@wastesentry/trak-client 0.1.0

package/docs/TeamsApi.md

@@ -0,0 +1,965 @@
+# TeamsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**invitationsCreate**](TeamsApi.md#invitationscreate) | **POST** /a/{team_slug}/team/api/invitations/ |  |
+| [**invitationsDestroy**](TeamsApi.md#invitationsdestroy) | **DELETE** /a/{team_slug}/team/api/invitations/{id}/ |  |
+| [**invitationsList**](TeamsApi.md#invitationslist) | **GET** /a/{team_slug}/team/api/invitations/ |  |
+| [**invitationsPartialUpdate**](TeamsApi.md#invitationspartialupdate) | **PATCH** /a/{team_slug}/team/api/invitations/{id}/ |  |
+| [**invitationsRetrieve**](TeamsApi.md#invitationsretrieve) | **GET** /a/{team_slug}/team/api/invitations/{id}/ |  |
+| [**invitationsUpdate**](TeamsApi.md#invitationsupdate) | **PUT** /a/{team_slug}/team/api/invitations/{id}/ |  |
+| [**teamsCreate**](TeamsApi.md#teamscreate) | **POST** /teams/api/teams/ |  |
+| [**teamsDestroy**](TeamsApi.md#teamsdestroy) | **DELETE** /teams/api/teams/{id}/ |  |
+| [**teamsList**](TeamsApi.md#teamslist) | **GET** /teams/api/teams/ |  |
+| [**teamsPartialUpdate**](TeamsApi.md#teamspartialupdate) | **PATCH** /teams/api/teams/{id}/ |  |
+| [**teamsRetrieve**](TeamsApi.md#teamsretrieve) | **GET** /teams/api/teams/{id}/ |  |
+| [**teamsUpdate**](TeamsApi.md#teamsupdate) | **PUT** /teams/api/teams/{id}/ |  |
+| [**userInvitations**](TeamsApi.md#userinvitations) | **GET** /teams/api/user-invitations/ |  |
+
+
+
+## invitationsCreate
+
+> Invitation invitationsCreate(teamSlug, invitation)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TeamsApi,
+} from '';
+import type { InvitationsCreateRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new TeamsApi(config);
+
+  const body = {
+    // string
+    teamSlug: teamSlug_example,
+    // Invitation
+    invitation: ...,
+  } satisfies InvitationsCreateRequest;
+
+  try {
+    const data = await api.invitationsCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **teamSlug** | `string` |  | [Defaults to `undefined`] |
+| **invitation** | [Invitation](Invitation.md) |  | |
+
+### Return type
+
+[**Invitation**](Invitation.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## invitationsDestroy
+
+> invitationsDestroy(id, teamSlug)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TeamsApi,
+} from '';
+import type { InvitationsDestroyRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new TeamsApi(config);
+
+  const body = {
+    // string | A UUID string identifying this invitation.
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string
+    teamSlug: teamSlug_example,
+  } satisfies InvitationsDestroyRequest;
+
+  try {
+    const data = await api.invitationsDestroy(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | A UUID string identifying this invitation. | [Defaults to `undefined`] |
+| **teamSlug** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | No response body |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## invitationsList
+
+> PaginatedInvitationList invitationsList(teamSlug, page)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TeamsApi,
+} from '';
+import type { InvitationsListRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new TeamsApi(config);
+
+  const body = {
+    // string
+    teamSlug: teamSlug_example,
+    // number | A page number within the paginated result set. (optional)
+    page: 56,
+  } satisfies InvitationsListRequest;
+
+  try {
+    const data = await api.invitationsList(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **teamSlug** | `string` |  | [Defaults to `undefined`] |
+| **page** | `number` | A page number within the paginated result set. | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**PaginatedInvitationList**](PaginatedInvitationList.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## invitationsPartialUpdate
+
+> Invitation invitationsPartialUpdate(id, teamSlug, patchedInvitation)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TeamsApi,
+} from '';
+import type { InvitationsPartialUpdateRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new TeamsApi(config);
+
+  const body = {
+    // string | A UUID string identifying this invitation.
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string
+    teamSlug: teamSlug_example,
+    // PatchedInvitation (optional)
+    patchedInvitation: ...,
+  } satisfies InvitationsPartialUpdateRequest;
+
+  try {
+    const data = await api.invitationsPartialUpdate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | A UUID string identifying this invitation. | [Defaults to `undefined`] |
+| **teamSlug** | `string` |  | [Defaults to `undefined`] |
+| **patchedInvitation** | [PatchedInvitation](PatchedInvitation.md) |  | [Optional] |
+
+### Return type
+
+[**Invitation**](Invitation.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## invitationsRetrieve
+
+> Invitation invitationsRetrieve(id, teamSlug)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TeamsApi,
+} from '';
+import type { InvitationsRetrieveRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new TeamsApi(config);
+
+  const body = {
+    // string | A UUID string identifying this invitation.
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string
+    teamSlug: teamSlug_example,
+  } satisfies InvitationsRetrieveRequest;
+
+  try {
+    const data = await api.invitationsRetrieve(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | A UUID string identifying this invitation. | [Defaults to `undefined`] |
+| **teamSlug** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**Invitation**](Invitation.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## invitationsUpdate
+
+> Invitation invitationsUpdate(id, teamSlug, invitation)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TeamsApi,
+} from '';
+import type { InvitationsUpdateRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new TeamsApi(config);
+
+  const body = {
+    // string | A UUID string identifying this invitation.
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string
+    teamSlug: teamSlug_example,
+    // Invitation
+    invitation: ...,
+  } satisfies InvitationsUpdateRequest;
+
+  try {
+    const data = await api.invitationsUpdate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | A UUID string identifying this invitation. | [Defaults to `undefined`] |
+| **teamSlug** | `string` |  | [Defaults to `undefined`] |
+| **invitation** | [Invitation](Invitation.md) |  | |
+
+### Return type
+
+[**Invitation**](Invitation.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## teamsCreate
+
+> Team teamsCreate(team)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TeamsApi,
+} from '';
+import type { TeamsCreateRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new TeamsApi(config);
+
+  const body = {
+    // Team
+    team: ...,
+  } satisfies TeamsCreateRequest;
+
+  try {
+    const data = await api.teamsCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **team** | [Team](Team.md) |  | |
+
+### Return type
+
+[**Team**](Team.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## teamsDestroy
+
+> teamsDestroy(id)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TeamsApi,
+} from '';
+import type { TeamsDestroyRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new TeamsApi(config);
+
+  const body = {
+    // number | A unique integer value identifying this team.
+    id: 56,
+  } satisfies TeamsDestroyRequest;
+
+  try {
+    const data = await api.teamsDestroy(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `number` | A unique integer value identifying this team. | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | No response body |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## teamsList
+
+> PaginatedTeamList teamsList(page)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TeamsApi,
+} from '';
+import type { TeamsListRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new TeamsApi(config);
+
+  const body = {
+    // number | A page number within the paginated result set. (optional)
+    page: 56,
+  } satisfies TeamsListRequest;
+
+  try {
+    const data = await api.teamsList(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **page** | `number` | A page number within the paginated result set. | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**PaginatedTeamList**](PaginatedTeamList.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## teamsPartialUpdate
+
+> Team teamsPartialUpdate(id, patchedTeam)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TeamsApi,
+} from '';
+import type { TeamsPartialUpdateRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new TeamsApi(config);
+
+  const body = {
+    // number | A unique integer value identifying this team.
+    id: 56,
+    // PatchedTeam (optional)
+    patchedTeam: ...,
+  } satisfies TeamsPartialUpdateRequest;
+
+  try {
+    const data = await api.teamsPartialUpdate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `number` | A unique integer value identifying this team. | [Defaults to `undefined`] |
+| **patchedTeam** | [PatchedTeam](PatchedTeam.md) |  | [Optional] |
+
+### Return type
+
+[**Team**](Team.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## teamsRetrieve
+
+> Team teamsRetrieve(id)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TeamsApi,
+} from '';
+import type { TeamsRetrieveRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new TeamsApi(config);
+
+  const body = {
+    // number | A unique integer value identifying this team.
+    id: 56,
+  } satisfies TeamsRetrieveRequest;
+
+  try {
+    const data = await api.teamsRetrieve(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `number` | A unique integer value identifying this team. | [Defaults to `undefined`] |
+
+### Return type
+
+[**Team**](Team.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## teamsUpdate
+
+> Team teamsUpdate(id, team)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TeamsApi,
+} from '';
+import type { TeamsUpdateRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new TeamsApi(config);
+
+  const body = {
+    // number | A unique integer value identifying this team.
+    id: 56,
+    // Team
+    team: ...,
+  } satisfies TeamsUpdateRequest;
+
+  try {
+    const data = await api.teamsUpdate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `number` | A unique integer value identifying this team. | [Defaults to `undefined`] |
+| **team** | [Team](Team.md) |  | |
+
+### Return type
+
+[**Team**](Team.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## userInvitations
+
+> UserInvitationsResponse userInvitations()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TeamsApi,
+} from '';
+import type { UserInvitationsRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new TeamsApi(config);
+
+  try {
+    const data = await api.userInvitations();
+    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
+
+[**UserInvitationsResponse**](UserInvitationsResponse.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)