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

package/docs/StoreApi.md

@@ -0,0 +1,286 @@
+# StoreApi
+
+All URIs are relative to *https://petstore3.swagger.io/api/v3*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**deleteOrder**](StoreApi.md#deleteorder) | **DELETE** /store/order/{orderId} | Delete purchase order by identifier. |
+| [**getInventory**](StoreApi.md#getinventory) | **GET** /store/inventory | Returns pet inventories by status. |
+| [**getOrderById**](StoreApi.md#getorderbyid) | **GET** /store/order/{orderId} | Find purchase order by ID. |
+| [**placeOrder**](StoreApi.md#placeorder) | **POST** /store/order | Place an order for a pet. |
+
+
+
+## deleteOrder
+
+> deleteOrder(orderId)
+
+Delete purchase order by identifier.
+
+For valid response try integer IDs with value < 1000. Anything above 1000 or non-integers will generate API errors.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  StoreApi,
+} from '@redhat-ecosystem-engineering/petstore-client-test';
+import type { DeleteOrderRequest } from '@redhat-ecosystem-engineering/petstore-client-test';
+
+async function example() {
+  console.log("🚀 Testing @redhat-ecosystem-engineering/petstore-client-test SDK...");
+  const api = new StoreApi();
+
+  const body = {
+    // number | ID of the order that needs to be deleted
+    orderId: 789,
+  } satisfies DeleteOrderRequest;
+
+  try {
+    const data = await api.deleteOrder(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **orderId** | `number` | ID of the order that needs to be deleted | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | order deleted |  -  |
+| **400** | Invalid ID supplied |  -  |
+| **404** | Order 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)
+
+
+## getInventory
+
+> { [key: string]: number; } getInventory()
+
+Returns pet inventories by status.
+
+Returns a map of status codes to quantities.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  StoreApi,
+} from '@redhat-ecosystem-engineering/petstore-client-test';
+import type { GetInventoryRequest } 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 API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new StoreApi(config);
+
+  try {
+    const data = await api.getInventory();
+    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
+
+**{ [key: string]: number; }**
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | successful operation |  -  |
+| **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)
+
+
+## getOrderById
+
+> Order getOrderById(orderId)
+
+Find purchase order by ID.
+
+For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  StoreApi,
+} from '@redhat-ecosystem-engineering/petstore-client-test';
+import type { GetOrderByIdRequest } from '@redhat-ecosystem-engineering/petstore-client-test';
+
+async function example() {
+  console.log("🚀 Testing @redhat-ecosystem-engineering/petstore-client-test SDK...");
+  const api = new StoreApi();
+
+  const body = {
+    // number | ID of order that needs to be fetched
+    orderId: 789,
+  } satisfies GetOrderByIdRequest;
+
+  try {
+    const data = await api.getOrderById(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **orderId** | `number` | ID of order that needs to be fetched | [Defaults to `undefined`] |
+
+### Return type
+
+[**Order**](Order.md)
+
+### Authorization
+
+No authorization required
+
+### 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** | Order 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)
+
+
+## placeOrder
+
+> Order placeOrder(order)
+
+Place an order for a pet.
+
+Place a new order in the store.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  StoreApi,
+} from '@redhat-ecosystem-engineering/petstore-client-test';
+import type { PlaceOrderRequest } from '@redhat-ecosystem-engineering/petstore-client-test';
+
+async function example() {
+  console.log("🚀 Testing @redhat-ecosystem-engineering/petstore-client-test SDK...");
+  const api = new StoreApi();
+
+  const body = {
+    // Order (optional)
+    order: ...,
+  } satisfies PlaceOrderRequest;
+
+  try {
+    const data = await api.placeOrder(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **order** | [Order](Order.md) |  | [Optional] |
+
+### Return type
+
+[**Order**](Order.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`, `application/xml`, `application/x-www-form-urlencoded`
+- **Accept**: `application/json`
+
+
+### 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)
+

package/docs/Tag.md

@@ -0,0 +1,36 @@
+
+# Tag
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`name` | string
+
+## Example
+
+```typescript
+import type { Tag } from '@redhat-ecosystem-engineering/petstore-client-test'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+} satisfies Tag
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Tag
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/User.md

@@ -0,0 +1,48 @@
+
+# User
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`username` | string
+`firstName` | string
+`lastName` | string
+`email` | string
+`password` | string
+`phone` | string
+`userStatus` | number
+
+## Example
+
+```typescript
+import type { User } from '@redhat-ecosystem-engineering/petstore-client-test'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": 10,
+  "username": theUser,
+  "firstName": John,
+  "lastName": James,
+  "email": john@email.com,
+  "password": 12345,
+  "phone": 12345,
+  "userStatus": 1,
+} satisfies User
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as User
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+