Merge pull request #339 from code-zero-to-one/feature/openapi-new

Feature/openapi new

Author: yeun38

src/api/openapi/.openapi-generator/FILES

@@ -194,7 +194,7 @@ docs/MatchingSystemStatusResponse.md
 docs/MatchingSystemStatusSchema.md
 docs/MemberAccountHistoryResponseDto.md
 docs/MemberApi.md
-docs/MemberCreationRequest.md
+docs/MemberCreationRequestDto.md
 docs/MemberCreationResponse.md
 docs/MemberCreationResponseContent.md
 docs/MemberFeature.md
@@ -480,7 +480,7 @@ models/matching-request-response.ts
 models/matching-system-status-response.ts
 models/matching-system-status-schema.ts
 models/member-account-history-response-dto.ts
-models/member-creation-request.ts
+models/member-creation-request-dto.ts
 models/member-creation-response-content.ts
 models/member-creation-response.ts
 models/member-feature.ts

src/api/openapi/api/member-api.ts

@@ -24,7 +24,7 @@ import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError
 // @ts-ignore
 import type { ErrorResponse } from '../models';
 // @ts-ignore
-import type { MemberCreationRequest } from '../models';
+import type { MemberCreationRequestDto } from '../models';
 // @ts-ignore
 import type { MemberCreationResponse } from '../models';
 // @ts-ignore
