Skip to content
Open
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
99 changes: 99 additions & 0 deletions src/Packages/ZkEvmApi/Documentation~/PassportProfileApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ All URIs are relative to *https://api.sandbox.immutable.com*
| [**GetUserInfo**](PassportProfileApi.md#getuserinfo) | **GET** /passport-profile/v1/user/info | Get all info for a Passport user |
| [**LinkWalletV2**](PassportProfileApi.md#linkwalletv2) | **POST** /passport-profile/v2/linked-wallets | Link wallet v2 |
| [**SendPhoneOtp**](PassportProfileApi.md#sendphoneotp) | **POST** /passport-profile/v1/phone-otp | Send phone OTP code for user supplied phone number |
| [**UpdateUsername**](PassportProfileApi.md#updateusername) | **POST** /passport-profile/v1/username | Update username |
| [**VerifyPhoneOtp**](PassportProfileApi.md#verifyphoneotp) | **POST** /passport-profile/v1/phone-otp/verify | Verify phone OTP code against user phone number |

<a id="getuserinfo"></a>
Expand Down Expand Up @@ -298,6 +299,104 @@ 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="updateusername"></a>
# **UpdateUsername**
> UsernameUpdateResponse UpdateUsername (UsernameUpdateRequest? usernameUpdateRequest = null)

Update username

Update username for the authenticated user's Passport wallet

### 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 UpdateUsernameExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.sandbox.immutable.com";
// Configure Bearer token for authorization: BearerAuth
config.AccessToken = "YOUR_BEARER_TOKEN";

var apiInstance = new PassportProfileApi(config);
var usernameUpdateRequest = new UsernameUpdateRequest?(); // UsernameUpdateRequest? | (optional)

try
{
// Update username
UsernameUpdateResponse result = apiInstance.UpdateUsername(usernameUpdateRequest);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling PassportProfileApi.UpdateUsername: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```

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

```csharp
try
{
// Update username
ApiResponse<UsernameUpdateResponse> response = apiInstance.UpdateUsernameWithHttpInfo(usernameUpdateRequest);
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 PassportProfileApi.UpdateUsernameWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```

### Parameters

| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **usernameUpdateRequest** | [**UsernameUpdateRequest?**](UsernameUpdateRequest?.md) | | [optional] |

### Return type

[**UsernameUpdateResponse**](UsernameUpdateResponse.md)

### Authorization

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

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | OK | - |
| **400** | BadRequestError | - |
| **401** | UnauthorizedError | - |
| **403** | ForbiddenError | - |
| **500** | InternalServerError | - |

[[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="verifyphoneotp"></a>
# **VerifyPhoneOtp**
> void VerifyPhoneOtp (PhoneNumberOTPVerificationRequest? phoneNumberOTPVerificationRequest = null)
Expand Down
17 changes: 17 additions & 0 deletions src/Packages/ZkEvmApi/Documentation~/SessionActivityContract.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Immutable.Api.ZkEvm.Model.SessionActivityContract

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **int** | The unique identifier of the session activity contract | [optional]
**Name** | **string** | The name of the session activity contract | [optional]
**ContractAddress** | **string** | The smart contract address | [optional]
**ClientId** | **string** | The client ID associated with the session activity contract | [optional]
**ChainId** | **string** | The chain ID for the session activity contract | [optional]
**OrganisationId** | **Guid** | The organisation ID that owns this session activity contract (UUID format) | [optional]
**Enabled** | **bool** | Whether the session activity contract is enabled | [optional]
**CreatedAt** | **DateTime** | The timestamp when the session activity contract was created | [optional]

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

Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Immutable.Api.ZkEvm.Model.SessionActivityContractResponse

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **int** | The unique identifier of the session activity contract |
**Name** | **string** | The name of the session activity contract |
**ContractAddress** | **string** | The smart contract address |
**ClientId** | **string** | The client ID associated with the session activity contract |
**ChainId** | **string** | The chain ID for the session activity contract |
**OrganisationId** | **Guid** | The organisation ID that owns this session activity contract (UUID format) |
**Enabled** | **bool** | Whether the session activity contract is enabled |
**CreatedAt** | **DateTime** | The timestamp when the session activity contract was created |

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

Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Immutable.Api.ZkEvm.Model.UpsertSessionActivityContractReq

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **int** | The unique identifier of the session activity contract | [optional]
**Name** | **string** | The name of the session activity contract |
**ContractAddress** | **string** | The smart contract address |
**ClientId** | **string** | The client ID associated with the session activity contract |
**ChainId** | **string** | The chain ID for the session activity contract |
**OrganisationId** | **Guid** | The organisation ID that owns this session activity contract (UUID format) |
**Enabled** | **bool** | Whether the session activity contract is enabled |
**CreatedAt** | **DateTime** | The timestamp when the session activity contract was created | [optional]

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

Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Immutable.Api.ZkEvm.Model.UpsertSessionActivityContractResp

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **int** | The unique identifier of the session activity contract | [optional]
**Name** | **string** | The name of the session activity contract | [optional]
**ContractAddress** | **string** | The smart contract address | [optional]
**ClientId** | **string** | The client ID associated with the session activity contract | [optional]
**ChainId** | **string** | The chain ID for the session activity contract | [optional]
**OrganisationId** | **Guid** | The organisation ID that owns this session activity contract (UUID format) | [optional]
**Enabled** | **bool** | Whether the session activity contract is enabled | [optional]
**CreatedAt** | **DateTime** | The timestamp when the session activity contract was created | [optional]

[[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 changes: 11 additions & 0 deletions src/Packages/ZkEvmApi/Documentation~/UsernameUpdateRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Immutable.Api.ZkEvm.Model.UsernameUpdateRequest
Request to update username

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Username** | **string** | The new username |

[[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 changes: 11 additions & 0 deletions src/Packages/ZkEvmApi/Documentation~/UsernameUpdateResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Immutable.Api.ZkEvm.Model.UsernameUpdateResponse
Username update response

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Username** | **string** | |

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

Loading