@cmarket/partner-sdk 0.1.0

package/docs/OauthApi.md

@@ -0,0 +1,61 @@
+# OauthApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**token**](#token) | **POST** /v1/oauth/token | OAuth 2.0 access token 발급 (client_credentials)|
+
+# **token**
+> TokenResponseDto token(tokenRequestDto)
+
+파트너 ERP 가 client_id/secret 로 단명 JWT access token 을 발급받습니다 (TTL 15분). 이후 모든 보호 endpoint 는 Authorization: Bearer <token> 헤더로 호출합니다.
+
+### Example
+
+```typescript
+import {
+    OauthApi,
+    Configuration,
+    TokenRequestDto
+} from '@cmarket/partner-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new OauthApi(configuration);
+
+let tokenRequestDto: TokenRequestDto; //
+
+const { status, data } = await apiInstance.token(
+    tokenRequestDto
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **tokenRequestDto** | **TokenRequestDto**|  | |
+
+
+### Return type
+
+**TokenResponseDto**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+|**401** | invalid_client 또는 invalid_scope |  -  |
+
+[[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/PartnerV1Api.md

@@ -0,0 +1,105 @@
+# PartnerV1Api
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**bidsControllerFindOne**](#bidscontrollerfindone) | **GET** /v1/bids/{bidId} | 공고 단건 조회|
+|[**healthControllerCheck**](#healthcontrollercheck) | **GET** /v1/health | Partner API 헬스체크 (V5 /check 후속)|
+
+# **bidsControllerFindOne**
+> BidSummaryResponseDto bidsControllerFindOne()
+
+V5 `GET /api/bid/{buyIdx}` 의 V6 후속. ERP 가 공고 정보를 조회합니다. 인증 필요 (스코프 `bids:read`).
+
+### Example
+
+```typescript
+import {
+    PartnerV1Api,
+    Configuration
+} from '@cmarket/partner-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new PartnerV1Api(configuration);
+
+let bidId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.bidsControllerFindOne(
+    bidId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **bidId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**BidSummaryResponseDto**
+
+### Authorization
+
+[partner-oauth2](../README.md#partner-oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+|**401** | invalid_token / insufficient_scope / ip_not_allowed |  -  |
+
+[[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)
+
+# **healthControllerCheck**
+> HealthResponseDto healthControllerCheck()
+
+V5 ApiController#check 의 V6 대체. ERP 연동 직전 회선·인증 endpoint 동작 확인용.
+
+### Example
+
+```typescript
+import {
+    PartnerV1Api,
+    Configuration
+} from '@cmarket/partner-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new PartnerV1Api(configuration);
+
+const { status, data } = await apiInstance.healthControllerCheck();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**HealthResponseDto**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+
+[[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/PartnerV1LegacyApi.md

@@ -0,0 +1,97 @@
+# PartnerV1LegacyApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**legacyControllerCheckGet**](#legacycontrollercheckget) | **GET** /v1-legacy/check | V5 /check 호환 헬스체크 (deprecated)|
+|[**legacyControllerCheckPost**](#legacycontrollercheckpost) | **POST** /v1-legacy/check | V5 /check 호환 헬스체크 — POST (deprecated)|
+
+# **legacyControllerCheckGet**
+> LegacyEnvelopeDto legacyControllerCheckGet()
+
+V5 ApiController#check 응답 envelope 그대로. Sunset 헤더 부착.
+
+### Example
+
+```typescript
+import {
+    PartnerV1LegacyApi,
+    Configuration
+} from '@cmarket/partner-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new PartnerV1LegacyApi(configuration);
+
+const { status, data } = await apiInstance.legacyControllerCheckGet();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**LegacyEnvelopeDto**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+
+[[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)
+
+# **legacyControllerCheckPost**
+> LegacyEnvelopeDto legacyControllerCheckPost()
+
+V5 는 GET·POST 모두 받음. 동일 응답.
+
+### Example
+
+```typescript
+import {
+    PartnerV1LegacyApi,
+    Configuration
+} from '@cmarket/partner-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new PartnerV1LegacyApi(configuration);
+
+const { status, data } = await apiInstance.legacyControllerCheckPost();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**LegacyEnvelopeDto**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+
+[[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/PartnerV2Api.md

@@ -0,0 +1,166 @@
+# PartnerV2Api
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**registerAward**](#registeraward) | **POST** /v2/awards | 낙찰 결과 전송|
+|[**registerBid**](#registerbid) | **POST** /v2/bids | 입찰 정보 전송(등록)|
+|[**uploadFile**](#uploadfile) | **POST** /v2/files | 입찰 첨부파일 업로드(base64 또는 url) → fileKey|
+
+# **registerAward**
+> AwardRegisteredResponseDto registerAward(registerAwardRequestDto)
+
+V5 /scsbidSend 후속. 스코프 `awards:write` + `Idempotency-Key` 헤더 필수.
+
+### Example
+
+```typescript
+import {
+    PartnerV2Api,
+    Configuration,
+    RegisterAwardRequestDto
+} from '@cmarket/partner-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new PartnerV2Api(configuration);
+
+let registerAwardRequestDto: RegisterAwardRequestDto; //
+
+const { status, data } = await apiInstance.registerAward(
+    registerAwardRequestDto
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **registerAwardRequestDto** | **RegisterAwardRequestDto**|  | |
+
+
+### Return type
+
+**AwardRegisteredResponseDto**
+
+### Authorization
+
+[partner-oauth2](../README.md#partner-oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** |  |  -  |
+
+[[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)
+
+# **registerBid**
+> BidCreatedResponseDto registerBid(createBidRequestDto)
+
+V5 /bidsend 후속. 스코프 `bids:write` + `Idempotency-Key` 헤더 필수.
+
+### Example
+
+```typescript
+import {
+    PartnerV2Api,
+    Configuration,
+    CreateBidRequestDto
+} from '@cmarket/partner-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new PartnerV2Api(configuration);
+
+let createBidRequestDto: CreateBidRequestDto; //
+
+const { status, data } = await apiInstance.registerBid(
+    createBidRequestDto
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createBidRequestDto** | **CreateBidRequestDto**|  | |
+
+
+### Return type
+
+**BidCreatedResponseDto**
+
+### Authorization
+
+[partner-oauth2](../README.md#partner-oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** |  |  -  |
+
+[[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)
+
+# **uploadFile**
+> FileUploadedResponseDto uploadFile(uploadFileRequestDto)
+
+스코프 `files:write` 필수. base64 또는 url 중 하나를 제출한다.
+
+### Example
+
+```typescript
+import {
+    PartnerV2Api,
+    Configuration,
+    UploadFileRequestDto
+} from '@cmarket/partner-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new PartnerV2Api(configuration);
+
+let uploadFileRequestDto: UploadFileRequestDto; //
+
+const { status, data } = await apiInstance.uploadFile(
+    uploadFileRequestDto
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **uploadFileRequestDto** | **UploadFileRequestDto**|  | |
+
+
+### Return type
+
+**FileUploadedResponseDto**
+
+### Authorization
+
+[partner-oauth2](../README.md#partner-oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** |  |  -  |
+
+[[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/PreconditionsDto.md

@@ -0,0 +1,38 @@
+# PreconditionsDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**bidBond** | [**BidBondDto**](BidBondDto.md) | 입찰보증금 설정 (A 토큰 계열). | [optional] [default to undefined]
+**businessRegistered** | **boolean** | B: 사업자등록증 납부 관련업체. | [optional] [default to undefined]
+**distributor** | **boolean** | C: 총판/대리점. | [optional] [default to undefined]
+**manufacturer** | **boolean** | D: 제조사. | [optional] [default to undefined]
+**directProduction** | **boolean** | E: 직접생산확인증명. | [optional] [default to undefined]
+**legalMandatory** | **Array<string>** | 법적의무구매(XX 우산). I/J/K/L/O1/O2/O3 | [optional] [default to undefined]
+**excellentProcurement** | **Array<string>** | 기술개발제품(XX 우산). P0/P101-P113 | [optional] [default to undefined]
+**greenProduct** | **Array<string>** | 녹색제품(XX 우산). Q0/Q101/Q102/Q103 | [optional] [default to undefined]
+**startup** | **boolean** | R: 창업기업 (XX 우산). | [optional] [default to undefined]
+**social** | **boolean** | S: 사회적기업 (XX 우산). | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PreconditionsDto } from '@cmarket/partner-sdk';
+
+const instance: PreconditionsDto = {
+    bidBond,
+    businessRegistered,
+    distributor,
+    manufacturer,
+    directProduction,
+    legalMandatory,
+    excellentProcurement,
+    greenProduct,
+    startup,
+    social,
+};
+```
+
+[[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/RegisterAwardRequestDto.md

@@ -0,0 +1,24 @@
+# RegisterAwardRequestDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**buyerId** | **string** | 공고 명의 회원 ID(b2b_member.member_id) = 낙찰 확정 actor. V5 bid_branch_id. | [default to undefined]
+**bidNo** | **string** | 공고 구매번호(등록 응답의 bidNo). | [default to undefined]
+**winnerMemberId** | **string** | 낙찰자(공급사) memberId. | [default to undefined]
+
+## Example
+
+```typescript
+import { RegisterAwardRequestDto } from '@cmarket/partner-sdk';
+
+const instance: RegisterAwardRequestDto = {
+    buyerId,
+    bidNo,
+    winnerMemberId,
+};
+```
+
+[[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/TokenRequestDto.md

@@ -0,0 +1,26 @@
+# TokenRequestDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**grant_type** | **string** | OAuth 2.0 grant type. 현재 client_credentials 만 지원. | [default to undefined]
+**client_id** | **string** | 파트너 client_id (대소문자 무시). | [default to undefined]
+**client_secret** | **string** | 파트너 client_secret. | [default to undefined]
+**scope** | **string** | space-separated 요청 스코프. 미지정 시 client 의 전체 스코프 발급. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TokenRequestDto } from '@cmarket/partner-sdk';
+
+const instance: TokenRequestDto = {
+    grant_type,
+    client_id,
+    client_secret,
+    scope,
+};
+```
+
+[[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/TokenResponseDto.md

@@ -0,0 +1,26 @@
+# TokenResponseDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**access_token** | **string** | 발급된 JWT access token. | [default to undefined]
+**token_type** | **string** | Bearer 고정. | [default to undefined]
+**expires_in** | **number** | 유효 기간 (초). | [default to undefined]
+**scope** | **string** | 발급된 스코프 (space-separated). | [default to undefined]
+
+## Example
+
+```typescript
+import { TokenResponseDto } from '@cmarket/partner-sdk';
+
+const instance: TokenResponseDto = {
+    access_token,
+    token_type,
+    expires_in,
+    scope,
+};
+```
+
+[[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/UploadFileRequestDto.md

@@ -0,0 +1,24 @@
+# UploadFileRequestDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fileName** | **string** | 파일명 (확장자 포함). 최대 255자. | [default to undefined]
+**base64** | **string** | Base64 인코딩된 파일 데이터. url 이 없을 때 필수. | [optional] [default to undefined]
+**url** | **string** | 다운로드 가능한 파일 URL. base64 가 없을 때 필수. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UploadFileRequestDto } from '@cmarket/partner-sdk';
+
+const instance: UploadFileRequestDto = {
+    fileName,
+    base64,
+    url,
+};
+```
+
+[[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/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'

package/index.ts

@@ -0,0 +1,18 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * CMARKET V6 Partner API
+ * 외부 ERP 연동용 RESTful API. V5 17개 엔드포인트의 V6 후속.
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+export * from "./api";
+export * from "./configuration";
+export * from "./models";

package/models/award-registered-response-dto.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * CMARKET V6 Partner API
+ * 외부 ERP 연동용 RESTful API. V5 17개 엔드포인트의 V6 후속.
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+export interface AwardRegisteredResponseDto {
+    /**
+     * 공고 구매번호.
+     */
+    'bidNo': string;
+    /**
+     * 낙찰자 memberId.
+     */
+    'winnerMemberId': string;
+    /**
+     * 처리 상태.
+     */
+    'status': string;
+}
+