@cmarket/partner-sdk 39.0.0 → 40.0.0

package/dist/api/oauth-api.js

@@ -3,9 +3,9 @@
 /* eslint-disable */
 /**
  * CMARKET V6 Partner API
- * 외부 ERP 연동용 RESTful API.  ## 인증 OAuth2 Bearer JWT (`client_credentials` 플로우). `/oauth/token` 에서 토큰을 발급받아 `Authorization: Bearer <token>` 헤더로 실으세요.  ## 권한 — 두 개의 독립된 축 `403` 을 만났다면 둘 중 어느 축에 걸린 것인지 먼저 구분하세요. - **스코프** = *무엇을 할 수 있나*. 토큰에 부여된 `bids:read`·`contracts:write` 등입니다. 미보유 시 `…/insufficient-scope`. - **대행 범위** = *누구의 데이터를 다룰 수 있나*. API 키 설정이며 스코프로 표현되지 않습니다. 범위 밖이면 스코프와 무관하게 403 입니다.  대행 범위는 키마다 둘 중 하나로 설정됩니다 — **소속 그룹 전원**(기관 키. 사업처·부서 계정이 새로 생겨도 자동 포함) 또는 **지정 발주처 목록**(계약으로 합의된 목록). 범위를 넓혀야 하면 스코프가 아니라 키 설정 변경을 요청하세요.  ## 성공 응답 봉투 `/v2` 의 모든 2xx 본문은 `{ \"data\": … }` 입니다. 단일 리소스든 목록이든 같습니다. **목록은 `data` 가 배열이고 `meta` 가 항상 함께 실립니다** — `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. 단일 리소스 응답에는 `meta` 가 나가지 않습니다.  봉투를 쓰지 않는 표면은 둘입니다. `/oauth/_*` 와 `/.well-known/_*` 는 각각 RFC 6749·RFC 8414·RFC 9728 이 최상위 필드를 규정하고, 파일 내용 응답은 본문이 JSON 이 아닙니다.  에러 응답에는 봉투를 씌우지 않습니다 — 아래 problem+json 이 단독으로 책임집니다.  ## 조건부 요청 (ETag) `/v2` 의 모든 `GET` 응답에 weak `ETag`(`W/\"…\"`)가 실립니다. 받은 값을 다음 요청의 `If-None-Match` 헤더로 되보내면, 내용이 그대로일 때 `304 Not Modified` 를 본문 없이 받습니다. 결과가 나기를 기다리며 같은 자원을 반복 조회하는 연동이라면 이 헤더 하나로 전송량이 사라집니다.  ## 에러 (RFC 9457 problem+json) 모든 에러 응답은 `application/problem+json` 입니다. **HTTP status + `type` URI** 로 분기하세요. - `retryable`(boolean): 자동 재시도 안전 여부. `true`(429·5xx transient)면 backoff 후 재시도하고, `false`면 요청을 고쳐야 합니다. - `traceId`: 요청 추적 id. `X-Correlation-Id` 응답 헤더와 같은 값입니다 — 문의할 때 이 값을 첨부하세요. - `correlationId`: `traceId` 와 같은 값의 옛 이름. 기존 연동 호환으로 함께 실립니다. 새 연동은 `traceId` 를 읽으세요. - `invalid-params`: 검증 실패(400 `…/validation-failed`) 시 위반 필드 경로 목록(RFC 9457 확장, 값 없음).  `type` 은 `https://problems.cmarket.io/partner/<slug>` 형태의 **안정 식별자**입니다. RFC 9457 §3.1.1 이 허용하는 대로 이 URI 는 **역참조(dereference)되지 않습니다** — 브라우저로 열지 말고 문자열 비교로만 쓰세요. slug 목록과 의미는 각 엔드포인트의 응답 설명에 status 별로 적혀 있습니다.  ### 멱등성 위반: 409 와 422 의 차이 - `409` `…/idempotency-key-conflict` — 같은 키의 **원 요청이 아직 처리 중**입니다. 잠시 뒤 같은 키로 다시 부르면 그 결과를 받습니다. - `422` `…/idempotency-key-reused` — 같은 키를 **다른 body** 로 보냈습니다. 재시도해도 영원히 같은 실패이니 새 키를 쓰거나 body 를 되돌리세요.  ## Rate Limit 전역 **60 요청/분 per `client_id`**, 토큰 발급(`/oauth/token`)은 **5 요청/분** 입니다. 초과 시 `429`(`type: …/too-many-requests`). 쿼터는 두 가지 표기로 함께 나갑니다 — 신규 연동은 표준 필드를 쓰세요. - **표준**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (정책) · `RateLimit: \"default\";r=59;t=42` (잔량 r, 리셋까지 t 초) - **레거시**(관용): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. 기존 연동 호환을 위해 유지합니다.  `429` 에서는 `Retry-After`(초)가 우선합니다. 대량 동기화(품목 단위 반복 등록 등)는 `Retry-After` 만큼 backoff 후 재시도하세요.  ## 추적 요청에 `X-Correlation-Id` 헤더를 실으면 그대로 echo 되고, 없으면 서버가 발급합니다. 모든 응답(성공/에러)에 `X-Correlation-Id` 가 실립니다.  ## 전방호환 — 모르는 필드와 값에서 깨지지 않게 다음 셋은 breaking 변경으로 보지 않으며 minor 릴리스에서 예고 없이 일어납니다. 이 전제로 구현하세요. - **선택 필드 추가**: 모르는 필드는 무시하세요. 엄격 파서(unknown key 거부)를 쓰지 마세요. - **enum 값 추가**: 상태·낙찰방법 등에 새 값이 생깁니다. 모르는 값을 만나면 예외를 던지지 말고 원문 문자열을 보존하세요. - **problem `type` slug 추가**: 모르는 slug 은 **HTTP status 로 폴백**해 분기하세요.  ## 버전 수명(deprecation/sunset) - **_/v2** breaking 변경은 CHANGELOG SemVer(major bump)와 `Deprecation`/`Sunset` 헤더로 통지합니다. 이 헤더를 모니터링하세요.
+ * 외부 ERP 연동용 RESTful API.  ## 인증 OAuth2 Bearer JWT (`client_credentials` 플로우). `/oauth/token`에서 토큰을 발급받아 `Authorization: Bearer <token>` 헤더로 실으세요.  ## 권한 — 두 개의 독립된 축 `403`을 만났다면 둘 중 어느 축에 걸린 것인지 먼저 구분하세요. - **스코프** = *무엇을 할 수 있나*. 토큰에 부여된 `bids:read`·`contracts:write` 등입니다. 미보유 시 `…/insufficient-scope`. - **대행 범위** = *누구의 데이터를 다룰 수 있나*. API 키 설정이며 스코프로 표현되지 않습니다. 범위 밖이면 스코프와 무관하게 403입니다.  대행 범위는 키마다 둘 중 하나로 설정됩니다 — **소속 그룹 전원**(기관 키. 사업처·부서 계정이 새로 생겨도 자동 포함) 또는 **지정 발주기관 목록**(계약으로 합의된 목록). 범위를 넓혀야 하면 스코프가 아니라 키 설정 변경을 요청하세요.  ## 성공 응답 봉투 `/v2`의 모든 2xx 본문은 `{ \"data\": … }`입니다. 단일 리소스든 목록이든 같습니다. **목록은 `data`가 배열이고 `meta`가 항상 함께 실립니다** — `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. 단일 리소스 응답에는 `meta`가 나가지 않습니다.  봉투를 쓰지 않는 표면은 둘입니다. `/oauth/_*`와 `/.well-known/_*`는 각각 RFC 6749·RFC 8414·RFC 9728이 최상위 필드를 규정하고, 파일 내용 응답은 본문이 JSON이 아닙니다.  에러 응답에는 봉투를 씌우지 않습니다 — 아래 problem+json이 단독으로 책임집니다.  ## 조건부 요청 (ETag) `/v2`의 모든 `GET` 응답에 weak `ETag`(`W/\"…\"`)가 실립니다. 받은 값을 다음 요청의 `If-None-Match` 헤더로 되보내면, 내용이 그대로일 때 `304 Not Modified`를 본문 없이 받습니다. 결과가 나기를 기다리며 같은 자원을 반복 조회하는 연동이라면 이 헤더 하나로 전송량이 사라집니다.  ## 에러 (RFC 9457 problem+json) 모든 에러 응답은 `application/problem+json`입니다. **HTTP status + `type` URI** 로 분기하세요. - `retryable`(boolean): 자동 재시도 안전 여부. `true`(429·5xx transient)면 backoff 후 재시도하고, `false`면 요청을 고쳐야 합니다. - `traceId`: 요청 추적 id. `X-Correlation-Id` 응답 헤더와 같은 값입니다 — 문의할 때 이 값을 첨부하세요. - `correlationId`: `traceId`와 같은 값의 옛 이름. 기존 연동 호환으로 함께 실립니다. 새 연동은 `traceId`를 읽으세요. - `invalid-params`: 검증 실패(400 `…/validation-failed`) 시 위반 필드 경로 목록(RFC 9457 확장, 값 없음).  `type`은 `https://problems.cmarket.io/partner/<slug>` 형태의 **안정 식별자**입니다. RFC 9457 §3.1.1이 허용하는 대로 이 URI는 **역참조(dereference)되지 않습니다** — 브라우저로 열지 말고 문자열 비교로만 쓰세요. slug 목록과 의미는 각 엔드포인트의 응답 설명에 status 별로 적혀 있습니다.  ### 멱등성 위반: 409와 422의 차이 - `409` `…/idempotency-key-conflict` — 같은 키의 **원 요청이 아직 처리 중**입니다. 잠시 뒤 같은 키로 다시 부르면 그 결과를 받습니다. - `422` `…/idempotency-key-reused` — 같은 키를 **다른 body** 로 보냈습니다. 재시도해도 영원히 같은 실패이니 새 키를 쓰거나 body를 되돌리세요.  ## Rate Limit 전역 **60 요청/분 per `client_id`**, 토큰 발급(`/oauth/token`)은 **5 요청/분** 입니다. 초과 시 `429`(`type: …/too-many-requests`). 쿼터는 두 가지 표기로 함께 나갑니다 — 신규 연동은 표준 필드를 쓰세요. - **표준**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (정책) · `RateLimit: \"default\";r=59;t=42` (잔량 r, 리셋까지 t 초) - **레거시**(관용): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. 기존 연동 호환을 위해 유지합니다.  `429` 에서는 `Retry-After`(초)가 우선합니다. 대량 동기화(품목 단위 반복 등록 등)는 `Retry-After` 만큼 backoff 후 재시도하세요.  ## 추적 요청에 `X-Correlation-Id` 헤더를 실으면 그대로 echo 되고, 없으면 서버가 발급합니다. 모든 응답(성공/에러)에 `X-Correlation-Id`가 실립니다.  ## 전방호환 — 모르는 필드와 값에서 깨지지 않게 다음 셋은 breaking 변경으로 보지 않으며 minor 릴리스에서 예고 없이 일어납니다. 이 전제로 구현하세요. - **선택 필드 추가**: 모르는 필드는 무시하세요. 엄격 파서(unknown key 거부)를 쓰지 마세요. - **enum 값 추가**: 상태·낙찰방법 등에 새 값이 생깁니다. 모르는 값을 만나면 예외를 던지지 말고 원문 문자열을 보존하세요. - **problem `type` slug 추가**: 모르는 slug은 **HTTP status로 폴백**해 분기하세요.  ## 버전 수명(deprecation/sunset) - **_/v2** breaking 변경은 CHANGELOG SemVer(major bump)와 `Deprecation`/`Sunset` 헤더로 통지합니다. 이 헤더를 모니터링하세요.
  *
- * The version of the OpenAPI document: 39.0.0
+ * The version of the OpenAPI document: 40.0.0
  * Contact: semo.io.kr@gmail.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -35,7 +35,7 @@ const base_1 = require("../base");
 const OauthApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         * 가지고 있는 access token 이 지금도 유효한지, 어떤 스코프를 갖는지 확인합니다. 자기 토큰만 조회할 수 있습니다 — 위조·만료·폐기됐거나 다른 client 의 토큰이면 이유를 구분하지 않고 `{\"active\": false}` 로 답합니다(RFC 7662 §4).
+         * 가지고 있는 access token이 지금도 유효한지, 어떤 스코프를 갖는지 확인합니다. 자기 토큰만 조회할 수 있습니다 — 위조·만료·폐기됐거나 다른 client의 토큰이면 이유를 구분하지 않고 `{\"active\": false}`로 답합니다(RFC 7662 §4).
          * @summary OAuth 2.0 토큰 검사 (Token Introspection, RFC 7662)
          * @param {IntrospectRequestDto} introspectRequestDto
          * @param {*} [options] Override http request option.
@@ -66,7 +66,7 @@ const OauthApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * 발급받은 access token 을 즉시 무효화합니다. 유출을 확인했을 때 TTL(15분) 만료를 기다리지 않고 끊는 경로입니다. RFC 7009 §2.2 에 따라 이미 만료됐거나 알 수 없는 토큰을 보내도 200 으로 응답합니다.
+         * 발급받은 access token을 즉시 무효화합니다. 유출을 확인했을 때 TTL(15분) 만료를 기다리지 않고 끊는 경로입니다. RFC 7009 §2.2에 따라 이미 만료됐거나 알 수 없는 토큰을 보내도 200으로 응답합니다.
          * @summary OAuth 2.0 토큰 폐기 (Token Revocation, RFC 7009)
          * @param {RevokeRequestDto} revokeRequestDto
          * @param {*} [options] Override http request option.
@@ -97,8 +97,8 @@ const OauthApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * 파트너 ERP 가 client_id/secret 로 단명 JWT access token 을 발급받습니다 (TTL 15분). 이후 모든 보호 endpoint 는 Authorization: Bearer <token> 헤더로 호출합니다.
-         * @summary OAuth 2.0 access token 발급 (client_credentials)
+         * `client_id`·`client_secret`으로 액세스 토큰을 발급합니다(`client_credentials`, TTL 15분). 이후 모든 요청은 `Authorization: Bearer <token>` 헤더로 호출합니다.
+         * @summary 액세스 토큰 발급
          * @param {TokenRequestDto} tokenRequestDto
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -137,7 +137,7 @@ const OauthApiFp = function (configuration) {
     const localVarAxiosParamCreator = (0, exports.OauthApiAxiosParamCreator)(configuration);
     return {
         /**
-         * 가지고 있는 access token 이 지금도 유효한지, 어떤 스코프를 갖는지 확인합니다. 자기 토큰만 조회할 수 있습니다 — 위조·만료·폐기됐거나 다른 client 의 토큰이면 이유를 구분하지 않고 `{\"active\": false}` 로 답합니다(RFC 7662 §4).
+         * 가지고 있는 access token이 지금도 유효한지, 어떤 스코프를 갖는지 확인합니다. 자기 토큰만 조회할 수 있습니다 — 위조·만료·폐기됐거나 다른 client의 토큰이면 이유를 구분하지 않고 `{\"active\": false}`로 답합니다(RFC 7662 §4).
          * @summary OAuth 2.0 토큰 검사 (Token Introspection, RFC 7662)
          * @param {IntrospectRequestDto} introspectRequestDto
          * @param {*} [options] Override http request option.
@@ -153,7 +153,7 @@ const OauthApiFp = function (configuration) {
             });
         },
         /**
-         * 발급받은 access token 을 즉시 무효화합니다. 유출을 확인했을 때 TTL(15분) 만료를 기다리지 않고 끊는 경로입니다. RFC 7009 §2.2 에 따라 이미 만료됐거나 알 수 없는 토큰을 보내도 200 으로 응답합니다.
+         * 발급받은 access token을 즉시 무효화합니다. 유출을 확인했을 때 TTL(15분) 만료를 기다리지 않고 끊는 경로입니다. RFC 7009 §2.2에 따라 이미 만료됐거나 알 수 없는 토큰을 보내도 200으로 응답합니다.
          * @summary OAuth 2.0 토큰 폐기 (Token Revocation, RFC 7009)
          * @param {RevokeRequestDto} revokeRequestDto
          * @param {*} [options] Override http request option.
@@ -169,8 +169,8 @@ const OauthApiFp = function (configuration) {
             });
         },
         /**
-         * 파트너 ERP 가 client_id/secret 로 단명 JWT access token 을 발급받습니다 (TTL 15분). 이후 모든 보호 endpoint 는 Authorization: Bearer <token> 헤더로 호출합니다.
-         * @summary OAuth 2.0 access token 발급 (client_credentials)
+         * `client_id`·`client_secret`으로 액세스 토큰을 발급합니다(`client_credentials`, TTL 15분). 이후 모든 요청은 `Authorization: Bearer <token>` 헤더로 호출합니다.
+         * @summary 액세스 토큰 발급
          * @param {TokenRequestDto} tokenRequestDto
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -194,7 +194,7 @@ const OauthApiFactory = function (configuration, basePath, axios) {
     const localVarFp = (0, exports.OauthApiFp)(configuration);
     return {
         /**
-         * 가지고 있는 access token 이 지금도 유효한지, 어떤 스코프를 갖는지 확인합니다. 자기 토큰만 조회할 수 있습니다 — 위조·만료·폐기됐거나 다른 client 의 토큰이면 이유를 구분하지 않고 `{\"active\": false}` 로 답합니다(RFC 7662 §4).
+         * 가지고 있는 access token이 지금도 유효한지, 어떤 스코프를 갖는지 확인합니다. 자기 토큰만 조회할 수 있습니다 — 위조·만료·폐기됐거나 다른 client의 토큰이면 이유를 구분하지 않고 `{\"active\": false}`로 답합니다(RFC 7662 §4).
          * @summary OAuth 2.0 토큰 검사 (Token Introspection, RFC 7662)
          * @param {IntrospectRequestDto} introspectRequestDto
          * @param {*} [options] Override http request option.
@@ -204,7 +204,7 @@ const OauthApiFactory = function (configuration, basePath, axios) {
             return localVarFp.introspect(introspectRequestDto, options).then((request) => request(axios, basePath));
         },
         /**
-         * 발급받은 access token 을 즉시 무효화합니다. 유출을 확인했을 때 TTL(15분) 만료를 기다리지 않고 끊는 경로입니다. RFC 7009 §2.2 에 따라 이미 만료됐거나 알 수 없는 토큰을 보내도 200 으로 응답합니다.
+         * 발급받은 access token을 즉시 무효화합니다. 유출을 확인했을 때 TTL(15분) 만료를 기다리지 않고 끊는 경로입니다. RFC 7009 §2.2에 따라 이미 만료됐거나 알 수 없는 토큰을 보내도 200으로 응답합니다.
          * @summary OAuth 2.0 토큰 폐기 (Token Revocation, RFC 7009)
          * @param {RevokeRequestDto} revokeRequestDto
          * @param {*} [options] Override http request option.
@@ -214,8 +214,8 @@ const OauthApiFactory = function (configuration, basePath, axios) {
             return localVarFp.revoke(revokeRequestDto, options).then((request) => request(axios, basePath));
         },
         /**
-         * 파트너 ERP 가 client_id/secret 로 단명 JWT access token 을 발급받습니다 (TTL 15분). 이후 모든 보호 endpoint 는 Authorization: Bearer <token> 헤더로 호출합니다.
-         * @summary OAuth 2.0 access token 발급 (client_credentials)
+         * `client_id`·`client_secret`으로 액세스 토큰을 발급합니다(`client_credentials`, TTL 15분). 이후 모든 요청은 `Authorization: Bearer <token>` 헤더로 호출합니다.
+         * @summary 액세스 토큰 발급
          * @param {TokenRequestDto} tokenRequestDto
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -231,7 +231,7 @@ exports.OauthApiFactory = OauthApiFactory;
  */
 class OauthApi extends base_1.BaseAPI {
     /**
-     * 가지고 있는 access token 이 지금도 유효한지, 어떤 스코프를 갖는지 확인합니다. 자기 토큰만 조회할 수 있습니다 — 위조·만료·폐기됐거나 다른 client 의 토큰이면 이유를 구분하지 않고 `{\"active\": false}` 로 답합니다(RFC 7662 §4).
+     * 가지고 있는 access token이 지금도 유효한지, 어떤 스코프를 갖는지 확인합니다. 자기 토큰만 조회할 수 있습니다 — 위조·만료·폐기됐거나 다른 client의 토큰이면 이유를 구분하지 않고 `{\"active\": false}`로 답합니다(RFC 7662 §4).
      * @summary OAuth 2.0 토큰 검사 (Token Introspection, RFC 7662)
      * @param {IntrospectRequestDto} introspectRequestDto
      * @param {*} [options] Override http request option.
@@ -241,7 +241,7 @@ class OauthApi extends base_1.BaseAPI {
         return (0, exports.OauthApiFp)(this.configuration).introspect(introspectRequestDto, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * 발급받은 access token 을 즉시 무효화합니다. 유출을 확인했을 때 TTL(15분) 만료를 기다리지 않고 끊는 경로입니다. RFC 7009 §2.2 에 따라 이미 만료됐거나 알 수 없는 토큰을 보내도 200 으로 응답합니다.
+     * 발급받은 access token을 즉시 무효화합니다. 유출을 확인했을 때 TTL(15분) 만료를 기다리지 않고 끊는 경로입니다. RFC 7009 §2.2에 따라 이미 만료됐거나 알 수 없는 토큰을 보내도 200으로 응답합니다.
      * @summary OAuth 2.0 토큰 폐기 (Token Revocation, RFC 7009)
      * @param {RevokeRequestDto} revokeRequestDto
      * @param {*} [options] Override http request option.
@@ -251,8 +251,8 @@ class OauthApi extends base_1.BaseAPI {
         return (0, exports.OauthApiFp)(this.configuration).revoke(revokeRequestDto, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * 파트너 ERP 가 client_id/secret 로 단명 JWT access token 을 발급받습니다 (TTL 15분). 이후 모든 보호 endpoint 는 Authorization: Bearer <token> 헤더로 호출합니다.
-     * @summary OAuth 2.0 access token 발급 (client_credentials)
+     * `client_id`·`client_secret`으로 액세스 토큰을 발급합니다(`client_credentials`, TTL 15분). 이후 모든 요청은 `Authorization: Bearer <token>` 헤더로 호출합니다.
+     * @summary 액세스 토큰 발급
      * @param {TokenRequestDto} tokenRequestDto
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}