@redhat-ecosystem-engineering/petstore-client-test 0.0.1

package/docs/PetApi.md

@@ -0,0 +1,622 @@
+# PetApi
+
+All URIs are relative to *https://petstore3.swagger.io/api/v3*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**addPet**](PetApi.md#addpet) | **POST** /pet | Add a new pet to the store. |
+| [**deletePet**](PetApi.md#deletepet) | **DELETE** /pet/{petId} | Deletes a pet. |
+| [**findPetsByStatus**](PetApi.md#findpetsbystatus) | **GET** /pet/findByStatus | Finds Pets by status. |
+| [**findPetsByTags**](PetApi.md#findpetsbytags) | **GET** /pet/findByTags | Finds Pets by tags. |
+| [**getPetById**](PetApi.md#getpetbyid) | **GET** /pet/{petId} | Find pet by ID. |
+| [**updatePet**](PetApi.md#updatepet) | **PUT** /pet | Update an existing pet. |
+| [**updatePetWithForm**](PetApi.md#updatepetwithform) | **POST** /pet/{petId} | Updates a pet in the store with form data. |
+| [**uploadFile**](PetApi.md#uploadfile) | **POST** /pet/{petId}/uploadImage | Uploads an image. |
+
+
+
+## addPet
+
+> Pet addPet(pet)
+
+Add a new pet to the store.
+
+Add a new pet to the store.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PetApi,
+} from '@redhat-ecosystem-engineering/petstore-client-test';
+import type { AddPetRequest } from '@redhat-ecosystem-engineering/petstore-client-test';
+
+async function example() {
+  console.log("🚀 Testing @redhat-ecosystem-engineering/petstore-client-test SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: petstore_auth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new PetApi(config);
+
+  const body = {
+    // Pet | Create a new pet in the store
+    pet: ...,
+  } satisfies AddPetRequest;
+
+  try {
+    const data = await api.addPet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **pet** | [Pet](Pet.md) | Create a new pet in the store | |
+
+### Return type
+
+[**Pet**](Pet.md)
+
+### Authorization
+
+[petstore_auth implicit](../README.md#petstore_auth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`, `application/xml`, `application/x-www-form-urlencoded`
+- **Accept**: `application/json`, `application/xml`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful operation |  -  |
+| **400** | Invalid input |  -  |
+| **422** | Validation exception |  -  |
+| **0** | Unexpected error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deletePet
+
+> deletePet(petId, apiKey)
+
+Deletes a pet.
+
+Delete a pet.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PetApi,
+} from '@redhat-ecosystem-engineering/petstore-client-test';
+import type { DeletePetRequest } from '@redhat-ecosystem-engineering/petstore-client-test';
+
+async function example() {
+  console.log("🚀 Testing @redhat-ecosystem-engineering/petstore-client-test SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: petstore_auth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new PetApi(config);
+
+  const body = {
+    // number | Pet id to delete
+    petId: 789,
+    // string |  (optional)
+    apiKey: apiKey_example,
+  } satisfies DeletePetRequest;
+
+  try {
+    const data = await api.deletePet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **petId** | `number` | Pet id to delete | [Defaults to `undefined`] |
+| **apiKey** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[petstore_auth implicit](../README.md#petstore_auth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Pet deleted |  -  |
+| **400** | Invalid pet value |  -  |
+| **0** | Unexpected error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## findPetsByStatus
+
+> Array<Pet> findPetsByStatus(status)
+
+Finds Pets by status.
+
+Multiple status values can be provided with comma separated strings.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PetApi,
+} from '@redhat-ecosystem-engineering/petstore-client-test';
+import type { FindPetsByStatusRequest } from '@redhat-ecosystem-engineering/petstore-client-test';
+
+async function example() {
+  console.log("🚀 Testing @redhat-ecosystem-engineering/petstore-client-test SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: petstore_auth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new PetApi(config);
+
+  const body = {
+    // 'available' | 'pending' | 'sold' | Status values that need to be considered for filter
+    status: status_example,
+  } satisfies FindPetsByStatusRequest;
+
+  try {
+    const data = await api.findPetsByStatus(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **status** | `available`, `pending`, `sold` | Status values that need to be considered for filter | [Defaults to `'available'`] [Enum: available, pending, sold] |
+
+### Return type
+
+[**Array<Pet>**](Pet.md)
+
+### Authorization
+
+[petstore_auth implicit](../README.md#petstore_auth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`, `application/xml`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | successful operation |  -  |
+| **400** | Invalid status value |  -  |
+| **0** | Unexpected error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## findPetsByTags
+
+> Array<Pet> findPetsByTags(tags)
+
+Finds Pets by tags.
+
+Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PetApi,
+} from '@redhat-ecosystem-engineering/petstore-client-test';
+import type { FindPetsByTagsRequest } from '@redhat-ecosystem-engineering/petstore-client-test';
+
+async function example() {
+  console.log("🚀 Testing @redhat-ecosystem-engineering/petstore-client-test SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: petstore_auth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new PetApi(config);
+
+  const body = {
+    // Array<string> | Tags to filter by
+    tags: ...,
+  } satisfies FindPetsByTagsRequest;
+
+  try {
+    const data = await api.findPetsByTags(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **tags** | `Array<string>` | Tags to filter by | |
+
+### Return type
+
+[**Array&lt;Pet&gt;**](Pet.md)
+
+### Authorization
+
+[petstore_auth implicit](../README.md#petstore_auth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`, `application/xml`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | successful operation |  -  |
+| **400** | Invalid tag value |  -  |
+| **0** | Unexpected error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getPetById
+
+> Pet getPetById(petId)
+
+Find pet by ID.
+
+Returns a single pet.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PetApi,
+} from '@redhat-ecosystem-engineering/petstore-client-test';
+import type { GetPetByIdRequest } from '@redhat-ecosystem-engineering/petstore-client-test';
+
+async function example() {
+  console.log("🚀 Testing @redhat-ecosystem-engineering/petstore-client-test SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: petstore_auth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new PetApi(config);
+
+  const body = {
+    // number | ID of pet to return
+    petId: 789,
+  } satisfies GetPetByIdRequest;
+
+  try {
+    const data = await api.getPetById(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **petId** | `number` | ID of pet to return | [Defaults to `undefined`] |
+
+### Return type
+
+[**Pet**](Pet.md)
+
+### Authorization
+
+[petstore_auth implicit](../README.md#petstore_auth-implicit), [api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`, `application/xml`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | successful operation |  -  |
+| **400** | Invalid ID supplied |  -  |
+| **404** | Pet not found |  -  |
+| **0** | Unexpected error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updatePet
+
+> Pet updatePet(pet)
+
+Update an existing pet.
+
+Update an existing pet by Id.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PetApi,
+} from '@redhat-ecosystem-engineering/petstore-client-test';
+import type { UpdatePetRequest } from '@redhat-ecosystem-engineering/petstore-client-test';
+
+async function example() {
+  console.log("🚀 Testing @redhat-ecosystem-engineering/petstore-client-test SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: petstore_auth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new PetApi(config);
+
+  const body = {
+    // Pet | Update an existent pet in the store
+    pet: ...,
+  } satisfies UpdatePetRequest;
+
+  try {
+    const data = await api.updatePet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **pet** | [Pet](Pet.md) | Update an existent pet in the store | |
+
+### Return type
+
+[**Pet**](Pet.md)
+
+### Authorization
+
+[petstore_auth implicit](../README.md#petstore_auth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`, `application/xml`, `application/x-www-form-urlencoded`
+- **Accept**: `application/json`, `application/xml`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful operation |  -  |
+| **400** | Invalid ID supplied |  -  |
+| **404** | Pet not found |  -  |
+| **422** | Validation exception |  -  |
+| **0** | Unexpected error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updatePetWithForm
+
+> Pet updatePetWithForm(petId, name, status)
+
+Updates a pet in the store with form data.
+
+Updates a pet resource based on the form data.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PetApi,
+} from '@redhat-ecosystem-engineering/petstore-client-test';
+import type { UpdatePetWithFormRequest } from '@redhat-ecosystem-engineering/petstore-client-test';
+
+async function example() {
+  console.log("🚀 Testing @redhat-ecosystem-engineering/petstore-client-test SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: petstore_auth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new PetApi(config);
+
+  const body = {
+    // number | ID of pet that needs to be updated
+    petId: 789,
+    // string | Name of pet that needs to be updated (optional)
+    name: name_example,
+    // string | Status of pet that needs to be updated (optional)
+    status: status_example,
+  } satisfies UpdatePetWithFormRequest;
+
+  try {
+    const data = await api.updatePetWithForm(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **petId** | `number` | ID of pet that needs to be updated | [Defaults to `undefined`] |
+| **name** | `string` | Name of pet that needs to be updated | [Optional] [Defaults to `undefined`] |
+| **status** | `string` | Status of pet that needs to be updated | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**Pet**](Pet.md)
+
+### Authorization
+
+[petstore_auth implicit](../README.md#petstore_auth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`, `application/xml`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | successful operation |  -  |
+| **400** | Invalid input |  -  |
+| **0** | Unexpected error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## uploadFile
+
+> ModelApiResponse uploadFile(petId, additionalMetadata, body)
+
+Uploads an image.
+
+Upload image of the pet.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PetApi,
+} from '@redhat-ecosystem-engineering/petstore-client-test';
+import type { UploadFileRequest } from '@redhat-ecosystem-engineering/petstore-client-test';
+
+async function example() {
+  console.log("🚀 Testing @redhat-ecosystem-engineering/petstore-client-test SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: petstore_auth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new PetApi(config);
+
+  const body = {
+    // number | ID of pet to update
+    petId: 789,
+    // string | Additional Metadata (optional)
+    additionalMetadata: additionalMetadata_example,
+    // Blob (optional)
+    body: BINARY_DATA_HERE,
+  } satisfies UploadFileRequest;
+
+  try {
+    const data = await api.uploadFile(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **petId** | `number` | ID of pet to update | [Defaults to `undefined`] |
+| **additionalMetadata** | `string` | Additional Metadata | [Optional] [Defaults to `undefined`] |
+| **body** | `Blob` |  | [Optional] |
+
+### Return type
+
+[**ModelApiResponse**](ModelApiResponse.md)
+
+### Authorization
+
+[petstore_auth implicit](../README.md#petstore_auth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: `application/octet-stream`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | successful operation |  -  |
+| **400** | No file uploaded |  -  |
+| **404** | Pet not found |  -  |
+| **0** | Unexpected error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+