mirror of
https://github.com/GlueOps/autoglue.git
synced 2026-02-13 04:40:05 +01:00
fis: updates to remove Terraform Provider reserved word collisions
Signed-off-by: allanice001 <allanice001@gmail.com>
This commit is contained in:
136
sdk/ts/docs/MeApi.md
Normal file
136
sdk/ts/docs/MeApi.md
Normal file
@@ -0,0 +1,136 @@
|
||||
# MeApi
|
||||
|
||||
All URIs are relative to *https://autoglue.glueopshosted.com/api/v1*
|
||||
|
||||
| Method | HTTP request | Description |
|
||||
| --------------------------------- | ------------- | --------------------------- |
|
||||
| [**getMe**](MeApi.md#getme) | **GET** /me | Get current user profile |
|
||||
| [**updateMe**](MeApi.md#updateme) | **PATCH** /me | Update current user profile |
|
||||
|
||||
## getMe
|
||||
|
||||
> HandlersMeResponse getMe()
|
||||
|
||||
Get current user profile
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import { Configuration, MeApi } from "@glueops/autoglue-sdk-go";
|
||||
import type { GetMeRequest } from "@glueops/autoglue-sdk-go";
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: ApiKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new MeApi(config);
|
||||
|
||||
try {
|
||||
const data = await api.getMe();
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**HandlersMeResponse**](HandlersMeResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ----------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
## updateMe
|
||||
|
||||
> ModelsUser updateMe(handlersUpdateMeRequest)
|
||||
|
||||
Update current user profile
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
Configuration,
|
||||
MeApi,
|
||||
} from '@glueops/autoglue-sdk-go';
|
||||
import type { UpdateMeRequest } from '@glueops/autoglue-sdk-go';
|
||||
|
||||
async function example() {
|
||||
console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
|
||||
const config = new Configuration({
|
||||
// To configure API key authorization: ApiKeyAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
// To configure API key authorization: BearerAuth
|
||||
apiKey: "YOUR API KEY",
|
||||
});
|
||||
const api = new MeApi(config);
|
||||
|
||||
const body = {
|
||||
// HandlersUpdateMeRequest | Patch profile
|
||||
handlersUpdateMeRequest: ...,
|
||||
} satisfies UpdateMeRequest;
|
||||
|
||||
try {
|
||||
const data = await api.updateMe(body);
|
||||
console.log(data);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
}
|
||||
|
||||
// Run the test
|
||||
example().catch(console.error);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| --------------------------- | ----------------------------------------------------- | ------------- | ----- |
|
||||
| **handlersUpdateMeRequest** | [HandlersUpdateMeRequest](HandlersUpdateMeRequest.md) | Patch profile | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ModelsUser**](ModelsUser.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: `application/json`
|
||||
- **Accept**: `application/json`
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ----------- | ---------------- |
|
||||
| **200** | OK | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
Reference in New Issue
Block a user