@cmarket/partner-sdk 49.1.0 → 49.2.0

package/docs/BidDetailResponseDto.md

@@ -0,0 +1,104 @@
+# BidDetailResponseDto
+
+
+## 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`로 관측(위 설명 참조). | [default to undefined]
+**awardMethod** | [**AwardMethodPublic**](AwardMethodPublic.md) | 낙찰방법(공개값). 아래 7종 밖의 방법으로 진행된 공고이면 null. | [default to undefined]
+**isDeadlinePassed** | **boolean** | 입찰 마감 경과 여부(서버 시각 기준). | [default to undefined]
+**budgetAmount** | **number** | 예산(예정)금액(원, 부가세 포함). 미공개/미지정이면 null. 품목 단가와 달리 발주기관의 견적 입력 설정에 좌우되지 않습니다. | [default to undefined]
+**awardedAmount** | **number** | 낙찰금액(원, 부가세 포함). 낙찰 전이거나 무낙찰이면 null. 예산금액과 같은 축이라 두 값을 그대로 빼면 절감액이 됩니다. | [default to undefined]
+**awardedAt** | **string** | 낙찰(계약체결) 시각(ISO 8601). 낙찰 전이면 null. 계약 진행 시작점. | [default to undefined]
+**lifecycle** | [**BidLifecycleDto**](BidLifecycleDto.md) | 라이프사이클 하위 상태. | [default to undefined]
+**bidStartAt** | **string** | 입찰 개시(게시) 시각(ISO 8601). 없으면 null. | [default to undefined]
+**bidEndAt** | **string** | 입찰 마감 시각(ISO 8601). 없으면 null. | [default to undefined]
+**delivery** | [**BidDeliveryTermsDto**](BidDeliveryTermsDto.md) | 납품 조건. | [default to undefined]
+**payment** | [**BidPaymentTermsDto**](BidPaymentTermsDto.md) | 대금 지급 조건. | [default to undefined]
+**contacts** | [**BidContactsDto**](BidContactsDto.md) | 발주 담당자(계약·기술). | [default to undefined]
+**products** | [**Array<BidProductDto>**](BidProductDto.md) | 등록 품목. | [default to undefined]
+**participants** | [**Array<BidResultParticipantDto>**](BidResultParticipantDto.md) | 응찰 참여자 목록입니다(응찰가·순위·낙찰 여부 포함). 낙찰자는 `isWinner` 값으로 확인합니다. 어떤 항목이 보이는지는 낙찰방법과 진행단계에 따라 이미 정해진 결과가 그대로 내려옵니다 — 개찰 전에는 공급사명·응찰가가 null 로 내려옵니다. 클라이언트에서 다시 계산하지 마세요. | [default to undefined]
+**contractDocuments** | [**Array<BidContractDocumentDto>**](BidContractDocumentDto.md) | 계약서류 목록(공고 공통 + 낙찰자 귀속). `downloadUrl`은 요청 시점에 서명한 1시간짜리 주소이므로 저장하지 말고 매번 이 응답에서 다시 받으세요. | [default to undefined]
+**acceptance** | [**BidAcceptanceDto**](BidAcceptanceDto.md) | 검수 진행 상태. | [default to undefined]
+**categoryType** | [**BidCategoryPublic**](BidCategoryPublic.md) | 공고 카테고리. 원천에 값이 없으면 null. | [default to undefined]
+**biddingStyle** | [**BiddingStylePublic**](BiddingStylePublic.md) | 참여 대상 지정 방식. `NOMINATED` 는 발주기관이 지명한 공급사만 참여할 수 있습니다. 지역 제한은 `regions` 를 보세요. | [default to undefined]
+**buyerName** | **string** | 발주기관명. 미상이면 null. | [default to undefined]
+**budgetPublic** | **boolean** | 예산(예정)금액을 공급사에게 공개하는 공고인지. false 면 공고상세에서 금액이 비공개로 표시됩니다. `budgetAmount` 를 볼 수 있는지와는 별개 축입니다. | [default to undefined]
+**noticeContent** | **string** | 공고문 본문. **HTML** 이므로 표시하기 전에 신뢰할 수 있는 새니타이저를 거치세요. 본문이 없으면 null. | [default to undefined]
+**attachments** | [**Array<BidAttachmentDto>**](BidAttachmentDto.md) | 공고 첨부파일. | [default to undefined]
+**qualifications** | **Array<string>** | 참가자격 안내 문장. 발주기관이 고른 참가 조건을 문장으로 풀어 놓은 값이며 순서대로 표시하면 공고상세 화면과 같습니다. | [default to undefined]
+**regions** | [**BidRegionRestrictionDto**](BidRegionRestrictionDto.md) | 참여 가능 지역 제한. | [default to undefined]
+**requiredLicenses** | [**BidLicenseRequirementDto**](BidLicenseRequirementDto.md) | 면허·인증 요건. 요구가 없으면 null. | [default to undefined]
+**awardMethodDetail** | [**BidAwardMethodDetailDto**](BidAwardMethodDetailDto.md) | 낙찰방법 부가 조건(제한적 최저가 계열). 해당 없으면 null. | [default to undefined]
+**siteBriefing** | [**BidSiteBriefingDto**](BidSiteBriefingDto.md) | 현장 방문·설명회 요건. 요구가 없으면 null. | [default to undefined]
+**requiredDocuments** | [**Array<BidRequiredDocumentDto>**](BidRequiredDocumentDto.md) | 낙찰 시 제출해야 할 서류 종류. 발급된 파일 목록인 `contractDocuments` 와는 다른 축이며 마감 전에도 채워집니다. | [default to undefined]
+**customDocuments** | **Array<string>** | 발주기관이 직접 입력한 제출서류명(코드가 없는 서류). | [default to undefined]
+**mustReadNotices** | [**Array<BidMustReadNoticeDto>**](BidMustReadNoticeDto.md) | 공고상세 \"필수 유의사항\" 항목. 해당 사항이 없으면 빈 배열. | [default to undefined]
+**cancellation** | [**BidCancellationDto**](BidCancellationDto.md) | 취소 정보. 취소되지 않았으면 null. | [default to undefined]
+**deadlineExtensionCount** | **number** | 마감 자동연장 횟수. 연장 이력이 없으면 0. | [default to undefined]
+**preliminaryPrice** | [**BidPreliminaryPriceDto**](BidPreliminaryPriceDto.md) | 복수예비가격 산출내역. 낙찰방법·진행단계·권한을 함께 본 판정 결과이며 볼 수 없는 시야에서는 null 입니다. | [default to undefined]
+**pricingType** | [**PricingTypePublic**](PricingTypePublic.md) | 예가 방식. `SINGLE_PRICE`=단일예가, `MULTIPLE_PRELIMINARY`=복수예비가격. 미지정이면 null. | [default to undefined]
+**regulationType** | [**RegulationTypePublic**](RegulationTypePublic.md) | 관련규정. 자체규정을 쓰는 발주기관의 물품 공고에서만 값이 있고, 그 밖에는 null 입니다. | [default to undefined]
+**amountsIncludeVat** | **boolean** | 품목 단가와 응찰가가 부가세를 포함한 값인지. false 면 공급가 기준입니다. 발주기관 그룹의 견적 입력 설정에서 오며, 공급사가 응찰 화면에서 단가를 어느 축으로 넣는지를 정합니다. 예산금액·낙찰금액은 이 값과 무관하게 항상 부가세 포함입니다. | [default to undefined]
+**ownRegulationMode** | **boolean** | 발주기관이 자체규정 모드로 운영 중인지. true 면 화면에서 예산을 \"배정예산\"으로 부릅니다. | [default to undefined]
+**qualificationReview** | [**BidQualificationReviewDto**](BidQualificationReviewDto.md) | 자격심사(적격심사) 산식. 해당 낙찰방법이 아니거나 볼 수 없는 시야면 null. | [default to undefined]
+**twoStagePhase** | [**TwoStagePhasePublic**](TwoStagePhasePublic.md) | 2단계 경쟁 단계. `SPEC_NOTICE`=1단계 규격공고, `PRICE_BID`=2단계 가격투찰. 2단계 공고가 아니면 null. | [default to undefined]
+**relatedBid** | [**BidRelatedBidDto**](BidRelatedBidDto.md) | 짝을 이루는 다른 공고(2단계 상대 또는 재공고 직전 공고). 없으면 null. | [default to undefined]
+
+## Example
+
+```typescript
+import { BidDetailResponseDto } from '@cmarket/partner-sdk';
+
+const instance: BidDetailResponseDto = {
+    bidId,
+    purchaseNo,
+    title,
+    status,
+    awardMethod,
+    isDeadlinePassed,
+    budgetAmount,
+    awardedAmount,
+    awardedAt,
+    lifecycle,
+    bidStartAt,
+    bidEndAt,
+    delivery,
+    payment,
+    contacts,
+    products,
+    participants,
+    contractDocuments,
+    acceptance,
+    categoryType,
+    biddingStyle,
+    buyerName,
+    budgetPublic,
+    noticeContent,
+    attachments,
+    qualifications,
+    regions,
+    requiredLicenses,
+    awardMethodDetail,
+    siteBriefing,
+    requiredDocuments,
+    customDocuments,
+    mustReadNotices,
+    cancellation,
+    deadlineExtensionCount,
+    preliminaryPrice,
+    pricingType,
+    regulationType,
+    amountsIncludeVat,
+    ownRegulationMode,
+    qualificationReview,
+    twoStagePhase,
+    relatedBid,
+};
+```
+
+[[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/BidLicenseRequirementDto.md

@@ -0,0 +1,24 @@
+# BidLicenseRequirementDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**licenses** | **Array<string>** | 요구 면허명. | [default to undefined]
+**certifications** | **Array<string>** | 요구 인증서명. | [default to undefined]
+**mode** | [**LicenseCombinationMode**](LicenseCombinationMode.md) | 면허 결합 방식. `AND`=모두 보유, `OR`=하나 이상 보유. | [default to undefined]
+
+## Example
+
+```typescript
+import { BidLicenseRequirementDto } from '@cmarket/partner-sdk';
+
+const instance: BidLicenseRequirementDto = {
+    licenses,
+    certifications,
+    mode,
+};
+```
+
+[[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/BidLifecycleDto.md

@@ -0,0 +1,28 @@
+# BidLifecycleDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**contractDocumentsGenerated** | **boolean** | 계약서류가 생성되었는지 여부(생성 서류 존재). | [default to undefined]
+**paymentCompleted** | **boolean** | 결제(정산)가 완료되었는지 여부. | [default to undefined]
+**taxInvoiceRequested** | **boolean** | 세금계산서 발행이 요청되었는지 여부. | [default to undefined]
+**taxInvoiceIssued** | **boolean** | 세금계산서가 발행되었는지 여부. | [default to undefined]
+**delivered** | **boolean** | 낙찰자가 납품(결과확인)을 완료했는지 여부입니다. | [default to undefined]
+
+## Example
+
+```typescript
+import { BidLifecycleDto } from '@cmarket/partner-sdk';
+
+const instance: BidLifecycleDto = {
+    contractDocumentsGenerated,
+    paymentCompleted,
+    taxInvoiceRequested,
+    taxInvoiceIssued,
+    delivered,
+};
+```
+
+[[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/BidMustReadNoticeDto.md

@@ -0,0 +1,22 @@
+# BidMustReadNoticeDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **string** | 유의사항 제목. | [default to undefined]
+**content** | **string** | 유의사항 본문. 줄바꿈(`\\n`)이 포함될 수 있습니다. | [default to undefined]
+
+## Example
+
+```typescript
+import { BidMustReadNoticeDto } from '@cmarket/partner-sdk';
+
+const instance: BidMustReadNoticeDto = {
+    title,
+    content,
+};
+```
+
+[[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/BidPaymentTermsDto.md

@@ -0,0 +1,22 @@
+# BidPaymentTermsDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**method** | [**PaymentMethodPublic**](PaymentMethodPublic.md) | 결제 방법(공개값). 미지정이면 null. | [default to undefined]
+**days** | **number** | 결제 기일(일). 미지정이면 null. | [default to undefined]
+
+## Example
+
+```typescript
+import { BidPaymentTermsDto } from '@cmarket/partner-sdk';
+
+const instance: BidPaymentTermsDto = {
+    method,
+    days,
+};
+```
+
+[[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/BidPreliminaryPriceDto.md

@@ -0,0 +1,30 @@
+# BidPreliminaryPriceDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**basePrice** | **number** | 기초금액(원, 부가세 포함). 예비가격 슬롯을 만들어 내는 기준값이며 예산금액에서 파생합니다. | [default to undefined]
+**slots** | [**Array<BidPreliminaryPriceSlotDto>**](BidPreliminaryPriceSlotDto.md) | 슬롯 표(보통 15칸). | [default to undefined]
+**selectedSlots** | **Array<string>** | 추첨된 슬롯 번호. | [default to undefined]
+**averagePrice** | **string** | 예정가격(원, 부가세 포함). 추첨된 슬롯 가격의 평균입니다. | [default to undefined]
+**floorPrice** | **string** | 낙찰하한가(원, 부가세 포함). `floor(예정가격 × 낙찰하한율 / 100)` 이며, 이 금액 미만으로 응찰하면 낙찰 대상에서 빠집니다. | [default to undefined]
+**appliedLowestPercent** | **number** | 적용 낙찰하한율(%). | [default to undefined]
+
+## Example
+
+```typescript
+import { BidPreliminaryPriceDto } from '@cmarket/partner-sdk';
+
+const instance: BidPreliminaryPriceDto = {
+    basePrice,
+    slots,
+    selectedSlots,
+    averagePrice,
+    floorPrice,
+    appliedLowestPercent,
+};
+```
+
+[[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/BidPreliminaryPriceSlotDto.md

@@ -0,0 +1,24 @@
+# BidPreliminaryPriceSlotDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**slot** | **number** | 슬롯 번호(1~15). | [default to undefined]
+**price** | **number** | 슬롯 가격(원, 부가세 포함). 예산금액에서 파생하므로 예산과 같은 축입니다. | [default to undefined]
+**pickCount** | **number** | 이 슬롯을 고른 응찰 수. | [default to undefined]
+
+## Example
+
+```typescript
+import { BidPreliminaryPriceSlotDto } from '@cmarket/partner-sdk';
+
+const instance: BidPreliminaryPriceSlotDto = {
+    slot,
+    price,
+    pickCount,
+};
+```
+
+[[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/BidProductDto.md

@@ -0,0 +1,38 @@
+# 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

@@ -0,0 +1,28 @@
+# 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

@@ -0,0 +1,22 @@
+# 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

@@ -0,0 +1,22 @@
+# 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

@@ -0,0 +1,22 @@
+# 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

@@ -0,0 +1,24 @@
+# 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/BidSiteBriefingDto.md

@@ -0,0 +1,22 @@
+# 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/BiddingStylePublic.md

@@ -0,0 +1,11 @@
+# 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/CreateEmbedLaunch201Response.md

@@ -0,0 +1,20 @@
+# 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/DeliveryDateTypePublic.md

@@ -0,0 +1,13 @@
+# 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

@@ -0,0 +1,13 @@
+# 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

@@ -0,0 +1,68 @@
+# 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)
+

package/docs/EmbedBidPrefillDto.md

@@ -0,0 +1,42 @@
+# EmbedBidPrefillDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**purchaseNo** | **string** | 발주기관 구매번호(ERP 구매번호). 공고 등록(`POST /v2/bids`)과 **같은 식별 축**이니 같은 값을 쓰세요. 숫자로 시작하면 CMARKET 공고번호로 오인되니 알파벳 접두사를 붙입니다. (화면: `bid-register`) | [optional] [default to undefined]
+**projectName** | **string** | 공고명. (화면: `bid-register`) | [optional] [default to undefined]
+**noticeContent** | **string** | 공고 내용. (화면: `bid-register`) | [optional] [default to undefined]
+**bidEndAt** | **string** | 입찰 마감 일시(ISO 8601, offset 필수). (화면: `bid-register`) | [optional] [default to undefined]
+**deliveryDate** | **string** | 납품 희망일(`YYYY-MM-DD`). 폼의 납품기한 \"지정일\" 로 들어갑니다. (화면: `bid-register`) | [optional] [default to undefined]
+**items** | [**Array<EmbedBidPrefillItemDto>**](EmbedBidPrefillItemDto.md) | 품목 행. (화면: `bid-register`) | [optional] [default to undefined]
+**categoryType** | **string** | 공고 유형 셀렉터 초기값. (화면: `bid-register`) | [optional] [default to undefined]
+**deliveryAddress** | **string** | 납품 장소(도로명 주소). (화면: `bid-register`) | [optional] [default to undefined]
+**paymentMethod** | **string** | 결제 방법. 공고 등록(`POST /v2/bids`)과 같은 값집합입니다. `payment` 화면은 `CARD` 일 때만 카드결제 진입을 그립니다(비권위 — 최종 판정은 서버). (화면: `bid-register` · `payment`) | [optional] [default to undefined]
+**paymentDays** | **string** | 대금지급 기한(일 단위 숫자 문자열). (화면: `bid-register`) | [optional] [default to undefined]
+**contractManager** | [**EmbedBidPrefillManagerDto**](EmbedBidPrefillManagerDto.md) | 계약 담당자. (화면: `bid-register`) | [optional] [default to undefined]
+**techManager** | [**EmbedBidPrefillManagerDto**](EmbedBidPrefillManagerDto.md) | 기술 담당자. (화면: `bid-register`) | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { EmbedBidPrefillDto } from '@cmarket/partner-sdk';
+
+const instance: EmbedBidPrefillDto = {
+    purchaseNo,
+    projectName,
+    noticeContent,
+    bidEndAt,
+    deliveryDate,
+    items,
+    categoryType,
+    deliveryAddress,
+    paymentMethod,
+    paymentDays,
+    contractManager,
+    techManager,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)