@cmarket/partner-sdk 1.3.0 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -7
- package/api/partner-v2-api.ts +0 -406
- package/dist/api/partner-v2-api.d.ts +0 -179
- package/dist/api/partner-v2-api.js +0 -376
- package/dist/esm/api/partner-v2-api.d.ts +0 -179
- package/dist/esm/api/partner-v2-api.js +0 -376
- package/docs/PartnerV2Api.md +0 -283
- package/package.json +1 -1
package/docs/PartnerV2Api.md
CHANGED
|
@@ -5,18 +5,13 @@ All URIs are relative to *http://localhost*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**completeAcceptance**](#completeacceptance) | **POST** /v2/bids/{bidId}/acceptance | 검수완료 전송|
|
|
8
|
-
|[**getBidContractDocuments**](#getbidcontractdocuments) | **GET** /v2/bids/{bidId}/contract-documents | 계약서류 수신 조회|
|
|
9
|
-
|[**getBidContractDocumentsBatch**](#getbidcontractdocumentsbatch) | **POST** /v2/bids/contract-documents/batch | 계약서류 수신 배치 조회|
|
|
10
8
|
|[**getBidResults**](#getbidresults) | **GET** /v2/bids/{bidId}/results | 입찰 결과 조회|
|
|
11
|
-
|[**getBidResultsBatch**](#getbidresultsbatch) | **POST** /v2/bids/results/batch | 입찰결과 배치 조회|
|
|
12
9
|
|[**getBidSettlement**](#getbidsettlement) | **GET** /v2/bids/{bidId}/settlement | 입찰결과 정산정보 조회|
|
|
13
10
|
|[**getBidStatement**](#getbidstatement) | **GET** /v2/bids/{bidId}/statement | 거래명세서 조회|
|
|
14
11
|
|[**healthControllerCheck**](#healthcontrollercheck) | **GET** /health | Partner API 헬스체크|
|
|
15
12
|
|[**markBidFailed**](#markbidfailed) | **POST** /v2/awards/fail | 유찰 처리|
|
|
16
13
|
|[**registerAward**](#registeraward) | **POST** /v2/awards | 낙찰 결과 전송|
|
|
17
14
|
|[**registerBid**](#registerbid) | **POST** /v2/bids | 입찰 정보 전송(등록)|
|
|
18
|
-
|[**requestSplitInvoice**](#requestsplitinvoice) | **POST** /v2/invoices/split-requests | 계산서 분할 발급 청구|
|
|
19
|
-
|[**submitNegotiationScores**](#submitnegotiationscores) | **POST** /v2/awards/nego-eval | 협상(H/K) 점수평가|
|
|
20
15
|
|[**uploadFile**](#uploadfile) | **POST** /v2/files | 입찰 첨부파일 업로드(base64 또는 url) → fileKey|
|
|
21
16
|
|
|
22
17
|
# **completeAcceptance**
|
|
@@ -82,112 +77,6 @@ const { status, data } = await apiInstance.completeAcceptance(
|
|
|
82
77
|
|
|
83
78
|
[[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)
|
|
84
79
|
|
|
85
|
-
# **getBidContractDocuments**
|
|
86
|
-
> BidContractDocumentsResponseDto getBidContractDocuments()
|
|
87
|
-
|
|
88
|
-
V5 /contractDocumentRec 후속. scope contracts:read.
|
|
89
|
-
|
|
90
|
-
### Example
|
|
91
|
-
|
|
92
|
-
```typescript
|
|
93
|
-
import {
|
|
94
|
-
PartnerV2Api,
|
|
95
|
-
Configuration
|
|
96
|
-
} from '@cmarket/partner-sdk';
|
|
97
|
-
|
|
98
|
-
const configuration = new Configuration();
|
|
99
|
-
const apiInstance = new PartnerV2Api(configuration);
|
|
100
|
-
|
|
101
|
-
let bidId: string; // (default to undefined)
|
|
102
|
-
let buyerId: string; //공고 명의 회원 ID(b2b_member.member_id). (default to undefined)
|
|
103
|
-
|
|
104
|
-
const { status, data } = await apiInstance.getBidContractDocuments(
|
|
105
|
-
bidId,
|
|
106
|
-
buyerId
|
|
107
|
-
);
|
|
108
|
-
```
|
|
109
|
-
|
|
110
|
-
### Parameters
|
|
111
|
-
|
|
112
|
-
|Name | Type | Description | Notes|
|
|
113
|
-
|------------- | ------------- | ------------- | -------------|
|
|
114
|
-
| **bidId** | [**string**] | | defaults to undefined|
|
|
115
|
-
| **buyerId** | [**string**] | 공고 명의 회원 ID(b2b_member.member_id). | defaults to undefined|
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
### Return type
|
|
119
|
-
|
|
120
|
-
**BidContractDocumentsResponseDto**
|
|
121
|
-
|
|
122
|
-
### Authorization
|
|
123
|
-
|
|
124
|
-
[partner-oauth2](../README.md#partner-oauth2)
|
|
125
|
-
|
|
126
|
-
### HTTP request headers
|
|
127
|
-
|
|
128
|
-
- **Content-Type**: Not defined
|
|
129
|
-
- **Accept**: application/json
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
### HTTP response details
|
|
133
|
-
| Status code | Description | Response headers |
|
|
134
|
-
|-------------|-------------|------------------|
|
|
135
|
-
|**200** | | - |
|
|
136
|
-
|
|
137
|
-
[[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)
|
|
138
|
-
|
|
139
|
-
# **getBidContractDocumentsBatch**
|
|
140
|
-
> Array<BidContractDocumentsResponseDto> getBidContractDocumentsBatch(bidContractDocumentsBatchRequestDto)
|
|
141
|
-
|
|
142
|
-
V5 /contractDocumentRec(bid_puchase_no_list) 후속. 공고번호 리스트를 한 번에 조회. 단건(GET :bidId/contract-documents)은 그대로 유지. scope contracts:read.
|
|
143
|
-
|
|
144
|
-
### Example
|
|
145
|
-
|
|
146
|
-
```typescript
|
|
147
|
-
import {
|
|
148
|
-
PartnerV2Api,
|
|
149
|
-
Configuration,
|
|
150
|
-
BidContractDocumentsBatchRequestDto
|
|
151
|
-
} from '@cmarket/partner-sdk';
|
|
152
|
-
|
|
153
|
-
const configuration = new Configuration();
|
|
154
|
-
const apiInstance = new PartnerV2Api(configuration);
|
|
155
|
-
|
|
156
|
-
let bidContractDocumentsBatchRequestDto: BidContractDocumentsBatchRequestDto; //
|
|
157
|
-
|
|
158
|
-
const { status, data } = await apiInstance.getBidContractDocumentsBatch(
|
|
159
|
-
bidContractDocumentsBatchRequestDto
|
|
160
|
-
);
|
|
161
|
-
```
|
|
162
|
-
|
|
163
|
-
### Parameters
|
|
164
|
-
|
|
165
|
-
|Name | Type | Description | Notes|
|
|
166
|
-
|------------- | ------------- | ------------- | -------------|
|
|
167
|
-
| **bidContractDocumentsBatchRequestDto** | **BidContractDocumentsBatchRequestDto**| | |
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
### Return type
|
|
171
|
-
|
|
172
|
-
**Array<BidContractDocumentsResponseDto>**
|
|
173
|
-
|
|
174
|
-
### Authorization
|
|
175
|
-
|
|
176
|
-
[partner-oauth2](../README.md#partner-oauth2)
|
|
177
|
-
|
|
178
|
-
### HTTP request headers
|
|
179
|
-
|
|
180
|
-
- **Content-Type**: application/json
|
|
181
|
-
- **Accept**: application/json
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
### HTTP response details
|
|
185
|
-
| Status code | Description | Response headers |
|
|
186
|
-
|-------------|-------------|------------------|
|
|
187
|
-
|**200** | | - |
|
|
188
|
-
|
|
189
|
-
[[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)
|
|
190
|
-
|
|
191
80
|
# **getBidResults**
|
|
192
81
|
> BidResultsResponseDto getBidResults()
|
|
193
82
|
|
|
@@ -235,58 +124,6 @@ const { status, data } = await apiInstance.getBidResults(
|
|
|
235
124
|
- **Accept**: application/json
|
|
236
125
|
|
|
237
126
|
|
|
238
|
-
### HTTP response details
|
|
239
|
-
| Status code | Description | Response headers |
|
|
240
|
-
|-------------|-------------|------------------|
|
|
241
|
-
|**200** | | - |
|
|
242
|
-
|
|
243
|
-
[[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)
|
|
244
|
-
|
|
245
|
-
# **getBidResultsBatch**
|
|
246
|
-
> Array<BidResultsResponseDto> getBidResultsBatch(bidResultsBatchRequestDto)
|
|
247
|
-
|
|
248
|
-
V5 entendRec(bid_puchase_no_list) 후속 — 여러 공고 결과를 1회 호출로(additive, 단건 유지). bidIds(공고 식별자) 또는 purchaseNos(구매번호) 중 하나 — purchaseNos 는 각 PO 의 가장 최근 공고로 해소. 입력 순서를 보존한다. scope bids:read.
|
|
249
|
-
|
|
250
|
-
### Example
|
|
251
|
-
|
|
252
|
-
```typescript
|
|
253
|
-
import {
|
|
254
|
-
PartnerV2Api,
|
|
255
|
-
Configuration,
|
|
256
|
-
BidResultsBatchRequestDto
|
|
257
|
-
} from '@cmarket/partner-sdk';
|
|
258
|
-
|
|
259
|
-
const configuration = new Configuration();
|
|
260
|
-
const apiInstance = new PartnerV2Api(configuration);
|
|
261
|
-
|
|
262
|
-
let bidResultsBatchRequestDto: BidResultsBatchRequestDto; //
|
|
263
|
-
|
|
264
|
-
const { status, data } = await apiInstance.getBidResultsBatch(
|
|
265
|
-
bidResultsBatchRequestDto
|
|
266
|
-
);
|
|
267
|
-
```
|
|
268
|
-
|
|
269
|
-
### Parameters
|
|
270
|
-
|
|
271
|
-
|Name | Type | Description | Notes|
|
|
272
|
-
|------------- | ------------- | ------------- | -------------|
|
|
273
|
-
| **bidResultsBatchRequestDto** | **BidResultsBatchRequestDto**| | |
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
### Return type
|
|
277
|
-
|
|
278
|
-
**Array<BidResultsResponseDto>**
|
|
279
|
-
|
|
280
|
-
### Authorization
|
|
281
|
-
|
|
282
|
-
[partner-oauth2](../README.md#partner-oauth2)
|
|
283
|
-
|
|
284
|
-
### HTTP request headers
|
|
285
|
-
|
|
286
|
-
- **Content-Type**: application/json
|
|
287
|
-
- **Accept**: application/json
|
|
288
|
-
|
|
289
|
-
|
|
290
127
|
### HTTP response details
|
|
291
128
|
| Status code | Description | Response headers |
|
|
292
129
|
|-------------|-------------|------------------|
|
|
@@ -615,126 +452,6 @@ const { status, data } = await apiInstance.registerBid(
|
|
|
615
452
|
|
|
616
453
|
[[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)
|
|
617
454
|
|
|
618
|
-
# **requestSplitInvoice**
|
|
619
|
-
> SplitInvoiceResponseDto requestSplitInvoice(requestSplitInvoiceRequestDto)
|
|
620
|
-
|
|
621
|
-
세금계산서 분할 발급 청구를 기록합니다. 발급 엔진이 아니라 \"분할 발급 청구 요청을 접수\"하는 엔드포인트입니다. **V5 대응:** `splitInvoiceRequest` — BidApi.xml `splitInvoice` 액션의 V6 후속. **호출 시점:** 검수완료 후 세금계산서를 분할 발급받고자 할 때. 공급가액과 부가세를 나누어 청구합니다. **부수효과:** - 분할 발급 청구가 기록됩니다(실제 세금계산서 발급은 별도 프로세스). - 작성일자(`issueDate`)는 미래 일자 불가(I5 — V5 `PgBidApiService:220-235` 패리티). 오늘 날짜는 허용. - `issueDate` 미지정 시 backend 기본값 적용. **금액 단위:** 원(KRW) 정수. `supplyAmount`(공급가액) + `vat`(부가세) 합산이 실제 청구 총액. **필수 스코프:** `invoices:write` **멱등성:** `Idempotency-Key` 헤더 필수.
|
|
622
|
-
|
|
623
|
-
### Example
|
|
624
|
-
|
|
625
|
-
```typescript
|
|
626
|
-
import {
|
|
627
|
-
PartnerV2Api,
|
|
628
|
-
Configuration,
|
|
629
|
-
RequestSplitInvoiceRequestDto
|
|
630
|
-
} from '@cmarket/partner-sdk';
|
|
631
|
-
|
|
632
|
-
const configuration = new Configuration();
|
|
633
|
-
const apiInstance = new PartnerV2Api(configuration);
|
|
634
|
-
|
|
635
|
-
let idempotencyKey: string; //멱등성 키(1~255자, [A-Za-z0-9_-]). 동일 키 + 동일 body 재전송 시 캐시 응답 반환(24시간). UUID v4 권장. (default to undefined)
|
|
636
|
-
let requestSplitInvoiceRequestDto: RequestSplitInvoiceRequestDto; //
|
|
637
|
-
|
|
638
|
-
const { status, data } = await apiInstance.requestSplitInvoice(
|
|
639
|
-
idempotencyKey,
|
|
640
|
-
requestSplitInvoiceRequestDto
|
|
641
|
-
);
|
|
642
|
-
```
|
|
643
|
-
|
|
644
|
-
### Parameters
|
|
645
|
-
|
|
646
|
-
|Name | Type | Description | Notes|
|
|
647
|
-
|------------- | ------------- | ------------- | -------------|
|
|
648
|
-
| **requestSplitInvoiceRequestDto** | **RequestSplitInvoiceRequestDto**| | |
|
|
649
|
-
| **idempotencyKey** | [**string**] | 멱등성 키(1~255자, [A-Za-z0-9_-]). 동일 키 + 동일 body 재전송 시 캐시 응답 반환(24시간). UUID v4 권장. | defaults to undefined|
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
### Return type
|
|
653
|
-
|
|
654
|
-
**SplitInvoiceResponseDto**
|
|
655
|
-
|
|
656
|
-
### Authorization
|
|
657
|
-
|
|
658
|
-
[partner-oauth2](../README.md#partner-oauth2)
|
|
659
|
-
|
|
660
|
-
### HTTP request headers
|
|
661
|
-
|
|
662
|
-
- **Content-Type**: application/json
|
|
663
|
-
- **Accept**: application/json
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
### HTTP response details
|
|
667
|
-
| Status code | Description | Response headers |
|
|
668
|
-
|-------------|-------------|------------------|
|
|
669
|
-
|**200** | 분할 발급 청구 접수 완료. | - |
|
|
670
|
-
|**400** | 입력 검증 실패(`type: …/validation-failed`) 또는 Idempotency-Key 헤더 누락(`type: …/idempotency-key-required`). issueDate 가 미래 일자인 경우도 400. | - |
|
|
671
|
-
|**401** | Bearer 토큰 없음 또는 만료(`type: …/unauthorized`). | - |
|
|
672
|
-
|**403** | 스코프 부족(`type: …/insufficient-scope`) 또는 buyerId 가 키 보유자와 불일치(`type: …/buyer-scope-mismatch`). | - |
|
|
673
|
-
|**409** | 동일 Idempotency-Key 로 다른 body 재전송(`type: …/idempotency-key-conflict`). | - |
|
|
674
|
-
|**502** | backend 도메인 거부 — 공고 상태 불일치, 이미 청구 완료 등(`type: …/upstream-rejected`). | - |
|
|
675
|
-
|
|
676
|
-
[[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)
|
|
677
|
-
|
|
678
|
-
# **submitNegotiationScores**
|
|
679
|
-
> NegotiationScoredResponseDto submitNegotiationScores(submitNegotiationScoresRequestDto)
|
|
680
|
-
|
|
681
|
-
협상에의한계약(낙찰방법 H/K) 응찰자별 기술/가격 점수를 일괄 입력합니다. **V5 대응:** `scsbidSend`(type=nego, 점수입력) — BidApi.xml `nego-eval` 액션의 V6 후속. **호출 시점:** 협상 방식 공고 마감 후 점수 평가를 진행할 때. `complete=true` 를 함께 보내면 평가완료 게이트(V5 `nego_complete_yn=Y`)까지 적용되어 낙찰 진입이 가능합니다. **부수효과:** - 각 응찰자의 기술점수(`techPoint`) 및 가격점수(`bidPoint`, 선택)가 저장됩니다. - `complete=true`인 경우 평가완료 상태로 전환되어 이후 `/v1/awards`로 낙찰 처리가 가능합니다. - 가격점수(`bidPoint`)를 생략하면 backend 가 배점 기준에 따라 자동 계산합니다. **응찰자 식별:** `sequence`(= V5 `buy_seq`, `entendrec` 응답의 `sequence` 필드). **필수 스코프:** `awards:write` **멱등성:** `Idempotency-Key` 헤더 필수.
|
|
682
|
-
|
|
683
|
-
### Example
|
|
684
|
-
|
|
685
|
-
```typescript
|
|
686
|
-
import {
|
|
687
|
-
PartnerV2Api,
|
|
688
|
-
Configuration,
|
|
689
|
-
SubmitNegotiationScoresRequestDto
|
|
690
|
-
} from '@cmarket/partner-sdk';
|
|
691
|
-
|
|
692
|
-
const configuration = new Configuration();
|
|
693
|
-
const apiInstance = new PartnerV2Api(configuration);
|
|
694
|
-
|
|
695
|
-
let idempotencyKey: string; //멱등성 키(1~255자, [A-Za-z0-9_-]). 동일 키 + 동일 body 재전송 시 캐시 응답 반환(24시간). UUID v4 권장. (default to undefined)
|
|
696
|
-
let submitNegotiationScoresRequestDto: SubmitNegotiationScoresRequestDto; //
|
|
697
|
-
|
|
698
|
-
const { status, data } = await apiInstance.submitNegotiationScores(
|
|
699
|
-
idempotencyKey,
|
|
700
|
-
submitNegotiationScoresRequestDto
|
|
701
|
-
);
|
|
702
|
-
```
|
|
703
|
-
|
|
704
|
-
### Parameters
|
|
705
|
-
|
|
706
|
-
|Name | Type | Description | Notes|
|
|
707
|
-
|------------- | ------------- | ------------- | -------------|
|
|
708
|
-
| **submitNegotiationScoresRequestDto** | **SubmitNegotiationScoresRequestDto**| | |
|
|
709
|
-
| **idempotencyKey** | [**string**] | 멱등성 키(1~255자, [A-Za-z0-9_-]). 동일 키 + 동일 body 재전송 시 캐시 응답 반환(24시간). UUID v4 권장. | defaults to undefined|
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
### Return type
|
|
713
|
-
|
|
714
|
-
**NegotiationScoredResponseDto**
|
|
715
|
-
|
|
716
|
-
### Authorization
|
|
717
|
-
|
|
718
|
-
[partner-oauth2](../README.md#partner-oauth2)
|
|
719
|
-
|
|
720
|
-
### HTTP request headers
|
|
721
|
-
|
|
722
|
-
- **Content-Type**: application/json
|
|
723
|
-
- **Accept**: application/json
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
### HTTP response details
|
|
727
|
-
| Status code | Description | Response headers |
|
|
728
|
-
|-------------|-------------|------------------|
|
|
729
|
-
|**201** | 점수 입력 완료. | - |
|
|
730
|
-
|**400** | 입력 검증 실패(`type: …/validation-failed`) 또는 Idempotency-Key 헤더 누락(`type: …/idempotency-key-required`). scores 배열이 비어 있거나 sequence 중복 시 400. | - |
|
|
731
|
-
|**401** | Bearer 토큰 없음 또는 만료(`type: …/unauthorized`). | - |
|
|
732
|
-
|**403** | 스코프 부족(`type: …/insufficient-scope`) 또는 buyerId 가 키 보유자와 불일치(`type: …/buyer-scope-mismatch`). | - |
|
|
733
|
-
|**409** | 동일 Idempotency-Key 로 다른 body 재전송(`type: …/idempotency-key-conflict`). | - |
|
|
734
|
-
|**502** | backend 도메인 거부 — 공고 상태 불일치, 응찰자 미존재 등(`type: …/upstream-rejected`). | - |
|
|
735
|
-
|
|
736
|
-
[[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)
|
|
737
|
-
|
|
738
455
|
# **uploadFile**
|
|
739
456
|
> FileUploadedResponseDto uploadFile(uploadFileRequestDto)
|
|
740
457
|
|