Skip to content

Commit 1c4cd48

Browse files
actions-userImmutableJeffrey
actions-user
authored and
ImmutableJeffrey
committed
feat: update immutable zkEVM API package
1 parent 2ebb9aa commit 1c4cd48

21 files changed

+1398
-0
lines changed

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

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ All URIs are relative to *https://api.sandbox.immutable.com*
77
| [**GetUserInfo**](PassportProfileApi.md#getuserinfo) | **GET** /passport-profile/v1/user/info | Get all info for a Passport user |
88
| [**LinkWalletV2**](PassportProfileApi.md#linkwalletv2) | **POST** /passport-profile/v2/linked-wallets | Link wallet v2 |
99
| [**SendPhoneOtp**](PassportProfileApi.md#sendphoneotp) | **POST** /passport-profile/v1/phone-otp | Send phone OTP code for user supplied phone number |
10+
| [**UpdateUsername**](PassportProfileApi.md#updateusername) | **POST** /passport-profile/v1/username | Update username |
1011
| [**VerifyPhoneOtp**](PassportProfileApi.md#verifyphoneotp) | **POST** /passport-profile/v1/phone-otp/verify | Verify phone OTP code against user phone number |
1112

1213
<a id="getuserinfo"></a>
@@ -298,6 +299,104 @@ catch (ApiException e)
298299

299300
[[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)
300301

302+
<a id="updateusername"></a>
303+
# **UpdateUsername**
304+
> UsernameUpdateResponse UpdateUsername (UsernameUpdateRequest? usernameUpdateRequest = null)
305+
306+
Update username
307+
308+
Update username for the authenticated user's Passport wallet
309+
310+
### Example
311+
```csharp
312+
using System.Collections.Generic;
313+
using System.Diagnostics;
314+
using Immutable.Api.ZkEvm.Api;
315+
using Immutable.Api.ZkEvm.Client;
316+
using Immutable.Api.ZkEvm.Model;
317+
318+
namespace Example
319+
{
320+
public class UpdateUsernameExample
321+
{
322+
public static void Main()
323+
{
324+
Configuration config = new Configuration();
325+
config.BasePath = "https://api.sandbox.immutable.com";
326+
// Configure Bearer token for authorization: BearerAuth
327+
config.AccessToken = "YOUR_BEARER_TOKEN";
328+
329+
var apiInstance = new PassportProfileApi(config);
330+
var usernameUpdateRequest = new UsernameUpdateRequest?(); // UsernameUpdateRequest? | (optional)
331+
332+
try
333+
{
334+
// Update username
335+
UsernameUpdateResponse result = apiInstance.UpdateUsername(usernameUpdateRequest);
336+
Debug.WriteLine(result);
337+
}
338+
catch (ApiException e)
339+
{
340+
Debug.Print("Exception when calling PassportProfileApi.UpdateUsername: " + e.Message);
341+
Debug.Print("Status Code: " + e.ErrorCode);
342+
Debug.Print(e.StackTrace);
343+
}
344+
}
345+
}
346+
}
347+
```
348+
349+
#### Using the UpdateUsernameWithHttpInfo variant
350+
This returns an ApiResponse object which contains the response data, status code and headers.
351+
352+
```csharp
353+
try
354+
{
355+
// Update username
356+
ApiResponse<UsernameUpdateResponse> response = apiInstance.UpdateUsernameWithHttpInfo(usernameUpdateRequest);
357+
Debug.Write("Status Code: " + response.StatusCode);
358+
Debug.Write("Response Headers: " + response.Headers);
359+
Debug.Write("Response Body: " + response.Data);
360+
}
361+
catch (ApiException e)
362+
{
363+
Debug.Print("Exception when calling PassportProfileApi.UpdateUsernameWithHttpInfo: " + e.Message);
364+
Debug.Print("Status Code: " + e.ErrorCode);
365+
Debug.Print(e.StackTrace);
366+
}
367+
```
368+
369+
### Parameters
370+
371+
| Name | Type | Description | Notes |
372+
|------|------|-------------|-------|
373+
| **usernameUpdateRequest** | [**UsernameUpdateRequest?**](UsernameUpdateRequest?.md) | | [optional] |
374+
375+
### Return type
376+
377+
[**UsernameUpdateResponse**](UsernameUpdateResponse.md)
378+
379+
### Authorization
380+
381+
[BearerAuth](../README.md#BearerAuth)
382+
383+
### HTTP request headers
384+
385+
- **Content-Type**: application/json
386+
- **Accept**: application/json
387+
388+
389+
### HTTP response details
390+
| Status code | Description | Response headers |
391+
|-------------|-------------|------------------|
392+
| **200** | OK | - |
393+
| **400** | BadRequestError | - |
394+
| **401** | UnauthorizedError | - |
395+
| **403** | ForbiddenError | - |
396+
| **500** | InternalServerError | - |
397+
398+
[[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)
399+
301400
<a id="verifyphoneotp"></a>
302401
# **VerifyPhoneOtp**
303402
> void VerifyPhoneOtp (PhoneNumberOTPVerificationRequest? phoneNumberOTPVerificationRequest = null)

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

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Immutable.Api.ZkEvm.Model.SessionActivityContract
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**Id** | **int** | The unique identifier of the session activity contract | [optional]
8+
**Name** | **string** | The name of the session activity contract | [optional]
9+
**ContractAddress** | **string** | The smart contract address | [optional]
10+
**ClientId** | **string** | The client ID associated with the session activity contract | [optional]
11+
**ChainId** | **string** | The chain ID for the session activity contract | [optional]
12+
**OrganisationId** | **Guid** | The organisation ID that owns this session activity contract (UUID format) | [optional]
13+
**Enabled** | **bool** | Whether the session activity contract is enabled | [optional]
14+
**CreatedAt** | **DateTime** | The timestamp when the session activity contract was created | [optional]
15+
16+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
17+

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

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Immutable.Api.ZkEvm.Model.SessionActivityContractResponse
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**Id** | **int** | The unique identifier of the session activity contract |
8+
**Name** | **string** | The name of the session activity contract |
9+
**ContractAddress** | **string** | The smart contract address |
10+
**ClientId** | **string** | The client ID associated with the session activity contract |
11+
**ChainId** | **string** | The chain ID for the session activity contract |
12+
**OrganisationId** | **Guid** | The organisation ID that owns this session activity contract (UUID format) |
13+
**Enabled** | **bool** | Whether the session activity contract is enabled |
14+
**CreatedAt** | **DateTime** | The timestamp when the session activity contract was created |
15+
16+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
17+

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

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Immutable.Api.ZkEvm.Model.UpsertSessionActivityContractReq
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**Id** | **int** | The unique identifier of the session activity contract | [optional]
8+
**Name** | **string** | The name of the session activity contract |
9+
**ContractAddress** | **string** | The smart contract address |
10+
**ClientId** | **string** | The client ID associated with the session activity contract |
11+
**ChainId** | **string** | The chain ID for the session activity contract |
12+
**OrganisationId** | **Guid** | The organisation ID that owns this session activity contract (UUID format) |
13+
**Enabled** | **bool** | Whether the session activity contract is enabled |
14+
**CreatedAt** | **DateTime** | The timestamp when the session activity contract was created | [optional]
15+
16+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
17+

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

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Immutable.Api.ZkEvm.Model.UpsertSessionActivityContractResp
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**Id** | **int** | The unique identifier of the session activity contract | [optional]
8+
**Name** | **string** | The name of the session activity contract | [optional]
9+
**ContractAddress** | **string** | The smart contract address | [optional]
10+
**ClientId** | **string** | The client ID associated with the session activity contract | [optional]
11+
**ChainId** | **string** | The chain ID for the session activity contract | [optional]
12+
**OrganisationId** | **Guid** | The organisation ID that owns this session activity contract (UUID format) | [optional]
13+
**Enabled** | **bool** | Whether the session activity contract is enabled | [optional]
14+
**CreatedAt** | **DateTime** | The timestamp when the session activity contract was created | [optional]
15+
16+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
17+

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Immutable.Api.ZkEvm.Model.UsernameUpdateRequest
2+
Request to update username
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**Username** | **string** | The new username |
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Immutable.Api.ZkEvm.Model.UsernameUpdateResponse
2+
Username update response
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**Username** | **string** | |
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+

0 commit comments

Comments
 (0)