@cmarket/partner-sdk 46.0.0 → 47.0.0

package/docs/GetWebhookEndpoint200Response.md

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

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

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

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

package/docs/OnBidAwardRevertedRequest.md

@@ -1,26 +0,0 @@
-# OnBidAwardRevertedRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** | 이벤트 식별자. `webhook-id` 헤더와 같은 값입니다. | [default to undefined]
-**type** | **string** |  | [default to undefined]
-**createdAt** | **string** | 이벤트 발생 시각(ISO 8601 UTC). | [default to undefined]
-**data** | [**WebhookBidEventData**](WebhookBidEventData.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { OnBidAwardRevertedRequest } from '@cmarket/partner-sdk';
-
-const instance: OnBidAwardRevertedRequest = {
-    id,
-    type,
-    createdAt,
-    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/OnBidAwardedRequest.md

@@ -1,26 +0,0 @@
-# OnBidAwardedRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** | 이벤트 식별자. `webhook-id` 헤더와 같은 값입니다. | [default to undefined]
-**type** | **string** |  | [default to undefined]
-**createdAt** | **string** | 이벤트 발생 시각(ISO 8601 UTC). | [default to undefined]
-**data** | [**WebhookBidEventData**](WebhookBidEventData.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { OnBidAwardedRequest } from '@cmarket/partner-sdk';
-
-const instance: OnBidAwardedRequest = {
-    id,
-    type,
-    createdAt,
-    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/OnBidCanceledRequest.md

@@ -1,26 +0,0 @@
-# OnBidCanceledRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** | 이벤트 식별자. `webhook-id` 헤더와 같은 값입니다. | [default to undefined]
-**type** | **string** |  | [default to undefined]
-**createdAt** | **string** | 이벤트 발생 시각(ISO 8601 UTC). | [default to undefined]
-**data** | [**WebhookBidEventData**](WebhookBidEventData.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { OnBidCanceledRequest } from '@cmarket/partner-sdk';
-
-const instance: OnBidCanceledRequest = {
-    id,
-    type,
-    createdAt,
-    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/OnBidClosedRequest.md

@@ -1,26 +0,0 @@
-# OnBidClosedRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** | 이벤트 식별자. `webhook-id` 헤더와 같은 값입니다. | [default to undefined]
-**type** | **string** |  | [default to undefined]
-**createdAt** | **string** | 이벤트 발생 시각(ISO 8601 UTC). | [default to undefined]
-**data** | [**WebhookBidEventData**](WebhookBidEventData.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { OnBidClosedRequest } from '@cmarket/partner-sdk';
-
-const instance: OnBidClosedRequest = {
-    id,
-    type,
-    createdAt,
-    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/OnBidFailedRequest.md

@@ -1,26 +0,0 @@
-# OnBidFailedRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** | 이벤트 식별자. `webhook-id` 헤더와 같은 값입니다. | [default to undefined]
-**type** | **string** |  | [default to undefined]
-**createdAt** | **string** | 이벤트 발생 시각(ISO 8601 UTC). | [default to undefined]
-**data** | [**WebhookBidEventData**](WebhookBidEventData.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { OnBidFailedRequest } from '@cmarket/partner-sdk';
-
-const instance: OnBidFailedRequest = {
-    id,
-    type,
-    createdAt,
-    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/OnPingRequest.md

@@ -1,26 +0,0 @@
-# OnPingRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** | 이벤트 식별자. `webhook-id` 헤더와 같은 값입니다. | [default to undefined]
-**type** | **string** |  | [default to undefined]
-**createdAt** | **string** | 이벤트 발생 시각(ISO 8601 UTC). | [default to undefined]
-**data** | [**WebhookPingEventData**](WebhookPingEventData.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { OnPingRequest } from '@cmarket/partner-sdk';
-
-const instance: OnPingRequest = {
-    id,
-    type,
-    createdAt,
-    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/PartnerWebhookDeliveryStatus.md

@@ -1,14 +0,0 @@
-# PartnerWebhookDeliveryStatus
-
-
-## Enum
-
-* `Pending` (value: `'PENDING'`)
-
-* `Delivered` (value: `'DELIVERED'`)
-
-* `Failed` (value: `'FAILED'`)
-
-* `Exhausted` (value: `'EXHAUSTED'`)
-
-[[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/PartnerWebhookEndpointStatus.md

@@ -1,11 +0,0 @@
-# PartnerWebhookEndpointStatus
-
-구독 상태. `DISABLED` 면 발송이 멈춘 상태이며 `PATCH … {\"status\":\"ACTIVE\"}`로 되살립니다.
-
-## Enum
-
-* `Active` (value: `'ACTIVE'`)
-
-* `Disabled` (value: `'DISABLED'`)
-
-[[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/PartnerWebhookEventType.md

@@ -1,17 +0,0 @@
-# PartnerWebhookEventType
-
-구독한 이벤트 타입.
-
-## Enum
-
-* `BidClosed` (value: `'bid.closed'`)
-
-* `BidAwarded` (value: `'bid.awarded'`)
-
-* `BidFailed` (value: `'bid.failed'`)
-
-* `BidCanceled` (value: `'bid.canceled'`)
-
-* `BidAwardReverted` (value: `'bid.award_reverted'`)
-
-[[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/SendWebhookTestEvent200Response.md

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

@@ -1,24 +0,0 @@
-# UpdateWebhookEndpointRequestDto
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**url** | **string** | 새 수신 주소(HTTPS). | [optional] [default to undefined]
-**eventTypes** | [**Set<PartnerWebhookEventType>**](PartnerWebhookEventType.md) | 구독 이벤트 타입 **전체 치환**. 최소 1개, 중복 불가. | [optional] [default to undefined]
-**status** | [**PartnerWebhookEndpointStatus**](PartnerWebhookEndpointStatus.md) | 구독 상태. 연속 실패로 자동 중지(`DISABLED`)된 구독을 고친 뒤 `ACTIVE`로 되살릴 때 씁니다. 잠시 발송을 멈추려면 `DISABLED`로 보내세요. | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { UpdateWebhookEndpointRequestDto } from '@cmarket/partner-sdk';
-
-const instance: UpdateWebhookEndpointRequestDto = {
-    url,
-    eventTypes,
-    status,
-};
-```
-
-[[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/WebhookBidEventData.md

@@ -1,27 +0,0 @@
-# WebhookBidEventData
-
-공고 상태 전이 이벤트의 본문. 상세는 `GET /v2/bids/{bidId}`가 SSOT입니다.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**bidId** | **string** | 공고 식별자. | [default to undefined]
-**status** | [**BidPublicStatus**](BidPublicStatus.md) | 전이 후 공고 상태(공개값). | [default to undefined]
-**previousStatus** | [**BidPublicStatus**](BidPublicStatus.md) | 전이 전 공고 상태(공개값). 직전 상태를 특정할 수 없으면 null. | [optional] [default to undefined]
-**occurredAt** | **string** | 전이 시각(ISO 8601 UTC). | [default to undefined]
-
-## Example
-
-```typescript
-import { WebhookBidEventData } from '@cmarket/partner-sdk';
-
-const instance: WebhookBidEventData = {
-    bidId,
-    status,
-    previousStatus,
-    occurredAt,
-};
-```
-
-[[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/WebhookDeliveryDto.md

@@ -1,42 +0,0 @@
-# WebhookDeliveryDto
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**deliveryId** | **string** | 전송 시도 식별자. | [default to undefined]
-**endpointId** | **string** | 이 전송이 속한 구독 식별자. | [default to undefined]
-**eventId** | **string** | 이벤트 식별자. 재시도해도 같은 값이며 `X-CMarket-Event-Id` 헤더로 실려 갑니다 — 수신측 중복 제거 키로 쓰세요. | [default to undefined]
-**eventType** | **string** | 이벤트 타입. | [default to undefined]
-**status** | [**PartnerWebhookDeliveryStatus**](PartnerWebhookDeliveryStatus.md) | 전송 상태. `PENDING`=대기·재시도 예정, `DELIVERED`=2xx 수신, `FAILED`=실패했고 재시도가 남음, `EXHAUSTED`=재시도 소진(더 보내지 않음). | [default to undefined]
-**attempt** | **number** | 몇 번째 시도인가(1부터). | [default to undefined]
-**payload** | **{ [key: string]: any; }** | 보낸(보낼) 이벤트 본문. 수신측이 실제로 받는 JSON 그대로입니다. | [default to undefined]
-**responseStatus** | **number** | 수신측이 돌려준 HTTP 상태. 아직 보내지 않았거나 연결 자체가 실패했으면 null. | [default to undefined]
-**responseBodyExcerpt** | **string** | 수신측 응답 본문 앞부분(진단용, 길이 제한). 없으면 null. | [default to undefined]
-**nextAttemptAt** | **string** | 다음 재시도 예정 일시(ISO 8601, UTC). 재시도 예정이 없으면 null. | [default to undefined]
-**createdAt** | **string** | 이 시도가 만들어진 일시(ISO 8601, UTC). | [default to undefined]
-**deliveredAt** | **string** | 2xx를 받은 일시(ISO 8601, UTC). 성공하지 않았으면 null. | [default to undefined]
-
-## Example
-
-```typescript
-import { WebhookDeliveryDto } from '@cmarket/partner-sdk';
-
-const instance: WebhookDeliveryDto = {
-    deliveryId,
-    endpointId,
-    eventId,
-    eventType,
-    status,
-    attempt,
-    payload,
-    responseStatus,
-    responseBodyExcerpt,
-    nextAttemptAt,
-    createdAt,
-    deliveredAt,
-};
-```
-
-[[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/WebhookEndpointDto.md

@@ -1,38 +0,0 @@
-# WebhookEndpointDto
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**endpointId** | **string** | 구독 식별자. | [default to undefined]
-**url** | **string** | 이벤트를 받을 수신 주소(HTTPS). | [default to undefined]
-**eventTypes** | [**Array<PartnerWebhookEventType>**](PartnerWebhookEventType.md) | 구독한 이벤트 타입. | [default to undefined]
-**status** | [**PartnerWebhookEndpointStatus**](PartnerWebhookEndpointStatus.md) | 구독 상태. `DISABLED` 면 발송이 멈춘 상태이며 `PATCH … {\"status\":\"ACTIVE\"}`로 되살립니다. | [default to undefined]
-**consecutiveFailures** | **number** | 연속 실패 횟수. 2xx를 한 번 받으면 0으로 돌아갑니다. 임계치에 닿으면 구독이 자동으로 `DISABLED` 됩니다. | [default to undefined]
-**secretVersion** | **number** | 서명 시크릿 세대. 재발급할 때마다 1 씩 올라갑니다 — 수신측이 어느 시크릿으로 검증해야 하는지 대조하는 용도입니다. | [default to undefined]
-**createdAt** | **string** | 등록 일시(ISO 8601, UTC). | [default to undefined]
-**updatedAt** | **string** | 최종 수정 일시(ISO 8601, UTC). | [default to undefined]
-**disabledAt** | **string** | `DISABLED`로 내려간 일시(ISO 8601, UTC). 활성 구독이면 null. | [default to undefined]
-**lastSuccessAt** | **string** | 마지막으로 2xx를 받은 일시(ISO 8601, UTC). 한 번도 성공한 적이 없으면 null. | [default to undefined]
-
-## Example
-
-```typescript
-import { WebhookEndpointDto } from '@cmarket/partner-sdk';
-
-const instance: WebhookEndpointDto = {
-    endpointId,
-    url,
-    eventTypes,
-    status,
-    consecutiveFailures,
-    secretVersion,
-    createdAt,
-    updatedAt,
-    disabledAt,
-    lastSuccessAt,
-};
-```
-
-[[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/WebhookEndpointWithSecretDto.md

@@ -1,40 +0,0 @@
-# WebhookEndpointWithSecretDto
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**endpointId** | **string** | 구독 식별자. | [default to undefined]
-**url** | **string** | 이벤트를 받을 수신 주소(HTTPS). | [default to undefined]
-**eventTypes** | [**Array<PartnerWebhookEventType>**](PartnerWebhookEventType.md) | 구독한 이벤트 타입. | [default to undefined]
-**status** | [**PartnerWebhookEndpointStatus**](PartnerWebhookEndpointStatus.md) | 구독 상태. `DISABLED` 면 발송이 멈춘 상태이며 `PATCH … {\"status\":\"ACTIVE\"}`로 되살립니다. | [default to undefined]
-**consecutiveFailures** | **number** | 연속 실패 횟수. 2xx를 한 번 받으면 0으로 돌아갑니다. 임계치에 닿으면 구독이 자동으로 `DISABLED` 됩니다. | [default to undefined]
-**secretVersion** | **number** | 서명 시크릿 세대. 재발급할 때마다 1 씩 올라갑니다 — 수신측이 어느 시크릿으로 검증해야 하는지 대조하는 용도입니다. | [default to undefined]
-**createdAt** | **string** | 등록 일시(ISO 8601, UTC). | [default to undefined]
-**updatedAt** | **string** | 최종 수정 일시(ISO 8601, UTC). | [default to undefined]
-**disabledAt** | **string** | `DISABLED`로 내려간 일시(ISO 8601, UTC). 활성 구독이면 null. | [default to undefined]
-**lastSuccessAt** | **string** | 마지막으로 2xx를 받은 일시(ISO 8601, UTC). 한 번도 성공한 적이 없으면 null. | [default to undefined]
-**secret** | **string** | 서명 시크릿. `X-CMarket-Signature` 검증에 쓰며 **이 응답에서만** 확인할 수 있습니다. 안전한 곳에 즉시 보관하세요. | [default to undefined]
-
-## Example
-
-```typescript
-import { WebhookEndpointWithSecretDto } from '@cmarket/partner-sdk';
-
-const instance: WebhookEndpointWithSecretDto = {
-    endpointId,
-    url,
-    eventTypes,
-    status,
-    consecutiveFailures,
-    secretVersion,
-    createdAt,
-    updatedAt,
-    disabledAt,
-    lastSuccessAt,
-    secret,
-};
-```
-
-[[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/WebhookEventEnvelope.md

@@ -1,27 +0,0 @@
-# WebhookEventEnvelope
-
-모든 웹훅 본문의 공통 형식. 필드 순서가 곧 서명 대상 바이트 순서입니다.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** | 이벤트 식별자. `webhook-id` 헤더와 같은 값입니다. | [default to undefined]
-**type** | **string** | 이벤트 타입. | [default to undefined]
-**createdAt** | **string** | 이벤트 발생 시각(ISO 8601 UTC). | [default to undefined]
-**data** | **{ [key: string]: any; }** | 이벤트별 본문. 아래 이벤트 항목의 스키마를 보세요. | [default to undefined]
-
-## Example
-
-```typescript
-import { WebhookEventEnvelope } from '@cmarket/partner-sdk';
-
-const instance: WebhookEventEnvelope = {
-    id,
-    type,
-    createdAt,
-    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/WebhookPingEventData.md

@@ -1,21 +0,0 @@
-# WebhookPingEventData
-
-연결 확인 발송의 본문.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**endpointId** | **string** | 확인을 요청한 구독 식별자. | [default to undefined]
-
-## Example
-
-```typescript
-import { WebhookPingEventData } from '@cmarket/partner-sdk';
-
-const instance: WebhookPingEventData = {
-    endpointId,
-};
-```
-
-[[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/WebhookTestResultDto.md

@@ -1,24 +0,0 @@
-# WebhookTestResultDto
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**delivered** | **boolean** | 수신측이 2xx로 응답했는가. | [default to undefined]
-**responseStatus** | **number** | 수신측이 돌려준 HTTP 상태. 연결 자체가 실패했으면 null. | [default to undefined]
-**error** | **string** | 실패 사유(연결 거부·타임아웃·TLS 오류 등). 성공했으면 null. 수신측 주소·방화벽·인증서를 확인하는 데 쓰세요. | [default to undefined]
-
-## Example
-
-```typescript
-import { WebhookTestResultDto } from '@cmarket/partner-sdk';
-
-const instance: WebhookTestResultDto = {
-    delivered,
-    responseStatus,
-    error,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)