@teemill/platform 0.15.0 → 0.17.0

package/README.md

@@ -1,4 +1,4 @@
-## @teemill/platform@0.15.0
+## @teemill/platform@0.17.0
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @teemill/platform@0.15.0 --save
+npm install @teemill/platform@0.17.0 --save
 ```
 
 _unPublished (not recommended):_
@@ -44,3 +44,96 @@ _unPublished (not recommended):_
 ```
 npm install PATH_TO_GENERATED_PACKAGE --save
 ```
+
+### Documentation for API Endpoints
+
+All URIs are relative to *https://localhost:8080*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*CustomersApi* | [**exportCustomers**](docs/CustomersApi.md#exportcustomers) | **GET** /v1/platform/{platformId}/customers/export | Export customers
+*CustomersApi* | [**getCustomer**](docs/CustomersApi.md#getcustomer) | **GET** /v1/platform/{platformId}/customers/{customerId} | Get customer
+*CustomersApi* | [**listCustomers**](docs/CustomersApi.md#listcustomers) | **GET** /v1/platform/{platformId}/customers | List customers
+*OrdersApi* | [**exportOrders**](docs/OrdersApi.md#exportorders) | **GET** /v1/platform/{platformId}/orders/export | Export orders
+*OrdersApi* | [**getFulfillment**](docs/OrdersApi.md#getfulfillment) | **GET** /v1/platform/{platformId}/fulfillments/{fulfillmentId} | Get fulfillment
+*OrdersApi* | [**getOrder**](docs/OrdersApi.md#getorder) | **GET** /v1/platform/{platformId}/orders/{orderId} | Get order
+*OrdersApi* | [**listAvailableFulfillers**](docs/OrdersApi.md#listavailablefulfillers) | **GET** /v1/platform/{platformId}/fulfillments/{fulfillmentId}/available-fulfillers | List available fulfillers
+*OrdersApi* | [**listOrders**](docs/OrdersApi.md#listorders) | **GET** /v1/platform/{platformId}/orders | List orders
+*OrdersApi* | [**updateFulfillment**](docs/OrdersApi.md#updatefulfillment) | **PATCH** /v1/platform/{platformId}/fulfillments/{fulfillmentId} | Update fulfillment
+*PaymentApi* | [**authorizeStripe**](docs/PaymentApi.md#authorizestripe) | **GET** /v1/platform/payment/stripe/authorize | Authorize Stripe
+*PaymentApi* | [**deauthorizeStripe**](docs/PaymentApi.md#deauthorizestripe) | **DELETE** /v1/platform/payment/stripe/deauthorize | Deauthorize Stripe
+*PaymentApi* | [**getStripePaymentAccount**](docs/PaymentApi.md#getstripepaymentaccount) | **GET** /v1/platform/payment/stripe | Get Stripe Payment Account
+*PlatformApi* | [**getPlatform**](docs/PlatformApi.md#getplatform) | **GET** /v1/platform | Get platform details
+*PlatformApi* | [**updatePlatform**](docs/PlatformApi.md#updateplatform) | **PATCH** /v1/platform | Update platform
+*ReviewsApi* | [**exportReviews**](docs/ReviewsApi.md#exportreviews) | **GET** /v1/platform/{platformId}/reviews/export | Export reviews
+*ReviewsApi* | [**getReview**](docs/ReviewsApi.md#getreview) | **GET** /v1/platform/{platformId}/reviews/{reviewId} | Get review
+*ReviewsApi* | [**listReviews**](docs/ReviewsApi.md#listreviews) | **GET** /v1/platform/{platformId}/reviews | List reviews
+*ReviewsApi* | [**moderateReview**](docs/ReviewsApi.md#moderatereview) | **PATCH** /v1/platform/{platformId}/reviews/{reviewId}/moderate | Moderate review
+
+
+### Documentation For Models
+
+ - [Address](docs/Address.md)
+ - [ApiError](docs/ApiError.md)
+ - [AuthorizeStripe200Response](docs/AuthorizeStripe200Response.md)
+ - [ContactInformation](docs/ContactInformation.md)
+ - [Customer](docs/Customer.md)
+ - [CustomersResponse](docs/CustomersResponse.md)
+ - [DeliveryEstimates](docs/DeliveryEstimates.md)
+ - [ExportOrders202Response](docs/ExportOrders202Response.md)
+ - [Fulfiller](docs/Fulfiller.md)
+ - [FulfillerLocation](docs/FulfillerLocation.md)
+ - [FulfillersResponse](docs/FulfillersResponse.md)
+ - [Fulfillment](docs/Fulfillment.md)
+ - [FulfillmentItem](docs/FulfillmentItem.md)
+ - [Image](docs/Image.md)
+ - [ModerateReviewRequest](docs/ModerateReviewRequest.md)
+ - [Option](docs/Option.md)
+ - [Order](docs/Order.md)
+ - [OrderItem](docs/OrderItem.md)
+ - [OrderStatus](docs/OrderStatus.md)
+ - [OrderTracking](docs/OrderTracking.md)
+ - [OrdersResponse](docs/OrdersResponse.md)
+ - [Origin](docs/Origin.md)
+ - [PaymentAccount](docs/PaymentAccount.md)
+ - [PaymentAttempt](docs/PaymentAttempt.md)
+ - [Platform](docs/Platform.md)
+ - [PlatformLogo](docs/PlatformLogo.md)
+ - [Price](docs/Price.md)
+ - [Project](docs/Project.md)
+ - [Review](docs/Review.md)
+ - [ReviewAuthor](docs/ReviewAuthor.md)
+ - [ReviewImagesInner](docs/ReviewImagesInner.md)
+ - [ReviewProduct](docs/ReviewProduct.md)
+ - [ReviewReply](docs/ReviewReply.md)
+ - [ReviewReplyAuthor](docs/ReviewReplyAuthor.md)
+ - [ReviewsResponse](docs/ReviewsResponse.md)
+ - [ShippingMethod](docs/ShippingMethod.md)
+ - [Statistics](docs/Statistics.md)
+ - [StatusHistoryItem](docs/StatusHistoryItem.md)
+ - [UpdateFulfillmentRequest](docs/UpdateFulfillmentRequest.md)
+ - [UpdatePlatformRequest](docs/UpdatePlatformRequest.md)
+ - [ValidationError](docs/ValidationError.md)
+ - [Variant](docs/Variant.md)
+
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+
+Authentication schemes defined for the API:
+<a id="api-key"></a>
+### api-key
+
+- **Type**: API key
+- **API key parameter name**: Authorization
+- **Location**: HTTP header
+
+<a id="session-oauth"></a>
+### session-oauth
+
+- **Type**: OAuth
+- **Flow**: password
+- **Authorization URL**: 
+- **Scopes**: N/A
+