@cmarket/partner-sdk 48.0.0 → 49.1.0

package/docs/BidProductDto.md

@@ -1,38 +0,0 @@
-# BidProductDto
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**itemCode** | **string** | 품목 코드. | [default to undefined]
-**productName** | **string** | 품목명. | [default to undefined]
-**spec** | **string** | 규격. | [default to undefined]
-**unit** | **string** | 단위. | [default to undefined]
-**quantity** | **number** | 수량. | [default to undefined]
-**unitPrice** | **number** | 단가(원). 부가세 포함 여부는 `amountsIncludeVat` 를 따릅니다. | [default to undefined]
-**manufacturer** | **string** | 제조사. 공고상세 화면이 규격 줄에 함께 표시하는 보조 식별 정보다. | [default to undefined]
-**modelNumber** | **string** | 모델명. | [default to undefined]
-**taxationType** | [**TaxationTypePublic**](TaxationTypePublic.md) | 과세구분. 공고 단위 기본값과 다른 품목을 위해 품목마다 따로 실린다. 미지정이면 null. | [default to undefined]
-**handoverType** | [**HandoverTypePublic**](HandoverTypePublic.md) | 인수도 방식. `LOADING_POINT`=상차도(출하지 인수), `ARRIVAL_POINT`=도착도(납품장소 인수). 미지정이면 null. | [default to undefined]
-
-## Example
-
-```typescript
-import { BidProductDto } from '@cmarket/partner-sdk';
-
-const instance: BidProductDto = {
-    itemCode,
-    productName,
-    spec,
-    unit,
-    quantity,
-    unitPrice,
-    manufacturer,
-    modelNumber,
-    taxationType,
-    handoverType,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/BidQualificationReviewDto.md

@@ -1,28 +0,0 @@
-# BidQualificationReviewDto
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**ncBase** | **number** | 기초순공사원가(원). | [default to undefined]
-**aValues** | [**BidAValuesDto**](BidAValuesDto.md) | A값 7개 항목. | [default to undefined]
-**aValueSum** | **number** | A값 합계(원). | [default to undefined]
-**lowestPercent** | **number** | 적용 낙찰하한율(%). 미설정이면 null. | [default to undefined]
-**priceScoreType** | [**PriceScoreTypePublic**](PriceScoreTypePublic.md) | 가격점수 산식. `STANDARD`=기본산식(종합·전문공사), `SPECIALTY_LARGE`=전기·정보통신·소방·국가유산공사 10억 이상, `SPECIALTY_MEDIUM`=같은 업종 3억 이상~10억 미만. 미설정이면 null. | [default to undefined]
-
-## Example
-
-```typescript
-import { BidQualificationReviewDto } from '@cmarket/partner-sdk';
-
-const instance: BidQualificationReviewDto = {
-    ncBase,
-    aValues,
-    aValueSum,
-    lowestPercent,
-    priceScoreType,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/BidRegionDto.md

@@ -1,22 +0,0 @@
-# BidRegionDto
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**province** | **string** | 광역시도명. | [default to undefined]
-**districts** | **Array<string>** | 선택된 시군구. 광역 전체를 고른 경우 그 광역의 시군구가 모두 들어옵니다. | [default to undefined]
-
-## Example
-
-```typescript
-import { BidRegionDto } from '@cmarket/partner-sdk';
-
-const instance: BidRegionDto = {
-    province,
-    districts,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/BidRegionRestrictionDto.md

@@ -1,22 +0,0 @@
-# BidRegionRestrictionDto
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**regions** | [**Array<BidRegionDto>**](BidRegionDto.md) | 선택된 지역. 비어 있으면 제한 없음(전국)입니다. | [default to undefined]
-**sameRegionOnly** | **boolean** | 발주기관 인근 지역만 허용하는지(견적 도메인 전용 축). true면 `regions`와 무관하게 인근 지역으로 제한합니다. | [default to undefined]
-
-## Example
-
-```typescript
-import { BidRegionRestrictionDto } from '@cmarket/partner-sdk';
-
-const instance: BidRegionRestrictionDto = {
-    regions,
-    sameRegionOnly,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/BidRelatedBidDto.md

@@ -1,22 +0,0 @@
-# BidRelatedBidDto
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**bidId** | **string** | 연결된 공고 id. | [default to undefined]
-**relation** | [**RelatedBidRelation**](RelatedBidRelation.md) | 이 공고에서 본 상대의 위치. `STAGE_2`=이 공고(1단계)에서 파생된 2단계 공고, `STAGE_1`=이 공고(2단계)의 부모 1단계 공고, `PREVIOUS_BID`=재공고 직전 공고. | [default to undefined]
-
-## Example
-
-```typescript
-import { BidRelatedBidDto } from '@cmarket/partner-sdk';
-
-const instance: BidRelatedBidDto = {
-    bidId,
-    relation,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/BidRequiredDocumentDto.md

@@ -1,24 +0,0 @@
-# BidRequiredDocumentDto
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**paperCode** | **number** | 서류 코드. | [default to undefined]
-**paperName** | **string** | 서류명. | [default to undefined]
-**isAutoGenerated** | **boolean** | 시스템이 자동 생성하는 서류인지. false면 공급사가 직접 제출합니다. | [default to undefined]
-
-## Example
-
-```typescript
-import { BidRequiredDocumentDto } from '@cmarket/partner-sdk';
-
-const instance: BidRequiredDocumentDto = {
-    paperCode,
-    paperName,
-    isAutoGenerated,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/BidSettlementLineItemDto.md

@@ -1,36 +0,0 @@
-# BidSettlementLineItemDto
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**sequence** | **number** | 품목 순번. | [default to undefined]
-**itemCode** | **string** | 품목 코드. | [default to undefined]
-**productName** | **string** | 품목명. | [default to undefined]
-**spec** | **string** | 규격. | [default to undefined]
-**quantity** | **number** | 수량. | [default to undefined]
-**unitPrice** | **number** | 단가(원, 부가세 별도). 수량을 곱한 값이 `supplyAmount` 입니다. | [default to undefined]
-**supplyAmount** | **number** | 공급가액(원, 부가세 별도). 단가 × 수량입니다. | [default to undefined]
-**vat** | **number** | 부가세(원). | [default to undefined]
-**total** | **number** | 합계(원). | [default to undefined]
-
-## Example
-
-```typescript
-import { BidSettlementLineItemDto } from '@cmarket/partner-sdk';
-
-const instance: BidSettlementLineItemDto = {
-    sequence,
-    itemCode,
-    productName,
-    spec,
-    quantity,
-    unitPrice,
-    supplyAmount,
-    vat,
-    total,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/BidSettlementParticipantDto.md

@@ -1,56 +0,0 @@
-# BidSettlementParticipantDto
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**sequence** | **number** | 응찰 순번 (안정 키). | [default to undefined]
-**companyId** | **string** | 응찰 공급사 ID. | [default to undefined]
-**businessRegistrationNumber** | **string** | 사업자등록번호. | [default to undefined]
-**supplierTaxType** | [**SupplierTaxType**](SupplierTaxType.md) | 낙찰 공급사 사업자의 과세유형. 공고 자체의 과세유형(`taxationType`)과 혼동 금지. | [default to undefined]
-**subBusinessNumber** | **string** | 종사업자 번호. | [default to undefined]
-**representativeName** | **string** | 대표자명. | [default to undefined]
-**businessType** | **string** | 업태. | [default to undefined]
-**businessItem** | **string** | 종목. | [default to undefined]
-**zipCode** | **string** | 우편번호. | [default to undefined]
-**address** | **string** | 사업장 주소. | [default to undefined]
-**addressDetail** | **string** | 사업장 상세주소. | [default to undefined]
-**bankCode** | **string** | 은행 코드. | [default to undefined]
-**bankName** | **string** | 은행명. | [default to undefined]
-**bankAccountNumber** | **string** | 계좌번호. | [default to undefined]
-**bankAccountOwner** | **string** | 예금주. | [default to undefined]
-**bidPrice** | **number** | 응찰 총액(원, 부가세 포함). 공급가액 + 부가세입니다. | [default to undefined]
-**supplyAmount** | **number** | 공급가액(원). | [default to undefined]
-**vat** | **number** | 부가세(원). | [default to undefined]
-**lineItems** | [**Array<BidSettlementLineItemDto>**](BidSettlementLineItemDto.md) | 응찰 품목 라인아이템. | [default to undefined]
-
-## Example
-
-```typescript
-import { BidSettlementParticipantDto } from '@cmarket/partner-sdk';
-
-const instance: BidSettlementParticipantDto = {
-    sequence,
-    companyId,
-    businessRegistrationNumber,
-    supplierTaxType,
-    subBusinessNumber,
-    representativeName,
-    businessType,
-    businessItem,
-    zipCode,
-    address,
-    addressDetail,
-    bankCode,
-    bankName,
-    bankAccountNumber,
-    bankAccountOwner,
-    bidPrice,
-    supplyAmount,
-    vat,
-    lineItems,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/BidSettlementResponseDto.md

@@ -1,22 +0,0 @@
-# BidSettlementResponseDto
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**bidId** | **string** | 공고 식별자. | [default to undefined]
-**participants** | [**Array<BidSettlementParticipantDto>**](BidSettlementParticipantDto.md) | 응찰 공급사별 정산정보 목록입니다(사업자·계좌·금액·품목내역). | [default to undefined]
-
-## Example
-
-```typescript
-import { BidSettlementResponseDto } from '@cmarket/partner-sdk';
-
-const instance: BidSettlementResponseDto = {
-    bidId,
-    participants,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/BidSiteBriefingDto.md

@@ -1,22 +0,0 @@
-# BidSiteBriefingDto
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**required** | **boolean** | 현장설명 참석이 필수인지. | [default to undefined]
-**note** | **string** | 장소·일시 안내. 없으면 null. | [default to undefined]
-
-## Example
-
-```typescript
-import { BidSiteBriefingDto } from '@cmarket/partner-sdk';
-
-const instance: BidSiteBriefingDto = {
-    required,
-    note,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/BidSummaryDto.md

@@ -1,54 +0,0 @@
-# BidSummaryDto
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**bidId** | **string** | 공고 식별자. | [default to undefined]
-**purchaseNo** | **string** | 외부 ERP 조달(PO) 번호. 등록 시 지정하지 않았으면 null. | [default to undefined]
-**title** | **string** | 공고명. | [default to undefined]
-**status** | [**BidPublicStatus**](BidPublicStatus.md) | 공고 상태(공개값). 낙찰 여부는 이 값이 아니라 낙찰 결과 조회의 `participants[].isWinner`로 관측하세요(AWARDED 상태는 없습니다 — 낙찰 직후 공고는 CONTRACT_IN_PROGRESS가 됩니다). | [default to undefined]
-**awardMethod** | [**AwardMethodPublic**](AwardMethodPublic.md) | 낙찰방법(공개값). 아래 7종 밖의 방법으로 진행된 공고이면 null. | [default to undefined]
-**bidStartAt** | **string** | 입찰 시작(게시) 시각(ISO 8601 UTC). 없으면 null. | [default to undefined]
-**bidEndAt** | **string** | 입찰 마감 시각(ISO 8601 UTC). 없으면 null. | [default to undefined]
-**budgetAmount** | **number** | 예산(예정)금액(원, 부가세 포함). 미공개/미지정이면 null. 등록 시 `totalBudget` 으로 보낸 값이며, 생략했다면 품목 합계입니다. | [default to undefined]
-**awardedAmount** | **number** | 낙찰금액(원, 부가세 포함). 낙찰 전이거나 무낙찰이면 null. 예산금액과 같은 축이라 두 값을 그대로 빼면 절감액이 됩니다. | [default to undefined]
-**lifecycle** | [**BidLifecycleDto**](BidLifecycleDto.md) | 라이프사이클 하위 상태(계약서류/지급/계산서/납품). | [default to undefined]
-**bidType** | [**BidTypePublic**](BidTypePublic.md) | 입찰방식(공개값). 미지정이면 null. | [optional] [default to undefined]
-**awardedAt** | **string** | 낙찰 확정 시각(ISO 8601 UTC). 낙찰 전이면 null. | [optional] [default to undefined]
-**inspectionConfirmedAt** | **string** | 검수 확정 시각(ISO 8601 UTC). 미검수면 null. | [optional] [default to undefined]
-**delivery** | [**BidDeliveryTermsDto**](BidDeliveryTermsDto.md) | 납품 조건. | [optional] [default to undefined]
-**payment** | [**BidPaymentTermsDto**](BidPaymentTermsDto.md) | 결제 조건. | [optional] [default to undefined]
-**contacts** | [**BidContactsDto**](BidContactsDto.md) | 계약/기술 담당자. `include=contacts` 일 때만 실립니다. | [optional] [default to undefined]
-**participants** | [**Array<BidResultParticipantDto>**](BidResultParticipantDto.md) | 응찰 참여자. `include=results` 일 때만 실립니다. | [optional] [default to undefined]
-**products** | [**Array<BidProductDto>**](BidProductDto.md) | 공고 등록 품목. `include=products` 일 때만 실립니다. | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { BidSummaryDto } from '@cmarket/partner-sdk';
-
-const instance: BidSummaryDto = {
-    bidId,
-    purchaseNo,
-    title,
-    status,
-    awardMethod,
-    bidStartAt,
-    bidEndAt,
-    budgetAmount,
-    awardedAmount,
-    lifecycle,
-    bidType,
-    awardedAt,
-    inspectionConfirmedAt,
-    delivery,
-    payment,
-    contacts,
-    participants,
-    products,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/BidTypePublic.md

@@ -1,11 +0,0 @@
-# BidTypePublic
-
-입찰방식(공개값). 미지정이면 null.
-
-## Enum
-
-* `Electronic` (value: `'ELECTRONIC'`)
-
-* `ReverseAuction` (value: `'REVERSE_AUCTION'`)
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/BidUpdatedResponseDto.md

@@ -1,20 +0,0 @@
-# BidUpdatedResponseDto
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**bidId** | **string** | 수정된 공고 식별자. | [default to undefined]
-
-## Example
-
-```typescript
-import { BidUpdatedResponseDto } from '@cmarket/partner-sdk';
-
-const instance: BidUpdatedResponseDto = {
-    bidId,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/BiddingStylePublic.md

@@ -1,11 +0,0 @@
-# BiddingStylePublic
-
-참여 대상 지정 방식. `NOMINATED` 는 발주기관이 지명한 공급사만 참여할 수 있습니다. 지역 제한은 `regions` 를 보세요.
-
-## Enum
-
-* `Open` (value: `'OPEN'`)
-
-* `Nominated` (value: `'NOMINATED'`)
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CancelBid200Response.md

@@ -1,20 +0,0 @@
-# CancelBid200Response
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**BidCancelledResponseDto**](BidCancelledResponseDto.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { CancelBid200Response } from '@cmarket/partner-sdk';
-
-const instance: CancelBid200Response = {
-    data,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CancelBidRequestDto.md

@@ -1,20 +0,0 @@
-# CancelBidRequestDto
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**reason** | **string** | 취소 사유. 공고 이력에 남으며 비워 둘 수 없습니다. | [default to undefined]
-
-## Example
-
-```typescript
-import { CancelBidRequestDto } from '@cmarket/partner-sdk';
-
-const instance: CancelBidRequestDto = {
-    reason,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CompleteInvoice200Response.md

@@ -1,20 +0,0 @@
-# CompleteInvoice200Response
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**InvoiceCompletedResponseDto**](InvoiceCompletedResponseDto.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { CompleteInvoice200Response } from '@cmarket/partner-sdk';
-
-const instance: CompleteInvoice200Response = {
-    data,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CompleteUploadRequestDto.md

@@ -1,20 +0,0 @@
-# CompleteUploadRequestDto
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**fileName** | **string** | 파일명입니다(확장자 포함, 최대 255자). 발급 단계에서 보낸 값과 같아야 합니다. | [default to undefined]
-
-## Example
-
-```typescript
-import { CompleteUploadRequestDto } from '@cmarket/partner-sdk';
-
-const instance: CompleteUploadRequestDto = {
-    fileName,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CreateEmbedLaunch201Response.md

@@ -1,20 +0,0 @@
-# CreateEmbedLaunch201Response
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**EmbedLaunchResponseDto**](EmbedLaunchResponseDto.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { CreateEmbedLaunch201Response } from '@cmarket/partner-sdk';
-
-const instance: CreateEmbedLaunch201Response = {
-    data,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CreateFileUploadUrl201Response.md

@@ -1,20 +0,0 @@
-# CreateFileUploadUrl201Response
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**UploadUrlCreatedResponseDto**](UploadUrlCreatedResponseDto.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { CreateFileUploadUrl201Response } from '@cmarket/partner-sdk';
-
-const instance: CreateFileUploadUrl201Response = {
-    data,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CreateUploadUrlRequestDto.md

@@ -1,22 +0,0 @@
-# CreateUploadUrlRequestDto
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**fileName** | **string** | 파일명입니다(확장자 포함, 최대 255자). 허용 형식: PDF, HWP, HWPX, HWT, DOC, DOCX, XLS, XLSX, CELL, PPT, PPTX, SHOW, TXT, CSV, ZIP, JPG, JPEG, PNG, GIF, BMP, TIFF, TIF, DWG, DXF, STEP, STP, IGES, IGS, STL (accept: `.pdf,.hwp,.hwpx,.hwt,.doc,.docx,.xls,.xlsx,.cell,.ppt,.pptx,.show,.txt,.csv,.zip,.jpg,.jpeg,.png,.gif,.bmp,.tiff,.tif,.dwg,.dxf,.step,.stp,.iges,.igs,.stl`). 그 외 확장자는 거부됩니다. | [default to undefined]
-**fileSize** | **number** | 파일 크기(바이트). 최대 100MB. 발급 전에 정책을 검사하기 위한 값이며, 확정 단계에서 실제 오브젝트 크기로 재확인합니다. | [default to undefined]
-
-## Example
-
-```typescript
-import { CreateUploadUrlRequestDto } from '@cmarket/partner-sdk';
-
-const instance: CreateUploadUrlRequestDto = {
-    fileName,
-    fileSize,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/DeliveryDateTypePublic.md

@@ -1,13 +0,0 @@
-# DeliveryDateTypePublic
-
-납품기한 유형(공개값). 미지정이면 null.
-
-## Enum
-
-* `FixedDate` (value: `'FIXED_DATE'`)
-
-* `DaysAfterContract` (value: `'DAYS_AFTER_CONTRACT'`)
-
-* `NegotiatedAfterContract` (value: `'NEGOTIATED_AFTER_CONTRACT'`)
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/DeliveryMethodPublic.md

@@ -1,13 +0,0 @@
-# DeliveryMethodPublic
-
-납품 방법(공개값). 미지정이면 null.
-
-## Enum
-
-* `Courier` (value: `'COURIER'`)
-
-* `Direct` (value: `'DIRECT'`)
-
-* `DeliveryAndInstall` (value: `'DELIVERY_AND_INSTALL'`)
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/EmbedApi.md

@@ -1,68 +0,0 @@
-# EmbedApi
-
-All URIs are relative to *https://partner-api.c-market.net*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**createEmbedLaunch**](#createembedlaunch) | **POST** /v2/embed/launch | 임베드 launch 발급|
-
-# **createEmbedLaunch**
-> CreateEmbedLaunch201Response createEmbedLaunch(embedLaunchRequestDto)
-
-발주기관 담당자(`memberId`)용 1회성 `launchUrl`을 발급합니다(TTL 60초). 이 주소로 CMARKET 화면이 ERP 사용자에게 로그인 없이 열립니다. 스코프 `embed:launch`.  - 응답은 `launchUrl` 하나입니다. iframe `src`에 걸거나 새 탭으로 엽니다. 설치할 스크립트도 SDK도 없습니다. - **iframe(권장)**: 발급 요청에 `parentOrigin`을 함께 보내면 등록 완료·취소·공고선택·공고데이터·세션만료를 그 origin으로 `postMessage` 통지합니다. 허용 origin을 먼저 등록해야 하며, 미등록이면 이 요청이 400입니다. 다만 개발 기기(`http://localhost:*`, `127.0.0.1`, `[::1]`)는 등록 없이 허용하므로 연동 착수 단계에서 별도 요청이 필요 없습니다. - `memberId` 검증은 **API 키의 대행 범위 확인뿐**입니다(범위 밖이면 403) — 같은 기관 담당자는 전부 통과하므로, 브라우저가 지정한 값을 그대로 넘기면 동료 명의로 화면이 열립니다. - **공고 데이터 통지(`cmarket:bid-data`)**: 두 자리에서 나옵니다 — ① 공고등록을 마친 직후(등록 → `cmarket:bid-data` → `cmarket:success` 순서, 별도 버튼 불요) ② 공고상세 화면 맨 아래의 \"수신하기\" 버튼. 본문은 `GET /v2/bids/{bidRef}` 응답과 완전히 같아서, REST를 연동하지 않은 기관도 임베드만으로 자체 대장을 채웁니다. - **새 탭**: `parentOrigin` 없이 발급합니다 — origin 등록이 필요 없는 대신 통지가 없어 결과는 조회 API로 확인합니다. - 허용 목록 밖 `screen`·`components`는 400입니다. - **화면마다 필요한 값이 다릅니다** — `bid-detail`·`payment`는 `targetBidId` 없이 발급하면 400입니다(임베드 그룹 설명의 요건 표 참조). 아래 예시 셋이 그대로 붙여 쓸 수 있는 최소 요청입니다.
-
-### Example
-
-```typescript
-import {
-    EmbedApi,
-    Configuration,
-    EmbedLaunchRequestDto
-} from '@cmarket/partner-sdk';
-
-const configuration = new Configuration();
-const apiInstance = new EmbedApi(configuration);
-
-let embedLaunchRequestDto: EmbedLaunchRequestDto; //
-
-const { status, data } = await apiInstance.createEmbedLaunch(
-    embedLaunchRequestDto
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **embedLaunchRequestDto** | **EmbedLaunchRequestDto**|  | |
-
-
-### Return type
-
-**CreateEmbedLaunch201Response**
-
-### Authorization
-
-[partner-oauth2](../README.md#partner-oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json, application/problem+json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**201** | 1회성 launch URL 발급 완료(TTL 60초). iframe·새 탭 어느 쪽이든 이 URL 하나를 그대로 씁니다. |  * RateLimit - 현재 창의 잔여 쿼터(&#x60;r&#x60;)와 리셋까지 남은 초(&#x60;t&#x60;). 이 값이 0에 가까워지면 요청 간격을 늘리세요 — 429를 만나기 전에 조절하라고 주는 값입니다. <br>  * RateLimit-Policy - 적용 중인 쿼터 정책(&#x60;q&#x60; 요청 수 / &#x60;w&#x60; 창 크기(초)). 변하지 않으므로 한 번 읽어 두면 됩니다. <br>  |
-|**400** | 입력 검증 실패(&#x60;…/validation-failed&#x60;). 상한 초과(&#x60;bidRefs&#x60; 101건 등), 값 형식 위반, 알 수 없는 &#x60;cursor&#x60;. |  -  |
-|**401** | Bearer 토큰 없음(&#x60;…/missing-bearer-token&#x60;), 만료·위변조·폐기(&#x60;…/invalid-token&#x60;). |  -  |
-|**403** | 키 미바인딩(&#x60;…/unbound-partner-key&#x60;), IP 차단(&#x60;…/ip-not-allowed&#x60;), 스코프 부족(&#x60;…/insufficient-scope&#x60;), 대행 범위 밖(&#x60;…/buyer-scope-mismatch&#x60;), 권한 없음(&#x60;…/upstream-forbidden&#x60;). |  -  |
-|**422** | 내용상 처리 불가(&#x60;…/upstream-unprocessable&#x60;). |  -  |
-|**429** | 요청 한도 초과(&#x60;…/too-many-requests&#x60;). 한도는 &#x60;client_id&#x60;당 분당 60회. 대기 시간은 &#x60;Retry-After&#x60;(초), 잔여 쿼터는 &#x60;RateLimit&#x60;·&#x60;RateLimit-Policy&#x60; 헤더에 실립니다. &#x60;retryable: true&#x60;. |  * Retry-After - 재시도까지 대기할 초. <br>  * RateLimit - 현재 창의 잔여 쿼터. 예: &#x60;\&quot;default\&quot;;r&#x3D;0;t&#x3D;42&#x60;. <br>  * RateLimit-Policy - 적용 중인 쿼터 정책(&#x60;q&#x60; 요청 수 / &#x60;w&#x60; 창 크기(초)). 변하지 않으므로 한 번 읽어 두면 됩니다. <br>  |
-|**500** | 서버 내부 오류(&#x60;…/internal-server-error&#x60;). &#x60;retryable: true&#x60;. |  -  |
-|**502** | 요청 처리 실패(&#x60;…/upstream-rejected&#x60;). &#x60;retryable: true&#x60;. |  -  |
-|**503** | 일시적 처리 불가(&#x60;…/service-unavailable&#x60;). &#x60;Retry-After&#x60; 헤더를 따릅니다. &#x60;retryable: true&#x60;. |  * Retry-After - 재시도까지 대기할 초. <br>  |
-
-[[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)
-