@cmarket/partner-sdk 0.2.1 → 0.4.0

package/docs/PartnerV1Api.md

@@ -4,13 +4,80 @@ All URIs are relative to *http://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**bidsControllerFindOne**](#bidscontrollerfindone) | **GET** /v1/bids/{bidId} | 공고 단건 조회|
+|[**completeAcceptance**](#completeacceptance) | **POST** /v1/bids/{bidId}/acceptance | 검수완료 전송|
+|[**getBidContractDocuments**](#getbidcontractdocuments) | **GET** /v1/bids/{bidId}/contract-documents | 계약서류 수신 조회|
+|[**getBidContractDocumentsBatch**](#getbidcontractdocumentsbatch) | **POST** /v1/bids/contract-documents/batch | 계약서류 수신 배치 조회|
+|[**getBidResults**](#getbidresults) | **GET** /v1/bids/{bidId}/results | 입찰 결과 조회|
+|[**getBidResultsBatch**](#getbidresultsbatch) | **POST** /v1/bids/results/batch | 입찰결과 배치 조회|
+|[**getBidSettlement**](#getbidsettlement) | **GET** /v1/bids/{bidId}/settlement | 입찰결과 정산정보 조회|
+|[**getBidStatement**](#getbidstatement) | **GET** /v1/bids/{bidId}/statement | 거래명세서 조회|
 |[**healthControllerCheck**](#healthcontrollercheck) | **GET** /v1/health | Partner API 헬스체크|
+|[**markBidFailed**](#markbidfailed) | **POST** /v1/awards/fail | 유찰 처리|
+|[**registerAward**](#registeraward) | **POST** /v1/awards | 낙찰 결과 전송|
+|[**registerBid**](#registerbid) | **POST** /v1/bids | 입찰 정보 전송(등록)|
+|[**requestSplitInvoice**](#requestsplitinvoice) | **POST** /v1/invoices/split-requests | 계산서 분할 발급 청구|
+|[**submitNegotiationScores**](#submitnegotiationscores) | **POST** /v1/awards/nego-eval | 협상(H/K) 점수평가|
+|[**uploadFile**](#uploadfile) | **POST** /v1/files | 입찰 첨부파일 업로드(base64 또는 url) → fileKey|
 
-# **bidsControllerFindOne**
-> BidSummaryResponseDto bidsControllerFindOne()
+# **completeAcceptance**
+> AcceptanceResultResponseDto completeAcceptance(completeAcceptanceRequestDto)
 
-ERP 가 공고 정보를 조회합니다. 인증 필요 (스코프 `bids:read`).
+V5 /acceptanceCompleteSend 후속. scope contracts:write + Idempotency-Key.
+
+### Example
+
+```typescript
+import {
+    PartnerV1Api,
+    Configuration,
+    CompleteAcceptanceRequestDto
+} from '@cmarket/partner-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new PartnerV1Api(configuration);
+
+let bidId: string; // (default to undefined)
+let completeAcceptanceRequestDto: CompleteAcceptanceRequestDto; //
+
+const { status, data } = await apiInstance.completeAcceptance(
+    bidId,
+    completeAcceptanceRequestDto
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **completeAcceptanceRequestDto** | **CompleteAcceptanceRequestDto**|  | |
+| **bidId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**AcceptanceResultResponseDto**
+
+### 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 |
+|-------------|-------------|------------------|
+|**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)
+
+# **getBidContractDocuments**
+> BidContractDocumentsResponseDto getBidContractDocuments()
+
+V5 /contractDocumentRec 후속. scope contracts:read.
 
 ### Example
 
@@ -24,8 +91,220 @@ const configuration = new Configuration();
 const apiInstance = new PartnerV1Api(configuration);
 
 let bidId: string; // (default to undefined)
+let buyerId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getBidContractDocuments(
+    bidId,
+    buyerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **bidId** | [**string**] |  | defaults to undefined|
+| **buyerId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**BidContractDocumentsResponseDto**
+
+### Authorization
+
+[partner-oauth2](../README.md#partner-oauth2)
+
+### 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)
+
+# **getBidContractDocumentsBatch**
+> Array<BidContractDocumentsResponseDto> getBidContractDocumentsBatch(bidContractDocumentsBatchRequestDto)
+
+V5 /contractDocumentRec(bid_puchase_no_list) 후속. 공고번호 리스트를 한 번에 조회. 단건(GET :bidId/contract-documents)은 그대로 유지. scope contracts:read.
+
+### Example
+
+```typescript
+import {
+    PartnerV1Api,
+    Configuration,
+    BidContractDocumentsBatchRequestDto
+} from '@cmarket/partner-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new PartnerV1Api(configuration);
+
+let bidContractDocumentsBatchRequestDto: BidContractDocumentsBatchRequestDto; //
+
+const { status, data } = await apiInstance.getBidContractDocumentsBatch(
+    bidContractDocumentsBatchRequestDto
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **bidContractDocumentsBatchRequestDto** | **BidContractDocumentsBatchRequestDto**|  | |
+
 
-const { status, data } = await apiInstance.bidsControllerFindOne(
+### Return type
+
+**Array<BidContractDocumentsResponseDto>**
+
+### 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 |
+|-------------|-------------|------------------|
+|**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)
+
+# **getBidResults**
+> BidResultsResponseDto getBidResults()
+
+V5 /entendrec 후속. scope bids:read.
+
+### Example
+
+```typescript
+import {
+    PartnerV1Api,
+    Configuration
+} from '@cmarket/partner-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new PartnerV1Api(configuration);
+
+let bidId: string; // (default to undefined)
+let buyerId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getBidResults(
+    bidId,
+    buyerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **bidId** | [**string**] |  | defaults to undefined|
+| **buyerId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**BidResultsResponseDto**
+
+### Authorization
+
+[partner-oauth2](../README.md#partner-oauth2)
+
+### 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)
+
+# **getBidResultsBatch**
+> Array<BidResultsResponseDto> getBidResultsBatch(bidResultsBatchRequestDto)
+
+V5 entendRec(bid_puchase_no_list) 후속 — 여러 공고 결과를 1회 호출로(additive, 단건 유지). 입력 순서를 보존한다. scope bids:read.
+
+### Example
+
+```typescript
+import {
+    PartnerV1Api,
+    Configuration,
+    BidResultsBatchRequestDto
+} from '@cmarket/partner-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new PartnerV1Api(configuration);
+
+let bidResultsBatchRequestDto: BidResultsBatchRequestDto; //
+
+const { status, data } = await apiInstance.getBidResultsBatch(
+    bidResultsBatchRequestDto
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **bidResultsBatchRequestDto** | **BidResultsBatchRequestDto**|  | |
+
+
+### Return type
+
+**Array<BidResultsResponseDto>**
+
+### 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 |
+|-------------|-------------|------------------|
+|**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)
+
+# **getBidSettlement**
+> BidSettlementResponseDto getBidSettlement()
+
+V5 /entendrec 정산(사업자·계좌·공급가액/부가세·응찰 품목내역) 후속. scope bids:read. 가격/신원 가시성 매트릭스와 직교한 ERP 정산 데이터 — read-only.
+
+### Example
+
+```typescript
+import {
+    PartnerV1Api,
+    Configuration
+} from '@cmarket/partner-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new PartnerV1Api(configuration);
+
+let bidId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getBidSettlement(
     bidId
 );
 ```
@@ -39,7 +318,61 @@ const { status, data } = await apiInstance.bidsControllerFindOne(
 
 ### Return type
 
-**BidSummaryResponseDto**
+**BidSettlementResponseDto**
+
+### Authorization
+
+[partner-oauth2](../README.md#partner-oauth2)
+
+### 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)
+
+# **getBidStatement**
+> BidStatementResponseDto getBidStatement()
+
+V5 /getGrm 후속. scope contracts:read.
+
+### Example
+
+```typescript
+import {
+    PartnerV1Api,
+    Configuration
+} from '@cmarket/partner-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new PartnerV1Api(configuration);
+
+let bidId: string; // (default to undefined)
+let paperCode: number; // (default to undefined)
+
+const { status, data } = await apiInstance.getBidStatement(
+    bidId,
+    paperCode
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **bidId** | [**string**] |  | defaults to undefined|
+| **paperCode** | [**number**] |  | defaults to undefined|
+
+
+### Return type
+
+**BidStatementResponseDto**
 
 ### Authorization
 
@@ -55,7 +388,6 @@ const { status, data } = await apiInstance.bidsControllerFindOne(
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** |  |  -  |
-|**401** | invalid_token / insufficient_scope / ip_not_allowed |  -  |
 
 [[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)
 
@@ -103,3 +435,315 @@ No authorization required
 
 [[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)
 
+# **markBidFailed**
+> BidFailedResponseDto markBidFailed(markBidFailedRequestDto)
+
+유찰 처리(V5 yoochal 패리티). 유찰사유 코드(1~8)·상세를 받아 공고를 유찰 상태로 전환. 스코프 `awards:write` + `Idempotency-Key` 헤더 필수.
+
+### Example
+
+```typescript
+import {
+    PartnerV1Api,
+    Configuration,
+    MarkBidFailedRequestDto
+} from '@cmarket/partner-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new PartnerV1Api(configuration);
+
+let markBidFailedRequestDto: MarkBidFailedRequestDto; //
+
+const { status, data } = await apiInstance.markBidFailed(
+    markBidFailedRequestDto
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **markBidFailedRequestDto** | **MarkBidFailedRequestDto**|  | |
+
+
+### Return type
+
+**BidFailedResponseDto**
+
+### 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)
+
+# **registerAward**
+> AwardRegisteredResponseDto registerAward(registerAwardRequestDto)
+
+낙찰 결과 등록. 스코프 `awards:write` + `Idempotency-Key` 헤더 필수.
+
+### Example
+
+```typescript
+import {
+    PartnerV1Api,
+    Configuration,
+    RegisterAwardRequestDto
+} from '@cmarket/partner-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new PartnerV1Api(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)
+
+입찰 정보 등록. 스코프 `bids:write` + `Idempotency-Key` 헤더 필수.
+
+### Example
+
+```typescript
+import {
+    PartnerV1Api,
+    Configuration,
+    CreateBidRequestDto
+} from '@cmarket/partner-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new PartnerV1Api(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)
+
+# **requestSplitInvoice**
+> SplitInvoiceResponseDto requestSplitInvoice(requestSplitInvoiceRequestDto)
+
+V5 /splitInvoiceRequest 후속. scope invoices:write + Idempotency-Key.
+
+### Example
+
+```typescript
+import {
+    PartnerV1Api,
+    Configuration,
+    RequestSplitInvoiceRequestDto
+} from '@cmarket/partner-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new PartnerV1Api(configuration);
+
+let requestSplitInvoiceRequestDto: RequestSplitInvoiceRequestDto; //
+
+const { status, data } = await apiInstance.requestSplitInvoice(
+    requestSplitInvoiceRequestDto
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **requestSplitInvoiceRequestDto** | **RequestSplitInvoiceRequestDto**|  | |
+
+
+### Return type
+
+**SplitInvoiceResponseDto**
+
+### 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 |
+|-------------|-------------|------------------|
+|**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)
+
+# **submitNegotiationScores**
+> NegotiationScoredResponseDto submitNegotiationScores(submitNegotiationScoresRequestDto)
+
+협상에의한계약(H/K) 응찰자별 기술/가격 점수 일괄 입력(V5 nego-eval 패리티). complete=true 면 평가완료 게이트까지 적용해 낙찰 진입 가능. 스코프 `awards:write` + `Idempotency-Key` 헤더 필수.
+
+### Example
+
+```typescript
+import {
+    PartnerV1Api,
+    Configuration,
+    SubmitNegotiationScoresRequestDto
+} from '@cmarket/partner-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new PartnerV1Api(configuration);
+
+let submitNegotiationScoresRequestDto: SubmitNegotiationScoresRequestDto; //
+
+const { status, data } = await apiInstance.submitNegotiationScores(
+    submitNegotiationScoresRequestDto
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **submitNegotiationScoresRequestDto** | **SubmitNegotiationScoresRequestDto**|  | |
+
+
+### Return type
+
+**NegotiationScoredResponseDto**
+
+### 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 {
+    PartnerV1Api,
+    Configuration,
+    UploadFileRequestDto
+} from '@cmarket/partner-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new PartnerV1Api(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)
+

package/models/create-bid-request-dto.ts

@@ -51,7 +51,7 @@ export interface CreateBidRequestDto {
      */
     'disclosePlannedAmount': boolean;
     /**
-     * 첨부파일 fileKey 배열 (POST /v2/files 응답에서 받은 32자 키). backend b2b_file_info 참조.
+     * 첨부파일 fileKey 배열 (POST /v1/files 응답에서 받은 32자 키). backend b2b_file_info 참조.
      */
     'attachments'?: Array<string>;
     /**
@@ -131,7 +131,7 @@ export interface CreateBidRequestDto {
      */
     'deliveryPeriodDays'?: number;
     /**
-     * 납품 방법. A=택배(직납가능), B=직접납품, C=납품및설치, D=픽업. backend BidDeliveryMethod mirror.
+     * 납품 방법. A=택배(직납가능), B=직접납품, C=납품및설치. backend BidDeliveryMethod mirror.
      */
     'deliveryMethod'?: CreateBidRequestDtoDeliveryMethodEnum;
     /**
@@ -285,7 +285,6 @@ export const CreateBidRequestDtoDeliveryMethodEnum = {
     A: 'A',
     B: 'B',
     C: 'C',
-    D: 'D',
 } as const;
 
 export type CreateBidRequestDtoDeliveryMethodEnum = typeof CreateBidRequestDtoDeliveryMethodEnum[keyof typeof CreateBidRequestDtoDeliveryMethodEnum];