@cmarket/partner-sdk 0.1.0 → 0.3.0

package/docs/PartnerV1LegacyApi.md

@@ -1,97 +0,0 @@
-# PartnerV1LegacyApi
-
-All URIs are relative to *http://localhost*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**legacyControllerCheckGet**](#legacycontrollercheckget) | **GET** /v1-legacy/check | V5 /check 호환 헬스체크 (deprecated)|
-|[**legacyControllerCheckPost**](#legacycontrollercheckpost) | **POST** /v1-legacy/check | V5 /check 호환 헬스체크 — POST (deprecated)|
-
-# **legacyControllerCheckGet**
-> LegacyEnvelopeDto legacyControllerCheckGet()
-
-V5 ApiController#check 응답 envelope 그대로. Sunset 헤더 부착.
-
-### Example
-
-```typescript
-import {
-    PartnerV1LegacyApi,
-    Configuration
-} from '@cmarket/partner-sdk';
-
-const configuration = new Configuration();
-const apiInstance = new PartnerV1LegacyApi(configuration);
-
-const { status, data } = await apiInstance.legacyControllerCheckGet();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**LegacyEnvelopeDto**
-
-### Authorization
-
-No authorization required
-
-### 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#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **legacyControllerCheckPost**
-> LegacyEnvelopeDto legacyControllerCheckPost()
-
-V5 는 GET·POST 모두 받음. 동일 응답.
-
-### Example
-
-```typescript
-import {
-    PartnerV1LegacyApi,
-    Configuration
-} from '@cmarket/partner-sdk';
-
-const configuration = new Configuration();
-const apiInstance = new PartnerV1LegacyApi(configuration);
-
-const { status, data } = await apiInstance.legacyControllerCheckPost();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**LegacyEnvelopeDto**
-
-### Authorization
-
-No authorization required
-
-### 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#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-

package/docs/PartnerV2Api.md

@@ -1,166 +0,0 @@
-# PartnerV2Api
-
-All URIs are relative to *http://localhost*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**registerAward**](#registeraward) | **POST** /v2/awards | 낙찰 결과 전송|
-|[**registerBid**](#registerbid) | **POST** /v2/bids | 입찰 정보 전송(등록)|
-|[**uploadFile**](#uploadfile) | **POST** /v2/files | 입찰 첨부파일 업로드(base64 또는 url) → fileKey|
-
-# **registerAward**
-> AwardRegisteredResponseDto registerAward(registerAwardRequestDto)
-
-V5 /scsbidSend 후속. 스코프 `awards:write` + `Idempotency-Key` 헤더 필수.
-
-### Example
-
-```typescript
-import {
-    PartnerV2Api,
-    Configuration,
-    RegisterAwardRequestDto
-} from '@cmarket/partner-sdk';
-
-const configuration = new Configuration();
-const apiInstance = new PartnerV2Api(configuration);
-
-let registerAwardRequestDto: RegisterAwardRequestDto; //
-
-const { status, data } = await apiInstance.registerAward(
-    registerAwardRequestDto
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **registerAwardRequestDto** | **RegisterAwardRequestDto**|  | |
-
-
-### Return type
-
-**AwardRegisteredResponseDto**
-
-### Authorization
-
-[partner-oauth2](../README.md#partner-oauth2)
-
-### 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#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **registerBid**
-> BidCreatedResponseDto registerBid(createBidRequestDto)
-
-V5 /bidsend 후속. 스코프 `bids:write` + `Idempotency-Key` 헤더 필수.
-
-### Example
-
-```typescript
-import {
-    PartnerV2Api,
-    Configuration,
-    CreateBidRequestDto
-} from '@cmarket/partner-sdk';
-
-const configuration = new Configuration();
-const apiInstance = new PartnerV2Api(configuration);
-
-let createBidRequestDto: CreateBidRequestDto; //
-
-const { status, data } = await apiInstance.registerBid(
-    createBidRequestDto
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **createBidRequestDto** | **CreateBidRequestDto**|  | |
-
-
-### Return type
-
-**BidCreatedResponseDto**
-
-### Authorization
-
-[partner-oauth2](../README.md#partner-oauth2)
-
-### 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#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **uploadFile**
-> FileUploadedResponseDto uploadFile(uploadFileRequestDto)
-
-스코프 `files:write` 필수. base64 또는 url 중 하나를 제출한다.
-
-### Example
-
-```typescript
-import {
-    PartnerV2Api,
-    Configuration,
-    UploadFileRequestDto
-} from '@cmarket/partner-sdk';
-
-const configuration = new Configuration();
-const apiInstance = new PartnerV2Api(configuration);
-
-let uploadFileRequestDto: UploadFileRequestDto; //
-
-const { status, data } = await apiInstance.uploadFile(
-    uploadFileRequestDto
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **uploadFileRequestDto** | **UploadFileRequestDto**|  | |
-
-
-### Return type
-
-**FileUploadedResponseDto**
-
-### Authorization
-
-[partner-oauth2](../README.md#partner-oauth2)
-
-### 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#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-