@cmarket/partner-sdk 38.0.0 → 38.2.0

package/docs/CreateWebhookEndpointRequestDto.md

@@ -0,0 +1,22 @@
+# CreateWebhookEndpointRequestDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **string** | 이벤트를 받을 수신 주소. **HTTPS 만 허용합니다** — 서명된 페이로드를 평문 구간에 실을 수 없습니다. | [default to undefined]
+**eventTypes** | [**Set<PartnerWebhookEventType>**](PartnerWebhookEventType.md) | 구독할 이벤트 타입. 최소 1개, 중복 불가. `ping` 은 연결 확인 전용이라 구독할 수 없습니다. | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateWebhookEndpointRequestDto } from '@cmarket/partner-sdk';
+
+const instance: CreateWebhookEndpointRequestDto = {
+    url,
+    eventTypes,
+};
+```
+
+[[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

@@ -4,12 +4,12 @@ All URIs are relative to *https://partner-api.c-market.net*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**createEmbedLaunch**](#createembedlaunch) | **POST** /v2/embed/launch | 임베드 launch code 발급 (iframe SSO)|
+|[**createEmbedLaunch**](#createembedlaunch) | **POST** /v2/embed/launch | 임베드 launch 발급 (SSO — iframe 또는 새 탭)|
 
 # **createEmbedLaunch**
 > CreateEmbedLaunch201Response createEmbedLaunch(embedLaunchRequestDto)
 
-스코프 `embed:launch` 필수. 발주기관 담당자(`memberId`)용 일회성 launch code(60초 TTL)를 발급합니다. 이 code 로 CMARKET 화면이 ERP 안에서 그대로 열립니다 — REST 로 UI 를 다시 만들지 않는 연동 방식입니다.  **프런트에서 직접 호출하지 마세요.** 이 API 는 파트너 자격증명을 쓰므로 ERP **백엔드**가 호출하고, 프런트에는 자체 엔드포인트(예: `POST /api/embed/launch`)로 감싸 노출합니다. code 는 URL 에 싣지 말고 `@cmarket/embed` SDK 의 postMessage 핸드셰이크로만 iframe 에 전달합니다(SDK 가 강제).  `memberId` 가 이 API 키의 대행 범위 밖이면 403, 화이트리스트 밖 `screen`·`components` 는 400 입니다.
+스코프 `embed:launch` 필수. 발주기관 담당자(`memberId`)용 일회성 launch(60초 TTL)를 발급합니다. 이 값으로 CMARKET 화면이 ERP 사용자에게 로그인 없이 열립니다 — REST 로 UI 를 다시 만들지 않는 연동 방식입니다.  **여는 방법 두 가지** — 응답은 한 번에 둘 다 내려줍니다. 1. **iframe 임베드(권장)**: `launchCode` 를 `@cmarket/embed` SDK 에 넘기면 ERP 화면 안에서 열리고, 등록 완료·취소·공고선택 콜백을 그대로 받습니다. code 는 SDK 의 postMessage 핸드셰이크로만 전달됩니다(SDK 가 강제). **허용 origin 등록이 선행**되어야 합니다(미등록 origin 은 세션이 폐기됩니다). 2. **새 탭(iframe 불가 환경)**: `launchUrl` 을 사용자 브라우저에서 그대로 엽니다. origin 등록도 SDK 도 필요 없습니다. 대신 완료 콜백이 없으므로 결과는 조회 API 로 확인합니다.  **프런트에서 직접 호출하지 마세요.** 이 API 는 파트너 자격증명을 쓰므로 ERP **백엔드**가 호출하고, 프런트에는 자체 엔드포인트(예: `POST /api/embed/launch`)로 감싸 노출합니다.  `memberId` 가 이 API 키의 대행 범위 밖이면 403, 화이트리스트 밖 `screen`·`components` 는 400 입니다.
 
 ### Example
 

package/docs/EmbedLaunchResponseDto.md

@@ -5,8 +5,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**launchCode** | **string** | 일회성 launch code입니다. URL 이나 쿼리 파라미터에 담지 말고, 임베드 SDK 를 통해서만 전달하세요. | [default to undefined]
+**launchCode** | **string** | 일회성 launch code입니다. **iframe 임베드(권장)** 에서 쓰는 값으로, `@cmarket/embed` SDK 의 postMessage 핸드셰이크로만 전달하세요. URL·쿼리 파라미터에 직접 담지 마세요(새 탭으로 열 때는 아래 `launchUrl` 을 그대로 쓰면 됩니다). | [default to undefined]
 **expiresIn** | **number** | launch code 의 유효기간(초)입니다. 만료 후에 사용하면 401 이 반환됩니다. | [default to undefined]
+**launchUrl** | **string** | iframe 을 쓸 수 없는 ERP(데스크톱 클라이언트, iframe 허용 origin 등록이 어려운 환경)를 위한 **새 탭 전용 1회성 URL** 입니다. 사용자 브라우저에서 그대로 열면 로그인 없이 해당 화면이 열립니다.  code 는 쿼리가 아니라 fragment(`#code=`)에 실려 서버 액세스 로그·Referer 에 남지 않고, CMARKET 화면이 소비 즉시 주소창에서 지웁니다. 다만 URL 자체가 60초짜리 자격증명이므로 메일·메신저로 재전달하지 말고, 사용자 클릭 시점에 발급해 바로 여세요.  이 방식에는 iframe 임베드의 완료·취소 콜백(`cmarket:success` 등)이 없습니다 — 결과 반영이 필요하면 조회 API 로 확인하세요. | [default to undefined]
 
 ## Example
 
@@ -16,6 +17,7 @@ import { EmbedLaunchResponseDto } from '@cmarket/partner-sdk';
 const instance: EmbedLaunchResponseDto = {
     launchCode,
     expiresIn,
+    launchUrl,
 };
 ```
 

package/docs/GetWebhookEndpoint200Response.md

@@ -0,0 +1,20 @@
+# GetWebhookEndpoint200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**WebhookEndpointDto**](WebhookEndpointDto.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetWebhookEndpoint200Response } from '@cmarket/partner-sdk';
+
+const instance: GetWebhookEndpoint200Response = {
+    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/ListWebhookDeliveries200Response.md

@@ -0,0 +1,20 @@
+# ListWebhookDeliveries200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**ListWebhookDeliveriesResponseDto**](ListWebhookDeliveriesResponseDto.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ListWebhookDeliveries200Response } from '@cmarket/partner-sdk';
+
+const instance: ListWebhookDeliveries200Response = {
+    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/ListWebhookDeliveriesResponseDto.md

@@ -0,0 +1,22 @@
+# ListWebhookDeliveriesResponseDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**Array<WebhookDeliveryDto>**](WebhookDeliveryDto.md) | 전송 시도 목록(최신순). | [default to undefined]
+**nextCursor** | **string** | 다음 페이지 커서(불투명). null 이면 마지막 페이지. | [default to undefined]
+
+## Example
+
+```typescript
+import { ListWebhookDeliveriesResponseDto } from '@cmarket/partner-sdk';
+
+const instance: ListWebhookDeliveriesResponseDto = {
+    items,
+    nextCursor,
+};
+```
+
+[[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/ListWebhookEndpoints200Response.md

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