@cmarket/partner-sdk 38.2.0 → 38.3.0

package/api/products-api.ts

@@ -4,7 +4,7 @@
  * 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` 헤더로 통지합니다. 이 헤더를 모니터링하세요.
  *
- * The version of the OpenAPI document: 38.2.0
+ * The version of the OpenAPI document: 38.3.0
  * Contact: semo.io.kr@gmail.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -83,10 +83,11 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
          * 기관에 공유된 물품 중 **아직 전송되지 않은 것**을 조회합니다.  **증분 피드입니다.** 가져간 물품을 `POST /v2/products/receipts` 로 수신확인하면 다음 조회 결과에서 빠집니다. 수신확인을 하지 않으면 같은 물품이 계속 내려옵니다.  **권장 흐름:** 조회 → 자기 시스템에 저장 → 저장에 성공한 물품 코드만 수신확인. 저장 전에 수신확인하면 그 물품은 다시 받을 수 없습니다.  **나눠 받기:** `limit` 을 주면 그만큼만 받고, 남은 것이 있으면 `meta.hasMore` 가 `true` 입니다. 커서는 없습니다 — 다음 묶음은 \"커서 다음\" 이 아니라 **아직 수신확인하지 않은 것**이라, 위 흐름을 `meta.hasMore` 가 `false` 가 될 때까지 반복하면 됩니다. `limit` 을 빼면 전부 한 번에 받습니다.  **조회 범위:** 요청 키가 대행하는 기관 그룹입니다. 기관 그룹이 설정되지 않은 키는 403 입니다.  **필수 스코프:** `products:read`
          * @summary 물품 카탈로그 조회
          * @param {number} [limit] 한 번에 받을 최대 물품 수(1~1000). 미지정이면 미전송 물품을 **전부** 받습니다(종전 동작). 카탈로그가 커서 응답이 부담스러우면 이 값을 주고 &#x60;meta.hasMore&#x60; 가 &#x60;false&#x60; 가 될 때까지 반복하세요.
+         * @param {string} [ifNoneMatch] 직전 응답의 &#x60;ETag&#x60; 값. 내용이 그대로면 본문 없이 &#x60;304&#x60; 로 끝납니다 — 폴링에서 전송량과 파싱 비용이 사라집니다.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listProducts: async (limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        listProducts: async (limit?: number, ifNoneMatch?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             const localVarPath = `/v2/products`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -109,6 +110,9 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
 
             localVarHeaderParameter['Accept'] = 'application/json,application/problem+json';
 
+            if (ifNoneMatch != null) {
+                localVarHeaderParameter['If-None-Match'] = String(ifNoneMatch);
+            }
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -145,11 +149,12 @@ export const ProductsApiFp = function(configuration?: Configuration) {
          * 기관에 공유된 물품 중 **아직 전송되지 않은 것**을 조회합니다.  **증분 피드입니다.** 가져간 물품을 `POST /v2/products/receipts` 로 수신확인하면 다음 조회 결과에서 빠집니다. 수신확인을 하지 않으면 같은 물품이 계속 내려옵니다.  **권장 흐름:** 조회 → 자기 시스템에 저장 → 저장에 성공한 물품 코드만 수신확인. 저장 전에 수신확인하면 그 물품은 다시 받을 수 없습니다.  **나눠 받기:** `limit` 을 주면 그만큼만 받고, 남은 것이 있으면 `meta.hasMore` 가 `true` 입니다. 커서는 없습니다 — 다음 묶음은 \"커서 다음\" 이 아니라 **아직 수신확인하지 않은 것**이라, 위 흐름을 `meta.hasMore` 가 `false` 가 될 때까지 반복하면 됩니다. `limit` 을 빼면 전부 한 번에 받습니다.  **조회 범위:** 요청 키가 대행하는 기관 그룹입니다. 기관 그룹이 설정되지 않은 키는 403 입니다.  **필수 스코프:** `products:read`
          * @summary 물품 카탈로그 조회
          * @param {number} [limit] 한 번에 받을 최대 물품 수(1~1000). 미지정이면 미전송 물품을 **전부** 받습니다(종전 동작). 카탈로그가 커서 응답이 부담스러우면 이 값을 주고 &#x60;meta.hasMore&#x60; 가 &#x60;false&#x60; 가 될 때까지 반복하세요.
+         * @param {string} [ifNoneMatch] 직전 응답의 &#x60;ETag&#x60; 값. 내용이 그대로면 본문 없이 &#x60;304&#x60; 로 끝납니다 — 폴링에서 전송량과 파싱 비용이 사라집니다.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async listProducts(limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProducts200Response>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.listProducts(limit, options);
+        async listProducts(limit?: number, ifNoneMatch?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProducts200Response>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listProducts(limit, ifNoneMatch, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['ProductsApi.listProducts']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -178,11 +183,12 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
          * 기관에 공유된 물품 중 **아직 전송되지 않은 것**을 조회합니다.  **증분 피드입니다.** 가져간 물품을 `POST /v2/products/receipts` 로 수신확인하면 다음 조회 결과에서 빠집니다. 수신확인을 하지 않으면 같은 물품이 계속 내려옵니다.  **권장 흐름:** 조회 → 자기 시스템에 저장 → 저장에 성공한 물품 코드만 수신확인. 저장 전에 수신확인하면 그 물품은 다시 받을 수 없습니다.  **나눠 받기:** `limit` 을 주면 그만큼만 받고, 남은 것이 있으면 `meta.hasMore` 가 `true` 입니다. 커서는 없습니다 — 다음 묶음은 \"커서 다음\" 이 아니라 **아직 수신확인하지 않은 것**이라, 위 흐름을 `meta.hasMore` 가 `false` 가 될 때까지 반복하면 됩니다. `limit` 을 빼면 전부 한 번에 받습니다.  **조회 범위:** 요청 키가 대행하는 기관 그룹입니다. 기관 그룹이 설정되지 않은 키는 403 입니다.  **필수 스코프:** `products:read`
          * @summary 물품 카탈로그 조회
          * @param {number} [limit] 한 번에 받을 최대 물품 수(1~1000). 미지정이면 미전송 물품을 **전부** 받습니다(종전 동작). 카탈로그가 커서 응답이 부담스러우면 이 값을 주고 &#x60;meta.hasMore&#x60; 가 &#x60;false&#x60; 가 될 때까지 반복하세요.
+         * @param {string} [ifNoneMatch] 직전 응답의 &#x60;ETag&#x60; 값. 내용이 그대로면 본문 없이 &#x60;304&#x60; 로 끝납니다 — 폴링에서 전송량과 파싱 비용이 사라집니다.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listProducts(limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<ListProducts200Response> {
-            return localVarFp.listProducts(limit, options).then((request) => request(axios, basePath));
+        listProducts(limit?: number, ifNoneMatch?: string, options?: RawAxiosRequestConfig): AxiosPromise<ListProducts200Response> {
+            return localVarFp.listProducts(limit, ifNoneMatch, options).then((request) => request(axios, basePath));
         },
     };
 };
@@ -207,11 +213,12 @@ export class ProductsApi extends BaseAPI {
      * 기관에 공유된 물품 중 **아직 전송되지 않은 것**을 조회합니다.  **증분 피드입니다.** 가져간 물품을 `POST /v2/products/receipts` 로 수신확인하면 다음 조회 결과에서 빠집니다. 수신확인을 하지 않으면 같은 물품이 계속 내려옵니다.  **권장 흐름:** 조회 → 자기 시스템에 저장 → 저장에 성공한 물품 코드만 수신확인. 저장 전에 수신확인하면 그 물품은 다시 받을 수 없습니다.  **나눠 받기:** `limit` 을 주면 그만큼만 받고, 남은 것이 있으면 `meta.hasMore` 가 `true` 입니다. 커서는 없습니다 — 다음 묶음은 \"커서 다음\" 이 아니라 **아직 수신확인하지 않은 것**이라, 위 흐름을 `meta.hasMore` 가 `false` 가 될 때까지 반복하면 됩니다. `limit` 을 빼면 전부 한 번에 받습니다.  **조회 범위:** 요청 키가 대행하는 기관 그룹입니다. 기관 그룹이 설정되지 않은 키는 403 입니다.  **필수 스코프:** `products:read`
      * @summary 물품 카탈로그 조회
      * @param {number} [limit] 한 번에 받을 최대 물품 수(1~1000). 미지정이면 미전송 물품을 **전부** 받습니다(종전 동작). 카탈로그가 커서 응답이 부담스러우면 이 값을 주고 &#x60;meta.hasMore&#x60; 가 &#x60;false&#x60; 가 될 때까지 반복하세요.
+     * @param {string} [ifNoneMatch] 직전 응답의 &#x60;ETag&#x60; 값. 내용이 그대로면 본문 없이 &#x60;304&#x60; 로 끝납니다 — 폴링에서 전송량과 파싱 비용이 사라집니다.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    public listProducts(limit?: number, options?: RawAxiosRequestConfig) {
-        return ProductsApiFp(this.configuration).listProducts(limit, options).then((request) => request(this.axios, this.basePath));
+    public listProducts(limit?: number, ifNoneMatch?: string, options?: RawAxiosRequestConfig) {
+        return ProductsApiFp(this.configuration).listProducts(limit, ifNoneMatch, options).then((request) => request(this.axios, this.basePath));
     }
 }