@@ -203,13 +203,13 @@ export const MemberApiAxiosParamCreator = function (configuration?: Configuratio
         /**
          * 회원가입을 진행하는 엔드포인트 - nickname: 필수, 2~20자 한글/영문/숫자, 특수문자 불가 (중복 체크 필수) - loginId: 선택(소셜 로그인 시 비움), 일반 로그인용 식별자 - jobs: 선택, Enum 리스트 (최대 5개) 값 = [IT_NOBASE_BUSINESS_STARTUP, IT_NOBASE_AUTOMATION, IT_NOBASE_MY_SERVICE, IT_PRACTITIONER_PM_PO_PLANNING, IT_PRACTITIONER_FRONTEND, IT_PRACTITIONER_BACKEND, IT_PRACTITIONER_AI_ML, IT_PRACTITIONER_IOS, IT_PRACTITIONER_ANDROID, IT_PRACTITIONER_DEVOPS, IT_PRACTITIONER_DATA_ANALYSIS, IT_PRACTITIONER_QA, IT_PRACTITIONER_GAME_DEV, IT_PRACTITIONER_DESIGN, IT_PRACTITIONER_MARKETING, IT_PRACTITIONER_ETC] - career: 선택, Enum 값 = [BEGINNER, JOB_SEEKER, JUNIOR, MIDDLE, SENIOR] - studyFormatTypes: 선택, Enum 값 = [PROJECT, MENTORING, SEMINAR, CHALLENGE, BOOK_LECTURE] - goal: 선택, 자유 텍스트 입력(최대 100자) - imageExtension: 선택, Enum 값 = [DEFAULT, JPG, PNG, GIF, WEBP, SVG, JPEG] 
          * @summary [회원가입/로그인 팝업] 회원가입
-         * @param {MemberCreationRequest} memberCreationRequest 
+         * @param {MemberCreationRequestDto} memberCreationRequestDto 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        signUp: async (memberCreationRequest: MemberCreationRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
-            // verify required parameter 'memberCreationRequest' is not null or undefined
-            assertParamExists('signUp', 'memberCreationRequest', memberCreationRequest)
+        signUp: async (memberCreationRequestDto: MemberCreationRequestDto, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'memberCreationRequestDto' is not null or undefined
+            assertParamExists('signUp', 'memberCreationRequestDto', memberCreationRequestDto)
             const localVarPath = `/api/v1/members`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -233,7 +233,7 @@ export const MemberApiAxiosParamCreator = function (configuration?: Configuratio
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
-            localVarRequestOptions.data = serializeDataIfNeeded(memberCreationRequest, localVarRequestOptions, configuration)
+            localVarRequestOptions.data = serializeDataIfNeeded(memberCreationRequestDto, localVarRequestOptions, configuration)
 
             return {
                 url: toPathString(localVarUrlObj),
@@ -300,12 +300,12 @@ export const MemberApiFp = function(configuration?: Configuration) {
         /**
          * 회원가입을 진행하는 엔드포인트 - nickname: 필수, 2~20자 한글/영문/숫자, 특수문자 불가 (중복 체크 필수) - loginId: 선택(소셜 로그인 시 비움), 일반 로그인용 식별자 - jobs: 선택, Enum 리스트 (최대 5개) 값 = [IT_NOBASE_BUSINESS_STARTUP, IT_NOBASE_AUTOMATION, IT_NOBASE_MY_SERVICE, IT_PRACTITIONER_PM_PO_PLANNING, IT_PRACTITIONER_FRONTEND, IT_PRACTITIONER_BACKEND, IT_PRACTITIONER_AI_ML, IT_PRACTITIONER_IOS, IT_PRACTITIONER_ANDROID, IT_PRACTITIONER_DEVOPS, IT_PRACTITIONER_DATA_ANALYSIS, IT_PRACTITIONER_QA, IT_PRACTITIONER_GAME_DEV, IT_PRACTITIONER_DESIGN, IT_PRACTITIONER_MARKETING, IT_PRACTITIONER_ETC] - career: 선택, Enum 값 = [BEGINNER, JOB_SEEKER, JUNIOR, MIDDLE, SENIOR] - studyFormatTypes: 선택, Enum 값 = [PROJECT, MENTORING, SEMINAR, CHALLENGE, BOOK_LECTURE] - goal: 선택, 자유 텍스트 입력(최대 100자) - imageExtension: 선택, Enum 값 = [DEFAULT, JPG, PNG, GIF, WEBP, SVG, JPEG] 
          * @summary [회원가입/로그인 팝업] 회원가입
-         * @param {MemberCreationRequest} memberCreationRequest 
+         * @param {MemberCreationRequestDto} memberCreationRequestDto 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async signUp(memberCreationRequest: MemberCreationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MemberCreationResponse>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.signUp(memberCreationRequest, options);
+        async signUp(memberCreationRequestDto: MemberCreationRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MemberCreationResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.signUp(memberCreationRequestDto, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['MemberApi.signUp']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -361,12 +361,12 @@ export const MemberApiFactory = function (configuration?: Configuration, basePat
         /**
          * 회원가입을 진행하는 엔드포인트 - nickname: 필수, 2~20자 한글/영문/숫자, 특수문자 불가 (중복 체크 필수) - loginId: 선택(소셜 로그인 시 비움), 일반 로그인용 식별자 - jobs: 선택, Enum 리스트 (최대 5개) 값 = [IT_NOBASE_BUSINESS_STARTUP, IT_NOBASE_AUTOMATION, IT_NOBASE_MY_SERVICE, IT_PRACTITIONER_PM_PO_PLANNING, IT_PRACTITIONER_FRONTEND, IT_PRACTITIONER_BACKEND, IT_PRACTITIONER_AI_ML, IT_PRACTITIONER_IOS, IT_PRACTITIONER_ANDROID, IT_PRACTITIONER_DEVOPS, IT_PRACTITIONER_DATA_ANALYSIS, IT_PRACTITIONER_QA, IT_PRACTITIONER_GAME_DEV, IT_PRACTITIONER_DESIGN, IT_PRACTITIONER_MARKETING, IT_PRACTITIONER_ETC] - career: 선택, Enum 값 = [BEGINNER, JOB_SEEKER, JUNIOR, MIDDLE, SENIOR] - studyFormatTypes: 선택, Enum 값 = [PROJECT, MENTORING, SEMINAR, CHALLENGE, BOOK_LECTURE] - goal: 선택, 자유 텍스트 입력(최대 100자) - imageExtension: 선택, Enum 값 = [DEFAULT, JPG, PNG, GIF, WEBP, SVG, JPEG] 
          * @summary [회원가입/로그인 팝업] 회원가입
-         * @param {MemberCreationRequest} memberCreationRequest 
+         * @param {MemberCreationRequestDto} memberCreationRequestDto 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        signUp(memberCreationRequest: MemberCreationRequest, options?: RawAxiosRequestConfig): AxiosPromise<MemberCreationResponse> {
-            return localVarFp.signUp(memberCreationRequest, options).then((request) => request(axios, basePath));
+        signUp(memberCreationRequestDto: MemberCreationRequestDto, options?: RawAxiosRequestConfig): AxiosPromise<MemberCreationResponse> {
+            return localVarFp.signUp(memberCreationRequestDto, options).then((request) => request(axios, basePath));
         },
     };
 };
@@ -420,12 +420,12 @@ export class MemberApi extends BaseAPI {
     /**
      * 회원가입을 진행하는 엔드포인트 - nickname: 필수, 2~20자 한글/영문/숫자, 특수문자 불가 (중복 체크 필수) - loginId: 선택(소셜 로그인 시 비움), 일반 로그인용 식별자 - jobs: 선택, Enum 리스트 (최대 5개) 값 = [IT_NOBASE_BUSINESS_STARTUP, IT_NOBASE_AUTOMATION, IT_NOBASE_MY_SERVICE, IT_PRACTITIONER_PM_PO_PLANNING, IT_PRACTITIONER_FRONTEND, IT_PRACTITIONER_BACKEND, IT_PRACTITIONER_AI_ML, IT_PRACTITIONER_IOS, IT_PRACTITIONER_ANDROID, IT_PRACTITIONER_DEVOPS, IT_PRACTITIONER_DATA_ANALYSIS, IT_PRACTITIONER_QA, IT_PRACTITIONER_GAME_DEV, IT_PRACTITIONER_DESIGN, IT_PRACTITIONER_MARKETING, IT_PRACTITIONER_ETC] - career: 선택, Enum 값 = [BEGINNER, JOB_SEEKER, JUNIOR, MIDDLE, SENIOR] - studyFormatTypes: 선택, Enum 값 = [PROJECT, MENTORING, SEMINAR, CHALLENGE, BOOK_LECTURE] - goal: 선택, 자유 텍스트 입력(최대 100자) - imageExtension: 선택, Enum 값 = [DEFAULT, JPG, PNG, GIF, WEBP, SVG, JPEG] 
      * @summary [회원가입/로그인 팝업] 회원가입
-     * @param {MemberCreationRequest} memberCreationRequest 
+     * @param {MemberCreationRequestDto} memberCreationRequestDto 
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    public signUp(memberCreationRequest: MemberCreationRequest, options?: RawAxiosRequestConfig) {
-        return MemberApiFp(this.configuration).signUp(memberCreationRequest, options).then((request) => request(this.axios, this.basePath));
+    public signUp(memberCreationRequestDto: MemberCreationRequestDto, options?: RawAxiosRequestConfig) {
+        return MemberApiFp(this.configuration).signUp(memberCreationRequestDto, options).then((request) => request(this.axios, this.basePath));
     }
 }
 

src/api/openapi/docs/MemberApi.md

@@ -194,7 +194,7 @@ const { status, data } = await apiInstance.getParticipatingStudies(
 [[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)
 
 # **signUp**
-> MemberCreationResponse signUp(memberCreationRequest)
+> MemberCreationResponse signUp(memberCreationRequestDto)
 
 회원가입을 진행하는 엔드포인트 - nickname: 필수, 2~20자 한글/영문/숫자, 특수문자 불가 (중복 체크 필수) - loginId: 선택(소셜 로그인 시 비움), 일반 로그인용 식별자 - jobs: 선택, Enum 리스트 (최대 5개) 값 = [IT_NOBASE_BUSINESS_STARTUP, IT_NOBASE_AUTOMATION, IT_NOBASE_MY_SERVICE, IT_PRACTITIONER_PM_PO_PLANNING, IT_PRACTITIONER_FRONTEND, IT_PRACTITIONER_BACKEND, IT_PRACTITIONER_AI_ML, IT_PRACTITIONER_IOS, IT_PRACTITIONER_ANDROID, IT_PRACTITIONER_DEVOPS, IT_PRACTITIONER_DATA_ANALYSIS, IT_PRACTITIONER_QA, IT_PRACTITIONER_GAME_DEV, IT_PRACTITIONER_DESIGN, IT_PRACTITIONER_MARKETING, IT_PRACTITIONER_ETC] - career: 선택, Enum 값 = [BEGINNER, JOB_SEEKER, JUNIOR, MIDDLE, SENIOR] - studyFormatTypes: 선택, Enum 값 = [PROJECT, MENTORING, SEMINAR, CHALLENGE, BOOK_LECTURE] - goal: 선택, 자유 텍스트 입력(최대 100자) - imageExtension: 선택, Enum 값 = [DEFAULT, JPG, PNG, GIF, WEBP, SVG, JPEG] 
 
@@ -204,24 +204,24 @@ const { status, data } = await apiInstance.getParticipatingStudies(
 import {
     MemberApi,
     Configuration,
-    MemberCreationRequest
+    MemberCreationRequestDto
 } from './api';
 
 const configuration = new Configuration();
 const apiInstance = new MemberApi(configuration);
 
-let memberCreationRequest: MemberCreationRequest; //
+let memberCreationRequestDto: MemberCreationRequestDto; //
 
 const { status, data } = await apiInstance.signUp(
-    memberCreationRequest
+    memberCreationRequestDto
 );
 ```
 
 ### Parameters
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **memberCreationRequest** | **MemberCreationRequest**|  | |
+| **memberCreationRequestDto** | **MemberCreationRequestDto**|  | |
 
 
 ### Return type

…pi/openapi/docs/MemberCreationRequest.md …openapi/docs/MemberCreationRequestDto.mdsrc/api/openapi/docs/MemberCreationRequest.md renamed to src/api/openapi/docs/MemberCreationRequestDto.md src/api/openapi/docs/MemberCreationRequest.md renamed to src/api/openapi/docs/MemberCreationRequestDto.md

@@ -1,4 +1,4 @@
-# MemberCreationRequest
+# MemberCreationRequestDto
 
 
 ## Properties
@@ -17,9 +17,9 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { MemberCreationRequest } from './api';
+import { MemberCreationRequestDto } from './api';
 
-const instance: MemberCreationRequest = {
+const instance: MemberCreationRequestDto = {
     loginId,
     nickname,
     name,

src/api/openapi/docs/TossWebhookPayload.md

@@ -8,8 +8,10 @@ Name | Type | Description | Notes
 **eventType** | **string** |  | [optional] [default to undefined]
 **createdAt** | **string** |  | [optional] [default to undefined]
 **data** | [**PaymentData**](PaymentData.md) |  | [optional] [default to undefined]
-**paymentStatusChanged** | **boolean** |  | [optional] [default to undefined]
+**paymentRelatedEvent** | **boolean** |  | [optional] [default to undefined]
 **latestCancel** | [**CancelData**](CancelData.md) |  | [optional] [default to undefined]
+**paymentStatusChanged** | **boolean** |  | [optional] [default to undefined]
+**depositCallback** | **boolean** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -20,8 +22,10 @@ const instance: TossWebhookPayload = {
     eventType,
     createdAt,
     data,
-    paymentStatusChanged,
+    paymentRelatedEvent,
     latestCancel,
+    paymentStatusChanged,
+    depositCallback,
 };
 ```
 

src/api/openapi/models/index.ts

@@ -129,7 +129,7 @@ export * from './matching-request-response';
 export * from './matching-system-status-response';
 export * from './matching-system-status-schema';
 export * from './member-account-history-response-dto';
-export * from './member-creation-request';
+export * from './member-creation-request-dto';
 export * from './member-creation-response';
 export * from './member-creation-response-content';
 export * from './member-feature';

…penapi/models/member-creation-request.ts …pi/models/member-creation-request-dto.tssrc/api/openapi/models/member-creation-request.ts renamed to src/api/openapi/models/member-creation-request-dto.ts src/api/openapi/models/member-creation-request.ts renamed to src/api/openapi/models/member-creation-request-dto.ts

@@ -14,7 +14,7 @@
 
 
 
-export interface MemberCreationRequest {
+export interface MemberCreationRequestDto {
     /**
      * 회원의 로그인 아이디(소셜 로그인 시 비어있음)
      */
@@ -30,26 +30,26 @@ export interface MemberCreationRequest {
     /**
      * 직무 리스트 (최대 5개) (예: [IT_PRACTITIONER_BACKEND, IT_PRACTITIONER_FRONTEND])
      */
-    'jobs'?: Array<MemberCreationRequestJobsEnum>;
+    'jobs'?: Array<MemberCreationRequestDtoJobsEnum>;
     /**
      * 경력 (예: JUNIOR)
      */
-    'career'?: MemberCreationRequestCareerEnum;
+    'career'?: MemberCreationRequestDtoCareerEnum;
     /**
      * 관심 스터디 유형 리스트 (예: [\"PROJECT\", \"SEMINAR\"])
      */
-    'studyFormatTypes'?: Array<MemberCreationRequestStudyFormatTypesEnum>;
+    'studyFormatTypes'?: Array<MemberCreationRequestDtoStudyFormatTypesEnum>;
     /**
      * 목표 및 다짐 (최대 100자)
      */
     'goal'?: string;
     /**
      * 이미지 확장자 - DEFAULT, JPG, PNG, GIF, WEBP, SVG, JPEG
      */
-    'imageExtension'?: MemberCreationRequestImageExtensionEnum;
+    'imageExtension'?: MemberCreationRequestDtoImageExtensionEnum;
 }
 
-export const MemberCreationRequestJobsEnum = {
+export const MemberCreationRequestDtoJobsEnum = {
     ItNobaseBusinessStartup: 'IT_NOBASE_BUSINESS_STARTUP',
     ItNobaseAutomation: 'IT_NOBASE_AUTOMATION',
     ItNobaseMyService: 'IT_NOBASE_MY_SERVICE',
@@ -68,26 +68,26 @@ export const MemberCreationRequestJobsEnum = {
     ItPractitionerEtc: 'IT_PRACTITIONER_ETC'
 } as const;
 
-export type MemberCreationRequestJobsEnum = typeof MemberCreationRequestJobsEnum[keyof typeof MemberCreationRequestJobsEnum];
-export const MemberCreationRequestCareerEnum = {
+export type MemberCreationRequestDtoJobsEnum = typeof MemberCreationRequestDtoJobsEnum[keyof typeof MemberCreationRequestDtoJobsEnum];
+export const MemberCreationRequestDtoCareerEnum = {
     Beginner: 'BEGINNER',
     JobSeeker: 'JOB_SEEKER',
     Junior: 'JUNIOR',
     Middle: 'MIDDLE',
     Senior: 'SENIOR'
 } as const;
 
-export type MemberCreationRequestCareerEnum = typeof MemberCreationRequestCareerEnum[keyof typeof MemberCreationRequestCareerEnum];
-export const MemberCreationRequestStudyFormatTypesEnum = {
+export type MemberCreationRequestDtoCareerEnum = typeof MemberCreationRequestDtoCareerEnum[keyof typeof MemberCreationRequestDtoCareerEnum];
+export const MemberCreationRequestDtoStudyFormatTypesEnum = {
     Project: 'PROJECT',
     Mentoring: 'MENTORING',
     Seminar: 'SEMINAR',
     Challenge: 'CHALLENGE',
     BookLecture: 'BOOK_LECTURE'
 } as const;
 
-export type MemberCreationRequestStudyFormatTypesEnum = typeof MemberCreationRequestStudyFormatTypesEnum[keyof typeof MemberCreationRequestStudyFormatTypesEnum];
-export const MemberCreationRequestImageExtensionEnum = {
+export type MemberCreationRequestDtoStudyFormatTypesEnum = typeof MemberCreationRequestDtoStudyFormatTypesEnum[keyof typeof MemberCreationRequestDtoStudyFormatTypesEnum];
+export const MemberCreationRequestDtoImageExtensionEnum = {
     Default: 'DEFAULT',
     Jpg: 'JPG',
     Png: 'PNG',
@@ -97,6 +97,6 @@ export const MemberCreationRequestImageExtensionEnum = {
     Jpeg: 'JPEG'
 } as const;
 
-export type MemberCreationRequestImageExtensionEnum = typeof MemberCreationRequestImageExtensionEnum[keyof typeof MemberCreationRequestImageExtensionEnum];
+export type MemberCreationRequestDtoImageExtensionEnum = typeof MemberCreationRequestDtoImageExtensionEnum[keyof typeof MemberCreationRequestDtoImageExtensionEnum];
 
 

src/api/openapi/models/toss-webhook-payload.ts

@@ -24,7 +24,9 @@ export interface TossWebhookPayload {
     'eventType'?: string;
     'createdAt'?: string;
     'data'?: PaymentData;
-    'paymentStatusChanged'?: boolean;
+    'paymentRelatedEvent'?: boolean;
     'latestCancel'?: CancelData;
+    'paymentStatusChanged'?: boolean;
+    'depositCallback'?: boolean;
 }