diff --git a/assets/input/bbs.swagger.json b/assets/input/bbs.swagger.json new file mode 100644 index 0000000..44c8604 --- /dev/null +++ b/assets/input/bbs.swagger.json @@ -0,0 +1,1634 @@ +{ + "openapi": "3.0.1", + "servers": [ + { + "url": "http://localhost:37001", + "description": "Local Server" + } + ], + "info": { + "version": "2.1.0", + "title": "@samchon/bbs-backend", + "description": "Backend for bbs", + "license": { + "name": "MIT" + } + }, + "paths": { + "/bbs/articles": { + "patch": { + "tags": [ + "BBS" + ], + "parameters": [], + "requestBody": { + "description": "Request info of pagination and searching options.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticle.IRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Paginated summarized articles.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IPageIBbsArticle.ISummary" + } + } + } + } + }, + "summary": "List up all summarized articles", + "description": "List up all summarized articles.\n\nList up all summarized articles with pagination and searching options." + }, + "post": { + "tags": [ + "BBS" + ], + "parameters": [], + "requestBody": { + "description": "Article information to create.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticle.ICreate" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Newly created article.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticle" + } + } + } + } + }, + "summary": "Create a new article", + "description": "Create a new article.\n\nCreate a new article with its first {@link IBbsArticle.ISnapshot snapshot}." + } + }, + "/bbs/articles/abridges": { + "patch": { + "tags": [ + "BBS" + ], + "parameters": [], + "requestBody": { + "description": "Request info of pagination and searching options.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticle.IRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Paginated abridged articles.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IPageIBbsArticle.IAbridge" + } + } + } + } + }, + "summary": "List up all abridged articles", + "description": "List up all abridged articles.\n\nList up all abridged articles with pagination and searching options." + } + }, + "/bbs/articles/{id}": { + "get": { + "tags": [ + "BBS" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "Target article's ", + "required": true + } + ], + "responses": { + "200": { + "description": "Article information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticle" + } + } + } + } + }, + "summary": "Read individual article", + "description": "Read individual article.\n\nReads an article with its every {@link IBbsArticle.ISnapshot snapshots}." + }, + "put": { + "tags": [ + "BBS" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "Target article's ", + "required": true + } + ], + "requestBody": { + "description": "Article information to update.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticle.IUpdate" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Newly accumulated snapshot information.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticle.ISnapshot" + } + } + } + } + }, + "summary": "Update an article", + "description": "Update an article.\n\nAccumulate a new {@link IBbsArticle.ISnapshot snapshot} record to the article." + }, + "delete": { + "tags": [ + "BBS" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "Target article's ", + "required": true + } + ], + "requestBody": { + "description": "Password of the article.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticle.IErase" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "" + } + }, + "summary": "Erase an article", + "description": "Erase an article.\n\nPerforms soft deletion to the article." + } + }, + "/bbs/articles/{articleId}/comments": { + "patch": { + "tags": [ + "BBS" + ], + "parameters": [ + { + "name": "articleId", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "", + "required": true + } + ], + "requestBody": { + "description": "Request info of pagination and searching options.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticleComment.IRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Paginated summarized comments.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IPageIBbsArticleComment" + } + } + } + } + }, + "summary": "List up all summarized comments", + "description": "List up all summarized comments.\n\nList up all summarized comments with pagination and searching options." + }, + "post": { + "tags": [ + "BBS" + ], + "parameters": [ + { + "name": "articleId", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "Belonged article's ", + "required": true + } + ], + "requestBody": { + "description": "Comment information to create.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticleComment.ICreate" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Newly created comment.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticleComment" + } + } + } + } + }, + "summary": "Create a new comment", + "description": "Create a new comment.\n\nCreate a new comment with its first {@link IBbsArticleComment.ISnapshot snapshot}." + } + }, + "/bbs/articles/{articleId}/comments/{id}": { + "get": { + "tags": [ + "BBS" + ], + "parameters": [ + { + "name": "articleId", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "Belonged article's ", + "required": true + }, + { + "name": "id", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "Target comment's ", + "required": true + } + ], + "responses": { + "200": { + "description": "Comment information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticleComment" + } + } + } + } + }, + "summary": "Read individual comment", + "description": "Read individual comment.\n\nReads a comment with its every {@link IBbsArticleComment.ISnapshot snapshots}." + }, + "put": { + "tags": [ + "BBS" + ], + "parameters": [ + { + "name": "articleId", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "Belonged article's ", + "required": true + }, + { + "name": "id", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "Target comment's ", + "required": true + } + ], + "requestBody": { + "description": "Comment information to update.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticleComment.IUpdate" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Newly accumulated snapshot information.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticleComment.ISnapshot" + } + } + } + } + }, + "summary": "Update a comment", + "description": "Update a comment.\n\nAccumulate a new {@link IBbsArticleComment.ISnapshot snapshot} record to the comment." + }, + "delete": { + "tags": [ + "BBS" + ], + "parameters": [ + { + "name": "articleId", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "Belonged article's ", + "required": true + }, + { + "name": "id", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "Target comment's ", + "required": true + } + ], + "requestBody": { + "description": "Password of the comment.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticleComment.IErase" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "" + } + }, + "summary": "Erase a comment", + "description": "Erase a comment.\n\nPerforms soft deletion to the comment." + } + }, + "/monitors/health": { + "get": { + "tags": [ + "Monitor" + ], + "parameters": [], + "responses": { + "200": { + "description": "" + } + }, + "summary": "Health check API", + "description": "Health check API." + } + }, + "/monitors/performance": { + "get": { + "tags": [ + "Monitor" + ], + "parameters": [], + "responses": { + "200": { + "description": "Performance info", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IPerformance" + } + } + } + } + }, + "summary": "Get performance information", + "description": "Get performance information.\n\nGet perofmration information composed with CPU, memory and resource usage." + } + }, + "/monitors/system": { + "get": { + "tags": [ + "Monitor" + ], + "parameters": [], + "responses": { + "200": { + "description": "System info", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ISystem" + } + } + } + } + }, + "summary": "Get system information", + "description": "Get system information.\n\nGet system information with commit and package information." + } + } + }, + "components": { + "schemas": { + "IBbsArticle.IRequest": { + "type": "object", + "properties": { + "search": { + "$ref": "#/components/schemas/IBbsArticle.IRequest.ISearch", + "title": "Search condition", + "description": "Search condition." + }, + "sort": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "-writer", + "-title", + "-created_at", + "-updated_at", + "+writer", + "+title", + "+created_at", + "+updated_at" + ] + }, + "title": "Sort condition", + "description": "Sort condition." + }, + "page": { + "type": "integer", + "title": "Page number", + "description": "Page number." + }, + "limit": { + "type": "integer", + "default": 100, + "title": "Limitation of records per a page", + "description": "Limitation of records per a page." + } + }, + "nullable": false + }, + "IBbsArticle.IRequest.ISearch": { + "type": "object", + "properties": { + "writer": { + "type": "string" + }, + "title": { + "type": "string" + }, + "body": { + "type": "string" + }, + "title_or_body": { + "type": "string" + }, + "from": { + "type": "string", + "format": "date-time" + }, + "to": { + "type": "string", + "format": "date-time" + } + }, + "nullable": false, + "description": "๊ฒ€์ƒ‰ ์ •๋ณด." + }, + "IPageIBbsArticle.ISummary": { + "type": "object", + "properties": { + "pagination": { + "$ref": "#/components/schemas/IPage.IPagination", + "title": "Page information", + "description": "Page information." + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IBbsArticle.ISummary" + }, + "title": "List of records", + "description": "List of records." + } + }, + "nullable": false, + "required": [ + "pagination", + "data" + ], + "description": "A page.\n\nCollection of records with pagination indformation." + }, + "IPage.IPagination": { + "type": "object", + "properties": { + "current": { + "type": "integer", + "title": "Current page number", + "description": "Current page number." + }, + "limit": { + "type": "integer", + "default": 100, + "title": "Limitation of records per a page", + "description": "Limitation of records per a page." + }, + "records": { + "type": "integer", + "title": "Total records in the database", + "description": "Total records in the database." + }, + "pages": { + "type": "integer", + "title": "Total pages", + "description": "Total pages.\n\nEqual to {@link records } / {@link limit } with ceiling." + } + }, + "nullable": false, + "required": [ + "current", + "limit", + "records", + "pages" + ], + "description": "Page information." + }, + "IBbsArticle.ISummary": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "title": "Primary Key", + "description": "Primary Key." + }, + "writer": { + "type": "string", + "title": "Writer of the article", + "description": "Writer of the article." + }, + "title": { + "type": "string", + "title": "Title of the last snapshot", + "description": "Title of the last snapshot." + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "Creation time of the article", + "description": "Creation time of the article." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "title": "Modification time of the article", + "description": "Modification time of the article.\n\nIn other words, the time when the last snapshot was created." + } + }, + "nullable": false, + "required": [ + "id", + "writer", + "title", + "created_at", + "updated_at" + ], + "description": "Summarized information of the article." + }, + "IPageIBbsArticle.IAbridge": { + "type": "object", + "properties": { + "pagination": { + "$ref": "#/components/schemas/IPage.IPagination", + "title": "Page information", + "description": "Page information." + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IBbsArticle.IAbridge" + }, + "title": "List of records", + "description": "List of records." + } + }, + "nullable": false, + "required": [ + "pagination", + "data" + ], + "description": "A page.\n\nCollection of records with pagination indformation." + }, + "IBbsArticle.IAbridge": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "title": "Primary Key", + "description": "Primary Key." + }, + "writer": { + "type": "string", + "title": "Writer of the article", + "description": "Writer of the article." + }, + "title": { + "type": "string", + "title": "Title of the last snapshot", + "description": "Title of the last snapshot." + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "Creation time of the article", + "description": "Creation time of the article." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "title": "Modification time of the article", + "description": "Modification time of the article.\n\nIn other words, the time when the last snapshot was created." + }, + "format": { + "$ref": "#/components/schemas/IBbsArticle.Format", + "title": "Format of body", + "description": "Format of body.\n\nSame meaning with extension like `html`, `md`, `txt`." + }, + "body": { + "type": "string", + "title": "Content body of article", + "description": "Content body of article." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAttachmentFile.ICreate" + }, + "title": "List of attachment files", + "description": "List of attachment files." + } + }, + "nullable": false, + "required": [ + "id", + "writer", + "title", + "created_at", + "updated_at", + "format", + "body", + "files" + ], + "description": "Abriged information of the article." + }, + "IBbsArticle.Format": { + "type": "string", + "enum": [ + "txt", + "md", + "html" + ] + }, + "IAttachmentFile.ICreate": { + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 255, + "title": "File name, except extension", + "description": "File name, except extension." + }, + "extension": { + "type": "string", + "maxLength": 8, + "minLength": 1, + "nullable": true, + "title": "Extension", + "description": "Extension.\n\nPossible to omit like `README` case." + }, + "url": { + "type": "string", + "format": "uri", + "contentMediaType": "application/octet-stream", + "title": "URL path of the real file", + "description": "URL path of the real file." + } + }, + "nullable": false, + "required": [ + "name", + "extension", + "url" + ] + }, + "IBbsArticle": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "title": "Primary Key", + "description": "Primary Key.", + "x-special-description": "Sommetimes made by database automatically." + }, + "writer": { + "type": "string", + "title": "Writer of article", + "description": "Writer of article." + }, + "snapshots": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IBbsArticle.ISnapshot" + }, + "minItems": 1, + "title": "List of snapshot contents", + "description": "List of snapshot contents.\n\nIt is created for the first time when an article is created, and is\naccumulated every time the article is modified." + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "Creation time of article", + "description": "Creation time of article." + } + }, + "nullable": false, + "required": [ + "id", + "writer", + "snapshots", + "created_at" + ], + "description": "Article entity.\n\n`IBbsArticle* is a super-type entity of all kinds of articles in the current\nbackend system, literally shaping individual articles of the bulletin board.\n\nAnd, as you can see, the elements that must inevitably exist in the article,\nsuch as the `title` or the `body`, do not exist in the `IBbsArticle`, but exist\nin the subsidiary entity, {@link IBbsArticle.ISnapshot }, as a 1: N relationship,\nwhich is because a new snapshot record is published every time the article is\nmodified.\n\nThe reason why a new snapshot record is published every time the article is\nmodified is to preserve the evidence. Due to the nature of e-community, there\nis always a threat of dispute among the participants. And it can happen that\ndisputes arise through articles or {@link IBbsArticleComment comments}, and to\nprevent such things as modifying existing articles to manipulate the situation,\nthe article is designed in this structure.\n\nIn other words, to keep evidence, and prevent fraud." + }, + "IBbsArticle.ISnapshot": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "title": "Primary Key", + "description": "Primary Key." + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "Creation time of snapshot record", + "description": "Creation time of snapshot record.\n\nIn other words, creation time or update time or article." + }, + "format": { + "$ref": "#/components/schemas/IBbsArticle.Format", + "title": "Format of body", + "description": "Format of body.\n\nSame meaning with extension like `html`, `md`, `txt`." + }, + "body": { + "type": "string", + "title": "Content body of article", + "description": "Content body of article." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAttachmentFile.ICreate" + }, + "title": "List of attachment files", + "description": "List of attachment files." + }, + "title": { + "type": "string", + "title": "Title of article", + "description": "Title of article." + } + }, + "nullable": false, + "required": [ + "id", + "created_at", + "format", + "body", + "files", + "title" + ], + "description": "Snapshot of article.\n\n`IBbsArticle.ISnapshot` is a snapshot entity that contains the contents of\nthe article, as mentioned in {@link IBbsArticle }, the contents of the article\nare separated from the article record to keep evidence and prevent fraud." + }, + "IBbsArticle.ICreate": { + "type": "object", + "properties": { + "writer": { + "type": "string" + }, + "format": { + "type": "string", + "enum": [ + "txt", + "md", + "html" + ], + "title": "Format of body", + "description": "Format of body.\n\nSame meaning with extension like `html`, `md`, `txt`." + }, + "title": { + "type": "string", + "title": "Title of article", + "description": "Title of article." + }, + "body": { + "type": "string", + "title": "Content body of article", + "description": "Content body of article." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAttachmentFile.ICreate" + }, + "title": "List of attachment files", + "description": "List of attachment files." + }, + "password": { + "type": "string", + "title": "Password for modification", + "description": "Password for modification." + } + }, + "nullable": false, + "required": [ + "writer", + "format", + "title", + "body", + "files", + "password" + ], + "description": "Store content type of the article." + }, + "IBbsArticle.IUpdate": { + "type": "object", + "properties": { + "format": { + "type": "string", + "enum": [ + "txt", + "md", + "html" + ], + "title": "Format of body", + "description": "Format of body.\n\nSame meaning with extension like `html`, `md`, `txt`." + }, + "title": { + "type": "string", + "title": "Title of article", + "description": "Title of article." + }, + "body": { + "type": "string", + "title": "Content body of article", + "description": "Content body of article." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAttachmentFile.ICreate" + }, + "title": "List of attachment files", + "description": "List of attachment files." + }, + "password": { + "type": "string", + "title": "Password for modification", + "description": "Password for modification." + } + }, + "nullable": false, + "required": [ + "format", + "title", + "body", + "files", + "password" + ] + }, + "IBbsArticle.IErase": { + "type": "object", + "properties": { + "password": { + "type": "string" + } + }, + "nullable": false, + "required": [ + "password" + ] + }, + "IBbsArticleComment.IRequest": { + "type": "object", + "properties": { + "search": { + "$ref": "#/components/schemas/IBbsArticleComment.IRequest.ISearch" + }, + "sort": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "-writer", + "-created_at", + "+writer", + "+created_at" + ] + } + }, + "page": { + "type": "integer", + "title": "Page number", + "description": "Page number." + }, + "limit": { + "type": "integer", + "default": 100, + "title": "Limitation of records per a page", + "description": "Limitation of records per a page." + } + }, + "nullable": false + }, + "IBbsArticleComment.IRequest.ISearch": { + "type": "object", + "properties": { + "writer": { + "type": "string" + }, + "body": { + "type": "string" + } + }, + "nullable": false + }, + "IPageIBbsArticleComment": { + "type": "object", + "properties": { + "pagination": { + "$ref": "#/components/schemas/IPage.IPagination", + "title": "Page information", + "description": "Page information." + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IBbsArticleComment" + }, + "title": "List of records", + "description": "List of records." + } + }, + "nullable": false, + "required": [ + "pagination", + "data" + ], + "description": "A page.\n\nCollection of records with pagination indformation." + }, + "IBbsArticleComment": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "title": "Primary Key", + "description": "Primary Key." + }, + "parent_id": { + "type": "string", + "format": "uuid", + "nullable": true, + "title": "Parent comment's ID", + "description": "Parent comment's ID." + }, + "writer": { + "type": "string", + "title": "Writer of comment", + "description": "Writer of comment." + }, + "snapshots": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IBbsArticleComment.ISnapshot" + }, + "minItems": 1, + "title": "List of snapshot contents", + "description": "List of snapshot contents.\n\nIt is created for the first time when a comment being created, and is\naccumulated every time the comment is modified." + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "Creation time of comment", + "description": "Creation time of comment." + } + }, + "nullable": false, + "required": [ + "id", + "parent_id", + "writer", + "snapshots", + "created_at" + ], + "description": "Comment written on an article.\n\n`IBbsArticleComment` is an entity that shapes the comments written on an article.\n\nAnd for this comment, as in the previous relationship between\n{@link IBbsArticle } and {@link IBbsArticle.ISnapshot }, the content body of the\ncomment is stored in the sub {@link IBbsArticleComment.ISnapshot } table for\nevidentialism, and a new snapshot record is issued every time the comment is modified.\n\nAlso, `IBbsArticleComment` is expressing the relationship of the hierarchical reply\nstructure through the {@link IBbsArticleComment.parent_id } attribute." + }, + "IBbsArticleComment.ISnapshot": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "title": "Primary Key", + "description": "Primary Key." + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "Creation time of snapshot record", + "description": "Creation time of snapshot record.\n\nIn other words, creation time or update time or comment." + }, + "format": { + "$ref": "#/components/schemas/IBbsArticleComment.Format", + "title": "Format of body", + "description": "Format of body.\n\nSame meaning with extension like `html`, `md`, `txt`." + }, + "body": { + "type": "string", + "title": "Content body of comment", + "description": "Content body of comment." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAttachmentFile.ICreate" + }, + "title": "List of attachment files", + "description": "List of attachment files." + } + }, + "nullable": false, + "required": [ + "id", + "created_at", + "format", + "body", + "files" + ], + "description": "Snapshot of comment.\n\n`IBbsArticleComment.ISnapshot` is a snapshot entity that contains\nthe contents of the comment.\n\nAs mentioned in {@link IBbsArticleComment }, designed to keep evidence\nand prevent fraud." + }, + "IBbsArticleComment.Format": { + "type": "string", + "enum": [ + "txt", + "md", + "html" + ] + }, + "IBbsArticleComment.ICreate": { + "type": "object", + "properties": { + "writer": { + "type": "string", + "title": "Writer of comment", + "description": "Writer of comment." + }, + "format": { + "type": "string", + "enum": [ + "txt", + "md", + "html" + ], + "title": "Format of body", + "description": "Format of body.\n\nSame meaning with extension like `html`, `md`, `txt`." + }, + "body": { + "type": "string", + "title": "Content body of comment", + "description": "Content body of comment." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAttachmentFile.ICreate" + }, + "title": "List of attachment files", + "description": "List of attachment files." + }, + "password": { + "type": "string", + "title": "Password for modification", + "description": "Password for modification." + } + }, + "nullable": false, + "required": [ + "writer", + "format", + "body", + "files", + "password" + ] + }, + "IBbsArticleComment.IUpdate": { + "type": "object", + "properties": { + "format": { + "type": "string", + "enum": [ + "txt", + "md", + "html" + ], + "title": "Format of body", + "description": "Format of body.\n\nSame meaning with extension like `html`, `md`, `txt`." + }, + "body": { + "type": "string", + "title": "Content body of comment", + "description": "Content body of comment." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAttachmentFile.ICreate" + }, + "title": "List of attachment files", + "description": "List of attachment files." + }, + "password": { + "type": "string", + "title": "Password for modification", + "description": "Password for modification." + } + }, + "nullable": false, + "required": [ + "format", + "body", + "files", + "password" + ] + }, + "IBbsArticleComment.IErase": { + "type": "object", + "properties": { + "password": { + "type": "string" + } + }, + "nullable": false, + "required": [ + "password" + ] + }, + "IPerformance": { + "type": "object", + "properties": { + "cpu": { + "$ref": "#/components/schemas/process.global.NodeJS.CpuUsage" + }, + "memory": { + "$ref": "#/components/schemas/process.global.NodeJS.MemoryUsage" + }, + "resource": { + "$ref": "#/components/schemas/process.global.NodeJS.ResourceUsage" + } + }, + "nullable": false, + "required": [ + "cpu", + "memory", + "resource" + ] + }, + "process.global.NodeJS.CpuUsage": { + "type": "object", + "properties": { + "user": { + "type": "number" + }, + "system": { + "type": "number" + } + }, + "nullable": false, + "required": [ + "user", + "system" + ] + }, + "process.global.NodeJS.MemoryUsage": { + "type": "object", + "properties": { + "rss": { + "type": "number" + }, + "heapTotal": { + "type": "number" + }, + "heapUsed": { + "type": "number" + }, + "external": { + "type": "number" + }, + "arrayBuffers": { + "type": "number" + } + }, + "nullable": false, + "required": [ + "rss", + "heapTotal", + "heapUsed", + "external", + "arrayBuffers" + ] + }, + "process.global.NodeJS.ResourceUsage": { + "type": "object", + "properties": { + "fsRead": { + "type": "number" + }, + "fsWrite": { + "type": "number" + }, + "involuntaryContextSwitches": { + "type": "number" + }, + "ipcReceived": { + "type": "number" + }, + "ipcSent": { + "type": "number" + }, + "majorPageFault": { + "type": "number" + }, + "maxRSS": { + "type": "number" + }, + "minorPageFault": { + "type": "number" + }, + "sharedMemorySize": { + "type": "number" + }, + "signalsCount": { + "type": "number" + }, + "swappedOut": { + "type": "number" + }, + "systemCPUTime": { + "type": "number" + }, + "unsharedDataSize": { + "type": "number" + }, + "unsharedStackSize": { + "type": "number" + }, + "userCPUTime": { + "type": "number" + }, + "voluntaryContextSwitches": { + "type": "number" + } + }, + "nullable": false, + "required": [ + "fsRead", + "fsWrite", + "involuntaryContextSwitches", + "ipcReceived", + "ipcSent", + "majorPageFault", + "maxRSS", + "minorPageFault", + "sharedMemorySize", + "signalsCount", + "swappedOut", + "systemCPUTime", + "unsharedDataSize", + "unsharedStackSize", + "userCPUTime", + "voluntaryContextSwitches" + ] + }, + "ISystem": { + "type": "object", + "properties": { + "uid": { + "type": "number", + "title": "Random Unique ID", + "description": "Random Unique ID." + }, + "arguments": { + "type": "array", + "items": { + "type": "string" + }, + "title": "`process", + "description": "`process.argv`" + }, + "commit": { + "$ref": "#/components/schemas/ISystem.ICommit", + "title": "Git commit info", + "description": "Git commit info." + }, + "package": { + "$ref": "#/components/schemas/ISystem.IPackage", + "title": "`package", + "description": "`package.json`" + }, + "created_at": { + "type": "string", + "title": "Creation time of this server", + "description": "Creation time of this server." + } + }, + "nullable": false, + "required": [ + "uid", + "arguments", + "commit", + "package", + "created_at" + ], + "description": "System Information." + }, + "ISystem.ICommit": { + "type": "object", + "properties": { + "shortHash": { + "type": "string" + }, + "branch": { + "type": "string" + }, + "hash": { + "type": "string" + }, + "subject": { + "type": "string" + }, + "sanitizedSubject": { + "type": "string" + }, + "body": { + "type": "string" + }, + "author": { + "$ref": "#/components/schemas/ISystem.ICommit.IUser" + }, + "committer": { + "$ref": "#/components/schemas/ISystem.ICommit.IUser" + }, + "authored_at": { + "type": "string" + }, + "commited_at": { + "type": "string" + }, + "notes": { + "type": "string" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "nullable": false, + "required": [ + "shortHash", + "branch", + "hash", + "subject", + "sanitizedSubject", + "body", + "author", + "committer", + "authored_at", + "commited_at", + "tags" + ], + "description": "Git commit info." + }, + "ISystem.ICommit.IUser": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + }, + "nullable": false, + "required": [ + "name", + "email" + ], + "description": "Git user account info." + }, + "ISystem.IPackage": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string" + }, + "description": { + "type": "string" + }, + "main": { + "type": "string" + }, + "typings": { + "type": "string" + }, + "scripts": { + "$ref": "#/components/schemas/Recordstringstring" + }, + "repository": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "git" + ] + }, + "url": { + "type": "string" + } + }, + "nullable": false, + "required": [ + "type", + "url" + ] + }, + "author": { + "type": "string" + }, + "license": { + "type": "string" + }, + "bugs": { + "type": "object", + "properties": { + "url": { + "type": "string" + } + }, + "nullable": false, + "required": [ + "url" + ] + }, + "homepage": { + "type": "string" + }, + "devDependencies": { + "$ref": "#/components/schemas/Recordstringstring" + }, + "dependencies": { + "$ref": "#/components/schemas/Recordstringstring" + }, + "publishConfig": { + "type": "object", + "properties": { + "registry": { + "type": "string" + } + }, + "nullable": false, + "required": [ + "registry" + ] + }, + "files": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "nullable": false, + "required": [ + "name", + "version", + "description", + "scripts", + "repository", + "author", + "license", + "bugs", + "homepage", + "dependencies" + ], + "description": "NPM package info." + }, + "Recordstringstring": { + "type": "object", + "properties": {}, + "nullable": false, + "description": "Construct a type with a set of properties K of type T" + } + } + } +} \ No newline at end of file diff --git a/assets/input/clickhouse.swagger.json b/assets/input/clickhouse.swagger.json new file mode 100644 index 0000000..fd9f990 --- /dev/null +++ b/assets/input/clickhouse.swagger.json @@ -0,0 +1,2581 @@ +{ + "openapi": "3.0.1", + "info": { + "title": "OpenAPI spec for ClickHouse Cloud", + "version": "1.0", + "contact": { + "name": "ClickHouse Support", + "url": "https://clickhouse.com/docs/en/cloud/manage/openapi?referrer=openapi-82913", + "email": "support@clickhouse.com" + } + }, + "servers": [ + { + "url": "https://api.clickhouse.cloud" + } + ], + "paths": { + "/v1/organizations": { + "get": { + "summary": "Get list of available organizations", + "description": "Returns a list with a single organization associated with the API key in the request.", + "parameters": [], + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Organization" + } + }, + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "Unique id assigned to every request. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "The server cannot or will not process the request due to something that is perceived to be a client error.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 400 + }, + "error": { + "type": "string", + "description": "Detailed error description." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId": { + "get": { + "summary": "Get organization details", + "description": "Returns details of a single organization. In order to get the details, the auth key must belong to the organization.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ID of the requested organization.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Organization" + }, + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "Unique id assigned to every request. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "The server cannot or will not process the request due to something that is perceived to be a client error.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 400 + }, + "error": { + "type": "string", + "description": "Detailed error description." + } + } + } + } + } + } + } + }, + "patch": { + "summary": "Update organization details", + "description": "Updates organization fields. Requires ADMIN auth key role.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ID of the organization to update.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrganizationPatchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Organization" + }, + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "Unique id assigned to every request. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "The server cannot or will not process the request due to something that is perceived to be a client error.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 400 + }, + "error": { + "type": "string", + "description": "Detailed error description." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/services": { + "get": { + "summary": "List of organization services", + "description": "Returns a list of all services in the organization.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ID of the requested organization.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Service" + } + }, + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "Unique id assigned to every request. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "The server cannot or will not process the request due to something that is perceived to be a client error.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 400 + }, + "error": { + "type": "string", + "description": "Detailed error description." + } + } + } + } + } + } + } + }, + "post": { + "summary": "Create new service", + "description": "Creates a new service in the organization, and returns the current service state and a password to access the service. The service is started asynchronously.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ID of the organization that will own the service.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServicePostRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/ServicePostResponse" + }, + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "Unique id assigned to every request. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "The server cannot or will not process the request due to something that is perceived to be a client error.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 400 + }, + "error": { + "type": "string", + "description": "Detailed error description." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/services/:serviceId": { + "get": { + "summary": "Get service details", + "description": "Returns a service that belongs to the organization", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ID of the organization that owns the service.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service ID", + "description": "ID of the requested service.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Service" + }, + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "Unique id assigned to every request. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "The server cannot or will not process the request due to something that is perceived to be a client error.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 400 + }, + "error": { + "type": "string", + "description": "Detailed error description." + } + } + } + } + } + } + } + }, + "patch": { + "summary": "Update service basic details.", + "description": "Updates basic service details like service name or IP access list.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ID of the organization that owns the service.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service ID", + "description": "ID of the service to update.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServicePatchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Service" + }, + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "Unique id assigned to every request. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "The server cannot or will not process the request due to something that is perceived to be a client error.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 400 + }, + "error": { + "type": "string", + "description": "Detailed error description." + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete service.", + "description": "Deletes the service. The service must be in stopped state and is deleted asynchronously after this method call.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ID of the organization that owns the service.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service ID", + "description": "ID of the service to delete.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ] + } + }, + "/v1/organizations/:organizationId/services/:serviceId/state": { + "patch": { + "summary": "Update service state.", + "description": "Starts or stop service", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ID of the organization that owns the service.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service ID", + "description": "ID of the service to update state.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServiceStatePatchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Service" + }, + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "Unique id assigned to every request. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "The server cannot or will not process the request due to something that is perceived to be a client error.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 400 + }, + "error": { + "type": "string", + "description": "Detailed error description." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/services/:serviceId/scaling": { + "patch": { + "summary": "Update service auto scaling settings.", + "description": "Updates minimum and maximum total memory limits and idle mode scaling behavior for the service. The memory settings are available only for \"production\" services and must be a multiple of 12 starting from 24GB.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ID of the organization that owns the service.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service ID", + "description": "ID of the service to update scaling parameters.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServiceScalingPatchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Service" + }, + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "Unique id assigned to every request. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "The server cannot or will not process the request due to something that is perceived to be a client error.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 400 + }, + "error": { + "type": "string", + "description": "Detailed error description." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/services/:serviceId/password": { + "patch": { + "summary": "Update service password.", + "description": "Sets a new password for the service", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ID of the organization that owns the service.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service ID", + "description": "ID of the service to update password.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServicePasswordPatchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/ServicePasswordPatchResponse" + }, + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "Unique id assigned to every request. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "The server cannot or will not process the request due to something that is perceived to be a client error.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 400 + }, + "error": { + "type": "string", + "description": "Detailed error description." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/services/:serviceId/backups": { + "get": { + "summary": "List of service backups", + "description": "Returns a list of all backups for the service.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ID of the organization that owns the backup.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service ID", + "description": "ID of the service the backup was created from.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Backup" + } + }, + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "Unique id assigned to every request. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "The server cannot or will not process the request due to something that is perceived to be a client error.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 400 + }, + "error": { + "type": "string", + "description": "Detailed error description." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/services/:serviceId/backups/:backupId": { + "get": { + "summary": "Get backup details", + "description": "Returns a single backup info.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ID of the organization that owns the backup.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service ID", + "description": "ID of the service the backup was created from.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service backup ID", + "description": "ID of the requested backup.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Backup" + }, + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "Unique id assigned to every request. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "The server cannot or will not process the request due to something that is perceived to be a client error.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 400 + }, + "error": { + "type": "string", + "description": "Detailed error description." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/keys": { + "get": { + "summary": "Get list of all keys", + "description": "Returns a list of all keys in the organization.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ID of the requested organization.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApiKey" + } + }, + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "Unique id assigned to every request. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "The server cannot or will not process the request due to something that is perceived to be a client error.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 400 + }, + "error": { + "type": "string", + "description": "Detailed error description." + } + } + } + } + } + } + } + }, + "post": { + "summary": "Create key", + "description": "Creates new API key.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ID of the organization that will own the key.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiKeyPostRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/ApiKeyPostResponse" + }, + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "Unique id assigned to every request. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "The server cannot or will not process the request due to something that is perceived to be a client error.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 400 + }, + "error": { + "type": "string", + "description": "Detailed error description." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/keys/:keyId": { + "get": { + "summary": "Get key details", + "description": "Returns a single key details.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ID of the requested organization.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "API key ID", + "description": "ID of the requested key.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/ApiKey" + }, + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "Unique id assigned to every request. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "The server cannot or will not process the request due to something that is perceived to be a client error.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 400 + }, + "error": { + "type": "string", + "description": "Detailed error description." + } + } + } + } + } + } + } + }, + "patch": { + "summary": "Update key", + "description": "Updates API key properties.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ID of the organization that owns the key.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "API key ID", + "description": "ID of the key to update.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiKeyPatchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/ApiKey" + }, + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "Unique id assigned to every request. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "The server cannot or will not process the request due to something that is perceived to be a client error.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 400 + }, + "error": { + "type": "string", + "description": "Detailed error description." + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete key", + "description": "Deletes API key. Only a key not used to authenticate the active request can be deleted.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ID of the organization that owns the key.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "API key ID", + "description": "ID of the key to delete.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ] + } + }, + "/v1/organizations/:organizationId/members": { + "get": { + "summary": "List organization members", + "description": "Returns a list of all members in the organization.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ID of the requested organization.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Member" + } + }, + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "Unique id assigned to every request. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "The server cannot or will not process the request due to something that is perceived to be a client error.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 400 + }, + "error": { + "type": "string", + "description": "Detailed error description." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/members/:userId": { + "get": { + "summary": "Get member details", + "description": "Returns a single organization member details.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ID of the organization the member is part of.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "User ID", + "description": "ID of the requested user.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Member" + }, + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "Unique id assigned to every request. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "The server cannot or will not process the request due to something that is perceived to be a client error.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 400 + }, + "error": { + "type": "string", + "description": "Detailed error description." + } + } + } + } + } + } + } + }, + "patch": { + "summary": "Update organization member.", + "description": "Updates organization member role.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ID of the organization the member is part of.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "User ID", + "description": "ID of the user to patch", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MemberPatchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Member" + }, + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "Unique id assigned to every request. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "The server cannot or will not process the request due to something that is perceived to be a client error.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 400 + }, + "error": { + "type": "string", + "description": "Detailed error description." + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Remove an organization member", + "description": "Removes a user from the organization", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ID of the requested organization.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "User ID", + "description": "ID of the requested user.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ] + } + }, + "/v1/organizations/:organizationId/invitations": { + "get": { + "summary": "List all invitations", + "description": "Returns list of all organization invitations.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ID of the requested organization.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Invitation" + } + }, + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "Unique id assigned to every request. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "The server cannot or will not process the request due to something that is perceived to be a client error.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 400 + }, + "error": { + "type": "string", + "description": "Detailed error description." + } + } + } + } + } + } + } + }, + "post": { + "summary": "Create an invitation", + "description": "Creates organization invitation.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ID of the organization to invite a user to.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InvitationPostRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Invitation" + }, + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "Unique id assigned to every request. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "The server cannot or will not process the request due to something that is perceived to be a client error.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 400 + }, + "error": { + "type": "string", + "description": "Detailed error description." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/invitations/:invitationId": { + "get": { + "summary": "Get invitation details", + "description": "Returns details for a single organization invitation.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ID of the requested organization.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Organization invitation ID", + "description": "ID of the requested organization.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Invitation" + }, + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "Unique id assigned to every request. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "The server cannot or will not process the request due to something that is perceived to be a client error.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 400 + }, + "error": { + "type": "string", + "description": "Detailed error description." + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete organization invitation", + "description": "Deletes a single organization invitation.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ID of the organization that has the invitation.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Organization invitation ID", + "description": "ID of the requested organization.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ] + } + }, + "/v1/organizations/:organizationId/activities": { + "get": { + "summary": "List of organization activities", + "description": "Returns a list of all organization activities.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ID of the requested organization.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Activity" + } + }, + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "Unique id assigned to every request. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "The server cannot or will not process the request due to something that is perceived to be a client error.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 400 + }, + "error": { + "type": "string", + "description": "Detailed error description." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/activities/:activityId": { + "get": { + "summary": "Organization activity", + "description": "Returns a single organization activity by ID.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ID of the requested organization.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Activity ID", + "description": "ID of the requested activity.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Activity" + }, + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "Unique id assigned to every request. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "The server cannot or will not process the request due to something that is perceived to be a client error.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP status code.", + "example": 400 + }, + "error": { + "type": "string", + "description": "Detailed error description." + } + } + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "ServiceEndpoint": { + "properties": { + "protocol": { + "type": "string", + "description": "Endpoint protocol: 'https', 'nativesecure', 'mysql'.", + "enum": [ + "https", + "nativesecure", + "mysql" + ] + }, + "host": { + "type": "string", + "description": "Service host name" + }, + "port": { + "type": "number", + "description": "Numeric port" + } + } + }, + "IpAccessListEntry": { + "properties": { + "source": { + "type": "string", + "description": "IP or CIDR" + }, + "description": { + "type": "string", + "description": "IPv4 address or IPv4 CIDR to allow access from" + } + } + }, + "Service": { + "properties": { + "id": { + "type": "string", + "description": "Unique service ID.", + "format": "uuid" + }, + "name": { + "type": "string", + "description": "Name of the service." + }, + "provider": { + "type": "string", + "description": "Cloud provider", + "enum": [ + "aws", + "gcp" + ] + }, + "region": { + "type": "string", + "description": "Service region.", + "enum": [ + "ap-south-1", + "ap-southeast-1", + "eu-central-1", + "eu-west-1", + "us-east-1", + "us-east-2", + "us-west-2", + "ap-southeast-2", + "us-east1", + "us-central1", + "europe-west4", + "asia-southeast1" + ] + }, + "state": { + "type": "string", + "description": "Current state of the service.", + "enum": [ + "starting", + "stopping", + "terminating", + "provisioning", + "running", + "stopped", + "terminated", + "degraded", + "failed", + "idle" + ] + }, + "endpoints": { + "type": "array", + "description": "List of all service endpoints.", + "items": { + "$ref": "#/components/schemas/ServiceEndpoint" + } + }, + "tier": { + "type": "string", + "description": "Tier of the service: 'development', 'production', 'dedicated_high_mem', 'dedicated_high_cpu', 'dedicated_standard'. Production services scale, Development are fixed size.", + "enum": [ + "development", + "production", + "dedicated_high_mem", + "dedicated_high_cpu", + "dedicated_standard" + ] + }, + "minTotalMemoryGb": { + "type": "number", + "description": "Minimum total memory of all workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and greater than 24.", + "minimum": 24, + "maximum": 720, + "multipleOf": 12, + "example": 48 + }, + "maxTotalMemoryGb": { + "type": "number", + "description": "Maximum total memory of all workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and lower than 360 for non paid services or 720 for paid services.", + "minimum": 24, + "maximum": 720, + "multipleOf": 12, + "example": 360 + }, + "idleScaling": { + "type": "boolean", + "description": "When set to true the service is allowed to scale down to zero when idle. Always true for development services." + }, + "idleTimeoutMinutes": { + "type": "number", + "description": "Set minimum idling timeout (in minutes). Must be >= 5 minutes." + }, + "ipAccessList": { + "type": "array", + "description": "List of IP addresses allowed to access the service", + "items": { + "$ref": "#/components/schemas/IpAccessListEntry" + } + }, + "createdAt": { + "type": "string", + "description": "Service creation timestamp. ISO-8601.", + "format": "date-time" + } + } + }, + "IpAccessListPatch": { + "properties": { + "add": { + "type": "array", + "description": "Elements to add. Executed after \"remove\" part is processed.", + "items": { + "$ref": "#/components/schemas/IpAccessListEntry" + } + }, + "remove": { + "type": "array", + "description": "Elements to remove. Executed before \"add\" part is processed.", + "items": { + "$ref": "#/components/schemas/IpAccessListEntry" + } + } + } + }, + "Activity": { + "properties": { + "id": { + "type": "string", + "description": "Unique activity ID." + }, + "createdAt": { + "type": "string", + "description": "Timestamp of the activity. ISO-8601.", + "format": "date-time" + }, + "type": { + "type": "string", + "description": "Type of the activity.", + "enum": [ + "organization_update_name", + "organization_invite_create", + "organization_invite_delete", + "organization_member_join", + "organization_member_add", + "organization_member_leave", + "organization_member_delete", + "organization_member_update_role", + "key_create", + "key_delete", + "service_create", + "service_start", + "service_stop", + "service_delete", + "service_update_name", + "service_update_ip_access_list", + "service_update_autoscaling_memory", + "service_update_autoscaling_idling", + "service_update_password", + "backup_delete" + ] + }, + "actorType": { + "type": "string", + "description": "Type of the actor: 'user', 'support', 'system', 'api'.", + "enum": [ + "user", + "support", + "system", + "api" + ] + }, + "actorId": { + "type": "string", + "description": "Unique actor ID." + }, + "actorDetails": { + "type": "string", + "description": "Additional information about the actor." + }, + "actorIpAddress": { + "type": "string", + "description": "IP address of the actor. Defined for 'user' and 'api' actor types." + }, + "organizationId": { + "type": "string", + "description": "Scope of the activity: organization ID this activity is related to." + }, + "serviceId": { + "type": "string", + "description": "Scope of the activity: service ID this activity is related to." + } + } + }, + "Backup": { + "properties": { + "id": { + "type": "string", + "description": "Unique backup ID.", + "format": "uuid" + }, + "status": { + "type": "string", + "description": "Status of the backup: 'done', 'error', 'in_progress'.", + "enum": [ + "done", + "error", + "in_progress" + ] + }, + "serviceId": { + "type": "string", + "description": "Name " + }, + "startedAt": { + "type": "string", + "description": "Backup start timestamp. ISO-8601.", + "format": "date-time" + }, + "finishedAt": { + "type": "string", + "description": "Backup finish timestamp. ISO-8601. Available only for finished backups", + "format": "date-time" + } + } + }, + "Organization": { + "properties": { + "id": { + "type": "string", + "description": "Unique organization ID.", + "format": "uuid" + }, + "createdAt": { + "type": "string", + "description": "The timestamp the organization was created. ISO-8601.", + "format": "date-time" + }, + "name": { + "type": "string", + "description": "Name of the organization." + } + } + }, + "Member": { + "properties": { + "userId": { + "type": "string", + "description": "Unique user ID. If a user is a member in multiple organizations this ID will stay the same." + }, + "name": { + "type": "string", + "description": "Name of the member as set a personal user profile." + }, + "email": { + "type": "string", + "description": "Email of the member as set in personal user profile.", + "format": "email" + }, + "role": { + "type": "string", + "description": "Role of the member in the organization.", + "enum": [ + "admin", + "developer" + ] + }, + "joinedAt": { + "type": "string", + "description": "Timestamp the member joined the organization. ISO-8601.", + "format": "date-time" + } + } + }, + "Invitation": { + "properties": { + "role": { + "type": "string", + "description": "Role of the member in the organization.", + "enum": [ + "admin", + "developer" + ] + }, + "id": { + "type": "string", + "description": "Unique invitation ID.", + "format": "uuid" + }, + "email": { + "type": "string", + "description": "Email of the invited user. Only a user with this email can join using the invitation. The email is stored in a lowercase form.", + "format": "email" + }, + "createdAt": { + "type": "string", + "description": "Invitation creation timestamp. ISO-8601.", + "format": "date-time" + }, + "expireAt": { + "type": "string", + "description": "Timestamp the invitation expires. ISO-8601.", + "format": "date-time" + } + } + }, + "ApiKey": { + "properties": { + "id": { + "type": "string", + "description": "Unique API key ID.", + "format": "uuid" + }, + "name": { + "type": "string", + "description": "Name of the key" + }, + "state": { + "type": "string", + "description": "State of the key: 'enabled', 'disabled'.", + "enum": [ + "enabled", + "disabled" + ] + }, + "roles": { + "type": "array", + "description": "List of roles assigned to the key. Contains at least 1 element.", + "items": { + "type": "string", + "enum": [ + "admin", + "developer" + ] + } + }, + "keySuffix": { + "type": "string", + "description": "Last 4 letters of the key." + }, + "createdAt": { + "type": "string", + "description": "Timestamp the key was created. ISO-8601.", + "format": "date-time" + }, + "expireAt": { + "type": "string", + "description": "Timestamp the key expires. If not present or is empty the key never expires. ISO-8601.", + "format": "date-time" + }, + "usedAt": { + "type": "string", + "description": "Timestamp the key was used last time. If not present the key was never used. ISO-8601.", + "format": "date-time" + } + } + }, + "ApiKeyHashData": { + "properties": { + "keyIdHash": { + "type": "string", + "description": "Hash of the key ID. " + }, + "keyIdSuffix": { + "type": "string", + "description": "Last 4 digits of the key ID. Algorithm: echo -n \"yourpassword\" | sha256sum | tr -d '-' | xxd -r -p | base64" + }, + "keySecretHash": { + "type": "string", + "description": "Hash of the key secret. Algorithm: echo -n \"yourpassword\" | sha256sum | tr -d '-' | xxd -r -p | base64" + } + } + }, + "OrganizationPatchRequest": { + "properties": { + "name": { + "type": "string", + "description": "Name of the organization." + } + } + }, + "ServicePostRequest": { + "properties": { + "name": { + "type": "string", + "description": "Name of the service." + }, + "provider": { + "type": "string", + "description": "Cloud provider", + "enum": [ + "aws", + "gcp" + ] + }, + "region": { + "type": "string", + "description": "Service region.", + "enum": [ + "ap-south-1", + "ap-southeast-1", + "eu-central-1", + "eu-west-1", + "us-east-1", + "us-east-2", + "us-west-2", + "ap-southeast-2", + "us-east1", + "us-central1", + "europe-west4", + "asia-southeast1" + ] + }, + "tier": { + "type": "string", + "description": "Tier of the service: 'development', 'production', 'dedicated_high_mem', 'dedicated_high_cpu', 'dedicated_standard'. Production services scale, Development are fixed size.", + "enum": [ + "development", + "production", + "dedicated_high_mem", + "dedicated_high_cpu", + "dedicated_standard" + ] + }, + "ipAccessList": { + "type": "array", + "description": "List of IP addresses allowed to access the service", + "items": { + "$ref": "#/components/schemas/IpAccessListEntry" + } + }, + "minTotalMemoryGb": { + "type": "number", + "description": "Minimum total memory of all workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and greater than 24.", + "minimum": 24, + "maximum": 720, + "multipleOf": 12, + "example": 48 + }, + "maxTotalMemoryGb": { + "type": "number", + "description": "Maximum total memory of all workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and lower than 360 for non paid services or 720 for paid services.", + "minimum": 24, + "maximum": 720, + "multipleOf": 12, + "example": 360 + }, + "idleScaling": { + "type": "boolean", + "description": "When set to true the service is allowed to scale down to zero when idle. Always true for development services." + }, + "idleTimeoutMinutes": { + "type": "number", + "description": "Set minimum idling timeout (in minutes). Must be >= 5 minutes." + }, + "backupId": { + "type": "string", + "description": "Optional backup ID used as an initial state for the new service. When used the region and the tier of the new instance must be the same as the values of the original instance.", + "format": "uuid" + } + } + }, + "ServicePostResponse": { + "properties": { + "service": { + "$ref": "#/components/schemas/Service" + }, + "password": { + "type": "string", + "description": "Password for the newly created service." + } + } + }, + "ServicePatchRequest": { + "properties": { + "name": { + "type": "string", + "description": "Name of the service." + }, + "ipAccessList": { + "$ref": "#/components/schemas/IpAccessListPatch" + } + } + }, + "ServiceStatePatchRequest": { + "properties": { + "command": { + "type": "string", + "description": "Command to change the state: 'start', 'stop'.", + "enum": [ + "start", + "stop" + ] + } + } + }, + "ServiceScalingPatchRequest": { + "properties": { + "minTotalMemoryGb": { + "type": "number", + "description": "Minimum total memory of all workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and greater than 24.", + "minimum": 24, + "maximum": 720, + "multipleOf": 12, + "example": 48 + }, + "maxTotalMemoryGb": { + "type": "number", + "description": "Maximum total memory of all workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and lower than 360 for non paid services or 720 for paid services.", + "minimum": 24, + "maximum": 720, + "multipleOf": 12, + "example": 360 + }, + "idleScaling": { + "type": "boolean", + "description": "When set to true the service is allowed to scale down to zero when idle. Always true for development services." + }, + "idleTimeoutMinutes": { + "type": "number", + "description": "Set minimum idling timeout (in minutes). Must be >= 5 minutes." + } + } + }, + "ServicePasswordPatchRequest": { + "properties": { + "newPasswordHash": { + "type": "string", + "description": "Optional password hash. Used to avoid password transmission over network. If not provided a new password is generated and is provided in the response. Otherwise this hash is used. Algorithm: echo -n \"yourpassword\" | sha256sum | tr -d '-' | xxd -r -p | base64" + }, + "newDoubleSha1Hash": { + "type": "string", + "description": "Optional double SHA1 password hash for MySQL protocol. If newPasswordHash is not provided this key will be ignored and the generated password will be used. To enable this field please contact support as it is experimental. Algorithm: echo -n \"yourpassword\" | sha1sum | tr -d '-' | xxd -r -p | sha1sum | tr -d '-'" + } + } + }, + "ServicePasswordPatchResponse": { + "properties": { + "password": { + "type": "string", + "description": "New service password. Provided only if there was no 'newPasswordHash' in the request" + } + } + }, + "ApiKeyPostRequest": { + "properties": { + "name": { + "type": "string", + "description": "Name of the key." + }, + "expireAt": { + "type": "string", + "description": "Timestamp the key expires. If not present or is empty the key never expires. ISO-8601.", + "format": "date-time" + }, + "state": { + "type": "string", + "description": "Initial state of the key: 'enabled', 'disabled'. If not provided the new key will be 'enabled'.", + "enum": [ + "enabled", + "disabled" + ] + }, + "hashData": { + "$ref": "#/components/schemas/ApiKeyHashData" + }, + "roles": { + "type": "array", + "description": "List of roles assigned to the key. Contains at least 1 element.", + "items": { + "type": "string", + "enum": [ + "admin", + "developer" + ] + } + } + } + }, + "ApiKeyPostResponse": { + "properties": { + "key": { + "$ref": "#/components/schemas/ApiKey" + }, + "keyId": { + "type": "string", + "description": "Generated key ID. Provided only if there was no 'hashData' in the request." + }, + "keySecret": { + "type": "string", + "description": "Generated key secret. Provided only if there was no 'hashData' in the request." + } + } + }, + "ApiKeyPatchRequest": { + "properties": { + "name": { + "type": "string", + "description": "Name of the key" + }, + "roles": { + "type": "array", + "description": "List of roles assigned to the key. Contains at least 1 element.", + "items": { + "type": "string", + "enum": [ + "admin", + "developer" + ] + } + }, + "expireAt": { + "type": "string", + "description": "Timestamp the key expires. If not present or is empty the key never expires. ISO-8601.", + "format": "date-time" + }, + "state": { + "type": "string", + "description": "State of the key: 'enabled', 'disabled'.", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "MemberPatchRequest": { + "properties": { + "role": { + "type": "string", + "description": "Role of the member in the organization.", + "enum": [ + "admin", + "developer" + ] + } + } + }, + "InvitationPostRequest": { + "properties": { + "email": { + "type": "string", + "description": "Email of the invited user. Only a user with this email can join using the invitation. The email is stored in a lowercase form.", + "format": "email" + }, + "role": { + "type": "string", + "description": "Role of the member in the organization.", + "enum": [ + "admin", + "developer" + ] + } + } + } + } + } + } \ No newline at end of file diff --git a/assets/input/damoa.swagger.json b/assets/input/damoa.swagger.json new file mode 100644 index 0000000..4028c00 --- /dev/null +++ b/assets/input/damoa.swagger.json @@ -0,0 +1,16679 @@ +{ + "openapi": "3.0.0", + "info": { + "title": "Damoa API Specification", + "description": "Damoa API Specification", + "version": "1.0.0" + }, + "servers": [ + { + "url": "https://api.queenit.kr", + "description": "production" + }, + { + "url": "https://api.dev.queenit.kr", + "description": "development" + }, + { + "url": "http://localhost:8080", + "description": "local" + }, + { + "url": "https://{namespace}-app-api.dev.rapportlabs.cloud", + "variables": { + "namespace": { + "default": "damoa" + } + } + } + ], + "tags": [ + { + "name": "metadata", + "description": "metadata api" + }, + { + "name": "verification", + "description": "verification api" + }, + { + "name": "hello", + "description": "hello api" + }, + { + "name": "favorite", + "description": "favorite api" + }, + { + "name": "best", + "description": "best api" + }, + { + "name": "product", + "description": "product api" + }, + { + "name": "ageGroup", + "description": "ageGroup api" + }, + { + "name": "home", + "description": "home api" + }, + { + "name": "newArrival", + "description": "new arrival api" + }, + { + "name": "hotDeal", + "description": "hot deal api" + }, + { + "name": "recommendation", + "description": "recommendation api" + }, + { + "name": "promotion", + "description": "promotion api" + }, + { + "name": "cart", + "description": "cart api" + }, + { + "name": "account", + "description": "account api" + }, + { + "name": "order", + "description": "order api" + }, + { + "name": "payment", + "description": "payment api" + }, + { + "name": "banner", + "description": "banner api" + }, + { + "name": "collection", + "description": "collection api" + }, + { + "name": "search", + "description": "search api" + }, + { + "name": "autocomplete", + "description": "autocomplete api" + }, + { + "name": "coupon", + "description": "coupon api" + }, + { + "name": "review", + "description": "review api" + }, + { + "name": "reviewStatistics", + "description": "reviewStatistics api" + }, + { + "name": "userProfile", + "description": "user profile api" + }, + { + "name": "image", + "description": "image api" + }, + { + "name": "prompt", + "description": "prompt api" + }, + { + "name": "shopLive", + "description": "shopLive api" + }, + { + "name": "point", + "description": "point api" + }, + { + "name": "productRanking", + "description": "productRanking api" + }, + { + "name": "tier", + "description": "tier api" + }, + { + "name": "styleShot", + "description": "style shot api" + }, + { + "name": "attendanceCheck", + "description": "attendance check api" + }, + { + "name": "tag", + "description": "tag api" + } + ], + "paths": { + "/metadata": { + "get": { + "description": "metadata api", + "operationId": "getMetadata", + "tags": [ + "metadata" + ], + "responses": { + "200": { + "description": "metadata response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MetadataDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/hello": { + "get": { + "summary": "hello world", + "operationId": "hello", + "tags": [ + "hello" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to hello", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/verifications/sms": { + "post": { + "summary": "send verification code by sms\n[ invalid phone number -> ApiErrorType.INVALID_VALUE]\n", + "operationId": "sendVerifCodeBySms", + "tags": [ + "verification" + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SendVerifCodeRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to send verification code", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SendVerifCodeResponseDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/verifications": { + "put": { + "summary": "verify code\n[invalid token or code -> ApiErrorType.INVALID_VALUE]\n", + "operationId": "verifyCode", + "tags": [ + "verification" + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VerifyCodeRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to verify code", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VerifyCodeResponseDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/verifications/kakao": { + "put": { + "summary": "verify kakao access token", + "operationId": "verifyKakaoToken", + "tags": [ + "verification" + ], + "description": "- ์นด์นด์˜ค ๋กœ๊ทธ์ธ์„ ํ†ตํ•ด ์ธ์ฆํ•œ ์‚ฌ์šฉ์ž์˜ ๊ฒฝ์šฐ ๋ฐœ๊ธ‰๋ฐ›์€ ์นด์นด์˜ค API access token ๊ณผ ์ „ํ™”๋ฒˆํ˜ธ๋ฅผ ์ด์šฉํ•˜์—ฌ verifiedToken์„ ์š”์ฒญ\n- ์ „ํ™”๋ฒˆํ˜ธ๋Š” ๊ตญ์ œ ์ „ํ™” ํ˜•์‹ (์˜ˆ : +82 10-1111-1111)\n- ๋ฐœ๊ธ‰๋ฐ›์€ verifiedToken ์„ ์ด์šฉํ•˜์—ฌ signUpV2 API ๋ฅผ ํ˜ธ์ถœํ•˜์—ฌ ๋กœ๊ทธ์ธ/ํšŒ์›๊ฐ€์ž… ์ง„ํ–‰\n", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VerifyKakaoTokenRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to verify", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VerifyKakaoTokenResponseDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/migrate-user": { + "post": { + "summary": "firebase auth user -> damoa auth user ์ „ํ™˜", + "description": "> ๊ธฐ์กด ๊ตฌ๋ฒ„์ „ ํด๋ผ์ด์–ธํŠธ์—์„œ firebase auth๋ฅผ ์‚ฌ์šฉํ•˜๋˜ ์œ ์ €๋ฅผ damoa auth๋ฅผ ์‚ฌ์šฉํ•˜๋„๋ก ์ „ํ™˜\n\nfirebase auth access token์„ ๋ฐ›์œผ๋ฉด, ํ•ด๋‹น ์‚ฌ์šฉ์ž ์ •๋ณด๋ฅผ damoa auth ์ชฝ์œผ๋กœ ์˜ฎ๊ฒจ์˜ค๊ณ , damoa auth์˜ access/refresh token์„ ์‚ฌ์šฉํ•˜๊ฒŒ๋” ์ •๋ณด๋ฅผ ๋‚ด๋ ค์ค€๋‹ค\n\n1. (ํด๋ผ์ด์–ธํŠธ) firebase auth ์ •๋ณด๊ฐ€ ์žˆ์œผ๋ฉด, ๊ธฐ์กด firebase auth token์„ ๋ฆฌํ”„๋ ˆ์‹œํ•œ๋‹ค\n2. (ํด๋ผ์ด์–ธํŠธ) firebase auth user -> damoa auth user๋กœ ์ „ํ™˜ํ•˜๊ธฐ ์œ„ํ•ด ์„œ๋ฒ„์ชฝ์— ์ •์˜๋œ ๋ณ„๋„์˜ endpoint๋ฅผ ํ˜ธ์ถœํ•œ๋‹ค (login required)\n3. (์„œ๋ฒ„) ํด๋ผ์ด์–ธํŠธ๊ฐ€ ๋ณด๋‚ด์ค€ access token ์ •๋ณด์—์„œ token vendor๋ฅผ ํ™•์ธํ•œ๋‹ค -> firebase์—์„œ ๋ฐœ๊ธ‰๋œ ๊ฒƒ์ธ์ง€, damoa์—์„œ ๋ฐœ๊ธ‰๋œ ๊ฒƒ์ธ์ง€ ํ™•์ธ\n4. (์„œ๋ฒ„) firebase์—์„œ ๋ฐœ๊ธ‰๋œ ํ† ํฐ์œผ๋กœ ํ™•์ธ๋˜๋ฉด -> access token์ด ์œ ํšจํ•œ์ง€ ํ•œ๋ฒˆ ๋” ๊ฒ€์‚ฌํ•œ๋‹ค\n5. (์„œ๋ฒ„) access token์ด ์œ ํšจํ•œ ๊ฒƒ์ด ํ™•์ธ๋˜๋ฉด -> firebase auth user ์ •๋ณด๋ฅผ damoa auth user ํ…Œ์ด๋ธ”์— ์ €์žฅํ•œ๋‹ค\n6. (์„œ๋ฒ„) damoa auth user ํ…Œ์ด๋ธ”์— firebase auth user ์ •๋ณด๋ฅผ ์ €์žฅํ•œ ํ›„์—, damoa auth token(access & refresh)์„ response๋กœ ๋ณด๋‚ด์ค€๋‹ค\n7. (ํด๋ผ์ด์–ธํŠธ) damoa auth token์„ ์‚ฌ์šฉํ•œ๋‹ค\n\n๋กœ๊ทธ์ธ๋œ ์ƒํƒœ์—์„œ(`Authorization` request header ์„ค์ •) request body์˜ access token์„ ์‹ค์–ด๋ณด๋‚ธ๋‹ค\n", + "operationId": "migrateUser", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FirebaseAuthUserMigrationRequest" + } + } + } + }, + "responses": { + "200": { + "description": "success to migrate user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DamoaTokenDto" + } + } + } + }, + "204": { + "description": "์ด๋ฏธ damoa auth user์ธ ๊ฒฝ์šฐ" + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/signin/anonymous": { + "post": { + "summary": "anonymous ์‚ฌ์šฉ์ž๋กœ ๋กœ๊ทธ์ธ", + "description": "anonymous ์‚ฌ์šฉ์ž๋กœ ๋กœ๊ทธ์ธ\n[invalid token -> ApiErrorType.INVALID_VALUE]\n", + "operationId": "signInAnonymously", + "tags": [ + "account" + ], + "responses": { + "200": { + "description": "success to signin anonymously", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DamoaTokenDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/signup/providers/{providerType}": { + "post": { + "summary": "์ธ์ฆ๋œ ์‚ฌ์šฉ์ž ๋กœ๊ทธ์ธ/๊ฐ€์ž…", + "description": "- ๊ธฐ์กด์— ๊ฐ€์ž…ํ–ˆ๋˜ ์‚ฌ์šฉ์ž๊ฐ€ ๋‹ค์‹œ ๋กœ๊ทธ์ธํ•˜๊ฑฐ๋‚˜ ์ƒˆ๋กญ๊ฒŒ ๊ฐ€์ž…ํ•˜๋Š” ๊ฒฝ์šฐ์— ํ˜ธ์ถœ๋จ\n- ํ˜„์žฌ `providerType`์œผ๋กœ `SMS` ๋ฐ `KAKAO` ์ง€์›\n - ๋‹ค๋ฅธ providerType์„ ์‚ฌ์šฉํ•˜๋ฉด ์—๋Ÿฌ ๋ฐœ์ƒ\n - ์ถ”ํ›„ ๋‹ค๋ฅธ auth provider(facebook, ..) ๋“ฑ์ด ์ถ”๊ฐ€๋  ์ˆ˜๋„ ์žˆ์Œ\n\n- request header์— ๋“ค์–ด๊ฐ€๋Š” authorization ์ •๋ณด์—๋Š” anonymous signup api ํ˜ธ์ถœ ์ดํ›„์— ๋ฐœ๊ธ‰๋ฐ›์€ access token์„ ๊ธฐ์ž…ํ•œ๋‹ค\n - `Bearer {{ anonymous access token }}` ํ˜•์‹\n - firebase auth๋ฅผ ํ†ตํ•ด ๋ฐœ๊ธ‰๋ฐ›์€ access token์€ ์‚ฌ์šฉํ•  ์ˆ˜ ์—†๋‹ค\n", + "operationId": "signUpV2", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "providerType", + "schema": { + "$ref": "#/components/schemas/ProviderTypeEnum" + }, + "required": true, + "description": "auth provider (SMS, KAKAO, ..)" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SignUpRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to signup", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DamoaTokenDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/refresh": { + "post": { + "summary": "์ธ์ฆ๋œ ์‚ฌ์šฉ์ž ํ˜น์€ anonymous ์‚ฌ์šฉ์ž์˜ access/refresh token ๊ฐฑ์‹ ", + "description": "์ธ์ฆ๋œ ์‚ฌ์šฉ์ž ํ˜น์€ anonymous ์‚ฌ์šฉ์ž์˜ access/refresh token ๊ฐฑ์‹ \n", + "operationId": "refreshToken", + "tags": [ + "account" + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DamoaTokenRefreshRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to refresh tokens", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DamoaTokenDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/accounts": { + "get": { + "summary": "์‚ฌ์šฉ์ž์˜ ๊ณ„์ • ์ •๋ณด๋ฅผ ์กฐํšŒํ•  ๊ฒฝ์šฐ์— ์‚ฌ์šฉํ•œ๋‹ค", + "description": "damoa auth๋ฅผ ์‚ฌ์šฉํ•˜๋Š” ์‚ฌ์šฉ์ž๋งŒ ์ •์ƒ์ ์œผ๋กœ ์ด์šฉํ•  ์ˆ˜ ์žˆ๋‹ค (anonymous ์‚ฌ์šฉ์ž ํฌํ•จ)", + "operationId": "getDamoaLoginAccount", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to retrieve account info", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LoginAccountDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/signout": { + "post": { + "summary": "signout", + "operationId": "signOut", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to signout" + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/logout": { + "post": { + "summary": "logout", + "operationId": "logout", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to logout" + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/external-uid": { + "get": { + "summary": "get external uid", + "description": "ํ•ด๋‹น user์˜ ์™ธ๋ถ€ API ํ˜ธ์ถœ์šฉ์œผ๋กœ ์‚ฌ์šฉ๋  ์ˆ˜ ์žˆ๋Š” external uid๋ฅผ ๋ฐ˜ํ™˜๋ฐ›์Šต๋‹ˆ๋‹ค.", + "operationId": "getExternalUid", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "external uid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExternalUidDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/payment-methods": { + "get": { + "summary": "get registered payment methods", + "description": "ํ•ด๋‹น user๊ฐ€ ํ€ธ์ž‡ํŽ˜์ด์— ๋“ฑ๋กํ•œ ๊ฒฐ์ œ ์ˆ˜๋‹จ ๋ชฉ๋ก์„ ๋ฐ˜ํ™˜๋ฐ›์Šต๋‹ˆ๋‹ค.", + "operationId": "getPaymentMethods", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "registered payment methods", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaymentMethodResponseDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/credentials/connect-pay": { + "get": { + "summary": "get connect pay credentials", + "description": "์ปค๋„ฅํŠธํŽ˜์ด JS SDK๋ฅผ ์‚ฌ์šฉํ•˜๊ธฐ ์œ„ํ•œ credential์„ ๋ฐ˜ํ™˜๋ฐ›์Šต๋‹ˆ๋‹ค.", + "operationId": "getConnectPayCredentials", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "connect pay clientKey and user specific customerKey", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectPayCredentialDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/favorites": { + "get": { + "summary": "get favorites", + "operationId": "getMyFavorites", + "tags": [ + "favorite" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "$ref": "#/components/parameters/queryCursor" + }, + { + "$ref": "#/components/parameters/querySize" + } + ], + "responses": { + "200": { + "description": "- my favorite product list\n- ํ€ธ์ž‡ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋˜๋Š” ๊ฒฝ์šฐ `FavoriteProductDto`์—์„œ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋œ ๊ธˆ์•ก์„ ๋ณด์—ฌ์ค€๋‹ค\n - ์˜ํ–ฅ ๋ฐ›๋Š” ํ•„๋“œ: `price`, `productDiscountRate`\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FavoriteProductListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/favorites/{productId}": { + "delete": { + "summary": "delete favorite", + "operationId": "deleteMyFavorite", + "tags": [ + "favorite" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "success to delete" + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + }, + "put": { + "summary": "add favorite", + "operationId": "addMyFavorite", + "tags": [ + "favorite" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "success to add" + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/best/products": { + "get": { + "summary": "get best products for recent specific period", + "operationId": "getBestAppProducts", + "tags": [ + "best" + ], + "parameters": [ + { + "$ref": "#/components/parameters/queryCursor" + }, + { + "$ref": "#/components/parameters/querySize" + }, + { + "in": "query", + "required": true, + "description": "best products for this period", + "name": "period", + "schema": { + "$ref": "#/components/schemas/BestPeriodEnum" + } + }, + { + "in": "query", + "required": false, + "name": "categoryId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "description": "์—ฐ๋ น๋Œ€ ์ฝ”๋“œ.", + "required": false, + "name": "ageGroupCode", + "schema": { + "$ref": "#/components/schemas/AgeGroupCodeEnum" + } + } + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- get best products for recent specific period\n- ํ€ธ์ž‡ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋˜๋Š” ๊ฒฝ์šฐ `AppProductDto`์—์„œ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋œ ๊ธˆ์•ก์„ ๋ณด์—ฌ์ค€๋‹ค\n - ์˜ํ–ฅ ๋ฐ›๋Š” ํ•„๋“œ: `finalPrice`, `discountPercentage`\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/best/brands/v2": { + "get": { + "summary": "get best brands for recent specific period", + "operationId": "getBestAppBrands", + "tags": [ + "best" + ], + "parameters": [ + { + "$ref": "#/components/parameters/queryCursor" + }, + { + "$ref": "#/components/parameters/querySize" + }, + { + "in": "query", + "required": true, + "description": "best brands for this period", + "name": "period", + "schema": { + "$ref": "#/components/schemas/BestPeriodEnum" + } + }, + { + "in": "query", + "description": "์—ฐ๋ น๋Œ€ ์ฝ”๋“œ.", + "required": false, + "name": "ageGroupCode", + "schema": { + "$ref": "#/components/schemas/AgeGroupCodeEnum" + } + } + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "get best brands for recent specific period", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BestBrandListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/best/WooRanking": { + "get": { + "summary": "get woo ranking products - DEPRECATED", + "operationId": "getWooRankingProducts", + "tags": [ + "best" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "$ref": "#/components/parameters/queryCursor" + }, + { + "$ref": "#/components/parameters/querySize" + } + ], + "responses": { + "200": { + "description": "woo ranking products - DEPRECATED", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/promotions/brands": { + "get": { + "summary": "get promotion brands", + "operationId": "getPromotedBrands", + "tags": [ + "promotion" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "promotion brands", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BrandListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/promotions/products": { + "get": { + "summary": "get promotion products", + "operationId": "getPromotionProducts", + "tags": [ + "promotion" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "$ref": "#/components/parameters/queryCursor" + }, + { + "$ref": "#/components/parameters/querySize" + } + ], + "responses": { + "200": { + "description": "- promotion products\n- ํ€ธ์ž‡ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋˜๋Š” ๊ฒฝ์šฐ `ProductDto`์—์„œ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋œ ๊ธˆ์•ก์„ ๋ณด์—ฌ์ค€๋‹ค\n - ์˜ํ–ฅ ๋ฐ›๋Š” ํ•„๋“œ: `finalPrice`, `discountPercentage`\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/promotions/connect-pay": { + "get": { + "summary": "get connect pay promotions", + "operationId": "getConnectPayPromotions", + "tags": [ + "promotion" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "connect-pay card discount promotions and interest-free installment policies", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectPayPromotionDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/promotions/toss": { + "get": { + "summary": "get toss payments promotions", + "operationId": "getTossPromotions", + "tags": [ + "promotion" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "toss card discount promotions policies and interest-free installment policies", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TossPaymentPromotionDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/newArrivals/products": { + "get": { + "summary": "get new arrival products - DEPRECATED", + "operationId": "getNewArrivalProducts", + "tags": [ + "newArrival" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "$ref": "#/components/parameters/queryCursor" + }, + { + "$ref": "#/components/parameters/querySize" + } + ], + "responses": { + "200": { + "description": "new products - DEPRECATED", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/promotions/products/discounted": { + "get": { + "deprecated": true, + "parameters": [ + { + "$ref": "#/components/parameters/queryCursor" + }, + { + "$ref": "#/components/parameters/querySize" + }, + { + "in": "query", + "description": "Please set orderBy to RECOMMENDATION as a default value.", + "name": "orderBy", + "required": true, + "schema": { + "$ref": "#/components/schemas/ProductOrderByEnum" + } + }, + { + "in": "query", + "required": false, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ], + "summary": "Get discounted promotion products by orderBy parameters", + "operationId": "getDiscountedPromotionProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- discounted promotion products by orderBy parameters\n- ํ€ธ์ž‡ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋˜๋Š” ๊ฒฝ์šฐ `AppProductDto`์—์„œ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋œ ๊ธˆ์•ก์„ ๋ณด์—ฌ์ค€๋‹ค\n - ์˜ํ–ฅ ๋ฐ›๋Š” ํ•„๋“œ: `finalPrice`, `discountPercentage`\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/products/{productId}/discount-benefits": { + "get": { + "summary": "get product's discount benefits information", + "operationId": "getProductDiscountBenefits", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "result of product's discount benefits information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductDiscountBenefitsDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/products/shopping-mall": { + "get": { + "deprecated": true, + "parameters": [ + { + "$ref": "#/components/parameters/queryCursor" + }, + { + "$ref": "#/components/parameters/querySize" + }, + { + "in": "query", + "description": "Please set orderBy to RECOMMENDATION as a default value.", + "name": "orderBy", + "required": true, + "schema": { + "$ref": "#/components/schemas/ProductOrderByEnum" + } + }, + { + "in": "query", + "required": false, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ], + "summary": "Get shopping mall products by orderBy parameters", + "operationId": "getShoppingMallProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- shopping mall products by orderBy parameters\n- ํ€ธ์ž‡ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋˜๋Š” ๊ฒฝ์šฐ `AppProductDto`์—์„œ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋œ ๊ธˆ์•ก์„ ๋ณด์—ฌ์ค€๋‹ค\n - ์˜ํ–ฅ ๋ฐ›๋Š” ํ•„๋“œ: `finalPrice`, `discountPercentage`\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/products/keyword-related": { + "get": { + "summary": "ํ‚ค์›Œ๋“œ์— ๋”ฐ๋ฅธ ์—ฐ๊ด€์ƒํ’ˆ๋“ค์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค.", + "operationId": "getKeywordRelatedProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "$ref": "#/components/parameters/queryCursor" + }, + { + "$ref": "#/components/parameters/querySize" + }, + { + "in": "query", + "name": "keyword", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "verbose", + "required": false, + "schema": { + "description": "๋””๋ฒ„๊น…์„ ์œ„ํ•œ ํŒŒ๋ผ๋ฏธํ„ฐ. ํ•ด๋‹น ๊ฐ’์ด true๋ฉด ๋กœ๊ทธ๋ฅผ ํ›จ์”ฌ ์ƒ์„ธํ•˜๊ฒŒ ์ฐ์Šต๋‹ˆ๋‹ค.", + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "ํ‚ค์›Œ๋“œ ์—ฐ๊ด€์ƒํ’ˆ ๊ฒฐ๊ณผ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/products/related": { + "get": { + "summary": "ํŠน์ • ์กฐ๊ฑด์— ๋”ฐ๋ฅธ ์—ฐ๊ด€์ƒํ’ˆ๋“ค์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค.", + "operationId": "getRelatedProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "$ref": "#/components/parameters/queryCursor" + }, + { + "$ref": "#/components/parameters/querySize" + }, + { + "in": "query", + "name": "brandId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "categoryId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "relationTargetProductIds", + "description": "์ด ํŒŒ๋ผ๋ฏธํ„ฐ์— ๋„˜๊ฒจ์ง„ ์ƒํ’ˆ๋“ค๊ณผ ์—ฐ๊ด€๋œ ์ƒํ’ˆ๋“ค์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค.", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "name": "verbose", + "required": false, + "schema": { + "description": "๋””๋ฒ„๊น…์„ ์œ„ํ•œ ํŒŒ๋ผ๋ฏธํ„ฐ. ํ•ด๋‹น ๊ฐ’์ด true๋ฉด ๋กœ๊ทธ๋ฅผ ํ›จ์”ฌ ์ƒ์„ธํ•˜๊ฒŒ ์ฐ์Šต๋‹ˆ๋‹ค.", + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "์—ฐ๊ด€์ƒํ’ˆ ๊ฒฐ๊ณผ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/personalized/products": { + "post": { + "deprecated": true, + "summary": "Get filtered personalized products", + "operationId": "getFilteredPersonalizedProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FilteredPersonalizedProductRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "- Get personalized products filtered by parameters\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + }, + "get": { + "parameters": [ + { + "$ref": "#/components/parameters/queryCursor" + }, + { + "$ref": "#/components/parameters/querySize" + }, + { + "in": "query", + "description": "Please set orderBy to RECOMMENDATION as a default value.", + "name": "orderBy", + "required": false, + "schema": { + "$ref": "#/components/schemas/ProductOrderByEnum" + } + }, + { + "in": "query", + "required": false, + "name": "categoryId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "required": false, + "name": "brandId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "description": "์—ฐ๋ น๋Œ€ ์ฝ”๋“œ.", + "required": false, + "name": "ageGroupCode", + "schema": { + "$ref": "#/components/schemas/AgeGroupCodeEnum" + } + }, + { + "in": "query", + "required": false, + "name": "minPrice", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "maxPrice", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "mySizeOnly", + "schema": { + "type": "boolean" + } + }, + { + "in": "query", + "required": false, + "name": "tagId", + "deprecated": true, + "schema": { + "type": "integer", + "description": "(deprecated) use tagIdForBrandSourcing", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "tagIdForBrandSourcing", + "schema": { + "description": "tagId์— ๋Œ€์‘๋˜๋Š” brandSourcingCode ๋“ค์— ๋Œ€ํ•ด ์ƒํ’ˆ์„ ์กฐํšŒํ•œ๋‹ค", + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "clickedProductIds", + "description": "- ํด๋ฆญํ•œ ์ƒํ’ˆ๋“ค. ๊ฐœ์ธํ™”๋œ ์ƒํ’ˆ ์ œ๊ณต์„ ์œ„ํ•ด ํ™œ์šฉ๋ฉ๋‹ˆ๋‹ค.\n- ๊ฐ ์ƒํ’ˆ์ด ํด๋ฆญ๋˜์—ˆ๋˜ ์‹œ๊ฐ„ ์ •๋ณด ์ „๋‹ฌ์„ ์œ„ํ•ด clickedProductAtMillis ํŒŒ๋ผ๋ฏธํ„ฐ๋ฅผ ํ•จ๊ป˜ ์ „๋‹ฌํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.\n", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "required": false, + "name": "clickedProductAtMillis", + "description": "- ์ƒํ’ˆ์„ ํด๋ฆญํ–ˆ๋˜ ์‹œ๊ฐ„๋“ค. ๊ฐ ์‹œ๊ฐ„์€ clickedProductIds ํŒŒ๋ผ๋ฏธํ„ฐ์— ๋Œ€์‘๋ฉ๋‹ˆ๋‹ค.\n- clickedProductIds์™€ clickedProductAtMillis ํŒŒ๋ผ๋ฏธํ„ฐ์˜ ํฌ๊ธฐ๋Š” ํ•ญ์ƒ ๊ฐ™์•„์•ผ ํ•ฉ๋‹ˆ๋‹ค.\n", + "schema": { + "type": "array", + "items": { + "type": "number", + "format": "int64" + } + } + }, + { + "in": "query", + "required": false, + "name": "modelId", + "description": "- ์–ด๋–ค ๊ฐœ์ธํ™” ๋ชจ๋ธ์„ ์‚ฌ์šฉํ•  ๊ฒƒ์ธ์ง€. (A/B Testing ์šฉ๋„)\n- ๋…ธ์…˜ ์ฐธ๊ณ : https://www.notion.so/rapportlabs/A-B-Protocol-c878d879ff0443cda929bb17d9b137c1\n", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "required": false, + "name": "postProcessingId", + "description": "- ๊ฐœ์ธํ™” ๊ฒฐ๊ณผ์˜ ํ›„์ฒ˜๋ฆฌ๋ฅผ ์–ด๋–ป๊ฒŒ ํ•  ๊ฒƒ์ธ๊ฐ€. (A/B Testing ์šฉ๋„)\n- ๋…ธ์…˜ ์ฐธ๊ณ : https://www.notion.so/rapportlabs/A-B-Protocol-c878d879ff0443cda929bb17d9b137c1\n", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "verbose", + "required": false, + "schema": { + "description": "๋””๋ฒ„๊น…์„ ์œ„ํ•œ ํŒŒ๋ผ๋ฏธํ„ฐ. ํ•ด๋‹น ๊ฐ’์ด true๋ฉด ๋กœ๊ทธ๋ฅผ ํ›จ์”ฌ ์ƒ์„ธํ•˜๊ฒŒ ์ฐ์Šต๋‹ˆ๋‹ค.", + "default": false, + "type": "boolean" + } + } + ], + "summary": "Get personalized recommendation products by filter", + "operationId": "getPersonalizedRecommendationProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- Get personalized recommendation products by filter and orderBy parameters\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/products/refined": { + "get": { + "parameters": [ + { + "$ref": "#/components/parameters/queryCursor" + }, + { + "$ref": "#/components/parameters/querySize" + }, + { + "in": "query", + "description": "Please set orderBy to RECOMMENDATION as a default value.", + "name": "orderBy", + "required": true, + "schema": { + "$ref": "#/components/schemas/ProductOrderByEnum" + } + }, + { + "in": "query", + "required": false, + "name": "categoryId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "required": false, + "name": "categoryIds", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "required": false, + "name": "brandId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "required": false, + "name": "brandIds", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "description": "์—ฐ๋ น๋Œ€ ์ฝ”๋“œ.", + "required": false, + "name": "ageGroupCode", + "schema": { + "$ref": "#/components/schemas/AgeGroupCodeEnum" + } + }, + { + "in": "query", + "required": false, + "name": "minPrice", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "maxPrice", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "mySizeOnly", + "schema": { + "type": "boolean" + } + }, + { + "in": "query", + "description": "ํ•„ํ„ฐ๋งํ•  ์ƒํ’ˆ ์†์„ฑ id ๋ชฉ๋ก", + "required": false, + "name": "productFeatureIds", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "deprecated": true, + "required": false, + "description": "(DEPRECATED) enabledTotalCount, enabledProductFeatureAggregation, enabledProductCategoryAggregation, enabledBrandAggregation ๋ฅผ ์‚ฌ์šฉํ•˜์„ธ์š”.", + "name": "enabledProductAggregation", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "์ƒํ’ˆ ์ง‘๊ณ„(aggregation)์—์„œ ์ „์ฒด ๊ฐœ์ˆ˜๊ฐ€ ํ•„์š”ํ•œ ๊ฒฝ์šฐ true๋กœ ์„ค์ •ํ•œ๋‹ค.", + "name": "enabledTotalCount", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "์ƒํ’ˆ ์ง‘๊ณ„(aggregation)์—์„œ ์ƒํ’ˆ ์†์„ฑ๋ณ„ ๊ฐœ์ˆ˜๊ฐ€ ํ•„์š”ํ•œ ๊ฒฝ์šฐ true๋กœ ์„ค์ •ํ•œ๋‹ค.", + "name": "enabledProductFeatureAggregation", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "์ƒํ’ˆ ์ง‘๊ณ„(aggregation)์—์„œ ์ƒํ’ˆ ์นดํ…Œ๊ณ ๋ฆฌ๋ณ„ ๊ฐœ์ˆ˜๊ฐ€ ํ•„์š”ํ•œ ๊ฒฝ์šฐ true๋กœ ์„ค์ •ํ•œ๋‹ค.", + "name": "enabledProductCategoryAggregation", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "์ƒํ’ˆ ์ง‘๊ณ„(aggregation)์—์„œ ๋ธŒ๋žœ๋“œ๋ณ„ ๊ฐœ์ˆ˜๊ฐ€ ํ•„์š”ํ•œ ๊ฒฝ์šฐ true๋กœ ์„ค์ •ํ•œ๋‹ค.", + "name": "enabledBrandAggregation", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "deprecated": true, + "description": "(deprecated) tagIdForBrandSourcing ํŒŒ๋ผ๋ฏธํ„ฐ๋ฅผ ์‚ฌ์šฉํ•˜์„ธ์š”", + "name": "tagId", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "tagIdForBrandSourcing", + "schema": { + "description": "tagId์— ๋Œ€์‘๋˜๋Š” brandSourcingCode ๋“ค์— ๋Œ€ํ•ด ์ƒํ’ˆ์„ ์กฐํšŒํ•œ๋‹ค", + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "description": "์ƒํ’ˆ ํƒœ๊ทธ ํ•„ํ„ฐ๋ฅผ ์œ„ํ•œ ids", + "name": "tagIdsForProductTag", + "schema": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + } + }, + { + "in": "query", + "required": false, + "description": "์ƒํ’ˆ ํƒœ๊ทธ๊ฐ€ ์—†๋Š” ์ƒํ’ˆ๋“ค๋„ ํ•จ๊ป˜ ๋…ธ์ถœ์‹œ์ผœ์ฃผ๊ธฐ ์œ„ํ•œ ํŒŒ๋ผ๋ฏธํ„ฐ", + "name": "allowProductsWithoutTags", + "schema": { + "type": "boolean" + } + } + ], + "summary": "Get refined products by filter and orderBy parameters", + "operationId": "getRefinedProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- Get refined products by filter and orderBy parameters\n- ํ€ธ์ž‡ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋˜๋Š” ๊ฒฝ์šฐ `AppProductDto`์—์„œ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋œ ๊ธˆ์•ก์„ ๋ณด์—ฌ์ค€๋‹ค\n - ์˜ํ–ฅ ๋ฐ›๋Š” ํ•„๋“œ: `finalPrice`, `discountPercentage`\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/products/advertisement": { + "get": { + "parameters": [ + { + "$ref": "#/components/parameters/queryPage" + }, + { + "$ref": "#/components/parameters/querySize" + }, + { + "in": "query", + "description": "Please set orderBy to RECOMMENDATION as a default value.", + "name": "orderBy", + "required": false, + "schema": { + "$ref": "#/components/schemas/ProductOrderByEnum" + } + }, + { + "in": "query", + "required": false, + "name": "categoryId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "required": false, + "name": "minPrice", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "maxPrice", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "mySizeOnly", + "schema": { + "type": "boolean" + } + } + ], + "summary": "Get advertisement products by filter and orderBy parameters", + "operationId": "getAdvertisementProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- Get advertisement products by filter and orderBy parameters\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAdvertisementProductListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/products/detail/advertisement": { + "get": { + "parameters": [ + { + "in": "query", + "required": false, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ], + "summary": "Get advertisement products by filter and orderBy parameters", + "operationId": "getAdvertisementProductDetail", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- Get advertisement products in PDP\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAdvertisementProductListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/products": { + "get": { + "parameters": [ + { + "in": "query", + "required": true, + "name": "ids", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "summary": "get products by ids parameter", + "description": "( count of ids is over 40 -> ApiErrorResponseCode.LIMITATION_EXCEEDED )", + "operationId": "getProducts", + "tags": [ + "product" + ], + "responses": { + "200": { + "description": "- products (unique and not ordered) by ids\n- ํ€ธ์ž‡ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋˜๋Š” ๊ฒฝ์šฐ `ProductDto`์—์„œ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋œ ๊ธˆ์•ก์„ ๋ณด์—ฌ์ค€๋‹ค\n - ์˜ํ–ฅ ๋ฐ›๋Š” ํ•„๋“œ: `finalPrice`, `discountPercentage`\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductSetDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/products/{productId}/similar/v2": { + "get": { + "summary": "get image based similar product (v2)", + "operationId": "getImageBasedSimilarProductsV2", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minRating", + "schema": { + "type": "number", + "format": "int32" + } + }, + { + "$ref": "#/components/parameters/queryCursor" + }, + { + "$ref": "#/components/parameters/querySize" + }, + { + "in": "query", + "name": "modelId", + "required": false, + "description": "์–ด๋–ค ๋ชจ๋ธ์„ ์‚ฌ์šฉํ• ๊ฑด์ง€. https://www.notion.so/rapportlabs/A-B-Protocol-c878d879ff0443cda929bb17d9b137c1?pvs=4", + "schema": { + "type": "string", + "default": "TAG_SIM" + } + }, + { + "in": "query", + "name": "postProcessingId", + "description": "ํ›„์ฒ˜๋ฆฌ๋ฅผ ์–ด๋–ป๊ฒŒ ํ•  ๊ฒƒ์ธ์ง€. https://www.notion.so/rapportlabs/A-B-Protocol-c878d879ff0443cda929bb17d9b137c1?pvs=4", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "verbose", + "required": false, + "schema": { + "description": "๋””๋ฒ„๊น…์„ ์œ„ํ•œ ํŒŒ๋ผ๋ฏธํ„ฐ. ํ•ด๋‹น ๊ฐ’์ด true๋ฉด ๋กœ๊ทธ๋ฅผ ํ›จ์”ฌ ์ƒ์„ธํ•˜๊ฒŒ ์ฐ์Šต๋‹ˆ๋‹ค.", + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "- ์ด๋ฏธ์ง€ ๊ธฐ๋ฐ˜ ์œ ์‚ฌ ์ƒํ’ˆ์„ ๋‚ด๋ ค์ค€๋‹ค. (v1๊ณผ ๋น„๊ตํ•ด๋ณด๊ณ  ๊ฒฐ๊ณผ์— ๋”ฐ๋ผ ํŠน์ • ๋ฒ„์ „ deprecated ์‹œํ‚ฌ ์˜ˆ์ •)\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/products/{productId}/similar": { + "get": { + "summary": "get image based similar product", + "operationId": "getImageBasedSimilarProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minRating", + "required": true, + "schema": { + "type": "number", + "format": "int32" + } + }, + { + "$ref": "#/components/parameters/queryCursor" + }, + { + "$ref": "#/components/parameters/querySize" + } + ], + "responses": { + "200": { + "description": "- ์ด๋ฏธ์ง€ ๊ธฐ๋ฐ˜ ์œ ์‚ฌ ์ƒํ’ˆ์„ ๋‚ด๋ ค์ค€๋‹ค.\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/products/{productId}/outfit": { + "get": { + "summary": "get image based outfit product", + "operationId": "getImageBasedOutfitProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minRating", + "required": true, + "schema": { + "type": "number", + "format": "int32" + } + }, + { + "$ref": "#/components/parameters/queryCursor" + }, + { + "$ref": "#/components/parameters/querySize" + } + ], + "responses": { + "200": { + "description": "- ์ด๋ฏธ์ง€ ๊ธฐ๋ฐ˜ ์ฝ”๋”” ์ƒํ’ˆ์„ ๋‚ด๋ ค์ค€๋‹ค.\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/hotDeals/products": { + "get": { + "summary": "get hotDeal products", + "operationId": "getHotDealProducts", + "tags": [ + "hotDeal" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "$ref": "#/components/parameters/queryCursor" + }, + { + "$ref": "#/components/parameters/querySize" + } + ], + "responses": { + "200": { + "description": "- hot deal products\n- ํ€ธ์ž‡ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋˜๋Š” ๊ฒฝ์šฐ `ProductDto`์—์„œ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋œ ๊ธˆ์•ก์„ ๋ณด์—ฌ์ค€๋‹ค\n - ์˜ํ–ฅ ๋ฐ›๋Š” ํ•„๋“œ: `finalPrice`, `discountPercentage`\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/recommendations/categories": { + "get": { + "summary": "get recommended product categories", + "operationId": "getRecommendationCategories", + "tags": [ + "recommendation" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "recommendation categories", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/recommendations/categories/{categoryId}/products": { + "get": { + "summary": "get recommended products", + "operationId": "getRecommendedProductsByCategory", + "tags": [ + "recommendation" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "$ref": "#/components/parameters/queryCursor" + }, + { + "$ref": "#/components/parameters/querySize" + } + ], + "responses": { + "200": { + "description": "- recommended products\n- ํ€ธ์ž‡ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋˜๋Š” ๊ฒฝ์šฐ `ProductDto`์—์„œ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋œ ๊ธˆ์•ก์„ ๋ณด์—ฌ์ค€๋‹ค\n - ์˜ํ–ฅ ๋ฐ›๋Š” ํ•„๋“œ: `finalPrice`, `discountPercentage`\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/recommendations/products": { + "get": { + "summary": "get recommended products", + "operationId": "getRecommendedProducts", + "tags": [ + "recommendation" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "$ref": "#/components/parameters/queryCursor" + }, + { + "$ref": "#/components/parameters/querySize" + } + ], + "responses": { + "200": { + "description": "- recommended products\n- ํ€ธ์ž‡ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋˜๋Š” ๊ฒฝ์šฐ `ProductDto`์—์„œ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋œ ๊ธˆ์•ก์„ ๋ณด์—ฌ์ค€๋‹ค\n - ์˜ํ–ฅ ๋ฐ›๋Š” ํ•„๋“œ: `finalPrice`, `discountPercentage`\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/tag-groups": { + "get": { + "parameters": [ + { + "in": "query", + "name": "type", + "required": true, + "schema": { + "$ref": "#/components/schemas/TagTypeEnum" + } + } + ], + "summary": "get tag-groups by type", + "description": "ํŒŒ๋ผ๋ฏธํ„ฐ์— ๋”ฐ๋ฅธ ํƒœ๊ทธ ๊ทธ๋ฃน ์ •๋ณด๋“ค์„ ๊ฐ€์ ธ์˜ต๋‹ˆ๋‹ค", + "operationId": "getTagGroups", + "tags": [ + "tag" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ํƒœ๊ทธ ๊ทธ๋ฃน ๋ชฉ๋ก", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagGroupListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/tags": { + "get": { + "parameters": [ + { + "in": "query", + "name": "type", + "required": false, + "schema": { + "$ref": "#/components/schemas/TagTypeEnum" + } + }, + { + "in": "query", + "name": "groupId", + "required": false, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "summary": "get tags", + "description": "tag ์ •๋ณด๋ฅผ ๊ฐ€์ ธ์˜ต๋‹ˆ๋‹ค.", + "operationId": "getTags", + "tags": [ + "tag" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "์กฐ๊ฑด์— ๋”ฐ๋ฅธ tag ์ •๋ณด๋ฅผ ๊ฐ€์ ธ์˜ต๋‹ˆ๋‹ค.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/products/{productId}/release-estimate": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product estimate release at", + "operationId": "getProductEstimateRelease", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product estimate release(์ƒํ’ˆ ์˜ˆ์ƒ ์ถœ๊ณ ์ผ) ์กฐํšŒ ์„ฑ๊ณต", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReleaseEstimateDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/products/{productId}/page": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "upload product page", + "operationId": "uploadProductPage", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UploadProductPageRequest" + } + } + } + }, + "responses": { + "200": { + "description": "success to upload" + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/products/{productId}": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product", + "operationId": "getProduct", + "description": "( can't find product -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- product\n- ํ€ธ์ž‡ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋˜๋Š” ๊ฒฝ์šฐ `ProductDto`์—์„œ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋œ ๊ธˆ์•ก์„ ๋ณด์—ฌ์ค€๋‹ค\n - ์˜ํ–ฅ ๋ฐ›๋Š” ํ•„๋“œ: `finalPrice`, `discountPercentage`\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/products/{productId}/personal": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get personal product", + "description": "( can't find product -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "getPersonalProduct", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- ํ€ธ์ž‡ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋˜๋Š” ๊ฒฝ์šฐ `ProductDto`์—์„œ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋œ ๊ธˆ์•ก์„ ๋ณด์—ฌ์ค€๋‹ค\n - ์˜ํ–ฅ ๋ฐ›๋Š” ํ•„๋“œ: `finalPrice`, `discountPercentage`\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PersonalProductDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/products/{productId}/items": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product items", + "operationId": "getProductItems", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product items(์ƒํ’ˆ ์˜ต์…˜) ๋ชฉ๋ก ์กฐํšŒ ์„ฑ๊ณต", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductItemListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/products/{productId}/item-availabilities": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product item availability list", + "description": "ํ•ด๋‹นํ•˜๋Š” ์ƒํ’ˆ์— ๋Œ€ํ•œ ์ƒํ’ˆ ์˜ต์…˜๋“ค์˜ ๊ตฌ๋งค ๊ฐ€๋Šฅ ์—ฌ๋ถ€ ๋ชฉ๋ก์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค", + "operationId": "getProductItemAvailabilityList", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "์ƒํ’ˆ ์˜ต์…˜๋“ค์˜ ๊ตฌ๋งค ๊ฐ€๋Šฅ ์—ฌ๋ถ€ ๋ชฉ๋ก", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductItemAvailabilityDto" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/users/birth-year": { + "post": { + "summary": "save of birth year for user", + "description": "save of birth year in user profile", + "operationId": "saveUserBirthYear", + "tags": [ + "userProfile" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserBirthYearDto" + } + } + } + }, + "responses": { + "200": { + "description": "saved birth year of user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserBirthYearDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/users/body-size": { + "post": { + "summary": "save of body size for user", + "description": "save of body size", + "operationId": "saveUserBodySize", + "tags": [ + "userProfile" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserBodySizeDataDto" + } + } + } + }, + "responses": { + "200": { + "description": "saved body size of user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserBodySizeDataDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/users/profile": { + "get": { + "summary": "get user profile", + "description": "( can't find user profile -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "getUserProfile", + "tags": [ + "userProfile" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "user profile", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserProfileDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/users/delivery-addresses": { + "get": { + "summary": "get user delivery addresses", + "description": "์‚ฌ์šฉ์ž์˜ ์ „์ฒด ๋ฐฐ์†ก์ง€ ๋ชฉ๋ก์„ ๊ฐ€์ ธ์˜ต๋‹ˆ๋‹ค (`retrievedAt` ์ˆœ์œผ๋กœ ์ •๋ ฌ๋˜์–ด ๋‚ด๋ ค๊ฐ‘๋‹ˆ๋‹ค)", + "operationId": "getUserDeliveryAddresses", + "tags": [ + "userProfile" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "user delivery address list", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserDeliveryAddressDto" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + }, + "put": { + "summary": "add user delivery address", + "description": "- ์‚ฌ์šฉ์ž์˜ ๋ฐฐ์†ก์ง€ ์ •๋ณด๋ฅผ ์ถ”๊ฐ€ํ•˜๊ฑฐ๋‚˜ `retrievedAt`์„ ์—…๋ฐ์ดํŠธํ•ฉ๋‹ˆ๋‹ค\n - ๊ธฐ๋“ฑ๋ก๋œ ๋ฐฐ์†ก์ง€ ๋ชฉ๋ก ์ค‘์—์„œ ์ฃผ์†Œ์™€ ๋ฐฐ์†ก ์š”์ฒญ์‚ฌํ•ญ์ด ๊ฐ™์€ ๊ฒฝ์šฐ์—๋งŒ ์—…๋ฐ์ดํŠธํ•ฉ๋‹ˆ๋‹ค\n", + "operationId": "addUserDeliveryAddress", + "tags": [ + "userProfile" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserDeliveryAddressAddRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to add user delivery address", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserDeliveryAddressDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/tier": { + "get": { + "summary": "get user's tier", + "operationId": "getTier", + "tags": [ + "tier" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "get user's tier", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TierDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/tier/next": { + "get": { + "summary": "get user's next tier information", + "operationId": "getNextTierInfo", + "tags": [ + "tier" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "get user's next tier information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NextTierInfoDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/images/{imageCategory}/uploadable-url": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "imageCategory", + "schema": { + "$ref": "#/components/schemas/ImageCategoryEnum" + } + }, + { + "in": "query", + "required": true, + "name": "filename", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "generate uploadable url to upload images for login user", + "operationId": "generateImageUploadableUrl", + "tags": [ + "image" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "uploadable image url", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UploadableImageResponseDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/images/{imageCategory}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "imageCategory", + "schema": { + "$ref": "#/components/schemas/ImageCategoryEnum" + } + } + ], + "post": { + "deprecated": true, + "description": "(deprecated) please use generateImageUploadableUrl instead of this api", + "summary": "upload images for login user", + "operationId": "uploadImage", + "tags": [ + "image" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "required": [ + "image" + ], + "properties": { + "image": { + "type": "string", + "format": "binary" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "upload image", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UploadImageResponseDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/images/{imageCategory}/base64": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "imageCategory", + "schema": { + "$ref": "#/components/schemas/ImageCategoryEnum" + } + } + ], + "post": { + "summary": "upload images as base 64 for login user", + "operationId": "uploadImageBase64", + "tags": [ + "image" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Base64ImageUploadRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "upload image as base64", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UploadImageResponseDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/products/{productId}/reviews": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product reviews", + "operationId": "getProductReviews", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "$ref": "#/components/parameters/queryCursor" + }, + { + "$ref": "#/components/parameters/querySize" + } + ], + "responses": { + "200": { + "description": "product reviews", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DisplayProductReviewListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/products/{productId}/reviews/v2": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product reviews v2", + "operationId": "findProductReviews", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "$ref": "#/components/parameters/queryPage" + }, + { + "$ref": "#/components/parameters/querySize" + }, + { + "in": "query", + "required": false, + "name": "sortOrder", + "schema": { + "$ref": "#/components/schemas/ProductReviewSortOrderEnum" + } + } + ], + "responses": { + "200": { + "description": "product reviews", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DisplayProductReviewListDtoV2" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/products/{productId}/reviews/representatives": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get representative product reviews", + "operationId": "getRepresentativeProductReviews", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "$ref": "#/components/parameters/queryCursor" + }, + { + "$ref": "#/components/parameters/querySize" + } + ], + "responses": { + "200": { + "description": "representative product reviews", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RepresentativeProductReviewListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/products/reviews/{reviewId}": { + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "put": { + "summary": "update product review", + "description": "๋ณธ์ธ์˜ ์ƒํ’ˆํ‰์„ ์ˆ˜์ •ํ•ฉ๋‹ˆ๋‹ค.\n- RESOURCE_NOT_FOUND: reviewId์— ํ•ด๋‹นํ•˜๋Š” ์ƒํ’ˆํ‰์„ ์ฐพ์„ ์ˆ˜ ์—†์„ ๋•Œ\n- ACCESS_DENIED: ํƒ€์ธ์˜ ์ƒํ’ˆํ‰์„ ์ˆ˜์ •ํ•˜๋ ค๊ณ  ํ•  ๋•Œ\n", + "operationId": "updateProductReview", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateProductReviewRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "updated product review", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReviewDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/products/items/{productItemId}/review": { + "parameters": [ + { + "in": "path", + "name": "productItemId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "orderLineId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "create product review", + "operationId": "createProductReview", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReviewDataDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to create product review", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReviewDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/reviews/{reviewId}": { + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "get": { + "summary": "get product review", + "operationId": "getProductReview", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product review", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DisplayProductReviewDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + }, + "delete": { + "summary": "delete product review", + "operationId": "deleteProductReview", + "description": "๋ณธ์ธ์˜ ์ƒํ’ˆํ‰์„ ์‚ญ์ œํ•ฉ๋‹ˆ๋‹ค.\n- RESOURCE_NOT_FOUND: reviewId์— ํ•ด๋‹นํ•˜๋Š” ์ƒํ’ˆํ‰์„ ์ฐพ์„ ์ˆ˜ ์—†์„ ๋•Œ\n- ACCESS_DENIED: ํƒ€์ธ์˜ ์ƒํ’ˆํ‰์„ ์ˆ˜์ •ํ•˜๋ ค๊ณ  ํ•  ๋•Œ\n", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to delete product review" + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/reviews/{reviewId}/favorites": { + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "post": { + "summary": "favorites product review", + "operationId": "favoritesProductReview", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "204": { + "description": "success to favorites product review" + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + }, + "delete": { + "summary": "delete favorites product review", + "operationId": "deleteFavoritesProductReview", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to delete favorites product review" + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/user/reviews": { + "get": { + "parameters": [ + { + "$ref": "#/components/parameters/queryCursor" + }, + { + "$ref": "#/components/parameters/querySize" + } + ], + "summary": "get created product reviews of user", + "operationId": "getMyProductReviews", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "created product reviews of user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MyProductReviewListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/user/review-candidates": { + "get": { + "parameters": [ + { + "$ref": "#/components/parameters/queryCursor" + }, + { + "$ref": "#/components/parameters/querySize" + } + ], + "summary": "get created product reviews of user", + "operationId": "getMyProductReviewCandidates", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product review candidates", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReviewCandidateListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/user/reviews/creatable-count": { + "get": { + "summary": "get count creatable product review of user", + "operationId": "countCreatableProductReviewOfUser", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "number of creatable product review of user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LongDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/user/reviews/created-count": { + "get": { + "summary": "get count created product review of user", + "operationId": "countCreatedProductReviewOfUser", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "number of created product review of user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LongDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/user/reviews/exist": { + "get": { + "summary": "check user's review exist", + "operationId": "checkExistProductReviewOfUser", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "flag of does user created review before", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RequiredBooleanDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/user/reviews/accumulable-point": { + "get": { + "summary": "get user's accumulable point amount of review creation", + "operationId": "getAccumulablePointProductReviewCreationOfUser", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "accumulable point amount of when user created total creatable review", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RequiredLongDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/products/{productId}/reviews/statistics/summary": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product review statistics summary", + "operationId": "getProductReviewStatisticsSummary", + "tags": [ + "reviewStatistics" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product review statistics summary", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReviewStatisticsSummaryDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/products/{productId}/reviews/statistics/size": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product review size statistics", + "operationId": "getProductSizeStatistics", + "tags": [ + "reviewStatistics" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product review size statistics", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductSizeStatisticsDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/products/{productId}/reviews/statistics/brightness": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product review brightness statistics", + "operationId": "getProductBrightnessStatistics", + "tags": [ + "reviewStatistics" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product review brightness statistics", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductBrightnessStatisticsDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/products/{productId}/reviews/statistics/color-sense": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product review color-sense statistics", + "operationId": "getProductColorSenseStatistics", + "tags": [ + "reviewStatistics" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product review color-sense statistics", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductColorSenseStatisticsDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/products/{productId}/reviews/statistics/thickness": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product review thickness statistics", + "operationId": "getProductThicknessStatistics", + "tags": [ + "reviewStatistics" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product review thickness statistics", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductThicknessStatisticsDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/categories/{categoryId}/attributes": { + "parameters": [ + { + "in": "path", + "name": "categoryId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get category's attributes", + "operationId": "getProductCategoryAttributes", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product category attributes", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductCategoryReviewAttributeDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/reviews/{reviewId}/reports": { + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "post": { + "summary": "report product review", + "description": "(can't report twice -> ApiErrorResponseCode.REVIEW_REPORTED_TWICE) (reporter uid and review uid can't be same -> ApiErrorResponseCode.REVIEW_REPORTED_BY_SELF)", + "operationId": "reportProductReview", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to report product review" + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/home/categories": { + "get": { + "summary": "get product categories in home screen", + "operationId": "getHomeProductCategories", + "tags": [ + "home" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product categories in home screen", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HomeProductCategoryDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/app/categories": { + "get": { + "summary": "get all categories with displaying products", + "operationId": "getDisplayingCategories", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "return all categories with displaying products", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/categories": { + "get": { + "summary": "get top product categories", + "operationId": "getTopProductCategories", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "query", + "required": false, + "name": "withAllCategory", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "product categories", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/categories/{categoryId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get inner product categories", + "operationId": "getInnerProductCategories", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "inner product categories", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/categories/{categoryId}/products": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get categorized products", + "operationId": "getCategorizedProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "$ref": "#/components/parameters/queryCursor" + }, + { + "$ref": "#/components/parameters/querySize" + } + ], + "responses": { + "200": { + "description": "- categorized products\n- ํ€ธ์ž‡ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋˜๋Š” ๊ฒฝ์šฐ `ProductDto`์—์„œ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋œ ๊ธˆ์•ก์„ ๋ณด์—ฌ์ค€๋‹ค\n - ์˜ํ–ฅ ๋ฐ›๋Š” ํ•„๋“œ: `finalPrice`, `discountPercentage`\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/age-group-filters": { + "get": { + "summary": "get all filters of age group.", + "operationId": "getAgeGroupFilters", + "tags": [ + "ageGroup" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "all age group filters", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AgeGroupFilterListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/brands": { + "get": { + "parameters": [ + { + "in": "query", + "required": false, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ], + "summary": "get all brands", + "operationId": "getAllBrands", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "brands", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BrandDto" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/brands/{brandId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "brandId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get brand detail", + "description": "( can't find brand -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "getBrandDetail", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "brand detail", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BrandDetailDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/brands/{brandId}/categories": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "brandId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get brand categories", + "operationId": "getBrandCategories", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "brand categories", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/brands/{brandId}/categories/{categoryId}/products": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "brandId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get categorized brand products", + "operationId": "getBrandProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "$ref": "#/components/parameters/queryCursor" + }, + { + "$ref": "#/components/parameters/querySize" + } + ], + "responses": { + "200": { + "description": "- categorized products\n- ํ€ธ์ž‡ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋˜๋Š” ๊ฒฝ์šฐ `ProductDto`์—์„œ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋œ ๊ธˆ์•ก์„ ๋ณด์—ฌ์ค€๋‹ค\n - ์˜ํ–ฅ ๋ฐ›๋Š” ํ•„๋“œ: `finalPrice`, `discountPercentage`\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/carts": { + "post": { + "summary": "add to cart", + "operationId": "addToCart", + "tags": [ + "cart" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AddToCartRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to add to cart", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AddToCartResponseDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + }, + "get": { + "summary": "get cart items", + "operationId": "getCartItems", + "tags": [ + "cart" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- cart items\n- ํ€ธ์ž‡ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋˜๋Š” ๊ฒฝ์šฐ `ProductDto`์—์„œ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋œ ๊ธˆ์•ก์„ ๋ณด์—ฌ์ค€๋‹ค\n - ์˜ํ–ฅ ๋ฐ›๋Š” ํ•„๋“œ: `finalPrice`, `discountPercentage`\n", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartItemGroupDto" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/carts/{cartItemId}": { + "delete": { + "summary": "delete cart item", + "operationId": "deleteCartItem", + "tags": [ + "cart" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "cartItemId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "success to delete cart item" + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/carts/delete": { + "post": { + "summary": "delete cart items", + "operationId": "deleteCartItems", + "tags": [ + "cart" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteCartItemsRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to delete cart items" + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/carts/rearrange": { + "post": { + "summary": "rearrange cart items for quantity constraint", + "operationId": "rearrangeCartItems", + "tags": [ + "cart" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- polished cart items\n- ํ€ธ์ž‡ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋˜๋Š” ๊ฒฝ์šฐ `ProductDto`์—์„œ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋œ ๊ธˆ์•ก์„ ๋ณด์—ฌ์ค€๋‹ค\n - ์˜ํ–ฅ ๋ฐ›๋Š” ํ•„๋“œ: `finalPrice`, `discountPercentage`\n", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartItemGroupDto" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/carts/{cartItemId}/quantity/{quantity}": { + "post": { + "summary": "update cart item quantity", + "operationId": "updateCartItemQuantity", + "tags": [ + "cart" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "cartItemId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "path", + "name": "quantity", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "success to update cart item quantity" + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/orders": { + "get": { + "summary": "get my order histories", + "operationId": "getMyOrders", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "$ref": "#/components/parameters/queryCursor" + }, + { + "$ref": "#/components/parameters/querySize" + } + ], + "responses": { + "200": { + "description": "order detail", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MyOrderHistoryListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + }, + "post": { + "summary": "start order for cart items", + "description": "( count of order line to order exceeds limit -> ApiErrorResponseCode.ORDER_LINE_COUNT_LIMIT_PER_ORDER_EXCEEDED )\n( order unavailable product item exists -> ApiErrorResponseCode.ORDER_UNAVAILABLE_PRODUCT_ITEM )\n", + "operationId": "startOrder", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StartOrderRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "product purchase material", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductPurchaseMaterialDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + }, + "put": { + "summary": "start order with adding cart items", + "description": "( count of order line to order exceeds limit -> ApiErrorResponseCode.ORDER_LINE_COUNT_LIMIT_PER_ORDER_EXCEEDED )\n( order unavailable product item exists -> ApiErrorResponseCode.ORDER_UNAVAILABLE_PRODUCT_ITEM )\n", + "operationId": "startOrderFromAdding", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StartOrderFromAddingRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "product purchase material", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductPurchaseMaterialDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/orders/wait-for-deposit/exist": { + "get": { + "summary": "whether exist order of waiting for deposit", + "operationId": "existOrdersOfWaitingForDeposit", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "whether exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BooleanDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/orders/{orderId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get order history", + "description": "( can't find order -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "getMyOrder", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "order detail", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MyOrderHistoryDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + }, + "delete": { + "summary": "abort order", + "description": "( can't find order -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "abortOrderById", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "query", + "required": false, + "name": "restoreCartItems", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "result order data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/orders/{orderId}/purchase-material": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get order purchase material", + "description": "refresh ๋‚˜ network ์œ ์‹ค์— ๋Œ€๋น„ํ•˜์—ฌ `๊ฒฐ์ œ ์™„๋ฃŒ ์ „ ์ฃผ๋ฌธ` ์˜ ๊ฒฐ์ œ ์ •๋ณด(`purchaseMaterial`)๋ฅผ ๋‹ค์‹œ ๊ฐ€์ ธ์˜ค๋Š” API", + "operationId": "getOrderPurchaseMaterial", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product purchase material", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductPurchaseMaterialDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/orders/{orderId}/lines/{orderLineId}/confirm-receipt": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "orderLineId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "confirm order line receipt", + "description": "- orderline์— ๋Œ€ํ•ด์„œ ๊ตฌ๋งคํ™•์ • ์ง„ํ–‰\n- ๋ฐฐ์†ก ์™„๋ฃŒ ์ƒํƒœ์—์„œ๋งŒ ํ™•์ • ๊ฐ€๋Šฅ\n- ๊ตฌ๋งคํ™•์ •์ด ๋œ orderline์€ ๊ตํ™˜/๋ฐ˜ํ’ˆ ๋ถˆ๊ฐ€๋Šฅ\n - app ๋‚ด์—์„œ ๋ฐ˜ํ’ˆ ์‹ ์ฒญํ•˜๋Š” ๊ฒƒ ๋ถˆ๊ฐ€๋Šฅ\n- ๋ฐœ์ƒ ๊ฐ€๋Šฅํ•œ ์—๋Ÿฌ\n - `TICKET_PROCESSING_IS_REQUIRED_TO_CONFIRM_RECEIPT (7001)`\n - `SUBMITTED` (์š”์ฒญ๋จ) / `CONFIRMED` (์Šน์ธ๋จ) ์ƒํƒœ์˜ OLC/OLR ํ‹ฐ์ผ“์ด ์กด์žฌํ•˜๋Š” ๊ฒฝ์šฐ -> ์•„์ง ์ฒ˜๋ฆฌ๋˜์ง€ ์•Š์€ OLC/OLR ํ‹ฐ์ผ“์ด ์กด์žฌํ•˜๋Š” ๊ฒฝ์šฐ\n - `CAN_ONLY_CONFIRM_RECEIPT_OF_PAID_ORDER_LINE (7002)`\n - ํ™˜๋ถˆ ์ฒ˜๋ฆฌ๋œ / ๊ฒฐ์ œ๋ฅผ ๋Œ€๊ธฐ์ค‘์ธ orderline์€ ๊ตฌ๋งค ํ™•์ •์ด ๋ถˆ๊ฐ€๋Šฅํ•จ\n - `CANNOT_CONFIRM_RECEIPT_WHEN_DELIVERY_NOT_COMPLETE (7003)`\n - ์•„์ง ๋ฐฐ์†ก ์™„๋ฃŒ์ƒํƒœ๊ฐ€ ์•„๋‹Œ orderline์€ ๊ตฌ๋งค ํ™•์ •์ด ๋ถˆ๊ฐ€๋Šฅํ•จ\n", + "operationId": "confirmOrderLineReceipt", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to confirm receipt" + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/orders/purchases/{purchaseId}/point": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "apply point", + "description": "( can't find order -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )\n( can't apply point -> ApiErrorResponseCode.POINT_NOT_CONSUMABLE )\n( lack of point -> ApiErrorResponseCode.LACK_OF_POINT )\n", + "operationId": "applyPointForOrder", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplyPointRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to save", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplyPointResponseDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/orders/purchases/{purchaseId}/coupons/v2": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "delete": { + "summary": "release coupon", + "description": "( can't find order -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "releaseCouponOfOrderV2", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to release", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReleaseCouponResponseDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + }, + "post": { + "summary": "apply coupon", + "description": "( can't find order, issued coupon -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )\n( can't apply coupon -> ApiErrorResponseCode.COUPON_NOT_CONSUMABLE )\n", + "operationId": "applyCouponToOrderV2", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplyCouponRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to save", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplyCouponResponseDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/orders/purchases/{purchaseId}/delivery": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "save delivery request", + "description": "( can't find order -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "saveDeliveryRequest", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeliveryRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to update delivery request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderSummaryDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/orders/{orderId}/delivery-request": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ], + "put": { + "summary": "update delivery request before delivery", + "description": "- ์ถœ๊ณ  ์ „ ์ฃผ๋ฌธ์˜ ๋ฐฐ์†ก์ง€๋ฅผ ๋ณ€๊ฒฝํ•ฉ๋‹ˆ๋‹ค\n- ๋ฐœ์ƒํ•  ์ˆ˜ ์žˆ๋Š” ์—๋Ÿฌ ์œ ํ˜•\n - `ApiErrorResponseCode.INVALID_VALUE`\n - ํ•ด๋‹น ์ฃผ๋ฌธ์— cancel/return ticket state๊ฐ€ `SUBMITTED`, `CONFIRMED` ์ƒํƒœ์ธ ํ‹ฐ์ผ“์ด ์กด์žฌํ•˜๋Š” ๊ฒฝ์šฐ\n - ๊ฒฐ์ œ๊ฐ€ ์™„๋ฃŒ๋˜์ง€ ์•Š์€ ์œ ๋ น ์ฃผ๋ฌธ์ธ ๊ฒฝ์šฐ\n - `ApiErrorResponseCode.RESOURCE_NOT_FOUND`\n - ์ฃผ๋ฌธ์ด ์กด์žฌํ•˜์ง€ ์•Š๋Š” ๊ฒฝ์šฐ\n - `ApiErrorResponseCode.ORDER_ALREADY_DISPATCHED`\n - ํ•ด๋‹นํ•˜๋Š” ์ฃผ๋ฌธ์˜ ๊ฐœ๋ณ„ ์ฃผ๋ฌธ๋“ค์˜ ๋ฐฐ์†ก์ƒํƒœ๊ฐ€ ๋ชจ๋‘ `WAIT`์ด ์•„๋‹Œ ๊ฒฝ์šฐ\n - `ApiErrorResponseCode.CANNOT_CHANGE_DELIVERY_AREA`\n - ๊ธฐ์กด ๋ฐฐ์†ก์ง€์™€ ๋‹ค๋ฅธ ๋ฐฐ์†ก์ง€์—ญ(ex. ๊ธฐ๋ณธ ๋ฐฐ์†ก์ง€ -> ๋„์„œ์‚ฐ๊ฐ„ ๋ฐฐ์†ก์ง€)์œผ๋กœ ๋ฐฐ์†ก์ง€๋ฅผ ๋ฐ”๊พธ๋ ค๊ณ  ์‹œ๋„ํ•œ ๊ฒฝ์šฐ\n", + "operationId": "updateDeliveryRequestBeforeDelivery", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeliveryRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to update delivery request" + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/orders/purchases/{purchaseId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get order history by purchase", + "description": "( can't find order -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "getMyOrderByPurchase", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "order detail", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + }, + "delete": { + "summary": "abort order", + "description": "( can't find order -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "abortOrder", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "query", + "required": false, + "name": "restoreCartItems", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "success to abort" + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + }, + "post": { + "summary": "complete order", + "description": "( can't find order -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "completeOrder", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to complete", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/order-line-tickets": { + "get": { + "summary": "get order line ticket history", + "operationId": "getOrderLineTickets", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "query", + "name": "ticket", + "schema": { + "$ref": "#/components/schemas/OrderLineTicketEnum" + } + }, + { + "$ref": "#/components/parameters/queryCursor" + }, + { + "$ref": "#/components/parameters/querySize" + } + ], + "responses": { + "200": { + "description": "list order line tickets (return or cancel)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MyOrderLineTicketListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/order-line-tickets/count/summary": { + "get": { + "summary": "์œ ์ €์˜ ์ง„ํ–‰์ค‘(๋˜๋Š” ์ตœ๊ทผ ์™„๋ฃŒ๋œ)์ธ ๋ฐ˜ํ’ˆ/์ทจ์†Œ ํ‹ฐ์ผ“๋“ค์„ ์ง‘๊ณ„ํ•ฉ๋‹ˆ๋‹ค.(My ํŽ˜์ด์ง€ ํ‘œ์‹œ์šฉ)", + "operationId": "getOrderLineTicketsCountSummary", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "count OL tickets. (return or cancel)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MyOLTicketsCountDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/prompts/creatable-review-prompt": { + "get": { + "summary": "get creatable review prompt with order line", + "operationId": "getCreatableReviewPrompt", + "tags": [ + "prompt" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "creatable review prompt", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreatableReviewPromptDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/refund-account": { + "get": { + "summary": "get user refund account", + "operationId": "getUserRefundAccount", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "refund account of user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserRefundAccountDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + }, + "post": { + "summary": "save refund account", + "operationId": "saveRefundAccount", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RefundAccountDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to save" + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/orders/{orderId}/lines/cancel": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ], + "put": { + "summary": "cancel order item", + "description": "- ๋ฐœ์ƒํ•  ์ˆ˜ ์žˆ๋Š” ์—๋Ÿฌ\n - `CANNOT_REQUEST_REFUND_AFTER_CONFIRM_RECEIPT (7004)`\n - ์ด๋ฏธ ๊ตฌ๋งคํ™•์ •์ด ์™„๋ฃŒ๋œ orderline์— ๋Œ€ํ•ด์„œ ์ทจ์†Œ ํ‹ฐ์ผ“ ์ƒ์„ฑ ์š”์ฒญ์„ ํ•˜๋Š” ๊ฒฝ์šฐ\n", + "operationId": "requestToCancelOrderItem", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OLCRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "order history with created cancel ticket", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/orders/{orderId}/lines/cancel/v2": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "estimate order item cancellation", + "operationId": "estimateOrderItemCancellationV2", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartialOrderItemDto" + } + } + } + } + }, + "responses": { + "200": { + "description": "estimation result", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OLCEstimationResultDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/orders/{orderId}/lines/cancel/{ticketId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "ticketId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get order item cancel ticket detail", + "operationId": "getOrderItemCancelTicket", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "cancel ticket response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderLineCancelTicketWithOrderDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + }, + "delete": { + "summary": "withdraw order item cancellation", + "operationId": "withdrawOrderItemCancelTicket", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "order history with withdrawn ticket", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/orders/{orderId}/lines/return": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ], + "put": { + "summary": "return order item", + "description": "- ๋ฐœ์ƒํ•  ์ˆ˜ ์žˆ๋Š” ์—๋Ÿฌ\n - `CANNOT_REQUEST_REFUND_AFTER_CONFIRM_RECEIPT (7004)`\n - ์ด๋ฏธ ๊ตฌ๋งคํ™•์ •์ด ์™„๋ฃŒ๋œ orderline์— ๋Œ€ํ•ด์„œ ๋ฐ˜ํ’ˆ ํ‹ฐ์ผ“ ์ƒ์„ฑ ์š”์ฒญ์„ ํ•˜๋Š” ๊ฒฝ์šฐ\n - `RESOURCE_NOT_FOUND (4)`\n - Can't not find order\n - `LIMITATION_EXCEEDED (5)`\n - imageUrls์˜ item์ด 3๊ฐœ ์ดˆ๊ณผ์ธ ๊ฒฝ์šฐ\n", + "operationId": "requestToReturnOrderItem", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OLRRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "order history with created return ticket", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/orders/{orderId}/lines/return/v2": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "estimate order item returning", + "operationId": "estimateOrderItemReturningV2", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OLREstimateRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "estimation result", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OLREstimationResultDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/orders/{orderId}/lines/return/{ticketId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "ticketId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get order item return ticket detail", + "operationId": "getOrderItemReturnTicket", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "return ticket response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderLineReturnTicketWithOrderDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + }, + "delete": { + "summary": "withdraw order item returning", + "operationId": "withdrawOrderItemReturnTicket", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "order history with withdrawn ticket", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/purchases/{topic}/{purchaseId}/payments/iamport": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "start iamport payment for specific purchase", + "description": "( can't find purchase -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "startIamportPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StartIamportPaymentRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "iamport payment material", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IamportPaymentMaterialDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/purchases/{topic}/{purchaseId}/payments/iamport/merchantIds/{merchantId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "finish iamport payment process", + "description": "( paid amount does not match -> ApiErrorResponseCode.PAYMENT_NOT_FULLY_PAID )", + "operationId": "finishIamportPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to process" + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + }, + "delete": { + "summary": "abandon iamport payment", + "description": "( can't find purchase -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "abandonIamportPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to process" + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/purchases/{topic}/{purchaseId}/payments/toss": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "start toss payment for specific purchase", + "description": "( can't find purchase -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "startTossPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StartTossPaymentRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "toss payment material", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TossPaymentMaterialDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/purchases/{topic}/{purchaseId}/payments/toss/merchantIds/{merchantId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "finish toss payment process", + "description": "( paid amount does not match -> ApiErrorResponseCode.PAYMENT_NOT_FULLY_PAID )", + "operationId": "finishTossPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to process" + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + }, + "delete": { + "summary": "abandon toss payment", + "description": "( can't find purchase -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "abandonTossPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to process" + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/purchases/{topic}/{purchaseId}/payments/connect-pay": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "start connect-pay payment for specific purchase", + "description": "( can't find purchase -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "startConnectPayPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StartConnectPayPaymentRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "connect-pay payment material", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectPayPaymentMaterialDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/purchases/{topic}/{purchaseId}/payments/connect-pay/merchantIds/{merchantId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "finish connect-pay payment process", + "description": "( paid amount does not match -> ApiErrorResponseCode.PAYMENT_NOT_FULLY_PAID )", + "operationId": "finishConnectPayPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to process" + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + }, + "delete": { + "summary": "abandon connect-pay payment", + "description": "( can't find purchase -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "abandonConnectPayPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to process" + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/purchases/{topic}/{purchaseId}/payments/dry": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "start dry-run payment for specific purchase", + "description": "( can't find purchase -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "startDryRunPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "dry run payment material", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DryRunPaymentMaterialDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/purchases/{topic}/{purchaseId}/payments/dry/merchantIds/{merchantId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "finish dry-run payment process", + "operationId": "finishDryRunPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to process" + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + }, + "delete": { + "summary": "abandon dry-run payment", + "description": "( can't find purchase -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "abandonDryRunPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to process" + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/purchases/{topic}/{purchaseId}/payments/free": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "start free payment for specific purchase", + "description": "( can't find purchase -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "startFreePayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to process" + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/banners/types/{bannerType}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "bannerType", + "schema": { + "$ref": "#/components/schemas/BannerTypeEnum" + } + } + ], + "get": { + "summary": "get banners", + "operationId": "getBanners", + "tags": [ + "banner" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "banner list", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BannerDto" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/banners/category/{categoryId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get banners for category", + "operationId": "getCategoryBanners", + "tags": [ + "banner" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "banner list", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BannerDto" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/banners/brand-promotion": { + "get": { + "summary": "get banners for brand-promotion", + "operationId": "getBrandPromotionBanners", + "parameters": [ + { + "in": "query", + "required": false, + "name": "brandSourcingTagIdOfPromotedChannelGroup", + "description": "๊ตฌ๋งค์ฑ„๋„๊ด€ ๊ทธ๋ฃน์— ํ•ด๋‹นํ•˜๋Š” ๋ธŒ๋žœ๋“œ ์†Œ์‹ฑ tag์˜ id", + "schema": { + "type": "string" + } + } + ], + "tags": [ + "banner" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "banner list", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BannerDto" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/banners/brand/{brandId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "brandId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get banner for brand", + "operationId": "getBrandBanners", + "tags": [ + "banner" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "banner list", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BannerDto" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/collections/{collectionId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "collectionId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get collection", + "description": "( can't find collection -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "getCollection", + "tags": [ + "collection" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- collection\n- ํ€ธ์ž‡ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋˜๋Š” ๊ฒฝ์šฐ `ProductDto`์—์„œ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋œ ๊ธˆ์•ก์„ ๋ณด์—ฌ์ค€๋‹ค\n - ์˜ํ–ฅ ๋ฐ›๋Š” ํ•„๋“œ: `finalPrice`, `discountPercentage`\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CollectionDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/search/products": { + "get": { + "summary": "search products", + "operationId": "searchProducts", + "tags": [ + "search" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "$ref": "#/components/parameters/queryCursor" + }, + { + "$ref": "#/components/parameters/querySize" + }, + { + "in": "query", + "name": "keyword", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "description": "If orderBy is not given, orderBy would be set MATCHING_SCORE_DESC as a default value.", + "name": "orderBy", + "required": false, + "schema": { + "$ref": "#/components/schemas/ProductSearchingOrderByEnum" + } + }, + { + "in": "query", + "name": "categoryId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "categoryIds", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "name": "brandId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "brandIds", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "required": false, + "name": "minPrice", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "maxPrice", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "description": "ํ•„ํ„ฐ๋งํ•  ์ƒํ’ˆ ์†์„ฑ id ๋ชฉ๋ก", + "required": false, + "name": "productFeatureIds", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "deprecated": true, + "required": false, + "description": "(DEPRECATED) enabledTotalCount, enabledProductFeatureAggreagtion, enabledProductCategoryAggregation, enabledBrandAggregation ๋ฅผ ์‚ฌ์šฉํ•˜์„ธ์š”.", + "name": "enabledProductAggregation", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "์ƒํ’ˆ ์ง‘๊ณ„(aggregation)์—์„œ ์ „์ฒด ๊ฐœ์ˆ˜๊ฐ€ ํ•„์š”ํ•œ ๊ฒฝ์šฐ true๋กœ ์„ค์ •ํ•œ๋‹ค.", + "name": "enabledTotalCount", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "์ƒํ’ˆ ์ง‘๊ณ„(aggregation)์—์„œ ์ƒํ’ˆ ์†์„ฑ๋ณ„ ๊ฐœ์ˆ˜๊ฐ€ ํ•„์š”ํ•œ ๊ฒฝ์šฐ true๋กœ ์„ค์ •ํ•œ๋‹ค.", + "name": "enabledProductFeatureAggregation", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "์ƒํ’ˆ ์ง‘๊ณ„(aggregation)์—์„œ ์ƒํ’ˆ ์นดํ…Œ๊ณ ๋ฆฌ๋ณ„ ๊ฐœ์ˆ˜๊ฐ€ ํ•„์š”ํ•œ ๊ฒฝ์šฐ true๋กœ ์„ค์ •ํ•œ๋‹ค.", + "name": "enabledProductCategoryAggregation", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "์ƒํ’ˆ ์ง‘๊ณ„(aggregation)์—์„œ ๋ธŒ๋žœ๋“œ๋ณ„ ๊ฐœ์ˆ˜๊ฐ€ ํ•„์š”ํ•œ ๊ฒฝ์šฐ true๋กœ ์„ค์ •ํ•œ๋‹ค.", + "name": "enabledBrandAggregation", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "๊ฒ€์ƒ‰๊ณผ ๊ด€๋ จ๋œ ํŠน์ • ํ”ผ์ณ๋ฅผ ์ ์šฉ์‹œ์— ์‹คํ—˜์„ ์œ„ํ•ด ํ•„์š”ํ•œ ํ•„๋“œ์ด๋‹ค.", + "name": "keywordSearchExperimentIds", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "- searched products\n- ํ€ธ์ž‡ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋˜๋Š” ๊ฒฝ์šฐ `AppProductDto`์—์„œ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋œ ๊ธˆ์•ก์„ ๋ณด์—ฌ์ค€๋‹ค\n - ์˜ํ–ฅ ๋ฐ›๋Š” ํ•„๋“œ: `finalPrice`, `discountPercentage`\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/autocomplete": { + "get": { + "summary": "get autocomplete candidates", + "operationId": "getAutocompleteCandidates", + "tags": [ + "autocomplete" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "query", + "name": "query", + "required": true, + "schema": { + "type": "string" + }, + "description": "autocomplete query" + }, + { + "in": "query", + "name": "brandSize", + "required": true, + "schema": { + "type": "integer", + "format": "int32", + "default": 0 + }, + "description": "required brand autocomplete candidate size" + } + ], + "responses": { + "200": { + "description": "get autocomplete list", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AutocompleteResponseDto" + } + } + } + } + } + } + }, + "/couponBooks/{couponBookCode}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "couponBookCode", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get coupon book", + "description": "( can't find coupon book -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "getCouponBook", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "coupon book", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CouponBookDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/couponBooks/{couponBookCode}/asset": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "couponBookCode", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get coupon book asset", + "description": "( can't find coupon book -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "getCouponBookAsset", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "coupon book asset", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CouponBookAssetDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/couponBooks/{couponBookCode}/coupons": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "couponBookCode", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "issue all coupons in coupon book", + "description": "( can't find coupon book -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )\n( there are no coupons could be issued -> ApiErrorResponseCode.COUPON_BOOK_ISSUABLES_NOT_EXIST )\n", + "operationId": "issueAllCouponsInCouponBook", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "issued coupons by coupon book", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IssuedCouponDto" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/coupons/displays/products/{productId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "productId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get coupons by display product", + "operationId": "listDisplayingCouponsForProduct", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "get coupons by display product", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCouponDto" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + }, + "post": { + "summary": "issue all coupons by display product", + "operationId": "issueAllDisplayingCoupons", + "description": "( there are no display coupons to issue -> ApiErrorResponseCode.DISPLAYING_COUPONS_ISSUABLE_NOT_EXIST )\n", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to issue", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IssuedCouponDto" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/coupons/displays/products/{productId}/v2": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "productId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get coupons by display product v2", + "operationId": "listDisplayingCouponsForProductV2", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "get coupons by display product v2", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppCouponListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/coupons/{couponCode}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "couponCode", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get coupon by coupon code", + "operationId": "getCouponByCode", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "coupon", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CouponDetailDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + }, + "post": { + "summary": "issue coupon", + "description": "( can't find coupon -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )\n( coupon is disabled -> ApiErrorResponseCode.COUPON_NOT_ENABLED )\n( before coupon issue begin date -> ApiErrorResponseCode.COUPON_ISSUE_BEFORE_BEGIN )\n( after coupon issue end date -> ApiErrorResponseCode.COUPON_ISSUE_AFTER_END )\n( exceed max coupon issue count -> ApiErrorResponseCode.COUPON_ISSUE_LIMIT_EXCEEDED )\n( exceed max coupon issue count per user -> ApiErrorResponseCode.COUPON_ISSUE_LIMIT_PER_USER_EXCEEDED )\n( not target to coupon issue -> ApiErrorResponseCode.COUPON_ISSUE_NOT_TARGET )\n", + "operationId": "issueCoupon", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to issue" + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/coupons": { + "get": { + "summary": "get my issued coupons", + "operationId": "getIssuedCoupons", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "issued coupons", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IssuedCouponDto" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/coupons/first-kakao-login/issuable": { + "get": { + "summary": "check current user can issue first kakao login coupon", + "operationId": "checkFirstKakaoLoginCouponIssueable", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "check first kakao login coupon is issuable with current user's phone number", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CheckFirstKakaoLoginCouponIssuableResponseDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/shop-live/authorize": { + "post": { + "summary": "generate shop live token with username", + "operationId": "generateShopLiveAccessToken", + "tags": [ + "shopLive" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShopLiveTokenRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to generate shop live token", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShopLiveTokenResponseDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/shop-live/campaigns/upcoming": { + "get": { + "parameters": [ + { + "in": "query", + "required": false, + "name": "includeOnAir", + "description": "ํ˜„์žฌ ์ง„ํ–‰์ค‘์ธ ๋ฐฉ์†ก ์ •๋ณด๊ฐ€ ์žˆ์„ ๊ฒฝ์šฐ ์ด ์บ ํŽ˜์ธ์˜ ์ •๋ณด๋ฅผ ๊ฐ€์ ธ์˜ฌ ์ง€ ์—ฌ๋ถ€. false์ธ ๊ฒฝ์šฐ ํ˜„์žฌ ์ดํ›„์˜ ์˜ˆ์ •๋œ ๋ฐฉ์†ก ์ •๋ณด๋งŒ ์กฐํšŒ", + "schema": { + "type": "boolean" + } + }, + { + "in": "query", + "required": false, + "name": "includePrivate", + "description": "๋ชจ์•„๋ณด๊ธฐ ๋น„๊ณต๊ฐœ๋กœ ์„ค์ •ํ•œ ์บ ํŽ˜์ธ์˜ ์ •๋ณด๋„ ์กฐํšŒํ•  ๊ฒƒ์ธ์ง€ ์—ฌ๋ถ€", + "schema": { + "type": "boolean" + } + } + ], + "summary": "ํ˜„์žฌ ์ดํ›„์˜ ๊ฐ€์žฅ ๊ฐ€๊นŒ์šด ์‹œ๊ฐ„์— ์˜ˆ์ •๋œ ๋ฐฉ์†ก ํ˜น์€ (์กฐ๊ฑด์— ๋”ฐ๋ผ) ํ˜„์žฌ ์ง„ํ–‰์ค‘ ๋ฐฉ์†ก์ด ์žˆ์„ ๊ฒฝ์šฐ ํ•ด๋‹น ๋ฐฉ์†ก์˜ ์ •๋ณด๋ฅผ ๋ฐ˜ํ™˜", + "operationId": "getUpcomingCampaign", + "tags": [ + "shopLive" + ], + "responses": { + "200": { + "description": "success to get upcoming campaign info", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShopLiveCampaignResponseDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/shop-live/campaigns/{campaignKey}/metadata": { + "get": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "campaignKey", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "required": false, + "name": "resolutionLevel", + "description": "ํ•ด์ƒ๋„ ๋ ˆ๋ฒจ", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "summary": "๊ฐœ๋ณ„ ๋ฐฉ์†ก(์บ ํŽ˜์ธ)์˜ ์ƒํƒœ, live stream URL ๋“ฑ์˜ ์š”์•ฝ ์ •๋ณด๋ฅผ ์กฐํšŒ", + "operationId": "getCampaignMetadata", + "tags": [ + "shopLive" + ], + "responses": { + "200": { + "description": "success to get campaign metadata", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShopLiveCampaignMetadataResponseDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/points": { + "get": { + "parameters": [ + { + "$ref": "#/components/parameters/querySize" + }, + { + "in": "query", + "name": "cursor", + "description": "epochSeconds", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "pointType", + "description": "์ ๋ฆฝ ํƒ€์ž… / null = ์ „์ฒด ์กฐํšŒ", + "required": false, + "schema": { + "$ref": "#/components/schemas/PointAmountTypeEnum" + } + } + ], + "summary": "์‚ฌ์šฉ์ž์˜ ์ ๋ฆฝ๊ธˆ ํžˆ์Šคํ† ๋ฆฌ๋ฅผ ์กฐํšŒํ•ฉ๋‹ˆ๋‹ค.", + "operationId": "getPointHistory", + "tags": [ + "point" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to get point hisotry", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PointHistoryBundleResponseDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/points/now-usable": { + "get": { + "summary": "์‚ฌ์šฉ์ž์˜ ํ˜„์žฌ ์‚ฌ์šฉ๊ฐ€๋Šฅํ•œ ์ ๋ฆฝ๊ธˆ์„ ์กฐํšŒํ•ฉ๋‹ˆ๋‹ค.", + "operationId": "getNowUsablePoint", + "tags": [ + "point" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to get now usable point", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NowUsablePointDto" + } + } + } + } + } + } + }, + "/points/promotions/{code}/attend": { + "put": { + "summary": "์ ๋ฆฝ๊ธˆ ํ”„๋กœ๋ชจ์…˜ ์ด๋ฒคํŠธ์— ์ฐธ์„ํ•ฉ๋‹ˆ๋‹ค.", + "operationId": "attendPromotion", + "tags": [ + "point" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "code", + "description": "ํ”„๋กœ๋ชจ์…˜ ์ฝ”๋“œ", + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "success to attend promotion" + } + } + }, + "get": { + "summary": "์ ๋ฆฝ๊ธˆ ํ”„๋กœ๋ชจ์…˜ ์ด๋ฒคํŠธ ์ฐธ์„์—ฌ๋ถ€๋ฅผ ์กฐํšŒํ•ฉ๋‹ˆ๋‹ค.", + "operationId": "getAttendPromotionState", + "tags": [ + "point" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "code", + "description": "ํ”„๋กœ๋ชจ์…˜ ์ฝ”๋“œ", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "success to query attend promotion", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotionAttendedStateDto" + } + } + } + } + } + } + }, + "/product-rankings/{productId}/is-category-best-product": { + "get": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "productId", + "schema": { + "type": "string" + } + } + ], + "summary": "์นดํ…Œ๊ณ ๋ฆฌ ๋ฒ ์ŠคํŠธ ์ƒํ’ˆ์ธ ์ง€์˜ ์œ ๋ฌด๋ฅผ ์กฐํšŒ", + "operationId": "findCategoryBestProduct", + "tags": [ + "productRanking" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to get category best product", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CategoryBestProductDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/referral/code": { + "get": { + "summary": "์ดˆ๋Œ€ ์ฝ”๋“œ ์กฐํšŒ API", + "description": "referrer ์˜ ์ดˆ๋Œ€์ฝ”๋“œ๋ฅผ ๋ฐ˜ํ™˜. ์ตœ์ดˆ ์š”์ฒญ์‹œ ์ƒ์„ฑ ํ›„ ๋ฐ˜ํ™˜ํ•œ๋‹ค.", + "operationId": "getReferralCode", + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "์ถ”์ฒœ ์ฝ”๋“œ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReferralCodeDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/referral/user/reward/policy": { + "get": { + "summary": "์œ ์ € ์ดˆ๋Œ€ ๋ณด์ƒ ์ •์ฑ… ์กฐํšŒ API", + "operationId": "getUserReferralPolicy", + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "์œ ์ € ์ดˆ๋Œ€ ๋ณด์ƒ ์ •์ฑ… ์กฐํšŒ ๊ฒฐ๊ณผ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserReferralRewardPolicyDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/referral/user-referral/summary": { + "get": { + "summary": "์œ ์ € ์ดˆ๋Œ€ ์š”์•ฝ ์ •๋ณด ์กฐํšŒ API", + "operationId": "getUserReferralSummary", + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "์œ ์ € ์ดˆ๋Œ€ ์š”์•ฝ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserReferralSummaryDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/referral/user-referral/bonus-box/open": { + "post": { + "summary": "์œ ์ €๋ ˆํผ๋Ÿด๋กœ ์ ๋ฆฝํ•œ ๋ณด๋„ˆ์Šค ๋ฐ•์Šค๋ฅผ ๊นŒ๋Š” API", + "description": "์œ ์ €๋ ˆํผ๋Ÿด ๋ณด๋„ˆ์Šค ๋ฐ•์Šค๋ฅผ 1๊ฐœ ์—ฌ๋Š” API", + "operationId": "openUserReferralBonusBox", + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "๋ณด๋„ˆ์Šค ๋ฐ•์Šค ์˜คํ”ˆ ๊ฒฐ๊ณผ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserReferralBonusBoxOpenResultDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/referral/user/reward/summary": { + "get": { + "summary": "์œ ์ € ์ดˆ๋Œ€ ๋ณด์ƒ ์š”์•ฝ ์ •๋ณด ์กฐํšŒ API -> `getUserReferralSummary` ์‚ฌ์šฉ", + "operationId": "getUserReferralRewardSummary", + "deprecated": true, + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "์œ ์ € ์ดˆ๋Œ€๋กœ ๋ฐ›์€ ๋ˆ„์  ๋ณด์ƒ ์กฐํšŒ ๊ฒฐ๊ณผ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserReferralRewardSummaryDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/referral/user/reward/estimate": { + "post": { + "summary": "์œ ์ € ์ถ”์ฒœ ๋ณด์ƒ ์˜ˆ์ƒ API", + "description": "- ์ถ”์ฒœ์ธ(referrer)์ด ๋ณด์ƒ์œผ๋กœ ์–ป์„ ์ˆ˜ ์žˆ๋Š” ํฌ์ธํŠธ ์˜ˆ์ƒ ๊ฒฐ๊ณผ๋ฅผ ์กฐํšŒํ•˜๋Š” API (์ตœ๋Œ€ 50๊ฐœ ์ฒ˜๋ฆฌ)\n- `Global PhoneNumber ํ˜•์‹์˜ ํ•œ๊ตญ๋ฒˆํ˜ธ`๋ฅผ ๋„˜๊ฒจ์ฃผ์–ด์•ผ ํ•œ๋‹ค (์˜ˆ '+821012341234')\n", + "operationId": "estimateUserReferralRewards", + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserReferralRewardEstimationRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "referrer ๊ฐ€ ๋ฐ›์„ ์ˆ˜ ์žˆ๋Š” ์ดˆ๋Œ€ ๋ณด์ƒ ๋ฆฌ์ŠคํŠธ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserReferralRewardEstimationListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/referral/user": { + "post": { + "summary": "์œ ์ € ์ถ”์ฒœ API", + "operationId": "createUserReferral", + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateUserReferralRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "์œ ์ € ์ถ”์ฒœ ์„ฑ๊ณต", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateUserReferralResponseDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/referral/user/referred-user-join": { + "post": { + "summary": "์ถ”์ฒœ๋ฐ›์€ ์œ ์ € ๊ฐ€์ž…์™„๋ฃŒ API", + "operationId": "joinReferredUser", + "description": "์ถ”์ฒœ๋ฐ›์€ ์œ ์ €๊ฐ€ referral link ๋ฅผ ํ†ตํ•ด ๊ฐ€์ž…์™„๋ฃŒ ํ›„ ํ•ด๋‹น API ํ˜ธ์ถœ", + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JoinReferredUserRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "์ถ”์ฒœ ์œ ์ € ๊ฐ€์ž… ์„ฑ๊ณต", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JoinReferredUserResponseDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/referral/product": { + "post": { + "summary": "์ถ”์ฒœ์ƒํ’ˆ ๊ตฌ๋งค์™„๋ฃŒ API", + "operationId": "createProductReferral", + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateProductReferralRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "์ƒํ’ˆ ์ถ”์ฒœ ๋งํฌ๋ฅผ ํ†ตํ•ด ์ƒํ’ˆ ๊ตฌ๋งค ์‹œ ProductReferral ์„ ์ƒ์„ฑํ•˜๋Š” API ์ž…๋‹ˆ๋‹ค." + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/games": { + "get": { + "summary": "ํ˜„์žฌ ์ง„ํ–‰์ค‘์ธ ๊ฒŒ์ž„ ๋ชฉ๋ก", + "operationId": "getGameList", + "tags": [ + "gamification" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "๊ฒŒ์ž„ ๋ชฉ๋ก", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActiveGameListResponse" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/games/{gameId}": { + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "์œ ์ € ๊ฒŒ์ž„ ์ •๋ณด ์กฐํšŒ", + "operationId": "getGameProgressInfo", + "tags": [ + "gamification" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "์œ ์ € ๊ฒŒ์ž„ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameUserProgressInfoResponse" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + }, + "post": { + "summary": "1์ฐจ ์žฌํ™” ์†Œ๋น„", + "operationId": "useInGameCredit", + "tags": [ + "gamification" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameUseInGameCreditRequest" + } + } + } + }, + "responses": { + "200": { + "description": "์œ ์ € ๊ฒŒ์ž„ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameUserProgressInfoResponse" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/games/{gameId}/achieve": { + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "๊ฒŒ์ž„ ํด๋ฆฌ์–ด ๋ณด์ƒ ํš๋“", + "operationId": "achieveGame", + "tags": [ + "gamification" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameAchieveRequest" + } + } + } + }, + "responses": { + "204": { + "description": "๊ฒŒ์ž„ ํด๋ฆฌ์–ด ์™„๋ฃŒ" + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/games/{gameId}/missions": { + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "๋ฏธ์…˜ ๋ชฉ๋ก ๋ฐ ๋ฏธ์…˜ ์ง„ํ–‰ ์ƒํ™ฉ ์กฐํšŒ", + "operationId": "getMissions", + "tags": [ + "gamification" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "๋ฏธ์…˜ ๋ชฉ๋ก ๋ฐ ๋ฏธ์…˜ ์ง„ํ–‰ ์ƒํ™ฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameMissionsResponse" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + }, + "post": { + "summary": "๋ฏธ์…˜ ์™„๋ฃŒ ์š”์ฒญ", + "operationId": "achieveMission", + "tags": [ + "gamification" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameMissionAchieveRequest" + } + } + } + }, + "responses": { + "204": { + "description": "๋ฏธ์…˜ ์™„๋ฃŒ" + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/games/{gameId}/missions/{missionId}": { + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "missionId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "post": { + "summary": "๋ฏธ์…˜ ๋ณด์ƒ ์ˆ˜๋ น", + "operationId": "receiveReward", + "tags": [ + "gamification" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "๋ฏธ์…˜ ๋ณด์ƒ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameMissionRewardReceiveResponse" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/categories/{categoryId}/review-guide": { + "parameters": [ + { + "in": "path", + "name": "categoryId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get category's review guide", + "operationId": "getProductCategoryReviewGuide", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product category review guide", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductCategoryReviewGuideDataDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/style-shots": { + "get": { + "summary": "get all style shots", + "operationId": "getAllStyleShots", + "tags": [ + "styleShot" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "query", + "name": "categoryId", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "$ref": "#/components/parameters/queryCursor" + }, + { + "$ref": "#/components/parameters/querySize" + } + ], + "responses": { + "200": { + "description": "get all style shots", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StyleShotListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/style-shots/{id}": { + "get": { + "summary": "get style shot by id", + "operationId": "getStyleShotById", + "tags": [ + "styleShot" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "id", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "get style shot", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StyleShotDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/style-shots/categories": { + "get": { + "summary": "get all style category", + "operationId": "getAllStyleCategory", + "tags": [ + "styleShot" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "get all style category", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StyleCategoryListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/style-shots/{id}/equipped-products": { + "get": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "id", + "schema": { + "type": "string" + } + } + ], + "summary": "get equipped product list by product item ids", + "description": "์Šคํƒ€์ผ ์ƒท ID๋กœ ์ฐฉ์šฉ ์ƒํ’ˆ ์กฐํšŒ", + "operationId": "getEquippedProductListByStyleShotId", + "tags": [ + "styleShot" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- products and product items (unique and not ordered) by product item ids\n- ํ€ธ์ž‡ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋˜๋Š” ๊ฒฝ์šฐ `ProductDto`์—์„œ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋œ ๊ธˆ์•ก์„ ๋ณด์—ฌ์ค€๋‹ค\n- ์˜ํ–ฅ ๋ฐ›๋Š” ํ•„๋“œ: `finalPrice`, `discountPercentage`\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EquippedProductListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/products/{productId}/delivery-prediction": { + "get": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "summary": "get delivery completed prediction dates and probability by product id", + "description": "ProductId๋ฅผ ํ†ตํ•ด ์˜ˆ์ƒ ๋ฐฐ์†ก ์™„๋ฃŒ ์‹œ์  ๋ฐ์ดํ„ฐ๋ฅผ ์กฐํšŒํ•ฉ๋‹ˆ๋‹ค.", + "operationId": "getDeliveryPrediction", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- get delivery completed expectation data\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeliveryPredictionListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/products/{productId}/purchase-measurements-statistics": { + "get": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "productId", + "schema": { + "type": "string" + } + } + ], + "summary": "get purchase measurements statistics by product id", + "description": "์ƒํ’ˆ ID๋กœ ๊ตฌ๋งค ํ†ต๊ณ„ ์กฐํšŒ", + "operationId": "getPurchaseMeasurementsStatistics", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- get purchase measurements statistics\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PurchaseMeasurementsStatisticsListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/products/{productId}/purchase-measurements": { + "get": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "productId", + "schema": { + "type": "string" + } + } + ], + "summary": "get purchase measurements by product id(limit 5)", + "description": "์ƒํ’ˆ ID๋กœ ๊ตฌ๋งค ํ†ต๊ณ„ ์กฐํšŒ(๋กœ์šฐ ๋ฐ์ดํ„ฐ)", + "operationId": "getPurchaseMeasurements", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- get purchase measurements\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PurchaseMeasurementsDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/attendance-checks/{id}/histories": { + "get": { + "summary": "get attendance check histories", + "operationId": "getAttendanceCheckHistories", + "tags": [ + "attendanceCheck" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "id", + "description": "์ถœ์„์ฒดํฌ ID", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "get attendance check histories", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AttendanceCheckHistoryListDto" + } + } + } + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + }, + "/attendance-checks/{id}/attend": { + "post": { + "summary": "attend attendance check", + "description": "- ์ด๋ฏธ ์ถœ์„ ์‹œ ์—๋Ÿฌ ์ฝ”๋“œ: ALREADY_EXISTS(1)\n- ์ถœ์„ ์ฒดํฌ ์™„๋ฃŒ ์‹œ ์—๋Ÿฌ ์ฝ”๋“œ: ATTENDANCE_CHECK_COMPLETED(8001)\n- ์ด๋ฒคํŠธ ์ข…๋ฃŒ ์‹œ ์—๋Ÿฌ ์ฝ”๋“œ: RESOURCE_NOT_FOUND(4)\n", + "operationId": "attendAttendanceCheck", + "tags": [ + "attendanceCheck" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "id", + "description": "์ถœ์„์ฒดํฌ ID", + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "success to attend attendance check" + }, + "400": { + "$ref": "#/components/responses/ApiFailure" + } + } + } + } + }, + "components": { + "securitySchemes": { + "damoa-token": { + "type": "http", + "scheme": "bearer", + "bearerFormat": "JWT" + } + }, + "responses": { + "ApiFailure": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": { + "queryCursor": { + "in": "query", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + "queryPage": { + "in": "query", + "name": "page", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + "querySize": { + "in": "query", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + "queryOrderBy": { + "in": "query", + "name": "orderBy", + "required": false, + "schema": { + "type": "string", + "enum": [ + "ASC", + "DESC" + ] + } + } + }, + "schemas": { + "BooleanDto": { + "type": "object", + "description": "to overcome oag bug that primitive api response does not converted from string in TS.", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "RequiredLongDto": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "integer", + "format": "int64" + } + } + }, + "LongDto": { + "type": "object", + "description": "to overcome oag bug that primitive api response does not converted from long in TS.", + "properties": { + "value": { + "type": "integer", + "format": "int64" + } + } + }, + "LongRangeDto": { + "type": "object", + "properties": { + "min": { + "type": "integer", + "format": "int64" + }, + "max": { + "type": "integer", + "format": "int64" + } + } + }, + "RequiredBooleanDto": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "boolean" + } + } + }, + "MetadataDto": { + "type": "object", + "required": [ + "version", + "serverStatus" + ], + "properties": { + "version": { + "$ref": "#/components/schemas/VersionDto" + }, + "serverStatus": { + "$ref": "#/components/schemas/ServerStatusDto" + } + } + }, + "VersionDto": { + "type": "object", + "required": [ + "minVersion", + "minBuildNumber" + ], + "properties": { + "minVersion": { + "type": "string", + "description": "minimum required version to show" + }, + "minBuildNumber": { + "type": "integer", + "format": "int32", + "description": "minimum required build number" + }, + "updateUrl": { + "type": "string", + "description": "update url" + } + } + }, + "BestPeriodEnum": { + "type": "string", + "enum": [ + "DAILY", + "WEEKLY", + "MONTHLY" + ] + }, + "ProductTagEnum": { + "deprecated": true, + "description": "์ƒํ’ˆ ํƒœ๊ทธ ์ •๋ณด.\nSHOPPING_MALL -> ์‡ผํ•‘๋ชฐ ์ƒํ’ˆ\nDISCOUNT_PROMOTION -> ํŠน๊ฐ€ ์ƒํ’ˆ\n", + "type": "string", + "enum": [ + "SHOPPING_MALL", + "DISCOUNT_PROMOTION" + ] + }, + "AgeGroupCodeEnum": { + "description": "์—ฐ๋ น๋Œ€ ์ฝ”๋“œ. ๋…ธ์…˜ ์ฐธ๊ณ  -> https://www.notion.so/rapportlabs/5d323300ed8a457da25b889fdc9c986c", + "type": "string", + "enum": [ + "AG0", + "AG1", + "AG2", + "AG3", + "AG4", + "AG5", + "AG6" + ] + }, + "ServerStatusDto": { + "type": "object", + "required": [ + "serverState" + ], + "properties": { + "serverState": { + "$ref": "#/components/schemas/ServerStateEnum" + }, + "serverMaintenanceReason": { + "type": "string", + "description": "server maintenance reason" + }, + "serverMaintenanceStartedAtMillis": { + "type": "integer", + "format": "int64", + "description": "server maintenance start time" + }, + "serverMaintenanceEndedAtMillis": { + "type": "integer", + "format": "int64", + "description": "server maintenance end time" + } + } + }, + "PlatformEnum": { + "type": "string", + "enum": [ + "ANDROID", + "IOS" + ] + }, + "ServerStateEnum": { + "type": "string", + "enum": [ + "OPERATIONAL", + "MAINTENANCE" + ], + "description": "server status enum" + }, + "SendVerifCodeRequestDto": { + "type": "object", + "required": [ + "phoneNumber" + ], + "properties": { + "phoneNumber": { + "type": "string", + "description": "phone number to send verif code" + } + } + }, + "SendVerifCodeResponseDto": { + "type": "object", + "required": [ + "verifyingToken", + "expirationMillis" + ], + "properties": { + "verifyingToken": { + "type": "string" + }, + "expirationMillis": { + "type": "integer", + "format": "int64" + } + } + }, + "VerifyCodeRequestDto": { + "type": "object", + "required": [ + "verifyingToken", + "verifCode" + ], + "properties": { + "verifyingToken": { + "type": "string" + }, + "verifCode": { + "type": "string" + } + } + }, + "VerifyCodeResponseDto": { + "type": "object", + "required": [ + "verifiedToken" + ], + "properties": { + "verifiedToken": { + "type": "string" + } + } + }, + "VerifyKakaoTokenRequestDto": { + "type": "object", + "required": [ + "kakaoAccessToken", + "phoneNumber" + ], + "properties": { + "kakaoAccessToken": { + "type": "string" + }, + "phoneNumber": { + "type": "string" + } + } + }, + "VerifyKakaoTokenResponseDto": { + "type": "object", + "required": [ + "verifiedToken" + ], + "properties": { + "verifiedToken": { + "type": "string" + } + } + }, + "SignUpRequestDto": { + "type": "object", + "required": [ + "verifiedToken" + ], + "properties": { + "verifiedToken": { + "type": "string" + } + } + }, + "SignUpResponseDto": { + "type": "object", + "required": [ + "firebaseToken" + ], + "properties": { + "firebaseToken": { + "type": "string" + } + } + }, + "DamoaTokenDto": { + "type": "object", + "required": [ + "accessToken", + "refreshToken" + ], + "properties": { + "accessToken": { + "type": "string", + "description": "1์‹œ๊ฐ„ ๋’ค์— ๋งŒ๋ฃŒ๋จ" + }, + "refreshToken": { + "type": "string", + "description": "180์ผ ๋’ค์— ๋งŒ๋ฃŒ๋จ" + } + } + }, + "DamoaTokenRefreshRequestDto": { + "type": "object", + "required": [ + "refreshToken" + ], + "properties": { + "refreshToken": { + "type": "string" + } + } + }, + "LoginAccountDto": { + "type": "object", + "required": [ + "uid", + "userRole", + "createdAtMillis", + "isKakaoLoginUser" + ], + "properties": { + "uid": { + "type": "string" + }, + "userRole": { + "$ref": "#/components/schemas/UserRoleEnum" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + }, + "phoneNumber": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "isKakaoLoginUser": { + "type": "boolean" + } + } + }, + "FirebaseAuthUserMigrationRequest": { + "type": "object", + "required": [ + "accessToken" + ], + "properties": { + "accessToken": { + "type": "string" + } + } + }, + "ProviderTypeEnum": { + "type": "string", + "enum": [ + "SMS", + "KAKAO" + ] + }, + "UserRoleEnum": { + "type": "string", + "enum": [ + "ANONYMOUS", + "IDENTIFIED_USER" + ] + }, + "BestBrandListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BestBrandDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "BestBrandDto": { + "type": "object", + "required": [ + "id", + "name", + "logo" + ], + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "logo": { + "$ref": "#/components/schemas/BrandLogoDto" + }, + "bestProducts": { + "$ref": "#/components/schemas/BestProductListOfBrandDto" + } + } + }, + "BestProductListOfBrandDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BestProductOfBrandDto" + } + } + } + }, + "BestProductOfBrandDto": { + "type": "object", + "required": [ + "title", + "productId", + "thumbnailUrl", + "multiResolutionThumbnail", + "finalPrice" + ], + "properties": { + "title": { + "type": "string" + }, + "productId": { + "type": "string" + }, + "thumbnailUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionThumbnail": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "finalPrice": { + "type": "integer", + "format": "int64" + } + } + }, + "TagListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "description": "ํƒœ๊ทธ ๋ชฉ๋ก", + "type": "array", + "items": { + "$ref": "#/components/schemas/TagDto" + } + } + } + }, + "TagDto": { + "type": "object", + "required": [ + "id", + "name", + "type" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "description": "tag์˜ ์ด๋ฆ„", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/TagTypeEnum" + } + } + }, + "TagTypeEnum": { + "description": "ํƒœ๊ทธ๊ฐ€ ๋ถ™์„ ์ˆ˜ ์žˆ๋Š” ๊ฒƒ๋“ค์˜ ์ข…๋ฅ˜. ๊ฐ™์€ group ์ด๋ฆ„์ด๋”๋ผ๋„ type์ด ๋‹ค๋ฅด๋ฉด ๋‹ค๋ฅธ ๊ทธ๋ฃน์œผ๋กœ ์ทจ๊ธ‰ํ•œ๋‹ค.", + "type": "string", + "enum": [ + "BRAND_SOURCING", + "PRODUCT" + ] + }, + "TagGroupListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "description": "ํƒœ๊ทธ ๊ทธ๋ฃน ๋ชฉ๋ก", + "type": "array", + "items": { + "$ref": "#/components/schemas/TagGroupDto" + } + } + } + }, + "TagGroupDto": { + "type": "object", + "required": [ + "id", + "name", + "type" + ], + "properties": { + "id": { + "description": "ํƒœ๊ทธ์˜ group id", + "type": "integer", + "format": "int64" + }, + "name": { + "description": "ํƒœ๊ทธ์˜ group name(ex. ์ƒ์‚ฐ๋…„๋„)", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/TagTypeEnum" + } + } + }, + "ProductDto": { + "type": "object", + "required": [ + "productId", + "mallId", + "mallProductCode", + "mallName", + "url", + "imageUrl", + "multiResolutionImage", + "thumbnailUrl", + "multiResolutionThumbnail", + "name", + "finalPrice", + "discountPercentage", + "productPriceDetail", + "brand", + "rating", + "salesStatus" + ], + "properties": { + "productId": { + "type": "string" + }, + "mallId": { + "type": "string", + "description": "DEPRECATED" + }, + "mallProductCode": { + "type": "string" + }, + "mallName": { + "type": "string", + "description": "DEPRECATED" + }, + "rank": { + "type": "integer", + "format": "int32" + }, + "logoUrl": { + "type": "string", + "description": "DEPRECATED" + }, + "logo2xUrl": { + "type": "string", + "description": "DEPRECATED" + }, + "logo3xUrl": { + "type": "string", + "description": "DEPRECATED" + }, + "url": { + "type": "string", + "description": "DEPRECATED" + }, + "imageUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "thumbnailUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionThumbnail": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "name": { + "type": "string" + }, + "originalPrice": { + "type": "integer", + "format": "int64" + }, + "finalPrice": { + "type": "integer", + "format": "int64", + "description": "- `productPriceDetail`์—์„œ์˜ `directCouponAppliedFinalPrice`, ๋‹ค๋งŒ null์ด๋ผ๋ฉด `finalPrice`\n" + }, + "discountPercentage": { + "type": "integer", + "format": "int32", + "description": "- `originalPrice` ๋Œ€๋น„ `finalPrice` ๋Œ€๋น„\n" + }, + "productPriceDetail": { + "$ref": "#/components/schemas/ProductPriceDetailDto" + }, + "brand": { + "type": "string" + }, + "display": { + "type": "boolean", + "description": "์ด ํ•„๋“œ๊ฐ’์ด `false`์ธ ๊ฒฝ์šฐ -> ํ’ˆ์ ˆ๋กœ ํ‘œ์‹œ" + }, + "reviewRatingAvg": { + "type": "number", + "format": "double" + }, + "reviewCount": { + "type": "integer", + "format": "int32" + }, + "category": { + "$ref": "#/components/schemas/ProductCategoryDto" + }, + "rating": { + "type": "integer", + "format": "int32" + }, + "deliveryPolicy": { + "$ref": "#/components/schemas/DeliveryPolicyDto" + }, + "salesStatus": { + "$ref": "#/components/schemas/SalesStatusEnum" + } + } + }, + "AppProductDto": { + "type": "object", + "required": [ + "productId", + "mallId", + "mallProductCode", + "mallName", + "url", + "imageUrl", + "multiResolutionImage", + "thumbnailUrl", + "multiResolutionThumbnail", + "name", + "finalPrice", + "discountPercentage", + "productPriceDetail", + "brand", + "rating", + "salesStatus", + "myBodySizesFromItems" + ], + "properties": { + "productId": { + "type": "string" + }, + "mallId": { + "type": "string", + "description": "DEPRECATED" + }, + "mallProductCode": { + "type": "string" + }, + "mallName": { + "type": "string", + "description": "DEPRECATED" + }, + "rank": { + "type": "integer", + "format": "int32" + }, + "url": { + "type": "string", + "description": "DEPRECATED" + }, + "imageUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "thumbnailUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionThumbnail": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "name": { + "type": "string" + }, + "originalPrice": { + "type": "integer", + "format": "int64" + }, + "finalPrice": { + "type": "integer", + "format": "int64" + }, + "discountPercentage": { + "type": "integer", + "format": "int32" + }, + "productPriceDetail": { + "$ref": "#/components/schemas/ProductPriceDetailDto" + }, + "brand": { + "type": "string" + }, + "display": { + "type": "boolean", + "description": "์ด ํ•„๋“œ๊ฐ’์ด `false`์ธ ๊ฒฝ์šฐ -> ํ’ˆ์ ˆ๋กœ ํ‘œ์‹œ" + }, + "category": { + "$ref": "#/components/schemas/ProductCategoryDto" + }, + "rating": { + "type": "integer", + "format": "int32" + }, + "deliveryPolicy": { + "$ref": "#/components/schemas/DeliveryPolicyDto" + }, + "salesStatus": { + "$ref": "#/components/schemas/SalesStatusEnum" + }, + "reviewRatingAvg": { + "type": "number", + "format": "double" + }, + "reviewCount": { + "type": "integer", + "format": "int32" + }, + "myBodySizesFromItems": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "EquippedProductDto": { + "type": "object", + "required": [ + "productId", + "productItem", + "mallId", + "mallProductCode", + "mallName", + "url", + "imageUrl", + "multiResolutionImage", + "thumbnailUrl", + "multiResolutionThumbnail", + "name", + "finalPrice", + "discountPercentage", + "productPriceDetail", + "brand", + "rating", + "salesStatus", + "favorite" + ], + "properties": { + "productId": { + "type": "string" + }, + "productItem": { + "$ref": "#/components/schemas/ProductItemDto" + }, + "mallId": { + "type": "string", + "description": "DEPRECATED" + }, + "mallProductCode": { + "type": "string" + }, + "mallName": { + "type": "string", + "description": "DEPRECATED" + }, + "rank": { + "type": "integer", + "format": "int32" + }, + "logoUrl": { + "type": "string", + "description": "DEPRECATED" + }, + "logo2xUrl": { + "type": "string", + "description": "DEPRECATED" + }, + "logo3xUrl": { + "type": "string", + "description": "DEPRECATED" + }, + "url": { + "type": "string", + "description": "DEPRECATED" + }, + "imageUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "thumbnailUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionThumbnail": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "name": { + "type": "string" + }, + "originalPrice": { + "type": "integer", + "format": "int64" + }, + "finalPrice": { + "type": "integer", + "format": "int64", + "description": "- `productPriceDetail`์—์„œ์˜ `directCouponAppliedFinalPrice`, ๋‹ค๋งŒ null์ด๋ผ๋ฉด `finalPrice`\n" + }, + "discountPercentage": { + "type": "integer", + "format": "int32", + "description": "- `originalPrice` ๋Œ€๋น„ `finalPrice` ๋Œ€๋น„\n" + }, + "productPriceDetail": { + "$ref": "#/components/schemas/ProductPriceDetailDto" + }, + "brand": { + "type": "string" + }, + "display": { + "type": "boolean", + "description": "์ด ํ•„๋“œ๊ฐ’์ด `false`์ธ ๊ฒฝ์šฐ -> ํ’ˆ์ ˆ๋กœ ํ‘œ์‹œ" + }, + "reviewRatingAvg": { + "type": "number", + "format": "double" + }, + "reviewCount": { + "type": "integer", + "format": "int32" + }, + "category": { + "$ref": "#/components/schemas/ProductCategoryDto" + }, + "rating": { + "type": "integer", + "format": "int32" + }, + "deliveryPolicy": { + "$ref": "#/components/schemas/DeliveryPolicyDto" + }, + "salesStatus": { + "$ref": "#/components/schemas/SalesStatusEnum" + }, + "favorite": { + "type": "boolean", + "default": false, + "description": "์ฐœํ•˜๊ธฐ ์—ฌ๋ถ€" + } + } + }, + "AppAdvertisementProductDto": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/AppProductDto" + } + ] + }, + "ProductPriceDetailDto": { + "type": "object", + "description": "- ๊ธฐ์กด ์ƒํ’ˆ์— ์„ค์ •๋œ ๊ฐ€๊ฒฉ๊ณผ, ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋œ ๊ฐ€๊ฒฉ ๋“ฑ์— ๋Œ€ํ•œ ์ƒ์„ธ ์ •๋ณด๋ฅผ ์ œ๊ณตํ•˜๊ธฐ ์œ„ํ•œ dto\n - `ProductDto`, `AppProductDto`, `FavoriteProductDto` ๋“ฑ์—์„œ ํ™•์ธํ•  ์ˆ˜ ์žˆ๋Š” ์ƒํ’ˆ ๊ฐ€๊ฒฉ์— ๋Œ€ํ•œ ์ƒ์„ธ ์ •๋ณด\n\n> ํ€ธ์ž‡ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋˜๋Š” ๊ฒฝ์šฐ์—๋Š” ๊ธฐ์กด์˜ dto์—์„œ ๋‚˜ํƒ€๋‚ด๋˜ ์ƒํ’ˆ ๊ฐ€๊ฒฉ์ด ํ€ธ์ž‡ ์ฆ‰์‹œ ํ• ์ธ๊ฐ€๋กœ ๋ฎ์–ด์”Œ์›Œ์ง€๊ฒŒ ๋จ\n", + "required": [ + "finalPrice" + ], + "properties": { + "originalPrice": { + "description": "- ์ •๊ฐ€\n- ์ด ํ•„๋“œ์˜ ๊ฐ’์ด `null`์ธ ๊ฒฝ์šฐ -> `finalPrice`๊ฐ€ ์ •๊ฐ€์˜ ์˜๋ฏธ๋ฅผ ํ•จ๊ป˜ ๊ฐ–๊ฒŒ๋จ\n", + "type": "integer", + "format": "int64" + }, + "finalPrice": { + "description": "- ํŒ๋งค๊ฐ€ (์‹ค์ œ ์‚ฌ์šฉ์ž๊ฐ€ ์ƒํ’ˆ์„ ๊ตฌ๋งคํ•˜๊ฒŒ ๋˜๋Š” ๊ฐ€๊ฒฉ)\n - ํ€ธ์ž‡ ์ฆ‰์‹œ ํ• ์ธ ์ฟ ํฐ์ด ์ ์šฉ๋˜์ง€ ์•Š์€ ํŒ๋งค๊ฐ€ ์ •๋ณด๋ฅผ ๋‚˜ํƒ€๋ƒ„\n - ์ƒํ’ˆ ๋“ฑ๋ก์‹œ์— ์ž…๋ ฅํ•œ ํŒ๋งค๊ฐ€๋ฅผ ๋‚˜ํƒ€๋ƒ„\n- `originalPrice`, `discountPercentage` ํ•„๋“œ ๊ฐ’์ด `null`์ธ ๊ฒฝ์šฐ -> ์ด ํ•„๋“œ๊ฐ€ ์ •๊ฐ€์˜ ์˜๋ฏธ๋ฅผ ํ•จ๊ป˜ ๊ฐ–๊ฒŒ๋จ\n", + "type": "integer", + "format": "int64" + }, + "discountPercentage": { + "description": "- ํ• ์ธ ๋น„์œจ -> `originalPrice` ๋Œ€๋น„ `finalPrice` ๋น„์œจ\n- ์ด ํ•„๋“œ์˜ ๊ฐ’์ด `null`์ธ ๊ฒฝ์šฐ -> `finalPrice`๊ฐ€ ์ •๊ฐ€์˜ ์˜๋ฏธ๋ฅผ ํ•จ๊ป˜ ๊ฐ–๊ฒŒ๋จ\n", + "type": "integer", + "format": "int32" + }, + "originalToDirectCouponDiscountPercentage": { + "description": "- ํ• ์ธ ๋น„์œจ -> `originalPrice` ๋Œ€๋น„ `directCouponAppliedFinalPrice` ๋น„์œจ (์ฆ‰์‹œํ• ์ธ ์ฟ ํฐ์ด ํ• ์ธํ•œ ๋น„์œจ)\n- ์ด ํ•„๋“œ์˜ ๊ฐ’์ด `null`์ธ ๊ฒฝ์šฐ -> ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋˜์ง€ ์•Š์€ ๊ฒƒ์œผ๋กœ ๋ณผ ์ˆ˜ ์žˆ์Œ\n", + "type": "integer", + "format": "int32" + }, + "finalToDirectCouponDiscountPercentage": { + "description": "- ํ• ์ธ ๋น„์œจ -> `finalPrice` ๋Œ€๋น„ `directCouponAppliedFinalPrice` ๋น„์œจ (์ฆ‰์‹œํ• ์ธ ์ฟ ํฐ์ด ํ• ์ธํ•œ ๋น„์œจ)\n- ์ด ํ•„๋“œ์˜ ๊ฐ’์ด `null`์ธ ๊ฒฝ์šฐ -> ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋˜์ง€ ์•Š์€ ๊ฒƒ์œผ๋กœ ๋ณผ ์ˆ˜ ์žˆ์Œ\n", + "type": "integer", + "format": "int32" + }, + "directCouponAppliedFinalPrice": { + "description": "- ํ€ธ์ž‡ ์ฆ‰์‹œ ํ• ์ธ ์ฟ ํฐ์ด ์ ์šฉ๋œ ์ตœ์ข… ๊ตฌ๋งค ๊ฐ€๊ฒฉ\n- ์ด ํ•„๋“œ์˜ ๊ฐ’์ด `null`์ธ ๊ฒฝ์šฐ -> ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋˜์ง€ ์•Š์€ ๊ฒƒ์œผ๋กœ ๋ณผ ์ˆ˜ ์žˆ์Œ\n", + "type": "integer", + "format": "int64" + }, + "originalToMaximumBenefitCouponPricePercentage": { + "description": "- ํ• ์ธ ๋น„์œจ -> `originalPrice` ๋Œ€๋น„ `maximumBenefitCouponAppliedFinalPrice` ๋น„์œจ (์ตœ๋Œ€ ํ˜œํƒ ์ฟ ํฐ์ด ํ• ์ธํ•œ ๋น„์œจ)\n- ์ด ํ•„๋“œ์˜ ๊ฐ’์ด `null`์ธ ๊ฒฝ์šฐ -> ์ตœ๋Œ€ ํ˜œํƒ์ด ์ ์šฉ๋˜์ง€ ์•Š์€ ๊ฒƒ์œผ๋กœ ๋ณผ ์ˆ˜ ์žˆ์Œ\n", + "type": "integer", + "format": "int32" + }, + "finalToMaximumBenefitCouponPricePercentage": { + "description": "- ํ• ์ธ ๋น„์œจ -> `finalPrice` ๋Œ€๋น„ `maximumBenefitCouponAppliedFinalPrice` ๋น„์œจ (์ตœ๋Œ€ ํ˜œํƒ ์ฟ ํฐ์ด ํ• ์ธํ•œ ๋น„์œจ)\n- ์ด ํ•„๋“œ์˜ ๊ฐ’์ด `null`์ธ ๊ฒฝ์šฐ -> ์ตœ๋Œ€ ํ˜œํƒ์ด ์ ์šฉ๋˜์ง€ ์•Š์€ ๊ฒƒ์œผ๋กœ ๋ณผ ์ˆ˜ ์žˆ์Œ\n", + "type": "integer", + "format": "int32" + }, + "maximumBenefitCouponAppliedFinalPrice": { + "description": "- ์ตœ๋Œ€ ํ˜œํƒ ์ฟ ํฐ์ด ์ ์šฉ๋œ ์ตœ์ข… ๊ตฌ๋งค ๊ฐ€๊ฒฉ\n- ์ด ํ•„๋“œ์˜ ๊ฐ’์ด `null`์ธ ๊ฒฝ์šฐ -> ์ตœ๋Œ€ ํ˜œํƒ ์ฟ ํฐ์ด ์ ์šฉ๋˜์ง€ ์•Š์€ ๊ฒƒ์œผ๋กœ ๋ณผ ์ˆ˜ ์žˆ์Œ\n", + "type": "integer", + "format": "int64" + } + } + }, + "SalesStatusEnum": { + "description": "- `ACTIVE` -> ํŒ๋งค์ค‘ - ํ˜„์žฌ ๊ณ„์† ํŒ๋งค์ค‘\n- `ARCHIVED` -> ํŒ๋งค ์ค‘์ง€ - ๋‹น์žฅ์€ ํŒ๋งค๋ฅผ ์ค‘์ง€ํ•˜์ง€๋งŒ, ์ถ”ํ›„ ํŒ๋งค๋  ์—ฌ์ง€๊ฐ€ ์žˆ์Œ์„ ๋‚˜ํƒ€๋ƒ„\n- `PERMANENTLY_ARCHIVED` -> ์˜๊ตฌ ํŒ๋งค ์ค‘์ง€ - ๋”์ด์ƒ ํŒ๋งคํ•  ์ƒํ’ˆ์ด ์•„๋‹˜์„ ๋‚˜ํƒ€๋ƒ„\n\n------------\n\n- ์ƒํ’ˆ์˜ ํŒ๋งค์ƒํƒœ๊ฐ€ `ACTIVE`๊ฐ€ ์•„๋‹Œ ๊ฒฝ์šฐ, ์ƒ์„ธ ํŽ˜์ด์ง€์—์„œ ํ’ˆ์ ˆ๋กœ ํ‘œ์‹œํ•œ๋‹ค\n- ์ƒํ’ˆ ์˜ต์…˜์˜ ํŒ๋งค์ƒํƒœ๊ฐ€ `ACTIVE`๊ฐ€ ์•„๋‹Œ ๊ฒฝ์šฐ\n - ์ƒํ’ˆ ์˜ต์…˜์„ ๋…ธ์ถœํ•˜์ง€ ์•Š๋Š”๋‹ค (์„œ๋ฒ„์—์„œ ํ•„ํ„ฐ๋งํ•ด์„œ ๋‚ด๋ ค์คŒ)\n - ์žฅ๋ฐ”๊ตฌ๋‹ˆ์—์„œ๋Š” ํ’ˆ์ ˆ ์ƒํƒœ๋กœ ๋‚˜ํƒ€๋‚ธ๋‹ค (ํด๋ผ์ด์–ธํŠธ์—์„œ ํ•„์š”)\n", + "type": "string", + "enum": [ + "ACTIVE", + "ARCHIVED", + "PERMANENTLY_ARCHIVED" + ] + }, + "ProductDiscountApplicationDto": { + "description": "- ์ƒํ’ˆ์— ์ ์šฉ๋˜๊ฑฐ๋‚˜ ์ ์šฉ๊ฐ€๋Šฅํ•œ ํ• ์ธ ์ •๋ณด๋ฅผ ์ œ๊ณตํ•˜๊ธฐ ์œ„ํ•œ DTO\n- ํ˜„์žฌ๋Š” DirectCoupon(์ฆ‰์‹œํ• ์ธ์ฟ ํฐ)์ •๋ณด๋งŒ ๋‹ด๊ฒจ ์žˆ์œผ๋‚˜ ์ถ”ํ›„์— ๋‹ค๋ฅธ ํ• ์ธํ˜œํƒ์ด ์ถ”๊ฐ€๋จ์— ๋”ฐ๋ผ ๊ด€๋ จ DTO๋“ค์ด ์ถ”๊ฐ€๋  ์ˆ˜ ์žˆ์Œ\n- ์ฆ‰์‹œํ• ์ธ ์ฟ ํฐ ์ค‘์ฒฉ ์ ์šฉ์ด ๊ฐ€๋Šฅํ•ด์ง์— ๋”ฐ๋ผ์„œ `appliedDirectCoupon`๋Š” ๋”์ด์ƒ ์‚ฌ์šฉํ•˜๋ฉด ์•ˆ๋จ, `appliedDirectCoupons` ์‚ฌ์šฉ ํ•„์š”\n", + "type": "object", + "properties": { + "appliedDirectCoupons": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppliedDirectCouponDto" + } + }, + "appliedDirectCoupon": { + "$ref": "#/components/schemas/AppliedDirectCouponDto" + }, + "maximumDiscountCouponAppliedPrice": { + "description": "- ์ตœ๋Œ€ ์ฟ ํฐ ํ• ์ธ๊ฐ€๊ฐ€ ์ ์šฉ๋œ ๊ฐ€๊ฒฉ\n- ์ด ํ•„๋“œ์˜ ๊ฐ’์ด `null`์ธ ๊ฒฝ์šฐ -> ์ตœ๋Œ€ ํ• ์ธ๊ฐ€๋ฅผ ๊ณ„์‚ฐํ•˜๊ธฐ ์œ„ํ•œ ์กฐ๊ฑด์„ ๋งŒ์กฑํ•˜๋Š” ์ฟ ํฐ์ด ์—†๋Š” ๊ฒƒ์œผ๋กœ ๋ณผ ์ˆ˜ ์žˆ์Œ\n", + "type": "integer", + "format": "int64" + } + } + }, + "AppliedDirectCouponDto": { + "type": "object", + "properties": { + "endAtMillis": { + "description": "์ฆ‰์‹œ ํ• ์ธ ์ฟ ํฐ ์ ์šฉ์ด ๋๋‚˜๋Š” ์‹œ์ ์„ ๋‚˜ํƒ€๋ƒ„", + "type": "integer", + "format": "int64" + } + } + }, + "ProductContentsDto": { + "type": "object", + "required": [ + "imageUrls", + "multiResolutionImages", + "descriptionPageUrl", + "measurements", + "classifications" + ], + "properties": { + "imageUrls": { + "description": "DEPRECATED", + "type": "array", + "items": { + "type": "string" + } + }, + "multiResolutionImages": { + "$ref": "#/components/schemas/MultiResolutionImageListDto" + }, + "descriptionPageUrl": { + "type": "string" + }, + "measurements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductMeasurementDto" + } + }, + "classifications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductClassificationDto" + } + }, + "announcement": { + "$ref": "#/components/schemas/ProductAnnouncementDto" + } + } + }, + "PersonalProductContentsDto": { + "allOf": [ + { + "$ref": "#/components/schemas/ProductContentsDto" + }, + { + "type": "object", + "required": [ + "sellerContentImages" + ], + "properties": { + "measurements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PersonalProductMeasurementDto" + } + }, + "sellerContentImages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SellerContentImagesDto" + }, + "description": "์…€๋Ÿฌ๊ฐ€ ๋“ฑ๋กํ•œ ์ด๋ฏธ์ง€" + } + } + } + ] + }, + "ProductMeasurementDto": { + "type": "object", + "required": [ + "type", + "unitOfLength", + "headers", + "rows" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/ProductMeasurementTypeEnum" + }, + "unitOfLength": { + "type": "string" + }, + "headers": { + "type": "array", + "items": { + "type": "string" + } + }, + "rows": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "PersonalProductMeasurementDto": { + "allOf": [ + { + "$ref": "#/components/schemas/ProductMeasurementDto" + }, + { + "type": "object", + "required": [ + "imageUrl" + ], + "properties": { + "imageUrl": { + "type": "string" + } + } + } + ] + }, + "ProductMeasurementTypeEnum": { + "type": "string", + "enum": [ + "SHORTS", + "SKIRT", + "PANTS", + "HOODIE", + "TSHIRTS", + "SWEATER", + "SHIRTS", + "DRESS", + "JUMPER", + "JACKET", + "PADDED_JACKET", + "COAT", + "CARDIGAN" + ] + }, + "ProductClassificationDto": { + "type": "object", + "required": [ + "criterionId", + "criterionText", + "elements" + ], + "properties": { + "criterionId": { + "type": "string" + }, + "criterionText": { + "type": "string" + }, + "elements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductClassificationElementDto" + } + } + } + }, + "ProductClassificationElementDto": { + "type": "object", + "required": [ + "name", + "classified" + ], + "properties": { + "name": { + "type": "string" + }, + "classified": { + "type": "boolean" + } + } + }, + "ProductAnnouncementDto": { + "type": "object", + "required": [ + "apparelProductAnnouncement", + "beautyProductAnnouncement" + ], + "properties": { + "apparelProductAnnouncement": { + "$ref": "#/components/schemas/ApparelProductAnnouncementDto" + }, + "beautyProductAnnouncement": { + "$ref": "#/components/schemas/BeautyProductAnnouncementDto" + }, + "color": { + "type": "string", + "description": "(DEPRECATED) ์ƒ‰์ƒ" + }, + "material": { + "type": "string", + "description": "(DEPRECATED) ์†Œ์žฌ" + }, + "measurement": { + "type": "string", + "description": "(DEPRECATED) ์น˜์ˆ˜" + }, + "manufacturingCompany": { + "type": "string", + "description": "(DEPRECATED) ์ œ์กฐํšŒ์‚ฌ" + }, + "manufacturingCountry": { + "type": "string", + "description": "(DEPRECATED) ์ œ์กฐ๊ตญ" + }, + "manufacturingDate": { + "type": "string", + "description": "(DEPRECATED) ์ œ์กฐ์ผ์ž" + }, + "qaStandards": { + "type": "string", + "description": "(DEPRECATED) ํ’ˆ์งˆ๋ณด์ฆ๊ธฐ์ค€" + }, + "customerCenterContact": { + "type": "string", + "description": "(DEPRECATED) A/S ์ฑ…์ž„์ž ๋ฐ ์ „ํ™”๋ฒˆํ˜ธ" + }, + "washingAndHandling": { + "type": "string", + "description": "(DEPRECATED) ์„ธํƒ๋ฐฉ๋ฒ• ๋ฐ ์ทจ๊ธ‰์‹œ ์ฃผ์˜์‚ฌํ•ญ" + } + } + }, + "ApparelProductAnnouncementDto": { + "type": "object", + "description": "์˜๋ฅ˜ ๊ด€๋ จ ์ƒํ’ˆ์ •๋ณด์ œ๊ณต๊ณ ์‹œ", + "required": [ + "manufacturingCompany", + "manufacturingCountry", + "qaStandards", + "customerCenterContact", + "color", + "material", + "measurement", + "manufacturingDate", + "washingAndHandling" + ], + "properties": { + "manufacturingCompany": { + "type": "string", + "description": "์ œ์กฐํšŒ์‚ฌ" + }, + "manufacturingCountry": { + "type": "string", + "description": "์ œ์กฐ๊ตญ" + }, + "qaStandards": { + "type": "string", + "description": "ํ’ˆ์งˆ๋ณด์ฆ๊ธฐ์ค€" + }, + "customerCenterContact": { + "type": "string", + "description": "A/S ์ฑ…์ž„์ž ๋ฐ ์ „ํ™”๋ฒˆํ˜ธ" + }, + "color": { + "type": "string", + "description": "์ƒ‰์ƒ" + }, + "material": { + "type": "string", + "description": "์†Œ์žฌ" + }, + "measurement": { + "type": "string", + "description": "์น˜์ˆ˜" + }, + "manufacturingDate": { + "type": "string", + "description": "์ œ์กฐ์ผ์ž" + }, + "washingAndHandling": { + "type": "string", + "description": "์„ธํƒ๋ฐฉ๋ฒ• ๋ฐ ์ทจ๊ธ‰์‹œ ์ฃผ์˜์‚ฌํ•ญ" + } + } + }, + "BeautyProductAnnouncementDto": { + "type": "object", + "description": "ํ™”์žฅํ’ˆ(๋ทฐํ‹ฐ) ๊ด€๋ จ ์ƒํ’ˆ์ •๋ณด์ œ๊ณต๊ณ ์‹œ", + "required": [ + "manufacturingCompany", + "manufacturingCountry", + "qaStandards", + "customerCenterContact", + "size", + "responsibleSellerCompany", + "usage", + "highlights", + "concerns", + "expiration", + "ingredients", + "mfdsReview" + ], + "properties": { + "manufacturingCompany": { + "type": "string", + "description": "์ œ์กฐํšŒ์‚ฌ" + }, + "manufacturingCountry": { + "type": "string", + "description": "์ œ์กฐ๊ตญ" + }, + "qaStandards": { + "type": "string", + "description": "ํ’ˆ์งˆ๋ณด์ฆ๊ธฐ์ค€" + }, + "customerCenterContact": { + "type": "string", + "description": "A/S ์ฑ…์ž„์ž ๋ฐ ์ „ํ™”๋ฒˆํ˜ธ" + }, + "size": { + "type": "string", + "description": "ํ™”์žฅํ’ˆ ์šฉ๋Ÿ‰" + }, + "responsibleSellerCompany": { + "type": "string", + "description": "ํ™”์žฅํ’ˆ ์ฑ…์ž„ํŒ๋งค์—…์ž" + }, + "usage": { + "type": "string", + "description": "์‚ฌ์šฉ ๋ฐฉ๋ฒ•" + }, + "highlights": { + "type": "string", + "description": "์ œํ’ˆ ์ฃผ์š” ์‚ฌ์–‘" + }, + "concerns": { + "type": "string", + "description": "์‚ฌ์šฉ์‹œ ์ฃผ์˜์‚ฌํ•ญ" + }, + "expiration": { + "type": "string", + "description": "์‚ฌ์šฉ๊ธฐํ•œ ๋˜๋Š” ๊ฐœ๋ด‰ ํ›„ ์‚ฌ์šฉ๊ธฐํ•œ" + }, + "ingredients": { + "type": "string", + "description": "์„ฑ๋ถ„ (ํ™”์žฅํ’ˆ๋ฒ•์— ๋”ฐ๋ผ ๊ธฐ์žฌ, ํ‘œ์‹œํ•˜์—ฌ์•ผ ํ•˜๋Š” ๋ชจ๋“  ์„ฑ๋ถ„)" + }, + "mfdsReview": { + "type": "string", + "description": "์‹ํ’ˆ์˜์•ฝํ’ˆ์•ˆ์ „์ฒ˜ ์‹ฌ์‚ฌ ํ•„์š” ์œ ๋ฌด (MFDS = Ministry of Food and Drug Safety)" + } + } + }, + "ProductSetDto": { + "type": "object", + "required": [ + "set", + "favoriteIds", + "freeReturnTargetProductIds" + ], + "properties": { + "set": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDto" + } + }, + "favoriteIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "freeReturnTargetProductIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ProductListDto": { + "type": "object", + "required": [ + "list", + "favoriteIds", + "last", + "freeReturnTargetProductIds" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDto" + } + }, + "favoriteIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + }, + "freeReturnTargetProductIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "FilteredPersonalizedProductRequestDto": { + "type": "object", + "required": [ + "size" + ], + "properties": { + "orderBy": { + "$ref": "#/components/schemas/ProductOrderByEnum" + }, + "cursor": { + "type": "string" + }, + "size": { + "type": "integer", + "format": "int32" + }, + "categoryId": { + "type": "string" + }, + "brandId": { + "type": "string" + }, + "minPrice": { + "type": "integer", + "format": "int64" + }, + "maxPrice": { + "type": "integer", + "format": "int64" + }, + "ageGroupCode": { + "$ref": "#/components/schemas/AgeGroupCodeEnum" + }, + "mySizeOnly": { + "type": "boolean", + "default": false + }, + "tag": { + "$ref": "#/components/schemas/ProductTagEnum" + }, + "tagId": { + "type": "integer", + "description": "(deprecated) use tagIdForBrandSourcing", + "format": "int64" + }, + "tagIdForBrandSourcing": { + "description": "tagId์— ๋Œ€์‘๋˜๋Š” BrandSourcing ๋“ค์— ๋Œ€ํ•ด ์ƒํ’ˆ์„ ์กฐํšŒํ•œ๋‹ค", + "type": "integer", + "format": "int64" + }, + "recentlyClickedProducts": { + "type": "array", + "description": "์ตœ๊ทผ ํด๋ฆญ๋œ ์ƒํ’ˆ๋“ค์— ๋Œ€ํ•œ ์ •๋ณด. *๊ฐฏ์ˆ˜๊ฐ€ 100์„ ๋„˜์„ ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค.*", + "items": { + "$ref": "#/components/schemas/ClickedProductDto" + } + }, + "modelId": { + "type": "string", + "description": "- ์–ด๋–ค ๊ฐœ์ธํ™” ๋ชจ๋ธ์„ ์‚ฌ์šฉํ•  ๊ฒƒ์ธ์ง€. (A/B Testing ์šฉ๋„)\n- ๋…ธ์…˜ ์ฐธ๊ณ : https://www.notion.so/rapportlabs/A-B-Protocol-c878d879ff0443cda929bb17d9b137c1\n" + }, + "postProcessingId": { + "type": "string", + "description": "- ๊ฐœ์ธํ™” ๊ฒฐ๊ณผ์˜ ํ›„์ฒ˜๋ฆฌ๋ฅผ ์–ด๋–ป๊ฒŒ ํ•  ๊ฒƒ์ธ๊ฐ€. (A/B Testing ์šฉ๋„)\n- ๋…ธ์…˜ ์ฐธ๊ณ : https://www.notion.so/rapportlabs/A-B-Protocol-c878d879ff0443cda929bb17d9b137c1\n" + } + } + }, + "ClickedProductDto": { + "type": "object", + "required": [ + "id", + "clickedAtMillis" + ], + "properties": { + "id": { + "type": "string" + }, + "clickedAtMillis": { + "type": "integer", + "format": "int64", + "description": "์ƒํ’ˆ์ด ํด๋ฆญ๋์—ˆ๋˜ ์‹œ๊ฐ„ (millis)" + } + } + }, + "AppProductListDto": { + "type": "object", + "required": [ + "list", + "favoriteIds", + "last", + "freeReturnTargetProductIds" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppProductDto" + } + }, + "favoriteIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + }, + "productAggregation": { + "$ref": "#/components/schemas/ProductAggregationDto" + }, + "freeReturnTargetProductIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "AppAdvertisementProductListDto": { + "type": "object", + "required": [ + "favoriteIds", + "list", + "totalPageCount", + "totalElementCount", + "freeReturnTargetProductIds" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppAdvertisementProductDto" + } + }, + "favoriteIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "totalPageCount": { + "type": "integer", + "format": "int32" + }, + "totalElementCount": { + "type": "integer", + "format": "int64" + }, + "freeReturnTargetProductIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PersonalProductDto": { + "type": "object", + "required": [ + "product", + "favorite", + "freeReturnTarget", + "discountInfo" + ], + "properties": { + "product": { + "$ref": "#/components/schemas/ProductDto" + }, + "favorite": { + "type": "boolean" + }, + "categoriesFromRoot": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + }, + "contents": { + "$ref": "#/components/schemas/PersonalProductContentsDto" + }, + "mappedBrand": { + "$ref": "#/components/schemas/BrandDto" + }, + "discountInfo": { + "$ref": "#/components/schemas/ProductDiscountApplicationDto" + }, + "freeReturnTarget": { + "type": "boolean" + } + } + }, + "HomeProductCategoryDto": { + "type": "object", + "required": [ + "topSideCategories", + "bottomSideCategories" + ], + "properties": { + "topSideCategories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + }, + "bottomSideCategories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + } + } + }, + "ProductCategoryDto": { + "type": "object", + "required": [ + "id", + "title" + ], + "properties": { + "id": { + "type": "string" + }, + "parentId": { + "type": "string" + }, + "title": { + "type": "string" + }, + "iconUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionIcon": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + } + } + }, + "MallDto": { + "type": "object", + "required": [ + "mallId", + "title" + ], + "properties": { + "mallId": { + "type": "string" + }, + "title": { + "type": "string" + }, + "logoUrl": { + "type": "string" + }, + "logo2xUrl": { + "type": "string" + }, + "logo3xUrl": { + "type": "string" + } + } + }, + "FavoriteProductDto": { + "type": "object", + "required": [ + "id", + "mallId", + "mallName", + "mallProductCode", + "itemImageUri", + "itemThumbnailUri", + "brandName", + "productName", + "productDiscountRate", + "price", + "productPriceDetail", + "shopUri", + "createdAt" + ], + "properties": { + "id": { + "type": "string" + }, + "mallId": { + "type": "string" + }, + "mallName": { + "type": "string" + }, + "mallProductCode": { + "type": "string" + }, + "itemImageUri": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionItemImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "itemThumbnailUri": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionItemThumbnail": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "brandName": { + "type": "string" + }, + "productName": { + "type": "string" + }, + "productDiscountRate": { + "type": "integer", + "format": "int32" + }, + "originalPrice": { + "type": "integer", + "format": "int64" + }, + "price": { + "type": "integer", + "format": "int64" + }, + "productPriceDetail": { + "$ref": "#/components/schemas/ProductPriceDetailDto" + }, + "shopUri": { + "type": "string" + }, + "shopLogoUri": { + "type": "string" + }, + "createdAt": { + "type": "string" + } + } + }, + "FavoriteProductListDto": { + "type": "object", + "required": [ + "list", + "last", + "freeReturnTargetProductIds" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FavoriteProductDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + }, + "freeReturnTargetProductIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ProductItemListDto": { + "type": "object", + "required": [ + "options", + "optionElements", + "productItems" + ], + "properties": { + "options": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OptionDto" + } + }, + "optionElements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OptionElementDto" + } + }, + "productItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductItemDto" + } + } + } + }, + "ProductReleaseEstimateDto": { + "type": "object", + "required": [ + "productId", + "itemReleaseEstimateAtList" + ], + "properties": { + "productId": { + "type": "string", + "description": "์ƒํ’ˆ ID" + }, + "itemReleaseEstimateAtList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductItemReleaseEstimateDto" + } + } + } + }, + "ProductItemReleaseEstimateDto": { + "type": "object", + "required": [ + "productItemId", + "releaseEstimateAt" + ], + "properties": { + "productItemId": { + "type": "string", + "description": "์ƒํ’ˆ ์˜ต์…˜ ID" + }, + "itemReleaseEstimateAtMillis": { + "type": "integer", + "format": "int64", + "description": "yyyy-mm-dd ํ˜•์‹์˜ ์ถœ๊ณ  ์ผ์ž" + } + } + }, + "ProductItemDto": { + "type": "object", + "required": [ + "id", + "title", + "optionElementIds", + "price", + "display", + "salesStatus", + "mallProductItemCode" + ], + "properties": { + "id": { + "type": "string" + }, + "title": { + "type": "string" + }, + "releaseAtEstimate": { + "type": "string", + "description": "yyyy-mm-dd ํ˜•์‹์˜ ์ถœ๊ณ  ์ผ์ž" + }, + "optionElementIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "maxQuantity": { + "type": "integer", + "format": "int64" + }, + "price": { + "type": "integer", + "format": "int64" + }, + "display": { + "type": "boolean", + "description": "- ์ƒํ’ˆ ์˜ต์…˜์˜ ๋…ธ์ถœ ์—ฌ๋ถ€๋ฅผ ๋‚˜ํƒ€๋‚ธ๋‹ค\n- false์ด๋ฉด ํ’ˆ์ ˆ ์ƒํƒœ๋กœ ๋‚˜ํƒ€๋‚ธ๋‹ค\n" + }, + "salesStatus": { + "$ref": "#/components/schemas/SalesStatusEnum" + }, + "mallProductItemCode": { + "type": "string" + } + } + }, + "OptionDto": { + "type": "object", + "required": [ + "title" + ], + "properties": { + "title": { + "type": "string" + } + } + }, + "OptionElementDto": { + "type": "object", + "required": [ + "id", + "title" + ], + "properties": { + "id": { + "type": "string" + }, + "title": { + "type": "string" + } + } + }, + "ProductItemAvailabilityDto": { + "type": "object", + "required": [ + "productId", + "productItemId", + "available" + ], + "properties": { + "productId": { + "type": "string" + }, + "productItemId": { + "type": "string" + }, + "quantity": { + "description": "- ์ƒํ’ˆ ์˜ต์…˜ ์žฌ๊ณ \n- ์ด ๊ฐ’์ด `null`์ธ ๊ฒฝ์šฐ -> ๋‚ด๋ถ€์ ์œผ๋กœ ์žฌ๊ณ ๊ฐ€ ๋ฌด์ œํ•œ์ธ ๊ฒƒ์œผ๋กœ ๊ฐ„์ฃผ\n- ์ด ๊ฐ’๋งŒ์œผ๋กœ๋Š” ์ƒํ’ˆ์˜ ๊ตฌ๋งค ๊ฐ€๋Šฅ ์—ฌ๋ถ€๋ฅผ ํŒ๋‹จํ•  ์ˆ˜ ์—†์Œ -> `ProductItemAvailabilityDto.available` ๊ฐ’์ด ์ค‘์š”\n", + "type": "integer", + "format": "int64" + }, + "available": { + "description": "์ƒํ’ˆ ๊ตฌ๋งค ๊ฐ€๋Šฅ ์—ฌ๋ถ€ (product ~ product item์˜ ๊ฐ’์„ ํ†ตํ•ด์„œ ๊ณ„์‚ฐ๋œ ๊ฐ’)", + "type": "boolean" + } + } + }, + "BrandListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BrandDto" + } + } + } + }, + "BrandDto": { + "type": "object", + "required": [ + "id", + "name", + "logo" + ], + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "logo": { + "$ref": "#/components/schemas/BrandLogoDto" + } + } + }, + "BrandLogoDto": { + "type": "object", + "properties": { + "landscapeUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionLandscape": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "squareUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionSquare": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + } + } + }, + "BrandDetailDto": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BrandDto" + }, + { + "type": "object", + "required": [ + "categories" + ], + "properties": { + "categories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + } + } + } + ] + }, + "BrandProductsDto": { + "type": "object", + "required": [ + "brand", + "list" + ], + "properties": { + "brand": { + "$ref": "#/components/schemas/BrandDto" + }, + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDto" + } + } + } + }, + "BrandProductsListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BrandProductsDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "AddToCartRequestDto": { + "type": "object", + "required": [ + "items" + ], + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AddCartItemDto" + } + } + } + }, + "AddToCartResponseDto": { + "type": "object", + "required": [ + "cartItemIds" + ], + "properties": { + "cartItemIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + } + } + }, + "AddCartItemDto": { + "type": "object", + "required": [ + "productItemId", + "quantity" + ], + "properties": { + "productItemId": { + "type": "string" + }, + "quantity": { + "type": "integer", + "format": "int64" + } + } + }, + "DeleteCartItemsRequestDto": { + "type": "object", + "required": [ + "cartItemIds" + ], + "properties": { + "cartItemIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + } + } + }, + "CartItemGroupDto": { + "type": "object", + "required": [ + "groupId", + "brand", + "delivery", + "items" + ], + "properties": { + "groupId": { + "type": "string" + }, + "brand": { + "$ref": "#/components/schemas/BrandDto" + }, + "delivery": { + "$ref": "#/components/schemas/CartItemGroupDeliveryPolicyDto" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartItemDto" + } + } + } + }, + "CartItemGroupDeliveryPolicyDto": { + "type": "object", + "required": [ + "defaultPrice", + "defaultReturnCost", + "shippingCostPolicy", + "returnCostPolicy", + "logisticsPolicy", + "assorted", + "shippingPolicyId" + ], + "properties": { + "defaultPrice": { + "type": "integer", + "format": "int64", + "description": "DEPRECATED -> use `shippingCostPolicy`" + }, + "requiredAmountForFree": { + "type": "integer", + "format": "int64", + "description": "DEPRECATED -> use `shippingCostPolicy`" + }, + "defaultReturnCost": { + "type": "integer", + "format": "int64", + "description": "DEPRECATED -> use `returnCostPolicy`" + }, + "shippingCostPolicy": { + "$ref": "#/components/schemas/ShippingCostPolicyDto" + }, + "returnCostPolicy": { + "$ref": "#/components/schemas/ReturnCostPolicyDto" + }, + "logisticsPolicy": { + "$ref": "#/components/schemas/LogisticsPolicyDto" + }, + "assorted": { + "type": "boolean" + }, + "shippingPolicyId": { + "type": "integer", + "format": "int64" + } + } + }, + "DeliveryPolicyDto": { + "type": "object", + "required": [ + "defaultPrice", + "defaultReturnCost", + "shippingCostPolicy", + "returnCostPolicy", + "logisticsPolicy" + ], + "properties": { + "defaultPrice": { + "type": "integer", + "format": "int64", + "description": "DEPRECATED -> use `shippingCostPolicy`" + }, + "requiredAmountForFree": { + "type": "integer", + "format": "int64", + "description": "DEPRECATED -> use `shippingCostPolicy`" + }, + "defaultReturnCost": { + "type": "integer", + "format": "int64", + "description": "DEPRECATED -> use `returnCostPolicy`" + }, + "shippingCostPolicy": { + "$ref": "#/components/schemas/ShippingCostPolicyDto" + }, + "returnCostPolicy": { + "$ref": "#/components/schemas/ReturnCostPolicyDto" + }, + "logisticsPolicy": { + "$ref": "#/components/schemas/LogisticsPolicyDto" + } + } + }, + "ShippingCostPolicyDto": { + "type": "object", + "description": "๋ฐฐ์†ก๋น„ ์ •์ฑ…", + "required": [ + "defaultCost", + "jejuIsland", + "backCountry" + ], + "properties": { + "defaultCost": { + "type": "integer", + "format": "int64" + }, + "jejuIsland": { + "type": "integer", + "format": "int64", + "description": "์ œ์ฃผ๋„ ์ถ”๊ฐ€ ๋ฐฐ์†ก๋น„" + }, + "backCountry": { + "type": "integer", + "format": "int64", + "description": "๋„์„œ์‚ฐ๊ฐ„ ์ถ”๊ฐ€ ๋ฐฐ์†ก๋น„" + }, + "requiredAmountForFree": { + "type": "integer", + "format": "int64", + "description": "๋ฌด๋ฃŒ ๋ฐฐ์†ก์„ ์œ„ํ•œ ์ตœ์†Œ ๊ตฌ๋งค ๊ธˆ์•ก" + } + } + }, + "ReturnCostPolicyDto": { + "type": "object", + "description": "๋ฐ˜ํ’ˆ๋น„ ์ •์ฑ…", + "required": [ + "defaultCost", + "jejuIsland", + "backCountry" + ], + "properties": { + "defaultCost": { + "type": "integer", + "format": "int64", + "description": "additionalCost๊ฐ€ ๊ณ ๋ ค๋˜์ง€ ์•Š์€ ๊ธฐ๋ณธ ๋ฐ˜ํ’ˆ ๋น„์šฉ" + }, + "jejuIsland": { + "type": "integer", + "format": "int64", + "description": "์ œ์ฃผ๋„ ์ถ”๊ฐ€ ๋ฐ˜ํ’ˆ๋น„" + }, + "backCountry": { + "type": "integer", + "format": "int64", + "description": "๋„์„œ์‚ฐ๊ฐ„ ์ถ”๊ฐ€ ๋ฐ˜ํ’ˆ๋น„" + } + } + }, + "LogisticsPolicyDto": { + "type": "object", + "properties": { + "shippingPlace": { + "type": "string", + "description": "์ถœ๊ณ ์ง€ ์ฃผ์†Œ" + }, + "returnPlace": { + "type": "string", + "description": "๋ฐ˜ํ’ˆ์ง€ ์ฃผ์†Œ" + }, + "courier": { + "deprecated": true, + "type": "string", + "description": "- DEPRECATED - `vendor` ํ•„๋“œ๋ฅผ ์‚ฌ์šฉํ•ด์ฃผ์„ธ์š”\n- ์ด์šฉ ํƒ๋ฐฐ์‚ฌ\n" + }, + "vendor": { + "$ref": "#/components/schemas/LogisticsVendorEnum" + } + } + }, + "LogisticsVendorEnum": { + "description": "- (๋ฐฐ์†ก ์ •์ฑ… ๊ด€๋ จ) ์„ค์ • ๊ฐ€๋Šฅํ•œ ํƒ๋ฐฐ์‚ฌ\n- `ETC (๊ธฐํƒ€๋ฐฐ์†ก์‚ฌ)` -> ํŠน์ • ๋ฐฐ์†ก์‚ฌ๋ฅผ ์ด์šฉ์ค‘์ด์ง€๋งŒ, ํ˜„์žฌ ์ง€์›ํ•˜๊ณ  ์žˆ์ง€ ์•Š์€ ํƒ๋ฐฐ์‚ฌ (๊ธฐํƒ€๋ฐฐ์†ก์‚ฌ์— ๋Œ€ํ•œ ์ง€์›์ด ํ•„์š”ํ•œ ๊ฒฝ์šฐ, ๋ณ„๋„ ๋ฌธ์˜์ฃผ์„ธ์š”)\n- `SELF_MANAGED (์ง์ ‘๋ฐฐ์†ก)` -> ์ง์ ‘ ๋ฐฐ์†กํ•˜๋Š” ๊ฒฝ์šฐ์— ์‚ฌ์šฉ\n", + "type": "string", + "enum": [ + "CJ๋Œ€ํ•œํ†ต์šด", + "๋กœ์  ํƒ๋ฐฐ", + "์šฐ์ฒด๊ตญํƒ๋ฐฐ", + "ํ•œ์ง„ํƒ๋ฐฐ", + "๋กฏ๋ฐํƒ๋ฐฐ", + "๋Œ€์‹ ํƒ๋ฐฐ", + "์ผ์–‘ํƒ๋ฐฐ", + "๊ฒฝ๋™ํƒ๋ฐฐ", + "ํ•ฉ๋™ํƒ๋ฐฐ", + "์ฒœ์ผํƒ๋ฐฐ", + "GSํŽธ์˜์ ํƒ๋ฐฐ", + "ํ•œ์˜์‚ฌ๋ž‘ํƒ๋ฐฐ", + "๊ฑด์˜ํƒ๋ฐฐ", + "ํ˜ธ๋‚จํƒ๋ฐฐ", + "SLX", + "CUํŽธ์˜์ ํƒ๋ฐฐ", + "์šฉ๋งˆ๋กœ์ง€์Šค", + "์„ธ๋ฐฉํƒ๋ฐฐ", + "์›๋”์Šคํ€ต", + "๋†ํ˜‘ํƒ๋ฐฐ", + "HIํƒ๋ฐฐ", + "ํ™ˆํ”ฝํƒ๋ฐฐ", + "CJ๋Œ€ํ•œํ†ต์šด๊ตญ์ œํŠน์†ก", + "EMS", + "๋กฏ๋ฐ๊ธ€๋กœ๋ฒŒ", + "ํ•œ๋ฑ์Šค", + "DHL", + "FEDEX", + "UPS", + "TNT", + "๋ฒ”ํ•œํŒํ† ์Šค", + "ACI Express", + "ACE Express", + "์€ํ•˜์‰ฌํ•‘", + "๋‘๋ฐœํžˆ์–ด๋กœ", + "๋กœ์ง€์ŠคํŒŸ", + "๋ถ€๋ฆ‰(VROONG)", + "์ดํˆฌ๋งˆ์Šค", + "์—์ด์Šค๋ฌผ๋ฅ˜", + "๋Œ€๋ฆผํ†ต์šด", + "๋ฐœ๋ ‰์Šค", + "๊ธฐํƒ€๋ฐฐ์†ก์‚ฌ", + "์ง์ ‘๋ฐฐ์†ก" + ], + "x-enum-varnames": [ + "CJ_GLS", + "LOGEN", + "EPOST", + "HANJIN", + "LOTTE", + "DAESIN", + "ILYANG", + "KYUNGDONG", + "HAPDONG", + "CHUNIL", + "CVSNET", + "HPL", + "KUNYOUNG", + "HONAM", + "SLX", + "BGF", + "YONGMA", + "SEBANG", + "WONDERS", + "NH_LOGIS", + "HI_LOGIS", + "HOMEPICK", + "KOREX_G", + "EMS", + "LOTTE_GLOBAL", + "HANDEX", + "DHL", + "FEDEX", + "UPS", + "TNT", + "PANTOS", + "ACI_EXPRESS", + "ACE_EXP", + "EUNHA", + "CHAIN_LOGISTICS", + "LOGISPOT", + "VROONG", + "ETOMARS", + "VENDORPIA", + "DAERIM", + "VALEX", + "ETC", + "SELF_MANAGED" + ] + }, + "CartItemDto": { + "type": "object", + "description": "- `product.salesStatus != ACTIVE || product.display == false`์ธ ๊ฒฝ์šฐ -> ํ’ˆ์ ˆ๋กœ ํ‘œ์‹œ\n- `productItem.salesStatus != ACTIVE || productItem.display == false`์ธ ๊ฒฝ์šฐ -> ํ’ˆ์ ˆ๋กœ ํ‘œ์‹œ\n- ํ€ธ์ž‡ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋˜๋Š” ๊ฒฝ์šฐ `ProductDto`์—์„œ ์ฆ‰์‹œ ํ• ์ธ์ด ์ ์šฉ๋œ ๊ธˆ์•ก์„ ๋ณด์—ฌ์ค€๋‹ค\n - ์˜ํ–ฅ ๋ฐ›๋Š” ํ•„๋“œ: `finalPrice`, `discountPercentage`\n", + "required": [ + "id", + "product", + "productItem", + "quantity", + "brand", + "freeReturnTarget" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "product": { + "$ref": "#/components/schemas/ProductDto" + }, + "productItem": { + "$ref": "#/components/schemas/ProductItemDto" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "brand": { + "$ref": "#/components/schemas/BrandDto" + }, + "freeReturnTarget": { + "type": "boolean" + } + } + }, + "PurchaseTopicEnum": { + "type": "string", + "enum": [ + "PRODUCT" + ] + }, + "StartOrderRequestDto": { + "type": "object", + "required": [ + "cartItemIds" + ], + "properties": { + "cartItemIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + } + } + }, + "StartOrderFromAddingRequestDto": { + "type": "object", + "required": [ + "items" + ], + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AddCartItemDto" + } + } + } + }, + "DeliveryAddressDto": { + "type": "object", + "required": [ + "recipientName", + "phoneNumber", + "zipCode", + "address", + "detailedAddress" + ], + "properties": { + "recipientName": { + "type": "string" + }, + "phoneNumber": { + "type": "string" + }, + "zipCode": { + "type": "string", + "description": "5์ž๋ฆฌ, ๊ตญ๊ฐ€ ๊ธฐ์ดˆ ๊ตฌ์—ญ ๋ฒˆํ˜ธ (State Basic District Number)" + }, + "address": { + "type": "string" + }, + "detailedAddress": { + "type": "string" + } + } + }, + "UserRefundAccountDto": { + "type": "object", + "properties": { + "refundAccount": { + "$ref": "#/components/schemas/RefundAccountDto" + } + } + }, + "RefundAccountDto": { + "type": "object", + "required": [ + "accountNumber", + "bank", + "holderName" + ], + "properties": { + "accountNumber": { + "type": "string" + }, + "bank": { + "$ref": "#/components/schemas/RefundAccountBankEnum" + }, + "holderName": { + "type": "string" + } + } + }, + "ConnectPayPromotionDto": { + "type": "object", + "required": [ + "discountCards", + "interestFreeCards" + ], + "properties": { + "discountCards": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConnectPayDiscountCardDto" + } + }, + "interestFreeCards": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConnectPayInterestFreeCardsDto" + } + } + } + }, + "ConnectPayDiscountCardDto": { + "type": "object", + "required": [ + "card", + "minimumPaymentAmount", + "discountCode", + "discountAmount" + ], + "properties": { + "card": { + "$ref": "#/components/schemas/TossPaymentCardEnum" + }, + "minimumPaymentAmount": { + "type": "integer", + "format": "int64" + }, + "maximumPaymentAmount": { + "type": "integer", + "format": "int64" + }, + "discountCode": { + "description": "discount code should be passed when request payment with connect-pay", + "type": "string" + }, + "discountAmount": { + "type": "integer", + "format": "int64" + } + } + }, + "ConnectPayInterestFreeCardsDto": { + "type": "object", + "required": [ + "card", + "interestFreeMonths", + "minimumPaymentAmount" + ], + "properties": { + "card": { + "$ref": "#/components/schemas/TossPaymentCardEnum" + }, + "interestFreeMonths": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + } + }, + "minimumPaymentAmount": { + "type": "integer", + "format": "int64" + } + } + }, + "TossPaymentPromotionDto": { + "type": "object", + "required": [ + "discountCards", + "interestFreeCards" + ], + "properties": { + "discountCards": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TossPaymentDiscountPolicyDto" + } + }, + "interestFreeCards": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TossPaymentInterestFreePolicyDto" + } + } + } + }, + "TossPaymentDiscountPolicyDto": { + "type": "object", + "required": [ + "card", + "minimumPaymentAmount", + "discountCode", + "discountAmount" + ], + "properties": { + "card": { + "$ref": "#/components/schemas/TossPaymentCardEnum" + }, + "minimumPaymentAmount": { + "type": "integer", + "format": "int64" + }, + "maximumPaymentAmount": { + "type": "integer", + "format": "int64" + }, + "discountCode": { + "description": "discount code should be passed when request payment with toss", + "type": "string" + }, + "discountAmount": { + "type": "integer", + "format": "int64" + } + } + }, + "TossPaymentInterestFreePolicyDto": { + "type": "object", + "required": [ + "card", + "installmentFreeMonths", + "minimumPaymentAmount" + ], + "properties": { + "card": { + "$ref": "#/components/schemas/TossPaymentCardEnum" + }, + "installmentFreeMonths": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + } + }, + "minimumPaymentAmount": { + "type": "integer", + "format": "int64" + } + } + }, + "TossPaymentAccountEnum": { + "type": "string", + "enum": [ + "๋†ํ˜‘", + "์šฐ๋ฆฌ", + "์‹ ํ•œ", + "๊ตญ๋ฏผ", + "ํ•˜๋‚˜", + "์”จํ‹ฐ", + "๊ธฐ์—…", + "์‚ฐ์—…", + "์ œ์ผ", + "๋Œ€๊ตฌ", + "๋ถ€์‚ฐ", + "์ „๋ถ", + "๊ฒฝ๋‚จ", + "์ œ์ฃผ", + "๊ด‘์ฃผ", + "์ƒˆ๋งˆ์„", + "์ˆ˜ํ˜‘", + "์‹ ํ˜‘", + "์šฐ์ฒด๊ตญ", + "์ผ€์ด", + "์นด์นด์˜ค", + "์ €์ถ•", + "์‚ฐ๋ฆผ", + "UNKNOWN" + ], + "x-enum-varnames": [ + "NONGHYUP", + "WOORI", + "SHINHAN", + "KOOKMIN", + "HANA", + "CITI", + "INDUSTRIAL", + "KDB", + "SC", + "DAEGU", + "BUSAN", + "JEONBUK", + "KYONGNAM", + "JEJU", + "KWANGJU", + "SAEMAEUL", + "SUHYUP", + "SHINHYUP", + "POST", + "K_BANK", + "KAKAO_BANK", + "SAVING_SB", + "FORESTRY_SJ", + "UNKNOWN" + ] + }, + "TossPaymentCardEnum": { + "type": "string", + "enum": [ + "์‹ ํ•œ", + "ํ˜„๋Œ€", + "์‚ผ์„ฑ", + "์šฐ๋ฆฌ", + "๊ตญ๋ฏผ", + "๋กฏ๋ฐ", + "๋†ํ˜‘", + "ํ•˜๋‚˜", + "BC", + "์”จํ‹ฐ", + "์นด์นด์˜ค๋ฑ…ํฌ", + "KDB", + "์ˆ˜ํ˜‘", + "์ „๋ถ", + "์šฐ์ฒด๊ตญ", + "์ƒˆ๋งˆ์„", + "์ €์ถ•", + "์ œ์ฃผ", + "๊ด‘์ฃผ", + "์‹ ํ˜‘", + "JCB", + "์œ ๋‹ˆ์˜จํŽ˜์ด", + "๋งˆ์Šคํ„ฐ", + "๋น„์ž", + "๋‹ค์ด๋„ˆ์Šค", + "๋””์Šค์ปค๋ฒ„", + "UNKNOWN" + ], + "x-enum-varnames": [ + "SHINHAN", + "HYUNDAI", + "SAMSUNG", + "WOORI", + "KOOKMIN", + "LOTTE", + "NONGHYUP", + "HANA", + "BC", + "CITI", + "KAKAO_BANK", + "KDB", + "SUHYUP", + "JEONBUK", + "POST", + "SAEMAEUL", + "SAVING_SB", + "JEJU", + "KWANGJU", + "SHINHYUP", + "JCB", + "UNION_PAY", + "MASTER_CARD", + "VISA", + "DINERS_CLUB", + "DISCOVER", + "UNKNOWN" + ] + }, + "RefundAccountBankEnum": { + "type": "string", + "enum": [ + "๋†ํ˜‘", + "๊ตญ๋ฏผ", + "์šฐ๋ฆฌ", + "์‹ ํ•œ", + "๊ธฐ์—…", + "ํ•˜๋‚˜", + "๊ฒฝ๋‚จ", + "๋Œ€๊ตฌ", + "๋ถ€์‚ฐ", + "์ˆ˜ํ˜‘", + "์šฐ์ฒด๊ตญ", + "์‚ฐ์—…", + "SC์ œ์ผ", + "์”จํ‹ฐ", + "๊ด‘์ฃผ", + "์ œ์ฃผ", + "์ „๋ถ", + "์ƒˆ๋งˆ์„", + "์‹ ํ˜‘", + "์ผ€์ด", + "์นด์นด์˜ค" + ], + "x-enum-varnames": [ + "NONGHYUP", + "KOOKMIN", + "WOORI", + "SHINHAN", + "INDUSTRIAL", + "HANA", + "KYONGNAM", + "DAEGU", + "BUSAN", + "SUHYUP", + "POST", + "KDB", + "SC", + "CITI", + "KWANGJU", + "JEJU", + "JEONBUK", + "SAEMAEUL", + "SHINHYUP", + "K_BANK", + "KAKAO_BANK" + ] + }, + "BankNameEnum": { + "type": "string", + "description": "์€ํ–‰ ์ด๋ฆ„", + "enum": [ + "๋†ํ˜‘", + "๊ตญ๋ฏผ", + "์šฐ๋ฆฌ", + "์‹ ํ•œ", + "๊ธฐ์—…", + "ํ•˜๋‚˜", + "๊ฒฝ๋‚จ", + "๋Œ€๊ตฌ", + "๋ถ€์‚ฐ", + "์ˆ˜ํ˜‘", + "์šฐ์ฒด๊ตญ", + "์‚ฐ์—…", + "SC์ œ์ผ", + "์”จํ‹ฐ", + "๊ด‘์ฃผ", + "์ œ์ฃผ", + "์ „๋ถ", + "์ƒˆ๋งˆ์„", + "์‹ ํ˜‘", + "์ผ€์ด", + "์นด์นด์˜ค" + ], + "x-enum-varnames": [ + "NONGHYUP", + "KOOKMIN", + "WOORI", + "SHINHAN", + "INDUSTRIAL", + "HANA", + "KYONGNAM", + "DAEGU", + "BUSAN", + "SUHYUP", + "POST", + "KDB", + "SC", + "CITI", + "KWANGJU", + "JEJU", + "JEONBUK", + "SAEMAEUL", + "SHINHYUP", + "K_BANK", + "KAKAO_BANK" + ] + }, + "ProductPurchaseMaterialDto": { + "type": "object", + "required": [ + "purchaseId", + "recentDeliveredRequests", + "issuedCoupons", + "orderSummary", + "payableMethodIds", + "tossPaymentsInterestFreePolicies" + ], + "properties": { + "purchaseId": { + "type": "string" + }, + "recentDeliveredRequests": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserDeliveryAddressDto" + } + }, + "recommendedIssuedCouponId": { + "type": "integer", + "format": "int64" + }, + "issuedCoupons": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IssuedCouponWhenOrderDto" + } + }, + "orderSummary": { + "$ref": "#/components/schemas/OrderSummaryDto" + }, + "refundAccount": { + "$ref": "#/components/schemas/RefundAccountDto" + }, + "payableMethodIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "tossPaymentsInterestFreePolicies": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TossPaymentInterestFreePolicyDto" + } + } + } + }, + "StartIamportPaymentRequestDto": { + "type": "object", + "required": [ + "pg", + "pgMethod" + ], + "properties": { + "pg": { + "type": "string", + "description": "payment gateway id" + }, + "pgMethod": { + "type": "string", + "description": "payment gateway dependent method" + } + } + }, + "IamportPaymentMaterialDto": { + "type": "object", + "required": [ + "storeId", + "pg", + "merchantId", + "productName", + "productPrice", + "currency", + "language", + "buyerTel", + "payMethod" + ], + "properties": { + "storeId": { + "type": "string", + "description": "store id (ex. 'imp*')" + }, + "pg": { + "type": "string", + "description": "payment gateway id" + }, + "merchantId": { + "type": "string", + "description": "generated merchantId for this payment" + }, + "productName": { + "type": "string", + "description": "product name to show to user" + }, + "productPrice": { + "type": "integer", + "format": "int64", + "description": "payment price as KRW" + }, + "currency": { + "type": "string", + "description": "KRW" + }, + "language": { + "type": "string", + "description": "ko" + }, + "buyerTel": { + "type": "string", + "description": "buyer phone number" + }, + "payMethod": { + "type": "string", + "description": "pay method (ex. card )" + }, + "naverProducts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NaverProductDto" + } + } + } + }, + "NaverProductDto": { + "type": "object", + "required": [ + "categoryType", + "categoryId", + "uid", + "name", + "count" + ], + "properties": { + "categoryType": { + "type": "string" + }, + "categoryId": { + "type": "string" + }, + "uid": { + "type": "string" + }, + "name": { + "type": "string" + }, + "count": { + "type": "integer", + "format": "int64" + } + } + }, + "StartConnectPayPaymentRequestDto": { + "type": "object", + "required": [ + "payMethod" + ], + "properties": { + "payMethod": { + "$ref": "#/components/schemas/ConnectPayPaymentMethodEnum" + } + } + }, + "ConnectPayPaymentMethodEnum": { + "type": "string", + "enum": [ + "CARD", + "ACCOUNT_TRANSFER" + ] + }, + "ConnectPayPaymentMaterialDto": { + "type": "object", + "required": [ + "clientKey", + "customerKey", + "amount", + "merchantId", + "title", + "successUrl", + "failUrl", + "redirectUrl" + ], + "properties": { + "clientKey": { + "type": "string", + "description": "์ปค๋„ฅํŠธํŽ˜์ด JS SDK ์ธ์ฆ์šฉ clientKey" + }, + "customerKey": { + "type": "string", + "description": "๊ฒฐ์ œ ์š”์ฒญ์‹œ ์‚ฌ์šฉ๋˜๋Š” user์˜ external uid" + }, + "amount": { + "type": "integer", + "format": "int64", + "description": "์‹ค์ œ ๊ฒฐ์ œ๋˜๋Š” ๊ธˆ์•ก (amount)" + }, + "merchantId": { + "type": "string", + "description": "์ฃผ๋ฌธ-๊ฒฐ์ œ๊ฑด์— ๋Œ€ํ•œ ๊ณ ์œ  ID (OrderID)" + }, + "title": { + "type": "string", + "description": "๊ฒฐ์ œ์— ๋Œ€ํ•œ ์ฃผ๋ฌธ๋ช… (OrderName)" + }, + "successUrl": { + "type": "string", + "description": "๊ฒฐ์ œ ์„ฑ๊ณต ์‹œ ๋ฆฌ๋‹ค์ด๋ ‰ํŠธ URL" + }, + "failUrl": { + "type": "string", + "description": "๊ฒฐ์ œ ์‹คํŒจ ์‹œ ๋ฆฌ๋‹ค์ด๋ ‰ํŠธ URL" + }, + "redirectUrl": { + "type": "string", + "description": "์ปค๋„ฅํŠธํŽ˜์ด OAuth ์ธ์ฆ ์‹œ ์‚ฌ์šฉ๋  redirect url" + } + } + }, + "StartTossPaymentRequestDto": { + "type": "object", + "required": [ + "payMethod" + ], + "properties": { + "payMethod": { + "$ref": "#/components/schemas/TossPaymentMethodEnum" + } + } + }, + "TossPaymentMethodEnum": { + "type": "string", + "enum": [ + "CARD", + "VIRTUAL_ACCOUNT", + "MOBILE", + "KAKAO_PAY", + "TOSS_PAY", + "APPLE_PAY" + ] + }, + "TossPaymentMaterialDto": { + "type": "object", + "required": [ + "clientKey", + "amount", + "payMethod", + "merchantId", + "title", + "successUrl", + "failUrl", + "customerMobilePhone" + ], + "properties": { + "clientKey": { + "type": "string" + }, + "amount": { + "type": "integer", + "format": "int64" + }, + "payMethod": { + "type": "string" + }, + "merchantId": { + "type": "string" + }, + "title": { + "type": "string" + }, + "successUrl": { + "type": "string" + }, + "failUrl": { + "type": "string" + }, + "virtualAccountCallbackUrl": { + "type": "string" + }, + "customerName": { + "type": "string" + }, + "customerMobilePhone": { + "type": "string" + } + } + }, + "DryRunPaymentMaterialDto": { + "type": "object", + "required": [ + "merchantId" + ], + "properties": { + "merchantId": { + "type": "string", + "description": "generated merchantId for this payment" + } + } + }, + "FreePaymentMaterialDto": { + "type": "object", + "required": [ + "merchantId" + ], + "properties": { + "merchantId": { + "type": "string", + "description": "generated merchantId for this payment" + } + } + }, + "OLCEstimationRequestDto": { + "type": "object", + "required": [ + "partials" + ], + "properties": { + "partials": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartialOrderItemDto" + } + } + } + }, + "PartialOrderItemDto": { + "type": "object", + "required": [ + "orderItemId", + "quantity" + ], + "properties": { + "orderItemId": { + "type": "string" + }, + "quantity": { + "type": "integer", + "format": "int64" + } + } + }, + "OrderItemPurchaseStateEnum": { + "type": "string", + "enum": [ + "WAIT", + "PAID", + "REFUNDED" + ] + }, + "ProductSearchingOrderByEnum": { + "type": "string", + "enum": [ + "MATCHING_SCORE_DESC", + "POPULARITY", + "RATING_DESC", + "FINAL_PRICE_DESC", + "FINAL_PRICE_ASC", + "DISCOUNT_PERCENTAGE_DESC", + "REVIEW_COUNT_DESC", + "REVIEW_RATING_AVG_DESC", + "CREATED_AT_DESC" + ] + }, + "OrderHistoryListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "MyOrderHistoryListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MyOrderHistoryDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "MyOrderHistoryDto": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OrderHistoryDto" + }, + { + "type": "object", + "properties": { + "orderSummary": { + "$ref": "#/components/schemas/MyOrderSummaryDto" + } + } + } + ] + }, + "OrderHistoryDto": { + "type": "object", + "required": [ + "orderSummary", + "deliveryRequest", + "purchaseResult" + ], + "properties": { + "orderSummary": { + "$ref": "#/components/schemas/OrderSummaryDto" + }, + "deliveryRequest": { + "$ref": "#/components/schemas/DeliveryRequestDto" + }, + "purchaseResult": { + "$ref": "#/components/schemas/PurchaseResultDto" + } + } + }, + "MyOrderLineTicketListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MyOrderLineTicketDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "MyOrderLineTicketDto": { + "type": "object", + "required": [ + "ticketType", + "createdAtMillis" + ], + "properties": { + "ticketType": { + "$ref": "#/components/schemas/OrderLineTicketEnum" + }, + "returnTicket": { + "$ref": "#/components/schemas/OrderLineReturnTicketWithOrderDto" + }, + "cancelTicket": { + "$ref": "#/components/schemas/OrderLineCancelTicketWithOrderDto" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + } + } + }, + "MyOLTicketsCountDto": { + "type": "object", + "required": [ + "cancelTicket", + "returnTicket" + ], + "properties": { + "cancelTicket": { + "$ref": "#/components/schemas/OrderLineTicketCountDto" + }, + "returnTicket": { + "$ref": "#/components/schemas/OrderLineTicketCountDto" + } + } + }, + "OrderLineTicketCountDto": { + "type": "object", + "required": [ + "inProgress", + "resolved" + ], + "properties": { + "inProgress": { + "description": "์ง„ํ–‰ ์ค‘ ์ธ (๋ฐ˜ํ’ˆ or ์ทจ์†Œ) ํ‹ฐ์ผ“ ์ˆ˜", + "type": "integer", + "format": "int32" + }, + "resolved": { + "description": "์ตœ๊ทผ 4์ผ ๋‚ด ์™„๋ฃŒ๋œ (๋ฐ˜ํ’ˆ or ์ทจ์†Œ) ํ‹ฐ์ผ“ ์ˆ˜", + "type": "integer", + "format": "int32" + } + } + }, + "DeliveryRequestDto": { + "type": "object", + "required": [ + "address" + ], + "properties": { + "address": { + "$ref": "#/components/schemas/DeliveryAddressDto" + }, + "request": { + "type": "string" + } + } + }, + "PurchaseResultDto": { + "type": "object", + "required": [ + "paymentId", + "payemntVendor", + "paymentMethod", + "paidAmount", + "refundedAmount", + "purchaseState" + ], + "properties": { + "paymentId": { + "type": "string" + }, + "paymentVendor": { + "type": "string" + }, + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethodEnum" + }, + "virtualAccount": { + "$ref": "#/components/schemas/VirtualAccountDto" + }, + "card": { + "$ref": "#/components/schemas/CardDto" + }, + "paidAmount": { + "type": "integer", + "format": "int64" + }, + "refundedAmount": { + "type": "integer", + "format": "int64" + }, + "purchaseState": { + "$ref": "#/components/schemas/PurchaseStateEnum" + }, + "completedAtMillis": { + "type": "integer", + "format": "int64" + } + } + }, + "VirtualAccountDto": { + "type": "object", + "required": [ + "accountNumber", + "bank", + "customerName" + ], + "properties": { + "accountNumber": { + "type": "string" + }, + "bank": { + "type": "string" + }, + "customerName": { + "type": "string" + }, + "dueDateMillis": { + "type": "integer", + "format": "int64" + } + } + }, + "CardDto": { + "type": "object", + "required": [ + "companyName" + ], + "properties": { + "companyName": { + "description": "์นด๋“œ์‚ฌ (e.g. ํ•˜๋‚˜, ์‹ ํ•œ, BC์นด๋“œ)", + "type": "string" + }, + "installmentPlanMonths": { + "description": "ํ• ๋ถ€ ๊ฐœ์›” ์ˆ˜ (0์ธ ๊ฒฝ์šฐ, ์ผ์‹œ๋ถˆ)", + "minimum": 0, + "format": "int32", + "type": "integer" + }, + "interestFreeInstallment": { + "description": "๋ฌด์ด์ž ํ• ๋ถ€ ์—ฌ๋ถ€", + "type": "boolean" + } + } + }, + "PaymentMethodEnum": { + "type": "string", + "enum": [ + "CARD", + "ACCOUNT_TRANSFER", + "KAKAO_PAY", + "NAVER_PAY", + "TOSS_PAY", + "VIRTUAL_ACCOUNT", + "DRY", + "MOBILE", + "FREE", + "APPLE_PAY" + ] + }, + "RefundPaymentMethodEnum": { + "type": "string", + "enum": [ + "CARD", + "ACCOUNT_TRANSFER", + "KAKAO_PAY", + "NAVER_PAY", + "TOSS_PAY", + "VIRTUAL_ACCOUNT", + "DRY", + "MOBILE", + "FREE", + "APPLE_PAY", + "POINT" + ] + }, + "RefundPaymentVendorEnum": { + "type": "string", + "enum": [ + "IAMPORT", + "TOSS_PAYMENTS", + "DRY_RUN", + "CONNECT_PAY", + "FREE" + ] + }, + "PurchaseStateEnum": { + "type": "string", + "enum": [ + "WAIT", + "WAITING_FOR_DEPOSIT", + "COMPLETED", + "ABORTED" + ] + }, + "MyOrderSummaryDto": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OrderSummaryDto" + }, + { + "type": "object", + "required": [ + "itemGroups" + ], + "properties": { + "itemGroups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MyOrderItemGroupDto" + } + } + } + } + ] + }, + "OrderSummaryDto": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/PriceSetDto" + }, + { + "type": "object", + "required": [ + "orderId", + "itemGroups", + "createdAtMillis" + ], + "properties": { + "id": { + "type": "string", + "description": "(deprecated) use orderId" + }, + "orderId": { + "type": "string" + }, + "costElements": { + "type": "array", + "description": "- PriceSetDto ์˜ ๊ฐ€๊ฒฉ ์ƒ์„ธ๋ฅผ ํ‘œํ˜„ํ•˜๊ธฐ ์œ„ํ•œ ํ•„๋“œ\n- ์ ์ง„์ ์œผ๋กœ ํ™•์žฅํ•ด ๋‚˜๊ฐ€๋‚˜, ํ˜„์žฌ๋Š” ๋ฐฐ์†ก๋น„์— ๋Œ€ํ•œ ์ƒ์„ธ ์ •๋ณด๋งŒ ํ‘œ์‹œํ•œ๋‹ค.\n", + "items": { + "$ref": "#/components/schemas/CostElementDto" + } + }, + "appliedCouponCode": { + "type": "string", + "description": "appliedCoupon.coupon.code ๋ฅผ ํ†ตํ•ด ์ ‘๊ทผํ•˜๋„๋ก ํ•ฉ๋‹ˆ๋‹ค.", + "deprecated": true + }, + "appliedCoupon": { + "$ref": "#/components/schemas/IssuedCouponDto" + }, + "itemGroups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderItemGroupDto" + } + }, + "confirmedAtMillis": { + "type": "integer", + "format": "int64" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + } + } + } + ] + }, + "PriceSetDeltaDto": { + "type": "object", + "required": [ + "totalProductPrice", + "totalDeliveryPrice", + "serviceCharge", + "discountAmount", + "finalPurchaseAmount" + ], + "properties": { + "totalProductPrice": { + "type": "integer", + "format": "int64" + }, + "totalDeliveryPrice": { + "type": "integer", + "format": "int64" + }, + "serviceCharge": { + "type": "integer", + "format": "int64" + }, + "discountAmount": { + "type": "integer", + "format": "int64" + }, + "finalPurchaseAmount": { + "type": "integer", + "format": "int64" + }, + "usePoint": { + "type": "integer", + "format": "int64" + }, + "costElements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CostElementDto" + } + } + } + }, + "DeliveryPriceDto": { + "type": "object", + "required": [ + "normal", + "jeju", + "backCountry" + ], + "properties": { + "normal": { + "type": "integer", + "format": "int64" + }, + "jeju": { + "type": "integer", + "format": "int64" + }, + "backCountry": { + "type": "integer", + "format": "int64" + } + } + }, + "PriceSetDto": { + "type": "object", + "required": [ + "totalProductPrice", + "totalDeliveryPrice", + "serviceCharge", + "discountAmount", + "finalPurchaseAmount" + ], + "properties": { + "totalProductPrice": { + "type": "integer", + "format": "int64" + }, + "totalDeliveryPrice": { + "type": "integer", + "format": "int64" + }, + "serviceCharge": { + "type": "integer", + "format": "int64" + }, + "discountAmount": { + "type": "integer", + "format": "int64" + }, + "finalPurchaseAmount": { + "type": "integer", + "format": "int64" + }, + "usePoint": { + "type": "integer", + "format": "int64" + } + } + }, + "MyOrderItemGroupDto": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OrderItemGroupDto" + }, + { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MyOrderItemDto" + } + } + } + } + ] + }, + "OrderItemGroupDto": { + "type": "object", + "required": [ + "groupId", + "mall", + "brand", + "deliveryPrice", + "items" + ], + "properties": { + "groupId": { + "type": "string" + }, + "mall": { + "$ref": "#/components/schemas/MallDto" + }, + "brand": { + "$ref": "#/components/schemas/BrandDto" + }, + "costElements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CostElementDto" + } + }, + "deliveryPrice": { + "type": "integer", + "format": "int64" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderItemDto" + } + } + } + }, + "CostElementDto": { + "type": "object", + "required": [ + "type", + "amount" + ], + "description": "- ๊ฐ€๊ฒฉ์˜ ์ƒ์„ธ ์ •๋ณด๋ฅผ ํ‘œํ˜„ํ•˜๋Š” DTO\n- ํ˜„์žฌ ๋ฐฐ์†ก๋น„, ๋ฐ˜ํ’ˆ๋น„์— ๋Œ€ํ•ด์„œ๋งŒ ์ƒ์„ธ์ •๋ณด๊ฐ€ ์กด์žฌํ•œ๋‹ค.\n", + "properties": { + "type": { + "$ref": "#/components/schemas/CostTypeEnum" + }, + "amount": { + "type": "integer", + "format": "int64" + } + } + }, + "CostTypeEnum": { + "type": "string", + "enum": [ + "SHIPPING_COST_NORMAL", + "SHIPPING_COST_JEJU", + "SHIPPING_COST_BACK_COUNTRY", + "RETURN_COST_NORMAL", + "RETURN_COST_JEJU", + "RETURN_COST_BACK_COUNTRY", + "RETURN_COST_TO_REFUND_FREE_SHIPPING" + ] + }, + "MyOrderItemDto": { + "allOf": [ + { + "$ref": "#/components/schemas/OrderItemDto" + }, + { + "type": "object", + "required": [ + "reviewCreatable" + ], + "properties": { + "review": { + "$ref": "#/components/schemas/ProductReviewDto" + }, + "reviewCreationExpirationDays": { + "type": "integer", + "format": "int64" + }, + "paidAtMillis": { + "type": "integer", + "format": "int64" + }, + "reviewCreatable": { + "type": "boolean" + }, + "estimateShipmentAt": { + "type": "string", + "description": "์ฃผ๋ฌธ ์‹œ์  ๊ธฐ์ค€ ์ƒํ’ˆ์˜ ์ถœ๊ณ ์˜ˆ์ •์ผ(ISO DATE, uuuu-MM-dd)" + } + } + } + ] + }, + "DividedOrderItemDto": { + "allOf": [ + { + "$ref": "#/components/schemas/OrderItemDto" + }, + { + "type": "object", + "required": [ + "dividedFromId" + ], + "properties": { + "dividedFromId": { + "type": "string" + } + } + } + ] + }, + "EachOLCEstimationDto": { + "required": [ + "orderItemId", + "quantity", + "totalProductPrice", + "totalDiscountAmount", + "finalPurchaseAmount", + "usePoint" + ], + "properties": { + "orderItemId": { + "type": "string" + }, + "totalProductPrice": { + "type": "integer", + "format": "int64" + }, + "finalPurchaseAmount": { + "type": "integer", + "format": "int64" + }, + "totalDiscountAmount": { + "type": "integer", + "format": "int64" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "usePoint": { + "type": "integer", + "format": "int64" + } + } + }, + "EachOLREstimationDto": { + "required": [ + "orderItemId", + "quantity", + "totalProductPrice", + "totalDiscountAmount", + "finalPurchaseAmount", + "usePoint" + ], + "properties": { + "orderItemId": { + "type": "string" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "totalProductPrice": { + "type": "integer", + "format": "int64" + }, + "finalPurchaseAmount": { + "type": "integer", + "format": "int64" + }, + "totalDiscountAmount": { + "type": "integer", + "format": "int64" + }, + "usePoint": { + "type": "integer", + "format": "int64" + } + } + }, + "OrderItemDto": { + "required": [ + "id", + "product", + "productItem", + "singlePrice", + "quantity", + "singleDirectDiscountAmount", + "totalPrice", + "state", + "purchaseState", + "delivery", + "totalProductPrice", + "finalPurchaseAmount", + "totalDiscountAmount", + "totalDirectDiscountAmount", + "brand", + "receiptConfirmation", + "finalSinglePrice", + "freeReturnTarget" + ], + "properties": { + "id": { + "type": "string" + }, + "product": { + "$ref": "#/components/schemas/ProductDto" + }, + "productItem": { + "$ref": "#/components/schemas/ProductItemDto" + }, + "singlePrice": { + "description": "์ƒํ’ˆ ๊ฐ€๊ฒฉ (ํ€ธ์ž‡ ์ฆ‰์‹œํ• ์ธ ๋ฐ˜์˜ ์•ˆ๋จ)", + "type": "integer", + "format": "int64" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "singleDirectDiscountAmount": { + "description": "ํ€ธ์ž‡ ์ฆ‰์‹œ ํ• ์ธ์•ก", + "type": "integer", + "format": "int64" + }, + "totalPrice": { + "description": "(deprecated) Use `totalProductPrice` instead.", + "type": "integer", + "format": "int64" + }, + "totalProductPrice": { + "description": "์ด ์ƒํ’ˆ๊ฐ€์•ก (`(singlePrice - singleDirectDiscountAmount) * quantity`)", + "type": "integer", + "format": "int64" + }, + "finalPurchaseAmount": { + "description": "์‹ค์ œ ๊ฒฐ์ œ์•ก (`totalProductPrice - totalDiscountAmount - usePoint`)", + "type": "integer", + "format": "int64" + }, + "usePoint": { + "description": "์‚ฌ์šฉํฌ์ธํŠธ", + "type": "integer", + "format": "int64" + }, + "totalDiscountAmount": { + "description": "์ด ์žฅ๋ฐ”๊ตฌ๋‹ˆ ์ฟ ํฐ ํ• ์ธ์•ก (`singleDiscountAmount * quantity + residueDiscountAmount`)", + "type": "integer", + "format": "int64" + }, + "totalDirectDiscountAmount": { + "description": "์ด ํ€ธ์ž‡ ์ฆ‰์‹œ ํ• ์ธ์•ก (`singleDirectDiscountAmount * quantity`)", + "type": "integer", + "format": "int64" + }, + "finalSinglePrice": { + "description": "์ƒํ’ˆ๊ฐ€์•ก (`singlePrice - singleDirectDiscountAmount`)", + "type": "integer", + "format": "int64" + }, + "state": { + "$ref": "#/components/schemas/OrderStateEnum" + }, + "purchaseState": { + "$ref": "#/components/schemas/OrderItemPurchaseStateEnum" + }, + "delivery": { + "$ref": "#/components/schemas/DeliveryProgressDto" + }, + "primaryCancelTicket": { + "$ref": "#/components/schemas/OLCTicketDto" + }, + "primaryReturnTicket": { + "$ref": "#/components/schemas/OLRTicketDto" + }, + "brand": { + "$ref": "#/components/schemas/BrandDto" + }, + "receiptConfirmation": { + "type": "boolean" + }, + "receiptConfirmedAtMillis": { + "type": "integer", + "format": "int64" + }, + "freeReturnTarget": { + "type": "boolean" + } + } + }, + "DeliveryProgressDto": { + "type": "object", + "required": [ + "state" + ], + "properties": { + "vendorName": { + "type": "string" + }, + "vendorDeliveryNumber": { + "type": "string" + }, + "detailUrl": { + "type": "string" + }, + "state": { + "$ref": "#/components/schemas/DeliveryStateEnum" + }, + "shippedAtMillis": { + "description": "ํ•ด๋‹น ์ฃผ๋ฌธ์ด ์ถœ๊ณ ๋œ ์‹œ์ ์ž…๋‹ˆ๋‹ค. ํ˜„์žฌ๋Š” ๋ฐฐ์†ก ์ค‘์œผ๋กœ ๋ณ€๊ฒฝ๋œ ์‹œ๊ฐ„์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค.", + "type": "integer", + "format": "int64" + } + } + }, + "DeliveryStateEnum": { + "type": "string", + "enum": [ + "WAIT", + "PREPARING", + "IN_DELIVERY", + "COMPLETED", + "CANCELLED" + ] + }, + "OrderByEnum": { + "type": "string", + "enum": [ + "ASC", + "DESC" + ] + }, + "ProductOrderByEnum": { + "type": "string", + "enum": [ + "RECOMMENDATION", + "POPULARITY", + "CREATED_AT_DESC", + "FINAL_PRICE_DESC", + "FINAL_PRICE_ASC", + "DISCOUNT_PERCENTAGE_DESC", + "REVIEW_COUNT_DESC", + "REVIEW_RATING_AVG_DESC" + ] + }, + "OrderStateEnum": { + "type": "string", + "enum": [ + "WAIT", + "PURCHASED", + "REFUNDED", + "PREPARING_PRODUCTS", + "IN_DELIVERY", + "DELIVERY_COMPLETED", + "ABORTED" + ] + }, + "OrderLineTicketStateEnum": { + "type": "string", + "description": "์ทจ์†Œ(๋ฐ˜ํ’ˆ) ์š”์ฒญ ์ƒํƒœ\n- SUBMITTED: ์ทจ์†Œ(๋ฐ˜ํ’ˆ)๊ฐ€ ์š”์ฒญ๋จ\n- CONFIRMED: ์ทจ์†Œ(๋ฐ˜ํ’ˆ) ์š”์ฒญ์„ ์Šน์ธํ•จ (์ฒ˜๋ฆฌ ์ง„ํ–‰ ์ค‘)\n- RESOLVED: ์ทจ์†Œ(๋ฐ˜ํ’ˆ) ์š”์ฒญ์ด ์ข…๊ฒฐ๋จ (๊ณ ๊ฐ์—๊ฒŒ ๊ธˆ์•ก ํ™˜๋ถˆ๋จ)\n- WITHDRAWN: ์ทจ์†Œ(๋ฐ˜ํ’ˆ) ์š”์ฒญ์„ ๊ณ ๊ฐ์ด ์ฒ ํšŒํ•จ\n- REJECTED: ์ทจ์†Œ(๋ฐ˜ํ’ˆ) ์š”์ฒญ์„ ์…€๋Ÿฌ/์–ด๋“œ๋ฏผ์ด ๋ฐ˜๋ คํ•จ\n", + "enum": [ + "SUBMITTED", + "CONFIRMED", + "RESOLVED", + "WITHDRAWN", + "REJECTED" + ] + }, + "OrderLineReturnStateEnum": { + "type": "string", + "description": "๋ฐ˜ํ’ˆ ์š”์ฒญ ์ƒํƒœ\n- WAITING : ๊ณ ๊ฐ์ด ๋ฐ˜ํ’ˆ ์š”์ฒญํ•˜๊ณ  ์…€๋Ÿฌ/์–ด๋“œ๋ฏผ์˜ ์Šน์ธ ๋Œ€๊ธฐ๋ฅผ ๊ธฐ๋‹ค๋ฆฌ๋Š” ์ƒํƒœ\n- IN_RECALL_DELIVERY_READY : (๊ตฟ์Šคํ”Œ๋กœ ์—ฐ๋™์ธ ๊ฒฝ์šฐ์—๋งŒ) ์Šน์ธ ํ›„, ํšŒ์ˆ˜ ์ค€๋น„\n- IN_RECALL_DELIVERY_PROCESSING : (๊ตฟ์Šคํ”Œ๋กœ ์—ฐ๋™์ธ ๊ฒฝ์šฐ) ๋ฐฐ์†ก๊ธฐ์‚ฌ ํ”ฝ์—… ํ›„ ์ธ๊ณ„๋ฐ›์€ ํ›„, ๋ฐ˜ํ’ˆ์ง€ ์ฃผ์†Œ๋กœ ํšŒ์ˆ˜ ์ค‘. (๊ตฟ์Šคํ”Œ๋กœ ์—ฐ๋™ ์•„๋‹Œ ๊ฒฝ์šฐ์—๋Š” ์…€๋Ÿฌ์— ์˜ํ•œ ํšŒ์ˆ˜์ค‘)\n- RECALL_DELIVERY_COMPLETED : (๊ตฟ์Šคํ”Œ๋กœ ์—ฐ๋™์ธ ๊ฒฝ์šฐ์—๋งŒ) ํšŒ์ˆ˜ ๊ฑด ๋ฐฐ๋‹ฌ์™„๋ฃŒ(๊ฒ€์ˆ˜ ์ค‘)\n- REJECTED : ๋ฐ˜ํ’ˆ ์š”์ฒญ ์ข…๊ฒฐ(์…€๋Ÿฌ/์–ด๋“œ๋ฏผ์ด ๋ฐ˜ํ’ˆ ์š”์ฒญ ๋ฐ˜๋ ค)\n- RESOLVED : ๋ฐ˜ํ’ˆ ์š”์ฒญ์ด ์ข…๊ฒฐ(๊ณ ๊ฐ์—๊ฒŒ ๊ธˆ์•ก ํ™˜๋ถˆ)\n- WITHDRAWN : ๋ฐ˜ํ’ˆ ์š”์ฒญ ํ›„ ๊ณ ๊ฐ์ด ์ฒ ํšŒ\n", + "enum": [ + "WAITING", + "IN_RECALL_DELIVERY_READY", + "IN_RECALL_DELIVERY_PROCESSING", + "RECALL_DELIVERY_COMPLETED", + "REJECTED", + "RESOLVED", + "WITHDRAWN" + ] + }, + "OrderLineTicketEnum": { + "description": "- ์ฃผ๋ฌธ์„œ ํ‹ฐ์ผ“ ํƒ€์ž…\n- CANCEL : ์ทจ์†Œ\n- RETURN : ๋ฐ˜ํ’ˆ\n", + "type": "string", + "enum": [ + "CANCEL", + "RETURN" + ] + }, + "AuditorGroupEnum": { + "type": "string", + "description": "ํ‹ฐ์ผ“ ์ƒํƒœ๋ฅผ ๋ณ€๊ฒฝํ•œ ์ฃผ์ฒด์ž ๋‹จ์œ„\n- SYSTEM: ์‹œ์Šคํ…œ์— ์˜ํ•ด ์ž๋™์œผ๋กœ ์ƒํƒœ๊ฐ€ ๋ณ€๊ฒฝ๋จ\n- CX_ADMIN: CXํŒ€์— ์˜ํ•ด ์ƒํƒœ๊ฐ€ ๋ณ€๊ฒฝ๋จ\n- SELLER_ADMIN: ์…€๋Ÿฌ์— ์˜ํ•ด ์ƒํƒœ๊ฐ€ ๋ณ€๊ฒฝ๋จ\n- USER: ๊ณ ๊ฐ์— ์˜ํ•ด ์ƒํƒœ๊ฐ€ ๋ณ€๊ฒฝ๋จ\n", + "enum": [ + "SYSTEM", + "CX_ADMIN", + "SELLER_ADMIN", + "USER" + ] + }, + "OLCEstimationDto": { + "type": "object", + "required": [ + "priceDelta" + ], + "properties": { + "orderItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderItemDto" + } + }, + "priceDelta": { + "$ref": "#/components/schemas/PriceSetDeltaDto" + } + } + }, + "OLCEstimationResultDto": { + "type": "object", + "required": [ + "priceDelta", + "eachEstimations" + ], + "properties": { + "eachEstimations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EachOLCEstimationDto" + } + }, + "priceDelta": { + "$ref": "#/components/schemas/PriceSetDeltaDto" + }, + "refundPaymentInfos": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RefundPaymentInfoDto" + } + } + } + }, + "OLCRequestDto": { + "type": "object", + "required": [ + "partials", + "reason" + ], + "properties": { + "partials": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartialOrderItemDto" + } + }, + "reason": { + "type": "string" + } + } + }, + "OLCTicketDto": { + "type": "object", + "required": [ + "ticketId", + "state", + "reason", + "createdAtMillis", + "orderItems" + ], + "properties": { + "ticketId": { + "type": "string" + }, + "state": { + "$ref": "#/components/schemas/OrderLineTicketStateEnum" + }, + "auditorGroup": { + "$ref": "#/components/schemas/AuditorGroupEnum" + }, + "reason": { + "type": "string" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + }, + "confirmedAtMillis": { + "type": "integer", + "format": "int64" + }, + "withdrawnAtMillis": { + "type": "integer", + "format": "int64" + }, + "rejectedAtMillis": { + "type": "integer", + "format": "int64" + }, + "rejectReason": { + "type": "string" + }, + "resolvedAtMillis": { + "type": "integer", + "format": "int64" + }, + "resolvedPriceDelta": { + "$ref": "#/components/schemas/PriceSetDeltaDto" + }, + "refundPaymentInfos": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RefundPaymentInfoDto" + } + }, + "orderItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderItemDto" + } + } + } + }, + "OrderLineCancelTicketWithOrderDto": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OLCTicketDto" + }, + { + "type": "object", + "required": [ + "linkedOrder" + ], + "properties": { + "linkedOrder": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + } + ] + }, + "OLREstimateRequestDto": { + "type": "object", + "required": [ + "isCustomerNegligence", + "partials" + ], + "properties": { + "isCustomerNegligence": { + "type": "boolean" + }, + "partials": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartialOrderItemDto" + } + } + } + }, + "OLREstimationResultDto": { + "type": "object", + "required": [ + "priceDelta", + "eachEstimations" + ], + "properties": { + "eachEstimations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EachOLREstimationDto" + } + }, + "priceDelta": { + "$ref": "#/components/schemas/PriceSetDeltaDto" + }, + "refundPaymentInfos": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RefundPaymentInfoDto" + } + } + } + }, + "OLRRequestDto": { + "type": "object", + "required": [ + "partials", + "isCustomerNegligence", + "returnAddress", + "reason" + ], + "properties": { + "partials": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartialOrderItemDto" + } + }, + "isCustomerNegligence": { + "type": "boolean" + }, + "returnAddress": { + "$ref": "#/components/schemas/DeliveryAddressDto" + }, + "reason": { + "type": "string" + }, + "imageUrls": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "OLRTicketDto": { + "type": "object", + "required": [ + "ticketId", + "state", + "returnState", + "isCustomerNegligence", + "returnAddress", + "reason", + "createdAtMillis", + "orderItems" + ], + "properties": { + "ticketId": { + "type": "string" + }, + "isCustomerNegligence": { + "type": "boolean" + }, + "returnAddress": { + "$ref": "#/components/schemas/DeliveryAddressDto" + }, + "state": { + "$ref": "#/components/schemas/OrderLineTicketStateEnum" + }, + "returnState": { + "$ref": "#/components/schemas/OrderLineReturnStateEnum" + }, + "auditorGroup": { + "$ref": "#/components/schemas/AuditorGroupEnum" + }, + "reason": { + "type": "string" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + }, + "confirmedAtMillis": { + "type": "integer", + "format": "int64" + }, + "withdrawnAtMillis": { + "type": "integer", + "format": "int64" + }, + "rejectedAtMillis": { + "type": "integer", + "format": "int64" + }, + "rejectReason": { + "type": "string" + }, + "resolvedAtMillis": { + "type": "integer", + "format": "int64" + }, + "resolvedPriceDelta": { + "$ref": "#/components/schemas/PriceSetDeltaDto" + }, + "refundPaymentInfos": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RefundPaymentInfoDto" + } + }, + "orderItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderItemDto" + } + }, + "imageUrls": { + "type": "array", + "description": "original image urls", + "items": { + "type": "string" + } + }, + "multiResolutionImages": { + "$ref": "#/components/schemas/MultiResolutionImageListDto" + }, + "recallDeliveryProgress": { + "$ref": "#/components/schemas/OLRTRecallDeliveryProgressDto" + } + } + }, + "OLRTRecallDeliveryProgressDto": { + "type": "object", + "description": "null ์ผ๊ฒฝ์šฐ GoodsFlow ํšŒ์ˆ˜ ์—ฐ๋™์ค‘์ธ ์ƒํ’ˆ์ด ์•„๋‹˜", + "properties": { + "recallDeliveryVendor": { + "$ref": "#/components/schemas/DeliveryVendorEnum" + }, + "recallDeliveryVendorNumber": { + "description": "์†ก์žฅ ๋ฒˆํ˜ธ", + "type": "string" + }, + "requestable": { + "description": "์žฌํšŒ์ˆ˜ ์š”์ฒญ ๊ฐ€๋Šฅ ์—ฌ๋ถ€", + "type": "boolean" + }, + "recallState": { + "$ref": "#/components/schemas/RecallDeliveryStateEnum" + }, + "recallDeliveryCompletedAtMillis": { + "description": "ํšŒ์ˆ˜ ์™„๋ฃŒ์ผ", + "type": "integer", + "format": "int64" + }, + "recallDeliveryTraceUrl": { + "description": "ํšŒ์ˆ˜ ํŠธ๋ž˜ํ‚น URL", + "type": "string" + } + } + }, + "OrderLineReturnTicketWithOrderDto": { + "allOf": [ + { + "$ref": "#/components/schemas/OLRTicketDto" + }, + { + "type": "object", + "required": [ + "linkedOrder" + ], + "properties": { + "linkedOrder": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + } + ] + }, + "RefundPaymentInfoDto": { + "type": "object", + "description": "ํ™˜๋ถˆ ๊ฒฐ์ œ ์ˆ˜๋‹จ", + "required": [ + "paymentMethod" + ], + "properties": { + "paymentMethod": { + "$ref": "#/components/schemas/RefundPaymentMethodEnum" + }, + "paymentVendor": { + "$ref": "#/components/schemas/RefundPaymentVendorEnum" + }, + "detail": { + "description": "ํ™˜๋ถˆ ๊ฒฐ์ œ ์ˆ˜๋‹จ๋ณ„ ์ƒ์„ธ ์„ค๋ช…(์นด๋“œ๊ฒฐ์ œ์˜ ๊ฒฝ์šฐ ์นด๋“œ์‚ฌ ์ •๋ณด)", + "type": "string" + } + } + }, + "DeliveryVendorEnum": { + "description": "- (์ฃผ๋ฌธ/์†ก์žฅ ์ •๋ณด ๊ด€๋ จ) ์„ค์ • ๊ฐ€๋Šฅํ•œ ํƒ๋ฐฐ์‚ฌ\n- `ETC (๊ธฐํƒ€๋ฐฐ์†ก์‚ฌ)` -> ํŠน์ • ๋ฐฐ์†ก์‚ฌ๋ฅผ ์ด์šฉ์ค‘์ด์ง€๋งŒ, ํ˜„์žฌ ์ง€์›ํ•˜๊ณ  ์žˆ์ง€ ์•Š์€ ํƒ๋ฐฐ์‚ฌ (๊ธฐํƒ€๋ฐฐ์†ก์‚ฌ์— ๋Œ€ํ•œ ์ง€์›์ด ํ•„์š”ํ•œ ๊ฒฝ์šฐ, ๋ณ„๋„ ๋ฌธ์˜์ฃผ์„ธ์š”)\n- `SELF_MANAGED (์ง์ ‘๋ฐฐ์†ก)` -> ์ง์ ‘ ๋ฐฐ์†กํ•˜๋Š” ๊ฒฝ์šฐ์— ์‚ฌ์šฉ\n\n## ์ฝ”๋“œ๋ณ„ ์—ฐ๊ฒฐ๋˜๋Š” ๋ฐฐ์†ก์‚ฌ\n\n- CJ_GLS # CJ๋Œ€ํ•œํ†ต์šด\n- LOGEN # ๋กœ์  ํƒ๋ฐฐ\n- EPOST # ์šฐ์ฒด๊ตญํƒ๋ฐฐ\n- HANJIN # ํ•œ์ง„ํƒ๋ฐฐ\n- LOTTE # ๋กฏ๋ฐํƒ๋ฐฐ\n- DAESIN # ๋Œ€์‹ ํƒ๋ฐฐ\n- ILYANG # ์ผ์–‘ํƒ๋ฐฐ\n- KYUNGDONG # ๊ฒฝ๋™ํƒ๋ฐฐ\n- HAPDONG # ํ•ฉ๋™ํƒ๋ฐฐ\n- CHUNIL # ์ฒœ์ผํƒ๋ฐฐ\n- CVSNET # GSํŽธ์˜์ ํƒ๋ฐฐ\n- HPL # ํ•œ์˜์‚ฌ๋ž‘ํƒ๋ฐฐ\n- KUNYOUNG # ๊ฑด์˜ํƒ๋ฐฐ\n- HONAM # ํ˜ธ๋‚จํƒ๋ฐฐ\n- SLX # SLX\n- BGF # CUํŽธ์˜์ ํƒ๋ฐฐ\n- YONGMA # ์šฉ๋งˆ๋กœ์ง€์Šค\n- SEBANG # ์„ธ๋ฐฉํƒ๋ฐฐ\n- WONDERS # ์›๋”์Šคํ€ต\n- NH_LOGIS # ๋†ํ˜‘ํƒ๋ฐฐ\n- HI_LOGIS # HIํƒ๋ฐฐ\n- HOMEPICK # ํ™ˆํ”ฝํƒ๋ฐฐ\n- KOREX_G # CJ๋Œ€ํ•œํ†ต์šด๊ตญ์ œํŠน์†ก\n- EMS # EMS\n- LOTTE_GLOBAL # ๋กฏ๋ฐ๊ธ€๋กœ๋ฒŒ\n- HANDEX # ํ•œ๋ฑ์Šค\n- DHL # DHL\n- FEDEX # FEDEX\n- UPS # UPS\n- TNT # TNT\n- PANTOS # ๋ฒ”ํ•œํŒํ† ์Šค\n- ACI_EXPRESS # ACI Express\n- ACE_EXP # ACE Express\n- EUNHA # ์€ํ•˜์‰ฌํ•‘\n- CHAIN_LOGISTICS # ๋‘๋ฐœํžˆ์–ด๋กœ\n- LOGISPOT # ๋กœ์ง€์ŠคํŒŸ\n- VROONG # ๋ถ€๋ฆ‰(VROONG)\n- ETOMARS # ์ดํˆฌ๋งˆ์Šค\n- VENDORPIA # ์—์ด์Šค๋ฌผ๋ฅ˜\n- DAERIM # ๋Œ€๋ฆผํ†ต์šด\n- VALEX # ๋ฐœ๋ ‰์Šค\n- ETC # ๊ธฐํƒ€๋ฐฐ์†ก์‚ฌ\n- SELF_MANAGED # ์ง์ ‘๋ฐฐ์†ก\n", + "type": "string", + "enum": [ + "CJ_GLS", + "LOGEN", + "EPOST", + "HANJIN", + "LOTTE", + "DAESIN", + "ILYANG", + "KYUNGDONG", + "HAPDONG", + "CHUNIL", + "CVSNET", + "HPL", + "KUNYOUNG", + "HONAM", + "SLX", + "BGF", + "YONGMA", + "SEBANG", + "WONDERS", + "NH_LOGIS", + "HI_LOGIS", + "HOMEPICK", + "KOREX_G", + "EMS", + "LOTTE_GLOBAL", + "HANDEX", + "DHL", + "FEDEX", + "UPS", + "TNT", + "PANTOS", + "ACI_EXPRESS", + "ACE_EXP", + "EUNHA", + "CHAIN_LOGISTICS", + "LOGISPOT", + "VROONG", + "ETOMARS", + "VENDORPIA", + "DAERIM", + "VALEX", + "ETC", + "SELF_MANAGED" + ] + }, + "RecallDeliveryStateEnum": { + "type": "string", + "enum": [ + "WAIT", + "PREPARING", + "IN_DELIVERY", + "COMPLETED", + "CANCELED", + "FAILED" + ] + }, + "BannerDto": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BannerDataDto" + }, + { + "type": "object", + "required": [ + "id", + "multiResolutionImage" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "multiResolutionImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "displayProducts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BannerDisplayProductDto" + } + } + } + } + ] + }, + "BannerDisplayProductDto": { + "type": "object", + "required": [ + "productId", + "imageUrl", + "finalPrice", + "title", + "brandName", + "discountPercentage" + ], + "properties": { + "productId": { + "type": "string" + }, + "imageUrl": { + "type": "string" + }, + "finalPrice": { + "type": "integer", + "format": "int64" + }, + "title": { + "description": "์ƒํ’ˆ ์ด๋ฆ„", + "type": "string" + }, + "brandName": { + "type": "string" + }, + "discountPercentage": { + "description": "originalPrice ๋Œ€๋น„ finalPrice ๋Œ€๋น„ ์ƒํ’ˆ ํ• ์ธ๋ฅ ", + "type": "integer", + "format": "int32" + }, + "maximumBenefitCouponAppliedFinalPrice": { + "type": "integer", + "format": "int64" + }, + "originalToMaximumBenefitCouponPricePercentage": { + "description": "originalPrice ๋Œ€๋น„ maximumBenefitCouponAppliedFinalPrice ๋Œ€๋น„ ์ƒํ’ˆ ํ• ์ธ๋ฅ ", + "type": "integer", + "format": "int32" + } + } + }, + "BannerDataDto": { + "type": "object", + "required": [ + "type", + "imageUrl", + "linkUrl", + "title", + "enabled", + "note" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/BannerTypeEnum" + }, + "categoryId": { + "type": "string" + }, + "brandId": { + "type": "string" + }, + "brandSourcingTagId": { + "type": "string" + }, + "displayProductIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "displayProductCount": { + "type": "integer" + }, + "imageUrl": { + "type": "string" + }, + "linkUrl": { + "type": "string" + }, + "startAtMillis": { + "type": "integer", + "format": "int64" + }, + "endAtMillis": { + "type": "integer", + "format": "int64" + }, + "title": { + "type": "string" + }, + "subTitle": { + "type": "string" + }, + "enabled": { + "description": "(deprecated) enabled", + "type": "boolean" + }, + "note": { + "description": "(deprecated) note", + "type": "string" + } + } + }, + "BannerTypeEnum": { + "type": "string", + "description": "SECTIONX is deprecated", + "enum": [ + "MAIN", + "STYLE", + "SUB", + "DISCOUNT", + "CATEGORY", + "BRAND", + "SECTION1", + "SECTION2", + "SPARE", + "BEST_TOP", + "DEPARTMENT_STORE", + "OUTLET", + "HOME_SHOPPING", + "SOHO_MALL", + "QUEENIT_EXCLUSIVE", + "DESIGNER", + "MAGAZINE", + "EVENT", + "BRAND_PROMOTION", + "SEARCH_HOME", + "MAIN_V2" + ] + }, + "CollectionListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CollectionDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "CollectionDto": { + "type": "object", + "required": [ + "id", + "title", + "elements" + ], + "properties": { + "id": { + "type": "string" + }, + "title": { + "type": "string" + }, + "elements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CollectionElementDto" + } + } + } + }, + "CollectionElementDto": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/CollectionElementTypeEnum" + }, + "text": { + "$ref": "#/components/schemas/TextCollectionElementDto" + }, + "image": { + "$ref": "#/components/schemas/ImageCollectionElementDto" + }, + "products": { + "$ref": "#/components/schemas/ProductsCollectionElementDto" + }, + "videos": { + "$ref": "#/components/schemas/VideosCollectionElementDto" + }, + "link": { + "$ref": "#/components/schemas/LinkCollectionElementDto" + }, + "campaign": { + "$ref": "#/components/schemas/CampaignCollectionElementDto" + }, + "coupon": { + "$ref": "#/components/schemas/CouponCollectionElementDto" + }, + "imageLink": { + "$ref": "#/components/schemas/ImageLinkCollectionElementDto" + }, + "markdown": { + "$ref": "#/components/schemas/MarkdownCollectionElementDto" + }, + "pointPromotion": { + "$ref": "#/components/schemas/PointPromotionCollectionElementDto" + }, + "attendanceCheck": { + "$ref": "#/components/schemas/AttendanceCheckCollectionElementDto" + } + } + }, + "TextCollectionElementDto": { + "type": "object", + "required": [ + "type", + "text" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/CollectionTextTypeEnum" + }, + "text": { + "type": "string" + } + } + }, + "CollectionTextTypeEnum": { + "type": "string", + "enum": [ + "TITLE", + "SUBTITLE", + "BODY", + "DESCRIPTION" + ] + }, + "ImageCollectionElementDto": { + "required": [ + "imageUrl" + ], + "type": "object", + "properties": { + "imageUrl": { + "type": "string" + } + } + }, + "ImageLinkCollectionElementDto": { + "type": "object", + "required": [ + "imageUrl", + "linkUrl" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/ImageLinkTypeEnum" + }, + "imageUrl": { + "type": "string" + }, + "linkUrl": { + "type": "string" + }, + "campaign": { + "type": "string" + } + } + }, + "ProductsCollectionElementDto": { + "type": "object", + "required": [ + "columnCount", + "products", + "freeReturnTargetProductIds" + ], + "properties": { + "title": { + "type": "string" + }, + "columnCount": { + "type": "integer", + "format": "int32" + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDto" + } + }, + "freeReturnTargetProductIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "FreeReturnTargetFilterTypeEnum": { + "type": "string", + "enum": [ + "WHITELIST", + "BLACKLIST" + ] + }, + "FreeReturnTargetTypeEnum": { + "type": "string", + "enum": [ + "PRODUCT" + ] + }, + "FreeReturnPromotionTargetTypeEnum": { + "type": "string", + "enum": [ + "PRODUCT", + "BRAND_SOURCING" + ] + }, + "VideosCollectionElementDto": { + "type": "object", + "required": [ + "ids", + "isLandscape" + ], + "properties": { + "ids": { + "type": "array", + "items": { + "type": "string" + } + }, + "isLandscape": { + "type": "boolean" + } + } + }, + "OrientationTypeEnum": { + "type": "string", + "enum": [ + "PORTRAIT", + "LANDSCAPE" + ] + }, + "LinkCollectionElementDto": { + "type": "object", + "required": [ + "imageUrl", + "linkUrl" + ], + "properties": { + "imageUrl": { + "type": "string" + }, + "linkUrl": { + "type": "string" + }, + "campaign": { + "type": "string" + } + } + }, + "CampaignCollectionElementDto": { + "type": "object", + "required": [ + "imageUrl", + "campaign" + ], + "properties": { + "imageUrl": { + "type": "string" + }, + "message": { + "type": "string" + }, + "campaign": { + "type": "string" + } + } + }, + "CouponCollectionElementDto": { + "type": "object", + "required": [ + "imageUrl", + "couponCode" + ], + "properties": { + "imageUrl": { + "type": "string" + }, + "couponCode": { + "type": "string" + }, + "campaign": { + "type": "string" + } + } + }, + "MarkdownCollectionElementDto": { + "type": "object", + "required": [ + "markdown" + ], + "properties": { + "markdown": { + "type": "string" + } + } + }, + "PointPromotionCollectionElementDto": { + "type": "object", + "required": [ + "promotionCode", + "imageUrl" + ], + "properties": { + "promotionCode": { + "description": "์ ๋ฆฝ๊ธˆ ํ”„๋กœ๋ชจ์…˜ Code", + "type": "string" + }, + "amount": { + "description": "ํ”„๋กœ๋ชจ์…˜ ์ฐธ์„์œผ๋กœ ๋ฐ›์„ ์ ๋ฆฝ๊ธˆ ์ˆ˜๋Ÿ‰", + "type": "integer", + "format": "int64" + }, + "imageUrl": { + "description": "์ ๋ฆฝ๊ธˆ ์ด๋ฏธ์ง€ URL", + "type": "string" + }, + "campaign": { + "description": "๋…ธํŠธ ์šฉ๋„์˜ ํ•„๋“œ", + "type": "string" + } + } + }, + "AttendanceCheckCollectionElementDto": { + "type": "object", + "required": [ + "title", + "imageUrl", + "kstStartDate", + "kstEndDate", + "numberOfAttendance", + "attendanceRewardPolicies" + ], + "properties": { + "id": { + "description": "์ถœ์„ ์ฒดํฌ id", + "type": "string" + }, + "title": { + "type": "string" + }, + "imageUrl": { + "description": "์ถœ์„ ์ฒดํฌ ์ด๋ฏธ์ง€ URL", + "type": "string" + }, + "kstStartDate": { + "type": "string", + "description": "yyyy-mm-dd ํ˜•์‹์˜ ์ผ์ž" + }, + "kstEndDate": { + "type": "string", + "description": "yyyy-mm-dd ํ˜•์‹์˜ ์ผ์ž" + }, + "numberOfAttendance": { + "type": "integer", + "format": "int64" + }, + "attendanceRewardPolicies": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AttendanceRewardPolicyCollectionElementDto" + } + } + } + }, + "AttendanceRewardPolicyCollectionElementDto": { + "type": "object", + "required": [ + "type", + "pointAmount", + "pointExpireDays" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/AttendanceRewardPolicyTypeEnum" + }, + "pointAmount": { + "type": "integer", + "format": "int64" + }, + "pointExpireDays": { + "type": "integer" + } + } + }, + "AttendanceRewardPolicyTypeEnum": { + "type": "string", + "enum": [ + "DAILY_REWARD", + "ACHIEVEMENT_REWARD" + ] + }, + "ImageLinkTypeEnum": { + "type": "string", + "enum": [ + "COUPON", + "LINK" + ] + }, + "CollectionElementTypeEnum": { + "type": "string", + "enum": [ + "TEXT", + "IMAGE", + "PRODUCTS", + "VIDEOS", + "LINK", + "CAMPAIGN", + "COUPON", + "IMAGELINK", + "MARKDOWN", + "POINT_PROMOTION", + "ATTENDANCE_CHECK" + ] + }, + "UploadProductPageRequest": { + "type": "object", + "required": [ + "base64" + ], + "properties": { + "base64": { + "type": "string" + } + } + }, + "CouponBookDto": { + "type": "object", + "required": [ + "code", + "header", + "title", + "contents", + "pairContents", + "asset", + "coupons" + ], + "properties": { + "code": { + "type": "string" + }, + "header": { + "type": "string" + }, + "title": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "pairContents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ContentsPairDto" + } + }, + "asset": { + "$ref": "#/components/schemas/CouponBookAssetDto" + }, + "coupons": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCouponDto" + } + } + } + }, + "CouponBookAssetDto": { + "type": "object", + "required": [ + "primaryColor" + ], + "properties": { + "primaryColor": { + "$ref": "#/components/schemas/ColorGradientDto" + }, + "contentImageUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionContentImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "stickerImageUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionStickerImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + } + } + }, + "ContentsPairDto": { + "type": "object", + "required": [ + "first", + "second" + ], + "properties": { + "first": { + "type": "string" + }, + "second": { + "type": "string" + } + } + }, + "ColorGradientDto": { + "type": "object", + "required": [ + "startColorCode", + "endColorCode" + ], + "properties": { + "startColorCode": { + "type": "string", + "description": "start of gradient color code. (ex. \\#AABBCC)" + }, + "endColorCode": { + "type": "string", + "description": "end of gradient color code. (ex. \\#DDEEFF)" + } + } + }, + "IssuedCouponWhenOrderDto": { + "allOf": [ + { + "$ref": "#/components/schemas/IssuedCouponDto" + }, + { + "type": "object", + "required": [ + "discountableAmount", + "consumable" + ], + "properties": { + "discountableAmount": { + "type": "integer", + "format": "int64" + }, + "consumable": { + "type": "boolean" + } + } + } + ] + }, + "IssuedCouponDto": { + "type": "object", + "required": [ + "issuedCouponId", + "coupon", + "state", + "issuedAtMillis", + "activatingAtMillis" + ], + "properties": { + "issuedCouponId": { + "type": "integer", + "format": "int64" + }, + "coupon": { + "$ref": "#/components/schemas/CouponDto" + }, + "state": { + "$ref": "#/components/schemas/IssuedCouponStateEnum" + }, + "issuedAtMillis": { + "type": "integer", + "format": "int64" + }, + "activatingAtMillis": { + "type": "integer", + "format": "int64" + }, + "expiringAtMillis": { + "type": "integer", + "format": "int64" + }, + "linkUrl": { + "type": "string" + } + } + }, + "IssuedCouponStateEnum": { + "type": "string", + "enum": [ + "CONSUMED", + "EXPIRED", + "ACTIVATED", + "DISABLED" + ] + }, + "CouponDto": { + "type": "object", + "required": [ + "code", + "title", + "caution", + "conditionSummary", + "type" + ], + "properties": { + "code": { + "type": "string" + }, + "title": { + "type": "string" + }, + "manager": { + "type": "string" + }, + "caution": { + "type": "string" + }, + "conditionSummary": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/CouponTypeEnum" + }, + "discountAmount": { + "type": "integer", + "format": "int64", + "description": "field for CouponTypeEnum.DISCOUNT_BY_AMOUNT type." + }, + "discountPercentage": { + "type": "integer", + "format": "int64", + "description": "field for CouponTypeEnum.DISCOUNT_BY_PERCENTAGE type." + }, + "maxDiscountAmount": { + "type": "integer", + "format": "int64", + "description": "field for CouponTypeEnum.DISCOUNT_BY_PERCENTAGE type." + }, + "specialPrice": { + "type": "integer", + "format": "int64", + "description": "field for CouponTypeEnum.SPECIAL_PRICE type." + } + } + }, + "AppCouponDto": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/CouponDto" + }, + { + "type": "object", + "properties": { + "consumableCount": { + "type": "integer", + "format": "int64" + } + } + } + ] + }, + "CouponDetailDto": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/CouponDto" + }, + { + "type": "object", + "required": [ + "expirationPolicy" + ], + "properties": { + "expirationPolicy": { + "$ref": "#/components/schemas/CouponExpirationPolicyDto" + } + } + } + ] + }, + "CouponExpirationPolicyDto": { + "type": "object", + "properties": { + "durationSecondsSinceHold": { + "type": "integer", + "format": "int64" + }, + "startAtMillis": { + "type": "integer", + "format": "int64" + }, + "endAtMillis": { + "type": "integer", + "format": "int64" + } + } + }, + "AppCouponListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCouponDto" + } + }, + "maximumDiscountCouponAppliedPrice": { + "description": "- ์ตœ๋Œ€ ์ฟ ํฐ ํ• ์ธ๊ฐ€๊ฐ€ ์ ์šฉ๋œ ๊ฐ€๊ฒฉ\n- ์ด ํ•„๋“œ์˜ ๊ฐ’์ด `null`์ธ ๊ฒฝ์šฐ -> ์ตœ๋Œ€ ํ• ์ธ๊ฐ€๋ฅผ ๊ณ„์‚ฐํ•˜๊ธฐ ์œ„ํ•œ ์กฐ๊ฑด์„ ๋งŒ์กฑํ•˜๋Š” ์ฟ ํฐ์ด ์—†๋Š” ๊ฒƒ์œผ๋กœ ๋ณผ ์ˆ˜ ์žˆ์Œ\n", + "type": "integer", + "format": "int64" + } + } + }, + "CouponTypeEnum": { + "type": "string", + "enum": [ + "DISCOUNT_BY_AMOUNT", + "DISCOUNT_BY_PERCENTAGE", + "SPECIAL_PRICE" + ] + }, + "ApplyCouponRequestDto": { + "type": "object", + "required": [ + "issuedCouponId" + ], + "properties": { + "issuedCouponId": { + "type": "integer", + "format": "int64" + } + } + }, + "ApplyPointRequestDto": { + "type": "object", + "required": [ + "usePoint" + ], + "properties": { + "usePoint": { + "type": "integer", + "format": "int64" + } + } + }, + "ReleaseCouponResponseDto": { + "type": "object", + "required": [ + "priceSet", + "orderSummary" + ], + "properties": { + "priceSet": { + "$ref": "#/components/schemas/PriceSetDto" + }, + "orderSummary": { + "$ref": "#/components/schemas/OrderSummaryDto" + } + } + }, + "ApplyCouponResponseDto": { + "type": "object", + "required": [ + "priceSet", + "orderSummary" + ], + "properties": { + "priceSet": { + "$ref": "#/components/schemas/PriceSetDto" + }, + "orderSummary": { + "$ref": "#/components/schemas/OrderSummaryDto" + } + } + }, + "ApplyPointResponseDto": { + "type": "object", + "required": [ + "priceSet", + "orderSummary" + ], + "properties": { + "priceSet": { + "$ref": "#/components/schemas/PriceSetDto" + }, + "orderSummary": { + "$ref": "#/components/schemas/OrderSummaryDto" + } + } + }, + "ProductPriceDto": { + "type": "object", + "required": [ + "originalPrice", + "sellingPrice" + ], + "properties": { + "originalPrice": { + "type": "integer", + "format": "int64", + "description": "์ •๊ฐ€" + }, + "sellingPrice": { + "type": "integer", + "format": "int64", + "description": "ํŒ๋งค๊ฐ€" + } + } + }, + "ProductDiscountBenefitsDto": { + "type": "object", + "required": [ + "discountBenefitsByCoupon", + "discountBenefitsByPoint" + ], + "properties": { + "discountBenefitsByCoupon": { + "$ref": "#/components/schemas/ProductDiscountBenefitsInfoByCouponDto" + }, + "discountBenefitsByPoint": { + "type": "integer", + "format": "int64", + "description": "์‚ฌ์šฉ๊ฐ€๋Šฅํ•œ ํฌ์ธํŠธ ๊ธˆ์•ก" + } + } + }, + "ProductDiscountBenefitsInfoByCouponDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDiscountBenefitsInfoByCouponElementDto" + } + } + } + }, + "ProductDiscountBenefitsInfoByCouponElementDto": { + "type": "object", + "required": [ + "title", + "couponCode", + "discountAmount" + ], + "properties": { + "title": { + "type": "string" + }, + "couponCode": { + "type": "string" + }, + "discountAmount": { + "type": "integer", + "format": "int64" + } + } + }, + "CheckFirstKakaoLoginCouponIssuableResponseDto": { + "type": "object", + "required": [ + "isIssuable" + ], + "properties": { + "isIssuable": { + "type": "boolean" + } + } + }, + "AgeGroupFilterListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AgeGroupFilterDto" + } + } + } + }, + "AgeGroupFilterDto": { + "type": "object", + "required": [ + "code", + "alias" + ], + "properties": { + "code": { + "$ref": "#/components/schemas/AgeGroupCodeEnum" + }, + "alias": { + "type": "string" + } + } + }, + "CreatableReviewPromptDto": { + "type": "object", + "properties": { + "myOrderItem": { + "$ref": "#/components/schemas/MyOrderItemDto" + } + } + }, + "DisplayProductReviewListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DisplayProductReviewDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "DisplayProductReviewListDtoV2": { + "type": "object", + "required": [ + "list", + "totalPageCount", + "totalElementCount" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DisplayProductReviewDto" + } + }, + "totalPageCount": { + "type": "integer", + "format": "int32" + }, + "totalElementCount": { + "type": "integer", + "format": "int64" + } + } + }, + "RepresentativeProductReviewListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DisplayProductReviewDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "DisplayProductReviewDto": { + "type": "object", + "required": [ + "productReview", + "optionTitle", + "userProfileDisplayPolicy", + "favoriteData" + ], + "properties": { + "productReview": { + "$ref": "#/components/schemas/ProductReviewDto" + }, + "optionTitle": { + "type": "string" + }, + "userProfileDisplayPolicy": { + "$ref": "#/components/schemas/UserProfileDisplayPolicyDto" + }, + "favoriteData": { + "$ref": "#/components/schemas/ProductReviewFavoriteDataDto" + } + } + }, + "ProductReviewListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "ProductReviewDto": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/ProductReviewDataDto" + }, + { + "type": "object", + "required": [ + "id", + "uid", + "createdAtMillis" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "uid": { + "type": "string" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + }, + "userProfile": { + "$ref": "#/components/schemas/UserProfileDto" + } + } + } + ] + }, + "ProductReviewFavoriteDataDto": { + "type": "object", + "required": [ + "favoriteCount", + "isMyFavorite" + ], + "properties": { + "favoriteCount": { + "type": "integer", + "format": "int64" + }, + "isMyFavorite": { + "type": "boolean", + "default": false + } + } + }, + "UpdateProductReviewRequestDto": { + "type": "object", + "required": [ + "reviewData" + ], + "properties": { + "reviewData": { + "$ref": "#/components/schemas/ProductReviewDataDto" + } + } + }, + "ProductCategoryReviewAttributeDto": { + "type": "object", + "required": [ + "productCategoryReviewGroupId", + "label", + "list", + "guide" + ], + "properties": { + "productCategoryReviewGroupId": { + "type": "string" + }, + "label": { + "type": "string" + }, + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryReviewAttributeItemDto" + } + }, + "guide": { + "$ref": "#/components/schemas/ProductCategoryReviewGuideDto" + } + } + }, + "ProductReviewAttributeDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewAttributeItemDto" + } + } + } + }, + "ProductCategoryReviewAttributeItemDto": { + "type": "object", + "required": [ + "code", + "label", + "options" + ], + "properties": { + "code": { + "type": "string" + }, + "label": { + "type": "string" + }, + "options": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewAttributeOptionItemDto" + } + } + } + }, + "ProductReviewAttributeItemDto": { + "type": "object", + "required": [ + "code", + "label", + "selectedOptions" + ], + "properties": { + "code": { + "type": "string" + }, + "label": { + "type": "string" + }, + "selectedOptions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewAttributeOptionItemDto" + } + } + } + }, + "ProductReviewAttributeOptionItemDto": { + "type": "object", + "required": [ + "code", + "label" + ], + "properties": { + "code": { + "type": "string" + }, + "label": { + "type": "string" + } + } + }, + "ProductCategoryReviewGuideDto": { + "type": "object", + "required": [ + "textGuides", + "imageWithTitles" + ], + "properties": { + "textGuides": { + "type": "array", + "items": { + "type": "string" + } + }, + "imageWithTitles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryReviewGuideImageWithTitleDto" + } + } + } + }, + "ProductCategoryReviewGuideImageWithTitleDto": { + "type": "object", + "required": [ + "imageUrl", + "title" + ], + "properties": { + "imageUrl": { + "type": "string" + }, + "title": { + "type": "string" + } + } + }, + "ProductReviewDataDto": { + "type": "object", + "required": [ + "rating" + ], + "properties": { + "attributes": { + "$ref": "#/components/schemas/ProductReviewAttributeDto" + }, + "rating": { + "$ref": "#/components/schemas/ProductRatingEnum" + }, + "size": { + "$ref": "#/components/schemas/ProductSizeEnum" + }, + "brightness": { + "$ref": "#/components/schemas/ProductBrightnessEnum" + }, + "colorSense": { + "$ref": "#/components/schemas/ProductColorSenseEnum" + }, + "thickness": { + "$ref": "#/components/schemas/ProductThicknessEnum" + }, + "contents": { + "type": "string" + }, + "imageUrls": { + "description": "DEPRECATED", + "type": "array", + "items": { + "type": "string" + } + }, + "multiResolutionImages": { + "$ref": "#/components/schemas/MultiResolutionImageListDto" + } + } + }, + "UserProfileDisplayPolicyDto": { + "type": "object", + "required": [ + "displayItemsOfUserProfile" + ], + "properties": { + "displayItemsOfUserProfile": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserProfileItemEnum" + } + } + } + }, + "UserProfileItemEnum": { + "type": "string", + "enum": [ + "HEIGHT_AS_CENTI_METER", + "WEIGHT_AS_KILO_GRAM", + "TOP_SIZE", + "BOTTOM_SIZE_AS_INCH", + "SHOE_SIZE_AS_MILLI_METER", + "AGE" + ] + }, + "ProductReviewCandidateListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewCandidateDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "ProductReviewCandidateDto": { + "type": "object", + "required": [ + "myOrderItem" + ], + "properties": { + "myOrderItem": { + "$ref": "#/components/schemas/MyOrderItemDto" + } + } + }, + "MyProductReviewListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MyProductReviewDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "MyProductReviewDto": { + "type": "object", + "required": [ + "myOrderItem" + ], + "properties": { + "myOrderItem": { + "$ref": "#/components/schemas/MyOrderItemDto" + } + } + }, + "ProductReviewItemListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ProductReviewStatisticsAttributeDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewStatisticsAttributeItemDto" + } + } + } + }, + "ProductReviewStatisticsAttributeItemDto": { + "type": "object", + "required": [ + "code", + "label", + "options" + ], + "properties": { + "code": { + "type": "string" + }, + "label": { + "type": "string" + }, + "options": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewStatisticsAttributeOptionItemDto" + } + } + } + }, + "ProductReviewStatisticsAttributeOptionItemDto": { + "type": "object", + "required": [ + "code", + "label", + "count" + ], + "properties": { + "code": { + "type": "string" + }, + "label": { + "type": "string" + }, + "percentage": { + "type": "integer", + "format": "int32" + }, + "count": { + "type": "integer", + "format": "int64" + } + } + }, + "ProductReviewStatisticsSummaryDto": { + "type": "object", + "required": [ + "ratingAverage", + "reviewCounts" + ], + "properties": { + "ratingAverage": { + "type": "number", + "format": "double" + }, + "reviewCounts": { + "type": "integer", + "format": "int64" + }, + "attributes": { + "$ref": "#/components/schemas/ProductReviewStatisticsAttributeDto" + }, + "satisfactionPercentage": { + "type": "integer", + "format": "int32" + }, + "topPercentageOfSize": { + "$ref": "#/components/schemas/ProductSizePercentageDto" + }, + "topPercentageOfBrightness": { + "$ref": "#/components/schemas/ProductBrightnessPercentageDto" + }, + "topPercentageOfColorSense": { + "$ref": "#/components/schemas/ProductColorSensePercentageDto" + }, + "topPercentageOfThickness": { + "$ref": "#/components/schemas/ProductThicknessPercentageDto" + } + } + }, + "ProductRatingStatisticsDto": { + "type": "object", + "required": [ + "percentages" + ], + "properties": { + "percentages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductRatingPercentageDto" + } + } + } + }, + "ProductRatingPercentageDto": { + "type": "object", + "required": [ + "rating", + "percentage" + ], + "properties": { + "rating": { + "$ref": "#/components/schemas/ProductRatingEnum" + }, + "percentage": { + "type": "integer", + "format": "int32" + } + } + }, + "ProductReviewSortOrderEnum": { + "type": "string", + "enum": [ + "CREATED_AT_DESC", + "CREATED_AT_ASC", + "REPORT_COUNT_DESC", + "RECOMMENDATION", + "REVIEW_RATING_DESC", + "REVIEW_RATING_ASC" + ] + }, + "ProductRatingEnum": { + "type": "number", + "x-enum-varnames": [ + "BAD", + "NOT_BAD", + "NORMAL", + "GOOD", + "BEST" + ], + "enum": [ + 1, + 2, + 3, + 4, + 5 + ] + }, + "ProductSizeStatisticsDto": { + "type": "object", + "required": [ + "percentages" + ], + "properties": { + "percentages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSizePercentageDto" + } + } + } + }, + "ProductSizePercentageDto": { + "type": "object", + "required": [ + "size" + ], + "properties": { + "size": { + "$ref": "#/components/schemas/ProductSizeEnum" + }, + "percentage": { + "type": "integer", + "format": "int32" + } + } + }, + "ProductSizeEnum": { + "type": "string", + "enum": [ + "SMALL", + "FITTED", + "BIG" + ] + }, + "ProductBrightnessStatisticsDto": { + "type": "object", + "required": [ + "percentages" + ], + "properties": { + "percentages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductBrightnessPercentageDto" + } + } + } + }, + "ProductBrightnessPercentageDto": { + "type": "object", + "required": [ + "brightness" + ], + "properties": { + "brightness": { + "$ref": "#/components/schemas/ProductBrightnessEnum" + }, + "percentage": { + "type": "integer", + "format": "int32" + } + } + }, + "ProductBrightnessEnum": { + "type": "string", + "enum": [ + "DARK", + "SAME_AS_PHOTO", + "BRIGHT" + ] + }, + "ProductColorSenseStatisticsDto": { + "type": "object", + "required": [ + "percentages" + ], + "properties": { + "percentages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductColorSensePercentageDto" + } + } + } + }, + "ProductColorSensePercentageDto": { + "type": "object", + "required": [ + "colorSense" + ], + "properties": { + "colorSense": { + "$ref": "#/components/schemas/ProductColorSenseEnum" + }, + "percentage": { + "type": "integer", + "format": "int32" + } + } + }, + "ProductColorSenseEnum": { + "type": "string", + "enum": [ + "BLURRY", + "SAME_AS_PHOTO", + "VIVID" + ] + }, + "ProductThicknessStatisticsDto": { + "type": "object", + "required": [ + "precentages" + ], + "properties": { + "percentages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductThicknessPercentageDto" + } + } + } + }, + "ProductThicknessPercentageDto": { + "type": "object", + "required": [ + "thickness" + ], + "properties": { + "thickness": { + "$ref": "#/components/schemas/ProductThicknessEnum" + }, + "percentage": { + "type": "integer", + "format": "int32" + } + } + }, + "ProductThicknessEnum": { + "type": "string", + "enum": [ + "THIN", + "NORMAL", + "THICK" + ] + }, + "ProductReviewReportDto": { + "type": "object", + "required": [ + "reason" + ], + "properties": { + "reason": { + "type": "string" + } + } + }, + "UserBirthYearDto": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "integer", + "format": "int32" + } + } + }, + "UserProfileDto": { + "type": "object", + "properties": { + "age": { + "type": "integer", + "format": "int32" + }, + "birthYear": { + "type": "integer", + "format": "int32" + }, + "bodySizeData": { + "$ref": "#/components/schemas/UserBodySizeDataDto" + } + } + }, + "UserBodySizeDataDto": { + "type": "object", + "properties": { + "heightAsCentiMeter": { + "type": "integer", + "format": "int32" + }, + "weightAsKiloGram": { + "type": "integer", + "format": "int32" + }, + "topSize": { + "type": "integer", + "format": "int32" + }, + "bottomSizeAsInch": { + "type": "integer", + "format": "int32" + }, + "shoeSizeAsMilliMeter": { + "type": "integer", + "format": "int32" + }, + "valid": { + "type": "boolean" + } + } + }, + "ExternalUidDto": { + "type": "object", + "properties": { + "externalUid": { + "type": "string" + } + } + }, + "ConnectPayCredentialDto": { + "type": "object", + "required": [ + "clientKey", + "customerKey", + "redirectUrl" + ], + "properties": { + "clientKey": { + "type": "string", + "description": "์ปค๋„ฅํŠธํŽ˜์ด JS SDK ์ธ์ฆ์šฉ clientKey" + }, + "customerKey": { + "type": "string", + "description": "๊ฒฐ์ œ ์š”์ฒญ์‹œ ์‚ฌ์šฉ๋˜๋Š” user์˜ external uid" + }, + "redirectUrl": { + "type": "string", + "description": "์ปค๋„ฅํŠธํŽ˜์ด OAuth ์ธ์ฆ ์‹œ ์‚ฌ์šฉ๋  redirect url" + } + } + }, + "PaymentMethodResponseDto": { + "type": "object", + "required": [ + "cards", + "accounts" + ], + "properties": { + "cards": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CardPaymentDto" + } + }, + "accounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AccountPaymentDto" + } + } + } + }, + "CardPaymentDto": { + "type": "object", + "required": [ + "methodId", + "cardCompany", + "cardName", + "iconUrl", + "maskedCardNumber", + "enabled", + "registeredAtMillis" + ], + "properties": { + "methodId": { + "type": "string", + "description": "๊ฒฐ์ œ ์ˆ˜๋‹จ Id, ์ปค๋„ฅํŠธํŽ˜์ด ๊ฒฐ์ œ์š”์ฒญ์‹œ ์‚ฌ์šฉ" + }, + "cardCompany": { + "$ref": "#/components/schemas/TossPaymentCardEnum" + }, + "unknownCardCompanyName": { + "type": "string", + "description": "cardCompany ๊ฐ’์ด `UNKNOWN`์ธ ๊ฒฝ์šฐ ํ•ด๋‹นํ•˜๋Š” ์นด๋“œ์‚ฌ์˜ ์ด๋ฆ„, unknown์ด ์•„๋‹ ๊ฒฝ์šฐ null" + }, + "cardName": { + "type": "string", + "description": "์นด๋“œ ์ด๋ฆ„" + }, + "iconUrl": { + "type": "string", + "description": "์นด๋“œ์‚ฌ ์•„์ด์ฝ˜ ์ด๋ฏธ์ง€ url" + }, + "maskedCardNumber": { + "type": "string", + "description": "๋งˆ์Šคํ‚น๋œ ์นด๋“œ ๋ฒˆํ˜ธ" + }, + "enabled": { + "type": "boolean" + }, + "registeredAtMillis": { + "type": "integer", + "format": "int64", + "description": "๋“ฑ๋ก์ผ" + } + } + }, + "AccountPaymentDto": { + "type": "object", + "required": [ + "methodId", + "bank", + "iconUrl", + "maskedAccountNumber", + "enabled", + "registeredAtMillis" + ], + "properties": { + "methodId": { + "type": "string", + "description": "๊ฒฐ์ œ ์ˆ˜๋‹จ Id, ์ปค๋„ฅํŠธํŽ˜์ด ๊ฒฐ์ œ์š”์ฒญ์‹œ ์‚ฌ์šฉ" + }, + "bank": { + "$ref": "#/components/schemas/TossPaymentAccountEnum" + }, + "unknownBankName": { + "type": "string", + "description": "bank ๊ฐ’์ด `UNKNOWN`์ธ ๊ฒฝ์šฐ ํ•ด๋‹นํ•˜๋Š” ์€ํ–‰์˜ ์ด๋ฆ„, unknown์ด ์•„๋‹ ๊ฒฝ์šฐ null" + }, + "iconUrl": { + "type": "string", + "description": "์€ํ–‰ ์•„์ด์ฝ˜ ์ด๋ฏธ์ง€ url" + }, + "maskedAccountNumber": { + "type": "string", + "description": "๋งˆ์Šคํ‚น๋œ ๊ณ„์ขŒ ๋ฒˆํ˜ธ" + }, + "enabled": { + "type": "boolean" + }, + "registeredAtMillis": { + "type": "integer", + "format": "int64", + "description": "๋“ฑ๋ก์ผ" + } + } + }, + "TierDto": { + "type": "object", + "required": [ + "uid", + "totalPurchaseAmount", + "tierRankType" + ], + "properties": { + "uid": { + "description": "์œ ์ € ์•„์ด๋””", + "type": "string" + }, + "totalPurchaseAmount": { + "description": "๋ˆ„์  ๊ตฌ๋งคํ™•์ • ๊ธˆ์•ก(์ง€๋‚œ 3๊ฐœ์›” ์น˜ ๊ตฌ๋งค ํ™•์ • ๊ธˆ์•ก, ex-8์›” 7์ผ ์กฐํšŒ ์‹œ 5,6,7์›” ํ†ต๊ณ„ ์ดํ•ฉ ๊ธˆ์•ก)", + "type": "integer", + "format": "int64" + }, + "tierRankType": { + "$ref": "#/components/schemas/TierRankTypeEnum" + } + } + }, + "TierRankTypeEnum": { + "type": "string", + "description": "ํ‹ฐ์–ด ํƒ€์ž…", + "enum": [ + "DIAMOND", + "PLATINUM", + "GOLD", + "SILVER" + ] + }, + "NextTierInfoDto": { + "type": "object", + "required": [ + "uid", + "nextTierRankType", + "startTierRankTypeForGraph", + "endTierRankTypeForGraph", + "totalPurchaseAmount", + "remainAmount", + "startAtMillis" + ], + "properties": { + "uid": { + "description": "์œ ์ € ์•„์ด๋””", + "type": "string" + }, + "nextTierRankType": { + "$ref": "#/components/schemas/TierRankTypeEnum" + }, + "startTierRankTypeForGraph": { + "$ref": "#/components/schemas/TierRankTypeEnum" + }, + "endTierRankTypeForGraph": { + "$ref": "#/components/schemas/TierRankTypeEnum" + }, + "totalPurchaseAmount": { + "description": "๋ˆ„์  ๊ตฌ๋งคํ™•์ • ๊ธˆ์•ก(์ง€๋‚œ 2๊ฐœ์›” ํ†ต๊ณ„ ๊ธˆ์•ก + ์กฐํšŒ์›” ์‹ค์‹œ๊ฐ„ ๊ตฌ๋งค ํ™•์ • ๊ธˆ์•ก)", + "type": "integer", + "format": "int64" + }, + "remainAmount": { + "description": "๋‹ค์Œ ํ‹ฐ์–ด๊นŒ์ง€ ๋‚จ์€ ๊ธˆ์•ก(์ด ๊ธˆ์•ก์ด ๋‹ค์Œ ํ‹ฐ์–ด๋“ฑ๊ธ‰ ์ดˆ๊ณผ ์‹œ ๋‹ค๋‹ค์Œ ํ‹ฐ์–ด ๊ธˆ์•ก๊นŒ์ง€ ๋‚จ์€ ๊ธˆ์•ก ์ถœ๋ ฅ)", + "type": "integer", + "format": "int64" + }, + "startAtMillis": { + "type": "integer", + "format": "int64", + "description": "ํ‹ฐ์–ด ๋“ฑ๊ธ‰ ์‚ฐ์ • ์‹œ์ž‘ ๊ธฐ๊ฐ„" + }, + "tierChangeStatus": { + "$ref": "#/components/schemas/TierChangeStatusEnum" + } + } + }, + "TierChangeStatusEnum": { + "type": "string", + "description": "ํ‹ฐ์–ด ๋ณ€๊ฒฝ ์ƒํƒœ ํƒ€์ž…", + "enum": [ + "RISE", + "HOLD", + "FALL" + ] + }, + "ImageCategoryEnum": { + "type": "string", + "enum": [ + "PRODUCT_REVIEW", + "ORDER_LINE_RETURN" + ] + }, + "UploadableImageResponseDto": { + "type": "object", + "required": [ + "url", + "uploadedUrl", + "expiredAtMillis" + ], + "properties": { + "url": { + "type": "string" + }, + "uploadedUrl": { + "type": "string" + }, + "expiredAtMillis": { + "type": "integer", + "format": "int64" + } + } + }, + "UploadImageResponseDto": { + "type": "object", + "required": [ + "imageUrl", + "multiResolutionImage" + ], + "properties": { + "imageUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + } + } + }, + "Base64ImageUploadRequestDto": { + "type": "object", + "required": [ + "name", + "base64" + ], + "properties": { + "name": { + "type": "string" + }, + "base64": { + "type": "string" + } + } + }, + "ShopLiveTokenResponseDto": { + "type": "object", + "required": [ + "accessToken" + ], + "properties": { + "accessToken": { + "type": "string", + "description": "7์ผ ๋’ค์— ๋งŒ๋ฃŒ๋จ" + } + } + }, + "ShopLiveTokenRequestDto": { + "type": "object", + "properties": { + "userName": { + "type": "string", + "description": "์‚ฌ์šฉ์ž ์ฑ„ํŒ…๋ช…" + } + } + }, + "ShopLiveCampaignMetadataResponseDto": { + "type": "object", + "required": [ + "campaignAccessKey", + "campaignMetadataState" + ], + "properties": { + "campaignKey": { + "type": "string", + "description": "์บ ํŽ˜์ธ key" + }, + "campaignAccessKey": { + "type": "string", + "description": "์บ ํŽ˜์ธ Access key" + }, + "title": { + "type": "string", + "description": "์บ ํŽ˜์ธ ์ œ๋ชฉ" + }, + "campaignMetadataState": { + "$ref": "#/components/schemas/ShopLiveCampaignMetadataStateEnum" + }, + "liveUrl": { + "type": "string", + "description": "์˜์ƒ ์žฌ์ƒ URL" + }, + "posterUrl": { + "type": "string", + "description": "๋ฐฉ์†ก ์˜ˆ๊ณ  ์ด๋ฏธ์ง€ URL" + }, + "poster2Url": { + "type": "string", + "description": "๋ฐฉ์†ก ์ข…๋ฃŒ ํ›„ ์ด๋ฏธ์ง€ URL" + }, + "scheduledAt": { + "type": "integer", + "format": "int64", + "description": "๋ฐฉ์†ก ์˜ˆ์ • ์‹œ๊ฐ„" + }, + "scheduledEndAt": { + "type": "integer", + "format": "int64", + "description": "๋ฐฉ์†ก ์ข…๋ฃŒ ์˜ˆ์ • ์‹œ๊ฐ„" + }, + "startedAt": { + "type": "integer", + "format": "int64", + "description": "๋ฐฉ์†ก ์‹œ์ž‘ ์‹œ๊ฐ„" + }, + "closingAt": { + "type": "integer", + "format": "int64", + "description": "n๋ถ„ ํ›„ ์ข…๋ฃŒ๋ฅผ ์„ค์ •ํ–ˆ์„ ๋•Œ ์‹ค์ œ ์ข…๋ฃŒ ์˜ˆ์ • ์‹œ๊ฐ„" + }, + "endedAt": { + "type": "integer", + "format": "int64", + "description": "๋ฐฉ์†ก ์ข…๋ฃŒ ์‹œ๊ฐ„" + } + } + }, + "ShopLiveCampaignResponseDto": { + "type": "object", + "required": [ + "campaignAccessKey", + "campaignState" + ], + "properties": { + "campaignKey": { + "type": "string", + "description": "์บ ํŽ˜์ธ key" + }, + "campaignAccessKey": { + "type": "string", + "description": "์บ ํŽ˜์ธ Access key" + }, + "campaignUrl": { + "type": "string", + "description": "์บ ํŽ˜์ธ URL" + }, + "title": { + "type": "string", + "description": "์บ ํŽ˜์ธ ์ œ๋ชฉ" + }, + "memo": { + "type": "string", + "description": "์บ ํŽ˜์ธ ๋ฉ”๋ชจ" + }, + "campaignState": { + "$ref": "#/components/schemas/ShopLiveCampaignStateEnum" + }, + "campaignGoodsList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShopLiveCampaignGoodsDto" + } + }, + "campaignGoodsCount": { + "type": "integer", + "format": "int32", + "description": "์บ ํŽ˜์ธ์— ๋“ฑ๋ก ์ƒํ’ˆ ๊ฐœ์ˆ˜" + }, + "userCount": { + "type": "integer", + "format": "int32", + "description": "๋ˆ„์  ์‹œ์ฒญ์ž ์ˆ˜" + }, + "adoreCount": { + "type": "integer", + "format": "int32", + "description": "์ข‹์•„์š” ์ˆ˜" + }, + "posterUrl": { + "type": "string", + "description": "๋ฐฉ์†ก ์˜ˆ๊ณ  ์ด๋ฏธ์ง€ URL" + }, + "poster2Url": { + "type": "string", + "description": "๋ฐฉ์†ก ์ข…๋ฃŒ ํ›„ ์ด๋ฏธ์ง€ URL" + }, + "unsupportInfoUrl": { + "type": "string", + "description": "IE ๋ฏธ์ง€์› ์•ˆ๋‚ด ์ด๋ฏธ์ง€ URL" + }, + "previewLiveUrl": { + "type": "string", + "description": "๋ฐฉ์†ก ๋ฏธ๋ฆฌ๋ณด๊ธฐ URL" + }, + "replayLiveUrl": { + "type": "string", + "description": "๋ฐฉ์†ก ๋‹ค์‹œ๋ณด๊ธฐ URL" + }, + "liveUrl": { + "type": "string", + "description": "์˜์ƒ ์žฌ์ƒ URL" + }, + "backgroundUrl": { + "type": "string", + "description": "๋ฐฐ๊ฒฝ ์ด๋ฏธ์ง€ URL" + }, + "scheduledAt": { + "type": "integer", + "format": "int64", + "description": "๋ฐฉ์†ก ์˜ˆ์ • ์‹œ๊ฐ„" + }, + "scheduledEndAt": { + "type": "integer", + "format": "int64", + "description": "๋ฐฉ์†ก ์ข…๋ฃŒ ์˜ˆ์ • ์‹œ๊ฐ„" + }, + "startedAt": { + "type": "integer", + "format": "int64", + "description": "๋ฐฉ์†ก ์‹œ์ž‘ ์‹œ๊ฐ„" + }, + "endedAt": { + "type": "integer", + "format": "int64", + "description": "๋ฐฉ์†ก ์ข…๋ฃŒ ์‹œ๊ฐ„" + } + } + }, + "ShopLiveCampaignGoodsDto": { + "type": "object", + "required": [ + "campaignId", + "goodsId", + "name", + "url", + "action", + "payload", + "showingNow", + "soldOut", + "originalPrice", + "currency", + "traceId" + ], + "properties": { + "campaignId": { + "type": "integer", + "format": "int64", + "description": "์บ ํŽ˜์ธ ID" + }, + "goodsId": { + "type": "integer", + "format": "int64", + "description": "์ƒํ’ˆ ID" + }, + "name": { + "type": "string", + "description": "์ƒํ’ˆ๋ช…" + }, + "brand": { + "type": "string", + "description": "์ƒํ’ˆ ๋ธŒ๋žœ๋“œ" + }, + "description": { + "type": "string", + "description": "์ƒํ’ˆ ์„ค๋ช…" + }, + "url": { + "type": "string", + "description": "์ƒํ’ˆ ์ด๋™ URL" + }, + "sku": { + "type": "string", + "description": "์ƒํ’ˆ ์ฝ”๋“œ" + }, + "action": { + "$ref": "#/components/schemas/ShopLiveCampaignGoodsActionTypeEnum" + }, + "payload": { + "type": "string", + "description": "์ƒํ’ˆ ํด๋ฆญ์‹œ ์ด๋™ํ•  URL ์ •๋ณด๋ฅผ ํฌํ•จํ•˜๋Š” json string" + }, + "medias": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShopLiveCampaignGoodsMediaDto" + } + }, + "showingNow": { + "type": "boolean", + "description": "์ƒํ’ˆ ๋…ธ์ถœ ์—ฌ๋ถ€" + }, + "soldOut": { + "type": "boolean", + "description": "์ƒํ’ˆ ๋งค์ง„ ์—ฌ๋ถ€" + }, + "originalPrice": { + "type": "number", + "format": "double", + "description": "์ƒํ’ˆ ๊ธฐ๋ณธ ๊ฐ€๊ฒฉ" + }, + "discountedPrice": { + "type": "number", + "format": "double", + "description": "์ƒํ’ˆ ํ• ์ธ ๊ฐ€๊ฒฉ" + }, + "discountPercentage": { + "type": "number", + "format": "double", + "description": "์ƒํ’ˆ ํ• ์ธ์œจ" + }, + "currency": { + "type": "string", + "description": "์žฌํ™” ๋‹จ์œ„" + }, + "traceId": { + "type": "string", + "description": "์ƒํ’ ํด๋ฆญ ์ถ”์  ID" + } + } + }, + "ShopLiveCampaignGoodsMediaDto": { + "type": "object", + "required": [ + "id", + "mediaType", + "url", + "size", + "width", + "height" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "๋ฏธ๋””์–ด ID" + }, + "mediaType": { + "$ref": "#/components/schemas/ShopLiveCampaignGoodsMediaTypeEnum" + }, + "url": { + "type": "string", + "description": "์ƒํ’ˆ ๋ฏธ๋””์–ด URL" + }, + "size": { + "type": "integer", + "format": "int64", + "description": "์ƒํ’ˆ ๋ฏธ๋””์–ด ์‚ฌ์ด์ฆˆ" + }, + "width": { + "type": "integer", + "format": "int32", + "description": "์ƒํ’ˆ ๋ฏธ๋””์–ด ๊ฐ€๋กœ ์‚ฌ์ด์ฆˆ" + }, + "height": { + "type": "integer", + "format": "int32", + "description": "์ƒํ’ˆ ๋ฏธ๋””์–ด ์„ธ๋กœ ์‚ฌ์ด์ฆˆ" + } + } + }, + "ReferralCodeDto": { + "type": "object", + "required": [ + "referralCode" + ], + "properties": { + "referralCode": { + "type": "string" + } + } + }, + "CategoryBestProductDto": { + "type": "object", + "required": [ + "isBest" + ], + "properties": { + "categoryId": { + "type": "string" + }, + "categoryTitle": { + "type": "string" + }, + "isBest": { + "type": "boolean" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + }, + "updatedAtMillis": { + "type": "integer", + "format": "int64" + } + } + }, + "ShopLiveCampaignMetadataStateEnum": { + "type": "string", + "description": "- `NOT_EXIST` -> ์กด์žฌํ•˜์ง€ ์•Š๋Š” ์บ ํŽ˜์ธ\n- `READY` -> ์ค€๋น„์ค‘\n- `ONAIR` -> ๋ฐฉ์†ก์ค‘\n- `CLOSING` -> ์ข…๋ฃŒ์ค‘\n- `CLOSED` -> ์ข…๋ฃŒ\n", + "enum": [ + "NOT_EXIST", + "READY", + "ONAIR", + "CLOSING", + "CLOSED" + ] + }, + "ShopLiveCampaignStateEnum": { + "type": "string", + "description": "- `NOT_EXIST` -> ์กด์žฌํ•˜์ง€ ์•Š๋Š” ์บ ํŽ˜์ธ\n- `READY` -> ์ค€๋น„์ค‘\n- `ONAIR` -> ๋ฐฉ์†ก์ค‘\n- `CLOSED` -> ์ข…๋ฃŒ\n", + "enum": [ + "NOT_EXIST", + "READY", + "ONAIR", + "CLOSED" + ] + }, + "ShopLiveCampaignGoodsActionTypeEnum": { + "type": "string", + "enum": [ + "LINK" + ] + }, + "ShopLiveCampaignGoodsMediaTypeEnum": { + "type": "string", + "enum": [ + "IMAGE" + ] + }, + "MultiResolutionImageDto": { + "type": "object", + "required": [ + "url_1x", + "url_2x", + "url_3x" + ], + "properties": { + "url_1x": { + "type": "string" + }, + "url_2x": { + "type": "string" + }, + "url_3x": { + "type": "string" + } + } + }, + "MultiResolutionImageListDto": { + "type": "object", + "required": [ + "urls_1x", + "urls_2x", + "urls_3x" + ], + "properties": { + "urls_1x": { + "type": "array", + "items": { + "type": "string" + } + }, + "urls_2x": { + "type": "array", + "items": { + "type": "string" + } + }, + "urls_3x": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SellerContentImagesDto": { + "type": "object", + "required": [ + "contentType", + "multiResolutionImages" + ], + "properties": { + "contentType": { + "$ref": "damoa-seller-api.yaml#/components/schemas/SellerContentTypeEnum" + }, + "multiResolutionImages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + } + } + } + }, + "UserDeliveryAddressAddRequestDto": { + "type": "object", + "required": [ + "address" + ], + "properties": { + "address": { + "$ref": "#/components/schemas/DeliveryAddressDto" + }, + "request": { + "type": "string", + "description": "๋ฐฐ์†ก ์š”์ฒญ ์‚ฌํ•ญ" + } + } + }, + "UserDeliveryAddressDto": { + "type": "object", + "required": [ + "id", + "address" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "minimum": 1 + }, + "address": { + "$ref": "#/components/schemas/DeliveryAddressDto" + }, + "request": { + "type": "string", + "description": "๋ฐฐ์†ก ์š”์ฒญ ์‚ฌํ•ญ" + } + } + }, + "PointHistoryBundleResponseDto": { + "type": "object", + "required": [ + "PointHistoyDto" + ], + "properties": { + "PointHistories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PointHistoryResponseDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "PointHistoryResponseDto": { + "type": "object", + "required": [ + "id", + "title", + "amount", + "amountType", + "expiredDetails", + "occurrenceAtMillis", + "occurrenceType", + "occurrenceId" + ], + "properties": { + "id": { + "type": "string", + "description": "์ ๋ฆฝ๊ธˆ ํžˆ์Šคํ† ๋ฆฌ ๊ณ ์œ  ์•„์ด๋””" + }, + "title": { + "type": "string" + }, + "subTitle": { + "type": "string" + }, + "amount": { + "type": "integer", + "format": "int64" + }, + "amountType": { + "$ref": "#/components/schemas/PointAmountTypeEnum" + }, + "expiredDetails": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PointAccumulateDetailResponseDto" + } + }, + "occurrenceAtMillis": { + "description": "์ ๋ฆฝ๊ธˆ ํžˆ์Šคํ† ๋ฆฌ ๋ฐœ์ƒ ์‹œ๊ฐ„ (epochMilliSeconds)", + "type": "integer", + "format": "int64" + }, + "occurrenceType": { + "$ref": "#/components/schemas/PointOccurrenceTypeEnum" + }, + "occurrenceId": { + "description": "์ ๋ฆฝ๊ธˆ ๋ฐœ์ƒ ์› ID occurrenceType์— ๋”ฐ๋ผ ๋‹ค๋ฅธ ๋ถ„๊ธฐ", + "type": "string" + } + } + }, + "PointAmountTypeEnum": { + "type": "string", + "enum": [ + "PLUS", + "MINUS" + ] + }, + "PointOccurrenceTypeEnum": { + "type": "string", + "description": "- ์ ๋ฆฝ๊ธˆ ์ ๋ฆฝ/์‚ฌ์šฉ/์†Œ๋ฉธ/์ทจ์†Œ ๋ฐœ์ƒ ํƒ€์ž…\n- ACCUMULATE_EVENT ์ด๋ฒคํŠธ๋กœ ์ ๋ฆฝ๋จ\n- ACCUMULATE_ORDER_ACCEPT ์ฃผ๋ฌธ ํ™•์ •์œผ๋กœ ์ ๋ฆฝ๋จ\n- WITHDRAW_ORDER_CANCEL ์ฃผ๋ฌธ ์ทจ์†Œ๋กœ ํ™˜๋ถˆ์ ๋ฆฝ๋จ\n- USE_ADMIN ๊ด€๋ฆฌ์ž๊ฐ€ ์ฐจ๊ฐํ•จ\n- ACCUMULATE_ADMIN ๊ด€๋ฆฌ์ž ๊ถŒํ•œ์œผ๋กœ ์ ๋ฆฝ๋จ\n- USE_ORDER_CREATE ์ฃผ๋ฌธ ์ƒ์„ฑ์œผ๋กœ ์‚ฌ์šฉ๋จ\n- EXPIRED ๊ธฐํ•œ ๋งŒ๋ฃŒ๋จ\n", + "enum": [ + "ACCUMULATE_EVENT", + "ACCUMULATE_ORDER_ACCEPT", + "WITHDRAW_ORDER_CANCEL", + "USE_ADMIN", + "ACCUMULATE_ADMIN", + "USE_ORDER_CREATE", + "EXPIRED" + ] + }, + "PointAccumulateDetailResponseDto": { + "type": "object", + "required": [ + "id", + "expiredAtMillis", + "amount" + ], + "properties": { + "id": { + "description": "์ ๋ฆฝ๊ธˆ ํžˆ์Šคํ† ๋ฆฌ ๊ณ ์œ  ์ƒ์„ธ ์•„์ด๋””", + "type": "string" + }, + "expiredAtMillis": { + "type": "integer", + "format": "int64" + }, + "amount": { + "type": "integer", + "format": "int64" + } + } + }, + "NowUsablePointDto": { + "type": "object", + "required": [ + "amount" + ], + "properties": { + "amount": { + "type": "integer", + "format": "int64" + } + } + }, + "PromotionAttendedStateDto": { + "type": "object", + "required": [ + "attended" + ], + "properties": { + "attended": { + "type": "boolean" + } + } + }, + "ProductAggregationDto": { + "type": "object", + "description": "์ƒํ’ˆ ์ง‘๊ณ„(aggregation)", + "required": [ + "productFeatureGroupAggregationList" + ], + "properties": { + "totalCount": { + "type": "integer", + "format": "int64" + }, + "productFeatureGroupAggregationList": { + "deprecated": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductFeatureGroupAggregationDto" + } + }, + "productAggregationGroup": { + "$ref": "#/components/schemas/ProductAggregationGroupDto" + } + } + }, + "ProductAggregationGroupDto": { + "type": "object", + "description": "์ƒํ’ˆ ์ง‘๊ณ„ ์ •๋ณด ๊ทธ๋ฃน", + "required": [ + "productFeatureGroupAggregationList", + "productCategoryAggregationList", + "brandAggregationList" + ], + "properties": { + "productFeatureGroupAggregationList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductFeatureGroupAggregationDto" + } + }, + "productCategoryAggregationList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryAggregationDto" + } + }, + "brandAggregationList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BrandAggregationDto" + } + } + } + }, + "ProductFeatureGroupAggregationDto": { + "type": "object", + "description": "group ๋ณ„๋กœ ์†์„ฑ ํƒœ๊ทธ ๊ฐœ์ˆ˜ ๋‚ด๋ฆผ์ฐจ์ˆœ์œผ๋กœ ๋‚ด๋ ค์ค€๋‹ค", + "properties": { + "group": { + "$ref": "#/components/schemas/ProductFeatureGroupDto" + }, + "productFeatureAggregation": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductFeatureAggregationDto" + } + } + } + }, + "ProductFeatureAggregationDto": { + "type": "object", + "properties": { + "productFeature": { + "$ref": "#/components/schemas/ProductFeatureDto" + }, + "count": { + "type": "integer", + "format": "int64" + } + } + }, + "ProductCategoryAggregationDto": { + "type": "object", + "properties": { + "categoryId": { + "type": "string" + }, + "count": { + "type": "integer", + "format": "int64" + } + } + }, + "BrandAggregationDto": { + "type": "object", + "properties": { + "brandName": { + "type": "string" + }, + "count": { + "type": "integer", + "format": "int64" + } + } + }, + "ProductFeatureListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductFeatureDto" + } + } + } + }, + "ProductFeatureDto": { + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string" + }, + "title": { + "type": "string" + }, + "groupId": { + "type": "string" + }, + "groupTitle": { + "type": "string" + } + } + }, + "ProductFeatureGroupDto": { + "type": "object", + "required": [ + "id", + "title" + ], + "properties": { + "id": { + "type": "string" + }, + "title": { + "type": "string" + } + } + }, + "UserReferralSummaryDto": { + "type": "object", + "required": [ + "totalAccrualPoint", + "totalReferralCount", + "totalUnopenedBonusBoxCount" + ], + "properties": { + "totalAccrualPoint": { + "description": "์œ ์ € ์ถ”์ฒœ ์ด ์ ๋ฆฝ์•ก (๋ณด๋„ˆ์Šค ๋ณด์ƒ ํฌํ•จ)", + "type": "integer", + "format": "int64" + }, + "totalReferralCount": { + "description": "์ด ์œ ์ € ์ถ”์ฒœ ์ˆ˜", + "type": "integer", + "format": "int64" + }, + "totalUnopenedBonusBoxCount": { + "description": "์•„์ง ์—ด์ง€์•Š์€ ๋ณด๋„ˆ์Šค ์ƒ์ž ์ˆ˜", + "type": "integer", + "format": "int64" + } + } + }, + "UserReferralRewardSummaryDto": { + "type": "object", + "required": [ + "totalAccrualPoint", + "totalReferral" + ], + "properties": { + "totalAccrualPoint": { + "type": "integer", + "format": "int64" + } + } + }, + "UserReferralBonusBoxOpenResultDto": { + "type": "object", + "required": [ + "pointAmount" + ], + "properties": { + "pointAmount": { + "type": "integer", + "format": "int64", + "description": "BonusBox ์—์„œ ์–ป์€ ์ ๋ฆฝ๊ธˆ" + } + } + }, + "UserReferralRewardPolicyDto": { + "type": "object", + "required": [ + "totalAccrualLimitByReferral", + "validDaysByReferral", + "joinRewardAmountForReferee", + "bonusBoxPolicies" + ], + "properties": { + "totalAccrualLimitByReferral": { + "type": "integer", + "format": "int64" + }, + "validDaysByReferral": { + "type": "integer", + "format": "int32" + }, + "joinRewardAmountForReferee": { + "type": "integer", + "format": "int64" + }, + "bonusBoxPolicies": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BonusBoxPolicyDto" + } + } + } + }, + "BonusBoxPolicyDto": { + "type": "object", + "description": "๋ณด๋„ˆ์Šค ๋ฐ•์Šค๋ฅผ ๋ฐœ๊ธ‰ํ•˜๊ธฐ ์œ„ํ•œ ์ •์ฑ…", + "required": [ + "bonusRewardType", + "referralCount" + ], + "properties": { + "bonusRewardType": { + "$ref": "#/components/schemas/BonusRewardTypeEnum" + }, + "referralCount": { + "description": "bonusBox ๋ฅผ ๋ฐ›๊ธฐ ์œ„ํ•ด ์ถฉ์กฑํ•ด์•ผ ํ•  referral ์ˆ˜", + "type": "integer", + "format": "int32" + } + } + }, + "BonusRewardTypeEnum": { + "type": "string", + "enum": [ + "REPEAT", + "ONE_TIME" + ], + "description": "๋ณด๋„ˆ์Šค ๋ฐ•์Šค ๋ฐœ๊ธ‰์ •์ฑ… ์œ ํ˜•: * ๋ฐ˜๋ณตํ˜• ๋ณด์ƒ (REPEAT): referralCount ๋ฅผ ๋งŒ์กฑํ•  ๋•Œ ๋งˆ๋‹ค ๋ณด๋„ˆ์Šค ๋ฐ•์Šค ์ง€๊ธ‰ (์˜ˆ: 5๋กœ ์„ค์ • ์‹œ 5,10,15,20.. ๋งˆ๋‹ค ์ง€๊ธ‰) * ์ผํšŒ์„ฑ ๋ณด์ƒ (ONE_TIME): referralCount ๋งŒ์กฑ ์‹œ ์ผํšŒ ์ง€๊ธ‰\n" + }, + "UserReferralRewardEstimationRequestDto": { + "type": "object", + "required": [ + "phoneNumbers" + ], + "properties": { + "phoneNumbers": { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + } + }, + "UserReferralRewardEstimationDto": { + "type": "object", + "required": [ + "phoneNumber", + "pointAmount", + "rewarded" + ], + "properties": { + "phoneNumber": { + "type": "string" + }, + "pointAmount": { + "type": "integer", + "format": "int64", + "description": "์ถ”์ฒœ ์ ๋ฆฝ๊ธˆ ์˜ˆ์ƒ๊ธˆ์•ก" + }, + "rewarded": { + "type": "boolean", + "description": "์ด๋ฏธ ์ถ”์ฒœ์„ ํ†ตํ•ด ๋ณด์ƒ ๋ฐ›์•˜๋Š”์ง€ ์—ฌ๋ถ€" + } + } + }, + "UserReferralRewardEstimationListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserReferralRewardEstimationDto" + } + } + } + }, + "CreateUserReferralRequestDto": { + "type": "object", + "required": [ + "phoneNumber", + "referrerName", + "dynamicLink" + ], + "properties": { + "phoneNumber": { + "type": "string" + }, + "referrerName": { + "type": "string" + }, + "dynamicLink": { + "type": "string" + }, + "message": { + "type": "string" + } + } + }, + "CreateUserReferralResponseDto": { + "type": "object", + "required": [ + "reward" + ], + "properties": { + "reward": { + "$ref": "#/components/schemas/ReferralRewardResultDto" + } + } + }, + "CreateProductReferralRequestDto": { + "type": "object", + "required": [ + "orderLineId", + "productId", + "referralCode" + ], + "properties": { + "orderLineId": { + "type": "string" + }, + "productId": { + "type": "string" + }, + "referralCode": { + "type": "string" + } + } + }, + "ReferralRewardResultDto": { + "type": "object", + "description": "์ถ”์ฒœ ๋ณด์ƒ ์ •๋ณด", + "required": [ + "pointAmount" + ], + "properties": { + "pointAmount": { + "type": "integer", + "format": "int64", + "description": "์ ๋ฆฝ๊ธˆ ์•ก์ˆ˜" + } + } + }, + "JoinReferredUserRequestDto": { + "type": "object", + "required": [ + "referralCode" + ], + "properties": { + "referralCode": { + "type": "string" + } + } + }, + "JoinReferredUserResponseDto": { + "type": "object", + "required": [ + "reward" + ], + "properties": { + "reward": { + "$ref": "#/components/schemas/ReferralRewardResultDto" + } + } + }, + "ActiveGameListResponse": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GameDto" + } + } + } + }, + "GameUserProgressInfoResponse": { + "type": "object", + "required": [ + "level", + "exp", + "requiredExpToNextLevel", + "inGameCredit", + "isGameAchievable", + "gameAchievedCount" + ], + "properties": { + "level": { + "type": "integer", + "format": "int32" + }, + "exp": { + "type": "integer", + "format": "int32" + }, + "requiredExpToNextLevel": { + "type": "integer", + "format": "int32" + }, + "inGameCredit": { + "type": "integer", + "format": "int32" + }, + "isGameAchievable": { + "type": "boolean" + }, + "gameAchievedCount": { + "type": "integer", + "format": "int32" + } + } + }, + "GameUseInGameCreditRequest": { + "type": "object", + "required": [ + "useCredit" + ], + "properties": { + "useCredit": { + "type": "integer", + "format": "int32" + } + } + }, + "GameDto": { + "type": "object", + "required": [ + "gameId", + "title", + "rewardTitle" + ], + "properties": { + "gameId": { + "type": "string" + }, + "title": { + "type": "string" + }, + "rewardTitle": { + "description": "๋ณด์ƒ๋ช… (ex. ์ปคํ”ผ ๊ธฐํ”„ํ‹ฐ์ฝ˜)", + "type": "string" + } + } + }, + "GameMissionsResponse": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GameMissionDto" + } + } + } + }, + "GameMissionAchieveRequest": { + "type": "object", + "required": [ + "missionType" + ], + "properties": { + "missionType": { + "$ref": "#/components/schemas/GameMissionTypeEnum" + }, + "referenceId": { + "description": "๋ฏธ์…˜์— ๋”ฐ๋ผ ๋ถ€๊ฐ€ ์ •๋ณด๋ฅผ ๋‹ด๊ธฐ ์œ„ํ•œ ํ•„๋“œ (ex. ๊ธฐํš์ „ ID)", + "type": "string" + } + } + }, + "GameMissionRewardReceiveResponse": { + "type": "object", + "required": [ + "inGameCredit" + ], + "properties": { + "inGameCredit": { + "type": "integer", + "format": "int32" + } + } + }, + "GameMissionDto": { + "type": "object", + "required": [ + "id", + "title", + "inGameCreditReward", + "missionType", + "completeCount", + "isRewardReceivable" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "inGameCreditReward": { + "type": "integer", + "format": "int32" + }, + "repeatIntervalInMins": { + "type": "integer", + "format": "int64" + }, + "missionType": { + "$ref": "#/components/schemas/GameMissionTypeEnum" + }, + "referenceId": { + "description": "๋ฏธ์…˜์— ๋”ฐ๋ผ ๋ถ€๊ฐ€ ์ •๋ณด๋ฅผ ๋‹ด๊ธฐ ์œ„ํ•œ ํ•„๋“œ (ex. ๊ธฐํš์ „ ID)", + "type": "string" + }, + "resetCycleDays": { + "type": "integer", + "format": "int32" + }, + "maxCompleteCount": { + "type": "integer", + "format": "int32" + }, + "lastCompletedAtMillis": { + "type": "integer", + "format": "int64" + }, + "completeCount": { + "type": "integer", + "format": "int32" + }, + "isRewardReceivable": { + "type": "boolean" + } + } + }, + "GameAchieveRequest": { + "type": "object", + "required": [ + "phoneNumber" + ], + "properties": { + "phoneNumber": { + "type": "string" + } + } + }, + "GameMissionTypeEnum": { + "type": "string", + "enum": [ + "PURCHASE_PRODUCT", + "FE_VALID_ATTENDANCE", + "FE_VALID_VIEWING_TO_30_SEC_RECOMMENDED", + "FE_VALID_VIEWING_TO_30_SEC_STYLE_SHOT", + "FE_VALID_VIEWING_TO_30_SEC_COLLECTION", + "FE_VALID_VIEWING_TO_30_SEC_NEW_IN_PRODUCT", + "FE_VALID_VIEWING_TO_30_SEC_BEST", + "FE_VALID_VIEWING_TO_30_SEC_HOT_DEAL", + "FE_VALID_VIEWING_TO_30_SEC_SHOPPING_MALL", + "FE_VALID_VIEWING_TO_30_SEC_DESIGNER" + ] + }, + "AutocompleteResponseDto": { + "type": "object", + "required": [ + "brands" + ], + "properties": { + "brands": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BrandAutocompleteCandidateDto" + } + } + } + }, + "BrandAutocompleteCandidateDto": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "ProductCategoryReviewGuideDataDto": { + "type": "object", + "required": [ + "textGuides", + "imageWithTitles", + "type", + "gridImage" + ], + "properties": { + "textGuides": { + "type": "array", + "items": { + "type": "string" + } + }, + "imageWithTitles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryReviewGuideImageWithTitleDto" + } + }, + "type": { + "$ref": "#/components/schemas/ProductCategoryReviewGuideTypeEnum" + }, + "gridImage": { + "type": "string" + } + } + }, + "ProductCategoryReviewGuideTypeEnum": { + "description": "์‚ฌ์ง„ ๋ฆฌ๋ทฐ ๊ฐ€์ด๋“œ์˜ ํƒ€์ž…", + "type": "string", + "enum": [ + "IMAGE_WITH_TITLE", + "GRID_IMAGE", + "NONE" + ] + }, + "StyleShotListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StyleShotDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "StyleShotDto": { + "type": "object", + "required": [ + "id", + "styleShotImages", + "styleCategory", + "equippedProductItemIds" + ], + "properties": { + "id": { + "description": "์Šคํƒ€์ผ ์ƒท id", + "type": "string" + }, + "styleShotImages": { + "description": "์Šคํƒ€์ผ ์ƒท ์ด๋ฏธ์ง€ url", + "type": "array", + "minItems": 1, + "maxItems": 4, + "items": { + "$ref": "#/components/schemas/StyleShotImageDto" + } + }, + "styleShotTags": { + "description": "์Šคํƒ€์ผ ์ƒท ํƒœ๊ทธ id ๋ฆฌ์ŠคํŠธ", + "type": "array", + "items": { + "type": "string" + } + }, + "styleCategory": { + "$ref": "#/components/schemas/StyleCategoryDto" + }, + "equippedProductItemIds": { + "description": "์ฐฉ์šฉ ์ƒํ’ˆ ์•„์ดํ…œ ID, empty list๋งŒ ์‘๋‹ต(deprecated)", + "type": "array", + "items": { + "type": "string" + } + }, + "text": { + "type": "string" + }, + "editor": { + "type": "string" + }, + "fashionModelHeightAsCentiMeter": { + "type": "integer", + "format": "int32" + }, + "fashionModelWeightAsKiloGram": { + "type": "integer", + "format": "int32" + }, + "fashionModelShoeSizeAsMilliMeter": { + "type": "integer", + "format": "int32" + } + } + }, + "EquippedProductListDto": { + "type": "object", + "required": [ + "equippedProducts", + "favoriteIds", + "freeReturnTargetProductIds" + ], + "properties": { + "equippedProducts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EquippedProductDto" + } + }, + "freeReturnTargetProductIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "StyleShotImageDto": { + "required": [ + "id", + "url_1x", + "url_2x", + "url_3x", + "priority" + ], + "properties": { + "id": { + "description": "์ด๋ฏธ์ง€ id", + "type": "string" + }, + "url_1x": { + "type": "string" + }, + "url_2x": { + "type": "string" + }, + "url_3x": { + "type": "string" + }, + "priority": { + "description": "์ด๋ฏธ์ง€ ์กฐํšŒ ์‹œ ์ˆœ์„œ(1๋ถ€ํ„ฐ ์˜ค๋ฆ„์ฐจ์ˆœ)", + "minimum": 1, + "type": "integer", + "format": "int32" + } + } + }, + "StyleCategoryDto": { + "type": "object", + "required": [ + "id", + "name", + "priority" + ], + "properties": { + "id": { + "description": "์Šคํƒ€์ผ ์นดํ…Œ๊ณ ๋ฆฌ id", + "type": "integer", + "format": "int64" + }, + "name": { + "description": "์Šคํƒ€์ผ ์นดํ…Œ๊ณ ๋ฆฌ ํ•œ๊ธ€๋ช…", + "type": "string" + }, + "representative_url_1x": { + "type": "string" + }, + "representative_url_2x": { + "type": "string" + }, + "representative_url_3x": { + "type": "string" + }, + "priority": { + "description": "์Šคํƒ€์ผ ์นดํ…Œ๊ณ ๋ฆฌ ์กฐํšŒ ์‹œ ์ˆœ์„œ", + "type": "integer", + "format": "int32" + } + } + }, + "StyleCategoryListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StyleCategoryDto" + } + } + } + }, + "DeliveryPredictionListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeliveryPredictionDto" + } + } + } + }, + "DeliveryPredictionDto": { + "type": "object", + "required": [ + "kstDeliveryPredictionDate", + "probability" + ], + "properties": { + "kstDeliveryPredictionDate": { + "type": "string", + "description": "ISO-8601 format string (uuuu-MM-dd)" + }, + "probability": { + "description": "ํ•ด๋‹น ์ผ์ž์— ๋ฐฐ์†ก์ด ์™„๋ฃŒ๋  ํ™•๋ฅ ", + "type": "integer", + "format": "int32" + } + } + }, + "PurchaseMeasurementsStatisticsListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PurchaseMeasurementsStatisticsDto" + } + } + } + }, + "PurchaseMeasurementsStatisticsDto": { + "type": "object", + "required": [ + "size", + "count", + "ratio" + ], + "properties": { + "size": { + "description": "์ƒํ’ˆ ์‚ฌ์ด์ฆˆ ์˜ต์…˜ ํƒ€์ดํ‹€", + "type": "string" + }, + "count": { + "description": "๊ตฌ๋งค ๊ฐœ์ˆ˜", + "type": "integer", + "format": "int64" + }, + "ratio": { + "description": "์ „์ฒด ๊ตฌ๋งค ๊ฐœ์ˆ˜์— ๋Œ€ํ•œ ๋น„์œจ", + "type": "integer", + "format": "int32" + } + } + }, + "PurchaseMeasurementsDto": { + "type": "object", + "required": [ + "bodySizeType", + "isSimilarBodySize", + "list" + ], + "properties": { + "bodySizeType": { + "$ref": "#/components/schemas/BodySizeTypeEnum" + }, + "isSimilarBodySize": { + "description": "์œ ์‚ฌ์ฒดํ˜• ๊ตฌ๋งค๋ฐ์ดํ„ฐ ์ธ์ง€ ์—ฌ๋ถ€", + "type": "boolean" + }, + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PurchaserSizeDto" + } + } + } + }, + "PurchaserSizeDto": { + "type": "object", + "required": [ + "purchaserBodySize", + "purchaseSizeOptionName" + ], + "properties": { + "purchaserBodySize": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PurchaserBodySizeDto" + } + }, + "purchaseSizeOptionName": { + "description": "๊ตฌ๋งคํ•œ ์‚ฌ์ด์ฆˆ ์˜ต์…˜ ํƒ€์ดํ‹€", + "type": "string" + } + } + }, + "PurchaserBodySizeDto": { + "type": "object", + "required": [ + "type", + "value" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/BodySizeTypeEnum" + }, + "value": { + "description": "๊ตฌ๋งค์ž์˜ ์‚ฌ์ด์ฆˆ", + "type": "integer", + "format": "int32" + } + } + }, + "BodySizeTypeEnum": { + "type": "string", + "enum": [ + "HEIGHT_AS_CENTI_METER", + "WEIGHT_AS_KILO_GRAM", + "TOP_SIZE", + "BOTTOM_SIZE_AS_INCH", + "SHOE_SIZE_AS_MILLI_METER" + ] + }, + "AttendanceCheckHistoryListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AttendanceCheckHistoryDto" + } + } + } + }, + "AttendanceCheckHistoryDto": { + "type": "object", + "required": [ + "days", + "attended", + "rewardPolicyType", + "pointAmount" + ], + "properties": { + "days": { + "description": "์ถœ์„ ์ฒดํฌ n์ผ์ฐจ", + "type": "integer", + "format": "int32" + }, + "pointAmount": { + "description": "์ถœ์„ ์ฒดํฌ ์ฐธ์—ฌ ์‹œ ์ ๋ฆฝ๊ธˆ ๊ธˆ์•ก", + "type": "integer", + "format": "int64" + }, + "attended": { + "description": "์ถœ์„ ์ฒดํฌ ์ฐธ์—ฌ ์—ฌ๋ถ€", + "type": "boolean" + }, + "attendedAt": { + "description": "์ถœ์„ ์ฒดํฌ ์ฐธ์—ฌ ์‹œ๊ฐ„ epochMillis(์ถœ์„์น˜ ์•Š์•˜์„ ๋•Œ null)", + "type": "integer", + "format": "int64" + }, + "rewardPolicyType": { + "$ref": "#/components/schemas/AttendanceRewardPolicyTypeEnum" + } + } + }, + "ApiErrorResponse": { + "type": "object", + "properties": { + "msg": { + "type": "string", + "description": "reason for error" + }, + "traceId": { + "type": "string", + "description": "trace id for debug" + }, + "code": { + "type": "number", + "x-enum-varnames": [ + "INTERNAL_FAILURE", + "EXTERNAL_FAILURE", + "ALREADY_EXISTS", + "NOT_AUTHORIZED", + "INVALID_VALUE", + "RESOURCE_NOT_FOUND", + "LIMITATION_EXCEEDED", + "LOGIN_REQUIRED", + "ACCESS_DENIED", + "ACCESS_TOKEN_EXPIRED", + "REFRESH_TOKEN_EXPIRED", + "INVALID_ACCESS_TOKEN", + "INVALID_REFRESH_TOKEN", + "COUPON_NOT_ENABLED", + "COUPON_NOT_CONSUMABLE", + "COUPON_ISSUE_BEFORE_BEGIN", + "COUPON_ISSUE_AFTER_END", + "COUPON_ISSUE_LIMIT_EXCEEDED", + "COUPON_ISSUE_LIMIT_PER_USER_EXCEEDED", + "COUPON_ISSUE_NOT_TARGET", + "COUPON_BOOK_ISSUABLES_NOT_EXIST", + "DISPLAYING_COUPONS_ISSUABLE_NOT_EXIST", + "PAYMENT_NOT_FULLY_PAID", + "MINIMUM_PAYMENT_PRICE_LIMIT_EXCEPTION", + "REVIEW_REPORTED_BY_SELF", + "REVIEW_REPORTED_TWICE", + "VALIDATAION_BANK_ACCOUNT_FAILURE", + "DUPLICATED_MALL_PRODUCT_CODE", + "PRODUCT_WITHOUT_POLICY_TARGET", + "DUPLICATED_BRAND_CODE", + "SEND_DELIVERY_TRACE_REQUEST_FAILED", + "RECEIVE_DELIVERY_TRACE_RESULT_FAILED", + "SEND_DELIVERY_TRACE_RESULT_RESPONSE_FAILED", + "TICKET_PROCESSING_IS_REQUIRED_TO_CONFIRM_RECEIPT", + "CAN_ONLY_CONFIRM_RECEIPT_OF_PAID_ORDER_LINE", + "CANNOT_CONFIRM_RECEIPT_WHEN_DELIVERY_NOT_COMPLETE", + "CANNOT_REQUEST_REFUND_AFTER_CONFIRM_RECEIPT", + "LACK_OF_POINT", + "ORDER_LINE_COUNT_LIMIT_PER_ORDER_EXCEEDED", + "ORDER_ALREADY_DISPATCHED", + "CANNOT_CHANGE_DELIVERY_AREA", + "ORDER_UNAVAILABLE_PRODUCT_ITEM", + "CANNOT_APPEND_TICKET", + "CANNOT_EXCEED_ALREADY_REQUESTED_AMOUNT", + "ATTENDANCE_CHECK_COMPLETED", + "PRODUCT_NOT_BELONGS_TO_BRAND" + ], + "enum": [ + -999999, + -888888, + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 1001, + 1002, + 1003, + 1004, + 60001, + 60002, + 61001, + 61002, + 61003, + 61004, + 61005, + 62001, + 62002, + 70001, + 70003, + 2001, + 2002, + 3001, + 4001, + 4002, + 5001, + 6001, + 6002, + 6003, + 7001, + 7002, + 7003, + 7004, + 7005, + 7006, + 7007, + 7008, + 7009, + 7010, + 7011, + 8001, + 9001 + ] + } + } + } + } + } +} \ No newline at end of file diff --git a/assets/input/fireblocks.swagger.json b/assets/input/fireblocks.swagger.json new file mode 100644 index 0000000..32ebdb1 --- /dev/null +++ b/assets/input/fireblocks.swagger.json @@ -0,0 +1,13598 @@ +{ + "openapi": "3.0.0", + "info": { + "title": "Fireblocks API", + "version": "1.0.0", + "contact": { + "email": "support@fireblocks.com" + } + }, + "servers": [ + { + "url": "https://api.fireblocks.io/v1" + } + ], + "x-readme": { + "explorer-enabled": false, + "samples-languages": [ + "curl", + "javascript", + "python" + ] + }, + "paths": { + "/vault/accounts": { + "get": { + "summary": "List vault accounts", + "description": "Gets all vault accounts in your workspace.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vault_accounts = fireblocks.get_vault_accounts()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAccounts = await fireblocks.getVaultAccounts();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "query", + "name": "namePrefix", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "nameSuffix", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minAmountThreshold", + "required": false, + "schema": { + "type": "number" + } + }, + { + "in": "query", + "name": "assetId", + "required": false, + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "A list of vault accounts", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VaultAccount" + } + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + }, + "post": { + "summary": "Create a new vault account", + "description": "Creates a new vault account with the requested name.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAccount = fireblocks.create_vault_account(name, hiddenOnUI, customer_ref_id, auto_fueling)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAccount = await fireblocks.createVaultAccount(name, hiddenOnUI, customerRefId, autoFueling);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "description": "Account Name", + "type": "string" + }, + "hiddenOnUI": { + "description": "Optional - if true, the created account and all related transactions will not be shown on Fireblocks console", + "type": "boolean" + }, + "customerRefId": { + "description": "Optional - Sets a customer reference ID", + "type": "string" + }, + "autoFuel": { + "description": "Optional - Sets the autoFuel property of the vault account", + "type": "boolean" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "A Vault Account object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/VaultAccount" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/vault/accounts_paged": { + "get": { + "summary": "List vault acounts (Paginated)", + "description": "Gets all vault accounts in your workspace. This endpoint returns a limited amount of results with a quick response time.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vault_accounts = fireblocks.get_vault_accounts_with_page_info(filters)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAccounts = await fireblocks.getVaultAccountsWithPageInfo(filters);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "query", + "name": "namePrefix", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "nameSuffix", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minAmountThreshold", + "required": false, + "schema": { + "type": "number" + } + }, + { + "in": "query", + "name": "assetId", + "required": false, + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + }, + { + "in": "query", + "name": "orderBy", + "required": false, + "schema": { + "type": "string", + "enum": [ + "ASC", + "DESC" + ], + "default": "DESC" + } + }, + { + "in": "query", + "name": "before", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "after", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "number", + "minimum": 1, + "maximum": 500, + "default": 200 + } + } + ], + "responses": { + "200": { + "description": "A VaultAccountsPagedResponse object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/VaultAccountsPagedResponse" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}": { + "get": { + "summary": "Find a vault account by ID", + "description": "Returns the requested vault account.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vault_account = fireblocks.get_vault_account(vault_account_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAccount = await fireblocks.getVaultAccount(vault_account_id);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "The ID of the vault account to return type: string", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + } + ], + "responses": { + "200": { + "description": "A Vault Account object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/VaultAccount" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + }, + "put": { + "summary": "Rename a vault account", + "description": "Renames the requested vault account.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAccount = fireblocks.update_vault_account(vault_account_id, name)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAccount = await fireblocks.updateVaultAccount(vautlAccountId, name);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "The ID of the vault account to edit", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "description": "Account Name", + "type": "string" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "OK", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/vault/asset_wallets": { + "get": { + "summary": "List asset wallets (Paginated)", + "description": "Gets all asset wallets at all of the vault accounts in your workspace. An asset wallet is an asset at a vault account. This method allows fast traversal of all account balances.\n**Note:**\n - This API endpoint is in limited availability and available for selected customers. If you would like to get early access to this endpoint, please reach out to [Fireblocks Support](https://support.fireblocks.io/hc/en-us/requests/new?ticket_form_id=36000337220)\n - This API call is subject to [rate limits](https://developers.fireblocks.com/reference/rate-limiting).\n", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vault_accounts = fireblocks.get_asset_wallets(filters)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAccounts = await fireblocks.getAssetWallets(filters);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "query", + "name": "totalAmountLargerThan", + "description": "When specified, only asset wallets with total balance larger than this amount are returned.", + "required": false, + "schema": { + "type": "number" + } + }, + { + "in": "query", + "name": "assetId", + "required": false, + "description": "When specified, only asset wallets cross vault accounts that have this asset ID are returned.", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + }, + { + "in": "query", + "name": "before", + "required": false, + "description": "Fetches the next paginated response before this element. This element is a cursor and is returned at the response of the previous page.", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "after", + "required": false, + "description": "Fetches the next paginated response after this element. This element is a cursor and is returned at the response of the previous page.", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "limit", + "required": false, + "description": "The maximum number of asset wallets in a single response. The default is 200 and the maximum is 1000.", + "schema": { + "type": "number", + "minimum": 1, + "maximum": 1000, + "default": 200 + } + } + ], + "responses": { + "200": { + "description": "A PaginatedAssetWalletResponse object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PaginatedAssetWalletResponse" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/hide": { + "post": { + "summary": "Hide a vault account in the console", + "description": "Hides the requested vault account from the web console view.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAsset = fireblocks.hide_vault_account(vault_account_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAsset = await fireblocks.hideVaultAccount(vaultAccountId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "The vault account to hide", + "schema": { + "type": "string", + "minimum": 1, + "format": "numeric", + "x-fb-entity": "vault_account" + } + } + ], + "responses": { + "201": { + "description": "OK", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/vault/accounts/{vaultAccountId}/unhide": { + "post": { + "summary": "Unhide a vault account in the console", + "description": "Makes a hidden vault account visible in web console view.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAsset = fireblocks.unhide_vault_account(vault_account_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAsset = await fireblocks.unhideVaultAccount(vaultAccountId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "The vault account to unhide", + "schema": { + "type": "string", + "minimum": 1, + "format": "numeric", + "x-fb-entity": "vault_account" + } + } + ], + "responses": { + "201": { + "description": "OK", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/activate": { + "post": { + "summary": "Activate a wallet in a vault account", + "description": "Initiates activation for a wallet in a vault account.", + "tags": [ + "Vaults" + ], + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "The ID of the vault account to return, or 'default' for the default vault account", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "The ID of the asset", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "OK", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateVaultAssetResponse" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/vault/accounts/{vaultAccountId}/set_customer_ref_id": { + "post": { + "summary": "Set an AML/KYT customer reference ID for a vault account", + "description": "Assigns an AML/KYT customer reference ID for the vault account.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAsset = fireblocks.set_vault_account_customer_ref_id(vault_account_id, customer_ref_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAsset = await fireblocks.setCustomerRefIdForVaultAccount(vaultAccountId, customerRefId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "The vault account ID", + "schema": { + "type": "string", + "minimum": 1, + "format": "numeric", + "x-fb-entity": "vault_account" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "customerRefId": { + "description": "Customer reference ID", + "type": "string" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "OK", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/vault/accounts/{vaultAccountId}/set_auto_fuel": { + "post": { + "summary": "Turn autofueling on or off", + "description": "Sets the autofueling property of the vault account to enabled or disabled.", + "tags": [ + "Vaults" + ], + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "The vault account ID", + "schema": { + "type": "string", + "minimum": 1, + "format": "numeric", + "x-fb-entity": "vault_account" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "autoFuel": { + "description": "Auto Fuel", + "type": "boolean" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "OK", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}": { + "get": { + "summary": "Get the asset balance for a vault account", + "description": "Returns a wallet for a specific asset of a vault account.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAsset = fireblocks.get_vault_account_asset(vault_account_id, asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAsset = await fireblocks.getVaultAccountAsset(vaultAccountId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "The ID of the vault account to return", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "The ID of the asset", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "A VaultAsset object", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/VaultAsset" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + }, + "post": { + "summary": "Create a new wallet", + "description": "Creates a wallet for a specific asset in a vault account.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAsset = fireblocks.create_vault_asset(vault_account_id, asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAsset = await fireblocks.createVaultAsset(vaultAccountId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "The ID of the vault account to return, or 'default' for the default vault account", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "The ID of the asset", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "eosAccountName": { + "description": "Optional - when creating an EOS wallet, the account name. If not provided, a random name will be generated", + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateVaultAssetResponse" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/balance": { + "post": { + "summary": "Refresh asset balance data", + "description": "Updates the balance of a specific asset in a vault account.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAsset = fireblocks.refresh_vault_asset_balance(vault_account_id, asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAsset = await fireblocks.refreshVaultAssetBalance(vaultAccountId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "The ID of the vault account to return", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "The ID of the asset", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "requestBody": { + "required": false, + "content": { + "*/*": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "A VaultAsset object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/VaultAsset" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/addresses": { + "get": { + "summary": "Get asset addresses", + "description": "Lists all addresses for specific asset of vault account.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "depositAddresses = fireblocks.get_deposit_addresses(vault_account_id, asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const depositAddresses = await fireblocks.getDepositAddresses(vaultAccountId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "The ID of the vault account to return", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "The ID of the asset", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "A list of deposit addresses", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VaultWalletAddress" + } + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + }, + "post": { + "summary": "Create new asset deposit address", + "description": "Creates a new deposit address for an asset of a vault account.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "address = fireblocks.generate_new_address(vault_account_id, asset_id, description, customer_ref_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const address = await fireblocks.generateNewAddress(vaultAccountId, assetId, description, customerRefId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "description": { + "description": "(Optional) Attach a description to the new address", + "type": "string" + }, + "customerRefId": { + "description": "Optional - Sets a customer reference ID", + "type": "string" + } + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "The ID of the vault account to return", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "The ID of the asset", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "The created address", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateAddressResponse" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/max_spendable_amount": { + "get": { + "summary": "Get the maximum spendable amount in a single transaction.", + "description": "Get the maximum amount of a particular asset that can be spent in a single transaction from a specified vault account (UTXO assets only, with a limitation on number of inputs embedded). Send several transactions if you want to spend more than the maximum spendable amount.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "address = fireblocks.set_address_description(vault_account_id, asset_id, address, tag, description)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const address = await fireblocks.setAddressDescription(vaultAccountId, assetId, address, tag, description);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "The ID of the vault account, or 'default' for the default vault account", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "The ID of the asset", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + }, + { + "in": "query", + "name": "manualSignging", + "required": false, + "description": "False by default. The maximum number of inputs depends if the transaction will be signed by an automated co-signer server or on a mobile device.", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "OK", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}": { + "put": { + "summary": "Update address description", + "description": "Updates the description of an existing address of an asset in a vault account.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "address = fireblocks.set_address_description(vault_account_id, asset_id, address, tag, description)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const address = await fireblocks.setAddressDescription(vaultAccountId, assetId, address, tag, description);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "description": { + "description": "The address description", + "type": "string" + } + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "The ID of the vault account", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "The ID of the asset", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + }, + { + "in": "path", + "name": "addressId", + "required": true, + "description": "The address for which to add a description. For XRP, use
:, for all other assets, use only the address", + "schema": { + "type": "string" + } + } + ], + "responses": { + "201": { + "description": "OK", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/set_customer_ref_id": { + "post": { + "summary": "Assign AML customer reference ID", + "description": "Sets an AML/KYT customer reference ID for a specific address.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAsset = fireblocks.set_customer_ref_id_for_address(vault_account_id, asset_id, address_id, customer_ref_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAsset = await fireblocks.setCustomerRefIdForAddress(vaultAccountId, assetId, addressId, customerRefId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "The ID of the vault account", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "The ID of the asset", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + }, + { + "in": "path", + "name": "addressId", + "required": true, + "description": "The address for which to add a description. For XRP, use
:, for all other assets, use only the address", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "customerRefId": { + "description": "Customer reference ID", + "type": "string" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "OK", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/create_legacy": { + "post": { + "summary": "Convert a segwit address to legacy format", + "description": "Converts an existing segwit address to the legacy format.", + "tags": [ + "Vaults" + ], + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "The ID of the vault account", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "The ID of the asset", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + }, + { + "in": "path", + "name": "addressId", + "required": true, + "description": "The segwit address to translate", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "The created address", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateAddressResponse" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/unspent_inputs": { + "get": { + "summary": "Get UTXO unspent inputs information", + "description": "Returns unspent inputs information of an asset in a vault account.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAsset = fireblocks.get_unspent_inputs(vault_account_id, asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAsset = await fireblocks.getUnspentInputs(vaultAccountId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "The ID of the vault account", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "The ID of the asset", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "List of Unspent information per input", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UnspentInputsResponse" + } + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/vault/public_key_info/": { + "get": { + "summary": "Get the public key information", + "description": "Gets the public key information based on derivation path and signing algorithm.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "pubKey = fireblocks.get_public_key_info(algorithm, derivation_path, compressed)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const PublicKeyInfoArgs = { algorithm: 'MPC_ECDSA_SECP256K1', derivationPath: '[44,0,0,0,0]' } const pubKey = await fireblocks.getPublicKeyInfo(PublicKeyInfoArgs);\n", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "query", + "name": "derivationPath", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "algorithm", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "compressed", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Public key information", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PublicKeyInformation" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/{change}/{addressIndex}/public_key_info": { + "get": { + "summary": "Get the public key for a vault account", + "description": "Gets the public key information for the vault account.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "pubKey = fireblocks.get_public_key_info_for_vault_account(asset_id, vault_account_id, change, address_index, compressed)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const PublicKeyInfoArgs = { assetId: 'ETH', vaultAccountId: 0, change: 0, addressIndex: 0, compressed: true } const pubKey = await fireblocks.getPublicKeyInfoForVaultAccount(PublicKeyInfoArgs);\n", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + }, + { + "in": "path", + "name": "change", + "required": true, + "schema": { + "type": "number" + } + }, + { + "in": "path", + "name": "addressIndex", + "required": true, + "schema": { + "type": "number" + } + }, + { + "in": "query", + "name": "compressed", + "required": false, + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Public Key Information", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PublicKeyInformation" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/vault/assets": { + "get": { + "summary": "Get asset balance for chosen assets", + "description": "Gets the assets amount summary for all accounts or filtered accounts.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "assets_balance = fireblocks.get_vault_assets_balance(accout_name_prefix, account_name_suffix)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const assetsBalance = await fireblocks.getVaultAssetsBalance(accountNamePrefix, accountNameSuffix);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "query", + "name": "accountNamePrefix", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "accountNameSuffix", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Amount by asset", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VaultAsset" + } + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/vault/assets/{assetId}": { + "get": { + "summary": "Get vault balance by asset", + "description": "Gets the vault balance summary for an asset.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "assets_balance = fireblocks.get_vault_balance_by_asset(asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const assetsBalance = await fireblocks.getVaultBalanceByAsset(assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "assetId", + "required": true, + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "Vault amount by asset", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/VaultAsset" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/exchange_accounts": { + "get": { + "summary": "List exchange accounts", + "description": "Returns all exchange accounts.", + "tags": [ + "Exchange accounts" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "exchangeAccounts = fireblocks.get_exchange_accounts()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const exchangeAccounts = await fireblocks.getExchangeAccounts();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "An ExchangeAccount object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExchangeAccount" + } + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/exchange_accounts/{exchangeAccountId}": { + "get": { + "summary": "Find a specific exchange account", + "description": "Returns an exchange account by ID.", + "tags": [ + "Exchange accounts" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "exchangeAccount = fireblocks.get_exchange_account(exchangeAccountId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const exchnageAccount = await fireblocks.get_exchange_account(exchangeAccountId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "exchangeAccountId", + "required": true, + "description": "The ID of the exchange account to return", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "An ExchangeAccount object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ExchangeAccount" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/exchange_accounts/{exchangeAccountId}/internal_transfer": { + "post": { + "summary": "Internal tranfer for exchange accounts", + "description": "Transfers funds between trading accounts under the same exchange account.", + "tags": [ + "Exchange accounts" + ], + "parameters": [ + { + "in": "path", + "name": "exchangeAccountId", + "required": true, + "description": "The ID of the exchange account to return", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "201": { + "description": "Transfer succeeded", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "asset": { + "type": "string" + }, + "amount": { + "type": "string" + }, + "sourceType": { + "$ref": "#/components/schemas/TradingAccountType" + }, + "destType": { + "$ref": "#/components/schemas/TradingAccountType" + } + } + } + } + } + } + } + }, + "/exchange_accounts/{exchangeAccountId}/convert": { + "post": { + "summary": "Convert exchange account funds from the source asset to the destination asset. Coinbase (USD to USDC, USDC to USD) and Bitso (MXN to USD) are supported conversions.", + "tags": [ + "Exchange accounts" + ], + "parameters": [ + { + "in": "path", + "name": "exchangeAccountId", + "required": true, + "description": "The ID of the exchange account. Please make sure the exchange supports conversions. To find the ID of your exchange account, use GET/exchange_accounts.", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "Conversion successful", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "srcAsset": { + "type": "string", + "description": "Name of the source asset (must be in a currency that is supported for conversions in the selected exchange type that corresponds to your exchange ID)" + }, + "destAsset": { + "type": "string", + "description": "Name of the destination asset (must be in a currency that is supported for conversions in the selected exchange type that corresponds to your exchange ID)" + }, + "amount": { + "type": "number", + "description": "The amount to transfer (in the currency of the source asset)" + } + }, + "required": [ + "srcAsset", + "destAsset", + "amount" + ] + } + } + } + } + } + }, + "/exchange_accounts/{exchangeAccountId}/{assetId}": { + "get": { + "summary": "Find an asset for an exchange account", + "description": "Returns an asset for an exchange account.", + "tags": [ + "Exchange accounts" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "exchangeAsset = fireblocks.get_exchange_account_asset(exchangeAccountId, assetId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const exchangeAsset = await fireblocks.getExchangeAsset(exchangeAccountId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "exchangeAccountId", + "required": true, + "description": "The ID of the exchange account to return", + "schema": { + "type": "string", + "minimum": 1 + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "The ID of the asset to return", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "An ExchangeAccountAsset object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ExchangeAsset" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/fiat_accounts": { + "get": { + "summary": "List fiat accounts", + "description": "Returns all fiat accounts.", + "tags": [ + "Fiat accounts" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "transactions = fireblocks.get_fiat_accounts()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const transactions = await fireblocks.getFiatAccounts();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "A fiat account object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FiatAccount" + } + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/fiat_accounts/{accountId}": { + "get": { + "summary": "Find a specific fiat account", + "description": "Returns a fiat account by ID.", + "tags": [ + "Fiat accounts" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "transactions = fireblocks.get_fiat_account_by_id(account_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const transactions = await fireblocks.getFiatAccountById(accountId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "accountId", + "required": true, + "description": "The ID of the fiat account to return", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "A fiat account object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/FiatAccount" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/fiat_accounts/{accountId}/redeem_to_linked_dda": { + "post": { + "summary": "Redeem funds to DDA", + "description": "Redeems funds to the linked DDA.", + "tags": [ + "Fiat accounts" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "transactions = fireblocks.redeem_to_linked_dda(account_id, amount)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const transactions = await fireblocks.redeemToLinkedDDA(accountId, amount);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "accountId", + "required": true, + "description": "The ID of the fiat account to use", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "201": { + "description": "Transfer succeeded", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "amount": { + "type": "number" + } + } + } + } + } + } + } + }, + "/fiat_accounts/{accountId}/deposit_from_linked_dda": { + "post": { + "summary": "Deposit funds from DDA", + "description": "Deposits funds from the linked DDA.", + "tags": [ + "Fiat accounts" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "transactions = fireblocks.deposit_from_linked_dda(account_id, amount)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const transactions = await fireblocks.depositFromLinkedDDA(accountId, amount);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "accountId", + "required": true, + "description": "The ID of the fiat account to use", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "201": { + "description": "Transfer succeeded", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "amount": { + "type": "number" + } + } + } + } + } + } + } + }, + "/network_connections": { + "get": { + "summary": "List network connections", + "description": "Returns all network connections.\n\n**Note:** This API call is subject to Flexible Routing Schemes.\n\nYour routing policy defines how your transactions are routed.\nYou can choose 1 of the 3 different schemes mentioned below for each asset type:\n - **None**; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to `None` will fail.\n - **Custom**; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one.\n - **Default**; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as \"Profile Routing\"\n\nDefault Workspace Presets:\n - Network Profile Crypto โ†’ **Custom**\n - Network Profile FIAT โ†’ **None**\n - Network Connection Crypto โ†’ **Default**\n - Network Connection FIAT โ†’ **Default**\n\n - **Note**: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).\n", + "tags": [ + "Network connections" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "network_connections = fireblocks.get_network_connections()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const networkConnections = await fireblocks.getNetworkConnections();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "A list of network connections", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkConnectionResponse" + } + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + }, + "post": { + "summary": "Creates a new network connection", + "description": "Initiates a new network connection.\n\n**Note:** This API call is subject to Flexible Routing Schemes.\n\nYour routing policy defines how your transactions are routed.\nYou can choose 1 of the 3 different schemes mentioned below for each asset type:\n - **None**; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to `None` will fail.\n - **Custom**; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one.\n - **Default**; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as \"Profile Routing\"\n\nDefault Workspace Presets:\n - Network Profile Crypto โ†’ **Custom**\n - Network Profile FIAT โ†’ **None**\n - Network Connection Crypto โ†’ **Default**\n - Network Connection FIAT โ†’ **Default**\n\n - **Note**: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).\n", + "tags": [ + "Network connections" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NetworkConnection" + } + } + } + }, + "responses": { + "201": { + "description": "A Network Connection object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/NetworkConnectionResponse" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/network_connections/{connectionId}/set_routing_policy": { + "patch": { + "summary": "Update network connection routing policy.", + "description": "Updates an existing network connection's routing policy.\n\n**Note:** This API call is subject to Flexible Routing Schemes.\n\nYour routing policy defines how your transactions are routed.\nYou can choose 1 of the 3 different schemes mentioned below for each asset type:\n - **None**; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to `None` will fail.\n - **Custom**; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one.\n - **Default**; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as \"Profile Routing\"\n\nDefault Workspace Presets:\n - Network Profile Crypto โ†’ **Custom**\n - Network Profile FIAT โ†’ **None**\n - Network Connection Crypto โ†’ **Default**\n - Network Connection FIAT โ†’ **Default**\n\n - **Note**: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).\n", + "tags": [ + "Network connections" + ], + "parameters": [ + { + "in": "path", + "name": "connectionId", + "required": true, + "description": "The ID of the network connection", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "routingPolicy": { + "$ref": "#/components/schemas/NetworkConnectionRoutingPolicy" + } + }, + "required": [ + "routingPolicy" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Network ID", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "properties": { + "success": { + "type": "boolean" + } + }, + "required": [ + "success" + ] + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/network_connections/{connectionId}/is_third_party_routing/{assetType}": { + "get": { + "summary": "Retrieve third-party network routing validation by asset type.", + "description": "The Fireblocks Network allows for flexibility around incoming deposits. A receiver can receive network deposits to locations other than Fireblocks. This endpoint validates whether future transactions are routed to the displayed recipient or to a 3rd party.", + "tags": [ + "Network connections" + ], + "parameters": [ + { + "in": "path", + "name": "connectionId", + "required": true, + "description": "The ID of the network connection", + "schema": { + "type": "string", + "minimum": 1 + } + }, + { + "in": "path", + "name": "assetType", + "required": true, + "description": "The destination asset type", + "schema": { + "type": "string", + "enum": [ + "CRYPTO", + "SIGNET", + "SEN", + "SIGNET_TEST", + "SEN_TEST" + ] + } + } + ], + "responses": { + "200": { + "description": "result for the validation", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "properties": { + "isThirdPartyRouting": { + "type": "boolean" + }, + "description": { + "type": "string" + } + } + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/network_connections/{connectionId}": { + "get": { + "summary": "Get a network connection", + "description": "Gets a network connection by ID.\n\n**Note:** This API call is subject to Flexible Routing Schemes.\n\nYour routing policy defines how your transactions are routed.\nYou can choose 1 of the 3 different schemes mentioned below for each asset type:\n - **None**; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to `None` will fail.\n - **Custom**; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one.\n - **Default**; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as \"Profile Routing\"\n\nDefault Workspace Presets:\n - Network Profile Crypto โ†’ **Custom**\n - Network Profile FIAT โ†’ **None**\n - Network Connection Crypto โ†’ **Default**\n - Network Connection FIAT โ†’ **Default**\n\n - **Note**: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).\n", + "tags": [ + "Network connections" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "network_connection = fireblocks.get_network_connection_by_id(connectionId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const network_connection = await fireblocks.getNetworkConnection(connectionId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "connectionId", + "required": true, + "description": "The ID of the connection", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "A network connection", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/NetworkConnectionResponse" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + }, + "delete": { + "summary": "Deletes a network connection by ID", + "description": "Deletes an existing network connection specified by its connection ID.\n\n**Note:** This API call is subject to Flexible Routing Schemes.\n\nYour routing policy defines how your transactions are routed.\nYou can choose 1 of the 3 different schemes mentioned below for each asset type:\n - **None**; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to `None` will fail.\n - **Custom**; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one.\n - **Default**; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as \"Profile Routing\"\n\nDefault Workspace Presets:\n - Network Profile Crypto โ†’ **Custom**\n - Network Profile FIAT โ†’ **None**\n - Network Connection Crypto โ†’ **Default**\n - Network Connection FIAT โ†’ **Default**\n\n - **Note**: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).\n", + "tags": [ + "Network connections" + ], + "parameters": [ + { + "in": "path", + "name": "connectionId", + "required": true, + "description": "The ID of the network connection to delete", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "Network ID", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "properties": { + "success": { + "type": "boolean" + } + }, + "required": [ + "success" + ] + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/network_ids": { + "get": { + "summary": "Returns all network IDs, both local IDs and discoverable remote IDs", + "description": "Retrieves a list of all local and discoverable remote network IDs.\n\n**Note:** This API call is subject to Flexible Routing Schemes.\n\nYour routing policy defines how your transactions are routed.\nYou can choose 1 of the 3 different schemes mentioned below for each asset type:\n - **None**; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to `None` will fail.\n - **Custom**; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one.\n - **Default**; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as \"Profile Routing\"\n\nDefault Workspace Presets:\n - Network Profile Crypto โ†’ **Custom**\n - Network Profile FIAT โ†’ **None**\n - Network Connection Crypto โ†’ **Default**\n - Network Connection FIAT โ†’ **Default**\n\n - **Note**: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).\n", + "tags": [ + "Network connections" + ], + "responses": { + "200": { + "description": "A list of network IDs", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "allOf": [ + { + "$ref": "#/components/schemas/NetworkIdResponse" + } + ] + } + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + }, + "post": { + "summary": "Creates a new Network ID", + "description": "Creates a new Network ID.\n\n**Note:** This API call is subject to Flexible Routing Schemes.\n\nYour routing policy defines how your transactions are routed.\nYou can choose 1 of the 3 different schemes mentioned below for each asset type:\n - **None**; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to `None` will fail.\n - **Custom**; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one.\n - **Default**; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as \"Profile Routing\"\n\nDefault Workspace Presets:\n - Network Profile Crypto โ†’ **Custom**\n - Network Profile FIAT โ†’ **None**\n - Network Connection Crypto โ†’ **Default**\n - Network Connection FIAT โ†’ **Default**\n\n - **Note**: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).\n", + "tags": [ + "Network connections" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "type": "string" + }, + "routingPolicy": { + "$ref": "#/components/schemas/NetworkIdRoutingPolicy" + } + }, + "required": [ + "name" + ] + } + } + } + }, + "responses": { + "201": { + "description": "Returns the new network ID in your workspace", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/NetworkIdResponse" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/network_ids/{networkId}": { + "get": { + "summary": "Returns specific network ID.", + "description": "Retrieves a network by its ID.\n\n**Note:** This API call is subject to Flexible Routing Schemes.\n\nYour routing policy defines how your transactions are routed.\nYou can choose 1 of the 3 different schemes mentioned below for each asset type:\n - **None**; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to `None` will fail.\n - **Custom**; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one.\n - **Default**; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as \"Profile Routing\"\n\nDefault Workspace Presets:\n - Network Profile Crypto โ†’ **Custom**\n - Network Profile FIAT โ†’ **None**\n - Network Connection Crypto โ†’ **Default**\n - Network Connection FIAT โ†’ **Default**\n\n - **Note**: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).\n", + "tags": [ + "Network connections" + ], + "parameters": [ + { + "in": "path", + "name": "networkId", + "required": true, + "description": "The ID of the network", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "Network ID", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/NetworkIdResponse" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + }, + "delete": { + "summary": "Deletes specific network ID.", + "description": "Deletes a network by its ID.\n\n**Note:** This API call is subject to Flexible Routing Schemes.\n\nYour routing policy defines how your transactions are routed.\nYou can choose 1 of the 3 different schemes mentioned below for each asset type:\n - **None**; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to `None` will fail.\n - **Custom**; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one.\n - **Default**; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as \"Profile Routing\"\n\nDefault Workspace Presets:\n - Network Profile Crypto โ†’ **Custom**\n - Network Profile FIAT โ†’ **None**\n - Network Connection Crypto โ†’ **Default**\n - Network Connection FIAT โ†’ **Default**\n\n - **Note**: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).\n", + "tags": [ + "Network connections" + ], + "parameters": [ + { + "in": "path", + "name": "networkId", + "required": true, + "description": "The ID of the network", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "Network ID", + "content": { + "*/*": { + "schema": { + "properties": { + "success": { + "type": "boolean" + } + }, + "required": [ + "success" + ] + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/network_ids/{networkId}/set_routing_policy": { + "patch": { + "summary": "Update network id routing policy.", + "description": "Updates the routing policy of a specified network ID.\n\n**Note:** This API call is subject to Flexible Routing Schemes.\n\nYour routing policy defines how your transactions are routed.\nYou can choose 1 of the 3 different schemes mentioned below for each asset type:\n - **None**; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to `None` will fail.\n - **Custom**; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one.\n - **Default**; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as \"Profile Routing\"\n\nDefault Workspace Presets:\n - Network Profile Crypto โ†’ **Custom**\n - Network Profile FIAT โ†’ **None**\n - Network Connection Crypto โ†’ **Default**\n - Network Connection FIAT โ†’ **Default**\n\n - **Note**: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).\n", + "tags": [ + "Network connections" + ], + "parameters": [ + { + "in": "path", + "name": "networkId", + "required": true, + "description": "The ID of the network", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "routingPolicy": { + "$ref": "#/components/schemas/NetworkIdRoutingPolicy" + } + }, + "required": [ + "routingPolicy" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Network ID", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "properties": { + "success": { + "type": "boolean" + } + }, + "required": [ + "success" + ] + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/network_ids/{networkId}/set_discoverability": { + "patch": { + "summary": "Update network ID's discoverability.", + "description": "Update whether or not the network ID is discoverable by others.\n\n**Note:** This API call is subject to Flexible Routing Schemes.\n\nYour routing policy defines how your transactions are routed.\nYou can choose 1 of the 3 different schemes mentioned below for each asset type:\n - **None**; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to `None` will fail.\n - **Custom**; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one.\n - **Default**; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as \"Profile Routing\"\n\nDefault Workspace Presets:\n - Network Profile Crypto โ†’ **Custom**\n - Network Profile FIAT โ†’ **None**\n - Network Connection Crypto โ†’ **Default**\n - Network Connection FIAT โ†’ **Default**\n\n - **Note**: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).\n", + "tags": [ + "Network connections" + ], + "parameters": [ + { + "in": "path", + "name": "networkId", + "required": true, + "description": "The ID of the network", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "isDiscoverable": { + "type": "boolean" + } + }, + "required": [ + "isDiscoverable" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Network ID", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "properties": { + "success": { + "type": "boolean" + } + }, + "required": [ + "success" + ] + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/network_ids/{networkId}/set_name": { + "patch": { + "summary": "Update network ID's name.", + "description": "Updates name of a specified network ID.\n\n**Note:** This API call is subject to Flexible Routing Schemes.\n\nYour routing policy defines how your transactions are routed.\nYou can choose 1 of the 3 different schemes mentioned below for each asset type:\n - **None**; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to `None` will fail.\n - **Custom**; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one.\n - **Default**; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as \"Profile Routing\"\n\nDefault Workspace Presets:\n - Network Profile Crypto โ†’ **Custom**\n - Network Profile FIAT โ†’ **None**\n - Network Connection Crypto โ†’ **Default**\n - Network Connection FIAT โ†’ **Default**\n\n - **Note**: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).\n", + "tags": [ + "Network connections" + ], + "parameters": [ + { + "in": "path", + "name": "networkId", + "required": true, + "description": "The ID of the network", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "type": "string" + } + }, + "required": [ + "name" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Network ID", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "properties": { + "success": { + "type": "boolean" + } + }, + "required": [ + "success" + ] + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/internal_wallets": { + "get": { + "summary": "List internal wallets", + "tags": [ + "Internal wallets" + ], + "description": "Gets a list of internal wallets.\n\n**Note**: BTC-based assets belonging to whitelisted addresses cannot be retrieved between 00:00 UTC and 00:01 UTC daily due to third-party provider, Blockchair, being unavailable for this 60 second period. Please wait until the next minute to retrieve BTC-based assets.\n", + "responses": { + "200": { + "description": "A list of internal wallets", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + }, + "post": { + "summary": "Create an internal wallet", + "tags": [ + "Internal wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "internalWallet = fireblocks.create_internal_wallet(name, customer_ref_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const internalWallet = await fireblocks.createInternalWallet(name, customerRefId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "description": "Creates a new internal wallet with the requested name.", + "responses": { + "200": { + "description": "A new wallet object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "type": "string", + "description": "the wallet's display name" + }, + "customerRefId": { + "description": "Optional - Sets a customer reference ID", + "type": "string" + } + } + } + } + } + } + } + }, + "/internal_wallets/{walletId}": { + "get": { + "summary": "Get assets for internal wallet", + "tags": [ + "Internal wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "internalWallet = fireblocks.get_internal_wallet(walletId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.getInternalWallet(walletId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "description": "Returns all assets in an internal wallet by ID.", + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "The ID of the wallet to return", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "A Wallet object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + }, + "delete": { + "summary": "Delete an internal wallet", + "tags": [ + "Internal wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = firebocks.delete_internal_wallet(walletId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.deleteInternalWallet(walletId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "description": "Deletes an internal wallet by ID.", + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "The ID of the wallet to delete", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "201": { + "description": "OK", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/internal_wallets/{walletId}/set_customer_ref_id": { + "post": { + "summary": "Set an AML/KYT customer reference ID for an internal wallet", + "tags": [ + "Internal wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = firebocks.set_customer_ref_id_for_internal_wallet(wallet_id, customer_ref_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.setCustomerRefIdForInternalWallet(walletId, customerRefId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "description": "Sets an AML/KYT customer reference ID for the specific internal wallet.", + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "The wallet ID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "customerRefId": { + "description": "Customer reference ID", + "type": "string" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "OK", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/internal_wallets/{walletId}/{assetId}": { + "get": { + "summary": "Get an asset from an internal wallet", + "tags": [ + "Internal wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "internalWalletAsset = fireblocks.get_internal_wallet_asset(walletId, assetId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const internalWalletAsset = fireblocks.getInternalWalletAsset(walletId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "description": "Returns information for an asset in an internal wallet.", + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "The ID of the wallet", + "schema": { + "type": "string", + "minimum": 1 + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "The ID of the asset to return", + "schema": { + "type": "string", + "minimum": 1, + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "A Wallet Asset object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/WalletAsset" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + }, + "post": { + "summary": "Add an asset to an internal wallet", + "tags": [ + "Internal wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "internalWalletAsset = fireblocks.create_internal_wallet_asset(walletId, assetId, address, tag)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const internalWalletAsset = await fireblocks.createInternalWalletAsset(walletContainerId, assetId, address, tag);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "description": "Adds an asset to an existing internal wallet.", + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "The ID of the wallet", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "The ID of the asset to add", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "A Wallet Asset object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/WalletAsset" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "address": { + "type": "string", + "description": "The wallet's address or, for EOS wallets, the account name" + }, + "tag": { + "type": "string", + "description": "for XRP wallets, the destination tag; for EOS, the memo; for the fiat providers (BLINC by BCB Group), the Bank Transfer Description" + } + }, + "required": [ + "address" + ] + } + } + } + } + }, + "delete": { + "summary": "Delete a whitelisted address from an internal wallet", + "tags": [ + "Internal wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = fireblocks.delete_internal_wallet_asset(walletId, assetId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.deleteInternalWalletAsset(walletId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "description": "Deletes a whitelisted address (for an asset) from an internal wallet.", + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "The ID of the wallet", + "schema": { + "type": "string", + "minimum": 1 + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "The ID of the asset to delete", + "schema": { + "type": "string", + "minimum": 1, + "x-fb-entity": "asset" + } + } + ], + "responses": { + "201": { + "description": "OK", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/external_wallets": { + "get": { + "summary": "List external wallets", + "description": "Gets a list of external wallets under the workspace.", + "tags": [ + "External wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "externalWallets = fireblocks.get_external_wallets()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const externalWallets = await fireblocks.getExternalWallets();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "A list of external wallets", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + }, + "post": { + "summary": "Create an external wallet", + "description": "Creates a new external wallet with the requested name.", + "tags": [ + "External wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "externalWallet = fireblocks.create_external_wallet(name, customer_ref_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const externalWallet = await fireblocks.createExternalWallet(name, customerRefId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "A Wallet object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "type": "string", + "description": "the wallet's display name" + }, + "customerRefId": { + "description": "Optional - Sets a customer reference ID", + "type": "string" + } + } + } + } + } + } + } + }, + "/external_wallets/{walletId}": { + "get": { + "summary": "Find an external wallet", + "description": "Returns an external wallet by ID.", + "tags": [ + "External wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "externalWallet = fireblocks.get_external_wallet(walletId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const externalWallet = await fireblocks.getExternalWallet(walletId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "The ID of the wallet to return", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "A Wallet object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + }, + "delete": { + "summary": "Delete an external wallet", + "description": "Deletes an external wallet by ID.", + "tags": [ + "External wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = firebocks.delete_external_wallet(walletId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.deleteExternalWallet(walletId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "The ID of the wallet to delete", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "201": { + "description": "OK", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/external_wallets/{walletId}/set_customer_ref_id": { + "post": { + "summary": "Set an AML customer reference ID for an external wallet", + "description": "Sets an AML/KYT customer reference ID for the specific external wallet.", + "tags": [ + "External wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = firebocks.set_customer_ref_id_for_external_wallet(wallet_id, customer_ref_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.setCustomerRefIdForExternalWallet(walletId, customerRefId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "The wallet ID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "customerRefId": { + "description": "Customer reference ID", + "type": "string" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "OK", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/external_wallets/{walletId}/{assetId}": { + "get": { + "summary": "Get an asset from an external wallet", + "description": "Returns an external wallet by wallet ID and asset ID.", + "tags": [ + "External wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "externalWalletAsset = fireblocks.get_external_wallet_asset(walletId, assetId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const externalWalletAsset = fireblocks.getExternalWalletAsset(walletId, assetId)", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "The ID of the wallet", + "schema": { + "type": "string", + "minimum": 1 + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "The ID of the asset to return", + "schema": { + "type": "string", + "minimum": 1, + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "A Wallet Asset object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ExternalWalletAsset" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + }, + "post": { + "summary": "Add an asset to an external wallet.", + "description": "Adds an asset to an existing external wallet.", + "tags": [ + "External wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "externalWalletAsset = fireblocks.create_external_wallet_asset(walletId, assetId, address, tag)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const externalWalletAsset = await fireblocks.createExternalWalletAsset(walletContainerId, assetId, address, tag);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "The ID of the wallet", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "The ID of the asset to add", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "A Wallet Asset object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ExternalWalletAsset" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "properties": { + "address": { + "type": "string", + "description": "The wallet's address (or xpub) of the wallet" + }, + "tag": { + "type": "string", + "description": "For XRP wallets, the destination tag; for EOS/XLM, the memo; for the fiat providers (BLINC by BCB Group), the Bank Transfer Description" + } + }, + "required": [ + "address" + ] + }, + { + "properties": { + "additionalInfo": { + "type": "object", + "oneOf": [ + { + "properties": { + "accountHolderGivenName": { + "type": "string" + }, + "accountHolderSurname": { + "type": "string" + }, + "accountHolderCity": { + "type": "string" + }, + "accountHolderCountry": { + "type": "string" + }, + "accountHolderAddress1": { + "type": "string" + }, + "accountHolderAddress2": { + "type": "string" + }, + "accountHolderDistrict": { + "type": "string" + }, + "accountHolderPostalCode": { + "type": "string" + }, + "iban": { + "type": "string" + }, + "ibanCity": { + "type": "string" + }, + "ibanCountry": { + "type": "string" + } + }, + "required": [ + "accountHolderGivenName", + "accountHolderCity", + "accountHolderCountry", + "accountHolderAddress1", + "accountHolderPostalCode", + "iban", + "ibanCity", + "ibanCountry" + ] + }, + { + "properties": { + "accountHolderGivenName": { + "type": "string" + }, + "accountHolderSurname": { + "type": "string" + }, + "accountHolderCity": { + "type": "string" + }, + "accountHolderCountry": { + "type": "string" + }, + "accountHolderAddress1": { + "type": "string" + }, + "accountHolderAddress2": { + "type": "string" + }, + "accountHolderDistrict": { + "type": "string" + }, + "accountHolderPostalCode": { + "type": "string" + }, + "abaRoutingNumber": { + "type": "string" + }, + "abaAccountNumber": { + "type": "string" + }, + "abaCountry": { + "type": "string" + } + }, + "required": [ + "accountHolderGivenName", + "accountHolderCity", + "accountHolderCountry", + "accountHolderAddress1", + "accountHolderPostalCode", + "abaRoutingNumber", + "abaAccountNumber", + "abaCountry" + ] + }, + { + "properties": { + "speiClabe": { + "type": "string" + }, + "speiName": { + "type": "string" + } + }, + "required": [ + "speiClabe" + ] + } + ] + } + }, + "required": [ + "additionalInfo" + ] + } + ] + } + } + } + } + }, + "delete": { + "summary": "Delete an asset from an external wallet", + "description": "Deletes an external wallet asset by ID.", + "tags": [ + "External wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = fireblocks.delete_external_wallet_asset(walletId, assetId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.deleteExternalWalletAsset(walletId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "The ID of the wallet", + "schema": { + "type": "string", + "minimum": 1 + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "The ID of the asset to delete", + "schema": { + "type": "string", + "minimum": 1, + "x-fb-entity": "asset" + } + } + ], + "responses": { + "201": { + "description": "OK", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/contracts": { + "get": { + "summary": "List contracts", + "description": "Gets a list of contracts.", + "tags": [ + "Contracts" + ], + "responses": { + "200": { + "description": "A list of contracts", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + }, + "post": { + "summary": "Create a contract", + "description": "Creates a new contract.", + "tags": [ + "Contracts" + ], + "responses": { + "200": { + "description": "A Wallet object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "type": "string", + "description": "the contract's display name" + } + } + } + } + } + } + } + }, + "/contracts/{contractId}": { + "get": { + "summary": "Find a specific contract", + "description": "Returns a contract by ID.", + "tags": [ + "Contracts" + ], + "parameters": [ + { + "in": "path", + "name": "contractId", + "required": true, + "description": "The ID of the contract to return", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "A Wallet object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + }, + "delete": { + "summary": "Delete a contract", + "description": "Deletes a contract by ID.", + "tags": [ + "Contracts" + ], + "parameters": [ + { + "in": "path", + "name": "contractId", + "required": true, + "description": "The ID of the contract to delete", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "201": { + "description": "OK", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/contracts/{contractId}/{assetId}": { + "get": { + "summary": "Find a contract asset", + "description": "Returns a contract asset by ID.", + "tags": [ + "Contracts" + ], + "parameters": [ + { + "in": "path", + "name": "contractId", + "required": true, + "description": "The ID of the contract", + "schema": { + "type": "string", + "minimum": 1 + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "The ID of the asset to return", + "schema": { + "type": "string", + "minimum": 1, + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "A Wallet Asset object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ExternalWalletAsset" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + }, + "post": { + "summary": "Add an asset to a contract", + "description": "Adds an asset to an existing contract.", + "tags": [ + "Contracts" + ], + "parameters": [ + { + "in": "path", + "name": "contractId", + "required": true, + "description": "The ID of the contract", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "The ID of the asset to add", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "A Wallet Asset object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ExternalWalletAsset" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "address": { + "type": "string", + "description": "The contract's address (or xpub) of the wallet" + }, + "tag": { + "type": "string", + "description": "The destination tag, for XRP wallets" + } + }, + "required": [ + "address" + ] + } + } + } + } + }, + "delete": { + "summary": "Delete a contract asset", + "description": "Deletes a contract asset by ID.", + "tags": [ + "Contracts" + ], + "parameters": [ + { + "in": "path", + "name": "contractId", + "required": true, + "description": "The ID of the contract", + "schema": { + "type": "string", + "minimum": 1 + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "The ID of the asset to delete", + "schema": { + "type": "string", + "minimum": 1, + "x-fb-entity": "asset" + } + } + ], + "responses": { + "201": { + "description": "OK", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/supported_assets": { + "get": { + "summary": "List all asset types supported by Fireblocks", + "description": "Returns all asset types supported by Fireblocks.", + "tags": [ + "Blockchains & assets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "supportedAssets = fireblocks.get_supported_assets()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const supportedAssets = await fireblocks.getSupportedAssets();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "A Transaction object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AssetTypeResponse" + } + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/estimate_network_fee": { + "get": { + "summary": "Estimate the required fee for an asset", + "description": "Gets the estimated required fee for an asset. For UTXO based assets, the response will contain the suggested fee per byte, for ETH/ETC based assets, the suggested gas price, and for XRP/XLM, the transaction fee.", + "tags": [ + "Blockchains & assets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "fee_result = fireblocks.get_fee_for_asset(asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const feeResult = await fireblocks.getFeeForAsset(assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "query", + "name": "assetId", + "description": "The asset for which to estimate the fee", + "required": true, + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "Estimated fees response", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/EstimatedNetworkFeeResponse" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/transactions/validate_address/{assetId}/{address}": { + "get": { + "summary": "Validate destination address", + "description": "Checks if an address is valid (for XRP, DOT, XLM, and EOS).", + "tags": [ + "Blockchains & assets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "const result = await fireblocks.validate_address(assetID, address)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.validateAddress(assetID, address)", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "assetId", + "required": true, + "description": "The asset of the address", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + }, + { + "in": "path", + "name": "address", + "required": true, + "description": "The address to validate", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "An Transaction object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ValidateAddressResponse" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/transactions": { + "get": { + "summary": "List transaction history", + "description": "Lists the transaction history for your workspace.", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "transactions = fireblocks.get_transactions(status, after)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const transactions = await fireblocks.getTransactions({\n status: args.status,\nafter: from });\n", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "query", + "name": "before", + "description": "Unix timestamp in milliseconds. Returns only transactions created before the specified date", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "after", + "description": "Unix timestamp in milliseconds. Returns only transactions created after the specified date", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "status", + "description": "You can filter by one of the statuses.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "orderBy", + "description": "The field to order the results by\n\n**Note**: Ordering by a field that is not createdAt may result with transactions that receive updates as you request the next or previous pages of results, resulting with missing those transactions.", + "required": false, + "schema": { + "type": "string", + "enum": [ + "createdAt", + "lastUpdated" + ] + } + }, + { + "in": "query", + "name": "sort", + "description": "The direction to order the results by", + "required": false, + "schema": { + "type": "string", + "enum": [ + "ASC", + "DESC" + ] + } + }, + { + "in": "query", + "name": "limit", + "description": "Limits the number of results. If not provided, a limit of 200 will be used. The maximum allowed limit is 500", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "default": 200 + } + }, + { + "in": "query", + "name": "sourceType", + "description": "The source type of the transaction", + "required": false, + "schema": { + "type": "string", + "enum": [ + "VAULT_ACCOUNT", + "EXCHANGE_ACCOUNT", + "INTERNAL_WALLET", + "EXTERNAL_WALLET", + "FIAT_ACCOUNT", + "NETWORK_CONNECTION", + "COMPOUND", + "UNKNOWN", + "GAS_STATION", + "END_USER_WALLET" + ] + } + }, + { + "in": "query", + "name": "sourceId", + "description": "The source ID of the transaction", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "destType", + "description": "The destination type of the transaction", + "required": false, + "schema": { + "type": "string", + "enum": [ + "VAULT_ACCOUNT", + "EXCHANGE_ACCOUNT", + "INTERNAL_WALLET", + "EXTERNAL_WALLET", + "FIAT_ACCOUNT", + "NETWORK_CONNECTION", + "COMPOUND", + "ONE_TIME_ADDRESS", + "END_USER_WALLET" + ] + } + }, + { + "in": "query", + "name": "destId", + "description": "The destination ID of the transaction", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "assets", + "description": "A list of assets to filter by, seperated by commas", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "txHash", + "description": "Returns only results with a specified txHash", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "sourceWalletId", + "description": "Returns only results where the source is a specific end user wallet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "destWalletId", + "description": "Returns only results where the destination is a specific end user wallet", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "A list of transactions", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + }, + "next-page": { + "$ref": "#/components/headers/next-page" + }, + "prev-page": { + "$ref": "#/components/headers/prev-page" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TransactionResponse" + } + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + }, + "post": { + "summary": "Create a new transaction", + "description": "Creates a new transaction.", + "tags": [ + "Transactions" + ], + "parameters": [ + { + "in": "header", + "name": "X-End-User-Wallet-Id", + "schema": { + "$ref": "#/components/headers/X-End-User-Wallet-Id" + } + } + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "tx_result = client.create_transaction( asset_id=\"BTC\", amount=\"50\", source=TransferPeerPath(VAULT_ACCOUNT, from_vault_account_id), destination=DestinationTransferPeerPath(VAULT_ACCOUNT, to_vault_account_id) )\n", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const payload: TransactionArguments = { assetId: asset, source: { type: sourceType, id: sourceId || 0 }, destination: { type: destinationType, id: String(destinationId) }, amount: String(amount), fee: String(fee), note: \"Created by fireblocks SDK\" }; const result = await fireblocks.createTransaction(payload);\n", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "A transaction object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateTransactionResponse" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TransactionRequest" + } + } + } + } + } + }, + "/transactions/estimate_fee": { + "post": { + "summary": "Estimate transaction fee", + "description": "Estimates the transaction fee for a transaction request.\n* Note: Supports all Fireblocks assets except ZCash (ZEC).", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "estimated_fee = client.estimate_fee_for_transaction( asset_id=\"BTC\", amount=\"50\", source=TransferPeerPath(VAULT_ACCOUNT, from_vault_account_id), destination=DestinationTransferPeerPath(VAULT_ACCOUNT, to_vault_account_id) )\n", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const payload: TransactionArguments = { assetId: asset, source: { type: sourceType, id: sourceId || 0 }, destination: { type: destinationType, id: String(destinationId) }, amount: Number(amount) }; const estimatedFee = await fireblocks.estimateFeeForTransaction(payload);\n", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TransactionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Estimated fees response", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/EstimatedTransactionFeeResponse" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/transactions/{txId}": { + "get": { + "summary": "Find a specific transaction by Fireblocks transaction ID", + "description": "Returns a transaction by ID.", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "tx = fireblocks.get_transaction_by_id(txId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const tx = await fireblocks.getTransactionById(txId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "txId", + "required": true, + "example": "00000000-0000-0000-0000-000000000000", + "description": "The ID of the transaction to return", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "An Transaction object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/TransactionResponse" + } + } + } + }, + "400": { + "$ref": "#/components/responses/Error" + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/transactions/external_tx_id/{externalTxId}/": { + "get": { + "summary": "Find a specific transaction by external transaction ID", + "description": "Returns transaction by external transaction ID.", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "tx = fireblocks.get_transaction_by_external_tx_id(externalTxId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const tx = await fireblocks.getTransactionByExternalTxId(externalTxId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "externalTxId", + "example": "00000000-0000-0000-0000-000000000000", + "required": true, + "description": "The external ID of the transaction to return", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "An Transaction object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/TransactionResponse" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/transactions/{txId}/set_confirmation_threshold": { + "post": { + "summary": "Set confirmation threshold by transaction ID", + "description": "Overrides the required number of confirmations for transaction completion by transaction ID.", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "set_conf_threshold = client.set_confirmation_threshold_by_tx_id(body)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const setConfThreshold = await fireblocks.setConfirmationThresholdByTxId(body);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SetConfirmationsThresholdRequest" + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "txId", + "required": true, + "description": "The ID of the transaction", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "Set successfully", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SetConfirmationsThresholdResponse" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/transactions/{txId}/drop": { + "post": { + "summary": "Drop ETH transaction by ID", + "description": "Drops a stuck ETH transaction and creates a replacement transaction.", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = fireblocks.drop_transaction(txId, fee_level)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.dropTransaction(txId, feeLevel);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DropTransactionRequest" + } + } + } + }, + "parameters": [ + { + "in": "header", + "name": "X-End-User-Wallet-Id", + "schema": { + "$ref": "#/components/headers/X-End-User-Wallet-Id" + } + }, + { + "in": "path", + "name": "txId", + "required": true, + "description": "The ID of the transaction", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "Created successfully", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/DropTransactionResponse" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/transactions/{txId}/cancel": { + "post": { + "summary": "Cancel a transaction", + "description": "Cancels a transaction by ID.", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = fireblocks.cancel_transaction_by_id(txId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.cancelTransactionById(txId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "header", + "name": "X-End-User-Wallet-Id", + "schema": { + "$ref": "#/components/headers/X-End-User-Wallet-Id" + } + }, + { + "in": "path", + "name": "txId", + "required": true, + "description": "The ID of the transaction to cancel", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "An Transaction object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CancelTransactionResponse" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/transactions/{txId}/freeze": { + "post": { + "summary": "Freeze a transaction", + "description": "Freezes a transaction by ID.", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = fireblocks.freeze_transaction(txId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.freezeTransaction(txId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "header", + "name": "X-End-User-Wallet-Id", + "schema": { + "$ref": "#/components/headers/X-End-User-Wallet-Id" + } + }, + { + "in": "path", + "name": "txId", + "required": true, + "description": "The ID of the transaction to freeze", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "freeze response", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/FreezeTransactionResponse" + } + } + } + } + } + } + }, + "/transactions/{txId}/unfreeze": { + "post": { + "summary": "Unfreeze a transaction", + "description": "Unfreezes a transaction by ID and makes the transaction available again.", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = fireblocks.unfreeze_transaction(txId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.unfreezeTransaction(txId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "header", + "name": "X-End-User-Wallet-Id", + "schema": { + "$ref": "#/components/headers/X-End-User-Wallet-Id" + } + }, + { + "in": "path", + "name": "txId", + "required": true, + "description": "The ID of the transaction to unfreeze", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "Unfreeze response", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/UnfreezeTransactionResponse" + } + } + } + } + } + } + }, + "/txHash/{txHash}/set_confirmation_threshold": { + "post": { + "summary": "Set confirmation threshold by transaction hash", + "description": "Overrides the required number of confirmations for transaction completion by transaction hash.", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "set_conf_threshold = client.set_confirmation_threshold_by_tx_hash(body)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const setConfThreshold = await fireblocks.setConfirmationThresholdByTxHash(body);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SetConfirmationsThresholdRequest" + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "txHash", + "required": true, + "description": "The TxHash", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "A list of transactions affected by the change", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SetConfirmationsThresholdResponse" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/payments/xb-settlements/configs": { + "post": { + "tags": [ + "Payments - cross-border settlement" + ], + "summary": "Create a new cross-border settlement configuration", + "description": "Create a new cross-border settlement configuration.
Configurations define the default assets, on-ramps, and off-ramps to use for the cross-border settlement.
\nA configuration must contain at least two steps - `ON_RAMP` and `VAULT_ACCOUNT`.
\nAll other steps (e.g., `OFF_RAMP`, `FIAT_DESTINATION`, etc.) are optional.
\nEvery step must include the `accountId` to be used, while `inputAssetId` and `outputAssetId` are optional. \nIf those are not provided, a default value will be used from the Corridor Settings.
\nIf the inputAssetId or the outputAssetId is provided for one of the objects, all assets in the objects must be consistent. For example, if the output asset of ON_RAMP is XLM_USDC_5F3T, then the input asset of the VAULT_ACCOUNT must also be XLM_USDC_5F3T..
\nYou can set a slippage amount for your configuration. Slippage is defined by basis points (bps). This value can be overloaded on execution. If you do not configure a slippage amount, the default slippage of 10000 bps (10%) is used.
\n**Note:** The reference content in this section documents the Payments Engine endpoint. The Payments Engine endpoint includes APIs available only for customers with the Payments Engine enabled on their accounts.\nThese endpoints are currently in beta and might be subject to changes.\nIf you want to learn more about the Fireblocks Payments Engine, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com.\n", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementConfigCreationRequestBody" + }, + "example": { + "name": "Flow Config Example", + "corridorId": "CO_US", + "steps": { + "ON_RAMP": { + "accountId": "3b7a1451-3453-4c96-a6a5-683cc8971d04" + }, + "VAULT_ACCOUNT": { + "accountId": "2" + }, + "OFF_RAMP": { + "accountId": "f2f74204-93ec-4614-870a-4ea2ad13aa0b" + } + }, + "conversionSlippageBasisPoints": 75 + } + } + } + }, + "responses": { + "200": { + "description": "Cross-border settlement configuration created successfully", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementConfigCreationResponse" + }, + "example": { + "configId": "074791cc-ef32-4920-8373-95efbeea66c5", + "corridorId": "CO_US", + "name": "Flow Config Example", + "steps": { + "ON_RAMP": { + "accountId": "3b7a1451-3453-4c96-a6a5-683cc8971d04", + "inputAssetId": "COP", + "outputAssetId": "USD" + }, + "VAULT_ACCOUNT": { + "accountId": "2", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + }, + "OFF_RAMP": { + "accountId": "f2f74204-93ec-4614-870a-4ea2ad13aa0b", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + } + }, + "conversionSlippageBasisPoints": 75, + "createdAt": 1680625226267 + } + } + } + }, + "400": { + "description": "Error creating cross-border request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized. Missing / invalid JWT token in Authorization header.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Internal error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "get": { + "tags": [ + "Payments - cross-border settlement" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "summary": "Get all the cross-border settlement configurations", + "description": "Get all the cross-border settlement configurations.
\n**Note:** The reference content in this section documents the Payments Engine endpoint. The Payments Engine endpoint includes APIs available only for customers with the Payments Engine enabled on their accounts.\nThese endpoints are currently in beta and might be subject to changes.\nIf you want to learn more about the Fireblocks Payments Engine, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com.\n", + "responses": { + "200": { + "description": "Returns all the cross-border settlement configurations", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementGetAllConfigsResponse" + }, + "example": { + "configurations": [ + { + "configId": "074791cc-ef32-4920-8373-95efbeea66c5", + "corridorId": "CO_US", + "name": "Flow Config Example", + "steps": { + "ON_RAMP": { + "accountId": "3b7a1451-3453-4c96-a6a5-683cc8971d04", + "inputAssetId": "COP", + "outputAssetId": "USD" + }, + "VAULT_ACCOUNT": { + "accountId": "2", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + }, + "OFF_RAMP": { + "accountId": "f2f74204-93ec-4614-870a-4ea2ad13aa0b", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + } + }, + "conversionSlippageBasisPoints": 75, + "createdAt": 1680625226267 + }, + { + "configId": "a4b0a706-4578-4467-bd5b-a852761dd2aa", + "corridorId": "MX_US", + "name": "MX to US flow", + "steps": { + "ON_RAMP": { + "accountId": "3d6241ad-879b-4a11-842f-4cee9cd7fbba", + "inputAssetId": "MXN", + "outputAssetId": "USD" + }, + "VAULT_ACCOUNT": { + "accountId": "1", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + }, + "OFF_RAMP": { + "accountId": "1cf7f750-117f-4c36-b4ef-14c420d118ce", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + } + }, + "conversionSlippageBasisPoints": 10, + "createdAt": 1665166171134 + } + ] + } + } + } + }, + "401": { + "description": "Unauthorized. Missing / invalid JWT token in Authorization header.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Internal error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/payments/xb-settlements/configs/{configId}": { + "get": { + "tags": [ + "Payments - cross-border settlement" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "summary": "Get a specific cross-border settlement configuration", + "description": "Get a specific cross-border settlement configuration.
\n**Note:** The reference content in this section documents the Payments Engine endpoint. The Payments Engine endpoint includes APIs available only for customers with the Payments Engine enabled on their accounts.\nThese endpoints are currently in beta and might be subject to changes.\nIf you want to learn more about the Fireblocks Payments Engine, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com.\n", + "parameters": [ + { + "in": "path", + "name": "configId", + "required": true, + "description": "The cross-border settlement configuration ID.", + "schema": { + "type": "string" + }, + "example": "074791cc-ef32-4920-8373-95efbeea66c5" + } + ], + "responses": { + "200": { + "description": "Returns the requested cross-border settlement configuration", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementGetConfigResponse" + }, + "example": { + "configId": "074791cc-ef32-4920-8373-95efbeea66c5", + "corridorId": "CO_US", + "name": "Flow Config Example", + "steps": { + "ON_RAMP": { + "accountId": "3b7a1451-3453-4c96-a6a5-683cc8971d04", + "inputAssetId": "COP", + "outputAssetId": "USD" + }, + "VAULT_ACCOUNT": { + "accountId": "2", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + }, + "OFF_RAMP": { + "accountId": "f2f74204-93ec-4614-870a-4ea2ad13aa0b", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + } + }, + "conversionSlippageBasisPoints": 75, + "createdAt": 1680625226267 + } + } + } + }, + "401": { + "description": "Unauthorized. Missing / invalid JWT token in Authorization header.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "No cross-border settlement configuration exists with the provided ID.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Internal error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "Payments - cross-border settlement" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "summary": "Edit a cross-border settlement configuration", + "description": "Edit a cross-border settlement configuration.\nEditing a configuration does not affect previously executed flows that used the configuration.\n**Note:** The reference content in this section documents the Payments Engine endpoint. The Payments Engine endpoint includes APIs available only for customers with the Payments Engine enabled on their accounts.\nThese endpoints are currently in beta and might be subject to changes.\nIf you want to learn more about the Fireblocks Payments Engine, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com.\n", + "parameters": [ + { + "in": "path", + "name": "configId", + "required": true, + "description": "The cross-border settlement configuration ID.", + "schema": { + "type": "string" + }, + "example": "074791cc-ef32-4920-8373-95efbeea66c5" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementConfigEditRequestBody" + }, + "example": { + "name": "Flow Config Example - Edited", + "steps": { + "ON_RAMP": { + "accountId": "e9dec04a-3c57-4052-a89a-288c545f6430" + }, + "VAULT_ACCOUNT": { + "accountId": "2" + }, + "OFF_RAMP": { + "accountId": "f2f74204-93ec-4614-870a-4ea2ad13aa0b" + } + }, + "corridorId": "CO_US", + "conversionSlippageBasisPoints": 30 + } + } + } + }, + "responses": { + "200": { + "description": "Cross-border settlement configuration edited successfully", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementConfigEditResponse" + }, + "example": { + "configId": "074791cc-ef32-4920-8373-95efbeea66c5", + "corridorId": "CO_US", + "name": "Flow Config Example - Edited", + "steps": { + "ON_RAMP": { + "accountId": "e9dec04a-3c57-4052-a89a-288c545f6430", + "inputAssetId": "COP", + "outputAssetId": "USD" + }, + "VAULT_ACCOUNT": { + "accountId": "2", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + }, + "OFF_RAMP": { + "accountId": "f2f74204-93ec-4614-870a-4ea2ad13aa0b", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + } + }, + "conversionSlippageBasisPoints": 30, + "createdAt": 1680625226267 + } + } + } + }, + "400": { + "description": "Error creating the cross-border request. Configuration not modified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized. Missing / invalid JWT token in Authorization header.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "No cross-border settlement configuration exists with the provided ID.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Internal error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Payments - cross-border settlement" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "configId", + "required": true, + "description": "The cross-border settlement configuration ID.", + "schema": { + "type": "string" + }, + "example": "074791cc-ef32-4920-8373-95efbeea66c5" + } + ], + "summary": "Delete a cross-border settlement configuration", + "description": "Delete a cross-border settlement configuration.\nThis does not delete or remove previously executed flows that used this configuration.\n**Note:** The reference content in this section documents the Payments Engine endpoint. The Payments Engine endpoint includes APIs available only for customers with the Payments Engine enabled on their accounts.\nThese endpoints are currently in beta and might be subject to changes.\nIf you want to learn more about the Fireblocks Payments Engine, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com.\n", + "responses": { + "200": { + "description": "Cross-border settlement configuration deleted successfully. Returns the deleted configuration.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementConfigDeletionResponse" + }, + "example": { + "configId": "074791cc-ef32-4920-8373-95efbeea66c5", + "corridorId": "CO_US", + "name": "Flow Config Example - Edited", + "steps": { + "ON_RAMP": { + "accountId": "e9dec04a-3c57-4052-a89a-288c545f6430", + "inputAssetId": "COP", + "outputAssetId": "USD" + }, + "VAULT_ACCOUNT": { + "accountId": "2", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + }, + "OFF_RAMP": { + "accountId": "f2f74204-93ec-4614-870a-4ea2ad13aa0b", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + } + }, + "conversionSlippageBasisPoints": 30, + "createdAt": 1680625226267 + } + } + } + }, + "401": { + "description": "Unauthorized. Missing / invalid JWT token in Authorization header.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "No cross-border settlement configuration exists with the provided ID.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Internal error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/payments/xb-settlements/flows": { + "post": { + "tags": [ + "Payments - cross-border settlement" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "summary": "Create a new cross-border settlement flow", + "description": "Create a cross-border flow (based on a cross-border configuration) with an amount to transfer. \nThe assetId is defined by the cross-border configuration.\nCreating a flow triggers a calculation of the flow estimations, including FX rates, times, and fees based on the amount provided.\nCreating a cross-border flow will not execute the flow.\n\n**Note:** The reference content in this section documents the Payments Engine endpoint. The Payments Engine endpoint includes APIs available only for customers with the Payments Engine enabled on their accounts.\nThese endpoints are currently in beta and might be subject to changes.\nIf you want to learn more about the Fireblocks Payments Engine, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com.\n", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementCreateFlowRequestBody" + }, + "example": { + "configId": "a4b0a706-4578-4467-bd5b-a852761dd2aa", + "amount": "100" + } + } + } + }, + "responses": { + "200": { + "description": "Cross-border settlement flow created successfully", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementCreateFlowResponse" + }, + "example": { + "flowId": "98fb5a8b-65ff-4f15-b89c-80910aedbfb3", + "configId": "a4b0a706-4578-4467-bd5b-a852761dd2aa", + "conversionRate": "0.05481268", + "inputAmount": { + "amount": "100", + "assetId": "MXN" + }, + "estimatedOutputAmount": { + "amount": "5.461268", + "assetId": "XLM_USDC_5F3T" + }, + "totalEstimatedFee": { + "amount": "0.063503", + "assetId": "XLM_USDC_5F3T" + }, + "steps": { + "ON_RAMP": { + "accountId": "3d6241ad-879b-4a11-842f-4cee9cd7fbba", + "inputAmount": { + "amount": "100", + "assetId": "MXN" + }, + "outputAmount": { + "amount": "5.48126865", + "assetId": "USD" + }, + "estimatedFeeAmount": { + "amount": "0.043503", + "assetId": "USD" + }, + "estimatedTime": 10, + "isSignRequired": false + }, + "VAULT_ACCOUNT": { + "accountId": "1", + "inputAmount": { + "amount": "5.48126865", + "assetId": "USD" + }, + "outputAmount": { + "amount": "5.471268", + "assetId": "XLM_USDC_5F3T" + }, + "estimatedFeeAmount": { + "amount": "0.01", + "assetId": "XLM_USDC_5F3T" + }, + "estimatedTime": 63, + "isSignRequired": true + }, + "OFF_RAMP": { + "accountId": "1cf7f750-117f-4c36-b4ef-14c420d118ce", + "inputAmount": { + "amount": "5.471268", + "assetId": "XLM_USDC_5F3T" + }, + "outputAmount": { + "amount": "5.461268", + "assetId": "XLM_USDC_5F3T" + }, + "estimatedFeeAmount": { + "amount": "0.01", + "assetId": "XLM_USDC_5F3T" + }, + "estimatedTime": 95, + "isSignRequired": true + } + }, + "totalEstimatedTime": 696 + } + } + } + }, + "400": { + "description": "Unable to create cross-border flow, invalid configuration ID.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized. Missing / invalid JWT token in Authorization header.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Internal error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/payments/xb-settlements/flows/{flowId}": { + "get": { + "tags": [ + "Payments - cross-border settlement" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "flowId", + "required": true, + "description": "The cross-border settlement flow ID.", + "schema": { + "type": "string" + }, + "example": "98fb5a8b-65ff-4f15-b89c-80910aedbfb3" + } + ], + "summary": "Get specific cross-border settlement flow details", + "description": "Gets details for a specific cross-border settlement flow\n**Note:** The reference content in this section documents the Payments Engine endpoint. The Payments Engine endpoint includes APIs available only for customers with the Payments Engine enabled on their accounts.\nThese endpoints are currently in beta and might be subject to changes.\nIf you want to learn more about the Fireblocks Payments Engine, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com.\n", + "responses": { + "200": { + "description": "Returns cross-border settlement flow details.\nFor unexecuted flows, a preview object will return, showing the estimated time, amounts, and fees.\nNote that this data structure updates as the flow progresses, including the total fees (accumulated), state, and steps.\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementGetFlowResponse" + }, + "examples": { + "not executed": { + "value": { + "preview": { + "flowId": "98fb5a8b-65ff-4f15-b89c-80910aedbfb3", + "configId": "a4b0a706-4578-4467-bd5b-a852761dd2aa", + "conversionRate": "0.055369", + "inputAmount": { + "amount": "32", + "assetId": "MXN" + }, + "estimatedOutputAmount": { + "amount": "1.741824", + "assetId": "XLM_USDC_5F3T" + }, + "totalEstimatedFee": { + "amount": "0.044063", + "assetId": "XLM_USDC_5F3T" + }, + "totalEstimatedTime": 831, + "steps": { + "ON_RAMP": { + "accountId": "3d6241ad-879b-4a11-842f-4cee9cd7fbba", + "inputAmount": { + "amount": "32", + "assetId": "MXN" + }, + "outputAmount": { + "amount": "1.77182407", + "assetId": "USD" + }, + "estimatedFeeAmount": { + "amount": "0.014063", + "assetId": "USD" + }, + "estimatedTime": 10, + "isSignRequired": false + }, + "VAULT_ACCOUNT": { + "accountId": "1", + "inputAmount": { + "amount": "1.77182407", + "assetId": "XLM_USDC_5F3T" + }, + "outputAmount": { + "amount": "1.761824", + "assetId": "XLM_USDC_5F3T" + }, + "estimatedFeeAmount": { + "amount": "0.01", + "assetId": "XLM_USDC_5F3T" + }, + "estimatedTime": 111, + "isSignRequired": true + }, + "OFF_RAMP": { + "accountId": "1cf7f750-117f-4c36-b4ef-14c420d118ce", + "inputAmount": { + "amount": "1.761824", + "assetId": "XLM_USDC_5F3T" + }, + "outputAmount": { + "amount": "1.751824", + "assetId": "XLM_USDC_5F3T" + }, + "estimatedFeeAmount": { + "amount": "0.01", + "assetId": "XLM_USDC_5F3T" + }, + "estimatedTime": 293, + "isSignRequired": true + } + } + } + } + }, + "in progress": { + "value": { + "execution": { + "flowId": "98fb5a8b-65ff-4f15-b89c-80910aedbfb3", + "configId": "a4b0a706-4578-4467-bd5b-a852761dd2aa", + "inputAmount": { + "amount": "32", + "assetId": "MXN" + }, + "outputAmount": { + "amount": "1.471824", + "assetId": "XLM_USDC_5F3T" + }, + "totalFee": { + "amount": "0.004415", + "assetId": "XLM_USDC_5F3T" + }, + "initiatedAt": 1684919822759, + "initiatedBy": "a92e87a0-5231-531e-a624-fb29c1283764", + "state": "PROCESSING", + "selectedConversionSlippage": { + "basisPoints": 10, + "reason": "FLOW" + }, + "steps": { + "ON_RAMP": { + "id": "c1863abf-e7fa-4f3a-908a-bcd6381f7eb4", + "accountId": "3d6241ad-879b-4a11-842f-4cee9cd7fbba", + "status": "COMPLETED", + "inputAmount": { + "amount": "32", + "assetId": "MXN" + }, + "outputAmount": { + "amount": "1.77182407", + "assetId": "USD" + }, + "fee": { + "amount": "0.014063", + "assetId": "USD" + }, + "startedAt": 1684919823052, + "completedAt": 1684919830456, + "isSignRequired": false + }, + "VAULT_ACCOUNT": { + "id": "2aa2634d-2bab-44ac-9b4e-36e2e4db5d49", + "accountId": "1", + "status": "COMPLETED", + "inputAmount": { + "amount": "1.77182407", + "assetId": "XLM_USDC_5F3T" + }, + "outputAmount": { + "amount": "1.761824", + "assetId": "XLM_USDC_5F3T" + }, + "fee": { + "amount": "0.01", + "assetId": "XLM" + }, + "startedAt": 1684919831385, + "completedAt": 1684920680227, + "isSignRequired": true + }, + "OFF_RAMP": { + "id": "b221ed63-a05c-4e78-b2f2-205dcffeabda", + "accountId": "1cf7f750-117f-4c36-b4ef-14c420d118ce", + "status": "PROCESSING", + "inputAmount": { + "amount": "1.761824", + "assetId": "XLM_USDC_5F3T" + }, + "startedAt": 1684920681088, + "isSignRequired": true + } + } + } + } + }, + "completed": { + "value": { + "execution": { + "flowId": "98fb5a8b-65ff-4f15-b89c-80910aedbfb3", + "configId": "a4b0a706-4578-4467-bd5b-a852761dd2aa", + "inputAmount": { + "amount": "32", + "assetId": "MXN" + }, + "outputAmount": { + "amount": "1.471824", + "assetId": "XLM_USDC_5F3T" + }, + "totalFee": { + "amount": "0.004415", + "assetId": "XLM_USDC_5F3T" + }, + "initiatedAt": 1684919822759, + "initiatedBy": "a92e87a0-5231-531e-a624-fb29c1283764", + "state": "COMPLETED", + "selectedConversionSlippage": { + "basisPoints": 10, + "reason": "FLOW" + }, + "steps": { + "ON_RAMP": { + "id": "b1bec144-c4dd-4ff8-80ed-4204c83dd422", + "accountId": "3d6241ad-879b-4a11-842f-4cee9cd7fbba", + "status": "COMPLETED", + "inputAmount": { + "amount": "32", + "assetId": "MXN" + }, + "outputAmount": { + "amount": "1.77182407", + "assetId": "USD" + }, + "fee": { + "amount": "0.014063", + "assetId": "USD" + }, + "startedAt": 1684919823052, + "completedAt": 1684919830456, + "isSignRequired": false + }, + "VAULT_ACCOUNT": { + "id": "df7e0103-04cf-4508-9654-aa5e4b90dd50", + "accountId": "1", + "status": "COMPLETED", + "inputAmount": { + "amount": "1.77182407", + "assetId": "XLM_USDC_5F3T" + }, + "outputAmount": { + "amount": "1.761824", + "assetId": "XLM_USDC_5F3T" + }, + "fee": { + "amount": "0.01", + "assetId": "XLM" + }, + "startedAt": 1684919831385, + "completedAt": 1684920680227, + "isSignRequired": true + }, + "OFF_RAMP": { + "id": "34c2d597-271a-4c11-937a-3c246f5d39c2", + "accountId": "1cf7f750-117f-4c36-b4ef-14c420d118ce", + "status": "COMPLETED", + "inputAmount": { + "amount": "1.761824", + "assetId": "XLM_USDC_5F3T" + }, + "outputAmount": { + "amount": "1.761823", + "assetId": "XLM_USDC_5F3T" + }, + "fee": { + "amount": "0.00001", + "assetId": "XLM" + }, + "startedAt": 1684920681088, + "completedAt": 1684921261453, + "isSignRequired": true + } + } + } + } + } + } + } + } + }, + "401": { + "description": "Unauthorized. Missing / invalid JWT token in Authorization header.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Invalid flowId.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Internal error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/payments/xb-settlements/flows/{flowId}/actions/execute": { + "post": { + "tags": [ + "Payments - cross-border settlement" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "flowId", + "required": true, + "description": "The cross-border settlement flow ID.", + "schema": { + "type": "string" + }, + "example": "98fb5a8b-65ff-4f15-b89c-80910aedbfb3" + } + ], + "summary": "Execute cross-border settlement flow", + "description": "Send a payment flow with 'flowId' for execution.\nIf a differet slippage configuraion is needed for this execution than configured in the flow configuration, the request body must define the desired slippage configuration for this execution.\n\n**Note:** The reference content in this section documents the Payments Engine endpoint. The Payments Engine endpoint includes APIs available only for customers with the Payments Engine enabled on their accounts.\nThese endpoints are currently in beta and might be subject to changes.\nIf you want to learn more about the Fireblocks Payments Engine, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com.\n", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementFlowExecutionRequestBody" + }, + "example": { + "conversionSlippageBasisPoints": 10 + } + } + } + }, + "responses": { + "200": { + "description": "Cross-border settlement flow started to execute successfully", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementFlowExecutionResponse" + }, + "example": { + "flowId": "98fb5a8b-65ff-4f15-b89c-80910aedbfb3", + "configId": "a4b0a706-4578-4467-bd5b-a852761dd2aa", + "inputAmount": { + "amount": "32", + "assetId": "MXN" + }, + "outputAmount": { + "amount": "1.471824", + "assetId": "XLM_USDC_5F3T" + }, + "totalFee": { + "amount": "0.004415", + "assetId": "XLM_USDC_5F3T" + }, + "initiatedAt": 1684919822759, + "initiatedBy": "a92e87a0-5231-531e-a624-fb29c1283764", + "state": "PROCESSING", + "selectedConversionSlippage": { + "basisPoints": 10, + "reason": "FLOW" + }, + "steps": { + "ON_RAMP": { + "id": "c1863abf-e7fa-4f3a-908a-bcd6381f7eb4", + "accountId": "3d6241ad-879b-4a11-842f-4cee9cd7fbba", + "status": "COMPLETED", + "inputAmount": { + "amount": "32", + "assetId": "MXN" + }, + "outputAmount": { + "amount": "1.77182407", + "assetId": "USD" + }, + "fee": { + "amount": "0.014063", + "assetId": "USD" + }, + "startedAt": 1684919823052, + "completedAt": 1684919830456, + "isSignRequired": false + }, + "VAULT_ACCOUNT": { + "id": "2aa2634d-2bab-44ac-9b4e-36e2e4db5d49", + "accountId": "1", + "status": "PROCESSING", + "inputAmount": { + "amount": "1.77182407", + "assetId": "XLM_USDC_5F3T" + }, + "outputAmount": { + "amount": "1.761824", + "assetId": "XLM_USDC_5F3T" + }, + "fee": { + "amount": "0.01", + "assetId": "XLM" + }, + "startedAt": 1684919831385, + "isSignRequired": true + }, + "OFF_RAMP": { + "id": "b221ed63-a05c-4e78-b2f2-205dcffeabda", + "accountId": "1cf7f750-117f-4c36-b4ef-14c420d118ce", + "status": "NOT_STARTED", + "inputAmount": { + "amount": "1.761824", + "assetId": "XLM_USDC_5F3T" + }, + "isSignRequired": true + } + } + } + } + } + }, + "400": { + "description": "Error while trying to execute the cross-border flow", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized. Missing / invalid JWT token in Authorization header.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "Invalid flowId.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Internal error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/payments/payout": { + "post": { + "tags": [ + "Payments - Payout" + ], + "description": "**Note:** The reference content in this section documents the Payments Engine endpoint. The Payments Engine endpoints include APIs available only for customers with Payments Engine enabled on their accounts.
\n
These endpoints are currently in beta and might be subject to changes.
\n
If you want to learn more about Fireblocks Payments Engine, please contact your Fireblocks Customer Success Manager or email CSM@fireblocks.com.
\n
Create a payout instruction set.
\nA payout instruction set is a set of instructions for distributing payments from a single payment account to a list of payee accounts.
\nThe instruction set defines:
\n
    \n
  • the payment account and its account type (vault, exchange, or fiat).
    • \n
  • the account type (vault account, exchange account, whitelisted address, network connection, fiat account, or merchant account), the amount, and the asset of payment for each payee account.
    • \n
\n", + "security": [ + { + "bearerAuth": [] + } + ], + "summary": "Create a payout instruction set", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreatePayoutRequest" + }, + "example": { + "paymentAccount": { + "id": "EX_SUB3", + "type": "EXCHANGE_ACCOUNT" + }, + "instructionSet": [ + { + "payeeAccount": { + "id": "bef85a1c-b605-4b2e-bdb5-2d400f4d0bf3", + "type": "EXTERNAL_WALLET" + }, + "amount": { + "amount": "43", + "assetId": "USDC" + } + }, + { + "payeeAccount": { + "id": "3adc1f92-e791-44a8-9aee-7f31c2108b78", + "type": "NETWORK_CONNECTION" + }, + "amount": { + "amount": "4423", + "assetId": "USDC" + } + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "The payout instruction set creation succeeded and returns the generated instruction set with a unique payout IDThe payout ID will be used for executing the payout and checking the payout status.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PayoutResponse" + }, + "example": { + "payoutId": "1fe3b61f-7e1f-4a19-aff0-4f0a524d44d7", + "paymentAccount": { + "id": "EX_SUB3", + "type": "EXCHANGE_ACCOUNT" + }, + "createdAt": 1645365800, + "state": "REQUESTED", + "status": "REGISTERED", + "initMethod": "API", + "instructionSet": [ + { + "id": "6ea4a016-536b-49af-b1a0-40b343ccf879", + "name": "payee-wallet-name", + "payeeAccount": { + "id": "bef85a1c-b605-4b2e-bdb5-2d400f4d0bf3", + "type": "EXTERNAL_WALLET" + }, + "amount": { + "amount": "43", + "assetId": "USDC" + }, + "state": "NOT_STARTED", + "transactions": [] + }, + { + "id": "e783a79b-6acc-4d18-885d-ed533cad8eeb", + "name": "payee-by-network", + "payeeAccount": { + "id": "3adc1f92-e791-44a8-9aee-7f31c2108b78", + "type": "NETWORK_CONNECTION" + }, + "amount": { + "amount": "4423.23", + "assetId": "USDC" + }, + "state": "NOT_STARTED", + "transactions": [] + } + ] + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized. Missing / invalid JWT token in Authorization header.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Internal error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/payments/payout/{payoutId}/actions/execute": { + "post": { + "tags": [ + "Payments - Payout" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "summary": "Execute a payout instruction set", + "description": "**Note:** The reference content in this section documents the Payments Engine endpoint. The Payments Engine endpoints include APIs available only for customers with Payments Engine enabled on their accounts.
\n
These endpoints are currently in beta and might be subject to changes.
\n
If you want to learn more about Fireblocks Payments Engine, please contact your Fireblocks Customer Success Manager or email CSM@fireblocks.com.
\n
Execute a payout instruction set.
\n
The instruction set will be verified and executed.
\nSource locking
 \nIf you are executing a payout instruction set from a payment account with an already active payout the active payout will complete before the new payout instruction set can be executed.
\nYou cannot execute the same payout instruction set more than once.\n", + "parameters": [ + { + "name": "payoutId", + "description": "the payout id received from the creation of the payout instruction set", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "example": "1fe3b61f-7e1f-4a19-aff0-4f0a524d44d7" + } + ], + "responses": { + "200": { + "description": "Executed the payout instruction set", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DispatchPayoutResponse" + }, + "example": { + "payoutId": "1fe3b61f-7e1f-4a19-aff0-4f0a524d44d7" + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized. Missing / invalid JWT token in Authorization header.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Internal error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/payments/payout/{payoutId}": { + "get": { + "tags": [ + "Payments - Payout" + ], + "summary": "Get the status of a payout instruction set", + "description": "**Note:** The reference content in this section documents the Payments Engine endpoint. The Payments Engine endpoints include APIs available only for customers with Payments Engine enabled on their accounts.
\n
These endpoints are currently in beta and might be subject to changes.
\n
If you want to learn more about Fireblocks Payments Engine, please contact your Fireblocks Customer Success Manager or email CSM@fireblocks.com.
\n", + "security": [ + { + "bearerAuth": [] + } + ], + "parameters": [ + { + "name": "payoutId", + "description": "the payout id received from the creation of the payout instruction set", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "example": "1fe3b61f-7e1f-4a19-aff0-4f0a524d44d7" + } + ], + "responses": { + "200": { + "description": "Returns the current status of the payout instruction set, including the status of each payout instruction and the transactions created in the process.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PayoutResponse" + }, + "example": { + "payoutId": "1fe3b61f-7e1f-4a19-aff0-4f0a524d44d7", + "paymentAccount": { + "id": "EX_SUB3", + "type": "EXCHANGE_ACCOUNT" + }, + "createdAt": 1645365800, + "state": "FINALIZED", + "status": "DONE", + "initMethod": "API", + "instructionSet": [ + { + "id": "6ea4a016-536b-49af-b1a0-40b343ccf879", + "name": "payee-wallet-name", + "payeeAccount": { + "id": "bef85a1c-b605-4b2e-bdb5-2d400f4d0bf3", + "type": "EXTERNAL_WALLET" + }, + "amount": { + "amount": "4312", + "assetId": "USDC" + }, + "state": "COMPLETED", + "transactions": [ + { + "id": "35a4b10c-1f83-4f0b-ba2a-da0e73be2d6e", + "state": "COMPLETED", + "timestamp": 1645367429 + } + ] + }, + { + "id": "e783a79b-6acc-4d18-885d-ed533cad8eeb", + "name": "payee-by-network", + "payeeAccount": { + "id": "3adc1f92-e791-44a8-9aee-7f31c2108b78", + "type": "NETWORK_CONNECTION" + }, + "amount": { + "amount": "4423.23", + "assetId": "USDC" + }, + "state": "COMPLETED", + "transactions": [ + { + "id": "4505e7d9-bfc7-41bc-9750-54311fcbbf26", + "state": "COMPLETED", + "timestamp": 1645367449 + } + ] + } + ], + "reportUrl": "https://some-url.com/reports/cc5777c1-75a9-4337-aebd-f1f5a40a9391" + } + } + } + }, + "401": { + "description": "Unauthorized. Missing / invalid JWT token in Authorization header.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "No payout with the given payout ID exists.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "Internal error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/gas_station": { + "get": { + "summary": "Get gas station settings", + "description": "Returns gas station settings and ETH balance.", + "tags": [ + "Gas stations" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "gas_station_info = fireblocks.get_gas_station_info()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const gasStationInfo = await fireblocks.gasStationInfo();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "Gas Station properties", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/GasStationPropertiesResponse" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/gas_station/{assetId}": { + "get": { + "summary": "Get gas station settings by asset", + "description": "Returns gas station settings and balances for a requested asset.", + "tags": [ + "Gas stations" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "gas_station_info = fireblocks.get_gas_station_info(asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const gasStationInfo = await fireblocks.gasStationInfo(assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "assetId", + "description": "The ID of the asset", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "Gas Station properties", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/GasStationPropertiesResponse" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/gas_station/configuration": { + "put": { + "summary": "Edit gas station settings", + "description": "Configures gas station settings for ETH.", + "tags": [ + "Gas stations" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "gas_station = fireblocks.set_gas_station_configuration(gas_threshold, gas_cap, max_gas_price, asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const gasStation = await fireblocks.setGasStationConfiguration(gasThreshold, gasCap, maxGasPrice)", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GasStationConfiguration" + } + } + } + }, + "responses": { + "201": { + "description": "OK", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/gas_station/configuration/{assetId}": { + "put": { + "summary": "Edit gas station settings for an asset", + "description": "Configures gas station settings for a requested asset.", + "tags": [ + "Gas stations" + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "assetId", + "description": "The ID of the asset", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GasStationConfiguration" + } + } + } + }, + "responses": { + "201": { + "description": "OK", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/users": { + "get": { + "summary": "List users", + "description": "List all users for the workspace.\n\nPlease note that this endpoint is available only for API keys with Admin permissions.\n", + "tags": [ + "Users" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "users = fireblocks.get_users()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const users = await fireblocks.getUsers();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "List of users", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/GetUsersResponse" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/audits": { + "get": { + "summary": "Get audit logs", + "tags": [ + "Audit Logs" + ], + "parameters": [ + { + "in": "query", + "name": "timePeriod", + "required": true, + "description": "The last time period to fetch audit logs", + "schema": { + "type": "string", + "enum": [ + "DAY", + "WEEK" + ] + } + } + ], + "responses": { + "200": { + "description": "Audit logs from requested time period", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/off_exchange/add": { + "post": { + "summary": "add collateral", + "description": "add collateral, create deposit request", + "tags": [ + "Off exchanges" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AddCollateralRequestBody" + } + } + } + }, + "responses": { + "200": { + "description": "A transaction object", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateTransactionResponse" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/off_exchange/remove": { + "post": { + "summary": "remove collateral", + "description": "remove collateral, create withdraw request", + "tags": [ + "Off exchanges" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RemoveCollateralRequestBody" + } + } + } + }, + "responses": { + "200": { + "description": "A transaction object", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateTransactionResponse" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/off_exchange/settlements/trader": { + "post": { + "summary": "create settlement for a trader", + "description": "create settlement for a trader", + "tags": [ + "Off exchanges" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SettlementRequestBody" + } + } + } + }, + "responses": { + "201": { + "description": "A settlement object", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SettlementResponse" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/off_exchange/settlements/transactions": { + "get": { + "summary": "get settlements transactions from exchange", + "description": "get settlements transactions from exchange", + "tags": [ + "Off exchanges" + ], + "parameters": [ + { + "in": "query", + "name": "mainExchangeAccountId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "A settlement transactions", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/GetSettlementResponse" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/off_exchange/collateral_accounts/{mainExchangeAccountId}": { + "get": { + "summary": "Find a specific collateral exchange account", + "description": "Returns a collateral account by mainExchangeAccountId.", + "tags": [ + "Off exchanges" + ], + "parameters": [ + { + "in": "path", + "name": "mainExchangeAccountId", + "required": true, + "description": "The id of the main exchange account for which the requested collateral account is associated with", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "An ExchangeAccount object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ExchangeAccount" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/webhooks/resend": { + "post": { + "summary": "Resend failed webhooks", + "description": "Resends all failed webhook notifications.", + "tags": [ + "Webhooks" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = fireblocks.resend_webhooks()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.resendWebhooks();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "OK", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ResendWebhooksResponse" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/webhooks/resend/{txId}": { + "post": { + "summary": "Resend failed webhooks for a transaction by ID", + "description": "Resends failed webhook notifications for a transaction by ID.", + "tags": [ + "Webhooks" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = fireblocks.resend_transaction_webhooks_by_id(txId, resend_created, resend_status_updated)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.resendTransactionWebhooksById(txId, resendCreated, resendStatusUpdated);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "txId", + "required": true, + "description": "The ID of the transaction for webhooks", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "resendCreated": { + "type": "boolean" + }, + "resendStatusUpdated": { + "type": "boolean" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/nfts/ownership/tokens": { + "put": { + "operationId": "refreshNFTOwnershipByVault", + "summary": "Refresh vault account tokens", + "description": "Updates all tokens and balances per blockchain and vault account.\n\n**Note**: This endpoint is now in Beta, disabled for general availability at this time.\n\nTo enroll in beta & enable this endpoint, contact your Fireblocks Customer Success Manager or reach out to [CSM@fireblocks.com](mailto:CSM@fireblocks.com).\n", + "parameters": [ + { + "name": "blockchainDescriptor", + "required": true, + "in": "query", + "description": "Blockchain descriptor filter", + "schema": { + "enum": [ + "ETH", + "ETH_TEST3", + "POLYGON", + "POLYGON_TEST_MUMBAI" + ], + "type": "string" + } + }, + { + "name": "vaultAccountId", + "required": true, + "in": "query", + "description": "Vault account filter", + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + } + }, + "tags": [ + "NFTs (Beta)" + ] + }, + "get": { + "operationId": "getOwnedNFTs", + "summary": "List all owned tokens (paginated)", + "description": "Returns all tokens and their data in your workspace.\n\n**Note**: This endpoint is now in Beta, disabled for general availability at this time.\n\nTo enroll in beta & enable this endpoint, contact your Fireblocks Customer Success Manager or reach out to [CSM@fireblocks.com](mailto:CSM@fireblocks.com).\n", + "parameters": [ + { + "name": "blockchainDescriptor", + "required": false, + "in": "query", + "description": "Blockchain descriptor filter", + "schema": { + "enum": [ + "ETH", + "ETH_TEST3", + "POLYGON", + "POLYGON_TEST_MUMBAI" + ], + "type": "string" + } + }, + { + "name": "vaultAccountIds", + "required": false, + "in": "query", + "description": "A comma separated list of Vault Account IDs. Up to 100 are allowed in a single request", + "schema": { + "type": "string" + } + }, + { + "name": "ids", + "required": false, + "in": "query", + "description": "A comma separated list of NFT IDs. Up to 100 are allowed in a single request.", + "schema": { + "type": "string" + } + }, + { + "name": "collectionIds", + "required": false, + "in": "query", + "description": "A comma separated list of collection IDs. Up to 100 are allowed in a single request.", + "schema": { + "type": "string" + } + }, + { + "name": "pageCursor", + "required": false, + "in": "query", + "description": "Page cursor to fetch", + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "required": false, + "in": "query", + "description": "Items per page (max 100)", + "schema": { + "minimum": 1, + "maximum": 100, + "type": "number" + } + }, + { + "name": "sort", + "required": false, + "in": "query", + "description": "Sort by param, it can be one param or a list of params separated by comma", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "ownershipLastUpdateTime", + "name", + "collection.name", + "blockchainDescriptor" + ] + } + } + }, + { + "name": "order", + "required": false, + "in": "query", + "description": "Order direction, it can be `ASC` for ascending or `DESC` for descending", + "schema": { + "default": "ASC", + "enum": [ + "DESC", + "ASC" + ], + "type": "string" + } + }, + { + "name": "status", + "required": false, + "in": "query", + "description": "Token ownership status", + "schema": { + "default": "LISTED", + "enum": [ + "LISTED", + "ARCHIVED" + ], + "type": "string" + } + }, + { + "name": "search", + "required": false, + "in": "query", + "description": "Search owned tokens and their collections. Possible criteria for search: token name and id within the contract/collection, collection name, blockchain descriptor and name.", + "schema": { + "maximum": 100, + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "application/json": { + "schema": { + "properties": { + "paging": { + "$ref": "#/components/schemas/Paging" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TokenOwnershipResponse" + } + } + } + } + } + } + } + }, + "tags": [ + "NFTs (Beta)" + ] + } + }, + "/nfts/ownership/collections": { + "get": { + "operationId": "listOwnedCollections", + "summary": "List owned collections (paginated)", + "description": "Returns all collections in your workspace\n\n**Note**: This endpoint is now in Beta, disabled for general availability at this time.\n\nTo enroll in beta & enable this endpoint, contact your Fireblocks Customer Success Manager or reach out to [CSM@fireblocks.com](mailto:CSM@fireblocks.com).\n", + "parameters": [ + { + "name": "search", + "required": false, + "in": "query", + "description": "Search owned collections. Possible criteria for search: collection name, collection contract address.", + "schema": { + "maximum": 100, + "type": "string" + } + }, + { + "name": "pageCursor", + "required": false, + "in": "query", + "description": "Page cursor to fetch", + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "required": false, + "in": "query", + "description": "Items per page (max 100)", + "schema": { + "minimum": 1, + "maximum": 100, + "type": "number" + } + }, + { + "name": "sort", + "required": false, + "in": "query", + "description": "Sort by param, it can be one param or a list of params separated by comma", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "name" + ] + } + } + }, + { + "name": "order", + "required": false, + "in": "query", + "description": "Order direction, it can be `ASC` for ascending or `DESC` for descending", + "schema": { + "default": "ASC", + "enum": [ + "DESC", + "ASC" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "application/json": { + "schema": { + "properties": { + "paging": { + "$ref": "#/components/schemas/Paging" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CollectionOwnershipResponse" + } + } + } + } + } + } + } + }, + "tags": [ + "NFTs (Beta)" + ] + } + }, + "/nfts/tokens/{id}": { + "put": { + "operationId": "refreshNFTMetadata", + "summary": "Refresh token metadata", + "description": "Updates the latest token metadata.\n\n**Note**: This endpoint is now in Beta, disabled for general availability at this time.\n\nTo enroll in beta & enable this endpoint, contact your Fireblocks Customer Success Manager or reach out to [CSM@fireblocks.com](mailto:CSM@fireblocks.com).\n", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "description": "NFT ID", + "example": "NFT-abcdefabcdefabcdefabcdefabcdefabcdefabcd", + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + } + }, + "tags": [ + "NFTs (Beta)" + ] + }, + "get": { + "operationId": "getNFT", + "summary": "List token data by ID", + "description": "Returns the requested token data.\n\n**Note**: This endpoint is now in Beta, disabled for general availability at this time.\n\nTo enroll in beta & enable this endpoint, contact your Fireblocks Customer Success Manager or reach out to [CSM@fireblocks.com](mailto:CSM@fireblocks.com).\n", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "description": "NFT ID", + "example": "NFT-abcdefabcdefabcdefabcdefabcdefabcdefabcd", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TokenResponse" + } + } + } + } + }, + "tags": [ + "NFTs (Beta)" + ] + } + }, + "/nfts/tokens": { + "get": { + "operationId": "getNFTs", + "summary": "List tokens by IDs", + "description": "Returns the requested tokens data\n\n**Note**: This endpoint is now in Beta, disabled for general availability at this time.\n\nTo enroll in beta & enable this endpoint, contact your Fireblocks Customer Success Manager or reach out to [CSM@fireblocks.com](mailto:CSM@fireblocks.com).\n", + "parameters": [ + { + "name": "ids", + "required": true, + "in": "query", + "description": "A comma separated list of NFT IDs. Up to 100 are allowed in a single request.", + "schema": { + "type": "string" + } + }, + { + "name": "pageCursor", + "required": false, + "in": "query", + "description": "Page cursor to fetch", + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "required": false, + "in": "query", + "description": "Items per page (max 100)", + "schema": { + "minimum": 1, + "maximum": 100, + "type": "number" + } + }, + { + "name": "sort", + "required": false, + "in": "query", + "description": "Sort by param, it can be one param or a list of params separated by comma", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "collection.name", + "name", + "blockchainDescriptor" + ] + } + } + }, + { + "name": "order", + "required": false, + "in": "query", + "description": "Order direction, it can be `ASC` for ascending or `DESC` for descending", + "schema": { + "default": "ASC", + "enum": [ + "DESC", + "ASC" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "application/json": { + "schema": { + "properties": { + "paging": { + "$ref": "#/components/schemas/Paging" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TokenResponse" + } + } + } + } + } + } + } + }, + "tags": [ + "NFTs (Beta)" + ] + } + }, + "/nfts/ownership/tokens/{id}/status": { + "put": { + "operationId": "updateTokenOwnershipStatus", + "summary": "Update token ownership status", + "description": "Updates token ownership status for a tenant, in all tenant vaults.\n\n**Note**: This endpoint is now in Beta, disabled for general availability at this time.\n\nTo enroll in beta & enable this endpoint, contact your Fireblocks Customer Success Manager or reach out to [CSM@fireblocks.com](mailto:CSM@fireblocks.com).\n", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "description": "NFT ID", + "example": "NFT-abcdefabcdefabcdefabcdefabcdefabcdefabcd", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateTokenOwnershipStatusDto" + } + } + } + }, + "responses": { + "200": { + "description": "", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + } + }, + "tags": [ + "NFTs (Beta)" + ] + } + }, + "/connections": { + "get": { + "operationId": "get", + "summary": "List all open Web3 connections.", + "description": "Get open Web3 connections.", + "parameters": [ + { + "name": "order", + "required": false, + "in": "query", + "description": "List order; ascending or descending.", + "schema": { + "type": "string", + "enum": [ + "ASC", + "DESC" + ], + "default": "ASC" + } + }, + { + "name": "filter", + "required": false, + "in": "query", + "description": "Parsed filter object", + "examples": { + "object": { + "summary": "The filter object", + "description": "", + "value": { + "id": "string", + "userId": "string", + "vaultAccountId": "number", + "connectionMethod": "string", + "feeLevel": "string", + "appUrl": "string", + "appName": "string" + } + }, + "stringified": { + "summary": "The stringified parsed object", + "description": "About stringified parsed objects:\n\n* Each key-value pair is separated by '=', and each pair is separated by ',' (you can use [`qs`](https://www.npmjs.com/package/qs) package for this)", + "value": "id=string,userId=string,vaultAccountId=number,connectionMethod=string,feeLevel=string,appUrl=string,appName=string" + } + }, + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "userId": { + "type": "string" + }, + "vaultAccountId": { + "type": "number" + }, + "connectionMethod": { + "type": "string" + }, + "feeLevel": { + "type": "string" + }, + "appUrl": { + "type": "string" + }, + "appName": { + "type": "string" + } + } + } + }, + { + "name": "sort", + "required": false, + "in": "query", + "description": "Property to sort Web3 connections by.", + "schema": { + "type": "string", + "enum": [ + "id", + "userId", + "vaultAccountId", + "createdAt", + "feeLevel", + "appUrl", + "appName" + ], + "default": "createdAt" + } + }, + { + "name": "pageSize", + "required": false, + "in": "query", + "description": "Amount of results to return in the next page.", + "schema": { + "type": "number", + "default": 10, + "maximum": 50 + } + }, + { + "name": "next", + "required": false, + "in": "query", + "description": "Cursor to the next page", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetConnectionsResponse" + } + } + } + }, + "400": { + "description": "Query parameters were invalid", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + }, + "500": { + "description": "Something went wrong", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + } + }, + "tags": [ + "Web3 connections" + ] + } + }, + "/connections/wc": { + "post": { + "operationId": "create", + "summary": "Create a new Web3 connection.", + "description": "Initiate a new Web3 connection.\n\n* Note: After this succeeds, make a request to `PUT /v1/connections/wc/{id}` (below) to approve or reject the new Web3 connection.", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateConnectionRequest" + } + } + } + }, + "responses": { + "201": { + "description": "Web3 connection initiated successfully", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateConnectionResponse" + } + } + } + }, + "400": { + "description": "Invalid data sent", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + }, + "500": { + "description": "Something went wrong", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + } + }, + "tags": [ + "Web3 connections" + ] + } + }, + "/connections/wc/{id}": { + "put": { + "operationId": "submit", + "summary": "Respond to a pending Web3 connection request.", + "description": "Submit a response to *approve* or *reject* an initiated Web3 connection.\n* Note: This call is used to complete your `POST /v1/connections/wc/` request.\n\nAfter this succeeds, your new Web3 connection is created and functioning.", + "parameters": [ + { + "name": "id", + "description": "The ID of the initiated Web3 connection to approve.", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RespondToConnectionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Connection submitted successfully", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + }, + "400": { + "description": "Invalid data sent", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + }, + "404": { + "description": "Connection not found", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + }, + "500": { + "description": "Something went wrong", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + } + }, + "tags": [ + "Web3 connections" + ] + }, + "delete": { + "operationId": "remove", + "summary": "Remove an existing Web3 connection.", + "description": "Remove a Web3 connection", + "parameters": [ + { + "name": "id", + "description": "The ID of the existing Web3 connection to remove.", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Connection removed successfully", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + }, + "404": { + "description": "Connection not found", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + }, + "500": { + "description": "Something went wrong", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + } + } + }, + "tags": [ + "Web3 connections" + ] + } + }, + "/screening/travel_rule/transaction/validate": { + "post": { + "operationId": "TravelRuleApiController_validate", + "summary": "Validate Travel Rule Transaction", + "description": "Validate Travel Rule transactions.\n\nChecks what beneficiary VASP details are required by your jurisdiction and the beneficiary's jurisdiction.\n\n**Note:** The reference content in this section documents the Travel Rule beta endpoint. The beta endpoint includes APIs that are currently in preview and aren't yet generally available.\n\nTo enroll in the beta and enable this endpoint, contact your Fireblocks Customer Success Manager or send an email to [CSM@fireblocks.com](mailto:CSM@fireblocks.com).", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TravelRuleValidateTransactionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Transaction validated successfully", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TravelRuleValidateTransactionResponse" + } + } + } + }, + "400": { + "description": "Invalid request body" + }, + "500": { + "description": "Internal server error" + } + }, + "tags": [ + "Travel Rule (Beta)" + ] + } + }, + "/screening/travel_rule/transaction/validate/full": { + "post": { + "operationId": "TravelRuleApiController_validateFull", + "summary": "Validate Full Travel Rule Transaction", + "description": "Validate Full Travel Rule transactions.\n\nChecks for all required information on the originator and beneficiary VASPs.\n\n**Note:** The reference content in this section documents the Travel Rule beta endpoint. The beta endpoint includes APIs that are currently in preview and aren't yet generally available.\n\nTo enroll in the beta and enable this endpoint, contact your Fireblocks Customer Success Manager or send an email to [CSM@fireblocks.com](mailto:CSM@fireblocks.com).", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TravelRuleValidateFullTransactionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Transaction validated successfully", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TravelRuleValidateTransactionResponse" + } + } + } + }, + "400": { + "description": "Invalid request body" + }, + "500": { + "description": "Internal server error" + } + }, + "tags": [ + "Travel Rule (Beta)" + ] + } + }, + "/screening/travel_rule/vasp/{did}": { + "get": { + "operationId": "TravelRuleApiController_findVasp", + "summary": "Get VASP details", + "description": "Get VASP Details.\n\nReturns information about a VASP that has the specified DID.\n\n**Note:** The reference content in this section documents the Travel Rule beta endpoint. The beta endpoint includes APIs that are currently in preview and aren't yet generally available.\n\nTo enroll in the beta and enable this endpoint, contact your Fireblocks Customer Success Manager or send an email to [CSM@fireblocks.com](mailto:CSM@fireblocks.com).", + "parameters": [ + { + "name": "did", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + }, + { + "name": "fields", + "required": false, + "in": "query", + "description": "CSV of fields to return (all, \"blank\" or see list of all field names below)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Transaction validated successfully", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TravelRuleVASP" + } + } + } + }, + "400": { + "description": "Invalid request body" + }, + "500": { + "description": "Internal server error" + } + }, + "tags": [ + "Travel Rule (Beta)" + ] + } + }, + "/screening/travel_rule/vasp": { + "get": { + "operationId": "TravelRuleApiController_findAllVasp", + "summary": "Get All VASPs", + "description": "Get All VASPs.\n\nReturns a list of VASPs. VASPs can be searched and sorted and results are paginated.\n\n**Note:** The reference content in this section documents the Travel Rule beta endpoint. The beta endpoint includes APIs that are currently in preview and aren't yet generally available.\n\nTo enroll in the beta and enable this endpoint, contact your Fireblocks Customer Success Manager or send an email to [CSM@fireblocks.com](mailto:CSM@fireblocks.com).", + "parameters": [ + { + "name": "order", + "required": false, + "in": "query", + "description": "Field to order by", + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "required": false, + "in": "query", + "description": "Records per page", + "schema": { + "type": "number" + } + }, + { + "name": "page", + "required": false, + "in": "query", + "description": "Page number", + "schema": { + "type": "number" + } + }, + { + "name": "fields", + "required": false, + "in": "query", + "description": "CSV of fields to return (all, \"blank\" or see list of all field names below)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Get all VASPs", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TravelRuleGetAllVASPsResponse" + } + } + } + } + }, + "tags": [ + "Travel Rule (Beta)" + ] + } + }, + "/screeening/travel_rule/vasp/update": { + "put": { + "operationId": "TravelRuleApiController_updateVasp", + "summary": "Add jsonDidKey to VASP details", + "description": "Update VASP Details.\n\nUpdates a VASP with the provided parameters. Use this endpoint to add your public jsonDIDkey generated by Notabene.\n\n**Note:** The reference content in this section documents the Travel Rule beta endpoint. The beta endpoint includes APIs that are currently in preview and aren't yet generally available.\n\nTo enroll in the beta and enable this endpoint, contact your Fireblocks Customer Success Manager or send an email to [CSM@fireblocks.com](mailto:CSM@fireblocks.com).", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TravelRuleUpdateVASPDetails" + } + } + } + }, + "responses": { + "200": { + "description": "VASP updated successfully", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TravelRuleUpdateVASPDetails" + } + } + } + }, + "400": { + "description": "Invalid request body" + }, + "500": { + "description": "Internal server error" + } + }, + "tags": [ + "Travel Rule (Beta)" + ] + } + }, + "/tap/active_policy": { + "get": { + "summary": "Get the active policy and its validation", + "description": "Returns the active policy and its validation.
\n**Note:** These endpoints are currently in beta and might be subject to changes.\nIf you want to participate and learn more about the Fireblocks TAP, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com.\n", + "tags": [ + "Policy Editor (Beta)" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "policy = fireblocks.get_active_policy()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const policy = await fireblocks.getActivePolicy();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "A policy object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PolicyAndValidationResponse" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/tap/draft": { + "get": { + "summary": "Get the active draft", + "description": "Returns the active draft and its validation.
\n**Note:** These endpoints are currently in beta and might be subject to changes.\nIf you want to participate and learn more about the Fireblocks TAP, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com.\n", + "tags": [ + "Policy Editor (Beta)" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "policy = fireblocks.get_draft()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const policy = await fireblocks.getDraft();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "A draft validation response object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/DraftReviewAndValidationResponse" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + }, + "put": { + "summary": "Update the draft with a new set of rules", + "description": "Update the draft and return its validation.
\n**Note:** These endpoints are currently in beta and might be subject to changes.\nIf you want to participate and learn more about the Fireblocks TAP, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com.\n", + "tags": [ + "Policy Editor (Beta)" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "policy = fireblocks.update_draft()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const policy = await fireblocks.updateDraft();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "rules": { + "description": "rules to update the draft with", + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicyRule" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "A draft validation response object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/DraftReviewAndValidationResponse" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + }, + "post": { + "summary": "Send publish request for a certain draft id", + "description": "Send publish request of certain draft id and returns the response.
\n**Note:** These endpoints are currently in beta and might be subject to changes.\nIf you want to participate and learn more about the Fireblocks TAP, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com.\n", + "tags": [ + "Policy Editor (Beta)" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "policy = fireblocks.publish_draft()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const policy = await fireblocks.publishDraft();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "draftId": { + "description": "draft unique identifier", + "type": "string" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "A policy publish result object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PublishResult" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + }, + "/tap/publish": { + "post": { + "summary": "Send publish request for a set of policy rules", + "description": "Send publish request of set of policy rules and returns the response.
\n**Note:** These endpoints are currently in beta and might be subject to changes.\nIf you want to participate and learn more about the Fireblocks TAP, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com.\n", + "tags": [ + "Policy Editor (Beta)" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "policy = fireblocks.publish_rules()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const policy = await fireblocks.publishRules();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "rules": { + "description": "Policy rules to publish", + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicyRule" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "A policy publish result object", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PublishResult" + } + } + } + }, + "default": { + "$ref": "#/components/responses/Error" + } + } + } + } + }, + "components": { + "responses": { + "Error": { + "description": "Error Response", + "headers": { + "X-Request-ID": { + "$ref": "#/components/headers/X-Request-ID" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "Unique ID correlated to the API request. Please provide it in any support ticket you create or on Github issues related to Fireblocks SDKs" + }, + "next-page": { + "schema": { + "type": "string" + }, + "description": "URL representing a new request to this API endpoint to receive the next page of results." + }, + "prev-page": { + "schema": { + "type": "string" + }, + "description": "URL representing a new request to this API endpoint to receive the previous page of results." + }, + "X-End-User-Wallet-Id": { + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "Unique ID of the End-User wallet to the API request. Required for end-user wallet operations.", + "required": false + } + }, + "requestBodies": { + "NewWallet": { + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "type": "string", + "description": "the wallet's display name" + } + } + } + } + } + }, + "WalletAddressProperties": { + "content": { + "application/json": { + "schema": { + "properties": { + "address": { + "type": "string", + "description": "The wallet's address (or xpub) of the wallet" + } + } + } + } + } + } + }, + "securitySchemes": { + "bearerTokenAuth": { + "type": "http", + "scheme": "bearer", + "bearerFormat": "JWT" + }, + "ApiKeyAuth": { + "type": "apiKey", + "in": "header", + "name": "X-API-Key" + } + }, + "schemas": { + "MediaEntityResponse": { + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "Cached accessible URL" + }, + "contentType": { + "type": "string", + "enum": [ + "IMAGE", + "VIDEO", + "ANIMATION", + "THREE_D", + "TEXT", + "GIF", + "UNKNOWN_TYPE", + "SVG", + "AUDIO" + ], + "description": "Media type" + } + }, + "required": [ + "url", + "contentType" + ] + }, + "TokenCollectionResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "symbol": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "symbol" + ] + }, + "TokenResponse": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The Fireblocks NFT asset id" + }, + "tokenId": { + "type": "string", + "description": "Token id within the contract/collection" + }, + "standard": { + "type": "string", + "description": "ERC721 / ERC1155" + }, + "metadataURI": { + "type": "string", + "description": "URL of the original token JSON metadata" + }, + "cachedMetadataURI": { + "type": "string", + "description": "URL of the cached token JSON metadata" + }, + "media": { + "description": "Media items extracted from metadata JSON", + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaEntityResponse" + } + }, + "collection": { + "description": "Parent collection information", + "allOf": [ + { + "$ref": "#/components/schemas/TokenCollectionResponse" + } + ] + }, + "blockchainDescriptor": { + "type": "string", + "enum": [ + "ETH", + "ETH_TEST3", + "POLYGON", + "POLYGON_TEST_MUMBAI" + ] + }, + "description": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "tokenId", + "standard", + "media", + "blockchainDescriptor", + "description", + "name" + ] + }, + "UpdateTokenOwnershipStatusDto": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "LISTED", + "ARCHIVED" + ] + } + }, + "required": [ + "status" + ] + }, + "Paging": { + "type": "object", + "properties": { + "next": { + "type": "string", + "description": "Cursor to the next page" + } + }, + "required": [ + "next" + ] + }, + "TokenOwnershipResponse": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The Fireblocks NFT asset id" + }, + "tokenId": { + "type": "string", + "description": "Token id within the contract/collection" + }, + "standard": { + "type": "string", + "description": "ERC721 / ERC1155" + }, + "metadataURI": { + "type": "string", + "description": "URL of the original token JSON metadata" + }, + "cachedMetadataURI": { + "type": "string", + "description": "URL of the cached token JSON metadata" + }, + "media": { + "description": "Media items extracted from metadata JSON", + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaEntityResponse" + } + }, + "collection": { + "description": "Parent collection information", + "allOf": [ + { + "$ref": "#/components/schemas/TokenCollectionResponse" + } + ] + }, + "balance": { + "type": "string" + }, + "vaultAccountId": { + "type": "string" + }, + "ownershipStartTime": { + "type": "number" + }, + "ownershipLastUpdateTime": { + "type": "number" + }, + "blockchainDescriptor": { + "enum": [ + "ETH", + "ETH_TEST3", + "POLYGON", + "POLYGON_TEST_MUMBAI" + ], + "type": "string" + }, + "description": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "tokenId", + "standard", + "media", + "balance", + "vaultAccountId", + "ownershipStartTime", + "ownershipLastUpdateTime", + "blockchainDescriptor", + "description", + "name" + ] + }, + "CollectionOwnershipResponse": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Fireblocks collection id" + }, + "name": { + "type": "string", + "description": "Collection name" + }, + "symbol": { + "type": "string", + "description": "Collection symbol" + }, + "standard": { + "type": "string", + "description": "Collection contract standard" + }, + "blockchainDescriptor": { + "enum": [ + "ETH", + "ETH_TEST3", + "POLYGON", + "POLYGON_TEST_MUMBAI" + ], + "type": "string", + "description": "Collection's blockchain" + }, + "contractAddress": { + "type": "string", + "description": "Collection contract standard" + } + }, + "required": [ + "id", + "name", + "symbol", + "blockchainDescriptor" + ] + }, + "WalletAsset": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "balance": { + "type": "string" + }, + "lockedAmount": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/ConfigChangeRequestStatus" + }, + "address": { + "type": "string" + }, + "tag": { + "type": "string" + }, + "activationTime": { + "type": "string" + } + } + }, + "ExternalWalletAsset": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/ConfigChangeRequestStatus" + }, + "address": { + "type": "string" + }, + "tag": { + "type": "string" + }, + "activationTime": { + "type": "string" + }, + "additionalInfo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WalletAssetAdditionalInfo" + } + } + } + }, + "WalletAssetAdditionalInfo": { + "type": "object", + "properties": { + "accountHolderGivenName": { + "type": "string" + }, + "accountHolderSurname": { + "type": "string" + }, + "accountHolderCity": { + "type": "string" + }, + "accountHolderCountry": { + "type": "string" + }, + "accountHolderAddress1": { + "type": "string" + }, + "accountHolderAddress2": { + "type": "string" + }, + "accountHolderDistrict": { + "type": "string" + }, + "accountHolderPostalCode": { + "type": "string" + }, + "abaRoutingNumber": { + "type": "string" + }, + "abaAccountNumber": { + "type": "string" + }, + "abaCountry": { + "type": "string" + }, + "iban": { + "type": "string" + }, + "ibanCity": { + "type": "string" + }, + "ibanCountry": { + "type": "string" + }, + "speiClabe": { + "type": "string" + }, + "speiName": { + "type": "string" + } + } + }, + "ExchangeAsset": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "balance": { + "type": "string" + }, + "lockedAmount": { + "type": "string" + }, + "total": { + "type": "string" + }, + "available": { + "type": "string" + } + } + }, + "ExchangeTradingAccount": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "name": { + "type": "string" + }, + "assets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExchangeAsset" + } + } + } + }, + "FiatAsset": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "balance": { + "type": "string" + } + } + }, + "CreateVaultAssetResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "address": { + "type": "string" + }, + "legacyAddress": { + "type": "string" + }, + "enterpriseAddress": { + "type": "string" + }, + "tag": { + "type": "string" + }, + "eosAccountName": { + "type": "string" + }, + "status": { + "type": "string" + }, + "activationTxId": { + "type": "string" + } + } + }, + "RewardsInfo": { + "type": "object", + "properties": { + "pendingRewards": { + "description": "Amount that is pending for rewards", + "type": "string" + } + } + }, + "VaultAsset": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "total": { + "description": "The total wallet balance. In EOS this value includes the network balance, self staking and pending refund. For all other coins it is the balance as it appears on the blockchain.", + "type": "string" + }, + "balance": { + "deprecated": true, + "description": "Deprecated - replaced by \"total\"", + "type": "string" + }, + "available": { + "description": "Funds available for transfer. Equals the blockchain balance minus any locked amounts", + "type": "string" + }, + "pending": { + "description": "The cumulative balance of all transactions pending to be cleared", + "type": "string" + }, + "frozen": { + "description": "The cumulative frozen balance", + "type": "string" + }, + "lockedAmount": { + "description": "Funds in outgoing transactions that are not yet published to the network", + "type": "string" + }, + "staked": { + "description": "Staked balance", + "type": "string" + }, + "totalStakedCPU": { + "type": "number", + "description": "Deprecated" + }, + "totalStakedNetwork": { + "type": "string", + "description": "Deprecated" + }, + "selfStakedCPU": { + "type": "string", + "description": "Deprecated" + }, + "selfStakedNetwork": { + "type": "string", + "description": "Deprecated" + }, + "pendingRefundCPU": { + "type": "string", + "description": "Deprecated" + }, + "pendingRefundNetwork": { + "type": "string", + "description": "Deprecated" + }, + "blockHeight": { + "type": "string" + }, + "blockHash": { + "type": "string" + }, + "rewardsInfo": { + "$ref": "#/components/schemas/RewardsInfo" + } + } + }, + "VaultWalletAddress": { + "type": "object", + "properties": { + "assetId": { + "type": "string", + "x-fb-entity": "asset" + }, + "address": { + "type": "string" + }, + "description": { + "type": "string" + }, + "tag": { + "type": "string" + }, + "type": { + "type": "string" + }, + "customerRefId": { + "type": "string" + }, + "addressFormat": { + "type": "string", + "enum": [ + "SEGWIT", + "LEGACY" + ] + }, + "legacyAddress": { + "type": "string" + }, + "enterpriseAddress": { + "type": "string" + }, + "bip44AddressIndex": { + "type": "integer" + }, + "userDefined": { + "type": "boolean" + } + } + }, + "CreateAddressResponse": { + "type": "object", + "properties": { + "address": { + "type": "string" + }, + "legacyAddress": { + "type": "string" + }, + "enterpriseAddress": { + "type": "string" + }, + "tag": { + "type": "string" + }, + "bip44AddressIndex": { + "type": "integer" + } + } + }, + "VaultAccountsPagedResponse": { + "type": "object", + "properties": { + "accounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VaultAccount" + } + }, + "paging": { + "type": "object", + "properties": { + "before": { + "type": "string" + }, + "after": { + "type": "string" + } + } + }, + "previousUrl": { + "type": "string" + }, + "nextUrl": { + "type": "string" + } + } + }, + "PaginatedAssetWalletResponse": { + "type": "object", + "properties": { + "assetWallets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AssetWallet" + } + }, + "paging": { + "type": "object", + "properties": { + "before": { + "description": "A string representing a cursor. Users can use this with a new request to this API endpoint as the โ€œbeforeโ€ request parameter to fetch the previous page of results.", + "type": "string" + }, + "after": { + "description": "A string representing a cursor. Users can use this with a new request to this API endpoint as the โ€œbeforeโ€ request parameter to fetch the next page of results.", + "type": "string" + } + } + } + } + }, + "AssetWallet": { + "type": "object", + "properties": { + "vaultId": { + "description": "ID of the vault account. You can [get the vault account by this ID](https://developers.fireblocks.com/reference/get_vault-accounts-vaultaccountid) to retrieve vault properties such as its name, auto fueling, hidden on UI or customer reference ID.", + "type": "string" + }, + "assetId": { + "description": "ID of the asset. You can get more information about this asset by using the [supported assets API](https://developers.fireblocks.com/reference/get_supported-assets)", + "type": "string" + }, + "available": { + "description": "Available balance, available to use in a transaction.", + "type": "string" + }, + "total": { + "description": "Total balance at the asset wallet, as seen at the blockchain explorers. This includes balance available, and any kind of unavailable balance such as locked, frozen, or others.", + "type": "string" + }, + "pending": { + "description": "Pending balance.", + "type": "string" + }, + "staked": { + "description": "Staked balance.", + "type": "string" + }, + "frozen": { + "description": "Funds frozen due to the anti-money laundering policy at this workspace.", + "type": "string" + }, + "lockedAmount": { + "description": "Locked balance.", + "type": "string" + }, + "blockHeight": { + "description": "The height (number) of the block of the balance. Can by empty.", + "type": "string" + }, + "blockHash": { + "description": "The hash of the block of the balance. Can by empty.", + "type": "string" + }, + "creationTimestamp": { + "description": "Unix timestamp of the time the asset wallet was created.", + "type": "string" + } + } + }, + "VaultAccount": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "assets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VaultAsset" + } + }, + "hiddenOnUI": { + "type": "boolean" + }, + "customerRefId": { + "type": "string" + }, + "autoFuel": { + "type": "boolean" + } + } + }, + "UnmanagedWallet": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "customerRefId": { + "type": "string" + }, + "assets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WalletAsset" + } + } + }, + "required": [ + "id", + "name", + "status" + ] + }, + "ExchangeAccount": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/ExchangeType" + }, + "name": { + "type": "string", + "description": "Display name of the exchange account" + }, + "status": { + "type": "string" + }, + "assets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExchangeAsset" + } + }, + "tradingAccounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExchangeTradingAccount" + } + }, + "isSubaccount": { + "description": "True if the account is a subaccount in an exchange", + "type": "boolean" + }, + "mainAccountId": { + "description": "if the account is a sub-account, the ID of the main account", + "type": "string" + } + } + }, + "FiatAccount": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/FiatAccountType" + }, + "name": { + "type": "string", + "description": "Display name of the fiat account" + }, + "address": { + "type": "string" + }, + "assets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FiatAsset" + } + } + } + }, + "OneTimeAddress": { + "type": "object", + "properties": { + "address": { + "type": "string" + }, + "tag": { + "type": "string" + } + }, + "required": [ + "address" + ] + }, + "TransferPeerPath": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "VAULT_ACCOUNT", + "EXCHANGE_ACCOUNT", + "INTERNAL_WALLET", + "EXTERNAL_WALLET", + "NETWORK_CONNECTION", + "FIAT_ACCOUNT", + "COMPOUND", + "GAS_STATION", + "ONE_TIME_ADDRESS", + "UNKNOWN", + "END_USER_WALLET" + ] + }, + "subType": { + "type": "string", + "enum": [ + "BINANCE", + "BINANCEUS", + "BITFINEX", + "BITHUMB", + "BITMEX", + "BITSO", + "BITSTAMP", + "BITTREX", + "BLINC", + "BYBIT", + "CIRCLE", + "COINBASEEXCHANGE", + "COINBASEPRO", + "COINMETRO", + "COINSPRO", + "CRYPTOCOM", + "DERIBIT", + "GEMINI", + "HITBTC", + "HUOBI", + "INDEPENDENTRESERVE", + "KORBIT", + "KRAKEN", + "KRAKENINTL", + "KUCOIN", + "LIQUID", + "OKCOIN", + "OKEX", + "PAXOS", + "POLONIEX", + "External", + "Internal" + ] + }, + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "walletId": { + "type": "string", + "format": "uuid" + } + }, + "required": [ + "type" + ] + }, + "DestinationTransferPeerPath": { + "allOf": [ + { + "$ref": "#/components/schemas/TransferPeerPath" + }, + { + "type": "object" + }, + { + "description": "The destination of the transaction.", + "properties": { + "oneTimeAddress": { + "$ref": "#/components/schemas/OneTimeAddress" + } + } + } + ] + }, + "CreateTransactionResponse": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the transaction." + }, + "status": { + "type": "string", + "description": "The primary status of the transaction. For details, see [Primary transaction statuses.] (https://developers.fireblocks.com/reference/primary-transaction-statuses)" + }, + "systemMessages": { + "$ref": "#/components/schemas/SystemMessageInfo" + } + } + }, + "SystemMessageInfo": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "WARN", + "BLOCK" + ] + }, + "message": { + "type": "string", + "description": "A response from Fireblocks that communicates a message about the health of the process being performed. If this object is returned with data, you should expect potential delays or incomplete transaction statuses.", + "example": "Slow transaction processing. Outgoing transactions might be stuck." + } + } + }, + "CancelTransactionResponse": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + } + } + }, + "UnfreezeTransactionResponse": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + } + } + }, + "FreezeTransactionResponse": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + } + } + }, + "AmlScreeningResult": { + "type": "object", + "description": "The result of the AML screening.", + "properties": { + "provider": { + "type": "string" + }, + "payload": { + "type": "object" + } + } + }, + "FeeInfo": { + "type": "object", + "description": "Details of the transaction's fee.", + "properties": { + "networkFee": { + "description": "The fee paid to the network", + "type": "string" + }, + "serviceFee": { + "description": "The total fee deducted by the exchange from the actual requested amount (serviceFee = amount - netAmount)", + "type": "string" + }, + "gasPrice": { + "type": "string" + } + } + }, + "BlockInfo": { + "type": "object", + "description": "The block hash and height of the block that this transaction was mined in.\n **Note**: If an outgoing transaction uses the destinations object with more than one value in the array, blockHash is set to null.", + "properties": { + "blockHeight": { + "type": "string" + }, + "blockHash": { + "type": "string" + } + } + }, + "AuthorizationInfo": { + "type": "object", + "description": "The information about your [Transaction Authorization Policy (TAP).](https://developers.fireblocks.com/docs/capabilities#transaction-authorization-policy-tap)", + "properties": { + "allowOperatorAsAuthorizer": { + "type": "boolean" + }, + "logic": { + "type": "string", + "enum": [ + "AND", + "OR" + ] + }, + "groups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AuthorizationGroups" + } + } + } + }, + "AuthorizationGroups": { + "type": "object", + "properties": { + "th": { + "type": "number" + }, + "users": { + "type": "object", + "additionalProperties": { + "type": "string", + "enum": [ + "PENDING_AUTHORIZATION", + "APPROVED", + "REJECTED", + "NA" + ] + } + } + } + }, + "AmountInfo": { + "type": "object", + "description": "The details of the requested amount to transfer.", + "properties": { + "amount": { + "description": "If the transfer is a withdrawal from an exchange, the actual amount that was requested to be transferred. Otherwise, the requested amount.", + "type": "string" + }, + "requestedAmount": { + "description": "The amount requested by the user.", + "type": "string" + }, + "netAmount": { + "description": "The net amount of the transaction, after fee deduction.", + "type": "string" + }, + "amountUSD": { + "description": "The USD value of the requested amount.", + "type": "string" + } + } + }, + "RewardInfo": { + "type": "object", + "description": "This field is relevant only for Algorand transactions. Both `srcRewards` and `destRewards` will appear only for Vault to Vault transactions, otherwise you will receive only the Fireblocksโ€™ side of the transaction.", + "properties": { + "srcRewards": { + "type": "string" + }, + "destRewards": { + "type": "string" + } + } + }, + "SourceTransferPeerPathResponse": { + "allOf": [ + { + "$ref": "#/components/schemas/TransferPeerPath" + }, + { + "type": "object", + "description": "The transactionโ€™s source.", + "properties": { + "type": { + "type": "string" + }, + "subType": { + "type": "string", + "description": "In case the type is set to `EXCHANGE_ACCOUNT` or `FIAT_ACCOUNT`, the specific exchange vendor name or fiat vendor name. In case the type is set to `INTERNAL_WALLET` or `EXTERNAL_WALLET`, the subType is set to `Internal` or `External`." + }, + "id": { + "type": "string", + "description": "The ID of the peer. You can retrieve the ID of each venue object using the endpoints for [listing vault accounts](https://developers.fireblocks.com/reference/get_vault-accounts-paged), [listing exchange account](https://developers.fireblocks.com/reference/get_exchange-accounts), [listing fiat accounts](https://developers.fireblocks.com/reference/get_fiat-accounts), [listing internal wallets](https://developers.fireblocks.com/reference/get_internal-wallets), [listing external wallets](https://developers.fireblocks.com/reference/get_external-wallets), [listing network connections](https://developers.fireblocks.com/reference/get_network-connections). For the other types, this parameter is not needed." + }, + "name": { + "type": "string", + "description": "The name of the peer." + } + } + } + ] + }, + "DestinationTransferPeerPathResponse": { + "allOf": [ + { + "$ref": "#/components/schemas/TransferPeerPath" + }, + { + "type": "object", + "description": "Destination of the transaction.\n\n**Note:** In case the transaction is sent to multiple destinations, the `destinations` parameter is be used instead of this.", + "properties": { + "type": { + "type": "string" + }, + "subType": { + "type": "string", + "description": "In case the type is set to `EXCHANGE_ACCOUNT` or `FIAT_ACCOUNT`, the specific exchange vendor name or fiat vendor name.In case the type is set to `INTERNAL_WALLET` or `EXTERNAL_WALLET`, the subType is set to `Internal` or `External`." + }, + "id": { + "type": "string", + "description": "The ID of the peer. You can retrieve the ID of each venue object using the endpoints for [listing vault accounts](https://developers.fireblocks.com/reference/get_vault-accounts-paged), [listing exchange account](https://developers.fireblocks.com/reference/get_exchange-accounts), [listing fiat accounts](https://developers.fireblocks.com/reference/get_fiat-accounts), [listing internal wallets](https://developers.fireblocks.com/reference/get_internal-wallets), [listing external wallets](https://developers.fireblocks.com/reference/get_external-wallets), [listing network connections](https://developers.fireblocks.com/reference/get_network-connections). For the other types, this parameter is not needed." + }, + "name": { + "type": "string", + "description": "The name of the peer." + } + } + } + ] + }, + "TransactionResponse": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the transaction." + }, + "externalTxId": { + "type": "string", + "description": "Unique transaction ID provided by the user. Fireblocks highly recommends setting an `externalTxId` for every transaction created, to avoid submitting the same transaction twice." + }, + "status": { + "type": "string", + "description": "The primary status of the transaction. For details, see [Primary transaction statuses](https://developers.fireblocks.com/reference/primary-transaction-statuses)." + }, + "subStatus": { + "type": "string", + "description": "See [Transaction substatuses](https://developers.fireblocks.com/reference/transaction-substatuses) for the list of transaction sub statuses." + }, + "txHash": { + "type": "string", + "description": "The hash of the transaction on the blockchain.\n * This parameter exists if at least one of the following conditions is met:\n\n 1. The transactionโ€™s source type is `UNKNOWN`, `WHITELISTED_ADDRESS`, `NETWORK_CONNECTION`, `ONE_TIME_ADDRESS`, `FIAT_ACCOUNT` or `GAS_STATION`.\n\n 2. The transactionโ€™s source type is `VAULT` and the status is either: `CONFIRMING`, `COMPLETED`, or was in any of these statuses prior to changing to `FAILED` or `REJECTED`. In some instances, transactions in status `BROADCASTING` will include the txHash as well.\n\n 3. The transactionโ€™s source type is `EXCHANGE_ACCOUNT` and the transactionโ€™s destination type is `VAULT`, and the status is either: `CONFIRMING`, `COMPLETED`, or was in any of these status prior to changing to `FAILED`.\n \n\n* In addition, the following conditions must be met:\n\n 1. The asset is a crypto asset (not fiat).\n\n 2. The transaction operation is not RAW or `TYPED_MESSAGE`." + }, + "operation": { + "$ref": "#/components/schemas/GetTransactionOperation" + }, + "note": { + "type": "string", + "description": "Custom note, not sent to the blockchain, that describes the transaction at your Fireblocks workspace." + }, + "assetId": { + "type": "string", + "description": "The ID of the asset to transfer, for `TRANSFER`, `MINT`, `BURN`, `ENABLE_ASSET`,`STAKE` ,`UNSTAKE` or `WITHDRAW` operations. [See the list of supported assets and their IDs on Fireblocks.](https://developers.fireblocks.com/reference/get_supported-assets)", + "x-fb-entity": "asset" + }, + "source": { + "$ref": "#/components/schemas/SourceTransferPeerPathResponse" + }, + "sourceAddress": { + "type": "string", + "description": "For account based assets only, the source address of the transaction.\n**Note:** If the status is `CONFIRMING`, `COMPLETED`, or has been `CONFIRMING`; then moved forward to `FAILED` or `REJECTED`, then this parameter will contain the source address. In any other case, this parameter will be empty." + }, + "tag": { + "type": "string", + "description": "Source address tag for XRP, used as memo for EOS/XLM, or Bank Transfer Description for the fiat provider BLINC (by BCB Group)." + }, + "destination": { + "$ref": "#/components/schemas/DestinationTransferPeerPathResponse" + }, + "destinations": { + "type": "array", + "description": "The transactionโ€™s destinations.\n**Note:** In case the transaction is sent to a single destination, the `destination` parameter is used instead of this.", + "items": { + "$ref": "#/components/schemas/TransactionResponseDestination" + } + }, + "destinationAddress": { + "type": "string", + "description": "Address where the asset were transferred.\nNotes:\n - For [Multi destination transactions](https://support.fireblocks.io/hc/en-us/articles/360018447980-Multi-destination-transactions), this parameter will be empty. In this case, you should refer to the destinations field.\n - If the status is `CONFIRMING`, `COMPLETED`, or has been `CONFIRMING`; then moved forward to `FAILED` or `REJECTED`, then this parameter will contain the destination address. In any other case, this parameter will be empty." + }, + "destinationAddressDescription": { + "type": "string", + "description": "Description of the address." + }, + "destinationTag": { + "type": "string", + "description": "Destination address tag for XRP, used as memo for EOS/XLM, or Bank Transfer Description for the fiat provider BLINC (by BCB Group)." + }, + "contractCallDecodedData": { + "description": "Decoded data for `CONTRACT_CALL` operations. The Fireblocks [development libraries](https://developers.fireblocks.com/docs/ethereum-development#convenience-libraries) are recommended for setting this parameter's value.", + "type": "object", + "properties": { + "contractName": { + "type": "string" + }, + "functionCalls": { + "type": "array", + "items": { + "type": "object" + } + } + } + }, + "amountInfo": { + "$ref": "#/components/schemas/AmountInfo" + }, + "treatAsGrossAmount": { + "type": "boolean", + "description": "For transactions initiated via this Fireblocks workspace, when set to `true`, the fee is deducted from the requested amount.\n\n**Note**: This parameter can only be considered if a transaction's asset is a base asset, such as ETH or MATIC. If the asset can't be used for transaction fees, like USDC, this parameter is ignored and the fee is deducted from the relevant base asset wallet in the source account." + }, + "feeInfo": { + "$ref": "#/components/schemas/FeeInfo" + }, + "feeCurrency": { + "type": "string", + "description": "The asset which was withdrawn to pay the transaction fee, for example ETH for EVM-based blockchains, BTC for Tether Omni." + }, + "networkRecords": { + "type": "array", + "description": "In case a single transaction resulted with multiple transfers, for example a result of a contract call, then this parameter specifies each transfer that took place on the blockchain. In case of a single transfer transaction, this parameter is empty.", + "items": { + "$ref": "#/components/schemas/NetworkRecord" + } + }, + "createdAt": { + "type": "number", + "description": "The transactionโ€™s creation date and time, in unix timestamp." + }, + "lastUpdated": { + "type": "number", + "description": "The transactionโ€™s last update date and time, in unix timestamp." + }, + "createdBy": { + "type": "string", + "description": "User ID of the initiator of the transaction." + }, + "signedBy": { + "type": "array", + "description": "User IDโ€™s of the signers of the transaction.", + "items": { + "type": "string" + } + }, + "rejectedBy": { + "type": "string", + "description": "User ID of the user that rejected the transaction (in case it was rejected)." + }, + "authorizationInfo": { + "$ref": "#/components/schemas/AuthorizationInfo" + }, + "exchangeTxId": { + "type": "string", + "description": "If the transaction originated from an exchange, this is the ID of this transaction at the exchange." + }, + "customerRefId": { + "type": "string", + "description": "The ID for AML providers to associate the owner of funds with transactions." + }, + "amlScreeningResult": { + "$ref": "#/components/schemas/AmlScreeningResult" + }, + "extraParameters": { + "$ref": "#/components/schemas/ExtraParameters" + }, + "signedMessages": { + "$ref": "#/components/schemas/SignedMessage" + }, + "numOfConfirmations": { + "type": "number", + "description": "The number of confirmations of the transaction. The number will increase until the transaction will be considered completed according to the confirmation policy." + }, + "blockInfo": { + "$ref": "#/components/schemas/BlockInfo" + }, + "index": { + "type": "number", + "description": "For UTXO based assets this is the vOut, for Ethereum based, this is the index of the event of the contract call.\n **Note:** This field is not returned if a transaction uses the `destinations` object with more than one value." + }, + "rewardInfo": { + "$ref": "#/components/schemas/RewardInfo" + }, + "systemMessages": { + "$ref": "#/components/schemas/SystemMessageInfo" + }, + "addressType": { + "type": "string", + "enum": [ + "WHITELISTED", + "ONE_TIME" + ] + }, + "requestedAmount": { + "description": "The amount requested by the user. Deprecated - please use the `amountInfo` field for accuracy.", + "type": "number", + "deprecated": true + }, + "amount": { + "description": "If the transfer is a withdrawal from an exchange, the actual amount that was requested to be transferred. Otherwise, the requested amount. Deprecated - please use the `amountInfo` field for accuracy.", + "type": "number", + "deprecated": true + }, + "netAmount": { + "description": "The net amount of the transaction, after fee deduction. Deprecated - please use the `amountInfo` field for accuracy.", + "type": "number", + "deprecated": true + }, + "amountUSD": { + "description": "The USD value of the requested amount. Deprecated - please use the `amountInfo` field for accuracy.", + "type": "number", + "nullable": true, + "deprecated": true + }, + "serviceFee": { + "description": "The total fee deducted by the exchange from the actual requested amount (`serviceFee` = `amount` - `netAmount`). Deprecated - please use the `feeInfo` field for accuracy.", + "type": "number", + "deprecated": true + }, + "fee": { + "description": "Deprecated - please use the `feeInfo` field for accuracy.", + "type": "number", + "deprecated": true + }, + "networkFee": { + "description": "The fee paid to the network. Deprecated - please use the `feeInfo` field for accuracy.", + "type": "number", + "deprecated": true + } + } + }, + "TransactionResponseDestination": { + "type": "object", + "properties": { + "destination": { + "$ref": "#/components/schemas/DestinationTransferPeerPathResponse" + }, + "destinationAddress": { + "description": "Address where the asset was transferred." + }, + "destinationAddressDescription": { + "description": "Description of the address." + }, + "amount": { + "type": "string", + "description": "The amount to be sent to this destination." + }, + "amountUSD": { + "type": "string", + "description": "The USD value of the requested amount." + }, + "amlScreeningResult": { + "$ref": "#/components/schemas/AmlScreeningResult" + }, + "customerRefId": { + "description": "The ID for AML providers to associate the owner of funds with transactions." + }, + "authorizationInfo": { + "$ref": "#/components/schemas/AuthorizationInfo" + } + } + }, + "NetworkRecord": { + "type": "object", + "properties": { + "source": { + "$ref": "#/components/schemas/SourceTransferPeerPathResponse" + }, + "destination": { + "$ref": "#/components/schemas/DestinationTransferPeerPathResponse" + }, + "txHash": { + "type": "string" + }, + "networkFee": { + "type": "string" + }, + "assetId": { + "type": "string", + "x-fb-entity": "asset" + }, + "netAmount": { + "description": "The net amount of the transaction, after fee deduction", + "type": "string" + }, + "isDropped": { + "type": "boolean" + }, + "type": { + "type": "string" + }, + "destinationAddress": { + "type": "string" + }, + "sourceAddress": { + "type": "string" + }, + "amountUSD": { + "type": "string" + }, + "index": { + "type": "number" + }, + "rewardInfo": { + "$ref": "#/components/schemas/RewardInfo" + } + } + }, + "AssetTypeResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "ALGO_ASSET", + "BASE_ASSET", + "BEP20", + "COMPOUND", + "ERC20", + "FIAT", + "SOL_ASSET", + "TRON_TRC20", + "XLM_ASSET", + "XDB_ASSET" + ] + }, + "contractAddress": { + "type": "string" + }, + "nativeAsset": { + "type": "string" + }, + "decimals": { + "type": "number" + } + }, + "required": [ + "id", + "name", + "type" + ] + }, + "NetworkConnection": { + "type": "object", + "properties": { + "localNetworkId": { + "type": "string", + "description": "The network ID of the profile trying to create the connection." + }, + "remoteNetworkId": { + "type": "string", + "description": "The network ID the profile is attempting to connect to." + }, + "routingPolicy": { + "$ref": "#/components/schemas/NetworkConnectionRoutingPolicy" + } + }, + "required": [ + "localNetworkId", + "remoteNetworkId" + ] + }, + "NetworkConnectionResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "localChannel": { + "allOf": [ + { + "$ref": "#/components/schemas/NetworkChannel" + } + ], + "deprecated": true, + "description": "Deprecated - Replaced by `localNetworkId`" + }, + "remoteChannel": { + "allOf": [ + { + "$ref": "#/components/schemas/NetworkChannel" + } + ], + "deprecated": true, + "description": "Deprecated - Replaced by `remoteNetworkId`" + }, + "status": { + "$ref": "#/components/schemas/ConfigChangeRequestStatus" + }, + "localNetworkId": { + "$ref": "#/components/schemas/NetworkId" + }, + "remoteNetworkId": { + "$ref": "#/components/schemas/NetworkId" + }, + "routingPolicy": { + "$ref": "#/components/schemas/NetworkConnectionRoutingPolicy" + } + }, + "required": [ + "id", + "localNetworkId", + "remoteNetworkId", + "routingPolicy", + "status" + ] + }, + "EstimatedTransactionFeeResponse": { + "type": "object", + "properties": { + "low": { + "$ref": "#/components/schemas/TransactionFee" + }, + "medium": { + "$ref": "#/components/schemas/TransactionFee" + }, + "high": { + "$ref": "#/components/schemas/TransactionFee" + } + }, + "required": [ + "low", + "medium", + "high" + ] + }, + "EstimatedNetworkFeeResponse": { + "type": "object", + "properties": { + "low": { + "$ref": "#/components/schemas/NetworkFee" + }, + "medium": { + "$ref": "#/components/schemas/NetworkFee" + }, + "high": { + "$ref": "#/components/schemas/NetworkFee" + } + }, + "required": [ + "low", + "medium", + "high" + ] + }, + "GasStationPropertiesResponse": { + "type": "object", + "properties": { + "balance": { + "type": "object" + }, + "configuration": { + "$ref": "#/components/schemas/GasStationConfiguration" + } + }, + "required": [ + "low", + "medium", + "high" + ] + }, + "TransactionFee": { + "type": "object", + "properties": { + "feePerByte": { + "type": "string" + }, + "gasPrice": { + "type": "string" + }, + "gasLimit": { + "type": "string" + }, + "networkFee": { + "type": "string" + }, + "baseFee": { + "description": "(optional) Base Fee according to EIP-1559 (ETH assets)", + "type": "string" + }, + "priorityFee": { + "description": "(optional) Priority Fee according to EIP-1559 (ETH assets)", + "type": "string" + } + } + }, + "NetworkFee": { + "type": "object", + "properties": { + "feePerByte": { + "type": "string" + }, + "gasPrice": { + "type": "string" + }, + "networkFee": { + "type": "string" + }, + "baseFee": { + "description": "(optional) Base Fee according to EIP-1559 (ETH assets)", + "type": "string" + }, + "priorityFee": { + "description": "(optional) Priority Fee according to EIP-1559 (ETH assets)", + "type": "string" + } + } + }, + "GasStationConfiguration": { + "type": "object", + "properties": { + "gasThreshold": { + "type": "string" + }, + "gasCap": { + "type": "string" + }, + "maxGasPrice": { + "type": "string" + } + } + }, + "NetworkChannel": { + "deprecated": true, + "description": "Deprecated in the only used reference - NetworkConnectionResponse", + "type": "object", + "properties": { + "networkId": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "NetworkId": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "name" + ] + }, + "NetworkIdResponse": { + "allOf": [ + { + "$ref": "#/components/schemas/NetworkId" + }, + { + "type": "object", + "properties": { + "routingPolicy": { + "$ref": "#/components/schemas/NetworkIdRoutingPolicy" + }, + "isDiscoverable": { + "type": "boolean", + "description": "The specific network is discoverable." + } + } + } + ] + }, + "TransactionRequest": { + "type": "object", + "properties": { + "operation": { + "$ref": "#/components/schemas/TransactionOperation" + }, + "note": { + "type": "string", + "description": "Custom note, not sent to the blockchain, to describe the transaction at your Fireblocks workspace.", + "example": "Ticket 123" + }, + "externalTxId": { + "type": "string", + "description": "An optional but highly recommended parameter. Fireblocks will reject future transactions with same ID. \n \nYou should set this to a unique ID representing the transaction, to avoid submitting the same transaction twice. This helps with cases where submitting the transaction responds with an error code due to Internet interruptions, but the transaction was actually sent and processed. To validate whether a transaction has been processed, [Find a specific transaction by external transaction ID](https://developers.fireblocks.com/reference/get_transactions-external-tx-id-externaltxid).\n \nThere is no specific format required for this parameter.", + "example": "00000000-0000-0000-0000-000000000000" + }, + "assetId": { + "type": "string", + "description": "The ID of the asset to transfer, for `TRANSFER`, `MINT` or `BURN` operations. [See the list of supported assets and their IDs on Fireblocks.](https://developers.fireblocks.com/reference/get_supported-assets)", + "x-fb-entity": "asset", + "example": "ETH" + }, + "source": { + "$ref": "#/components/schemas/TransferPeerPath" + }, + "destination": { + "$ref": "#/components/schemas/DestinationTransferPeerPath" + }, + "destinations": { + "type": "array", + "description": "For UTXO based blockchains, you can send a single transaction to multiple destinations.", + "items": { + "$ref": "#/components/schemas/TransactionRequestDestination" + } + }, + "amount": { + "description": "For `TRANSFER` operations, the requested amount to transfer, in the assetโ€™s unit. Fireblocks recommends using a numeric string for accurate precision. Although a number input exists, it is deprecated.", + "oneOf": [ + { + "type": "string", + "description": "Numeric string (recommended)", + "example": "0.02" + }, + { + "type": "number", + "description": "Number (deprecated)", + "example": 0.02 + } + ] + }, + "treatAsGrossAmount": { + "type": "boolean", + "description": "\"When set to `true`, the fee will be deducted from the requested amount.\"\n\n**Note**: This parameter can only be considered if a transactionโ€™s asset is a base asset, such as ETH or MATIC. If the asset canโ€™t be used for transaction fees, like USDC, this parameter is ignored and the fee is deducted from the relevant base asset wallet in the source account.", + "example": false + }, + "forceSweep": { + "type": "boolean", + "description": "For Polkadot, Kusama and Westend transactions only. When set to true, Fireblocks will empty the asset wallet.\n\n **Note:** If set to true when the source account is exactly 1 DOT, the transaction will fail. Any amount more or less than 1 DOT succeeds. This is a Polkadot blockchain limitation.", + "example": false + }, + "feeLevel": { + "type": "string", + "description": "For UTXO or EVM-based blockchains only. Defines the blockchain fee level which will be payed for the transaction. Alternatively, specific fee estimation parameters exist below.", + "enum": [ + "LOW", + "MEDIUM", + "HIGH" + ], + "example": "MEDIUM" + }, + "fee": { + "description": "For UTXO-based blockchains, the fee per bytes in the assetโ€™s smallest unit (Satoshi, Latoshi, etc.). For Ripple, the fee for the transaction. Fireblocks recommends using a numeric string for accurate precision. Although a number input exists, it is deprecated.", + "oneOf": [ + { + "type": "string", + "description": "Numeric string (recommended)" + }, + { + "type": "number", + "description": "Number (deprecated)" + } + ] + }, + "priorityFee": { + "description": "For Ethereum-based blockchains only, the fee for EIP-1559 transaction pricing mechanism. Value is in Gwei. Fireblocks recommends using a numeric string for accurate precision. Although a number input exists, it is deprecated.", + "oneOf": [ + { + "type": "string", + "description": "Numeric string (recommended)", + "example": "2" + }, + { + "type": "number", + "description": "Number (deprecated)", + "example": 2 + } + ] + }, + "failOnLowFee": { + "type": "boolean", + "description": "When set to `true`, in case the current `MEDIUM` fee level is higher than the one specified in the transaction, the transaction will fail to avoid getting stuck with no confirmations." + }, + "maxFee": { + "description": "The maximum fee (gas price or fee per byte) that should be payed for the transaction. In case the current value of the requested `feeLevel` is higher than this requested maximum fee. Represented by a numeric string for accurate precision.", + "type": "string", + "example": "120" + }, + "gasLimit": { + "description": "For EVM-based blockchains only. Units of gas required to process the transaction. Note: Only two of the three arguments can be specified in a single transaction: `gasLimit`, `gasPrice` and `networkFee`. Fireblocks recommends using a numeric string for accurate precision. Although a number input exists, it is deprecated.", + "oneOf": [ + { + "type": "string", + "description": "Numeric string (recommended)", + "example": "21000" + }, + { + "type": "number", + "description": "Number (deprecated)", + "example": 21000 + } + ] + }, + "gasPrice": { + "description": "For non-EIP-1559, EVM-based transactions. Price per gas unit (in Ethereum this is specified in Gwei). Note: Only two of the three arguments can be specified in a single transaction: `gasLimit`, `gasPrice` and `networkFee`. Fireblocks recommends using a numeric string for accurate precision. Although a number input exists, it is deprecated.", + "oneOf": [ + { + "type": "string", + "description": "Numeric string (recommended)" + }, + { + "type": "number", + "description": "Number (deprecated)" + } + ] + }, + "networkFee": { + "description": "For EVM-based blockchains only. The total transaction fee in the blockchainโ€™s largest unit. Note: Only two of the three arguments can be specified in a single transaction: `gasLimit`, `gasPrice` and `networkFee`. Fireblocks recommends using a numeric string for accurate precision. Although a number input exists, it is deprecated. - The transaction blockchain fee.\n- For Ethereum, you can't pass gasPrice, gasLimit and networkFee all together.\n- A numeric value representation is required.", + "oneOf": [ + { + "type": "string", + "description": "Numeric string (recommended)" + }, + { + "type": "number", + "description": "Number (deprecated)" + } + ] + }, + "replaceTxByHash": { + "type": "string", + "description": "For EVM-based blockchains only. In case a transaction is stuck, specify the hash of the stuck transaction to replace it by this transaction with a higher fee, or to replace it with this transaction with a zero fee and drop it from the blockchain.", + "example": "00000000-0000-0000-0000-000000000000" + }, + "extraParameters": { + "$ref": "#/components/schemas/ExtraParameters" + }, + "customerRefId": { + "type": "string", + "description": "The ID for AML providers to associate the owner of funds with transactions.", + "example": "abcdef" + }, + "autoStaking": { + "type": "boolean", + "description": "This feature is no longer supported.", + "deprecated": true + }, + "networkStaking": { + "deprecated": true, + "description": "This feature is no longer supported.", + "oneOf": [ + { + "type": "string", + "description": "Numeric string (recommended)" + }, + { + "type": "number", + "description": "Number (deprecated)" + } + ] + }, + "cpuStaking": { + "deprecated": true, + "description": "This feature is no longer supported.", + "oneOf": [ + { + "type": "string", + "description": "Numeric string (recommended)" + }, + { + "type": "number", + "description": "Number (deprecated)" + } + ] + } + } + }, + "TransactionRequestDestination": { + "type": "object", + "properties": { + "amount": { + "type": "string" + }, + "destination": { + "$ref": "#/components/schemas/DestinationTransferPeerPath" + } + } + }, + "ExchangeType": { + "type": "string", + "enum": [ + "BINANCE", + "BINANCEUS", + "BITFINEX", + "BITHUMB", + "BITMEX", + "BITSO", + "BITSTAMP", + "BITTREX", + "CIRCLE", + "COINBASEPRO", + "COINMETRO", + "COINSPRO", + "CRYPTOCOM", + "DERIBIT", + "FTX", + "FIXUS", + "GEMINI", + "HITBTC", + "HUOBI", + "KORBIT", + "KRAKEN", + "LIQUID", + "POLONIEX", + "OKCOIN", + "OKEX", + "SEEDCX" + ] + }, + "FiatAccountType": { + "type": "string", + "enum": [ + "BLINC" + ] + }, + "ConfigChangeRequestStatus": { + "type": "string", + "enum": [ + "WAITING_FOR_APPROVAL", + "APPROVED", + "CANCELLED", + "REJECTED", + "FAILED" + ] + }, + "TransactionOperation": { + "type": "string", + "default": "TRANSFER", + "enum": [ + "TRANSFER", + "BURN", + "CONTRACT_CALL", + "MINT", + "RAW", + "TYPED_MESSAGE" + ], + "description": "* `TRANSFER` - The default value for an operation. Transfers funds from one account to another. UTXO blockchains allow multi-input and multi-output transfers. All other blockchains allow transfers with one source address and one destination address.\n* `MINT` - Mints new tokens. Supported for Stellar, Ripple and EVM-based blockchains.\n* `BURN` - Burns tokens. Supported for Stellar, Ripple and EVM-based blockchains.\n* `CONTRACT_CALL` - Calls a smart contract method for web3 operations on any EVM blockchain. The Fireblocks [development libraries](https://developers.fireblocks.com/docs/ethereum-development#convenience-libraries) are recommended for building contract call transactions.\n* `TYPED_MESSAGE` - An off-chain message in either Ethereum Personal Message or EIP712 format. Use it to sign specific readable messages that are not actual transactions. [Learn more about typed messages](https://developers.fireblocks.com/docs/typed-message-signing).\n* `RAW` - An off-chain message with no predefined format. Use it to sign any message with your private key, including protocols such as blockchains and custom transaction types that are not natively supported by Fireblocks. [Learn more about raw signing transactions.](https://developers.fireblocks.com/docs/raw-message-signing)\n" + }, + "GetTransactionOperation": { + "type": "string", + "enum": [ + "TRANSFER", + "BURN", + "CONTRACT_CALL", + "MINT", + "RAW", + "TYPED_MESSAGE", + "ENABLE_ASSET", + "STAKE", + "UNSTAKE", + "WITHDRAW", + "REDEEM_FROM_COMPOUND", + "SUPPLY_TO_COMPOUND" + ], + "description": "* `TRANSFER` - Transfers funds from one account to another. UTXO blockchains allow multi-input and multi-output transfers. All other blockchains allow transfers with one source address and one destination address.\n* `MINT` - Mints new tokens. Supported for Stellar, Ripple and EVM-based blockchains.\n* `BURN` - Burns tokens. Supported for Stellar, Ripple and EVM-based blockchains.\n* `CONTRACT_CALL` - Calls a smart contract method for web3 operations on any EVM blockchain. The Fireblocks [development libraries](https://developers.fireblocks.com/docs/ethereum-development#convenience-libraries) are recommended for building contract call transactions.\n* `TYPED_MESSAGE` - An off-chain message in either Ethereum Personal Message or EIP712 format. Use it to sign specific readable messages that are not actual transactions. [Learn more about typed messages](https://developers.fireblocks.com/docs/typed-message-signing).\n* `RAW` - An off-chain message with no predefined format. Use it to sign any message with your private key, including protocols such as blockchains and custom transaction types that are not natively supported by Fireblocks. [Learn more about raw signing transactions.](https://developers.fireblocks.com/docs/raw-message-signing)\n* `ENABLE_ASSET` - Algorand, DigitalBits, Solana, and Stellar require an on-chain transaction to create an asset wallet and enable the deposit address. This transaction is automatically created when adding assets on these blockchains at a vault account.\n* `STAKE` - Assign assets to a staking pool managed by a staking validator. Supported for Stellar and EVM-based blockchains. This transaction is automatically created when performing staking operations.\n* `UNSTAKE` - Remove assets from a staking pool managed by a staking validator. Supported for Stellar and EVM-based blockchains. This transaction is automatically created when performing staking operations.\n* `WITHDRAW` - Transfer assets from a dedicated staking vault account to another address. Supported for Stellar and EVM-based blockchains. This transaction is automatically created when performing staking operations.\n\n **Note:** Fireblocks will rename this type from `WITHDRAW` to a different type name soon. There will be a 7-day notice regarding the new type name.\n\n* `SUPPLY_TO_COMPOUND` - Deprecated since April 1st, 2023. Older transactions may have this as their operation, in case users in the workspace have used the direct integration between Fireblocks and the Compound DeFI protocol.\n* `REDEEM_FROM_COMPOUND` - Deprecated since April 1st, 2023. Older transactions may have this as their operation, in case users in the workspace have used the direct integration between Fireblocks and the Compound DeFI protocol.\n" + }, + "Error": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "code": { + "type": "number" + } + } + }, + "Term": { + "type": "object", + "properties": { + "networkConnectionId": { + "type": "string" + }, + "outgoing": { + "type": "boolean" + }, + "asset": { + "type": "string" + }, + "amount": { + "type": "string" + }, + "note": { + "type": "string" + }, + "operation": { + "type": "string" + } + } + }, + "SetConfirmationsThresholdRequest": { + "type": "object", + "properties": { + "numOfConfirmations": { + "type": "number" + } + } + }, + "SetConfirmationsThresholdResponse": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + }, + "transactions": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DropTransactionRequest": { + "type": "object", + "properties": { + "txId": { + "type": "string" + }, + "feeLevel": { + "type": "string" + }, + "gasPrice": { + "type": "string" + } + } + }, + "DropTransactionResponse": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + }, + "transactions": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "UnsignedMessage": { + "type": "object", + "properties": { + "content": { + "type": "string" + }, + "bip44addressIndex": { + "type": "integer" + }, + "bip44change": { + "type": "number" + }, + "derivationPath": { + "type": "array", + "items": { + "type": "number" + } + } + }, + "required": [ + "content" + ] + }, + "SignedMessage": { + "type": "object", + "description": "A list of signed messages returned for raw signing.", + "properties": { + "content": { + "type": "string" + }, + "algorithm": { + "type": "string", + "enum": [ + "MPC_ECDSA_SECP256K1", + "MPC_EDDSA_ED25519" + ] + }, + "derivationPath": { + "type": "array", + "items": { + "type": "number" + } + }, + "signature": { + "type": "object", + "properties": { + "fullSig": { + "type": "string" + }, + "r": { + "type": "string" + }, + "s": { + "type": "string" + }, + "v": { + "type": "number" + } + } + }, + "publicKey": { + "type": "string" + } + } + }, + "PublicKeyInformation": { + "type": "object", + "properties": { + "algorithm": { + "type": "string" + }, + "derivationPath": { + "type": "array", + "items": { + "type": "number" + } + }, + "publicKey": { + "type": "string" + } + } + }, + "TradingAccountType": { + "type": "string", + "enum": [ + "COIN_FUTURES", + "COIN_MARGINED_SWAP", + "EXCHANGE", + "FUNDING", + "FUNDABLE", + "FUTURES", + "FUTURES_CROSS", + "MARGIN", + "MARGIN_CROSS", + "OPTIONS", + "SPOT", + "USDT_MARGINED_SWAP_CROSS", + "USDT_FUTURES", + "UNIFIED" + ] + }, + "ValidateAddressResponse": { + "type": "object", + "properties": { + "isValid": { + "type": "boolean" + }, + "isActive": { + "type": "boolean" + }, + "requiresTag": { + "type": "boolean" + } + } + }, + "ResendWebhooksResponse": { + "type": "object", + "properties": { + "messagesCount": { + "type": "number" + } + } + }, + "UnspentInputsResponse": { + "type": "object", + "properties": { + "input": { + "$ref": "#/components/schemas/UnspentInput" + }, + "address": { + "type": "string" + }, + "amount": { + "type": "string" + }, + "confirmations": { + "type": "number" + }, + "status": { + "type": "string" + } + } + }, + "UnspentInput": { + "type": "object", + "properties": { + "txHash": { + "type": "string" + }, + "index": { + "type": "number" + } + } + }, + "GetUsersResponse": { + "type": "object", + "properties": { + "users": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserResponse" + } + } + } + }, + "ExtraParameters": { + "type": "object", + "properties": {}, + "description": "Additional protocol / operation specific key-value parameters:\n\nFor UTXO-based blockchain input selection, add the key `inputsSelection` with the value set the [input selection structure.](https://developers.fireblocks.com/reference/transaction-objects#inputsselection) The inputs can be retrieved from the [Retrieve Unspent Inputs endpoint.](https://developers.fireblocks.com/reference/get_vault-accounts-vaultaccountid-assetid-unspent-inputs)\n\nFor `RAW` operations, add the key `rawMessageData` with the value set to the [raw message data structure.](https://developers.fireblocks.com/reference/raw-signing-objects#rawmessagedata)\n\nFor `CONTRACT_CALL` operations, add the key `contractCallData` with the value set to the Ethereum smart contract Application Binary Interface (ABI) payload. The Fireblocks [development libraries](https://developers.fireblocks.com/docs/ethereum-development#convenience-libraries) are recommended for building contract call transactions.\n" + }, + "NetworkIdRoutingPolicy": { + "type": "object", + "properties": { + "crypto": { + "oneOf": [ + { + "$ref": "#/components/schemas/CustomCryptoRoutingDest" + }, + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + } + ] + }, + "sen": { + "oneOf": [ + { + "$ref": "#/components/schemas/CustomFiatRoutingDest" + }, + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + } + ] + }, + "signet": { + "oneOf": [ + { + "$ref": "#/components/schemas/CustomFiatRoutingDest" + }, + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + } + ] + }, + "sen_test": { + "oneOf": [ + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + }, + { + "$ref": "#/components/schemas/CustomFiatRoutingDest" + } + ] + }, + "signet_test": { + "oneOf": [ + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + }, + { + "$ref": "#/components/schemas/CustomFiatRoutingDest" + } + ] + } + } + }, + "NetworkConnectionRoutingPolicy": { + "type": "object", + "properties": { + "crypto": { + "oneOf": [ + { + "$ref": "#/components/schemas/CustomCryptoRoutingDest" + }, + { + "$ref": "#/components/schemas/DefaultNetworkRoutingDest" + }, + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + } + ] + }, + "sen": { + "oneOf": [ + { + "$ref": "#/components/schemas/CustomFiatRoutingDest" + }, + { + "$ref": "#/components/schemas/DefaultNetworkRoutingDest" + }, + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + } + ] + }, + "signet": { + "oneOf": [ + { + "$ref": "#/components/schemas/DefaultNetworkRoutingDest" + }, + { + "$ref": "#/components/schemas/CustomFiatRoutingDest" + }, + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + } + ] + }, + "sen_test": { + "oneOf": [ + { + "$ref": "#/components/schemas/DefaultNetworkRoutingDest" + }, + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + }, + { + "$ref": "#/components/schemas/CustomFiatRoutingDest" + } + ] + }, + "signet_test": { + "oneOf": [ + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + }, + { + "$ref": "#/components/schemas/CustomFiatRoutingDest" + }, + { + "$ref": "#/components/schemas/DefaultNetworkRoutingDest" + } + ] + } + } + }, + "CustomFiatRoutingDest": { + "type": "object", + "properties": { + "scheme": { + "description": "The network routing logic.", + "type": "string", + "enum": [ + "CUSTOM" + ] + }, + "dstType": { + "type": "string", + "description": "The fiat account the funds are being sent to.", + "enum": [ + "FIAT_ACCOUNT" + ] + }, + "dstId": { + "type": "string", + "description": "The ID of the fiat account the funds are being sent to." + } + }, + "required": [ + "scheme", + "dstType", + "dstId" + ] + }, + "CustomCryptoRoutingDest": { + "type": "object", + "properties": { + "scheme": { + "type": "string", + "description": "The network routing logic.", + "enum": [ + "CUSTOM" + ] + }, + "dstType": { + "type": "string", + "description": "The type of destination account the funds are being sent to.", + "enum": [ + "VAULT", + "EXCHANGE" + ] + }, + "dstId": { + "type": "string", + "description": "The ID of the destination account the funds are being sent to." + } + }, + "required": [ + "scheme", + "dstType", + "dstId" + ] + }, + "DefaultNetworkRoutingDest": { + "type": "object", + "properties": { + "scheme": { + "type": "string", + "description": "The network routing logic.", + "enum": [ + "DEFAULT" + ] + } + }, + "required": [ + "scheme" + ] + }, + "NoneNetworkRoutingDest": { + "type": "object", + "properties": { + "scheme": { + "type": "string", + "description": "No network routing logic.", + "enum": [ + "NONE" + ] + } + }, + "required": [ + "scheme" + ] + }, + "UserResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "role": { + "type": "string" + }, + "email": { + "type": "string" + }, + "enabled": { + "type": "boolean" + } + } + }, + "SessionMetadata": { + "type": "object", + "properties": { + "appUrl": { + "type": "string" + }, + "appName": { + "type": "string" + }, + "appDescription": { + "type": "string" + }, + "appIcon": { + "type": "string" + } + }, + "required": [ + "appUrl" + ] + }, + "SessionDTO": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Id of the connection", + "example": "4e9e7051-f3b2-48e9-8ee6-b12492552657" + }, + "userId": { + "type": "string", + "description": "Id of the user that created the connection" + }, + "sessionMetadata": { + "description": "Metadata of the connection (provided by the dapp)", + "allOf": [ + { + "$ref": "#/components/schemas/SessionMetadata" + } + ] + }, + "vaultAccountId": { + "type": "number", + "description": "The vault to connect", + "example": 1 + }, + "feeLevel": { + "type": "string", + "description": "The default fee level", + "example": "MEDIUM", + "enum": [ + "MEDIUM", + "HIGH" + ] + }, + "chainIds": { + "description": "The chains approved for the connection", + "example": [ + "ETH", + "ETH_TEST", + "SOL" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "connectionType": { + "type": "string", + "description": "The connection's type", + "example": "WalletConnect", + "enum": [ + "WalletConnect" + ] + }, + "connectionMethod": { + "type": "string", + "description": "The method through which the connection was established", + "example": "API", + "enum": [ + "DESKTOP", + "MOBILE", + "API" + ] + }, + "creationDate": { + "format": "date-time", + "type": "string", + "description": "Timestamp of the session's creation" + } + }, + "required": [ + "id", + "userId", + "sessionMetadata", + "vaultAccountId", + "feeLevel", + "chainIds", + "connectionType", + "connectionMethod", + "creationDate" + ] + }, + "GetConnectionsResponse": { + "type": "object", + "properties": { + "data": { + "description": "Array with the requested Web3 connection's data", + "type": "array", + "items": { + "$ref": "#/components/schemas/SessionDTO" + } + }, + "paging": { + "$ref": "#/components/schemas/Paging" + } + }, + "required": [ + "data" + ] + }, + "CreateConnectionRequest": { + "type": "object", + "properties": { + "vaultAccountId": { + "type": "number", + "description": "The ID of the vault to connect to the Web3 connection.", + "example": 1 + }, + "feeLevel": { + "type": "string", + "description": "The default fee level. Valid values are `MEDIUM` and `HIGH`.", + "example": "MEDIUM", + "enum": [ + "MEDIUM", + "HIGH" + ] + }, + "uri": { + "type": "string", + "description": "The WalletConnect uri provided by the dapp.", + "example": "wc:77752975-906f-48f5-b59f-047826ee947e@1?bridge=https%3A%2F%2F0.bridge.walletconnect.org&key=64be99adc6086b7a729b0ec8c7e1f174927ab92e84f5c6f9527050225344a637" + }, + "chainIds": { + "description": "The ID of the blockchain network used in the Web3 connection.", + "example": [ + "ETH", + "ETH_TEST" + ], + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "vaultAccountId", + "feeLevel", + "uri", + "chainIds" + ] + }, + "CreateConnectionResponse": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the Web3 connection initiated.", + "example": "4e9e7051-f3b2-48e9-8ee6-b12492552657" + }, + "sessionMetadata": { + "description": "Metadata of the Web3 connection (provided by the DApp).", + "allOf": [ + { + "$ref": "#/components/schemas/SessionMetadata" + } + ] + } + }, + "required": [ + "id", + "sessionMetadata" + ] + }, + "RespondToConnectionRequest": { + "type": "object", + "properties": { + "approve": { + "type": "boolean", + "description": "Approval of the initiated Web3 connection.", + "example": true + } + }, + "required": [ + "approve" + ] + }, + "AddCollateralRequestBody": { + "type": "object", + "properties": { + "transactionRequest": { + "$ref": "#/components/schemas/TransactionRequest" + }, + "isSrcCollateral": { + "type": "boolean", + "description": "optional" + } + } + }, + "RemoveCollateralRequestBody": { + "type": "object", + "properties": { + "transactionRequest": { + "$ref": "#/components/schemas/TransactionRequest" + }, + "isDstCollateral": { + "type": "boolean", + "description": "optional" + } + } + }, + "SettlementRequestBody": { + "type": "object", + "properties": { + "mainExchangeAccountId": { + "type": "string" + } + } + }, + "SettlementResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "initiator": { + "type": "string" + }, + "exchangeReply": { + "type": "string" + }, + "fireblocksInitiatedTransactions": { + "type": "object" + }, + "exchangeRequestedTransactions": { + "$ref": "#/components/schemas/SettlementResponse" + } + } + }, + "GetSettlementResponse": { + "$ref": "#/components/schemas/SettlementResponse" + }, + "ToExchangeTransaction": { + "type": "object", + "properties": { + "assetId": { + "type": "string" + }, + "amount": { + "type": "string" + }, + "dstAddress": { + "type": "string" + }, + "dstTag": { + "type": "string", + "description": "optional" + } + } + }, + "ToCollateralTransaction": { + "type": "object", + "properties": { + "asset": { + "type": "string" + }, + "amount": { + "type": "string" + }, + "srcAddress": { + "type": "string" + }, + "srcTag": { + "type": "string", + "description": "optional" + }, + "fee": { + "type": "string", + "description": "optional" + } + } + }, + "XBSettlementConfigCreationRequestBody": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name for the cross-border settlement configuration" + }, + "corridorId": { + "$ref": "#/components/schemas/XBSettlementCorridorId" + }, + "steps": { + "$ref": "#/components/schemas/XBSettlementConfigStepsRecord" + }, + "conversionSlippageBasisPoints": { + "$ref": "#/components/schemas/XBSettlementConversionSlippageBasisPoints" + } + }, + "required": [ + "name", + "corridorId", + "steps" + ] + }, + "XBSettlementConfigCreationResponse": { + "$ref": "#/components/schemas/XBSettlementConfigModel" + }, + "XBSettlementConfigEditRequestBody": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name for the cross-border settlement configuration" + }, + "steps": { + "$ref": "#/components/schemas/XBSettlementConfigStepsRecord" + }, + "conversionSlippageBasisPoints": { + "$ref": "#/components/schemas/XBSettlementConversionSlippageBasisPoints" + } + }, + "required": [ + "name", + "steps" + ] + }, + "XBSettlementConfigEditResponse": { + "$ref": "#/components/schemas/XBSettlementConfigModel" + }, + "XBSettlementConfigDeletionResponse": { + "$ref": "#/components/schemas/XBSettlementConfigModel" + }, + "XBSettlementGetConfigResponse": { + "$ref": "#/components/schemas/XBSettlementConfigModel" + }, + "XBSettlementGetAllConfigsResponse": { + "type": "object", + "properties": { + "configurations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/XBSettlementConfigModel" + } + } + }, + "required": [ + "configurations" + ] + }, + "XBSettlementFlowExecutionRequestBody": { + "type": "object", + "properties": { + "conversionSlippageBasisPoints": { + "$ref": "#/components/schemas/XBSettlementConversionSlippageBasisPoints" + } + } + }, + "XBSettlementFlowExecutionResponse": { + "$ref": "#/components/schemas/XBSettlementFlowExecutionModel" + }, + "XBSettlementFlowExecutionStep": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "A unique id for the step execution" + }, + "accountId": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/XBSettlementFlowExecutionStepStatus" + }, + "inputAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "outputAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "fee": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "startedAt": { + "type": "number", + "description": "The step execution start time in epoch format." + }, + "completedAt": { + "type": "number", + "description": "The step execution end time in epoch format." + }, + "isSignRequired": { + "type": "boolean", + "description": "Whether or not signing is required for executing the step." + } + }, + "required": [ + "id", + "accountId", + "status", + "inputAmount", + "isSignRequired" + ] + }, + "XBSettlementFlowExecutionStepStatus": { + "type": "string", + "enum": [ + "NOT_STARTED", + "PROCESSING", + "COMPLETED", + "FAILED" + ] + }, + "XBSettlementFlowExecutionStatus": { + "type": "string", + "enum": [ + "NOT_LAUNCHED", + "PROCESSING", + "COMPLETED", + "FAILED" + ] + }, + "XBSettlementConfigId": { + "type": "string", + "format": "uuid", + "description": "Cross Bodrder configuraion unique id" + }, + "XBSettlementConfigModel": { + "type": "object", + "properties": { + "configId": { + "$ref": "#/components/schemas/XBSettlementConfigId" + }, + "corridorId": { + "$ref": "#/components/schemas/XBSettlementCorridorId" + }, + "name": { + "type": "string", + "description": "The name for the cross-border ettlement configuration" + }, + "steps": { + "$ref": "#/components/schemas/XBSettlementConfigStepsRecord" + }, + "conversionSlippageBasisPoints": { + "$ref": "#/components/schemas/XBSettlementConversionSlippageBasisPoints" + }, + "createdAt": { + "type": "number", + "description": "The creation time in epoch format." + } + }, + "required": [ + "configId", + "name", + "corridorId", + "steps", + "conversionSlippageBasisPoints", + "createdAt" + ] + }, + "XBSettlementCorridorId": { + "type": "string", + "enum": [ + "MX_US", + "CO_US", + "US_MX", + "US_EU", + "US_UK" + ], + "description": "- MX_US : Mexico (MXN) to USA (USD)\n- CO_US : Colombia (COP) to USA (USD)\n- US_MX : USA (USD) to Mexico (MXN)\n- US_EU : USA (USD) to Europe Union (EUR)\n- US_UK : USA (USD) to United Kingdon (GBP)\n" + }, + "XBSettlementConfigStep": { + "type": "object", + "properties": { + "stepType": { + "$ref": "#/components/schemas/XBSettlementStepType" + }, + "accountId": { + "type": "string" + } + }, + "required": [ + "stepType", + "accountId" + ] + }, + "XBSettlementStepType": { + "type": "string", + "enum": [ + "ON_RAMP", + "VAULT_ACCOUNT", + "OFF_RAMP", + "FIAT_DESTINATION" + ], + "description": "- ON_RAMP : A service that allows for the exchange of fiat currencies for cryptocurrencies. An OnRamp input value will always be fiat and output value crypto asset.\n- VAULT_ACCOUNT : Fireblocks Vault account\n- OFF_RAMP : A service that allows for the exchange of cryptocurrencies for fiat. An OffRamp input value will always be a crypto asset and output value be fiat.\n- FIAT_DESTINATION : Fiat account\n" + }, + "XBSettlementFlowSetupStep": { + "type": "object", + "properties": { + "accountId": { + "type": "string" + }, + "inputAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "outputAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "estimatedFeeAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "estimatedTime": { + "type": "number", + "description": "The estimated time for executing the step." + }, + "isSignRequired": { + "type": "boolean", + "description": "Whether or not signing is required for executing the step." + } + }, + "required": [ + "accountId", + "inputAmount", + "outputAmount", + "estimatedFeeAmount", + "estimatedTime", + "isSignRequired" + ] + }, + "XBSettlementGetFlowResponse": { + "type": "object", + "properties": { + "preview": { + "$ref": "#/components/schemas/XBSettlementFlowPreviewModel" + }, + "execution": { + "$ref": "#/components/schemas/XBSettlementFlowExecutionModel" + } + } + }, + "XBSettlementFlowPreviewModel": { + "type": "object", + "properties": { + "flowId": { + "type": "string", + "description": "The unique id for the cross-border flow." + }, + "configId": { + "$ref": "#/components/schemas/XBSettlementConfigId" + }, + "conversionRate": { + "type": "string", + "description": "The conversion rate received from the on-ramp or off-ramp." + }, + "inputAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "estimatedOutputAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "totalEstimatedFee": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "totalEstimatedTime": { + "type": "number", + "description": "The total *estimated* time for executing the cross-border flow." + }, + "steps": { + "$ref": "#/components/schemas/XBSettlementFlowStepsRecord" + } + }, + "required": [ + "flowId", + "configId", + "steps", + "inputAmount", + "estimatedOutputAmount", + "totalEstimatedFee", + "totalEstimatedTime", + "conversionRate" + ] + }, + "XBSettlementCreateFlowRequestBody": { + "type": "object", + "properties": { + "configId": { + "$ref": "#/components/schemas/XBSettlementConfigId" + }, + "amount": { + "type": "string", + "description": "The amount to transfer in this cross-border flow. The type of asset is defined by the cross-border settlement configuration." + } + }, + "required": [ + "configId", + "amount" + ] + }, + "XBSettlementCreateFlowResponse": { + "$ref": "#/components/schemas/XBSettlementFlowPreviewModel" + }, + "XBSettlementFlowExecutionModel": { + "type": "object", + "properties": { + "flowId": { + "type": "string", + "description": "The unique id for the cross-border flow." + }, + "configId": { + "$ref": "#/components/schemas/XBSettlementConfigId" + }, + "inputAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "outputAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "totalFee": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "initiatedAt": { + "type": "number", + "description": "The time the cross-border flow executed in epoch format." + }, + "initiatedBy": { + "description": "The id of the user which launched the flow", + "type": "string" + }, + "state": { + "$ref": "#/components/schemas/XBSettlementFlowExecutionStatus" + }, + "steps": { + "$ref": "#/components/schemas/XBSettlementFlowStepsExecutionRecord" + }, + "selectedConversionSlippage": { + "type": "object", + "description": "Indicates the selected slippage used during the flow since override logic may have taken place.", + "properties": { + "basisPoints": { + "type": "number" + }, + "reason": { + "$ref": "#/components/schemas/XBSettlementFlowSelectedConversionSlippageReason" + } + }, + "required": [ + "basisPoints", + "reason" + ] + } + }, + "required": [ + "flowId", + "configId", + "steps", + "inputAmount", + "outputAmount", + "totalFee", + "initiatedAt", + "initiatedBy", + "state", + "selectedConversionSlippage" + ] + }, + "XBSettlementFlowSelectedConversionSlippageReason": { + "type": "string", + "enum": [ + "DEFAULT", + "CONFIG", + "FLOW" + ] + }, + "XBSettlementFlowStepsExecutionRecord": { + "type": "object", + "properties": { + "stepType": { + "$ref": "#/components/schemas/XBSettlementStepType" + } + }, + "additionalProperties": { + "$ref": "#/components/schemas/XBSettlementFlowExecutionStep" + } + }, + "XBSettlementConfigStepsRecord": { + "type": "object", + "properties": { + "stepType": { + "$ref": "#/components/schemas/XBSettlementStepType" + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "accountId": { + "type": "string" + }, + "inputAssetId": { + "$ref": "#/components/schemas/XBSettlementAssetID" + }, + "outputAssetId": { + "$ref": "#/components/schemas/XBSettlementAssetID" + } + }, + "required": [ + "accountId" + ] + } + }, + "XBSettlementConversionSlippageBasisPoints": { + "type": "integer", + "minimum": 0, + "maximum": 10000, + "default": 10000, + "description": "Slippage configuarion in basis points, the default value is 10%\n" + }, + "XBSettlementFlowStepsRecord": { + "type": "object", + "properties": { + "stepType": { + "$ref": "#/components/schemas/XBSettlementStepType" + } + }, + "additionalProperties": { + "$ref": "#/components/schemas/XBSettlementFlowSetupStep" + } + }, + "XBSettlementAsset": { + "type": "object", + "properties": { + "amount": { + "type": "string" + }, + "assetId": { + "$ref": "#/components/schemas/XBSettlementAssetID" + } + }, + "required": [ + "amount" + ] + }, + "XBSettlementAssetID": { + "oneOf": [ + { + "$ref": "#/components/schemas/XBSettlementFiatAsset" + }, + { + "$ref": "#/components/schemas/XBSettlementCryptoAsset" + } + ] + }, + "XBSettlementFiatAsset": { + "type": "string", + "enum": [ + "USD", + "MXN", + "COP", + "EUR", + "GBP" + ] + }, + "XBSettlementCryptoAsset": { + "type": "string", + "enum": [ + "XLM_USDC_5F3T", + "XLM" + ], + "description": "- XLM_USDC_5F3T : USDC over Stellar network\n" + }, + "CreatePayoutRequest": { + "type": "object", + "properties": { + "paymentAccount": { + "$ref": "#/components/schemas/PaymentAccount" + }, + "instructionSet": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PayoutInstruction" + } + } + }, + "required": [ + "paymentAccount", + "instructionSet" + ] + }, + "PaymentAccount": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/PaymentAccountType" + } + }, + "required": [ + "id", + "type" + ] + }, + "PayoutInstruction": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "payeeAccount": { + "$ref": "#/components/schemas/PayeeAccount" + }, + "amount": { + "$ref": "#/components/schemas/InstructionAmount" + } + }, + "required": [ + "amount", + "payeeAccount" + ] + }, + "PaymentAccountType": { + "type": "string", + "enum": [ + "VAULT_ACCOUNT", + "EXCHANGE_ACCOUNT", + "FIAT_ACCOUNT" + ] + }, + "PayeeAccount": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/PayeeAccountType" + } + }, + "required": [ + "id", + "type" + ] + }, + "InstructionAmount": { + "type": "object", + "properties": { + "amount": { + "type": "string" + }, + "assetId": { + "type": "string" + } + }, + "required": [ + "amount", + "assetId" + ] + }, + "PayeeAccountType": { + "type": "string", + "enum": [ + "VAULT_ACCOUNT", + "EXCHANGE_ACCOUNT", + "INTERNAL_WALLET", + "EXTERNAL_WALLET", + "NETWORK_CONNECTION", + "FIAT_ACCOUNT" + ], + "description": "- VAULT_ACCOUNT \ta native Fireblocks vault account\n- EXCHANGE_ACCOUNT \ta third-party exchange account\n- INTERNAL_WALLET \ta whitelisted address marked as internal to the workspace/organization\n- EXTERNAL_WALLET\ta whitelisted address marked as external\n- NETWORK_CONNECTION\ta member of the Fireblocks network\n- FIAT_ACCOUNT\ta third-party account of a fiat bank (Signature, BCB, etc)\n" + }, + "PayoutResponse": { + "type": "object", + "properties": { + "payoutId": { + "type": "string" + }, + "paymentAccount": { + "$ref": "#/components/schemas/PaymentAccountResponse" + }, + "createdAt": { + "type": "number" + }, + "state": { + "$ref": "#/components/schemas/PayoutState" + }, + "status": { + "$ref": "#/components/schemas/PayoutStatus" + }, + "reasonOfFailure": { + "type": "string", + "description": "
    \n
  • INSUFFICIENT_BALANCE
    • \n
  • SOURCE_TRANSLATION
    • \n
  • SOURCE_NOT_UNIQUE
    • \n
  • SOURCE_NOT_FOUND
    • \n
  • SOURCE_TYPE_NOT_SUPPORTED
    • \n
  • EMPTY_SOURCE
    • \n
  • DESTINATION_TRANSLATION
    • \n
  • DESTINATION_NOT_UNIQUE
    • \n
  • DESTINATION_NOT_FOUND
    • \n
  • EMPTY_DESTINATION
    • \n
  • PARSING
    • \n
  • UNKNOWN
    • \n
  • FIREBLOCKS_CLIENT
    • \n
  • TRANSACTION_SUBMISSION
    • \n
\n" + }, + "initMethod": { + "$ref": "#/components/schemas/PayoutInitMethod" + }, + "instructionSet": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PayoutInstructionResponse" + } + }, + "reportUrl": { + "type": "string" + } + }, + "required": [ + "payoutId", + "createdAt", + "state", + "status", + "paymentAccount", + "instructionSet" + ] + }, + "PaymentAccountResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/PaymentAccountType" + } + } + }, + "PayoutState": { + "type": "string", + "enum": [ + "CREATED", + "FILE_FOUND", + "REQUESTED", + "TRANSLATED", + "PROCESSING", + "SUBMITTED", + "FINALIZED", + "INSUFFICIENT_BALANCE", + "FAILED" + ], + "description": "- CREATED - payout instruction set created with all its details\n- FILE_FOUND - new file found in the FTP\n- REQUESTED - payout requested with all its details\n- TRANSLATED - payout instruction account IDs identified and translated\n- PROCESSING - payout instruction set executed and is processing\n- SUBMITTED - transactions submitted for payout instructions\n- FINALIZED - payout finished processing, all transactions processed successfully\n- INSUFFICIENT_BALANCE - insufficient balance in the payment account (can be a temporary state)\n- FAILED - one or more of the payout instructions failed\n" + }, + "PayoutStatus": { + "type": "string", + "enum": [ + "REGISTERED", + "VERIFYING", + "IN_PROGRESS", + "DONE", + "INSUFFICIENT_BALANCE", + "FAILED" + ], + "description": "- REQUESTED\tpayout requested with all its details\n- VERIFIED\tpayout instruction set details were verified\n- PROCESSING\tpayout instruction set executed and is processing\n- FINALIZED\tpayout done (all payout instructions completed successfully)\n- INSUFFICIENT_BALANCE\tinsufficient balance in the payment account (can be a temporary state)\n- FAILED\tone or more of the payout instructions failed\n" + }, + "PayoutInitMethod": { + "type": "string", + "enum": [ + "FILE", + "API" + ] + }, + "PayoutInstructionResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "payeeAccount": { + "$ref": "#/components/schemas/PayeeAccountResponse" + }, + "amount": { + "$ref": "#/components/schemas/InstructionAmount" + }, + "state": { + "$ref": "#/components/schemas/PayoutInstructionState" + }, + "transactions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Transaction" + } + } + }, + "required": [ + "amount", + "payeeAccount", + "state", + "transactions" + ] + }, + "PayeeAccountResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/PayeeAccountType" + } + } + }, + "PayoutInstructionState": { + "type": "string", + "enum": [ + "NOT_STARTED", + "TRANSACTION_SENT", + "COMPLETED", + "FAILED", + "TRANSLATION_ERROR", + "SKIPPED" + ], + "description": "- NOT_STARTED\t- waiting to start\n- TRANSACTION_SENT - an underlying transaction was sent\n- COMPLETED\t- completed successfully\n- FAILED - failed\n- TRANSLATION_ERROR -lookup of the destination failed (due to changes in the underlying whitelisted external wallet or similar)\n- SKIPPED- no transaction(s) created for this instruction\n" + }, + "Transaction": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "SUBMITTED", + "QUEUED", + "PENDING_AUTHORIZATION", + "PENDING_SIGNATURE", + "BROADCASTING", + "PENDING_3RD_PARTY_MANUAL_APPROVAL", + "PENDING_3RD_PARTY", + "PENDING", + "CONFIRMING", + "CONFIRMED", + "COMPLETED", + "PARTIALLY_COMPLETED", + "PENDING_AML_SCREENING", + "CANCELLING", + "CANCELLED", + "REJECTED", + "BLOCKED", + "FAILED", + "TIMEOUT" + ] + }, + "timestamp": { + "type": "number", + "format": "date-time" + }, + "instructionId": { + "type": "string" + } + }, + "required": [ + "id", + "state" + ] + }, + "DispatchPayoutResponse": { + "type": "object", + "properties": { + "payoutId": { + "type": "string" + } + }, + "required": [ + "payoutId" + ] + }, + "TravelRuleAddress": { + "type": "object", + "properties": { + "street": { + "type": "string", + "example": "1234 Example St", + "description": "Street address" + }, + "city": { + "type": "string", + "example": "New York", + "description": "City" + }, + "state": { + "type": "string", + "example": "NY", + "description": "State or province" + }, + "postalCode": { + "type": "string", + "example": "10001", + "description": "Postal or ZIP code" + } + }, + "required": [ + "street", + "city", + "state", + "postalCode" + ] + }, + "TravelRuleValidateTransactionRequest": { + "type": "object", + "properties": { + "transactionAsset": { + "type": "string", + "example": "BTC", + "description": "Transaction asset symbol BTC,ETH)" + }, + "destination": { + "type": "string", + "example": "bc1qxy2kgdygjrsqtzq2n0yrf1234p83kkfjhx0wlh", + "description": "Transaction destination address" + }, + "transactionAmount": { + "type": "string", + "example": "10", + "description": "Transaction amount in the transaction asset" + }, + "originatorVASPdid": { + "type": "string", + "example": "did:ethr:0x44957e75d6ce4a5bf37aae117da86422c848f7c2", + "description": "This is the identifier assigned to your VASP" + }, + "originatorEqualsBeneficiary": { + "type": "boolean", + "example": false, + "description": "\"True\" if the originator and beneficiary is the same person and you therefore do not need to collect any information. \"False\" if it is a third-party transfer." + }, + "travelRuleBehavior": { + "type": "boolean", + "example": true, + "description": "This will also check if the transaction is a TRAVEL_RULE in the beneficiary VASP's jurisdiction" + }, + "beneficiaryVASPdid": { + "type": "string", + "example": "did:ethr:0x46a7ed5813ce735387df2bfb245bd7722e0de992", + "description": "This is the identifier assigned to the VASP the funds are being sent to" + }, + "beneficiaryVASPname": { + "type": "string", + "example": "HelloCrypto", + "description": "Beneficiary VASP name" + }, + "beneficiaryName": { + "type": "string", + "example": "John Doe", + "description": "Beneficiary name" + }, + "beneficiaryAccountNumber": { + "type": "string", + "example": "1234-1234-1234-12234", + "description": "Beneficiary name" + }, + "beneficiaryAddress": { + "example": "{\"addressLine: [Wayne Manor, Gotham City, New York, USA]\"}", + "description": "Beneficiary name", + "allOf": [ + { + "$ref": "#/components/schemas/TravelRuleAddress" + } + ] + } + }, + "required": [ + "transactionAsset", + "destination", + "transactionAmount", + "originatorVASPdid", + "originatorEqualsBeneficiary", + "travelRuleBehavior", + "beneficiaryVASPdid", + "beneficiaryVASPname", + "beneficiaryName", + "beneficiaryAccountNumber", + "beneficiaryAddress" + ] + }, + "TravelRuleValidateTransactionResponse": { + "type": "object", + "properties": { + "isValid": { + "type": "boolean", + "description": "\"isValid\" will tell you if you have collected all the information needed for the travel rule data transfer. Once this field = \"true\", you can move on to the next step which is to transfer the front-end information to your back-end and perform Travel Rule Transaction create", + "example": true + }, + "type": { + "type": "string", + "description": "\"type\" will tell you if the virtual asset value converted to FIAT value of the withdrawal request is above (=TRAVELRULE) or below (=BELOW_THRESHOLD) the threshold in your jurisdiction. If it is to an unhosted wallet which does not require travel rule information to be sent and only collected, it will say NON_CUSTODIAL.", + "example": "TRAVELRULE" + }, + "beneficiaryAddressType": { + "type": "string", + "description": "\"beneficiaryAddressType\" will tell you if your blockchain analytics provider or internal address book has been able to identify the wallet address.", + "example": "UNKNOWN" + }, + "addressSource": { + "type": "string", + "description": "\"addressSource\" will tell you if the address was found in your internal address book or identified by the blockchain analytics provider.", + "example": "UNKNOWN" + }, + "beneficiaryVASPdid": { + "type": "string", + "description": "The VASP DID of the beneficiary VASP", + "example": "did:ethr:0x46a7ed5813ce735387df2bfb245bd7722e0de992" + }, + "beneficiaryVASPname": { + "type": "string", + "description": "\"beneficiaryVASPname\" will tell you the name of the VASP that has been identified as the owner of the wallet address. This name is used in a subsequent call to get its DID.", + "example": "Fireblocks" + }, + "warnings": { + "description": "\"errors/warnings\" will tell you what information about the beneficiary you need to collect from the sender.", + "example": [ + "optional-beneficiaryAccountNumber" + ], + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "isValid", + "type", + "beneficiaryAddressType", + "addressSource", + "beneficiaryVASPdid", + "beneficiaryVASPname", + "warnings" + ] + }, + "TravelRuleTransactionBlockchainInfo": { + "type": "object", + "properties": { + "txHash": { + "type": "string" + }, + "origin": { + "type": "string" + }, + "destination": { + "type": "string" + } + }, + "required": [ + "txHash", + "origin", + "destination" + ] + }, + "TravelRulePiiIVMS": { + "type": "object", + "properties": { + "fullName": { + "type": "string" + }, + "dateOfBirth": { + "type": "string" + }, + "placeOfBirth": { + "type": "string" + }, + "address": { + "type": "string" + }, + "identificationNumber": { + "type": "string" + }, + "nationality": { + "type": "string" + }, + "countryOfResidence": { + "type": "string" + }, + "taxIdentificationNumber": { + "type": "string" + }, + "customerNumber": { + "type": "string" + } + }, + "required": [ + "fullName", + "dateOfBirth", + "placeOfBirth", + "address", + "identificationNumber", + "nationality", + "countryOfResidence", + "taxIdentificationNumber", + "customerNumber" + ] + }, + "TravelRuleOwnershipProof": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "passport", + "description": "Type of ownership proof" + }, + "id": { + "type": "string", + "example": "123456789", + "description": "Identification number" + }, + "name": { + "type": "string", + "example": "Alice", + "description": "Name of owner" + }, + "country": { + "type": "string", + "example": "US", + "description": "Country of issuance" + }, + "issueDate": { + "type": "string", + "example": "2022-01-01", + "description": "Date of issuance" + }, + "issuer": { + "type": "string", + "example": "US Government", + "description": "Name of issuing entity" + } + }, + "required": [ + "type", + "id", + "name", + "country", + "issueDate", + "issuer" + ] + }, + "TravelRuleValidateFullTransactionRequest": { + "type": "object", + "properties": { + "transactionAsset": { + "type": "string", + "description": "The asset involved in the transaction" + }, + "transactionAmount": { + "type": "string", + "description": "The amount of the transaction" + }, + "originatorDid": { + "type": "string", + "description": "The DID of the transaction originator" + }, + "beneficiaryDid": { + "type": "string", + "description": "The DID of the transaction beneficiary" + }, + "originatorVASPdid": { + "type": "string", + "description": "The VASP ID of the transaction originator" + }, + "beneficiaryVASPdid": { + "type": "string", + "description": "The VASP ID of the transaction beneficiary" + }, + "beneficiaryVASPname": { + "type": "string", + "description": "The name of the VASP acting as the beneficiary" + }, + "transactionBlockchainInfo": { + "description": "Information about the blockchain transaction", + "allOf": [ + { + "$ref": "#/components/schemas/TravelRuleTransactionBlockchainInfo" + } + ] + }, + "originator": { + "description": "Information about the originator of the transaction", + "allOf": [ + { + "$ref": "#/components/schemas/TravelRulePiiIVMS" + } + ] + }, + "beneficiary": { + "description": "Information about the beneficiary of the transaction", + "allOf": [ + { + "$ref": "#/components/schemas/TravelRulePiiIVMS" + } + ] + }, + "encrypted": { + "type": "string", + "description": "Encrypted data related to the transaction" + }, + "protocol": { + "type": "string", + "description": "The protocol used to perform the travel rule" + }, + "notificationEmail": { + "type": "string", + "description": "The email address where a notification should be sent upon completion of the travel rule" + }, + "skipBeneficiaryDataValidation": { + "type": "boolean", + "description": "Whether to skip validation of beneficiary data" + }, + "travelRuleBehavior": { + "type": "boolean", + "description": "Whether to check if the transaction is a TRAVEL_RULE in the beneficiary VASP's jurisdiction" + }, + "originatorProof": { + "description": "Ownership proof related to the originator of the transaction", + "allOf": [ + { + "$ref": "#/components/schemas/TravelRuleOwnershipProof" + } + ] + }, + "beneficiaryProof": { + "description": "Ownership proof related to the beneficiary of the transaction", + "allOf": [ + { + "$ref": "#/components/schemas/TravelRuleOwnershipProof" + } + ] + }, + "pii": { + "description": "Personal identifiable information related to the transaction", + "allOf": [ + { + "$ref": "#/components/schemas/TravelRulePiiIVMS" + } + ] + } + }, + "required": [ + "transactionAsset", + "transactionAmount", + "originatorDid", + "beneficiaryDid", + "originatorVASPdid", + "beneficiaryVASPdid", + "beneficiaryVASPname", + "transactionBlockchainInfo", + "originator", + "beneficiary", + "encrypted", + "protocol", + "notificationEmail", + "skipBeneficiaryDataValidation", + "travelRuleBehavior", + "originatorProof", + "beneficiaryProof", + "pii" + ] + }, + "TravelRuleIssuer": { + "type": "object", + "properties": { + "issuerDid": { + "type": "string" + } + }, + "required": [ + "issuerDid" + ] + }, + "TravelRuleIssuers": { + "type": "object", + "properties": { + "yearFounded": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "isRegulated": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "regulatoryAuthorities": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "name": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "logo": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "website": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "legalName": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "legalStructure": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "incorporationCountry": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "businessNumber": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "addressLine1": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "city": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "country": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "description": { + "$ref": "#/components/schemas/TravelRuleIssuer" + } + }, + "required": [ + "yearFounded", + "isRegulated", + "regulatoryAuthorities", + "name", + "logo", + "website", + "legalName", + "legalStructure", + "incorporationCountry", + "businessNumber", + "addressLine1", + "city", + "country", + "description" + ] + }, + "TravelRuleVASP": { + "type": "object", + "properties": { + "did": { + "type": "string" + }, + "name": { + "type": "string" + }, + "verificationStatus": { + "type": "string" + }, + "addressLine1": { + "type": "string" + }, + "addressLine2": { + "type": "string" + }, + "city": { + "type": "string" + }, + "country": { + "type": "string" + }, + "emailDomains": { + "type": "string" + }, + "website": { + "type": "string" + }, + "logo": { + "type": "string" + }, + "legalStructure": { + "type": "string" + }, + "legalName": { + "type": "string" + }, + "yearFounded": { + "type": "string" + }, + "incorporationCountry": { + "type": "string" + }, + "isRegulated": { + "type": "string" + }, + "otherNames": { + "type": "string" + }, + "identificationType": { + "type": "string" + }, + "identificationCountry": { + "type": "string" + }, + "businessNumber": { + "type": "string" + }, + "regulatoryAuthorities": { + "type": "string" + }, + "jurisdictions": { + "type": "string" + }, + "street": { + "type": "string" + }, + "number": { + "type": "string" + }, + "unit": { + "type": "string" + }, + "postCode": { + "type": "string" + }, + "state": { + "type": "string" + }, + "certificates": { + "type": "string" + }, + "description": { + "type": "string" + }, + "travelRule_OPENVASP": { + "type": "string" + }, + "travelRule_SYGNA": { + "type": "string" + }, + "travelRule_TRISA": { + "type": "string" + }, + "travelRule_TRLIGHT": { + "type": "string" + }, + "travelRule_EMAIL": { + "type": "string" + }, + "travelRule_TRP": { + "type": "string" + }, + "travelRule_SHYFT": { + "type": "string" + }, + "travelRule_USTRAVELRULEWG": { + "type": "string" + }, + "createdAt": { + "type": "string" + }, + "createdBy": { + "type": "string" + }, + "updatedAt": { + "type": "string" + }, + "updatedBy": { + "type": "string" + }, + "lastSentDate": { + "type": "string" + }, + "lastReceivedDate": { + "type": "string" + }, + "documents": { + "type": "string" + }, + "hasAdmin": { + "type": "boolean" + }, + "isNotifiable": { + "type": "boolean" + }, + "issuers": { + "$ref": "#/components/schemas/TravelRuleIssuers" + } + }, + "required": [ + "did", + "name", + "verificationStatus", + "addressLine1", + "addressLine2", + "city", + "country", + "emailDomains", + "website", + "logo", + "legalStructure", + "legalName", + "yearFounded", + "incorporationCountry", + "isRegulated", + "otherNames", + "identificationType", + "identificationCountry", + "businessNumber", + "regulatoryAuthorities", + "jurisdictions", + "street", + "number", + "unit", + "postCode", + "state", + "certificates", + "description", + "travelRule_OPENVASP", + "travelRule_SYGNA", + "travelRule_TRISA", + "travelRule_TRLIGHT", + "travelRule_EMAIL", + "travelRule_TRP", + "travelRule_SHYFT", + "travelRule_USTRAVELRULEWG", + "createdAt", + "createdBy", + "updatedAt", + "updatedBy", + "lastSentDate", + "lastReceivedDate", + "documents", + "hasAdmin", + "isNotifiable", + "issuers" + ] + }, + "TravelRuleGetAllVASPsResponse": { + "type": "object", + "properties": { + "vasps": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TravelRuleVASP" + } + } + }, + "required": [ + "vasps" + ] + }, + "TravelRuleUpdateVASPDetails": { + "type": "object", + "properties": { + "did": { + "type": "string", + "example": "did:ethr:0x44957e75d6ce4a5bf37aae117da86422c848f7c2", + "description": "The decentralized identifier of the VASP" + }, + "pii_didkey": { + "type": "string", + "example": "did:key:z6Mks5CZRaiooKYhq5TwtXQC1gWhwiZnmiKfFrMnYY62MhYf", + "description": "The PII DID key of the VASP" + } + }, + "required": [ + "did", + "pii_didkey" + ] + }, + "PolicySrcOrDestType": { + "type": "string", + "enum": [ + "EXCHANGE", + "UNMANAGED", + "VAULT", + "NETWORK_CONNECTION", + "COMPOUND", + "FIAT_ACCOUNT", + "ONE_TIME_ADDRESS", + "*" + ], + "description": "* EXCHANGE - A third-party exchange account connected to your workspace\n* UNMANAGED - A unmanaged wallet outside of Fireblocks workspace\n* VAULT - An account in your Fireblocks Vault\n* NETWORK_CONNECTION - A connection in your Fireblocks network\n* COMPOUND - (deprecated) An asset retrieved by using the Compound DeFI protocol\n* FIAT_ACCOUNT - A third-party fiat account connected to your workspace\n* ONE_TIME_ADDRESS - A non-whitelisted asset from your Fireblocks Workspace\n* \"*\" - All types\n" + }, + "PolicySrcOrDestSubType": { + "type": "string", + "enum": [ + "EXTERNAL", + "INTERNAL", + "CONTRACT", + "EXCHANGETEST", + "*" + ], + "description": "* EXTERNAL - A whitelisted wallet assigned as external is typically used for addresses managed by your clients and counterparties\n* INTERNAL - A whitelisted wallet assigned as internal, is typically used for addresses that you control outside of your Fireblocks workspace\n* CONTRACT - A whitelisted wallet assigned as contract is for identifying and managing external smart contracts\n* EXCHANGETEST - Exchanges which operate only on testnet assets\n* \"*\" - All subtypes\n" + }, + "PolicySrcOrDestId": { + "type": "string", + "description": "Defines the account id, options are\n* \"*\" - All accounts\n* Specific account id\n" + }, + "AmountAggregationTimePeriodMethod": { + "type": "string", + "enum": [ + "PER_SINGLE_MATCH", + "ACROSS_ALL_MATCHES" + ], + "description": "* PER_SINGLE_MATCH - Apply the limit to each listed entity\n* ACROSS_ALL_MATCHES - Apply the limit to the sum of all listed entities\n" + }, + "PolicyRule": { + "type": "object", + "description": "Policy rule which is enforced on transactions", + "properties": { + "operator": { + "type": "string", + "description": "(deprecated - replaced by \"operators\") | Defines users who can initiate the type of transaction to which the rule applies. options are * \"*\" - All users are allowed * Specific User id", + "deprecated": true + }, + "operators": { + "type": "object", + "description": "Defines users/groups who can initiate the type of transaction to which the rule applies.", + "properties": { + "wildcard": { + "type": "string", + "enum": [ + "*" + ], + "description": "If used then this property should appear as the only child property\n* \"*\" - All users are allowed\n" + }, + "users": { + "type": "array", + "description": "Set of users ids", + "items": { + "type": "string" + } + }, + "usersGroups": { + "type": "array", + "description": "Set of group ids", + "items": { + "type": "string" + } + }, + "services": { + "type": "array", + "description": "set of services to initiate transactions", + "items": { + "type": "string" + } + } + } + }, + "transactionType": { + "type": "string", + "enum": [ + "TRANSFER", + "CONTRACT_CALL", + "APPROVE", + "MINT", + "BURN", + "SUPPLY", + "REDEEM", + "STAKE", + "RAW", + "TYPED_MESSAGE" + ], + "description": "Defines the type of transaction to which the rule applies.\n * TRANSFER - Default. Transfers funds from one account to another\n * CONTRACT_CALL - Calls a smart contract, mainly for DeFi operations.\n * APPROVE - Allows a smart contract to withdraw from a designated wallet.\n * MINT - Perform a mint operation (increase supply) on a supported token\n * BURN - Perform a burn operation (reduce supply) on a supported token\n * SUPPLY - Use for DeFi to lend assets\n * REDEEM - Use for DeFi to get lending back\n * STAKE - Allows you to allocate and lock certain assets for earning staking rewards.\n * RAW - An off-chain message with no predefined format, use it to sign any message with your private key.\n * TYPED_MESSAGE - An off-chain message type that follows a predefined format, used to sign specific messages that are not actual transactions.\n" + }, + "designatedSigner": { + "type": "string", + "description": "(deprecated - replaced by \"designatedSigners\") Id representing the user who signs transactions that match a specific rule", + "deprecated": true + }, + "designatedSigners": { + "type": "object", + "description": "Set of ids representing the users who signs transactions that match a specific rule", + "properties": { + "users": { + "type": "array", + "description": "Set of users ids", + "items": { + "type": "string" + } + }, + "usersGroups": { + "type": "array", + "description": "Set of group ids", + "items": { + "type": "string" + } + } + } + }, + "type": { + "type": "string", + "description": "Policy rule type", + "enum": [ + "TRANSFER" + ] + }, + "action": { + "type": "string", + "enum": [ + "ALLOW", + "BLOCK", + "2-TIER" + ], + "description": "Defines what occurs when a transaction meets the rule's criteria\n* ALLOW - The transaction goes through and can be signed without requiring additional approvals\n* BLOCK - The transaction is automatically blocked\n* 2-TIER - Only these users or user groups can approve \n If any of them reject the transaction before the required approval threshold is met, the transaction doesn't go through\n The list of entities are set is \"authorizationGroups\" field\n" + }, + "asset": { + "type": "string", + "description": "Defines the type of asset being transacted, options are\n* \"*\" - All assets\n* Specific asset\n" + }, + "srcType": { + "description": "(deprecated - replaced by \"src\") source account type", + "deprecated": true, + "allOf": [ + { + "$ref": "#/components/schemas/PolicySrcOrDestType" + } + ] + }, + "srcSubType": { + "description": "(deprecated - replaced by \"src\") source sub account type", + "deprecated": true, + "allOf": [ + { + "$ref": "#/components/schemas/PolicySrcOrDestSubType" + } + ] + }, + "srcId": { + "description": "(deprecated - replaced by \"src\") source account id", + "deprecated": true, + "allOf": [ + { + "$ref": "#/components/schemas/PolicySrcOrDestId" + } + ] + }, + "src": { + "type": "object", + "description": "Defines source accounts the rule allows transfers to originate from", + "properties": { + "ids": { + "type": "array", + "description": "A set of ids", + "items": { + "type": "array", + "description": "A set of ids in a tuple format", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/PolicySrcOrDestId" + }, + { + "$ref": "#/components/schemas/PolicySrcOrDestType" + }, + { + "$ref": "#/components/schemas/PolicySrcOrDestSubType" + } + ] + }, + "minItems": 1, + "maxItems": 3 + } + } + } + }, + "dstType": { + "description": "(deprecated - replaced by \"dst\") destination account type", + "deprecated": true, + "allOf": [ + { + "$ref": "#/components/schemas/PolicySrcOrDestType" + } + ] + }, + "dstSubType": { + "description": "(deprecated - replaced by \"dst\") destination sub account type", + "deprecated": true, + "allOf": [ + { + "$ref": "#/components/schemas/PolicySrcOrDestSubType" + } + ] + }, + "dstId": { + "description": "(deprecated - replaced by \"dst\") destination account id", + "deprecated": true, + "allOf": [ + { + "$ref": "#/components/schemas/PolicySrcOrDestId" + } + ] + }, + "dst": { + "type": "object", + "description": "Defines the destination accounts the rule allows transfers to", + "properties": { + "ids": { + "type": "array", + "description": "A set of ids", + "items": { + "type": "array", + "description": "A set of ids in a tuple format", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/PolicySrcOrDestId" + }, + { + "$ref": "#/components/schemas/PolicySrcOrDestType" + }, + { + "$ref": "#/components/schemas/PolicySrcOrDestSubType" + } + ] + }, + "minItems": 1, + "maxItems": 3 + } + } + } + }, + "dstAddressType": { + "type": "string", + "enum": [ + "WHITELISTED", + "ONE_TIME", + "*" + ], + "description": "Defines whether the destination to which you are sending funds must be whitelisted, to allow one-time transfers to non-whitelisted external addresses, or both.\nBy default, you can only transfer to an external address after itโ€™s whitelisted.\n * WHITELISTED - Can only be sent to whitelisted addresses.\n * ONE_TIME - Can only be sent to non-whitelisted external addresses.\n * \"*\" - can be sent to whitelisted addresses or non-whitelisted external\n" + }, + "amountCurrency": { + "type": "string", + "enum": [ + "USD", + "EUR", + "NATIVE" + ], + "description": "* USD - Limits the amount of any asset users can transfer based on the USD equivalent of the asset.\n* EUR - Limits the amount of any asset users can transfer based on the EURO equivalent of the asset.\n* NATIVE - Limits the amount of an asset a user can transfer when using a specific asset.\n" + }, + "amountScope": { + "type": "string", + "enum": [ + "SINGLE_TX", + "TIMEFRAME" + ], + "description": "* SINGLE_TX - limit applies to a single transaction\n* TIMEFRAME - limit applies to all transactions within the defined time period\n" + }, + "amount": { + "type": "number", + "description": "Defines the value a transaction must exceed for the rule to apply to it (according to the amountCurrency field)" + }, + "periodSec": { + "type": "number", + "description": "Time period in seconds applied by the amountScope field to accumulate transferred amounts in transactions that match the rule, until the total exceeds the value you specify under Minimum.\nWhen the specified amount is reached within that period, whether by one or many transactions, further transactions in that period either fail or require more approvals.\n" + }, + "authorizers": { + "type": "array", + "description": "(deprecated - replaced by \"authorizationGroups\") Allowed entities which can approves a transaction", + "deprecated": true, + "items": { + "type": "string" + } + }, + "authorizersCount": { + "type": "number", + "description": "(deprecated - replaced by \"authorizationGroups\") Min amount of entities which are needed to approve a transaction", + "deprecated": true + }, + "authorizationGroups": { + "type": "object", + "description": "Defines the transaction approval terms", + "properties": { + "logic": { + "type": "string", + "enum": [ + "AND", + "OR" + ], + "description": "* AND - requires approval of all authorization groups\n* OR - requires approval of at least one of the authorization groups\n" + }, + "allowOperatorAsAuthorizer": { + "type": "boolean", + "description": "Defines whether the user who initiates a transaction can approve their own transaction and count toward the approval threshold for their transaction" + }, + "groups": { + "type": "array", + "description": "Groups of entities which can approve the transaction", + "items": { + "type": "object", + "properties": { + "users": { + "type": "array", + "description": "User ids", + "items": { + "type": "string" + } + }, + "usersGroups": { + "type": "array", + "description": "Group ids", + "items": { + "type": "string" + } + }, + "th": { + "type": "number", + "description": "Represents the min amount of entities which are required to approve the transaction, default is 1." + } + } + } + } + } + }, + "amountAggregation": { + "type": "object", + "description": "Defines the method by which the Policy Engine calculates accumulation.\nIt uses the Initiator, Source, and Destination to calculate accumulation toward the value under Minimum, for the time under Time Period.\n", + "properties": { + "operators": { + "$ref": "#/components/schemas/AmountAggregationTimePeriodMethod" + }, + "srcTransferPeers": { + "$ref": "#/components/schemas/AmountAggregationTimePeriodMethod" + }, + "dstTransferPeers": { + "$ref": "#/components/schemas/AmountAggregationTimePeriodMethod" + } + } + }, + "rawMessageSigning": { + "type": "object", + "description": "Raw message signing configuration", + "properties": { + "algorithm": { + "type": "string" + }, + "derivationPath": { + "type": "object", + "properties": { + "path": { + "type": "array", + "items": { + "type": "number" + } + } + } + } + } + }, + "applyForApprove": { + "type": "boolean", + "description": "Applying this rule over APPROVE type transactions (can only be enabled when rule's transaction type is TRANSFER)" + }, + "applyForTypedMessage": { + "type": "boolean", + "description": "Applying this rule over TYPED_MESSAGE type transactions (can only be enabled when rule's transaction type is CONTRACT_CALL)" + }, + "externalDescriptor": { + "type": "string", + "description": "A unique id identifying the rule" + } + }, + "required": [ + "type", + "action", + "asset", + "amountCurrency", + "amountScope", + "amount", + "periodSec", + "externalDescriptor" + ] + }, + "PublishResult": { + "type": "object", + "description": "Response object of the publish policy operation", + "properties": { + "status": { + "$ref": "#/components/schemas/PolicyStatus" + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicyRule" + } + }, + "checkResult": { + "$ref": "#/components/schemas/PolicyCheckResult" + }, + "metadata": { + "$ref": "#/components/schemas/PolicyMetadata" + } + }, + "required": [ + "status", + "rules", + "checkResult", + "metadata" + ] + }, + "PolicyStatus": { + "type": "string", + "enum": [ + "SUCCESS", + "UNVALIDATED", + "INVALID_CONFIGURATION", + "PENDING", + "PENDING_CONSOLE_APPROVAL", + "AWAITING_QUORUM", + "UNHANDLED_ERROR" + ], + "description": "* SUCCESS - success\n* UNVALIDATED - not validated yet\n* INVALID_CONFIGURATION - at least one rule is invalid\n* PENDING - pending approval\n* PENDING_CONSOLE_APPROVAL - pending approval from the console app\n* AWAITING_QUORUM - pending quorum approval\n* UNHANDLED_ERROR - unhandled error\n" + }, + "PolicyMetadata": { + "type": "object", + "description": "Policy related metadata", + "properties": { + "editedBy": { + "type": "string", + "description": "The user id of the user who last edited the policy" + }, + "editedAt": { + "type": "string", + "description": "The timestamp of the last edit of the policy" + }, + "publishedBy": { + "type": "string", + "description": "The user id of the user who last published the policy" + }, + "publishedAt": { + "type": "string", + "description": "The timestamp of the last publish of the policy" + } + } + }, + "PolicyCheckResult": { + "type": "object", + "description": "Policy rules validation result", + "properties": { + "errors": { + "type": "number", + "description": "Number of errors" + }, + "result": { + "type": "array", + "description": "A set of validation results", + "items": { + "$ref": "#/components/schemas/PolicyRuleCheckResult" + } + } + }, + "required": [ + "errors", + "result" + ] + }, + "PolicyRuleCheckResult": { + "type": "object", + "description": "The rule validation result", + "properties": { + "index": { + "type": "number", + "description": "Rule index number in the policy" + }, + "status": { + "type": "string", + "description": "Validation status", + "enum": [ + "ok", + "failure" + ] + }, + "errors": { + "type": "array", + "description": "A set of rule validation error objects", + "items": { + "$ref": "#/components/schemas/PolicyRuleError" + } + } + }, + "required": [ + "index", + "status", + "errors" + ] + }, + "PolicyRuleError": { + "type": "object", + "description": "Rule validation result error", + "properties": { + "errorMessage": { + "type": "string", + "description": "Error message" + }, + "errorCode": { + "type": "number", + "description": "error code" + }, + "errorCodeName": { + "type": "string", + "description": "error code name" + }, + "errorField": { + "type": "string", + "enum": [ + "operator", + "operators", + "authorizationGroups", + "designatedSigner", + "designatedSigners", + "contractMethods", + "amountAggregation", + "src", + "dst" + ], + "description": "The field which the error relates to\n* operator - transaction initiator\n* operators - transaction initiators\n* authorizationGroups - transaction authorizer groups\n* designatedSigner - transaction signer\n* designatedSigners - transaction signers\n* contractMethods - contract methods\n* amountAggregation - transaction amount aggregation configuration\n* src - transaction source asset configuration\n* dst - transaction destination asset configuration\n" + } + }, + "required": [ + "errorMessage", + "errorCode", + "errorCodeName", + "errorField" + ] + }, + "DraftReviewAndValidationResponse": { + "type": "object", + "description": "Draft validation", + "properties": { + "draftResponse": { + "$ref": "#/components/schemas/DraftResponse" + }, + "validation": { + "$ref": "#/components/schemas/PolicyValidation" + } + }, + "required": [ + "draftResponse", + "validation" + ] + }, + "PolicyAndValidationResponse": { + "type": "object", + "description": "Policy validation", + "properties": { + "policy": { + "$ref": "#/components/schemas/PolicyResponse" + }, + "validation": { + "$ref": "#/components/schemas/PolicyValidation" + } + }, + "required": [ + "policy", + "validation" + ] + }, + "DraftResponse": { + "type": "object", + "description": "Response object for draft operations", + "properties": { + "status": { + "type": "string", + "description": "Operation status" + }, + "rules": { + "type": "array", + "description": "Draft rules", + "items": { + "$ref": "#/components/schemas/PolicyRule" + } + }, + "draftId": { + "type": "string", + "description": "Draft unique id" + }, + "metadata": { + "$ref": "#/components/schemas/PolicyMetadata" + } + }, + "required": [ + "draftId", + "status", + "rules", + "metadata" + ] + }, + "PolicyResponse": { + "type": "object", + "description": "Response object for policy operations", + "properties": { + "rules": { + "type": "array", + "description": "A set of policy rules", + "items": { + "$ref": "#/components/schemas/PolicyRule" + } + }, + "metadata": { + "$ref": "#/components/schemas/PolicyMetadata" + } + }, + "required": [ + "rules", + "metadata" + ] + }, + "PolicyValidation": { + "type": "object", + "description": "Policy validation object", + "properties": { + "status": { + "type": "string", + "description": "Validation status" + }, + "checkResult": { + "$ref": "#/components/schemas/PolicyCheckResult" + } + }, + "required": [ + "status", + "checkResult" + ] + }, + "ErrorResponse": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "INTERNAL", + "AUTHENTICATION", + "AUTHORIZATION", + "VALIDATION", + "NOT_FOUND", + "UNPROCESSABLE_ENTITY", + "FORBIDDEN" + ] + }, + "message": { + "type": "string" + } + }, + "required": [ + "type", + "message" + ] + } + }, + "required": [ + "error" + ] + } + } + } +} \ No newline at end of file diff --git a/assets/input/iamport.swagger.json b/assets/input/iamport.swagger.json new file mode 100644 index 0000000..d4459b7 --- /dev/null +++ b/assets/input/iamport.swagger.json @@ -0,0 +1,4535 @@ +{ + "openapi": "3.0.1", + "servers": [ + { + "url": "http://localhost:10851", + "description": "fake" + }, + { + "url": "https://api.iamport.kr", + "description": "real" + } + ], + "info": { + "title": "Iamport API", + "description": "Built by [fake-iamport-server](https://github.com/samchon/fake-iamport-server) with [nestia](https://github.com/samchon/nestia)", + "version": "2.0.1", + "license": { + "name": "MIT" + } + }, + "paths": { + "/certifications/{imp_uid}": { + "get": { + "tags": [], + "parameters": [ + { + "name": "imp_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "๋Œ€์ƒ ๋ณธ์ธ์ธ์ฆ ์ •๋ณด์˜ ", + "required": true + } + ], + "responses": { + "200": { + "description": "๋ณธ์ธ์ธ์ฆ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportCertification_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "๋ณธ์ธ์ธ์ฆ ์ •๋ณด ์—ด๋žŒํ•˜๊ธฐ", + "description": "๋ณธ์ธ์ธ์ฆ ์ •๋ณด ์—ด๋žŒํ•˜๊ธฐ.\n\n`certiciations.at` ์€ ๋ณธ์ธ์ธ์ฆ ์ •๋ณด๋ฅผ ์—ด๋žŒํ•  ๋•Œ ์‚ฌ์šฉํ•˜๋Š” API ํ•จ์ˆ˜์ด๋‹ค.\n\n๋‹ค๋งŒ ์ด API ํ•จ์ˆ˜๋ฅผ ํ†ตํ•˜์—ฌ ์—ด๋žŒํ•œ ๋ณธ์ธ์ธ์ฆ ์ •๋ณด {@link IIamportCertification } ์ด\n๊ณง OTP ์ธ์ฆ๊นŒ์ง€ ๋งˆ์ณ ๋ณธ์ธ์ธ์ฆ์„ ๋ชจ๋‘ ๋งˆ์นœ ๋ ˆ์ฝ”๋“œ๋ผ๋Š” ๋ณด์žฅ์€ ์—†๋‹ค. ๋ณธ์ธ์ธ์ฆ์˜ ์™„๊ฒฐ\n์—ฌ๋ถ€๋Š” ์˜ค์ง, {@link IIamportCertification.certified } ๊ฐ’์„ ์ง์ ‘ ๊ฒ€์‚ฌํ•ด๋ด์•ผ๋งŒ ์•Œ\n์ˆ˜ ์žˆ๊ธฐ ๋•Œ๋ฌธ์ด๋‹ค.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "certifications.at", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "imp_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋Œ€์ƒ ๋ณธ์ธ์ธ์ฆ ์ •๋ณด์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "IIamportCertification.imp_uid", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-iamport-server/src/api/structures/IIamportCertification.ts", + "textSpan": { + "start": 488, + "length": 16 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๋ณธ์ธ์ธ์ฆ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "GET" + }, + "delete": { + "tags": [], + "parameters": [ + { + "name": "imp_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "๋Œ€์ƒ ๋ณธ์ธ์ธ์ฆ ์ •๋ณด์˜ ", + "required": true + } + ], + "responses": { + "200": { + "description": "์‚ญ์ œ๋œ ๋ณธ์ธ์ธ์ฆ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportCertification_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "๋ณธ์ธ์ธ์ฆ ์ •๋ณด ์‚ญ์ œํ•˜๊ธฐ", + "description": "๋ณธ์ธ์ธ์ฆ ์ •๋ณด ์‚ญ์ œํ•˜๊ธฐ.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "certifications.erase", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "imp_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋Œ€์ƒ ๋ณธ์ธ์ธ์ฆ ์ •๋ณด์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "IIamportCertification.imp_uid", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-iamport-server/src/api/structures/IIamportCertification.ts", + "textSpan": { + "start": 488, + "length": 16 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์‚ญ์ œ๋œ ๋ณธ์ธ์ธ์ฆ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "DELETE" + } + }, + "/certifications/otp/request": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "๋ณธ์ธ์ธ์ฆ ์š”์ฒญ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportCertification.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "์ง„ํ–‰ ์ค‘์ธ ๋ณธ์ธ์ธ์ฆ์˜ ์‹๋ณ„์ž ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportCertification.IAccessor_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "๋ณธ์ธ์ธ์ฆ ์š”์ฒญํ•˜๊ธฐ", + "description": "๋ณธ์ธ์ธ์ฆ ์š”์ฒญํ•˜๊ธฐ.\n\n`certifications.otp.request` ๋Š” ์•„์ž„ํฌํŠธ ์„œ๋ฒ„์— ๋ณธ์ธ์ธ์ฆ์„ ์š”์ฒญํ•˜๋Š” API ํ•จ์ˆ˜์ด๋‹ค.\n์ด API ๋ฅผ ํ˜ธ์ถœํ•˜๋ฉด ๋ณธ์ธ์ธ์ฆ ๋Œ€์ƒ์ž์˜ ํ•ธ๋“œํฐ์œผ๋กœ OTP ๋ฌธ์ž๊ฐ€ ์ „์†ก๋˜๋ฉฐ, ๋ณธ์ธ์ธ์ฆ\n๋Œ€์ƒ์ž๊ฐ€ {@link certifications.otp.confirm } ์„ ํ†ตํ•˜์—ฌ ์ด OTP ๋ฒˆํ˜ธ๋ฅผ ์ •ํ™•ํžˆ\n์ž…๋ ฅํ•จ์œผ๋กœ์จ, ๋ณธ์ธ์ธ์ฆ์ด ์™„๊ฒฐ๋œ๋‹ค.\n\n๋˜ํ•œ ๋ณธ์ธ์ธ์ฆ ๋Œ€์ƒ์ž๊ฐ€ ์ž์‹ ์˜ ํ•ธ๋“œํฐ์œผ๋กœ ์ „์†ก๋œ OTP ๋ฌธ์ž๋ฅผ ์ž…๋ ฅํ•˜๊ธฐ ์ „์—๋„,\n์—ฌ์ „ํžˆํ•ด๋‹น ๋ณธ์ธ์ธ์ฆ ๋‚ด์—ญ์€ {@link certifications.at } ํ•จ์ˆ˜๋ฅผ ํ†ตํ•˜์—ฌ ์กฐํšŒํ•  ์ˆ˜ ์žˆ๋‹ค.\n๋‹ค๋งŒ, ์ด ๋•Œ ๋ฆฌํ„ด๋˜๋Š” {@link IIamportCertification } ์—์„œ ์ธ์ฆ์˜ ์™„๊ฒฐ ์—ฌ๋ถ€๋ฅผ\n์ง€์นญํ•˜๋Š” {@link IIamportCertification.certified } ๊ฐ’์€ `false` ์ด๋‹ค.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "certifications.otp.request.request", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋ณธ์ธ์ธ์ฆ ์š”์ฒญ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์ง„ํ–‰ ์ค‘์ธ ๋ณธ์ธ์ธ์ฆ์˜ ์‹๋ณ„์ž ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/certifications/otp/confirm/{imp_uid}": { + "post": { + "tags": [], + "parameters": [ + { + "name": "imp_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "๋Œ€์ƒ ๋ณธ์ธ์ธ์ฆ ์ •๋ณด์˜ ", + "required": true + } + ], + "requestBody": { + "description": "OTP ์ฝ”๋“œ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportCertification.IConfirm" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "์ธ์ฆ ์™„๋ฃŒ๋œ ๋ณธ์ธ์ธ์ฆ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportCertification_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "๋ณธ์ธ์ธ์ฆ ์‹œ ๋ฐœ๊ธ‰๋œ OTP ์ฝ”๋“œ ์ž…๋ ฅํ•˜๊ธฐ", + "description": "๋ณธ์ธ์ธ์ฆ ์‹œ ๋ฐœ๊ธ‰๋œ OTP ์ฝ”๋“œ ์ž…๋ ฅํ•˜๊ธฐ.\n\n`certifications.otp.confirm` ๋Š” {@link certifications.otp.request } ๋ฅผ ํ†ตํ•˜์—ฌ\n๋ฐœ๊ธ‰๋œ ๋ณธ์ธ์ธ์ฆ ๊ฑด์— ๋Œ€ํ•˜์—ฌ, ๋ณธ์ธ์ธ์ฆ ๋Œ€์ƒ์ž์˜ ํœด๋Œ€ํฐ์œผ๋กœ ์ „์†ก๋œ OTP ๋ฒˆํ˜ธ๋ฅผ\n๊ฒ€์ฆํ•˜๊ณ , ์ž…๋ ฅํ•œ OTP ๋ฒˆํ˜ธ๊ฐ€ ๋งž๊ฑฐ๋“  ํ•ด๋‹น ๋ณธ์ธ์ธ์ฆ ๊ฑด์„ ์Šน์ธํ•˜์—ฌ ์™„๋ฃŒ ์ฒ˜๋ฆฌํ•ด์ฃผ๋Š”\nAPI ํ•จ์ˆ˜์ด๋‹ค.\n\n์ด์ฒ˜๋Ÿผ ๋ณธ์ธ์ธ์ฆ์„ ์™„๋ฃŒํ•˜๊ฑฐ๋“ , ํ•ด๋‹น ๋ณธ์ธ์ธ์ฆ ๊ฑด {@link IIamportCertification } ์˜\n{@link IIamportCertification.certified } ๊ฐ’์ด ๋น„๋กœ์†Œ `true` ๋กœ ๋ณ€๊ฒฝ๋˜์–ด,\n๋น„๋กœ์†Œ ์™„๊ฒฐ๋œ๋‹ค.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "certifications.otp.confirm.confirm", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "imp_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋Œ€์ƒ ๋ณธ์ธ์ธ์ฆ ์ •๋ณด์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "IIamportCertification.imp_uid", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-iamport-server/src/api/structures/IIamportCertification.ts", + "textSpan": { + "start": 488, + "length": 16 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "OTP ์ฝ”๋“œ", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์ธ์ฆ ์™„๋ฃŒ๋œ ๋ณธ์ธ์ธ์ฆ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/internal/webhook": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "์›นํ›… ์ด๋ฒคํŠธ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportPayment.IWebhook" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "", + "x-nestia-encrypted": false + } + }, + "summary": "์›นํ›… ์ด๋ฒคํŠธ ๋”๋ฏธ ๋ฆฌ์Šค๋„ˆ", + "description": "์›นํ›… ์ด๋ฒคํŠธ ๋”๋ฏธ ๋ฆฌ์Šค๋„ˆ.\n\n`internal.webhook` ์€ ์‹ค์ œ ์•„์ž„ํฌํŠธ์˜ ์„œ๋ฒ„์—๋Š” ์กด์žฌํ•˜์ง€ ์•Š๋Š” API ๋กœ์จ,\n`fake-impoart-server` ์˜ {@link Configuration.WEBHOOK_URL } ์— ์•„๋ฌด๋Ÿฐ URL ์„ ์„ค์ •ํ•˜์ง€\n์•Š์œผ๋ฉด, `fake-iamport-server` ๋กœ๋ถ€ํ„ฐ ๋ฐœ์ƒํ•˜๋Š” ๋ชจ๋“  ์ข…๋ฅ˜์˜ ์›นํ›… ์ด๋ฒคํŠธ๋Š” ์ด ๊ณณ์œผ๋กœ ์ „๋‹ฌ๋˜์–ด\n๋ฌด์˜๋ฏธํ•˜๊ฒŒ ์‚ฌ๋ผ์ง„๋‹ค.\n\n๋”ฐ๋ผ์„œ `fake-iamport-server` ๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ์•„์ž„ํฌํŠธ ์„œ๋ฒ„์™€์˜ ์—ฐ๋™์„ ๋ฏธ๋ฆฌ ๊ฒ€์ฆ์ฝ”์ž ํ•  ๋•Œ๋Š”,\n๋ฐ˜๋“œ์‹œ {@link Configuration.WEBHOOK_URL } ๋ฅผ ์„ค์ •ํ•˜์—ฌ ์›นํ›… ์ด๋ฒคํŠธ๊ฐ€ ๊ท€ํ•˜์˜ ๋ฐฑ์—”๋“œ ์„œ๋ฒ„๋กœ\n์ œ๋Œ€๋กœ ์ „๋‹ฌ๋˜๋„๋ก ํ•˜์ž.", + "x-nestia-namespace": "internal.webhook.webhook", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์›นํ›… ์ด๋ฒคํŠธ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/internal/deposit/{imp_uid}": { + "get": { + "tags": [], + "parameters": [ + { + "name": "imp_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "๋Œ€์ƒ ๊ฒฐ์ œ์˜ ", + "required": true + } + ], + "responses": { + "200": { + "description": "", + "x-nestia-encrypted": false + } + }, + "summary": "๊ฐ€์ƒ ๊ณ„์ขŒ์— ์ž…๊ธˆํ•˜๊ธฐ", + "description": "๊ฐ€์ƒ ๊ณ„์ขŒ์— ์ž…๊ธˆํ•˜๊ธฐ.\n\n`internal.deposit` ์€ ์‹ค์ œ ์•„์ž„ํฌํŠธ ๊ฒฐ์ œ ์„œ๋ฒ„์—๋Š” ์กด์žฌํ•˜์ง€ ์•Š๋Š” API ๋กœ์จ, ๊ฐ€์ƒ ๊ณ„์ขŒ\n๊ฒฐ์ œ๋ฅผ ์‹ ์ฒญํ•œ ๊ณ ๊ฐ์ด, ์ดํ›„ ๊ฐ€์ƒ ๊ณ„์ขŒ์— ๋ชฉํ‘œ ๊ธˆ์•ก์„ ์ž…๊ธˆํ•˜๋Š” ์ƒํ™ฉ์„ ์‹œ๋ฎฌ๋ ˆ์ด์…˜ ํ•  ์ˆ˜ ์žˆ๋Š”\nํ•จ์ˆ˜์ด๋‹ค.\n\n์ฆ‰, `internal.deposit` ๋Š” ๊ณ ๊ฐ์ด ์Šค์Šค๋กœ์—๊ฒŒ ๊ฐ€์ƒ์œผ๋กœ ๋ฐœ๊ธ‰๋œ ๊ณ„์ขŒ์— ์ž…๊ธˆ์„ ํ•˜๊ณ , ๊ทธ์— ๋”ฐ๋ผ\n์•„์ž„ํฌํŠธ ์„œ๋ฒ„์—์„œ webhook ์ด๋ฒคํŠธ๊ฐ€ ๋ฐœ์ƒ, ์ด๋ฅผ ๊ท€ํ•˜์˜ ๋ฐฑ์—”๋“œ ์„œ๋ฒ„๋กœ ์ „์†กํ•˜๋Š” ์ผ๋ จ์˜ ์ƒํ™ฉ์„\n์‹œ๋ฎฌ๋ ˆ์ด์…˜ํ•˜๊ธฐ ์œ„ํ•˜์—ฌ ์„ค๊ณ„๋œ ํ…Œ์ŠคํŠธ ํ•จ์ˆ˜๋‹ค.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "internal.deposit.deposit", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "imp_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋Œ€์ƒ ๊ฒฐ์ œ์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "IIamportVBankPayment.imp_uid ", + "kind": "linkText" + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "GET" + } + }, + "/payments/{imp_uid}": { + "get": { + "tags": [], + "parameters": [ + { + "name": "imp_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "๋Œ€์ƒ ๊ฒฐ์ œ ๊ธฐ๋ก์˜ ", + "required": true + }, + { + "name": "query", + "in": "query", + "schema": { + "$ref": "#/components/schemas/IIamportPayment.IQuery" + }, + "description": "๊ฒฐ์ œ ์ˆ˜๋‹จ์ด ํŽ˜์ดํŒ”์ธ ๊ฒฝ์šฐ์— ์‚ฌ์šฉ", + "required": true + } + ], + "responses": { + "200": { + "description": "๊ฒฐ์ œ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportPayment_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "๊ฒฐ์ œ ๊ธฐ๋ก ์—ด๋žŒํ•˜๊ธฐ", + "description": "๊ฒฐ์ œ ๊ธฐ๋ก ์—ด๋žŒํ•˜๊ธฐ.\n\n์•„์ž„ํฌํŠธ๋ฅผ ํ†ตํ•˜์—ฌ ๋ฐœ์ƒํ•œ ๊ฒฐ์ œ ๊ธฐ๋ก์„ ์—ด๋žŒํ•œ๋‹ค.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "payments.at", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "imp_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋Œ€์ƒ ๊ฒฐ์ œ ๊ธฐ๋ก์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "IIamportPayment.imp_uid", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-iamport-server/src/api/structures/IIamportPayment.ts", + "textSpan": { + "start": 2339, + "length": 16 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "query", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฒฐ์ œ ์ˆ˜๋‹จ์ด ํŽ˜์ดํŒ”์ธ ๊ฒฝ์šฐ์— ์‚ฌ์šฉ", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "GET" + } + }, + "/payments/cancel": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "๊ฒฐ์ œ ์ทจ์†Œ ์ž…๋ ฅ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportPaymentCancel.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "์ทจ์†Œ๋œ ๊ฒฐ์ œ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportPayment_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "๊ฒฐ์ œ ์ทจ์†Œํ•˜๊ธฐ", + "description": "๊ฒฐ์ œ ์ทจ์†Œํ•˜๊ธฐ.\n\n๋งŒ์•ฝ ๊ฐ€์ƒ ๊ณ„์ขŒ๋ฅผ ํ†ตํ•œ ๊ฒฐ์ œ์˜€๋‹ค๋ฉด, ๋ฐ˜๋“œ์‹œ ํ™˜๋ถˆ ๊ณ„์ขŒ ์ •๋ณด๋ฅผ ์ž…๋ ฅํ•ด์ค˜์•ผ ํ•œ๋‹ค.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "payments.cancel.cancel", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฒฐ์ œ ์ทจ์†Œ ์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์ทจ์†Œ๋œ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/receipts/{imp_uid}": { + "get": { + "tags": [], + "parameters": [ + { + "name": "imp_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "๊ท€์† ๊ฒฐ์ œ์˜ ", + "required": true + } + ], + "responses": { + "200": { + "description": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportReceipt_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์กฐํšŒํ•˜๊ธฐ", + "description": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์กฐํšŒํ•˜๊ธฐ.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "receipts.at", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "imp_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ท€์† ๊ฒฐ์ œ์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "IIamportPayment.imp_uid", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-iamport-server/src/api/structures/IIamportPayment.ts", + "textSpan": { + "start": 2339, + "length": 16 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "GET" + }, + "post": { + "tags": [], + "parameters": [ + { + "name": "imp_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "๊ท€์† ๊ฒฐ์ œ์˜ ", + "required": true + } + ], + "requestBody": { + "description": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ž…๋ ฅ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportReceipt.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportReceipt_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ๋ฐœํ–‰ํ•˜๊ธฐ", + "description": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ๋ฐœํ–‰ํ•˜๊ธฐ.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "receipts.store", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "imp_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ท€์† ๊ฒฐ์ œ์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "IIamportPayment.imp_uid", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-iamport-server/src/api/structures/IIamportPayment.ts", + "textSpan": { + "start": 2339, + "length": 16 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + }, + "delete": { + "tags": [], + "parameters": [ + { + "name": "imp_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "๊ท€์† ๊ฒฐ์ œ์˜ ", + "required": true + } + ], + "responses": { + "200": { + "description": "์ทจ์†Œ๋œ ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportReceipt_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ทจ์†Œํ•˜๊ธฐ", + "description": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ทจ์†Œํ•˜๊ธฐ.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "receipts.erase", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "imp_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ท€์† ๊ฒฐ์ œ์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "IIamportPayment.imp_uid", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-iamport-server/src/api/structures/IIamportPayment.ts", + "textSpan": { + "start": 2339, + "length": 16 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์ทจ์†Œ๋œ ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "DELETE" + } + }, + "/users/getToken": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "์•„์ž„ํฌํŠธ์˜ API ๋ฐ secret ํ‚ค ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportUser.IAccessor" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "์œ ์ € ์ธ์ฆ ํ† ํฐ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportUser_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "์œ ์ € ์ธ์ฆ ํ† ํฐ ๋ฐœํ–‰ํ•˜๊ธฐ", + "description": "์œ ์ € ์ธ์ฆ ํ† ํฐ ๋ฐœํ–‰ํ•˜๊ธฐ.\n\n์•„์ž„ํฌํŠธ์— ๊ฐ€์ž…ํ•˜์—ฌ ๋ถ€์—ฌ๋ฐ›์€ API ๋ฐ secret ํ‚ค๋ฅผ ํ† ๋Œ€๋กœ, ์œ ์ € ์ธ์ฆ ํ† ํฐ์„ ๋ฐœํ–‰ํ•œ๋‹ค.\n\n๋‹จ, ์•„์ž„ํฌํŠธ๊ฐ€ ๋ฐœ๊ธ‰ํ•ด์ฃผ๋Š” ์œ ์ € ์ธ์ฆ ํ† ํฐ์—๋Š” ์œ ํšจ ์‹œ๊ฐ„ {@link IIamportUser.expired_at }\n์ด ์žˆ์–ด, ํ•ด๋‹น ์‹œ๊ฐ„์ด ์ง€๋‚˜๊ฑฐ๋“  ๊ธฐ ๋ฐœ๊ธ‰ ํ† ํฐ์ด ๋งŒ๋ฃŒ๋˜์–ด ๋” ์ด์ƒ ์“ธ ์ˆ˜ ์—†๊ฒŒ ๋œ๋‹ค. ๋•Œ๋ฌธ์—\n์•„์ž„ํฌํŠธ์˜ ์ด๋Ÿฌํ•œ ์‹œ๊ฐ„ ์ œํ•œ์— ๊ตฌ์• ๋ฐ›์ง€ ์•Š๊ณ  ์ž์œ ๋กœ์ด ์•„์ž„ํฌํŠธ์˜ API ๋ฅผ ์ด์šฉํ•˜๊ณ  ์‹ถ๋‹ค๋ฉด,\n`iamport-server-api` ์—์„œ ์ œ๊ณตํ•ด์ฃผ๋Š” {@link IamportConnector } ๋ฅผ ํ™œ์šฉํ•˜๋„๋ก ํ•˜์ž.", + "x-nestia-namespace": "users.getToken.getToken", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์•„์ž„ํฌํŠธ์˜ API ๋ฐ secret ํ‚ค ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์œ ์ € ์ธ์ฆ ํ† ํฐ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/vbanks": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "๊ฐ€์ƒ ๊ณ„์ขŒ ์ž…๋ ฅ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportVBankPayment.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "๊ฐ€์ƒ ๊ณ„์ขŒ ๊ฒฐ์ œ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportVBankPayment_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "๊ฐ€์ƒ ๊ณ„์ขŒ ๋ฐœ๊ธ‰ํ•˜๊ธฐ", + "description": "๊ฐ€์ƒ ๊ณ„์ขŒ ๋ฐœ๊ธ‰ํ•˜๊ธฐ.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "vbanks.store", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฐ€์ƒ ๊ณ„์ขŒ ์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฐ€์ƒ ๊ณ„์ขŒ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + }, + "put": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "๊ฐ€์ƒ ๊ณ„์ขŒ ํŽธ์ง‘ ์ž…๋ ฅ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportVBankPayment.IUpdate" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ํŽธ์ง‘๋œ ๊ฐ€์ƒ ๊ณ„์ขŒ ๊ฒฐ์ œ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportVBankPayment_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "๊ฐ€์ƒ ๊ณ„์ขŒ ํŽธ์ง‘ํ•˜๊ธฐ", + "description": "๊ฐ€์ƒ ๊ณ„์ขŒ ํŽธ์ง‘ํ•˜๊ธฐ.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "vbanks.update", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฐ€์ƒ ๊ณ„์ขŒ ํŽธ์ง‘ ์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "ํŽธ์ง‘๋œ ๊ฐ€์ƒ ๊ณ„์ขŒ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "PUT" + } + }, + "/subscribe/customers/{customer_uid}": { + "get": { + "tags": [], + "parameters": [ + { + "name": "customer_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "๊ณ ๊ฐ (๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ) ์‹๋ณ„์ž ํ‚ค", + "required": true + } + ], + "responses": { + "200": { + "description": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportSubscription_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ์ •๋ณด ์กฐํšŒํ•˜๊ธฐ", + "description": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ์ •๋ณด ์กฐํšŒํ•˜๊ธฐ.\n\n`subscribe.customers.at` ์€ ๊ณ ๊ฐ์ด {@link store } ๋‚˜ ํ˜น์€ ์•„์ž„ํฌํŠธ๊ฐ€ ์ œ๊ณตํ•˜๋Š”\n๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ๋“ฑ๋ก ์ฐฝ์„ ์ด์šฉํ•˜์—ฌ ์ €์žฅํ•œ ๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ์ •๋ณด๋ฅผ ์กฐํšŒํ•˜๋Š” API\nํ•จ์ˆ˜์ด๋‹ค.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "subscribe.customers.at", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "customer_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ณ ๊ฐ (๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ) ์‹๋ณ„์ž ํ‚ค", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "GET" + }, + "post": { + "tags": [], + "parameters": [ + { + "name": "customer_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "๊ณ ๊ฐ (๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ) ์‹๋ณ„์ž ํ‚ค", + "required": true + } + ], + "requestBody": { + "description": "์นด๋“œ ์ž…๋ ฅ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportSubscription.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportSubscription_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ๋“ฑ๋กํ•˜๊ธฐ", + "description": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ๋“ฑ๋กํ•˜๊ธฐ.\n\n`subscribe.customers.stoer` ๋Š” ๊ณ ๊ฐ์ด ์ž์‹ ์˜ ์นด๋“œ๋ฅผ ์„œ๋ฒ„์— ๋“ฑ๋กํ•ด๋‘๊ณ , ๋งค๋ฒˆ ๊ฒฐ์ œ๊ฐ€\nํ•„์š”ํ•  ๋•Œ๋งˆ๋‹ค ์นด๋“œ ์ •๋ณด๋ฅผ ๋ฐ˜๋ณต ์ž…๋ ฅํ•˜๋Š” ์ผ ์—†์ด, ๊ฐ„ํŽธํ•˜๊ฒŒ ๊ฒฐ์ œ๋ฅผ ์ง„ํ–‰ํ•˜๊ณ ์ž ํ•  ๋•Œ\n์‚ฌ์šฉํ•˜๋Š” API ํ•จ์ˆ˜์ด๋‹ค.\n\n์ฐธ๊ณ ๋กœ `subscribe.customers.store` ๋Š” ํด๋ผ์ด์–ธํŠธ ์–ดํ”Œ๋ฆฌ์ผ€์ด์…˜์ด ์•„์ž„ํฌํŠธ๊ฐ€ ์ œ๊ณตํ•˜๋Š”\n๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ๋“ฑ๋ก ์ฐฝ์„ ์‚ฌ์šฉํ•˜๋Š” ๊ฒฝ์šฐ, ๊ท€ํ•˜์˜ ๋ฐฑ์—”๋“œ ์„œ๋ฒ„๊ฐ€ ์ด๋ฅผ ์‹ค ์„œ๋น„์Šค์—์„œ ํ˜ธ์ถœํ•˜๋Š”\n์ผ์€ ์—†์„ ๊ฒƒ์ด๋‹ค. ๋‹ค๋งŒ, ๊ณ ๊ฐ์ด ๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ๋ฅผ ๋“ฑ๋กํ•˜๋Š” ์ƒํ™ฉ์„ ์‹œ๋ฎฌ๋ ˆ์ด์…˜ํ•˜๊ธฐ ์œ„ํ•˜์—ฌ,\nํ…Œ์ŠคํŠธ ์ž๋™ํ™” ํ”„๋กœ๊ทธ๋žจ ์ˆ˜์ค€์—์„œ ์‚ฌ์šฉ๋  ์ˆ˜๋Š” ์žˆ๋‹ค.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "subscribe.customers.store", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "customer_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ณ ๊ฐ (๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ) ์‹๋ณ„์ž ํ‚ค", + "kind": "text" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์นด๋“œ ์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + }, + "delete": { + "tags": [], + "parameters": [ + { + "name": "customer_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "๊ณ ๊ฐ (๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ) ์‹๋ณ„์ž ํ‚ค", + "required": true + } + ], + "responses": { + "200": { + "description": "์‚ญ์ œ๋œ ๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportSubscription_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ์‚ญ์ œํ•˜๊ธฐ", + "description": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ์‚ญ์ œํ•˜๊ธฐ.\n\n๊ฐ„ํŽธ ๊ฒฐ์ œ๋ฅผ ์œ„ํ•˜์—ฌ ๋“ฑ๋กํ•œ ์นด๋“œ๋ฅผ ์ œ๊ฑฐํ•œ๋‹ค.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "subscribe.customers.erase", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "customer_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ณ ๊ฐ (๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ) ์‹๋ณ„์ž ํ‚ค", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์‚ญ์ œ๋œ ๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "DELETE" + } + }, + "/subscribe/payments/onetime": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "์นด๋“œ ๊ฒฐ์ œ ์‹ ์ฒญ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportSubscription.IOnetime" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "์นด๋“œ ๊ฒฐ์ œ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportCardPayment_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "์นด๋“œ๋กœ ๊ฒฐ์ œํ•˜๊ธฐ, ๋”๋ถˆ์–ด ๊ฐ„ํŽธ ๊ฒฐ์ œ์šฉ์œผ๋กœ ๋“ฑ๋ก ๊ฐ€๋Šฅ", + "description": "์นด๋“œ๋กœ ๊ฒฐ์ œํ•˜๊ธฐ, ๋”๋ถˆ์–ด ๊ฐ„ํŽธ ๊ฒฐ์ œ์šฉ์œผ๋กœ ๋“ฑ๋ก ๊ฐ€๋Šฅ.\n\n`subscribe.payments.onetime` ์€ ์นด๋“œ๋ฅผ ๋งค๊ฐœ๋กœ ํ•œ ๊ฒฐ์ œ๋ฅผ ํ•˜๊ณ ์ž ํ•  ๋•Œ ํ˜ธ์ถœํ•˜๋Š” API\nํ•จ์ˆ˜์ด๋‹ค. ๋”ํ•˜์—ฌ ์ž…๋ ฅ ๊ฐ’์— {@link IIamportSubscription.IOnetime.customer_uid } ๋ฅผ\n๊ธฐ์ž…ํ•˜๋Š” ๊ฒฝ์šฐ, ๊ฒฐ์ œ์— ์‚ฌ์šฉํ•œ ์นด๋“œ๋ฅผ ๊ทธ๋Œ€๋กœ ๊ฐ„ํŽธ ๊ฒฐ์ œ์šฉ ์นด๋“œ\n{@link IIamportSubscription } ๋กœ ๋“ฑ๋กํ•ด๋ฒ„๋ฆฐ๋‹ค.\n\n๋‹ค๋งŒ, ์ •ํžˆ ๊ฐ„ํŽธ ์นด๋“œ ๋“ฑ๋ก๊ณผ ๊ฒฐ์ œ๋ฅผ ๋™์‹œ์— ํ•˜๊ณ  ์‹ถ๋‹ค๋ฉด,\n`subscribe.payments.onetime` ์— {@link IIamportSubscription.IOnetime.customer_uid }\n๋ฅผ ๋”ํ•˜๊ธฐ๋ณด๋‹ค, {@link subscribe.customers.store } ์™€ {@link subscribe.payments.again }\n์„ ๊ฐ๊ฐ ํ˜ธ์ถœํ•˜๋Š” ๊ฒƒ์„ ๊ถŒ์žฅํ•œ๋‹ค. ๊ทธ๊ฒƒ์ด ์˜ˆ์™ธ์ ์ธ ์ƒํ™ฉ์— ๋ณด๋‹ค ์•ˆ์ „ํ•˜๊ฒŒ ๋Œ€์ฒ˜ํ•  ์ˆ˜ ์žˆ๊ธฐ\n๋•Œ๋ฌธ์ด๋‹ค.\n\n๋”ํ•˜์—ฌ `subscribe.payments.onetime` ์€ ํด๋ผ์ด์–ธํŠธ ์–ดํ”Œ๋ฆฌ์ผ€์ด์…˜์ด ์•„์ž„ํฌํŠธ๊ฐ€ ์ œ๊ณตํ•˜๋Š”\n๊ฒฐ์ œ ์ฐฝ์„ ๊ทธ๋Œ€๋กœ ์‚ฌ์šฉํ•˜๋Š” ๊ฒฝ์šฐ, ๊ท€ํ•˜์˜ ๋ฐฑ์—”๋“œ ์„œ๋ฒ„๊ฐ€ ์ด๋ฅผ ์‹ค ์„œ๋น„์Šค์—์„œ ํ˜ธ์ถœํ•˜๋Š” ์ผ์€\n์—†์„ ๊ฒƒ์ด๋‹ค. ๋‹ค๋งŒ, ๊ณ ๊ฐ์ด ์นด๋“œ๋ฅผ ํ†ตํ•˜์—ฌ ๊ฒฐ์ œํ•˜๋Š” ์ƒํ™ฉ์„ ์‹œ๋ฎฌ๋ ˆ์ด์…˜ํ•˜๊ธฐ ์œ„ํ•˜์—ฌ, ํ…Œ์ŠคํŠธ\n์ž๋™ํ™” ํ”„๋กœ๊ทธ๋žจ ์ˆ˜์ค€์—์„œ ์‚ฌ์šฉ๋  ์ˆ˜๋Š” ์žˆ๋‹ค.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "subscribe.payments.onetime.onetime", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์นด๋“œ ๊ฒฐ์ œ ์‹ ์ฒญ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์นด๋“œ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/subscribe/payments/again": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "๋ฏธ๋ฆฌ ๋“ฑ๋กํ•œ ์นด๋“œ๋ฅผ ์ด์šฉํ•œ ๊ฒฐ์ œ ์‹ ์ฒญ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportSubscription.IAgain" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "์นด๋“œ ๊ฒฐ์ œ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportCardPayment_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "๊ฐ„ํŽธ ๊ฒฐ์ œ์— ๋“ฑ๋ก๋œ ์นด๋“œ๋กœ ๊ฒฐ์ œํ•˜๊ธฐ", + "description": "๊ฐ„ํŽธ ๊ฒฐ์ œ์— ๋“ฑ๋ก๋œ ์นด๋“œ๋กœ ๊ฒฐ์ œํ•˜๊ธฐ.\n\n`subscribe.payments.again` ์€ ๊ณ ๊ฐ์ด ๊ฐ„ํŽธ ๊ฒฐ์ œ์— ๋“ฑ๋กํ•œ ์นด๋“œ๋กœ ๊ฒฐ์ œ๋ฅผ ์ง„ํ–‰ํ•˜๊ณ ์ž ํ•  ๋•Œ\nํ˜ธ์ถœํ•˜๋Š” API ํ•จ์ˆ˜์ด๋‹ค. ์ด๋Š” ๊ฐ„ํŽธํ•˜๊ณ  ๋ถˆํŽธํ•˜๊ณ ๋ฅผ ๋– ๋‚˜, ๋ณธ์งˆ์ ์œผ๋กœ ์นด๋“œ ๊ฒฐ์ œ์˜ ์ผํ™˜์ด๊ธฐ์—,\n๋ฆฌํ„ด๊ฐ’์€ ์ผ๋ฐ˜์ ์ธ ์นด๋“œ ๊ฒฐ์ œ ๋•Œ์™€ ๋™์ผํ•œ {@link IIamportCardPayment } ์ด๋‹ค.\n\n๊ทธ๋ฆฌ๊ณ  `subscribe.payments.again` ์€ ๊ฒฐ์ œ ์ˆ˜๋‹จ ์ค‘ ์œ ์ผํ•˜๊ฒŒ, ํด๋ผ์ด์–ธํŠธ ์–ดํ”Œ๋ฆฌ์ผ€์ด์…˜์ด\n์•„์ž„ํฌํŠธ๊ฐ€ ์ œ๊ณตํ•˜๋Š” ๊ฒฐ์ฒด ์ฐฝ์„ ์‚ฌ์šฉํ•  ์ˆ˜ ์—†์–ด, ์˜ค์ง ๊ท€ํ•˜์˜ ๋ฐฑ์—”๋“œ ์„œ๋ฒ„๊ฐ€ ์•„์ž„ํฌํŠธ์˜ API\nํ•จ์ˆ˜๋ฅผ ์ง์ ‘ ํ˜ธ์ถœํ•ด์•ผํ•˜๋Š” ๊ฒฝ์šฐ์— ํ•ด๋‹นํ•œ๋‹ค. ๋”ฐ๋ผ์„œ ๊ฐ„ํŽธ ๊ฒฐ์ œ์— ๊ด€ํ•˜์—ฌ ์•„์ž„ํฌํŠธ ์„œ๋ฒ„์™€\n์—ฐ๋™ํ•˜๋Š” ๋ฐฑ์—”๋“œ ์„œ๋ฒ„ ๋ฐ ํ”„๋ก ํŠธ ์–ดํ”Œ๋ฆฌ์ผ€์ด์…˜์„ ๊ฐœ๋ฐœํ•  ๋•Œ, ๋ฐ˜๋“œ์‹œ ์ด ์ƒํ™ฉ์— ๋Œ€ํ•œ ๋ณ„๋„์˜\n์„ค๊ณ„ ๋ฐ ๊ฐœ๋ฐœ์ด ํ•„์š”ํ•˜๋‹ˆ, ์ด ์ ์„ ์—ผ๋‘์— ๋‘๊ธฐ ๋ฐ”๋ž€๋‹ค.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "subscribe.payments.again.again", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋ฏธ๋ฆฌ ๋“ฑ๋กํ•œ ์นด๋“œ๋ฅผ ์ด์šฉํ•œ ๊ฒฐ์ œ ์‹ ์ฒญ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์นด๋“œ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + } + }, + "components": { + "schemas": { + "IIamportResponse_lt_IIamportCertification_gt_": { + "type": "object", + "properties": { + "code": { + "description": "์—๋Ÿฌ ์ฝ”๋“œ.\n\n๊ฐ’์ด 0 ์ด๋ฉด ์˜ค๋ฅ˜๊ฐ€ ์—†๋‹ค๋Š” ๋œป.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "message": { + "description": "์„ฑ๊ณต ๋˜๋Š” ์˜ค๋ฅ˜ ๋ฉ”์‹œ์ง€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/IIamportCertification" + } + }, + "nullable": false, + "required": [ + "code", + "message", + "response" + ], + "description": "์•„์ž„ํฌํŠธ ๊ณ ์œ ์˜ ์‘๋‹ต ๋ฐ์ดํ„ฐ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportCertification": { + "type": "object", + "properties": { + "imp_uid": { + "description": "์•„์ž„ํฌํŠธ๊ฐ€ ๋ฐœ๊ธ‰ํ•ด ์ค€ ์‹๋ณ„์ž ๋ฒˆํ˜ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "merchant_uid": { + "description": "์„œ๋น„์Šค๋กœ๋ถ€ํ„ฐ์˜ ์‹๋ณ„์ž ํ‚ค.\n\n์•„์ž„ํฌํŠธ ์„œ๋ฒ„๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์‚ฌ์šฉํ•˜๋Š” ์„œ๋น„์Šค๊ฐ€ ์ž์ฒด์ ์œผ๋กœ ๋ฐœ๊ธ‰ํ•˜๊ณ  ๊ด€๋ฆฌํ•œ๋‹ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "name": { + "description": "๋ณธ์ธ์ธ์ฆ๋Œ€์ƒ์ž ์„ฑ๋ช….", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "gender": { + "description": "์„ฑ๋ณ„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "birth": { + "description": "์ƒ๋…„์›”์ผ.\n\n๋ฆฌ๋ˆ…์Šค ํƒ€์ž„์ด ์“ฐ์ธ๋‹ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "birthday": { + "description": "์ƒ๋…„์›”์ผ, YYYYMMDD ํ˜•์‹.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^([0-9]{4})(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$" + }, + "foreigner": { + "description": "์™ธ๊ตญ์ธ ์—ฌ๋ถ€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "phone": { + "description": "๋ณธ์ธ์ธ์ฆ ๋Œ€์ƒ์ž ํ•ธ๋“œํฐ ๋ฒˆํ˜ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "carrier": { + "description": "๋ณธ์ธ์ธ์ฆ ๋Œ€์ƒ์ž ํ†ต์‹ ์‚ฌ ์ฝ”๋“œ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "SKT", + "KT", + "LGT" + ] + }, + "certified": { + "description": "OTP ์ธ์ฆ ์—ฌ๋ถ€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "certified_at": { + "description": "OTP ์ธ์ฆ ์ผ์‹œ.\n\n๋ฆฌ๋ˆ…์Šค ํƒ€์ž„์ด ์“ฐ์ด๋ฉฐ, `null` ๋Œ€์‹  0 ์„ ์”€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "unique_key": { + "description": "๋ญ”์ง€ ์ž˜ ๋ชจ๋ฆ„, ์šฉ๋„ ์•„์‹œ๋Š” ๋ถ„?", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "unique_in_site": { + "description": "๋ญ”์ง€ ์ž˜ ๋ชจ๋ฆ„, ์šฉ๋„ ์•„์‹œ๋Š” ๋ถ„?", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_tid": { + "description": "๋ญ”์ง€ ์ž˜ ๋ชจ๋ฆ„, ์šฉ๋„ ์•„์‹œ๋Š” ๋ถ„?", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_provider": { + "description": "PG ์ œ๊ณต์ž.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "origin": { + "description": "๋ญ”์ง€ ์ž˜ ๋ชจ๋ฆ„, ์šฉ๋„ ์•„์‹œ๋Š” ๋ถ„?", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "__otp": { + "description": "(ํ…Œ์ŠคํŠธ ์ „์šฉ) OTP ์ฝ”๋“œ.\n\n์˜ค์ง `fake-iamport-server` ์—์„œ๋งŒ ์“ฐ์ด๋Š” ์†์„ฑ์œผ๋กœ์จ, ๋ณธ์ธ์ธ์ฆ์„ ์‹œ๋ฎฌ๋ ˆ์ด์…˜ํ•  ๋•Œ,\n์–ด๋– ํ•œ OTP ์ฝ”๋“œ๊ฐ€ ๋ฐœ๊ธ‰๋˜์—ˆ๋Š” ์ง€๋ฅผ ํ™•์ธํ•˜๊ธฐ ์œ„ํ•˜์—ฌ ์‚ฌ์šฉ๋œ๋‹ค. ์ด๋ฅผ ์ด์šฉํ•˜์—ฌ\n{@link functional.certifications.otp.confirm } ํ•จ์ˆ˜๋ฅผ ํ˜ธ์ถœํ•˜๋ฉด, ๋ณธ์ธ์ธ์ฆ์„ ์™„๋ฃŒํ• \n์ˆ˜ ์žˆ๋‹ค.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + } + }, + "nullable": false, + "required": [ + "imp_uid", + "merchant_uid", + "name", + "gender", + "birth", + "birthday", + "foreigner", + "phone", + "carrier", + "certified", + "certified_at", + "unique_key", + "unique_in_site", + "pg_tid", + "pg_provider", + "origin" + ], + "description": "๋ณธ์ธ ์ธ์ฆ ๋‚ด์—ญ.\n\n`IIamportCertification` ์€ ์•„์ž„ํฌํŠธ์˜ ๋ณธ์ธ์ธ์ฆ ์ •๋ณด๋ฅผ ํ˜•์ƒํ™”ํ•œ ์ž๋ฃŒ๊ตฌ์กฐ ์ธํ„ฐํŽ˜์ด์Šค์ด๋‹ค.\n\n๋‹จ, `IIamportCertification` ๋ ˆ์ฝ”๋“œ์˜ ์กด์žฌ๊ฐ€ ๊ณง ๋ณธ์ธ์ธ์ฆ์˜ ์™„๊ฒฐ์„ ๋œปํ•˜๋Š” ๊ฒƒ์€ ์•„๋‹ˆ๋‹ค.\n{@link IIamportCertification.certified } ๊ฐ’์ด `true` ์—ฌ์•ผ๋งŒ์ด ๋น„๋กœ์†Œ, ๋ณธ์ธ์ธ์ฆ\n๋Œ€์ƒ์ž๊ฐ€ ์ž์‹ ์˜ ํ•ธ๋“œํฐ ๋ฒˆํ˜ธ๋กœ ์ „์†ก๋œ OTP ๋ฅผ ์•„์ž„ํฌํŠธ์˜ ๋ณธ์ธ์ธ์ฆ ํŒ์—…์ฐฝ์— ์ •ํ™•ํžˆ ์ ์–ด,\n๋ณธ์ธ์ธ์ฆ์„ ์™„๋ฃŒํ–ˆ์Œ์„ ์˜๋ฏธํ•œ๋‹ค.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportCertification.IStore": { + "type": "object", + "properties": { + "name": { + "description": "๋ณธ์ธ์ธ์ฆ๋Œ€์ƒ์ž ์„ฑ๋ช….", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "phone": { + "description": "๋ณธ์ธ์ธ์ฆ ๋Œ€์ƒ์ž ํ•ธ๋“œํฐ ๋ฒˆํ˜ธ.\n\nํ•ธ๋“œํฐ ๋ฒˆํ˜ธ์— \"-\" ๊ฐ’์ด ๋“ค์–ด๊ฐ€๋˜ ์•„๋‹ˆ๋˜ ์ƒ๊ด€ ์—†์Œ.\n\n๋‹ค๋งŒ, ๋‚ด๋ถ€์ ์œผ๋กœ๋Š” \"-\" ๊ฐ’์„ ์ œ๊ฑฐํ•˜์—ฌ ์ฒ˜๋ฆฌํ•œ๋‹ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "birth": { + "description": "์ƒ๋…„์›”์ผ.\n\nYYYYMMDD ํ˜•์‹.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^([0-9]{4})(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$" + }, + "gender_digit": { + "description": "์ฃผ๋ฏผ๋“ฑ๋ก ๋’ท๋ถ€๋ถ„ ์ฒซ ์ž๋ฆฌ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "carrier": { + "description": "๋ณธ์ธ์ธ์ฆ ๋Œ€์ƒ์ž ํ†ต์‹ ์‚ฌ ์ฝ”๋“œ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "SKT", + "KT", + "LGT" + ] + }, + "is_mvno": { + "description": "์•Œ๋œฐํฐ ์—ฌ๋ถ€.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "boolean" + }, + "commpany": { + "description": "๊ฐ€๋งน์  ์„œ๋น„์Šค ๋ช…์นญ ๋˜๋Š” domain URL.\n\nKISA ์—์„œ ๋Œ€์ƒ์ž์—๊ฒŒ ๋ฐœ์†กํ•˜๋Š” SMS์— ์•ˆ๋‚ด๋  ์„œ๋น„์Šค ๋ช…์นญ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "merchant_uid": { + "description": "๊ท€์‚ฌ ์„œ๋น„์Šค์—์„œ์˜ ๋ณธ์ธ์ธ์ฆ ์‹๋ณ„์ž ํ‚ค.\n\n์•„์ž„ํฌํŠธ ์„œ๋ฒ„๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์‚ฌ์šฉํ•˜๋Š” ์„œ๋น„์Šค๊ฐ€ ์ž์ฒด์ ์œผ๋กœ ๋ฐœ๊ธ‰ํ•˜๊ณ  ๊ด€๋ฆฌํ•œ๋‹ค.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "pg": { + "description": "PG ์‚ฌ ๊ตฌ๋ถ„์ž.\n\n๋‹ค๋‚  ์ƒ์ ์•„์ด๋””๋ฅผ 2๊ฐœ ์ด์ƒ ๋™์‹œ์— ์‚ฌ์šฉํ•˜์‹œ๋ ค๋Š” ๊ฒฝ์šฐ์— ์„ค์ •ํ•˜๋ฉด ๋œ๋‹ค.\n\n**danal.{์ƒ์ ์•„์ด๋””}** ํ˜•ํƒœ๋กœ ์ง€์ •.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + } + }, + "nullable": false, + "required": [ + "name", + "phone", + "birth", + "gender_digit", + "carrier" + ], + "description": "๋ณธ์ธ ์ธ์ฆ ์ž…๋ ฅ ์ •๋ณด.", + "x-typia-jsDocTags": [] + }, + "IIamportResponse_lt_IIamportCertification.IAccessor_gt_": { + "type": "object", + "properties": { + "code": { + "description": "์—๋Ÿฌ ์ฝ”๋“œ.\n\n๊ฐ’์ด 0 ์ด๋ฉด ์˜ค๋ฅ˜๊ฐ€ ์—†๋‹ค๋Š” ๋œป.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "message": { + "description": "์„ฑ๊ณต ๋˜๋Š” ์˜ค๋ฅ˜ ๋ฉ”์‹œ์ง€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/IIamportCertification.IAccessor" + } + }, + "nullable": false, + "required": [ + "code", + "message", + "response" + ], + "description": "์•„์ž„ํฌํŠธ ๊ณ ์œ ์˜ ์‘๋‹ต ๋ฐ์ดํ„ฐ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportCertification.IAccessor": { + "type": "object", + "properties": { + "imp_uid": { + "description": "๋ณธ์ธ์ธ์ฆ์ •๋ณด์˜ ์‹๋ณ„์ž ํ‚ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "nullable": false, + "required": [ + "imp_uid" + ], + "description": "๋ณธ์ธ์ธ์ฆ ์ •๋ณด์˜ ์ ‘๊ทผ์ž ๊ตฌ์กฐ์ฒด.", + "x-typia-jsDocTags": [] + }, + "IIamportCertification.IConfirm": { + "type": "object", + "properties": { + "otp": { + "description": "SMS ๋กœ ์ „์†ก๋œ ๋ณธ์ธ์ธ์ฆ ๋ฒˆํ˜ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "nullable": false, + "required": [ + "otp" + ], + "description": "๋ณธ์ธ์ธ์ฆ ์Šน์ธ์„ ์œ„ํ•œ ์ž…๋ ฅ ์ •๋ณด.", + "x-typia-jsDocTags": [] + }, + "IIamportPayment.IWebhook": { + "type": "object", + "properties": { + "imp_uid": { + "description": "๊ฒฐ์ œ ์ •๋ณด {@link IIamportPayment } ์˜ ์‹๋ณ„์ž ํ‚ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "merchant_uid": { + "description": "์ฃผ๋ฌธ ์‹๋ณ„์ž ํ‚ค.\n\n์•„์ž„ํฌํŠธ ์„œ๋ฒ„๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์‚ฌ์šฉํ•˜๋Š” ์„œ๋น„์Šค๊ฐ€ ์ž์ฒด์ ์œผ๋กœ ๋ฐœ๊ธ‰ํ•˜๊ณ  ๊ด€๋ฆฌํ•œ๋‹ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "status": { + "description": "ํ˜„์žฌ ์ƒํƒœ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "paid", + "ready", + "failed", + "cancelled" + ] + } + }, + "nullable": false, + "required": [ + "imp_uid", + "merchant_uid", + "status" + ], + "description": "์›นํ›… ๋ฐ์ดํ„ฐ.", + "x-typia-jsDocTags": [] + }, + "IIamportPayment.IQuery": { + "type": "object", + "properties": { + "extension": { + "description": "ํŽ˜์ดํŒ”์˜ ๊ฒฝ์šฐ, ์ด ๊ฐ’์„ `true` ๋กœ ํ•  ๊ฒƒ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "boolean" + } + }, + "nullable": false, + "description": "๊ฒฐ์ œ ์ˆ˜๋‹จ์ด ํŽ˜์ดํŒ”์ธ ๊ฒฝ์šฐ, ํŽ˜์ดํŒ”์˜ ๊ตฌ๋งค์ž ๋ณดํ˜ธ์ •์ฑ…์— ์˜ํ•ด ๊ฒฐ์ œ ์Šน์ธ ์‹œ์ ์—\nPending ์ƒํƒœ๋ฅผ ๋งŒ๋“  ํ›„, ๋‚ด๋ถ€ ์‹ฌ์‚ฌ๋“ฑ์„ ํ†ตํ•ด ์ตœ์ข… ๊ฒฐ์ œ ์™„๋ฃŒ๋ผ๊ณ  ๋ณ€๊ฒฝํ•จ.\n\n`iamport` ์˜ ๊ธฐ์ˆ ์  ์ด์Šˆ๋กœ ํ•ด๋‹น ์ƒํƒœ๋ฅผ status: failed ๋กœ ๊ธฐ๋กํ•จ. ์ถ”ํ›„\nํŽ˜์ดํŒ”์—์„œ ์ตœ์ข…๊ฒฐ์ œ์™„๋ฃŒ๋กœ ๋ณ€๊ฒฝ๋œ ๊ฒฝ์šฐ, `iamport` ์—์„œ `paid` ๋กœ ๋ณ€๊ฒฝ ํ›„,\nํ•ด๋‹น๊ฑด์— ๋Œ€ํ•œ ์›นํ›… ๋ฐœ์†ก. `iamport` ๋ฅผ ์‚ฌ์šฉํ•˜๋Š” ๊ณ ๊ฐ์‚ฌ์—์„œ๋Š”, failed ๋กœ ์ด๋ฏธ\n์ฒ˜๋ฆฌ๋œ ๊ฒฐ์ œ๊ฑด์— ๋Œ€ํ•œ paid ์ƒํƒœ์˜ ์›นํ›…์„ ๋ฐ›๋Š” ๋ฌธ์ œ์ ์ด ์ƒ๊น€.\n\n์ด์—, `iamport` ์—์„œ ์ œ๊ณตํ•˜๋Š” `/payment/{imp_uid}` ์— query-string ์œผ๋กœ\n`extension=true` ์˜ต์…˜์„ ์ถ”๊ฐ€ํ•ด์•ผ ํ•จ", + "x-typia-jsDocTags": [ + { + "name": "issue", + "text": [ + { + "text": "https://github.com/samchon/fake-iamport-server/issues/13", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Sangjin Han - https://github.com/ltnscp9028", + "kind": "text" + } + ] + } + ] + }, + "IIamportResponse_lt_IIamportPayment_gt_": { + "type": "object", + "properties": { + "code": { + "description": "์—๋Ÿฌ ์ฝ”๋“œ.\n\n๊ฐ’์ด 0 ์ด๋ฉด ์˜ค๋ฅ˜๊ฐ€ ์—†๋‹ค๋Š” ๋œป.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "message": { + "description": "์„ฑ๊ณต ๋˜๋Š” ์˜ค๋ฅ˜ ๋ฉ”์‹œ์ง€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/IIamportPayment" + } + }, + "nullable": false, + "required": [ + "code", + "message", + "response" + ], + "description": "์•„์ž„ํฌํŠธ ๊ณ ์œ ์˜ ์‘๋‹ต ๋ฐ์ดํ„ฐ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportPayment": { + "oneOf": [ + { + "$ref": "#/components/schemas/IIamportCardPayment" + }, + { + "$ref": "#/components/schemas/IIamportTransferPayment" + }, + { + "$ref": "#/components/schemas/IIamportVBankPayment" + }, + { + "$ref": "#/components/schemas/IIamportPayment.IBase_lt__doublequote_phone_doublequote__space__or__space__doublequote_kpay_doublequote__space__or__space__doublequote_kakaopay_doublequote__space__or__space__doublequote_payco_doublequote__space__or__space__doublequote_lpay_doublequote__space__or__space__doublequote_ssgpay_doublequote__space__or__space__doublequote_tosspay_doublequote__space__or__space__doublequote_cultureland_doublequote__space__or__space__doublequote_smartculture_doublequote__space__or__space__doublequote_happymoney_doublequote__space__or__space__doublequote_booknlife_doublequote__space__or__space__doublequote_point_doublequote__gt_" + } + ], + "description": "๊ฒฐ์ œ ์ •๋ณด.\n\n`IIamportPayment` ๋Š” ์•„์ž„ํฌํŠธ์˜ ๊ฒฐ์ œ ์ •๋ณด๋ฅผ ํ˜•์ƒํ™”ํ•œ ์ž๋ฃŒ๊ตฌ์กฐ์ด์ž ์œ ๋‹ˆ์–ธ ํƒ€์ž…์˜\n์ธํ„ฐํŽ˜์ด์Šค๋กœ์จ, if condition ์„ ํ†ตํ•˜์—ฌ method ๊ฐ’์„ ํŠน์ •ํ•˜๋ฉด, ํŒŒ์ƒ ํƒ€์ž…์ด ์ž๋™์œผ๋กœ\n์ง€์ •๋œ๋‹ค.\n\n```typescript\nif (payment.pay_method === \"card\")\n payment.card_number; // payment be IIamportCardPayment\n```", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportCardPayment": { + "type": "object", + "properties": { + "card_code": { + "description": "์นด๋“œ ์‹๋ณ„์ž ์ฝ”๋“œ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "card_name": { + "description": "์นด๋“œ ์ด๋ฆ„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "card_number": { + "description": "์นด๋“œ ๋ฒˆํ˜ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "\\d{4}-\\d{4}-\\d{4}-\\d{4}" + }, + "card_quota": { + "description": "ํ• ๋ถ€ ๊ฐœ์›” ์ˆ˜.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "integer" + }, + "apply_num": { + "description": "์นด๋“œ์‚ฌ ์Šน์ธ๋ฒˆํ˜ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pay_method": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "card", + "samsung" + ] + }, + "imp_uid": { + "description": "๊ฒฐ์ œ ์ •๋ณด {@link IIamportPayment } ์˜ ์‹๋ณ„์ž ํ‚ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "merchant_uid": { + "description": "์ฃผ๋ฌธ ์‹๋ณ„์ž ํ‚ค.\n\n์•„์ž„ํฌํŠธ ์„œ๋ฒ„๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์‚ฌ์šฉํ•˜๋Š” ์„œ๋น„์Šค๊ฐ€ ์ž์ฒด์ ์œผ๋กœ ๋ฐœ๊ธ‰ํ•˜๊ณ  ๊ด€๋ฆฌํ•œ๋‹ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "name": { + "description": "์ฃผ๋ฌธ๋ช…, ๋ˆ„๋ฝ ๊ฐ€๋Šฅ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "amount": { + "description": "๊ฒฐ์ œ ์ด์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancel_amount": { + "description": "๊ฒฐ์ œ ์ทจ์†Œ, ํ™˜๋ถˆ ์ด์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "currency": { + "$ref": "#/components/schemas/IIamportPayment.Currency" + }, + "receipt_url": { + "description": "์˜์ˆ˜์ฆ URL.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "url" + }, + "cash_receipt_issue": { + "description": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ๋ฐœํ–‰ ์—ฌ๋ถ€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "channel": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_provider": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "emb_pg_provider": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "pg_id": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_tid": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "escrow": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "buyer_name": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "buyer_email": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "email", + "nullable": true + }, + "buyer_tel": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "buyer_addr": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "buyer_postcode": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "customer_uid": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "customer_uid_usage": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "custom_data": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "user_agent": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "status": { + "$ref": "#/components/schemas/IIamportPayment.Status" + }, + "started_at": { + "description": "๊ฒฐ์ œ ์‹ ์ฒญ ์ผ์‹œ.\n\n๋ฆฌ๋ˆ…์Šค ํƒ€์ž„์ด ์“ฐ์ž„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "paid_at": { + "description": "๊ฒฐ์ œ (์ง€๋ถˆ) ์™„๋ฃŒ ์ผ์‹œ.\n\n๋ฆฌ๋ˆ…์Šค ํƒ€์ž„์ด ์“ฐ์ด๋ฉฐ, `null` ๋Œ€์‹  0 ์„ ์”€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "failed_at": { + "description": "๊ฒฐ์ œ ์‹คํŒจ ์ผ์‹œ.\n\n๋ฆฌ๋ˆ…์Šค ํƒ€์ž„์ด ์“ฐ์ด๋ฉฐ, `null` ๋Œ€์‹  0 ์„ ์”€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancelled_at": { + "description": "๊ฒฐ์ œ ์ทจ์†Œ ์ผ์‹œ.\n\n๋ฆฌ๋ˆ…์Šค ํƒ€์ž„์ด ์“ฐ์ด๋ฉฐ, `null` ๋Œ€์‹  0 ์„ ์”€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "fail_reason": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "cancel_reason": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "cancel_history": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/IIamportPaymentCancel" + } + } + }, + "nullable": false, + "required": [ + "card_code", + "card_name", + "card_number", + "card_quota", + "apply_num", + "pay_method", + "imp_uid", + "merchant_uid", + "name", + "amount", + "cancel_amount", + "currency", + "receipt_url", + "cash_receipt_issue", + "channel", + "pg_provider", + "emb_pg_provider", + "pg_id", + "pg_tid", + "escrow", + "buyer_name", + "buyer_email", + "buyer_tel", + "buyer_addr", + "buyer_postcode", + "customer_uid", + "customer_uid_usage", + "custom_data", + "user_agent", + "status", + "started_at", + "paid_at", + "failed_at", + "cancelled_at", + "fail_reason", + "cancel_reason", + "cancel_history" + ], + "description": "์นด๋“œ ๊ฒฐ์ œ ์ •๋ณด.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportPayment.Currency": { + "type": "string", + "enum": [ + "KRW", + "USD", + "EUR", + "JPY" + ] + }, + "IIamportPayment.Status": { + "type": "string", + "enum": [ + "paid", + "ready", + "failed", + "cancelled" + ] + }, + "IIamportPaymentCancel": { + "type": "object", + "properties": { + "pg_id": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_tid": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancelled_at": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "reason": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "receipt_url": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "url" + } + }, + "nullable": false, + "required": [ + "pg_id", + "pg_tid", + "amount", + "cancelled_at", + "reason", + "receipt_url" + ], + "description": "๊ฒฐ์ œ ์ทจ์†Œ ์ •๋ณด.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportTransferPayment": { + "type": "object", + "properties": { + "bank_code": { + "description": "์€ํ–‰ ์‹๋ณ„์ž ์ฝ”๋“œ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "bank_name": { + "description": "์€ํ–‰ ์ด๋ฆ„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pay_method": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "trans" + ] + }, + "imp_uid": { + "description": "๊ฒฐ์ œ ์ •๋ณด {@link IIamportPayment } ์˜ ์‹๋ณ„์ž ํ‚ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "merchant_uid": { + "description": "์ฃผ๋ฌธ ์‹๋ณ„์ž ํ‚ค.\n\n์•„์ž„ํฌํŠธ ์„œ๋ฒ„๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์‚ฌ์šฉํ•˜๋Š” ์„œ๋น„์Šค๊ฐ€ ์ž์ฒด์ ์œผ๋กœ ๋ฐœ๊ธ‰ํ•˜๊ณ  ๊ด€๋ฆฌํ•œ๋‹ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "name": { + "description": "์ฃผ๋ฌธ๋ช…, ๋ˆ„๋ฝ ๊ฐ€๋Šฅ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "amount": { + "description": "๊ฒฐ์ œ ์ด์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancel_amount": { + "description": "๊ฒฐ์ œ ์ทจ์†Œ, ํ™˜๋ถˆ ์ด์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "currency": { + "$ref": "#/components/schemas/IIamportPayment.Currency" + }, + "receipt_url": { + "description": "์˜์ˆ˜์ฆ URL.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "url" + }, + "cash_receipt_issue": { + "description": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ๋ฐœํ–‰ ์—ฌ๋ถ€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "channel": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_provider": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "emb_pg_provider": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "pg_id": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_tid": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "escrow": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "buyer_name": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "buyer_email": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "email", + "nullable": true + }, + "buyer_tel": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "buyer_addr": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "buyer_postcode": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "customer_uid": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "customer_uid_usage": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "custom_data": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "user_agent": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "status": { + "$ref": "#/components/schemas/IIamportPayment.Status" + }, + "started_at": { + "description": "๊ฒฐ์ œ ์‹ ์ฒญ ์ผ์‹œ.\n\n๋ฆฌ๋ˆ…์Šค ํƒ€์ž„์ด ์“ฐ์ž„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "paid_at": { + "description": "๊ฒฐ์ œ (์ง€๋ถˆ) ์™„๋ฃŒ ์ผ์‹œ.\n\n๋ฆฌ๋ˆ…์Šค ํƒ€์ž„์ด ์“ฐ์ด๋ฉฐ, `null` ๋Œ€์‹  0 ์„ ์”€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "failed_at": { + "description": "๊ฒฐ์ œ ์‹คํŒจ ์ผ์‹œ.\n\n๋ฆฌ๋ˆ…์Šค ํƒ€์ž„์ด ์“ฐ์ด๋ฉฐ, `null` ๋Œ€์‹  0 ์„ ์”€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancelled_at": { + "description": "๊ฒฐ์ œ ์ทจ์†Œ ์ผ์‹œ.\n\n๋ฆฌ๋ˆ…์Šค ํƒ€์ž„์ด ์“ฐ์ด๋ฉฐ, `null` ๋Œ€์‹  0 ์„ ์”€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "fail_reason": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "cancel_reason": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "cancel_history": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/IIamportPaymentCancel" + } + } + }, + "nullable": false, + "required": [ + "bank_code", + "bank_name", + "pay_method", + "imp_uid", + "merchant_uid", + "name", + "amount", + "cancel_amount", + "currency", + "receipt_url", + "cash_receipt_issue", + "channel", + "pg_provider", + "emb_pg_provider", + "pg_id", + "pg_tid", + "escrow", + "buyer_name", + "buyer_email", + "buyer_tel", + "buyer_addr", + "buyer_postcode", + "customer_uid", + "customer_uid_usage", + "custom_data", + "user_agent", + "status", + "started_at", + "paid_at", + "failed_at", + "cancelled_at", + "fail_reason", + "cancel_reason", + "cancel_history" + ], + "description": "๊ณ„์ขŒ ์ด์ฒด ๊ฒฐ์ œ ์ •๋ณด.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportVBankPayment": { + "type": "object", + "properties": { + "vbank_code": { + "description": "๊ฐ€์ƒ ๊ณ„์ขŒ ์‹๋ณ„์ž ์ฝ”๋“œ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "vbank_name": { + "description": "๊ฐ€์ƒ ๊ฒŒ์ขŒ ์ด๋ฆ„", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "vbank_num": { + "description": "๊ฐ€์ƒ ๊ณ„์ขŒ ๋ฒˆํ˜ธ", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "vbank_holder": { + "description": "๊ฐ€์ƒ ๊ณ„์ขŒ ์˜ˆ๊ธˆ์ฃผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "vbank_date": { + "description": "๊ฐ€์ƒ ๊ณ„์ขŒ ์ž…๊ธˆ ๋งŒ๋ฃŒ ๊ธฐํ•œ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vbank_issued_at": { + "description": "๊ฐ€์ƒ ๊ณ„์ขŒ ๊ฐœ์„ค ์ผ์‹œ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "pay_method": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "vbank" + ] + }, + "imp_uid": { + "description": "๊ฒฐ์ œ ์ •๋ณด {@link IIamportPayment } ์˜ ์‹๋ณ„์ž ํ‚ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "merchant_uid": { + "description": "์ฃผ๋ฌธ ์‹๋ณ„์ž ํ‚ค.\n\n์•„์ž„ํฌํŠธ ์„œ๋ฒ„๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์‚ฌ์šฉํ•˜๋Š” ์„œ๋น„์Šค๊ฐ€ ์ž์ฒด์ ์œผ๋กœ ๋ฐœ๊ธ‰ํ•˜๊ณ  ๊ด€๋ฆฌํ•œ๋‹ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "name": { + "description": "์ฃผ๋ฌธ๋ช…, ๋ˆ„๋ฝ ๊ฐ€๋Šฅ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "amount": { + "description": "๊ฒฐ์ œ ์ด์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancel_amount": { + "description": "๊ฒฐ์ œ ์ทจ์†Œ, ํ™˜๋ถˆ ์ด์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "currency": { + "$ref": "#/components/schemas/IIamportPayment.Currency" + }, + "receipt_url": { + "description": "์˜์ˆ˜์ฆ URL.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "url" + }, + "cash_receipt_issue": { + "description": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ๋ฐœํ–‰ ์—ฌ๋ถ€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "channel": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_provider": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "emb_pg_provider": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "pg_id": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_tid": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "escrow": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "buyer_name": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "buyer_email": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "email", + "nullable": true + }, + "buyer_tel": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "buyer_addr": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "buyer_postcode": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "customer_uid": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "customer_uid_usage": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "custom_data": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "user_agent": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "status": { + "$ref": "#/components/schemas/IIamportPayment.Status" + }, + "started_at": { + "description": "๊ฒฐ์ œ ์‹ ์ฒญ ์ผ์‹œ.\n\n๋ฆฌ๋ˆ…์Šค ํƒ€์ž„์ด ์“ฐ์ž„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "paid_at": { + "description": "๊ฒฐ์ œ (์ง€๋ถˆ) ์™„๋ฃŒ ์ผ์‹œ.\n\n๋ฆฌ๋ˆ…์Šค ํƒ€์ž„์ด ์“ฐ์ด๋ฉฐ, `null` ๋Œ€์‹  0 ์„ ์”€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "failed_at": { + "description": "๊ฒฐ์ œ ์‹คํŒจ ์ผ์‹œ.\n\n๋ฆฌ๋ˆ…์Šค ํƒ€์ž„์ด ์“ฐ์ด๋ฉฐ, `null` ๋Œ€์‹  0 ์„ ์”€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancelled_at": { + "description": "๊ฒฐ์ œ ์ทจ์†Œ ์ผ์‹œ.\n\n๋ฆฌ๋ˆ…์Šค ํƒ€์ž„์ด ์“ฐ์ด๋ฉฐ, `null` ๋Œ€์‹  0 ์„ ์”€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "fail_reason": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "cancel_reason": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "cancel_history": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/IIamportPaymentCancel" + } + } + }, + "nullable": false, + "required": [ + "vbank_code", + "vbank_name", + "vbank_num", + "vbank_holder", + "vbank_date", + "vbank_issued_at", + "pay_method", + "imp_uid", + "merchant_uid", + "name", + "amount", + "cancel_amount", + "currency", + "receipt_url", + "cash_receipt_issue", + "channel", + "pg_provider", + "emb_pg_provider", + "pg_id", + "pg_tid", + "escrow", + "buyer_name", + "buyer_email", + "buyer_tel", + "buyer_addr", + "buyer_postcode", + "customer_uid", + "customer_uid_usage", + "custom_data", + "user_agent", + "status", + "started_at", + "paid_at", + "failed_at", + "cancelled_at", + "fail_reason", + "cancel_reason", + "cancel_history" + ], + "description": "๊ฐ€์ƒ ๊ณ„์ขŒ ๊ฒฐ์ œ ์ •๋ณด.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportPayment.IBase_lt__doublequote_phone_doublequote__space__or__space__doublequote_kpay_doublequote__space__or__space__doublequote_kakaopay_doublequote__space__or__space__doublequote_payco_doublequote__space__or__space__doublequote_lpay_doublequote__space__or__space__doublequote_ssgpay_doublequote__space__or__space__doublequote_tosspay_doublequote__space__or__space__doublequote_cultureland_doublequote__space__or__space__doublequote_smartculture_doublequote__space__or__space__doublequote_happymoney_doublequote__space__or__space__doublequote_booknlife_doublequote__space__or__space__doublequote_point_doublequote__gt_": { + "type": "object", + "properties": { + "pay_method": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "phone", + "kpay", + "kakaopay", + "payco", + "lpay", + "ssgpay", + "tosspay", + "cultureland", + "smartculture", + "happymoney", + "booknlife", + "point" + ] + }, + "imp_uid": { + "description": "๊ฒฐ์ œ ์ •๋ณด {@link IIamportPayment } ์˜ ์‹๋ณ„์ž ํ‚ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "merchant_uid": { + "description": "์ฃผ๋ฌธ ์‹๋ณ„์ž ํ‚ค.\n\n์•„์ž„ํฌํŠธ ์„œ๋ฒ„๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์‚ฌ์šฉํ•˜๋Š” ์„œ๋น„์Šค๊ฐ€ ์ž์ฒด์ ์œผ๋กœ ๋ฐœ๊ธ‰ํ•˜๊ณ  ๊ด€๋ฆฌํ•œ๋‹ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "name": { + "description": "์ฃผ๋ฌธ๋ช…, ๋ˆ„๋ฝ ๊ฐ€๋Šฅ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "amount": { + "description": "๊ฒฐ์ œ ์ด์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancel_amount": { + "description": "๊ฒฐ์ œ ์ทจ์†Œ, ํ™˜๋ถˆ ์ด์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "currency": { + "$ref": "#/components/schemas/IIamportPayment.Currency" + }, + "receipt_url": { + "description": "์˜์ˆ˜์ฆ URL.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "url" + }, + "cash_receipt_issue": { + "description": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ๋ฐœํ–‰ ์—ฌ๋ถ€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "channel": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_provider": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "emb_pg_provider": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "pg_id": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_tid": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "escrow": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "buyer_name": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "buyer_email": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "email", + "nullable": true + }, + "buyer_tel": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "buyer_addr": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "buyer_postcode": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "customer_uid": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "customer_uid_usage": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "custom_data": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "user_agent": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "status": { + "$ref": "#/components/schemas/IIamportPayment.Status" + }, + "started_at": { + "description": "๊ฒฐ์ œ ์‹ ์ฒญ ์ผ์‹œ.\n\n๋ฆฌ๋ˆ…์Šค ํƒ€์ž„์ด ์“ฐ์ž„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "paid_at": { + "description": "๊ฒฐ์ œ (์ง€๋ถˆ) ์™„๋ฃŒ ์ผ์‹œ.\n\n๋ฆฌ๋ˆ…์Šค ํƒ€์ž„์ด ์“ฐ์ด๋ฉฐ, `null` ๋Œ€์‹  0 ์„ ์”€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "failed_at": { + "description": "๊ฒฐ์ œ ์‹คํŒจ ์ผ์‹œ.\n\n๋ฆฌ๋ˆ…์Šค ํƒ€์ž„์ด ์“ฐ์ด๋ฉฐ, `null` ๋Œ€์‹  0 ์„ ์”€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancelled_at": { + "description": "๊ฒฐ์ œ ์ทจ์†Œ ์ผ์‹œ.\n\n๋ฆฌ๋ˆ…์Šค ํƒ€์ž„์ด ์“ฐ์ด๋ฉฐ, `null` ๋Œ€์‹  0 ์„ ์”€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "fail_reason": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "cancel_reason": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "cancel_history": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/IIamportPaymentCancel" + } + } + }, + "nullable": false, + "required": [ + "pay_method", + "imp_uid", + "merchant_uid", + "name", + "amount", + "cancel_amount", + "currency", + "receipt_url", + "cash_receipt_issue", + "channel", + "pg_provider", + "emb_pg_provider", + "pg_id", + "pg_tid", + "escrow", + "buyer_name", + "buyer_email", + "buyer_tel", + "buyer_addr", + "buyer_postcode", + "customer_uid", + "customer_uid_usage", + "custom_data", + "user_agent", + "status", + "started_at", + "paid_at", + "failed_at", + "cancelled_at", + "fail_reason", + "cancel_reason", + "cancel_history" + ], + "description": "๊ฒฐ์ œ ๊ธฐ๋ณธ (๊ณตํ†ต) ์ •๋ณด.", + "x-typia-jsDocTags": [] + }, + "IIamportPaymentCancel.IStore": { + "type": "object", + "properties": { + "imp_uid": { + "description": "๊ฒฐ์ œ ์ •๋ณด {@link IIamportPayment } ์˜ ์‹๋ณ„์ž ํ‚ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "merchant_uid": { + "description": "์ฃผ๋ฌธ ์‹๋ณ„์ž ํ‚ค.\n\n์•„์ž„ํฌํŠธ ์„œ๋ฒ„๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์‚ฌ์šฉํ•˜๋Š” ์„œ๋น„์Šค๊ฐ€ ์ž์ฒด์ ์œผ๋กœ ๋ฐœ๊ธ‰ํ•˜๊ณ  ๊ด€๋ฆฌํ•œ๋‹ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "์ทจ์†Œ ๊ธˆ์•ก, ๋ถ€๋ถ„ ์ทจ์†Œ๋„ ๊ฐ€๋Šฅํ•˜๋‹ค.\n\n๋ˆ„๋ฝ์‹œ ์ „์•ก ์ทจ์†Œ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "checksum": { + "description": "์ทจ์†Œ ํŠธ๋žœ์žญ์…˜ ์ˆ˜ํ–‰ ์ „, ํ˜„์žฌ ์‹œ์ ์˜ ์ทจ์†Œ ๊ฐ€๋Šฅํ•œ ์ž”์•ก.\n\nAPI์š”์ฒญ์ž๊ฐ€ ๊ธฐ๋กํ•˜๊ณ  ์žˆ๋Š” ์ทจ์†Œ๊ฐ€๋Šฅ ์ž”์•ก๊ณผ ์•„์ž„ํฌํŠธ๊ฐ€ ๊ธฐ๋กํ•˜๊ณ  ์žˆ๋Š” ์ทจ์†Œ๊ฐ€๋Šฅ ์ž”์•ก์ด\n์ผ์น˜ํ•˜๋Š”์ง€ ์‚ฌ์ „์— ๊ฒ€์ฆํ•˜๊ณ , ๊ฒ€์ฆ์— ์‹คํŒจํ•˜๋ฉด ํŠธ๋žœ์žญ์…˜์„ ์ˆ˜ํ–‰ํ•˜์ง€ ์•Š๋Š”๋‹ค.\n\n`null` ์ธ ๊ฒฝ์šฐ์—๋Š” ๊ฒ€์ฆ ํ”„๋กœ์„ธ์Šค๋ฅผ ์ƒ๋žต.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number", + "nullable": true + }, + "reason": { + "description": "์ทจ์†Œ ์‚ฌ์œ .", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "tax_free": { + "description": "์ทจ์†Œ์š”์ฒญ๊ธˆ์•ก ์ค‘ ๋ฉด์„ธ๊ธˆ์•ก.", + "x-typia-jsDocTags": [ + { + "name": "default", + "text": [ + { + "text": "0", + "kind": "text" + } + ] + } + ], + "x-typia-required": false, + "x-typia-optional": true, + "type": "number", + "default": 0 + }, + "refund_holder": { + "description": "ํ™˜๋ถˆ๊ณ„์ขŒ ์˜ˆ๊ธˆ์ฃผ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "refund_bank": { + "description": "ํ™˜๋ถˆ๊ณ„์ขŒ ์€ํ–‰ ์ฝ”๋“œ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "refund_account": { + "description": "ํ™˜๋ถˆ๊ณ„์ขŒ ๊ณ„์ขŒ๋ฒˆํ˜ธ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "refund_tel": { + "description": "ํ™˜๋ถˆ๊ณ„์ขŒ ์˜ˆ๊ธˆ์ฃผ ์—ฐ๋ฝ์ฒ˜", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + } + }, + "nullable": false, + "required": [ + "imp_uid", + "merchant_uid", + "checksum", + "reason" + ], + "description": "๊ฒฐ์ œ ์ทจ์†Œ ์ž…๋ ฅ ์ •๋ณด.", + "x-typia-jsDocTags": [] + }, + "IIamportResponse_lt_IIamportReceipt_gt_": { + "type": "object", + "properties": { + "code": { + "description": "์—๋Ÿฌ ์ฝ”๋“œ.\n\n๊ฐ’์ด 0 ์ด๋ฉด ์˜ค๋ฅ˜๊ฐ€ ์—†๋‹ค๋Š” ๋œป.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "message": { + "description": "์„ฑ๊ณต ๋˜๋Š” ์˜ค๋ฅ˜ ๋ฉ”์‹œ์ง€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/IIamportReceipt" + } + }, + "nullable": false, + "required": [ + "code", + "message", + "response" + ], + "description": "์•„์ž„ํฌํŠธ ๊ณ ์œ ์˜ ์‘๋‹ต ๋ฐ์ดํ„ฐ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportReceipt": { + "type": "object", + "properties": { + "imp_uid": { + "description": "๊ท€์† ๊ฒฐ์ œ์˜ {@link IIamportPayment.imp_uid }.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "receipt_uid": { + "description": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ์˜ ๊ณ ์œ  ์‹๋ณ„์ž ID.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "apply_num": { + "description": "์Šน์ธ ๋ฒˆํ˜ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/IIamportReceipt.Type" + }, + "amount": { + "description": "๊ฒฐ์ œ ์ด์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vat": { + "description": "๋ถ€๊ฐ€์„ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "receipt_url": { + "description": "ํ˜„๊ธˆ์˜์ˆ˜์ฆ ์กฐํšŒ URL.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "url" + }, + "applied_at": { + "description": "ํ˜„๊ธˆ์˜์ˆ˜์ฆ ๋ฐœํ–‰ ์‹œ๊ฐ„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancelled_at": { + "description": "ํ˜„๊ธˆ์˜์ˆ˜์ฆ ์ทจ์†Œ ์‹œ๊ฐ„.\n\n๋ฆฌ๋ˆ…์Šค ํƒ€์ž„์ด ์“ฐ์ด๋ฉฐ, `null` ๋Œ€์‹  0 ์„ ์”€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + } + }, + "nullable": false, + "required": [ + "imp_uid", + "receipt_uid", + "apply_num", + "type", + "amount", + "vat", + "receipt_url", + "applied_at", + "cancelled_at" + ], + "description": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ •๋ณด.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportReceipt.Type": { + "description": "ํ˜„๊ธˆ์˜์ˆ˜์ฆ ๋ฐœํ–‰ ํƒ€์ž… (๋Œ€์ƒ).", + "type": "string", + "enum": [ + "person", + "company" + ] + }, + "IIamportReceipt.IStore": { + "type": "object", + "properties": { + "imp_uid": { + "description": "๊ท€์† ๊ฒฐ์ œ์˜ {@link IIamportPayment.imp_uid }.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "identifier": { + "description": "ํ˜„๊ธˆ์˜์ˆ˜์ฆ ๋ฐœ์ƒ๋Œ€์ƒ ์‹๋ณ„์ •๋ณด.\n\n - ๊ตญ์„ธ์ฒญํ˜„๊ธˆ์˜์ˆ˜์ฆ์นด๋“œ\n - ํœด๋Œ€ํฐ๋ฒˆํ˜ธ\n - ์ฃผ๋ฏผ๋“ฑ๋ก๋ฒˆํ˜ธ\n - ์‚ฌ์—…์ž๋“ฑ๋ก๋ฒˆํ˜ธ", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "identifier_type": { + "description": "ํ˜„๊ธˆ์˜์ˆ˜์ฆ ๋ฐœํ–‰๋Œ€์ƒ ์œ ํ˜•.\n\n - person: ์ฃผ๋ฏผ๋“ฑ๋ก๋ฒˆํ˜ธ\n - business: ์‚ฌ์—…์ž๋“ฑ๋ก๋ฒˆํ˜ธ\n - phone: ํœด๋Œ€ํฐ๋ฒˆํ˜ธ\n - taxcard: ๊ตญ์„ธ์ฒญํ˜„๊ธˆ์˜์ˆ˜์ฆ์นด๋“œ\n\n์ผ๋ถ€ PG ์‚ฌ์˜ ๊ฒฝ์šฐ ์ด ํ•ญ๋ชฉ์ด ์—†์–ด ๋œ๋‹ค๋Š”๋ฐ, ์–ด์ง€๊ฐ„ํ•˜๋ฉด ๊ทธ๋ƒฅ ์“ฐ๊ธฐ ๋ฐ”๋žŒ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "enum": [ + "phone", + "person", + "business", + "taxcard" + ] + }, + "type": { + "description": "ํ˜„๊ธˆ์˜์ˆ˜์ฆ ๋ฐœํ–‰ ํƒ€์ž… (๋Œ€์ƒ).\n\n๋ˆ„๋ฝ์‹œ person ์ด ์‚ฌ์šฉ๋จ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "enum": [ + "person", + "company" + ] + }, + "buyer_name": { + "description": "๊ตฌ๋งค์ž ์ด๋ฆ„.\n\nํ˜•๊ธˆ์˜์ˆ˜์ฆ ๋ฐœํ–‰๊ฑด ์‚ฌํ›„ ์ถ”์ ์„ ์œ„ํ•ด ๊ฐ€๊ธ‰ ์ž…๋ ฅํ•˜๊ธฐ ๋ฐ”๋žŒ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_email": { + "description": "๊ตฌ๋งค์ž ์ด๋ฉ”์ผ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_tel": { + "description": "๊ตฌ๋งค์ž ์ „ํ™”๋ฒˆํ˜ธ.\n\nํ˜„๊ธˆ์˜์ˆ˜์ฆ ๋ฐœํ–‰๊ฑด ์‚ฌํ›„ ์ถ”์ ์„ ์œ„ํ•ด ๊ฐ€๊ธ‰ ์ž…๋ ฅํ•˜๊ธฐ ๋ฐ”๋žŒ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "tax_free": { + "description": "๋ฉด์„ธ ๊ธˆ์•ก.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + } + }, + "nullable": false, + "required": [ + "imp_uid", + "identifier" + ], + "description": "ํ˜„๊ธˆ์˜์ˆ˜์ฆ ์ž…๋ ฅ ์ •๋ณด.", + "x-typia-jsDocTags": [] + }, + "IIamportUser.IAccessor": { + "type": "object", + "properties": { + "imp_key": { + "description": "API ํ‚ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "imp_secret": { + "description": "Secret ํ‚ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "nullable": false, + "required": [ + "imp_key", + "imp_secret" + ], + "description": "์•„์ž„ํฌํŠธ์—์„œ ๋ถ€์—ฌํ•ด ์ค€ API ๋ฐ secret ํ‚ค.", + "x-typia-jsDocTags": [] + }, + "IIamportResponse_lt_IIamportUser_gt_": { + "type": "object", + "properties": { + "code": { + "description": "์—๋Ÿฌ ์ฝ”๋“œ.\n\n๊ฐ’์ด 0 ์ด๋ฉด ์˜ค๋ฅ˜๊ฐ€ ์—†๋‹ค๋Š” ๋œป.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "message": { + "description": "์„ฑ๊ณต ๋˜๋Š” ์˜ค๋ฅ˜ ๋ฉ”์‹œ์ง€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/IIamportUser" + } + }, + "nullable": false, + "required": [ + "code", + "message", + "response" + ], + "description": "์•„์ž„ํฌํŠธ ๊ณ ์œ ์˜ ์‘๋‹ต ๋ฐ์ดํ„ฐ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportUser": { + "type": "object", + "properties": { + "now": { + "description": "ํ† ํฐ ๋ฐœํ–‰ ์‹œ๊ฐ„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "expired_at": { + "description": "ํ† ํฐ ๋งŒ๋ฃŒ ์‹œ๊ฐ„.\n\n๋ฆฌ๋ˆ…์Šค ํƒ€์ž„์ด ๊ธฐ์ค€์ด๋ฉฐ, ์ด๋ฅผ JS ์—์„œ ์‚ฌ์šฉํ•˜๋ ค๊ฑฐ๋“ , ์•„๋ž˜์™€ ๊ฐ™์ด ๋ณ€ํ™˜ํ•ด์•ผ ํ•œ๋‹ค.\n\n```typescript\nnew Date(user.expired_at * 1_000);\n```", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "access_token": { + "description": "์œ ์ € ์ธ์ฆ ํ† ํฐ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "nullable": false, + "required": [ + "now", + "expired_at", + "access_token" + ], + "description": "์•„์ž„ํฌํŠธ ์œ ์ € ์ธ์ฆ ์ •๋ณด.\n\n์•„์ž„ํฌํŠธ๋Š” ๊ณ ๊ฐ์‚ฌ์—๊ฒŒ API ๋ฐ secret ํ‚ค ์ •๋ณด, {@link IIamportUser.IAccessor } ๋ฅผ ๋ฐœ๊ธ‰ํ•ด์ค€๋‹ค.\n\nํ•˜์ง€๋งŒ ์ด๋ฅผ ๊ณง์žฅ ์•„์ž„ํฌํŠธ์˜ ์œ ์ € ์ธ์ฆ์— ์‚ฌ์šฉํ•  ์ˆ˜๋Š” ์—†๊ณ , ํ•ด๋‹น API ๋ฐ secret ํ‚ค๋ฅผ ํ† ๋Œ€๋กœ ์œ ์ €\n์ธ์ฆ ํ† ํฐ์„ ๋ฐœ๊ธ‰๋ฐ›์•„์•ผ ํ•˜๋Š”๋ฐ, ์ด ์œ ์ € ์ธ์ฆ ํ† ํฐ์—๋Š” ํ•˜ํ•„์ด๋ฉด ๋งŒ๋กœ ์‹œ๊ฐ„์ด๋ผ๋Š” ๊ฒŒ ์กด์žฌํ•œ๋‹ค.\n`IIamportUser` ๋Š” ๋ฐ”๋กœ ์ด๋Ÿฌํ•œ ์œ ์ € ์ธ์ฆ ํ† ํฐ ๋ฐ ๊ทธ๊ฒƒ์˜ ๋งŒ๋ฃŒ ์‹œ๊ฐ„์„ ํ˜•์ƒํ™”ํ•œ ์ž๋ฃŒ๊ตฌ์กฐ\n์ธํ„ฐํŽ˜์ด์Šค์ด๋‹ค.\n\n๋”ํ•˜์—ฌ ์ด์ฒ˜๋Ÿผ ๋งŒ๋ฃŒ ์‹œ๊ฐ„์ด ์กด์žฌํ•˜๋Š” ์•„์ž„ํฌํŠธ์˜ ์œ ์ € ์ธ์ฆ ํ† ํฐ์˜ ํŠน์„ฑ์ƒ, ์ด๊ฒƒ์˜ ๋งŒ๋ฃŒ ์‹œ๊ฐ„์ด\n์ดˆ๊ณผ๋˜์ง€ ์•Š๋„๋ก ๊ด€๋ฆฌํ•˜๋Š” ๊ฒƒ์€ ๋งค์šฐ ํž˜๋“  ์ผ์ด๋‹ค. ์ด์— `iamport-server-api` ์—์„œ๋Š” ์•„์ž„ํฌํŠธ\n์œ ์ € ์ธ์ฆ ํ† ํฐ์ด ๋งŒ๋ฃŒ๋  ๋•Œ๋งˆ๋‹ค ์ž๋™ ๊ฐฑ์‹ ํ•ด์ฃผ๋Š”, {@link IamportConnector } ํด๋ž˜์Šค๋ฅผ ์ œ๊ณตํ•œ๋‹ค.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportVBankPayment.IStore": { + "type": "object", + "properties": { + "merchant_uid": { + "description": "์ฃผ๋ฌธ ์‹๋ณ„์ž ํ‚ค.\n\n์•„์ž„ํฌํŠธ ์„œ๋ฒ„๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์‚ฌ์šฉํ•˜๋Š” ์„œ๋น„์Šค๊ฐ€ ์ž์ฒด์ ์œผ๋กœ ๋ฐœ๊ธ‰ํ•˜๊ณ  ๊ด€๋ฆฌํ•œ๋‹ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "์ด์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vbank_code": { + "description": "๊ฐ€์ƒ๊ณ„์ขŒ ์€ํ–‰ ์ฝ”๋“œ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "vbank_due": { + "description": "๊ฐ€์ƒ๊ณ„์ขŒ ์ž…๊ธˆ๊ธฐํ•œ, ์œ ๋‹‰์Šค ํƒ€์ž„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vbank_holder": { + "description": "์˜ˆ๊ธˆ์ฃผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "name": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_name": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_email": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_tel": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_addr": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_postcode": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "pg": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "notice_url": { + "description": "๊ฐ€์ƒ ๊ณ„์ขŒ ์ž…๊ธˆ ์ •๋ณด๋ฅผ ์ˆ˜์‹ ํ•  URL.\n\n๋ˆ„๋ฝ์‹œ ๊ธฐ๋ณธ ์›นํ›… URL ์‚ฌ์šฉ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "custom_data": { + "description": "์ปค์Šคํ…€ ๋ฐ์ดํ„ฐ, ์ž์œ ๋กญ๊ฒŒ ์‚ฌ์šฉ ๊ฐ€๋Šฅ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "pg_api_key": { + "description": "[์ด๋‹ˆ์‹œ์Šค ์ „์šฉ] ๊ฐ€๋งน์  ์ฝ˜์†”์—์„œ ํ™•์ธํ•œ API ๊ฐ’.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + } + }, + "nullable": false, + "required": [ + "merchant_uid", + "amount", + "vbank_code", + "vbank_due", + "vbank_holder" + ], + "description": "๊ฐ€์ƒ ๊ณ„์ขŒ ๊ฒฐ์ œ ์ž…๋ ฅ ์ •๋ณด.\n\n๊ฐ€์ƒ ๊ณ„์ขŒ๋ฅผ ์ž„์˜ ์ƒ์„ฑํ•  ์ˆ˜ ์žˆ๋‹ค.\n\n๋‹จ, ์ผ๋ถ€ PG ์‚ฌ ํ˜น์€ `fake-iamport-server` ๋งŒ ๊ฐ€๋Šฅ.\n\n - ์„ธํ‹€๋ฑ…ํฌ\n - ๋‚˜์ด์ŠคํŽ˜์ด๋จผ์ธ \n - KG์ด๋‹ˆ์‹œ์Šค", + "x-typia-jsDocTags": [] + }, + "IIamportResponse_lt_IIamportVBankPayment_gt_": { + "type": "object", + "properties": { + "code": { + "description": "์—๋Ÿฌ ์ฝ”๋“œ.\n\n๊ฐ’์ด 0 ์ด๋ฉด ์˜ค๋ฅ˜๊ฐ€ ์—†๋‹ค๋Š” ๋œป.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "message": { + "description": "์„ฑ๊ณต ๋˜๋Š” ์˜ค๋ฅ˜ ๋ฉ”์‹œ์ง€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/IIamportVBankPayment" + } + }, + "nullable": false, + "required": [ + "code", + "message", + "response" + ], + "description": "์•„์ž„ํฌํŠธ ๊ณ ์œ ์˜ ์‘๋‹ต ๋ฐ์ดํ„ฐ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportVBankPayment.IUpdate": { + "type": "object", + "properties": { + "imp_uid": { + "description": "๋Œ€์ƒ ๊ฒฐ์ œ ๊ธฐ๋ก์˜ {@link IIamportPayment.imp_uid }.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "์ˆ˜์ •ํ•  ๊ฒฐ์ œ ๊ธˆ์•ก.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "vbank_due": { + "description": "์ˆ˜์ •ํ•  ๊ฐ€์ƒ๊ณ„์ขŒ ์ž…๊ธˆ ๊ธฐํ•œ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + } + }, + "nullable": false, + "required": [ + "imp_uid" + ], + "description": "๊ฐ€์ƒ ๊ณ„์ขŒ ๊ฒฐ์ œ์˜ ์ˆ˜์ • ์ž…๋ ฅ ์ •๋ณด.\n\n์•„์ง ์ž…๊ธˆ๋˜์ง€ ์•Š์€ ๊ฐ€์ƒ๊ณ„์ขŒ์˜ ์ž…๊ธˆ๊ธฐํ•œ ๋˜๋Š” ์ž…๊ธˆ๊ธˆ์•ก์„ ์ˆ˜์ •ํ•  ์ˆ˜ ์žˆ๋‹ค.\n\n๋‹ค๋งŒ, ์„ธํ‹€๋ฑ…ํฌ ํ˜น์€ `fake-iamport-server` ๋งŒ ๊ฐ€๋Šฅ.", + "x-typia-jsDocTags": [] + }, + "IIamportResponse_lt_IIamportSubscription_gt_": { + "type": "object", + "properties": { + "code": { + "description": "์—๋Ÿฌ ์ฝ”๋“œ.\n\n๊ฐ’์ด 0 ์ด๋ฉด ์˜ค๋ฅ˜๊ฐ€ ์—†๋‹ค๋Š” ๋œป.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "message": { + "description": "์„ฑ๊ณต ๋˜๋Š” ์˜ค๋ฅ˜ ๋ฉ”์‹œ์ง€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/IIamportSubscription" + } + }, + "nullable": false, + "required": [ + "code", + "message", + "response" + ], + "description": "์•„์ž„ํฌํŠธ ๊ณ ์œ ์˜ ์‘๋‹ต ๋ฐ์ดํ„ฐ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportSubscription": { + "type": "object", + "properties": { + "pg_provider": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_id": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "card_name": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "card_code": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "card_number": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "card_type": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "customer_name": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "customer_tel": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "customer_email": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "customer_addr": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "customer_postcode": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "nullable": true + }, + "inserted": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "updated": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "customer_uid": { + "description": "๊ณ ๊ฐ ์‹๋ณ„์ž ํ‚ค.\n\n์•„์ž„ํฌํŠธ๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์ด์šฉํ•˜๋Š” ์„œ๋น„์Šค์—์„œ ์ž์ฒด์ ์œผ๋กœ ๊ด€๋ฆฌํ•˜๋Š” ์‹๋ณ„์ž ํ‚ค.\n\n๋‹ค๋งŒ ๊ณ ๊ฐ์ด๋ผ๊ธฐ๋ณด๋‹ค ์‹ค์ œ๋กœ๋Š” ์นด๋“œ์˜ ์‹๋ณ„์ž ํ‚ค๋กœ ์จ์•ผํ•จ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "nullable": false, + "required": [ + "pg_provider", + "pg_id", + "card_name", + "card_code", + "card_number", + "card_type", + "customer_name", + "customer_tel", + "customer_email", + "customer_addr", + "customer_postcode", + "inserted", + "updated", + "customer_uid" + ], + "description": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ์ •๋ณด.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportSubscription.IStore": { + "type": "object", + "properties": { + "card_number": { + "description": "์นด๋“œ ๋ฒˆํ˜ธ.\n\nํ˜•์‹: XXXX-XXXX-XXXX-XXXX", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "\\d{4}-\\d{4}-\\d{4}-\\d{4}" + }, + "expiry": { + "description": "์นด๋“œ ์œ ํšจ๊ธฐ๊ฐ„.\n\nํ˜•์‹: YYYY-MM", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^([0-9]{4})-(0[1-9]|1[012])$" + }, + "birth": { + "description": "์ƒ๋…„์›”์ผ YYMMDD ๋˜๋Š” ์‚ฌ์—…์ž๋“ฑ๋ก๋ฒˆํ˜ธ 10์ž๋ฆฌ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^(([0-9]{2})(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01]))|(\\d{10})$" + }, + "pwd_2digit": { + "description": "์นด๋“œ ๋น„๋ฐ€๋ฒˆํ˜ธ ์•ž ๋‘ ์ž๋ฆฌ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "pattern": "\\d{2}" + }, + "cvc": { + "description": "์นด๋“œ ์ธ์ฆ๋ฒˆํ˜ธ (์นด๋“œ ๋’ท๋ฉด 3 ์ž๋ฆฌ).", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "pattern": "\\d{2}" + }, + "customer_name": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customer_tel": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customer_email": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "format": "email" + }, + "customr_addr": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customer_postcode": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customer_uid": { + "description": "๊ณ ๊ฐ ์‹๋ณ„์ž ํ‚ค.\n\n์•„์ž„ํฌํŠธ๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์ด์šฉํ•˜๋Š” ์„œ๋น„์Šค์—์„œ ์ž์ฒด์ ์œผ๋กœ ๊ด€๋ฆฌํ•˜๋Š” ์‹๋ณ„์ž ํ‚ค.\n\n๋‹ค๋งŒ ๊ณ ๊ฐ์ด๋ผ๊ธฐ๋ณด๋‹ค ์‹ค์ œ๋กœ๋Š” ์นด๋“œ์˜ ์‹๋ณ„์ž ํ‚ค๋กœ ์จ์•ผํ•จ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "nullable": false, + "required": [ + "card_number", + "expiry", + "birth", + "customer_uid" + ], + "description": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ์ž…๋ ฅ ์ •๋ณด.", + "x-typia-jsDocTags": [] + }, + "IIamportSubscription.IOnetime": { + "type": "object", + "properties": { + "customer_uid": { + "description": "๊ณ ๊ฐ ์‹๋ณ„์ž ํ‚ค.\n\n์•„์ž„ํฌํŠธ๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์ด์šฉํ•˜๋Š” ์„œ๋น„์Šค์—์„œ ์ž์ฒด์ ์œผ๋กœ ๊ด€๋ฆฌํ•˜๋Š” ์‹๋ณ„์ž ํ‚ค.\n\n๋‹ค๋งŒ ๊ณ ๊ฐ์ด๋ผ๊ธฐ๋ณด๋‹ค ์‹ค์ œ๋กœ๋Š” ์นด๋“œ์˜ ์‹๋ณ„์ž ํ‚ค๋กœ ์จ์•ผํ•จ.\n\n์ด๋ฅผ ์ƒ๋žต์‹œ ๋‹จ์ˆœ ๊ฒฐ์ œ๋กœ๋งŒ ๊ทธ์น˜๋ฉฐ, ์นด๋“œ ์ •๋ณด๊ฐ€ ๊ฐ„ํŽธ ๊ฒฐ์ œ์šฉ์œผ๋กœ ๋“ฑ๋ก๋˜์ง€ ์•„๋‹ˆํ•จ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "card_number": { + "description": "์นด๋“œ ๋ฒˆํ˜ธ.\n\nํ˜•์‹: XXXX-XXXX-XXXX-XXXX", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "\\d{4}-\\d{4}-\\d{4}-\\d{4}" + }, + "expiry": { + "description": "์นด๋“œ ์œ ํšจ๊ธฐ๊ฐ„.\n\nํ˜•์‹: YYYY-MM", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^([0-9]{4})-(0[1-9]|1[012])$" + }, + "birth": { + "description": "์ƒ๋…„์›”์ผ YYMMDD ๋˜๋Š” ์‚ฌ์—…์ž๋“ฑ๋ก๋ฒˆํ˜ธ 10์ž๋ฆฌ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^(([0-9]{2})(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01]))|(\\d{10})$" + }, + "pwd_2digit": { + "description": "์นด๋“œ ๋น„๋ฐ€๋ฒˆํ˜ธ ์•ž ๋‘ ์ž๋ฆฌ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "pattern": "\\d{2}" + }, + "cvc": { + "description": "์นด๋“œ ์ธ์ฆ๋ฒˆํ˜ธ (์นด๋“œ ๋’ท๋ฉด 3 ์ž๋ฆฌ).", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "pattern": "\\d{2}" + }, + "customer_name": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customer_tel": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customer_email": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "format": "email" + }, + "customr_addr": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customer_postcode": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "merchant_uid": { + "description": "์ฃผ๋ฌธ ์‹๋ณ„์ž ํ‚ค.\n\n์•„์ž„ํฌํŠธ๊ฐ€ ์•„๋‹Œ ์ด๋ฅผ ์ด์šฉํ•˜๋Š” ์„œ๋น„์Šค์—์„œ ์ž์ฒด์ ์œผ๋กœ ๊ด€๋ฆฌํ•˜๋Š” ์‹๋ณ„์ž ํ‚ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "๊ฒฐ์ œ ์ด์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "name": { + "description": "์ฃผ๋ฌธ ์ด๋ฆ„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "currency": { + "description": "ํ†ตํ™” ์ •๋ณด.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "enum": [ + "KRW", + "USD", + "EUR", + "JPY" + ] + }, + "tax_free": { + "description": "๋ฉด์„ธ ๊ณต๊ธ‰๊ฐ€์•ก.\n\n๊ธฐ๋ณธ๊ฐ’์€ 0 ๋กœ์จ, ์•Œ์•„์„œ amount ์˜ 1/11 ๋กœ์จ ๋ถ€๊ฐ€์„ธ ์ฒ˜๋ฆฌ๋จ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "card_quota": { + "description": "ํ• ๋ถ€ ๊ฐœ์›” ์ˆ˜.\n\n์ผ์‹œ๋ถˆ์€ 0.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "buyer_name": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_email": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "format": "email" + }, + "buyer_tel": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_addr": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_postcode": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "interest_free_by_merchant": { + "description": "์นด๋“œํ• ๋ถ€์ฒ˜๋ฆฌํ•  ๋•Œ, ํ• ๋ถ€์ด์ž๊ฐ€ ๋ฐœ์ƒํ•˜๋Š” ๊ฒฝ์šฐ (์นด๋“œ์‚ฌ ๋ฌด์ด์ž ํ”„๋กœ๋ชจ์…˜ ์ œ์™ธ).\n\n๋ถ€๊ณผ๋˜๋Š” ํ• ๋ถ€์ด์ž๋ฅผ ๊ณ ๊ฐ๋Œ€์‹  ๊ฐ€๋งน์ ์ด ์ง€๋ถˆํ•˜๊ณ ์ž PG์‚ฌ์™€ ๊ณ„์•ฝ๋œ ๊ฒฝ์šฐ(ํ˜„์žฌ, ๋‚˜์ด์ŠคํŽ˜์ด๋จผ์ธ ๋งŒ ์ง€์›๋จ)", + "x-typia-required": false, + "x-typia-optional": true, + "type": "boolean" + }, + "use_card_point": { + "description": "์Šน์ธ์š”์ฒญ์‹œ ์นด๋“œ์‚ฌ ํฌ์ธํŠธ ์ฐจ๊ฐํ•˜๋ฉฐ ๊ฒฐ์ œ์Šน์ธ์ฒ˜๋ฆฌํ• ์ง€ flag.\n\nPG์‚ฌ ์˜์—…๋‹ด๋‹น์ž์™€ ๊ณ„์•ฝ ๋‹น์‹œ ์‚ฌ์ „ ํ˜‘์˜ ํ•„์š”(ํ˜„์žฌ, ๋‚˜์ด์ŠคํŽ˜์ด๋จผ์ธ ๋งŒ ์ง€์›๋จ)", + "x-typia-required": false, + "x-typia-optional": true, + "type": "boolean" + }, + "custom_data": { + "description": "์ž„์˜ ์ •๋ณด๋ฅผ ๊ธฐ์žฌํ•  ์ˆ˜ ์žˆ๋‹ค.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "notice_url": { + "description": "๊ฒฐ์ œ ์„ฑ๊ณต์‹œ ํ†ต์ง€๋  Notification, ์›นํ›… URL.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "format": "url" + } + }, + "nullable": false, + "required": [ + "card_number", + "expiry", + "birth", + "merchant_uid", + "amount", + "name" + ], + "description": "๊ฒฐ์ œ ์‹ ์ฒญ ์ž…๋ ฅ ์ •๋ณด.", + "x-typia-jsDocTags": [] + }, + "IIamportResponse_lt_IIamportCardPayment_gt_": { + "type": "object", + "properties": { + "code": { + "description": "์—๋Ÿฌ ์ฝ”๋“œ.\n\n๊ฐ’์ด 0 ์ด๋ฉด ์˜ค๋ฅ˜๊ฐ€ ์—†๋‹ค๋Š” ๋œป.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "message": { + "description": "์„ฑ๊ณต ๋˜๋Š” ์˜ค๋ฅ˜ ๋ฉ”์‹œ์ง€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/IIamportCardPayment" + } + }, + "nullable": false, + "required": [ + "code", + "message", + "response" + ], + "description": "์•„์ž„ํฌํŠธ ๊ณ ์œ ์˜ ์‘๋‹ต ๋ฐ์ดํ„ฐ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportSubscription.IAgain": { + "type": "object", + "properties": { + "merchant_uid": { + "description": "์ฃผ๋ฌธ ์‹๋ณ„์ž ํ‚ค.\n\n์•„์ž„ํฌํŠธ๊ฐ€ ์•„๋‹Œ ์ด๋ฅผ ์ด์šฉํ•˜๋Š” ์„œ๋น„์Šค์—์„œ ์ž์ฒด์ ์œผ๋กœ ๊ด€๋ฆฌํ•˜๋Š” ์‹๋ณ„์ž ํ‚ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "๊ฒฐ์ œ ์ด์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "name": { + "description": "์ฃผ๋ฌธ ์ด๋ฆ„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "currency": { + "description": "ํ†ตํ™” ์ •๋ณด.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "enum": [ + "KRW", + "USD", + "EUR", + "JPY" + ] + }, + "tax_free": { + "description": "๋ฉด์„ธ ๊ณต๊ธ‰๊ฐ€์•ก.\n\n๊ธฐ๋ณธ๊ฐ’์€ 0 ๋กœ์จ, ์•Œ์•„์„œ amount ์˜ 1/11 ๋กœ์จ ๋ถ€๊ฐ€์„ธ ์ฒ˜๋ฆฌ๋จ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "card_quota": { + "description": "ํ• ๋ถ€ ๊ฐœ์›” ์ˆ˜.\n\n์ผ์‹œ๋ถˆ์€ 0.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "buyer_name": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_email": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "format": "email" + }, + "buyer_tel": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_addr": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_postcode": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "interest_free_by_merchant": { + "description": "์นด๋“œํ• ๋ถ€์ฒ˜๋ฆฌํ•  ๋•Œ, ํ• ๋ถ€์ด์ž๊ฐ€ ๋ฐœ์ƒํ•˜๋Š” ๊ฒฝ์šฐ (์นด๋“œ์‚ฌ ๋ฌด์ด์ž ํ”„๋กœ๋ชจ์…˜ ์ œ์™ธ).\n\n๋ถ€๊ณผ๋˜๋Š” ํ• ๋ถ€์ด์ž๋ฅผ ๊ณ ๊ฐ๋Œ€์‹  ๊ฐ€๋งน์ ์ด ์ง€๋ถˆํ•˜๊ณ ์ž PG์‚ฌ์™€ ๊ณ„์•ฝ๋œ ๊ฒฝ์šฐ(ํ˜„์žฌ, ๋‚˜์ด์ŠคํŽ˜์ด๋จผ์ธ ๋งŒ ์ง€์›๋จ)", + "x-typia-required": false, + "x-typia-optional": true, + "type": "boolean" + }, + "use_card_point": { + "description": "์Šน์ธ์š”์ฒญ์‹œ ์นด๋“œ์‚ฌ ํฌ์ธํŠธ ์ฐจ๊ฐํ•˜๋ฉฐ ๊ฒฐ์ œ์Šน์ธ์ฒ˜๋ฆฌํ• ์ง€ flag.\n\nPG์‚ฌ ์˜์—…๋‹ด๋‹น์ž์™€ ๊ณ„์•ฝ ๋‹น์‹œ ์‚ฌ์ „ ํ˜‘์˜ ํ•„์š”(ํ˜„์žฌ, ๋‚˜์ด์ŠคํŽ˜์ด๋จผ์ธ ๋งŒ ์ง€์›๋จ)", + "x-typia-required": false, + "x-typia-optional": true, + "type": "boolean" + }, + "custom_data": { + "description": "์ž„์˜ ์ •๋ณด๋ฅผ ๊ธฐ์žฌํ•  ์ˆ˜ ์žˆ๋‹ค.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "notice_url": { + "description": "๊ฒฐ์ œ ์„ฑ๊ณต์‹œ ํ†ต์ง€๋  Notification, ์›นํ›… URL.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "format": "url" + }, + "customer_uid": { + "description": "๊ณ ๊ฐ ์‹๋ณ„์ž ํ‚ค.\n\n์•„์ž„ํฌํŠธ๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์ด์šฉํ•˜๋Š” ์„œ๋น„์Šค์—์„œ ์ž์ฒด์ ์œผ๋กœ ๊ด€๋ฆฌํ•˜๋Š” ์‹๋ณ„์ž ํ‚ค.\n\n๋‹ค๋งŒ ๊ณ ๊ฐ์ด๋ผ๊ธฐ๋ณด๋‹ค ์‹ค์ œ๋กœ๋Š” ์นด๋“œ์˜ ์‹๋ณ„์ž ํ‚ค๋กœ ์จ์•ผํ•จ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "nullable": false, + "required": [ + "merchant_uid", + "amount", + "name", + "customer_uid" + ], + "description": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ๋กœ ๊ฒฐ์ œ ์‹ ์ฒญ ์ž…๋ ฅ ์ •๋ณด.", + "x-typia-jsDocTags": [] + } + }, + "securitySchemes": { + "bearer": { + "type": "apiKey", + "name": "Authorization", + "in": "header" + } + } + } +} \ No newline at end of file diff --git a/assets/input/petstore.swagger.json b/assets/input/petstore.swagger.json new file mode 100644 index 0000000..06354c6 --- /dev/null +++ b/assets/input/petstore.swagger.json @@ -0,0 +1,1225 @@ +{ + "openapi": "3.0.2", + "info": { + "title": "Swagger Petstore - OpenAPI 3.0", + "description": "This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about\nSwagger at [http://swagger.io](http://swagger.io). In the third iteration of the pet store, we've switched to the design first approach!\nYou can now help us improve the API whether it's by making changes to the definition itself or to the code.\nThat way, with time, we can improve the API in general, and expose some of the new features in OAS3.\n\nSome useful links:\n- [The Pet Store repository](https://github.com/swagger-api/swagger-petstore)\n- [The source API definition for the Pet Store](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml)", + "termsOfService": "http://swagger.io/terms/", + "contact": { + "email": "apiteam@swagger.io" + }, + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0.html" + }, + "version": "1.0.17" + }, + "externalDocs": { + "description": "Find out more about Swagger", + "url": "http://swagger.io" + }, + "servers": [ + { + "url": "/api/v3" + } + ], + "tags": [ + { + "name": "pet", + "description": "Everything about your Pets", + "externalDocs": { + "description": "Find out more", + "url": "http://swagger.io" + } + }, + { + "name": "store", + "description": "Access to Petstore orders", + "externalDocs": { + "description": "Find out more about our store", + "url": "http://swagger.io" + } + }, + { + "name": "user", + "description": "Operations about user" + } + ], + "paths": { + "/pet": { + "put": { + "tags": [ + "pet" + ], + "summary": "Update an existing pet", + "description": "Update an existing pet by Id", + "operationId": "updatePet", + "requestBody": { + "description": "Update an existent pet in the store", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + } + } + }, + "400": { + "description": "Invalid ID supplied" + }, + "404": { + "description": "Pet not found" + }, + "405": { + "description": "Validation exception" + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + }, + "post": { + "tags": [ + "pet" + ], + "summary": "Add a new pet to the store", + "description": "Add a new pet to the store", + "operationId": "addPet", + "requestBody": { + "description": "Create a new pet in the store", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + } + } + }, + "405": { + "description": "Invalid input" + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + } + }, + "/pet/findByStatus": { + "get": { + "tags": [ + "pet" + ], + "summary": "Finds Pets by status", + "description": "Multiple status values can be provided with comma separated strings", + "operationId": "findPetsByStatus", + "parameters": [ + { + "name": "status", + "in": "query", + "description": "Status values that need to be considered for filter", + "required": false, + "explode": true, + "schema": { + "type": "string", + "default": "available", + "enum": [ + "available", + "pending", + "sold" + ] + } + } + ], + "responses": { + "200": { + "description": "successful operation", + "content": { + "application/xml": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Pet" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Pet" + } + } + } + } + }, + "400": { + "description": "Invalid status value" + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + } + }, + "/pet/findByTags": { + "get": { + "tags": [ + "pet" + ], + "summary": "Finds Pets by tags", + "description": "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.", + "operationId": "findPetsByTags", + "parameters": [ + { + "name": "tags", + "in": "query", + "description": "Tags to filter by", + "required": false, + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "successful operation", + "content": { + "application/xml": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Pet" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Pet" + } + } + } + } + }, + "400": { + "description": "Invalid tag value" + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + } + }, + "/pet/{petId}": { + "get": { + "tags": [ + "pet" + ], + "summary": "Find pet by ID", + "description": "Returns a single pet", + "operationId": "getPetById", + "parameters": [ + { + "name": "petId", + "in": "path", + "description": "ID of pet to return", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "successful operation", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + } + } + }, + "400": { + "description": "Invalid ID supplied" + }, + "404": { + "description": "Pet not found" + } + }, + "security": [ + { + "api_key": [] + }, + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + }, + "post": { + "tags": [ + "pet" + ], + "summary": "Updates a pet in the store with form data", + "description": "", + "operationId": "updatePetWithForm", + "parameters": [ + { + "name": "petId", + "in": "path", + "description": "ID of pet that needs to be updated", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "name", + "in": "query", + "description": "Name of pet that needs to be updated", + "schema": { + "type": "string" + } + }, + { + "name": "status", + "in": "query", + "description": "Status of pet that needs to be updated", + "schema": { + "type": "string" + } + } + ], + "responses": { + "405": { + "description": "Invalid input" + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + }, + "delete": { + "tags": [ + "pet" + ], + "summary": "Deletes a pet", + "description": "", + "operationId": "deletePet", + "parameters": [ + { + "name": "api_key", + "in": "header", + "description": "", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "petId", + "in": "path", + "description": "Pet id to delete", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "400": { + "description": "Invalid pet value" + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + } + }, + "/pet/{petId}/uploadImage": { + "post": { + "tags": [ + "pet" + ], + "summary": "uploads an image", + "description": "", + "operationId": "uploadFile", + "parameters": [ + { + "name": "petId", + "in": "path", + "description": "ID of pet to update", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "additionalMetadata", + "in": "query", + "description": "Additional Metadata", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + }, + "responses": { + "200": { + "description": "successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + } + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + } + }, + "/store/inventory": { + "get": { + "tags": [ + "store" + ], + "summary": "Returns pet inventories by status", + "description": "Returns a map of status codes to quantities", + "operationId": "getInventory", + "responses": { + "200": { + "description": "successful operation", + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "type": "integer", + "format": "int32" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/store/order": { + "post": { + "tags": [ + "store" + ], + "summary": "Place an order for a pet", + "description": "Place a new order in the store", + "operationId": "placeOrder", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Order" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Order" + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/Order" + } + } + } + }, + "responses": { + "200": { + "description": "successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Order" + } + } + } + }, + "405": { + "description": "Invalid input" + } + } + } + }, + "/store/order/{orderId}": { + "get": { + "tags": [ + "store" + ], + "summary": "Find purchase order by ID", + "description": "For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions.", + "operationId": "getOrderById", + "parameters": [ + { + "name": "orderId", + "in": "path", + "description": "ID of order that needs to be fetched", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "successful operation", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Order" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Order" + } + } + } + }, + "400": { + "description": "Invalid ID supplied" + }, + "404": { + "description": "Order not found" + } + } + }, + "delete": { + "tags": [ + "store" + ], + "summary": "Delete purchase order by ID", + "description": "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors", + "operationId": "deleteOrder", + "parameters": [ + { + "name": "orderId", + "in": "path", + "description": "ID of the order that needs to be deleted", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "400": { + "description": "Invalid ID supplied" + }, + "404": { + "description": "Order not found" + } + } + } + }, + "/user": { + "post": { + "tags": [ + "user" + ], + "summary": "Create user", + "description": "This can only be done by the logged in user.", + "operationId": "createUser", + "requestBody": { + "description": "Created user object", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "responses": { + "default": { + "description": "successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + } + } + } + }, + "/user/createWithList": { + "post": { + "tags": [ + "user" + ], + "summary": "Creates list of users with given input array", + "description": "Creates list of users with given input array", + "operationId": "createUsersWithListInput", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + } + } + } + }, + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "default": { + "description": "successful operation" + } + } + } + }, + "/user/login": { + "get": { + "tags": [ + "user" + ], + "summary": "Logs user into the system", + "description": "", + "operationId": "loginUser", + "parameters": [ + { + "name": "username", + "in": "query", + "description": "The user name for login", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "password", + "in": "query", + "description": "The password for login in clear text", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "successful operation", + "headers": { + "X-Rate-Limit": { + "description": "calls per hour allowed by the user", + "schema": { + "type": "integer", + "format": "int32" + } + }, + "X-Expires-After": { + "description": "date in UTC when token expires", + "schema": { + "type": "string", + "format": "date-time" + } + } + }, + "content": { + "application/xml": { + "schema": { + "type": "string" + } + }, + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "Invalid username/password supplied" + } + } + } + }, + "/user/logout": { + "get": { + "tags": [ + "user" + ], + "summary": "Logs out current logged in user session", + "description": "", + "operationId": "logoutUser", + "parameters": [], + "responses": { + "default": { + "description": "successful operation" + } + } + } + }, + "/user/{username}": { + "get": { + "tags": [ + "user" + ], + "summary": "Get user by user name", + "description": "", + "operationId": "getUserByName", + "parameters": [ + { + "name": "username", + "in": "path", + "description": "The name that needs to be fetched. Use user1 for testing. ", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "successful operation", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "400": { + "description": "Invalid username supplied" + }, + "404": { + "description": "User not found" + } + } + }, + "put": { + "tags": [ + "user" + ], + "summary": "Update user", + "description": "This can only be done by the logged in user.", + "operationId": "updateUser", + "parameters": [ + { + "name": "username", + "in": "path", + "description": "name that need to be deleted", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Update an existent user in the store", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "responses": { + "default": { + "description": "successful operation" + } + } + }, + "delete": { + "tags": [ + "user" + ], + "summary": "Delete user", + "description": "This can only be done by the logged in user.", + "operationId": "deleteUser", + "parameters": [ + { + "name": "username", + "in": "path", + "description": "The name that needs to be deleted", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "400": { + "description": "Invalid username supplied" + }, + "404": { + "description": "User not found" + } + } + } + } + }, + "components": { + "schemas": { + "Order": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 10 + }, + "petId": { + "type": "integer", + "format": "int64", + "example": 198772 + }, + "quantity": { + "type": "integer", + "format": "int32", + "example": 7 + }, + "shipDate": { + "type": "string", + "format": "date-time" + }, + "status": { + "type": "string", + "description": "Order Status", + "example": "approved", + "enum": [ + "placed", + "approved", + "delivered" + ] + }, + "complete": { + "type": "boolean" + } + }, + "xml": { + "name": "order" + } + }, + "Customer": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 100000 + }, + "username": { + "type": "string", + "example": "fehguy" + }, + "address": { + "type": "array", + "xml": { + "name": "addresses", + "wrapped": true + }, + "items": { + "$ref": "#/components/schemas/Address" + } + } + }, + "xml": { + "name": "customer" + } + }, + "Address": { + "type": "object", + "properties": { + "street": { + "type": "string", + "example": "437 Lytton" + }, + "city": { + "type": "string", + "example": "Palo Alto" + }, + "state": { + "type": "string", + "example": "CA" + }, + "zip": { + "type": "string", + "example": "94301" + } + }, + "xml": { + "name": "address" + } + }, + "Category": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "name": { + "type": "string", + "example": "Dogs" + } + }, + "xml": { + "name": "category" + } + }, + "User": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 10 + }, + "username": { + "type": "string", + "example": "theUser" + }, + "firstName": { + "type": "string", + "example": "John" + }, + "lastName": { + "type": "string", + "example": "James" + }, + "email": { + "type": "string", + "example": "john@email.com" + }, + "password": { + "type": "string", + "example": "12345" + }, + "phone": { + "type": "string", + "example": "12345" + }, + "userStatus": { + "type": "integer", + "description": "User Status", + "format": "int32", + "example": 1 + } + }, + "xml": { + "name": "user" + } + }, + "Tag": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + } + }, + "xml": { + "name": "tag" + } + }, + "Pet": { + "required": [ + "name", + "photoUrls" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 10 + }, + "name": { + "type": "string", + "example": "doggie" + }, + "category": { + "$ref": "#/components/schemas/Category" + }, + "photoUrls": { + "type": "array", + "xml": { + "wrapped": true + }, + "items": { + "type": "string", + "xml": { + "name": "photoUrl" + } + } + }, + "tags": { + "type": "array", + "xml": { + "wrapped": true + }, + "items": { + "$ref": "#/components/schemas/Tag" + } + }, + "status": { + "type": "string", + "description": "pet status in the store", + "enum": [ + "available", + "pending", + "sold" + ] + } + }, + "xml": { + "name": "pet" + } + }, + "ApiResponse": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "type": { + "type": "string" + }, + "message": { + "type": "string" + } + }, + "xml": { + "name": "##default" + } + } + }, + "requestBodies": { + "Pet": { + "description": "Pet object that needs to be added to the store", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + } + } + }, + "UserArray": { + "description": "List of user object", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + } + } + } + } + }, + "securitySchemes": { + "petstore_auth": { + "type": "oauth2", + "flows": { + "implicit": { + "authorizationUrl": "https://petstore3.swagger.io/oauth/authorize", + "scopes": { + "write:pets": "modify pets in your account", + "read:pets": "read your pets" + } + } + } + }, + "api_key": { + "type": "apiKey", + "name": "api_key", + "in": "header" + } + } + } +} \ No newline at end of file diff --git a/assets/input/toss.swagger.json b/assets/input/toss.swagger.json new file mode 100644 index 0000000..b9280da --- /dev/null +++ b/assets/input/toss.swagger.json @@ -0,0 +1,3471 @@ +{ + "openapi": "3.0.1", + "servers": [ + { + "url": "http://localhost:30771", + "description": "fake" + }, + { + "url": "https://api.tosspayments.com", + "description": "real" + } + ], + "info": { + "title": "Toss Payments API", + "description": "Built by [fake-toss-payments-server](https://github.com/samchon/fake-toss-payments-server) with [nestia](https://github.com/samchon/nestia)", + "version": "2.0.0", + "license": { + "name": "MIT" + } + }, + "paths": { + "/v1/billing/authorizations/card": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ๋“ฑ๋ก ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossBilling.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossBilling" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ๋“ฑ๋กํ•˜๊ธฐ", + "description": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ๋“ฑ๋กํ•˜๊ธฐ.\n\n`billing.authorizations.card.store` ๋Š” ๊ณ ๊ฐ์ด ์ž์‹ ์˜ ์‹ ๋ก ์นด๋“œ๋ฅผ ์„œ๋ฒ„์— ๋“ฑ๋กํ•ด๋‘๊ณ ,\n๋งค๋ฒˆ ๊ฒฐ์ œ๊ฐ€ ํ•„์š”ํ•  ๋•Œ๋งˆ๋‹ค ์นด๋“œ ์ •๋ณด๋ฅผ ๋ฐ˜๋ณต ์ž…๋ ฅํ•˜๋Š” ์ผ ์—†์ด ๊ฐ„ํŽธํ•˜๊ฒŒ ๊ฒฐ์ œ๋ฅผ\n์ง„ํ–‰ํ•˜๊ณ ์ž ํ•  ๋•Œ, ํ˜ธ์ถœ๋˜๋Š” API ํ•จ์ˆ˜์ด๋‹ค.\n\n์ฐธ๊ณ ๋กœ `billing.authorizations.card.store` ๋Š” ํด๋ผ์ด์–ธํŠธ ์–ดํ”Œ๋ฆฌ์ผ€์ด์…˜์ด ํ† ์Šค\nํŽ˜์ด๋จผ์ธ ๊ฐ€ ์ œ๊ณตํ•˜๋Š” ๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ๋“ฑ๋ก ์ฐฝ์„ ์‚ฌ์šฉํ•˜๋Š” ๊ฒฝ์šฐ, ๊ท€ํ•˜์˜ ๋ฐฑ์—”๋“œ ์„œ๋ฒ„๊ฐ€ ์ด๋ฅผ\n์‹ค ์„œ๋น„์Šค์—์„œ ํ˜ธ์ถœํ•˜๋Š” ์ผ์€ ์—†์„ ๊ฒƒ์ด๋‹ค. ๋‹ค๋งŒ, ๊ณ ๊ฐ์ด ๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ๋ฅผ ๋“ฑ๋กํ•˜๋Š”\n์ƒํ™ฉ์„ ์‹œ๋ฎฌ๋ ˆ์ด์…˜ํ•˜๊ธฐ ์œ„ํ•˜์—ฌ, ํ…Œ์ŠคํŠธ ์ž๋™ํ™” ํ”„๋กœ๊ทธ๋žจ ์ˆ˜์ค€์—์„œ ์‚ฌ์šฉ๋  ์ˆ˜๋Š” ์žˆ๋‹ค.", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.billing.authorizations.card.store", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ๋“ฑ๋ก ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/v1/billing/authorizations/{billingKey}": { + "post": { + "tags": [], + "parameters": [ + { + "name": "billingKey", + "in": "path", + "schema": { + "type": "string" + }, + "description": "๋Œ€์ƒ ์ •๋ณด์˜ ", + "required": true + } + ], + "requestBody": { + "description": "๊ณ ๊ฐ ์‹๋ณ„์ž ํ‚ค", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossBilling.ICustomerKey" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์ˆ˜๋‹จ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossBilling" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "๊ฐ„ํŽธ ๊ฒฐ์ œ๋กœ ๋“ฑ๋กํ•œ ์ˆ˜๋‹จ ์กฐํšŒํ•˜๊ธฐ", + "description": "๊ฐ„ํŽธ ๊ฒฐ์ œ๋กœ ๋“ฑ๋กํ•œ ์ˆ˜๋‹จ ์กฐํšŒํ•˜๊ธฐ.\n\n`billing.authorizations.at` ์€ ๊ณ ๊ฐ์ด ๊ฐ„ํŽธ ๊ฒฐ์ œ๋ฅผ ์œ„ํ•˜์—ฌ ํ† ์Šค ํŽ˜์ด๋จผ์ธ  ์„œ๋ฒ„์—\n๋“ฑ๋กํ•œ ๊ฒฐ์ œ ์ˆ˜๋‹จ์„ ์กฐํšŒํ•˜๋Š” ํ•จ์ˆ˜์ด๋‹ค.\n\n์ฃผ๋กœ ํด๋ผ์ด์–ธํŠธ ์–ดํ”Œ๋ฆฌ์ผ€์ด์…˜์ด ํ† ์Šค ํŽ˜์ด๋จผ์ธ ๊ฐ€ ์ž์ฒด์ ์œผ๋กœ ์ œ๊ณตํ•˜๋Š” ๊ฒฐ์ œ ์ฐฝ์„ ์‚ฌ์šฉํ•˜๋Š”\n๊ฒฝ์šฐ, ๊ทธ๋ž˜์„œ ํ”„๋ก ํŠธ ์–ดํ”Œ๋ฆฌ์ผ€์ด์…˜์ด ๊ท€ํ•˜์˜ ๋ฐฑ์—”๋“œ ์„œ๋ฒ„์— `billingKey` ์™€` customerKey`\n๋งŒ์„ ์ „๋‹ฌํ•ด์ฃผ์–ด, ์ƒ์„ธ ๊ฐ„ํŽธ ๊ฒฐ์ œ ์ˆ˜๋‹จ ์ •๋ณด๊ฐ€ ํ•„์š”ํ•  ๋•Œ ์‚ฌ์šฉํ•œ๋‹ค.", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.billing.authorizations.at", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "billingKey", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋Œ€์ƒ ์ •๋ณด์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "ITossBilling.billingKey", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-toss-payments-server/src/api/structures/ITossBilling.ts", + "textSpan": { + "start": 500, + "length": 19 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ณ ๊ฐ ์‹๋ณ„์ž ํ‚ค", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์ˆ˜๋‹จ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/v1/billing/{billingKey}": { + "post": { + "tags": [], + "parameters": [ + { + "name": "billingKey", + "in": "path", + "schema": { + "type": "string" + }, + "description": "๊ฐ„ํŽธ ๊ฒฐ์ œ์— ๋“ฑ๋กํ•œ ์ˆ˜๋‹จ์˜ ", + "required": true + } + ], + "requestBody": { + "description": "์ฃผ๋ฌธ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossBilling.IPaymentStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "๊ฒฐ์ œ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossPayment" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "๊ฐ„ํŽธ ๊ฒฐ์ œ์— ๋“ฑ๋กํ•œ ์ˆ˜๋‹จ์œผ๋กœ ๊ฒฐ์ œํ•˜๊ธฐ", + "description": "๊ฐ„ํŽธ ๊ฒฐ์ œ์— ๋“ฑ๋กํ•œ ์ˆ˜๋‹จ์œผ๋กœ ๊ฒฐ์ œํ•˜๊ธฐ.\n\n`billing.pay` ๋Š” ๊ฐ„ํŽธ ๊ฒฐ์ œ์— ๋“ฑ๋กํ•œ ์ˆ˜๋‹จ์œผ๋กœ ๊ฒฐ์ œ๋ฅผ ์ง„ํ–‰ํ•˜๊ณ ์ž ํ•  ๋•Œ ํ˜ธ์ถœํ•˜๋Š” API\nํ•จ์ˆ˜์ด๋‹ค.\n\n๊ทธ๋ฆฌ๊ณ  `billing.pay` ๋Š” ๊ฒฐ์ œ ์ˆ˜๋‹จ ์ค‘ ์œ ์ผํ•˜๊ฒŒ, ํด๋ผ์ด์–ธํŠธ ์–ดํ”Œ๋ฆฌ์ผ€์ด์…˜์ด ํ† ์Šค\nํŽ˜์ด๋จผ์ธ ๊ฐ€ ์ œ๊ณตํ•˜๋Š” ๊ฒฐ์ œ ์ฐฝ์„ ์‚ฌ์šฉํ•  ์ˆ˜ ์—†์–ด, ๊ท€ํ•˜์˜ ๋ฐฑ์—”๋“œ ์„œ๋ฒ„๊ฐ€ ํ† ์Šค ํŽ˜์ด๋จผ์ธ ์˜\nAPI ํ•จ์ˆ˜๋ฅผ ์ง์ ‘ ํ˜ธ์ถœํ•ด์•ผ ํ•˜๋Š” ๊ฒฝ์šฐ์— ํ•ด๋‹นํ•œ๋‹ค. ๋”ฐ๋ผ์„œ ๊ฐ„ํŽธ ๊ฒฐ์ œ์— ๊ด€๋ จํ•˜์—ฌ ํ† ์Šค\nํŽ˜์ด๋จผ์ธ ์™€ ์—ฐ๋™ํ•˜๋Š” ๋ฐฑ์—”๋“œ ์„œ๋ฒ„ ๋ฐ ํ”„๋ก ํŠธ ์–ดํ”Œ๋ฆฌ์ผ€์ด์…˜์„ ๊ฐœ๋ฐœํ•  ๋•Œ, ๋ฐ˜๋“œ์‹œ ์ด ์ƒํ™ฉ์—\n๋Œ€ํ•œ ๋ณ„๋„์˜ ์„ค๊ณ„ ๋ฐ ๊ฐœ๋ฐœ์ด ํ•„์š”ํ•˜๋‹ˆ, ์ด ์ ์„ ์—ผ๋‘์— ๋‘๊ธฐ ๋ฐ”๋ž€๋‹ค.\n\n๋”ํ•˜์—ฌ `billing.pay` ๋Š” ์ฒ ์ €ํžˆ ๊ท€์‚ฌ ๋ฐฑ์—”๋“œ ์„œ๋ฒ„์˜ ํŒ๋‹จ ์•„๋ž˜ ํ˜ธ์ถœ๋˜๋Š” API ํ•จ์ˆ˜์ธ์ง€๋ผ,\n์ด๋ฅผ ํ†ตํ•˜์—ฌ ์ด๋ฃจ์–ด์ง€๋Š” ๊ฒฐ์ œ๋Š” ์ผ์ ˆ {@link payments.approve } ๊ฐ€ ํ•„์š” ์—†๋‹ค. ๋‹ค๋งŒ\n`billing.pay` ๋Š” ์ด์ฒ˜๋Ÿผ ๋ถ€์ฐจ์ ์ธ ์Šน์ธ ๊ณผ์ • ํ•„์š”์—†์ด ๊ทธ ์ฆ‰์‹œ๋กœ ๊ฒฐ์ œ๊ฐ€ ์™„์„ฑ๋˜๋‹ˆ, ์ด๋ฅผ\nํ˜ธ์ถœํ•˜๋Š” ์ƒํ™ฉ์— ๋Œ€ํ•˜์—ฌ ์„ธ์‹ฌํžˆ ์ฃผ์˜๋ฅผ ๊ธฐ์šธ์ผ ํ•„์š”๊ฐ€ ์žˆ๋‹ค", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.billing.pay", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "billingKey", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฐ„ํŽธ ๊ฒฐ์ œ์— ๋“ฑ๋กํ•œ ์ˆ˜๋‹จ์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "ITossBilling.billingKey", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-toss-payments-server/src/api/structures/ITossBilling.ts", + "textSpan": { + "start": 500, + "length": 19 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์ฃผ๋ฌธ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/v1/cash-receipts": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "์ž…๋ ฅ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossCashReceipt.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossCashReceipt" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ๋ฐœํ–‰ํ•˜๊ธฐ", + "description": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ๋ฐœํ–‰ํ•˜๊ธฐ.", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.cash-receipts.store", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/v1/cash-receipts/{receiptKey}/cancel": { + "post": { + "tags": [], + "parameters": [ + { + "name": "receiptKey", + "in": "path", + "schema": { + "type": "string" + }, + "description": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ์˜ ", + "required": true + } + ], + "requestBody": { + "description": "์ทจ์†Œ ์ž…๋ ฅ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossCashReceipt.ICancel" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "์ทจ์†Œ๋œ ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossCashReceipt" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ทจ์†Œํ•˜๊ธฐ", + "description": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ทจ์†Œํ•˜๊ธฐ.", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.cash-receipts.cancel.cancel", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "receiptKey", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "ITossCashReceipt.receiptKey", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-toss-payments-server/src/api/structures/ITossCashReceipt.ts", + "textSpan": { + "start": 199, + "length": 19 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์ทจ์†Œ ์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์ทจ์†Œ๋œ ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/internal/webhook": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "์›นํ›… ์ด๋ฒคํŠธ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossPaymentWebhook" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "", + "x-nestia-encrypted": false + } + }, + "summary": "์›นํ›… ์ด๋ฒคํŠธ ๋”๋ฏธ ๋ฆฌ์Šค๋„ˆ", + "description": "์›นํ›… ์ด๋ฒคํŠธ ๋”๋ฏธ ๋ฆฌ์Šค๋„ˆ.\n\n`internal.webhook` ์€ ์‹ค์ œ ํ† ์Šค ํŽ˜์ด๋จผ์ธ ์˜ ๊ฒฐ์ œ ์„œ๋ฒ„์—๋Š” ์กด์žฌํ•˜์ง€ ์•Š๋Š” API ๋กœ์จ,\n`fake-toss-payments-server` ์˜ {@link Configuration.WEBHOOK_URL } ์— ์•„๋ฌด๋Ÿฐ URL ์„\n์„ค์ •ํ•˜์ง€ ์•Š์œผ๋ฉด, `fake-toss-payments-server` ๋กœ๋ถ€ํ„ฐ ๋ฐœ์ƒํ•˜๋Š” ๋ชจ๋“  ์ข…๋ฅ˜์˜ ์›นํ›…\n์ด๋ฒคํŠธ๋Š” ์ด ๊ณณ์œผ๋กœ ์ „๋‹ฌ๋˜์–ด ๋ฌด์˜๋ฏธํ•˜๊ฒŒ ์‚ฌ๋ผ์ง„๋‹ค.\n\n๋”ฐ๋ผ์„œ `fake-toss-payments-server` ๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ํ† ์Šค ํŽ˜์ด๋จผ์ธ  ์„œ๋ฒ„์™€์˜ ์—ฐ๋™์„ ๋ฏธ๋ฆฌ\n๊ฒ€์ฆ์ฝ”์ž ํ•  ๋•Œ๋Š”, ๋ฐ˜๋“œ์‹œ {@link Configuration.WEBHOOK_URL } ๋ฅผ ์„ค์ •ํ•˜์—ฌ ์›นํ›…\n์ด๋ฒคํŠธ๊ฐ€ ๊ท€ํ•˜์˜ ๋ฐฑ์—”๋“œ ์„œ๋ฒ„๋กœ ์ œ๋Œ€๋กœ ์ „๋‹ฌ๋˜๋„๋ก ํ•˜์ž.", + "x-nestia-namespace": "internal.webhook.webhook", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์›นํ›… ์ด๋ฒคํŠธ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/internal/{paymentKey}/deposit": { + "get": { + "tags": [], + "parameters": [ + { + "name": "paymentKey", + "in": "path", + "schema": { + "type": "string" + }, + "description": "๋Œ€์ƒ ๊ฐ€์ƒ ๊ณ„์ขŒ ๊ฒฐ์ œ ์ •๋ณด์˜ ", + "required": true + } + ], + "responses": { + "200": { + "description": "์ž…๊ธˆ ์™„๋ฃŒ๋œ ๊ฐ€์ƒ ๊ผ์ขŒ ๊ฒฐ์ œ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossPayment" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "๊ฐ€์ƒ ๊ณ„์ขŒ์— ์ž…๊ธˆํ•˜๊ธฐ", + "description": "๊ฐ€์ƒ ๊ณ„์ขŒ์— ์ž…๊ธˆํ•˜๊ธฐ.\n\n`internal.virtual_accounts.deposit` ์€ ์‹ค์ œ ํ† ์Šค ํŽ˜์ด๋จผ์ธ ์˜ ๊ฒฐ์ œ ์„œ๋ฒ„์—๋Š” ์กด์žฌํ•˜์ง€\n์•Š๋Š” API ๋กœ์จ, ๊ฐ€์ƒ ๊ณ„์ขŒ ๊ฒฐ์ œ๋ฅผ ์‹ ์ฒญํ•œ ๊ณ ๊ฐ์ด, ์ดํ›„ ๊ฐ€์ƒ ๊ณ„์ขŒ์— ๋ชฉํ‘œ ๊ธˆ์•ก์„ ์ž…๊ธˆํ•˜๋Š”\n์ƒํ™ฉ์„ ์‹œ๋ฎฌ๋ ˆ์ด์…˜ํ•  ์ˆ˜ ์žˆ๋Š” ํ•จ์ˆ˜์ด๋‹ค.\n\n์ฆ‰ `internal.virtual_accounts.deposit` ๋Š” ๊ณ ๊ฐ์ด ์Šค์Šค๋กœ์—๊ฒŒ ๊ฐ€์ƒ์œผ๋กœ ๋ฐœ๊ธ‰๋œ ๊ณ„์ขŒ์—\n์ž…๊ธˆ์„ ํ•˜๊ณ , ๊ทธ์— ๋”ฐ๋ผ ํ† ์Šค ํŽ˜์ด๋จผ์ธ  ์„œ๋ฒ„์—์„œ webhook ์ด๋ฒคํŠธ๊ฐ€ ๋ฐœ์ƒํ•˜์—ฌ ์ด๋ฅผ ๊ท€ํ•˜์˜\n๋ฐฑ์—”๋“œ ์„œ๋ฒ„๋กœ ์ „์†กํ•˜๋Š” ์ผ๋ จ์˜ ์ƒํ™ฉ์„ ํ…Œ์ŠคํŠธํ•˜๊ธฐ ์œ„ํ•œ ํ•จ์ˆ˜์ธ ์…ˆ์ด๋‹ค.", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "internal.deposit.deposit", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "paymentKey", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋Œ€์ƒ ๊ฐ€์ƒ ๊ณ„์ขŒ ๊ฒฐ์ œ ์ •๋ณด์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "ITossPayment.paymentKey", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-toss-payments-server/src/api/structures/ITossPayment.ts", + "textSpan": { + "start": 2480, + "length": 19 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์ž…๊ธˆ ์™„๋ฃŒ๋œ ๊ฐ€์ƒ ๊ผ์ขŒ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "GET" + } + }, + "/v1/payments/{paymentKey}": { + "get": { + "tags": [], + "parameters": [ + { + "name": "paymentKey", + "in": "path", + "schema": { + "type": "string" + }, + "description": "๊ฒฐ์ œ ์ •๋ณด์˜ ", + "required": true + } + ], + "responses": { + "200": { + "description": "๊ฒฐ์ œ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossPayment" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "๊ฒฐ์ œ ์ •๋ณด ์กฐํšŒํ•˜๊ธฐ", + "description": "๊ฒฐ์ œ ์ •๋ณด ์กฐํšŒํ•˜๊ธฐ.\n\n`payments.at` ์€ ๊ฒฐ์ œ ์ •๋ณด๋ฅผ ์กฐํšŒํ•˜๋Š” ํ•จ์ˆ˜์ด๋‹ค.\n\n์ฃผ๋กœ ํด๋ผ์ด์–ธํŠธ ์–ดํ”Œ๋ฆฌ์ผ€์ด์…˜์ด ํ† ์Šค ํŽ˜์ด๋จผ์ธ ๊ฐ€ ์ž์ฒด์ ์œผ๋กœ ์ œ๊ณตํ•˜๋Š” ๊ฒฐ์ œ ์ฐฝ์„ ์‚ฌ์šฉํ•˜๋Š”\n๊ฒฝ์šฐ, ๊ทธ๋ž˜์„œ ํ”„๋ก ํŠธ ์–ดํ”Œ๋ฆฌ์ผ€์ด์…˜์ด ๊ท€ํ•˜์˜ ๋ฐฑ์—”๋“œ ์„œ๋ฒ„์— `paymentKey` ๋“ฑ ๊ทนํžˆ ์ผ๋ถ€์˜\n์‹๋ณ„์ž ์ •๋ณด๋งŒ์„ ์ „๋‹ฌํ•ด์ฃผ์–ด, ์ƒ์„ธ ๊ฒฐ์ œ ์ •๋ณด๊ฐ€ ํ•„์š”ํ•  ๋•Œ ์‚ฌ์šฉํ•œ๋‹ค.\n\n์ฐธ๊ณ ๋กœ ํ† ์Šค ํŽ˜์ด๋จผ์ธ ๋Š” ๋‹ค๋ฅธ ๊ฒฐ์ œ PG ์‚ฌ๋“ค๊ณผ ๋‹ค๋ฅด๊ฒŒ, ํด๋ผ์ด์–ธํŠธ ์–ดํ”Œ๋ฆฌ์ผ€์ด์…˜์—์„œ ํ† ์Šค\nํŽ˜์ด๋จผ์ธ ์˜ ๊ฒฐ์ œ ์ฐฝ์„ ์ด์šฉํ•˜์—ฌ ์ง„ํ–‰ํ•œ ๊ฒฐ์ œ๊ฐ€ ๋ฐ”๋กœ ํ™•์ •๋˜๋Š” ๊ฒƒ์€ ์•„๋‹ˆ๋‹ค. ๊ท€์‚ฌ์˜ ๋ฐฑ์—”๋“œ\n์„œ๋ฒ„๊ฐ€ ํ˜„์žฌ์˜ `payments.at` ์„ ํ†ตํ•˜์—ฌ ํ•ด๋‹น ๊ฒฐ์ œ ์ •๋ณด๋ฅผ ํ™•์ธํ•˜๊ณ , {@link approve } ๋ฅผ\nํ˜ธ์ถœํ•˜์—ฌ ์ง์ ‘ ์Šน์ธํ•˜๊ธฐ ์ „๊นŒ์ง€, ํ•ด๋‹น ๊ฒฐ์ œ๋Š” ํ™•์ •๋˜์ง€ ์•Š์œผ๋‹ˆ, ์ด ์ ์— ์œ ์˜ํ•˜๊ธฐ ๋ฐ”๋ž€๋‹ค.", + "x-nestia-namespace": "v1.payments.at", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "paymentKey", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฒฐ์ œ ์ •๋ณด์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "ITossPayment.paymentKey", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-toss-payments-server/src/api/structures/ITossPayment.ts", + "textSpan": { + "start": 2480, + "length": 19 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "GET" + }, + "post": { + "tags": [], + "parameters": [ + { + "name": "paymentKey", + "in": "path", + "schema": { + "type": "string" + }, + "description": "๋Œ€์ƒ ๊ฒฐ์ œ์˜ ", + "required": true + } + ], + "requestBody": { + "description": "์ฃผ๋ฌธ ์ •๋ณด ํ™•์ธ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossPayment.IApproval" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "์Šน์ธ๋œ ๊ฒฐ์ œ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossPayment" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "๊ฒฐ์ œ ์Šน์ธํ•˜๊ธฐ", + "description": "๊ฒฐ์ œ ์Šน์ธํ•˜๊ธฐ.\n\nํ† ์Šค ํŽ˜์ด๋จผ์ธ ๋Š” ๊ท€์‚ฌ์˜ ๋ฐฑ์—”๋“œ์—์„œ ์ผ์–ด๋‚œ ๊ฒฐ์ œ๊ฐ€ ์•„๋‹Œ ํ”„๋ก ํŠธ ์–ดํ”Œ๋ฆฌ์ผ€์ด์…˜์˜ ๊ฒฐ์ œ ์ฐฝ์—์„œ\n์ด๋ฃจ์–ด์ง„ ๊ฒฐ์ œ์˜ ๊ฒฝ์šฐ, ํ•ด๋‹น ์„œ๋น„์Šค์œผ ๋ฐฑ์—”๋“œ ์„œ๋ฒ„๋กœ๋ถ€ํ„ฐ ๊ฒฐ์ œ๋ฅผ ์Šน์ธ๋ฐ›๊ธฐ ์ „๊นŒ์ง€, ์ด๋ฅผ\nํ™•์ •ํ•˜์ง€ ์•Š๋Š”๋‹ค. `payments.approve` ๋Š” ๋ฐ”๋กœ ์ด๋Ÿฌํ•œ ์ƒํ™ฉ์—์„œ, ํ•ด๋‹น ๊ฒฐ์ œ๋ฅผ ์Šน์ธํ•ด์ฃผ๋Š”\nํ•จ์ˆ˜์ด๋‹ค.\n\n๋งŒ์ผ ๊ท€ํ•˜๊ฐ€ `fake-toss-payments-server` ๋ฅผ ์ด์šฉํ•˜์—ฌ ๊ฒฐ์ œ๋ฅผ ์‹œ๋ฎฌ๋ ˆ์ด์…˜ํ•˜๋Š” ๊ฒฝ์šฐ๋ผ๋ฉด,\n๊ฒฐ์ œ ๊ด€๋ จ API ๋ฅผ ํ˜ธ์ถœํ•จ์— ์žˆ์–ด {@link ITossCardPayment.IStore.__approved } ๋‚ด์ง€\n{@link ITossVirtualAccountPayment.IStore.__approved } ๋ฅผ `false` ๋กœ ํ•จ์œผ๋กœ์จ, ๋ณ„๋„\n์Šน์ธ์ด ํ•„์š”ํ•œ ์ด๋Ÿฌํ•œ ์ƒํ™ฉ์„ ์‹œ๋ฎฌ๋ ˆ์ด์…˜ ํ•  ์ˆ˜ ์žˆ๋‹ค.", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.payments.approve", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "paymentKey", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋Œ€์ƒ ๊ฒฐ์ œ์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "ITossPayment.paymentKey", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-toss-payments-server/src/api/structures/ITossPayment.ts", + "textSpan": { + "start": 2480, + "length": 19 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์ฃผ๋ฌธ ์ •๋ณด ํ™•์ธ", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์Šน์ธ๋œ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/v1/payments/key-in": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "์นด๋“œ ๊ฒฐ์ œ ์ž…๋ ฅ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossCardPayment.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "์นด๋“œ ๊ฒฐ์ œ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossCardPayment" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "์นด๋“œ๋กœ ๊ฒฐ์ œํ•˜๊ธฐ", + "description": "์นด๋“œ๋กœ ๊ฒฐ์ œํ•˜๊ธฐ.\n\n`payments.key_in` ์€ ์นด๋“œ๋ฅผ ์ด์šฉํ•œ ๊ฒฐ์ œ๋ฅผ ํ•  ๋•Œ ํ˜ธ์ถœ๋˜๋Š” API ํ•จ์ˆ˜์ด๋‹ค.\n\n์ฐธ๊ณ ๋กœ `payments.key_in` ๋Š” ํด๋ผ์ด์–ธํŠธ ์–ดํ”Œ๋ฆฌ์ผ€์ด์…˜์ด ํ† ์Šค ํŽ˜์ด๋จผ์ธ ๊ฐ€ ์ž์ฒด์ ์œผ๋กœ\n์ œ๊ณตํ•˜๋Š” ๊ฒฐ์ œ ์ฐฝ์„ ์‚ฌ์šฉํ•˜๋Š” ๊ฒฝ์šฐ, ๊ท€ํ•˜์˜ ๋ฐฑ์—”๋“œ ์„œ๋ฒ„๊ฐ€ ์ด๋ฅผ ์‹ค ์„œ๋น„์Šค์—์„œ ํ˜ธ์ถœํ•˜๋Š”\n์ผ์€ ์—†์„ ๊ฒƒ์ด๋‹ค. ๋‹ค๋งŒ, ๊ณ ๊ฐ์ด ์นด๋“œ๋ฅผ ํ†ตํ•˜์—ฌ ๊ฒฐ์ œํ•˜๋Š” ์ƒํ™ฉ์„ ์‹œ๋ฎฌ๋ ˆ์ด์…˜ํ•˜๊ธฐ ์œ„ํ•˜์—ฌ,\nํ…Œ์ŠคํŠธ ์ž๋™ํ™” ํ”„๋กœ๊ทธ๋žจ ์ˆ˜์ค€์—์„œ ์‚ฌ์šฉ๋  ์ˆ˜๋Š” ์žˆ๋‹ค.\n\n๊ทธ๋ฆฌ๊ณ  ๊ท€ํ•˜์˜ ๋ฐฑ์—”๋“œ ์„œ๋ฒ„๊ฐ€ `payments.key-in` ์„ ์ง์ ‘ ํ˜ธ์ถœํ•˜๋Š” ๊ฒฝ์šฐ, ํ† ์Šค ํŽ˜์ด๋จผ์ธ \n์„œ๋ฒ„๋Š” ์ด๋ฅผ ์™„์ „ํžˆ ์Šน์ธ๋œ ๊ฒฐ์ œ๋กœ ๋ณด๊ณ  ๋ฐ”๋กœ ํ™•์ •ํ•œ๋‹ค. ๋•Œ๋ฌธ์— `payments.key-in` ์„\n์ง์ ‘ ํ˜ธ์ถœํ•˜๋Š” ๊ฒฝ์šฐ, ํ† ์Šค ํŽ˜์ด๋จผ์ธ ์˜ ๊ฒฐ์ œ ์ฐฝ์„ ์ด์šฉํ•˜์—ฌ ๋ณ„๋„์˜ {@link approve } ๊ฐ€\nํ•„์š”ํ•œ ๋•Œ ๋Œ€๋น„, ํ›จ์”ฌ ๋” ์„ธ์‹ฌํ•œ ์ฃผ์˜๊ฐ€ ์š”๊ตฌ๋œ๋‹ค.\n\n๋”ํ•˜์—ฌ ๋งŒ์•ฝ ๊ท€ํ•˜์˜ ๋ฐฑ์—”๋“œ ์„œ๋ฒ„๊ฐ€ `fake-toss-payments-server` ๋ฅผ ์ด์šฉํ•˜์—ฌ ๊ณ ๊ฐ์˜\n์นด๋“œ ๊ฒฐ์ œ๋ฅผ ์‹œ๋ฎฌ๋ ˆ์ด์…˜ํ•˜๋Š” ๊ฒฝ์šฐ, {@link ITossCardPayment.IStore.__approved } ๊ฐ’์„\n`false` ๋กœ ํ•˜์—ฌ ์นด๋“œ ๊ฒฐ์ œ์˜ ํ™•์ •์„ ๊ณ ์˜๋กœ ํšŒํ”ผํ•  ์ˆ˜ ์žˆ๋‹ค. ์ด๋ฅผ ํ†ตํ•˜์—ฌ ํ† ์Šค\nํŽ˜์ด๋จผ์ธ ์˜ ๊ฒฐ์ œ ์ฐฝ์„ ์ด์šฉํ•œ ์นด๋“œ ๊ฒฐ์ œ์˜ ๊ฒฝ์šฐ, ๋ณ„๋„์˜ {@link approve } ๊ฐ€ ํ•„์š”ํ•œ\n์ƒํ™ฉ์„ ์‹œ๋ฎฌ๋ ˆ์ด์…˜ ํ•  ์ˆ˜ ์žˆ๋‹ค.", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.payments.key-in.key_in", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์นด๋“œ ๊ฒฐ์ œ ์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์นด๋“œ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/v1/payments/{paymentKey}/cancel": { + "post": { + "tags": [], + "parameters": [ + { + "name": "paymentKey", + "in": "path", + "schema": { + "type": "string" + }, + "description": "๊ฒฐ์ œ ์ •๋ณด์˜ ", + "required": true + } + ], + "requestBody": { + "description": "์ทจ์†Œ ์ž…๋ ฅ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossPaymentCancel.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "์ทจ์†Œ๋œ ๊ฒฐ์ œ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossPayment" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "๊ฒฐ์ œ ์ทจ์†Œํ•˜๊ธฐ", + "description": "๊ฒฐ์ œ ์ทจ์†Œํ•˜๊ธฐ.\n\n`payments.cancel` ์€ ๊ฒฐ์ œ๋ฅผ ์ทจ์†Œํ•˜๋Š” API ์ด๋‹ค.\n\n๊ฒฐ์ œ ์ทจ์†Œ ์ž…๋ ฅ ์ •๋ณด {@link ITossPaymentCancel.IStore } ์—๋Š” ์ทจ์†Œ ์‚ฌ์œ ๋ฅผ ๋น„๋กฏํ•˜์—ฌ,\n๊ณ ๊ฐ์—๊ฒŒ ํ™˜๋ถˆํ•ด ์ค„ ๊ธˆ์•ก๊ณผ ๋ถ€๊ฐ€์„ธ ๋ฐ ํ•„์š”์‹œ ํ™˜๋ถˆ ๊ณ„์ขŒ ์ •๋ณด ๋“ฑ์„ ์ž…๋ ฅํ•˜๊ฒŒ ๋˜์–ด์žˆ๋‹ค.", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.payments.cancel.cancel", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "paymentKey", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฒฐ์ œ ์ •๋ณด์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "ITossPayment.paymentKey", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-toss-payments-server/src/api/structures/ITossPayment.ts", + "textSpan": { + "start": 2480, + "length": 19 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์ทจ์†Œ ์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์ทจ์†Œ๋œ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/v1/virtual-accounts": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "๊ฐ€์ƒ ๊ฒฐ์ œ ์‹ ์ฒญ ์ •๋ณด.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossVirtualAccountPayment.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "๊ฐ€์ƒ ๊ณ„์ขŒ ๊ฒฐ์ œ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossVirtualAccountPayment" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "๊ฐ€์ƒ ๊ณ„์ขŒ๋กœ ๊ฒฐ์ œ ์‹ ์ฒญํ•˜๊ธฐ", + "description": "๊ฐ€์ƒ ๊ณ„์ขŒ๋กœ ๊ฒฐ์ œ ์‹ ์ฒญํ•˜๊ธฐ.\n\n`virtual_accounts.store` ๋Š” ๊ณ ๊ฐ์ด ๊ฒฐ์ œ ์ˆ˜๋‹จ์„ ๊ฐ€์ƒ ๊ณ„์ขŒ๋กœ ์„ ํƒํ•˜๋Š” ๊ฒฝ์šฐ์— ํ˜ธ์ถœ๋˜๋Š”\nAPI ํ•จ์ˆ˜์ด๋‹ค. ๋ฌผ๋ก  ๊ณ ๊ฐ์ด ์ด์ฒ˜๋Ÿผ ๊ฐ€์ƒ ๊ณ„์ขŒ๋ฅผ ์„ ํƒํ•œ ๊ฒฝ์šฐ, ๊ณ ๊ฐ์ด ์ง€์ •๋œ ๊ณ„์ขŒ์— ๋ˆ์„\n์ž…๊ธˆํ•˜๊ธฐ ์ „๊นŒ์ง€๋Š” ๊ฒฐ์ œ๊ฐ€ ๋งˆ๋ฌด๋ฆฌ๋œ ๊ฒƒ์ด ์•„๋‹ˆ๊ธฐ์—, {@link ITossPayment.status } ๊ฐ’์€\n`WAITING_FOR_DEPOSIT` ์ด ๋œ๋‹ค.\n\n์ฐธ๊ณ ๋กœ `virtual_accounts.store` ๋Š” ํด๋ผ์ด์–ธํŠธ ์–ดํ”Œ๋ฆฌ์ผ€์ด์…˜์ด ํ† ์Šค ํŽ˜์ด๋จผ์ธ ๊ฐ€\n์ž์ฒด์ ์œผ๋กœ ์ œ๊ณตํ•˜๋Š” ๊ฒฐ์ œ ์ฐฝ์„ ์‚ฌ์šฉํ•˜๋Š” ๊ฒฝ์šฐ, ๊ท€ํ•˜์˜ ๋ฐฑ์—”๋“œ ์„œ๋ฒ„๊ฐ€ ์ด๋ฅผ ์‹ค ์„œ๋น„์Šค์—์„œ\nํ˜ธ์ถœํ•˜๋Š” ์ผ์€ ์—†์„ ๊ฒƒ์ด๋‹ค. ๋‹ค๋งŒ, ๊ณ ๊ฐ์ด ๊ฐ€์ƒ ๊ณ„์ขŒ๋กœ ๊ฒฐ์ œ๋ฅผ ์ง„ํ–‰ํ•˜๋Š” ์ƒํ™ฉ์„\n์‹œ๋ฎฌ๋ ˆ์ด์…˜ํ•˜๊ธฐ ์œ„ํ•˜์—ฌ, ํ…Œ์ŠคํŠธ ์ž๋™ํ™” ํ”„๋กœ๊ทธ๋žจ ์ˆ˜์ค€์—์„œ ์‚ฌ์šฉ๋  ์ˆ˜๋Š” ์žˆ๋‹ค.\n\n๊ทธ๋ฆฌ๊ณ  `virtual_accounts.store` ์ดํ›„์— ๊ณ ๊ฐ์ด ์ง€์ •๋œ ๊ณ„์ขŒ์— ๊ธˆ์•ก์„ ์ž…๊ธˆํ•˜๊ฑฐ๋“ , ํ† ์Šค\nํŽ˜์ด๋จผ์ธ  ์„œ๋ฒ„๋กœ๋ถ€ํ„ฐ ์›นํ›… ์ด๋ฒคํŠธ๊ฐ€ ๋ฐœ์ƒ๋˜์–ด ๊ท€ํ•˜์˜ ๋ฐฑ์—”๋“œ ์„œ๋ฒ„๋กœ ์ „์†ก๋œ๋‹ค. ๋งŒ์•ฝ ์—ฐ๋™\n๋Œ€์ƒ ํ† ์Šค ํŽ˜์ด๋จผ์ธ  ์„œ๋ฒ„๊ฐ€ ์‹ค์ œ๊ฐ€ ์•„๋‹Œ `fake-toss-payments-server` ๋ผ๋ฉด,\n{@link internal.virtual_accounts.deposit } ๋ฅผ ํ˜ธ์ถœํ•˜์—ฌ, ๊ณ ๊ฐ์ด ๊ฐ€์ƒ ๊ณ„์ขŒ์— ์ž…๊ธˆํ•˜๋Š”\n์ƒํ™ฉ์„ ์‹œ๋ฎฌ๋ ˆ์ด์…˜ ํ•  ์ˆ˜ ์žˆ๋‹ค.", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.virtual-accounts.store", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฐ€์ƒ ๊ฒฐ์ œ ์‹ ์ฒญ ์ •๋ณด.", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฐ€์ƒ ๊ณ„์ขŒ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + } + }, + "components": { + "schemas": { + "ITossBilling.IStore": { + "type": "object", + "properties": { + "cardNumber": { + "description": "์นด๋“œ ๋ฒˆํ˜ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "[0-9]{16}" + }, + "cardExpirationYear": { + "description": "์นด๋“œ ๋งŒ๋ฃŒ ๋…„๋„ (2 ์ž๋ฆฌ).", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "\\d{2}" + }, + "cardExpirationMonth": { + "description": "์นด๋“œ ๋งŒ๋ฃŒ ์›” (2 ์ž๋ฆฌ).", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^(0[1-9]|1[012])$" + }, + "cardPassword": { + "description": "์นด๋“œ ๋น„๋ฐ€๋ฒˆํ˜ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "customerBirthday": { + "description": "๊ณ ๊ฐ์˜ ์ƒ๋…„์›”์ผ.\n\nํ‘œ๊ธฐ ํ˜•์‹ YYMMDD.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^([0-9]{2})(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$" + }, + "consumerName": { + "description": "๊ณ ๊ฐ์˜ ์ด๋ฆ„.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customerEmail": { + "description": "๊ณ ๊ฐ์˜ ์ด๋ฉ”์ผ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "format": "email" + }, + "vbv": { + "$ref": "#/components/schemas/__type" + }, + "customerKey": { + "description": "๊ณ ๊ฐ ์‹๋ณ„์ž ํ‚ค.\n\nํ† ์Šค ํŽ˜์ด๋จผ์ธ ๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์ด์šฉํ•˜๋Š” ์„œ๋น„์Šค์—์„œ ์ž์ฒด์ ์œผ๋กœ ๊ด€๋ฆฌํ•˜๋Š” ์‹๋ณ„์ž ํ‚ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "nullable": false, + "required": [ + "cardNumber", + "cardExpirationYear", + "cardExpirationMonth", + "cardPassword", + "customerBirthday", + "customerKey" + ], + "description": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ๋“ฑ๋ก ์ •๋ณด.", + "x-typia-jsDocTags": [] + }, + "__type": { + "type": "object", + "properties": { + "cavv": { + "description": "3D Secure ์ธ์ฆ ์„ธ์…˜์— ๋Œ€ํ•œ ์ธ์ฆ ๊ฐ’.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "xid": { + "description": "ํŠธ๋žœ์žญ์…˜ ID.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "eci": { + "description": "3DS ์ธ์ฆ ๊ฒฐ๊ณผ์— ๋Œ€ํ•œ ์ฝ”๋“œ ๊ฐ’.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "nullable": false, + "required": [ + "cavv", + "xid", + "eci" + ], + "x-typia-jsDocTags": [] + }, + "ITossBilling": { + "type": "object", + "properties": { + "mId": { + "description": "๊ฐ€๋งน์  ID.\n\nํ˜„์žฌ tosspayments ๊ฐ€ ์“ฐ์ž„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "billingKey": { + "description": "{@link ITossBilling } ์˜ ์‹๋ณ„์ž ํ‚ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "method": { + "description": "๊ฒฐ์ œ ์ˆ˜๋‹จ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "์นด๋“œ" + ] + }, + "cardCompany": { + "description": "์นด๋“œ์‚ฌ ์ด๋ฆ„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "cardNumber": { + "description": "์นด๋“œ ๋ฒˆํ˜ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "[0-9]{16}" + }, + "authenticatedAt": { + "description": "์ธ์ฆ ์ผ์‹œ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + "customerKey": { + "description": "๊ณ ๊ฐ ์‹๋ณ„์ž ํ‚ค.\n\nํ† ์Šค ํŽ˜์ด๋จผ์ธ ๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์ด์šฉํ•˜๋Š” ์„œ๋น„์Šค์—์„œ ์ž์ฒด์ ์œผ๋กœ ๊ด€๋ฆฌํ•˜๋Š” ์‹๋ณ„์ž ํ‚ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "nullable": false, + "required": [ + "mId", + "billingKey", + "method", + "cardCompany", + "cardNumber", + "authenticatedAt", + "customerKey" + ], + "description": "๊ฐ„ํŽธ ๊ฒฐ์ œ ๋“ฑ๋ก ์ˆ˜๋‹จ ์ •๋ณด.\n\n`ITossBilling` ์€ ๊ฐ„ํŽธ ๊ฒฐ์ œ ๋“ฑ๋ก ์ˆ˜๋‹จ์„ ํ˜•์ƒํ™”ํ•œ ์ž๋ฃŒ๊ตฌ์กฐ ์ธํ„ฐํŽ˜์ด์Šค๋กœ์จ, ๊ณ ๊ฐ์ด ์ž์‹ ์˜\n์‹ ์šฉ ์นด๋“œ๋ฅผ ์„œ๋ฒ„์— ๋“ฑ๋กํ•ด๋‘๊ณ , ๋งค๋ฒˆ ๊ฒฐ์ œ๊ฐ€ ํ•„์š”ํ•  ๋•Œ๋งˆ๋‹ค ์นด๋“œ ์ •๋ณด๋ฅผ ๋ฐ˜๋ณต ์ž…๋ คํ•˜๋Š” ์ผ\n์—†์ด ๊ฐ„ํŽธํ•˜๊ฒŒ ๊ฒฐ์ œ๋ฅผ ์ง„ํ–‰ํ•˜๊ณ ์ž ํ•  ๋•Œ ์‚ฌ์šฉํ•œ๋‹ค.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossBilling.ICustomerKey": { + "type": "object", + "properties": { + "customerKey": { + "description": "๊ณ ๊ฐ ์‹๋ณ„์ž ํ‚ค.\n\nํ† ์Šค ํŽ˜์ด๋จผ์ธ ๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์ด์šฉํ•˜๋Š” ์„œ๋น„์Šค์—์„œ ์ž์ฒด์ ์œผ๋กœ ๊ด€๋ฆฌํ•˜๋Š” ์‹๋ณ„์ž ํ‚ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "nullable": false, + "required": [ + "customerKey" + ], + "description": "๊ณ ๊ฐ ์‹๋ณ„์ž ์ •๋ณด.", + "x-typia-jsDocTags": [] + }, + "ITossBilling.IPaymentStore": { + "type": "object", + "properties": { + "method": { + "description": "๊ฒฐ์ œ ์ˆ˜๋‹จ์ด ๊ฐ„ํŽธ ๊ฒฐ์ œ์ž„์„ ์˜๋ฏธํ•จ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "billing" + ] + }, + "billingKey": { + "description": "{@link IPaymentStore } ์˜ ์‹๋ณ„์ž ํ‚ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderId": { + "description": "์ฃผ๋ฌธ ์‹๋ณ„์ž ํ‚ค.\n\nํ† ์Šค ํŽ˜์ด๋จผ์ธ ๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์ด์šฉํ•˜๋Š” ์„œ๋น„์Šค์—์„œ ์ž์ฒด์ ์œผ๋กœ ๊ด€๋ฆฌํ•˜๋Š” ์‹๋ณ„์ž ํ‚ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "๊ฒฐ์ œ ์ด์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "customerKey": { + "description": "๊ณ ๊ฐ ์‹๋ณ„์ž ํ‚ค.\n\nํ† ์Šค ํŽ˜์ด๋จผ์ธ ๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์ด์šฉํ•˜๋Š” ์„œ๋น„์Šค์—์„œ ์ž์ฒด์ ์œผ๋กœ ๊ด€๋ฆฌํ•˜๋Š” ์‹๋ณ„์ž ํ‚ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "nullable": false, + "required": [ + "method", + "billingKey", + "orderId", + "amount", + "customerKey" + ], + "description": "๊ฐ„ํŽธ ๊ฒฐ์ œ๋ฅผ ์ด์šฉํ•œ ๊ฒฐ์ œ ์‹ ์ฒญ ์ •๋ณด.", + "x-typia-jsDocTags": [] + }, + "ITossPayment": { + "oneOf": [ + { + "$ref": "#/components/schemas/ITossCardPayment" + }, + { + "$ref": "#/components/schemas/ITossGiftCertificatePayment" + }, + { + "$ref": "#/components/schemas/ITossMobilePhonePayment" + }, + { + "$ref": "#/components/schemas/ITossTransferPayment" + }, + { + "$ref": "#/components/schemas/ITossVirtualAccountPayment" + } + ], + "description": "๊ฒฐ์ œ ์ •๋ณด.\n\n`ITossPayment` ๋Š” ํ† ์Šค ํŽ˜์ด๋จผ์ธ ์˜ ๊ฒฐ์ œ ์ •๋ณด๋ฅผ ํ˜•์ƒํ™”ํ•œ ์ž๋ฃŒ๊ตฌ์กฐ์ด์ž ์œ ๋‹ˆ์–ธ ํƒ€์ž…์˜ \n์ธํ„ฐํŽ˜์ด์Šค๋กœ์จ, if condition ์„ ํ†ตํ•˜์—ฌ method ๊ฐ’์„ ํŠน์ •ํ•˜๋ฉด, ํŒŒ์ƒ ํƒ€์ž…์ด ์ž๋™์œผ๋กœ\n์ง€์ •๋œ๋‹ค.\n\n```typescript\nif (payment.method === \"์นด๋“œ\")\n payment.card; // payment be ITossCardPayment\n```", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossCardPayment": { + "type": "object", + "properties": { + "card": { + "$ref": "#/components/schemas/ITossCardPayment.ICard" + }, + "discount": { + "$ref": "#/components/schemas/ITossCardPayment.IDiscount.Nullable" + }, + "easyPay": { + "description": "๊ฐ„ํŽธ๊ฒฐ์ œ๋กœ ๊ฒฐ์ œํ•œ ๊ฒฝ์šฐ ๊ฐ„ํŽธ๊ฒฐ์ œ ํƒ€์ž… ์ •๋ณด.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "ํ† ์Šค๊ฒฐ์ œ", + "ํŽ˜์ด์ฝ”", + "์‚ผ์„ฑํŽ˜์ด" + ], + "nullable": true + }, + "method": { + "description": "๊ฒฐ์ œ ์ˆ˜๋‹จ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "์นด๋“œ" + ] + }, + "type": { + "description": "๊ฒฐ์ œ ํƒ€์ž….\n\n - NORMAL: ์ผ๋ฐ˜ ๊ฒฐ์ œ\n - BILLING: ๋ฏธ๋ฆฌ ๋“ฑ๋กํ•œ ์นด๋“œ์— ์˜ํ•œ ๊ฐ„ํŽธ ๊ฒฐ์ œ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "NORMAL", + "BILLING" + ] + }, + "status": { + "description": "๊ฒฐ์ œ ์ƒํƒœ.\n\n - READY\n - IN_PROGRESS\n - WAITING_FOR_DEPOSIT\n - DONE\n - CANCELED\n - PARTIAL_CANCELED\n - ABORTED\n - EXPIRED", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "READY", + "IN_PROGRESS", + "WAITING_FOR_DEPOSIT", + "DONE", + "CANCELED", + "PARTIAL_CANCELED", + "ABORTED", + "EXPIRED" + ] + }, + "mId": { + "description": "๊ฐ€๋งน์  ID.\n\nํ˜„์žฌ tosspayments ๊ฐ€ ์“ฐ์ž„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "version": { + "description": "์‚ฌ์šฉ ์ค‘์ธ ํ† ์Šค ํŽ˜์ด๋จผ์ธ  API ์˜ ๋ฒ„์ „.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "paymentKey": { + "description": "๊ฒฐ์ œ ๋‚ด์—ญ์˜ ์‹๋ณ„์ž ๋ฒˆํ˜ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderId": { + "description": "์ฃผ๋ฌธ ์‹๋ณ„์ž ํ‚ค.\n\nํ† ์Šค ํŽ˜์ด๋จผ์ธ ๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์ด์šฉํ•˜๋Š” ์„œ๋น„์Šค์—์„œ ์ž์ฒด์ ์œผ๋กœ ๊ด€๋ฆฌํ•˜๋Š” ์‹๋ณ„์ž ํ‚ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "transactionKey": { + "description": "๊ฑฐ๋ž˜ ๊ฑด์— ๋Œ€ํ•œ ๊ณ ์œ ํ•œ ํ‚ค ๊ฐ’.\n\n{@link paymentKey } ์™€ ๋‹ฌ๋ฆฌ, ์ด๋ฅผ ์‚ฌ์šฉํ•  ์ผ์€ ์—†๋”๋ผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "์ฃผ๋ฌธ ์ด๋ฆ„.\n\nํ† ์Šค ํŽ˜์ด๋จผ์ธ ๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์ด์šฉํ•˜๋Š” ์„œ๋น„์Šค์—์„œ ๋ฐœ๊ธ‰ํ•œ ์ฃผ๋ฌธ๋ช….", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "currency": { + "description": "ํ™”ํ ๋‹จ์œ„.\n\nํ˜„์žฌ ํ† ์Šค ํŽ˜์ด๋จผ์ธ ๋Š” KRW ๋งŒ ์‚ฌ์šฉ ๊ฐ€๋Šฅ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "totalAmount": { + "description": "์ด ๊ฒฐ์ œ ๊ธˆ์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "balanceAmount": { + "description": "์ทจ์†Œํ•  ์ˆ˜ ์žˆ๋Š” ๊ธˆ์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "suppliedAmount": { + "description": "๊ณต๊ธ‰๊ฐ€์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxFreeAmount": { + "description": "๋ฉด์„ธ์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vat": { + "description": "๋ถ€๊ฐ€์„ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "useEscrow": { + "description": "์—์Šคํฌ๋กœ ์‚ฌ์šฉ ์—ฌ๋ถ€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "cultureExpense": { + "description": "๋ฌธํ™”๋น„ ์ง€์ถœ ์—ฌ๋ถ€.\n\n๋„์„์ž…, ๊ณต์—ฐ ํ‹ฐ์ผ“, ๋ฐ•๋ฌผ๊ด€/๋ฏธ์ˆ ๊ด€ ์ž…์žฅ๊ถŒ ๋“ฑ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "requestedAt": { + "description": "๊ฒฐ์ œ ์š”์ฒญ ์ผ์‹œ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + "approvedAt": { + "description": "๊ฒฐ์ œ ์Šน์ธ ์ผ์‹œ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time", + "nullable": true + }, + "cancels": { + "description": "๊ฒฐ์ œ ์ทจ์†Œ ๋‚ด์—ญ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/ITossPaymentCancel" + }, + "nullable": true + }, + "cashReceipt": { + "$ref": "#/components/schemas/ITossCashReceipt.ISummary.Nullable" + } + }, + "nullable": false, + "required": [ + "card", + "discount", + "easyPay", + "method", + "type", + "status", + "mId", + "version", + "paymentKey", + "orderId", + "transactionKey", + "orderName", + "currency", + "totalAmount", + "balanceAmount", + "suppliedAmount", + "taxFreeAmount", + "vat", + "useEscrow", + "cultureExpense", + "requestedAt", + "approvedAt", + "cancels", + "cashReceipt" + ], + "description": "์นด๋“œ ๊ฒฐ์ œ ์ •๋ณด.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossCardPayment.ICard": { + "type": "object", + "properties": { + "company": { + "description": "์นด๋“œ์‚ฌ ์ด๋ฆ„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "number": { + "description": "์นด๋“œ ๋ฒˆํ˜ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "[0-9]{16}" + }, + "installmentPlanMonths": { + "description": "ํ• ๋ถ€ ๊ฐœ์›” ์ˆ˜.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "isInterestFree": { + "description": "๋ฌด์ด์ž ํ• ๋ถ€ ์ ์šฉ ์—ฌ๋ถ€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "approveNo": { + "description": "์Šน์ธ ๋ฒˆํ˜ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "useCardPoint": { + "description": "์นด๋“œ ํฌ์ธํŠธ ์‚ฌ์šฉ ์—ฌ๋ถ€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean", + "enum": [ + false + ] + }, + "cardType": { + "description": "์นด๋“œ ํƒ€์ž….", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "์‹ ์šฉ", + "์ฒดํฌ", + "๊ธฐํ”„ํŠธ" + ] + }, + "ownerType": { + "description": "์นด๋“œ์˜ ์†Œ์œ ์ž ํƒ€์ž….", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "๊ฐœ์ธ", + "๋ฒ•์ธ" + ] + }, + "acquireStatus": { + "description": "์นด๋“œ ๊ฒฐ์ œ์˜ ๋งค์ž… ์ƒํƒœ.\n\n - READY: ๋งค์ž… ๋Œ€๊ธฐ\n - REQUESTED: ๋งค์ž… ์š”์ฒญ๋จ\n - COMPLETED: ๋งค์ž… ์™„๋ฃŒ\n - CANCEL_REQUESTED: ๋งค์ž… ์ทจ์†Œ ์š”์ฒญ๋จ\n - CANCELD: ๋งค์ž… ์ทจ์†Œ๋จ", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "READY", + "CANCELED", + "REQUESTED", + "COMPLETED", + "CANCEL_REQUESTED" + ] + }, + "receiptUrl": { + "description": "์˜์ˆ˜์ฆ URL.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "url" + } + }, + "nullable": false, + "required": [ + "company", + "number", + "installmentPlanMonths", + "isInterestFree", + "approveNo", + "useCardPoint", + "cardType", + "ownerType", + "acquireStatus", + "receiptUrl" + ], + "description": "์นด๋“œ ์ •๋ณด.", + "x-typia-jsDocTags": [] + }, + "ITossCardPayment.IDiscount.Nullable": { + "type": "object", + "properties": { + "amount": { + "description": "์นด๋“œ์‚ฌ์˜ ์ฆ‰์‹œ ํ• ์ธ ํ”„๋กœ๋ชจ์…˜์„ ์ ์šฉํ•œ ๊ธˆ์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + } + }, + "nullable": true, + "required": [ + "amount" + ], + "description": "์นด๋“œ์‚ฌ์˜ ์ฆ‰์‹œ ํ• ์ธ ํ”„๋กœ๋ชจ์…˜ ์ •๋ณด.", + "x-typia-jsDocTags": [] + }, + "ITossPaymentCancel": { + "type": "object", + "properties": { + "cancelAmount": { + "description": "์ทจ์†Œ ์ด์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancelReason": { + "description": "์ทจ์†Œ ์‚ฌ์œ .", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "taxFreeAmount": { + "description": "๋ฉด์„ธ ์ฒ˜๋ฆฌ๋œ ๊ธˆ์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxAmount": { + "description": "๊ณผ์„ธ ์ฒ˜๋ฆฌ๋œ ๊ธˆ์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "refundableAmount": { + "description": "๊ฒฐ์ œ ์ทจ์†Œ ํ›„ ํ™˜๋ถˆ ๊ฐ€๋Šฅ ์ž”์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "canceledAt": { + "description": "์ทจ์†Œ ์ผ์‹œ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + } + }, + "nullable": false, + "required": [ + "cancelAmount", + "cancelReason", + "taxFreeAmount", + "taxAmount", + "refundableAmount", + "canceledAt" + ], + "description": "๊ฒฐ์ œ ์ทจ์†Œ ์ •๋ณด.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossCashReceipt.ISummary.Nullable": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/ITossCashReceipt.Type" + }, + "amount": { + "description": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ฒ˜๋ฆฌ๋œ ๊ธˆ์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxFreeAmount": { + "description": "๋ฉด์„ธ ์ฒ˜๋ฆฌ๋œ ๊ธˆ์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "issueNumber": { + "description": "ํ˜„๊ธˆ์˜์ˆ˜์ฆ ๋ฐœ๊ธ‰๋ฒˆํ˜ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "receiptUrl": { + "description": "ํ˜„๊ธˆ์˜์ˆ˜์ฆ ์กฐํšŒ ํŽ˜์ด์ง€ ์ฃผ์†Œ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "nullable": true, + "required": [ + "type", + "amount", + "taxFreeAmount", + "issueNumber", + "receiptUrl" + ], + "description": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์š”์•ฝ ์ •๋ณด.", + "x-typia-jsDocTags": [] + }, + "ITossCashReceipt.Type": { + "description": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ์˜ ์ข…๋ฅ˜.", + "type": "string", + "enum": [ + "์†Œ๋“๊ณต์ œ", + "์ง€์ถœ์ฆ๋น™" + ] + }, + "ITossGiftCertificatePayment": { + "type": "object", + "properties": { + "giftCertificate": { + "$ref": "#/components/schemas/ITossGiftCertificatePayment.IGiftCertificate" + }, + "method": { + "description": "๊ฒฐ์ œ ์ˆ˜๋‹จ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "์ƒํ’ˆ๊ถŒ" + ] + }, + "type": { + "description": "๊ฒฐ์ œ ํƒ€์ž….\n\n - NORMAL: ์ผ๋ฐ˜ ๊ฒฐ์ œ\n - BILLING: ๋ฏธ๋ฆฌ ๋“ฑ๋กํ•œ ์นด๋“œ์— ์˜ํ•œ ๊ฐ„ํŽธ ๊ฒฐ์ œ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "NORMAL" + ] + }, + "status": { + "description": "๊ฒฐ์ œ ์ƒํƒœ.\n\n - READY\n - IN_PROGRESS\n - WAITING_FOR_DEPOSIT\n - DONE\n - CANCELED\n - PARTIAL_CANCELED\n - ABORTED\n - EXPIRED", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "READY", + "IN_PROGRESS", + "WAITING_FOR_DEPOSIT", + "DONE", + "CANCELED", + "PARTIAL_CANCELED", + "ABORTED", + "EXPIRED" + ] + }, + "mId": { + "description": "๊ฐ€๋งน์  ID.\n\nํ˜„์žฌ tosspayments ๊ฐ€ ์“ฐ์ž„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "version": { + "description": "์‚ฌ์šฉ ์ค‘์ธ ํ† ์Šค ํŽ˜์ด๋จผ์ธ  API ์˜ ๋ฒ„์ „.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "paymentKey": { + "description": "๊ฒฐ์ œ ๋‚ด์—ญ์˜ ์‹๋ณ„์ž ๋ฒˆํ˜ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderId": { + "description": "์ฃผ๋ฌธ ์‹๋ณ„์ž ํ‚ค.\n\nํ† ์Šค ํŽ˜์ด๋จผ์ธ ๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์ด์šฉํ•˜๋Š” ์„œ๋น„์Šค์—์„œ ์ž์ฒด์ ์œผ๋กœ ๊ด€๋ฆฌํ•˜๋Š” ์‹๋ณ„์ž ํ‚ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "transactionKey": { + "description": "๊ฑฐ๋ž˜ ๊ฑด์— ๋Œ€ํ•œ ๊ณ ์œ ํ•œ ํ‚ค ๊ฐ’.\n\n{@link paymentKey } ์™€ ๋‹ฌ๋ฆฌ, ์ด๋ฅผ ์‚ฌ์šฉํ•  ์ผ์€ ์—†๋”๋ผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "์ฃผ๋ฌธ ์ด๋ฆ„.\n\nํ† ์Šค ํŽ˜์ด๋จผ์ธ ๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์ด์šฉํ•˜๋Š” ์„œ๋น„์Šค์—์„œ ๋ฐœ๊ธ‰ํ•œ ์ฃผ๋ฌธ๋ช….", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "currency": { + "description": "ํ™”ํ ๋‹จ์œ„.\n\nํ˜„์žฌ ํ† ์Šค ํŽ˜์ด๋จผ์ธ ๋Š” KRW ๋งŒ ์‚ฌ์šฉ ๊ฐ€๋Šฅ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "totalAmount": { + "description": "์ด ๊ฒฐ์ œ ๊ธˆ์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "balanceAmount": { + "description": "์ทจ์†Œํ•  ์ˆ˜ ์žˆ๋Š” ๊ธˆ์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "suppliedAmount": { + "description": "๊ณต๊ธ‰๊ฐ€์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxFreeAmount": { + "description": "๋ฉด์„ธ์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vat": { + "description": "๋ถ€๊ฐ€์„ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "useEscrow": { + "description": "์—์Šคํฌ๋กœ ์‚ฌ์šฉ ์—ฌ๋ถ€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "cultureExpense": { + "description": "๋ฌธํ™”๋น„ ์ง€์ถœ ์—ฌ๋ถ€.\n\n๋„์„์ž…, ๊ณต์—ฐ ํ‹ฐ์ผ“, ๋ฐ•๋ฌผ๊ด€/๋ฏธ์ˆ ๊ด€ ์ž…์žฅ๊ถŒ ๋“ฑ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "requestedAt": { + "description": "๊ฒฐ์ œ ์š”์ฒญ ์ผ์‹œ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + "approvedAt": { + "description": "๊ฒฐ์ œ ์Šน์ธ ์ผ์‹œ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time", + "nullable": true + }, + "cancels": { + "description": "๊ฒฐ์ œ ์ทจ์†Œ ๋‚ด์—ญ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/ITossPaymentCancel" + }, + "nullable": true + }, + "cashReceipt": { + "$ref": "#/components/schemas/ITossCashReceipt.ISummary.Nullable" + } + }, + "nullable": false, + "required": [ + "giftCertificate", + "method", + "type", + "status", + "mId", + "version", + "paymentKey", + "orderId", + "transactionKey", + "orderName", + "currency", + "totalAmount", + "balanceAmount", + "suppliedAmount", + "taxFreeAmount", + "vat", + "useEscrow", + "cultureExpense", + "requestedAt", + "approvedAt", + "cancels", + "cashReceipt" + ], + "description": "์ƒํ’ˆ๊ถŒ ๊ฒฐ์ œ ์ •๋ณด.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossGiftCertificatePayment.IGiftCertificate": { + "type": "object", + "properties": { + "approveNo": { + "description": "์Šน์ธ ๋ฒˆํ˜ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "settlementStatus": { + "description": "์ •์‚ฐ ์ƒํƒœ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "COMPLETE", + "INCOMPLETE" + ] + } + }, + "nullable": false, + "required": [ + "approveNo", + "settlementStatus" + ], + "description": "์ƒํ’ˆ๊ถŒ ์ •๋ณด.", + "x-typia-jsDocTags": [] + }, + "ITossMobilePhonePayment": { + "type": "object", + "properties": { + "mobilePhone": { + "$ref": "#/components/schemas/ITossMobilePhonePayment.IMobilePhone" + }, + "method": { + "description": "๊ฒฐ์ œ ์ˆ˜๋‹จ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "ํœด๋Œ€ํฐ" + ] + }, + "type": { + "description": "๊ฒฐ์ œ ํƒ€์ž….\n\n - NORMAL: ์ผ๋ฐ˜ ๊ฒฐ์ œ\n - BILLING: ๋ฏธ๋ฆฌ ๋“ฑ๋กํ•œ ์นด๋“œ์— ์˜ํ•œ ๊ฐ„ํŽธ ๊ฒฐ์ œ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "NORMAL" + ] + }, + "status": { + "description": "๊ฒฐ์ œ ์ƒํƒœ.\n\n - READY\n - IN_PROGRESS\n - WAITING_FOR_DEPOSIT\n - DONE\n - CANCELED\n - PARTIAL_CANCELED\n - ABORTED\n - EXPIRED", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "READY", + "IN_PROGRESS", + "WAITING_FOR_DEPOSIT", + "DONE", + "CANCELED", + "PARTIAL_CANCELED", + "ABORTED", + "EXPIRED" + ] + }, + "mId": { + "description": "๊ฐ€๋งน์  ID.\n\nํ˜„์žฌ tosspayments ๊ฐ€ ์“ฐ์ž„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "version": { + "description": "์‚ฌ์šฉ ์ค‘์ธ ํ† ์Šค ํŽ˜์ด๋จผ์ธ  API ์˜ ๋ฒ„์ „.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "paymentKey": { + "description": "๊ฒฐ์ œ ๋‚ด์—ญ์˜ ์‹๋ณ„์ž ๋ฒˆํ˜ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderId": { + "description": "์ฃผ๋ฌธ ์‹๋ณ„์ž ํ‚ค.\n\nํ† ์Šค ํŽ˜์ด๋จผ์ธ ๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์ด์šฉํ•˜๋Š” ์„œ๋น„์Šค์—์„œ ์ž์ฒด์ ์œผ๋กœ ๊ด€๋ฆฌํ•˜๋Š” ์‹๋ณ„์ž ํ‚ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "transactionKey": { + "description": "๊ฑฐ๋ž˜ ๊ฑด์— ๋Œ€ํ•œ ๊ณ ์œ ํ•œ ํ‚ค ๊ฐ’.\n\n{@link paymentKey } ์™€ ๋‹ฌ๋ฆฌ, ์ด๋ฅผ ์‚ฌ์šฉํ•  ์ผ์€ ์—†๋”๋ผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "์ฃผ๋ฌธ ์ด๋ฆ„.\n\nํ† ์Šค ํŽ˜์ด๋จผ์ธ ๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์ด์šฉํ•˜๋Š” ์„œ๋น„์Šค์—์„œ ๋ฐœ๊ธ‰ํ•œ ์ฃผ๋ฌธ๋ช….", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "currency": { + "description": "ํ™”ํ ๋‹จ์œ„.\n\nํ˜„์žฌ ํ† ์Šค ํŽ˜์ด๋จผ์ธ ๋Š” KRW ๋งŒ ์‚ฌ์šฉ ๊ฐ€๋Šฅ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "totalAmount": { + "description": "์ด ๊ฒฐ์ œ ๊ธˆ์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "balanceAmount": { + "description": "์ทจ์†Œํ•  ์ˆ˜ ์žˆ๋Š” ๊ธˆ์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "suppliedAmount": { + "description": "๊ณต๊ธ‰๊ฐ€์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxFreeAmount": { + "description": "๋ฉด์„ธ์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vat": { + "description": "๋ถ€๊ฐ€์„ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "useEscrow": { + "description": "์—์Šคํฌ๋กœ ์‚ฌ์šฉ ์—ฌ๋ถ€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "cultureExpense": { + "description": "๋ฌธํ™”๋น„ ์ง€์ถœ ์—ฌ๋ถ€.\n\n๋„์„์ž…, ๊ณต์—ฐ ํ‹ฐ์ผ“, ๋ฐ•๋ฌผ๊ด€/๋ฏธ์ˆ ๊ด€ ์ž…์žฅ๊ถŒ ๋“ฑ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "requestedAt": { + "description": "๊ฒฐ์ œ ์š”์ฒญ ์ผ์‹œ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + "approvedAt": { + "description": "๊ฒฐ์ œ ์Šน์ธ ์ผ์‹œ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time", + "nullable": true + }, + "cancels": { + "description": "๊ฒฐ์ œ ์ทจ์†Œ ๋‚ด์—ญ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/ITossPaymentCancel" + }, + "nullable": true + }, + "cashReceipt": { + "$ref": "#/components/schemas/ITossCashReceipt.ISummary.Nullable" + } + }, + "nullable": false, + "required": [ + "mobilePhone", + "method", + "type", + "status", + "mId", + "version", + "paymentKey", + "orderId", + "transactionKey", + "orderName", + "currency", + "totalAmount", + "balanceAmount", + "suppliedAmount", + "taxFreeAmount", + "vat", + "useEscrow", + "cultureExpense", + "requestedAt", + "approvedAt", + "cancels", + "cashReceipt" + ], + "description": "ํœด๋Œ€ํฐ ๊ฒฐ์ œ ์ •๋ณด.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossMobilePhonePayment.IMobilePhone": { + "type": "object", + "properties": { + "carrier": { + "description": "ํ†ต์‹ ์‚ฌ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "customerMobilePhone": { + "description": "๊ณ ๊ฐ ํœด๋Œ€ํฐ ๋ฒˆํ˜ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "settlementStatus": { + "description": "์ •์‚ฐ ์ƒํƒœ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "COMPLETED", + "INCOMPLETED" + ] + } + }, + "nullable": false, + "required": [ + "carrier", + "customerMobilePhone", + "settlementStatus" + ], + "description": "ํœด๋Œ€ํฐ ์ •๋ณด.", + "x-typia-jsDocTags": [] + }, + "ITossTransferPayment": { + "type": "object", + "properties": { + "transfer": { + "$ref": "#/components/schemas/ITossTransferPayment.ITransfer" + }, + "method": { + "description": "๊ฒฐ์ œ ์ˆ˜๋‹จ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "๊ณ„์ขŒ์ด์ฒด" + ] + }, + "type": { + "description": "๊ฒฐ์ œ ํƒ€์ž….\n\n - NORMAL: ์ผ๋ฐ˜ ๊ฒฐ์ œ\n - BILLING: ๋ฏธ๋ฆฌ ๋“ฑ๋กํ•œ ์นด๋“œ์— ์˜ํ•œ ๊ฐ„ํŽธ ๊ฒฐ์ œ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "NORMAL" + ] + }, + "status": { + "description": "๊ฒฐ์ œ ์ƒํƒœ.\n\n - READY\n - IN_PROGRESS\n - WAITING_FOR_DEPOSIT\n - DONE\n - CANCELED\n - PARTIAL_CANCELED\n - ABORTED\n - EXPIRED", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "READY", + "IN_PROGRESS", + "WAITING_FOR_DEPOSIT", + "DONE", + "CANCELED", + "PARTIAL_CANCELED", + "ABORTED", + "EXPIRED" + ] + }, + "mId": { + "description": "๊ฐ€๋งน์  ID.\n\nํ˜„์žฌ tosspayments ๊ฐ€ ์“ฐ์ž„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "version": { + "description": "์‚ฌ์šฉ ์ค‘์ธ ํ† ์Šค ํŽ˜์ด๋จผ์ธ  API ์˜ ๋ฒ„์ „.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "paymentKey": { + "description": "๊ฒฐ์ œ ๋‚ด์—ญ์˜ ์‹๋ณ„์ž ๋ฒˆํ˜ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderId": { + "description": "์ฃผ๋ฌธ ์‹๋ณ„์ž ํ‚ค.\n\nํ† ์Šค ํŽ˜์ด๋จผ์ธ ๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์ด์šฉํ•˜๋Š” ์„œ๋น„์Šค์—์„œ ์ž์ฒด์ ์œผ๋กœ ๊ด€๋ฆฌํ•˜๋Š” ์‹๋ณ„์ž ํ‚ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "transactionKey": { + "description": "๊ฑฐ๋ž˜ ๊ฑด์— ๋Œ€ํ•œ ๊ณ ์œ ํ•œ ํ‚ค ๊ฐ’.\n\n{@link paymentKey } ์™€ ๋‹ฌ๋ฆฌ, ์ด๋ฅผ ์‚ฌ์šฉํ•  ์ผ์€ ์—†๋”๋ผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "์ฃผ๋ฌธ ์ด๋ฆ„.\n\nํ† ์Šค ํŽ˜์ด๋จผ์ธ ๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์ด์šฉํ•˜๋Š” ์„œ๋น„์Šค์—์„œ ๋ฐœ๊ธ‰ํ•œ ์ฃผ๋ฌธ๋ช….", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "currency": { + "description": "ํ™”ํ ๋‹จ์œ„.\n\nํ˜„์žฌ ํ† ์Šค ํŽ˜์ด๋จผ์ธ ๋Š” KRW ๋งŒ ์‚ฌ์šฉ ๊ฐ€๋Šฅ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "totalAmount": { + "description": "์ด ๊ฒฐ์ œ ๊ธˆ์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "balanceAmount": { + "description": "์ทจ์†Œํ•  ์ˆ˜ ์žˆ๋Š” ๊ธˆ์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "suppliedAmount": { + "description": "๊ณต๊ธ‰๊ฐ€์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxFreeAmount": { + "description": "๋ฉด์„ธ์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vat": { + "description": "๋ถ€๊ฐ€์„ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "useEscrow": { + "description": "์—์Šคํฌ๋กœ ์‚ฌ์šฉ ์—ฌ๋ถ€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "cultureExpense": { + "description": "๋ฌธํ™”๋น„ ์ง€์ถœ ์—ฌ๋ถ€.\n\n๋„์„์ž…, ๊ณต์—ฐ ํ‹ฐ์ผ“, ๋ฐ•๋ฌผ๊ด€/๋ฏธ์ˆ ๊ด€ ์ž…์žฅ๊ถŒ ๋“ฑ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "requestedAt": { + "description": "๊ฒฐ์ œ ์š”์ฒญ ์ผ์‹œ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + "approvedAt": { + "description": "๊ฒฐ์ œ ์Šน์ธ ์ผ์‹œ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time", + "nullable": true + }, + "cancels": { + "description": "๊ฒฐ์ œ ์ทจ์†Œ ๋‚ด์—ญ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/ITossPaymentCancel" + }, + "nullable": true + }, + "cashReceipt": { + "$ref": "#/components/schemas/ITossCashReceipt.ISummary.Nullable" + } + }, + "nullable": false, + "required": [ + "transfer", + "method", + "type", + "status", + "mId", + "version", + "paymentKey", + "orderId", + "transactionKey", + "orderName", + "currency", + "totalAmount", + "balanceAmount", + "suppliedAmount", + "taxFreeAmount", + "vat", + "useEscrow", + "cultureExpense", + "requestedAt", + "approvedAt", + "cancels", + "cashReceipt" + ], + "description": "๊ณ„์ขŒ ์ด์ฒด ๊ฒฐ์ œ ์ •๋ณด.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossTransferPayment.ITransfer": { + "type": "object", + "properties": { + "bank": { + "description": "์€ํ–‰๋ช….", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "settlementStatus": { + "description": "์ด์ฒด ์ƒํƒœ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "COMPLETED", + "INCOMPLETED" + ] + } + }, + "nullable": false, + "required": [ + "bank", + "settlementStatus" + ], + "description": "๊ณ„์ขŒ ์ด์ฒด ์ •๋ณด.", + "x-typia-jsDocTags": [] + }, + "ITossVirtualAccountPayment": { + "type": "object", + "properties": { + "secret": { + "description": "๊ฐ€์ƒ ๊ณ„์ขŒ๋กœ ๊ฒฐ์ œํ•  ๋•Œ ์ „๋‹ฌ๋˜๋Š” ์ž…๊ธˆ ์ฝœ๋ฐฑ์„ ๊ฒ€์ฆํ•˜๊ธฐ ์œ„ํ•œ ๊ฐ’.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "virtualAccount": { + "$ref": "#/components/schemas/ITossVirtualAccountPayment.IVirtualAccount" + }, + "method": { + "description": "๊ฒฐ์ œ ์ˆ˜๋‹จ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "๊ฐ€์ƒ๊ณ„์ขŒ" + ] + }, + "type": { + "description": "๊ฒฐ์ œ ํƒ€์ž….\n\n - NORMAL: ์ผ๋ฐ˜ ๊ฒฐ์ œ\n - BILLING: ๋ฏธ๋ฆฌ ๋“ฑ๋กํ•œ ์นด๋“œ์— ์˜ํ•œ ๊ฐ„ํŽธ ๊ฒฐ์ œ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "NORMAL" + ] + }, + "status": { + "description": "๊ฒฐ์ œ ์ƒํƒœ.\n\n - READY\n - IN_PROGRESS\n - WAITING_FOR_DEPOSIT\n - DONE\n - CANCELED\n - PARTIAL_CANCELED\n - ABORTED\n - EXPIRED", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "READY", + "IN_PROGRESS", + "WAITING_FOR_DEPOSIT", + "DONE", + "CANCELED", + "PARTIAL_CANCELED", + "ABORTED", + "EXPIRED" + ] + }, + "mId": { + "description": "๊ฐ€๋งน์  ID.\n\nํ˜„์žฌ tosspayments ๊ฐ€ ์“ฐ์ž„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "version": { + "description": "์‚ฌ์šฉ ์ค‘์ธ ํ† ์Šค ํŽ˜์ด๋จผ์ธ  API ์˜ ๋ฒ„์ „.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "paymentKey": { + "description": "๊ฒฐ์ œ ๋‚ด์—ญ์˜ ์‹๋ณ„์ž ๋ฒˆํ˜ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderId": { + "description": "์ฃผ๋ฌธ ์‹๋ณ„์ž ํ‚ค.\n\nํ† ์Šค ํŽ˜์ด๋จผ์ธ ๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์ด์šฉํ•˜๋Š” ์„œ๋น„์Šค์—์„œ ์ž์ฒด์ ์œผ๋กœ ๊ด€๋ฆฌํ•˜๋Š” ์‹๋ณ„์ž ํ‚ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "transactionKey": { + "description": "๊ฑฐ๋ž˜ ๊ฑด์— ๋Œ€ํ•œ ๊ณ ์œ ํ•œ ํ‚ค ๊ฐ’.\n\n{@link paymentKey } ์™€ ๋‹ฌ๋ฆฌ, ์ด๋ฅผ ์‚ฌ์šฉํ•  ์ผ์€ ์—†๋”๋ผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "์ฃผ๋ฌธ ์ด๋ฆ„.\n\nํ† ์Šค ํŽ˜์ด๋จผ์ธ ๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์ด์šฉํ•˜๋Š” ์„œ๋น„์Šค์—์„œ ๋ฐœ๊ธ‰ํ•œ ์ฃผ๋ฌธ๋ช….", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "currency": { + "description": "ํ™”ํ ๋‹จ์œ„.\n\nํ˜„์žฌ ํ† ์Šค ํŽ˜์ด๋จผ์ธ ๋Š” KRW ๋งŒ ์‚ฌ์šฉ ๊ฐ€๋Šฅ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "totalAmount": { + "description": "์ด ๊ฒฐ์ œ ๊ธˆ์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "balanceAmount": { + "description": "์ทจ์†Œํ•  ์ˆ˜ ์žˆ๋Š” ๊ธˆ์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "suppliedAmount": { + "description": "๊ณต๊ธ‰๊ฐ€์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxFreeAmount": { + "description": "๋ฉด์„ธ์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vat": { + "description": "๋ถ€๊ฐ€์„ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "useEscrow": { + "description": "์—์Šคํฌ๋กœ ์‚ฌ์šฉ ์—ฌ๋ถ€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "cultureExpense": { + "description": "๋ฌธํ™”๋น„ ์ง€์ถœ ์—ฌ๋ถ€.\n\n๋„์„์ž…, ๊ณต์—ฐ ํ‹ฐ์ผ“, ๋ฐ•๋ฌผ๊ด€/๋ฏธ์ˆ ๊ด€ ์ž…์žฅ๊ถŒ ๋“ฑ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "requestedAt": { + "description": "๊ฒฐ์ œ ์š”์ฒญ ์ผ์‹œ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + "approvedAt": { + "description": "๊ฒฐ์ œ ์Šน์ธ ์ผ์‹œ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time", + "nullable": true + }, + "cancels": { + "description": "๊ฒฐ์ œ ์ทจ์†Œ ๋‚ด์—ญ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/ITossPaymentCancel" + }, + "nullable": true + }, + "cashReceipt": { + "$ref": "#/components/schemas/ITossCashReceipt.ISummary.Nullable" + } + }, + "nullable": false, + "required": [ + "secret", + "virtualAccount", + "method", + "type", + "status", + "mId", + "version", + "paymentKey", + "orderId", + "transactionKey", + "orderName", + "currency", + "totalAmount", + "balanceAmount", + "suppliedAmount", + "taxFreeAmount", + "vat", + "useEscrow", + "cultureExpense", + "requestedAt", + "approvedAt", + "cancels", + "cashReceipt" + ], + "description": "๊ฐ€์ƒ ๊ณ„์ขŒ ๊ฒฐ์ œ ์ •๋ณด.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossVirtualAccountPayment.IVirtualAccount": { + "type": "object", + "properties": { + "accountNumber": { + "description": "๊ณ„์ขŒ ๋ฒˆํ˜ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "accountType": { + "description": "๊ฐ€์ƒ ๊ณ„์ขŒ ํƒ€์ž….", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "์ผ๋ฐ˜", + "๊ณ ์ •" + ] + }, + "bank": { + "description": "์€ํ–‰๋ช….", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "customerName": { + "description": "๊ณ ๊ฐ ์ด๋ฆ„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "dueDate": { + "description": "์ž…๊ธˆ ๊ธฐํ•œ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date" + }, + "expired": { + "description": "๊ฐ€์ƒ ๊ณ„์ขŒ ๋งŒ๋ฃŒ ์—ฌ๋ถ€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "settlementStatus": { + "description": "์ •์‚ฐ ์ƒํƒœ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "COMPLETED", + "INCOMPLETED" + ] + }, + "refundStatus": { + "description": "ํ™˜๋ถˆ ์ฒ˜๋ฆฌ ์ƒํƒœ.\n\n - NONE: ํ•ด๋‹น ์—†์Œ\n - FAILED: ํ™˜๋ถˆ ์‹คํŒจ\n - PENDING: ํ™˜๋ถˆ ์ฒ˜๋ฆฌ์ค‘\n - PARTIAL_FAILED: ๋ถ€๋ถ„ ํ™˜๋ถˆ ์‹คํŒจ\n - COMPLETED: ํ™˜๋ถˆ ์™„๋ฃŒ", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "COMPLETED", + "NONE", + "FAILED", + "PENDING", + "PARTIAL_FAILED" + ] + } + }, + "nullable": false, + "required": [ + "accountNumber", + "accountType", + "bank", + "customerName", + "dueDate", + "expired", + "settlementStatus", + "refundStatus" + ], + "description": "๊ฐ€์ƒ ๊ณ„์ขŒ ์ •๋ณด.", + "x-typia-jsDocTags": [] + }, + "ITossCashReceipt.IStore": { + "type": "object", + "properties": { + "type": { + "description": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ์˜ ์ข…๋ฅ˜.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "์†Œ๋“๊ณต์ œ", + "์ง€์ถœ์ฆ๋น™" + ] + }, + "paymentKey": { + "description": "๊ท€์† ๊ฒฐ์ œ์˜ {@link ITossPayment.paymentKey }.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderId": { + "description": "์ฃผ๋ฌธ์˜ ์‹๋ณ„์ž ID.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "์ฃผ๋ฌธ ์ด๋ฆ„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "registrationNumber": { + "description": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ๋ฐœ๊ธ‰์„ ์œ„ํ•œ ๊ฐœ์ธ ์‹๋ณ„ ๋ฒˆํ˜ธ.\n\nํ˜„๊ธˆ ์˜์ˆ˜์ฆ์˜ ์ข…๋ฅ˜์— ๋”ฐ๋ผ ํœด๋Œ€ํฐ ๋ฒˆํ˜ธ๋‚˜ ์ฃผ๋ฏผ๋“ฑ๋ก๋ฒˆํ˜ธ ๋˜๋Š” ์‚ฌ์—…์ž๋“ฑ๋ก๋ฒˆํ˜ธ ๋ฐ \n์นด๋“œ ๋ฒˆํ˜ธ๋ฅผ ์ž…๋ ฅํ•  ์ˆ˜ ์žˆ๋‹ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ์„ ๋ฐœํ–‰ํ•  ๊ธˆ์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxFreeAmount": { + "description": "๋ฉด์„ธ ๊ธˆ์•ก.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "businessNumber": { + "description": "์‚ฌ์—…์ž ๋“ฑ๋ก๋ฒˆํ˜ธ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + } + }, + "nullable": false, + "required": [ + "type", + "paymentKey", + "orderId", + "orderName", + "registrationNumber", + "amount" + ], + "description": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ž…๋ ฅ ์ •๋ณด.", + "x-typia-jsDocTags": [] + }, + "ITossCashReceipt": { + "type": "object", + "properties": { + "receiptKey": { + "description": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ์˜ ์‹๋ณ„์ž ํ‚ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/ITossCashReceipt.Type" + }, + "orderId": { + "description": "์ฃผ๋ฌธ์˜ ์‹๋ณ„์ž ID.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "์ฃผ๋ฌธ ์ด๋ฆ„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "approvalNumber": { + "description": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์Šน์ธ ๋ฒˆํ˜ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "approvedAt": { + "description": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์Šน์ธ ์ผ์‹œ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + "canceledAt": { + "description": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ทจ์†Œ ์ผ์‹œ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time", + "nullable": true + }, + "receiptUrl": { + "description": "์˜์ˆ˜์ฆ URL.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "nullable": false, + "required": [ + "receiptKey", + "type", + "orderId", + "orderName", + "approvalNumber", + "approvedAt", + "canceledAt", + "receiptUrl" + ], + "description": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ •๋ณด.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossCashReceipt.ICancel": { + "type": "object", + "properties": { + "amount": { + "description": "์ทจ์†Œ ๊ธˆ์•ก.\n\n๋ฏธ ์ž…๋ ฅ์‹œ ํ˜„๊ธˆ ์˜์ˆ˜์ฆ์— ๊ธฐ์žฌ๋œ {@link ITossCashReceipt.amount ์ด์•ก}์ด ์ทจ์†Œ๋จ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + } + }, + "nullable": false, + "description": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ทจ์†Œ ์ž…๋ ฅ ์ •๋ณด.", + "x-typia-jsDocTags": [] + }, + "ITossPaymentWebhook": { + "type": "object", + "properties": { + "eventType": { + "description": "์ด๋ฒคํŠธ ํƒ€์ž….", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "PAYMENT_STATUS_CHANGED" + ] + }, + "data": { + "$ref": "#/components/schemas/ITossPaymentWebhook.IData" + } + }, + "nullable": false, + "required": [ + "eventType", + "data" + ], + "description": "์›นํ›… ์ด๋ฒคํŠธ ์ •๋ณด.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossPaymentWebhook.IData": { + "type": "object", + "properties": { + "paymentKey": { + "description": "{@link ITossPayment } ์˜ ์‹๋ณ„์ž ํ‚ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderId": { + "description": "์ฃผ๋ฌธ ์‹๋ณ„์ž ํ‚ค.\n\nํ† ์Šค ํŽ˜์ด๋จผ์ธ ๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์ด์šฉํ•˜๋Š” ์„œ๋น„์Šค์—์„œ ์ž์ฒด์ ์œผ๋กœ ๊ด€๋ฆฌํ•˜๋Š” ์‹๋ณ„์ž ํ‚ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "status": { + "description": "๊ฒฐ์ œ ์ƒํƒœ.\n\n - DONE: ๊ฒฐ์ œ ์™„๋ฃŒ\n - CANCELED: ๊ฒฐ์ œ๊ฐ€ ์ทจ์†Œ๋จ\n - PARTIAL_CANCELED: ๊ฒฐ์ œ๊ฐ€ ๋ถ€๋ถ„ ์ทจ์†Œ๋จ\n - WAITING_FOR_DEPOSIT: ์ž…๊ธˆ ๋Œ€๊ธฐ ์ค‘", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "WAITING_FOR_DEPOSIT", + "DONE", + "CANCELED", + "PARTIAL_CANCELED" + ] + } + }, + "nullable": false, + "required": [ + "paymentKey", + "orderId", + "status" + ], + "description": "์›นํ›… ์ด๋ฒคํŠธ ๋ฐ์ดํ„ฐ.", + "x-typia-jsDocTags": [] + }, + "ITossCardPayment.IStore": { + "type": "object", + "properties": { + "method": { + "description": "๊ฒฐ์ œ ์ˆ˜๋‹จ์ด ์‹ ์šฉ ์นด๋“œ์ž„์„ ์˜๋ฏธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "card" + ] + }, + "cardNumber": { + "description": "์นด๋“œ ๋ฒˆํ˜ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "[0-9]{16}" + }, + "cardExpirationYear": { + "description": "์นด๋“œ ๋งŒ๋ฃŒ ๋…„๋„ (2 ์ž๋ฆฌ).", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "\\d{2}" + }, + "cardExpirationMonth": { + "description": "์นด๋“œ ๋งŒ๋ฃŒ ์›” (2 ์ž๋ฆฌ).", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^(0[1-9]|1[012])$" + }, + "cardPassword": { + "description": "์นด๋“œ ๋น„๋ฐ€๋ฒˆํ˜ธ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "cardInstallmentPlan": { + "description": "ํ• ๋ถ€ ๊ฐœ์›” ์ˆ˜.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "amount": { + "description": "์ง€๋ถˆ ์ด์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxFreeAmount": { + "description": "๋ฉด์„ธ๊ธˆ ์ด์•ก.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "orderId": { + "description": "์ฃผ๋ฌธ ์‹๋ณ„์ž ํ‚ค.\n\nํ† ์Šค ํŽ˜์ด๋จผ์ธ ๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์ด์šฉํ•˜๋Š” ์„œ๋น„์Šค์—์„œ ์ž์ฒด์ ์œผ๋กœ ๊ด€๋ฆฌํ•˜๋Š” ์‹๋ณ„์ž ํ‚ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "์ฃผ๋ฌธ ์ด๋ฆ„.\n\nํ† ์Šค ํŽ˜์ด๋จผ์ธ ๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์ด์šฉํ•˜๋Š” ์„œ๋น„์Šค์—์„œ ๋ฐœ๊ธ‰ํ•œ ์ฃผ๋ฌธ๋ช….", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customerBirthday": { + "description": "๊ณ ๊ฐ์˜ ์ƒ๋…„์›”์ผ.\n\nํ‘œ๊ธฐ ํ˜•์‹ YYMMDD.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "pattern": "^([0-9]{2})(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$" + }, + "customerEmail": { + "description": "๊ณ ๊ฐ์˜ ์ด๋ฉ”์ผ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "format": "email" + }, + "vbv": { + "$ref": "#/components/schemas/__type.o1" + }, + "__approved": { + "description": "๊ฒฐ์ œ ์Šน์ธ ์—ฌ๋ถ€.\n\n์˜ค์ง ๊ฐ€์งœ ํŽ˜์ด๋จผ์ธ  ์„œ๋ฒ„ `fake-toss-payments-server` ์—์„œ๋งŒ ์‚ฌ์šฉ๋˜๋Š” ๊ฐ’์œผ๋กœ์จ, \n๊ฒฐ์ œ ์Šน์ธ์„ ๊ณ ์˜๋กœ ์ง€์—ฐ์‹œํ‚ค๊ฑฐ๋‚˜ ํ•  ๋•Œ ์‚ฌ์šฉ๋œ๋‹ค. ์ด ๊ฐ’์„ `false` ๋กœ ํ•˜๋ฉด, ํ”„๋ก ํŠธ \n์–ดํ”Œ๋ฆฌ์ผ€์ด์…˜์ด ํ† ์Šค ํŽ˜์ด๋จผ์ธ ๊ฐ€ ์ œ๊ณตํ•ด์ฃผ๋Š” ๊ฒฐ์ œ ์ฐฝ์„ ์‚ฌ์šฉํ•˜์—ฌ ๊ฒฐ์ œ๋ฅผ ์ง„ํ–‰ํ•˜๋Š” \n์ƒํ™ฉ์„ ์‹œ๋ฎฌ๋ ˆ์ด์…˜ํ•  ์ˆ˜ ์žˆ๋‹ค.\n\n๋ณธ๋”” ํ† ์Šค ํŽ˜์ด๋จผ์ธ  ์„œ๋ฒ„๋Š” ํ”„๋ก ํŠธ ์–ดํ”Œ๋ฆฌ์ผ€์ด์…˜์—์„œ ๋ฐฑ์—”๋“œ ์„œ๋ฒ„๋ฅผ ๊ฑฐ์น˜์ง€ ์•Š๊ณ ,\nํ† ์Šค ํŽ˜์ด๋จผ์ธ ๊ฐ€ ์ œ๊ณตํ•ด์ฃผ๋Š” ๊ฒฐ์ œ ์ฐฝ์„ ์ด์šฉํ•˜์—ฌ ์ง์ ‘ ๊ฒฐ์ œ๋ฅผ ์š”์ฒญํ•˜๋Š” ๊ฒฝ์šฐ, \n๋ฐฑ์—”๋“œ์—์„œ ์ด๋ฅผ ๋ณ„๋„ {@link functional.payments.approve ์Šน์ธ} ์ฒ˜๋ฆฌํ•ด์ฃผ๊ธฐ ์ „๊นŒ์ง€ \n์ •์‹ ๊ฒฐ์ œ๋กœ ์ธ์ฒญ์น˜ ์•„๋‹ˆํ•œ๋‹ค.\n\n๋ฐ˜๋ฉด ๋ฐฑ์—”๋“œ ์„œ๋ฒ„์—์„œ ํ† ์Šค ํŽ˜์ด๋จผ์ธ  ์„œ๋ฒ„์˜ API ๋ฅผ ํ˜ธ์ถœํ•˜๋Š” ๊ฒฝ์šฐ, ํ† ์Šค ํŽ˜์ด๋จผ์ธ ๋Š”\n์ด๋ฅผ ๊ทธ ์ฆ‰์‹œ๋กœ ์Šน์ธํ•ด์ฃผ๊ธฐ, `fake-toss-payments-server` ์—์„œ ๋ณ„๋„์˜ ์Šน์ธ ์ฒ˜๋ฆฌ๊ฐ€\nํ•„์š”ํ•œ ์ƒํ™ฉ์„ ์‹œ๋ฎฌ๋ ˆ์ด์…˜ํ•˜๊ธฐ ์œ„ํ•ด์„œ๋Š” ์ด๋Ÿฌํ•œ ์†์„ฑ์ด ํ•„์š”ํ•œ ๊ฒƒ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "boolean" + } + }, + "nullable": false, + "required": [ + "method", + "cardNumber", + "cardExpirationYear", + "cardExpirationMonth", + "amount", + "orderId" + ], + "description": "์‹ ์šฉ ์นด๋“œ๋ฅผ ์ด์šฉํ•œ ๊ฒฐ์ œ ์‹ ์ฒญ ์ •๋ณด.", + "x-typia-jsDocTags": [] + }, + "__type.o1": { + "type": "object", + "properties": { + "cavv": { + "description": "3D Secure ์ธ์ฆ ์„ธ์…˜์— ๋Œ€ํ•œ ์ธ์ฆ ๊ฐ’.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "xid": { + "description": "ํŠธ๋žœ์žญ์…˜ ID.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "eci": { + "description": "3DS ์ธ์ฆ ๊ฒฐ๊ณผ์— ๋Œ€ํ•œ ์ฝ”๋“œ ๊ฐ’.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "nullable": false, + "required": [ + "cavv", + "xid", + "eci" + ], + "x-typia-jsDocTags": [] + }, + "ITossPayment.IApproval": { + "type": "object", + "properties": { + "orderId": { + "description": "์ฃผ๋ฌธ ์‹๋ณ„์ž ํ‚ค.\n\nํ† ์Šค ํŽ˜์ด๋จผ์ธ ๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์ด์šฉํ•˜๋Š” ์„œ๋น„์Šค์—์„œ ์ž์ฒด์ ์œผ๋กœ ๊ด€๋ฆฌํ•˜๋Š” ์‹๋ณ„์ž ํ‚ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "๊ฒฐ์ œ ์ด์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + } + }, + "nullable": false, + "required": [ + "orderId", + "amount" + ], + "description": "๊ฒฐ์ œ ์Šน์ธ ์ •๋ณด.", + "x-typia-jsDocTags": [] + }, + "ITossPaymentCancel.IStore": { + "type": "object", + "properties": { + "paymentKey": { + "description": "{@link ITossPayment } ์˜ ์‹๋ณ„์ž ํ‚ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "cancelReason": { + "description": "์ทจ์†Œ ์‚ฌ์œ .", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "cancelAmount": { + "description": "์ทจ์†Œ ์ด์•ก.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "refundReceiveAccount": { + "$ref": "#/components/schemas/__type.o2" + }, + "taxAmount": { + "description": "๊ณผ์„ธ ์ฒ˜๋ฆฌ ๊ธˆ์•ก.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "taxFreeAmount": { + "description": "๋ฉด์„ธ ์ฒ˜๋ฆฌ ๊ธˆ์•ก.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "refundableAmount": { + "description": "๊ฒฐ์ œ ์ทจ์†Œ ํ›„ ํ™˜๋ถˆ ๊ฐ€๋Šฅ ์ž”์•ก.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + } + }, + "nullable": false, + "required": [ + "paymentKey", + "cancelReason" + ], + "description": "๊ฒฐ์ œ ์ทจ์†Œ ์‹ ์ฒญ ์ •๋ณด.", + "x-typia-jsDocTags": [] + }, + "__type.o2": { + "type": "object", + "properties": { + "bank": { + "description": "์€ํ–‰ ์ •๋ณด.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "accountNumber": { + "description": "๊ณ„์ขŒ ๋ฒˆํ˜ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^[0-9]{0,20}$" + }, + "holderName": { + "description": "์˜ˆ๊ธˆ์ฃผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "nullable": false, + "required": [ + "bank", + "accountNumber", + "holderName" + ], + "x-typia-jsDocTags": [] + }, + "ITossVirtualAccountPayment.IStore": { + "type": "object", + "properties": { + "method": { + "description": "๊ฒฐ์ œ ์ˆ˜๋‹จ์ด ๊ฐ€์ƒ ๊ณ„์ขŒ์ž„์„ ์˜๋ฏธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "enum": [ + "virtual-account" + ] + }, + "orderId": { + "description": "์ฃผ๋ฌธ ์‹๋ณ„์ž ๋ฒˆํ˜ธ.\n\nํ† ์Šค ํŽ˜์ด๋จผ์ธ ๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์ด์šฉํ•˜๋Š” ์„œ๋น„์Šค์—์„œ ์ž์ฒด์ ์œผ๋กœ ๊ด€๋ฆฌํ•˜๋Š” ์‹๋ณ„์ž ํ‚ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "์ฃผ๋ฌธ ์ด๋ฆ„.\n\nํ† ์Šค ํŽ˜์ด๋จผ์ธ ๊ฐ€ ์•„๋‹Œ, ์ด๋ฅผ ์ด์šฉํ•˜๋Š” ์„œ๋น„์Šค์—์„œ ๋ฐœ๊ธ‰ํ•œ ์ฃผ๋ฌธ๋ช….", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "bank": { + "description": "์€ํ–‰๋ช….", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "customerName": { + "description": "๊ณ ๊ฐ ์ด๋ฆ„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "๊ฒฐ์ œ ์ด์•ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "__approved": { + "description": "๊ฒฐ์ œ ์Šน์ธ ์—ฌ๋ถ€.\n\n์˜ค์ง ๊ฐ€์งœ ํŽ˜์ด๋จผ์ธ  ์„œ๋ฒ„ `fake-toss-payments-server` ์—์„œ๋งŒ ์‚ฌ์šฉ๋˜๋Š” ๊ฐ’์œผ๋กœ์จ, \n๊ฒฐ์ œ ์Šน์ธ์„ ๊ณ ์˜๋กœ ์ง€์—ฐ์‹œํ‚ค๊ฑฐ๋‚˜ ํ•  ๋•Œ ์‚ฌ์šฉ๋œ๋‹ค. ์ด ๊ฐ’์„ `false` ๋กœ ํ•˜๋ฉด, ํ”„๋ก ํŠธ \n์–ดํ”Œ๋ฆฌ์ผ€์ด์…˜์ด ํ† ์Šค ํŽ˜์ด๋จผ์ธ ๊ฐ€ ์ œ๊ณตํ•ด์ฃผ๋Š” ๊ฒฐ์ œ ์ฐฝ์„ ์‚ฌ์šฉํ•˜์—ฌ ๊ฒฐ์ œ๋ฅผ ์ง„ํ–‰ํ•˜๋Š” \n์ƒํ™ฉ์„ ์‹œ๋ฎฌ๋ ˆ์ด์…˜ํ•  ์ˆ˜ ์žˆ๋‹ค.\n\n๋ณธ๋”” ํ† ์Šค ํŽ˜์ด๋จผ์ธ  ์„œ๋ฒ„๋Š” ํ”„๋ก ํŠธ ์–ดํ”Œ๋ฆฌ์ผ€์ด์…˜์—์„œ ๋ฐฑ์—”๋“œ ์„œ๋ฒ„๋ฅผ ๊ฑฐ์น˜์ง€ ์•Š๊ณ ,\nํ† ์Šค ํŽ˜์ด๋จผ์ธ ๊ฐ€ ์ œ๊ณตํ•ด์ฃผ๋Š” ๊ฒฐ์ œ ์ฐฝ์„ ์ด์šฉํ•˜์—ฌ ์ง์ ‘ ๊ฒฐ์ œ๋ฅผ ์š”์ฒญํ•˜๋Š” ๊ฒฝ์šฐ, \n๋ฐฑ์—”๋“œ์—์„œ ์ด๋ฅผ ๋ณ„๋„ {@link functional.payments.approve ์Šน์ธ} ์ฒ˜๋ฆฌํ•ด์ฃผ๊ธฐ ์ „๊นŒ์ง€ \n์ •์‹ ๊ฒฐ์ œ๋กœ ์ธ์ฒญ์น˜ ์•„๋‹ˆํ•œ๋‹ค.\n\n๋ฐ˜๋ฉด ๋ฐฑ์—”๋“œ ์„œ๋ฒ„์—์„œ ํ† ์Šค ํŽ˜์ด๋จผ์ธ  ์„œ๋ฒ„์˜ API ๋ฅผ ํ˜ธ์ถœํ•˜๋Š” ๊ฒฝ์šฐ, ํ† ์Šค ํŽ˜์ด๋จผ์ธ ๋Š”\n์ด๋ฅผ ๊ทธ ์ฆ‰์‹œ๋กœ ์Šน์ธํ•ด์ฃผ๊ธฐ, `fake-toss-payments-server` ์—์„œ ๋ณ„๋„์˜ ์Šน์ธ ์ฒ˜๋ฆฌ๊ฐ€\nํ•„์š”ํ•œ ์ƒํ™ฉ์„ ์‹œ๋ฎฌ๋ ˆ์ด์…˜ํ•˜๊ธฐ ์œ„ํ•ด์„œ๋Š” ์ด๋Ÿฌํ•œ ์†์„ฑ์ด ํ•„์š”ํ•œ ๊ฒƒ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "boolean" + } + }, + "nullable": false, + "required": [ + "method", + "orderId", + "orderName", + "bank", + "customerName", + "amount" + ], + "description": "๊ฐ€์ƒ ๊ณ„์ขŒ๋ฅผ ์ด์šฉํ•œ ๊ฒฐ์ œ ์‹ ์ฒญ ์ •๋ณด.", + "x-typia-jsDocTags": [] + } + }, + "securitySchemes": { + "basic": { + "type": "apiKey", + "name": "Authorization", + "in": "header" + } + } + } +} \ No newline at end of file diff --git a/assets/input/uber.swagger.json b/assets/input/uber.swagger.json new file mode 100644 index 0000000..9577828 --- /dev/null +++ b/assets/input/uber.swagger.json @@ -0,0 +1,370 @@ +{ + "swagger": "2.0", + "info": { + "title": "Uber API", + "description": "Move your app forward with the Uber API", + "version": "1.0.0" + }, + "host": "api.uber.com", + "schemes": [ + "https" + ], + "basePath": "/v1", + "produces": [ + "application/json" + ], + "paths": { + "/products": { + "get": { + "summary": "Product Types", + "description": "The Products endpoint returns information about the Uber products offered at a given location. The response includes the display name and other details about each product, and lists the products in the proper display order.", + "parameters": [ + { + "name": "latitude", + "in": "query", + "description": "Latitude component of location.", + "required": true, + "type": "number", + "format": "double" + }, + { + "name": "longitude", + "in": "query", + "description": "Longitude component of location.", + "required": true, + "type": "number", + "format": "double" + } + ], + "tags": [ + "Products" + ], + "responses": { + "200": { + "description": "An array of products", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Product" + } + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/estimates/price": { + "get": { + "summary": "Price Estimates", + "description": "The Price Estimates endpoint returns an estimated price range for each product offered at a given location. The price estimate is provided as a formatted string with the full price range and the localized currency symbol.

The response also includes low and high estimates, and the [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) currency code for situations requiring currency conversion. When surge is active for a particular product, its surge_multiplier will be greater than 1, but the price estimate already factors in this multiplier.", + "parameters": [ + { + "name": "start_latitude", + "in": "query", + "description": "Latitude component of start location.", + "required": true, + "type": "number", + "format": "double" + }, + { + "name": "start_longitude", + "in": "query", + "description": "Longitude component of start location.", + "required": true, + "type": "number", + "format": "double" + }, + { + "name": "end_latitude", + "in": "query", + "description": "Latitude component of end location.", + "required": true, + "type": "number", + "format": "double" + }, + { + "name": "end_longitude", + "in": "query", + "description": "Longitude component of end location.", + "required": true, + "type": "number", + "format": "double" + } + ], + "tags": [ + "Estimates" + ], + "responses": { + "200": { + "description": "An array of price estimates by product", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/PriceEstimate" + } + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/estimates/time": { + "get": { + "summary": "Time Estimates", + "description": "The Time Estimates endpoint returns ETAs for all products offered at a given location, with the responses expressed as integers in seconds. We recommend that this endpoint be called every minute to provide the most accurate, up-to-date ETAs.", + "parameters": [ + { + "name": "start_latitude", + "in": "query", + "description": "Latitude component of start location.", + "required": true, + "type": "number", + "format": "double" + }, + { + "name": "start_longitude", + "in": "query", + "description": "Longitude component of start location.", + "required": true, + "type": "number", + "format": "double" + }, + { + "name": "customer_uuid", + "in": "query", + "type": "string", + "format": "uuid", + "description": "Unique customer identifier to be used for experience customization." + }, + { + "name": "product_id", + "in": "query", + "type": "string", + "description": "Unique identifier representing a specific product for a given latitude & longitude." + } + ], + "tags": [ + "Estimates" + ], + "responses": { + "200": { + "description": "An array of products", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Product" + } + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/me": { + "get": { + "summary": "User Profile", + "description": "The User Profile endpoint returns information about the Uber user that has authorized with the application.", + "tags": [ + "User" + ], + "responses": { + "200": { + "description": "Profile information for a user", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/history": { + "get": { + "summary": "User Activity", + "description": "The User Activity endpoint returns data about a user's lifetime activity with Uber. The response will include pickup locations and times, dropoff locations and times, the distance of past requests, and information about which products were requested.

The history array in the response will have a maximum length based on the limit parameter. The response value count may exceed limit, therefore subsequent API requests may be necessary.", + "parameters": [ + { + "name": "offset", + "in": "query", + "type": "integer", + "format": "int32", + "description": "Offset the list of returned results by this amount. Default is zero." + }, + { + "name": "limit", + "in": "query", + "type": "integer", + "format": "int32", + "description": "Number of items to retrieve. Default is 5, maximum is 100." + } + ], + "tags": [ + "User" + ], + "responses": { + "200": { + "description": "History information for the given user", + "schema": { + "$ref": "#/definitions/Activities" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + } + }, + "definitions": { + "Product": { + "properties": { + "product_id": { + "type": "string", + "description": "Unique identifier representing a specific product for a given latitude & longitude. For example, uberX in San Francisco will have a different product_id than uberX in Los Angeles." + }, + "description": { + "type": "string", + "description": "Description of product." + }, + "display_name": { + "type": "string", + "description": "Display name of product." + }, + "capacity": { + "type": "string", + "description": "Capacity of product. For example, 4 people." + }, + "image": { + "type": "string", + "description": "Image URL representing the product." + } + } + }, + "PriceEstimate": { + "properties": { + "product_id": { + "type": "string", + "description": "Unique identifier representing a specific product for a given latitude & longitude. For example, uberX in San Francisco will have a different product_id than uberX in Los Angeles" + }, + "currency_code": { + "type": "string", + "description": "[ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) currency code." + }, + "display_name": { + "type": "string", + "description": "Display name of product." + }, + "estimate": { + "type": "string", + "description": "Formatted string of estimate in local currency of the start location. Estimate could be a range, a single number (flat rate) or \"Metered\" for TAXI." + }, + "low_estimate": { + "type": "number", + "description": "Lower bound of the estimated price." + }, + "high_estimate": { + "type": "number", + "description": "Upper bound of the estimated price." + }, + "surge_multiplier": { + "type": "number", + "description": "Expected surge multiplier. Surge is active if surge_multiplier is greater than 1. Price estimate already factors in the surge multiplier." + } + } + }, + "Profile": { + "properties": { + "first_name": { + "type": "string", + "description": "First name of the Uber user." + }, + "last_name": { + "type": "string", + "description": "Last name of the Uber user." + }, + "email": { + "type": "string", + "description": "Email address of the Uber user" + }, + "picture": { + "type": "string", + "description": "Image URL of the Uber user." + }, + "promo_code": { + "type": "string", + "description": "Promo code of the Uber user." + } + } + }, + "Activity": { + "properties": { + "uuid": { + "type": "string", + "description": "Unique identifier for the activity" + } + } + }, + "Activities": { + "properties": { + "offset": { + "type": "integer", + "format": "int32", + "description": "Position in pagination." + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "Number of items to retrieve (100 max)." + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Total number of items available." + }, + "history": { + "type": "array", + "items": { + "$ref": "#/definitions/Activity" + } + } + } + }, + "Error": { + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "fields": { + "type": "string" + } + } + } + } +} \ No newline at end of file diff --git a/assets/input/wanted.swagger.json b/assets/input/wanted.swagger.json new file mode 100644 index 0000000..bede379 --- /dev/null +++ b/assets/input/wanted.swagger.json @@ -0,0 +1 @@ +{"openapi":"3.1.0","info":{"title":"Wanted OpenAPI V1 Server","version":"1.0.0"},"servers":[{"url":"/v1"}],"paths":{"/ai/pass/text-prediction/async":{"post":{"tags":["AI"],"summary":"[์œ ๋ฃŒ] ํ…์ŠคํŠธ ์„œ๋ฅ˜ํ•ฉ๊ฒฉ์˜ˆ์ธก ์‹คํ–‰(๋น„๋™๊ธฐ)","description":"**๋ณธ API๋Š” ๋ณ„๋„์˜ ๊ณ„์•ฝํ›„ ์‚ฌ์šฉ์ด ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค.(๋ฌธ์˜ : team-ml@wantedlab.com)**\n\n๋น„๋™๊ธฐ๋กœ ์˜ˆ์ธก์„ ์‹คํ–‰ํ•˜๋ฏ€๋กœ APIํ˜ธ์ถœ ์ฆ‰์‹œ ์™„๋ฃŒ๋˜๋ฉฐ callback_url๋กœ ๊ฒฐ๊ณผ๊ฐ€ ์ „๋‹ฌ๋ฉ๋‹ˆ๋‹ค.**(ํ•œ๋ฒˆ ํ˜ธ์ถœ ์‹œ ์ž…๋ ฅ๋ฐ์ดํ„ฐ๋Š” ์ตœ๋Œ€ 50๊ฐœ ์ž…๋‹ˆ๋‹ค.)**","operationId":"_์œ ๋ฃŒ__ํ…์ŠคํŠธ_์„œ๋ฅ˜ํ•ฉ๊ฒฉ์˜ˆ์ธก_์‹คํ–‰_๋น„๋™๊ธฐ__ai_pass_text_prediction_async_post","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PassTextPredictionRequestSerializer"}],"title":"์ž…๋ ฅ๋ฐ์ดํ„ฐ","description":"์ตœ๋Œ€ 50๊ฐœ"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncPredictionResponseSerializer"}}}},"422":{"description":"ํ•„์ˆ˜ ์š”์ฒญ ๋ฐ์ดํ„ฐ ๋ˆ„๋ฝ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}},"401":{"description":"๋น„์ธ์ฆ ์‚ฌ์šฉ์ž","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}}},"security":[{"ClientIdHeader":[]},{"ClientSecretHeader":[]},{"PermissionsDependency":[]}]}},"/ai/apply/text-prediction/async":{"post":{"tags":["AI"],"summary":"[์œ ๋ฃŒ] ํ…์ŠคํŠธ ์ง€์›์˜ˆ์ธก ์‹คํ–‰(๋น„๋™๊ธฐ)","description":"**๋ณธ API๋Š” ๋ณ„๋„์˜ ๊ณ„์•ฝํ›„ ์‚ฌ์šฉ์ด ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค.(๋ฌธ์˜ : team-ml@wantedlab.com)**\n\n๋น„๋™๊ธฐ๋กœ ์˜ˆ์ธก์„ ์‹คํ–‰ํ•˜๋ฏ€๋กœ APIํ˜ธ์ถœ ์ฆ‰์‹œ ์™„๋ฃŒ๋˜๋ฉฐ callback_url๋กœ ๊ฒฐ๊ณผ๊ฐ€ ์ „๋‹ฌ๋ฉ๋‹ˆ๋‹ค.**(ํ•œ๋ฒˆ ํ˜ธ์ถœ ์‹œ ์ž…๋ ฅ๋ฐ์ดํ„ฐ๋Š” ์ตœ๋Œ€ 50๊ฐœ ์ž…๋‹ˆ๋‹ค.)**","operationId":"_์œ ๋ฃŒ__ํ…์ŠคํŠธ_์ง€์›์˜ˆ์ธก_์‹คํ–‰_๋น„๋™๊ธฐ__ai_apply_text_prediction_async_post","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApplyTextPredictionRequestSerializer"}],"title":"์ž…๋ ฅ๋ฐ์ดํ„ฐ","description":"์ตœ๋Œ€ 50๊ฐœ"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncPredictionResponseSerializer"}}}},"422":{"description":"ํ•„์ˆ˜ ์š”์ฒญ ๋ฐ์ดํ„ฐ ๋ˆ„๋ฝ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}},"401":{"description":"๋น„์ธ์ฆ ์‚ฌ์šฉ์ž","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}}},"security":[{"ClientIdHeader":[]},{"ClientSecretHeader":[]},{"PermissionsDependency":[]}]}},"/applications":{"get":{"tags":["Application"],"summary":"์ง€์› ๋ชฉ๋ก ์กฐํšŒ","operationId":"get_application_list_applications_get","parameters":[{"description":"๊ฒ€์ƒ‰์–ด(ํšŒ์‚ฌ๋ช…/ํฌ์ง€์…˜๋ช…/์ง€์›์ž๋ช…)","required":false,"schema":{"type":"string","title":"Q","description":"๊ฒ€์ƒ‰์–ด(ํšŒ์‚ฌ๋ช…/ํฌ์ง€์…˜๋ช…/์ง€์›์ž๋ช…)"},"name":"q","in":"query"},{"description":"ํฌ์ง€์…˜ID","required":false,"schema":{"type":"integer","title":"Job Id","description":"ํฌ์ง€์…˜ID"},"name":"job_id","in":"query"},{"description":"์ง€์›์„œ ์ƒํƒœ; complete(์ง€์›์„œ ์ ‘์ˆ˜), pass(์„œ๋ฅ˜ ํ†ต๊ณผ), reject(๋ถˆํ•ฉ๊ฒฉ), hire(์ตœ์ข…ํ•ฉ๊ฒฉ)","required":false,"schema":{"items":{"$ref":"#/components/schemas/ApplicationStatusSearchEnum"},"type":"array","description":"์ง€์›์„œ ์ƒํƒœ; complete(์ง€์›์„œ ์ ‘์ˆ˜), pass(์„œ๋ฅ˜ ํ†ต๊ณผ), reject(๋ถˆํ•ฉ๊ฒฉ), hire(์ตœ์ข…ํ•ฉ๊ฒฉ)"},"name":"status","in":"query"},{"description":"์ง€์›์„œ ์ œ์ถœ ๋‚ ์งœ ์‹œ์ž‘ ๋ฒ”์œ„ (ํฌ๋งท: YYYY-MM-DD)","required":false,"schema":{"type":"string","format":"date","title":"Start Date","description":"์ง€์›์„œ ์ œ์ถœ ๋‚ ์งœ ์‹œ์ž‘ ๋ฒ”์œ„ (ํฌ๋งท: YYYY-MM-DD)"},"name":"start_date","in":"query"},{"description":"์ง€์›์„œ ์ œ์ถœ ๋‚ ์งœ ์ข…๋ฃŒ ๋ฒ”์œ„ (ํฌ๋งท: YYYY-MM-DD)","required":false,"schema":{"type":"string","format":"date","title":"End Date","description":"์ง€์›์„œ ์ œ์ถœ ๋‚ ์งœ ์ข…๋ฃŒ ๋ฒ”์œ„ (ํฌ๋งท: YYYY-MM-DD)"},"name":"end_date","in":"query"},{"description":"์ทจ์†Œํ•œ ์ง€์›์„œ ์กฐํšŒ์‹œ True","required":false,"schema":{"type":"boolean","title":"Is Cancel","description":"์ทจ์†Œํ•œ ์ง€์›์„œ ์กฐํšŒ์‹œ True","default":false},"name":"is_cancel","in":"query"},{"required":false,"schema":{"type":"integer","title":"Offset","default":0},"name":"offset","in":"query"},{"required":false,"schema":{"type":"integer","title":"Limit","default":20},"name":"limit","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationListResponseSerializer"}}}},"422":{"description":"ํ•„์ˆ˜ ์š”์ฒญ ๋ฐ์ดํ„ฐ ๋ˆ„๋ฝ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}},"401":{"description":"๋น„์ธ์ฆ ์‚ฌ์šฉ์ž","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}}},"security":[{"ClientIdHeader":[]},{"ClientSecretHeader":[]},{"PermissionsDependency":[]},{"PermissionsDependency":[]}]},"post":{"tags":["Application"],"summary":"ํฌ์ง€์…˜ ์ง€์›","operationId":"apply_for_job_applications_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyJobRequestSerializer"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationResponseSerializer"}}}},"422":{"description":"ํ•„์ˆ˜ ์š”์ฒญ ๋ฐ์ดํ„ฐ ๋ˆ„๋ฝ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}},"401":{"description":"๋น„์ธ์ฆ ์‚ฌ์šฉ์ž","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"examples":{"AlreadyAppliedJob":{"value":{"error_code":"AlreadyAppliedJob","message":"์ด๋ฏธ ์ง€์›ํ•œ ํฌ์ง€์…˜์ž…๋‹ˆ๋‹ค."}},"JobNotExists":{"value":{"error_code":"JobNotExists","message":"์กด์žฌํ•˜์ง€ ์•Š๋Š” ํฌ์ง€์…˜์ž…๋‹ˆ๋‹ค."}},"FileNotFound":{"value":{"error_code":"FileNotFound","message":"์กด์žฌํ•˜์ง€ ์•Š๋Š” ํŒŒ์ผ์ž…๋‹ˆ๋‹ค."}},"DuplicateFile":{"value":{"error_code":"DuplicateFile","message":"์ค‘๋ณต๋œ ํŒŒ์ผ๋กœ ์ง€์›ํ•  ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค."}}}}}}},"security":[{"ClientIdHeader":[]},{"ClientSecretHeader":[]},{"PermissionsDependency":[]},{"PermissionsDependency":[]}]}},"/applications/{application_id}/cancel":{"patch":{"tags":["Application"],"summary":"์ง€์› ์ทจ์†Œ","operationId":"cancel_application_applications__application_id__cancel_patch","parameters":[{"required":true,"schema":{"type":"integer","title":"Application Id"},"name":"application_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelApplicationRequestSerializer"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"ํ•„์ˆ˜ ์š”์ฒญ ๋ฐ์ดํ„ฐ ๋ˆ„๋ฝ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}},"401":{"description":"๋น„์ธ์ฆ ์‚ฌ์šฉ์ž","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"examples":{"ApplicationNotFound":{"value":{"error_code":"ApplicationNotFound","message":"์กด์žฌํ•˜์ง€ ์•Š๋Š” ์ง€์›์„œ์ž…๋‹ˆ๋‹ค."}}}}}}},"security":[{"ClientIdHeader":[]},{"ClientSecretHeader":[]},{"PermissionsDependency":[]},{"PermissionsDependency":[]}]}},"/companies/{company_id}":{"get":{"tags":["Company"],"summary":"๊ธฐ์—… ์ƒ์„ธ ์กฐํšŒ","operationId":"get_company_companies__company_id__get","parameters":[{"required":true,"schema":{"type":"integer","title":"Company Id"},"name":"company_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyResponseSerializer"}}}},"422":{"description":"ํ•„์ˆ˜ ์š”์ฒญ ๋ฐ์ดํ„ฐ ๋ˆ„๋ฝ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}},"401":{"description":"๋น„์ธ์ฆ ์‚ฌ์šฉ์ž","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"examples":{"JobNotExists":{"value":{"error_code":"JobNotExists","message":"์กด์žฌํ•˜์ง€ ์•Š๋Š” ํฌ์ง€์…˜์ž…๋‹ˆ๋‹ค."}}}}}}},"security":[{"ClientIdHeader":[]},{"ClientSecretHeader":[]},{"PermissionsDependency":[]}]}},"/companies/{company_id}/jobs":{"get":{"tags":["Company"],"summary":"๊ธฐ์—…์˜ ์ฑ„์šฉ ์ค‘์ธ ํฌ์ง€์…˜ ๋ชฉ๋ก ์กฐํšŒ","operationId":"get_company_job_list_companies__company_id__jobs_get","parameters":[{"required":true,"schema":{"type":"integer","title":"Company Id"},"name":"company_id","in":"path"},{"required":false,"schema":{"type":"integer","title":"Offset","default":0},"name":"offset","in":"query"},{"required":false,"schema":{"type":"integer","title":"Limit","default":12},"name":"limit","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyJobListResponseSerializer"}}}},"422":{"description":"ํ•„์ˆ˜ ์š”์ฒญ ๋ฐ์ดํ„ฐ ๋ˆ„๋ฝ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}},"401":{"description":"๋น„์ธ์ฆ ์‚ฌ์šฉ์ž","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}}},"security":[{"ClientIdHeader":[]},{"ClientSecretHeader":[]},{"PermissionsDependency":[]}]}},"/jobs":{"get":{"tags":["Job"],"summary":"(ํƒ์ƒ‰) ํฌ์ง€์…˜ ๋ฆฌ์ŠคํŠธ ์กฐํšŒ","operationId":"get_job_list_jobs_get","parameters":[{"description":"์ง๊ตฐ/์ง๋ฌด ํƒœ๊ทธID(์ตœ๋Œ€ 5๊ฐœ)","required":false,"schema":{"items":{"type":"integer"},"type":"array","maxItems":5,"minItems":0,"title":"Category Tags","description":"์ง๊ตฐ/์ง๋ฌด ํƒœ๊ทธID(์ตœ๋Œ€ 5๊ฐœ)"},"name":"category_tags","in":"query"},{"description":"์Šคํ‚ฌ ํƒœ๊ทธ ID(์ตœ๋Œ€ 5๊ฐœ)","required":false,"schema":{"items":{"type":"integer"},"type":"array","maxItems":5,"minItems":0,"title":"Skill Tags","description":"์Šคํ‚ฌ ํƒœ๊ทธ ID(์ตœ๋Œ€ 5๊ฐœ)"},"name":"skill_tags","in":"query"},{"description":"๊ฒฝ๋ ฅ. 10 ์ž…๋ ฅ์‹œ ์—ฐ์ฐจ 10๋…„ ์ด์ƒ์˜ ํฌ์ง€์…˜ ๋…ธ์ถœ๋จ","required":false,"schema":{"items":{"type":"integer","maximum":10.0,"minimum":0.0},"type":"array","maximum":10.0,"minimum":0.0,"maxItems":2,"title":"Years","description":"๊ฒฝ๋ ฅ. 10 ์ž…๋ ฅ์‹œ ์—ฐ์ฐจ 10๋…„ ์ด์ƒ์˜ ํฌ์ง€์…˜ ๋…ธ์ถœ๋จ"},"name":"years","in":"query"},{"description":"์ง€์—ญ. ๊ตญ๊ฐ€","required":false,"schema":{"items":{"type":"string"},"type":"array","title":"Locations","description":"์ง€์—ญ. ๊ตญ๊ฐ€"},"name":"locations","in":"query"},{"description":"์ •๋ ฌ","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/JobSortEnum"}],"description":"์ •๋ ฌ","default":"job.latest_order"},"name":"sort","in":"query"},{"required":false,"schema":{"type":"integer","title":"Offset","default":0},"name":"offset","in":"query"},{"required":false,"schema":{"type":"integer","title":"Limit","default":20},"name":"limit","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobListResponseSerializer"}}}},"422":{"description":"ํ•„์ˆ˜ ์š”์ฒญ ๋ฐ์ดํ„ฐ ๋ˆ„๋ฝ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}},"401":{"description":"๋น„์ธ์ฆ ์‚ฌ์šฉ์ž","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}}},"security":[{"ClientIdHeader":[]},{"ClientSecretHeader":[]},{"PermissionsDependency":[]}]}},"/jobs/{job_id}":{"get":{"tags":["Job"],"summary":"ํฌ์ง€์…˜ ์ƒ์„ธ ์กฐํšŒ","operationId":"get_job_jobs__job_id__get","parameters":[{"required":true,"schema":{"type":"integer","title":"ํฌ์ง€์…˜ID"},"name":"job_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/openapi__apis__v1__jobs__serializers__JobResponseSerializer"}}}},"422":{"description":"ํ•„์ˆ˜ ์š”์ฒญ ๋ฐ์ดํ„ฐ ๋ˆ„๋ฝ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}},"401":{"description":"๋น„์ธ์ฆ ์‚ฌ์šฉ์ž","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"examples":{"JobNotExists":{"value":{"error_code":"JobNotExists","message":"์กด์žฌํ•˜์ง€ ์•Š๋Š” ํฌ์ง€์…˜์ž…๋‹ˆ๋‹ค."}}}}}}},"security":[{"ClientIdHeader":[]},{"ClientSecretHeader":[]},{"PermissionsDependency":[]}]}},"/tags/categories":{"get":{"tags":["Tag"],"summary":"์ง๊ตฐ/์ง๋ฌด ๋ฆฌ์ŠคํŠธ ์กฐํšŒ","operationId":"get_categories_tags_categories_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagListResponseSerializer"}}}},"422":{"description":"ํ•„์ˆ˜ ์š”์ฒญ ๋ฐ์ดํ„ฐ ๋ˆ„๋ฝ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}},"401":{"description":"๋น„์ธ์ฆ ์‚ฌ์šฉ์ž","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}}},"security":[{"ClientIdHeader":[]},{"ClientSecretHeader":[]},{"PermissionsDependency":[]}]}},"/tags/skills":{"get":{"tags":["Tag"],"summary":"์Šคํ‚ฌ ๋ฆฌ์ŠคํŠธ ์กฐํšŒ","operationId":"get_skills_tags_skills_get","parameters":[{"required":true,"schema":{"type":"string","title":"Keyword"},"name":"keyword","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SkillListResponseSerializer"}}}},"422":{"description":"ํ•„์ˆ˜ ์š”์ฒญ ๋ฐ์ดํ„ฐ ๋ˆ„๋ฝ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}},"401":{"description":"๋น„์ธ์ฆ ์‚ฌ์šฉ์ž","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}}},"security":[{"ClientIdHeader":[]},{"ClientSecretHeader":[]},{"PermissionsDependency":[]}]}},"/search/company/autocomplate":{"get":{"tags":["Search"],"summary":"Authcomplate","operationId":"authcomplate_search_company_autocomplate_get","parameters":[{"description":"๊ฒ€์ƒ‰ํ•  ํšŒ์‚ฌ๋ช…","required":false,"schema":{"type":"string","title":"Query","description":"๊ฒ€์ƒ‰ํ•  ํšŒ์‚ฌ๋ช…"},"name":"query","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyAutoCompleteResponseSerializer"}}}},"422":{"description":"ํ•„์ˆ˜ ์š”์ฒญ ๋ฐ์ดํ„ฐ ๋ˆ„๋ฝ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}},"401":{"description":"๋น„์ธ์ฆ ์‚ฌ์šฉ์ž","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}}},"security":[{"ClientIdHeader":[]},{"ClientSecretHeader":[]},{"PermissionsDependency":[]}]}},"/search/company":{"get":{"tags":["Search"],"summary":"Search Companies","operationId":"search_companies_search_company_get","parameters":[{"description":"๊ฒ€์ƒ‰ํ•  ํšŒ์‚ฌ๋ช…, ๋˜๋Š” ์‚ฌ์—…์ž๋ฒˆํ˜ธ","required":true,"schema":{"type":"string","title":"Query","description":"๊ฒ€์ƒ‰ํ•  ํšŒ์‚ฌ๋ช…, ๋˜๋Š” ์‚ฌ์—…์ž๋ฒˆํ˜ธ"},"name":"query","in":"query"},{"required":false,"schema":{"type":"integer","title":"Offset","default":0},"name":"offset","in":"query"},{"required":false,"schema":{"type":"integer","title":"Limit","default":20},"name":"limit","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchCompanyResponseSerializer"}}}},"422":{"description":"ํ•„์ˆ˜ ์š”์ฒญ ๋ฐ์ดํ„ฐ ๋ˆ„๋ฝ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}},"401":{"description":"๋น„์ธ์ฆ ์‚ฌ์šฉ์ž","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}}},"security":[{"ClientIdHeader":[]},{"ClientSecretHeader":[]},{"PermissionsDependency":[]}]}},"/files":{"get":{"tags":["File"],"summary":"์ฒจ๋ถ€ํŒŒ์ผ ๋ชฉ๋ก ์กฐํšŒ","operationId":"get_file_list_files_get","parameters":[{"required":false,"schema":{"type":"integer","title":"Offset","default":0},"name":"offset","in":"query"},{"required":false,"schema":{"type":"integer","title":"Limit","default":20},"name":"limit","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFileListResponseSerializer"}}}},"422":{"description":"ํ•„์ˆ˜ ์š”์ฒญ ๋ฐ์ดํ„ฐ ๋ˆ„๋ฝ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}},"401":{"description":"๋น„์ธ์ฆ ์‚ฌ์šฉ์ž","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}}},"security":[{"ClientIdHeader":[]},{"ClientSecretHeader":[]},{"PermissionsDependency":[]},{"PermissionsDependency":[]}]},"post":{"tags":["File"],"summary":"์ง€์›์„œ ์ฒจ๋ถ€ํŒŒ์ผ ์—…๋กœ๋“œ","description":"**ํŒŒ์ผ ์—…๋กœ๋“œ ๋ฐฉ๋ฒ•**\n\n 1. `POST /v1/files/upload-url` ์š”์ฒญ\n\n 2. 1๋ฒˆ ์‘๋‹ต `presigned_url`์„ ํ†ตํ•ด ์ž„์‹œ ํŒŒ์ผ ์—…๋กœ๋“œ\n\n a. `presigned_url`์€ 60๋ถ„ ๋™์•ˆ ์œ ํšจ\n\n b. `presigned_url`์€ PUT ๋ฉ”์†Œ๋“œ, Content-Type ํ—ค๋”๋ฅผ 'application/binary'๋กœ ์š”์ฒญ\n\n 3. 1๋ฒˆ ์‘๋‹ต `upload_key`๋ฅผ `POST /v1/files` ์š”์ฒญ ๋ฐ์ดํ„ฐ์— ๋„ฃ์–ด ํŒŒ์ผ ์—…๋กœ๋“œ ์™„๋ฃŒ","operationId":"upload_file_files_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadFileRequestSerializer"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadFileResponseSerializer"}}}},"422":{"description":"ํ•„์ˆ˜ ์š”์ฒญ ๋ฐ์ดํ„ฐ ๋ˆ„๋ฝ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}},"401":{"description":"๋น„์ธ์ฆ ์‚ฌ์šฉ์ž","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}}},"security":[{"ClientIdHeader":[]},{"ClientSecretHeader":[]},{"PermissionsDependency":[]},{"PermissionsDependency":[]}]}},"/files/{file_key}/download":{"get":{"tags":["File"],"summary":"์ฒจ๋ถ€ํŒŒ์ผ ๋‹ค์šด๋กœ๋“œ","operationId":"get_download_url_files__file_key__download_get","parameters":[{"required":true,"schema":{"type":"string","title":"File Key"},"name":"file_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDownloadUrlResponseSerializer"}}}},"422":{"description":"ํ•„์ˆ˜ ์š”์ฒญ ๋ฐ์ดํ„ฐ ๋ˆ„๋ฝ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}},"401":{"description":"๋น„์ธ์ฆ ์‚ฌ์šฉ์ž","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"examples":{"FileNotFound":{"value":{"error_code":"FileNotFound","message":"์กด์žฌํ•˜์ง€ ์•Š๋Š” ํŒŒ์ผ์ž…๋‹ˆ๋‹ค."}}}}}}},"security":[{"ClientIdHeader":[]},{"ClientSecretHeader":[]},{"PermissionsDependency":[]},{"PermissionsDependency":[]}]}},"/files/upload-url":{"post":{"tags":["File"],"summary":"์ฒจ๋ถ€ํŒŒ์ผ ์—…๋กœ๋“œ์šฉ presigned url ์ƒ์„ฑ","operationId":"generate_presigned_url_files_upload_url_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePresignedURLResponseSerializer"}}}},"422":{"description":"ํ•„์ˆ˜ ์š”์ฒญ ๋ฐ์ดํ„ฐ ๋ˆ„๋ฝ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}},"401":{"description":"๋น„์ธ์ฆ ์‚ฌ์šฉ์ž","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}}},"security":[{"ClientIdHeader":[]},{"ClientSecretHeader":[]},{"PermissionsDependency":[]},{"PermissionsDependency":[]}]}},"/stat/application/summary":{"get":{"tags":["Stat"],"summary":"(ํด๋ผ์ด์–ธํŠธ๋ณ„) ์ง€์› ํ˜„ํ™ฉ summary ์กฐํšŒ","operationId":"get_application_summary_by_client_stat_application_summary_get","parameters":[{"description":"์ง€์›์„œ ์ œ์ถœ ๋‚ ์งœ ์‹œ์ž‘ ๋ฒ”์œ„ (ํฌ๋งท: YYYY-MM-DD)","required":false,"schema":{"type":"string","format":"date","title":"Start Date","description":"์ง€์›์„œ ์ œ์ถœ ๋‚ ์งœ ์‹œ์ž‘ ๋ฒ”์œ„ (ํฌ๋งท: YYYY-MM-DD)","default":"2023-11-24"},"name":"start_date","in":"query"},{"description":"์ง€์›์„œ ์ œ์ถœ ๋‚ ์งœ ์ข…๋ฃŒ ๋ฒ”์œ„ (ํฌ๋งท: YYYY-MM-DD)","required":false,"schema":{"type":"string","format":"date","title":"End Date","description":"์ง€์›์„œ ์ œ์ถœ ๋‚ ์งœ ์ข…๋ฃŒ ๋ฒ”์œ„ (ํฌ๋งท: YYYY-MM-DD)","default":"2024-02-22"},"name":"end_date","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationSummaryResponseSerializer"}}}},"422":{"description":"ํ•„์ˆ˜ ์š”์ฒญ ๋ฐ์ดํ„ฐ ๋ˆ„๋ฝ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}},"401":{"description":"๋น„์ธ์ฆ ์‚ฌ์šฉ์ž","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAPIExceptionResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"examples":{"InvalidDateRange":{"value":{"error_code":"InvalidDateRange","message":"์‹œ์ž‘ ๋‚ ์งœ์™€ ์ข…๋ฃŒ ๋‚ ์งœ์˜ ์ฐจ์ด๋Š” 90์ผ์„ ๋„˜์„ ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค."}}}}}}},"security":[{"ClientIdHeader":[]},{"ClientSecretHeader":[]},{"PermissionsDependency":[]}]}}},"components":{"schemas":{"AddressResponseSerializer":{"properties":{"id":{"type":"integer","title":"Id"},"country":{"type":"string","title":"๊ตญ๊ฐ€"},"country_code":{"type":"string","title":"๊ตญ๊ฐ€ ์ฝ”๋“œ"},"location":{"type":"string","title":"Location"},"full_location":{"type":"string","title":"์ „์ฒด ์ฃผ์†Œ"},"geo_location":{"type":"object","title":"Geo Location"}},"type":"object","title":"AddressResponseSerializer"},"ApplicationListResponseSerializer":{"properties":{"links":{"$ref":"#/components/schemas/LinksSchema"},"applications":{"items":{"$ref":"#/components/schemas/ApplicationResponseSerializer"},"type":"array","title":"Applications"}},"type":"object","title":"ApplicationListResponseSerializer"},"ApplicationResponseSerializer":{"properties":{"id":{"type":"integer","title":"Id","description":"์ง€์›์„œID"},"oneid":{"type":"string","title":"Oneid","description":"์ง€์›์žID"},"username":{"type":"string","title":"Username","description":"์ง€์›์ž๋ช…"},"email":{"type":"string","title":"Email","description":"์ง€์›์ž ์ด๋ฉ”์ผ"},"mobile":{"type":"string","title":"Mobile","description":"ํฌ๋งทํŒ… ๋œ ์ „ํ™”๋ฒˆํ˜ธ (e.g. +821086388688)"},"application_status":{"allOf":[{"$ref":"#/components/schemas/ApplicationStatusSearchEnum"}],"description":"์ง€์›์„œ ์ƒํƒœ"},"apply_time":{"type":"string","format":"date-time","title":"Apply Time","description":"์ง€์›์„œ ์ œ์ถœ ์‹œ๊ฐ„"},"edited_time":{"type":"string","format":"date-time","title":"Edited Time","description":"์ง€์›์„œ ์ˆ˜์ • ์‹œ๊ฐ„"},"open_time":{"type":"string","format":"date-time","title":"Open Time","description":"์ง€์›์„œ ์ตœ์ดˆ ์—ด๋žŒ ์‹œ๊ฐ„"},"cancel_time":{"type":"string","format":"date-time","title":"Cancel Time","description":"์ง€์› ์ทจ์†Œ ์‹œ๊ฐ„"},"cancel_reason":{"type":"string","title":"Cancel Reason","description":"์ง€์› ์ทจ์†Œ ์‚ฌ์œ "},"company_id":{"type":"integer","title":"Company Id"},"company_name":{"type":"string","title":"Company Name","description":"๊ธฐ์—…๋ช…"},"job_id":{"type":"integer","title":"Job Id","description":"ํฌ์ง€์…˜ID"},"job_name":{"type":"string","title":"Job Name","description":"์ง€์› ์‹œ์ ์˜ ํฌ์ง€์…˜๋ช…"},"job_detail":{"allOf":[{"$ref":"#/components/schemas/openapi__apis__v1__applications__serializers__JobDetailResponseSerializer"}],"title":"Job Detail","description":"ํฌ์ง€์…˜ ์ƒ์„ธ"},"resumes":{"items":{"$ref":"#/components/schemas/FilesResponseSerializer"},"type":"array","title":"Resumes","description":"์ฒจ๋ถ€ํŒŒ์ผ ๋ชฉ๋ก"}},"type":"object","required":["id","oneid","username","email","mobile","application_status","apply_time","company_id","job_id"],"title":"ApplicationResponseSerializer","example":{"id":688129,"oneid":"QrKSEkh74AFf","username":"์ง€์›์ž๋ช…","email":"user@test.com","mobile":"+821023456789","application_status":"complte","apply_time":"2023-03-15T02:09:27.883418","company_id":1422,"company_name":"์›ํ‹ฐ๋“œ๋žฉ","job_id":23920,"job_name":"ํฌ์ง€์…˜๋ช…","job_detail":{"id":23920,"status":"active","company_id":1,"logo_url":{"origin":"https://...","thumb":"https://..."}},"files":[{"key":"qwefew-qweifj-1234","title":"์ด๋ ฅ์„œ.pdf","update_time":"2023-03-15T02:09:27.883418"}]}},"ApplicationStatusSearchEnum":{"type":"string","enum":["complete","pass","reject","hire"],"title":"ApplicationStatusSearchEnum","description":"An enumeration."},"ApplicationSummaryResponseSerializer":{"properties":{"complete":{"type":"integer","title":"Complete","default":0},"document_pass":{"type":"integer","title":"Document Pass","default":0},"hire":{"type":"integer","title":"Hire","default":0},"reject":{"type":"integer","title":"Reject","default":0},"total":{"type":"integer","title":"Total","default":0}},"type":"object","title":"ApplicationSummaryResponseSerializer","example":{"complete":1,"document_pass":1,"hire":0,"reject":1,"total":3}},"ApplyJobRequestSerializer":{"properties":{"job_id":{"type":"integer","title":"Job Id"},"username":{"type":"string","title":"Username"},"email":{"type":"string","title":"Email"},"mobile":{"type":"string","title":"Mobile"},"resume_keys":{"items":{"type":"string"},"type":"array","title":"Resume Keys","description":"์ง€์›์‹œ ์ฒจ๋ถ€ํ•  ํŒŒ์ผ ๋ฆฌ์ŠคํŠธ"}},"type":"object","required":["job_id","username","email","mobile","resume_keys"],"title":"ApplyJobRequestSerializer"},"ApplyTextPredictionRequestSerializer":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ResumeJdTextPredictionItemSerializer"},"type":"array","title":"์˜ˆ์ธก์š”์ฒญ ๋ฐ์ดํ„ฐ ๋ฆฌ์ŠคํŠธ"},"callback_url":{"type":"string","title":"CallbackURL","description":"๋น„๋™๊ธฐ ์ฒ˜๋ฆฌํ›„ ๊ฒฐ๊ณผ๋ฅผ ํ†ต๋ณด๋ฐ›์„ URL","example":"http://my-server.com/v1/apply/callback"},"request_id":{"type":"string","title":"์š”์ฒญID","description":"์ฒ˜๋ฆฌ๊ฒฐ๊ณผ ํ†ต๋ณด ์‹œ ์š”์ฒญID๊ฐ€ ํ•จ๊ป˜ ์ „๋‹ฌ๋จ.\n ๊ธฐ๋ณธ์ ์œผ๋กœ UUIDํ˜•ํƒœ๋กœ ์ž๋™์ƒ์„ฑ ๋˜๋‚˜, ํด๋ผ์ด์–ธํŠธ ์ธก ๋กœ์ง์— ์˜ํ•ด ๋น„๋™๊ธฐ ์š”์ฒญ ํ”„๋กœ์„ธ์Šค๋ณด๋‹ค ํ†ต๋ณดURLํ˜ธ์ถœ์ด ๋จผ์ € ์ด๋ฃจ์–ด ์ง€๋Š” ๊ฒฝ์šฐ ๋ฏธ๋ฆฌ request_id๋ฅผ ์ง€์ •ํ•ด์•ผ ํ•จ\n ","example":"55e41f9f-a5a6-4836-8490-68914ff51b64"}},"type":"object","required":["data","callback_url"],"title":"ApplyTextPredictionRequestSerializer"},"AsyncPredictionResponseSerializer":{"properties":{"request_id":{"type":"string","title":"์š”์ฒญID","description":"\nCallbackURL ํ˜ธ์ถœ ์‹œ ์–ด๋–ค ์š”์ฒญ์—๋Œ€ํ•œ ๊ฒฐ๊ณผ์ธ์ง€ ๊ตฌ๋ถ„์„ ์œ„ํ•ด ์š”์ฒญID๋ฅผ ํ•จ๊ป˜ ์ „๋‹ฌ\n","example":"55e41f9f-a5a6-4836-8490-68914ff51b64"}},"type":"object","required":["request_id"],"title":"AsyncPredictionResponseSerializer"},"CancelApplicationRequestSerializer":{"properties":{"cancel_reason":{"type":"string","title":"Cancel Reason"}},"type":"object","title":"CancelApplicationRequestSerializer"},"CategoryTagResponseSerializer":{"properties":{"parent_tag":{"allOf":[{"$ref":"#/components/schemas/openapi__apis__v1__jobs__serializers__TagResponseSerializer"}],"title":"์ง๊ตฐ"},"child_tags":{"items":{"$ref":"#/components/schemas/openapi__apis__v1__jobs__serializers__TagResponseSerializer"},"type":"array","title":"์ง๋ฌด"}},"type":"object","title":"CategoryTagResponseSerializer"},"CompanyAutoCompleteResponseSerializer":{"properties":{"data":{"items":{"$ref":"#/components/schemas/_CompanyAutoCompleteSerializer"},"type":"array","title":"Data"}},"type":"object","title":"CompanyAutoCompleteResponseSerializer","example":{"data":[{"company_id":518,"name":"์›ํ‹ฐ๋“œ๋žฉ","logo_image":"https://image.jpg"}]}},"CompanyDetailResponseSerializer":{"properties":{"id":{"type":"integer","title":"๊ธฐ์—…ID"},"company_confirm":{"type":"boolean","title":"๊ธฐ์—… ์Šน์ธ์—ฌ๋ถ€","description":"True: ์Šน์ธ ์™„๋ฃŒ,\n False: ์Šน์ธ ๊ฑฐ์ ˆ, ์Šน์ธ ์š”์ฒญ์ค‘, ์Šน์ธ ์š”์ฒญ ์•ˆํ•จ"},"registration_number":{"type":"string","title":"์‚ฌ์—…์ž๋ฒˆํ˜ธ"},"name":{"type":"string","title":"๊ธฐ์—…๋ช…"},"logo_url":{"$ref":"#/components/schemas/ImageUrlSchema"},"images":{"items":{"type":"object"},"type":"array","title":"ํšŒ์‚ฌ ์ด๋ฏธ์ง€"},"description":{"type":"string","title":"ํšŒ์‚ฌ์†Œ๊ฐœ"},"link":{"type":"string","title":"๊ธฐ์—… ํŽ˜์ด์ง€ ๋งํฌ"},"url":{"type":"string","title":"ํšŒ์‚ฌ ์ƒ์„ธ ํŽ˜์ด์ง€ url"}},"type":"object","required":["id","company_confirm","name","url"],"title":"CompanyDetailResponseSerializer"},"CompanyJobListResponseSerializer":{"properties":{"links":{"$ref":"#/components/schemas/LinksSchema"},"jobs":{"items":{"$ref":"#/components/schemas/openapi__apis__v1__companies__serializers__JobResponseSerializer"},"type":"array","title":"Jobs"}},"type":"object","title":"CompanyJobListResponseSerializer","example":{"links":{"next":"/v1/companies/79/jobs?offset=12&limit=12"},"jobs":[{"id":23617,"name":"VR ์—”์ง€๋‹ˆ์–ด","reward":{"country":"KR","total":"100๋งŒ์›","recommender":"50๋งŒ์›","recommendee":"50๋งŒ์›"},"url":"https://www.wanted.co.kr/wd/10002"},{"id":23652,"name":"QA","due_time":"2023-03-21"}]}},"CompanyResponseSerializer":{"properties":{"company":{"$ref":"#/components/schemas/CompanyDetailResponseSerializer"}},"type":"object","title":"CompanyResponseSerializer","example":{"company":{"id":79,"company_confirm":true,"registration_number":"12622032023","name":"์›ํ‹ฐ๋“œ๋žฉ","logo_url":{"origin":"https://...","thumb":"https://..."},"images":[{"id":1894,"is_title":true,"origin":"https://...","thumb":"https://..."},{"id":1889,"is_title":false,"origin":"https://...","thumb":"https://..."}],"description":"์›ํ‹ฐ๋“œ๋žฉ ํšŒ์‚ฌ ์†Œ๊ฐœ","link":"http://wanted.co.kr/","url":"https://www.wanted.co.kr/company/79?client_id=xxxx"}}},"CompanyTagResponseSerializer":{"properties":{"tag_type_id":{"type":"integer","title":"ํƒœ๊ทธID"},"text":{"type":"string","title":"ํƒœ๊ทธ๋ช…"}},"type":"object","title":"CompanyTagResponseSerializer"},"CountryEnum":{"type":"string","enum":["KR","JP","TW","HK","SG","WW"],"title":"CountryEnum","description":"An enumeration."},"CreatePresignedURLResponseSerializer":{"properties":{"presigned_url":{"type":"string","title":"Presigned Url"},"upload_key":{"type":"string","title":"Upload Key"}},"type":"object","required":["presigned_url","upload_key"],"title":"CreatePresignedURLResponseSerializer","example":{"presigned_url":"https://...","upload_key":"qwe0982awfwef"}},"FilesResponseSerializer":{"properties":{"key":{"type":"string","title":"Key"},"title":{"type":"string","title":"Title"},"update_time":{"type":"string","format":"date-time","title":"Update Time"}},"type":"object","required":["key","update_time"],"title":"FilesResponseSerializer"},"GetDownloadUrlResponseSerializer":{"properties":{"presigned_url":{"type":"string","title":"Presigned Url"}},"type":"object","required":["presigned_url"],"title":"GetDownloadUrlResponseSerializer","example":{"url":"https://..."}},"GetFileListResponseSerializer":{"properties":{"links":{"$ref":"#/components/schemas/LinksSchema"},"data":{"items":{"$ref":"#/components/schemas/FilesResponseSerializer"},"type":"array","title":"Data"}},"type":"object","title":"GetFileListResponseSerializer","example":{"data":[{"key":"AAUIBQQDSgdNVQ==","title":"string.pdf","update_time":"2023-04-10T16:53:23"}],"links":{"prev":"http://...","next":"http://..."}}},"ImageUrlResponseSerializer":{"properties":{"origin":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Origin"},"thumb":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Thumb"},"is_title":{"type":"boolean","title":"Is Title","default":false}},"type":"object","title":"ImageUrlResponseSerializer"},"ImageUrlSchema":{"properties":{"origin":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Origin","description":"์›๋ณธ ์ด๋ฏธ์ง€ URL"},"thumb":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Thumb","description":"์ธ๋„ค์ผ ์ด๋ฏธ์ง€ URL"}},"type":"object","title":"ImageUrlSchema"},"JobCompanyResponseSerializer":{"properties":{"id":{"type":"integer","title":"๊ธฐ์—…ID"},"name":{"type":"string","title":"๊ธฐ์—…๋ช…"},"link":{"type":"string","title":"๊ธฐ์—… ํŽ˜์ด์ง€ ๋งํฌ"},"registration_number":{"type":"string","title":"์‚ฌ์—…์ž๋ฒˆํ˜ธ"},"logo_img":{"allOf":[{"$ref":"#/components/schemas/ImageUrlResponseSerializer"}],"title":"๋กœ๊ณ  ์ด๋ฏธ์ง€"},"description":{"type":"string","title":"ํšŒ์‚ฌ์†Œ๊ฐœ"},"company_tags":{"items":{"$ref":"#/components/schemas/CompanyTagResponseSerializer"},"type":"array","title":"๊ธฐ์—… ํƒœ๊ทธ","default":[]}},"type":"object","title":"JobCompanyResponseSerializer"},"JobListAddressResponseSerializer":{"properties":{"country":{"type":"string","title":"Country"},"location":{"type":"string","title":"Location"},"full_location":{"type":"string","title":"Full Location"}},"type":"object","title":"JobListAddressResponseSerializer"},"JobListDetailResponseSerializer":{"properties":{"id":{"type":"integer","title":"ํฌ์ง€์…˜ID"},"status":{"$ref":"#/components/schemas/JobStatusEnum"},"due_time":{"type":"string","format":"date","title":"๋งˆ๊ฐ์ผ"},"position":{"type":"string","title":"ํฌ์ง€์…˜๋ช…"},"company":{"allOf":[{"$ref":"#/components/schemas/JobCompanyResponseSerializer"}],"title":"ํšŒ์‚ฌ"},"reward":{"allOf":[{"$ref":"#/components/schemas/RewardResponseSerializer"}],"title":"๋ณด์ƒ๊ธˆ"},"address":{"allOf":[{"$ref":"#/components/schemas/JobListAddressResponseSerializer"}],"title":"์ฃผ์†Œ"},"title_img":{"$ref":"#/components/schemas/ImageUrlResponseSerializer"},"logo_img":{"$ref":"#/components/schemas/ImageUrlResponseSerializer"},"category_tags":{"allOf":[{"$ref":"#/components/schemas/CategoryTagResponseSerializer"}],"title":"์ง๊ตฐ/์ง๋ฌด ํƒœ๊ทธ"},"url":{"type":"string","title":"ํฌ์ง€์…˜ ํŽ˜์ด์ง€ ์ƒ์„ธ URL"}},"type":"object","required":["id","status","position","company","url"],"title":"JobListDetailResponseSerializer"},"JobListResponseSerializer":{"properties":{"links":{"$ref":"#/components/schemas/LinksSchema"},"data":{"items":{"$ref":"#/components/schemas/JobListDetailResponseSerializer"},"type":"array","title":"Data"}},"type":"object","title":"JobListResponseSerializer","example":{"data":[{"id":24049,"status":"active","due_time":"2023-05-01","name":"ํฌ์ง€์…˜๋ช…","address":{"country":"ํ•œ๊ตญ","location":"์„œ์šธ"},"title_img":{"origin":"https://...","thumb":"https://..."},"logo_img":{"origin":"https://...","thumb":"https://..."},"company":{"id":7565,"name":"๊ธฐ์—…๋ช…"},"reward":{"total":"100๋งŒ์›","recommender":"50๋งŒ์›","recommendee":"50๋งŒ์›"}}],"links":{"prev":"/api/chaos/jobs/v1?country=KR&sort=company.response_rate_order&offset=1&limit=1","next":"/api/chaos/jobs/v1?country=KR&sort=company.response_rate_order&offset=1&limit=1"}}},"JobSortEnum":{"enum":["job.latest_order","job.popularity_order","company.response_rate_order"],"title":"JobSortEnum","description":"An enumeration."},"JobStatusEnum":{"type":"string","enum":["request","draft","active","archived","close","saved"],"title":"JobStatusEnum","description":"An enumeration."},"LinksSchema":{"properties":{"prev":{"type":"string","title":"Prev","description":"์ด์ „ํŽ˜์ด์ง€"},"next":{"type":"string","title":"Next","description":"๋‹ค์ŒํŽ˜์ด์ง€"}},"type":"object","title":"LinksSchema"},"OpenAPIExceptionResponse":{"properties":{"error_code":{"type":"string","title":"Error Code"},"message":{"type":"string","title":"Message"},"data":{"type":"object","title":"Data"}},"type":"object","required":["error_code","message"],"title":"OpenAPIExceptionResponse"},"ParentTagResponseSerializer":{"properties":{"id":{"type":"integer","title":"Id","description":"ํƒœ๊ทธID"},"parent_id":{"type":"integer","title":"Parent Id","description":"์ƒ์œ„ ํƒœ๊ทธID"},"title":{"type":"string","title":"Title","description":"ํƒœ๊ทธ๋ช…"},"title_thumb_img":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Title Thumb Img","description":"ํƒœ๊ทธ ์ด๋ฏธ์ง€ URL"},"sub_tags":{"items":{"$ref":"#/components/schemas/openapi__apis__v1__tags__serializers__TagResponseSerializer"},"type":"array","title":"Sub Tags"}},"type":"object","required":["id","title"],"title":"ParentTagResponseSerializer"},"PassTextPredictionRequestSerializer":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ResumeJdTextPredictionItemSerializer"},"type":"array","title":"์˜ˆ์ธก์š”์ฒญ ๋ฐ์ดํ„ฐ ๋ฆฌ์ŠคํŠธ"},"callback_url":{"type":"string","title":"CallbackURL","description":"๋น„๋™๊ธฐ ์ฒ˜๋ฆฌํ›„ ๊ฒฐ๊ณผ๋ฅผ ํ†ต๋ณด๋ฐ›์„ URL","example":"http://my-server.com/v1/pass/callback"},"request_id":{"type":"string","title":"์š”์ฒญID","description":"์ฒ˜๋ฆฌ๊ฒฐ๊ณผ ํ†ต๋ณด ์‹œ ์š”์ฒญID๊ฐ€ ํ•จ๊ป˜ ์ „๋‹ฌ๋จ.\n ๊ธฐ๋ณธ์ ์œผ๋กœ UUIDํ˜•ํƒœ๋กœ ์ž๋™์ƒ์„ฑ ๋˜๋‚˜, ํด๋ผ์ด์–ธํŠธ ์ธก ๋กœ์ง์— ์˜ํ•ด ๋น„๋™๊ธฐ ์š”์ฒญ ํ”„๋กœ์„ธ์Šค๋ณด๋‹ค ํ†ต๋ณดURLํ˜ธ์ถœ์ด ๋จผ์ € ์ด๋ฃจ์–ด ์ง€๋Š” ๊ฒฝ์šฐ ๋ฏธ๋ฆฌ request_id๋ฅผ ์ง€์ •ํ•ด์•ผ ํ•จ\n ","example":"55e41f9f-a5a6-4836-8490-68914ff51b64"}},"type":"object","required":["data","callback_url"],"title":"PassTextPredictionRequestSerializer"},"ResumeJdTextPredictionItemSerializer":{"properties":{"resume":{"type":"string","title":"์ด๋ ฅ์„œํ…์ŠคํŠธ","example":"5๋…„์ฐจ ์†Œํ”„ํŠธ์›จ์–ด ์—”์ง€๋‹ˆ์–ด ์ž…๋‹ˆ๋‹ค..."},"jd":{"type":"string","title":"JDํ…์ŠคํŠธ","example":"5๋…„์ฐจ ์†Œํ”„ํŠธ์›จ์–ด ์—”์ง€๋‹ˆ์–ด ๊ตฌํ•ฉ๋‹ˆ๋‹ค..."}},"type":"object","required":["resume","jd"],"title":"ResumeJdTextPredictionItemSerializer"},"RewardResponseSerializer":{"properties":{"country":{"$ref":"#/components/schemas/CountryEnum"},"formatted_total":{"type":"string","title":"Formatted Total","description":"์ „์ฒด ๋ณด์ƒ๊ธˆ","default":"0"},"formatted_recommender":{"type":"string","title":"Formatted Recommender","description":"์ถ”์ฒœ์ธ ๋ณด์ƒ๊ธˆ","default":"0"},"formatted_recommendee":{"type":"string","title":"Formatted Recommendee","description":"์ง€์›์ž ๋ณด์ƒ๊ธˆ","default":"0"}},"type":"object","title":"RewardResponseSerializer"},"SearchCompanyResponseSerializer":{"properties":{"links":{"$ref":"#/components/schemas/LinksSchema"},"data":{"items":{"$ref":"#/components/schemas/_SearchCompanySchema"},"type":"array","title":"Data"}},"type":"object","title":"SearchCompanyResponseSerializer","example":{"links":{"next":"/api/chaos/search/v1/company?query=%EC%9B%90%ED%8B%B0%EB%93%9C&offset=1&limit=1&offset=1&limit=1"},"companies":[{"id":79,"name":"์›ํ‹ฐ๋“œ๋žฉ","logo_img":{"origin":"https://static.wanted.co.kr/nextweek/images/wdes/0_4.7d6ea9b0.test_nextweek.jpg","thumb":"https://static.wanted.co.kr/nextweek/images/wdes/0_5.7d6ea9b0.test_nextweek.jpg"},"title_img":{"origin":"https://static.wanted.co.kr/images/company/79/15562_2_6.__1080_790.jpg","thumb":"https://static.wanted.co.kr/images/company/79/15562_2_6.__400_400.jpg"},"description":"์›ํ‹ฐ๋“œ๋žฉ ์ตœ๊ณ ","url":"https://www.wanted.co.kr/company/79?client_id=xxxx"}]}},"SkillListResponseSerializer":{"properties":{"skills":{"items":{"$ref":"#/components/schemas/ParentTagResponseSerializer"},"type":"array","title":"Skills"}},"type":"object","title":"SkillListResponseSerializer","example":{"data":[{"id":1540,"title":"Java"}]}},"TagListResponseSerializer":{"properties":{"tags":{"items":{"$ref":"#/components/schemas/ParentTagResponseSerializer"},"type":"array","title":"Tags"}},"type":"object","title":"TagListResponseSerializer","example":{"data":[{"id":518,"title":"๊ฐœ๋ฐœ","image_url":"https://...","sub_tags":[{"id":873,"parent_id":518,"title":"์›น ๊ฐœ๋ฐœ์ž","image_url":"https://..."},{"id":872,"parent_id":518,"title":"์„œ๋ฒ„ ๊ฐœ๋ฐœ์ž","image_url":"https://..."}]}]}},"UploadFileRequestSerializer":{"properties":{"upload_key":{"type":"string","title":"Upload Key","description":"`/v1/files/upload-url` ์‘๋‹ต์˜ upload_key"},"title":{"type":"string","title":"ํŒŒ์ผ๋ช…","description":"`/v1/files/upload-url` ์‘๋‹ต์˜ `presigned_url` ์ด์šฉํ•ด์„œ ์—…๋กœ๋“œํ•œ ํŒŒ์ผ์˜ ํ™•์žฅ์ž๋ฅผ ํฌํ•จํ•œ ํŒŒ์ผ๋ช…"}},"type":"object","required":["upload_key","title"],"title":"UploadFileRequestSerializer","example":{"upload_key":"0362e393-45b7-4bca-9e33-676cffcc5cbe","title":"์ฒจ๋ถ€ํŒŒ์ผ.pdf"}},"UploadFileResponseSerializer":{"properties":{"key":{"type":"string","title":"Key"}},"type":"object","required":["key"],"title":"UploadFileResponseSerializer","example":{"key":"AAUIBQQGSgdNVQ=="}},"_CompanyAutoCompleteSerializer":{"properties":{"company_id":{"type":"integer","title":"Company Id","description":"ํšŒ์‚ฌ ID"},"name_ko":{"type":"string","title":"Name Ko","description":"ํšŒ์‚ฌ๋ช…"},"logo_image":{"type":"string","title":"Logo Image","description":"ํšŒ์‚ฌ๋กœ๊ณ  ์ด๋ฏธ์ง€ url"}},"type":"object","required":["company_id","name_ko"],"title":"_CompanyAutoCompleteSerializer"},"_SearchCompanySchema":{"properties":{"id":{"type":"integer","title":"Id","description":"ํšŒ์‚ฌ ID"},"name":{"type":"string","title":"Name","description":"ํšŒ์‚ฌ๋ช…"},"logo_img":{"$ref":"#/components/schemas/ImageUrlSchema"},"title_img":{"$ref":"#/components/schemas/ImageUrlSchema"},"description":{"type":"string","title":"Description","description":"ํšŒ์‚ฌ์„ค๋ช…"},"url":{"type":"string","title":"Url","description":"ํšŒ์‚ฌ ์ƒ์„ธ ํŽ˜์ด์ง€ url"}},"type":"object","required":["id","name","url"],"title":"_SearchCompanySchema"},"openapi__apis__v1__applications__serializers__JobDetailResponseSerializer":{"properties":{"id":{"type":"integer","title":"Id"},"status":{"$ref":"#/components/schemas/JobStatusEnum"},"company_id":{"type":"integer","title":"Company Id"},"due_time":{"type":"string","format":"date","title":"Due Time","description":"๋งˆ๊ฐ์ผ"},"logo_url":{"$ref":"#/components/schemas/ImageUrlResponseSerializer"}},"type":"object","required":["id","status"],"title":"JobDetailResponseSerializer"},"openapi__apis__v1__companies__serializers__JobResponseSerializer":{"properties":{"id":{"type":"integer","title":"Id","description":"ํฌ์ง€์…˜ID"},"name":{"type":"string","title":"Name","description":"ํฌ์ง€์…˜๋ช…"},"due_time":{"type":"string","format":"date","title":"Due Time","description":"๋งˆ๊ฐ์ผ"},"reward":{"allOf":[{"$ref":"#/components/schemas/RewardResponseSerializer"}],"title":"Reward","description":"๋ณด์ƒ๊ธˆ"},"url":{"type":"string","title":"ํฌ์ง€์…˜ ํŽ˜์ด์ง€ ์ƒ์„ธ URL"}},"type":"object","required":["id","name","url"],"title":"JobResponseSerializer"},"openapi__apis__v1__jobs__serializers__JobDetailResponseSerializer":{"properties":{"position":{"type":"string","title":"ํฌ์ง€์…˜๋ช…"},"intro":{"type":"string","title":"์ธํŠธ๋กœ"},"main_tasks":{"type":"string","title":"์ฃผ์š”์—…๋ฌด"},"requirements":{"type":"string","title":"์ž๊ฒฉ์š”๊ฑด"},"preferred_points":{"type":"string","title":"์šฐ๋Œ€์‚ฌํ•ญ"},"benefits":{"type":"string","title":"ํ˜œํƒ ๋ฐ ๋ณต์ง€"}},"type":"object","title":"JobDetailResponseSerializer"},"openapi__apis__v1__jobs__serializers__JobResponseSerializer":{"properties":{"id":{"type":"integer","title":"ํฌ์ง€์…˜ID"},"status":{"$ref":"#/components/schemas/JobStatusEnum"},"due_time":{"type":"string","format":"date","title":"๋งˆ๊ฐ์ผ"},"detail":{"$ref":"#/components/schemas/openapi__apis__v1__jobs__serializers__JobDetailResponseSerializer"},"category_tags":{"allOf":[{"$ref":"#/components/schemas/CategoryTagResponseSerializer"}],"title":"์ง๊ตฐ/์ง๋ฌด ํƒœ๊ทธ"},"skill_tags":{"items":{"$ref":"#/components/schemas/openapi__apis__v1__jobs__serializers__TagResponseSerializer"},"type":"array","title":"์Šคํ‚ฌ ํƒœ๊ทธ"},"company":{"allOf":[{"$ref":"#/components/schemas/JobCompanyResponseSerializer"}],"title":"ํšŒ์‚ฌ"},"reward":{"allOf":[{"$ref":"#/components/schemas/RewardResponseSerializer"}],"title":"๋ณด์ƒ๊ธˆ"},"address":{"allOf":[{"$ref":"#/components/schemas/AddressResponseSerializer"}],"title":"์ฃผ์†Œ"},"images":{"items":{"$ref":"#/components/schemas/ImageUrlResponseSerializer"},"type":"array","title":"Images"},"url":{"type":"string","title":"ํฌ์ง€์…˜ ํŽ˜์ด์ง€ ์ƒ์„ธ URL"}},"type":"object","required":["url"],"title":"JobResponseSerializer","example":{"id":24090,"status":"active","due_time":"2023-05-01","detail":{"intro":"โ€˜์›ํ‹ฐ๋“œ๋žฉโ€™์€ ์ „ ์„ธ๊ณ„ ๋ชจ๋“  ๊ธฐ์—…๊ณผ ์ง์žฅ์ธ์˜ ๊ณ ๋ฏผ์„ ํ•ด๊ฒฐํ•˜๊ธฐ ์œ„ํ•œ HR ์Šคํƒ€ํŠธ์—…์ž…๋‹ˆ๋‹ค. ์ง์žฅ์ธ์˜ 90%๋Š” ์ด์ง์„ ์ƒ๊ฐํ•˜์ง€๋งŒ, ์–ด๋–ค ๊ธฐ์—…์ด ์ž์‹ ์—๊ฒŒ ์ตœ์„ ์˜ ์„ ํƒ์ธ์ง€ ์•Œ์ง€ ๋ชปํ•œ ์ฑ„ ์—…๋ฌด์— ์ž์‹ ์„ ๋งž์ถ”๊ณ  ์žˆ์Šต๋‹ˆ๋‹ค. ๊ธฐ์—…์€ ๋ˆ„๊ตฐ๊ฐ€์— ์˜ํ•ด ๊ฒ€์ฆ๋œ ์ธ์žฌ๋ฅผ ์ฑ„์šฉํ•˜๊ณ  ์‹ถ์ง€๋งŒ, ๊ทธ ๋น„์šฉ๊ณผ ์‹œ๊ฐ„์ด ๋งŒ๋งŒ์น˜ ์•Š์•„ ์žกํฌํ„ธ ๊ด‘๊ณ ์™€ ์˜คํ”„๋ผ์ธ ํ—ค๋“œํ—ŒํŒ…์— ์˜์กดํ•˜๊ณ  ์žˆ์Šต๋‹ˆ๋‹ค. \n\n์šฐ๋ฆฌ๋Š” ๋‹จ์ˆœํ•œ ์ฑ„์šฉ ์„œ๋น„์Šค๊ฐ€ ๋˜๋ ค๋Š” ๊ฒƒ์ด ์•„๋‹™๋‹ˆ๋‹ค. ์šฐ๋ฆฌ๋Š” โ€˜์ข‹์€ ์ผ์ž๋ฆฌ์™€ ์ˆจ์€ ์ธ์žฌ๋ฅผ ์—ฐ๊ฒฐํ•˜๋Š” ๊ฐ€์žฅ ํšจ์œจ์ ์ด๊ณ  ์ธ๊ฐ„์ ์ธ ๋ฐฉ๋ฒ•โ€™์ด๋ผ๋Š” ๋ฌธ์ œ๋ฅผ ํ’€๊ณ ์ž ํ•ฉ๋‹ˆ๋‹ค. ์ธ์žฌ์—๊ฒŒ๋Š” ์ž์‹ ์˜ ์—ญ๋Ÿ‰์„ ์œ ๊ฐ์—†์ด ๋ฐœํœ˜ํ•  ์ˆ˜ ์žˆ๋Š” ์ผ์ž๋ฆฌ๋ฅผ ์ถ”์ฒœํ•˜๊ณ , ๊ธฐ์—…์—๊ฒŒ๋Š” ํ•„์š”ํ•œ ์ž๋ฆฌ์— ๋”ฑ ๋งž๋Š” ์ธ์žฌ๋ฅผ ์ถ”์ฒœํ•˜๋Š” ์„œ๋น„์Šค์ž…๋‹ˆ๋‹ค. ์ด๋ฅผ ์œ„ํ•ด ๋ชจ๋ฐ”์ผ / ์†Œ์…œ ๋„คํŠธ์›Œํฌ / ๋น…๋ฐ์ดํ„ฐ์— ๊ธฐ๋ฐ˜ํ•œ HR ์†”๋ฃจ์…˜๋“ค์„ ํ•˜๋‚˜์”ฉ ๋งŒ๋“ค์–ด๋‚˜๊ฐ€๊ณ  ์žˆ์Šต๋‹ˆ๋‹ค. ์šฐ๋ฆฌ์˜ ์‹œ์„ ์€ ํ•œ๊ตญ์— ๋จธ๋ฌผ๋Ÿฌ ์žˆ์ง€ ์•Š์Šต๋‹ˆ๋‹ค. \n\n2015๋…„ 5์›” ์„œ๋น„์Šค๋ฅผ ์‹œ์ž‘ํ•˜์—ฌ, 2019๋…„ 3์›” ํ˜„์žฌ 4000์—ฌ ๊ธฐ์—…, 60๋งŒ ์œ ์ €(ํ•œ๊ตญ ๊ธฐ์ค€)๊ฐ€ ์ด์šฉ ์ค‘์— ์žˆ์Šต๋‹ˆ๋‹ค. 2017๋…„ 5์›”์—๋Š” 100์–ต ํˆฌ์ž๋ฅผ ๋ฐ›์•˜์œผ๋ฉฐ, ํ•œ๊ตญ/์ผ๋ณธ/๋Œ€๋งŒ/์‹ฑ๊ฐ€ํด/ํ™์ฝฉ ์˜คํ”ผ์Šค์— 65์—ฌ๋ช…์˜ ๊ตฌ์„ฑ์›๋“ค๊ณผ ํ•จ๊ป˜ ์•„์‹œ์•„ HR ์‹œ์žฅ์„ ์„ ๋„ํ•˜๊ณ ์ž ํ•ฉ๋‹ˆ๋‹ค. \n \n2016๋…„ ์•„์‹œ์•„ ์ตœ์ดˆ๋กœ ์„ค๋ฆฝ๋œ Google Campus์˜ ์ฒซ ๋ฒˆ์งธ ์ž…์ฃผ๊ธฐ์—…์œผ๋กœ ์„ ๋ฐœ๋˜์—ˆ์œผ๋ฉฐ, 2016๋…„ KMA ๋Œ€ํ•œ๋ฏผ๊ตญ๋ชจ๋ฐ”์ผ์–ด์›Œ๋“œ ๋Œ€์ƒ ์ˆ˜์ƒ, 2017๋…„ AWS์˜ ๋– ์˜ค๋ฅด๋Š” ์Šคํƒ€ํŠธ์—… ์„ ์ •, Facebook Korea๊ฐ€ ์„ ์ •ํ•œ ๋Œ€ํ‘œ์ ์ธ ํŒŒํŠธ๋„ˆ์‹ญ ์‚ฌ๋ก€๋กœ ์†Œ๊ฐœ, 2018๋…„ Forbes๊ฐ€ ์„ ์ •ํ•œ 2018๋…„ ์ฃผ๋ชฉํ•ด์•ผ ํ•  ํ•œ๊ตญ ์Šคํƒ€ํŠธ์—…์œผ๋กœ ์„ ์ •๋˜์—ˆ๊ณ , ๋˜ํ•œ Google TensorFlow๋ฅผ ํ™œ์šฉํ•˜์—ฌ ๋งค์นญ ์„œ๋น„์Šค๋ฅผ ํ•˜๊ณ  ์žˆ๋Š” ๊ตญ๋‚ด ์ฒซ ์‚ฌ๋ก€๋กœ ๊ตฌ๊ธ€ ๊ฐœ๋ฐœ์ž ํ–‰์‚ฌ์—์„œ ์‚ฌ๋ก€๋ฅผ ๋ฐœํ‘œํ•˜๊ธฐ๋„ ํ•˜์˜€์Šต๋‹ˆ๋‹ค.","main_tasks":"โ€ข ๋ฉ”์ดํ”Œ ์Šคํ† ๋ฆฌ2 ๊ธฐํš ์—…๋ฌด \nโ€ข ๊ฒŒ์ž„์˜ ์žฌ๋ฏธ๋ฅผ ์œ„ํ•œ ๋‹ค์–‘ํ•œ ๋ฃฐ์ด๋‚˜ ์‹œ์Šคํ…œ์„ ๊ธฐํšํ•˜๊ณ  ์ด๋ฅผ ๊ตฌํ˜„","requirements":"โ€ข ์‹ค๋ฌด์—์„œ MS Office๋ฅผ ํ™œ์šฉํ•˜๋Š”๋ฐ ํฐ ๋ฌธ์ œ๊ฐ€ ์—†๋Š” ๋ถ„ \nโ€ข ๊ฒŒ์ž„์„ ์ฆ๊ธฐ๊ณ  ์ข‹์•„ํ•˜์‹œ๋Š” ๋ถ„","preferred_points":"โ€ข ๋…ํŠนํ•˜๊ณ  ์ฐฝ์˜์ ์ธ ์•„์ด๋””์–ด๊ฐ€ ๋„˜์น˜๋Š” ๋ถ„ \nโ€ข ํŠน์ • ํฌ์ง€์…˜์— ์ข…์†๋˜์ง€ ์•Š๊ณ  ๊ฒŒ์ž„ ๊ธฐํš ์ „๋ฐ˜์˜ ๋‹ค์–‘ํ•œ ์—ญํ• ์„ ์ˆ˜ํ–‰ํ•  ์ˆ˜ ์žˆ์œผ์‹  ๋ถ„ \nโ€ข ๋ฉ”์ดํ”Œ ์Šคํ† ๋ฆฌ2์˜ ํ”Œ๋ ˆ์ด ๊ฒฝํ—˜๊ณผ ์ดํ•ด๋„๊ฐ€ ์žˆ์œผ์‹  ๋ถ„","benefits":"โ€ข ์ „ ์ง์žฅ๋ณด๋‹ค ์‹œ๊ฐ„์ /๊ฒฝ์ œ์ ์œผ๋กœ ๋” ๋‚˜์€ ์‚ถ ์ถ”๊ตฌ\nโ€ข ํ•˜๋ฃจ 8์‹œ๊ฐ„, ์•ผ๊ทผ์—†์ด ์ง‘์ค‘ํ•˜๋Š” ๋ฌธํ™” ์ •์ฐฉ\nโ€ข ํŽธ๋ฆฌํ•œ ์ถœํ‡ด๊ทผ (์—ญ์‚ผ์—ญ 3๋ฒˆ ์ถœ๊ตฌ ๋„๋ณด 10์ดˆ)\nโ€ข ์ž์œจ์  ์—…๋ฌดํ™˜๊ฒฝ (์œ„์›Œํฌ ์‚ฌ๋ฌด์‹ค, ๋ผ์šด์ง€/๋ถ€์Šค, ์ˆ˜ํ‰์  ์กฐ์ง, ๋งฅ์ฃผ ๋ฌดํ•œ๋Œ€)\nโ€ข ํœด๊ฐ€๋‹ค์šด ํœด๊ฐ€ (์‚ฌ์œ ๋‚˜ ์Šน์ธ์—†์ด ์Šค์Šค๋กœ ํœด๊ฐ€ ๊ณ„ํš, 3/5/7๋…„ ๋งŒ๊ทผ์‹œ 2์ฃผ ๋ฆฌํ”„๋ ˆ์‹œ ํœด๊ฐ€)\nโ€ข ๋ฐ˜๋ ค๋™๋ฌผ, ํœด๋Œ€๊ฐ€๋Šฅํ•œ ์•…๊ธฐ, ์ž์ „๊ฑฐ์™€ ๋™๋ฐ˜์ถœ๊ทผ ๊ฐ€๋Šฅ\nโ€ข ์—…๋ฌด๊ด€๋ จ ์ปจํผ๋Ÿฐ์Šค/๊ต์œก/๋„์„œ๊ตฌ๋งค๋น„ ์ง€์›\nโ€ข ์›” 1ํšŒ ํŒ€ ์‹์‚ฌ ๋ฐ ํ‹ฐํƒ€์ž„ ์ œ๊ณต\nโ€ข ์ง๋ฌด ์ˆ˜ํ–‰์— ํ•„์š”ํ•œ ์ตœ์‹ ์žฅ๋น„/์†Œํ”„ํŠธ์›จ์–ด ์ œ๊ณต\nโ€ข ์ตœ๊ณ ์˜ ์—…๋ฌด ํ™˜๊ฒฝ์ธ Wework ์—ญ์‚ผ์—ญ์  ์ž…์ฃผ์‚ฌ์ž…๋‹ˆ๋‹ค. ์•ˆ๋ฝํ•œ ํ™˜๊ฒฝ, ๊ตญ๋‚ด/์™ธ ์ง€์  ์ž์œ ๋กœ์šด ์ด์šฉ, ๋งฅ์ฃผ์™€ ์ปคํ”ผ ๋ฌดํ•œ์ œ๊ณต, ์ˆ˜์‹œ ์ด๋ฒคํŠธ ๋“ฑ์˜ ์„œ๋น„์Šค๋ฅผ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค.\n\n๊ธฐํƒ€\nโ€ข ๋ณธ ์ฑ„์šฉ์€ ์‚ฌ์—… ํ™•์žฅ์— ๋”ฐ๋ฅธ ์‹ ๊ทœ ์ฑ„์šฉ์ž…๋‹ˆ๋‹ค. \nโ€ข ์ผ์„ ๋” ์ž˜ํ•˜๊ธฐ ์œ„ํ•œ ๋ฐฉ๋ฒ• ์ค‘ ํ•˜๋‚˜๋กœ ์›” 2ํšŒ ๋ฆฌ๋ชจํŠธ ๊ทผ๋ฌด๋ฅผ ํ•˜์‹ค ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.","name":"ํ…Œ์ŠคํŠธ ํฌ์ง€์…˜"},"url":"https://www.wanted.co.kr/wd/24090","company":{"id":79,"name":"์›ํ‹ฐ๋“œ๋žฉ","description":"์›ํ‹ฐ๋“œ๋žฉ ์ผ๊ป„์š”","link":"https://","registration_number":"2991023012","company_tags":[{"id":9962,"text":"๋งฅ์ฃผ"}],"logo_img":{"origin":"https://...","thumb":"https://..."}},"address":{"id":5873,"country":"ํ•œ๊ตญ","country_code":"kr","location":"์„œ์šธ","district":"seoul.songpa-gu","full_location":"์„œ์šธ์‹œ ์†กํŒŒ๊ตฌ ์˜ฌ๋ฆผํ”ฝ๋กœ 300","geo_location":{"bounds":{"northeast":{"lat":37.5137876,"lng":127.1047335},"southwest":{"lat":37.5130537,"lng":127.1034478}},"location":{"lat":37.5134449,"lng":127.1041611},"location_type":"ROOFTOP","viewport":{"northeast":{"lat":37.5147696302915,"lng":127.1054396302915},"southwest":{"lat":37.5120716697085,"lng":127.1027416697085}}}},"reward":{"total":"100๋งŒ์›","recommender":"50๋งŒ์›","recommendee":"50๋งŒ์›"},"category_tags":{"parent_tag":{"id":530,"text":"์˜์—…"},"child_tags":[{"id":768,"text":"์ฃผ์š”๊ณ ๊ฐ์‚ฌ ๋‹ด๋‹น์ž"}]},"skill_tags":[{"id":1630,"text":"์˜์—…"}],"images":[{"origin":"https://...","thumb":"https://...","is_title":true},{"origin":"https://...","thumb":"https://...","is_title":false}]}},"openapi__apis__v1__jobs__serializers__TagResponseSerializer":{"properties":{"id":{"type":"integer","title":"ํƒœ๊ทธID"},"text":{"type":"string","title":"ํƒœ๊ทธ๋ช…"}},"type":"object","title":"TagResponseSerializer"},"openapi__apis__v1__tags__serializers__TagResponseSerializer":{"properties":{"id":{"type":"integer","title":"Id","description":"ํƒœ๊ทธID"},"parent_id":{"type":"integer","title":"Parent Id","description":"์ƒ์œ„ ํƒœ๊ทธID"},"title":{"type":"string","title":"Title","description":"ํƒœ๊ทธ๋ช…"},"title_thumb_img":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Title Thumb Img","description":"ํƒœ๊ทธ ์ด๋ฏธ์ง€ URL"}},"type":"object","required":["id","title"],"title":"TagResponseSerializer"}},"securitySchemes":{"ClientIdHeader":{"type":"apiKey","in":"header","name":"wanted-client-id"},"ClientSecretHeader":{"type":"apiKey","in":"header","name":"wanted-client-secret"},"PermissionsDependency":{"type":"apiKey","in":"header","name":"Authorization"}}}} \ No newline at end of file diff --git a/assets/input/webhook.swagger.json b/assets/input/webhook.swagger.json new file mode 100644 index 0000000..712a42f --- /dev/null +++ b/assets/input/webhook.swagger.json @@ -0,0 +1,50 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "Webhook Example", + "version": "1.0.0" + }, + "webhooks": { + "newPet": { + "post": { + "requestBody": { + "description": "Information about a new pet in the system", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + } + } + } + }, + "components": { + "schemas": { + "Pet": { + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "tag": { + "type": "string" + } + } + } + } + } +} \ No newline at end of file diff --git a/assets/output/bbs.swagger.ar.json b/assets/output/bbs.swagger.ar.json new file mode 100644 index 0000000..f24fb23 --- /dev/null +++ b/assets/output/bbs.swagger.ar.json @@ -0,0 +1,1663 @@ +{ + "openapi": "3.1.0", + "servers": [ + { + "url": "http://localhost:37001", + "description": "ุงู„ุฎุงุฏู… ุงู„ู…ุญู„ูŠ" + } + ], + "info": { + "version": "2.1.0", + "title": "@samchon/bbs-backend", + "description": "ุงู„ูˆุงุฌู‡ุฉ ุงู„ุฎู„ููŠุฉ ู„ู„ู€ BBS", + "license": { + "name": "MIT" + } + }, + "paths": { + "/bbs/articles": { + "patch": { + "tags": [ + "BBS" + ], + "parameters": [], + "requestBody": { + "description": "ุทู„ุจ ู…ุนู„ูˆู…ุงุช ุญูˆู„ ุงู„ุชุฑู‚ูŠู… ูˆุฎูŠุงุฑุงุช ุงู„ุจุญุซ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticle.IRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "ู…ู‚ุงู„ุงุช ู…ุฎุชุตุฑุฉ ู…ู‚ุณู…ุฉ ุฅู„ู‰ ุตูุญุงุช.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IPageIBbsArticle.ISummary" + } + } + } + } + }, + "summary": "ู‚ู… ุจุฅุฏุฑุงุฌ ุฌู…ูŠุน ุงู„ู…ู‚ุงู„ุงุช ุงู„ู…ุฎุชุตุฑุฉ", + "description": "ู‚ู… ุจุฅุฏุฑุงุฌ ุฌู…ูŠุน ุงู„ู…ู‚ุงู„ุงุช ุงู„ู…ุฎุชุตุฑุฉ. ู‚ู… ุจุฅุฏุฑุงุฌ ุฌู…ูŠุน ุงู„ู…ู‚ุงู„ุงุช ุงู„ู…ุฎุชุตุฑุฉ ู…ุน ุฎูŠุงุฑุงุช ุงู„ุชุฑู‚ูŠู… ูˆุงู„ุจุญุซ." + }, + "post": { + "tags": [ + "BBS" + ], + "parameters": [], + "requestBody": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ู…ู‚ุงู„ ุงู„ู…ุฑุงุฏ ุฅู†ุดุงุฆู‡.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticle.ICreate" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "ู…ู‚ุงู„ุฉ ุชู… ุฅู†ุดุงุคู‡ุง ุญุฏูŠุซู‹ุง.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticle" + } + } + } + } + }, + "summary": "ุฅู†ุดุงุก ู…ู‚ุงู„ ุฌุฏูŠุฏ", + "description": "ุฅู†ุดุงุก ู…ู‚ุงู„ ุฌุฏูŠุฏ. ุฅู†ุดุงุก ู…ู‚ุงู„ ุฌุฏูŠุฏ ู…ุน ุฃูˆู„ {@link IBbsArticle.ISnapshot snapshot}." + } + }, + "/bbs/articles/abridges": { + "patch": { + "tags": [ + "BBS" + ], + "parameters": [], + "requestBody": { + "description": "ุทู„ุจ ู…ุนู„ูˆู…ุงุช ุญูˆู„ ุงู„ุชุฑู‚ูŠู… ูˆุฎูŠุงุฑุงุช ุงู„ุจุญุซ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticle.IRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "ู…ู‚ุงู„ุงุช ู…ุฎุชุตุฑุฉ ู…ู‚ุณู…ุฉ ุฅู„ู‰ ุตูุญุงุช.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IPageIBbsArticle.IAbridge" + } + } + } + } + }, + "summary": "ู‚ู… ุจุฅุฏุฑุงุฌ ุฌู…ูŠุน ุงู„ู…ู‚ุงู„ุงุช ุงู„ู…ุฎุชุตุฑุฉ", + "description": "ู‚ู… ุจุฅุฏุฑุงุฌ ุฌู…ูŠุน ุงู„ู…ู‚ุงู„ุงุช ุงู„ู…ุฎุชุตุฑุฉ. ู‚ู… ุจุฅุฏุฑุงุฌ ุฌู…ูŠุน ุงู„ู…ู‚ุงู„ุงุช ุงู„ู…ุฎุชุตุฑุฉ ู…ุน ุฎูŠุงุฑุงุช ุงู„ุชุฑู‚ูŠู… ูˆุงู„ุจุญุซ." + } + }, + "/bbs/articles/{id}": { + "get": { + "tags": [ + "BBS" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "ุงู„ู…ู‚ุงู„ ุงู„ู…ุณุชู‡ุฏู", + "required": true + } + ], + "responses": { + "200": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ู…ู‚ุงู„", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticle" + } + } + } + } + }, + "summary": "ุงู‚ุฑุฃ ุงู„ู…ู‚ุงู„ ุงู„ูุฑุฏูŠ", + "description": "ู‚ุฑุงุกุฉ ู…ู‚ุงู„ ูุฑุฏูŠ. ู‚ุฑุงุกุฉ ู…ู‚ุงู„ ู…ุน ูƒู„ {@link IBbsArticle.ISnapshot snapshots}." + }, + "put": { + "tags": [ + "BBS" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "ุงู„ู…ู‚ุงู„ ุงู„ู…ุณุชู‡ุฏู", + "required": true + } + ], + "requestBody": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ู…ู‚ุงู„ ุงู„ู…ุทู„ูˆุจ ุชุญุฏูŠุซู‡ุง.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticle.IUpdate" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ู„ู‚ุทุฉ ุงู„ู…ุชุฑุงูƒู…ุฉ ุญุฏูŠุซู‹ุง.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticle.ISnapshot" + } + } + } + } + }, + "summary": "ุชุญุฏูŠุซ ุงู„ู…ู‚ุงู„", + "description": "ุชุญุฏูŠุซ ู…ู‚ุงู„ุฉ. ุชุฌู…ูŠุน ุณุฌู„ ุฌุฏูŠุฏ {@link IBbsArticle.ISnapshot snapshot} ู„ู„ู…ู‚ุงู„ุฉ." + }, + "delete": { + "tags": [ + "BBS" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "ุงู„ู…ู‚ุงู„ ุงู„ู…ุณุชู‡ุฏู", + "required": true + } + ], + "requestBody": { + "description": "ูƒู„ู…ุฉ ุงู„ู…ุฑูˆุฑ ู„ู„ู…ู‚ุงู„ุฉ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticle.IErase" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "" + } + }, + "summary": "ู…ุณุญ ู…ู‚ุงู„ุฉ", + "description": "ู…ุณุญ ู…ู‚ุงู„ุฉ. ุชู†ููŠุฐ ุนู…ู„ูŠุฉ ุญุฐู ุจุณูŠุทุฉ ู„ู„ู…ู‚ุงู„ุฉ." + } + }, + "/bbs/articles/{articleId}/comments": { + "patch": { + "tags": [ + "BBS" + ], + "parameters": [ + { + "name": "articleId", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "", + "required": true + } + ], + "requestBody": { + "description": "ุทู„ุจ ู…ุนู„ูˆู…ุงุช ุญูˆู„ ุงู„ุชุฑู‚ูŠู… ูˆุฎูŠุงุฑุงุช ุงู„ุจุญุซ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticleComment.IRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "ุชุนู„ูŠู‚ุงุช ู…ุฎุชุตุฑุฉ ู…ู‚ุณู…ุฉ ุฅู„ู‰ ุตูุญุงุช.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IPageIBbsArticleComment" + } + } + } + } + }, + "summary": "ู‚ู… ุจุฅุฏุฑุงุฌ ุฌู…ูŠุน ุงู„ุชุนู„ูŠู‚ุงุช ุงู„ู…ุฎุชุตุฑุฉ", + "description": "ู‚ู… ุจุฅุฏุฑุงุฌ ุฌู…ูŠุน ุงู„ุชุนู„ูŠู‚ุงุช ุงู„ู…ุฎุชุตุฑุฉ. ู‚ู… ุจุฅุฏุฑุงุฌ ุฌู…ูŠุน ุงู„ุชุนู„ูŠู‚ุงุช ุงู„ู…ุฎุชุตุฑุฉ ู…ุน ุฎูŠุงุฑุงุช ุงู„ุชุฑู‚ูŠู… ูˆุงู„ุจุญุซ." + }, + "post": { + "tags": [ + "BBS" + ], + "parameters": [ + { + "name": "articleId", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "ุงู„ู…ู‚ุงู„ุงุช ุงู„ุชุงุจุนุฉ", + "required": true + } + ], + "requestBody": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุชุนู„ูŠู‚ ู„ุฅู†ุดุงุก.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticleComment.ICreate" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "ุชุนู„ูŠู‚ ุชู… ุฅู†ุดุงุคู‡ ุญุฏูŠุซู‹ุง.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticleComment" + } + } + } + } + }, + "summary": "ุฅู†ุดุงุก ุชุนู„ูŠู‚ ุฌุฏูŠุฏ", + "description": "ุฅู†ุดุงุก ุชุนู„ูŠู‚ ุฌุฏูŠุฏ. ุฅู†ุดุงุก ุชุนู„ูŠู‚ ุฌุฏูŠุฏ ู…ุน ุฃูˆู„ {@link IBbsArticleComment.ISnapshot snapshot}." + } + }, + "/bbs/articles/{articleId}/comments/{id}": { + "get": { + "tags": [ + "BBS" + ], + "parameters": [ + { + "name": "articleId", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "ุงู„ู…ู‚ุงู„ุงุช ุงู„ุชุงุจุนุฉ", + "required": true + }, + { + "name": "id", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "ุชุนู„ูŠู‚ ุงู„ู‡ุฏู", + "required": true + } + ], + "responses": { + "200": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุชุนู„ูŠู‚", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticleComment" + } + } + } + } + }, + "summary": "ุงู‚ุฑุฃ ุงู„ุชุนู„ูŠู‚ ุงู„ูุฑุฏูŠ", + "description": "ู‚ุฑุงุกุฉ ุงู„ุชุนู„ูŠู‚ุงุช ุงู„ูุฑุฏูŠุฉ. ู‚ุฑุงุกุฉ ุงู„ุชุนู„ูŠู‚ ู…ุน ูƒู„ {@link IBbsArticleComment.ISnapshot snapshots}." + }, + "put": { + "tags": [ + "BBS" + ], + "parameters": [ + { + "name": "articleId", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "ุงู„ู…ู‚ุงู„ุงุช ุงู„ุชุงุจุนุฉ", + "required": true + }, + { + "name": "id", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "ุชุนู„ูŠู‚ ุงู„ู‡ุฏู", + "required": true + } + ], + "requestBody": { + "description": "ุชุนู„ูŠู‚ ุนู„ู‰ ุงู„ู…ุนู„ูˆู…ุงุช ุงู„ุชูŠ ูŠุฌุจ ุชุญุฏูŠุซู‡ุง.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticleComment.IUpdate" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ู„ู‚ุทุฉ ุงู„ู…ุชุฑุงูƒู…ุฉ ุญุฏูŠุซู‹ุง.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticleComment.ISnapshot" + } + } + } + } + }, + "summary": "ุชุญุฏูŠุซ ุชุนู„ูŠู‚", + "description": "ุชุญุฏูŠุซ ุชุนู„ูŠู‚. ู‚ู… ุจุชุฌู…ูŠุน ุณุฌู„ ุฌุฏูŠุฏ {@link IBbsArticleComment.ISnapshot snapshot} ู„ู„ุชุนู„ูŠู‚." + }, + "delete": { + "tags": [ + "BBS" + ], + "parameters": [ + { + "name": "articleId", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "ุงู„ู…ู‚ุงู„ุงุช ุงู„ุชุงุจุนุฉ", + "required": true + }, + { + "name": "id", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "ุชุนู„ูŠู‚ ุงู„ู‡ุฏู", + "required": true + } + ], + "requestBody": { + "description": "ูƒู„ู…ุฉ ุงู„ู…ุฑูˆุฑ ู„ู„ุชุนู„ูŠู‚.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticleComment.IErase" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "" + } + }, + "summary": "ู…ุณุญ ุงู„ุชุนู„ูŠู‚", + "description": "ู…ุณุญ ุชุนู„ูŠู‚. ูŠู‚ูˆู… ุจุญุฐู ุงู„ุชุนู„ูŠู‚ ุจุดูƒู„ ู†ุงุนู…." + } + }, + "/monitors/health": { + "get": { + "tags": [ + "Monitor" + ], + "parameters": [], + "responses": { + "200": { + "description": "" + } + }, + "summary": "ูุญุต ุงู„ุตุญุฉ API", + "description": "ูุญุต ุงู„ุตุญุฉ API." + } + }, + "/monitors/performance": { + "get": { + "tags": [ + "Monitor" + ], + "parameters": [], + "responses": { + "200": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุฃุฏุงุก", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IPerformance" + } + } + } + } + }, + "summary": "ุงุญุตู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช ุงู„ุฃุฏุงุก", + "description": "ุงุญุตู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช ุงู„ุฃุฏุงุก. ุงุญุตู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช ุงู„ุฃุฏุงุก ุงู„ู…ุคู„ูุฉ ู…ู† ูˆุญุฏุฉ ุงู„ู…ุนุงู„ุฌุฉ ุงู„ู…ุฑูƒุฒูŠุฉ ูˆุงู„ุฐุงูƒุฑุฉ ูˆุงุณุชุฎุฏุงู… ุงู„ู…ูˆุงุฑุฏ." + } + }, + "/monitors/system": { + "get": { + "tags": [ + "Monitor" + ], + "parameters": [], + "responses": { + "200": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ู†ุธุงู…", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ISystem" + } + } + } + } + }, + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช ุงู„ู†ุธุงู…", + "description": "ุงุญุตู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช ุงู„ู†ุธุงู…. ุงุญุตู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช ุงู„ู†ุธุงู… ุจุงุณุชุฎุฏุงู… ู…ุนู„ูˆู…ุงุช ุงู„ุงู„ุชุฒุงู… ูˆุงู„ุญุฒู…ุฉ." + } + } + }, + "components": { + "schemas": { + "IBbsArticle.IRequest": { + "type": "object", + "properties": { + "search": { + "$ref": "#/components/schemas/IBbsArticle.IRequest.ISearch", + "title": "ุดุฑุท ุงู„ุจุญุซ", + "description": "ุดุฑุท ุงู„ุจุญุซ." + }, + "sort": { + "type": "array", + "items": { + "oneOf": [ + { + "const": "-writer" + }, + { + "const": "-title" + }, + { + "const": "-created_at" + }, + { + "const": "-updated_at" + }, + { + "const": "+writer" + }, + { + "const": "+title" + }, + { + "const": "+created_at" + }, + { + "const": "+updated_at" + } + ] + }, + "title": "ุญุงู„ุฉ ุงู„ูุฑุฒ", + "description": "ุญุงู„ุฉ ุงู„ูุฑุฒ." + }, + "page": { + "type": "integer", + "title": "ุฑู‚ู… ุงู„ุตูุญุฉ", + "description": "ุฑู‚ู… ุงู„ุตูุญุฉ." + }, + "limit": { + "type": "integer", + "default": 100, + "title": "ุชุญุฏูŠุฏ ุนุฏุฏ ุงู„ุณุฌู„ุงุช ู„ูƒู„ ุตูุญุฉ", + "description": "ุชุญุฏูŠุฏ ุนุฏุฏ ุงู„ุณุฌู„ุงุช ู„ูƒู„ ุตูุญุฉ." + } + } + }, + "IBbsArticle.IRequest.ISearch": { + "type": "object", + "properties": { + "writer": { + "type": "string" + }, + "title": { + "type": "string" + }, + "body": { + "type": "string" + }, + "title_or_body": { + "type": "string" + }, + "from": { + "type": "string", + "format": "date-time" + }, + "to": { + "type": "string", + "format": "date-time" + } + }, + "description": "๊ฒ€์ƒ‰ ์ •๋ณด." + }, + "IPageIBbsArticle.ISummary": { + "type": "object", + "properties": { + "pagination": { + "$ref": "#/components/schemas/IPage.IPagination", + "title": "ู…ุนู„ูˆู…ุงุช ุงู„ุตูุญุฉ", + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุตูุญุฉ." + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IBbsArticle.ISummary" + }, + "title": "ู‚ุงุฆู…ุฉ ุงู„ุณุฌู„ุงุช", + "description": "ู‚ุงุฆู…ุฉ ุงู„ุณุฌู„ุงุช." + } + }, + "required": [ + "pagination", + "data" + ], + "description": "ุตูุญุฉ. ู…ุฌู…ูˆุนุฉ ู…ู† ุงู„ุณุฌู„ุงุช ู…ุน ู…ุนู„ูˆู…ุงุช ุงู„ุชุฑู‚ูŠู…." + }, + "IPage.IPagination": { + "type": "object", + "properties": { + "current": { + "type": "integer", + "title": "ุฑู‚ู… ุงู„ุตูุญุฉ ุงู„ุญุงู„ูŠุฉ", + "description": "ุฑู‚ู… ุงู„ุตูุญุฉ ุงู„ุญุงู„ูŠุฉ." + }, + "limit": { + "type": "integer", + "default": 100, + "title": "ุชุญุฏูŠุฏ ุนุฏุฏ ุงู„ุณุฌู„ุงุช ู„ูƒู„ ุตูุญุฉ", + "description": "ุชุญุฏูŠุฏ ุนุฏุฏ ุงู„ุณุฌู„ุงุช ู„ูƒู„ ุตูุญุฉ." + }, + "records": { + "type": "integer", + "title": "ู…ุฌู…ูˆุน ุงู„ุณุฌู„ุงุช ููŠ ู‚ุงุนุฏุฉ ุงู„ุจูŠุงู†ุงุช", + "description": "ู…ุฌู…ูˆุน ุงู„ุณุฌู„ุงุช ููŠ ู‚ุงุนุฏุฉ ุงู„ุจูŠุงู†ุงุช." + }, + "pages": { + "type": "integer", + "title": "ู…ุฌู…ูˆุน ุงู„ุตูุญุงุช", + "description": "ุฅุฌู…ุงู„ูŠ ุงู„ุตูุญุงุช ูŠุณุงูˆูŠ {@link records } / {@link limit } ู…ุน ุณู‚ู." + } + }, + "required": [ + "current", + "limit", + "records", + "pages" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุตูุญุฉ." + }, + "IBbsArticle.ISummary": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "title": "ุงู„ู…ูุชุงุญ ุงู„ุฃุณุงุณูŠ", + "description": "ุงู„ู…ูุชุงุญ ุงู„ุฃุณุงุณูŠ." + }, + "writer": { + "type": "string", + "title": "ูƒุงุชุจ ุงู„ู…ู‚ุงู„", + "description": "ูƒุงุชุจ ุงู„ู…ู‚ุงู„." + }, + "title": { + "type": "string", + "title": "ุนู†ูˆุงู† ุงู„ุตูˆุฑุฉ ุงู„ุงุฎูŠุฑุฉ", + "description": "ุนู†ูˆุงู† ุงู„ุตูˆุฑุฉ ุงู„ุงุฎูŠุฑุฉ." + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "ูˆู‚ุช ุฅู†ุดุงุก ุงู„ู…ู‚ุงู„", + "description": "ูˆู‚ุช ุฅู†ุดุงุก ุงู„ู…ู‚ุงู„." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "title": "ูˆู‚ุช ุชุนุฏูŠู„ ุงู„ู…ู‚ุงู„", + "description": "ูˆู‚ุช ุชุนุฏูŠู„ ุงู„ู…ู‚ุงู„ุฉ. ุจู…ุนู†ู‰ ุขุฎุฑุŒ ุงู„ูˆู‚ุช ุงู„ุฐูŠ ุชู… ููŠู‡ ุฅู†ุดุงุก ุขุฎุฑ ู„ู‚ุทุฉ." + } + }, + "required": [ + "id", + "writer", + "title", + "created_at", + "updated_at" + ], + "description": "ู…ู„ุฎุต ุงู„ู…ุนู„ูˆู…ุงุช ุงู„ู…ูˆุฌูˆุฏุฉ ููŠ ุงู„ู…ู‚ุงู„." + }, + "IPageIBbsArticle.IAbridge": { + "type": "object", + "properties": { + "pagination": { + "$ref": "#/components/schemas/IPage.IPagination", + "title": "ู…ุนู„ูˆู…ุงุช ุงู„ุตูุญุฉ", + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุตูุญุฉ." + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IBbsArticle.IAbridge" + }, + "title": "ู‚ุงุฆู…ุฉ ุงู„ุณุฌู„ุงุช", + "description": "ู‚ุงุฆู…ุฉ ุงู„ุณุฌู„ุงุช." + } + }, + "required": [ + "pagination", + "data" + ], + "description": "ุตูุญุฉ. ู…ุฌู…ูˆุนุฉ ู…ู† ุงู„ุณุฌู„ุงุช ู…ุน ู…ุนู„ูˆู…ุงุช ุงู„ุชุฑู‚ูŠู…." + }, + "IBbsArticle.IAbridge": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "title": "ุงู„ู…ูุชุงุญ ุงู„ุฃุณุงุณูŠ", + "description": "ุงู„ู…ูุชุงุญ ุงู„ุฃุณุงุณูŠ." + }, + "writer": { + "type": "string", + "title": "ูƒุงุชุจ ุงู„ู…ู‚ุงู„", + "description": "ูƒุงุชุจ ุงู„ู…ู‚ุงู„." + }, + "title": { + "type": "string", + "title": "ุนู†ูˆุงู† ุงู„ุตูˆุฑุฉ ุงู„ุงุฎูŠุฑุฉ", + "description": "ุนู†ูˆุงู† ุงู„ุตูˆุฑุฉ ุงู„ุงุฎูŠุฑุฉ." + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "ูˆู‚ุช ุฅู†ุดุงุก ุงู„ู…ู‚ุงู„", + "description": "ูˆู‚ุช ุฅู†ุดุงุก ุงู„ู…ู‚ุงู„." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "title": "ูˆู‚ุช ุชุนุฏูŠู„ ุงู„ู…ู‚ุงู„", + "description": "ูˆู‚ุช ุชุนุฏูŠู„ ุงู„ู…ู‚ุงู„ุฉ. ุจู…ุนู†ู‰ ุขุฎุฑุŒ ุงู„ูˆู‚ุช ุงู„ุฐูŠ ุชู… ููŠู‡ ุฅู†ุดุงุก ุขุฎุฑ ู„ู‚ุทุฉ." + }, + "format": { + "$ref": "#/components/schemas/IBbsArticle.Format", + "title": "ุดูƒู„ ุงู„ุฌุณู…", + "description": "ุชู†ุณูŠู‚ ุงู„ู†ุตุŒ ู†ูุณ ุงู„ู…ุนู†ู‰ ู…ุน ุงู…ุชุฏุงุฏุงุช ู…ุซู„ `html`ุŒ `md`ุŒ `txt`." + }, + "body": { + "type": "string", + "title": "ู…ุญุชูˆู‰ ู†ุต ุงู„ู…ู‚ุงู„", + "description": "ู…ุญุชูˆู‰ ู†ุต ุงู„ู…ู‚ุงู„." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAttachmentFile.ICreate" + }, + "title": "ู‚ุงุฆู…ุฉ ุงู„ู…ู„ูุงุช ุงู„ู…ุฑูู‚ุฉ", + "description": "ู‚ุงุฆู…ุฉ ุงู„ู…ู„ูุงุช ุงู„ู…ุฑูู‚ุฉ." + } + }, + "required": [ + "id", + "writer", + "title", + "created_at", + "updated_at", + "format", + "body", + "files" + ], + "description": "ู…ุนู„ูˆู…ุงุช ู…ุฎุชุตุฑุฉ ุนู† ุงู„ู…ู‚ุงู„." + }, + "IBbsArticle.Format": { + "oneOf": [ + { + "const": "txt" + }, + { + "const": "md" + }, + { + "const": "html" + } + ] + }, + "IAttachmentFile.ICreate": { + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 255, + "title": "ุงุณู… ุงู„ู…ู„ูุŒ ุจุงุณุชุซู†ุงุก ุงู„ุงู…ุชุฏุงุฏ", + "description": "ุงุณู… ุงู„ู…ู„ูุŒ ุจุงุณุชุซู†ุงุก ุงู„ุงู…ุชุฏุงุฏ." + }, + "extension": { + "oneOf": [ + { + "type": "string", + "maxLength": 8, + "minLength": 1 + }, + { + "type": "null" + } + ], + "title": "ุงู…ุชุฏุงุฏ", + "description": "ุงู„ุงู…ุชุฏุงุฏ. ู…ู† ุงู„ู…ู…ูƒู† ุญุฐู ู…ุซู„ ุญุงู„ุฉ `README`." + }, + "url": { + "type": "string", + "format": "uri", + "contentMediaType": "application/octet-stream", + "title": "ู…ุณุงุฑ URL ู„ู„ู…ู„ู ุงู„ุญู‚ูŠู‚ูŠ", + "description": "ู…ุณุงุฑ URL ู„ู„ู…ู„ู ุงู„ุญู‚ูŠู‚ูŠ." + } + }, + "required": [ + "name", + "extension", + "url" + ] + }, + "IBbsArticle": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "title": "ุงู„ู…ูุชุงุญ ุงู„ุฃุณุงุณูŠ", + "description": "ุงู„ู…ูุชุงุญ ุงู„ุฃุณุงุณูŠ.", + "x-special-description": "Sommetimes made by database automatically." + }, + "writer": { + "type": "string", + "title": "ูƒุงุชุจ ุงู„ู…ู‚ุงู„", + "description": "ูƒุงุชุจ ุงู„ู…ู‚ุงู„." + }, + "snapshots": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IBbsArticle.ISnapshot" + }, + "minItems": 1, + "title": "ู‚ุงุฆู…ุฉ ู…ุญุชูˆูŠุงุช ุงู„ุตูˆุฑุฉ", + "description": "ู‚ุงุฆู…ุฉ ู…ุญุชูˆูŠุงุช ุงู„ุตูˆุฑุฉ ุงู„ููˆุฑูŠุฉ. ูŠุชู… ุฅู†ุดุงุคู‡ุง ู„ุฃูˆู„ ู…ุฑุฉ ุนู†ุฏ ุฅู†ุดุงุก ู…ู‚ุงู„ุŒ ูˆูŠุชู… ุชุฌู…ูŠุนู‡ุง ููŠ ูƒู„ ู…ุฑุฉ ูŠุชู… ููŠู‡ุง ุชุนุฏูŠู„ ุงู„ู…ู‚ุงู„." + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "ูˆู‚ุช ุฅู†ุดุงุก ุงู„ู…ู‚ุงู„", + "description": "ูˆู‚ุช ุฅู†ุดุงุก ุงู„ู…ู‚ุงู„." + } + }, + "required": [ + "id", + "writer", + "snapshots", + "created_at" + ], + "description": "ูƒูŠุงู† ุงู„ู…ู‚ุงู„ุฉ. `IBbsArticle* ู‡ูˆ ูƒูŠุงู† ู…ู† ู†ูˆุน ูุฑุนูŠ ู„ุฌู…ูŠุน ุฃู†ูˆุงุน ุงู„ู…ู‚ุงู„ุงุช ููŠ ู†ุธุงู… ุงู„ูˆุงุฌู‡ุฉ ุงู„ุฎู„ููŠุฉ ุงู„ุญุงู„ูŠุŒ ูˆูŠุดูƒู„ ุญุฑููŠู‹ุง ุงู„ู…ู‚ุงู„ุงุช ุงู„ูุฑุฏูŠุฉ ู„ู„ูˆุญุฉ ุงู„ุฅุนู„ุงู†ุงุช. ูˆูƒู…ุง ุชุฑู‰ุŒ ูุฅู† ุงู„ุนู†ุงุตุฑ ุงู„ุชูŠ ูŠุฌุจ ุฃู† ุชูˆุฌุฏ ุญุชู…ู‹ุง ููŠ ุงู„ู…ู‚ุงู„ุฉุŒ ู…ุซู„ `ุงู„ุนู†ูˆุงู†` ุฃูˆ `ุงู„ุฌุณู…`ุŒ ู„ุง ุชูˆุฌุฏ ููŠ `IBbsArticle`ุŒ ูˆู„ูƒู†ู‡ุง ู…ูˆุฌูˆุฏุฉ ููŠ ุงู„ูƒูŠุงู† ุงู„ูุฑุนูŠุŒ {@link IBbsArticle.ISnapshot }ุŒ ูƒุนู„ุงู‚ุฉ 1: NุŒ ูˆุฐู„ูƒ ู„ุฃู† ุณุฌู„ ู„ู‚ุทุฉ ุฌุฏูŠุฏ ูŠุชู… ู†ุดุฑู‡ ููŠ ูƒู„ ู…ุฑุฉ ูŠุชู… ููŠู‡ุง ุชุนุฏูŠู„ ุงู„ู…ู‚ุงู„ุฉ. ูˆุงู„ุณุจุจ ูˆุฑุงุก ู†ุดุฑ ุณุฌู„ ู„ู‚ุทุฉ ุฌุฏูŠุฏ ููŠ ูƒู„ ู…ุฑุฉ ูŠุชู… ููŠู‡ุง ุชุนุฏูŠู„ ุงู„ู…ู‚ุงู„ุฉ ู‡ูˆ ุงู„ุญูุงุธ ุนู„ู‰ ุงู„ุฃุฏู„ุฉ. ู†ุธุฑู‹ุง ู„ุทุจูŠุนุฉ ุงู„ู…ุฌุชู…ุน ุงู„ุฅู„ูƒุชุฑูˆู†ูŠุŒ ู‡ู†ุงูƒ ุฏุงุฆู…ู‹ุง ุชู‡ุฏูŠุฏ ุจุงู„ู†ุฒุงุน ุจูŠู† ุงู„ู…ุดุงุฑูƒูŠู†. ูˆู‚ุฏ ูŠุญุฏุซ ุฃู† ุชู†ุดุฃ ุงู„ู†ุฒุงุนุงุช ู…ู† ุฎู„ุงู„ ุงู„ู…ู‚ุงู„ุงุช ุฃูˆ {@link IBbsArticleComment comments}ุŒ ูˆู„ู…ู†ุน ุฃุดูŠุงุก ู…ุซู„ ุชุนุฏูŠู„ ุงู„ู…ู‚ุงู„ุงุช ุงู„ู…ูˆุฌูˆุฏุฉ ู„ู„ุชู„ุงุนุจ ุจุงู„ู…ูˆู‚ูุŒ ุชู… ุชุตู…ูŠู… ุงู„ู…ู‚ุงู„ุฉ ุจู‡ุฐุง ุงู„ู‡ูŠูƒู„. ุจุนุจุงุฑุฉ ุฃุฎุฑู‰ุŒ ู„ู„ุญูุงุธ ุนู„ู‰ ุงู„ุฃุฏู„ุฉ ูˆู…ู†ุน ุงู„ุงุญุชูŠุงู„." + }, + "IBbsArticle.ISnapshot": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "title": "ุงู„ู…ูุชุงุญ ุงู„ุฃุณุงุณูŠ", + "description": "ุงู„ู…ูุชุงุญ ุงู„ุฃุณุงุณูŠ." + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "ูˆู‚ุช ุฅู†ุดุงุก ุณุฌู„ ุงู„ู„ู‚ุทุฉ", + "description": "ูˆู‚ุช ุฅู†ุดุงุก ุณุฌู„ ู„ู‚ุทุฉ. ุจู…ุนู†ู‰ ุขุฎุฑุŒ ูˆู‚ุช ุงู„ุฅู†ุดุงุก ุฃูˆ ูˆู‚ุช ุงู„ุชุญุฏูŠุซ ุฃูˆ ุงู„ู…ู‚ุงู„ุฉ." + }, + "format": { + "$ref": "#/components/schemas/IBbsArticle.Format", + "title": "ุดูƒู„ ุงู„ุฌุณู…", + "description": "ุชู†ุณูŠู‚ ุงู„ู†ุตุŒ ู†ูุณ ุงู„ู…ุนู†ู‰ ู…ุน ุงู…ุชุฏุงุฏุงุช ู…ุซู„ `html`ุŒ `md`ุŒ `txt`." + }, + "body": { + "type": "string", + "title": "ู…ุญุชูˆู‰ ู†ุต ุงู„ู…ู‚ุงู„", + "description": "ู…ุญุชูˆู‰ ู†ุต ุงู„ู…ู‚ุงู„." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAttachmentFile.ICreate" + }, + "title": "ู‚ุงุฆู…ุฉ ุงู„ู…ู„ูุงุช ุงู„ู…ุฑูู‚ุฉ", + "description": "ู‚ุงุฆู…ุฉ ุงู„ู…ู„ูุงุช ุงู„ู…ุฑูู‚ุฉ." + }, + "title": { + "type": "string", + "title": "ุนู†ูˆุงู† ุงู„ู…ู‚ุงู„", + "description": "ุนู†ูˆุงู† ุงู„ู…ู‚ุงู„." + } + }, + "required": [ + "id", + "created_at", + "format", + "body", + "files", + "title" + ], + "description": "ู„ู‚ุทุฉ ู…ู† ุงู„ู…ู‚ุงู„ุฉ. `IBbsArticle.ISnapshot` ู‡ูŠ ูƒูŠุงู† ู„ู‚ุทุฉ ูŠุญุชูˆูŠ ุนู„ู‰ ู…ุญุชูˆูŠุงุช ุงู„ู…ู‚ุงู„ุฉุŒ ูƒู…ุง ู‡ูˆ ู…ุฐูƒูˆุฑ ููŠ {@link IBbsArticle }ุŒ ูŠุชู… ูุตู„ ู…ุญุชูˆูŠุงุช ุงู„ู…ู‚ุงู„ุฉ ุนู† ุณุฌู„ ุงู„ู…ู‚ุงู„ุฉ ู„ู„ุงุญุชูุงุธ ุจุงู„ุฃุฏู„ุฉ ูˆู…ู†ุน ุงู„ุงุญุชูŠุงู„." + }, + "IBbsArticle.ICreate": { + "type": "object", + "properties": { + "writer": { + "type": "string" + }, + "format": { + "oneOf": [ + { + "const": "txt" + }, + { + "const": "md" + }, + { + "const": "html" + } + ], + "title": "ุดูƒู„ ุงู„ุฌุณู…", + "description": "ุชู†ุณูŠู‚ ุงู„ู†ุตุŒ ู†ูุณ ุงู„ู…ุนู†ู‰ ู…ุน ุงู…ุชุฏุงุฏุงุช ู…ุซู„ `html`ุŒ `md`ุŒ `txt`." + }, + "title": { + "type": "string", + "title": "ุนู†ูˆุงู† ุงู„ู…ู‚ุงู„", + "description": "ุนู†ูˆุงู† ุงู„ู…ู‚ุงู„." + }, + "body": { + "type": "string", + "title": "ู…ุญุชูˆู‰ ู†ุต ุงู„ู…ู‚ุงู„", + "description": "ู…ุญุชูˆู‰ ู†ุต ุงู„ู…ู‚ุงู„." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAttachmentFile.ICreate" + }, + "title": "ู‚ุงุฆู…ุฉ ุงู„ู…ู„ูุงุช ุงู„ู…ุฑูู‚ุฉ", + "description": "ู‚ุงุฆู…ุฉ ุงู„ู…ู„ูุงุช ุงู„ู…ุฑูู‚ุฉ." + }, + "password": { + "type": "string", + "title": "ูƒู„ู…ุฉ ุงู„ู…ุฑูˆุฑ ู„ู„ุชุนุฏูŠู„", + "description": "ูƒู„ู…ุฉ ุงู„ู…ุฑูˆุฑ ู„ู„ุชุนุฏูŠู„." + } + }, + "required": [ + "writer", + "format", + "title", + "body", + "files", + "password" + ], + "description": "ุชุฎุฒูŠู† ู†ูˆุน ู…ุญุชูˆู‰ ุงู„ู…ู‚ุงู„ุฉ." + }, + "IBbsArticle.IUpdate": { + "type": "object", + "properties": { + "format": { + "oneOf": [ + { + "const": "txt" + }, + { + "const": "md" + }, + { + "const": "html" + } + ], + "title": "ุดูƒู„ ุงู„ุฌุณู…", + "description": "ุชู†ุณูŠู‚ ุงู„ู†ุตุŒ ู†ูุณ ุงู„ู…ุนู†ู‰ ู…ุน ุงู…ุชุฏุงุฏุงุช ู…ุซู„ `html`ุŒ `md`ุŒ `txt`." + }, + "title": { + "type": "string", + "title": "ุนู†ูˆุงู† ุงู„ู…ู‚ุงู„", + "description": "ุนู†ูˆุงู† ุงู„ู…ู‚ุงู„." + }, + "body": { + "type": "string", + "title": "ู…ุญุชูˆู‰ ู†ุต ุงู„ู…ู‚ุงู„", + "description": "ู…ุญุชูˆู‰ ู†ุต ุงู„ู…ู‚ุงู„." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAttachmentFile.ICreate" + }, + "title": "ู‚ุงุฆู…ุฉ ุงู„ู…ู„ูุงุช ุงู„ู…ุฑูู‚ุฉ", + "description": "ู‚ุงุฆู…ุฉ ุงู„ู…ู„ูุงุช ุงู„ู…ุฑูู‚ุฉ." + }, + "password": { + "type": "string", + "title": "ูƒู„ู…ุฉ ุงู„ู…ุฑูˆุฑ ู„ู„ุชุนุฏูŠู„", + "description": "ูƒู„ู…ุฉ ุงู„ู…ุฑูˆุฑ ู„ู„ุชุนุฏูŠู„." + } + }, + "required": [ + "format", + "title", + "body", + "files", + "password" + ] + }, + "IBbsArticle.IErase": { + "type": "object", + "properties": { + "password": { + "type": "string" + } + }, + "required": [ + "password" + ] + }, + "IBbsArticleComment.IRequest": { + "type": "object", + "properties": { + "search": { + "$ref": "#/components/schemas/IBbsArticleComment.IRequest.ISearch" + }, + "sort": { + "type": "array", + "items": { + "oneOf": [ + { + "const": "-writer" + }, + { + "const": "-created_at" + }, + { + "const": "+writer" + }, + { + "const": "+created_at" + } + ] + } + }, + "page": { + "type": "integer", + "title": "ุฑู‚ู… ุงู„ุตูุญุฉ", + "description": "ุฑู‚ู… ุงู„ุตูุญุฉ." + }, + "limit": { + "type": "integer", + "default": 100, + "title": "ุชุญุฏูŠุฏ ุนุฏุฏ ุงู„ุณุฌู„ุงุช ู„ูƒู„ ุตูุญุฉ", + "description": "ุชุญุฏูŠุฏ ุนุฏุฏ ุงู„ุณุฌู„ุงุช ู„ูƒู„ ุตูุญุฉ." + } + } + }, + "IBbsArticleComment.IRequest.ISearch": { + "type": "object", + "properties": { + "writer": { + "type": "string" + }, + "body": { + "type": "string" + } + } + }, + "IPageIBbsArticleComment": { + "type": "object", + "properties": { + "pagination": { + "$ref": "#/components/schemas/IPage.IPagination", + "title": "ู…ุนู„ูˆู…ุงุช ุงู„ุตูุญุฉ", + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุตูุญุฉ." + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IBbsArticleComment" + }, + "title": "ู‚ุงุฆู…ุฉ ุงู„ุณุฌู„ุงุช", + "description": "ู‚ุงุฆู…ุฉ ุงู„ุณุฌู„ุงุช." + } + }, + "required": [ + "pagination", + "data" + ], + "description": "ุตูุญุฉ. ู…ุฌู…ูˆุนุฉ ู…ู† ุงู„ุณุฌู„ุงุช ู…ุน ู…ุนู„ูˆู…ุงุช ุงู„ุชุฑู‚ูŠู…." + }, + "IBbsArticleComment": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "title": "ุงู„ู…ูุชุงุญ ุงู„ุฃุณุงุณูŠ", + "description": "ุงู„ู…ูุชุงุญ ุงู„ุฃุณุงุณูŠ." + }, + "parent_id": { + "oneOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], + "title": "ู…ุนุฑู ุชุนู„ูŠู‚ ุงู„ูˆุงู„ุฏูŠู†", + "description": "ู…ุนุฑู ุชุนู„ูŠู‚ ุงู„ูˆุงู„ุฏูŠู†." + }, + "writer": { + "type": "string", + "title": "ูƒุงุชุจ ุงู„ุชุนู„ูŠู‚", + "description": "ูƒุงุชุจ ุงู„ุชุนู„ูŠู‚." + }, + "snapshots": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IBbsArticleComment.ISnapshot" + }, + "minItems": 1, + "title": "ู‚ุงุฆู…ุฉ ู…ุญุชูˆูŠุงุช ุงู„ุตูˆุฑุฉ", + "description": "ู‚ุงุฆู…ุฉ ู…ุญุชูˆูŠุงุช ุงู„ู„ู‚ุทุฉ. ูŠุชู… ุฅู†ุดุงุคู‡ุง ู„ุฃูˆู„ ู…ุฑุฉ ุนู†ุฏ ุฅู†ุดุงุก ุชุนู„ูŠู‚ุŒ ูˆูŠุชู… ุชุฌู…ูŠุนู‡ุง ููŠ ูƒู„ ู…ุฑุฉ ูŠุชู… ููŠู‡ุง ุชุนุฏูŠู„ ุงู„ุชุนู„ูŠู‚." + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "ูˆู‚ุช ุฅู†ุดุงุก ุงู„ุชุนู„ูŠู‚", + "description": "ูˆู‚ุช ุฅู†ุดุงุก ุงู„ุชุนู„ูŠู‚." + } + }, + "required": [ + "id", + "parent_id", + "writer", + "snapshots", + "created_at" + ], + "description": "ุงู„ุชุนู„ูŠู‚ ุงู„ู…ูƒุชูˆุจ ุนู„ู‰ ู…ู‚ุงู„. `IBbsArticleComment` ู‡ูˆ ูƒูŠุงู† ูŠุดูƒู„ ุงู„ุชุนู„ูŠู‚ุงุช ุงู„ู…ูƒุชูˆุจุฉ ุนู„ู‰ ู…ู‚ุงู„. ูˆุจุงู„ู†ุณุจุฉ ู„ู‡ุฐุง ุงู„ุชุนู„ูŠู‚ุŒ ูƒู…ุง ููŠ ุงู„ุนู„ุงู‚ุฉ ุงู„ุณุงุจู‚ุฉ ุจูŠู† {@link IBbsArticle } ูˆ{@link IBbsArticle.ISnapshot }ุŒ ูŠุชู… ุชุฎุฒูŠู† ู†ุต ู…ุญุชูˆู‰ ุงู„ุชุนู„ูŠู‚ ููŠ ุงู„ุฌุฏูˆู„ ุงู„ูุฑุนูŠ {@link IBbsArticleComment.ISnapshot } ู„ู„ุฅุซุจุงุชุŒ ูˆูŠุชู… ุฅุตุฏุงุฑ ุณุฌู„ ู„ู‚ุทุฉ ุฌุฏูŠุฏ ููŠ ูƒู„ ู…ุฑุฉ ูŠุชู… ููŠู‡ุง ุชุนุฏูŠู„ ุงู„ุชุนู„ูŠู‚. ูƒู…ุง ูŠุนุจุฑ `IBbsArticleComment` ุนู† ุนู„ุงู‚ุฉ ู‡ูŠูƒู„ ุงู„ุฑุฏ ุงู„ู‡ุฑู…ูŠ ู…ู† ุฎู„ุงู„ ุงู„ุณู…ุฉ {@link IBbsArticleComment.parent_id }." + }, + "IBbsArticleComment.ISnapshot": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "title": "ุงู„ู…ูุชุงุญ ุงู„ุฃุณุงุณูŠ", + "description": "ุงู„ู…ูุชุงุญ ุงู„ุฃุณุงุณูŠ." + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "ูˆู‚ุช ุฅู†ุดุงุก ุณุฌู„ ุงู„ู„ู‚ุทุฉ", + "description": "ูˆู‚ุช ุฅู†ุดุงุก ุณุฌู„ ู„ู‚ุทุฉ. ุจู…ุนู†ู‰ ุขุฎุฑุŒ ูˆู‚ุช ุงู„ุฅู†ุดุงุก ุฃูˆ ูˆู‚ุช ุงู„ุชุญุฏูŠุซ ุฃูˆ ุงู„ุชุนู„ูŠู‚." + }, + "format": { + "$ref": "#/components/schemas/IBbsArticleComment.Format", + "title": "ุดูƒู„ ุงู„ุฌุณู…", + "description": "ุชู†ุณูŠู‚ ุงู„ู†ุตุŒ ู†ูุณ ุงู„ู…ุนู†ู‰ ู…ุน ุงู…ุชุฏุงุฏุงุช ู…ุซู„ `html`ุŒ `md`ุŒ `txt`." + }, + "body": { + "type": "string", + "title": "ู…ุญุชูˆู‰ ู†ุต ุงู„ุชุนู„ูŠู‚", + "description": "ู…ุญุชูˆู‰ ู†ุต ุงู„ุชุนู„ูŠู‚." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAttachmentFile.ICreate" + }, + "title": "ู‚ุงุฆู…ุฉ ุงู„ู…ู„ูุงุช ุงู„ู…ุฑูู‚ุฉ", + "description": "ู‚ุงุฆู…ุฉ ุงู„ู…ู„ูุงุช ุงู„ู…ุฑูู‚ุฉ." + } + }, + "required": [ + "id", + "created_at", + "format", + "body", + "files" + ], + "description": "ู„ู‚ุทุฉ ู…ู† ุงู„ุชุนู„ูŠู‚. `IBbsArticleComment.ISnapshot` ุนุจุงุฑุฉ ุนู† ูƒูŠุงู† ู„ู‚ุทุฉ ูŠุญุชูˆูŠ ุนู„ู‰ ู…ุญุชูˆูŠุงุช ุงู„ุชุนู„ูŠู‚. ูˆูƒู…ุง ุฐูƒุฑ ููŠ {@link IBbsArticleComment }ุŒ ุชู… ุชุตู…ูŠู…ู‡ ู„ู„ุงุญุชูุงุธ ุจุงู„ุฃุฏู„ุฉ ูˆู…ู†ุน ุงู„ุงุญุชูŠุงู„." + }, + "IBbsArticleComment.Format": { + "oneOf": [ + { + "const": "txt" + }, + { + "const": "md" + }, + { + "const": "html" + } + ] + }, + "IBbsArticleComment.ICreate": { + "type": "object", + "properties": { + "writer": { + "type": "string", + "title": "ูƒุงุชุจ ุงู„ุชุนู„ูŠู‚", + "description": "ูƒุงุชุจ ุงู„ุชุนู„ูŠู‚." + }, + "format": { + "oneOf": [ + { + "const": "txt" + }, + { + "const": "md" + }, + { + "const": "html" + } + ], + "title": "ุดูƒู„ ุงู„ุฌุณู…", + "description": "ุชู†ุณูŠู‚ ุงู„ู†ุตุŒ ู†ูุณ ุงู„ู…ุนู†ู‰ ู…ุน ุงู…ุชุฏุงุฏุงุช ู…ุซู„ `html`ุŒ `md`ุŒ `txt`." + }, + "body": { + "type": "string", + "title": "ู…ุญุชูˆู‰ ู†ุต ุงู„ุชุนู„ูŠู‚", + "description": "ู…ุญุชูˆู‰ ู†ุต ุงู„ุชุนู„ูŠู‚." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAttachmentFile.ICreate" + }, + "title": "ู‚ุงุฆู…ุฉ ุงู„ู…ู„ูุงุช ุงู„ู…ุฑูู‚ุฉ", + "description": "ู‚ุงุฆู…ุฉ ุงู„ู…ู„ูุงุช ุงู„ู…ุฑูู‚ุฉ." + }, + "password": { + "type": "string", + "title": "ูƒู„ู…ุฉ ุงู„ู…ุฑูˆุฑ ู„ู„ุชุนุฏูŠู„", + "description": "ูƒู„ู…ุฉ ุงู„ู…ุฑูˆุฑ ู„ู„ุชุนุฏูŠู„." + } + }, + "required": [ + "writer", + "format", + "body", + "files", + "password" + ] + }, + "IBbsArticleComment.IUpdate": { + "type": "object", + "properties": { + "format": { + "oneOf": [ + { + "const": "txt" + }, + { + "const": "md" + }, + { + "const": "html" + } + ], + "title": "ุดูƒู„ ุงู„ุฌุณู…", + "description": "ุชู†ุณูŠู‚ ุงู„ู†ุตุŒ ู†ูุณ ุงู„ู…ุนู†ู‰ ู…ุน ุงู…ุชุฏุงุฏุงุช ู…ุซู„ `html`ุŒ `md`ุŒ `txt`." + }, + "body": { + "type": "string", + "title": "ู…ุญุชูˆู‰ ู†ุต ุงู„ุชุนู„ูŠู‚", + "description": "ู…ุญุชูˆู‰ ู†ุต ุงู„ุชุนู„ูŠู‚." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAttachmentFile.ICreate" + }, + "title": "ู‚ุงุฆู…ุฉ ุงู„ู…ู„ูุงุช ุงู„ู…ุฑูู‚ุฉ", + "description": "ู‚ุงุฆู…ุฉ ุงู„ู…ู„ูุงุช ุงู„ู…ุฑูู‚ุฉ." + }, + "password": { + "type": "string", + "title": "ูƒู„ู…ุฉ ุงู„ู…ุฑูˆุฑ ู„ู„ุชุนุฏูŠู„", + "description": "ูƒู„ู…ุฉ ุงู„ู…ุฑูˆุฑ ู„ู„ุชุนุฏูŠู„." + } + }, + "required": [ + "format", + "body", + "files", + "password" + ] + }, + "IBbsArticleComment.IErase": { + "type": "object", + "properties": { + "password": { + "type": "string" + } + }, + "required": [ + "password" + ] + }, + "IPerformance": { + "type": "object", + "properties": { + "cpu": { + "$ref": "#/components/schemas/process.global.NodeJS.CpuUsage" + }, + "memory": { + "$ref": "#/components/schemas/process.global.NodeJS.MemoryUsage" + }, + "resource": { + "$ref": "#/components/schemas/process.global.NodeJS.ResourceUsage" + } + }, + "required": [ + "cpu", + "memory", + "resource" + ] + }, + "process.global.NodeJS.CpuUsage": { + "type": "object", + "properties": { + "user": { + "type": "number" + }, + "system": { + "type": "number" + } + }, + "required": [ + "user", + "system" + ] + }, + "process.global.NodeJS.MemoryUsage": { + "type": "object", + "properties": { + "rss": { + "type": "number" + }, + "heapTotal": { + "type": "number" + }, + "heapUsed": { + "type": "number" + }, + "external": { + "type": "number" + }, + "arrayBuffers": { + "type": "number" + } + }, + "required": [ + "rss", + "heapTotal", + "heapUsed", + "external", + "arrayBuffers" + ] + }, + "process.global.NodeJS.ResourceUsage": { + "type": "object", + "properties": { + "fsRead": { + "type": "number" + }, + "fsWrite": { + "type": "number" + }, + "involuntaryContextSwitches": { + "type": "number" + }, + "ipcReceived": { + "type": "number" + }, + "ipcSent": { + "type": "number" + }, + "majorPageFault": { + "type": "number" + }, + "maxRSS": { + "type": "number" + }, + "minorPageFault": { + "type": "number" + }, + "sharedMemorySize": { + "type": "number" + }, + "signalsCount": { + "type": "number" + }, + "swappedOut": { + "type": "number" + }, + "systemCPUTime": { + "type": "number" + }, + "unsharedDataSize": { + "type": "number" + }, + "unsharedStackSize": { + "type": "number" + }, + "userCPUTime": { + "type": "number" + }, + "voluntaryContextSwitches": { + "type": "number" + } + }, + "required": [ + "fsRead", + "fsWrite", + "involuntaryContextSwitches", + "ipcReceived", + "ipcSent", + "majorPageFault", + "maxRSS", + "minorPageFault", + "sharedMemorySize", + "signalsCount", + "swappedOut", + "systemCPUTime", + "unsharedDataSize", + "unsharedStackSize", + "userCPUTime", + "voluntaryContextSwitches" + ] + }, + "ISystem": { + "type": "object", + "properties": { + "uid": { + "type": "number", + "title": "ู…ุนุฑู ูุฑูŠุฏ ุนุดูˆุงุฆูŠ", + "description": "ู…ุนุฑู ูุฑูŠุฏ ุนุดูˆุงุฆูŠ." + }, + "arguments": { + "type": "array", + "items": { + "type": "string" + }, + "title": "`ุนู…ู„ูŠุฉ", + "description": "`process.argv`" + }, + "commit": { + "$ref": "#/components/schemas/ISystem.ICommit", + "title": "ู…ุนู„ูˆู…ุงุช ุญูˆู„ ุงู„ุชุฒุงู… Git", + "description": "ู…ุนู„ูˆู…ุงุช ุญูˆู„ ุงู„ุชุฒุงู… Git." + }, + "package": { + "$ref": "#/components/schemas/ISystem.IPackage", + "title": "`ุงู„ุญุฒู…ุฉ", + "description": "`package.json`" + }, + "created_at": { + "type": "string", + "title": "ูˆู‚ุช ุฅู†ุดุงุก ู‡ุฐุง ุงู„ุฎุงุฏู…", + "description": "ูˆู‚ุช ุฅู†ุดุงุก ู‡ุฐุง ุงู„ุฎุงุฏู…." + } + }, + "required": [ + "uid", + "arguments", + "commit", + "package", + "created_at" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ู†ุธุงู…." + }, + "ISystem.ICommit": { + "type": "object", + "properties": { + "shortHash": { + "type": "string" + }, + "branch": { + "type": "string" + }, + "hash": { + "type": "string" + }, + "subject": { + "type": "string" + }, + "sanitizedSubject": { + "type": "string" + }, + "body": { + "type": "string" + }, + "author": { + "$ref": "#/components/schemas/ISystem.ICommit.IUser" + }, + "committer": { + "$ref": "#/components/schemas/ISystem.ICommit.IUser" + }, + "authored_at": { + "type": "string" + }, + "commited_at": { + "type": "string" + }, + "notes": { + "type": "string" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "shortHash", + "branch", + "hash", + "subject", + "sanitizedSubject", + "body", + "author", + "committer", + "authored_at", + "commited_at", + "tags" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุญูˆู„ ุงู„ุชุฒุงู… Git." + }, + "ISystem.ICommit.IUser": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + }, + "required": [ + "name", + "email" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุญุณุงุจ ู…ุณุชุฎุฏู… Git." + }, + "ISystem.IPackage": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string" + }, + "description": { + "type": "string" + }, + "main": { + "type": "string" + }, + "typings": { + "type": "string" + }, + "scripts": { + "$ref": "#/components/schemas/Recordstringstring" + }, + "repository": { + "type": "object", + "properties": { + "type": { + "const": "git" + }, + "url": { + "type": "string" + } + }, + "required": [ + "type", + "url" + ] + }, + "author": { + "type": "string" + }, + "license": { + "type": "string" + }, + "bugs": { + "type": "object", + "properties": { + "url": { + "type": "string" + } + }, + "required": [ + "url" + ] + }, + "homepage": { + "type": "string" + }, + "devDependencies": { + "$ref": "#/components/schemas/Recordstringstring" + }, + "dependencies": { + "$ref": "#/components/schemas/Recordstringstring" + }, + "publishConfig": { + "type": "object", + "properties": { + "registry": { + "type": "string" + } + }, + "required": [ + "registry" + ] + }, + "files": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "name", + "version", + "description", + "scripts", + "repository", + "author", + "license", + "bugs", + "homepage", + "dependencies" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุนู† ุญุฒู…ุฉ NPM." + }, + "Recordstringstring": { + "type": "object", + "properties": {}, + "description": "ุฅู†ุดุงุก ู†ูˆุน ุจู…ุฌู…ูˆุนุฉ ู…ู† ุงู„ุฎุตุงุฆุต K ู…ู† ุงู„ู†ูˆุน T" + } + } + }, + "x-samchon-emended": true +} \ No newline at end of file diff --git a/assets/output/bbs.swagger.ja.json b/assets/output/bbs.swagger.ja.json new file mode 100644 index 0000000..7ae38f6 --- /dev/null +++ b/assets/output/bbs.swagger.ja.json @@ -0,0 +1,1663 @@ +{ + "openapi": "3.1.0", + "servers": [ + { + "url": "http://localhost:37001", + "description": "ใƒญใƒผใ‚ซใƒซใ‚ตใƒผใƒใƒผ" + } + ], + "info": { + "version": "2.1.0", + "title": "@samchon/bbs-ใƒใƒƒใ‚ฏใ‚จใƒณใƒ‰", + "description": "BBS ใฎใƒใƒƒใ‚ฏใ‚จใƒณใƒ‰", + "license": { + "name": "MIT" + } + }, + "paths": { + "/bbs/articles": { + "patch": { + "tags": [ + "BBS" + ], + "parameters": [], + "requestBody": { + "description": "ใƒšใƒผใ‚ธใƒใƒผใ‚ทใƒงใƒณใจๆคœ็ดขใ‚ชใƒ—ใ‚ทใƒงใƒณใซ้–ขใ™ใ‚‹ๆƒ…ๅ ฑใ‚’ใƒชใ‚ฏใ‚จใ‚นใƒˆใ™ใ‚‹.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticle.IRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "ใƒšใƒผใ‚ธๅˆ†ใ‘ใ•ใ‚ŒใŸ่ฆ็ด„่จ˜ไบ‹.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IPageIBbsArticle.ISummary" + } + } + } + } + }, + "summary": "่ฆ็ด„ใ•ใ‚ŒใŸ่จ˜ไบ‹ใ‚’ใ™ในใฆใƒชใ‚นใƒˆใ‚ขใƒƒใƒ—ใ™ใ‚‹", + "description": "่ฆ็ด„ใ•ใ‚ŒใŸ่จ˜ไบ‹ใ‚’ใ™ในใฆไธ€่ฆง่กจ็คบใ—ใพใ™ใ€‚ใƒšใƒผใ‚ธไป˜ใ‘ใจๆคœ็ดขใ‚ชใƒ—ใ‚ทใƒงใƒณใ‚’ไฝฟ็”จใ—ใฆ่ฆ็ด„ใ•ใ‚ŒใŸ่จ˜ไบ‹ใ‚’ใ™ในใฆไธ€่ฆง่กจ็คบใ—ใพใ™ใ€‚." + }, + "post": { + "tags": [ + "BBS" + ], + "parameters": [], + "requestBody": { + "description": "ไฝœๆˆใ™ใ‚‹่จ˜ไบ‹ๆƒ…ๅ ฑ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticle.ICreate" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "ๆ–ฐใ—ใไฝœๆˆใ•ใ‚ŒใŸ่จ˜ไบ‹.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticle" + } + } + } + } + }, + "summary": "ๆ–ฐใ—ใ„่จ˜ไบ‹ใ‚’ไฝœๆˆใ™ใ‚‹", + "description": "ๆ–ฐใ—ใ„่จ˜ไบ‹ใ‚’ไฝœๆˆใ—ใพใ™ใ€‚ๆœ€ๅˆใฎ {@link IBbsArticle.ISnapshot ใ‚นใƒŠใƒƒใƒ—ใ‚ทใƒงใƒƒใƒˆ} ใงๆ–ฐใ—ใ„่จ˜ไบ‹ใ‚’ไฝœๆˆใ—ใพใ™ใ€‚." + } + }, + "/bbs/articles/abridges": { + "patch": { + "tags": [ + "BBS" + ], + "parameters": [], + "requestBody": { + "description": "ใƒšใƒผใ‚ธใƒใƒผใ‚ทใƒงใƒณใจๆคœ็ดขใ‚ชใƒ—ใ‚ทใƒงใƒณใซ้–ขใ™ใ‚‹ๆƒ…ๅ ฑใ‚’ใƒชใ‚ฏใ‚จใ‚นใƒˆใ™ใ‚‹.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticle.IRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "ใƒšใƒผใ‚ธๅˆ†ใ‘ใ•ใ‚ŒใŸ่ฆ็ด„่จ˜ไบ‹.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IPageIBbsArticle.IAbridge" + } + } + } + } + }, + "summary": "ใ™ในใฆใฎ่ฆ็ด„่จ˜ไบ‹ใ‚’ไธ€่ฆง่กจ็คบใ™ใ‚‹", + "description": "ใ™ในใฆใฎ่ฆ็ด„่จ˜ไบ‹ใ‚’ไธ€่ฆง่กจ็คบใ—ใพใ™ใ€‚ใƒšใƒผใ‚ธไป˜ใ‘ใจๆคœ็ดขใ‚ชใƒ—ใ‚ทใƒงใƒณใ‚’ไฝฟ็”จใ—ใฆใ™ในใฆใฎ่ฆ็ด„่จ˜ไบ‹ใ‚’ไธ€่ฆง่กจ็คบใ—ใพใ™ใ€‚." + } + }, + "/bbs/articles/{id}": { + "get": { + "tags": [ + "BBS" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "ๅฏพ่ฑก่จ˜ไบ‹ใฎ", + "required": true + } + ], + "responses": { + "200": { + "description": "่จ˜ไบ‹ๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticle" + } + } + } + } + }, + "summary": "ๅ€‹ๅˆฅใฎ่จ˜ไบ‹ใ‚’่ชญใ‚€", + "description": "ๅ€‹ใ€…ใฎ่จ˜ไบ‹ใ‚’่ชญใฟใพใ™ใ€‚่จ˜ไบ‹ใ‚’ใใฎใ™ในใฆใฎ {@link IBbsArticle.ISnapshot ใ‚นใƒŠใƒƒใƒ—ใ‚ทใƒงใƒƒใƒˆใจใจใ‚‚ใซ่ชญใฟๅ–ใ‚Šใพใ™}." + }, + "put": { + "tags": [ + "BBS" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "ๅฏพ่ฑก่จ˜ไบ‹ใฎ", + "required": true + } + ], + "requestBody": { + "description": "ๆ›ดๆ–ฐใ™ใ‚‹่จ˜ไบ‹ๆƒ…ๅ ฑ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticle.IUpdate" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "ๆ–ฐใŸใซ่“„็ฉใ•ใ‚ŒใŸใ‚นใƒŠใƒƒใƒ—ใ‚ทใƒงใƒƒใƒˆๆƒ…ๅ ฑ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticle.ISnapshot" + } + } + } + } + }, + "summary": "่จ˜ไบ‹ใ‚’ๆ›ดๆ–ฐใ™ใ‚‹", + "description": "่จ˜ไบ‹ใ‚’ๆ›ดๆ–ฐใ—ใพใ™ใ€‚่จ˜ไบ‹ใซๆ–ฐใ—ใ„ {@link IBbsArticle.ISnapshot ใ‚นใƒŠใƒƒใƒ—ใ‚ทใƒงใƒƒใƒˆ} ใƒฌใ‚ณใƒผใƒ‰ใ‚’่“„็ฉใ—ใพใ™ใ€‚." + }, + "delete": { + "tags": [ + "BBS" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "ๅฏพ่ฑก่จ˜ไบ‹ใฎ", + "required": true + } + ], + "requestBody": { + "description": "่จ˜ไบ‹ใฎใƒ‘ใ‚นใƒฏใƒผใƒ‰.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticle.IErase" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "" + } + }, + "summary": "่จ˜ไบ‹ใ‚’ๆถˆๅŽปใ™ใ‚‹", + "description": "่จ˜ไบ‹ใ‚’ๆถˆๅŽปใ—ใพใ™ใ€‚่จ˜ไบ‹ใซๅฏพใ—ใฆใ‚ฝใƒ•ใƒˆๅ‰Š้™คใ‚’ๅฎŸ่กŒใ—ใพใ™." + } + }, + "/bbs/articles/{articleId}/comments": { + "patch": { + "tags": [ + "BBS" + ], + "parameters": [ + { + "name": "articleId", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "", + "required": true + } + ], + "requestBody": { + "description": "ใƒšใƒผใ‚ธใƒใƒผใ‚ทใƒงใƒณใจๆคœ็ดขใ‚ชใƒ—ใ‚ทใƒงใƒณใซ้–ขใ™ใ‚‹ๆƒ…ๅ ฑใ‚’ใƒชใ‚ฏใ‚จใ‚นใƒˆใ™ใ‚‹.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticleComment.IRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "ใƒšใƒผใ‚ธๅˆ†ใ‘ใ•ใ‚ŒใŸ่ฆ็ด„ใ‚ณใƒกใƒณใƒˆ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IPageIBbsArticleComment" + } + } + } + } + }, + "summary": "่ฆ็ด„ใ•ใ‚ŒใŸใ‚ณใƒกใƒณใƒˆใ‚’ใ™ในใฆไธ€่ฆง่กจ็คบใ™ใ‚‹", + "description": "่ฆ็ด„ใ•ใ‚ŒใŸใ‚ณใƒกใƒณใƒˆใ‚’ใ™ในใฆไธ€่ฆง่กจ็คบใ—ใพใ™ใ€‚ใƒšใƒผใ‚ธๅŒบๅˆ‡ใ‚Šใจๆคœ็ดขใ‚ชใƒ—ใ‚ทใƒงใƒณใ‚’ไฝฟ็”จใ—ใฆใ€่ฆ็ด„ใ•ใ‚ŒใŸใ‚ณใƒกใƒณใƒˆใ‚’ใ™ในใฆไธ€่ฆง่กจ็คบใ—ใพใ™ใ€‚." + }, + "post": { + "tags": [ + "BBS" + ], + "parameters": [ + { + "name": "articleId", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "ๆ‰€ๅฑž่จ˜ไบ‹", + "required": true + } + ], + "requestBody": { + "description": "ไฝœๆˆใ™ใ‚‹ใ‚ณใƒกใƒณใƒˆๆƒ…ๅ ฑ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticleComment.ICreate" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "ๆ–ฐใ—ใไฝœๆˆใ•ใ‚ŒใŸใ‚ณใƒกใƒณใƒˆ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticleComment" + } + } + } + } + }, + "summary": "ๆ–ฐใ—ใ„ใ‚ณใƒกใƒณใƒˆใ‚’ไฝœๆˆใ™ใ‚‹", + "description": "ๆ–ฐใ—ใ„ใ‚ณใƒกใƒณใƒˆใ‚’ไฝœๆˆใ—ใพใ™ใ€‚ๆœ€ๅˆใฎ {@link IBbsArticleComment.ISnapshot ใ‚นใƒŠใƒƒใƒ—ใ‚ทใƒงใƒƒใƒˆ} ใงๆ–ฐใ—ใ„ใ‚ณใƒกใƒณใƒˆใ‚’ไฝœๆˆใ—ใพใ™." + } + }, + "/bbs/articles/{articleId}/comments/{id}": { + "get": { + "tags": [ + "BBS" + ], + "parameters": [ + { + "name": "articleId", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "ๆ‰€ๅฑž่จ˜ไบ‹", + "required": true + }, + { + "name": "id", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "ใ‚ฟใƒผใ‚ฒใƒƒใƒˆใ‚ณใƒกใƒณใƒˆใฎ", + "required": true + } + ], + "responses": { + "200": { + "description": "ใ‚ณใƒกใƒณใƒˆๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticleComment" + } + } + } + } + }, + "summary": "ๅ€‹ๅˆฅใฎใ‚ณใƒกใƒณใƒˆใ‚’่ชญใ‚€", + "description": "ๅ€‹ใ€…ใฎใ‚ณใƒกใƒณใƒˆใ‚’่ชญใฟใพใ™ใ€‚ใ‚ณใƒกใƒณใƒˆใ‚’ใใฎใ™ในใฆใฎ {@link IBbsArticleComment.ISnapshot ใ‚นใƒŠใƒƒใƒ—ใ‚ทใƒงใƒƒใƒˆใจใจใ‚‚ใซ่ชญใฟๅ–ใ‚Šใพใ™}." + }, + "put": { + "tags": [ + "BBS" + ], + "parameters": [ + { + "name": "articleId", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "ๆ‰€ๅฑž่จ˜ไบ‹", + "required": true + }, + { + "name": "id", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "ใ‚ฟใƒผใ‚ฒใƒƒใƒˆใ‚ณใƒกใƒณใƒˆใฎ", + "required": true + } + ], + "requestBody": { + "description": "ๆ›ดๆ–ฐใ™ใ‚‹ใ‚ณใƒกใƒณใƒˆๆƒ…ๅ ฑ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticleComment.IUpdate" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "ๆ–ฐใŸใซ่“„็ฉใ•ใ‚ŒใŸใ‚นใƒŠใƒƒใƒ—ใ‚ทใƒงใƒƒใƒˆๆƒ…ๅ ฑ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticleComment.ISnapshot" + } + } + } + } + }, + "summary": "ใ‚ณใƒกใƒณใƒˆใ‚’ๆ›ดๆ–ฐใ™ใ‚‹", + "description": "ใ‚ณใƒกใƒณใƒˆใ‚’ๆ›ดๆ–ฐใ—ใพใ™ใ€‚ใ‚ณใƒกใƒณใƒˆใซๆ–ฐใ—ใ„{@link IBbsArticleComment.ISnapshotใ‚นใƒŠใƒƒใƒ—ใ‚ทใƒงใƒƒใƒˆ}ใƒฌใ‚ณใƒผใƒ‰ใ‚’่“„็ฉใ—ใพใ™ใ€‚." + }, + "delete": { + "tags": [ + "BBS" + ], + "parameters": [ + { + "name": "articleId", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "ๆ‰€ๅฑž่จ˜ไบ‹", + "required": true + }, + { + "name": "id", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "ใ‚ฟใƒผใ‚ฒใƒƒใƒˆใ‚ณใƒกใƒณใƒˆใฎ", + "required": true + } + ], + "requestBody": { + "description": "ใ‚ณใƒกใƒณใƒˆใฎใƒ‘ใ‚นใƒฏใƒผใƒ‰.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticleComment.IErase" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "" + } + }, + "summary": "ใ‚ณใƒกใƒณใƒˆใ‚’ๆถˆๅŽป", + "description": "ใ‚ณใƒกใƒณใƒˆใ‚’ๆถˆๅŽปใ—ใพใ™ใ€‚ใ‚ณใƒกใƒณใƒˆใฎใ‚ฝใƒ•ใƒˆๅ‰Š้™คใ‚’ๅฎŸ่กŒใ—ใพใ™." + } + }, + "/monitors/health": { + "get": { + "tags": [ + "Monitor" + ], + "parameters": [], + "responses": { + "200": { + "description": "" + } + }, + "summary": "ใƒ˜ใƒซใ‚นใƒใ‚งใƒƒใ‚ฏAPI", + "description": "ใƒ˜ใƒซใ‚นใƒใ‚งใƒƒใ‚ฏAPI." + } + }, + "/monitors/performance": { + "get": { + "tags": [ + "Monitor" + ], + "parameters": [], + "responses": { + "200": { + "description": "ใƒ‘ใƒ•ใ‚ฉใƒผใƒžใƒณใ‚นๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IPerformance" + } + } + } + } + }, + "summary": "ใƒ‘ใƒ•ใ‚ฉใƒผใƒžใƒณใ‚นๆƒ…ๅ ฑใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "description": "ใƒ‘ใƒ•ใ‚ฉใƒผใƒžใƒณใ‚นๆƒ…ๅ ฑใ‚’ๅ–ๅพ—ใ—ใพใ™ใ€‚CPUใ€ใƒกใƒขใƒชใ€ใƒชใ‚ฝใƒผใ‚นใฎไฝฟ็”จ็Šถๆณใงๆง‹ๆˆใ•ใ‚ŒใŸใƒ‘ใƒ•ใ‚ฉใƒผใƒžใƒณใ‚นๆƒ…ๅ ฑใ‚’ๅ–ๅพ—ใ—ใพใ™ใ€‚." + } + }, + "/monitors/system": { + "get": { + "tags": [ + "Monitor" + ], + "parameters": [], + "responses": { + "200": { + "description": "ใ‚ทใ‚นใƒ†ใƒ ๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ISystem" + } + } + } + } + }, + "summary": "ใ‚ทใ‚นใƒ†ใƒ ๆƒ…ๅ ฑใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "description": "ใ‚ทใ‚นใƒ†ใƒ ๆƒ…ๅ ฑใ‚’ๅ–ๅพ—ใ—ใพใ™ใ€‚ใ‚ณใƒŸใƒƒใƒˆใจใƒ‘ใƒƒใ‚ฑใƒผใ‚ธๆƒ…ๅ ฑใ‚’ๅซใ‚€ใ‚ทใ‚นใƒ†ใƒ ๆƒ…ๅ ฑใ‚’ๅ–ๅพ—ใ—ใพใ™ใ€‚." + } + } + }, + "components": { + "schemas": { + "IBbsArticle.IRequest": { + "type": "object", + "properties": { + "search": { + "$ref": "#/components/schemas/IBbsArticle.IRequest.ISearch", + "title": "ๆคœ็ดขๆกไปถ", + "description": "ๆคœ็ดขๆกไปถ." + }, + "sort": { + "type": "array", + "items": { + "oneOf": [ + { + "const": "-writer" + }, + { + "const": "-title" + }, + { + "const": "-created_at" + }, + { + "const": "-updated_at" + }, + { + "const": "+writer" + }, + { + "const": "+title" + }, + { + "const": "+created_at" + }, + { + "const": "+updated_at" + } + ] + }, + "title": "ไธฆในๆ›ฟใˆๆกไปถ", + "description": "ไธฆในๆ›ฟใˆๆกไปถ." + }, + "page": { + "type": "integer", + "title": "ใƒšใƒผใ‚ธ็•ชๅท", + "description": "ใƒšใƒผใ‚ธ็•ชๅท." + }, + "limit": { + "type": "integer", + "default": 100, + "title": "1ใƒšใƒผใ‚ธใ‚ใŸใ‚Šใฎใƒฌใ‚ณใƒผใƒ‰ๆ•ฐใฎๅˆถ้™", + "description": "1ใƒšใƒผใ‚ธใ‚ใŸใ‚Šใฎใƒฌใ‚ณใƒผใƒ‰ๆ•ฐใฎๅˆถ้™." + } + } + }, + "IBbsArticle.IRequest.ISearch": { + "type": "object", + "properties": { + "writer": { + "type": "string" + }, + "title": { + "type": "string" + }, + "body": { + "type": "string" + }, + "title_or_body": { + "type": "string" + }, + "from": { + "type": "string", + "format": "date-time" + }, + "to": { + "type": "string", + "format": "date-time" + } + }, + "description": "ๆคœๆŸป็ตๆžœ." + }, + "IPageIBbsArticle.ISummary": { + "type": "object", + "properties": { + "pagination": { + "$ref": "#/components/schemas/IPage.IPagination", + "title": "ใƒšใƒผใ‚ธๆƒ…ๅ ฑ", + "description": "ใƒšใƒผใ‚ธๆƒ…ๅ ฑ." + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IBbsArticle.ISummary" + }, + "title": "่จ˜้Œฒไธ€่ฆง", + "description": "่จ˜้Œฒไธ€่ฆง." + } + }, + "required": [ + "pagination", + "data" + ], + "description": "ใƒšใƒผใ‚ธใ€‚ใƒšใƒผใ‚ธ็•ชๅทๆƒ…ๅ ฑใ‚’ๅซใ‚€ใƒฌใ‚ณใƒผใƒ‰ใฎใ‚ณใƒฌใ‚ฏใ‚ทใƒงใƒณ." + }, + "IPage.IPagination": { + "type": "object", + "properties": { + "current": { + "type": "integer", + "title": "็พๅœจใฎใƒšใƒผใ‚ธ็•ชๅท", + "description": "็พๅœจใฎใƒšใƒผใ‚ธ็•ชๅท." + }, + "limit": { + "type": "integer", + "default": 100, + "title": "1ใƒšใƒผใ‚ธใ‚ใŸใ‚Šใฎใƒฌใ‚ณใƒผใƒ‰ๆ•ฐใฎๅˆถ้™", + "description": "1ใƒšใƒผใ‚ธใ‚ใŸใ‚Šใฎใƒฌใ‚ณใƒผใƒ‰ๆ•ฐใฎๅˆถ้™." + }, + "records": { + "type": "integer", + "title": "ใƒ‡ใƒผใ‚ฟใƒ™ใƒผใ‚นๅ†…ใฎใƒฌใ‚ณใƒผใƒ‰็ทๆ•ฐ", + "description": "ใƒ‡ใƒผใ‚ฟใƒ™ใƒผใ‚นๅ†…ใฎใƒฌใ‚ณใƒผใƒ‰็ทๆ•ฐ." + }, + "pages": { + "type": "integer", + "title": "็ทใƒšใƒผใ‚ธๆ•ฐ", + "description": "ๅˆ่จˆใƒšใƒผใ‚ธๆ•ฐใ€‚ไธŠ้™ใฏ {@link records } / {@link limit } ใซ็ญ‰ใ—ใ„." + } + }, + "required": [ + "current", + "limit", + "records", + "pages" + ], + "description": "ใƒšใƒผใ‚ธๆƒ…ๅ ฑ." + }, + "IBbsArticle.ISummary": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "title": "ไธปใ‚ญใƒผ", + "description": "ไธปใ‚ญใƒผ." + }, + "writer": { + "type": "string", + "title": "่จ˜ไบ‹ใฎ่‘—่€…", + "description": "่จ˜ไบ‹ใฎ่‘—่€…." + }, + "title": { + "type": "string", + "title": "ๆœ€ๅพŒใฎใ‚นใƒŠใƒƒใƒ—ใ‚ทใƒงใƒƒใƒˆใฎใ‚ฟใ‚คใƒˆใƒซ", + "description": "ๆœ€ๅพŒใฎใ‚นใƒŠใƒƒใƒ—ใ‚ทใƒงใƒƒใƒˆใฎใ‚ฟใ‚คใƒˆใƒซ." + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "่จ˜ไบ‹ใฎไฝœๆˆๆ™‚้–“", + "description": "่จ˜ไบ‹ใฎไฝœๆˆๆ™‚้–“." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "title": "่จ˜ไบ‹ใฎไฟฎๆญฃๆ—ฅๆ™‚", + "description": "่จ˜ไบ‹ใฎๅค‰ๆ›ดๆ™‚ๅˆปใ€‚ใคใพใ‚Šใ€ๆœ€ๅพŒใฎใ‚นใƒŠใƒƒใƒ—ใ‚ทใƒงใƒƒใƒˆใŒไฝœๆˆใ•ใ‚ŒใŸๆ™‚ๅˆปใงใ™ใ€‚." + } + }, + "required": [ + "id", + "writer", + "title", + "created_at", + "updated_at" + ], + "description": "่จ˜ไบ‹ใฎ่ฆ็ด„ๆƒ…ๅ ฑ." + }, + "IPageIBbsArticle.IAbridge": { + "type": "object", + "properties": { + "pagination": { + "$ref": "#/components/schemas/IPage.IPagination", + "title": "ใƒšใƒผใ‚ธๆƒ…ๅ ฑ", + "description": "ใƒšใƒผใ‚ธๆƒ…ๅ ฑ." + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IBbsArticle.IAbridge" + }, + "title": "่จ˜้Œฒไธ€่ฆง", + "description": "่จ˜้Œฒไธ€่ฆง." + } + }, + "required": [ + "pagination", + "data" + ], + "description": "ใƒšใƒผใ‚ธใ€‚ใƒšใƒผใ‚ธ็•ชๅทๆƒ…ๅ ฑใ‚’ๅซใ‚€ใƒฌใ‚ณใƒผใƒ‰ใฎใ‚ณใƒฌใ‚ฏใ‚ทใƒงใƒณ." + }, + "IBbsArticle.IAbridge": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "title": "ไธปใ‚ญใƒผ", + "description": "ไธปใ‚ญใƒผ." + }, + "writer": { + "type": "string", + "title": "่จ˜ไบ‹ใฎ่‘—่€…", + "description": "่จ˜ไบ‹ใฎ่‘—่€…." + }, + "title": { + "type": "string", + "title": "ๆœ€ๅพŒใฎใ‚นใƒŠใƒƒใƒ—ใ‚ทใƒงใƒƒใƒˆใฎใ‚ฟใ‚คใƒˆใƒซ", + "description": "ๆœ€ๅพŒใฎใ‚นใƒŠใƒƒใƒ—ใ‚ทใƒงใƒƒใƒˆใฎใ‚ฟใ‚คใƒˆใƒซ." + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "่จ˜ไบ‹ใฎไฝœๆˆๆ™‚้–“", + "description": "่จ˜ไบ‹ใฎไฝœๆˆๆ™‚้–“." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "title": "่จ˜ไบ‹ใฎไฟฎๆญฃๆ—ฅๆ™‚", + "description": "่จ˜ไบ‹ใฎๅค‰ๆ›ดๆ™‚ๅˆปใ€‚ใคใพใ‚Šใ€ๆœ€ๅพŒใฎใ‚นใƒŠใƒƒใƒ—ใ‚ทใƒงใƒƒใƒˆใŒไฝœๆˆใ•ใ‚ŒใŸๆ™‚ๅˆปใงใ™ใ€‚." + }, + "format": { + "$ref": "#/components/schemas/IBbsArticle.Format", + "title": "ๆœฌๆ–‡ใฎๅฝขๅผ", + "description": "ๆœฌๆ–‡ใฎใƒ•ใ‚ฉใƒผใƒžใƒƒใƒˆใ€‚`html`ใ€`md`ใ€`txt` ใชใฉใฎๆ‹กๅผตๅญใจๅŒใ˜ๆ„ๅ‘ณใงใ™ใ€‚." + }, + "body": { + "type": "string", + "title": "่จ˜ไบ‹ใฎๅ†…ๅฎนๆœฌๆ–‡", + "description": "่จ˜ไบ‹ใฎๅ†…ๅฎนๆœฌๆ–‡." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAttachmentFile.ICreate" + }, + "title": "ๆทปไป˜ใƒ•ใ‚กใ‚คใƒซใฎใƒชใ‚นใƒˆ", + "description": "ๆทปไป˜ใƒ•ใ‚กใ‚คใƒซใฎใƒชใ‚นใƒˆ." + } + }, + "required": [ + "id", + "writer", + "title", + "created_at", + "updated_at", + "format", + "body", + "files" + ], + "description": "่จ˜ไบ‹ใฎ่ฆ็ด„ๆƒ…ๅ ฑ." + }, + "IBbsArticle.Format": { + "oneOf": [ + { + "const": "txt" + }, + { + "const": "md" + }, + { + "const": "html" + } + ] + }, + "IAttachmentFile.ICreate": { + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 255, + "title": "ๆ‹กๅผตๅญใ‚’้™คใใƒ•ใ‚กใ‚คใƒซๅ", + "description": "ๆ‹กๅผตๅญใ‚’้™คใใƒ•ใ‚กใ‚คใƒซๅ." + }, + "extension": { + "oneOf": [ + { + "type": "string", + "maxLength": 8, + "minLength": 1 + }, + { + "type": "null" + } + ], + "title": "ๆ‹กๅคง", + "description": "ๆ‹กๅผตๅญใ€‚`README` ใฎใ‚ˆใ†ใซ็œ็•ฅๅฏ่ƒฝ." + }, + "url": { + "type": "string", + "format": "uri", + "contentMediaType": "application/octet-stream", + "title": "ๅฎŸ้š›ใฎใƒ•ใ‚กใ‚คใƒซใฎURLใƒ‘ใ‚น", + "description": "ๅฎŸ้š›ใฎใƒ•ใ‚กใ‚คใƒซใฎURLใƒ‘ใ‚น." + } + }, + "required": [ + "name", + "extension", + "url" + ] + }, + "IBbsArticle": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "title": "ไธปใ‚ญใƒผ", + "description": "ไธปใ‚ญใƒผ.", + "x-special-description": "Sommetimes made by database automatically." + }, + "writer": { + "type": "string", + "title": "่จ˜ไบ‹ใฎ่‘—่€…", + "description": "่จ˜ไบ‹ใฎ่‘—่€…." + }, + "snapshots": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IBbsArticle.ISnapshot" + }, + "minItems": 1, + "title": "ใ‚นใƒŠใƒƒใƒ—ใ‚ทใƒงใƒƒใƒˆใฎๅ†…ๅฎนไธ€่ฆง", + "description": "ใ‚นใƒŠใƒƒใƒ—ใ‚ทใƒงใƒƒใƒˆใฎๅ†…ๅฎนใฎไธ€่ฆงใ€‚่จ˜ไบ‹ไฝœๆˆๆ™‚ใซๅˆใ‚ใฆไฝœๆˆใ•ใ‚Œใ€่จ˜ไบ‹ใŒๅค‰ๆ›ดใ•ใ‚Œใ‚‹ใŸใณใซ่“„็ฉใ•ใ‚Œใพใ™ใ€‚." + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "่จ˜ไบ‹ไฝœๆˆๆ™‚้–“", + "description": "่จ˜ไบ‹ไฝœๆˆๆ™‚้–“." + } + }, + "required": [ + "id", + "writer", + "snapshots", + "created_at" + ], + "description": "่จ˜ไบ‹ใ‚จใƒณใƒ†ใ‚ฃใƒ†ใ‚ฃใ€‚ `IBbsArticle* ใฏใ€็พๅœจใฎใƒใƒƒใ‚ฏใ‚จใƒณใƒ‰ใ‚ทใ‚นใƒ†ใƒ ใซใ‚ใ‚‹ใ‚ใ‚‰ใ‚†ใ‚‹็จฎ้กžใฎ่จ˜ไบ‹ใฎใ‚นใƒผใƒ‘ใƒผใ‚ฟใ‚คใƒ—ใฎใ‚จใƒณใƒ†ใ‚ฃใƒ†ใ‚ฃใงใ‚ใ‚Šใ€ๆ–‡ๅญ—้€šใ‚ŠๆŽฒ็คบๆฟใฎๅ€‹ใ€…ใฎ่จ˜ไบ‹ใ‚’ๅฝขไฝœใฃใฆใ„ใพใ™ใ€‚ ใใ—ใฆใ€ใ”่ฆงใฎใจใŠใ‚Šใ€่จ˜ไบ‹ใซๅฟ…ใšๅญ˜ๅœจใ—ใชใ‘ใ‚Œใฐใชใ‚‰ใชใ„่ฆ็ด ใ€ใŸใจใˆใฐ `title` ใ‚„ `body` ใฏ `IBbsArticle` ใซใฏๅญ˜ๅœจใ›ใšใ€่ฃœๅŠฉใ‚จใƒณใƒ†ใ‚ฃใƒ†ใ‚ฃใงใ‚ใ‚‹ {@link IBbsArticle.ISnapshot } ใซ 1:N ใฎ้–ขไฟ‚ใงๅญ˜ๅœจใ—ใพใ™ใ€‚ ใ“ใ‚Œใฏใ€่จ˜ไบ‹ใŒๅค‰ๆ›ดใ•ใ‚Œใ‚‹ใŸใณใซๆ–ฐใ—ใ„ใ‚นใƒŠใƒƒใƒ—ใ‚ทใƒงใƒƒใƒˆใƒฌใ‚ณใƒผใƒ‰ใŒๅ…ฌ้–‹ใ•ใ‚Œใ‚‹ใŸใ‚ใงใ™ใ€‚ ่จ˜ไบ‹ใŒๅค‰ๆ›ดใ•ใ‚Œใ‚‹ใŸใณใซๆ–ฐใ—ใ„ใ‚นใƒŠใƒƒใƒ—ใ‚ทใƒงใƒƒใƒˆใƒฌใ‚ณใƒผใƒ‰ใŒๅ…ฌ้–‹ใ•ใ‚Œใ‚‹็†็”ฑใฏใ€่จผๆ‹ ใ‚’ไฟๅญ˜ใ™ใ‚‹ใŸใ‚ใงใ™ใ€‚ e-ใ‚ณใƒŸใƒฅใƒ‹ใƒ†ใ‚ฃใฎๆ€ง่ณชไธŠใ€ๅ‚ๅŠ ่€…ใฎ้–“ใง็ด›ไบ‰ใŒ็™บ็”Ÿใ™ใ‚‹ๅฏ่ƒฝๆ€งใฏๅธธใซใ‚ใ‚Šใพใ™ใ€‚ ใใ—ใฆใ€่จ˜ไบ‹ใ‚„ {@link IBbsArticleComment ใ‚ณใƒกใƒณใƒˆ} ใ‚’้€šใ˜ใฆ็ด›ไบ‰ใŒ็™บ็”Ÿใ™ใ‚‹ๅฏ่ƒฝๆ€งใŒใ‚ใ‚Šใ€ๆ—ขๅญ˜ใฎ่จ˜ไบ‹ใ‚’ๅค‰ๆ›ดใ—ใฆ็Šถๆณใ‚’ๆ“ไฝœใ™ใ‚‹ใชใฉใฎ่กŒ็‚บใ‚’้˜ฒใใŸใ‚ใซใ€่จ˜ไบ‹ใฏใ“ใฎใ‚ˆใ†ใชๆง‹้€ ใซ่จญ่จˆใ•ใ‚Œใฆใ„ใพใ™ใ€‚ ใคใพใ‚Šใ€่จผๆ‹ ใ‚’ไฟๅญ˜ใ—ใ€่ฉๆฌบใ‚’้˜ฒๆญขใ™ใ‚‹ใŸใ‚ใงใ™ใ€‚." + }, + "IBbsArticle.ISnapshot": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "title": "ไธปใ‚ญใƒผ", + "description": "ไธปใ‚ญใƒผ." + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "ใ‚นใƒŠใƒƒใƒ—ใ‚ทใƒงใƒƒใƒˆใƒฌใ‚ณใƒผใƒ‰ใฎไฝœๆˆๆ™‚ๅˆป", + "description": "ใ‚นใƒŠใƒƒใƒ—ใ‚ทใƒงใƒƒใƒˆใƒฌใ‚ณใƒผใƒ‰ใฎไฝœๆˆๆ™‚ๅˆปใ€‚ใคใพใ‚Šใ€ไฝœๆˆๆ™‚ๅˆปใพใŸใฏๆ›ดๆ–ฐๆ™‚ๅˆปใพใŸใฏ่จ˜ไบ‹." + }, + "format": { + "$ref": "#/components/schemas/IBbsArticle.Format", + "title": "ๆœฌๆ–‡ใฎๅฝขๅผ", + "description": "ๆœฌๆ–‡ใฎใƒ•ใ‚ฉใƒผใƒžใƒƒใƒˆใ€‚`html`ใ€`md`ใ€`txt` ใชใฉใฎๆ‹กๅผตๅญใจๅŒใ˜ๆ„ๅ‘ณใงใ™ใ€‚." + }, + "body": { + "type": "string", + "title": "่จ˜ไบ‹ใฎๅ†…ๅฎนๆœฌๆ–‡", + "description": "่จ˜ไบ‹ใฎๅ†…ๅฎนๆœฌๆ–‡." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAttachmentFile.ICreate" + }, + "title": "ๆทปไป˜ใƒ•ใ‚กใ‚คใƒซใฎใƒชใ‚นใƒˆ", + "description": "ๆทปไป˜ใƒ•ใ‚กใ‚คใƒซใฎใƒชใ‚นใƒˆ." + }, + "title": { + "type": "string", + "title": "่จ˜ไบ‹ใฎใ‚ฟใ‚คใƒˆใƒซ", + "description": "่จ˜ไบ‹ใฎใ‚ฟใ‚คใƒˆใƒซ." + } + }, + "required": [ + "id", + "created_at", + "format", + "body", + "files", + "title" + ], + "description": "่จ˜ไบ‹ใฎใ‚นใƒŠใƒƒใƒ—ใ‚ทใƒงใƒƒใƒˆใ€‚ `IBbsArticle.ISnapshot` ใฏ่จ˜ไบ‹ใฎๅ†…ๅฎนใ‚’ๅซใ‚€ใ‚นใƒŠใƒƒใƒ—ใ‚ทใƒงใƒƒใƒˆใ‚จใƒณใƒ†ใ‚ฃใƒ†ใ‚ฃใงใ™ใ€‚{@link IBbsArticle } ใง่ฟฐในใŸใ‚ˆใ†ใซใ€่จ˜ไบ‹ใฎๅ†…ๅฎนใฏ่จผๆ‹ ใ‚’ไฟๅญ˜ใ—ใ€ไธๆญฃใ‚’้˜ฒใใŸใ‚ใซ่จ˜ไบ‹ใƒฌใ‚ณใƒผใƒ‰ใ‹ใ‚‰ๅˆ†้›ขใ•ใ‚Œใฆใ„ใพใ™ใ€‚." + }, + "IBbsArticle.ICreate": { + "type": "object", + "properties": { + "writer": { + "type": "string" + }, + "format": { + "oneOf": [ + { + "const": "txt" + }, + { + "const": "md" + }, + { + "const": "html" + } + ], + "title": "ๆœฌๆ–‡ใฎๅฝขๅผ", + "description": "ๆœฌๆ–‡ใฎใƒ•ใ‚ฉใƒผใƒžใƒƒใƒˆใ€‚`html`ใ€`md`ใ€`txt` ใชใฉใฎๆ‹กๅผตๅญใจๅŒใ˜ๆ„ๅ‘ณใงใ™ใ€‚." + }, + "title": { + "type": "string", + "title": "่จ˜ไบ‹ใฎใ‚ฟใ‚คใƒˆใƒซ", + "description": "่จ˜ไบ‹ใฎใ‚ฟใ‚คใƒˆใƒซ." + }, + "body": { + "type": "string", + "title": "่จ˜ไบ‹ใฎๅ†…ๅฎนๆœฌๆ–‡", + "description": "่จ˜ไบ‹ใฎๅ†…ๅฎนๆœฌๆ–‡." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAttachmentFile.ICreate" + }, + "title": "ๆทปไป˜ใƒ•ใ‚กใ‚คใƒซใฎใƒชใ‚นใƒˆ", + "description": "ๆทปไป˜ใƒ•ใ‚กใ‚คใƒซใฎใƒชใ‚นใƒˆ." + }, + "password": { + "type": "string", + "title": "ๅค‰ๆ›ด็”จใƒ‘ใ‚นใƒฏใƒผใƒ‰", + "description": "ๅค‰ๆ›ด็”จใƒ‘ใ‚นใƒฏใƒผใƒ‰." + } + }, + "required": [ + "writer", + "format", + "title", + "body", + "files", + "password" + ], + "description": "่จ˜ไบ‹ใฎใ‚ณใƒณใƒ†ใƒณใƒ„ใ‚ฟใ‚คใƒ—ใ‚’ไฟๅญ˜ใ™ใ‚‹." + }, + "IBbsArticle.IUpdate": { + "type": "object", + "properties": { + "format": { + "oneOf": [ + { + "const": "txt" + }, + { + "const": "md" + }, + { + "const": "html" + } + ], + "title": "ๆœฌๆ–‡ใฎๅฝขๅผ", + "description": "ๆœฌๆ–‡ใฎใƒ•ใ‚ฉใƒผใƒžใƒƒใƒˆใ€‚`html`ใ€`md`ใ€`txt` ใชใฉใฎๆ‹กๅผตๅญใจๅŒใ˜ๆ„ๅ‘ณใงใ™ใ€‚." + }, + "title": { + "type": "string", + "title": "่จ˜ไบ‹ใฎใ‚ฟใ‚คใƒˆใƒซ", + "description": "่จ˜ไบ‹ใฎใ‚ฟใ‚คใƒˆใƒซ." + }, + "body": { + "type": "string", + "title": "่จ˜ไบ‹ใฎๅ†…ๅฎนๆœฌๆ–‡", + "description": "่จ˜ไบ‹ใฎๅ†…ๅฎนๆœฌๆ–‡." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAttachmentFile.ICreate" + }, + "title": "ๆทปไป˜ใƒ•ใ‚กใ‚คใƒซใฎใƒชใ‚นใƒˆ", + "description": "ๆทปไป˜ใƒ•ใ‚กใ‚คใƒซใฎใƒชใ‚นใƒˆ." + }, + "password": { + "type": "string", + "title": "ๅค‰ๆ›ด็”จใƒ‘ใ‚นใƒฏใƒผใƒ‰", + "description": "ๅค‰ๆ›ด็”จใƒ‘ใ‚นใƒฏใƒผใƒ‰." + } + }, + "required": [ + "format", + "title", + "body", + "files", + "password" + ] + }, + "IBbsArticle.IErase": { + "type": "object", + "properties": { + "password": { + "type": "string" + } + }, + "required": [ + "password" + ] + }, + "IBbsArticleComment.IRequest": { + "type": "object", + "properties": { + "search": { + "$ref": "#/components/schemas/IBbsArticleComment.IRequest.ISearch" + }, + "sort": { + "type": "array", + "items": { + "oneOf": [ + { + "const": "-writer" + }, + { + "const": "-created_at" + }, + { + "const": "+writer" + }, + { + "const": "+created_at" + } + ] + } + }, + "page": { + "type": "integer", + "title": "ใƒšใƒผใ‚ธ็•ชๅท", + "description": "ใƒšใƒผใ‚ธ็•ชๅท." + }, + "limit": { + "type": "integer", + "default": 100, + "title": "1ใƒšใƒผใ‚ธใ‚ใŸใ‚Šใฎใƒฌใ‚ณใƒผใƒ‰ๆ•ฐใฎๅˆถ้™", + "description": "1ใƒšใƒผใ‚ธใ‚ใŸใ‚Šใฎใƒฌใ‚ณใƒผใƒ‰ๆ•ฐใฎๅˆถ้™." + } + } + }, + "IBbsArticleComment.IRequest.ISearch": { + "type": "object", + "properties": { + "writer": { + "type": "string" + }, + "body": { + "type": "string" + } + } + }, + "IPageIBbsArticleComment": { + "type": "object", + "properties": { + "pagination": { + "$ref": "#/components/schemas/IPage.IPagination", + "title": "ใƒšใƒผใ‚ธๆƒ…ๅ ฑ", + "description": "ใƒšใƒผใ‚ธๆƒ…ๅ ฑ." + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IBbsArticleComment" + }, + "title": "่จ˜้Œฒไธ€่ฆง", + "description": "่จ˜้Œฒไธ€่ฆง." + } + }, + "required": [ + "pagination", + "data" + ], + "description": "ใƒšใƒผใ‚ธใ€‚ใƒšใƒผใ‚ธ็•ชๅทๆƒ…ๅ ฑใ‚’ๅซใ‚€ใƒฌใ‚ณใƒผใƒ‰ใฎใ‚ณใƒฌใ‚ฏใ‚ทใƒงใƒณ." + }, + "IBbsArticleComment": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "title": "ไธปใ‚ญใƒผ", + "description": "ไธปใ‚ญใƒผ." + }, + "parent_id": { + "oneOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], + "title": "่ฆชใ‚ณใƒกใƒณใƒˆใฎID", + "description": "่ฆชใ‚ณใƒกใƒณใƒˆใฎID." + }, + "writer": { + "type": "string", + "title": "ใ‚ณใƒกใƒณใƒˆใฎๆŠ•็จฟ่€…", + "description": "ใ‚ณใƒกใƒณใƒˆใฎๆŠ•็จฟ่€…." + }, + "snapshots": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IBbsArticleComment.ISnapshot" + }, + "minItems": 1, + "title": "ใ‚นใƒŠใƒƒใƒ—ใ‚ทใƒงใƒƒใƒˆใฎๅ†…ๅฎนไธ€่ฆง", + "description": "ใ‚นใƒŠใƒƒใƒ—ใ‚ทใƒงใƒƒใƒˆใฎๅ†…ๅฎนใฎใƒชใ‚นใƒˆใ€‚ใ‚ณใƒกใƒณใƒˆใฎไฝœๆˆๆ™‚ใซๅˆใ‚ใฆไฝœๆˆใ•ใ‚Œใ€ใ‚ณใƒกใƒณใƒˆใŒๅค‰ๆ›ดใ•ใ‚Œใ‚‹ใŸใณใซ่“„็ฉใ•ใ‚Œใพใ™ใ€‚." + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "ใ‚ณใƒกใƒณใƒˆใฎไฝœๆˆๆ™‚้–“", + "description": "ใ‚ณใƒกใƒณใƒˆใฎไฝœๆˆๆ™‚้–“." + } + }, + "required": [ + "id", + "parent_id", + "writer", + "snapshots", + "created_at" + ], + "description": "่จ˜ไบ‹ใซๆ›ธใ่พผใพใ‚ŒใŸใ‚ณใƒกใƒณใƒˆใ€‚`IBbsArticleComment` ใฏ่จ˜ไบ‹ใซๆ›ธใ่พผใพใ‚ŒใŸใ‚ณใƒกใƒณใƒˆใ‚’ๅฝขไฝœใ‚‹ใ‚จใƒณใƒ†ใ‚ฃใƒ†ใ‚ฃใงใ™ใ€‚ใใ—ใฆใ“ใฎใ‚ณใƒกใƒณใƒˆใฏใ€ๅ‰่ฟฐใฎ {@link IBbsArticle } ใจ {@link IBbsArticle.ISnapshot } ใฎ้–ขไฟ‚ใจๅŒๆง˜ใซใ€ใ‚ณใƒกใƒณใƒˆใฎใ‚ณใƒณใƒ†ใƒณใƒ„ๆœฌไฝ“ใฏ่จผๆ‹ ไธป็พฉใฎใŸใ‚ใซใ‚ตใƒ– {@link IBbsArticleComment.ISnapshot } ใƒ†ใƒผใƒ–ใƒซใซๆ ผ็ดใ•ใ‚Œใ€ใ‚ณใƒกใƒณใƒˆใŒๅค‰ๆ›ดใ•ใ‚Œใ‚‹ใŸใณใซๆ–ฐใ—ใ„ใ‚นใƒŠใƒƒใƒ—ใ‚ทใƒงใƒƒใƒˆใƒฌใ‚ณใƒผใƒ‰ใŒ็™บ่กŒใ•ใ‚Œใพใ™ใ€‚ใพใŸใ€`IBbsArticleComment` ใฏ {@link IBbsArticleComment.parent_id } ๅฑžๆ€งใ‚’้€šใ˜ใฆ้šŽๅฑค็š„ใช่ฟ”ไฟกๆง‹้€ ใฎ้–ขไฟ‚ใ‚’่กจ็พใ—ใฆใ„ใพใ™ใ€‚." + }, + "IBbsArticleComment.ISnapshot": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "title": "ไธปใ‚ญใƒผ", + "description": "ไธปใ‚ญใƒผ." + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "ใ‚นใƒŠใƒƒใƒ—ใ‚ทใƒงใƒƒใƒˆใƒฌใ‚ณใƒผใƒ‰ใฎไฝœๆˆๆ™‚ๅˆป", + "description": "ใ‚นใƒŠใƒƒใƒ—ใ‚ทใƒงใƒƒใƒˆใƒฌใ‚ณใƒผใƒ‰ใฎไฝœๆˆๆ™‚ๅˆปใ€‚ใคใพใ‚Šใ€ไฝœๆˆๆ™‚ๅˆปใ€ๆ›ดๆ–ฐๆ™‚ๅˆปใ€ใ‚ณใƒกใƒณใƒˆ." + }, + "format": { + "$ref": "#/components/schemas/IBbsArticleComment.Format", + "title": "ๆœฌๆ–‡ใฎๅฝขๅผ", + "description": "ๆœฌๆ–‡ใฎใƒ•ใ‚ฉใƒผใƒžใƒƒใƒˆใ€‚`html`ใ€`md`ใ€`txt` ใชใฉใฎๆ‹กๅผตๅญใจๅŒใ˜ๆ„ๅ‘ณใงใ™ใ€‚." + }, + "body": { + "type": "string", + "title": "ใ‚ณใƒกใƒณใƒˆใฎๅ†…ๅฎนๆœฌๆ–‡", + "description": "ใ‚ณใƒกใƒณใƒˆใฎๅ†…ๅฎนๆœฌๆ–‡." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAttachmentFile.ICreate" + }, + "title": "ๆทปไป˜ใƒ•ใ‚กใ‚คใƒซใฎใƒชใ‚นใƒˆ", + "description": "ๆทปไป˜ใƒ•ใ‚กใ‚คใƒซใฎใƒชใ‚นใƒˆ." + } + }, + "required": [ + "id", + "created_at", + "format", + "body", + "files" + ], + "description": "ใ‚ณใƒกใƒณใƒˆใฎใ‚นใƒŠใƒƒใƒ—ใ‚ทใƒงใƒƒใƒˆใ€‚`IBbsArticleComment.ISnapshot` ใฏใ‚ณใƒกใƒณใƒˆใฎๅ†…ๅฎนใ‚’ๅซใ‚€ใ‚นใƒŠใƒƒใƒ—ใ‚ทใƒงใƒƒใƒˆใ‚จใƒณใƒ†ใ‚ฃใƒ†ใ‚ฃใงใ™ใ€‚{@link IBbsArticleComment } ใง่ฟฐในใŸใ‚ˆใ†ใซใ€่จผๆ‹ ใ‚’ไฟๅญ˜ใ—ใ€ไธๆญฃ่กŒ็‚บใ‚’้˜ฒๆญขใ™ใ‚‹ใ‚ˆใ†ใซ่จญ่จˆใ•ใ‚Œใฆใ„ใพใ™ใ€‚." + }, + "IBbsArticleComment.Format": { + "oneOf": [ + { + "const": "txt" + }, + { + "const": "md" + }, + { + "const": "html" + } + ] + }, + "IBbsArticleComment.ICreate": { + "type": "object", + "properties": { + "writer": { + "type": "string", + "title": "ใ‚ณใƒกใƒณใƒˆใฎๆŠ•็จฟ่€…", + "description": "ใ‚ณใƒกใƒณใƒˆใฎๆŠ•็จฟ่€…." + }, + "format": { + "oneOf": [ + { + "const": "txt" + }, + { + "const": "md" + }, + { + "const": "html" + } + ], + "title": "ๆœฌๆ–‡ใฎๅฝขๅผ", + "description": "ๆœฌๆ–‡ใฎใƒ•ใ‚ฉใƒผใƒžใƒƒใƒˆใ€‚`html`ใ€`md`ใ€`txt` ใชใฉใฎๆ‹กๅผตๅญใจๅŒใ˜ๆ„ๅ‘ณใงใ™ใ€‚." + }, + "body": { + "type": "string", + "title": "ใ‚ณใƒกใƒณใƒˆใฎๅ†…ๅฎนๆœฌๆ–‡", + "description": "ใ‚ณใƒกใƒณใƒˆใฎๅ†…ๅฎนๆœฌๆ–‡." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAttachmentFile.ICreate" + }, + "title": "ๆทปไป˜ใƒ•ใ‚กใ‚คใƒซใฎใƒชใ‚นใƒˆ", + "description": "ๆทปไป˜ใƒ•ใ‚กใ‚คใƒซใฎใƒชใ‚นใƒˆ." + }, + "password": { + "type": "string", + "title": "ๅค‰ๆ›ด็”จใƒ‘ใ‚นใƒฏใƒผใƒ‰", + "description": "ๅค‰ๆ›ด็”จใƒ‘ใ‚นใƒฏใƒผใƒ‰." + } + }, + "required": [ + "writer", + "format", + "body", + "files", + "password" + ] + }, + "IBbsArticleComment.IUpdate": { + "type": "object", + "properties": { + "format": { + "oneOf": [ + { + "const": "txt" + }, + { + "const": "md" + }, + { + "const": "html" + } + ], + "title": "ๆœฌๆ–‡ใฎๅฝขๅผ", + "description": "ๆœฌๆ–‡ใฎใƒ•ใ‚ฉใƒผใƒžใƒƒใƒˆใ€‚`html`ใ€`md`ใ€`txt` ใชใฉใฎๆ‹กๅผตๅญใจๅŒใ˜ๆ„ๅ‘ณใงใ™ใ€‚." + }, + "body": { + "type": "string", + "title": "ใ‚ณใƒกใƒณใƒˆใฎๅ†…ๅฎนๆœฌๆ–‡", + "description": "ใ‚ณใƒกใƒณใƒˆใฎๅ†…ๅฎนๆœฌๆ–‡." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAttachmentFile.ICreate" + }, + "title": "ๆทปไป˜ใƒ•ใ‚กใ‚คใƒซใฎใƒชใ‚นใƒˆ", + "description": "ๆทปไป˜ใƒ•ใ‚กใ‚คใƒซใฎใƒชใ‚นใƒˆ." + }, + "password": { + "type": "string", + "title": "ๅค‰ๆ›ด็”จใƒ‘ใ‚นใƒฏใƒผใƒ‰", + "description": "ๅค‰ๆ›ด็”จใƒ‘ใ‚นใƒฏใƒผใƒ‰." + } + }, + "required": [ + "format", + "body", + "files", + "password" + ] + }, + "IBbsArticleComment.IErase": { + "type": "object", + "properties": { + "password": { + "type": "string" + } + }, + "required": [ + "password" + ] + }, + "IPerformance": { + "type": "object", + "properties": { + "cpu": { + "$ref": "#/components/schemas/process.global.NodeJS.CpuUsage" + }, + "memory": { + "$ref": "#/components/schemas/process.global.NodeJS.MemoryUsage" + }, + "resource": { + "$ref": "#/components/schemas/process.global.NodeJS.ResourceUsage" + } + }, + "required": [ + "cpu", + "memory", + "resource" + ] + }, + "process.global.NodeJS.CpuUsage": { + "type": "object", + "properties": { + "user": { + "type": "number" + }, + "system": { + "type": "number" + } + }, + "required": [ + "user", + "system" + ] + }, + "process.global.NodeJS.MemoryUsage": { + "type": "object", + "properties": { + "rss": { + "type": "number" + }, + "heapTotal": { + "type": "number" + }, + "heapUsed": { + "type": "number" + }, + "external": { + "type": "number" + }, + "arrayBuffers": { + "type": "number" + } + }, + "required": [ + "rss", + "heapTotal", + "heapUsed", + "external", + "arrayBuffers" + ] + }, + "process.global.NodeJS.ResourceUsage": { + "type": "object", + "properties": { + "fsRead": { + "type": "number" + }, + "fsWrite": { + "type": "number" + }, + "involuntaryContextSwitches": { + "type": "number" + }, + "ipcReceived": { + "type": "number" + }, + "ipcSent": { + "type": "number" + }, + "majorPageFault": { + "type": "number" + }, + "maxRSS": { + "type": "number" + }, + "minorPageFault": { + "type": "number" + }, + "sharedMemorySize": { + "type": "number" + }, + "signalsCount": { + "type": "number" + }, + "swappedOut": { + "type": "number" + }, + "systemCPUTime": { + "type": "number" + }, + "unsharedDataSize": { + "type": "number" + }, + "unsharedStackSize": { + "type": "number" + }, + "userCPUTime": { + "type": "number" + }, + "voluntaryContextSwitches": { + "type": "number" + } + }, + "required": [ + "fsRead", + "fsWrite", + "involuntaryContextSwitches", + "ipcReceived", + "ipcSent", + "majorPageFault", + "maxRSS", + "minorPageFault", + "sharedMemorySize", + "signalsCount", + "swappedOut", + "systemCPUTime", + "unsharedDataSize", + "unsharedStackSize", + "userCPUTime", + "voluntaryContextSwitches" + ] + }, + "ISystem": { + "type": "object", + "properties": { + "uid": { + "type": "number", + "title": "ใƒฉใƒณใƒ€ใƒ ใชใƒฆใƒ‹ใƒผใ‚ฏID", + "description": "ใƒฉใƒณใƒ€ใƒ ใชใƒฆใƒ‹ใƒผใ‚ฏID." + }, + "arguments": { + "type": "array", + "items": { + "type": "string" + }, + "title": "ใƒ—ใƒญใ‚ปใ‚น", + "description": "`ใƒ—ใƒญใ‚ปใ‚น.argv`" + }, + "commit": { + "$ref": "#/components/schemas/ISystem.ICommit", + "title": "Gitใ‚ณใƒŸใƒƒใƒˆๆƒ…ๅ ฑ", + "description": "Gitใ‚ณใƒŸใƒƒใƒˆๆƒ…ๅ ฑ." + }, + "package": { + "$ref": "#/components/schemas/ISystem.IPackage", + "title": "`ใƒ‘ใƒƒใ‚ฑใƒผใ‚ธ", + "description": "`package.json`" + }, + "created_at": { + "type": "string", + "title": "ใ“ใฎใ‚ตใƒผใƒใƒผใฎไฝœๆˆๆ™‚้–“", + "description": "ใ“ใฎใ‚ตใƒผใƒใƒผใฎไฝœๆˆๆ™‚้–“." + } + }, + "required": [ + "uid", + "arguments", + "commit", + "package", + "created_at" + ], + "description": "ใ‚ทใ‚นใƒ†ใƒ ๆƒ…ๅ ฑ." + }, + "ISystem.ICommit": { + "type": "object", + "properties": { + "shortHash": { + "type": "string" + }, + "branch": { + "type": "string" + }, + "hash": { + "type": "string" + }, + "subject": { + "type": "string" + }, + "sanitizedSubject": { + "type": "string" + }, + "body": { + "type": "string" + }, + "author": { + "$ref": "#/components/schemas/ISystem.ICommit.IUser" + }, + "committer": { + "$ref": "#/components/schemas/ISystem.ICommit.IUser" + }, + "authored_at": { + "type": "string" + }, + "commited_at": { + "type": "string" + }, + "notes": { + "type": "string" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "shortHash", + "branch", + "hash", + "subject", + "sanitizedSubject", + "body", + "author", + "committer", + "authored_at", + "commited_at", + "tags" + ], + "description": "Gitใ‚ณใƒŸใƒƒใƒˆๆƒ…ๅ ฑ." + }, + "ISystem.ICommit.IUser": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + }, + "required": [ + "name", + "email" + ], + "description": "Git ใƒฆใƒผใ‚ถใƒผใ‚ขใ‚ซใ‚ฆใƒณใƒˆๆƒ…ๅ ฑ." + }, + "ISystem.IPackage": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string" + }, + "description": { + "type": "string" + }, + "main": { + "type": "string" + }, + "typings": { + "type": "string" + }, + "scripts": { + "$ref": "#/components/schemas/Recordstringstring" + }, + "repository": { + "type": "object", + "properties": { + "type": { + "const": "git" + }, + "url": { + "type": "string" + } + }, + "required": [ + "type", + "url" + ] + }, + "author": { + "type": "string" + }, + "license": { + "type": "string" + }, + "bugs": { + "type": "object", + "properties": { + "url": { + "type": "string" + } + }, + "required": [ + "url" + ] + }, + "homepage": { + "type": "string" + }, + "devDependencies": { + "$ref": "#/components/schemas/Recordstringstring" + }, + "dependencies": { + "$ref": "#/components/schemas/Recordstringstring" + }, + "publishConfig": { + "type": "object", + "properties": { + "registry": { + "type": "string" + } + }, + "required": [ + "registry" + ] + }, + "files": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "name", + "version", + "description", + "scripts", + "repository", + "author", + "license", + "bugs", + "homepage", + "dependencies" + ], + "description": "NPM ใƒ‘ใƒƒใ‚ฑใƒผใ‚ธๆƒ…ๅ ฑ." + }, + "Recordstringstring": { + "type": "object", + "properties": {}, + "description": "ๅž‹Tใฎใƒ—ใƒญใƒ‘ใƒ†ใ‚ฃKใฎใ‚ปใƒƒใƒˆใ‚’ๆŒใคๅž‹ใ‚’ๆง‹็ฏ‰ใ™ใ‚‹" + } + } + }, + "x-samchon-emended": true +} \ No newline at end of file diff --git a/assets/output/bbs.swagger.ko.json b/assets/output/bbs.swagger.ko.json new file mode 100644 index 0000000..672475f --- /dev/null +++ b/assets/output/bbs.swagger.ko.json @@ -0,0 +1,1663 @@ +{ + "openapi": "3.1.0", + "servers": [ + { + "url": "http://localhost:37001", + "description": "๋กœ์ปฌ ์„œ๋ฒ„" + } + ], + "info": { + "version": "2.1.0", + "title": "@samchon/bbs-๋ฐฑ์—”๋“œ", + "description": "bbs๋ฅผ ์œ„ํ•œ ๋ฐฑ์—”๋“œ", + "license": { + "name": "MIT" + } + }, + "paths": { + "/bbs/articles": { + "patch": { + "tags": [ + "BBS" + ], + "parameters": [], + "requestBody": { + "description": "ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ ๋ฐ ๊ฒ€์ƒ‰ ์˜ต์…˜์— ๋Œ€ํ•œ ์ •๋ณด ์š”์ฒญ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticle.IRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "ํŽ˜์ด์ง€๋ณ„๋กœ ์š”์•ฝ๋œ ๊ธฐ์‚ฌ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IPageIBbsArticle.ISummary" + } + } + } + } + }, + "summary": "์š”์•ฝ๋œ ๋ชจ๋“  ๊ธฐ์‚ฌ๋ฅผ ๋‚˜์—ดํ•˜์„ธ์š”", + "description": "์š”์•ฝ๋œ ๋ชจ๋“  ๊ธฐ์‚ฌ๋ฅผ ๋‚˜์—ดํ•ฉ๋‹ˆ๋‹ค. ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ์™€ ๊ฒ€์ƒ‰ ์˜ต์…˜์„ ์‚ฌ์šฉํ•˜์—ฌ ์š”์•ฝ๋œ ๋ชจ๋“  ๊ธฐ์‚ฌ๋ฅผ ๋‚˜์—ดํ•ฉ๋‹ˆ๋‹ค.." + }, + "post": { + "tags": [ + "BBS" + ], + "parameters": [], + "requestBody": { + "description": "์ž‘์„ฑ์„ ์œ„ํ•œ ๊ธฐ์‚ฌ์ •๋ณด.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticle.ICreate" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "์ƒˆ๋กœ ์ƒ์„ฑ๋œ ๊ธฐ์‚ฌ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticle" + } + } + } + } + }, + "summary": "์ƒˆ๋กœ์šด ๊ธฐ์‚ฌ๋ฅผ ๋งŒ๋“œ์„ธ์š”", + "description": "์ƒˆ ๊ธฐ์‚ฌ๋ฅผ ๋งŒ๋“ญ๋‹ˆ๋‹ค. ์ฒซ ๋ฒˆ์งธ {@link IBbsArticle.ISnapshot ์Šค๋ƒ…์ƒท}์œผ๋กœ ์ƒˆ ๊ธฐ์‚ฌ๋ฅผ ๋งŒ๋“ญ๋‹ˆ๋‹ค.." + } + }, + "/bbs/articles/abridges": { + "patch": { + "tags": [ + "BBS" + ], + "parameters": [], + "requestBody": { + "description": "ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ ๋ฐ ๊ฒ€์ƒ‰ ์˜ต์…˜์— ๋Œ€ํ•œ ์ •๋ณด ์š”์ฒญ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticle.IRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "ํŽ˜์ด์ง€๊ฐ€ ๋งค๊ฒจ์ง„ ์š”์•ฝ ๊ธฐ์‚ฌ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IPageIBbsArticle.IAbridge" + } + } + } + } + }, + "summary": "๋ชจ๋“  ์š”์•ฝ๋œ ๊ธฐ์‚ฌ๋ฅผ ๋‚˜์—ดํ•˜์„ธ์š”", + "description": "๋ชจ๋“  ์š”์•ฝ๋œ ๊ธฐ์‚ฌ๋ฅผ ๋‚˜์—ดํ•ฉ๋‹ˆ๋‹ค. ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ์™€ ๊ฒ€์ƒ‰ ์˜ต์…˜์ด ์žˆ๋Š” ๋ชจ๋“  ์š”์•ฝ๋œ ๊ธฐ์‚ฌ๋ฅผ ๋‚˜์—ดํ•ฉ๋‹ˆ๋‹ค.." + } + }, + "/bbs/articles/{id}": { + "get": { + "tags": [ + "BBS" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "๋Œ€์ƒ ๊ธฐ์‚ฌ", + "required": true + } + ], + "responses": { + "200": { + "description": "๊ธฐ์‚ฌ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticle" + } + } + } + } + }, + "summary": "๊ฐœ๋ณ„ ๊ธฐ์‚ฌ ์ฝ๊ธฐ", + "description": "๊ฐœ๋ณ„ ๊ธฐ์‚ฌ๋ฅผ ์ฝ์Šต๋‹ˆ๋‹ค. ๋ชจ๋“  {@link IBbsArticle.ISnapshot ์Šค๋ƒ…์ƒท}์ด ์žˆ๋Š” ๊ธฐ์‚ฌ๋ฅผ ์ฝ์Šต๋‹ˆ๋‹ค.." + }, + "put": { + "tags": [ + "BBS" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "๋Œ€์ƒ ๊ธฐ์‚ฌ", + "required": true + } + ], + "requestBody": { + "description": "์—…๋ฐ์ดํŠธํ•  ๊ธฐ์‚ฌ ์ •๋ณด.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticle.IUpdate" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "์ƒˆ๋กœ ๋ˆ„์ ๋œ ์Šค๋ƒ…์ƒท ์ •๋ณด.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticle.ISnapshot" + } + } + } + } + }, + "summary": "๊ธฐ์‚ฌ ์—…๋ฐ์ดํŠธ", + "description": "๊ธฐ์‚ฌ๋ฅผ ์—…๋ฐ์ดํŠธํ•ฉ๋‹ˆ๋‹ค. ๊ธฐ์‚ฌ์— ์ƒˆ๋กœ์šด {@link IBbsArticle.ISnapshot ์Šค๋ƒ…์ƒท} ๋ ˆ์ฝ”๋“œ๋ฅผ ์ถ•์ ํ•ฉ๋‹ˆ๋‹ค.." + }, + "delete": { + "tags": [ + "BBS" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "๋Œ€์ƒ ๊ธฐ์‚ฌ", + "required": true + } + ], + "requestBody": { + "description": "ํ•ด๋‹น ๊ธฐ์‚ฌ์˜ ๋น„๋ฐ€๋ฒˆํ˜ธ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticle.IErase" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "" + } + }, + "summary": "๊ธฐ์‚ฌ๋ฅผ ์ง€์šฐ๋‹ค", + "description": "๊ธฐ์‚ฌ๋ฅผ ์ง€์›๋‹ˆ๋‹ค. ๊ธฐ์‚ฌ์— ์†Œํ”„ํŠธ ์‚ญ์ œ๋ฅผ ์ˆ˜ํ–‰ํ•ฉ๋‹ˆ๋‹ค.." + } + }, + "/bbs/articles/{articleId}/comments": { + "patch": { + "tags": [ + "BBS" + ], + "parameters": [ + { + "name": "articleId", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "", + "required": true + } + ], + "requestBody": { + "description": "ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ ๋ฐ ๊ฒ€์ƒ‰ ์˜ต์…˜์— ๋Œ€ํ•œ ์ •๋ณด ์š”์ฒญ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticleComment.IRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "ํŽ˜์ด์ง€๋ณ„๋กœ ์š”์•ฝ๋œ ๋Œ“๊ธ€.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IPageIBbsArticleComment" + } + } + } + } + }, + "summary": "์š”์•ฝ๋œ ๋ชจ๋“  ์˜๊ฒฌ์„ ๋‚˜์—ดํ•˜์„ธ์š”", + "description": "์š”์•ฝ๋œ ๋ชจ๋“  ๋Œ“๊ธ€์„ ๋‚˜์—ดํ•ฉ๋‹ˆ๋‹ค. ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ์™€ ๊ฒ€์ƒ‰ ์˜ต์…˜์„ ์‚ฌ์šฉํ•˜์—ฌ ์š”์•ฝ๋œ ๋ชจ๋“  ๋Œ“๊ธ€์„ ๋‚˜์—ดํ•ฉ๋‹ˆ๋‹ค.." + }, + "post": { + "tags": [ + "BBS" + ], + "parameters": [ + { + "name": "articleId", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "์†Œ์† ๊ธฐ์‚ฌ", + "required": true + } + ], + "requestBody": { + "description": "์ƒ์„ฑํ•˜๊ธฐ ์œ„ํ•œ ์ฝ”๋ฉ˜ํŠธ ์ •๋ณด.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticleComment.ICreate" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "์ƒˆ๋กœ ์ƒ์„ฑ๋œ ๋Œ“๊ธ€.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticleComment" + } + } + } + } + }, + "summary": "์ƒˆ๋กœ์šด ๋Œ“๊ธ€์„ ์ž‘์„ฑํ•˜์„ธ์š”", + "description": "์ƒˆ ๋Œ“๊ธ€์„ ๋งŒ๋“ญ๋‹ˆ๋‹ค. ์ฒซ ๋ฒˆ์งธ {@link IBbsArticleComment.ISnapshot ์Šค๋ƒ…์ƒท}์œผ๋กœ ์ƒˆ ๋Œ“๊ธ€์„ ๋งŒ๋“ญ๋‹ˆ๋‹ค.." + } + }, + "/bbs/articles/{articleId}/comments/{id}": { + "get": { + "tags": [ + "BBS" + ], + "parameters": [ + { + "name": "articleId", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "์†Œ์† ๊ธฐ์‚ฌ", + "required": true + }, + { + "name": "id", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "ํƒ€๊ฒŸ ์ฝ”๋ฉ˜ํŠธ", + "required": true + } + ], + "responses": { + "200": { + "description": "๋Œ“๊ธ€ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticleComment" + } + } + } + } + }, + "summary": "๊ฐœ๋ณ„ ๋Œ“๊ธ€ ์ฝ๊ธฐ", + "description": "๊ฐœ๋ณ„ ๋Œ“๊ธ€ ์ฝ๊ธฐ. ๋ชจ๋“  {@link IBbsArticleComment.ISnapshot ์Šค๋ƒ…์ƒท}๊ณผ ํ•จ๊ป˜ ๋Œ“๊ธ€์„ ์ฝ์Šต๋‹ˆ๋‹ค.." + }, + "put": { + "tags": [ + "BBS" + ], + "parameters": [ + { + "name": "articleId", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "์†Œ์† ๊ธฐ์‚ฌ", + "required": true + }, + { + "name": "id", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "ํƒ€๊ฒŸ ์ฝ”๋ฉ˜ํŠธ", + "required": true + } + ], + "requestBody": { + "description": "์—…๋ฐ์ดํŠธํ•  ์ฝ”๋ฉ˜ํŠธ ์ •๋ณด.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticleComment.IUpdate" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "์ƒˆ๋กœ ๋ˆ„์ ๋œ ์Šค๋ƒ…์ƒท ์ •๋ณด.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticleComment.ISnapshot" + } + } + } + } + }, + "summary": "๋Œ“๊ธ€ ์—…๋ฐ์ดํŠธ", + "description": "์ฃผ์„์„ ์—…๋ฐ์ดํŠธํ•ฉ๋‹ˆ๋‹ค. ์ฃผ์„์— ์ƒˆ๋กœ์šด {@link IBbsArticleComment.ISnapshot snapshot} ๋ ˆ์ฝ”๋“œ๋ฅผ ์ถ•์ ํ•ฉ๋‹ˆ๋‹ค.." + }, + "delete": { + "tags": [ + "BBS" + ], + "parameters": [ + { + "name": "articleId", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "์†Œ์† ๊ธฐ์‚ฌ", + "required": true + }, + { + "name": "id", + "in": "path", + "schema": { + "type": "string", + "format": "uuid" + }, + "description": "ํƒ€๊ฒŸ ์ฝ”๋ฉ˜ํŠธ", + "required": true + } + ], + "requestBody": { + "description": "๋Œ“๊ธ€์˜ ๋น„๋ฐ€๋ฒˆํ˜ธ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IBbsArticleComment.IErase" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "" + } + }, + "summary": "๋Œ“๊ธ€ ์ง€์šฐ๊ธฐ", + "description": "์ฃผ์„์„ ์ง€์›๋‹ˆ๋‹ค. ์ฃผ์„์— ์†Œํ”„ํŠธ ์‚ญ์ œ๋ฅผ ์ˆ˜ํ–‰ํ•ฉ๋‹ˆ๋‹ค.." + } + }, + "/monitors/health": { + "get": { + "tags": [ + "Monitor" + ], + "parameters": [], + "responses": { + "200": { + "description": "" + } + }, + "summary": "๊ฑด๊ฐ• ๊ฒ€์ง„ API", + "description": "๊ฑด๊ฐ• ๊ฒ€์ง„ API." + } + }, + "/monitors/performance": { + "get": { + "tags": [ + "Monitor" + ], + "parameters": [], + "responses": { + "200": { + "description": "์„ฑ๋Šฅ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IPerformance" + } + } + } + } + }, + "summary": "์„ฑ๋Šฅ ์ •๋ณด ์–ป๊ธฐ", + "description": "์„ฑ๋Šฅ ์ •๋ณด๋ฅผ ์–ป์œผ์„ธ์š”. CPU, ๋ฉ”๋ชจ๋ฆฌ ๋ฐ ๋ฆฌ์†Œ์Šค ์‚ฌ์šฉ๋Ÿ‰์œผ๋กœ ๊ตฌ์„ฑ๋œ ์„ฑ๋Šฅ ์ •๋ณด๋ฅผ ์–ป์œผ์„ธ์š”.." + } + }, + "/monitors/system": { + "get": { + "tags": [ + "Monitor" + ], + "parameters": [], + "responses": { + "200": { + "description": "์‹œ์Šคํ…œ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ISystem" + } + } + } + } + }, + "summary": "์‹œ์Šคํ…œ ์ •๋ณด ์–ป๊ธฐ", + "description": "์‹œ์Šคํ…œ ์ •๋ณด ๊ฐ€์ ธ์˜ค๊ธฐ. commit ๋ฐ ํŒจํ‚ค์ง€ ์ •๋ณด๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ์‹œ์Šคํ…œ ์ •๋ณด ๊ฐ€์ ธ์˜ค๊ธฐ." + } + } + }, + "components": { + "schemas": { + "IBbsArticle.IRequest": { + "type": "object", + "properties": { + "search": { + "$ref": "#/components/schemas/IBbsArticle.IRequest.ISearch", + "title": "๊ฒ€์ƒ‰ ์กฐ๊ฑด", + "description": "๊ฒ€์ƒ‰ ์กฐ๊ฑด." + }, + "sort": { + "type": "array", + "items": { + "oneOf": [ + { + "const": "-writer" + }, + { + "const": "-title" + }, + { + "const": "-created_at" + }, + { + "const": "-updated_at" + }, + { + "const": "+writer" + }, + { + "const": "+title" + }, + { + "const": "+created_at" + }, + { + "const": "+updated_at" + } + ] + }, + "title": "์ •๋ ฌ ์กฐ๊ฑด", + "description": "์ •๋ ฌ ์กฐ๊ฑด." + }, + "page": { + "type": "integer", + "title": "ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ", + "description": "ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ." + }, + "limit": { + "type": "integer", + "default": 100, + "title": "ํŽ˜์ด์ง€๋‹น ๋ ˆ์ฝ”๋“œ ์ˆ˜ ์ œํ•œ", + "description": "ํŽ˜์ด์ง€๋‹น ๋ ˆ์ฝ”๋“œ ์ˆ˜ ์ œํ•œ." + } + } + }, + "IBbsArticle.IRequest.ISearch": { + "type": "object", + "properties": { + "writer": { + "type": "string" + }, + "title": { + "type": "string" + }, + "body": { + "type": "string" + }, + "title_or_body": { + "type": "string" + }, + "from": { + "type": "string", + "format": "date-time" + }, + "to": { + "type": "string", + "format": "date-time" + } + }, + "description": "๊ฒ€์ƒ‰ ์ •๋ณด." + }, + "IPageIBbsArticle.ISummary": { + "type": "object", + "properties": { + "pagination": { + "$ref": "#/components/schemas/IPage.IPagination", + "title": "ํŽ˜์ด์ง€ ์ •๋ณด", + "description": "ํŽ˜์ด์ง€ ์ •๋ณด." + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IBbsArticle.ISummary" + }, + "title": "๊ธฐ๋ก ๋ชฉ๋ก", + "description": "๊ธฐ๋ก ๋ชฉ๋ก." + } + }, + "required": [ + "pagination", + "data" + ], + "description": "ํŽ˜์ด์ง€. ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ ์ •๋ณด๊ฐ€ ์žˆ๋Š” ๋ ˆ์ฝ”๋“œ ๋ชจ์Œ." + }, + "IPage.IPagination": { + "type": "object", + "properties": { + "current": { + "type": "integer", + "title": "ํ˜„์žฌ ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ", + "description": "ํ˜„์žฌ ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ." + }, + "limit": { + "type": "integer", + "default": 100, + "title": "ํŽ˜์ด์ง€๋‹น ๋ ˆ์ฝ”๋“œ ์ˆ˜ ์ œํ•œ", + "description": "ํŽ˜์ด์ง€๋‹น ๋ ˆ์ฝ”๋“œ ์ˆ˜ ์ œํ•œ." + }, + "records": { + "type": "integer", + "title": "๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค์˜ ์ด ๋ ˆ์ฝ”๋“œ", + "description": "๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค์˜ ์ด ๋ ˆ์ฝ”๋“œ." + }, + "pages": { + "type": "integer", + "title": "์ด ํŽ˜์ด์ง€ ์ˆ˜", + "description": "์ด ํŽ˜์ด์ง€ ์ˆ˜. ์ƒํ•œ์ด ์žˆ๋Š” {@link ๋ ˆ์ฝ”๋“œ } / {@link ์ œํ•œ }๊ณผ ๋™์ผ." + } + }, + "required": [ + "current", + "limit", + "records", + "pages" + ], + "description": "ํŽ˜์ด์ง€ ์ •๋ณด." + }, + "IBbsArticle.ISummary": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "title": "๊ธฐ๋ณธ ํ‚ค", + "description": "๊ธฐ๋ณธ ํ‚ค." + }, + "writer": { + "type": "string", + "title": "๊ธฐ์‚ฌ ์ž‘์„ฑ์ž", + "description": "๊ธฐ์‚ฌ ์ž‘์„ฑ์ž." + }, + "title": { + "type": "string", + "title": "๋งˆ์ง€๋ง‰ ์Šค๋ƒ…์ƒท์˜ ์ œ๋ชฉ", + "description": "๋งˆ์ง€๋ง‰ ์Šค๋ƒ…์ƒท์˜ ์ œ๋ชฉ." + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "๊ธฐ์‚ฌ ์ž‘์„ฑ ์‹œ๊ฐ„", + "description": "๊ธฐ์‚ฌ ์ž‘์„ฑ ์‹œ๊ฐ„." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "title": "๊ธฐ์‚ฌ ์ˆ˜์ • ์‹œ๊ฐ„", + "description": "๊ธฐ์‚ฌ์˜ ์ˆ˜์ • ์‹œ๊ฐ„. ์ฆ‰, ๋งˆ์ง€๋ง‰ ์Šค๋ƒ…์ƒท์ด ์ƒ์„ฑ๋œ ์‹œ๊ฐ„์ž…๋‹ˆ๋‹ค.." + } + }, + "required": [ + "id", + "writer", + "title", + "created_at", + "updated_at" + ], + "description": "๊ธฐ์‚ฌ์˜ ์š”์•ฝ๋œ ์ •๋ณด." + }, + "IPageIBbsArticle.IAbridge": { + "type": "object", + "properties": { + "pagination": { + "$ref": "#/components/schemas/IPage.IPagination", + "title": "ํŽ˜์ด์ง€ ์ •๋ณด", + "description": "ํŽ˜์ด์ง€ ์ •๋ณด." + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IBbsArticle.IAbridge" + }, + "title": "๊ธฐ๋ก ๋ชฉ๋ก", + "description": "๊ธฐ๋ก ๋ชฉ๋ก." + } + }, + "required": [ + "pagination", + "data" + ], + "description": "ํŽ˜์ด์ง€. ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ ์ •๋ณด๊ฐ€ ์žˆ๋Š” ๋ ˆ์ฝ”๋“œ ๋ชจ์Œ." + }, + "IBbsArticle.IAbridge": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "title": "๊ธฐ๋ณธ ํ‚ค", + "description": "๊ธฐ๋ณธ ํ‚ค." + }, + "writer": { + "type": "string", + "title": "๊ธฐ์‚ฌ ์ž‘์„ฑ์ž", + "description": "๊ธฐ์‚ฌ ์ž‘์„ฑ์ž." + }, + "title": { + "type": "string", + "title": "๋งˆ์ง€๋ง‰ ์Šค๋ƒ…์ƒท์˜ ์ œ๋ชฉ", + "description": "๋งˆ์ง€๋ง‰ ์Šค๋ƒ…์ƒท์˜ ์ œ๋ชฉ." + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "๊ธฐ์‚ฌ ์ž‘์„ฑ ์‹œ๊ฐ„", + "description": "๊ธฐ์‚ฌ ์ž‘์„ฑ ์‹œ๊ฐ„." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "title": "๊ธฐ์‚ฌ ์ˆ˜์ • ์‹œ๊ฐ„", + "description": "๊ธฐ์‚ฌ์˜ ์ˆ˜์ • ์‹œ๊ฐ„. ์ฆ‰, ๋งˆ์ง€๋ง‰ ์Šค๋ƒ…์ƒท์ด ์ƒ์„ฑ๋œ ์‹œ๊ฐ„์ž…๋‹ˆ๋‹ค.." + }, + "format": { + "$ref": "#/components/schemas/IBbsArticle.Format", + "title": "๋ณธ๋ฌธ ํ˜•์‹", + "description": "๋ณธ๋ฌธ ํ˜•์‹. `html`, `md`, `txt`์™€ ๊ฐ™์€ ํ™•์žฅ์ž์™€ ๋™์ผํ•œ ์˜๋ฏธ." + }, + "body": { + "type": "string", + "title": "๊ธฐ์‚ฌ์˜ ๋‚ด์šฉ ๋ณธ๋ฌธ", + "description": "๊ธฐ์‚ฌ์˜ ๋‚ด์šฉ ๋ณธ๋ฌธ." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAttachmentFile.ICreate" + }, + "title": "์ฒจ๋ถ€ํŒŒ์ผ ๋ชฉ๋ก", + "description": "์ฒจ๋ถ€ํŒŒ์ผ ๋ชฉ๋ก." + } + }, + "required": [ + "id", + "writer", + "title", + "created_at", + "updated_at", + "format", + "body", + "files" + ], + "description": "๊ธฐ์‚ฌ์˜ ์š”์•ฝ ์ •๋ณด." + }, + "IBbsArticle.Format": { + "oneOf": [ + { + "const": "txt" + }, + { + "const": "md" + }, + { + "const": "html" + } + ] + }, + "IAttachmentFile.ICreate": { + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 255, + "title": "ํ™•์žฅ์ž๋ฅผ ์ œ์™ธํ•œ ํŒŒ์ผ ์ด๋ฆ„", + "description": "ํ™•์žฅ์ž๋ฅผ ์ œ์™ธํ•œ ํŒŒ์ผ ์ด๋ฆ„." + }, + "extension": { + "oneOf": [ + { + "type": "string", + "maxLength": 8, + "minLength": 1 + }, + { + "type": "null" + } + ], + "title": "ํ™•๋Œ€", + "description": "ํ™•์žฅ์ž. `README`์™€ ๊ฐ™์€ ๊ฒฝ์šฐ ์ƒ๋žต ๊ฐ€๋Šฅ." + }, + "url": { + "type": "string", + "format": "uri", + "contentMediaType": "application/octet-stream", + "title": "์‹ค์ œ ํŒŒ์ผ์˜ URL ๊ฒฝ๋กœ", + "description": "์‹ค์ œ ํŒŒ์ผ์˜ URL ๊ฒฝ๋กœ." + } + }, + "required": [ + "name", + "extension", + "url" + ] + }, + "IBbsArticle": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "title": "๊ธฐ๋ณธ ํ‚ค", + "description": "๊ธฐ๋ณธ ํ‚ค.", + "x-special-description": "Sommetimes made by database automatically." + }, + "writer": { + "type": "string", + "title": "๊ธฐ์‚ฌ ์ž‘์„ฑ์ž", + "description": "๊ธฐ์‚ฌ ์ž‘์„ฑ์ž." + }, + "snapshots": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IBbsArticle.ISnapshot" + }, + "minItems": 1, + "title": "์Šค๋ƒ…์ƒท ๋‚ด์šฉ ๋ชฉ๋ก", + "description": "์Šค๋ƒ…์ƒท ๋‚ด์šฉ ๋ชฉ๋ก์ž…๋‹ˆ๋‹ค. ๊ธฐ์‚ฌ๊ฐ€ ์ƒ์„ฑ๋  ๋•Œ ์ฒ˜์Œ ์ƒ์„ฑ๋˜๋ฉฐ, ๊ธฐ์‚ฌ๊ฐ€ ์ˆ˜์ •๋  ๋•Œ๋งˆ๋‹ค ๋ˆ„์ ๋ฉ๋‹ˆ๋‹ค.." + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "๊ธฐ์‚ฌ ์ž‘์„ฑ ์‹œ๊ฐ„", + "description": "๊ธฐ์‚ฌ ์ž‘์„ฑ ์‹œ๊ฐ„." + } + }, + "required": [ + "id", + "writer", + "snapshots", + "created_at" + ], + "description": "๊ธฐ์‚ฌ ์—”ํ„ฐํ‹ฐ. `IBbsArticle*์€ ํ˜„์žฌ ๋ฐฑ์—”๋“œ ์‹œ์Šคํ…œ์—์„œ ๋ชจ๋“  ์ข…๋ฅ˜์˜ ๊ธฐ์‚ฌ์˜ ์Šˆํผ ํƒ€์ž… ์—”ํ„ฐํ‹ฐ๋กœ, ๋ฌธ์ž ๊ทธ๋Œ€๋กœ ๊ฒŒ์‹œํŒ์˜ ๊ฐœ๋ณ„ ๊ธฐ์‚ฌ๋ฅผ ํ˜•์„ฑํ•ฉ๋‹ˆ๋‹ค. ๊ทธ๋ฆฌ๊ณ  ๋ณด์‹œ๋‹ค์‹œํ”ผ, `์ œ๋ชฉ`์ด๋‚˜ `๋ณธ๋ฌธ`๊ณผ ๊ฐ™์ด ๊ธฐ์‚ฌ์— ํ•„์—ฐ์ ์œผ๋กœ ์กด์žฌํ•ด์•ผ ํ•˜๋Š” ์š”์†Œ๋Š” `IBbsArticle`์— ์กด์žฌํ•˜์ง€ ์•Š๊ณ , ํ•˜์œ„ ์—”ํ„ฐํ‹ฐ์ธ {@link IBbsArticle.ISnapshot}์— 1:N ๊ด€๊ณ„๋กœ ์กด์žฌํ•ฉ๋‹ˆ๋‹ค. ๊ทธ ์ด์œ ๋Š” ๊ธฐ์‚ฌ๊ฐ€ ์ˆ˜์ •๋  ๋•Œ๋งˆ๋‹ค ์ƒˆ๋กœ์šด ์Šค๋ƒ…์ƒท ๋ ˆ์ฝ”๋“œ๊ฐ€ ๊ฒŒ์‹œ๋˜๊ธฐ ๋•Œ๋ฌธ์ž…๋‹ˆ๋‹ค. ๊ธฐ์‚ฌ๊ฐ€ ์ˆ˜์ •๋  ๋•Œ๋งˆ๋‹ค ์ƒˆ๋กœ์šด ์Šค๋ƒ…์ƒท ๋ ˆ์ฝ”๋“œ๊ฐ€ ๊ฒŒ์‹œ๋˜๋Š” ์ด์œ ๋Š” ์ฆ๊ฑฐ๋ฅผ ๋ณด์กดํ•˜๊ธฐ ์œ„ํ•ด์„œ์ž…๋‹ˆ๋‹ค. ์ „์ž ์ปค๋ฎค๋‹ˆํ‹ฐ์˜ ํŠน์„ฑ์ƒ ์ฐธ์—ฌ์ž ๊ฐ„์—๋Š” ํ•ญ์ƒ ๋ถ„์Ÿ์˜ ์œ„ํ˜‘์ด ์žˆ์Šต๋‹ˆ๋‹ค. ๊ทธ๋ฆฌ๊ณ  ๊ธฐ์‚ฌ๋‚˜ {@link IBbsArticleComment ๋Œ“๊ธ€}์„ ํ†ตํ•ด ๋ถ„์Ÿ์ด ๋ฐœ์ƒํ•  ์ˆ˜ ์žˆ์œผ๋ฉฐ, ์ƒํ™ฉ์„ ์กฐ์ž‘ํ•˜๊ธฐ ์œ„ํ•ด ๊ธฐ์กด ๊ธฐ์‚ฌ๋ฅผ ์ˆ˜์ •ํ•˜๋Š” ๊ฒƒ๊ณผ ๊ฐ™์€ ์ผ์„ ๋ฐฉ์ง€ํ•˜๊ธฐ ์œ„ํ•ด ๊ธฐ์‚ฌ๋Š” ์ด๋Ÿฌํ•œ ๊ตฌ์กฐ๋กœ ์„ค๊ณ„๋˜์—ˆ์Šต๋‹ˆ๋‹ค. ์ฆ‰, ์ฆ๊ฑฐ๋ฅผ ๋ณด์กดํ•˜๊ณ  ์‚ฌ๊ธฐ๋ฅผ ๋ฐฉ์ง€ํ•˜๊ธฐ ์œ„ํ•ด์„œ์ž…๋‹ˆ๋‹ค.." + }, + "IBbsArticle.ISnapshot": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "title": "๊ธฐ๋ณธ ํ‚ค", + "description": "๊ธฐ๋ณธ ํ‚ค." + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "์Šค๋ƒ…์ƒท ๋ ˆ์ฝ”๋“œ ์ƒ์„ฑ ์‹œ๊ฐ„", + "description": "์Šค๋ƒ…์ƒท ๋ ˆ์ฝ”๋“œ์˜ ์ƒ์„ฑ ์‹œ๊ฐ„. ์ฆ‰, ์ƒ์„ฑ ์‹œ๊ฐ„ ๋˜๋Š” ์—…๋ฐ์ดํŠธ ์‹œ๊ฐ„ ๋˜๋Š” ๊ธฐ์‚ฌ." + }, + "format": { + "$ref": "#/components/schemas/IBbsArticle.Format", + "title": "๋ณธ๋ฌธ ํ˜•์‹", + "description": "๋ณธ๋ฌธ ํ˜•์‹. `html`, `md`, `txt`์™€ ๊ฐ™์€ ํ™•์žฅ์ž์™€ ๋™์ผํ•œ ์˜๋ฏธ." + }, + "body": { + "type": "string", + "title": "๊ธฐ์‚ฌ์˜ ๋‚ด์šฉ ๋ณธ๋ฌธ", + "description": "๊ธฐ์‚ฌ์˜ ๋‚ด์šฉ ๋ณธ๋ฌธ." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAttachmentFile.ICreate" + }, + "title": "์ฒจ๋ถ€ํŒŒ์ผ ๋ชฉ๋ก", + "description": "์ฒจ๋ถ€ํŒŒ์ผ ๋ชฉ๋ก." + }, + "title": { + "type": "string", + "title": "๊ธฐ์‚ฌ ์ œ๋ชฉ", + "description": "๊ธฐ์‚ฌ ์ œ๋ชฉ." + } + }, + "required": [ + "id", + "created_at", + "format", + "body", + "files", + "title" + ], + "description": "๊ธฐ์‚ฌ์˜ ์Šค๋ƒ…์ƒท. `IBbsArticle.ISnapshot`์€ {@link IBbsArticle}์—์„œ ์–ธ๊ธ‰๋œ ๋Œ€๋กœ ๊ธฐ์‚ฌ์˜ ๋‚ด์šฉ์„ ํฌํ•จํ•˜๋Š” ์Šค๋ƒ…์ƒท ์—”ํ„ฐํ‹ฐ์ด๋ฉฐ, ๊ธฐ์‚ฌ์˜ ๋‚ด์šฉ์€ ์ฆ๊ฑฐ๋ฅผ ๋ณด๊ด€ํ•˜๊ณ  ์‚ฌ๊ธฐ๋ฅผ ๋ฐฉ์ง€ํ•˜๊ธฐ ์œ„ํ•ด ๊ธฐ์‚ฌ ๊ธฐ๋ก๊ณผ ๋ถ„๋ฆฌ๋ฉ๋‹ˆ๋‹ค.." + }, + "IBbsArticle.ICreate": { + "type": "object", + "properties": { + "writer": { + "type": "string" + }, + "format": { + "oneOf": [ + { + "const": "txt" + }, + { + "const": "md" + }, + { + "const": "html" + } + ], + "title": "๋ณธ๋ฌธ ํ˜•์‹", + "description": "๋ณธ๋ฌธ ํ˜•์‹. `html`, `md`, `txt`์™€ ๊ฐ™์€ ํ™•์žฅ์ž์™€ ๋™์ผํ•œ ์˜๋ฏธ." + }, + "title": { + "type": "string", + "title": "๊ธฐ์‚ฌ ์ œ๋ชฉ", + "description": "๊ธฐ์‚ฌ ์ œ๋ชฉ." + }, + "body": { + "type": "string", + "title": "๊ธฐ์‚ฌ์˜ ๋‚ด์šฉ ๋ณธ๋ฌธ", + "description": "๊ธฐ์‚ฌ์˜ ๋‚ด์šฉ ๋ณธ๋ฌธ." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAttachmentFile.ICreate" + }, + "title": "์ฒจ๋ถ€ํŒŒ์ผ ๋ชฉ๋ก", + "description": "์ฒจ๋ถ€ํŒŒ์ผ ๋ชฉ๋ก." + }, + "password": { + "type": "string", + "title": "์ˆ˜์ •์„ ์œ„ํ•œ ๋น„๋ฐ€๋ฒˆํ˜ธ", + "description": "์ˆ˜์ •์„ ์œ„ํ•œ ๋น„๋ฐ€๋ฒˆํ˜ธ." + } + }, + "required": [ + "writer", + "format", + "title", + "body", + "files", + "password" + ], + "description": "๊ธฐ์‚ฌ์˜ ์ฝ˜ํ…์ธ  ์œ ํ˜•์„ ์ €์žฅํ•ฉ๋‹ˆ๋‹ค.." + }, + "IBbsArticle.IUpdate": { + "type": "object", + "properties": { + "format": { + "oneOf": [ + { + "const": "txt" + }, + { + "const": "md" + }, + { + "const": "html" + } + ], + "title": "๋ณธ๋ฌธ ํ˜•์‹", + "description": "๋ณธ๋ฌธ ํ˜•์‹. `html`, `md`, `txt`์™€ ๊ฐ™์€ ํ™•์žฅ์ž์™€ ๋™์ผํ•œ ์˜๋ฏธ." + }, + "title": { + "type": "string", + "title": "๊ธฐ์‚ฌ ์ œ๋ชฉ", + "description": "๊ธฐ์‚ฌ ์ œ๋ชฉ." + }, + "body": { + "type": "string", + "title": "๊ธฐ์‚ฌ์˜ ๋‚ด์šฉ ๋ณธ๋ฌธ", + "description": "๊ธฐ์‚ฌ์˜ ๋‚ด์šฉ ๋ณธ๋ฌธ." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAttachmentFile.ICreate" + }, + "title": "์ฒจ๋ถ€ํŒŒ์ผ ๋ชฉ๋ก", + "description": "์ฒจ๋ถ€ํŒŒ์ผ ๋ชฉ๋ก." + }, + "password": { + "type": "string", + "title": "์ˆ˜์ •์„ ์œ„ํ•œ ๋น„๋ฐ€๋ฒˆํ˜ธ", + "description": "์ˆ˜์ •์„ ์œ„ํ•œ ๋น„๋ฐ€๋ฒˆํ˜ธ." + } + }, + "required": [ + "format", + "title", + "body", + "files", + "password" + ] + }, + "IBbsArticle.IErase": { + "type": "object", + "properties": { + "password": { + "type": "string" + } + }, + "required": [ + "password" + ] + }, + "IBbsArticleComment.IRequest": { + "type": "object", + "properties": { + "search": { + "$ref": "#/components/schemas/IBbsArticleComment.IRequest.ISearch" + }, + "sort": { + "type": "array", + "items": { + "oneOf": [ + { + "const": "-writer" + }, + { + "const": "-created_at" + }, + { + "const": "+writer" + }, + { + "const": "+created_at" + } + ] + } + }, + "page": { + "type": "integer", + "title": "ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ", + "description": "ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ." + }, + "limit": { + "type": "integer", + "default": 100, + "title": "ํŽ˜์ด์ง€๋‹น ๋ ˆ์ฝ”๋“œ ์ˆ˜ ์ œํ•œ", + "description": "ํŽ˜์ด์ง€๋‹น ๋ ˆ์ฝ”๋“œ ์ˆ˜ ์ œํ•œ." + } + } + }, + "IBbsArticleComment.IRequest.ISearch": { + "type": "object", + "properties": { + "writer": { + "type": "string" + }, + "body": { + "type": "string" + } + } + }, + "IPageIBbsArticleComment": { + "type": "object", + "properties": { + "pagination": { + "$ref": "#/components/schemas/IPage.IPagination", + "title": "ํŽ˜์ด์ง€ ์ •๋ณด", + "description": "ํŽ˜์ด์ง€ ์ •๋ณด." + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IBbsArticleComment" + }, + "title": "๊ธฐ๋ก ๋ชฉ๋ก", + "description": "๊ธฐ๋ก ๋ชฉ๋ก." + } + }, + "required": [ + "pagination", + "data" + ], + "description": "ํŽ˜์ด์ง€. ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ ์ •๋ณด๊ฐ€ ์žˆ๋Š” ๋ ˆ์ฝ”๋“œ ๋ชจ์Œ." + }, + "IBbsArticleComment": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "title": "๊ธฐ๋ณธ ํ‚ค", + "description": "๊ธฐ๋ณธ ํ‚ค." + }, + "parent_id": { + "oneOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], + "title": "๋ถ€๋ชจ์˜ ๋Œ“๊ธ€ ID", + "description": "๋ถ€๋ชจ์˜ ๋Œ“๊ธ€ ID." + }, + "writer": { + "type": "string", + "title": "๋Œ“๊ธ€ ์ž‘์„ฑ์ž", + "description": "๋Œ“๊ธ€ ์ž‘์„ฑ์ž." + }, + "snapshots": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IBbsArticleComment.ISnapshot" + }, + "minItems": 1, + "title": "์Šค๋ƒ…์ƒท ๋‚ด์šฉ ๋ชฉ๋ก", + "description": "์Šค๋ƒ…์ƒท ๋‚ด์šฉ ๋ชฉ๋ก์ž…๋‹ˆ๋‹ค. ๋Œ“๊ธ€์ด ์ƒ์„ฑ๋  ๋•Œ ์ฒ˜์Œ ์ƒ์„ฑ๋˜๋ฉฐ, ๋Œ“๊ธ€์ด ์ˆ˜์ •๋  ๋•Œ๋งˆ๋‹ค ๋ˆ„์ ๋ฉ๋‹ˆ๋‹ค.." + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "๋Œ“๊ธ€ ์ž‘์„ฑ ์‹œ๊ฐ„", + "description": "๋Œ“๊ธ€ ์ž‘์„ฑ ์‹œ๊ฐ„." + } + }, + "required": [ + "id", + "parent_id", + "writer", + "snapshots", + "created_at" + ], + "description": "๊ธฐ์‚ฌ์— ์ž‘์„ฑ๋œ ๋Œ“๊ธ€. `IBbsArticleComment`๋Š” ๊ธฐ์‚ฌ์— ์ž‘์„ฑ๋œ ๋Œ“๊ธ€์„ ํ˜•์„ฑํ•˜๋Š” ์—”ํ‹ฐํ‹ฐ์ž…๋‹ˆ๋‹ค. ๊ทธ๋ฆฌ๊ณ  ์ด ๋Œ“๊ธ€์˜ ๊ฒฝ์šฐ, {@link IBbsArticle}๊ณผ {@link IBbsArticle.ISnapshot} ๊ฐ„์˜ ์ด์ „ ๊ด€๊ณ„์—์„œ์™€ ๊ฐ™์ด, ๋Œ“๊ธ€์˜ ์ฝ˜ํ…์ธ  ๋ณธ๋ฌธ์€ ์ฆ๊ฑฐ์„ฑ์„ ์œ„ํ•ด ํ•˜์œ„ {@link IBbsArticleComment.ISnapshot} ํ…Œ์ด๋ธ”์— ์ €์žฅ๋˜๊ณ , ๋Œ“๊ธ€์ด ์ˆ˜์ •๋  ๋•Œ๋งˆ๋‹ค ์ƒˆ ์Šค๋ƒ…์ƒท ๋ ˆ์ฝ”๋“œ๊ฐ€ ๋ฐœํ–‰๋ฉ๋‹ˆ๋‹ค. ๋˜ํ•œ `IBbsArticleComment`๋Š” {@link IBbsArticleComment.parent_id} ์†์„ฑ์„ ํ†ตํ•ด ๊ณ„์ธต์  ํšŒ์‹  ๊ตฌ์กฐ์˜ ๊ด€๊ณ„๋ฅผ ํ‘œํ˜„ํ•ฉ๋‹ˆ๋‹ค.." + }, + "IBbsArticleComment.ISnapshot": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "title": "๊ธฐ๋ณธ ํ‚ค", + "description": "๊ธฐ๋ณธ ํ‚ค." + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "์Šค๋ƒ…์ƒท ๋ ˆ์ฝ”๋“œ ์ƒ์„ฑ ์‹œ๊ฐ„", + "description": "์Šค๋ƒ…์ƒท ๋ ˆ์ฝ”๋“œ์˜ ์ƒ์„ฑ ์‹œ๊ฐ„. ์ฆ‰, ์ƒ์„ฑ ์‹œ๊ฐ„ ๋˜๋Š” ์—…๋ฐ์ดํŠธ ์‹œ๊ฐ„ ๋˜๋Š” ์ฃผ์„." + }, + "format": { + "$ref": "#/components/schemas/IBbsArticleComment.Format", + "title": "๋ณธ๋ฌธ ํ˜•์‹", + "description": "๋ณธ๋ฌธ ํ˜•์‹. `html`, `md`, `txt`์™€ ๊ฐ™์€ ํ™•์žฅ์ž์™€ ๋™์ผํ•œ ์˜๋ฏธ." + }, + "body": { + "type": "string", + "title": "๋Œ“๊ธ€์˜ ๋‚ด์šฉ ๋ณธ๋ฌธ", + "description": "๋Œ“๊ธ€์˜ ๋‚ด์šฉ ๋ณธ๋ฌธ." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAttachmentFile.ICreate" + }, + "title": "์ฒจ๋ถ€ํŒŒ์ผ ๋ชฉ๋ก", + "description": "์ฒจ๋ถ€ํŒŒ์ผ ๋ชฉ๋ก." + } + }, + "required": [ + "id", + "created_at", + "format", + "body", + "files" + ], + "description": "๋Œ“๊ธ€์˜ ์Šค๋ƒ…์ƒท. `IBbsArticleComment.ISnapshot`์€ ๋Œ“๊ธ€์˜ ๋‚ด์šฉ์„ ๋‹ด๊ณ  ์žˆ๋Š” ์Šค๋ƒ…์ƒท ์—”ํ‹ฐํ‹ฐ์ž…๋‹ˆ๋‹ค. {@link IBbsArticleComment }์—์„œ ์–ธ๊ธ‰ํ–ˆ๋“ฏ์ด, ์ฆ๊ฑฐ๋ฅผ ๋ณด๊ด€ํ•˜๊ณ  ์‚ฌ๊ธฐ๋ฅผ ๋ฐฉ์ง€ํ•˜๋„๋ก ์„ค๊ณ„๋˜์—ˆ์Šต๋‹ˆ๋‹ค.." + }, + "IBbsArticleComment.Format": { + "oneOf": [ + { + "const": "txt" + }, + { + "const": "md" + }, + { + "const": "html" + } + ] + }, + "IBbsArticleComment.ICreate": { + "type": "object", + "properties": { + "writer": { + "type": "string", + "title": "๋Œ“๊ธ€ ์ž‘์„ฑ์ž", + "description": "๋Œ“๊ธ€ ์ž‘์„ฑ์ž." + }, + "format": { + "oneOf": [ + { + "const": "txt" + }, + { + "const": "md" + }, + { + "const": "html" + } + ], + "title": "๋ณธ๋ฌธ ํ˜•์‹", + "description": "๋ณธ๋ฌธ ํ˜•์‹. `html`, `md`, `txt`์™€ ๊ฐ™์€ ํ™•์žฅ์ž์™€ ๋™์ผํ•œ ์˜๋ฏธ." + }, + "body": { + "type": "string", + "title": "๋Œ“๊ธ€์˜ ๋‚ด์šฉ ๋ณธ๋ฌธ", + "description": "๋Œ“๊ธ€์˜ ๋‚ด์šฉ ๋ณธ๋ฌธ." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAttachmentFile.ICreate" + }, + "title": "์ฒจ๋ถ€ํŒŒ์ผ ๋ชฉ๋ก", + "description": "์ฒจ๋ถ€ํŒŒ์ผ ๋ชฉ๋ก." + }, + "password": { + "type": "string", + "title": "์ˆ˜์ •์„ ์œ„ํ•œ ๋น„๋ฐ€๋ฒˆํ˜ธ", + "description": "์ˆ˜์ •์„ ์œ„ํ•œ ๋น„๋ฐ€๋ฒˆํ˜ธ." + } + }, + "required": [ + "writer", + "format", + "body", + "files", + "password" + ] + }, + "IBbsArticleComment.IUpdate": { + "type": "object", + "properties": { + "format": { + "oneOf": [ + { + "const": "txt" + }, + { + "const": "md" + }, + { + "const": "html" + } + ], + "title": "๋ณธ๋ฌธ ํ˜•์‹", + "description": "๋ณธ๋ฌธ ํ˜•์‹. `html`, `md`, `txt`์™€ ๊ฐ™์€ ํ™•์žฅ์ž์™€ ๋™์ผํ•œ ์˜๋ฏธ." + }, + "body": { + "type": "string", + "title": "๋Œ“๊ธ€์˜ ๋‚ด์šฉ ๋ณธ๋ฌธ", + "description": "๋Œ“๊ธ€์˜ ๋‚ด์šฉ ๋ณธ๋ฌธ." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAttachmentFile.ICreate" + }, + "title": "์ฒจ๋ถ€ํŒŒ์ผ ๋ชฉ๋ก", + "description": "์ฒจ๋ถ€ํŒŒ์ผ ๋ชฉ๋ก." + }, + "password": { + "type": "string", + "title": "์ˆ˜์ •์„ ์œ„ํ•œ ๋น„๋ฐ€๋ฒˆํ˜ธ", + "description": "์ˆ˜์ •์„ ์œ„ํ•œ ๋น„๋ฐ€๋ฒˆํ˜ธ." + } + }, + "required": [ + "format", + "body", + "files", + "password" + ] + }, + "IBbsArticleComment.IErase": { + "type": "object", + "properties": { + "password": { + "type": "string" + } + }, + "required": [ + "password" + ] + }, + "IPerformance": { + "type": "object", + "properties": { + "cpu": { + "$ref": "#/components/schemas/process.global.NodeJS.CpuUsage" + }, + "memory": { + "$ref": "#/components/schemas/process.global.NodeJS.MemoryUsage" + }, + "resource": { + "$ref": "#/components/schemas/process.global.NodeJS.ResourceUsage" + } + }, + "required": [ + "cpu", + "memory", + "resource" + ] + }, + "process.global.NodeJS.CpuUsage": { + "type": "object", + "properties": { + "user": { + "type": "number" + }, + "system": { + "type": "number" + } + }, + "required": [ + "user", + "system" + ] + }, + "process.global.NodeJS.MemoryUsage": { + "type": "object", + "properties": { + "rss": { + "type": "number" + }, + "heapTotal": { + "type": "number" + }, + "heapUsed": { + "type": "number" + }, + "external": { + "type": "number" + }, + "arrayBuffers": { + "type": "number" + } + }, + "required": [ + "rss", + "heapTotal", + "heapUsed", + "external", + "arrayBuffers" + ] + }, + "process.global.NodeJS.ResourceUsage": { + "type": "object", + "properties": { + "fsRead": { + "type": "number" + }, + "fsWrite": { + "type": "number" + }, + "involuntaryContextSwitches": { + "type": "number" + }, + "ipcReceived": { + "type": "number" + }, + "ipcSent": { + "type": "number" + }, + "majorPageFault": { + "type": "number" + }, + "maxRSS": { + "type": "number" + }, + "minorPageFault": { + "type": "number" + }, + "sharedMemorySize": { + "type": "number" + }, + "signalsCount": { + "type": "number" + }, + "swappedOut": { + "type": "number" + }, + "systemCPUTime": { + "type": "number" + }, + "unsharedDataSize": { + "type": "number" + }, + "unsharedStackSize": { + "type": "number" + }, + "userCPUTime": { + "type": "number" + }, + "voluntaryContextSwitches": { + "type": "number" + } + }, + "required": [ + "fsRead", + "fsWrite", + "involuntaryContextSwitches", + "ipcReceived", + "ipcSent", + "majorPageFault", + "maxRSS", + "minorPageFault", + "sharedMemorySize", + "signalsCount", + "swappedOut", + "systemCPUTime", + "unsharedDataSize", + "unsharedStackSize", + "userCPUTime", + "voluntaryContextSwitches" + ] + }, + "ISystem": { + "type": "object", + "properties": { + "uid": { + "type": "number", + "title": "๋ฌด์ž‘์œ„ ๊ณ ์œ  ID", + "description": "๋ฌด์ž‘์œ„ ๊ณ ์œ  ID." + }, + "arguments": { + "type": "array", + "items": { + "type": "string" + }, + "title": "`๊ณผ์ •", + "description": "`ํ”„๋กœ์„ธ์Šค.argv`" + }, + "commit": { + "$ref": "#/components/schemas/ISystem.ICommit", + "title": "Git ์ปค๋ฐ‹ ์ •๋ณด", + "description": "Git ์ปค๋ฐ‹ ์ •๋ณด." + }, + "package": { + "$ref": "#/components/schemas/ISystem.IPackage", + "title": "`ํŒจํ‚ค์ง€", + "description": "`ํŒจํ‚ค์ง€.json`" + }, + "created_at": { + "type": "string", + "title": "์ด ์„œ๋ฒ„์˜ ์ƒ์„ฑ ์‹œ๊ฐ„", + "description": "์ด ์„œ๋ฒ„์˜ ์ƒ์„ฑ ์‹œ๊ฐ„." + } + }, + "required": [ + "uid", + "arguments", + "commit", + "package", + "created_at" + ], + "description": "์‹œ์Šคํ…œ ์ •๋ณด." + }, + "ISystem.ICommit": { + "type": "object", + "properties": { + "shortHash": { + "type": "string" + }, + "branch": { + "type": "string" + }, + "hash": { + "type": "string" + }, + "subject": { + "type": "string" + }, + "sanitizedSubject": { + "type": "string" + }, + "body": { + "type": "string" + }, + "author": { + "$ref": "#/components/schemas/ISystem.ICommit.IUser" + }, + "committer": { + "$ref": "#/components/schemas/ISystem.ICommit.IUser" + }, + "authored_at": { + "type": "string" + }, + "commited_at": { + "type": "string" + }, + "notes": { + "type": "string" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "shortHash", + "branch", + "hash", + "subject", + "sanitizedSubject", + "body", + "author", + "committer", + "authored_at", + "commited_at", + "tags" + ], + "description": "Git ์ปค๋ฐ‹ ์ •๋ณด." + }, + "ISystem.ICommit.IUser": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + }, + "required": [ + "name", + "email" + ], + "description": "Git ์‚ฌ์šฉ์ž ๊ณ„์ • ์ •๋ณด." + }, + "ISystem.IPackage": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string" + }, + "description": { + "type": "string" + }, + "main": { + "type": "string" + }, + "typings": { + "type": "string" + }, + "scripts": { + "$ref": "#/components/schemas/Recordstringstring" + }, + "repository": { + "type": "object", + "properties": { + "type": { + "const": "git" + }, + "url": { + "type": "string" + } + }, + "required": [ + "type", + "url" + ] + }, + "author": { + "type": "string" + }, + "license": { + "type": "string" + }, + "bugs": { + "type": "object", + "properties": { + "url": { + "type": "string" + } + }, + "required": [ + "url" + ] + }, + "homepage": { + "type": "string" + }, + "devDependencies": { + "$ref": "#/components/schemas/Recordstringstring" + }, + "dependencies": { + "$ref": "#/components/schemas/Recordstringstring" + }, + "publishConfig": { + "type": "object", + "properties": { + "registry": { + "type": "string" + } + }, + "required": [ + "registry" + ] + }, + "files": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "name", + "version", + "description", + "scripts", + "repository", + "author", + "license", + "bugs", + "homepage", + "dependencies" + ], + "description": "NPM ํŒจํ‚ค์ง€ ์ •๋ณด." + }, + "Recordstringstring": { + "type": "object", + "properties": {}, + "description": "T ์œ ํ˜•์˜ ์†์„ฑ K ์ง‘ํ•ฉ์„ ๊ฐ–๋Š” ์œ ํ˜•์„ ๊ตฌ์„ฑํ•ฉ๋‹ˆ๋‹ค." + } + } + }, + "x-samchon-emended": true +} \ No newline at end of file diff --git a/assets/output/clickhouse.swagger.ar.json b/assets/output/clickhouse.swagger.ar.json new file mode 100644 index 0000000..e155422 --- /dev/null +++ b/assets/output/clickhouse.swagger.ar.json @@ -0,0 +1,2582 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "ู…ูˆุงุตูุงุช OpenAPI ู„ู€ ClickHouse Cloud", + "version": "1.0", + "contact": { + "name": "ClickHouse Support", + "url": "https://clickhouse.com/docs/en/cloud/manage/openapi?referrer=openapi-82913", + "email": "support@clickhouse.com" + } + }, + "servers": [ + { + "url": "https://api.clickhouse.cloud" + } + ], + "paths": { + "/v1/organizations": { + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ู‚ุงุฆู…ุฉ ุงู„ู…ู†ุธู…ุงุช ุงู„ู…ุชุงุญุฉ", + "description": "ุฅุฑุฌุงุน ู‚ุงุฆู…ุฉ ุชุญุชูˆูŠ ุนู„ู‰ ู…ู†ุธู…ุฉ ูˆุงุญุฏุฉ ู…ุฑุชุจุทุฉ ุจู…ูุชุงุญ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ููŠ ุงู„ุทู„ุจ.", + "parameters": [], + "responses": { + "200": { + "description": "ุงุณุชุฌุงุจุฉ ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Organization" + } + }, + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ูŠุชู… ุชุนูŠูŠู†ู‡ ู„ูƒู„ ุทู„ุจ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ู„ุง ูŠู…ูƒู† ู„ู„ุฎุงุฏู… ู…ุนุงู„ุฌุฉ ุงู„ุทู„ุจ ุฃูˆ ู„ู† ูŠู‚ูˆู… ุจุฐู„ูƒ ุจุณุจุจ ุดูŠุก ูŠูู†ุธุฑ ุฅู„ูŠู‡ ุนู„ู‰ ุฃู†ู‡ ุฎุทุฃ ู…ู† ุฌุงู†ุจ ุงู„ุนู…ูŠู„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 400 + }, + "error": { + "type": "string", + "description": "ูˆุตู ู…ูุตู„ ู„ู„ุฎุทุฃ." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId": { + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ุชูุงุตูŠู„ ุงู„ู…ู†ุธู…ุฉ", + "description": "ูŠุนูŠุฏ ุชูุงุตูŠู„ ู…ู†ุธู…ุฉ ูˆุงุญุฏุฉ. ู„ู„ุญุตูˆู„ ุนู„ู‰ ุงู„ุชูุงุตูŠู„ุŒ ูŠุฌุจ ุฃู† ูŠู†ุชู…ูŠ ู…ูุชุงุญ ุงู„ู…ุตุงุฏู‚ุฉ ุฅู„ู‰ ุงู„ู…ู†ุธู…ุฉ.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ู…ุนุฑู ุงู„ู…ู†ุธู…ุฉ ุงู„ู…ุทู„ูˆุจุฉ.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "ุงุณุชุฌุงุจุฉ ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Organization" + }, + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ูŠุชู… ุชุนูŠูŠู†ู‡ ู„ูƒู„ ุทู„ุจ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ู„ุง ูŠู…ูƒู† ู„ู„ุฎุงุฏู… ู…ุนุงู„ุฌุฉ ุงู„ุทู„ุจ ุฃูˆ ู„ู† ูŠู‚ูˆู… ุจุฐู„ูƒ ุจุณุจุจ ุดูŠุก ูŠูู†ุธุฑ ุฅู„ูŠู‡ ุนู„ู‰ ุฃู†ู‡ ุฎุทุฃ ู…ู† ุฌุงู†ุจ ุงู„ุนู…ูŠู„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 400 + }, + "error": { + "type": "string", + "description": "ูˆุตู ู…ูุตู„ ู„ู„ุฎุทุฃ." + } + } + } + } + } + } + } + }, + "patch": { + "summary": "ุชุญุฏูŠุซ ุชูุงุตูŠู„ ุงู„ู…ู†ุธู…ุฉ", + "description": "ุชุญุฏูŠุซ ุญู‚ูˆู„ ุงู„ู…ุคุณุณุฉ. ูŠุชุทู„ุจ ุฏูˆุฑ ู…ูุชุงุญ ู…ุตุงุฏู‚ุฉ ุงู„ู…ุณุคูˆู„.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ู…ุนุฑู ุงู„ู…ู†ุธู…ุฉ ุงู„ู…ุฑุงุฏ ุชุญุฏูŠุซู‡ุง.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrganizationPatchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "ุงุณุชุฌุงุจุฉ ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Organization" + }, + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ูŠุชู… ุชุนูŠูŠู†ู‡ ู„ูƒู„ ุทู„ุจ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ู„ุง ูŠู…ูƒู† ู„ู„ุฎุงุฏู… ู…ุนุงู„ุฌุฉ ุงู„ุทู„ุจ ุฃูˆ ู„ู† ูŠู‚ูˆู… ุจุฐู„ูƒ ุจุณุจุจ ุดูŠุก ูŠูู†ุธุฑ ุฅู„ูŠู‡ ุนู„ู‰ ุฃู†ู‡ ุฎุทุฃ ู…ู† ุฌุงู†ุจ ุงู„ุนู…ูŠู„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 400 + }, + "error": { + "type": "string", + "description": "ูˆุตู ู…ูุตู„ ู„ู„ุฎุทุฃ." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/services": { + "get": { + "summary": "ู‚ุงุฆู…ุฉ ุฎุฏู…ุงุช ุงู„ู…ู†ุธู…ุฉ", + "description": "ุฅุฑุฌุงุน ู‚ุงุฆู…ุฉ ุจุฌู…ูŠุน ุงู„ุฎุฏู…ุงุช ููŠ ุงู„ู…ุคุณุณุฉ.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ู…ุนุฑู ุงู„ู…ู†ุธู…ุฉ ุงู„ู…ุทู„ูˆุจุฉ.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "ุงุณุชุฌุงุจุฉ ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Service" + } + }, + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ูŠุชู… ุชุนูŠูŠู†ู‡ ู„ูƒู„ ุทู„ุจ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ู„ุง ูŠู…ูƒู† ู„ู„ุฎุงุฏู… ู…ุนุงู„ุฌุฉ ุงู„ุทู„ุจ ุฃูˆ ู„ู† ูŠู‚ูˆู… ุจุฐู„ูƒ ุจุณุจุจ ุดูŠุก ูŠูู†ุธุฑ ุฅู„ูŠู‡ ุนู„ู‰ ุฃู†ู‡ ุฎุทุฃ ู…ู† ุฌุงู†ุจ ุงู„ุนู…ูŠู„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 400 + }, + "error": { + "type": "string", + "description": "ูˆุตู ู…ูุตู„ ู„ู„ุฎุทุฃ." + } + } + } + } + } + } + } + }, + "post": { + "summary": "ุฅู†ุดุงุก ุฎุฏู…ุฉ ุฌุฏูŠุฏุฉ", + "description": "ูŠู†ุดุฆ ุฎุฏู…ุฉ ุฌุฏูŠุฏุฉ ููŠ ุงู„ู…ุคุณุณุฉุŒ ูˆูŠุนูŠุฏ ุญุงู„ุฉ ุงู„ุฎุฏู…ุฉ ุงู„ุญุงู„ูŠุฉ ูˆูƒู„ู…ุฉ ุงู„ู…ุฑูˆุฑ ู„ู„ูˆุตูˆู„ ุฅู„ู‰ ุงู„ุฎุฏู…ุฉ. ูŠุชู… ุจุฏุก ุชุดุบูŠู„ ุงู„ุฎุฏู…ุฉ ุจุดูƒู„ ุบูŠุฑ ู…ุชุฒุงู…ู†.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ู…ุนุฑู ุงู„ู…ู†ุธู…ุฉ ุงู„ุชูŠ ุณุชู…ุชู„ูƒ ุงู„ุฎุฏู…ุฉ.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServicePostRequest" + } + } + } + }, + "responses": { + "200": { + "description": "ุงุณุชุฌุงุจุฉ ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/ServicePostResponse" + }, + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ูŠุชู… ุชุนูŠูŠู†ู‡ ู„ูƒู„ ุทู„ุจ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ู„ุง ูŠู…ูƒู† ู„ู„ุฎุงุฏู… ู…ุนุงู„ุฌุฉ ุงู„ุทู„ุจ ุฃูˆ ู„ู† ูŠู‚ูˆู… ุจุฐู„ูƒ ุจุณุจุจ ุดูŠุก ูŠูู†ุธุฑ ุฅู„ูŠู‡ ุนู„ู‰ ุฃู†ู‡ ุฎุทุฃ ู…ู† ุฌุงู†ุจ ุงู„ุนู…ูŠู„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 400 + }, + "error": { + "type": "string", + "description": "ูˆุตู ู…ูุตู„ ู„ู„ุฎุทุฃ." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/services/:serviceId": { + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ุชูุงุตูŠู„ ุงู„ุฎุฏู…ุฉ", + "description": "ุฅุฑุฌุงุน ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชู†ุชู…ูŠ ุฅู„ู‰ ุงู„ู…ุคุณุณุฉ", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ู…ุนุฑู ุงู„ู…ู†ุธู…ุฉ ุงู„ุชูŠ ุชู…ุชู„ูƒ ุงู„ุฎุฏู…ุฉ.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service ID", + "description": "ู…ุนุฑู ุงู„ุฎุฏู…ุฉ ุงู„ู…ุทู„ูˆุจุฉ.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "ุงุณุชุฌุงุจุฉ ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Service" + }, + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ูŠุชู… ุชุนูŠูŠู†ู‡ ู„ูƒู„ ุทู„ุจ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ู„ุง ูŠู…ูƒู† ู„ู„ุฎุงุฏู… ู…ุนุงู„ุฌุฉ ุงู„ุทู„ุจ ุฃูˆ ู„ู† ูŠู‚ูˆู… ุจุฐู„ูƒ ุจุณุจุจ ุดูŠุก ูŠูู†ุธุฑ ุฅู„ูŠู‡ ุนู„ู‰ ุฃู†ู‡ ุฎุทุฃ ู…ู† ุฌุงู†ุจ ุงู„ุนู…ูŠู„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 400 + }, + "error": { + "type": "string", + "description": "ูˆุตู ู…ูุตู„ ู„ู„ุฎุทุฃ." + } + } + } + } + } + } + } + }, + "patch": { + "summary": "ุชุญุฏูŠุซ ุชูุงุตูŠู„ ุงู„ุฎุฏู…ุฉ ุงู„ุฃุณุงุณูŠุฉ.", + "description": "ุชุญุฏูŠุซ ุชูุงุตูŠู„ ุงู„ุฎุฏู…ุฉ ุงู„ุฃุณุงุณูŠุฉ ู…ุซู„ ุงุณู… ุงู„ุฎุฏู…ุฉ ุฃูˆ ู‚ุงุฆู…ุฉ ูˆุตูˆู„ IP.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ู…ุนุฑู ุงู„ู…ู†ุธู…ุฉ ุงู„ุชูŠ ุชู…ุชู„ูƒ ุงู„ุฎุฏู…ุฉ.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service ID", + "description": "ู…ุนุฑู ุงู„ุฎุฏู…ุฉ ุงู„ู…ุทู„ูˆุจ ุชุญุฏูŠุซู‡ุง.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServicePatchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "ุงุณุชุฌุงุจุฉ ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Service" + }, + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ูŠุชู… ุชุนูŠูŠู†ู‡ ู„ูƒู„ ุทู„ุจ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ู„ุง ูŠู…ูƒู† ู„ู„ุฎุงุฏู… ู…ุนุงู„ุฌุฉ ุงู„ุทู„ุจ ุฃูˆ ู„ู† ูŠู‚ูˆู… ุจุฐู„ูƒ ุจุณุจุจ ุดูŠุก ูŠูู†ุธุฑ ุฅู„ูŠู‡ ุนู„ู‰ ุฃู†ู‡ ุฎุทุฃ ู…ู† ุฌุงู†ุจ ุงู„ุนู…ูŠู„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 400 + }, + "error": { + "type": "string", + "description": "ูˆุตู ู…ูุตู„ ู„ู„ุฎุทุฃ." + } + } + } + } + } + } + } + }, + "delete": { + "summary": "ุญุฐู ุงู„ุฎุฏู…ุฉ.", + "description": "ูŠุญุฐู ุงู„ุฎุฏู…ุฉ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุฎุฏู…ุฉ ููŠ ุญุงู„ุฉ ู…ุชูˆู‚ูุฉ ูˆูŠุชู… ุญุฐูู‡ุง ุจุดูƒู„ ุบูŠุฑ ู…ุชุฒุงู…ู† ุจุนุฏ ุงุณุชุฏุนุงุก ู‡ุฐู‡ ุงู„ุทุฑูŠู‚ุฉ.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ู…ุนุฑู ุงู„ู…ู†ุธู…ุฉ ุงู„ุชูŠ ุชู…ุชู„ูƒ ุงู„ุฎุฏู…ุฉ.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service ID", + "description": "ู…ุนุฑู ุงู„ุฎุฏู…ุฉ ุงู„ู…ุฑุงุฏ ุญุฐูู‡ุง.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ] + } + }, + "/v1/organizations/:organizationId/services/:serviceId/state": { + "patch": { + "summary": "ุชุญุฏูŠุซ ุญุงู„ุฉ ุงู„ุฎุฏู…ุฉ.", + "description": "ุจุฏุก ุฃูˆ ุฅูŠู‚ุงู ุงู„ุฎุฏู…ุฉ", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ู…ุนุฑู ุงู„ู…ู†ุธู…ุฉ ุงู„ุชูŠ ุชู…ุชู„ูƒ ุงู„ุฎุฏู…ุฉ.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service ID", + "description": "ู…ุนุฑู ุงู„ุฎุฏู…ุฉ ู„ุชุญุฏูŠุซ ุงู„ุญุงู„ุฉ.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServiceStatePatchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "ุงุณุชุฌุงุจุฉ ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Service" + }, + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ูŠุชู… ุชุนูŠูŠู†ู‡ ู„ูƒู„ ุทู„ุจ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ู„ุง ูŠู…ูƒู† ู„ู„ุฎุงุฏู… ู…ุนุงู„ุฌุฉ ุงู„ุทู„ุจ ุฃูˆ ู„ู† ูŠู‚ูˆู… ุจุฐู„ูƒ ุจุณุจุจ ุดูŠุก ูŠูู†ุธุฑ ุฅู„ูŠู‡ ุนู„ู‰ ุฃู†ู‡ ุฎุทุฃ ู…ู† ุฌุงู†ุจ ุงู„ุนู…ูŠู„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 400 + }, + "error": { + "type": "string", + "description": "ูˆุตู ู…ูุตู„ ู„ู„ุฎุทุฃ." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/services/:serviceId/scaling": { + "patch": { + "summary": "ุชุญุฏูŠุซ ุฅุนุฏุงุฏุงุช ุงู„ุชูˆุณุน ุงู„ุชู„ู‚ุงุฆูŠ ู„ู„ุฎุฏู…ุฉ.", + "description": "ุชุญุฏูŠุซ ุงู„ุญุฏ ุงู„ุฃุฏู†ู‰ ูˆุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ ู„ุฅุฌู…ุงู„ูŠ ุญุฏูˆุฏ ุงู„ุฐุงูƒุฑุฉ ูˆุณู„ูˆูƒ ุงู„ุชูˆุณุน ููŠ ูˆุถุน ุงู„ุฎู…ูˆู„ ู„ู„ุฎุฏู…ุฉ. ุชุชูˆูุฑ ุฅุนุฏุงุฏุงุช ุงู„ุฐุงูƒุฑุฉ ูู‚ุท ู„ุฎุฏู…ุงุช "ุงู„ุฅู†ุชุงุฌ" ูˆูŠุฌุจ ุฃู† ุชูƒูˆู† ู…ุถุงุนูุงุช 12 ุจุฏุกู‹ุง ู…ู† 24 ุฌูŠุฌุงุจุงูŠุช.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ู…ุนุฑู ุงู„ู…ู†ุธู…ุฉ ุงู„ุชูŠ ุชู…ุชู„ูƒ ุงู„ุฎุฏู…ุฉ.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service ID", + "description": "ู…ุนุฑู ุงู„ุฎุฏู…ุฉ ู„ุชุญุฏูŠุซ ู…ุนู„ู…ุงุช ุงู„ู‚ูŠุงุณ.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServiceScalingPatchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "ุงุณุชุฌุงุจุฉ ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Service" + }, + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ูŠุชู… ุชุนูŠูŠู†ู‡ ู„ูƒู„ ุทู„ุจ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ู„ุง ูŠู…ูƒู† ู„ู„ุฎุงุฏู… ู…ุนุงู„ุฌุฉ ุงู„ุทู„ุจ ุฃูˆ ู„ู† ูŠู‚ูˆู… ุจุฐู„ูƒ ุจุณุจุจ ุดูŠุก ูŠูู†ุธุฑ ุฅู„ูŠู‡ ุนู„ู‰ ุฃู†ู‡ ุฎุทุฃ ู…ู† ุฌุงู†ุจ ุงู„ุนู…ูŠู„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 400 + }, + "error": { + "type": "string", + "description": "ูˆุตู ู…ูุตู„ ู„ู„ุฎุทุฃ." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/services/:serviceId/password": { + "patch": { + "summary": "ุชุญุฏูŠุซ ูƒู„ู…ุฉ ู…ุฑูˆุฑ ุงู„ุฎุฏู…ุฉ.", + "description": "ุชุนูŠูŠู† ูƒู„ู…ุฉ ู…ุฑูˆุฑ ุฌุฏูŠุฏุฉ ู„ู„ุฎุฏู…ุฉ", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ู…ุนุฑู ุงู„ู…ู†ุธู…ุฉ ุงู„ุชูŠ ุชู…ุชู„ูƒ ุงู„ุฎุฏู…ุฉ.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service ID", + "description": "ู…ุนุฑู ุงู„ุฎุฏู…ุฉ ู„ุชุญุฏูŠุซ ูƒู„ู…ุฉ ุงู„ู…ุฑูˆุฑ.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServicePasswordPatchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "ุงุณุชุฌุงุจุฉ ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/ServicePasswordPatchResponse" + }, + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ูŠุชู… ุชุนูŠูŠู†ู‡ ู„ูƒู„ ุทู„ุจ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ู„ุง ูŠู…ูƒู† ู„ู„ุฎุงุฏู… ู…ุนุงู„ุฌุฉ ุงู„ุทู„ุจ ุฃูˆ ู„ู† ูŠู‚ูˆู… ุจุฐู„ูƒ ุจุณุจุจ ุดูŠุก ูŠูู†ุธุฑ ุฅู„ูŠู‡ ุนู„ู‰ ุฃู†ู‡ ุฎุทุฃ ู…ู† ุฌุงู†ุจ ุงู„ุนู…ูŠู„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 400 + }, + "error": { + "type": "string", + "description": "ูˆุตู ู…ูุตู„ ู„ู„ุฎุทุฃ." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/services/:serviceId/backups": { + "get": { + "summary": "ู‚ุงุฆู…ุฉ ุงู„ู†ุณุฎ ุงู„ุงุญุชูŠุงุทูŠุฉ ู„ู„ุฎุฏู…ุฉ", + "description": "ุฅุฑุฌุงุน ู‚ุงุฆู…ุฉ ุจุฌู…ูŠุน ุงู„ู†ุณุฎ ุงู„ุงุญุชูŠุงุทูŠุฉ ู„ู„ุฎุฏู…ุฉ.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ู…ุนุฑู ุงู„ู…ู†ุธู…ุฉ ุงู„ุชูŠ ุชู…ุชู„ูƒ ุงู„ู†ุณุฎุฉ ุงู„ุงุญุชูŠุงุทูŠุฉ.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service ID", + "description": "ู…ุนุฑู ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชู… ุฅู†ุดุงุก ุงู„ู†ุณุฎุฉ ุงู„ุงุญุชูŠุงุทูŠุฉ ู…ู†ู‡ุง.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "ุงุณุชุฌุงุจุฉ ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Backup" + } + }, + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ูŠุชู… ุชุนูŠูŠู†ู‡ ู„ูƒู„ ุทู„ุจ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ู„ุง ูŠู…ูƒู† ู„ู„ุฎุงุฏู… ู…ุนุงู„ุฌุฉ ุงู„ุทู„ุจ ุฃูˆ ู„ู† ูŠู‚ูˆู… ุจุฐู„ูƒ ุจุณุจุจ ุดูŠุก ูŠูู†ุธุฑ ุฅู„ูŠู‡ ุนู„ู‰ ุฃู†ู‡ ุฎุทุฃ ู…ู† ุฌุงู†ุจ ุงู„ุนู…ูŠู„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 400 + }, + "error": { + "type": "string", + "description": "ูˆุตู ู…ูุตู„ ู„ู„ุฎุทุฃ." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/services/:serviceId/backups/:backupId": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุชูุงุตูŠู„ ุงู„ู†ุณุฎ ุงู„ุงุญุชูŠุงุทูŠ", + "description": "ุฅุฑุฌุงุน ู…ุนู„ูˆู…ุงุช ุงู„ู†ุณุฎ ุงู„ุงุญุชูŠุงุทูŠ ุงู„ูุฑุฏูŠุฉ.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ู…ุนุฑู ุงู„ู…ู†ุธู…ุฉ ุงู„ุชูŠ ุชู…ุชู„ูƒ ุงู„ู†ุณุฎุฉ ุงู„ุงุญุชูŠุงุทูŠุฉ.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service ID", + "description": "ู…ุนุฑู ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชู… ุฅู†ุดุงุก ุงู„ู†ุณุฎุฉ ุงู„ุงุญุชูŠุงุทูŠุฉ ู…ู†ู‡ุง.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service backup ID", + "description": "ู…ุนุฑู ุงู„ู†ุณุฎุฉ ุงู„ุงุญุชูŠุงุทูŠุฉ ุงู„ู…ุทู„ูˆุจุฉ.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "ุงุณุชุฌุงุจุฉ ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Backup" + }, + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ูŠุชู… ุชุนูŠูŠู†ู‡ ู„ูƒู„ ุทู„ุจ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ู„ุง ูŠู…ูƒู† ู„ู„ุฎุงุฏู… ู…ุนุงู„ุฌุฉ ุงู„ุทู„ุจ ุฃูˆ ู„ู† ูŠู‚ูˆู… ุจุฐู„ูƒ ุจุณุจุจ ุดูŠุก ูŠูู†ุธุฑ ุฅู„ูŠู‡ ุนู„ู‰ ุฃู†ู‡ ุฎุทุฃ ู…ู† ุฌุงู†ุจ ุงู„ุนู…ูŠู„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 400 + }, + "error": { + "type": "string", + "description": "ูˆุตู ู…ูุตู„ ู„ู„ุฎุทุฃ." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/keys": { + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ู‚ุงุฆู…ุฉ ุจุฌู…ูŠุน ุงู„ู…ูุงุชูŠุญ", + "description": "ุฅุฑุฌุงุน ู‚ุงุฆู…ุฉ ุจุฌู…ูŠุน ุงู„ู…ูุงุชูŠุญ ุงู„ู…ูˆุฌูˆุฏุฉ ููŠ ุงู„ู…ุคุณุณุฉ.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ู…ุนุฑู ุงู„ู…ู†ุธู…ุฉ ุงู„ู…ุทู„ูˆุจุฉ.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "ุงุณุชุฌุงุจุฉ ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApiKey" + } + }, + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ูŠุชู… ุชุนูŠูŠู†ู‡ ู„ูƒู„ ุทู„ุจ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ู„ุง ูŠู…ูƒู† ู„ู„ุฎุงุฏู… ู…ุนุงู„ุฌุฉ ุงู„ุทู„ุจ ุฃูˆ ู„ู† ูŠู‚ูˆู… ุจุฐู„ูƒ ุจุณุจุจ ุดูŠุก ูŠูู†ุธุฑ ุฅู„ูŠู‡ ุนู„ู‰ ุฃู†ู‡ ุฎุทุฃ ู…ู† ุฌุงู†ุจ ุงู„ุนู…ูŠู„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 400 + }, + "error": { + "type": "string", + "description": "ูˆุตู ู…ูุตู„ ู„ู„ุฎุทุฃ." + } + } + } + } + } + } + } + }, + "post": { + "summary": "ุฅู†ุดุงุก ู…ูุชุงุญ", + "description": "ุฅู†ุดุงุก ู…ูุชุงุญ API ุฌุฏูŠุฏ.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ู…ุนุฑู ุงู„ู…ู†ุธู…ุฉ ุงู„ุชูŠ ุณุชู…ุชู„ูƒ ุงู„ู…ูุชุงุญ.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiKeyPostRequest" + } + } + } + }, + "responses": { + "200": { + "description": "ุงุณุชุฌุงุจุฉ ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/ApiKeyPostResponse" + }, + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ูŠุชู… ุชุนูŠูŠู†ู‡ ู„ูƒู„ ุทู„ุจ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ู„ุง ูŠู…ูƒู† ู„ู„ุฎุงุฏู… ู…ุนุงู„ุฌุฉ ุงู„ุทู„ุจ ุฃูˆ ู„ู† ูŠู‚ูˆู… ุจุฐู„ูƒ ุจุณุจุจ ุดูŠุก ูŠูู†ุธุฑ ุฅู„ูŠู‡ ุนู„ู‰ ุฃู†ู‡ ุฎุทุฃ ู…ู† ุฌุงู†ุจ ุงู„ุนู…ูŠู„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 400 + }, + "error": { + "type": "string", + "description": "ูˆุตู ู…ูุตู„ ู„ู„ุฎุทุฃ." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/keys/:keyId": { + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ุงู„ุชูุงุตูŠู„ ุงู„ุฑุฆูŠุณูŠุฉ", + "description": "ุฅุฑุฌุงุน ุชูุงุตูŠู„ ู…ูุชุงุญ ูˆุงุญุฏ.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ู…ุนุฑู ุงู„ู…ู†ุธู…ุฉ ุงู„ู…ุทู„ูˆุจุฉ.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "API key ID", + "description": "ู…ุนุฑู ุงู„ู…ูุชุงุญ ุงู„ู…ุทู„ูˆุจ.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "ุงุณุชุฌุงุจุฉ ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/ApiKey" + }, + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ูŠุชู… ุชุนูŠูŠู†ู‡ ู„ูƒู„ ุทู„ุจ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ู„ุง ูŠู…ูƒู† ู„ู„ุฎุงุฏู… ู…ุนุงู„ุฌุฉ ุงู„ุทู„ุจ ุฃูˆ ู„ู† ูŠู‚ูˆู… ุจุฐู„ูƒ ุจุณุจุจ ุดูŠุก ูŠูู†ุธุฑ ุฅู„ูŠู‡ ุนู„ู‰ ุฃู†ู‡ ุฎุทุฃ ู…ู† ุฌุงู†ุจ ุงู„ุนู…ูŠู„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 400 + }, + "error": { + "type": "string", + "description": "ูˆุตู ู…ูุตู„ ู„ู„ุฎุทุฃ." + } + } + } + } + } + } + } + }, + "patch": { + "summary": "ู…ูุชุงุญ ุงู„ุชุญุฏูŠุซ", + "description": "ุชุญุฏูŠุซ ุฎุตุงุฆุต ู…ูุชุงุญ API.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ู…ุนุฑู ุงู„ู…ู†ุธู…ุฉ ุงู„ุชูŠ ุชู…ุชู„ูƒ ุงู„ู…ูุชุงุญ.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "API key ID", + "description": "ู…ุนุฑู ุงู„ู…ูุชุงุญ ุงู„ู…ุฑุงุฏ ุชุญุฏูŠุซู‡.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiKeyPatchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "ุงุณุชุฌุงุจุฉ ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/ApiKey" + }, + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ูŠุชู… ุชุนูŠูŠู†ู‡ ู„ูƒู„ ุทู„ุจ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ู„ุง ูŠู…ูƒู† ู„ู„ุฎุงุฏู… ู…ุนุงู„ุฌุฉ ุงู„ุทู„ุจ ุฃูˆ ู„ู† ูŠู‚ูˆู… ุจุฐู„ูƒ ุจุณุจุจ ุดูŠุก ูŠูู†ุธุฑ ุฅู„ูŠู‡ ุนู„ู‰ ุฃู†ู‡ ุฎุทุฃ ู…ู† ุฌุงู†ุจ ุงู„ุนู…ูŠู„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 400 + }, + "error": { + "type": "string", + "description": "ูˆุตู ู…ูุตู„ ู„ู„ุฎุทุฃ." + } + } + } + } + } + } + } + }, + "delete": { + "summary": "ุญุฐู ุงู„ู…ูุชุงุญ", + "description": "ูŠุญุฐู ู…ูุชุงุญ API. ู„ุง ูŠู…ูƒู† ุญุฐู ุณูˆู‰ ุงู„ู…ูุชุงุญ ุบูŠุฑ ุงู„ู…ุณุชุฎุฏู… ู„ู…ุตุงุฏู‚ุฉ ุงู„ุทู„ุจ ุงู„ู†ุดุท.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ู…ุนุฑู ุงู„ู…ู†ุธู…ุฉ ุงู„ุชูŠ ุชู…ุชู„ูƒ ุงู„ู…ูุชุงุญ.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "API key ID", + "description": "ู…ุนุฑู ุงู„ู…ูุชุงุญ ุงู„ุฐูŠ ุณูŠุชู… ุญุฐูู‡.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ] + } + }, + "/v1/organizations/:organizationId/members": { + "get": { + "summary": "ู‚ุงุฆู…ุฉ ุฃุนุถุงุก ุงู„ู…ู†ุธู…ุฉ", + "description": "ุฅุฑุฌุงุน ู‚ุงุฆู…ุฉ ุจุฌู…ูŠุน ุงู„ุฃุนุถุงุก ููŠ ุงู„ู…ุคุณุณุฉ.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ู…ุนุฑู ุงู„ู…ู†ุธู…ุฉ ุงู„ู…ุทู„ูˆุจุฉ.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "ุงุณุชุฌุงุจุฉ ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Member" + } + }, + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ูŠุชู… ุชุนูŠูŠู†ู‡ ู„ูƒู„ ุทู„ุจ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ู„ุง ูŠู…ูƒู† ู„ู„ุฎุงุฏู… ู…ุนุงู„ุฌุฉ ุงู„ุทู„ุจ ุฃูˆ ู„ู† ูŠู‚ูˆู… ุจุฐู„ูƒ ุจุณุจุจ ุดูŠุก ูŠูู†ุธุฑ ุฅู„ูŠู‡ ุนู„ู‰ ุฃู†ู‡ ุฎุทุฃ ู…ู† ุฌุงู†ุจ ุงู„ุนู…ูŠู„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 400 + }, + "error": { + "type": "string", + "description": "ูˆุตู ู…ูุตู„ ู„ู„ุฎุทุฃ." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/members/:userId": { + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ุชูุงุตูŠู„ ุงู„ุนุถูˆูŠุฉ", + "description": "ุฅุฑุฌุงุน ุชูุงุตูŠู„ ุนุถูˆ ู…ู†ุธู…ุฉ ูˆุงุญุฏุฉ.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ู…ุนุฑู ุงู„ู…ู†ุธู…ุฉ ุงู„ุชูŠ ูŠู†ุชู…ูŠ ุฅู„ูŠู‡ุง ุงู„ุนุถูˆ.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "User ID", + "description": "ู…ุนุฑู ุงู„ู…ุณุชุฎุฏู… ุงู„ู…ุทู„ูˆุจ.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "ุงุณุชุฌุงุจุฉ ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Member" + }, + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ูŠุชู… ุชุนูŠูŠู†ู‡ ู„ูƒู„ ุทู„ุจ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ู„ุง ูŠู…ูƒู† ู„ู„ุฎุงุฏู… ู…ุนุงู„ุฌุฉ ุงู„ุทู„ุจ ุฃูˆ ู„ู† ูŠู‚ูˆู… ุจุฐู„ูƒ ุจุณุจุจ ุดูŠุก ูŠูู†ุธุฑ ุฅู„ูŠู‡ ุนู„ู‰ ุฃู†ู‡ ุฎุทุฃ ู…ู† ุฌุงู†ุจ ุงู„ุนู…ูŠู„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 400 + }, + "error": { + "type": "string", + "description": "ูˆุตู ู…ูุตู„ ู„ู„ุฎุทุฃ." + } + } + } + } + } + } + } + }, + "patch": { + "summary": "ุชุญุฏูŠุซ ุนุถูˆ ุงู„ู…ู†ุธู…ุฉ.", + "description": "ุชุญุฏูŠุซ ุฏูˆุฑ ุนุถูˆ ุงู„ู…ู†ุธู…ุฉ.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ู…ุนุฑู ุงู„ู…ู†ุธู…ุฉ ุงู„ุชูŠ ูŠู†ุชู…ูŠ ุฅู„ูŠู‡ุง ุงู„ุนุถูˆ.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "User ID", + "description": "ู…ุนุฑู ุงู„ู…ุณุชุฎุฏู… ุงู„ู…ุฑุงุฏ ุชุตุญูŠุญู‡", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MemberPatchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "ุงุณุชุฌุงุจุฉ ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Member" + }, + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ูŠุชู… ุชุนูŠูŠู†ู‡ ู„ูƒู„ ุทู„ุจ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ู„ุง ูŠู…ูƒู† ู„ู„ุฎุงุฏู… ู…ุนุงู„ุฌุฉ ุงู„ุทู„ุจ ุฃูˆ ู„ู† ูŠู‚ูˆู… ุจุฐู„ูƒ ุจุณุจุจ ุดูŠุก ูŠูู†ุธุฑ ุฅู„ูŠู‡ ุนู„ู‰ ุฃู†ู‡ ุฎุทุฃ ู…ู† ุฌุงู†ุจ ุงู„ุนู…ูŠู„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 400 + }, + "error": { + "type": "string", + "description": "ูˆุตู ู…ูุตู„ ู„ู„ุฎุทุฃ." + } + } + } + } + } + } + } + }, + "delete": { + "summary": "ุฅุฒุงู„ุฉ ุนุถูˆ ุงู„ู…ู†ุธู…ุฉ", + "description": "ุฅุฒุงู„ุฉ ู…ุณุชุฎุฏู… ู…ู† ุงู„ู…ุคุณุณุฉ", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ู…ุนุฑู ุงู„ู…ู†ุธู…ุฉ ุงู„ู…ุทู„ูˆุจุฉ.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "User ID", + "description": "ู…ุนุฑู ุงู„ู…ุณุชุฎุฏู… ุงู„ู…ุทู„ูˆุจ.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ] + } + }, + "/v1/organizations/:organizationId/invitations": { + "get": { + "summary": "ู‚ุงุฆู…ุฉ ุฌู…ูŠุน ุงู„ุฏุนูˆุงุช", + "description": "ุฅุฑุฌุงุน ู‚ุงุฆู…ุฉ ุจุฌู…ูŠุน ุฏุนูˆุงุช ุงู„ู…ู†ุธู…ุฉ.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ู…ุนุฑู ุงู„ู…ู†ุธู…ุฉ ุงู„ู…ุทู„ูˆุจุฉ.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "ุงุณุชุฌุงุจุฉ ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Invitation" + } + }, + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ูŠุชู… ุชุนูŠูŠู†ู‡ ู„ูƒู„ ุทู„ุจ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ู„ุง ูŠู…ูƒู† ู„ู„ุฎุงุฏู… ู…ุนุงู„ุฌุฉ ุงู„ุทู„ุจ ุฃูˆ ู„ู† ูŠู‚ูˆู… ุจุฐู„ูƒ ุจุณุจุจ ุดูŠุก ูŠูู†ุธุฑ ุฅู„ูŠู‡ ุนู„ู‰ ุฃู†ู‡ ุฎุทุฃ ู…ู† ุฌุงู†ุจ ุงู„ุนู…ูŠู„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 400 + }, + "error": { + "type": "string", + "description": "ูˆุตู ู…ูุตู„ ู„ู„ุฎุทุฃ." + } + } + } + } + } + } + } + }, + "post": { + "summary": "ุฅู†ุดุงุก ุฏุนูˆุฉ", + "description": "ุฅู†ุดุงุก ุฏุนูˆุฉ ู„ู„ู…ู†ุธู…ุฉ.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ู…ุนุฑู ุงู„ู…ู†ุธู…ุฉ ุงู„ุชูŠ ุณูŠุชู… ุฏุนูˆุฉ ุงู„ู…ุณุชุฎุฏู… ุฅู„ูŠู‡ุง.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InvitationPostRequest" + } + } + } + }, + "responses": { + "200": { + "description": "ุงุณุชุฌุงุจุฉ ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Invitation" + }, + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ูŠุชู… ุชุนูŠูŠู†ู‡ ู„ูƒู„ ุทู„ุจ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ู„ุง ูŠู…ูƒู† ู„ู„ุฎุงุฏู… ู…ุนุงู„ุฌุฉ ุงู„ุทู„ุจ ุฃูˆ ู„ู† ูŠู‚ูˆู… ุจุฐู„ูƒ ุจุณุจุจ ุดูŠุก ูŠูู†ุธุฑ ุฅู„ูŠู‡ ุนู„ู‰ ุฃู†ู‡ ุฎุทุฃ ู…ู† ุฌุงู†ุจ ุงู„ุนู…ูŠู„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 400 + }, + "error": { + "type": "string", + "description": "ูˆุตู ู…ูุตู„ ู„ู„ุฎุทุฃ." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/invitations/:invitationId": { + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ุชูุงุตูŠู„ ุงู„ุฏุนูˆุฉ", + "description": "ุฅุฑุฌุงุน ุชูุงุตูŠู„ ุฏุนูˆุฉ ู…ู†ุธู…ุฉ ูˆุงุญุฏุฉ.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ู…ุนุฑู ุงู„ู…ู†ุธู…ุฉ ุงู„ู…ุทู„ูˆุจุฉ.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Organization invitation ID", + "description": "ู…ุนุฑู ุงู„ู…ู†ุธู…ุฉ ุงู„ู…ุทู„ูˆุจุฉ.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "ุงุณุชุฌุงุจุฉ ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Invitation" + }, + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ูŠุชู… ุชุนูŠูŠู†ู‡ ู„ูƒู„ ุทู„ุจ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ู„ุง ูŠู…ูƒู† ู„ู„ุฎุงุฏู… ู…ุนุงู„ุฌุฉ ุงู„ุทู„ุจ ุฃูˆ ู„ู† ูŠู‚ูˆู… ุจุฐู„ูƒ ุจุณุจุจ ุดูŠุก ูŠูู†ุธุฑ ุฅู„ูŠู‡ ุนู„ู‰ ุฃู†ู‡ ุฎุทุฃ ู…ู† ุฌุงู†ุจ ุงู„ุนู…ูŠู„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 400 + }, + "error": { + "type": "string", + "description": "ูˆุตู ู…ูุตู„ ู„ู„ุฎุทุฃ." + } + } + } + } + } + } + } + }, + "delete": { + "summary": "ุญุฐู ุฏุนูˆุฉ ุงู„ู…ู†ุธู…ุฉ", + "description": "ุญุฐู ุฏุนูˆุฉ ู…ู†ุธู…ุฉ ูˆุงุญุฏุฉ.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ู…ุนุฑู ุงู„ู…ู†ุธู…ุฉ ุงู„ุชูŠ ู„ุฏูŠู‡ุง ุงู„ุฏุนูˆุฉ.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Organization invitation ID", + "description": "ู…ุนุฑู ุงู„ู…ู†ุธู…ุฉ ุงู„ู…ุทู„ูˆุจุฉ.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ] + } + }, + "/v1/organizations/:organizationId/activities": { + "get": { + "summary": "ู‚ุงุฆู…ุฉ ุฃู†ุดุทุฉ ุงู„ู…ู†ุธู…ุฉ", + "description": "ุฅุฑุฌุงุน ู‚ุงุฆู…ุฉ ุจุฌู…ูŠุน ุฃู†ุดุทุฉ ุงู„ู…ู†ุธู…ุฉ.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ู…ุนุฑู ุงู„ู…ู†ุธู…ุฉ ุงู„ู…ุทู„ูˆุจุฉ.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "ุงุณุชุฌุงุจุฉ ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Activity" + } + }, + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ูŠุชู… ุชุนูŠูŠู†ู‡ ู„ูƒู„ ุทู„ุจ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ู„ุง ูŠู…ูƒู† ู„ู„ุฎุงุฏู… ู…ุนุงู„ุฌุฉ ุงู„ุทู„ุจ ุฃูˆ ู„ู† ูŠู‚ูˆู… ุจุฐู„ูƒ ุจุณุจุจ ุดูŠุก ูŠูู†ุธุฑ ุฅู„ูŠู‡ ุนู„ู‰ ุฃู†ู‡ ุฎุทุฃ ู…ู† ุฌุงู†ุจ ุงู„ุนู…ูŠู„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 400 + }, + "error": { + "type": "string", + "description": "ูˆุตู ู…ูุตู„ ู„ู„ุฎุทุฃ." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/activities/:activityId": { + "get": { + "summary": "ู†ุดุงุท ุงู„ู…ู†ุธู…ุฉ", + "description": "ุฅุฑุฌุงุน ู†ุดุงุท ู…ู†ุธู…ุฉ ูˆุงุญุฏุฉ ุญุณุจ ุงู„ู…ุนุฑู.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ู…ุนุฑู ุงู„ู…ู†ุธู…ุฉ ุงู„ู…ุทู„ูˆุจุฉ.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Activity ID", + "description": "ู…ุนุฑู ุงู„ู†ุดุงุท ุงู„ู…ุทู„ูˆุจ.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "ุงุณุชุฌุงุจุฉ ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Activity" + }, + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ูŠุชู… ุชุนูŠูŠู†ู‡ ู„ูƒู„ ุทู„ุจ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ู„ุง ูŠู…ูƒู† ู„ู„ุฎุงุฏู… ู…ุนุงู„ุฌุฉ ุงู„ุทู„ุจ ุฃูˆ ู„ู† ูŠู‚ูˆู… ุจุฐู„ูƒ ุจุณุจุจ ุดูŠุก ูŠูู†ุธุฑ ุฅู„ูŠู‡ ุนู„ู‰ ุฃู†ู‡ ุฎุทุฃ ู…ู† ุฌุงู†ุจ ุงู„ุนู…ูŠู„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "ุฑู…ุฒ ุญุงู„ุฉ HTTP.", + "example": 400 + }, + "error": { + "type": "string", + "description": "ูˆุตู ู…ูุตู„ ู„ู„ุฎุทุฃ." + } + } + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "ServiceEndpoint": { + "properties": { + "protocol": { + "type": "string", + "description": "ุจุฑูˆุชูˆูƒูˆู„ ู†ู‚ุทุฉ ุงู„ู†ู‡ุงูŠุฉ: 'https'ุŒ 'nativesecure'ุŒ 'mysql'.", + "enum": [ + "https", + "nativesecure", + "mysql" + ] + }, + "host": { + "type": "string", + "description": "ุงุณู… ู…ุถูŠู ุงู„ุฎุฏู…ุฉ" + }, + "port": { + "type": "number", + "description": "ู…ู†ูุฐ ุฑู‚ู…ูŠ" + } + } + }, + "IpAccessListEntry": { + "properties": { + "source": { + "type": "string", + "description": "IP ุฃูˆ CIDR" + }, + "description": { + "type": "string", + "description": "ุนู†ูˆุงู† IPv4 ุฃูˆ IPv4 CIDR ู„ู„ุณู…ุงุญ ุจุงู„ูˆุตูˆู„ ู…ู†" + } + } + }, + "Service": { + "properties": { + "id": { + "type": "string", + "description": "ู…ุนุฑู ุงู„ุฎุฏู…ุฉ ุงู„ูุฑูŠุฏ.", + "format": "uuid" + }, + "name": { + "type": "string", + "description": "ุงุณู… ุงู„ุฎุฏู…ุฉ." + }, + "provider": { + "type": "string", + "description": "ู…ุฒูˆุฏ ุงู„ุฎุฏู…ุฉ ุงู„ุณุญุงุจูŠุฉ", + "enum": [ + "aws", + "gcp" + ] + }, + "region": { + "type": "string", + "description": "ู…ู†ุทู‚ุฉ ุงู„ุฎุฏู…ุฉ.", + "enum": [ + "ap-south-1", + "ap-southeast-1", + "eu-central-1", + "eu-west-1", + "us-east-1", + "us-east-2", + "us-west-2", + "ap-southeast-2", + "us-east1", + "us-central1", + "europe-west4", + "asia-southeast1" + ] + }, + "state": { + "type": "string", + "description": "ุงู„ุญุงู„ุฉ ุงู„ุญุงู„ูŠุฉ ู„ู„ุฎุฏู…ุฉ.", + "enum": [ + "starting", + "stopping", + "terminating", + "provisioning", + "running", + "stopped", + "terminated", + "degraded", + "failed", + "idle" + ] + }, + "endpoints": { + "type": "array", + "description": "ู‚ุงุฆู…ุฉ ุจุฌู…ูŠุน ู†ู‚ุงุท ู†ู‡ุงูŠุฉ ุงู„ุฎุฏู…ุฉ.", + "items": { + "$ref": "#/components/schemas/ServiceEndpoint" + } + }, + "tier": { + "type": "string", + "description": "ู…ุณุชูˆู‰ ุงู„ุฎุฏู…ุฉ: "ุงู„ุชุทูˆูŠุฑ"ุŒ "ุงู„ุฅู†ุชุงุฌ"ุŒ "ุงู„ุฐุงูƒุฑุฉ ุงู„ู…ุฎุตุตุฉ ุนุงู„ูŠุฉ ุงู„ุฃุฏุงุก"ุŒ "ูˆุญุฏุฉ ุงู„ู…ุนุงู„ุฌุฉ ุงู„ู…ุฑูƒุฒูŠุฉ ุงู„ู…ุฎุตุตุฉ ุนุงู„ูŠุฉ ุงู„ุฃุฏุงุก"ุŒ "ุงู„ู…ุนูŠุงุฑ ุงู„ู…ุฎุตุต". ุญุฌู… ุฎุฏู…ุงุช ุงู„ุฅู†ุชุงุฌ ูˆุงู„ุชุทูˆูŠุฑ ุซุงุจุช.", + "enum": [ + "development", + "production", + "dedicated_high_mem", + "dedicated_high_cpu", + "dedicated_standard" + ] + }, + "minTotalMemoryGb": { + "type": "number", + "description": "ุงู„ุญุฏ ุงู„ุฃุฏู†ู‰ ู„ุฅุฌู…ุงู„ูŠ ุงู„ุฐุงูƒุฑุฉ ู„ุฌู…ูŠุน ุงู„ุนุงู…ู„ูŠู† ุฃุซู†ุงุก ุงู„ุชูˆุณุน ุงู„ุชู„ู‚ุงุฆูŠ ุจุงู„ุฌูŠุฌุงุจุงูŠุช. ู…ุชุงุญ ูู‚ุท ู„ุฎุฏู…ุงุช "ุงู„ุฅู†ุชุงุฌ". ูŠุฌุจ ุฃู† ูŠูƒูˆู† ู…ุถุงุนูู‹ุง ู„ู€ 12 ูˆุฃูƒุจุฑ ู…ู† 24.", + "minimum": 24, + "maximum": 720, + "multipleOf": 12, + "example": 48 + }, + "maxTotalMemoryGb": { + "type": "number", + "description": "ุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ ู„ุฅุฌู…ุงู„ูŠ ุงู„ุฐุงูƒุฑุฉ ู„ุฌู…ูŠุน ุงู„ุนุงู…ู„ูŠู† ุฃุซู†ุงุก ุงู„ุชูˆุณุน ุงู„ุชู„ู‚ุงุฆูŠ ุจุงู„ุฌูŠุฌุงุจุงูŠุช. ู…ุชุงุญ ูู‚ุท ู„ุฎุฏู…ุงุช "ุงู„ุฅู†ุชุงุฌ". ูŠุฌุจ ุฃู† ูŠูƒูˆู† ู…ุถุงุนูู‹ุง ู„ู€ 12 ูˆุฃู‚ู„ ู…ู† 360 ู„ู„ุฎุฏู…ุงุช ุบูŠุฑ ุงู„ู…ุฏููˆุนุฉ ุฃูˆ 720 ู„ู„ุฎุฏู…ุงุช ุงู„ู…ุฏููˆุนุฉ.", + "minimum": 24, + "maximum": 720, + "multipleOf": 12, + "example": 360 + }, + "idleScaling": { + "type": "boolean", + "description": "ุนู†ุฏ ุถุจุทู‡ ุนู„ู‰ trueุŒ ูŠูุณู…ุญ ู„ู„ุฎุฏู…ุฉ ุจุงู„ุชู‚ู„ูŠุต ุฅู„ู‰ ุงู„ุตูุฑ ุนู†ุฏ ุงู„ุฎู…ูˆู„. ู‡ุฐุง ุตุญูŠุญ ุฏุงุฆู…ู‹ุง ู„ุฎุฏู…ุงุช ุงู„ุชุทูˆูŠุฑ." + }, + "idleTimeoutMinutes": { + "type": "number", + "description": "ุงุถุจุท ุงู„ุญุฏ ุงู„ุฃุฏู†ู‰ ู„ูˆู‚ุช ุงู„ุฎู…ูˆู„ (ุจุงู„ุฏู‚ุงุฆู‚). ูŠุฌุจ ุฃู† ูŠูƒูˆู† >= 5 ุฏู‚ุงุฆู‚." + }, + "ipAccessList": { + "type": "array", + "description": "ู‚ุงุฆู…ุฉ ุนู†ุงูˆูŠู† IP ุงู„ู…ุณู…ูˆุญ ู„ู‡ุง ุจุงู„ูˆุตูˆู„ ุฅู„ู‰ ุงู„ุฎุฏู…ุฉ", + "items": { + "$ref": "#/components/schemas/IpAccessListEntry" + } + }, + "createdAt": { + "type": "string", + "description": "ุทุงุจุน ุฒู…ู†ูŠ ู„ุฅู†ุดุงุก ุงู„ุฎุฏู…ุฉ. ISO-8601.", + "format": "date-time" + } + } + }, + "IpAccessListPatch": { + "properties": { + "add": { + "type": "array", + "description": "ุงู„ุนู†ุงุตุฑ ุงู„ู…ุฑุงุฏ ุฅุถุงูุชู‡ุง. ูŠุชู… ุชู†ููŠุฐู‡ุง ุจุนุฏ ู…ุนุงู„ุฌุฉ ุฌุฒุก "ุงู„ุฅุฒุงู„ุฉ".", + "items": { + "$ref": "#/components/schemas/IpAccessListEntry" + } + }, + "remove": { + "type": "array", + "description": "ุงู„ุนู†ุงุตุฑ ุงู„ู…ุฑุงุฏ ุฅุฒุงู„ุชู‡ุง. ูŠุชู… ุชู†ููŠุฐู‡ุง ู‚ุจู„ ู…ุนุงู„ุฌุฉ ุฌุฒุก "ุงู„ุฅุถุงูุฉ".", + "items": { + "$ref": "#/components/schemas/IpAccessListEntry" + } + } + } + }, + "Activity": { + "properties": { + "id": { + "type": "string", + "description": "ู…ุนุฑู ุงู„ู†ุดุงุท ุงู„ูุฑูŠุฏ." + }, + "createdAt": { + "type": "string", + "description": "ุงู„ุทุงุจุน ุงู„ุฒู…ู†ูŠ ู„ู„ู†ุดุงุท. ISO-8601.", + "format": "date-time" + }, + "type": { + "type": "string", + "description": "ู†ูˆุน ุงู„ู†ุดุงุท.", + "enum": [ + "organization_update_name", + "organization_invite_create", + "organization_invite_delete", + "organization_member_join", + "organization_member_add", + "organization_member_leave", + "organization_member_delete", + "organization_member_update_role", + "key_create", + "key_delete", + "service_create", + "service_start", + "service_stop", + "service_delete", + "service_update_name", + "service_update_ip_access_list", + "service_update_autoscaling_memory", + "service_update_autoscaling_idling", + "service_update_password", + "backup_delete" + ] + }, + "actorType": { + "type": "string", + "description": "ู†ูˆุน ุงู„ู…ู…ุซู„: 'ู…ุณุชุฎุฏู…'ุŒ 'ุฏุนู…'ุŒ 'ู†ุธุงู…'ุŒ 'ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช'.", + "enum": [ + "user", + "support", + "system", + "api" + ] + }, + "actorId": { + "type": "string", + "description": "ู…ุนุฑู ุงู„ู…ู…ุซู„ ุงู„ูุฑูŠุฏ." + }, + "actorDetails": { + "type": "string", + "description": "ู…ุนู„ูˆู…ุงุช ุงุถุงููŠุฉ ุนู† ุงู„ู…ู…ุซู„." + }, + "actorIpAddress": { + "type": "string", + "description": "ุนู†ูˆุงู† IP ู„ู„ู…ู…ุซู„. ู…ุญุฏุฏ ู„ุฃู†ูˆุงุน ุงู„ู…ู…ุซู„ูŠู† "ุงู„ู…ุณุชุฎุฏู…" ูˆ"ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช"." + }, + "organizationId": { + "type": "string", + "description": "ู†ุทุงู‚ ุงู„ู†ุดุงุท: ู…ุนุฑู ุงู„ู…ู†ุธู…ุฉ ุงู„ุชูŠ ูŠุฑุชุจุท ุจู‡ุง ู‡ุฐุง ุงู„ู†ุดุงุท." + }, + "serviceId": { + "type": "string", + "description": "ู†ุทุงู‚ ุงู„ู†ุดุงุท: ู…ุนุฑู ุงู„ุฎุฏู…ุฉ ุงู„ุฐูŠ ูŠุฑุชุจุท ุจู‡ ู‡ุฐุง ุงู„ู†ุดุงุท." + } + } + }, + "Backup": { + "properties": { + "id": { + "type": "string", + "description": "ู…ุนุฑู ุงู„ู†ุณุฎ ุงู„ุงุญุชูŠุงุทูŠ ุงู„ูุฑูŠุฏ.", + "format": "uuid" + }, + "status": { + "type": "string", + "description": "ุญุงู„ุฉ ุงู„ู†ุณุฎ ุงู„ุงุญุชูŠุงุทูŠ: 'ุชู…'ุŒ 'ุฎุทุฃ'ุŒ 'ู‚ูŠุฏ ุงู„ุชู†ููŠุฐ'.", + "enum": [ + "done", + "error", + "in_progress" + ] + }, + "serviceId": { + "type": "string", + "description": "ุงุณู…" + }, + "startedAt": { + "type": "string", + "description": "ุทุงุจุน ุฒู…ู†ูŠ ู„ุจุฏุก ุงู„ู†ุณุฎ ุงู„ุงุญุชูŠุงุทูŠ. ISO-8601.", + "format": "date-time" + }, + "finishedAt": { + "type": "string", + "description": "ุฎุชู… ุฒู…ู†ูŠ ู„ุงู†ุชู‡ุงุก ุงู„ู†ุณุฎ ุงู„ุงุญุชูŠุงุทูŠ. ISO-8601. ู…ุชุงุญ ูู‚ุท ู„ู„ู†ุณุฎ ุงู„ุงุญุชูŠุงุทูŠุฉ ุงู„ู…ู†ุชู‡ูŠุฉ", + "format": "date-time" + } + } + }, + "Organization": { + "properties": { + "id": { + "type": "string", + "description": "ู…ุนุฑู ุงู„ู…ู†ุธู…ุฉ ุงู„ูุฑูŠุฏ.", + "format": "uuid" + }, + "createdAt": { + "type": "string", + "description": "ุงู„ุทุงุจุน ุงู„ุฒู…ู†ูŠ ุงู„ุฐูŠ ุชู… ููŠู‡ ุฅู†ุดุงุก ุงู„ู…ู†ุธู…ุฉ. ISO-8601.", + "format": "date-time" + }, + "name": { + "type": "string", + "description": "ุงุณู… ุงู„ู…ู†ุธู…ุฉ." + } + } + }, + "Member": { + "properties": { + "userId": { + "type": "string", + "description": "ู…ุนุฑู ู…ุณุชุฎุฏู… ูุฑูŠุฏ. ุฅุฐุง ูƒุงู† ุงู„ู…ุณุชุฎุฏู… ุนุถูˆู‹ุง ููŠ ู…ุคุณุณุงุช ู…ุชุนุฏุฏุฉุŒ ูุณูŠุธู„ ู‡ุฐุง ุงู„ู…ุนุฑู ูƒู…ุง ู‡ูˆ." + }, + "name": { + "type": "string", + "description": "ุงุณู… ุงู„ุนุถูˆ ูƒู…ุง ุชู… ุชุนูŠูŠู†ู‡ ููŠ ู…ู„ู ุชุนุฑูŠู ุงู„ู…ุณุชุฎุฏู… ุงู„ุดุฎุตูŠ." + }, + "email": { + "type": "string", + "description": "ุงู„ุจุฑูŠุฏ ุงู„ุฅู„ูƒุชุฑูˆู†ูŠ ู„ู„ุนุถูˆ ูƒู…ุง ู‡ูˆ ู…ุญุฏุฏ ููŠ ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ ู„ู„ู…ุณุชุฎุฏู….", + "format": "email" + }, + "role": { + "type": "string", + "description": "ุฏูˆุฑ ุงู„ุนุถูˆ ููŠ ุงู„ู…ู†ุธู…ุฉ.", + "enum": [ + "admin", + "developer" + ] + }, + "joinedAt": { + "type": "string", + "description": "ุนู„ุงู…ุฉ ุฒู…ู†ูŠุฉ ู„ุงู†ุถู…ุงู… ุงู„ุนุถูˆ ุฅู„ู‰ ุงู„ู…ู†ุธู…ุฉ. ISO-8601.", + "format": "date-time" + } + } + }, + "Invitation": { + "properties": { + "role": { + "type": "string", + "description": "ุฏูˆุฑ ุงู„ุนุถูˆ ููŠ ุงู„ู…ู†ุธู…ุฉ.", + "enum": [ + "admin", + "developer" + ] + }, + "id": { + "type": "string", + "description": "ู…ุนุฑู ุฏุนูˆุฉ ูุฑูŠุฏ.", + "format": "uuid" + }, + "email": { + "type": "string", + "description": "ุงู„ุจุฑูŠุฏ ุงู„ุฅู„ูƒุชุฑูˆู†ูŠ ู„ู„ู…ุณุชุฎุฏู… ุงู„ู…ุฏุนูˆ. ู„ุง ูŠู…ูƒู† ุฅู„ุง ู„ู„ู…ุณุชุฎุฏู… ุงู„ุฐูŠ ู„ุฏูŠู‡ ู‡ุฐุง ุงู„ุจุฑูŠุฏ ุงู„ุฅู„ูƒุชุฑูˆู†ูŠ ุงู„ุงู†ุถู…ุงู… ุจุงุณุชุฎุฏุงู… ุงู„ุฏุนูˆุฉ. ูŠุชู… ุชุฎุฒูŠู† ุงู„ุจุฑูŠุฏ ุงู„ุฅู„ูƒุชุฑูˆู†ูŠ ุจุฃุญุฑู ุตุบูŠุฑุฉ.", + "format": "email" + }, + "createdAt": { + "type": "string", + "description": "ุทุงุจุน ุฒู…ู†ูŠ ู„ุฅู†ุดุงุก ุงู„ุฏุนูˆุฉ. ISO-8601.", + "format": "date-time" + }, + "expireAt": { + "type": "string", + "description": "ุนู„ุงู…ุฉ ุฒู…ู†ูŠุฉ ุชุดูŠุฑ ุฅู„ู‰ ุงู†ุชู‡ุงุก ุตู„ุงุญูŠุฉ ุงู„ุฏุนูˆุฉ. ISO-8601.", + "format": "date-time" + } + } + }, + "ApiKey": { + "properties": { + "id": { + "type": "string", + "description": "ู…ุนุฑู ู…ูุชุงุญ API ุงู„ูุฑูŠุฏ.", + "format": "uuid" + }, + "name": { + "type": "string", + "description": "ุงุณู… ุงู„ู…ูุชุงุญ" + }, + "state": { + "type": "string", + "description": "ุญุงู„ุฉ ุงู„ู…ูุชุงุญ: 'ู…ู…ูƒู‘ู†'ุŒ 'ู…ุนุทู„'.", + "enum": [ + "enabled", + "disabled" + ] + }, + "roles": { + "type": "array", + "description": "ู‚ุงุฆู…ุฉ ุงู„ุฃุฏูˆุงุฑ ุงู„ู…ุฎุตุตุฉ ู„ู„ู…ูุชุงุญ. ุชุญุชูˆูŠ ุนู„ู‰ ุนู†ุตุฑ ูˆุงุญุฏ ุนู„ู‰ ุงู„ุฃู‚ู„.", + "items": { + "type": "string", + "enum": [ + "admin", + "developer" + ] + } + }, + "keySuffix": { + "type": "string", + "description": "ุขุฎุฑ 4 ุฃุญุฑู ู…ู† ุงู„ู…ูุชุงุญ." + }, + "createdAt": { + "type": "string", + "description": "ุนู„ุงู…ุฉ ุฒู…ู†ูŠุฉ ุชุดูŠุฑ ุฅู„ู‰ ุฅู†ุดุงุก ุงู„ู…ูุชุงุญ. ISO-8601.", + "format": "date-time" + }, + "expireAt": { + "type": "string", + "description": "ุนู„ุงู…ุฉ ุฒู…ู†ูŠุฉ ุชุดูŠุฑ ุฅู„ู‰ ุงู†ุชู‡ุงุก ุตู„ุงุญูŠุฉ ุงู„ู…ูุชุงุญ. ุฅุฐุง ู„ู… ูŠูƒู† ุงู„ู…ูุชุงุญ ู…ูˆุฌูˆุฏู‹ุง ุฃูˆ ูƒุงู† ูุงุฑุบู‹ุงุŒ ูู„ู† ุชู†ุชู‡ูŠ ุตู„ุงุญูŠุชู‡ ุฃุจุฏู‹ุง. ISO-8601.", + "format": "date-time" + }, + "usedAt": { + "type": "string", + "description": "ู‚ู… ุจุชุญุฏูŠุฏ ุชุงุฑูŠุฎ ุขุฎุฑ ุงุณุชุฎุฏุงู… ู„ู„ู…ูุชุงุญ. ุฅุฐุง ู„ู… ูŠูƒู† ู…ูˆุฌูˆุฏู‹ุงุŒ ูู‡ุฐุง ูŠุนู†ูŠ ุฃู†ู‡ ู„ู… ูŠุชู… ุงุณุชุฎุฏุงู… ุงู„ู…ูุชุงุญ ู…ุทู„ู‚ู‹ุง. ISO-8601.", + "format": "date-time" + } + } + }, + "ApiKeyHashData": { + "properties": { + "keyIdHash": { + "type": "string", + "description": "ุชุฌุฒุฆุฉ ู…ุนุฑู ุงู„ู…ูุชุงุญ." + }, + "keyIdSuffix": { + "type": "string", + "description": "ุขุฎุฑ 4 ุฃุฑู‚ุงู… ู…ู† ู…ุนุฑู ุงู„ู…ูุชุงุญ. ุงู„ุฎูˆุงุฑุฒู…ูŠุฉ: echo -n "yourpassword" | sha256sum | tr -d '-' | xxd -r -p | base64" + }, + "keySecretHash": { + "type": "string", + "description": "ุชุฌุฒุฆุฉ ุงู„ู…ูุชุงุญ ุงู„ุณุฑูŠ. ุงู„ุฎูˆุงุฑุฒู…ูŠุฉ: echo -n "yourpassword" | sha256sum | tr -d '-' | xxd -r -p | base64" + } + } + }, + "OrganizationPatchRequest": { + "properties": { + "name": { + "type": "string", + "description": "ุงุณู… ุงู„ู…ู†ุธู…ุฉ." + } + } + }, + "ServicePostRequest": { + "properties": { + "name": { + "type": "string", + "description": "ุงุณู… ุงู„ุฎุฏู…ุฉ." + }, + "provider": { + "type": "string", + "description": "ู…ุฒูˆุฏ ุงู„ุฎุฏู…ุฉ ุงู„ุณุญุงุจูŠุฉ", + "enum": [ + "aws", + "gcp" + ] + }, + "region": { + "type": "string", + "description": "ู…ู†ุทู‚ุฉ ุงู„ุฎุฏู…ุฉ.", + "enum": [ + "ap-south-1", + "ap-southeast-1", + "eu-central-1", + "eu-west-1", + "us-east-1", + "us-east-2", + "us-west-2", + "ap-southeast-2", + "us-east1", + "us-central1", + "europe-west4", + "asia-southeast1" + ] + }, + "tier": { + "type": "string", + "description": "ู…ุณุชูˆู‰ ุงู„ุฎุฏู…ุฉ: "ุงู„ุชุทูˆูŠุฑ"ุŒ "ุงู„ุฅู†ุชุงุฌ"ุŒ "ุงู„ุฐุงูƒุฑุฉ ุงู„ู…ุฎุตุตุฉ ุนุงู„ูŠุฉ ุงู„ุฃุฏุงุก"ุŒ "ูˆุญุฏุฉ ุงู„ู…ุนุงู„ุฌุฉ ุงู„ู…ุฑูƒุฒูŠุฉ ุงู„ู…ุฎุตุตุฉ ุนุงู„ูŠุฉ ุงู„ุฃุฏุงุก"ุŒ "ุงู„ู…ุนูŠุงุฑ ุงู„ู…ุฎุตุต". ุญุฌู… ุฎุฏู…ุงุช ุงู„ุฅู†ุชุงุฌ ูˆุงู„ุชุทูˆูŠุฑ ุซุงุจุช.", + "enum": [ + "development", + "production", + "dedicated_high_mem", + "dedicated_high_cpu", + "dedicated_standard" + ] + }, + "ipAccessList": { + "type": "array", + "description": "ู‚ุงุฆู…ุฉ ุนู†ุงูˆูŠู† IP ุงู„ู…ุณู…ูˆุญ ู„ู‡ุง ุจุงู„ูˆุตูˆู„ ุฅู„ู‰ ุงู„ุฎุฏู…ุฉ", + "items": { + "$ref": "#/components/schemas/IpAccessListEntry" + } + }, + "minTotalMemoryGb": { + "type": "number", + "description": "ุงู„ุญุฏ ุงู„ุฃุฏู†ู‰ ู„ุฅุฌู…ุงู„ูŠ ุงู„ุฐุงูƒุฑุฉ ู„ุฌู…ูŠุน ุงู„ุนุงู…ู„ูŠู† ุฃุซู†ุงุก ุงู„ุชูˆุณุน ุงู„ุชู„ู‚ุงุฆูŠ ุจุงู„ุฌูŠุฌุงุจุงูŠุช. ู…ุชุงุญ ูู‚ุท ู„ุฎุฏู…ุงุช "ุงู„ุฅู†ุชุงุฌ". ูŠุฌุจ ุฃู† ูŠูƒูˆู† ู…ุถุงุนูู‹ุง ู„ู€ 12 ูˆุฃูƒุจุฑ ู…ู† 24.", + "minimum": 24, + "maximum": 720, + "multipleOf": 12, + "example": 48 + }, + "maxTotalMemoryGb": { + "type": "number", + "description": "ุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ ู„ุฅุฌู…ุงู„ูŠ ุงู„ุฐุงูƒุฑุฉ ู„ุฌู…ูŠุน ุงู„ุนุงู…ู„ูŠู† ุฃุซู†ุงุก ุงู„ุชูˆุณุน ุงู„ุชู„ู‚ุงุฆูŠ ุจุงู„ุฌูŠุฌุงุจุงูŠุช. ู…ุชุงุญ ูู‚ุท ู„ุฎุฏู…ุงุช "ุงู„ุฅู†ุชุงุฌ". ูŠุฌุจ ุฃู† ูŠูƒูˆู† ู…ุถุงุนูู‹ุง ู„ู€ 12 ูˆุฃู‚ู„ ู…ู† 360 ู„ู„ุฎุฏู…ุงุช ุบูŠุฑ ุงู„ู…ุฏููˆุนุฉ ุฃูˆ 720 ู„ู„ุฎุฏู…ุงุช ุงู„ู…ุฏููˆุนุฉ.", + "minimum": 24, + "maximum": 720, + "multipleOf": 12, + "example": 360 + }, + "idleScaling": { + "type": "boolean", + "description": "ุนู†ุฏ ุถุจุทู‡ ุนู„ู‰ trueุŒ ูŠูุณู…ุญ ู„ู„ุฎุฏู…ุฉ ุจุงู„ุชู‚ู„ูŠุต ุฅู„ู‰ ุงู„ุตูุฑ ุนู†ุฏ ุงู„ุฎู…ูˆู„. ู‡ุฐุง ุตุญูŠุญ ุฏุงุฆู…ู‹ุง ู„ุฎุฏู…ุงุช ุงู„ุชุทูˆูŠุฑ." + }, + "idleTimeoutMinutes": { + "type": "number", + "description": "ุงุถุจุท ุงู„ุญุฏ ุงู„ุฃุฏู†ู‰ ู„ูˆู‚ุช ุงู„ุฎู…ูˆู„ (ุจุงู„ุฏู‚ุงุฆู‚). ูŠุฌุจ ุฃู† ูŠูƒูˆู† >= 5 ุฏู‚ุงุฆู‚." + }, + "backupId": { + "type": "string", + "description": "ู…ุนุฑู ุงู„ู†ุณุฎ ุงู„ุงุญุชูŠุงุทูŠ ุงู„ุงุฎุชูŠุงุฑูŠ ุงู„ู…ุณุชุฎุฏู… ูƒุญุงู„ุฉ ุฃูˆู„ูŠุฉ ู„ู„ุฎุฏู…ุฉ ุงู„ุฌุฏูŠุฏุฉ. ุนู†ุฏ ุงู„ุงุณุชุฎุฏุงู…ุŒ ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ู…ู†ุทู‚ุฉ ูˆุงู„ุทุจู‚ุฉ ุงู„ุฎุงุตุฉ ุจุงู„ู…ุซูŠู„ ุงู„ุฌุฏูŠุฏ ู…ุชุทุงุจู‚ุชูŠู† ู…ุน ู‚ูŠู… ุงู„ู…ุซูŠู„ ุงู„ุฃุตู„ูŠ.", + "format": "uuid" + } + } + }, + "ServicePostResponse": { + "properties": { + "service": { + "$ref": "#/components/schemas/Service" + }, + "password": { + "type": "string", + "description": "ูƒู„ู…ุฉ ุงู„ู…ุฑูˆุฑ ู„ู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชู… ุฅู†ุดุงุคู‡ุง ุญุฏูŠุซู‹ุง." + } + } + }, + "ServicePatchRequest": { + "properties": { + "name": { + "type": "string", + "description": "ุงุณู… ุงู„ุฎุฏู…ุฉ." + }, + "ipAccessList": { + "$ref": "#/components/schemas/IpAccessListPatch" + } + } + }, + "ServiceStatePatchRequest": { + "properties": { + "command": { + "type": "string", + "description": "ุฃู…ุฑ ู„ุชุบูŠูŠุฑ ุงู„ุญุงู„ุฉ: 'ุจุฏุก'ุŒ 'ุฅูŠู‚ุงู'.", + "enum": [ + "start", + "stop" + ] + } + } + }, + "ServiceScalingPatchRequest": { + "properties": { + "minTotalMemoryGb": { + "type": "number", + "description": "ุงู„ุญุฏ ุงู„ุฃุฏู†ู‰ ู„ุฅุฌู…ุงู„ูŠ ุงู„ุฐุงูƒุฑุฉ ู„ุฌู…ูŠุน ุงู„ุนุงู…ู„ูŠู† ุฃุซู†ุงุก ุงู„ุชูˆุณุน ุงู„ุชู„ู‚ุงุฆูŠ ุจุงู„ุฌูŠุฌุงุจุงูŠุช. ู…ุชุงุญ ูู‚ุท ู„ุฎุฏู…ุงุช "ุงู„ุฅู†ุชุงุฌ". ูŠุฌุจ ุฃู† ูŠูƒูˆู† ู…ุถุงุนูู‹ุง ู„ู€ 12 ูˆุฃูƒุจุฑ ู…ู† 24.", + "minimum": 24, + "maximum": 720, + "multipleOf": 12, + "example": 48 + }, + "maxTotalMemoryGb": { + "type": "number", + "description": "ุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ ู„ุฅุฌู…ุงู„ูŠ ุงู„ุฐุงูƒุฑุฉ ู„ุฌู…ูŠุน ุงู„ุนุงู…ู„ูŠู† ุฃุซู†ุงุก ุงู„ุชูˆุณุน ุงู„ุชู„ู‚ุงุฆูŠ ุจุงู„ุฌูŠุฌุงุจุงูŠุช. ู…ุชุงุญ ูู‚ุท ู„ุฎุฏู…ุงุช "ุงู„ุฅู†ุชุงุฌ". ูŠุฌุจ ุฃู† ูŠูƒูˆู† ู…ุถุงุนูู‹ุง ู„ู€ 12 ูˆุฃู‚ู„ ู…ู† 360 ู„ู„ุฎุฏู…ุงุช ุบูŠุฑ ุงู„ู…ุฏููˆุนุฉ ุฃูˆ 720 ู„ู„ุฎุฏู…ุงุช ุงู„ู…ุฏููˆุนุฉ.", + "minimum": 24, + "maximum": 720, + "multipleOf": 12, + "example": 360 + }, + "idleScaling": { + "type": "boolean", + "description": "ุนู†ุฏ ุถุจุทู‡ ุนู„ู‰ trueุŒ ูŠูุณู…ุญ ู„ู„ุฎุฏู…ุฉ ุจุงู„ุชู‚ู„ูŠุต ุฅู„ู‰ ุงู„ุตูุฑ ุนู†ุฏ ุงู„ุฎู…ูˆู„. ู‡ุฐุง ุตุญูŠุญ ุฏุงุฆู…ู‹ุง ู„ุฎุฏู…ุงุช ุงู„ุชุทูˆูŠุฑ." + }, + "idleTimeoutMinutes": { + "type": "number", + "description": "ุงุถุจุท ุงู„ุญุฏ ุงู„ุฃุฏู†ู‰ ู„ูˆู‚ุช ุงู„ุฎู…ูˆู„ (ุจุงู„ุฏู‚ุงุฆู‚). ูŠุฌุจ ุฃู† ูŠูƒูˆู† >= 5 ุฏู‚ุงุฆู‚." + } + } + }, + "ServicePasswordPatchRequest": { + "properties": { + "newPasswordHash": { + "type": "string", + "description": "ุชุฌุฒุฆุฉ ูƒู„ู…ุฉ ุงู„ู…ุฑูˆุฑ ุงู„ุงุฎุชูŠุงุฑูŠุฉ. ุชุณุชุฎุฏู… ู„ุชุฌู†ุจ ู†ู‚ู„ ูƒู„ู…ุฉ ุงู„ู…ุฑูˆุฑ ุนุจุฑ ุงู„ุดุจูƒุฉ. ุฅุฐุง ู„ู… ูŠุชู… ุชูˆููŠุฑู‡ุงุŒ ูŠุชู… ุฅู†ุดุงุก ูƒู„ู…ุฉ ู…ุฑูˆุฑ ุฌุฏูŠุฏุฉ ูˆุชู‚ุฏูŠู…ู‡ุง ููŠ ุงู„ุงุณุชุฌุงุจุฉ. ูˆุฅู„ุงุŒ ูŠุชู… ุงุณุชุฎุฏุงู… ู‡ุฐู‡ ุงู„ุชุฌุฒุฆุฉ. ุงู„ุฎูˆุงุฑุฒู…ูŠุฉ: echo -n "yourpassword" | sha256sum | tr -d '-' | xxd -r -p | base64" + }, + "newDoubleSha1Hash": { + "type": "string", + "description": "ุชุฌุฒุฆุฉ ูƒู„ู…ุฉ ู…ุฑูˆุฑ SHA1 ู…ุฒุฏูˆุฌุฉ ุงุฎุชูŠุงุฑูŠุฉ ู„ุจุฑูˆุชูˆูƒูˆู„ MySQL. ุฅุฐุง ู„ู… ูŠุชู… ุชูˆููŠุฑ newPasswordHashุŒ ูุณูŠุชู… ุชุฌุงู‡ู„ ู‡ุฐุง ุงู„ู…ูุชุงุญ ูˆุณูŠุชู… ุงุณุชุฎุฏุงู… ูƒู„ู…ุฉ ุงู„ู…ุฑูˆุฑ ุงู„ู†ุงุชุฌุฉ. ู„ุชู…ูƒูŠู† ู‡ุฐุง ุงู„ุญู‚ู„ุŒ ูŠุฑุฌู‰ ุงู„ุงุชุตุงู„ ุจุงู„ุฏุนู… ู„ุฃู†ู‡ ุชุฌุฑูŠุจูŠ. ุงู„ุฎูˆุงุฑุฒู…ูŠุฉ: echo -n "yourpassword" | sha1sum | tr -d '-' | xxd -r -p | sha1sum | tr -d '-'" + } + } + }, + "ServicePasswordPatchResponse": { + "properties": { + "password": { + "type": "string", + "description": "ูƒู„ู…ุฉ ู…ุฑูˆุฑ ุงู„ุฎุฏู…ุฉ ุงู„ุฌุฏูŠุฏุฉ. ูŠุชู… ุชูˆููŠุฑู‡ุง ูู‚ุท ุฅุฐุง ู„ู… ูŠูƒู† ู‡ู†ุงูƒ "newPasswordHash" ููŠ ุงู„ุทู„ุจ" + } + } + }, + "ApiKeyPostRequest": { + "properties": { + "name": { + "type": "string", + "description": "ุงุณู… ุงู„ู…ูุชุงุญ." + }, + "expireAt": { + "type": "string", + "description": "ุนู„ุงู…ุฉ ุฒู…ู†ูŠุฉ ุชุดูŠุฑ ุฅู„ู‰ ุงู†ุชู‡ุงุก ุตู„ุงุญูŠุฉ ุงู„ู…ูุชุงุญ. ุฅุฐุง ู„ู… ูŠูƒู† ุงู„ู…ูุชุงุญ ู…ูˆุฌูˆุฏู‹ุง ุฃูˆ ูƒุงู† ูุงุฑุบู‹ุงุŒ ูู„ู† ุชู†ุชู‡ูŠ ุตู„ุงุญูŠุชู‡ ุฃุจุฏู‹ุง. ISO-8601.", + "format": "date-time" + }, + "state": { + "type": "string", + "description": "ุงู„ุญุงู„ุฉ ุงู„ุฃูˆู„ูŠุฉ ู„ู„ู…ูุชุงุญ: "ู…ู…ูƒู‘ู†"ุŒ "ู…ุนุทู„". ุฅุฐุง ู„ู… ูŠุชู… ุชูˆููŠุฑ ุงู„ู…ูุชุงุญ ุงู„ุฌุฏูŠุฏุŒ ูุณูŠูƒูˆู† "ู…ู…ูƒู‘ู†ู‹ุง".", + "enum": [ + "enabled", + "disabled" + ] + }, + "hashData": { + "$ref": "#/components/schemas/ApiKeyHashData" + }, + "roles": { + "type": "array", + "description": "ู‚ุงุฆู…ุฉ ุงู„ุฃุฏูˆุงุฑ ุงู„ู…ุฎุตุตุฉ ู„ู„ู…ูุชุงุญ. ุชุญุชูˆูŠ ุนู„ู‰ ุนู†ุตุฑ ูˆุงุญุฏ ุนู„ู‰ ุงู„ุฃู‚ู„.", + "items": { + "type": "string", + "enum": [ + "admin", + "developer" + ] + } + } + } + }, + "ApiKeyPostResponse": { + "properties": { + "key": { + "$ref": "#/components/schemas/ApiKey" + }, + "keyId": { + "type": "string", + "description": "ุชู… ุฅู†ุดุงุก ู…ุนุฑู ุงู„ู…ูุชุงุญ. ูŠุชู… ุชูˆููŠุฑู‡ ูู‚ุท ุฅุฐุง ู„ู… ูŠูƒู† ู‡ู†ุงูƒ "hashData" ููŠ ุงู„ุทู„ุจ." + }, + "keySecret": { + "type": "string", + "description": "ุชู… ุฅู†ุดุงุก ู…ูุชุงุญ ุณุฑูŠ. ูŠุชู… ุชูˆููŠุฑู‡ ูู‚ุท ุฅุฐุง ู„ู… ูŠูƒู† ู‡ู†ุงูƒ "hashData" ููŠ ุงู„ุทู„ุจ." + } + } + }, + "ApiKeyPatchRequest": { + "properties": { + "name": { + "type": "string", + "description": "ุงุณู… ุงู„ู…ูุชุงุญ" + }, + "roles": { + "type": "array", + "description": "ู‚ุงุฆู…ุฉ ุงู„ุฃุฏูˆุงุฑ ุงู„ู…ุฎุตุตุฉ ู„ู„ู…ูุชุงุญ. ุชุญุชูˆูŠ ุนู„ู‰ ุนู†ุตุฑ ูˆุงุญุฏ ุนู„ู‰ ุงู„ุฃู‚ู„.", + "items": { + "type": "string", + "enum": [ + "admin", + "developer" + ] + } + }, + "expireAt": { + "type": "string", + "description": "ุนู„ุงู…ุฉ ุฒู…ู†ูŠุฉ ุชุดูŠุฑ ุฅู„ู‰ ุงู†ุชู‡ุงุก ุตู„ุงุญูŠุฉ ุงู„ู…ูุชุงุญ. ุฅุฐุง ู„ู… ูŠูƒู† ุงู„ู…ูุชุงุญ ู…ูˆุฌูˆุฏู‹ุง ุฃูˆ ูƒุงู† ูุงุฑุบู‹ุงุŒ ูู„ู† ุชู†ุชู‡ูŠ ุตู„ุงุญูŠุชู‡ ุฃุจุฏู‹ุง. ISO-8601.", + "format": "date-time" + }, + "state": { + "type": "string", + "description": "ุญุงู„ุฉ ุงู„ู…ูุชุงุญ: 'ู…ู…ูƒู‘ู†'ุŒ 'ู…ุนุทู„'.", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "MemberPatchRequest": { + "properties": { + "role": { + "type": "string", + "description": "ุฏูˆุฑ ุงู„ุนุถูˆ ููŠ ุงู„ู…ู†ุธู…ุฉ.", + "enum": [ + "admin", + "developer" + ] + } + } + }, + "InvitationPostRequest": { + "properties": { + "email": { + "type": "string", + "description": "ุงู„ุจุฑูŠุฏ ุงู„ุฅู„ูƒุชุฑูˆู†ูŠ ู„ู„ู…ุณุชุฎุฏู… ุงู„ู…ุฏุนูˆ. ู„ุง ูŠู…ูƒู† ุฅู„ุง ู„ู„ู…ุณุชุฎุฏู… ุงู„ุฐูŠ ู„ุฏูŠู‡ ู‡ุฐุง ุงู„ุจุฑูŠุฏ ุงู„ุฅู„ูƒุชุฑูˆู†ูŠ ุงู„ุงู†ุถู…ุงู… ุจุงุณุชุฎุฏุงู… ุงู„ุฏุนูˆุฉ. ูŠุชู… ุชุฎุฒูŠู† ุงู„ุจุฑูŠุฏ ุงู„ุฅู„ูƒุชุฑูˆู†ูŠ ุจุฃุญุฑู ุตุบูŠุฑุฉ.", + "format": "email" + }, + "role": { + "type": "string", + "description": "ุฏูˆุฑ ุงู„ุนุถูˆ ููŠ ุงู„ู…ู†ุธู…ุฉ.", + "enum": [ + "admin", + "developer" + ] + } + } + } + } + }, + "x-samchon-emended": true +} \ No newline at end of file diff --git a/assets/output/clickhouse.swagger.ja.json b/assets/output/clickhouse.swagger.ja.json new file mode 100644 index 0000000..8b3a452 --- /dev/null +++ b/assets/output/clickhouse.swagger.ja.json @@ -0,0 +1,2582 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "ClickHouse Cloud ใฎ OpenAPI ไป•ๆง˜", + "version": "1.0", + "contact": { + "name": "ClickHouse Support", + "url": "https://clickhouse.com/docs/en/cloud/manage/openapi?referrer=openapi-82913", + "email": "support@clickhouse.com" + } + }, + "servers": [ + { + "url": "https://api.clickhouse.cloud" + } + ], + "paths": { + "/v1/organizations": { + "get": { + "summary": "ๅˆฉ็”จๅฏ่ƒฝใช็ต„็น”ใฎใƒชใ‚นใƒˆใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "description": "ใƒชใ‚ฏใ‚จใ‚นใƒˆๅ†…ใฎAPIใ‚ญใƒผใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸๅ˜ไธ€ใฎ็ต„็น”ใฎใƒชใ‚นใƒˆใ‚’่ฟ”ใ—ใพใ™ใ€‚.", + "parameters": [], + "responses": { + "200": { + "description": "ๅฟœ็ญ”ๆˆๅŠŸ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Organization" + } + }, + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ใ™ในใฆใฎใƒชใ‚ฏใ‚จใ‚นใƒˆใซๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚Œใ‚‹ไธ€ๆ„ใฎ IDใ€‚UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚จใƒฉใƒผใจๆ€ใ‚ใ‚Œใ‚‹ไฝ•ใ‚‰ใ‹ใฎๅŽŸๅ› ใซใ‚ˆใ‚Šใ€ใ‚ตใƒผใƒใƒผใŒใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’ๅ‡ฆ็†ใงใใชใ„ใ€ใพใŸใฏๅ‡ฆ็†ใ—ใชใ„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 400 + }, + "error": { + "type": "string", + "description": "่ฉณ็ดฐใชใ‚จใƒฉใƒผใฎ่ชฌๆ˜Ž." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId": { + "get": { + "summary": "็ต„็น”ใฎ่ฉณ็ดฐใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "description": "ๅ˜ไธ€ใฎ็ต„็น”ใฎ่ฉณ็ดฐใ‚’่ฟ”ใ—ใพใ™ใ€‚่ฉณ็ดฐใ‚’ๅ–ๅพ—ใ™ใ‚‹ใซใฏใ€่ช่จผใ‚ญใƒผใŒ็ต„็น”ใซๅฑžใ—ใฆใ„ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸ็ต„็น”ใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "ๅฟœ็ญ”ๆˆๅŠŸ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Organization" + }, + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ใ™ในใฆใฎใƒชใ‚ฏใ‚จใ‚นใƒˆใซๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚Œใ‚‹ไธ€ๆ„ใฎ IDใ€‚UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚จใƒฉใƒผใจๆ€ใ‚ใ‚Œใ‚‹ไฝ•ใ‚‰ใ‹ใฎๅŽŸๅ› ใซใ‚ˆใ‚Šใ€ใ‚ตใƒผใƒใƒผใŒใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’ๅ‡ฆ็†ใงใใชใ„ใ€ใพใŸใฏๅ‡ฆ็†ใ—ใชใ„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 400 + }, + "error": { + "type": "string", + "description": "่ฉณ็ดฐใชใ‚จใƒฉใƒผใฎ่ชฌๆ˜Ž." + } + } + } + } + } + } + } + }, + "patch": { + "summary": "็ต„็น”ใฎ่ฉณ็ดฐใ‚’ๆ›ดๆ–ฐใ™ใ‚‹", + "description": "็ต„็น”ใƒ•ใ‚ฃใƒผใƒซใƒ‰ใ‚’ๆ›ดๆ–ฐใ—ใพใ™ใ€‚ADMIN ่ช่จผใ‚ญใƒผใƒญใƒผใƒซใŒๅฟ…่ฆใงใ™.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ๆ›ดๆ–ฐใ™ใ‚‹็ต„็น”ใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrganizationPatchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "ๅฟœ็ญ”ๆˆๅŠŸ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Organization" + }, + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ใ™ในใฆใฎใƒชใ‚ฏใ‚จใ‚นใƒˆใซๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚Œใ‚‹ไธ€ๆ„ใฎ IDใ€‚UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚จใƒฉใƒผใจๆ€ใ‚ใ‚Œใ‚‹ไฝ•ใ‚‰ใ‹ใฎๅŽŸๅ› ใซใ‚ˆใ‚Šใ€ใ‚ตใƒผใƒใƒผใŒใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’ๅ‡ฆ็†ใงใใชใ„ใ€ใพใŸใฏๅ‡ฆ็†ใ—ใชใ„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 400 + }, + "error": { + "type": "string", + "description": "่ฉณ็ดฐใชใ‚จใƒฉใƒผใฎ่ชฌๆ˜Ž." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/services": { + "get": { + "summary": "็ต„็น”ใ‚ตใƒผใƒ“ใ‚นไธ€่ฆง", + "description": "็ต„็น”ๅ†…ใฎใ™ในใฆใฎใ‚ตใƒผใƒ“ใ‚นใฎใƒชใ‚นใƒˆใ‚’่ฟ”ใ—ใพใ™.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸ็ต„็น”ใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "ๅฟœ็ญ”ๆˆๅŠŸ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Service" + } + }, + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ใ™ในใฆใฎใƒชใ‚ฏใ‚จใ‚นใƒˆใซๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚Œใ‚‹ไธ€ๆ„ใฎ IDใ€‚UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚จใƒฉใƒผใจๆ€ใ‚ใ‚Œใ‚‹ไฝ•ใ‚‰ใ‹ใฎๅŽŸๅ› ใซใ‚ˆใ‚Šใ€ใ‚ตใƒผใƒใƒผใŒใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’ๅ‡ฆ็†ใงใใชใ„ใ€ใพใŸใฏๅ‡ฆ็†ใ—ใชใ„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 400 + }, + "error": { + "type": "string", + "description": "่ฉณ็ดฐใชใ‚จใƒฉใƒผใฎ่ชฌๆ˜Ž." + } + } + } + } + } + } + } + }, + "post": { + "summary": "ๆ–ฐใ—ใ„ใ‚ตใƒผใƒ“ใ‚นใ‚’ไฝœๆˆใ™ใ‚‹", + "description": "็ต„็น”ๅ†…ใซๆ–ฐใ—ใ„ใ‚ตใƒผใƒ“ใ‚นใ‚’ไฝœๆˆใ—ใ€็พๅœจใฎใ‚ตใƒผใƒ“ใ‚น็Šถๆ…‹ใจใ‚ตใƒผใƒ“ใ‚นใซใ‚ขใ‚ฏใ‚ปใ‚นใ™ใ‚‹ใŸใ‚ใฎใƒ‘ใ‚นใƒฏใƒผใƒ‰ใ‚’่ฟ”ใ—ใพใ™ใ€‚ใ‚ตใƒผใƒ“ใ‚นใฏ้žๅŒๆœŸ็š„ใซ้–‹ๅง‹ใ•ใ‚Œใพใ™ใ€‚.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ใ‚ตใƒผใƒ“ใ‚นใ‚’ๆ‰€ๆœ‰ใ™ใ‚‹็ต„็น”ใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServicePostRequest" + } + } + } + }, + "responses": { + "200": { + "description": "ๅฟœ็ญ”ๆˆๅŠŸ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/ServicePostResponse" + }, + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ใ™ในใฆใฎใƒชใ‚ฏใ‚จใ‚นใƒˆใซๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚Œใ‚‹ไธ€ๆ„ใฎ IDใ€‚UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚จใƒฉใƒผใจๆ€ใ‚ใ‚Œใ‚‹ไฝ•ใ‚‰ใ‹ใฎๅŽŸๅ› ใซใ‚ˆใ‚Šใ€ใ‚ตใƒผใƒใƒผใŒใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’ๅ‡ฆ็†ใงใใชใ„ใ€ใพใŸใฏๅ‡ฆ็†ใ—ใชใ„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 400 + }, + "error": { + "type": "string", + "description": "่ฉณ็ดฐใชใ‚จใƒฉใƒผใฎ่ชฌๆ˜Ž." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/services/:serviceId": { + "get": { + "summary": "ใ‚ตใƒผใƒ“ใ‚นใฎ่ฉณ็ดฐใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "description": "็ต„็น”ใซๅฑžใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใ‚’่ฟ”ใ—ใพใ™", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ใ‚ตใƒผใƒ“ใ‚นใ‚’ๆ‰€ๆœ‰ใ™ใ‚‹็ต„็น”ใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service ID", + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸใ‚ตใƒผใƒ“ใ‚นใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "ๅฟœ็ญ”ๆˆๅŠŸ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Service" + }, + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ใ™ในใฆใฎใƒชใ‚ฏใ‚จใ‚นใƒˆใซๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚Œใ‚‹ไธ€ๆ„ใฎ IDใ€‚UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚จใƒฉใƒผใจๆ€ใ‚ใ‚Œใ‚‹ไฝ•ใ‚‰ใ‹ใฎๅŽŸๅ› ใซใ‚ˆใ‚Šใ€ใ‚ตใƒผใƒใƒผใŒใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’ๅ‡ฆ็†ใงใใชใ„ใ€ใพใŸใฏๅ‡ฆ็†ใ—ใชใ„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 400 + }, + "error": { + "type": "string", + "description": "่ฉณ็ดฐใชใ‚จใƒฉใƒผใฎ่ชฌๆ˜Ž." + } + } + } + } + } + } + } + }, + "patch": { + "summary": "ใ‚ตใƒผใƒ“ใ‚นใฎๅŸบๆœฌๆƒ…ๅ ฑใ‚’ๆ›ดๆ–ฐใ™ใ‚‹.", + "description": "ใ‚ตใƒผใƒ“ใ‚นๅใ‚„IPใ‚ขใ‚ฏใ‚ปใ‚นใƒชใ‚นใƒˆใชใฉใฎๅŸบๆœฌ็š„ใชใ‚ตใƒผใƒ“ใ‚น่ฉณ็ดฐใ‚’ๆ›ดๆ–ฐใ—ใพใ™.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ใ‚ตใƒผใƒ“ใ‚นใ‚’ๆ‰€ๆœ‰ใ™ใ‚‹็ต„็น”ใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service ID", + "description": "ๆ›ดๆ–ฐใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServicePatchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "ๅฟœ็ญ”ๆˆๅŠŸ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Service" + }, + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ใ™ในใฆใฎใƒชใ‚ฏใ‚จใ‚นใƒˆใซๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚Œใ‚‹ไธ€ๆ„ใฎ IDใ€‚UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚จใƒฉใƒผใจๆ€ใ‚ใ‚Œใ‚‹ไฝ•ใ‚‰ใ‹ใฎๅŽŸๅ› ใซใ‚ˆใ‚Šใ€ใ‚ตใƒผใƒใƒผใŒใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’ๅ‡ฆ็†ใงใใชใ„ใ€ใพใŸใฏๅ‡ฆ็†ใ—ใชใ„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 400 + }, + "error": { + "type": "string", + "description": "่ฉณ็ดฐใชใ‚จใƒฉใƒผใฎ่ชฌๆ˜Ž." + } + } + } + } + } + } + } + }, + "delete": { + "summary": "ใ‚ตใƒผใƒ“ใ‚นใ‚’ๅ‰Š้™ค.", + "description": "ใ‚ตใƒผใƒ“ใ‚นใ‚’ๅ‰Š้™คใ—ใพใ™ใ€‚ใ‚ตใƒผใƒ“ใ‚นใฏๅœๆญข็Šถๆ…‹ใงใ‚ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใ€ใ“ใฎใƒกใ‚ฝใƒƒใƒ‰ๅ‘ผใณๅ‡บใ—ๅพŒใซ้žๅŒๆœŸ็š„ใซๅ‰Š้™คใ•ใ‚Œใพใ™ใ€‚.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ใ‚ตใƒผใƒ“ใ‚นใ‚’ๆ‰€ๆœ‰ใ™ใ‚‹็ต„็น”ใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service ID", + "description": "ๅ‰Š้™คใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ] + } + }, + "/v1/organizations/:organizationId/services/:serviceId/state": { + "patch": { + "summary": "ใ‚ตใƒผใƒ“ใ‚น็Šถๆ…‹ใฎๆ›ดๆ–ฐ.", + "description": "ใ‚ตใƒผใƒ“ใ‚นใ‚’้–‹ๅง‹ใพใŸใฏๅœๆญขใ™ใ‚‹", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ใ‚ตใƒผใƒ“ใ‚นใ‚’ๆ‰€ๆœ‰ใ™ใ‚‹็ต„็น”ใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service ID", + "description": "็Šถๆ…‹ใ‚’ๆ›ดๆ–ฐใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServiceStatePatchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "ๅฟœ็ญ”ๆˆๅŠŸ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Service" + }, + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ใ™ในใฆใฎใƒชใ‚ฏใ‚จใ‚นใƒˆใซๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚Œใ‚‹ไธ€ๆ„ใฎ IDใ€‚UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚จใƒฉใƒผใจๆ€ใ‚ใ‚Œใ‚‹ไฝ•ใ‚‰ใ‹ใฎๅŽŸๅ› ใซใ‚ˆใ‚Šใ€ใ‚ตใƒผใƒใƒผใŒใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’ๅ‡ฆ็†ใงใใชใ„ใ€ใพใŸใฏๅ‡ฆ็†ใ—ใชใ„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 400 + }, + "error": { + "type": "string", + "description": "่ฉณ็ดฐใชใ‚จใƒฉใƒผใฎ่ชฌๆ˜Ž." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/services/:serviceId/scaling": { + "patch": { + "summary": "ใ‚ตใƒผใƒ“ใ‚นใฎ่‡ชๅ‹•ใ‚นใ‚ฑใƒผใƒชใƒณใ‚ฐ่จญๅฎšใ‚’ๆ›ดๆ–ฐใ™ใ‚‹.", + "description": "ใ‚ตใƒผใƒ“ใ‚นใฎๆœ€ๅฐใŠใ‚ˆใณๆœ€ๅคงๅˆ่จˆใƒกใƒขใƒชๅˆถ้™ใจใ‚ขใ‚คใƒ‰ใƒซ ใƒขใƒผใƒ‰ใฎใ‚นใ‚ฑใƒผใƒชใƒณใ‚ฐๅ‹•ไฝœใ‚’ๆ›ดๆ–ฐใ—ใพใ™ใ€‚ใƒกใƒขใƒช่จญๅฎšใฏใ€Œใƒ—ใƒญใƒ€ใ‚ฏใ‚ทใƒงใƒณใ€ใ‚ตใƒผใƒ“ใ‚นใงใฎใฟไฝฟ็”จๅฏ่ƒฝใงใ€24 GB ใ‹ใ‚‰ๅง‹ใพใ‚‹ 12 ใฎๅ€ๆ•ฐใงใ‚ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ใ‚ตใƒผใƒ“ใ‚นใ‚’ๆ‰€ๆœ‰ใ™ใ‚‹็ต„็น”ใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service ID", + "description": "ใ‚นใ‚ฑใƒผใƒชใƒณใ‚ฐใƒ‘ใƒฉใƒกใƒผใ‚ฟใ‚’ๆ›ดๆ–ฐใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServiceScalingPatchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "ๅฟœ็ญ”ๆˆๅŠŸ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Service" + }, + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ใ™ในใฆใฎใƒชใ‚ฏใ‚จใ‚นใƒˆใซๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚Œใ‚‹ไธ€ๆ„ใฎ IDใ€‚UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚จใƒฉใƒผใจๆ€ใ‚ใ‚Œใ‚‹ไฝ•ใ‚‰ใ‹ใฎๅŽŸๅ› ใซใ‚ˆใ‚Šใ€ใ‚ตใƒผใƒใƒผใŒใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’ๅ‡ฆ็†ใงใใชใ„ใ€ใพใŸใฏๅ‡ฆ็†ใ—ใชใ„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 400 + }, + "error": { + "type": "string", + "description": "่ฉณ็ดฐใชใ‚จใƒฉใƒผใฎ่ชฌๆ˜Ž." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/services/:serviceId/password": { + "patch": { + "summary": "ใ‚ตใƒผใƒ“ใ‚นใƒ‘ใ‚นใƒฏใƒผใƒ‰ใ‚’ๆ›ดๆ–ฐใ™ใ‚‹.", + "description": "ใ‚ตใƒผใƒ“ใ‚นใฎๆ–ฐใ—ใ„ใƒ‘ใ‚นใƒฏใƒผใƒ‰ใ‚’่จญๅฎšใ—ใพใ™", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ใ‚ตใƒผใƒ“ใ‚นใ‚’ๆ‰€ๆœ‰ใ™ใ‚‹็ต„็น”ใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service ID", + "description": "ใƒ‘ใ‚นใƒฏใƒผใƒ‰ใ‚’ๆ›ดๆ–ฐใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServicePasswordPatchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "ๅฟœ็ญ”ๆˆๅŠŸ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/ServicePasswordPatchResponse" + }, + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ใ™ในใฆใฎใƒชใ‚ฏใ‚จใ‚นใƒˆใซๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚Œใ‚‹ไธ€ๆ„ใฎ IDใ€‚UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚จใƒฉใƒผใจๆ€ใ‚ใ‚Œใ‚‹ไฝ•ใ‚‰ใ‹ใฎๅŽŸๅ› ใซใ‚ˆใ‚Šใ€ใ‚ตใƒผใƒใƒผใŒใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’ๅ‡ฆ็†ใงใใชใ„ใ€ใพใŸใฏๅ‡ฆ็†ใ—ใชใ„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 400 + }, + "error": { + "type": "string", + "description": "่ฉณ็ดฐใชใ‚จใƒฉใƒผใฎ่ชฌๆ˜Ž." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/services/:serviceId/backups": { + "get": { + "summary": "ใ‚ตใƒผใƒ“ใ‚น ใƒใƒƒใ‚ฏใ‚ขใƒƒใƒ—ใฎใƒชใ‚นใƒˆ", + "description": "ใ‚ตใƒผใƒ“ใ‚นใฎใ™ในใฆใฎใƒใƒƒใ‚ฏใ‚ขใƒƒใƒ—ใฎใƒชใ‚นใƒˆใ‚’่ฟ”ใ—ใพใ™.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ใƒใƒƒใ‚ฏใ‚ขใƒƒใƒ—ใ‚’ๆ‰€ๆœ‰ใ™ใ‚‹็ต„็น”ใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service ID", + "description": "ใƒใƒƒใ‚ฏใ‚ขใƒƒใƒ—ใŒไฝœๆˆใ•ใ‚ŒใŸใ‚ตใƒผใƒ“ใ‚นใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "ๅฟœ็ญ”ๆˆๅŠŸ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Backup" + } + }, + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ใ™ในใฆใฎใƒชใ‚ฏใ‚จใ‚นใƒˆใซๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚Œใ‚‹ไธ€ๆ„ใฎ IDใ€‚UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚จใƒฉใƒผใจๆ€ใ‚ใ‚Œใ‚‹ไฝ•ใ‚‰ใ‹ใฎๅŽŸๅ› ใซใ‚ˆใ‚Šใ€ใ‚ตใƒผใƒใƒผใŒใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’ๅ‡ฆ็†ใงใใชใ„ใ€ใพใŸใฏๅ‡ฆ็†ใ—ใชใ„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 400 + }, + "error": { + "type": "string", + "description": "่ฉณ็ดฐใชใ‚จใƒฉใƒผใฎ่ชฌๆ˜Ž." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/services/:serviceId/backups/:backupId": { + "get": { + "summary": "ใƒใƒƒใ‚ฏใ‚ขใƒƒใƒ—ใฎ่ฉณ็ดฐใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "description": "ๅ˜ไธ€ใฎใƒใƒƒใ‚ฏใ‚ขใƒƒใƒ—ๆƒ…ๅ ฑใ‚’่ฟ”ใ—ใพใ™.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ใƒใƒƒใ‚ฏใ‚ขใƒƒใƒ—ใ‚’ๆ‰€ๆœ‰ใ™ใ‚‹็ต„็น”ใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service ID", + "description": "ใƒใƒƒใ‚ฏใ‚ขใƒƒใƒ—ใŒไฝœๆˆใ•ใ‚ŒใŸใ‚ตใƒผใƒ“ใ‚นใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service backup ID", + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸใƒใƒƒใ‚ฏใ‚ขใƒƒใƒ—ใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "ๅฟœ็ญ”ๆˆๅŠŸ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Backup" + }, + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ใ™ในใฆใฎใƒชใ‚ฏใ‚จใ‚นใƒˆใซๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚Œใ‚‹ไธ€ๆ„ใฎ IDใ€‚UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚จใƒฉใƒผใจๆ€ใ‚ใ‚Œใ‚‹ไฝ•ใ‚‰ใ‹ใฎๅŽŸๅ› ใซใ‚ˆใ‚Šใ€ใ‚ตใƒผใƒใƒผใŒใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’ๅ‡ฆ็†ใงใใชใ„ใ€ใพใŸใฏๅ‡ฆ็†ใ—ใชใ„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 400 + }, + "error": { + "type": "string", + "description": "่ฉณ็ดฐใชใ‚จใƒฉใƒผใฎ่ชฌๆ˜Ž." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/keys": { + "get": { + "summary": "ใ™ในใฆใฎใ‚ญใƒผใฎใƒชใ‚นใƒˆใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "description": "็ต„็น”ๅ†…ใฎใ™ในใฆใฎใ‚ญใƒผใฎใƒชใ‚นใƒˆใ‚’่ฟ”ใ—ใพใ™.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸ็ต„็น”ใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "ๅฟœ็ญ”ๆˆๅŠŸ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApiKey" + } + }, + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ใ™ในใฆใฎใƒชใ‚ฏใ‚จใ‚นใƒˆใซๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚Œใ‚‹ไธ€ๆ„ใฎ IDใ€‚UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚จใƒฉใƒผใจๆ€ใ‚ใ‚Œใ‚‹ไฝ•ใ‚‰ใ‹ใฎๅŽŸๅ› ใซใ‚ˆใ‚Šใ€ใ‚ตใƒผใƒใƒผใŒใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’ๅ‡ฆ็†ใงใใชใ„ใ€ใพใŸใฏๅ‡ฆ็†ใ—ใชใ„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 400 + }, + "error": { + "type": "string", + "description": "่ฉณ็ดฐใชใ‚จใƒฉใƒผใฎ่ชฌๆ˜Ž." + } + } + } + } + } + } + } + }, + "post": { + "summary": "ใ‚ญใƒผใ‚’ไฝœๆˆ", + "description": "ๆ–ฐใ—ใ„APIใ‚ญใƒผใ‚’ไฝœๆˆใ—ใพใ™.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ใ‚ญใƒผใ‚’ๆ‰€ๆœ‰ใ™ใ‚‹็ต„็น”ใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiKeyPostRequest" + } + } + } + }, + "responses": { + "200": { + "description": "ๅฟœ็ญ”ๆˆๅŠŸ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/ApiKeyPostResponse" + }, + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ใ™ในใฆใฎใƒชใ‚ฏใ‚จใ‚นใƒˆใซๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚Œใ‚‹ไธ€ๆ„ใฎ IDใ€‚UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚จใƒฉใƒผใจๆ€ใ‚ใ‚Œใ‚‹ไฝ•ใ‚‰ใ‹ใฎๅŽŸๅ› ใซใ‚ˆใ‚Šใ€ใ‚ตใƒผใƒใƒผใŒใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’ๅ‡ฆ็†ใงใใชใ„ใ€ใพใŸใฏๅ‡ฆ็†ใ—ใชใ„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 400 + }, + "error": { + "type": "string", + "description": "่ฉณ็ดฐใชใ‚จใƒฉใƒผใฎ่ชฌๆ˜Ž." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/keys/:keyId": { + "get": { + "summary": "้‡่ฆใช่ฉณ็ดฐใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "description": "ๅ˜ไธ€ใฎใ‚ญใƒผใฎ่ฉณ็ดฐใ‚’่ฟ”ใ—ใพใ™.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸ็ต„็น”ใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "API key ID", + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸใ‚ญใƒผใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "ๅฟœ็ญ”ๆˆๅŠŸ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/ApiKey" + }, + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ใ™ในใฆใฎใƒชใ‚ฏใ‚จใ‚นใƒˆใซๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚Œใ‚‹ไธ€ๆ„ใฎ IDใ€‚UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚จใƒฉใƒผใจๆ€ใ‚ใ‚Œใ‚‹ไฝ•ใ‚‰ใ‹ใฎๅŽŸๅ› ใซใ‚ˆใ‚Šใ€ใ‚ตใƒผใƒใƒผใŒใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’ๅ‡ฆ็†ใงใใชใ„ใ€ใพใŸใฏๅ‡ฆ็†ใ—ใชใ„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 400 + }, + "error": { + "type": "string", + "description": "่ฉณ็ดฐใชใ‚จใƒฉใƒผใฎ่ชฌๆ˜Ž." + } + } + } + } + } + } + } + }, + "patch": { + "summary": "ๆ›ดๆ–ฐใ‚ญใƒผ", + "description": "APIใ‚ญใƒผใฎใƒ—ใƒญใƒ‘ใƒ†ใ‚ฃใ‚’ๆ›ดๆ–ฐใ—ใพใ™.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ใ‚ญใƒผใ‚’ๆ‰€ๆœ‰ใ™ใ‚‹็ต„็น”ใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "API key ID", + "description": "ๆ›ดๆ–ฐใ™ใ‚‹ใ‚ญใƒผใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiKeyPatchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "ๅฟœ็ญ”ๆˆๅŠŸ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/ApiKey" + }, + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ใ™ในใฆใฎใƒชใ‚ฏใ‚จใ‚นใƒˆใซๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚Œใ‚‹ไธ€ๆ„ใฎ IDใ€‚UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚จใƒฉใƒผใจๆ€ใ‚ใ‚Œใ‚‹ไฝ•ใ‚‰ใ‹ใฎๅŽŸๅ› ใซใ‚ˆใ‚Šใ€ใ‚ตใƒผใƒใƒผใŒใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’ๅ‡ฆ็†ใงใใชใ„ใ€ใพใŸใฏๅ‡ฆ็†ใ—ใชใ„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 400 + }, + "error": { + "type": "string", + "description": "่ฉณ็ดฐใชใ‚จใƒฉใƒผใฎ่ชฌๆ˜Ž." + } + } + } + } + } + } + } + }, + "delete": { + "summary": "ๅ‰Š้™คใ‚ญใƒผ", + "description": "APIใ‚ญใƒผใ‚’ๅ‰Š้™คใ—ใพใ™ใ€‚ใ‚ขใ‚ฏใƒ†ใ‚ฃใƒ–ใชใƒชใ‚ฏใ‚จใ‚นใƒˆใฎ่ช่จผใซไฝฟ็”จใ•ใ‚Œใฆใ„ใชใ„ใ‚ญใƒผใฎใฟๅ‰Š้™คใงใใพใ™ใ€‚.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ใ‚ญใƒผใ‚’ๆ‰€ๆœ‰ใ™ใ‚‹็ต„็น”ใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "API key ID", + "description": "ๅ‰Š้™คใ™ใ‚‹ใ‚ญใƒผใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ] + } + }, + "/v1/organizations/:organizationId/members": { + "get": { + "summary": "็ต„็น”ใƒกใƒณใƒใƒผใฎไธ€่ฆง", + "description": "็ต„็น”ๅ†…ใฎใ™ในใฆใฎใƒกใƒณใƒใƒผใฎใƒชใ‚นใƒˆใ‚’่ฟ”ใ—ใพใ™.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸ็ต„็น”ใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "ๅฟœ็ญ”ๆˆๅŠŸ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Member" + } + }, + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ใ™ในใฆใฎใƒชใ‚ฏใ‚จใ‚นใƒˆใซๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚Œใ‚‹ไธ€ๆ„ใฎ IDใ€‚UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚จใƒฉใƒผใจๆ€ใ‚ใ‚Œใ‚‹ไฝ•ใ‚‰ใ‹ใฎๅŽŸๅ› ใซใ‚ˆใ‚Šใ€ใ‚ตใƒผใƒใƒผใŒใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’ๅ‡ฆ็†ใงใใชใ„ใ€ใพใŸใฏๅ‡ฆ็†ใ—ใชใ„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 400 + }, + "error": { + "type": "string", + "description": "่ฉณ็ดฐใชใ‚จใƒฉใƒผใฎ่ชฌๆ˜Ž." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/members/:userId": { + "get": { + "summary": "ใƒกใƒณใƒใƒผใฎ่ฉณ็ดฐใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "description": "ๅ˜ไธ€ใฎ็ต„็น”ใƒกใƒณใƒใƒผใฎ่ฉณ็ดฐใ‚’่ฟ”ใ—ใพใ™.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ใƒกใƒณใƒใƒผใŒๆ‰€ๅฑžใ™ใ‚‹็ต„็น”ใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "User ID", + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸใƒฆใƒผใ‚ถใƒผใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "ๅฟœ็ญ”ๆˆๅŠŸ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Member" + }, + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ใ™ในใฆใฎใƒชใ‚ฏใ‚จใ‚นใƒˆใซๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚Œใ‚‹ไธ€ๆ„ใฎ IDใ€‚UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚จใƒฉใƒผใจๆ€ใ‚ใ‚Œใ‚‹ไฝ•ใ‚‰ใ‹ใฎๅŽŸๅ› ใซใ‚ˆใ‚Šใ€ใ‚ตใƒผใƒใƒผใŒใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’ๅ‡ฆ็†ใงใใชใ„ใ€ใพใŸใฏๅ‡ฆ็†ใ—ใชใ„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 400 + }, + "error": { + "type": "string", + "description": "่ฉณ็ดฐใชใ‚จใƒฉใƒผใฎ่ชฌๆ˜Ž." + } + } + } + } + } + } + } + }, + "patch": { + "summary": "็ต„็น”ใƒกใƒณใƒใƒผใฎๆ›ดๆ–ฐ.", + "description": "็ต„็น”ใƒกใƒณใƒใƒผใฎๅฝนๅ‰ฒใ‚’ๆ›ดๆ–ฐ.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ใƒกใƒณใƒใƒผใŒๆ‰€ๅฑžใ™ใ‚‹็ต„็น”ใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "User ID", + "description": "ใƒ‘ใƒƒใƒใ‚’้ฉ็”จใ™ใ‚‹ใƒฆใƒผใ‚ถใƒผใฎID", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MemberPatchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "ๅฟœ็ญ”ๆˆๅŠŸ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Member" + }, + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ใ™ในใฆใฎใƒชใ‚ฏใ‚จใ‚นใƒˆใซๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚Œใ‚‹ไธ€ๆ„ใฎ IDใ€‚UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚จใƒฉใƒผใจๆ€ใ‚ใ‚Œใ‚‹ไฝ•ใ‚‰ใ‹ใฎๅŽŸๅ› ใซใ‚ˆใ‚Šใ€ใ‚ตใƒผใƒใƒผใŒใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’ๅ‡ฆ็†ใงใใชใ„ใ€ใพใŸใฏๅ‡ฆ็†ใ—ใชใ„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 400 + }, + "error": { + "type": "string", + "description": "่ฉณ็ดฐใชใ‚จใƒฉใƒผใฎ่ชฌๆ˜Ž." + } + } + } + } + } + } + } + }, + "delete": { + "summary": "็ต„็น”ใƒกใƒณใƒใƒผใ‚’ๅ‰Š้™คใ™ใ‚‹", + "description": "็ต„็น”ใ‹ใ‚‰ใƒฆใƒผใ‚ถใƒผใ‚’ๅ‰Š้™คใ—ใพใ™", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸ็ต„็น”ใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "User ID", + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸใƒฆใƒผใ‚ถใƒผใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ] + } + }, + "/v1/organizations/:organizationId/invitations": { + "get": { + "summary": "ใ™ในใฆใฎๆ‹›ๅพ…็Šถใ‚’ไธ€่ฆง่กจ็คบใ™ใ‚‹", + "description": "ใ™ในใฆใฎ็ต„็น”ใฎๆ‹›ๅพ…ใฎใƒชใ‚นใƒˆใ‚’่ฟ”ใ—ใพใ™.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸ็ต„็น”ใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "ๅฟœ็ญ”ๆˆๅŠŸ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Invitation" + } + }, + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ใ™ในใฆใฎใƒชใ‚ฏใ‚จใ‚นใƒˆใซๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚Œใ‚‹ไธ€ๆ„ใฎ IDใ€‚UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚จใƒฉใƒผใจๆ€ใ‚ใ‚Œใ‚‹ไฝ•ใ‚‰ใ‹ใฎๅŽŸๅ› ใซใ‚ˆใ‚Šใ€ใ‚ตใƒผใƒใƒผใŒใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’ๅ‡ฆ็†ใงใใชใ„ใ€ใพใŸใฏๅ‡ฆ็†ใ—ใชใ„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 400 + }, + "error": { + "type": "string", + "description": "่ฉณ็ดฐใชใ‚จใƒฉใƒผใฎ่ชฌๆ˜Ž." + } + } + } + } + } + } + } + }, + "post": { + "summary": "ๆ‹›ๅพ…็Šถใ‚’ไฝœๆˆใ™ใ‚‹", + "description": "็ต„็น”ใฎๆ‹›ๅพ…็Šถใ‚’ไฝœๆˆใ™ใ‚‹.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ใƒฆใƒผใ‚ถใƒผใ‚’ๆ‹›ๅพ…ใ™ใ‚‹็ต„็น”ใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InvitationPostRequest" + } + } + } + }, + "responses": { + "200": { + "description": "ๅฟœ็ญ”ๆˆๅŠŸ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Invitation" + }, + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ใ™ในใฆใฎใƒชใ‚ฏใ‚จใ‚นใƒˆใซๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚Œใ‚‹ไธ€ๆ„ใฎ IDใ€‚UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚จใƒฉใƒผใจๆ€ใ‚ใ‚Œใ‚‹ไฝ•ใ‚‰ใ‹ใฎๅŽŸๅ› ใซใ‚ˆใ‚Šใ€ใ‚ตใƒผใƒใƒผใŒใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’ๅ‡ฆ็†ใงใใชใ„ใ€ใพใŸใฏๅ‡ฆ็†ใ—ใชใ„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 400 + }, + "error": { + "type": "string", + "description": "่ฉณ็ดฐใชใ‚จใƒฉใƒผใฎ่ชฌๆ˜Ž." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/invitations/:invitationId": { + "get": { + "summary": "ๆ‹›ๅพ…ใฎ่ฉณ็ดฐใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "description": "ๅ˜ไธ€ใฎ็ต„็น”ๆ‹›ๅพ…ใฎ่ฉณ็ดฐใ‚’่ฟ”ใ—ใพใ™.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸ็ต„็น”ใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Organization invitation ID", + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸ็ต„็น”ใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "ๅฟœ็ญ”ๆˆๅŠŸ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Invitation" + }, + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ใ™ในใฆใฎใƒชใ‚ฏใ‚จใ‚นใƒˆใซๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚Œใ‚‹ไธ€ๆ„ใฎ IDใ€‚UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚จใƒฉใƒผใจๆ€ใ‚ใ‚Œใ‚‹ไฝ•ใ‚‰ใ‹ใฎๅŽŸๅ› ใซใ‚ˆใ‚Šใ€ใ‚ตใƒผใƒใƒผใŒใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’ๅ‡ฆ็†ใงใใชใ„ใ€ใพใŸใฏๅ‡ฆ็†ใ—ใชใ„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 400 + }, + "error": { + "type": "string", + "description": "่ฉณ็ดฐใชใ‚จใƒฉใƒผใฎ่ชฌๆ˜Ž." + } + } + } + } + } + } + } + }, + "delete": { + "summary": "็ต„็น”ใฎๆ‹›ๅพ…ใ‚’ๅ‰Š้™คใ™ใ‚‹", + "description": "ๅ˜ไธ€ใฎ็ต„็น”ๆ‹›ๅพ…ใ‚’ๅ‰Š้™คใ—ใพใ™.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ๆ‹›ๅพ…ใ‚’ๅ—ใ‘ใŸ็ต„็น”ใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Organization invitation ID", + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸ็ต„็น”ใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ] + } + }, + "/v1/organizations/:organizationId/activities": { + "get": { + "summary": "ๅ›ฃไฝ“ๆดปๅ‹•ไธ€่ฆง", + "description": "ใ™ในใฆใฎ็ต„็น”ๆดปๅ‹•ใฎใƒชใ‚นใƒˆใ‚’่ฟ”ใ—ใพใ™.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸ็ต„็น”ใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "ๅฟœ็ญ”ๆˆๅŠŸ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Activity" + } + }, + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ใ™ในใฆใฎใƒชใ‚ฏใ‚จใ‚นใƒˆใซๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚Œใ‚‹ไธ€ๆ„ใฎ IDใ€‚UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚จใƒฉใƒผใจๆ€ใ‚ใ‚Œใ‚‹ไฝ•ใ‚‰ใ‹ใฎๅŽŸๅ› ใซใ‚ˆใ‚Šใ€ใ‚ตใƒผใƒใƒผใŒใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’ๅ‡ฆ็†ใงใใชใ„ใ€ใพใŸใฏๅ‡ฆ็†ใ—ใชใ„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 400 + }, + "error": { + "type": "string", + "description": "่ฉณ็ดฐใชใ‚จใƒฉใƒผใฎ่ชฌๆ˜Ž." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/activities/:activityId": { + "get": { + "summary": "็ต„็น”ๆดปๅ‹•", + "description": "IDใงๅ˜ไธ€ใฎ็ต„็น”ใ‚ขใ‚ฏใƒ†ใ‚ฃใƒ“ใƒ†ใ‚ฃใ‚’่ฟ”ใ—ใพใ™.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸ็ต„็น”ใฎID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Activity ID", + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸใ‚ขใ‚ฏใƒ†ใ‚ฃใƒ“ใƒ†ใ‚ฃใฎID.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "ๅฟœ็ญ”ๆˆๅŠŸ", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Activity" + }, + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "ใ™ในใฆใฎใƒชใ‚ฏใ‚จใ‚นใƒˆใซๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚Œใ‚‹ไธ€ๆ„ใฎ IDใ€‚UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚จใƒฉใƒผใจๆ€ใ‚ใ‚Œใ‚‹ไฝ•ใ‚‰ใ‹ใฎๅŽŸๅ› ใซใ‚ˆใ‚Šใ€ใ‚ตใƒผใƒใƒผใŒใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’ๅ‡ฆ็†ใงใใชใ„ใ€ใพใŸใฏๅ‡ฆ็†ใ—ใชใ„.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ณใƒผใƒ‰.", + "example": 400 + }, + "error": { + "type": "string", + "description": "่ฉณ็ดฐใชใ‚จใƒฉใƒผใฎ่ชฌๆ˜Ž." + } + } + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "ServiceEndpoint": { + "properties": { + "protocol": { + "type": "string", + "description": "ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆ ใƒ—ใƒญใƒˆใ‚ณใƒซ: 'https'ใ€'nativesecure'ใ€'mysql'.", + "enum": [ + "https", + "nativesecure", + "mysql" + ] + }, + "host": { + "type": "string", + "description": "ใ‚ตใƒผใƒ“ใ‚นใƒ›ใ‚นใƒˆๅ" + }, + "port": { + "type": "number", + "description": "ๆ•ฐๅ€คใƒใƒผใƒˆ" + } + } + }, + "IpAccessListEntry": { + "properties": { + "source": { + "type": "string", + "description": "IP ใพใŸใฏ CIDR" + }, + "description": { + "type": "string", + "description": "IPv4ใ‚ขใƒ‰ใƒฌใ‚นใพใŸใฏIPv4 CIDRใงใ‚ขใ‚ฏใ‚ปใ‚นใ‚’่จฑๅฏใ™ใ‚‹" + } + } + }, + "Service": { + "properties": { + "id": { + "type": "string", + "description": "ๅ›บๆœ‰ใฎใ‚ตใƒผใƒ“ใ‚นID.", + "format": "uuid" + }, + "name": { + "type": "string", + "description": "ใ‚ตใƒผใƒ“ใ‚นๅ." + }, + "provider": { + "type": "string", + "description": "ใ‚ฏใƒฉใ‚ฆใƒ‰ใƒ—ใƒญใƒใ‚คใƒ€ใƒผ", + "enum": [ + "aws", + "gcp" + ] + }, + "region": { + "type": "string", + "description": "ใ‚ตใƒผใƒ“ใ‚นๅœฐๅŸŸ.", + "enum": [ + "ap-south-1", + "ap-southeast-1", + "eu-central-1", + "eu-west-1", + "us-east-1", + "us-east-2", + "us-west-2", + "ap-southeast-2", + "us-east1", + "us-central1", + "europe-west4", + "asia-southeast1" + ] + }, + "state": { + "type": "string", + "description": "ใ‚ตใƒผใƒ“ใ‚นใฎ็พ็Šถ.", + "enum": [ + "starting", + "stopping", + "terminating", + "provisioning", + "running", + "stopped", + "terminated", + "degraded", + "failed", + "idle" + ] + }, + "endpoints": { + "type": "array", + "description": "ใ™ในใฆใฎใ‚ตใƒผใƒ“ใ‚นใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฎใƒชใ‚นใƒˆ.", + "items": { + "$ref": "#/components/schemas/ServiceEndpoint" + } + }, + "tier": { + "type": "string", + "description": "ใ‚ตใƒผใƒ“ใ‚นใฎ้šŽๅฑค: ใ€Œ้–‹็™บใ€ใ€ใ€Œๆœฌ็•ชใ€ใ€ใ€Œๅฐ‚็”จ้ซ˜ใƒกใƒขใƒชใ€ใ€ใ€Œๅฐ‚็”จ้ซ˜CPUใ€ใ€ใ€Œๅฐ‚็”จๆจ™ๆบ–ใ€ใ€‚ๆœฌ็•ชใ‚ตใƒผใƒ“ใ‚นใฎใ‚นใ‚ฑใƒผใƒซใ€้–‹็™บใฏๅ›บๅฎšใ‚ตใ‚คใ‚บใงใ™.", + "enum": [ + "development", + "production", + "dedicated_high_mem", + "dedicated_high_cpu", + "dedicated_standard" + ] + }, + "minTotalMemoryGb": { + "type": "number", + "description": "่‡ชๅ‹•ใ‚นใ‚ฑใƒผใƒชใƒณใ‚ฐไธญใฎใ™ในใฆใฎใƒฏใƒผใ‚ซใƒผใฎๆœ€ๅฐๅˆ่จˆใƒกใƒขใƒช๏ผˆGB๏ผ‰ใ€‚ใ€Œๆœฌ็•ชใ€ใ‚ตใƒผใƒ“ใ‚นใงใฎใฟไฝฟ็”จๅฏ่ƒฝใ€‚12 ใฎๅ€ๆ•ฐใงใ€24 ใ‚ˆใ‚Šๅคงใใ„ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚.", + "minimum": 24, + "maximum": 720, + "multipleOf": 12, + "example": 48 + }, + "maxTotalMemoryGb": { + "type": "number", + "description": "่‡ชๅ‹•ใ‚นใ‚ฑใƒผใƒชใƒณใ‚ฐไธญใฎใ™ในใฆใฎใƒฏใƒผใ‚ซใƒผใฎๆœ€ๅคงๅˆ่จˆใƒกใƒขใƒช (GB)ใ€‚ใ€Œใƒ—ใƒญใƒ€ใ‚ฏใ‚ทใƒงใƒณใ€ใ‚ตใƒผใƒ“ใ‚นใงใฎใฟไฝฟ็”จใงใใพใ™ใ€‚็„กๆ–™ใ‚ตใƒผใƒ“ใ‚นใฎๅ ดๅˆใฏ 12 ใฎๅ€ๆ•ฐใง 360 ๆœชๆบ€ใ€ๆœ‰ๆ–™ใ‚ตใƒผใƒ“ใ‚นใฎๅ ดๅˆใฏ 720 ๆœชๆบ€ใงใ‚ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚.", + "minimum": 24, + "maximum": 720, + "multipleOf": 12, + "example": 360 + }, + "idleScaling": { + "type": "boolean", + "description": "true ใซ่จญๅฎšใ™ใ‚‹ใจใ€ใ‚ขใ‚คใƒ‰ใƒซๆ™‚ใซใ‚ตใƒผใƒ“ใ‚นใŒใ‚ผใƒญใซใ‚นใ‚ฑใƒผใƒซใƒ€ใ‚ฆใƒณใ•ใ‚Œใพใ™ใ€‚้–‹็™บใ‚ตใƒผใƒ“ใ‚นใงใฏๅธธใซ true ใงใ™ใ€‚." + }, + "idleTimeoutMinutes": { + "type": "number", + "description": "ๆœ€ๅฐใ‚ขใ‚คใƒ‰ใƒซใ‚ฟใ‚คใƒ ใ‚ขใ‚ฆใƒˆใ‚’่จญๅฎšใ—ใพใ™๏ผˆๅˆ†ๅ˜ไฝ๏ผ‰ใ€‚5ๅˆ†ไปฅไธŠใงใ‚ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™." + }, + "ipAccessList": { + "type": "array", + "description": "ใ‚ตใƒผใƒ“ใ‚นใธใฎใ‚ขใ‚ฏใ‚ปใ‚นใŒ่จฑๅฏใ•ใ‚ŒใŸ IP ใ‚ขใƒ‰ใƒฌใ‚นใฎใƒชใ‚นใƒˆ", + "items": { + "$ref": "#/components/schemas/IpAccessListEntry" + } + }, + "createdAt": { + "type": "string", + "description": "ใ‚ตใƒผใƒ“ใ‚นไฝœๆˆใ‚ฟใ‚คใƒ ใ‚นใ‚ฟใƒณใƒ—ใ€‚ISO-8601.", + "format": "date-time" + } + } + }, + "IpAccessListPatch": { + "properties": { + "add": { + "type": "array", + "description": "่ฟฝๅŠ ใ™ใ‚‹่ฆ็ด ใ€‚ใ€Œๅ‰Š้™คใ€้ƒจๅˆ†ใŒๅ‡ฆ็†ใ•ใ‚ŒใŸๅพŒใซๅฎŸ่กŒใ•ใ‚Œใพใ™.", + "items": { + "$ref": "#/components/schemas/IpAccessListEntry" + } + }, + "remove": { + "type": "array", + "description": "ๅ‰Š้™คใ™ใ‚‹่ฆ็ด ใ€‚ใ€Œ่ฟฝๅŠ ใ€้ƒจๅˆ†ใŒๅ‡ฆ็†ใ•ใ‚Œใ‚‹ๅ‰ใซๅฎŸ่กŒใ•ใ‚Œใพใ™.", + "items": { + "$ref": "#/components/schemas/IpAccessListEntry" + } + } + } + }, + "Activity": { + "properties": { + "id": { + "type": "string", + "description": "ไธ€ๆ„ใฎใ‚ขใ‚ฏใƒ†ใ‚ฃใƒ“ใƒ†ใ‚ฃID." + }, + "createdAt": { + "type": "string", + "description": "ใ‚ขใ‚ฏใƒ†ใ‚ฃใƒ“ใƒ†ใ‚ฃใฎใ‚ฟใ‚คใƒ ใ‚นใ‚ฟใƒณใƒ—ใ€‚ISO-8601.", + "format": "date-time" + }, + "type": { + "type": "string", + "description": "ๆดปๅ‹•ใฎ็จฎ้กž.", + "enum": [ + "organization_update_name", + "organization_invite_create", + "organization_invite_delete", + "organization_member_join", + "organization_member_add", + "organization_member_leave", + "organization_member_delete", + "organization_member_update_role", + "key_create", + "key_delete", + "service_create", + "service_start", + "service_stop", + "service_delete", + "service_update_name", + "service_update_ip_access_list", + "service_update_autoscaling_memory", + "service_update_autoscaling_idling", + "service_update_password", + "backup_delete" + ] + }, + "actorType": { + "type": "string", + "description": "ใ‚ขใ‚ฏใ‚ฟใƒผใฎใ‚ฟใ‚คใƒ—: ใ€Œใƒฆใƒผใ‚ถใƒผใ€ใ€ใ€Œใ‚ตใƒใƒผใƒˆใ€ใ€ใ€Œใ‚ทใ‚นใƒ†ใƒ ใ€ใ€ใ€ŒAPIใ€.", + "enum": [ + "user", + "support", + "system", + "api" + ] + }, + "actorId": { + "type": "string", + "description": "ใƒฆใƒ‹ใƒผใ‚ฏใชไฟณๅ„ชID." + }, + "actorDetails": { + "type": "string", + "description": "ไฟณๅ„ชใซ้–ขใ™ใ‚‹่ฟฝๅŠ ๆƒ…ๅ ฑ." + }, + "actorIpAddress": { + "type": "string", + "description": "ใ‚ขใ‚ฏใ‚ฟใƒผใฎ IP ใ‚ขใƒ‰ใƒฌใ‚นใ€‚'user' ใŠใ‚ˆใณ 'api' ใ‚ขใ‚ฏใ‚ฟใƒผ ใ‚ฟใ‚คใƒ—ใงๅฎš็พฉใ•ใ‚Œใพใ™ใ€‚." + }, + "organizationId": { + "type": "string", + "description": "ๆดปๅ‹•ใฎ็ฏ„ๅ›ฒ: ใ“ใฎๆดปๅ‹•ใŒ้–ข้€ฃใ™ใ‚‹็ต„็น”ID." + }, + "serviceId": { + "type": "string", + "description": "ใ‚ขใ‚ฏใƒ†ใ‚ฃใƒ“ใƒ†ใ‚ฃใฎ็ฏ„ๅ›ฒ: ใ“ใฎใ‚ขใ‚ฏใƒ†ใ‚ฃใƒ“ใƒ†ใ‚ฃใŒ้–ข้€ฃใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นID." + } + } + }, + "Backup": { + "properties": { + "id": { + "type": "string", + "description": "ไธ€ๆ„ใฎใƒใƒƒใ‚ฏใ‚ขใƒƒใƒ—ID.", + "format": "uuid" + }, + "status": { + "type": "string", + "description": "ใƒใƒƒใ‚ฏใ‚ขใƒƒใƒ—ใฎใ‚นใƒ†ใƒผใ‚ฟใ‚น: ใ€ŒๅฎŒไบ†ใ€ใ€ใ€Œใ‚จใƒฉใƒผใ€ใ€ใ€Œ้€ฒ่กŒไธญใ€.", + "enum": [ + "done", + "error", + "in_progress" + ] + }, + "serviceId": { + "type": "string", + "description": "ๅๅ‰" + }, + "startedAt": { + "type": "string", + "description": "ใƒใƒƒใ‚ฏใ‚ขใƒƒใƒ—้–‹ๅง‹ใ‚ฟใ‚คใƒ ใ‚นใ‚ฟใƒณใƒ—ใ€‚ISO-8601.", + "format": "date-time" + }, + "finishedAt": { + "type": "string", + "description": "ใƒใƒƒใ‚ฏใ‚ขใƒƒใƒ—็ต‚ไบ†ใ‚ฟใ‚คใƒ ใ‚นใ‚ฟใƒณใƒ—ใ€‚ISO-8601ใ€‚ๅฎŒไบ†ใ—ใŸใƒใƒƒใ‚ฏใ‚ขใƒƒใƒ—ใซใฎใฟไฝฟ็”จๅฏ่ƒฝ", + "format": "date-time" + } + } + }, + "Organization": { + "properties": { + "id": { + "type": "string", + "description": "ๅ›บๆœ‰ใฎ็ต„็น”ID.", + "format": "uuid" + }, + "createdAt": { + "type": "string", + "description": "็ต„็น”ใŒไฝœๆˆใ•ใ‚ŒใŸใ‚ฟใ‚คใƒ ใ‚นใ‚ฟใƒณใƒ—ใ€‚ISO-8601.", + "format": "date-time" + }, + "name": { + "type": "string", + "description": "็ต„็น”ๅ." + } + } + }, + "Member": { + "properties": { + "userId": { + "type": "string", + "description": "ๅ›บๆœ‰ใฎใƒฆใƒผใ‚ถใƒผIDใ€‚ใƒฆใƒผใ‚ถใƒผใŒ่ค‡ๆ•ฐใฎ็ต„็น”ใฎใƒกใƒณใƒใƒผใงใ‚ใ‚‹ๅ ดๅˆใ€ใ“ใฎIDใฏๅŒใ˜ใพใพใซใชใ‚Šใพใ™ใ€‚." + }, + "name": { + "type": "string", + "description": "ๅ€‹ไบบใƒฆใƒผใ‚ถใƒผใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซใซ่จญๅฎšใ•ใ‚ŒใŸใƒกใƒณใƒใƒผใฎๅๅ‰." + }, + "email": { + "type": "string", + "description": "ๅ€‹ไบบใƒฆใƒผใ‚ถใƒผใƒ—ใƒญใƒ•ใ‚ฃใƒผใƒซใซ่จญๅฎšใ•ใ‚Œใฆใ„ใ‚‹ใƒกใƒณใƒใƒผใฎใƒกใƒผใƒซใ‚ขใƒ‰ใƒฌใ‚น.", + "format": "email" + }, + "role": { + "type": "string", + "description": "็ต„็น”ใซใŠใ‘ใ‚‹ใƒกใƒณใƒใƒผใฎๅฝนๅ‰ฒ.", + "enum": [ + "admin", + "developer" + ] + }, + "joinedAt": { + "type": "string", + "description": "ใƒกใƒณใƒใƒผใŒ็ต„็น”ใซๅ‚ๅŠ ใ—ใŸใ‚ฟใ‚คใƒ ใ‚นใ‚ฟใƒณใƒ—ใ€‚ISO-8601.", + "format": "date-time" + } + } + }, + "Invitation": { + "properties": { + "role": { + "type": "string", + "description": "็ต„็น”ใซใŠใ‘ใ‚‹ใƒกใƒณใƒใƒผใฎๅฝนๅ‰ฒ.", + "enum": [ + "admin", + "developer" + ] + }, + "id": { + "type": "string", + "description": "ๅ›บๆœ‰ใฎๆ‹›ๅพ…ID.", + "format": "uuid" + }, + "email": { + "type": "string", + "description": "ๆ‹›ๅพ…ใ•ใ‚ŒใŸใƒฆใƒผใ‚ถใƒผใฎใƒกใƒผใƒซใ‚ขใƒ‰ใƒฌใ‚นใ€‚ใ“ใฎใƒกใƒผใƒซใ‚ขใƒ‰ใƒฌใ‚นใ‚’ๆŒใคใƒฆใƒผใ‚ถใƒผใฎใฟใŒๆ‹›ๅพ…ใ‚’ไฝฟ็”จใ—ใฆๅ‚ๅŠ ใงใใพใ™ใ€‚ใƒกใƒผใƒซใ‚ขใƒ‰ใƒฌใ‚นใฏๅฐๆ–‡ๅญ—ใงไฟๅญ˜ใ•ใ‚Œใพใ™ใ€‚.", + "format": "email" + }, + "createdAt": { + "type": "string", + "description": "ๆ‹›ๅพ…็Šถไฝœๆˆใ‚ฟใ‚คใƒ ใ‚นใ‚ฟใƒณใƒ—ใ€‚ISO-8601.", + "format": "date-time" + }, + "expireAt": { + "type": "string", + "description": "ๆ‹›ๅพ…ใฎๆœ‰ๅŠนๆœŸ้™ใ‚’ใ‚ฟใ‚คใƒ ใ‚นใ‚ฟใƒณใƒ—ใ—ใพใ™ใ€‚ISO-8601.", + "format": "date-time" + } + } + }, + "ApiKey": { + "properties": { + "id": { + "type": "string", + "description": "ไธ€ๆ„ใฎ API ใ‚ญใƒผ ID.", + "format": "uuid" + }, + "name": { + "type": "string", + "description": "ใ‚ญใƒผใฎๅๅ‰" + }, + "state": { + "type": "string", + "description": "ใ‚ญใƒผใฎ็Šถๆ…‹: ใ€Œๆœ‰ๅŠนใ€ใ€ใ€Œ็„กๅŠนใ€.", + "enum": [ + "enabled", + "disabled" + ] + }, + "roles": { + "type": "array", + "description": "ใ‚ญใƒผใซๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚ŒใŸใƒญใƒผใƒซใฎใƒชใ‚นใƒˆใ€‚ๅฐ‘ใชใใจใ‚‚ 1 ใคใฎ่ฆ็ด ใŒๅซใพใ‚Œใพใ™ใ€‚.", + "items": { + "type": "string", + "enum": [ + "admin", + "developer" + ] + } + }, + "keySuffix": { + "type": "string", + "description": "ใ‚ญใƒผใฎๆœ€ๅพŒใฎ4ๆ–‡ๅญ—." + }, + "createdAt": { + "type": "string", + "description": "ใ‚ญใƒผใŒไฝœๆˆใ•ใ‚ŒใŸใ‚ฟใ‚คใƒ ใ‚นใ‚ฟใƒณใƒ—ใ€‚ISO-8601.", + "format": "date-time" + }, + "expireAt": { + "type": "string", + "description": "ใ‚ญใƒผใฎๆœ‰ๅŠนๆœŸ้™ใ‚’ใ‚ฟใ‚คใƒ ใ‚นใ‚ฟใƒณใƒ—ใ—ใพใ™ใ€‚ๅญ˜ๅœจใ—ใชใ„ใ‹็ฉบใฎๅ ดๅˆใ€ใ‚ญใƒผใฏๆœŸ้™ๅˆ‡ใ‚Œใซใชใ‚Šใพใ›ใ‚“ใ€‚ISO-8601.", + "format": "date-time" + }, + "usedAt": { + "type": "string", + "description": "ใ‚ญใƒผใŒๆœ€ๅพŒใซไฝฟ็”จใ•ใ‚ŒใŸใจใใฎใ‚ฟใ‚คใƒ ใ‚นใ‚ฟใƒณใƒ—ใ€‚ๅญ˜ๅœจใ—ใชใ„ๅ ดๅˆใ€ใ‚ญใƒผใฏไธ€ๅบฆใ‚‚ไฝฟ็”จใ•ใ‚Œใฆใ„ใพใ›ใ‚“ใ€‚ISO-8601.", + "format": "date-time" + } + } + }, + "ApiKeyHashData": { + "properties": { + "keyIdHash": { + "type": "string", + "description": "ใ‚ญใƒผIDใฎใƒใƒƒใ‚ทใƒฅ." + }, + "keyIdSuffix": { + "type": "string", + "description": "ใ‚ญใƒผ ID ใฎๆœ€ๅพŒใฎ 4 ๆกใ€‚ใ‚ขใƒซใ‚ดใƒชใ‚บใƒ : echo -n "yourpassword" | sha256sum | tr -d '-' | xxd -r -p | base64" + }, + "keySecretHash": { + "type": "string", + "description": "ใ‚ญใƒผ secret ใฎใƒใƒƒใ‚ทใƒฅใ€‚ใ‚ขใƒซใ‚ดใƒชใ‚บใƒ : echo -n "yourpassword" | sha256sum | tr -d '-' | xxd -r -p | base64" + } + } + }, + "OrganizationPatchRequest": { + "properties": { + "name": { + "type": "string", + "description": "็ต„็น”ๅ." + } + } + }, + "ServicePostRequest": { + "properties": { + "name": { + "type": "string", + "description": "ใ‚ตใƒผใƒ“ใ‚นๅ." + }, + "provider": { + "type": "string", + "description": "ใ‚ฏใƒฉใ‚ฆใƒ‰ใƒ—ใƒญใƒใ‚คใƒ€ใƒผ", + "enum": [ + "aws", + "gcp" + ] + }, + "region": { + "type": "string", + "description": "ใ‚ตใƒผใƒ“ใ‚นๅœฐๅŸŸ.", + "enum": [ + "ap-south-1", + "ap-southeast-1", + "eu-central-1", + "eu-west-1", + "us-east-1", + "us-east-2", + "us-west-2", + "ap-southeast-2", + "us-east1", + "us-central1", + "europe-west4", + "asia-southeast1" + ] + }, + "tier": { + "type": "string", + "description": "ใ‚ตใƒผใƒ“ใ‚นใฎ้šŽๅฑค: ใ€Œ้–‹็™บใ€ใ€ใ€Œๆœฌ็•ชใ€ใ€ใ€Œๅฐ‚็”จ้ซ˜ใƒกใƒขใƒชใ€ใ€ใ€Œๅฐ‚็”จ้ซ˜CPUใ€ใ€ใ€Œๅฐ‚็”จๆจ™ๆบ–ใ€ใ€‚ๆœฌ็•ชใ‚ตใƒผใƒ“ใ‚นใฎใ‚นใ‚ฑใƒผใƒซใ€้–‹็™บใฏๅ›บๅฎšใ‚ตใ‚คใ‚บใงใ™.", + "enum": [ + "development", + "production", + "dedicated_high_mem", + "dedicated_high_cpu", + "dedicated_standard" + ] + }, + "ipAccessList": { + "type": "array", + "description": "ใ‚ตใƒผใƒ“ใ‚นใธใฎใ‚ขใ‚ฏใ‚ปใ‚นใŒ่จฑๅฏใ•ใ‚ŒใŸ IP ใ‚ขใƒ‰ใƒฌใ‚นใฎใƒชใ‚นใƒˆ", + "items": { + "$ref": "#/components/schemas/IpAccessListEntry" + } + }, + "minTotalMemoryGb": { + "type": "number", + "description": "่‡ชๅ‹•ใ‚นใ‚ฑใƒผใƒชใƒณใ‚ฐไธญใฎใ™ในใฆใฎใƒฏใƒผใ‚ซใƒผใฎๆœ€ๅฐๅˆ่จˆใƒกใƒขใƒช๏ผˆGB๏ผ‰ใ€‚ใ€Œๆœฌ็•ชใ€ใ‚ตใƒผใƒ“ใ‚นใงใฎใฟไฝฟ็”จๅฏ่ƒฝใ€‚12 ใฎๅ€ๆ•ฐใงใ€24 ใ‚ˆใ‚Šๅคงใใ„ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚.", + "minimum": 24, + "maximum": 720, + "multipleOf": 12, + "example": 48 + }, + "maxTotalMemoryGb": { + "type": "number", + "description": "่‡ชๅ‹•ใ‚นใ‚ฑใƒผใƒชใƒณใ‚ฐไธญใฎใ™ในใฆใฎใƒฏใƒผใ‚ซใƒผใฎๆœ€ๅคงๅˆ่จˆใƒกใƒขใƒช (GB)ใ€‚ใ€Œใƒ—ใƒญใƒ€ใ‚ฏใ‚ทใƒงใƒณใ€ใ‚ตใƒผใƒ“ใ‚นใงใฎใฟไฝฟ็”จใงใใพใ™ใ€‚็„กๆ–™ใ‚ตใƒผใƒ“ใ‚นใฎๅ ดๅˆใฏ 12 ใฎๅ€ๆ•ฐใง 360 ๆœชๆบ€ใ€ๆœ‰ๆ–™ใ‚ตใƒผใƒ“ใ‚นใฎๅ ดๅˆใฏ 720 ๆœชๆบ€ใงใ‚ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚.", + "minimum": 24, + "maximum": 720, + "multipleOf": 12, + "example": 360 + }, + "idleScaling": { + "type": "boolean", + "description": "true ใซ่จญๅฎšใ™ใ‚‹ใจใ€ใ‚ขใ‚คใƒ‰ใƒซๆ™‚ใซใ‚ตใƒผใƒ“ใ‚นใŒใ‚ผใƒญใซใ‚นใ‚ฑใƒผใƒซใƒ€ใ‚ฆใƒณใ•ใ‚Œใพใ™ใ€‚้–‹็™บใ‚ตใƒผใƒ“ใ‚นใงใฏๅธธใซ true ใงใ™ใ€‚." + }, + "idleTimeoutMinutes": { + "type": "number", + "description": "ๆœ€ๅฐใ‚ขใ‚คใƒ‰ใƒซใ‚ฟใ‚คใƒ ใ‚ขใ‚ฆใƒˆใ‚’่จญๅฎšใ—ใพใ™๏ผˆๅˆ†ๅ˜ไฝ๏ผ‰ใ€‚5ๅˆ†ไปฅไธŠใงใ‚ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™." + }, + "backupId": { + "type": "string", + "description": "ๆ–ฐใ—ใ„ใ‚ตใƒผใƒ“ใ‚นใฎๅˆๆœŸ็Šถๆ…‹ใจใ—ใฆไฝฟ็”จใ•ใ‚Œใ‚‹ใ‚ชใƒ—ใ‚ทใƒงใƒณใฎใƒใƒƒใ‚ฏใ‚ขใƒƒใƒ— IDใ€‚ไฝฟ็”จใ™ใ‚‹ๅ ดๅˆใ€ๆ–ฐใ—ใ„ใ‚คใƒณใ‚นใ‚ฟใƒณใ‚นใฎใƒชใƒผใ‚ธใƒงใƒณใจๅฑคใฏๅ…ƒใฎใ‚คใƒณใ‚นใ‚ฟใƒณใ‚นใฎๅ€คใจๅŒใ˜ใงใ‚ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚.", + "format": "uuid" + } + } + }, + "ServicePostResponse": { + "properties": { + "service": { + "$ref": "#/components/schemas/Service" + }, + "password": { + "type": "string", + "description": "ๆ–ฐใ—ใไฝœๆˆใ•ใ‚ŒใŸใ‚ตใƒผใƒ“ใ‚นใฎใƒ‘ใ‚นใƒฏใƒผใƒ‰." + } + } + }, + "ServicePatchRequest": { + "properties": { + "name": { + "type": "string", + "description": "ใ‚ตใƒผใƒ“ใ‚นๅ." + }, + "ipAccessList": { + "$ref": "#/components/schemas/IpAccessListPatch" + } + } + }, + "ServiceStatePatchRequest": { + "properties": { + "command": { + "type": "string", + "description": "็Šถๆ…‹ใ‚’ๅค‰ๆ›ดใ™ใ‚‹ใ‚ณใƒžใƒณใƒ‰: 'start'ใ€'stop'.", + "enum": [ + "start", + "stop" + ] + } + } + }, + "ServiceScalingPatchRequest": { + "properties": { + "minTotalMemoryGb": { + "type": "number", + "description": "่‡ชๅ‹•ใ‚นใ‚ฑใƒผใƒชใƒณใ‚ฐไธญใฎใ™ในใฆใฎใƒฏใƒผใ‚ซใƒผใฎๆœ€ๅฐๅˆ่จˆใƒกใƒขใƒช๏ผˆGB๏ผ‰ใ€‚ใ€Œๆœฌ็•ชใ€ใ‚ตใƒผใƒ“ใ‚นใงใฎใฟไฝฟ็”จๅฏ่ƒฝใ€‚12 ใฎๅ€ๆ•ฐใงใ€24 ใ‚ˆใ‚Šๅคงใใ„ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚.", + "minimum": 24, + "maximum": 720, + "multipleOf": 12, + "example": 48 + }, + "maxTotalMemoryGb": { + "type": "number", + "description": "่‡ชๅ‹•ใ‚นใ‚ฑใƒผใƒชใƒณใ‚ฐไธญใฎใ™ในใฆใฎใƒฏใƒผใ‚ซใƒผใฎๆœ€ๅคงๅˆ่จˆใƒกใƒขใƒช (GB)ใ€‚ใ€Œใƒ—ใƒญใƒ€ใ‚ฏใ‚ทใƒงใƒณใ€ใ‚ตใƒผใƒ“ใ‚นใงใฎใฟไฝฟ็”จใงใใพใ™ใ€‚็„กๆ–™ใ‚ตใƒผใƒ“ใ‚นใฎๅ ดๅˆใฏ 12 ใฎๅ€ๆ•ฐใง 360 ๆœชๆบ€ใ€ๆœ‰ๆ–™ใ‚ตใƒผใƒ“ใ‚นใฎๅ ดๅˆใฏ 720 ๆœชๆบ€ใงใ‚ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚.", + "minimum": 24, + "maximum": 720, + "multipleOf": 12, + "example": 360 + }, + "idleScaling": { + "type": "boolean", + "description": "true ใซ่จญๅฎšใ™ใ‚‹ใจใ€ใ‚ขใ‚คใƒ‰ใƒซๆ™‚ใซใ‚ตใƒผใƒ“ใ‚นใŒใ‚ผใƒญใซใ‚นใ‚ฑใƒผใƒซใƒ€ใ‚ฆใƒณใ•ใ‚Œใพใ™ใ€‚้–‹็™บใ‚ตใƒผใƒ“ใ‚นใงใฏๅธธใซ true ใงใ™ใ€‚." + }, + "idleTimeoutMinutes": { + "type": "number", + "description": "ๆœ€ๅฐใ‚ขใ‚คใƒ‰ใƒซใ‚ฟใ‚คใƒ ใ‚ขใ‚ฆใƒˆใ‚’่จญๅฎšใ—ใพใ™๏ผˆๅˆ†ๅ˜ไฝ๏ผ‰ใ€‚5ๅˆ†ไปฅไธŠใงใ‚ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™." + } + } + }, + "ServicePasswordPatchRequest": { + "properties": { + "newPasswordHash": { + "type": "string", + "description": "ใ‚ชใƒ—ใ‚ทใƒงใƒณใฎใƒ‘ใ‚นใƒฏใƒผใƒ‰ ใƒใƒƒใ‚ทใƒฅใ€‚ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ็ตŒ็”ฑใงใฎใƒ‘ใ‚นใƒฏใƒผใƒ‰ใฎ้€ไฟกใ‚’ๅ›ž้ฟใ™ใ‚‹ใŸใ‚ใซไฝฟ็”จใ•ใ‚Œใพใ™ใ€‚ๆŒ‡ๅฎšใ—ใชใ„ๅ ดๅˆใฏใ€ๆ–ฐใ—ใ„ใƒ‘ใ‚นใƒฏใƒผใƒ‰ใŒ็”Ÿๆˆใ•ใ‚Œใ€ๅฟœ็ญ”ใงๆไพ›ใ•ใ‚Œใพใ™ใ€‚ใใ‚Œไปฅๅค–ใฎๅ ดๅˆใฏใ€ใ“ใฎใƒใƒƒใ‚ทใƒฅใŒไฝฟ็”จใ•ใ‚Œใพใ™ใ€‚ใ‚ขใƒซใ‚ดใƒชใ‚บใƒ : echo -n "yourpassword" | sha256sum | tr -d '-' | xxd -r -p | base64" + }, + "newDoubleSha1Hash": { + "type": "string", + "description": "MySQL ใƒ—ใƒญใƒˆใ‚ณใƒซใฎใ‚ชใƒ—ใ‚ทใƒงใƒณใฎไบŒ้‡ SHA1 ใƒ‘ใ‚นใƒฏใƒผใƒ‰ ใƒใƒƒใ‚ทใƒฅใ€‚newPasswordHash ใŒๆŒ‡ๅฎšใ•ใ‚Œใฆใ„ใชใ„ๅ ดๅˆใ€ใ“ใฎใ‚ญใƒผใฏ็„ก่ฆ–ใ•ใ‚Œใ€็”Ÿๆˆใ•ใ‚ŒใŸใƒ‘ใ‚นใƒฏใƒผใƒ‰ใŒไฝฟ็”จใ•ใ‚Œใพใ™ใ€‚ใ“ใฎใƒ•ใ‚ฃใƒผใƒซใƒ‰ใ‚’ๆœ‰ๅŠนใซใ™ใ‚‹ใซใฏใ€ๅฎŸ้จ“ๆฎต้šŽใงใ‚ใ‚‹ใŸใ‚ใ‚ตใƒใƒผใƒˆใซใŠๅ•ใ„ๅˆใ‚ใ›ใใ ใ•ใ„ใ€‚ใ‚ขใƒซใ‚ดใƒชใ‚บใƒ : echo -n "yourpassword" | sha1sum | tr -d '-' | xxd -r -p | sha1sum | tr -d '-'" + } + } + }, + "ServicePasswordPatchResponse": { + "properties": { + "password": { + "type": "string", + "description": "ๆ–ฐใ—ใ„ใ‚ตใƒผใƒ“ใ‚นใƒ‘ใ‚นใƒฏใƒผใƒ‰ใ€‚ใƒชใ‚ฏใ‚จใ‚นใƒˆใซใ€ŒnewPasswordHashใ€ใŒๅซใพใ‚Œใฆใ„ใชใ„ๅ ดๅˆใซใฎใฟๆไพ›ใ•ใ‚Œใพใ™ใ€‚" + } + } + }, + "ApiKeyPostRequest": { + "properties": { + "name": { + "type": "string", + "description": "ใ‚ญใƒผใฎๅๅ‰." + }, + "expireAt": { + "type": "string", + "description": "ใ‚ญใƒผใฎๆœ‰ๅŠนๆœŸ้™ใ‚’ใ‚ฟใ‚คใƒ ใ‚นใ‚ฟใƒณใƒ—ใ—ใพใ™ใ€‚ๅญ˜ๅœจใ—ใชใ„ใ‹็ฉบใฎๅ ดๅˆใ€ใ‚ญใƒผใฏๆœŸ้™ๅˆ‡ใ‚Œใซใชใ‚Šใพใ›ใ‚“ใ€‚ISO-8601.", + "format": "date-time" + }, + "state": { + "type": "string", + "description": "ใ‚ญใƒผใฎๅˆๆœŸ็Šถๆ…‹: 'ๆœ‰ๅŠน'ใ€'็„กๅŠน'ใ€‚ๆŒ‡ๅฎšใ—ใชใ„ๅ ดๅˆใ€ๆ–ฐใ—ใ„ใ‚ญใƒผใฏ 'ๆœ‰ๅŠน' ใซใชใ‚Šใพใ™ใ€‚.", + "enum": [ + "enabled", + "disabled" + ] + }, + "hashData": { + "$ref": "#/components/schemas/ApiKeyHashData" + }, + "roles": { + "type": "array", + "description": "ใ‚ญใƒผใซๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚ŒใŸใƒญใƒผใƒซใฎใƒชใ‚นใƒˆใ€‚ๅฐ‘ใชใใจใ‚‚ 1 ใคใฎ่ฆ็ด ใŒๅซใพใ‚Œใพใ™ใ€‚.", + "items": { + "type": "string", + "enum": [ + "admin", + "developer" + ] + } + } + } + }, + "ApiKeyPostResponse": { + "properties": { + "key": { + "$ref": "#/components/schemas/ApiKey" + }, + "keyId": { + "type": "string", + "description": "็”Ÿๆˆใ•ใ‚ŒใŸใ‚ญใƒผIDใ€‚ใƒชใ‚ฏใ‚จใ‚นใƒˆใซใ€ŒhashDataใ€ใŒใชใ‹ใฃใŸๅ ดๅˆใซใฎใฟๆไพ›ใ•ใ‚Œใพใ™ใ€‚." + }, + "keySecret": { + "type": "string", + "description": "็”Ÿๆˆใ•ใ‚ŒใŸใ‚ญใƒผใ‚ทใƒผใ‚ฏใƒฌใƒƒใƒˆใ€‚ใƒชใ‚ฏใ‚จใ‚นใƒˆใซใ€ŒhashDataใ€ใŒใชใ‹ใฃใŸๅ ดๅˆใซใฎใฟๆไพ›ใ•ใ‚Œใพใ™ใ€‚." + } + } + }, + "ApiKeyPatchRequest": { + "properties": { + "name": { + "type": "string", + "description": "ใ‚ญใƒผใฎๅๅ‰" + }, + "roles": { + "type": "array", + "description": "ใ‚ญใƒผใซๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚ŒใŸใƒญใƒผใƒซใฎใƒชใ‚นใƒˆใ€‚ๅฐ‘ใชใใจใ‚‚ 1 ใคใฎ่ฆ็ด ใŒๅซใพใ‚Œใพใ™ใ€‚.", + "items": { + "type": "string", + "enum": [ + "admin", + "developer" + ] + } + }, + "expireAt": { + "type": "string", + "description": "ใ‚ญใƒผใฎๆœ‰ๅŠนๆœŸ้™ใ‚’ใ‚ฟใ‚คใƒ ใ‚นใ‚ฟใƒณใƒ—ใ—ใพใ™ใ€‚ๅญ˜ๅœจใ—ใชใ„ใ‹็ฉบใฎๅ ดๅˆใ€ใ‚ญใƒผใฏๆœŸ้™ๅˆ‡ใ‚Œใซใชใ‚Šใพใ›ใ‚“ใ€‚ISO-8601.", + "format": "date-time" + }, + "state": { + "type": "string", + "description": "ใ‚ญใƒผใฎ็Šถๆ…‹: ใ€Œๆœ‰ๅŠนใ€ใ€ใ€Œ็„กๅŠนใ€.", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "MemberPatchRequest": { + "properties": { + "role": { + "type": "string", + "description": "็ต„็น”ใซใŠใ‘ใ‚‹ใƒกใƒณใƒใƒผใฎๅฝนๅ‰ฒ.", + "enum": [ + "admin", + "developer" + ] + } + } + }, + "InvitationPostRequest": { + "properties": { + "email": { + "type": "string", + "description": "ๆ‹›ๅพ…ใ•ใ‚ŒใŸใƒฆใƒผใ‚ถใƒผใฎใƒกใƒผใƒซใ‚ขใƒ‰ใƒฌใ‚นใ€‚ใ“ใฎใƒกใƒผใƒซใ‚ขใƒ‰ใƒฌใ‚นใ‚’ๆŒใคใƒฆใƒผใ‚ถใƒผใฎใฟใŒๆ‹›ๅพ…ใ‚’ไฝฟ็”จใ—ใฆๅ‚ๅŠ ใงใใพใ™ใ€‚ใƒกใƒผใƒซใ‚ขใƒ‰ใƒฌใ‚นใฏๅฐๆ–‡ๅญ—ใงไฟๅญ˜ใ•ใ‚Œใพใ™ใ€‚.", + "format": "email" + }, + "role": { + "type": "string", + "description": "็ต„็น”ใซใŠใ‘ใ‚‹ใƒกใƒณใƒใƒผใฎๅฝนๅ‰ฒ.", + "enum": [ + "admin", + "developer" + ] + } + } + } + } + }, + "x-samchon-emended": true +} \ No newline at end of file diff --git a/assets/output/clickhouse.swagger.ko.json b/assets/output/clickhouse.swagger.ko.json new file mode 100644 index 0000000..a0df42f --- /dev/null +++ b/assets/output/clickhouse.swagger.ko.json @@ -0,0 +1,2582 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "ClickHouse Cloud๋ฅผ ์œ„ํ•œ OpenAPI ์‚ฌ์–‘", + "version": "1.0", + "contact": { + "name": "ClickHouse Support", + "url": "https://clickhouse.com/docs/en/cloud/manage/openapi?referrer=openapi-82913", + "email": "support@clickhouse.com" + } + }, + "servers": [ + { + "url": "https://api.clickhouse.cloud" + } + ], + "paths": { + "/v1/organizations": { + "get": { + "summary": "์‚ฌ์šฉ ๊ฐ€๋Šฅํ•œ ์กฐ์ง ๋ชฉ๋ก ๊ฐ€์ ธ์˜ค๊ธฐ", + "description": "์š”์ฒญ์˜ API ํ‚ค์™€ ์—ฐ๊ฒฐ๋œ ๋‹จ์ผ ์กฐ์ง์ด ํฌํ•จ๋œ ๋ชฉ๋ก์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "parameters": [], + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์‘๋‹ต", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Organization" + } + }, + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "๋ชจ๋“  ์š”์ฒญ์— ๊ณ ์œ ํ•œ ID๊ฐ€ ํ• ๋‹น๋จ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ํด๋ผ์ด์–ธํŠธ ์˜ค๋ฅ˜๋กœ ์ธ์‹๋˜๋Š” ์‚ฌํ•ญ์œผ๋กœ ์ธํ•ด ์„œ๋ฒ„๊ฐ€ ์š”์ฒญ์„ ์ฒ˜๋ฆฌํ•  ์ˆ˜ ์—†๊ฑฐ๋‚˜ ์ฒ˜๋ฆฌํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 400 + }, + "error": { + "type": "string", + "description": "์ž์„ธํ•œ ์˜ค๋ฅ˜ ์„ค๋ช…." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId": { + "get": { + "summary": "์กฐ์ง ์„ธ๋ถ€ ์ •๋ณด ๊ฐ€์ ธ์˜ค๊ธฐ", + "description": "๋‹จ์ผ ์กฐ์ง์˜ ์„ธ๋ถ€ ์ •๋ณด๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค. ์„ธ๋ถ€ ์ •๋ณด๋ฅผ ์–ป์œผ๋ ค๋ฉด auth ํ‚ค๊ฐ€ ์กฐ์ง์— ์†ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค..", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "์š”์ฒญํ•˜์‹  ์กฐ์ง์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์‘๋‹ต", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Organization" + }, + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "๋ชจ๋“  ์š”์ฒญ์— ๊ณ ์œ ํ•œ ID๊ฐ€ ํ• ๋‹น๋จ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ํด๋ผ์ด์–ธํŠธ ์˜ค๋ฅ˜๋กœ ์ธ์‹๋˜๋Š” ์‚ฌํ•ญ์œผ๋กœ ์ธํ•ด ์„œ๋ฒ„๊ฐ€ ์š”์ฒญ์„ ์ฒ˜๋ฆฌํ•  ์ˆ˜ ์—†๊ฑฐ๋‚˜ ์ฒ˜๋ฆฌํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 400 + }, + "error": { + "type": "string", + "description": "์ž์„ธํ•œ ์˜ค๋ฅ˜ ์„ค๋ช…." + } + } + } + } + } + } + } + }, + "patch": { + "summary": "์กฐ์ง ์„ธ๋ถ€ ์ •๋ณด ์—…๋ฐ์ดํŠธ", + "description": "์กฐ์ง ํ•„๋“œ๋ฅผ ์—…๋ฐ์ดํŠธํ•ฉ๋‹ˆ๋‹ค. ADMIN ์ธ์ฆ ํ‚ค ์—ญํ• ์ด ํ•„์š”ํ•ฉ๋‹ˆ๋‹ค..", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "์—…๋ฐ์ดํŠธํ•  ์กฐ์ง์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrganizationPatchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์‘๋‹ต", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Organization" + }, + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "๋ชจ๋“  ์š”์ฒญ์— ๊ณ ์œ ํ•œ ID๊ฐ€ ํ• ๋‹น๋จ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ํด๋ผ์ด์–ธํŠธ ์˜ค๋ฅ˜๋กœ ์ธ์‹๋˜๋Š” ์‚ฌํ•ญ์œผ๋กœ ์ธํ•ด ์„œ๋ฒ„๊ฐ€ ์š”์ฒญ์„ ์ฒ˜๋ฆฌํ•  ์ˆ˜ ์—†๊ฑฐ๋‚˜ ์ฒ˜๋ฆฌํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 400 + }, + "error": { + "type": "string", + "description": "์ž์„ธํ•œ ์˜ค๋ฅ˜ ์„ค๋ช…." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/services": { + "get": { + "summary": "์กฐ์ง ์„œ๋น„์Šค ๋ชฉ๋ก", + "description": "์กฐ์ง์˜ ๋ชจ๋“  ์„œ๋น„์Šค ๋ชฉ๋ก์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "์š”์ฒญํ•˜์‹  ์กฐ์ง์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์‘๋‹ต", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Service" + } + }, + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "๋ชจ๋“  ์š”์ฒญ์— ๊ณ ์œ ํ•œ ID๊ฐ€ ํ• ๋‹น๋จ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ํด๋ผ์ด์–ธํŠธ ์˜ค๋ฅ˜๋กœ ์ธ์‹๋˜๋Š” ์‚ฌํ•ญ์œผ๋กœ ์ธํ•ด ์„œ๋ฒ„๊ฐ€ ์š”์ฒญ์„ ์ฒ˜๋ฆฌํ•  ์ˆ˜ ์—†๊ฑฐ๋‚˜ ์ฒ˜๋ฆฌํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 400 + }, + "error": { + "type": "string", + "description": "์ž์„ธํ•œ ์˜ค๋ฅ˜ ์„ค๋ช…." + } + } + } + } + } + } + } + }, + "post": { + "summary": "์ƒˆ๋กœ์šด ์„œ๋น„์Šค ๋งŒ๋“ค๊ธฐ", + "description": "์กฐ์ง์—์„œ ์ƒˆ ์„œ๋น„์Šค๋ฅผ ๋งŒ๋“ค๊ณ  ํ˜„์žฌ ์„œ๋น„์Šค ์ƒํƒœ์™€ ์„œ๋น„์Šค์— ์•ก์„ธ์Šคํ•˜๊ธฐ ์œ„ํ•œ ๋น„๋ฐ€๋ฒˆํ˜ธ๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค. ์„œ๋น„์Šค๋Š” ๋น„๋™๊ธฐ์ ์œผ๋กœ ์‹œ์ž‘๋ฉ๋‹ˆ๋‹ค..", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "์„œ๋น„์Šค๋ฅผ ์†Œ์œ ํ•  ์กฐ์ง์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServicePostRequest" + } + } + } + }, + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์‘๋‹ต", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/ServicePostResponse" + }, + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "๋ชจ๋“  ์š”์ฒญ์— ๊ณ ์œ ํ•œ ID๊ฐ€ ํ• ๋‹น๋จ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ํด๋ผ์ด์–ธํŠธ ์˜ค๋ฅ˜๋กœ ์ธ์‹๋˜๋Š” ์‚ฌํ•ญ์œผ๋กœ ์ธํ•ด ์„œ๋ฒ„๊ฐ€ ์š”์ฒญ์„ ์ฒ˜๋ฆฌํ•  ์ˆ˜ ์—†๊ฑฐ๋‚˜ ์ฒ˜๋ฆฌํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 400 + }, + "error": { + "type": "string", + "description": "์ž์„ธํ•œ ์˜ค๋ฅ˜ ์„ค๋ช…." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/services/:serviceId": { + "get": { + "summary": "์„œ๋น„์Šค ์„ธ๋ถ€ ์ •๋ณด ๋ฐ›๊ธฐ", + "description": "์กฐ์ง์— ์†ํ•œ ์„œ๋น„์Šค๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "์„œ๋น„์Šค๋ฅผ ์†Œ์œ ํ•œ ์กฐ์ง์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service ID", + "description": "์š”์ฒญ๋œ ์„œ๋น„์Šค์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์‘๋‹ต", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Service" + }, + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "๋ชจ๋“  ์š”์ฒญ์— ๊ณ ์œ ํ•œ ID๊ฐ€ ํ• ๋‹น๋จ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ํด๋ผ์ด์–ธํŠธ ์˜ค๋ฅ˜๋กœ ์ธ์‹๋˜๋Š” ์‚ฌํ•ญ์œผ๋กœ ์ธํ•ด ์„œ๋ฒ„๊ฐ€ ์š”์ฒญ์„ ์ฒ˜๋ฆฌํ•  ์ˆ˜ ์—†๊ฑฐ๋‚˜ ์ฒ˜๋ฆฌํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 400 + }, + "error": { + "type": "string", + "description": "์ž์„ธํ•œ ์˜ค๋ฅ˜ ์„ค๋ช…." + } + } + } + } + } + } + } + }, + "patch": { + "summary": "์„œ๋น„์Šค ๊ธฐ๋ณธ ์„ธ๋ถ€ ์ •๋ณด ์—…๋ฐ์ดํŠธ.", + "description": "์„œ๋น„์Šค ์ด๋ฆ„์ด๋‚˜ IP ์•ก์„ธ์Šค ๋ชฉ๋ก๊ณผ ๊ฐ™์€ ๊ธฐ๋ณธ ์„œ๋น„์Šค ์„ธ๋ถ€ ์ •๋ณด๋ฅผ ์—…๋ฐ์ดํŠธํ•ฉ๋‹ˆ๋‹ค..", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "์„œ๋น„์Šค๋ฅผ ์†Œ์œ ํ•œ ์กฐ์ง์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service ID", + "description": "์—…๋ฐ์ดํŠธํ•  ์„œ๋น„์Šค์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServicePatchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์‘๋‹ต", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Service" + }, + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "๋ชจ๋“  ์š”์ฒญ์— ๊ณ ์œ ํ•œ ID๊ฐ€ ํ• ๋‹น๋จ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ํด๋ผ์ด์–ธํŠธ ์˜ค๋ฅ˜๋กœ ์ธ์‹๋˜๋Š” ์‚ฌํ•ญ์œผ๋กœ ์ธํ•ด ์„œ๋ฒ„๊ฐ€ ์š”์ฒญ์„ ์ฒ˜๋ฆฌํ•  ์ˆ˜ ์—†๊ฑฐ๋‚˜ ์ฒ˜๋ฆฌํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 400 + }, + "error": { + "type": "string", + "description": "์ž์„ธํ•œ ์˜ค๋ฅ˜ ์„ค๋ช…." + } + } + } + } + } + } + } + }, + "delete": { + "summary": "์„œ๋น„์Šค ์‚ญ์ œ.", + "description": "์„œ๋น„์Šค๋ฅผ ์‚ญ์ œํ•ฉ๋‹ˆ๋‹ค. ์„œ๋น„์Šค๋Š” ์ค‘์ง€๋œ ์ƒํƒœ์—ฌ์•ผ ํ•˜๋ฉฐ ์ด ๋ฉ”์„œ๋“œ ํ˜ธ์ถœ ํ›„ ๋น„๋™๊ธฐ์ ์œผ๋กœ ์‚ญ์ œ๋ฉ๋‹ˆ๋‹ค..", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "์„œ๋น„์Šค๋ฅผ ์†Œ์œ ํ•œ ์กฐ์ง์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service ID", + "description": "์‚ญ์ œํ•  ์„œ๋น„์Šค์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ] + } + }, + "/v1/organizations/:organizationId/services/:serviceId/state": { + "patch": { + "summary": "์„œ๋น„์Šค ์ƒํƒœ ์—…๋ฐ์ดํŠธ.", + "description": "์„œ๋น„์Šค๋ฅผ ์‹œ์ž‘ํ•˜๊ฑฐ๋‚˜ ์ค‘์ง€ํ•ฉ๋‹ˆ๋‹ค", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "์„œ๋น„์Šค๋ฅผ ์†Œ์œ ํ•œ ์กฐ์ง์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service ID", + "description": "์ƒํƒœ๋ฅผ ์—…๋ฐ์ดํŠธํ•  ์„œ๋น„์Šค์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServiceStatePatchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์‘๋‹ต", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Service" + }, + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "๋ชจ๋“  ์š”์ฒญ์— ๊ณ ์œ ํ•œ ID๊ฐ€ ํ• ๋‹น๋จ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ํด๋ผ์ด์–ธํŠธ ์˜ค๋ฅ˜๋กœ ์ธ์‹๋˜๋Š” ์‚ฌํ•ญ์œผ๋กœ ์ธํ•ด ์„œ๋ฒ„๊ฐ€ ์š”์ฒญ์„ ์ฒ˜๋ฆฌํ•  ์ˆ˜ ์—†๊ฑฐ๋‚˜ ์ฒ˜๋ฆฌํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 400 + }, + "error": { + "type": "string", + "description": "์ž์„ธํ•œ ์˜ค๋ฅ˜ ์„ค๋ช…." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/services/:serviceId/scaling": { + "patch": { + "summary": "์„œ๋น„์Šค ์ž๋™ ํ™•์žฅ ์„ค์ • ์—…๋ฐ์ดํŠธ.", + "description": "์„œ๋น„์Šค์— ๋Œ€ํ•œ ์ตœ์†Œ ๋ฐ ์ตœ๋Œ€ ์ด ๋ฉ”๋ชจ๋ฆฌ ์ œํ•œ๊ณผ ์œ ํœด ๋ชจ๋“œ ํ™•์žฅ ๋™์ž‘์„ ์—…๋ฐ์ดํŠธํ•ฉ๋‹ˆ๋‹ค. ๋ฉ”๋ชจ๋ฆฌ ์„ค์ •์€ "์ƒ์‚ฐ" ์„œ๋น„์Šค์—๋งŒ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ์œผ๋ฉฐ 24GB๋ถ€ํ„ฐ ์‹œ์ž‘ํ•˜์—ฌ 12์˜ ๋ฐฐ์ˆ˜์—ฌ์•ผ ํ•ฉ๋‹ˆ๋‹ค..", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "์„œ๋น„์Šค๋ฅผ ์†Œ์œ ํ•œ ์กฐ์ง์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service ID", + "description": "์Šค์ผ€์ผ๋ง ๋งค๊ฐœ๋ณ€์ˆ˜๋ฅผ ์—…๋ฐ์ดํŠธํ•  ์„œ๋น„์Šค์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServiceScalingPatchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์‘๋‹ต", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Service" + }, + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "๋ชจ๋“  ์š”์ฒญ์— ๊ณ ์œ ํ•œ ID๊ฐ€ ํ• ๋‹น๋จ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ํด๋ผ์ด์–ธํŠธ ์˜ค๋ฅ˜๋กœ ์ธ์‹๋˜๋Š” ์‚ฌํ•ญ์œผ๋กœ ์ธํ•ด ์„œ๋ฒ„๊ฐ€ ์š”์ฒญ์„ ์ฒ˜๋ฆฌํ•  ์ˆ˜ ์—†๊ฑฐ๋‚˜ ์ฒ˜๋ฆฌํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 400 + }, + "error": { + "type": "string", + "description": "์ž์„ธํ•œ ์˜ค๋ฅ˜ ์„ค๋ช…." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/services/:serviceId/password": { + "patch": { + "summary": "์„œ๋น„์Šค ๋น„๋ฐ€๋ฒˆํ˜ธ ์—…๋ฐ์ดํŠธ.", + "description": "์„œ๋น„์Šค์— ๋Œ€ํ•œ ์ƒˆ ์•”ํ˜ธ๋ฅผ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "์„œ๋น„์Šค๋ฅผ ์†Œ์œ ํ•œ ์กฐ์ง์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service ID", + "description": "๋น„๋ฐ€๋ฒˆํ˜ธ๋ฅผ ์—…๋ฐ์ดํŠธํ•  ์„œ๋น„์Šค์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServicePasswordPatchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์‘๋‹ต", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/ServicePasswordPatchResponse" + }, + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "๋ชจ๋“  ์š”์ฒญ์— ๊ณ ์œ ํ•œ ID๊ฐ€ ํ• ๋‹น๋จ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ํด๋ผ์ด์–ธํŠธ ์˜ค๋ฅ˜๋กœ ์ธ์‹๋˜๋Š” ์‚ฌํ•ญ์œผ๋กœ ์ธํ•ด ์„œ๋ฒ„๊ฐ€ ์š”์ฒญ์„ ์ฒ˜๋ฆฌํ•  ์ˆ˜ ์—†๊ฑฐ๋‚˜ ์ฒ˜๋ฆฌํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 400 + }, + "error": { + "type": "string", + "description": "์ž์„ธํ•œ ์˜ค๋ฅ˜ ์„ค๋ช…." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/services/:serviceId/backups": { + "get": { + "summary": "์„œ๋น„์Šค ๋ฐฑ์—… ๋ชฉ๋ก", + "description": "์„œ๋น„์Šค์— ๋Œ€ํ•œ ๋ชจ๋“  ๋ฐฑ์—… ๋ชฉ๋ก์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "๋ฐฑ์—…์„ ์†Œ์œ ํ•œ ์กฐ์ง์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service ID", + "description": "๋ฐฑ์—…์ด ์ƒ์„ฑ๋œ ์„œ๋น„์Šค์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์‘๋‹ต", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Backup" + } + }, + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "๋ชจ๋“  ์š”์ฒญ์— ๊ณ ์œ ํ•œ ID๊ฐ€ ํ• ๋‹น๋จ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ํด๋ผ์ด์–ธํŠธ ์˜ค๋ฅ˜๋กœ ์ธ์‹๋˜๋Š” ์‚ฌํ•ญ์œผ๋กœ ์ธํ•ด ์„œ๋ฒ„๊ฐ€ ์š”์ฒญ์„ ์ฒ˜๋ฆฌํ•  ์ˆ˜ ์—†๊ฑฐ๋‚˜ ์ฒ˜๋ฆฌํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 400 + }, + "error": { + "type": "string", + "description": "์ž์„ธํ•œ ์˜ค๋ฅ˜ ์„ค๋ช…." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/services/:serviceId/backups/:backupId": { + "get": { + "summary": "๋ฐฑ์—… ์„ธ๋ถ€ ์ •๋ณด ๊ฐ€์ ธ์˜ค๊ธฐ", + "description": "๋‹จ์ผ ๋ฐฑ์—… ์ •๋ณด๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "๋ฐฑ์—…์„ ์†Œ์œ ํ•œ ์กฐ์ง์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service ID", + "description": "๋ฐฑ์—…์ด ์ƒ์„ฑ๋œ ์„œ๋น„์Šค์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Service backup ID", + "description": "์š”์ฒญ๋œ ๋ฐฑ์—…์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์‘๋‹ต", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Backup" + }, + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "๋ชจ๋“  ์š”์ฒญ์— ๊ณ ์œ ํ•œ ID๊ฐ€ ํ• ๋‹น๋จ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ํด๋ผ์ด์–ธํŠธ ์˜ค๋ฅ˜๋กœ ์ธ์‹๋˜๋Š” ์‚ฌํ•ญ์œผ๋กœ ์ธํ•ด ์„œ๋ฒ„๊ฐ€ ์š”์ฒญ์„ ์ฒ˜๋ฆฌํ•  ์ˆ˜ ์—†๊ฑฐ๋‚˜ ์ฒ˜๋ฆฌํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 400 + }, + "error": { + "type": "string", + "description": "์ž์„ธํ•œ ์˜ค๋ฅ˜ ์„ค๋ช…." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/keys": { + "get": { + "summary": "๋ชจ๋“  ํ‚ค ๋ชฉ๋ก ๊ฐ€์ ธ์˜ค๊ธฐ", + "description": "์กฐ์ง์˜ ๋ชจ๋“  ํ‚ค ๋ชฉ๋ก์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "์š”์ฒญํ•˜์‹  ์กฐ์ง์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์‘๋‹ต", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApiKey" + } + }, + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "๋ชจ๋“  ์š”์ฒญ์— ๊ณ ์œ ํ•œ ID๊ฐ€ ํ• ๋‹น๋จ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ํด๋ผ์ด์–ธํŠธ ์˜ค๋ฅ˜๋กœ ์ธ์‹๋˜๋Š” ์‚ฌํ•ญ์œผ๋กœ ์ธํ•ด ์„œ๋ฒ„๊ฐ€ ์š”์ฒญ์„ ์ฒ˜๋ฆฌํ•  ์ˆ˜ ์—†๊ฑฐ๋‚˜ ์ฒ˜๋ฆฌํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 400 + }, + "error": { + "type": "string", + "description": "์ž์„ธํ•œ ์˜ค๋ฅ˜ ์„ค๋ช…." + } + } + } + } + } + } + } + }, + "post": { + "summary": "ํ‚ค ์ƒ์„ฑ", + "description": "์ƒˆ๋กœ์šด API ํ‚ค๋ฅผ ์ƒ์„ฑํ•ฉ๋‹ˆ๋‹ค.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ํ‚ค๋ฅผ ์†Œ์œ ํ•  ์กฐ์ง์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiKeyPostRequest" + } + } + } + }, + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์‘๋‹ต", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/ApiKeyPostResponse" + }, + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "๋ชจ๋“  ์š”์ฒญ์— ๊ณ ์œ ํ•œ ID๊ฐ€ ํ• ๋‹น๋จ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ํด๋ผ์ด์–ธํŠธ ์˜ค๋ฅ˜๋กœ ์ธ์‹๋˜๋Š” ์‚ฌํ•ญ์œผ๋กœ ์ธํ•ด ์„œ๋ฒ„๊ฐ€ ์š”์ฒญ์„ ์ฒ˜๋ฆฌํ•  ์ˆ˜ ์—†๊ฑฐ๋‚˜ ์ฒ˜๋ฆฌํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 400 + }, + "error": { + "type": "string", + "description": "์ž์„ธํ•œ ์˜ค๋ฅ˜ ์„ค๋ช…." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/keys/:keyId": { + "get": { + "summary": "์ฃผ์š” ์„ธ๋ถ€ ์ •๋ณด๋ฅผ ์–ป์œผ์„ธ์š”", + "description": "๋‹จ์ผ ํ‚ค ์„ธ๋ถ€ ์ •๋ณด๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "์š”์ฒญํ•˜์‹  ์กฐ์ง์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "API key ID", + "description": "์š”์ฒญ๋œ ํ‚ค์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์‘๋‹ต", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/ApiKey" + }, + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "๋ชจ๋“  ์š”์ฒญ์— ๊ณ ์œ ํ•œ ID๊ฐ€ ํ• ๋‹น๋จ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ํด๋ผ์ด์–ธํŠธ ์˜ค๋ฅ˜๋กœ ์ธ์‹๋˜๋Š” ์‚ฌํ•ญ์œผ๋กœ ์ธํ•ด ์„œ๋ฒ„๊ฐ€ ์š”์ฒญ์„ ์ฒ˜๋ฆฌํ•  ์ˆ˜ ์—†๊ฑฐ๋‚˜ ์ฒ˜๋ฆฌํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 400 + }, + "error": { + "type": "string", + "description": "์ž์„ธํ•œ ์˜ค๋ฅ˜ ์„ค๋ช…." + } + } + } + } + } + } + } + }, + "patch": { + "summary": "์—…๋ฐ์ดํŠธ ํ‚ค", + "description": "API ํ‚ค ์†์„ฑ ์—…๋ฐ์ดํŠธ.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ํ‚ค๋ฅผ ์†Œ์œ ํ•œ ์กฐ์ง์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "API key ID", + "description": "์—…๋ฐ์ดํŠธํ•  ํ‚ค์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiKeyPatchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์‘๋‹ต", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/ApiKey" + }, + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "๋ชจ๋“  ์š”์ฒญ์— ๊ณ ์œ ํ•œ ID๊ฐ€ ํ• ๋‹น๋จ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ํด๋ผ์ด์–ธํŠธ ์˜ค๋ฅ˜๋กœ ์ธ์‹๋˜๋Š” ์‚ฌํ•ญ์œผ๋กœ ์ธํ•ด ์„œ๋ฒ„๊ฐ€ ์š”์ฒญ์„ ์ฒ˜๋ฆฌํ•  ์ˆ˜ ์—†๊ฑฐ๋‚˜ ์ฒ˜๋ฆฌํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 400 + }, + "error": { + "type": "string", + "description": "์ž์„ธํ•œ ์˜ค๋ฅ˜ ์„ค๋ช…." + } + } + } + } + } + } + } + }, + "delete": { + "summary": "์‚ญ์ œ ํ‚ค", + "description": "API ํ‚ค๋ฅผ ์‚ญ์ œํ•ฉ๋‹ˆ๋‹ค. ํ™œ์„ฑ ์š”์ฒญ์„ ์ธ์ฆํ•˜๋Š” ๋ฐ ์‚ฌ์šฉ๋˜์ง€ ์•Š๋Š” ํ‚ค๋งŒ ์‚ญ์ œํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค..", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ํ‚ค๋ฅผ ์†Œ์œ ํ•œ ์กฐ์ง์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "API key ID", + "description": "์‚ญ์ œํ•  ํ‚ค์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ] + } + }, + "/v1/organizations/:organizationId/members": { + "get": { + "summary": "์กฐ์ง ๊ตฌ์„ฑ์› ๋ชฉ๋ก", + "description": "์กฐ์ง์˜ ๋ชจ๋“  ๊ตฌ์„ฑ์› ๋ชฉ๋ก์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "์š”์ฒญํ•˜์‹  ์กฐ์ง์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์‘๋‹ต", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Member" + } + }, + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "๋ชจ๋“  ์š”์ฒญ์— ๊ณ ์œ ํ•œ ID๊ฐ€ ํ• ๋‹น๋จ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ํด๋ผ์ด์–ธํŠธ ์˜ค๋ฅ˜๋กœ ์ธ์‹๋˜๋Š” ์‚ฌํ•ญ์œผ๋กœ ์ธํ•ด ์„œ๋ฒ„๊ฐ€ ์š”์ฒญ์„ ์ฒ˜๋ฆฌํ•  ์ˆ˜ ์—†๊ฑฐ๋‚˜ ์ฒ˜๋ฆฌํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 400 + }, + "error": { + "type": "string", + "description": "์ž์„ธํ•œ ์˜ค๋ฅ˜ ์„ค๋ช…." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/members/:userId": { + "get": { + "summary": "ํšŒ์› ์ •๋ณด ๋ฐ›๊ธฐ", + "description": "๋‹จ์ผ ์กฐ์ง ๊ตฌ์„ฑ์› ์„ธ๋ถ€ ์ •๋ณด๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ํšŒ์›์ด ์†ํ•œ ์กฐ์ง์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "User ID", + "description": "์š”์ฒญํ•˜์‹  ์‚ฌ์šฉ์ž์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์‘๋‹ต", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Member" + }, + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "๋ชจ๋“  ์š”์ฒญ์— ๊ณ ์œ ํ•œ ID๊ฐ€ ํ• ๋‹น๋จ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ํด๋ผ์ด์–ธํŠธ ์˜ค๋ฅ˜๋กœ ์ธ์‹๋˜๋Š” ์‚ฌํ•ญ์œผ๋กœ ์ธํ•ด ์„œ๋ฒ„๊ฐ€ ์š”์ฒญ์„ ์ฒ˜๋ฆฌํ•  ์ˆ˜ ์—†๊ฑฐ๋‚˜ ์ฒ˜๋ฆฌํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 400 + }, + "error": { + "type": "string", + "description": "์ž์„ธํ•œ ์˜ค๋ฅ˜ ์„ค๋ช…." + } + } + } + } + } + } + } + }, + "patch": { + "summary": "์กฐ์ง ๊ตฌ์„ฑ์› ์—…๋ฐ์ดํŠธ.", + "description": "์กฐ์ง ๊ตฌ์„ฑ์› ์—ญํ•  ์—…๋ฐ์ดํŠธ.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "ํšŒ์›์ด ์†ํ•œ ์กฐ์ง์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "User ID", + "description": "ํŒจ์น˜ํ•  ์‚ฌ์šฉ์ž์˜ ID", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MemberPatchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์‘๋‹ต", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Member" + }, + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "๋ชจ๋“  ์š”์ฒญ์— ๊ณ ์œ ํ•œ ID๊ฐ€ ํ• ๋‹น๋จ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ํด๋ผ์ด์–ธํŠธ ์˜ค๋ฅ˜๋กœ ์ธ์‹๋˜๋Š” ์‚ฌํ•ญ์œผ๋กœ ์ธํ•ด ์„œ๋ฒ„๊ฐ€ ์š”์ฒญ์„ ์ฒ˜๋ฆฌํ•  ์ˆ˜ ์—†๊ฑฐ๋‚˜ ์ฒ˜๋ฆฌํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 400 + }, + "error": { + "type": "string", + "description": "์ž์„ธํ•œ ์˜ค๋ฅ˜ ์„ค๋ช…." + } + } + } + } + } + } + } + }, + "delete": { + "summary": "์กฐ์ง ๊ตฌ์„ฑ์› ์ œ๊ฑฐ", + "description": "์กฐ์ง์—์„œ ์‚ฌ์šฉ์ž๋ฅผ ์ œ๊ฑฐํ•ฉ๋‹ˆ๋‹ค.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "์š”์ฒญํ•˜์‹  ์กฐ์ง์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "User ID", + "description": "์š”์ฒญํ•˜์‹  ์‚ฌ์šฉ์ž์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ] + } + }, + "/v1/organizations/:organizationId/invitations": { + "get": { + "summary": "๋ชจ๋“  ์ดˆ๋Œ€์žฅ์„ ๋‚˜์—ดํ•˜์„ธ์š”", + "description": "๋ชจ๋“  ์กฐ์ง ์ดˆ๋Œ€ ๋ชฉ๋ก์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "์š”์ฒญํ•˜์‹  ์กฐ์ง์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์‘๋‹ต", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Invitation" + } + }, + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "๋ชจ๋“  ์š”์ฒญ์— ๊ณ ์œ ํ•œ ID๊ฐ€ ํ• ๋‹น๋จ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ํด๋ผ์ด์–ธํŠธ ์˜ค๋ฅ˜๋กœ ์ธ์‹๋˜๋Š” ์‚ฌํ•ญ์œผ๋กœ ์ธํ•ด ์„œ๋ฒ„๊ฐ€ ์š”์ฒญ์„ ์ฒ˜๋ฆฌํ•  ์ˆ˜ ์—†๊ฑฐ๋‚˜ ์ฒ˜๋ฆฌํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 400 + }, + "error": { + "type": "string", + "description": "์ž์„ธํ•œ ์˜ค๋ฅ˜ ์„ค๋ช…." + } + } + } + } + } + } + } + }, + "post": { + "summary": "์ดˆ๋Œ€์žฅ ๋งŒ๋“ค๊ธฐ", + "description": "์กฐ์ง ์ดˆ๋Œ€์žฅ์„ ๋งŒ๋“ญ๋‹ˆ๋‹ค.", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "์‚ฌ์šฉ์ž๋ฅผ ์ดˆ๋Œ€ํ•  ์กฐ์ง์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InvitationPostRequest" + } + } + } + }, + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์‘๋‹ต", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Invitation" + }, + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "๋ชจ๋“  ์š”์ฒญ์— ๊ณ ์œ ํ•œ ID๊ฐ€ ํ• ๋‹น๋จ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ํด๋ผ์ด์–ธํŠธ ์˜ค๋ฅ˜๋กœ ์ธ์‹๋˜๋Š” ์‚ฌํ•ญ์œผ๋กœ ์ธํ•ด ์„œ๋ฒ„๊ฐ€ ์š”์ฒญ์„ ์ฒ˜๋ฆฌํ•  ์ˆ˜ ์—†๊ฑฐ๋‚˜ ์ฒ˜๋ฆฌํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 400 + }, + "error": { + "type": "string", + "description": "์ž์„ธํ•œ ์˜ค๋ฅ˜ ์„ค๋ช…." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/invitations/:invitationId": { + "get": { + "summary": "์ดˆ๋Œ€์žฅ ์„ธ๋ถ€ ์ •๋ณด ๋ฐ›๊ธฐ", + "description": "๋‹จ์ผ ์กฐ์ง ์ดˆ๋Œ€์— ๋Œ€ํ•œ ์„ธ๋ถ€ ์ •๋ณด๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "์š”์ฒญํ•˜์‹  ์กฐ์ง์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Organization invitation ID", + "description": "์š”์ฒญํ•˜์‹  ์กฐ์ง์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์‘๋‹ต", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Invitation" + }, + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "๋ชจ๋“  ์š”์ฒญ์— ๊ณ ์œ ํ•œ ID๊ฐ€ ํ• ๋‹น๋จ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ํด๋ผ์ด์–ธํŠธ ์˜ค๋ฅ˜๋กœ ์ธ์‹๋˜๋Š” ์‚ฌํ•ญ์œผ๋กœ ์ธํ•ด ์„œ๋ฒ„๊ฐ€ ์š”์ฒญ์„ ์ฒ˜๋ฆฌํ•  ์ˆ˜ ์—†๊ฑฐ๋‚˜ ์ฒ˜๋ฆฌํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 400 + }, + "error": { + "type": "string", + "description": "์ž์„ธํ•œ ์˜ค๋ฅ˜ ์„ค๋ช…." + } + } + } + } + } + } + } + }, + "delete": { + "summary": "์กฐ์ง ์ดˆ๋Œ€ ์‚ญ์ œ", + "description": "๋‹จ์ผ ์กฐ์ง ์ดˆ๋Œ€๋ฅผ ์‚ญ์ œํ•ฉ๋‹ˆ๋‹ค..", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "์ดˆ๋Œ€์žฅ์„ ๋ฐ›์€ ์กฐ์ง์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Organization invitation ID", + "description": "์š”์ฒญํ•˜์‹  ์กฐ์ง์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ] + } + }, + "/v1/organizations/:organizationId/activities": { + "get": { + "summary": "์กฐ์งํ™œ๋™ ๋ชฉ๋ก", + "description": "๋ชจ๋“  ์กฐ์ง ํ™œ๋™ ๋ชฉ๋ก์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "์š”์ฒญํ•˜์‹  ์กฐ์ง์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์‘๋‹ต", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Activity" + } + }, + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "๋ชจ๋“  ์š”์ฒญ์— ๊ณ ์œ ํ•œ ID๊ฐ€ ํ• ๋‹น๋จ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ํด๋ผ์ด์–ธํŠธ ์˜ค๋ฅ˜๋กœ ์ธ์‹๋˜๋Š” ์‚ฌํ•ญ์œผ๋กœ ์ธํ•ด ์„œ๋ฒ„๊ฐ€ ์š”์ฒญ์„ ์ฒ˜๋ฆฌํ•  ์ˆ˜ ์—†๊ฑฐ๋‚˜ ์ฒ˜๋ฆฌํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 400 + }, + "error": { + "type": "string", + "description": "์ž์„ธํ•œ ์˜ค๋ฅ˜ ์„ค๋ช…." + } + } + } + } + } + } + } + } + }, + "/v1/organizations/:organizationId/activities/:activityId": { + "get": { + "summary": "์กฐ์ง ํ™œ๋™", + "description": "ID๋ณ„๋กœ ๋‹จ์ผ ์กฐ์ง ํ™œ๋™์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "parameters": [ + { + "in": "path", + "name": "Organization ID", + "description": "์š”์ฒญํ•˜์‹  ์กฐ์ง์˜ ID.", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "in": "path", + "name": "Activity ID", + "description": "์š”์ฒญ๋œ ํ™œ๋™์˜ ID.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์‘๋‹ต", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Activity" + }, + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 200 + }, + "requestId": { + "type": "string", + "description": "๋ชจ๋“  ์š”์ฒญ์— ๊ณ ์œ ํ•œ ID๊ฐ€ ํ• ๋‹น๋จ. UUIDv4", + "format": "uuid" + } + } + } + } + } + }, + "400": { + "description": "ํด๋ผ์ด์–ธํŠธ ์˜ค๋ฅ˜๋กœ ์ธ์‹๋˜๋Š” ์‚ฌํ•ญ์œผ๋กœ ์ธํ•ด ์„œ๋ฒ„๊ฐ€ ์š”์ฒญ์„ ์ฒ˜๋ฆฌํ•  ์ˆ˜ ์—†๊ฑฐ๋‚˜ ์ฒ˜๋ฆฌํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "number", + "description": "HTTP ์ƒํƒœ ์ฝ”๋“œ.", + "example": 400 + }, + "error": { + "type": "string", + "description": "์ž์„ธํ•œ ์˜ค๋ฅ˜ ์„ค๋ช…." + } + } + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "ServiceEndpoint": { + "properties": { + "protocol": { + "type": "string", + "description": "์—”๋“œํฌ์ธํŠธ ํ”„๋กœํ† ์ฝœ: 'https', 'nativesecure', 'mysql'.", + "enum": [ + "https", + "nativesecure", + "mysql" + ] + }, + "host": { + "type": "string", + "description": "์„œ๋น„์Šค ํ˜ธ์ŠคํŠธ ์ด๋ฆ„" + }, + "port": { + "type": "number", + "description": "์ˆซ์ž ํฌํŠธ" + } + } + }, + "IpAccessListEntry": { + "properties": { + "source": { + "type": "string", + "description": "IP ๋˜๋Š” CIDR" + }, + "description": { + "type": "string", + "description": "์•ก์„ธ์Šค๋ฅผ ํ—ˆ์šฉํ•˜๋ ค๋ฉด IPv4 ์ฃผ์†Œ ๋˜๋Š” IPv4 CIDR์„ ์‚ฌ์šฉํ•˜์„ธ์š”." + } + } + }, + "Service": { + "properties": { + "id": { + "type": "string", + "description": "๊ณ ์œ ํ•œ ์„œ๋น„์Šค ID.", + "format": "uuid" + }, + "name": { + "type": "string", + "description": "์„œ๋น„์Šค ์ด๋ฆ„." + }, + "provider": { + "type": "string", + "description": "ํด๋ผ์šฐ๋“œ ์ œ๊ณต์ž", + "enum": [ + "aws", + "gcp" + ] + }, + "region": { + "type": "string", + "description": "์„œ๋น„์Šค ์ง€์—ญ.", + "enum": [ + "ap-south-1", + "ap-southeast-1", + "eu-central-1", + "eu-west-1", + "us-east-1", + "us-east-2", + "us-west-2", + "ap-southeast-2", + "us-east1", + "us-central1", + "europe-west4", + "asia-southeast1" + ] + }, + "state": { + "type": "string", + "description": "ํ˜„์žฌ ์„œ๋น„์Šค ์ƒํƒœ.", + "enum": [ + "starting", + "stopping", + "terminating", + "provisioning", + "running", + "stopped", + "terminated", + "degraded", + "failed", + "idle" + ] + }, + "endpoints": { + "type": "array", + "description": "๋ชจ๋“  ์„œ๋น„์Šค ์—”๋“œํฌ์ธํŠธ ๋ชฉ๋ก.", + "items": { + "$ref": "#/components/schemas/ServiceEndpoint" + } + }, + "tier": { + "type": "string", + "description": "์„œ๋น„์Šค ๊ณ„์ธต: '๊ฐœ๋ฐœ', '์ƒ์‚ฐ', '์ „์šฉ_๊ณ _๋ฉ”๋ชจ๋ฆฌ', '์ „์šฉ_๊ณ _CPU', '์ „์šฉ_ํ‘œ์ค€'. ์ƒ์‚ฐ ์„œ๋น„์Šค ๊ทœ๋ชจ, ๊ฐœ๋ฐœ์€ ๊ณ ์ • ํฌ๊ธฐ.", + "enum": [ + "development", + "production", + "dedicated_high_mem", + "dedicated_high_cpu", + "dedicated_standard" + ] + }, + "minTotalMemoryGb": { + "type": "number", + "description": "์ž๋™ ํ™•์žฅ ์ค‘ ๋ชจ๋“  ์ž‘์—…์ž์˜ ์ตœ์†Œ ์ด ๋ฉ”๋ชจ๋ฆฌ(GB). 'production' ์„œ๋น„์Šค์—๋งŒ ์‚ฌ์šฉ ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค. 12์˜ ๋ฐฐ์ˆ˜์—ฌ์•ผ ํ•˜๋ฉฐ 24๋ณด๋‹ค ์ปค์•ผ ํ•ฉ๋‹ˆ๋‹ค..", + "minimum": 24, + "maximum": 720, + "multipleOf": 12, + "example": 48 + }, + "maxTotalMemoryGb": { + "type": "number", + "description": "์ž๋™ ํ™•์žฅ ์ค‘ ๋ชจ๋“  ์ž‘์—…์ž์˜ ์ตœ๋Œ€ ์ด ๋ฉ”๋ชจ๋ฆฌ(Gb). 'production' ์„œ๋น„์Šค์—๋งŒ ์‚ฌ์šฉ ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค. ๋น„์œ ๋ฃŒ ์„œ๋น„์Šค์˜ ๊ฒฝ์šฐ 12์˜ ๋ฐฐ์ˆ˜์—ฌ์•ผ ํ•˜๋ฉฐ 360๋ณด๋‹ค ์ž‘์•„์•ผ ํ•˜๊ณ  ์œ ๋ฃŒ ์„œ๋น„์Šค์˜ ๊ฒฝ์šฐ 720๋ณด๋‹ค ์ž‘์•„์•ผ ํ•ฉ๋‹ˆ๋‹ค..", + "minimum": 24, + "maximum": 720, + "multipleOf": 12, + "example": 360 + }, + "idleScaling": { + "type": "boolean", + "description": "true๋กœ ์„ค์ •ํ•˜๋ฉด ์„œ๋น„์Šค๋Š” ์œ ํœด ์ƒํƒœ์ผ ๋•Œ 0์œผ๋กœ ์ถ•์†Œํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๊ฐœ๋ฐœ ์„œ๋น„์Šค์˜ ๊ฒฝ์šฐ ํ•ญ์ƒ true์ž…๋‹ˆ๋‹ค.." + }, + "idleTimeoutMinutes": { + "type": "number", + "description": "์ตœ์†Œ ์œ ํœด ์‹œ๊ฐ„ ์ดˆ๊ณผ(๋ถ„)๋ฅผ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค. 5๋ถ„ ์ด์ƒ์ด์–ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.." + }, + "ipAccessList": { + "type": "array", + "description": "์„œ๋น„์Šค์— ์ ‘๊ทผ์ด ํ—ˆ์šฉ๋œ IP ์ฃผ์†Œ ๋ชฉ๋ก", + "items": { + "$ref": "#/components/schemas/IpAccessListEntry" + } + }, + "createdAt": { + "type": "string", + "description": "์„œ๋น„์Šค ์ƒ์„ฑ ํƒ€์ž„์Šคํƒฌํ”„. ISO-8601.", + "format": "date-time" + } + } + }, + "IpAccessListPatch": { + "properties": { + "add": { + "type": "array", + "description": "์ถ”๊ฐ€ํ•  ์š”์†Œ์ž…๋‹ˆ๋‹ค. "์ œ๊ฑฐ" ๋ถ€๋ถ„์ด ์ฒ˜๋ฆฌ๋œ ํ›„ ์‹คํ–‰๋ฉ๋‹ˆ๋‹ค..", + "items": { + "$ref": "#/components/schemas/IpAccessListEntry" + } + }, + "remove": { + "type": "array", + "description": "์ œ๊ฑฐํ•  ์š”์†Œ์ž…๋‹ˆ๋‹ค. "add" ๋ถ€๋ถ„์ด ์ฒ˜๋ฆฌ๋˜๊ธฐ ์ „์— ์‹คํ–‰๋ฉ๋‹ˆ๋‹ค..", + "items": { + "$ref": "#/components/schemas/IpAccessListEntry" + } + } + } + }, + "Activity": { + "properties": { + "id": { + "type": "string", + "description": "๊ณ ์œ  ํ™œ๋™ ID." + }, + "createdAt": { + "type": "string", + "description": "ํ™œ๋™์˜ ํƒ€์ž„์Šคํƒฌํ”„. ISO-8601.", + "format": "date-time" + }, + "type": { + "type": "string", + "description": "ํ™œ๋™ ์œ ํ˜•.", + "enum": [ + "organization_update_name", + "organization_invite_create", + "organization_invite_delete", + "organization_member_join", + "organization_member_add", + "organization_member_leave", + "organization_member_delete", + "organization_member_update_role", + "key_create", + "key_delete", + "service_create", + "service_start", + "service_stop", + "service_delete", + "service_update_name", + "service_update_ip_access_list", + "service_update_autoscaling_memory", + "service_update_autoscaling_idling", + "service_update_password", + "backup_delete" + ] + }, + "actorType": { + "type": "string", + "description": "์•กํ„ฐ ์œ ํ˜•: '์‚ฌ์šฉ์ž', '์ง€์›', '์‹œ์Šคํ…œ', 'api'.", + "enum": [ + "user", + "support", + "system", + "api" + ] + }, + "actorId": { + "type": "string", + "description": "๊ณ ์œ  ๋ฐฐ์šฐ ID." + }, + "actorDetails": { + "type": "string", + "description": "๋ฐฐ์šฐ์— ๋Œ€ํ•œ ์ถ”๊ฐ€ ์ •๋ณด." + }, + "actorIpAddress": { + "type": "string", + "description": "์•กํ„ฐ์˜ IP ์ฃผ์†Œ์ž…๋‹ˆ๋‹ค. 'user' ๋ฐ 'api' ์•กํ„ฐ ์œ ํ˜•์— ๋Œ€ํ•ด ์ •์˜๋จ." + }, + "organizationId": { + "type": "string", + "description": "ํ™œ๋™ ๋ฒ”์œ„: ์ด ํ™œ๋™์ด ๊ด€๋ จ๋œ ์กฐ์ง ID." + }, + "serviceId": { + "type": "string", + "description": "ํ™œ๋™ ๋ฒ”์œ„: ์ด ํ™œ๋™์ด ๊ด€๋ จ๋œ ์„œ๋น„์Šค ID." + } + } + }, + "Backup": { + "properties": { + "id": { + "type": "string", + "description": "๊ณ ์œ ํ•œ ๋ฐฑ์—… ID.", + "format": "uuid" + }, + "status": { + "type": "string", + "description": "๋ฐฑ์—… ์ƒํƒœ: '์™„๋ฃŒ', '์˜ค๋ฅ˜', '์ง„ํ–‰ ์ค‘'.", + "enum": [ + "done", + "error", + "in_progress" + ] + }, + "serviceId": { + "type": "string", + "description": "์ด๋ฆ„" + }, + "startedAt": { + "type": "string", + "description": "๋ฐฑ์—… ์‹œ์ž‘ ํƒ€์ž„์Šคํƒฌํ”„. ISO-8601.", + "format": "date-time" + }, + "finishedAt": { + "type": "string", + "description": "๋ฐฑ์—… ์™„๋ฃŒ ํƒ€์ž„์Šคํƒฌํ”„. ISO-8601. ์™„๋ฃŒ๋œ ๋ฐฑ์—…์—๋งŒ ์‚ฌ์šฉ ๊ฐ€๋Šฅ", + "format": "date-time" + } + } + }, + "Organization": { + "properties": { + "id": { + "type": "string", + "description": "๊ณ ์œ ํ•œ ์กฐ์ง ID.", + "format": "uuid" + }, + "createdAt": { + "type": "string", + "description": "์กฐ์ง์ด ์ƒ์„ฑ๋œ ํƒ€์ž„์Šคํƒฌํ”„์ž…๋‹ˆ๋‹ค. ISO-8601.", + "format": "date-time" + }, + "name": { + "type": "string", + "description": "์กฐ์ง์˜ ์ด๋ฆ„." + } + } + }, + "Member": { + "properties": { + "userId": { + "type": "string", + "description": "๊ณ ์œ ํ•œ ์‚ฌ์šฉ์ž ID. ์‚ฌ์šฉ์ž๊ฐ€ ์—ฌ๋Ÿฌ ์กฐ์ง์˜ ๋ฉค๋ฒ„์ธ ๊ฒฝ์šฐ ์ด ID๋Š” ๋™์ผํ•˜๊ฒŒ ์œ ์ง€๋ฉ๋‹ˆ๋‹ค.." + }, + "name": { + "type": "string", + "description": "๊ฐœ์ธ ์‚ฌ์šฉ์ž ํ”„๋กœํ•„์„ ์„ค์ •ํ•œ ํšŒ์› ์ด๋ฆ„." + }, + "email": { + "type": "string", + "description": "๊ฐœ์ธ ์‚ฌ์šฉ์ž ํ”„๋กœํ•„์— ์„ค์ •๋œ ํšŒ์›์˜ ์ด๋ฉ”์ผ.", + "format": "email" + }, + "role": { + "type": "string", + "description": "์กฐ์ง ๋‚ด ๊ตฌ์„ฑ์›์˜ ์—ญํ• .", + "enum": [ + "admin", + "developer" + ] + }, + "joinedAt": { + "type": "string", + "description": "ํšŒ์›์ด ์กฐ์ง์— ๊ฐ€์ž…ํ•œ ํƒ€์ž„์Šคํƒฌํ”„. ISO-8601.", + "format": "date-time" + } + } + }, + "Invitation": { + "properties": { + "role": { + "type": "string", + "description": "์กฐ์ง ๋‚ด ๊ตฌ์„ฑ์›์˜ ์—ญํ• .", + "enum": [ + "admin", + "developer" + ] + }, + "id": { + "type": "string", + "description": "๊ณ ์œ  ์ดˆ๋Œ€ ID.", + "format": "uuid" + }, + "email": { + "type": "string", + "description": "์ดˆ๋Œ€๋œ ์‚ฌ์šฉ์ž์˜ ์ด๋ฉ”์ผ. ์ด ์ด๋ฉ”์ผ์„ ๊ฐ€์ง„ ์‚ฌ์šฉ์ž๋งŒ ์ดˆ๋Œ€์žฅ์„ ์‚ฌ์šฉํ•˜์—ฌ ๊ฐ€์ž…ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์ด๋ฉ”์ผ์€ ์†Œ๋ฌธ์ž ํ˜•ํƒœ๋กœ ์ €์žฅ๋ฉ๋‹ˆ๋‹ค..", + "format": "email" + }, + "createdAt": { + "type": "string", + "description": "์ดˆ๋Œ€์žฅ ์ƒ์„ฑ ํƒ€์ž„์Šคํƒฌํ”„. ISO-8601.", + "format": "date-time" + }, + "expireAt": { + "type": "string", + "description": "์ดˆ๋Œ€์žฅ์ด ๋งŒ๋ฃŒ๋˜๋Š” ํƒ€์ž„์Šคํƒฌํ”„์ž…๋‹ˆ๋‹ค. ISO-8601.", + "format": "date-time" + } + } + }, + "ApiKey": { + "properties": { + "id": { + "type": "string", + "description": "๊ณ ์œ ํ•œ API ํ‚ค ID.", + "format": "uuid" + }, + "name": { + "type": "string", + "description": "ํ‚ค์˜ ์ด๋ฆ„" + }, + "state": { + "type": "string", + "description": "ํ‚ค ์ƒํƒœ: 'ํ™œ์„ฑํ™”๋จ', '๋น„ํ™œ์„ฑํ™”๋จ'.", + "enum": [ + "enabled", + "disabled" + ] + }, + "roles": { + "type": "array", + "description": "ํ‚ค์— ํ• ๋‹น๋œ ์—ญํ•  ๋ชฉ๋ก์ž…๋‹ˆ๋‹ค. ์ตœ์†Œ 1๊ฐœ์˜ ์š”์†Œ๋ฅผ ํฌํ•จํ•ฉ๋‹ˆ๋‹ค..", + "items": { + "type": "string", + "enum": [ + "admin", + "developer" + ] + } + }, + "keySuffix": { + "type": "string", + "description": "ํ‚ค์˜ ๋งˆ์ง€๋ง‰ 4๊ธ€์ž." + }, + "createdAt": { + "type": "string", + "description": "ํ‚ค๊ฐ€ ์ƒ์„ฑ๋œ ํƒ€์ž„์Šคํƒฌํ”„. ISO-8601.", + "format": "date-time" + }, + "expireAt": { + "type": "string", + "description": "ํ‚ค๊ฐ€ ๋งŒ๋ฃŒ๋˜๋Š” ํƒ€์ž„์Šคํƒฌํ”„์ž…๋‹ˆ๋‹ค. ์กด์žฌํ•˜์ง€ ์•Š๊ฑฐ๋‚˜ ๋น„์–ด ์žˆ์œผ๋ฉด ํ‚ค๊ฐ€ ๋งŒ๋ฃŒ๋˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค. ISO-8601.", + "format": "date-time" + }, + "usedAt": { + "type": "string", + "description": "ํƒ€์ž„์Šคํƒฌํ”„ ํ‚ค๊ฐ€ ๋งˆ์ง€๋ง‰์œผ๋กœ ์‚ฌ์šฉ๋œ ์‹œ๊ฐ„์ž…๋‹ˆ๋‹ค. ์—†์œผ๋ฉด ํ‚ค๊ฐ€ ์‚ฌ์šฉ๋˜์ง€ ์•Š์€ ๊ฒƒ์ž…๋‹ˆ๋‹ค. ISO-8601.", + "format": "date-time" + } + } + }, + "ApiKeyHashData": { + "properties": { + "keyIdHash": { + "type": "string", + "description": "ํ‚ค ID์˜ ํ•ด์‹œ." + }, + "keyIdSuffix": { + "type": "string", + "description": "ํ‚ค ID์˜ ๋งˆ์ง€๋ง‰ 4์ž๋ฆฌ. ์•Œ๊ณ ๋ฆฌ์ฆ˜: echo -n "yourpassword" | sha256sum | tr -d '-' | xxd -r -p | base64" + }, + "keySecretHash": { + "type": "string", + "description": "ํ‚ค ๋น„๋ฐ€์˜ ํ•ด์‹œ. ์•Œ๊ณ ๋ฆฌ์ฆ˜: echo -n "yourpassword" | sha256sum | tr -d '-' | xxd -r -p | base64" + } + } + }, + "OrganizationPatchRequest": { + "properties": { + "name": { + "type": "string", + "description": "์กฐ์ง์˜ ์ด๋ฆ„." + } + } + }, + "ServicePostRequest": { + "properties": { + "name": { + "type": "string", + "description": "์„œ๋น„์Šค ์ด๋ฆ„." + }, + "provider": { + "type": "string", + "description": "ํด๋ผ์šฐ๋“œ ์ œ๊ณต์ž", + "enum": [ + "aws", + "gcp" + ] + }, + "region": { + "type": "string", + "description": "์„œ๋น„์Šค ์ง€์—ญ.", + "enum": [ + "ap-south-1", + "ap-southeast-1", + "eu-central-1", + "eu-west-1", + "us-east-1", + "us-east-2", + "us-west-2", + "ap-southeast-2", + "us-east1", + "us-central1", + "europe-west4", + "asia-southeast1" + ] + }, + "tier": { + "type": "string", + "description": "์„œ๋น„์Šค ๊ณ„์ธต: '๊ฐœ๋ฐœ', '์ƒ์‚ฐ', '์ „์šฉ_๊ณ _๋ฉ”๋ชจ๋ฆฌ', '์ „์šฉ_๊ณ _CPU', '์ „์šฉ_ํ‘œ์ค€'. ์ƒ์‚ฐ ์„œ๋น„์Šค ๊ทœ๋ชจ, ๊ฐœ๋ฐœ์€ ๊ณ ์ • ํฌ๊ธฐ.", + "enum": [ + "development", + "production", + "dedicated_high_mem", + "dedicated_high_cpu", + "dedicated_standard" + ] + }, + "ipAccessList": { + "type": "array", + "description": "์„œ๋น„์Šค์— ์ ‘๊ทผ์ด ํ—ˆ์šฉ๋œ IP ์ฃผ์†Œ ๋ชฉ๋ก", + "items": { + "$ref": "#/components/schemas/IpAccessListEntry" + } + }, + "minTotalMemoryGb": { + "type": "number", + "description": "์ž๋™ ํ™•์žฅ ์ค‘ ๋ชจ๋“  ์ž‘์—…์ž์˜ ์ตœ์†Œ ์ด ๋ฉ”๋ชจ๋ฆฌ(GB). 'production' ์„œ๋น„์Šค์—๋งŒ ์‚ฌ์šฉ ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค. 12์˜ ๋ฐฐ์ˆ˜์—ฌ์•ผ ํ•˜๋ฉฐ 24๋ณด๋‹ค ์ปค์•ผ ํ•ฉ๋‹ˆ๋‹ค..", + "minimum": 24, + "maximum": 720, + "multipleOf": 12, + "example": 48 + }, + "maxTotalMemoryGb": { + "type": "number", + "description": "์ž๋™ ํ™•์žฅ ์ค‘ ๋ชจ๋“  ์ž‘์—…์ž์˜ ์ตœ๋Œ€ ์ด ๋ฉ”๋ชจ๋ฆฌ(Gb). 'production' ์„œ๋น„์Šค์—๋งŒ ์‚ฌ์šฉ ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค. ๋น„์œ ๋ฃŒ ์„œ๋น„์Šค์˜ ๊ฒฝ์šฐ 12์˜ ๋ฐฐ์ˆ˜์—ฌ์•ผ ํ•˜๋ฉฐ 360๋ณด๋‹ค ์ž‘์•„์•ผ ํ•˜๊ณ  ์œ ๋ฃŒ ์„œ๋น„์Šค์˜ ๊ฒฝ์šฐ 720๋ณด๋‹ค ์ž‘์•„์•ผ ํ•ฉ๋‹ˆ๋‹ค..", + "minimum": 24, + "maximum": 720, + "multipleOf": 12, + "example": 360 + }, + "idleScaling": { + "type": "boolean", + "description": "true๋กœ ์„ค์ •ํ•˜๋ฉด ์„œ๋น„์Šค๋Š” ์œ ํœด ์ƒํƒœ์ผ ๋•Œ 0์œผ๋กœ ์ถ•์†Œํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๊ฐœ๋ฐœ ์„œ๋น„์Šค์˜ ๊ฒฝ์šฐ ํ•ญ์ƒ true์ž…๋‹ˆ๋‹ค.." + }, + "idleTimeoutMinutes": { + "type": "number", + "description": "์ตœ์†Œ ์œ ํœด ์‹œ๊ฐ„ ์ดˆ๊ณผ(๋ถ„)๋ฅผ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค. 5๋ถ„ ์ด์ƒ์ด์–ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.." + }, + "backupId": { + "type": "string", + "description": "์ƒˆ ์„œ๋น„์Šค์˜ ์ดˆ๊ธฐ ์ƒํƒœ๋กœ ์‚ฌ์šฉ๋˜๋Š” ์„ ํƒ์  ๋ฐฑ์—… ID์ž…๋‹ˆ๋‹ค. ์‚ฌ์šฉํ•  ๊ฒฝ์šฐ ์ƒˆ ์ธ์Šคํ„ด์Šค์˜ ์ง€์—ญ ๋ฐ ๊ณ„์ธต์€ ์›๋ž˜ ์ธ์Šคํ„ด์Šค์˜ ๊ฐ’๊ณผ ๋™์ผํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค..", + "format": "uuid" + } + } + }, + "ServicePostResponse": { + "properties": { + "service": { + "$ref": "#/components/schemas/Service" + }, + "password": { + "type": "string", + "description": "์ƒˆ๋กœ ์ƒ์„ฑ๋œ ์„œ๋น„์Šค์˜ ๋น„๋ฐ€๋ฒˆํ˜ธ." + } + } + }, + "ServicePatchRequest": { + "properties": { + "name": { + "type": "string", + "description": "์„œ๋น„์Šค ์ด๋ฆ„." + }, + "ipAccessList": { + "$ref": "#/components/schemas/IpAccessListPatch" + } + } + }, + "ServiceStatePatchRequest": { + "properties": { + "command": { + "type": "string", + "description": "์ƒํƒœ๋ฅผ ๋ณ€๊ฒฝํ•˜๋Š” ๋ช…๋ น: '์‹œ์ž‘', '์ค‘์ง€'.", + "enum": [ + "start", + "stop" + ] + } + } + }, + "ServiceScalingPatchRequest": { + "properties": { + "minTotalMemoryGb": { + "type": "number", + "description": "์ž๋™ ํ™•์žฅ ์ค‘ ๋ชจ๋“  ์ž‘์—…์ž์˜ ์ตœ์†Œ ์ด ๋ฉ”๋ชจ๋ฆฌ(GB). 'production' ์„œ๋น„์Šค์—๋งŒ ์‚ฌ์šฉ ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค. 12์˜ ๋ฐฐ์ˆ˜์—ฌ์•ผ ํ•˜๋ฉฐ 24๋ณด๋‹ค ์ปค์•ผ ํ•ฉ๋‹ˆ๋‹ค..", + "minimum": 24, + "maximum": 720, + "multipleOf": 12, + "example": 48 + }, + "maxTotalMemoryGb": { + "type": "number", + "description": "์ž๋™ ํ™•์žฅ ์ค‘ ๋ชจ๋“  ์ž‘์—…์ž์˜ ์ตœ๋Œ€ ์ด ๋ฉ”๋ชจ๋ฆฌ(Gb). 'production' ์„œ๋น„์Šค์—๋งŒ ์‚ฌ์šฉ ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค. ๋น„์œ ๋ฃŒ ์„œ๋น„์Šค์˜ ๊ฒฝ์šฐ 12์˜ ๋ฐฐ์ˆ˜์—ฌ์•ผ ํ•˜๋ฉฐ 360๋ณด๋‹ค ์ž‘์•„์•ผ ํ•˜๊ณ  ์œ ๋ฃŒ ์„œ๋น„์Šค์˜ ๊ฒฝ์šฐ 720๋ณด๋‹ค ์ž‘์•„์•ผ ํ•ฉ๋‹ˆ๋‹ค..", + "minimum": 24, + "maximum": 720, + "multipleOf": 12, + "example": 360 + }, + "idleScaling": { + "type": "boolean", + "description": "true๋กœ ์„ค์ •ํ•˜๋ฉด ์„œ๋น„์Šค๋Š” ์œ ํœด ์ƒํƒœ์ผ ๋•Œ 0์œผ๋กœ ์ถ•์†Œํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๊ฐœ๋ฐœ ์„œ๋น„์Šค์˜ ๊ฒฝ์šฐ ํ•ญ์ƒ true์ž…๋‹ˆ๋‹ค.." + }, + "idleTimeoutMinutes": { + "type": "number", + "description": "์ตœ์†Œ ์œ ํœด ์‹œ๊ฐ„ ์ดˆ๊ณผ(๋ถ„)๋ฅผ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค. 5๋ถ„ ์ด์ƒ์ด์–ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.." + } + } + }, + "ServicePasswordPatchRequest": { + "properties": { + "newPasswordHash": { + "type": "string", + "description": "์„ ํƒ ์‚ฌํ•ญ์ธ ๋น„๋ฐ€๋ฒˆํ˜ธ ํ•ด์‹œ์ž…๋‹ˆ๋‹ค. ๋„คํŠธ์›Œํฌ๋ฅผ ํ†ตํ•œ ๋น„๋ฐ€๋ฒˆํ˜ธ ์ „์†ก์„ ๋ฐฉ์ง€ํ•˜๋Š” ๋ฐ ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ƒˆ ๋น„๋ฐ€๋ฒˆํ˜ธ๊ฐ€ ์ƒ์„ฑ๋˜์–ด ์‘๋‹ต์— ์ œ๊ณต๋ฉ๋‹ˆ๋‹ค. ๊ทธ๋ ‡์ง€ ์•Š์œผ๋ฉด ์ด ํ•ด์‹œ๊ฐ€ ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ์•Œ๊ณ ๋ฆฌ์ฆ˜: echo -n "yourpassword" | sha256sum | tr -d '-' | xxd -r -p | base64" + }, + "newDoubleSha1Hash": { + "type": "string", + "description": "MySQL ํ”„๋กœํ† ์ฝœ์— ๋Œ€ํ•œ ์„ ํƒ์  ์ด์ค‘ SHA1 ์•”ํ˜ธ ํ•ด์‹œ. newPasswordHash๊ฐ€ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ด ํ‚ค๋Š” ๋ฌด์‹œ๋˜๊ณ  ์ƒ์„ฑ๋œ ์•”ํ˜ธ๊ฐ€ ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ์ด ํ•„๋“œ๋ฅผ ํ™œ์„ฑํ™”ํ•˜๋ ค๋ฉด ์‹คํ—˜์ ์ด๋ฏ€๋กœ ์ง€์›ํŒ€์— ๋ฌธ์˜ํ•˜์„ธ์š”. ์•Œ๊ณ ๋ฆฌ์ฆ˜: echo -n "yourpassword" | sha1sum | tr -d '-' | xxd -r -p | sha1sum | tr -d '-'" + } + } + }, + "ServicePasswordPatchResponse": { + "properties": { + "password": { + "type": "string", + "description": "์ƒˆ๋กœ์šด ์„œ๋น„์Šค ๋น„๋ฐ€๋ฒˆํ˜ธ. ์š”์ฒญ์— 'newPasswordHash'๊ฐ€ ์—†๋Š” ๊ฒฝ์šฐ์—๋งŒ ์ œ๊ณต๋ฉ๋‹ˆ๋‹ค." + } + } + }, + "ApiKeyPostRequest": { + "properties": { + "name": { + "type": "string", + "description": "ํ‚ค์˜ ์ด๋ฆ„." + }, + "expireAt": { + "type": "string", + "description": "ํ‚ค๊ฐ€ ๋งŒ๋ฃŒ๋˜๋Š” ํƒ€์ž„์Šคํƒฌํ”„์ž…๋‹ˆ๋‹ค. ์กด์žฌํ•˜์ง€ ์•Š๊ฑฐ๋‚˜ ๋น„์–ด ์žˆ์œผ๋ฉด ํ‚ค๊ฐ€ ๋งŒ๋ฃŒ๋˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค. ISO-8601.", + "format": "date-time" + }, + "state": { + "type": "string", + "description": "ํ‚ค์˜ ์ดˆ๊ธฐ ์ƒํƒœ: 'ํ™œ์„ฑํ™”๋จ', '๋น„ํ™œ์„ฑํ™”๋จ'. ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ƒˆ ํ‚ค๋Š” 'ํ™œ์„ฑํ™”๋จ'์ด ๋ฉ๋‹ˆ๋‹ค..", + "enum": [ + "enabled", + "disabled" + ] + }, + "hashData": { + "$ref": "#/components/schemas/ApiKeyHashData" + }, + "roles": { + "type": "array", + "description": "ํ‚ค์— ํ• ๋‹น๋œ ์—ญํ•  ๋ชฉ๋ก์ž…๋‹ˆ๋‹ค. ์ตœ์†Œ 1๊ฐœ์˜ ์š”์†Œ๋ฅผ ํฌํ•จํ•ฉ๋‹ˆ๋‹ค..", + "items": { + "type": "string", + "enum": [ + "admin", + "developer" + ] + } + } + } + }, + "ApiKeyPostResponse": { + "properties": { + "key": { + "$ref": "#/components/schemas/ApiKey" + }, + "keyId": { + "type": "string", + "description": "์ƒ์„ฑ๋œ ํ‚ค ID. ์š”์ฒญ์— 'hashData'๊ฐ€ ์—†๋Š” ๊ฒฝ์šฐ์—๋งŒ ์ œ๊ณต๋ฉ๋‹ˆ๋‹ค.." + }, + "keySecret": { + "type": "string", + "description": "์ƒ์„ฑ๋œ ํ‚ค ๋น„๋ฐ€. ์š”์ฒญ์— 'hashData'๊ฐ€ ์—†๋Š” ๊ฒฝ์šฐ์—๋งŒ ์ œ๊ณต๋ฉ๋‹ˆ๋‹ค.." + } + } + }, + "ApiKeyPatchRequest": { + "properties": { + "name": { + "type": "string", + "description": "ํ‚ค์˜ ์ด๋ฆ„" + }, + "roles": { + "type": "array", + "description": "ํ‚ค์— ํ• ๋‹น๋œ ์—ญํ•  ๋ชฉ๋ก์ž…๋‹ˆ๋‹ค. ์ตœ์†Œ 1๊ฐœ์˜ ์š”์†Œ๋ฅผ ํฌํ•จํ•ฉ๋‹ˆ๋‹ค..", + "items": { + "type": "string", + "enum": [ + "admin", + "developer" + ] + } + }, + "expireAt": { + "type": "string", + "description": "ํ‚ค๊ฐ€ ๋งŒ๋ฃŒ๋˜๋Š” ํƒ€์ž„์Šคํƒฌํ”„์ž…๋‹ˆ๋‹ค. ์กด์žฌํ•˜์ง€ ์•Š๊ฑฐ๋‚˜ ๋น„์–ด ์žˆ์œผ๋ฉด ํ‚ค๊ฐ€ ๋งŒ๋ฃŒ๋˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค. ISO-8601.", + "format": "date-time" + }, + "state": { + "type": "string", + "description": "ํ‚ค ์ƒํƒœ: 'ํ™œ์„ฑํ™”๋จ', '๋น„ํ™œ์„ฑํ™”๋จ'.", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "MemberPatchRequest": { + "properties": { + "role": { + "type": "string", + "description": "์กฐ์ง ๋‚ด ๊ตฌ์„ฑ์›์˜ ์—ญํ• .", + "enum": [ + "admin", + "developer" + ] + } + } + }, + "InvitationPostRequest": { + "properties": { + "email": { + "type": "string", + "description": "์ดˆ๋Œ€๋œ ์‚ฌ์šฉ์ž์˜ ์ด๋ฉ”์ผ. ์ด ์ด๋ฉ”์ผ์„ ๊ฐ€์ง„ ์‚ฌ์šฉ์ž๋งŒ ์ดˆ๋Œ€์žฅ์„ ์‚ฌ์šฉํ•˜์—ฌ ๊ฐ€์ž…ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์ด๋ฉ”์ผ์€ ์†Œ๋ฌธ์ž ํ˜•ํƒœ๋กœ ์ €์žฅ๋ฉ๋‹ˆ๋‹ค..", + "format": "email" + }, + "role": { + "type": "string", + "description": "์กฐ์ง ๋‚ด ๊ตฌ์„ฑ์›์˜ ์—ญํ• .", + "enum": [ + "admin", + "developer" + ] + } + } + } + } + }, + "x-samchon-emended": true +} \ No newline at end of file diff --git a/assets/output/connector.swagger.ar.json b/assets/output/connector.swagger.ar.json index 96c38a5..fa4a086 100644 --- a/assets/output/connector.swagger.ar.json +++ b/assets/output/connector.swagger.ar.json @@ -893,8 +893,8 @@ }, "/connector/google-docs/get-list": { "post": { - "summary": "ุงุญุตู„ ุนู„ู‰ ู‚ุงุฆู…ุฉ ู…ุณุชู†ุฏุงุช Google", - "description": "ุงุญุตู„ ุนู„ู‰ ู‚ุงุฆู…ุฉ ู…ุณุชู†ุฏุงุช Google", + "summary": "ุงุญุตู„ ุนู„ู‰ ู‚ุงุฆู…ุฉ ุจู…ุณุชู†ุฏุงุช Google", + "description": "ุงุญุตู„ ุนู„ู‰ ู‚ุงุฆู…ุฉ ุจู…ุณุชู†ุฏุงุช Google", "tags": [ "Google Docs" ], @@ -1262,7 +1262,7 @@ }, "responses": { "201": { - "description": "ุงู„ู…ุนุฑู ุงู„ูุฑูŠุฏ ู„ู„ุชู‚ูˆูŠู… ูˆุนู†ูˆุงู† ุงู„ุชู‚ูˆูŠู…", + "description": "ู…ุนุฑู ูุฑูŠุฏ ู„ู„ุชู‚ูˆูŠู… ูˆุนู†ูˆุงู† ุงู„ุชู‚ูˆูŠู…", "content": { "application/json": { "schema": { @@ -1845,7 +1845,7 @@ } }, "required": true, - "description": "ุงู„ู…ุนุฑู ุงู„ูุฑูŠุฏ ู„ู„ู…ุฌู„ุฏ ุงู„ุฐูŠ ุณูŠุชู… ุญุฐูู‡" + "description": "ู…ุนุฑู ูุฑูŠุฏ ู„ู„ู…ุฌู„ุฏ ุงู„ุฐูŠ ุณูŠุชู… ุญุฐูู‡" } ], "requestBody": { @@ -4261,7 +4261,7 @@ "/connector/open-data/getCopyRight": { "post": { "summary": "[ุฎุฏู…ุฉ ู…ุนู„ูˆู…ุงุช ุชุณุฌูŠู„ ุญู‚ูˆู‚ ุงู„ู†ุดุฑ (ุฌุฏูŠุฏุฉ)]", - "description": "[ู„ุฌู†ุฉ ุญู‚ูˆู‚ ุงู„ุทุจุน ูˆุงู„ู†ุดุฑ ุงู„ูƒูˆุฑูŠุฉ] ูŠุจุญุซ ุนู† ู…ุนู„ูˆู…ุงุช ุญู‚ูˆู‚ ุงู„ุทุจุน ูˆุงู„ู†ุดุฑ ูˆูŠุนุชู…ุฏ ู‡ุฐุง ุงู„ุงุชุตุงู„ ุนู„ู‰ ุงู„ุจูŠุงู†ุงุช ุงู„ุชูŠ ุชู… ุงู„ุญุตูˆู„ ุนู„ูŠู‡ุง ู…ู† ุจูˆุงุจุงุช ุงู„ุจูŠุงู†ุงุช ุงู„ุนุงู…ุฉ ููŠ ูƒูˆุฑูŠุง. ุฅุฐุง ูƒู†ุช ุชุชุญุฏุซ ุนู† ู…ู†ุธู…ุฉ ู…ุนูŠู†ุฉ ู‡ู†ุงุŒ ูู‡ูŠ ู…ู†ุธู…ุฉ ููŠ ูƒูˆุฑูŠุงุŒ ูˆุงู„ู…ุนู„ูˆู…ุงุช ุฃูˆ ุงู„ุญู‚ุงุฆู‚ ุงู„ู‚ุงุจู„ุฉ ู„ู„ุงุณุชู†ุชุงุฌ ุงู„ุชูŠ ุชุดูŠุฑ ุฅู„ูŠู‡ุง ุงู„ุจูŠุงู†ุงุช ุฃูˆ ุงู„ุฅุญุตุงุฆูŠุงุช ูŠู…ูƒู† ุฃู† ุชู‚ุชุตุฑ ุฃูŠุถู‹ุง ุนู„ู‰ ูƒูˆุฑูŠุง. ูˆุจู…ุง ุฃู† ู‡ุฐู‡ ุจูŠุงู†ุงุช ุนุงู…ุฉ ูƒูˆุฑูŠุฉุŒ ูู‚ุฏ ูŠู„ุฒู… ุฅุฌุฑุงุก ู…ุนุธู… ุนู…ู„ูŠุงุช ุงู„ุจุญุซ ุจุงู„ู„ุบุฉ ุงู„ูƒูˆุฑูŠุฉ. ูŠุฑุฌู‰ ุฃู† ุชูƒูˆู† ุนู„ู‰ ุนู„ู… ุจู‡ุฐุง. - ์ œํ˜ธ(๋ช…์นญ): ์ €์ž‘๋ฌผ์˜ ๋ช…์นญ์„ ๋ช…์นญ์„ ๋ง๋กœุŒ ์‚ฌ์šฉ์ž๊ฐ€ ์–ด๋ ค์›Œํ•  ์ˆ˜ ์žˆ๊ธฐ ๋•Œ๋ฌธ์— ์‰ฝ๊ฒŒ ํ’€์–ด ู‡ุฐุง ู‡ูˆ ุงู„ุญู„ ุงู„ุฃู…ุซู„.", + "description": "[ู„ุฌู†ุฉ ุญู‚ูˆู‚ ุงู„ุทุจุน ูˆุงู„ู†ุดุฑ ุงู„ูƒูˆุฑูŠุฉ] ูŠุจุญุซ ุนู† ู…ุนู„ูˆู…ุงุช ุญู‚ูˆู‚ ุงู„ุทุจุน ูˆุงู„ู†ุดุฑ. ูŠุนุชู…ุฏ ู‡ุฐุง ุงู„ุงุชุตุงู„ ุนู„ู‰ ุงู„ุจูŠุงู†ุงุช ุงู„ุชูŠ ุชู… ุงู„ุญุตูˆู„ ุนู„ูŠู‡ุง ู…ู† ุจูˆุงุจุงุช ุงู„ุจูŠุงู†ุงุช ุงู„ุนุงู…ุฉ ููŠ ูƒูˆุฑูŠุง. ุฅุฐุง ูƒู†ุช ุชุชุญุฏุซ ุนู† ู…ู†ุธู…ุฉ ู…ุนูŠู†ุฉ ู‡ู†ุงุŒ ูู‡ูŠ ู…ู†ุธู…ุฉ ููŠ ูƒูˆุฑูŠุงุŒ ูˆุงู„ู…ุนู„ูˆู…ุงุช ุฃูˆ ุงู„ุญู‚ุงุฆู‚ ุงู„ู‚ุงุจู„ุฉ ู„ู„ุงุณุชู†ุชุงุฌ ุงู„ุชูŠ ุชุดูŠุฑ ุฅู„ูŠู‡ุง ุงู„ุจูŠุงู†ุงุช ุฃูˆ ุงู„ุฅุญุตุงุฆูŠุงุช ูŠู…ูƒู† ุฃู† ุชู‚ุชุตุฑ ุฃูŠุถู‹ุง ุนู„ู‰ ูƒูˆุฑูŠุง. ูˆู†ุธุฑู‹ุง ู„ุฃู† ู‡ุฐู‡ ุจูŠุงู†ุงุช ุนุงู…ุฉ ูƒูˆุฑูŠุฉุŒ ูู‚ุฏ ูŠู„ุฒู… ุฅุฌุฑุงุก ู…ุนุธู… ุนู…ู„ูŠุงุช ุงู„ุจุญุซ ุจุงู„ู„ุบุฉ ุงู„ูƒูˆุฑูŠุฉ. ูŠุฑุฌู‰ ุฃู† ุชูƒูˆู† ุนู„ู‰ ุนู„ู… ุจู‡ุฐุง. - ์ œํ˜ธ(๋ช…์นญ): ์ €์ž‘๋ฌผ์˜ ๋ช…์นญ์„ ๋ช…์นญ์„ ๋ง๋กœุŒ ์‚ฌ์šฉ์ž๊ฐ€ ์–ด๋ ค์›Œํ•  ์ˆ˜ ์žˆ๊ธฐ ๋•Œ๋ฌธ์— ์‰ฝ๊ฒŒ ํ’€์–ด ู‡ุฐุง ู‡ูˆ ุงู„ุญู„ ุงู„ุฃู…ุซู„.", "tags": [ "Open Data" ], @@ -4843,7 +4843,7 @@ }, "responses": { "201": { - "description": "ู†ุชุงุฆุฌ ุงู„ุจุญุซ ุนู† ุงู„ูˆุธุงุฆู", + "description": "ู†ุชุงุฆุฌ ุงู„ุจุญุซ ุนู† ุงู„ูˆุธุงุฆู ุงู„ุดุงุบุฑุฉ", "content": { "application/json": { "schema": { @@ -5566,7 +5566,7 @@ "/connector/google-ads/get-ads": { "post": { "summary": "ุงุณุชุฑุฌุงุน ู‚ุงุฆู…ุฉ ุฅุนู„ุงู†ุงุช ุงู„ุญู…ู„ุฉ", - "description": "ุงุญุตู„ ุนู„ู‰ ู‚ุงุฆู…ุฉ ุงู„ุฅุนู„ุงู†ุงุช ู…ู† ุญุณุงุจ ุนู…ูŠู„ Google ู…ุฑุฑ `customerId` ุฅู„ู‰ ุงู„ู…ุณุชุฎุฏู… ูˆุงุจุญุซ ุนู† ุงู„ุฅุนู„ุงู†ุงุช (=ad) ููŠ ุญุณุงุจ ุฅุนู„ุงู† ุงู„ุนู…ูŠู„. ุฅุฐุง ู„ู… ูŠุชู… ุชู…ุฑูŠุฑ `customerId`ุŒ ูุณูŠุชู… ุชุญุฏูŠุฏู‡ ุชู„ู‚ุงุฆูŠู‹ุง ูู‚ุท ุฅุฐุง ูƒุงู† ู‡ู†ุงูƒ ุญุณุงุจ ุฅุนู„ุงู† ูˆุงุญุฏ ูู‚ุท ูŠู…ูƒู† ุงู„ูˆุตูˆู„ ุฅู„ูŠู‡ ุจูˆุงุณุทุฉ `Wrtn` ู…ู† ุงู„ู…ุณุชุฎุฏู…. ุงู„ุฅุนู„ุงู† ู‡ูˆ ุนู‚ุฏุฉ ููŠ ู†ู‡ุงูŠุฉ ุจู†ูŠุฉ ุดุฌุฑุฉ ุชุชูƒูˆู† ู…ู† ุงู„ุญู…ู„ุงุช ูˆู…ุฌู…ูˆุนุงุช ุงู„ุฅุนู„ุงู†ุงุช ูˆุงู„ุฅุนู„ุงู†ุงุชุŒ ูˆู‡ูˆ ู‚ุณู… ู…ุณุคูˆู„ ุนู† ุงู„ู…ูˆุงุฏุŒ ูˆู‡ูˆ ุฃูŠุถู‹ุง ูˆุญุฏุฉ ู…ูƒุดูˆูุฉ ู„ู„ู…ุณุชุฎุฏู…ูŠู† ุงู„ู†ู‡ุงุฆูŠูŠู†. ุฅุฐุง ุชู… ุชู…ุฑูŠุฑ ุงุณู… ุงู„ู…ูˆุฑุฏ ู„ู…ุฌู…ูˆุนุฉ ุฅุนู„ุงู†ุงุช (=adGroup) ูƒุญุฌุฉุŒ ูุณูŠุชู… ุงู„ุจุญุซ ุนู† ุงู„ุฅุนู„ุงู†ุงุช ุงู„ุชูŠ ุชู†ุชู…ูŠ ุฅู„ู‰ ู…ุฌู…ูˆุนุฉ ุงู„ุฅุนู„ุงู†ุงุช ู‡ุฐู‡ ูู‚ุท. ุงู„ุบุฑุถ ู…ู† ู‡ุฐุง ุงู„ู…ูˆุตู„ ู‡ูˆ ุชุญุฏูŠุฏ ู…ุง ุฅุฐุง ูƒุงู† ุฅุนู„ุงู† ุงู„ู…ุณุชุฎุฏู… ู‚ูŠุฏ ุงู„ุชุดุบูŠู„ ุญุงู„ูŠู‹ุง ุฃู… ู„ุง. ููŠ ุญุงู„ุฉ ู…ุฏูŠุฑูŠ `Wrtn`ุŒ ู„ุง ูŠุชู… ุชุบูŠูŠุฑ ุงู„ุญู…ู„ุงุช ูˆู…ุฌู…ูˆุนุงุช ุงู„ุฅุนู„ุงู†ุงุช ุฅู„ู‰ ุญุงู„ุฉ `PAUSED` ู…ุง ู„ู… ูŠุบูŠุฑ ุงู„ู…ุณุชุฎุฏู… ุญุงู„ุฉ ุงู„ุญู…ู„ุฉ ูˆู…ุฌู…ูˆุนุฉ ุงู„ุฅุนู„ุงู†ุงุช ู…ุจุงุดุฑุฉู‹ ููŠ ู„ูˆุญุฉ ู…ุนู„ูˆู…ุงุช ุฅุนู„ุงู†ุงุช Google. ู„ุฐู„ูƒุŒ ุจุดูƒู„ ุนุงู…ุŒ ุฅุฐุง ูƒุงู†ุช ุญุงู„ุฉ ุงู„ุฅุนู„ุงู† ู‡ูŠ ENABLEDุŒ ูุฅู† ุงู„ุฅุนู„ุงู† ู‚ูŠุฏ ุงู„ุชุดุบูŠู„ุŒ ูˆุฅุฐุง ูƒุงู†ุช ENABLEDุŒ ูุฅู† ุงู„ุฅุนู„ุงู† ู…ุชูˆู‚ู. ู…ุฑุฉ ุฃุฎุฑู‰ุŒ ู„ุง ูŠุบูŠุฑ ู…ูˆุตู„ Wrtn ุญุงู„ุฉ ุงู„ุญู…ู„ุฉ ุฃูˆ ู…ุฌู…ูˆุนุฉ ุงู„ุฅุนู„ุงู†ุงุช. ูŠู…ูƒู† ุฃูŠุถู‹ุง ุงุณุชุฎุฏุงู… ู‡ุฐู‡ ุงู„ูˆุธูŠูุฉ ู„ู„ุชุญู‚ู‚ ู…ู…ุง ุฅุฐุง ูƒุงู† ูŠุชู… ุชู†ููŠุฐ ุงู„ุฅุนู„ุงู† ุจุดูƒู„ ุตุญูŠุญ ุจุงู„ุฅุถุงูุฉ ุฅู„ู‰ ุนุฑุถ ุงู„ุฅุนู„ุงู†. ูŠุญุชูˆูŠ ูƒู„ ุฅุนู„ุงู† ุนู„ู‰ ุณุฌู„ ุชู‚ูŠูŠู… ู„ู…ุฑุงุฌุนุฉ ุงู„ุฅุนู„ุงู† ูˆุงู„ุณูŠุงุณุฉุŒ ูˆุงู„ุฐูŠ ูŠูˆุฌุฏ ูƒุฎุงุตูŠุฉ ุชุณู…ู‰ PolicySummary. ุชุญุชูˆูŠ ู‡ุฐู‡ ุงู„ุฎุงุตูŠุฉ ุนู„ู‰ ู…ุง ุฅุฐุง ูƒุงู† ุงู„ุฅุนู„ุงู† ู‚ุฏ ุชู…ุช ุงู„ู…ูˆุงูู‚ุฉ ุนู„ูŠู‡ุŒ ูˆุชุนู†ูŠ ุญุงู„ุฉ APPROVED ุฃู† Google ู‚ุฏ ูˆุงูู‚ุช ุนู„ู‰ ุงู„ู…ุฑุงุฌุนุฉ ูˆู‚ุฑุฑุช ุฃู†ู‡ ู…ุคู‡ู„. ูŠู…ูƒู†ูƒ ุชุบูŠูŠุฑ ุญุงู„ุฉ ุงู„ุฅุนู„ุงู† ููŠ PATCH connector/google-ads/campaigns/ads/status. ู‚ุจู„ ุงุณุชุฏุนุงุก ุงู„ูˆุธูŠูุฉุŒ ูŠุฌุจ ุฃู† ุชุทู„ุจ ู…ู† ุงู„ู…ุณุชุฎุฏู… ู…ุนุฑู ุงู„ุนู…ูŠู„ ุงู„ุฎุงุต ุจู‡ุŒ ู„ุฐุง ูŠุฌุจ ุฃู† ุชู‚ุชุฑุญ ู…ูˆุตู„ู‹ุง ูŠู…ูƒู†ู‡ ุงู„ุชุญู‚ู‚ ู…ู† ู…ุนุฑู ุงู„ุนู…ูŠู„ ุงู„ุฎุงุต ุจู‡.", + "description": "ุงุญุตู„ ุนู„ู‰ ู‚ุงุฆู…ุฉ ุงู„ุฅุนู„ุงู†ุงุช ู…ู† ุญุณุงุจ ุนู…ูŠู„ Google ู…ุฑุฑ `customerId` ุฅู„ู‰ ุงู„ู…ุณุชุฎุฏู… ูˆุงุจุญุซ ุนู† ุงู„ุฅุนู„ุงู†ุงุช (=ad) ููŠ ุญุณุงุจ ุฅุนู„ุงู† ุงู„ุนู…ูŠู„. ุฅุฐุง ู„ู… ูŠุชู… ุชู…ุฑูŠุฑ `customerId`ุŒ ูุณูŠุชู… ุชุญุฏูŠุฏู‡ ุชู„ู‚ุงุฆูŠู‹ุง ูู‚ุท ุฅุฐุง ูƒุงู† ู‡ู†ุงูƒ ุญุณุงุจ ุฅุนู„ุงู† ูˆุงุญุฏ ูู‚ุท ูŠู…ูƒู† ุงู„ูˆุตูˆู„ ุฅู„ูŠู‡ ุจูˆุงุณุทุฉ `Wrtn` ู…ู† ุงู„ู…ุณุชุฎุฏู…. ุงู„ุฅุนู„ุงู† ู‡ูˆ ุนู‚ุฏุฉ ููŠ ู†ู‡ุงูŠุฉ ุจู†ูŠุฉ ุดุฌุฑุฉ ุชุชูƒูˆู† ู…ู† ุงู„ุญู…ู„ุงุช ูˆู…ุฌู…ูˆุนุงุช ุงู„ุฅุนู„ุงู†ุงุช ูˆุงู„ุฅุนู„ุงู†ุงุชุŒ ูˆู‡ูˆ ู‚ุณู… ู…ุณุคูˆู„ ุนู† ุงู„ู…ูˆุงุฏุŒ ูˆู‡ูˆ ุฃูŠุถู‹ุง ูˆุญุฏุฉ ู…ูƒุดูˆูุฉ ู„ู„ู…ุณุชุฎุฏู…ูŠู† ุงู„ู†ู‡ุงุฆูŠูŠู†. ุฅุฐุง ุชู… ุชู…ุฑูŠุฑ ุงุณู… ุงู„ู…ูˆุฑุฏ ู„ู…ุฌู…ูˆุนุฉ ุฅุนู„ุงู†ุงุช (=adGroup) ูƒุญุฌุฉุŒ ูุณูŠุชู… ุงู„ุจุญุซ ุนู† ุงู„ุฅุนู„ุงู†ุงุช ุงู„ุชูŠ ุชู†ุชู…ูŠ ุฅู„ู‰ ู…ุฌู…ูˆุนุฉ ุงู„ุฅุนู„ุงู†ุงุช ู‡ุฐู‡ ูู‚ุท. ุงู„ุบุฑุถ ู…ู† ู‡ุฐุง ุงู„ู…ูˆุตู„ ู‡ูˆ ุชุญุฏูŠุฏ ู…ุง ุฅุฐุง ูƒุงู† ุฅุนู„ุงู† ุงู„ู…ุณุชุฎุฏู… ู‚ูŠุฏ ุงู„ุชุดุบูŠู„ ุญุงู„ูŠู‹ุง ุฃู… ู„ุง. ููŠ ุญุงู„ุฉ ู…ุฏูŠุฑูŠ `Wrtn`ุŒ ู„ุง ูŠุชู… ุชุบูŠูŠุฑ ุงู„ุญู…ู„ุงุช ูˆู…ุฌู…ูˆุนุงุช ุงู„ุฅุนู„ุงู†ุงุช ุฅู„ู‰ ุญุงู„ุฉ `PAUSED` ู…ุง ู„ู… ูŠุบูŠุฑ ุงู„ู…ุณุชุฎุฏู… ุญุงู„ุฉ ุงู„ุญู…ู„ุฉ ูˆู…ุฌู…ูˆุนุฉ ุงู„ุฅุนู„ุงู†ุงุช ู…ุจุงุดุฑุฉู‹ ููŠ ู„ูˆุญุฉ ู…ุนู„ูˆู…ุงุช ุฅุนู„ุงู†ุงุช Google. ู„ุฐู„ูƒุŒ ุจุดูƒู„ ุนุงู…ุŒ ุฅุฐุง ูƒุงู†ุช ุญุงู„ุฉ ุงู„ุฅุนู„ุงู† ู‡ูŠ `ENABLED`ุŒ ูุฅู† ุงู„ุฅุนู„ุงู† ู‚ูŠุฏ ุงู„ุชุดุบูŠู„ุŒ ูˆุฅุฐุง ูƒุงู†ุช `PAUSED`ุŒ ูุฅู† ุงู„ุฅุนู„ุงู† ู…ุชูˆู‚ู. ู…ุฑุฉ ุฃุฎุฑู‰ุŒ ู„ุง ูŠุบูŠุฑ ู…ูˆุตู„ `Wrtn` ุญุงู„ุฉ ุงู„ุญู…ู„ุฉ ุฃูˆ ู…ุฌู…ูˆุนุฉ ุงู„ุฅุนู„ุงู†ุงุช. ูŠู…ูƒู† ุฃูŠุถู‹ุง ุงุณุชุฎุฏุงู… ู‡ุฐู‡ ุงู„ูˆุธูŠูุฉ ู„ู„ุชุญู‚ู‚ ู…ู…ุง ุฅุฐุง ูƒุงู† ูŠุชู… ุชู†ููŠุฐ ุงู„ุฅุนู„ุงู† ุจุดูƒู„ ุตุญูŠุญ ุจุงู„ุฅุถุงูุฉ ุฅู„ู‰ ุนุฑุถ ุงู„ุฅุนู„ุงู†. ูŠุญุชูˆูŠ ูƒู„ ุฅุนู„ุงู† ุนู„ู‰ ุณุฌู„ ุชู‚ูŠูŠู… ู„ู…ุฑุงุฌุนุฉ ุงู„ุฅุนู„ุงู† ูˆุงู„ุณูŠุงุณุฉุŒ ูˆุงู„ุฐูŠ ูŠูˆุฌุฏ ูƒุฎุงุตูŠุฉ ุชุณู…ู‰ `PolicySummary`. ุชุญุชูˆูŠ ู‡ุฐู‡ ุงู„ุฎุงุตูŠุฉ ุนู„ู‰ ู…ุง ุฅุฐุง ูƒุงู† ุงู„ุฅุนู„ุงู† ู‚ุฏ ุชู…ุช ุงู„ู…ูˆุงูู‚ุฉ ุนู„ูŠู‡ุŒ ูˆุชุนู†ูŠ ุญุงู„ุฉ `APPROVED` ุฃู† Google ู‚ุฏ ูˆุงูู‚ุช ุนู„ู‰ ุงู„ู…ุฑุงุฌุนุฉ ูˆู‚ุฑุฑุช ุฃู†ู‡ ู…ุคู‡ู„. ูŠู…ูƒู†ูƒ ุชุบูŠูŠุฑ ุญุงู„ุฉ ุงู„ุฅุนู„ุงู† ููŠ `PATCH connector/google-ads/campaigns/ads/status`. ู‚ุจู„ ุงุณุชุฏุนุงุก ุงู„ูˆุธูŠูุฉุŒ ูŠุฌุจ ุฃู† ุชุทู„ุจ ู…ู† ุงู„ู…ุณุชุฎุฏู… `customerId` ุงู„ุฎุงุต ุจู‡ุŒ ู„ุฐู„ูƒ ูŠุฌุจ ุฃู† ุชู‚ุชุฑุญ ู…ูˆุตู„ู‹ุง ูŠู…ูƒู†ู‡ ุงู„ุชุญู‚ู‚ ู…ู† `customerId` ุงู„ุฎุงุต ุจู‡.", "tags": [ "Google Ads" ], @@ -5840,7 +5840,7 @@ }, "responses": { "201": { - "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุฅุนู„ุงู† ุงู„ู…ููˆู„ุฏุฉ", + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุฅุนู„ุงู† ุงู„ู…ููˆู„ูŽู‘ุฏ", "content": { "application/json": { "schema": { @@ -6823,7 +6823,7 @@ }, "responses": { "201": { - "description": "ู…ุนุฑู ูุฑูŠุฏ ู„ู„ุตูุญุฉ ุงู„ู…ูˆู„ุฏุฉ", + "description": "ู…ุนุฑู ูุฑูŠุฏ ู„ู„ุตูุญุฉ ุงู„ุชูŠ ุชู… ุฅู†ุดุงุคู‡ุง", "content": { "application/json": { "schema": { @@ -8432,7 +8432,7 @@ }, "responses": { "201": { - "description": "ู‚ุงุฆู…ุฉ ู…ู‚ุณู…ุฉ ุฅู„ู‰ ุตูุญุงุช ู„ู„ู…ุดุงุฑูŠุน ุงู„ู…ุฑุฆูŠุฉ ู„ู„ู…ุณุชุฎุฏู…", + "description": "ู‚ุงุฆู…ุฉ ู…ู‚ุณู…ุฉ ุฅู„ู‰ ุตูุญุงุช ู…ู† ุงู„ู…ุดุงุฑูŠุน ุงู„ู…ุฑุฆูŠุฉ ู„ู„ู…ุณุชุฎุฏู…", "content": { "application/json": { "schema": { @@ -12522,7 +12522,7 @@ "subtitle": { "type": "string", "title": "ูˆุตู ุงู„ู†ุต ุงู„ุชุณูˆูŠู‚ูŠ", - "description": "ููŠู…ุง ูŠู„ูŠ ูˆุตู ู„ู†ุต ุงู„ุชุณูˆูŠู‚." + "description": "ููŠู…ุง ูŠู„ูŠ ูˆุตู ู„ู†ุณุฎุฉ ุงู„ุชุณูˆูŠู‚." } } }, @@ -12663,8 +12663,8 @@ "type": "string", "format": "iri", "contentMediaType": "image/*", - "title": "ุนู†ูˆุงู† URL ู„ุตูˆุฑุฉ ู…ุณูˆุฏุฉ ุงู„ู†ุณุฎุฉ ุงู„ุชุณูˆูŠู‚ูŠุฉ ุงู„ู…ูˆู„ุฏุฉ", - "description": "ุนู†ูˆุงู† URL ู„ุตูˆุฑุฉ ู…ุณูˆุฏุฉ ุงู„ู†ุณุฎุฉ ุงู„ุชุณูˆูŠู‚ูŠุฉ ุงู„ู…ูˆู„ุฏุฉ." + "title": "ุนู†ูˆุงู† URL ู„ุตูˆุฑุฉ ู…ุณูˆุฏุฉ ุงู„ู†ุณุฎุฉ ุงู„ุชุณูˆูŠู‚ูŠุฉ ุงู„ู…ููˆู„ุฏุฉ", + "description": "ุนู†ูˆุงู† URL ู„ุตูˆุฑุฉ ู…ุณูˆุฏุฉ ุงู„ู†ุณุฎุฉ ุงู„ุชุณูˆูŠู‚ูŠุฉ ุงู„ู…ููˆู„ุฏุฉ." } }, "required": [ @@ -15905,7 +15905,7 @@ } ], "title": "ู…ุนู„ูˆู…ุงุช ุฑุฃุณ ุงู„ู…ุฑูู‚", - "description": "ูŠุญุชูˆูŠ ุฌุฒุก ุงู„ุฑุณุงู„ุฉ ุนู„ู‰ ุงู„ู…ุณุชูˆู‰ ุงู„ุฃุนู„ู‰ุŒ ูˆุงู„ุฐูŠ ูŠู…ุซู„ ุญู…ูˆู„ุฉ ุงู„ุฑุณุงู„ุฉ ุจุงู„ูƒุงู…ู„ุŒ ุนู„ู‰ ุฑุคูˆุณ ุจุฑูŠุฏ ุฅู„ูƒุชุฑูˆู†ูŠ ู‚ูŠุงุณูŠุฉ ูˆูู‚ู‹ุง ู„ู…ุนูŠุงุฑ RFC 2822 ู…ุซู„ "ุฅู„ู‰" ูˆ"ู…ู†" ูˆ"ุงู„ู…ูˆุถูˆุน"." + "description": "ูŠุญุชูˆูŠ ุฌุฒุก ุงู„ุฑุณุงู„ุฉ ุนู„ู‰ ุงู„ู…ุณุชูˆู‰ ุงู„ุฃุนู„ู‰ุŒ ูˆุงู„ุฐูŠ ูŠู…ุซู„ ุญู…ูˆู„ุฉ ุงู„ุฑุณุงู„ุฉ ุจุงู„ูƒุงู…ู„ุŒ ุนู„ู‰ ุฑุคูˆุณ ุจุฑูŠุฏ ุฅู„ูƒุชุฑูˆู†ูŠ ู‚ูŠุงุณูŠุฉ ูˆูู‚ู‹ุง ู„ู€ RFC 2822 ู…ุซู„ "ุฅู„ู‰" ูˆ"ู…ู†" ูˆ"ุงู„ู…ูˆุถูˆุน"." }, "body": { "oneOf": [ @@ -19759,7 +19759,7 @@ "type": "string", "maxLength": 16, "title": "ุงู„ู†ุต ุงู„ุฐูŠ ุณูŠุชู… ุนุฑุถู‡ ููŠ ู…ู†ุทู‚ุฉ ุงู„ุฑุฃุณ ุฃูˆ ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ", - "description": "ุฅุฐุง ูƒุงู† `profile_image_url` ุบุงุฆุจู‹ุงุŒ ูุณูŠุชู… ุนุฑุถู‡ ูƒุฑุฃุณ ุบุงู…ู‚ ูŠุญุชูˆูŠ ูู‚ุท ุนู„ู‰ ุงู„ุนู†ูˆุงู†." + "description": "ุฅุฐุง ูƒุงู† `profile_image_url` ุบุงุฆุจู‹ุงุŒ ูุณูŠุชู… ุนุฑุถู‡ ูƒุนู†ูˆุงู† ุนุฑูŠุถ ูŠุญุชูˆูŠ ูู‚ุท ุนู„ู‰ ุงู„ุนู†ูˆุงู†." }, "profile_image_url": { "type": "string", @@ -19919,7 +19919,7 @@ "required": [ "event_id" ], - "title": "ู…ุฎุฑุฌุงุช ุงู„ุญุฏุซ ุงู„ุฐูŠ ุชู… ุฅู†ุดุงุคู‡" + "title": "ุฅุฎุฑุงุฌ ุงู„ุญุฏุซ ุงู„ุฐูŠ ุชู… ุฅู†ุดุงุคู‡" }, "IKakaoTalk.ICreateEventInput": { "type": "object", @@ -19937,7 +19937,7 @@ }, "event": { "$ref": "#/components/schemas/IKakaoTalk.Event", - "title": "ู…ุนู„ูˆู…ุงุช ุนู† ุงู„ุญุฏุซ ุงู„ุฐูŠ ุณูŠุชู… ุฅู†ุดุงุคู‡" + "title": "ู…ุนู„ูˆู…ุงุช ุนู† ุงู„ุญุฏุซ ุงู„ู…ุฑุงุฏ ุฅู†ุดุงุคู‡" }, "secretKey": { "type": "string", @@ -20050,7 +20050,7 @@ { "const": "MAGENTA", "title": "ุฃุฑุฌูˆุงู†ูŠ", - "description": "ุฃุจ47 ู‚ุจู„ ุงู„ู…ูŠู„ุงุฏ" + "description": "ุฃูŠู‡ ุจูŠ 47 ู‚ุจู„ ุงู„ู…ูŠู„ุงุฏ" }, { "const": "VIOLET", @@ -20414,7 +20414,7 @@ { "const": "MAGENTA", "title": "ุฃุฑุฌูˆุงู†ูŠ", - "description": "ุฃุจ47 ู‚ุจู„ ุงู„ู…ูŠู„ุงุฏ" + "description": "ุฃูŠู‡ ุจูŠ 47 ู‚ุจู„ ุงู„ู…ูŠู„ุงุฏ" }, { "const": "VIOLET", @@ -20672,7 +20672,7 @@ { "const": "MAGENTA", "title": "ุฃุฑุฌูˆุงู†ูŠ", - "description": "ุฃุจ47 ู‚ุจู„ ุงู„ู…ูŠู„ุงุฏ" + "description": "ุฃูŠู‡ ุจูŠ 47 ู‚ุจู„ ุงู„ู…ูŠู„ุงุฏ" }, { "const": "VIOLET", @@ -20797,7 +20797,7 @@ { "const": "MAGENTA", "title": "ุฃุฑุฌูˆุงู†ูŠ", - "description": "ุฃุจ47 ู‚ุจู„ ุงู„ู…ูŠู„ุงุฏ" + "description": "ุฃูŠู‡ ุจูŠ 47 ู‚ุจู„ ุงู„ู…ูŠู„ุงุฏ" }, { "const": "VIOLET", @@ -21152,7 +21152,7 @@ "x": { "type": "string", "title": "ู‚ูŠู…ุฉ ุฅุญุฏุงุซูŠุงุช X", - "description": "ุฎุท ุงู„ุทูˆู„ (Longitude) ููŠ ุญุงู„ุฉ ุฎุทูˆุท ุงู„ุนุฑุถ ูˆุงู„ุทูˆู„" + "description": "ุฎุท ุงู„ุทูˆู„ (ุงู„ุฎุท ุงู„ุทูˆู„ูŠ) ููŠ ุญุงู„ุฉ ุฎุทูˆุท ุงู„ุนุฑุถ ูˆุงู„ุทูˆู„" }, "y": { "type": "string", @@ -21350,11 +21350,11 @@ }, { "const": 206, - "title": "๋‹ค์ค‘ ์ถœ๋ฐœ์ง€: ๋ชฉ์ ์ง€ ์ฃผ๋ณ€์˜ ์œ ๊ณ  ์ •๋ณด(๊ตํ†ต ์žฅ์• ) ุฃูˆ ๋กœ ํ•œ ํ†ตํ–‰ ๋ถˆ๊ฐ€" + "title": "๋‹ค์ค‘ ์ถœ๋ฐœ์ง€: ๋ชฉ์ ์ง€ ์ฃผ๋ณ€์˜ ๊ณ  ๊ณ  ์ •๋ณด(๊ตํ†ต ์žฅ์• ) ุฃูˆ ๋กœ ํ•œ ํ†ตํ–‰ ๋ถˆ๊ฐ€" }, { "const": 207, - "title": "๋‹ค์ค‘ ์ถœ๋ฐœ์ง€: ู…ุณุชู„ุฒู…ุงุชูƒ ุงู„ู…ูุถู„ุฉ" + "title": "๋‹ค์ค‘ ์ถœ๋ฐœ์ง€: ุฃูุถู„ ู…ุง ููŠ ุงู„ุฃู…ุฑ ุจุงู„ู†ุณุจุฉ ู„ูƒ" }, { "const": 301, @@ -21654,7 +21654,7 @@ }, { "const": 8, - "title": "ุฃูุถู„ ู…ุง ููŠ ุงู„ุฃู…ุฑ" + "title": "ู‡ุฐุง ู‡ูˆ ู…ุง ุชุจุญุซ ุนู†ู‡" }, { "const": 9, @@ -21742,7 +21742,7 @@ }, { "const": 31, - "title": "ู…ูƒุงูุฃุฉ ู†ู‡ุงูŠุฉ ุงู„ุฃุณุจูˆุน 2" + "title": "ุงู„ุฌุฒุก ุงู„ุซุงู†ูŠ ู…ู† ุงู„ู„ุนุจุฉ" }, { "const": 32, @@ -21794,7 +21794,7 @@ }, { "const": 44, - "title": "ุฃูุถู„ ู…ุง ููŠ ุงู„ุฃู…ุฑ ู‡ูˆ ุฃู† ุชูƒูˆู† ู‚ุงุฏุฑู‹ุง ุนู„ู‰ ุงู„ุนู…ู„" + "title": "ุฃูุถู„ ู…ุง ููŠ ุงู„ุฃู…ุฑ ู‡ูˆ ุงู„ุญุตูˆู„ ุนู„ู‰ ุจุทุงู‚ุฉ ุงู„ุงุฆุชู…ุงู† ุงู„ุฎุงุตุฉ ุจูƒ" }, { "const": 45, @@ -21806,7 +21806,7 @@ }, { "const": 47, - "title": "ุฃูุถู„ ู…ุง ููŠ ุงู„ุฃู…ุฑ ู‡ูˆ ุงู„ุญุตูˆู„ ุนู„ู‰ ุงู„ู…ุงู„" + "title": "ุฃูุถู„ ู…ุง ููŠ ุงู„ุฃู…ุฑ ู‡ูˆ ุฃู† ุชูƒูˆู† ู‚ุงุฏุฑู‹ุง ุนู„ู‰ ุงู„ุนู…ู„" }, { "const": 48, @@ -22174,7 +22174,7 @@ "type": "string", "format": "iri", "title": "ุฑุงุจุท ุงู„ุตูˆุฑุฉ", - "description": "ููŠ ุญุงู„ุฉ ูˆุฌูˆุฏ ู…ุดูƒู„ุฉ ููŠ ุงู„ุตูˆุฑุฉุŒ ู‚ุฏ ุชุธู‡ุฑ ุงู„ุฑุณุงู„ุฉ ุฃุฏู†ุงู‡. ูŠุฌุจ ุนู„ูŠูƒ ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑ ุงู„ู…ูˆุฌูˆุฏุฉ ูู‚ุทุŒ ูˆุฅุฐุง ูƒุงู†ุช ุงู„ุตูˆุฑุฉ ุตุบูŠุฑุฉ ุฌุฏู‹ุงุŒ ูู‚ุฏ ุชุธู‡ุฑ ุฃุฎุทุงุกุŒ ู„ุฐุง ู‚ู… ุจุฅุฏุฑุงุฌ ุตูˆุฑุฉ ุจุงู„ุญุฌู… ุงู„ู…ู†ุงุณุจ ุฃูˆ ู‚ู… ุจุฅู†ุดุงุฆู‡ุง ุจู†ูุณูƒ ู„ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑุฉ. ุงู„ุฎุทุฃ ุงู„ุฃูˆู„ ุฃุฏู†ุงู‡ ู‡ูˆ ุนู†ุฏู…ุง ู„ุง ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ู…ูˆุฌูˆุฏุฉุŒ ูˆุงู„ุซุงู†ูŠ ู‡ูˆ ุนู†ุฏู…ุง ูŠูƒูˆู† ุญุฌู… ุฃูˆ ุชู†ุณูŠู‚ ุงู„ุตูˆุฑุฉ ุบูŠุฑ ุตุงู„ุญ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุจุชู†ุณูŠู‚ุงุช jpg ูˆjpeg ูˆpng. 1. ู„ู… ูŠุชู… ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ. 2. ุญุฏุซุช ู…ุดูƒู„ุฉ ููŠ ุงุณุชุฑุฏุงุฏ ุงู„ุตูˆุฑุฉ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ ู…ุชุงุญุฉ ู„ู„ุฌู…ู‡ูˆุฑุŒ ูˆุถู…ู† ุญุฏ ุงู„ุญุฌู…ุŒ ูˆุจุชู†ุณูŠู‚ุงุช ู…ุฏุนูˆู…ุฉ." + "description": "ููŠ ุญุงู„ุฉ ูˆุฌูˆุฏ ู…ุดูƒู„ุฉ ููŠ ุงู„ุตูˆุฑุฉุŒ ู‚ุฏ ุชุธู‡ุฑ ุงู„ุฑุณุงู„ุฉ ุฃุฏู†ุงู‡. ูŠุฌุจ ุนู„ูŠูƒ ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑ ุงู„ู…ูˆุฌูˆุฏุฉ ูู‚ุทุŒ ูˆุฅุฐุง ูƒุงู†ุช ุงู„ุตูˆุฑุฉ ุตุบูŠุฑุฉ ุฌุฏู‹ุงุŒ ูู‚ุฏ ุชุธู‡ุฑ ุฃุฎุทุงุกุŒ ู„ุฐุง ู‚ู… ุจุฅุฏุฑุงุฌ ุตูˆุฑุฉ ุจุงู„ุญุฌู… ุงู„ู…ู†ุงุณุจ ุฃูˆ ู‚ู… ุจุฅู†ุดุงุฆู‡ุง ุจู†ูุณูƒ ู„ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑุฉ. ุงู„ุฎุทุฃ ุงู„ุฃูˆู„ ุฃุฏู†ุงู‡ ู‡ูˆ ุนู†ุฏู…ุง ู„ุง ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ู…ูˆุฌูˆุฏุฉุŒ ูˆุงู„ุซุงู†ูŠ ู‡ูˆ ุนู†ุฏู…ุง ูŠูƒูˆู† ุญุฌู… ุฃูˆ ุชู†ุณูŠู‚ ุงู„ุตูˆุฑุฉ ุบูŠุฑ ุตุงู„ุญ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุจุชู†ุณูŠู‚ุงุช jpg ูˆjpeg ูˆpng. 1. ู„ู… ูŠุชู… ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ. 2. ุญุฏุซุช ู…ุดูƒู„ุฉ ููŠ ุงุณุชุฑุฏุงุฏ ุงู„ุตูˆุฑุฉ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ ู…ุชุงุญุฉ ู„ู„ุนุงู…ุฉุŒ ูˆุถู…ู† ุญุฏ ุงู„ุญุฌู…ุŒ ูˆุจุชู†ุณูŠู‚ุงุช ู…ุฏุนูˆู…ุฉ." }, "text": { "$ref": "#/components/schemas/IGoogleSlides.InsertText", @@ -22260,7 +22260,7 @@ "type": "string", "format": "iri", "title": "ุฑุงุจุท ุงู„ุตูˆุฑุฉ", - "description": "ููŠ ุญุงู„ุฉ ูˆุฌูˆุฏ ู…ุดูƒู„ุฉ ููŠ ุงู„ุตูˆุฑุฉุŒ ู‚ุฏ ุชุธู‡ุฑ ุงู„ุฑุณุงู„ุฉ ุฃุฏู†ุงู‡. ูŠุฌุจ ุนู„ูŠูƒ ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑ ุงู„ู…ูˆุฌูˆุฏุฉ ูู‚ุทุŒ ูˆุฅุฐุง ูƒุงู†ุช ุงู„ุตูˆุฑุฉ ุตุบูŠุฑุฉ ุฌุฏู‹ุงุŒ ูู‚ุฏ ุชุธู‡ุฑ ุฃุฎุทุงุกุŒ ู„ุฐุง ู‚ู… ุจุฅุฏุฑุงุฌ ุตูˆุฑุฉ ุจุงู„ุญุฌู… ุงู„ู…ู†ุงุณุจ ุฃูˆ ู‚ู… ุจุฅู†ุดุงุฆู‡ุง ุจู†ูุณูƒ ู„ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑุฉ. ุงู„ุฎุทุฃ ุงู„ุฃูˆู„ ุฃุฏู†ุงู‡ ู‡ูˆ ุนู†ุฏู…ุง ู„ุง ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ู…ูˆุฌูˆุฏุฉุŒ ูˆุงู„ุซุงู†ูŠ ู‡ูˆ ุนู†ุฏู…ุง ูŠูƒูˆู† ุญุฌู… ุฃูˆ ุชู†ุณูŠู‚ ุงู„ุตูˆุฑุฉ ุบูŠุฑ ุตุงู„ุญ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุจุชู†ุณูŠู‚ุงุช jpg ูˆjpeg ูˆpng. 1. ู„ู… ูŠุชู… ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ. 2. ุญุฏุซุช ู…ุดูƒู„ุฉ ููŠ ุงุณุชุฑุฏุงุฏ ุงู„ุตูˆุฑุฉ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ ู…ุชุงุญุฉ ู„ู„ุฌู…ู‡ูˆุฑุŒ ูˆุถู…ู† ุญุฏ ุงู„ุญุฌู…ุŒ ูˆุจุชู†ุณูŠู‚ุงุช ู…ุฏุนูˆู…ุฉ." + "description": "ููŠ ุญุงู„ุฉ ูˆุฌูˆุฏ ู…ุดูƒู„ุฉ ููŠ ุงู„ุตูˆุฑุฉุŒ ู‚ุฏ ุชุธู‡ุฑ ุงู„ุฑุณุงู„ุฉ ุฃุฏู†ุงู‡. ูŠุฌุจ ุนู„ูŠูƒ ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑ ุงู„ู…ูˆุฌูˆุฏุฉ ูู‚ุทุŒ ูˆุฅุฐุง ูƒุงู†ุช ุงู„ุตูˆุฑุฉ ุตุบูŠุฑุฉ ุฌุฏู‹ุงุŒ ูู‚ุฏ ุชุธู‡ุฑ ุฃุฎุทุงุกุŒ ู„ุฐุง ู‚ู… ุจุฅุฏุฑุงุฌ ุตูˆุฑุฉ ุจุงู„ุญุฌู… ุงู„ู…ู†ุงุณุจ ุฃูˆ ู‚ู… ุจุฅู†ุดุงุฆู‡ุง ุจู†ูุณูƒ ู„ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑุฉ. ุงู„ุฎุทุฃ ุงู„ุฃูˆู„ ุฃุฏู†ุงู‡ ู‡ูˆ ุนู†ุฏู…ุง ู„ุง ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ู…ูˆุฌูˆุฏุฉุŒ ูˆุงู„ุซุงู†ูŠ ู‡ูˆ ุนู†ุฏู…ุง ูŠูƒูˆู† ุญุฌู… ุฃูˆ ุชู†ุณูŠู‚ ุงู„ุตูˆุฑุฉ ุบูŠุฑ ุตุงู„ุญ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุจุชู†ุณูŠู‚ุงุช jpg ูˆjpeg ูˆpng. 1. ู„ู… ูŠุชู… ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ. 2. ุญุฏุซุช ู…ุดูƒู„ุฉ ููŠ ุงุณุชุฑุฏุงุฏ ุงู„ุตูˆุฑุฉ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ ู…ุชุงุญุฉ ู„ู„ุนุงู…ุฉุŒ ูˆุถู…ู† ุญุฏ ุงู„ุญุฌู…ุŒ ูˆุจุชู†ุณูŠู‚ุงุช ู…ุฏุนูˆู…ุฉ." } }, "required": [ @@ -22309,7 +22309,7 @@ "type": "string", "format": "iri", "title": "ุฑุงุจุท ุงู„ุตูˆุฑุฉ", - "description": "ููŠ ุญุงู„ุฉ ูˆุฌูˆุฏ ู…ุดูƒู„ุฉ ููŠ ุงู„ุตูˆุฑุฉุŒ ู‚ุฏ ุชุธู‡ุฑ ุงู„ุฑุณุงู„ุฉ ุฃุฏู†ุงู‡. ูŠุฌุจ ุนู„ูŠูƒ ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑ ุงู„ู…ูˆุฌูˆุฏุฉ ูู‚ุทุŒ ูˆุฅุฐุง ูƒุงู†ุช ุงู„ุตูˆุฑุฉ ุตุบูŠุฑุฉ ุฌุฏู‹ุงุŒ ูู‚ุฏ ุชุธู‡ุฑ ุฃุฎุทุงุกุŒ ู„ุฐุง ู‚ู… ุจุฅุฏุฑุงุฌ ุตูˆุฑุฉ ุจุงู„ุญุฌู… ุงู„ู…ู†ุงุณุจ ุฃูˆ ู‚ู… ุจุฅู†ุดุงุฆู‡ุง ุจู†ูุณูƒ ู„ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑุฉ. ุงู„ุฎุทุฃ ุงู„ุฃูˆู„ ุฃุฏู†ุงู‡ ู‡ูˆ ุนู†ุฏู…ุง ู„ุง ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ู…ูˆุฌูˆุฏุฉุŒ ูˆุงู„ุซุงู†ูŠ ู‡ูˆ ุนู†ุฏู…ุง ูŠูƒูˆู† ุญุฌู… ุฃูˆ ุชู†ุณูŠู‚ ุงู„ุตูˆุฑุฉ ุบูŠุฑ ุตุงู„ุญ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุจุชู†ุณูŠู‚ุงุช jpg ูˆjpeg ูˆpng. 1. ู„ู… ูŠุชู… ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ. 2. ุญุฏุซุช ู…ุดูƒู„ุฉ ููŠ ุงุณุชุฑุฏุงุฏ ุงู„ุตูˆุฑุฉ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ ู…ุชุงุญุฉ ู„ู„ุฌู…ู‡ูˆุฑุŒ ูˆุถู…ู† ุญุฏ ุงู„ุญุฌู…ุŒ ูˆุจุชู†ุณูŠู‚ุงุช ู…ุฏุนูˆู…ุฉ." + "description": "ููŠ ุญุงู„ุฉ ูˆุฌูˆุฏ ู…ุดูƒู„ุฉ ููŠ ุงู„ุตูˆุฑุฉุŒ ู‚ุฏ ุชุธู‡ุฑ ุงู„ุฑุณุงู„ุฉ ุฃุฏู†ุงู‡. ูŠุฌุจ ุนู„ูŠูƒ ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑ ุงู„ู…ูˆุฌูˆุฏุฉ ูู‚ุทุŒ ูˆุฅุฐุง ูƒุงู†ุช ุงู„ุตูˆุฑุฉ ุตุบูŠุฑุฉ ุฌุฏู‹ุงุŒ ูู‚ุฏ ุชุธู‡ุฑ ุฃุฎุทุงุกุŒ ู„ุฐุง ู‚ู… ุจุฅุฏุฑุงุฌ ุตูˆุฑุฉ ุจุงู„ุญุฌู… ุงู„ู…ู†ุงุณุจ ุฃูˆ ู‚ู… ุจุฅู†ุดุงุฆู‡ุง ุจู†ูุณูƒ ู„ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑุฉ. ุงู„ุฎุทุฃ ุงู„ุฃูˆู„ ุฃุฏู†ุงู‡ ู‡ูˆ ุนู†ุฏู…ุง ู„ุง ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ู…ูˆุฌูˆุฏุฉุŒ ูˆุงู„ุซุงู†ูŠ ู‡ูˆ ุนู†ุฏู…ุง ูŠูƒูˆู† ุญุฌู… ุฃูˆ ุชู†ุณูŠู‚ ุงู„ุตูˆุฑุฉ ุบูŠุฑ ุตุงู„ุญ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุจุชู†ุณูŠู‚ุงุช jpg ูˆjpeg ูˆpng. 1. ู„ู… ูŠุชู… ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ. 2. ุญุฏุซุช ู…ุดูƒู„ุฉ ููŠ ุงุณุชุฑุฏุงุฏ ุงู„ุตูˆุฑุฉ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ ู…ุชุงุญุฉ ู„ู„ุนุงู…ุฉุŒ ูˆุถู…ู† ุญุฏ ุงู„ุญุฌู…ุŒ ูˆุจุชู†ุณูŠู‚ุงุช ู…ุฏุนูˆู…ุฉ." }, "text": { "$ref": "#/components/schemas/IGoogleSlides.InsertText", @@ -22363,7 +22363,7 @@ "type": "string", "format": "iri", "title": "ุฑุงุจุท ุงู„ุตูˆุฑุฉ", - "description": "ููŠ ุญุงู„ุฉ ูˆุฌูˆุฏ ู…ุดูƒู„ุฉ ููŠ ุงู„ุตูˆุฑุฉุŒ ู‚ุฏ ุชุธู‡ุฑ ุงู„ุฑุณุงู„ุฉ ุฃุฏู†ุงู‡. ูŠุฌุจ ุนู„ูŠูƒ ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑ ุงู„ู…ูˆุฌูˆุฏุฉ ูู‚ุทุŒ ูˆุฅุฐุง ูƒุงู†ุช ุงู„ุตูˆุฑุฉ ุตุบูŠุฑุฉ ุฌุฏู‹ุงุŒ ูู‚ุฏ ุชุธู‡ุฑ ุฃุฎุทุงุกุŒ ู„ุฐุง ู‚ู… ุจุฅุฏุฑุงุฌ ุตูˆุฑุฉ ุจุงู„ุญุฌู… ุงู„ู…ู†ุงุณุจ ุฃูˆ ู‚ู… ุจุฅู†ุดุงุฆู‡ุง ุจู†ูุณูƒ ู„ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑุฉ. ุงู„ุฎุทุฃ ุงู„ุฃูˆู„ ุฃุฏู†ุงู‡ ู‡ูˆ ุนู†ุฏู…ุง ู„ุง ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ู…ูˆุฌูˆุฏุฉุŒ ูˆุงู„ุซุงู†ูŠ ู‡ูˆ ุนู†ุฏู…ุง ูŠูƒูˆู† ุญุฌู… ุฃูˆ ุชู†ุณูŠู‚ ุงู„ุตูˆุฑุฉ ุบูŠุฑ ุตุงู„ุญ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุจุชู†ุณูŠู‚ุงุช jpg ูˆjpeg ูˆpng. 1. ู„ู… ูŠุชู… ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ. 2. ุญุฏุซุช ู…ุดูƒู„ุฉ ููŠ ุงุณุชุฑุฏุงุฏ ุงู„ุตูˆุฑุฉ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ ู…ุชุงุญุฉ ู„ู„ุฌู…ู‡ูˆุฑุŒ ูˆุถู…ู† ุญุฏ ุงู„ุญุฌู…ุŒ ูˆุจุชู†ุณูŠู‚ุงุช ู…ุฏุนูˆู…ุฉ." + "description": "ููŠ ุญุงู„ุฉ ูˆุฌูˆุฏ ู…ุดูƒู„ุฉ ููŠ ุงู„ุตูˆุฑุฉุŒ ู‚ุฏ ุชุธู‡ุฑ ุงู„ุฑุณุงู„ุฉ ุฃุฏู†ุงู‡. ูŠุฌุจ ุนู„ูŠูƒ ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑ ุงู„ู…ูˆุฌูˆุฏุฉ ูู‚ุทุŒ ูˆุฅุฐุง ูƒุงู†ุช ุงู„ุตูˆุฑุฉ ุตุบูŠุฑุฉ ุฌุฏู‹ุงุŒ ูู‚ุฏ ุชุธู‡ุฑ ุฃุฎุทุงุกุŒ ู„ุฐุง ู‚ู… ุจุฅุฏุฑุงุฌ ุตูˆุฑุฉ ุจุงู„ุญุฌู… ุงู„ู…ู†ุงุณุจ ุฃูˆ ู‚ู… ุจุฅู†ุดุงุฆู‡ุง ุจู†ูุณูƒ ู„ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑุฉ. ุงู„ุฎุทุฃ ุงู„ุฃูˆู„ ุฃุฏู†ุงู‡ ู‡ูˆ ุนู†ุฏู…ุง ู„ุง ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ู…ูˆุฌูˆุฏุฉุŒ ูˆุงู„ุซุงู†ูŠ ู‡ูˆ ุนู†ุฏู…ุง ูŠูƒูˆู† ุญุฌู… ุฃูˆ ุชู†ุณูŠู‚ ุงู„ุตูˆุฑุฉ ุบูŠุฑ ุตุงู„ุญ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุจุชู†ุณูŠู‚ุงุช jpg ูˆjpeg ูˆpng. 1. ู„ู… ูŠุชู… ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ. 2. ุญุฏุซุช ู…ุดูƒู„ุฉ ููŠ ุงุณุชุฑุฏุงุฏ ุงู„ุตูˆุฑุฉ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ ู…ุชุงุญุฉ ู„ู„ุนุงู…ุฉุŒ ูˆุถู…ู† ุญุฏ ุงู„ุญุฌู…ุŒ ูˆุจุชู†ุณูŠู‚ุงุช ู…ุฏุนูˆู…ุฉ." }, "text": { "$ref": "#/components/schemas/IGoogleSlides.InsertText", @@ -22417,7 +22417,7 @@ "type": "string", "format": "iri", "title": "ุฑุงุจุท ุงู„ุตูˆุฑุฉ", - "description": "ููŠ ุญุงู„ุฉ ูˆุฌูˆุฏ ู…ุดูƒู„ุฉ ููŠ ุงู„ุตูˆุฑุฉุŒ ู‚ุฏ ุชุธู‡ุฑ ุงู„ุฑุณุงู„ุฉ ุฃุฏู†ุงู‡. ูŠุฌุจ ุนู„ูŠูƒ ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑ ุงู„ู…ูˆุฌูˆุฏุฉ ูู‚ุทุŒ ูˆุฅุฐุง ูƒุงู†ุช ุงู„ุตูˆุฑุฉ ุตุบูŠุฑุฉ ุฌุฏู‹ุงุŒ ูู‚ุฏ ุชุธู‡ุฑ ุฃุฎุทุงุกุŒ ู„ุฐุง ู‚ู… ุจุฅุฏุฑุงุฌ ุตูˆุฑุฉ ุจุงู„ุญุฌู… ุงู„ู…ู†ุงุณุจ ุฃูˆ ู‚ู… ุจุฅู†ุดุงุฆู‡ุง ุจู†ูุณูƒ ู„ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑุฉ. ุงู„ุฎุทุฃ ุงู„ุฃูˆู„ ุฃุฏู†ุงู‡ ู‡ูˆ ุนู†ุฏู…ุง ู„ุง ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ู…ูˆุฌูˆุฏุฉุŒ ูˆุงู„ุซุงู†ูŠ ู‡ูˆ ุนู†ุฏู…ุง ูŠูƒูˆู† ุญุฌู… ุฃูˆ ุชู†ุณูŠู‚ ุงู„ุตูˆุฑุฉ ุบูŠุฑ ุตุงู„ุญ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุจุชู†ุณูŠู‚ุงุช jpg ูˆjpeg ูˆpng. 1. ู„ู… ูŠุชู… ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ. 2. ุญุฏุซุช ู…ุดูƒู„ุฉ ููŠ ุงุณุชุฑุฏุงุฏ ุงู„ุตูˆุฑุฉ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ ู…ุชุงุญุฉ ู„ู„ุฌู…ู‡ูˆุฑุŒ ูˆุถู…ู† ุญุฏ ุงู„ุญุฌู…ุŒ ูˆุจุชู†ุณูŠู‚ุงุช ู…ุฏุนูˆู…ุฉ." + "description": "ููŠ ุญุงู„ุฉ ูˆุฌูˆุฏ ู…ุดูƒู„ุฉ ููŠ ุงู„ุตูˆุฑุฉุŒ ู‚ุฏ ุชุธู‡ุฑ ุงู„ุฑุณุงู„ุฉ ุฃุฏู†ุงู‡. ูŠุฌุจ ุนู„ูŠูƒ ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑ ุงู„ู…ูˆุฌูˆุฏุฉ ูู‚ุทุŒ ูˆุฅุฐุง ูƒุงู†ุช ุงู„ุตูˆุฑุฉ ุตุบูŠุฑุฉ ุฌุฏู‹ุงุŒ ูู‚ุฏ ุชุธู‡ุฑ ุฃุฎุทุงุกุŒ ู„ุฐุง ู‚ู… ุจุฅุฏุฑุงุฌ ุตูˆุฑุฉ ุจุงู„ุญุฌู… ุงู„ู…ู†ุงุณุจ ุฃูˆ ู‚ู… ุจุฅู†ุดุงุฆู‡ุง ุจู†ูุณูƒ ู„ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑุฉ. ุงู„ุฎุทุฃ ุงู„ุฃูˆู„ ุฃุฏู†ุงู‡ ู‡ูˆ ุนู†ุฏู…ุง ู„ุง ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ู…ูˆุฌูˆุฏุฉุŒ ูˆุงู„ุซุงู†ูŠ ู‡ูˆ ุนู†ุฏู…ุง ูŠูƒูˆู† ุญุฌู… ุฃูˆ ุชู†ุณูŠู‚ ุงู„ุตูˆุฑุฉ ุบูŠุฑ ุตุงู„ุญ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุจุชู†ุณูŠู‚ุงุช jpg ูˆjpeg ูˆpng. 1. ู„ู… ูŠุชู… ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ. 2. ุญุฏุซุช ู…ุดูƒู„ุฉ ููŠ ุงุณุชุฑุฏุงุฏ ุงู„ุตูˆุฑุฉ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ ู…ุชุงุญุฉ ู„ู„ุนุงู…ุฉุŒ ูˆุถู…ู† ุญุฏ ุงู„ุญุฌู…ุŒ ูˆุจุชู†ุณูŠู‚ุงุช ู…ุฏุนูˆู…ุฉ." }, "text": { "$ref": "#/components/schemas/IGoogleSlides.InsertText", @@ -22502,7 +22502,7 @@ "type": "string", "format": "iri", "title": "ุฑุงุจุท ุงู„ุตูˆุฑุฉ", - "description": "ููŠ ุญุงู„ุฉ ูˆุฌูˆุฏ ู…ุดูƒู„ุฉ ููŠ ุงู„ุตูˆุฑุฉุŒ ู‚ุฏ ุชุธู‡ุฑ ุงู„ุฑุณุงู„ุฉ ุฃุฏู†ุงู‡. ูŠุฌุจ ุนู„ูŠูƒ ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑ ุงู„ู…ูˆุฌูˆุฏุฉ ูู‚ุทุŒ ูˆุฅุฐุง ูƒุงู†ุช ุงู„ุตูˆุฑุฉ ุตุบูŠุฑุฉ ุฌุฏู‹ุงุŒ ูู‚ุฏ ุชุธู‡ุฑ ุฃุฎุทุงุกุŒ ู„ุฐุง ู‚ู… ุจุฅุฏุฑุงุฌ ุตูˆุฑุฉ ุจุงู„ุญุฌู… ุงู„ู…ู†ุงุณุจ ุฃูˆ ู‚ู… ุจุฅู†ุดุงุฆู‡ุง ุจู†ูุณูƒ ู„ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑุฉ. ุงู„ุฎุทุฃ ุงู„ุฃูˆู„ ุฃุฏู†ุงู‡ ู‡ูˆ ุนู†ุฏู…ุง ู„ุง ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ู…ูˆุฌูˆุฏุฉุŒ ูˆุงู„ุซุงู†ูŠ ู‡ูˆ ุนู†ุฏู…ุง ูŠูƒูˆู† ุญุฌู… ุฃูˆ ุชู†ุณูŠู‚ ุงู„ุตูˆุฑุฉ ุบูŠุฑ ุตุงู„ุญ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุจุชู†ุณูŠู‚ุงุช jpg ูˆjpeg ูˆpng. 1. ู„ู… ูŠุชู… ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ. 2. ุญุฏุซุช ู…ุดูƒู„ุฉ ููŠ ุงุณุชุฑุฏุงุฏ ุงู„ุตูˆุฑุฉ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ ู…ุชุงุญุฉ ู„ู„ุฌู…ู‡ูˆุฑุŒ ูˆุถู…ู† ุญุฏ ุงู„ุญุฌู…ุŒ ูˆุจุชู†ุณูŠู‚ุงุช ู…ุฏุนูˆู…ุฉ." + "description": "ููŠ ุญุงู„ุฉ ูˆุฌูˆุฏ ู…ุดูƒู„ุฉ ููŠ ุงู„ุตูˆุฑุฉุŒ ู‚ุฏ ุชุธู‡ุฑ ุงู„ุฑุณุงู„ุฉ ุฃุฏู†ุงู‡. ูŠุฌุจ ุนู„ูŠูƒ ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑ ุงู„ู…ูˆุฌูˆุฏุฉ ูู‚ุทุŒ ูˆุฅุฐุง ูƒุงู†ุช ุงู„ุตูˆุฑุฉ ุตุบูŠุฑุฉ ุฌุฏู‹ุงุŒ ูู‚ุฏ ุชุธู‡ุฑ ุฃุฎุทุงุกุŒ ู„ุฐุง ู‚ู… ุจุฅุฏุฑุงุฌ ุตูˆุฑุฉ ุจุงู„ุญุฌู… ุงู„ู…ู†ุงุณุจ ุฃูˆ ู‚ู… ุจุฅู†ุดุงุฆู‡ุง ุจู†ูุณูƒ ู„ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑุฉ. ุงู„ุฎุทุฃ ุงู„ุฃูˆู„ ุฃุฏู†ุงู‡ ู‡ูˆ ุนู†ุฏู…ุง ู„ุง ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ู…ูˆุฌูˆุฏุฉุŒ ูˆุงู„ุซุงู†ูŠ ู‡ูˆ ุนู†ุฏู…ุง ูŠูƒูˆู† ุญุฌู… ุฃูˆ ุชู†ุณูŠู‚ ุงู„ุตูˆุฑุฉ ุบูŠุฑ ุตุงู„ุญ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุจุชู†ุณูŠู‚ุงุช jpg ูˆjpeg ูˆpng. 1. ู„ู… ูŠุชู… ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ. 2. ุญุฏุซุช ู…ุดูƒู„ุฉ ููŠ ุงุณุชุฑุฏุงุฏ ุงู„ุตูˆุฑุฉ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ ู…ุชุงุญุฉ ู„ู„ุนุงู…ุฉุŒ ูˆุถู…ู† ุญุฏ ุงู„ุญุฌู…ุŒ ูˆุจุชู†ุณูŠู‚ุงุช ู…ุฏุนูˆู…ุฉ." }, "text": { "$ref": "#/components/schemas/IGoogleSlides.InsertText", @@ -22536,7 +22536,7 @@ "type": "string", "format": "iri", "title": "ุฑุงุจุท ุงู„ุตูˆุฑุฉ", - "description": "ููŠ ุญุงู„ุฉ ูˆุฌูˆุฏ ู…ุดูƒู„ุฉ ููŠ ุงู„ุตูˆุฑุฉุŒ ู‚ุฏ ุชุธู‡ุฑ ุงู„ุฑุณุงู„ุฉ ุฃุฏู†ุงู‡. ูŠุฌุจ ุนู„ูŠูƒ ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑ ุงู„ู…ูˆุฌูˆุฏุฉ ูู‚ุทุŒ ูˆุฅุฐุง ูƒุงู†ุช ุงู„ุตูˆุฑุฉ ุตุบูŠุฑุฉ ุฌุฏู‹ุงุŒ ูู‚ุฏ ุชุธู‡ุฑ ุฃุฎุทุงุกุŒ ู„ุฐุง ู‚ู… ุจุฅุฏุฑุงุฌ ุตูˆุฑุฉ ุจุงู„ุญุฌู… ุงู„ู…ู†ุงุณุจ ุฃูˆ ู‚ู… ุจุฅู†ุดุงุฆู‡ุง ุจู†ูุณูƒ ู„ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑุฉ. ุงู„ุฎุทุฃ ุงู„ุฃูˆู„ ุฃุฏู†ุงู‡ ู‡ูˆ ุนู†ุฏู…ุง ู„ุง ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ู…ูˆุฌูˆุฏุฉุŒ ูˆุงู„ุซุงู†ูŠ ู‡ูˆ ุนู†ุฏู…ุง ูŠูƒูˆู† ุญุฌู… ุฃูˆ ุชู†ุณูŠู‚ ุงู„ุตูˆุฑุฉ ุบูŠุฑ ุตุงู„ุญ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุจุชู†ุณูŠู‚ุงุช jpg ูˆjpeg ูˆpng. 1. ู„ู… ูŠุชู… ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ. 2. ุญุฏุซุช ู…ุดูƒู„ุฉ ููŠ ุงุณุชุฑุฏุงุฏ ุงู„ุตูˆุฑุฉ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ ู…ุชุงุญุฉ ู„ู„ุฌู…ู‡ูˆุฑุŒ ูˆุถู…ู† ุญุฏ ุงู„ุญุฌู…ุŒ ูˆุจุชู†ุณูŠู‚ุงุช ู…ุฏุนูˆู…ุฉ." + "description": "ููŠ ุญุงู„ุฉ ูˆุฌูˆุฏ ู…ุดูƒู„ุฉ ููŠ ุงู„ุตูˆุฑุฉุŒ ู‚ุฏ ุชุธู‡ุฑ ุงู„ุฑุณุงู„ุฉ ุฃุฏู†ุงู‡. ูŠุฌุจ ุนู„ูŠูƒ ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑ ุงู„ู…ูˆุฌูˆุฏุฉ ูู‚ุทุŒ ูˆุฅุฐุง ูƒุงู†ุช ุงู„ุตูˆุฑุฉ ุตุบูŠุฑุฉ ุฌุฏู‹ุงุŒ ูู‚ุฏ ุชุธู‡ุฑ ุฃุฎุทุงุกุŒ ู„ุฐุง ู‚ู… ุจุฅุฏุฑุงุฌ ุตูˆุฑุฉ ุจุงู„ุญุฌู… ุงู„ู…ู†ุงุณุจ ุฃูˆ ู‚ู… ุจุฅู†ุดุงุฆู‡ุง ุจู†ูุณูƒ ู„ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑุฉ. ุงู„ุฎุทุฃ ุงู„ุฃูˆู„ ุฃุฏู†ุงู‡ ู‡ูˆ ุนู†ุฏู…ุง ู„ุง ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ู…ูˆุฌูˆุฏุฉุŒ ูˆุงู„ุซุงู†ูŠ ู‡ูˆ ุนู†ุฏู…ุง ูŠูƒูˆู† ุญุฌู… ุฃูˆ ุชู†ุณูŠู‚ ุงู„ุตูˆุฑุฉ ุบูŠุฑ ุตุงู„ุญ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุจุชู†ุณูŠู‚ุงุช jpg ูˆjpeg ูˆpng. 1. ู„ู… ูŠุชู… ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ. 2. ุญุฏุซุช ู…ุดูƒู„ุฉ ููŠ ุงุณุชุฑุฏุงุฏ ุงู„ุตูˆุฑุฉ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ ู…ุชุงุญุฉ ู„ู„ุนุงู…ุฉุŒ ูˆุถู…ู† ุญุฏ ุงู„ุญุฌู…ุŒ ูˆุจุชู†ุณูŠู‚ุงุช ู…ุฏุนูˆู…ุฉ." }, "text": { "$ref": "#/components/schemas/IGoogleSlides.InsertText", @@ -22571,7 +22571,7 @@ "type": "string", "format": "iri", "title": "ุฑุงุจุท ุงู„ุตูˆุฑุฉ", - "description": "ููŠ ุญุงู„ุฉ ูˆุฌูˆุฏ ู…ุดูƒู„ุฉ ููŠ ุงู„ุตูˆุฑุฉุŒ ู‚ุฏ ุชุธู‡ุฑ ุงู„ุฑุณุงู„ุฉ ุฃุฏู†ุงู‡. ูŠุฌุจ ุนู„ูŠูƒ ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑ ุงู„ู…ูˆุฌูˆุฏุฉ ูู‚ุทุŒ ูˆุฅุฐุง ูƒุงู†ุช ุงู„ุตูˆุฑุฉ ุตุบูŠุฑุฉ ุฌุฏู‹ุงุŒ ูู‚ุฏ ุชุธู‡ุฑ ุฃุฎุทุงุกุŒ ู„ุฐุง ู‚ู… ุจุฅุฏุฑุงุฌ ุตูˆุฑุฉ ุจุงู„ุญุฌู… ุงู„ู…ู†ุงุณุจ ุฃูˆ ู‚ู… ุจุฅู†ุดุงุฆู‡ุง ุจู†ูุณูƒ ู„ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑุฉ. ุงู„ุฎุทุฃ ุงู„ุฃูˆู„ ุฃุฏู†ุงู‡ ู‡ูˆ ุนู†ุฏู…ุง ู„ุง ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ู…ูˆุฌูˆุฏุฉุŒ ูˆุงู„ุซุงู†ูŠ ู‡ูˆ ุนู†ุฏู…ุง ูŠูƒูˆู† ุญุฌู… ุฃูˆ ุชู†ุณูŠู‚ ุงู„ุตูˆุฑุฉ ุบูŠุฑ ุตุงู„ุญ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุจุชู†ุณูŠู‚ุงุช jpg ูˆjpeg ูˆpng. 1. ู„ู… ูŠุชู… ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ. 2. ุญุฏุซุช ู…ุดูƒู„ุฉ ููŠ ุงุณุชุฑุฏุงุฏ ุงู„ุตูˆุฑุฉ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ ู…ุชุงุญุฉ ู„ู„ุฌู…ู‡ูˆุฑุŒ ูˆุถู…ู† ุญุฏ ุงู„ุญุฌู…ุŒ ูˆุจุชู†ุณูŠู‚ุงุช ู…ุฏุนูˆู…ุฉ." + "description": "ููŠ ุญุงู„ุฉ ูˆุฌูˆุฏ ู…ุดูƒู„ุฉ ููŠ ุงู„ุตูˆุฑุฉุŒ ู‚ุฏ ุชุธู‡ุฑ ุงู„ุฑุณุงู„ุฉ ุฃุฏู†ุงู‡. ูŠุฌุจ ุนู„ูŠูƒ ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑ ุงู„ู…ูˆุฌูˆุฏุฉ ูู‚ุทุŒ ูˆุฅุฐุง ูƒุงู†ุช ุงู„ุตูˆุฑุฉ ุตุบูŠุฑุฉ ุฌุฏู‹ุงุŒ ูู‚ุฏ ุชุธู‡ุฑ ุฃุฎุทุงุกุŒ ู„ุฐุง ู‚ู… ุจุฅุฏุฑุงุฌ ุตูˆุฑุฉ ุจุงู„ุญุฌู… ุงู„ู…ู†ุงุณุจ ุฃูˆ ู‚ู… ุจุฅู†ุดุงุฆู‡ุง ุจู†ูุณูƒ ู„ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑุฉ. ุงู„ุฎุทุฃ ุงู„ุฃูˆู„ ุฃุฏู†ุงู‡ ู‡ูˆ ุนู†ุฏู…ุง ู„ุง ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ู…ูˆุฌูˆุฏุฉุŒ ูˆุงู„ุซุงู†ูŠ ู‡ูˆ ุนู†ุฏู…ุง ูŠูƒูˆู† ุญุฌู… ุฃูˆ ุชู†ุณูŠู‚ ุงู„ุตูˆุฑุฉ ุบูŠุฑ ุตุงู„ุญ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุจุชู†ุณูŠู‚ุงุช jpg ูˆjpeg ูˆpng. 1. ู„ู… ูŠุชู… ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ. 2. ุญุฏุซุช ู…ุดูƒู„ุฉ ููŠ ุงุณุชุฑุฏุงุฏ ุงู„ุตูˆุฑุฉ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ ู…ุชุงุญุฉ ู„ู„ุนุงู…ุฉุŒ ูˆุถู…ู† ุญุฏ ุงู„ุญุฌู…ุŒ ูˆุจุชู†ุณูŠู‚ุงุช ู…ุฏุนูˆู…ุฉ." }, "text": { "$ref": "#/components/schemas/IGoogleSlides.InsertText", @@ -22605,7 +22605,7 @@ "type": "string", "format": "iri", "title": "ุฑุงุจุท ุงู„ุตูˆุฑุฉ", - "description": "ููŠ ุญุงู„ุฉ ูˆุฌูˆุฏ ู…ุดูƒู„ุฉ ููŠ ุงู„ุตูˆุฑุฉุŒ ู‚ุฏ ุชุธู‡ุฑ ุงู„ุฑุณุงู„ุฉ ุฃุฏู†ุงู‡. ูŠุฌุจ ุนู„ูŠูƒ ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑ ุงู„ู…ูˆุฌูˆุฏุฉ ูู‚ุทุŒ ูˆุฅุฐุง ูƒุงู†ุช ุงู„ุตูˆุฑุฉ ุตุบูŠุฑุฉ ุฌุฏู‹ุงุŒ ูู‚ุฏ ุชุธู‡ุฑ ุฃุฎุทุงุกุŒ ู„ุฐุง ู‚ู… ุจุฅุฏุฑุงุฌ ุตูˆุฑุฉ ุจุงู„ุญุฌู… ุงู„ู…ู†ุงุณุจ ุฃูˆ ู‚ู… ุจุฅู†ุดุงุฆู‡ุง ุจู†ูุณูƒ ู„ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑุฉ. ุงู„ุฎุทุฃ ุงู„ุฃูˆู„ ุฃุฏู†ุงู‡ ู‡ูˆ ุนู†ุฏู…ุง ู„ุง ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ู…ูˆุฌูˆุฏุฉุŒ ูˆุงู„ุซุงู†ูŠ ู‡ูˆ ุนู†ุฏู…ุง ูŠูƒูˆู† ุญุฌู… ุฃูˆ ุชู†ุณูŠู‚ ุงู„ุตูˆุฑุฉ ุบูŠุฑ ุตุงู„ุญ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุจุชู†ุณูŠู‚ุงุช jpg ูˆjpeg ูˆpng. 1. ู„ู… ูŠุชู… ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ. 2. ุญุฏุซุช ู…ุดูƒู„ุฉ ููŠ ุงุณุชุฑุฏุงุฏ ุงู„ุตูˆุฑุฉ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ ู…ุชุงุญุฉ ู„ู„ุฌู…ู‡ูˆุฑุŒ ูˆุถู…ู† ุญุฏ ุงู„ุญุฌู…ุŒ ูˆุจุชู†ุณูŠู‚ุงุช ู…ุฏุนูˆู…ุฉ." + "description": "ููŠ ุญุงู„ุฉ ูˆุฌูˆุฏ ู…ุดูƒู„ุฉ ููŠ ุงู„ุตูˆุฑุฉุŒ ู‚ุฏ ุชุธู‡ุฑ ุงู„ุฑุณุงู„ุฉ ุฃุฏู†ุงู‡. ูŠุฌุจ ุนู„ูŠูƒ ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑ ุงู„ู…ูˆุฌูˆุฏุฉ ูู‚ุทุŒ ูˆุฅุฐุง ูƒุงู†ุช ุงู„ุตูˆุฑุฉ ุตุบูŠุฑุฉ ุฌุฏู‹ุงุŒ ูู‚ุฏ ุชุธู‡ุฑ ุฃุฎุทุงุกุŒ ู„ุฐุง ู‚ู… ุจุฅุฏุฑุงุฌ ุตูˆุฑุฉ ุจุงู„ุญุฌู… ุงู„ู…ู†ุงุณุจ ุฃูˆ ู‚ู… ุจุฅู†ุดุงุฆู‡ุง ุจู†ูุณูƒ ู„ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑุฉ. ุงู„ุฎุทุฃ ุงู„ุฃูˆู„ ุฃุฏู†ุงู‡ ู‡ูˆ ุนู†ุฏู…ุง ู„ุง ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ู…ูˆุฌูˆุฏุฉุŒ ูˆุงู„ุซุงู†ูŠ ู‡ูˆ ุนู†ุฏู…ุง ูŠูƒูˆู† ุญุฌู… ุฃูˆ ุชู†ุณูŠู‚ ุงู„ุตูˆุฑุฉ ุบูŠุฑ ุตุงู„ุญ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุจุชู†ุณูŠู‚ุงุช jpg ูˆjpeg ูˆpng. 1. ู„ู… ูŠุชู… ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ. 2. ุญุฏุซุช ู…ุดูƒู„ุฉ ููŠ ุงุณุชุฑุฏุงุฏ ุงู„ุตูˆุฑุฉ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ ู…ุชุงุญุฉ ู„ู„ุนุงู…ุฉุŒ ูˆุถู…ู† ุญุฏ ุงู„ุญุฌู…ุŒ ูˆุจุชู†ุณูŠู‚ุงุช ู…ุฏุนูˆู…ุฉ." } }, "required": [ @@ -22636,7 +22636,7 @@ "type": "string", "format": "iri", "title": "ุฑุงุจุท ุงู„ุตูˆุฑุฉ", - "description": "ููŠ ุญุงู„ุฉ ูˆุฌูˆุฏ ู…ุดูƒู„ุฉ ููŠ ุงู„ุตูˆุฑุฉุŒ ู‚ุฏ ุชุธู‡ุฑ ุงู„ุฑุณุงู„ุฉ ุฃุฏู†ุงู‡. ูŠุฌุจ ุนู„ูŠูƒ ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑ ุงู„ู…ูˆุฌูˆุฏุฉ ูู‚ุทุŒ ูˆุฅุฐุง ูƒุงู†ุช ุงู„ุตูˆุฑุฉ ุตุบูŠุฑุฉ ุฌุฏู‹ุงุŒ ูู‚ุฏ ุชุธู‡ุฑ ุฃุฎุทุงุกุŒ ู„ุฐุง ู‚ู… ุจุฅุฏุฑุงุฌ ุตูˆุฑุฉ ุจุงู„ุญุฌู… ุงู„ู…ู†ุงุณุจ ุฃูˆ ู‚ู… ุจุฅู†ุดุงุฆู‡ุง ุจู†ูุณูƒ ู„ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑุฉ. ุงู„ุฎุทุฃ ุงู„ุฃูˆู„ ุฃุฏู†ุงู‡ ู‡ูˆ ุนู†ุฏู…ุง ู„ุง ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ู…ูˆุฌูˆุฏุฉุŒ ูˆุงู„ุซุงู†ูŠ ู‡ูˆ ุนู†ุฏู…ุง ูŠูƒูˆู† ุญุฌู… ุฃูˆ ุชู†ุณูŠู‚ ุงู„ุตูˆุฑุฉ ุบูŠุฑ ุตุงู„ุญ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุจุชู†ุณูŠู‚ุงุช jpg ูˆjpeg ูˆpng. 1. ู„ู… ูŠุชู… ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ. 2. ุญุฏุซุช ู…ุดูƒู„ุฉ ููŠ ุงุณุชุฑุฏุงุฏ ุงู„ุตูˆุฑุฉ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ ู…ุชุงุญุฉ ู„ู„ุฌู…ู‡ูˆุฑุŒ ูˆุถู…ู† ุญุฏ ุงู„ุญุฌู…ุŒ ูˆุจุชู†ุณูŠู‚ุงุช ู…ุฏุนูˆู…ุฉ." + "description": "ููŠ ุญุงู„ุฉ ูˆุฌูˆุฏ ู…ุดูƒู„ุฉ ููŠ ุงู„ุตูˆุฑุฉุŒ ู‚ุฏ ุชุธู‡ุฑ ุงู„ุฑุณุงู„ุฉ ุฃุฏู†ุงู‡. ูŠุฌุจ ุนู„ูŠูƒ ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑ ุงู„ู…ูˆุฌูˆุฏุฉ ูู‚ุทุŒ ูˆุฅุฐุง ูƒุงู†ุช ุงู„ุตูˆุฑุฉ ุตุบูŠุฑุฉ ุฌุฏู‹ุงุŒ ูู‚ุฏ ุชุธู‡ุฑ ุฃุฎุทุงุกุŒ ู„ุฐุง ู‚ู… ุจุฅุฏุฑุงุฌ ุตูˆุฑุฉ ุจุงู„ุญุฌู… ุงู„ู…ู†ุงุณุจ ุฃูˆ ู‚ู… ุจุฅู†ุดุงุฆู‡ุง ุจู†ูุณูƒ ู„ุฅุฏุฑุงุฌ ุงู„ุตูˆุฑุฉ. ุงู„ุฎุทุฃ ุงู„ุฃูˆู„ ุฃุฏู†ุงู‡ ู‡ูˆ ุนู†ุฏู…ุง ู„ุง ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ู…ูˆุฌูˆุฏุฉุŒ ูˆุงู„ุซุงู†ูŠ ู‡ูˆ ุนู†ุฏู…ุง ูŠูƒูˆู† ุญุฌู… ุฃูˆ ุชู†ุณูŠู‚ ุงู„ุตูˆุฑุฉ ุบูŠุฑ ุตุงู„ุญ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุจุชู†ุณูŠู‚ุงุช jpg ูˆjpeg ูˆpng. 1. ู„ู… ูŠุชู… ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ. 2. ุญุฏุซุช ู…ุดูƒู„ุฉ ููŠ ุงุณุชุฑุฏุงุฏ ุงู„ุตูˆุฑุฉ. ูŠุฌุจ ุฃู† ุชูƒูˆู† ุงู„ุตูˆุฑุฉ ุงู„ู…ู‚ุฏู…ุฉ ู…ุชุงุญุฉ ู„ู„ุนุงู…ุฉุŒ ูˆุถู…ู† ุญุฏ ุงู„ุญุฌู…ุŒ ูˆุจุชู†ุณูŠู‚ุงุช ู…ุฏุนูˆู…ุฉ." }, "text": { "$ref": "#/components/schemas/IGoogleSlides.InsertText", @@ -24575,7 +24575,7 @@ }, "indrAutoUtcnt": { "type": "number", - "title": "ู…ุฎุฒูˆู† ุฏุงุฎู„ูŠ ู…ูƒุชูู ุฐุงุชูŠู‹ุง (ูƒุจูŠุฑ)" + "title": "ู…ุฎุฒูˆู† ู…ูƒุชู ุฐุงุชูŠุง ุฏุงุฎู„ูŠุง (ูƒุจูŠุฑ)" }, "indrAutoArea": { "type": "number", @@ -24657,7 +24657,7 @@ "type": "number" } ], - "title": "ูƒูˆุฏ ุชุตู†ูŠู ุฑู‚ู… ุงู„ุชุตุฑูŠุญ" + "title": "ุฑู…ุฒ ุชุตู†ูŠู ุฑู‚ู… ุงู„ุชุตุฑูŠุญ" }, "pmsnoGbCdNm": { "type": "string", @@ -25790,7 +25790,7 @@ "properties": { "user_request": { "type": "string", - "x-wrtn-placeholder": "ู„ุง ุฏุงุนูŠ ู„ู„ู‚ู„ู‚ ุจุดุฃู† ูƒูŠููŠุฉ ุงุณุชุฎุฏุงู… ุจุทุงู‚ุฉ ุงู„ุงุฆุชู…ุงู† ุงู„ุฎุงุตุฉ ุจูƒ.", + "x-wrtn-placeholder": "ุฅู† ุงู„ุญุตูˆู„ ุนู„ู‰ ุจุทุงู‚ุฉ ุงู„ุงุฆุชู…ุงู† ุงู„ุฎุงุตุฉ ุจูƒ ู‡ูˆ ุฃู…ุฑ ุฑุงุฆุน ุจุงู„ู†ุณุจุฉ ู„ูƒ.", "title": "ุทู„ุจ ุงู„ู…ุณุชุฎุฏู…" }, "system_prompt": { @@ -28870,8 +28870,8 @@ "display", "items" ], - "title": "ุจูŠุงู†ุงุช ู†ุชูŠุฌุฉ ุงู„ุจุญุซ ููŠ Naver Cafe", - "description": "ุจูŠุงู†ุงุช ู†ุชูŠุฌุฉ ุงู„ุจุญุซ ููŠ Naver Cafe." + "title": "ุจูŠุงู†ุงุช ู†ุชูŠุฌุฉ ุงู„ุจุญุซ ููŠ ู…ู‚ู‡ู‰ Naver", + "description": "ุจูŠุงู†ุงุช ู†ุชูŠุฌุฉ ุงู„ุจุญุซ ููŠ ู…ู‚ู‡ู‰ Naver." } }, "required": [ @@ -29236,7 +29236,7 @@ "type": "string", "format": "iri", "title": "ุฑูˆุงุจุท ู„ู„ู…ูˆุงุฏ ุงู„ุฃูƒุงุฏูŠู…ูŠุฉ ุฐุงุช ุงู„ุตู„ุฉ", - "description": "ููŠู…ุง ูŠู„ูŠ ุฑูˆุงุจุท ู„ู„ู…ูˆุงุฏ ุงู„ุฃูƒุงุฏูŠู…ูŠุฉ ุงู„ู…ุชุนู„ู‚ุฉ ุจุงู„ูˆุฑู‚ุฉ ุงู„ุจุญุซูŠุฉ ุงู„ุชูŠ ุชู… ุงู„ุจุญุซ ุนู†ู‡ุง." + "description": "ููŠู…ุง ูŠู„ูŠ ุฑูˆุงุจุท ู„ู„ู…ูˆุงุฏ ุงู„ุฃูƒุงุฏูŠู…ูŠุฉ ุงู„ู…ุชุนู„ู‚ุฉ ุจุงู„ูˆุฑู‚ุฉ ุงู„ุจุญุซูŠุฉ." }, "version_info": { "$ref": "#/components/schemas/IGoogleScholar.IVersion", @@ -32449,7 +32449,7 @@ "type", "people" ], - "title": "ุฎุตุงุฆุต ู‚ุงุนุฏุฉ ุงู„ุจูŠุงู†ุงุช ู„ู„ุฃุดุฎุงุต" + "title": "ุฎุตุงุฆุต ุงู„ุฃุดุฎุงุต ููŠ ู‚ุงุนุฏุฉ ุงู„ุจูŠุงู†ุงุช" }, "INotion.FilesDatabaseProperty": { "type": "object", @@ -32958,7 +32958,7 @@ "type": "string" } ], - "title": "ุฑู…ุฒ ุชุนุจูŠุฑูŠ", + "title": "ุงูŠู‚ูˆู†ุฉ ุงูŠู…ูˆุฌูŠ", "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุฃูŠู‚ูˆู†ุฉ ุนู†ุฏู…ุง ูŠูƒูˆู† ู†ูˆุน ุงู„ุฃูŠู‚ูˆู†ุฉ ุนุจุงุฑุฉ ุนู† ุฑู…ุฒ ุชุนุจูŠุฑูŠ" }, "external": { @@ -33809,7 +33809,7 @@ }, { "const": "13", - "title": "ุจูŠุงุชุดูˆูƒ ู‡ูˆุช" + "title": "ุจูŠุงุชุฑูŠุณ ู‡ูˆุช" }, { "const": "14", @@ -33853,7 +33853,7 @@ }, { "const": "24", - "title": "ู…ูŠุฑุงูƒุง" + "title": "ู…ูŠูƒุงุฑุง" } ] }, @@ -33979,7 +33979,7 @@ "flight", "booking_options" ], - "title": "ู†ุชุงุฆุฌ ุงุฎุชูŠุงุฑ ุงู„ุฑุญู„ุงุช ุงู„ู†ู‡ุงุฆูŠุฉ", + "title": "ู†ุชุงุฆุฌ ุงู„ุงุฎุชูŠุงุฑ ุงู„ู†ู‡ุงุฆูŠ ู„ู„ุฑุญู„ุงุช", "description": "ุฅู„ูŠูƒู… ู†ุชุงุฆุฌ ุงุฎุชูŠุงุฑ ุงู„ุฑุญู„ุงุช ุงู„ู†ู‡ุงุฆูŠุฉ." }, "IGoogleFlight.ISearchOutput": { @@ -38282,7 +38282,7 @@ } ], "title": "ู…ุนุฑู ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ", - "description": "ู…ุนุฑู ุงู„ู…ุดูƒู„ุฉ. ููŠ ุจุนุถ ุงู„ุฃุญูŠุงู†ุŒ ูŠู…ูƒู† ู„ู„ู…ุณุชุฎุฏู… ุฃู† ูŠุฐูƒุฑ ุงุณู… ู†ูˆุน ุงู„ู…ุดูƒู„ุฉุŒ ู…ุซู„ "bug" ุฃูˆ "story"ุŒ ูˆู„ูƒู† ู„ุง ูŠู…ูƒู†ูƒ ุชุญุฏูŠุฏ ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ ุจุงุณุชุฎุฏุงู… ุงุณู… ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ. ู„ุฃู†ู‡ ู‚ุฏ ูŠูƒูˆู† ู‡ู†ุงูƒ ุฃู†ูˆุงุน ุชุญู…ู„ ู†ูุณ ุงู„ุงุณู…. ู„ุฐู„ูƒุŒ ูŠุฌุจ ุนู„ูŠูƒ ุงู„ุชุญู‚ู‚ ู…ู† ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ ุจุงุณุชุฎุฏุงู… ู…ูˆุตู„ ู…ุฎุชู„ู ู„ู„ุชุฃูƒุฏ ู…ู† ุฃู†ู‡ ู†ูˆุน ู…ุดูƒู„ุฉ ูŠู…ูƒู† ุงุณุชุฎุฏุงู…ู‡ ููŠ ุงู„ู…ุดุฑูˆุน. ูˆู…ุน ุฐู„ูƒุŒ ุฅุฐุง ู‚ู…ุช ุจุชุณู„ูŠู… ู†ูˆุน ุงู„ุณู„ุณู„ุฉ ุงู„ุฑู‚ู…ูŠุฉ ู…ู† ุงู„ุจุฏุงูŠุฉุŒ ูู‚ุฏ ูŠูƒูˆู† ู…ุนุฑู ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ." + "description": "ู…ุนุฑู ุงู„ู…ุดูƒู„ุฉ. ููŠ ุจุนุถ ุงู„ุฃุญูŠุงู†ุŒ ูŠู…ูƒู† ู„ู„ู…ุณุชุฎุฏู… ุฃู† ูŠุฐูƒุฑ ุงุณู… ู†ูˆุน ุงู„ู…ุดูƒู„ุฉุŒ ู…ุซู„ "bug" ุฃูˆ "story"ุŒ ูˆู„ูƒู† ู„ุง ูŠู…ูƒู†ูƒ ุชุญุฏูŠุฏ ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ ุจุงุณุชุฎุฏุงู… ุงุณู… ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ. ู„ุฃู†ู‡ ู‚ุฏ ูŠูƒูˆู† ู‡ู†ุงูƒ ุฃู†ูˆุงุน ุชุญู…ู„ ู†ูุณ ุงู„ุงุณู…. ู„ุฐู„ูƒุŒ ูŠุฌุจ ุนู„ูŠูƒ ุงู„ุชุญู‚ู‚ ู…ู† ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ ุจุงุณุชุฎุฏุงู… ู…ูˆุตู„ ู…ุฎุชู„ู ู„ู„ุชุฃูƒุฏ ู…ู† ุฃู†ู‡ ู†ูˆุน ู…ุดูƒู„ุฉ ูŠู…ูƒู† ุงุณุชุฎุฏุงู…ู‡ ููŠ ุงู„ู…ุดุฑูˆุน. ูˆู…ุน ุฐู„ูƒุŒ ุฅุฐุง ุณู„ู…ุช ู†ูˆุน ุงู„ุณู„ุณู„ุฉ ุงู„ุฑู‚ู…ูŠุฉ ู…ู† ุงู„ุจุฏุงูŠุฉุŒ ูู‚ุฏ ูŠูƒูˆู† ู…ุนุฑู ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ." } }, "required": [ @@ -38521,7 +38521,7 @@ } ], "title": "ู…ุนุฑู ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ", - "description": "ู…ุนุฑู ุงู„ู…ุดูƒู„ุฉ. ููŠ ุจุนุถ ุงู„ุฃุญูŠุงู†ุŒ ูŠู…ูƒู† ู„ู„ู…ุณุชุฎุฏู… ุฃู† ูŠุฐูƒุฑ ุงุณู… ู†ูˆุน ุงู„ู…ุดูƒู„ุฉุŒ ู…ุซู„ "bug" ุฃูˆ "story"ุŒ ูˆู„ูƒู† ู„ุง ูŠู…ูƒู†ูƒ ุชุญุฏูŠุฏ ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ ุจุงุณุชุฎุฏุงู… ุงุณู… ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ. ู„ุฃู†ู‡ ู‚ุฏ ูŠูƒูˆู† ู‡ู†ุงูƒ ุฃู†ูˆุงุน ุชุญู…ู„ ู†ูุณ ุงู„ุงุณู…. ู„ุฐู„ูƒุŒ ูŠุฌุจ ุนู„ูŠูƒ ุงู„ุชุญู‚ู‚ ู…ู† ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ ุจุงุณุชุฎุฏุงู… ู…ูˆุตู„ ู…ุฎุชู„ู ู„ู„ุชุฃูƒุฏ ู…ู† ุฃู†ู‡ ู†ูˆุน ู…ุดูƒู„ุฉ ูŠู…ูƒู† ุงุณุชุฎุฏุงู…ู‡ ููŠ ุงู„ู…ุดุฑูˆุน. ูˆู…ุน ุฐู„ูƒุŒ ุฅุฐุง ู‚ู…ุช ุจุชุณู„ูŠู… ู†ูˆุน ุงู„ุณู„ุณู„ุฉ ุงู„ุฑู‚ู…ูŠุฉ ู…ู† ุงู„ุจุฏุงูŠุฉุŒ ูู‚ุฏ ูŠูƒูˆู† ู…ุนุฑู ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ." + "description": "ู…ุนุฑู ุงู„ู…ุดูƒู„ุฉ. ููŠ ุจุนุถ ุงู„ุฃุญูŠุงู†ุŒ ูŠู…ูƒู† ู„ู„ู…ุณุชุฎุฏู… ุฃู† ูŠุฐูƒุฑ ุงุณู… ู†ูˆุน ุงู„ู…ุดูƒู„ุฉุŒ ู…ุซู„ "bug" ุฃูˆ "story"ุŒ ูˆู„ูƒู† ู„ุง ูŠู…ูƒู†ูƒ ุชุญุฏูŠุฏ ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ ุจุงุณุชุฎุฏุงู… ุงุณู… ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ. ู„ุฃู†ู‡ ู‚ุฏ ูŠูƒูˆู† ู‡ู†ุงูƒ ุฃู†ูˆุงุน ุชุญู…ู„ ู†ูุณ ุงู„ุงุณู…. ู„ุฐู„ูƒุŒ ูŠุฌุจ ุนู„ูŠูƒ ุงู„ุชุญู‚ู‚ ู…ู† ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ ุจุงุณุชุฎุฏุงู… ู…ูˆุตู„ ู…ุฎุชู„ู ู„ู„ุชุฃูƒุฏ ู…ู† ุฃู†ู‡ ู†ูˆุน ู…ุดูƒู„ุฉ ูŠู…ูƒู† ุงุณุชุฎุฏุงู…ู‡ ููŠ ุงู„ู…ุดุฑูˆุน. ูˆู…ุน ุฐู„ูƒุŒ ุฅุฐุง ุณู„ู…ุช ู†ูˆุน ุงู„ุณู„ุณู„ุฉ ุงู„ุฑู‚ู…ูŠุฉ ู…ู† ุงู„ุจุฏุงูŠุฉุŒ ูู‚ุฏ ูŠูƒูˆู† ู…ุนุฑู ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ." } }, "required": [ @@ -39876,7 +39876,7 @@ "traffic": { "type": "string", "title": "ู‡ุงู‡ุงู‡ุงู‡ุงู‡ุง", - "description": "ุฃูุถู„ ู…ุง ููŠ ุงู„ุฃู…ุฑ ู‡ูˆ ุงู„ุญุตูˆู„ ุนู„ู‰ ู…ูƒุงูุขุช ุฑุงุฆุนุฉ." + "description": "ุฃูุถู„ ู…ุง ููŠ ุงู„ุฃู…ุฑ ู‡ูˆ ุงู„ุญุตูˆู„ ุนู„ู‰ ุงู„ู…ุงู„." } }, "required": [ @@ -39886,7 +39886,7 @@ "traffic" ], "title": "ุฃูุถู„ ู…ุง ููŠ ุงู„ุฃู…ุฑ ู‡ูˆ ุงู„ุญุตูˆู„ ุนู„ู‰ ุงู„ู…ุงู„", - "description": "ู‡ุฐุง ู‡ูˆ ุงู„ุณุจุจ ููŠ ุฃู† ู‡ุฐุง ู‡ูˆ ู…ุง ูŠุญุฏุซ." + "description": "ู‡ุฐุง ู‡ูˆ ุงู„ุณุจุจ ููŠ ุฃู† ู‡ุฐุง ู‡ูˆ ุงู„ุญุงู„ ุจุงู„ู†ุณุจุฉ ู„ูƒ.." }, "IGoogleTrend.IRequest": { "type": "object", @@ -39899,7 +39899,7 @@ } }, "title": "ุฃูุถู„ ู…ุง ููŠ ุงู„ุฃู…ุฑ ู‡ูˆ ุงู„ุญุตูˆู„ ุนู„ู‰ ุจุทุงู‚ุฉ ุงู„ุงุฆุชู…ุงู†", - "description": "ุดูƒุฑุง ุฌุฒูŠู„ุง ู„ูƒ. ู‡ุฐุง ู‡ูˆ ุงู„ุณุจุจ ููŠ ุฃู† ู‡ุฐุง ู‡ูˆ ู…ุง ูŠุญุฏุซ ุงู„ุขู†. ๋‚ ์งœ ํ˜•์‹์€ "20241231" ํ˜•์‹์ž…๋‹ˆ๋‹ค." + "description": "ุดูƒุฑุง ุฌุฒูŠู„ุง ู„ูƒ. ู‡ุฐุง ู‡ูˆ ุงู„ุณุจุจ ููŠ ุฃู† ู‡ุฐุง ู‡ูˆ ู…ุง ูŠุญุฏุซ. ๋‚ ์งœ ํ˜•์‹์€ "20241231" ํ˜•์‹์ž…๋‹ˆ๋‹ค." }, "IGoogleMap.IResponse": { "type": "object", @@ -40167,7 +40167,7 @@ }, { "const": "PullRequestReviewThreadEvent", - "title": "ุณุญุจ ุทู„ุจ ู…ุฑุงุฌุนุฉ ุงู„ู…ูˆุถูˆุน ุงู„ุญุฏุซ", + "title": "ุณุญุจ ุทู„ุจ ู…ุฑุงุฌุนุฉ ุงู„ู…ูˆุถูˆุน", "description": "ูŠุชู… ุชุดุบูŠู„ู‡ ุนู†ุฏู…ุง ูŠูƒูˆู† ู‡ู†ุงูƒ ุชุบูŠูŠุฑ ููŠ ุณู„ุณู„ุฉ ุงู„ู…ุฑุงุฌุนุฉ ููŠ ุทู„ุจ ุงู„ุณุญุจ." }, { @@ -43776,7 +43776,7 @@ "properties": { "pull_request_review_id": { "type": "integer", - "title": "ุทู„ุจ ู…ุฑุงุฌุนุฉ ุงู„ุณุญุจ" + "title": "ู…ุนุฑู ุทู„ุจ ุงู„ู…ุฑุงุฌุนุฉ" }, "diff_hunk": { "type": "string", @@ -46392,7 +46392,7 @@ "$ref": "#/components/schemas/RepositoryreadmeIGetReadmeFileContentOutput" } ], - "title": "ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ ู„ู„ู…ุณุชูˆุฏุน" + "title": "ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ_ุงู„ู…ุณุชูˆุฏุน" }, "pinned_repositories": { "type": "array", @@ -49408,7 +49408,7 @@ "pinned", "type" ], - "title": "๋ฉ”์„ธ์ง€ ์ •๋ณด" + "title": "ู…ู‚ุงู„ุงุช ุฐุงุช ุตู„ุฉ" }, "IDiscord.IChannelMention": { "type": "object", @@ -49806,7 +49806,7 @@ "jmesPath": "[].{value:id, label:name}" }, "title": "์ฑ„๋„", - "description": "ู„ุง ุฏุงุนูŠ ู„ู„ู‚ู„ู‚ ุจุดุฃู† ู‡ุฐุง ุงู„ุฃู…ุฑ." + "description": "ู‚ู… ุจุญุฌุฒ ู…ูƒุงู†ูƒ ุงู„ู…ูุถู„ ููŠ ุงู„ู…ู†ุฒู„." }, "messageId": { "type": "string", @@ -49859,7 +49859,7 @@ }, "content": { "type": "string", - "title": "ู…ูŠุฑุณูŠู‡ ู†ูŠูŠู‡", + "title": "๋ฉ”์„ธ์ง€ ๋‚ด์šฉ", "description": "๋ฉ”์„ธ์ง€ ๋‚ด์šฉ์„ ์ž…๋ ฅํ•ด์ฃผ์„ธ์š”." } }, @@ -49926,7 +49926,7 @@ "jmesPath": "[].{value:id, label:content}" }, "title": "์‚ญ์ œํ•  ๋ฉ”์„ธ์ง€", - "description": "ู…ุณุชู„ุฒู…ุงุช ุดุฎุตูŠุฉ" + "description": "ุฃูุถู„ ู…ุง ููŠ ุงู„ุฃู…ุฑ ู‡ูˆ ุงู„ุญุตูˆู„ ุนู„ู‰ ุจุทุงู‚ุฉ ุงู„ุงุฆุชู…ุงู†" } }, "required": [ @@ -50413,7 +50413,7 @@ }, "enabled": { "type": "boolean", - "title": "ูŠุชู… ุชู…ูƒูŠู† ู‡ุฐุง ุงู„ุฎูŠุงุฑ true ุฅุฐุง ูƒุงู† ุงู„ุณุคุงู„ ุงู„ุฐูŠ ุฃู†ุดุฃู‡ ุงู„ู…ุถูŠู ู‚ูŠุฏ ุงู„ุชุดุบูŠู„ ูˆูƒุงู† ู…ุฑุฆูŠู‹ุง ุนู„ู‰ ุตูุญุฉ ุญุฌุฒ ุงู„ุญุฏุซุ› ูˆูŠุชู… ุชู…ูƒูŠู† ู‡ุฐุง ุงู„ุฎูŠุงุฑ false ุฅุฐุง ูƒุงู† ู…ุบู„ู‚ู‹ุง ูˆุบูŠุฑ ู…ุฑุฆูŠ ุนู„ู‰ ุตูุญุฉ ุญุฌุฒ ุงู„ุญุฏุซ." + "title": "ูŠุชู… ุชู…ูƒูŠู† ู‡ุฐุง ุงู„ุฎูŠุงุฑ ุนู„ู‰ ุงู„ู†ุญูˆ ุงู„ุชุงู„ูŠ: ุตุญูŠุญ ุฅุฐุง ูƒุงู† ุงู„ุณุคุงู„ ุงู„ุฐูŠ ุฃู†ุดุฃู‡ ุงู„ู…ุถูŠู ู‚ูŠุฏ ุงู„ุชุดุบูŠู„ ูˆูƒุงู† ู…ุฑุฆูŠู‹ุง ุนู„ู‰ ุตูุญุฉ ุญุฌุฒ ุงู„ุญุฏุซุ› ุฎุทุฃ ุฅุฐุง ุชู… ุฅูŠู‚ุงู ุชุดุบูŠู„ู‡ ูˆูƒุงู† ุบูŠุฑ ู…ุฑุฆูŠ ุนู„ู‰ ุตูุญุฉ ุญุฌุฒ ุงู„ุญุฏุซ." }, "required": { "type": "boolean", @@ -54281,7 +54281,7 @@ "status", "data" ], - "title": "ูˆุงุฌู‡ุฉ ุงู„ุฅุฎุฑุงุฌ ู„ู„ุญุตูˆู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช ุงู„ู…ุฌุงู„", + "title": "ูˆุงุฌู‡ุฉ ุฅุฎุฑุงุฌ ู„ู„ุญุตูˆู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช ุงู„ู…ุฌุงู„", "description": "ูŠุญุชูˆูŠ ุนู„ู‰ ุชูุงุตูŠู„ ุงู„ุงุณุชุฌุงุจุฉ ู„ุงุณุชุฑุฌุงุน ู…ุนู„ูˆู…ุงุช ุงู„ู…ุฌุงู„" }, "ISimilarweb.DomainInfo": { @@ -54322,7 +54322,7 @@ }, "EstimatedMonthlyVisits": { "$ref": "#/components/schemas/Recordstringnumber", - "title": "ุชู‚ุฏูŠุฑ ุนุฏุฏ ุงู„ุฒูŠุงุฑุงุช ุงู„ุดู‡ุฑูŠุฉ", + "title": "ุงู„ุฒูŠุงุฑุงุช ุงู„ุดู‡ุฑูŠุฉ ุงู„ู…ู‚ุฏุฑุฉ", "description": "ุนุฏุฏ ุงู„ุฒูŠุงุฑุงุช ุงู„ุดู‡ุฑูŠุฉ ุงู„ู…ู‚ุฏุฑุฉ. ุงู„ู…ูุชุงุญ ู‡ูˆ ุชู†ุณูŠู‚ ุงู„ุชุงุฑูŠุฎ (YYYY-MM-DD) ูˆุงู„ู‚ูŠู…ุฉ ู‡ูŠ ุฑู‚ู…. (ุนู„ู‰ ุณุจูŠู„ ุงู„ู…ุซุงู„ { "2024-07-01": ุฑู‚ู… } )" }, "GlobalRank": { @@ -54342,7 +54342,7 @@ }, "GlobalCategoryRank": { "title": "ุงู„ุชุตู†ูŠู ุงู„ุนุงู„ู…ูŠ ู„ู„ูุฆุฉ", - "description": "ุงู„ุชุตู†ูŠู ุงู„ุนุงู„ู…ูŠ ู„ู„ูุฆุฉ" + "description": "ุชุตู†ูŠู ุงู„ูุฆุฉ ุงู„ุนุงู„ู…ูŠุฉ" }, "IsSmall": { "type": "boolean", diff --git a/assets/output/connector.swagger.ja.json b/assets/output/connector.swagger.ja.json index c9cbdbb..aef13b8 100644 --- a/assets/output/connector.swagger.ja.json +++ b/assets/output/connector.swagger.ja.json @@ -73,7 +73,7 @@ }, "/workflow/run/{workflowRunId}": { "get": { - "description": "1ใคใฎใƒฏใƒผใ‚ฏใƒ•ใƒญใƒผๅฎŸ่กŒใฎใ‚นใƒ†ใƒผใ‚ฟใ‚นใ‚’่ฟ”ใ™", + "description": "1ๅ›žใฎใƒฏใƒผใ‚ฏใƒ•ใƒญใƒผๅฎŸ่กŒใฎใ‚นใƒ†ใƒผใ‚ฟใ‚นใ‚’่ฟ”ใ™", "tags": [], "parameters": [ { @@ -2178,7 +2178,7 @@ "/connector/gmail/{id}/hardDelete": { "delete": { "summary": "ใƒกใƒผใƒซใ‚’ๅ‰Š้™ค", - "description": "ใƒกใƒผใƒซใ‚’ๅ‰Š้™คใ™ใ‚‹GmailใฏGoogleใŒๆไพ›ใ™ใ‚‹็„กๆ–™ใฎใ‚ฆใ‚งใƒ–ใƒ™ใƒผใ‚นใฎใƒกใƒผใƒซใ‚ตใƒผใƒ“ใ‚นใงใ™ใ€‚ใ“ใฎๆฉŸ่ƒฝใฏใƒกใƒผใƒซใ‚’ใ‚ดใƒŸ็ฎฑใซ็งปๅ‹•ใ™ใ‚‹ใฎใงใฏใชใใ€ๅฎŒๅ…จใซๅ‰Š้™คใ™ใ‚‹ใŸใ‚ใ€็‰นๅˆฅใชๆณจๆ„ใŒๅฟ…่ฆใงใ™ใ€‚ใปใจใ‚“ใฉใฎใƒฆใƒผใ‚ถใƒผใฏใ€ใ™ใงใซใ‚ดใƒŸ็ฎฑใซใ‚ใ‚‹ใƒกใƒผใƒซใ‚’ๅ‰Š้™คใ—ใŸใ„ใงใ—ใ‚‡ใ†ใ€‚ใ—ใŸใŒใฃใฆใ€ใƒฆใƒผใ‚ถใƒผใŒๅ‰Š้™คใ—ใŸใ„ๅ ดๅˆใฏใ€ใƒกใƒผใƒซใ‚’ใ‚ดใƒŸ็ฎฑใซ็งปๅ‹•ใ™ใ‚‹ใ‚ˆใ†ใซ่ช˜ๅฐŽใ™ใ‚‹ใฎใŒ่‰ฏใ„ใงใ™ใŒใ€ใใ‚Œใงใ‚‚ๅ‰Š้™คใ—ใŸใ„ๅ ดๅˆใฏใ€ใ‚ดใƒŸ็ฎฑใ‚’ใ‚ฟใƒผใ‚ฒใƒƒใƒˆใซใ™ใ‚‹ใฎใŒๆญฃใ—ใ„ใงใ™ใ€‚.", + "description": "ใƒกใƒผใƒซใ‚’ๅ‰Š้™คใ™ใ‚‹GmailใฏGoogleใŒๆไพ›ใ™ใ‚‹็„กๆ–™ใฎใ‚ฆใ‚งใƒ–ใƒ™ใƒผใ‚นใฎใƒกใƒผใƒซใ‚ตใƒผใƒ“ใ‚นใงใ™ใ€‚ใ“ใฎๆฉŸ่ƒฝใฏใƒกใƒผใƒซใ‚’ใ‚ดใƒŸ็ฎฑใซ็งปๅ‹•ใ™ใ‚‹ใฎใงใฏใชใๆฐธไน…ใซๅ‰Š้™คใ™ใ‚‹ใŸใ‚ใ€็‰นๅˆฅใชๆณจๆ„ใŒๅฟ…่ฆใงใ™ใ€‚ใปใจใ‚“ใฉใฎใƒฆใƒผใ‚ถใƒผใฏใ€ใ™ใงใซใ‚ดใƒŸ็ฎฑใซใ‚ใ‚‹ใƒกใƒผใƒซใ‚’ๅ‰Š้™คใ—ใŸใ„ใงใ—ใ‚‡ใ†ใ€‚ใ—ใŸใŒใฃใฆใ€ใƒฆใƒผใ‚ถใƒผใŒๅ‰Š้™คใ—ใŸใ„ๅ ดๅˆใฏใ€ใƒกใƒผใƒซใ‚’ใ‚ดใƒŸ็ฎฑใซ็งปๅ‹•ใ™ใ‚‹ใ‚ˆใ†ใซ่ช˜ๅฐŽใ™ใ‚‹ใฎใŒ่‰ฏใ„ใงใ™ใŒใ€ใใ‚Œใงใ‚‚ๅ‰Š้™คใ—ใŸใ„ๅ ดๅˆใฏใ€ใ‚ดใƒŸ็ฎฑใ‚’ใ‚ฟใƒผใ‚ฒใƒƒใƒˆใซใ™ใ‚‹ใฎใŒๆญฃใ—ใ„ใงใ™ใ€‚.", "tags": [ "Gmail" ], @@ -4222,7 +4222,7 @@ ], "parameters": [], "requestBody": { - "description": "ๅคฉๆฐ—ไบˆๅ ฑใ‚ฏใ‚จใƒชใฎๅ ดๆ‰€ใฎ DTO", + "description": "ๅคฉๆฐ—ใ‚ฏใ‚จใƒชใฎๅ ดๆ‰€ใฎ DTO", "content": { "application/json": { "schema": { @@ -5319,7 +5319,7 @@ "/connector/google-ads/generateKeywordIdeas/keywordsAndUrl": { "post": { "summary": "ใ‚ญใƒผใƒฏใƒผใƒ‰ใจURLใ‚’ไฝฟ็”จใ—ใฆใ‚ญใƒผใƒฏใƒผใƒ‰ใ‚’ไฝœๆˆใ™ใ‚‹", - "description": "Google ๅบƒๅ‘Šใฎใ‚ญใƒผใƒฏใƒผใƒ‰ใ‚’ๆŽจๅฅจใ™ใ‚‹ Google ๅบƒๅ‘Šใงๅบƒๅ‘Šใ‚’ๅฎŸ่กŒใ™ใ‚‹ใซใฏใ€ใ‚ญใƒผใƒฏใƒผใƒ‰ใ‚’็™ป้Œฒใ™ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚ใ‚ญใƒผใƒฏใƒผใƒ‰ใฏๅบƒๅ‘Šใฎใ‚จใƒณใƒ‰ใƒฆใƒผใ‚ถใƒผใ‚’ใ‚ฟใƒผใ‚ฒใƒƒใƒˆใซใ™ใ‚‹ใŸใ‚ใซ็™ป้Œฒใ™ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใ€Google ๅบƒๅ‘Šใฎใƒชใ‚ฝใƒผใ‚นใฎใ†ใก `adGroup` ใซใƒžใƒƒใƒ”ใƒณใ‚ฐใ•ใ‚Œใฆใ„ใ‚‹ `adGroupCriteria` ใฎ 1 ใคใงใ™ใ€‚ใ“ใฎใ‚ณใƒใ‚ฏใ‚ฟใฏใ€ใใฎใ‚ˆใ†ใชใ‚ญใƒผใƒฏใƒผใƒ‰ใ‚’ๆŽจๅฅจใ™ใ‚‹ๆฉŸ่ƒฝใงใ€ใƒฆใƒผใ‚ถใƒผใŒ็™ป้Œฒใ—ใŸใ„ใ‚ญใƒผใƒฏใƒผใƒ‰ใจ URL ใ‚’ๅ…ฅๅŠ›ใ™ใ‚‹ใจใ€ใใ“ใ‹ใ‚‰ๆดพ็”Ÿใงใใ‚‹ไป–ใฎใ‚ญใƒผใƒฏใƒผใƒ‰ใ‚’ๆŽจๅฅจใ—ใพใ™ใ€‚ใƒชใ‚ฏใ‚จใ‚นใƒˆ็ตๆžœใฏใ€ๅบƒๅ‘Š็™ป้Œฒๆ™‚ใฎใ‚ญใƒผใƒฏใƒผใƒ‰ใฎไธ€่ฆงใ€็ซถๅˆๆŒ‡ๆ•ฐใ€ๅ˜ไพกใ€ใ‚ญใƒผใƒฏใƒผใƒ‰ใ”ใจใฎไบˆๆƒณๆŒ‡ๆ•ฐๅ€คใงใ™ใ€‚ใ“ใฎใ‚ณใƒใ‚ฏใ‚ฟใฏใ€ใ‚ขใƒ€ใƒซใƒˆๅบƒๅ‘Šใฎใ‚ญใƒผใƒฏใƒผใƒ‰ใ‚’้™คๅค–ใ—ใ€่จ€่ชžๆกไปถใฏ้Ÿ“ๅ›ฝ่ชžใ€ๅœฐๅŸŸๆกไปถใฏ้Ÿ“ๅ›ฝ (ๅคง้Ÿ“ๆฐ‘ๅ›ฝ) ใซ่จญๅฎšใ•ใ‚Œใฆใ„ใพใ™ใ€‚ๆฉŸ่ƒฝใ‚’ๅ‘ผใณๅ‡บใ™ๅ‰ใซใ€ใƒฆใƒผใ‚ถใƒผใซ `customerId` ใ‚’ๅฐ‹ใญใ‚‹ๅฟ…่ฆใŒใ‚ใ‚‹ใŸใ‚ใ€`customerId` ใ‚’็ขบ่ชใงใใ‚‹ใ‚ณใƒใ‚ฏใ‚ฟใ‚’ๆๆกˆใ™ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚.", + "description": "Google ๅบƒๅ‘Šใฎใ‚ญใƒผใƒฏใƒผใƒ‰ใ‚’ๆŽจๅฅจใ™ใ‚‹ Google ๅบƒๅ‘Šใงๅบƒๅ‘Šใ‚’ๅฎŸ่กŒใ™ใ‚‹ใซใฏใ€ใ‚ญใƒผใƒฏใƒผใƒ‰ใ‚’็™ป้Œฒใ™ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚ใ‚ญใƒผใƒฏใƒผใƒ‰ใฏๅบƒๅ‘Šใฎใ‚จใƒณใƒ‰ใƒฆใƒผใ‚ถใƒผใ‚’ใ‚ฟใƒผใ‚ฒใƒƒใƒˆใซใ™ใ‚‹ใŸใ‚ใซ็™ป้Œฒใ™ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใ€Google ๅบƒๅ‘Šใฎใƒชใ‚ฝใƒผใ‚นใฎใ†ใก `adGroup` ใซใƒžใƒƒใƒ”ใƒณใ‚ฐใ•ใ‚Œใฆใ„ใ‚‹ `adGroupCriteria` ใฎ 1 ใคใงใ™ใ€‚ใ“ใฎใ‚ณใƒใ‚ฏใ‚ฟใฏใ€ใใฎใ‚ˆใ†ใชใ‚ญใƒผใƒฏใƒผใƒ‰ใ‚’ๆŽจๅฅจใ™ใ‚‹ๆฉŸ่ƒฝใงใ€ใƒฆใƒผใ‚ถใƒผใŒ็™ป้Œฒใ—ใŸใ„ใ‚ญใƒผใƒฏใƒผใƒ‰ใจ URL ใ‚’ๅ…ฅๅŠ›ใ™ใ‚‹ใจใ€ใใ“ใ‹ใ‚‰ๆดพ็”Ÿใงใใ‚‹ไป–ใฎใ‚ญใƒผใƒฏใƒผใƒ‰ใ‚’ๆŽจๅฅจใ—ใพใ™ใ€‚ใƒชใ‚ฏใ‚จใ‚นใƒˆ็ตๆžœใฏใ€ๅบƒๅ‘Š็™ป้Œฒๆ™‚ใฎใ‚ญใƒผใƒฏใƒผใƒ‰ใฎไธ€่ฆงใ€็ซถๅˆๆŒ‡ๆ•ฐใ€ๅ˜ไพกใ€ใ‚ญใƒผใƒฏใƒผใƒ‰ใ”ใจใฎๆœŸๅพ…ๆŒ‡ๆ•ฐๅ€คใงใ™ใ€‚ใ“ใฎใ‚ณใƒใ‚ฏใ‚ฟใฏใ€ใ‚ขใƒ€ใƒซใƒˆๅบƒๅ‘Šใฎใ‚ญใƒผใƒฏใƒผใƒ‰ใ‚’้™คๅค–ใ—ใ€่จ€่ชžๆกไปถใฏ้Ÿ“ๅ›ฝ่ชžใ€ๅœฐๅŸŸๆกไปถใฏ้Ÿ“ๅ›ฝ (ๅคง้Ÿ“ๆฐ‘ๅ›ฝ) ใซ่จญๅฎšใ•ใ‚Œใฆใ„ใพใ™ใ€‚ๆฉŸ่ƒฝใ‚’ๅ‘ผใณๅ‡บใ™ๅ‰ใซใ€ใƒฆใƒผใ‚ถใƒผใซ `customerId` ใ‚’ๅฐ‹ใญใ‚‹ๅฟ…่ฆใŒใ‚ใ‚‹ใŸใ‚ใ€`customerId` ใ‚’็ขบ่ชใงใใ‚‹ใ‚ณใƒใ‚ฏใ‚ฟใ‚’ๆๆกˆใ™ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚.", "tags": [ "Google Ads" ], @@ -5884,7 +5884,7 @@ }, "post": { "summary": "ใ‚ญใƒฃใƒณใƒšใƒผใƒณใ‚’ไฝœๆˆใ™ใ‚‹", - "description": "Google ้กงๅฎขใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎๅบƒๅ‘Šใ‚ญใƒฃใƒณใƒšใƒผใƒณใ‚’ไฝœๆˆใ—ใพใ™ใ€‚ใ‚ญใƒฃใƒณใƒšใƒผใƒณ (= ใ‚ญใƒฃใƒณใƒšใƒผใƒณ) ใ‚’ไฝœๆˆใ—ใพใ™ใ€‚ใ‚ญใƒฃใƒณใƒšใƒผใƒณใฏ Google ๅบƒๅ‘Šใงใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎไธ‹ไฝใซใ‚ใ‚Šใ€ใ‚ญใƒฃใƒณใƒšใƒผใƒณใ€ๅบƒๅ‘Šใ‚ฐใƒซใƒผใƒ—ใ€ๅบƒๅ‘Šใงๆง‹ๆˆใ•ใ‚Œใ‚‹ใƒ„ใƒชใƒผๆง‹้€ ใฎๆœ€ไธŠไฝใซใ‚ใ‚Šใพใ™ใ€‚ใ‚ญใƒฃใƒณใƒšใƒผใƒณใฏๅบƒๅ‘Šใ‚ฐใƒซใƒผใƒ—ใ‚’ใ‚ฐใƒซใƒผใƒ—ๅŒ–ใ™ใ‚‹่ฆชใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆใงใ€ๅบƒๅ‘ŠใฎๆœŸ้–“ใ€ไบˆ็ฎ—ใ€็›ฎ็š„ใ€ใƒใƒฃใƒใƒซใชใฉใ‚’ๆ‹…ใ„ใพใ™ใ€‚ใ‚ญใƒฃใƒณใƒšใƒผใƒณๅใ‚’ๆŒ‡ๅฎšใ—ใชใ„ใจใ€ใƒฉใƒณใƒ€ใƒ ใชๅๅ‰ใŒๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚Œใพใ™ใ€‚ใ“ใฎๅ ดๅˆใ€่ญ˜ๅˆฅใŒๅ›ฐ้›ฃใซใชใ‚‹ๅฏ่ƒฝๆ€งใŒใ‚ใ‚Šใพใ™ใ€‚ใ—ใŸใŒใฃใฆใ€ๅ„ใ‚ญใƒฃใƒณใƒšใƒผใƒณใซใฏ็›ฎ็š„ใซๅฟœใ˜ใฆ็•ฐใชใ‚‹ๅๅ‰ใ‚’ไป˜ใ‘ใฆๅŒบๅˆฅใงใใ‚‹ใ‚ˆใ†ใซใ™ใ‚‹ใ“ใจใ‚’ใŠๅ‹งใ‚ใ—ใพใ™ใ€‚ใ‚ญใƒฃใƒณใƒšใƒผใƒณใฎๅๅ‰ใฏใ€ใƒฆใƒผใ‚ถใƒผใŒ็ฐกๅ˜ใซ่ญ˜ๅˆฅใงใใ‚‹ใ‚ˆใ†ใซใ™ใ‚‹ใŸใ‚ใฎใ‚‚ใฎใงใ‚ใ‚Šใ€ๅบƒๅ‘ŠใฎๅŠนๆžœใซใฏใพใฃใŸใๅฝฑ้Ÿฟใ—ใพใ›ใ‚“ใฎใงใ€ๅฎ‰ๅฟƒใ—ใฆใใ ใ•ใ„ใ€‚`customerId` ใ‚’ๆธกใ•ใชใ„ๅ ดๅˆใฏใ€ใƒฆใƒผใ‚ถใƒผใ‹ใ‚‰ `Wrtn` ใซใ‚ขใ‚ฏใ‚ปใ‚นใงใใ‚‹ๅบƒๅ‘Šใ‚ขใ‚ซใ‚ฆใƒณใƒˆใŒ 1 ใคใ—ใ‹ใชใ„ๅ ดๅˆใซใฎใฟ่‡ชๅ‹•็š„ใซ้ธๆŠžใ•ใ‚Œใพใ™ใ€‚้–ขๆ•ฐใ‚’ๅ‘ผใณๅ‡บใ™ๅ‰ใซใƒฆใƒผใ‚ถใƒผใซ `customerId` ใ‚’ๅฐ‹ใญใ‚‹ๅฟ…่ฆใŒใ‚ใ‚‹ใŸใ‚ใ€`customerId` ใ‚’็ขบ่ชใงใใ‚‹ใ‚ณใƒใ‚ฏใ‚ฟใ‚’ๆๆกˆใ™ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚ๅฝ“ๅˆใฏ้‡‘้กๅˆถ้™ใฏใชใ‹ใฃใŸใŒใ€็ทŠๆ€ฅไบ‹ๆ…‹ใซๅ‚™ใˆใฆ็พๅœจใฏใ‚ญใƒฃใƒณใƒšใƒผใƒณใ”ใจใซ10ไธ‡ใ‚ฆใ‚ฉใƒณใซๅˆถ้™ใ•ใ‚Œใฆใ„ใ‚‹ใ€‚.", + "description": "Google ้กงๅฎขใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎๅบƒๅ‘Šใ‚ญใƒฃใƒณใƒšใƒผใƒณใ‚’ไฝœๆˆใ—ใพใ™ใ€‚ใ‚ญใƒฃใƒณใƒšใƒผใƒณ (= ใ‚ญใƒฃใƒณใƒšใƒผใƒณ) ใ‚’ไฝœๆˆใ—ใพใ™ใ€‚ใ‚ญใƒฃใƒณใƒšใƒผใƒณใฏ Google ๅบƒๅ‘Šใงใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎไธ‹ไฝใซใ‚ใ‚Šใ€ใ‚ญใƒฃใƒณใƒšใƒผใƒณใ€ๅบƒๅ‘Šใ‚ฐใƒซใƒผใƒ—ใ€ๅบƒๅ‘Šใงๆง‹ๆˆใ•ใ‚Œใ‚‹ใƒ„ใƒชใƒผๆง‹้€ ใฎๆœ€ไธŠไฝใซใ‚ใ‚Šใพใ™ใ€‚ใ‚ญใƒฃใƒณใƒšใƒผใƒณใฏๅบƒๅ‘Šใ‚ฐใƒซใƒผใƒ—ใ‚’ใ‚ฐใƒซใƒผใƒ—ๅŒ–ใ™ใ‚‹่ฆชใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆใงใ€ๅบƒๅ‘ŠใฎๆœŸ้–“ใ€ไบˆ็ฎ—ใ€็›ฎ็š„ใ€ใƒใƒฃใƒใƒซใชใฉใ‚’ๆ‹…ๅฝ“ใ—ใพใ™ใ€‚ใ‚ญใƒฃใƒณใƒšใƒผใƒณๅใ‚’ๆŒ‡ๅฎšใ—ใชใ„ใจใ€ใƒฉใƒณใƒ€ใƒ ใชๅๅ‰ใŒๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚Œใพใ™ใ€‚ใ“ใฎๅ ดๅˆใ€่ญ˜ๅˆฅใŒๅ›ฐ้›ฃใซใชใ‚‹ๅฏ่ƒฝๆ€งใŒใ‚ใ‚Šใพใ™ใ€‚ใ—ใŸใŒใฃใฆใ€ๅ„ใ‚ญใƒฃใƒณใƒšใƒผใƒณใซใฏ็›ฎ็š„ใซๅฟœใ˜ใฆ็•ฐใชใ‚‹ๅๅ‰ใ‚’ไป˜ใ‘ใฆๅŒบๅˆฅใงใใ‚‹ใ‚ˆใ†ใซใ™ใ‚‹ใ“ใจใ‚’ใŠๅ‹งใ‚ใ—ใพใ™ใ€‚ใ‚ญใƒฃใƒณใƒšใƒผใƒณใฎๅๅ‰ใฏใ€ใƒฆใƒผใ‚ถใƒผใŒ็ฐกๅ˜ใซ่ญ˜ๅˆฅใงใใ‚‹ใ‚ˆใ†ใซใ™ใ‚‹ใŸใ‚ใฎใ‚‚ใฎใงใ‚ใ‚Šใ€ๅบƒๅ‘ŠใฎๅŠนๆžœใซใฏใพใฃใŸใๅฝฑ้Ÿฟใ—ใพใ›ใ‚“ใฎใงใ€ๅฎ‰ๅฟƒใ—ใฆใใ ใ•ใ„ใ€‚`customerId` ใ‚’ๆธกใ•ใชใ„ๅ ดๅˆใฏใ€ใƒฆใƒผใ‚ถใƒผใ‹ใ‚‰ `Wrtn` ใซใ‚ขใ‚ฏใ‚ปใ‚นใงใใ‚‹ๅบƒๅ‘Šใ‚ขใ‚ซใ‚ฆใƒณใƒˆใŒ 1 ใคใ—ใ‹ใชใ„ๅ ดๅˆใซใฎใฟ่‡ชๅ‹•็š„ใซ้ธๆŠžใ•ใ‚Œใพใ™ใ€‚้–ขๆ•ฐใ‚’ๅ‘ผใณๅ‡บใ™ๅ‰ใซใƒฆใƒผใ‚ถใƒผใซ `customerId` ใ‚’ๅฐ‹ใญใ‚‹ๅฟ…่ฆใŒใ‚ใ‚‹ใŸใ‚ใ€`customerId` ใ‚’็ขบ่ชใงใใ‚‹ใ‚ณใƒใ‚ฏใ‚ฟใ‚’ๆๆกˆใ™ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚ๅฝ“ๅˆใฏ้‡‘้กๅˆถ้™ใฏใชใ‹ใฃใŸใŒใ€็ทŠๆ€ฅไบ‹ๆ…‹ใซๅ‚™ใˆใฆ็พๅœจใฏใ‚ญใƒฃใƒณใƒšใƒผใƒณใ”ใจใซ10ไธ‡ใ‚ฆใ‚ฉใƒณใซๅˆถ้™ใ•ใ‚Œใฆใ„ใ‚‹ใ€‚.", "tags": [ "Google Ads" ], @@ -8514,7 +8514,7 @@ "/connector/jira/get-issue-statuses": { "post": { "summary": "ๅ•้กŒใฎใ‚นใƒ†ใƒผใ‚ฟใ‚นใ‚’็ขบ่ชใ™ใ‚‹", - "description": "ๅ•้กŒใฎๆคœ็ดขใซ้–ขใ™ใ‚‹ๅ•้กŒใฎใ‚นใƒ†ใƒผใ‚ฟใ‚นใ‚’่ฆ‹ใคใ‘ใ‚‹", + "description": "ๅ•้กŒใ‚’ๆคœ็ดขใ™ใ‚‹ใŸใ‚ใฎๅ•้กŒใ‚นใƒ†ใƒผใ‚ฟใ‚นใ‚’่ฆ‹ใคใ‘ใ‚‹", "tags": [ "Jira" ], @@ -9213,7 +9213,7 @@ "/connector/github/repos/get-contents/bulk": { "post": { "summary": "ใƒชใƒใ‚ธใƒˆใƒชใƒ•ใ‚กใ‚คใƒซใฎๆคœ็ดข(ไธ€ๆ‹ฌ)", - "description": "ใƒชใƒใ‚ธใƒˆใƒชใฎใƒ•ใ‚กใ‚คใƒซใ‚’ๆคœ็ดขใ™ใ‚‹(ไธ€ๆ‹ฌ) ็…งไผšใ—ใŸใ„ใƒ•ใ‚กใ‚คใƒซใŒใƒ•ใ‚ฉใƒซใƒ€ใฎๅ ดๅˆใฏใ€ๅ†…้ƒจใฎใƒ•ใ‚กใ‚คใƒซใ‚’้…ๅˆ—ใงๆไพ›ใ—ใ€ใƒ•ใ‚กใ‚คใƒซใฎๅ ดๅˆใฏใ€ใƒ•ใ‚กใ‚คใƒซใฎใ‚จใƒณใ‚ณใƒผใƒ‰ๆ–นๅผใจใƒ•ใ‚กใ‚คใƒซๆœฌไฝ“ใฎๅ†…ๅฎนใ‚’ๅ•ใ„ๅˆใ‚ใ›ใพใ™ใ€‚ githubใƒชใƒใ‚ธใƒˆใƒชใซใฏ็„กๆ•ฐใฎใƒ•ใ‚กใ‚คใƒซใ‚„ใƒ•ใ‚ฉใƒซใƒ€ใŒๅญ˜ๅœจใ™ใ‚‹ๅฏ่ƒฝๆ€งใŒใ‚ใ‚‹ใŸใ‚ใ€ใƒฌใƒผใƒˆๅˆถ้™ใ‚’่ถ…ใˆใ‚‹ใƒ•ใ‚กใ‚คใƒซใŒๅคšใๅญ˜ๅœจใ™ใ‚‹ๅฏ่ƒฝๆ€งใŒใ‚ใ‚Šใพใ™ใ€‚ ใ“ใฎๅ ดๅˆใฏใ€ๅฏพๅฟœใ™ใ‚‹ใ‚ณใƒใ‚ฏใ‚ฟใ‚’ไฝฟ็”จใ—ใฆใƒ•ใ‚ฉใƒซใƒ€ใ‚’1ใคใšใค้ †็•ชใซ่ฆ‹ใคใ‘ใ‚‹ใ“ใจใงใ€ใ“ใฎๅ•้กŒใ‚’่งฃๆฑบใ—ใฆใฟใฆใใ ใ•ใ„ใ€‚ ่ค‡ๆ•ฐใฎใƒ•ใ‚กใ‚คใƒซใƒ‘ใ‚นใ‚’ๆธกใ™ใจใ€่ค‡ๆ•ฐใฎใƒ•ใ‚กใ‚คใƒซใ‚’ๅŒๆ™‚ใซ่กจ็คบใงใใพใ™ใ€‚ ใƒ•ใ‚กใ‚คใƒซๆ•ฐใซๅˆถ้™ใฏใ‚ใ‚Šใพใ›ใ‚“ใ€‚ ็‰นๅฎšใฎใƒ–ใƒฉใƒณใƒไธŠใฎใƒ•ใ‚กใ‚คใƒซใ‚’่กจ็คบใ™ใ‚‹ใฎใซ้ฉใ—ใฆใ„ใพใ™ใŒใ€ใ‚ณใƒผใƒ‰ใƒฌใƒ“ใƒฅใƒผใ‚„PRใฎ่ฉณ็ดฐใ‚’่กจ็คบใ™ใ‚‹็›ฎ็š„ใฎๅ ดๅˆใฏใ€ๅˆฅใฎใ‚ณใƒใ‚ฏใ‚ฟใ‚’ไฝฟ็”จใ™ใ‚‹ใ“ใจใ‚’ใŠๅ‹งใ‚ใ—ใพใ™ใ€‚ PRใงๅค‰ๆ›ดใ•ใ‚ŒใŸใƒ•ใ‚กใ‚คใƒซใฎไธ€่ฆงใ‚’่กจ็คบใ—ใŸใ‚Šใ€ๅค‰ๆ›ดๅ†…ๅฎนใ‚’็ขบ่ชใ—ใŸใ‚Šใ™ใ‚‹ใ‚ณใƒใ‚ฏใ‚ฟใŒใ‚ใ‚Šใพใ™ใ€‚.", + "description": "ใƒชใƒใ‚ธใƒˆใƒชใฎใƒ•ใ‚กใ‚คใƒซใ‚’ๆคœ็ดขใ™ใ‚‹(ไธ€ๆ‹ฌ) ็…งไผšใ—ใŸใ„ใƒ•ใ‚กใ‚คใƒซใŒใƒ•ใ‚ฉใƒซใƒ€ใฎๅ ดๅˆใฏใ€ๅ†…้ƒจใฎใƒ•ใ‚กใ‚คใƒซใ‚’้…ๅˆ—ใงๆไพ›ใ—ใ€ใƒ•ใ‚กใ‚คใƒซใฎๅ ดๅˆใฏใ€ใƒ•ใ‚กใ‚คใƒซใฎใ‚จใƒณใ‚ณใƒผใƒ‰ๆ–นๅผใจใƒ•ใ‚กใ‚คใƒซๆœฌไฝ“ใฎๅ†…ๅฎนใ‚’ๅ•ใ„ๅˆใ‚ใ›ใพใ™ใ€‚githubใƒชใƒใ‚ธใƒˆใƒชใซใฏ็„กๆ•ฐใฎใƒ•ใ‚กใ‚คใƒซใ‚„ใƒ•ใ‚ฉใƒซใƒ€ใŒๅญ˜ๅœจใ™ใ‚‹ๅฏ่ƒฝๆ€งใŒใ‚ใ‚‹ใŸใ‚ใ€ใƒฌใƒผใƒˆๅˆถ้™ใ‚’่ถ…ใˆใ‚‹ใƒ•ใ‚กใ‚คใƒซใŒๅคšใๅญ˜ๅœจใ™ใ‚‹ๅฏ่ƒฝๆ€งใŒใ‚ใ‚Šใพใ™ใ€‚ใ“ใฎๅ ดๅˆใ€ๅฏพๅฟœใ™ใ‚‹ใ‚ณใƒใ‚ฏใ‚ฟใ‚’ไฝฟ็”จใ—ใฆใƒ•ใ‚ฉใƒซใƒ€ใ‚’1ใคใšใค้ †็•ชใซ่ฆ‹ใคใ‘ใ‚‹ใ“ใจใงใ€ใ“ใฎๅ•้กŒใ‚’่งฃๆฑบใ—ใฆใฟใฆใใ ใ•ใ„ใ€‚่ค‡ๆ•ฐใฎใƒ•ใ‚กใ‚คใƒซใƒ‘ใ‚นใ‚’ๆธกใ—ใฆใ€่ค‡ๆ•ฐใฎใƒ•ใ‚กใ‚คใƒซใ‚’ๅŒๆ™‚ใซ่กจ็คบใงใใพใ™ใ€‚ใƒ•ใ‚กใ‚คใƒซๆ•ฐใซๅˆถ้™ใฏใ‚ใ‚Šใพใ›ใ‚“ใ€‚็‰นๅฎšใฎใƒ–ใƒฉใƒณใƒไธŠใฎใƒ•ใ‚กใ‚คใƒซใ‚’่กจ็คบใ™ใ‚‹ใฎใซ้ฉใ—ใฆใ„ใพใ™ใŒใ€ใ‚ณใƒผใƒ‰ใƒฌใƒ“ใƒฅใƒผใ‚„PRใฎ่ฉณ็ดฐใ‚’่กจ็คบใ™ใ‚‹็›ฎ็š„ใฎๅ ดๅˆใฏใ€ๅˆฅใฎใ‚ณใƒใ‚ฏใ‚ฟใ‚’ไฝฟ็”จใ™ใ‚‹ใ“ใจใ‚’ใŠๅ‹งใ‚ใ—ใพใ™ใ€‚PRใงๅค‰ๆ›ดใ•ใ‚ŒใŸใƒ•ใ‚กใ‚คใƒซใฎไธ€่ฆงใ‚’่กจ็คบใ—ใŸใ‚Šใ€ๅค‰ๆ›ดๅ†…ๅฎนใ‚’็ขบ่ชใ—ใŸใ‚Šใ™ใ‚‹ใ‚ณใƒใ‚ฏใ‚ฟใŒใ‚ใ‚Šใพใ™ใ€‚.", "tags": [ "Github" ], @@ -10443,7 +10443,7 @@ }, "responses": { "201": { - "description": "ๆŒ‡ๅฎšใ•ใ‚ŒใŸใ‚ณใƒŸใƒƒใƒˆใ‚’ๅซใ‚€ใƒ–ใƒฉใƒณใƒๅใฎ้…ๅˆ—ใ‚’่งฃๆฑบใ™ใ‚‹ใƒ—ใƒญใƒŸใ‚น.", + "description": "ๆŒ‡ๅฎšใ•ใ‚ŒใŸใ‚ณใƒŸใƒƒใƒˆใ‚’ๅซใ‚€ใƒ–ใƒฉใƒณใƒๅใฎ้…ๅˆ—ใซ่งฃๆฑบใ•ใ‚Œใ‚‹ใƒ—ใƒญใƒŸใ‚น.", "content": { "application/json": { "schema": { @@ -14569,7 +14569,7 @@ "hour" ], "title": "ใ‚คใƒ™ใƒณใƒˆใ‚’ๅ–ๅพ—ใ™ใ‚‹ๆœ€็ต‚ๆ—ฅไป˜ใซ้–ขใ™ใ‚‹ๆƒ…ๅ ฑ", - "description": "ใใฎๆ—ฅไป˜ไปฅ้™ใฎใ‚คใƒ™ใƒณใƒˆใฏๅ–ๅพ—ใ•ใ‚Œใพใ›ใ‚“ใ€‚ๆ—ฅไป˜ใจๆ™‚ๅˆปใฏใ™ในใฆUTCใชใฎใงใ€ไฝฟ็”จใ™ใ‚‹ๅ‰ใซๆ—ฅไป˜ใจๆ™‚ๅˆปใ‚’UTCใซๅค‰ๆ›ใ—ใฆใใ ใ•ใ„ใ€‚." + "description": "ใใฎๆ—ฅไป˜ไปฅ้™ใฎใ‚คใƒ™ใƒณใƒˆใฏๅ–ๅพ—ใ•ใ‚Œใพใ›ใ‚“ใ€‚ๆ—ฅไป˜ใจๆ™‚ๅˆปใฏใ™ในใฆ UTC ใง่กจ็คบใ•ใ‚Œใ‚‹ใŸใ‚ใ€ไฝฟ็”จใ™ใ‚‹ๅ‰ใซๆ—ฅไป˜ใจๆ™‚ๅˆปใ‚’ UTC ใซๅค‰ๆ›ใ—ใฆใŠใๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚." }, "time_min": { "type": "object", @@ -14718,7 +14718,7 @@ "hour" ], "title": "ใ‚คใƒ™ใƒณใƒˆ้–‹ๅง‹ๆ—ฅ", - "description": "ไฝœๆˆใ™ใ‚‹ใ‚คใƒ™ใƒณใƒˆใฎ้–‹ๅง‹ๆ—ฅใ€‚ๆ—ฅไป˜/ๆ™‚ๅˆปใฏใ™ในใฆ UTC ใชใฎใงใ€ไฝฟ็”จใ™ใ‚‹ๅ‰ใซๆ—ฅไป˜/ๆ™‚ๅˆปใ‚’ UTC ใซๅค‰ๆ›ใ—ใฆใŠใๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚." + "description": "ไฝœๆˆใ™ใ‚‹ใ‚คใƒ™ใƒณใƒˆใฎ้–‹ๅง‹ๆ—ฅใ€‚ๆ—ฅไป˜/ๆ™‚ๅˆปใฏใ™ในใฆ UTC ใง่กจใ•ใ‚Œใพใ™ใฎใงใ€ไฝฟ็”จใ™ใ‚‹ๅ‰ใซๆ—ฅไป˜/ๆ™‚ๅˆปใ‚’ UTC ใซๅค‰ๆ›ใ—ใฆใใ ใ•ใ„ใ€‚." }, "end": { "type": "object", @@ -15431,7 +15431,7 @@ }, "copyRequiresWriterPermission": { "type": "boolean", - "title": "ใ‚ณใƒ”ใƒผใซใฏWriterPermissionใŒๅฟ…่ฆ" + "title": "ใ‚ณใƒ”ใƒผใซใฏๆ›ธใ่พผใฟๆจฉ้™ใŒๅฟ…่ฆ" }, "spaces": { "type": "array", @@ -16063,7 +16063,7 @@ "type": "string" }, "title": "ใƒ•ใ‚ฃใƒซใ‚ฟใƒชใƒณใ‚ฐใ™ใ‚‹ใƒฉใƒ™ใƒซใฎใƒชใ‚นใƒˆ", - "description": "ๆŒ‡ๅฎšใ•ใ‚ŒใŸใƒฉใƒ™ใƒซ ID ใซใ™ในใฆไธ€่‡ดใ™ใ‚‹ใƒฉใƒ™ใƒซใ‚’ๆŒใคใƒกใƒผใƒซใฎใฟใ‚’่ฟ”ใ™ใƒฉใƒ™ใƒซใฎใƒชใ‚นใƒˆ." + "description": "ๆŒ‡ๅฎšใ•ใ‚ŒใŸใƒฉใƒ™ใƒซIDใซไธ€่‡ดใ™ใ‚‹ใƒฉใƒ™ใƒซใ‚’ๆŒใคใƒกใƒผใƒซใฎใฟใ‚’่ฟ”ใ™ใƒฉใƒ™ใƒซใฎใƒชใ‚นใƒˆ." }, "secretKey": { "type": "string", @@ -17476,7 +17476,7 @@ "type": "string", "format": "url", "title": "ไผš่ญฐใฎไธปๅ‚ฌ่€…ใจใ—ใฆๅ‚ๅŠ ใงใใ‚‹URL", - "description": "ใ“ใฎURLใฏใƒŸใƒผใƒ†ใ‚ฃใƒณใ‚ฐไธปๅ‚ฌ่€…ใฎใฟใŒไฝฟ็”จใ—ใ€ไป–ใฎๅ‚ๅŠ ่€…ใจๅ…ฑๆœ‰ใ—ใชใ„ใงใใ ใ•ใ„ใ€‚ใ“ใฎURLใ‚’็Ÿฅใฃใฆใ„ใ‚‹ไบบใฏ่ชฐใงใ‚‚ใ€ไธปๅ‚ฌ่€…ๆจฉ้™ใงZoomใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใซใƒญใ‚ฐใ‚คใƒณใงใใพใ™ใ€‚." + "description": "ใ“ใฎURLใฏใƒŸใƒผใƒ†ใ‚ฃใƒณใ‚ฐไธปๅ‚ฌ่€…ใฎใฟใŒไฝฟ็”จใ—ใ€ไป–ใฎๅ‚ๅŠ ่€…ใจๅ…ฑๆœ‰ใ—ใชใ„ใงใใ ใ•ใ„ใ€‚ใ“ใฎURLใ‚’็Ÿฅใฃใฆใ„ใ‚‹ไบบใฏ่ชฐใงใ‚‚ไธปๅ‚ฌ่€…ๆจฉ้™ใงZoomใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใซใƒญใ‚ฐใ‚คใƒณใงใใพใ™ใ€‚." }, "timezone": { "type": "string", @@ -18738,7 +18738,7 @@ "type": "string" } ], - "title": "้…้€ใ‚นใƒ†ใƒผใ‚ฟใ‚นใ‚ณใƒผใƒ‰" + "title": "้…้€็Šถๆณใ‚ณใƒผใƒ‰" }, "kind": { "oneOf": [ @@ -19653,7 +19653,7 @@ }, "minItems": 2, "maxItems": 3, - "title": "ใƒชใ‚นใƒˆใซ่กจ็คบใ•ใ‚Œใ‚‹ใ‚ณใƒณใƒ†ใƒณใƒ„ใฎใƒชใ‚นใƒˆ" + "title": "ใƒชใ‚นใƒˆใซ่กจ็คบใ•ใ‚Œใ‚‹ใ‚ณใƒณใƒ†ใƒณใƒ„ใฎไธ€่ฆง" }, "buttons": { "type": "array", @@ -21147,7 +21147,7 @@ }, "road_address_name": { "type": "string", - "title": "ๅฎŒๅ…จใช้“่ทฏๅไฝๆ‰€" + "title": "้“่ทฏๅไฝๆ‰€" }, "x": { "type": "string", @@ -23199,7 +23199,7 @@ }, "is_culture_benefit": { "type": "boolean", - "title": "ๆ–‡ๅŒ–ใƒ‘ใƒ•ใ‚ฉใƒผใƒžใƒณใ‚นๆ‰€ๅพ—ๆŽง้™ค" + "title": "ๆ–‡ๅŒ–ๅ…ฌๆผ”ๆ‰€ๅพ—ๆŽง้™ค" }, "order_made": { "type": "boolean", @@ -23232,7 +23232,7 @@ }, "member_maximum_purchase_quantity": { "type": "integer", - "title": "ไผšๅ“กใ”ใจใฎ่ณผๅ…ฅๆœ€ๅคงๆ•ฐ้‡" + "title": "ไผšๅ“กใ”ใจใฎ่ณผๅ…ฅๅฏ่ƒฝๆ•ฐ้‡" }, "optional_limit_type": { "oneOf": [ @@ -23319,7 +23319,7 @@ }, "secret": { "type": "string", - "title": "APIใ‚ทใƒผใ‚ฏใƒฌใƒƒใƒˆใ‚ญใƒผใ“ใ‚Œใฏใ€Imwebใฎ่จญๅฎšใง็ขบ่ชใงใใพใ™ใ€‚." + "title": "APIใ‚ทใƒผใ‚ฏใƒฌใƒƒใƒˆใ‚ญใƒผใฏใ€`Imweb`ใฎ่จญๅฎšใง็ขบ่ชใงใใพใ™ใ€‚." } }, "required": [ @@ -23365,7 +23365,7 @@ }, "secret": { "type": "string", - "title": "APIใ‚ทใƒผใ‚ฏใƒฌใƒƒใƒˆใ‚ญใƒผใ“ใ‚Œใฏใ€Imwebใฎ่จญๅฎšใง็ขบ่ชใงใใพใ™ใ€‚." + "title": "APIใ‚ทใƒผใ‚ฏใƒฌใƒƒใƒˆใ‚ญใƒผใฏใ€`Imweb`ใฎ่จญๅฎšใง็ขบ่ชใงใใพใ™ใ€‚." } }, "required": [ @@ -24304,7 +24304,7 @@ }, "enforceSe": { "type": "string", - "title": "ๅญ—ๅน•ๆ–ฝ่กŒๅˆ†้กž" + "title": "ๅญ—ๅน•ๆ–ฝ่กŒๅŒบๅˆ†" }, "operDay": { "type": "string", @@ -25665,7 +25665,7 @@ "ny": { "type": "number", "maximum": 180, - "title": "็ทฏๅบฆใพใŸใฏyไฝ็ฝฎ", + "title": "็ทฏๅบฆใพใŸใฏy_ไฝ็ฝฎ", "description": "ใ“ใฎใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆใฎ type ใƒ—ใƒญใƒ‘ใƒ†ใ‚ฃใŒ 'latitude_and_longitude' ใฎๅ ดๅˆใ€ใ“ใฎๅ€คใฏ็ทฏๅบฆใ‚’ๆ„ๅ‘ณใ—ใพใ™ใ€‚ใใ†ใงใชใ„ๅ ดๅˆใฏใ€้Ÿ“ๅ›ฝใฎใ‚ฐใƒชใƒƒใƒ‰ๅบงๆจ™ใฎ y ไฝ็ฝฎใฎๅ€คใ‚’ไฝฟ็”จใ—ใพใ™ใ€‚." } }, @@ -28870,8 +28870,8 @@ "display", "items" ], - "title": "ใƒใ‚คใƒใƒผใ‚ซใƒ•ใ‚งๆคœ็ดข็ตๆžœใƒ‡ใƒผใ‚ฟ", - "description": "ใƒใ‚คใƒใƒผใ‚ซใƒ•ใ‚งๆคœ็ดข็ตๆžœใƒ‡ใƒผใ‚ฟ." + "title": "Naver Cafeๆคœ็ดข็ตๆžœใƒ‡ใƒผใ‚ฟ", + "description": "Naver Cafeๆคœ็ดข็ตๆžœใƒ‡ใƒผใ‚ฟ." } }, "required": [ @@ -29018,7 +29018,7 @@ "title": { "type": "string", "title": "ๆŠ•็จฟใ‚ฟใ‚คใƒˆใƒซ", - "description": "Naverใƒ–ใƒญใ‚ฐ่จ˜ไบ‹ใฎใ‚ฟใ‚คใƒˆใƒซ." + "description": "Naverใƒ–ใƒญใ‚ฐๆŠ•็จฟใฎใ‚ฟใ‚คใƒˆใƒซ." }, "link": { "type": "string", @@ -31528,7 +31528,7 @@ "jmesPath": "[].{value:pageId, label:title}" }, "title": "id", - "description": "ใƒšใƒผใ‚ธ ๆจฉ้™ id ใƒ–ใƒญใƒƒใ‚ฏใ‚’่ฟฝๅŠ ใ™ใ‚‹ใƒšใƒผใ‚ธใ‚’็คบใ—ใพใ™ใ€‚ใ“ใฎใƒšใƒผใ‚ธใฎไธ‹้ƒจใซใ€ใ“ใ“ใง่ฆๆฑ‚ใ•ใ‚ŒใŸใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆใซไธ€่‡ดใ™ใ‚‹ใƒ–ใƒญใƒƒใ‚ฏใŒ่ฟฝๅŠ ใ•ใ‚Œใพใ™ใ€‚." + "description": "ใƒšใƒผใ‚ธ ๆจฉ้™ id ใƒ–ใƒญใƒƒใ‚ฏใ‚’่ฟฝๅŠ ใ™ใ‚‹ใƒšใƒผใ‚ธใ‚’็คบใ—ใพใ™ใ€‚ใ“ใฎใƒšใƒผใ‚ธใฎไธ‹้ƒจใซใ€่ฆๆฑ‚ใ•ใ‚ŒใŸใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆใซไธ€่‡ดใ™ใ‚‹ใƒ–ใƒญใƒƒใ‚ฏใŒ่ฟฝๅŠ ใ•ใ‚Œใพใ™ใ€‚." }, "title": { "type": "string", @@ -33849,7 +33849,7 @@ }, { "const": "23", - "title": "ใ‚คใƒณใ‚ฟใƒผใƒใƒƒใƒˆใƒ“ใ‚บใƒใ‚นใƒ›ใƒ†ใƒซ" + "title": "ใ‚คใƒณใ‚ฟใƒผใƒใƒƒใƒˆ ใƒ“ใ‚ธใƒใ‚น ใƒ›ใƒ†ใƒซ" }, { "const": "24", @@ -33878,7 +33878,7 @@ }, { "const": "4", - "title": "4ๆœˆ" + "title": "4ๆ™‚้–“ๅ‰" }, { "const": "5", @@ -34266,7 +34266,7 @@ "type": "string", "format": "date", "title": "ๅ‡บ็™บๆ—ฅ", - "description": "ๅ‡บ็™บๆ—ฅใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚ไปŠๆ—ฅใฎๆ—ฅไป˜ใ‚ˆใ‚ŠๅพŒใฎๆ—ฅไป˜ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„." + "description": "ๅ‡บ็™บๆ—ฅใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚ๆœฌๆ—ฅไปฅ้™ใฎๆ—ฅไป˜ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„." }, "return_date": { "type": "string", @@ -35135,7 +35135,7 @@ } ], "title": "ใƒ—ใƒญใƒ•ใ‚ฃใƒผใƒซ็”ปๅƒ", - "description": "ใƒ—ใƒญใƒ•ใ‚ฃใƒผใƒซ็”ปๅƒใฏ็”ป่ณชใ”ใจใซ่ค‡ๆ•ฐใ‚ใ‚Šใพใ™ใŒใ€ใ“ใ“ใงใฏใƒฆใƒผใ‚ถใƒผใŒๆœ€ๅˆใซใ‚ขใƒƒใƒ—ใƒญใƒผใƒ‰ใ—ใŸ็”ปๅƒใซๅŸบใฅใ„ใฆๆไพ›ใ—ใพใ™ใ€‚." + "description": "ใƒ—ใƒญใƒ•ใ‚ฃใƒผใƒซ็”ปๅƒใฏ็”ป่ณชใ”ใจใซ่ค‡ๆ•ฐใ‚ใ‚Šใพใ™ใŒใ€ใ“ใ“ใงใฏใƒฆใƒผใ‚ถใƒผใŒๆœ€ๅˆใซใ‚ขใƒƒใƒ—ใƒญใƒผใƒ‰ใ—ใŸ็”ปๅƒใซๅŸบใฅใ„ใฆๆไพ›ใ—ใพใ™." }, "display_name": { "oneOf": [ @@ -35332,7 +35332,7 @@ }, "ts_date": { "type": "string", - "title": "`ts`ใฎๆ—ฅไป˜ๅฝขๅผใ“ใ‚Œใฏใ€'ts'ใงๅŒบๅˆ‡ใ‚‹ใ“ใจใง็พๅœจใฎๆ™‚ๅˆปๅ€คใ‚’่ช่ญ˜ใ—ใ‚„ใ™ใใ™ใ‚‹ใŸใ‚ใซISOๆ–‡ๅญ—ๅˆ—ใซๅค‰ๆ›ดใ•ใ‚ŒใŸๅ€คใงใ™ใ€‚." + "title": "`ts`ใฎๆ—ฅไป˜ๅฝขๅผใ“ใ‚Œใฏใ€็พๅœจใฎๆ™‚ๅˆปๅ€คใ‚’ 'ts' ใงๅŒบๅˆ‡ใฃใฆ่ช่ญ˜ใ—ใ‚„ใ™ใใ™ใ‚‹ใŸใ‚ใซ ISO ๆ–‡ๅญ—ๅˆ—ใซๅค‰ๆ›ดใ•ใ‚ŒใŸๅ€คใงใ™ใ€‚." } }, "required": [ @@ -35552,7 +35552,7 @@ }, "ts_date": { "type": "string", - "title": "`ts`ใฎๆ—ฅไป˜ๅฝขๅผใ“ใ‚Œใฏใ€'ts'ใงๅŒบๅˆ‡ใ‚‹ใ“ใจใง็พๅœจใฎๆ™‚ๅˆปๅ€คใ‚’่ช่ญ˜ใ—ใ‚„ใ™ใใ™ใ‚‹ใŸใ‚ใซISOๆ–‡ๅญ—ๅˆ—ใซๅค‰ๆ›ดใ•ใ‚ŒใŸๅ€คใงใ™ใ€‚." + "title": "`ts`ใฎๆ—ฅไป˜ๅฝขๅผใ“ใ‚Œใฏใ€็พๅœจใฎๆ™‚ๅˆปๅ€คใ‚’ 'ts' ใงๅŒบๅˆ‡ใฃใฆ่ช่ญ˜ใ—ใ‚„ใ™ใใ™ใ‚‹ใŸใ‚ใซ ISO ๆ–‡ๅญ—ๅˆ—ใซๅค‰ๆ›ดใ•ใ‚ŒใŸๅ€คใงใ™ใ€‚." }, "links": { "type": "array", @@ -35744,7 +35744,7 @@ }, "ts_date": { "type": "string", - "title": "`ts`ใฎๆ—ฅไป˜ๅฝขๅผใ“ใ‚Œใฏใ€'ts'ใงๅŒบๅˆ‡ใ‚‹ใ“ใจใง็พๅœจใฎๆ™‚ๅˆปๅ€คใ‚’่ช่ญ˜ใ—ใ‚„ใ™ใใ™ใ‚‹ใŸใ‚ใซISOๆ–‡ๅญ—ๅˆ—ใซๅค‰ๆ›ดใ•ใ‚ŒใŸๅ€คใงใ™ใ€‚." + "title": "`ts`ใฎๆ—ฅไป˜ๅฝขๅผใ“ใ‚Œใฏใ€็พๅœจใฎๆ™‚ๅˆปๅ€คใ‚’ 'ts' ใงๅŒบๅˆ‡ใฃใฆ่ช่ญ˜ใ—ใ‚„ใ™ใใ™ใ‚‹ใŸใ‚ใซ ISO ๆ–‡ๅญ—ๅˆ—ใซๅค‰ๆ›ดใ•ใ‚ŒใŸๅ€คใงใ™ใ€‚." } }, "required": [ @@ -36313,7 +36313,7 @@ }, "isLast": { "type": "boolean", - "title": "ๅคฉๆฐ—ใฏๆœ€ๅพŒใฎใƒšใƒผใ‚ธใงใ™" + "title": "ใ‚ฆใ‚งใ‚ถใƒผใฏๆœ€ๅพŒใฎใƒšใƒผใ‚ธใงใ™" }, "total": { "type": "integer", @@ -39140,7 +39140,7 @@ }, "isLast": { "type": "boolean", - "title": "ๅคฉๆฐ—ใฏๆœ€ๅพŒใฎใƒšใƒผใ‚ธใงใ™" + "title": "ใ‚ฆใ‚งใ‚ถใƒผใฏๆœ€ๅพŒใฎใƒšใƒผใ‚ธใงใ™" }, "total": { "type": "integer", @@ -39378,7 +39378,7 @@ }, "isLast": { "type": "boolean", - "title": "ๅคฉๆฐ—ใฏๆœ€ๅพŒใฎใƒšใƒผใ‚ธใงใ™" + "title": "ใ‚ฆใ‚งใ‚ถใƒผใฏๆœ€ๅพŒใฎใƒšใƒผใ‚ธใงใ™" }, "total": { "type": "integer", @@ -39515,7 +39515,7 @@ }, "isLast": { "type": "boolean", - "title": "ๅคฉๆฐ—ใฏๆœ€ๅพŒใฎใƒšใƒผใ‚ธใงใ™" + "title": "ใ‚ฆใ‚งใ‚ถใƒผใฏๆœ€ๅพŒใฎใƒšใƒผใ‚ธใงใ™" }, "total": { "type": "integer", @@ -40360,7 +40360,7 @@ }, "comment": { "$ref": "#/components/schemas/IGithub.Comment", - "title": "ใ‚ณใƒกใƒณใƒˆ ใ‚ณใƒกใƒณใƒˆใฎใ‚คใƒ™ใƒณใƒˆใฎๅ ดๅˆใฏใ€ใ‚ณใƒกใƒณใƒˆๆƒ…ๅ ฑใ‚’ๅซใ‚ใพใ™." + "title": "ใ‚ณใƒกใƒณใƒˆ ใ‚ณใƒกใƒณใƒˆใฎใ‚คใƒ™ใƒณใƒˆใฎๅ ดๅˆใฏใ€ใ‚ณใƒกใƒณใƒˆๆƒ…ๅ ฑใ‚’ๅซใ‚ใ‚‹." } } }, @@ -40885,7 +40885,7 @@ }, "has_projects": { "type": "boolean", - "title": "ใƒ—ใƒญใ‚ธใ‚งใ‚ฏใƒˆใŒใ‚ใ‚‹" + "title": "ใƒ—ใƒญใ‚ธใ‚งใ‚ฏใƒˆใ‚ใ‚Š" }, "has_wiki": { "type": "boolean", @@ -40897,7 +40897,7 @@ }, "has_downloads": { "type": "boolean", - "title": "ใƒ€ใ‚ฆใƒณใƒญใƒผใƒ‰ใ‚ใ‚Š" + "title": "ใƒ€ใ‚ฆใƒณใƒญใƒผใƒ‰ๆ•ฐ" }, "archived": { "type": "boolean", @@ -41595,7 +41595,7 @@ }, "has_projects": { "type": "boolean", - "title": "ใƒ—ใƒญใ‚ธใ‚งใ‚ฏใƒˆใŒใ‚ใ‚‹" + "title": "ใƒ—ใƒญใ‚ธใ‚งใ‚ฏใƒˆใ‚ใ‚Š" }, "has_wiki": { "type": "boolean", @@ -41607,7 +41607,7 @@ }, "has_downloads": { "type": "boolean", - "title": "ใƒ€ใ‚ฆใƒณใƒญใƒผใƒ‰ใ‚ใ‚Š" + "title": "ใƒ€ใ‚ฆใƒณใƒญใƒผใƒ‰ๆ•ฐ" }, "archived": { "type": "boolean", @@ -45268,7 +45268,7 @@ "title": "่จฑๅฏ" } }, - "description": "T ๅ†…ใฎใ™ในใฆใฎใƒ—ใƒญใƒ‘ใƒ†ใ‚ฃใ‚’ใ‚ชใƒ—ใ‚ทใƒงใƒณใซใ™ใ‚‹" + "description": "T ใฎใ™ในใฆใฎใƒ—ใƒญใƒ‘ใƒ†ใ‚ฃใ‚’ใ‚ชใƒ—ใ‚ทใƒงใƒณใซใ™ใ‚‹" }, "IGithub.IFetchRepositoryPullRequestOutput": { "type": "object", @@ -46525,7 +46525,7 @@ }, "has_projects": { "type": "boolean", - "title": "ใƒ—ใƒญใ‚ธใ‚งใ‚ฏใƒˆใŒใ‚ใ‚‹" + "title": "ใƒ—ใƒญใ‚ธใ‚งใ‚ฏใƒˆใ‚ใ‚Š" }, "has_wiki": { "type": "boolean", @@ -46537,7 +46537,7 @@ }, "has_downloads": { "type": "boolean", - "title": "ใƒ€ใ‚ฆใƒณใƒญใƒผใƒ‰ใ‚ใ‚Š" + "title": "ใƒ€ใ‚ฆใƒณใƒญใƒผใƒ‰ๆ•ฐ" }, "archived": { "type": "boolean", @@ -49214,7 +49214,7 @@ }, { "const": 1, - "title": "DM ใƒใƒฃใƒณใƒใƒซ" + "title": "DM ใƒใƒฃใƒƒใƒˆ" } ], "title": "ใƒฆใƒ˜", @@ -49277,7 +49277,7 @@ "properties": { "name": { "type": "string", - "title": "ๆญฃใ—ใ„ใƒใƒงใƒผใ‚ฏใฎ็ตต", + "title": "ๆญฃใ—ใ„ใƒใƒงใƒณใ‚คใƒซ", "description": "์ˆ˜์ •ํ•  ์ฑ„๋„ ์ด๋ฆ„์„ ์ž…๋ ฅํ•ด์ฃผ์„ธ์š”." }, "channelId": { @@ -49427,7 +49427,7 @@ }, { "const": 1, - "title": "DM ใƒใƒฃใƒณใƒใƒซ" + "title": "DM ใƒใƒฃใƒƒใƒˆ" } ] }, @@ -49774,7 +49774,7 @@ "type": "boolean" } }, - "description": "T ๅ†…ใฎใ™ในใฆใฎใƒ—ใƒญใƒ‘ใƒ†ใ‚ฃใ‚’ใ‚ชใƒ—ใ‚ทใƒงใƒณใซใ™ใ‚‹" + "description": "T ใฎใ™ในใฆใฎใƒ—ใƒญใƒ‘ใƒ†ใ‚ฃใ‚’ใ‚ชใƒ—ใ‚ทใƒงใƒณใซใ™ใ‚‹" }, "IDiscord.IGetPinnedMessagesRequest": { "type": "object", @@ -51393,7 +51393,7 @@ "reschedule_url": { "type": "string", "format": "iri", - "title": "reschedule_url ๆ‹›ๅพ…่€…ใฎใ‚คใƒ™ใƒณใƒˆใ‚’ๅ†ใ‚นใ‚ฑใ‚ธใƒฅใƒผใƒซใ™ใ‚‹ใŸใ‚ใฎใƒชใƒณใ‚ฏ" + "title": "reschedule_url ๆ‹›ๅพ…่€…ใฎใ‚คใƒ™ใƒณใƒˆใฎใ‚นใ‚ฑใ‚ธใƒฅใƒผใƒซๅค‰ๆ›ดใธใฎใƒชใƒณใ‚ฏ" }, "routing_form_submission": { "oneOf": [ @@ -54377,7 +54377,7 @@ "Competitors": { "$ref": "#/components/schemas/ISimilarweb.Competitors", "title": "็ซถๅˆไป–็คพ", - "description": "็ซถๅˆไป–็คพใฎๆƒ…ๅ ฑ" + "description": "็ซถๅˆไป–็คพๆƒ…ๅ ฑ" }, "Notification": { "$ref": "#/components/schemas/ISimilarweb.Notification", @@ -54618,7 +54618,7 @@ "TopSimilarityCompetitors" ], "title": "็ซถๅˆไป–็คพ", - "description": "็ซถๅˆไป–็คพใฎๆƒ…ๅ ฑ" + "description": "็ซถๅˆไป–็คพๆƒ…ๅ ฑ" }, "ISimilarweb.Notification": { "type": "object", diff --git a/assets/output/connector.swagger.ko.json b/assets/output/connector.swagger.ko.json index 87542a5..9e8f452 100644 --- a/assets/output/connector.swagger.ko.json +++ b/assets/output/connector.swagger.ko.json @@ -600,7 +600,7 @@ }, "/connector/excel/rows/upload": { "post": { - "summary": "Excel์„ ์ƒ์„ฑํ•˜๊ณ  Excel ํŒŒ์ผ์„ ์—…๋กœ๋“œํ•˜์—ฌ ๋ฐ์ดํ„ฐ๋ฅผ ์ถ”๊ฐ€ํ•ฉ๋‹ˆ๋‹ค.", + "summary": "Excel์„ ๋งŒ๋“ค๊ณ  Excel ํŒŒ์ผ์„ ์—…๋กœ๋“œํ•˜์—ฌ ๋ฐ์ดํ„ฐ๋ฅผ ์ถ”๊ฐ€ํ•ฉ๋‹ˆ๋‹ค.", "description": "Excel ํŒŒ์ผ์„ ์—…๋กœ๋“œํ•˜์—ฌ ํŒŒ์ผ์— ๋ฐ์ดํ„ฐ ์ถ”๊ฐ€ Excel์— ๋ฐ์ดํ„ฐ๋ฅผ ์ถ”๊ฐ€ํ•  ๋•Œ ์•„์ง ์กด์žฌํ•˜์ง€ ์•Š๋Š” ์‹œํŠธ์ธ ๊ฒฝ์šฐ ์‹œํŠธ ์ƒ์„ฑ์ด ์šฐ์„ ํ•ฉ๋‹ˆ๋‹ค. ๋”ฐ๋ผ์„œ ์ด ๊ธฐ๋Šฅ์€ ์‹œํŠธ ์ƒ์„ฑ์—๋„ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์‹œํŠธ๋งŒ ๋งŒ๋“ค๊ณ  ๋ฐ์ดํ„ฐ๊ฐ€ ์—†๋Š” ๋นˆ ํŒŒ์ผ์„ ๋งŒ๋“ค๋ ค๋ฉด ๋ฐ์ดํ„ฐ๊ฐ€ ์—†๋Š” ์‹œํŠธ ์ด๋ฆ„๋งŒ ์ง€์ •ํ•˜๋ฉด ๋ฉ๋‹ˆ๋‹ค. ์ด๋ฏธ ์กด์žฌํ•˜๋Š” ์‹œํŠธ์— ํ–‰์„ ์ถ”๊ฐ€ํ•  ๋•Œ๋Š” ๊ฐ€์žฅ ์•„๋žซ์ค„์— ์ถ”๊ฐ€ํ•ด์•ผ ํ•˜๋ฏ€๋กœ ์ถ”๊ฐ€ํ•˜๊ธฐ ์ „์— ๋ฐ์ดํ„ฐ๋ฅผ ํ™•์ธํ•˜๋Š” ๊ฒƒ์ด ์ข‹์Šต๋‹ˆ๋‹ค. fileUrl์„ ์ œ๊ณตํ•˜๋ฉด ์ž‘์—… ํ›„ ์ˆ˜์ •ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์ˆ˜์ • ํ›„ ํŒŒ์ผ์ด ์ƒˆ๋กœ์šด ๋งํฌ๋กœ ๋ฐœ๊ธ‰๋ฉ๋‹ˆ๋‹ค. ์‚ฌ์šฉ์ž๊ฐ€ ๋“œ๋ž˜๊ทธ ์•ค ๋“œ๋กญ์œผ๋กœ ํŒŒ์ผ์„ ์—…๋กœ๋“œํ•  ์ˆ˜ ์žˆ๋„๋ก ํ•ด์ฃผ๋Š” ์ปค๋„ฅํ„ฐ์ž…๋‹ˆ๋‹ค..", "tags": [ "Excel" @@ -3958,7 +3958,7 @@ }, "/connector/open-data/getRTMSDataSvcOffiRent": { "post": { - "summary": "์˜คํ”ผ์Šคํ…” ์ž„๋Œ€ ๋ฐ ๋ ŒํŠธ ์ •๋ณด ๊ฒ€์ƒ‰", + "summary": "์˜คํ”ผ์Šคํ…” ์ž„๋Œ€ ๋ฐ ์ž„๋Œ€ ์ •๋ณด ๊ฒ€์ƒ‰", "description": "[๊ตญํ† ๊ตํ†ต๋ถ€] ์˜คํ”ผ์Šคํ…” ์ž„๋Œ€์ฐจ ์ •๋ณด ๊ฒ€์ƒ‰ ์ด ์ปค๋„ฅํŠธ๋Š” ๊ตญ๋‚ด ๊ณต๊ณต๋ฐ์ดํ„ฐ ํฌํ„ธ์—์„œ ์–ป์€ ๋ฐ์ดํ„ฐ๋ฅผ ๊ธฐ๋ฐ˜์œผ๋กœ ํ•ฉ๋‹ˆ๋‹ค. ์—ฌ๊ธฐ์„œ ํŠน์ • ๊ธฐ๊ด€์— ๋Œ€ํ•ด ์ด์•ผ๊ธฐํ•˜๋ฉด ๊ตญ๋‚ด ๊ธฐ๊ด€์ด๋ฉฐ, ๋ฐ์ดํ„ฐ๋‚˜ ํ†ต๊ณ„๊ฐ€ ๊ฐ€๋ฆฌํ‚ค๋Š” ์ •๋ณด๋‚˜ ์ถ”๋ก  ๊ฐ€๋Šฅํ•œ ์‚ฌ์‹ค๋„ ๊ตญ๋‚ด์— ๊ตญํ•œ๋  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๋จผ์ € ์‹œ, ๊ตฐ, ๊ตฌ ์ฝ”๋“œ๋ฅผ ๊ฒ€์ƒ‰ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. (POST /connector/open-data/getStandardRegionCodeList connector) ๊ตฌ ์ฝ”๋“œ๋ฅผ ๊ฒ€์ƒ‰ํ•˜๋Š” ์ปค๋„ฅํ„ฐ๊ฐ€ ์ด๋ฏธ ์žˆ์œผ๋ฏ€๋กœ ์•ž์˜ ์ปค๋„ฅํ„ฐ๋ฅผ ํ˜ธ์ถœํ•ฉ๋‹ˆ๋‹ค. ์ด๋Š” ๊ตญ๋‚ด ๊ณต๊ณต๋ฐ์ดํ„ฐ์ด๋ฏ€๋กœ ๋Œ€๋ถ€๋ถ„ ๊ฒ€์ƒ‰์€ ํ•œ๊ตญ์–ด๋กœ ํ•ด์•ผ ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์ด ์ ์— ์œ ์˜ํ•˜์„ธ์š”..", "tags": [ "Open Data" @@ -4174,7 +4174,7 @@ "/connector/open-data/getStockPriceInfo": { "post": { "summary": "์‹œ๊ฐ€์ด์•ก ๋ฐ ์ฃผ์‹ ์ •๋ณด ๊ฒ€์ƒ‰", - "description": "[๊ธˆ์œต์œ„์›ํšŒ] ์‹œ๊ฐ€์ด์•ก ๋ฐ ์ฃผ์‹์ •๋ณด ๊ฒ€์ƒ‰ ์ด ์ปค๋„ฅํŠธ๋Š” ๊ตญ๋‚ด ๊ณต๊ณต๋ฐ์ดํ„ฐ ํฌํ„ธ์—์„œ ์–ป์€ ๋ฐ์ดํ„ฐ๋ฅผ ๊ธฐ๋ฐ˜์œผ๋กœ ํ•ฉ๋‹ˆ๋‹ค. ์—ฌ๊ธฐ์„œ ํŠน์ • ๊ธฐ๊ด€์— ๋Œ€ํ•ด ์ด์•ผ๊ธฐํ•˜๋ฉด ๊ตญ๋‚ด ๊ธฐ๊ด€์ด๋ฉฐ, ๋ฐ์ดํ„ฐ๋‚˜ ํ†ต๊ณ„๊ฐ€ ๊ฐ€๋ฆฌํ‚ค๋Š” ์ •๋ณด๋‚˜ ์ถ”๋ก  ๊ฐ€๋Šฅํ•œ ์‚ฌ์‹ค๋„ ๊ตญ๋‚ด์— ๊ตญํ•œ๋  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์ด๋Š” ๊ตญ๋‚ด ๊ณต๊ณต๋ฐ์ดํ„ฐ์ด๋ฏ€๋กœ ๋Œ€๋ถ€๋ถ„ ๊ฒ€์ƒ‰์€ ํ•œ๊ตญ์–ด๋กœ ํ•ด์•ผ ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์˜ˆ๋ฅผ ๋“ค์–ด "์‚ผ์„ฑ์ „์ž". ๋˜ํ•œ ์ด๋Š” ์ฃผ์‹์‹œ์žฅ ๋งˆ๊ฐ์ผ์„ ๊ธฐ์ค€์œผ๋กœ ํ•˜๊ธฐ ๋•Œ๋ฌธ์— ์˜ค๋Š˜ ๋‚ ์งœ๋กœ๋ถ€ํ„ฐ ์•ฝ 2๊ฐœ์›” ์ „(9์ผ ์ „)๋ถ€ํ„ฐ ์–ด์ œ๊นŒ์ง€๋งŒ ์กฐํšŒํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค..", + "description": "[๊ธˆ์œต์œ„์›ํšŒ] ์‹œ๊ฐ€์ด์•ก ๋ฐ ์ฃผ์‹์ •๋ณด ๊ฒ€์ƒ‰ ์ด ์ปค๋„ฅํŠธ๋Š” ๊ตญ๋‚ด ๊ณต๊ณต๋ฐ์ดํ„ฐ ํฌํ„ธ์—์„œ ์–ป์€ ๋ฐ์ดํ„ฐ๋ฅผ ๊ธฐ๋ฐ˜์œผ๋กœ ํ•ฉ๋‹ˆ๋‹ค. ์—ฌ๊ธฐ์„œ ํŠน์ • ๊ธฐ๊ด€์— ๋Œ€ํ•ด ์ด์•ผ๊ธฐํ•˜๋ฉด ๊ตญ๋‚ด ๊ธฐ๊ด€์ด๋ฉฐ, ๋ฐ์ดํ„ฐ๋‚˜ ํ†ต๊ณ„๊ฐ€ ๊ฐ€๋ฆฌํ‚ค๋Š” ์ •๋ณด๋‚˜ ์ถ”๋ก  ๊ฐ€๋Šฅํ•œ ์‚ฌ์‹ค๋„ ๊ตญ๋‚ด๋กœ ์ œํ•œ๋  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์ด๋Š” ๊ตญ๋‚ด ๊ณต๊ณต๋ฐ์ดํ„ฐ์ด๋ฏ€๋กœ ๋Œ€๋ถ€๋ถ„ ๊ฒ€์ƒ‰์€ ํ•œ๊ตญ์–ด๋กœ ํ•ด์•ผ ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์˜ˆ๋ฅผ ๋“ค์–ด "์‚ผ์„ฑ์ „์ž". ๋˜ํ•œ ์ด๋Š” ์ฃผ์‹์‹œ์žฅ ๋งˆ๊ฐ์ผ์„ ๊ธฐ์ค€์œผ๋กœ ํ•˜๊ธฐ ๋•Œ๋ฌธ์— ์˜ค๋Š˜ ๋‚ ์งœ๋กœ๋ถ€ํ„ฐ ์•ฝ 2๊ฐœ์›” ์ „(9์ผ ์ „)๋ถ€ํ„ฐ ์–ด์ œ๊นŒ์ง€๋งŒ ์กฐํšŒํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค..", "tags": [ "Open Data" ], @@ -4261,7 +4261,7 @@ "/connector/open-data/getCopyRight": { "post": { "summary": "[์ €์ž‘๊ถŒ๋“ฑ๋ก์ •๋ณด์„œ๋น„์Šค(์‹ ๊ทœ)]", - "description": "[ํ•œ๊ตญ์ €์ž‘๊ถŒ์œ„์›ํšŒ] ์ €์ž‘๊ถŒ ์ •๋ณด ๊ฒ€์ƒ‰ ๋ณธ ์ปค๋„ฅํŠธ๋Š” ๊ตญ๋‚ด ๊ณต๊ณต๋ฐ์ดํ„ฐํฌํ„ธ์—์„œ ์–ป์€ ์ž๋ฃŒ๋ฅผ ๊ธฐ๋ฐ˜์œผ๋กœ ํ•ฉ๋‹ˆ๋‹ค. ์—ฌ๊ธฐ์„œ ํŠน์ • ๊ธฐ๊ด€์„ ์ด์•ผ๊ธฐํ•œ๋‹ค๋ฉด ๊ทธ๊ฒƒ์€ ํ•œ๊ตญ์˜ ๊ธฐ๊ด€์ด๊ณ , ๋ฐ์ดํ„ฐ๋‚˜ ํ†ต๊ณ„๊ฐ€ ๊ฐ€๋ฆฌํ‚ค๋Š” ์ •๋ณด๋‚˜ ์ถ”๋ก  ๊ฐ€๋Šฅํ•œ ์‚ฌ์‹ค๋„ ํ•œ๊ตญ์— ๊ตญํ•œ๋  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ํ•œ๊ตญ์˜ ๊ณต๊ฐœ ๋ฐ์ดํ„ฐ์ด๊ธฐ ๋•Œ๋ฌธ์— ๋Œ€๋ถ€๋ถ„์˜ ๊ฒ€์ƒ‰์€ ํ•œ๊ตญ์–ด๋กœ ์ด๋ฃจ์–ด์ ธ์•ผ ํ•  ์ˆ˜๋„ ์žˆ์Šต๋‹ˆ๋‹ค. ์ด ์ ์„ ์ฃผ์˜ํ•˜์‹œ๊ธฐ ๋ฐ”๋ž๋‹ˆ๋‹ค. - ์ œํ˜ธ(๋ช…์นญ) : ์ €์ž‘๋ฌผ์ด ๋ช…์นญ์„ ์˜๋ฏธํ•œ๋‹ค๋Š” ๊ฒƒ, ์‚ฌ์šฉ์ž๊ฐ€ ํ•  ์ˆ˜ ์žˆ๊ธฐ ๋•Œ๋ฌธ์— ์‰ฝ๊ฒŒ ๋งํ•˜๋Š” ๊ฒƒ์ด ์ข‹์Šต๋‹ˆ๋‹ค..", + "description": "[ํ•œ๊ตญ์ €์ž‘๊ถŒ์œ„์›ํšŒ] ์ €์ž‘๊ถŒ ์ •๋ณด ๊ฒ€์ƒ‰ ๋ณธ ์ปค๋„ฅํŠธ๋Š” ๊ตญ๋‚ด ๊ณต๊ณต๋ฐ์ดํ„ฐํฌํ„ธ์—์„œ ์–ป์€ ์ž๋ฃŒ๋ฅผ ๊ธฐ๋ฐ˜์œผ๋กœ ํ•ฉ๋‹ˆ๋‹ค. ์—ฌ๊ธฐ์„œ ํŠน์ • ๊ธฐ๊ด€์„ ์ด์•ผ๊ธฐํ•œ๋‹ค๋ฉด ๊ทธ๊ฒƒ์€ ํ•œ๊ตญ์˜ ๊ธฐ๊ด€์ด๊ณ , ๋ฐ์ดํ„ฐ๋‚˜ ํ†ต๊ณ„๊ฐ€ ๊ฐ€๋ฆฌํ‚ค๋Š” ์ •๋ณด๋‚˜ ์ถ”๋ก  ๊ฐ€๋Šฅํ•œ ์‚ฌ์‹ค๋„ ํ•œ๊ตญ์— ๊ตญํ•œ๋  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์ด๋Š” ํ•œ๊ตญ์˜ ๊ณต๊ฐœ ๋ฐ์ดํ„ฐ์ด๊ธฐ ๋•Œ๋ฌธ์— ๋Œ€๋ถ€๋ถ„์˜ ๊ฒ€์ƒ‰์€ ํ•œ๊ตญ์–ด๋กœ ์ด๋ฃจ์–ด์ ธ์•ผ ํ•  ์ˆ˜๋„ ์žˆ์Šต๋‹ˆ๋‹ค. ์ด ์ ์„ ์ฃผ์˜ํ•˜์‹œ๊ธฐ ๋ฐ”๋ž๋‹ˆ๋‹ค. - ์ œํ˜ธ(๋ช…์นญ) : ์ €์ž‘๋ฌผ์ด ๋ช…์นญ์„ ์˜๋ฏธํ•œ๋‹ค๋Š” ๊ฒƒ, ์‚ฌ์šฉ์ž๊ฐ€ ํ•  ์ˆ˜ ์žˆ๊ธฐ ๋•Œ๋ฌธ์— ์‰ฝ๊ฒŒ ๋งํ•˜๋Š” ๊ฒƒ์ด ์ข‹์Šต๋‹ˆ๋‹ค..", "tags": [ "Open Data" ], @@ -4461,7 +4461,7 @@ "type": "string" } ], - "title": "์„œ์šธ์™ธํ™˜์ค‘๊ฐœ๊ฑฐ๋ž˜๊ธฐ์ค€๊ธˆ๋ฆฌ" + "title": "์„œ์šธ์™ธํ™˜์ค‘๊ฐœ๊ฑฐ๋ž˜๊ธฐ์ค€ํ™˜์œจ" }, "cur_nm": { "oneOf": [ @@ -10623,7 +10623,7 @@ }, "/connector/github/get-labels": { "post": { - "summary": "์ €์žฅ์†Œ์— ๋Œ€ํ•œ ๋ผ๋ฒจ ๋ชฉ๋ก", + "summary": "์ €์žฅ์†Œ์˜ ๋ผ๋ฒจ ๋ชฉ๋ก", "description": "์ €์žฅ์†Œ์— ๋Œ€ํ•œ ๋ ˆ์ด๋ธ” ๋‚˜์—ด ํ•ด๋‹น ์ €์žฅ์†Œ์—์„œ ์ƒ์„ฑ๋˜๊ณ  ์‚ฌ์šฉ๋œ ์ด์Šˆ ๋ชฉ๋ก์„ ๋ด…๋‹ˆ๋‹ค. ๊ฐ ์ด์Šˆ์—๋Š” ์ด ์ €์žฅ์†Œ์— ์ด๋ฏธ ๋“ฑ๋ก๋œ ๋ ˆ์ด๋ธ”๋งŒ ์žˆ์Šต๋‹ˆ๋‹ค. ๋ฌผ๋ก  ์ด์Šˆ๋ฅผ ์ƒ์„ฑํ•  ๋•Œ ๋ฐ˜๋“œ์‹œ ์—ฌ๊ธฐ์˜ ๋ ˆ์ด๋ธ”๋งŒ ์‚ฌ์šฉํ•ด์•ผ ํ•œ๋‹ค๋Š” ๊ฒƒ์€ ์•„๋‹ˆ์ง€๋งŒ ์—ฌ๊ธฐ์˜ ๋ ˆ์ด๋ธ”์„ ์ฐธ์กฐํ•˜์—ฌ ํ• ๋‹นํ•˜๋Š” ๊ฒƒ์ด ์ข‹์Šต๋‹ˆ๋‹ค..", "tags": [ "Github" @@ -11782,7 +11782,7 @@ } }, "required": true, - "description": "์‚ญ์ œํ•  ์ž‘์—… ๊ณต๊ฐ„ ID" + "description": "์‚ญ์ œํ•  ์ž‘์—…๊ณต๊ฐ„ ID" } ], "requestBody": { @@ -13256,8 +13256,8 @@ "items": { "$ref": "#/components/schemas/IPermission" }, - "title": "์ ‘๊ทผ ๊ฐ€๋Šฅํ•˜๊ฒŒ ํ•  ์ด๋ฉ”์ผ ๋ชฉ๋ก๊ณผ ๋ถ€์—ฌํ•  ์ˆ˜ ์žˆ๋Š” ๊ถŒํ•œ์€ ๋‹ค์Œ๊ณผ ๊ฐ™์Šต๋‹ˆ๋‹ค.", - "description": "์ ‘๊ทผ ๊ฐ€๋Šฅํ•˜๊ฒŒ ํ•  ์ด๋ฉ”์ผ ๋ชฉ๋ก๊ณผ ๋ถ€์—ฌํ•  ์ˆ˜ ์žˆ๋Š” ๊ถŒํ•œ์€ ๋‹ค์Œ๊ณผ ๊ฐ™์Šต๋‹ˆ๋‹ค.." + "title": "๋‹ค์Œ์€ ์ ‘๊ทผ ๊ฐ€๋Šฅํ•˜๊ฒŒ ํ•  ์ด๋ฉ”์ผ ๋ชฉ๋ก๊ณผ ๋ถ€์—ฌํ•  ์ˆ˜ ์žˆ๋Š” ๊ถŒํ•œ์ž…๋‹ˆ๋‹ค.", + "description": "๋‹ค์Œ์€ ์ ‘๊ทผ ๊ฐ€๋Šฅํ•˜๊ฒŒ ํ•  ์ด๋ฉ”์ผ ๋ชฉ๋ก๊ณผ ๋ถ€์—ฌํ•  ์ˆ˜ ์žˆ๋Š” ๊ถŒํ•œ์ž…๋‹ˆ๋‹ค.." }, "secretKey": { "type": "string", @@ -13342,7 +13342,7 @@ "data": { "$ref": "#/components/schemas/IGoogleDocs", "title": "Google ๋ฌธ์„œ ๋ฐ์ดํ„ฐ", - "description": "๋‚ด๊ฐ€ ์ฝ์€ Google ๋ฌธ์„œ์˜ ๋ฐ์ดํ„ฐ์ž…๋‹ˆ๋‹ค.." + "description": "์ด๊ฑด ๋‚ด๊ฐ€ ์ฝ์€ Google ๋ฌธ์„œ์˜ ๋ฐ์ดํ„ฐ์ž…๋‹ˆ๋‹ค.." } }, "required": [ @@ -14650,8 +14650,8 @@ "properties": { "text": { "type": "string", - "title": "๋น ๋ฅธ ์ผ์ • ์ด๋ฒคํŠธ๋ฅผ ๋งŒ๋“œ๋Š” ํ…์ŠคํŠธ์ž…๋‹ˆ๋‹ค.", - "description": "๋น ๋ฅธ ์ผ์ • ์ด๋ฒคํŠธ๋ฅผ ๋งŒ๋“œ๋Š” ํ…์ŠคํŠธ์ž…๋‹ˆ๋‹ค.." + "title": "๋น ๋ฅธ ์บ˜๋ฆฐ๋” ์ด๋ฒคํŠธ๋ฅผ ๋งŒ๋“œ๋Š” ํ…์ŠคํŠธ์ž…๋‹ˆ๋‹ค.", + "description": "๋น ๋ฅธ ์บ˜๋ฆฐ๋” ์ด๋ฒคํŠธ๋ฅผ ๋งŒ๋“œ๋Š” ํ…์ŠคํŠธ์ž…๋‹ˆ๋‹ค.." }, "secretKey": { "type": "string", @@ -15503,7 +15503,7 @@ "lastViewedByMeDate": { "type": "string", "format": "date-time", - "title": "lastViewedByMe๋‚ ์งœ" + "title": "๋‚ด๊ฐ€ ๋งˆ์ง€๋ง‰์œผ๋กœ ๋ณธ ๋‚ ์งœ" }, "markedViewedByMeDate": { "type": "string", @@ -16663,7 +16663,7 @@ "depth": { "type": "integer", "title": "๋ฌธ์„œ ํŠธ๋ฆฌ๋ฅผ ์–ผ๋งˆ๋‚˜ ๊นŠ์ด ํƒ์ƒ‰ํ•ด์•ผ ํ•˜๋Š”์ง€ ๋‚˜ํƒ€๋‚ด๋Š” ์–‘์˜ ์ •์ˆ˜", - "description": "๋ฌธ์„œ ํŠธ๋ฆฌ๋ฅผ ์–ผ๋งˆ๋‚˜ ๊นŠ์ด ํƒ์ƒ‰ํ• ์ง€๋ฅผ ๋‚˜ํƒ€๋‚ด๋Š” ์–‘์˜ ์ •์ˆ˜์ž…๋‹ˆ๋‹ค. ์˜ˆ๋ฅผ ๋“ค์–ด, ์ด ๊ฐ’์„ 1๋กœ ์„ค์ •ํ•˜๋ฉด ํŽ˜์ด์ง€๋งŒ ๋ฐ˜ํ™˜๋˜๊ณ , 2๋กœ ์„ค์ •ํ•˜๋ฉด ํŽ˜์ด์ง€์™€ ๊ฐ ํŽ˜์ด์ง€์˜ ๋ชจ๋“  ์ตœ์ƒ์œ„ ๊ฐœ์ฒด๊ฐ€ ๋ฐ˜ํ™˜๋ฉ๋‹ˆ๋‹ค. ์ด ๋งค๊ฐœ๋ณ€์ˆ˜๋ฅผ ์„ค์ •ํ•˜์ง€ ์•Š์œผ๋ฉด ๋ชจ๋“  ๋…ธ๋“œ๊ฐ€ ๋ฐ˜ํ™˜๋ฉ๋‹ˆ๋‹ค.." + "description": "๋ฌธ์„œ ํŠธ๋ฆฌ๋ฅผ ์–ผ๋งˆ๋‚˜ ๊นŠ์ด ํƒ์ƒ‰ํ•  ๊ฒƒ์ธ์ง€๋ฅผ ๋‚˜ํƒ€๋‚ด๋Š” ์–‘์˜ ์ •์ˆ˜์ž…๋‹ˆ๋‹ค. ์˜ˆ๋ฅผ ๋“ค์–ด, ์ด ๊ฐ’์„ 1๋กœ ์„ค์ •ํ•˜๋ฉด ํŽ˜์ด์ง€๋งŒ ๋ฐ˜ํ™˜๋˜๊ณ , 2๋กœ ์„ค์ •ํ•˜๋ฉด ํŽ˜์ด์ง€์™€ ๊ฐ ํŽ˜์ด์ง€์˜ ๋ชจ๋“  ์ตœ์ƒ์œ„ ๊ฐœ์ฒด๊ฐ€ ๋ฐ˜ํ™˜๋ฉ๋‹ˆ๋‹ค. ์ด ๋งค๊ฐœ๋ณ€์ˆ˜๊ฐ€ ์„ค์ •๋˜์ง€ ์•Š์œผ๋ฉด ๋ชจ๋“  ๋…ธ๋“œ๊ฐ€ ๋ฐ˜ํ™˜๋ฉ๋‹ˆ๋‹ค.." }, "geometry": { "type": "string", @@ -21778,7 +21778,7 @@ }, { "const": 40, - "title": "๋กœํ„ฐ๋ฆฌ์—์„œ 11์‹œ๋ฐฉํ–ฅ" + "title": "๋กœํ„ฐ๋ฆฌ์—์„œ 11์‹œ ๋ฐฉํ–ฅ" }, { "const": 41, @@ -21842,7 +21842,7 @@ }, { "const": 74, - "title": "ํšŒ์ „ ๋ฐฉํ–ฅ์—์„œ ์˜ค๋ฅธ์ชฝ 5์‹œ ์ชฝ์œผ๋กœ" + "title": "ํšŒ์ „์œผ๋กœ ์˜ค๋ฅธ์ชฝ 5์‹œ ๋ฐฉํ–ฅ" }, { "const": 75, @@ -21850,7 +21850,7 @@ }, { "const": 76, - "title": "ํšŒ์ „ ๋ฐฉํ–ฅ์—์„œ 7์‹œ ๋ฐฉํ–ฅ" + "title": "ํšŒ์ „๊ต์ฐจ๋กœ์—์„œ ์™ผ์ชฝ 7์‹œ๋ฐฉํ–ฅ" }, { "const": 77, @@ -21866,7 +21866,7 @@ }, { "const": 80, - "title": "ํšŒ์ „๊ต์ฐจ๋กœ์—์„œ ์™ผ์ชฝ 11์‹œ ๋ฐฉํ–ฅ" + "title": "ํšŒ์ „๊ต์ฐจ๋กœ์—์„œ ์˜† 11์‹œ ๋ฐฉํ–ฅ" }, { "const": 81, @@ -22810,7 +22810,7 @@ }, "pre_sale_start_date": { "type": "number", - "title": "ํŒ๋งค์šฉ ํƒ€์ž„์Šคํƒฌํ”„" + "title": "ํƒ€์ž„์Šคํƒฌํ”„ ํŒ๋งค" }, "pre_sale_end_date": { "type": "number", @@ -22827,7 +22827,7 @@ }, "price_tax": { "type": "boolean", - "title": "์„ธ๊ธˆ์ด ํฌํ•จ๋˜๋Š”์ง€ ์•„๋‹Œ์ง€" + "title": "์„ธ๊ธˆ์ด ํฌํ•จ๋˜๋Š”์ง€ ์—ฌ๋ถ€" }, "price_none": { "type": "boolean", @@ -23306,7 +23306,7 @@ } ], "title": "์ œํ’ˆ์˜ ํŒ๋งค ์ƒํƒœ", - "description": "์ƒํ’ˆ์˜ ํŒ๋งค ํ˜„ํ™ฉ์— ๋”ฐ๋ผ ๋ฌธ์˜๋ฅผ ์›ํ•˜์‹ค ๋•Œ ๊ฐ’์„ ์ „๋‹ฌํ•ด๋“œ๋ฆด ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. 'ํŒ๋งค์ค‘', 'ํ’ˆ์ ˆ', 'ํŒ๋งค์ค‘์ง€'๋ฅผ ์„ ํƒํ•˜์‹ค ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.." + "description": "์ƒํ’ˆ์˜ ํŒ๋งค ํ˜„ํ™ฉ์— ๋”ฐ๋ผ ๋ฌธ์˜๋ฅผ ์›ํ•˜์‹ค ๋•Œ ๊ฐ’์„ ์ „๋‹ฌํ•ด๋“œ๋ฆด ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. '์„ธ์ผ', 'ํ’ˆ์ ˆ', '๋ฏธํŒ๋งค'๋ฅผ ์„ ํƒํ•˜์‹ค ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.." }, "category": { "type": "string", @@ -26607,7 +26607,7 @@ }, "currencyCode": { "type": "string", - "title": "ํ™”ํ ๋‹จ์œ„, ํ†ตํ™” ์ฝ”๋“œ", + "title": "ํ™”ํ ๋‹จ์œ„, ํ™”ํ ์ฝ”๋“œ", "description": "'USD', 'EUR', 'KRW' ๋“ฑ์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค.." } }, @@ -28189,7 +28189,7 @@ { "const": "DISPLAY", "title": "๋””์Šคํ”Œ๋ ˆ์ด ๊ด‘๊ณ ", - "description": "๋ˆˆ์— ์ž˜ ๋“ค๋ฆฌ๋Š” ๋ชจ์–‘์œผ๋กœ 3๋ฐฑ๋งŒ ์‚ฌ์ดํŠธ์™€ ์•ฑ์—์„œ ๊ณ ๊ฐ์—๊ฒŒ ์‘๋‹ต", + "description": "๋ˆˆ์— ์ž˜ ๋งž๋Š” ๋ชจ์–‘์œผ๋กœ 3๋ฐฑ๋งŒ ์‚ฌ์ดํŠธ์™€ ์•ฑ์—์„œ ๊ณ ๊ฐ์—๊ฒŒ ์‘๋‹ต", "default": "SEARCH" } ], @@ -28375,7 +28375,7 @@ { "const": "DISPLAY", "title": "๋””์Šคํ”Œ๋ ˆ์ด ๊ด‘๊ณ ", - "description": "๋ˆˆ์— ์ž˜ ๋“ค๋ฆฌ๋Š” ๋ชจ์–‘์œผ๋กœ 3๋ฐฑ๋งŒ ์‚ฌ์ดํŠธ์™€ ์•ฑ์—์„œ ๊ณ ๊ฐ์—๊ฒŒ ์‘๋‹ต", + "description": "๋ˆˆ์— ์ž˜ ๋งž๋Š” ๋ชจ์–‘์œผ๋กœ 3๋ฐฑ๋งŒ ์‚ฌ์ดํŠธ์™€ ์•ฑ์—์„œ ๊ณ ๊ฐ์—๊ฒŒ ์‘๋‹ต", "default": "SEARCH" } ], @@ -33623,8 +33623,8 @@ "items": { "$ref": "#/components/schemas/IGoogleHotel.INearbyPlace" }, - "title": "์ฃผ๋ณ€ ์‹œ์„ค", - "description": "์ฃผ๋ณ€ ์‹œ์„ค" + "title": "๋ถ€์ง€ ์ฃผ๋ณ€ ์‹œ์„ค", + "description": "๋ถ€์ง€ ์ฃผ๋ณ€ ์‹œ์„ค" }, "hotel_class": { "type": "string", @@ -34282,7 +34282,7 @@ "children": { "type": "integer", "title": "์ž๋…€ ์ˆ˜", - "description": "์ž๋…€ ์ˆ˜๋ฅผ ์ž…๋ ฅํ•ด ์ฃผ์„ธ์š”.." + "description": "์ž๋…€ ์ˆ˜๋ฅผ ์ž…๋ ฅํ•ด์ฃผ์„ธ์š”.." }, "stop": { "oneOf": [ @@ -35314,7 +35314,7 @@ "type": "string" } ], - "title": "์ด ๋ฉ”์‹œ์ง€๋ฅผ ๋งŒ๋“  ์‚ฌ๋žŒ์˜ ID ์‚ฌ์šฉ์ž๊ฐ€ ์•„๋‹Œ ๊ฒฝ์šฐ ๋ฉ”์‹œ์ง€์— ID๊ฐ€ ์—†์Šต๋‹ˆ๋‹ค.." + "title": "์ด ๋ฉ”์‹œ์ง€๋ฅผ ์ž‘์„ฑํ•œ ์‚ฌ๋žŒ์˜ ID ์‚ฌ์šฉ์ž๊ฐ€ ์•„๋‹Œ ๊ฒฝ์šฐ ๋ฉ”์‹œ์ง€์— ID๊ฐ€ ์—†์Šต๋‹ˆ๋‹ค.." }, "attachments": { "type": "array", @@ -35527,7 +35527,7 @@ "type": "string" } ], - "title": "์ด ๋ฉ”์‹œ์ง€๋ฅผ ๋งŒ๋“  ์‚ฌ๋žŒ์˜ ID ์‚ฌ์šฉ์ž๊ฐ€ ์•„๋‹Œ ๊ฒฝ์šฐ ๋ฉ”์‹œ์ง€์— ID๊ฐ€ ์—†์Šต๋‹ˆ๋‹ค.." + "title": "์ด ๋ฉ”์‹œ์ง€๋ฅผ ์ž‘์„ฑํ•œ ์‚ฌ๋žŒ์˜ ID ์‚ฌ์šฉ์ž๊ฐ€ ์•„๋‹Œ ๊ฒฝ์šฐ ๋ฉ”์‹œ์ง€์— ID๊ฐ€ ์—†์Šต๋‹ˆ๋‹ค.." }, "channel": { "type": "string", @@ -35719,7 +35719,7 @@ "type": "string" } ], - "title": "์ด ๋ฉ”์‹œ์ง€๋ฅผ ๋งŒ๋“  ์‚ฌ๋žŒ์˜ ID ์‚ฌ์šฉ์ž๊ฐ€ ์•„๋‹Œ ๊ฒฝ์šฐ ๋ฉ”์‹œ์ง€์— ID๊ฐ€ ์—†์Šต๋‹ˆ๋‹ค.." + "title": "์ด ๋ฉ”์‹œ์ง€๋ฅผ ์ž‘์„ฑํ•œ ์‚ฌ๋žŒ์˜ ID ์‚ฌ์šฉ์ž๊ฐ€ ์•„๋‹Œ ๊ฒฝ์šฐ ๋ฉ”์‹œ์ง€์— ID๊ฐ€ ์—†์Šต๋‹ˆ๋‹ค.." }, "channel": { "type": "string", @@ -39895,7 +39895,7 @@ "type": "string", "format": "date", "title": "๋‚ ์งœ", - "description": "๋ฐ์ผ๋ฆฌ๋กœ ์กฐํšŒํ•  ๋ฐ์ดํŠธ์ž…๋‹ˆ๋‹ค. ์ž…๋ ฅํ•˜๋Š” ๋‚ ์งœ๋ฅผ ๊ด€๊ณ„๋กœ ์กฐํšŒํ•ฉ๋‹ˆ๋‹ค. ๋…„-์›”-์ผ ํ˜•์‹์˜ ๋‚ ์งœ ์œ ํ˜• ๋ฌธ์ž์—ด์„ ์—ฐ๊ฒฐํ•˜๋Š” ๊ฒƒ์ž…๋‹ˆ๋‹ค." + "description": "๋ฐ์ผ๋ฆฌ๋กœ ์กฐํšŒํ•  ๋ฐ์ดํŠธ์ž…๋‹ˆ๋‹ค. ์ž…๋ ฅํ•˜๋Š” ๋‚ ์งœ๋ฅผ ๊ด€๊ณ„๋กœ ์กฐํšŒํ•ฉ๋‹ˆ๋‹ค. ๋…„-์›”-์ผ ํ˜•์‹์˜ ๋‚ ์งœ ์œ ํ˜• ๋ฌธ์ž์—ด์„ ์—ฐ๊ฒฐํ•˜๊ธฐ ๋•Œ๋ฌธ์—." } }, "title": "Google ๋ฐ์ผ๋ฆฌ ๋™ํ–ฅ ์กฐํšŒ ์ •๋ณด", @@ -40260,7 +40260,7 @@ } ], "title": "์ด์ „", - "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์˜ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." + "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์— ๋Œ€ํ•œ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." }, "next": { "oneOf": [ @@ -40758,7 +40758,7 @@ } ], "title": "์ด์ „", - "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์˜ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." + "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์— ๋Œ€ํ•œ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." }, "next": { "oneOf": [ @@ -41279,7 +41279,7 @@ } ], "title": "์ด์ „", - "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์˜ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." + "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์— ๋Œ€ํ•œ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." }, "next": { "oneOf": [ @@ -41485,7 +41485,7 @@ } ], "title": "์ด์ „", - "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์˜ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." + "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์— ๋Œ€ํ•œ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." }, "next": { "oneOf": [ @@ -41816,7 +41816,7 @@ } ], "title": "์ด์ „", - "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์˜ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." + "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์— ๋Œ€ํ•œ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." }, "next": { "oneOf": [ @@ -42677,7 +42677,7 @@ } ], "title": "์ด์ „", - "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์˜ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." + "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์— ๋Œ€ํ•œ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." }, "next": { "oneOf": [ @@ -42823,7 +42823,7 @@ } ], "title": "์ด์ „", - "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์˜ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." + "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์— ๋Œ€ํ•œ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." }, "next": { "oneOf": [ @@ -43312,7 +43312,7 @@ } ], "title": "์ด์ „", - "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์˜ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." + "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์— ๋Œ€ํ•œ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." }, "next": { "oneOf": [ @@ -43741,7 +43741,7 @@ } ], "title": "์ด์ „", - "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์˜ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." + "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์— ๋Œ€ํ•œ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." }, "next": { "oneOf": [ @@ -43780,7 +43780,7 @@ }, "diff_hunk": { "type": "string", - "title": "๋””ํ”„_๋ฉํฌ", + "title": "diff_hunk", "description": "diff_hunk๋Š” github์—์„œ ์ฝ”๋“œ์˜ ๋ณ€๊ฒฝ์„ ๋‚˜ํƒ€๋‚ด๋Š” ์–‘์‹์ž…๋‹ˆ๋‹ค. ๋ฌธ์ž์—ด๋กœ ๊ตฌ์„ฑ๋˜๋ฉฐ, ์ƒˆ ์ค„ ๋ฌธ์ž๋ฅผ ๊ธฐ์ค€์œผ๋กœ ์ฒซ ๋ฒˆ์งธ ์ค„์—๋Š” ๊ธฐํ˜ธ ์‚ฌ์ด์˜ ๋ณ€๊ฒฝ ์ง€์ ์— ๋Œ€ํ•œ ๋ฉ”ํƒ€ ์ •๋ณด๊ฐ€ ์žˆ์Šต๋‹ˆ๋‹ค." }, "path": { @@ -43994,7 +43994,7 @@ } ], "title": "์ด์ „", - "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์˜ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." + "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์— ๋Œ€ํ•œ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." }, "next": { "oneOf": [ @@ -44351,7 +44351,7 @@ } ], "title": "์ด์ „", - "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์˜ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." + "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์— ๋Œ€ํ•œ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." }, "next": { "oneOf": [ @@ -44553,7 +44553,7 @@ } ], "title": "์ด์ „", - "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์˜ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." + "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์— ๋Œ€ํ•œ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." }, "next": { "oneOf": [ @@ -44858,7 +44858,7 @@ }, "draft": { "type": "boolean", - "title": "draft ํ’€ ๋ฆฌํ€˜์ŠคํŠธ๊ฐ€ ์ดˆ์•ˆ์ธ์ง€ ์—ฌ๋ถ€๋ฅผ ๋‚˜ํƒ€๋ƒ…๋‹ˆ๋‹ค.." + "title": "draft ํ’€ ๋ฆฌํ€˜์ŠคํŠธ๊ฐ€ ์ดˆ์•ˆ์ธ์ง€ ์•„๋‹Œ์ง€๋ฅผ ๋‚˜ํƒ€๋ƒ…๋‹ˆ๋‹ค.." }, "requested_reviewers": { "type": "array", @@ -46076,7 +46076,7 @@ "title": "๋Œ“๊ธ€" } ], - "title": "๋ฐฉํ–ฅ์˜ ์กฐ๊ฑด์€ "CREATED_AT", "UPDATED_AT", "COMMENTS" ์ค‘ ํ•˜๋‚˜์—ฌ์•ผ ํ•ฉ๋‹ˆ๋‹ค.." + "title": "๋ฐฉํ–ฅ ์กฐ๊ฑด์€ "CREATED_AT", "UPDATED_AT", "COMMENTS" ์ค‘ ํ•˜๋‚˜์—ฌ์•ผ ํ•ฉ๋‹ˆ๋‹ค.." }, "owner": { "type": "string", @@ -46135,7 +46135,7 @@ } ], "title": "์ด์ „", - "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์˜ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." + "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์— ๋Œ€ํ•œ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." }, "next": { "oneOf": [ @@ -46782,7 +46782,7 @@ } ], "title": "์ด์ „", - "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์˜ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." + "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์— ๋Œ€ํ•œ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." }, "next": { "oneOf": [ @@ -46873,7 +46873,7 @@ } ], "title": "์ด์ „", - "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์˜ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." + "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์— ๋Œ€ํ•œ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." }, "next": { "oneOf": [ @@ -47225,7 +47225,7 @@ }, "draft": { "type": "boolean", - "title": "draft ํ’€ ๋ฆฌํ€˜์ŠคํŠธ๊ฐ€ ์ดˆ์•ˆ์ธ์ง€ ์—ฌ๋ถ€๋ฅผ ๋‚˜ํƒ€๋ƒ…๋‹ˆ๋‹ค.." + "title": "draft ํ’€ ๋ฆฌํ€˜์ŠคํŠธ๊ฐ€ ์ดˆ์•ˆ์ธ์ง€ ์•„๋‹Œ์ง€๋ฅผ ๋‚˜ํƒ€๋ƒ…๋‹ˆ๋‹ค.." }, "milestone": { "oneOf": [ @@ -47690,7 +47690,7 @@ } ], "title": "์ด์ „", - "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์˜ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." + "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์— ๋Œ€ํ•œ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." }, "next": { "oneOf": [ @@ -47893,7 +47893,7 @@ } ], "title": "์ด์ „", - "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์˜ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." + "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์— ๋Œ€ํ•œ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." }, "next": { "oneOf": [ @@ -48033,7 +48033,7 @@ } ], "title": "์ด์ „", - "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์˜ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." + "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์— ๋Œ€ํ•œ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." }, "next": { "oneOf": [ @@ -48142,7 +48142,7 @@ } ], "title": "์ด์ „", - "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์˜ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." + "description": "์ด๊ฒƒ์ด ์˜คํ”„์…‹ ๊ธฐ๋ฐ˜ ํŽ˜์ด์ง€๋„ค์ด์…˜์˜ ์‘๋‹ต์ธ ๊ฒฝ์šฐ ๋‹ค์Œ ํŽ˜์ด์ง€์— ๋Œ€ํ•œ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”. ์ฆ‰, ์ด์ „ ํŽ˜์ด์ง€." }, "next": { "oneOf": [ @@ -49288,7 +49288,7 @@ "jmesPath": "[].{value:id, label:name}" }, "title": "์ฑ„๋„", - "description": "์Šคํ† ์–ด ์ฑ„๋„์„ ์„ ํƒํ•ด์ฃผ์„ธ์š”." + "description": "์ฃผ๋ฅ˜ ์ฑ„๋„์„ ์„ ํƒํ•ด์ฃผ์„ธ์š”." } }, "required": [ @@ -51406,7 +51406,7 @@ } ], "title": "๋ผ์šฐํŒ…_์–‘์‹_์ œ์ถœ", - "description": "์ดˆ๋Œ€์ž๋ฅผ ์˜ˆ์•ฝ ํŽ˜์ด์ง€๋กœ ๋ฆฌ๋””๋ ‰์…˜ํ•˜๋Š” ๋ผ์šฐํŒ… ์–‘์‹ ์ œ์ถœ์— ๋Œ€ํ•œ ์ฐธ์กฐ." + "description": "์ดˆ๋Œ€๋ฐ›์€ ์‚ฌ๋žŒ์„ ์˜ˆ์•ฝ ํŽ˜์ด์ง€๋กœ ๋ฆฌ๋””๋ ‰์…˜ํ•˜๋Š” ๋ผ์šฐํŒ… ์–‘์‹ ์ œ์ถœ์— ๋Œ€ํ•œ ์ฐธ์กฐ." }, "cancellation": { "$ref": "#/components/schemas/ICalendly.Cancellation", @@ -52066,7 +52066,7 @@ "id": { "type": "string", "title": "ํผ์•„์ด๋””", - "description": "์ƒ์„ฑ๋œ ํผ์˜ id." + "description": "์ƒ์„ฑ๋œ ํผ์˜ ID." }, "name": { "type": "string", @@ -52394,7 +52394,7 @@ "properties": { "markdown": { "type": "string", - "title": "๋งˆํฌ๋‹ค์šด ๋งˆํฌ๋‹ค์šด", + "title": "๋งˆ๋ฅดํ”„ ๋งˆํฌ๋‹ค์šด", "description": "Marp ๋งˆํฌ๋‹ค์šด ์ž…๋ ฅ ๋ฌธ์ž์—ด." } }, @@ -54372,7 +54372,7 @@ "IsDataFromGa": { "type": "boolean", "title": "GA์—์„œ ๊ฐ€์ ธ์˜จ ๋ฐ์ดํ„ฐ์ธ๊ฐ€", - "description": "๋ฐ์ดํ„ฐ๊ฐ€ Google Analytics์—์„œ ๋‚˜์˜จ ๊ฒƒ์ธ์ง€ ์—ฌ๋ถ€๋ฅผ ๋‚˜ํƒ€๋ƒ…๋‹ˆ๋‹ค." + "description": "๋ฐ์ดํ„ฐ๊ฐ€ Google Analytics์—์„œ ๋‚˜์˜จ ๊ฒƒ์ธ์ง€ ๋‚˜ํƒ€๋ƒ…๋‹ˆ๋‹ค." }, "Competitors": { "$ref": "#/components/schemas/ISimilarweb.Competitors", diff --git a/assets/output/damoa.swagger.ar.json b/assets/output/damoa.swagger.ar.json new file mode 100644 index 0000000..111c332 --- /dev/null +++ b/assets/output/damoa.swagger.ar.json @@ -0,0 +1,20539 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "ู…ูˆุงุตูุงุช ุฏุงู…ูˆุง API", + "description": "ู…ูˆุงุตูุงุช ุฏุงู…ูˆุง API", + "version": "1.0.0" + }, + "servers": [ + { + "url": "https://api.queenit.kr", + "description": "ุฅู†ุชุงุฌ" + }, + { + "url": "https://api.dev.queenit.kr", + "description": "ุชุทูˆูŠุฑ" + }, + { + "url": "http://localhost:8080", + "description": "ู…ุญู„ูŠ" + }, + { + "url": "https://{namespace}-app-api.dev.rapportlabs.cloud", + "variables": { + "namespace": { + "default": "damoa" + } + } + } + ], + "tags": [ + { + "name": "metadata", + "description": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช ุงู„ุจูŠุงู†ุงุช ุงู„ูˆุตููŠุฉ" + }, + { + "name": "verification", + "description": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช ุงู„ุชุญู‚ู‚" + }, + { + "name": "hello", + "description": "ู…ุฑุญุจุง API" + }, + { + "name": "favorite", + "description": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ุงู„ู…ูุถู„ุฉ" + }, + { + "name": "best", + "description": "ุฃูุถู„ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช" + }, + { + "name": "product", + "description": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช ุงู„ู…ู†ุชุฌ" + }, + { + "name": "ageGroup", + "description": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช ุงู„ู…ุฌู…ูˆุนุฉ ุงู„ุนู…ุฑูŠุฉ" + }, + { + "name": "home", + "description": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ุงู„ุฑุฆูŠุณูŠุฉ" + }, + { + "name": "newArrival", + "description": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช ุงู„ูˆุตูˆู„ ุงู„ุฌุฏูŠุฏุฉ" + }, + { + "name": "hotDeal", + "description": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช ุงู„ุตูู‚ุฉ ุงู„ุณุงุฎู†ุฉ" + }, + { + "name": "recommendation", + "description": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ู„ู„ุชูˆุตูŠุฉ" + }, + { + "name": "promotion", + "description": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ุงู„ุชุฑูˆูŠุฌูŠุฉ" + }, + { + "name": "cart", + "description": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช ุณู„ุฉ ุงู„ุชุณูˆู‚" + }, + { + "name": "account", + "description": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช ุงู„ุญุณุงุจ" + }, + { + "name": "order", + "description": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ู„ู„ุทู„ุจ" + }, + { + "name": "payment", + "description": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช ุงู„ุฏูุน" + }, + { + "name": "banner", + "description": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช ุจุงู†ุฑ" + }, + { + "name": "collection", + "description": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช ุงู„ุชุฌู…ูŠุน" + }, + { + "name": "search", + "description": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช ุงู„ุจุญุซ" + }, + { + "name": "autocomplete", + "description": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช ุงู„ุฅูƒู…ุงู„ ุงู„ุชู„ู‚ุงุฆูŠ" + }, + { + "name": "coupon", + "description": "ู‚ุณูŠู…ุฉ API" + }, + { + "name": "review", + "description": "ู…ุฑุงุฌุนุฉ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช" + }, + { + "name": "reviewStatistics", + "description": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช ุฅุญุตุงุฆูŠุงุช ุงู„ู…ุฑุงุฌุนุฉ" + }, + { + "name": "userProfile", + "description": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช ู…ู„ู ุชุนุฑูŠู ุงู„ู…ุณุชุฎุฏู…" + }, + { + "name": "image", + "description": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช ุงู„ุตูˆุฑ" + }, + { + "name": "prompt", + "description": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ุงู„ุณุฑูŠุนุฉ" + }, + { + "name": "shopLive", + "description": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช ShopLive" + }, + { + "name": "point", + "description": "ู†ู‚ุทุฉ API" + }, + { + "name": "productRanking", + "description": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช ุชุฑุชูŠุจ ุงู„ู…ู†ุชุฌุงุช" + }, + { + "name": "tier", + "description": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ู„ู„ุทุจู‚ุฉ" + }, + { + "name": "styleShot", + "description": "ุฃุณู„ูˆุจ ู„ู‚ุทุฉ API" + }, + { + "name": "attendanceCheck", + "description": "ุงู„ุชุญู‚ู‚ ู…ู† ุงู„ุญุถูˆุฑ API" + }, + { + "name": "tag", + "description": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ู„ู„ุนู„ุงู…ุฉ" + } + ], + "paths": { + "/metadata": { + "get": { + "description": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช ุงู„ุจูŠุงู†ุงุช ุงู„ูˆุตููŠุฉ", + "operationId": "getMetadata", + "tags": [ + "metadata" + ], + "responses": { + "200": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุจูŠุงู†ุงุช ุงู„ูˆุตููŠุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MetadataDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/hello": { + "get": { + "summary": "ู…ุฑุญุจุง ุจุงู„ุนุงู„ู…", + "operationId": "hello", + "tags": [ + "hello" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ู…ุฑุญุจุง", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/verifications/sms": { + "post": { + "summary": "ุฅุฑุณุงู„ ุฑู…ุฒ ุงู„ุชุญู‚ู‚ ุนุจุฑ ุฑุณุงู„ุฉ ู†ุตูŠุฉ ู‚ุตูŠุฑุฉ [ุฑู‚ู… ู‡ุงุชู ุบูŠุฑ ุตุงู„ุญ -> ApiErrorType.INVALID_VALUE]", + "operationId": "sendVerifCodeBySms", + "tags": [ + "verification" + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SendVerifCodeRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "ู†ุฌุงุญ ุฅุฑุณุงู„ ุฑู…ุฒ ุงู„ุชุญู‚ู‚", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SendVerifCodeResponseDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/verifications": { + "put": { + "summary": "ุฑู…ุฒ ุงู„ุชุญู‚ู‚ [ุฑู…ุฒ ู…ู…ูŠุฒ ุฃูˆ ุฑู…ุฒ ุบูŠุฑ ุตุงู„ุญ -> ApiErrorType.INVALID_VALUE]", + "operationId": "verifyCode", + "tags": [ + "verification" + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VerifyCodeRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุงู„ุชุญู‚ู‚ ู…ู† ุงู„ุฑู…ุฒ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VerifyCodeResponseDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/verifications/kakao": { + "put": { + "summary": "ุงู„ุชุญู‚ู‚ ู…ู† ุฑู…ุฒ ูˆุตูˆู„ kakao", + "operationId": "verifyKakaoToken", + "tags": [ + "verification" + ], + "description": "- ุจุงู„ู†ุณุจุฉ ู„ู„ู…ุณุชุฎุฏู…ูŠู† ุงู„ุฐูŠู† ุชู…ุช ู…ุตุงุฏู‚ุชู‡ู… ู…ู† ุฎู„ุงู„ ุชุณุฌูŠู„ ุงู„ุฏุฎูˆู„ ุฅู„ู‰ KakaoุŒ ุงุทู„ุจ ุฑู…ุฒู‹ุง ุชู… ุงู„ุชุญู‚ู‚ ู…ู†ู‡ ุจุงุณุชุฎุฏุงู… ุฑู…ุฒ ุงู„ูˆุตูˆู„ ุฅู„ู‰ Kakao API ุงู„ุตุงุฏุฑ ูˆุฑู‚ู… ุงู„ู‡ุงุชู - ุฑู‚ู… ุงู„ู‡ุงุชู ุจุชู†ุณูŠู‚ ุงู„ุงุชุตุงู„ ุงู„ุฏูˆู„ูŠ (ุนู„ู‰ ุณุจูŠู„ ุงู„ู…ุซุงู„ +82 10-1111-1111) - ุงุณุชุฎุฏู… ุชุณุฌูŠู„ ุงู„ุฏุฎูˆู„/ุงู„ุงุดุชุฑุงูƒ ู„ู„ุฑู…ุฒ ุงู„ุฐูŠ ุชู… ุงู„ุชุญู‚ู‚ ู…ู†ู‡ ุจูˆุงุณุทุฉ ุงุณุชุฏุนุงุก ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช SignUpV2", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VerifyKakaoTokenRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ู„ู„ุชุญู‚ู‚", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VerifyKakaoTokenResponseDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/migrate-user": { + "post": { + "summary": "ู…ุณุชุฎุฏู… ู…ุตุงุฏู‚ุฉ Firebase -> ุชุญูˆูŠู„ ู…ุณุชุฎุฏู… ู…ุตุงุฏู‚ุฉ ุฏุงู…ูˆุง", + "description": "> ุชุญูˆูŠู„ ุงู„ู…ุณุชุฎุฏู…ูŠู† ุงู„ุฐูŠู† ุงุณุชุฎุฏู…ูˆุง ู…ุตุงุฏู‚ุฉ firebase ููŠ ุนู…ูŠู„ ุงู„ุฅุตุฏุงุฑ ุงู„ุฃู‚ุฏู… ุงู„ุญุงู„ูŠ ู„ุงุณุชุฎุฏุงู… ู…ุตุงุฏู‚ุฉ damoa ุนู†ุฏ ุงุณุชู„ุงู… ุฑู…ุฒ ูˆุตูˆู„ ู…ุตุงุฏู‚ุฉ firebaseุŒ ูŠุชู… ู†ู‚ู„ ู…ุนู„ูˆู…ุงุช ุงู„ู…ุณุชุฎุฏู… ุฅู„ู‰ ู…ุตุงุฏู‚ุฉ damoa ูˆูŠุชู… ุชูˆููŠุฑ ุงู„ู…ุนู„ูˆู…ุงุช ู„ุงุณุชุฎุฏุงู… ุฑู…ุฒ ุงู„ูˆุตูˆู„/ุงู„ุชุญุฏูŠุซ ุงู„ุฎุงุต ุจู€ damoa 1 (Client ) ุฅุฐุง ูƒุงู†ุช ู‡ู†ุงูƒ ู…ุนู„ูˆู…ุงุช ู…ุตุงุฏู‚ุฉ firebaseุŒ ูู‚ู… ุจุชุญุฏูŠุซ ุฑู…ุฒ ู…ุตุงุฏู‚ุฉ firebase ุงู„ู…ูˆุฌูˆุฏ 2. (ุงู„ุนู…ูŠู„) ุงุชุตู„ ุจู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ ู…ู†ูุตู„ุฉ ู…ุญุฏุฏุฉ ุนู„ู‰ ุฌุงู†ุจ ุงู„ุฎุงุฏู… ู„ู„ุชุจุฏูŠู„ ู…ู† ู…ุณุชุฎุฏู… ู…ุตุงุฏู‚ุฉ firebase ุฅู„ู‰ ู…ุณุชุฎุฏู… ู…ุตุงุฏู‚ุฉ damoa (ูŠู„ุฒู… ุชุณุฌูŠู„ ุงู„ุฏุฎูˆู„) 3. (ุงู„ุฎุงุฏู…) ุชุญู‚ู‚ ู…ู† ุจุงุฆุน ุงู„ุฑู…ุฒ ุงู„ู…ู…ูŠุฒ ููŠ ู…ุนู„ูˆู…ุงุช ุฑู…ุฒ ุงู„ูˆุตูˆู„ ุงู„ู…ุฑุณู„ุฉ ู…ู† ู‚ุจู„ ุงู„ุนู…ูŠู„ -> ุชุญู‚ู‚ ู…ู…ุง ุฅุฐุง ูƒุงู† ู‚ุฏ ุชู… ุฅุตุฏุงุฑู‡ ุจูˆุงุณุทุฉ Firebase ุฃูˆ damoa 4. (ุงู„ุฎุงุฏู…) ุฅุฐุง ุชู… ุงู„ุชุฃูƒุฏ ู…ู† ุฃู†ู‡ ุฑู…ุฒ ู…ู…ูŠุฒ ุตุงุฏุฑ ุนู† Firebase -> ุชุญู‚ู‚ ู…ู…ุง ุฅุฐุง ูƒุงู† ุฑู…ุฒ ุงู„ูˆุตูˆู„ ุตุงู„ุญู‹ุง ุฃู… ู„ุง 5. (ุงู„ุฎุงุฏู…) ุฅุฐุง ุชู… ุงู„ุชุฃูƒุฏ ู…ู† ุตุญุฉ ุฑู…ุฒ ุงู„ูˆุตูˆู„ -> ุงุญูุธ ู…ุนู„ูˆู…ุงุช ู…ุณุชุฎุฏู… ู…ุตุงุฏู‚ุฉ firebase ููŠ ุฌุฏูˆู„ ู…ุณุชุฎุฏู… ู…ุตุงุฏู‚ุฉ damoa 6. (ุงู„ุฎุงุฏู…) ุจุนุฏ ุญูุธ ู…ุนู„ูˆู…ุงุช ู…ุณุชุฎุฏู… ู…ุตุงุฏู‚ุฉ firebase ููŠ ุฌุฏูˆู„ ู…ุณุชุฎุฏู… damoa authุŒ damoa auth A ูŠุชู… ุฅุฑุณุงู„ ุงู„ุฑู…ุฒ ุงู„ู…ู…ูŠุฒ (ุงู„ูˆุตูˆู„ ูˆุงู„ุชุญุฏูŠุซ) ูƒุฑุฏ 7. (ุงู„ุนู…ูŠู„) ุงุณุชุฎุฏู… ุฑู…ุฒ ู…ุตุงุฏู‚ุฉ damoa ุนู†ุฏ ุชุณุฌูŠู„ ุงู„ุฏุฎูˆู„ (ู…ุฌู…ูˆุนุฉ ุฑุฃุณ ุทู„ุจ "ุงู„ุชููˆูŠุถ")ุŒ ูŠุชู… ุฅุฑุณุงู„ ุฑู…ุฒ ุงู„ูˆุตูˆู„ ููŠ ู†ุต ุงู„ุทู„ุจ.", + "operationId": "migrateUser", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FirebaseAuthUserMigrationRequest" + } + } + } + }, + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุชุฑุญูŠู„ ุงู„ู…ุณุชุฎุฏู…", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DamoaTokenDto" + } + } + } + }, + "204": { + "description": "ุฅุฐุง ูƒู†ุช ุจุงู„ูุนู„ ู…ุณุชุฎุฏู… ู…ุตุงุฏู‚ุฉ damoa" + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/signin/anonymous": { + "post": { + "summary": "ู‚ู… ุจุชุณุฌูŠู„ ุงู„ุฏุฎูˆู„ ูƒู…ุณุชุฎุฏู… ู…ุฌู‡ูˆู„", + "description": "ู‚ู… ุจุชุณุฌูŠู„ ุงู„ุฏุฎูˆู„ ูƒู…ุณุชุฎุฏู… ู…ุฌู‡ูˆู„ [ุฑู…ุฒ ู…ู…ูŠุฒ ุบูŠุฑ ุตุงู„ุญ -> ApiErrorType.INVALID_VALUE]", + "operationId": "signInAnonymously", + "tags": [ + "account" + ], + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุชุณุฌูŠู„ ุงู„ุฏุฎูˆู„ ุจุดูƒู„ ู…ุฌู‡ูˆู„", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DamoaTokenDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/signup/providers/{providerType}": { + "post": { + "summary": "ุชุณุฌูŠู„ ุฏุฎูˆู„/ุชุณุฌูŠู„ ู…ุณุชุฎุฏู… ู…ุตุงุฏู‚ ุนู„ูŠู‡", + "description": "- ูŠุชู… ุงู„ุงุชุตุงู„ ุจู‡ ุนู†ุฏู…ุง ูŠู‚ูˆู… ู…ุณุชุฎุฏู… ู…ุณุฌู„ ู…ุณุจู‚ู‹ุง ุจุชุณุฌูŠู„ ุงู„ุฏุฎูˆู„ ู…ุฑุฉ ุฃุฎุฑู‰ ุฃูˆ ุงู„ุงุดุชุฑุงูƒ ู…ู† ุฌุฏูŠุฏ - ูŠุฏุนู… ุญุงู„ูŠู‹ุง `SMS` ูˆ`KAKAO` ูƒู€ "providerType" - ูŠุญุฏุซ ุฎุทุฃ ุฅุฐุง ุชู… ุงุณุชุฎุฏุงู… ProviderType ู…ุฎุชู„ู - ุณูŠุชู… ุงุณุชุฎุฏุงู… ู…ูˆูุฑูŠ ุงู„ู…ุตุงุฏู‚ุฉ ุงู„ุขุฎุฑูŠู† (facebookุŒ ..) ูŠู…ูƒู† ุฅุถุงูุชู‡ุง ููŠ ุงู„ู…ุณุชู‚ุจู„ ูˆู…ุง ุฅู„ู‰ ุฐู„ูƒ - ุฃุฏุฎู„ ุฑู…ุฒ ุงู„ูˆุตูˆู„ ุงู„ุฐูŠ ุชู… ุฅุตุฏุงุฑู‡ ุจุนุฏ ุงุณุชุฏุนุงุก ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ู„ู„ุชุณุฌูŠู„ ุงู„ู…ุฌู‡ูˆู„ ููŠ ู…ุนู„ูˆู…ุงุช ุงู„ุชููˆูŠุถ ุงู„ุชูŠ ุชู… ุฅุฏุฎุงู„ู‡ุง ููŠ ุฑุฃุณ ุงู„ุทู„ุจ - ุชู†ุณูŠู‚ `Bearer {{onymous Access Token }}` - ุฑู…ุฒ ุงู„ูˆุตูˆู„ ุงู„ุตุงุฏุฑ ู…ู† ุฎู„ุงู„ ู…ุตุงุฏู‚ุฉ Firebase ู„ุง ูŠู…ูƒู† ุงุณุชุฎุฏุงู…ู‡ุง", + "operationId": "signUpV2", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "providerType", + "schema": { + "$ref": "#/components/schemas/ProviderTypeEnum" + }, + "required": true, + "description": "ู…ุฒูˆุฏ ุงู„ู…ุตุงุฏู‚ุฉ (SMSุŒ KAKAOุŒ ..)" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SignUpRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุงู„ุงุดุชุฑุงูƒ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DamoaTokenDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/refresh": { + "post": { + "summary": "ุชุฌุฏูŠุฏ ุฑู…ุฒ ุงู„ูˆุตูˆู„/ุงู„ุชุญุฏูŠุซ ู„ู„ู…ุณุชุฎุฏู…ูŠู† ุงู„ู…ุตุงุฏู‚ ุนู„ูŠู‡ู… ุฃูˆ ุงู„ู…ุฌู‡ูˆู„ูŠู†", + "description": "ุชุฌุฏูŠุฏ ุฑู…ุฒ ุงู„ูˆุตูˆู„/ุงู„ุชุญุฏูŠุซ ู„ู„ู…ุณุชุฎุฏู…ูŠู† ุงู„ู…ุตุงุฏู‚ ุนู„ูŠู‡ู… ุฃูˆ ุงู„ู…ุฌู‡ูˆู„ูŠู†", + "operationId": "refreshToken", + "tags": [ + "account" + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DamoaTokenRefreshRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุชุญุฏูŠุซ ุงู„ุฑู…ูˆุฒ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DamoaTokenDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/accounts": { + "get": { + "summary": "ูŠุณุชุฎุฏู… ู„ู„ุจุญุซ ุนู† ู…ุนู„ูˆู…ุงุช ุญุณุงุจ ุงู„ู…ุณุชุฎุฏู…", + "description": "ูŠู…ูƒู† ูู‚ุท ู„ู„ู…ุณุชุฎุฏู…ูŠู† ุงู„ุฐูŠู† ูŠุณุชุฎุฏู…ูˆู† damoa auth ุงุณุชุฎุฏุงู…ู‡ ุจุดูƒู„ ุทุจูŠุนูŠ (ุจู…ุง ููŠ ุฐู„ูƒ ุงู„ู…ุณุชุฎุฏู…ูŠู† ุงู„ู…ุฌู‡ูˆู„ูŠู†).", + "operationId": "getDamoaLoginAccount", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุงุณุชุฑุฏุงุฏ ู…ุนู„ูˆู…ุงุช ุงู„ุญุณุงุจ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LoginAccountDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/signout": { + "post": { + "summary": "ุชุณุฌูŠู„ ุงู„ุฎุฑูˆุฌ", + "operationId": "signOut", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุชุณุฌูŠู„ ุงู„ุฎุฑูˆุฌ" + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/logout": { + "post": { + "summary": "ุชุณุฌูŠู„ ุงู„ุฎุฑูˆุฌ", + "operationId": "logout", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุชุณุฌูŠู„ ุงู„ุฎุฑูˆุฌ" + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/external-uid": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู…ุนุฑู ุฎุงุฑุฌูŠ", + "description": "ูŠุชู… ุฅุฑุฌุงุน ู…ุนุฑู ู…ุณุชุฎุฏู… ุฎุงุฑุฌูŠ ูŠู…ูƒู† ุงุณุชุฎุฏุงู…ู‡ ู„ู„ุงุชุตุงู„ ุจูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ุงู„ุฎุงุฑุฌูŠุฉ ู„ู„ู…ุณุชุฎุฏู…..", + "operationId": "getExternalUid", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ู…ุนุฑู ุฎุงุฑุฌูŠ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExternalUidDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/payment-methods": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุทุฑู‚ ุงู„ุฏูุน ุงู„ู…ุณุฌู„ุฉ", + "description": "ูŠุชู… ุฅุฑุฌุงุน ู‚ุงุฆู…ุฉ ุทุฑู‚ ุงู„ุฏูุน ุงู„ุชูŠ ุณุฌู„ู‡ุง ุงู„ู…ุณุชุฎุฏู… ููŠ Queen It Pay..", + "operationId": "getPaymentMethods", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุทุฑู‚ ุงู„ุฏูุน ุงู„ู…ุณุฌู„ุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaymentMethodResponseDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/credentials/connect-pay": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุจูŠุงู†ุงุช ุงุนุชู…ุงุฏ ุงู„ุงุชุตุงู„ ุงู„ุฏูุน", + "description": "ูŠุชู… ุฅุฑุฌุงุน ุจูŠุงู†ุงุช ุงู„ุงุนุชู…ุงุฏ ู„ุงุณุชุฎุฏุงู… ConnectPay JS SDK..", + "operationId": "getConnectPayCredentials", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ู‚ู… ุจุชูˆุตูŠู„ ู…ูุชุงุญ ุงู„ุนู…ูŠู„ ุงู„ู…ุฏููˆุน ูˆู…ูุชุงุญ ุงู„ุนู…ูŠู„ ุงู„ุฎุงุต ุจุงู„ู…ุณุชุฎุฏู…", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectPayCredentialDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/favorites": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุงู„ู…ูุถู„ุฉ", + "operationId": "getMyFavorites", + "tags": [ + "favorite" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "- ู‚ุงุฆู…ุฉ ู…ู†ุชุฌุงุชูŠ ุงู„ู…ูุถู„ุฉ - ุนู†ุฏ ุชุทุจูŠู‚ ุงู„ุฎุตู… ุงู„ููˆุฑูŠ ู„ู€ Queen ItุŒ ูŠูุธู‡ุฑ "FavoriteProductDto" ุงู„ู…ุจู„ุบ ู…ุน ุชุทุจูŠู‚ ุงู„ุฎุตู… ุงู„ููˆุฑูŠ - ุงู„ุญู‚ูˆู„ ุงู„ู…ุชุฃุซุฑุฉ: "price"ุŒ ูˆ"productDiscountRate"", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FavoriteProductListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/favorites/{productId}": { + "delete": { + "summary": "ุญุฐู ุงู„ู…ูุถู„ุฉ", + "operationId": "deleteMyFavorite", + "tags": [ + "favorite" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุงู„ุญุฐู" + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + }, + "put": { + "summary": "ุฅุถุงูุฉ ุงู„ู…ูุถู„ุฉ", + "operationId": "addMyFavorite", + "tags": [ + "favorite" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุงู„ุฅุถุงูุฉ" + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/best/products": { + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ุฃูุถู„ ุงู„ู…ู†ุชุฌุงุช ู„ูุชุฑุฉ ู…ุญุฏุฏุฉ ุงู„ุฃุฎูŠุฑุฉ", + "operationId": "getBestAppProducts", + "tags": [ + "best" + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "required": true, + "description": "ุฃูุถู„ ุงู„ู…ู†ุชุฌุงุช ู„ู‡ุฐู‡ ุงู„ูุชุฑุฉ", + "name": "period", + "schema": { + "$ref": "#/components/schemas/BestPeriodEnum" + } + }, + { + "in": "query", + "required": false, + "name": "categoryId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "description": "ุฑู…ุฒ ุงู„ุนู…ุฑ.", + "required": false, + "name": "ageGroupCode", + "schema": { + "$ref": "#/components/schemas/AgeGroupCodeEnum" + } + } + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- ุงุญุตู„ ุนู„ู‰ ุฃูุถู„ ุงู„ู…ู†ุชุฌุงุช ู„ูุชุฑุฉ ู…ุญุฏุฏุฉ ุญุฏูŠุซุฉ - ุฅุฐุง ุชู… ุชุทุจูŠู‚ ุงู„ุฎุตู… ุงู„ููˆุฑูŠ ู„ู€ QueenitุŒ ูุฅู† `AppProductDto` ูŠุนุฑุถ ุงู„ู…ุจู„ุบ ู…ุน ุงู„ุฎุตู… ุงู„ููˆุฑูŠ ุงู„ู…ุทุจู‚ - ุงู„ุญู‚ูˆู„ ุงู„ู…ุชุฃุซุฑุฉ: `finalPrice`ุŒ `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/best/brands/v2": { + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ุฃูุถู„ ุงู„ุนู„ุงู…ุงุช ุงู„ุชุฌุงุฑูŠุฉ ู„ูุชุฑุฉ ู…ุญุฏุฏุฉ ุงู„ุฃุฎูŠุฑุฉ", + "operationId": "getBestAppBrands", + "tags": [ + "best" + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "required": true, + "description": "ุฃูุถู„ ุงู„ุนู„ุงู…ุงุช ุงู„ุชุฌุงุฑูŠุฉ ู„ู‡ุฐู‡ ุงู„ูุชุฑุฉ", + "name": "period", + "schema": { + "$ref": "#/components/schemas/BestPeriodEnum" + } + }, + { + "in": "query", + "description": "ุฑู…ุฒ ุงู„ุนู…ุฑ.", + "required": false, + "name": "ageGroupCode", + "schema": { + "$ref": "#/components/schemas/AgeGroupCodeEnum" + } + } + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงุญุตู„ ุนู„ู‰ ุฃูุถู„ ุงู„ุนู„ุงู…ุงุช ุงู„ุชุฌุงุฑูŠุฉ ู„ูุชุฑุฉ ู…ุญุฏุฏุฉ ุงู„ุฃุฎูŠุฑุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BestBrandListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/best/WooRanking": { + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ู…ู†ุชุฌุงุช ุฐุงุช ุชุตู†ูŠู ุฑุงุฆุน - ุชู… ุฅู‡ู…ุงู„ู‡ุง", + "operationId": "getWooRankingProducts", + "tags": [ + "best" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "ู…ู†ุชุฌุงุช ุชุตู†ูŠู ูˆูˆ - ุชู… ุฅู‡ู…ุงู„ู‡ุง", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/promotions/brands": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุงู„ุนู„ุงู…ุงุช ุงู„ุชุฌุงุฑูŠุฉ ุงู„ุชุฑูˆูŠุฌูŠุฉ", + "operationId": "getPromotedBrands", + "tags": [ + "promotion" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ุนู„ุงู…ุงุช ุงู„ุชุฌุงุฑูŠุฉ ุงู„ุชุฑูˆูŠุฌูŠุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BrandListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/promotions/products": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู…ู†ุชุฌุงุช ุงู„ุชุฑูˆูŠุฌ", + "operationId": "getPromotionProducts", + "tags": [ + "promotion" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "- ุงู„ู…ู†ุชุฌุงุช ุงู„ุชุฑูˆูŠุฌูŠุฉ - ุฅุฐุง ุชู… ุชุทุจูŠู‚ ุฎุตู… Queenit ุงู„ููˆุฑูŠุŒ ูุฅู† `ProductDto` ูŠุนุฑุถ ุงู„ู…ุจู„ุบ ู…ุน ุงู„ุฎุตู… ุงู„ููˆุฑูŠ ุงู„ู…ุทุจู‚ - ุงู„ุญู‚ูˆู„ ุงู„ู…ุชุฃุซุฑุฉ: `finalPrice`ุŒ `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/promotions/connect-pay": { + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ุนุฑูˆุถ Connect Pay ุงู„ุชุฑูˆูŠุฌูŠุฉ", + "operationId": "getConnectPayPromotions", + "tags": [ + "promotion" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ุนุฑูˆุถ ุงู„ุชุฑูˆูŠุฌูŠุฉ ู„ุฎุตู… ุจุทุงู‚ุฉ Connect-Pay ูˆุณูŠุงุณุงุช ุงู„ุชู‚ุณูŠุท ุจุฏูˆู† ููˆุงุฆุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectPayPromotionDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/promotions/toss": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุงู„ุนุฑูˆุถ ุงู„ุชุฑูˆูŠุฌูŠุฉ ู„ู„ู…ุฏููˆุนุงุช", + "operationId": "getTossPromotions", + "tags": [ + "promotion" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุฅุฑู… ุณูŠุงุณุงุช ุงู„ุนุฑูˆุถ ุงู„ุชุฑูˆูŠุฌูŠุฉ ู„ู„ุฎุตู… ูˆุณูŠุงุณุงุช ุงู„ุชู‚ุณูŠุท ุจุฏูˆู† ููˆุงุฆุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TossPaymentPromotionDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/newArrivals/products": { + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ู…ู†ุชุฌุงุช ูˆุตูˆู„ ุฌุฏูŠุฏุฉ - ุชู… ุฅู‡ู…ุงู„ู‡ุง", + "operationId": "getNewArrivalProducts", + "tags": [ + "newArrival" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "ู…ู†ุชุฌุงุช ุฌุฏูŠุฏุฉ - ู…ู‡ู…ู„ุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/promotions/products/discounted": { + "get": { + "deprecated": true, + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "description": "ูŠุฑุฌู‰ ุถุจุท orderBy ุนู„ู‰ RECOMMENDATION ูƒู‚ูŠู…ุฉ ุงูุชุฑุงุถูŠุฉ.", + "name": "orderBy", + "required": true, + "schema": { + "$ref": "#/components/schemas/ProductOrderByEnum" + } + }, + { + "in": "query", + "required": false, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ], + "summary": "ุงุญุตู„ ุนู„ู‰ ู…ู†ุชุฌุงุช ุชุฑูˆูŠุฌูŠุฉ ู…ุฎูุถุฉ ุญุณุจ ู…ุนู„ู…ุงุช ุงู„ุทู„ุจ", + "operationId": "getDiscountedPromotionProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- ู…ู†ุชุฌุงุช ุชุฑูˆูŠุฌูŠุฉ ู…ุฎูุถุฉ ุญุณุจ ู…ุนู„ู…ุงุช orderBy - ุฅุฐุง ุชู… ุชุทุจูŠู‚ ุงู„ุฎุตู… ุงู„ููˆุฑูŠ ู„ู€ QueenitุŒ ูุฅู† `AppProductDto` ูŠุนุฑุถ ุงู„ู…ุจู„ุบ ู…ุน ุงู„ุฎุตู… ุงู„ููˆุฑูŠ ุงู„ู…ุทุจู‚ - ุงู„ุญู‚ูˆู„ ุงู„ู…ุชุฃุซุฑุฉ: `finalPrice`ุŒ `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/discount-benefits": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช ููˆุงุฆุฏ ุงู„ุฎุตู… ู„ู„ู…ู†ุชุฌ", + "operationId": "getProductDiscountBenefits", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "ู†ุชูŠุฌุฉ ู…ุนู„ูˆู…ุงุช ููˆุงุฆุฏ ุงู„ุฎุตู… ู„ู„ู…ู†ุชุฌ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductDiscountBenefitsDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/shopping-mall": { + "get": { + "deprecated": true, + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "description": "ูŠุฑุฌู‰ ุถุจุท orderBy ุนู„ู‰ RECOMMENDATION ูƒู‚ูŠู…ุฉ ุงูุชุฑุงุถูŠุฉ.", + "name": "orderBy", + "required": true, + "schema": { + "$ref": "#/components/schemas/ProductOrderByEnum" + } + }, + { + "in": "query", + "required": false, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ], + "summary": "ุงุญุตู„ ุนู„ู‰ ู…ู†ุชุฌุงุช ู…ุฑุงูƒุฒ ุงู„ุชุณูˆู‚ ุญุณุจ ู…ุนู„ู…ุงุช ุงู„ุทู„ุจ", + "operationId": "getShoppingMallProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- ู…ู†ุชุฌุงุช ู…ุฑุงูƒุฒ ุงู„ุชุณูˆู‚ ุญุณุจ ู…ุนู„ู…ุงุช orderBy - ุนู†ุฏ ุชุทุจูŠู‚ ุงู„ุฎุตู… ุงู„ููˆุฑูŠ ู„ู€ QueenitุŒ ูŠุนุฑุถ `AppProductDto' ุงู„ู…ุจู„ุบ ู…ุน ุงู„ุฎุตู… ุงู„ููˆุฑูŠ ุงู„ู…ุทุจู‚ - ุงู„ุญู‚ูˆู„ ุงู„ู…ุชุฃุซุฑุฉ: `finalPrice`ุŒ `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/keyword-related": { + "get": { + "summary": "ุฅุฑุฌุงุน ุงู„ู…ู†ุชุฌุงุช ุฐุงุช ุงู„ุตู„ุฉ ูˆูู‚ู‹ุง ู„ู„ูƒู„ู…ุงุช ุงู„ุฑุฆูŠุณูŠุฉ.", + "operationId": "getKeywordRelatedProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "name": "keyword", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "verbose", + "required": false, + "schema": { + "description": "ู…ุนู„ู…ุงุช ุงู„ุชุตุญูŠุญ. ุฅุฐุง ูƒุงู†ุช ุงู„ู‚ูŠู…ุฉ ุตุญูŠุญุฉุŒ ูุณูŠุชู… ุชุณุฌูŠู„ ุงู„ุณุฌู„ ุจู…ุฒูŠุฏ ู…ู† ุงู„ุชูุงุตูŠู„..", + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "ู†ุชุงุฆุฌ ุงู„ู…ู†ุชุฌุงุช ุฐุงุช ุงู„ุตู„ุฉ ุจุงู„ูƒู„ู…ุงุช ุงู„ุฑุฆูŠุณูŠุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/related": { + "get": { + "summary": "ุฅุฑุฌุงุน ุงู„ู…ู†ุชุฌุงุช ุฐุงุช ุงู„ุตู„ุฉ ุจู†ุงุกู‹ ุนู„ู‰ ุดุฑูˆุท ู…ุญุฏุฏุฉ.", + "operationId": "getRelatedProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "name": "brandId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "categoryId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "relationTargetProductIds", + "description": "ุฅุฑุฌุงุน ุงู„ู…ู†ุชุฌุงุช ุงู„ู…ุฑุชุจุทุฉ ุจุงู„ู…ู†ุชุฌุงุช ุงู„ุชูŠ ุชู… ุชู…ุฑูŠุฑู‡ุง ููŠ ู‡ุฐู‡ ุงู„ู…ุนู„ู…ุฉ..", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "name": "verbose", + "required": false, + "schema": { + "description": "ู…ุนู„ู…ุงุช ุงู„ุชุตุญูŠุญ. ุฅุฐุง ูƒุงู†ุช ุงู„ู‚ูŠู…ุฉ ุตุญูŠุญุฉุŒ ูุณูŠุชู… ุชุณุฌูŠู„ ุงู„ุณุฌู„ ุจู…ุฒูŠุฏ ู…ู† ุงู„ุชูุงุตูŠู„..", + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "ู†ุชุงุฆุฌ ุงู„ู…ู†ุชุฌุงุช ุฐุงุช ุงู„ุตู„ุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/personalized/products": { + "post": { + "deprecated": true, + "summary": "ุงุญุตู„ ุนู„ู‰ ู…ู†ุชุฌุงุช ุดุฎุตูŠุฉ ุชู…ุช ุชุตููŠุชู‡ุง", + "operationId": "getFilteredPersonalizedProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FilteredPersonalizedProductRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "- ุงุญุตู„ ุนู„ู‰ ู…ู†ุชุฌุงุช ู…ุฎุตุตุฉ ุชู…ุช ุชุตููŠุชู‡ุง ุญุณุจ ุงู„ู…ุนู„ู…ุงุช", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + }, + "get": { + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "description": "ูŠุฑุฌู‰ ุถุจุท orderBy ุนู„ู‰ RECOMMENDATION ูƒู‚ูŠู…ุฉ ุงูุชุฑุงุถูŠุฉ.", + "name": "orderBy", + "required": false, + "schema": { + "$ref": "#/components/schemas/ProductOrderByEnum" + } + }, + { + "in": "query", + "required": false, + "name": "categoryId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "required": false, + "name": "brandId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "description": "ุฑู…ุฒ ุงู„ุนู…ุฑ.", + "required": false, + "name": "ageGroupCode", + "schema": { + "$ref": "#/components/schemas/AgeGroupCodeEnum" + } + }, + { + "in": "query", + "required": false, + "name": "minPrice", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "maxPrice", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "mySizeOnly", + "schema": { + "type": "boolean" + } + }, + { + "in": "query", + "required": false, + "name": "tagId", + "deprecated": true, + "schema": { + "type": "integer", + "description": "(ู…ู‡ู…ู„) ุงุณุชุฎุฏู… tagIdForBrandSourcing", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "tagIdForBrandSourcing", + "schema": { + "description": "ุงุจุญุซ ุนู† ุงู„ู…ู†ุชุฌุงุช ุนู† BrandSourcingCode ุงู„ู…ุชูˆุงูู‚ ู…ุน tagId", + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "clickedProductIds", + "description": "- ุงู„ู…ู†ุชุฌุงุช ุงู„ุชูŠ ุชู… ุงู„ู†ู‚ุฑ ุนู„ูŠู‡ุง. ูŠุชู… ุงุณุชุฎุฏุงู…ู‡ ู„ุชูˆููŠุฑ ุงู„ู…ู†ุชุฌุงุช ุงู„ุดุฎุตูŠุฉ. - ูŠุฌุจ ุชู…ุฑูŠุฑ ุงู„ู…ุนู„ู…ุฉ clickedProductAtMillis ู…ุนู‹ุง ู„ู†ู‚ู„ ุงู„ู…ุนู„ูˆู…ุงุช ุญูˆู„ ูˆู‚ุช ุงู„ู†ู‚ุฑ ุนู„ู‰ ูƒู„ ู…ู†ุชุฌ..", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "required": false, + "name": "clickedProductAtMillis", + "description": "- ุงู„ุฃูˆู‚ุงุช ุงู„ุชูŠ ุชู… ููŠู‡ุง ุงู„ู†ู‚ุฑ ุนู„ู‰ ุงู„ู…ู†ุชุฌุงุช. ุชุชูˆุงูู‚ ูƒู„ ู…ุฑุฉ ู…ุน ู…ุนู„ู…ุฉ ClickedProductIds. - ูŠุฌุจ ุฃู† ูŠูƒูˆู† ุญุฌู… ู…ุนู„ู…ุงุช ClickedProductIds ูˆู…ุนู„ู…ุงุช ClickedProductAtMillis ู‡ูˆ ู†ูุณู‡ ุฏุงุฆู…ู‹ุง..", + "schema": { + "type": "array", + "items": { + "type": "number", + "format": "int64" + } + } + }, + { + "in": "query", + "required": false, + "name": "modelId", + "description": "- ู…ุง ู‡ูˆ ู†ู…ูˆุฐุฌ ุงู„ุชุฎุตูŠุต ุงู„ุฐูŠ ูŠุฌุจ ุงุณุชุฎุฏุงู…ู‡ุŸ (ู„ุงุฎุชุจุงุฑ A/B) - ู…ุฑุฌุน ุงู„ููƒุฑุฉ: https://www.notion.so/rapportlabs/AB-Protocol-c878d879ff0443cda929bb17d9b137c1", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "required": false, + "name": "postProcessingId", + "description": "- ูƒูŠููŠุฉ ุงู„ู…ุนุงู„ุฌุฉ ุงู„ู„ุงุญู‚ุฉ ู„ู†ุชุงุฆุฌ ุงู„ุชุฎุตูŠุต. (ู„ุงุฎุชุจุงุฑ A/B) - ู…ุฑุฌุน ุงู„ููƒุฑุฉ: https://www.notion.so/rapportlabs/AB-Protocol-c878d879ff0443cda929bb17d9b137c1", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "verbose", + "required": false, + "schema": { + "description": "ู…ุนู„ู…ุงุช ุงู„ุชุตุญูŠุญ. ุฅุฐุง ูƒุงู†ุช ุงู„ู‚ูŠู…ุฉ ุตุญูŠุญุฉุŒ ูุณูŠุชู… ุชุณุฌูŠู„ ุงู„ุณุฌู„ ุจู…ุฒูŠุฏ ู…ู† ุงู„ุชูุงุตูŠู„..", + "default": false, + "type": "boolean" + } + } + ], + "summary": "ุงุญุตู„ ุนู„ู‰ ู…ู†ุชุฌุงุช ุชูˆุตูŠุฉ ู…ุฎุตุตุฉ ุญุณุจ ุงู„ูู„ุชุฑ", + "operationId": "getPersonalizedRecommendationProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- ุงุญุตู„ ุนู„ู‰ ู…ู†ุชุฌุงุช ุชูˆุตูŠุฉ ู…ุฎุตุตุฉ ุญุณุจ ุนูˆุงู…ู„ ุงู„ุชุตููŠุฉ ูˆุงู„ุชุฑุชูŠุจ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/refined": { + "get": { + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "description": "ูŠุฑุฌู‰ ุถุจุท orderBy ุนู„ู‰ RECOMMENDATION ูƒู‚ูŠู…ุฉ ุงูุชุฑุงุถูŠุฉ.", + "name": "orderBy", + "required": true, + "schema": { + "$ref": "#/components/schemas/ProductOrderByEnum" + } + }, + { + "in": "query", + "required": false, + "name": "categoryId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "required": false, + "name": "categoryIds", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "required": false, + "name": "brandId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "required": false, + "name": "brandIds", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "description": "ุฑู…ุฒ ุงู„ุนู…ุฑ.", + "required": false, + "name": "ageGroupCode", + "schema": { + "$ref": "#/components/schemas/AgeGroupCodeEnum" + } + }, + { + "in": "query", + "required": false, + "name": "minPrice", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "maxPrice", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "mySizeOnly", + "schema": { + "type": "boolean" + } + }, + { + "in": "query", + "description": "ู‚ุงุฆู…ุฉ ู…ุนุฑูุงุช ุณู…ุงุช ุงู„ู…ู†ุชุฌ ู„ู„ุชุตููŠุฉ", + "required": false, + "name": "productFeatureIds", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "deprecated": true, + "required": false, + "description": "(ู…ู‡ู…ู„) ุงุณุชุฎุฏู… EnableTotalCountุŒ EnableProductFeatureAggregationุŒ EnableProductCategoryAggregationุŒ EnableBrandAggregation.", + "name": "enabledProductAggregation", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "ุงุถุจุท ุนู„ู‰ "ุตุญูŠุญ" ุฅุฐุง ูƒุงู† ุงู„ุนุฏุฏ ุงู„ุฅุฌู…ุงู„ูŠ ู…ุทู„ูˆุจู‹ุง ููŠ ุชุฌู…ูŠุน ุงู„ู…ู†ุชุฌ..", + "name": "enabledTotalCount", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "ุงุถุจุท ุนู„ู‰ "ุตุญูŠุญ" ุฅุฐุง ูƒุงู† ุนุฏุฏ ุณู…ุงุช ุงู„ู…ู†ุชุฌ ู…ุทู„ูˆุจู‹ุง ููŠ ุชุฌู…ูŠุน ุงู„ู…ู†ุชุฌ..", + "name": "enabledProductFeatureAggregation", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "ู‚ู… ุจุงู„ุชุนูŠูŠู† ุนู„ู‰ "ุตุญูŠุญ" ุฅุฐุง ูƒุงู† ุนุฏุฏ ุงู„ู…ู†ุชุฌุงุช ู„ูƒู„ ูุฆุฉ ู…ุทู„ูˆุจู‹ุง ููŠ ุชุฌู…ูŠุน ุงู„ู…ู†ุชุฌุงุช..", + "name": "enabledProductCategoryAggregation", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "ู‚ู… ุจุงู„ุชุนูŠูŠู† ุนู„ู‰ "ุตุญูŠุญ" ุฅุฐุง ูƒุงู† ุนุฏุฏ ุงู„ุนู„ุงู…ุงุช ุงู„ุชุฌุงุฑูŠุฉ ู…ุทู„ูˆุจู‹ุง ููŠ ุชุฌู…ูŠุน ุงู„ู…ู†ุชุฌุงุช..", + "name": "enabledBrandAggregation", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "deprecated": true, + "description": "(ู…ู‡ู…ู„) ุงุณุชุฎุฏู… ุงู„ู…ุนู„ู…ุฉ tagIdForBrandSourcing", + "name": "tagId", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "tagIdForBrandSourcing", + "schema": { + "description": "ุงุจุญุซ ุนู† ุงู„ู…ู†ุชุฌุงุช ุนู† BrandSourcingCode ุงู„ู…ุชูˆุงูู‚ ู…ุน tagId", + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "description": "ู…ุนุฑูุงุช ู„ู…ุฑุดุญ ุนู„ุงู…ุฉ ุงู„ู…ู†ุชุฌ", + "name": "tagIdsForProductTag", + "schema": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + } + }, + { + "in": "query", + "required": false, + "description": "ู…ุนู„ู…ุฉ ู„ูƒุดู ุงู„ู…ู†ุชุฌุงุช ุงู„ุชูŠ ู„ุง ุชุญุชูˆูŠ ุนู„ู‰ ุนู„ุงู…ุงุช ุงู„ู…ู†ุชุฌ ุฃูŠุถู‹ุง", + "name": "allowProductsWithoutTags", + "schema": { + "type": "boolean" + } + } + ], + "summary": "ุงุญุตู„ ุนู„ู‰ ุงู„ู…ู†ุชุฌุงุช ุงู„ู…ูƒุฑุฑุฉ ุญุณุจ ุนูˆุงู…ู„ ุงู„ุชุตููŠุฉ ูˆุงู„ุชุฑุชูŠุจ", + "operationId": "getRefinedProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- ุงุญุตู„ ุนู„ู‰ ุงู„ู…ู†ุชุฌุงุช ุงู„ู…ูƒุฑุฑุฉ ุญุณุจ ุนุงู…ู„ ุงู„ุชุตููŠุฉ ูˆู…ุนู„ู…ุงุช orderBy - ุฅุฐุง ุชู… ุชุทุจูŠู‚ ุงู„ุฎุตู… ุงู„ููˆุฑูŠ ู„ู€ QueenitุŒ ูุฅู† `AppProductDto` ูŠุนุฑุถ ุงู„ู…ุจู„ุบ ู…ุน ุงู„ุฎุตู… ุงู„ููˆุฑูŠ ุงู„ู…ุทุจู‚ - ุงู„ุญู‚ูˆู„ ุงู„ู…ุชุฃุซุฑุฉ: `finalPrice`ุŒ `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/advertisement": { + "get": { + "parameters": [ + { + "in": "header", + "name": "page", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "description": "ูŠุฑุฌู‰ ุถุจุท orderBy ุนู„ู‰ RECOMMENDATION ูƒู‚ูŠู…ุฉ ุงูุชุฑุงุถูŠุฉ.", + "name": "orderBy", + "required": false, + "schema": { + "$ref": "#/components/schemas/ProductOrderByEnum" + } + }, + { + "in": "query", + "required": false, + "name": "categoryId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "required": false, + "name": "minPrice", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "maxPrice", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "mySizeOnly", + "schema": { + "type": "boolean" + } + } + ], + "summary": "ุงุญุตู„ ุนู„ู‰ ู…ู†ุชุฌุงุช ุฅุนู„ุงู†ูŠุฉ ุญุณุจ ุนูˆุงู…ู„ ุงู„ุชุตููŠุฉ ูˆุงู„ุชุฑุชูŠุจ", + "operationId": "getAdvertisementProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- ุงุญุตู„ ุนู„ู‰ ู…ู†ุชุฌุงุช ุฅุนู„ุงู†ูŠุฉ ุญุณุจ ุนูˆุงู…ู„ ุงู„ุชุตููŠุฉ ูˆุงู„ุชุฑุชูŠุจ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAdvertisementProductListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/detail/advertisement": { + "get": { + "parameters": [ + { + "in": "query", + "required": false, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ], + "summary": "ุงุญุตู„ ุนู„ู‰ ู…ู†ุชุฌุงุช ุฅุนู„ุงู†ูŠุฉ ุญุณุจ ุนูˆุงู…ู„ ุงู„ุชุตููŠุฉ ูˆุงู„ุชุฑุชูŠุจ", + "operationId": "getAdvertisementProductDetail", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- ุงู„ุญุตูˆู„ ุนู„ู‰ ุงู„ู…ู†ุชุฌุงุช ุงู„ุฅุนู„ุงู†ูŠุฉ ููŠ PDP", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAdvertisementProductListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products": { + "get": { + "parameters": [ + { + "in": "query", + "required": true, + "name": "ids", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุงู„ู…ู†ุชุฌุงุช ุญุณุจ ู…ุนู„ู…ุฉ ids", + "description": "(ุนุฏุฏ ุงู„ู…ุนุฑูุงุช ูŠุฒูŠุฏ ุนู† 40 -> ApiErrorResponseCode.LIMITATION_EXCEEDED)", + "operationId": "getProducts", + "tags": [ + "product" + ], + "responses": { + "200": { + "description": "- ุงู„ู…ู†ุชุฌุงุช (ุงู„ูุฑูŠุฏุฉ ูˆุบูŠุฑ ุงู„ู…ุทู„ูˆุจุฉ) ุญุณุจ ุงู„ู…ุนุฑูุงุช - ุฅุฐุง ุชู… ุชุทุจูŠู‚ ุฎุตู… Queenit ุงู„ููˆุฑูŠุŒ ูุฅู† `ProductDto` ูŠุนุฑุถ ุงู„ู…ุจู„ุบ ู…ุน ุงู„ุฎุตู… ุงู„ููˆุฑูŠ ุงู„ู…ุทุจู‚ - ุงู„ุญู‚ูˆู„ ุงู„ู…ุชุฃุซุฑุฉ: `finalPrice`ุŒ `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductSetDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/similar/v2": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู…ู†ุชุฌ ู…ู…ุงุซู„ ูŠุนุชู…ุฏ ุนู„ู‰ ุงู„ุตูˆุฑ (ุงู„ุฅุตุฏุงุฑ ุงู„ุซุงู†ูŠ)", + "operationId": "getImageBasedSimilarProductsV2", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minRating", + "schema": { + "type": "number", + "format": "int32" + } + }, + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "name": "modelId", + "required": false, + "description": "ุงู„ู†ู…ูˆุฐุฌ ุงู„ุฐูŠ ู„ู„ุงุณุชุฎุฏุงู…. https://www.notion.so/rapportlabs/AB-Protocol-c878d879ff0443cda929bb17d9b137c1?pvs=4", + "schema": { + "type": "string", + "default": "TAG_SIM" + } + }, + { + "in": "query", + "name": "postProcessingId", + "description": "ูƒูŠููŠุฉ ุงู„ู‚ูŠุงู… ุจู…ุฑุญู„ุฉ ู…ุง ุจุนุฏ ุงู„ู…ุนุงู„ุฌุฉ. https://www.notion.so/rapportlabs/AB-Protocol-c878d879ff0443cda929bb17d9b137c1?pvs=4", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "verbose", + "required": false, + "schema": { + "description": "ู…ุนู„ู…ุงุช ุงู„ุชุตุญูŠุญ. ุฅุฐุง ูƒุงู†ุช ุงู„ู‚ูŠู…ุฉ ุตุญูŠุญุฉุŒ ูุณูŠุชู… ุชุณุฌูŠู„ ุงู„ุณุฌู„ ุจู…ุฒูŠุฏ ู…ู† ุงู„ุชูุงุตูŠู„..", + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "- ุชู†ุฒูŠู„ ู…ู†ุชุฌุงุช ู…ู…ุงุซู„ุฉ ุจู†ุงุกู‹ ุนู„ู‰ ุงู„ุตูˆุฑ. (ู†ุฎุทุท ู„ู…ู‚ุงุฑู†ุชู‡ ุจุงู„ุฅุตุฏุงุฑ 1 ูˆุฅู‡ู…ุงู„ ุฅุตุฏุงุฑุงุช ู…ุนูŠู†ุฉ ุงุนุชู…ุงุฏู‹ุง ุนู„ู‰ ุงู„ู†ุชุงุฆุฌ)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/similar": { + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ู…ู†ุชุฌ ู…ู…ุงุซู„ ูŠุนุชู…ุฏ ุนู„ู‰ ุงู„ุตูˆุฑุฉ", + "operationId": "getImageBasedSimilarProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minRating", + "required": true, + "schema": { + "type": "number", + "format": "int32" + } + }, + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "- ุชู†ุฒูŠู„ ู…ู†ุชุฌุงุช ู…ู…ุงุซู„ุฉ ุจู†ุงุกู‹ ุนู„ู‰ ุงู„ุตูˆุฑ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/outfit": { + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ู…ู†ุชุฌ ุงู„ุฒูŠ ุงู„ู‚ุงุฆู… ุนู„ู‰ ุงู„ุตูˆุฑุฉ", + "operationId": "getImageBasedOutfitProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minRating", + "required": true, + "schema": { + "type": "number", + "format": "int32" + } + }, + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "- ูŠูˆูุฑ ู…ู†ุชุฌุงุช ุงู„ุชู†ุณูŠู‚ ุงู„ู‚ุงุฆู…ุฉ ุนู„ู‰ ุงู„ุตูˆุฑ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/hotDeals/products": { + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ู…ู†ุชุฌุงุช hotDeal", + "operationId": "getHotDealProducts", + "tags": [ + "hotDeal" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "- ู…ู†ุชุฌุงุช ุงู„ุตูู‚ุงุช ุงู„ุณุงุฎู†ุฉ - ุนู†ุฏ ุชุทุจูŠู‚ ุฎุตู… Queenit ุงู„ููˆุฑูŠุŒ ูŠุนุฑุถ `ProductDto` ุงู„ู…ุจู„ุบ ู…ุน ุชุทุจูŠู‚ ุงู„ุฎุตู… ุงู„ููˆุฑูŠ - ุงู„ุญู‚ูˆู„ ุงู„ู…ุชุฃุซุฑุฉ: `ุงู„ุณุนุฑ ุงู„ู†ู‡ุงุฆูŠ`ุŒ `ุงู„ู†ุณุจุฉ ุงู„ู…ุฆูˆูŠุฉ ู„ู„ุฎุตู…`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/recommendations/categories": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ูุฆุงุช ุงู„ู…ู†ุชุฌุงุช ุงู„ู…ูˆุตู‰ ุจู‡ุง", + "operationId": "getRecommendationCategories", + "tags": [ + "recommendation" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ูุฆุงุช ุงู„ุชูˆุตูŠุฉ", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/recommendations/categories/{categoryId}/products": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุงู„ู…ู†ุชุฌุงุช ุงู„ู…ูˆุตู‰ ุจู‡ุง", + "operationId": "getRecommendedProductsByCategory", + "tags": [ + "recommendation" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "- ุงู„ู…ู†ุชุฌุงุช ุงู„ู…ูˆุตู‰ ุจู‡ุง - ุนู†ุฏ ุชุทุจูŠู‚ ุฎุตู… Queenit ุงู„ููˆุฑูŠุŒ ูŠุนุฑุถ `ProductDto` ุงู„ู…ุจู„ุบ ู…ุน ุชุทุจูŠู‚ ุงู„ุฎุตู… ุงู„ููˆุฑูŠ - ุงู„ุญู‚ูˆู„ ุงู„ู…ุชุฃุซุฑุฉ: `ุงู„ุณุนุฑ ุงู„ู†ู‡ุงุฆูŠ`ุŒ `ุงู„ู†ุณุจุฉ ุงู„ู…ุฆูˆูŠุฉ ู„ู„ุฎุตู…`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/recommendations/products": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุงู„ู…ู†ุชุฌุงุช ุงู„ู…ูˆุตู‰ ุจู‡ุง", + "operationId": "getRecommendedProducts", + "tags": [ + "recommendation" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "- ุงู„ู…ู†ุชุฌุงุช ุงู„ู…ูˆุตู‰ ุจู‡ุง - ุนู†ุฏ ุชุทุจูŠู‚ ุฎุตู… Queenit ุงู„ููˆุฑูŠุŒ ูŠุนุฑุถ `ProductDto` ุงู„ู…ุจู„ุบ ู…ุน ุชุทุจูŠู‚ ุงู„ุฎุตู… ุงู„ููˆุฑูŠ - ุงู„ุญู‚ูˆู„ ุงู„ู…ุชุฃุซุฑุฉ: `ุงู„ุณุนุฑ ุงู„ู†ู‡ุงุฆูŠ`ุŒ `ุงู„ู†ุณุจุฉ ุงู„ู…ุฆูˆูŠุฉ ู„ู„ุฎุตู…`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/tag-groups": { + "get": { + "parameters": [ + { + "in": "query", + "name": "type", + "required": true, + "schema": { + "$ref": "#/components/schemas/TagTypeEnum" + } + } + ], + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู…ุฌู…ูˆุนุงุช ุงู„ุนู„ุงู…ุงุช ุญุณุจ ุงู„ู†ูˆุน", + "description": "ุงุณุชุฑุฏุงุฏ ู…ุนู„ูˆู…ุงุช ู…ุฌู…ูˆุนุฉ ุงู„ุนู„ุงู…ุงุช ูˆูู‚ู‹ุง ู„ู„ู…ุนู„ู…ุงุช", + "operationId": "getTagGroups", + "tags": [ + "tag" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ู‚ุงุฆู…ุฉ ู…ุฌู…ูˆุนุฉ ุงู„ุนู„ุงู…ุงุช", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagGroupListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/tags": { + "get": { + "parameters": [ + { + "in": "query", + "name": "type", + "required": false, + "schema": { + "$ref": "#/components/schemas/TagTypeEnum" + } + }, + { + "in": "query", + "name": "groupId", + "required": false, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุงู„ุนู„ุงู…ุงุช", + "description": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช ุงู„ุนู„ุงู…ุฉ.", + "operationId": "getTags", + "tags": [ + "tag" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช ุงู„ุนู„ุงู…ุฉ ูˆูู‚ุง ู„ู„ุดุฑูˆุท.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/release-estimate": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ุฅุตุฏุงุฑ ุชู‚ุฏูŠุฑ ุงู„ู…ู†ุชุฌ ููŠ", + "operationId": "getProductEstimateRelease", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุชุชุจุน ุฅุตุฏุงุฑ ุชู‚ุฏูŠุฑ ุงู„ู…ู†ุชุฌ ุงู„ู†ุงุฌุญ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReleaseEstimateDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/products/{productId}/page": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "ุชุญู…ูŠู„ ุตูุญุฉ ุงู„ู…ู†ุชุฌ", + "operationId": "uploadProductPage", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UploadProductPageRequest" + } + } + } + }, + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ู„ู„ุชุญู…ูŠู„" + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/products/{productId}": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุงู„ู…ู†ุชุฌ", + "operationId": "getProduct", + "description": "(ู„ุง ูŠู…ูƒู† ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ู…ู†ุชุฌ -> ApiErrorResponseCode.RESOURCE_NOT_FOUND)", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- ุงู„ู…ู†ุชุฌ - ุฅุฐุง ุชู… ุชุทุจูŠู‚ ุฎุตู… Queenit ุงู„ููˆุฑูŠุŒ ูุฅู† `ProductDto` ูŠุนุฑุถ ุงู„ู…ุจู„ุบ ู…ุน ุงู„ุฎุตู… ุงู„ููˆุฑูŠ ุงู„ู…ุทุจู‚ - ุงู„ุญู‚ูˆู„ ุงู„ู…ุชุฃุซุฑุฉ: `finalPrice`ุŒ `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/products/{productId}/personal": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุงู„ู…ู†ุชุฌ ุงู„ุดุฎุตูŠ", + "description": "(ู„ุง ูŠู…ูƒู† ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ู…ู†ุชุฌ -> ApiErrorResponseCode.RESOURCE_NOT_FOUND)", + "operationId": "getPersonalProduct", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- ุฅุฐุง ุชู… ุชุทุจูŠู‚ ุฎุตู… Queenit ุงู„ููˆุฑูŠุŒ ูุฅู† `ProductDto` ูŠุนุฑุถ ุงู„ู…ุจู„ุบ ู…ุน ุงู„ุฎุตู… ุงู„ููˆุฑูŠ ุงู„ู…ุทุจู‚ - ุงู„ุญู‚ูˆู„ ุงู„ู…ุชุฃุซุฑุฉ: `finalPrice`ุŒ `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PersonalProductDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/products/{productId}/items": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุนู†ุงุตุฑ ุงู„ู…ู†ุชุฌ", + "operationId": "getProductItems", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุชู… ุงู„ุจุญุซ ููŠ ู‚ุงุฆู…ุฉ ุนู†ุงุตุฑ ุงู„ู…ู†ุชุฌ (ุฎูŠุงุฑุงุช ุงู„ู…ู†ุชุฌ) ุจู†ุฌุงุญ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductItemListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/products/{productId}/item-availabilities": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู‚ุงุฆู…ุฉ ุชูˆูุฑ ุนู†ุงุตุฑ ุงู„ู…ู†ุชุฌ", + "description": "ุฅุฑุฌุงุน ู‚ุงุฆู…ุฉ ุจุฎูŠุงุฑุงุช ุงู„ู…ู†ุชุฌ ู„ู…ุฏู‰ ุชูˆูุฑ ุงู„ุดุฑุงุก ู„ู„ู…ู†ุชุฌ ุงู„ู…ู‚ุงุจู„", + "operationId": "getProductItemAvailabilityList", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ู‚ุงุฆู…ุฉ ุจุชูˆูุฑ ุฎูŠุงุฑุงุช ุงู„ู…ู†ุชุฌ", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductItemAvailabilityDto" + } + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/users/birth-year": { + "post": { + "summary": "ุญูุธ ุณู†ุฉ ุงู„ู…ูŠู„ุงุฏ ู„ู„ู…ุณุชุฎุฏู…", + "description": "ุญูุธ ุณู†ุฉ ุงู„ู…ูŠู„ุงุฏ ููŠ ู…ู„ู ุชุนุฑูŠู ุงู„ู…ุณุชุฎุฏู…", + "operationId": "saveUserBirthYear", + "tags": [ + "userProfile" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserBirthYearDto" + } + } + } + }, + "responses": { + "200": { + "description": "ุณู†ุฉ ู…ูŠู„ุงุฏ ุงู„ู…ุณุชุฎุฏู… ุงู„ู…ุญููˆุธุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserBirthYearDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/users/body-size": { + "post": { + "summary": "ุญูุธ ุญุฌู… ุงู„ุฌุณู… ู„ู„ู…ุณุชุฎุฏู…", + "description": "ุญูุธ ุญุฌู… ุงู„ุฌุณู…", + "operationId": "saveUserBodySize", + "tags": [ + "userProfile" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserBodySizeDataDto" + } + } + } + }, + "responses": { + "200": { + "description": "ุญูุธ ุญุฌู… ุงู„ุฌุณู… ู„ู„ู…ุณุชุฎุฏู…", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserBodySizeDataDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/users/profile": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู…ู„ู ุชุนุฑูŠู ุงู„ู…ุณุชุฎุฏู…", + "description": "(ู„ุง ูŠู…ูƒู† ุงู„ุนุซูˆุฑ ุนู„ู‰ ู…ู„ู ุชุนุฑูŠู ุงู„ู…ุณุชุฎุฏู… -> ApiErrorResponseCode.RESOURCE_NOT_FOUND)", + "operationId": "getUserProfile", + "tags": [ + "userProfile" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ู…ู„ู ุชุนุฑูŠู ุงู„ู…ุณุชุฎุฏู…", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserProfileDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/users/delivery-addresses": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุนู†ูˆุงู† ุชุณู„ูŠู… ุงู„ู…ุณุชุฎุฏู…", + "description": "ุงุณุชุฑุฏุงุฏ ุงู„ู‚ุงุฆู…ุฉ ุงู„ูƒุงู…ู„ุฉ ู„ุนู†ุงูˆูŠู† ุงู„ุดุญู† ุงู„ุฎุงุตุฉ ุจุงู„ู…ุณุชุฎุฏู… (ู…ุตู†ูุฉ ุญุณุจ "ุชู… ุงู„ุงุณุชุฑุฌุงุน")", + "operationId": "getUserDeliveryAddresses", + "tags": [ + "userProfile" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ู‚ุงุฆู…ุฉ ุนู†ุงูˆูŠู† ุชุณู„ูŠู… ุงู„ู…ุณุชุฎุฏู…", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserDeliveryAddressDto" + } + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + }, + "put": { + "summary": "ุฅุถุงูุฉ ุนู†ูˆุงู† ุชุณู„ูŠู… ุงู„ู…ุณุชุฎุฏู…", + "description": "- ุฃุถู ู…ุนู„ูˆู…ุงุช ุนู†ูˆุงู† ุงู„ุดุญู† ุงู„ุฎุงุตุฉ ุจุงู„ู…ุณุชุฎุฏู… ุฃูˆ ู‚ู… ุจุชุญุฏูŠุซ "ุชู… ุงู„ุงุณุชุฑุฌุงุน ููŠ" - ู‚ู… ุจุงู„ุชุญุฏูŠุซ ูู‚ุท ุฅุฐุง ูƒุงู† ุงู„ุนู†ูˆุงู† ูˆุทู„ุจ ุงู„ุดุญู† ู…ุชุทุงุจู‚ูŠู† ุจูŠู† ู‚ุงุฆู…ุฉ ุนู†ุงูˆูŠู† ุงู„ุดุญู† ุงู„ู…ุณุฌู„ุฉ ุจุงู„ูุนู„", + "operationId": "addUserDeliveryAddress", + "tags": [ + "userProfile" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserDeliveryAddressAddRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุฅุถุงูุฉ ุนู†ูˆุงู† ุชุณู„ูŠู… ุงู„ู…ุณุชุฎุฏู…", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserDeliveryAddressDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/tier": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุทุจู‚ุฉ ุงู„ู…ุณุชุฎุฏู…", + "operationId": "getTier", + "tags": [ + "tier" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุทุจู‚ุฉ ุงู„ู…ุณุชุฎุฏู…", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TierDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/tier/next": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช ุงู„ู…ุณุชูˆู‰ ุงู„ุชุงู„ูŠ ู„ู„ู…ุณุชุฎุฏู…", + "operationId": "getNextTierInfo", + "tags": [ + "tier" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช ุงู„ู…ุณุชูˆู‰ ุงู„ุชุงู„ูŠ ู„ู„ู…ุณุชุฎุฏู…", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NextTierInfoDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/images/{imageCategory}/uploadable-url": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "imageCategory", + "schema": { + "$ref": "#/components/schemas/ImageCategoryEnum" + } + }, + { + "in": "query", + "required": true, + "name": "filename", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "ู‚ู… ุจุฅู†ุดุงุก ุนู†ูˆุงู† URL ู‚ุงุจู„ ู„ู„ุชุญู…ูŠู„ ู„ุชุญู…ูŠู„ ุงู„ุตูˆุฑ ู„ู„ู…ุณุชุฎุฏู… ุงู„ุฐูŠ ู‚ุงู… ุจุชุณุฌูŠู„ ุงู„ุฏุฎูˆู„", + "operationId": "generateImageUploadableUrl", + "tags": [ + "image" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุนู†ูˆุงู† URL ู„ู„ุตูˆุฑุฉ ุงู„ู‚ุงุจู„ุฉ ู„ู„ุชุญู…ูŠู„", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UploadableImageResponseDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "imageCategory", + "schema": { + "$ref": "#/components/schemas/ImageCategoryEnum" + } + }, + { + "in": "query", + "required": true, + "name": "filename", + "schema": { + "type": "string" + } + } + ] + } + }, + "/images/{imageCategory}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "imageCategory", + "schema": { + "$ref": "#/components/schemas/ImageCategoryEnum" + } + } + ], + "post": { + "deprecated": true, + "description": "(ู…ู‡ู…ู„) ูŠุฑุฌู‰ ุงุณุชุฎุฏุงู… generatorImageUploadableUrl ุจุฏู„ุงู‹ ู…ู† ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ู‡ุฐู‡", + "summary": "ุชุญู…ูŠู„ ุงู„ุตูˆุฑ ู„ู„ู…ุณุชุฎุฏู… ุชุณุฌูŠู„ ุงู„ุฏุฎูˆู„", + "operationId": "uploadImage", + "tags": [ + "image" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "required": [ + "image" + ], + "properties": { + "image": { + "type": "string", + "format": "binary" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "ุชุญู…ูŠู„ ุงู„ุตูˆุฑุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UploadImageResponseDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "imageCategory", + "schema": { + "$ref": "#/components/schemas/ImageCategoryEnum" + } + } + ] + } + }, + "/images/{imageCategory}/base64": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "imageCategory", + "schema": { + "$ref": "#/components/schemas/ImageCategoryEnum" + } + } + ], + "post": { + "summary": "ุชุญู…ูŠู„ ุงู„ุตูˆุฑ ูƒู‚ุงุนุฏุฉ 64 ู„ุชุณุฌูŠู„ ุงู„ุฏุฎูˆู„ ู„ู„ู…ุณุชุฎุฏู…", + "operationId": "uploadImageBase64", + "tags": [ + "image" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Base64ImageUploadRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "ุชุญู…ูŠู„ ุงู„ุตูˆุฑุฉ ูƒู‚ุงุนุฏุฉ64", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UploadImageResponseDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "imageCategory", + "schema": { + "$ref": "#/components/schemas/ImageCategoryEnum" + } + } + ] + } + }, + "/products/{productId}/reviews": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู…ุฑุงุฌุนุงุช ุงู„ู…ู†ุชุฌ", + "operationId": "getProductReviews", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "ู…ุฑุงุฌุนุงุช ุงู„ู…ู†ุชุฌ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DisplayProductReviewListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/reviews/v2": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู…ุฑุงุฌุนุงุช ุงู„ู…ู†ุชุฌ v2", + "operationId": "findProductReviews", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "page", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "required": false, + "name": "sortOrder", + "schema": { + "$ref": "#/components/schemas/ProductReviewSortOrderEnum" + } + } + ], + "responses": { + "200": { + "description": "ู…ุฑุงุฌุนุงุช ุงู„ู…ู†ุชุฌ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DisplayProductReviewListDtoV2" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/reviews/representatives": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู…ุฑุงุฌุนุงุช ุงู„ู…ู†ุชุฌ ุงู„ุชู…ุซูŠู„ูŠุฉ", + "operationId": "getRepresentativeProductReviews", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "ู…ุฑุงุฌุนุงุช ุงู„ู…ู†ุชุฌุงุช ุงู„ุชู…ุซูŠู„ูŠุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RepresentativeProductReviewListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/reviews/{reviewId}": { + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "put": { + "summary": "ุชุญุฏูŠุซ ู…ุฑุงุฌุนุฉ ุงู„ู…ู†ุชุฌ", + "description": "ุชุญุฑูŠุฑ ู…ุฑุงุฌุนุฉ ุงู„ู…ู†ุชุฌ ุงู„ุฎุงุต ุจูƒ. - ุงู„ู…ูˆุฑุฏ_NOT_FOUND: ุนู†ุฏู…ุง ู„ุง ูŠู…ูƒู† ุงู„ุนุซูˆุฑ ุนู„ู‰ ู…ุฑุงุฌุนุฉ ุงู„ู…ู†ุชุฌ ุงู„ู…ุชูˆุงูู‚ุฉ ู…ุน ู…ุนุฑู ุงู„ู…ุฑุงุฌุนุฉ - ACCESS_DENIED: ุนู†ุฏ ู…ุญุงูˆู„ุฉ ุชุญุฑูŠุฑ ู…ุฑุงุฌุนุฉ ุงู„ู…ู†ุชุฌ ุงู„ุฎุงุตุฉ ุจุดุฎุต ุขุฎุฑ", + "operationId": "updateProductReview", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateProductReviewRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "ู…ุฑุงุฌุนุฉ ุงู„ู…ู†ุชุฌ ุงู„ู…ุญุฏุซุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReviewDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ] + } + }, + "/products/items/{productItemId}/review": { + "parameters": [ + { + "in": "path", + "name": "productItemId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "orderLineId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "ุฅู†ุดุงุก ู…ุฑุงุฌุนุฉ ู„ู„ู…ู†ุชุฌ", + "operationId": "createProductReview", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReviewDataDto" + } + } + } + }, + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุฅู†ุดุงุก ู…ุฑุงุฌุนุฉ ู„ู„ู…ู†ุชุฌ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReviewDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productItemId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "orderLineId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/reviews/{reviewId}": { + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู…ุฑุงุฌุนุฉ ุงู„ู…ู†ุชุฌ", + "operationId": "getProductReview", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ู…ุฑุงุฌุนุฉ ุงู„ู…ู†ุชุฌ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DisplayProductReviewDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ] + }, + "delete": { + "summary": "ุญุฐู ู…ุฑุงุฌุนุฉ ุงู„ู…ู†ุชุฌ", + "operationId": "deleteProductReview", + "description": "ุญุฐู ู…ุฑุงุฌุนุฉ ุงู„ู…ู†ุชุฌ ุงู„ุฎุงุต ุจูƒ. - ุงู„ู…ูˆุฑุฏ_NOT_FOUND: ุนู†ุฏู…ุง ู„ุง ูŠู…ูƒู† ุงู„ุนุซูˆุฑ ุนู„ู‰ ู…ุฑุงุฌุนุฉ ุงู„ู…ู†ุชุฌ ุงู„ู…ุชูˆุงูู‚ุฉ ู…ุน ู…ุนุฑู ุงู„ู…ุฑุงุฌุนุฉ - ACCESS_DENIED: ุนู†ุฏ ู…ุญุงูˆู„ุฉ ุชุญุฑูŠุฑ ู…ุฑุงุฌุนุฉ ุงู„ู…ู†ุชุฌ ุงู„ุฎุงุตุฉ ุจุดุฎุต ุขุฎุฑ", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุญุฐู ู…ุฑุงุฌุนุฉ ุงู„ู…ู†ุชุฌ" + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ] + } + }, + "/reviews/{reviewId}/favorites": { + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "post": { + "summary": "ู…ุฑุงุฌุนุฉ ุงู„ู…ู†ุชุฌุงุช ุงู„ู…ูุถู„ุฉ", + "operationId": "favoritesProductReview", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "204": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ู…ุฑุงุฌุนุฉ ุงู„ู…ู†ุชุฌุงุช ุงู„ู…ูุถู„ุฉ" + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ] + }, + "delete": { + "summary": "ุญุฐู ู…ุฑุงุฌุนุฉ ุงู„ู…ู†ุชุฌ ุงู„ู…ูุถู„ุฉ", + "operationId": "deleteFavoritesProductReview", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุญุฐู ู…ุฑุงุฌุนุฉ ุงู„ู…ู†ุชุฌ ุงู„ู…ูุถู„ุฉ" + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ] + } + }, + "/user/reviews": { + "get": { + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุชู‚ูŠูŠู…ุงุช ุงู„ู…ู†ุชุฌุงุช ุงู„ุชูŠ ุชู… ุฅู†ุดุงุคู‡ุง ู…ู† ุงู„ู…ุณุชุฎุฏู…ูŠู†", + "operationId": "getMyProductReviews", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุชู… ุฅู†ุดุงุก ู…ุฑุงุฌุนุงุช ุงู„ู…ู†ุชุฌ ู„ู„ู…ุณุชุฎุฏู…ูŠู†", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MyProductReviewListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/user/review-candidates": { + "get": { + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุชู‚ูŠูŠู…ุงุช ุงู„ู…ู†ุชุฌุงุช ุงู„ุชูŠ ุชู… ุฅู†ุดุงุคู‡ุง ู…ู† ุงู„ู…ุณุชุฎุฏู…ูŠู†", + "operationId": "getMyProductReviewCandidates", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ู…ุฑุดุญูŠู† ู…ุฑุงุฌุนุฉ ุงู„ู…ู†ุชุฌ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReviewCandidateListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/user/reviews/creatable-count": { + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ุนุฏุฏ ู…ู† ู…ุฑุงุฌุนุฉ ุงู„ู…ู†ุชุฌ ุงู„ู‚ุงุจู„ุฉ ู„ู„ุฅู†ุดุงุก ู„ู„ู…ุณุชุฎุฏู…", + "operationId": "countCreatableProductReviewOfUser", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุนุฏุฏ ู…ุฑุงุฌุนุงุช ุงู„ู…ู†ุชุฌุงุช ุงู„ุฅุจุฏุงุนูŠุฉ ู„ู„ู…ุณุชุฎุฏู…ูŠู†", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LongDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/user/reviews/created-count": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุนุฏุฏ ู…ุฑุงุฌุนุฉ ุงู„ู…ู†ุชุฌ ุงู„ุฐูŠ ุชู… ุฅู†ุดุงุคู‡ ู„ู„ู…ุณุชุฎุฏู…", + "operationId": "countCreatedProductReviewOfUser", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุนุฏุฏ ู…ุฑุงุฌุนุงุช ุงู„ู…ู†ุชุฌุงุช ุงู„ุชูŠ ุชู… ุฅู†ุดุงุคู‡ุง ู„ู„ู…ุณุชุฎุฏู…ูŠู†", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LongDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/user/reviews/exist": { + "get": { + "summary": "ุงู„ุชุญู‚ู‚ ู…ู† ูˆุฌูˆุฏ ู…ุฑุงุฌุนุฉ ุงู„ู…ุณุชุฎุฏู…", + "operationId": "checkExistProductReviewOfUser", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุนู„ุงู…ุฉ ู‡ู„ ุฃู†ุดุฃ ุงู„ู…ุณุชุฎุฏู… ู…ุฑุงุฌุนุฉ ู…ู† ู‚ุจู„", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RequiredBooleanDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/user/reviews/accumulable-point": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู…ู‚ุฏุงุฑ ุงู„ู†ู‚ุงุท ุงู„ู…ุชุฑุงูƒู…ุฉ ู„ู„ู…ุณุชุฎุฏู… ู…ู† ุฅู†ุดุงุก ุงู„ู…ุฑุงุฌุนุฉ", + "operationId": "getAccumulablePointProductReviewCreationOfUser", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ู…ู‚ุฏุงุฑ ุงู„ู†ู‚ุงุท ุงู„ู…ุชุฑุงูƒู…ุฉ ุนู†ุฏู…ุง ู‚ุงู… ุงู„ู…ุณุชุฎุฏู… ุจุฅู†ุดุงุก ู…ุฑุงุฌุนุฉ ุฅุฌู…ุงู„ูŠุฉ ู‚ุงุจู„ุฉ ู„ู„ุฅู†ุดุงุก", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RequiredLongDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/reviews/statistics/summary": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู…ู„ุฎุต ุฅุญุตุงุกุงุช ู…ุฑุงุฌุนุฉ ุงู„ู…ู†ุชุฌ", + "operationId": "getProductReviewStatisticsSummary", + "tags": [ + "reviewStatistics" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ู…ู„ุฎุต ุฅุญุตุงุกุงุช ู…ุฑุงุฌุนุฉ ุงู„ู…ู†ุชุฌ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReviewStatisticsSummaryDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/products/{productId}/reviews/statistics/size": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ุฅุญุตุงุฆูŠุงุช ุญุฌู… ู…ุฑุงุฌุนุฉ ุงู„ู…ู†ุชุฌ", + "operationId": "getProductSizeStatistics", + "tags": [ + "reviewStatistics" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุฅุญุตุงุฆูŠุงุช ุญุฌู… ู…ุฑุงุฌุนุฉ ุงู„ู…ู†ุชุฌ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductSizeStatisticsDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/products/{productId}/reviews/statistics/brightness": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ุฅุญุตุงุฆูŠุงุช ุณุทูˆุน ู…ุฑุงุฌุนุฉ ุงู„ู…ู†ุชุฌ", + "operationId": "getProductBrightnessStatistics", + "tags": [ + "reviewStatistics" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุฅุญุตุงุฆูŠุงุช ุณุทูˆุน ู…ุฑุงุฌุนุฉ ุงู„ู…ู†ุชุฌ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductBrightnessStatisticsDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/products/{productId}/reviews/statistics/color-sense": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ุฅุญุตุงุฆูŠุงุช ุชุญุณุณ ุงู„ุฃู„ูˆุงู† ุงู„ุฎุงุตุฉ ุจู…ุฑุงุฌุนุฉ ุงู„ู…ู†ุชุฌ", + "operationId": "getProductColorSenseStatistics", + "tags": [ + "reviewStatistics" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ู…ุฑุงุฌุนุฉ ุงู„ู…ู†ุชุฌ ุฅุญุตุงุฆูŠุงุช ุญุณ ุงู„ู„ูˆู†", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductColorSenseStatisticsDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/products/{productId}/reviews/statistics/thickness": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ุฅุญุตุงุฆูŠุงุช ุณู…ูƒ ู…ุฑุงุฌุนุฉ ุงู„ู…ู†ุชุฌ", + "operationId": "getProductThicknessStatistics", + "tags": [ + "reviewStatistics" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุฅุญุตุงุฆูŠุงุช ุณู…ูƒ ู…ุฑุงุฌุนุฉ ุงู„ู…ู†ุชุฌ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductThicknessStatisticsDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/categories/{categoryId}/attributes": { + "parameters": [ + { + "in": "path", + "name": "categoryId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุณู…ุงุช ุงู„ูุฆุฉ", + "operationId": "getProductCategoryAttributes", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุณู…ุงุช ูุฆุฉ ุงู„ู…ู†ุชุฌ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductCategoryReviewAttributeDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "categoryId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/reviews/{reviewId}/reports": { + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "post": { + "summary": "ุงู„ุฅุจู„ุงุบ ุนู† ู…ุฑุงุฌุนุฉ ุงู„ู…ู†ุชุฌ", + "description": "(ู„ุง ูŠู…ูƒู† ุงู„ุฅุจู„ุงุบ ู…ุฑุชูŠู† -> ApiErrorResponseCode.REVIEW_REPORTED_TWICE) (ู„ุง ูŠู…ูƒู† ุฃู† ูŠูƒูˆู† ุงู„ู…ุนุฑู ุงู„ูุฑูŠุฏ ู„ู„ู…ุจู„ุบ ูˆุงู„ู…ุนุฑู ุงู„ูุฑูŠุฏ ู„ู„ู…ุฑุงุฌุนุฉ ู…ุชู…ุงุซู„ูŠู† -> ApiErrorResponseCode.REVIEW_REPORTED_BY_SELF)", + "operationId": "reportProductReview", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุงู„ุฅุจู„ุงุบ ุนู† ู…ุฑุงุฌุนุฉ ุงู„ู…ู†ุชุฌ" + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ] + } + }, + "/home/categories": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ูุฆุงุช ุงู„ู…ู†ุชุฌุงุช ููŠ ุงู„ุดุงุดุฉ ุงู„ุฑุฆูŠุณูŠุฉ", + "operationId": "getHomeProductCategories", + "tags": [ + "home" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ูุฆุงุช ุงู„ู…ู†ุชุฌุงุช ููŠ ุงู„ุดุงุดุฉ ุงู„ุฑุฆูŠุณูŠุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HomeProductCategoryDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/app/categories": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุฌู…ูŠุน ุงู„ูุฆุงุช ู…ุน ุนุฑุถ ุงู„ู…ู†ุชุฌุงุช", + "operationId": "getDisplayingCategories", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุฅุฑุฌุงุน ุฌู…ูŠุน ุงู„ูุฆุงุช ู…ุน ุนุฑุถ ุงู„ู…ู†ุชุฌุงุช", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/categories": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุฃุนู„ู‰ ูุฆุงุช ุงู„ู…ู†ุชุฌุงุช", + "operationId": "getTopProductCategories", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "query", + "required": false, + "name": "withAllCategory", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "ูุฆุงุช ุงู„ู…ู†ุชุฌุงุช", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/categories/{categoryId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ูุฆุงุช ุงู„ู…ู†ุชุฌุงุช ุงู„ุฏุงุฎู„ูŠุฉ", + "operationId": "getInnerProductCategories", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ูุฆุงุช ุงู„ู…ู†ุชุฌุงุช ุงู„ุฏุงุฎู„ูŠุฉ", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/categories/{categoryId}/products": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุงู„ู…ู†ุชุฌุงุช ุงู„ู…ุตู†ูุฉ", + "operationId": "getCategorizedProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "categoryId", + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "- ุงู„ู…ู†ุชุฌุงุช ุงู„ู…ุตู†ูุฉ - ุนู†ุฏ ุชุทุจูŠู‚ ุฎุตู… Queenit ุงู„ููˆุฑูŠุŒ ูŠุนุฑุถ `ProductDto` ุงู„ู…ุจู„ุบ ู…ุน ุชุทุจูŠู‚ ุงู„ุฎุตู… ุงู„ููˆุฑูŠ - ุงู„ุญู‚ูˆู„ ุงู„ู…ุชุฃุซุฑุฉ: `ุงู„ุณุนุฑ ุงู„ู†ู‡ุงุฆูŠ`ุŒ `ุงู„ู†ุณุจุฉ ุงู„ู…ุฆูˆูŠุฉ ู„ู„ุฎุตู…`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/age-group-filters": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุฌู…ูŠุน ู…ุฑุดุญุงุช ุงู„ูุฆุฉ ุงู„ุนู…ุฑูŠุฉ.", + "operationId": "getAgeGroupFilters", + "tags": [ + "ageGroup" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุฌู…ูŠุน ู…ุฑุดุญุงุช ุงู„ูุฆุงุช ุงู„ุนู…ุฑูŠุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AgeGroupFilterListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/brands": { + "get": { + "parameters": [ + { + "in": "query", + "required": false, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ], + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุฌู…ูŠุน ุงู„ุนู„ุงู…ุงุช ุงู„ุชุฌุงุฑูŠุฉ", + "operationId": "getAllBrands", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ุนู„ุงู…ุงุช ุงู„ุชุฌุงุฑูŠุฉ", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BrandDto" + } + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/brands/{brandId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "brandId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุชูุงุตูŠู„ ุงู„ุนู„ุงู…ุฉ ุงู„ุชุฌุงุฑูŠุฉ", + "description": "(ู„ุง ูŠู…ูƒู† ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุนู„ุงู…ุฉ ุงู„ุชุฌุงุฑูŠุฉ -> ApiErrorResponseCode.RESOURCE_NOT_FOUND)", + "operationId": "getBrandDetail", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุชูุงุตูŠู„ ุงู„ุนู„ุงู…ุฉ ุงู„ุชุฌุงุฑูŠุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BrandDetailDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "brandId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/brands/{brandId}/categories": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "brandId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ูุฆุงุช ุงู„ุนู„ุงู…ุฉ ุงู„ุชุฌุงุฑูŠุฉ", + "operationId": "getBrandCategories", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ูุฆุงุช ุงู„ุนู„ุงู…ุฉ ุงู„ุชุฌุงุฑูŠุฉ", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "brandId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/brands/{brandId}/categories/{categoryId}/products": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "brandId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุงู„ู…ู†ุชุฌุงุช ุฐุงุช ุงู„ุนู„ุงู…ุงุช ุงู„ุชุฌุงุฑูŠุฉ ุงู„ู…ุตู†ูุฉ", + "operationId": "getBrandProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "brandId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "categoryId", + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "- ุงู„ู…ู†ุชุฌุงุช ุงู„ู…ุตู†ูุฉ - ุนู†ุฏ ุชุทุจูŠู‚ ุฎุตู… Queenit ุงู„ููˆุฑูŠุŒ ูŠุนุฑุถ `ProductDto` ุงู„ู…ุจู„ุบ ู…ุน ุชุทุจูŠู‚ ุงู„ุฎุตู… ุงู„ููˆุฑูŠ - ุงู„ุญู‚ูˆู„ ุงู„ู…ุชุฃุซุฑุฉ: `ุงู„ุณุนุฑ ุงู„ู†ู‡ุงุฆูŠ`ุŒ `ุงู„ู†ุณุจุฉ ุงู„ู…ุฆูˆูŠุฉ ู„ู„ุฎุตู…`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/carts": { + "post": { + "summary": "ุฃุถู ุฅู„ู‰ ุงู„ุณู„ุฉ", + "operationId": "addToCart", + "tags": [ + "cart" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AddToCartRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุงู„ุฅุถุงูุฉ ุฅู„ู‰ ุณู„ุฉ ุงู„ุชุณูˆู‚", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AddToCartResponseDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + }, + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุนู†ุงุตุฑ ุงู„ุณู„ุฉ", + "operationId": "getCartItems", + "tags": [ + "cart" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- ุนู†ุงุตุฑ ุณู„ุฉ ุงู„ุชุณูˆู‚ - ุนู†ุฏ ุชุทุจูŠู‚ ุฎุตู… Queenit ุงู„ููˆุฑูŠุŒ ูŠุนุฑุถ `ProductDto` ุงู„ู…ุจู„ุบ ู…ุน ุชุทุจูŠู‚ ุงู„ุฎุตู… ุงู„ููˆุฑูŠ - ุงู„ุญู‚ูˆู„ ุงู„ู…ุชุฃุซุฑุฉ: `ุงู„ุณุนุฑ ุงู„ู†ู‡ุงุฆูŠ`ุŒ `ุงู„ู†ุณุจุฉ ุงู„ู…ุฆูˆูŠุฉ ู„ู„ุฎุตู…`", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartItemGroupDto" + } + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/carts/{cartItemId}": { + "delete": { + "summary": "ุญุฐู ุนู†ุตุฑ ุงู„ุณู„ุฉ", + "operationId": "deleteCartItem", + "tags": [ + "cart" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "cartItemId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "ู†ุฌุงุญ ุญุฐู ุนู†ุตุฑ ุณู„ุฉ ุงู„ุชุณูˆู‚" + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/carts/delete": { + "post": { + "summary": "ุญุฐู ุนู†ุงุตุฑ ุงู„ุณู„ุฉ", + "operationId": "deleteCartItems", + "tags": [ + "cart" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteCartItemsRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุญุฐู ุนู†ุงุตุฑ ุณู„ุฉ ุงู„ุชุณูˆู‚" + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/carts/rearrange": { + "post": { + "summary": "ุฅุนุงุฏุฉ ุชุฑุชูŠุจ ุนู†ุงุตุฑ ุณู„ุฉ ุงู„ุชุณูˆู‚ ู„ู‚ูŠูˆุฏ ุงู„ูƒู…ูŠุฉ", + "operationId": "rearrangeCartItems", + "tags": [ + "cart" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- ุนู†ุงุตุฑ ุนุฑุจุฉ ุงู„ุชุณูˆู‚ ุงู„ู…ุตู‚ูˆู„ุฉ - ุฅุฐุง ุชู… ุชุทุจูŠู‚ ุฎุตู… Queenit ุงู„ููˆุฑูŠุŒ ูุฅู† `ProductDto` ูŠุนุฑุถ ุงู„ู…ุจู„ุบ ู…ุน ุงู„ุฎุตู… ุงู„ููˆุฑูŠ ุงู„ู…ุทุจู‚ - ุงู„ุญู‚ูˆู„ ุงู„ู…ุชุฃุซุฑุฉ: `finalPrice`ุŒ `discountPercentage`", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartItemGroupDto" + } + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/carts/{cartItemId}/quantity/{quantity}": { + "post": { + "summary": "ุชุญุฏูŠุซ ูƒู…ูŠุฉ ุงู„ุณู„ุนุฉ ููŠ ุณู„ุฉ ุงู„ุชุณูˆู‚", + "operationId": "updateCartItemQuantity", + "tags": [ + "cart" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "cartItemId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "path", + "name": "quantity", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "ู†ุฌุงุญ ุชุญุฏูŠุซ ูƒู…ูŠุฉ ุนู†ุตุฑ ุณู„ุฉ ุงู„ุชุณูˆู‚" + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/orders": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุณุฌู„ ุทู„ุจูŠ", + "operationId": "getMyOrders", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "ุชูุงุตูŠู„ ุงู„ุทู„ุจ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MyOrderHistoryListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + }, + "post": { + "summary": "ุจุฏุก ุงู„ุทู„ุจ ุนู„ู‰ ุนู†ุงุตุฑ ุณู„ุฉ ุงู„ุชุณูˆู‚", + "description": "(ุนุฏุฏ ุณุทุฑ ุงู„ุฃู…ุฑ ู„ู„ุทู„ุจ ูŠุชุฌุงูˆุฒ ุงู„ุญุฏ -> ApiErrorResponseCode.ORDER_LINE_COUNT_LIMIT_PER_ORDER_EXCEEDED) (ูŠูˆุฌุฏ ุนู†ุตุฑ ู…ู†ุชุฌ ุบูŠุฑ ู…ุชูˆูุฑ ู„ู„ุทู„ุจ -> ApiErrorResponseCode.ORDER_UNAVAILABLE_PRODUCT_ITEM)", + "operationId": "startOrder", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StartOrderRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "ู…ุงุฏุฉ ุดุฑุงุก ุงู„ู…ู†ุชุฌ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductPurchaseMaterialDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + }, + "put": { + "summary": "ุงุจุฏุฃ ุงู„ุทู„ุจ ุจุฅุถุงูุฉ ุนู†ุงุตุฑ ุณู„ุฉ ุงู„ุชุณูˆู‚", + "description": "(ุนุฏุฏ ุณุทุฑ ุงู„ุฃู…ุฑ ู„ู„ุทู„ุจ ูŠุชุฌุงูˆุฒ ุงู„ุญุฏ -> ApiErrorResponseCode.ORDER_LINE_COUNT_LIMIT_PER_ORDER_EXCEEDED) (ูŠูˆุฌุฏ ุนู†ุตุฑ ู…ู†ุชุฌ ุบูŠุฑ ู…ุชูˆูุฑ ู„ู„ุทู„ุจ -> ApiErrorResponseCode.ORDER_UNAVAILABLE_PRODUCT_ITEM)", + "operationId": "startOrderFromAdding", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StartOrderFromAddingRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "ู…ุงุฏุฉ ุดุฑุงุก ุงู„ู…ู†ุชุฌ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductPurchaseMaterialDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/orders/wait-for-deposit/exist": { + "get": { + "summary": "ู…ุง ุฅุฐุง ูƒุงู† ู‡ู†ุงูƒ ุฃู…ุฑ ุงู†ุชุธุงุฑ ุงู„ุฅูŠุฏุงุน", + "operationId": "existOrdersOfWaitingForDeposit", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุณูˆุงุก ูƒุงู†ุช ู…ูˆุฌูˆุฏุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BooleanDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/orders/{orderId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุชุงุฑูŠุฎ ุงู„ุทู„ุจ", + "description": "(ู„ุง ูŠู…ูƒู† ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุทู„ุจ -> ApiErrorResponseCode.RESOURCE_NOT_FOUND)", + "operationId": "getMyOrder", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุชูุงุตูŠู„ ุงู„ุทู„ุจ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MyOrderHistoryDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ] + }, + "delete": { + "summary": "ุฃู…ุฑ ุงู„ุฅุฌู‡ุงุถ", + "description": "(ู„ุง ูŠู…ูƒู† ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุทู„ุจ -> ApiErrorResponseCode.RESOURCE_NOT_FOUND)", + "operationId": "abortOrderById", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "required": false, + "name": "restoreCartItems", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "ุจูŠุงู†ุงุช ุฃู…ุฑ ุงู„ู†ุชูŠุฌุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/orders/{orderId}/purchase-material": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู…ูˆุงุฏ ุดุฑุงุก ุงู„ุทู„ุจ", + "description": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช (API) ู„ุงุณุชุฑุฏุงุฏ ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน ("ู…ูˆุงุฏ ุงู„ุดุฑุงุก") ุงู„ุฎุงุตุฉ ุจู€ "ุงู„ุทู„ุจ ู‚ุจู„ ุฅุชู…ุงู… ุงู„ุฏูุน" ููŠ ุญุงู„ุฉ ุงู„ุชุญุฏูŠุซ ุฃูˆ ูู‚ุฏุงู† ุงู„ุดุจูƒุฉ", + "operationId": "getOrderPurchaseMaterial", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ู…ุงุฏุฉ ุดุฑุงุก ุงู„ู…ู†ุชุฌ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductPurchaseMaterialDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/{orderId}/lines/{orderLineId}/confirm-receipt": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "orderLineId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "ุชุฃูƒูŠุฏ ุงุณุชู„ุงู… ุณุทุฑ ุงู„ุทู„ุจ", + "description": "- ุชุฃูƒูŠุฏ ุงู„ุดุฑุงุก ู‚ูŠุฏ ุงู„ุชู‚ุฏู… ู„ุฎุท ุงู„ุทู„ุจ - ุงู„ุชุฃูƒูŠุฏ ู…ู…ูƒู† ูู‚ุท ููŠ ุญุงู„ุฉ ุงู„ุชุณู„ูŠู… - ู„ุง ูŠู…ูƒู† ุงุณุชุจุฏุงู„/ุฅุฑุฌุงุน ุงู„ุดุฑุงุก ุงู„ู…ุคูƒุฏ - ุทู„ุจ ุงู„ุฅุฑุฌุงุน ุฏุงุฎู„ ุงู„ุชุทุจูŠู‚ ุบูŠุฑ ู…ู…ูƒู† - ุฃุฎุทุงุก ู…ุญุชู…ู„ุฉ - `TICKET_PROCESSING_IS_REQUIRED_TO_CONFIRM_RECEIPT (7001)` - `SUBMITTED` (ู…ุทู„ูˆุจ) / ุฅุฐุง ูƒุงู†ุช ู‡ู†ุงูƒ ุชุฐูƒุฑุฉ OLC/OLR ุจุงู„ุญุงู„ุฉ `CONFIRMED` (ุชู…ุช ุงู„ู…ูˆุงูู‚ุฉ ุนู„ูŠู‡ุง) -> ุฅุฐุง ูƒุงู†ุช ู‡ู†ุงูƒ ุชุฐูƒุฑุฉ OLC/OLR ู„ู… ุชุชู… ู…ุนุงู„ุฌุชู‡ุง ุจุนุฏ - `CAN_ONLY_CONFIRM_RECEIPT_OF_PAID_ORDER_LINE (7002)` - ุชู…ุช ู…ุนุงู„ุฌุฉ ุงุณุชุฑุฏุงุฏ ุงู„ุฃู…ูˆุงู„ / ููŠ ุงู†ุชุธุงุฑ ุงู„ุฏูุน ุงู„ุดุฑุงุก ุงู„ุชุฃูƒูŠุฏ ุบูŠุฑ ู…ู…ูƒู† ู„ุฎุทูˆุท ุงู„ุทู„ุจ ู‚ูŠุฏ ุงู„ุชู‚ุฏู… - `CANNOT_CONFIRM_RECEIPT_WHEN_DELIVERY_NOT_COMPLETE (7003)` - ุชุฃูƒูŠุฏ ุงู„ุดุฑุงุก ุบูŠุฑ ู…ู…ูƒู† ู„ุฎุทูˆุท ุงู„ุทู„ุจ ุงู„ุชูŠ ู„ู… ูŠุชู… ุชุณู„ูŠู…ู‡ุง ุจุนุฏ.", + "operationId": "confirmOrderLineReceipt", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ู„ุชุฃูƒูŠุฏ ุงู„ุงุณุชู„ุงู…" + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "orderLineId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/purchases/{purchaseId}/point": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "ุชุทุจูŠู‚ ู†ู‚ุทุฉ", + "description": "(ู„ุง ูŠู…ูƒู† ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุชุฑุชูŠุจ -> ApiErrorResponseCode.RESOURCE_NOT_FOUND) (ู„ุง ูŠู…ูƒู† ุชุทุจูŠู‚ ุงู„ู†ู‚ุทุฉ -> ApiErrorResponseCode.POINT_NOT_CONSUMABLE) (ู†ู‚ุต ุงู„ู†ู‚ุทุฉ -> ApiErrorResponseCode.LACK_OF_POINT)", + "operationId": "applyPointForOrder", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplyPointRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุงู„ุญูุธ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplyPointResponseDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/purchases/{purchaseId}/coupons/v2": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "delete": { + "summary": "ู‚ุณูŠู…ุฉ ุงู„ุงูุฑุงุฌ", + "description": "(ู„ุง ูŠู…ูƒู† ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุทู„ุจ -> ApiErrorResponseCode.RESOURCE_NOT_FOUND)", + "operationId": "releaseCouponOfOrderV2", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุงู„ุงูุฑุงุฌ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReleaseCouponResponseDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + }, + "post": { + "summary": "ุชุทุจูŠู‚ ุงู„ู‚ุณูŠู…ุฉ", + "description": "(ู„ุง ูŠู…ูƒู† ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุทู„ุจุŒ ุงู„ู‚ุณูŠู…ุฉ ุงู„ุตุงุฏุฑุฉ -> ApiErrorResponseCode.RESOURCE_NOT_FOUND) (ู„ุง ูŠู…ูƒู† ุชุทุจูŠู‚ ุงู„ู‚ุณูŠู…ุฉ -> ApiErrorResponseCode.COUPON_NOT_CONSUMABLE)", + "operationId": "applyCouponToOrderV2", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplyCouponRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุงู„ุญูุธ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplyCouponResponseDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/purchases/{purchaseId}/delivery": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "ุญูุธ ุทู„ุจ ุงู„ุชุณู„ูŠู…", + "description": "(ู„ุง ูŠู…ูƒู† ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุทู„ุจ -> ApiErrorResponseCode.RESOURCE_NOT_FOUND)", + "operationId": "saveDeliveryRequest", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeliveryRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "ู†ุฌุงุญ ุชุญุฏูŠุซ ุทู„ุจ ุงู„ุชุณู„ูŠู…", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderSummaryDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/{orderId}/delivery-request": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ], + "put": { + "summary": "ุชุญุฏูŠุซ ุทู„ุจ ุงู„ุชุณู„ูŠู… ู‚ุจู„ ุงู„ุชุณู„ูŠู…", + "description": "- ู‚ู… ุจุชุบูŠูŠุฑ ุนู†ูˆุงู† ุชุณู„ูŠู… ุงู„ุทู„ุจ ู‚ุจู„ ุงู„ุดุญู† - ุฃู†ูˆุงุน ุงู„ุฃุฎุทุงุก ุงู„ุชูŠ ู‚ุฏ ุชุญุฏุซ - `ApiErrorResponseCode.INVALID_VALUE` - ููŠ ุญุงู„ุฉ ูˆุฌูˆุฏ ุชุฐูƒุฑุฉ ุจุญุงู„ุฉ ุฅู„ุบุงุก/ุชุฐูƒุฑุฉ ุฅุฑุฌุงุน `SUBMITTED` ุฃูˆ `CONFIRMED` ููŠ ุงู„ุทู„ุจ - ู„ู… ูŠูƒุชู…ู„ ุงู„ุฏูุน ุฅุฐุง ุฅู†ู‡ ุทู„ุจ ูˆู‡ู…ูŠ - `ApiErrorResponseCode.RESOURCE_NOT_FOUND` - ุฅุฐุง ูƒุงู† ุงู„ุทู„ุจ ุบูŠุฑ ู…ูˆุฌูˆุฏ - `ApiErrorResponseCode.ORDER_ALREADY_DISPATCHED` - ุฅุฐุง ูƒุงู†ุช ุญุงู„ุฉ ุงู„ุชุณู„ูŠู… ู„ุฌู…ูŠุน ุงู„ุทู„ุจุงุช ุงู„ูุฑุฏูŠุฉ ู„ู„ุทู„ุจ ุงู„ู…ู‚ุงุจู„ ู„ูŠุณุช `WAIT` - `ApiErrorResponseCode.CANNOT_CHANGE_DELIVERY_AREA` - ู…ูˆุฌูˆุฏ ุนู†ุฏ ุฅุฌุฑุงุก ู…ุญุงูˆู„ุฉ ู„ุชุบูŠูŠุฑ ุนู†ูˆุงู† ุงู„ุชุณู„ูŠู… ุฅู„ู‰ ู…ู†ุทู‚ุฉ ุชุณู„ูŠู… ู…ุฎุชู„ูุฉ ุนู† ุนู†ูˆุงู† ุงู„ุชุณู„ูŠู… (ุนู„ู‰ ุณุจูŠู„ ุงู„ู…ุซุงู„ุŒ ุนู†ูˆุงู† ุงู„ุชุณู„ูŠู… ุงู„ุฃุณุงุณูŠ -> ุนู†ูˆุงู† ุงู„ุชุณู„ูŠู… ููŠ ุงู„ุฌุฒูŠุฑุฉ)", + "operationId": "updateDeliveryRequestBeforeDelivery", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeliveryRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "ู†ุฌุงุญ ุชุญุฏูŠุซ ุทู„ุจ ุงู„ุชุณู„ูŠู…" + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/purchases/{purchaseId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุณุฌู„ ุงู„ุทู„ุจ ุนู† ุทุฑูŠู‚ ุงู„ุดุฑุงุก", + "description": "(ู„ุง ูŠู…ูƒู† ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุทู„ุจ -> ApiErrorResponseCode.RESOURCE_NOT_FOUND)", + "operationId": "getMyOrderByPurchase", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุชูุงุตูŠู„ ุงู„ุทู„ุจ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + }, + "delete": { + "summary": "ุฃู…ุฑ ุงู„ุฅุฌู‡ุงุถ", + "description": "(ู„ุง ูŠู…ูƒู† ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุทู„ุจ -> ApiErrorResponseCode.RESOURCE_NOT_FOUND)", + "operationId": "abortOrder", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "required": false, + "name": "restoreCartItems", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุงู„ุฅุฌู‡ุงุถ" + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + }, + "post": { + "summary": "ุงู„ู†ุธุงู… ุงู„ูƒุงู…ู„", + "description": "(ู„ุง ูŠู…ูƒู† ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุทู„ุจ -> ApiErrorResponseCode.RESOURCE_NOT_FOUND)", + "operationId": "completeOrder", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ู„ุฅูƒู…ุงู„", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/order-line-tickets": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุณุฌู„ ุชุฐูƒุฑุฉ ุฎุท ุงู„ุทู„ุจ", + "operationId": "getOrderLineTickets", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "query", + "name": "ticket", + "schema": { + "$ref": "#/components/schemas/OrderLineTicketEnum" + } + }, + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "ู‚ุงุฆู…ุฉ ุชุฐุงูƒุฑ ุฎุท ุงู„ุทู„ุจ (ุงู„ุนูˆุฏุฉ ุฃูˆ ุงู„ุฅู„ุบุงุก)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MyOrderLineTicketListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/order-line-tickets/count/summary": { + "get": { + "summary": "ูŠุญุณุจ ุชุฐุงูƒุฑ ุงู„ุฅุฑุฌุงุน/ุงู„ุฅู„ุบุงุก ุงู„ู…ูุชูˆุญุฉ (ุฃูˆ ุงู„ู…ูƒุชู…ู„ุฉ ู…ุคุฎุฑู‹ุง) ุงู„ุฎุงุตุฉ ุจุงู„ู…ุณุชุฎุฏู… (ู„ู„ุนุฑุถ ุนู„ู‰ ุตูุญุชูŠ).", + "operationId": "getOrderLineTicketsCountSummary", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุนุฏ ุชุฐุงูƒุฑ OL. (ุงู„ุนูˆุฏุฉ ุฃูˆ ุงู„ุฅู„ุบุงุก)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MyOLTicketsCountDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/prompts/creatable-review-prompt": { + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ู…ุฑุงุฌุนุฉ ุฅุจุฏุงุนูŠุฉ ุณุฑูŠุนุฉ ู…ุน ุณุทุฑ ุงู„ุทู„ุจ", + "operationId": "getCreatableReviewPrompt", + "tags": [ + "prompt" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ู…ูˆุฌู‡ ุงู„ู…ุฑุงุฌุนุฉ ุงู„ุฅุจุฏุงุนูŠุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreatableReviewPromptDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/refund-account": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุญุณุงุจ ุงุณุชุฑุฏุงุฏ ุงู„ู…ุณุชุฎุฏู…", + "operationId": "getUserRefundAccount", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุญุณุงุจ ุงุณุชุฑุฏุงุฏ ู„ู„ู…ุณุชุฎุฏู…", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserRefundAccountDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + }, + "post": { + "summary": "ุญูุธ ุญุณุงุจ ุงู„ุงุณุชุฑุฏุงุฏ", + "operationId": "saveRefundAccount", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RefundAccountDto" + } + } + } + }, + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุงู„ุญูุธ" + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/orders/{orderId}/lines/cancel": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ], + "put": { + "summary": "ุฅู„ุบุงุก ุนู†ุตุฑ ุงู„ุทู„ุจ", + "description": "- ุงู„ุฃุฎุทุงุก ุงู„ู…ุญุชู…ู„ุฉ - `CANNOT_REQUEST_REFUND_AFTER_CONFIRM_RECEIPT (7004)` - ุนู†ุฏ ุทู„ุจ ุฅู†ุดุงุก ุชุฐูƒุฑุฉ ุฅู„ุบุงุก ู„ุฎุท ุงู„ุทู„ุจ ุญูŠุซ ุชู… ุชุฃูƒูŠุฏ ุงู„ุดุฑุงุก ุจุงู„ูุนู„", + "operationId": "requestToCancelOrderItem", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OLCRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "ุณุฌู„ ุงู„ุทู„ุจ ู…ุน ุชุฐูƒุฑุฉ ุงู„ุฅู„ุบุงุก ุงู„ุชูŠ ุชู… ุฅู†ุดุงุคู‡ุง", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/{orderId}/lines/cancel/v2": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "ุชู‚ุฏูŠุฑ ุฅู„ุบุงุก ุนู†ุตุฑ ุงู„ุทู„ุจ", + "operationId": "estimateOrderItemCancellationV2", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartialOrderItemDto" + } + } + } + } + }, + "responses": { + "200": { + "description": "ู†ุชูŠุฌุฉ ุงู„ุชู‚ุฏูŠุฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OLCEstimationResultDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/{orderId}/lines/cancel/{ticketId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "ticketId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุชูุงุตูŠู„ ุทู„ุจ ุฅู„ุบุงุก ุงู„ุชุฐูƒุฑุฉ", + "operationId": "getOrderItemCancelTicket", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุฅู„ุบุงุก ุงุณุชุฌุงุจุฉ ุงู„ุชุฐูƒุฑุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderLineCancelTicketWithOrderDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "ticketId", + "schema": { + "type": "string" + } + } + ] + }, + "delete": { + "summary": "ุณุญุจ ุฅู„ุบุงุก ุนู†ุตุฑ ุงู„ุทู„ุจ", + "operationId": "withdrawOrderItemCancelTicket", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุณุฌู„ ุงู„ุทู„ุจ ู…ุน ุงู„ุชุฐูƒุฑุฉ ุงู„ู…ุณุญูˆุจุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "ticketId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/{orderId}/lines/return": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ], + "put": { + "summary": "ุงู„ุจู†ุฏ ุฃู…ุฑ ุงู„ุนูˆุฏุฉ", + "description": "- ุฃุฎุทุงุก ู…ุญุชู…ู„ุฉ - `CANNOT_REQUEST_REFUND_AFTER_CONFIRM_RECEIPT (7004)` - ุนู†ุฏ ุทู„ุจ ุฅู†ุดุงุก ุชุฐูƒุฑุฉ ุนูˆุฏุฉ ู„ุฎุท ุงู„ุทู„ุจ ุญูŠุซ ุชู… ุชุฃูƒูŠุฏ ุงู„ุดุฑุงุก ุจุงู„ูุนู„ - `RESOURCE_NOT_FOUND (4)` - ู„ุง ูŠู…ูƒู† ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุทู„ุจ - `LIMITATION_EXCEEDED (5)` - ู…ุชู‰ ูŠุญุชูˆูŠ imageUrls ุนู„ู‰ ุฃูƒุซุฑ ู…ู† 3 ุนู†ุงุตุฑ", + "operationId": "requestToReturnOrderItem", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OLRRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "ุณุฌู„ ุงู„ุทู„ุจ ู…ุน ุชุฐูƒุฑุฉ ุงู„ุนูˆุฏุฉ ุงู„ุชูŠ ุชู… ุฅู†ุดุงุคู‡ุง", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/{orderId}/lines/return/v2": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "ุชู‚ุฏูŠุฑ ุฅุฑุฌุงุน ุนู†ุตุฑ ุงู„ุทู„ุจ", + "operationId": "estimateOrderItemReturningV2", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OLREstimateRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "ู†ุชูŠุฌุฉ ุงู„ุชู‚ุฏูŠุฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OLREstimationResultDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/{orderId}/lines/return/{ticketId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "ticketId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุชูุงุตูŠู„ ุชุฐูƒุฑุฉ ุฅุฑุฌุงุน ุนู†ุตุฑ ุงู„ุทู„ุจ", + "operationId": "getOrderItemReturnTicket", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงุณุชุฌุงุจุฉ ุชุฐูƒุฑุฉ ุงู„ุนูˆุฏุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderLineReturnTicketWithOrderDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "ticketId", + "schema": { + "type": "string" + } + } + ] + }, + "delete": { + "summary": "ุณุญุจ ุนู†ุตุฑ ุงู„ุทู„ุจ ุงู„ุนุงุฆุฏ", + "operationId": "withdrawOrderItemReturnTicket", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุณุฌู„ ุงู„ุทู„ุจ ู…ุน ุงู„ุชุฐูƒุฑุฉ ุงู„ู…ุณุญูˆุจุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "ticketId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/purchases/{topic}/{purchaseId}/payments/iamport": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "ุงุจุฏุฃ ุฏูุน iport ู„ุดุฑุงุก ู…ุญุฏุฏ", + "description": "(ู„ุง ูŠู…ูƒู† ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุดุฑุงุก -> ApiErrorResponseCode.RESOURCE_NOT_FOUND)", + "operationId": "startIamportPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StartIamportPaymentRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "ุงุณุชูŠุฑุงุฏ ู…ูˆุงุฏ ุงู„ุฏูุน", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IamportPaymentMaterialDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/purchases/{topic}/{purchaseId}/payments/iamport/merchantIds/{merchantId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "ุฅู†ู‡ุงุก ุนู…ู„ูŠุฉ ุงู„ุฏูุน ุงู„ู…ุณุชูˆุฑุฏุฉ", + "description": "( ุงู„ู…ุจู„ุบ ุงู„ู…ุฏููˆุน ุบูŠุฑ ู…ุชุทุงุจู‚ -> ApiErrorResponseCode.PAYMENT_NOT_FULLY_PAID )", + "operationId": "finishIamportPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุงู„ู…ุนุงู„ุฌุฉ" + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ] + }, + "delete": { + "summary": "ุงู„ุชุฎู„ูŠ ุนู† ุฏูุน ุงู„ุงุณุชูŠุฑุงุฏ", + "description": "(ู„ุง ูŠู…ูƒู† ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุดุฑุงุก -> ApiErrorResponseCode.RESOURCE_NOT_FOUND)", + "operationId": "abandonIamportPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุงู„ู…ุนุงู„ุฌุฉ" + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/purchases/{topic}/{purchaseId}/payments/toss": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "ุงู„ุจุฏุก ููŠ ุฅุฑู… ุงู„ุฏูุน ู„ุดุฑุงุก ู…ุญุฏุฏ", + "description": "(ู„ุง ูŠู…ูƒู† ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุดุฑุงุก -> ApiErrorResponseCode.RESOURCE_NOT_FOUND)", + "operationId": "startTossPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StartTossPaymentRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "ุฅุฑู… ู…ูˆุงุฏ ุงู„ุฏูุน", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TossPaymentMaterialDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/purchases/{topic}/{purchaseId}/payments/toss/merchantIds/{merchantId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "ุฅู†ู‡ุงุก ุนู…ู„ูŠุฉ ุงู„ุฏูุน", + "description": "( ุงู„ู…ุจู„ุบ ุงู„ู…ุฏููˆุน ุบูŠุฑ ู…ุชุทุงุจู‚ -> ApiErrorResponseCode.PAYMENT_NOT_FULLY_PAID )", + "operationId": "finishTossPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุงู„ู…ุนุงู„ุฌุฉ" + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ] + }, + "delete": { + "summary": "ุงู„ุชุฎู„ูŠ ุนู† ุฅุฑู… ุงู„ุฏูุน", + "description": "(ู„ุง ูŠู…ูƒู† ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุดุฑุงุก -> ApiErrorResponseCode.RESOURCE_NOT_FOUND)", + "operationId": "abandonTossPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุงู„ู…ุนุงู„ุฌุฉ" + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/purchases/{topic}/{purchaseId}/payments/connect-pay": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "ุงุจุฏุฃ ุงู„ุฏูุน ุนุจุฑ Connect-Pay ู„ุดุฑุงุก ู…ุญุฏุฏ", + "description": "(ู„ุง ูŠู…ูƒู† ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุดุฑุงุก -> ApiErrorResponseCode.RESOURCE_NOT_FOUND)", + "operationId": "startConnectPayPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StartConnectPayPaymentRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "ุฑุจุท ู…ูˆุงุฏ ุงู„ุฏูุน", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectPayPaymentMaterialDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/purchases/{topic}/{purchaseId}/payments/connect-pay/merchantIds/{merchantId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "ุฅู†ู‡ุงุก ุนู…ู„ูŠุฉ ุงู„ุฏูุน ุนุจุฑ ุงู„ุงุชุตุงู„", + "description": "( ุงู„ู…ุจู„ุบ ุงู„ู…ุฏููˆุน ุบูŠุฑ ู…ุชุทุงุจู‚ -> ApiErrorResponseCode.PAYMENT_NOT_FULLY_PAID )", + "operationId": "finishConnectPayPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุงู„ู…ุนุงู„ุฌุฉ" + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ] + }, + "delete": { + "summary": "ุงู„ุชุฎู„ูŠ ุนู† ุฏูุน ุงู„ุงุชุตุงู„", + "description": "(ู„ุง ูŠู…ูƒู† ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุดุฑุงุก -> ApiErrorResponseCode.RESOURCE_NOT_FOUND)", + "operationId": "abandonConnectPayPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุงู„ู…ุนุงู„ุฌุฉ" + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/purchases/{topic}/{purchaseId}/payments/dry": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "ุจุฏุก ุงู„ุฏูุน ุงู„ุชุฌุฑูŠุจูŠ ู„ุนู…ู„ูŠุฉ ุดุฑุงุก ู…ุญุฏุฏุฉ", + "description": "(ู„ุง ูŠู…ูƒู† ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุดุฑุงุก -> ApiErrorResponseCode.RESOURCE_NOT_FOUND)", + "operationId": "startDryRunPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ู…ูˆุงุฏ ุงู„ุฏูุน ุงู„ุฌุงูุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DryRunPaymentMaterialDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/purchases/{topic}/{purchaseId}/payments/dry/merchantIds/{merchantId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "ุฅู†ู‡ุงุก ุนู…ู„ูŠุฉ ุงู„ุฏูุน ุงู„ุฌุงูุฉ", + "operationId": "finishDryRunPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุงู„ู…ุนุงู„ุฌุฉ" + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ] + }, + "delete": { + "summary": "ุงู„ุชุฎู„ูŠ ุนู† ุงู„ุฏูุน ุงู„ุฌุงู", + "description": "(ู„ุง ูŠู…ูƒู† ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุดุฑุงุก -> ApiErrorResponseCode.RESOURCE_NOT_FOUND)", + "operationId": "abandonDryRunPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุงู„ู…ุนุงู„ุฌุฉ" + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/purchases/{topic}/{purchaseId}/payments/free": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "ุงุจุฏุฃ ุงู„ุฏูุน ุงู„ู…ุฌุงู†ูŠ ู„ุนู…ู„ูŠุฉ ุดุฑุงุก ู…ุญุฏุฏุฉ", + "description": "(ู„ุง ูŠู…ูƒู† ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุดุฑุงุก -> ApiErrorResponseCode.RESOURCE_NOT_FOUND)", + "operationId": "startFreePayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุงู„ู…ุนุงู„ุฌุฉ" + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/banners/types/{bannerType}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "bannerType", + "schema": { + "$ref": "#/components/schemas/BannerTypeEnum" + } + } + ], + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู„ุงูุชุงุช", + "operationId": "getBanners", + "tags": [ + "banner" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ู‚ุงุฆู…ุฉ ุงู„ุจุงู†ุฑ", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BannerDto" + } + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "bannerType", + "schema": { + "$ref": "#/components/schemas/BannerTypeEnum" + } + } + ] + } + }, + "/banners/category/{categoryId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู„ุงูุชุงุช ู„ู„ูุฆุงุช", + "operationId": "getCategoryBanners", + "tags": [ + "banner" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ู‚ุงุฆู…ุฉ ุงู„ุจุงู†ุฑ", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BannerDto" + } + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/banners/brand-promotion": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู„ุงูุชุงุช ู„ู„ุชุฑูˆูŠุฌ ู„ู„ุนู„ุงู…ุฉ ุงู„ุชุฌุงุฑูŠุฉ", + "operationId": "getBrandPromotionBanners", + "parameters": [ + { + "in": "query", + "required": false, + "name": "brandSourcingTagIdOfPromotedChannelGroup", + "description": "ู…ุนุฑู ุนู„ุงู…ุฉ ู…ุตุงุฏุฑ ุงู„ุนู„ุงู…ุฉ ุงู„ุชุฌุงุฑูŠุฉ ุงู„ู…ู‚ุงุจู„ุฉ ู„ู…ุฌู…ูˆุนุฉ ู‚ู†ูˆุงุช ุงู„ุดุฑุงุก", + "schema": { + "type": "string" + } + } + ], + "tags": [ + "banner" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ู‚ุงุฆู…ุฉ ุงู„ุจุงู†ุฑ", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BannerDto" + } + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/banners/brand/{brandId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "brandId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู„ุงูุชุฉ ู„ู„ุนู„ุงู…ุฉ ุงู„ุชุฌุงุฑูŠุฉ", + "operationId": "getBrandBanners", + "tags": [ + "banner" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ู‚ุงุฆู…ุฉ ุงู„ุจุงู†ุฑ", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BannerDto" + } + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "brandId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/collections/{collectionId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "collectionId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุงู„ู…ุฌู…ูˆุนุฉ", + "description": "(ู„ุง ูŠู…ูƒู† ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ู…ุฌู…ูˆุนุฉ -> ApiErrorResponseCode.RESOURCE_NOT_FOUND)", + "operationId": "getCollection", + "tags": [ + "collection" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- ุงู„ุชุฌู…ูŠุน - ุฅุฐุง ุชู… ุชุทุจูŠู‚ ุฎุตู… Queenit ุงู„ููˆุฑูŠุŒ ูุฅู† `ProductDto` ูŠุนุฑุถ ุงู„ู…ุจู„ุบ ู…ุน ุงู„ุฎุตู… ุงู„ููˆุฑูŠ ุงู„ู…ุทุจู‚ - ุงู„ุญู‚ูˆู„ ุงู„ู…ุชุฃุซุฑุฉ: `finalPrice`ุŒ `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CollectionDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "collectionId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/search/products": { + "get": { + "summary": "ู…ู†ุชุฌุงุช ุงู„ุจุญุซ", + "operationId": "searchProducts", + "tags": [ + "search" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "name": "keyword", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "description": "ุฅุฐุง ู„ู… ูŠุชู… ุชุญุฏูŠุฏ orderByุŒ ูุณูŠุชู… ุชุนูŠูŠู† orderBy ุนู„ู‰ MATCHING_SCORE_DESC ูƒู‚ูŠู…ุฉ ุงูุชุฑุงุถูŠุฉ.", + "name": "orderBy", + "required": false, + "schema": { + "$ref": "#/components/schemas/ProductSearchingOrderByEnum" + } + }, + { + "in": "query", + "name": "categoryId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "categoryIds", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "name": "brandId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "brandIds", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "required": false, + "name": "minPrice", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "maxPrice", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "description": "ู‚ุงุฆู…ุฉ ู…ุนุฑูุงุช ุณู…ุงุช ุงู„ู…ู†ุชุฌ ู„ู„ุชุตููŠุฉ", + "required": false, + "name": "productFeatureIds", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "deprecated": true, + "required": false, + "description": "(ู…ู‡ู…ู„) ุงุณุชุฎุฏู… EnableTotalCountุŒ EnableProductFeatureAggreagtionุŒ EnableProductCategoryAggregationุŒ EnableBrandAggregation.", + "name": "enabledProductAggregation", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "ุงุถุจุท ุนู„ู‰ "ุตุญูŠุญ" ุฅุฐุง ูƒุงู† ุงู„ุนุฏุฏ ุงู„ุฅุฌู…ุงู„ูŠ ู…ุทู„ูˆุจู‹ุง ููŠ ุชุฌู…ูŠุน ุงู„ู…ู†ุชุฌ..", + "name": "enabledTotalCount", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "ุงุถุจุท ุนู„ู‰ "ุตุญูŠุญ" ุฅุฐุง ูƒุงู† ุนุฏุฏ ุณู…ุงุช ุงู„ู…ู†ุชุฌ ู…ุทู„ูˆุจู‹ุง ููŠ ุชุฌู…ูŠุน ุงู„ู…ู†ุชุฌ..", + "name": "enabledProductFeatureAggregation", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "ู‚ู… ุจุงู„ุชุนูŠูŠู† ุนู„ู‰ "ุตุญูŠุญ" ุฅุฐุง ูƒุงู† ุนุฏุฏ ุงู„ู…ู†ุชุฌุงุช ู„ูƒู„ ูุฆุฉ ู…ุทู„ูˆุจู‹ุง ููŠ ุชุฌู…ูŠุน ุงู„ู…ู†ุชุฌุงุช..", + "name": "enabledProductCategoryAggregation", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "ู‚ู… ุจุงู„ุชุนูŠูŠู† ุนู„ู‰ "ุตุญูŠุญ" ุฅุฐุง ูƒุงู† ุนุฏุฏ ุงู„ุนู„ุงู…ุงุช ุงู„ุชุฌุงุฑูŠุฉ ู…ุทู„ูˆุจู‹ุง ููŠ ุชุฌู…ูŠุน ุงู„ู…ู†ุชุฌุงุช..", + "name": "enabledBrandAggregation", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "ู‡ุฐุง ุงู„ุญู‚ู„ ู…ุทู„ูˆุจ ู„ู„ุชุฌุฑุจุฉ ุนู†ุฏ ุชุทุจูŠู‚ ู…ูŠุฒุงุช ู…ุญุฏุฏุฉ ุชุชุนู„ู‚ ุจุงู„ุจุญุซ..", + "name": "keywordSearchExperimentIds", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "- ุงู„ู…ู†ุชุฌุงุช ุงู„ุชูŠ ุชู… ุงู„ุจุญุซ ุนู†ู‡ุง - ุนู†ุฏ ุชุทุจูŠู‚ ุฎุตู… Queenit ุงู„ููˆุฑูŠุŒ ูŠุนุฑุถ `AppProductDto' ุงู„ู…ุจู„ุบ ู…ุน ุชุทุจูŠู‚ ุงู„ุฎุตู… ุงู„ููˆุฑูŠ - ุงู„ุญู‚ูˆู„ ุงู„ู…ุชุฃุซุฑุฉ: `finalPrice`ุŒ `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/autocomplete": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู…ุฑุดุญูŠ ุงู„ุฅูƒู…ุงู„ ุงู„ุชู„ู‚ุงุฆูŠ", + "operationId": "getAutocompleteCandidates", + "tags": [ + "autocomplete" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "query", + "name": "query", + "required": true, + "schema": { + "type": "string" + }, + "description": "ุงุณุชุนู„ุงู… ุงู„ุฅูƒู…ุงู„ ุงู„ุชู„ู‚ุงุฆูŠ" + }, + { + "in": "query", + "name": "brandSize", + "required": true, + "schema": { + "type": "integer", + "format": "int32", + "default": 0 + }, + "description": "ุงู„ุญุฌู… ุงู„ู…ุทู„ูˆุจ ู„ู…ุฑุดุญ ุงู„ุฅูƒู…ุงู„ ุงู„ุชู„ู‚ุงุฆูŠ ู„ู„ุนู„ุงู…ุฉ ุงู„ุชุฌุงุฑูŠุฉ" + } + ], + "responses": { + "200": { + "description": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู‚ุงุฆู…ุฉ ุงู„ุฅูƒู…ุงู„ ุงู„ุชู„ู‚ุงุฆูŠ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AutocompleteResponseDto" + } + } + } + } + } + } + }, + "/couponBooks/{couponBookCode}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "couponBookCode", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ูƒุชุงุจ ุงู„ู‚ุณูŠู…ุฉ", + "description": "(ู„ุง ูŠู…ูƒู† ุงู„ุนุซูˆุฑ ุนู„ู‰ ุฏูุชุฑ ุงู„ู‚ุณูŠู…ุฉ -> ApiErrorResponseCode.RESOURCE_NOT_FOUND)", + "operationId": "getCouponBook", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ูƒุชุงุจ ุงู„ู‚ุณูŠู…ุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CouponBookDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "couponBookCode", + "schema": { + "type": "string" + } + } + ] + } + }, + "/couponBooks/{couponBookCode}/asset": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "couponBookCode", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ุฃุตู„ ูƒุชุงุจ ุงู„ู‚ุณูŠู…ุฉ", + "description": "(ู„ุง ูŠู…ูƒู† ุงู„ุนุซูˆุฑ ุนู„ู‰ ุฏูุชุฑ ุงู„ู‚ุณูŠู…ุฉ -> ApiErrorResponseCode.RESOURCE_NOT_FOUND)", + "operationId": "getCouponBookAsset", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุฃุตู„ ูƒุชุงุจ ุงู„ู‚ุณูŠู…ุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CouponBookAssetDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "couponBookCode", + "schema": { + "type": "string" + } + } + ] + } + }, + "/couponBooks/{couponBookCode}/coupons": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "couponBookCode", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "ุฅุตุฏุงุฑ ูƒุงูุฉ ุงู„ู‚ุณุงุฆู… ููŠ ูƒุชุงุจ ุงู„ู‚ุณูŠู…ุฉ", + "description": "(ู„ุง ูŠู…ูƒู† ุงู„ุนุซูˆุฑ ุนู„ู‰ ุฏูุชุฑ ุงู„ูƒูˆุจูˆู†ุงุช -> ApiErrorResponseCode.RESOURCE_NOT_FOUND) (ู„ุง ูŠู…ูƒู† ุฅุตุฏุงุฑ ู‚ุณุงุฆู… -> ApiErrorResponseCode.COUPON_BOOK_ISSUABLES_NOT_EXIST)", + "operationId": "issueAllCouponsInCouponBook", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ูƒูˆุจูˆู†ุงุช ุงู„ุตุงุฏุฑุฉ ุนู† ุทุฑูŠู‚ ูƒุชุงุจ ุงู„ู‚ุณูŠู…ุฉ", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IssuedCouponDto" + } + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "couponBookCode", + "schema": { + "type": "string" + } + } + ] + } + }, + "/coupons/displays/products/{productId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "productId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ูƒูˆุจูˆู†ุงุช ุญุณุจ ุนุฑุถ ุงู„ู…ู†ุชุฌ", + "operationId": "listDisplayingCouponsForProduct", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ุญุตูˆู„ ุนู„ู‰ ูƒูˆุจูˆู†ุงุช ุญุณุจ ุนุฑุถ ุงู„ู…ู†ุชุฌ", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCouponDto" + } + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "productId", + "schema": { + "type": "string" + } + } + ] + }, + "post": { + "summary": "ุฅุตุฏุงุฑ ุฌู…ูŠุน ุงู„ู‚ุณุงุฆู… ุญุณุจ ุนุฑุถ ุงู„ู…ู†ุชุฌ", + "operationId": "issueAllDisplayingCoupons", + "description": "( ู„ุง ุชูˆุฌุฏ ู‚ุณุงุฆู… ุนุฑุถ ู„ุฅุตุฏุงุฑู‡ุง -> ApiErrorResponseCode.DISPLAYING_COUPONS_ISSUABLE_NOT_EXIST )", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ู„ุฅุตุฏุงุฑ", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IssuedCouponDto" + } + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "productId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/coupons/displays/products/{productId}/v2": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "productId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ูƒูˆุจูˆู†ุงุช ุนู† ุทุฑูŠู‚ ุนุฑุถ ุงู„ู…ู†ุชุฌ v2", + "operationId": "listDisplayingCouponsForProductV2", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ุญุตูˆู„ ุนู„ู‰ ูƒูˆุจูˆู†ุงุช ุนู† ุทุฑูŠู‚ ุนุฑุถ ุงู„ู…ู†ุชุฌ v2", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppCouponListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "productId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/coupons/{couponCode}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "couponCode", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู‚ุณูŠู…ุฉ ุนู† ุทุฑูŠู‚ ุฑู…ุฒ ุงู„ู‚ุณูŠู…ุฉ", + "operationId": "getCouponByCode", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ู‚ุณูŠู…ุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CouponDetailDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "couponCode", + "schema": { + "type": "string" + } + } + ] + }, + "post": { + "summary": "ู‚ุณูŠู…ุฉ ุงู„ุฅุตุฏุงุฑ", + "description": "( ู„ุง ูŠู…ูƒู† ุงู„ุนุซูˆุฑ ุนู„ู‰ ู‚ุณูŠู…ุฉ -> ApiErrorResponseCode.RESOURCE_NOT_FOUND ) ( ุชู… ุชุนุทูŠู„ ุงู„ู‚ุณูŠู…ุฉ -> ApiErrorResponseCode.COUPON_NOT_ENABLED ) ( ู‚ุจู„ ุชุงุฑูŠุฎ ุจุฏุก ุฅุตุฏุงุฑ ุงู„ู‚ุณูŠู…ุฉ -> ApiErrorResponseCode.COUPON_ISSUE_BEFORE_BEGIN ) ( ุจุนุฏ ุชุงุฑูŠุฎ ุงู†ุชู‡ุงุก ุฅุตุฏุงุฑ ุงู„ู‚ุณูŠู…ุฉ -> ุจุนุฏ _END ) (ูŠุชุฌุงูˆุฒ ุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ ุนุฏุฏ ุฅุตุฏุงุฑุงุช ุงู„ู‚ุณูŠู…ุฉ -> ApiErrorResponseCode.COUPON_ISSUE_LIMIT_EXCEEDED ) ( ูŠุชุฌุงูˆุฒ ุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ ู„ุนุฏุฏ ุฅุตุฏุงุฑุงุช ุงู„ู‚ุณูŠู…ุฉ ู„ูƒู„ ู…ุณุชุฎุฏู… -> ApiErrorResponseCode.COUPON_ISSUE_LIMIT_PER_USER_EXCEEDED ) ( ู„ุง ูŠุณุชู‡ุฏู ุฅุตุฏุงุฑ ุงู„ู‚ุณูŠู…ุฉ -> ApiErrorResponseCode.COUPON_ISSUE_NOT_TARGET )", + "operationId": "issueCoupon", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ู„ุฅุตุฏุงุฑ" + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "couponCode", + "schema": { + "type": "string" + } + } + ] + } + }, + "/coupons": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ูƒูˆุจูˆู†ุงุชูŠ ุงู„ุตุงุฏุฑุฉ", + "operationId": "getIssuedCoupons", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ูƒูˆุจูˆู†ุงุช ุตุงุฏุฑุฉ", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IssuedCouponDto" + } + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/coupons/first-kakao-login/issuable": { + "get": { + "summary": "ุชุญู‚ู‚ ู…ู† ุฃู† ุงู„ู…ุณุชุฎุฏู… ุงู„ุญุงู„ูŠ ูŠู…ูƒู†ู‡ ุฅุตุฏุงุฑ ู‚ุณูŠู…ุฉ ุชุณุฌูŠู„ ุฏุฎูˆู„ kakao ุงู„ุฃูˆู„ู‰", + "operationId": "checkFirstKakaoLoginCouponIssueable", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุชุญู‚ู‚ ู…ู† ุฃู† ู‚ุณูŠู…ุฉ ุชุณุฌูŠู„ ุงู„ุฏุฎูˆู„ ุงู„ุฃูˆู„ู‰ ู„ู€ kakao ู‚ุงุจู„ุฉ ู„ู„ุฅุตุฏุงุฑ ุจุฑู‚ู… ู‡ุงุชู ุงู„ู…ุณุชุฎุฏู… ุงู„ุญุงู„ูŠ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CheckFirstKakaoLoginCouponIssuableResponseDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/shop-live/authorize": { + "post": { + "summary": "ุฅู†ุดุงุก ุฑู…ุฒ ู…ู…ูŠุฒ ู„ู„ู…ุชุฌุฑ ุจุงุณุชุฎุฏุงู… ุงุณู… ุงู„ู…ุณุชุฎุฏู…", + "operationId": "generateShopLiveAccessToken", + "tags": [ + "shopLive" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShopLiveTokenRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุฅู†ุดุงุก ุฑู…ุฒ ู…ุชุฌุฑ ู…ุจุงุดุฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShopLiveTokenResponseDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/shop-live/campaigns/upcoming": { + "get": { + "parameters": [ + { + "in": "query", + "required": false, + "name": "includeOnAir", + "description": "ู…ุง ุฅุฐุง ูƒุงู† ุณูŠุชู… ุงุณุชุฑุฏุงุฏ ุงู„ู…ุนู„ูˆู…ุงุช ู„ู‡ุฐู‡ ุงู„ุญู…ู„ุฉ ุฅุฐุง ูƒุงู†ุช ู‡ู†ุงูƒ ู…ุนู„ูˆู…ุงุช ุจุซ ุญุงู„ูŠู‹ุง. ุฅุฐุง ูƒุงู† ุฎุทุฃุŒ ูุณูŠุชู… ุนุฑุถ ู…ุนู„ูˆู…ุงุช ุงู„ุจุซ ุงู„ู…ุฌุฏูˆู„ุฉ ุจุนุฏ ุงู„ุญุงุถุฑ ูู‚ุท.", + "schema": { + "type": "boolean" + } + }, + { + "in": "query", + "required": false, + "name": "includePrivate", + "description": "ู…ุง ุฅุฐุง ูƒุงู† ุณูŠุชู… ุนุฑุถ ู…ุนู„ูˆู…ุงุช ุญูˆู„ ุงู„ุญู…ู„ุงุช ุงู„ุชูŠ ุชู… ุชุนูŠูŠู†ู‡ุง ุนู„ู‰ ุฃู†ู‡ุง ุฎุงุตุฉ", + "schema": { + "type": "boolean" + } + } + ], + "summary": "ุฅุฐุง ูƒุงู† ู‡ู†ุงูƒ ุจุซ ู…ุฌุฏูˆู„ ู„ุฃู‚ุฑุจ ูˆู‚ุช ุจุนุฏ ุงู„ุญุงุถุฑ ุฃูˆ ุจุซ ู‚ูŠุฏ ุงู„ุชู‚ุฏู… ุญุงู„ูŠู‹ุง (ุญุณุจ ุงู„ุธุฑูˆู)ุŒ ูุณูŠุชู… ุฅุฑุฌุงุน ู…ุนู„ูˆู…ุงุช ุญูˆู„ ุงู„ุจุซ.", + "operationId": "getUpcomingCampaign", + "tags": [ + "shopLive" + ], + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ู„ู„ุญุตูˆู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช ุงู„ุญู…ู„ุฉ ุงู„ู‚ุงุฏู…ุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShopLiveCampaignResponseDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/shop-live/campaigns/{campaignKey}/metadata": { + "get": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "campaignKey", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "required": false, + "name": "resolutionLevel", + "description": "ู…ุณุชูˆู‰ ุงู„ู‚ุฑุงุฑ", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "summary": "ุนุฑุถ ู…ุนู„ูˆู…ุงุช ู…ู„ุฎุตุฉ ู…ุซู„ ุญุงู„ุฉ ุงู„ุจุซ ุงู„ูุฑุฏูŠ (ุงู„ุญู…ู„ุฉ) ูˆุนู†ูˆุงู† URL ู„ู„ุจุซ ุงู„ู…ุจุงุดุฑ", + "operationId": "getCampaignMetadata", + "tags": [ + "shopLive" + ], + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุงู„ุจูŠุงู†ุงุช ุงู„ูˆุตููŠุฉ ู„ู„ุญู…ู„ุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShopLiveCampaignMetadataResponseDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/points": { + "get": { + "parameters": [ + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "name": "cursor", + "description": "EpochSeconds", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "pointType", + "description": "ู†ูˆุน ุงู„ุชุฑุงูƒู… / null = ุนุฑุถ ุงู„ูƒู„", + "required": false, + "schema": { + "$ref": "#/components/schemas/PointAmountTypeEnum" + } + } + ], + "summary": "ุงู„ุชุญู‚ู‚ ู…ู† ุณุฌู„ ุงู„ุชูˆููŠุฑ ุงู„ุฎุงุต ุจุงู„ู…ุณุชุฎุฏู….", + "operationId": "getPointHistory", + "tags": [ + "point" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ู†ู‚ุทุฉ ุงู„ุชุงุฑูŠุฎ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PointHistoryBundleResponseDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/points/now-usable": { + "get": { + "summary": "ุงู„ุชุญู‚ู‚ ู…ู† ุงู„ู†ู‚ุงุท ุงู„ู…ุชุงุญุฉ ู„ู„ู…ุณุชุฎุฏู… ุญุงู„ูŠุง.", + "operationId": "getNowUsablePoint", + "tags": [ + "point" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ู„ู„ุญุตูˆู„ ุนู„ู‰ ู†ู‚ุทุฉ ุตุงู„ุญุฉ ู„ู„ุงุณุชุนู…ุงู„ ุงู„ุขู†", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NowUsablePointDto" + } + } + } + } + } + } + }, + "/points/promotions/{code}/attend": { + "put": { + "summary": "ุญุถูˆุฑ ุญุฏุซ ุชุฑูˆูŠุฌ ุงู„ุงุฏุฎุงุฑ.", + "operationId": "attendPromotion", + "tags": [ + "point" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "code", + "description": "ุงู„ุฑู…ุฒ ุงู„ุชุฑูˆูŠุฌูŠ", + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "ุงู„ู†ุฌุงุญ ู„ุญุถูˆุฑ ุงู„ุชุฑูˆูŠุฌ" + } + } + }, + "get": { + "summary": "ุงู„ุชุญู‚ู‚ ู…ู† ุงู„ุญุถูˆุฑ ููŠ ุญุฏุซ ุชุฑูˆูŠุฌ ู†ู‚ุงุท ุงู„ู…ูƒุงูุฃุฉ.", + "operationId": "getAttendPromotionState", + "tags": [ + "point" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "code", + "description": "ุงู„ุฑู…ุฒ ุงู„ุชุฑูˆูŠุฌูŠ", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "ู†ุฌุงุญ ุงู„ุงุณุชุนู„ุงู… ุนู† ุญุถูˆุฑ ุงู„ุชุฑู‚ูŠุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotionAttendedStateDto" + } + } + } + } + } + } + }, + "/product-rankings/{productId}/is-category-best-product": { + "get": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "productId", + "schema": { + "type": "string" + } + } + ], + "summary": "ุงู„ุชุญู‚ู‚ ู…ู† ูˆุฌูˆุฏ ุฃูˆ ุนุฏู… ูˆุฌูˆุฏ ุฃูุถู„ ู…ู†ุชุฌ ููŠ ู‡ุฐู‡ ุงู„ูุฆุฉ", + "operationId": "findCategoryBestProduct", + "tags": [ + "productRanking" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ู†ุฌุงุญ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฃูุถู„ ู…ู†ุชุฌ ููŠ ุงู„ูุฆุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CategoryBestProductDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/referral/code": { + "get": { + "summary": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช ุงู„ุจุญุซ ุนู† ุฑู…ุฒ ุงู„ุฏุนูˆุฉ", + "description": "ุฅุฑุฌุงุน ุฑู…ุฒ ุฏุนูˆุฉ ุงู„ู…ูุญูŠู„. ุจู†ุงุก ุนู„ู‰ ุงู„ุทู„ุจ ุงู„ุฃูˆู„ูŠุŒ ูŠุชู… ุฅู†ุดุงุคู‡ ูˆุฅุนุงุฏุชู‡..", + "operationId": "getReferralCode", + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุฑู…ุฒ ุงู„ุฅุญุงู„ุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReferralCodeDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/referral/user/reward/policy": { + "get": { + "summary": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ู„ู„ุงุณุชุนู„ุงู… ุนู† ุณูŠุงุณุฉ ู…ูƒุงูุฃุฉ ุฏุนูˆุฉ ุงู„ู…ุณุชุฎุฏู…", + "operationId": "getUserReferralPolicy", + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ู†ุชุงุฆุฌ ุงู„ุงุณุชูุณุงุฑ ุนู† ุณูŠุงุณุฉ ู…ูƒุงูุฃุฉ ุฏุนูˆุฉ ุงู„ู…ุณุชุฎุฏู…", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserReferralRewardPolicyDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/referral/user-referral/summary": { + "get": { + "summary": "API ุงู„ุงุณุชุนู„ุงู… ุนู† ู…ุนู„ูˆู…ุงุช ู…ู„ุฎุต ุฏุนูˆุฉ ุงู„ู…ุณุชุฎุฏู…", + "operationId": "getUserReferralSummary", + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ู…ุนู„ูˆู…ุงุช ู…ู„ุฎุต ุฏุนูˆุฉ ุงู„ู…ุณุชุฎุฏู…", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserReferralSummaryDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/referral/user-referral/bonus-box/open": { + "post": { + "summary": "API ู„ูุชุญ ุตู†ุงุฏูŠู‚ ุงู„ู…ูƒุงูุขุช ุงู„ู…ุชุฑุงูƒู…ุฉ ู…ู† ุฎู„ุงู„ ุฅุญุงู„ุงุช ุงู„ู…ุณุชุฎุฏู…", + "description": "API ู„ูุชุญ ู…ุฑุจุน ู…ูƒุงูุฃุฉ ุฅุญุงู„ุฉ ู…ุณุชุฎุฏู… ูˆุงุญุฏ", + "operationId": "openUserReferralBonusBox", + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ู†ุชุงุฆุฌ ูุชุญ ุตู†ุฏูˆู‚ ุงู„ู…ูƒุงูุฃุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserReferralBonusBoxOpenResultDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/referral/user/reward/summary": { + "get": { + "summary": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช ุงู„ุงุณุชุนู„ุงู… ุนู† ู…ุนู„ูˆู…ุงุช ู…ู„ุฎุต ู…ูƒุงูุฃุฉ ุฏุนูˆุฉ ุงู„ู…ุณุชุฎุฏู… -> ุงุณุชุฎุฏู… `getUserReferralSummary`", + "operationId": "getUserReferralRewardSummary", + "deprecated": true, + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ู†ุชุงุฆุฌ ุจุญุซ ุงู„ู…ูƒุงูุฃุฉ ุงู„ุชุฑุงูƒู…ูŠุฉ ุงู„ุชูŠ ุชู… ุชู„ู‚ูŠู‡ุง ู…ู† ุฎู„ุงู„ ุฏุนูˆุฉ ุงู„ู…ุณุชุฎุฏู…", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserReferralRewardSummaryDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/referral/user/reward/estimate": { + "post": { + "summary": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ู„ู„ุชู†ุจุค ุจู…ูƒุงูุฃุฉ ุชูˆุตูŠุฉ ุงู„ู…ุณุชุฎุฏู…", + "description": "- ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช (API) ู„ู„ุชุญู‚ู‚ ู…ู† ุงู„ู†ุชุงุฆุฌ ุงู„ู…ุชูˆู‚ุนุฉ ู„ู„ู†ู‚ุงุท ุงู„ุชูŠ ูŠู…ูƒู† ุฃู† ูŠุญุตู„ ุนู„ูŠู‡ุง ุงู„ู…ูุญูŠู„ ูƒู…ูƒุงูุฃุฉ (ู…ุง ูŠุตู„ ุฅู„ู‰ 50 ู†ู‚ุทุฉ ุชู…ุช ู…ุนุงู„ุฌุชู‡ุง) - ูŠุฌุจ ุนู„ูŠูƒ ุชู…ุฑูŠุฑ "ุฑู‚ู… ูƒูˆุฑูŠ ุจุชู†ุณูŠู‚ Global PhoneNumber" (ู…ุซุงู„: "+821012341234")", + "operationId": "estimateUserReferralRewards", + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserReferralRewardEstimationRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "ู‚ุงุฆู…ุฉ ู…ูƒุงูุขุช ุงู„ุฏุนูˆุฉ ุงู„ุชูŠ ูŠู…ูƒู† ุฃู† ูŠุญุตู„ ุนู„ูŠู‡ุง ุงู„ู…ูุญูŠู„", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserReferralRewardEstimationListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/referral/user": { + "post": { + "summary": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช ุชูˆุตูŠุฉ ุงู„ู…ุณุชุฎุฏู…", + "operationId": "createUserReferral", + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateUserReferralRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "ู†ุฌุงุญ ุชูˆุตูŠุฉ ุงู„ู…ุณุชุฎุฏู…", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateUserReferralResponseDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/referral/user/referred-user-join": { + "post": { + "summary": "ุงู„ู…ูˆุตู‰ ุจู‡ุง API ุฅูƒู…ุงู„ ุชุณุฌูŠู„ ุงู„ู…ุณุชุฎุฏู…", + "operationId": "joinReferredUser", + "description": "ุจุนุฏ ู‚ูŠุงู… ุงู„ู…ุณุชุฎุฏู… ุงู„ู…ูˆุตู‰ ุจู‡ ุจุงู„ุชุณุฌูŠู„ ู…ู† ุฎู„ุงู„ ุฑุงุจุท ุงู„ุฅุญุงู„ุฉุŒ ูŠุชู… ุงุณุชุฏุนุงุก ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช (API).", + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JoinReferredUserRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "ุชู… ุงู„ุชุณุฌูŠู„ ุจู†ุฌุงุญ ู„ู„ู…ุณุชุฎุฏู… ุงู„ู…ูˆุตู‰ ุจู‡", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JoinReferredUserResponseDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/referral/product": { + "post": { + "summary": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช (API) ู„ุฅูƒู…ุงู„ ุดุฑุงุก ุงู„ู…ู†ุชุฌ ุงู„ู…ูˆุตู‰ ุจู‡ุง", + "operationId": "createProductReferral", + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateProductReferralRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "ู‡ุฐู‡ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช ุชู†ุดุฆ ProductReferral ุนู†ุฏ ุดุฑุงุก ู…ู†ุชุฌ ู…ู† ุฎู„ุงู„ ุฑุงุจุท ุชูˆุตูŠุฉ ุงู„ู…ู†ุชุฌ.." + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/games": { + "get": { + "summary": "ู‚ุงุฆู…ุฉ ุงู„ุฃู„ุนุงุจ ู‚ูŠุฏ ุงู„ุชู†ููŠุฐ ุญุงู„ูŠู‹ุง", + "operationId": "getGameList", + "tags": [ + "gamification" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ู‚ุงุฆู…ุฉ ุงู„ู„ุนุจุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActiveGameListResponse" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/games/{gameId}": { + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงู„ุงุณุชุนู„ุงู… ุนู† ู…ุนู„ูˆู…ุงุช ู„ุนุจุฉ ุงู„ู…ุณุชุฎุฏู…", + "operationId": "getGameProgressInfo", + "tags": [ + "gamification" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ู„ุนุจุฉ ู„ู„ู…ุณุชุฎุฏู…", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameUserProgressInfoResponse" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + } + ] + }, + "post": { + "summary": "ุงุณุชู‡ู„ุงูƒ ุงู„ุณู„ุน ุงู„ุฃูˆู„ูŠุฉ", + "operationId": "useInGameCredit", + "tags": [ + "gamification" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameUseInGameCreditRequest" + } + } + } + }, + "responses": { + "200": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ู„ุนุจุฉ ู„ู„ู…ุณุชุฎุฏู…", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameUserProgressInfoResponse" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/games/{gameId}/achieve": { + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู…ูƒุงูุขุช ู„ู…ุณุญ ุงู„ู„ุนุจุฉ", + "operationId": "achieveGame", + "tags": [ + "gamification" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameAchieveRequest" + } + } + } + }, + "responses": { + "204": { + "description": "ุชู… ู…ุณุญ ุงู„ู„ุนุจุฉ" + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/games/{gameId}/missions": { + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุนุฑุถ ู‚ุงุฆู…ุฉ ุงู„ู…ู‡ุงู… ูˆุชู‚ุฏู… ุงู„ู…ู‡ู…ุฉ", + "operationId": "getMissions", + "tags": [ + "gamification" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ู‚ุงุฆู…ุฉ ุงู„ู…ู‡ุงู… ูˆุชู‚ุฏู… ุงู„ู…ู‡ู…ุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameMissionsResponse" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + } + ] + }, + "post": { + "summary": "ุทู„ุจ ุฅูƒู…ุงู„ ุงู„ู…ู‡ู…ุฉ", + "operationId": "achieveMission", + "tags": [ + "gamification" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameMissionAchieveRequest" + } + } + } + }, + "responses": { + "204": { + "description": "ุงูƒุชู…ู„ุช ุงู„ู…ู‡ู…ุฉ" + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/games/{gameId}/missions/{missionId}": { + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "missionId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "post": { + "summary": "ุงุญุตู„ ุนู„ู‰ ู…ูƒุงูุขุช ุงู„ู…ู‡ู…ุฉ", + "operationId": "receiveReward", + "tags": [ + "gamification" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ู…ูƒุงูุขุช ุงู„ู…ู‡ู…ุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameMissionRewardReceiveResponse" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "missionId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ] + } + }, + "/categories/{categoryId}/review-guide": { + "parameters": [ + { + "in": "path", + "name": "categoryId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ุฏู„ูŠู„ ู…ุฑุงุฌุนุฉ ุงู„ูุฆุฉ", + "operationId": "getProductCategoryReviewGuide", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุฏู„ูŠู„ ู…ุฑุงุฌุนุฉ ูุฆุฉ ุงู„ู…ู†ุชุฌ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductCategoryReviewGuideDataDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "categoryId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/style-shots": { + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ุฌู…ูŠุน ุงู„ู„ู‚ุทุงุช ุงู„ุฃู†ูŠู‚ุฉ", + "operationId": "getAllStyleShots", + "tags": [ + "styleShot" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "query", + "name": "categoryId", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "ุงุญุตู„ ุนู„ู‰ ุฌู…ูŠุน ุงู„ู„ู‚ุทุงุช ุงู„ุฃู†ูŠู‚ุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StyleShotListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/style-shots/{id}": { + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ู†ู…ุท ู„ู‚ุทุฉ ุจูˆุงุณุทุฉ ุงู„ู…ุนุฑู", + "operationId": "getStyleShotById", + "tags": [ + "styleShot" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "id", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "ุงุญุตู„ ุนู„ู‰ ู„ู‚ุทุฉ ุฃู†ูŠู‚ุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StyleShotDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/style-shots/categories": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุฌู…ูŠุน ูุฆุงุช ุงู„ู†ู…ุท", + "operationId": "getAllStyleCategory", + "tags": [ + "styleShot" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุฌู…ูŠุน ูุฆุงุช ุงู„ู†ู…ุท", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StyleCategoryListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/style-shots/{id}/equipped-products": { + "get": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "id", + "schema": { + "type": "string" + } + } + ], + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู‚ุงุฆู…ุฉ ุงู„ู…ู†ุชุฌุงุช ุงู„ู…ุฌู‡ุฒุฉ ุจู…ุนุฑูุงุช ุนู†ุงุตุฑ ุงู„ู…ู†ุชุฌ", + "description": "ุงุจุญุซ ุนู† ุงู„ุนู†ุงุตุฑ ุงู„ุชูŠ ุชู… ุงุฑุชุฏุงุคู‡ุง ุจุงุณุชุฎุฏุงู… Style Shot ID", + "operationId": "getEquippedProductListByStyleShotId", + "tags": [ + "styleShot" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- ุงู„ู…ู†ุชุฌุงุช ูˆุนู†ุงุตุฑ ุงู„ู…ู†ุชุฌ (ุงู„ูุฑูŠุฏุฉ ูˆุบูŠุฑ ุงู„ู…ุทู„ูˆุจุฉ) ุญุณุจ ู…ุนุฑูุงุช ุนู†ุงุตุฑ ุงู„ู…ู†ุชุฌ - ุฅุฐุง ุชู… ุชุทุจูŠู‚ ุฎุตู… Queenit ุงู„ููˆุฑูŠุŒ ูุฅู† `ProductDto` ูŠุนุฑุถ ุงู„ู…ุจู„ุบ ู…ุน ุงู„ุฎุตู… ุงู„ููˆุฑูŠ ุงู„ู…ุทุจู‚ - ุงู„ุญู‚ูˆู„ ุงู„ู…ุชุฃุซุฑุฉ: `ุงู„ุณุนุฑ ุงู„ู†ู‡ุงุฆูŠ`ุŒ `ุงู„ู†ุณุจุฉ ุงู„ู…ุฆูˆูŠุฉ ู„ู„ุฎุตู…`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EquippedProductListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/delivery-prediction": { + "get": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "summary": "ุงุญุตู„ ุนู„ู‰ ุชูˆุงุฑูŠุฎ ุงู„ุชู†ุจุค ุงู„ู…ูƒุชู…ู„ุฉ ู„ู„ุชุณู„ูŠู… ูˆุงู„ุงุญุชู…ุงู„ูŠุฉ ุญุณุจ ู…ุนุฑู ุงู„ู…ู†ุชุฌ", + "description": "ุงุณุชุฑุฌุน ุจูŠุงู†ุงุช ูˆู‚ุช ุงูƒุชู…ุงู„ ุงู„ุชุณู„ูŠู… ุงู„ู…ู‚ุฏุฑ ุนุจุฑ ProductId.", + "operationId": "getDeliveryPrediction", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- ุงู„ุญุตูˆู„ ุนู„ู‰ ุจูŠุงู†ุงุช ุชูˆู‚ุน ุงู„ุชุณู„ูŠู… ุงู„ู…ูƒุชู…ู„ุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeliveryPredictionListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/purchase-measurements-statistics": { + "get": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "productId", + "schema": { + "type": "string" + } + } + ], + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุฅุญุตุงุฆูŠุงุช ู‚ูŠุงุณุงุช ุงู„ุดุฑุงุก ุญุณุจ ู…ุนุฑู ุงู„ู…ู†ุชุฌ", + "description": "ุนุฑุถ ุฅุญุตุงุฆูŠุงุช ุงู„ุดุฑุงุก ุญุณุจ ู…ุนุฑู ุงู„ู…ู†ุชุฌ", + "operationId": "getPurchaseMeasurementsStatistics", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- ุงู„ุญุตูˆู„ ุนู„ู‰ ุฅุญุตุงุฆูŠุงุช ู‚ูŠุงุณุงุช ุงู„ุดุฑุงุก", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PurchaseMeasurementsStatisticsListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/purchase-measurements": { + "get": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "productId", + "schema": { + "type": "string" + } + } + ], + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู‚ูŠุงุณุงุช ุงู„ุดุฑุงุก ุญุณุจ ู…ุนุฑู ุงู„ู…ู†ุชุฌ (ุงู„ุญุฏ 5)", + "description": "ุนุฑุถ ุฅุญุตุงุฆูŠุงุช ุงู„ุดุฑุงุก ุญุณุจ ู…ุนุฑู ุงู„ู…ู†ุชุฌ (ุจูŠุงู†ุงุช ุฃูˆู„ูŠุฉ)", + "operationId": "getPurchaseMeasurements", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "-ุงู„ุญุตูˆู„ ุนู„ู‰ ู‚ูŠุงุณุงุช ุงู„ุดุฑุงุก", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PurchaseMeasurementsDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/attendance-checks/{id}/histories": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุณุฌู„ ุงู„ุชุญู‚ู‚ ู…ู† ุงู„ุญุถูˆุฑ", + "operationId": "getAttendanceCheckHistories", + "tags": [ + "attendanceCheck" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "id", + "description": "ู…ุนุฑู ุงู„ุชุญู‚ู‚ ู…ู† ุงู„ุญุถูˆุฑ", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุณุฌู„ ุงู„ุชุญู‚ู‚ ู…ู† ุงู„ุญุถูˆุฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AttendanceCheckHistoryListDto" + } + } + } + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/attendance-checks/{id}/attend": { + "post": { + "summary": "ุญุถูˆุฑ ุงู„ุชุญู‚ู‚ ู…ู† ุงู„ุญุถูˆุฑ", + "description": "- ุฑู…ุฒ ุงู„ุฎุทุฃ ุนู†ุฏู…ุง ูŠูƒูˆู† ุงู„ุญุถูˆุฑ ู…ูˆุฌูˆุฏู‹ุง ุจุงู„ูุนู„: ALREADY_EXISTS(1) - ุฑู…ุฒ ุงู„ุฎุทุฃ ุนู†ุฏ ุงูƒุชู…ุงู„ ุงู„ุชุญู‚ู‚ ู…ู† ุงู„ุญุถูˆุฑ: ATTENDANCE_CHECK_COMPLETED(8001) - ุฑู…ุฒ ุงู„ุฎุทุฃ ุนู†ุฏ ุงู†ุชู‡ุงุก ุงู„ุญุฏุซ: RESOURCE_NOT_FOUND(4)", + "operationId": "attendAttendanceCheck", + "tags": [ + "attendanceCheck" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "id", + "description": "ู…ุนุฑู ุงู„ุชุญู‚ู‚ ู…ู† ุงู„ุญุถูˆุฑ", + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "ุงู„ู†ุฌุงุญ ู„ุญุถูˆุฑ ูุญุต ุงู„ุญุถูˆุฑ" + }, + "400": { + "description": "ูุดู„ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "BooleanDto": { + "type": "object", + "description": "ู„ู„ุชุบู„ุจ ุนู„ู‰ ุฎุทุฃ oag ุงู„ุฐูŠ ู„ุง ูŠุชู… ุชุญูˆูŠู„ ุงุณุชุฌุงุจุฉ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ุงู„ุจุฏุงุฆูŠุฉ ู…ู† ุณู„ุณู„ุฉ ููŠ TS.", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "RequiredLongDto": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "integer", + "format": "int64" + } + } + }, + "LongDto": { + "type": "object", + "description": "ู„ู„ุชุบู„ุจ ุนู„ู‰ ุฎุทุฃ oag ุงู„ุฐูŠ ู„ุง ูŠุชู… ุชุญูˆูŠู„ ุงุณุชุฌุงุจุฉ API ุงู„ุจุฏุงุฆูŠุฉ ู…ู†ู‡ ู„ูุชุฑุฉ ุทูˆูŠู„ุฉ ููŠ TS.", + "properties": { + "value": { + "type": "integer", + "format": "int64" + } + } + }, + "LongRangeDto": { + "type": "object", + "properties": { + "min": { + "type": "integer", + "format": "int64" + }, + "max": { + "type": "integer", + "format": "int64" + } + } + }, + "RequiredBooleanDto": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "boolean" + } + } + }, + "MetadataDto": { + "type": "object", + "required": [ + "version", + "serverStatus" + ], + "properties": { + "version": { + "$ref": "#/components/schemas/VersionDto" + }, + "serverStatus": { + "$ref": "#/components/schemas/ServerStatusDto" + } + } + }, + "VersionDto": { + "type": "object", + "required": [ + "minVersion", + "minBuildNumber" + ], + "properties": { + "minVersion": { + "type": "string", + "description": "ุงู„ุญุฏ ุงู„ุฃุฏู†ู‰ ุงู„ู…ุทู„ูˆุจ ู„ู„ุนุฑุถ ุงู„ุฅุตุฏุงุฑ" + }, + "minBuildNumber": { + "type": "integer", + "format": "int32", + "description": "ุงู„ุญุฏ ุงู„ุฃุฏู†ู‰ ุงู„ู…ุทู„ูˆุจ ู„ุฑู‚ู… ุงู„ุจู†ุงุก" + }, + "updateUrl": { + "type": "string", + "description": "ุชุญุฏูŠุซ ุนู†ูˆุงู† URL" + } + } + }, + "BestPeriodEnum": { + "oneOf": [ + { + "const": "DAILY" + }, + { + "const": "WEEKLY" + }, + { + "const": "MONTHLY" + } + ] + }, + "ProductTagEnum": { + "oneOf": [ + { + "const": "SHOPPING_MALL" + }, + { + "const": "DISCOUNT_PROMOTION" + } + ], + "description": "ู…ุนู„ูˆู…ุงุช ุนู„ุงู…ุฉ ุงู„ู…ู†ุชุฌ. SHOPPING_MALL -> ู…ู†ุชุฌุงุช ู…ุฑุงูƒุฒ ุงู„ุชุณูˆู‚ DISCOUNT_PROMOTION -> ู…ู†ุชุฌุงุช ุจุฃุณุนุงุฑ ุฎุงุตุฉ" + }, + "AgeGroupCodeEnum": { + "oneOf": [ + { + "const": "AG0" + }, + { + "const": "AG1" + }, + { + "const": "AG2" + }, + { + "const": "AG3" + }, + { + "const": "AG4" + }, + { + "const": "AG5" + }, + { + "const": "AG6" + } + ], + "description": "ูƒูˆุฏ ุงู„ุนู…ุฑ. ู…ุฑุฌุน ุงู„ููƒุฑุฉ -> https://www.notion.so/rapportlabs/5d323300ed8a457da25b889fdc9c986c" + }, + "ServerStatusDto": { + "type": "object", + "required": [ + "serverState" + ], + "properties": { + "serverState": { + "$ref": "#/components/schemas/ServerStateEnum" + }, + "serverMaintenanceReason": { + "type": "string", + "description": "ุณุจุจ ุตูŠุงู†ุฉ ุงู„ุณูŠุฑูุฑ" + }, + "serverMaintenanceStartedAtMillis": { + "type": "integer", + "format": "int64", + "description": "ูˆู‚ุช ุจุฏุก ุตูŠุงู†ุฉ ุงู„ุฎุงุฏู…" + }, + "serverMaintenanceEndedAtMillis": { + "type": "integer", + "format": "int64", + "description": "ูˆู‚ุช ุงู†ุชู‡ุงุก ุตูŠุงู†ุฉ ุงู„ุฎุงุฏู…" + } + } + }, + "PlatformEnum": { + "oneOf": [ + { + "const": "ANDROID" + }, + { + "const": "IOS" + } + ] + }, + "ServerStateEnum": { + "oneOf": [ + { + "const": "OPERATIONAL" + }, + { + "const": "MAINTENANCE" + } + ], + "description": "ุชุนุฏุงุฏ ุญุงู„ุฉ ุงู„ุฎุงุฏู…" + }, + "SendVerifCodeRequestDto": { + "type": "object", + "required": [ + "phoneNumber" + ], + "properties": { + "phoneNumber": { + "type": "string", + "description": "ุฑู‚ู… ุงู„ู‡ุงุชู ู„ุฅุฑุณุงู„ ุฑู…ุฒ ุงู„ุชุญู‚ู‚" + } + } + }, + "SendVerifCodeResponseDto": { + "type": "object", + "required": [ + "verifyingToken", + "expirationMillis" + ], + "properties": { + "verifyingToken": { + "type": "string" + }, + "expirationMillis": { + "type": "integer", + "format": "int64" + } + } + }, + "VerifyCodeRequestDto": { + "type": "object", + "required": [ + "verifyingToken", + "verifCode" + ], + "properties": { + "verifyingToken": { + "type": "string" + }, + "verifCode": { + "type": "string" + } + } + }, + "VerifyCodeResponseDto": { + "type": "object", + "required": [ + "verifiedToken" + ], + "properties": { + "verifiedToken": { + "type": "string" + } + } + }, + "VerifyKakaoTokenRequestDto": { + "type": "object", + "required": [ + "kakaoAccessToken", + "phoneNumber" + ], + "properties": { + "kakaoAccessToken": { + "type": "string" + }, + "phoneNumber": { + "type": "string" + } + } + }, + "VerifyKakaoTokenResponseDto": { + "type": "object", + "required": [ + "verifiedToken" + ], + "properties": { + "verifiedToken": { + "type": "string" + } + } + }, + "SignUpRequestDto": { + "type": "object", + "required": [ + "verifiedToken" + ], + "properties": { + "verifiedToken": { + "type": "string" + } + } + }, + "SignUpResponseDto": { + "type": "object", + "required": [ + "firebaseToken" + ], + "properties": { + "firebaseToken": { + "type": "string" + } + } + }, + "DamoaTokenDto": { + "type": "object", + "required": [ + "accessToken", + "refreshToken" + ], + "properties": { + "accessToken": { + "type": "string", + "description": "ุชู†ุชู‡ูŠ ุตู„ุงุญูŠุชู‡ ุฎู„ุงู„ ุณุงุนุฉ ูˆุงุญุฏุฉ" + }, + "refreshToken": { + "type": "string", + "description": "ุชู†ุชู‡ูŠ ุตู„ุงุญูŠุชู‡ ุฎู„ุงู„ 180 ูŠูˆู…ู‹ุง" + } + } + }, + "DamoaTokenRefreshRequestDto": { + "type": "object", + "required": [ + "refreshToken" + ], + "properties": { + "refreshToken": { + "type": "string" + } + } + }, + "LoginAccountDto": { + "type": "object", + "required": [ + "uid", + "userRole", + "createdAtMillis", + "isKakaoLoginUser" + ], + "properties": { + "uid": { + "type": "string" + }, + "userRole": { + "$ref": "#/components/schemas/UserRoleEnum" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + }, + "phoneNumber": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "isKakaoLoginUser": { + "type": "boolean" + } + } + }, + "FirebaseAuthUserMigrationRequest": { + "type": "object", + "required": [ + "accessToken" + ], + "properties": { + "accessToken": { + "type": "string" + } + } + }, + "ProviderTypeEnum": { + "oneOf": [ + { + "const": "SMS" + }, + { + "const": "KAKAO" + } + ] + }, + "UserRoleEnum": { + "oneOf": [ + { + "const": "ANONYMOUS" + }, + { + "const": "IDENTIFIED_USER" + } + ] + }, + "BestBrandListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BestBrandDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "BestBrandDto": { + "type": "object", + "required": [ + "id", + "name", + "logo" + ], + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "logo": { + "$ref": "#/components/schemas/BrandLogoDto" + }, + "bestProducts": { + "$ref": "#/components/schemas/BestProductListOfBrandDto" + } + } + }, + "BestProductListOfBrandDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BestProductOfBrandDto" + } + } + } + }, + "BestProductOfBrandDto": { + "type": "object", + "required": [ + "title", + "productId", + "thumbnailUrl", + "multiResolutionThumbnail", + "finalPrice" + ], + "properties": { + "title": { + "type": "string" + }, + "productId": { + "type": "string" + }, + "thumbnailUrl": { + "description": "ู…ูˆู‚ูˆู", + "type": "string" + }, + "multiResolutionThumbnail": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "finalPrice": { + "type": "integer", + "format": "int64" + } + } + }, + "TagListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "description": "ู‚ุงุฆู…ุฉ ุงู„ุนู„ุงู…ุงุช", + "type": "array", + "items": { + "$ref": "#/components/schemas/TagDto" + } + } + } + }, + "TagDto": { + "type": "object", + "required": [ + "id", + "name", + "type" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "description": "ุงุณู… ุงู„ุนู„ุงู…ุฉ", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/TagTypeEnum" + } + } + }, + "TagTypeEnum": { + "oneOf": [ + { + "const": "BRAND_SOURCING" + }, + { + "const": "PRODUCT" + } + ], + "description": "ุฃู†ูˆุงุน ุงู„ุฃุดูŠุงุก ุงู„ุชูŠ ูŠู…ูƒู† ูˆุถุน ุนู„ุงู…ุฉ ุนู„ูŠู‡ุง. ุญุชู‰ ู„ูˆ ูƒุงู† ุงุณู… ุงู„ู…ุฌู…ูˆุนุฉ ู‡ูˆ ู†ูุณู‡ุŒ ุฅุฐุง ูƒุงู† ุงู„ู†ูˆุน ู…ุฎุชู„ูู‹ุงุŒ ูุณูŠุชู… ุงู„ุชุนุงู…ู„ ู…ุนู‡ุง ุนู„ู‰ ุฃู†ู‡ุง ู…ุฌู…ูˆุนุฉ ู…ุฎุชู„ูุฉ.." + }, + "TagGroupListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "description": "ู‚ุงุฆู…ุฉ ู…ุฌู…ูˆุนุฉ ุงู„ุนู„ุงู…ุงุช", + "type": "array", + "items": { + "$ref": "#/components/schemas/TagGroupDto" + } + } + } + }, + "TagGroupDto": { + "type": "object", + "required": [ + "id", + "name", + "type" + ], + "properties": { + "id": { + "description": "ู…ุนุฑู ุงู„ู…ุฌู…ูˆุนุฉ ู„ู„ุนู„ุงู…ุฉ", + "type": "integer", + "format": "int64" + }, + "name": { + "description": "ุงุณู… ู…ุฌู…ูˆุนุฉ ุงู„ุนู„ุงู…ุงุช (ุนู„ู‰ ุณุจูŠู„ ุงู„ู…ุซุงู„ุŒ ุณู†ุฉ ุงู„ุฅู†ุชุงุฌ)", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/TagTypeEnum" + } + } + }, + "ProductDto": { + "type": "object", + "required": [ + "productId", + "mallId", + "mallProductCode", + "mallName", + "url", + "imageUrl", + "multiResolutionImage", + "thumbnailUrl", + "multiResolutionThumbnail", + "name", + "finalPrice", + "discountPercentage", + "productPriceDetail", + "brand", + "rating", + "salesStatus" + ], + "properties": { + "productId": { + "type": "string" + }, + "mallId": { + "type": "string", + "description": "ู…ูˆู‚ูˆู" + }, + "mallProductCode": { + "type": "string" + }, + "mallName": { + "type": "string", + "description": "ู…ูˆู‚ูˆู" + }, + "rank": { + "type": "integer", + "format": "int32" + }, + "logoUrl": { + "type": "string", + "description": "ู…ูˆู‚ูˆู" + }, + "logo2xUrl": { + "type": "string", + "description": "ู…ูˆู‚ูˆู" + }, + "logo3xUrl": { + "type": "string", + "description": "ู…ูˆู‚ูˆู" + }, + "url": { + "type": "string", + "description": "ู…ูˆู‚ูˆู" + }, + "imageUrl": { + "description": "ู…ูˆู‚ูˆู", + "type": "string" + }, + "multiResolutionImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "thumbnailUrl": { + "description": "ู…ูˆู‚ูˆู", + "type": "string" + }, + "multiResolutionThumbnail": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "name": { + "type": "string" + }, + "originalPrice": { + "type": "integer", + "format": "int64" + }, + "finalPrice": { + "type": "integer", + "format": "int64", + "description": "- `directCouponAppliedFinalPrice` ููŠ `productPriceDetail`ุŒ ู„ูƒู† `finalPrice` ุฅุฐุง ูƒุงู† ุฎุงู„ูŠู‹ุง" + }, + "discountPercentage": { + "type": "integer", + "format": "int32", + "description": "- ู…ู‚ุงุฑู†ุฉ ุจู€ "ุงู„ุณุนุฑ ุงู„ุฃุตู„ูŠ" ู…ู‚ุงุฑู†ุฉ ุจู€ "ุงู„ุณุนุฑ ุงู„ู†ู‡ุงุฆูŠ"." + }, + "productPriceDetail": { + "$ref": "#/components/schemas/ProductPriceDetailDto" + }, + "brand": { + "type": "string" + }, + "display": { + "type": "boolean", + "description": "ุฅุฐุง ูƒุงู†ุช ู‚ูŠู…ุฉ ุงู„ุญู‚ู„ ู‡ุฐู‡ `ุฎุทุฃ` -> ูŠุชู… ุนุฑุถู‡ุง ุนู„ู‰ ุฃู†ู‡ุง ู†ูุฏุช ู…ู† ุงู„ู…ุฎุฒูˆู†" + }, + "reviewRatingAvg": { + "type": "number", + "format": "double" + }, + "reviewCount": { + "type": "integer", + "format": "int32" + }, + "category": { + "$ref": "#/components/schemas/ProductCategoryDto" + }, + "rating": { + "type": "integer", + "format": "int32" + }, + "deliveryPolicy": { + "$ref": "#/components/schemas/DeliveryPolicyDto" + }, + "salesStatus": { + "$ref": "#/components/schemas/SalesStatusEnum" + } + } + }, + "AppProductDto": { + "type": "object", + "required": [ + "productId", + "mallId", + "mallProductCode", + "mallName", + "url", + "imageUrl", + "multiResolutionImage", + "thumbnailUrl", + "multiResolutionThumbnail", + "name", + "finalPrice", + "discountPercentage", + "productPriceDetail", + "brand", + "rating", + "salesStatus", + "myBodySizesFromItems" + ], + "properties": { + "productId": { + "type": "string" + }, + "mallId": { + "type": "string", + "description": "ู…ูˆู‚ูˆู" + }, + "mallProductCode": { + "type": "string" + }, + "mallName": { + "type": "string", + "description": "ู…ูˆู‚ูˆู" + }, + "rank": { + "type": "integer", + "format": "int32" + }, + "url": { + "type": "string", + "description": "ู…ูˆู‚ูˆู" + }, + "imageUrl": { + "description": "ู…ูˆู‚ูˆู", + "type": "string" + }, + "multiResolutionImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "thumbnailUrl": { + "description": "ู…ูˆู‚ูˆู", + "type": "string" + }, + "multiResolutionThumbnail": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "name": { + "type": "string" + }, + "originalPrice": { + "type": "integer", + "format": "int64" + }, + "finalPrice": { + "type": "integer", + "format": "int64" + }, + "discountPercentage": { + "type": "integer", + "format": "int32" + }, + "productPriceDetail": { + "$ref": "#/components/schemas/ProductPriceDetailDto" + }, + "brand": { + "type": "string" + }, + "display": { + "type": "boolean", + "description": "ุฅุฐุง ูƒุงู†ุช ู‚ูŠู…ุฉ ุงู„ุญู‚ู„ ู‡ุฐู‡ `ุฎุทุฃ` -> ูŠุชู… ุนุฑุถู‡ุง ุนู„ู‰ ุฃู†ู‡ุง ู†ูุฏุช ู…ู† ุงู„ู…ุฎุฒูˆู†" + }, + "category": { + "$ref": "#/components/schemas/ProductCategoryDto" + }, + "rating": { + "type": "integer", + "format": "int32" + }, + "deliveryPolicy": { + "$ref": "#/components/schemas/DeliveryPolicyDto" + }, + "salesStatus": { + "$ref": "#/components/schemas/SalesStatusEnum" + }, + "reviewRatingAvg": { + "type": "number", + "format": "double" + }, + "reviewCount": { + "type": "integer", + "format": "int32" + }, + "myBodySizesFromItems": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "EquippedProductDto": { + "type": "object", + "required": [ + "productId", + "productItem", + "mallId", + "mallProductCode", + "mallName", + "url", + "imageUrl", + "multiResolutionImage", + "thumbnailUrl", + "multiResolutionThumbnail", + "name", + "finalPrice", + "discountPercentage", + "productPriceDetail", + "brand", + "rating", + "salesStatus", + "favorite" + ], + "properties": { + "productId": { + "type": "string" + }, + "productItem": { + "$ref": "#/components/schemas/ProductItemDto" + }, + "mallId": { + "type": "string", + "description": "ู…ูˆู‚ูˆู" + }, + "mallProductCode": { + "type": "string" + }, + "mallName": { + "type": "string", + "description": "ู…ูˆู‚ูˆู" + }, + "rank": { + "type": "integer", + "format": "int32" + }, + "logoUrl": { + "type": "string", + "description": "ู…ูˆู‚ูˆู" + }, + "logo2xUrl": { + "type": "string", + "description": "ู…ูˆู‚ูˆู" + }, + "logo3xUrl": { + "type": "string", + "description": "ู…ูˆู‚ูˆู" + }, + "url": { + "type": "string", + "description": "ู…ูˆู‚ูˆู" + }, + "imageUrl": { + "description": "ู…ูˆู‚ูˆู", + "type": "string" + }, + "multiResolutionImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "thumbnailUrl": { + "description": "ู…ูˆู‚ูˆู", + "type": "string" + }, + "multiResolutionThumbnail": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "name": { + "type": "string" + }, + "originalPrice": { + "type": "integer", + "format": "int64" + }, + "finalPrice": { + "type": "integer", + "format": "int64", + "description": "- `directCouponAppliedFinalPrice` ููŠ `productPriceDetail`ุŒ ู„ูƒู† `finalPrice` ุฅุฐุง ูƒุงู† ุฎุงู„ูŠู‹ุง" + }, + "discountPercentage": { + "type": "integer", + "format": "int32", + "description": "- ู…ู‚ุงุฑู†ุฉ ุจู€ "ุงู„ุณุนุฑ ุงู„ุฃุตู„ูŠ" ู…ู‚ุงุฑู†ุฉ ุจู€ "ุงู„ุณุนุฑ ุงู„ู†ู‡ุงุฆูŠ"." + }, + "productPriceDetail": { + "$ref": "#/components/schemas/ProductPriceDetailDto" + }, + "brand": { + "type": "string" + }, + "display": { + "type": "boolean", + "description": "ุฅุฐุง ูƒุงู†ุช ู‚ูŠู…ุฉ ุงู„ุญู‚ู„ ู‡ุฐู‡ `ุฎุทุฃ` -> ูŠุชู… ุนุฑุถู‡ุง ุนู„ู‰ ุฃู†ู‡ุง ู†ูุฏุช ู…ู† ุงู„ู…ุฎุฒูˆู†" + }, + "reviewRatingAvg": { + "type": "number", + "format": "double" + }, + "reviewCount": { + "type": "integer", + "format": "int32" + }, + "category": { + "$ref": "#/components/schemas/ProductCategoryDto" + }, + "rating": { + "type": "integer", + "format": "int32" + }, + "deliveryPolicy": { + "$ref": "#/components/schemas/DeliveryPolicyDto" + }, + "salesStatus": { + "$ref": "#/components/schemas/SalesStatusEnum" + }, + "favorite": { + "type": "boolean", + "default": false, + "description": "ุณูˆุงุก ู„ู„ุญูุธ ุฃู… ู„ุง" + } + } + }, + "AppAdvertisementProductDto": { + "type": "object", + "properties": { + "productId": { + "type": "string" + }, + "mallId": { + "type": "string", + "description": "ู…ูˆู‚ูˆู" + }, + "mallProductCode": { + "type": "string" + }, + "mallName": { + "type": "string", + "description": "ู…ูˆู‚ูˆู" + }, + "rank": { + "type": "integer", + "format": "int32" + }, + "url": { + "type": "string", + "description": "ู…ูˆู‚ูˆู" + }, + "imageUrl": { + "description": "ู…ูˆู‚ูˆู", + "type": "string" + }, + "multiResolutionImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "thumbnailUrl": { + "description": "ู…ูˆู‚ูˆู", + "type": "string" + }, + "multiResolutionThumbnail": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "name": { + "type": "string" + }, + "originalPrice": { + "type": "integer", + "format": "int64" + }, + "finalPrice": { + "type": "integer", + "format": "int64" + }, + "discountPercentage": { + "type": "integer", + "format": "int32" + }, + "productPriceDetail": { + "$ref": "#/components/schemas/ProductPriceDetailDto" + }, + "brand": { + "type": "string" + }, + "display": { + "type": "boolean", + "description": "ุฅุฐุง ูƒุงู†ุช ู‚ูŠู…ุฉ ุงู„ุญู‚ู„ ู‡ุฐู‡ `ุฎุทุฃ` -> ูŠุชู… ุนุฑุถู‡ุง ุนู„ู‰ ุฃู†ู‡ุง ู†ูุฏุช ู…ู† ุงู„ู…ุฎุฒูˆู†" + }, + "category": { + "$ref": "#/components/schemas/ProductCategoryDto" + }, + "rating": { + "type": "integer", + "format": "int32" + }, + "deliveryPolicy": { + "$ref": "#/components/schemas/DeliveryPolicyDto" + }, + "salesStatus": { + "$ref": "#/components/schemas/SalesStatusEnum" + }, + "reviewRatingAvg": { + "type": "number", + "format": "double" + }, + "reviewCount": { + "type": "integer", + "format": "int32" + }, + "myBodySizesFromItems": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ProductPriceDetailDto": { + "type": "object", + "description": "- dto ู„ุชูˆููŠุฑ ู…ุนู„ูˆู…ุงุช ุชูุตูŠู„ูŠุฉ ุนู† ุงู„ุฃุณุนุงุฑ ุงู„ู…ุญุฏุฏุฉ ู„ู„ู…ู†ุชุฌุงุช ุงู„ุญุงู„ูŠุฉ ูˆุงู„ุฃุณุนุงุฑ ู…ุน ุชุทุจูŠู‚ ุงู„ุฎุตูˆู…ุงุช ุงู„ููˆุฑูŠุฉ - ู…ุนู„ูˆู…ุงุช ุชูุตูŠู„ูŠุฉ ุนู† ุฃุณุนุงุฑ ุงู„ู…ู†ุชุฌุงุช ุงู„ุชูŠ ูŠู…ูƒู† ุงู„ุนุซูˆุฑ ุนู„ูŠู‡ุง ููŠ "ProductDto"ุŒ ูˆ"AppProductDto"ุŒ ูˆ"FavoriteProductDto"ุŒ ูˆู…ุง ุฅู„ู‰ ุฐู„ูƒ. > Queen It ูŠุชู… ุชุทุจูŠู‚ ุงู„ุฎุตู… ุงู„ููˆุฑูŠ ููŠ ููŠ ู‡ุฐู‡ ุงู„ุญุงู„ุฉุŒ ุณูŠุชู… ุงุณุชุจุฏุงู„ ุณุนุฑ ุงู„ู…ู†ุชุฌ ุงู„ู…ูˆุถุญ ููŠ DTO ุงู„ุญุงู„ูŠ ุนู„ู‰ ุงู„ููˆุฑ ุจุณุนุฑ ุงู„ุฎุตู… ุงู„ุฎุงุต ุจู€ Queen It.", + "required": [ + "finalPrice" + ], + "properties": { + "originalPrice": { + "description": "- ู‚ุงุฆู…ุฉ ุงู„ุฃุณุนุงุฑ - ุฅุฐุง ูƒุงู†ุช ู‚ูŠู…ุฉ ู‡ุฐุง ุงู„ุญู‚ู„ `ูุงุฑุบุฉ` -> ูุฅู† `ุงู„ุณุนุฑ ุงู„ู†ู‡ุงุฆูŠ` ู„ู‡ ุฃูŠุถู‹ุง ู…ุนู†ู‰ ู‚ุงุฆู…ุฉ ุงู„ุฃุณุนุงุฑ.", + "type": "integer", + "format": "int64" + }, + "finalPrice": { + "description": "- ุณุนุฑ ุงู„ุจูŠุน (ุงู„ุณุนุฑ ุงู„ุฐูŠ ูŠุดุชุฑูŠ ุจู‡ ุงู„ู…ุณุชุฎุฏู…ูˆู† ุงู„ู…ู†ุชุฌ ูุนู„ูŠู‹ุง) - ูŠุดูŠุฑ ุฅู„ู‰ ู…ุนู„ูˆู…ุงุช ุณุนุฑ ุงู„ู…ุจูŠุนุงุช ุฏูˆู† ุชุทุจูŠู‚ ู‚ุณูŠู…ุฉ ุฎุตู… Queen It ุงู„ููˆุฑูŠุฉ - ูŠุดูŠุฑ ุฅู„ู‰ ุณุนุฑ ุงู„ุจูŠุน ุงู„ุฐูŠ ุชู… ุฅุฏุฎุงู„ู‡ ุนู†ุฏ ุชุณุฌูŠู„ ุงู„ู…ู†ุชุฌ - ู‚ูŠู… ุงู„ุญู‚ูˆู„ "ุงู„ุณุนุฑ ุงู„ุฃุตู„ูŠ"ุŒ "ุงู„ู†ุณุจุฉ ุงู„ู…ุฆูˆูŠุฉ ู„ู„ุฎุตู…" ู‡ูŠ " null` Case -> ู‡ุฐุง ุงู„ุญู‚ู„ ู„ู‡ ุฃูŠุถู‹ุง ู…ุนู†ู‰ ู‚ุงุฆู…ุฉ ุงู„ุฃุณุนุงุฑ.", + "type": "integer", + "format": "int64" + }, + "discountPercentage": { + "description": "- ู†ุณุจุฉ ุงู„ุฎุตู… -> ู†ุณุจุฉ "ุงู„ุณุนุฑ ุงู„ู†ู‡ุงุฆูŠ" ุฅู„ู‰ "ุงู„ุณุนุฑ ุงู„ุฃุตู„ูŠ" - ุฅุฐุง ูƒุงู†ุช ู‚ูŠู…ุฉ ู‡ุฐุง ุงู„ุญู‚ู„ "ุฎุงู„ูŠุฉ" -> ูุฅู† "ุงู„ุณุนุฑ ุงู„ู†ู‡ุงุฆูŠ" ู„ู‡ ุฃูŠุถู‹ุง ู…ุนู†ู‰ ู‚ุงุฆู…ุฉ ุงู„ุฃุณุนุงุฑ.", + "type": "integer", + "format": "int32" + }, + "originalToDirectCouponDiscountPercentage": { + "description": "- ู†ุณุจุฉ ุงู„ุฎุตู… -> ู†ุณุจุฉ `directCouponAppliedFinalPrice` ุฅู„ู‰ `ุงู„ุณุนุฑ ุงู„ุฃุตู„ูŠ` (ุงู„ุณุนุฑ ุงู„ู…ุฎูุถ ุจูˆุงุณุทุฉ ู‚ุณูŠู…ุฉ ุงู„ุฎุตู… ุงู„ููˆุฑูŠ) - ุฅุฐุง ูƒุงู†ุช ู‚ูŠู…ุฉ ู‡ุฐุง ุงู„ุญู‚ู„ `ูุงุฑุบุฉ` -> ูŠู…ูƒู† ู…ู„ุงุญุธุฉ ุฃู†ู‡ ู„ู… ูŠุชู… ุชุทุจูŠู‚ ุงู„ุฎุตู… ุงู„ููˆุฑูŠ.", + "type": "integer", + "format": "int32" + }, + "finalToDirectCouponDiscountPercentage": { + "description": "- ู†ุณุจุฉ ุงู„ุฎุตู… -> ู†ุณุจุฉ `directCouponAppliedFinalPrice` ุฅู„ู‰ `finalPrice` (ู†ุณุจุฉ ุงู„ุฎุตู… ุญุณุจ ู‚ุณูŠู…ุฉ ุงู„ุฎุตู… ุงู„ููˆุฑูŠุฉ) - ุฅุฐุง ูƒุงู†ุช ู‚ูŠู…ุฉ ู‡ุฐุง ุงู„ุญู‚ู„ `ูุงุฑุบุฉ` -> ูŠู…ูƒู† ู…ู„ุงุญุธุฉ ุฃู†ู‡ ู„ู… ูŠุชู… ุชุทุจูŠู‚ ุงู„ุฎุตู… ุงู„ููˆุฑูŠ.", + "type": "integer", + "format": "int32" + }, + "directCouponAppliedFinalPrice": { + "description": "- ุณุนุฑ ุงู„ุดุฑุงุก ุงู„ู†ู‡ุงุฆูŠ ู…ุน ุชุทุจูŠู‚ ู‚ุณูŠู…ุฉ ุงู„ุฎุตู… ุงู„ููˆุฑูŠ Queen It - ุฅุฐุง ูƒุงู†ุช ู‚ูŠู…ุฉ ู‡ุฐุง ุงู„ุญู‚ู„ `ูุงุฑุบุฉ` -> ูŠู…ูƒู† ู…ู„ุงุญุธุฉ ุฃู†ู‡ ู„ู… ูŠุชู… ุชุทุจูŠู‚ ุงู„ุฎุตู… ุงู„ููˆุฑูŠ", + "type": "integer", + "format": "int64" + }, + "originalToMaximumBenefitCouponPricePercentage": { + "description": "- ู†ุณุจุฉ ุงู„ุฎุตู… -> ู†ุณุจุฉ `maximumBenefitCouponAppliedFinalPrice` ุฅู„ู‰ `ุงู„ุณุนุฑ ุงู„ุฃุตู„ูŠ` (ุงู„ุณุนุฑ ุงู„ู…ุฎูุถ ุญุณุจ ู‚ุณูŠู…ุฉ ุงู„ูุงุฆุฏุฉ ุงู„ู‚ุตูˆู‰) - ุฅุฐุง ูƒุงู†ุช ู‚ูŠู…ุฉ ู‡ุฐุง ุงู„ุญู‚ู„ `ูุงุฑุบุฉ` -> ูŠู…ูƒู† ู…ู„ุงุญุธุฉ ุฃู†ู‡ ู„ู… ูŠุชู… ุชุทุจูŠู‚ ุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ ู„ู„ูุงุฆุฏุฉ.", + "type": "integer", + "format": "int32" + }, + "finalToMaximumBenefitCouponPricePercentage": { + "description": "- ู†ุณุจุฉ ุงู„ุฎุตู… -> ู†ุณุจุฉ `maximumBenefitCouponAppliedFinalPrice` ุฅู„ู‰ `finalPrice` (ุงู„ู†ุณุจุฉ ุงู„ู…ุฆูˆูŠุฉ ุงู„ู…ุฎุตูˆู…ุฉ ุจูˆุงุณุทุฉ ู‚ุณูŠู…ุฉ ุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ ู„ู„ูุงุฆุฏุฉ) - ุฅุฐุง ูƒุงู†ุช ู‚ูŠู…ุฉ ู‡ุฐุง ุงู„ุญู‚ู„ `ูุงุฑุบุฉ` -> ูŠู…ูƒู† ู…ู„ุงุญุธุฉ ุฃู†ู‡ ู„ู… ูŠุชู… ุชุทุจูŠู‚ ุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ ู„ู„ูุงุฆุฏุฉ.", + "type": "integer", + "format": "int32" + }, + "maximumBenefitCouponAppliedFinalPrice": { + "description": "- ุณุนุฑ ุงู„ุดุฑุงุก ุงู„ู†ู‡ุงุฆูŠ ู…ุน ุชุทุจูŠู‚ ู‚ุณูŠู…ุฉ ุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ ู„ู„ู…ู†ูุนุฉ - ุฅุฐุง ูƒุงู†ุช ู‚ูŠู…ุฉ ู‡ุฐุง ุงู„ุญู‚ู„ `ูุงุฑุบุฉ` -> ูŠู…ูƒู† ู…ู„ุงุญุธุฉ ุฃู†ู‡ ู„ู… ูŠุชู… ุชุทุจูŠู‚ ู‚ุณูŠู…ุฉ ุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ ู„ู„ู…ู†ูุนุฉ.", + "type": "integer", + "format": "int64" + } + } + }, + "SalesStatusEnum": { + "oneOf": [ + { + "const": "ACTIVE" + }, + { + "const": "ARCHIVED" + }, + { + "const": "PERMANENTLY_ARCHIVED" + } + ], + "description": "- `ู†ุดุท` -> ู…ุนุฑูˆุถ ู„ู„ุจูŠุน - ู„ุง ูŠุฒุงู„ ู…ุนุฑูˆุถู‹ุง ู„ู„ุจูŠุน ุญุงู„ูŠู‹ุง - `ู…ุคุฑุดู` -> ุงู„ู…ุจูŠุนุงุช ู…ุชูˆู‚ูุฉ - ูŠุดูŠุฑ ุฅู„ู‰ ุฃู† ุงู„ู…ุจูŠุนุงุช ู…ุชูˆู‚ูุฉ ุญุงู„ูŠู‹ุงุŒ ูˆู„ูƒู† ู‡ู†ุงูƒ ู…ุฌุงู„ ู„ู„ุจูŠุน ููŠ ุงู„ู…ุณุชู‚ุจู„ - `PERMANENTLY_ARCHIVED` -> ู…ุจูŠุนุงุช ู…ุชูˆู‚ูุฉ ู†ู‡ุงุฆูŠู‹ุง - ู„ุง ู…ุชุงุญ ู„ู„ุจูŠุน ู„ูุชุฑุฉ ุฃุทูˆู„ ูŠุดูŠุฑ ุฅู„ู‰ ุฃู† ุงู„ู…ู†ุชุฌ ู„ูŠุณ ู…ู†ุชุฌู‹ุง ------------ - ุฅุฐุง ูƒุงู†ุช ุญุงู„ุฉ ู…ุจูŠุนุงุช ุงู„ู…ู†ุชุฌ ู„ูŠุณุช "ู†ุดุทุฉ"ุŒ ูุณูŠุชู… ุนุฑุถู‡ ุนู„ู‰ ุฃู†ู‡ ู…ุจุงุน ููŠ ุตูุญุฉ ุงู„ุชูุงุตูŠู„ - ุฅุฐุง ูƒุงู† ุงู„ู…ู†ุชุฌ ุญุงู„ุฉ ู…ุจูŠุนุงุช ุงู„ุฎูŠุงุฑ ู„ูŠุณุช "ู†ุดุทุฉ" - ู„ุง ูŠุชู… ุนุฑุถ ุฎูŠุงุฑุงุช ุงู„ู…ู†ุชุฌ (ูŠุชู… ุชุตููŠุชู‡ุง ูˆุชู†ุฒูŠู„ู‡ุง ู…ู† ุงู„ุฎุงุฏู…) - ูŠุชู… ุนุฑุถู‡ุง ุนู„ู‰ ุฃู†ู‡ุง ุบูŠุฑ ู…ุชูˆูุฑุฉ ููŠ ุนุฑุจุฉ ุงู„ุชุณูˆู‚ (ู…ุทู„ูˆุจ ู…ู† ู‚ุจู„ ุงู„ุนู…ูŠู„)" + }, + "ProductDiscountApplicationDto": { + "description": "- DTO ู„ุชูˆููŠุฑ ู…ุนู„ูˆู…ุงุช ุงู„ุฎุตู… ุงู„ู…ุทุจู‚ุฉ ุฃูˆ ุงู„ู…ุทุจู‚ุฉ ุนู„ู‰ ุงู„ู…ู†ุชุฌ - ุชุญุชูˆูŠ ุญุงู„ูŠู‹ุง ูู‚ุท ุนู„ู‰ ู…ุนู„ูˆู…ุงุช DirectCoupon (ู‚ุณูŠู…ุฉ ุงู„ุฎุตู… ุงู„ููˆุฑูŠ)ุŒ ูˆู„ูƒู† ู‚ุฏ ุชุชู… ุฅุถุงูุฉ DTOs ุฐุงุช ุงู„ุตู„ุฉ ููŠ ุงู„ู…ุณุชู‚ุจู„ ู…ุน ุฅุถุงูุฉ ู…ุฒุงูŠุง ุฎุตู… ุฃุฎุฑู‰ - ุชุชุฏุงุฎู„ ู‚ุณูŠู…ุฉ ุงู„ุฎุตู… ุงู„ููˆุฑูŠ ุนู†ุฏู…ุง ุชุตุจุญ ู…ุชุงุญุฉุŒ ` ูŠุฌุจ ุฃู„ุง ูŠุชู… ุงุณุชุฎุฏุงู… applicationDirectCoupon` ุจุนุฏ ุงู„ุขู†ุŒ ูˆูŠุฌุจ ุงุณุชุฎุฏุงู… `appliedDirectCoupons`.", + "type": "object", + "properties": { + "appliedDirectCoupons": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppliedDirectCouponDto" + } + }, + "appliedDirectCoupon": { + "$ref": "#/components/schemas/AppliedDirectCouponDto" + }, + "maximumDiscountCouponAppliedPrice": { + "description": "- ุงู„ุณุนุฑ ู…ุน ุชุทุจูŠู‚ ุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ ู„ุฎุตู… ุงู„ูƒูˆุจูˆู† - ุฅุฐุง ูƒุงู†ุช ู‚ูŠู…ุฉ ู‡ุฐุง ุงู„ุญู‚ู„ `ูุงุฑุบุฉ` -> ูŠู…ูƒู† ู…ู„ุงุญุธุฉ ุฃู†ู‡ ู„ุง ูŠูˆุฌุฏ ู‚ุณูŠู…ุฉ ุชุณุชูˆููŠ ุดุฑูˆุท ุญุณุงุจ ุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ ู„ุณุนุฑ ุงู„ุฎุตู….", + "type": "integer", + "format": "int64" + } + } + }, + "AppliedDirectCouponDto": { + "type": "object", + "properties": { + "endAtMillis": { + "description": "ูŠุดูŠุฑ ุฅู„ู‰ ุงู„ู†ู‚ุทุฉ ุงู„ุชูŠ ูŠู†ุชู‡ูŠ ุนู†ุฏู‡ุง ุชุทุจูŠู‚ ู‚ุณูŠู…ุฉ ุงู„ุฎุตู… ุงู„ููˆุฑูŠ", + "type": "integer", + "format": "int64" + } + } + }, + "ProductContentsDto": { + "type": "object", + "required": [ + "imageUrls", + "multiResolutionImages", + "descriptionPageUrl", + "measurements", + "classifications" + ], + "properties": { + "imageUrls": { + "description": "ู…ูˆู‚ูˆู", + "type": "array", + "items": { + "type": "string" + } + }, + "multiResolutionImages": { + "$ref": "#/components/schemas/MultiResolutionImageListDto" + }, + "descriptionPageUrl": { + "type": "string" + }, + "measurements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductMeasurementDto" + } + }, + "classifications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductClassificationDto" + } + }, + "announcement": { + "$ref": "#/components/schemas/ProductAnnouncementDto" + } + } + }, + "PersonalProductContentsDto": { + "type": "object", + "properties": { + "imageUrls": { + "description": "ู…ูˆู‚ูˆู", + "type": "array", + "items": { + "type": "string" + } + }, + "multiResolutionImages": { + "$ref": "#/components/schemas/MultiResolutionImageListDto" + }, + "descriptionPageUrl": { + "type": "string" + }, + "measurements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PersonalProductMeasurementDto" + } + }, + "classifications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductClassificationDto" + } + }, + "announcement": { + "$ref": "#/components/schemas/ProductAnnouncementDto" + }, + "sellerContentImages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SellerContentImagesDto" + }, + "description": "ุงู„ุตูˆุฑุฉ ู…ุณุฌู„ุฉ ู…ู† ู‚ุจู„ ุงู„ุจุงุฆุน" + } + } + }, + "ProductMeasurementDto": { + "type": "object", + "required": [ + "type", + "unitOfLength", + "headers", + "rows" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/ProductMeasurementTypeEnum" + }, + "unitOfLength": { + "type": "string" + }, + "headers": { + "type": "array", + "items": { + "type": "string" + } + }, + "rows": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "PersonalProductMeasurementDto": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/ProductMeasurementTypeEnum" + }, + "unitOfLength": { + "type": "string" + }, + "headers": { + "type": "array", + "items": { + "type": "string" + } + }, + "rows": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "imageUrl": { + "type": "string" + } + } + }, + "ProductMeasurementTypeEnum": { + "oneOf": [ + { + "const": "SHORTS" + }, + { + "const": "SKIRT" + }, + { + "const": "PANTS" + }, + { + "const": "HOODIE" + }, + { + "const": "TSHIRTS" + }, + { + "const": "SWEATER" + }, + { + "const": "SHIRTS" + }, + { + "const": "DRESS" + }, + { + "const": "JUMPER" + }, + { + "const": "JACKET" + }, + { + "const": "PADDED_JACKET" + }, + { + "const": "COAT" + }, + { + "const": "CARDIGAN" + } + ] + }, + "ProductClassificationDto": { + "type": "object", + "required": [ + "criterionId", + "criterionText", + "elements" + ], + "properties": { + "criterionId": { + "type": "string" + }, + "criterionText": { + "type": "string" + }, + "elements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductClassificationElementDto" + } + } + } + }, + "ProductClassificationElementDto": { + "type": "object", + "required": [ + "name", + "classified" + ], + "properties": { + "name": { + "type": "string" + }, + "classified": { + "type": "boolean" + } + } + }, + "ProductAnnouncementDto": { + "type": "object", + "required": [ + "apparelProductAnnouncement", + "beautyProductAnnouncement" + ], + "properties": { + "apparelProductAnnouncement": { + "$ref": "#/components/schemas/ApparelProductAnnouncementDto" + }, + "beautyProductAnnouncement": { + "$ref": "#/components/schemas/BeautyProductAnnouncementDto" + }, + "color": { + "type": "string", + "description": "(ู…ู‡ู…ู„) ุงู„ู„ูˆู†" + }, + "material": { + "type": "string", + "description": "(ู…ู‡ู…ู„ุฉ) ุงู„ู…ูˆุงุฏ" + }, + "measurement": { + "type": "string", + "description": "(ู…ู‡ู…ู„ุฉ) ุงู„ุฃุจุนุงุฏ" + }, + "manufacturingCompany": { + "type": "string", + "description": "(ู…ู‡ู…ู„ุฉ) ุงู„ุดุฑูƒุฉ ุงู„ู…ุตู†ุนุฉ" + }, + "manufacturingCountry": { + "type": "string", + "description": "(ู…ู‡ู…ู„) ุจู„ุฏ ุงู„ุตู†ุน" + }, + "manufacturingDate": { + "type": "string", + "description": "(ู…ู‡ู…ู„) ุชุงุฑูŠุฎ ุงู„ุตู†ุน" + }, + "qaStandards": { + "type": "string", + "description": "(ู…ู‡ู…ู„ุฉ) ู…ุนุงูŠูŠุฑ ุถู…ุงู† ุงู„ุฌูˆุฏุฉ" + }, + "customerCenterContact": { + "type": "string", + "description": "(ู…ู‡ู…ู„) ู…ุฏูŠุฑ A/S ูˆุฑู‚ู… ุงู„ู‡ุงุชู" + }, + "washingAndHandling": { + "type": "string", + "description": "(ู…ู‡ู…ู„) ุทุฑูŠู‚ุฉ ุงู„ุบุณูŠู„ ูˆุงุญุชูŠุงุทุงุช ุงู„ุชุนุงู…ู„" + } + } + }, + "ApparelProductAnnouncementDto": { + "type": "object", + "description": "ุฅุดุนุงุฑ ุชูˆููŠุฑ ู…ุนู„ูˆู…ุงุช ุงู„ู…ู†ุชุฌ ุงู„ู…ุชุนู„ู‚ุฉ ุจุงู„ู…ู„ุงุจุณ", + "required": [ + "manufacturingCompany", + "manufacturingCountry", + "qaStandards", + "customerCenterContact", + "color", + "material", + "measurement", + "manufacturingDate", + "washingAndHandling" + ], + "properties": { + "manufacturingCompany": { + "type": "string", + "description": "ุงู„ุดุฑูƒุฉ ุงู„ู…ุตู†ุนุฉ" + }, + "manufacturingCountry": { + "type": "string", + "description": "ุจู„ุฏ ุงู„ุตู†ุน" + }, + "qaStandards": { + "type": "string", + "description": "ู…ุนุงูŠูŠุฑ ุถู…ุงู† ุงู„ุฌูˆุฏุฉ" + }, + "customerCenterContact": { + "type": "string", + "description": "ู…ุฏูŠุฑ A/S ูˆุฑู‚ู… ุงู„ู‡ุงุชู" + }, + "color": { + "type": "string", + "description": "ู„ูˆู†" + }, + "material": { + "type": "string", + "description": "ุงู„ู…ูˆุถูˆุน" + }, + "measurement": { + "type": "string", + "description": "ู…ู‚ุงุณ" + }, + "manufacturingDate": { + "type": "string", + "description": "ุชุงุฑูŠุฎ ุงู„ุชุตู†ูŠุน" + }, + "washingAndHandling": { + "type": "string", + "description": "ุทุฑู‚ ุงู„ุบุณูŠู„ ูˆุงุญุชูŠุงุทุงุช ุงู„ุชุนุงู…ู„" + } + } + }, + "BeautyProductAnnouncementDto": { + "type": "object", + "description": "ุฅุดุนุงุฑ ุจุดุฃู† ุชูˆููŠุฑ ู…ุนู„ูˆู…ุงุช ุงู„ู…ู†ุชุฌ ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุณุชุญุถุฑุงุช ุงู„ุชุฌู…ูŠู„ (ุงู„ุชุฌู…ูŠู„)", + "required": [ + "manufacturingCompany", + "manufacturingCountry", + "qaStandards", + "customerCenterContact", + "size", + "responsibleSellerCompany", + "usage", + "highlights", + "concerns", + "expiration", + "ingredients", + "mfdsReview" + ], + "properties": { + "manufacturingCompany": { + "type": "string", + "description": "ุงู„ุดุฑูƒุฉ ุงู„ู…ุตู†ุนุฉ" + }, + "manufacturingCountry": { + "type": "string", + "description": "ุจู„ุฏ ุงู„ุตู†ุน" + }, + "qaStandards": { + "type": "string", + "description": "ู…ุนุงูŠูŠุฑ ุถู…ุงู† ุงู„ุฌูˆุฏุฉ" + }, + "customerCenterContact": { + "type": "string", + "description": "ู…ุฏูŠุฑ A/S ูˆุฑู‚ู… ุงู„ู‡ุงุชู" + }, + "size": { + "type": "string", + "description": "ุงู„ู‚ุฏุฑุฉ ุงู„ุชุฌู…ูŠู„ูŠุฉ" + }, + "responsibleSellerCompany": { + "type": "string", + "description": "ุจุงุฆุน ู…ุณุชุญุถุฑุงุช ุงู„ุชุฌู…ูŠู„ ุงู„ู…ุณุคูˆู„" + }, + "usage": { + "type": "string", + "description": "ูƒูŠููŠุฉ ุงู„ุงุณุชุฎุฏุงู…" + }, + "highlights": { + "type": "string", + "description": "ุงู„ู…ูˆุงุตูุงุช ุงู„ุฑุฆูŠุณูŠุฉ ู„ู„ู…ู†ุชุฌ" + }, + "concerns": { + "type": "string", + "description": "ุงุญุชูŠุงุทุงุช ุงู„ุงุณุชุฎุฏุงู…" + }, + "expiration": { + "type": "string", + "description": "ุชุงุฑูŠุฎ ุงู†ุชู‡ุงุก ุงู„ุตู„ุงุญูŠุฉ ุฃูˆ ุชุงุฑูŠุฎ ุงู†ุชู‡ุงุก ุงู„ุตู„ุงุญูŠุฉ ุจุนุฏ ุงู„ูุชุญ" + }, + "ingredients": { + "type": "string", + "description": "ุงู„ู…ูƒูˆู†ุงุช (ุฌู…ูŠุน ุงู„ู…ูƒูˆู†ุงุช ุงู„ุชูŠ ูŠุฌุจ ุฅุฏุฑุงุฌู‡ุง ูˆุชุตู†ูŠูู‡ุง ูˆูู‚ู‹ุง ู„ู‚ุงู†ูˆู† ู…ุณุชุญุถุฑุงุช ุงู„ุชุฌู…ูŠู„)" + }, + "mfdsReview": { + "type": "string", + "description": "ู‡ู„ ู‡ู†ุงูƒ ุญุงุฌุฉ ู„ู„ู…ุฑุงุฌุนุฉ ู…ู† ู‚ุจู„ ูˆุฒุงุฑุฉ ุงู„ุบุฐุงุก ูˆุงู„ุณู„ุงู…ุฉ ุงู„ุฏูˆุงุฆูŠุฉ (MFDS = ูˆุฒุงุฑุฉ ุงู„ุบุฐุงุก ูˆุงู„ุณู„ุงู…ุฉ ุงู„ุฏูˆุงุฆูŠุฉ)ุŸ" + } + } + }, + "ProductSetDto": { + "type": "object", + "required": [ + "set", + "favoriteIds", + "freeReturnTargetProductIds" + ], + "properties": { + "set": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDto" + } + }, + "favoriteIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "freeReturnTargetProductIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ProductListDto": { + "type": "object", + "required": [ + "list", + "favoriteIds", + "last", + "freeReturnTargetProductIds" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDto" + } + }, + "favoriteIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + }, + "freeReturnTargetProductIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "FilteredPersonalizedProductRequestDto": { + "type": "object", + "required": [ + "size" + ], + "properties": { + "orderBy": { + "$ref": "#/components/schemas/ProductOrderByEnum" + }, + "cursor": { + "type": "string" + }, + "size": { + "type": "integer", + "format": "int32" + }, + "categoryId": { + "type": "string" + }, + "brandId": { + "type": "string" + }, + "minPrice": { + "type": "integer", + "format": "int64" + }, + "maxPrice": { + "type": "integer", + "format": "int64" + }, + "ageGroupCode": { + "$ref": "#/components/schemas/AgeGroupCodeEnum" + }, + "mySizeOnly": { + "type": "boolean", + "default": false + }, + "tag": { + "$ref": "#/components/schemas/ProductTagEnum" + }, + "tagId": { + "type": "integer", + "description": "(ู…ู‡ู…ู„) ุงุณุชุฎุฏู… tagIdForBrandSourcing", + "format": "int64" + }, + "tagIdForBrandSourcing": { + "description": "ุงุจุญุซ ุนู† ุงู„ู…ู†ุชุฌุงุช ุนู† BrandSources ุงู„ู…ุชูˆุงูู‚ุฉ ู…ุน tagId", + "type": "integer", + "format": "int64" + }, + "recentlyClickedProducts": { + "type": "array", + "description": "ู…ุนู„ูˆู…ุงุช ุญูˆู„ ุงู„ู…ู†ุชุฌุงุช ุงู„ุชูŠ ุชู… ุงู„ู†ู‚ุฑ ุนู„ูŠู‡ุง ู…ุคุฎุฑู‹ุง. *ู„ุง ูŠุฌูˆุฒ ุฃู† ูŠุชุฌุงูˆุฒ ุงู„ุนุฏุฏ 100.*", + "items": { + "$ref": "#/components/schemas/ClickedProductDto" + } + }, + "modelId": { + "type": "string", + "description": "- ู…ุง ู‡ูˆ ู†ู…ูˆุฐุฌ ุงู„ุชุฎุตูŠุต ุงู„ุฐูŠ ูŠุฌุจ ุงุณุชุฎุฏุงู…ู‡ุŸ (ู„ุงุฎุชุจุงุฑ A/B) - ู…ุฑุฌุน ุงู„ููƒุฑุฉ: https://www.notion.so/rapportlabs/AB-Protocol-c878d879ff0443cda929bb17d9b137c1" + }, + "postProcessingId": { + "type": "string", + "description": "- ูƒูŠููŠุฉ ุงู„ู…ุนุงู„ุฌุฉ ุงู„ู„ุงุญู‚ุฉ ู„ู†ุชุงุฆุฌ ุงู„ุชุฎุตูŠุต. (ู„ุงุฎุชุจุงุฑ A/B) - ู…ุฑุฌุน ุงู„ููƒุฑุฉ: https://www.notion.so/rapportlabs/AB-Protocol-c878d879ff0443cda929bb17d9b137c1" + } + } + }, + "ClickedProductDto": { + "type": "object", + "required": [ + "id", + "clickedAtMillis" + ], + "properties": { + "id": { + "type": "string" + }, + "clickedAtMillis": { + "type": "integer", + "format": "int64", + "description": "ุงู„ูˆู‚ุช ุงู„ุฐูŠ ุชู… ููŠู‡ ุงู„ู†ู‚ุฑ ุนู„ู‰ ุงู„ู…ู†ุชุฌ (ุจุงู„ู…ู„ู„ูŠ)" + } + } + }, + "AppProductListDto": { + "type": "object", + "required": [ + "list", + "favoriteIds", + "last", + "freeReturnTargetProductIds" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppProductDto" + } + }, + "favoriteIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + }, + "productAggregation": { + "$ref": "#/components/schemas/ProductAggregationDto" + }, + "freeReturnTargetProductIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "AppAdvertisementProductListDto": { + "type": "object", + "required": [ + "favoriteIds", + "list", + "totalPageCount", + "totalElementCount", + "freeReturnTargetProductIds" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppAdvertisementProductDto" + } + }, + "favoriteIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "totalPageCount": { + "type": "integer", + "format": "int32" + }, + "totalElementCount": { + "type": "integer", + "format": "int64" + }, + "freeReturnTargetProductIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PersonalProductDto": { + "type": "object", + "required": [ + "product", + "favorite", + "freeReturnTarget", + "discountInfo" + ], + "properties": { + "product": { + "$ref": "#/components/schemas/ProductDto" + }, + "favorite": { + "type": "boolean" + }, + "categoriesFromRoot": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + }, + "contents": { + "$ref": "#/components/schemas/PersonalProductContentsDto" + }, + "mappedBrand": { + "$ref": "#/components/schemas/BrandDto" + }, + "discountInfo": { + "$ref": "#/components/schemas/ProductDiscountApplicationDto" + }, + "freeReturnTarget": { + "type": "boolean" + } + } + }, + "HomeProductCategoryDto": { + "type": "object", + "required": [ + "topSideCategories", + "bottomSideCategories" + ], + "properties": { + "topSideCategories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + }, + "bottomSideCategories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + } + } + }, + "ProductCategoryDto": { + "type": "object", + "required": [ + "id", + "title" + ], + "properties": { + "id": { + "type": "string" + }, + "parentId": { + "type": "string" + }, + "title": { + "type": "string" + }, + "iconUrl": { + "description": "ู…ูˆู‚ูˆู", + "type": "string" + }, + "multiResolutionIcon": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + } + } + }, + "MallDto": { + "type": "object", + "required": [ + "mallId", + "title" + ], + "properties": { + "mallId": { + "type": "string" + }, + "title": { + "type": "string" + }, + "logoUrl": { + "type": "string" + }, + "logo2xUrl": { + "type": "string" + }, + "logo3xUrl": { + "type": "string" + } + } + }, + "FavoriteProductDto": { + "type": "object", + "required": [ + "id", + "mallId", + "mallName", + "mallProductCode", + "itemImageUri", + "itemThumbnailUri", + "brandName", + "productName", + "productDiscountRate", + "price", + "productPriceDetail", + "shopUri", + "createdAt" + ], + "properties": { + "id": { + "type": "string" + }, + "mallId": { + "type": "string" + }, + "mallName": { + "type": "string" + }, + "mallProductCode": { + "type": "string" + }, + "itemImageUri": { + "description": "ู…ูˆู‚ูˆู", + "type": "string" + }, + "multiResolutionItemImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "itemThumbnailUri": { + "description": "ู…ูˆู‚ูˆู", + "type": "string" + }, + "multiResolutionItemThumbnail": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "brandName": { + "type": "string" + }, + "productName": { + "type": "string" + }, + "productDiscountRate": { + "type": "integer", + "format": "int32" + }, + "originalPrice": { + "type": "integer", + "format": "int64" + }, + "price": { + "type": "integer", + "format": "int64" + }, + "productPriceDetail": { + "$ref": "#/components/schemas/ProductPriceDetailDto" + }, + "shopUri": { + "type": "string" + }, + "shopLogoUri": { + "type": "string" + }, + "createdAt": { + "type": "string" + } + } + }, + "FavoriteProductListDto": { + "type": "object", + "required": [ + "list", + "last", + "freeReturnTargetProductIds" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FavoriteProductDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + }, + "freeReturnTargetProductIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ProductItemListDto": { + "type": "object", + "required": [ + "options", + "optionElements", + "productItems" + ], + "properties": { + "options": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OptionDto" + } + }, + "optionElements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OptionElementDto" + } + }, + "productItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductItemDto" + } + } + } + }, + "ProductReleaseEstimateDto": { + "type": "object", + "required": [ + "productId", + "itemReleaseEstimateAtList" + ], + "properties": { + "productId": { + "type": "string", + "description": "ู…ุนุฑู ุงู„ู…ู†ุชุฌ" + }, + "itemReleaseEstimateAtList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductItemReleaseEstimateDto" + } + } + } + }, + "ProductItemReleaseEstimateDto": { + "type": "object", + "required": [ + "productItemId", + "releaseEstimateAt" + ], + "properties": { + "productItemId": { + "type": "string", + "description": "ู…ุนุฑู ุฎูŠุงุฑ ุงู„ู…ู†ุชุฌ" + }, + "itemReleaseEstimateAtMillis": { + "type": "integer", + "format": "int64", + "description": "ุชุงุฑูŠุฎ ุงู„ุดุญู† ุจุชู†ุณูŠู‚ yyyy-mm-dd" + } + } + }, + "ProductItemDto": { + "type": "object", + "required": [ + "id", + "title", + "optionElementIds", + "price", + "display", + "salesStatus", + "mallProductItemCode" + ], + "properties": { + "id": { + "type": "string" + }, + "title": { + "type": "string" + }, + "releaseAtEstimate": { + "type": "string", + "description": "ุชุงุฑูŠุฎ ุงู„ุดุญู† ุจุชู†ุณูŠู‚ yyyy-mm-dd" + }, + "optionElementIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "maxQuantity": { + "type": "integer", + "format": "int64" + }, + "price": { + "type": "integer", + "format": "int64" + }, + "display": { + "type": "boolean", + "description": "- ูŠุดูŠุฑ ุฅู„ู‰ ู…ุง ุฅุฐุง ูƒุงู†ุช ุฎูŠุงุฑุงุช ุงู„ู…ู†ุชุฌ ู…ุนุฑูˆุถุฉ ุฃู… ู„ุง - ุฅุฐุง ูƒุงู† ุฎุทุฃุŒ ูŠุดูŠุฑ ุฅู„ู‰ ุญุงู„ุฉ ู†ูุงุฏ ุงู„ู…ุฎุฒูˆู†" + }, + "salesStatus": { + "$ref": "#/components/schemas/SalesStatusEnum" + }, + "mallProductItemCode": { + "type": "string" + } + } + }, + "OptionDto": { + "type": "object", + "required": [ + "title" + ], + "properties": { + "title": { + "type": "string" + } + } + }, + "OptionElementDto": { + "type": "object", + "required": [ + "id", + "title" + ], + "properties": { + "id": { + "type": "string" + }, + "title": { + "type": "string" + } + } + }, + "ProductItemAvailabilityDto": { + "type": "object", + "required": [ + "productId", + "productItemId", + "available" + ], + "properties": { + "productId": { + "type": "string" + }, + "productItemId": { + "type": "string" + }, + "quantity": { + "description": "- ู…ุฎุฒูˆู† ุฎูŠุงุฑ ุงู„ู…ู†ุชุฌ - ุฅุฐุง ูƒุงู†ุช ู‡ุฐู‡ ุงู„ู‚ูŠู…ุฉ `ูุงุฑุบุฉ` -> ูŠุนุชุจุฑ ุงู„ู…ุฎุฒูˆู† ุบูŠุฑ ู…ุญุฏูˆุฏ ุฏุงุฎู„ูŠู‹ุง - ู„ุง ูŠู…ูƒู† ู„ู‡ุฐู‡ ุงู„ู‚ูŠู…ุฉ ูˆุญุฏู‡ุง ุชุญุฏูŠุฏ ู…ุง ุฅุฐุง ูƒุงู† ุงู„ู…ู†ุชุฌ ู…ุชุงุญู‹ุง ู„ู„ุดุฑุงุก ุฃู… ู„ุง -> ู‚ูŠู…ุฉ `ProductItemAvailabilityDto.available` ู…ู‡ู…ุฉ", + "type": "integer", + "format": "int64" + }, + "available": { + "description": "ุชูˆูุฑ ุงู„ู…ู†ุชุฌ (ุงู„ู‚ูŠู…ุฉ ุงู„ู…ุญุณูˆุจุฉ ู…ู† ู‚ูŠู…ุฉ ุงู„ู…ู†ุชุฌ ~ ุนู†ุตุฑ ุงู„ู…ู†ุชุฌ)", + "type": "boolean" + } + } + }, + "BrandListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BrandDto" + } + } + } + }, + "BrandDto": { + "type": "object", + "required": [ + "id", + "name", + "logo" + ], + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "logo": { + "$ref": "#/components/schemas/BrandLogoDto" + } + } + }, + "BrandLogoDto": { + "type": "object", + "properties": { + "landscapeUrl": { + "description": "ู…ูˆู‚ูˆู", + "type": "string" + }, + "multiResolutionLandscape": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "squareUrl": { + "description": "ู…ูˆู‚ูˆู", + "type": "string" + }, + "multiResolutionSquare": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + } + } + }, + "BrandDetailDto": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "logo": { + "$ref": "#/components/schemas/BrandLogoDto" + }, + "categories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + } + } + }, + "BrandProductsDto": { + "type": "object", + "required": [ + "brand", + "list" + ], + "properties": { + "brand": { + "$ref": "#/components/schemas/BrandDto" + }, + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDto" + } + } + } + }, + "BrandProductsListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BrandProductsDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "AddToCartRequestDto": { + "type": "object", + "required": [ + "items" + ], + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AddCartItemDto" + } + } + } + }, + "AddToCartResponseDto": { + "type": "object", + "required": [ + "cartItemIds" + ], + "properties": { + "cartItemIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + } + } + }, + "AddCartItemDto": { + "type": "object", + "required": [ + "productItemId", + "quantity" + ], + "properties": { + "productItemId": { + "type": "string" + }, + "quantity": { + "type": "integer", + "format": "int64" + } + } + }, + "DeleteCartItemsRequestDto": { + "type": "object", + "required": [ + "cartItemIds" + ], + "properties": { + "cartItemIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + } + } + }, + "CartItemGroupDto": { + "type": "object", + "required": [ + "groupId", + "brand", + "delivery", + "items" + ], + "properties": { + "groupId": { + "type": "string" + }, + "brand": { + "$ref": "#/components/schemas/BrandDto" + }, + "delivery": { + "$ref": "#/components/schemas/CartItemGroupDeliveryPolicyDto" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartItemDto" + } + } + } + }, + "CartItemGroupDeliveryPolicyDto": { + "type": "object", + "required": [ + "defaultPrice", + "defaultReturnCost", + "shippingCostPolicy", + "returnCostPolicy", + "logisticsPolicy", + "assorted", + "shippingPolicyId" + ], + "properties": { + "defaultPrice": { + "type": "integer", + "format": "int64", + "description": "ุชู… ุงู„ุฅูŠู‚ุงู -> ุงุณุชุฎุฏู… "shippingCostPolicy"." + }, + "requiredAmountForFree": { + "type": "integer", + "format": "int64", + "description": "ุชู… ุงู„ุฅูŠู‚ุงู -> ุงุณุชุฎุฏู… "shippingCostPolicy"." + }, + "defaultReturnCost": { + "type": "integer", + "format": "int64", + "description": "ุชู… ุฅู‡ู…ุงู„ู‡ -> ุงุณุชุฎุฏู… "returnCostPolicy"." + }, + "shippingCostPolicy": { + "$ref": "#/components/schemas/ShippingCostPolicyDto" + }, + "returnCostPolicy": { + "$ref": "#/components/schemas/ReturnCostPolicyDto" + }, + "logisticsPolicy": { + "$ref": "#/components/schemas/LogisticsPolicyDto" + }, + "assorted": { + "type": "boolean" + }, + "shippingPolicyId": { + "type": "integer", + "format": "int64" + } + } + }, + "DeliveryPolicyDto": { + "type": "object", + "required": [ + "defaultPrice", + "defaultReturnCost", + "shippingCostPolicy", + "returnCostPolicy", + "logisticsPolicy" + ], + "properties": { + "defaultPrice": { + "type": "integer", + "format": "int64", + "description": "ุชู… ุงู„ุฅูŠู‚ุงู -> ุงุณุชุฎุฏู… "shippingCostPolicy"." + }, + "requiredAmountForFree": { + "type": "integer", + "format": "int64", + "description": "ุชู… ุงู„ุฅูŠู‚ุงู -> ุงุณุชุฎุฏู… "shippingCostPolicy"." + }, + "defaultReturnCost": { + "type": "integer", + "format": "int64", + "description": "ุชู… ุฅู‡ู…ุงู„ู‡ -> ุงุณุชุฎุฏู… "returnCostPolicy"." + }, + "shippingCostPolicy": { + "$ref": "#/components/schemas/ShippingCostPolicyDto" + }, + "returnCostPolicy": { + "$ref": "#/components/schemas/ReturnCostPolicyDto" + }, + "logisticsPolicy": { + "$ref": "#/components/schemas/LogisticsPolicyDto" + } + } + }, + "ShippingCostPolicyDto": { + "type": "object", + "description": "ุณูŠุงุณุฉ ุงู„ุดุญู†", + "required": [ + "defaultCost", + "jejuIsland", + "backCountry" + ], + "properties": { + "defaultCost": { + "type": "integer", + "format": "int64" + }, + "jejuIsland": { + "type": "integer", + "format": "int64", + "description": "ุฑุณูˆู… ุดุญู† ุฅุถุงููŠุฉ ุฅู„ู‰ ุฌุฒูŠุฑุฉ ุฌูŠุฌูˆ" + }, + "backCountry": { + "type": "integer", + "format": "int64", + "description": "ุชูƒุงู„ูŠู ุงู„ุดุญู† ุงู„ุฅุถุงููŠุฉ ุฅู„ู‰ ุงู„ุฌุฒุฑ ูˆุงู„ู…ู†ุงุทู‚ ุงู„ู†ุงุฆูŠุฉ" + }, + "requiredAmountForFree": { + "type": "integer", + "format": "int64", + "description": "ุงู„ุญุฏ ุงู„ุฃุฏู†ู‰ ู„ู…ุจู„ุบ ุงู„ุดุฑุงุก ู„ู„ุดุญู† ุงู„ู…ุฌุงู†ูŠ" + } + } + }, + "ReturnCostPolicyDto": { + "type": "object", + "description": "ุณูŠุงุณุฉ ุฑุณูˆู… ุงู„ุฅุฑุฌุงุน", + "required": [ + "defaultCost", + "jejuIsland", + "backCountry" + ], + "properties": { + "defaultCost": { + "type": "integer", + "format": "int64", + "description": "ุชูƒู„ูุฉ ุงู„ุฅุฑุฌุงุน ุงู„ุฃุณุงุณูŠุฉ ุฏูˆู† ุฃุฎุฐ ุงู„ุชูƒู„ูุฉ ุงู„ุฅุถุงููŠุฉ ููŠ ุงู„ุงุนุชุจุงุฑ" + }, + "jejuIsland": { + "type": "integer", + "format": "int64", + "description": "ุฌุฒูŠุฑุฉ ุฌูŠุฌูˆ ุฑุณูˆู… ุนูˆุฏุฉ ุฅุถุงููŠุฉ" + }, + "backCountry": { + "type": "integer", + "format": "int64", + "description": "ุฑุณูˆู… ุนูˆุฏุฉ ุฅุถุงููŠุฉ ู„ู„ุฌุฒุฑ ูˆุงู„ู…ู†ุงุทู‚ ุงู„ู†ุงุฆูŠุฉ" + } + } + }, + "LogisticsPolicyDto": { + "type": "object", + "properties": { + "shippingPlace": { + "type": "string", + "description": "ุนู†ูˆุงู† ุงู„ุดุญู†" + }, + "returnPlace": { + "type": "string", + "description": "ุนู†ูˆุงู† ุงู„ู…ุฑุณู„" + }, + "courier": { + "deprecated": true, + "type": "string", + "description": "- ู…ูˆู‚ูˆู - ุงู„ุฑุฌุงุก ุงุณุชุฎุฏุงู… ุญู‚ู„ "ุงู„ู…ูˆุฑุฏ" - ุดุฑูƒุฉ ุงู„ุจุฑูŠุฏ ุงู„ุณุฑูŠุน ุงู„ู…ุณุชุฎุฏู…ุฉ" + }, + "vendor": { + "$ref": "#/components/schemas/LogisticsVendorEnum" + } + } + }, + "LogisticsVendorEnum": { + "oneOf": [ + { + "const": "CJ๋Œ€ํ•œํ†ต์šด" + }, + { + "const": "๋กœ์  ํƒ๋ฐฐ" + }, + { + "const": "์šฐ์ฒด๊ตญํƒ๋ฐฐ" + }, + { + "const": "ํ•œ์ง„ํƒ๋ฐฐ" + }, + { + "const": "๋กฏ๋ฐํƒ๋ฐฐ" + }, + { + "const": "๋Œ€์‹ ํƒ๋ฐฐ" + }, + { + "const": "์ผ์–‘ํƒ๋ฐฐ" + }, + { + "const": "๊ฒฝ๋™ํƒ๋ฐฐ" + }, + { + "const": "ํ•ฉ๋™ํƒ๋ฐฐ" + }, + { + "const": "์ฒœ์ผํƒ๋ฐฐ" + }, + { + "const": "GSํŽธ์˜์ ํƒ๋ฐฐ" + }, + { + "const": "ํ•œ์˜์‚ฌ๋ž‘ํƒ๋ฐฐ" + }, + { + "const": "๊ฑด์˜ํƒ๋ฐฐ" + }, + { + "const": "ํ˜ธ๋‚จํƒ๋ฐฐ" + }, + { + "const": "SLX" + }, + { + "const": "CUํŽธ์˜์ ํƒ๋ฐฐ" + }, + { + "const": "์šฉ๋งˆ๋กœ์ง€์Šค" + }, + { + "const": "์„ธ๋ฐฉํƒ๋ฐฐ" + }, + { + "const": "์›๋”์Šคํ€ต" + }, + { + "const": "๋†ํ˜‘ํƒ๋ฐฐ" + }, + { + "const": "HIํƒ๋ฐฐ" + }, + { + "const": "ํ™ˆํ”ฝํƒ๋ฐฐ" + }, + { + "const": "CJ๋Œ€ํ•œํ†ต์šด๊ตญ์ œํŠน์†ก" + }, + { + "const": "EMS" + }, + { + "const": "๋กฏ๋ฐ๊ธ€๋กœ๋ฒŒ" + }, + { + "const": "ํ•œ๋ฑ์Šค" + }, + { + "const": "DHL" + }, + { + "const": "FEDEX" + }, + { + "const": "UPS" + }, + { + "const": "TNT" + }, + { + "const": "๋ฒ”ํ•œํŒํ† ์Šค" + }, + { + "const": "ACI Express" + }, + { + "const": "ACE Express" + }, + { + "const": "์€ํ•˜์‰ฌํ•‘" + }, + { + "const": "๋‘๋ฐœํžˆ์–ด๋กœ" + }, + { + "const": "๋กœ์ง€์ŠคํŒŸ" + }, + { + "const": "๋ถ€๋ฆ‰(VROONG)" + }, + { + "const": "์ดํˆฌ๋งˆ์Šค" + }, + { + "const": "์—์ด์Šค๋ฌผ๋ฅ˜" + }, + { + "const": "๋Œ€๋ฆผํ†ต์šด" + }, + { + "const": "๋ฐœ๋ ‰์Šค" + }, + { + "const": "๊ธฐํƒ€๋ฐฐ์†ก์‚ฌ" + }, + { + "const": "์ง์ ‘๋ฐฐ์†ก" + } + ], + "description": "- (ููŠู…ุง ูŠุชุนู„ู‚ ุจุณูŠุงุณุฉ ุงู„ุชูˆุตูŠู„) ุดุฑูƒุงุช ุงู„ุชูˆุตูŠู„ ุงู„ุชูŠ ูŠู…ูƒู† ุชุนูŠูŠู†ู‡ุง - `ETC (ุฎุฏู…ุฉ ุชูˆุตูŠู„ ุฃุฎุฑู‰)` -> ุฃู†ุช ุชุณุชุฎุฏู… ุดุฑูƒุฉ ุชูˆุตูŠู„ ู…ุญุฏุฏุฉุŒ ูˆู„ูƒู† ุฎุฏู…ุฉ ุงู„ุชูˆุตูŠู„ ุบูŠุฑ ู…ุฏุนูˆู…ุฉ ุญุงู„ูŠู‹ุง (ุฅุฐุง ูƒู†ุช ุจุญุงุฌุฉ ุฅู„ู‰ ุฏุนู… ู„ุดุฑูƒุงุช ุงู„ุชูˆุตูŠู„ ุงู„ุฃุฎุฑู‰ุŒ ู…ู† ูุถู„ูƒ ุงุชุตู„ ุจู†ุง ุจุดูƒู„ ู…ู†ูุตู„) - `SELF_MANAGED (ุงู„ุชุณู„ูŠู… ุงู„ู…ุจุงุดุฑ)` -> ูŠุณุชุฎุฏู… ุนู†ุฏ ุงู„ุชุณู„ูŠู… ุงู„ู…ุจุงุดุฑ", + "x-enum-varnames": [ + "CJ_GLS", + "LOGEN", + "EPOST", + "HANJIN", + "LOTTE", + "DAESIN", + "ILYANG", + "KYUNGDONG", + "HAPDONG", + "CHUNIL", + "CVSNET", + "HPL", + "KUNYOUNG", + "HONAM", + "SLX", + "BGF", + "YONGMA", + "SEBANG", + "WONDERS", + "NH_LOGIS", + "HI_LOGIS", + "HOMEPICK", + "KOREX_G", + "EMS", + "LOTTE_GLOBAL", + "HANDEX", + "DHL", + "FEDEX", + "UPS", + "TNT", + "PANTOS", + "ACI_EXPRESS", + "ACE_EXP", + "EUNHA", + "CHAIN_LOGISTICS", + "LOGISPOT", + "VROONG", + "ETOMARS", + "VENDORPIA", + "DAERIM", + "VALEX", + "ETC", + "SELF_MANAGED" + ] + }, + "CartItemDto": { + "type": "object", + "description": "- `product.salesStatus != ู†ุดุท || ุฅุฐุง ูƒุงู† ุงู„ู…ู†ุชุฌ.display == false` -> ุงู„ุนุฑุถ ุนู„ู‰ ุฃู†ู‡ ุบูŠุฑ ู…ุชูˆูุฑ ููŠ ุงู„ู…ุฎุฒูˆู† - `productItem.salesStatus!= ACTIVE || ุฅุฐุง ูƒุงู† ProductItem.display == false` -> ูŠุชู… ุนุฑุถู‡ ุนู„ู‰ ุฃู†ู‡ ู†ูุงุฏ ุงู„ู…ุฎุฒูˆู† - ุฅุฐุง ุชู… ุชุทุจูŠู‚ ุฎุตู… Queenit ุงู„ููˆุฑูŠุŒ ูุฅู† `ProductDto` ูŠุนุฑุถ ุงู„ู…ุจู„ุบ ู…ุน ุงู„ุฎุตู… ุงู„ููˆุฑูŠ ุงู„ู…ุทุจู‚ - ุงู„ุญู‚ูˆู„ ุงู„ู…ุชุฃุซุฑุฉ: `finalPrice`ุŒ `discountPercentage`", + "required": [ + "id", + "product", + "productItem", + "quantity", + "brand", + "freeReturnTarget" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "product": { + "$ref": "#/components/schemas/ProductDto" + }, + "productItem": { + "$ref": "#/components/schemas/ProductItemDto" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "brand": { + "$ref": "#/components/schemas/BrandDto" + }, + "freeReturnTarget": { + "type": "boolean" + } + } + }, + "PurchaseTopicEnum": { + "const": "PRODUCT" + }, + "StartOrderRequestDto": { + "type": "object", + "required": [ + "cartItemIds" + ], + "properties": { + "cartItemIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + } + } + }, + "StartOrderFromAddingRequestDto": { + "type": "object", + "required": [ + "items" + ], + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AddCartItemDto" + } + } + } + }, + "DeliveryAddressDto": { + "type": "object", + "required": [ + "recipientName", + "phoneNumber", + "zipCode", + "address", + "detailedAddress" + ], + "properties": { + "recipientName": { + "type": "string" + }, + "phoneNumber": { + "type": "string" + }, + "zipCode": { + "type": "string", + "description": "ุฑู‚ู… ุงู„ู…ู†ุทู‚ุฉ ุงู„ุฃุณุงุณูŠ ู„ู„ูˆู„ุงูŠุฉ ุงู„ู…ูƒูˆู† ู…ู† 5 ุฃุฑู‚ุงู…" + }, + "address": { + "type": "string" + }, + "detailedAddress": { + "type": "string" + } + } + }, + "UserRefundAccountDto": { + "type": "object", + "properties": { + "refundAccount": { + "$ref": "#/components/schemas/RefundAccountDto" + } + } + }, + "RefundAccountDto": { + "type": "object", + "required": [ + "accountNumber", + "bank", + "holderName" + ], + "properties": { + "accountNumber": { + "type": "string" + }, + "bank": { + "$ref": "#/components/schemas/RefundAccountBankEnum" + }, + "holderName": { + "type": "string" + } + } + }, + "ConnectPayPromotionDto": { + "type": "object", + "required": [ + "discountCards", + "interestFreeCards" + ], + "properties": { + "discountCards": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConnectPayDiscountCardDto" + } + }, + "interestFreeCards": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConnectPayInterestFreeCardsDto" + } + } + } + }, + "ConnectPayDiscountCardDto": { + "type": "object", + "required": [ + "card", + "minimumPaymentAmount", + "discountCode", + "discountAmount" + ], + "properties": { + "card": { + "$ref": "#/components/schemas/TossPaymentCardEnum" + }, + "minimumPaymentAmount": { + "type": "integer", + "format": "int64" + }, + "maximumPaymentAmount": { + "type": "integer", + "format": "int64" + }, + "discountCode": { + "description": "ูŠุฌุจ ุชู…ุฑูŠุฑ ุฑู…ุฒ ุงู„ุฎุตู… ุนู†ุฏ ุทู„ุจ ุงู„ุฏูุน ุจุงุณุชุฎุฏุงู… ุฎุฏู…ุฉ Connect-Pay", + "type": "string" + }, + "discountAmount": { + "type": "integer", + "format": "int64" + } + } + }, + "ConnectPayInterestFreeCardsDto": { + "type": "object", + "required": [ + "card", + "interestFreeMonths", + "minimumPaymentAmount" + ], + "properties": { + "card": { + "$ref": "#/components/schemas/TossPaymentCardEnum" + }, + "interestFreeMonths": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + } + }, + "minimumPaymentAmount": { + "type": "integer", + "format": "int64" + } + } + }, + "TossPaymentPromotionDto": { + "type": "object", + "required": [ + "discountCards", + "interestFreeCards" + ], + "properties": { + "discountCards": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TossPaymentDiscountPolicyDto" + } + }, + "interestFreeCards": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TossPaymentInterestFreePolicyDto" + } + } + } + }, + "TossPaymentDiscountPolicyDto": { + "type": "object", + "required": [ + "card", + "minimumPaymentAmount", + "discountCode", + "discountAmount" + ], + "properties": { + "card": { + "$ref": "#/components/schemas/TossPaymentCardEnum" + }, + "minimumPaymentAmount": { + "type": "integer", + "format": "int64" + }, + "maximumPaymentAmount": { + "type": "integer", + "format": "int64" + }, + "discountCode": { + "description": "ูŠุฌุจ ุชู…ุฑูŠุฑ ุฑู…ุฒ ุงู„ุฎุตู… ุนู†ุฏ ุทู„ุจ ุงู„ุฏูุน ุจุงู„ุฑู…ูŠ", + "type": "string" + }, + "discountAmount": { + "type": "integer", + "format": "int64" + } + } + }, + "TossPaymentInterestFreePolicyDto": { + "type": "object", + "required": [ + "card", + "installmentFreeMonths", + "minimumPaymentAmount" + ], + "properties": { + "card": { + "$ref": "#/components/schemas/TossPaymentCardEnum" + }, + "installmentFreeMonths": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + } + }, + "minimumPaymentAmount": { + "type": "integer", + "format": "int64" + } + } + }, + "TossPaymentAccountEnum": { + "oneOf": [ + { + "const": "๋†ํ˜‘" + }, + { + "const": "์šฐ๋ฆฌ" + }, + { + "const": "์‹ ํ•œ" + }, + { + "const": "๊ตญ๋ฏผ" + }, + { + "const": "ํ•˜๋‚˜" + }, + { + "const": "์”จํ‹ฐ" + }, + { + "const": "๊ธฐ์—…" + }, + { + "const": "์‚ฐ์—…" + }, + { + "const": "์ œ์ผ" + }, + { + "const": "๋Œ€๊ตฌ" + }, + { + "const": "๋ถ€์‚ฐ" + }, + { + "const": "์ „๋ถ" + }, + { + "const": "๊ฒฝ๋‚จ" + }, + { + "const": "์ œ์ฃผ" + }, + { + "const": "๊ด‘์ฃผ" + }, + { + "const": "์ƒˆ๋งˆ์„" + }, + { + "const": "์ˆ˜ํ˜‘" + }, + { + "const": "์‹ ํ˜‘" + }, + { + "const": "์šฐ์ฒด๊ตญ" + }, + { + "const": "์ผ€์ด" + }, + { + "const": "์นด์นด์˜ค" + }, + { + "const": "์ €์ถ•" + }, + { + "const": "์‚ฐ๋ฆผ" + }, + { + "const": "UNKNOWN" + } + ], + "x-enum-varnames": [ + "NONGHYUP", + "WOORI", + "SHINHAN", + "KOOKMIN", + "HANA", + "CITI", + "INDUSTRIAL", + "KDB", + "SC", + "DAEGU", + "BUSAN", + "JEONBUK", + "KYONGNAM", + "JEJU", + "KWANGJU", + "SAEMAEUL", + "SUHYUP", + "SHINHYUP", + "POST", + "K_BANK", + "KAKAO_BANK", + "SAVING_SB", + "FORESTRY_SJ", + "UNKNOWN" + ] + }, + "TossPaymentCardEnum": { + "oneOf": [ + { + "const": "์‹ ํ•œ" + }, + { + "const": "ํ˜„๋Œ€" + }, + { + "const": "์‚ผ์„ฑ" + }, + { + "const": "์šฐ๋ฆฌ" + }, + { + "const": "๊ตญ๋ฏผ" + }, + { + "const": "๋กฏ๋ฐ" + }, + { + "const": "๋†ํ˜‘" + }, + { + "const": "ํ•˜๋‚˜" + }, + { + "const": "BC" + }, + { + "const": "์”จํ‹ฐ" + }, + { + "const": "์นด์นด์˜ค๋ฑ…ํฌ" + }, + { + "const": "KDB" + }, + { + "const": "์ˆ˜ํ˜‘" + }, + { + "const": "์ „๋ถ" + }, + { + "const": "์šฐ์ฒด๊ตญ" + }, + { + "const": "์ƒˆ๋งˆ์„" + }, + { + "const": "์ €์ถ•" + }, + { + "const": "์ œ์ฃผ" + }, + { + "const": "๊ด‘์ฃผ" + }, + { + "const": "์‹ ํ˜‘" + }, + { + "const": "JCB" + }, + { + "const": "์œ ๋‹ˆ์˜จํŽ˜์ด" + }, + { + "const": "๋งˆ์Šคํ„ฐ" + }, + { + "const": "๋น„์ž" + }, + { + "const": "๋‹ค์ด๋„ˆ์Šค" + }, + { + "const": "๋””์Šค์ปค๋ฒ„" + }, + { + "const": "UNKNOWN" + } + ], + "x-enum-varnames": [ + "SHINHAN", + "HYUNDAI", + "SAMSUNG", + "WOORI", + "KOOKMIN", + "LOTTE", + "NONGHYUP", + "HANA", + "BC", + "CITI", + "KAKAO_BANK", + "KDB", + "SUHYUP", + "JEONBUK", + "POST", + "SAEMAEUL", + "SAVING_SB", + "JEJU", + "KWANGJU", + "SHINHYUP", + "JCB", + "UNION_PAY", + "MASTER_CARD", + "VISA", + "DINERS_CLUB", + "DISCOVER", + "UNKNOWN" + ] + }, + "RefundAccountBankEnum": { + "oneOf": [ + { + "const": "๋†ํ˜‘" + }, + { + "const": "๊ตญ๋ฏผ" + }, + { + "const": "์šฐ๋ฆฌ" + }, + { + "const": "์‹ ํ•œ" + }, + { + "const": "๊ธฐ์—…" + }, + { + "const": "ํ•˜๋‚˜" + }, + { + "const": "๊ฒฝ๋‚จ" + }, + { + "const": "๋Œ€๊ตฌ" + }, + { + "const": "๋ถ€์‚ฐ" + }, + { + "const": "์ˆ˜ํ˜‘" + }, + { + "const": "์šฐ์ฒด๊ตญ" + }, + { + "const": "์‚ฐ์—…" + }, + { + "const": "SC์ œ์ผ" + }, + { + "const": "์”จํ‹ฐ" + }, + { + "const": "๊ด‘์ฃผ" + }, + { + "const": "์ œ์ฃผ" + }, + { + "const": "์ „๋ถ" + }, + { + "const": "์ƒˆ๋งˆ์„" + }, + { + "const": "์‹ ํ˜‘" + }, + { + "const": "์ผ€์ด" + }, + { + "const": "์นด์นด์˜ค" + } + ], + "x-enum-varnames": [ + "NONGHYUP", + "KOOKMIN", + "WOORI", + "SHINHAN", + "INDUSTRIAL", + "HANA", + "KYONGNAM", + "DAEGU", + "BUSAN", + "SUHYUP", + "POST", + "KDB", + "SC", + "CITI", + "KWANGJU", + "JEJU", + "JEONBUK", + "SAEMAEUL", + "SHINHYUP", + "K_BANK", + "KAKAO_BANK" + ] + }, + "BankNameEnum": { + "oneOf": [ + { + "const": "๋†ํ˜‘" + }, + { + "const": "๊ตญ๋ฏผ" + }, + { + "const": "์šฐ๋ฆฌ" + }, + { + "const": "์‹ ํ•œ" + }, + { + "const": "๊ธฐ์—…" + }, + { + "const": "ํ•˜๋‚˜" + }, + { + "const": "๊ฒฝ๋‚จ" + }, + { + "const": "๋Œ€๊ตฌ" + }, + { + "const": "๋ถ€์‚ฐ" + }, + { + "const": "์ˆ˜ํ˜‘" + }, + { + "const": "์šฐ์ฒด๊ตญ" + }, + { + "const": "์‚ฐ์—…" + }, + { + "const": "SC์ œ์ผ" + }, + { + "const": "์”จํ‹ฐ" + }, + { + "const": "๊ด‘์ฃผ" + }, + { + "const": "์ œ์ฃผ" + }, + { + "const": "์ „๋ถ" + }, + { + "const": "์ƒˆ๋งˆ์„" + }, + { + "const": "์‹ ํ˜‘" + }, + { + "const": "์ผ€์ด" + }, + { + "const": "์นด์นด์˜ค" + } + ], + "description": "ุงุณู… ุงู„ุจู†ูƒ", + "x-enum-varnames": [ + "NONGHYUP", + "KOOKMIN", + "WOORI", + "SHINHAN", + "INDUSTRIAL", + "HANA", + "KYONGNAM", + "DAEGU", + "BUSAN", + "SUHYUP", + "POST", + "KDB", + "SC", + "CITI", + "KWANGJU", + "JEJU", + "JEONBUK", + "SAEMAEUL", + "SHINHYUP", + "K_BANK", + "KAKAO_BANK" + ] + }, + "ProductPurchaseMaterialDto": { + "type": "object", + "required": [ + "purchaseId", + "recentDeliveredRequests", + "issuedCoupons", + "orderSummary", + "payableMethodIds", + "tossPaymentsInterestFreePolicies" + ], + "properties": { + "purchaseId": { + "type": "string" + }, + "recentDeliveredRequests": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserDeliveryAddressDto" + } + }, + "recommendedIssuedCouponId": { + "type": "integer", + "format": "int64" + }, + "issuedCoupons": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IssuedCouponWhenOrderDto" + } + }, + "orderSummary": { + "$ref": "#/components/schemas/OrderSummaryDto" + }, + "refundAccount": { + "$ref": "#/components/schemas/RefundAccountDto" + }, + "payableMethodIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "tossPaymentsInterestFreePolicies": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TossPaymentInterestFreePolicyDto" + } + } + } + }, + "StartIamportPaymentRequestDto": { + "type": "object", + "required": [ + "pg", + "pgMethod" + ], + "properties": { + "pg": { + "type": "string", + "description": "ู…ุนุฑู ุจูˆุงุจุฉ ุงู„ุฏูุน" + }, + "pgMethod": { + "type": "string", + "description": "ุทุฑูŠู‚ุฉ ุชุนุชู…ุฏ ุนู„ู‰ ุจูˆุงุจุฉ ุงู„ุฏูุน" + } + } + }, + "IamportPaymentMaterialDto": { + "type": "object", + "required": [ + "storeId", + "pg", + "merchantId", + "productName", + "productPrice", + "currency", + "language", + "buyerTel", + "payMethod" + ], + "properties": { + "storeId": { + "type": "string", + "description": "ู…ุนุฑู ุงู„ู…ุชุฌุฑ (ุนู„ู‰ ุณุจูŠู„ ุงู„ู…ุซุงู„ "imp*")" + }, + "pg": { + "type": "string", + "description": "ู…ุนุฑู ุจูˆุงุจุฉ ุงู„ุฏูุน" + }, + "merchantId": { + "type": "string", + "description": "ุชู… ุฅู†ุดุงุก ู…ุนุฑู ุงู„ุชุงุฌุฑ ู„ู‡ุฐู‡ ุงู„ุฏูุนุฉ" + }, + "productName": { + "type": "string", + "description": "ุงุณู… ุงู„ู…ู†ุชุฌ ุงู„ุฐูŠ ุณูŠุธู‡ุฑ ู„ู„ู…ุณุชุฎุฏู…" + }, + "productPrice": { + "type": "integer", + "format": "int64", + "description": "ุณุนุฑ ุงู„ุฏูุน ูƒู…ุง KRW" + }, + "currency": { + "type": "string", + "description": "ูˆูˆู† ูƒูˆุฑูŠ ุฌู†ูˆุจูŠ" + }, + "language": { + "type": "string", + "description": "ุฃูˆู†" + }, + "buyerTel": { + "type": "string", + "description": "ุฑู‚ู… ู‡ุงุชู ุงู„ู…ุดุชุฑูŠ" + }, + "payMethod": { + "type": "string", + "description": "ุทุฑูŠู‚ุฉ ุงู„ุฏูุน (ู…ุซู„ุง ุงู„ุจุทุงู‚ุฉ)" + }, + "naverProducts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NaverProductDto" + } + } + } + }, + "NaverProductDto": { + "type": "object", + "required": [ + "categoryType", + "categoryId", + "uid", + "name", + "count" + ], + "properties": { + "categoryType": { + "type": "string" + }, + "categoryId": { + "type": "string" + }, + "uid": { + "type": "string" + }, + "name": { + "type": "string" + }, + "count": { + "type": "integer", + "format": "int64" + } + } + }, + "StartConnectPayPaymentRequestDto": { + "type": "object", + "required": [ + "payMethod" + ], + "properties": { + "payMethod": { + "$ref": "#/components/schemas/ConnectPayPaymentMethodEnum" + } + } + }, + "ConnectPayPaymentMethodEnum": { + "oneOf": [ + { + "const": "CARD" + }, + { + "const": "ACCOUNT_TRANSFER" + } + ] + }, + "ConnectPayPaymentMaterialDto": { + "type": "object", + "required": [ + "clientKey", + "customerKey", + "amount", + "merchantId", + "title", + "successUrl", + "failUrl", + "redirectUrl" + ], + "properties": { + "clientKey": { + "type": "string", + "description": "ClientKey ู„ู…ุตุงุฏู‚ุฉ ConnectPay JS SDK" + }, + "customerKey": { + "type": "string", + "description": "ุงู„ู…ุณุชุฎุฏู… uid ุงู„ุฎุงุฑุฌูŠ ุงู„ู…ุณุชุฎุฏู… ุนู†ุฏ ุทู„ุจ ุงู„ุฏูุน" + }, + "amount": { + "type": "integer", + "format": "int64", + "description": "ุงู„ู…ุจู„ุบ ุงู„ูุนู„ูŠ ุงู„ู…ุฏููˆุน (ุงู„ู…ุจู„ุบ)" + }, + "merchantId": { + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ู„ุฏูุน ุงู„ุทู„ุจ (OrderID)" + }, + "title": { + "type": "string", + "description": "ุงุณู… ุงู„ุทู„ุจ ู„ู„ุฏูุน (ุงุณู… ุงู„ุทู„ุจ)" + }, + "successUrl": { + "type": "string", + "description": "ุฅุนุงุฏุฉ ุชูˆุฌูŠู‡ URL ุนู†ุฏ ุงู„ุฏูุน ุงู„ู†ุงุฌุญ" + }, + "failUrl": { + "type": "string", + "description": "ุฅุนุงุฏุฉ ุชูˆุฌูŠู‡ ุนู†ูˆุงู† URL ุนู†ุฏ ูุดู„ ุงู„ุฏูุน" + }, + "redirectUrl": { + "type": "string", + "description": "ุฅุนุงุฏุฉ ุชูˆุฌูŠู‡ ุนู†ูˆุงู† URL ู„ุงุณุชุฎุฏุงู…ู‡ ููŠ ู…ุตุงุฏู‚ุฉ Connect Pay OAuth" + } + } + }, + "StartTossPaymentRequestDto": { + "type": "object", + "required": [ + "payMethod" + ], + "properties": { + "payMethod": { + "$ref": "#/components/schemas/TossPaymentMethodEnum" + } + } + }, + "TossPaymentMethodEnum": { + "oneOf": [ + { + "const": "CARD" + }, + { + "const": "VIRTUAL_ACCOUNT" + }, + { + "const": "MOBILE" + }, + { + "const": "KAKAO_PAY" + }, + { + "const": "TOSS_PAY" + }, + { + "const": "APPLE_PAY" + } + ] + }, + "TossPaymentMaterialDto": { + "type": "object", + "required": [ + "clientKey", + "amount", + "payMethod", + "merchantId", + "title", + "successUrl", + "failUrl", + "customerMobilePhone" + ], + "properties": { + "clientKey": { + "type": "string" + }, + "amount": { + "type": "integer", + "format": "int64" + }, + "payMethod": { + "type": "string" + }, + "merchantId": { + "type": "string" + }, + "title": { + "type": "string" + }, + "successUrl": { + "type": "string" + }, + "failUrl": { + "type": "string" + }, + "virtualAccountCallbackUrl": { + "type": "string" + }, + "customerName": { + "type": "string" + }, + "customerMobilePhone": { + "type": "string" + } + } + }, + "DryRunPaymentMaterialDto": { + "type": "object", + "required": [ + "merchantId" + ], + "properties": { + "merchantId": { + "type": "string", + "description": "ุชู… ุฅู†ุดุงุก ู…ุนุฑู ุงู„ุชุงุฌุฑ ู„ู‡ุฐู‡ ุงู„ุฏูุนุฉ" + } + } + }, + "FreePaymentMaterialDto": { + "type": "object", + "required": [ + "merchantId" + ], + "properties": { + "merchantId": { + "type": "string", + "description": "ุชู… ุฅู†ุดุงุก ู…ุนุฑู ุงู„ุชุงุฌุฑ ู„ู‡ุฐู‡ ุงู„ุฏูุนุฉ" + } + } + }, + "OLCEstimationRequestDto": { + "type": "object", + "required": [ + "partials" + ], + "properties": { + "partials": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartialOrderItemDto" + } + } + } + }, + "PartialOrderItemDto": { + "type": "object", + "required": [ + "orderItemId", + "quantity" + ], + "properties": { + "orderItemId": { + "type": "string" + }, + "quantity": { + "type": "integer", + "format": "int64" + } + } + }, + "OrderItemPurchaseStateEnum": { + "oneOf": [ + { + "const": "WAIT" + }, + { + "const": "PAID" + }, + { + "const": "REFUNDED" + } + ] + }, + "ProductSearchingOrderByEnum": { + "oneOf": [ + { + "const": "MATCHING_SCORE_DESC" + }, + { + "const": "POPULARITY" + }, + { + "const": "RATING_DESC" + }, + { + "const": "FINAL_PRICE_DESC" + }, + { + "const": "FINAL_PRICE_ASC" + }, + { + "const": "DISCOUNT_PERCENTAGE_DESC" + }, + { + "const": "REVIEW_COUNT_DESC" + }, + { + "const": "REVIEW_RATING_AVG_DESC" + }, + { + "const": "CREATED_AT_DESC" + } + ] + }, + "OrderHistoryListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "MyOrderHistoryListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MyOrderHistoryDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "MyOrderHistoryDto": { + "type": "object", + "properties": { + "orderSummary": { + "$ref": "#/components/schemas/MyOrderSummaryDto" + }, + "deliveryRequest": { + "$ref": "#/components/schemas/DeliveryRequestDto" + }, + "purchaseResult": { + "$ref": "#/components/schemas/PurchaseResultDto" + } + } + }, + "OrderHistoryDto": { + "type": "object", + "required": [ + "orderSummary", + "deliveryRequest", + "purchaseResult" + ], + "properties": { + "orderSummary": { + "$ref": "#/components/schemas/OrderSummaryDto" + }, + "deliveryRequest": { + "$ref": "#/components/schemas/DeliveryRequestDto" + }, + "purchaseResult": { + "$ref": "#/components/schemas/PurchaseResultDto" + } + } + }, + "MyOrderLineTicketListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MyOrderLineTicketDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "MyOrderLineTicketDto": { + "type": "object", + "required": [ + "ticketType", + "createdAtMillis" + ], + "properties": { + "ticketType": { + "$ref": "#/components/schemas/OrderLineTicketEnum" + }, + "returnTicket": { + "$ref": "#/components/schemas/OrderLineReturnTicketWithOrderDto" + }, + "cancelTicket": { + "$ref": "#/components/schemas/OrderLineCancelTicketWithOrderDto" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + } + } + }, + "MyOLTicketsCountDto": { + "type": "object", + "required": [ + "cancelTicket", + "returnTicket" + ], + "properties": { + "cancelTicket": { + "$ref": "#/components/schemas/OrderLineTicketCountDto" + }, + "returnTicket": { + "$ref": "#/components/schemas/OrderLineTicketCountDto" + } + } + }, + "OrderLineTicketCountDto": { + "type": "object", + "required": [ + "inProgress", + "resolved" + ], + "properties": { + "inProgress": { + "description": "ุนุฏุฏ ุงู„ุชุฐุงูƒุฑ ู‚ูŠุฏ ุงู„ุชู‚ุฏู… (ุงู„ู…ุฑุชุฌุนุฉ ุฃูˆ ุงู„ู…ู„ุบุงุฉ)", + "type": "integer", + "format": "int32" + }, + "resolved": { + "description": "ุนุฏุฏ ุงู„ุชุฐุงูƒุฑ ุงู„ู…ูƒุชู…ู„ุฉ (ุงู„ู…ุฑุชุฌุนุฉ ุฃูˆ ุงู„ู…ู„ุบุงุฉ) ุฎู„ุงู„ ุขุฎุฑ 4 ุฃูŠุงู…", + "type": "integer", + "format": "int32" + } + } + }, + "DeliveryRequestDto": { + "type": "object", + "required": [ + "address" + ], + "properties": { + "address": { + "$ref": "#/components/schemas/DeliveryAddressDto" + }, + "request": { + "type": "string" + } + } + }, + "PurchaseResultDto": { + "type": "object", + "required": [ + "paymentId", + "payemntVendor", + "paymentMethod", + "paidAmount", + "refundedAmount", + "purchaseState" + ], + "properties": { + "paymentId": { + "type": "string" + }, + "paymentVendor": { + "type": "string" + }, + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethodEnum" + }, + "virtualAccount": { + "$ref": "#/components/schemas/VirtualAccountDto" + }, + "card": { + "$ref": "#/components/schemas/CardDto" + }, + "paidAmount": { + "type": "integer", + "format": "int64" + }, + "refundedAmount": { + "type": "integer", + "format": "int64" + }, + "purchaseState": { + "$ref": "#/components/schemas/PurchaseStateEnum" + }, + "completedAtMillis": { + "type": "integer", + "format": "int64" + } + } + }, + "VirtualAccountDto": { + "type": "object", + "required": [ + "accountNumber", + "bank", + "customerName" + ], + "properties": { + "accountNumber": { + "type": "string" + }, + "bank": { + "type": "string" + }, + "customerName": { + "type": "string" + }, + "dueDateMillis": { + "type": "integer", + "format": "int64" + } + } + }, + "CardDto": { + "type": "object", + "required": [ + "companyName" + ], + "properties": { + "companyName": { + "description": "ุดุฑูƒุงุช ุงู„ุจุทุงู‚ุงุช (ู…ุซู„ HanaุŒ ShinhanุŒ BC Card)", + "type": "string" + }, + "installmentPlanMonths": { + "description": "ุนุฏุฏ ุฃุดู‡ุฑ ุงู„ู‚ุณุท (ุฅุฐุง ูƒุงู† 0ุŒ ุฏูุนุฉ ู…ู‚ุทูˆุนุฉ)", + "minimum": 0, + "format": "int32", + "type": "integer" + }, + "interestFreeInstallment": { + "description": "ุฎุทุฉ ุงู„ุชู‚ุณูŠุท ุจุฏูˆู† ููˆุงุฆุฏ", + "type": "boolean" + } + } + }, + "PaymentMethodEnum": { + "oneOf": [ + { + "const": "CARD" + }, + { + "const": "ACCOUNT_TRANSFER" + }, + { + "const": "KAKAO_PAY" + }, + { + "const": "NAVER_PAY" + }, + { + "const": "TOSS_PAY" + }, + { + "const": "VIRTUAL_ACCOUNT" + }, + { + "const": "DRY" + }, + { + "const": "MOBILE" + }, + { + "const": "FREE" + }, + { + "const": "APPLE_PAY" + } + ] + }, + "RefundPaymentMethodEnum": { + "oneOf": [ + { + "const": "CARD" + }, + { + "const": "ACCOUNT_TRANSFER" + }, + { + "const": "KAKAO_PAY" + }, + { + "const": "NAVER_PAY" + }, + { + "const": "TOSS_PAY" + }, + { + "const": "VIRTUAL_ACCOUNT" + }, + { + "const": "DRY" + }, + { + "const": "MOBILE" + }, + { + "const": "FREE" + }, + { + "const": "APPLE_PAY" + }, + { + "const": "POINT" + } + ] + }, + "RefundPaymentVendorEnum": { + "oneOf": [ + { + "const": "IAMPORT" + }, + { + "const": "TOSS_PAYMENTS" + }, + { + "const": "DRY_RUN" + }, + { + "const": "CONNECT_PAY" + }, + { + "const": "FREE" + } + ] + }, + "PurchaseStateEnum": { + "oneOf": [ + { + "const": "WAIT" + }, + { + "const": "WAITING_FOR_DEPOSIT" + }, + { + "const": "COMPLETED" + }, + { + "const": "ABORTED" + } + ] + }, + "MyOrderSummaryDto": {}, + "OrderSummaryDto": { + "type": "object", + "properties": { + "totalProductPrice": { + "type": "integer", + "format": "int64" + }, + "totalDeliveryPrice": { + "type": "integer", + "format": "int64" + }, + "serviceCharge": { + "type": "integer", + "format": "int64" + }, + "discountAmount": { + "type": "integer", + "format": "int64" + }, + "finalPurchaseAmount": { + "type": "integer", + "format": "int64" + }, + "usePoint": { + "type": "integer", + "format": "int64" + }, + "id": { + "type": "string", + "description": "(ู…ู‡ู…ู„) ุงุณุชุฎุฏู… orderId" + }, + "orderId": { + "type": "string" + }, + "costElements": { + "type": "array", + "description": "- ุญู‚ู„ ู„ู„ุชุนุจูŠุฑ ุนู† ุชูุงุตูŠู„ ุฃุณุนุงุฑ PriceSetDto - ุณูˆู ู†ุชูˆุณุน ุชุฏุฑูŠุฌูŠู‹ุงุŒ ูˆู„ูƒู†ู†ุง ู†ุนุฑุถ ุญุงู„ูŠู‹ุง ู…ุนู„ูˆู…ุงุช ู…ูุตู„ุฉ ุญูˆู„ ุชูƒุงู„ูŠู ุงู„ุดุญู† ูู‚ุท..", + "items": { + "$ref": "#/components/schemas/CostElementDto" + } + }, + "appliedCouponCode": { + "type": "string", + "description": "ุงู„ูˆุตูˆู„ ุฅู„ูŠู‡ ู…ู† ุฎู„ุงู„ ApplyCoupon.coupon.code.", + "deprecated": true + }, + "appliedCoupon": { + "$ref": "#/components/schemas/IssuedCouponDto" + }, + "itemGroups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderItemGroupDto" + } + }, + "confirmedAtMillis": { + "type": "integer", + "format": "int64" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + } + } + }, + "PriceSetDeltaDto": { + "type": "object", + "required": [ + "totalProductPrice", + "totalDeliveryPrice", + "serviceCharge", + "discountAmount", + "finalPurchaseAmount" + ], + "properties": { + "totalProductPrice": { + "type": "integer", + "format": "int64" + }, + "totalDeliveryPrice": { + "type": "integer", + "format": "int64" + }, + "serviceCharge": { + "type": "integer", + "format": "int64" + }, + "discountAmount": { + "type": "integer", + "format": "int64" + }, + "finalPurchaseAmount": { + "type": "integer", + "format": "int64" + }, + "usePoint": { + "type": "integer", + "format": "int64" + }, + "costElements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CostElementDto" + } + } + } + }, + "DeliveryPriceDto": { + "type": "object", + "required": [ + "normal", + "jeju", + "backCountry" + ], + "properties": { + "normal": { + "type": "integer", + "format": "int64" + }, + "jeju": { + "type": "integer", + "format": "int64" + }, + "backCountry": { + "type": "integer", + "format": "int64" + } + } + }, + "PriceSetDto": { + "type": "object", + "required": [ + "totalProductPrice", + "totalDeliveryPrice", + "serviceCharge", + "discountAmount", + "finalPurchaseAmount" + ], + "properties": { + "totalProductPrice": { + "type": "integer", + "format": "int64" + }, + "totalDeliveryPrice": { + "type": "integer", + "format": "int64" + }, + "serviceCharge": { + "type": "integer", + "format": "int64" + }, + "discountAmount": { + "type": "integer", + "format": "int64" + }, + "finalPurchaseAmount": { + "type": "integer", + "format": "int64" + }, + "usePoint": { + "type": "integer", + "format": "int64" + } + } + }, + "MyOrderItemGroupDto": { + "type": "object", + "properties": { + "groupId": { + "type": "string" + }, + "mall": { + "$ref": "#/components/schemas/MallDto" + }, + "brand": { + "$ref": "#/components/schemas/BrandDto" + }, + "costElements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CostElementDto" + } + }, + "deliveryPrice": { + "type": "integer", + "format": "int64" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MyOrderItemDto" + } + } + } + }, + "OrderItemGroupDto": { + "type": "object", + "required": [ + "groupId", + "mall", + "brand", + "deliveryPrice", + "items" + ], + "properties": { + "groupId": { + "type": "string" + }, + "mall": { + "$ref": "#/components/schemas/MallDto" + }, + "brand": { + "$ref": "#/components/schemas/BrandDto" + }, + "costElements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CostElementDto" + } + }, + "deliveryPrice": { + "type": "integer", + "format": "int64" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderItemDto" + } + } + } + }, + "CostElementDto": { + "type": "object", + "required": [ + "type", + "amount" + ], + "description": "- DTO ูŠุนุจุฑ ุนู† ู…ุนู„ูˆู…ุงุช ู…ูุตู„ุฉ ุนู† ุงู„ุฃุณุนุงุฑ - ุญุงู„ูŠู‹ุงุŒ ุชูˆุฌุฏ ู…ุนู„ูˆู…ุงุช ู…ูุตู„ุฉ ูู‚ุท ุนู† ุชูƒุงู„ูŠู ุงู„ุดุญู† ูˆุงู„ุฅุฑุฌุงุน.", + "properties": { + "type": { + "$ref": "#/components/schemas/CostTypeEnum" + }, + "amount": { + "type": "integer", + "format": "int64" + } + } + }, + "CostTypeEnum": { + "oneOf": [ + { + "const": "SHIPPING_COST_NORMAL" + }, + { + "const": "SHIPPING_COST_JEJU" + }, + { + "const": "SHIPPING_COST_BACK_COUNTRY" + }, + { + "const": "RETURN_COST_NORMAL" + }, + { + "const": "RETURN_COST_JEJU" + }, + { + "const": "RETURN_COST_BACK_COUNTRY" + }, + { + "const": "RETURN_COST_TO_REFUND_FREE_SHIPPING" + } + ] + }, + "MyOrderItemDto": {}, + "DividedOrderItemDto": {}, + "EachOLCEstimationDto": { + "required": [ + "orderItemId", + "quantity", + "totalProductPrice", + "totalDiscountAmount", + "finalPurchaseAmount", + "usePoint" + ], + "properties": { + "orderItemId": { + "type": "string" + }, + "totalProductPrice": { + "type": "integer", + "format": "int64" + }, + "finalPurchaseAmount": { + "type": "integer", + "format": "int64" + }, + "totalDiscountAmount": { + "type": "integer", + "format": "int64" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "usePoint": { + "type": "integer", + "format": "int64" + } + } + }, + "EachOLREstimationDto": { + "required": [ + "orderItemId", + "quantity", + "totalProductPrice", + "totalDiscountAmount", + "finalPurchaseAmount", + "usePoint" + ], + "properties": { + "orderItemId": { + "type": "string" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "totalProductPrice": { + "type": "integer", + "format": "int64" + }, + "finalPurchaseAmount": { + "type": "integer", + "format": "int64" + }, + "totalDiscountAmount": { + "type": "integer", + "format": "int64" + }, + "usePoint": { + "type": "integer", + "format": "int64" + } + } + }, + "OrderItemDto": { + "required": [ + "id", + "product", + "productItem", + "singlePrice", + "quantity", + "singleDirectDiscountAmount", + "totalPrice", + "state", + "purchaseState", + "delivery", + "totalProductPrice", + "finalPurchaseAmount", + "totalDiscountAmount", + "totalDirectDiscountAmount", + "brand", + "receiptConfirmation", + "finalSinglePrice", + "freeReturnTarget" + ], + "properties": { + "id": { + "type": "string" + }, + "product": { + "$ref": "#/components/schemas/ProductDto" + }, + "productItem": { + "$ref": "#/components/schemas/ProductItemDto" + }, + "singlePrice": { + "description": "ุณุนุฑ ุงู„ู…ู†ุชุฌ (ู„ุง ูŠุธู‡ุฑ ุงู„ุฎุตู… ุงู„ููˆุฑูŠ ููŠ Queen It)", + "type": "integer", + "format": "int64" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "singleDirectDiscountAmount": { + "description": "ูƒูˆูŠู† ุฅุช ุฎุตู… ููˆุฑูŠ", + "type": "integer", + "format": "int64" + }, + "totalPrice": { + "description": "(ู…ู‡ู…ู„) ุงุณุชุฎุฏู… "totalProductPrice" ุจุฏู„ุงู‹ ู…ู† ุฐู„ูƒ.", + "type": "integer", + "format": "int64" + }, + "totalProductPrice": { + "description": "ุฅุฌู…ุงู„ูŠ ุณุนุฑ ุงู„ู…ู†ุชุฌ (((singlePrice - SingleDirectDiscountAmount) * ุงู„ูƒู…ูŠุฉ`)", + "type": "integer", + "format": "int64" + }, + "finalPurchaseAmount": { + "description": "ู…ุจู„ุบ ุงู„ุฏูุน ุงู„ูุนู„ูŠ (`totalProductPrice - TotalDiscountAmount - usePoint`)", + "type": "integer", + "format": "int64" + }, + "usePoint": { + "description": "ู†ู‚ุงุท ุงู„ุงุณุชุฎุฏุงู…", + "type": "integer", + "format": "int64" + }, + "totalDiscountAmount": { + "description": "ุฅุฌู…ุงู„ูŠ ู…ุจู„ุบ ุงู„ุฎุตู… ุนู„ู‰ ู‚ุณูŠู…ุฉ ุนุฑุจุฉ ุงู„ุชุณูˆู‚ (`singleDiscountAmount * ุงู„ูƒู…ูŠุฉ + ResideDiscountAmount`)", + "type": "integer", + "format": "int64" + }, + "totalDirectDiscountAmount": { + "description": "ุฅุฌู…ุงู„ูŠ ู…ุจู„ุบ ุงู„ุฎุตู… ุงู„ููˆุฑูŠ ู„ู€ Queen It (`singleDirectDiscountAmount * ุงู„ูƒู…ูŠุฉ`)", + "type": "integer", + "format": "int64" + }, + "finalSinglePrice": { + "description": "ุณุนุฑ ุงู„ู…ู†ุชุฌ (`ุงู„ุณุนุฑ ุงู„ูุฑุฏูŠ - SingleDirectDiscountAmount`)", + "type": "integer", + "format": "int64" + }, + "state": { + "$ref": "#/components/schemas/OrderStateEnum" + }, + "purchaseState": { + "$ref": "#/components/schemas/OrderItemPurchaseStateEnum" + }, + "delivery": { + "$ref": "#/components/schemas/DeliveryProgressDto" + }, + "primaryCancelTicket": { + "$ref": "#/components/schemas/OLCTicketDto" + }, + "primaryReturnTicket": { + "$ref": "#/components/schemas/OLRTicketDto" + }, + "brand": { + "$ref": "#/components/schemas/BrandDto" + }, + "receiptConfirmation": { + "type": "boolean" + }, + "receiptConfirmedAtMillis": { + "type": "integer", + "format": "int64" + }, + "freeReturnTarget": { + "type": "boolean" + } + } + }, + "DeliveryProgressDto": { + "type": "object", + "required": [ + "state" + ], + "properties": { + "vendorName": { + "type": "string" + }, + "vendorDeliveryNumber": { + "type": "string" + }, + "detailUrl": { + "type": "string" + }, + "state": { + "$ref": "#/components/schemas/DeliveryStateEnum" + }, + "shippedAtMillis": { + "description": "ู‡ุฐุง ู‡ูˆ ุนู†ุฏู…ุง ุชู… ุดุญู† ุงู„ุทู„ุจ. ูŠุนู†ูŠ ุญุงู„ูŠุง ุชุบูŠูŠุฑ ูˆู‚ุช ุงู„ุชุณู„ูŠู….", + "type": "integer", + "format": "int64" + } + } + }, + "DeliveryStateEnum": { + "oneOf": [ + { + "const": "WAIT" + }, + { + "const": "PREPARING" + }, + { + "const": "IN_DELIVERY" + }, + { + "const": "COMPLETED" + }, + { + "const": "CANCELLED" + } + ] + }, + "OrderByEnum": { + "oneOf": [ + { + "const": "ASC" + }, + { + "const": "DESC" + } + ] + }, + "ProductOrderByEnum": { + "oneOf": [ + { + "const": "RECOMMENDATION" + }, + { + "const": "POPULARITY" + }, + { + "const": "CREATED_AT_DESC" + }, + { + "const": "FINAL_PRICE_DESC" + }, + { + "const": "FINAL_PRICE_ASC" + }, + { + "const": "DISCOUNT_PERCENTAGE_DESC" + }, + { + "const": "REVIEW_COUNT_DESC" + }, + { + "const": "REVIEW_RATING_AVG_DESC" + } + ] + }, + "OrderStateEnum": { + "oneOf": [ + { + "const": "WAIT" + }, + { + "const": "PURCHASED" + }, + { + "const": "REFUNDED" + }, + { + "const": "PREPARING_PRODUCTS" + }, + { + "const": "IN_DELIVERY" + }, + { + "const": "DELIVERY_COMPLETED" + }, + { + "const": "ABORTED" + } + ] + }, + "OrderLineTicketStateEnum": { + "oneOf": [ + { + "const": "SUBMITTED" + }, + { + "const": "CONFIRMED" + }, + { + "const": "RESOLVED" + }, + { + "const": "WITHDRAWN" + }, + { + "const": "REJECTED" + } + ], + "description": "ุญุงู„ุฉ ุทู„ุจ ุงู„ุฅู„ุบุงุก (ุงู„ุฅุฑุฌุงุน) - ุชู… ุงู„ุชู‚ุฏูŠู…: ุทู„ุจ ุงู„ุฅู„ุบุงุก (ุงู„ุฅุฑุฌุงุน) - ู…ุคูƒุฏ: ุชู…ุช ุงู„ู…ูˆุงูู‚ุฉ ุนู„ู‰ ุทู„ุจ ุงู„ุฅู„ุบุงุก (ุงู„ุฅุฑุฌุงุน) (ุงู„ู…ุนุงู„ุฌุฉ ู‚ูŠุฏ ุงู„ุชู‚ุฏู…) - ุชู… ุงู„ุญู„: ุชู… ุฅุบู„ุงู‚ ุทู„ุจ ุงู„ุฅู„ุบุงุก (ุงู„ุฅุฑุฌุงุน) (ุชู… ุฑุฏ ุงู„ู…ุจู„ุบ ุฅู„ู‰ ุงู„ุนู…ูŠู„) - ุชู… ุงู„ุณุญุจ: ูŠุณุญุจ ุงู„ุนู…ูŠู„ ุงู„ุฅู„ุบุงุก ( ุทู„ุจ ุงู„ุฅุฑุฌุงุน) - ู…ุฑููˆุถ: ุชู… ุฑูุถ ุทู„ุจ ุงู„ุฅู„ุบุงุก (ุงู„ุฅุฑุฌุงุน) ู…ู† ู‚ุจู„ ุงู„ุจุงุฆุน/ุงู„ู…ุณุคูˆู„" + }, + "OrderLineReturnStateEnum": { + "oneOf": [ + { + "const": "WAITING" + }, + { + "const": "IN_RECALL_DELIVERY_READY" + }, + { + "const": "IN_RECALL_DELIVERY_PROCESSING" + }, + { + "const": "RECALL_DELIVERY_COMPLETED" + }, + { + "const": "REJECTED" + }, + { + "const": "RESOLVED" + }, + { + "const": "WITHDRAWN" + } + ], + "description": "ุญุงู„ุฉ ุทู„ุจ ุงู„ุฅุฑุฌุงุน - ุงู„ุงู†ุชุธุงุฑ: ุงู„ุญุงู„ุฉ ุงู„ุชูŠ ูŠุทู„ุจ ููŠู‡ุง ุงู„ุนู…ูŠู„ ุงู„ุฅุฑุฌุงุน ูˆูŠู†ุชุธุฑ ุงู„ู…ูˆุงูู‚ุฉ ู…ู† ุงู„ุจุงุฆุน/ุงู„ู…ุณุคูˆู„ - IN_RECALL_DELIVERY_READY: (ูู‚ุท ุนู†ุฏ ุงู„ุงุฑุชุจุงุท ุจู€ Goodsflow) ุจุนุฏ ุงู„ู…ูˆุงูู‚ุฉุŒ ุงู„ุงุณุชุนุฏุงุฏ ู„ู„ุชุฌู…ูŠุน - IN_RECALL_DELIVERY_PROCESSING: (ุฅุฐุง ูƒุงู† ู…ุฑุชุจุทู‹ุง ุจู€ Goodsflow ) ุณุงุฆู‚ ุงู„ุชูˆุตูŠู„ ุจุนุฏ ุงุณุชู„ุงู…ู‡ ูˆุชุณู„ูŠู…ู‡ุŒ ูŠุชู… ุฅุนุงุฏุชู‡ ุฅู„ู‰ ุนู†ูˆุงู† ุงู„ุฅุฑุฌุงุน. (ุฅุฐุง ู„ู… ูŠูƒู† ู…ุฑุชุจุทู‹ุง ุจู€ GoodsflowุŒ ูุณูŠุชู… ุชุญุตูŠู„ู‡ ุจูˆุงุณุทุฉ ุงู„ุจุงุฆุน) - RECALL_DELIVERY_COMPLETED: (ูู‚ุท ุฅุฐุง ูƒุงู† ู…ุฑุชุจุทู‹ุง ุจู€ Goodsflow) ุชู… ุชุณู„ูŠู… ุนู†ุตุฑ ุงู„ุชุญุตูŠู„ (ู‚ูŠุฏ ุงู„ู…ุฑุงุฌุนุฉ) - ู…ุฑููˆุถ: ุชู… ุฅุบู„ุงู‚ ุทู„ุจ ุงู„ุฅุฑุฌุงุน (ุชู… ุฑูุถ ุทู„ุจ ุงู„ุฅุฑุฌุงุน ู…ู† ู‚ุจู„ ุงู„ุจุงุฆุน) /administrator) - ุชู… ุงู„ุญู„: ุชู… ุฅุบู„ุงู‚ ุทู„ุจ ุงู„ุฅุฑุฌุงุน (ุงู„ู…ุจู„ุบ ุงู„ู…ุณุชุฑุฏ ู„ู„ุนู…ูŠู„) - ุงู„ุณุญุจ: ูŠู†ุณุญุจ ุงู„ุนู…ูŠู„ ุจุนุฏ ุทู„ุจ ุงู„ุฅุฑุฌุงุน" + }, + "OrderLineTicketEnum": { + "oneOf": [ + { + "const": "CANCEL" + }, + { + "const": "RETURN" + } + ], + "description": "- ู†ูˆุน ุชุฐูƒุฑุฉ ุงู„ุทู„ุจ - ุงู„ุฅู„ุบุงุก: ุงู„ุฅู„ุบุงุก - ุงู„ุนูˆุฏุฉ: ุงู„ุนูˆุฏุฉ" + }, + "AuditorGroupEnum": { + "oneOf": [ + { + "const": "SYSTEM" + }, + { + "const": "CX_ADMIN" + }, + { + "const": "SELLER_ADMIN" + }, + { + "const": "USER" + } + ], + "description": "ูˆุญุฏุฉ ุงู„ูƒูŠุงู† ุงู„ุชูŠ ุบูŠุฑุช ุญุงู„ุฉ ุงู„ุชุฐูƒุฑุฉ - ุงู„ู†ุธุงู…: ุชู… ุชุบูŠูŠุฑ ุงู„ุญุงู„ุฉ ุชู„ู‚ุงุฆูŠู‹ุง ุจูˆุงุณุทุฉ ุงู„ู†ุธุงู… - CX_ADMIN: ุชู… ุชุบูŠูŠุฑ ุงู„ุญุงู„ุฉ ุจูˆุงุณุทุฉ ูุฑูŠู‚ CX - SELLER_ADMIN: ุชู… ุชุบูŠูŠุฑ ุงู„ุญุงู„ุฉ ุจูˆุงุณุทุฉ ุงู„ุจุงุฆุน - ุงู„ู…ุณุชุฎุฏู…: ุชู… ุชุบูŠูŠุฑ ุงู„ุญุงู„ุฉ ุจูˆุงุณุทุฉ ุงู„ุนู…ูŠู„" + }, + "OLCEstimationDto": { + "type": "object", + "required": [ + "priceDelta" + ], + "properties": { + "orderItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderItemDto" + } + }, + "priceDelta": { + "$ref": "#/components/schemas/PriceSetDeltaDto" + } + } + }, + "OLCEstimationResultDto": { + "type": "object", + "required": [ + "priceDelta", + "eachEstimations" + ], + "properties": { + "eachEstimations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EachOLCEstimationDto" + } + }, + "priceDelta": { + "$ref": "#/components/schemas/PriceSetDeltaDto" + }, + "refundPaymentInfos": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RefundPaymentInfoDto" + } + } + } + }, + "OLCRequestDto": { + "type": "object", + "required": [ + "partials", + "reason" + ], + "properties": { + "partials": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartialOrderItemDto" + } + }, + "reason": { + "type": "string" + } + } + }, + "OLCTicketDto": { + "type": "object", + "required": [ + "ticketId", + "state", + "reason", + "createdAtMillis", + "orderItems" + ], + "properties": { + "ticketId": { + "type": "string" + }, + "state": { + "$ref": "#/components/schemas/OrderLineTicketStateEnum" + }, + "auditorGroup": { + "$ref": "#/components/schemas/AuditorGroupEnum" + }, + "reason": { + "type": "string" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + }, + "confirmedAtMillis": { + "type": "integer", + "format": "int64" + }, + "withdrawnAtMillis": { + "type": "integer", + "format": "int64" + }, + "rejectedAtMillis": { + "type": "integer", + "format": "int64" + }, + "rejectReason": { + "type": "string" + }, + "resolvedAtMillis": { + "type": "integer", + "format": "int64" + }, + "resolvedPriceDelta": { + "$ref": "#/components/schemas/PriceSetDeltaDto" + }, + "refundPaymentInfos": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RefundPaymentInfoDto" + } + }, + "orderItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderItemDto" + } + } + } + }, + "OrderLineCancelTicketWithOrderDto": { + "type": "object", + "properties": { + "ticketId": { + "type": "string" + }, + "state": { + "$ref": "#/components/schemas/OrderLineTicketStateEnum" + }, + "auditorGroup": { + "$ref": "#/components/schemas/AuditorGroupEnum" + }, + "reason": { + "type": "string" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + }, + "confirmedAtMillis": { + "type": "integer", + "format": "int64" + }, + "withdrawnAtMillis": { + "type": "integer", + "format": "int64" + }, + "rejectedAtMillis": { + "type": "integer", + "format": "int64" + }, + "rejectReason": { + "type": "string" + }, + "resolvedAtMillis": { + "type": "integer", + "format": "int64" + }, + "resolvedPriceDelta": { + "$ref": "#/components/schemas/PriceSetDeltaDto" + }, + "refundPaymentInfos": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RefundPaymentInfoDto" + } + }, + "orderItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderItemDto" + } + }, + "linkedOrder": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + }, + "OLREstimateRequestDto": { + "type": "object", + "required": [ + "isCustomerNegligence", + "partials" + ], + "properties": { + "isCustomerNegligence": { + "type": "boolean" + }, + "partials": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartialOrderItemDto" + } + } + } + }, + "OLREstimationResultDto": { + "type": "object", + "required": [ + "priceDelta", + "eachEstimations" + ], + "properties": { + "eachEstimations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EachOLREstimationDto" + } + }, + "priceDelta": { + "$ref": "#/components/schemas/PriceSetDeltaDto" + }, + "refundPaymentInfos": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RefundPaymentInfoDto" + } + } + } + }, + "OLRRequestDto": { + "type": "object", + "required": [ + "partials", + "isCustomerNegligence", + "returnAddress", + "reason" + ], + "properties": { + "partials": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartialOrderItemDto" + } + }, + "isCustomerNegligence": { + "type": "boolean" + }, + "returnAddress": { + "$ref": "#/components/schemas/DeliveryAddressDto" + }, + "reason": { + "type": "string" + }, + "imageUrls": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "OLRTicketDto": { + "type": "object", + "required": [ + "ticketId", + "state", + "returnState", + "isCustomerNegligence", + "returnAddress", + "reason", + "createdAtMillis", + "orderItems" + ], + "properties": { + "ticketId": { + "type": "string" + }, + "isCustomerNegligence": { + "type": "boolean" + }, + "returnAddress": { + "$ref": "#/components/schemas/DeliveryAddressDto" + }, + "state": { + "$ref": "#/components/schemas/OrderLineTicketStateEnum" + }, + "returnState": { + "$ref": "#/components/schemas/OrderLineReturnStateEnum" + }, + "auditorGroup": { + "$ref": "#/components/schemas/AuditorGroupEnum" + }, + "reason": { + "type": "string" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + }, + "confirmedAtMillis": { + "type": "integer", + "format": "int64" + }, + "withdrawnAtMillis": { + "type": "integer", + "format": "int64" + }, + "rejectedAtMillis": { + "type": "integer", + "format": "int64" + }, + "rejectReason": { + "type": "string" + }, + "resolvedAtMillis": { + "type": "integer", + "format": "int64" + }, + "resolvedPriceDelta": { + "$ref": "#/components/schemas/PriceSetDeltaDto" + }, + "refundPaymentInfos": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RefundPaymentInfoDto" + } + }, + "orderItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderItemDto" + } + }, + "imageUrls": { + "type": "array", + "description": "ุนู†ุงูˆูŠู† URL ู„ู„ุตูˆุฑุฉ ุงู„ุฃุตู„ูŠุฉ", + "items": { + "type": "string" + } + }, + "multiResolutionImages": { + "$ref": "#/components/schemas/MultiResolutionImageListDto" + }, + "recallDeliveryProgress": { + "$ref": "#/components/schemas/OLRTRecallDeliveryProgressDto" + } + } + }, + "OLRTRecallDeliveryProgressDto": { + "type": "object", + "description": "ุฅุฐุง ูƒุงู† ุฎุงู„ูŠู‹ุงุŒ ูู‡ูˆ ู„ูŠุณ ู…ู†ุชุฌู‹ุง ู…ุฑุชุจุทู‹ุง ุจู…ุฌู…ูˆุนุฉ GoodsFlow.", + "properties": { + "recallDeliveryVendor": { + "$ref": "#/components/schemas/DeliveryVendorEnum" + }, + "recallDeliveryVendorNumber": { + "description": "ุฑู‚ู… ุงู„ูุงุชูˆุฑุฉ", + "type": "string" + }, + "requestable": { + "description": "ู‡ู„ ู…ู† ุงู„ู…ู…ูƒู† ุทู„ุจ ุฅุนุงุฏุฉ ุงู„ุชุญุตูŠู„ุŸ", + "type": "boolean" + }, + "recallState": { + "$ref": "#/components/schemas/RecallDeliveryStateEnum" + }, + "recallDeliveryCompletedAtMillis": { + "description": "ุชุงุฑูŠุฎ ุงูƒุชู…ุงู„ ุงู„ุงุณุชุฑุฏุงุฏ", + "type": "integer", + "format": "int64" + }, + "recallDeliveryTraceUrl": { + "description": "ุนู†ูˆุงู† URL ู„ุชุชุจุน ุงู„ุงุณุชุฑุฏุงุฏ", + "type": "string" + } + } + }, + "OrderLineReturnTicketWithOrderDto": { + "type": "object", + "properties": { + "ticketId": { + "type": "string" + }, + "isCustomerNegligence": { + "type": "boolean" + }, + "returnAddress": { + "$ref": "#/components/schemas/DeliveryAddressDto" + }, + "state": { + "$ref": "#/components/schemas/OrderLineTicketStateEnum" + }, + "returnState": { + "$ref": "#/components/schemas/OrderLineReturnStateEnum" + }, + "auditorGroup": { + "$ref": "#/components/schemas/AuditorGroupEnum" + }, + "reason": { + "type": "string" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + }, + "confirmedAtMillis": { + "type": "integer", + "format": "int64" + }, + "withdrawnAtMillis": { + "type": "integer", + "format": "int64" + }, + "rejectedAtMillis": { + "type": "integer", + "format": "int64" + }, + "rejectReason": { + "type": "string" + }, + "resolvedAtMillis": { + "type": "integer", + "format": "int64" + }, + "resolvedPriceDelta": { + "$ref": "#/components/schemas/PriceSetDeltaDto" + }, + "refundPaymentInfos": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RefundPaymentInfoDto" + } + }, + "orderItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderItemDto" + } + }, + "imageUrls": { + "type": "array", + "description": "ุนู†ุงูˆูŠู† URL ู„ู„ุตูˆุฑุฉ ุงู„ุฃุตู„ูŠุฉ", + "items": { + "type": "string" + } + }, + "multiResolutionImages": { + "$ref": "#/components/schemas/MultiResolutionImageListDto" + }, + "recallDeliveryProgress": { + "$ref": "#/components/schemas/OLRTRecallDeliveryProgressDto" + }, + "linkedOrder": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + }, + "RefundPaymentInfoDto": { + "type": "object", + "description": "ุทุฑูŠู‚ุฉ ุฏูุน ุงุณุชุฑุฏุงุฏ ุงู„ุฃู…ูˆุงู„", + "required": [ + "paymentMethod" + ], + "properties": { + "paymentMethod": { + "$ref": "#/components/schemas/RefundPaymentMethodEnum" + }, + "paymentVendor": { + "$ref": "#/components/schemas/RefundPaymentVendorEnum" + }, + "detail": { + "description": "ูˆุตู ุชูุตูŠู„ูŠ ู„ูƒู„ ุทุฑูŠู‚ุฉ ุฏูุน ู…ุณุชุฑุฏุฉ (ููŠ ุญุงู„ุฉ ุงู„ุฏูุน ุจุงู„ุจุทุงู‚ุฉุŒ ู…ุนู„ูˆู…ุงุช ุดุฑูƒุฉ ุงู„ุจุทุงู‚ุฉ)", + "type": "string" + } + } + }, + "DeliveryVendorEnum": { + "oneOf": [ + { + "const": "CJ_GLS" + }, + { + "const": "LOGEN" + }, + { + "const": "EPOST" + }, + { + "const": "HANJIN" + }, + { + "const": "LOTTE" + }, + { + "const": "DAESIN" + }, + { + "const": "ILYANG" + }, + { + "const": "KYUNGDONG" + }, + { + "const": "HAPDONG" + }, + { + "const": "CHUNIL" + }, + { + "const": "CVSNET" + }, + { + "const": "HPL" + }, + { + "const": "KUNYOUNG" + }, + { + "const": "HONAM" + }, + { + "const": "SLX" + }, + { + "const": "BGF" + }, + { + "const": "YONGMA" + }, + { + "const": "SEBANG" + }, + { + "const": "WONDERS" + }, + { + "const": "NH_LOGIS" + }, + { + "const": "HI_LOGIS" + }, + { + "const": "HOMEPICK" + }, + { + "const": "KOREX_G" + }, + { + "const": "EMS" + }, + { + "const": "LOTTE_GLOBAL" + }, + { + "const": "HANDEX" + }, + { + "const": "DHL" + }, + { + "const": "FEDEX" + }, + { + "const": "UPS" + }, + { + "const": "TNT" + }, + { + "const": "PANTOS" + }, + { + "const": "ACI_EXPRESS" + }, + { + "const": "ACE_EXP" + }, + { + "const": "EUNHA" + }, + { + "const": "CHAIN_LOGISTICS" + }, + { + "const": "LOGISPOT" + }, + { + "const": "VROONG" + }, + { + "const": "ETOMARS" + }, + { + "const": "VENDORPIA" + }, + { + "const": "DAERIM" + }, + { + "const": "VALEX" + }, + { + "const": "ETC" + }, + { + "const": "SELF_MANAGED" + } + ], + "description": "- (ุชุชุนู„ู‚ ุจู…ุนู„ูˆู…ุงุช ุงู„ุทู„ุจ/ุงู„ูุงุชูˆุฑุฉ) ุฎุฏู…ุฉ ุงู„ุชูˆุตูŠู„ ุงู„ุชูŠ ูŠู…ูƒู† ุชุนูŠูŠู†ู‡ุง - `ETC (ุฎุฏู…ุฉ ุชูˆุตูŠู„ ุฃุฎุฑู‰)' -> ุฃู†ุช ุชุณุชุฎุฏู… ุฎุฏู…ุฉ ุชูˆุตูŠู„ ู…ุญุฏุฏุฉุŒ ูˆู„ูƒู† ุฎุฏู…ุฉ ุงู„ุชูˆุตูŠู„ ุบูŠุฑ ู…ุฏุนูˆู…ุฉ ุญุงู„ูŠู‹ุง (ุฅุฐุง ูƒู†ุช ุจุญุงุฌุฉ ุฅู„ู‰ ุฏุนู… ู„ุชูˆุตูŠู„ ุขุฎุฑ ุงู„ุดุฑูƒุงุชุŒ ูŠุฑุฌู‰ ุงู„ุงุชุตุงู„ ุจู†ุง ุจุดูƒู„ ู…ู†ูุตู„) - `ุงู„ุฅุฏุงุฑุฉ ุงู„ุฐุงุชูŠุฉ (ุงู„ุชุณู„ูŠู… ุงู„ู…ุจุงุดุฑ)` -> ุชุณุชุฎุฏู… ููŠ ุญุงู„ุฉ ุงู„ุชุณู„ูŠู… ุงู„ู…ุจุงุดุฑ ## ุดุฑูƒุฉ ุดุญู† ู…ุชุตู„ุฉ ุนู† ุทุฑูŠู‚ ุงู„ุฑู…ุฒ - CJ_GLS # CJ Logistics - LOGEN # Rosen Express - EPOST # ุชุณู„ูŠู… ู…ูƒุชุจ ุงู„ุจุฑูŠุฏ - HANJIN # Hanjin Express - LOTTE # Lotte Express - DAESIN # Daeshin Express - ILYANG # Ilyang Express - KYUNGDONG # Kyungdong Express - HAPDONG # Joint Express - CHUNIL # Cheonil Express - CVSNET # GS Convenience Store Express - HPL # Oriental Love Express - KUNYOUNG # Geonyoung Express - HONAM # Honam Express - SLX # SLX - BGF # CU ุชูˆุตูŠู„ ุงู„ู…ุชุงุฌุฑ ุงู„ุตุบูŠุฑุฉ - YONGMA # Yongma Logis - SEBANG # ุชูˆุตูŠู„ Sebang - WONDERS # Wondersquick - NH_LOGIS # ุชูˆุตูŠู„ Nonghyup - HI_LOGIS # HI ุงู„ุชูˆุตูŠู„ - HOMEPICK # ุชูˆุตูŠู„ Homepick - KOREX_G # CJ Logistics International Express - EMS # EMS - LOTTE_GLOBAL # Lotte Global - HANDEX # HANDEX - DHL # DHL - FEDEX # FEDEX - UPS # UPS - TNT # TNT - PANTOS # Beomhan Pantos - ACI_EXPRESS # ACI Express - ACE_EXP # ACE Express - EUNHA # Eunha Shipping - CHAIN_LOGISTICS # Hair Hero - LOGISPOT # Logispot - VROONG # VROONG - ETOMARS # Etumas - VENDORPIA # Ace Logistics - DAERIM # Daelim Express - VALEX # Valex - ETC # ุดุฑูƒุฉ ุชูˆุตูŠู„ ุฃุฎุฑู‰ - SELF_MANAGED # ุชูˆุตูŠู„ ู…ุจุงุดุฑ" + }, + "RecallDeliveryStateEnum": { + "oneOf": [ + { + "const": "WAIT" + }, + { + "const": "PREPARING" + }, + { + "const": "IN_DELIVERY" + }, + { + "const": "COMPLETED" + }, + { + "const": "CANCELED" + }, + { + "const": "FAILED" + } + ] + }, + "BannerDto": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/BannerTypeEnum" + }, + "categoryId": { + "type": "string" + }, + "brandId": { + "type": "string" + }, + "brandSourcingTagId": { + "type": "string" + }, + "displayProductIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "displayProductCount": { + "type": "integer" + }, + "imageUrl": { + "type": "string" + }, + "linkUrl": { + "type": "string" + }, + "startAtMillis": { + "type": "integer", + "format": "int64" + }, + "endAtMillis": { + "type": "integer", + "format": "int64" + }, + "title": { + "type": "string" + }, + "subTitle": { + "type": "string" + }, + "enabled": { + "description": "(ู…ู‡ู…ู„) ู…ู…ูƒู‘ู†", + "type": "boolean" + }, + "note": { + "description": "(ู…ูˆู‚ูˆู) ู…ู„ุงุญุธุฉ", + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "multiResolutionImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "displayProducts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BannerDisplayProductDto" + } + } + } + }, + "BannerDisplayProductDto": { + "type": "object", + "required": [ + "productId", + "imageUrl", + "finalPrice", + "title", + "brandName", + "discountPercentage" + ], + "properties": { + "productId": { + "type": "string" + }, + "imageUrl": { + "type": "string" + }, + "finalPrice": { + "type": "integer", + "format": "int64" + }, + "title": { + "description": "ุงุณู… ุงู„ู…ู†ุชุฌ", + "type": "string" + }, + "brandName": { + "type": "string" + }, + "discountPercentage": { + "description": "ู…ุนุฏู„ ุฎุตู… ุงู„ู…ู†ุชุฌ ู…ู‚ุงุฑู†ุฉ ุจุงู„ุณุนุฑ ุงู„ุฃุตู„ูŠ ู…ู‚ุงุฑู†ุฉ ุจุงู„ุณุนุฑ ุงู„ู†ู‡ุงุฆูŠ", + "type": "integer", + "format": "int32" + }, + "maximumBenefitCouponAppliedFinalPrice": { + "type": "integer", + "format": "int64" + }, + "originalToMaximumBenefitCouponPricePercentage": { + "description": "ู…ุนุฏู„ ุฎุตู… ุงู„ู…ู†ุชุฌ ู…ู‚ุงุฑู†ุฉ ุจุงู„ุณุนุฑ ุงู„ุฃุตู„ูŠุŒ ุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ ู„ูƒูˆุจูˆู† ุงู„ุงุณุชูุงุฏุฉ ุงู„ู…ุทุจู‚ุŒ ุงู„ุณุนุฑ ุงู„ู†ู‡ุงุฆูŠ", + "type": "integer", + "format": "int32" + } + } + }, + "BannerDataDto": { + "type": "object", + "required": [ + "type", + "imageUrl", + "linkUrl", + "title", + "enabled", + "note" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/BannerTypeEnum" + }, + "categoryId": { + "type": "string" + }, + "brandId": { + "type": "string" + }, + "brandSourcingTagId": { + "type": "string" + }, + "displayProductIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "displayProductCount": { + "type": "integer" + }, + "imageUrl": { + "type": "string" + }, + "linkUrl": { + "type": "string" + }, + "startAtMillis": { + "type": "integer", + "format": "int64" + }, + "endAtMillis": { + "type": "integer", + "format": "int64" + }, + "title": { + "type": "string" + }, + "subTitle": { + "type": "string" + }, + "enabled": { + "description": "(ู…ู‡ู…ู„) ู…ู…ูƒู‘ู†", + "type": "boolean" + }, + "note": { + "description": "(ู…ูˆู‚ูˆู) ู…ู„ุงุญุธุฉ", + "type": "string" + } + } + }, + "BannerTypeEnum": { + "oneOf": [ + { + "const": "MAIN" + }, + { + "const": "STYLE" + }, + { + "const": "SUB" + }, + { + "const": "DISCOUNT" + }, + { + "const": "CATEGORY" + }, + { + "const": "BRAND" + }, + { + "const": "SECTION1" + }, + { + "const": "SECTION2" + }, + { + "const": "SPARE" + }, + { + "const": "BEST_TOP" + }, + { + "const": "DEPARTMENT_STORE" + }, + { + "const": "OUTLET" + }, + { + "const": "HOME_SHOPPING" + }, + { + "const": "SOHO_MALL" + }, + { + "const": "QUEENIT_EXCLUSIVE" + }, + { + "const": "DESIGNER" + }, + { + "const": "MAGAZINE" + }, + { + "const": "EVENT" + }, + { + "const": "BRAND_PROMOTION" + }, + { + "const": "SEARCH_HOME" + }, + { + "const": "MAIN_V2" + } + ], + "description": "ุชู… ุฅู‡ู…ุงู„ SECTIONX" + }, + "CollectionListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CollectionDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "CollectionDto": { + "type": "object", + "required": [ + "id", + "title", + "elements" + ], + "properties": { + "id": { + "type": "string" + }, + "title": { + "type": "string" + }, + "elements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CollectionElementDto" + } + } + } + }, + "CollectionElementDto": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/CollectionElementTypeEnum" + }, + "text": { + "$ref": "#/components/schemas/TextCollectionElementDto" + }, + "image": { + "$ref": "#/components/schemas/ImageCollectionElementDto" + }, + "products": { + "$ref": "#/components/schemas/ProductsCollectionElementDto" + }, + "videos": { + "$ref": "#/components/schemas/VideosCollectionElementDto" + }, + "link": { + "$ref": "#/components/schemas/LinkCollectionElementDto" + }, + "campaign": { + "$ref": "#/components/schemas/CampaignCollectionElementDto" + }, + "coupon": { + "$ref": "#/components/schemas/CouponCollectionElementDto" + }, + "imageLink": { + "$ref": "#/components/schemas/ImageLinkCollectionElementDto" + }, + "markdown": { + "$ref": "#/components/schemas/MarkdownCollectionElementDto" + }, + "pointPromotion": { + "$ref": "#/components/schemas/PointPromotionCollectionElementDto" + }, + "attendanceCheck": { + "$ref": "#/components/schemas/AttendanceCheckCollectionElementDto" + } + } + }, + "TextCollectionElementDto": { + "type": "object", + "required": [ + "type", + "text" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/CollectionTextTypeEnum" + }, + "text": { + "type": "string" + } + } + }, + "CollectionTextTypeEnum": { + "oneOf": [ + { + "const": "TITLE" + }, + { + "const": "SUBTITLE" + }, + { + "const": "BODY" + }, + { + "const": "DESCRIPTION" + } + ] + }, + "ImageCollectionElementDto": { + "required": [ + "imageUrl" + ], + "type": "object", + "properties": { + "imageUrl": { + "type": "string" + } + } + }, + "ImageLinkCollectionElementDto": { + "type": "object", + "required": [ + "imageUrl", + "linkUrl" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/ImageLinkTypeEnum" + }, + "imageUrl": { + "type": "string" + }, + "linkUrl": { + "type": "string" + }, + "campaign": { + "type": "string" + } + } + }, + "ProductsCollectionElementDto": { + "type": "object", + "required": [ + "columnCount", + "products", + "freeReturnTargetProductIds" + ], + "properties": { + "title": { + "type": "string" + }, + "columnCount": { + "type": "integer", + "format": "int32" + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDto" + } + }, + "freeReturnTargetProductIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "FreeReturnTargetFilterTypeEnum": { + "oneOf": [ + { + "const": "WHITELIST" + }, + { + "const": "BLACKLIST" + } + ] + }, + "FreeReturnTargetTypeEnum": { + "const": "PRODUCT" + }, + "FreeReturnPromotionTargetTypeEnum": { + "oneOf": [ + { + "const": "PRODUCT" + }, + { + "const": "BRAND_SOURCING" + } + ] + }, + "VideosCollectionElementDto": { + "type": "object", + "required": [ + "ids", + "isLandscape" + ], + "properties": { + "ids": { + "type": "array", + "items": { + "type": "string" + } + }, + "isLandscape": { + "type": "boolean" + } + } + }, + "OrientationTypeEnum": { + "oneOf": [ + { + "const": "PORTRAIT" + }, + { + "const": "LANDSCAPE" + } + ] + }, + "LinkCollectionElementDto": { + "type": "object", + "required": [ + "imageUrl", + "linkUrl" + ], + "properties": { + "imageUrl": { + "type": "string" + }, + "linkUrl": { + "type": "string" + }, + "campaign": { + "type": "string" + } + } + }, + "CampaignCollectionElementDto": { + "type": "object", + "required": [ + "imageUrl", + "campaign" + ], + "properties": { + "imageUrl": { + "type": "string" + }, + "message": { + "type": "string" + }, + "campaign": { + "type": "string" + } + } + }, + "CouponCollectionElementDto": { + "type": "object", + "required": [ + "imageUrl", + "couponCode" + ], + "properties": { + "imageUrl": { + "type": "string" + }, + "couponCode": { + "type": "string" + }, + "campaign": { + "type": "string" + } + } + }, + "MarkdownCollectionElementDto": { + "type": "object", + "required": [ + "markdown" + ], + "properties": { + "markdown": { + "type": "string" + } + } + }, + "PointPromotionCollectionElementDto": { + "type": "object", + "required": [ + "promotionCode", + "imageUrl" + ], + "properties": { + "promotionCode": { + "description": "ุฑู…ุฒ ุชุนุฒูŠุฒ ุงู„ุงุฏุฎุงุฑ", + "type": "string" + }, + "amount": { + "description": "ู…ู‚ุฏุงุฑ ุงู„ู†ู‚ุงุท ุงู„ุชูŠ ุณุชุญุตู„ ุนู„ูŠู‡ุง ู…ู† ุฎู„ุงู„ ุญุถูˆุฑ ุงู„ุนุฑุถ ุงู„ุชุฑูˆูŠุฌูŠ", + "type": "integer", + "format": "int64" + }, + "imageUrl": { + "description": "ุนู†ูˆุงู† URL ู„ุตูˆุฑุฉ ุงู„ู†ู‚ุทุฉ", + "type": "string" + }, + "campaign": { + "description": "ุญู‚ูˆู„ ู„ู„ู…ู„ุงุญุธุงุช", + "type": "string" + } + } + }, + "AttendanceCheckCollectionElementDto": { + "type": "object", + "required": [ + "title", + "imageUrl", + "kstStartDate", + "kstEndDate", + "numberOfAttendance", + "attendanceRewardPolicies" + ], + "properties": { + "id": { + "description": "ู…ุนุฑู ุงู„ุชุญู‚ู‚ ู…ู† ุงู„ุญุถูˆุฑ", + "type": "string" + }, + "title": { + "type": "string" + }, + "imageUrl": { + "description": "ุนู†ูˆุงู† URL ู„ุตูˆุฑุฉ ุงู„ุชุญู‚ู‚ ู…ู† ุงู„ุญุถูˆุฑ", + "type": "string" + }, + "kstStartDate": { + "type": "string", + "description": "ุงู„ุชุงุฑูŠุฎ ุจุชู†ุณูŠู‚ yyyy-mm-dd" + }, + "kstEndDate": { + "type": "string", + "description": "ุงู„ุชุงุฑูŠุฎ ุจุชู†ุณูŠู‚ yyyy-mm-dd" + }, + "numberOfAttendance": { + "type": "integer", + "format": "int64" + }, + "attendanceRewardPolicies": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AttendanceRewardPolicyCollectionElementDto" + } + } + } + }, + "AttendanceRewardPolicyCollectionElementDto": { + "type": "object", + "required": [ + "type", + "pointAmount", + "pointExpireDays" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/AttendanceRewardPolicyTypeEnum" + }, + "pointAmount": { + "type": "integer", + "format": "int64" + }, + "pointExpireDays": { + "type": "integer" + } + } + }, + "AttendanceRewardPolicyTypeEnum": { + "oneOf": [ + { + "const": "DAILY_REWARD" + }, + { + "const": "ACHIEVEMENT_REWARD" + } + ] + }, + "ImageLinkTypeEnum": { + "oneOf": [ + { + "const": "COUPON" + }, + { + "const": "LINK" + } + ] + }, + "CollectionElementTypeEnum": { + "oneOf": [ + { + "const": "TEXT" + }, + { + "const": "IMAGE" + }, + { + "const": "PRODUCTS" + }, + { + "const": "VIDEOS" + }, + { + "const": "LINK" + }, + { + "const": "CAMPAIGN" + }, + { + "const": "COUPON" + }, + { + "const": "IMAGELINK" + }, + { + "const": "MARKDOWN" + }, + { + "const": "POINT_PROMOTION" + }, + { + "const": "ATTENDANCE_CHECK" + } + ] + }, + "UploadProductPageRequest": { + "type": "object", + "required": [ + "base64" + ], + "properties": { + "base64": { + "type": "string" + } + } + }, + "CouponBookDto": { + "type": "object", + "required": [ + "code", + "header", + "title", + "contents", + "pairContents", + "asset", + "coupons" + ], + "properties": { + "code": { + "type": "string" + }, + "header": { + "type": "string" + }, + "title": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "pairContents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ContentsPairDto" + } + }, + "asset": { + "$ref": "#/components/schemas/CouponBookAssetDto" + }, + "coupons": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCouponDto" + } + } + } + }, + "CouponBookAssetDto": { + "type": "object", + "required": [ + "primaryColor" + ], + "properties": { + "primaryColor": { + "$ref": "#/components/schemas/ColorGradientDto" + }, + "contentImageUrl": { + "description": "ู…ูˆู‚ูˆู", + "type": "string" + }, + "multiResolutionContentImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "stickerImageUrl": { + "description": "ู…ูˆู‚ูˆู", + "type": "string" + }, + "multiResolutionStickerImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + } + } + }, + "ContentsPairDto": { + "type": "object", + "required": [ + "first", + "second" + ], + "properties": { + "first": { + "type": "string" + }, + "second": { + "type": "string" + } + } + }, + "ColorGradientDto": { + "type": "object", + "required": [ + "startColorCode", + "endColorCode" + ], + "properties": { + "startColorCode": { + "type": "string", + "description": "ุจุฏุงูŠุฉ ุฑู…ุฒ ุงู„ู„ูˆู† ุงู„ุชุฏุฑุฌ. (ุนู„ู‰ ุณุจูŠู„ ุงู„ู…ุซุงู„ \\#AABBCC)" + }, + "endColorCode": { + "type": "string", + "description": "ู†ู‡ุงูŠุฉ ุฑู…ุฒ ุงู„ู„ูˆู† ุงู„ุชุฏุฑุฌ. (ุนู„ู‰ ุณุจูŠู„ ุงู„ู…ุซุงู„ \\#DDEEFF)" + } + } + }, + "IssuedCouponWhenOrderDto": { + "type": "object", + "properties": { + "issuedCouponId": { + "type": "integer", + "format": "int64" + }, + "coupon": { + "$ref": "#/components/schemas/CouponDto" + }, + "state": { + "$ref": "#/components/schemas/IssuedCouponStateEnum" + }, + "issuedAtMillis": { + "type": "integer", + "format": "int64" + }, + "activatingAtMillis": { + "type": "integer", + "format": "int64" + }, + "expiringAtMillis": { + "type": "integer", + "format": "int64" + }, + "linkUrl": { + "type": "string" + }, + "discountableAmount": { + "type": "integer", + "format": "int64" + }, + "consumable": { + "type": "boolean" + } + } + }, + "IssuedCouponDto": { + "type": "object", + "required": [ + "issuedCouponId", + "coupon", + "state", + "issuedAtMillis", + "activatingAtMillis" + ], + "properties": { + "issuedCouponId": { + "type": "integer", + "format": "int64" + }, + "coupon": { + "$ref": "#/components/schemas/CouponDto" + }, + "state": { + "$ref": "#/components/schemas/IssuedCouponStateEnum" + }, + "issuedAtMillis": { + "type": "integer", + "format": "int64" + }, + "activatingAtMillis": { + "type": "integer", + "format": "int64" + }, + "expiringAtMillis": { + "type": "integer", + "format": "int64" + }, + "linkUrl": { + "type": "string" + } + } + }, + "IssuedCouponStateEnum": { + "oneOf": [ + { + "const": "CONSUMED" + }, + { + "const": "EXPIRED" + }, + { + "const": "ACTIVATED" + }, + { + "const": "DISABLED" + } + ] + }, + "CouponDto": { + "type": "object", + "required": [ + "code", + "title", + "caution", + "conditionSummary", + "type" + ], + "properties": { + "code": { + "type": "string" + }, + "title": { + "type": "string" + }, + "manager": { + "type": "string" + }, + "caution": { + "type": "string" + }, + "conditionSummary": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/CouponTypeEnum" + }, + "discountAmount": { + "type": "integer", + "format": "int64", + "description": "ุงู„ุญู‚ู„ ู„ู†ูˆุน CouponTypeEnum.DISCOUNT_BY_AMOUNT." + }, + "discountPercentage": { + "type": "integer", + "format": "int64", + "description": "ุงู„ุญู‚ู„ ู„ู†ูˆุน CouponTypeEnum.DISCOUNT_BY_PERCENTAGE." + }, + "maxDiscountAmount": { + "type": "integer", + "format": "int64", + "description": "ุงู„ุญู‚ู„ ู„ู†ูˆุน CouponTypeEnum.DISCOUNT_BY_PERCENTAGE." + }, + "specialPrice": { + "type": "integer", + "format": "int64", + "description": "ุงู„ุญู‚ู„ ู„ู†ูˆุน CouponTypeEnum.SPECIAL_PRICE." + } + } + }, + "AppCouponDto": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "title": { + "type": "string" + }, + "manager": { + "type": "string" + }, + "caution": { + "type": "string" + }, + "conditionSummary": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/CouponTypeEnum" + }, + "discountAmount": { + "type": "integer", + "format": "int64", + "description": "ุงู„ุญู‚ู„ ู„ู†ูˆุน CouponTypeEnum.DISCOUNT_BY_AMOUNT." + }, + "discountPercentage": { + "type": "integer", + "format": "int64", + "description": "ุงู„ุญู‚ู„ ู„ู†ูˆุน CouponTypeEnum.DISCOUNT_BY_PERCENTAGE." + }, + "maxDiscountAmount": { + "type": "integer", + "format": "int64", + "description": "ุงู„ุญู‚ู„ ู„ู†ูˆุน CouponTypeEnum.DISCOUNT_BY_PERCENTAGE." + }, + "specialPrice": { + "type": "integer", + "format": "int64", + "description": "ุงู„ุญู‚ู„ ู„ู†ูˆุน CouponTypeEnum.SPECIAL_PRICE." + }, + "consumableCount": { + "type": "integer", + "format": "int64" + } + } + }, + "CouponDetailDto": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "title": { + "type": "string" + }, + "manager": { + "type": "string" + }, + "caution": { + "type": "string" + }, + "conditionSummary": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/CouponTypeEnum" + }, + "discountAmount": { + "type": "integer", + "format": "int64", + "description": "ุงู„ุญู‚ู„ ู„ู†ูˆุน CouponTypeEnum.DISCOUNT_BY_AMOUNT." + }, + "discountPercentage": { + "type": "integer", + "format": "int64", + "description": "ุงู„ุญู‚ู„ ู„ู†ูˆุน CouponTypeEnum.DISCOUNT_BY_PERCENTAGE." + }, + "maxDiscountAmount": { + "type": "integer", + "format": "int64", + "description": "ุงู„ุญู‚ู„ ู„ู†ูˆุน CouponTypeEnum.DISCOUNT_BY_PERCENTAGE." + }, + "specialPrice": { + "type": "integer", + "format": "int64", + "description": "ุงู„ุญู‚ู„ ู„ู†ูˆุน CouponTypeEnum.SPECIAL_PRICE." + }, + "expirationPolicy": { + "$ref": "#/components/schemas/CouponExpirationPolicyDto" + } + } + }, + "CouponExpirationPolicyDto": { + "type": "object", + "properties": { + "durationSecondsSinceHold": { + "type": "integer", + "format": "int64" + }, + "startAtMillis": { + "type": "integer", + "format": "int64" + }, + "endAtMillis": { + "type": "integer", + "format": "int64" + } + } + }, + "AppCouponListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCouponDto" + } + }, + "maximumDiscountCouponAppliedPrice": { + "description": "- ุงู„ุณุนุฑ ู…ุน ุชุทุจูŠู‚ ุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ ู„ุฎุตู… ุงู„ูƒูˆุจูˆู† - ุฅุฐุง ูƒุงู†ุช ู‚ูŠู…ุฉ ู‡ุฐุง ุงู„ุญู‚ู„ `ูุงุฑุบุฉ` -> ูŠู…ูƒู† ู…ู„ุงุญุธุฉ ุฃู†ู‡ ู„ุง ูŠูˆุฌุฏ ู‚ุณูŠู…ุฉ ุชุณุชูˆููŠ ุดุฑูˆุท ุญุณุงุจ ุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ ู„ุณุนุฑ ุงู„ุฎุตู….", + "type": "integer", + "format": "int64" + } + } + }, + "CouponTypeEnum": { + "oneOf": [ + { + "const": "DISCOUNT_BY_AMOUNT" + }, + { + "const": "DISCOUNT_BY_PERCENTAGE" + }, + { + "const": "SPECIAL_PRICE" + } + ] + }, + "ApplyCouponRequestDto": { + "type": "object", + "required": [ + "issuedCouponId" + ], + "properties": { + "issuedCouponId": { + "type": "integer", + "format": "int64" + } + } + }, + "ApplyPointRequestDto": { + "type": "object", + "required": [ + "usePoint" + ], + "properties": { + "usePoint": { + "type": "integer", + "format": "int64" + } + } + }, + "ReleaseCouponResponseDto": { + "type": "object", + "required": [ + "priceSet", + "orderSummary" + ], + "properties": { + "priceSet": { + "$ref": "#/components/schemas/PriceSetDto" + }, + "orderSummary": { + "$ref": "#/components/schemas/OrderSummaryDto" + } + } + }, + "ApplyCouponResponseDto": { + "type": "object", + "required": [ + "priceSet", + "orderSummary" + ], + "properties": { + "priceSet": { + "$ref": "#/components/schemas/PriceSetDto" + }, + "orderSummary": { + "$ref": "#/components/schemas/OrderSummaryDto" + } + } + }, + "ApplyPointResponseDto": { + "type": "object", + "required": [ + "priceSet", + "orderSummary" + ], + "properties": { + "priceSet": { + "$ref": "#/components/schemas/PriceSetDto" + }, + "orderSummary": { + "$ref": "#/components/schemas/OrderSummaryDto" + } + } + }, + "ProductPriceDto": { + "type": "object", + "required": [ + "originalPrice", + "sellingPrice" + ], + "properties": { + "originalPrice": { + "type": "integer", + "format": "int64", + "description": "ุงู„ุณุนุฑ ุงู„ุนุงุฏูŠ" + }, + "sellingPrice": { + "type": "integer", + "format": "int64", + "description": "ุณุนุฑ ุงู„ุจูŠุน" + } + } + }, + "ProductDiscountBenefitsDto": { + "type": "object", + "required": [ + "discountBenefitsByCoupon", + "discountBenefitsByPoint" + ], + "properties": { + "discountBenefitsByCoupon": { + "$ref": "#/components/schemas/ProductDiscountBenefitsInfoByCouponDto" + }, + "discountBenefitsByPoint": { + "type": "integer", + "format": "int64", + "description": "ูƒู…ูŠุฉ ุงู„ู†ู‚ุงุท ุงู„ู…ุชุงุญุฉ" + } + } + }, + "ProductDiscountBenefitsInfoByCouponDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDiscountBenefitsInfoByCouponElementDto" + } + } + } + }, + "ProductDiscountBenefitsInfoByCouponElementDto": { + "type": "object", + "required": [ + "title", + "couponCode", + "discountAmount" + ], + "properties": { + "title": { + "type": "string" + }, + "couponCode": { + "type": "string" + }, + "discountAmount": { + "type": "integer", + "format": "int64" + } + } + }, + "CheckFirstKakaoLoginCouponIssuableResponseDto": { + "type": "object", + "required": [ + "isIssuable" + ], + "properties": { + "isIssuable": { + "type": "boolean" + } + } + }, + "AgeGroupFilterListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AgeGroupFilterDto" + } + } + } + }, + "AgeGroupFilterDto": { + "type": "object", + "required": [ + "code", + "alias" + ], + "properties": { + "code": { + "$ref": "#/components/schemas/AgeGroupCodeEnum" + }, + "alias": { + "type": "string" + } + } + }, + "CreatableReviewPromptDto": { + "type": "object", + "properties": { + "myOrderItem": { + "$ref": "#/components/schemas/MyOrderItemDto" + } + } + }, + "DisplayProductReviewListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DisplayProductReviewDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "DisplayProductReviewListDtoV2": { + "type": "object", + "required": [ + "list", + "totalPageCount", + "totalElementCount" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DisplayProductReviewDto" + } + }, + "totalPageCount": { + "type": "integer", + "format": "int32" + }, + "totalElementCount": { + "type": "integer", + "format": "int64" + } + } + }, + "RepresentativeProductReviewListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DisplayProductReviewDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "DisplayProductReviewDto": { + "type": "object", + "required": [ + "productReview", + "optionTitle", + "userProfileDisplayPolicy", + "favoriteData" + ], + "properties": { + "productReview": { + "$ref": "#/components/schemas/ProductReviewDto" + }, + "optionTitle": { + "type": "string" + }, + "userProfileDisplayPolicy": { + "$ref": "#/components/schemas/UserProfileDisplayPolicyDto" + }, + "favoriteData": { + "$ref": "#/components/schemas/ProductReviewFavoriteDataDto" + } + } + }, + "ProductReviewListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "ProductReviewDto": { + "type": "object", + "properties": { + "attributes": { + "$ref": "#/components/schemas/ProductReviewAttributeDto" + }, + "rating": { + "$ref": "#/components/schemas/ProductRatingEnum" + }, + "size": { + "$ref": "#/components/schemas/ProductSizeEnum" + }, + "brightness": { + "$ref": "#/components/schemas/ProductBrightnessEnum" + }, + "colorSense": { + "$ref": "#/components/schemas/ProductColorSenseEnum" + }, + "thickness": { + "$ref": "#/components/schemas/ProductThicknessEnum" + }, + "contents": { + "type": "string" + }, + "imageUrls": { + "description": "ู…ูˆู‚ูˆู", + "type": "array", + "items": { + "type": "string" + } + }, + "multiResolutionImages": { + "$ref": "#/components/schemas/MultiResolutionImageListDto" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "uid": { + "type": "string" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + }, + "userProfile": { + "$ref": "#/components/schemas/UserProfileDto" + } + } + }, + "ProductReviewFavoriteDataDto": { + "type": "object", + "required": [ + "favoriteCount", + "isMyFavorite" + ], + "properties": { + "favoriteCount": { + "type": "integer", + "format": "int64" + }, + "isMyFavorite": { + "type": "boolean", + "default": false + } + } + }, + "UpdateProductReviewRequestDto": { + "type": "object", + "required": [ + "reviewData" + ], + "properties": { + "reviewData": { + "$ref": "#/components/schemas/ProductReviewDataDto" + } + } + }, + "ProductCategoryReviewAttributeDto": { + "type": "object", + "required": [ + "productCategoryReviewGroupId", + "label", + "list", + "guide" + ], + "properties": { + "productCategoryReviewGroupId": { + "type": "string" + }, + "label": { + "type": "string" + }, + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryReviewAttributeItemDto" + } + }, + "guide": { + "$ref": "#/components/schemas/ProductCategoryReviewGuideDto" + } + } + }, + "ProductReviewAttributeDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewAttributeItemDto" + } + } + } + }, + "ProductCategoryReviewAttributeItemDto": { + "type": "object", + "required": [ + "code", + "label", + "options" + ], + "properties": { + "code": { + "type": "string" + }, + "label": { + "type": "string" + }, + "options": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewAttributeOptionItemDto" + } + } + } + }, + "ProductReviewAttributeItemDto": { + "type": "object", + "required": [ + "code", + "label", + "selectedOptions" + ], + "properties": { + "code": { + "type": "string" + }, + "label": { + "type": "string" + }, + "selectedOptions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewAttributeOptionItemDto" + } + } + } + }, + "ProductReviewAttributeOptionItemDto": { + "type": "object", + "required": [ + "code", + "label" + ], + "properties": { + "code": { + "type": "string" + }, + "label": { + "type": "string" + } + } + }, + "ProductCategoryReviewGuideDto": { + "type": "object", + "required": [ + "textGuides", + "imageWithTitles" + ], + "properties": { + "textGuides": { + "type": "array", + "items": { + "type": "string" + } + }, + "imageWithTitles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryReviewGuideImageWithTitleDto" + } + } + } + }, + "ProductCategoryReviewGuideImageWithTitleDto": { + "type": "object", + "required": [ + "imageUrl", + "title" + ], + "properties": { + "imageUrl": { + "type": "string" + }, + "title": { + "type": "string" + } + } + }, + "ProductReviewDataDto": { + "type": "object", + "required": [ + "rating" + ], + "properties": { + "attributes": { + "$ref": "#/components/schemas/ProductReviewAttributeDto" + }, + "rating": { + "$ref": "#/components/schemas/ProductRatingEnum" + }, + "size": { + "$ref": "#/components/schemas/ProductSizeEnum" + }, + "brightness": { + "$ref": "#/components/schemas/ProductBrightnessEnum" + }, + "colorSense": { + "$ref": "#/components/schemas/ProductColorSenseEnum" + }, + "thickness": { + "$ref": "#/components/schemas/ProductThicknessEnum" + }, + "contents": { + "type": "string" + }, + "imageUrls": { + "description": "ู…ูˆู‚ูˆู", + "type": "array", + "items": { + "type": "string" + } + }, + "multiResolutionImages": { + "$ref": "#/components/schemas/MultiResolutionImageListDto" + } + } + }, + "UserProfileDisplayPolicyDto": { + "type": "object", + "required": [ + "displayItemsOfUserProfile" + ], + "properties": { + "displayItemsOfUserProfile": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserProfileItemEnum" + } + } + } + }, + "UserProfileItemEnum": { + "oneOf": [ + { + "const": "HEIGHT_AS_CENTI_METER" + }, + { + "const": "WEIGHT_AS_KILO_GRAM" + }, + { + "const": "TOP_SIZE" + }, + { + "const": "BOTTOM_SIZE_AS_INCH" + }, + { + "const": "SHOE_SIZE_AS_MILLI_METER" + }, + { + "const": "AGE" + } + ] + }, + "ProductReviewCandidateListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewCandidateDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "ProductReviewCandidateDto": { + "type": "object", + "required": [ + "myOrderItem" + ], + "properties": { + "myOrderItem": { + "$ref": "#/components/schemas/MyOrderItemDto" + } + } + }, + "MyProductReviewListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MyProductReviewDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "MyProductReviewDto": { + "type": "object", + "required": [ + "myOrderItem" + ], + "properties": { + "myOrderItem": { + "$ref": "#/components/schemas/MyOrderItemDto" + } + } + }, + "ProductReviewItemListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ProductReviewStatisticsAttributeDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewStatisticsAttributeItemDto" + } + } + } + }, + "ProductReviewStatisticsAttributeItemDto": { + "type": "object", + "required": [ + "code", + "label", + "options" + ], + "properties": { + "code": { + "type": "string" + }, + "label": { + "type": "string" + }, + "options": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewStatisticsAttributeOptionItemDto" + } + } + } + }, + "ProductReviewStatisticsAttributeOptionItemDto": { + "type": "object", + "required": [ + "code", + "label", + "count" + ], + "properties": { + "code": { + "type": "string" + }, + "label": { + "type": "string" + }, + "percentage": { + "type": "integer", + "format": "int32" + }, + "count": { + "type": "integer", + "format": "int64" + } + } + }, + "ProductReviewStatisticsSummaryDto": { + "type": "object", + "required": [ + "ratingAverage", + "reviewCounts" + ], + "properties": { + "ratingAverage": { + "type": "number", + "format": "double" + }, + "reviewCounts": { + "type": "integer", + "format": "int64" + }, + "attributes": { + "$ref": "#/components/schemas/ProductReviewStatisticsAttributeDto" + }, + "satisfactionPercentage": { + "type": "integer", + "format": "int32" + }, + "topPercentageOfSize": { + "$ref": "#/components/schemas/ProductSizePercentageDto" + }, + "topPercentageOfBrightness": { + "$ref": "#/components/schemas/ProductBrightnessPercentageDto" + }, + "topPercentageOfColorSense": { + "$ref": "#/components/schemas/ProductColorSensePercentageDto" + }, + "topPercentageOfThickness": { + "$ref": "#/components/schemas/ProductThicknessPercentageDto" + } + } + }, + "ProductRatingStatisticsDto": { + "type": "object", + "required": [ + "percentages" + ], + "properties": { + "percentages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductRatingPercentageDto" + } + } + } + }, + "ProductRatingPercentageDto": { + "type": "object", + "required": [ + "rating", + "percentage" + ], + "properties": { + "rating": { + "$ref": "#/components/schemas/ProductRatingEnum" + }, + "percentage": { + "type": "integer", + "format": "int32" + } + } + }, + "ProductReviewSortOrderEnum": { + "oneOf": [ + { + "const": "CREATED_AT_DESC" + }, + { + "const": "CREATED_AT_ASC" + }, + { + "const": "REPORT_COUNT_DESC" + }, + { + "const": "RECOMMENDATION" + }, + { + "const": "REVIEW_RATING_DESC" + }, + { + "const": "REVIEW_RATING_ASC" + } + ] + }, + "ProductRatingEnum": { + "oneOf": [ + { + "const": 1 + }, + { + "const": 2 + }, + { + "const": 3 + }, + { + "const": 4 + }, + { + "const": 5 + } + ], + "x-enum-varnames": [ + "BAD", + "NOT_BAD", + "NORMAL", + "GOOD", + "BEST" + ] + }, + "ProductSizeStatisticsDto": { + "type": "object", + "required": [ + "percentages" + ], + "properties": { + "percentages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSizePercentageDto" + } + } + } + }, + "ProductSizePercentageDto": { + "type": "object", + "required": [ + "size" + ], + "properties": { + "size": { + "$ref": "#/components/schemas/ProductSizeEnum" + }, + "percentage": { + "type": "integer", + "format": "int32" + } + } + }, + "ProductSizeEnum": { + "oneOf": [ + { + "const": "SMALL" + }, + { + "const": "FITTED" + }, + { + "const": "BIG" + } + ] + }, + "ProductBrightnessStatisticsDto": { + "type": "object", + "required": [ + "percentages" + ], + "properties": { + "percentages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductBrightnessPercentageDto" + } + } + } + }, + "ProductBrightnessPercentageDto": { + "type": "object", + "required": [ + "brightness" + ], + "properties": { + "brightness": { + "$ref": "#/components/schemas/ProductBrightnessEnum" + }, + "percentage": { + "type": "integer", + "format": "int32" + } + } + }, + "ProductBrightnessEnum": { + "oneOf": [ + { + "const": "DARK" + }, + { + "const": "SAME_AS_PHOTO" + }, + { + "const": "BRIGHT" + } + ] + }, + "ProductColorSenseStatisticsDto": { + "type": "object", + "required": [ + "percentages" + ], + "properties": { + "percentages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductColorSensePercentageDto" + } + } + } + }, + "ProductColorSensePercentageDto": { + "type": "object", + "required": [ + "colorSense" + ], + "properties": { + "colorSense": { + "$ref": "#/components/schemas/ProductColorSenseEnum" + }, + "percentage": { + "type": "integer", + "format": "int32" + } + } + }, + "ProductColorSenseEnum": { + "oneOf": [ + { + "const": "BLURRY" + }, + { + "const": "SAME_AS_PHOTO" + }, + { + "const": "VIVID" + } + ] + }, + "ProductThicknessStatisticsDto": { + "type": "object", + "required": [ + "precentages" + ], + "properties": { + "percentages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductThicknessPercentageDto" + } + } + } + }, + "ProductThicknessPercentageDto": { + "type": "object", + "required": [ + "thickness" + ], + "properties": { + "thickness": { + "$ref": "#/components/schemas/ProductThicknessEnum" + }, + "percentage": { + "type": "integer", + "format": "int32" + } + } + }, + "ProductThicknessEnum": { + "oneOf": [ + { + "const": "THIN" + }, + { + "const": "NORMAL" + }, + { + "const": "THICK" + } + ] + }, + "ProductReviewReportDto": { + "type": "object", + "required": [ + "reason" + ], + "properties": { + "reason": { + "type": "string" + } + } + }, + "UserBirthYearDto": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "integer", + "format": "int32" + } + } + }, + "UserProfileDto": { + "type": "object", + "properties": { + "age": { + "type": "integer", + "format": "int32" + }, + "birthYear": { + "type": "integer", + "format": "int32" + }, + "bodySizeData": { + "$ref": "#/components/schemas/UserBodySizeDataDto" + } + } + }, + "UserBodySizeDataDto": { + "type": "object", + "properties": { + "heightAsCentiMeter": { + "type": "integer", + "format": "int32" + }, + "weightAsKiloGram": { + "type": "integer", + "format": "int32" + }, + "topSize": { + "type": "integer", + "format": "int32" + }, + "bottomSizeAsInch": { + "type": "integer", + "format": "int32" + }, + "shoeSizeAsMilliMeter": { + "type": "integer", + "format": "int32" + }, + "valid": { + "type": "boolean" + } + } + }, + "ExternalUidDto": { + "type": "object", + "properties": { + "externalUid": { + "type": "string" + } + } + }, + "ConnectPayCredentialDto": { + "type": "object", + "required": [ + "clientKey", + "customerKey", + "redirectUrl" + ], + "properties": { + "clientKey": { + "type": "string", + "description": "ClientKey ู„ู…ุตุงุฏู‚ุฉ ConnectPay JS SDK" + }, + "customerKey": { + "type": "string", + "description": "ุงู„ู…ุณุชุฎุฏู… uid ุงู„ุฎุงุฑุฌูŠ ุงู„ู…ุณุชุฎุฏู… ุนู†ุฏ ุทู„ุจ ุงู„ุฏูุน" + }, + "redirectUrl": { + "type": "string", + "description": "ุฅุนุงุฏุฉ ุชูˆุฌูŠู‡ ุนู†ูˆุงู† URL ู„ุงุณุชุฎุฏุงู…ู‡ ููŠ ู…ุตุงุฏู‚ุฉ Connect Pay OAuth" + } + } + }, + "PaymentMethodResponseDto": { + "type": "object", + "required": [ + "cards", + "accounts" + ], + "properties": { + "cards": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CardPaymentDto" + } + }, + "accounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AccountPaymentDto" + } + } + } + }, + "CardPaymentDto": { + "type": "object", + "required": [ + "methodId", + "cardCompany", + "cardName", + "iconUrl", + "maskedCardNumber", + "enabled", + "registeredAtMillis" + ], + "properties": { + "methodId": { + "type": "string", + "description": "ู…ุนุฑู ุทุฑูŠู‚ุฉ ุงู„ุฏูุนุŒ ูŠูุณุชุฎุฏู… ุนู†ุฏ ุทู„ุจ ุงู„ุฏูุน Connect Pay" + }, + "cardCompany": { + "$ref": "#/components/schemas/TossPaymentCardEnum" + }, + "unknownCardCompanyName": { + "type": "string", + "description": "ุฅุฐุง ูƒุงู†ุช ู‚ูŠู…ุฉ ุดุฑูƒุฉ ุงู„ุจุทุงู‚ุฉ `ุบูŠุฑ ู…ุนุฑูˆูุฉ`ุŒ ูุณูŠูƒูˆู† ุงุณู… ุดุฑูƒุฉ ุงู„ุจุทุงู‚ุฉ ุงู„ู…ู‚ุงุจู„ุฉุŒ ูˆุฅู„ุง ูŠูƒูˆู† ูุงุฑุบู‹ุง" + }, + "cardName": { + "type": "string", + "description": "ุงุณู… ุงู„ุจุทุงู‚ุฉ" + }, + "iconUrl": { + "type": "string", + "description": "ุนู†ูˆุงู† URL ู„ุตูˆุฑุฉ ุฑู…ุฒ ุดุฑูƒุฉ ุงู„ุจุทุงู‚ุฉ" + }, + "maskedCardNumber": { + "type": "string", + "description": "ุฑู‚ู… ุงู„ุจุทุงู‚ุฉ ุงู„ู…ู‚ู†ุนุฉ" + }, + "enabled": { + "type": "boolean" + }, + "registeredAtMillis": { + "type": "integer", + "format": "int64", + "description": "ุชุงุฑูŠุฎ ุงู„ุชุณุฌูŠู„" + } + } + }, + "AccountPaymentDto": { + "type": "object", + "required": [ + "methodId", + "bank", + "iconUrl", + "maskedAccountNumber", + "enabled", + "registeredAtMillis" + ], + "properties": { + "methodId": { + "type": "string", + "description": "ู…ุนุฑู ุทุฑูŠู‚ุฉ ุงู„ุฏูุนุŒ ูŠูุณุชุฎุฏู… ุนู†ุฏ ุทู„ุจ ุงู„ุฏูุน Connect Pay" + }, + "bank": { + "$ref": "#/components/schemas/TossPaymentAccountEnum" + }, + "unknownBankName": { + "type": "string", + "description": "ุฅุฐุง ูƒุงู†ุช ู‚ูŠู…ุฉ ุงู„ุจู†ูƒ `ุบูŠุฑ ู…ุนุฑูˆูุฉ`ุŒ ุงุณู… ุงู„ุจู†ูƒ ุงู„ู…ู‚ุงุจู„ุŒ ูˆุฅู„ุง ูŠูƒูˆู† ูุงุฑุบู‹ุง" + }, + "iconUrl": { + "type": "string", + "description": "ุนู†ูˆุงู† URL ู„ุตูˆุฑุฉ ุฑู…ุฒ ุงู„ุจู†ูƒ" + }, + "maskedAccountNumber": { + "type": "string", + "description": "ุฑู‚ู… ุงู„ุญุณุงุจ ุงู„ู…ู‚ู†ุน" + }, + "enabled": { + "type": "boolean" + }, + "registeredAtMillis": { + "type": "integer", + "format": "int64", + "description": "ุชุงุฑูŠุฎ ุงู„ุชุณุฌูŠู„" + } + } + }, + "TierDto": { + "type": "object", + "required": [ + "uid", + "totalPurchaseAmount", + "tierRankType" + ], + "properties": { + "uid": { + "description": "ู…ุนุฑู ุงู„ู…ุณุชุฎุฏู…", + "type": "string" + }, + "totalPurchaseAmount": { + "description": "ู…ุจู„ุบ ุงู„ุดุฑุงุก ุงู„ู…ุคูƒุฏ ุงู„ุชุฑุงูƒู…ูŠ (ู…ุจู„ุบ ุงู„ุดุฑุงุก ุงู„ู…ุคูƒุฏ ู„ู„ุฃุดู‡ุฑ ุงู„ุซู„ุงุซุฉ ุงู„ู…ุงุถูŠุฉุŒ ุงู„ู…ุจู„ุบ ุงู„ุฅุญุตุงุฆูŠ ุงู„ุฅุฌู…ุงู„ูŠ ุงู„ุณุงุจู‚ ู„ุดู‡ุฑ ู…ุงูŠูˆ ูˆูŠูˆู†ูŠูˆ ูˆูŠูˆู„ูŠูˆ ุนู†ุฏ ุนุฑุถู‡ ููŠ 7 ุฃุบุณุทุณ)", + "type": "integer", + "format": "int64" + }, + "tierRankType": { + "$ref": "#/components/schemas/TierRankTypeEnum" + } + } + }, + "TierRankTypeEnum": { + "oneOf": [ + { + "const": "DIAMOND" + }, + { + "const": "PLATINUM" + }, + { + "const": "GOLD" + }, + { + "const": "SILVER" + } + ], + "description": "ู†ูˆุน ุงู„ุทุจู‚ุฉ" + }, + "NextTierInfoDto": { + "type": "object", + "required": [ + "uid", + "nextTierRankType", + "startTierRankTypeForGraph", + "endTierRankTypeForGraph", + "totalPurchaseAmount", + "remainAmount", + "startAtMillis" + ], + "properties": { + "uid": { + "description": "ู…ุนุฑู ุงู„ู…ุณุชุฎุฏู…", + "type": "string" + }, + "nextTierRankType": { + "$ref": "#/components/schemas/TierRankTypeEnum" + }, + "startTierRankTypeForGraph": { + "$ref": "#/components/schemas/TierRankTypeEnum" + }, + "endTierRankTypeForGraph": { + "$ref": "#/components/schemas/TierRankTypeEnum" + }, + "totalPurchaseAmount": { + "description": "ู…ุจู„ุบ ุชุฃูƒูŠุฏ ุงู„ุดุฑุงุก ุงู„ุชุฑุงูƒู…ูŠ (ุงู„ู…ุจู„ุบ ุงู„ุฅุญุตุงุฆูŠ ู„ู„ุดู‡ุฑูŠู† ุงู„ู…ุงุถูŠูŠู† + ู…ุจู„ุบ ุชุฃูƒูŠุฏ ุงู„ุดุฑุงุก ููŠ ุงู„ูˆู‚ุช ุงู„ูุนู„ูŠ ู„ู„ุดู‡ุฑ ุงู„ุฐูŠ ุชู… ุนุฑุถู‡)", + "type": "integer", + "format": "int64" + }, + "remainAmount": { + "description": "ุงู„ู…ุจู„ุบ ุงู„ู…ุชุจู‚ูŠ ุญุชู‰ ุงู„ู…ุณุชูˆู‰ ุงู„ุชุงู„ูŠ (ุฅุฐุง ุชุฌุงูˆุฒ ุงู„ู…ุจู„ุบ ุงู„ุฅุฌู…ุงู„ูŠ ุงู„ู…ุณุชูˆู‰ ุงู„ุชุงู„ูŠุŒ ูุฅู† ุงู„ู…ุจู„ุบ ุงู„ู…ุชุจู‚ูŠ ุญุชู‰ ูŠุชู… ุฅุฎุฑุงุฌ ุงู„ู…ุณุชูˆู‰ ุงู„ุชุงู„ูŠ)", + "type": "integer", + "format": "int64" + }, + "startAtMillis": { + "type": "integer", + "format": "int64", + "description": "ูุชุฑุฉ ุจุฏุก ุญุณุงุจ ุงู„ุทุจู‚ุฉ" + }, + "tierChangeStatus": { + "$ref": "#/components/schemas/TierChangeStatusEnum" + } + } + }, + "TierChangeStatusEnum": { + "oneOf": [ + { + "const": "RISE" + }, + { + "const": "HOLD" + }, + { + "const": "FALL" + } + ], + "description": "ู†ูˆุน ุญุงู„ุฉ ุชุบูŠูŠุฑ ุงู„ุทุจู‚ุฉ" + }, + "ImageCategoryEnum": { + "oneOf": [ + { + "const": "PRODUCT_REVIEW" + }, + { + "const": "ORDER_LINE_RETURN" + } + ] + }, + "UploadableImageResponseDto": { + "type": "object", + "required": [ + "url", + "uploadedUrl", + "expiredAtMillis" + ], + "properties": { + "url": { + "type": "string" + }, + "uploadedUrl": { + "type": "string" + }, + "expiredAtMillis": { + "type": "integer", + "format": "int64" + } + } + }, + "UploadImageResponseDto": { + "type": "object", + "required": [ + "imageUrl", + "multiResolutionImage" + ], + "properties": { + "imageUrl": { + "description": "ู…ูˆู‚ูˆู", + "type": "string" + }, + "multiResolutionImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + } + } + }, + "Base64ImageUploadRequestDto": { + "type": "object", + "required": [ + "name", + "base64" + ], + "properties": { + "name": { + "type": "string" + }, + "base64": { + "type": "string" + } + } + }, + "ShopLiveTokenResponseDto": { + "type": "object", + "required": [ + "accessToken" + ], + "properties": { + "accessToken": { + "type": "string", + "description": "ุชู†ุชู‡ูŠ ุตู„ุงุญูŠุชู‡ ุฎู„ุงู„ 7 ุฃูŠุงู…" + } + } + }, + "ShopLiveTokenRequestDto": { + "type": "object", + "properties": { + "userName": { + "type": "string", + "description": "ุงุณู… ุฏุฑุฏุดุฉ ุงู„ู…ุณุชุฎุฏู…" + } + } + }, + "ShopLiveCampaignMetadataResponseDto": { + "type": "object", + "required": [ + "campaignAccessKey", + "campaignMetadataState" + ], + "properties": { + "campaignKey": { + "type": "string", + "description": "ู…ูุชุงุญ ุงู„ุญู…ู„ุฉ" + }, + "campaignAccessKey": { + "type": "string", + "description": "ู…ูุชุงุญ ุงู„ูˆุตูˆู„ ู„ู„ุญู…ู„ุฉ" + }, + "title": { + "type": "string", + "description": "ุนู†ูˆุงู† ุงู„ุญู…ู„ุฉ" + }, + "campaignMetadataState": { + "$ref": "#/components/schemas/ShopLiveCampaignMetadataStateEnum" + }, + "liveUrl": { + "type": "string", + "description": "ุนู†ูˆุงู† URL ู„ุชุดุบูŠู„ ุงู„ููŠุฏูŠูˆ" + }, + "posterUrl": { + "type": "string", + "description": "ุนู†ูˆุงู† URL ู„ุตูˆุฑุฉ ู…ุนุงูŠู†ุฉ ุงู„ุจุซ" + }, + "poster2Url": { + "type": "string", + "description": "ุนู†ูˆุงู† URL ู„ู„ุตูˆุฑุฉ ุจุนุฏ ุงู†ุชู‡ุงุก ุงู„ุจุซ" + }, + "scheduledAt": { + "type": "integer", + "format": "int64", + "description": "ูˆู‚ุช ุงู„ุจุซ ุงู„ู…ู‚ุฑุฑ" + }, + "scheduledEndAt": { + "type": "integer", + "format": "int64", + "description": "ูˆู‚ุช ุงู†ุชู‡ุงุก ุงู„ุจุซ ุงู„ู…ู‚ุฏุฑ" + }, + "startedAt": { + "type": "integer", + "format": "int64", + "description": "ูˆู‚ุช ุจุฏุก ุงู„ุจุซ" + }, + "closingAt": { + "type": "integer", + "format": "int64", + "description": "ูˆู‚ุช ุฅูŠู‚ุงู ุงู„ุชุดุบูŠู„ ุงู„ู…ุฌุฏูˆู„ ุงู„ูุนู„ูŠ ุนู†ุฏ ุถุจุท ุฅูŠู‚ุงู ุงู„ุชุดุบูŠู„ ุจุนุฏ n ุฏู‚ูŠู‚ุฉ" + }, + "endedAt": { + "type": "integer", + "format": "int64", + "description": "ูˆู‚ุช ุงู†ุชู‡ุงุก ุงู„ุจุซ" + } + } + }, + "ShopLiveCampaignResponseDto": { + "type": "object", + "required": [ + "campaignAccessKey", + "campaignState" + ], + "properties": { + "campaignKey": { + "type": "string", + "description": "ู…ูุชุงุญ ุงู„ุญู…ู„ุฉ" + }, + "campaignAccessKey": { + "type": "string", + "description": "ู…ูุชุงุญ ุงู„ูˆุตูˆู„ ู„ู„ุญู…ู„ุฉ" + }, + "campaignUrl": { + "type": "string", + "description": "ุนู†ูˆุงู† URL ู„ู„ุญู…ู„ุฉ" + }, + "title": { + "type": "string", + "description": "ุนู†ูˆุงู† ุงู„ุญู…ู„ุฉ" + }, + "memo": { + "type": "string", + "description": "ู…ู„ุงุญุธุงุช ุงู„ุญู…ู„ุฉ" + }, + "campaignState": { + "$ref": "#/components/schemas/ShopLiveCampaignStateEnum" + }, + "campaignGoodsList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShopLiveCampaignGoodsDto" + } + }, + "campaignGoodsCount": { + "type": "integer", + "format": "int32", + "description": "ุนุฏุฏ ุงู„ู…ู†ุชุฌุงุช ุงู„ู…ุณุฌู„ุฉ ููŠ ุงู„ุญู…ู„ุฉ" + }, + "userCount": { + "type": "integer", + "format": "int32", + "description": "ุงู„ุนุฏุฏ ุงู„ุชุฑุงูƒู…ูŠ ู„ู„ู…ุดุงู‡ุฏูŠู†" + }, + "adoreCount": { + "type": "integer", + "format": "int32", + "description": "ุนุฏุฏ ุงู„ุฅุนุฌุงุจุงุช" + }, + "posterUrl": { + "type": "string", + "description": "ุนู†ูˆุงู† URL ู„ุตูˆุฑุฉ ู…ุนุงูŠู†ุฉ ุงู„ุจุซ" + }, + "poster2Url": { + "type": "string", + "description": "ุนู†ูˆุงู† URL ู„ู„ุตูˆุฑุฉ ุจุนุฏ ุงู†ุชู‡ุงุก ุงู„ุจุซ" + }, + "unsupportInfoUrl": { + "type": "string", + "description": "IE ุบูŠุฑ ู…ุฏุนูˆู… ุจุนู†ูˆุงู† URL ู„ุตูˆุฑุฉ ุงู„ู…ุนู„ูˆู…ุงุช" + }, + "previewLiveUrl": { + "type": "string", + "description": "ุนู†ูˆุงู† URL ู„ู…ุนุงูŠู†ุฉ ุงู„ุจุซ" + }, + "replayLiveUrl": { + "type": "string", + "description": "ุนู†ูˆุงู† URL ู„ุฅุนุงุฏุฉ ุชุดุบูŠู„ ุงู„ุจุซ" + }, + "liveUrl": { + "type": "string", + "description": "ุนู†ูˆุงู† URL ู„ุชุดุบูŠู„ ุงู„ููŠุฏูŠูˆ" + }, + "backgroundUrl": { + "type": "string", + "description": "ุนู†ูˆุงู† URL ู„ุตูˆุฑุฉ ุงู„ุฎู„ููŠุฉ" + }, + "scheduledAt": { + "type": "integer", + "format": "int64", + "description": "ูˆู‚ุช ุงู„ุจุซ ุงู„ู…ู‚ุฑุฑ" + }, + "scheduledEndAt": { + "type": "integer", + "format": "int64", + "description": "ูˆู‚ุช ุงู†ุชู‡ุงุก ุงู„ุจุซ ุงู„ู…ู‚ุฏุฑ" + }, + "startedAt": { + "type": "integer", + "format": "int64", + "description": "ูˆู‚ุช ุจุฏุก ุงู„ุจุซ" + }, + "endedAt": { + "type": "integer", + "format": "int64", + "description": "ูˆู‚ุช ุงู†ุชู‡ุงุก ุงู„ุจุซ" + } + } + }, + "ShopLiveCampaignGoodsDto": { + "type": "object", + "required": [ + "campaignId", + "goodsId", + "name", + "url", + "action", + "payload", + "showingNow", + "soldOut", + "originalPrice", + "currency", + "traceId" + ], + "properties": { + "campaignId": { + "type": "integer", + "format": "int64", + "description": "ู…ุนุฑู ุงู„ุญู…ู„ุฉ" + }, + "goodsId": { + "type": "integer", + "format": "int64", + "description": "ู…ุนุฑู ุงู„ู…ู†ุชุฌ" + }, + "name": { + "type": "string", + "description": "ุงุณู… ุงู„ู…ู†ุชุฌ" + }, + "brand": { + "type": "string", + "description": "ุงู„ุนู„ุงู…ุฉ ุงู„ุชุฌุงุฑูŠุฉ ู„ู„ู…ู†ุชุฌ" + }, + "description": { + "type": "string", + "description": "ูˆุตู ุงู„ู…ู†ุชุฌ" + }, + "url": { + "type": "string", + "description": "ุนู†ูˆุงู† URL ู„ุญุฑูƒุฉ ุงู„ู…ู†ุชุฌ" + }, + "sku": { + "type": "string", + "description": "ุฑู…ุฒ ุงู„ู…ู†ุชุฌ" + }, + "action": { + "$ref": "#/components/schemas/ShopLiveCampaignGoodsActionTypeEnum" + }, + "payload": { + "type": "string", + "description": "ุณู„ุณู„ุฉ json ุชุญุชูˆูŠ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช URL ู„ู„ุงู†ุชู‚ุงู„ ุฅู„ูŠู‡ุง ุนู†ุฏ ุงู„ู†ู‚ุฑ ุนู„ู‰ ุงู„ู…ู†ุชุฌ" + }, + "medias": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShopLiveCampaignGoodsMediaDto" + } + }, + "showingNow": { + "type": "boolean", + "description": "ุงู„ุชุนุฑุถ ู„ู„ู…ู†ุชุฌ" + }, + "soldOut": { + "type": "boolean", + "description": "ู…ุง ุฅุฐุง ูƒุงู† ุงู„ู…ู†ุชุฌ ู‚ุฏ ุชู… ุจูŠุนู‡" + }, + "originalPrice": { + "type": "number", + "format": "double", + "description": "ุงู„ุณุนุฑ ุงู„ุฃุณุงุณูŠ ู„ู„ู…ู†ุชุฌ" + }, + "discountedPrice": { + "type": "number", + "format": "double", + "description": "ุณุนุฑ ุฎุตู… ุงู„ู…ู†ุชุฌ" + }, + "discountPercentage": { + "type": "number", + "format": "double", + "description": "ู…ุนุฏู„ ุฎุตู… ุงู„ู…ู†ุชุฌ" + }, + "currency": { + "type": "string", + "description": "ูˆุญุฏุฉ ุงู„ุจุถุงุฆุน" + }, + "traceId": { + "type": "string", + "description": "ุงู†ู‚ุฑ ุนู„ู‰ ุฃุนู„ู‰ ู…ุนุฑู ุงู„ุชุชุจุน" + } + } + }, + "ShopLiveCampaignGoodsMediaDto": { + "type": "object", + "required": [ + "id", + "mediaType", + "url", + "size", + "width", + "height" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "ู…ุนุฑู ุงู„ูˆุณุงุฆุท" + }, + "mediaType": { + "$ref": "#/components/schemas/ShopLiveCampaignGoodsMediaTypeEnum" + }, + "url": { + "type": "string", + "description": "ุนู†ูˆุงู† URL ู„ูˆุณุงุฆุท ุงู„ู…ู†ุชุฌ" + }, + "size": { + "type": "integer", + "format": "int64", + "description": "ุญุฌู… ูˆุณุงุฆุท ุงู„ู…ู†ุชุฌ" + }, + "width": { + "type": "integer", + "format": "int32", + "description": "ุญุฌู… ูˆุณุงุฆุท ุงู„ู…ู†ุชุฌ ุฃูู‚ูŠู‹ุง" + }, + "height": { + "type": "integer", + "format": "int32", + "description": "ุงู„ุญุฌู… ุงู„ุฑุฃุณูŠ ู„ูˆุณุงุฆุท ุงู„ู…ู†ุชุฌ" + } + } + }, + "ReferralCodeDto": { + "type": "object", + "required": [ + "referralCode" + ], + "properties": { + "referralCode": { + "type": "string" + } + } + }, + "CategoryBestProductDto": { + "type": "object", + "required": [ + "isBest" + ], + "properties": { + "categoryId": { + "type": "string" + }, + "categoryTitle": { + "type": "string" + }, + "isBest": { + "type": "boolean" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + }, + "updatedAtMillis": { + "type": "integer", + "format": "int64" + } + } + }, + "ShopLiveCampaignMetadataStateEnum": { + "oneOf": [ + { + "const": "NOT_EXIST" + }, + { + "const": "READY" + }, + { + "const": "ONAIR" + }, + { + "const": "CLOSING" + }, + { + "const": "CLOSED" + } + ], + "description": "- `ุบูŠุฑ ู…ูˆุฌูˆุฏ` -> ุญู…ู„ุฉ ุบูŠุฑ ู…ูˆุฌูˆุฏุฉ - `ุฌุงู‡ุฒ` -> ุงู„ุชุญุถูŠุฑ - `ONAIR` -> ุงู„ุจุซ - `ุฅุบู„ุงู‚` -> ุงู„ู†ู‡ุงูŠุฉ - `ู…ุบู„ู‚` -> ุงู„ู†ู‡ุงูŠุฉ" + }, + "ShopLiveCampaignStateEnum": { + "oneOf": [ + { + "const": "NOT_EXIST" + }, + { + "const": "READY" + }, + { + "const": "ONAIR" + }, + { + "const": "CLOSED" + } + ], + "description": "- `NOT_EXIST` -> ุญู…ู„ุฉ ุบูŠุฑ ู…ูˆุฌูˆุฏุฉ - `ุฌุงู‡ุฒุฉ` -> ุงู„ุชุญุถูŠุฑ - `ONAIR` -> ุงู„ุจุซ - `ู…ุบู„ู‚` -> ู…ู†ุชู‡ูŠุฉ" + }, + "ShopLiveCampaignGoodsActionTypeEnum": { + "const": "LINK" + }, + "ShopLiveCampaignGoodsMediaTypeEnum": { + "const": "IMAGE" + }, + "MultiResolutionImageDto": { + "type": "object", + "required": [ + "url_1x", + "url_2x", + "url_3x" + ], + "properties": { + "url_1x": { + "type": "string" + }, + "url_2x": { + "type": "string" + }, + "url_3x": { + "type": "string" + } + } + }, + "MultiResolutionImageListDto": { + "type": "object", + "required": [ + "urls_1x", + "urls_2x", + "urls_3x" + ], + "properties": { + "urls_1x": { + "type": "array", + "items": { + "type": "string" + } + }, + "urls_2x": { + "type": "array", + "items": { + "type": "string" + } + }, + "urls_3x": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SellerContentImagesDto": { + "type": "object", + "required": [ + "contentType", + "multiResolutionImages" + ], + "properties": { + "contentType": { + "$ref": "damoa-seller-api.yaml#/components/schemas/SellerContentTypeEnum" + }, + "multiResolutionImages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + } + } + } + }, + "UserDeliveryAddressAddRequestDto": { + "type": "object", + "required": [ + "address" + ], + "properties": { + "address": { + "$ref": "#/components/schemas/DeliveryAddressDto" + }, + "request": { + "type": "string", + "description": "ุทู„ุจ ุงู„ุชุณู„ูŠู…" + } + } + }, + "UserDeliveryAddressDto": { + "type": "object", + "required": [ + "id", + "address" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "minimum": 1 + }, + "address": { + "$ref": "#/components/schemas/DeliveryAddressDto" + }, + "request": { + "type": "string", + "description": "ุทู„ุจ ุงู„ุชุณู„ูŠู…" + } + } + }, + "PointHistoryBundleResponseDto": { + "type": "object", + "required": [ + "PointHistoyDto" + ], + "properties": { + "PointHistories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PointHistoryResponseDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "PointHistoryResponseDto": { + "type": "object", + "required": [ + "id", + "title", + "amount", + "amountType", + "expiredDetails", + "occurrenceAtMillis", + "occurrenceType", + "occurrenceId" + ], + "properties": { + "id": { + "type": "string", + "description": "ุชุงุฑูŠุฎ ุงู„ู†ู‚ุทุฉ ู…ุนุฑู ูุฑูŠุฏ" + }, + "title": { + "type": "string" + }, + "subTitle": { + "type": "string" + }, + "amount": { + "type": "integer", + "format": "int64" + }, + "amountType": { + "$ref": "#/components/schemas/PointAmountTypeEnum" + }, + "expiredDetails": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PointAccumulateDetailResponseDto" + } + }, + "occurrenceAtMillis": { + "description": "ูˆู‚ุช ุญุฏูˆุซ ุณุฌู„ ุงู„ุชุฑุงูƒู… (epochMilliSeconds)", + "type": "integer", + "format": "int64" + }, + "occurrenceType": { + "$ref": "#/components/schemas/PointOccurrenceTypeEnum" + }, + "occurrenceId": { + "description": "ุฃุฑุจุงุน ู…ุฎุชู„ูุฉ ุญุณุจ ุญุฏูˆุซ ุงู„ู…ุนุฑูู†ูˆุน ุงุณุชุญู‚ุงู‚ ุงู„ู†ู‚ุงุท", + "type": "string" + } + } + }, + "PointAmountTypeEnum": { + "oneOf": [ + { + "const": "PLUS" + }, + { + "const": "MINUS" + } + ] + }, + "PointOccurrenceTypeEnum": { + "oneOf": [ + { + "const": "ACCUMULATE_EVENT" + }, + { + "const": "ACCUMULATE_ORDER_ACCEPT" + }, + { + "const": "WITHDRAW_ORDER_CANCEL" + }, + { + "const": "USE_ADMIN" + }, + { + "const": "ACCUMULATE_ADMIN" + }, + { + "const": "USE_ORDER_CREATE" + }, + { + "const": "EXPIRED" + } + ], + "description": "- ู†ูˆุน ุญุฏุซ ุชุฑุงูƒู…/ุงุณุชุฎุฏุงู…/ุชุฏู…ูŠุฑ/ุฅู„ุบุงุก - ู…ุชุฑุงูƒู… ุจูˆุงุณุทุฉ ุญุฏุซ ACCUMULATE_EVENT - ACCUMULATE_ORDER_ACCEPT ู…ุชุฑุงูƒู… ุจูˆุงุณุทุฉ ุชุฃูƒูŠุฏ ุงู„ุทู„ุจ - ู…ุน DRAW_ORDER_CANCEL ุงุณุชุฑุฏุงุฏ ุงู„ุฃู…ูˆุงู„ ุงู„ู…ุชุฑุงูƒู…ุฉ ุนู† ุทุฑูŠู‚ ุฅู„ุบุงุก ุงู„ุทู„ุจ - USE_ADMIN ูŠุชู… ุฎุตู…ู‡ ุจูˆุงุณุทุฉ ุงู„ู…ุณุคูˆู„ - ACCUMULATE_ADMIN ู…ุชุฑุงูƒู… ุจูˆุงุณุทุฉ ุณู„ุทุฉ ุงู„ู…ุณุคูˆู„ - USE_ORDER_CREATE ุนู† ุทุฑูŠู‚ ุฅู†ุดุงุก ุงู„ุทู„ุจ ุงู„ู…ุณุชุฎุฏู… - EXPIRED ู…ู†ุชู‡ูŠ ุงู„ุตู„ุงุญูŠุฉ" + }, + "PointAccumulateDetailResponseDto": { + "type": "object", + "required": [ + "id", + "expiredAtMillis", + "amount" + ], + "properties": { + "id": { + "description": "ุชุงุฑูŠุฎ ุงู„ู†ู‚ุทุฉ ู…ุนุฑู ู…ูุตู„ ูุฑูŠุฏ ู…ู† ู†ูˆุนู‡", + "type": "string" + }, + "expiredAtMillis": { + "type": "integer", + "format": "int64" + }, + "amount": { + "type": "integer", + "format": "int64" + } + } + }, + "NowUsablePointDto": { + "type": "object", + "required": [ + "amount" + ], + "properties": { + "amount": { + "type": "integer", + "format": "int64" + } + } + }, + "PromotionAttendedStateDto": { + "type": "object", + "required": [ + "attended" + ], + "properties": { + "attended": { + "type": "boolean" + } + } + }, + "ProductAggregationDto": { + "type": "object", + "description": "ุชุฌู…ูŠุน ุงู„ู…ู†ุชุฌ", + "required": [ + "productFeatureGroupAggregationList" + ], + "properties": { + "totalCount": { + "type": "integer", + "format": "int64" + }, + "productFeatureGroupAggregationList": { + "deprecated": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductFeatureGroupAggregationDto" + } + }, + "productAggregationGroup": { + "$ref": "#/components/schemas/ProductAggregationGroupDto" + } + } + }, + "ProductAggregationGroupDto": { + "type": "object", + "description": "ู…ุฌู…ูˆุนุฉ ุงู„ู…ุนู„ูˆู…ุงุช ุงู„ุฅุฌู…ุงู„ูŠุฉ ู„ู„ู…ู†ุชุฌ", + "required": [ + "productFeatureGroupAggregationList", + "productCategoryAggregationList", + "brandAggregationList" + ], + "properties": { + "productFeatureGroupAggregationList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductFeatureGroupAggregationDto" + } + }, + "productCategoryAggregationList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryAggregationDto" + } + }, + "brandAggregationList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BrandAggregationDto" + } + } + } + }, + "ProductFeatureGroupAggregationDto": { + "type": "object", + "description": "ูุฑุฒ ุนุฏุฏ ุนู„ุงู…ุงุช ุงู„ุณู…ุงุช ุญุณุจ ุงู„ู…ุฌู…ูˆุนุฉ ุจุชุฑุชูŠุจ ุชู†ุงุฒู„ูŠ.", + "properties": { + "group": { + "$ref": "#/components/schemas/ProductFeatureGroupDto" + }, + "productFeatureAggregation": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductFeatureAggregationDto" + } + } + } + }, + "ProductFeatureAggregationDto": { + "type": "object", + "properties": { + "productFeature": { + "$ref": "#/components/schemas/ProductFeatureDto" + }, + "count": { + "type": "integer", + "format": "int64" + } + } + }, + "ProductCategoryAggregationDto": { + "type": "object", + "properties": { + "categoryId": { + "type": "string" + }, + "count": { + "type": "integer", + "format": "int64" + } + } + }, + "BrandAggregationDto": { + "type": "object", + "properties": { + "brandName": { + "type": "string" + }, + "count": { + "type": "integer", + "format": "int64" + } + } + }, + "ProductFeatureListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductFeatureDto" + } + } + } + }, + "ProductFeatureDto": { + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string" + }, + "title": { + "type": "string" + }, + "groupId": { + "type": "string" + }, + "groupTitle": { + "type": "string" + } + } + }, + "ProductFeatureGroupDto": { + "type": "object", + "required": [ + "id", + "title" + ], + "properties": { + "id": { + "type": "string" + }, + "title": { + "type": "string" + } + } + }, + "UserReferralSummaryDto": { + "type": "object", + "required": [ + "totalAccrualPoint", + "totalReferralCount", + "totalUnopenedBonusBoxCount" + ], + "properties": { + "totalAccrualPoint": { + "description": "ุฅุฌู…ุงู„ูŠ ุงู„ู…ุจู„ุบ ุงู„ู…ุชุฑุงูƒู… ู…ู† ุชูˆุตูŠุงุช ุงู„ู…ุณุชุฎุฏู… (ุจู…ุง ููŠ ุฐู„ูƒ ุงู„ู…ูƒุงูุขุช ุงู„ุฅุถุงููŠุฉ)", + "type": "integer", + "format": "int64" + }, + "totalReferralCount": { + "description": "ุงู„ุนุฏุฏ ุงู„ุฅุฌู…ุงู„ูŠ ู„ุชูˆุตูŠุงุช ุงู„ู…ุณุชุฎุฏู…", + "type": "integer", + "format": "int64" + }, + "totalUnopenedBonusBoxCount": { + "description": "ุนุฏุฏ ุตู†ุงุฏูŠู‚ ุงู„ู…ูƒุงูุขุช ุงู„ุชูŠ ู„ู… ูŠุชู… ูุชุญู‡ุง ุจุนุฏ", + "type": "integer", + "format": "int64" + } + } + }, + "UserReferralRewardSummaryDto": { + "type": "object", + "required": [ + "totalAccrualPoint", + "totalReferral" + ], + "properties": { + "totalAccrualPoint": { + "type": "integer", + "format": "int64" + } + } + }, + "UserReferralBonusBoxOpenResultDto": { + "type": "object", + "required": [ + "pointAmount" + ], + "properties": { + "pointAmount": { + "type": "integer", + "format": "int64", + "description": "ุงู„ู†ู‚ุงุท ุงู„ู…ูƒุชุณุจุฉ ู…ู† BonusBox" + } + } + }, + "UserReferralRewardPolicyDto": { + "type": "object", + "required": [ + "totalAccrualLimitByReferral", + "validDaysByReferral", + "joinRewardAmountForReferee", + "bonusBoxPolicies" + ], + "properties": { + "totalAccrualLimitByReferral": { + "type": "integer", + "format": "int64" + }, + "validDaysByReferral": { + "type": "integer", + "format": "int32" + }, + "joinRewardAmountForReferee": { + "type": "integer", + "format": "int64" + }, + "bonusBoxPolicies": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BonusBoxPolicyDto" + } + } + } + }, + "BonusBoxPolicyDto": { + "type": "object", + "description": "ุณูŠุงุณุฉ ุฅุตุฏุงุฑ ุตู†ุงุฏูŠู‚ ุงู„ู…ูƒุงูุขุช", + "required": [ + "bonusRewardType", + "referralCount" + ], + "properties": { + "bonusRewardType": { + "$ref": "#/components/schemas/BonusRewardTypeEnum" + }, + "referralCount": { + "description": "ุนุฏุฏ ุงู„ุฅุญุงู„ุงุช ุงู„ุชูŠ ูŠุฌุจ ุชู„ุจูŠุชู‡ุง ู„ู„ุญุตูˆู„ ุนู„ู‰ BonusBox", + "type": "integer", + "format": "int32" + } + } + }, + "BonusRewardTypeEnum": { + "oneOf": [ + { + "const": "REPEAT" + }, + { + "const": "ONE_TIME" + } + ], + "description": "ุฃู†ูˆุงุน ุณูŠุงุณุงุช ุฅุตุฏุงุฑ ุตู†ุฏูˆู‚ ุงู„ู…ูƒุงูุฃุฉ: * ุงู„ู…ูƒุงูุฃุฉ ุงู„ู…ุชูƒุฑุฑุฉ (REPEAT): ูŠุชู… ุฏูุน ุตู†ุฏูˆู‚ ุงู„ู…ูƒุงูุฃุฉ ููŠ ูƒู„ ู…ุฑุฉ ูŠุชู… ููŠู‡ุง ุงุณุชูŠูุงุก ุนุฏุฏ ุงู„ุฅุญุงู„ุงุช (ุนู„ู‰ ุณุจูŠู„ ุงู„ู…ุซุงู„ุŒ ุฅุฐุง ุชู… ุงู„ุชุนูŠูŠู† ุนู„ู‰ 5ุŒ ูŠุชู… ุฏูุนู‡ุง ูƒู„ 5ุŒ 10ุŒ 15ุŒ 20...) * ู…ูƒุงูุฃุฉ ู„ู…ุฑุฉ ูˆุงุญุฏุฉ (ONE_TIME) : ุนู†ุฏ ุงุณุชูŠูุงุก ReferralCount ุงู„ุฏูุน ู„ู…ุฑุฉ ูˆุงุญุฏุฉ" + }, + "UserReferralRewardEstimationRequestDto": { + "type": "object", + "required": [ + "phoneNumbers" + ], + "properties": { + "phoneNumbers": { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + } + }, + "UserReferralRewardEstimationDto": { + "type": "object", + "required": [ + "phoneNumber", + "pointAmount", + "rewarded" + ], + "properties": { + "phoneNumber": { + "type": "string" + }, + "pointAmount": { + "type": "integer", + "format": "int64", + "description": "ูŠู‚ุฏุฑ ู…ุจู„ุบ ุงู„ุงุฏุฎุงุฑ ุงู„ู…ูˆุตู‰ ุจู‡" + }, + "rewarded": { + "type": "boolean", + "description": "ู…ุง ุฅุฐุง ูƒู†ุช ู‚ุฏ ุชู„ู‚ูŠุช ุจุงู„ูุนู„ ุชุนูˆูŠุถู‹ุง ุนู† ุฅุญุงู„ุชูƒ" + } + } + }, + "UserReferralRewardEstimationListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserReferralRewardEstimationDto" + } + } + } + }, + "CreateUserReferralRequestDto": { + "type": "object", + "required": [ + "phoneNumber", + "referrerName", + "dynamicLink" + ], + "properties": { + "phoneNumber": { + "type": "string" + }, + "referrerName": { + "type": "string" + }, + "dynamicLink": { + "type": "string" + }, + "message": { + "type": "string" + } + } + }, + "CreateUserReferralResponseDto": { + "type": "object", + "required": [ + "reward" + ], + "properties": { + "reward": { + "$ref": "#/components/schemas/ReferralRewardResultDto" + } + } + }, + "CreateProductReferralRequestDto": { + "type": "object", + "required": [ + "orderLineId", + "productId", + "referralCode" + ], + "properties": { + "orderLineId": { + "type": "string" + }, + "productId": { + "type": "string" + }, + "referralCode": { + "type": "string" + } + } + }, + "ReferralRewardResultDto": { + "type": "object", + "description": "ู…ุนู„ูˆู…ุงุช ู…ูƒุงูุฃุฉ ุงู„ุฅุญุงู„ุฉ", + "required": [ + "pointAmount" + ], + "properties": { + "pointAmount": { + "type": "integer", + "format": "int64", + "description": "ู…ุจู„ุบ ุงู„ุชูˆููŠุฑ" + } + } + }, + "JoinReferredUserRequestDto": { + "type": "object", + "required": [ + "referralCode" + ], + "properties": { + "referralCode": { + "type": "string" + } + } + }, + "JoinReferredUserResponseDto": { + "type": "object", + "required": [ + "reward" + ], + "properties": { + "reward": { + "$ref": "#/components/schemas/ReferralRewardResultDto" + } + } + }, + "ActiveGameListResponse": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GameDto" + } + } + } + }, + "GameUserProgressInfoResponse": { + "type": "object", + "required": [ + "level", + "exp", + "requiredExpToNextLevel", + "inGameCredit", + "isGameAchievable", + "gameAchievedCount" + ], + "properties": { + "level": { + "type": "integer", + "format": "int32" + }, + "exp": { + "type": "integer", + "format": "int32" + }, + "requiredExpToNextLevel": { + "type": "integer", + "format": "int32" + }, + "inGameCredit": { + "type": "integer", + "format": "int32" + }, + "isGameAchievable": { + "type": "boolean" + }, + "gameAchievedCount": { + "type": "integer", + "format": "int32" + } + } + }, + "GameUseInGameCreditRequest": { + "type": "object", + "required": [ + "useCredit" + ], + "properties": { + "useCredit": { + "type": "integer", + "format": "int32" + } + } + }, + "GameDto": { + "type": "object", + "required": [ + "gameId", + "title", + "rewardTitle" + ], + "properties": { + "gameId": { + "type": "string" + }, + "title": { + "type": "string" + }, + "rewardTitle": { + "description": "ุงุณู… ุงู„ู…ูƒุงูุฃุฉ (ู…ุซุงู„: ุฑู…ุฒ ู‡ุฏูŠุฉ ุงู„ู‚ู‡ูˆุฉ)", + "type": "string" + } + } + }, + "GameMissionsResponse": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GameMissionDto" + } + } + } + }, + "GameMissionAchieveRequest": { + "type": "object", + "required": [ + "missionType" + ], + "properties": { + "missionType": { + "$ref": "#/components/schemas/GameMissionTypeEnum" + }, + "referenceId": { + "description": "ุญู‚ู„ ูŠุญุชูˆูŠ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช ุฅุถุงููŠุฉ ุญุณุจ ุงู„ู…ู‡ู…ุฉ (ู…ุซู„ ู…ุนุฑู ุงู„ู…ุนุฑุถ ุงู„ุฎุงุต)", + "type": "string" + } + } + }, + "GameMissionRewardReceiveResponse": { + "type": "object", + "required": [ + "inGameCredit" + ], + "properties": { + "inGameCredit": { + "type": "integer", + "format": "int32" + } + } + }, + "GameMissionDto": { + "type": "object", + "required": [ + "id", + "title", + "inGameCreditReward", + "missionType", + "completeCount", + "isRewardReceivable" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "inGameCreditReward": { + "type": "integer", + "format": "int32" + }, + "repeatIntervalInMins": { + "type": "integer", + "format": "int64" + }, + "missionType": { + "$ref": "#/components/schemas/GameMissionTypeEnum" + }, + "referenceId": { + "description": "ุญู‚ู„ ูŠุญุชูˆูŠ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช ุฅุถุงููŠุฉ ุญุณุจ ุงู„ู…ู‡ู…ุฉ (ู…ุซู„ ู…ุนุฑู ุงู„ู…ุนุฑุถ ุงู„ุฎุงุต)", + "type": "string" + }, + "resetCycleDays": { + "type": "integer", + "format": "int32" + }, + "maxCompleteCount": { + "type": "integer", + "format": "int32" + }, + "lastCompletedAtMillis": { + "type": "integer", + "format": "int64" + }, + "completeCount": { + "type": "integer", + "format": "int32" + }, + "isRewardReceivable": { + "type": "boolean" + } + } + }, + "GameAchieveRequest": { + "type": "object", + "required": [ + "phoneNumber" + ], + "properties": { + "phoneNumber": { + "type": "string" + } + } + }, + "GameMissionTypeEnum": { + "oneOf": [ + { + "const": "PURCHASE_PRODUCT" + }, + { + "const": "FE_VALID_ATTENDANCE" + }, + { + "const": "FE_VALID_VIEWING_TO_30_SEC_RECOMMENDED" + }, + { + "const": "FE_VALID_VIEWING_TO_30_SEC_STYLE_SHOT" + }, + { + "const": "FE_VALID_VIEWING_TO_30_SEC_COLLECTION" + }, + { + "const": "FE_VALID_VIEWING_TO_30_SEC_NEW_IN_PRODUCT" + }, + { + "const": "FE_VALID_VIEWING_TO_30_SEC_BEST" + }, + { + "const": "FE_VALID_VIEWING_TO_30_SEC_HOT_DEAL" + }, + { + "const": "FE_VALID_VIEWING_TO_30_SEC_SHOPPING_MALL" + }, + { + "const": "FE_VALID_VIEWING_TO_30_SEC_DESIGNER" + } + ] + }, + "AutocompleteResponseDto": { + "type": "object", + "required": [ + "brands" + ], + "properties": { + "brands": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BrandAutocompleteCandidateDto" + } + } + } + }, + "BrandAutocompleteCandidateDto": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "ProductCategoryReviewGuideDataDto": { + "type": "object", + "required": [ + "textGuides", + "imageWithTitles", + "type", + "gridImage" + ], + "properties": { + "textGuides": { + "type": "array", + "items": { + "type": "string" + } + }, + "imageWithTitles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryReviewGuideImageWithTitleDto" + } + }, + "type": { + "$ref": "#/components/schemas/ProductCategoryReviewGuideTypeEnum" + }, + "gridImage": { + "type": "string" + } + } + }, + "ProductCategoryReviewGuideTypeEnum": { + "oneOf": [ + { + "const": "IMAGE_WITH_TITLE" + }, + { + "const": "GRID_IMAGE" + }, + { + "const": "NONE" + } + ], + "description": "ุฃู†ูˆุงุน ุฃุฏู„ุฉ ู…ุฑุงุฌุนุฉ ุงู„ุตูˆุฑ" + }, + "StyleShotListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StyleShotDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "StyleShotDto": { + "type": "object", + "required": [ + "id", + "styleShotImages", + "styleCategory", + "equippedProductItemIds" + ], + "properties": { + "id": { + "description": "ู…ุนุฑู ุฃุณู„ูˆุจ ุงู„ู„ู‚ุทุฉ", + "type": "string" + }, + "styleShotImages": { + "description": "ุนู†ูˆุงู† URL ู„ุตูˆุฑุฉ ู„ู‚ุทุฉ ุงู„ู†ู…ุท", + "type": "array", + "minItems": 1, + "maxItems": 4, + "items": { + "$ref": "#/components/schemas/StyleShotImageDto" + } + }, + "styleShotTags": { + "description": "ู‚ุงุฆู…ุฉ ู…ุนุฑูุงุช ุนู„ุงู…ุงุช ู†ู…ุท ุงู„ู„ู‚ุทุฉ", + "type": "array", + "items": { + "type": "string" + } + }, + "styleCategory": { + "$ref": "#/components/schemas/StyleCategoryDto" + }, + "equippedProductItemIds": { + "description": "ูŠุฑุชุฏูŠ ู…ุนุฑู ุนู†ุตุฑ ุงู„ู…ู†ุชุฌุŒ ุงุณุชุฌุงุจุฉ ุงู„ู‚ุงุฆู…ุฉ ุงู„ูุงุฑุบุฉ ูู‚ุท (ู…ู‡ู…ู„ุฉ)", + "type": "array", + "items": { + "type": "string" + } + }, + "text": { + "type": "string" + }, + "editor": { + "type": "string" + }, + "fashionModelHeightAsCentiMeter": { + "type": "integer", + "format": "int32" + }, + "fashionModelWeightAsKiloGram": { + "type": "integer", + "format": "int32" + }, + "fashionModelShoeSizeAsMilliMeter": { + "type": "integer", + "format": "int32" + } + } + }, + "EquippedProductListDto": { + "type": "object", + "required": [ + "equippedProducts", + "favoriteIds", + "freeReturnTargetProductIds" + ], + "properties": { + "equippedProducts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EquippedProductDto" + } + }, + "freeReturnTargetProductIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "StyleShotImageDto": { + "required": [ + "id", + "url_1x", + "url_2x", + "url_3x", + "priority" + ], + "properties": { + "id": { + "description": "ู…ุนุฑู ุงู„ุตูˆุฑุฉ", + "type": "string" + }, + "url_1x": { + "type": "string" + }, + "url_2x": { + "type": "string" + }, + "url_3x": { + "type": "string" + }, + "priority": { + "description": "ุงู„ุชุฑุชูŠุจ ุนู†ุฏ ุนุฑุถ ุงู„ุตูˆุฑ (ุชุฑุชูŠุจ ุชุตุงุนุฏูŠ ู…ู† 1)", + "minimum": 1, + "type": "integer", + "format": "int32" + } + } + }, + "StyleCategoryDto": { + "type": "object", + "required": [ + "id", + "name", + "priority" + ], + "properties": { + "id": { + "description": "ู…ุนุฑู ูุฆุฉ ุงู„ู†ู…ุท", + "type": "integer", + "format": "int64" + }, + "name": { + "description": "ูุฆุฉ ุงู„ู†ู…ุท ุงู„ุงุณู… ุงู„ูƒูˆุฑูŠ", + "type": "string" + }, + "representative_url_1x": { + "type": "string" + }, + "representative_url_2x": { + "type": "string" + }, + "representative_url_3x": { + "type": "string" + }, + "priority": { + "description": "ุงุทู„ุจ ุนู†ุฏ ุงู„ุจุญุซ ุนู† ูุฆุงุช ุงู„ุฃู†ู…ุงุท", + "type": "integer", + "format": "int32" + } + } + }, + "StyleCategoryListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StyleCategoryDto" + } + } + } + }, + "DeliveryPredictionListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeliveryPredictionDto" + } + } + } + }, + "DeliveryPredictionDto": { + "type": "object", + "required": [ + "kstDeliveryPredictionDate", + "probability" + ], + "properties": { + "kstDeliveryPredictionDate": { + "type": "string", + "description": "ุณู„ุณู„ุฉ ุชู†ุณูŠู‚ ISO-8601 (uuuu-MM-dd)" + }, + "probability": { + "description": "ุงุญุชู…ุงู„ ุงูƒุชู…ุงู„ ุงู„ุชุณู„ูŠู… ููŠ ุฐู„ูƒ ุงู„ุชุงุฑูŠุฎ", + "type": "integer", + "format": "int32" + } + } + }, + "PurchaseMeasurementsStatisticsListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PurchaseMeasurementsStatisticsDto" + } + } + } + }, + "PurchaseMeasurementsStatisticsDto": { + "type": "object", + "required": [ + "size", + "count", + "ratio" + ], + "properties": { + "size": { + "description": "ุนู†ูˆุงู† ุฎูŠุงุฑ ุญุฌู… ุงู„ู…ู†ุชุฌ", + "type": "string" + }, + "count": { + "description": "ุนุฏุฏ ุงู„ู…ุดุชุฑูŠุงุช", + "type": "integer", + "format": "int64" + }, + "ratio": { + "description": "ุงู„ู†ุณุจุฉ ุงู„ู…ุฆูˆูŠุฉ ู„ุฅุฌู…ุงู„ูŠ ุงู„ู…ุดุชุฑูŠุงุช", + "type": "integer", + "format": "int32" + } + } + }, + "PurchaseMeasurementsDto": { + "type": "object", + "required": [ + "bodySizeType", + "isSimilarBodySize", + "list" + ], + "properties": { + "bodySizeType": { + "$ref": "#/components/schemas/BodySizeTypeEnum" + }, + "isSimilarBodySize": { + "description": "ู…ุง ุฅุฐุง ูƒุงู† ูŠุชู… ุงู„ุชุนุฑู ุนู„ู‰ ุจูŠุงู†ุงุช ุงู„ุดุฑุงุก ุงู„ู…ู…ุงุซู„ุฉ", + "type": "boolean" + }, + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PurchaserSizeDto" + } + } + } + }, + "PurchaserSizeDto": { + "type": "object", + "required": [ + "purchaserBodySize", + "purchaseSizeOptionName" + ], + "properties": { + "purchaserBodySize": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PurchaserBodySizeDto" + } + }, + "purchaseSizeOptionName": { + "description": "ุนู†ูˆุงู† ุฎูŠุงุฑ ุงู„ุญุฌู… ุงู„ุฐูŠ ุชู… ุดุฑุงุคู‡", + "type": "string" + } + } + }, + "PurchaserBodySizeDto": { + "type": "object", + "required": [ + "type", + "value" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/BodySizeTypeEnum" + }, + "value": { + "description": "ุญุฌู… ุงู„ู…ุดุชุฑูŠ", + "type": "integer", + "format": "int32" + } + } + }, + "BodySizeTypeEnum": { + "oneOf": [ + { + "const": "HEIGHT_AS_CENTI_METER" + }, + { + "const": "WEIGHT_AS_KILO_GRAM" + }, + { + "const": "TOP_SIZE" + }, + { + "const": "BOTTOM_SIZE_AS_INCH" + }, + { + "const": "SHOE_SIZE_AS_MILLI_METER" + } + ] + }, + "AttendanceCheckHistoryListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AttendanceCheckHistoryDto" + } + } + } + }, + "AttendanceCheckHistoryDto": { + "type": "object", + "required": [ + "days", + "attended", + "rewardPolicyType", + "pointAmount" + ], + "properties": { + "days": { + "description": "ูŠูˆู… ุงู„ุชุญู‚ู‚ ู…ู† ุงู„ุญุถูˆุฑ ู†", + "type": "integer", + "format": "int32" + }, + "pointAmount": { + "description": "ู…ุจู„ุบ ุงู„ู†ู‚ุทุฉ ุนู†ุฏ ุงู„ู…ุดุงุฑูƒุฉ ููŠ ูุญุต ุงู„ุญุถูˆุฑ", + "type": "integer", + "format": "int64" + }, + "attended": { + "description": "ุงู„ู…ุดุงุฑูƒุฉ ููŠ ูุญุต ุงู„ุญุถูˆุฑ", + "type": "boolean" + }, + "attendedAt": { + "description": "ุงู„ุชุญู‚ู‚ ู…ู† ุงู„ุญุถูˆุฑ ูˆู‚ุช ุงู„ู…ุดุงุฑูƒุฉ EpochMillis (ูุงุฑุบ ุฅุฐุง ู„ู… ูŠูƒู† ู…ูˆุฌูˆุฏู‹ุง)", + "type": "integer", + "format": "int64" + }, + "rewardPolicyType": { + "$ref": "#/components/schemas/AttendanceRewardPolicyTypeEnum" + } + } + }, + "ApiErrorResponse": { + "type": "object", + "properties": { + "msg": { + "type": "string", + "description": "ุณุจุจ ุงู„ุฎุทุฃ" + }, + "traceId": { + "type": "string", + "description": "ู…ุนุฑู ุงู„ุชุชุจุน ู„ู„ุชุตุญูŠุญ" + }, + "code": { + "oneOf": [ + { + "const": -999999 + }, + { + "const": -888888 + }, + { + "const": 1 + }, + { + "const": 2 + }, + { + "const": 3 + }, + { + "const": 4 + }, + { + "const": 5 + }, + { + "const": 6 + }, + { + "const": 7 + }, + { + "const": 1001 + }, + { + "const": 1002 + }, + { + "const": 1003 + }, + { + "const": 1004 + }, + { + "const": 60001 + }, + { + "const": 60002 + }, + { + "const": 61001 + }, + { + "const": 61002 + }, + { + "const": 61003 + }, + { + "const": 61004 + }, + { + "const": 61005 + }, + { + "const": 62001 + }, + { + "const": 62002 + }, + { + "const": 70001 + }, + { + "const": 70003 + }, + { + "const": 2001 + }, + { + "const": 2002 + }, + { + "const": 3001 + }, + { + "const": 4001 + }, + { + "const": 4002 + }, + { + "const": 5001 + }, + { + "const": 6001 + }, + { + "const": 6002 + }, + { + "const": 6003 + }, + { + "const": 7001 + }, + { + "const": 7002 + }, + { + "const": 7003 + }, + { + "const": 7004 + }, + { + "const": 7005 + }, + { + "const": 7006 + }, + { + "const": 7007 + }, + { + "const": 7008 + }, + { + "const": 7009 + }, + { + "const": 7010 + }, + { + "const": 7011 + }, + { + "const": 8001 + }, + { + "const": 9001 + } + ], + "x-enum-varnames": [ + "INTERNAL_FAILURE", + "EXTERNAL_FAILURE", + "ALREADY_EXISTS", + "NOT_AUTHORIZED", + "INVALID_VALUE", + "RESOURCE_NOT_FOUND", + "LIMITATION_EXCEEDED", + "LOGIN_REQUIRED", + "ACCESS_DENIED", + "ACCESS_TOKEN_EXPIRED", + "REFRESH_TOKEN_EXPIRED", + "INVALID_ACCESS_TOKEN", + "INVALID_REFRESH_TOKEN", + "COUPON_NOT_ENABLED", + "COUPON_NOT_CONSUMABLE", + "COUPON_ISSUE_BEFORE_BEGIN", + "COUPON_ISSUE_AFTER_END", + "COUPON_ISSUE_LIMIT_EXCEEDED", + "COUPON_ISSUE_LIMIT_PER_USER_EXCEEDED", + "COUPON_ISSUE_NOT_TARGET", + "COUPON_BOOK_ISSUABLES_NOT_EXIST", + "DISPLAYING_COUPONS_ISSUABLE_NOT_EXIST", + "PAYMENT_NOT_FULLY_PAID", + "MINIMUM_PAYMENT_PRICE_LIMIT_EXCEPTION", + "REVIEW_REPORTED_BY_SELF", + "REVIEW_REPORTED_TWICE", + "VALIDATAION_BANK_ACCOUNT_FAILURE", + "DUPLICATED_MALL_PRODUCT_CODE", + "PRODUCT_WITHOUT_POLICY_TARGET", + "DUPLICATED_BRAND_CODE", + "SEND_DELIVERY_TRACE_REQUEST_FAILED", + "RECEIVE_DELIVERY_TRACE_RESULT_FAILED", + "SEND_DELIVERY_TRACE_RESULT_RESPONSE_FAILED", + "TICKET_PROCESSING_IS_REQUIRED_TO_CONFIRM_RECEIPT", + "CAN_ONLY_CONFIRM_RECEIPT_OF_PAID_ORDER_LINE", + "CANNOT_CONFIRM_RECEIPT_WHEN_DELIVERY_NOT_COMPLETE", + "CANNOT_REQUEST_REFUND_AFTER_CONFIRM_RECEIPT", + "LACK_OF_POINT", + "ORDER_LINE_COUNT_LIMIT_PER_ORDER_EXCEEDED", + "ORDER_ALREADY_DISPATCHED", + "CANNOT_CHANGE_DELIVERY_AREA", + "ORDER_UNAVAILABLE_PRODUCT_ITEM", + "CANNOT_APPEND_TICKET", + "CANNOT_EXCEED_ALREADY_REQUESTED_AMOUNT", + "ATTENDANCE_CHECK_COMPLETED", + "PRODUCT_NOT_BELONGS_TO_BRAND" + ] + } + } + } + }, + "securitySchemes": { + "damoa-token": { + "type": "http", + "scheme": "bearer", + "bearerFormat": "JWT" + } + } + }, + "x-samchon-emended": true +} \ No newline at end of file diff --git a/assets/output/damoa.swagger.en.json b/assets/output/damoa.swagger.en.json new file mode 100644 index 0000000..a7e7135 --- /dev/null +++ b/assets/output/damoa.swagger.en.json @@ -0,0 +1,20539 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "Damoa API Specification", + "description": "Damoa API Specification", + "version": "1.0.0" + }, + "servers": [ + { + "url": "https://api.queenit.kr", + "description": "production" + }, + { + "url": "https://api.dev.queenit.kr", + "description": "development" + }, + { + "url": "http://localhost:8080", + "description": "local" + }, + { + "url": "https://{namespace}-app-api.dev.rapportlabs.cloud", + "variables": { + "namespace": { + "default": "damoa" + } + } + } + ], + "tags": [ + { + "name": "metadata", + "description": "metadata api" + }, + { + "name": "verification", + "description": "verification api" + }, + { + "name": "hello", + "description": "hello api" + }, + { + "name": "favorite", + "description": "favorite api" + }, + { + "name": "best", + "description": "best api" + }, + { + "name": "product", + "description": "product api" + }, + { + "name": "ageGroup", + "description": "ageGroup api" + }, + { + "name": "home", + "description": "home api" + }, + { + "name": "newArrival", + "description": "new arrival api" + }, + { + "name": "hotDeal", + "description": "hot deal api" + }, + { + "name": "recommendation", + "description": "recommendation api" + }, + { + "name": "promotion", + "description": "promotion api" + }, + { + "name": "cart", + "description": "cart api" + }, + { + "name": "account", + "description": "account api" + }, + { + "name": "order", + "description": "order api" + }, + { + "name": "payment", + "description": "payment api" + }, + { + "name": "banner", + "description": "banner api" + }, + { + "name": "collection", + "description": "collection api" + }, + { + "name": "search", + "description": "search api" + }, + { + "name": "autocomplete", + "description": "autocomplete api" + }, + { + "name": "coupon", + "description": "coupon api" + }, + { + "name": "review", + "description": "review api" + }, + { + "name": "reviewStatistics", + "description": "reviewStatistics api" + }, + { + "name": "userProfile", + "description": "user profile api" + }, + { + "name": "image", + "description": "image api" + }, + { + "name": "prompt", + "description": "prompt api" + }, + { + "name": "shopLive", + "description": "shopLive api" + }, + { + "name": "point", + "description": "point api" + }, + { + "name": "productRanking", + "description": "productRanking api" + }, + { + "name": "tier", + "description": "tier api" + }, + { + "name": "styleShot", + "description": "style shot api" + }, + { + "name": "attendanceCheck", + "description": "attendance check api" + }, + { + "name": "tag", + "description": "tag api" + } + ], + "paths": { + "/metadata": { + "get": { + "description": "metadata api", + "operationId": "getMetadata", + "tags": [ + "metadata" + ], + "responses": { + "200": { + "description": "metadata response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MetadataDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/hello": { + "get": { + "summary": "hello world", + "operationId": "hello", + "tags": [ + "hello" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to hello", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/verifications/sms": { + "post": { + "summary": "send verification code by sms [invalid phone number -> ApiErrorType.INVALID_VALUE]", + "operationId": "sendVerifCodeBySms", + "tags": [ + "verification" + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SendVerifCodeRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to send verification code", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SendVerifCodeResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/verifications": { + "put": { + "summary": "verify code [invalid token or code -> ApiErrorType.INVALID_VALUE]", + "operationId": "verifyCode", + "tags": [ + "verification" + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VerifyCodeRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to verify code", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VerifyCodeResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/verifications/kakao": { + "put": { + "summary": "verify kakao access token", + "operationId": "verifyKakaoToken", + "tags": [ + "verification" + ], + "description": "- For users authenticated through Kakao login, request verifiedToken using the issued Kakao API access token and phone number - Phone number is in international call format (e.g. +82 10-1111-1111) - Login/sign up is processed by calling signUpV2 API using the issued verifiedToken", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VerifyKakaoTokenRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to verify", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VerifyKakaoTokenResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/migrate-user": { + "post": { + "summary": "firebase auth user -> damoa auth user conversion", + "description": "> Convert users who were using firebase auth in the existing old client to use damoa auth. When a firebase auth access token is received, the user information is transferred to damoa auth and information is provided to use the access/refresh token of damoa auth. 1. (Client) If there is firebase auth information, refresh the existing firebase auth token. 2. (Client) Call a separate endpoint defined on the server side to convert firebase auth user -> damoa auth user (login required) 3. (Server) Check the token vendor in the access token information sent by the client -> Check whether it was issued by firebase or damoa 4. (Server) If it is confirmed to be a token issued by firebase -> Check once more whether the access token is valid 5. (Server) If the access token is confirmed to be valid -> Store the firebase auth user information in the damoa auth user table 6. (Server) damoa auth user After saving the firebase auth user information in the table, send the damoa auth token (access & refresh) as a response. 7. (Client) Use the damoa auth token. Send the access token in the request body while logged in (setting the `Authorization` request header).", + "operationId": "migrateUser", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FirebaseAuthUserMigrationRequest" + } + } + } + }, + "responses": { + "200": { + "description": "success to migrate user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DamoaTokenDto" + } + } + } + }, + "204": { + "description": "If you are already a damoa auth user" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/signin/anonymous": { + "post": { + "summary": "Log in as anonymous user", + "description": "Login as anonymous user [invalid token -> ApiErrorType.INVALID_VALUE]", + "operationId": "signInAnonymously", + "tags": [ + "account" + ], + "responses": { + "200": { + "description": "success to sign in anonymously", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DamoaTokenDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/signup/providers/{providerType}": { + "post": { + "summary": "Authenticated User Login/Sign Up", + "description": "- Called when a previously registered user logs in again or signs up for the first time - Currently supports `SMS` and `KAKAO` as `providerType` - An error occurs if a different providerType is used - Other auth providers (facebook, ..) may be added in the future - The authorization information entered in the request header contains the access token issued after calling the anonymous signup API - `Bearer {{ anonymous access token }}` format - Access tokens issued through firebase auth cannot be used.", + "operationId": "signUpV2", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "providerType", + "schema": { + "$ref": "#/components/schemas/ProviderTypeEnum" + }, + "required": true, + "description": "auth provider (SMS, KAKAO, ..)" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SignUpRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to signup", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DamoaTokenDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/refresh": { + "post": { + "summary": "Renew access/refresh token for authenticated or anonymous users", + "description": "Renew access/refresh token for authenticated or anonymous users", + "operationId": "refreshToken", + "tags": [ + "account" + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DamoaTokenRefreshRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to refresh tokens", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DamoaTokenDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/accounts": { + "get": { + "summary": "Used when checking the user's account information.", + "description": "Only users using damoa auth can use it normally (including anonymous users)", + "operationId": "getDamoaLoginAccount", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to retrieve account info", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LoginAccountDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/signout": { + "post": { + "summary": "sign out", + "operationId": "signOut", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to signout" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/logout": { + "post": { + "summary": "logout", + "operationId": "logout", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to logout" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/external-uid": { + "get": { + "summary": "get external uid", + "description": "Returns an external uid that can be used for external API calls for the user..", + "operationId": "getExternalUid", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "external uid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExternalUidDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/payment-methods": { + "get": { + "summary": "get registered payment methods", + "description": "The user will receive a list of payment methods registered with QueenitPay..", + "operationId": "getPaymentMethods", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "registered payment methods", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaymentMethodResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/credentials/connect-pay": { + "get": { + "summary": "get connect pay credentials", + "description": "Returns credentials for using ConnectPay JS SDK.", + "operationId": "getConnectPayCredentials", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "connect pay clientKey and user specific customerKey", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectPayCredentialDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/favorites": { + "get": { + "summary": "get favorites", + "operationId": "getMyFavorites", + "tags": [ + "favorite" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "- my favorite product list - If Queenit instant discount is applied, `FavoriteProductDto` shows the amount with the instant discount applied - Affected fields: `price`, `productDiscountRate`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FavoriteProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/favorites/{productId}": { + "delete": { + "summary": "delete favorite", + "operationId": "deleteMyFavorite", + "tags": [ + "favorite" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "success to delete" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + }, + "put": { + "summary": "add favorite", + "operationId": "addMyFavorite", + "tags": [ + "favorite" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "success to add" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/best/products": { + "get": { + "summary": "get best products for recent specific period", + "operationId": "getBestAppProducts", + "tags": [ + "best" + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "required": true, + "description": "best products for this period", + "name": "period", + "schema": { + "$ref": "#/components/schemas/BestPeriodEnum" + } + }, + { + "in": "query", + "required": false, + "name": "categoryId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "description": "Age Code.", + "required": false, + "name": "ageGroupCode", + "schema": { + "$ref": "#/components/schemas/AgeGroupCodeEnum" + } + } + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- get best products for recent specific period - If Queenit instant discount is applied, `AppProductDto` shows the amount with the instant discount applied - Affected fields: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/best/brands/v2": { + "get": { + "summary": "get best brands for recent specific period", + "operationId": "getBestAppBrands", + "tags": [ + "best" + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "required": true, + "description": "best brands for this period", + "name": "period", + "schema": { + "$ref": "#/components/schemas/BestPeriodEnum" + } + }, + { + "in": "query", + "description": "Age Code.", + "required": false, + "name": "ageGroupCode", + "schema": { + "$ref": "#/components/schemas/AgeGroupCodeEnum" + } + } + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "get best brands for recent specific period", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BestBrandListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/best/WooRanking": { + "get": { + "summary": "get woo ranking products - DEPRECATED", + "operationId": "getWooRankingProducts", + "tags": [ + "best" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "woo ranking products - DEPRECATED", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/promotions/brands": { + "get": { + "summary": "get promotion brands", + "operationId": "getPromotedBrands", + "tags": [ + "promotion" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "promotion brands", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BrandListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/promotions/products": { + "get": { + "summary": "get promotion products", + "operationId": "getPromotionProducts", + "tags": [ + "promotion" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "- promotion products - If Queenit instant discount is applied, `ProductDto` shows the amount with the instant discount applied - Affected fields: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/promotions/connect-pay": { + "get": { + "summary": "get connect pay promotions", + "operationId": "getConnectPayPromotions", + "tags": [ + "promotion" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "connect-pay card discount promotions and interest-free installment policies", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectPayPromotionDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/promotions/toss": { + "get": { + "summary": "get toss payments promotions", + "operationId": "getTossPromotions", + "tags": [ + "promotion" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "toss card discount promotions policies and interest-free installment policies", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TossPaymentPromotionDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/newArrivals/products": { + "get": { + "summary": "get new arrival products - DEPRECATED", + "operationId": "getNewArrivalProducts", + "tags": [ + "newArrival" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "new products - DEPRECATED", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/promotions/products/discounted": { + "get": { + "deprecated": true, + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "description": "Please set orderBy to RECOMMENDATION as a default value.", + "name": "orderBy", + "required": true, + "schema": { + "$ref": "#/components/schemas/ProductOrderByEnum" + } + }, + { + "in": "query", + "required": false, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ], + "summary": "Get discounted promotion products by orderBy parameters", + "operationId": "getDiscountedPromotionProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- discounted promotion products by orderBy parameters - If Queenit instant discount is applied, `AppProductDto` shows the amount with the instant discount applied - Affected fields: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/discount-benefits": { + "get": { + "summary": "get product's discount benefits information", + "operationId": "getProductDiscountBenefits", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "result of product's discount benefits information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductDiscountBenefitsDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/shopping-mall": { + "get": { + "deprecated": true, + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "description": "Please set orderBy to RECOMMENDATION as a default value.", + "name": "orderBy", + "required": true, + "schema": { + "$ref": "#/components/schemas/ProductOrderByEnum" + } + }, + { + "in": "query", + "required": false, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ], + "summary": "Get shopping mall products by orderBy parameters", + "operationId": "getShoppingMallProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- shopping mall products by orderBy parameters - If Queenit instant discount is applied, `AppProductDto` shows the amount with the instant discount applied - Affected fields: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/keyword-related": { + "get": { + "summary": "Returns related products based on keywords.", + "operationId": "getKeywordRelatedProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "name": "keyword", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "verbose", + "required": false, + "schema": { + "description": "Parameter for debugging. If true, the log will be printed in much more detail..", + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Keyword related product results", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/related": { + "get": { + "summary": "Returns related products based on specific conditions.", + "operationId": "getRelatedProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "name": "brandId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "categoryId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "relationTargetProductIds", + "description": "Returns products associated with the products passed to this parameter..", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "name": "verbose", + "required": false, + "schema": { + "description": "Parameter for debugging. If true, the log will be printed in much more detail..", + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Related Products Results", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/personalized/products": { + "post": { + "deprecated": true, + "summary": "Get filtered personalized products", + "operationId": "getFilteredPersonalizedProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FilteredPersonalizedProductRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "- Get personalized products filtered by parameters", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + }, + "get": { + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "description": "Please set orderBy to RECOMMENDATION as a default value.", + "name": "orderBy", + "required": false, + "schema": { + "$ref": "#/components/schemas/ProductOrderByEnum" + } + }, + { + "in": "query", + "required": false, + "name": "categoryId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "required": false, + "name": "brandId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "description": "Age Code.", + "required": false, + "name": "ageGroupCode", + "schema": { + "$ref": "#/components/schemas/AgeGroupCodeEnum" + } + }, + { + "in": "query", + "required": false, + "name": "minPrice", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "maxPrice", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "mySizeOnly", + "schema": { + "type": "boolean" + } + }, + { + "in": "query", + "required": false, + "name": "tagId", + "deprecated": true, + "schema": { + "type": "integer", + "description": "(deprecated) use tagIdForBrandSourcing", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "tagIdForBrandSourcing", + "schema": { + "description": "Search for products for brandSourcingCode corresponding to tagId", + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "clickedProductIds", + "description": "- Clicked products. Used to provide personalized products. - The clickedProductAtMillis parameter must be passed together to convey information on the time each product was clicked..", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "required": false, + "name": "clickedProductAtMillis", + "description": "- The times when the product was clicked. Each time corresponds to a clickedProductIds parameter. - The sizes of the clickedProductIds and clickedProductAtMillis parameters must always be the same..", + "schema": { + "type": "array", + "items": { + "type": "number", + "format": "int64" + } + } + }, + { + "in": "query", + "required": false, + "name": "modelId", + "description": "- Which personalized model to use. (For A/B Testing) - Notion reference: https://www.notion.so/rapportlabs/AB-Protocol-c878d879ff0443cda929bb17d9b137c1", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "required": false, + "name": "postProcessingId", + "description": "- How to post-process the personalized results. (For A/B Testing) - Notion reference: https://www.notion.so/rapportlabs/AB-Protocol-c878d879ff0443cda929bb17d9b137c1", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "verbose", + "required": false, + "schema": { + "description": "Parameter for debugging. If true, the log will be printed in much more detail..", + "default": false, + "type": "boolean" + } + } + ], + "summary": "Get personalized recommendation products by filter", + "operationId": "getPersonalizedRecommendationProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- Get personalized recommendation products by filter and orderBy parameters", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/refined": { + "get": { + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "description": "Please set orderBy to RECOMMENDATION as a default value.", + "name": "orderBy", + "required": true, + "schema": { + "$ref": "#/components/schemas/ProductOrderByEnum" + } + }, + { + "in": "query", + "required": false, + "name": "categoryId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "required": false, + "name": "categoryIds", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "required": false, + "name": "brandId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "required": false, + "name": "brandIds", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "description": "Age Code.", + "required": false, + "name": "ageGroupCode", + "schema": { + "$ref": "#/components/schemas/AgeGroupCodeEnum" + } + }, + { + "in": "query", + "required": false, + "name": "minPrice", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "maxPrice", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "mySizeOnly", + "schema": { + "type": "boolean" + } + }, + { + "in": "query", + "description": "List of product attribute ids to filter on", + "required": false, + "name": "productFeatureIds", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "deprecated": true, + "required": false, + "description": "(DEPRECATED) Use enabledTotalCount, enabledProductFeatureAggregation, enabledProductCategoryAggregation, enabledBrandAggregation.", + "name": "enabledProductAggregation", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "Set to true if the total count is required in product aggregation..", + "name": "enabledTotalCount", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "Set to true if the number of product attributes is required in product aggregation..", + "name": "enabledProductFeatureAggregation", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "Set to true if product aggregation requires counts by product category..", + "name": "enabledProductCategoryAggregation", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "Set to true if you need to count by brand in product aggregation..", + "name": "enabledBrandAggregation", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "deprecated": true, + "description": "(deprecated) Use tagIdForBrandSourcing parameter", + "name": "tagId", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "tagIdForBrandSourcing", + "schema": { + "description": "Search for products for brandSourcingCode corresponding to tagId", + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "description": "ids for product tag filter", + "name": "tagIdsForProductTag", + "schema": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + } + }, + { + "in": "query", + "required": false, + "description": "Parameter to display products without product tags as well", + "name": "allowProductsWithoutTags", + "schema": { + "type": "boolean" + } + } + ], + "summary": "Get refined products by filter and orderBy parameters", + "operationId": "getRefinedProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- Get refined products by filter and orderBy parameters - If Queenit instant discount is applied, `AppProductDto` shows the amount with the instant discount applied - Affected fields: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/advertisement": { + "get": { + "parameters": [ + { + "in": "header", + "name": "page", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "description": "Please set orderBy to RECOMMENDATION as a default value.", + "name": "orderBy", + "required": false, + "schema": { + "$ref": "#/components/schemas/ProductOrderByEnum" + } + }, + { + "in": "query", + "required": false, + "name": "categoryId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "required": false, + "name": "minPrice", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "maxPrice", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "mySizeOnly", + "schema": { + "type": "boolean" + } + } + ], + "summary": "Get advertisement products by filter and orderBy parameters", + "operationId": "getAdvertisementProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- Get advertisement products by filter and orderBy parameters", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAdvertisementProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/detail/advertisement": { + "get": { + "parameters": [ + { + "in": "query", + "required": false, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ], + "summary": "Get advertisement products by filter and orderBy parameters", + "operationId": "getAdvertisementProductDetail", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- Get advertisement products in PDP", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAdvertisementProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products": { + "get": { + "parameters": [ + { + "in": "query", + "required": true, + "name": "ids", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "summary": "get products by ids parameter", + "description": "( count of ids is over 40 -> ApiErrorResponseCode.LIMITATION_EXCEEDED )", + "operationId": "getProducts", + "tags": [ + "product" + ], + "responses": { + "200": { + "description": "- products (unique and not ordered) by ids - If Queenit instant discount is applied, `ProductDto` shows the amount with the instant discount applied - Affected fields: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductSetDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/similar/v2": { + "get": { + "summary": "get image based similar product (v2)", + "operationId": "getImageBasedSimilarProductsV2", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minRating", + "schema": { + "type": "number", + "format": "int32" + } + }, + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "name": "modelId", + "required": false, + "description": "Which model to use. https://www.notion.so/rapportlabs/AB-Protocol-c878d879ff0443cda929bb17d9b137c1?pvs=4", + "schema": { + "type": "string", + "default": "TAG_SIM" + } + }, + { + "in": "query", + "name": "postProcessingId", + "description": "How to do post-processing. https://www.notion.so/rapportlabs/AB-Protocol-c878d879ff0443cda929bb17d9b137c1?pvs=4", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "verbose", + "required": false, + "schema": { + "description": "Parameter for debugging. If true, the log will be printed in much more detail..", + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "- Provide image-based similar products. (We will compare with v1 and deprecate specific versions based on the results.)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/similar": { + "get": { + "summary": "get image based similar product", + "operationId": "getImageBasedSimilarProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minRating", + "required": true, + "schema": { + "type": "number", + "format": "int32" + } + }, + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "- Provides image-based similar products.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/outfit": { + "get": { + "summary": "get image based outfit product", + "operationId": "getImageBasedOutfitProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minRating", + "required": true, + "schema": { + "type": "number", + "format": "int32" + } + }, + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "- Provides image-based coordination products.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/hotDeals/products": { + "get": { + "summary": "get hotDeal products", + "operationId": "getHotDealProducts", + "tags": [ + "hotDeal" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "- hot deal products - If Queenit instant discount is applied, `ProductDto` shows the amount with the instant discount applied - Affected fields: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/recommendations/categories": { + "get": { + "summary": "get recommended product categories", + "operationId": "getRecommendationCategories", + "tags": [ + "recommendation" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "recommendation categories", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/recommendations/categories/{categoryId}/products": { + "get": { + "summary": "get recommended products", + "operationId": "getRecommendedProductsByCategory", + "tags": [ + "recommendation" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "- recommended products - If Queenit instant discount is applied, `ProductDto` shows the amount with the instant discount applied - Affected fields: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/recommendations/products": { + "get": { + "summary": "get recommended products", + "operationId": "getRecommendedProducts", + "tags": [ + "recommendation" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "- recommended products - If Queenit instant discount is applied, `ProductDto` shows the amount with the instant discount applied - Affected fields: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/tag-groups": { + "get": { + "parameters": [ + { + "in": "query", + "name": "type", + "required": true, + "schema": { + "$ref": "#/components/schemas/TagTypeEnum" + } + } + ], + "summary": "get tag-groups by type", + "description": "Get tag group information based on parameters", + "operationId": "getTagGroups", + "tags": [ + "tag" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "List of tag groups", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagGroupListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/tags": { + "get": { + "parameters": [ + { + "in": "query", + "name": "type", + "required": false, + "schema": { + "$ref": "#/components/schemas/TagTypeEnum" + } + }, + { + "in": "query", + "name": "groupId", + "required": false, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "summary": "get tags", + "description": "Get tag information.", + "operationId": "getTags", + "tags": [ + "tag" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "Get tag information based on conditions.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/release-estimate": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product estimate release at", + "operationId": "getProductEstimateRelease", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "Successful inquiry of product estimate release (estimated product release date)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReleaseEstimateDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/products/{productId}/page": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "upload product page", + "operationId": "uploadProductPage", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UploadProductPageRequest" + } + } + } + }, + "responses": { + "200": { + "description": "success to upload" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/products/{productId}": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product", + "operationId": "getProduct", + "description": "( can't find product -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- product - If Queenit instant discount is applied, `ProductDto` shows the amount with the instant discount applied - Affected fields: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/products/{productId}/personal": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get personal product", + "description": "( can't find product -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "getPersonalProduct", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- If Queenit instant discount is applied, `ProductDto` shows the amount with the instant discount applied - Affected fields: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PersonalProductDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/products/{productId}/items": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product items", + "operationId": "getProductItems", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "Successful query of product items(product options) list", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductItemListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/products/{productId}/item-availabilities": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product item availability list", + "description": "Returns a list of available product options for the given product.", + "operationId": "getProductItemAvailabilityList", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "List of product options available for purchase", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductItemAvailabilityDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/users/birth-year": { + "post": { + "summary": "save birth year for user", + "description": "save birth year in user profile", + "operationId": "saveUserBirthYear", + "tags": [ + "userProfile" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserBirthYearDto" + } + } + } + }, + "responses": { + "200": { + "description": "saved birth year of user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserBirthYearDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/users/body-size": { + "post": { + "summary": "save body size for user", + "description": "save body size", + "operationId": "saveUserBodySize", + "tags": [ + "userProfile" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserBodySizeDataDto" + } + } + } + }, + "responses": { + "200": { + "description": "saved body size of user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserBodySizeDataDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/users/profile": { + "get": { + "summary": "get user profile", + "description": "( can't find user profile -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "getUserProfile", + "tags": [ + "userProfile" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "user profile", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserProfileDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/users/delivery-addresses": { + "get": { + "summary": "get user delivery addresses", + "description": "Get the user's full list of shipping addresses (sorted by `retrievedAt`, descending)", + "operationId": "getUserDeliveryAddresses", + "tags": [ + "userProfile" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "user delivery address list", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserDeliveryAddressDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + }, + "put": { + "summary": "add user delivery address", + "description": "- Add the user's shipping address information or update `retrievedAt` - Update only if the address and shipping request are the same among the registered shipping addresses.", + "operationId": "addUserDeliveryAddress", + "tags": [ + "userProfile" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserDeliveryAddressAddRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to add user delivery address", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserDeliveryAddressDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/tier": { + "get": { + "summary": "get user's tier", + "operationId": "getTier", + "tags": [ + "tier" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "get user's tier", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TierDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/tier/next": { + "get": { + "summary": "get user's next tier information", + "operationId": "getNextTierInfo", + "tags": [ + "tier" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "get user's next tier information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NextTierInfoDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/images/{imageCategory}/uploadable-url": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "imageCategory", + "schema": { + "$ref": "#/components/schemas/ImageCategoryEnum" + } + }, + { + "in": "query", + "required": true, + "name": "filename", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "generate uploadable url to upload images for login user", + "operationId": "generateImageUploadableUrl", + "tags": [ + "image" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "uploadable image url", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UploadableImageResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "imageCategory", + "schema": { + "$ref": "#/components/schemas/ImageCategoryEnum" + } + }, + { + "in": "query", + "required": true, + "name": "filename", + "schema": { + "type": "string" + } + } + ] + } + }, + "/images/{imageCategory}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "imageCategory", + "schema": { + "$ref": "#/components/schemas/ImageCategoryEnum" + } + } + ], + "post": { + "deprecated": true, + "description": "(deprecated) please use generateImageUploadableUrl instead of this api", + "summary": "upload images for login user", + "operationId": "uploadImage", + "tags": [ + "image" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "required": [ + "image" + ], + "properties": { + "image": { + "type": "string", + "format": "binary" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "upload image", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UploadImageResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "imageCategory", + "schema": { + "$ref": "#/components/schemas/ImageCategoryEnum" + } + } + ] + } + }, + "/images/{imageCategory}/base64": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "imageCategory", + "schema": { + "$ref": "#/components/schemas/ImageCategoryEnum" + } + } + ], + "post": { + "summary": "upload images as base 64 for login user", + "operationId": "uploadImageBase64", + "tags": [ + "image" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Base64ImageUploadRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "upload image as base64", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UploadImageResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "imageCategory", + "schema": { + "$ref": "#/components/schemas/ImageCategoryEnum" + } + } + ] + } + }, + "/products/{productId}/reviews": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product reviews", + "operationId": "getProductReviews", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Product Reviews", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DisplayProductReviewListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/reviews/v2": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product reviews v2", + "operationId": "findProductReviews", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "page", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "required": false, + "name": "sortOrder", + "schema": { + "$ref": "#/components/schemas/ProductReviewSortOrderEnum" + } + } + ], + "responses": { + "200": { + "description": "Product Reviews", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DisplayProductReviewListDtoV2" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/reviews/representatives": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get representative product reviews", + "operationId": "getRepresentativeProductReviews", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "representative product reviews", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RepresentativeProductReviewListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/reviews/{reviewId}": { + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "put": { + "summary": "update product review", + "description": "Edit your own product review. - RESOURCE_NOT_FOUND: When the product review corresponding to the reviewId cannot be found. - ACCESS_DENIED: When trying to edit someone else's product review.", + "operationId": "updateProductReview", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateProductReviewRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "Updated product review", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReviewDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ] + } + }, + "/products/items/{productItemId}/review": { + "parameters": [ + { + "in": "path", + "name": "productItemId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "orderLineId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "create product review", + "operationId": "createProductReview", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReviewDataDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to create product review", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReviewDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productItemId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "orderLineId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/reviews/{reviewId}": { + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "get": { + "summary": "get product review", + "operationId": "getProductReview", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "Product review", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DisplayProductReviewDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ] + }, + "delete": { + "summary": "delete product review", + "operationId": "deleteProductReview", + "description": "Delete your own product review. - RESOURCE_NOT_FOUND: When the product review corresponding to the reviewId cannot be found. - ACCESS_DENIED: When trying to edit someone else's product review.", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to delete product review" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ] + } + }, + "/reviews/{reviewId}/favorites": { + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "post": { + "summary": "favorites product review", + "operationId": "favoritesProductReview", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "204": { + "description": "success to favorites product review" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ] + }, + "delete": { + "summary": "delete favorites product review", + "operationId": "deleteFavoritesProductReview", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to delete favorites product review" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ] + } + }, + "/user/reviews": { + "get": { + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "summary": "get created product reviews of users", + "operationId": "getMyProductReviews", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "created product reviews of users", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MyProductReviewListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/user/review-candidates": { + "get": { + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "summary": "get created product reviews of users", + "operationId": "getMyProductReviewCandidates", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product review candidates", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReviewCandidateListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/user/reviews/creatable-count": { + "get": { + "summary": "get count creatable product review of user", + "operationId": "countCreatableProductReviewOfUser", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "number of creative product reviews of users", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LongDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/user/reviews/created-count": { + "get": { + "summary": "get count created product review of user", + "operationId": "countCreatedProductReviewOfUser", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "number of created product reviews of users", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LongDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/user/reviews/exist": { + "get": { + "summary": "check user's review exist", + "operationId": "checkExistProductReviewOfUser", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "flag of does user created review before", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RequiredBooleanDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/user/reviews/accumulable-point": { + "get": { + "summary": "get user's accumulable point amount of review creation", + "operationId": "getAccumulablePointProductReviewCreationOfUser", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "accumulable point amount of when user created total creatable review", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RequiredLongDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/reviews/statistics/summary": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product review statistics summary", + "operationId": "getProductReviewStatisticsSummary", + "tags": [ + "reviewStatistics" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product review statistics summary", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReviewStatisticsSummaryDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/products/{productId}/reviews/statistics/size": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product review size statistics", + "operationId": "getProductSizeStatistics", + "tags": [ + "reviewStatistics" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product review size statistics", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductSizeStatisticsDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/products/{productId}/reviews/statistics/brightness": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product review brightness statistics", + "operationId": "getProductBrightnessStatistics", + "tags": [ + "reviewStatistics" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product review brightness statistics", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductBrightnessStatisticsDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/products/{productId}/reviews/statistics/color-sense": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product review color-sense statistics", + "operationId": "getProductColorSenseStatistics", + "tags": [ + "reviewStatistics" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product review color-sense statistics", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductColorSenseStatisticsDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/products/{productId}/reviews/statistics/thickness": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product review thickness statistics", + "operationId": "getProductThicknessStatistics", + "tags": [ + "reviewStatistics" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product review thickness statistics", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductThicknessStatisticsDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/categories/{categoryId}/attributes": { + "parameters": [ + { + "in": "path", + "name": "categoryId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get category's attributes", + "operationId": "getProductCategoryAttributes", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product category attributes", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductCategoryReviewAttributeDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "categoryId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/reviews/{reviewId}/reports": { + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "post": { + "summary": "report product review", + "description": "(can't report twice -> ApiErrorResponseCode.REVIEW_REPORTED_TWICE) (reporter uid and review uid can't be same -> ApiErrorResponseCode.REVIEW_REPORTED_BY_SELF)", + "operationId": "reportProductReview", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to report product review" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ] + } + }, + "/home/categories": { + "get": { + "summary": "get product categories in home screen", + "operationId": "getHomeProductCategories", + "tags": [ + "home" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product categories in home screen", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HomeProductCategoryDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/app/categories": { + "get": { + "summary": "get all categories with displaying products", + "operationId": "getDisplayingCategories", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "return all categories with displaying products", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/categories": { + "get": { + "summary": "get top product categories", + "operationId": "getTopProductCategories", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "query", + "required": false, + "name": "withAllCategory", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "product categories", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/categories/{categoryId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get inner product categories", + "operationId": "getInnerProductCategories", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "inner product categories", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/categories/{categoryId}/products": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get categorized products", + "operationId": "getCategorizedProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "categoryId", + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "- categorized products - If Queenit instant discount is applied, `ProductDto` shows the amount with the instant discount applied - Affected fields: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/age-group-filters": { + "get": { + "summary": "get all filters of age group.", + "operationId": "getAgeGroupFilters", + "tags": [ + "ageGroup" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "all age group filters", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AgeGroupFilterListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/brands": { + "get": { + "parameters": [ + { + "in": "query", + "required": false, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ], + "summary": "get all brands", + "operationId": "getAllBrands", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "brands", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BrandDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/brands/{brandId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "brandId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get brand details", + "description": "( can't find brand -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "getBrandDetail", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "brand detail", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BrandDetailDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "brandId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/brands/{brandId}/categories": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "brandId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get brand categories", + "operationId": "getBrandCategories", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "brand categories", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "brandId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/brands/{brandId}/categories/{categoryId}/products": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "brandId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get categorized brand products", + "operationId": "getBrandProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "brandId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "categoryId", + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "- categorized products - If Queenit instant discount is applied, `ProductDto` shows the amount with the instant discount applied - Affected fields: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/carts": { + "post": { + "summary": "add to cart", + "operationId": "addToCart", + "tags": [ + "cart" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AddToCartRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to add to cart", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AddToCartResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + }, + "get": { + "summary": "get cart items", + "operationId": "getCartItems", + "tags": [ + "cart" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- cart items - If Queenit instant discount is applied, it shows the amount with the instant discount applied in `ProductDto` - Affected fields: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartItemGroupDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/carts/{cartItemId}": { + "delete": { + "summary": "delete cart item", + "operationId": "deleteCartItem", + "tags": [ + "cart" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "cartItemId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "success to delete cart item" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/carts/delete": { + "post": { + "summary": "delete cart items", + "operationId": "deleteCartItems", + "tags": [ + "cart" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteCartItemsRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to delete cart items" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/carts/rearrange": { + "post": { + "summary": "rearrange cart items for quantity constraint", + "operationId": "rearrangeCartItems", + "tags": [ + "cart" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- polished cart items - If Queenit instant discount is applied, `ProductDto` shows the amount with the instant discount applied - Affected fields: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartItemGroupDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/carts/{cartItemId}/quantity/{quantity}": { + "post": { + "summary": "update cart item quantity", + "operationId": "updateCartItemQuantity", + "tags": [ + "cart" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "cartItemId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "path", + "name": "quantity", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "success to update cart item quantity" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/orders": { + "get": { + "summary": "get my order histories", + "operationId": "getMyOrders", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "order details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MyOrderHistoryListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + }, + "post": { + "summary": "start order for cart items", + "description": "( count of order line to order exceeds limit -> ApiErrorResponseCode.ORDER_LINE_COUNT_LIMIT_PER_ORDER_EXCEEDED ) ( order unavailable product item exists -> ApiErrorResponseCode.ORDER_UNAVAILABLE_PRODUCT_ITEM )", + "operationId": "startOrder", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StartOrderRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "product purchase material", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductPurchaseMaterialDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + }, + "put": { + "summary": "start order with adding cart items", + "description": "( count of order line to order exceeds limit -> ApiErrorResponseCode.ORDER_LINE_COUNT_LIMIT_PER_ORDER_EXCEEDED ) ( order unavailable product item exists -> ApiErrorResponseCode.ORDER_UNAVAILABLE_PRODUCT_ITEM )", + "operationId": "startOrderFromAdding", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StartOrderFromAddingRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "product purchase material", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductPurchaseMaterialDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/orders/wait-for-deposit/exist": { + "get": { + "summary": "whether exist order of waiting for deposit", + "operationId": "existOrdersOfWaitingForDeposit", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "whether exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BooleanDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/orders/{orderId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get order history", + "description": "( can't find order -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "getMyOrder", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "order details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MyOrderHistoryDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ] + }, + "delete": { + "summary": "abort order", + "description": "( can't find order -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "abortOrderById", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "required": false, + "name": "restoreCartItems", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "result order data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/orders/{orderId}/purchase-material": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get order purchase material", + "description": "API to retrieve payment information (`purchaseMaterial`) of `order before payment completion` in case of refresh or network loss", + "operationId": "getOrderPurchaseMaterial", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product purchase material", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductPurchaseMaterialDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/{orderId}/lines/{orderLineId}/confirm-receipt": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "orderLineId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "confirm order line receipt", + "description": "- Proceed with purchase confirmation for the orderline - Confirmation is only possible when delivery is complete - Orderlines with confirmed purchase cannot be exchanged/returned - It is impossible to request a return within the app - Possible errors - `TICKET_PROCESSING_IS_REQUIRED_TO_CONFIRM_RECEIPT (7001)` - If there is an OLC/OLR ticket in the `SUBMITTED` (requested) / `CONFIRMED` (approved) status -> If there is an OLC/OLR ticket that has not been processed yet - `CAN_ONLY_CONFIRM_RECEIPT_OF_PAID_ORDER_LINE (7002)` - Purchase confirmation is not possible for orderlines that have been refunded / are awaiting payment - `CANNOT_CONFIRM_RECEIPT_WHEN_DELIVERY_NOT_COMPLETE (7003)` - Purchase confirmation is not possible for orderlines that are not yet delivered.", + "operationId": "confirmOrderLineReceipt", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to confirm receipt" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "orderLineId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/purchases/{purchaseId}/point": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "Apply point", + "description": "( can't find order -> ApiErrorResponseCode.RESOURCE_NOT_FOUND ) ( can't apply point -> ApiErrorResponseCode.POINT_NOT_CONSUMABLE ) ( lack of point -> ApiErrorResponseCode.LACK_OF_POINT )", + "operationId": "applyPointForOrder", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplyPointRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to save", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplyPointResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/purchases/{purchaseId}/coupons/v2": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "delete": { + "summary": "release coupon", + "description": "( can't find order -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "releaseCouponOfOrderV2", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to release", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReleaseCouponResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + }, + "post": { + "summary": "apply coupon", + "description": "( can't find order, issued coupon -> ApiErrorResponseCode.RESOURCE_NOT_FOUND ) ( can't apply coupon -> ApiErrorResponseCode.COUPON_NOT_CONSUMABLE )", + "operationId": "applyCouponToOrderV2", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplyCouponRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to save", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplyCouponResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/purchases/{purchaseId}/delivery": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "save delivery request", + "description": "( can't find order -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "saveDeliveryRequest", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeliveryRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to update delivery request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderSummaryDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/{orderId}/delivery-request": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ], + "put": { + "summary": "update delivery request before delivery", + "description": "- Change the delivery address of an order before shipment - Types of errors that may occur - `ApiErrorResponseCode.INVALID_VALUE` - If there is a ticket for the order with a cancel/return ticket state of `SUBMITTED` or `CONFIRMED` - If it is a ghost order whose payment has not been completed - `ApiErrorResponseCode.RESOURCE_NOT_FOUND` - If the order does not exist - `ApiErrorResponseCode.ORDER_ALREADY_DISPATCHED` - If the delivery status of individual orders of the order is not `WAIT` - `ApiErrorResponseCode.CANNOT_CHANGE_DELIVERY_AREA` - If an attempt is made to change the delivery address to a different delivery area (ex. default delivery address -> island/mountainous area delivery address) from the existing delivery address", + "operationId": "updateDeliveryRequestBeforeDelivery", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeliveryRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to update delivery request" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/purchases/{purchaseId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get order history by purchase", + "description": "( can't find order -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "getMyOrderByPurchase", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "order details", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + }, + "delete": { + "summary": "abort order", + "description": "( can't find order -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "abortOrder", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "required": false, + "name": "restoreCartItems", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "success to abort" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + }, + "post": { + "summary": "complete order", + "description": "( can't find order -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "completeOrder", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to complete", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/order-line-tickets": { + "get": { + "summary": "get order line ticket history", + "operationId": "getOrderLineTickets", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "query", + "name": "ticket", + "schema": { + "$ref": "#/components/schemas/OrderLineTicketEnum" + } + }, + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "list order line tickets (return or cancel)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MyOrderLineTicketListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/order-line-tickets/count/summary": { + "get": { + "summary": "Aggregates the user's ongoing (or recently completed) return/cancellation tickets (for display on My Page)", + "operationId": "getOrderLineTicketsCountSummary", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "count OL tickets. (return or cancel)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MyOLTicketsCountDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/prompts/creatable-review-prompt": { + "get": { + "summary": "get creative review prompt with order line", + "operationId": "getCreatableReviewPrompt", + "tags": [ + "prompt" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "creatable review prompt", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreatableReviewPromptDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/refund-account": { + "get": { + "summary": "get user refund account", + "operationId": "getUserRefundAccount", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "refund account of user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserRefundAccountDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + }, + "post": { + "summary": "save refund account", + "operationId": "saveRefundAccount", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RefundAccountDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to save" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/orders/{orderId}/lines/cancel": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ], + "put": { + "summary": "cancel order item", + "description": "- Possible errors - `CANNOT_REQUEST_REFUND_AFTER_CONFIRM_RECEIPT (7004)` - When requesting to create a cancellation ticket for an orderline that has already been confirmed", + "operationId": "requestToCancelOrderItem", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OLCRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "order history with created cancel ticket", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/{orderId}/lines/cancel/v2": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "estimate order item cancellation", + "operationId": "estimateOrderItemCancellationV2", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartialOrderItemDto" + } + } + } + } + }, + "responses": { + "200": { + "description": "Estimation result", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OLCEstimationResultDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/{orderId}/lines/cancel/{ticketId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "ticketId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get order item cancel ticket details", + "operationId": "getOrderItemCancelTicket", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "cancel ticket response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderLineCancelTicketWithOrderDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "ticketId", + "schema": { + "type": "string" + } + } + ] + }, + "delete": { + "summary": "withdraw order item cancellation", + "operationId": "withdrawOrderItemCancelTicket", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "order history with withdrawn ticket", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "ticketId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/{orderId}/lines/return": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ], + "put": { + "summary": "return order item", + "description": "- Possible errors - `CANNOT_REQUEST_REFUND_AFTER_CONFIRM_RECEIPT (7004)` - When requesting to create a return ticket for an orderline that has already been confirmed for purchase - `RESOURCE_NOT_FOUND (4)` - Can't find order - `LIMITATION_EXCEEDED (5)` - When there are more than 3 items in imageUrls", + "operationId": "requestToReturnOrderItem", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OLRRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "order history with created return ticket", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/{orderId}/lines/return/v2": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "Estimate order item returning", + "operationId": "estimateOrderItemReturningV2", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OLREstimateRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "Estimation result", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OLREstimationResultDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/{orderId}/lines/return/{ticketId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "ticketId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get order item return ticket details", + "operationId": "getOrderItemReturnTicket", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "return ticket response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderLineReturnTicketWithOrderDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "ticketId", + "schema": { + "type": "string" + } + } + ] + }, + "delete": { + "summary": "withdraw order item returning", + "operationId": "withdrawOrderItemReturnTicket", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "order history with withdrawn ticket", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "ticketId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/purchases/{topic}/{purchaseId}/payments/iamport": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "start iamport payment for specific purchase", + "description": "( can't find purchase -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "startIamportPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StartIamportPaymentRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "iamport payment material", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IamportPaymentMaterialDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/purchases/{topic}/{purchaseId}/payments/iamport/merchantIds/{merchantId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "finish iamport payment process", + "description": "( paid amount does not match -> ApiErrorResponseCode.PAYMENT_NOT_FULLY_PAID )", + "operationId": "finishIamportPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to process" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ] + }, + "delete": { + "summary": "abandon iamport payment", + "description": "( can't find purchase -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "abandonIamportPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to process" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/purchases/{topic}/{purchaseId}/payments/toss": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "start toss payment for specific purchase", + "description": "( can't find purchase -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "startTossPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StartTossPaymentRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "toss payment material", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TossPaymentMaterialDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/purchases/{topic}/{purchaseId}/payments/toss/merchantIds/{merchantId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "finish toss payment process", + "description": "( paid amount does not match -> ApiErrorResponseCode.PAYMENT_NOT_FULLY_PAID )", + "operationId": "finishTossPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to process" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ] + }, + "delete": { + "summary": "abandon toss payment", + "description": "( can't find purchase -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "abandonTossPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to process" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/purchases/{topic}/{purchaseId}/payments/connect-pay": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "start connect-pay payment for specific purchase", + "description": "( can't find purchase -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "startConnectPayPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StartConnectPayPaymentRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "connect-pay payment material", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectPayPaymentMaterialDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/purchases/{topic}/{purchaseId}/payments/connect-pay/merchantIds/{merchantId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "finish connect-pay payment process", + "description": "( paid amount does not match -> ApiErrorResponseCode.PAYMENT_NOT_FULLY_PAID )", + "operationId": "finishConnectPayPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to process" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ] + }, + "delete": { + "summary": "abandon connect-pay payment", + "description": "( can't find purchase -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "abandonConnectPayPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to process" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/purchases/{topic}/{purchaseId}/payments/dry": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "start dry-run payment for specific purchase", + "description": "( can't find purchase -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "startDryRunPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "dry run payment material", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DryRunPaymentMaterialDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/purchases/{topic}/{purchaseId}/payments/dry/merchantIds/{merchantId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "finish dry-run payment process", + "operationId": "finishDryRunPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to process" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ] + }, + "delete": { + "summary": "abandon dry-run payment", + "description": "( can't find purchase -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "abandonDryRunPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to process" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/purchases/{topic}/{purchaseId}/payments/free": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "start free payment for specific purchase", + "description": "( can't find purchase -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "startFreePayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to process" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/banners/types/{bannerType}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "bannerType", + "schema": { + "$ref": "#/components/schemas/BannerTypeEnum" + } + } + ], + "get": { + "summary": "get banners", + "operationId": "getBanners", + "tags": [ + "banner" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "banner list", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BannerDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "bannerType", + "schema": { + "$ref": "#/components/schemas/BannerTypeEnum" + } + } + ] + } + }, + "/banners/category/{categoryId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get banners for category", + "operationId": "getCategoryBanners", + "tags": [ + "banner" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "banner list", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BannerDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/banners/brand-promotion": { + "get": { + "summary": "get banners for brand-promotion", + "operationId": "getBrandPromotionBanners", + "parameters": [ + { + "in": "query", + "required": false, + "name": "brandSourcingTagIdOfPromotedChannelGroup", + "description": "The ID of the brand sourcing tag corresponding to the purchasing channel group", + "schema": { + "type": "string" + } + } + ], + "tags": [ + "banner" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "banner list", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BannerDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/banners/brand/{brandId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "brandId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get banner for brand", + "operationId": "getBrandBanners", + "tags": [ + "banner" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "banner list", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BannerDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "brandId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/collections/{collectionId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "collectionId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get collection", + "description": "( can't find collection -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "getCollection", + "tags": [ + "collection" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- collection - If Queenit instant discount is applied, it shows the amount with the instant discount applied in `ProductDto` - Affected fields: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CollectionDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "collectionId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/search/products": { + "get": { + "summary": "search products", + "operationId": "searchProducts", + "tags": [ + "search" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "name": "keyword", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "description": "If orderBy is not given, orderBy would be set MATCHING_SCORE_DESC as a default value.", + "name": "orderBy", + "required": false, + "schema": { + "$ref": "#/components/schemas/ProductSearchingOrderByEnum" + } + }, + { + "in": "query", + "name": "categoryId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "categoryIds", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "name": "brandId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "brandIds", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "required": false, + "name": "minPrice", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "maxPrice", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "description": "List of product attribute ids to filter on", + "required": false, + "name": "productFeatureIds", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "deprecated": true, + "required": false, + "description": "(DEPRECATED) Use enabledTotalCount, enabledProductFeatureAggreagtion, enabledProductCategoryAggregation, enabledBrandAggregation.", + "name": "enabledProductAggregation", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "Set to true if the total count is required in product aggregation..", + "name": "enabledTotalCount", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "Set to true if the number of product attributes is required in product aggregation..", + "name": "enabledProductFeatureAggregation", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "Set to true if product aggregation requires counts by product category..", + "name": "enabledProductCategoryAggregation", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "Set to true if you need to count by brand in product aggregation..", + "name": "enabledBrandAggregation", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "This is the field required for experiments when applying specific features related to search..", + "name": "keywordSearchExperimentIds", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "- searched products - If Queenit instant discount is applied, `AppProductDto` shows the amount with the instant discount applied - Affected fields: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/autocomplete": { + "get": { + "summary": "get autocomplete candidates", + "operationId": "getAutocompleteCandidates", + "tags": [ + "autocomplete" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "query", + "name": "query", + "required": true, + "schema": { + "type": "string" + }, + "description": "autocomplete query" + }, + { + "in": "query", + "name": "brandSize", + "required": true, + "schema": { + "type": "integer", + "format": "int32", + "default": 0 + }, + "description": "required brand autocomplete candidate size" + } + ], + "responses": { + "200": { + "description": "get autocomplete list", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AutocompleteResponseDto" + } + } + } + } + } + } + }, + "/couponBooks/{couponBookCode}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "couponBookCode", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get coupon book", + "description": "( can't find coupon book -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "getCouponBook", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "coupon book", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CouponBookDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "couponBookCode", + "schema": { + "type": "string" + } + } + ] + } + }, + "/couponBooks/{couponBookCode}/asset": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "couponBookCode", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get coupon book asset", + "description": "( can't find coupon book -> ApiErrorResponseCode.RESOURCE_NOT_FOUND )", + "operationId": "getCouponBookAsset", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "coupon book asset", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CouponBookAssetDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "couponBookCode", + "schema": { + "type": "string" + } + } + ] + } + }, + "/couponBooks/{couponBookCode}/coupons": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "couponBookCode", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "issue all coupons in coupon book", + "description": "( can't find coupon book -> ApiErrorResponseCode.RESOURCE_NOT_FOUND ) ( there are no coupons could be issued -> ApiErrorResponseCode.COUPON_BOOK_ISSUABLES_NOT_EXIST )", + "operationId": "issueAllCouponsInCouponBook", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "Issued coupons by coupon book", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IssuedCouponDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "couponBookCode", + "schema": { + "type": "string" + } + } + ] + } + }, + "/coupons/displays/products/{productId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "productId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get coupons by display product", + "operationId": "listDisplayingCouponsForProduct", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "get coupons by display product", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCouponDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "productId", + "schema": { + "type": "string" + } + } + ] + }, + "post": { + "summary": "issue all coupons by display product", + "operationId": "issueAllDisplayingCoupons", + "description": "( there are no display coupons to issue -> ApiErrorResponseCode.DISPLAYING_COUPONS_ISSUABLE_NOT_EXIST )", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to issue", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IssuedCouponDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "productId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/coupons/displays/products/{productId}/v2": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "productId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get coupons by display product v2", + "operationId": "listDisplayingCouponsForProductV2", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "get coupons by display product v2", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppCouponListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "productId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/coupons/{couponCode}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "couponCode", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get coupon by coupon code", + "operationId": "getCouponByCode", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "coupon", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CouponDetailDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "couponCode", + "schema": { + "type": "string" + } + } + ] + }, + "post": { + "summary": "issue coupon", + "description": "( can't find coupon -> ApiErrorResponseCode.RESOURCE_NOT_FOUND ) ( coupon is disabled -> ApiErrorResponseCode.COUPON_NOT_ENABLED ) ( before coupon issue begin date -> ApiErrorResponseCode.COUPON_ISSUE_BEFORE_BEGIN ) ( after coupon issue end date -> ApiErrorResponseCode.COUPON_ISSUE_AFTER _END ) ( exceed max coupon issue count -> ApiErrorResponseCode.COUPON_ISSUE_LIMIT_EXCEEDED ) ( exceed max coupon issue count per user -> ApiErrorResponseCode.COUPON_ISSUE_LIMIT_PER_USER_EXCEEDED ) ( not target to coupon issue -> ApiErrorResponseCode.COUPON_ISSUE_NOT_TARGET )", + "operationId": "issueCoupon", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to issue" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "couponCode", + "schema": { + "type": "string" + } + } + ] + } + }, + "/coupons": { + "get": { + "summary": "get my issued coupons", + "operationId": "getIssuedCoupons", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "Issued coupons", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IssuedCouponDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/coupons/first-kakao-login/issuable": { + "get": { + "summary": "check current user can issue first kakao login coupon", + "operationId": "checkFirstKakaoLoginCouponIssueable", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "check first kakao login coupon is issuable with current user's phone number", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CheckFirstKakaoLoginCouponIssuableResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/shop-live/authorize": { + "post": { + "summary": "generate shop live token with username", + "operationId": "generateShopLiveAccessToken", + "tags": [ + "shopLive" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShopLiveTokenRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to generate shop live token", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShopLiveTokenResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/shop-live/campaigns/upcoming": { + "get": { + "parameters": [ + { + "in": "query", + "required": false, + "name": "includeOnAir", + "description": "Whether to retrieve information about this campaign if there is information about a currently ongoing broadcast. If false, only retrieve information about upcoming broadcasts after the current one.", + "schema": { + "type": "boolean" + } + }, + { + "in": "query", + "required": false, + "name": "includePrivate", + "description": "Whether to also view information on campaigns set to private", + "schema": { + "type": "boolean" + } + } + ], + "summary": "Returns information about the broadcast scheduled for the nearest time after the present, or (if applicable) the broadcast currently in progress.", + "operationId": "getUpcomingCampaign", + "tags": [ + "shopLive" + ], + "responses": { + "200": { + "description": "success to get upcoming campaign info", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShopLiveCampaignResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/shop-live/campaigns/{campaignKey}/metadata": { + "get": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "campaignKey", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "required": false, + "name": "resolutionLevel", + "description": "Resolution level", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "summary": "View summary information such as status of individual broadcasts (campaigns), live stream URL, etc.", + "operationId": "getCampaignMetadata", + "tags": [ + "shopLive" + ], + "responses": { + "200": { + "description": "success to get campaign metadata", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShopLiveCampaignMetadataResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/points": { + "get": { + "parameters": [ + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "name": "cursor", + "description": "epochSeconds", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "pointType", + "description": "Accumulation type / null = full view", + "required": false, + "schema": { + "$ref": "#/components/schemas/PointAmountTypeEnum" + } + } + ], + "summary": "View your points history.", + "operationId": "getPointHistory", + "tags": [ + "point" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to get point history", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PointHistoryBundleResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/points/now-usable": { + "get": { + "summary": "Check the user's current available savings.", + "operationId": "getNowUsablePoint", + "tags": [ + "point" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to get now usable point", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NowUsablePointDto" + } + } + } + } + } + } + }, + "/points/promotions/{code}/attend": { + "put": { + "summary": "Attend the savings promotion event.", + "operationId": "attendPromotion", + "tags": [ + "point" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "code", + "description": "Promotion Code", + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "success to attend promotion" + } + } + }, + "get": { + "summary": "Check attendance at the savings promotion event.", + "operationId": "getAttendPromotionState", + "tags": [ + "point" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "code", + "description": "Promotion Code", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "success to query attend promotion", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotionAttendedStateDto" + } + } + } + } + } + } + }, + "/product-rankings/{productId}/is-category-best-product": { + "get": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "productId", + "schema": { + "type": "string" + } + } + ], + "summary": "Check if there is a best product in the category", + "operationId": "findCategoryBestProduct", + "tags": [ + "productRanking" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to get category best product", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CategoryBestProductDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/referral/code": { + "get": { + "summary": "Invitation Code Lookup API", + "description": "Returns the referrer's invitation code. It is generated and returned upon initial request..", + "operationId": "getReferralCode", + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "Referral Code", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReferralCodeDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/referral/user/reward/policy": { + "get": { + "summary": "User Invitation Reward Policy Inquiry API", + "operationId": "getUserReferralPolicy", + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "User Invitation Reward Policy Inquiry Results", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserReferralRewardPolicyDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/referral/user-referral/summary": { + "get": { + "summary": "User Invitation Summary Information Retrieval API", + "operationId": "getUserReferralSummary", + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "User Invitation Summary Information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserReferralSummaryDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/referral/user-referral/bonus-box/open": { + "post": { + "summary": "API for opening bonus boxes accumulated through user referrals", + "description": "API to open 1 user referral bonus box", + "operationId": "openUserReferralBonusBox", + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "Bonus Box Open Results", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserReferralBonusBoxOpenResultDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/referral/user/reward/summary": { + "get": { + "summary": "API for querying user referral reward summary information -> Use `getUserReferralSummary`", + "operationId": "getUserReferralRewardSummary", + "deprecated": true, + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "Results of cumulative reward inquiry received through user invitation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserReferralRewardSummaryDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/referral/user/reward/estimate": { + "post": { + "summary": "User Referral Reward Estimation API", + "description": "- API to query the expected result of the points that the referrer can get as a reward (up to 50 items) - You must pass a `Korean number in the format of Global PhoneNumber` (e.g. '+821012341234')", + "operationId": "estimateUserReferralRewards", + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserReferralRewardEstimationRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "List of referral rewards that referrers can receive", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserReferralRewardEstimationListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/referral/user": { + "post": { + "summary": "User Recommendation API", + "operationId": "createUserReferral", + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateUserReferralRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "User recommendation success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateUserReferralResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/referral/user/referred-user-join": { + "post": { + "summary": "API for completing registration of recommended users", + "operationId": "joinReferredUser", + "description": "After the recommended user completes registration through the referral link, the API is called.", + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JoinReferredUserRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "Recommended user sign-up successful", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JoinReferredUserResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/referral/product": { + "post": { + "summary": "Recommended Product Purchase Completion API", + "operationId": "createProductReferral", + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateProductReferralRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "This is an API that creates a ProductReferral when purchasing a product through a product recommendation link.." + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/games": { + "get": { + "summary": "List of games currently in progress", + "operationId": "getGameList", + "tags": [ + "gamification" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "Game List", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActiveGameListResponse" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/games/{gameId}": { + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "View user game information", + "operationId": "getGameProgressInfo", + "tags": [ + "gamification" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "User game information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameUserProgressInfoResponse" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + } + ] + }, + "post": { + "summary": "Consumption of primary goods", + "operationId": "useInGameCredit", + "tags": [ + "gamification" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameUseInGameCreditRequest" + } + } + } + }, + "responses": { + "200": { + "description": "User game information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameUserProgressInfoResponse" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/games/{gameId}/achieve": { + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "Obtain rewards for clearing the game", + "operationId": "achieveGame", + "tags": [ + "gamification" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameAchieveRequest" + } + } + } + }, + "responses": { + "204": { + "description": "Game clear completed" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/games/{gameId}/missions": { + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "Check the mission list and mission progress", + "operationId": "getMissions", + "tags": [ + "gamification" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "Mission list and mission progress", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameMissionsResponse" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + } + ] + }, + "post": { + "summary": "Request to complete mission", + "operationId": "achieveMission", + "tags": [ + "gamification" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameMissionAchieveRequest" + } + } + } + }, + "responses": { + "204": { + "description": "Mission Complete" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/games/{gameId}/missions/{missionId}": { + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "missionId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "post": { + "summary": "Receive mission rewards", + "operationId": "receiveReward", + "tags": [ + "gamification" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "Mission Reward", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameMissionRewardReceiveResponse" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "missionId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ] + } + }, + "/categories/{categoryId}/review-guide": { + "parameters": [ + { + "in": "path", + "name": "categoryId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get category's review guide", + "operationId": "getProductCategoryReviewGuide", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product category review guide", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductCategoryReviewGuideDataDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "categoryId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/style-shots": { + "get": { + "summary": "get all style shots", + "operationId": "getAllStyleShots", + "tags": [ + "styleShot" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "query", + "name": "categoryId", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "get all style shots", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StyleShotListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/style-shots/{id}": { + "get": { + "summary": "get style shot by id", + "operationId": "getStyleShotById", + "tags": [ + "styleShot" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "id", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "get style shot", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StyleShotDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/style-shots/categories": { + "get": { + "summary": "get all style category", + "operationId": "getAllStyleCategory", + "tags": [ + "styleShot" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "get all style category", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StyleCategoryListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/style-shots/{id}/equipped-products": { + "get": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "id", + "schema": { + "type": "string" + } + } + ], + "summary": "get equipped product list by product item ids", + "description": "Search for items worn by Style Shot ID", + "operationId": "getEquippedProductListByStyleShotId", + "tags": [ + "styleShot" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- products and product items (unique and not ordered) by product item ids - If Queenit instant discount is applied, `ProductDto` shows the amount with the instant discount applied - Affected fields: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EquippedProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/delivery-prediction": { + "get": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "summary": "get delivery completed prediction dates and probability by product id", + "description": "Retrieve expected delivery completion time data via ProductId.", + "operationId": "getDeliveryPrediction", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- get delivery completed expectation data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeliveryPredictionListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/purchase-measurements-statistics": { + "get": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "productId", + "schema": { + "type": "string" + } + } + ], + "summary": "get purchase measurements statistics by product id", + "description": "Check purchase statistics by product ID", + "operationId": "getPurchaseMeasurementsStatistics", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- get purchase measurements statistics", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PurchaseMeasurementsStatisticsListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/purchase-measurements": { + "get": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "productId", + "schema": { + "type": "string" + } + } + ], + "summary": "get purchase measurements by product id(limit 5)", + "description": "View purchase statistics by product ID (raw data)", + "operationId": "getPurchaseMeasurements", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- get purchase measurements", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PurchaseMeasurementsDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/attendance-checks/{id}/histories": { + "get": { + "summary": "get attendance check history", + "operationId": "getAttendanceCheckHistories", + "tags": [ + "attendanceCheck" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "id", + "description": "Attendance Check ID", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "get attendance check history", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AttendanceCheckHistoryListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/attendance-checks/{id}/attend": { + "post": { + "summary": "attend attendance check", + "description": "- Error code when attendance is already done: ALREADY_EXISTS(1) - Error code when attendance check is completed: ATTENDANCE_CHECK_COMPLETED(8001) - Error code when event ends: RESOURCE_NOT_FOUND(4)", + "operationId": "attendAttendanceCheck", + "tags": [ + "attendanceCheck" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "id", + "description": "Attendance Check ID", + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "success to attend attendance check" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "BooleanDto": { + "type": "object", + "description": "to overcome oag bug that primitive api response does not converted from string in TS.", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "RequiredLongDto": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "integer", + "format": "int64" + } + } + }, + "LongDto": { + "type": "object", + "description": "to overcome oag bug that primitive api response does not converted from long in TS.", + "properties": { + "value": { + "type": "integer", + "format": "int64" + } + } + }, + "LongRangeDto": { + "type": "object", + "properties": { + "min": { + "type": "integer", + "format": "int64" + }, + "max": { + "type": "integer", + "format": "int64" + } + } + }, + "RequiredBooleanDto": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "boolean" + } + } + }, + "MetadataDto": { + "type": "object", + "required": [ + "version", + "serverStatus" + ], + "properties": { + "version": { + "$ref": "#/components/schemas/VersionDto" + }, + "serverStatus": { + "$ref": "#/components/schemas/ServerStatusDto" + } + } + }, + "VersionDto": { + "type": "object", + "required": [ + "minVersion", + "minBuildNumber" + ], + "properties": { + "minVersion": { + "type": "string", + "description": "minimum required version to show" + }, + "minBuildNumber": { + "type": "integer", + "format": "int32", + "description": "minimum required build number" + }, + "updateUrl": { + "type": "string", + "description": "update url" + } + } + }, + "BestPeriodEnum": { + "oneOf": [ + { + "const": "DAILY" + }, + { + "const": "WEEKLY" + }, + { + "const": "MONTHLY" + } + ] + }, + "ProductTagEnum": { + "oneOf": [ + { + "const": "SHOPPING_MALL" + }, + { + "const": "DISCOUNT_PROMOTION" + } + ], + "description": "Product tag information. SHOPPING_MALL -> Shopping mall products DISCOUNT_PROMOTION -> Special price products" + }, + "AgeGroupCodeEnum": { + "oneOf": [ + { + "const": "AG0" + }, + { + "const": "AG1" + }, + { + "const": "AG2" + }, + { + "const": "AG3" + }, + { + "const": "AG4" + }, + { + "const": "AG5" + }, + { + "const": "AG6" + } + ], + "description": "Age code. Notion reference -> https://www.notion.so/rapportlabs/5d323300ed8a457da25b889fdc9c986c" + }, + "ServerStatusDto": { + "type": "object", + "required": [ + "serverState" + ], + "properties": { + "serverState": { + "$ref": "#/components/schemas/ServerStateEnum" + }, + "serverMaintenanceReason": { + "type": "string", + "description": "server maintenance reason" + }, + "serverMaintenanceStartedAtMillis": { + "type": "integer", + "format": "int64", + "description": "server maintenance start time" + }, + "serverMaintenanceEndedAtMillis": { + "type": "integer", + "format": "int64", + "description": "server maintenance end time" + } + } + }, + "PlatformEnum": { + "oneOf": [ + { + "const": "ANDROID" + }, + { + "const": "IOS" + } + ] + }, + "ServerStateEnum": { + "oneOf": [ + { + "const": "OPERATIONAL" + }, + { + "const": "MAINTENANCE" + } + ], + "description": "server status enum" + }, + "SendVerifCodeRequestDto": { + "type": "object", + "required": [ + "phoneNumber" + ], + "properties": { + "phoneNumber": { + "type": "string", + "description": "phone number to send verif code" + } + } + }, + "SendVerifCodeResponseDto": { + "type": "object", + "required": [ + "verifyingToken", + "expirationMillis" + ], + "properties": { + "verifyingToken": { + "type": "string" + }, + "expirationMillis": { + "type": "integer", + "format": "int64" + } + } + }, + "VerifyCodeRequestDto": { + "type": "object", + "required": [ + "verifyingToken", + "verifCode" + ], + "properties": { + "verifyingToken": { + "type": "string" + }, + "verifCode": { + "type": "string" + } + } + }, + "VerifyCodeResponseDto": { + "type": "object", + "required": [ + "verifiedToken" + ], + "properties": { + "verifiedToken": { + "type": "string" + } + } + }, + "VerifyKakaoTokenRequestDto": { + "type": "object", + "required": [ + "kakaoAccessToken", + "phoneNumber" + ], + "properties": { + "kakaoAccessToken": { + "type": "string" + }, + "phoneNumber": { + "type": "string" + } + } + }, + "VerifyKakaoTokenResponseDto": { + "type": "object", + "required": [ + "verifiedToken" + ], + "properties": { + "verifiedToken": { + "type": "string" + } + } + }, + "SignUpRequestDto": { + "type": "object", + "required": [ + "verifiedToken" + ], + "properties": { + "verifiedToken": { + "type": "string" + } + } + }, + "SignUpResponseDto": { + "type": "object", + "required": [ + "firebaseToken" + ], + "properties": { + "firebaseToken": { + "type": "string" + } + } + }, + "DamoaTokenDto": { + "type": "object", + "required": [ + "accessToken", + "refreshToken" + ], + "properties": { + "accessToken": { + "type": "string", + "description": "Expires in 1 hour" + }, + "refreshToken": { + "type": "string", + "description": "Expires in 180 days" + } + } + }, + "DamoaTokenRefreshRequestDto": { + "type": "object", + "required": [ + "refreshToken" + ], + "properties": { + "refreshToken": { + "type": "string" + } + } + }, + "LoginAccountDto": { + "type": "object", + "required": [ + "uid", + "userRole", + "createdAtMillis", + "isKakaoLoginUser" + ], + "properties": { + "uid": { + "type": "string" + }, + "userRole": { + "$ref": "#/components/schemas/UserRoleEnum" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + }, + "phoneNumber": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "isKakaoLoginUser": { + "type": "boolean" + } + } + }, + "FirebaseAuthUserMigrationRequest": { + "type": "object", + "required": [ + "accessToken" + ], + "properties": { + "accessToken": { + "type": "string" + } + } + }, + "ProviderTypeEnum": { + "oneOf": [ + { + "const": "SMS" + }, + { + "const": "KAKAO" + } + ] + }, + "UserRoleEnum": { + "oneOf": [ + { + "const": "ANONYMOUS" + }, + { + "const": "IDENTIFIED_USER" + } + ] + }, + "BestBrandListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BestBrandDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "BestBrandDto": { + "type": "object", + "required": [ + "id", + "name", + "logo" + ], + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "logo": { + "$ref": "#/components/schemas/BrandLogoDto" + }, + "bestProducts": { + "$ref": "#/components/schemas/BestProductListOfBrandDto" + } + } + }, + "BestProductListOfBrandDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BestProductOfBrandDto" + } + } + } + }, + "BestProductOfBrandDto": { + "type": "object", + "required": [ + "title", + "productId", + "thumbnailUrl", + "multiResolutionThumbnail", + "finalPrice" + ], + "properties": { + "title": { + "type": "string" + }, + "productId": { + "type": "string" + }, + "thumbnailUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionThumbnail": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "finalPrice": { + "type": "integer", + "format": "int64" + } + } + }, + "TagListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "description": "Tag list", + "type": "array", + "items": { + "$ref": "#/components/schemas/TagDto" + } + } + } + }, + "TagDto": { + "type": "object", + "required": [ + "id", + "name", + "type" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "description": "The name of the tag", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/TagTypeEnum" + } + } + }, + "TagTypeEnum": { + "oneOf": [ + { + "const": "BRAND_SOURCING" + }, + { + "const": "PRODUCT" + } + ], + "description": "Types of things that can be tagged. Even if the group name is the same, if the type is different, they are treated as different groups.." + }, + "TagGroupListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "description": "List of tag groups", + "type": "array", + "items": { + "$ref": "#/components/schemas/TagGroupDto" + } + } + } + }, + "TagGroupDto": { + "type": "object", + "required": [ + "id", + "name", + "type" + ], + "properties": { + "id": { + "description": "Group id of the tag", + "type": "integer", + "format": "int64" + }, + "name": { + "description": "Group name of the tag (ex. production year)", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/TagTypeEnum" + } + } + }, + "ProductDto": { + "type": "object", + "required": [ + "productId", + "mallId", + "mallProductCode", + "mallName", + "url", + "imageUrl", + "multiResolutionImage", + "thumbnailUrl", + "multiResolutionThumbnail", + "name", + "finalPrice", + "discountPercentage", + "productPriceDetail", + "brand", + "rating", + "salesStatus" + ], + "properties": { + "productId": { + "type": "string" + }, + "mallId": { + "type": "string", + "description": "DEPRECATED" + }, + "mallProductCode": { + "type": "string" + }, + "mallName": { + "type": "string", + "description": "DEPRECATED" + }, + "rank": { + "type": "integer", + "format": "int32" + }, + "logoUrl": { + "type": "string", + "description": "DEPRECATED" + }, + "logo2xUrl": { + "type": "string", + "description": "DEPRECATED" + }, + "logo3xUrl": { + "type": "string", + "description": "DEPRECATED" + }, + "url": { + "type": "string", + "description": "DEPRECATED" + }, + "imageUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "thumbnailUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionThumbnail": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "name": { + "type": "string" + }, + "originalPrice": { + "type": "integer", + "format": "int64" + }, + "finalPrice": { + "type": "integer", + "format": "int64", + "description": "- `directCouponAppliedFinalPrice` in `productPriceDetail`, but `finalPrice` if null" + }, + "discountPercentage": { + "type": "integer", + "format": "int32", + "description": "- `finalPrice` compared to `originalPrice`" + }, + "productPriceDetail": { + "$ref": "#/components/schemas/ProductPriceDetailDto" + }, + "brand": { + "type": "string" + }, + "display": { + "type": "boolean", + "description": "If this field value is `false` -> Mark as sold out" + }, + "reviewRatingAvg": { + "type": "number", + "format": "double" + }, + "reviewCount": { + "type": "integer", + "format": "int32" + }, + "category": { + "$ref": "#/components/schemas/ProductCategoryDto" + }, + "rating": { + "type": "integer", + "format": "int32" + }, + "deliveryPolicy": { + "$ref": "#/components/schemas/DeliveryPolicyDto" + }, + "salesStatus": { + "$ref": "#/components/schemas/SalesStatusEnum" + } + } + }, + "AppProductDto": { + "type": "object", + "required": [ + "productId", + "mallId", + "mallProductCode", + "mallName", + "url", + "imageUrl", + "multiResolutionImage", + "thumbnailUrl", + "multiResolutionThumbnail", + "name", + "finalPrice", + "discountPercentage", + "productPriceDetail", + "brand", + "rating", + "salesStatus", + "myBodySizesFromItems" + ], + "properties": { + "productId": { + "type": "string" + }, + "mallId": { + "type": "string", + "description": "DEPRECATED" + }, + "mallProductCode": { + "type": "string" + }, + "mallName": { + "type": "string", + "description": "DEPRECATED" + }, + "rank": { + "type": "integer", + "format": "int32" + }, + "url": { + "type": "string", + "description": "DEPRECATED" + }, + "imageUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "thumbnailUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionThumbnail": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "name": { + "type": "string" + }, + "originalPrice": { + "type": "integer", + "format": "int64" + }, + "finalPrice": { + "type": "integer", + "format": "int64" + }, + "discountPercentage": { + "type": "integer", + "format": "int32" + }, + "productPriceDetail": { + "$ref": "#/components/schemas/ProductPriceDetailDto" + }, + "brand": { + "type": "string" + }, + "display": { + "type": "boolean", + "description": "If this field value is `false` -> Mark as sold out" + }, + "category": { + "$ref": "#/components/schemas/ProductCategoryDto" + }, + "rating": { + "type": "integer", + "format": "int32" + }, + "deliveryPolicy": { + "$ref": "#/components/schemas/DeliveryPolicyDto" + }, + "salesStatus": { + "$ref": "#/components/schemas/SalesStatusEnum" + }, + "reviewRatingAvg": { + "type": "number", + "format": "double" + }, + "reviewCount": { + "type": "integer", + "format": "int32" + }, + "myBodySizesFromItems": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "EquippedProductDto": { + "type": "object", + "required": [ + "productId", + "productItem", + "mallId", + "mallProductCode", + "mallName", + "url", + "imageUrl", + "multiResolutionImage", + "thumbnailUrl", + "multiResolutionThumbnail", + "name", + "finalPrice", + "discountPercentage", + "productPriceDetail", + "brand", + "rating", + "salesStatus", + "favorite" + ], + "properties": { + "productId": { + "type": "string" + }, + "productItem": { + "$ref": "#/components/schemas/ProductItemDto" + }, + "mallId": { + "type": "string", + "description": "DEPRECATED" + }, + "mallProductCode": { + "type": "string" + }, + "mallName": { + "type": "string", + "description": "DEPRECATED" + }, + "rank": { + "type": "integer", + "format": "int32" + }, + "logoUrl": { + "type": "string", + "description": "DEPRECATED" + }, + "logo2xUrl": { + "type": "string", + "description": "DEPRECATED" + }, + "logo3xUrl": { + "type": "string", + "description": "DEPRECATED" + }, + "url": { + "type": "string", + "description": "DEPRECATED" + }, + "imageUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "thumbnailUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionThumbnail": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "name": { + "type": "string" + }, + "originalPrice": { + "type": "integer", + "format": "int64" + }, + "finalPrice": { + "type": "integer", + "format": "int64", + "description": "- `directCouponAppliedFinalPrice` in `productPriceDetail`, but `finalPrice` if null" + }, + "discountPercentage": { + "type": "integer", + "format": "int32", + "description": "- `finalPrice` compared to `originalPrice`" + }, + "productPriceDetail": { + "$ref": "#/components/schemas/ProductPriceDetailDto" + }, + "brand": { + "type": "string" + }, + "display": { + "type": "boolean", + "description": "If this field value is `false` -> Mark as sold out" + }, + "reviewRatingAvg": { + "type": "number", + "format": "double" + }, + "reviewCount": { + "type": "integer", + "format": "int32" + }, + "category": { + "$ref": "#/components/schemas/ProductCategoryDto" + }, + "rating": { + "type": "integer", + "format": "int32" + }, + "deliveryPolicy": { + "$ref": "#/components/schemas/DeliveryPolicyDto" + }, + "salesStatus": { + "$ref": "#/components/schemas/SalesStatusEnum" + }, + "favorite": { + "type": "boolean", + "default": false, + "description": "Whether to steam or not" + } + } + }, + "AppAdvertisementProductDto": { + "type": "object", + "properties": { + "productId": { + "type": "string" + }, + "mallId": { + "type": "string", + "description": "DEPRECATED" + }, + "mallProductCode": { + "type": "string" + }, + "mallName": { + "type": "string", + "description": "DEPRECATED" + }, + "rank": { + "type": "integer", + "format": "int32" + }, + "url": { + "type": "string", + "description": "DEPRECATED" + }, + "imageUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "thumbnailUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionThumbnail": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "name": { + "type": "string" + }, + "originalPrice": { + "type": "integer", + "format": "int64" + }, + "finalPrice": { + "type": "integer", + "format": "int64" + }, + "discountPercentage": { + "type": "integer", + "format": "int32" + }, + "productPriceDetail": { + "$ref": "#/components/schemas/ProductPriceDetailDto" + }, + "brand": { + "type": "string" + }, + "display": { + "type": "boolean", + "description": "If this field value is `false` -> Mark as sold out" + }, + "category": { + "$ref": "#/components/schemas/ProductCategoryDto" + }, + "rating": { + "type": "integer", + "format": "int32" + }, + "deliveryPolicy": { + "$ref": "#/components/schemas/DeliveryPolicyDto" + }, + "salesStatus": { + "$ref": "#/components/schemas/SalesStatusEnum" + }, + "reviewRatingAvg": { + "type": "number", + "format": "double" + }, + "reviewCount": { + "type": "integer", + "format": "int32" + }, + "myBodySizesFromItems": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ProductPriceDetailDto": { + "type": "object", + "description": "- DTO to provide detailed information about the price set for the existing product and the price with the immediate discount applied, etc. - Detailed information about the product price that can be checked in `ProductDto`, `AppProductDto`, `FavoriteProductDto`, etc. > If the Queenit immediate discount is applied, the product price shown in the existing DTO will be overwritten with the Queenit immediate discount price.", + "required": [ + "finalPrice" + ], + "properties": { + "originalPrice": { + "description": "- Regular price - If the value of this field is `null` -> `finalPrice` will have the meaning of regular price.", + "type": "integer", + "format": "int64" + }, + "finalPrice": { + "description": "- Sales price (price at which actual users purchase the product) - Indicates sales price information before the Queenit instant discount coupon is applied - Indicates the sales price entered when registering the product - If the `originalPrice` and `discountPercentage` fields have `null` values -> This field also has the meaning of the regular price.", + "type": "integer", + "format": "int64" + }, + "discountPercentage": { + "description": "- Discount ratio -> `finalPrice` ratio compared to `originalPrice` - If the value of this field is `null` -> `finalPrice` also has the meaning of the regular price.", + "type": "integer", + "format": "int32" + }, + "originalToDirectCouponDiscountPercentage": { + "description": "- Discount ratio -> `directCouponAppliedFinalPrice` ratio compared to `originalPrice` (the ratio discounted by the instant discount coupon) - If the value of this field is `null` -> it can be considered that the instant discount was not applied.", + "type": "integer", + "format": "int32" + }, + "finalToDirectCouponDiscountPercentage": { + "description": "- Discount ratio -> `directCouponAppliedFinalPrice` to `finalPrice` ratio (the discount ratio applied by the instant discount coupon) - If the value of this field is `null` -> it can be considered that the instant discount was not applied.", + "type": "integer", + "format": "int32" + }, + "directCouponAppliedFinalPrice": { + "description": "- Final purchase price with Queenit instant discount coupon applied - If the value of this field is `null` -> It can be considered that the instant discount was not applied.", + "type": "integer", + "format": "int64" + }, + "originalToMaximumBenefitCouponPricePercentage": { + "description": "- Discount ratio -> `maximumBenefitCouponAppliedFinalPrice` to `originalPrice` ratio (the discount rate applied by the maximum benefit coupon) - If the value of this field is `null` -> it can be considered that the maximum benefit was not applied.", + "type": "integer", + "format": "int32" + }, + "finalToMaximumBenefitCouponPricePercentage": { + "description": "- Discount ratio -> `maximumBenefitCouponAppliedFinalPrice` to `finalPrice` ratio (the discount rate applied by the maximum benefit coupon) - If the value of this field is `null` -> it can be considered that the maximum benefit was not applied.", + "type": "integer", + "format": "int32" + }, + "maximumBenefitCouponAppliedFinalPrice": { + "description": "- Final purchase price with maximum benefit coupon applied - If the value of this field is `null` -> It can be considered that the maximum benefit coupon was not applied.", + "type": "integer", + "format": "int64" + } + } + }, + "SalesStatusEnum": { + "oneOf": [ + { + "const": "ACTIVE" + }, + { + "const": "ARCHIVED" + }, + { + "const": "PERMANENTLY_ARCHIVED" + } + ], + "description": "- `ACTIVE` -> On sale - Currently still on sale - `ARCHIVED` -> Stopped sale - Stopped sale for now, but may be sold in the future - `PERMANENTLY_ARCHIVED` -> Permanently stopped sale - Indicates that the product is no longer for sale ------------ - If the product's sales status is not `ACTIVE`, it is marked as sold out on the detail page. - If the product option's sales status is not `ACTIVE` - The product option is not displayed (filtered and sent down by the server) - It is marked as sold out in the shopping cart (required by the client)" + }, + "ProductDiscountApplicationDto": { + "description": "- DTO to provide discount information applied or applicable to a product - Currently, only DirectCoupon (instant discount coupon) information is included, but related DTOs may be added in the future as other discount benefits are added. - Since it is possible to apply instant discount coupons in layers, `appliedDirectCoupon` should no longer be used, and `appliedDirectCoupons` should be used.", + "type": "object", + "properties": { + "appliedDirectCoupons": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppliedDirectCouponDto" + } + }, + "appliedDirectCoupon": { + "$ref": "#/components/schemas/AppliedDirectCouponDto" + }, + "maximumDiscountCouponAppliedPrice": { + "description": "- Price with maximum coupon discount applied - If the value of this field is `null` -> It can be considered that there is no coupon that satisfies the condition for calculating the maximum discount.", + "type": "integer", + "format": "int64" + } + } + }, + "AppliedDirectCouponDto": { + "type": "object", + "properties": { + "endAtMillis": { + "description": "Indicates when the immediate discount coupon application ends", + "type": "integer", + "format": "int64" + } + } + }, + "ProductContentsDto": { + "type": "object", + "required": [ + "imageUrls", + "multiResolutionImages", + "descriptionPageUrl", + "measurements", + "classifications" + ], + "properties": { + "imageUrls": { + "description": "DEPRECATED", + "type": "array", + "items": { + "type": "string" + } + }, + "multiResolutionImages": { + "$ref": "#/components/schemas/MultiResolutionImageListDto" + }, + "descriptionPageUrl": { + "type": "string" + }, + "measurements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductMeasurementDto" + } + }, + "classifications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductClassificationDto" + } + }, + "announcement": { + "$ref": "#/components/schemas/ProductAnnouncementDto" + } + } + }, + "PersonalProductContentsDto": { + "type": "object", + "properties": { + "imageUrls": { + "description": "DEPRECATED", + "type": "array", + "items": { + "type": "string" + } + }, + "multiResolutionImages": { + "$ref": "#/components/schemas/MultiResolutionImageListDto" + }, + "descriptionPageUrl": { + "type": "string" + }, + "measurements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PersonalProductMeasurementDto" + } + }, + "classifications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductClassificationDto" + } + }, + "announcement": { + "$ref": "#/components/schemas/ProductAnnouncementDto" + }, + "sellerContentImages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SellerContentImagesDto" + }, + "description": "Images registered by the seller" + } + } + }, + "ProductMeasurementDto": { + "type": "object", + "required": [ + "type", + "unitOfLength", + "headers", + "rows" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/ProductMeasurementTypeEnum" + }, + "unitOfLength": { + "type": "string" + }, + "headers": { + "type": "array", + "items": { + "type": "string" + } + }, + "rows": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "PersonalProductMeasurementDto": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/ProductMeasurementTypeEnum" + }, + "unitOfLength": { + "type": "string" + }, + "headers": { + "type": "array", + "items": { + "type": "string" + } + }, + "rows": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "imageUrl": { + "type": "string" + } + } + }, + "ProductMeasurementTypeEnum": { + "oneOf": [ + { + "const": "SHORTS" + }, + { + "const": "SKIRT" + }, + { + "const": "PANTS" + }, + { + "const": "HOODIE" + }, + { + "const": "TSHIRTS" + }, + { + "const": "SWEATER" + }, + { + "const": "SHIRTS" + }, + { + "const": "DRESS" + }, + { + "const": "JUMPER" + }, + { + "const": "JACKET" + }, + { + "const": "PADDED_JACKET" + }, + { + "const": "COAT" + }, + { + "const": "CARDIGAN" + } + ] + }, + "ProductClassificationDto": { + "type": "object", + "required": [ + "criterionId", + "criterionText", + "elements" + ], + "properties": { + "criterionId": { + "type": "string" + }, + "criterionText": { + "type": "string" + }, + "elements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductClassificationElementDto" + } + } + } + }, + "ProductClassificationElementDto": { + "type": "object", + "required": [ + "name", + "classified" + ], + "properties": { + "name": { + "type": "string" + }, + "classified": { + "type": "boolean" + } + } + }, + "ProductAnnouncementDto": { + "type": "object", + "required": [ + "apparelProductAnnouncement", + "beautyProductAnnouncement" + ], + "properties": { + "apparelProductAnnouncement": { + "$ref": "#/components/schemas/ApparelProductAnnouncementDto" + }, + "beautyProductAnnouncement": { + "$ref": "#/components/schemas/BeautyProductAnnouncementDto" + }, + "color": { + "type": "string", + "description": "(DEPRECATED) Color" + }, + "material": { + "type": "string", + "description": "(DEPRECATED) Material" + }, + "measurement": { + "type": "string", + "description": "(DEPRECATED) Dimensions" + }, + "manufacturingCompany": { + "type": "string", + "description": "(DEPRECATED) Manufacturer" + }, + "manufacturingCountry": { + "type": "string", + "description": "(DEPRECATED) Country of Origin" + }, + "manufacturingDate": { + "type": "string", + "description": "(DEPRECATED) Manufacturing date" + }, + "qaStandards": { + "type": "string", + "description": "(DEPRECATED) Quality Assurance Standards" + }, + "customerCenterContact": { + "type": "string", + "description": "(DEPRECATED) A/S Manager and Phone Number" + }, + "washingAndHandling": { + "type": "string", + "description": "(DEPRECATED) Washing Instructions and Handling Precautions" + } + } + }, + "ApparelProductAnnouncementDto": { + "type": "object", + "description": "Notice on Provision of Clothing-Related Product Information", + "required": [ + "manufacturingCompany", + "manufacturingCountry", + "qaStandards", + "customerCenterContact", + "color", + "material", + "measurement", + "manufacturingDate", + "washingAndHandling" + ], + "properties": { + "manufacturingCompany": { + "type": "string", + "description": "Manufacturing company" + }, + "manufacturingCountry": { + "type": "string", + "description": "Country of Origin" + }, + "qaStandards": { + "type": "string", + "description": "Quality Assurance Standards" + }, + "customerCenterContact": { + "type": "string", + "description": "A/S Manager and Phone Number" + }, + "color": { + "type": "string", + "description": "color" + }, + "material": { + "type": "string", + "description": "subject matter" + }, + "measurement": { + "type": "string", + "description": "size" + }, + "manufacturingDate": { + "type": "string", + "description": "Date of manufacture" + }, + "washingAndHandling": { + "type": "string", + "description": "Washing instructions and handling precautions" + } + } + }, + "BeautyProductAnnouncementDto": { + "type": "object", + "description": "Notice on Provision of Product Information Related to Cosmetics (Beauty)", + "required": [ + "manufacturingCompany", + "manufacturingCountry", + "qaStandards", + "customerCenterContact", + "size", + "responsibleSellerCompany", + "usage", + "highlights", + "concerns", + "expiration", + "ingredients", + "mfdsReview" + ], + "properties": { + "manufacturingCompany": { + "type": "string", + "description": "Manufacturing company" + }, + "manufacturingCountry": { + "type": "string", + "description": "Country of Origin" + }, + "qaStandards": { + "type": "string", + "description": "Quality Assurance Standards" + }, + "customerCenterContact": { + "type": "string", + "description": "A/S Manager and Phone Number" + }, + "size": { + "type": "string", + "description": "Cosmetic Capacity" + }, + "responsibleSellerCompany": { + "type": "string", + "description": "Cosmetics Responsible Salesperson" + }, + "usage": { + "type": "string", + "description": "How to use" + }, + "highlights": { + "type": "string", + "description": "Product Key Specifications" + }, + "concerns": { + "type": "string", + "description": "Precautions for use" + }, + "expiration": { + "type": "string", + "description": "Expiration date or expiration date after opening" + }, + "ingredients": { + "type": "string", + "description": "Ingredients (all ingredients that must be listed and indicated according to the Cosmetics Act)" + }, + "mfdsReview": { + "type": "string", + "description": "Whether or not the Ministry of Food and Drug Safety (MFDS = Ministry of Food and Drug Safety) requires review" + } + } + }, + "ProductSetDto": { + "type": "object", + "required": [ + "set", + "favoriteIds", + "freeReturnTargetProductIds" + ], + "properties": { + "set": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDto" + } + }, + "favoriteIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "freeReturnTargetProductIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ProductListDto": { + "type": "object", + "required": [ + "list", + "favoriteIds", + "last", + "freeReturnTargetProductIds" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDto" + } + }, + "favoriteIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + }, + "freeReturnTargetProductIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "FilteredPersonalizedProductRequestDto": { + "type": "object", + "required": [ + "size" + ], + "properties": { + "orderBy": { + "$ref": "#/components/schemas/ProductOrderByEnum" + }, + "cursor": { + "type": "string" + }, + "size": { + "type": "integer", + "format": "int32" + }, + "categoryId": { + "type": "string" + }, + "brandId": { + "type": "string" + }, + "minPrice": { + "type": "integer", + "format": "int64" + }, + "maxPrice": { + "type": "integer", + "format": "int64" + }, + "ageGroupCode": { + "$ref": "#/components/schemas/AgeGroupCodeEnum" + }, + "mySizeOnly": { + "type": "boolean", + "default": false + }, + "tag": { + "$ref": "#/components/schemas/ProductTagEnum" + }, + "tagId": { + "type": "integer", + "description": "(deprecated) use tagIdForBrandSourcing", + "format": "int64" + }, + "tagIdForBrandSourcing": { + "description": "Search for products for BrandSourcings corresponding to tagId", + "type": "integer", + "format": "int64" + }, + "recentlyClickedProducts": { + "type": "array", + "description": "Information about recently clicked products. *The number cannot exceed 100.*", + "items": { + "$ref": "#/components/schemas/ClickedProductDto" + } + }, + "modelId": { + "type": "string", + "description": "- Which personalized model to use. (For A/B Testing) - Notion reference: https://www.notion.so/rapportlabs/AB-Protocol-c878d879ff0443cda929bb17d9b137c1" + }, + "postProcessingId": { + "type": "string", + "description": "- How to post-process the personalized results. (For A/B Testing) - Notion reference: https://www.notion.so/rapportlabs/AB-Protocol-c878d879ff0443cda929bb17d9b137c1" + } + } + }, + "ClickedProductDto": { + "type": "object", + "required": [ + "id", + "clickedAtMillis" + ], + "properties": { + "id": { + "type": "string" + }, + "clickedAtMillis": { + "type": "integer", + "format": "int64", + "description": "The time the product was clicked (in millis)" + } + } + }, + "AppProductListDto": { + "type": "object", + "required": [ + "list", + "favoriteIds", + "last", + "freeReturnTargetProductIds" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppProductDto" + } + }, + "favoriteIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + }, + "productAggregation": { + "$ref": "#/components/schemas/ProductAggregationDto" + }, + "freeReturnTargetProductIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "AppAdvertisementProductListDto": { + "type": "object", + "required": [ + "favoriteIds", + "list", + "totalPageCount", + "totalElementCount", + "freeReturnTargetProductIds" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppAdvertisementProductDto" + } + }, + "favoriteIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "totalPageCount": { + "type": "integer", + "format": "int32" + }, + "totalElementCount": { + "type": "integer", + "format": "int64" + }, + "freeReturnTargetProductIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PersonalProductDto": { + "type": "object", + "required": [ + "product", + "favorite", + "freeReturnTarget", + "discountInfo" + ], + "properties": { + "product": { + "$ref": "#/components/schemas/ProductDto" + }, + "favorite": { + "type": "boolean" + }, + "categoriesFromRoot": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + }, + "contents": { + "$ref": "#/components/schemas/PersonalProductContentsDto" + }, + "mappedBrand": { + "$ref": "#/components/schemas/BrandDto" + }, + "discountInfo": { + "$ref": "#/components/schemas/ProductDiscountApplicationDto" + }, + "freeReturnTarget": { + "type": "boolean" + } + } + }, + "HomeProductCategoryDto": { + "type": "object", + "required": [ + "topSideCategories", + "bottomSideCategories" + ], + "properties": { + "topSideCategories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + }, + "bottomSideCategories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + } + } + }, + "ProductCategoryDto": { + "type": "object", + "required": [ + "id", + "title" + ], + "properties": { + "id": { + "type": "string" + }, + "parentId": { + "type": "string" + }, + "title": { + "type": "string" + }, + "iconUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionIcon": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + } + } + }, + "MallDto": { + "type": "object", + "required": [ + "mallId", + "title" + ], + "properties": { + "mallId": { + "type": "string" + }, + "title": { + "type": "string" + }, + "logoUrl": { + "type": "string" + }, + "logo2xUrl": { + "type": "string" + }, + "logo3xUrl": { + "type": "string" + } + } + }, + "FavoriteProductDto": { + "type": "object", + "required": [ + "id", + "mallId", + "mallName", + "mallProductCode", + "itemImageUri", + "itemThumbnailUri", + "brandName", + "productName", + "productDiscountRate", + "price", + "productPriceDetail", + "shopUri", + "createdAt" + ], + "properties": { + "id": { + "type": "string" + }, + "mallId": { + "type": "string" + }, + "mallName": { + "type": "string" + }, + "mallProductCode": { + "type": "string" + }, + "itemImageUri": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionItemImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "itemThumbnailUri": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionItemThumbnail": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "brandName": { + "type": "string" + }, + "productName": { + "type": "string" + }, + "productDiscountRate": { + "type": "integer", + "format": "int32" + }, + "originalPrice": { + "type": "integer", + "format": "int64" + }, + "price": { + "type": "integer", + "format": "int64" + }, + "productPriceDetail": { + "$ref": "#/components/schemas/ProductPriceDetailDto" + }, + "shopUri": { + "type": "string" + }, + "shopLogoUri": { + "type": "string" + }, + "createdAt": { + "type": "string" + } + } + }, + "FavoriteProductListDto": { + "type": "object", + "required": [ + "list", + "last", + "freeReturnTargetProductIds" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FavoriteProductDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + }, + "freeReturnTargetProductIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ProductItemListDto": { + "type": "object", + "required": [ + "options", + "optionElements", + "productItems" + ], + "properties": { + "options": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OptionDto" + } + }, + "optionElements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OptionElementDto" + } + }, + "productItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductItemDto" + } + } + } + }, + "ProductReleaseEstimateDto": { + "type": "object", + "required": [ + "productId", + "itemReleaseEstimateAtList" + ], + "properties": { + "productId": { + "type": "string", + "description": "Product ID" + }, + "itemReleaseEstimateAtList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductItemReleaseEstimateDto" + } + } + } + }, + "ProductItemReleaseEstimateDto": { + "type": "object", + "required": [ + "productItemId", + "releaseEstimateAt" + ], + "properties": { + "productItemId": { + "type": "string", + "description": "Product Option ID" + }, + "itemReleaseEstimateAtMillis": { + "type": "integer", + "format": "int64", + "description": "Shipment date in yyyy-mm-dd format" + } + } + }, + "ProductItemDto": { + "type": "object", + "required": [ + "id", + "title", + "optionElementIds", + "price", + "display", + "salesStatus", + "mallProductItemCode" + ], + "properties": { + "id": { + "type": "string" + }, + "title": { + "type": "string" + }, + "releaseAtEstimate": { + "type": "string", + "description": "Shipment date in yyyy-mm-dd format" + }, + "optionElementIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "maxQuantity": { + "type": "integer", + "format": "int64" + }, + "price": { + "type": "integer", + "format": "int64" + }, + "display": { + "type": "boolean", + "description": "- Indicates whether the product option is displayed - If false, it is displayed as out of stock" + }, + "salesStatus": { + "$ref": "#/components/schemas/SalesStatusEnum" + }, + "mallProductItemCode": { + "type": "string" + } + } + }, + "OptionDto": { + "type": "object", + "required": [ + "title" + ], + "properties": { + "title": { + "type": "string" + } + } + }, + "OptionElementDto": { + "type": "object", + "required": [ + "id", + "title" + ], + "properties": { + "id": { + "type": "string" + }, + "title": { + "type": "string" + } + } + }, + "ProductItemAvailabilityDto": { + "type": "object", + "required": [ + "productId", + "productItemId", + "available" + ], + "properties": { + "productId": { + "type": "string" + }, + "productItemId": { + "type": "string" + }, + "quantity": { + "description": "- Product option inventory - If this value is `null` -> Internally, inventory is considered unlimited - This value alone cannot determine whether the product is available for purchase -> The `ProductItemAvailabilityDto.available` value is important.", + "type": "integer", + "format": "int64" + }, + "available": { + "description": "Availability of product (value calculated from the value of product ~ product item)", + "type": "boolean" + } + } + }, + "BrandListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BrandDto" + } + } + } + }, + "BrandDto": { + "type": "object", + "required": [ + "id", + "name", + "logo" + ], + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "logo": { + "$ref": "#/components/schemas/BrandLogoDto" + } + } + }, + "BrandLogoDto": { + "type": "object", + "properties": { + "landscapeUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionLandscape": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "squareUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionSquare": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + } + } + }, + "BrandDetailDto": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "logo": { + "$ref": "#/components/schemas/BrandLogoDto" + }, + "categories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + } + } + }, + "BrandProductsDto": { + "type": "object", + "required": [ + "brand", + "list" + ], + "properties": { + "brand": { + "$ref": "#/components/schemas/BrandDto" + }, + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDto" + } + } + } + }, + "BrandProductsListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BrandProductsDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "AddToCartRequestDto": { + "type": "object", + "required": [ + "items" + ], + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AddCartItemDto" + } + } + } + }, + "AddToCartResponseDto": { + "type": "object", + "required": [ + "cartItemIds" + ], + "properties": { + "cartItemIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + } + } + }, + "AddCartItemDto": { + "type": "object", + "required": [ + "productItemId", + "quantity" + ], + "properties": { + "productItemId": { + "type": "string" + }, + "quantity": { + "type": "integer", + "format": "int64" + } + } + }, + "DeleteCartItemsRequestDto": { + "type": "object", + "required": [ + "cartItemIds" + ], + "properties": { + "cartItemIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + } + } + }, + "CartItemGroupDto": { + "type": "object", + "required": [ + "groupId", + "brand", + "delivery", + "items" + ], + "properties": { + "groupId": { + "type": "string" + }, + "brand": { + "$ref": "#/components/schemas/BrandDto" + }, + "delivery": { + "$ref": "#/components/schemas/CartItemGroupDeliveryPolicyDto" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartItemDto" + } + } + } + }, + "CartItemGroupDeliveryPolicyDto": { + "type": "object", + "required": [ + "defaultPrice", + "defaultReturnCost", + "shippingCostPolicy", + "returnCostPolicy", + "logisticsPolicy", + "assorted", + "shippingPolicyId" + ], + "properties": { + "defaultPrice": { + "type": "integer", + "format": "int64", + "description": "DEPRECATED -> use `shippingCostPolicy`" + }, + "requiredAmountForFree": { + "type": "integer", + "format": "int64", + "description": "DEPRECATED -> use `shippingCostPolicy`" + }, + "defaultReturnCost": { + "type": "integer", + "format": "int64", + "description": "DEPRECATED -> use `returnCostPolicy`" + }, + "shippingCostPolicy": { + "$ref": "#/components/schemas/ShippingCostPolicyDto" + }, + "returnCostPolicy": { + "$ref": "#/components/schemas/ReturnCostPolicyDto" + }, + "logisticsPolicy": { + "$ref": "#/components/schemas/LogisticsPolicyDto" + }, + "assorted": { + "type": "boolean" + }, + "shippingPolicyId": { + "type": "integer", + "format": "int64" + } + } + }, + "DeliveryPolicyDto": { + "type": "object", + "required": [ + "defaultPrice", + "defaultReturnCost", + "shippingCostPolicy", + "returnCostPolicy", + "logisticsPolicy" + ], + "properties": { + "defaultPrice": { + "type": "integer", + "format": "int64", + "description": "DEPRECATED -> use `shippingCostPolicy`" + }, + "requiredAmountForFree": { + "type": "integer", + "format": "int64", + "description": "DEPRECATED -> use `shippingCostPolicy`" + }, + "defaultReturnCost": { + "type": "integer", + "format": "int64", + "description": "DEPRECATED -> use `returnCostPolicy`" + }, + "shippingCostPolicy": { + "$ref": "#/components/schemas/ShippingCostPolicyDto" + }, + "returnCostPolicy": { + "$ref": "#/components/schemas/ReturnCostPolicyDto" + }, + "logisticsPolicy": { + "$ref": "#/components/schemas/LogisticsPolicyDto" + } + } + }, + "ShippingCostPolicyDto": { + "type": "object", + "description": "Shipping Policy", + "required": [ + "defaultCost", + "jejuIsland", + "backCountry" + ], + "properties": { + "defaultCost": { + "type": "integer", + "format": "int64" + }, + "jejuIsland": { + "type": "integer", + "format": "int64", + "description": "Additional shipping fee for Jeju Island" + }, + "backCountry": { + "type": "integer", + "format": "int64", + "description": "Additional shipping cost for islands and mountainous areas" + }, + "requiredAmountForFree": { + "type": "integer", + "format": "int64", + "description": "Minimum purchase amount for free shipping" + } + } + }, + "ReturnCostPolicyDto": { + "type": "object", + "description": "Return Policy", + "required": [ + "defaultCost", + "jejuIsland", + "backCountry" + ], + "properties": { + "defaultCost": { + "type": "integer", + "format": "int64", + "description": "Basic return cost without additionalCost taken into account" + }, + "jejuIsland": { + "type": "integer", + "format": "int64", + "description": "Jeju Island additional return fee" + }, + "backCountry": { + "type": "integer", + "format": "int64", + "description": "Additional return fee for islands and mountainous regions" + } + } + }, + "LogisticsPolicyDto": { + "type": "object", + "properties": { + "shippingPlace": { + "type": "string", + "description": "Shipping address" + }, + "returnPlace": { + "type": "string", + "description": "Return Address" + }, + "courier": { + "deprecated": true, + "type": "string", + "description": "- DEPRECATED - Please use `vendor` field - Courier used" + }, + "vendor": { + "$ref": "#/components/schemas/LogisticsVendorEnum" + } + } + }, + "LogisticsVendorEnum": { + "oneOf": [ + { + "const": "CJ๋Œ€ํ•œํ†ต์šด" + }, + { + "const": "๋กœ์  ํƒ๋ฐฐ" + }, + { + "const": "์šฐ์ฒด๊ตญํƒ๋ฐฐ" + }, + { + "const": "ํ•œ์ง„ํƒ๋ฐฐ" + }, + { + "const": "๋กฏ๋ฐํƒ๋ฐฐ" + }, + { + "const": "๋Œ€์‹ ํƒ๋ฐฐ" + }, + { + "const": "์ผ์–‘ํƒ๋ฐฐ" + }, + { + "const": "๊ฒฝ๋™ํƒ๋ฐฐ" + }, + { + "const": "ํ•ฉ๋™ํƒ๋ฐฐ" + }, + { + "const": "์ฒœ์ผํƒ๋ฐฐ" + }, + { + "const": "GSํŽธ์˜์ ํƒ๋ฐฐ" + }, + { + "const": "ํ•œ์˜์‚ฌ๋ž‘ํƒ๋ฐฐ" + }, + { + "const": "๊ฑด์˜ํƒ๋ฐฐ" + }, + { + "const": "ํ˜ธ๋‚จํƒ๋ฐฐ" + }, + { + "const": "SLX" + }, + { + "const": "CUํŽธ์˜์ ํƒ๋ฐฐ" + }, + { + "const": "์šฉ๋งˆ๋กœ์ง€์Šค" + }, + { + "const": "์„ธ๋ฐฉํƒ๋ฐฐ" + }, + { + "const": "์›๋”์Šคํ€ต" + }, + { + "const": "๋†ํ˜‘ํƒ๋ฐฐ" + }, + { + "const": "HIํƒ๋ฐฐ" + }, + { + "const": "ํ™ˆํ”ฝํƒ๋ฐฐ" + }, + { + "const": "CJ๋Œ€ํ•œํ†ต์šด๊ตญ์ œํŠน์†ก" + }, + { + "const": "EMS" + }, + { + "const": "๋กฏ๋ฐ๊ธ€๋กœ๋ฒŒ" + }, + { + "const": "ํ•œ๋ฑ์Šค" + }, + { + "const": "DHL" + }, + { + "const": "FEDEX" + }, + { + "const": "UPS" + }, + { + "const": "TNT" + }, + { + "const": "๋ฒ”ํ•œํŒํ† ์Šค" + }, + { + "const": "ACI Express" + }, + { + "const": "ACE Express" + }, + { + "const": "์€ํ•˜์‰ฌํ•‘" + }, + { + "const": "๋‘๋ฐœํžˆ์–ด๋กœ" + }, + { + "const": "๋กœ์ง€์ŠคํŒŸ" + }, + { + "const": "๋ถ€๋ฆ‰(VROONG)" + }, + { + "const": "์ดํˆฌ๋งˆ์Šค" + }, + { + "const": "์—์ด์Šค๋ฌผ๋ฅ˜" + }, + { + "const": "๋Œ€๋ฆผํ†ต์šด" + }, + { + "const": "๋ฐœ๋ ‰์Šค" + }, + { + "const": "๊ธฐํƒ€๋ฐฐ์†ก์‚ฌ" + }, + { + "const": "์ง์ ‘๋ฐฐ์†ก" + } + ], + "description": "- (Regarding delivery policy) Configurable delivery companies - `ETC (Other delivery company)` -> A specific delivery company is being used, but is not currently supported (If support for other delivery companies is needed, please contact us separately) - `SELF_MANAGED (Direct delivery)` -> Used when delivering directly", + "x-enum-varnames": [ + "CJ_GLS", + "LOGEN", + "EPOST", + "HANJIN", + "LOTTE", + "DAESIN", + "ILYANG", + "KYUNGDONG", + "HAPDONG", + "CHUNIL", + "CVSNET", + "HPL", + "KUNYOUNG", + "HONAM", + "SLX", + "BGF", + "YONGMA", + "SEBANG", + "WONDERS", + "NH_LOGIS", + "HI_LOGIS", + "HOMEPICK", + "KOREX_G", + "EMS", + "LOTTE_GLOBAL", + "HANDEX", + "DHL", + "FEDEX", + "UPS", + "TNT", + "PANTOS", + "ACI_EXPRESS", + "ACE_EXP", + "EUNHA", + "CHAIN_LOGISTICS", + "LOGISPOT", + "VROONG", + "ETOMARS", + "VENDORPIA", + "DAERIM", + "VALEX", + "ETC", + "SELF_MANAGED" + ] + }, + "CartItemDto": { + "type": "object", + "description": "- If `product.salesStatus != ACTIVE || product.display == false` -> Mark as out of stock - If `productItem.salesStatus != ACTIVE || productItem.display == false` -> Mark as out of stock - If QueenIt immediate discount is applied, `ProductDto` shows the amount with the immediate discount applied - Affected fields: `finalPrice`, `discountPercentage`", + "required": [ + "id", + "product", + "productItem", + "quantity", + "brand", + "freeReturnTarget" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "product": { + "$ref": "#/components/schemas/ProductDto" + }, + "productItem": { + "$ref": "#/components/schemas/ProductItemDto" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "brand": { + "$ref": "#/components/schemas/BrandDto" + }, + "freeReturnTarget": { + "type": "boolean" + } + } + }, + "PurchaseTopicEnum": { + "const": "PRODUCT" + }, + "StartOrderRequestDto": { + "type": "object", + "required": [ + "cartItemIds" + ], + "properties": { + "cartItemIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + } + } + }, + "StartOrderFromAddingRequestDto": { + "type": "object", + "required": [ + "items" + ], + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AddCartItemDto" + } + } + } + }, + "DeliveryAddressDto": { + "type": "object", + "required": [ + "recipientName", + "phoneNumber", + "zipCode", + "address", + "detailedAddress" + ], + "properties": { + "recipientName": { + "type": "string" + }, + "phoneNumber": { + "type": "string" + }, + "zipCode": { + "type": "string", + "description": "5 digits, State Basic District Number" + }, + "address": { + "type": "string" + }, + "detailedAddress": { + "type": "string" + } + } + }, + "UserRefundAccountDto": { + "type": "object", + "properties": { + "refundAccount": { + "$ref": "#/components/schemas/RefundAccountDto" + } + } + }, + "RefundAccountDto": { + "type": "object", + "required": [ + "accountNumber", + "bank", + "holderName" + ], + "properties": { + "accountNumber": { + "type": "string" + }, + "bank": { + "$ref": "#/components/schemas/RefundAccountBankEnum" + }, + "holderName": { + "type": "string" + } + } + }, + "ConnectPayPromotionDto": { + "type": "object", + "required": [ + "discountCards", + "interestFreeCards" + ], + "properties": { + "discountCards": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConnectPayDiscountCardDto" + } + }, + "interestFreeCards": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConnectPayInterestFreeCardsDto" + } + } + } + }, + "ConnectPayDiscountCardDto": { + "type": "object", + "required": [ + "card", + "minimumPaymentAmount", + "discountCode", + "discountAmount" + ], + "properties": { + "card": { + "$ref": "#/components/schemas/TossPaymentCardEnum" + }, + "minimumPaymentAmount": { + "type": "integer", + "format": "int64" + }, + "maximumPaymentAmount": { + "type": "integer", + "format": "int64" + }, + "discountCode": { + "description": "discount code should be passed when request payment with connect-pay", + "type": "string" + }, + "discountAmount": { + "type": "integer", + "format": "int64" + } + } + }, + "ConnectPayInterestFreeCardsDto": { + "type": "object", + "required": [ + "card", + "interestFreeMonths", + "minimumPaymentAmount" + ], + "properties": { + "card": { + "$ref": "#/components/schemas/TossPaymentCardEnum" + }, + "interestFreeMonths": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + } + }, + "minimumPaymentAmount": { + "type": "integer", + "format": "int64" + } + } + }, + "TossPaymentPromotionDto": { + "type": "object", + "required": [ + "discountCards", + "interestFreeCards" + ], + "properties": { + "discountCards": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TossPaymentDiscountPolicyDto" + } + }, + "interestFreeCards": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TossPaymentInterestFreePolicyDto" + } + } + } + }, + "TossPaymentDiscountPolicyDto": { + "type": "object", + "required": [ + "card", + "minimumPaymentAmount", + "discountCode", + "discountAmount" + ], + "properties": { + "card": { + "$ref": "#/components/schemas/TossPaymentCardEnum" + }, + "minimumPaymentAmount": { + "type": "integer", + "format": "int64" + }, + "maximumPaymentAmount": { + "type": "integer", + "format": "int64" + }, + "discountCode": { + "description": "discount code should be passed when request payment with toss", + "type": "string" + }, + "discountAmount": { + "type": "integer", + "format": "int64" + } + } + }, + "TossPaymentInterestFreePolicyDto": { + "type": "object", + "required": [ + "card", + "installmentFreeMonths", + "minimumPaymentAmount" + ], + "properties": { + "card": { + "$ref": "#/components/schemas/TossPaymentCardEnum" + }, + "installmentFreeMonths": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + } + }, + "minimumPaymentAmount": { + "type": "integer", + "format": "int64" + } + } + }, + "TossPaymentAccountEnum": { + "oneOf": [ + { + "const": "๋†ํ˜‘" + }, + { + "const": "์šฐ๋ฆฌ" + }, + { + "const": "์‹ ํ•œ" + }, + { + "const": "๊ตญ๋ฏผ" + }, + { + "const": "ํ•˜๋‚˜" + }, + { + "const": "์”จํ‹ฐ" + }, + { + "const": "๊ธฐ์—…" + }, + { + "const": "์‚ฐ์—…" + }, + { + "const": "์ œ์ผ" + }, + { + "const": "๋Œ€๊ตฌ" + }, + { + "const": "๋ถ€์‚ฐ" + }, + { + "const": "์ „๋ถ" + }, + { + "const": "๊ฒฝ๋‚จ" + }, + { + "const": "์ œ์ฃผ" + }, + { + "const": "๊ด‘์ฃผ" + }, + { + "const": "์ƒˆ๋งˆ์„" + }, + { + "const": "์ˆ˜ํ˜‘" + }, + { + "const": "์‹ ํ˜‘" + }, + { + "const": "์šฐ์ฒด๊ตญ" + }, + { + "const": "์ผ€์ด" + }, + { + "const": "์นด์นด์˜ค" + }, + { + "const": "์ €์ถ•" + }, + { + "const": "์‚ฐ๋ฆผ" + }, + { + "const": "UNKNOWN" + } + ], + "x-enum-varnames": [ + "NONGHYUP", + "WOORI", + "SHINHAN", + "KOOKMIN", + "HANA", + "CITI", + "INDUSTRIAL", + "KDB", + "SC", + "DAEGU", + "BUSAN", + "JEONBUK", + "KYONGNAM", + "JEJU", + "KWANGJU", + "SAEMAEUL", + "SUHYUP", + "SHINHYUP", + "POST", + "K_BANK", + "KAKAO_BANK", + "SAVING_SB", + "FORESTRY_SJ", + "UNKNOWN" + ] + }, + "TossPaymentCardEnum": { + "oneOf": [ + { + "const": "์‹ ํ•œ" + }, + { + "const": "ํ˜„๋Œ€" + }, + { + "const": "์‚ผ์„ฑ" + }, + { + "const": "์šฐ๋ฆฌ" + }, + { + "const": "๊ตญ๋ฏผ" + }, + { + "const": "๋กฏ๋ฐ" + }, + { + "const": "๋†ํ˜‘" + }, + { + "const": "ํ•˜๋‚˜" + }, + { + "const": "BC" + }, + { + "const": "์”จํ‹ฐ" + }, + { + "const": "์นด์นด์˜ค๋ฑ…ํฌ" + }, + { + "const": "KDB" + }, + { + "const": "์ˆ˜ํ˜‘" + }, + { + "const": "์ „๋ถ" + }, + { + "const": "์šฐ์ฒด๊ตญ" + }, + { + "const": "์ƒˆ๋งˆ์„" + }, + { + "const": "์ €์ถ•" + }, + { + "const": "์ œ์ฃผ" + }, + { + "const": "๊ด‘์ฃผ" + }, + { + "const": "์‹ ํ˜‘" + }, + { + "const": "JCB" + }, + { + "const": "์œ ๋‹ˆ์˜จํŽ˜์ด" + }, + { + "const": "๋งˆ์Šคํ„ฐ" + }, + { + "const": "๋น„์ž" + }, + { + "const": "๋‹ค์ด๋„ˆ์Šค" + }, + { + "const": "๋””์Šค์ปค๋ฒ„" + }, + { + "const": "UNKNOWN" + } + ], + "x-enum-varnames": [ + "SHINHAN", + "HYUNDAI", + "SAMSUNG", + "WOORI", + "KOOKMIN", + "LOTTE", + "NONGHYUP", + "HANA", + "BC", + "CITI", + "KAKAO_BANK", + "KDB", + "SUHYUP", + "JEONBUK", + "POST", + "SAEMAEUL", + "SAVING_SB", + "JEJU", + "KWANGJU", + "SHINHYUP", + "JCB", + "UNION_PAY", + "MASTER_CARD", + "VISA", + "DINERS_CLUB", + "DISCOVER", + "UNKNOWN" + ] + }, + "RefundAccountBankEnum": { + "oneOf": [ + { + "const": "๋†ํ˜‘" + }, + { + "const": "๊ตญ๋ฏผ" + }, + { + "const": "์šฐ๋ฆฌ" + }, + { + "const": "์‹ ํ•œ" + }, + { + "const": "๊ธฐ์—…" + }, + { + "const": "ํ•˜๋‚˜" + }, + { + "const": "๊ฒฝ๋‚จ" + }, + { + "const": "๋Œ€๊ตฌ" + }, + { + "const": "๋ถ€์‚ฐ" + }, + { + "const": "์ˆ˜ํ˜‘" + }, + { + "const": "์šฐ์ฒด๊ตญ" + }, + { + "const": "์‚ฐ์—…" + }, + { + "const": "SC์ œ์ผ" + }, + { + "const": "์”จํ‹ฐ" + }, + { + "const": "๊ด‘์ฃผ" + }, + { + "const": "์ œ์ฃผ" + }, + { + "const": "์ „๋ถ" + }, + { + "const": "์ƒˆ๋งˆ์„" + }, + { + "const": "์‹ ํ˜‘" + }, + { + "const": "์ผ€์ด" + }, + { + "const": "์นด์นด์˜ค" + } + ], + "x-enum-varnames": [ + "NONGHYUP", + "KOOKMIN", + "WOORI", + "SHINHAN", + "INDUSTRIAL", + "HANA", + "KYONGNAM", + "DAEGU", + "BUSAN", + "SUHYUP", + "POST", + "KDB", + "SC", + "CITI", + "KWANGJU", + "JEJU", + "JEONBUK", + "SAEMAEUL", + "SHINHYUP", + "K_BANK", + "KAKAO_BANK" + ] + }, + "BankNameEnum": { + "oneOf": [ + { + "const": "๋†ํ˜‘" + }, + { + "const": "๊ตญ๋ฏผ" + }, + { + "const": "์šฐ๋ฆฌ" + }, + { + "const": "์‹ ํ•œ" + }, + { + "const": "๊ธฐ์—…" + }, + { + "const": "ํ•˜๋‚˜" + }, + { + "const": "๊ฒฝ๋‚จ" + }, + { + "const": "๋Œ€๊ตฌ" + }, + { + "const": "๋ถ€์‚ฐ" + }, + { + "const": "์ˆ˜ํ˜‘" + }, + { + "const": "์šฐ์ฒด๊ตญ" + }, + { + "const": "์‚ฐ์—…" + }, + { + "const": "SC์ œ์ผ" + }, + { + "const": "์”จํ‹ฐ" + }, + { + "const": "๊ด‘์ฃผ" + }, + { + "const": "์ œ์ฃผ" + }, + { + "const": "์ „๋ถ" + }, + { + "const": "์ƒˆ๋งˆ์„" + }, + { + "const": "์‹ ํ˜‘" + }, + { + "const": "์ผ€์ด" + }, + { + "const": "์นด์นด์˜ค" + } + ], + "description": "Bank name", + "x-enum-varnames": [ + "NONGHYUP", + "KOOKMIN", + "WOORI", + "SHINHAN", + "INDUSTRIAL", + "HANA", + "KYONGNAM", + "DAEGU", + "BUSAN", + "SUHYUP", + "POST", + "KDB", + "SC", + "CITI", + "KWANGJU", + "JEJU", + "JEONBUK", + "SAEMAEUL", + "SHINHYUP", + "K_BANK", + "KAKAO_BANK" + ] + }, + "ProductPurchaseMaterialDto": { + "type": "object", + "required": [ + "purchaseId", + "recentDeliveredRequests", + "issuedCoupons", + "orderSummary", + "payableMethodIds", + "tossPaymentsInterestFreePolicies" + ], + "properties": { + "purchaseId": { + "type": "string" + }, + "recentDeliveredRequests": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserDeliveryAddressDto" + } + }, + "recommendedIssuedCouponId": { + "type": "integer", + "format": "int64" + }, + "issuedCoupons": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IssuedCouponWhenOrderDto" + } + }, + "orderSummary": { + "$ref": "#/components/schemas/OrderSummaryDto" + }, + "refundAccount": { + "$ref": "#/components/schemas/RefundAccountDto" + }, + "payableMethodIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "tossPaymentsInterestFreePolicies": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TossPaymentInterestFreePolicyDto" + } + } + } + }, + "StartIamportPaymentRequestDto": { + "type": "object", + "required": [ + "pg", + "pgMethod" + ], + "properties": { + "pg": { + "type": "string", + "description": "payment gateway id" + }, + "pgMethod": { + "type": "string", + "description": "payment gateway dependent method" + } + } + }, + "IamportPaymentMaterialDto": { + "type": "object", + "required": [ + "storeId", + "pg", + "merchantId", + "productName", + "productPrice", + "currency", + "language", + "buyerTel", + "payMethod" + ], + "properties": { + "storeId": { + "type": "string", + "description": "store id (ex. 'imp*')" + }, + "pg": { + "type": "string", + "description": "payment gateway id" + }, + "merchantId": { + "type": "string", + "description": "generated merchantId for this payment" + }, + "productName": { + "type": "string", + "description": "product name to show to user" + }, + "productPrice": { + "type": "integer", + "format": "int64", + "description": "Payment price as KRW" + }, + "currency": { + "type": "string", + "description": "KRW" + }, + "language": { + "type": "string", + "description": "ko" + }, + "buyerTel": { + "type": "string", + "description": "buyer phone number" + }, + "payMethod": { + "type": "string", + "description": "Pay method (ex. card)" + }, + "naverProducts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NaverProductDto" + } + } + } + }, + "NaverProductDto": { + "type": "object", + "required": [ + "categoryType", + "categoryId", + "uid", + "name", + "count" + ], + "properties": { + "categoryType": { + "type": "string" + }, + "categoryId": { + "type": "string" + }, + "uid": { + "type": "string" + }, + "name": { + "type": "string" + }, + "count": { + "type": "integer", + "format": "int64" + } + } + }, + "StartConnectPayPaymentRequestDto": { + "type": "object", + "required": [ + "payMethod" + ], + "properties": { + "payMethod": { + "$ref": "#/components/schemas/ConnectPayPaymentMethodEnum" + } + } + }, + "ConnectPayPaymentMethodEnum": { + "oneOf": [ + { + "const": "CARD" + }, + { + "const": "ACCOUNT_TRANSFER" + } + ] + }, + "ConnectPayPaymentMaterialDto": { + "type": "object", + "required": [ + "clientKey", + "customerKey", + "amount", + "merchantId", + "title", + "successUrl", + "failUrl", + "redirectUrl" + ], + "properties": { + "clientKey": { + "type": "string", + "description": "clientKey for ConnectPay JS SDK authentication" + }, + "customerKey": { + "type": "string", + "description": "The user's external uid used when requesting payment." + }, + "amount": { + "type": "integer", + "format": "int64", + "description": "Actual amount paid (amount)" + }, + "merchantId": { + "type": "string", + "description": "Unique ID for order-payment transaction (OrderID)" + }, + "title": { + "type": "string", + "description": "Order Name for payment (OrderName)" + }, + "successUrl": { + "type": "string", + "description": "Redirect URL when payment is successful" + }, + "failUrl": { + "type": "string", + "description": "Redirect URL when payment fails" + }, + "redirectUrl": { + "type": "string", + "description": "Redirect url to be used when authenticating with ConnectPay OAuth" + } + } + }, + "StartTossPaymentRequestDto": { + "type": "object", + "required": [ + "payMethod" + ], + "properties": { + "payMethod": { + "$ref": "#/components/schemas/TossPaymentMethodEnum" + } + } + }, + "TossPaymentMethodEnum": { + "oneOf": [ + { + "const": "CARD" + }, + { + "const": "VIRTUAL_ACCOUNT" + }, + { + "const": "MOBILE" + }, + { + "const": "KAKAO_PAY" + }, + { + "const": "TOSS_PAY" + }, + { + "const": "APPLE_PAY" + } + ] + }, + "TossPaymentMaterialDto": { + "type": "object", + "required": [ + "clientKey", + "amount", + "payMethod", + "merchantId", + "title", + "successUrl", + "failUrl", + "customerMobilePhone" + ], + "properties": { + "clientKey": { + "type": "string" + }, + "amount": { + "type": "integer", + "format": "int64" + }, + "payMethod": { + "type": "string" + }, + "merchantId": { + "type": "string" + }, + "title": { + "type": "string" + }, + "successUrl": { + "type": "string" + }, + "failUrl": { + "type": "string" + }, + "virtualAccountCallbackUrl": { + "type": "string" + }, + "customerName": { + "type": "string" + }, + "customerMobilePhone": { + "type": "string" + } + } + }, + "DryRunPaymentMaterialDto": { + "type": "object", + "required": [ + "merchantId" + ], + "properties": { + "merchantId": { + "type": "string", + "description": "generated merchantId for this payment" + } + } + }, + "FreePaymentMaterialDto": { + "type": "object", + "required": [ + "merchantId" + ], + "properties": { + "merchantId": { + "type": "string", + "description": "generated merchantId for this payment" + } + } + }, + "OLCEstimationRequestDto": { + "type": "object", + "required": [ + "partials" + ], + "properties": { + "partials": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartialOrderItemDto" + } + } + } + }, + "PartialOrderItemDto": { + "type": "object", + "required": [ + "orderItemId", + "quantity" + ], + "properties": { + "orderItemId": { + "type": "string" + }, + "quantity": { + "type": "integer", + "format": "int64" + } + } + }, + "OrderItemPurchaseStateEnum": { + "oneOf": [ + { + "const": "WAIT" + }, + { + "const": "PAID" + }, + { + "const": "REFUNDED" + } + ] + }, + "ProductSearchingOrderByEnum": { + "oneOf": [ + { + "const": "MATCHING_SCORE_DESC" + }, + { + "const": "POPULARITY" + }, + { + "const": "RATING_DESC" + }, + { + "const": "FINAL_PRICE_DESC" + }, + { + "const": "FINAL_PRICE_ASC" + }, + { + "const": "DISCOUNT_PERCENTAGE_DESC" + }, + { + "const": "REVIEW_COUNT_DESC" + }, + { + "const": "REVIEW_RATING_AVG_DESC" + }, + { + "const": "CREATED_AT_DESC" + } + ] + }, + "OrderHistoryListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "MyOrderHistoryListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MyOrderHistoryDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "MyOrderHistoryDto": { + "type": "object", + "properties": { + "orderSummary": { + "$ref": "#/components/schemas/MyOrderSummaryDto" + }, + "deliveryRequest": { + "$ref": "#/components/schemas/DeliveryRequestDto" + }, + "purchaseResult": { + "$ref": "#/components/schemas/PurchaseResultDto" + } + } + }, + "OrderHistoryDto": { + "type": "object", + "required": [ + "orderSummary", + "deliveryRequest", + "purchaseResult" + ], + "properties": { + "orderSummary": { + "$ref": "#/components/schemas/OrderSummaryDto" + }, + "deliveryRequest": { + "$ref": "#/components/schemas/DeliveryRequestDto" + }, + "purchaseResult": { + "$ref": "#/components/schemas/PurchaseResultDto" + } + } + }, + "MyOrderLineTicketListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MyOrderLineTicketDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "MyOrderLineTicketDto": { + "type": "object", + "required": [ + "ticketType", + "createdAtMillis" + ], + "properties": { + "ticketType": { + "$ref": "#/components/schemas/OrderLineTicketEnum" + }, + "returnTicket": { + "$ref": "#/components/schemas/OrderLineReturnTicketWithOrderDto" + }, + "cancelTicket": { + "$ref": "#/components/schemas/OrderLineCancelTicketWithOrderDto" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + } + } + }, + "MyOLTicketsCountDto": { + "type": "object", + "required": [ + "cancelTicket", + "returnTicket" + ], + "properties": { + "cancelTicket": { + "$ref": "#/components/schemas/OrderLineTicketCountDto" + }, + "returnTicket": { + "$ref": "#/components/schemas/OrderLineTicketCountDto" + } + } + }, + "OrderLineTicketCountDto": { + "type": "object", + "required": [ + "inProgress", + "resolved" + ], + "properties": { + "inProgress": { + "description": "Number of tickets in progress (returned or cancelled)", + "type": "integer", + "format": "int32" + }, + "resolved": { + "description": "Number of tickets completed (returned or cancelled) in the last 4 days", + "type": "integer", + "format": "int32" + } + } + }, + "DeliveryRequestDto": { + "type": "object", + "required": [ + "address" + ], + "properties": { + "address": { + "$ref": "#/components/schemas/DeliveryAddressDto" + }, + "request": { + "type": "string" + } + } + }, + "PurchaseResultDto": { + "type": "object", + "required": [ + "paymentId", + "payemntVendor", + "paymentMethod", + "paidAmount", + "refundedAmount", + "purchaseState" + ], + "properties": { + "paymentId": { + "type": "string" + }, + "paymentVendor": { + "type": "string" + }, + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethodEnum" + }, + "virtualAccount": { + "$ref": "#/components/schemas/VirtualAccountDto" + }, + "card": { + "$ref": "#/components/schemas/CardDto" + }, + "paidAmount": { + "type": "integer", + "format": "int64" + }, + "refundedAmount": { + "type": "integer", + "format": "int64" + }, + "purchaseState": { + "$ref": "#/components/schemas/PurchaseStateEnum" + }, + "completedAtMillis": { + "type": "integer", + "format": "int64" + } + } + }, + "VirtualAccountDto": { + "type": "object", + "required": [ + "accountNumber", + "bank", + "customerName" + ], + "properties": { + "accountNumber": { + "type": "string" + }, + "bank": { + "type": "string" + }, + "customerName": { + "type": "string" + }, + "dueDateMillis": { + "type": "integer", + "format": "int64" + } + } + }, + "CardDto": { + "type": "object", + "required": [ + "companyName" + ], + "properties": { + "companyName": { + "description": "Card companies (e.g. Hana, Shinhan, BC Card)", + "type": "string" + }, + "installmentPlanMonths": { + "description": "Number of installment months (if 0, lump sum payment)", + "minimum": 0, + "format": "int32", + "type": "integer" + }, + "interestFreeInstallment": { + "description": "Interest-free installment plan", + "type": "boolean" + } + } + }, + "PaymentMethodEnum": { + "oneOf": [ + { + "const": "CARD" + }, + { + "const": "ACCOUNT_TRANSFER" + }, + { + "const": "KAKAO_PAY" + }, + { + "const": "NAVER_PAY" + }, + { + "const": "TOSS_PAY" + }, + { + "const": "VIRTUAL_ACCOUNT" + }, + { + "const": "DRY" + }, + { + "const": "MOBILE" + }, + { + "const": "FREE" + }, + { + "const": "APPLE_PAY" + } + ] + }, + "RefundPaymentMethodEnum": { + "oneOf": [ + { + "const": "CARD" + }, + { + "const": "ACCOUNT_TRANSFER" + }, + { + "const": "KAKAO_PAY" + }, + { + "const": "NAVER_PAY" + }, + { + "const": "TOSS_PAY" + }, + { + "const": "VIRTUAL_ACCOUNT" + }, + { + "const": "DRY" + }, + { + "const": "MOBILE" + }, + { + "const": "FREE" + }, + { + "const": "APPLE_PAY" + }, + { + "const": "POINT" + } + ] + }, + "RefundPaymentVendorEnum": { + "oneOf": [ + { + "const": "IAMPORT" + }, + { + "const": "TOSS_PAYMENTS" + }, + { + "const": "DRY_RUN" + }, + { + "const": "CONNECT_PAY" + }, + { + "const": "FREE" + } + ] + }, + "PurchaseStateEnum": { + "oneOf": [ + { + "const": "WAIT" + }, + { + "const": "WAITING_FOR_DEPOSIT" + }, + { + "const": "COMPLETED" + }, + { + "const": "ABORTED" + } + ] + }, + "MyOrderSummaryDto": {}, + "OrderSummaryDto": { + "type": "object", + "properties": { + "totalProductPrice": { + "type": "integer", + "format": "int64" + }, + "totalDeliveryPrice": { + "type": "integer", + "format": "int64" + }, + "serviceCharge": { + "type": "integer", + "format": "int64" + }, + "discountAmount": { + "type": "integer", + "format": "int64" + }, + "finalPurchaseAmount": { + "type": "integer", + "format": "int64" + }, + "usePoint": { + "type": "integer", + "format": "int64" + }, + "id": { + "type": "string", + "description": "(deprecated) use orderId" + }, + "orderId": { + "type": "string" + }, + "costElements": { + "type": "array", + "description": "- Field for expressing price details of PriceSetDto - It will be gradually expanded, but currently only displays detailed information about shipping costs..", + "items": { + "$ref": "#/components/schemas/CostElementDto" + } + }, + "appliedCouponCode": { + "type": "string", + "description": "Access it through appliedCoupon.coupon.code.", + "deprecated": true + }, + "appliedCoupon": { + "$ref": "#/components/schemas/IssuedCouponDto" + }, + "itemGroups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderItemGroupDto" + } + }, + "confirmedAtMillis": { + "type": "integer", + "format": "int64" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + } + } + }, + "PriceSetDeltaDto": { + "type": "object", + "required": [ + "totalProductPrice", + "totalDeliveryPrice", + "serviceCharge", + "discountAmount", + "finalPurchaseAmount" + ], + "properties": { + "totalProductPrice": { + "type": "integer", + "format": "int64" + }, + "totalDeliveryPrice": { + "type": "integer", + "format": "int64" + }, + "serviceCharge": { + "type": "integer", + "format": "int64" + }, + "discountAmount": { + "type": "integer", + "format": "int64" + }, + "finalPurchaseAmount": { + "type": "integer", + "format": "int64" + }, + "usePoint": { + "type": "integer", + "format": "int64" + }, + "costElements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CostElementDto" + } + } + } + }, + "DeliveryPriceDto": { + "type": "object", + "required": [ + "normal", + "jeju", + "backCountry" + ], + "properties": { + "normal": { + "type": "integer", + "format": "int64" + }, + "jeju": { + "type": "integer", + "format": "int64" + }, + "backCountry": { + "type": "integer", + "format": "int64" + } + } + }, + "PriceSetDto": { + "type": "object", + "required": [ + "totalProductPrice", + "totalDeliveryPrice", + "serviceCharge", + "discountAmount", + "finalPurchaseAmount" + ], + "properties": { + "totalProductPrice": { + "type": "integer", + "format": "int64" + }, + "totalDeliveryPrice": { + "type": "integer", + "format": "int64" + }, + "serviceCharge": { + "type": "integer", + "format": "int64" + }, + "discountAmount": { + "type": "integer", + "format": "int64" + }, + "finalPurchaseAmount": { + "type": "integer", + "format": "int64" + }, + "usePoint": { + "type": "integer", + "format": "int64" + } + } + }, + "MyOrderItemGroupDto": { + "type": "object", + "properties": { + "groupId": { + "type": "string" + }, + "mall": { + "$ref": "#/components/schemas/MallDto" + }, + "brand": { + "$ref": "#/components/schemas/BrandDto" + }, + "costElements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CostElementDto" + } + }, + "deliveryPrice": { + "type": "integer", + "format": "int64" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MyOrderItemDto" + } + } + } + }, + "OrderItemGroupDto": { + "type": "object", + "required": [ + "groupId", + "mall", + "brand", + "deliveryPrice", + "items" + ], + "properties": { + "groupId": { + "type": "string" + }, + "mall": { + "$ref": "#/components/schemas/MallDto" + }, + "brand": { + "$ref": "#/components/schemas/BrandDto" + }, + "costElements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CostElementDto" + } + }, + "deliveryPrice": { + "type": "integer", + "format": "int64" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderItemDto" + } + } + } + }, + "CostElementDto": { + "type": "object", + "required": [ + "type", + "amount" + ], + "description": "- DTO that expresses detailed price information - Currently, detailed information exists only for shipping and return costs..", + "properties": { + "type": { + "$ref": "#/components/schemas/CostTypeEnum" + }, + "amount": { + "type": "integer", + "format": "int64" + } + } + }, + "CostTypeEnum": { + "oneOf": [ + { + "const": "SHIPPING_COST_NORMAL" + }, + { + "const": "SHIPPING_COST_JEJU" + }, + { + "const": "SHIPPING_COST_BACK_COUNTRY" + }, + { + "const": "RETURN_COST_NORMAL" + }, + { + "const": "RETURN_COST_JEJU" + }, + { + "const": "RETURN_COST_BACK_COUNTRY" + }, + { + "const": "RETURN_COST_TO_REFUND_FREE_SHIPPING" + } + ] + }, + "MyOrderItemDto": {}, + "DividedOrderItemDto": {}, + "EachOLCEstimationDto": { + "required": [ + "orderItemId", + "quantity", + "totalProductPrice", + "totalDiscountAmount", + "finalPurchaseAmount", + "usePoint" + ], + "properties": { + "orderItemId": { + "type": "string" + }, + "totalProductPrice": { + "type": "integer", + "format": "int64" + }, + "finalPurchaseAmount": { + "type": "integer", + "format": "int64" + }, + "totalDiscountAmount": { + "type": "integer", + "format": "int64" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "usePoint": { + "type": "integer", + "format": "int64" + } + } + }, + "EachOLREstimationDto": { + "required": [ + "orderItemId", + "quantity", + "totalProductPrice", + "totalDiscountAmount", + "finalPurchaseAmount", + "usePoint" + ], + "properties": { + "orderItemId": { + "type": "string" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "totalProductPrice": { + "type": "integer", + "format": "int64" + }, + "finalPurchaseAmount": { + "type": "integer", + "format": "int64" + }, + "totalDiscountAmount": { + "type": "integer", + "format": "int64" + }, + "usePoint": { + "type": "integer", + "format": "int64" + } + } + }, + "OrderItemDto": { + "required": [ + "id", + "product", + "productItem", + "singlePrice", + "quantity", + "singleDirectDiscountAmount", + "totalPrice", + "state", + "purchaseState", + "delivery", + "totalProductPrice", + "finalPurchaseAmount", + "totalDiscountAmount", + "totalDirectDiscountAmount", + "brand", + "receiptConfirmation", + "finalSinglePrice", + "freeReturnTarget" + ], + "properties": { + "id": { + "type": "string" + }, + "product": { + "$ref": "#/components/schemas/ProductDto" + }, + "productItem": { + "$ref": "#/components/schemas/ProductItemDto" + }, + "singlePrice": { + "description": "Product price (Queenit instant discount not reflected)", + "type": "integer", + "format": "int64" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "singleDirectDiscountAmount": { + "description": "Queenit instant discount", + "type": "integer", + "format": "int64" + }, + "totalPrice": { + "description": "(deprecated) Use `totalProductPrice` instead.", + "type": "integer", + "format": "int64" + }, + "totalProductPrice": { + "description": "Total product price (`(singlePrice - singleDirectDiscountAmount) * quantity`)", + "type": "integer", + "format": "int64" + }, + "finalPurchaseAmount": { + "description": "Actual payment amount (`totalProductPrice - totalDiscountAmount - usePoint`)", + "type": "integer", + "format": "int64" + }, + "usePoint": { + "description": "Points of use", + "type": "integer", + "format": "int64" + }, + "totalDiscountAmount": { + "description": "Total cart coupon discount amount (`singleDiscountAmount * quantity + residueDiscountAmount`)", + "type": "integer", + "format": "int64" + }, + "totalDirectDiscountAmount": { + "description": "Total Queenit instant discount amount (`singleDirectDiscountAmount * quantity`)", + "type": "integer", + "format": "int64" + }, + "finalSinglePrice": { + "description": "Product price (`singlePrice - singleDirectDiscountAmount`)", + "type": "integer", + "format": "int64" + }, + "state": { + "$ref": "#/components/schemas/OrderStateEnum" + }, + "purchaseState": { + "$ref": "#/components/schemas/OrderItemPurchaseStateEnum" + }, + "delivery": { + "$ref": "#/components/schemas/DeliveryProgressDto" + }, + "primaryCancelTicket": { + "$ref": "#/components/schemas/OLCTicketDto" + }, + "primaryReturnTicket": { + "$ref": "#/components/schemas/OLRTicketDto" + }, + "brand": { + "$ref": "#/components/schemas/BrandDto" + }, + "receiptConfirmation": { + "type": "boolean" + }, + "receiptConfirmedAtMillis": { + "type": "integer", + "format": "int64" + }, + "freeReturnTarget": { + "type": "boolean" + } + } + }, + "DeliveryProgressDto": { + "type": "object", + "required": [ + "state" + ], + "properties": { + "vendorName": { + "type": "string" + }, + "vendorDeliveryNumber": { + "type": "string" + }, + "detailUrl": { + "type": "string" + }, + "state": { + "$ref": "#/components/schemas/DeliveryStateEnum" + }, + "shippedAtMillis": { + "description": "This is the time when the order was shipped. This means the time when it was changed to shipping..", + "type": "integer", + "format": "int64" + } + } + }, + "DeliveryStateEnum": { + "oneOf": [ + { + "const": "WAIT" + }, + { + "const": "PREPARING" + }, + { + "const": "IN_DELIVERY" + }, + { + "const": "COMPLETED" + }, + { + "const": "CANCELLED" + } + ] + }, + "OrderByEnum": { + "oneOf": [ + { + "const": "ASC" + }, + { + "const": "DESC" + } + ] + }, + "ProductOrderByEnum": { + "oneOf": [ + { + "const": "RECOMMENDATION" + }, + { + "const": "POPULARITY" + }, + { + "const": "CREATED_AT_DESC" + }, + { + "const": "FINAL_PRICE_DESC" + }, + { + "const": "FINAL_PRICE_ASC" + }, + { + "const": "DISCOUNT_PERCENTAGE_DESC" + }, + { + "const": "REVIEW_COUNT_DESC" + }, + { + "const": "REVIEW_RATING_AVG_DESC" + } + ] + }, + "OrderStateEnum": { + "oneOf": [ + { + "const": "WAIT" + }, + { + "const": "PURCHASED" + }, + { + "const": "REFUNDED" + }, + { + "const": "PREPARING_PRODUCTS" + }, + { + "const": "IN_DELIVERY" + }, + { + "const": "DELIVERY_COMPLETED" + }, + { + "const": "ABORTED" + } + ] + }, + "OrderLineTicketStateEnum": { + "oneOf": [ + { + "const": "SUBMITTED" + }, + { + "const": "CONFIRMED" + }, + { + "const": "RESOLVED" + }, + { + "const": "WITHDRAWN" + }, + { + "const": "REJECTED" + } + ], + "description": "Cancellation (return) request status - SUBMITTED: Cancellation (return) has been requested - CONFIRMED: Cancellation (return) request has been approved (processing in progress) - RESOLVED: Cancellation (return) request has been closed (amount refunded to customer) - WITHDRAWN: Cancellation (return) request has been withdrawn by customer - REJECTED: Cancellation (return) request has been rejected by seller/admin" + }, + "OrderLineReturnStateEnum": { + "oneOf": [ + { + "const": "WAITING" + }, + { + "const": "IN_RECALL_DELIVERY_READY" + }, + { + "const": "IN_RECALL_DELIVERY_PROCESSING" + }, + { + "const": "RECALL_DELIVERY_COMPLETED" + }, + { + "const": "REJECTED" + }, + { + "const": "RESOLVED" + }, + { + "const": "WITHDRAWN" + } + ], + "description": "Return request status - WAITING: The customer has requested a return and is waiting for approval from the seller/admin. - IN_RECALL_DELIVERY_READY: (Only in case of Goodsflow integration) After approval, preparing for collection. - IN_RECALL_DELIVERY_PROCESSING: (In case of Goodsflow integration) After being picked up by the delivery person and handed over, collecting to the return address. (In case of not being integrated with Goodsflow, collecting by the seller.) - RECALL_DELIVERY_COMPLETED: (Only in case of Goodsflow integration) Delivery of the collection has been completed (under inspection) - REJECTED: The return request has been closed (the seller/admin has rejected the return request) - RESOLVED: The return request has been closed (the amount has been refunded to the customer) - WITHDRAWN: The customer has withdrawn after the return request." + }, + "OrderLineTicketEnum": { + "oneOf": [ + { + "const": "CANCEL" + }, + { + "const": "RETURN" + } + ], + "description": "- Order Ticket Type - CANCEL: Cancel - RETURN: Return" + }, + "AuditorGroupEnum": { + "oneOf": [ + { + "const": "SYSTEM" + }, + { + "const": "CX_ADMIN" + }, + { + "const": "SELLER_ADMIN" + }, + { + "const": "USER" + } + ], + "description": "Unit of entity that changed the ticket status - SYSTEM: Status changed automatically by the system - CX_ADMIN: Status changed by the CX team - SELLER_ADMIN: Status changed by the seller - USER: Status changed by the customer" + }, + "OLCEstimationDto": { + "type": "object", + "required": [ + "priceDelta" + ], + "properties": { + "orderItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderItemDto" + } + }, + "priceDelta": { + "$ref": "#/components/schemas/PriceSetDeltaDto" + } + } + }, + "OLCEstimationResultDto": { + "type": "object", + "required": [ + "priceDelta", + "eachEstimations" + ], + "properties": { + "eachEstimations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EachOLCEstimationDto" + } + }, + "priceDelta": { + "$ref": "#/components/schemas/PriceSetDeltaDto" + }, + "refundPaymentInfos": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RefundPaymentInfoDto" + } + } + } + }, + "OLCRequestDto": { + "type": "object", + "required": [ + "partials", + "reason" + ], + "properties": { + "partials": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartialOrderItemDto" + } + }, + "reason": { + "type": "string" + } + } + }, + "OLCTicketDto": { + "type": "object", + "required": [ + "ticketId", + "state", + "reason", + "createdAtMillis", + "orderItems" + ], + "properties": { + "ticketId": { + "type": "string" + }, + "state": { + "$ref": "#/components/schemas/OrderLineTicketStateEnum" + }, + "auditorGroup": { + "$ref": "#/components/schemas/AuditorGroupEnum" + }, + "reason": { + "type": "string" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + }, + "confirmedAtMillis": { + "type": "integer", + "format": "int64" + }, + "withdrawnAtMillis": { + "type": "integer", + "format": "int64" + }, + "rejectedAtMillis": { + "type": "integer", + "format": "int64" + }, + "rejectReason": { + "type": "string" + }, + "resolvedAtMillis": { + "type": "integer", + "format": "int64" + }, + "resolvedPriceDelta": { + "$ref": "#/components/schemas/PriceSetDeltaDto" + }, + "refundPaymentInfos": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RefundPaymentInfoDto" + } + }, + "orderItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderItemDto" + } + } + } + }, + "OrderLineCancelTicketWithOrderDto": { + "type": "object", + "properties": { + "ticketId": { + "type": "string" + }, + "state": { + "$ref": "#/components/schemas/OrderLineTicketStateEnum" + }, + "auditorGroup": { + "$ref": "#/components/schemas/AuditorGroupEnum" + }, + "reason": { + "type": "string" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + }, + "confirmedAtMillis": { + "type": "integer", + "format": "int64" + }, + "withdrawnAtMillis": { + "type": "integer", + "format": "int64" + }, + "rejectedAtMillis": { + "type": "integer", + "format": "int64" + }, + "rejectReason": { + "type": "string" + }, + "resolvedAtMillis": { + "type": "integer", + "format": "int64" + }, + "resolvedPriceDelta": { + "$ref": "#/components/schemas/PriceSetDeltaDto" + }, + "refundPaymentInfos": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RefundPaymentInfoDto" + } + }, + "orderItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderItemDto" + } + }, + "linkedOrder": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + }, + "OLREstimateRequestDto": { + "type": "object", + "required": [ + "isCustomerNegligence", + "partials" + ], + "properties": { + "isCustomerNegligence": { + "type": "boolean" + }, + "partials": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartialOrderItemDto" + } + } + } + }, + "OLREstimationResultDto": { + "type": "object", + "required": [ + "priceDelta", + "eachEstimations" + ], + "properties": { + "eachEstimations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EachOLREstimationDto" + } + }, + "priceDelta": { + "$ref": "#/components/schemas/PriceSetDeltaDto" + }, + "refundPaymentInfos": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RefundPaymentInfoDto" + } + } + } + }, + "OLRRequestDto": { + "type": "object", + "required": [ + "partials", + "isCustomerNegligence", + "returnAddress", + "reason" + ], + "properties": { + "partials": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartialOrderItemDto" + } + }, + "isCustomerNegligence": { + "type": "boolean" + }, + "returnAddress": { + "$ref": "#/components/schemas/DeliveryAddressDto" + }, + "reason": { + "type": "string" + }, + "imageUrls": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "OLRTicketDto": { + "type": "object", + "required": [ + "ticketId", + "state", + "returnState", + "isCustomerNegligence", + "returnAddress", + "reason", + "createdAtMillis", + "orderItems" + ], + "properties": { + "ticketId": { + "type": "string" + }, + "isCustomerNegligence": { + "type": "boolean" + }, + "returnAddress": { + "$ref": "#/components/schemas/DeliveryAddressDto" + }, + "state": { + "$ref": "#/components/schemas/OrderLineTicketStateEnum" + }, + "returnState": { + "$ref": "#/components/schemas/OrderLineReturnStateEnum" + }, + "auditorGroup": { + "$ref": "#/components/schemas/AuditorGroupEnum" + }, + "reason": { + "type": "string" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + }, + "confirmedAtMillis": { + "type": "integer", + "format": "int64" + }, + "withdrawnAtMillis": { + "type": "integer", + "format": "int64" + }, + "rejectedAtMillis": { + "type": "integer", + "format": "int64" + }, + "rejectReason": { + "type": "string" + }, + "resolvedAtMillis": { + "type": "integer", + "format": "int64" + }, + "resolvedPriceDelta": { + "$ref": "#/components/schemas/PriceSetDeltaDto" + }, + "refundPaymentInfos": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RefundPaymentInfoDto" + } + }, + "orderItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderItemDto" + } + }, + "imageUrls": { + "type": "array", + "description": "original image urls", + "items": { + "type": "string" + } + }, + "multiResolutionImages": { + "$ref": "#/components/schemas/MultiResolutionImageListDto" + }, + "recallDeliveryProgress": { + "$ref": "#/components/schemas/OLRTRecallDeliveryProgressDto" + } + } + }, + "OLRTRecallDeliveryProgressDto": { + "type": "object", + "description": "If null, it is not a product that is being linked to GoodsFlow collection.", + "properties": { + "recallDeliveryVendor": { + "$ref": "#/components/schemas/DeliveryVendorEnum" + }, + "recallDeliveryVendorNumber": { + "description": "Invoice number", + "type": "string" + }, + "requestable": { + "description": "Whether a retrieval request is possible", + "type": "boolean" + }, + "recallState": { + "$ref": "#/components/schemas/RecallDeliveryStateEnum" + }, + "recallDeliveryCompletedAtMillis": { + "description": "Date of completion of recovery", + "type": "integer", + "format": "int64" + }, + "recallDeliveryTraceUrl": { + "description": "Retrieval Tracking URL", + "type": "string" + } + } + }, + "OrderLineReturnTicketWithOrderDto": { + "type": "object", + "properties": { + "ticketId": { + "type": "string" + }, + "isCustomerNegligence": { + "type": "boolean" + }, + "returnAddress": { + "$ref": "#/components/schemas/DeliveryAddressDto" + }, + "state": { + "$ref": "#/components/schemas/OrderLineTicketStateEnum" + }, + "returnState": { + "$ref": "#/components/schemas/OrderLineReturnStateEnum" + }, + "auditorGroup": { + "$ref": "#/components/schemas/AuditorGroupEnum" + }, + "reason": { + "type": "string" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + }, + "confirmedAtMillis": { + "type": "integer", + "format": "int64" + }, + "withdrawnAtMillis": { + "type": "integer", + "format": "int64" + }, + "rejectedAtMillis": { + "type": "integer", + "format": "int64" + }, + "rejectReason": { + "type": "string" + }, + "resolvedAtMillis": { + "type": "integer", + "format": "int64" + }, + "resolvedPriceDelta": { + "$ref": "#/components/schemas/PriceSetDeltaDto" + }, + "refundPaymentInfos": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RefundPaymentInfoDto" + } + }, + "orderItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderItemDto" + } + }, + "imageUrls": { + "type": "array", + "description": "original image urls", + "items": { + "type": "string" + } + }, + "multiResolutionImages": { + "$ref": "#/components/schemas/MultiResolutionImageListDto" + }, + "recallDeliveryProgress": { + "$ref": "#/components/schemas/OLRTRecallDeliveryProgressDto" + }, + "linkedOrder": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + }, + "RefundPaymentInfoDto": { + "type": "object", + "description": "Refund Payment Method", + "required": [ + "paymentMethod" + ], + "properties": { + "paymentMethod": { + "$ref": "#/components/schemas/RefundPaymentMethodEnum" + }, + "paymentVendor": { + "$ref": "#/components/schemas/RefundPaymentVendorEnum" + }, + "detail": { + "description": "Detailed explanation of refund payment method (card company information in case of card payment)", + "type": "string" + } + } + }, + "DeliveryVendorEnum": { + "oneOf": [ + { + "const": "CJ_GLS" + }, + { + "const": "LOGEN" + }, + { + "const": "EPOST" + }, + { + "const": "HANJIN" + }, + { + "const": "LOTTE" + }, + { + "const": "DAESIN" + }, + { + "const": "ILYANG" + }, + { + "const": "KYUNGDONG" + }, + { + "const": "HAPDONG" + }, + { + "const": "CHUNIL" + }, + { + "const": "CVSNET" + }, + { + "const": "HPL" + }, + { + "const": "KUNYOUNG" + }, + { + "const": "HONAM" + }, + { + "const": "SLX" + }, + { + "const": "BGF" + }, + { + "const": "YONGMA" + }, + { + "const": "SEBANG" + }, + { + "const": "WONDERS" + }, + { + "const": "NH_LOGIS" + }, + { + "const": "HI_LOGIS" + }, + { + "const": "HOMEPICK" + }, + { + "const": "KOREX_G" + }, + { + "const": "EMS" + }, + { + "const": "LOTTE_GLOBAL" + }, + { + "const": "HANDEX" + }, + { + "const": "DHL" + }, + { + "const": "FEDEX" + }, + { + "const": "UPS" + }, + { + "const": "TNT" + }, + { + "const": "PANTOS" + }, + { + "const": "ACI_EXPRESS" + }, + { + "const": "ACE_EXP" + }, + { + "const": "EUNHA" + }, + { + "const": "CHAIN_LOGISTICS" + }, + { + "const": "LOGISPOT" + }, + { + "const": "VROONG" + }, + { + "const": "ETOMARS" + }, + { + "const": "VENDORPIA" + }, + { + "const": "DAERIM" + }, + { + "const": "VALEX" + }, + { + "const": "ETC" + }, + { + "const": "SELF_MANAGED" + } + ], + "description": "- (Order/Invoice Information) Available delivery companies - `ETC (Other delivery companies)` -> A specific delivery company is being used, but is not currently supported (If you need support for other delivery companies, please contact us separately) - `SELF_MANAGED (Direct delivery)` -> Used when delivering directly ## Delivery companies linked by code - CJ_GLS # CJ๋Œ€ํ•œํ†ต์šด - LOGEN # Logen Delivery Company - EPOST # Post Office Delivery Company - HANJIN # Hanjin Delivery Company - LOTTE # Lotte Delivery Company - DAESIN # Daeshin Delivery Company - ILYANG # Ilyang Delivery Company - KYUNGDONG # Gyeongdong Delivery Company - HAPDONG # Hapdong Delivery Company - CHUNIL # Cheonil Delivery Company - CVSNET # GS Convenience Store Delivery Company - HPL # Hanui Sarang Delivery Company - KUNYOUNG # Geonyoung Delivery Company - HONAM # Honam Delivery Company - SLX # SLX - BGF # CU Convenience Store Delivery Company - YONGMA # Yongmarojis - SEBANG #์„ธ๋ฐฉํƒ๋ฐฐ - WONDERS #์œ„๋”์ŠคQUICK - NH_LOGIS #๋†ํ˜‘ํƒ๋ฐฐ - HI_LOGIS #HIํƒ๋ฐฐ - HOMEPICK #ํ™ˆํ”ฝํƒ๋ฐฐ - KOREX_G #CJ๋Œ€ํ•œํ†ต์šด๊ตญ์ œํŠนํ–‰ - EMS #EMS - LOTTE_GLOBAL #๋กฏ๊ธ€๋กœ๋ฒŒ - HANDEX #ํ•œํŽ™ํŠธ - DHL #DHL - FEDEX #FEDEX - UPS #UPS - TNT #TNT - PANTOS #๋ฒ”ํ•œํŒํ† ์Šค - ACI_EXPRESS #ACI Express - ACE_EXP #ACE Express - EUNHA #์€ํ•˜SHIPPING - CHAIN_LOGISTICS #๋‘๋ฐœํžˆ๋Ÿฌ - LOGISPOT #๋กœ์ง€์Šค์  - VROONG #๋ธŒ๋ฃฝ(VROONG) - ETOMARS #์ดํˆฌ๋งˆ์Šค - VENDORPIA #ACElogistics - DAERIM #๋Œ€๋ฆผํ†ต์šด - VALEX #๋ฐœ๋ ‰์Šค - ETC #Otherdeliverycompany - SELF_MANAGED #Directdelivery" + }, + "RecallDeliveryStateEnum": { + "oneOf": [ + { + "const": "WAIT" + }, + { + "const": "PREPARING" + }, + { + "const": "IN_DELIVERY" + }, + { + "const": "COMPLETED" + }, + { + "const": "CANCELED" + }, + { + "const": "FAILED" + } + ] + }, + "BannerDto": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/BannerTypeEnum" + }, + "categoryId": { + "type": "string" + }, + "brandId": { + "type": "string" + }, + "brandSourcingTagId": { + "type": "string" + }, + "displayProductIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "displayProductCount": { + "type": "integer" + }, + "imageUrl": { + "type": "string" + }, + "linkUrl": { + "type": "string" + }, + "startAtMillis": { + "type": "integer", + "format": "int64" + }, + "endAtMillis": { + "type": "integer", + "format": "int64" + }, + "title": { + "type": "string" + }, + "subTitle": { + "type": "string" + }, + "enabled": { + "description": "(deprecated) enabled", + "type": "boolean" + }, + "note": { + "description": "(deprecated) note", + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "multiResolutionImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "displayProducts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BannerDisplayProductDto" + } + } + } + }, + "BannerDisplayProductDto": { + "type": "object", + "required": [ + "productId", + "imageUrl", + "finalPrice", + "title", + "brandName", + "discountPercentage" + ], + "properties": { + "productId": { + "type": "string" + }, + "imageUrl": { + "type": "string" + }, + "finalPrice": { + "type": "integer", + "format": "int64" + }, + "title": { + "description": "Product Name", + "type": "string" + }, + "brandName": { + "type": "string" + }, + "discountPercentage": { + "description": "Product discount rate compared to originalPrice and finalPrice", + "type": "integer", + "format": "int32" + }, + "maximumBenefitCouponAppliedFinalPrice": { + "type": "integer", + "format": "int64" + }, + "originalToMaximumBenefitCouponPricePercentage": { + "description": "Product discount rate compared to originalPrice maximumBenefitCouponAppliedFinalPrice", + "type": "integer", + "format": "int32" + } + } + }, + "BannerDataDto": { + "type": "object", + "required": [ + "type", + "imageUrl", + "linkUrl", + "title", + "enabled", + "note" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/BannerTypeEnum" + }, + "categoryId": { + "type": "string" + }, + "brandId": { + "type": "string" + }, + "brandSourcingTagId": { + "type": "string" + }, + "displayProductIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "displayProductCount": { + "type": "integer" + }, + "imageUrl": { + "type": "string" + }, + "linkUrl": { + "type": "string" + }, + "startAtMillis": { + "type": "integer", + "format": "int64" + }, + "endAtMillis": { + "type": "integer", + "format": "int64" + }, + "title": { + "type": "string" + }, + "subTitle": { + "type": "string" + }, + "enabled": { + "description": "(deprecated) enabled", + "type": "boolean" + }, + "note": { + "description": "(deprecated) note", + "type": "string" + } + } + }, + "BannerTypeEnum": { + "oneOf": [ + { + "const": "MAIN" + }, + { + "const": "STYLE" + }, + { + "const": "SUB" + }, + { + "const": "DISCOUNT" + }, + { + "const": "CATEGORY" + }, + { + "const": "BRAND" + }, + { + "const": "SECTION1" + }, + { + "const": "SECTION2" + }, + { + "const": "SPARE" + }, + { + "const": "BEST_TOP" + }, + { + "const": "DEPARTMENT_STORE" + }, + { + "const": "OUTLET" + }, + { + "const": "HOME_SHOPPING" + }, + { + "const": "SOHO_MALL" + }, + { + "const": "QUEENIT_EXCLUSIVE" + }, + { + "const": "DESIGNER" + }, + { + "const": "MAGAZINE" + }, + { + "const": "EVENT" + }, + { + "const": "BRAND_PROMOTION" + }, + { + "const": "SEARCH_HOME" + }, + { + "const": "MAIN_V2" + } + ], + "description": "SECTIONX is deprecated" + }, + "CollectionListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CollectionDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "CollectionDto": { + "type": "object", + "required": [ + "id", + "title", + "elements" + ], + "properties": { + "id": { + "type": "string" + }, + "title": { + "type": "string" + }, + "elements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CollectionElementDto" + } + } + } + }, + "CollectionElementDto": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/CollectionElementTypeEnum" + }, + "text": { + "$ref": "#/components/schemas/TextCollectionElementDto" + }, + "image": { + "$ref": "#/components/schemas/ImageCollectionElementDto" + }, + "products": { + "$ref": "#/components/schemas/ProductsCollectionElementDto" + }, + "videos": { + "$ref": "#/components/schemas/VideosCollectionElementDto" + }, + "link": { + "$ref": "#/components/schemas/LinkCollectionElementDto" + }, + "campaign": { + "$ref": "#/components/schemas/CampaignCollectionElementDto" + }, + "coupon": { + "$ref": "#/components/schemas/CouponCollectionElementDto" + }, + "imageLink": { + "$ref": "#/components/schemas/ImageLinkCollectionElementDto" + }, + "markdown": { + "$ref": "#/components/schemas/MarkdownCollectionElementDto" + }, + "pointPromotion": { + "$ref": "#/components/schemas/PointPromotionCollectionElementDto" + }, + "attendanceCheck": { + "$ref": "#/components/schemas/AttendanceCheckCollectionElementDto" + } + } + }, + "TextCollectionElementDto": { + "type": "object", + "required": [ + "type", + "text" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/CollectionTextTypeEnum" + }, + "text": { + "type": "string" + } + } + }, + "CollectionTextTypeEnum": { + "oneOf": [ + { + "const": "TITLE" + }, + { + "const": "SUBTITLE" + }, + { + "const": "BODY" + }, + { + "const": "DESCRIPTION" + } + ] + }, + "ImageCollectionElementDto": { + "required": [ + "imageUrl" + ], + "type": "object", + "properties": { + "imageUrl": { + "type": "string" + } + } + }, + "ImageLinkCollectionElementDto": { + "type": "object", + "required": [ + "imageUrl", + "linkUrl" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/ImageLinkTypeEnum" + }, + "imageUrl": { + "type": "string" + }, + "linkUrl": { + "type": "string" + }, + "campaign": { + "type": "string" + } + } + }, + "ProductsCollectionElementDto": { + "type": "object", + "required": [ + "columnCount", + "products", + "freeReturnTargetProductIds" + ], + "properties": { + "title": { + "type": "string" + }, + "columnCount": { + "type": "integer", + "format": "int32" + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDto" + } + }, + "freeReturnTargetProductIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "FreeReturnTargetFilterTypeEnum": { + "oneOf": [ + { + "const": "WHITELIST" + }, + { + "const": "BLACKLIST" + } + ] + }, + "FreeReturnTargetTypeEnum": { + "const": "PRODUCT" + }, + "FreeReturnPromotionTargetTypeEnum": { + "oneOf": [ + { + "const": "PRODUCT" + }, + { + "const": "BRAND_SOURCING" + } + ] + }, + "VideosCollectionElementDto": { + "type": "object", + "required": [ + "ids", + "isLandscape" + ], + "properties": { + "ids": { + "type": "array", + "items": { + "type": "string" + } + }, + "isLandscape": { + "type": "boolean" + } + } + }, + "OrientationTypeEnum": { + "oneOf": [ + { + "const": "PORTRAIT" + }, + { + "const": "LANDSCAPE" + } + ] + }, + "LinkCollectionElementDto": { + "type": "object", + "required": [ + "imageUrl", + "linkUrl" + ], + "properties": { + "imageUrl": { + "type": "string" + }, + "linkUrl": { + "type": "string" + }, + "campaign": { + "type": "string" + } + } + }, + "CampaignCollectionElementDto": { + "type": "object", + "required": [ + "imageUrl", + "campaign" + ], + "properties": { + "imageUrl": { + "type": "string" + }, + "message": { + "type": "string" + }, + "campaign": { + "type": "string" + } + } + }, + "CouponCollectionElementDto": { + "type": "object", + "required": [ + "imageUrl", + "couponCode" + ], + "properties": { + "imageUrl": { + "type": "string" + }, + "couponCode": { + "type": "string" + }, + "campaign": { + "type": "string" + } + } + }, + "MarkdownCollectionElementDto": { + "type": "object", + "required": [ + "markdown" + ], + "properties": { + "markdown": { + "type": "string" + } + } + }, + "PointPromotionCollectionElementDto": { + "type": "object", + "required": [ + "promotionCode", + "imageUrl" + ], + "properties": { + "promotionCode": { + "description": "Points Promotion Code", + "type": "string" + }, + "amount": { + "description": "Amount of points you will receive for attending promotions", + "type": "integer", + "format": "int64" + }, + "imageUrl": { + "description": "Accumulated points image URL", + "type": "string" + }, + "campaign": { + "description": "Fields for note purposes", + "type": "string" + } + } + }, + "AttendanceCheckCollectionElementDto": { + "type": "object", + "required": [ + "title", + "imageUrl", + "kstStartDate", + "kstEndDate", + "numberOfAttendance", + "attendanceRewardPolicies" + ], + "properties": { + "id": { + "description": "Attendance check id", + "type": "string" + }, + "title": { + "type": "string" + }, + "imageUrl": { + "description": "Attendance Check Image URL", + "type": "string" + }, + "kstStartDate": { + "type": "string", + "description": "Date in yyyy-mm-dd format" + }, + "kstEndDate": { + "type": "string", + "description": "Date in yyyy-mm-dd format" + }, + "numberOfAttendance": { + "type": "integer", + "format": "int64" + }, + "attendanceRewardPolicies": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AttendanceRewardPolicyCollectionElementDto" + } + } + } + }, + "AttendanceRewardPolicyCollectionElementDto": { + "type": "object", + "required": [ + "type", + "pointAmount", + "pointExpireDays" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/AttendanceRewardPolicyTypeEnum" + }, + "pointAmount": { + "type": "integer", + "format": "int64" + }, + "pointExpireDays": { + "type": "integer" + } + } + }, + "AttendanceRewardPolicyTypeEnum": { + "oneOf": [ + { + "const": "DAILY_REWARD" + }, + { + "const": "ACHIEVEMENT_REWARD" + } + ] + }, + "ImageLinkTypeEnum": { + "oneOf": [ + { + "const": "COUPON" + }, + { + "const": "LINK" + } + ] + }, + "CollectionElementTypeEnum": { + "oneOf": [ + { + "const": "TEXT" + }, + { + "const": "IMAGE" + }, + { + "const": "PRODUCTS" + }, + { + "const": "VIDEOS" + }, + { + "const": "LINK" + }, + { + "const": "CAMPAIGN" + }, + { + "const": "COUPON" + }, + { + "const": "IMAGELINK" + }, + { + "const": "MARKDOWN" + }, + { + "const": "POINT_PROMOTION" + }, + { + "const": "ATTENDANCE_CHECK" + } + ] + }, + "UploadProductPageRequest": { + "type": "object", + "required": [ + "base64" + ], + "properties": { + "base64": { + "type": "string" + } + } + }, + "CouponBookDto": { + "type": "object", + "required": [ + "code", + "header", + "title", + "contents", + "pairContents", + "asset", + "coupons" + ], + "properties": { + "code": { + "type": "string" + }, + "header": { + "type": "string" + }, + "title": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "pairContents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ContentsPairDto" + } + }, + "asset": { + "$ref": "#/components/schemas/CouponBookAssetDto" + }, + "coupons": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCouponDto" + } + } + } + }, + "CouponBookAssetDto": { + "type": "object", + "required": [ + "primaryColor" + ], + "properties": { + "primaryColor": { + "$ref": "#/components/schemas/ColorGradientDto" + }, + "contentImageUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionContentImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "stickerImageUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionStickerImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + } + } + }, + "ContentsPairDto": { + "type": "object", + "required": [ + "first", + "second" + ], + "properties": { + "first": { + "type": "string" + }, + "second": { + "type": "string" + } + } + }, + "ColorGradientDto": { + "type": "object", + "required": [ + "startColorCode", + "endColorCode" + ], + "properties": { + "startColorCode": { + "type": "string", + "description": "start of gradient color code. (ex. \\#AABBCC)" + }, + "endColorCode": { + "type": "string", + "description": "end of gradient color code. (ex. \\#DDEEFF)" + } + } + }, + "IssuedCouponWhenOrderDto": { + "type": "object", + "properties": { + "issuedCouponId": { + "type": "integer", + "format": "int64" + }, + "coupon": { + "$ref": "#/components/schemas/CouponDto" + }, + "state": { + "$ref": "#/components/schemas/IssuedCouponStateEnum" + }, + "issuedAtMillis": { + "type": "integer", + "format": "int64" + }, + "activatingAtMillis": { + "type": "integer", + "format": "int64" + }, + "expiringAtMillis": { + "type": "integer", + "format": "int64" + }, + "linkUrl": { + "type": "string" + }, + "discountableAmount": { + "type": "integer", + "format": "int64" + }, + "consumable": { + "type": "boolean" + } + } + }, + "IssuedCouponDto": { + "type": "object", + "required": [ + "issuedCouponId", + "coupon", + "state", + "issuedAtMillis", + "activatingAtMillis" + ], + "properties": { + "issuedCouponId": { + "type": "integer", + "format": "int64" + }, + "coupon": { + "$ref": "#/components/schemas/CouponDto" + }, + "state": { + "$ref": "#/components/schemas/IssuedCouponStateEnum" + }, + "issuedAtMillis": { + "type": "integer", + "format": "int64" + }, + "activatingAtMillis": { + "type": "integer", + "format": "int64" + }, + "expiringAtMillis": { + "type": "integer", + "format": "int64" + }, + "linkUrl": { + "type": "string" + } + } + }, + "IssuedCouponStateEnum": { + "oneOf": [ + { + "const": "CONSUMED" + }, + { + "const": "EXPIRED" + }, + { + "const": "ACTIVATED" + }, + { + "const": "DISABLED" + } + ] + }, + "CouponDto": { + "type": "object", + "required": [ + "code", + "title", + "caution", + "conditionSummary", + "type" + ], + "properties": { + "code": { + "type": "string" + }, + "title": { + "type": "string" + }, + "manager": { + "type": "string" + }, + "caution": { + "type": "string" + }, + "conditionSummary": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/CouponTypeEnum" + }, + "discountAmount": { + "type": "integer", + "format": "int64", + "description": "field for CouponTypeEnum.DISCOUNT_BY_AMOUNT type." + }, + "discountPercentage": { + "type": "integer", + "format": "int64", + "description": "field for CouponTypeEnum.DISCOUNT_BY_PERCENTAGE type." + }, + "maxDiscountAmount": { + "type": "integer", + "format": "int64", + "description": "field for CouponTypeEnum.DISCOUNT_BY_PERCENTAGE type." + }, + "specialPrice": { + "type": "integer", + "format": "int64", + "description": "field for CouponTypeEnum.SPECIAL_PRICE type." + } + } + }, + "AppCouponDto": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "title": { + "type": "string" + }, + "manager": { + "type": "string" + }, + "caution": { + "type": "string" + }, + "conditionSummary": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/CouponTypeEnum" + }, + "discountAmount": { + "type": "integer", + "format": "int64", + "description": "field for CouponTypeEnum.DISCOUNT_BY_AMOUNT type." + }, + "discountPercentage": { + "type": "integer", + "format": "int64", + "description": "field for CouponTypeEnum.DISCOUNT_BY_PERCENTAGE type." + }, + "maxDiscountAmount": { + "type": "integer", + "format": "int64", + "description": "field for CouponTypeEnum.DISCOUNT_BY_PERCENTAGE type." + }, + "specialPrice": { + "type": "integer", + "format": "int64", + "description": "field for CouponTypeEnum.SPECIAL_PRICE type." + }, + "consumableCount": { + "type": "integer", + "format": "int64" + } + } + }, + "CouponDetailDto": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "title": { + "type": "string" + }, + "manager": { + "type": "string" + }, + "caution": { + "type": "string" + }, + "conditionSummary": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/CouponTypeEnum" + }, + "discountAmount": { + "type": "integer", + "format": "int64", + "description": "field for CouponTypeEnum.DISCOUNT_BY_AMOUNT type." + }, + "discountPercentage": { + "type": "integer", + "format": "int64", + "description": "field for CouponTypeEnum.DISCOUNT_BY_PERCENTAGE type." + }, + "maxDiscountAmount": { + "type": "integer", + "format": "int64", + "description": "field for CouponTypeEnum.DISCOUNT_BY_PERCENTAGE type." + }, + "specialPrice": { + "type": "integer", + "format": "int64", + "description": "field for CouponTypeEnum.SPECIAL_PRICE type." + }, + "expirationPolicy": { + "$ref": "#/components/schemas/CouponExpirationPolicyDto" + } + } + }, + "CouponExpirationPolicyDto": { + "type": "object", + "properties": { + "durationSecondsSinceHold": { + "type": "integer", + "format": "int64" + }, + "startAtMillis": { + "type": "integer", + "format": "int64" + }, + "endAtMillis": { + "type": "integer", + "format": "int64" + } + } + }, + "AppCouponListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCouponDto" + } + }, + "maximumDiscountCouponAppliedPrice": { + "description": "- Price with maximum coupon discount applied - If the value of this field is `null` -> It can be considered that there is no coupon that satisfies the condition for calculating the maximum discount.", + "type": "integer", + "format": "int64" + } + } + }, + "CouponTypeEnum": { + "oneOf": [ + { + "const": "DISCOUNT_BY_AMOUNT" + }, + { + "const": "DISCOUNT_BY_PERCENTAGE" + }, + { + "const": "SPECIAL_PRICE" + } + ] + }, + "ApplyCouponRequestDto": { + "type": "object", + "required": [ + "issuedCouponId" + ], + "properties": { + "issuedCouponId": { + "type": "integer", + "format": "int64" + } + } + }, + "ApplyPointRequestDto": { + "type": "object", + "required": [ + "usePoint" + ], + "properties": { + "usePoint": { + "type": "integer", + "format": "int64" + } + } + }, + "ReleaseCouponResponseDto": { + "type": "object", + "required": [ + "priceSet", + "orderSummary" + ], + "properties": { + "priceSet": { + "$ref": "#/components/schemas/PriceSetDto" + }, + "orderSummary": { + "$ref": "#/components/schemas/OrderSummaryDto" + } + } + }, + "ApplyCouponResponseDto": { + "type": "object", + "required": [ + "priceSet", + "orderSummary" + ], + "properties": { + "priceSet": { + "$ref": "#/components/schemas/PriceSetDto" + }, + "orderSummary": { + "$ref": "#/components/schemas/OrderSummaryDto" + } + } + }, + "ApplyPointResponseDto": { + "type": "object", + "required": [ + "priceSet", + "orderSummary" + ], + "properties": { + "priceSet": { + "$ref": "#/components/schemas/PriceSetDto" + }, + "orderSummary": { + "$ref": "#/components/schemas/OrderSummaryDto" + } + } + }, + "ProductPriceDto": { + "type": "object", + "required": [ + "originalPrice", + "sellingPrice" + ], + "properties": { + "originalPrice": { + "type": "integer", + "format": "int64", + "description": "Regular price" + }, + "sellingPrice": { + "type": "integer", + "format": "int64", + "description": "Sales price" + } + } + }, + "ProductDiscountBenefitsDto": { + "type": "object", + "required": [ + "discountBenefitsByCoupon", + "discountBenefitsByPoint" + ], + "properties": { + "discountBenefitsByCoupon": { + "$ref": "#/components/schemas/ProductDiscountBenefitsInfoByCouponDto" + }, + "discountBenefitsByPoint": { + "type": "integer", + "format": "int64", + "description": "Amount of points available" + } + } + }, + "ProductDiscountBenefitsInfoByCouponDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDiscountBenefitsInfoByCouponElementDto" + } + } + } + }, + "ProductDiscountBenefitsInfoByCouponElementDto": { + "type": "object", + "required": [ + "title", + "couponCode", + "discountAmount" + ], + "properties": { + "title": { + "type": "string" + }, + "couponCode": { + "type": "string" + }, + "discountAmount": { + "type": "integer", + "format": "int64" + } + } + }, + "CheckFirstKakaoLoginCouponIssuableResponseDto": { + "type": "object", + "required": [ + "isIssuable" + ], + "properties": { + "isIssuable": { + "type": "boolean" + } + } + }, + "AgeGroupFilterListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AgeGroupFilterDto" + } + } + } + }, + "AgeGroupFilterDto": { + "type": "object", + "required": [ + "code", + "alias" + ], + "properties": { + "code": { + "$ref": "#/components/schemas/AgeGroupCodeEnum" + }, + "alias": { + "type": "string" + } + } + }, + "CreatableReviewPromptDto": { + "type": "object", + "properties": { + "myOrderItem": { + "$ref": "#/components/schemas/MyOrderItemDto" + } + } + }, + "DisplayProductReviewListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DisplayProductReviewDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "DisplayProductReviewListDtoV2": { + "type": "object", + "required": [ + "list", + "totalPageCount", + "totalElementCount" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DisplayProductReviewDto" + } + }, + "totalPageCount": { + "type": "integer", + "format": "int32" + }, + "totalElementCount": { + "type": "integer", + "format": "int64" + } + } + }, + "RepresentativeProductReviewListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DisplayProductReviewDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "DisplayProductReviewDto": { + "type": "object", + "required": [ + "productReview", + "optionTitle", + "userProfileDisplayPolicy", + "favoriteData" + ], + "properties": { + "productReview": { + "$ref": "#/components/schemas/ProductReviewDto" + }, + "optionTitle": { + "type": "string" + }, + "userProfileDisplayPolicy": { + "$ref": "#/components/schemas/UserProfileDisplayPolicyDto" + }, + "favoriteData": { + "$ref": "#/components/schemas/ProductReviewFavoriteDataDto" + } + } + }, + "ProductReviewListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "ProductReviewDto": { + "type": "object", + "properties": { + "attributes": { + "$ref": "#/components/schemas/ProductReviewAttributeDto" + }, + "rating": { + "$ref": "#/components/schemas/ProductRatingEnum" + }, + "size": { + "$ref": "#/components/schemas/ProductSizeEnum" + }, + "brightness": { + "$ref": "#/components/schemas/ProductBrightnessEnum" + }, + "colorSense": { + "$ref": "#/components/schemas/ProductColorSenseEnum" + }, + "thickness": { + "$ref": "#/components/schemas/ProductThicknessEnum" + }, + "contents": { + "type": "string" + }, + "imageUrls": { + "description": "DEPRECATED", + "type": "array", + "items": { + "type": "string" + } + }, + "multiResolutionImages": { + "$ref": "#/components/schemas/MultiResolutionImageListDto" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "uid": { + "type": "string" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + }, + "userProfile": { + "$ref": "#/components/schemas/UserProfileDto" + } + } + }, + "ProductReviewFavoriteDataDto": { + "type": "object", + "required": [ + "favoriteCount", + "isMyFavorite" + ], + "properties": { + "favoriteCount": { + "type": "integer", + "format": "int64" + }, + "isMyFavorite": { + "type": "boolean", + "default": false + } + } + }, + "UpdateProductReviewRequestDto": { + "type": "object", + "required": [ + "reviewData" + ], + "properties": { + "reviewData": { + "$ref": "#/components/schemas/ProductReviewDataDto" + } + } + }, + "ProductCategoryReviewAttributeDto": { + "type": "object", + "required": [ + "productCategoryReviewGroupId", + "label", + "list", + "guide" + ], + "properties": { + "productCategoryReviewGroupId": { + "type": "string" + }, + "label": { + "type": "string" + }, + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryReviewAttributeItemDto" + } + }, + "guide": { + "$ref": "#/components/schemas/ProductCategoryReviewGuideDto" + } + } + }, + "ProductReviewAttributeDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewAttributeItemDto" + } + } + } + }, + "ProductCategoryReviewAttributeItemDto": { + "type": "object", + "required": [ + "code", + "label", + "options" + ], + "properties": { + "code": { + "type": "string" + }, + "label": { + "type": "string" + }, + "options": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewAttributeOptionItemDto" + } + } + } + }, + "ProductReviewAttributeItemDto": { + "type": "object", + "required": [ + "code", + "label", + "selectedOptions" + ], + "properties": { + "code": { + "type": "string" + }, + "label": { + "type": "string" + }, + "selectedOptions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewAttributeOptionItemDto" + } + } + } + }, + "ProductReviewAttributeOptionItemDto": { + "type": "object", + "required": [ + "code", + "label" + ], + "properties": { + "code": { + "type": "string" + }, + "label": { + "type": "string" + } + } + }, + "ProductCategoryReviewGuideDto": { + "type": "object", + "required": [ + "textGuides", + "imageWithTitles" + ], + "properties": { + "textGuides": { + "type": "array", + "items": { + "type": "string" + } + }, + "imageWithTitles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryReviewGuideImageWithTitleDto" + } + } + } + }, + "ProductCategoryReviewGuideImageWithTitleDto": { + "type": "object", + "required": [ + "imageUrl", + "title" + ], + "properties": { + "imageUrl": { + "type": "string" + }, + "title": { + "type": "string" + } + } + }, + "ProductReviewDataDto": { + "type": "object", + "required": [ + "rating" + ], + "properties": { + "attributes": { + "$ref": "#/components/schemas/ProductReviewAttributeDto" + }, + "rating": { + "$ref": "#/components/schemas/ProductRatingEnum" + }, + "size": { + "$ref": "#/components/schemas/ProductSizeEnum" + }, + "brightness": { + "$ref": "#/components/schemas/ProductBrightnessEnum" + }, + "colorSense": { + "$ref": "#/components/schemas/ProductColorSenseEnum" + }, + "thickness": { + "$ref": "#/components/schemas/ProductThicknessEnum" + }, + "contents": { + "type": "string" + }, + "imageUrls": { + "description": "DEPRECATED", + "type": "array", + "items": { + "type": "string" + } + }, + "multiResolutionImages": { + "$ref": "#/components/schemas/MultiResolutionImageListDto" + } + } + }, + "UserProfileDisplayPolicyDto": { + "type": "object", + "required": [ + "displayItemsOfUserProfile" + ], + "properties": { + "displayItemsOfUserProfile": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserProfileItemEnum" + } + } + } + }, + "UserProfileItemEnum": { + "oneOf": [ + { + "const": "HEIGHT_AS_CENTI_METER" + }, + { + "const": "WEIGHT_AS_KILO_GRAM" + }, + { + "const": "TOP_SIZE" + }, + { + "const": "BOTTOM_SIZE_AS_INCH" + }, + { + "const": "SHOE_SIZE_AS_MILLI_METER" + }, + { + "const": "AGE" + } + ] + }, + "ProductReviewCandidateListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewCandidateDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "ProductReviewCandidateDto": { + "type": "object", + "required": [ + "myOrderItem" + ], + "properties": { + "myOrderItem": { + "$ref": "#/components/schemas/MyOrderItemDto" + } + } + }, + "MyProductReviewListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MyProductReviewDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "MyProductReviewDto": { + "type": "object", + "required": [ + "myOrderItem" + ], + "properties": { + "myOrderItem": { + "$ref": "#/components/schemas/MyOrderItemDto" + } + } + }, + "ProductReviewItemListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ProductReviewStatisticsAttributeDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewStatisticsAttributeItemDto" + } + } + } + }, + "ProductReviewStatisticsAttributeItemDto": { + "type": "object", + "required": [ + "code", + "label", + "options" + ], + "properties": { + "code": { + "type": "string" + }, + "label": { + "type": "string" + }, + "options": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewStatisticsAttributeOptionItemDto" + } + } + } + }, + "ProductReviewStatisticsAttributeOptionItemDto": { + "type": "object", + "required": [ + "code", + "label", + "count" + ], + "properties": { + "code": { + "type": "string" + }, + "label": { + "type": "string" + }, + "percentage": { + "type": "integer", + "format": "int32" + }, + "count": { + "type": "integer", + "format": "int64" + } + } + }, + "ProductReviewStatisticsSummaryDto": { + "type": "object", + "required": [ + "ratingAverage", + "reviewCounts" + ], + "properties": { + "ratingAverage": { + "type": "number", + "format": "double" + }, + "reviewCounts": { + "type": "integer", + "format": "int64" + }, + "attributes": { + "$ref": "#/components/schemas/ProductReviewStatisticsAttributeDto" + }, + "satisfactionPercentage": { + "type": "integer", + "format": "int32" + }, + "topPercentageOfSize": { + "$ref": "#/components/schemas/ProductSizePercentageDto" + }, + "topPercentageOfBrightness": { + "$ref": "#/components/schemas/ProductBrightnessPercentageDto" + }, + "topPercentageOfColorSense": { + "$ref": "#/components/schemas/ProductColorSensePercentageDto" + }, + "topPercentageOfThickness": { + "$ref": "#/components/schemas/ProductThicknessPercentageDto" + } + } + }, + "ProductRatingStatisticsDto": { + "type": "object", + "required": [ + "percentages" + ], + "properties": { + "percentages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductRatingPercentageDto" + } + } + } + }, + "ProductRatingPercentageDto": { + "type": "object", + "required": [ + "rating", + "percentage" + ], + "properties": { + "rating": { + "$ref": "#/components/schemas/ProductRatingEnum" + }, + "percentage": { + "type": "integer", + "format": "int32" + } + } + }, + "ProductReviewSortOrderEnum": { + "oneOf": [ + { + "const": "CREATED_AT_DESC" + }, + { + "const": "CREATED_AT_ASC" + }, + { + "const": "REPORT_COUNT_DESC" + }, + { + "const": "RECOMMENDATION" + }, + { + "const": "REVIEW_RATING_DESC" + }, + { + "const": "REVIEW_RATING_ASC" + } + ] + }, + "ProductRatingEnum": { + "oneOf": [ + { + "const": 1 + }, + { + "const": 2 + }, + { + "const": 3 + }, + { + "const": 4 + }, + { + "const": 5 + } + ], + "x-enum-varnames": [ + "BAD", + "NOT_BAD", + "NORMAL", + "GOOD", + "BEST" + ] + }, + "ProductSizeStatisticsDto": { + "type": "object", + "required": [ + "percentages" + ], + "properties": { + "percentages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSizePercentageDto" + } + } + } + }, + "ProductSizePercentageDto": { + "type": "object", + "required": [ + "size" + ], + "properties": { + "size": { + "$ref": "#/components/schemas/ProductSizeEnum" + }, + "percentage": { + "type": "integer", + "format": "int32" + } + } + }, + "ProductSizeEnum": { + "oneOf": [ + { + "const": "SMALL" + }, + { + "const": "FITTED" + }, + { + "const": "BIG" + } + ] + }, + "ProductBrightnessStatisticsDto": { + "type": "object", + "required": [ + "percentages" + ], + "properties": { + "percentages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductBrightnessPercentageDto" + } + } + } + }, + "ProductBrightnessPercentageDto": { + "type": "object", + "required": [ + "brightness" + ], + "properties": { + "brightness": { + "$ref": "#/components/schemas/ProductBrightnessEnum" + }, + "percentage": { + "type": "integer", + "format": "int32" + } + } + }, + "ProductBrightnessEnum": { + "oneOf": [ + { + "const": "DARK" + }, + { + "const": "SAME_AS_PHOTO" + }, + { + "const": "BRIGHT" + } + ] + }, + "ProductColorSenseStatisticsDto": { + "type": "object", + "required": [ + "percentages" + ], + "properties": { + "percentages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductColorSensePercentageDto" + } + } + } + }, + "ProductColorSensePercentageDto": { + "type": "object", + "required": [ + "colorSense" + ], + "properties": { + "colorSense": { + "$ref": "#/components/schemas/ProductColorSenseEnum" + }, + "percentage": { + "type": "integer", + "format": "int32" + } + } + }, + "ProductColorSenseEnum": { + "oneOf": [ + { + "const": "BLURRY" + }, + { + "const": "SAME_AS_PHOTO" + }, + { + "const": "VIVID" + } + ] + }, + "ProductThicknessStatisticsDto": { + "type": "object", + "required": [ + "precentages" + ], + "properties": { + "percentages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductThicknessPercentageDto" + } + } + } + }, + "ProductThicknessPercentageDto": { + "type": "object", + "required": [ + "thickness" + ], + "properties": { + "thickness": { + "$ref": "#/components/schemas/ProductThicknessEnum" + }, + "percentage": { + "type": "integer", + "format": "int32" + } + } + }, + "ProductThicknessEnum": { + "oneOf": [ + { + "const": "THIN" + }, + { + "const": "NORMAL" + }, + { + "const": "THICK" + } + ] + }, + "ProductReviewReportDto": { + "type": "object", + "required": [ + "reason" + ], + "properties": { + "reason": { + "type": "string" + } + } + }, + "UserBirthYearDto": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "integer", + "format": "int32" + } + } + }, + "UserProfileDto": { + "type": "object", + "properties": { + "age": { + "type": "integer", + "format": "int32" + }, + "birthYear": { + "type": "integer", + "format": "int32" + }, + "bodySizeData": { + "$ref": "#/components/schemas/UserBodySizeDataDto" + } + } + }, + "UserBodySizeDataDto": { + "type": "object", + "properties": { + "heightAsCentiMeter": { + "type": "integer", + "format": "int32" + }, + "weightAsKiloGram": { + "type": "integer", + "format": "int32" + }, + "topSize": { + "type": "integer", + "format": "int32" + }, + "bottomSizeAsInch": { + "type": "integer", + "format": "int32" + }, + "shoeSizeAsMilliMeter": { + "type": "integer", + "format": "int32" + }, + "valid": { + "type": "boolean" + } + } + }, + "ExternalUidDto": { + "type": "object", + "properties": { + "externalUid": { + "type": "string" + } + } + }, + "ConnectPayCredentialDto": { + "type": "object", + "required": [ + "clientKey", + "customerKey", + "redirectUrl" + ], + "properties": { + "clientKey": { + "type": "string", + "description": "clientKey for ConnectPay JS SDK authentication" + }, + "customerKey": { + "type": "string", + "description": "The user's external uid used when requesting payment." + }, + "redirectUrl": { + "type": "string", + "description": "Redirect url to be used when authenticating with ConnectPay OAuth" + } + } + }, + "PaymentMethodResponseDto": { + "type": "object", + "required": [ + "cards", + "accounts" + ], + "properties": { + "cards": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CardPaymentDto" + } + }, + "accounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AccountPaymentDto" + } + } + } + }, + "CardPaymentDto": { + "type": "object", + "required": [ + "methodId", + "cardCompany", + "cardName", + "iconUrl", + "maskedCardNumber", + "enabled", + "registeredAtMillis" + ], + "properties": { + "methodId": { + "type": "string", + "description": "Payment method ID, used when requesting ConnectPay payment" + }, + "cardCompany": { + "$ref": "#/components/schemas/TossPaymentCardEnum" + }, + "unknownCardCompanyName": { + "type": "string", + "description": "The name of the corresponding card company if the cardCompany value is `UNKNOWN`, otherwise null" + }, + "cardName": { + "type": "string", + "description": "Card name" + }, + "iconUrl": { + "type": "string", + "description": "Card company icon image url" + }, + "maskedCardNumber": { + "type": "string", + "description": "Masked card number" + }, + "enabled": { + "type": "boolean" + }, + "registeredAtMillis": { + "type": "integer", + "format": "int64", + "description": "Registration date" + } + } + }, + "AccountPaymentDto": { + "type": "object", + "required": [ + "methodId", + "bank", + "iconUrl", + "maskedAccountNumber", + "enabled", + "registeredAtMillis" + ], + "properties": { + "methodId": { + "type": "string", + "description": "Payment method ID, used when requesting ConnectPay payment" + }, + "bank": { + "$ref": "#/components/schemas/TossPaymentAccountEnum" + }, + "unknownBankName": { + "type": "string", + "description": "The name of the bank if the bank value is `UNKNOWN`, otherwise null" + }, + "iconUrl": { + "type": "string", + "description": "bank icon image url" + }, + "maskedAccountNumber": { + "type": "string", + "description": "Masked account number" + }, + "enabled": { + "type": "boolean" + }, + "registeredAtMillis": { + "type": "integer", + "format": "int64", + "description": "Registration date" + } + } + }, + "TierDto": { + "type": "object", + "required": [ + "uid", + "totalPurchaseAmount", + "tierRankType" + ], + "properties": { + "uid": { + "description": "User ID", + "type": "string" + }, + "totalPurchaseAmount": { + "description": "Cumulative purchase confirmation amount (confirmed purchase amount for the past 3 months, ex-sum of statistics for May, June, and July when checked on August 7)", + "type": "integer", + "format": "int64" + }, + "tierRankType": { + "$ref": "#/components/schemas/TierRankTypeEnum" + } + } + }, + "TierRankTypeEnum": { + "oneOf": [ + { + "const": "DIAMOND" + }, + { + "const": "PLATINUM" + }, + { + "const": "GOLD" + }, + { + "const": "SILVER" + } + ], + "description": "Tier Type" + }, + "NextTierInfoDto": { + "type": "object", + "required": [ + "uid", + "nextTierRankType", + "startTierRankTypeForGraph", + "endTierRankTypeForGraph", + "totalPurchaseAmount", + "remainAmount", + "startAtMillis" + ], + "properties": { + "uid": { + "description": "User ID", + "type": "string" + }, + "nextTierRankType": { + "$ref": "#/components/schemas/TierRankTypeEnum" + }, + "startTierRankTypeForGraph": { + "$ref": "#/components/schemas/TierRankTypeEnum" + }, + "endTierRankTypeForGraph": { + "$ref": "#/components/schemas/TierRankTypeEnum" + }, + "totalPurchaseAmount": { + "description": "Cumulative purchase confirmation amount (statistical amount for the past 2 months + real-time purchase confirmation amount for the month of inquiry)", + "type": "integer", + "format": "int64" + }, + "remainAmount": { + "description": "Amount remaining until the next tier (if the total amount exceeds the next tier level, the amount remaining until the next tier level is displayed)", + "type": "integer", + "format": "int64" + }, + "startAtMillis": { + "type": "integer", + "format": "int64", + "description": "Tier Rank Calculation Start Period" + }, + "tierChangeStatus": { + "$ref": "#/components/schemas/TierChangeStatusEnum" + } + } + }, + "TierChangeStatusEnum": { + "oneOf": [ + { + "const": "RISE" + }, + { + "const": "HOLD" + }, + { + "const": "FALL" + } + ], + "description": "Tier change status type" + }, + "ImageCategoryEnum": { + "oneOf": [ + { + "const": "PRODUCT_REVIEW" + }, + { + "const": "ORDER_LINE_RETURN" + } + ] + }, + "UploadableImageResponseDto": { + "type": "object", + "required": [ + "url", + "uploadedUrl", + "expiredAtMillis" + ], + "properties": { + "url": { + "type": "string" + }, + "uploadedUrl": { + "type": "string" + }, + "expiredAtMillis": { + "type": "integer", + "format": "int64" + } + } + }, + "UploadImageResponseDto": { + "type": "object", + "required": [ + "imageUrl", + "multiResolutionImage" + ], + "properties": { + "imageUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + } + } + }, + "Base64ImageUploadRequestDto": { + "type": "object", + "required": [ + "name", + "base64" + ], + "properties": { + "name": { + "type": "string" + }, + "base64": { + "type": "string" + } + } + }, + "ShopLiveTokenResponseDto": { + "type": "object", + "required": [ + "accessToken" + ], + "properties": { + "accessToken": { + "type": "string", + "description": "Expires in 7 days" + } + } + }, + "ShopLiveTokenRequestDto": { + "type": "object", + "properties": { + "userName": { + "type": "string", + "description": "User chat name" + } + } + }, + "ShopLiveCampaignMetadataResponseDto": { + "type": "object", + "required": [ + "campaignAccessKey", + "campaignMetadataState" + ], + "properties": { + "campaignKey": { + "type": "string", + "description": "Campaign key" + }, + "campaignAccessKey": { + "type": "string", + "description": "Campaign Access key" + }, + "title": { + "type": "string", + "description": "Campaign Title" + }, + "campaignMetadataState": { + "$ref": "#/components/schemas/ShopLiveCampaignMetadataStateEnum" + }, + "liveUrl": { + "type": "string", + "description": "Video playback URL" + }, + "posterUrl": { + "type": "string", + "description": "Broadcast preview image URL" + }, + "poster2Url": { + "type": "string", + "description": "Image URL after broadcast ends" + }, + "scheduledAt": { + "type": "integer", + "format": "int64", + "description": "Scheduled broadcast time" + }, + "scheduledEndAt": { + "type": "integer", + "format": "int64", + "description": "Expected broadcast end time" + }, + "startedAt": { + "type": "integer", + "format": "int64", + "description": "Broadcast start time" + }, + "closingAt": { + "type": "integer", + "format": "int64", + "description": "The actual scheduled termination time when the termination is set to occur after n minutes" + }, + "endedAt": { + "type": "integer", + "format": "int64", + "description": "Broadcast end time" + } + } + }, + "ShopLiveCampaignResponseDto": { + "type": "object", + "required": [ + "campaignAccessKey", + "campaignState" + ], + "properties": { + "campaignKey": { + "type": "string", + "description": "Campaign key" + }, + "campaignAccessKey": { + "type": "string", + "description": "Campaign Access key" + }, + "campaignUrl": { + "type": "string", + "description": "Campaign URL" + }, + "title": { + "type": "string", + "description": "Campaign Title" + }, + "memo": { + "type": "string", + "description": "Campaign Notes" + }, + "campaignState": { + "$ref": "#/components/schemas/ShopLiveCampaignStateEnum" + }, + "campaignGoodsList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShopLiveCampaignGoodsDto" + } + }, + "campaignGoodsCount": { + "type": "integer", + "format": "int32", + "description": "Number of products registered in the campaign" + }, + "userCount": { + "type": "integer", + "format": "int32", + "description": "Cumulative Viewers" + }, + "adoreCount": { + "type": "integer", + "format": "int32", + "description": "Number of likes" + }, + "posterUrl": { + "type": "string", + "description": "Broadcast preview image URL" + }, + "poster2Url": { + "type": "string", + "description": "Image URL after broadcast ends" + }, + "unsupportInfoUrl": { + "type": "string", + "description": "IE Unsupported Guide Image URL" + }, + "previewLiveUrl": { + "type": "string", + "description": "Broadcast Preview URL" + }, + "replayLiveUrl": { + "type": "string", + "description": "Replay URL" + }, + "liveUrl": { + "type": "string", + "description": "Video playback URL" + }, + "backgroundUrl": { + "type": "string", + "description": "Background image URL" + }, + "scheduledAt": { + "type": "integer", + "format": "int64", + "description": "Scheduled broadcast time" + }, + "scheduledEndAt": { + "type": "integer", + "format": "int64", + "description": "Expected broadcast end time" + }, + "startedAt": { + "type": "integer", + "format": "int64", + "description": "Broadcast start time" + }, + "endedAt": { + "type": "integer", + "format": "int64", + "description": "Broadcast end time" + } + } + }, + "ShopLiveCampaignGoodsDto": { + "type": "object", + "required": [ + "campaignId", + "goodsId", + "name", + "url", + "action", + "payload", + "showingNow", + "soldOut", + "originalPrice", + "currency", + "traceId" + ], + "properties": { + "campaignId": { + "type": "integer", + "format": "int64", + "description": "Campaign ID" + }, + "goodsId": { + "type": "integer", + "format": "int64", + "description": "Product ID" + }, + "name": { + "type": "string", + "description": "Product name" + }, + "brand": { + "type": "string", + "description": "Product Brand" + }, + "description": { + "type": "string", + "description": "Product Description" + }, + "url": { + "type": "string", + "description": "Product Move URL" + }, + "sku": { + "type": "string", + "description": "Product Code" + }, + "action": { + "$ref": "#/components/schemas/ShopLiveCampaignGoodsActionTypeEnum" + }, + "payload": { + "type": "string", + "description": "A json string containing information about the URL to be moved to when clicking on a product." + }, + "medias": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShopLiveCampaignGoodsMediaDto" + } + }, + "showingNow": { + "type": "boolean", + "description": "Whether the product is exposed" + }, + "soldOut": { + "type": "boolean", + "description": "Whether the product is sold out" + }, + "originalPrice": { + "type": "number", + "format": "double", + "description": "Basic price of product" + }, + "discountedPrice": { + "type": "number", + "format": "double", + "description": "Product Discount Price" + }, + "discountPercentage": { + "type": "number", + "format": "double", + "description": "Product Discount Rate" + }, + "currency": { + "type": "string", + "description": "Goods Unit" + }, + "traceId": { + "type": "string", + "description": "Click Tracking ID" + } + } + }, + "ShopLiveCampaignGoodsMediaDto": { + "type": "object", + "required": [ + "id", + "mediaType", + "url", + "size", + "width", + "height" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "Media ID" + }, + "mediaType": { + "$ref": "#/components/schemas/ShopLiveCampaignGoodsMediaTypeEnum" + }, + "url": { + "type": "string", + "description": "Product Media URL" + }, + "size": { + "type": "integer", + "format": "int64", + "description": "Product Media Size" + }, + "width": { + "type": "integer", + "format": "int32", + "description": "Product Media Horizontal Size" + }, + "height": { + "type": "integer", + "format": "int32", + "description": "Product Media Vertical Size" + } + } + }, + "ReferralCodeDto": { + "type": "object", + "required": [ + "referralCode" + ], + "properties": { + "referralCode": { + "type": "string" + } + } + }, + "CategoryBestProductDto": { + "type": "object", + "required": [ + "isBest" + ], + "properties": { + "categoryId": { + "type": "string" + }, + "categoryTitle": { + "type": "string" + }, + "isBest": { + "type": "boolean" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + }, + "updatedAtMillis": { + "type": "integer", + "format": "int64" + } + } + }, + "ShopLiveCampaignMetadataStateEnum": { + "oneOf": [ + { + "const": "NOT_EXIST" + }, + { + "const": "READY" + }, + { + "const": "ONAIR" + }, + { + "const": "CLOSING" + }, + { + "const": "CLOSED" + } + ], + "description": "- `NOT_EXIST` -> Non-existent campaign - `READY` -> Preparing - `ONAIR` -> On air - `CLOSING` -> Ending - `CLOSED` -> Closed" + }, + "ShopLiveCampaignStateEnum": { + "oneOf": [ + { + "const": "NOT_EXIST" + }, + { + "const": "READY" + }, + { + "const": "ONAIR" + }, + { + "const": "CLOSED" + } + ], + "description": "- `NOT_EXIST` -> Non-existent campaign - `READY` -> Preparing - `ONAIR` -> On air - `CLOSED` -> Closed" + }, + "ShopLiveCampaignGoodsActionTypeEnum": { + "const": "LINK" + }, + "ShopLiveCampaignGoodsMediaTypeEnum": { + "const": "IMAGE" + }, + "MultiResolutionImageDto": { + "type": "object", + "required": [ + "url_1x", + "url_2x", + "url_3x" + ], + "properties": { + "url_1x": { + "type": "string" + }, + "url_2x": { + "type": "string" + }, + "url_3x": { + "type": "string" + } + } + }, + "MultiResolutionImageListDto": { + "type": "object", + "required": [ + "urls_1x", + "urls_2x", + "urls_3x" + ], + "properties": { + "urls_1x": { + "type": "array", + "items": { + "type": "string" + } + }, + "urls_2x": { + "type": "array", + "items": { + "type": "string" + } + }, + "urls_3x": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SellerContentImagesDto": { + "type": "object", + "required": [ + "contentType", + "multiResolutionImages" + ], + "properties": { + "contentType": { + "$ref": "damoa-seller-api.yaml#/components/schemas/SellerContentTypeEnum" + }, + "multiResolutionImages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + } + } + } + }, + "UserDeliveryAddressAddRequestDto": { + "type": "object", + "required": [ + "address" + ], + "properties": { + "address": { + "$ref": "#/components/schemas/DeliveryAddressDto" + }, + "request": { + "type": "string", + "description": "Shipping Requests" + } + } + }, + "UserDeliveryAddressDto": { + "type": "object", + "required": [ + "id", + "address" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "minimum": 1 + }, + "address": { + "$ref": "#/components/schemas/DeliveryAddressDto" + }, + "request": { + "type": "string", + "description": "Shipping Requests" + } + } + }, + "PointHistoryBundleResponseDto": { + "type": "object", + "required": [ + "PointHistoyDto" + ], + "properties": { + "PointHistories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PointHistoryResponseDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "PointHistoryResponseDto": { + "type": "object", + "required": [ + "id", + "title", + "amount", + "amountType", + "expiredDetails", + "occurrenceAtMillis", + "occurrenceType", + "occurrenceId" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique ID for savings history" + }, + "title": { + "type": "string" + }, + "subTitle": { + "type": "string" + }, + "amount": { + "type": "integer", + "format": "int64" + }, + "amountType": { + "$ref": "#/components/schemas/PointAmountTypeEnum" + }, + "expiredDetails": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PointAccumulateDetailResponseDto" + } + }, + "occurrenceAtMillis": { + "description": "Accumulation history occurrence time (epochMilliSeconds)", + "type": "integer", + "format": "int64" + }, + "occurrenceType": { + "$ref": "#/components/schemas/PointOccurrenceTypeEnum" + }, + "occurrenceId": { + "description": "Different quarters depending on the occurrenceType of the accrual origin ID", + "type": "string" + } + } + }, + "PointAmountTypeEnum": { + "oneOf": [ + { + "const": "PLUS" + }, + { + "const": "MINUS" + } + ] + }, + "PointOccurrenceTypeEnum": { + "oneOf": [ + { + "const": "ACCUMULATE_EVENT" + }, + { + "const": "ACCUMULATE_ORDER_ACCEPT" + }, + { + "const": "WITHDRAW_ORDER_CANCEL" + }, + { + "const": "USE_ADMIN" + }, + { + "const": "ACCUMULATE_ADMIN" + }, + { + "const": "USE_ORDER_CREATE" + }, + { + "const": "EXPIRED" + } + ], + "description": "- Types of occurrence of point accumulation/use/expiration/cancellation - ACCUMULATE_EVENT Points accumulated through events - ACCUMULATE_ORDER_ACCEPT Points accumulated through order confirmation - WITHDRAW_ORDER_CANCEL Points accumulated through refund due to order cancellation - USE_ADMIN Points deducted by the administrator - ACCUMULATE_ADMIN Points accumulated with administrator authority - USE_ORDER_CREATE Points used for order creation - EXPIRED Points expired" + }, + "PointAccumulateDetailResponseDto": { + "type": "object", + "required": [ + "id", + "expiredAtMillis", + "amount" + ], + "properties": { + "id": { + "description": "Unique detailed ID for your savings history", + "type": "string" + }, + "expiredAtMillis": { + "type": "integer", + "format": "int64" + }, + "amount": { + "type": "integer", + "format": "int64" + } + } + }, + "NowUsablePointDto": { + "type": "object", + "required": [ + "amount" + ], + "properties": { + "amount": { + "type": "integer", + "format": "int64" + } + } + }, + "PromotionAttendedStateDto": { + "type": "object", + "required": [ + "attended" + ], + "properties": { + "attended": { + "type": "boolean" + } + } + }, + "ProductAggregationDto": { + "type": "object", + "description": "Product aggregation", + "required": [ + "productFeatureGroupAggregationList" + ], + "properties": { + "totalCount": { + "type": "integer", + "format": "int64" + }, + "productFeatureGroupAggregationList": { + "deprecated": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductFeatureGroupAggregationDto" + } + }, + "productAggregationGroup": { + "$ref": "#/components/schemas/ProductAggregationGroupDto" + } + } + }, + "ProductAggregationGroupDto": { + "type": "object", + "description": "Product Aggregation Information Group", + "required": [ + "productFeatureGroupAggregationList", + "productCategoryAggregationList", + "brandAggregationList" + ], + "properties": { + "productFeatureGroupAggregationList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductFeatureGroupAggregationDto" + } + }, + "productCategoryAggregationList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryAggregationDto" + } + }, + "brandAggregationList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BrandAggregationDto" + } + } + } + }, + "ProductFeatureGroupAggregationDto": { + "type": "object", + "description": "Sorts the number of attribute tags by group in descending order", + "properties": { + "group": { + "$ref": "#/components/schemas/ProductFeatureGroupDto" + }, + "productFeatureAggregation": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductFeatureAggregationDto" + } + } + } + }, + "ProductFeatureAggregationDto": { + "type": "object", + "properties": { + "productFeature": { + "$ref": "#/components/schemas/ProductFeatureDto" + }, + "count": { + "type": "integer", + "format": "int64" + } + } + }, + "ProductCategoryAggregationDto": { + "type": "object", + "properties": { + "categoryId": { + "type": "string" + }, + "count": { + "type": "integer", + "format": "int64" + } + } + }, + "BrandAggregationDto": { + "type": "object", + "properties": { + "brandName": { + "type": "string" + }, + "count": { + "type": "integer", + "format": "int64" + } + } + }, + "ProductFeatureListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductFeatureDto" + } + } + } + }, + "ProductFeatureDto": { + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string" + }, + "title": { + "type": "string" + }, + "groupId": { + "type": "string" + }, + "groupTitle": { + "type": "string" + } + } + }, + "ProductFeatureGroupDto": { + "type": "object", + "required": [ + "id", + "title" + ], + "properties": { + "id": { + "type": "string" + }, + "title": { + "type": "string" + } + } + }, + "UserReferralSummaryDto": { + "type": "object", + "required": [ + "totalAccrualPoint", + "totalReferralCount", + "totalUnopenedBonusBoxCount" + ], + "properties": { + "totalAccrualPoint": { + "description": "Total user referral accrual (including bonus rewards)", + "type": "integer", + "format": "int64" + }, + "totalReferralCount": { + "description": "Total number of user recommendations", + "type": "integer", + "format": "int64" + }, + "totalUnopenedBonusBoxCount": { + "description": "Number of bonus boxes not yet opened", + "type": "integer", + "format": "int64" + } + } + }, + "UserReferralRewardSummaryDto": { + "type": "object", + "required": [ + "totalAccrualPoint", + "totalReferral" + ], + "properties": { + "totalAccrualPoint": { + "type": "integer", + "format": "int64" + } + } + }, + "UserReferralBonusBoxOpenResultDto": { + "type": "object", + "required": [ + "pointAmount" + ], + "properties": { + "pointAmount": { + "type": "integer", + "format": "int64", + "description": "Points earned from BonusBox" + } + } + }, + "UserReferralRewardPolicyDto": { + "type": "object", + "required": [ + "totalAccrualLimitByReferral", + "validDaysByReferral", + "joinRewardAmountForReferee", + "bonusBoxPolicies" + ], + "properties": { + "totalAccrualLimitByReferral": { + "type": "integer", + "format": "int64" + }, + "validDaysByReferral": { + "type": "integer", + "format": "int32" + }, + "joinRewardAmountForReferee": { + "type": "integer", + "format": "int64" + }, + "bonusBoxPolicies": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BonusBoxPolicyDto" + } + } + } + }, + "BonusBoxPolicyDto": { + "type": "object", + "description": "Policy for issuing bonus boxes", + "required": [ + "bonusRewardType", + "referralCount" + ], + "properties": { + "bonusRewardType": { + "$ref": "#/components/schemas/BonusRewardTypeEnum" + }, + "referralCount": { + "description": "Number of referrals you need to meet to receive bonusBox", + "type": "integer", + "format": "int32" + } + } + }, + "BonusRewardTypeEnum": { + "oneOf": [ + { + "const": "REPEAT" + }, + { + "const": "ONE_TIME" + } + ], + "description": "Bonus Box Issuance Policy Types: * Repeatable Reward (REPEAT): Bonus box is paid every time the referralCount is met (e.g., if set to 5, it is paid every 5, 10, 15, 20, etc.) * One-time Reward (ONE_TIME): One-time payment when the referralCount is met" + }, + "UserReferralRewardEstimationRequestDto": { + "type": "object", + "required": [ + "phoneNumbers" + ], + "properties": { + "phoneNumbers": { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + } + }, + "UserReferralRewardEstimationDto": { + "type": "object", + "required": [ + "phoneNumber", + "pointAmount", + "rewarded" + ], + "properties": { + "phoneNumber": { + "type": "string" + }, + "pointAmount": { + "type": "integer", + "format": "int64", + "description": "Recommended savings amount expected amount" + }, + "rewarded": { + "type": "boolean", + "description": "Whether you have already been rewarded for your referral" + } + } + }, + "UserReferralRewardEstimationListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserReferralRewardEstimationDto" + } + } + } + }, + "CreateUserReferralRequestDto": { + "type": "object", + "required": [ + "phoneNumber", + "referrerName", + "dynamicLink" + ], + "properties": { + "phoneNumber": { + "type": "string" + }, + "referrerName": { + "type": "string" + }, + "dynamicLink": { + "type": "string" + }, + "message": { + "type": "string" + } + } + }, + "CreateUserReferralResponseDto": { + "type": "object", + "required": [ + "reward" + ], + "properties": { + "reward": { + "$ref": "#/components/schemas/ReferralRewardResultDto" + } + } + }, + "CreateProductReferralRequestDto": { + "type": "object", + "required": [ + "orderLineId", + "productId", + "referralCode" + ], + "properties": { + "orderLineId": { + "type": "string" + }, + "productId": { + "type": "string" + }, + "referralCode": { + "type": "string" + } + } + }, + "ReferralRewardResultDto": { + "type": "object", + "description": "Recommended Reward Information", + "required": [ + "pointAmount" + ], + "properties": { + "pointAmount": { + "type": "integer", + "format": "int64", + "description": "Amount of savings" + } + } + }, + "JoinReferredUserRequestDto": { + "type": "object", + "required": [ + "referralCode" + ], + "properties": { + "referralCode": { + "type": "string" + } + } + }, + "JoinReferredUserResponseDto": { + "type": "object", + "required": [ + "reward" + ], + "properties": { + "reward": { + "$ref": "#/components/schemas/ReferralRewardResultDto" + } + } + }, + "ActiveGameListResponse": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GameDto" + } + } + } + }, + "GameUserProgressInfoResponse": { + "type": "object", + "required": [ + "level", + "exp", + "requiredExpToNextLevel", + "inGameCredit", + "isGameAchievable", + "gameAchievedCount" + ], + "properties": { + "level": { + "type": "integer", + "format": "int32" + }, + "exp": { + "type": "integer", + "format": "int32" + }, + "requiredExpToNextLevel": { + "type": "integer", + "format": "int32" + }, + "inGameCredit": { + "type": "integer", + "format": "int32" + }, + "isGameAchievable": { + "type": "boolean" + }, + "gameAchievedCount": { + "type": "integer", + "format": "int32" + } + } + }, + "GameUseInGameCreditRequest": { + "type": "object", + "required": [ + "useCredit" + ], + "properties": { + "useCredit": { + "type": "integer", + "format": "int32" + } + } + }, + "GameDto": { + "type": "object", + "required": [ + "gameId", + "title", + "rewardTitle" + ], + "properties": { + "gameId": { + "type": "string" + }, + "title": { + "type": "string" + }, + "rewardTitle": { + "description": "Reward name (ex. coffee gift certificate)", + "type": "string" + } + } + }, + "GameMissionsResponse": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GameMissionDto" + } + } + } + }, + "GameMissionAchieveRequest": { + "type": "object", + "required": [ + "missionType" + ], + "properties": { + "missionType": { + "$ref": "#/components/schemas/GameMissionTypeEnum" + }, + "referenceId": { + "description": "Fields for additional information depending on the mission (e.g. event ID)", + "type": "string" + } + } + }, + "GameMissionRewardReceiveResponse": { + "type": "object", + "required": [ + "inGameCredit" + ], + "properties": { + "inGameCredit": { + "type": "integer", + "format": "int32" + } + } + }, + "GameMissionDto": { + "type": "object", + "required": [ + "id", + "title", + "inGameCreditReward", + "missionType", + "completeCount", + "isRewardReceivable" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "inGameCreditReward": { + "type": "integer", + "format": "int32" + }, + "repeatIntervalInMins": { + "type": "integer", + "format": "int64" + }, + "missionType": { + "$ref": "#/components/schemas/GameMissionTypeEnum" + }, + "referenceId": { + "description": "Fields for additional information depending on the mission (e.g. event ID)", + "type": "string" + }, + "resetCycleDays": { + "type": "integer", + "format": "int32" + }, + "maxCompleteCount": { + "type": "integer", + "format": "int32" + }, + "lastCompletedAtMillis": { + "type": "integer", + "format": "int64" + }, + "completeCount": { + "type": "integer", + "format": "int32" + }, + "isRewardReceivable": { + "type": "boolean" + } + } + }, + "GameAchieveRequest": { + "type": "object", + "required": [ + "phoneNumber" + ], + "properties": { + "phoneNumber": { + "type": "string" + } + } + }, + "GameMissionTypeEnum": { + "oneOf": [ + { + "const": "PURCHASE_PRODUCT" + }, + { + "const": "FE_VALID_ATTENDANCE" + }, + { + "const": "FE_VALID_VIEWING_TO_30_SEC_RECOMMENDED" + }, + { + "const": "FE_VALID_VIEWING_TO_30_SEC_STYLE_SHOT" + }, + { + "const": "FE_VALID_VIEWING_TO_30_SEC_COLLECTION" + }, + { + "const": "FE_VALID_VIEWING_TO_30_SEC_NEW_IN_PRODUCT" + }, + { + "const": "FE_VALID_VIEWING_TO_30_SEC_BEST" + }, + { + "const": "FE_VALID_VIEWING_TO_30_SEC_HOT_DEAL" + }, + { + "const": "FE_VALID_VIEWING_TO_30_SEC_SHOPPING_MALL" + }, + { + "const": "FE_VALID_VIEWING_TO_30_SEC_DESIGNER" + } + ] + }, + "AutocompleteResponseDto": { + "type": "object", + "required": [ + "brands" + ], + "properties": { + "brands": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BrandAutocompleteCandidateDto" + } + } + } + }, + "BrandAutocompleteCandidateDto": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "ProductCategoryReviewGuideDataDto": { + "type": "object", + "required": [ + "textGuides", + "imageWithTitles", + "type", + "gridImage" + ], + "properties": { + "textGuides": { + "type": "array", + "items": { + "type": "string" + } + }, + "imageWithTitles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryReviewGuideImageWithTitleDto" + } + }, + "type": { + "$ref": "#/components/schemas/ProductCategoryReviewGuideTypeEnum" + }, + "gridImage": { + "type": "string" + } + } + }, + "ProductCategoryReviewGuideTypeEnum": { + "oneOf": [ + { + "const": "IMAGE_WITH_TITLE" + }, + { + "const": "GRID_IMAGE" + }, + { + "const": "NONE" + } + ], + "description": "Types of photo review guides" + }, + "StyleShotListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StyleShotDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "StyleShotDto": { + "type": "object", + "required": [ + "id", + "styleShotImages", + "styleCategory", + "equippedProductItemIds" + ], + "properties": { + "id": { + "description": "style shot id", + "type": "string" + }, + "styleShotImages": { + "description": "Style shot image url", + "type": "array", + "minItems": 1, + "maxItems": 4, + "items": { + "$ref": "#/components/schemas/StyleShotImageDto" + } + }, + "styleShotTags": { + "description": "Style Shot Tag Id List", + "type": "array", + "items": { + "type": "string" + } + }, + "styleCategory": { + "$ref": "#/components/schemas/StyleCategoryDto" + }, + "equippedProductItemIds": { + "description": "Wearable product item ID, only empty list response (deprecated)", + "type": "array", + "items": { + "type": "string" + } + }, + "text": { + "type": "string" + }, + "editor": { + "type": "string" + }, + "fashionModelHeightAsCentiMeter": { + "type": "integer", + "format": "int32" + }, + "fashionModelWeightAsKiloGram": { + "type": "integer", + "format": "int32" + }, + "fashionModelShoeSizeAsMilliMeter": { + "type": "integer", + "format": "int32" + } + } + }, + "EquippedProductListDto": { + "type": "object", + "required": [ + "equippedProducts", + "favoriteIds", + "freeReturnTargetProductIds" + ], + "properties": { + "equippedProducts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EquippedProductDto" + } + }, + "freeReturnTargetProductIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "StyleShotImageDto": { + "required": [ + "id", + "url_1x", + "url_2x", + "url_3x", + "priority" + ], + "properties": { + "id": { + "description": "Image id", + "type": "string" + }, + "url_1x": { + "type": "string" + }, + "url_2x": { + "type": "string" + }, + "url_3x": { + "type": "string" + }, + "priority": { + "description": "Order when viewing images (ascending from 1)", + "minimum": 1, + "type": "integer", + "format": "int32" + } + } + }, + "StyleCategoryDto": { + "type": "object", + "required": [ + "id", + "name", + "priority" + ], + "properties": { + "id": { + "description": "style category id", + "type": "integer", + "format": "int64" + }, + "name": { + "description": "Style Category Korean Name", + "type": "string" + }, + "representative_url_1x": { + "type": "string" + }, + "representative_url_2x": { + "type": "string" + }, + "representative_url_3x": { + "type": "string" + }, + "priority": { + "description": "Order when viewing style categories", + "type": "integer", + "format": "int32" + } + } + }, + "StyleCategoryListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StyleCategoryDto" + } + } + } + }, + "DeliveryPredictionListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeliveryPredictionDto" + } + } + } + }, + "DeliveryPredictionDto": { + "type": "object", + "required": [ + "kstDeliveryPredictionDate", + "probability" + ], + "properties": { + "kstDeliveryPredictionDate": { + "type": "string", + "description": "ISO-8601 format string (uuuu-MM-dd)" + }, + "probability": { + "description": "Probability of delivery being completed on that date", + "type": "integer", + "format": "int32" + } + } + }, + "PurchaseMeasurementsStatisticsListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PurchaseMeasurementsStatisticsDto" + } + } + } + }, + "PurchaseMeasurementsStatisticsDto": { + "type": "object", + "required": [ + "size", + "count", + "ratio" + ], + "properties": { + "size": { + "description": "Product Size Option Title", + "type": "string" + }, + "count": { + "description": "Number of purchases", + "type": "integer", + "format": "int64" + }, + "ratio": { + "description": "Percentage of total purchases", + "type": "integer", + "format": "int32" + } + } + }, + "PurchaseMeasurementsDto": { + "type": "object", + "required": [ + "bodySizeType", + "isSimilarBodySize", + "list" + ], + "properties": { + "bodySizeType": { + "$ref": "#/components/schemas/BodySizeTypeEnum" + }, + "isSimilarBodySize": { + "description": "Whether or not similar body type purchase data is recognized", + "type": "boolean" + }, + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PurchaserSizeDto" + } + } + } + }, + "PurchaserSizeDto": { + "type": "object", + "required": [ + "purchaserBodySize", + "purchaseSizeOptionName" + ], + "properties": { + "purchaserBodySize": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PurchaserBodySizeDto" + } + }, + "purchaseSizeOptionName": { + "description": "Purchased Size Option Title", + "type": "string" + } + } + }, + "PurchaserBodySizeDto": { + "type": "object", + "required": [ + "type", + "value" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/BodySizeTypeEnum" + }, + "value": { + "description": "Buyer's size", + "type": "integer", + "format": "int32" + } + } + }, + "BodySizeTypeEnum": { + "oneOf": [ + { + "const": "HEIGHT_AS_CENTI_METER" + }, + { + "const": "WEIGHT_AS_KILO_GRAM" + }, + { + "const": "TOP_SIZE" + }, + { + "const": "BOTTOM_SIZE_AS_INCH" + }, + { + "const": "SHOE_SIZE_AS_MILLI_METER" + } + ] + }, + "AttendanceCheckHistoryListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AttendanceCheckHistoryDto" + } + } + } + }, + "AttendanceCheckHistoryDto": { + "type": "object", + "required": [ + "days", + "attended", + "rewardPolicyType", + "pointAmount" + ], + "properties": { + "days": { + "description": "Attendance check day n", + "type": "integer", + "format": "int32" + }, + "pointAmount": { + "description": "Amount of points accumulated when participating in attendance check", + "type": "integer", + "format": "int64" + }, + "attended": { + "description": "Attendance check participation", + "type": "boolean" + }, + "attendedAt": { + "description": "Attendance check participation time epochMillis (null if not present)", + "type": "integer", + "format": "int64" + }, + "rewardPolicyType": { + "$ref": "#/components/schemas/AttendanceRewardPolicyTypeEnum" + } + } + }, + "ApiErrorResponse": { + "type": "object", + "properties": { + "msg": { + "type": "string", + "description": "reason for error" + }, + "traceId": { + "type": "string", + "description": "trace id for debug" + }, + "code": { + "oneOf": [ + { + "const": -999999 + }, + { + "const": -888888 + }, + { + "const": 1 + }, + { + "const": 2 + }, + { + "const": 3 + }, + { + "const": 4 + }, + { + "const": 5 + }, + { + "const": 6 + }, + { + "const": 7 + }, + { + "const": 1001 + }, + { + "const": 1002 + }, + { + "const": 1003 + }, + { + "const": 1004 + }, + { + "const": 60001 + }, + { + "const": 60002 + }, + { + "const": 61001 + }, + { + "const": 61002 + }, + { + "const": 61003 + }, + { + "const": 61004 + }, + { + "const": 61005 + }, + { + "const": 62001 + }, + { + "const": 62002 + }, + { + "const": 70001 + }, + { + "const": 70003 + }, + { + "const": 2001 + }, + { + "const": 2002 + }, + { + "const": 3001 + }, + { + "const": 4001 + }, + { + "const": 4002 + }, + { + "const": 5001 + }, + { + "const": 6001 + }, + { + "const": 6002 + }, + { + "const": 6003 + }, + { + "const": 7001 + }, + { + "const": 7002 + }, + { + "const": 7003 + }, + { + "const": 7004 + }, + { + "const": 7005 + }, + { + "const": 7006 + }, + { + "const": 7007 + }, + { + "const": 7008 + }, + { + "const": 7009 + }, + { + "const": 7010 + }, + { + "const": 7011 + }, + { + "const": 8001 + }, + { + "const": 9001 + } + ], + "x-enum-varnames": [ + "INTERNAL_FAILURE", + "EXTERNAL_FAILURE", + "ALREADY_EXISTS", + "NOT_AUTHORIZED", + "INVALID_VALUE", + "RESOURCE_NOT_FOUND", + "LIMITATION_EXCEEDED", + "LOGIN_REQUIRED", + "ACCESS_DENIED", + "ACCESS_TOKEN_EXPIRED", + "REFRESH_TOKEN_EXPIRED", + "INVALID_ACCESS_TOKEN", + "INVALID_REFRESH_TOKEN", + "COUPON_NOT_ENABLED", + "COUPON_NOT_CONSUMABLE", + "COUPON_ISSUE_BEFORE_BEGIN", + "COUPON_ISSUE_AFTER_END", + "COUPON_ISSUE_LIMIT_EXCEEDED", + "COUPON_ISSUE_LIMIT_PER_USER_EXCEEDED", + "COUPON_ISSUE_NOT_TARGET", + "COUPON_BOOK_ISSUABLES_NOT_EXIST", + "DISPLAYING_COUPONS_ISSUABLE_NOT_EXIST", + "PAYMENT_NOT_FULLY_PAID", + "MINIMUM_PAYMENT_PRICE_LIMIT_EXCEPTION", + "REVIEW_REPORTED_BY_SELF", + "REVIEW_REPORTED_TWICE", + "VALIDATAION_BANK_ACCOUNT_FAILURE", + "DUPLICATED_MALL_PRODUCT_CODE", + "PRODUCT_WITHOUT_POLICY_TARGET", + "DUPLICATED_BRAND_CODE", + "SEND_DELIVERY_TRACE_REQUEST_FAILED", + "RECEIVE_DELIVERY_TRACE_RESULT_FAILED", + "SEND_DELIVERY_TRACE_RESULT_RESPONSE_FAILED", + "TICKET_PROCESSING_IS_REQUIRED_TO_CONFIRM_RECEIPT", + "CAN_ONLY_CONFIRM_RECEIPT_OF_PAID_ORDER_LINE", + "CANNOT_CONFIRM_RECEIPT_WHEN_DELIVERY_NOT_COMPLETE", + "CANNOT_REQUEST_REFUND_AFTER_CONFIRM_RECEIPT", + "LACK_OF_POINT", + "ORDER_LINE_COUNT_LIMIT_PER_ORDER_EXCEEDED", + "ORDER_ALREADY_DISPATCHED", + "CANNOT_CHANGE_DELIVERY_AREA", + "ORDER_UNAVAILABLE_PRODUCT_ITEM", + "CANNOT_APPEND_TICKET", + "CANNOT_EXCEED_ALREADY_REQUESTED_AMOUNT", + "ATTENDANCE_CHECK_COMPLETED", + "PRODUCT_NOT_BELONGS_TO_BRAND" + ] + } + } + } + }, + "securitySchemes": { + "damoa-token": { + "type": "http", + "scheme": "bearer", + "bearerFormat": "JWT" + } + } + }, + "x-samchon-emended": true +} \ No newline at end of file diff --git a/assets/output/damoa.swagger.ja.json b/assets/output/damoa.swagger.ja.json new file mode 100644 index 0000000..2f9a443 --- /dev/null +++ b/assets/output/damoa.swagger.ja.json @@ -0,0 +1,20539 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "Damoa API ไป•ๆง˜", + "description": "Damoa API ไป•ๆง˜", + "version": "1.0.0" + }, + "servers": [ + { + "url": "https://api.queenit.kr", + "description": "production" + }, + { + "url": "https://api.dev.queenit.kr", + "description": "้–‹็™บ" + }, + { + "url": "http://localhost:8080", + "description": "local" + }, + { + "url": "https://{namespace}-app-api.dev.rapportlabs.cloud", + "variables": { + "namespace": { + "default": "damoa" + } + } + } + ], + "tags": [ + { + "name": "metadata", + "description": "metadata api" + }, + { + "name": "verification", + "description": "verification api" + }, + { + "name": "hello", + "description": "hello api" + }, + { + "name": "favorite", + "description": "favorite api" + }, + { + "name": "best", + "description": "best api" + }, + { + "name": "product", + "description": "product api" + }, + { + "name": "ageGroup", + "description": "ageGroup api" + }, + { + "name": "home", + "description": "home api" + }, + { + "name": "newArrival", + "description": "new arrival api" + }, + { + "name": "hotDeal", + "description": "hot deal api" + }, + { + "name": "recommendation", + "description": "recommendation api" + }, + { + "name": "promotion", + "description": "promotion api" + }, + { + "name": "cart", + "description": "cart api" + }, + { + "name": "account", + "description": "account api" + }, + { + "name": "order", + "description": "order api" + }, + { + "name": "payment", + "description": "payment api" + }, + { + "name": "banner", + "description": "banner api" + }, + { + "name": "collection", + "description": "collection api" + }, + { + "name": "search", + "description": "search api" + }, + { + "name": "autocomplete", + "description": "autocomplete api" + }, + { + "name": "coupon", + "description": "coupon api" + }, + { + "name": "review", + "description": "review api" + }, + { + "name": "reviewStatistics", + "description": "reviewStatistics api" + }, + { + "name": "userProfile", + "description": "user profile api" + }, + { + "name": "image", + "description": "image api" + }, + { + "name": "prompt", + "description": "prompt api" + }, + { + "name": "shopLive", + "description": "shopLive api" + }, + { + "name": "point", + "description": "point api" + }, + { + "name": "productRanking", + "description": "productRanking api" + }, + { + "name": "tier", + "description": "tier api" + }, + { + "name": "styleShot", + "description": "style shot api" + }, + { + "name": "attendanceCheck", + "description": "attendance check api" + }, + { + "name": "tag", + "description": "tag api" + } + ], + "paths": { + "/metadata": { + "get": { + "description": "metadata api", + "operationId": "getMetadata", + "tags": [ + "metadata" + ], + "responses": { + "200": { + "description": "metadata response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MetadataDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/hello": { + "get": { + "summary": "hello world", + "operationId": "hello", + "tags": [ + "hello" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to hello", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/verifications/sms": { + "post": { + "summary": "send verification code by sms [invalid phone number -> ApiErrorType.INVALID_VALUE]", + "operationId": "sendVerifCodeBySms", + "tags": [ + "verification" + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SendVerifCodeRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to send verification code", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SendVerifCodeResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/verifications": { + "put": { + "summary": "verify code [invalid token or code -> ApiErrorType.INVALID_VALUE]", + "operationId": "verifyCode", + "tags": [ + "verification" + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VerifyCodeRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to verify code", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VerifyCodeResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/verifications/kakao": { + "put": { + "summary": "verify kakao access token", + "operationId": "verifyKakaoToken", + "tags": [ + "verification" + ], + "description": "- ใ‚ซใ‚ซใ‚ชใƒญใ‚ฐใ‚คใƒณใง่ช่จผใ—ใŸใƒฆใƒผใ‚ถใƒผใฎๅ ดๅˆใ€็™บ่กŒใ•ใ‚ŒใŸใ‚ซใ‚ซใ‚ชAPIใ‚ขใ‚ฏใ‚ปใ‚นใƒˆใƒผใ‚ฏใƒณใจ้›ป่ฉฑ็•ชๅทใ‚’ไฝฟ็”จใ—ใฆverifiedTokenใ‚’่ฆๆฑ‚ - ้›ป่ฉฑ็•ชๅทใฏๅ›ฝ้š›้›ป่ฉฑๅฝขๅผ๏ผˆไพ‹๏ผš+82 10-1111-1111๏ผ‰ - ็™บ่กŒใ•ใ‚ŒใŸverifiedTokenใ‚’ไฝฟ็”จใ—ใฆsignUpV2 APIใ‚’ๅ‘ผใณๅ‡บใ—ใฆใƒญใ‚ฐใ‚คใƒณ/ไผšๅ“ก็™ป้Œฒใ‚’้€ฒใ‚ใ‚‹", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VerifyKakaoTokenRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to verify", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VerifyKakaoTokenResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/migrate-user": { + "post": { + "summary": "firebase auth user -> damoa auth user ๅˆ‡ใ‚Šๆ›ฟใˆ", + "description": ">ๆ—ขๅญ˜ใฎๅคใ„ใƒใƒผใ‚ธใƒงใƒณใฎใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใงfirebase authใ‚’ไฝฟ็”จใ—ใฆใ„ใŸใƒฆใƒผใ‚ถใƒผใ‚’damoa authใ‚’ไฝฟ็”จใ™ใ‚‹ใ‚ˆใ†ใซๅˆ‡ใ‚Šๆ›ฟใˆใพใ™ใ€‚ ๏ผˆใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆ๏ผ‰firebase authๆƒ…ๅ ฑใŒใ‚ใ‚‹ๅ ดๅˆใฏใ€ๆ—ขๅญ˜ใฎfirebase auth tokenใ‚’ใƒชใƒ•ใƒฌใƒƒใ‚ทใƒฅใ—ใพใ™ใ€‚ ๏ผˆใ‚ตใƒผใƒใƒผ๏ผ‰ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใŒ้€ไฟกใ—ใŸใ‚ขใ‚ฏใ‚ปใ‚นใƒˆใƒผใ‚ฏใƒณๆƒ…ๅ ฑใงใƒˆใƒผใ‚ฏใƒณใƒ™ใƒณใƒ€ใƒผใ‚’็ขบ่ชใ™ใ‚‹ -> firebaseใง็™บ่กŒใ•ใ‚ŒใŸใฎใ‹ใ€damoaใง็™บ่กŒใ•ใ‚ŒใŸใฎใ‹ใ‚’็ขบ่ชใ™ใ‚‹ใ‚‚ใฃใจใƒใ‚งใƒƒใ‚ฏใ™ใ‚‹token(access & refresh)ใ‚’responseใซ้€ใ‚‹ 7. (ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆ) damoa auth tokenใ‚’ไฝฟใ†", + "operationId": "migrateUser", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FirebaseAuthUserMigrationRequest" + } + } + } + }, + "responses": { + "200": { + "description": "success to migrate user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DamoaTokenDto" + } + } + } + }, + "204": { + "description": "ใ™ใงใซdamoa auth userใฎๅ ดๅˆ" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/signin/anonymous": { + "post": { + "summary": "anonymous ใƒฆใƒผใ‚ถใƒผใจใ—ใฆใƒญใ‚ฐใ‚คใƒณ", + "description": "anonymous ใƒฆใƒผใ‚ถใƒผใจใ—ใฆใƒญใ‚ฐใ‚คใƒณใ™ใ‚‹ [invalid token -> ApiErrorType.INVALID_VALUE]", + "operationId": "signInAnonymously", + "tags": [ + "account" + ], + "responses": { + "200": { + "description": "success to signin anonymously", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DamoaTokenDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/signup/providers/{providerType}": { + "post": { + "summary": "่ช่จผใ•ใ‚ŒใŸใƒฆใƒผใ‚ถใƒผใฎใƒญใ‚ฐใ‚คใƒณ/็™ป้Œฒ", + "description": "- ๆ—ขๅญ˜ใฎใ‚ตใƒ–ใ‚นใ‚ฏใƒชใƒ—ใ‚ทใƒงใƒณใ‚’ๆŒใฃใฆใ„ใŸใƒฆใƒผใ‚ถใƒผใŒๅ†ใณใƒญใ‚ฐใ‚คใƒณใ—ใŸใ‚Šใ€ๆ–ฐใ—ใ„ใ‚ตใƒ–ใ‚นใ‚ฏใƒชใƒ—ใ‚ทใƒงใƒณใ‚’ใ—ใŸๅ ดๅˆใซๅ‘ผใณๅ‡บใ•ใ‚Œใ‚‹ - ็พๅœจใฎ `providerType`ใง `SMS`ใจ `KAKAO`ใ‚’ใ‚ตใƒใƒผใƒˆ - ไป–ใฎproviderTypeใ‚’ไฝฟ็”จใ™ใ‚‹ใจใ‚จใƒฉใƒผใŒ็™บ็”Ÿใ™ใ‚‹ใชใฉใŒ่ฟฝๅŠ ใ•ใ‚Œใ‚‹ใ“ใจใ‚‚ใ‚ใ‚‹ - request headerใซๅ…ฅใ‚‹authorizationๆƒ…ๅ ฑใซใฏanonymous signup apiๅ‘ผใณๅ‡บใ—ๅพŒใซ็™บ่กŒใ•ใ‚ŒใŸaccess tokenใ‚’่จ˜ๅ…ฅใ™ใ‚‹ - `Bearer {{ anonymous access token }}`ๅฝขๅผใงใใชใ„", + "operationId": "signUpV2", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "providerType", + "schema": { + "$ref": "#/components/schemas/ProviderTypeEnum" + }, + "required": true, + "description": "auth provider(SMSใ€KAKAOใ€..)" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SignUpRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to signup", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DamoaTokenDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/refresh": { + "post": { + "summary": "่ช่จผใ•ใ‚ŒใŸใƒฆใƒผใ‚ถใƒผใพใŸใฏanonymousใƒฆใƒผใ‚ถใƒผใฎaccess/refresh tokenใฎๆ›ดๆ–ฐ", + "description": "่ช่จผใ•ใ‚ŒใŸใƒฆใƒผใ‚ถใƒผใพใŸใฏanonymousใƒฆใƒผใ‚ถใƒผใฎaccess/refresh tokenใฎๆ›ดๆ–ฐ", + "operationId": "refreshToken", + "tags": [ + "account" + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DamoaTokenRefreshRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to refresh tokens", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DamoaTokenDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/accounts": { + "get": { + "summary": "ใƒฆใƒผใ‚ถใƒผใฎใ‚ขใ‚ซใ‚ฆใƒณใƒˆๆƒ…ๅ ฑใ‚’็…งไผšใ™ใ‚‹ใจใใซไฝฟ็”จใ™ใ‚‹", + "description": "damoa authใ‚’ไฝฟ็”จใ—ใฆใ„ใ‚‹ใƒฆใƒผใ‚ถใƒผใ ใ‘ใŒๆญฃๅธธใซๅˆฉ็”จใงใใพใ™๏ผˆanonymousใƒฆใƒผใ‚ถใƒผใ‚’ๅซใ‚€๏ผ‰", + "operationId": "getDamoaLoginAccount", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to retrieve account info", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LoginAccountDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/signout": { + "post": { + "summary": "signout", + "operationId": "signOut", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to signout" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/logout": { + "post": { + "summary": "logout", + "operationId": "logout", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to logout" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/external-uid": { + "get": { + "summary": "get external uid", + "description": "ใใฎ user ใฎๅค–้ƒจ API ๅ‘ผใณๅ‡บใ—ใซไฝฟ็”จใงใใ‚‹ external uid ใ‚’่ฟ”ใ—ใพใ™.", + "operationId": "getExternalUid", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "external uid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExternalUidDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/payment-methods": { + "get": { + "summary": "get registered payment methods", + "description": "ใใฎใƒฆใƒผใ‚ถใƒผใŒใ‚ฏใ‚คใƒผใƒณใ‚คใƒƒใƒˆใƒšใ‚คใซ็™ป้Œฒใ—ใŸใŠๆ”ฏๆ‰•ใ„ๆ–นๆณ•ใฎใƒชใ‚นใƒˆใ‚’่ฟ”ใ—ใพใ™.", + "operationId": "getPaymentMethods", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "registered payment methods", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaymentMethodResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/credentials/connect-pay": { + "get": { + "summary": "get connect pay credentials", + "description": "ConnectPay JS SDKใ‚’ไฝฟ็”จใ™ใ‚‹ใŸใ‚ใฎcredentialใ‚’่ฟ”ใ—ใพใ™.", + "operationId": "getConnectPayCredentials", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "connect pay clientKey and user specific customerKey", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectPayCredentialDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/favorites": { + "get": { + "summary": "get favorites", + "operationId": "getMyFavorites", + "tags": [ + "favorite" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "- my favorite product list - ใ‚ฏใ‚คใƒผใƒณใ‚คใƒƒใƒˆๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸๅ ดๅˆใ€`FavoriteProductDto`ใงๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸ้‡‘้กใ‚’่กจ็คบใ™ใ‚‹ - ๅฝฑ้Ÿฟใ‚’ๅ—ใ‘ใ‚‹ใƒ•ใ‚ฃใƒผใƒซใƒ‰: `price`, `productDiscountRate`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FavoriteProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/favorites/{productId}": { + "delete": { + "summary": "delete favorite", + "operationId": "deleteMyFavorite", + "tags": [ + "favorite" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "success to delete" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + }, + "put": { + "summary": "add favorite", + "operationId": "addMyFavorite", + "tags": [ + "favorite" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "success to add" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/best/products": { + "get": { + "summary": "get best products for recent specific period", + "operationId": "getBestAppProducts", + "tags": [ + "best" + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "required": true, + "description": "best products for this period", + "name": "period", + "schema": { + "$ref": "#/components/schemas/BestPeriodEnum" + } + }, + { + "in": "query", + "required": false, + "name": "categoryId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "description": "ๅนด้ฝขใ‚ณใƒผใƒ‰.", + "required": false, + "name": "ageGroupCode", + "schema": { + "$ref": "#/components/schemas/AgeGroupCodeEnum" + } + } + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- get best products for recent specific period - ใ‚ฏใ‚คใƒผใƒณใ‚คใƒƒใƒˆๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸๅ ดๅˆ `AppProductDto` ใงๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸ้‡‘้กใ‚’่กจ็คบใ™ใ‚‹ - ๅฝฑ้Ÿฟใ‚’ๅ—ใ‘ใ‚‹ใƒ•ใ‚ฃใƒผใƒซใƒ‰: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/best/brands/v2": { + "get": { + "summary": "get best brands for recent specific period", + "operationId": "getBestAppBrands", + "tags": [ + "best" + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "required": true, + "description": "best brands for this period", + "name": "period", + "schema": { + "$ref": "#/components/schemas/BestPeriodEnum" + } + }, + { + "in": "query", + "description": "ๅนด้ฝขใ‚ณใƒผใƒ‰.", + "required": false, + "name": "ageGroupCode", + "schema": { + "$ref": "#/components/schemas/AgeGroupCodeEnum" + } + } + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "get best brands for recent specific period", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BestBrandListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/best/WooRanking": { + "get": { + "summary": "get woo ranking products - DEPRECATED", + "operationId": "getWooRankingProducts", + "tags": [ + "best" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "woo ranking products - DEPRECATED", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/promotions/brands": { + "get": { + "summary": "get promotion brands", + "operationId": "getPromotedBrands", + "tags": [ + "promotion" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "promotion brands", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BrandListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/promotions/products": { + "get": { + "summary": "get promotion products", + "operationId": "getPromotionProducts", + "tags": [ + "promotion" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "- promotion products - ใ‚ฏใ‚คใƒผใƒณใ‚คใƒƒใƒˆๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚Œใ‚‹ๅ ดๅˆใ€`ProductDto`ใงๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸ้‡‘้กใ‚’่กจ็คบใ™ใ‚‹ - ๅฝฑ้Ÿฟใ‚’ๅ—ใ‘ใ‚‹ใƒ•ใ‚ฃใƒผใƒซใƒ‰: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/promotions/connect-pay": { + "get": { + "summary": "get connect pay promotions", + "operationId": "getConnectPayPromotions", + "tags": [ + "promotion" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "connect-pay card discount promotions and interest-free installment policies", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectPayPromotionDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/promotions/toss": { + "get": { + "summary": "get toss payments promotions", + "operationId": "getTossPromotions", + "tags": [ + "promotion" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "toss card discount promotions policies and interest-free installment policies", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TossPaymentPromotionDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/newArrivals/products": { + "get": { + "summary": "get new arrival products - DEPRECATED", + "operationId": "getNewArrivalProducts", + "tags": [ + "newArrival" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "new products - DEPRECATED", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/promotions/products/discounted": { + "get": { + "deprecated": true, + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "description": "Please set orderBy to RECOMMENDATION as a default value.", + "name": "orderBy", + "required": true, + "schema": { + "$ref": "#/components/schemas/ProductOrderByEnum" + } + }, + { + "in": "query", + "required": false, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ], + "summary": "Get discounted promotion products by orderBy parameters", + "operationId": "getDiscountedPromotionProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- discounted promotion products by orderBy parameters - ใ‚ฏใ‚คใƒผใƒณใ‚คใƒƒใƒˆๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸๅ ดๅˆ `AppProductDto` ใงๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸ้‡‘้กใ‚’่กจ็คบใ™ใ‚‹ - ๅฝฑ้Ÿฟใ‚’ๅ—ใ‘ใ‚‹ใƒ•ใ‚ฃใƒผใƒซใƒ‰: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/discount-benefits": { + "get": { + "summary": "get product's discount benefits information", + "operationId": "getProductDiscountBenefits", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "result of product's discount benefits information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductDiscountBenefitsDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/shopping-mall": { + "get": { + "deprecated": true, + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "description": "Please set orderBy to RECOMMENDATION as a default value.", + "name": "orderBy", + "required": true, + "schema": { + "$ref": "#/components/schemas/ProductOrderByEnum" + } + }, + { + "in": "query", + "required": false, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ], + "summary": "Get shopping mall products by orderBy parameters", + "operationId": "getShoppingMallProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- shopping mall products by orderBy parameters - ใ‚ฏใ‚คใƒผใƒณใ‚คใƒƒใƒˆๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚Œใ‚‹ๅ ดๅˆ `AppProductDto` ใงๅณๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸ้‡‘้กใ‚’่กจ็คบใ™ใ‚‹ - ๅฝฑ้Ÿฟใ‚’ๅ—ใ‘ใ‚‹ใƒ•ใ‚ฃใƒผใƒซใƒ‰: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/keyword-related": { + "get": { + "summary": "ใ‚ญใƒผใƒฏใƒผใƒ‰ใซใ‚ˆใ‚‹้–ข้€ฃๅ•†ๅ“ใ‚’่ฟ”ใ—ใพใ™.", + "operationId": "getKeywordRelatedProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "name": "keyword", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "verbose", + "required": false, + "schema": { + "description": "ใƒ‡ใƒใƒƒใ‚ฐ็”จใฎใƒ‘ใƒฉใƒกใƒผใ‚ฟใ€‚ใใฎๅ€คใŒtrueใฎๅ ดๅˆใ€ใƒญใ‚ฐใ‚’ใฏใ‚‹ใ‹ใซ่ฉณ็ดฐใซๅ–ๅพ—ใ—ใพใ™.", + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "ใ‚ญใƒผใƒฏใƒผใƒ‰้–ข้€ฃๅ•†ๅ“ใฎ็ตๆžœ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/related": { + "get": { + "summary": "็‰นๅฎšใฎๆกไปถใซๅฟœใ˜ใŸ้–ข้€ฃๅ•†ๅ“ใ‚’่ฟ”ใ—ใพใ™.", + "operationId": "getRelatedProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "name": "brandId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "categoryId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "relationTargetProductIds", + "description": "ใ“ใฎใƒ‘ใƒฉใƒกใƒผใ‚ฟใซๆธกใ•ใ‚ŒใŸๅ•†ๅ“ใซ้–ข้€ฃใ™ใ‚‹ๅ•†ๅ“ใ‚’่ฟ”ใ—ใพใ™.", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "name": "verbose", + "required": false, + "schema": { + "description": "ใƒ‡ใƒใƒƒใ‚ฐ็”จใฎใƒ‘ใƒฉใƒกใƒผใ‚ฟใ€‚ใใฎๅ€คใŒtrueใฎๅ ดๅˆใ€ใƒญใ‚ฐใ‚’ใฏใ‚‹ใ‹ใซ่ฉณ็ดฐใซๅ–ๅพ—ใ—ใพใ™.", + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "้–ข้€ฃๅ•†ๅ“็ตๆžœ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/personalized/products": { + "post": { + "deprecated": true, + "summary": "Get filtered personalized products", + "operationId": "getFilteredPersonalizedProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FilteredPersonalizedProductRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "- Get personalized products filtered by parameters", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + }, + "get": { + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "description": "Please set orderBy to RECOMMENDATION as a default value.", + "name": "orderBy", + "required": false, + "schema": { + "$ref": "#/components/schemas/ProductOrderByEnum" + } + }, + { + "in": "query", + "required": false, + "name": "categoryId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "required": false, + "name": "brandId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "description": "ๅนด้ฝขใ‚ณใƒผใƒ‰.", + "required": false, + "name": "ageGroupCode", + "schema": { + "$ref": "#/components/schemas/AgeGroupCodeEnum" + } + }, + { + "in": "query", + "required": false, + "name": "minPrice", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "maxPrice", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "mySizeOnly", + "schema": { + "type": "boolean" + } + }, + { + "in": "query", + "required": false, + "name": "tagId", + "deprecated": true, + "schema": { + "type": "integer", + "description": "(deprecated) use tagIdForBrandSourcing", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "tagIdForBrandSourcing", + "schema": { + "description": "tagIdใซๅฏพๅฟœใ™ใ‚‹brandSourcingCodeใซใคใ„ใฆๅ•†ๅ“ใ‚’็…งไผšใ™ใ‚‹", + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "clickedProductIds", + "description": "- ใ‚ฏใƒชใƒƒใ‚ฏใ—ใŸๅ•†ๅ“ใ€‚ใƒ‘ใƒผใ‚ฝใƒŠใƒฉใ‚คใ‚บใ•ใ‚ŒใŸๅ•†ๅ“ใ‚’ๆไพ›ใ™ใ‚‹ใŸใ‚ใซไฝฟ็”จใ•ใ‚Œใพใ™ใ€‚ - ๅ„ๅ•†ๅ“ใŒใ‚ฏใƒชใƒƒใ‚ฏใ•ใ‚ŒใŸๆ™‚้–“ๆƒ…ๅ ฑใ‚’้…ไฟกใ™ใ‚‹ใซใฏใ€clickedProductAtMillisใƒ‘ใƒฉใƒกใƒผใ‚ฟใ‚’ไธ€็ท’ใซๆธกใ™ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™.", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "required": false, + "name": "clickedProductAtMillis", + "description": "- ๅ•†ๅ“ใ‚’ใ‚ฏใƒชใƒƒใ‚ฏใ—ใŸๆ™‚้–“ใ€‚ๅ„ๆ™‚้–“ใฏ clickedProductIds ใƒ‘ใƒฉใƒกใƒผใ‚ฟใซๅฏพๅฟœใ—ใพใ™ใ€‚ - clickedProductIds ใจ clickedProductAtMillis ใƒ‘ใƒฉใƒกใƒผใ‚ฟใฎใ‚ตใ‚คใ‚บใฏๅธธใซๅŒใ˜ใงใชใ‘ใ‚Œใฐใชใ‚Šใพใ›ใ‚“.", + "schema": { + "type": "array", + "items": { + "type": "number", + "format": "int64" + } + } + }, + { + "in": "query", + "required": false, + "name": "modelId", + "description": "- ใฉใฎใƒ‘ใƒผใ‚ฝใƒŠใƒฉใ‚คใ‚บใƒขใƒ‡ใƒซใ‚’ไฝฟ็”จใ™ใ‚‹ใ‹ใ€‚ (A/B Testing ็”จ้€”) - ใƒŽใƒƒใ‚ทใƒงใƒณใƒŽใƒผใƒˆ: https://www.notion.so/rapportlabs/AB-Protocol-c878d879ff0443cda929bb17d9b137c1", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "required": false, + "name": "postProcessingId", + "description": "- ๅ€‹ไบบๅŒ–็ตๆžœใฎๅพŒๅ‡ฆ็†ใ‚’ใฉใ†ใ™ใ‚‹ใ‹ใ€‚ (A/B Testing ็”จ้€”) - ใƒŽใƒƒใ‚ทใƒงใƒณใƒŽใƒผใƒˆ: https://www.notion.so/rapportlabs/AB-Protocol-c878d879ff0443cda929bb17d9b137c1", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "verbose", + "required": false, + "schema": { + "description": "ใƒ‡ใƒใƒƒใ‚ฐ็”จใฎใƒ‘ใƒฉใƒกใƒผใ‚ฟใ€‚ใใฎๅ€คใŒtrueใฎๅ ดๅˆใ€ใƒญใ‚ฐใ‚’ใฏใ‚‹ใ‹ใซ่ฉณ็ดฐใซๅ–ๅพ—ใ—ใพใ™.", + "default": false, + "type": "boolean" + } + } + ], + "summary": "Get personalized recommendation products by filter", + "operationId": "getPersonalizedRecommendationProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- Get personalized recommendation products by filter and orderBy parameters", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/refined": { + "get": { + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "description": "Please set orderBy to RECOMMENDATION as a default value.", + "name": "orderBy", + "required": true, + "schema": { + "$ref": "#/components/schemas/ProductOrderByEnum" + } + }, + { + "in": "query", + "required": false, + "name": "categoryId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "required": false, + "name": "categoryIds", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "required": false, + "name": "brandId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "required": false, + "name": "brandIds", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "description": "ๅนด้ฝขใ‚ณใƒผใƒ‰.", + "required": false, + "name": "ageGroupCode", + "schema": { + "$ref": "#/components/schemas/AgeGroupCodeEnum" + } + }, + { + "in": "query", + "required": false, + "name": "minPrice", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "maxPrice", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "mySizeOnly", + "schema": { + "type": "boolean" + } + }, + { + "in": "query", + "description": "ใƒ•ใ‚ฃใƒซใ‚ฟใƒชใƒณใ‚ฐใ™ใ‚‹ๅ•†ๅ“ๅฑžๆ€งIDใฎใƒชใ‚นใƒˆ", + "required": false, + "name": "productFeatureIds", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "deprecated": true, + "required": false, + "description": "๏ผˆDEPRECATED๏ผ‰enabledTotalCountใ€enabledProductFeatureAggregationใ€enabledProductCategoryAggregationใ€enabledBrandAggregationใ‚’ไฝฟ็”จใ—ใฆใใ ใ•ใ„.", + "name": "enabledProductAggregation", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "ๅ•†ๅ“้›†่จˆใง็ทๆ•ฐใŒๅฟ…่ฆใชๅ ดๅˆใฏtrueใซ่จญๅฎšใ—ใพใ™ใ€‚.", + "name": "enabledTotalCount", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "ๅ•†ๅ“้›†่จˆใงๅ•†ๅ“ๅฑžๆ€งๅˆฅใฎๆ•ฐใŒๅฟ…่ฆใชๅ ดๅˆใฏtrueใซ่จญๅฎšใ—ใพใ™ใ€‚.", + "name": "enabledProductFeatureAggregation", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "ๅ•†ๅ“้›†่จˆใงๅ•†ๅ“ใ‚ซใƒ†ใ‚ดใƒชๅˆฅใฎๆ•ฐใŒๅฟ…่ฆใชๅ ดๅˆใฏtrueใซ่จญๅฎšใ—ใพใ™ใ€‚.", + "name": "enabledProductCategoryAggregation", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "ๅ•†ๅ“้›†่จˆ(aggregation)ใงใƒ–ใƒฉใƒณใƒ‰ๅˆฅๅ€‹ๆ•ฐใŒๅฟ…่ฆใชๅ ดๅˆใฏtrueใซ่จญๅฎšใ™ใ‚‹.", + "name": "enabledBrandAggregation", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "deprecated": true, + "description": "๏ผˆdeprecated๏ผ‰tagIdForBrandSourcingใƒ‘ใƒฉใƒกใƒผใ‚ฟใ‚’ไฝฟ็”จใ—ใฆใใ ใ•ใ„", + "name": "tagId", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "tagIdForBrandSourcing", + "schema": { + "description": "tagIdใซๅฏพๅฟœใ™ใ‚‹brandSourcingCodeใซใคใ„ใฆๅ•†ๅ“ใ‚’็…งไผšใ™ใ‚‹", + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "description": "ๅ•†ๅ“ใ‚ฟใ‚ฐใƒ•ใ‚ฃใƒซใ‚ฟใฎใŸใ‚ใฎids", + "name": "tagIdsForProductTag", + "schema": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + } + }, + { + "in": "query", + "required": false, + "description": "ๅ•†ๅ“ใ‚ฟใ‚ฐใฎใชใ„ๅ•†ๅ“ใ‚‚ไธ€็ท’ใซ้œฒๅ‡บใ•ใ›ใ‚‹ใŸใ‚ใฎใƒ‘ใƒฉใƒกใƒผใ‚ฟ", + "name": "allowProductsWithoutTags", + "schema": { + "type": "boolean" + } + } + ], + "summary": "Get refined products by filter and orderBy parameters", + "operationId": "getRefinedProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- Get refined products by filter and orderBy parameters - ใ‚ฏใ‚คใƒผใƒณใ‚คใƒƒใƒˆๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸๅ ดๅˆ `AppProductDto` ใงๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸ้‡‘้กใ‚’่กจ็คบใ™ใ‚‹ - ๅฝฑ้Ÿฟใ‚’ๅ—ใ‘ใ‚‹ใƒ•ใ‚ฃใƒผใƒซใƒ‰: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/advertisement": { + "get": { + "parameters": [ + { + "in": "header", + "name": "page", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "description": "Please set orderBy to RECOMMENDATION as a default value.", + "name": "orderBy", + "required": false, + "schema": { + "$ref": "#/components/schemas/ProductOrderByEnum" + } + }, + { + "in": "query", + "required": false, + "name": "categoryId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "required": false, + "name": "minPrice", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "maxPrice", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "mySizeOnly", + "schema": { + "type": "boolean" + } + } + ], + "summary": "Get advertisement products by filter and orderBy parameters", + "operationId": "getAdvertisementProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- Get advertisement products by filter and orderBy parameters", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAdvertisementProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/detail/advertisement": { + "get": { + "parameters": [ + { + "in": "query", + "required": false, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ], + "summary": "Get advertisement products by filter and orderBy parameters", + "operationId": "getAdvertisementProductDetail", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- Get advertisement products in PDP", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAdvertisementProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products": { + "get": { + "parameters": [ + { + "in": "query", + "required": true, + "name": "ids", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "summary": "get products by ids parameter", + "description": "( count of ids is over 40 -> ApiErrorResponseCode.LIMITATION_EXCEEDED )", + "operationId": "getProducts", + "tags": [ + "product" + ], + "responses": { + "200": { + "description": "- products (unique and not ordered) by ids - ใ‚ฏใ‚คใƒผใƒณใ‚คใƒƒใƒˆๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸๅ ดๅˆ `ProductDto` ใงๅณๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸ้‡‘้กใ‚’่กจ็คบใ™ใ‚‹ - ๅฝฑ้Ÿฟใ‚’ๅ—ใ‘ใ‚‹ใƒ•ใ‚ฃใƒผใƒซใƒ‰: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductSetDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/similar/v2": { + "get": { + "summary": "get image based similar product (v2)", + "operationId": "getImageBasedSimilarProductsV2", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minRating", + "schema": { + "type": "number", + "format": "int32" + } + }, + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "name": "modelId", + "required": false, + "description": "ใฉใฎใƒขใƒ‡ใƒซใ‚’ไฝฟใ†ใ‹ใ€‚ https://www.notion.so/rapportlabs/AB-Protocol-c878d879ff0443cda929bb17d9b137c1?pvs=4", + "schema": { + "type": "string", + "default": "TAG_SIM" + } + }, + { + "in": "query", + "name": "postProcessingId", + "description": "ๅพŒๅ‡ฆ็†ใ‚’ใฉใ†ใ™ใ‚‹ใ‹ใ€‚ https://www.notion.so/rapportlabs/AB-Protocol-c878d879ff0443cda929bb17d9b137c1?pvs=4", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "verbose", + "required": false, + "schema": { + "description": "ใƒ‡ใƒใƒƒใ‚ฐ็”จใฎใƒ‘ใƒฉใƒกใƒผใ‚ฟใ€‚ใใฎๅ€คใŒtrueใฎๅ ดๅˆใ€ใƒญใ‚ฐใ‚’ใฏใ‚‹ใ‹ใซ่ฉณ็ดฐใซๅ–ๅพ—ใ—ใพใ™.", + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "- ็”ปๅƒใƒ™ใƒผใ‚นใฎ้กžไผผๅ•†ๅ“ใ‚’ไธ‹ใ’ใ‚‹ใ€‚ ๏ผˆv1ใจๆฏ”่ผƒใ—ใฆๅ ฑๅ‘Š็ตๆžœใซๅฟœใ˜ใฆ็‰นๅฎšใƒใƒผใ‚ธใƒงใƒณใ‚’deprecatedใ•ใ›ใ‚‹ไบˆๅฎš๏ผ‰", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/similar": { + "get": { + "summary": "get image based similar product", + "operationId": "getImageBasedSimilarProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minRating", + "required": true, + "schema": { + "type": "number", + "format": "int32" + } + }, + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "- ็”ปๅƒใƒ™ใƒผใ‚นใฎ้กžไผผๅ•†ๅ“ใ‚’ไธ‹ใ’ใ‚‹.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/outfit": { + "get": { + "summary": "get image based outfit product", + "operationId": "getImageBasedOutfitProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minRating", + "required": true, + "schema": { + "type": "number", + "format": "int32" + } + }, + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "- ็”ปๅƒใƒ™ใƒผใ‚นใฎใ‚ณใƒผใƒ‡ใ‚ฃใƒใƒผใƒˆๅ•†ๅ“ใ‚’ไธ‹ใ’ใ‚‹.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/hotDeals/products": { + "get": { + "summary": "get hotDeal products", + "operationId": "getHotDealProducts", + "tags": [ + "hotDeal" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "- hot deal products - ใ‚ฏใ‚คใƒผใƒณใ‚คใƒƒใƒˆๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸๅ ดๅˆใ€`ProductDto`ใงใ™ใใซๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸ้‡‘้กใ‚’่กจ็คบใ™ใ‚‹ - ๅฝฑ้Ÿฟใ‚’ๅ—ใ‘ใ‚‹ใƒ•ใ‚ฃใƒผใƒซใƒ‰: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/recommendations/categories": { + "get": { + "summary": "get recommended product categories", + "operationId": "getRecommendationCategories", + "tags": [ + "recommendation" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "recommendation categories", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/recommendations/categories/{categoryId}/products": { + "get": { + "summary": "get recommended products", + "operationId": "getRecommendedProductsByCategory", + "tags": [ + "recommendation" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "- recommended products - ใ‚ฏใ‚คใƒผใƒณใ‚คใƒƒใƒˆๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸๅ ดๅˆใ€`ProductDto`ใงๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸ้‡‘้กใ‚’่กจ็คบใ™ใ‚‹ - ๅฝฑ้Ÿฟใ‚’ๅ—ใ‘ใ‚‹ใƒ•ใ‚ฃใƒผใƒซใƒ‰: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/recommendations/products": { + "get": { + "summary": "get recommended products", + "operationId": "getRecommendedProducts", + "tags": [ + "recommendation" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "- recommended products - ใ‚ฏใ‚คใƒผใƒณใ‚คใƒƒใƒˆๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸๅ ดๅˆใ€`ProductDto`ใงๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸ้‡‘้กใ‚’่กจ็คบใ™ใ‚‹ - ๅฝฑ้Ÿฟใ‚’ๅ—ใ‘ใ‚‹ใƒ•ใ‚ฃใƒผใƒซใƒ‰: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/tag-groups": { + "get": { + "parameters": [ + { + "in": "query", + "name": "type", + "required": true, + "schema": { + "$ref": "#/components/schemas/TagTypeEnum" + } + } + ], + "summary": "get tag-groups by type", + "description": "ใƒ‘ใƒฉใƒกใƒผใ‚ฟใซๅฟœใ˜ใŸใ‚ฟใ‚ฐใ‚ฐใƒซใƒผใƒ—ๆƒ…ๅ ฑใ‚’ๅ–ๅพ—ใ—ใพใ™", + "operationId": "getTagGroups", + "tags": [ + "tag" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ใ‚ฟใ‚ฐใ‚ฐใƒซใƒผใƒ—ใƒชใ‚นใƒˆ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagGroupListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/tags": { + "get": { + "parameters": [ + { + "in": "query", + "name": "type", + "required": false, + "schema": { + "$ref": "#/components/schemas/TagTypeEnum" + } + }, + { + "in": "query", + "name": "groupId", + "required": false, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "summary": "get tags", + "description": "ใ‚ฟใ‚ฐๆƒ…ๅ ฑใ‚’ๅ–ๅพ—.", + "operationId": "getTags", + "tags": [ + "tag" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ๆกไปถใซๅฟœใ˜ใŸใ‚ฟใ‚ฐๆƒ…ๅ ฑใ‚’ๅ–ๅพ—ใ—ใพใ™.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/release-estimate": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product estimate release at", + "operationId": "getProductEstimateRelease", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product estimate release๏ผˆๅ•†ๅ“ไบˆๆƒณๅ‡บ่ทๆ—ฅ๏ผ‰็…งไผšๆˆๅŠŸ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReleaseEstimateDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/products/{productId}/page": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "upload product page", + "operationId": "uploadProductPage", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UploadProductPageRequest" + } + } + } + }, + "responses": { + "200": { + "description": "success to upload" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/products/{productId}": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product", + "operationId": "getProduct", + "description": "๏ผˆ can't find product -> ApiErrorResponseCode.RESOURCE_NOT_FOUND ๏ผ‰", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- product - ใ‚ฏใ‚คใƒผใƒณใ‚คใƒƒใƒˆๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸๅ ดๅˆใ€`ProductDto`ใงๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸ้‡‘้กใ‚’่กจ็คบใ™ใ‚‹ - ๅฝฑ้Ÿฟใ‚’ๅ—ใ‘ใ‚‹ใƒ•ใ‚ฃใƒผใƒซใƒ‰: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/products/{productId}/personal": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get personal product", + "description": "๏ผˆ can't find product -> ApiErrorResponseCode.RESOURCE_NOT_FOUND ๏ผ‰", + "operationId": "getPersonalProduct", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- ใ‚ฏใ‚คใƒผใƒณใ‚คใƒƒใƒˆๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸๅ ดๅˆใ€`ProductDto`ใงใ™ใใซๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸ้‡‘้กใ‚’่กจ็คบใ™ใ‚‹ - ๅฝฑ้Ÿฟใ‚’ๅ—ใ‘ใ‚‹ใƒ•ใ‚ฃใƒผใƒซใƒ‰: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PersonalProductDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/products/{productId}/items": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product items", + "operationId": "getProductItems", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product items๏ผˆๅ•†ๅ“ใ‚ชใƒ—ใ‚ทใƒงใƒณ๏ผ‰ใƒชใ‚นใƒˆใฎๆคœ็ดขใซๆˆๅŠŸ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductItemListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/products/{productId}/item-availabilities": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product item availability list", + "description": "่ฉฒๅฝ“ใ™ใ‚‹ๅ•†ๅ“ใฎๅ•†ๅ“ใ‚ชใƒ—ใ‚ทใƒงใƒณใฎ่ณผๅ…ฅๅฏ่ƒฝๆ€งใฎใƒชใ‚นใƒˆใ‚’่ฟ”ใ—ใพใ™ใ€‚", + "operationId": "getProductItemAvailabilityList", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ๅ•†ๅ“ใ‚ชใƒ—ใ‚ทใƒงใƒณใฎ่ณผๅ…ฅๅฏ่ƒฝๆ€งใฎใƒชใ‚นใƒˆ", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductItemAvailabilityDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/users/birth-year": { + "post": { + "summary": "save of birth year for user", + "description": "save of birth year in user profile", + "operationId": "saveUserBirthYear", + "tags": [ + "userProfile" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserBirthYearDto" + } + } + } + }, + "responses": { + "200": { + "description": "saved birth year of user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserBirthYearDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/users/body-size": { + "post": { + "summary": "save of body size for user", + "description": "save of body size", + "operationId": "saveUserBodySize", + "tags": [ + "userProfile" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserBodySizeDataDto" + } + } + } + }, + "responses": { + "200": { + "description": "saved body size of user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserBodySizeDataDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/users/profile": { + "get": { + "summary": "get user profile", + "description": "๏ผˆ can't find user profile -> ApiErrorResponseCode.RESOURCE_NOT_FOUND ๏ผ‰", + "operationId": "getUserProfile", + "tags": [ + "userProfile" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "user profile", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserProfileDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/users/delivery-addresses": { + "get": { + "summary": "get user delivery addresses", + "description": "ใƒฆใƒผใ‚ถใƒผใฎๅฎŒๅ…จใช้…้€ๅ…ˆใƒชใ‚นใƒˆใ‚’ๅ–ๅพ—ใ—ใพใ™(`retrievedAt`ใฎ้ †ใซไธฆในๆ›ฟใˆใ‚‰ใ‚Œใพใ™)", + "operationId": "getUserDeliveryAddresses", + "tags": [ + "userProfile" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "user delivery address list", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserDeliveryAddressDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + }, + "put": { + "summary": "add user delivery address", + "description": "- ใƒฆใƒผใ‚ถใƒผใฎ้…้€ๅ…ˆๆƒ…ๅ ฑใ‚’่ฟฝๅŠ ใ™ใ‚‹ใ‹ใ€ `retrievedAt`ใ‚’ๆ›ดๆ–ฐใ—ใพใ™ - ็™ป้Œฒใ•ใ‚Œใฆใ„ใ‚‹้…้€ๅ…ˆใƒชใ‚นใƒˆใฎใ†ใกใ€ไฝๆ‰€ใจ้…้€ใƒชใ‚ฏใ‚จใ‚นใƒˆใŒๅŒใ˜ๅ ดๅˆใซใฎใฟๆ›ดๆ–ฐใ—ใพใ™", + "operationId": "addUserDeliveryAddress", + "tags": [ + "userProfile" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserDeliveryAddressAddRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to add user delivery address", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserDeliveryAddressDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/tier": { + "get": { + "summary": "get user's tier", + "operationId": "getTier", + "tags": [ + "tier" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "get user's tier", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TierDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/tier/next": { + "get": { + "summary": "get user's next tier information", + "operationId": "getNextTierInfo", + "tags": [ + "tier" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "get user's next tier information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NextTierInfoDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/images/{imageCategory}/uploadable-url": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "imageCategory", + "schema": { + "$ref": "#/components/schemas/ImageCategoryEnum" + } + }, + { + "in": "query", + "required": true, + "name": "filename", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "generate uploadable url to upload images for login user", + "operationId": "generateImageUploadableUrl", + "tags": [ + "image" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "uploadable image url", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UploadableImageResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "imageCategory", + "schema": { + "$ref": "#/components/schemas/ImageCategoryEnum" + } + }, + { + "in": "query", + "required": true, + "name": "filename", + "schema": { + "type": "string" + } + } + ] + } + }, + "/images/{imageCategory}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "imageCategory", + "schema": { + "$ref": "#/components/schemas/ImageCategoryEnum" + } + } + ], + "post": { + "deprecated": true, + "description": "(deprecated) please use generateImageUploadableUrl instead of this api", + "summary": "upload images for login user", + "operationId": "uploadImage", + "tags": [ + "image" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "required": [ + "image" + ], + "properties": { + "image": { + "type": "string", + "format": "binary" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "upload image", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UploadImageResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "imageCategory", + "schema": { + "$ref": "#/components/schemas/ImageCategoryEnum" + } + } + ] + } + }, + "/images/{imageCategory}/base64": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "imageCategory", + "schema": { + "$ref": "#/components/schemas/ImageCategoryEnum" + } + } + ], + "post": { + "summary": "upload images as base 64 for login user", + "operationId": "uploadImageBase64", + "tags": [ + "image" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Base64ImageUploadRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "upload image as base64", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UploadImageResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "imageCategory", + "schema": { + "$ref": "#/components/schemas/ImageCategoryEnum" + } + } + ] + } + }, + "/products/{productId}/reviews": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product reviews", + "operationId": "getProductReviews", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "product reviews", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DisplayProductReviewListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/reviews/v2": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product reviews v2", + "operationId": "findProductReviews", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "page", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "required": false, + "name": "sortOrder", + "schema": { + "$ref": "#/components/schemas/ProductReviewSortOrderEnum" + } + } + ], + "responses": { + "200": { + "description": "product reviews", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DisplayProductReviewListDtoV2" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/reviews/representatives": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get representative product reviews", + "operationId": "getRepresentativeProductReviews", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "representative product reviews", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RepresentativeProductReviewListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/reviews/{reviewId}": { + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "put": { + "summary": "update product review", + "description": "ๆœฌไบบใฎๅ•†ๅ“่ฉ•ไพกใ‚’ไฟฎๆญฃใ—ใพใ™ใ€‚ - RESOURCE_NOT_FOUND๏ผšreviewIdใซๅฏพๅฟœใ™ใ‚‹่ฉ•ไพกใŒ่ฆ‹ใคใ‹ใ‚‰ใชใ„ๅ ดๅˆ - ACCESS_DENIED๏ผšไป–ไบบใฎ่ฉ•ไพกใ‚’็ทจ้›†ใ—ใ‚ˆใ†ใจใ—ใŸใจใ", + "operationId": "updateProductReview", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateProductReviewRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "updated product review", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReviewDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ] + } + }, + "/products/items/{productItemId}/review": { + "parameters": [ + { + "in": "path", + "name": "productItemId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "orderLineId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "create product review", + "operationId": "createProductReview", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReviewDataDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to create product review", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReviewDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productItemId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "orderLineId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/reviews/{reviewId}": { + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "get": { + "summary": "get product review", + "operationId": "getProductReview", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product review", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DisplayProductReviewDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ] + }, + "delete": { + "summary": "delete product review", + "operationId": "deleteProductReview", + "description": "ๆœฌไบบใฎๅ•†ๅ“่ฉ•ไพกใ‚’ๅ‰Š้™คใ—ใพใ™ใ€‚ - RESOURCE_NOT_FOUND๏ผšreviewIdใซๅฏพๅฟœใ™ใ‚‹่ฉ•ไพกใŒ่ฆ‹ใคใ‹ใ‚‰ใชใ„ๅ ดๅˆ - ACCESS_DENIED๏ผšไป–ไบบใฎ่ฉ•ไพกใ‚’็ทจ้›†ใ—ใ‚ˆใ†ใจใ—ใŸใจใ", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to delete product review" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ] + } + }, + "/reviews/{reviewId}/favorites": { + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "post": { + "summary": "favorites product review", + "operationId": "favoritesProductReview", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "204": { + "description": "success to favorites product review" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ] + }, + "delete": { + "summary": "delete favorites product review", + "operationId": "deleteFavoritesProductReview", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to delete favorites product review" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ] + } + }, + "/user/reviews": { + "get": { + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "summary": "get created product reviews of user", + "operationId": "getMyProductReviews", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "created product reviews of user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MyProductReviewListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/user/review-candidates": { + "get": { + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "summary": "get created product reviews of user", + "operationId": "getMyProductReviewCandidates", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product review candidates", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReviewCandidateListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/user/reviews/creatable-count": { + "get": { + "summary": "get count creatable product review of user", + "operationId": "countCreatableProductReviewOfUser", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "number of creatable product review of user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LongDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/user/reviews/created-count": { + "get": { + "summary": "get count created product review of user", + "operationId": "countCreatedProductReviewOfUser", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "number of created product review of user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LongDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/user/reviews/exist": { + "get": { + "summary": "check user's review exist", + "operationId": "checkExistProductReviewOfUser", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "flag of does user created review before", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RequiredBooleanDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/user/reviews/accumulable-point": { + "get": { + "summary": "get user's accumulable point amount of review creation", + "operationId": "getAccumulablePointProductReviewCreationOfUser", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "accumulable point amount of when user created total creatable review", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RequiredLongDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/reviews/statistics/summary": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product review statistics summary", + "operationId": "getProductReviewStatisticsSummary", + "tags": [ + "reviewStatistics" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product review statistics summary", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReviewStatisticsSummaryDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/products/{productId}/reviews/statistics/size": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product review size statistics", + "operationId": "getProductSizeStatistics", + "tags": [ + "reviewStatistics" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product review size statistics", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductSizeStatisticsDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/products/{productId}/reviews/statistics/brightness": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product review brightness statistics", + "operationId": "getProductBrightnessStatistics", + "tags": [ + "reviewStatistics" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product review brightness statistics", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductBrightnessStatisticsDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/products/{productId}/reviews/statistics/color-sense": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product review color-sense statistics", + "operationId": "getProductColorSenseStatistics", + "tags": [ + "reviewStatistics" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product review color-sense statistics", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductColorSenseStatisticsDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/products/{productId}/reviews/statistics/thickness": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get product review thickness statistics", + "operationId": "getProductThicknessStatistics", + "tags": [ + "reviewStatistics" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product review thickness statistics", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductThicknessStatisticsDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/categories/{categoryId}/attributes": { + "parameters": [ + { + "in": "path", + "name": "categoryId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get category's attributes", + "operationId": "getProductCategoryAttributes", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product category attributes", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductCategoryReviewAttributeDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "categoryId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/reviews/{reviewId}/reports": { + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "post": { + "summary": "report product review", + "description": "(can't report twice -> ApiErrorResponseCode.REVIEW_REPORTED_TWICE) (reporter uid and review uid can't be same -> ApiErrorResponseCode.REVIEW_REPORTED_BY_SELF)", + "operationId": "reportProductReview", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to report product review" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "reviewId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ] + } + }, + "/home/categories": { + "get": { + "summary": "get product categories in home screen", + "operationId": "getHomeProductCategories", + "tags": [ + "home" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product categories in home screen", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HomeProductCategoryDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/app/categories": { + "get": { + "summary": "get all categories with displaying products", + "operationId": "getDisplayingCategories", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "return all categories with displaying products", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/categories": { + "get": { + "summary": "get top product categories", + "operationId": "getTopProductCategories", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "query", + "required": false, + "name": "withAllCategory", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "product categories", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/categories/{categoryId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get inner product categories", + "operationId": "getInnerProductCategories", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "inner product categories", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/categories/{categoryId}/products": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get categorized products", + "operationId": "getCategorizedProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "categoryId", + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "- categorized products - ใ‚ฏใ‚คใƒผใƒณใ‚คใƒƒใƒˆๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚Œใ‚‹ๅ ดๅˆใ€`ProductDto`ใงๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸ้‡‘้กใ‚’่กจ็คบใ™ใ‚‹ - ๅฝฑ้Ÿฟใ‚’ๅ—ใ‘ใ‚‹ใƒ•ใ‚ฃใƒผใƒซใƒ‰: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/age-group-filters": { + "get": { + "summary": "get all filters of age group.", + "operationId": "getAgeGroupFilters", + "tags": [ + "ageGroup" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "all age group filters", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AgeGroupFilterListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/brands": { + "get": { + "parameters": [ + { + "in": "query", + "required": false, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ], + "summary": "get all brands", + "operationId": "getAllBrands", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "brands", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BrandDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/brands/{brandId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "brandId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get brand detail", + "description": "๏ผˆ can't find brand -> ApiErrorResponseCode.RESOURCE_NOT_FOUND ๏ผ‰", + "operationId": "getBrandDetail", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ใƒ–ใƒฉใƒณใƒ‰ใฎ่ฉณ็ดฐ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BrandDetailDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "brandId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/brands/{brandId}/categories": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "brandId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get brand categories", + "operationId": "getBrandCategories", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ใƒ–ใƒฉใƒณใƒ‰ใ‚ซใƒ†ใ‚ดใƒช", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "brandId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/brands/{brandId}/categories/{categoryId}/products": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "brandId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get categorized brand products", + "operationId": "getBrandProducts", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "brandId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "categoryId", + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "- categorized products - ใ‚ฏใ‚คใƒผใƒณใ‚คใƒƒใƒˆๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚Œใ‚‹ๅ ดๅˆใ€`ProductDto`ใงๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸ้‡‘้กใ‚’่กจ็คบใ™ใ‚‹ - ๅฝฑ้Ÿฟใ‚’ๅ—ใ‘ใ‚‹ใƒ•ใ‚ฃใƒผใƒซใƒ‰: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/carts": { + "post": { + "summary": "add to cart", + "operationId": "addToCart", + "tags": [ + "cart" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AddToCartRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to add to cart", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AddToCartResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + }, + "get": { + "summary": "get cart items", + "operationId": "getCartItems", + "tags": [ + "cart" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- cart items - ใ‚ฏใ‚คใƒผใƒณใ‚คใƒƒใƒˆๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸๅ ดๅˆใ€`ProductDto`ใงใ™ใใซๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸ้‡‘้กใ‚’่กจ็คบใ™ใ‚‹ - ๅฝฑ้Ÿฟใ‚’ๅ—ใ‘ใ‚‹ใƒ•ใ‚ฃใƒผใƒซใƒ‰: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartItemGroupDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/carts/{cartItemId}": { + "delete": { + "summary": "delete cart item", + "operationId": "deleteCartItem", + "tags": [ + "cart" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "cartItemId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "success to delete cart item" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/carts/delete": { + "post": { + "summary": "delete cart items", + "operationId": "deleteCartItems", + "tags": [ + "cart" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteCartItemsRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to delete cart items" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/carts/rearrange": { + "post": { + "summary": "rearrange cart items for quantity constraint", + "operationId": "rearrangeCartItems", + "tags": [ + "cart" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- polish cart items - ใ‚ฏใ‚คใƒผใƒณใ‚คใƒƒใƒˆๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸๅ ดๅˆใ€`ProductDto`ใงๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸ้‡‘้กใ‚’่กจ็คบใ™ใ‚‹ - ๅฝฑ้Ÿฟใ‚’ๅ—ใ‘ใ‚‹ใƒ•ใ‚ฃใƒผใƒซใƒ‰: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartItemGroupDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/carts/{cartItemId}/quantity/{quantity}": { + "post": { + "summary": "update cart item quantity", + "operationId": "updateCartItemQuantity", + "tags": [ + "cart" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "cartItemId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "path", + "name": "quantity", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "success to update cart item quantity" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/orders": { + "get": { + "summary": "get my order histories", + "operationId": "getMyOrders", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "order detail", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MyOrderHistoryListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + }, + "post": { + "summary": "start order for cart items", + "description": "๏ผˆ count of order line to order exceeds limit -> ApiErrorResponseCode.ORDER_LINE_COUNT_LIMIT_PER_ORDER_EXCEEDED ๏ผ‰ ( order unavailable product item exists -> ApiErrorResponseCode.ORDER_UNAVAILABLE_PRODUCT_ITEM )", + "operationId": "startOrder", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StartOrderRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "product purchase material", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductPurchaseMaterialDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + }, + "put": { + "summary": "start order with adding cart items", + "description": "๏ผˆ count of order line to order exceeds limit -> ApiErrorResponseCode.ORDER_LINE_COUNT_LIMIT_PER_ORDER_EXCEEDED ๏ผ‰ ( order unavailable product item exists -> ApiErrorResponseCode.ORDER_UNAVAILABLE_PRODUCT_ITEM )", + "operationId": "startOrderFromAdding", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StartOrderFromAddingRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "product purchase material", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductPurchaseMaterialDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/orders/wait-for-deposit/exist": { + "get": { + "summary": "whether exist order of waiting for deposit", + "operationId": "existOrdersOfWaitingForDeposit", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "whether exist", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BooleanDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/orders/{orderId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get order history", + "description": "๏ผˆ can't find order -> ApiErrorResponseCode.RESOURCE_NOT_FOUND ๏ผ‰", + "operationId": "getMyOrder", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "order detail", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MyOrderHistoryDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ] + }, + "delete": { + "summary": "abort order", + "description": "๏ผˆ can't find order -> ApiErrorResponseCode.RESOURCE_NOT_FOUND ๏ผ‰", + "operationId": "abortOrderById", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "required": false, + "name": "restoreCartItems", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "result order data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/orders/{orderId}/purchase-material": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get order purchase material", + "description": "ใƒชใƒ•ใƒฌใƒƒใ‚ทใƒฅใพใŸใฏใƒใƒƒใƒˆใƒฏใƒผใ‚ฏใฎ็ด›ๅคฑใซๅ‚™ใˆใฆใ€ใ€ŒๆฑบๆธˆๅฎŒไบ†ๅ‰ๆณจๆ–‡ใ€ใฎๆฑบๆธˆๆƒ…ๅ ฑ๏ผˆใ€ŒpurchaseMaterialใ€๏ผ‰ใ‚’ๅ†ใ‚คใƒณใƒใƒผใƒˆใ™ใ‚‹API", + "operationId": "getOrderPurchaseMaterial", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product purchase material", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductPurchaseMaterialDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/{orderId}/lines/{orderLineId}/confirm-receipt": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "orderLineId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "confirm order line receipt", + "description": "- orderlineใซใคใ„ใฆ่ณผๅ…ฅ็ขบๅฎš้€ฒ่กŒ - ้…้€ๅฎŒไบ†็Šถๆ…‹ใงใฎใฟ็ขบๅฎšๅฏ่ƒฝ่ฆๆฑ‚ใ•ใ‚ŒใŸ) / `CONFIRMED` (ๆ‰ฟ่ชๆธˆใฟ) ็Šถๆ…‹ใฎ OLC/OLR ใƒใ‚ฑใƒƒใƒˆใŒๅญ˜ๅœจใ™ใ‚‹ๅ ดๅˆ -> ใพใ ๅ‡ฆ็†ใ•ใ‚Œใฆใ„ใชใ„ OLC/OLR ใƒใ‚ฑใƒƒใƒˆใŒๅญ˜ๅœจใ™ใ‚‹ๅ ดๅˆ - `CAN_ONLY_CONFIRM_RECEIPT_OF_PAID_ORDER_LINE (7002)`ไธญใฎๆณจๆ–‡ใƒฉใ‚คใƒณใฏ่ณผๅ…ฅ็ขบๅฎšใŒไธๅฏ่ƒฝ - CANNOT_CONFIRM_RECEIPT_WHEN_DELIVERY_NOT_COMPLETE๏ผˆ7003๏ผ‰", + "operationId": "confirmOrderLineReceipt", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to confirm receipt" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "orderLineId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/purchases/{purchaseId}/point": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "apply point", + "description": "( can't find order -> ApiErrorResponseCode.RESOURCE_NOT_FOUND ) ( can't apply point -> ApiErrorResponseCode.POINT_NOT_CONSUMABLE ) ( lack of point -> ApiErrorResponseCode.LACK_OF_POINT )", + "operationId": "applyPointForOrder", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplyPointRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to save", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplyPointResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/purchases/{purchaseId}/coupons/v2": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "delete": { + "summary": "ใƒชใƒชใƒผใ‚นใ‚ฏใƒผใƒใƒณ", + "description": "๏ผˆ can't find order -> ApiErrorResponseCode.RESOURCE_NOT_FOUND ๏ผ‰", + "operationId": "releaseCouponOfOrderV2", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to release", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReleaseCouponResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + }, + "post": { + "summary": "apply coupon", + "description": "( can't find order, issued coupon -> ApiErrorResponseCode.RESOURCE_NOT_FOUND ) ( can't apply coupon -> ApiErrorResponseCode.COUPON_NOT_CONSUMABLE )", + "operationId": "applyCouponToOrderV2", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplyCouponRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to save", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplyCouponResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/purchases/{purchaseId}/delivery": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "save delivery request", + "description": "๏ผˆ can't find order -> ApiErrorResponseCode.RESOURCE_NOT_FOUND ๏ผ‰", + "operationId": "saveDeliveryRequest", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeliveryRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to update delivery request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderSummaryDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/{orderId}/delivery-request": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ], + "put": { + "summary": "update delivery request before delivery", + "description": "- ๅ‡บ่ทๅ‰ใฎๆณจๆ–‡ใฎ้…้€ๅ…ˆใ‚’ๅค‰ๆ›ดใ—ใพใ™ - ็™บ็”Ÿใ™ใ‚‹ๅฏ่ƒฝๆ€งใฎใ‚ใ‚‹ใ‚จใƒฉใƒผใ‚ฟใ‚คใƒ— - `ApiErrorResponseCode.INVALID_VALUE` - ใใฎๆณจๆ–‡ใซcancel / return ticket stateใŒ `SUBMITTED`ใ€ `CONFIRMED`็Šถๆ…‹ใฎใƒใ‚ฑใƒƒใƒˆใŒๅญ˜ๅœจใ™ใ‚‹ๅ ดๅˆ - ๆ”ฏๆ‰•ใ„ใฏๅฎŒไบ†ใ—ใพใ›ใ‚“ๅนฝ้œŠๅ‘ชๆ–‡ใฎๅ ดๅˆ - `ApiErrorResponseCode.RESOURCE_NOT_FOUND` - ๅ‘ชๆ–‡ใŒๅญ˜ๅœจใ—ใชใ„ๅ ดๅˆ - `ApiErrorResponseCode.ORDER_ALREADY_DISPATCHED`้…้€ๅ…ˆใจใฏ็•ฐใชใ‚‹้…้€ๅœฐๅŸŸ๏ผˆex. ๅŸบๆœฌ้…้€ๅ…ˆ - >ๆ›ธ็ฑ้–“ใฎ้…้€ๅ…ˆ๏ผ‰ใซ้…้€ๅ…ˆใ‚’ๅค‰ๆ›ดใ—ใ‚ˆใ†ใจใ—ใŸๅ ดๅˆ", + "operationId": "updateDeliveryRequestBeforeDelivery", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeliveryRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to update delivery request" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/purchases/{purchaseId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get order history by purchase", + "description": "๏ผˆ can't find order -> ApiErrorResponseCode.RESOURCE_NOT_FOUND ๏ผ‰", + "operationId": "getMyOrderByPurchase", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "order detail", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + }, + "delete": { + "summary": "abort order", + "description": "๏ผˆ can't find order -> ApiErrorResponseCode.RESOURCE_NOT_FOUND ๏ผ‰", + "operationId": "abortOrder", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "required": false, + "name": "restoreCartItems", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "success to abort" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + }, + "post": { + "summary": "complete order", + "description": "๏ผˆ can't find order -> ApiErrorResponseCode.RESOURCE_NOT_FOUND ๏ผ‰", + "operationId": "completeOrder", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to complete", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/order-line-tickets": { + "get": { + "summary": "get order line ticket history", + "operationId": "getOrderLineTickets", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "query", + "name": "ticket", + "schema": { + "$ref": "#/components/schemas/OrderLineTicketEnum" + } + }, + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "list order line tickets (return or cancel)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MyOrderLineTicketListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/order-line-tickets/count/summary": { + "get": { + "summary": "ใƒฆใƒผใ‚ถใƒผใฎ้€ฒ่กŒไธญ๏ผˆใพใŸใฏๆœ€่ฟ‘ๅฎŒไบ†ใ—ใŸ๏ผ‰ใงใ‚ใ‚‹่ฟ”ๅ“/ใ‚ญใƒฃใƒณใ‚ปใƒซใƒใ‚ฑใƒƒใƒˆใ‚’้›†่จˆใ—ใพใ™๏ผˆMyใƒšใƒผใ‚ธ่กจ็คบ็”จ๏ผ‰", + "operationId": "getOrderLineTicketsCountSummary", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "count OLใƒใ‚ฑใƒƒใƒˆใ€‚ (return or cancel)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MyOLTicketsCountDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/prompts/creatable-review-prompt": { + "get": { + "summary": "get creatable review prompt with order line", + "operationId": "getCreatableReviewPrompt", + "tags": [ + "prompt" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "creatable review prompt", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreatableReviewPromptDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/refund-account": { + "get": { + "summary": "get user refund account", + "operationId": "getUserRefundAccount", + "tags": [ + "account" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "refund account of user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserRefundAccountDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + }, + "post": { + "summary": "save refund account", + "operationId": "saveRefundAccount", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RefundAccountDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to save" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/orders/{orderId}/lines/cancel": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ], + "put": { + "summary": "cancel order item", + "description": "- ็™บ็”Ÿใ™ใ‚‹ๅฏ่ƒฝๆ€งใฎใ‚ใ‚‹ใ‚จใƒฉใƒผ - ใ€ŒCANNOT_REQUEST_REFUND_AFTER_CONFIRM_RECEIPT (7004)ใ€", + "operationId": "requestToCancelOrderItem", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OLCRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "order history with created cancel ticket", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/{orderId}/lines/cancel/v2": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "estimate order item cancellation", + "operationId": "estimateOrderItemCancellationV2", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartialOrderItemDto" + } + } + } + } + }, + "responses": { + "200": { + "description": "estimation result", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OLCEstimationResultDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/{orderId}/lines/cancel/{ticketId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "ticketId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get order item cancel ticket detail", + "operationId": "getOrderItemCancelTicket", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "cancel ticket response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderLineCancelTicketWithOrderDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "ticketId", + "schema": { + "type": "string" + } + } + ] + }, + "delete": { + "summary": "withdraw order item cancellation", + "operationId": "withdrawOrderItemCancelTicket", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "order history with withdrawn ticket", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "ticketId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/{orderId}/lines/return": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ], + "put": { + "summary": "return order item", + "description": "- ็™บ็”Ÿใ™ใ‚‹ๅฏ่ƒฝๆ€งใฎใ‚ใ‚‹ใ‚จใƒฉใƒผ - ใ€ŒCANNOT_REQUEST_REFUND_AFTER_CONFIRM_RECEIPT๏ผˆ7004๏ผ‰ใ€ imageUrlsใฎitemใŒ3ใคใ‚’่ถ…ใˆใ‚‹ๅ ดๅˆ", + "operationId": "requestToReturnOrderItem", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OLRRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "order history with created return ticket", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/{orderId}/lines/return/v2": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "estimate order item returning", + "operationId": "estimateOrderItemReturningV2", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OLREstimateRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "estimation result", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OLREstimationResultDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/orders/{orderId}/lines/return/{ticketId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "ticketId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get order item return ticket detail", + "operationId": "getOrderItemReturnTicket", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "return ticket response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderLineReturnTicketWithOrderDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "ticketId", + "schema": { + "type": "string" + } + } + ] + }, + "delete": { + "summary": "withdraw order item returning", + "operationId": "withdrawOrderItemReturnTicket", + "tags": [ + "order" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "order history with withdrawn ticket", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "orderId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "ticketId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/purchases/{topic}/{purchaseId}/payments/iamport": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "start iamport payment for specific purchase", + "description": "๏ผˆ can't find purchase -> ApiErrorResponseCode.RESOURCE_NOT_FOUND ๏ผ‰", + "operationId": "startIamportPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StartIamportPaymentRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "iamport payment material", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IamportPaymentMaterialDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/purchases/{topic}/{purchaseId}/payments/iamport/merchantIds/{merchantId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "finish iamport payment process", + "description": "๏ผˆ paid amount does not match -> ApiErrorResponseCode.PAYMENT_NOT_FULLY_PAID ๏ผ‰", + "operationId": "finishIamportPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to process" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ] + }, + "delete": { + "summary": "abandon iamport payment", + "description": "๏ผˆ can't find purchase -> ApiErrorResponseCode.RESOURCE_NOT_FOUND ๏ผ‰", + "operationId": "abandonIamportPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to process" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/purchases/{topic}/{purchaseId}/payments/toss": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "start toss payment for specific purchase", + "description": "๏ผˆ can't find purchase -> ApiErrorResponseCode.RESOURCE_NOT_FOUND ๏ผ‰", + "operationId": "startTossPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StartTossPaymentRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "toss payment material", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TossPaymentMaterialDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/purchases/{topic}/{purchaseId}/payments/toss/merchantIds/{merchantId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "finish toss payment process", + "description": "๏ผˆ paid amount does not match -> ApiErrorResponseCode.PAYMENT_NOT_FULLY_PAID ๏ผ‰", + "operationId": "finishTossPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to process" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ] + }, + "delete": { + "summary": "abandon toss payment", + "description": "๏ผˆ can't find purchase -> ApiErrorResponseCode.RESOURCE_NOT_FOUND ๏ผ‰", + "operationId": "abandonTossPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to process" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/purchases/{topic}/{purchaseId}/payments/connect-pay": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "start connect-pay payment for specific purchase", + "description": "๏ผˆ can't find purchase -> ApiErrorResponseCode.RESOURCE_NOT_FOUND ๏ผ‰", + "operationId": "startConnectPayPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StartConnectPayPaymentRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "connect-pay payment material", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectPayPaymentMaterialDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/purchases/{topic}/{purchaseId}/payments/connect-pay/merchantIds/{merchantId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "finish connect-pay payment process", + "description": "๏ผˆ paid amount does not match -> ApiErrorResponseCode.PAYMENT_NOT_FULLY_PAID ๏ผ‰", + "operationId": "finishConnectPayPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to process" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ] + }, + "delete": { + "summary": "abandon connect-pay payment", + "description": "๏ผˆ can't find purchase -> ApiErrorResponseCode.RESOURCE_NOT_FOUND ๏ผ‰", + "operationId": "abandonConnectPayPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to process" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/purchases/{topic}/{purchaseId}/payments/dry": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "start dry-run payment for specific purchase", + "description": "๏ผˆ can't find purchase -> ApiErrorResponseCode.RESOURCE_NOT_FOUND ๏ผ‰", + "operationId": "startDryRunPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "dry run payment material", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DryRunPaymentMaterialDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/purchases/{topic}/{purchaseId}/payments/dry/merchantIds/{merchantId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "finish dry-run payment process", + "operationId": "finishDryRunPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to process" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ] + }, + "delete": { + "summary": "abandon dry-run payment", + "description": "๏ผˆ can't find purchase -> ApiErrorResponseCode.RESOURCE_NOT_FOUND ๏ผ‰", + "operationId": "abandonDryRunPayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to process" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "required": true, + "name": "merchantId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/purchases/{topic}/{purchaseId}/payments/free": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "start free payment for specific purchase", + "description": "๏ผˆ can't find purchase -> ApiErrorResponseCode.RESOURCE_NOT_FOUND ๏ผ‰", + "operationId": "startFreePayment", + "tags": [ + "payment" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to process" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "topic", + "schema": { + "$ref": "#/components/schemas/PurchaseTopicEnum" + } + }, + { + "in": "path", + "required": true, + "name": "purchaseId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/banners/types/{bannerType}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "bannerType", + "schema": { + "$ref": "#/components/schemas/BannerTypeEnum" + } + } + ], + "get": { + "summary": "get banners", + "operationId": "getBanners", + "tags": [ + "banner" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ใƒใƒŠใƒผใƒชใ‚นใƒˆ", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BannerDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "bannerType", + "schema": { + "$ref": "#/components/schemas/BannerTypeEnum" + } + } + ] + } + }, + "/banners/category/{categoryId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get banners for category", + "operationId": "getCategoryBanners", + "tags": [ + "banner" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ใƒใƒŠใƒผใƒชใ‚นใƒˆ", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BannerDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "categoryId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/banners/brand-promotion": { + "get": { + "summary": "get banners for brand-promotion", + "operationId": "getBrandPromotionBanners", + "parameters": [ + { + "in": "query", + "required": false, + "name": "brandSourcingTagIdOfPromotedChannelGroup", + "description": "่ณผ่ฒทใƒใƒฃใƒณใƒใƒซ้คจใ‚ฐใƒซใƒผใƒ—ใซๅฏพๅฟœใ™ใ‚‹ใƒ–ใƒฉใƒณใƒ‰ใ‚ฝใƒผใ‚ทใƒณใ‚ฐใ‚ฟใ‚ฐใฎid", + "schema": { + "type": "string" + } + } + ], + "tags": [ + "banner" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ใƒใƒŠใƒผใƒชใ‚นใƒˆ", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BannerDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/banners/brand/{brandId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "brandId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get banner for brand", + "operationId": "getBrandBanners", + "tags": [ + "banner" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ใƒใƒŠใƒผใƒชใ‚นใƒˆ", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BannerDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "brandId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/collections/{collectionId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "collectionId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get collection", + "description": "๏ผˆ can't find collection -> ApiErrorResponseCode.RESOURCE_NOT_FOUND ๏ผ‰", + "operationId": "getCollection", + "tags": [ + "collection" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- collection - ใ‚ฏใ‚คใƒผใƒณใ‚คใƒƒใƒˆๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸๅ ดๅˆใ€`ProductDto`ใงใ™ใใซๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸ้‡‘้กใ‚’่กจ็คบใ™ใ‚‹ - ๅฝฑ้Ÿฟใ‚’ๅ—ใ‘ใ‚‹ใƒ•ใ‚ฃใƒผใƒซใƒ‰: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CollectionDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "collectionId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/search/products": { + "get": { + "summary": "search products", + "operationId": "searchProducts", + "tags": [ + "search" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "name": "keyword", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "description": "If orderBy is not given, orderBy would be set MATCHING_SCORE_DESC as a default value.", + "name": "orderBy", + "required": false, + "schema": { + "$ref": "#/components/schemas/ProductSearchingOrderByEnum" + } + }, + { + "in": "query", + "name": "categoryId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "categoryIds", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "name": "brandId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "brandIds", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "required": false, + "name": "minPrice", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "required": false, + "name": "maxPrice", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "query", + "description": "ใƒ•ใ‚ฃใƒซใ‚ฟใƒชใƒณใ‚ฐใ™ใ‚‹ๅ•†ๅ“ๅฑžๆ€งIDใฎใƒชใ‚นใƒˆ", + "required": false, + "name": "productFeatureIds", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "deprecated": true, + "required": false, + "description": "๏ผˆDEPRECATED๏ผ‰enabledTotalCountใ€enabledProductFeatureAggreagtionใ€enabledProductCategoryAggregationใ€enabledBrandAggregationใ‚’ไฝฟ็”จใ—ใฆใใ ใ•ใ„.", + "name": "enabledProductAggregation", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "ๅ•†ๅ“้›†่จˆใง็ทๆ•ฐใŒๅฟ…่ฆใชๅ ดๅˆใฏtrueใซ่จญๅฎšใ—ใพใ™ใ€‚.", + "name": "enabledTotalCount", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "ๅ•†ๅ“้›†่จˆใงๅ•†ๅ“ๅฑžๆ€งๅˆฅใฎๆ•ฐใŒๅฟ…่ฆใชๅ ดๅˆใฏtrueใซ่จญๅฎšใ—ใพใ™ใ€‚.", + "name": "enabledProductFeatureAggregation", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "ๅ•†ๅ“้›†่จˆใงๅ•†ๅ“ใ‚ซใƒ†ใ‚ดใƒชๅˆฅใฎๆ•ฐใŒๅฟ…่ฆใชๅ ดๅˆใฏtrueใซ่จญๅฎšใ—ใพใ™ใ€‚.", + "name": "enabledProductCategoryAggregation", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "ๅ•†ๅ“้›†่จˆ(aggregation)ใงใƒ–ใƒฉใƒณใƒ‰ๅˆฅๅ€‹ๆ•ฐใŒๅฟ…่ฆใชๅ ดๅˆใฏtrueใซ่จญๅฎšใ™ใ‚‹.", + "name": "enabledBrandAggregation", + "schema": { + "type": "boolean", + "default": false + } + }, + { + "in": "query", + "required": false, + "description": "ๆคœ็ดขใซ้–ข้€ฃใ™ใ‚‹็‰นๅฎšใฎๆฉŸ่ƒฝใ‚’้ฉ็”จใ™ใ‚‹้š›ใซๅฎŸ้จ“ใซๅฟ…่ฆใชใƒ•ใ‚ฃใƒผใƒซใƒ‰ใงใ™ใ€‚.", + "name": "keywordSearchExperimentIds", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "- searched products - ใ‚ฏใ‚คใƒผใƒณใ‚คใƒƒใƒˆๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸๅ ดๅˆใ€`AppProductDto`ใงๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸ้‡‘้กใ‚’่กจ็คบใ™ใ‚‹ - ๅฝฑ้Ÿฟใ‚’ๅ—ใ‘ใ‚‹ใƒ•ใ‚ฃใƒผใƒซใƒ‰: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/autocomplete": { + "get": { + "summary": "get autocomplete candidates", + "operationId": "getAutocompleteCandidates", + "tags": [ + "autocomplete" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "query", + "name": "query", + "required": true, + "schema": { + "type": "string" + }, + "description": "autocomplete query" + }, + { + "in": "query", + "name": "brandSize", + "required": true, + "schema": { + "type": "integer", + "format": "int32", + "default": 0 + }, + "description": "required brand autocomplete candidate size" + } + ], + "responses": { + "200": { + "description": "get autocomplete list", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AutocompleteResponseDto" + } + } + } + } + } + } + }, + "/couponBooks/{couponBookCode}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "couponBookCode", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get coupon book", + "description": "๏ผˆ can't find coupon book -> ApiErrorResponseCode.RESOURCE_NOT_FOUND ๏ผ‰", + "operationId": "getCouponBook", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ใ‚ฏใƒผใƒใƒณใƒ–ใƒƒใ‚ฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CouponBookDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "couponBookCode", + "schema": { + "type": "string" + } + } + ] + } + }, + "/couponBooks/{couponBookCode}/asset": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "couponBookCode", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get coupon book asset", + "description": "๏ผˆ can't find coupon book -> ApiErrorResponseCode.RESOURCE_NOT_FOUND ๏ผ‰", + "operationId": "getCouponBookAsset", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "coupon book asset", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CouponBookAssetDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "couponBookCode", + "schema": { + "type": "string" + } + } + ] + } + }, + "/couponBooks/{couponBookCode}/coupons": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "couponBookCode", + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "issue all coupons in coupon book", + "description": "( can't find coupon book -> ApiErrorResponseCode.RESOURCE_NOT_FOUND ) ( there are no coupons could be issued -> ApiErrorResponseCode.COUPON_BOOK_ISSUABLES_NOT_EXIST )", + "operationId": "issueAllCouponsInCouponBook", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "issued coupons by coupon book", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IssuedCouponDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "couponBookCode", + "schema": { + "type": "string" + } + } + ] + } + }, + "/coupons/displays/products/{productId}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "productId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get coupons by display product", + "operationId": "listDisplayingCouponsForProduct", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "get coupons by display product", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCouponDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "productId", + "schema": { + "type": "string" + } + } + ] + }, + "post": { + "summary": "issue all coupons by display product", + "operationId": "issueAllDisplayingCoupons", + "description": "๏ผˆ there are no display coupons to issue -> ApiErrorResponseCode.DISPLAYING_COUPONS_ISSUABLE_NOT_EXIST ๏ผ‰", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to issue", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IssuedCouponDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "productId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/coupons/displays/products/{productId}/v2": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "productId", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get coupons by display product v2", + "operationId": "listDisplayingCouponsForProductV2", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "get coupons by display product v2", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppCouponListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "productId", + "schema": { + "type": "string" + } + } + ] + } + }, + "/coupons/{couponCode}": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "couponCode", + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get coupon by coupon code", + "operationId": "getCouponByCode", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ใ‚ฏใƒผใƒใƒณ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CouponDetailDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "couponCode", + "schema": { + "type": "string" + } + } + ] + }, + "post": { + "summary": "issue coupon", + "description": "( cant find coupon -> ApiErrorResponseCode.RESOURCE_NOT_FOUND ) ( coupon is disabled -> ApiErrorResponseCode.COUPON_NOT_ENABLED ) ( before coupon issue begin date -> ApiErrorResponseCode.EGUP_ end date -> ApiErrorResponseCode.COUPON_ISSUE_AFTER_END ) ( exceed max coupon issue count -> ApiErrorResponseCode.COUPON_ISSUE_LIMIT_EXCEEDED ) ( exceed max coupon issue count per user -> ApiErrorResponseCode.COUPON_ISSUE_LIMIT_PER_USER_EXCEEDED ) _TARGET๏ผ‰", + "operationId": "issueCoupon", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to issue" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "couponCode", + "schema": { + "type": "string" + } + } + ] + } + }, + "/coupons": { + "get": { + "summary": "get my issued coupons", + "operationId": "getIssuedCoupons", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "issued coupons", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IssuedCouponDto" + } + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/coupons/first-kakao-login/issuable": { + "get": { + "summary": "check current user can issue first kakao login coupon", + "operationId": "checkFirstKakaoLoginCouponIssueable", + "tags": [ + "coupon" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "check first kakao login coupon is issuable with current user's phone number", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CheckFirstKakaoLoginCouponIssuableResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/shop-live/authorize": { + "post": { + "summary": "generate shop live token with username", + "operationId": "generateShopLiveAccessToken", + "tags": [ + "shopLive" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShopLiveTokenRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "success to generate shop live token", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShopLiveTokenResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/shop-live/campaigns/upcoming": { + "get": { + "parameters": [ + { + "in": "query", + "required": false, + "name": "includeOnAir", + "description": "็พๅœจ้€ฒ่กŒไธญใฎๆ”พ้€ๆƒ…ๅ ฑใŒใ‚ใ‚‹ๅ ดๅˆใฏใ€ใ“ใฎใ‚ญใƒฃใƒณใƒšใƒผใƒณใฎๆƒ…ๅ ฑใ‚’ๅ–ๅพ—ใ™ใ‚‹ใ‹ใฉใ†ใ‹ใ€‚ falseใฎๅ ดๅˆใ€็พๅœจไปฅ้™ใฎไบˆๅฎšใ•ใ‚ŒใŸๆ”พ้€ๆƒ…ๅ ฑใฎใฟใ‚’็…งไผš", + "schema": { + "type": "boolean" + } + }, + { + "in": "query", + "required": false, + "name": "includePrivate", + "description": "้›†ใ‚ใฆ้žๅ…ฌ้–‹ใซ่จญๅฎšใ—ใŸใ‚ญใƒฃใƒณใƒšใƒผใƒณใฎๆƒ…ๅ ฑใ‚‚่กจ็คบใ™ใ‚‹ใ‹ใฉใ†ใ‹", + "schema": { + "type": "boolean" + } + } + ], + "summary": "็พๅœจไปฅ้™ใฎๆœ€ใ‚‚่ฟ‘ใ„ๆ™‚้–“ใซไบˆๅฎšใ•ใ‚Œใฆใ„ใ‚‹ๆ”พ้€ใพใŸใฏ๏ผˆๆกไปถใซๅฟœใ˜ใฆ๏ผ‰็พๅœจ้€ฒ่กŒไธญใฎๆ”พ้€ใŒใ‚ใ‚‹ๅ ดๅˆใฏใ€ใใฎๆ”พ้€ใฎๆƒ…ๅ ฑใ‚’่ฟ”ใ—ใพใ™", + "operationId": "getUpcomingCampaign", + "tags": [ + "shopLive" + ], + "responses": { + "200": { + "description": "success to get upcoming campaign info", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShopLiveCampaignResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/shop-live/campaigns/{campaignKey}/metadata": { + "get": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "campaignKey", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "required": false, + "name": "resolutionLevel", + "description": "่งฃๅƒๅบฆใƒฌใƒ™ใƒซ", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "summary": "ๅ€‹ๅˆฅๆ”พ้€๏ผˆใ‚ญใƒฃใƒณใƒšใƒผใƒณ๏ผ‰ใฎใ‚นใƒ†ใƒผใ‚ฟใ‚นใ€ใƒฉใ‚คใƒ–ใ‚นใƒˆใƒชใƒผใƒ URLใชใฉใฎ่ฆ็ด„ๆƒ…ๅ ฑใ‚’็…งไผš", + "operationId": "getCampaignMetadata", + "tags": [ + "shopLive" + ], + "responses": { + "200": { + "description": "success to get campaign metadata", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShopLiveCampaignMetadataResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/points": { + "get": { + "parameters": [ + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "name": "cursor", + "description": "epochSeconds", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "pointType", + "description": "็ฒๅพ—ใ‚ฟใ‚คใƒ— / null = ใƒ•ใƒซ็…งไผš", + "required": false, + "schema": { + "$ref": "#/components/schemas/PointAmountTypeEnum" + } + } + ], + "summary": "ใƒฆใƒผใ‚ถใƒผใฎๅ…ฅ้‡‘ๅฑฅๆญดใ‚’็…งไผšใ—ใพใ™.", + "operationId": "getPointHistory", + "tags": [ + "point" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to get point hisotry", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PointHistoryBundleResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/points/now-usable": { + "get": { + "summary": "ใƒฆใƒผใ‚ถใƒผใฎ็พๅœจๅˆฉ็”จๅฏ่ƒฝใชๅ…ฅ้‡‘ใ‚’็ขบ่ชใ—ใพใ™.", + "operationId": "getNowUsablePoint", + "tags": [ + "point" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to get now usable point", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NowUsablePointDto" + } + } + } + } + } + } + }, + "/points/promotions/{code}/attend": { + "put": { + "summary": "็ฉ็ซ‹้‡‘ใƒ—ใƒญใƒขใƒผใ‚ทใƒงใƒณใ‚คใƒ™ใƒณใƒˆใซๅ‚ๅŠ .", + "operationId": "attendPromotion", + "tags": [ + "point" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "code", + "description": "ใƒ—ใƒญใƒขใƒผใ‚ทใƒงใƒณใ‚ณใƒผใƒ‰", + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "success to attend promotion" + } + } + }, + "get": { + "summary": "็ฒๅพ—้‡‘ใƒ—ใƒญใƒขใƒผใ‚ทใƒงใƒณใ‚คใƒ™ใƒณใƒˆใซๅ‚ๅŠ ใ™ใ‚‹ใ‹ใฉใ†ใ‹ใ‚’็ขบ่ชใ—ใพใ™.", + "operationId": "getAttendPromotionState", + "tags": [ + "point" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "code", + "description": "ใƒ—ใƒญใƒขใƒผใ‚ทใƒงใƒณใ‚ณใƒผใƒ‰", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "success to query attend promotion", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotionAttendedStateDto" + } + } + } + } + } + } + }, + "/product-rankings/{productId}/is-category-best-product": { + "get": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "productId", + "schema": { + "type": "string" + } + } + ], + "summary": "ใ‚ซใƒ†ใ‚ดใƒชใƒผใƒ™ใ‚นใƒˆๅ•†ๅ“ใงใ‚ใ‚‹ใ‹ใฉใ†ใ‹ใฎ็ขบ่ช", + "operationId": "findCategoryBestProduct", + "tags": [ + "productRanking" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "success to get category best product", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CategoryBestProductDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/referral/code": { + "get": { + "summary": "ๆ‹›ๅพ…ใ‚ณใƒผใƒ‰็…งไผš API", + "description": "referrer ใฎๆ‹›ๅพ…ใ‚ณใƒผใƒ‰ใ‚’่ฟ”ใ—ใพใ™ใ€‚ๆœ€ๅˆใฎ่ฆๆฑ‚ๆ™‚ใซ็”ŸๆˆๅพŒใซ่ฟ”ใ™.", + "operationId": "getReferralCode", + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ใŠใ™ใ™ใ‚ใ‚ณใƒผใƒ‰", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReferralCodeDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/referral/user/reward/policy": { + "get": { + "summary": "ใƒฆใƒผใ‚ถใƒผๆ‹›ๅพ…ๅ ฑ้…ฌใƒใƒชใ‚ทใƒผ็…งไผšAPI", + "operationId": "getUserReferralPolicy", + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ใƒฆใƒผใ‚ถใƒผๆ‹›ๅพ…ๅ ฑ้…ฌใƒใƒชใ‚ทใƒผ็…งไผš็ตๆžœ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserReferralRewardPolicyDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/referral/user-referral/summary": { + "get": { + "summary": "ใƒฆใƒผใ‚ถใƒผๆ‹›ๅพ…่ฆ็ด„ๆƒ…ๅ ฑ็…งไผšAPI", + "operationId": "getUserReferralSummary", + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ใƒฆใƒผใ‚ถใƒผๆ‹›ๅพ…ใฎๆฆ‚่ฆใซใคใ„ใฆ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserReferralSummaryDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/referral/user-referral/bonus-box/open": { + "post": { + "summary": "ใƒฆใƒผใ‚ถใƒผใƒชใƒ•ใ‚กใƒฌใƒณใ‚นใง็ฒๅพ—ใ—ใŸใƒœใƒผใƒŠใ‚นใƒœใƒƒใ‚ฏใ‚นใ‚’็ฒๅพ—ใ™ใ‚‹API", + "description": "ใƒฆใƒผใ‚ถใƒผใƒชใƒ•ใ‚กใƒฌใƒณใ‚นใƒœใƒผใƒŠใ‚นใƒœใƒƒใ‚ฏใ‚นใ‚’1ใค้–‹ใAPI", + "operationId": "openUserReferralBonusBox", + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ใƒœใƒผใƒŠใ‚นใƒœใƒƒใ‚ฏใ‚นใ‚ชใƒผใƒ—ใƒณ็ตๆžœ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserReferralBonusBoxOpenResultDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/referral/user/reward/summary": { + "get": { + "summary": "ใƒฆใƒผใ‚ถใƒผๆ‹›ๅพ…ๅ ฑ้…ฌใ‚ตใƒžใƒชใƒผๆƒ…ๅ ฑ็…งไผšAPI - > `getUserReferralSummary`ใ‚’ไฝฟ็”จใ™ใ‚‹", + "operationId": "getUserReferralRewardSummary", + "deprecated": true, + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ใƒฆใƒผใ‚ถใƒผๆ‹›ๅพ…ใ‚’ๅ—ใ‘ใŸ็ดฏ็ฉๅ ฑ้…ฌใฎ็…งไผš็ตๆžœ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserReferralRewardSummaryDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/referral/user/reward/estimate": { + "post": { + "summary": "ใƒฆใƒผใ‚ถใƒผๆŽจๅฅจๅ ฑ้…ฌไบˆๆƒณAPI", + "description": "- ๆŽจ่–ฆ่€…ใŒๅ ฑ้…ฌใงๅพ—ใ‚‰ใ‚Œใ‚‹ใƒใ‚คใƒณใƒˆไบˆๆƒณ็ตๆžœใ‚’็…งไผšใ™ใ‚‹API(ๆœ€ๅคง50ๅ€‹ๅ‡ฆ็†)", + "operationId": "estimateUserReferralRewards", + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserReferralRewardEstimationRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "referrer ใŒๅ—ใ‘ๅ–ใ‚‹ใ“ใจใŒใงใใ‚‹ๆ‹›ๅพ…ๅ ฑ้…ฌใƒชใ‚นใƒˆ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserReferralRewardEstimationListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/referral/user": { + "post": { + "summary": "ใƒฆใƒผใ‚ถใƒผๆŽจๅฅจAPI", + "operationId": "createUserReferral", + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateUserReferralRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "ใƒฆใƒผใ‚ถใƒผๆŽจๅฅจๆˆๅŠŸ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateUserReferralResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/referral/user/referred-user-join": { + "post": { + "summary": "ใŠใ™ใ™ใ‚ใฎใƒฆใƒผใ‚ถใƒผ็™ป้ŒฒๅฎŒไบ†API", + "operationId": "joinReferredUser", + "description": "ๆŽจๅฅจใ•ใ‚ŒใŸใƒฆใƒผใ‚ถใƒผใŒreferral linkใ‚’ไป‹ใ—ใฆ่ณผ่ชญๅฎŒไบ†ๅพŒใซใใฎAPIใ‚’ๅ‘ผใณๅ‡บใ™", + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JoinReferredUserRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "ใŠใ™ใ™ใ‚ใƒฆใƒผใ‚ถใƒผ็™ป้ŒฒๆˆๅŠŸ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JoinReferredUserResponseDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/referral/product": { + "post": { + "summary": "ๆŽจๅฅจๅ•†ๅ“่ณผๅ…ฅๅฎŒไบ†API", + "operationId": "createProductReferral", + "tags": [ + "referral" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateProductReferralRequestDto" + } + } + } + }, + "responses": { + "200": { + "description": "ๅ•†ๅ“็ดนไป‹ใƒชใƒณใ‚ฏใ‚’ไป‹ใ—ใฆๅ•†ๅ“่ณผๅ…ฅๆ™‚ใซProductReferralใ‚’็”Ÿๆˆใ™ใ‚‹APIใงใ™ใ€‚." + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/games": { + "get": { + "summary": "็พๅœจ้€ฒ่กŒไธญใฎใ‚ฒใƒผใƒ ใฎใƒชใ‚นใƒˆ", + "operationId": "getGameList", + "tags": [ + "gamification" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ใ‚ฒใƒผใƒ ใƒชใ‚นใƒˆ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActiveGameListResponse" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/games/{gameId}": { + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ใƒฆใƒผใ‚ถใƒผใ‚ฒใƒผใƒ ๆƒ…ๅ ฑใฎ็…งไผš", + "operationId": "getGameProgressInfo", + "tags": [ + "gamification" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ใƒฆใƒผใ‚ถใƒผใ‚ฒใƒผใƒ ๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameUserProgressInfoResponse" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + } + ] + }, + "post": { + "summary": "ไธ€ๆฌก่ฒกๆถˆ่ฒป", + "operationId": "useInGameCredit", + "tags": [ + "gamification" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameUseInGameCreditRequest" + } + } + } + }, + "responses": { + "200": { + "description": "ใƒฆใƒผใ‚ถใƒผใ‚ฒใƒผใƒ ๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameUserProgressInfoResponse" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/games/{gameId}/achieve": { + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "post": { + "summary": "ใ‚ฒใƒผใƒ ใ‚ฏใƒชใ‚ขๅ ฑ้…ฌ็ฒๅพ—", + "operationId": "achieveGame", + "tags": [ + "gamification" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameAchieveRequest" + } + } + } + }, + "responses": { + "204": { + "description": "ใ‚ฒใƒผใƒ ใ‚ฏใƒชใ‚ขๅฎŒไบ†" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/games/{gameId}/missions": { + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "ใƒŸใƒƒใ‚ทใƒงใƒณใƒชใ‚นใƒˆใจใƒŸใƒƒใ‚ทใƒงใƒณ้€ฒๆ—็Šถๆณใฎ็ขบ่ช", + "operationId": "getMissions", + "tags": [ + "gamification" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ใƒŸใƒƒใ‚ทใƒงใƒณใƒชใ‚นใƒˆใจใƒŸใƒƒใ‚ทใƒงใƒณ้€ฒๆ—็Šถๆณ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameMissionsResponse" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + } + ] + }, + "post": { + "summary": "ใƒŸใƒƒใ‚ทใƒงใƒณๅฎŒไบ†ใƒชใ‚ฏใ‚จใ‚นใƒˆ", + "operationId": "achieveMission", + "tags": [ + "gamification" + ], + "security": [ + { + "damoa-token": [] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameMissionAchieveRequest" + } + } + } + }, + "responses": { + "204": { + "description": "ใƒŸใƒƒใ‚ทใƒงใƒณๅฎŒไบ†" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/games/{gameId}/missions/{missionId}": { + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "missionId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "post": { + "summary": "ใƒŸใƒƒใ‚ทใƒงใƒณๅ ฑ้…ฌใฎๅ—้ ˜", + "operationId": "receiveReward", + "tags": [ + "gamification" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "ใƒŸใƒƒใ‚ทใƒงใƒณๅ ฑ้…ฌ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GameMissionRewardReceiveResponse" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "gameId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "missionId", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ] + } + }, + "/categories/{categoryId}/review-guide": { + "parameters": [ + { + "in": "path", + "name": "categoryId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "get": { + "summary": "get category's review guide", + "operationId": "getProductCategoryReviewGuide", + "tags": [ + "review" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "product category review guide", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductCategoryReviewGuideDataDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "categoryId", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/style-shots": { + "get": { + "summary": "get all style shots", + "operationId": "getAllStyleShots", + "tags": [ + "styleShot" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "query", + "name": "categoryId", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "in": "header", + "name": "cursor", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "size", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "get all style shots", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StyleShotListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/style-shots/{id}": { + "get": { + "summary": "get style shot by id", + "operationId": "getStyleShotById", + "tags": [ + "styleShot" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "id", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "get style shot", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StyleShotDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/style-shots/categories": { + "get": { + "summary": "get all style category", + "operationId": "getAllStyleCategory", + "tags": [ + "styleShot" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "get all style category", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StyleCategoryListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/style-shots/{id}/equipped-products": { + "get": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "id", + "schema": { + "type": "string" + } + } + ], + "summary": "get equipped product list by product item ids", + "description": "ใ‚นใ‚ฟใ‚คใƒซใ‚ทใƒงใƒƒใƒˆIDใง็€็”จๅ•†ๅ“ใ‚’่ฆ‹ใ‚‹", + "operationId": "getEquippedProductListByStyleShotId", + "tags": [ + "styleShot" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- products and product items (unique and not ordered) by product item ids - ใ‚ฏใ‚คใƒผใƒณใ‚คใƒƒใƒˆๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸๅ ดๅˆ `ProductDto` ใงๅณๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸ้‡‘้กใ‚’่กจ็คบใ™ใ‚‹ - ๅฝฑ้Ÿฟใ‚’ๅ—ใ‘ใ‚‹ใƒ•ใ‚ฃใƒผใƒซใƒ‰: `finalPrice`, `discountPercentage`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EquippedProductListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/delivery-prediction": { + "get": { + "parameters": [ + { + "in": "path", + "name": "productId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "summary": "get delivery completed prediction dates and probability by product id", + "description": "ProductIdใ‚’ไป‹ใ—ใฆไบˆๆƒณ้…้€ๅฎŒไบ†ๆ™‚็‚นใƒ‡ใƒผใ‚ฟใ‚’็…งไผšใ—ใพใ™.", + "operationId": "getDeliveryPrediction", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- get delivery completed expectation data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeliveryPredictionListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/purchase-measurements-statistics": { + "get": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "productId", + "schema": { + "type": "string" + } + } + ], + "summary": "get purchase measurements statistics by product id", + "description": "ๅ•†ๅ“IDใซใ‚ˆใ‚‹่ณผๅ…ฅ็ตฑ่จˆใฎ่กจ็คบ", + "operationId": "getPurchaseMeasurementsStatistics", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- get purchase measurements statistics", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PurchaseMeasurementsStatisticsListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/products/{productId}/purchase-measurements": { + "get": { + "parameters": [ + { + "in": "path", + "required": true, + "name": "productId", + "schema": { + "type": "string" + } + } + ], + "summary": "get purchase measurements by product id(limit 5)", + "description": "ๅ•†ๅ“IDใซใ‚ˆใ‚‹่ณผๅ…ฅ็ตฑ่จˆใฎ็…งไผš๏ผˆ่กŒใƒ‡ใƒผใ‚ฟ๏ผ‰", + "operationId": "getPurchaseMeasurements", + "tags": [ + "product" + ], + "security": [ + { + "damoa-token": [] + } + ], + "responses": { + "200": { + "description": "- get purchase measurements", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PurchaseMeasurementsDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/attendance-checks/{id}/histories": { + "get": { + "summary": "get attendance check histories", + "operationId": "getAttendanceCheckHistories", + "tags": [ + "attendanceCheck" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "id", + "description": "ๅ‡บๅธญใƒใ‚งใƒƒใ‚ฏID", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "get attendance check histories", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AttendanceCheckHistoryListDto" + } + } + } + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + }, + "/attendance-checks/{id}/attend": { + "post": { + "summary": "attend attendance check", + "description": "- ๆ—ขๅ‡บๅธญๆ™‚ใ‚จใƒฉใƒผใ‚ณใƒผใƒ‰: ALREADY_EXISTS(1) - ๅ‡บๅธญใƒใ‚งใƒƒใ‚ฏๅฎŒไบ†ๆ™‚ใ‚จใƒฉใƒผใ‚ณใƒผใƒ‰: ATTENDANCE_CHECK_COMPLETED(8001) - ใ‚คใƒ™ใƒณใƒˆ็ต‚ไบ†ๆ™‚ใ‚จใƒฉใƒผใ‚ณใƒผใƒ‰: RESOURCE_NOT_FOUND(4)", + "operationId": "attendAttendanceCheck", + "tags": [ + "attendanceCheck" + ], + "security": [ + { + "damoa-token": [] + } + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "id", + "description": "ๅ‡บๅธญใƒใ‚งใƒƒใ‚ฏID", + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "success to attend attendance check" + }, + "400": { + "description": "failed to get response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "BooleanDto": { + "type": "object", + "description": "to overcome oag bug that primitive api response does not converted from string in TS.", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "RequiredLongDto": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "integer", + "format": "int64" + } + } + }, + "LongDto": { + "type": "object", + "description": "to overcome oag bug that primitive api response does not converted from long in TS.", + "properties": { + "value": { + "type": "integer", + "format": "int64" + } + } + }, + "LongRangeDto": { + "type": "object", + "properties": { + "min": { + "type": "integer", + "format": "int64" + }, + "max": { + "type": "integer", + "format": "int64" + } + } + }, + "RequiredBooleanDto": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "boolean" + } + } + }, + "MetadataDto": { + "type": "object", + "required": [ + "version", + "serverStatus" + ], + "properties": { + "version": { + "$ref": "#/components/schemas/VersionDto" + }, + "serverStatus": { + "$ref": "#/components/schemas/ServerStatusDto" + } + } + }, + "VersionDto": { + "type": "object", + "required": [ + "minVersion", + "minBuildNumber" + ], + "properties": { + "minVersion": { + "type": "string", + "description": "minimum required version to show" + }, + "minBuildNumber": { + "type": "integer", + "format": "int32", + "description": "minimum required build number" + }, + "updateUrl": { + "type": "string", + "description": "update url" + } + } + }, + "BestPeriodEnum": { + "oneOf": [ + { + "const": "DAILY" + }, + { + "const": "WEEKLY" + }, + { + "const": "MONTHLY" + } + ] + }, + "ProductTagEnum": { + "oneOf": [ + { + "const": "SHOPPING_MALL" + }, + { + "const": "DISCOUNT_PROMOTION" + } + ], + "description": "ๅ•†ๅ“ใ‚ฟใ‚ฐๆƒ…ๅ ฑใ€‚ SHOPPING_MALL ->ใ‚ทใƒงใƒƒใƒ”ใƒณใ‚ฐใƒขใƒผใƒซใฎๅ•†ๅ“DISCOUNT_PROMOTION ->็‰นไพกๅ•†ๅ“" + }, + "AgeGroupCodeEnum": { + "oneOf": [ + { + "const": "AG0" + }, + { + "const": "AG1" + }, + { + "const": "AG2" + }, + { + "const": "AG3" + }, + { + "const": "AG4" + }, + { + "const": "AG5" + }, + { + "const": "AG6" + } + ], + "description": "ๅนด้ฝขใ‚ณใƒผใƒ‰ใ€‚ใƒŽใƒƒใ‚ทใƒงใƒณใƒŽใƒผใƒˆ - > https://www.notion.so/rapportlabs/5d323300ed8a457da25b889fdc9c986c" + }, + "ServerStatusDto": { + "type": "object", + "required": [ + "serverState" + ], + "properties": { + "serverState": { + "$ref": "#/components/schemas/ServerStateEnum" + }, + "serverMaintenanceReason": { + "type": "string", + "description": "server maintenance reason" + }, + "serverMaintenanceStartedAtMillis": { + "type": "integer", + "format": "int64", + "description": "server maintenance start time" + }, + "serverMaintenanceEndedAtMillis": { + "type": "integer", + "format": "int64", + "description": "server maintenance end time" + } + } + }, + "PlatformEnum": { + "oneOf": [ + { + "const": "ANDROID" + }, + { + "const": "IOS" + } + ] + }, + "ServerStateEnum": { + "oneOf": [ + { + "const": "OPERATIONAL" + }, + { + "const": "MAINTENANCE" + } + ], + "description": "server status enum" + }, + "SendVerifCodeRequestDto": { + "type": "object", + "required": [ + "phoneNumber" + ], + "properties": { + "phoneNumber": { + "type": "string", + "description": "phone number to send verif code" + } + } + }, + "SendVerifCodeResponseDto": { + "type": "object", + "required": [ + "verifyingToken", + "expirationMillis" + ], + "properties": { + "verifyingToken": { + "type": "string" + }, + "expirationMillis": { + "type": "integer", + "format": "int64" + } + } + }, + "VerifyCodeRequestDto": { + "type": "object", + "required": [ + "verifyingToken", + "verifCode" + ], + "properties": { + "verifyingToken": { + "type": "string" + }, + "verifCode": { + "type": "string" + } + } + }, + "VerifyCodeResponseDto": { + "type": "object", + "required": [ + "verifiedToken" + ], + "properties": { + "verifiedToken": { + "type": "string" + } + } + }, + "VerifyKakaoTokenRequestDto": { + "type": "object", + "required": [ + "kakaoAccessToken", + "phoneNumber" + ], + "properties": { + "kakaoAccessToken": { + "type": "string" + }, + "phoneNumber": { + "type": "string" + } + } + }, + "VerifyKakaoTokenResponseDto": { + "type": "object", + "required": [ + "verifiedToken" + ], + "properties": { + "verifiedToken": { + "type": "string" + } + } + }, + "SignUpRequestDto": { + "type": "object", + "required": [ + "verifiedToken" + ], + "properties": { + "verifiedToken": { + "type": "string" + } + } + }, + "SignUpResponseDto": { + "type": "object", + "required": [ + "firebaseToken" + ], + "properties": { + "firebaseToken": { + "type": "string" + } + } + }, + "DamoaTokenDto": { + "type": "object", + "required": [ + "accessToken", + "refreshToken" + ], + "properties": { + "accessToken": { + "type": "string", + "description": "1ๆ™‚้–“ๅพŒใซๆœŸ้™ๅˆ‡ใ‚Œ" + }, + "refreshToken": { + "type": "string", + "description": "180ๆ—ฅๅพŒใซๆœŸ้™ๅˆ‡ใ‚Œ" + } + } + }, + "DamoaTokenRefreshRequestDto": { + "type": "object", + "required": [ + "refreshToken" + ], + "properties": { + "refreshToken": { + "type": "string" + } + } + }, + "LoginAccountDto": { + "type": "object", + "required": [ + "uid", + "userRole", + "createdAtMillis", + "isKakaoLoginUser" + ], + "properties": { + "uid": { + "type": "string" + }, + "userRole": { + "$ref": "#/components/schemas/UserRoleEnum" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + }, + "phoneNumber": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "isKakaoLoginUser": { + "type": "boolean" + } + } + }, + "FirebaseAuthUserMigrationRequest": { + "type": "object", + "required": [ + "accessToken" + ], + "properties": { + "accessToken": { + "type": "string" + } + } + }, + "ProviderTypeEnum": { + "oneOf": [ + { + "const": "SMS" + }, + { + "const": "KAKAO" + } + ] + }, + "UserRoleEnum": { + "oneOf": [ + { + "const": "ANONYMOUS" + }, + { + "const": "IDENTIFIED_USER" + } + ] + }, + "BestBrandListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BestBrandDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "BestBrandDto": { + "type": "object", + "required": [ + "id", + "name", + "logo" + ], + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "logo": { + "$ref": "#/components/schemas/BrandLogoDto" + }, + "bestProducts": { + "$ref": "#/components/schemas/BestProductListOfBrandDto" + } + } + }, + "BestProductListOfBrandDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BestProductOfBrandDto" + } + } + } + }, + "BestProductOfBrandDto": { + "type": "object", + "required": [ + "title", + "productId", + "thumbnailUrl", + "multiResolutionThumbnail", + "finalPrice" + ], + "properties": { + "title": { + "type": "string" + }, + "productId": { + "type": "string" + }, + "thumbnailUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionThumbnail": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "finalPrice": { + "type": "integer", + "format": "int64" + } + } + }, + "TagListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "description": "ใ‚ฟใ‚ฐใƒชใ‚นใƒˆ", + "type": "array", + "items": { + "$ref": "#/components/schemas/TagDto" + } + } + } + }, + "TagDto": { + "type": "object", + "required": [ + "id", + "name", + "type" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "description": "tagใฎๅๅ‰", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/TagTypeEnum" + } + } + }, + "TagTypeEnum": { + "oneOf": [ + { + "const": "BRAND_SOURCING" + }, + { + "const": "PRODUCT" + } + ], + "description": "ใ‚ฟใ‚ฐไป˜ใ‘ใงใใ‚‹ใ‚‚ใฎใฎ็จฎ้กžใ€‚ๅŒใ˜ใ‚ฐใƒซใƒผใƒ—ๅใงใ‚‚ใ‚ฟใ‚คใƒ—ใŒ็•ฐใชใ‚‹ๅ ดๅˆใฏๅˆฅใฎใ‚ฐใƒซใƒผใƒ—ใจใ—ใฆๆ‰ฑใ†." + }, + "TagGroupListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "description": "ใ‚ฟใ‚ฐใ‚ฐใƒซใƒผใƒ—ใƒชใ‚นใƒˆ", + "type": "array", + "items": { + "$ref": "#/components/schemas/TagGroupDto" + } + } + } + }, + "TagGroupDto": { + "type": "object", + "required": [ + "id", + "name", + "type" + ], + "properties": { + "id": { + "description": "ใ‚ฟใ‚ฐใฎ group id", + "type": "integer", + "format": "int64" + }, + "name": { + "description": "ใ‚ฟใ‚ฐใฎ group name (ex. ็”Ÿ็”ฃๅนดๅบฆ)", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/TagTypeEnum" + } + } + }, + "ProductDto": { + "type": "object", + "required": [ + "productId", + "mallId", + "mallProductCode", + "mallName", + "url", + "imageUrl", + "multiResolutionImage", + "thumbnailUrl", + "multiResolutionThumbnail", + "name", + "finalPrice", + "discountPercentage", + "productPriceDetail", + "brand", + "rating", + "salesStatus" + ], + "properties": { + "productId": { + "type": "string" + }, + "mallId": { + "type": "string", + "description": "DEPRECATED" + }, + "mallProductCode": { + "type": "string" + }, + "mallName": { + "type": "string", + "description": "DEPRECATED" + }, + "rank": { + "type": "integer", + "format": "int32" + }, + "logoUrl": { + "type": "string", + "description": "DEPRECATED" + }, + "logo2xUrl": { + "type": "string", + "description": "DEPRECATED" + }, + "logo3xUrl": { + "type": "string", + "description": "DEPRECATED" + }, + "url": { + "type": "string", + "description": "DEPRECATED" + }, + "imageUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "thumbnailUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionThumbnail": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "name": { + "type": "string" + }, + "originalPrice": { + "type": "integer", + "format": "int64" + }, + "finalPrice": { + "type": "integer", + "format": "int64", + "description": "- `productPriceDetail`ใงใฎ`directCouponAppliedFinalPrice`ใ€ใŸใ nullใชใ‚‰`finalPrice`" + }, + "discountPercentage": { + "type": "integer", + "format": "int32", + "description": "- `originalPrice`ใ‚ณใƒณใƒˆใƒฉใ‚นใƒˆ `finalPrice`ใ‚ณใƒณใƒˆใƒฉใ‚นใƒˆ" + }, + "productPriceDetail": { + "$ref": "#/components/schemas/ProductPriceDetailDto" + }, + "brand": { + "type": "string" + }, + "display": { + "type": "boolean", + "description": "ใ“ใฎใƒ•ใ‚ฃใƒผใƒซใƒ‰ๅ€คใŒ `false` ใฎๅ ดๅˆ - > ๅฃฒใ‚Šๅˆ‡ใ‚Œใง่กจ็คบ" + }, + "reviewRatingAvg": { + "type": "number", + "format": "double" + }, + "reviewCount": { + "type": "integer", + "format": "int32" + }, + "category": { + "$ref": "#/components/schemas/ProductCategoryDto" + }, + "rating": { + "type": "integer", + "format": "int32" + }, + "deliveryPolicy": { + "$ref": "#/components/schemas/DeliveryPolicyDto" + }, + "salesStatus": { + "$ref": "#/components/schemas/SalesStatusEnum" + } + } + }, + "AppProductDto": { + "type": "object", + "required": [ + "productId", + "mallId", + "mallProductCode", + "mallName", + "url", + "imageUrl", + "multiResolutionImage", + "thumbnailUrl", + "multiResolutionThumbnail", + "name", + "finalPrice", + "discountPercentage", + "productPriceDetail", + "brand", + "rating", + "salesStatus", + "myBodySizesFromItems" + ], + "properties": { + "productId": { + "type": "string" + }, + "mallId": { + "type": "string", + "description": "DEPRECATED" + }, + "mallProductCode": { + "type": "string" + }, + "mallName": { + "type": "string", + "description": "DEPRECATED" + }, + "rank": { + "type": "integer", + "format": "int32" + }, + "url": { + "type": "string", + "description": "DEPRECATED" + }, + "imageUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "thumbnailUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionThumbnail": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "name": { + "type": "string" + }, + "originalPrice": { + "type": "integer", + "format": "int64" + }, + "finalPrice": { + "type": "integer", + "format": "int64" + }, + "discountPercentage": { + "type": "integer", + "format": "int32" + }, + "productPriceDetail": { + "$ref": "#/components/schemas/ProductPriceDetailDto" + }, + "brand": { + "type": "string" + }, + "display": { + "type": "boolean", + "description": "ใ“ใฎใƒ•ใ‚ฃใƒผใƒซใƒ‰ๅ€คใŒ `false` ใฎๅ ดๅˆ - > ๅฃฒใ‚Šๅˆ‡ใ‚Œใง่กจ็คบ" + }, + "category": { + "$ref": "#/components/schemas/ProductCategoryDto" + }, + "rating": { + "type": "integer", + "format": "int32" + }, + "deliveryPolicy": { + "$ref": "#/components/schemas/DeliveryPolicyDto" + }, + "salesStatus": { + "$ref": "#/components/schemas/SalesStatusEnum" + }, + "reviewRatingAvg": { + "type": "number", + "format": "double" + }, + "reviewCount": { + "type": "integer", + "format": "int32" + }, + "myBodySizesFromItems": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "EquippedProductDto": { + "type": "object", + "required": [ + "productId", + "productItem", + "mallId", + "mallProductCode", + "mallName", + "url", + "imageUrl", + "multiResolutionImage", + "thumbnailUrl", + "multiResolutionThumbnail", + "name", + "finalPrice", + "discountPercentage", + "productPriceDetail", + "brand", + "rating", + "salesStatus", + "favorite" + ], + "properties": { + "productId": { + "type": "string" + }, + "productItem": { + "$ref": "#/components/schemas/ProductItemDto" + }, + "mallId": { + "type": "string", + "description": "DEPRECATED" + }, + "mallProductCode": { + "type": "string" + }, + "mallName": { + "type": "string", + "description": "DEPRECATED" + }, + "rank": { + "type": "integer", + "format": "int32" + }, + "logoUrl": { + "type": "string", + "description": "DEPRECATED" + }, + "logo2xUrl": { + "type": "string", + "description": "DEPRECATED" + }, + "logo3xUrl": { + "type": "string", + "description": "DEPRECATED" + }, + "url": { + "type": "string", + "description": "DEPRECATED" + }, + "imageUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "thumbnailUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionThumbnail": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "name": { + "type": "string" + }, + "originalPrice": { + "type": "integer", + "format": "int64" + }, + "finalPrice": { + "type": "integer", + "format": "int64", + "description": "- `productPriceDetail`ใงใฎ`directCouponAppliedFinalPrice`ใ€ใŸใ nullใชใ‚‰`finalPrice`" + }, + "discountPercentage": { + "type": "integer", + "format": "int32", + "description": "- `originalPrice`ใ‚ณใƒณใƒˆใƒฉใ‚นใƒˆ `finalPrice`ใ‚ณใƒณใƒˆใƒฉใ‚นใƒˆ" + }, + "productPriceDetail": { + "$ref": "#/components/schemas/ProductPriceDetailDto" + }, + "brand": { + "type": "string" + }, + "display": { + "type": "boolean", + "description": "ใ“ใฎใƒ•ใ‚ฃใƒผใƒซใƒ‰ๅ€คใŒ `false` ใฎๅ ดๅˆ - > ๅฃฒใ‚Šๅˆ‡ใ‚Œใง่กจ็คบ" + }, + "reviewRatingAvg": { + "type": "number", + "format": "double" + }, + "reviewCount": { + "type": "integer", + "format": "int32" + }, + "category": { + "$ref": "#/components/schemas/ProductCategoryDto" + }, + "rating": { + "type": "integer", + "format": "int32" + }, + "deliveryPolicy": { + "$ref": "#/components/schemas/DeliveryPolicyDto" + }, + "salesStatus": { + "$ref": "#/components/schemas/SalesStatusEnum" + }, + "favorite": { + "type": "boolean", + "default": false, + "description": "่’ธใ™ใ‹ใฉใ†ใ‹" + } + } + }, + "AppAdvertisementProductDto": { + "type": "object", + "properties": { + "productId": { + "type": "string" + }, + "mallId": { + "type": "string", + "description": "DEPRECATED" + }, + "mallProductCode": { + "type": "string" + }, + "mallName": { + "type": "string", + "description": "DEPRECATED" + }, + "rank": { + "type": "integer", + "format": "int32" + }, + "url": { + "type": "string", + "description": "DEPRECATED" + }, + "imageUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "thumbnailUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionThumbnail": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "name": { + "type": "string" + }, + "originalPrice": { + "type": "integer", + "format": "int64" + }, + "finalPrice": { + "type": "integer", + "format": "int64" + }, + "discountPercentage": { + "type": "integer", + "format": "int32" + }, + "productPriceDetail": { + "$ref": "#/components/schemas/ProductPriceDetailDto" + }, + "brand": { + "type": "string" + }, + "display": { + "type": "boolean", + "description": "ใ“ใฎใƒ•ใ‚ฃใƒผใƒซใƒ‰ๅ€คใŒ `false` ใฎๅ ดๅˆ - > ๅฃฒใ‚Šๅˆ‡ใ‚Œใง่กจ็คบ" + }, + "category": { + "$ref": "#/components/schemas/ProductCategoryDto" + }, + "rating": { + "type": "integer", + "format": "int32" + }, + "deliveryPolicy": { + "$ref": "#/components/schemas/DeliveryPolicyDto" + }, + "salesStatus": { + "$ref": "#/components/schemas/SalesStatusEnum" + }, + "reviewRatingAvg": { + "type": "number", + "format": "double" + }, + "reviewCount": { + "type": "integer", + "format": "int32" + }, + "myBodySizesFromItems": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ProductPriceDetailDto": { + "type": "object", + "description": "- ๆ—ขๅญ˜ๅ•†ๅ“ใซ่จญๅฎšใ•ใ‚ŒใŸไพกๆ ผใจใ€ๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸไพกๆ ผใชใฉใซ้–ขใ™ใ‚‹่ฉณ็ดฐๆƒ…ๅ ฑใ‚’ๆไพ›ใ™ใ‚‹ใŸใ‚ใฎdto - `ProductDto`ใ€`AppProductDto`ใ€`FavoriteProductDto`ใชใฉใง็ขบ่ชใงใใ‚‹ๅ•†ๅ“ไพกๆ ผใซ้–ขใ™ใ‚‹่ฉณ็ดฐๆƒ…ๅ ฑ > ใ‚ฏใ‚คใƒผใƒณใ‚คใƒƒใƒˆๅณๅ‰ฒๅผ•ใŒ้ฉ็”จใชใ‚‹ๅ ดๅˆใซใฏใ€ๆ—ขๅญ˜ใฎdtoใง็คบใ—ใŸๅ•†ๅ“ไพกๆ ผใŒใ‚ฏใ‚คใƒผใƒณใ‚คใƒƒใƒˆๅณๅ‰ฒๅผ•ใงไธŠๆ›ธใใ•ใ‚Œใ‚‹ใ“ใจใซใชใ‚‹", + "required": [ + "finalPrice" + ], + "properties": { + "originalPrice": { + "description": "- ๅฎšไพก - ใ“ใฎใƒ•ใ‚ฃใƒผใƒซใƒ‰ใฎๅ€คใŒ `null` ใฎๅ ดๅˆ -> `finalPrice` ใŒๅฎšไพกใฎๆ„ๅ‘ณใ‚’ไธ€็ท’ใซๆŒใคใ‚ˆใ†ใซใชใ‚‹", + "type": "integer", + "format": "int64" + }, + "finalPrice": { + "description": "- ่ฒฉๅฃฒไพกๆ ผ๏ผˆๅฎŸ้š›ใฎใƒฆใƒผใ‚ถใƒผใŒๅ•†ๅ“ใ‚’่ณผๅ…ฅใ™ใ‚‹ไพกๆ ผ๏ผ‰ - ใ‚ฏใ‚คใƒผใƒณใ‚คใƒƒใƒˆๅณๆ™‚ๅ‰ฒๅผ•ใ‚ฏใƒผใƒใƒณใŒ้ฉ็”จใ•ใ‚Œใฆใ„ใชใ„่ฒฉๅฃฒไพกๆ ผๆƒ…ๅ ฑใ‚’่กจ็คบใ™ใ‚‹ - ๅ•†ๅ“็™ป้Œฒๆ™‚ใซๅ…ฅๅŠ›ใ—ใŸ่ฒฉๅฃฒไพกๆ ผใ‚’็คบใ™ - `originalPrice`ใ€ `discountPercentage`ใƒ•ใ‚ฃใƒผใƒซใƒ‰ๅ€คใŒ `null`ๅ ดๅˆ - >ใ“ใฎใƒ•ใ‚ฃใƒผใƒซใƒ‰ใซๅฎšไพกใฎๆ„ๅ‘ณใŒไธ€็ท’ใซใชใ‚‹", + "type": "integer", + "format": "int64" + }, + "discountPercentage": { + "description": "- ๅ‰ฒๅผ•็Ž‡ - > `originalPrice`ใซๅฏพใ™ใ‚‹`finalPrice`ใฎๆฏ”็Ž‡", + "type": "integer", + "format": "int32" + }, + "originalToDirectCouponDiscountPercentage": { + "description": "- ๅ‰ฒๅผ•็Ž‡ - > `originalPrice`ใซๅฏพใ™ใ‚‹`directCouponAppliedFinalPrice`ใฎๆฏ”็Ž‡", + "type": "integer", + "format": "int32" + }, + "finalToDirectCouponDiscountPercentage": { + "description": "- ๅ‰ฒๅผ•็Ž‡ -> `finalPrice`ใซๅฏพใ™ใ‚‹`directCouponAppliedFinalPrice`ใฎๆฏ”็Ž‡", + "type": "integer", + "format": "int32" + }, + "directCouponAppliedFinalPrice": { + "description": "- ใ‚ฏใ‚คใƒผใƒณใ‚คใƒƒใƒˆๅณๆ™‚ๅ‰ฒๅผ•ใ‚ฏใƒผใƒใƒณใŒ้ฉ็”จใ•ใ‚ŒใŸๆœ€็ต‚่ณผๅ…ฅไพกๆ ผ", + "type": "integer", + "format": "int64" + }, + "originalToMaximumBenefitCouponPricePercentage": { + "description": "- ๅ‰ฒๅผ•็Ž‡ - > `originalPrice`ใซๅฏพใ™ใ‚‹`maximumBenefitCouponAppliedFinalPrice`ใฎๅ‰ฒๅˆ", + "type": "integer", + "format": "int32" + }, + "finalToMaximumBenefitCouponPricePercentage": { + "description": "- ๅ‰ฒๅผ•็Ž‡ -> `finalPrice`ใซๅฏพใ™ใ‚‹`maximumBenefitCouponAppliedFinalPrice`ใฎๆฏ”็Ž‡", + "type": "integer", + "format": "int32" + }, + "maximumBenefitCouponAppliedFinalPrice": { + "description": "- ๆœ€ๅคง็‰นๅ…ธใ‚ฏใƒผใƒใƒณใŒ้ฉ็”จใ•ใ‚ŒใŸๆœ€็ต‚่ณผๅ…ฅไพกๆ ผ - ใ“ใฎใƒ•ใ‚ฃใƒผใƒซใƒ‰ใฎๅ€คใŒใ€Œnullใ€ใฎๅ ดๅˆ - >ๆœ€ๅคง็‰นๅ…ธใ‚ฏใƒผใƒใƒณใŒ้ฉ็”จใ•ใ‚Œใฆใ„ใชใ„ใจ่ฆ‹ใชใ™", + "type": "integer", + "format": "int64" + } + } + }, + "SalesStatusEnum": { + "oneOf": [ + { + "const": "ACTIVE" + }, + { + "const": "ARCHIVED" + }, + { + "const": "PERMANENTLY_ARCHIVED" + } + ], + "description": "- `ACTIVE` ->่ฒฉๅฃฒไธญ - ็พๅœจ็ถ™็ถš่ฒฉๅฃฒไธญ - `ARCHIVED` ->่ฒฉๅฃฒไธญๆญข - ไปŠใฏ่ฒฉๅฃฒใ‚’ไธญๆญขใ™ใ‚‹ใŒใ€ไปŠๅพŒ่ฒฉๅฃฒใ•ใ‚Œใ‚‹ไฝ™ๅœฐใŒใ‚ใ‚‹ใ“ใจใ‚’็คบใ™ - `PERMANENTLY_ARCHIVED` ->ๆฐธไน…่ฒฉๅฃฒๅœๆญข - ใ‚‚ใ†่ฒฉๅฃฒๅ•†ๅ“ใงใฏใชใ„ใ“ใจใ‚’็คบใ™------------ - ๅ•†ๅ“ใฎ่ฒฉๅฃฒ็Šถๆ…‹ใŒใ€ŒACTIVEใ€ใงใชใ„ๅ ดๅˆใ€่ฉณ็ดฐใƒšใƒผใ‚ธใซๅ“ๅˆ‡ใ‚Œใง่กจ็คบใ™ใ‚‹ - ๅ•†ๅ“ใ‚ชใƒ—ใ‚ทใƒงใƒณใฎ่ฒฉๅฃฒ็Šถๆ…‹ใŒใ€ŒACTIVEใ€ใงใชใ„ๅ ดๅˆ- ๅ•†ๅ“ใ‚ชใƒ—ใ‚ทใƒงใƒณใ‚’ๅ…ฌ้–‹ใ—ใชใ„๏ผˆใ‚ตใƒผใƒใƒผใงใƒ•ใ‚ฃใƒซใ‚ฟใƒชใƒณใ‚ฐใ—ใฆไธ‹ใ’ใ‚‹๏ผ‰ - ใ‚ทใƒงใƒƒใƒ”ใƒณใ‚ฐใ‚ซใƒผใƒˆใงใฏๅฃฒใ‚Šๅˆ‡ใ‚Œ็Šถๆ…‹ใง่กจใ™๏ผˆใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใงๅฟ…่ฆ๏ผ‰" + }, + "ProductDiscountApplicationDto": { + "description": "- ๅ•†ๅ“ใซ้ฉ็”จใพใŸใฏ้ฉ็”จๅฏ่ƒฝใชๅ‰ฒๅผ•ๆƒ…ๅ ฑใ‚’ๆไพ›ใ™ใ‚‹ใŸใ‚ใฎDTO - ็พๅœจใฏDirectCoupon๏ผˆๅณๆ™‚ๅ‰ฒๅผ•ใ‚ฏใƒผใƒใƒณ๏ผ‰ๆƒ…ๅ ฑใฎใฟๅซใพใ‚Œใฆใ„ใพใ™ใŒใ€ไปŠๅพŒไป–ใฎๅ‰ฒๅผ•็‰นๅ…ธใŒ่ฟฝๅŠ ใ•ใ‚Œใ‚‹ใ“ใจใซใ‚ˆใ‚Š้–ข้€ฃDTOใŒ่ฟฝๅŠ ใ•ใ‚Œใ‚‹ๅฏ่ƒฝๆ€งใŒใ‚ใ‚Šใพใ™ใ€‚ๅฏ่ƒฝใซใชใ‚‹ใŸใ‚ใ€ `appliedDirectCoupon`ใฏใ‚‚ใ†ไฝฟ็”จใ—ใชใ„ใงใใ ใ•ใ„ใ€ `appliedDirectCoupons`ใ‚’ไฝฟ็”จใ™ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™", + "type": "object", + "properties": { + "appliedDirectCoupons": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppliedDirectCouponDto" + } + }, + "appliedDirectCoupon": { + "$ref": "#/components/schemas/AppliedDirectCouponDto" + }, + "maximumDiscountCouponAppliedPrice": { + "description": "- ๆœ€ๅคงใ‚ฏใƒผใƒใƒณๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸไพกๆ ผ - ใ“ใฎใƒ•ใ‚ฃใƒผใƒซใƒ‰ใฎๅ€คใŒใ€Œnullใ€ใฎๅ ดๅˆ - >ๆœ€ๅคงๅ‰ฒๅผ•ใ‚’่จˆ็ฎ—ใ™ใ‚‹ใŸใ‚ใฎๆกไปถใ‚’ๆบ€ใŸใ™ใ‚ฏใƒผใƒใƒณใŒใชใ„ใจ่ฆ‹ใชใ™", + "type": "integer", + "format": "int64" + } + } + }, + "AppliedDirectCouponDto": { + "type": "object", + "properties": { + "endAtMillis": { + "description": "ๅณๆ™‚ๅ‰ฒๅผ•ใ‚ฏใƒผใƒใƒณใฎ้ฉ็”จใŒ็ต‚ไบ†ใ—ใŸๆ™‚็‚นใ‚’็คบใ™", + "type": "integer", + "format": "int64" + } + } + }, + "ProductContentsDto": { + "type": "object", + "required": [ + "imageUrls", + "multiResolutionImages", + "descriptionPageUrl", + "measurements", + "classifications" + ], + "properties": { + "imageUrls": { + "description": "DEPRECATED", + "type": "array", + "items": { + "type": "string" + } + }, + "multiResolutionImages": { + "$ref": "#/components/schemas/MultiResolutionImageListDto" + }, + "descriptionPageUrl": { + "type": "string" + }, + "measurements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductMeasurementDto" + } + }, + "classifications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductClassificationDto" + } + }, + "announcement": { + "$ref": "#/components/schemas/ProductAnnouncementDto" + } + } + }, + "PersonalProductContentsDto": { + "type": "object", + "properties": { + "imageUrls": { + "description": "DEPRECATED", + "type": "array", + "items": { + "type": "string" + } + }, + "multiResolutionImages": { + "$ref": "#/components/schemas/MultiResolutionImageListDto" + }, + "descriptionPageUrl": { + "type": "string" + }, + "measurements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PersonalProductMeasurementDto" + } + }, + "classifications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductClassificationDto" + } + }, + "announcement": { + "$ref": "#/components/schemas/ProductAnnouncementDto" + }, + "sellerContentImages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SellerContentImagesDto" + }, + "description": "ใ‚ปใƒฉใƒผใŒ็™ป้Œฒใ—ใŸ็”ปๅƒ" + } + } + }, + "ProductMeasurementDto": { + "type": "object", + "required": [ + "type", + "unitOfLength", + "headers", + "rows" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/ProductMeasurementTypeEnum" + }, + "unitOfLength": { + "type": "string" + }, + "headers": { + "type": "array", + "items": { + "type": "string" + } + }, + "rows": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "PersonalProductMeasurementDto": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/ProductMeasurementTypeEnum" + }, + "unitOfLength": { + "type": "string" + }, + "headers": { + "type": "array", + "items": { + "type": "string" + } + }, + "rows": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "imageUrl": { + "type": "string" + } + } + }, + "ProductMeasurementTypeEnum": { + "oneOf": [ + { + "const": "SHORTS" + }, + { + "const": "SKIRT" + }, + { + "const": "PANTS" + }, + { + "const": "HOODIE" + }, + { + "const": "TSHIRTS" + }, + { + "const": "SWEATER" + }, + { + "const": "SHIRTS" + }, + { + "const": "DRESS" + }, + { + "const": "JUMPER" + }, + { + "const": "JACKET" + }, + { + "const": "PADDED_JACKET" + }, + { + "const": "COAT" + }, + { + "const": "CARDIGAN" + } + ] + }, + "ProductClassificationDto": { + "type": "object", + "required": [ + "criterionId", + "criterionText", + "elements" + ], + "properties": { + "criterionId": { + "type": "string" + }, + "criterionText": { + "type": "string" + }, + "elements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductClassificationElementDto" + } + } + } + }, + "ProductClassificationElementDto": { + "type": "object", + "required": [ + "name", + "classified" + ], + "properties": { + "name": { + "type": "string" + }, + "classified": { + "type": "boolean" + } + } + }, + "ProductAnnouncementDto": { + "type": "object", + "required": [ + "apparelProductAnnouncement", + "beautyProductAnnouncement" + ], + "properties": { + "apparelProductAnnouncement": { + "$ref": "#/components/schemas/ApparelProductAnnouncementDto" + }, + "beautyProductAnnouncement": { + "$ref": "#/components/schemas/BeautyProductAnnouncementDto" + }, + "color": { + "type": "string", + "description": "(DEPRECATED)่‰ฒ" + }, + "material": { + "type": "string", + "description": "(DEPRECATED)็ด ๆ" + }, + "measurement": { + "type": "string", + "description": "(DEPRECATED) ๅฏธๆณ•" + }, + "manufacturingCompany": { + "type": "string", + "description": "๏ผˆDEPRECATED๏ผ‰่ฃฝ้€ ไผš็คพ" + }, + "manufacturingCountry": { + "type": "string", + "description": "(DEPRECATED)่ฃฝ้€ ๅ›ฝ" + }, + "manufacturingDate": { + "type": "string", + "description": "๏ผˆDEPRECATED๏ผ‰่ฃฝ้€ ๆ—ฅ" + }, + "qaStandards": { + "type": "string", + "description": "๏ผˆDEPRECATED๏ผ‰ๅ“่ณชไฟ่จผๅŸบๆบ–" + }, + "customerCenterContact": { + "type": "string", + "description": "๏ผˆDEPRECATED๏ผ‰A / S่ฒฌไปป่€…ใจ้›ป่ฉฑ็•ชๅท" + }, + "washingAndHandling": { + "type": "string", + "description": "(DEPRECATED) ๆด—ๆฟฏๆ–นๆณ•ๅŠใณๅ–ใ‚Šๆ‰ฑใ„ๆ™‚ใฎๆณจๆ„ไบ‹้ …" + } + } + }, + "ApparelProductAnnouncementDto": { + "type": "object", + "description": "่กฃ้กž้–ข้€ฃๅ•†ๅ“ๆƒ…ๅ ฑๆไพ›ๅ‘Š็คบๆ™‚", + "required": [ + "manufacturingCompany", + "manufacturingCountry", + "qaStandards", + "customerCenterContact", + "color", + "material", + "measurement", + "manufacturingDate", + "washingAndHandling" + ], + "properties": { + "manufacturingCompany": { + "type": "string", + "description": "่ฃฝ้€ ไผš็คพ" + }, + "manufacturingCountry": { + "type": "string", + "description": "่ฃฝ้€ ๅฑ€" + }, + "qaStandards": { + "type": "string", + "description": "ๅ“่ณชไฟ่จผๅŸบๆบ–" + }, + "customerCenterContact": { + "type": "string", + "description": "A / S่ฒฌไปป่€…ใจ้›ป่ฉฑ็•ชๅท" + }, + "color": { + "type": "string", + "description": "่‰ฒ" + }, + "material": { + "type": "string", + "description": "็ด ๆ" + }, + "measurement": { + "type": "string", + "description": "ๅฏธๆณ•" + }, + "manufacturingDate": { + "type": "string", + "description": "่ฃฝ้€ ๆ—ฅ" + }, + "washingAndHandling": { + "type": "string", + "description": "ๆด—ๆฟฏๆ–นๆณ•ๅŠใณๅ–ๆ‰ฑใ„ไธŠใฎๆณจๆ„ไบ‹้ …" + } + } + }, + "BeautyProductAnnouncementDto": { + "type": "object", + "description": "ๅŒ–็ฒงๅ“๏ผˆ็พŽๅฎน๏ผ‰้–ข้€ฃๅ•†ๅ“ๆƒ…ๅ ฑๆไพ›ๅ‘Š็คบๆ™‚", + "required": [ + "manufacturingCompany", + "manufacturingCountry", + "qaStandards", + "customerCenterContact", + "size", + "responsibleSellerCompany", + "usage", + "highlights", + "concerns", + "expiration", + "ingredients", + "mfdsReview" + ], + "properties": { + "manufacturingCompany": { + "type": "string", + "description": "่ฃฝ้€ ไผš็คพ" + }, + "manufacturingCountry": { + "type": "string", + "description": "่ฃฝ้€ ๅฑ€" + }, + "qaStandards": { + "type": "string", + "description": "ๅ“่ณชไฟ่จผๅŸบๆบ–" + }, + "customerCenterContact": { + "type": "string", + "description": "A / S่ฒฌไปป่€…ใจ้›ป่ฉฑ็•ชๅท" + }, + "size": { + "type": "string", + "description": "ๅŒ–็ฒงๅ“ๅฎน้‡" + }, + "responsibleSellerCompany": { + "type": "string", + "description": "ๅŒ–็ฒงๅ“่ฒฌไปป่ฒฉๅฃฒๆฅญ่€…" + }, + "usage": { + "type": "string", + "description": "ไฝฟ็”จๆ–นๆณ•" + }, + "highlights": { + "type": "string", + "description": "่ฃฝๅ“ใฎไธปใชไป•ๆง˜" + }, + "concerns": { + "type": "string", + "description": "ไฝฟ็”จๆ™‚ใฎๆณจๆ„ไบ‹้ …" + }, + "expiration": { + "type": "string", + "description": "ไฝฟ็”จๆœŸ้™ใพใŸใฏ้–‹ๅฐๅพŒใฎไฝฟ็”จๆœŸ้™" + }, + "ingredients": { + "type": "string", + "description": "ๆˆๅˆ†๏ผˆๅŒ–็ฒงๅ“ๆณ•ใซใ‚ˆใ‚Š่จ˜่ผ‰ใ€่กจ็คบใ—ใชใ‘ใ‚Œใฐใชใ‚‰ใชใ„ใ™ในใฆใฎๆˆๅˆ†๏ผ‰" + }, + "mfdsReview": { + "type": "string", + "description": "้ฃŸๅ“ๅŒป่–ฌๅ“ๅฎ‰ๅ…จๆ‹…ๅฝ“่€…ใฎๅฏฉๆŸปใŒๅฟ…่ฆใ‹ใฉใ†ใ‹๏ผˆMFDS = Ministry of Food and Drug Safety๏ผ‰" + } + } + }, + "ProductSetDto": { + "type": "object", + "required": [ + "set", + "favoriteIds", + "freeReturnTargetProductIds" + ], + "properties": { + "set": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDto" + } + }, + "favoriteIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "freeReturnTargetProductIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ProductListDto": { + "type": "object", + "required": [ + "list", + "favoriteIds", + "last", + "freeReturnTargetProductIds" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDto" + } + }, + "favoriteIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + }, + "freeReturnTargetProductIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "FilteredPersonalizedProductRequestDto": { + "type": "object", + "required": [ + "size" + ], + "properties": { + "orderBy": { + "$ref": "#/components/schemas/ProductOrderByEnum" + }, + "cursor": { + "type": "string" + }, + "size": { + "type": "integer", + "format": "int32" + }, + "categoryId": { + "type": "string" + }, + "brandId": { + "type": "string" + }, + "minPrice": { + "type": "integer", + "format": "int64" + }, + "maxPrice": { + "type": "integer", + "format": "int64" + }, + "ageGroupCode": { + "$ref": "#/components/schemas/AgeGroupCodeEnum" + }, + "mySizeOnly": { + "type": "boolean", + "default": false + }, + "tag": { + "$ref": "#/components/schemas/ProductTagEnum" + }, + "tagId": { + "type": "integer", + "description": "(deprecated) use tagIdForBrandSourcing", + "format": "int64" + }, + "tagIdForBrandSourcing": { + "description": "tagIdใซๅฏพๅฟœใ™ใ‚‹BrandSourcingใซใคใ„ใฆๅ•†ๅ“ใ‚’็…งไผšใ™ใ‚‹", + "type": "integer", + "format": "int64" + }, + "recentlyClickedProducts": { + "type": "array", + "description": "ๆœ€่ฟ‘ใ‚ฏใƒชใƒƒใ‚ฏใ•ใ‚ŒใŸๅ•†ๅ“ใซ้–ขใ™ใ‚‹ๆƒ…ๅ ฑใ€‚ *ๆœฌๆ•ฐใฏ100ใ‚’่ถ…ใˆใ‚‹ใ“ใจใฏใงใใพใ›ใ‚“ใ€‚*", + "items": { + "$ref": "#/components/schemas/ClickedProductDto" + } + }, + "modelId": { + "type": "string", + "description": "- ใฉใฎใƒ‘ใƒผใ‚ฝใƒŠใƒฉใ‚คใ‚บใƒขใƒ‡ใƒซใ‚’ไฝฟ็”จใ™ใ‚‹ใ‹ใ€‚ (A/B Testing ็”จ้€”) - ใƒŽใƒƒใ‚ทใƒงใƒณใƒŽใƒผใƒˆ: https://www.notion.so/rapportlabs/AB-Protocol-c878d879ff0443cda929bb17d9b137c1" + }, + "postProcessingId": { + "type": "string", + "description": "- ๅ€‹ไบบๅŒ–็ตๆžœใฎๅพŒๅ‡ฆ็†ใ‚’ใฉใ†ใ™ใ‚‹ใ‹ใ€‚ (A/B Testing ็”จ้€”) - ใƒŽใƒƒใ‚ทใƒงใƒณใƒŽใƒผใƒˆ: https://www.notion.so/rapportlabs/AB-Protocol-c878d879ff0443cda929bb17d9b137c1" + } + } + }, + "ClickedProductDto": { + "type": "object", + "required": [ + "id", + "clickedAtMillis" + ], + "properties": { + "id": { + "type": "string" + }, + "clickedAtMillis": { + "type": "integer", + "format": "int64", + "description": "ๅ•†ๅ“ใŒใ‚ฏใƒชใƒƒใ‚ฏใ•ใ‚ŒใŸๆ™‚้–“๏ผˆใƒŸใƒชใ‚น๏ผ‰" + } + } + }, + "AppProductListDto": { + "type": "object", + "required": [ + "list", + "favoriteIds", + "last", + "freeReturnTargetProductIds" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppProductDto" + } + }, + "favoriteIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + }, + "productAggregation": { + "$ref": "#/components/schemas/ProductAggregationDto" + }, + "freeReturnTargetProductIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "AppAdvertisementProductListDto": { + "type": "object", + "required": [ + "favoriteIds", + "list", + "totalPageCount", + "totalElementCount", + "freeReturnTargetProductIds" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppAdvertisementProductDto" + } + }, + "favoriteIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "totalPageCount": { + "type": "integer", + "format": "int32" + }, + "totalElementCount": { + "type": "integer", + "format": "int64" + }, + "freeReturnTargetProductIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PersonalProductDto": { + "type": "object", + "required": [ + "product", + "favorite", + "freeReturnTarget", + "discountInfo" + ], + "properties": { + "product": { + "$ref": "#/components/schemas/ProductDto" + }, + "favorite": { + "type": "boolean" + }, + "categoriesFromRoot": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + }, + "contents": { + "$ref": "#/components/schemas/PersonalProductContentsDto" + }, + "mappedBrand": { + "$ref": "#/components/schemas/BrandDto" + }, + "discountInfo": { + "$ref": "#/components/schemas/ProductDiscountApplicationDto" + }, + "freeReturnTarget": { + "type": "boolean" + } + } + }, + "HomeProductCategoryDto": { + "type": "object", + "required": [ + "topSideCategories", + "bottomSideCategories" + ], + "properties": { + "topSideCategories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + }, + "bottomSideCategories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + } + } + }, + "ProductCategoryDto": { + "type": "object", + "required": [ + "id", + "title" + ], + "properties": { + "id": { + "type": "string" + }, + "parentId": { + "type": "string" + }, + "title": { + "type": "string" + }, + "iconUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionIcon": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + } + } + }, + "MallDto": { + "type": "object", + "required": [ + "mallId", + "title" + ], + "properties": { + "mallId": { + "type": "string" + }, + "title": { + "type": "string" + }, + "logoUrl": { + "type": "string" + }, + "logo2xUrl": { + "type": "string" + }, + "logo3xUrl": { + "type": "string" + } + } + }, + "FavoriteProductDto": { + "type": "object", + "required": [ + "id", + "mallId", + "mallName", + "mallProductCode", + "itemImageUri", + "itemThumbnailUri", + "brandName", + "productName", + "productDiscountRate", + "price", + "productPriceDetail", + "shopUri", + "createdAt" + ], + "properties": { + "id": { + "type": "string" + }, + "mallId": { + "type": "string" + }, + "mallName": { + "type": "string" + }, + "mallProductCode": { + "type": "string" + }, + "itemImageUri": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionItemImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "itemThumbnailUri": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionItemThumbnail": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "brandName": { + "type": "string" + }, + "productName": { + "type": "string" + }, + "productDiscountRate": { + "type": "integer", + "format": "int32" + }, + "originalPrice": { + "type": "integer", + "format": "int64" + }, + "price": { + "type": "integer", + "format": "int64" + }, + "productPriceDetail": { + "$ref": "#/components/schemas/ProductPriceDetailDto" + }, + "shopUri": { + "type": "string" + }, + "shopLogoUri": { + "type": "string" + }, + "createdAt": { + "type": "string" + } + } + }, + "FavoriteProductListDto": { + "type": "object", + "required": [ + "list", + "last", + "freeReturnTargetProductIds" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FavoriteProductDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + }, + "freeReturnTargetProductIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ProductItemListDto": { + "type": "object", + "required": [ + "options", + "optionElements", + "productItems" + ], + "properties": { + "options": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OptionDto" + } + }, + "optionElements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OptionElementDto" + } + }, + "productItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductItemDto" + } + } + } + }, + "ProductReleaseEstimateDto": { + "type": "object", + "required": [ + "productId", + "itemReleaseEstimateAtList" + ], + "properties": { + "productId": { + "type": "string", + "description": "ๅ•†ๅ“ID" + }, + "itemReleaseEstimateAtList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductItemReleaseEstimateDto" + } + } + } + }, + "ProductItemReleaseEstimateDto": { + "type": "object", + "required": [ + "productItemId", + "releaseEstimateAt" + ], + "properties": { + "productItemId": { + "type": "string", + "description": "ๅ•†ๅ“ใ‚ชใƒ—ใ‚ทใƒงใƒณID" + }, + "itemReleaseEstimateAtMillis": { + "type": "integer", + "format": "int64", + "description": "yyyy-mm-ddๅฝขๅผใฎๅ‡บ่ทๆ—ฅ" + } + } + }, + "ProductItemDto": { + "type": "object", + "required": [ + "id", + "title", + "optionElementIds", + "price", + "display", + "salesStatus", + "mallProductItemCode" + ], + "properties": { + "id": { + "type": "string" + }, + "title": { + "type": "string" + }, + "releaseAtEstimate": { + "type": "string", + "description": "yyyy-mm-ddๅฝขๅผใฎๅ‡บ่ทๆ—ฅ" + }, + "optionElementIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "maxQuantity": { + "type": "integer", + "format": "int64" + }, + "price": { + "type": "integer", + "format": "int64" + }, + "display": { + "type": "boolean", + "description": "- ๅ•†ๅ“ใ‚ชใƒ—ใ‚ทใƒงใƒณใฎ้œฒๅ‡บๅฏๅฆใ‚’็คบใ™ - falseใฎๅ ดๅˆใ€ๅœจๅบซๅˆ‡ใ‚Œใฎ็Šถๆ…‹ใง่กจ็คบ" + }, + "salesStatus": { + "$ref": "#/components/schemas/SalesStatusEnum" + }, + "mallProductItemCode": { + "type": "string" + } + } + }, + "OptionDto": { + "type": "object", + "required": [ + "title" + ], + "properties": { + "title": { + "type": "string" + } + } + }, + "OptionElementDto": { + "type": "object", + "required": [ + "id", + "title" + ], + "properties": { + "id": { + "type": "string" + }, + "title": { + "type": "string" + } + } + }, + "ProductItemAvailabilityDto": { + "type": "object", + "required": [ + "productId", + "productItemId", + "available" + ], + "properties": { + "productId": { + "type": "string" + }, + "productItemId": { + "type": "string" + }, + "quantity": { + "description": "- ๅ•†ๅ“ใ‚ชใƒ—ใ‚ทใƒงใƒณๅœจๅบซ - ใ“ใฎๅ€คใŒ `null` ใฎๅ ดๅˆ -> ๅ†…้ƒจ็š„ใซๅœจๅบซใŒ็„กๅˆถ้™ใจใฟใชใ•ใ‚Œใ‚‹ - ใ“ใฎๅ€คใ ใ‘ใงใฏๅ•†ๅ“ใฎ่ณผๅ…ฅๅฏๅฆใ‚’ๅˆคๆ–ญใงใใชใ„ -> `ProductItemAvailabilityDto.available` ๅ€คใŒ้‡่ฆ", + "type": "integer", + "format": "int64" + }, + "available": { + "description": "ๅ•†ๅ“่ณผๅ…ฅๅฏๅฆ๏ผˆproduct๏ฝžproduct itemใฎๅ€คใ‹ใ‚‰่จˆ็ฎ—ใ•ใ‚ŒใŸๅ€ค๏ผ‰", + "type": "boolean" + } + } + }, + "BrandListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BrandDto" + } + } + } + }, + "BrandDto": { + "type": "object", + "required": [ + "id", + "name", + "logo" + ], + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "logo": { + "$ref": "#/components/schemas/BrandLogoDto" + } + } + }, + "BrandLogoDto": { + "type": "object", + "properties": { + "landscapeUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionLandscape": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "squareUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionSquare": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + } + } + }, + "BrandDetailDto": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "logo": { + "$ref": "#/components/schemas/BrandLogoDto" + }, + "categories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryDto" + } + } + } + }, + "BrandProductsDto": { + "type": "object", + "required": [ + "brand", + "list" + ], + "properties": { + "brand": { + "$ref": "#/components/schemas/BrandDto" + }, + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDto" + } + } + } + }, + "BrandProductsListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BrandProductsDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "AddToCartRequestDto": { + "type": "object", + "required": [ + "items" + ], + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AddCartItemDto" + } + } + } + }, + "AddToCartResponseDto": { + "type": "object", + "required": [ + "cartItemIds" + ], + "properties": { + "cartItemIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + } + } + }, + "AddCartItemDto": { + "type": "object", + "required": [ + "productItemId", + "quantity" + ], + "properties": { + "productItemId": { + "type": "string" + }, + "quantity": { + "type": "integer", + "format": "int64" + } + } + }, + "DeleteCartItemsRequestDto": { + "type": "object", + "required": [ + "cartItemIds" + ], + "properties": { + "cartItemIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + } + } + }, + "CartItemGroupDto": { + "type": "object", + "required": [ + "groupId", + "brand", + "delivery", + "items" + ], + "properties": { + "groupId": { + "type": "string" + }, + "brand": { + "$ref": "#/components/schemas/BrandDto" + }, + "delivery": { + "$ref": "#/components/schemas/CartItemGroupDeliveryPolicyDto" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartItemDto" + } + } + } + }, + "CartItemGroupDeliveryPolicyDto": { + "type": "object", + "required": [ + "defaultPrice", + "defaultReturnCost", + "shippingCostPolicy", + "returnCostPolicy", + "logisticsPolicy", + "assorted", + "shippingPolicyId" + ], + "properties": { + "defaultPrice": { + "type": "integer", + "format": "int64", + "description": "DEPRECATED -> use `shippingCostPolicy`" + }, + "requiredAmountForFree": { + "type": "integer", + "format": "int64", + "description": "DEPRECATED -> use `shippingCostPolicy`" + }, + "defaultReturnCost": { + "type": "integer", + "format": "int64", + "description": "DEPRECATED -> use `returnCostPolicy`" + }, + "shippingCostPolicy": { + "$ref": "#/components/schemas/ShippingCostPolicyDto" + }, + "returnCostPolicy": { + "$ref": "#/components/schemas/ReturnCostPolicyDto" + }, + "logisticsPolicy": { + "$ref": "#/components/schemas/LogisticsPolicyDto" + }, + "assorted": { + "type": "boolean" + }, + "shippingPolicyId": { + "type": "integer", + "format": "int64" + } + } + }, + "DeliveryPolicyDto": { + "type": "object", + "required": [ + "defaultPrice", + "defaultReturnCost", + "shippingCostPolicy", + "returnCostPolicy", + "logisticsPolicy" + ], + "properties": { + "defaultPrice": { + "type": "integer", + "format": "int64", + "description": "DEPRECATED -> use `shippingCostPolicy`" + }, + "requiredAmountForFree": { + "type": "integer", + "format": "int64", + "description": "DEPRECATED -> use `shippingCostPolicy`" + }, + "defaultReturnCost": { + "type": "integer", + "format": "int64", + "description": "DEPRECATED -> use `returnCostPolicy`" + }, + "shippingCostPolicy": { + "$ref": "#/components/schemas/ShippingCostPolicyDto" + }, + "returnCostPolicy": { + "$ref": "#/components/schemas/ReturnCostPolicyDto" + }, + "logisticsPolicy": { + "$ref": "#/components/schemas/LogisticsPolicyDto" + } + } + }, + "ShippingCostPolicyDto": { + "type": "object", + "description": "้€ๆ–™ใƒใƒชใ‚ทใƒผ", + "required": [ + "defaultCost", + "jejuIsland", + "backCountry" + ], + "properties": { + "defaultCost": { + "type": "integer", + "format": "int64" + }, + "jejuIsland": { + "type": "integer", + "format": "int64", + "description": "ๆธˆๅทžๅณถ่ฟฝๅŠ ้€ๆ–™" + }, + "backCountry": { + "type": "integer", + "format": "int64", + "description": "ๅ›ณๆ›ธๅฑฑ้–“่ฟฝๅŠ ้€ๆ–™" + }, + "requiredAmountForFree": { + "type": "integer", + "format": "int64", + "description": "้€ๆ–™็„กๆ–™ใฎๆœ€ๅฐ่ณผๅ…ฅ้‡‘้ก" + } + } + }, + "ReturnCostPolicyDto": { + "type": "object", + "description": "่ฟ”ๅ“่ฒปใƒใƒชใ‚ทใƒผ", + "required": [ + "defaultCost", + "jejuIsland", + "backCountry" + ], + "properties": { + "defaultCost": { + "type": "integer", + "format": "int64", + "description": "additionalCostใŒ่€ƒๆ…ฎใ•ใ‚Œใฆใ„ใชใ„ๅŸบๆœฌ่ฟ”ๅ“่ฒป็”จ" + }, + "jejuIsland": { + "type": "integer", + "format": "int64", + "description": "ๆธˆๅทžๅณถ่ฟฝๅŠ ่ฟ”ๅ“ๆ–™้‡‘" + }, + "backCountry": { + "type": "integer", + "format": "int64", + "description": "ๅ›ณๆ›ธๅฑฑ้–“่ฟฝๅŠ ่ฟ”ๅ“่ฒป" + } + } + }, + "LogisticsPolicyDto": { + "type": "object", + "properties": { + "shippingPlace": { + "type": "string", + "description": "ๅ‡บๅบซๅ…ˆไฝๆ‰€" + }, + "returnPlace": { + "type": "string", + "description": "่ฟ”ๅ“ๅ…ˆไฝๆ‰€" + }, + "courier": { + "deprecated": true, + "type": "string", + "description": "- DEPRECATED - `vendor`ใƒ•ใ‚ฃใƒผใƒซใƒ‰ใ‚’ไฝฟ็”จใ—ใฆใใ ใ•ใ„ - ๅˆฉ็”จๅฎ…้…ไพฟไผš็คพ" + }, + "vendor": { + "$ref": "#/components/schemas/LogisticsVendorEnum" + } + } + }, + "LogisticsVendorEnum": { + "oneOf": [ + { + "const": "CJ๋Œ€ํ•œํ†ต์šด" + }, + { + "const": "๋กœ์  ํƒ๋ฐฐ" + }, + { + "const": "์šฐ์ฒด๊ตญํƒ๋ฐฐ" + }, + { + "const": "ํ•œ์ง„ํƒ๋ฐฐ" + }, + { + "const": "๋กฏ๋ฐํƒ๋ฐฐ" + }, + { + "const": "๋Œ€์‹ ํƒ๋ฐฐ" + }, + { + "const": "์ผ์–‘ํƒ๋ฐฐ" + }, + { + "const": "๊ฒฝ๋™ํƒ๋ฐฐ" + }, + { + "const": "ํ•ฉ๋™ํƒ๋ฐฐ" + }, + { + "const": "์ฒœ์ผํƒ๋ฐฐ" + }, + { + "const": "GSํŽธ์˜์ ํƒ๋ฐฐ" + }, + { + "const": "ํ•œ์˜์‚ฌ๋ž‘ํƒ๋ฐฐ" + }, + { + "const": "๊ฑด์˜ํƒ๋ฐฐ" + }, + { + "const": "ํ˜ธ๋‚จํƒ๋ฐฐ" + }, + { + "const": "SLX" + }, + { + "const": "CUํŽธ์˜์ ํƒ๋ฐฐ" + }, + { + "const": "์šฉ๋งˆ๋กœ์ง€์Šค" + }, + { + "const": "์„ธ๋ฐฉํƒ๋ฐฐ" + }, + { + "const": "์›๋”์Šคํ€ต" + }, + { + "const": "๋†ํ˜‘ํƒ๋ฐฐ" + }, + { + "const": "HIํƒ๋ฐฐ" + }, + { + "const": "ํ™ˆํ”ฝํƒ๋ฐฐ" + }, + { + "const": "CJ๋Œ€ํ•œํ†ต์šด๊ตญ์ œํŠน์†ก" + }, + { + "const": "EMS" + }, + { + "const": "๋กฏ๋ฐ๊ธ€๋กœ๋ฒŒ" + }, + { + "const": "ํ•œ๋ฑ์Šค" + }, + { + "const": "DHL" + }, + { + "const": "FEDEX" + }, + { + "const": "UPS" + }, + { + "const": "TNT" + }, + { + "const": "๋ฒ”ํ•œํŒํ† ์Šค" + }, + { + "const": "ACI Express" + }, + { + "const": "ACE Express" + }, + { + "const": "์€ํ•˜์‰ฌํ•‘" + }, + { + "const": "๋‘๋ฐœํžˆ์–ด๋กœ" + }, + { + "const": "๋กœ์ง€์ŠคํŒŸ" + }, + { + "const": "๋ถ€๋ฆ‰(VROONG)" + }, + { + "const": "์ดํˆฌ๋งˆ์Šค" + }, + { + "const": "์—์ด์Šค๋ฌผ๋ฅ˜" + }, + { + "const": "๋Œ€๋ฆผํ†ต์šด" + }, + { + "const": "๋ฐœ๋ ‰์Šค" + }, + { + "const": "๊ธฐํƒ€๋ฐฐ์†ก์‚ฌ" + }, + { + "const": "์ง์ ‘๋ฐฐ์†ก" + } + ], + "description": "- ๏ผˆ้…้€ใƒใƒชใ‚ทใƒผ้–ข้€ฃ๏ผ‰่จญๅฎšๅฏ่ƒฝใชๅฎ…้…ไผš็คพ - ใ€ŒETC๏ผˆใใฎไป–้…้€ไผš็คพ๏ผ‰ใ€ - >็‰นๅฎšใฎ้…้€ไผš็คพใ‚’ไฝฟ็”จใ—ใฆใ„ใพใ™ใŒใ€็พๅœจใ‚ตใƒใƒผใƒˆใ—ใฆใ„ใชใ„ๅฎ…้…ไผš็คพ๏ผˆใใฎไป–้…้€ไผš็คพใฎใ‚ตใƒใƒผใƒˆใŒๅฟ…่ฆใชๅ ดๅˆใฏใ€ๅˆฅ้€”ใŠๅ•ใ„ๅˆใ‚ใ›ใใ ใ•ใ„๏ผ‰ - ` SELF_MANAGED๏ผˆ็›ดๆŽฅ้…้€๏ผ‰`->็›ดๆŽฅ้…้€ใ™ใ‚‹ๅ ดๅˆใซไฝฟ็”จ", + "x-enum-varnames": [ + "CJ_GLS", + "LOGEN", + "EPOST", + "HANJIN", + "LOTTE", + "DAESIN", + "ILYANG", + "KYUNGDONG", + "HAPDONG", + "CHUNIL", + "CVSNET", + "HPL", + "KUNYOUNG", + "HONAM", + "SLX", + "BGF", + "YONGMA", + "SEBANG", + "WONDERS", + "NH_LOGIS", + "HI_LOGIS", + "HOMEPICK", + "KOREX_G", + "EMS", + "LOTTE_GLOBAL", + "HANDEX", + "DHL", + "FEDEX", + "UPS", + "TNT", + "PANTOS", + "ACI_EXPRESS", + "ACE_EXP", + "EUNHA", + "CHAIN_LOGISTICS", + "LOGISPOT", + "VROONG", + "ETOMARS", + "VENDORPIA", + "DAERIM", + "VALEX", + "ETC", + "SELF_MANAGED" + ] + }, + "CartItemDto": { + "type": "object", + "description": "- `product.salesStatus != ACTIVE || product.display == false` ใฎๅ ดๅˆ -> ๅœจๅบซๅˆ‡ใ‚Œใง่กจ็คบ - `productItem.salesStatus != ACTIVE || productItem.display == false` ใฎๅ ดๅˆ -> ๅœจๅบซๅˆ‡ใ‚Œใง่กจ็คบ - ใ‚ฏใ‚คใƒผใƒณใ‚คใƒƒใƒˆๅณๆ™‚ๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸๅ ดๅˆ `ProductDto` ใง็›ดใกใซๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸ้‡‘้กใ‚’่กจ็คบใ™ใ‚‹ - ๅฝฑ้Ÿฟใ‚’ๅ—ใ‘ใ‚‹ใƒ•ใ‚ฃใƒผใƒซใƒ‰: `finalPrice`, `discountPercentage`", + "required": [ + "id", + "product", + "productItem", + "quantity", + "brand", + "freeReturnTarget" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "product": { + "$ref": "#/components/schemas/ProductDto" + }, + "productItem": { + "$ref": "#/components/schemas/ProductItemDto" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "brand": { + "$ref": "#/components/schemas/BrandDto" + }, + "freeReturnTarget": { + "type": "boolean" + } + } + }, + "PurchaseTopicEnum": { + "const": "PRODUCT" + }, + "StartOrderRequestDto": { + "type": "object", + "required": [ + "cartItemIds" + ], + "properties": { + "cartItemIds": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + } + } + }, + "StartOrderFromAddingRequestDto": { + "type": "object", + "required": [ + "items" + ], + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AddCartItemDto" + } + } + } + }, + "DeliveryAddressDto": { + "type": "object", + "required": [ + "recipientName", + "phoneNumber", + "zipCode", + "address", + "detailedAddress" + ], + "properties": { + "recipientName": { + "type": "string" + }, + "phoneNumber": { + "type": "string" + }, + "zipCode": { + "type": "string", + "description": "5ๆกใ€ๅ›ฝๅฎถๅŸบ็คŽๅŒบๅŸŸ็•ชๅท (State Basic District Number)" + }, + "address": { + "type": "string" + }, + "detailedAddress": { + "type": "string" + } + } + }, + "UserRefundAccountDto": { + "type": "object", + "properties": { + "refundAccount": { + "$ref": "#/components/schemas/RefundAccountDto" + } + } + }, + "RefundAccountDto": { + "type": "object", + "required": [ + "accountNumber", + "bank", + "holderName" + ], + "properties": { + "accountNumber": { + "type": "string" + }, + "bank": { + "$ref": "#/components/schemas/RefundAccountBankEnum" + }, + "holderName": { + "type": "string" + } + } + }, + "ConnectPayPromotionDto": { + "type": "object", + "required": [ + "discountCards", + "interestFreeCards" + ], + "properties": { + "discountCards": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConnectPayDiscountCardDto" + } + }, + "interestFreeCards": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConnectPayInterestFreeCardsDto" + } + } + } + }, + "ConnectPayDiscountCardDto": { + "type": "object", + "required": [ + "card", + "minimumPaymentAmount", + "discountCode", + "discountAmount" + ], + "properties": { + "card": { + "$ref": "#/components/schemas/TossPaymentCardEnum" + }, + "minimumPaymentAmount": { + "type": "integer", + "format": "int64" + }, + "maximumPaymentAmount": { + "type": "integer", + "format": "int64" + }, + "discountCode": { + "description": "discount code should be passed when request payment with connect-pay", + "type": "string" + }, + "discountAmount": { + "type": "integer", + "format": "int64" + } + } + }, + "ConnectPayInterestFreeCardsDto": { + "type": "object", + "required": [ + "card", + "interestFreeMonths", + "minimumPaymentAmount" + ], + "properties": { + "card": { + "$ref": "#/components/schemas/TossPaymentCardEnum" + }, + "interestFreeMonths": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + } + }, + "minimumPaymentAmount": { + "type": "integer", + "format": "int64" + } + } + }, + "TossPaymentPromotionDto": { + "type": "object", + "required": [ + "discountCards", + "interestFreeCards" + ], + "properties": { + "discountCards": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TossPaymentDiscountPolicyDto" + } + }, + "interestFreeCards": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TossPaymentInterestFreePolicyDto" + } + } + } + }, + "TossPaymentDiscountPolicyDto": { + "type": "object", + "required": [ + "card", + "minimumPaymentAmount", + "discountCode", + "discountAmount" + ], + "properties": { + "card": { + "$ref": "#/components/schemas/TossPaymentCardEnum" + }, + "minimumPaymentAmount": { + "type": "integer", + "format": "int64" + }, + "maximumPaymentAmount": { + "type": "integer", + "format": "int64" + }, + "discountCode": { + "description": "discount code should be passed when request payment with toss", + "type": "string" + }, + "discountAmount": { + "type": "integer", + "format": "int64" + } + } + }, + "TossPaymentInterestFreePolicyDto": { + "type": "object", + "required": [ + "card", + "installmentFreeMonths", + "minimumPaymentAmount" + ], + "properties": { + "card": { + "$ref": "#/components/schemas/TossPaymentCardEnum" + }, + "installmentFreeMonths": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + } + }, + "minimumPaymentAmount": { + "type": "integer", + "format": "int64" + } + } + }, + "TossPaymentAccountEnum": { + "oneOf": [ + { + "const": "๋†ํ˜‘" + }, + { + "const": "์šฐ๋ฆฌ" + }, + { + "const": "์‹ ํ•œ" + }, + { + "const": "๊ตญ๋ฏผ" + }, + { + "const": "ํ•˜๋‚˜" + }, + { + "const": "์”จํ‹ฐ" + }, + { + "const": "๊ธฐ์—…" + }, + { + "const": "์‚ฐ์—…" + }, + { + "const": "์ œ์ผ" + }, + { + "const": "๋Œ€๊ตฌ" + }, + { + "const": "๋ถ€์‚ฐ" + }, + { + "const": "์ „๋ถ" + }, + { + "const": "๊ฒฝ๋‚จ" + }, + { + "const": "์ œ์ฃผ" + }, + { + "const": "๊ด‘์ฃผ" + }, + { + "const": "์ƒˆ๋งˆ์„" + }, + { + "const": "์ˆ˜ํ˜‘" + }, + { + "const": "์‹ ํ˜‘" + }, + { + "const": "์šฐ์ฒด๊ตญ" + }, + { + "const": "์ผ€์ด" + }, + { + "const": "์นด์นด์˜ค" + }, + { + "const": "์ €์ถ•" + }, + { + "const": "์‚ฐ๋ฆผ" + }, + { + "const": "UNKNOWN" + } + ], + "x-enum-varnames": [ + "NONGHYUP", + "WOORI", + "SHINHAN", + "KOOKMIN", + "HANA", + "CITI", + "INDUSTRIAL", + "KDB", + "SC", + "DAEGU", + "BUSAN", + "JEONBUK", + "KYONGNAM", + "JEJU", + "KWANGJU", + "SAEMAEUL", + "SUHYUP", + "SHINHYUP", + "POST", + "K_BANK", + "KAKAO_BANK", + "SAVING_SB", + "FORESTRY_SJ", + "UNKNOWN" + ] + }, + "TossPaymentCardEnum": { + "oneOf": [ + { + "const": "์‹ ํ•œ" + }, + { + "const": "ํ˜„๋Œ€" + }, + { + "const": "์‚ผ์„ฑ" + }, + { + "const": "์šฐ๋ฆฌ" + }, + { + "const": "๊ตญ๋ฏผ" + }, + { + "const": "๋กฏ๋ฐ" + }, + { + "const": "๋†ํ˜‘" + }, + { + "const": "ํ•˜๋‚˜" + }, + { + "const": "BC" + }, + { + "const": "์”จํ‹ฐ" + }, + { + "const": "์นด์นด์˜ค๋ฑ…ํฌ" + }, + { + "const": "KDB" + }, + { + "const": "์ˆ˜ํ˜‘" + }, + { + "const": "์ „๋ถ" + }, + { + "const": "์šฐ์ฒด๊ตญ" + }, + { + "const": "์ƒˆ๋งˆ์„" + }, + { + "const": "์ €์ถ•" + }, + { + "const": "์ œ์ฃผ" + }, + { + "const": "๊ด‘์ฃผ" + }, + { + "const": "์‹ ํ˜‘" + }, + { + "const": "JCB" + }, + { + "const": "์œ ๋‹ˆ์˜จํŽ˜์ด" + }, + { + "const": "๋งˆ์Šคํ„ฐ" + }, + { + "const": "๋น„์ž" + }, + { + "const": "๋‹ค์ด๋„ˆ์Šค" + }, + { + "const": "๋””์Šค์ปค๋ฒ„" + }, + { + "const": "UNKNOWN" + } + ], + "x-enum-varnames": [ + "SHINHAN", + "HYUNDAI", + "SAMSUNG", + "WOORI", + "KOOKMIN", + "LOTTE", + "NONGHYUP", + "HANA", + "BC", + "CITI", + "KAKAO_BANK", + "KDB", + "SUHYUP", + "JEONBUK", + "POST", + "SAEMAEUL", + "SAVING_SB", + "JEJU", + "KWANGJU", + "SHINHYUP", + "JCB", + "UNION_PAY", + "MASTER_CARD", + "VISA", + "DINERS_CLUB", + "DISCOVER", + "UNKNOWN" + ] + }, + "RefundAccountBankEnum": { + "oneOf": [ + { + "const": "๋†ํ˜‘" + }, + { + "const": "๊ตญ๋ฏผ" + }, + { + "const": "์šฐ๋ฆฌ" + }, + { + "const": "์‹ ํ•œ" + }, + { + "const": "๊ธฐ์—…" + }, + { + "const": "ํ•˜๋‚˜" + }, + { + "const": "๊ฒฝ๋‚จ" + }, + { + "const": "๋Œ€๊ตฌ" + }, + { + "const": "๋ถ€์‚ฐ" + }, + { + "const": "์ˆ˜ํ˜‘" + }, + { + "const": "์šฐ์ฒด๊ตญ" + }, + { + "const": "์‚ฐ์—…" + }, + { + "const": "SC์ œ์ผ" + }, + { + "const": "์”จํ‹ฐ" + }, + { + "const": "๊ด‘์ฃผ" + }, + { + "const": "์ œ์ฃผ" + }, + { + "const": "์ „๋ถ" + }, + { + "const": "์ƒˆ๋งˆ์„" + }, + { + "const": "์‹ ํ˜‘" + }, + { + "const": "์ผ€์ด" + }, + { + "const": "์นด์นด์˜ค" + } + ], + "x-enum-varnames": [ + "NONGHYUP", + "KOOKMIN", + "WOORI", + "SHINHAN", + "INDUSTRIAL", + "HANA", + "KYONGNAM", + "DAEGU", + "BUSAN", + "SUHYUP", + "POST", + "KDB", + "SC", + "CITI", + "KWANGJU", + "JEJU", + "JEONBUK", + "SAEMAEUL", + "SHINHYUP", + "K_BANK", + "KAKAO_BANK" + ] + }, + "BankNameEnum": { + "oneOf": [ + { + "const": "๋†ํ˜‘" + }, + { + "const": "๊ตญ๋ฏผ" + }, + { + "const": "์šฐ๋ฆฌ" + }, + { + "const": "์‹ ํ•œ" + }, + { + "const": "๊ธฐ์—…" + }, + { + "const": "ํ•˜๋‚˜" + }, + { + "const": "๊ฒฝ๋‚จ" + }, + { + "const": "๋Œ€๊ตฌ" + }, + { + "const": "๋ถ€์‚ฐ" + }, + { + "const": "์ˆ˜ํ˜‘" + }, + { + "const": "์šฐ์ฒด๊ตญ" + }, + { + "const": "์‚ฐ์—…" + }, + { + "const": "SC์ œ์ผ" + }, + { + "const": "์”จํ‹ฐ" + }, + { + "const": "๊ด‘์ฃผ" + }, + { + "const": "์ œ์ฃผ" + }, + { + "const": "์ „๋ถ" + }, + { + "const": "์ƒˆ๋งˆ์„" + }, + { + "const": "์‹ ํ˜‘" + }, + { + "const": "์ผ€์ด" + }, + { + "const": "์นด์นด์˜ค" + } + ], + "description": "้Š€่กŒๅ", + "x-enum-varnames": [ + "NONGHYUP", + "KOOKMIN", + "WOORI", + "SHINHAN", + "INDUSTRIAL", + "HANA", + "KYONGNAM", + "DAEGU", + "BUSAN", + "SUHYUP", + "POST", + "KDB", + "SC", + "CITI", + "KWANGJU", + "JEJU", + "JEONBUK", + "SAEMAEUL", + "SHINHYUP", + "K_BANK", + "KAKAO_BANK" + ] + }, + "ProductPurchaseMaterialDto": { + "type": "object", + "required": [ + "purchaseId", + "recentDeliveredRequests", + "issuedCoupons", + "orderSummary", + "payableMethodIds", + "tossPaymentsInterestFreePolicies" + ], + "properties": { + "purchaseId": { + "type": "string" + }, + "recentDeliveredRequests": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserDeliveryAddressDto" + } + }, + "recommendedIssuedCouponId": { + "type": "integer", + "format": "int64" + }, + "issuedCoupons": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IssuedCouponWhenOrderDto" + } + }, + "orderSummary": { + "$ref": "#/components/schemas/OrderSummaryDto" + }, + "refundAccount": { + "$ref": "#/components/schemas/RefundAccountDto" + }, + "payableMethodIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "tossPaymentsInterestFreePolicies": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TossPaymentInterestFreePolicyDto" + } + } + } + }, + "StartIamportPaymentRequestDto": { + "type": "object", + "required": [ + "pg", + "pgMethod" + ], + "properties": { + "pg": { + "type": "string", + "description": "payment gateway id" + }, + "pgMethod": { + "type": "string", + "description": "payment gateway dependent method" + } + } + }, + "IamportPaymentMaterialDto": { + "type": "object", + "required": [ + "storeId", + "pg", + "merchantId", + "productName", + "productPrice", + "currency", + "language", + "buyerTel", + "payMethod" + ], + "properties": { + "storeId": { + "type": "string", + "description": "store id (ex. 'imp*')" + }, + "pg": { + "type": "string", + "description": "payment gateway id" + }, + "merchantId": { + "type": "string", + "description": "generated merchantId for this payment" + }, + "productName": { + "type": "string", + "description": "product name to show to user" + }, + "productPrice": { + "type": "integer", + "format": "int64", + "description": "payment price as KRW" + }, + "currency": { + "type": "string", + "description": "KRW" + }, + "language": { + "type": "string", + "description": "ja" + }, + "buyerTel": { + "type": "string", + "description": "buyer phone number" + }, + "payMethod": { + "type": "string", + "description": "pay method (ex. card )" + }, + "naverProducts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NaverProductDto" + } + } + } + }, + "NaverProductDto": { + "type": "object", + "required": [ + "categoryType", + "categoryId", + "uid", + "name", + "count" + ], + "properties": { + "categoryType": { + "type": "string" + }, + "categoryId": { + "type": "string" + }, + "uid": { + "type": "string" + }, + "name": { + "type": "string" + }, + "count": { + "type": "integer", + "format": "int64" + } + } + }, + "StartConnectPayPaymentRequestDto": { + "type": "object", + "required": [ + "payMethod" + ], + "properties": { + "payMethod": { + "$ref": "#/components/schemas/ConnectPayPaymentMethodEnum" + } + } + }, + "ConnectPayPaymentMethodEnum": { + "oneOf": [ + { + "const": "CARD" + }, + { + "const": "ACCOUNT_TRANSFER" + } + ] + }, + "ConnectPayPaymentMaterialDto": { + "type": "object", + "required": [ + "clientKey", + "customerKey", + "amount", + "merchantId", + "title", + "successUrl", + "failUrl", + "redirectUrl" + ], + "properties": { + "clientKey": { + "type": "string", + "description": "ใ‚ณใƒใ‚ฏใƒˆใƒšใ‚ค JS SDK ่ช่จผ็”จ clientKey" + }, + "customerKey": { + "type": "string", + "description": "ใŠๆ”ฏๆ‰•ใ„ใƒชใ‚ฏใ‚จใ‚นใƒˆใซไฝฟ็”จใ•ใ‚Œใ‚‹ใƒฆใƒผใ‚ถใƒผใฎ external uid" + }, + "amount": { + "type": "integer", + "format": "int64", + "description": "ๅฎŸ้š›ใซๆ”ฏๆ‰•ใ‚ใ‚Œใ‚‹้‡‘้ก๏ผˆamount๏ผ‰" + }, + "merchantId": { + "type": "string", + "description": "ๆณจๆ–‡ - ๆ”ฏๆ‰•ใ„ใฎไธ€ๆ„ใฎID๏ผˆOrderID๏ผ‰" + }, + "title": { + "type": "string", + "description": "ใŠๆ”ฏๆ‰•ใ„ใฎๆณจๆ–‡ๅ๏ผˆOrderName๏ผ‰" + }, + "successUrl": { + "type": "string", + "description": "ใŠๆ”ฏๆ‰•ใ„ใฎๆˆๅŠŸๆ™‚ใซใƒชใƒ€ใ‚คใƒฌใ‚ฏใƒˆ URL" + }, + "failUrl": { + "type": "string", + "description": "ใŠๆ”ฏๆ‰•ใ„ใซๅคฑๆ•—ใ—ใŸๅ ดๅˆใฎใƒชใƒ€ใ‚คใƒฌใ‚ฏใƒˆ URL" + }, + "redirectUrl": { + "type": "string", + "description": "ConnectPay OAuth่ช่จผใซไฝฟ็”จใ•ใ‚Œใ‚‹redirect url" + } + } + }, + "StartTossPaymentRequestDto": { + "type": "object", + "required": [ + "payMethod" + ], + "properties": { + "payMethod": { + "$ref": "#/components/schemas/TossPaymentMethodEnum" + } + } + }, + "TossPaymentMethodEnum": { + "oneOf": [ + { + "const": "CARD" + }, + { + "const": "VIRTUAL_ACCOUNT" + }, + { + "const": "MOBILE" + }, + { + "const": "KAKAO_PAY" + }, + { + "const": "TOSS_PAY" + }, + { + "const": "APPLE_PAY" + } + ] + }, + "TossPaymentMaterialDto": { + "type": "object", + "required": [ + "clientKey", + "amount", + "payMethod", + "merchantId", + "title", + "successUrl", + "failUrl", + "customerMobilePhone" + ], + "properties": { + "clientKey": { + "type": "string" + }, + "amount": { + "type": "integer", + "format": "int64" + }, + "payMethod": { + "type": "string" + }, + "merchantId": { + "type": "string" + }, + "title": { + "type": "string" + }, + "successUrl": { + "type": "string" + }, + "failUrl": { + "type": "string" + }, + "virtualAccountCallbackUrl": { + "type": "string" + }, + "customerName": { + "type": "string" + }, + "customerMobilePhone": { + "type": "string" + } + } + }, + "DryRunPaymentMaterialDto": { + "type": "object", + "required": [ + "merchantId" + ], + "properties": { + "merchantId": { + "type": "string", + "description": "generated merchantId for this payment" + } + } + }, + "FreePaymentMaterialDto": { + "type": "object", + "required": [ + "merchantId" + ], + "properties": { + "merchantId": { + "type": "string", + "description": "generated merchantId for this payment" + } + } + }, + "OLCEstimationRequestDto": { + "type": "object", + "required": [ + "partials" + ], + "properties": { + "partials": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartialOrderItemDto" + } + } + } + }, + "PartialOrderItemDto": { + "type": "object", + "required": [ + "orderItemId", + "quantity" + ], + "properties": { + "orderItemId": { + "type": "string" + }, + "quantity": { + "type": "integer", + "format": "int64" + } + } + }, + "OrderItemPurchaseStateEnum": { + "oneOf": [ + { + "const": "WAIT" + }, + { + "const": "PAID" + }, + { + "const": "REFUNDED" + } + ] + }, + "ProductSearchingOrderByEnum": { + "oneOf": [ + { + "const": "MATCHING_SCORE_DESC" + }, + { + "const": "POPULARITY" + }, + { + "const": "RATING_DESC" + }, + { + "const": "FINAL_PRICE_DESC" + }, + { + "const": "FINAL_PRICE_ASC" + }, + { + "const": "DISCOUNT_PERCENTAGE_DESC" + }, + { + "const": "REVIEW_COUNT_DESC" + }, + { + "const": "REVIEW_RATING_AVG_DESC" + }, + { + "const": "CREATED_AT_DESC" + } + ] + }, + "OrderHistoryListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "MyOrderHistoryListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MyOrderHistoryDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "MyOrderHistoryDto": { + "type": "object", + "properties": { + "orderSummary": { + "$ref": "#/components/schemas/MyOrderSummaryDto" + }, + "deliveryRequest": { + "$ref": "#/components/schemas/DeliveryRequestDto" + }, + "purchaseResult": { + "$ref": "#/components/schemas/PurchaseResultDto" + } + } + }, + "OrderHistoryDto": { + "type": "object", + "required": [ + "orderSummary", + "deliveryRequest", + "purchaseResult" + ], + "properties": { + "orderSummary": { + "$ref": "#/components/schemas/OrderSummaryDto" + }, + "deliveryRequest": { + "$ref": "#/components/schemas/DeliveryRequestDto" + }, + "purchaseResult": { + "$ref": "#/components/schemas/PurchaseResultDto" + } + } + }, + "MyOrderLineTicketListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MyOrderLineTicketDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "MyOrderLineTicketDto": { + "type": "object", + "required": [ + "ticketType", + "createdAtMillis" + ], + "properties": { + "ticketType": { + "$ref": "#/components/schemas/OrderLineTicketEnum" + }, + "returnTicket": { + "$ref": "#/components/schemas/OrderLineReturnTicketWithOrderDto" + }, + "cancelTicket": { + "$ref": "#/components/schemas/OrderLineCancelTicketWithOrderDto" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + } + } + }, + "MyOLTicketsCountDto": { + "type": "object", + "required": [ + "cancelTicket", + "returnTicket" + ], + "properties": { + "cancelTicket": { + "$ref": "#/components/schemas/OrderLineTicketCountDto" + }, + "returnTicket": { + "$ref": "#/components/schemas/OrderLineTicketCountDto" + } + } + }, + "OrderLineTicketCountDto": { + "type": "object", + "required": [ + "inProgress", + "resolved" + ], + "properties": { + "inProgress": { + "description": "้€ฒ่กŒไธญใฎไบบ๏ผˆ่ฟ”ๅ“orใ‚ญใƒฃใƒณใ‚ปใƒซ๏ผ‰ใƒใ‚ฑใƒƒใƒˆๆ•ฐ", + "type": "integer", + "format": "int32" + }, + "resolved": { + "description": "ๆœ€่ฟ‘4ๆ—ฅไปฅๅ†…ใซๅฎŒไบ†ใ—ใŸ๏ผˆ่ฟ”ๅ“orใ‚ญใƒฃใƒณใ‚ปใƒซ๏ผ‰ใƒใ‚ฑใƒƒใƒˆๆ•ฐ", + "type": "integer", + "format": "int32" + } + } + }, + "DeliveryRequestDto": { + "type": "object", + "required": [ + "address" + ], + "properties": { + "address": { + "$ref": "#/components/schemas/DeliveryAddressDto" + }, + "request": { + "type": "string" + } + } + }, + "PurchaseResultDto": { + "type": "object", + "required": [ + "paymentId", + "payemntVendor", + "paymentMethod", + "paidAmount", + "refundedAmount", + "purchaseState" + ], + "properties": { + "paymentId": { + "type": "string" + }, + "paymentVendor": { + "type": "string" + }, + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethodEnum" + }, + "virtualAccount": { + "$ref": "#/components/schemas/VirtualAccountDto" + }, + "card": { + "$ref": "#/components/schemas/CardDto" + }, + "paidAmount": { + "type": "integer", + "format": "int64" + }, + "refundedAmount": { + "type": "integer", + "format": "int64" + }, + "purchaseState": { + "$ref": "#/components/schemas/PurchaseStateEnum" + }, + "completedAtMillis": { + "type": "integer", + "format": "int64" + } + } + }, + "VirtualAccountDto": { + "type": "object", + "required": [ + "accountNumber", + "bank", + "customerName" + ], + "properties": { + "accountNumber": { + "type": "string" + }, + "bank": { + "type": "string" + }, + "customerName": { + "type": "string" + }, + "dueDateMillis": { + "type": "integer", + "format": "int64" + } + } + }, + "CardDto": { + "type": "object", + "required": [ + "companyName" + ], + "properties": { + "companyName": { + "description": "ใ‚ซใƒผใƒ‰ไผš็คพ๏ผˆeg 1ใ€Shinhanใ€BCใ‚ซใƒผใƒ‰๏ผ‰", + "type": "string" + }, + "installmentPlanMonths": { + "description": "ๅ‰ฒ่ณฆๆœˆๆ•ฐ๏ผˆ0ใฎๅ ดๅˆใ€ไธ€ๆ™‚ๆ‰•ใ„๏ผ‰", + "minimum": 0, + "format": "int32", + "type": "integer" + }, + "interestFreeInstallment": { + "description": "็„กๅˆฉๅญๅˆ†ๅ‰ฒๆ‰•ใ„ใ‹ใฉใ†ใ‹", + "type": "boolean" + } + } + }, + "PaymentMethodEnum": { + "oneOf": [ + { + "const": "CARD" + }, + { + "const": "ACCOUNT_TRANSFER" + }, + { + "const": "KAKAO_PAY" + }, + { + "const": "NAVER_PAY" + }, + { + "const": "TOSS_PAY" + }, + { + "const": "VIRTUAL_ACCOUNT" + }, + { + "const": "DRY" + }, + { + "const": "MOBILE" + }, + { + "const": "FREE" + }, + { + "const": "APPLE_PAY" + } + ] + }, + "RefundPaymentMethodEnum": { + "oneOf": [ + { + "const": "CARD" + }, + { + "const": "ACCOUNT_TRANSFER" + }, + { + "const": "KAKAO_PAY" + }, + { + "const": "NAVER_PAY" + }, + { + "const": "TOSS_PAY" + }, + { + "const": "VIRTUAL_ACCOUNT" + }, + { + "const": "DRY" + }, + { + "const": "MOBILE" + }, + { + "const": "FREE" + }, + { + "const": "APPLE_PAY" + }, + { + "const": "POINT" + } + ] + }, + "RefundPaymentVendorEnum": { + "oneOf": [ + { + "const": "IAMPORT" + }, + { + "const": "TOSS_PAYMENTS" + }, + { + "const": "DRY_RUN" + }, + { + "const": "CONNECT_PAY" + }, + { + "const": "FREE" + } + ] + }, + "PurchaseStateEnum": { + "oneOf": [ + { + "const": "WAIT" + }, + { + "const": "WAITING_FOR_DEPOSIT" + }, + { + "const": "COMPLETED" + }, + { + "const": "ABORTED" + } + ] + }, + "MyOrderSummaryDto": {}, + "OrderSummaryDto": { + "type": "object", + "properties": { + "totalProductPrice": { + "type": "integer", + "format": "int64" + }, + "totalDeliveryPrice": { + "type": "integer", + "format": "int64" + }, + "serviceCharge": { + "type": "integer", + "format": "int64" + }, + "discountAmount": { + "type": "integer", + "format": "int64" + }, + "finalPurchaseAmount": { + "type": "integer", + "format": "int64" + }, + "usePoint": { + "type": "integer", + "format": "int64" + }, + "id": { + "type": "string", + "description": "(deprecated) use orderId" + }, + "orderId": { + "type": "string" + }, + "costElements": { + "type": "array", + "description": "- PriceSetDto ใฎไพกๆ ผ่ฉณ็ดฐใ‚’่กจ็พใ™ใ‚‹ใŸใ‚ใฎใƒ•ใ‚ฃใƒผใƒซใƒ‰ - ๅพใ€…ใซๆ‹กๅผตใ—ใฆใ„ใใŒใ€็พๅœจใฏ้€ๆ–™ใซ้–ขใ™ใ‚‹่ฉณ็ดฐๆƒ…ๅ ฑใฎใฟ่กจ็คบใ™ใ‚‹.", + "items": { + "$ref": "#/components/schemas/CostElementDto" + } + }, + "appliedCouponCode": { + "type": "string", + "description": "appliedCoupon.coupon.codeใงใ‚ขใ‚ฏใ‚ปใ‚นใงใใ‚‹ใ‚ˆใ†ใซใ—ใพใ™.", + "deprecated": true + }, + "appliedCoupon": { + "$ref": "#/components/schemas/IssuedCouponDto" + }, + "itemGroups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderItemGroupDto" + } + }, + "confirmedAtMillis": { + "type": "integer", + "format": "int64" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + } + } + }, + "PriceSetDeltaDto": { + "type": "object", + "required": [ + "totalProductPrice", + "totalDeliveryPrice", + "serviceCharge", + "discountAmount", + "finalPurchaseAmount" + ], + "properties": { + "totalProductPrice": { + "type": "integer", + "format": "int64" + }, + "totalDeliveryPrice": { + "type": "integer", + "format": "int64" + }, + "serviceCharge": { + "type": "integer", + "format": "int64" + }, + "discountAmount": { + "type": "integer", + "format": "int64" + }, + "finalPurchaseAmount": { + "type": "integer", + "format": "int64" + }, + "usePoint": { + "type": "integer", + "format": "int64" + }, + "costElements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CostElementDto" + } + } + } + }, + "DeliveryPriceDto": { + "type": "object", + "required": [ + "normal", + "jeju", + "backCountry" + ], + "properties": { + "normal": { + "type": "integer", + "format": "int64" + }, + "jeju": { + "type": "integer", + "format": "int64" + }, + "backCountry": { + "type": "integer", + "format": "int64" + } + } + }, + "PriceSetDto": { + "type": "object", + "required": [ + "totalProductPrice", + "totalDeliveryPrice", + "serviceCharge", + "discountAmount", + "finalPurchaseAmount" + ], + "properties": { + "totalProductPrice": { + "type": "integer", + "format": "int64" + }, + "totalDeliveryPrice": { + "type": "integer", + "format": "int64" + }, + "serviceCharge": { + "type": "integer", + "format": "int64" + }, + "discountAmount": { + "type": "integer", + "format": "int64" + }, + "finalPurchaseAmount": { + "type": "integer", + "format": "int64" + }, + "usePoint": { + "type": "integer", + "format": "int64" + } + } + }, + "MyOrderItemGroupDto": { + "type": "object", + "properties": { + "groupId": { + "type": "string" + }, + "mall": { + "$ref": "#/components/schemas/MallDto" + }, + "brand": { + "$ref": "#/components/schemas/BrandDto" + }, + "costElements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CostElementDto" + } + }, + "deliveryPrice": { + "type": "integer", + "format": "int64" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MyOrderItemDto" + } + } + } + }, + "OrderItemGroupDto": { + "type": "object", + "required": [ + "groupId", + "mall", + "brand", + "deliveryPrice", + "items" + ], + "properties": { + "groupId": { + "type": "string" + }, + "mall": { + "$ref": "#/components/schemas/MallDto" + }, + "brand": { + "$ref": "#/components/schemas/BrandDto" + }, + "costElements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CostElementDto" + } + }, + "deliveryPrice": { + "type": "integer", + "format": "int64" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderItemDto" + } + } + } + }, + "CostElementDto": { + "type": "object", + "required": [ + "type", + "amount" + ], + "description": "- ไพกๆ ผใฎ่ฉณ็ดฐๆƒ…ๅ ฑใ‚’่กจ็พใ™ใ‚‹DTO - ็พๅœจ้€ๆ–™ใ€่ฟ”ๅ“่ฒปใซใคใ„ใฆใฎใฟ่ฉณ็ดฐๆƒ…ๅ ฑใŒๅญ˜ๅœจใ™ใ‚‹.", + "properties": { + "type": { + "$ref": "#/components/schemas/CostTypeEnum" + }, + "amount": { + "type": "integer", + "format": "int64" + } + } + }, + "CostTypeEnum": { + "oneOf": [ + { + "const": "SHIPPING_COST_NORMAL" + }, + { + "const": "SHIPPING_COST_JEJU" + }, + { + "const": "SHIPPING_COST_BACK_COUNTRY" + }, + { + "const": "RETURN_COST_NORMAL" + }, + { + "const": "RETURN_COST_JEJU" + }, + { + "const": "RETURN_COST_BACK_COUNTRY" + }, + { + "const": "RETURN_COST_TO_REFUND_FREE_SHIPPING" + } + ] + }, + "MyOrderItemDto": {}, + "DividedOrderItemDto": {}, + "EachOLCEstimationDto": { + "required": [ + "orderItemId", + "quantity", + "totalProductPrice", + "totalDiscountAmount", + "finalPurchaseAmount", + "usePoint" + ], + "properties": { + "orderItemId": { + "type": "string" + }, + "totalProductPrice": { + "type": "integer", + "format": "int64" + }, + "finalPurchaseAmount": { + "type": "integer", + "format": "int64" + }, + "totalDiscountAmount": { + "type": "integer", + "format": "int64" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "usePoint": { + "type": "integer", + "format": "int64" + } + } + }, + "EachOLREstimationDto": { + "required": [ + "orderItemId", + "quantity", + "totalProductPrice", + "totalDiscountAmount", + "finalPurchaseAmount", + "usePoint" + ], + "properties": { + "orderItemId": { + "type": "string" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "totalProductPrice": { + "type": "integer", + "format": "int64" + }, + "finalPurchaseAmount": { + "type": "integer", + "format": "int64" + }, + "totalDiscountAmount": { + "type": "integer", + "format": "int64" + }, + "usePoint": { + "type": "integer", + "format": "int64" + } + } + }, + "OrderItemDto": { + "required": [ + "id", + "product", + "productItem", + "singlePrice", + "quantity", + "singleDirectDiscountAmount", + "totalPrice", + "state", + "purchaseState", + "delivery", + "totalProductPrice", + "finalPurchaseAmount", + "totalDiscountAmount", + "totalDirectDiscountAmount", + "brand", + "receiptConfirmation", + "finalSinglePrice", + "freeReturnTarget" + ], + "properties": { + "id": { + "type": "string" + }, + "product": { + "$ref": "#/components/schemas/ProductDto" + }, + "productItem": { + "$ref": "#/components/schemas/ProductItemDto" + }, + "singlePrice": { + "description": "ๅ•†ๅ“ไพกๆ ผ๏ผˆใ‚ฏใ‚คใƒผใƒณใ‚คใƒƒใƒˆๅณๅ‰ฒๅผ•ๅๆ˜ ใ•ใ‚Œใพใ›ใ‚“๏ผ‰", + "type": "integer", + "format": "int64" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "singleDirectDiscountAmount": { + "description": "ใ‚ฏใ‚คใƒผใƒณใ‚คใƒƒใƒˆๅณๆ™‚ๅ‰ฒๅผ•", + "type": "integer", + "format": "int64" + }, + "totalPrice": { + "description": "(deprecated) Use `totalProductPrice` instead.", + "type": "integer", + "format": "int64" + }, + "totalProductPrice": { + "description": "็ทๅ•†ๅ“ไพกๆ ผ๏ผˆ `๏ผˆsinglePrice - singleDirectDiscountAmount๏ผ‰* quantity`๏ผ‰", + "type": "integer", + "format": "int64" + }, + "finalPurchaseAmount": { + "description": "ๅฎŸ้š›ใฎใŠๆ”ฏๆ‰•ใ„้ก(`totalProductPrice - totalDiscountAmount - usePoint`)", + "type": "integer", + "format": "int64" + }, + "usePoint": { + "description": "ไฝฟ็”จใƒใ‚คใƒณใƒˆ", + "type": "integer", + "format": "int64" + }, + "totalDiscountAmount": { + "description": "ใ‚ซใƒผใƒˆใฎๅˆ่จˆใ‚ฏใƒผใƒใƒณๅ‰ฒๅผ•้ก(``singleDiscountAmount* quantity + residueDiscountAmount`)", + "type": "integer", + "format": "int64" + }, + "totalDirectDiscountAmount": { + "description": "ใ‚ฏใ‚คใƒผใƒณๅˆ่จˆๅณๆ™‚ๅ‰ฒๅผ•้ก(`singleDirectDiscountAmount* quantity`)", + "type": "integer", + "format": "int64" + }, + "finalSinglePrice": { + "description": "ๅ•†ๅ“ไพกๆ ผ๏ผˆ `singlePrice - singleDirectDiscountAmount`๏ผ‰", + "type": "integer", + "format": "int64" + }, + "state": { + "$ref": "#/components/schemas/OrderStateEnum" + }, + "purchaseState": { + "$ref": "#/components/schemas/OrderItemPurchaseStateEnum" + }, + "delivery": { + "$ref": "#/components/schemas/DeliveryProgressDto" + }, + "primaryCancelTicket": { + "$ref": "#/components/schemas/OLCTicketDto" + }, + "primaryReturnTicket": { + "$ref": "#/components/schemas/OLRTicketDto" + }, + "brand": { + "$ref": "#/components/schemas/BrandDto" + }, + "receiptConfirmation": { + "type": "boolean" + }, + "receiptConfirmedAtMillis": { + "type": "integer", + "format": "int64" + }, + "freeReturnTarget": { + "type": "boolean" + } + } + }, + "DeliveryProgressDto": { + "type": "object", + "required": [ + "state" + ], + "properties": { + "vendorName": { + "type": "string" + }, + "vendorDeliveryNumber": { + "type": "string" + }, + "detailUrl": { + "type": "string" + }, + "state": { + "$ref": "#/components/schemas/DeliveryStateEnum" + }, + "shippedAtMillis": { + "description": "ใใฎๆณจๆ–‡ใŒๅ‡บ่ทใ•ใ‚ŒใŸๆ™‚็‚นใงใ™ใ€‚็พๅœจใฏ้…้€ไธญใซๅค‰ๆ›ดใ•ใ‚ŒใŸๆ™‚้–“ใ‚’ๆ„ๅ‘ณใ—ใพใ™.", + "type": "integer", + "format": "int64" + } + } + }, + "DeliveryStateEnum": { + "oneOf": [ + { + "const": "WAIT" + }, + { + "const": "PREPARING" + }, + { + "const": "IN_DELIVERY" + }, + { + "const": "COMPLETED" + }, + { + "const": "CANCELLED" + } + ] + }, + "OrderByEnum": { + "oneOf": [ + { + "const": "ASC" + }, + { + "const": "DESC" + } + ] + }, + "ProductOrderByEnum": { + "oneOf": [ + { + "const": "RECOMMENDATION" + }, + { + "const": "POPULARITY" + }, + { + "const": "CREATED_AT_DESC" + }, + { + "const": "FINAL_PRICE_DESC" + }, + { + "const": "FINAL_PRICE_ASC" + }, + { + "const": "DISCOUNT_PERCENTAGE_DESC" + }, + { + "const": "REVIEW_COUNT_DESC" + }, + { + "const": "REVIEW_RATING_AVG_DESC" + } + ] + }, + "OrderStateEnum": { + "oneOf": [ + { + "const": "WAIT" + }, + { + "const": "PURCHASED" + }, + { + "const": "REFUNDED" + }, + { + "const": "PREPARING_PRODUCTS" + }, + { + "const": "IN_DELIVERY" + }, + { + "const": "DELIVERY_COMPLETED" + }, + { + "const": "ABORTED" + } + ] + }, + "OrderLineTicketStateEnum": { + "oneOf": [ + { + "const": "SUBMITTED" + }, + { + "const": "CONFIRMED" + }, + { + "const": "RESOLVED" + }, + { + "const": "WITHDRAWN" + }, + { + "const": "REJECTED" + } + ], + "description": "ใ‚ญใƒฃใƒณใ‚ปใƒซ๏ผˆ่ฟ”ๅ“๏ผ‰ใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚นใƒ†ใƒผใ‚ฟใ‚น - SUBMITTED๏ผšใ‚ญใƒฃใƒณใ‚ปใƒซ๏ผˆ่ฟ”ๅ“๏ผ‰ใŒ่ฆๆฑ‚ใ•ใ‚Œใพใ—ใŸ - CONFIRMED๏ผšใ‚ญใƒฃใƒณใ‚ปใƒซ๏ผˆ่ฟ”ๅ“๏ผ‰ใƒชใ‚ฏใ‚จใ‚นใƒˆใŒๆ‰ฟ่ชใ•ใ‚Œใพใ—ใŸ๏ผˆๅ‡ฆ็†ไธญ๏ผ‰ - RESOLVED๏ผšใ‚ญใƒฃใƒณใ‚ปใƒซ๏ผˆ่ฟ”ๅ“๏ผ‰ใƒชใ‚ฏใ‚จใ‚นใƒˆใŒ็ต‚ไบ†ใ—ใพใ—ใŸ๏ผˆ้กงๅฎขใซ่ฟ”้‡‘ใ•ใ‚ŒใŸ้‡‘้ก๏ผ‰ - WITHDRAWN: ใ‚ญใƒฃใƒณใ‚ปใƒซ(่ฟ”ๅ“)ใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’ใŠๅฎขๆง˜ใŒๆ’คๅ›ž" + }, + "OrderLineReturnStateEnum": { + "oneOf": [ + { + "const": "WAITING" + }, + { + "const": "IN_RECALL_DELIVERY_READY" + }, + { + "const": "IN_RECALL_DELIVERY_PROCESSING" + }, + { + "const": "RECALL_DELIVERY_COMPLETED" + }, + { + "const": "REJECTED" + }, + { + "const": "RESOLVED" + }, + { + "const": "WITHDRAWN" + } + ], + "description": "่ฟ”ๅ“ไพ้ ผใ‚นใƒ†ใƒผใ‚ฟใ‚น - WAITING๏ผš้กงๅฎขใŒ่ฟ”ๅ“ไพ้ ผใ—ใ€ๅฃฒใ‚Šๆ‰‹/ใ‚ขใƒ‰ใƒŸใƒณใฎๆ‰ฟ่ชๅพ…ใกใ‚’ๅพ…ใฃใฆใ„ใ‚‹็Šถๆ…‹ใƒ”ใƒƒใ‚ฏใ‚ขใƒƒใƒ—ๅพŒๅผ•ใ็ถ™ใ„ใ ๅพŒใ€่ฟ”ๅ“ๅ…ˆไฝๆ‰€ใซๅ›žๅŽไธญใ€‚ ๏ผˆใ‚ฐใƒƒใƒ‰ใ‚นใƒ—ใƒญ้€ฃๅ‹•ใงใชใ„ๅ ดๅˆใฏใ‚ปใƒฉใƒผใซใ‚ˆใ‚‹ๅ›žๅŽไธญ๏ผ‰ - RECALL_DELIVERY_COMPLETED๏ผš๏ผˆใ‚ฐใƒƒใƒ‰ใ‚นใƒ—ใƒญ้€ฃๅ‹•ใฎๅ ดๅˆใฎใฟ๏ผ‰ RESOLVED : ่ฟ”ๅ“ไพ้ ผใŒ็ต‚ไบ†(้กงๅฎขใซ้‡‘้กๆ‰•ใ„ๆˆปใ—)" + }, + "OrderLineTicketEnum": { + "oneOf": [ + { + "const": "CANCEL" + }, + { + "const": "RETURN" + } + ], + "description": "- ๆณจๆ–‡ๆ›ธใƒใ‚ฑใƒƒใƒˆใ‚ฟใ‚คใƒ— - CANCEL๏ผšใ‚ญใƒฃใƒณใ‚ปใƒซ - RETURN๏ผš่ฟ”ๅ“" + }, + "AuditorGroupEnum": { + "oneOf": [ + { + "const": "SYSTEM" + }, + { + "const": "CX_ADMIN" + }, + { + "const": "SELLER_ADMIN" + }, + { + "const": "USER" + } + ], + "description": "ใƒใ‚ฑใƒƒใƒˆใฎใ‚นใƒ†ใƒผใ‚ฟใ‚นใ‚’ๅค‰ๆ›ดใ—ใŸใƒ—ใƒชใƒณใ‚ทใƒ‘ใƒซๅ˜ไฝ - SYSTEM๏ผšใ‚ทใ‚นใƒ†ใƒ ใซใ‚ˆใฃใฆ่‡ชๅ‹•็š„ใซใ‚นใƒ†ใƒผใ‚ฟใ‚นใŒๅค‰ๆ›ดใ•ใ‚Œใ‚‹ - CX_ADMIN๏ผšCXใƒใƒผใƒ ใซใ‚ˆใฃใฆใ‚นใƒ†ใƒผใ‚ฟใ‚นใŒๅค‰ๆ›ดใ•ใ‚Œใพใ—ใŸ - SELLER_ADMIN๏ผšใ‚ปใƒฉใƒผใซใ‚ˆใฃใฆใ‚นใƒ†ใƒผใ‚ฟใ‚นใŒๅค‰ๆ›ดใ•ใ‚Œใพใ—ใŸ - USER๏ผš้กงๅฎขใซใ‚ˆใฃใฆใ‚นใƒ†ใƒผใ‚ฟใ‚นใŒๅค‰ๆ›ดใ•ใ‚Œใพใ—ใŸ" + }, + "OLCEstimationDto": { + "type": "object", + "required": [ + "priceDelta" + ], + "properties": { + "orderItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderItemDto" + } + }, + "priceDelta": { + "$ref": "#/components/schemas/PriceSetDeltaDto" + } + } + }, + "OLCEstimationResultDto": { + "type": "object", + "required": [ + "priceDelta", + "eachEstimations" + ], + "properties": { + "eachEstimations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EachOLCEstimationDto" + } + }, + "priceDelta": { + "$ref": "#/components/schemas/PriceSetDeltaDto" + }, + "refundPaymentInfos": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RefundPaymentInfoDto" + } + } + } + }, + "OLCRequestDto": { + "type": "object", + "required": [ + "partials", + "reason" + ], + "properties": { + "partials": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartialOrderItemDto" + } + }, + "reason": { + "type": "string" + } + } + }, + "OLCTicketDto": { + "type": "object", + "required": [ + "ticketId", + "state", + "reason", + "createdAtMillis", + "orderItems" + ], + "properties": { + "ticketId": { + "type": "string" + }, + "state": { + "$ref": "#/components/schemas/OrderLineTicketStateEnum" + }, + "auditorGroup": { + "$ref": "#/components/schemas/AuditorGroupEnum" + }, + "reason": { + "type": "string" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + }, + "confirmedAtMillis": { + "type": "integer", + "format": "int64" + }, + "withdrawnAtMillis": { + "type": "integer", + "format": "int64" + }, + "rejectedAtMillis": { + "type": "integer", + "format": "int64" + }, + "rejectReason": { + "type": "string" + }, + "resolvedAtMillis": { + "type": "integer", + "format": "int64" + }, + "resolvedPriceDelta": { + "$ref": "#/components/schemas/PriceSetDeltaDto" + }, + "refundPaymentInfos": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RefundPaymentInfoDto" + } + }, + "orderItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderItemDto" + } + } + } + }, + "OrderLineCancelTicketWithOrderDto": { + "type": "object", + "properties": { + "ticketId": { + "type": "string" + }, + "state": { + "$ref": "#/components/schemas/OrderLineTicketStateEnum" + }, + "auditorGroup": { + "$ref": "#/components/schemas/AuditorGroupEnum" + }, + "reason": { + "type": "string" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + }, + "confirmedAtMillis": { + "type": "integer", + "format": "int64" + }, + "withdrawnAtMillis": { + "type": "integer", + "format": "int64" + }, + "rejectedAtMillis": { + "type": "integer", + "format": "int64" + }, + "rejectReason": { + "type": "string" + }, + "resolvedAtMillis": { + "type": "integer", + "format": "int64" + }, + "resolvedPriceDelta": { + "$ref": "#/components/schemas/PriceSetDeltaDto" + }, + "refundPaymentInfos": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RefundPaymentInfoDto" + } + }, + "orderItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderItemDto" + } + }, + "linkedOrder": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + }, + "OLREstimateRequestDto": { + "type": "object", + "required": [ + "isCustomerNegligence", + "partials" + ], + "properties": { + "isCustomerNegligence": { + "type": "boolean" + }, + "partials": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartialOrderItemDto" + } + } + } + }, + "OLREstimationResultDto": { + "type": "object", + "required": [ + "priceDelta", + "eachEstimations" + ], + "properties": { + "eachEstimations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EachOLREstimationDto" + } + }, + "priceDelta": { + "$ref": "#/components/schemas/PriceSetDeltaDto" + }, + "refundPaymentInfos": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RefundPaymentInfoDto" + } + } + } + }, + "OLRRequestDto": { + "type": "object", + "required": [ + "partials", + "isCustomerNegligence", + "returnAddress", + "reason" + ], + "properties": { + "partials": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartialOrderItemDto" + } + }, + "isCustomerNegligence": { + "type": "boolean" + }, + "returnAddress": { + "$ref": "#/components/schemas/DeliveryAddressDto" + }, + "reason": { + "type": "string" + }, + "imageUrls": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "OLRTicketDto": { + "type": "object", + "required": [ + "ticketId", + "state", + "returnState", + "isCustomerNegligence", + "returnAddress", + "reason", + "createdAtMillis", + "orderItems" + ], + "properties": { + "ticketId": { + "type": "string" + }, + "isCustomerNegligence": { + "type": "boolean" + }, + "returnAddress": { + "$ref": "#/components/schemas/DeliveryAddressDto" + }, + "state": { + "$ref": "#/components/schemas/OrderLineTicketStateEnum" + }, + "returnState": { + "$ref": "#/components/schemas/OrderLineReturnStateEnum" + }, + "auditorGroup": { + "$ref": "#/components/schemas/AuditorGroupEnum" + }, + "reason": { + "type": "string" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + }, + "confirmedAtMillis": { + "type": "integer", + "format": "int64" + }, + "withdrawnAtMillis": { + "type": "integer", + "format": "int64" + }, + "rejectedAtMillis": { + "type": "integer", + "format": "int64" + }, + "rejectReason": { + "type": "string" + }, + "resolvedAtMillis": { + "type": "integer", + "format": "int64" + }, + "resolvedPriceDelta": { + "$ref": "#/components/schemas/PriceSetDeltaDto" + }, + "refundPaymentInfos": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RefundPaymentInfoDto" + } + }, + "orderItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderItemDto" + } + }, + "imageUrls": { + "type": "array", + "description": "original image urls", + "items": { + "type": "string" + } + }, + "multiResolutionImages": { + "$ref": "#/components/schemas/MultiResolutionImageListDto" + }, + "recallDeliveryProgress": { + "$ref": "#/components/schemas/OLRTRecallDeliveryProgressDto" + } + } + }, + "OLRTRecallDeliveryProgressDto": { + "type": "object", + "description": "nullใฎๅ ดๅˆใ€GoodsFlowๅ›žๅŽ้€ฃๅ‹•ไธญใฎๅ•†ๅ“ใงใฏใชใ„", + "properties": { + "recallDeliveryVendor": { + "$ref": "#/components/schemas/DeliveryVendorEnum" + }, + "recallDeliveryVendorNumber": { + "description": "่ซ‹ๆฑ‚ๆ›ธ็•ชๅท", + "type": "string" + }, + "requestable": { + "description": "ๅ†ๅ›žๅŽ่ฆๆฑ‚ๅฏๅฆ", + "type": "boolean" + }, + "recallState": { + "$ref": "#/components/schemas/RecallDeliveryStateEnum" + }, + "recallDeliveryCompletedAtMillis": { + "description": "ๅ›žๅŽๅฎŒไบ†ๆ—ฅ", + "type": "integer", + "format": "int64" + }, + "recallDeliveryTraceUrl": { + "description": "ๅ›žๅŽใƒˆใƒฉใƒƒใ‚ญใƒณใ‚ฐURL", + "type": "string" + } + } + }, + "OrderLineReturnTicketWithOrderDto": { + "type": "object", + "properties": { + "ticketId": { + "type": "string" + }, + "isCustomerNegligence": { + "type": "boolean" + }, + "returnAddress": { + "$ref": "#/components/schemas/DeliveryAddressDto" + }, + "state": { + "$ref": "#/components/schemas/OrderLineTicketStateEnum" + }, + "returnState": { + "$ref": "#/components/schemas/OrderLineReturnStateEnum" + }, + "auditorGroup": { + "$ref": "#/components/schemas/AuditorGroupEnum" + }, + "reason": { + "type": "string" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + }, + "confirmedAtMillis": { + "type": "integer", + "format": "int64" + }, + "withdrawnAtMillis": { + "type": "integer", + "format": "int64" + }, + "rejectedAtMillis": { + "type": "integer", + "format": "int64" + }, + "rejectReason": { + "type": "string" + }, + "resolvedAtMillis": { + "type": "integer", + "format": "int64" + }, + "resolvedPriceDelta": { + "$ref": "#/components/schemas/PriceSetDeltaDto" + }, + "refundPaymentInfos": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RefundPaymentInfoDto" + } + }, + "orderItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderItemDto" + } + }, + "imageUrls": { + "type": "array", + "description": "original image urls", + "items": { + "type": "string" + } + }, + "multiResolutionImages": { + "$ref": "#/components/schemas/MultiResolutionImageListDto" + }, + "recallDeliveryProgress": { + "$ref": "#/components/schemas/OLRTRecallDeliveryProgressDto" + }, + "linkedOrder": { + "$ref": "#/components/schemas/OrderHistoryDto" + } + } + }, + "RefundPaymentInfoDto": { + "type": "object", + "description": "ๆ‰•ใ„ๆˆปใ—ใฎใŠๆ”ฏๆ‰•ใ„ๆ–นๆณ•", + "required": [ + "paymentMethod" + ], + "properties": { + "paymentMethod": { + "$ref": "#/components/schemas/RefundPaymentMethodEnum" + }, + "paymentVendor": { + "$ref": "#/components/schemas/RefundPaymentVendorEnum" + }, + "detail": { + "description": "ๆ‰•ใ„ๆˆปใ—ๆฑบๆธˆๆ‰‹ๆฎตๅˆฅ่ฉณ็ดฐ่ชฌๆ˜Ž๏ผˆใ‚ซใƒผใƒ‰ๆฑบๆธˆใฎๅ ดๅˆใ‚ซใƒผใƒ‰ไผš็คพๆƒ…ๅ ฑ๏ผ‰", + "type": "string" + } + } + }, + "DeliveryVendorEnum": { + "oneOf": [ + { + "const": "CJ_GLS" + }, + { + "const": "LOGEN" + }, + { + "const": "EPOST" + }, + { + "const": "HANJIN" + }, + { + "const": "LOTTE" + }, + { + "const": "DAESIN" + }, + { + "const": "ILYANG" + }, + { + "const": "KYUNGDONG" + }, + { + "const": "HAPDONG" + }, + { + "const": "CHUNIL" + }, + { + "const": "CVSNET" + }, + { + "const": "HPL" + }, + { + "const": "KUNYOUNG" + }, + { + "const": "HONAM" + }, + { + "const": "SLX" + }, + { + "const": "BGF" + }, + { + "const": "YONGMA" + }, + { + "const": "SEBANG" + }, + { + "const": "WONDERS" + }, + { + "const": "NH_LOGIS" + }, + { + "const": "HI_LOGIS" + }, + { + "const": "HOMEPICK" + }, + { + "const": "KOREX_G" + }, + { + "const": "EMS" + }, + { + "const": "LOTTE_GLOBAL" + }, + { + "const": "HANDEX" + }, + { + "const": "DHL" + }, + { + "const": "FEDEX" + }, + { + "const": "UPS" + }, + { + "const": "TNT" + }, + { + "const": "PANTOS" + }, + { + "const": "ACI_EXPRESS" + }, + { + "const": "ACE_EXP" + }, + { + "const": "EUNHA" + }, + { + "const": "CHAIN_LOGISTICS" + }, + { + "const": "LOGISPOT" + }, + { + "const": "VROONG" + }, + { + "const": "ETOMARS" + }, + { + "const": "VENDORPIA" + }, + { + "const": "DAERIM" + }, + { + "const": "VALEX" + }, + { + "const": "ETC" + }, + { + "const": "SELF_MANAGED" + } + ], + "description": "- ๏ผˆๆณจๆ–‡/่ซ‹ๆฑ‚ๆ›ธๆƒ…ๅ ฑ้–ข้€ฃ๏ผ‰่จญๅฎšๅฏ่ƒฝใชๅฎ…้…ไผš็คพ - ใ€ŒETC๏ผˆใใฎไป–้…้€ไผš็คพ๏ผ‰ใ€ - >็‰นๅฎšใฎ้…้€ไผš็คพใ‚’ไฝฟ็”จใ—ใฆใ„ใพใ™ใŒใ€็พๅœจใ‚ตใƒใƒผใƒˆใ—ใฆใ„ใชใ„ๅฎ…้…ไผš็คพ๏ผˆใใฎไป–้…้€ไผš็คพใฎใ‚ตใƒใƒผใƒˆใŒๅฟ…่ฆใชๅ ดๅˆใฏใ€ๅˆฅ้€”ใŠๅ•ใ„ๅˆใ‚ใ›ใใ ใ•ใ„๏ผ‰ - `SELF_MANAGED (็›ดๆŽฅ้…้€)` -> ็›ดๆŽฅ้…้€ใ™ใ‚‹ๅ ดๅˆใซไฝฟ็”จ ## ใ‚ณใƒผใƒ‰ๅˆฅ้€ฃ็ตใ•ใ‚Œใ‚‹้…้€ไผš็คพ - CJ_GLS # CJๅคง้Ÿ“้€š้‹ - LOGEN # ใƒญใƒผใ‚ผใƒณๅฎ…้…ไพฟ - EPOST # ้ƒตไพฟๅฑ€ๅฎ…้…ไพฟ - HANJIN # ้Ÿ“้€ฒๅฎ…้…ไพฟ - LOTTE # ใƒญใƒƒใƒ†ๅฎ…้…ไพฟ- DAESIN #ๅคงๅฎ…ๅฎ…้…ไพฟ - ILYANG # ๆ—ฅ้™ฝๅฎ…้…ไพฟ - KYUNGDONG # ไบฌๆฑๅฎ…้…ไพฟ - HAPDONG # ๅˆๅŒๅฎ…้…ไพฟ - CHUNIL # ๅคฉๆ—ฅๅฎ…้…ไพฟ - CVSNET # GSใ‚ณใƒณใƒ“ใƒ‹ๅฎ…้…ไพฟ - HPL # ้Ÿ“ๅŒปๆ„›ๅฎ…้…ไพฟ - KUNYOUNG # ๅปบๅ–ถๅฎ…้…ไพฟ - HONAM SLX - BGF # CUใ‚ณใƒณใƒ“ใƒ‹ๅฎ…้…ไพฟ - YONGMA # ใƒจใƒณใƒžใƒญใ‚ธใ‚น - SEBANG # ใ‚ปใƒใƒณๅฎ…้…ไพฟ - WONDERS # ใƒฏใƒณใƒ€ใƒผใ‚นใ‚ฏใ‚คใƒƒใ‚ฏ - NH_LOGIS # ่พฒๅ”ๅฎ…้…ไพฟ - HI_LOGIS # HIๅฎ…้…ไพฟ - HOMEPICK # ใƒ›ใƒผใƒ ใƒ”ใƒƒใ‚ฏๅฎ…้…ไพฟ - KOREX_G # CJๅคง้Ÿ“้€š้‹ๅ›ฝ้š›็‰นๅ…ธ - E LOTTE_GLOBAL #ใƒญใƒƒใƒ†ใ‚ฐใƒญใƒผใƒใƒซ - HANDEX #ใƒใƒณใƒ‡ใƒƒใ‚ฏใ‚น - DHL # DHL - FEDEX # FEDEX - UPS # UPS - TNT # TNT - PANTOS # ๆฑŽใƒใƒณใƒ‘ใƒณใƒˆใ‚น - ACI_EXPRESS # ACI Express - ACE_EXP # ACE Express - EUNHA # ้Š€ๆฒณใ‚ทใƒƒใƒ”ใƒณใ‚ฐ - CHAIN_LOGISTใƒ’ใƒผใƒญใƒผ - LOGISPOT # ใƒญใƒƒใ‚ธใ‚นใƒใƒƒใƒˆ - VROONG # ใƒ–ใƒฉใƒณ (VROONG) - ETOMARS # ใ‚คใƒˆใ‚ฅใƒžใ‚น - VENDORPIA # ใ‚จใƒผใ‚น็‰ฉๆต - DAERIM # ๅคงๆž—้€š้‹ - VALEX # ใƒใƒฌใƒƒใ‚ฏใ‚น - ETC # ใใฎไป–้…้€ไผš็คพ - SELF_MANAGED # ็›ดๆŽฅ้…้€" + }, + "RecallDeliveryStateEnum": { + "oneOf": [ + { + "const": "WAIT" + }, + { + "const": "PREPARING" + }, + { + "const": "IN_DELIVERY" + }, + { + "const": "COMPLETED" + }, + { + "const": "CANCELED" + }, + { + "const": "FAILED" + } + ] + }, + "BannerDto": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/BannerTypeEnum" + }, + "categoryId": { + "type": "string" + }, + "brandId": { + "type": "string" + }, + "brandSourcingTagId": { + "type": "string" + }, + "displayProductIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "displayProductCount": { + "type": "integer" + }, + "imageUrl": { + "type": "string" + }, + "linkUrl": { + "type": "string" + }, + "startAtMillis": { + "type": "integer", + "format": "int64" + }, + "endAtMillis": { + "type": "integer", + "format": "int64" + }, + "title": { + "type": "string" + }, + "subTitle": { + "type": "string" + }, + "enabled": { + "description": "(deprecated) enabled", + "type": "boolean" + }, + "note": { + "description": "(deprecated) note", + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "multiResolutionImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "displayProducts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BannerDisplayProductDto" + } + } + } + }, + "BannerDisplayProductDto": { + "type": "object", + "required": [ + "productId", + "imageUrl", + "finalPrice", + "title", + "brandName", + "discountPercentage" + ], + "properties": { + "productId": { + "type": "string" + }, + "imageUrl": { + "type": "string" + }, + "finalPrice": { + "type": "integer", + "format": "int64" + }, + "title": { + "description": "ๅ•†ๅ“ๅ", + "type": "string" + }, + "brandName": { + "type": "string" + }, + "discountPercentage": { + "description": "originalPrice ใ‚ณใƒณใƒˆใƒฉใ‚นใƒˆ finalPrice ใ‚ณใƒณใƒˆใƒฉใ‚นใƒˆๅ•†ๅ“ๅ‰ฒๅผ•็Ž‡", + "type": "integer", + "format": "int32" + }, + "maximumBenefitCouponAppliedFinalPrice": { + "type": "integer", + "format": "int64" + }, + "originalToMaximumBenefitCouponPricePercentage": { + "description": "originalPrice ใ‚ณใƒณใƒˆใƒฉใ‚นใƒˆ maximumBenefitCouponAppliedFinalPrice ใ‚ณใƒณใƒˆใƒฉใ‚นใƒˆๅ•†ๅ“ๅ‰ฒๅผ•็Ž‡", + "type": "integer", + "format": "int32" + } + } + }, + "BannerDataDto": { + "type": "object", + "required": [ + "type", + "imageUrl", + "linkUrl", + "title", + "enabled", + "note" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/BannerTypeEnum" + }, + "categoryId": { + "type": "string" + }, + "brandId": { + "type": "string" + }, + "brandSourcingTagId": { + "type": "string" + }, + "displayProductIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "displayProductCount": { + "type": "integer" + }, + "imageUrl": { + "type": "string" + }, + "linkUrl": { + "type": "string" + }, + "startAtMillis": { + "type": "integer", + "format": "int64" + }, + "endAtMillis": { + "type": "integer", + "format": "int64" + }, + "title": { + "type": "string" + }, + "subTitle": { + "type": "string" + }, + "enabled": { + "description": "(deprecated) enabled", + "type": "boolean" + }, + "note": { + "description": "(deprecated) note", + "type": "string" + } + } + }, + "BannerTypeEnum": { + "oneOf": [ + { + "const": "MAIN" + }, + { + "const": "STYLE" + }, + { + "const": "SUB" + }, + { + "const": "DISCOUNT" + }, + { + "const": "CATEGORY" + }, + { + "const": "BRAND" + }, + { + "const": "SECTION1" + }, + { + "const": "SECTION2" + }, + { + "const": "SPARE" + }, + { + "const": "BEST_TOP" + }, + { + "const": "DEPARTMENT_STORE" + }, + { + "const": "OUTLET" + }, + { + "const": "HOME_SHOPPING" + }, + { + "const": "SOHO_MALL" + }, + { + "const": "QUEENIT_EXCLUSIVE" + }, + { + "const": "DESIGNER" + }, + { + "const": "MAGAZINE" + }, + { + "const": "EVENT" + }, + { + "const": "BRAND_PROMOTION" + }, + { + "const": "SEARCH_HOME" + }, + { + "const": "MAIN_V2" + } + ], + "description": "SECTIONX is deprecated" + }, + "CollectionListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CollectionDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "CollectionDto": { + "type": "object", + "required": [ + "id", + "title", + "elements" + ], + "properties": { + "id": { + "type": "string" + }, + "title": { + "type": "string" + }, + "elements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CollectionElementDto" + } + } + } + }, + "CollectionElementDto": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/CollectionElementTypeEnum" + }, + "text": { + "$ref": "#/components/schemas/TextCollectionElementDto" + }, + "image": { + "$ref": "#/components/schemas/ImageCollectionElementDto" + }, + "products": { + "$ref": "#/components/schemas/ProductsCollectionElementDto" + }, + "videos": { + "$ref": "#/components/schemas/VideosCollectionElementDto" + }, + "link": { + "$ref": "#/components/schemas/LinkCollectionElementDto" + }, + "campaign": { + "$ref": "#/components/schemas/CampaignCollectionElementDto" + }, + "coupon": { + "$ref": "#/components/schemas/CouponCollectionElementDto" + }, + "imageLink": { + "$ref": "#/components/schemas/ImageLinkCollectionElementDto" + }, + "markdown": { + "$ref": "#/components/schemas/MarkdownCollectionElementDto" + }, + "pointPromotion": { + "$ref": "#/components/schemas/PointPromotionCollectionElementDto" + }, + "attendanceCheck": { + "$ref": "#/components/schemas/AttendanceCheckCollectionElementDto" + } + } + }, + "TextCollectionElementDto": { + "type": "object", + "required": [ + "type", + "text" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/CollectionTextTypeEnum" + }, + "text": { + "type": "string" + } + } + }, + "CollectionTextTypeEnum": { + "oneOf": [ + { + "const": "TITLE" + }, + { + "const": "SUBTITLE" + }, + { + "const": "BODY" + }, + { + "const": "DESCRIPTION" + } + ] + }, + "ImageCollectionElementDto": { + "required": [ + "imageUrl" + ], + "type": "object", + "properties": { + "imageUrl": { + "type": "string" + } + } + }, + "ImageLinkCollectionElementDto": { + "type": "object", + "required": [ + "imageUrl", + "linkUrl" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/ImageLinkTypeEnum" + }, + "imageUrl": { + "type": "string" + }, + "linkUrl": { + "type": "string" + }, + "campaign": { + "type": "string" + } + } + }, + "ProductsCollectionElementDto": { + "type": "object", + "required": [ + "columnCount", + "products", + "freeReturnTargetProductIds" + ], + "properties": { + "title": { + "type": "string" + }, + "columnCount": { + "type": "integer", + "format": "int32" + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDto" + } + }, + "freeReturnTargetProductIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "FreeReturnTargetFilterTypeEnum": { + "oneOf": [ + { + "const": "WHITELIST" + }, + { + "const": "BLACKLIST" + } + ] + }, + "FreeReturnTargetTypeEnum": { + "const": "PRODUCT" + }, + "FreeReturnPromotionTargetTypeEnum": { + "oneOf": [ + { + "const": "PRODUCT" + }, + { + "const": "BRAND_SOURCING" + } + ] + }, + "VideosCollectionElementDto": { + "type": "object", + "required": [ + "ids", + "isLandscape" + ], + "properties": { + "ids": { + "type": "array", + "items": { + "type": "string" + } + }, + "isLandscape": { + "type": "boolean" + } + } + }, + "OrientationTypeEnum": { + "oneOf": [ + { + "const": "PORTRAIT" + }, + { + "const": "LANDSCAPE" + } + ] + }, + "LinkCollectionElementDto": { + "type": "object", + "required": [ + "imageUrl", + "linkUrl" + ], + "properties": { + "imageUrl": { + "type": "string" + }, + "linkUrl": { + "type": "string" + }, + "campaign": { + "type": "string" + } + } + }, + "CampaignCollectionElementDto": { + "type": "object", + "required": [ + "imageUrl", + "campaign" + ], + "properties": { + "imageUrl": { + "type": "string" + }, + "message": { + "type": "string" + }, + "campaign": { + "type": "string" + } + } + }, + "CouponCollectionElementDto": { + "type": "object", + "required": [ + "imageUrl", + "couponCode" + ], + "properties": { + "imageUrl": { + "type": "string" + }, + "couponCode": { + "type": "string" + }, + "campaign": { + "type": "string" + } + } + }, + "MarkdownCollectionElementDto": { + "type": "object", + "required": [ + "markdown" + ], + "properties": { + "markdown": { + "type": "string" + } + } + }, + "PointPromotionCollectionElementDto": { + "type": "object", + "required": [ + "promotionCode", + "imageUrl" + ], + "properties": { + "promotionCode": { + "description": "็ฒๅพ—้‡‘ใƒ—ใƒญใƒขใƒผใ‚ทใƒงใƒณใ‚ณใƒผใƒ‰", + "type": "string" + }, + "amount": { + "description": "ใƒ—ใƒญใƒขใƒผใ‚ทใƒงใƒณๅ‡บๅธญใงๅ—ใ‘ๅ–ใ‚‹็ฒๅพ—้‡‘ใฎๆ•ฐ้‡", + "type": "integer", + "format": "int64" + }, + "imageUrl": { + "description": "็ฉ็ซ‹้‡‘็”ปๅƒURL", + "type": "string" + }, + "campaign": { + "description": "ใƒกใƒข็”จ้€”ใฎใƒ•ใ‚ฃใƒผใƒซใƒ‰", + "type": "string" + } + } + }, + "AttendanceCheckCollectionElementDto": { + "type": "object", + "required": [ + "title", + "imageUrl", + "kstStartDate", + "kstEndDate", + "numberOfAttendance", + "attendanceRewardPolicies" + ], + "properties": { + "id": { + "description": "ๅ‡บๅธญใƒใ‚งใƒƒใ‚ฏid", + "type": "string" + }, + "title": { + "type": "string" + }, + "imageUrl": { + "description": "ๅ‡บๅธญใƒใ‚งใƒƒใ‚ฏ็”ปๅƒURL", + "type": "string" + }, + "kstStartDate": { + "type": "string", + "description": "yyyy-mm-ddๅฝขๅผใฎๆ—ฅไป˜" + }, + "kstEndDate": { + "type": "string", + "description": "yyyy-mm-ddๅฝขๅผใฎๆ—ฅไป˜" + }, + "numberOfAttendance": { + "type": "integer", + "format": "int64" + }, + "attendanceRewardPolicies": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AttendanceRewardPolicyCollectionElementDto" + } + } + } + }, + "AttendanceRewardPolicyCollectionElementDto": { + "type": "object", + "required": [ + "type", + "pointAmount", + "pointExpireDays" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/AttendanceRewardPolicyTypeEnum" + }, + "pointAmount": { + "type": "integer", + "format": "int64" + }, + "pointExpireDays": { + "type": "integer" + } + } + }, + "AttendanceRewardPolicyTypeEnum": { + "oneOf": [ + { + "const": "DAILY_REWARD" + }, + { + "const": "ACHIEVEMENT_REWARD" + } + ] + }, + "ImageLinkTypeEnum": { + "oneOf": [ + { + "const": "COUPON" + }, + { + "const": "LINK" + } + ] + }, + "CollectionElementTypeEnum": { + "oneOf": [ + { + "const": "TEXT" + }, + { + "const": "IMAGE" + }, + { + "const": "PRODUCTS" + }, + { + "const": "VIDEOS" + }, + { + "const": "LINK" + }, + { + "const": "CAMPAIGN" + }, + { + "const": "COUPON" + }, + { + "const": "IMAGELINK" + }, + { + "const": "MARKDOWN" + }, + { + "const": "POINT_PROMOTION" + }, + { + "const": "ATTENDANCE_CHECK" + } + ] + }, + "UploadProductPageRequest": { + "type": "object", + "required": [ + "base64" + ], + "properties": { + "base64": { + "type": "string" + } + } + }, + "CouponBookDto": { + "type": "object", + "required": [ + "code", + "header", + "title", + "contents", + "pairContents", + "asset", + "coupons" + ], + "properties": { + "code": { + "type": "string" + }, + "header": { + "type": "string" + }, + "title": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "pairContents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ContentsPairDto" + } + }, + "asset": { + "$ref": "#/components/schemas/CouponBookAssetDto" + }, + "coupons": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCouponDto" + } + } + } + }, + "CouponBookAssetDto": { + "type": "object", + "required": [ + "primaryColor" + ], + "properties": { + "primaryColor": { + "$ref": "#/components/schemas/ColorGradientDto" + }, + "contentImageUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionContentImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + }, + "stickerImageUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionStickerImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + } + } + }, + "ContentsPairDto": { + "type": "object", + "required": [ + "first", + "second" + ], + "properties": { + "first": { + "type": "string" + }, + "second": { + "type": "string" + } + } + }, + "ColorGradientDto": { + "type": "object", + "required": [ + "startColorCode", + "endColorCode" + ], + "properties": { + "startColorCode": { + "type": "string", + "description": "start of gradient color code. (ex.\\#AABBCC)" + }, + "endColorCode": { + "type": "string", + "description": "end of gradient color code. (ex.\\#DDEEFF)" + } + } + }, + "IssuedCouponWhenOrderDto": { + "type": "object", + "properties": { + "issuedCouponId": { + "type": "integer", + "format": "int64" + }, + "coupon": { + "$ref": "#/components/schemas/CouponDto" + }, + "state": { + "$ref": "#/components/schemas/IssuedCouponStateEnum" + }, + "issuedAtMillis": { + "type": "integer", + "format": "int64" + }, + "activatingAtMillis": { + "type": "integer", + "format": "int64" + }, + "expiringAtMillis": { + "type": "integer", + "format": "int64" + }, + "linkUrl": { + "type": "string" + }, + "discountableAmount": { + "type": "integer", + "format": "int64" + }, + "consumable": { + "type": "boolean" + } + } + }, + "IssuedCouponDto": { + "type": "object", + "required": [ + "issuedCouponId", + "coupon", + "state", + "issuedAtMillis", + "activatingAtMillis" + ], + "properties": { + "issuedCouponId": { + "type": "integer", + "format": "int64" + }, + "coupon": { + "$ref": "#/components/schemas/CouponDto" + }, + "state": { + "$ref": "#/components/schemas/IssuedCouponStateEnum" + }, + "issuedAtMillis": { + "type": "integer", + "format": "int64" + }, + "activatingAtMillis": { + "type": "integer", + "format": "int64" + }, + "expiringAtMillis": { + "type": "integer", + "format": "int64" + }, + "linkUrl": { + "type": "string" + } + } + }, + "IssuedCouponStateEnum": { + "oneOf": [ + { + "const": "CONSUMED" + }, + { + "const": "EXPIRED" + }, + { + "const": "ACTIVATED" + }, + { + "const": "DISABLED" + } + ] + }, + "CouponDto": { + "type": "object", + "required": [ + "code", + "title", + "caution", + "conditionSummary", + "type" + ], + "properties": { + "code": { + "type": "string" + }, + "title": { + "type": "string" + }, + "manager": { + "type": "string" + }, + "caution": { + "type": "string" + }, + "conditionSummary": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/CouponTypeEnum" + }, + "discountAmount": { + "type": "integer", + "format": "int64", + "description": "field for CouponTypeEnum.DISCOUNT_BY_AMOUNT type." + }, + "discountPercentage": { + "type": "integer", + "format": "int64", + "description": "field for CouponTypeEnum.DISCOUNT_BY_PERCENTAGE type." + }, + "maxDiscountAmount": { + "type": "integer", + "format": "int64", + "description": "field for CouponTypeEnum.DISCOUNT_BY_PERCENTAGE type." + }, + "specialPrice": { + "type": "integer", + "format": "int64", + "description": "field for CouponTypeEnum.SPECIAL_PRICE type." + } + } + }, + "AppCouponDto": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "title": { + "type": "string" + }, + "manager": { + "type": "string" + }, + "caution": { + "type": "string" + }, + "conditionSummary": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/CouponTypeEnum" + }, + "discountAmount": { + "type": "integer", + "format": "int64", + "description": "field for CouponTypeEnum.DISCOUNT_BY_AMOUNT type." + }, + "discountPercentage": { + "type": "integer", + "format": "int64", + "description": "field for CouponTypeEnum.DISCOUNT_BY_PERCENTAGE type." + }, + "maxDiscountAmount": { + "type": "integer", + "format": "int64", + "description": "field for CouponTypeEnum.DISCOUNT_BY_PERCENTAGE type." + }, + "specialPrice": { + "type": "integer", + "format": "int64", + "description": "field for CouponTypeEnum.SPECIAL_PRICE type." + }, + "consumableCount": { + "type": "integer", + "format": "int64" + } + } + }, + "CouponDetailDto": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "title": { + "type": "string" + }, + "manager": { + "type": "string" + }, + "caution": { + "type": "string" + }, + "conditionSummary": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/CouponTypeEnum" + }, + "discountAmount": { + "type": "integer", + "format": "int64", + "description": "field for CouponTypeEnum.DISCOUNT_BY_AMOUNT type." + }, + "discountPercentage": { + "type": "integer", + "format": "int64", + "description": "field for CouponTypeEnum.DISCOUNT_BY_PERCENTAGE type." + }, + "maxDiscountAmount": { + "type": "integer", + "format": "int64", + "description": "field for CouponTypeEnum.DISCOUNT_BY_PERCENTAGE type." + }, + "specialPrice": { + "type": "integer", + "format": "int64", + "description": "field for CouponTypeEnum.SPECIAL_PRICE type." + }, + "expirationPolicy": { + "$ref": "#/components/schemas/CouponExpirationPolicyDto" + } + } + }, + "CouponExpirationPolicyDto": { + "type": "object", + "properties": { + "durationSecondsSinceHold": { + "type": "integer", + "format": "int64" + }, + "startAtMillis": { + "type": "integer", + "format": "int64" + }, + "endAtMillis": { + "type": "integer", + "format": "int64" + } + } + }, + "AppCouponListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCouponDto" + } + }, + "maximumDiscountCouponAppliedPrice": { + "description": "- ๆœ€ๅคงใ‚ฏใƒผใƒใƒณๅ‰ฒๅผ•ใŒ้ฉ็”จใ•ใ‚ŒใŸไพกๆ ผ - ใ“ใฎใƒ•ใ‚ฃใƒผใƒซใƒ‰ใฎๅ€คใŒใ€Œnullใ€ใฎๅ ดๅˆ - >ๆœ€ๅคงๅ‰ฒๅผ•ใ‚’่จˆ็ฎ—ใ™ใ‚‹ใŸใ‚ใฎๆกไปถใ‚’ๆบ€ใŸใ™ใ‚ฏใƒผใƒใƒณใŒใชใ„ใจ่ฆ‹ใชใ™", + "type": "integer", + "format": "int64" + } + } + }, + "CouponTypeEnum": { + "oneOf": [ + { + "const": "DISCOUNT_BY_AMOUNT" + }, + { + "const": "DISCOUNT_BY_PERCENTAGE" + }, + { + "const": "SPECIAL_PRICE" + } + ] + }, + "ApplyCouponRequestDto": { + "type": "object", + "required": [ + "issuedCouponId" + ], + "properties": { + "issuedCouponId": { + "type": "integer", + "format": "int64" + } + } + }, + "ApplyPointRequestDto": { + "type": "object", + "required": [ + "usePoint" + ], + "properties": { + "usePoint": { + "type": "integer", + "format": "int64" + } + } + }, + "ReleaseCouponResponseDto": { + "type": "object", + "required": [ + "priceSet", + "orderSummary" + ], + "properties": { + "priceSet": { + "$ref": "#/components/schemas/PriceSetDto" + }, + "orderSummary": { + "$ref": "#/components/schemas/OrderSummaryDto" + } + } + }, + "ApplyCouponResponseDto": { + "type": "object", + "required": [ + "priceSet", + "orderSummary" + ], + "properties": { + "priceSet": { + "$ref": "#/components/schemas/PriceSetDto" + }, + "orderSummary": { + "$ref": "#/components/schemas/OrderSummaryDto" + } + } + }, + "ApplyPointResponseDto": { + "type": "object", + "required": [ + "priceSet", + "orderSummary" + ], + "properties": { + "priceSet": { + "$ref": "#/components/schemas/PriceSetDto" + }, + "orderSummary": { + "$ref": "#/components/schemas/OrderSummaryDto" + } + } + }, + "ProductPriceDto": { + "type": "object", + "required": [ + "originalPrice", + "sellingPrice" + ], + "properties": { + "originalPrice": { + "type": "integer", + "format": "int64", + "description": "ๅฎšไพก" + }, + "sellingPrice": { + "type": "integer", + "format": "int64", + "description": "่ฒฉๅฃฒไพกๆ ผ" + } + } + }, + "ProductDiscountBenefitsDto": { + "type": "object", + "required": [ + "discountBenefitsByCoupon", + "discountBenefitsByPoint" + ], + "properties": { + "discountBenefitsByCoupon": { + "$ref": "#/components/schemas/ProductDiscountBenefitsInfoByCouponDto" + }, + "discountBenefitsByPoint": { + "type": "integer", + "format": "int64", + "description": "ๅˆฉ็”จๅฏ่ƒฝใชใƒใ‚คใƒณใƒˆ้ก" + } + } + }, + "ProductDiscountBenefitsInfoByCouponDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDiscountBenefitsInfoByCouponElementDto" + } + } + } + }, + "ProductDiscountBenefitsInfoByCouponElementDto": { + "type": "object", + "required": [ + "title", + "couponCode", + "discountAmount" + ], + "properties": { + "title": { + "type": "string" + }, + "couponCode": { + "type": "string" + }, + "discountAmount": { + "type": "integer", + "format": "int64" + } + } + }, + "CheckFirstKakaoLoginCouponIssuableResponseDto": { + "type": "object", + "required": [ + "isIssuable" + ], + "properties": { + "isIssuable": { + "type": "boolean" + } + } + }, + "AgeGroupFilterListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AgeGroupFilterDto" + } + } + } + }, + "AgeGroupFilterDto": { + "type": "object", + "required": [ + "code", + "alias" + ], + "properties": { + "code": { + "$ref": "#/components/schemas/AgeGroupCodeEnum" + }, + "alias": { + "type": "string" + } + } + }, + "CreatableReviewPromptDto": { + "type": "object", + "properties": { + "myOrderItem": { + "$ref": "#/components/schemas/MyOrderItemDto" + } + } + }, + "DisplayProductReviewListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DisplayProductReviewDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "DisplayProductReviewListDtoV2": { + "type": "object", + "required": [ + "list", + "totalPageCount", + "totalElementCount" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DisplayProductReviewDto" + } + }, + "totalPageCount": { + "type": "integer", + "format": "int32" + }, + "totalElementCount": { + "type": "integer", + "format": "int64" + } + } + }, + "RepresentativeProductReviewListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DisplayProductReviewDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "DisplayProductReviewDto": { + "type": "object", + "required": [ + "productReview", + "optionTitle", + "userProfileDisplayPolicy", + "favoriteData" + ], + "properties": { + "productReview": { + "$ref": "#/components/schemas/ProductReviewDto" + }, + "optionTitle": { + "type": "string" + }, + "userProfileDisplayPolicy": { + "$ref": "#/components/schemas/UserProfileDisplayPolicyDto" + }, + "favoriteData": { + "$ref": "#/components/schemas/ProductReviewFavoriteDataDto" + } + } + }, + "ProductReviewListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "ProductReviewDto": { + "type": "object", + "properties": { + "attributes": { + "$ref": "#/components/schemas/ProductReviewAttributeDto" + }, + "rating": { + "$ref": "#/components/schemas/ProductRatingEnum" + }, + "size": { + "$ref": "#/components/schemas/ProductSizeEnum" + }, + "brightness": { + "$ref": "#/components/schemas/ProductBrightnessEnum" + }, + "colorSense": { + "$ref": "#/components/schemas/ProductColorSenseEnum" + }, + "thickness": { + "$ref": "#/components/schemas/ProductThicknessEnum" + }, + "contents": { + "type": "string" + }, + "imageUrls": { + "description": "DEPRECATED", + "type": "array", + "items": { + "type": "string" + } + }, + "multiResolutionImages": { + "$ref": "#/components/schemas/MultiResolutionImageListDto" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "uid": { + "type": "string" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + }, + "userProfile": { + "$ref": "#/components/schemas/UserProfileDto" + } + } + }, + "ProductReviewFavoriteDataDto": { + "type": "object", + "required": [ + "favoriteCount", + "isMyFavorite" + ], + "properties": { + "favoriteCount": { + "type": "integer", + "format": "int64" + }, + "isMyFavorite": { + "type": "boolean", + "default": false + } + } + }, + "UpdateProductReviewRequestDto": { + "type": "object", + "required": [ + "reviewData" + ], + "properties": { + "reviewData": { + "$ref": "#/components/schemas/ProductReviewDataDto" + } + } + }, + "ProductCategoryReviewAttributeDto": { + "type": "object", + "required": [ + "productCategoryReviewGroupId", + "label", + "list", + "guide" + ], + "properties": { + "productCategoryReviewGroupId": { + "type": "string" + }, + "label": { + "type": "string" + }, + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryReviewAttributeItemDto" + } + }, + "guide": { + "$ref": "#/components/schemas/ProductCategoryReviewGuideDto" + } + } + }, + "ProductReviewAttributeDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewAttributeItemDto" + } + } + } + }, + "ProductCategoryReviewAttributeItemDto": { + "type": "object", + "required": [ + "code", + "label", + "options" + ], + "properties": { + "code": { + "type": "string" + }, + "label": { + "type": "string" + }, + "options": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewAttributeOptionItemDto" + } + } + } + }, + "ProductReviewAttributeItemDto": { + "type": "object", + "required": [ + "code", + "label", + "selectedOptions" + ], + "properties": { + "code": { + "type": "string" + }, + "label": { + "type": "string" + }, + "selectedOptions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewAttributeOptionItemDto" + } + } + } + }, + "ProductReviewAttributeOptionItemDto": { + "type": "object", + "required": [ + "code", + "label" + ], + "properties": { + "code": { + "type": "string" + }, + "label": { + "type": "string" + } + } + }, + "ProductCategoryReviewGuideDto": { + "type": "object", + "required": [ + "textGuides", + "imageWithTitles" + ], + "properties": { + "textGuides": { + "type": "array", + "items": { + "type": "string" + } + }, + "imageWithTitles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryReviewGuideImageWithTitleDto" + } + } + } + }, + "ProductCategoryReviewGuideImageWithTitleDto": { + "type": "object", + "required": [ + "imageUrl", + "title" + ], + "properties": { + "imageUrl": { + "type": "string" + }, + "title": { + "type": "string" + } + } + }, + "ProductReviewDataDto": { + "type": "object", + "required": [ + "rating" + ], + "properties": { + "attributes": { + "$ref": "#/components/schemas/ProductReviewAttributeDto" + }, + "rating": { + "$ref": "#/components/schemas/ProductRatingEnum" + }, + "size": { + "$ref": "#/components/schemas/ProductSizeEnum" + }, + "brightness": { + "$ref": "#/components/schemas/ProductBrightnessEnum" + }, + "colorSense": { + "$ref": "#/components/schemas/ProductColorSenseEnum" + }, + "thickness": { + "$ref": "#/components/schemas/ProductThicknessEnum" + }, + "contents": { + "type": "string" + }, + "imageUrls": { + "description": "DEPRECATED", + "type": "array", + "items": { + "type": "string" + } + }, + "multiResolutionImages": { + "$ref": "#/components/schemas/MultiResolutionImageListDto" + } + } + }, + "UserProfileDisplayPolicyDto": { + "type": "object", + "required": [ + "displayItemsOfUserProfile" + ], + "properties": { + "displayItemsOfUserProfile": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserProfileItemEnum" + } + } + } + }, + "UserProfileItemEnum": { + "oneOf": [ + { + "const": "HEIGHT_AS_CENTI_METER" + }, + { + "const": "WEIGHT_AS_KILO_GRAM" + }, + { + "const": "TOP_SIZE" + }, + { + "const": "BOTTOM_SIZE_AS_INCH" + }, + { + "const": "SHOE_SIZE_AS_MILLI_METER" + }, + { + "const": "AGE" + } + ] + }, + "ProductReviewCandidateListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewCandidateDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "ProductReviewCandidateDto": { + "type": "object", + "required": [ + "myOrderItem" + ], + "properties": { + "myOrderItem": { + "$ref": "#/components/schemas/MyOrderItemDto" + } + } + }, + "MyProductReviewListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MyProductReviewDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "MyProductReviewDto": { + "type": "object", + "required": [ + "myOrderItem" + ], + "properties": { + "myOrderItem": { + "$ref": "#/components/schemas/MyOrderItemDto" + } + } + }, + "ProductReviewItemListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ProductReviewStatisticsAttributeDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewStatisticsAttributeItemDto" + } + } + } + }, + "ProductReviewStatisticsAttributeItemDto": { + "type": "object", + "required": [ + "code", + "label", + "options" + ], + "properties": { + "code": { + "type": "string" + }, + "label": { + "type": "string" + }, + "options": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewStatisticsAttributeOptionItemDto" + } + } + } + }, + "ProductReviewStatisticsAttributeOptionItemDto": { + "type": "object", + "required": [ + "code", + "label", + "count" + ], + "properties": { + "code": { + "type": "string" + }, + "label": { + "type": "string" + }, + "percentage": { + "type": "integer", + "format": "int32" + }, + "count": { + "type": "integer", + "format": "int64" + } + } + }, + "ProductReviewStatisticsSummaryDto": { + "type": "object", + "required": [ + "ratingAverage", + "reviewCounts" + ], + "properties": { + "ratingAverage": { + "type": "number", + "format": "double" + }, + "reviewCounts": { + "type": "integer", + "format": "int64" + }, + "attributes": { + "$ref": "#/components/schemas/ProductReviewStatisticsAttributeDto" + }, + "satisfactionPercentage": { + "type": "integer", + "format": "int32" + }, + "topPercentageOfSize": { + "$ref": "#/components/schemas/ProductSizePercentageDto" + }, + "topPercentageOfBrightness": { + "$ref": "#/components/schemas/ProductBrightnessPercentageDto" + }, + "topPercentageOfColorSense": { + "$ref": "#/components/schemas/ProductColorSensePercentageDto" + }, + "topPercentageOfThickness": { + "$ref": "#/components/schemas/ProductThicknessPercentageDto" + } + } + }, + "ProductRatingStatisticsDto": { + "type": "object", + "required": [ + "percentages" + ], + "properties": { + "percentages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductRatingPercentageDto" + } + } + } + }, + "ProductRatingPercentageDto": { + "type": "object", + "required": [ + "rating", + "percentage" + ], + "properties": { + "rating": { + "$ref": "#/components/schemas/ProductRatingEnum" + }, + "percentage": { + "type": "integer", + "format": "int32" + } + } + }, + "ProductReviewSortOrderEnum": { + "oneOf": [ + { + "const": "CREATED_AT_DESC" + }, + { + "const": "CREATED_AT_ASC" + }, + { + "const": "REPORT_COUNT_DESC" + }, + { + "const": "RECOMMENDATION" + }, + { + "const": "REVIEW_RATING_DESC" + }, + { + "const": "REVIEW_RATING_ASC" + } + ] + }, + "ProductRatingEnum": { + "oneOf": [ + { + "const": 1 + }, + { + "const": 2 + }, + { + "const": 3 + }, + { + "const": 4 + }, + { + "const": 5 + } + ], + "x-enum-varnames": [ + "BAD", + "NOT_BAD", + "NORMAL", + "GOOD", + "BEST" + ] + }, + "ProductSizeStatisticsDto": { + "type": "object", + "required": [ + "percentages" + ], + "properties": { + "percentages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSizePercentageDto" + } + } + } + }, + "ProductSizePercentageDto": { + "type": "object", + "required": [ + "size" + ], + "properties": { + "size": { + "$ref": "#/components/schemas/ProductSizeEnum" + }, + "percentage": { + "type": "integer", + "format": "int32" + } + } + }, + "ProductSizeEnum": { + "oneOf": [ + { + "const": "SMALL" + }, + { + "const": "FITTED" + }, + { + "const": "BIG" + } + ] + }, + "ProductBrightnessStatisticsDto": { + "type": "object", + "required": [ + "percentages" + ], + "properties": { + "percentages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductBrightnessPercentageDto" + } + } + } + }, + "ProductBrightnessPercentageDto": { + "type": "object", + "required": [ + "brightness" + ], + "properties": { + "brightness": { + "$ref": "#/components/schemas/ProductBrightnessEnum" + }, + "percentage": { + "type": "integer", + "format": "int32" + } + } + }, + "ProductBrightnessEnum": { + "oneOf": [ + { + "const": "DARK" + }, + { + "const": "SAME_AS_PHOTO" + }, + { + "const": "BRIGHT" + } + ] + }, + "ProductColorSenseStatisticsDto": { + "type": "object", + "required": [ + "percentages" + ], + "properties": { + "percentages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductColorSensePercentageDto" + } + } + } + }, + "ProductColorSensePercentageDto": { + "type": "object", + "required": [ + "colorSense" + ], + "properties": { + "colorSense": { + "$ref": "#/components/schemas/ProductColorSenseEnum" + }, + "percentage": { + "type": "integer", + "format": "int32" + } + } + }, + "ProductColorSenseEnum": { + "oneOf": [ + { + "const": "BLURRY" + }, + { + "const": "SAME_AS_PHOTO" + }, + { + "const": "VIVID" + } + ] + }, + "ProductThicknessStatisticsDto": { + "type": "object", + "required": [ + "precentages" + ], + "properties": { + "percentages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductThicknessPercentageDto" + } + } + } + }, + "ProductThicknessPercentageDto": { + "type": "object", + "required": [ + "thickness" + ], + "properties": { + "thickness": { + "$ref": "#/components/schemas/ProductThicknessEnum" + }, + "percentage": { + "type": "integer", + "format": "int32" + } + } + }, + "ProductThicknessEnum": { + "oneOf": [ + { + "const": "THIN" + }, + { + "const": "NORMAL" + }, + { + "const": "THICK" + } + ] + }, + "ProductReviewReportDto": { + "type": "object", + "required": [ + "reason" + ], + "properties": { + "reason": { + "type": "string" + } + } + }, + "UserBirthYearDto": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "integer", + "format": "int32" + } + } + }, + "UserProfileDto": { + "type": "object", + "properties": { + "age": { + "type": "integer", + "format": "int32" + }, + "birthYear": { + "type": "integer", + "format": "int32" + }, + "bodySizeData": { + "$ref": "#/components/schemas/UserBodySizeDataDto" + } + } + }, + "UserBodySizeDataDto": { + "type": "object", + "properties": { + "heightAsCentiMeter": { + "type": "integer", + "format": "int32" + }, + "weightAsKiloGram": { + "type": "integer", + "format": "int32" + }, + "topSize": { + "type": "integer", + "format": "int32" + }, + "bottomSizeAsInch": { + "type": "integer", + "format": "int32" + }, + "shoeSizeAsMilliMeter": { + "type": "integer", + "format": "int32" + }, + "valid": { + "type": "boolean" + } + } + }, + "ExternalUidDto": { + "type": "object", + "properties": { + "externalUid": { + "type": "string" + } + } + }, + "ConnectPayCredentialDto": { + "type": "object", + "required": [ + "clientKey", + "customerKey", + "redirectUrl" + ], + "properties": { + "clientKey": { + "type": "string", + "description": "ใ‚ณใƒใ‚ฏใƒˆใƒšใ‚ค JS SDK ่ช่จผ็”จ clientKey" + }, + "customerKey": { + "type": "string", + "description": "ใŠๆ”ฏๆ‰•ใ„ใƒชใ‚ฏใ‚จใ‚นใƒˆใซไฝฟ็”จใ•ใ‚Œใ‚‹ใƒฆใƒผใ‚ถใƒผใฎ external uid" + }, + "redirectUrl": { + "type": "string", + "description": "ConnectPay OAuth่ช่จผใซไฝฟ็”จใ•ใ‚Œใ‚‹redirect url" + } + } + }, + "PaymentMethodResponseDto": { + "type": "object", + "required": [ + "cards", + "accounts" + ], + "properties": { + "cards": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CardPaymentDto" + } + }, + "accounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AccountPaymentDto" + } + } + } + }, + "CardPaymentDto": { + "type": "object", + "required": [ + "methodId", + "cardCompany", + "cardName", + "iconUrl", + "maskedCardNumber", + "enabled", + "registeredAtMillis" + ], + "properties": { + "methodId": { + "type": "string", + "description": "ๆฑบๆธˆๆ‰‹ๆฎตIdใ€ใ‚ณใƒใ‚ฏใƒˆใƒšใ‚คๆฑบๆธˆ่ฆๆฑ‚ใซไฝฟ็”จ" + }, + "cardCompany": { + "$ref": "#/components/schemas/TossPaymentCardEnum" + }, + "unknownCardCompanyName": { + "type": "string", + "description": "cardCompany ใฎๅ€คใŒ `UNKNOWN` ใฎๅ ดๅˆใฏ่ฉฒๅฝ“ใ™ใ‚‹ใ‚ซใƒผใƒ‰ไผš็คพใฎๅๅ‰ใ€unknown ใงใชใ„ๅ ดๅˆ null" + }, + "cardName": { + "type": "string", + "description": "ใ‚ซใƒผใƒ‰ๅ" + }, + "iconUrl": { + "type": "string", + "description": "ใ‚ซใƒผใƒ‰ไผš็คพใ‚ขใ‚คใ‚ณใƒณ็”ปๅƒurl" + }, + "maskedCardNumber": { + "type": "string", + "description": "ใƒžใ‚นใ‚ฏใ•ใ‚ŒใŸใ‚ซใƒผใƒ‰็•ชๅท" + }, + "enabled": { + "type": "boolean" + }, + "registeredAtMillis": { + "type": "integer", + "format": "int64", + "description": "็™ป้Œฒๆ—ฅ" + } + } + }, + "AccountPaymentDto": { + "type": "object", + "required": [ + "methodId", + "bank", + "iconUrl", + "maskedAccountNumber", + "enabled", + "registeredAtMillis" + ], + "properties": { + "methodId": { + "type": "string", + "description": "ๆฑบๆธˆๆ‰‹ๆฎตIdใ€ใ‚ณใƒใ‚ฏใƒˆใƒšใ‚คๆฑบๆธˆ่ฆๆฑ‚ใซไฝฟ็”จ" + }, + "bank": { + "$ref": "#/components/schemas/TossPaymentAccountEnum" + }, + "unknownBankName": { + "type": "string", + "description": "bankๅ€คใŒ `UNKNOWN`ใฎๅ ดๅˆใฏๅฏพๅฟœใ™ใ‚‹้Š€่กŒใฎๅๅ‰ใ€unknownใงใชใ„ๅ ดๅˆใฏnull" + }, + "iconUrl": { + "type": "string", + "description": "้Š€่กŒใ‚ขใ‚คใ‚ณใƒณ็”ปๅƒURL" + }, + "maskedAccountNumber": { + "type": "string", + "description": "ใƒžใ‚นใ‚ฏใ•ใ‚ŒใŸๅฃๅบง็•ชๅท" + }, + "enabled": { + "type": "boolean" + }, + "registeredAtMillis": { + "type": "integer", + "format": "int64", + "description": "็™ป้Œฒๆ—ฅ" + } + } + }, + "TierDto": { + "type": "object", + "required": [ + "uid", + "totalPurchaseAmount", + "tierRankType" + ], + "properties": { + "uid": { + "description": "ใƒฆใƒผใ‚ถใƒผID", + "type": "string" + }, + "totalPurchaseAmount": { + "description": "็ดฏ็ฉ่ณผๅ…ฅ็ขบๅฎš้‡‘้ก๏ผˆ้ŽๅŽป3ใƒถๆœˆๅ€ค่ณผๅ…ฅ็ขบๅฎš้‡‘้กใ€ex-8ๆœˆ7ๆ—ฅ็…งไผšๆ™‚5,6,7ๆœˆ็ตฑ่จˆ็ทๅˆ้‡‘้ก๏ผ‰", + "type": "integer", + "format": "int64" + }, + "tierRankType": { + "$ref": "#/components/schemas/TierRankTypeEnum" + } + } + }, + "TierRankTypeEnum": { + "oneOf": [ + { + "const": "DIAMOND" + }, + { + "const": "PLATINUM" + }, + { + "const": "GOLD" + }, + { + "const": "SILVER" + } + ], + "description": "ใƒ†ใ‚ฃใ‚ขใ‚ฟใ‚คใƒ—" + }, + "NextTierInfoDto": { + "type": "object", + "required": [ + "uid", + "nextTierRankType", + "startTierRankTypeForGraph", + "endTierRankTypeForGraph", + "totalPurchaseAmount", + "remainAmount", + "startAtMillis" + ], + "properties": { + "uid": { + "description": "ใƒฆใƒผใ‚ถใƒผID", + "type": "string" + }, + "nextTierRankType": { + "$ref": "#/components/schemas/TierRankTypeEnum" + }, + "startTierRankTypeForGraph": { + "$ref": "#/components/schemas/TierRankTypeEnum" + }, + "endTierRankTypeForGraph": { + "$ref": "#/components/schemas/TierRankTypeEnum" + }, + "totalPurchaseAmount": { + "description": "็ดฏ็ฉ่ณผๅ…ฅ็ขบๅฎš้‡‘้ก๏ผˆ้ŽๅŽป2ใƒถๆœˆ็ตฑ่จˆ้‡+็…งไผšๆœˆใƒชใ‚ขใƒซใ‚ฟใ‚คใƒ ่ณผๅ…ฅ็ขบๅฎš้‡‘้ก๏ผ‰", + "type": "integer", + "format": "int64" + }, + "remainAmount": { + "description": "ๆฌกใฎ้šŽใพใงๆฎ‹ใฃใŸ้‡‘้ก", + "type": "integer", + "format": "int64" + }, + "startAtMillis": { + "type": "integer", + "format": "int64", + "description": "ใƒ†ใ‚ฃใ‚ข็ญ‰็ดš็ฎ—ๅฎš้–‹ๅง‹ๆœŸ้–“" + }, + "tierChangeStatus": { + "$ref": "#/components/schemas/TierChangeStatusEnum" + } + } + }, + "TierChangeStatusEnum": { + "oneOf": [ + { + "const": "RISE" + }, + { + "const": "HOLD" + }, + { + "const": "FALL" + } + ], + "description": "ใƒ†ใ‚ฃใ‚ขๅค‰ๆ›ด็Šถๆ…‹ใ‚ฟใ‚คใƒ—" + }, + "ImageCategoryEnum": { + "oneOf": [ + { + "const": "PRODUCT_REVIEW" + }, + { + "const": "ORDER_LINE_RETURN" + } + ] + }, + "UploadableImageResponseDto": { + "type": "object", + "required": [ + "url", + "uploadedUrl", + "expiredAtMillis" + ], + "properties": { + "url": { + "type": "string" + }, + "uploadedUrl": { + "type": "string" + }, + "expiredAtMillis": { + "type": "integer", + "format": "int64" + } + } + }, + "UploadImageResponseDto": { + "type": "object", + "required": [ + "imageUrl", + "multiResolutionImage" + ], + "properties": { + "imageUrl": { + "description": "DEPRECATED", + "type": "string" + }, + "multiResolutionImage": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + } + } + }, + "Base64ImageUploadRequestDto": { + "type": "object", + "required": [ + "name", + "base64" + ], + "properties": { + "name": { + "type": "string" + }, + "base64": { + "type": "string" + } + } + }, + "ShopLiveTokenResponseDto": { + "type": "object", + "required": [ + "accessToken" + ], + "properties": { + "accessToken": { + "type": "string", + "description": "7ๆ—ฅๅพŒใซๆœŸ้™ๅˆ‡ใ‚Œ" + } + } + }, + "ShopLiveTokenRequestDto": { + "type": "object", + "properties": { + "userName": { + "type": "string", + "description": "ใƒฆใƒผใ‚ถใƒผใƒใƒฃใƒƒใƒˆๅ" + } + } + }, + "ShopLiveCampaignMetadataResponseDto": { + "type": "object", + "required": [ + "campaignAccessKey", + "campaignMetadataState" + ], + "properties": { + "campaignKey": { + "type": "string", + "description": "ใ‚ญใƒฃใƒณใƒšใƒผใƒณใ‚ญใƒผ" + }, + "campaignAccessKey": { + "type": "string", + "description": "ใ‚ญใƒฃใƒณใƒšใƒผใƒณ Access key" + }, + "title": { + "type": "string", + "description": "ใ‚ญใƒฃใƒณใƒšใƒผใƒณใ‚ฟใ‚คใƒˆใƒซ" + }, + "campaignMetadataState": { + "$ref": "#/components/schemas/ShopLiveCampaignMetadataStateEnum" + }, + "liveUrl": { + "type": "string", + "description": "ๅ‹•็”ปๅ†็”Ÿ URL" + }, + "posterUrl": { + "type": "string", + "description": "ๆ”พ้€ไบˆๅ‘Š็”ปๅƒURL" + }, + "poster2Url": { + "type": "string", + "description": "ๆ”พ้€็ต‚ไบ†ๅพŒใฎ็”ปๅƒURL" + }, + "scheduledAt": { + "type": "integer", + "format": "int64", + "description": "ๆ”พ้€ไบˆๅฎšๆ™‚้–“" + }, + "scheduledEndAt": { + "type": "integer", + "format": "int64", + "description": "ๆ”พ้€็ต‚ไบ†ไบˆๅฎšๆ™‚้–“" + }, + "startedAt": { + "type": "integer", + "format": "int64", + "description": "ๆ”พ้€้–‹ๅง‹ๆ™‚้–“" + }, + "closingAt": { + "type": "integer", + "format": "int64", + "description": "nๅˆ†ๅพŒใซ็ต‚ไบ†ใ‚’่จญๅฎšใ—ใŸใจใใฎๅฎŸ้š›ใฎ็ต‚ไบ†ไบˆๅฎšๆ™‚้–“" + }, + "endedAt": { + "type": "integer", + "format": "int64", + "description": "ๆ”พ้€็ต‚ไบ†ๆ™‚้–“" + } + } + }, + "ShopLiveCampaignResponseDto": { + "type": "object", + "required": [ + "campaignAccessKey", + "campaignState" + ], + "properties": { + "campaignKey": { + "type": "string", + "description": "ใ‚ญใƒฃใƒณใƒšใƒผใƒณใ‚ญใƒผ" + }, + "campaignAccessKey": { + "type": "string", + "description": "ใ‚ญใƒฃใƒณใƒšใƒผใƒณ Access key" + }, + "campaignUrl": { + "type": "string", + "description": "ใ‚ญใƒฃใƒณใƒšใƒผใƒณ URL" + }, + "title": { + "type": "string", + "description": "ใ‚ญใƒฃใƒณใƒšใƒผใƒณใ‚ฟใ‚คใƒˆใƒซ" + }, + "memo": { + "type": "string", + "description": "ใ‚ญใƒฃใƒณใƒšใƒผใƒณใƒŽใƒผใƒˆ" + }, + "campaignState": { + "$ref": "#/components/schemas/ShopLiveCampaignStateEnum" + }, + "campaignGoodsList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShopLiveCampaignGoodsDto" + } + }, + "campaignGoodsCount": { + "type": "integer", + "format": "int32", + "description": "ใ‚ญใƒฃใƒณใƒšใƒผใƒณใซ็™ป้Œฒๅ•†ๅ“ๆ•ฐ" + }, + "userCount": { + "type": "integer", + "format": "int32", + "description": "็ดฏ็ฉ่ฆ–่ด่€…ๆ•ฐ" + }, + "adoreCount": { + "type": "integer", + "format": "int32", + "description": "ใ„ใ„ใญ" + }, + "posterUrl": { + "type": "string", + "description": "ๆ”พ้€ไบˆๅ‘Š็”ปๅƒURL" + }, + "poster2Url": { + "type": "string", + "description": "ๆ”พ้€็ต‚ไบ†ๅพŒใฎ็”ปๅƒURL" + }, + "unsupportInfoUrl": { + "type": "string", + "description": "IEๆœชใ‚ตใƒใƒผใƒˆใ‚ฌใ‚คใƒ‰็”ปๅƒURL" + }, + "previewLiveUrl": { + "type": "string", + "description": "ๆ”พ้€ใƒ—ใƒฌใƒ“ใƒฅใƒผURL" + }, + "replayLiveUrl": { + "type": "string", + "description": "ๆ”พ้€ใฎๅ†่กจ็คบ URL" + }, + "liveUrl": { + "type": "string", + "description": "ๅ‹•็”ปๅ†็”Ÿ URL" + }, + "backgroundUrl": { + "type": "string", + "description": "่ƒŒๆ™ฏ็”ปๅƒURL" + }, + "scheduledAt": { + "type": "integer", + "format": "int64", + "description": "ๆ”พ้€ไบˆๅฎšๆ™‚้–“" + }, + "scheduledEndAt": { + "type": "integer", + "format": "int64", + "description": "ๆ”พ้€็ต‚ไบ†ไบˆๅฎšๆ™‚้–“" + }, + "startedAt": { + "type": "integer", + "format": "int64", + "description": "ๆ”พ้€้–‹ๅง‹ๆ™‚้–“" + }, + "endedAt": { + "type": "integer", + "format": "int64", + "description": "ๆ”พ้€็ต‚ไบ†ๆ™‚้–“" + } + } + }, + "ShopLiveCampaignGoodsDto": { + "type": "object", + "required": [ + "campaignId", + "goodsId", + "name", + "url", + "action", + "payload", + "showingNow", + "soldOut", + "originalPrice", + "currency", + "traceId" + ], + "properties": { + "campaignId": { + "type": "integer", + "format": "int64", + "description": "ใ‚ญใƒฃใƒณใƒšใƒผใƒณID" + }, + "goodsId": { + "type": "integer", + "format": "int64", + "description": "ๅ•†ๅ“ID" + }, + "name": { + "type": "string", + "description": "ๅ•†ๅ“ๅ" + }, + "brand": { + "type": "string", + "description": "ๅ•†ๅ“ใƒ–ใƒฉใƒณใƒ‰" + }, + "description": { + "type": "string", + "description": "ๅ•†ๅ“่ชฌๆ˜Ž" + }, + "url": { + "type": "string", + "description": "ๅ•†ๅ“็งปๅ‹• URL" + }, + "sku": { + "type": "string", + "description": "ๅ•†ๅ“ใ‚ณใƒผใƒ‰" + }, + "action": { + "$ref": "#/components/schemas/ShopLiveCampaignGoodsActionTypeEnum" + }, + "payload": { + "type": "string", + "description": "ๅ•†ๅ“ใฎใ‚ฏใƒชใƒƒใ‚ฏๆ™‚ใซ็งปๅ‹•ใ™ใ‚‹URLๆƒ…ๅ ฑใ‚’ๅซใ‚€jsonๆ–‡ๅญ—ๅˆ—" + }, + "medias": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShopLiveCampaignGoodsMediaDto" + } + }, + "showingNow": { + "type": "boolean", + "description": "ๅ•†ๅ“้œฒๅ‡บใฎๆœ‰็„ก" + }, + "soldOut": { + "type": "boolean", + "description": "ๅ•†ๅ“ๅฎŒๅฃฒใ‹ใฉใ†ใ‹" + }, + "originalPrice": { + "type": "number", + "format": "double", + "description": "ๅ•†ๅ“ๅŸบๆœฌไพกๆ ผ" + }, + "discountedPrice": { + "type": "number", + "format": "double", + "description": "ๅ•†ๅ“ๅ‰ฒๅผ•ไพกๆ ผ" + }, + "discountPercentage": { + "type": "number", + "format": "double", + "description": "ๅ•†ๅ“ๅ‰ฒๅผ•็Ž‡" + }, + "currency": { + "type": "string", + "description": "ๅ•†ๅ“ใƒฆใƒ‹ใƒƒใƒˆ" + }, + "traceId": { + "type": "string", + "description": "ไธŠ้™ใ‚ฏใƒชใƒƒใ‚ฏใƒˆใƒฉใƒƒใ‚ญใƒณใ‚ฐID" + } + } + }, + "ShopLiveCampaignGoodsMediaDto": { + "type": "object", + "required": [ + "id", + "mediaType", + "url", + "size", + "width", + "height" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "ใƒกใƒ‡ใ‚ฃใ‚ขID" + }, + "mediaType": { + "$ref": "#/components/schemas/ShopLiveCampaignGoodsMediaTypeEnum" + }, + "url": { + "type": "string", + "description": "ๅ•†ๅ“ใƒกใƒ‡ใ‚ฃใ‚ขใฎURL" + }, + "size": { + "type": "integer", + "format": "int64", + "description": "ๅ•†ๅ“ใƒกใƒ‡ใ‚ฃใ‚ขใ‚ตใ‚คใ‚บ" + }, + "width": { + "type": "integer", + "format": "int32", + "description": "ๅ•†ๅ“ใƒกใƒ‡ใ‚ฃใ‚ขๆจชใ‚ตใ‚คใ‚บ" + }, + "height": { + "type": "integer", + "format": "int32", + "description": "ๅ•†ๅ“ใƒกใƒ‡ใ‚ฃใ‚ข็ธฆใ‚ตใ‚คใ‚บ" + } + } + }, + "ReferralCodeDto": { + "type": "object", + "required": [ + "referralCode" + ], + "properties": { + "referralCode": { + "type": "string" + } + } + }, + "CategoryBestProductDto": { + "type": "object", + "required": [ + "isBest" + ], + "properties": { + "categoryId": { + "type": "string" + }, + "categoryTitle": { + "type": "string" + }, + "isBest": { + "type": "boolean" + }, + "createdAtMillis": { + "type": "integer", + "format": "int64" + }, + "updatedAtMillis": { + "type": "integer", + "format": "int64" + } + } + }, + "ShopLiveCampaignMetadataStateEnum": { + "oneOf": [ + { + "const": "NOT_EXIST" + }, + { + "const": "READY" + }, + { + "const": "ONAIR" + }, + { + "const": "CLOSING" + }, + { + "const": "CLOSED" + } + ], + "description": "- `NOT_EXIST` ->ๅญ˜ๅœจใ—ใชใ„ใ‚ญใƒฃใƒณใƒšใƒผใƒณ - `READY` ->ๆบ–ๅ‚™ไธญ - `ONAIR` ->ๆ”พ้€ไธญ - `CLOSING` ->็ต‚ไบ†ไธญ - `CLOSED` ->็ต‚ไบ†" + }, + "ShopLiveCampaignStateEnum": { + "oneOf": [ + { + "const": "NOT_EXIST" + }, + { + "const": "READY" + }, + { + "const": "ONAIR" + }, + { + "const": "CLOSED" + } + ], + "description": "- `NOT_EXIST` ->ๅญ˜ๅœจใ—ใชใ„ใ‚ญใƒฃใƒณใƒšใƒผใƒณ - `READY` ->ๆบ–ๅ‚™ไธญ - `ONAIR` ->ๆ”พ้€ไธญ - `CLOSED` ->็ต‚ไบ†" + }, + "ShopLiveCampaignGoodsActionTypeEnum": { + "const": "LINK" + }, + "ShopLiveCampaignGoodsMediaTypeEnum": { + "const": "IMAGE" + }, + "MultiResolutionImageDto": { + "type": "object", + "required": [ + "url_1x", + "url_2x", + "url_3x" + ], + "properties": { + "url_1x": { + "type": "string" + }, + "url_2x": { + "type": "string" + }, + "url_3x": { + "type": "string" + } + } + }, + "MultiResolutionImageListDto": { + "type": "object", + "required": [ + "urls_1x", + "urls_2x", + "urls_3x" + ], + "properties": { + "urls_1x": { + "type": "array", + "items": { + "type": "string" + } + }, + "urls_2x": { + "type": "array", + "items": { + "type": "string" + } + }, + "urls_3x": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SellerContentImagesDto": { + "type": "object", + "required": [ + "contentType", + "multiResolutionImages" + ], + "properties": { + "contentType": { + "$ref": "damoa-seller-api.yaml#/components/schemas/SellerContentTypeEnum" + }, + "multiResolutionImages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MultiResolutionImageDto" + } + } + } + }, + "UserDeliveryAddressAddRequestDto": { + "type": "object", + "required": [ + "address" + ], + "properties": { + "address": { + "$ref": "#/components/schemas/DeliveryAddressDto" + }, + "request": { + "type": "string", + "description": "้…้€ใƒชใ‚ฏใ‚จใ‚นใƒˆ" + } + } + }, + "UserDeliveryAddressDto": { + "type": "object", + "required": [ + "id", + "address" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "minimum": 1 + }, + "address": { + "$ref": "#/components/schemas/DeliveryAddressDto" + }, + "request": { + "type": "string", + "description": "้…้€ใƒชใ‚ฏใ‚จใ‚นใƒˆ" + } + } + }, + "PointHistoryBundleResponseDto": { + "type": "object", + "required": [ + "PointHistoyDto" + ], + "properties": { + "PointHistories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PointHistoryResponseDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "PointHistoryResponseDto": { + "type": "object", + "required": [ + "id", + "title", + "amount", + "amountType", + "expiredDetails", + "occurrenceAtMillis", + "occurrenceType", + "occurrenceId" + ], + "properties": { + "id": { + "type": "string", + "description": "็ฒๅพ—้‡‘ๅฑฅๆญดๅ›บๆœ‰ใฎID" + }, + "title": { + "type": "string" + }, + "subTitle": { + "type": "string" + }, + "amount": { + "type": "integer", + "format": "int64" + }, + "amountType": { + "$ref": "#/components/schemas/PointAmountTypeEnum" + }, + "expiredDetails": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PointAccumulateDetailResponseDto" + } + }, + "occurrenceAtMillis": { + "description": "็ฉ็ซ‹้‡‘ๅฑฅๆญด็™บ็”Ÿๆ™‚้–“(epochMilliSeconds)", + "type": "integer", + "format": "int64" + }, + "occurrenceType": { + "$ref": "#/components/schemas/PointOccurrenceTypeEnum" + }, + "occurrenceId": { + "description": "็ฉ็ซ‹้‡‘็™บ็”Ÿๅ…ƒID occurrenceTypeใซๅฟœใ˜ใฆ็•ฐใชใ‚‹ๅ››ๅŠๆœŸ", + "type": "string" + } + } + }, + "PointAmountTypeEnum": { + "oneOf": [ + { + "const": "PLUS" + }, + { + "const": "MINUS" + } + ] + }, + "PointOccurrenceTypeEnum": { + "oneOf": [ + { + "const": "ACCUMULATE_EVENT" + }, + { + "const": "ACCUMULATE_ORDER_ACCEPT" + }, + { + "const": "WITHDRAW_ORDER_CANCEL" + }, + { + "const": "USE_ADMIN" + }, + { + "const": "ACCUMULATE_ADMIN" + }, + { + "const": "USE_ORDER_CREATE" + }, + { + "const": "EXPIRED" + } + ], + "description": "- ็ฉ็ซ‹้‡‘ใฎ็ฒๅพ—/ไฝฟ็”จ/ๆถˆๆป…/ใ‚ญใƒฃใƒณใ‚ปใƒซใฎ็™บ็”Ÿใ‚ฟใ‚คใƒ— - ACCUMULATE_EVENTใ‚คใƒ™ใƒณใƒˆใง็ฒๅพ— - ACCUMULATE_ORDER_ACCEPTๆณจๆ–‡็ขบๅฎšใง็ฒๅพ— - WITHDRAW_ORDER_CANCELๆณจๆ–‡ใ‚ญใƒฃใƒณใ‚ปใƒซใงๆ‰•ใ„ๆˆปใ—ใ‚’็ฒๅพ— - USE_ADMIN็ฎก็†่€…ใŒๅทฎใ—ๅผ•ใ - USUM_ATE_ADMIN็ฎก็†่€…ใจใ—ใฆ็ฒๅพ—ไฝฟ็”จๆธˆใฟ - EXPIRED ๆœŸ้™ๅˆ‡ใ‚Œ" + }, + "PointAccumulateDetailResponseDto": { + "type": "object", + "required": [ + "id", + "expiredAtMillis", + "amount" + ], + "properties": { + "id": { + "description": "็ฒๅพ—้‡‘ๅฑฅๆญดๅ›บๆœ‰ใฎ่ฉณ็ดฐID", + "type": "string" + }, + "expiredAtMillis": { + "type": "integer", + "format": "int64" + }, + "amount": { + "type": "integer", + "format": "int64" + } + } + }, + "NowUsablePointDto": { + "type": "object", + "required": [ + "amount" + ], + "properties": { + "amount": { + "type": "integer", + "format": "int64" + } + } + }, + "PromotionAttendedStateDto": { + "type": "object", + "required": [ + "attended" + ], + "properties": { + "attended": { + "type": "boolean" + } + } + }, + "ProductAggregationDto": { + "type": "object", + "description": "ๅ•†ๅ“้›†่จˆ", + "required": [ + "productFeatureGroupAggregationList" + ], + "properties": { + "totalCount": { + "type": "integer", + "format": "int64" + }, + "productFeatureGroupAggregationList": { + "deprecated": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductFeatureGroupAggregationDto" + } + }, + "productAggregationGroup": { + "$ref": "#/components/schemas/ProductAggregationGroupDto" + } + } + }, + "ProductAggregationGroupDto": { + "type": "object", + "description": "ๅ•†ๅ“้›†่จˆๆƒ…ๅ ฑใ‚ฐใƒซใƒผใƒ—", + "required": [ + "productFeatureGroupAggregationList", + "productCategoryAggregationList", + "brandAggregationList" + ], + "properties": { + "productFeatureGroupAggregationList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductFeatureGroupAggregationDto" + } + }, + "productCategoryAggregationList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryAggregationDto" + } + }, + "brandAggregationList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BrandAggregationDto" + } + } + } + }, + "ProductFeatureGroupAggregationDto": { + "type": "object", + "description": "groupใ”ใจใซๅฑžๆ€งใ‚ฟใ‚ฐใฎๆ•ฐใ‚’้™้ †ใซไธ‹ใ’ใ‚‹", + "properties": { + "group": { + "$ref": "#/components/schemas/ProductFeatureGroupDto" + }, + "productFeatureAggregation": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductFeatureAggregationDto" + } + } + } + }, + "ProductFeatureAggregationDto": { + "type": "object", + "properties": { + "productFeature": { + "$ref": "#/components/schemas/ProductFeatureDto" + }, + "count": { + "type": "integer", + "format": "int64" + } + } + }, + "ProductCategoryAggregationDto": { + "type": "object", + "properties": { + "categoryId": { + "type": "string" + }, + "count": { + "type": "integer", + "format": "int64" + } + } + }, + "BrandAggregationDto": { + "type": "object", + "properties": { + "brandName": { + "type": "string" + }, + "count": { + "type": "integer", + "format": "int64" + } + } + }, + "ProductFeatureListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductFeatureDto" + } + } + } + }, + "ProductFeatureDto": { + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string" + }, + "title": { + "type": "string" + }, + "groupId": { + "type": "string" + }, + "groupTitle": { + "type": "string" + } + } + }, + "ProductFeatureGroupDto": { + "type": "object", + "required": [ + "id", + "title" + ], + "properties": { + "id": { + "type": "string" + }, + "title": { + "type": "string" + } + } + }, + "UserReferralSummaryDto": { + "type": "object", + "required": [ + "totalAccrualPoint", + "totalReferralCount", + "totalUnopenedBonusBoxCount" + ], + "properties": { + "totalAccrualPoint": { + "description": "ใƒฆใƒผใ‚ถใƒผๆŽจๅฅจ็ท็ฉ็ฎ—้ก๏ผˆใƒœใƒผใƒŠใ‚นๅ ฑ้…ฌๅซใ‚€๏ผ‰", + "type": "integer", + "format": "int64" + }, + "totalReferralCount": { + "description": "็ทใƒฆใƒผใ‚ถใƒผๆŽจๅฅจๆ•ฐ", + "type": "integer", + "format": "int64" + }, + "totalUnopenedBonusBoxCount": { + "description": "ใพใ ้–‹ใ„ใฆใ„ใชใ„ใƒœใƒผใƒŠใ‚นใƒœใƒƒใ‚ฏใ‚นๆ•ฐ", + "type": "integer", + "format": "int64" + } + } + }, + "UserReferralRewardSummaryDto": { + "type": "object", + "required": [ + "totalAccrualPoint", + "totalReferral" + ], + "properties": { + "totalAccrualPoint": { + "type": "integer", + "format": "int64" + } + } + }, + "UserReferralBonusBoxOpenResultDto": { + "type": "object", + "required": [ + "pointAmount" + ], + "properties": { + "pointAmount": { + "type": "integer", + "format": "int64", + "description": "BonusBoxใ‹ใ‚‰ๅพ—ใŸ็ฉ็ซ‹้‡‘" + } + } + }, + "UserReferralRewardPolicyDto": { + "type": "object", + "required": [ + "totalAccrualLimitByReferral", + "validDaysByReferral", + "joinRewardAmountForReferee", + "bonusBoxPolicies" + ], + "properties": { + "totalAccrualLimitByReferral": { + "type": "integer", + "format": "int64" + }, + "validDaysByReferral": { + "type": "integer", + "format": "int32" + }, + "joinRewardAmountForReferee": { + "type": "integer", + "format": "int64" + }, + "bonusBoxPolicies": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BonusBoxPolicyDto" + } + } + } + }, + "BonusBoxPolicyDto": { + "type": "object", + "description": "ใƒœใƒผใƒŠใ‚นใƒœใƒƒใ‚ฏใ‚นใ‚’็™บ่กŒใ™ใ‚‹ใŸใ‚ใฎๆ–น้‡", + "required": [ + "bonusRewardType", + "referralCount" + ], + "properties": { + "bonusRewardType": { + "$ref": "#/components/schemas/BonusRewardTypeEnum" + }, + "referralCount": { + "description": "bonusBoxใ‚’ๅ—ใ‘ๅ–ใ‚‹ใŸใ‚ใซๆบ€ใŸใ™ๅฟ…่ฆใŒใ‚ใ‚‹referralใฎๆ•ฐ", + "type": "integer", + "format": "int32" + } + } + }, + "BonusRewardTypeEnum": { + "oneOf": [ + { + "const": "REPEAT" + }, + { + "const": "ONE_TIME" + } + ], + "description": "ใƒœใƒผใƒŠใ‚นใƒœใƒƒใ‚ฏใ‚น็™บ่กŒใƒใƒชใ‚ทใƒผใ‚ฟใ‚คใƒ—๏ผš*็นฐใ‚Š่ฟ”ใ—ๅ ฑ้…ฌ๏ผˆREPEAT๏ผ‰๏ผšreferralCountใŒๆบ€ใŸใ•ใ‚Œใ‚‹ใŸใณใซใƒœใƒผใƒŠใ‚นใƒœใƒƒใ‚ฏใ‚นๆ”ฏๆ‰•ใ„๏ผˆไพ‹๏ผš5ใซ่จญๅฎšใ•ใ‚Œใฆใ„ใ‚‹ๅ ดๅˆใฏ5,10,15,20..ใ”ใจใซๆ”ฏๆ‰•ใ‚ใ‚Œใ‚‹๏ผ‰*ใƒฏใƒณใ‚ฟใ‚คใƒ ๅ ฑ้…ฌ๏ผˆONE_TIME๏ผ‰๏ผšreferralCountใŒๆบ€ใŸใ•ใ‚ŒใŸๅ ดๅˆใƒฏใƒณใ‚ฟใ‚คใƒ ๆ”ฏๆ‰•ใ„" + }, + "UserReferralRewardEstimationRequestDto": { + "type": "object", + "required": [ + "phoneNumbers" + ], + "properties": { + "phoneNumbers": { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + } + }, + "UserReferralRewardEstimationDto": { + "type": "object", + "required": [ + "phoneNumber", + "pointAmount", + "rewarded" + ], + "properties": { + "phoneNumber": { + "type": "string" + }, + "pointAmount": { + "type": "integer", + "format": "int64", + "description": "ๆŽจๅฅจ็ฉ็ซ‹้‡‘่ฆ‹็ฉ้ก" + }, + "rewarded": { + "type": "boolean", + "description": "ๆ—ขใซใŠใ™ใ™ใ‚ใงๅ ฑใ‚ใ‚Œใฆใ„ใ‚‹ใ‹ใฉใ†ใ‹" + } + } + }, + "UserReferralRewardEstimationListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserReferralRewardEstimationDto" + } + } + } + }, + "CreateUserReferralRequestDto": { + "type": "object", + "required": [ + "phoneNumber", + "referrerName", + "dynamicLink" + ], + "properties": { + "phoneNumber": { + "type": "string" + }, + "referrerName": { + "type": "string" + }, + "dynamicLink": { + "type": "string" + }, + "message": { + "type": "string" + } + } + }, + "CreateUserReferralResponseDto": { + "type": "object", + "required": [ + "reward" + ], + "properties": { + "reward": { + "$ref": "#/components/schemas/ReferralRewardResultDto" + } + } + }, + "CreateProductReferralRequestDto": { + "type": "object", + "required": [ + "orderLineId", + "productId", + "referralCode" + ], + "properties": { + "orderLineId": { + "type": "string" + }, + "productId": { + "type": "string" + }, + "referralCode": { + "type": "string" + } + } + }, + "ReferralRewardResultDto": { + "type": "object", + "description": "ใŠใ™ใ™ใ‚ๅ ฑ้…ฌๆƒ…ๅ ฑ", + "required": [ + "pointAmount" + ], + "properties": { + "pointAmount": { + "type": "integer", + "format": "int64", + "description": "็ฒๅพ—้‡‘้ก" + } + } + }, + "JoinReferredUserRequestDto": { + "type": "object", + "required": [ + "referralCode" + ], + "properties": { + "referralCode": { + "type": "string" + } + } + }, + "JoinReferredUserResponseDto": { + "type": "object", + "required": [ + "reward" + ], + "properties": { + "reward": { + "$ref": "#/components/schemas/ReferralRewardResultDto" + } + } + }, + "ActiveGameListResponse": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GameDto" + } + } + } + }, + "GameUserProgressInfoResponse": { + "type": "object", + "required": [ + "level", + "exp", + "requiredExpToNextLevel", + "inGameCredit", + "isGameAchievable", + "gameAchievedCount" + ], + "properties": { + "level": { + "type": "integer", + "format": "int32" + }, + "exp": { + "type": "integer", + "format": "int32" + }, + "requiredExpToNextLevel": { + "type": "integer", + "format": "int32" + }, + "inGameCredit": { + "type": "integer", + "format": "int32" + }, + "isGameAchievable": { + "type": "boolean" + }, + "gameAchievedCount": { + "type": "integer", + "format": "int32" + } + } + }, + "GameUseInGameCreditRequest": { + "type": "object", + "required": [ + "useCredit" + ], + "properties": { + "useCredit": { + "type": "integer", + "format": "int32" + } + } + }, + "GameDto": { + "type": "object", + "required": [ + "gameId", + "title", + "rewardTitle" + ], + "properties": { + "gameId": { + "type": "string" + }, + "title": { + "type": "string" + }, + "rewardTitle": { + "description": "ๅ ฑ้…ฌๅ(ex.ใ‚ณใƒผใƒ’ใƒผใ‚ฎใƒ•ใƒ†ใ‚ฃใ‚ณใƒณ)", + "type": "string" + } + } + }, + "GameMissionsResponse": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GameMissionDto" + } + } + } + }, + "GameMissionAchieveRequest": { + "type": "object", + "required": [ + "missionType" + ], + "properties": { + "missionType": { + "$ref": "#/components/schemas/GameMissionTypeEnum" + }, + "referenceId": { + "description": "ใƒŸใƒƒใ‚ทใƒงใƒณใซๅฟœใ˜ใฆไป˜ๅŠ ๆƒ…ๅ ฑใ‚’็››ใ‚Š่พผใ‚€ใŸใ‚ใฎใƒ•ใ‚ฃใƒผใƒซใƒ‰๏ผˆex.ไผ็”ปๅฑ•ID๏ผ‰", + "type": "string" + } + } + }, + "GameMissionRewardReceiveResponse": { + "type": "object", + "required": [ + "inGameCredit" + ], + "properties": { + "inGameCredit": { + "type": "integer", + "format": "int32" + } + } + }, + "GameMissionDto": { + "type": "object", + "required": [ + "id", + "title", + "inGameCreditReward", + "missionType", + "completeCount", + "isRewardReceivable" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "inGameCreditReward": { + "type": "integer", + "format": "int32" + }, + "repeatIntervalInMins": { + "type": "integer", + "format": "int64" + }, + "missionType": { + "$ref": "#/components/schemas/GameMissionTypeEnum" + }, + "referenceId": { + "description": "ใƒŸใƒƒใ‚ทใƒงใƒณใซๅฟœใ˜ใฆไป˜ๅŠ ๆƒ…ๅ ฑใ‚’็››ใ‚Š่พผใ‚€ใŸใ‚ใฎใƒ•ใ‚ฃใƒผใƒซใƒ‰๏ผˆex.ไผ็”ปๅฑ•ID๏ผ‰", + "type": "string" + }, + "resetCycleDays": { + "type": "integer", + "format": "int32" + }, + "maxCompleteCount": { + "type": "integer", + "format": "int32" + }, + "lastCompletedAtMillis": { + "type": "integer", + "format": "int64" + }, + "completeCount": { + "type": "integer", + "format": "int32" + }, + "isRewardReceivable": { + "type": "boolean" + } + } + }, + "GameAchieveRequest": { + "type": "object", + "required": [ + "phoneNumber" + ], + "properties": { + "phoneNumber": { + "type": "string" + } + } + }, + "GameMissionTypeEnum": { + "oneOf": [ + { + "const": "PURCHASE_PRODUCT" + }, + { + "const": "FE_VALID_ATTENDANCE" + }, + { + "const": "FE_VALID_VIEWING_TO_30_SEC_RECOMMENDED" + }, + { + "const": "FE_VALID_VIEWING_TO_30_SEC_STYLE_SHOT" + }, + { + "const": "FE_VALID_VIEWING_TO_30_SEC_COLLECTION" + }, + { + "const": "FE_VALID_VIEWING_TO_30_SEC_NEW_IN_PRODUCT" + }, + { + "const": "FE_VALID_VIEWING_TO_30_SEC_BEST" + }, + { + "const": "FE_VALID_VIEWING_TO_30_SEC_HOT_DEAL" + }, + { + "const": "FE_VALID_VIEWING_TO_30_SEC_SHOPPING_MALL" + }, + { + "const": "FE_VALID_VIEWING_TO_30_SEC_DESIGNER" + } + ] + }, + "AutocompleteResponseDto": { + "type": "object", + "required": [ + "brands" + ], + "properties": { + "brands": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BrandAutocompleteCandidateDto" + } + } + } + }, + "BrandAutocompleteCandidateDto": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "ProductCategoryReviewGuideDataDto": { + "type": "object", + "required": [ + "textGuides", + "imageWithTitles", + "type", + "gridImage" + ], + "properties": { + "textGuides": { + "type": "array", + "items": { + "type": "string" + } + }, + "imageWithTitles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCategoryReviewGuideImageWithTitleDto" + } + }, + "type": { + "$ref": "#/components/schemas/ProductCategoryReviewGuideTypeEnum" + }, + "gridImage": { + "type": "string" + } + } + }, + "ProductCategoryReviewGuideTypeEnum": { + "oneOf": [ + { + "const": "IMAGE_WITH_TITLE" + }, + { + "const": "GRID_IMAGE" + }, + { + "const": "NONE" + } + ], + "description": "ๅ†™็œŸใƒฌใƒ“ใƒฅใƒผใ‚ฌใ‚คใƒ‰ใฎ็จฎ้กž" + }, + "StyleShotListDto": { + "type": "object", + "required": [ + "list", + "last" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StyleShotDto" + } + }, + "nextCursor": { + "type": "string" + }, + "last": { + "type": "boolean" + } + } + }, + "StyleShotDto": { + "type": "object", + "required": [ + "id", + "styleShotImages", + "styleCategory", + "equippedProductItemIds" + ], + "properties": { + "id": { + "description": "ใ‚นใ‚ฟใ‚คใƒซใ‚ทใƒงใƒƒใƒˆid", + "type": "string" + }, + "styleShotImages": { + "description": "ใ‚นใ‚ฟใ‚คใƒซใ‚ทใƒงใƒƒใƒˆ็”ปๅƒURL", + "type": "array", + "minItems": 1, + "maxItems": 4, + "items": { + "$ref": "#/components/schemas/StyleShotImageDto" + } + }, + "styleShotTags": { + "description": "ใ‚นใ‚ฟใ‚คใƒซใ‚ทใƒงใƒƒใƒˆใ‚ฟใ‚ฐIDใƒชใ‚นใƒˆ", + "type": "array", + "items": { + "type": "string" + } + }, + "styleCategory": { + "$ref": "#/components/schemas/StyleCategoryDto" + }, + "equippedProductItemIds": { + "description": "็€็”จๅ•†ๅ“ใ‚ขใ‚คใƒ†ใƒ IDใ€empty listใฎใฟๅฟœ็ญ”(deprecated)", + "type": "array", + "items": { + "type": "string" + } + }, + "text": { + "type": "string" + }, + "editor": { + "type": "string" + }, + "fashionModelHeightAsCentiMeter": { + "type": "integer", + "format": "int32" + }, + "fashionModelWeightAsKiloGram": { + "type": "integer", + "format": "int32" + }, + "fashionModelShoeSizeAsMilliMeter": { + "type": "integer", + "format": "int32" + } + } + }, + "EquippedProductListDto": { + "type": "object", + "required": [ + "equippedProducts", + "favoriteIds", + "freeReturnTargetProductIds" + ], + "properties": { + "equippedProducts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EquippedProductDto" + } + }, + "freeReturnTargetProductIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "StyleShotImageDto": { + "required": [ + "id", + "url_1x", + "url_2x", + "url_3x", + "priority" + ], + "properties": { + "id": { + "description": "ใ‚คใƒกใƒผใ‚ธid", + "type": "string" + }, + "url_1x": { + "type": "string" + }, + "url_2x": { + "type": "string" + }, + "url_3x": { + "type": "string" + }, + "priority": { + "description": "็”ปๅƒ็…งไผšๆ™‚ใฎ้ †ๅบ๏ผˆ1ใ‹ใ‚‰ๆ˜‡้ †๏ผ‰", + "minimum": 1, + "type": "integer", + "format": "int32" + } + } + }, + "StyleCategoryDto": { + "type": "object", + "required": [ + "id", + "name", + "priority" + ], + "properties": { + "id": { + "description": "ใ‚นใ‚ฟใ‚คใƒซใ‚ซใƒ†ใ‚ดใƒชid", + "type": "integer", + "format": "int64" + }, + "name": { + "description": "ใ‚นใ‚ฟใ‚คใƒซใ‚ซใƒ†ใ‚ดใƒชใƒใƒณใ‚ฐใƒซๅ", + "type": "string" + }, + "representative_url_1x": { + "type": "string" + }, + "representative_url_2x": { + "type": "string" + }, + "representative_url_3x": { + "type": "string" + }, + "priority": { + "description": "ใ‚นใ‚ฟใ‚คใƒซใ‚ซใƒ†ใ‚ดใƒชใฎ็…งไผšๆ™‚ใฎ้ †ๅบ", + "type": "integer", + "format": "int32" + } + } + }, + "StyleCategoryListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StyleCategoryDto" + } + } + } + }, + "DeliveryPredictionListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeliveryPredictionDto" + } + } + } + }, + "DeliveryPredictionDto": { + "type": "object", + "required": [ + "kstDeliveryPredictionDate", + "probability" + ], + "properties": { + "kstDeliveryPredictionDate": { + "type": "string", + "description": "ISO-8601ใƒ•ใ‚ฉใƒผใƒžใƒƒใƒˆๆ–‡ๅญ—ๅˆ—(uuuu-MM-dd)" + }, + "probability": { + "description": "ใใฎๆ—ฅไป˜ใซๅ‡บ่ทใŒๅฎŒไบ†ใ™ใ‚‹็ขบ็Ž‡", + "type": "integer", + "format": "int32" + } + } + }, + "PurchaseMeasurementsStatisticsListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PurchaseMeasurementsStatisticsDto" + } + } + } + }, + "PurchaseMeasurementsStatisticsDto": { + "type": "object", + "required": [ + "size", + "count", + "ratio" + ], + "properties": { + "size": { + "description": "ๅ•†ๅ“ใ‚ตใ‚คใ‚บใ‚ชใƒ—ใ‚ทใƒงใƒณใ‚ฟใ‚คใƒˆใƒซ", + "type": "string" + }, + "count": { + "description": "่ณผๅ…ฅๆ•ฐ", + "type": "integer", + "format": "int64" + }, + "ratio": { + "description": "่ณผๅ…ฅใฎ็ทๆ•ฐใซๅฏพใ™ใ‚‹ๅ‰ฒๅˆ", + "type": "integer", + "format": "int32" + } + } + }, + "PurchaseMeasurementsDto": { + "type": "object", + "required": [ + "bodySizeType", + "isSimilarBodySize", + "list" + ], + "properties": { + "bodySizeType": { + "$ref": "#/components/schemas/BodySizeTypeEnum" + }, + "isSimilarBodySize": { + "description": "้กžไผผไฝ“ๅž‹่ณผๅ…ฅใƒ‡ใƒผใ‚ฟใ‹ใฉใ†ใ‹", + "type": "boolean" + }, + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PurchaserSizeDto" + } + } + } + }, + "PurchaserSizeDto": { + "type": "object", + "required": [ + "purchaserBodySize", + "purchaseSizeOptionName" + ], + "properties": { + "purchaserBodySize": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PurchaserBodySizeDto" + } + }, + "purchaseSizeOptionName": { + "description": "่ณผๅ…ฅใ—ใŸใ‚ตใ‚คใ‚บใ‚ชใƒ—ใ‚ทใƒงใƒณใ‚ฟใ‚คใƒˆใƒซ", + "type": "string" + } + } + }, + "PurchaserBodySizeDto": { + "type": "object", + "required": [ + "type", + "value" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/BodySizeTypeEnum" + }, + "value": { + "description": "ใƒใ‚คใƒคใƒผใฎใ‚ตใ‚คใ‚บ", + "type": "integer", + "format": "int32" + } + } + }, + "BodySizeTypeEnum": { + "oneOf": [ + { + "const": "HEIGHT_AS_CENTI_METER" + }, + { + "const": "WEIGHT_AS_KILO_GRAM" + }, + { + "const": "TOP_SIZE" + }, + { + "const": "BOTTOM_SIZE_AS_INCH" + }, + { + "const": "SHOE_SIZE_AS_MILLI_METER" + } + ] + }, + "AttendanceCheckHistoryListDto": { + "type": "object", + "required": [ + "list" + ], + "properties": { + "list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AttendanceCheckHistoryDto" + } + } + } + }, + "AttendanceCheckHistoryDto": { + "type": "object", + "required": [ + "days", + "attended", + "rewardPolicyType", + "pointAmount" + ], + "properties": { + "days": { + "description": "ๅ‡บๅธญใƒใ‚งใƒƒใ‚ฏnๆ—ฅ็›ฎ", + "type": "integer", + "format": "int32" + }, + "pointAmount": { + "description": "ๅ‡บๅธญใƒใ‚งใƒƒใ‚ฏๅ‚ๅŠ ๆ™‚ใฎ็ฉ็ซ‹้‡‘้ก", + "type": "integer", + "format": "int64" + }, + "attended": { + "description": "ๅ‡บๅธญใƒใ‚งใƒƒใ‚ฏใซๅ‚ๅŠ ใ™ใ‚‹ใ‹ใฉใ†ใ‹", + "type": "boolean" + }, + "attendedAt": { + "description": "ๅ‡บๅธญใƒใ‚งใƒƒใ‚ฏๅ‚ๅŠ ๆ™‚้–“ epochMillis (ๅ‡บๅธญใ—ใชใ‹ใฃใŸๅ ดๅˆ null)", + "type": "integer", + "format": "int64" + }, + "rewardPolicyType": { + "$ref": "#/components/schemas/AttendanceRewardPolicyTypeEnum" + } + } + }, + "ApiErrorResponse": { + "type": "object", + "properties": { + "msg": { + "type": "string", + "description": "reason for error" + }, + "traceId": { + "type": "string", + "description": "trace id for debug" + }, + "code": { + "oneOf": [ + { + "const": -999999 + }, + { + "const": -888888 + }, + { + "const": 1 + }, + { + "const": 2 + }, + { + "const": 3 + }, + { + "const": 4 + }, + { + "const": 5 + }, + { + "const": 6 + }, + { + "const": 7 + }, + { + "const": 1001 + }, + { + "const": 1002 + }, + { + "const": 1003 + }, + { + "const": 1004 + }, + { + "const": 60001 + }, + { + "const": 60002 + }, + { + "const": 61001 + }, + { + "const": 61002 + }, + { + "const": 61003 + }, + { + "const": 61004 + }, + { + "const": 61005 + }, + { + "const": 62001 + }, + { + "const": 62002 + }, + { + "const": 70001 + }, + { + "const": 70003 + }, + { + "const": 2001 + }, + { + "const": 2002 + }, + { + "const": 3001 + }, + { + "const": 4001 + }, + { + "const": 4002 + }, + { + "const": 5001 + }, + { + "const": 6001 + }, + { + "const": 6002 + }, + { + "const": 6003 + }, + { + "const": 7001 + }, + { + "const": 7002 + }, + { + "const": 7003 + }, + { + "const": 7004 + }, + { + "const": 7005 + }, + { + "const": 7006 + }, + { + "const": 7007 + }, + { + "const": 7008 + }, + { + "const": 7009 + }, + { + "const": 7010 + }, + { + "const": 7011 + }, + { + "const": 8001 + }, + { + "const": 9001 + } + ], + "x-enum-varnames": [ + "INTERNAL_FAILURE", + "EXTERNAL_FAILURE", + "ALREADY_EXISTS", + "NOT_AUTHORIZED", + "INVALID_VALUE", + "RESOURCE_NOT_FOUND", + "LIMITATION_EXCEEDED", + "LOGIN_REQUIRED", + "ACCESS_DENIED", + "ACCESS_TOKEN_EXPIRED", + "REFRESH_TOKEN_EXPIRED", + "INVALID_ACCESS_TOKEN", + "INVALID_REFRESH_TOKEN", + "COUPON_NOT_ENABLED", + "COUPON_NOT_CONSUMABLE", + "COUPON_ISSUE_BEFORE_BEGIN", + "COUPON_ISSUE_AFTER_END", + "COUPON_ISSUE_LIMIT_EXCEEDED", + "COUPON_ISSUE_LIMIT_PER_USER_EXCEEDED", + "COUPON_ISSUE_NOT_TARGET", + "COUPON_BOOK_ISSUABLES_NOT_EXIST", + "DISPLAYING_COUPONS_ISSUABLE_NOT_EXIST", + "PAYMENT_NOT_FULLY_PAID", + "MINIMUM_PAYMENT_PRICE_LIMIT_EXCEPTION", + "REVIEW_REPORTED_BY_SELF", + "REVIEW_REPORTED_TWICE", + "VALIDATAION_BANK_ACCOUNT_FAILURE", + "DUPLICATED_MALL_PRODUCT_CODE", + "PRODUCT_WITHOUT_POLICY_TARGET", + "DUPLICATED_BRAND_CODE", + "SEND_DELIVERY_TRACE_REQUEST_FAILED", + "RECEIVE_DELIVERY_TRACE_RESULT_FAILED", + "SEND_DELIVERY_TRACE_RESULT_RESPONSE_FAILED", + "TICKET_PROCESSING_IS_REQUIRED_TO_CONFIRM_RECEIPT", + "CAN_ONLY_CONFIRM_RECEIPT_OF_PAID_ORDER_LINE", + "CANNOT_CONFIRM_RECEIPT_WHEN_DELIVERY_NOT_COMPLETE", + "CANNOT_REQUEST_REFUND_AFTER_CONFIRM_RECEIPT", + "LACK_OF_POINT", + "ORDER_LINE_COUNT_LIMIT_PER_ORDER_EXCEEDED", + "ORDER_ALREADY_DISPATCHED", + "CANNOT_CHANGE_DELIVERY_AREA", + "ORDER_UNAVAILABLE_PRODUCT_ITEM", + "CANNOT_APPEND_TICKET", + "CANNOT_EXCEED_ALREADY_REQUESTED_AMOUNT", + "ATTENDANCE_CHECK_COMPLETED", + "PRODUCT_NOT_BELONGS_TO_BRAND" + ] + } + } + } + }, + "securitySchemes": { + "damoa-token": { + "type": "http", + "scheme": "bearer", + "bearerFormat": "JWT" + } + } + }, + "x-samchon-emended": true +} \ No newline at end of file diff --git a/assets/output/fireblocks.swagger.ar.json b/assets/output/fireblocks.swagger.ar.json new file mode 100644 index 0000000..d7ef113 --- /dev/null +++ b/assets/output/fireblocks.swagger.ar.json @@ -0,0 +1,16347 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช Fireblocks", + "version": "1.0.0", + "contact": { + "email": "support@fireblocks.com" + } + }, + "servers": [ + { + "url": "https://api.fireblocks.io/v1" + } + ], + "x-readme": { + "explorer-enabled": false, + "samples-languages": [ + "curl", + "javascript", + "python" + ] + }, + "paths": { + "/vault/accounts": { + "get": { + "summary": "ู‚ุงุฆู…ุฉ ุญุณุงุจุงุช ุงู„ุฎุฒู†ุฉ", + "description": "ูŠุญุตู„ ุนู„ู‰ ุฌู…ูŠุน ุญุณุงุจุงุช ุงู„ุฎุฒู†ุฉ ููŠ ู…ุณุงุญุฉ ุงู„ุนู…ู„ ุงู„ุฎุงุตุฉ ุจูƒ.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vault_accounts = fireblocks.get_vault_accounts()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAccounts = await fireblocks.getVaultAccounts();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "query", + "name": "namePrefix", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "nameSuffix", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minAmountThreshold", + "required": false, + "schema": { + "type": "number" + } + }, + { + "in": "query", + "name": "assetId", + "required": false, + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "ู‚ุงุฆู…ุฉ ุญุณุงุจุงุช ุงู„ุฎุฒู†ุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VaultAccount" + } + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "ุฅู†ุดุงุก ุญุณุงุจ ุฎุฒู†ุฉ ุฌุฏูŠุฏ", + "description": "ุฅู†ุดุงุก ุญุณุงุจ ุฎุฒู†ุฉ ุฌุฏูŠุฏ ุจุงู„ุงุณู… ุงู„ู…ุทู„ูˆุจ.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAccount = fireblocks.create_vault_account(name, hiddenOnUI, customer_ref_id, auto_fueling)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAccount = await fireblocks.createVaultAccount(name, hiddenOnUI, customerRefId, autoFueling);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "description": "ุฅุณู… ุงู„ุญุณุงุจ", + "type": "string" + }, + "hiddenOnUI": { + "description": "ุงุฎุชูŠุงุฑูŠ - ุฅุฐุง ูƒุงู† ู‡ุฐุง ุตุญูŠุญู‹ุงุŒ ูู„ู† ูŠุชู… ุนุฑุถ ุงู„ุญุณุงุจ ุงู„ุฐูŠ ุชู… ุฅู†ุดุงุคู‡ ูˆุฌู…ูŠุน ุงู„ู…ุนุงู…ู„ุงุช ุงู„ู…ุฑุชุจุทุฉ ุจู‡ ุนู„ู‰ ูˆุญุฏุฉ ุชุญูƒู… Fireblocks", + "type": "boolean" + }, + "customerRefId": { + "description": "ุงุฎุชูŠุงุฑูŠ - ุชุนูŠูŠู† ู…ุนุฑู ู…ุฑุฌุน ุงู„ุนู…ูŠู„", + "type": "string" + }, + "autoFuel": { + "description": "ุงุฎุชูŠุงุฑูŠ - ุชุนูŠูŠู† ุฎุงุตูŠุฉ autoFuel ู„ุญุณุงุจ ุงู„ุฎุฒู†ุฉ", + "type": "boolean" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "ูƒุงุฆู† ุญุณุงุจ ุงู„ุฎุฒู†ุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/VaultAccount" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts_paged": { + "get": { + "summary": "ู‚ุงุฆู…ุฉ ุญุณุงุจุงุช ุงู„ุฎุฒู†ุฉ (ู…ู‚ุณู…ุฉ ุฅู„ู‰ ุตูุญุงุช)", + "description": "ูŠุญุตู„ ุนู„ู‰ ุฌู…ูŠุน ุญุณุงุจุงุช ุงู„ุฎุฒู†ุฉ ููŠ ู…ุณุงุญุฉ ุงู„ุนู…ู„ ุงู„ุฎุงุตุฉ ุจูƒ. ุชุนูŠุฏ ู‡ุฐู‡ ุงู„ู†ู‚ุทุฉ ุงู„ู†ู‡ุงุฆูŠุฉ ุนุฏุฏู‹ุง ู…ุญุฏูˆุฏู‹ุง ู…ู† ุงู„ู†ุชุงุฆุฌ ู…ุน ูˆู‚ุช ุงุณุชุฌุงุจุฉ ุณุฑูŠุน.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vault_accounts = fireblocks.get_vault_accounts_with_page_info(filters)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAccounts = await fireblocks.getVaultAccountsWithPageInfo(filters);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "query", + "name": "namePrefix", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "nameSuffix", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minAmountThreshold", + "required": false, + "schema": { + "type": "number" + } + }, + { + "in": "query", + "name": "assetId", + "required": false, + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + }, + { + "in": "query", + "name": "orderBy", + "required": false, + "schema": { + "oneOf": [ + { + "const": "ASC" + }, + { + "const": "DESC" + } + ] + } + }, + { + "in": "query", + "name": "before", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "after", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "number", + "minimum": 1, + "maximum": 500, + "default": 200 + } + } + ], + "responses": { + "200": { + "description": "ูƒุงุฆู† VaultAccountsPagedResponse", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/VaultAccountsPagedResponse" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}": { + "get": { + "summary": "ุงู„ุนุซูˆุฑ ุนู„ู‰ ุญุณุงุจ ุงู„ุฎุฒู†ุฉ ุนู† ุทุฑูŠู‚ ุงู„ู…ุนุฑู", + "description": "ุฅุฑุฌุงุน ุญุณุงุจ ุงู„ุฎุฒู†ุฉ ุงู„ู…ุทู„ูˆุจ.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vault_account = fireblocks.get_vault_account(vault_account_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAccount = await fireblocks.getVaultAccount(vault_account_id);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "ู…ุนุฑู ุญุณุงุจ ุงู„ุฎุฒู†ุฉ ุงู„ู…ุฑุงุฏ ุฅุฑุฌุงุน ุงู„ู†ูˆุน: ุณู„ุณู„ุฉ", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + } + ], + "responses": { + "200": { + "description": "ูƒุงุฆู† ุญุณุงุจ ุงู„ุฎุฒู†ุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/VaultAccount" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "put": { + "summary": "ุฅุนุงุฏุฉ ุชุณู…ูŠุฉ ุญุณุงุจ ุงู„ุฎุฒู†ุฉ", + "description": "ุฅุนุงุฏุฉ ุชุณู…ูŠุฉ ุญุณุงุจ ุงู„ุฎุฒู†ุฉ ุงู„ู…ุทู„ูˆุจ.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAccount = fireblocks.update_vault_account(vault_account_id, name)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAccount = await fireblocks.updateVaultAccount(vautlAccountId, name);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "ู…ุนุฑู ุญุณุงุจ ุงู„ุฎุฒู†ุฉ ุงู„ู…ุฑุงุฏ ุชุนุฏูŠู„ู‡", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "description": "ุฅุณู… ุงู„ุญุณุงุจ", + "type": "string" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "ู†ุนู…", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/asset_wallets": { + "get": { + "summary": "ู‚ุงุฆู…ุฉ ู…ุญุงูุธ ุงู„ุฃุตูˆู„ (ู…ู‚ุณู…ุฉ ุฅู„ู‰ ุตูุญุงุช)", + "description": "ูŠุญุตู„ ุนู„ู‰ ุฌู…ูŠุน ู…ุญุงูุธ ุงู„ุฃุตูˆู„ ููŠ ุฌู…ูŠุน ุญุณุงุจุงุช ุงู„ุฎุฒู†ุฉ ููŠ ู…ุณุงุญุฉ ุงู„ุนู…ู„ ุงู„ุฎุงุตุฉ ุจูƒ. ู…ุญูุธุฉ ุงู„ุฃุตูˆู„ ู‡ูŠ ุฃุตู„ ููŠ ุญุณุงุจ ุงู„ุฎุฒู†ุฉ. ุชุชูŠุญ ู‡ุฐู‡ ุงู„ุทุฑูŠู‚ุฉ ุงู„ุชู†ู‚ู„ ุงู„ุณุฑูŠุน ู„ุฌู…ูŠุน ุฃุฑุตุฏุฉ ุงู„ุญุณุงุจุงุช. **ู…ู„ุงุญุธุฉ:** - ุชุชูˆูุฑ ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ู‡ุฐู‡ ุจุดูƒู„ ู…ุญุฏูˆุฏ ูˆู…ุชุงุญุฉ ู„ุนู…ู„ุงุก ู…ุญุฏุฏูŠู†. ุฅุฐุง ูƒู†ุช ุชุฑุบุจ ููŠ ุงู„ุญุตูˆู„ ุนู„ู‰ ูˆุตูˆู„ ู…ุจูƒุฑ ุฅู„ู‰ ู†ู‚ุทุฉ ุงู„ู†ู‡ุงูŠุฉ ู‡ุฐู‡ุŒ ููŠุฑุฌู‰ ุงู„ุชูˆุงุตู„ ู…ุน [ุฏุนู… Fireblocks](https://support.fireblocks.io/hc/en-us/requests/new?ticket_form_id=36000337220) - ุชุฎุถุน ู…ูƒุงู„ู…ุฉ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ู‡ุฐู‡ ู„ู€ [ุญุฏูˆุฏ ุงู„ู…ุนุฏู„](https://developers.fireblocks.com/reference/rate-limiting).", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vault_accounts = fireblocks.get_asset_wallets(filters)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAccounts = await fireblocks.getAssetWallets(filters);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "query", + "name": "totalAmountLargerThan", + "description": "ุนู†ุฏ ุชุญุฏูŠุฏ ุฐู„ูƒุŒ ุณูŠุชู… ุฅุฑุฌุงุน ู…ุญุงูุธ ุงู„ุฃุตูˆู„ ุงู„ุชูŠ ูŠุจู„ุบ ุฅุฌู…ุงู„ูŠ ุฑุตูŠุฏู‡ุง ุฃูƒุจุฑ ู…ู† ู‡ุฐุง ุงู„ู…ุจู„ุบ ูู‚ุท.", + "required": false, + "schema": { + "type": "number" + } + }, + { + "in": "query", + "name": "assetId", + "required": false, + "description": "ุนู†ุฏ ุชุญุฏูŠุฏ ุฐู„ูƒุŒ ุณูŠุชู… ุฅุฑุฌุงุน ู…ุญุงูุธ ุงู„ุฃุตูˆู„ ุงู„ุชูŠ ุชุชู‚ุงุทุน ู…ุน ุญุณุงุจุงุช ุงู„ุฎุฒุงุฆู† ุงู„ุชูŠ ุชุญุชูˆูŠ ุนู„ู‰ ู…ุนุฑู ุงู„ุฃุตูˆู„ ู‡ุฐุง ูู‚ุท.", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + }, + { + "in": "query", + "name": "before", + "required": false, + "description": "ูŠู‚ูˆู… ุจุฌู„ุจ ุงู„ุงุณุชุฌุงุจุฉ ุงู„ู…ู‚ุณู…ุฉ ุฅู„ู‰ ุตูุญุงุช ุงู„ุชุงู„ูŠุฉ ู‚ุจู„ ู‡ุฐุง ุงู„ุนู†ุตุฑ. ู‡ุฐุง ุงู„ุนู†ุตุฑ ุนุจุงุฑุฉ ุนู† ู…ุคุดุฑ ูˆูŠุชู… ุฅุฑุฌุงุนู‡ ุนู†ุฏ ุงุณุชุฌุงุจุฉ ุงู„ุตูุญุฉ ุงู„ุณุงุจู‚ุฉ.", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "after", + "required": false, + "description": "ูŠู‚ูˆู… ุจุฌู„ุจ ุงู„ุงุณุชุฌุงุจุฉ ุงู„ู…ู‚ุณู…ุฉ ุฅู„ู‰ ุตูุญุงุช ุงู„ุชุงู„ูŠุฉ ุจุนุฏ ู‡ุฐุง ุงู„ุนู†ุตุฑ. ู‡ุฐุง ุงู„ุนู†ุตุฑ ุนุจุงุฑุฉ ุนู† ู…ุคุดุฑ ูˆูŠุชู… ุฅุฑุฌุงุนู‡ ุนู†ุฏ ุงุณุชุฌุงุจุฉ ุงู„ุตูุญุฉ ุงู„ุณุงุจู‚ุฉ.", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "limit", + "required": false, + "description": "ุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ ู„ุนุฏุฏ ู…ุญุงูุธ ุงู„ุฃุตูˆู„ ููŠ ุงุณุชุฌุงุจุฉ ูˆุงุญุฏุฉ. ุงู„ุงูุชุฑุงุถูŠ ู‡ูˆ 200 ูˆุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ ู‡ูˆ 1000.", + "schema": { + "type": "number", + "minimum": 1, + "maximum": 1000, + "default": 200 + } + } + ], + "responses": { + "200": { + "description": "ูƒุงุฆู† PaginatedAssetWalletResponse", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PaginatedAssetWalletResponse" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/hide": { + "post": { + "summary": "ุฅุฎูุงุก ุญุณุงุจ ุงู„ุฎุฒู†ุฉ ููŠ ูˆุญุฏุฉ ุงู„ุชุญูƒู…", + "description": "ุฅุฎูุงุก ุญุณุงุจ ุงู„ุฎุฒู†ุฉ ุงู„ู…ุทู„ูˆุจ ู…ู† ุนุฑุถ ูˆุญุฏุฉ ุงู„ุชุญูƒู… ุนู„ู‰ ุงู„ูˆูŠุจ.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAsset = fireblocks.hide_vault_account(vault_account_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAsset = await fireblocks.hideVaultAccount(vaultAccountId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "ุญุณุงุจ ุงู„ุฎุฒู†ุฉ ู„ู„ุฅุฎูุงุก", + "schema": { + "type": "string", + "minimum": 1, + "format": "numeric", + "x-fb-entity": "vault_account" + } + } + ], + "responses": { + "201": { + "description": "ู†ุนู…", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/unhide": { + "post": { + "summary": "ุฅุธู‡ุงุฑ ุญุณุงุจ ุงู„ุฎุฒู†ุฉ ููŠ ูˆุญุฏุฉ ุงู„ุชุญูƒู…", + "description": "ูŠุฌุนู„ ุญุณุงุจ ุงู„ุฎุฒู†ุฉ ุงู„ู…ุฎููŠ ู…ุฑุฆูŠู‹ุง ููŠ ุนุฑุถ ูˆุญุฏุฉ ุงู„ุชุญูƒู… ุนู„ู‰ ุงู„ูˆูŠุจ.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAsset = fireblocks.unhide_vault_account(vault_account_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAsset = await fireblocks.unhideVaultAccount(vaultAccountId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "ุญุณุงุจ ุงู„ุฎุฒู†ุฉ ู„ุฅุธู‡ุงุฑู‡", + "schema": { + "type": "string", + "minimum": 1, + "format": "numeric", + "x-fb-entity": "vault_account" + } + } + ], + "responses": { + "201": { + "description": "ู†ุนู…", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/activate": { + "post": { + "summary": "ุชูุนูŠู„ ุงู„ู…ุญูุธุฉ ููŠ ุญุณุงุจ ุงู„ุฎุฒู†ุฉ", + "description": "ูŠุจุฏุฃ ุงู„ุชู†ุดูŠุท ู„ู…ุญูุธุฉ ููŠ ุญุณุงุจ ุงู„ุฎุฒู†ุฉ.", + "tags": [ + "Vaults" + ], + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "ู…ุนุฑู ุญุณุงุจ ุงู„ุฎุฒู†ุฉ ุงู„ู…ุฑุงุฏ ุฅุฑุฌุงุนู‡ุŒ ุฃูˆ "ุงู„ุงูุชุฑุงุถูŠ" ู„ุญุณุงุจ ุงู„ุฎุฒู†ุฉ ุงู„ุงูุชุฑุงุถูŠ", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุฃุตู„", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "ู†ุนู…", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateVaultAssetResponse" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/set_customer_ref_id": { + "post": { + "summary": "ุชุนูŠูŠู† ู…ุนุฑู ู…ุฑุฌุนูŠ ู„ุนู…ูŠู„ AML/KYT ู„ุญุณุงุจ ุงู„ุฎุฒู†ุฉ", + "description": "ุชุนูŠูŠู† ู…ุนุฑู ู…ุฑุฌุนูŠ ู„ุนู…ูŠู„ AML/KYT ู„ุญุณุงุจ ุงู„ุฎุฒู†ุฉ.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAsset = fireblocks.set_vault_account_customer_ref_id(vault_account_id, customer_ref_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAsset = await fireblocks.setCustomerRefIdForVaultAccount(vaultAccountId, customerRefId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "ู…ุนุฑู ุญุณุงุจ ุงู„ุฎุฒู†ุฉ", + "schema": { + "type": "string", + "minimum": 1, + "format": "numeric", + "x-fb-entity": "vault_account" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "customerRefId": { + "description": "ู…ุนุฑู ู…ุฑุฌุน ุงู„ุนู…ูŠู„", + "type": "string" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "ู†ุนู…", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/set_auto_fuel": { + "post": { + "summary": "ุชุดุบูŠู„ ุฃูˆ ุฅูŠู‚ุงู ุชุดุบูŠู„ ุงู„ุชุฒูˆุฏ ุจุงู„ูˆู‚ูˆุฏ ุชู„ู‚ุงุฆูŠู‹ุง", + "description": "ุชุนูŠูŠู† ุฎุงุตูŠุฉ ุงู„ุชุฒูˆูŠุฏ ุงู„ุชู„ู‚ุงุฆูŠ ู„ู„ูˆู‚ูˆุฏ ู„ุญุณุงุจ ุงู„ุฎุฒู†ุฉ ุนู„ู‰ ุชู…ูƒูŠู† ุฃูˆ ุชุนุทูŠู„.", + "tags": [ + "Vaults" + ], + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "ู…ุนุฑู ุญุณุงุจ ุงู„ุฎุฒู†ุฉ", + "schema": { + "type": "string", + "minimum": 1, + "format": "numeric", + "x-fb-entity": "vault_account" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "autoFuel": { + "description": "ูˆู‚ูˆุฏ ุงู„ุณูŠุงุฑุงุช", + "type": "boolean" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "ู†ุนู…", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}": { + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ุฑุตูŠุฏ ุงู„ุฃุตูˆู„ ู„ุญุณุงุจ ุงู„ุฎุฒู†ุฉ", + "description": "ุฅุฑุฌุงุน ู…ุญูุธุฉ ู„ุฃุตู„ ู…ุญุฏุฏ ู„ุญุณุงุจ ุงู„ุฎุฒู†ุฉ.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAsset = fireblocks.get_vault_account_asset(vault_account_id, asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAsset = await fireblocks.getVaultAccountAsset(vaultAccountId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "ู…ุนุฑู ุญุณุงุจ ุงู„ุฎุฒู†ุฉ ุงู„ู…ุฑุงุฏ ุฅุฑุฌุงุนู‡", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุฃุตู„", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "ูƒุงุฆู† VaultAsset", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/VaultAsset" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "ุฅู†ุดุงุก ู…ุญูุธุฉ ุฌุฏูŠุฏุฉ", + "description": "ุฅู†ุดุงุก ู…ุญูุธุฉ ู„ุฃุตู„ ู…ุญุฏุฏ ููŠ ุญุณุงุจ ุงู„ุฎุฒู†ุฉ.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAsset = fireblocks.create_vault_asset(vault_account_id, asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAsset = await fireblocks.createVaultAsset(vaultAccountId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "ู…ุนุฑู ุญุณุงุจ ุงู„ุฎุฒู†ุฉ ุงู„ู…ุฑุงุฏ ุฅุฑุฌุงุนู‡ุŒ ุฃูˆ "ุงู„ุงูุชุฑุงุถูŠ" ู„ุญุณุงุจ ุงู„ุฎุฒู†ุฉ ุงู„ุงูุชุฑุงุถูŠ", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุฃุตู„", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "eosAccountName": { + "description": "ุงุฎุชูŠุงุฑูŠ - ุนู†ุฏ ุฅู†ุดุงุก ู…ุญูุธุฉ EOSุŒ ุงุณู… ุงู„ุญุณุงุจ. ุฅุฐุง ู„ู… ูŠุชู… ุชูˆููŠุฑู‡ุŒ ูุณูŠุชู… ุฅู†ุดุงุก ุงุณู… ุนุดูˆุงุฆูŠ", + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "ู†ุนู…", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateVaultAssetResponse" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/balance": { + "post": { + "summary": "ุชุญุฏูŠุซ ุจูŠุงู†ุงุช ุฑุตูŠุฏ ุงู„ุฃุตูˆู„", + "description": "ุชุญุฏูŠุซ ุฑุตูŠุฏ ุฃุญุฏ ุงู„ุฃุตูˆู„ ุงู„ู…ุญุฏุฏุฉ ููŠ ุญุณุงุจ ุงู„ุฎุฒู†ุฉ.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAsset = fireblocks.refresh_vault_asset_balance(vault_account_id, asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAsset = await fireblocks.refreshVaultAssetBalance(vaultAccountId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "ู…ุนุฑู ุญุณุงุจ ุงู„ุฎุฒู†ุฉ ุงู„ู…ุฑุงุฏ ุฅุฑุฌุงุนู‡", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุฃุตู„", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "requestBody": { + "required": false, + "content": { + "*/*": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "ูƒุงุฆู† VaultAsset", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/VaultAsset" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/addresses": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุนู†ุงูˆูŠู† ุงู„ุฃุตูˆู„", + "description": "ูŠุณุฑุฏ ุฌู…ูŠุน ุงู„ุนู†ุงูˆูŠู† ู„ุฃุตูˆู„ ู…ุญุฏุฏุฉ ููŠ ุญุณุงุจ ุงู„ุฎุฒู†ุฉ.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "depositAddresses = fireblocks.get_deposit_addresses(vault_account_id, asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const depositAddresses = await fireblocks.getDepositAddresses(vaultAccountId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "ู…ุนุฑู ุญุณุงุจ ุงู„ุฎุฒู†ุฉ ุงู„ู…ุฑุงุฏ ุฅุฑุฌุงุนู‡", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุฃุตู„", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "ู‚ุงุฆู…ุฉ ุนู†ุงูˆูŠู† ุงู„ุฅูŠุฏุงุน", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VaultWalletAddress" + } + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "ุฅู†ุดุงุก ุนู†ูˆุงู† ุฅูŠุฏุงุน ุงู„ุฃุตูˆู„ ุงู„ุฌุฏูŠุฏ", + "description": "ุฅู†ุดุงุก ุนู†ูˆุงู† ุฅูŠุฏุงุน ุฌุฏูŠุฏ ู„ุฃุตู„ ููŠ ุญุณุงุจ ุงู„ุฎุฒู†ุฉ.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "address = fireblocks.generate_new_address(vault_account_id, asset_id, description, customer_ref_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const address = await fireblocks.generateNewAddress(vaultAccountId, assetId, description, customerRefId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "description": { + "description": "(ุงุฎุชูŠุงุฑูŠ) ู‚ู… ุจุฅุฑูุงู‚ ูˆุตู ู„ู„ุนู†ูˆุงู† ุงู„ุฌุฏูŠุฏ", + "type": "string" + }, + "customerRefId": { + "description": "ุงุฎุชูŠุงุฑูŠ - ุชุนูŠูŠู† ู…ุนุฑู ู…ุฑุฌุน ุงู„ุนู…ูŠู„", + "type": "string" + } + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "ู…ุนุฑู ุญุณุงุจ ุงู„ุฎุฒู†ุฉ ุงู„ู…ุฑุงุฏ ุฅุฑุฌุงุนู‡", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุฃุตู„", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "ุงู„ุนู†ูˆุงู† ุงู„ุฐูŠ ุชู… ุฅู†ุดุงุคู‡", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateAddressResponse" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/max_spendable_amount": { + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ ู„ู„ู…ุจู„ุบ ุงู„ู‚ุงุจู„ ู„ู„ุฅู†ูุงู‚ ููŠ ู…ุนุงู…ู„ุฉ ูˆุงุญุฏุฉ.", + "description": "ุงุญุตู„ ุนู„ู‰ ุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ ู…ู† ุฃุตู„ ู…ุนูŠู† ูŠู…ูƒู† ุฅู†ูุงู‚ู‡ ููŠ ู…ุนุงู…ู„ุฉ ูˆุงุญุฏุฉ ู…ู† ุญุณุงุจ ุฎุฒู†ุฉ ู…ุญุฏุฏ (ุฃุตูˆู„ UTXO ูู‚ุทุŒ ู…ุน ูˆุฌูˆุฏ ุญุฏ ู„ุนุฏุฏ ุงู„ู…ุฏุฎู„ุงุช ุงู„ู…ุถู…ู†ุฉ). ุฃุฑุณู„ ุนุฏุฉ ู…ุนุงู…ู„ุงุช ุฅุฐุง ูƒู†ุช ุชุฑูŠุฏ ุฅู†ูุงู‚ ุฃูƒุซุฑ ู…ู† ุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ ู„ู„ู…ุจู„ุบ ุงู„ู‚ุงุจู„ ู„ู„ุฅู†ูุงู‚.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "address = fireblocks.set_address_description(vault_account_id, asset_id, address, tag, description)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const address = await fireblocks.setAddressDescription(vaultAccountId, assetId, address, tag, description);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "ู…ุนุฑู ุญุณุงุจ ุงู„ุฎุฒู†ุฉุŒ ุฃูˆ "ุงู„ุงูุชุฑุงุถูŠ" ู„ุญุณุงุจ ุงู„ุฎุฒู†ุฉ ุงู„ุงูุชุฑุงุถูŠ", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุฃุตู„", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + }, + { + "in": "query", + "name": "manualSignging", + "required": false, + "description": "ุฎุทุฃ ุงูุชุฑุงุถูŠู‹ุง. ูŠุนุชู…ุฏ ุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ ู„ุนุฏุฏ ุงู„ู…ุฏุฎู„ุงุช ุนู„ู‰ ู…ุง ุฅุฐุง ูƒุงู†ุช ุงู„ู…ุนุงู…ู„ุฉ ุณูŠุชู… ุชูˆู‚ูŠุนู‡ุง ุจูˆุงุณุทุฉ ุฎุงุฏู… ุชูˆู‚ูŠุน ู…ุดุงุฑูƒ ุขู„ูŠ ุฃูˆ ุนู„ู‰ ุฌู‡ุงุฒ ู…ุญู…ูˆู„.", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "ู†ุนู…", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}": { + "put": { + "summary": "ุชุญุฏูŠุซ ูˆุตู ุงู„ุนู†ูˆุงู†", + "description": "ูŠู‚ูˆู… ุจุชุญุฏูŠุซ ูˆุตู ุนู†ูˆุงู† ู…ูˆุฌูˆุฏ ู„ุฃุตู„ ููŠ ุญุณุงุจ ุงู„ุฎุฒู†ุฉ.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "address = fireblocks.set_address_description(vault_account_id, asset_id, address, tag, description)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const address = await fireblocks.setAddressDescription(vaultAccountId, assetId, address, tag, description);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "description": { + "description": "ูˆุตู ุงู„ุนู†ูˆุงู†", + "type": "string" + } + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "ู…ุนุฑู ุญุณุงุจ ุงู„ุฎุฒู†ุฉ", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุฃุตู„", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + }, + { + "in": "path", + "name": "addressId", + "required": true, + "description": "ุงู„ุนู†ูˆุงู† ุงู„ุฐูŠ ุชุฑูŠุฏ ุฅุถุงูุฉ ูˆุตู ู„ู‡. ุจุงู„ู†ุณุจุฉ ุฅู„ู‰ XRPุŒ ุงุณุชุฎุฏู…
: ุจุงู„ู†ุณุจุฉ ู„ุฌู…ูŠุน ุงู„ุฃุตูˆู„ ุงู„ุฃุฎุฑู‰ุŒ ุงุณุชุฎุฏู… ุงู„ุนู†ูˆุงู† ูู‚ุท", + "schema": { + "type": "string" + } + } + ], + "responses": { + "201": { + "description": "ู†ุนู…", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/set_customer_ref_id": { + "post": { + "summary": "ุชุนูŠูŠู† ู…ุนุฑู ู…ุฑุฌุนูŠ ู„ุนู…ูŠู„ ู…ูƒุงูุญุฉ ุบุณู„ ุงู„ุฃู…ูˆุงู„", + "description": "ุชุนูŠูŠู† ู…ุนุฑู ู…ุฑุฌุนูŠ ู„ุนู…ูŠู„ AML/KYT ู„ุนู†ูˆุงู† ู…ุญุฏุฏ.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAsset = fireblocks.set_customer_ref_id_for_address(vault_account_id, asset_id, address_id, customer_ref_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAsset = await fireblocks.setCustomerRefIdForAddress(vaultAccountId, assetId, addressId, customerRefId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "ู…ุนุฑู ุญุณุงุจ ุงู„ุฎุฒู†ุฉ", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุฃุตู„", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + }, + { + "in": "path", + "name": "addressId", + "required": true, + "description": "ุงู„ุนู†ูˆุงู† ุงู„ุฐูŠ ุชุฑูŠุฏ ุฅุถุงูุฉ ูˆุตู ู„ู‡. ุจุงู„ู†ุณุจุฉ ุฅู„ู‰ XRPุŒ ุงุณุชุฎุฏู…
: ุจุงู„ู†ุณุจุฉ ู„ุฌู…ูŠุน ุงู„ุฃุตูˆู„ ุงู„ุฃุฎุฑู‰ุŒ ุงุณุชุฎุฏู… ุงู„ุนู†ูˆุงู† ูู‚ุท", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "customerRefId": { + "description": "ู…ุนุฑู ู…ุฑุฌุน ุงู„ุนู…ูŠู„", + "type": "string" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "ู†ุนู…", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/create_legacy": { + "post": { + "summary": "ุชุญูˆูŠู„ ุนู†ูˆุงู† segwit ุฅู„ู‰ ุชู†ุณูŠู‚ ู‚ุฏูŠู…", + "description": "ูŠุญูˆู„ ุนู†ูˆุงู† segwit ุงู„ุญุงู„ูŠ ุฅู„ู‰ ุงู„ุชู†ุณูŠู‚ ุงู„ู‚ุฏูŠู….", + "tags": [ + "Vaults" + ], + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "ู…ุนุฑู ุญุณุงุจ ุงู„ุฎุฒู†ุฉ", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุฃุตู„", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + }, + { + "in": "path", + "name": "addressId", + "required": true, + "description": "ุนู†ูˆุงู† ุณูŠุฌูˆูŠุช ู„ู„ุชุฑุฌู…ุฉ", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "ุงู„ุนู†ูˆุงู† ุงู„ุฐูŠ ุชู… ุฅู†ุดุงุคู‡", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateAddressResponse" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/unspent_inputs": { + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช ู…ุฏุฎู„ุงุช UTXO ุบูŠุฑ ุงู„ู…ู†ูู‚ุฉ", + "description": "ุฅุฑุฌุงุน ู…ุนู„ูˆู…ุงุช ุงู„ู…ุฏุฎู„ุงุช ุบูŠุฑ ุงู„ู…ู†ูู‚ุฉ ู„ู„ุฃุตู„ ููŠ ุญุณุงุจ ุงู„ุฎุฒู†ุฉ.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAsset = fireblocks.get_unspent_inputs(vault_account_id, asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAsset = await fireblocks.getUnspentInputs(vaultAccountId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "ู…ุนุฑู ุญุณุงุจ ุงู„ุฎุฒู†ุฉ", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุฃุตู„", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "ู‚ุงุฆู…ุฉ ุงู„ู…ุนู„ูˆู…ุงุช ุบูŠุฑ ุงู„ู…ู†ูู‚ุฉ ู„ูƒู„ ุฅุฏุฎุงู„", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UnspentInputsResponse" + } + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/public_key_info/": { + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช ุงู„ู…ูุชุงุญ ุงู„ุนุงู…", + "description": "ูŠุญุตู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช ุงู„ู…ูุชุงุญ ุงู„ุนุงู… ุจู†ุงุกู‹ ุนู„ู‰ ู…ุณุงุฑ ุงู„ุงุดุชู‚ุงู‚ ูˆุฎูˆุงุฑุฒู…ูŠุฉ ุงู„ุชูˆู‚ูŠุน.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "pubKey = fireblocks.get_public_key_info(algorithm, derivation_path, compressed)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const PublicKeyInfoArgs = { algorithm: 'MPC_ECDSA_SECP256K1', derivationPath: '[44,0,0,0,0]' } const pubKey = await fireblocks.getPublicKeyInfo(PublicKeyInfoArgs);\n", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "query", + "name": "derivationPath", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "algorithm", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "compressed", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ู…ูุชุงุญ ุงู„ุนุงู…", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PublicKeyInformation" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/{change}/{addressIndex}/public_key_info": { + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ุงู„ู…ูุชุงุญ ุงู„ุนุงู… ู„ุญุณุงุจ ุงู„ุฎุฒู†ุฉ", + "description": "ูŠุญุตู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช ุงู„ู…ูุชุงุญ ุงู„ุนุงู… ู„ุญุณุงุจ ุงู„ุฎุฒู†ุฉ.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "pubKey = fireblocks.get_public_key_info_for_vault_account(asset_id, vault_account_id, change, address_index, compressed)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const PublicKeyInfoArgs = { assetId: 'ETH', vaultAccountId: 0, change: 0, addressIndex: 0, compressed: true } const pubKey = await fireblocks.getPublicKeyInfoForVaultAccount(PublicKeyInfoArgs);\n", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + }, + { + "in": "path", + "name": "change", + "required": true, + "schema": { + "type": "number" + } + }, + { + "in": "path", + "name": "addressIndex", + "required": true, + "schema": { + "type": "number" + } + }, + { + "in": "query", + "name": "compressed", + "required": false, + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ู…ูุชุงุญ ุงู„ุนุงู…", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PublicKeyInformation" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/assets": { + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ุฑุตูŠุฏ ุงู„ุฃุตูˆู„ ู„ู„ุฃุตูˆู„ ุงู„ู…ุฎุชุงุฑุฉ", + "description": "ูŠุญุตู„ ุนู„ู‰ ู…ู„ุฎุต ู…ุจู„ุบ ุงู„ุฃุตูˆู„ ู„ุฌู…ูŠุน ุงู„ุญุณุงุจุงุช ุฃูˆ ุงู„ุญุณุงุจุงุช ุงู„ู…ูู„ุชุฑุฉ.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "assets_balance = fireblocks.get_vault_assets_balance(accout_name_prefix, account_name_suffix)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const assetsBalance = await fireblocks.getVaultAssetsBalance(accountNamePrefix, accountNameSuffix);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "query", + "name": "accountNamePrefix", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "accountNameSuffix", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "ุงู„ู…ุจู„ุบ ุญุณุจ ุงู„ุฃุตูˆู„", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VaultAsset" + } + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/assets/{assetId}": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุฑุตูŠุฏ ุงู„ุฎุฒู†ุฉ ุญุณุจ ุงู„ุฃุตูˆู„", + "description": "ูŠุญุตู„ ุนู„ู‰ ู…ู„ุฎุต ุฑุตูŠุฏ ุงู„ุฎุฒู†ุฉ ู„ู„ุฃุตู„.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "assets_balance = fireblocks.get_vault_balance_by_asset(asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const assetsBalance = await fireblocks.getVaultBalanceByAsset(assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "assetId", + "required": true, + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "ู…ุจู„ุบ ุงู„ุฎุฒู†ุฉ ุญุณุจ ุงู„ุฃุตูˆู„", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/VaultAsset" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/exchange_accounts": { + "get": { + "summary": "ู‚ุงุฆู…ุฉ ุญุณุงุจุงุช ุงู„ุชุจุงุฏู„", + "description": "ุฅุฑุฌุงุน ุฌู…ูŠุน ุญุณุงุจุงุช ุงู„ุตุฑู.", + "tags": [ + "Exchange accounts" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "exchangeAccounts = fireblocks.get_exchange_accounts()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const exchangeAccounts = await fireblocks.getExchangeAccounts();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "ูƒุงุฆู† ExchangeAccount", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExchangeAccount" + } + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/exchange_accounts/{exchangeAccountId}": { + "get": { + "summary": "ุงู„ุนุซูˆุฑ ุนู„ู‰ ุญุณุงุจ ุชุจุงุฏู„ ู…ุญุฏุฏ", + "description": "ุฅุฑุฌุงุน ุญุณุงุจ ุงู„ุชุจุงุฏู„ ุญุณุจ ุงู„ู…ุนุฑู.", + "tags": [ + "Exchange accounts" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "exchangeAccount = fireblocks.get_exchange_account(exchangeAccountId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const exchnageAccount = await fireblocks.get_exchange_account(exchangeAccountId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "exchangeAccountId", + "required": true, + "description": "ู…ุนุฑู ุญุณุงุจ ุงู„ุชุจุงุฏู„ ุงู„ู…ุฑุงุฏ ุฅุฑุฌุงุนู‡", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ูƒุงุฆู† ExchangeAccount", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ExchangeAccount" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/exchange_accounts/{exchangeAccountId}/internal_transfer": { + "post": { + "summary": "ุงู„ุชุญูˆูŠู„ ุงู„ุฏุงุฎู„ูŠ ู„ุญุณุงุจุงุช ุงู„ุตุฑู", + "description": "ู†ู‚ู„ ุงู„ุฃู…ูˆุงู„ ุจูŠู† ุญุณุงุจุงุช ุงู„ุชุฏุงูˆู„ ุถู…ู† ู†ูุณ ุญุณุงุจ ุงู„ุชุจุงุฏู„.", + "tags": [ + "Exchange accounts" + ], + "parameters": [ + { + "in": "path", + "name": "exchangeAccountId", + "required": true, + "description": "ู…ุนุฑู ุญุณุงุจ ุงู„ุชุจุงุฏู„ ุงู„ู…ุฑุงุฏ ุฅุฑุฌุงุนู‡", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "201": { + "description": "ุชู… ุงู„ู†ู‚ู„ ุจู†ุฌุงุญ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "asset": { + "type": "string" + }, + "amount": { + "type": "string" + }, + "sourceType": { + "$ref": "#/components/schemas/TradingAccountType" + }, + "destType": { + "$ref": "#/components/schemas/TradingAccountType" + } + } + } + } + } + } + } + }, + "/exchange_accounts/{exchangeAccountId}/convert": { + "post": { + "summary": "ุชุญูˆูŠู„ ุฃู…ูˆุงู„ ุญุณุงุจ ุงู„ุตุฑู ู…ู† ุงู„ุฃุตู„ ุงู„ู…ุตุฏุฑ ุฅู„ู‰ ุงู„ุฃุตู„ ุงู„ูˆุฌู‡ุฉ. Coinbase (USD ุฅู„ู‰ USDCุŒ USDC ุฅู„ู‰ USD) ูˆBitso (MXN ุฅู„ู‰ USD) ู‡ูŠ ุงู„ุชุญูˆูŠู„ุงุช ุงู„ู…ุฏุนูˆู…ุฉ.", + "tags": [ + "Exchange accounts" + ], + "parameters": [ + { + "in": "path", + "name": "exchangeAccountId", + "required": true, + "description": "ู…ุนุฑู ุญุณุงุจ ุงู„ุชุจุงุฏู„. ูŠุฑุฌู‰ ุงู„ุชุฃูƒุฏ ู…ู† ุฃู† ุงู„ุชุจุงุฏู„ ูŠุฏุนู… ุงู„ุชุญูˆูŠู„ุงุช. ู„ู„ุนุซูˆุฑ ุนู„ู‰ ู…ุนุฑู ุญุณุงุจ ุงู„ุชุจุงุฏู„ ุงู„ุฎุงุต ุจูƒุŒ ุงุณุชุฎุฏู… GET/exchange_accounts.", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ุชู… ุงู„ุชุญูˆูŠู„ ุจู†ุฌุงุญ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "srcAsset": { + "type": "string", + "description": "ุงุณู… ุงู„ุฃุตู„ ุงู„ู…ุตุฏุฑ (ูŠุฌุจ ุฃู† ูŠูƒูˆู† ุจุนู…ู„ุฉ ู…ุฏุนูˆู…ุฉ ู„ู„ุชุญูˆูŠู„ุงุช ููŠ ู†ูˆุน ุงู„ุชุจุงุฏู„ ุงู„ู…ุญุฏุฏ ุงู„ุฐูŠ ูŠุชูˆุงูู‚ ู…ุน ู…ุนุฑู ุงู„ุชุจุงุฏู„ ุงู„ุฎุงุต ุจูƒ)" + }, + "destAsset": { + "type": "string", + "description": "ุงุณู… ุงู„ุฃุตู„ ุงู„ูˆุฌู‡ุฉ (ูŠุฌุจ ุฃู† ูŠูƒูˆู† ุจุนู…ู„ุฉ ู…ุฏุนูˆู…ุฉ ู„ู„ุชุญูˆูŠู„ุงุช ููŠ ู†ูˆุน ุงู„ุชุจุงุฏู„ ุงู„ู…ุญุฏุฏ ุงู„ุฐูŠ ูŠุชูˆุงูู‚ ู…ุน ู…ุนุฑู ุงู„ุชุจุงุฏู„ ุงู„ุฎุงุต ุจูƒ)" + }, + "amount": { + "type": "number", + "description": "ุงู„ู…ุจู„ุบ ุงู„ู…ุฑุงุฏ ุชุญูˆูŠู„ู‡ (ุจุนู…ู„ุฉ ุงู„ุฃุตู„ ุงู„ู…ุตุฏุฑ)" + } + }, + "required": [ + "srcAsset", + "destAsset", + "amount" + ] + } + } + } + } + } + }, + "/exchange_accounts/{exchangeAccountId}/{assetId}": { + "get": { + "summary": "ุงู„ุนุซูˆุฑ ุนู„ู‰ ุฃุตู„ ู„ุญุณุงุจ ุงู„ุชุจุงุฏู„", + "description": "ุฅุฑุฌุงุน ุฃุญุฏ ุงู„ุฃุตูˆู„ ู„ุญุณุงุจ ุงู„ุชุจุงุฏู„.", + "tags": [ + "Exchange accounts" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "exchangeAsset = fireblocks.get_exchange_account_asset(exchangeAccountId, assetId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const exchangeAsset = await fireblocks.getExchangeAsset(exchangeAccountId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "exchangeAccountId", + "required": true, + "description": "ู…ุนุฑู ุญุณุงุจ ุงู„ุชุจุงุฏู„ ุงู„ู…ุฑุงุฏ ุฅุฑุฌุงุนู‡", + "schema": { + "type": "string", + "minimum": 1 + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุฃุตู„ ุงู„ู…ุฑุงุฏ ุฅุฑุฌุงุนู‡", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ูƒุงุฆู† ExchangeAccountAsset", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ExchangeAsset" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/fiat_accounts": { + "get": { + "summary": "ู‚ุงุฆู…ุฉ ุงู„ุญุณุงุจุงุช ุงู„ูˆุฑู‚ูŠุฉ", + "description": "ุฅุฑุฌุงุน ุฌู…ูŠุน ุงู„ุญุณุงุจุงุช ุงู„ูˆุฑู‚ูŠุฉ.", + "tags": [ + "Fiat accounts" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "transactions = fireblocks.get_fiat_accounts()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const transactions = await fireblocks.getFiatAccounts();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "ูƒุงุฆู† ุญุณุงุจ ููŠุงุช", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FiatAccount" + } + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/fiat_accounts/{accountId}": { + "get": { + "summary": "ุงู„ุนุซูˆุฑ ุนู„ู‰ ุญุณุงุจ ููŠุงุช ู…ุญุฏุฏ", + "description": "ุฅุฑุฌุงุน ุญุณุงุจ ููŠุงุช ุญุณุจ ุงู„ู…ุนุฑู.", + "tags": [ + "Fiat accounts" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "transactions = fireblocks.get_fiat_account_by_id(account_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const transactions = await fireblocks.getFiatAccountById(accountId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "accountId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุญุณุงุจ ุงู„ูˆุฑู‚ูŠ ุงู„ู…ุฑุงุฏ ุฅุฑุฌุงุนู‡", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ูƒุงุฆู† ุญุณุงุจ ููŠุงุช", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/FiatAccount" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/fiat_accounts/{accountId}/redeem_to_linked_dda": { + "post": { + "summary": "ุงุณุชุฑุฏุงุฏ ุงู„ุฃู…ูˆุงู„ ุฅู„ู‰ DDA", + "description": "ุงุณุชุฑุฏุงุฏ ุงู„ุฃู…ูˆุงู„ ุฅู„ู‰ DDA ุงู„ู…ุฑุชุจุทุฉ.", + "tags": [ + "Fiat accounts" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "transactions = fireblocks.redeem_to_linked_dda(account_id, amount)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const transactions = await fireblocks.redeemToLinkedDDA(accountId, amount);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "accountId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุญุณุงุจ ุงู„ูˆุฑู‚ูŠ ุงู„ุฐูŠ ุณูŠุชู… ุงุณุชุฎุฏุงู…ู‡", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "201": { + "description": "ุชู… ุงู„ู†ู‚ู„ ุจู†ุฌุงุญ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "amount": { + "type": "number" + } + } + } + } + } + } + } + }, + "/fiat_accounts/{accountId}/deposit_from_linked_dda": { + "post": { + "summary": "ุฅูŠุฏุงุน ุงู„ุฃู…ูˆุงู„ ู…ู† DDA", + "description": "ุฅูŠุฏุงุน ุงู„ุฃู…ูˆุงู„ ู…ู† DDA ุงู„ู…ุฑุชุจุทุฉ.", + "tags": [ + "Fiat accounts" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "transactions = fireblocks.deposit_from_linked_dda(account_id, amount)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const transactions = await fireblocks.depositFromLinkedDDA(accountId, amount);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "accountId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุญุณุงุจ ุงู„ูˆุฑู‚ูŠ ุงู„ุฐูŠ ุณูŠุชู… ุงุณุชุฎุฏุงู…ู‡", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "201": { + "description": "ุชู… ุงู„ู†ู‚ู„ ุจู†ุฌุงุญ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "amount": { + "type": "number" + } + } + } + } + } + } + } + }, + "/network_connections": { + "get": { + "summary": "ู‚ุงุฆู…ุฉ ุงุชุตุงู„ุงุช ุงู„ุดุจูƒุฉ", + "description": "ูŠุนูŠุฏ ุฌู…ูŠุน ุงุชุตุงู„ุงุช ุงู„ุดุจูƒุฉ. **ู…ู„ุงุญุธุฉ:** ุชุฎุถุน ู…ูƒุงู„ู…ุฉ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ู‡ุฐู‡ ู„ู…ุฎุทุทุงุช ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุฑู†ุฉ. ุชุญุฏุฏ ุณูŠุงุณุฉ ุงู„ุชูˆุฌูŠู‡ ุงู„ุฎุงุตุฉ ุจูƒ ูƒูŠููŠุฉ ุชูˆุฌูŠู‡ ู…ุนุงู…ู„ุงุชูƒ. ูŠู…ูƒู†ูƒ ุงุฎุชูŠุงุฑ ุฃุญุฏ ุงู„ู…ุฎุทุทุงุช ุงู„ุซู„ุงุซุฉ ุงู„ู…ุฎุชู„ูุฉ ุงู„ู…ุฐูƒูˆุฑุฉ ุฃุฏู†ุงู‡ ู„ูƒู„ ู†ูˆุน ู…ู† ุฃู†ูˆุงุน ุงู„ุฃุตูˆู„: - **ู„ุง ุดูŠุก**ุ› ูŠุญุฏุฏ ุชูˆุฌูŠู‡ ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ ุฅู„ู‰ ูˆุฌู‡ุฉ ู„ุง ู„ู†ูˆุน ุงู„ุฃุตูˆู„ ู‡ุฐุง. ุณุชูุดู„ ุงู„ู…ุนุงู…ู„ุงุช ุงู„ูˆุงุฑุฏุฉ ุฅู„ู‰ ุฃู†ูˆุงุน ุงู„ุฃุตูˆู„ ุงู„ุชูŠ ุชู… ุชูˆุฌูŠู‡ู‡ุง ุฅู„ู‰ "ู„ุง ุดูŠุก". - **ู…ุฎุตุต**ุ› ุงู„ุชูˆุฌูŠู‡ ุฅู„ู‰ ุญุณุงุจ ุชุฎุชุงุฑู‡. ุฅุฐุง ู‚ู…ุช ุจุฅุฒุงู„ุฉ ุงู„ุญุณุงุจุŒ ูุณุชูุดู„ ุงู„ู…ุนุงู…ู„ุงุช ุงู„ูˆุงุฑุฏุฉ ุญุชู‰ ุชุฎุชุงุฑ ุญุณุงุจู‹ุง ุขุฎุฑ. - **ุงูุชุฑุงุถูŠ**ุ› ุงุณุชุฎุฏู… ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุญุฏุฏ ุจูˆุงุณุทุฉ ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ ุงู„ุฐูŠ ูŠุชุตู„ ุจู‡ ุงู„ุงุชุตุงู„. ูŠุดุงุฑ ุฅู„ู‰ ู‡ุฐุง ุงู„ู…ุฎุทุท ุฃูŠุถู‹ุง ุจุงุณู… "ุชูˆุฌูŠู‡ ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ" ุงู„ุฅุนุฏุงุฏุงุช ุงู„ู…ุณุจู‚ุฉ ู„ู…ุณุงุญุฉ ุงู„ุนู…ู„ ุงู„ุงูุชุฑุงุถูŠุฉ: - ุชุดููŠุฑ ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ โ†’ **ู…ุฎุตุต** - ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ FIAT โ†’ **ู„ุง ุดูŠุก** - ุชุดููŠุฑ ุงุชุตุงู„ ุงู„ุดุจูƒุฉ โ†’ **ุงูุชุฑุงุถูŠ** - ุงุชุตุงู„ ุงู„ุดุจูƒุฉ FIAT โ†’ **ุงูุชุฑุงุถูŠ** - **ู…ู„ุงุญุธุฉ**: ุจุดูƒู„ ุงูุชุฑุงุถูŠุŒ ูŠุณุชุฎุฏู… ู…ุฎุทุท ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุฎุตุต (`dstId` = `0`ุŒ `dstType` = `VAULT`).", + "tags": [ + "Network connections" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "network_connections = fireblocks.get_network_connections()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const networkConnections = await fireblocks.getNetworkConnections();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "ู‚ุงุฆู…ุฉ ุงุชุตุงู„ุงุช ุงู„ุดุจูƒุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkConnectionResponse" + } + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "ุฅู†ุดุงุก ุงุชุตุงู„ ุดุจูƒุฉ ุฌุฏูŠุฏ", + "description": "ูŠุจุฏุฃ ุงุชุตุงู„ุงู‹ ุฌุฏูŠุฏู‹ุง ุจุงู„ุดุจูƒุฉ. **ู…ู„ุงุญุธุฉ:** ุชุฎุถุน ู…ูƒุงู„ู…ุฉ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ู‡ุฐู‡ ู„ู…ุฎุทุทุงุช ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุฑู†ุฉ. ุชุญุฏุฏ ุณูŠุงุณุฉ ุงู„ุชูˆุฌูŠู‡ ุงู„ุฎุงุตุฉ ุจูƒ ูƒูŠููŠุฉ ุชูˆุฌูŠู‡ ู…ุนุงู…ู„ุงุชูƒ. ูŠู…ูƒู†ูƒ ุงุฎุชูŠุงุฑ ุฃุญุฏ ุงู„ู…ุฎุทุทุงุช ุงู„ุซู„ุงุซุฉ ุงู„ู…ุฎุชู„ูุฉ ุงู„ู…ุฐูƒูˆุฑุฉ ุฃุฏู†ุงู‡ ู„ูƒู„ ู†ูˆุน ู…ู† ุฃู†ูˆุงุน ุงู„ุฃุตูˆู„: - **ู„ุง ุดูŠุก**ุ› ูŠุญุฏุฏ ุชูˆุฌูŠู‡ ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ ุฅู„ู‰ ูˆุฌู‡ุฉ ู„ุง ู„ู†ูˆุน ุงู„ุฃุตูˆู„ ู‡ุฐุง. ุณุชูุดู„ ุงู„ู…ุนุงู…ู„ุงุช ุงู„ูˆุงุฑุฏุฉ ุฅู„ู‰ ุฃู†ูˆุงุน ุงู„ุฃุตูˆู„ ุงู„ุชูŠ ุชู… ุชูˆุฌูŠู‡ู‡ุง ุฅู„ู‰ "ู„ุง ุดูŠุก". - **ู…ุฎุตุต**ุ› ุงู„ุชูˆุฌูŠู‡ ุฅู„ู‰ ุญุณุงุจ ุชุฎุชุงุฑู‡. ุฅุฐุง ู‚ู…ุช ุจุฅุฒุงู„ุฉ ุงู„ุญุณุงุจุŒ ูุณุชูุดู„ ุงู„ู…ุนุงู…ู„ุงุช ุงู„ูˆุงุฑุฏุฉ ุญุชู‰ ุชุฎุชุงุฑ ุญุณุงุจู‹ุง ุขุฎุฑ. - **ุงูุชุฑุงุถูŠ**ุ› ุงุณุชุฎุฏู… ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุญุฏุฏ ุจูˆุงุณุทุฉ ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ ุงู„ุฐูŠ ูŠุชุตู„ ุจู‡ ุงู„ุงุชุตุงู„. ูŠุดุงุฑ ุฅู„ู‰ ู‡ุฐุง ุงู„ู…ุฎุทุท ุฃูŠุถู‹ุง ุจุงุณู… "ุชูˆุฌูŠู‡ ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ" ุงู„ุฅุนุฏุงุฏุงุช ุงู„ู…ุณุจู‚ุฉ ู„ู…ุณุงุญุฉ ุงู„ุนู…ู„ ุงู„ุงูุชุฑุงุถูŠุฉ: - ุชุดููŠุฑ ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ โ†’ **ู…ุฎุตุต** - ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ FIAT โ†’ **ู„ุง ุดูŠุก** - ุชุดููŠุฑ ุงุชุตุงู„ ุงู„ุดุจูƒุฉ โ†’ **ุงูุชุฑุงุถูŠ** - ุงุชุตุงู„ ุงู„ุดุจูƒุฉ FIAT โ†’ **ุงูุชุฑุงุถูŠ** - **ู…ู„ุงุญุธุฉ**: ุจุดูƒู„ ุงูุชุฑุงุถูŠุŒ ูŠุณุชุฎุฏู… ู…ุฎุทุท ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุฎุตุต (`dstId` = `0`ุŒ `dstType` = `VAULT`).", + "tags": [ + "Network connections" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NetworkConnection" + } + } + } + }, + "responses": { + "201": { + "description": "ูƒุงุฆู† ุงุชุตุงู„ ุงู„ุดุจูƒุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/NetworkConnectionResponse" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/network_connections/{connectionId}/set_routing_policy": { + "patch": { + "summary": "ุชุญุฏูŠุซ ุณูŠุงุณุฉ ุชูˆุฌูŠู‡ ุงุชุตุงู„ ุงู„ุดุจูƒุฉ.", + "description": "ุชุญุฏูŠุซ ุณูŠุงุณุฉ ุงู„ุชูˆุฌูŠู‡ ู„ุงุชุตุงู„ ุดุจูƒุฉ ู…ูˆุฌูˆุฏ. **ู…ู„ุงุญุธุฉ:** ุชุฎุถุน ู…ูƒุงู„ู…ุฉ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ู‡ุฐู‡ ู„ู…ุฎุทุทุงุช ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุฑู†ุฉ. ุชุญุฏุฏ ุณูŠุงุณุฉ ุงู„ุชูˆุฌูŠู‡ ุงู„ุฎุงุตุฉ ุจูƒ ูƒูŠููŠุฉ ุชูˆุฌูŠู‡ ู…ุนุงู…ู„ุงุชูƒ. ูŠู…ูƒู†ูƒ ุงุฎุชูŠุงุฑ ุฃุญุฏ ุงู„ู…ุฎุทุทุงุช ุงู„ุซู„ุงุซุฉ ุงู„ู…ุฎุชู„ูุฉ ุงู„ู…ุฐูƒูˆุฑุฉ ุฃุฏู†ุงู‡ ู„ูƒู„ ู†ูˆุน ู…ู† ุฃู†ูˆุงุน ุงู„ุฃุตูˆู„: - **ู„ุง ุดูŠุก**ุ› ูŠุญุฏุฏ ุชูˆุฌูŠู‡ ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ ุฅู„ู‰ ูˆุฌู‡ุฉ ู„ุง ู„ู†ูˆุน ุงู„ุฃุตูˆู„ ู‡ุฐุง. ุณุชูุดู„ ุงู„ู…ุนุงู…ู„ุงุช ุงู„ูˆุงุฑุฏุฉ ุฅู„ู‰ ุฃู†ูˆุงุน ุงู„ุฃุตูˆู„ ุงู„ุชูŠ ุชู… ุชูˆุฌูŠู‡ู‡ุง ุฅู„ู‰ "ู„ุง ุดูŠุก". - **ู…ุฎุตุต**ุ› ุงู„ุชูˆุฌูŠู‡ ุฅู„ู‰ ุญุณุงุจ ุชุฎุชุงุฑู‡. ุฅุฐุง ู‚ู…ุช ุจุฅุฒุงู„ุฉ ุงู„ุญุณุงุจุŒ ูุณุชูุดู„ ุงู„ู…ุนุงู…ู„ุงุช ุงู„ูˆุงุฑุฏุฉ ุญุชู‰ ุชุฎุชุงุฑ ุญุณุงุจู‹ุง ุขุฎุฑ. - **ุงูุชุฑุงุถูŠ**ุ› ุงุณุชุฎุฏู… ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุญุฏุฏ ุจูˆุงุณุทุฉ ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ ุงู„ุฐูŠ ูŠุชุตู„ ุจู‡ ุงู„ุงุชุตุงู„. ูŠุดุงุฑ ุฅู„ู‰ ู‡ุฐุง ุงู„ู…ุฎุทุท ุฃูŠุถู‹ุง ุจุงุณู… "ุชูˆุฌูŠู‡ ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ" ุงู„ุฅุนุฏุงุฏุงุช ุงู„ู…ุณุจู‚ุฉ ู„ู…ุณุงุญุฉ ุงู„ุนู…ู„ ุงู„ุงูุชุฑุงุถูŠุฉ: - ุชุดููŠุฑ ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ โ†’ **ู…ุฎุตุต** - ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ FIAT โ†’ **ู„ุง ุดูŠุก** - ุชุดููŠุฑ ุงุชุตุงู„ ุงู„ุดุจูƒุฉ โ†’ **ุงูุชุฑุงุถูŠ** - ุงุชุตุงู„ ุงู„ุดุจูƒุฉ FIAT โ†’ **ุงูุชุฑุงุถูŠ** - **ู…ู„ุงุญุธุฉ**: ุจุดูƒู„ ุงูุชุฑุงุถูŠุŒ ูŠุณุชุฎุฏู… ู…ุฎุทุท ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุฎุตุต (`dstId` = `0`ุŒ `dstType` = `VAULT`).", + "tags": [ + "Network connections" + ], + "parameters": [ + { + "in": "path", + "name": "connectionId", + "required": true, + "description": "ู…ุนุฑู ุงุชุตุงู„ ุงู„ุดุจูƒุฉ", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "routingPolicy": { + "$ref": "#/components/schemas/NetworkConnectionRoutingPolicy" + } + }, + "required": [ + "routingPolicy" + ] + } + } + } + }, + "responses": { + "200": { + "description": "ู…ุนุฑู ุงู„ุดุจูƒุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "properties": { + "success": { + "type": "boolean" + } + }, + "required": [ + "success" + ] + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/network_connections/{connectionId}/is_third_party_routing/{assetType}": { + "get": { + "summary": "ุงุณุชุฑุฏุงุฏ ุงู„ุชุญู‚ู‚ ู…ู† ุชูˆุฌูŠู‡ ุงู„ุดุจูƒุฉ ุงู„ุฎุงุตุฉ ุจุทุฑู ุซุงู„ุซ ุญุณุจ ู†ูˆุน ุงู„ุฃุตูˆู„.", + "description": "ุชุชูŠุญ ุดุจูƒุฉ Fireblocks ุงู„ู…ุฑูˆู†ุฉ ููŠู…ุง ูŠุชุนู„ู‚ ุจุงู„ูˆุฏุงุฆุน ุงู„ูˆุงุฑุฏุฉ. ูŠู…ูƒู† ู„ู„ู…ุณุชู„ู… ุชู„ู‚ูŠ ูˆุฏุงุฆุน ุงู„ุดุจูƒุฉ ููŠ ู…ูˆุงู‚ุน ุฃุฎุฑู‰ ุบูŠุฑ Fireblocks. ุชุชุญู‚ู‚ ู‡ุฐู‡ ุงู„ู†ู‚ุทุฉ ุงู„ู†ู‡ุงุฆูŠุฉ ู…ู…ุง ุฅุฐุง ูƒุงู†ุช ุงู„ู…ุนุงู…ู„ุงุช ุงู„ู…ุณุชู‚ุจู„ูŠุฉ ูŠุชู… ุชูˆุฌูŠู‡ู‡ุง ุฅู„ู‰ ุงู„ู…ุณุชู„ู… ุงู„ู…ุนุฑูˆุถ ุฃูˆ ุฅู„ู‰ ุฌู‡ุฉ ุฎุงุฑุฌูŠุฉ.", + "tags": [ + "Network connections" + ], + "parameters": [ + { + "in": "path", + "name": "connectionId", + "required": true, + "description": "ู…ุนุฑู ุงุชุตุงู„ ุงู„ุดุจูƒุฉ", + "schema": { + "type": "string", + "minimum": 1 + } + }, + { + "in": "path", + "name": "assetType", + "required": true, + "description": "ู†ูˆุน ุงู„ุฃุตูˆู„ ุงู„ูˆุฌู‡ุฉ", + "schema": { + "oneOf": [ + { + "const": "CRYPTO" + }, + { + "const": "SIGNET" + }, + { + "const": "SEN" + }, + { + "const": "SIGNET_TEST" + }, + { + "const": "SEN_TEST" + } + ] + } + } + ], + "responses": { + "200": { + "description": "ู†ุชูŠุฌุฉ ู„ู„ุชุญู‚ู‚", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "properties": { + "isThirdPartyRouting": { + "type": "boolean" + }, + "description": { + "type": "string" + } + } + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/network_connections/{connectionId}": { + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ุงุชุตุงู„ ุจุงู„ุดุจูƒุฉ", + "description": "ูŠุญุตู„ ุนู„ู‰ ุงุชุตุงู„ ุจุงู„ุดุจูƒุฉ ุนู† ุทุฑูŠู‚ ุงู„ู…ุนุฑู. **ู…ู„ุงุญุธุฉ:** ุชุฎุถุน ู…ูƒุงู„ู…ุฉ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ู‡ุฐู‡ ู„ู…ุฎุทุทุงุช ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุฑู†ุฉ. ุชุญุฏุฏ ุณูŠุงุณุฉ ุงู„ุชูˆุฌูŠู‡ ุงู„ุฎุงุตุฉ ุจูƒ ูƒูŠููŠุฉ ุชูˆุฌูŠู‡ ู…ุนุงู…ู„ุงุชูƒ. ูŠู…ูƒู†ูƒ ุงุฎุชูŠุงุฑ ุฃุญุฏ ุงู„ู…ุฎุทุทุงุช ุงู„ุซู„ุงุซุฉ ุงู„ู…ุฎุชู„ูุฉ ุงู„ู…ุฐูƒูˆุฑุฉ ุฃุฏู†ุงู‡ ู„ูƒู„ ู†ูˆุน ู…ู† ุฃู†ูˆุงุน ุงู„ุฃุตูˆู„: - **ู„ุง ุดูŠุก**ุ› ูŠุญุฏุฏ ุชูˆุฌูŠู‡ ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ ุฅู„ู‰ ูˆุฌู‡ุฉ ู„ุง ู„ู†ูˆุน ุงู„ุฃุตูˆู„ ู‡ุฐุง. ุณุชูุดู„ ุงู„ู…ุนุงู…ู„ุงุช ุงู„ูˆุงุฑุฏุฉ ุฅู„ู‰ ุฃู†ูˆุงุน ุงู„ุฃุตูˆู„ ุงู„ุชูŠ ุชู… ุชูˆุฌูŠู‡ู‡ุง ุฅู„ู‰ "ู„ุง ุดูŠุก". - **ู…ุฎุตุต**ุ› ุงู„ุชูˆุฌูŠู‡ ุฅู„ู‰ ุญุณุงุจ ุชุฎุชุงุฑู‡. ุฅุฐุง ู‚ู…ุช ุจุฅุฒุงู„ุฉ ุงู„ุญุณุงุจุŒ ูุณุชูุดู„ ุงู„ู…ุนุงู…ู„ุงุช ุงู„ูˆุงุฑุฏุฉ ุญุชู‰ ุชุฎุชุงุฑ ุญุณุงุจู‹ุง ุขุฎุฑ. - **ุงูุชุฑุงุถูŠ**ุ› ุงุณุชุฎุฏู… ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุญุฏุฏ ุจูˆุงุณุทุฉ ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ ุงู„ุฐูŠ ูŠุชุตู„ ุจู‡ ุงู„ุงุชุตุงู„. ูŠุดุงุฑ ุฅู„ู‰ ู‡ุฐุง ุงู„ู…ุฎุทุท ุฃูŠุถู‹ุง ุจุงุณู… "ุชูˆุฌูŠู‡ ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ" ุงู„ุฅุนุฏุงุฏุงุช ุงู„ู…ุณุจู‚ุฉ ู„ู…ุณุงุญุฉ ุงู„ุนู…ู„ ุงู„ุงูุชุฑุงุถูŠุฉ: - ุชุดููŠุฑ ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ โ†’ **ู…ุฎุตุต** - ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ FIAT โ†’ **ู„ุง ุดูŠุก** - ุชุดููŠุฑ ุงุชุตุงู„ ุงู„ุดุจูƒุฉ โ†’ **ุงูุชุฑุงุถูŠ** - ุงุชุตุงู„ ุงู„ุดุจูƒุฉ FIAT โ†’ **ุงูุชุฑุงุถูŠ** - **ู…ู„ุงุญุธุฉ**: ุจุดูƒู„ ุงูุชุฑุงุถูŠุŒ ูŠุณุชุฎุฏู… ู…ุฎุทุท ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุฎุตุต (`dstId` = `0`ุŒ `dstType` = `VAULT`).", + "tags": [ + "Network connections" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "network_connection = fireblocks.get_network_connection_by_id(connectionId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const network_connection = await fireblocks.getNetworkConnection(connectionId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "connectionId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุงุชุตุงู„", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ุงุชุตุงู„ ุจุงู„ุดุจูƒุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/NetworkConnectionResponse" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "delete": { + "summary": "ุญุฐู ุงุชุตุงู„ ุงู„ุดุจูƒุฉ ุนู† ุทุฑูŠู‚ ุงู„ู…ุนุฑู", + "description": "ูŠุญุฐู ุงุชุตุงู„ ุดุจูƒุฉ ู…ูˆุฌูˆุฏ ู…ุญุฏุฏ ุจูˆุงุณุทุฉ ู…ุนุฑู ุงู„ุงุชุตุงู„ ุงู„ุฎุงุต ุจู‡. **ู…ู„ุงุญุธุฉ:** ุชุฎุถุน ู…ูƒุงู„ู…ุฉ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ู‡ุฐู‡ ู„ู…ุฎุทุทุงุช ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุฑู†ุฉ. ุชุญุฏุฏ ุณูŠุงุณุฉ ุงู„ุชูˆุฌูŠู‡ ุงู„ุฎุงุตุฉ ุจูƒ ูƒูŠููŠุฉ ุชูˆุฌูŠู‡ ู…ุนุงู…ู„ุงุชูƒ. ูŠู…ูƒู†ูƒ ุงุฎุชูŠุงุฑ ุฃุญุฏ ุงู„ู…ุฎุทุทุงุช ุงู„ุซู„ุงุซุฉ ุงู„ู…ุฎุชู„ูุฉ ุงู„ู…ุฐูƒูˆุฑุฉ ุฃุฏู†ุงู‡ ู„ูƒู„ ู†ูˆุน ู…ู† ุฃู†ูˆุงุน ุงู„ุฃุตูˆู„: - **ู„ุง ุดูŠุก**ุ› ูŠุญุฏุฏ ุชูˆุฌูŠู‡ ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ ุฅู„ู‰ ูˆุฌู‡ุฉ ุบูŠุฑ ู…ูˆุฌูˆุฏุฉ ู„ู†ูˆุน ุงู„ุฃุตูˆู„ ู‡ุฐุง. ุณุชูุดู„ ุงู„ู…ุนุงู…ู„ุงุช ุงู„ูˆุงุฑุฏุฉ ุฅู„ู‰ ุฃู†ูˆุงุน ุงู„ุฃุตูˆู„ ุงู„ุชูŠ ุชู… ุชูˆุฌูŠู‡ู‡ุง ุฅู„ู‰ "ู„ุง ุดูŠุก". - **ู…ุฎุตุต**ุ› ุงู„ุชูˆุฌูŠู‡ ุฅู„ู‰ ุญุณุงุจ ุชุฎุชุงุฑู‡. ุฅุฐุง ู‚ู…ุช ุจุฅุฒุงู„ุฉ ุงู„ุญุณุงุจุŒ ูุณุชูุดู„ ุงู„ู…ุนุงู…ู„ุงุช ุงู„ูˆุงุฑุฏุฉ ุญุชู‰ ุชุฎุชุงุฑ ุญุณุงุจู‹ุง ุขุฎุฑ. - **ุงูุชุฑุงุถูŠ**ุ› ุงุณุชุฎุฏู… ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุญุฏุฏ ุจูˆุงุณุทุฉ ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ ุงู„ุฐูŠ ูŠุชุตู„ ุจู‡ ุงู„ุงุชุตุงู„. ูŠุดุงุฑ ุฅู„ู‰ ู‡ุฐุง ุงู„ู…ุฎุทุท ุฃูŠุถู‹ุง ุจุงุณู… "ุชูˆุฌูŠู‡ ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ" ุงู„ุฅุนุฏุงุฏุงุช ุงู„ู…ุณุจู‚ุฉ ู„ู…ุณุงุญุฉ ุงู„ุนู…ู„ ุงู„ุงูุชุฑุงุถูŠุฉ: - ุชุดููŠุฑ ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ โ†’ **ู…ุฎุตุต** - ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ FIAT โ†’ **ู„ุง ุดูŠุก** - ุชุดููŠุฑ ุงุชุตุงู„ ุงู„ุดุจูƒุฉ โ†’ **ุงูุชุฑุงุถูŠ** - ุงุชุตุงู„ ุงู„ุดุจูƒุฉ FIAT โ†’ **ุงูุชุฑุงุถูŠ** - **ู…ู„ุงุญุธุฉ**: ุจุดูƒู„ ุงูุชุฑุงุถูŠุŒ ูŠุณุชุฎุฏู… ู…ุฎุทุท ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุฎุตุต (`dstId` = `0`ุŒ `dstType` = `VAULT`).", + "tags": [ + "Network connections" + ], + "parameters": [ + { + "in": "path", + "name": "connectionId", + "required": true, + "description": "ู…ุนุฑู ุงุชุตุงู„ ุงู„ุดุจูƒุฉ ุงู„ู…ุฑุงุฏ ุญุฐูู‡", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ู…ุนุฑู ุงู„ุดุจูƒุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "properties": { + "success": { + "type": "boolean" + } + }, + "required": [ + "success" + ] + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/network_ids": { + "get": { + "summary": "ุฅุฑุฌุงุน ุฌู…ูŠุน ู…ุนุฑูุงุช ุงู„ุดุจูƒุฉุŒ ุณูˆุงุก ู…ุนุฑูุงุช ู…ุญู„ูŠุฉ ุฃูˆ ู…ุนุฑูุงุช ุจุนูŠุฏุฉ ูŠู…ูƒู† ุงูƒุชุดุงูู‡ุง", + "description": "ูŠุณุชุฑุฏ ู‚ุงุฆู…ุฉ ุจุฌู…ูŠุน ู…ุนุฑูุงุช ุงู„ุดุจูƒุฉ ุงู„ู…ุญู„ูŠุฉ ูˆุงู„ุจุนูŠุฏุฉ ุงู„ุชูŠ ูŠู…ูƒู† ุงูƒุชุดุงูู‡ุง. **ู…ู„ุงุญุธุฉ:** ุชุฎุถุน ู…ูƒุงู„ู…ุฉ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ู‡ุฐู‡ ู„ู…ุฎุทุทุงุช ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุฑู†ุฉ. ุชุญุฏุฏ ุณูŠุงุณุฉ ุงู„ุชูˆุฌูŠู‡ ุงู„ุฎุงุตุฉ ุจูƒ ูƒูŠููŠุฉ ุชูˆุฌูŠู‡ ู…ุนุงู…ู„ุงุชูƒ. ูŠู…ูƒู†ูƒ ุงุฎุชูŠุงุฑ ุฃุญุฏ ุงู„ู…ุฎุทุทุงุช ุงู„ุซู„ุงุซุฉ ุงู„ู…ุฎุชู„ูุฉ ุงู„ู…ุฐูƒูˆุฑุฉ ุฃุฏู†ุงู‡ ู„ูƒู„ ู†ูˆุน ู…ู† ุฃู†ูˆุงุน ุงู„ุฃุตูˆู„: - **ู„ุง ุดูŠุก**ุ› ูŠุญุฏุฏ ุชูˆุฌูŠู‡ ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ ุฅู„ู‰ ูˆุฌู‡ุฉ ู„ุง ุชูˆุฌุฏ ู„ู†ูˆุน ุงู„ุฃุตูˆู„ ู‡ุฐุง. ุณุชูุดู„ ุงู„ู…ุนุงู…ู„ุงุช ุงู„ูˆุงุฑุฏุฉ ุฅู„ู‰ ุฃู†ูˆุงุน ุงู„ุฃุตูˆู„ ุงู„ุชูŠ ุชู… ุชูˆุฌูŠู‡ู‡ุง ุฅู„ู‰ "ู„ุง ุดูŠุก". - **ู…ุฎุตุต**ุ› ุงู„ุชูˆุฌูŠู‡ ุฅู„ู‰ ุญุณุงุจ ุชุฎุชุงุฑู‡. ุฅุฐุง ู‚ู…ุช ุจุฅุฒุงู„ุฉ ุงู„ุญุณุงุจุŒ ูุณุชูุดู„ ุงู„ู…ุนุงู…ู„ุงุช ุงู„ูˆุงุฑุฏุฉ ุญุชู‰ ุชุฎุชุงุฑ ุญุณุงุจู‹ุง ุขุฎุฑ. - **ุงูุชุฑุงุถูŠ**ุ› ุงุณุชุฎุฏู… ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุญุฏุฏ ุจูˆุงุณุทุฉ ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ ุงู„ุฐูŠ ูŠุชุตู„ ุจู‡ ุงู„ุงุชุตุงู„. ูŠุดุงุฑ ุฅู„ู‰ ู‡ุฐุง ุงู„ู…ุฎุทุท ุฃูŠุถู‹ุง ุจุงุณู… "ุชูˆุฌูŠู‡ ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ" ุงู„ุฅุนุฏุงุฏุงุช ุงู„ู…ุณุจู‚ุฉ ู„ู…ุณุงุญุฉ ุงู„ุนู…ู„ ุงู„ุงูุชุฑุงุถูŠุฉ: - ุชุดููŠุฑ ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ โ†’ **ู…ุฎุตุต** - ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ FIAT โ†’ **ู„ุง ุดูŠุก** - ุชุดููŠุฑ ุงุชุตุงู„ ุงู„ุดุจูƒุฉ โ†’ **ุงูุชุฑุงุถูŠ** - ุงุชุตุงู„ ุงู„ุดุจูƒุฉ FIAT โ†’ **ุงูุชุฑุงุถูŠ** - **ู…ู„ุงุญุธุฉ**: ุจุดูƒู„ ุงูุชุฑุงุถูŠุŒ ูŠุณุชุฎุฏู… ู…ุฎุทุท ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุฎุตุต (`dstId` = `0`ุŒ `dstType` = `VAULT`).", + "tags": [ + "Network connections" + ], + "responses": { + "200": { + "description": "ู‚ุงุฆู…ุฉ ู…ุนุฑูุงุช ุงู„ุดุจูƒุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": {} + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "ุฅู†ุดุงุก ู…ุนุฑู ุดุจูƒุฉ ุฌุฏูŠุฏ", + "description": "ูŠู†ุดุฆ ู…ุนุฑู ุดุจูƒุฉ ุฌุฏูŠุฏ. **ู…ู„ุงุญุธุฉ:** ุชุฎุถุน ู…ูƒุงู„ู…ุฉ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ู‡ุฐู‡ ู„ู…ุฎุทุทุงุช ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุฑู†ุฉ. ุชุญุฏุฏ ุณูŠุงุณุฉ ุงู„ุชูˆุฌูŠู‡ ุงู„ุฎุงุตุฉ ุจูƒ ูƒูŠููŠุฉ ุชูˆุฌูŠู‡ ู…ุนุงู…ู„ุงุชูƒ. ูŠู…ูƒู†ูƒ ุงุฎุชูŠุงุฑ ุฃุญุฏ ุงู„ู…ุฎุทุทุงุช ุงู„ุซู„ุงุซุฉ ุงู„ู…ุฎุชู„ูุฉ ุงู„ู…ุฐูƒูˆุฑุฉ ุฃุฏู†ุงู‡ ู„ูƒู„ ู†ูˆุน ู…ู† ุฃู†ูˆุงุน ุงู„ุฃุตูˆู„: - **ู„ุง ุดูŠุก**ุ› ูŠุญุฏุฏ ุชูˆุฌูŠู‡ ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ ุฅู„ู‰ ูˆุฌู‡ุฉ ู„ุง ู„ู†ูˆุน ุงู„ุฃุตูˆู„ ู‡ุฐุง. ุณุชูุดู„ ุงู„ู…ุนุงู…ู„ุงุช ุงู„ูˆุงุฑุฏุฉ ุฅู„ู‰ ุฃู†ูˆุงุน ุงู„ุฃุตูˆู„ ุงู„ุชูŠ ุชู… ุชูˆุฌูŠู‡ู‡ุง ุฅู„ู‰ "ู„ุง ุดูŠุก". - **ู…ุฎุตุต**ุ› ุงู„ุชูˆุฌูŠู‡ ุฅู„ู‰ ุญุณุงุจ ุชุฎุชุงุฑู‡. ุฅุฐุง ู‚ู…ุช ุจุฅุฒุงู„ุฉ ุงู„ุญุณุงุจุŒ ูุณุชูุดู„ ุงู„ู…ุนุงู…ู„ุงุช ุงู„ูˆุงุฑุฏุฉ ุญุชู‰ ุชุฎุชุงุฑ ุญุณุงุจู‹ุง ุขุฎุฑ. - **ุงูุชุฑุงุถูŠ**ุ› ุงุณุชุฎุฏู… ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุญุฏุฏ ุจูˆุงุณุทุฉ ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ ุงู„ุฐูŠ ูŠุชุตู„ ุจู‡ ุงู„ุงุชุตุงู„. ูŠุดุงุฑ ุฅู„ู‰ ู‡ุฐุง ุงู„ู…ุฎุทุท ุฃูŠุถู‹ุง ุจุงุณู… "ุชูˆุฌูŠู‡ ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ" ุงู„ุฅุนุฏุงุฏุงุช ุงู„ู…ุณุจู‚ุฉ ู„ู…ุณุงุญุฉ ุงู„ุนู…ู„ ุงู„ุงูุชุฑุงุถูŠุฉ: - ุชุดููŠุฑ ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ โ†’ **ู…ุฎุตุต** - ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ FIAT โ†’ **ู„ุง ุดูŠุก** - ุชุดููŠุฑ ุงุชุตุงู„ ุงู„ุดุจูƒุฉ โ†’ **ุงูุชุฑุงุถูŠ** - ุงุชุตุงู„ ุงู„ุดุจูƒุฉ FIAT โ†’ **ุงูุชุฑุงุถูŠ** - **ู…ู„ุงุญุธุฉ**: ุจุดูƒู„ ุงูุชุฑุงุถูŠุŒ ูŠุณุชุฎุฏู… ู…ุฎุทุท ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุฎุตุต (`dstId` = `0`ุŒ `dstType` = `VAULT`).", + "tags": [ + "Network connections" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "type": "string" + }, + "routingPolicy": { + "$ref": "#/components/schemas/NetworkIdRoutingPolicy" + } + }, + "required": [ + "name" + ] + } + } + } + }, + "responses": { + "201": { + "description": "ุฅุฑุฌุงุน ู…ุนุฑู ุงู„ุดุจูƒุฉ ุงู„ุฌุฏูŠุฏ ููŠ ู…ุณุงุญุฉ ุงู„ุนู…ู„ ุงู„ุฎุงุตุฉ ุจูƒ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/NetworkIdResponse" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/network_ids/{networkId}": { + "get": { + "summary": "ุฅุฑุฌุงุน ู…ุนุฑู ุงู„ุดุจูƒุฉ ุงู„ู…ุญุฏุฏ.", + "description": "ูŠุณุชุฑุฏ ุดุจูƒุฉ ู…ู† ุฎู„ุงู„ ู…ุนุฑูู‡ุง. **ู…ู„ุงุญุธุฉ:** ุชุฎุถุน ู…ูƒุงู„ู…ุฉ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ู‡ุฐู‡ ู„ู…ุฎุทุทุงุช ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุฑู†ุฉ. ุชุญุฏุฏ ุณูŠุงุณุฉ ุงู„ุชูˆุฌูŠู‡ ุงู„ุฎุงุตุฉ ุจูƒ ูƒูŠููŠุฉ ุชูˆุฌูŠู‡ ู…ุนุงู…ู„ุงุชูƒ. ูŠู…ูƒู†ูƒ ุงุฎุชูŠุงุฑ ุฃุญุฏ ุงู„ู…ุฎุทุทุงุช ุงู„ุซู„ุงุซุฉ ุงู„ู…ุฎุชู„ูุฉ ุงู„ู…ุฐูƒูˆุฑุฉ ุฃุฏู†ุงู‡ ู„ูƒู„ ู†ูˆุน ู…ู† ุฃู†ูˆุงุน ุงู„ุฃุตูˆู„: - **ู„ุง ุดูŠุก**ุ› ูŠุญุฏุฏ ุชูˆุฌูŠู‡ ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ ุฅู„ู‰ ูˆุฌู‡ุฉ ู„ุง ู„ู†ูˆุน ุงู„ุฃุตูˆู„ ู‡ุฐุง. ุณุชูุดู„ ุงู„ู…ุนุงู…ู„ุงุช ุงู„ูˆุงุฑุฏุฉ ุฅู„ู‰ ุฃู†ูˆุงุน ุงู„ุฃุตูˆู„ ุงู„ุชูŠ ุชู… ุชูˆุฌูŠู‡ู‡ุง ุฅู„ู‰ "ู„ุง ุดูŠุก". - **ู…ุฎุตุต**ุ› ุงู„ุชูˆุฌูŠู‡ ุฅู„ู‰ ุญุณุงุจ ุชุฎุชุงุฑู‡. ุฅุฐุง ู‚ู…ุช ุจุฅุฒุงู„ุฉ ุงู„ุญุณุงุจุŒ ูุณุชูุดู„ ุงู„ู…ุนุงู…ู„ุงุช ุงู„ูˆุงุฑุฏุฉ ุญุชู‰ ุชุฎุชุงุฑ ุญุณุงุจู‹ุง ุขุฎุฑ. - **ุงูุชุฑุงุถูŠ**ุ› ุงุณุชุฎุฏู… ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุญุฏุฏ ุจูˆุงุณุทุฉ ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ ุงู„ุฐูŠ ูŠุชุตู„ ุจู‡ ุงู„ุงุชุตุงู„. ูŠุดุงุฑ ุฅู„ู‰ ู‡ุฐุง ุงู„ู…ุฎุทุท ุฃูŠุถู‹ุง ุจุงุณู… "ุชูˆุฌูŠู‡ ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ" ุงู„ุฅุนุฏุงุฏุงุช ุงู„ู…ุณุจู‚ุฉ ู„ู…ุณุงุญุฉ ุงู„ุนู…ู„ ุงู„ุงูุชุฑุงุถูŠุฉ: - ุชุดููŠุฑ ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ โ†’ **ู…ุฎุตุต** - ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ FIAT โ†’ **ู„ุง ุดูŠุก** - ุชุดููŠุฑ ุงุชุตุงู„ ุงู„ุดุจูƒุฉ โ†’ **ุงูุชุฑุงุถูŠ** - ุงุชุตุงู„ ุงู„ุดุจูƒุฉ FIAT โ†’ **ุงูุชุฑุงุถูŠ** - **ู…ู„ุงุญุธุฉ**: ุจุดูƒู„ ุงูุชุฑุงุถูŠุŒ ูŠุณุชุฎุฏู… ู…ุฎุทุท ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุฎุตุต (`dstId` = `0`ุŒ `dstType` = `VAULT`).", + "tags": [ + "Network connections" + ], + "parameters": [ + { + "in": "path", + "name": "networkId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุดุจูƒุฉ", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ู…ุนุฑู ุงู„ุดุจูƒุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/NetworkIdResponse" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "delete": { + "summary": "ุญุฐู ู…ุนุฑู ุงู„ุดุจูƒุฉ ุงู„ู…ุญุฏุฏ.", + "description": "ูŠุญุฐู ุดุจูƒุฉ ู…ู† ุฎู„ุงู„ ู…ุนุฑูู‡ุง. **ู…ู„ุงุญุธุฉ:** ุชุฎุถุน ู…ูƒุงู„ู…ุฉ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ู‡ุฐู‡ ู„ู…ุฎุทุทุงุช ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุฑู†ุฉ. ุชุญุฏุฏ ุณูŠุงุณุฉ ุงู„ุชูˆุฌูŠู‡ ุงู„ุฎุงุตุฉ ุจูƒ ูƒูŠููŠุฉ ุชูˆุฌูŠู‡ ู…ุนุงู…ู„ุงุชูƒ. ูŠู…ูƒู†ูƒ ุงุฎุชูŠุงุฑ ุฃุญุฏ ุงู„ู…ุฎุทุทุงุช ุงู„ุซู„ุงุซุฉ ุงู„ู…ุฎุชู„ูุฉ ุงู„ู…ุฐูƒูˆุฑุฉ ุฃุฏู†ุงู‡ ู„ูƒู„ ู†ูˆุน ู…ู† ุฃู†ูˆุงุน ุงู„ุฃุตูˆู„: - **ู„ุง ุดูŠุก**ุ› ูŠุญุฏุฏ ุชูˆุฌูŠู‡ ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ ุฅู„ู‰ ูˆุฌู‡ุฉ ู„ุง ู„ู†ูˆุน ุงู„ุฃุตูˆู„ ู‡ุฐุง. ุณุชูุดู„ ุงู„ู…ุนุงู…ู„ุงุช ุงู„ูˆุงุฑุฏุฉ ุฅู„ู‰ ุฃู†ูˆุงุน ุงู„ุฃุตูˆู„ ุงู„ุชูŠ ุชู… ุชูˆุฌูŠู‡ู‡ุง ุฅู„ู‰ "ู„ุง ุดูŠุก". - **ู…ุฎุตุต**ุ› ุงู„ุชูˆุฌูŠู‡ ุฅู„ู‰ ุญุณุงุจ ุชุฎุชุงุฑู‡. ุฅุฐุง ู‚ู…ุช ุจุฅุฒุงู„ุฉ ุงู„ุญุณุงุจุŒ ูุณุชูุดู„ ุงู„ู…ุนุงู…ู„ุงุช ุงู„ูˆุงุฑุฏุฉ ุญุชู‰ ุชุฎุชุงุฑ ุญุณุงุจู‹ุง ุขุฎุฑ. - **ุงูุชุฑุงุถูŠ**ุ› ุงุณุชุฎุฏู… ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุญุฏุฏ ุจูˆุงุณุทุฉ ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ ุงู„ุฐูŠ ูŠุชุตู„ ุจู‡ ุงู„ุงุชุตุงู„. ูŠุดุงุฑ ุฅู„ู‰ ู‡ุฐุง ุงู„ู…ุฎุทุท ุฃูŠุถู‹ุง ุจุงุณู… "ุชูˆุฌูŠู‡ ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ" ุงู„ุฅุนุฏุงุฏุงุช ุงู„ู…ุณุจู‚ุฉ ู„ู…ุณุงุญุฉ ุงู„ุนู…ู„ ุงู„ุงูุชุฑุงุถูŠุฉ: - ุชุดููŠุฑ ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ โ†’ **ู…ุฎุตุต** - ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ FIAT โ†’ **ู„ุง ุดูŠุก** - ุชุดููŠุฑ ุงุชุตุงู„ ุงู„ุดุจูƒุฉ โ†’ **ุงูุชุฑุงุถูŠ** - ุงุชุตุงู„ ุงู„ุดุจูƒุฉ FIAT โ†’ **ุงูุชุฑุงุถูŠ** - **ู…ู„ุงุญุธุฉ**: ุจุดูƒู„ ุงูุชุฑุงุถูŠุŒ ูŠุณุชุฎุฏู… ู…ุฎุทุท ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุฎุตุต (`dstId` = `0`ุŒ `dstType` = `VAULT`).", + "tags": [ + "Network connections" + ], + "parameters": [ + { + "in": "path", + "name": "networkId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุดุจูƒุฉ", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ู…ุนุฑู ุงู„ุดุจูƒุฉ", + "content": { + "*/*": { + "schema": { + "properties": { + "success": { + "type": "boolean" + } + }, + "required": [ + "success" + ] + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/network_ids/{networkId}/set_routing_policy": { + "patch": { + "summary": "ุชุญุฏูŠุซ ุณูŠุงุณุฉ ุชูˆุฌูŠู‡ ู…ุนุฑู ุงู„ุดุจูƒุฉ.", + "description": "ูŠู‚ูˆู… ุจุชุญุฏูŠุซ ุณูŠุงุณุฉ ุงู„ุชูˆุฌูŠู‡ ู„ู…ุนุฑู ุดุจูƒุฉ ู…ุญุฏุฏ. **ู…ู„ุงุญุธุฉ:** ุชุฎุถุน ู…ูƒุงู„ู…ุฉ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ู‡ุฐู‡ ู„ู…ุฎุทุทุงุช ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุฑู†ุฉ. ุชุญุฏุฏ ุณูŠุงุณุฉ ุงู„ุชูˆุฌูŠู‡ ุงู„ุฎุงุตุฉ ุจูƒ ูƒูŠููŠุฉ ุชูˆุฌูŠู‡ ู…ุนุงู…ู„ุงุชูƒ. ูŠู…ูƒู†ูƒ ุงุฎุชูŠุงุฑ ุฃุญุฏ ุงู„ู…ุฎุทุทุงุช ุงู„ุซู„ุงุซุฉ ุงู„ู…ุฎุชู„ูุฉ ุงู„ู…ุฐูƒูˆุฑุฉ ุฃุฏู†ุงู‡ ู„ูƒู„ ู†ูˆุน ู…ู† ุฃู†ูˆุงุน ุงู„ุฃุตูˆู„: - **ู„ุง ุดูŠุก**ุ› ูŠุญุฏุฏ ุชูˆุฌูŠู‡ ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ ุฅู„ู‰ ูˆุฌู‡ุฉ ู„ุง ุชูˆุฌุฏ ู„ู†ูˆุน ุงู„ุฃุตูˆู„ ู‡ุฐุง. ุณุชูุดู„ ุงู„ู…ุนุงู…ู„ุงุช ุงู„ูˆุงุฑุฏุฉ ุฅู„ู‰ ุฃู†ูˆุงุน ุงู„ุฃุตูˆู„ ุงู„ุชูŠ ุชู… ุชูˆุฌูŠู‡ู‡ุง ุฅู„ู‰ "ู„ุง ุดูŠุก". - **ู…ุฎุตุต**ุ› ุงู„ุชูˆุฌูŠู‡ ุฅู„ู‰ ุญุณุงุจ ุชุฎุชุงุฑู‡. ุฅุฐุง ู‚ู…ุช ุจุฅุฒุงู„ุฉ ุงู„ุญุณุงุจุŒ ูุณุชูุดู„ ุงู„ู…ุนุงู…ู„ุงุช ุงู„ูˆุงุฑุฏุฉ ุญุชู‰ ุชุฎุชุงุฑ ุญุณุงุจู‹ุง ุขุฎุฑ. - **ุงูุชุฑุงุถูŠ**ุ› ุงุณุชุฎุฏู… ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุญุฏุฏ ุจูˆุงุณุทุฉ ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ ุงู„ุฐูŠ ูŠุชุตู„ ุจู‡ ุงู„ุงุชุตุงู„. ูŠุดุงุฑ ุฅู„ู‰ ู‡ุฐุง ุงู„ู…ุฎุทุท ุฃูŠุถู‹ุง ุจุงุณู… "ุชูˆุฌูŠู‡ ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ" ุงู„ุฅุนุฏุงุฏุงุช ุงู„ู…ุณุจู‚ุฉ ู„ู…ุณุงุญุฉ ุงู„ุนู…ู„ ุงู„ุงูุชุฑุงุถูŠุฉ: - ุชุดููŠุฑ ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ โ†’ **ู…ุฎุตุต** - ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ FIAT โ†’ **ู„ุง ุดูŠุก** - ุชุดููŠุฑ ุงุชุตุงู„ ุงู„ุดุจูƒุฉ โ†’ **ุงูุชุฑุงุถูŠ** - ุงุชุตุงู„ ุงู„ุดุจูƒุฉ FIAT โ†’ **ุงูุชุฑุงุถูŠ** - **ู…ู„ุงุญุธุฉ**: ุจุดูƒู„ ุงูุชุฑุงุถูŠุŒ ูŠุณุชุฎุฏู… ู…ุฎุทุท ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุฎุตุต (`dstId` = `0`ุŒ `dstType` = `VAULT`).", + "tags": [ + "Network connections" + ], + "parameters": [ + { + "in": "path", + "name": "networkId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุดุจูƒุฉ", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "routingPolicy": { + "$ref": "#/components/schemas/NetworkIdRoutingPolicy" + } + }, + "required": [ + "routingPolicy" + ] + } + } + } + }, + "responses": { + "200": { + "description": "ู…ุนุฑู ุงู„ุดุจูƒุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "properties": { + "success": { + "type": "boolean" + } + }, + "required": [ + "success" + ] + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/network_ids/{networkId}/set_discoverability": { + "patch": { + "summary": "ุชุญุฏูŠุซ ุฅู…ูƒุงู†ูŠุฉ ุงูƒุชุดุงู ู…ุนุฑู ุงู„ุดุจูƒุฉ.", + "description": "ู‚ู… ุจุชุญุฏูŠุซ ู…ุง ุฅุฐุง ูƒุงู† ูŠู…ูƒู† ู„ู„ุขุฎุฑูŠู† ุงูƒุชุดุงู ู…ุนุฑู ุงู„ุดุจูƒุฉ ุฃู… ู„ุง. **ู…ู„ุงุญุธุฉ:** ุชุฎุถุน ู…ูƒุงู„ู…ุฉ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ู‡ุฐู‡ ู„ู…ุฎุทุทุงุช ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุฑู†ุฉ. ุชุญุฏุฏ ุณูŠุงุณุฉ ุงู„ุชูˆุฌูŠู‡ ุงู„ุฎุงุตุฉ ุจูƒ ูƒูŠููŠุฉ ุชูˆุฌูŠู‡ ู…ุนุงู…ู„ุงุชูƒ. ูŠู…ูƒู†ูƒ ุงุฎุชูŠุงุฑ ุฃุญุฏ ุงู„ู…ุฎุทุทุงุช ุงู„ุซู„ุงุซุฉ ุงู„ู…ุฎุชู„ูุฉ ุงู„ู…ุฐูƒูˆุฑุฉ ุฃุฏู†ุงู‡ ู„ูƒู„ ู†ูˆุน ู…ู† ุฃู†ูˆุงุน ุงู„ุฃุตูˆู„: - **ู„ุง ุดูŠุก**ุ› ูŠุญุฏุฏ ุชูˆุฌูŠู‡ ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ ุฅู„ู‰ ูˆุฌู‡ุฉ ู„ุง ู„ู†ูˆุน ุงู„ุฃุตูˆู„ ู‡ุฐุง. ุณุชูุดู„ ุงู„ู…ุนุงู…ู„ุงุช ุงู„ูˆุงุฑุฏุฉ ุฅู„ู‰ ุฃู†ูˆุงุน ุงู„ุฃุตูˆู„ ุงู„ุชูŠ ุชู… ุชูˆุฌูŠู‡ู‡ุง ุฅู„ู‰ "ู„ุง ุดูŠุก". - **ู…ุฎุตุต**ุ› ุงู„ุชูˆุฌูŠู‡ ุฅู„ู‰ ุญุณุงุจ ุชุฎุชุงุฑู‡. ุฅุฐุง ู‚ู…ุช ุจุฅุฒุงู„ุฉ ุงู„ุญุณุงุจุŒ ูุณุชูุดู„ ุงู„ู…ุนุงู…ู„ุงุช ุงู„ูˆุงุฑุฏุฉ ุญุชู‰ ุชุฎุชุงุฑ ุญุณุงุจู‹ุง ุขุฎุฑ. - **ุงูุชุฑุงุถูŠ**ุ› ุงุณุชุฎุฏู… ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุญุฏุฏ ุจูˆุงุณุทุฉ ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ ุงู„ุฐูŠ ูŠุชุตู„ ุจู‡ ุงู„ุงุชุตุงู„. ูŠุดุงุฑ ุฅู„ู‰ ู‡ุฐุง ุงู„ู…ุฎุทุท ุฃูŠุถู‹ุง ุจุงุณู… "ุชูˆุฌูŠู‡ ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ" ุงู„ุฅุนุฏุงุฏุงุช ุงู„ู…ุณุจู‚ุฉ ู„ู…ุณุงุญุฉ ุงู„ุนู…ู„ ุงู„ุงูุชุฑุงุถูŠุฉ: - ุชุดููŠุฑ ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ โ†’ **ู…ุฎุตุต** - ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ FIAT โ†’ **ู„ุง ุดูŠุก** - ุชุดููŠุฑ ุงุชุตุงู„ ุงู„ุดุจูƒุฉ โ†’ **ุงูุชุฑุงุถูŠ** - ุงุชุตุงู„ ุงู„ุดุจูƒุฉ FIAT โ†’ **ุงูุชุฑุงุถูŠ** - **ู…ู„ุงุญุธุฉ**: ุจุดูƒู„ ุงูุชุฑุงุถูŠุŒ ูŠุณุชุฎุฏู… ู…ุฎุทุท ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุฎุตุต (`dstId` = `0`ุŒ `dstType` = `VAULT`).", + "tags": [ + "Network connections" + ], + "parameters": [ + { + "in": "path", + "name": "networkId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุดุจูƒุฉ", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "isDiscoverable": { + "type": "boolean" + } + }, + "required": [ + "isDiscoverable" + ] + } + } + } + }, + "responses": { + "200": { + "description": "ู…ุนุฑู ุงู„ุดุจูƒุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "properties": { + "success": { + "type": "boolean" + } + }, + "required": [ + "success" + ] + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/network_ids/{networkId}/set_name": { + "patch": { + "summary": "ุชุญุฏูŠุซ ุงุณู… ู…ุนุฑู ุงู„ุดุจูƒุฉ.", + "description": "ุชุญุฏูŠุซ ุงุณู… ู…ุนุฑู ุดุจูƒุฉ ู…ุญุฏุฏ. **ู…ู„ุงุญุธุฉ:** ุชุฎุถุน ู…ูƒุงู„ู…ุฉ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ู‡ุฐู‡ ู„ู…ุฎุทุทุงุช ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุฑู†ุฉ. ุชุญุฏุฏ ุณูŠุงุณุฉ ุงู„ุชูˆุฌูŠู‡ ุงู„ุฎุงุตุฉ ุจูƒ ูƒูŠููŠุฉ ุชูˆุฌูŠู‡ ู…ุนุงู…ู„ุงุชูƒ. ูŠู…ูƒู†ูƒ ุงุฎุชูŠุงุฑ ุฃุญุฏ ุงู„ู…ุฎุทุทุงุช ุงู„ุซู„ุงุซุฉ ุงู„ู…ุฎุชู„ูุฉ ุงู„ู…ุฐูƒูˆุฑุฉ ุฃุฏู†ุงู‡ ู„ูƒู„ ู†ูˆุน ู…ู† ุฃู†ูˆุงุน ุงู„ุฃุตูˆู„: - **ู„ุง ุดูŠุก**ุ› ูŠุญุฏุฏ ุชูˆุฌูŠู‡ ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ ุฅู„ู‰ ูˆุฌู‡ุฉ ุบูŠุฑ ู…ูˆุฌูˆุฏุฉ ู„ู†ูˆุน ุงู„ุฃุตูˆู„ ู‡ุฐุง. ุณุชูุดู„ ุงู„ู…ุนุงู…ู„ุงุช ุงู„ูˆุงุฑุฏุฉ ุฅู„ู‰ ุฃู†ูˆุงุน ุงู„ุฃุตูˆู„ ุงู„ุชูŠ ุชู… ุชูˆุฌูŠู‡ู‡ุง ุฅู„ู‰ "ู„ุง ุดูŠุก". - **ู…ุฎุตุต**ุ› ุงู„ุชูˆุฌูŠู‡ ุฅู„ู‰ ุญุณุงุจ ุชุฎุชุงุฑู‡. ุฅุฐุง ู‚ู…ุช ุจุฅุฒุงู„ุฉ ุงู„ุญุณุงุจุŒ ูุณุชูุดู„ ุงู„ู…ุนุงู…ู„ุงุช ุงู„ูˆุงุฑุฏุฉ ุญุชู‰ ุชุฎุชุงุฑ ุญุณุงุจู‹ุง ุขุฎุฑ. - **ุงูุชุฑุงุถูŠ**ุ› ุงุณุชุฎุฏู… ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุญุฏุฏ ุจูˆุงุณุทุฉ ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ ุงู„ุฐูŠ ูŠุชุตู„ ุจู‡ ุงู„ุงุชุตุงู„. ูŠุดุงุฑ ุฅู„ู‰ ู‡ุฐุง ุงู„ู…ุฎุทุท ุฃูŠุถู‹ุง ุจุงุณู… "ุชูˆุฌูŠู‡ ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ" ุงู„ุฅุนุฏุงุฏุงุช ุงู„ู…ุณุจู‚ุฉ ู„ู…ุณุงุญุฉ ุงู„ุนู…ู„ ุงู„ุงูุชุฑุงุถูŠุฉ: - ุชุดููŠุฑ ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ โ†’ **ู…ุฎุตุต** - ู…ู„ู ุชุนุฑูŠู ุงู„ุดุจูƒุฉ FIAT โ†’ **ู„ุง ุดูŠุก** - ุชุดููŠุฑ ุงุชุตุงู„ ุงู„ุดุจูƒุฉ โ†’ **ุงูุชุฑุงุถูŠ** - ุงุชุตุงู„ ุงู„ุดุจูƒุฉ FIAT โ†’ **ุงูุชุฑุงุถูŠ** - **ู…ู„ุงุญุธุฉ**: ุจุดูƒู„ ุงูุชุฑุงุถูŠุŒ ูŠุณุชุฎุฏู… ู…ุฎุทุท ุงู„ุชูˆุฌูŠู‡ ุงู„ู…ุฎุตุต (`dstId` = `0`ุŒ `dstType` = `VAULT`).", + "tags": [ + "Network connections" + ], + "parameters": [ + { + "in": "path", + "name": "networkId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุดุจูƒุฉ", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "type": "string" + } + }, + "required": [ + "name" + ] + } + } + } + }, + "responses": { + "200": { + "description": "ู…ุนุฑู ุงู„ุดุจูƒุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "properties": { + "success": { + "type": "boolean" + } + }, + "required": [ + "success" + ] + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/internal_wallets": { + "get": { + "summary": "ู‚ุงุฆู…ุฉ ุงู„ู…ุญุงูุธ ุงู„ุฏุงุฎู„ูŠุฉ", + "tags": [ + "Internal wallets" + ], + "description": "ุงุญุตู„ ุนู„ู‰ ู‚ุงุฆู…ุฉ ุจุงู„ู…ุญุงูุธ ุงู„ุฏุงุฎู„ูŠุฉ. **ู…ู„ุงุญุธุฉ**: ู„ุง ูŠู…ูƒู† ุงุณุชุฑุฏุงุฏ ุงู„ุฃุตูˆู„ ุงู„ู‚ุงุฆู…ุฉ ุนู„ู‰ BTC ูˆุงู„ู…ู…ู„ูˆูƒุฉ ู„ุนู†ุงูˆูŠู† ู…ุฏุฑุฌุฉ ููŠ ุงู„ู‚ุงุฆู…ุฉ ุงู„ุจูŠุถุงุก ุจูŠู† ุงู„ุณุงุนุฉ 00:00 ูˆ00:01 ุจุงู„ุชูˆู‚ูŠุช ุงู„ุนุงู„ู…ูŠ ุงู„ู…ู†ุณู‚ ูŠูˆู…ูŠู‹ุง ุจุณุจุจ ุนุฏู… ุชูˆูุฑ ู…ุฒูˆุฏ ุงู„ุทุฑู ุงู„ุซุงู„ุซุŒ BlockchairุŒ ุฎู„ุงู„ ู‡ุฐู‡ ุงู„ูุชุฑุฉ ุงู„ุชูŠ ุชุจู„ุบ 60 ุซุงู†ูŠุฉ. ูŠูุฑุฌู‰ ุงู„ุงู†ุชุธุงุฑ ุญุชู‰ ุงู„ุฏู‚ูŠู‚ุฉ ุงู„ุชุงู„ูŠุฉ ู„ุงุณุชุฑุฏุงุฏ ุงู„ุฃุตูˆู„ ุงู„ู‚ุงุฆู…ุฉ ุนู„ู‰ BTC.", + "responses": { + "200": { + "description": "ู‚ุงุฆู…ุฉ ุงู„ู…ุญุงูุธ ุงู„ุฏุงุฎู„ูŠุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "ุฅู†ุดุงุก ู…ุญูุธุฉ ุฏุงุฎู„ูŠุฉ", + "tags": [ + "Internal wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "internalWallet = fireblocks.create_internal_wallet(name, customer_ref_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const internalWallet = await fireblocks.createInternalWallet(name, customerRefId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "description": "ุฅู†ุดุงุก ู…ุญูุธุฉ ุฏุงุฎู„ูŠุฉ ุฌุฏูŠุฏุฉ ุจุงู„ุงุณู… ุงู„ู…ุทู„ูˆุจ.", + "responses": { + "200": { + "description": "ูƒุงุฆู† ู…ุญูุธุฉ ุฌุฏูŠุฏ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "type": "string", + "description": "ุงุณู… ุนุฑุถ ุงู„ู…ุญูุธุฉ" + }, + "customerRefId": { + "description": "ุงุฎุชูŠุงุฑูŠ - ุชุนูŠูŠู† ู…ุนุฑู ู…ุฑุฌุน ุงู„ุนู…ูŠู„", + "type": "string" + } + } + } + } + } + } + } + }, + "/internal_wallets/{walletId}": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุงู„ุฃุตูˆู„ ู„ู„ู…ุญูุธุฉ ุงู„ุฏุงุฎู„ูŠุฉ", + "tags": [ + "Internal wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "internalWallet = fireblocks.get_internal_wallet(walletId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.getInternalWallet(walletId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "description": "ุฅุฑุฌุงุน ุฌู…ูŠุน ุงู„ุฃุตูˆู„ ุงู„ู…ูˆุฌูˆุฏุฉ ููŠ ุงู„ู…ุญูุธุฉ ุงู„ุฏุงุฎู„ูŠุฉ ุนู† ุทุฑูŠู‚ ุงู„ู…ุนุฑู.", + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "ู…ุนุฑู ุงู„ู…ุญูุธุฉ ุงู„ู…ุฑุงุฏ ุฅุฑุฌุงุนู‡ุง", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ูƒุงุฆู† ุงู„ู…ุญูุธุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "delete": { + "summary": "ุญุฐู ุงู„ู…ุญูุธุฉ ุงู„ุฏุงุฎู„ูŠุฉ", + "tags": [ + "Internal wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = firebocks.delete_internal_wallet(walletId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.deleteInternalWallet(walletId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "description": "ุญุฐู ุงู„ู…ุญูุธุฉ ุงู„ุฏุงุฎู„ูŠุฉ ุนู† ุทุฑูŠู‚ ุงู„ู…ุนุฑู.", + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "ู…ุนุฑู ุงู„ู…ุญูุธุฉ ุงู„ู…ุฑุงุฏ ุญุฐูู‡ุง", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "201": { + "description": "ู†ุนู…", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/internal_wallets/{walletId}/set_customer_ref_id": { + "post": { + "summary": "ุชุนูŠูŠู† ู…ุนุฑู ู…ุฑุฌุนูŠ ู„ุนู…ูŠู„ AML/KYT ู„ู…ุญูุธุฉ ุฏุงุฎู„ูŠุฉ", + "tags": [ + "Internal wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = firebocks.set_customer_ref_id_for_internal_wallet(wallet_id, customer_ref_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.setCustomerRefIdForInternalWallet(walletId, customerRefId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "description": "ุชุนูŠูŠู† ู…ุนุฑู ู…ุฑุฌุนูŠ ู„ุนู…ูŠู„ AML/KYT ู„ู„ู…ุญูุธุฉ ุงู„ุฏุงุฎู„ูŠุฉ ุงู„ู…ุญุฏุฏุฉ.", + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "ู…ุนุฑู ุงู„ู…ุญูุธุฉ", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "customerRefId": { + "description": "ู…ุนุฑู ู…ุฑุฌุน ุงู„ุนู…ูŠู„", + "type": "string" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "ู†ุนู…", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/internal_wallets/{walletId}/{assetId}": { + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ุฃุญุฏ ุงู„ุฃุตูˆู„ ู…ู† ู…ุญูุธุฉ ุฏุงุฎู„ูŠุฉ", + "tags": [ + "Internal wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "internalWalletAsset = fireblocks.get_internal_wallet_asset(walletId, assetId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const internalWalletAsset = fireblocks.getInternalWalletAsset(walletId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "description": "ุฅุฑุฌุงุน ุงู„ู…ุนู„ูˆู…ุงุช ุงู„ุฎุงุตุฉ ุจุงู„ุฃุตูˆู„ ุงู„ู…ูˆุฌูˆุฏุฉ ููŠ ุงู„ู…ุญูุธุฉ ุงู„ุฏุงุฎู„ูŠุฉ.", + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "ู…ุนุฑู ุงู„ู…ุญูุธุฉ", + "schema": { + "type": "string", + "minimum": 1 + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุฃุตู„ ุงู„ู…ุฑุงุฏ ุฅุฑุฌุงุนู‡", + "schema": { + "type": "string", + "minimum": 1, + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "ูƒุงุฆู† ุฃุตูˆู„ ุงู„ู…ุญูุธุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/WalletAsset" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "ุฅุถุงูุฉ ุฃุตู„ ุฅู„ู‰ ู…ุญูุธุฉ ุฏุงุฎู„ูŠุฉ", + "tags": [ + "Internal wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "internalWalletAsset = fireblocks.create_internal_wallet_asset(walletId, assetId, address, tag)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const internalWalletAsset = await fireblocks.createInternalWalletAsset(walletContainerId, assetId, address, tag);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "description": "ูŠุถูŠู ุฃุตู„ู‹ุง ุฅู„ู‰ ู…ุญูุธุฉ ุฏุงุฎู„ูŠุฉ ู…ูˆุฌูˆุฏุฉ.", + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "ู…ุนุฑู ุงู„ู…ุญูุธุฉ", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุฃุตู„ ุงู„ู…ุฑุงุฏ ุฅุถุงูุชู‡", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "ูƒุงุฆู† ุฃุตูˆู„ ุงู„ู…ุญูุธุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/WalletAsset" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "address": { + "type": "string", + "description": "ุนู†ูˆุงู† ุงู„ู…ุญูุธุฉ ุฃูˆุŒ ุจุงู„ู†ุณุจุฉ ู„ู…ุญุงูุธ EOSุŒ ุงุณู… ุงู„ุญุณุงุจ" + }, + "tag": { + "type": "string", + "description": "ุจุงู„ู†ุณุจุฉ ู„ู…ุญุงูุธ XRPุŒ ุนู„ุงู…ุฉ ุงู„ูˆุฌู‡ุฉุ› ุจุงู„ู†ุณุจุฉ ู„ู€ EOSุŒ ุงู„ู…ุฐูƒุฑุฉุ› ุจุงู„ู†ุณุจุฉ ู„ู…ู‚ุฏู…ูŠ ุงู„ุนู…ู„ุงุช ุงู„ูˆุฑู‚ูŠุฉ (BLINC ู…ู† BCB Group)ุŒ ูˆุตู ุงู„ุชุญูˆูŠู„ ุงู„ุจู†ูƒูŠ" + } + }, + "required": [ + "address" + ] + } + } + } + } + }, + "delete": { + "summary": "ุญุฐู ุนู†ูˆุงู† ู…ุฏุฑุฌ ููŠ ุงู„ู‚ุงุฆู…ุฉ ุงู„ุจูŠุถุงุก ู…ู† ู…ุญูุธุฉ ุฏุงุฎู„ูŠุฉ", + "tags": [ + "Internal wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = fireblocks.delete_internal_wallet_asset(walletId, assetId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.deleteInternalWalletAsset(walletId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "description": "ูŠุญุฐู ุนู†ูˆุงู†ู‹ุง ู…ุฏุฑุฌู‹ุง ููŠ ุงู„ู‚ุงุฆู…ุฉ ุงู„ุจูŠุถุงุก (ู„ู„ุฃุตู„) ู…ู† ู…ุญูุธุฉ ุฏุงุฎู„ูŠุฉ.", + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "ู…ุนุฑู ุงู„ู…ุญูุธุฉ", + "schema": { + "type": "string", + "minimum": 1 + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุฃุตู„ ุงู„ุฐูŠ ุณูŠุชู… ุญุฐูู‡", + "schema": { + "type": "string", + "minimum": 1, + "x-fb-entity": "asset" + } + } + ], + "responses": { + "201": { + "description": "ู†ุนู…", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/external_wallets": { + "get": { + "summary": "ู‚ุงุฆู…ุฉ ุงู„ู…ุญุงูุธ ุงู„ุฎุงุฑุฌูŠุฉ", + "description": "ูŠุญุตู„ ุนู„ู‰ ู‚ุงุฆู…ุฉ ุจุงู„ู…ุญุงูุธ ุงู„ุฎุงุฑุฌูŠุฉ ุถู…ู† ู…ุณุงุญุฉ ุงู„ุนู…ู„.", + "tags": [ + "External wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "externalWallets = fireblocks.get_external_wallets()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const externalWallets = await fireblocks.getExternalWallets();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "ู‚ุงุฆู…ุฉ ุงู„ู…ุญุงูุธ ุงู„ุฎุงุฑุฌูŠุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "ุฅู†ุดุงุก ู…ุญูุธุฉ ุฎุงุฑุฌูŠุฉ", + "description": "ุฅู†ุดุงุก ู…ุญูุธุฉ ุฎุงุฑุฌูŠุฉ ุฌุฏูŠุฏุฉ ุจุงู„ุงุณู… ุงู„ู…ุทู„ูˆุจ.", + "tags": [ + "External wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "externalWallet = fireblocks.create_external_wallet(name, customer_ref_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const externalWallet = await fireblocks.createExternalWallet(name, customerRefId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "ูƒุงุฆู† ุงู„ู…ุญูุธุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "type": "string", + "description": "ุงุณู… ุนุฑุถ ุงู„ู…ุญูุธุฉ" + }, + "customerRefId": { + "description": "ุงุฎุชูŠุงุฑูŠ - ุชุนูŠูŠู† ู…ุนุฑู ู…ุฑุฌุน ุงู„ุนู…ูŠู„", + "type": "string" + } + } + } + } + } + } + } + }, + "/external_wallets/{walletId}": { + "get": { + "summary": "ุงู„ุนุซูˆุฑ ุนู„ู‰ ู…ุญูุธุฉ ุฎุงุฑุฌูŠุฉ", + "description": "ุฅุฑุฌุงุน ู…ุญูุธุฉ ุฎุงุฑุฌูŠุฉ ุนู† ุทุฑูŠู‚ ุงู„ู…ุนุฑู.", + "tags": [ + "External wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "externalWallet = fireblocks.get_external_wallet(walletId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const externalWallet = await fireblocks.getExternalWallet(walletId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "ู…ุนุฑู ุงู„ู…ุญูุธุฉ ุงู„ู…ุฑุงุฏ ุฅุฑุฌุงุนู‡ุง", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ูƒุงุฆู† ุงู„ู…ุญูุธุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "delete": { + "summary": "ุญุฐู ู…ุญูุธุฉ ุฎุงุฑุฌูŠุฉ", + "description": "ุญุฐู ู…ุญูุธุฉ ุฎุงุฑุฌูŠุฉ ุนู† ุทุฑูŠู‚ ุงู„ู…ุนุฑู.", + "tags": [ + "External wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = firebocks.delete_external_wallet(walletId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.deleteExternalWallet(walletId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "ู…ุนุฑู ุงู„ู…ุญูุธุฉ ุงู„ู…ุฑุงุฏ ุญุฐูู‡ุง", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "201": { + "description": "ู†ุนู…", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/external_wallets/{walletId}/set_customer_ref_id": { + "post": { + "summary": "ุชุนูŠูŠู† ู…ุนุฑู ู…ุฑุฌุนูŠ ู„ุนู…ูŠู„ ู…ูƒุงูุญุฉ ุบุณู„ ุงู„ุฃู…ูˆุงู„ ู„ู…ุญูุธุฉ ุฎุงุฑุฌูŠุฉ", + "description": "ุชุนูŠูŠู† ู…ุนุฑู ู…ุฑุฌุนูŠ ู„ุนู…ูŠู„ AML/KYT ู„ู„ู…ุญูุธุฉ ุงู„ุฎุงุฑุฌูŠุฉ ุงู„ู…ุญุฏุฏุฉ.", + "tags": [ + "External wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = firebocks.set_customer_ref_id_for_external_wallet(wallet_id, customer_ref_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.setCustomerRefIdForExternalWallet(walletId, customerRefId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "ู…ุนุฑู ุงู„ู…ุญูุธุฉ", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "customerRefId": { + "description": "ู…ุนุฑู ู…ุฑุฌุน ุงู„ุนู…ูŠู„", + "type": "string" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "ู†ุนู…", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/external_wallets/{walletId}/{assetId}": { + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ุฃุญุฏ ุงู„ุฃุตูˆู„ ู…ู† ู…ุญูุธุฉ ุฎุงุฑุฌูŠุฉ", + "description": "ุฅุฑุฌุงุน ู…ุญูุธุฉ ุฎุงุฑุฌูŠุฉ ุญุณุจ ู…ุนุฑู ุงู„ู…ุญูุธุฉ ูˆู…ุนุฑู ุงู„ุฃุตูˆู„.", + "tags": [ + "External wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "externalWalletAsset = fireblocks.get_external_wallet_asset(walletId, assetId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const externalWalletAsset = fireblocks.getExternalWalletAsset(walletId, assetId)", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "ู…ุนุฑู ุงู„ู…ุญูุธุฉ", + "schema": { + "type": "string", + "minimum": 1 + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุฃุตู„ ุงู„ู…ุฑุงุฏ ุฅุฑุฌุงุนู‡", + "schema": { + "type": "string", + "minimum": 1, + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "ูƒุงุฆู† ุฃุตูˆู„ ุงู„ู…ุญูุธุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ExternalWalletAsset" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "ุฅุถุงูุฉ ุฃุตู„ ุฅู„ู‰ ู…ุญูุธุฉ ุฎุงุฑุฌูŠุฉ.", + "description": "ูŠุถูŠู ุฃุตู„ู‹ุง ุฅู„ู‰ ู…ุญูุธุฉ ุฎุงุฑุฌูŠุฉ ู…ูˆุฌูˆุฏุฉ.", + "tags": [ + "External wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "externalWalletAsset = fireblocks.create_external_wallet_asset(walletId, assetId, address, tag)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const externalWalletAsset = await fireblocks.createExternalWalletAsset(walletContainerId, assetId, address, tag);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "ู…ุนุฑู ุงู„ู…ุญูุธุฉ", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุฃุตู„ ุงู„ู…ุฑุงุฏ ุฅุถุงูุชู‡", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "ูƒุงุฆู† ุฃุตูˆู„ ุงู„ู…ุญูุธุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ExternalWalletAsset" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "properties": { + "address": { + "type": "string", + "description": "ุนู†ูˆุงู† ุงู„ู…ุญูุธุฉ (ุฃูˆ xpub) ู„ู„ู…ุญูุธุฉ" + }, + "tag": { + "type": "string", + "description": "ุจุงู„ู†ุณุจุฉ ู„ู…ุญุงูุธ XRPุŒ ุนู„ุงู…ุฉ ุงู„ูˆุฌู‡ุฉุ› ุจุงู„ู†ุณุจุฉ ู„ู…ุญุงูุธ EOS/XLMุŒ ุงู„ู…ุฐูƒุฑุฉุ› ุจุงู„ู†ุณุจุฉ ู„ู…ู‚ุฏู…ูŠ ุงู„ุนู…ู„ุงุช ุงู„ูˆุฑู‚ูŠุฉ (BLINC ู…ู† ู…ุฌู…ูˆุนุฉ BCB)ุŒ ูˆุตู ุงู„ุชุญูˆูŠู„ ุงู„ุจู†ูƒูŠ" + } + }, + "required": [ + "address" + ] + }, + { + "properties": { + "additionalInfo": { + "type": "object", + "oneOf": [ + { + "properties": { + "accountHolderGivenName": { + "type": "string" + }, + "accountHolderSurname": { + "type": "string" + }, + "accountHolderCity": { + "type": "string" + }, + "accountHolderCountry": { + "type": "string" + }, + "accountHolderAddress1": { + "type": "string" + }, + "accountHolderAddress2": { + "type": "string" + }, + "accountHolderDistrict": { + "type": "string" + }, + "accountHolderPostalCode": { + "type": "string" + }, + "iban": { + "type": "string" + }, + "ibanCity": { + "type": "string" + }, + "ibanCountry": { + "type": "string" + } + }, + "required": [ + "accountHolderGivenName", + "accountHolderCity", + "accountHolderCountry", + "accountHolderAddress1", + "accountHolderPostalCode", + "iban", + "ibanCity", + "ibanCountry" + ] + }, + { + "properties": { + "accountHolderGivenName": { + "type": "string" + }, + "accountHolderSurname": { + "type": "string" + }, + "accountHolderCity": { + "type": "string" + }, + "accountHolderCountry": { + "type": "string" + }, + "accountHolderAddress1": { + "type": "string" + }, + "accountHolderAddress2": { + "type": "string" + }, + "accountHolderDistrict": { + "type": "string" + }, + "accountHolderPostalCode": { + "type": "string" + }, + "abaRoutingNumber": { + "type": "string" + }, + "abaAccountNumber": { + "type": "string" + }, + "abaCountry": { + "type": "string" + } + }, + "required": [ + "accountHolderGivenName", + "accountHolderCity", + "accountHolderCountry", + "accountHolderAddress1", + "accountHolderPostalCode", + "abaRoutingNumber", + "abaAccountNumber", + "abaCountry" + ] + }, + { + "properties": { + "speiClabe": { + "type": "string" + }, + "speiName": { + "type": "string" + } + }, + "required": [ + "speiClabe" + ] + } + ] + } + }, + "required": [ + "additionalInfo" + ] + } + ] + } + } + } + } + }, + "delete": { + "summary": "ุญุฐู ุฃุญุฏ ุงู„ุฃุตูˆู„ ู…ู† ู…ุญูุธุฉ ุฎุงุฑุฌูŠุฉ", + "description": "ุญุฐู ุฃุญุฏ ุฃุตูˆู„ ุงู„ู…ุญูุธุฉ ุงู„ุฎุงุฑุฌูŠุฉ ุนู† ุทุฑูŠู‚ ุงู„ู…ุนุฑู.", + "tags": [ + "External wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = fireblocks.delete_external_wallet_asset(walletId, assetId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.deleteExternalWalletAsset(walletId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "ู…ุนุฑู ุงู„ู…ุญูุธุฉ", + "schema": { + "type": "string", + "minimum": 1 + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุฃุตู„ ุงู„ุฐูŠ ุณูŠุชู… ุญุฐูู‡", + "schema": { + "type": "string", + "minimum": 1, + "x-fb-entity": "asset" + } + } + ], + "responses": { + "201": { + "description": "ู†ุนู…", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/contracts": { + "get": { + "summary": "ู‚ุงุฆู…ุฉ ุงู„ุนู‚ูˆุฏ", + "description": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู‚ุงุฆู…ุฉ ุงู„ุนู‚ูˆุฏ.", + "tags": [ + "Contracts" + ], + "responses": { + "200": { + "description": "ู‚ุงุฆู…ุฉ ุงู„ุนู‚ูˆุฏ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "ุฅู†ุดุงุก ุนู‚ุฏ", + "description": "ุฅู†ุดุงุก ุนู‚ุฏ ุฌุฏูŠุฏ.", + "tags": [ + "Contracts" + ], + "responses": { + "200": { + "description": "ูƒุงุฆู† ุงู„ู…ุญูุธุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "type": "string", + "description": "ุงุณู… ุนุฑุถ ุงู„ุนู‚ุฏ" + } + } + } + } + } + } + } + }, + "/contracts/{contractId}": { + "get": { + "summary": "ุงู„ุจุญุซ ุนู† ุนู‚ุฏ ู…ุญุฏุฏ", + "description": "ุฅุฑุฌุงุน ุงู„ุนู‚ุฏ ุญุณุจ ุงู„ู…ุนุฑู.", + "tags": [ + "Contracts" + ], + "parameters": [ + { + "in": "path", + "name": "contractId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุนู‚ุฏ ุงู„ู…ุฑุงุฏ ุงุณุชุฑุฌุงุนู‡", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ูƒุงุฆู† ุงู„ู…ุญูุธุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "delete": { + "summary": "ุญุฐู ุงู„ุนู‚ุฏ", + "description": "ุญุฐู ุงู„ุนู‚ุฏ ุนู† ุทุฑูŠู‚ ุงู„ู…ุนุฑู.", + "tags": [ + "Contracts" + ], + "parameters": [ + { + "in": "path", + "name": "contractId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุนู‚ุฏ ุงู„ู…ุฑุงุฏ ุญุฐูู‡", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "201": { + "description": "ู†ุนู…", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/contracts/{contractId}/{assetId}": { + "get": { + "summary": "ุงู„ุนุซูˆุฑ ุนู„ู‰ ุฃุตู„ ุงู„ุนู‚ุฏ", + "description": "ุฅุฑุฌุงุน ุฃุตู„ ุงู„ุนู‚ุฏ ุญุณุจ ุงู„ู…ุนุฑู.", + "tags": [ + "Contracts" + ], + "parameters": [ + { + "in": "path", + "name": "contractId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุนู‚ุฏ", + "schema": { + "type": "string", + "minimum": 1 + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุฃุตู„ ุงู„ู…ุฑุงุฏ ุฅุฑุฌุงุนู‡", + "schema": { + "type": "string", + "minimum": 1, + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "ูƒุงุฆู† ุฃุตูˆู„ ุงู„ู…ุญูุธุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ExternalWalletAsset" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "ุฅุถุงูุฉ ุฃุตู„ ุฅู„ู‰ ุงู„ุนู‚ุฏ", + "description": "ุฅุถุงูุฉ ุฃุตู„ ุฅู„ู‰ ุนู‚ุฏ ู…ูˆุฌูˆุฏ.", + "tags": [ + "Contracts" + ], + "parameters": [ + { + "in": "path", + "name": "contractId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุนู‚ุฏ", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุฃุตู„ ุงู„ู…ุฑุงุฏ ุฅุถุงูุชู‡", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "ูƒุงุฆู† ุฃุตูˆู„ ุงู„ู…ุญูุธุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ExternalWalletAsset" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "address": { + "type": "string", + "description": "ุนู†ูˆุงู† ุงู„ุนู‚ุฏ (ุฃูˆ xpub) ู„ู„ู…ุญูุธุฉ" + }, + "tag": { + "type": "string", + "description": "ุนู„ุงู…ุฉ ุงู„ูˆุฌู‡ุฉ ู„ู…ุญุงูุธ XRP" + } + }, + "required": [ + "address" + ] + } + } + } + } + }, + "delete": { + "summary": "ุญุฐู ุฃุตู„ ุงู„ุนู‚ุฏ", + "description": "ุญุฐู ุฃุตู„ ุงู„ุนู‚ุฏ ุญุณุจ ุงู„ู…ุนุฑู.", + "tags": [ + "Contracts" + ], + "parameters": [ + { + "in": "path", + "name": "contractId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุนู‚ุฏ", + "schema": { + "type": "string", + "minimum": 1 + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "ู…ุนุฑู ุงู„ุฃุตู„ ุงู„ุฐูŠ ุณูŠุชู… ุญุฐูู‡", + "schema": { + "type": "string", + "minimum": 1, + "x-fb-entity": "asset" + } + } + ], + "responses": { + "201": { + "description": "ู†ุนู…", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/supported_assets": { + "get": { + "summary": "ู‚ุงุฆู…ุฉ ุจุฌู…ูŠุน ุฃู†ูˆุงุน ุงู„ุฃุตูˆู„ ุงู„ุชูŠ ูŠุฏุนู…ู‡ุง Fireblocks", + "description": "ุฅุฑุฌุงุน ุฌู…ูŠุน ุฃู†ูˆุงุน ุงู„ุฃุตูˆู„ ุงู„ุชูŠ ูŠุฏุนู…ู‡ุง Fireblocks.", + "tags": [ + "Blockchains & assets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "supportedAssets = fireblocks.get_supported_assets()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const supportedAssets = await fireblocks.getSupportedAssets();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "ูƒุงุฆู† ุงู„ู…ุนุงู…ู„ุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AssetTypeResponse" + } + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/estimate_network_fee": { + "get": { + "summary": "ุชู‚ุฏูŠุฑ ุงู„ุฑุณูˆู… ุงู„ู…ุทู„ูˆุจุฉ ู„ู„ุฃุตู„", + "description": "ูŠุญุตู„ ุนู„ู‰ ุงู„ุฑุณูˆู… ุงู„ู…ุทู„ูˆุจุฉ ุงู„ู…ู‚ุฏุฑุฉ ู„ู„ุฃุตู„. ุจุงู„ู†ุณุจุฉ ู„ู„ุฃุตูˆู„ ุงู„ู‚ุงุฆู…ุฉ ุนู„ู‰ UTXOุŒ ุณุชุญุชูˆูŠ ุงู„ุงุณุชุฌุงุจุฉ ุนู„ู‰ ุงู„ุฑุณูˆู… ุงู„ู…ู‚ุชุฑุญุฉ ู„ูƒู„ ุจุงูŠุชุŒ ูˆุจุงู„ู†ุณุจุฉ ู„ู„ุฃุตูˆู„ ุงู„ู‚ุงุฆู…ุฉ ุนู„ู‰ ETH/ETCุŒ ุณุนุฑ ุงู„ุบุงุฒ ุงู„ู…ู‚ุชุฑุญุŒ ูˆุจุงู„ู†ุณุจุฉ ู„ู€ XRP/XLMุŒ ุฑุณูˆู… ุงู„ู…ุนุงู…ู„ุฉ.", + "tags": [ + "Blockchains & assets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "fee_result = fireblocks.get_fee_for_asset(asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const feeResult = await fireblocks.getFeeForAsset(assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "query", + "name": "assetId", + "description": "ุงู„ุฃุตูˆู„ ุงู„ุชูŠ ุณูŠุชู… ุชู‚ุฏูŠุฑ ุงู„ุฑุณูˆู… ู„ู‡ุง", + "required": true, + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "ุชู‚ุฏูŠุฑ ุฑุณูˆู… ุงู„ุงุณุชุฌุงุจุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/EstimatedNetworkFeeResponse" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/transactions/validate_address/{assetId}/{address}": { + "get": { + "summary": "ุงู„ุชุญู‚ู‚ ู…ู† ุตุญุฉ ุนู†ูˆุงู† ุงู„ูˆุฌู‡ุฉ", + "description": "ุงู„ุชุญู‚ู‚ ู…ู† ุตุญุฉ ุงู„ุนู†ูˆุงู† (ุจุงู„ู†ุณุจุฉ ุฅู„ู‰ XRP ูˆDOT ูˆXLM ูˆEOS).", + "tags": [ + "Blockchains & assets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "const result = await fireblocks.validate_address(assetID, address)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.validateAddress(assetID, address)", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "assetId", + "required": true, + "description": "ุฃุตู„ ุงู„ุนู†ูˆุงู†", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + }, + { + "in": "path", + "name": "address", + "required": true, + "description": "ุงู„ุนู†ูˆุงู† ู„ู„ุชุญู‚ู‚", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "ูƒุงุฆู† ุงู„ู…ุนุงู…ู„ุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ValidateAddressResponse" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/transactions": { + "get": { + "summary": "ู‚ุงุฆู…ุฉ ุชุงุฑูŠุฎ ุงู„ู…ุนุงู…ู„ุงุช", + "description": "ูŠุณุฑุฏ ุณุฌู„ ุงู„ู…ุนุงู…ู„ุงุช ู„ู…ุณุงุญุฉ ุงู„ุนู…ู„ ุงู„ุฎุงุตุฉ ุจูƒ.", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "transactions = fireblocks.get_transactions(status, after)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const transactions = await fireblocks.getTransactions({\n status: args.status,\nafter: from });\n", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "query", + "name": "before", + "description": "ุทุงุจุน ุฒู…ู†ูŠ ูŠูˆู†ูƒุณ ุจุงู„ู…ู„ู„ูŠ ุซุงู†ูŠุฉ. ูŠุนูŠุฏ ูู‚ุท ุงู„ู…ุนุงู…ู„ุงุช ุงู„ุชูŠ ุชู… ุฅู†ุดุงุคู‡ุง ู‚ุจู„ ุงู„ุชุงุฑูŠุฎ ุงู„ู…ุญุฏุฏ", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "after", + "description": "ุทุงุจุน ุฒู…ู†ูŠ ูŠูˆู†ูƒุณ ุจุงู„ู…ู„ู„ูŠ ุซุงู†ูŠุฉ. ูŠุนูŠุฏ ูู‚ุท ุงู„ู…ุนุงู…ู„ุงุช ุงู„ุชูŠ ุชู… ุฅู†ุดุงุคู‡ุง ุจุนุฏ ุงู„ุชุงุฑูŠุฎ ุงู„ู…ุญุฏุฏ", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "status", + "description": "ูŠู…ูƒู†ูƒ ุงู„ุชุตููŠุฉ ุญุณุจ ุฅุญุฏู‰ ุงู„ุญุงู„ุงุช.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "orderBy", + "description": "ุงู„ุญู‚ู„ ุงู„ุฐูŠ ูŠุชู… ุชุฑุชูŠุจ ุงู„ู†ุชุงุฆุฌ ุจู‡ **ู…ู„ุงุญุธุฉ**: ู‚ุฏ ูŠุคุฏูŠ ุงู„ุชุฑุชูŠุจ ุญุณุจ ุงู„ุญู‚ู„ ุงู„ุฐูŠ ู„ู… ูŠุชู… ุฅู†ุดุงุคู‡ ููŠ ุฅู„ู‰ ู…ุนุงู…ู„ุงุช ุชุชู„ู‚ู‰ ุชุญุฏูŠุซุงุช ุนู†ุฏ ุทู„ุจ ุงู„ุตูุญุงุช ุงู„ุชุงู„ูŠุฉ ุฃูˆ ุงู„ุณุงุจู‚ุฉ ู…ู† ุงู„ู†ุชุงุฆุฌุŒ ู…ู…ุง ูŠุคุฏูŠ ุฅู„ู‰ ูู‚ุฏุงู† ู‡ุฐู‡ ุงู„ู…ุนุงู…ู„ุงุช.", + "required": false, + "schema": { + "oneOf": [ + { + "const": "createdAt" + }, + { + "const": "lastUpdated" + } + ] + } + }, + { + "in": "query", + "name": "sort", + "description": "ุงู„ุงุชุฌุงู‡ ู„ุชุฑุชูŠุจ ุงู„ู†ุชุงุฆุฌ ุญุณุจ", + "required": false, + "schema": { + "oneOf": [ + { + "const": "ASC" + }, + { + "const": "DESC" + } + ] + } + }, + { + "in": "query", + "name": "limit", + "description": "ูŠุญุฏุฏ ุนุฏุฏ ุงู„ู†ุชุงุฆุฌ. ุฅุฐุง ู„ู… ูŠุชู… ุชุญุฏูŠุฏ ุฐู„ูƒุŒ ูุณูŠุชู… ุงุณุชุฎุฏุงู… ุญุฏ 200. ุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ ุงู„ู…ุณู…ูˆุญ ุจู‡ ู‡ูˆ 500", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "default": 200 + } + }, + { + "in": "query", + "name": "sourceType", + "description": "ู†ูˆุน ู…ุตุฏุฑ ุงู„ู…ุนุงู…ู„ุฉ", + "required": false, + "schema": { + "oneOf": [ + { + "const": "VAULT_ACCOUNT" + }, + { + "const": "EXCHANGE_ACCOUNT" + }, + { + "const": "INTERNAL_WALLET" + }, + { + "const": "EXTERNAL_WALLET" + }, + { + "const": "FIAT_ACCOUNT" + }, + { + "const": "NETWORK_CONNECTION" + }, + { + "const": "COMPOUND" + }, + { + "const": "UNKNOWN" + }, + { + "const": "GAS_STATION" + }, + { + "const": "END_USER_WALLET" + } + ] + } + }, + { + "in": "query", + "name": "sourceId", + "description": "ู…ุนุฑู ู…ุตุฏุฑ ุงู„ู…ุนุงู…ู„ุฉ", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "destType", + "description": "ู†ูˆุน ูˆุฌู‡ุฉ ุงู„ู…ุนุงู…ู„ุฉ", + "required": false, + "schema": { + "oneOf": [ + { + "const": "VAULT_ACCOUNT" + }, + { + "const": "EXCHANGE_ACCOUNT" + }, + { + "const": "INTERNAL_WALLET" + }, + { + "const": "EXTERNAL_WALLET" + }, + { + "const": "FIAT_ACCOUNT" + }, + { + "const": "NETWORK_CONNECTION" + }, + { + "const": "COMPOUND" + }, + { + "const": "ONE_TIME_ADDRESS" + }, + { + "const": "END_USER_WALLET" + } + ] + } + }, + { + "in": "query", + "name": "destId", + "description": "ู…ุนุฑู ุงู„ูˆุฌู‡ุฉ ู„ู„ู…ุนุงู…ู„ุฉ", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "assets", + "description": "ู‚ุงุฆู…ุฉ ุงู„ุฃุตูˆู„ ุงู„ู…ุฑุงุฏ ุชุตููŠุชู‡ุงุŒ ู…ูุตูˆู„ุฉ ุจููˆุงุตู„", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "txHash", + "description": "ูŠุนูŠุฏ ูู‚ุท ุงู„ู†ุชุงุฆุฌ ุงู„ุชูŠ ุชุญุชูˆูŠ ุนู„ู‰ txHash ู…ุญุฏุฏ", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "sourceWalletId", + "description": "ูŠุนูŠุฏ ูู‚ุท ุงู„ู†ุชุงุฆุฌ ุญูŠุซ ูŠูƒูˆู† ุงู„ู…ุตุฏุฑ ุนุจุงุฑุฉ ุนู† ู…ุญูุธุฉ ู…ุณุชุฎุฏู… ู†ู‡ุงุฆูŠ ู…ุญุฏุฏุฉ", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "destWalletId", + "description": "ูŠุนูŠุฏ ูู‚ุท ุงู„ู†ุชุงุฆุฌ ุญูŠุซ ุชูƒูˆู† ุงู„ูˆุฌู‡ุฉ ุนุจุงุฑุฉ ุนู† ู…ุญูุธุฉ ู…ุณุชุฎุฏู… ู†ู‡ุงุฆูŠ ู…ุญุฏุฏุฉ", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "ู‚ุงุฆู…ุฉ ุงู„ู…ุนุงู…ู„ุงุช", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + }, + "next-page": { + "schema": { + "type": "string" + }, + "description": "ุนู†ูˆุงู† URL ูŠู…ุซู„ ุทู„ุจู‹ุง ุฌุฏูŠุฏู‹ุง ุฅู„ู‰ ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ู‡ุฐู‡ ู„ุชู„ู‚ูŠ ุงู„ุตูุญุฉ ุงู„ุชุงู„ูŠุฉ ู…ู† ุงู„ู†ุชุงุฆุฌ.", + "in": "header" + }, + "prev-page": { + "schema": { + "type": "string" + }, + "description": "ุนู†ูˆุงู† URL ูŠู…ุซู„ ุทู„ุจู‹ุง ุฌุฏูŠุฏู‹ุง ุฅู„ู‰ ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ู‡ุฐู‡ ู„ุชู„ู‚ูŠ ุงู„ุตูุญุฉ ุงู„ุณุงุจู‚ุฉ ู…ู† ุงู„ู†ุชุงุฆุฌ.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TransactionResponse" + } + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "ุฅู†ุดุงุก ู…ุนุงู…ู„ุฉ ุฌุฏูŠุฏุฉ", + "description": "ุฅู†ุดุงุก ู…ุนุงู…ู„ุฉ ุฌุฏูŠุฏุฉ.", + "tags": [ + "Transactions" + ], + "parameters": [ + { + "in": "header", + "name": "X-End-User-Wallet-Id", + "schema": { + "$ref": "#/components/headers/X-End-User-Wallet-Id" + } + } + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "tx_result = client.create_transaction( asset_id=\"BTC\", amount=\"50\", source=TransferPeerPath(VAULT_ACCOUNT, from_vault_account_id), destination=DestinationTransferPeerPath(VAULT_ACCOUNT, to_vault_account_id) )\n", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const payload: TransactionArguments = { assetId: asset, source: { type: sourceType, id: sourceId || 0 }, destination: { type: destinationType, id: String(destinationId) }, amount: String(amount), fee: String(fee), note: \"Created by fireblocks SDK\" }; const result = await fireblocks.createTransaction(payload);\n", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "ูƒุงุฆู† ุงู„ู…ุนุงู…ู„ุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateTransactionResponse" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TransactionRequest" + } + } + } + } + } + }, + "/transactions/estimate_fee": { + "post": { + "summary": "ุชู‚ุฏูŠุฑ ุฑุณูˆู… ุงู„ู…ุนุงู…ู„ุฉ", + "description": "ูŠู‚ูˆู… ุจุชู‚ุฏูŠุฑ ุฑุณูˆู… ุงู„ู…ุนุงู…ู„ุฉ ู„ุทู„ุจ ุงู„ู…ุนุงู…ู„ุฉ. * ู…ู„ุงุญุธุฉ: ูŠุฏุนู… ุฌู…ูŠุน ุฃุตูˆู„ Fireblocks ุจุงุณุชุซู†ุงุก ZCash (ZEC).", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "estimated_fee = client.estimate_fee_for_transaction( asset_id=\"BTC\", amount=\"50\", source=TransferPeerPath(VAULT_ACCOUNT, from_vault_account_id), destination=DestinationTransferPeerPath(VAULT_ACCOUNT, to_vault_account_id) )\n", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const payload: TransactionArguments = { assetId: asset, source: { type: sourceType, id: sourceId || 0 }, destination: { type: destinationType, id: String(destinationId) }, amount: Number(amount) }; const estimatedFee = await fireblocks.estimateFeeForTransaction(payload);\n", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TransactionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "ุชู‚ุฏูŠุฑ ุฑุณูˆู… ุงู„ุงุณุชุฌุงุจุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/EstimatedTransactionFeeResponse" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/transactions/{txId}": { + "get": { + "summary": "ุงุจุญุซ ุนู† ู…ุนุงู…ู„ุฉ ู…ุญุฏุฏุฉ ู…ู† ุฎู„ุงู„ ู…ุนุฑู ู…ุนุงู…ู„ุฉ Fireblocks", + "description": "ุฅุฑุฌุงุน ุงู„ู…ุนุงู…ู„ุฉ ุญุณุจ ุงู„ู…ุนุฑู.", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "tx = fireblocks.get_transaction_by_id(txId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const tx = await fireblocks.getTransactionById(txId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "txId", + "required": true, + "example": "00000000-0000-0000-0000-000000000000", + "description": "ู…ุนุฑู ุงู„ู…ุนุงู…ู„ุฉ ุงู„ู…ุฑุงุฏ ุฅุฑุฌุงุนู‡ุง", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ูƒุงุฆู† ุงู„ู…ุนุงู…ู„ุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/TransactionResponse" + } + } + } + }, + "400": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/transactions/external_tx_id/{externalTxId}/": { + "get": { + "summary": "ุงู„ุจุญุซ ุนู† ู…ุนุงู…ู„ุฉ ู…ุญุฏุฏุฉ ู…ู† ุฎู„ุงู„ ู…ุนุฑู ุงู„ู…ุนุงู…ู„ุฉ ุงู„ุฎุงุฑุฌูŠุฉ", + "description": "ุฅุฑุฌุงุน ุงู„ู…ุนุงู…ู„ุฉ ุญุณุจ ู…ุนุฑู ุงู„ู…ุนุงู…ู„ุฉ ุงู„ุฎุงุฑุฌูŠุฉ.", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "tx = fireblocks.get_transaction_by_external_tx_id(externalTxId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const tx = await fireblocks.getTransactionByExternalTxId(externalTxId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "externalTxId", + "example": "00000000-0000-0000-0000-000000000000", + "required": true, + "description": "ุงู„ู…ุนุฑู ุงู„ุฎุงุฑุฌูŠ ู„ู„ู…ุนุงู…ู„ุฉ ุงู„ู…ุฑุงุฏ ุฅุฑุฌุงุนู‡ุง", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ูƒุงุฆู† ุงู„ู…ุนุงู…ู„ุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/TransactionResponse" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/transactions/{txId}/set_confirmation_threshold": { + "post": { + "summary": "ุชุนูŠูŠู† ุญุฏ ุงู„ุชุฃูƒูŠุฏ ุญุณุจ ู…ุนุฑู ุงู„ู…ุนุงู…ู„ุฉ", + "description": "ูŠุชุฌุงูˆุฒ ุงู„ุนุฏุฏ ุงู„ู…ุทู„ูˆุจ ู…ู† ุงู„ุชุฃูƒูŠุฏุงุช ู„ุฅุชู…ุงู… ุงู„ู…ุนุงู…ู„ุฉ ุนู† ุทุฑูŠู‚ ู…ุนุฑู ุงู„ู…ุนุงู…ู„ุฉ.", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "set_conf_threshold = client.set_confirmation_threshold_by_tx_id(body)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const setConfThreshold = await fireblocks.setConfirmationThresholdByTxId(body);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SetConfirmationsThresholdRequest" + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "txId", + "required": true, + "description": "ู…ุนุฑู ุงู„ู…ุนุงู…ู„ุฉ", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ุชู… ุงู„ุถุจุท ุจู†ุฌุงุญ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SetConfirmationsThresholdResponse" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/transactions/{txId}/drop": { + "post": { + "summary": "ุฅุณู‚ุงุท ู…ุนุงู…ู„ุฉ ETH ุญุณุจ ุงู„ู…ุนุฑู", + "description": "ูŠุณู‚ุท ู…ุนุงู…ู„ุฉ ETH ุงู„ุนุงู„ู‚ุฉ ูˆูŠู†ุดุฆ ู…ุนุงู…ู„ุฉ ุจุฏูŠู„ุฉ.", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = fireblocks.drop_transaction(txId, fee_level)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.dropTransaction(txId, feeLevel);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DropTransactionRequest" + } + } + } + }, + "parameters": [ + { + "in": "header", + "name": "X-End-User-Wallet-Id", + "schema": { + "$ref": "#/components/headers/X-End-User-Wallet-Id" + } + }, + { + "in": "path", + "name": "txId", + "required": true, + "description": "ู…ุนุฑู ุงู„ู…ุนุงู…ู„ุฉ", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ุชู… ุงู„ุฅู†ุดุงุก ุจู†ุฌุงุญ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/DropTransactionResponse" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/transactions/{txId}/cancel": { + "post": { + "summary": "ุฅู„ุบุงุก ู…ุนุงู…ู„ุฉ", + "description": "ุฅู„ุบุงุก ู…ุนุงู…ู„ุฉ ุนู† ุทุฑูŠู‚ ุงู„ู…ุนุฑู.", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = fireblocks.cancel_transaction_by_id(txId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.cancelTransactionById(txId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "header", + "name": "X-End-User-Wallet-Id", + "schema": { + "$ref": "#/components/headers/X-End-User-Wallet-Id" + } + }, + { + "in": "path", + "name": "txId", + "required": true, + "description": "ู…ุนุฑู ุงู„ู…ุนุงู…ู„ุฉ ุงู„ู…ุฑุงุฏ ุฅู„ุบุงุคู‡ุง", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ูƒุงุฆู† ุงู„ู…ุนุงู…ู„ุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CancelTransactionResponse" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/transactions/{txId}/freeze": { + "post": { + "summary": "ุชุฌู…ูŠุฏ ุงู„ู…ุนุงู…ู„ุฉ", + "description": "ุชุฌู…ูŠุฏ ุงู„ู…ุนุงู…ู„ุฉ ุนู† ุทุฑูŠู‚ ุงู„ู…ุนุฑู.", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = fireblocks.freeze_transaction(txId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.freezeTransaction(txId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "header", + "name": "X-End-User-Wallet-Id", + "schema": { + "$ref": "#/components/headers/X-End-User-Wallet-Id" + } + }, + { + "in": "path", + "name": "txId", + "required": true, + "description": "ู…ุนุฑู ุงู„ู…ุนุงู…ู„ุฉ ุงู„ู…ุฑุงุฏ ุชุฌู…ูŠุฏู‡ุง", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุชุฌู…ูŠุฏ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/FreezeTransactionResponse" + } + } + } + } + } + } + }, + "/transactions/{txId}/unfreeze": { + "post": { + "summary": "ุฅู„ุบุงุก ุชุฌู…ูŠุฏ ุงู„ู…ุนุงู…ู„ุฉ", + "description": "ูŠู‚ูˆู… ุจุฅู„ุบุงุก ุชุฌู…ูŠุฏ ุงู„ู…ุนุงู…ู„ุฉ ุนู† ุทุฑูŠู‚ ุงู„ู…ุนุฑู ูˆูŠุฌุนู„ ุงู„ู…ุนุงู…ู„ุฉ ู…ุชุงุญุฉ ู…ุฑุฉ ุฃุฎุฑู‰.", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = fireblocks.unfreeze_transaction(txId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.unfreezeTransaction(txId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "header", + "name": "X-End-User-Wallet-Id", + "schema": { + "$ref": "#/components/headers/X-End-User-Wallet-Id" + } + }, + { + "in": "path", + "name": "txId", + "required": true, + "description": "ู…ุนุฑู ุงู„ู…ุนุงู…ู„ุฉ ุงู„ู…ุฑุงุฏ ููƒ ุชุฌู…ูŠุฏู‡ุง", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ุงุณุชุฌุงุจุฉ ุฅู„ุบุงุก ุงู„ุชุฌู…ูŠุฏ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/UnfreezeTransactionResponse" + } + } + } + } + } + } + }, + "/txHash/{txHash}/set_confirmation_threshold": { + "post": { + "summary": "ุชุนูŠูŠู† ุนุชุจุฉ ุงู„ุชุฃูƒูŠุฏ ุญุณุจ ุชุฌุฒุฆุฉ ุงู„ู…ุนุงู…ู„ุฉ", + "description": "ูŠุชุฌุงูˆุฒ ุงู„ุนุฏุฏ ุงู„ู…ุทู„ูˆุจ ู…ู† ุงู„ุชุฃูƒูŠุฏุงุช ู„ุฅูƒู…ุงู„ ุงู„ู…ุนุงู…ู„ุฉ ุนู† ุทุฑูŠู‚ ุชุฌุฒุฆุฉ ุงู„ู…ุนุงู…ู„ุฉ.", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "set_conf_threshold = client.set_confirmation_threshold_by_tx_hash(body)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const setConfThreshold = await fireblocks.setConfirmationThresholdByTxHash(body);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SetConfirmationsThresholdRequest" + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "txHash", + "required": true, + "description": "ุฐุง ุชูƒุณุงุณ ู‡ุงุด", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ู‚ุงุฆู…ุฉ ุงู„ู…ุนุงู…ู„ุงุช ุงู„ู…ุชุฃุซุฑุฉ ุจุงู„ุชุบูŠูŠุฑ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SetConfirmationsThresholdResponse" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/payments/xb-settlements/configs": { + "post": { + "tags": [ + "Payments - cross-border settlement" + ], + "summary": "ุฅู†ุดุงุก ุชูƒูˆูŠู† ุชุณูˆูŠุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ ุฌุฏูŠุฏ", + "description": "ุฅู†ุดุงุก ุชูƒูˆูŠู† ุชุณูˆูŠุฉ ุฌุฏูŠุฏุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ.
ุชุนุฑู ุงู„ุชูƒูˆูŠู†ุงุช ุงู„ุฃุตูˆู„ ุงู„ุงูุชุฑุงุถูŠุฉุŒ ูˆู…ู…ุฑุงุช ุงู„ุฏุฎูˆู„ ูˆุงู„ุฎุฑูˆุฌุŒ ุงู„ุชูŠ ุณูŠุชู… ุงุณุชุฎุฏุงู…ู‡ุง ู„ุชุณูˆูŠุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ.
ูŠุฌุจ ุฃู† ูŠุญุชูˆูŠ ุงู„ุชูƒูˆูŠู† ุนู„ู‰ ุฎุทูˆุชูŠู† ุนู„ู‰ ุงู„ุฃู‚ู„ - `ON_RAMP` ูˆ`VAULT_ACCOUNT`.
ุฌู…ูŠุน ุงู„ุฎุทูˆุงุช ุงู„ุฃุฎุฑู‰ (ุนู„ู‰ ุณุจูŠู„ ุงู„ู…ุซุงู„ุŒ `OFF_RAMP`ุŒ `FIAT_DESTINATION`ุŒ ูˆู…ุง ุฅู„ู‰ ุฐู„ูƒ) ุงุฎุชูŠุงุฑูŠุฉ.
ูŠุฌุจ ุฃู† ุชุชุถู…ู† ูƒู„ ุฎุทูˆุฉ "accountId" ุงู„ู…ุฑุงุฏ ุงุณุชุฎุฏุงู…ู‡ุŒ ุจูŠู†ู…ุง "inputAssetId" ูˆ"outputAssetId" ุงุฎุชูŠุงุฑูŠุงู†. ุฅุฐุง ู„ู… ูŠุชู… ุชูˆููŠุฑู‡ู…ุงุŒ ูุณูŠุชู… ุงุณุชุฎุฏุงู… ู‚ูŠู…ุฉ ุงูุชุฑุงุถูŠุฉ ู…ู† ุฅุนุฏุงุฏุงุช ุงู„ู…ู…ุฑ.
ุฅุฐุง ุชู… ุชูˆููŠุฑ inputAssetId ุฃูˆ outputAssetId ู„ุฃุญุฏ ุงู„ูƒุงุฆู†ุงุชุŒ ููŠุฌุจ ุฃู† ุชูƒูˆู† ุฌู…ูŠุน ุงู„ุฃุตูˆู„ ููŠ ุงู„ูƒุงุฆู†ุงุช ู…ุชุณู‚ุฉ. ุนู„ู‰ ุณุจูŠู„ ุงู„ู…ุซุงู„ุŒ ุฅุฐุง ูƒุงู† ุฃุตู„ ุงู„ุฅุฎุฑุงุฌ ู„ู€ ON_RAMP ู‡ูˆ XLM_USDC_5F3TุŒ ููŠุฌุจ ุฃู† ูŠูƒูˆู† ุฃุตู„ ุงู„ุฅุฏุฎุงู„ ู„ู€ VAULT_ACCOUNT ุฃูŠุถู‹ุง XLM_USDC_5F3T..
ูŠู…ูƒู†ูƒ ุชุนูŠูŠู† ู…ุจู„ุบ ุงู†ุฒู„ุงู‚ ู„ุชูƒูˆูŠู†ูƒ. ูŠุชู… ุชุญุฏูŠุฏ ุงู„ุงู†ุฒู„ุงู‚ ุจู†ู‚ุงุท ุงู„ุฃุณุงุณ (bps). ูŠู…ูƒู† ุชุญู…ูŠู„ ู‡ุฐู‡ ุงู„ู‚ูŠู…ุฉ ุจุดูƒู„ ุฒุงุฆุฏ ุนู†ุฏ ุงู„ุชู†ููŠุฐ. ุฅุฐุง ู„ู… ุชู‚ู… ุจุชูƒูˆูŠู† ู…ุจู„ุบ ุงู†ุฒู„ุงู‚ุŒ ูุณูŠุชู… ุงุณุชุฎุฏุงู… ุงู„ุงู†ุฒู„ุงู‚ ุงู„ุงูุชุฑุงุถูŠ ุงู„ุจุงู„ุบ 10000 bps (10%).
**ู…ู„ุงุญุธุฉ:** ูŠูˆุซู‚ ู…ุญุชูˆู‰ ุงู„ู…ุฑุฌุน ููŠ ู‡ุฐุง ุงู„ู‚ุณู… ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ Payments Engine. ุชุชุถู…ู† ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ Payments Engine ูˆุงุฌู‡ุงุช ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ุงู„ู…ุชุงุญุฉ ูู‚ุท ู„ู„ุนู…ู„ุงุก ุงู„ุฐูŠู† ุชู… ุชู…ูƒูŠู† Payments Engine ุนู„ู‰ ุญุณุงุจุงุชู‡ู…. ู‡ุฐู‡ ุงู„ู†ู‚ุงุท ุงู„ู†ู‡ุงุฆูŠุฉ ููŠ ู…ุฑุญู„ุฉ ุชุฌุฑูŠุจูŠุฉ ุญุงู„ูŠู‹ุง ูˆู‚ุฏ ุชูƒูˆู† ุนุฑุถุฉ ู„ู„ุชุบูŠูŠุฑุงุช. ุฅุฐุง ูƒู†ุช ุชุฑูŠุฏ ู…ุนุฑูุฉ ุงู„ู…ุฒูŠุฏ ุนู† Fireblocks Payments EngineุŒ ููŠุฑุฌู‰ ุงู„ุงุชุตุงู„ ุจู…ุฏูŠุฑ ู†ุฌุงุญ ุงู„ุนู…ู„ุงุก ููŠ Fireblocks ุฃูˆ ุฅุฑุณุงู„ ุจุฑูŠุฏ ุฅู„ูƒุชุฑูˆู†ูŠ ุฅู„ู‰ CSM@fireblocks.com.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementConfigCreationRequestBody" + }, + "example": { + "name": "Flow Config Example", + "corridorId": "CO_US", + "steps": { + "ON_RAMP": { + "accountId": "3b7a1451-3453-4c96-a6a5-683cc8971d04" + }, + "VAULT_ACCOUNT": { + "accountId": "2" + }, + "OFF_RAMP": { + "accountId": "f2f74204-93ec-4614-870a-4ea2ad13aa0b" + } + }, + "conversionSlippageBasisPoints": 75 + } + } + } + }, + "responses": { + "200": { + "description": "ุชู… ุฅู†ุดุงุก ุชูƒูˆูŠู† ุงู„ุชุณูˆูŠุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ ุจู†ุฌุงุญ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementConfigCreationResponse" + }, + "example": { + "configId": "074791cc-ef32-4920-8373-95efbeea66c5", + "corridorId": "CO_US", + "name": "Flow Config Example", + "steps": { + "ON_RAMP": { + "accountId": "3b7a1451-3453-4c96-a6a5-683cc8971d04", + "inputAssetId": "COP", + "outputAssetId": "USD" + }, + "VAULT_ACCOUNT": { + "accountId": "2", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + }, + "OFF_RAMP": { + "accountId": "f2f74204-93ec-4614-870a-4ea2ad13aa0b", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + } + }, + "conversionSlippageBasisPoints": 75, + "createdAt": 1680625226267 + } + } + } + }, + "400": { + "description": "ุฎุทุฃ ููŠ ุฅู†ุดุงุก ุทู„ุจ ุนุจุฑ ุงู„ุญุฏูˆุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "ุบูŠุฑ ู…ุตุฑุญ ุจู‡. ุฑู…ุฒ JWT ู…ูู‚ูˆุฏ/ุบูŠุฑ ุตุงู„ุญ ููŠ ุฑุฃุณ ุงู„ุชููˆูŠุถ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "ุฎุทุฃ ุฏุงุฎู„ูŠ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "get": { + "tags": [ + "Payments - cross-border settlement" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "summary": "ุงุญุตู„ ุนู„ู‰ ุฌู…ูŠุน ุชูƒูˆูŠู†ุงุช ุงู„ุชุณูˆูŠุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ", + "description": "ุงุญุตู„ ุนู„ู‰ ุฌู…ูŠุน ุชูƒูˆูŠู†ุงุช ุงู„ุชุณูˆูŠุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ.
**ู…ู„ุงุญุธุฉ:** ูŠูˆุซู‚ ู…ุญุชูˆู‰ ุงู„ู…ุฑุฌุน ููŠ ู‡ุฐุง ุงู„ู‚ุณู… ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ Payments Engine. ุชุชุถู…ู† ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ Payments Engine ูˆุงุฌู‡ุงุช ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ุงู„ู…ุชุงุญุฉ ูู‚ุท ู„ู„ุนู…ู„ุงุก ุงู„ุฐูŠู† ุชู… ุชู…ูƒูŠู† Payments Engine ุนู„ู‰ ุญุณุงุจุงุชู‡ู…. ู‡ุฐู‡ ุงู„ู†ู‚ุงุท ุงู„ู†ู‡ุงุฆูŠุฉ ููŠ ู…ุฑุญู„ุฉ ุชุฌุฑูŠุจูŠุฉ ุญุงู„ูŠู‹ุง ูˆู‚ุฏ ุชูƒูˆู† ุนุฑุถุฉ ู„ู„ุชุบูŠูŠุฑุงุช. ุฅุฐุง ูƒู†ุช ุชุฑูŠุฏ ู…ุนุฑูุฉ ุงู„ู…ุฒูŠุฏ ุนู† Fireblocks Payments EngineุŒ ููŠุฑุฌู‰ ุงู„ุงุชุตุงู„ ุจู…ุฏูŠุฑ ู†ุฌุงุญ ุงู„ุนู…ู„ุงุก ููŠ Fireblocks ุฃูˆ ุฅุฑุณุงู„ ุจุฑูŠุฏ ุฅู„ูƒุชุฑูˆู†ูŠ ุฅู„ู‰ CSM@fireblocks.com.", + "responses": { + "200": { + "description": "ุฅุฑุฌุงุน ุฌู…ูŠุน ุชูƒูˆูŠู†ุงุช ุงู„ุชุณูˆูŠุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementGetAllConfigsResponse" + }, + "example": { + "configurations": [ + { + "configId": "074791cc-ef32-4920-8373-95efbeea66c5", + "corridorId": "CO_US", + "name": "Flow Config Example", + "steps": { + "ON_RAMP": { + "accountId": "3b7a1451-3453-4c96-a6a5-683cc8971d04", + "inputAssetId": "COP", + "outputAssetId": "USD" + }, + "VAULT_ACCOUNT": { + "accountId": "2", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + }, + "OFF_RAMP": { + "accountId": "f2f74204-93ec-4614-870a-4ea2ad13aa0b", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + } + }, + "conversionSlippageBasisPoints": 75, + "createdAt": 1680625226267 + }, + { + "configId": "a4b0a706-4578-4467-bd5b-a852761dd2aa", + "corridorId": "MX_US", + "name": "MX to US flow", + "steps": { + "ON_RAMP": { + "accountId": "3d6241ad-879b-4a11-842f-4cee9cd7fbba", + "inputAssetId": "MXN", + "outputAssetId": "USD" + }, + "VAULT_ACCOUNT": { + "accountId": "1", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + }, + "OFF_RAMP": { + "accountId": "1cf7f750-117f-4c36-b4ef-14c420d118ce", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + } + }, + "conversionSlippageBasisPoints": 10, + "createdAt": 1665166171134 + } + ] + } + } + } + }, + "401": { + "description": "ุบูŠุฑ ู…ุตุฑุญ ุจู‡. ุฑู…ุฒ JWT ู…ูู‚ูˆุฏ/ุบูŠุฑ ุตุงู„ุญ ููŠ ุฑุฃุณ ุงู„ุชููˆูŠุถ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "ุฎุทุฃ ุฏุงุฎู„ูŠ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/payments/xb-settlements/configs/{configId}": { + "get": { + "tags": [ + "Payments - cross-border settlement" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "summary": "ุงุญุตู„ ุนู„ู‰ ุชูƒูˆูŠู† ุชุณูˆูŠุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ ู…ุญุฏุฏู‹ุง", + "description": "ุงุญุตู„ ุนู„ู‰ ุชูƒูˆูŠู† ุชุณูˆูŠุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ ู…ุญุฏุฏู‹ุง.
**ู…ู„ุงุญุธุฉ:** ูŠูˆุซู‚ ู…ุญุชูˆู‰ ุงู„ู…ุฑุฌุน ููŠ ู‡ุฐุง ุงู„ู‚ุณู… ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ Payments Engine. ุชุชุถู…ู† ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ Payments Engine ูˆุงุฌู‡ุงุช ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ุงู„ู…ุชุงุญุฉ ูู‚ุท ู„ู„ุนู…ู„ุงุก ุงู„ุฐูŠู† ุชู… ุชู…ูƒูŠู† Payments Engine ุนู„ู‰ ุญุณุงุจุงุชู‡ู…. ู‡ุฐู‡ ุงู„ู†ู‚ุงุท ุงู„ู†ู‡ุงุฆูŠุฉ ููŠ ู…ุฑุญู„ุฉ ุชุฌุฑูŠุจูŠุฉ ุญุงู„ูŠู‹ุง ูˆู‚ุฏ ุชูƒูˆู† ุนุฑุถุฉ ู„ู„ุชุบูŠูŠุฑุงุช. ุฅุฐุง ูƒู†ุช ุชุฑูŠุฏ ู…ุนุฑูุฉ ุงู„ู…ุฒูŠุฏ ุนู† Fireblocks Payments EngineุŒ ููŠุฑุฌู‰ ุงู„ุงุชุตุงู„ ุจู…ุฏูŠุฑ ู†ุฌุงุญ ุงู„ุนู…ู„ุงุก ููŠ Fireblocks ุฃูˆ ุฅุฑุณุงู„ ุจุฑูŠุฏ ุฅู„ูƒุชุฑูˆู†ูŠ ุฅู„ู‰ CSM@fireblocks.com.", + "parameters": [ + { + "in": "path", + "name": "configId", + "required": true, + "description": "ู…ุนุฑู ุชูƒูˆูŠู† ุงู„ุชุณูˆูŠุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ.", + "schema": { + "type": "string" + }, + "example": "074791cc-ef32-4920-8373-95efbeea66c5" + } + ], + "responses": { + "200": { + "description": "ุฅุฑุฌุงุน ุชูƒูˆูŠู† ุงู„ุชุณูˆูŠุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ ุงู„ู…ุทู„ูˆุจ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementGetConfigResponse" + }, + "example": { + "configId": "074791cc-ef32-4920-8373-95efbeea66c5", + "corridorId": "CO_US", + "name": "Flow Config Example", + "steps": { + "ON_RAMP": { + "accountId": "3b7a1451-3453-4c96-a6a5-683cc8971d04", + "inputAssetId": "COP", + "outputAssetId": "USD" + }, + "VAULT_ACCOUNT": { + "accountId": "2", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + }, + "OFF_RAMP": { + "accountId": "f2f74204-93ec-4614-870a-4ea2ad13aa0b", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + } + }, + "conversionSlippageBasisPoints": 75, + "createdAt": 1680625226267 + } + } + } + }, + "401": { + "description": "ุบูŠุฑ ู…ุตุฑุญ ุจู‡. ุฑู…ุฒ JWT ู…ูู‚ูˆุฏ/ุบูŠุฑ ุตุงู„ุญ ููŠ ุฑุฃุณ ุงู„ุชููˆูŠุถ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "ู„ุง ูŠูˆุฌุฏ ุชูƒูˆูŠู† ุชุณูˆูŠุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ ู…ุน ุงู„ู…ุนุฑู ุงู„ู…ู‚ุฏู….", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "ุฎุทุฃ ุฏุงุฎู„ูŠ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "Payments - cross-border settlement" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "summary": "ุชุนุฏูŠู„ ุชูƒูˆูŠู† ุงู„ุชุณูˆูŠุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ", + "description": "ุชุนุฏูŠู„ ุชูƒูˆูŠู† ุชุณูˆูŠุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ. ู„ุง ูŠุคุซุฑ ุชุนุฏูŠู„ ุงู„ุชูƒูˆูŠู† ุนู„ู‰ ุงู„ุชุฏูู‚ุงุช ุงู„ุชูŠ ุชู… ุชู†ููŠุฐู‡ุง ุณุงุจู‚ู‹ุง ูˆุงู„ุชูŠ ุงุณุชุฎุฏู…ุช ุงู„ุชูƒูˆูŠู†. **ู…ู„ุงุญุธุฉ:** ูŠูˆุซู‚ ู…ุญุชูˆู‰ ุงู„ู…ุฑุฌุน ููŠ ู‡ุฐุง ุงู„ู‚ุณู… ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ Payments Engine. ุชุชุถู…ู† ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ Payments Engine ูˆุงุฌู‡ุงุช ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ุงู„ู…ุชุงุญุฉ ูู‚ุท ู„ู„ุนู…ู„ุงุก ุงู„ุฐูŠู† ุชู… ุชู…ูƒูŠู† Payments Engine ุนู„ู‰ ุญุณุงุจุงุชู‡ู…. ู‡ุฐู‡ ุงู„ู†ู‚ุงุท ุงู„ู†ู‡ุงุฆูŠุฉ ููŠ ู…ุฑุญู„ุฉ ุชุฌุฑูŠุจูŠุฉ ุญุงู„ูŠู‹ุง ูˆู‚ุฏ ุชูƒูˆู† ุนุฑุถุฉ ู„ู„ุชุบูŠูŠุฑุงุช. ุฅุฐุง ูƒู†ุช ุชุฑูŠุฏ ู…ุนุฑูุฉ ุงู„ู…ุฒูŠุฏ ุญูˆู„ Fireblocks Payments EngineุŒ ููŠุฑุฌู‰ ุงู„ุงุชุตุงู„ ุจู…ุฏูŠุฑ ู†ุฌุงุญ ุงู„ุนู…ู„ุงุก ููŠ Fireblocks ุฃูˆ ุฅุฑุณุงู„ ุจุฑูŠุฏ ุฅู„ูƒุชุฑูˆู†ูŠ ุฅู„ู‰ CSM@fireblocks.com.", + "parameters": [ + { + "in": "path", + "name": "configId", + "required": true, + "description": "ู…ุนุฑู ุชูƒูˆูŠู† ุงู„ุชุณูˆูŠุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ.", + "schema": { + "type": "string" + }, + "example": "074791cc-ef32-4920-8373-95efbeea66c5" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementConfigEditRequestBody" + }, + "example": { + "name": "Flow Config Example - Edited", + "steps": { + "ON_RAMP": { + "accountId": "e9dec04a-3c57-4052-a89a-288c545f6430" + }, + "VAULT_ACCOUNT": { + "accountId": "2" + }, + "OFF_RAMP": { + "accountId": "f2f74204-93ec-4614-870a-4ea2ad13aa0b" + } + }, + "corridorId": "CO_US", + "conversionSlippageBasisPoints": 30 + } + } + } + }, + "responses": { + "200": { + "description": "ุชู… ุชุญุฑูŠุฑ ุชูƒูˆูŠู† ุงู„ุชุณูˆูŠุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ ุจู†ุฌุงุญ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementConfigEditResponse" + }, + "example": { + "configId": "074791cc-ef32-4920-8373-95efbeea66c5", + "corridorId": "CO_US", + "name": "Flow Config Example - Edited", + "steps": { + "ON_RAMP": { + "accountId": "e9dec04a-3c57-4052-a89a-288c545f6430", + "inputAssetId": "COP", + "outputAssetId": "USD" + }, + "VAULT_ACCOUNT": { + "accountId": "2", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + }, + "OFF_RAMP": { + "accountId": "f2f74204-93ec-4614-870a-4ea2ad13aa0b", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + } + }, + "conversionSlippageBasisPoints": 30, + "createdAt": 1680625226267 + } + } + } + }, + "400": { + "description": "ุญุฏุซ ุฎุทุฃ ุฃุซู†ุงุก ุฅู†ุดุงุก ุทู„ุจ ุนุจุฑ ุงู„ุญุฏูˆุฏ. ู„ู… ูŠุชู… ุชุนุฏูŠู„ ุงู„ุชูƒูˆูŠู†.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "ุบูŠุฑ ู…ุตุฑุญ ุจู‡. ุฑู…ุฒ JWT ู…ูู‚ูˆุฏ/ุบูŠุฑ ุตุงู„ุญ ููŠ ุฑุฃุณ ุงู„ุชููˆูŠุถ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "ู„ุง ูŠูˆุฌุฏ ุชูƒูˆูŠู† ุชุณูˆูŠุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ ู…ุน ุงู„ู…ุนุฑู ุงู„ู…ู‚ุฏู….", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "ุฎุทุฃ ุฏุงุฎู„ูŠ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Payments - cross-border settlement" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "configId", + "required": true, + "description": "ู…ุนุฑู ุชูƒูˆูŠู† ุงู„ุชุณูˆูŠุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ.", + "schema": { + "type": "string" + }, + "example": "074791cc-ef32-4920-8373-95efbeea66c5" + } + ], + "summary": "ุญุฐู ุชูƒูˆูŠู† ุงู„ุชุณูˆูŠุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ", + "description": "ุญุฐู ุชูƒูˆูŠู† ุชุณูˆูŠุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ. ู„ุง ูŠุคุฏูŠ ู‡ุฐุง ุฅู„ู‰ ุญุฐู ุฃูˆ ุฅุฒุงู„ุฉ ุงู„ุชุฏูู‚ุงุช ุงู„ุชูŠ ุชู… ุชู†ููŠุฐู‡ุง ุณุงุจู‚ู‹ุง ูˆุงู„ุชูŠ ุงุณุชุฎุฏู…ุช ู‡ุฐุง ุงู„ุชูƒูˆูŠู†. **ู…ู„ุงุญุธุฉ:** ูŠูˆุซู‚ ู…ุญุชูˆู‰ ุงู„ู…ุฑุฌุน ููŠ ู‡ุฐุง ุงู„ู‚ุณู… ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ Payments Engine. ุชุชุถู…ู† ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ Payments Engine ูˆุงุฌู‡ุงุช ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ุงู„ู…ุชุงุญุฉ ูู‚ุท ู„ู„ุนู…ู„ุงุก ุงู„ุฐูŠู† ุชู… ุชู…ูƒูŠู† Payments Engine ุนู„ู‰ ุญุณุงุจุงุชู‡ู…. ู‡ุฐู‡ ุงู„ู†ู‚ุงุท ุงู„ู†ู‡ุงุฆูŠุฉ ููŠ ู…ุฑุญู„ุฉ ุชุฌุฑูŠุจูŠุฉ ุญุงู„ูŠู‹ุง ูˆู‚ุฏ ุชูƒูˆู† ุนุฑุถุฉ ู„ู„ุชุบูŠูŠุฑุงุช. ุฅุฐุง ูƒู†ุช ุชุฑูŠุฏ ู…ุนุฑูุฉ ุงู„ู…ุฒูŠุฏ ุญูˆู„ Fireblocks Payments EngineุŒ ููŠุฑุฌู‰ ุงู„ุงุชุตุงู„ ุจู…ุฏูŠุฑ ู†ุฌุงุญ ุงู„ุนู…ู„ุงุก ููŠ Fireblocks ุฃูˆ ุฅุฑุณุงู„ ุจุฑูŠุฏ ุฅู„ูƒุชุฑูˆู†ูŠ ุฅู„ู‰ CSM@fireblocks.com.", + "responses": { + "200": { + "description": "ุชู… ุญุฐู ุชูƒูˆูŠู† ุงู„ุชุณูˆูŠุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ ุจู†ุฌุงุญ. ุฅุฑุฌุงุน ุงู„ุชูƒูˆูŠู† ุงู„ู…ุญุฐูˆู.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementConfigDeletionResponse" + }, + "example": { + "configId": "074791cc-ef32-4920-8373-95efbeea66c5", + "corridorId": "CO_US", + "name": "Flow Config Example - Edited", + "steps": { + "ON_RAMP": { + "accountId": "e9dec04a-3c57-4052-a89a-288c545f6430", + "inputAssetId": "COP", + "outputAssetId": "USD" + }, + "VAULT_ACCOUNT": { + "accountId": "2", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + }, + "OFF_RAMP": { + "accountId": "f2f74204-93ec-4614-870a-4ea2ad13aa0b", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + } + }, + "conversionSlippageBasisPoints": 30, + "createdAt": 1680625226267 + } + } + } + }, + "401": { + "description": "ุบูŠุฑ ู…ุตุฑุญ ุจู‡. ุฑู…ุฒ JWT ู…ูู‚ูˆุฏ/ุบูŠุฑ ุตุงู„ุญ ููŠ ุฑุฃุณ ุงู„ุชููˆูŠุถ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "ู„ุง ูŠูˆุฌุฏ ุชูƒูˆูŠู† ุชุณูˆูŠุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ ู…ุน ุงู„ู…ุนุฑู ุงู„ู…ู‚ุฏู….", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "ุฎุทุฃ ุฏุงุฎู„ูŠ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/payments/xb-settlements/flows": { + "post": { + "tags": [ + "Payments - cross-border settlement" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "summary": "ุฅู†ุดุงุก ุชุฏูู‚ ุชุณูˆูŠุฉ ุฌุฏูŠุฏ ุนุจุฑ ุงู„ุญุฏูˆุฏ", + "description": "ุฅู†ุดุงุก ุชุฏูู‚ ุนุจุฑ ุงู„ุญุฏูˆุฏ (ุจู†ุงุกู‹ ุนู„ู‰ ุชูƒูˆูŠู† ุนุจุฑ ุงู„ุญุฏูˆุฏ) ุจู…ุจู„ุบ ู„ู„ุชุญูˆูŠู„. ูŠุชู… ุชุนุฑูŠู assetId ุจูˆุงุณุทุฉ ุชูƒูˆูŠู† ุนุจุฑ ุงู„ุญุฏูˆุฏ. ูŠุคุฏูŠ ุฅู†ุดุงุก ุชุฏูู‚ ุฅู„ู‰ ุชุดุบูŠู„ ุญุณุงุจ ุชู‚ุฏูŠุฑุงุช ุงู„ุชุฏูู‚ุŒ ุจู…ุง ููŠ ุฐู„ูƒ ุฃุณุนุงุฑ ุงู„ุตุฑู ุงู„ุฃุฌู†ุจูŠ ูˆุงู„ุฃูˆู‚ุงุช ูˆุงู„ุฑุณูˆู… ุจู†ุงุกู‹ ุนู„ู‰ ุงู„ู…ุจู„ุบ ุงู„ู…ู‚ุฏู…. ู„ู† ูŠุคุฏูŠ ุฅู†ุดุงุก ุชุฏูู‚ ุนุจุฑ ุงู„ุญุฏูˆุฏ ุฅู„ู‰ ุชู†ููŠุฐ ุงู„ุชุฏูู‚. **ู…ู„ุงุญุธุฉ:** ูŠูˆุซู‚ ู…ุญุชูˆู‰ ุงู„ู…ุฑุฌุน ููŠ ู‡ุฐุง ุงู„ู‚ุณู… ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ Payments Engine. ุชุชุถู…ู† ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ Payments Engine ูˆุงุฌู‡ุงุช ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช ู…ุชุงุญุฉ ูู‚ุท ู„ู„ุนู…ู„ุงุก ุงู„ุฐูŠู† ุชู… ุชู…ูƒูŠู† Payments Engine ุนู„ู‰ ุญุณุงุจุงุชู‡ู…. ู‡ุฐู‡ ุงู„ู†ู‚ุงุท ุงู„ู†ู‡ุงุฆูŠุฉ ููŠ ู…ุฑุญู„ุฉ ุชุฌุฑูŠุจูŠุฉ ุญุงู„ูŠู‹ุง ูˆู‚ุฏ ุชูƒูˆู† ุนุฑุถุฉ ู„ู„ุชุบูŠูŠุฑุงุช. ุฅุฐุง ูƒู†ุช ุชุฑูŠุฏ ู…ุนุฑูุฉ ุงู„ู…ุฒูŠุฏ ุญูˆู„ Fireblocks Payments EngineุŒ ููŠุฑุฌู‰ ุงู„ุงุชุตุงู„ ุจู…ุฏูŠุฑ ู†ุฌุงุญ ุนู…ู„ุงุก Fireblocks ุฃูˆ ุฅุฑุณุงู„ ุจุฑูŠุฏ ุฅู„ูƒุชุฑูˆู†ูŠ ุฅู„ู‰ CSM@fireblocks.com.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementCreateFlowRequestBody" + }, + "example": { + "configId": "a4b0a706-4578-4467-bd5b-a852761dd2aa", + "amount": "100" + } + } + } + }, + "responses": { + "200": { + "description": "ุชู… ุฅู†ุดุงุก ุชุฏูู‚ ุงู„ุชุณูˆูŠุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ ุจู†ุฌุงุญ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementCreateFlowResponse" + }, + "example": { + "flowId": "98fb5a8b-65ff-4f15-b89c-80910aedbfb3", + "configId": "a4b0a706-4578-4467-bd5b-a852761dd2aa", + "conversionRate": "0.05481268", + "inputAmount": { + "amount": "100", + "assetId": "MXN" + }, + "estimatedOutputAmount": { + "amount": "5.461268", + "assetId": "XLM_USDC_5F3T" + }, + "totalEstimatedFee": { + "amount": "0.063503", + "assetId": "XLM_USDC_5F3T" + }, + "steps": { + "ON_RAMP": { + "accountId": "3d6241ad-879b-4a11-842f-4cee9cd7fbba", + "inputAmount": { + "amount": "100", + "assetId": "MXN" + }, + "outputAmount": { + "amount": "5.48126865", + "assetId": "USD" + }, + "estimatedFeeAmount": { + "amount": "0.043503", + "assetId": "USD" + }, + "estimatedTime": 10, + "isSignRequired": false + }, + "VAULT_ACCOUNT": { + "accountId": "1", + "inputAmount": { + "amount": "5.48126865", + "assetId": "USD" + }, + "outputAmount": { + "amount": "5.471268", + "assetId": "XLM_USDC_5F3T" + }, + "estimatedFeeAmount": { + "amount": "0.01", + "assetId": "XLM_USDC_5F3T" + }, + "estimatedTime": 63, + "isSignRequired": true + }, + "OFF_RAMP": { + "accountId": "1cf7f750-117f-4c36-b4ef-14c420d118ce", + "inputAmount": { + "amount": "5.471268", + "assetId": "XLM_USDC_5F3T" + }, + "outputAmount": { + "amount": "5.461268", + "assetId": "XLM_USDC_5F3T" + }, + "estimatedFeeAmount": { + "amount": "0.01", + "assetId": "XLM_USDC_5F3T" + }, + "estimatedTime": 95, + "isSignRequired": true + } + }, + "totalEstimatedTime": 696 + } + } + } + }, + "400": { + "description": "ุบูŠุฑ ู‚ุงุฏุฑ ุนู„ู‰ ุฅู†ุดุงุก ุชุฏูู‚ ุนุจุฑ ุงู„ุญุฏูˆุฏุŒ ู…ุนุฑู ุชูƒูˆูŠู† ุบูŠุฑ ุตุงู„ุญ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "ุบูŠุฑ ู…ุตุฑุญ ุจู‡. ุฑู…ุฒ JWT ู…ูู‚ูˆุฏ/ุบูŠุฑ ุตุงู„ุญ ููŠ ุฑุฃุณ ุงู„ุชููˆูŠุถ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "ุฎุทุฃ ุฏุงุฎู„ูŠ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/payments/xb-settlements/flows/{flowId}": { + "get": { + "tags": [ + "Payments - cross-border settlement" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "flowId", + "required": true, + "description": "ู…ุนุฑู ุชุฏูู‚ ุงู„ุชุณูˆูŠุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ.", + "schema": { + "type": "string" + }, + "example": "98fb5a8b-65ff-4f15-b89c-80910aedbfb3" + } + ], + "summary": "ุงุญุตู„ ุนู„ู‰ ุชูุงุตูŠู„ ู…ุญุฏุฏุฉ ุญูˆู„ ุชุฏูู‚ ุงู„ุชุณูˆูŠุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ", + "description": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุชูุงุตูŠู„ ุญูˆู„ ุชุฏูู‚ ุชุณูˆูŠุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ ู…ุนูŠู† **ู…ู„ุงุญุธุฉ:** ูŠูˆุซู‚ ู…ุญุชูˆู‰ ุงู„ู…ุฑุฌุน ููŠ ู‡ุฐุง ุงู„ู‚ุณู… ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ Payments Engine. ุชุชุถู…ู† ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ Payments Engine ูˆุงุฌู‡ุงุช ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ุงู„ู…ุชุงุญุฉ ูู‚ุท ู„ู„ุนู…ู„ุงุก ุงู„ุฐูŠู† ุชู… ุชู…ูƒูŠู† Payments Engine ุนู„ู‰ ุญุณุงุจุงุชู‡ู…. ู‡ุฐู‡ ุงู„ู†ู‚ุงุท ุงู„ู†ู‡ุงุฆูŠุฉ ููŠ ู…ุฑุญู„ุฉ ุชุฌุฑูŠุจูŠุฉ ุญุงู„ูŠู‹ุง ูˆู‚ุฏ ุชูƒูˆู† ุนุฑุถุฉ ู„ู„ุชุบูŠูŠุฑุงุช. ุฅุฐุง ูƒู†ุช ุชุฑูŠุฏ ู…ุนุฑูุฉ ุงู„ู…ุฒูŠุฏ ุญูˆู„ Fireblocks Payments EngineุŒ ููŠุฑุฌู‰ ุงู„ุงุชุตุงู„ ุจู…ุฏูŠุฑ ู†ุฌุงุญ ุนู…ู„ุงุก Fireblocks ุฃูˆ ุฅุฑุณุงู„ ุจุฑูŠุฏ ุฅู„ูƒุชุฑูˆู†ูŠ ุฅู„ู‰ CSM@fireblocks.com.", + "responses": { + "200": { + "description": "ูŠุนูŠุฏ ุชูุงุตูŠู„ ุชุฏูู‚ ุงู„ุชุณูˆูŠุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ. ุจุงู„ู†ุณุจุฉ ู„ู„ุชุฏูู‚ุงุช ุบูŠุฑ ุงู„ู…ู†ูุฐุฉุŒ ุณูŠุชู… ุฅุฑุฌุงุน ูƒุงุฆู† ู…ุนุงูŠู†ุฉุŒ ูŠุนุฑุถ ุงู„ูˆู‚ุช ุงู„ู…ู‚ุฏุฑ ูˆุงู„ู…ุจุงู„ุบ ูˆุงู„ุฑุณูˆู…. ู„ุงุญุธ ุฃู† ุจู†ูŠุฉ ุงู„ุจูŠุงู†ุงุช ู‡ุฐู‡ ูŠุชู… ุชุญุฏูŠุซู‡ุง ู…ุน ุชู‚ุฏู… ุงู„ุชุฏูู‚ุŒ ุจู…ุง ููŠ ุฐู„ูƒ ุงู„ุฑุณูˆู… ุงู„ุฅุฌู…ุงู„ูŠุฉ (ุงู„ู…ุชุฑุงูƒู…ุฉ) ูˆุงู„ุญุงู„ุฉ ูˆุงู„ุฎุทูˆุงุช.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementGetFlowResponse" + }, + "examples": { + "not executed": { + "value": { + "preview": { + "flowId": "98fb5a8b-65ff-4f15-b89c-80910aedbfb3", + "configId": "a4b0a706-4578-4467-bd5b-a852761dd2aa", + "conversionRate": "0.055369", + "inputAmount": { + "amount": "32", + "assetId": "MXN" + }, + "estimatedOutputAmount": { + "amount": "1.741824", + "assetId": "XLM_USDC_5F3T" + }, + "totalEstimatedFee": { + "amount": "0.044063", + "assetId": "XLM_USDC_5F3T" + }, + "totalEstimatedTime": 831, + "steps": { + "ON_RAMP": { + "accountId": "3d6241ad-879b-4a11-842f-4cee9cd7fbba", + "inputAmount": { + "amount": "32", + "assetId": "MXN" + }, + "outputAmount": { + "amount": "1.77182407", + "assetId": "USD" + }, + "estimatedFeeAmount": { + "amount": "0.014063", + "assetId": "USD" + }, + "estimatedTime": 10, + "isSignRequired": false + }, + "VAULT_ACCOUNT": { + "accountId": "1", + "inputAmount": { + "amount": "1.77182407", + "assetId": "XLM_USDC_5F3T" + }, + "outputAmount": { + "amount": "1.761824", + "assetId": "XLM_USDC_5F3T" + }, + "estimatedFeeAmount": { + "amount": "0.01", + "assetId": "XLM_USDC_5F3T" + }, + "estimatedTime": 111, + "isSignRequired": true + }, + "OFF_RAMP": { + "accountId": "1cf7f750-117f-4c36-b4ef-14c420d118ce", + "inputAmount": { + "amount": "1.761824", + "assetId": "XLM_USDC_5F3T" + }, + "outputAmount": { + "amount": "1.751824", + "assetId": "XLM_USDC_5F3T" + }, + "estimatedFeeAmount": { + "amount": "0.01", + "assetId": "XLM_USDC_5F3T" + }, + "estimatedTime": 293, + "isSignRequired": true + } + } + } + } + }, + "in progress": { + "value": { + "execution": { + "flowId": "98fb5a8b-65ff-4f15-b89c-80910aedbfb3", + "configId": "a4b0a706-4578-4467-bd5b-a852761dd2aa", + "inputAmount": { + "amount": "32", + "assetId": "MXN" + }, + "outputAmount": { + "amount": "1.471824", + "assetId": "XLM_USDC_5F3T" + }, + "totalFee": { + "amount": "0.004415", + "assetId": "XLM_USDC_5F3T" + }, + "initiatedAt": 1684919822759, + "initiatedBy": "a92e87a0-5231-531e-a624-fb29c1283764", + "state": "PROCESSING", + "selectedConversionSlippage": { + "basisPoints": 10, + "reason": "FLOW" + }, + "steps": { + "ON_RAMP": { + "id": "c1863abf-e7fa-4f3a-908a-bcd6381f7eb4", + "accountId": "3d6241ad-879b-4a11-842f-4cee9cd7fbba", + "status": "COMPLETED", + "inputAmount": { + "amount": "32", + "assetId": "MXN" + }, + "outputAmount": { + "amount": "1.77182407", + "assetId": "USD" + }, + "fee": { + "amount": "0.014063", + "assetId": "USD" + }, + "startedAt": 1684919823052, + "completedAt": 1684919830456, + "isSignRequired": false + }, + "VAULT_ACCOUNT": { + "id": "2aa2634d-2bab-44ac-9b4e-36e2e4db5d49", + "accountId": "1", + "status": "COMPLETED", + "inputAmount": { + "amount": "1.77182407", + "assetId": "XLM_USDC_5F3T" + }, + "outputAmount": { + "amount": "1.761824", + "assetId": "XLM_USDC_5F3T" + }, + "fee": { + "amount": "0.01", + "assetId": "XLM" + }, + "startedAt": 1684919831385, + "completedAt": 1684920680227, + "isSignRequired": true + }, + "OFF_RAMP": { + "id": "b221ed63-a05c-4e78-b2f2-205dcffeabda", + "accountId": "1cf7f750-117f-4c36-b4ef-14c420d118ce", + "status": "PROCESSING", + "inputAmount": { + "amount": "1.761824", + "assetId": "XLM_USDC_5F3T" + }, + "startedAt": 1684920681088, + "isSignRequired": true + } + } + } + } + }, + "completed": { + "value": { + "execution": { + "flowId": "98fb5a8b-65ff-4f15-b89c-80910aedbfb3", + "configId": "a4b0a706-4578-4467-bd5b-a852761dd2aa", + "inputAmount": { + "amount": "32", + "assetId": "MXN" + }, + "outputAmount": { + "amount": "1.471824", + "assetId": "XLM_USDC_5F3T" + }, + "totalFee": { + "amount": "0.004415", + "assetId": "XLM_USDC_5F3T" + }, + "initiatedAt": 1684919822759, + "initiatedBy": "a92e87a0-5231-531e-a624-fb29c1283764", + "state": "COMPLETED", + "selectedConversionSlippage": { + "basisPoints": 10, + "reason": "FLOW" + }, + "steps": { + "ON_RAMP": { + "id": "b1bec144-c4dd-4ff8-80ed-4204c83dd422", + "accountId": "3d6241ad-879b-4a11-842f-4cee9cd7fbba", + "status": "COMPLETED", + "inputAmount": { + "amount": "32", + "assetId": "MXN" + }, + "outputAmount": { + "amount": "1.77182407", + "assetId": "USD" + }, + "fee": { + "amount": "0.014063", + "assetId": "USD" + }, + "startedAt": 1684919823052, + "completedAt": 1684919830456, + "isSignRequired": false + }, + "VAULT_ACCOUNT": { + "id": "df7e0103-04cf-4508-9654-aa5e4b90dd50", + "accountId": "1", + "status": "COMPLETED", + "inputAmount": { + "amount": "1.77182407", + "assetId": "XLM_USDC_5F3T" + }, + "outputAmount": { + "amount": "1.761824", + "assetId": "XLM_USDC_5F3T" + }, + "fee": { + "amount": "0.01", + "assetId": "XLM" + }, + "startedAt": 1684919831385, + "completedAt": 1684920680227, + "isSignRequired": true + }, + "OFF_RAMP": { + "id": "34c2d597-271a-4c11-937a-3c246f5d39c2", + "accountId": "1cf7f750-117f-4c36-b4ef-14c420d118ce", + "status": "COMPLETED", + "inputAmount": { + "amount": "1.761824", + "assetId": "XLM_USDC_5F3T" + }, + "outputAmount": { + "amount": "1.761823", + "assetId": "XLM_USDC_5F3T" + }, + "fee": { + "amount": "0.00001", + "assetId": "XLM" + }, + "startedAt": 1684920681088, + "completedAt": 1684921261453, + "isSignRequired": true + } + } + } + } + } + } + } + } + }, + "401": { + "description": "ุบูŠุฑ ู…ุตุฑุญ ุจู‡. ุฑู…ุฒ JWT ู…ูู‚ูˆุฏ/ุบูŠุฑ ุตุงู„ุญ ููŠ ุฑุฃุณ ุงู„ุชููˆูŠุถ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "ู…ุนุฑู ุงู„ุชุฏูู‚ ุบูŠุฑ ุตุงู„ุญ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "ุฎุทุฃ ุฏุงุฎู„ูŠ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/payments/xb-settlements/flows/{flowId}/actions/execute": { + "post": { + "tags": [ + "Payments - cross-border settlement" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "flowId", + "required": true, + "description": "ู…ุนุฑู ุชุฏูู‚ ุงู„ุชุณูˆูŠุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ.", + "schema": { + "type": "string" + }, + "example": "98fb5a8b-65ff-4f15-b89c-80910aedbfb3" + } + ], + "summary": "ุชู†ููŠุฐ ุชุฏูู‚ ุงู„ุชุณูˆูŠุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ", + "description": "ุฃุฑุณู„ ุชุฏูู‚ ุฏูุน ู…ุน "flowId" ู„ู„ุชู†ููŠุฐ. ุฅุฐุง ูƒุงู† ู‡ู†ุงูƒ ุญุงุฌุฉ ุฅู„ู‰ ุชูƒูˆูŠู† ุงู†ุฒู„ุงู‚ ู…ุฎุชู„ู ู„ู‡ุฐุง ุงู„ุชู†ููŠุฐ ุนู† ุงู„ุชูƒูˆูŠู† ุงู„ู…ูˆุฌูˆุฏ ููŠ ุชูƒูˆูŠู† ุงู„ุชุฏูู‚ุŒ ููŠุฌุจ ุฃู† ูŠุญุฏุฏ ู†ุต ุงู„ุทู„ุจ ุชูƒูˆูŠู† ุงู„ุงู†ุฒู„ุงู‚ ุงู„ู…ุทู„ูˆุจ ู„ู‡ุฐุง ุงู„ุชู†ููŠุฐ. **ู…ู„ุงุญุธุฉ:** ูŠูˆุซู‚ ู…ุญุชูˆู‰ ุงู„ู…ุฑุฌุน ููŠ ู‡ุฐุง ุงู„ู‚ุณู… ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ Payments Engine. ุชุชุถู…ู† ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ Payments Engine ูˆุงุฌู‡ุงุช ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช ู…ุชุงุญุฉ ูู‚ุท ู„ู„ุนู…ู„ุงุก ุงู„ุฐูŠู† ุชู… ุชู…ูƒูŠู† Payments Engine ุนู„ู‰ ุญุณุงุจุงุชู‡ู…. ู‡ุฐู‡ ุงู„ู†ู‚ุงุท ุงู„ู†ู‡ุงุฆูŠุฉ ููŠ ู…ุฑุญู„ุฉ ุชุฌุฑูŠุจูŠุฉ ุญุงู„ูŠู‹ุง ูˆู‚ุฏ ุชูƒูˆู† ุนุฑุถุฉ ู„ู„ุชุบูŠูŠุฑุงุช. ุฅุฐุง ูƒู†ุช ุชุฑูŠุฏ ู…ุนุฑูุฉ ุงู„ู…ุฒูŠุฏ ุญูˆู„ Fireblocks Payments EngineุŒ ููŠุฑุฌู‰ ุงู„ุงุชุตุงู„ ุจู…ุฏูŠุฑ ู†ุฌุงุญ ุงู„ุนู…ู„ุงุก ููŠ Fireblocks ุฃูˆ ุฅุฑุณุงู„ ุจุฑูŠุฏ ุฅู„ูƒุชุฑูˆู†ูŠ ุฅู„ู‰ CSM@fireblocks.com.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementFlowExecutionRequestBody" + }, + "example": { + "conversionSlippageBasisPoints": 10 + } + } + } + }, + "responses": { + "200": { + "description": "ุจุฏุฃุช ุนู…ู„ูŠุฉ ุชู†ููŠุฐ ุชุฏูู‚ ุงู„ุชุณูˆูŠุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ ุจู†ุฌุงุญ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementFlowExecutionResponse" + }, + "example": { + "flowId": "98fb5a8b-65ff-4f15-b89c-80910aedbfb3", + "configId": "a4b0a706-4578-4467-bd5b-a852761dd2aa", + "inputAmount": { + "amount": "32", + "assetId": "MXN" + }, + "outputAmount": { + "amount": "1.471824", + "assetId": "XLM_USDC_5F3T" + }, + "totalFee": { + "amount": "0.004415", + "assetId": "XLM_USDC_5F3T" + }, + "initiatedAt": 1684919822759, + "initiatedBy": "a92e87a0-5231-531e-a624-fb29c1283764", + "state": "PROCESSING", + "selectedConversionSlippage": { + "basisPoints": 10, + "reason": "FLOW" + }, + "steps": { + "ON_RAMP": { + "id": "c1863abf-e7fa-4f3a-908a-bcd6381f7eb4", + "accountId": "3d6241ad-879b-4a11-842f-4cee9cd7fbba", + "status": "COMPLETED", + "inputAmount": { + "amount": "32", + "assetId": "MXN" + }, + "outputAmount": { + "amount": "1.77182407", + "assetId": "USD" + }, + "fee": { + "amount": "0.014063", + "assetId": "USD" + }, + "startedAt": 1684919823052, + "completedAt": 1684919830456, + "isSignRequired": false + }, + "VAULT_ACCOUNT": { + "id": "2aa2634d-2bab-44ac-9b4e-36e2e4db5d49", + "accountId": "1", + "status": "PROCESSING", + "inputAmount": { + "amount": "1.77182407", + "assetId": "XLM_USDC_5F3T" + }, + "outputAmount": { + "amount": "1.761824", + "assetId": "XLM_USDC_5F3T" + }, + "fee": { + "amount": "0.01", + "assetId": "XLM" + }, + "startedAt": 1684919831385, + "isSignRequired": true + }, + "OFF_RAMP": { + "id": "b221ed63-a05c-4e78-b2f2-205dcffeabda", + "accountId": "1cf7f750-117f-4c36-b4ef-14c420d118ce", + "status": "NOT_STARTED", + "inputAmount": { + "amount": "1.761824", + "assetId": "XLM_USDC_5F3T" + }, + "isSignRequired": true + } + } + } + } + } + }, + "400": { + "description": "ุฎุทุฃ ุฃุซู†ุงุก ู…ุญุงูˆู„ุฉ ุชู†ููŠุฐ ุงู„ุชุฏูู‚ ุนุจุฑ ุงู„ุญุฏูˆุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "ุบูŠุฑ ู…ุตุฑุญ ุจู‡. ุฑู…ุฒ JWT ู…ูู‚ูˆุฏ/ุบูŠุฑ ุตุงู„ุญ ููŠ ุฑุฃุณ ุงู„ุชููˆูŠุถ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "ู…ุนุฑู ุงู„ุชุฏูู‚ ุบูŠุฑ ุตุงู„ุญ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "ุฎุทุฃ ุฏุงุฎู„ูŠ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/payments/payout": { + "post": { + "tags": [ + "Payments - Payout" + ], + "description": "**ู…ู„ุงุญุธุฉ:** ูŠูˆุซู‚ ู…ุญุชูˆู‰ ุงู„ู…ุฑุฌุน ููŠ ู‡ุฐุง ุงู„ู‚ุณู… ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ Payments Engine. ุชุชุถู…ู† ู†ู‚ุงุท ู†ู‡ุงูŠุฉ Payments Engine ูˆุงุฌู‡ุงุช ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ุงู„ู…ุชุงุญุฉ ูู‚ุท ู„ู„ุนู…ู„ุงุก ุงู„ุฐูŠู† ุชู… ุชู…ูƒูŠู† Payments Engine ุนู„ู‰ ุญุณุงุจุงุชู‡ู….

ุชูุนุฏ ู‡ุฐู‡ ุงู„ู†ู‚ุงุท ุงู„ู†ู‡ุงุฆูŠุฉ ุญุงู„ูŠู‹ุง ููŠ ู…ุฑุญู„ุฉ ุชุฌุฑูŠุจูŠุฉ ูˆู‚ุฏ ุชูƒูˆู† ุนุฑุถุฉ ู„ู„ุชุบูŠูŠุฑุงุช.

ุฅุฐุง ูƒู†ุช ุชุฑูŠุฏ ู…ุนุฑูุฉ ุงู„ู…ุฒูŠุฏ ุญูˆู„ ู…ุญุฑูƒ ู…ุฏููˆุนุงุช FireblocksุŒ ูŠุฑุฌู‰ ุงู„ุงุชุตุงู„ ุจู…ุฏูŠุฑ ู†ุฌุงุญ ุนู…ู„ุงุก Fireblocks ุฃูˆ ู…ุฑุงุณู„ุชู†ุง ุนุจุฑ ุงู„ุจุฑูŠุฏ ุงู„ุฅู„ูƒุชุฑูˆู†ูŠ ุนู„ู‰ CSM@fireblocks.com.

ุฅู†ุดุงุก ู…ุฌู…ูˆุนุฉ ุชุนู„ูŠู…ุงุช ุงู„ุฏูุน.
ู…ุฌู…ูˆุนุฉ ุชุนู„ูŠู…ุงุช ุงู„ุฏูุน ู‡ูŠ ู…ุฌู…ูˆุนุฉ ู…ู† ุงู„ุชุนู„ูŠู…ุงุช ู„ุชูˆุฒูŠุน ุงู„ู…ุฏููˆุนุงุช ู…ู† ุญุณุงุจ ุฏูุน ูˆุงุญุฏ ุฅู„ู‰ ู‚ุงุฆู…ุฉ ู…ู† ุญุณุงุจุงุช ุงู„ู…ุณุชููŠุฏ.
ุชุญุฏุฏ ู…ุฌู…ูˆุนุฉ ุงู„ุชุนู„ูŠู…ุงุช:
  • ุญุณุงุจ ุงู„ุฏูุน ูˆู†ูˆุน ุงู„ุญุณุงุจ (ุฎุฒู†ุฉุŒ ุฃูˆ ุชุจุงุฏู„ุŒ ุฃูˆ ุนู…ู„ุฉ ูˆุฑู‚ูŠุฉ).
  • ู†ูˆุน ุงู„ุญุณุงุจ (ุญุณุงุจ ุงู„ุฎุฒู†ุฉุŒ ุฃูˆ ุญุณุงุจ ุงู„ุชุจุงุฏู„ุŒ ุฃูˆ ุนู†ูˆุงู† ุงู„ู‚ุงุฆู…ุฉ ุงู„ุจูŠุถุงุกุŒ ุฃูˆ ุงุชุตุงู„ ุงู„ุดุจูƒุฉุŒ ุฃูˆ ุญุณุงุจ ุงู„ุนู…ู„ุฉ ุงู„ูˆุฑู‚ูŠุฉุŒ ุฃูˆ ุญุณุงุจ ุงู„ุชุงุฌุฑ)ุŒ ูˆุงู„ู…ุจู„ุบุŒ ูˆุฃุตูˆู„ ุงู„ุฏูุน ู„ูƒู„ ุญุณุงุจ ู…ุณุชููŠุฏ.
", + "security": [ + { + "bearerAuth": [] + } + ], + "summary": "ุฅู†ุดุงุก ู…ุฌู…ูˆุนุฉ ุชุนู„ูŠู…ุงุช ุงู„ุฏูุน", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreatePayoutRequest" + }, + "example": { + "paymentAccount": { + "id": "EX_SUB3", + "type": "EXCHANGE_ACCOUNT" + }, + "instructionSet": [ + { + "payeeAccount": { + "id": "bef85a1c-b605-4b2e-bdb5-2d400f4d0bf3", + "type": "EXTERNAL_WALLET" + }, + "amount": { + "amount": "43", + "assetId": "USDC" + } + }, + { + "payeeAccount": { + "id": "3adc1f92-e791-44a8-9aee-7f31c2108b78", + "type": "NETWORK_CONNECTION" + }, + "amount": { + "amount": "4423", + "assetId": "USDC" + } + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "ุชู… ุฅู†ุดุงุก ู…ุฌู…ูˆุนุฉ ุชุนู„ูŠู…ุงุช ุงู„ุฏูุน ุจู†ุฌุงุญ ูˆุฅุฑุฌุงุน ู…ุฌู…ูˆุนุฉ ุงู„ุชุนู„ูŠู…ุงุช ุงู„ู…ูˆู„ุฏุฉ ุจู…ุนุฑู ุฏูุน ูุฑูŠุฏ. ุณูŠุชู… ุงุณุชุฎุฏุงู… ู…ุนุฑู ุงู„ุฏูุน ู„ุชู†ููŠุฐ ุงู„ุฏูุน ูˆุงู„ุชุญู‚ู‚ ู…ู† ุญุงู„ุฉ ุงู„ุฏูุน.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PayoutResponse" + }, + "example": { + "payoutId": "1fe3b61f-7e1f-4a19-aff0-4f0a524d44d7", + "paymentAccount": { + "id": "EX_SUB3", + "type": "EXCHANGE_ACCOUNT" + }, + "createdAt": 1645365800, + "state": "REQUESTED", + "status": "REGISTERED", + "initMethod": "API", + "instructionSet": [ + { + "id": "6ea4a016-536b-49af-b1a0-40b343ccf879", + "name": "payee-wallet-name", + "payeeAccount": { + "id": "bef85a1c-b605-4b2e-bdb5-2d400f4d0bf3", + "type": "EXTERNAL_WALLET" + }, + "amount": { + "amount": "43", + "assetId": "USDC" + }, + "state": "NOT_STARTED", + "transactions": [] + }, + { + "id": "e783a79b-6acc-4d18-885d-ed533cad8eeb", + "name": "payee-by-network", + "payeeAccount": { + "id": "3adc1f92-e791-44a8-9aee-7f31c2108b78", + "type": "NETWORK_CONNECTION" + }, + "amount": { + "amount": "4423.23", + "assetId": "USDC" + }, + "state": "NOT_STARTED", + "transactions": [] + } + ] + } + } + } + }, + "400": { + "description": "ุงู‚ุชุฑุงุญ ุบูŠุฑ ุฌูŠุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "ุบูŠุฑ ู…ุตุฑุญ ุจู‡. ุฑู…ุฒ JWT ู…ูู‚ูˆุฏ/ุบูŠุฑ ุตุงู„ุญ ููŠ ุฑุฃุณ ุงู„ุชููˆูŠุถ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "ุฎุทุฃ ุฏุงุฎู„ูŠ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/payments/payout/{payoutId}/actions/execute": { + "post": { + "tags": [ + "Payments - Payout" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "summary": "ุชู†ููŠุฐ ู…ุฌู…ูˆุนุฉ ุชุนู„ูŠู…ุงุช ุงู„ุฏูุน", + "description": "**ู…ู„ุงุญุธุฉ:** ูŠูˆุซู‚ ู…ุญุชูˆู‰ ุงู„ู…ุฑุฌุน ููŠ ู‡ุฐุง ุงู„ู‚ุณู… ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ Payments Engine. ุชุชุถู…ู† ู†ู‚ุงุท ู†ู‡ุงูŠุฉ Payments Engine ูˆุงุฌู‡ุงุช ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ุงู„ู…ุชุงุญุฉ ูู‚ุท ู„ู„ุนู…ู„ุงุก ุงู„ุฐูŠู† ุชู… ุชู…ูƒูŠู† Payments Engine ุนู„ู‰ ุญุณุงุจุงุชู‡ู….

ุชูุนุฏ ู‡ุฐู‡ ุงู„ู†ู‚ุงุท ุงู„ู†ู‡ุงุฆูŠุฉ ุญุงู„ูŠู‹ุง ููŠ ู…ุฑุญู„ุฉ ุชุฌุฑูŠุจูŠุฉ ูˆู‚ุฏ ุชูƒูˆู† ุนุฑุถุฉ ู„ู„ุชุบูŠูŠุฑุงุช.

ุฅุฐุง ูƒู†ุช ุชุฑูŠุฏ ู…ุนุฑูุฉ ุงู„ู…ุฒูŠุฏ ุญูˆู„ ู…ุญุฑูƒ ู…ุฏููˆุนุงุช FireblocksุŒ ููŠุฑุฌู‰ ุงู„ุงุชุตุงู„ ุจู…ุฏูŠุฑ ู†ุฌุงุญ ุนู…ู„ุงุก Fireblocks ุฃูˆ ู…ุฑุงุณู„ุชู†ุง ุนุจุฑ ุงู„ุจุฑูŠุฏ ุงู„ุฅู„ูƒุชุฑูˆู†ูŠ ุนู„ู‰ CSM@fireblocks.com.

ุชู†ููŠุฐ ู…ุฌู…ูˆุนุฉ ุชุนู„ูŠู…ุงุช ุงู„ุฏูุน.

ุณูŠุชู… ุงู„ุชุญู‚ู‚ ู…ู† ู…ุฌู…ูˆุนุฉ ุงู„ุชุนู„ูŠู…ุงุช ูˆุชู†ููŠุฐู‡ุง.
ู‚ูู„ ุงู„ู…ุตุฏุฑ
ุฅุฐุง ูƒู†ุช ุชู‚ูˆู… ุจุชู†ููŠุฐ ู…ุฌู…ูˆุนุฉ ุชุนู„ูŠู…ุงุช ุงู„ุฏูุน ู…ู† ุญุณุงุจ ุฏูุน ูŠุญุชูˆูŠ ุนู„ู‰ ุนู…ู„ูŠุฉ ุฏูุน ู†ุดุทุฉ ุจุงู„ูุนู„ุŒ ูุณูˆู ุชูƒุชู…ู„ ุนู…ู„ูŠุฉ ุงู„ุฏูุน ุงู„ู†ุดุทุฉ ู‚ุจู„ ุฃู† ุชุชู…ูƒู† ู…ู† ุชู†ููŠุฐ ู…ุฌู…ูˆุนุฉ ุชุนู„ูŠู…ุงุช ุงู„ุฏูุน ุงู„ุฌุฏูŠุฏุฉ.
ู„ุง ูŠู…ูƒู†ูƒ ุชู†ููŠุฐ ู†ูุณ ู…ุฌู…ูˆุนุฉ ุชุนู„ูŠู…ุงุช ุงู„ุฏูุน ุฃูƒุซุฑ ู…ู† ู…ุฑุฉ.", + "parameters": [ + { + "name": "payoutId", + "description": "ู…ุนุฑู ุงู„ุฏูุนุฉ ุงู„ุฐูŠ ุชู… ุงุณุชู„ุงู…ู‡ ู…ู† ุฅู†ุดุงุก ู…ุฌู…ูˆุนุฉ ุชุนู„ูŠู…ุงุช ุงู„ุฏูุน", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "example": "1fe3b61f-7e1f-4a19-aff0-4f0a524d44d7" + } + ], + "responses": { + "200": { + "description": "ุชู… ุชู†ููŠุฐ ู…ุฌู…ูˆุนุฉ ุชุนู„ูŠู…ุงุช ุงู„ุฏูุน", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DispatchPayoutResponse" + }, + "example": { + "payoutId": "1fe3b61f-7e1f-4a19-aff0-4f0a524d44d7" + } + } + } + }, + "400": { + "description": "ุงู‚ุชุฑุงุญ ุบูŠุฑ ุฌูŠุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "ุบูŠุฑ ู…ุตุฑุญ ุจู‡. ุฑู…ุฒ JWT ู…ูู‚ูˆุฏ/ุบูŠุฑ ุตุงู„ุญ ููŠ ุฑุฃุณ ุงู„ุชููˆูŠุถ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "ุฎุทุฃ ุฏุงุฎู„ูŠ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/payments/payout/{payoutId}": { + "get": { + "tags": [ + "Payments - Payout" + ], + "summary": "ุงุญุตู„ ุนู„ู‰ ุญุงู„ุฉ ู…ุฌู…ูˆุนุฉ ุชุนู„ูŠู…ุงุช ุงู„ุฏูุน", + "description": "**ู…ู„ุงุญุธุฉ:** ูŠูˆุซู‚ ู…ุญุชูˆู‰ ุงู„ู…ุฑุฌุน ููŠ ู‡ุฐุง ุงู„ู‚ุณู… ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ Payments Engine. ุชุชุถู…ู† ู†ู‚ุงุท ู†ู‡ุงูŠุฉ Payments Engine ูˆุงุฌู‡ุงุช ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ุงู„ู…ุชุงุญุฉ ูู‚ุท ู„ู„ุนู…ู„ุงุก ุงู„ุฐูŠู† ุชู… ุชู…ูƒูŠู† Payments Engine ุนู„ู‰ ุญุณุงุจุงุชู‡ู….

ุชูุนุฏ ู‡ุฐู‡ ุงู„ู†ู‚ุงุท ุงู„ู†ู‡ุงุฆูŠุฉ ุญุงู„ูŠู‹ุง ููŠ ู…ุฑุญู„ุฉ ุชุฌุฑูŠุจูŠุฉ ูˆู‚ุฏ ุชูƒูˆู† ุนุฑุถุฉ ู„ู„ุชุบูŠูŠุฑุงุช.

ุฅุฐุง ูƒู†ุช ุชุฑูŠุฏ ู…ุนุฑูุฉ ุงู„ู…ุฒูŠุฏ ุญูˆู„ ู…ุญุฑูƒ ู…ุฏููˆุนุงุช FireblocksุŒ ููŠุฑุฌู‰ ุงู„ุงุชุตุงู„ ุจู…ุฏูŠุฑ ู†ุฌุงุญ ุนู…ู„ุงุก Fireblocks ุฃูˆ ู…ุฑุงุณู„ุชู†ุง ุนุจุฑ ุงู„ุจุฑูŠุฏ ุงู„ุฅู„ูƒุชุฑูˆู†ูŠ ุนู„ู‰ CSM@fireblocks.com.
", + "security": [ + { + "bearerAuth": [] + } + ], + "parameters": [ + { + "name": "payoutId", + "description": "ู…ุนุฑู ุงู„ุฏูุนุฉ ุงู„ุฐูŠ ุชู… ุงุณุชู„ุงู…ู‡ ู…ู† ุฅู†ุดุงุก ู…ุฌู…ูˆุนุฉ ุชุนู„ูŠู…ุงุช ุงู„ุฏูุน", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "example": "1fe3b61f-7e1f-4a19-aff0-4f0a524d44d7" + } + ], + "responses": { + "200": { + "description": "ุฅุฑุฌุงุน ุงู„ุญุงู„ุฉ ุงู„ุญุงู„ูŠุฉ ู„ู…ุฌู…ูˆุนุฉ ุชุนู„ูŠู…ุงุช ุงู„ุฏูุนุŒ ุจู…ุง ููŠ ุฐู„ูƒ ุญุงู„ุฉ ูƒู„ ุชุนู„ูŠู…ุงุช ุงู„ุฏูุน ูˆุงู„ู…ุนุงู…ู„ุงุช ุงู„ุชูŠ ุชู… ุฅู†ุดุงุคู‡ุง ููŠ ุงู„ุนู…ู„ูŠุฉ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PayoutResponse" + }, + "example": { + "payoutId": "1fe3b61f-7e1f-4a19-aff0-4f0a524d44d7", + "paymentAccount": { + "id": "EX_SUB3", + "type": "EXCHANGE_ACCOUNT" + }, + "createdAt": 1645365800, + "state": "FINALIZED", + "status": "DONE", + "initMethod": "API", + "instructionSet": [ + { + "id": "6ea4a016-536b-49af-b1a0-40b343ccf879", + "name": "payee-wallet-name", + "payeeAccount": { + "id": "bef85a1c-b605-4b2e-bdb5-2d400f4d0bf3", + "type": "EXTERNAL_WALLET" + }, + "amount": { + "amount": "4312", + "assetId": "USDC" + }, + "state": "COMPLETED", + "transactions": [ + { + "id": "35a4b10c-1f83-4f0b-ba2a-da0e73be2d6e", + "state": "COMPLETED", + "timestamp": 1645367429 + } + ] + }, + { + "id": "e783a79b-6acc-4d18-885d-ed533cad8eeb", + "name": "payee-by-network", + "payeeAccount": { + "id": "3adc1f92-e791-44a8-9aee-7f31c2108b78", + "type": "NETWORK_CONNECTION" + }, + "amount": { + "amount": "4423.23", + "assetId": "USDC" + }, + "state": "COMPLETED", + "transactions": [ + { + "id": "4505e7d9-bfc7-41bc-9750-54311fcbbf26", + "state": "COMPLETED", + "timestamp": 1645367449 + } + ] + } + ], + "reportUrl": "https://some-url.com/reports/cc5777c1-75a9-4337-aebd-f1f5a40a9391" + } + } + } + }, + "401": { + "description": "ุบูŠุฑ ู…ุตุฑุญ ุจู‡. ุฑู…ุฒ JWT ู…ูู‚ูˆุฏ/ุบูŠุฑ ุตุงู„ุญ ููŠ ุฑุฃุณ ุงู„ุชููˆูŠุถ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "ู„ุง ูŠูˆุฌุฏ ุฏูุน ู…ุน ู…ุนุฑู ุงู„ุฏูุน ุงู„ู…ุญุฏุฏ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "ุฎุทุฃ ุฏุงุฎู„ูŠ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/gas_station": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุฅุนุฏุงุฏุงุช ู…ุญุทุฉ ุงู„ูˆู‚ูˆุฏ", + "description": "ุฅุฑุฌุงุน ุฅุนุฏุงุฏุงุช ู…ุญุทุฉ ุงู„ูˆู‚ูˆุฏ ูˆุฑุตูŠุฏ ETH.", + "tags": [ + "Gas stations" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "gas_station_info = fireblocks.get_gas_station_info()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const gasStationInfo = await fireblocks.gasStationInfo();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "ุฎุตุงุฆุต ู…ุญุทุฉ ุงู„ูˆู‚ูˆุฏ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/GasStationPropertiesResponse" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/gas_station/{assetId}": { + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ุฅุนุฏุงุฏุงุช ู…ุญุทุฉ ุงู„ูˆู‚ูˆุฏ ุญุณุจ ุงู„ุฃุตูˆู„", + "description": "ุฅุฑุฌุงุน ุฅุนุฏุงุฏุงุช ู…ุญุทุฉ ุงู„ูˆู‚ูˆุฏ ูˆุงู„ุฃุฑุตุฏุฉ ู„ู„ุฃุตู„ ุงู„ู…ุทู„ูˆุจ.", + "tags": [ + "Gas stations" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "gas_station_info = fireblocks.get_gas_station_info(asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const gasStationInfo = await fireblocks.gasStationInfo(assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "assetId", + "description": "ู…ุนุฑู ุงู„ุฃุตู„", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "ุฎุตุงุฆุต ู…ุญุทุฉ ุงู„ูˆู‚ูˆุฏ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/GasStationPropertiesResponse" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/gas_station/configuration": { + "put": { + "summary": "ุชุนุฏูŠู„ ุฅุนุฏุงุฏุงุช ู…ุญุทุฉ ุงู„ูˆู‚ูˆุฏ", + "description": "ูŠู‚ูˆู… ุจุชูƒูˆูŠู† ุฅุนุฏุงุฏุงุช ู…ุญุทุฉ ุงู„ูˆู‚ูˆุฏ ู„ู€ ETH.", + "tags": [ + "Gas stations" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "gas_station = fireblocks.set_gas_station_configuration(gas_threshold, gas_cap, max_gas_price, asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const gasStation = await fireblocks.setGasStationConfiguration(gasThreshold, gasCap, maxGasPrice)", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GasStationConfiguration" + } + } + } + }, + "responses": { + "201": { + "description": "ู†ุนู…", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/gas_station/configuration/{assetId}": { + "put": { + "summary": "ุชุนุฏูŠู„ ุฅุนุฏุงุฏุงุช ู…ุญุทุฉ ุงู„ูˆู‚ูˆุฏ ู„ู„ุฃุตูˆู„", + "description": "ูŠู‚ูˆู… ุจุชูƒูˆูŠู† ุฅุนุฏุงุฏุงุช ู…ุญุทุฉ ุงู„ูˆู‚ูˆุฏ ู„ู„ุฃุตู„ ุงู„ู…ุทู„ูˆุจ.", + "tags": [ + "Gas stations" + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "assetId", + "description": "ู…ุนุฑู ุงู„ุฃุตู„", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GasStationConfiguration" + } + } + } + }, + "responses": { + "201": { + "description": "ู†ุนู…", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/users": { + "get": { + "summary": "ู‚ุงุฆู…ุฉ ุงู„ู…ุณุชุฎุฏู…ูŠู†", + "description": "ู‚ู… ุจุฅุฏุฑุงุฌ ุฌู…ูŠุน ุงู„ู…ุณุชุฎุฏู…ูŠู† ู„ู…ุณุงุญุฉ ุงู„ุนู…ู„. ูŠุฑุฌู‰ ู…ู„ุงุญุธุฉ ุฃู† ู†ู‚ุทุฉ ุงู„ู†ู‡ุงูŠุฉ ู‡ุฐู‡ ู…ุชุงุญุฉ ูู‚ุท ู„ู…ูุงุชูŠุญ API ุงู„ุชูŠ ุชุชู…ุชุน ุจุฃุฐูˆู†ุงุช ุงู„ู…ุณุคูˆู„.", + "tags": [ + "Users" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "users = fireblocks.get_users()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const users = await fireblocks.getUsers();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "ู‚ุงุฆู…ุฉ ุงู„ู…ุณุชุฎุฏู…ูŠู†", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/GetUsersResponse" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/audits": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุณุฌู„ุงุช ุงู„ุชุฏู‚ูŠู‚", + "tags": [ + "Audit Logs" + ], + "parameters": [ + { + "in": "query", + "name": "timePeriod", + "required": true, + "description": "ุขุฎุฑ ูุชุฑุฉ ุฒู…ู†ูŠุฉ ู„ุฌู„ุจ ุณุฌู„ุงุช ุงู„ุชุฏู‚ูŠู‚", + "schema": { + "oneOf": [ + { + "const": "DAY" + }, + { + "const": "WEEK" + } + ] + } + } + ], + "responses": { + "200": { + "description": "ุณุฌู„ุงุช ุงู„ุชุฏู‚ูŠู‚ ู…ู† ุงู„ูุชุฑุฉ ุงู„ุฒู…ู†ูŠุฉ ุงู„ู…ุทู„ูˆุจุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/off_exchange/add": { + "post": { + "summary": "ุฅุถุงูุฉ ุงู„ุถู…ุงู†ุงุช", + "description": "ุฅุถุงูุฉ ุถู…ุงู†ุงุชุŒ ุฅู†ุดุงุก ุทู„ุจ ุฅูŠุฏุงุน", + "tags": [ + "Off exchanges" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AddCollateralRequestBody" + } + } + } + }, + "responses": { + "200": { + "description": "ูƒุงุฆู† ุงู„ู…ุนุงู…ู„ุฉ", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateTransactionResponse" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/off_exchange/remove": { + "post": { + "summary": "ุฅุฒุงู„ุฉ ุงู„ุถู…ุงู†ุงุช", + "description": "ุฅุฒุงู„ุฉ ุงู„ุถู…ุงู†ุงุชุŒ ุฅู†ุดุงุก ุทู„ุจ ุณุญุจ", + "tags": [ + "Off exchanges" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RemoveCollateralRequestBody" + } + } + } + }, + "responses": { + "200": { + "description": "ูƒุงุฆู† ุงู„ู…ุนุงู…ู„ุฉ", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateTransactionResponse" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/off_exchange/settlements/trader": { + "post": { + "summary": "ุฅู†ุดุงุก ุชุณูˆูŠุฉ ู„ู„ุชุงุฌุฑ", + "description": "ุฅู†ุดุงุก ุชุณูˆูŠุฉ ู„ู„ุชุงุฌุฑ", + "tags": [ + "Off exchanges" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SettlementRequestBody" + } + } + } + }, + "responses": { + "201": { + "description": "ูƒุงุฆู† ุงุณุชูŠุทุงู†ูŠ", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SettlementResponse" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/off_exchange/settlements/transactions": { + "get": { + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู…ุนุงู…ู„ุงุช ุงู„ุชุณูˆูŠุฉ ู…ู† ุงู„ุจูˆุฑุตุฉ", + "description": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู…ุนุงู…ู„ุงุช ุงู„ุชุณูˆูŠุฉ ู…ู† ุงู„ุจูˆุฑุตุฉ", + "tags": [ + "Off exchanges" + ], + "parameters": [ + { + "in": "query", + "name": "mainExchangeAccountId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "ู…ุนุงู…ู„ุงุช ุงู„ุชุณูˆูŠุฉ", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/GetSettlementResponse" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/off_exchange/collateral_accounts/{mainExchangeAccountId}": { + "get": { + "summary": "ุงู„ุนุซูˆุฑ ุนู„ู‰ ุญุณุงุจ ุชุจุงุฏู„ ุถู…ุงู†ุงุช ู…ุญุฏุฏ", + "description": "ุฅุฑุฌุงุน ุญุณุงุจ ุงู„ุถู…ุงู† ุจูˆุงุณุทุฉ mainExchangeAccountId.", + "tags": [ + "Off exchanges" + ], + "parameters": [ + { + "in": "path", + "name": "mainExchangeAccountId", + "required": true, + "description": "ู…ุนุฑู ุญุณุงุจ ุงู„ุชุจุงุฏู„ ุงู„ุฑุฆูŠุณูŠ ุงู„ุฐูŠ ูŠุฑุชุจุท ุจู‡ ุญุณุงุจ ุงู„ุถู…ุงู† ุงู„ู…ุทู„ูˆุจ", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ูƒุงุฆู† ExchangeAccount", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ExchangeAccount" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/webhooks/resend": { + "post": { + "summary": "ุฅุนุงุฏุฉ ุฅุฑุณุงู„ ุฎุทุงูุงุช ุงู„ูˆูŠุจ ุงู„ูุงุดู„ุฉ", + "description": "ุฅุนุงุฏุฉ ุฅุฑุณุงู„ ุฌู…ูŠุน ุฅุดุนุงุฑุงุช ุงู„ูˆูŠุจ ู‡ูˆูƒ ุงู„ูุงุดู„ุฉ.", + "tags": [ + "Webhooks" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = fireblocks.resend_webhooks()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.resendWebhooks();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "ู†ุนู…", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ResendWebhooksResponse" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/webhooks/resend/{txId}": { + "post": { + "summary": "ุฅุนุงุฏุฉ ุฅุฑุณุงู„ ุฎุทุงูุงุช ุงู„ูˆูŠุจ ุงู„ูุงุดู„ุฉ ู„ู…ุนุงู…ู„ุฉ ุจูˆุงุณุทุฉ ุงู„ู…ุนุฑู", + "description": "ุฅุนุงุฏุฉ ุฅุฑุณุงู„ ุฅุดุนุงุฑุงุช ุงู„ูˆูŠุจ ู‡ูˆูƒ ุงู„ูุงุดู„ุฉ ู„ู…ุนุงู…ู„ุฉ ู…ุง ุนู† ุทุฑูŠู‚ ุงู„ู…ุนุฑู.", + "tags": [ + "Webhooks" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = fireblocks.resend_transaction_webhooks_by_id(txId, resend_created, resend_status_updated)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.resendTransactionWebhooksById(txId, resendCreated, resendStatusUpdated);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "txId", + "required": true, + "description": "ู…ุนุฑู ุงู„ู…ุนุงู…ู„ุฉ ู„ุฎุทุงูุงุช ุงู„ูˆูŠุจ", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "resendCreated": { + "type": "boolean" + }, + "resendStatusUpdated": { + "type": "boolean" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "ู†ุนู…", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/nfts/ownership/tokens": { + "put": { + "operationId": "refreshNFTOwnershipByVault", + "summary": "ุชุญุฏูŠุซ ุฑู…ูˆุฒ ุญุณุงุจ ุงู„ุฎุฒู†ุฉ", + "description": "ุชุญุฏูŠุซ ุฌู…ูŠุน ุงู„ุฑู…ูˆุฒ ูˆุงู„ุฃุฑุตุฏุฉ ู„ูƒู„ ุญุณุงุจ blockchain ูˆvault. **ู…ู„ุงุญุธุฉ**: ู‡ุฐู‡ ุงู„ู†ู‚ุทุฉ ุงู„ู†ู‡ุงุฆูŠุฉ ููŠ ู…ุฑุญู„ุฉ ุชุฌุฑูŠุจูŠุฉ ุงู„ุขู†ุŒ ู…ุนุทู„ุฉ ู„ู„ุชูˆุงูุฑ ุงู„ุนุงู… ููŠ ู‡ุฐุง ุงู„ูˆู‚ุช. ู„ู„ุชุณุฌูŠู„ ููŠ ู…ุฑุญู„ุฉ ุชุฌุฑูŠุจูŠุฉ ูˆุชู…ูƒูŠู† ู‡ุฐู‡ ุงู„ู†ู‚ุทุฉ ุงู„ู†ู‡ุงุฆูŠุฉุŒ ุงุชุตู„ ุจู…ุฏูŠุฑ ู†ุฌุงุญ ุงู„ุนู…ู„ุงุก ููŠ Fireblocks ุฃูˆ ุชูˆุงุตู„ ู…ุน [CSM@fireblocks.com](mailto:CSM@fireblocks.com).", + "parameters": [ + { + "name": "blockchainDescriptor", + "required": true, + "in": "query", + "description": "ู…ุฑุดุญ ูˆุตู ุงู„ุจู„ูˆูƒุดูŠู†", + "schema": { + "oneOf": [ + { + "const": "ETH" + }, + { + "const": "ETH_TEST3" + }, + { + "const": "POLYGON" + }, + { + "const": "POLYGON_TEST_MUMBAI" + } + ] + } + }, + { + "name": "vaultAccountId", + "required": true, + "in": "query", + "description": "ู…ุฑุดุญ ุญุณุงุจ ุงู„ุฎุฒู†ุฉ", + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + } + }, + "tags": [ + "NFTs (Beta)" + ] + }, + "get": { + "operationId": "getOwnedNFTs", + "summary": "ู‚ุงุฆู…ุฉ ุจุฌู…ูŠุน ุงู„ุฑู…ูˆุฒ ุงู„ู…ู…ู„ูˆูƒุฉ (ู…ู‚ุณู…ุฉ ุฅู„ู‰ ุตูุญุงุช)", + "description": "ูŠุนูŠุฏ ุฌู…ูŠุน ุงู„ุฑู…ูˆุฒ ูˆุจูŠุงู†ุงุชู‡ุง ููŠ ู…ุณุงุญุฉ ุงู„ุนู…ู„ ุงู„ุฎุงุตุฉ ุจูƒ. **ู…ู„ุงุญุธุฉ**: ู‡ุฐู‡ ุงู„ู†ู‚ุทุฉ ุงู„ู†ู‡ุงุฆูŠุฉ ููŠ ู…ุฑุญู„ุฉ ุชุฌุฑูŠุจูŠุฉ ุงู„ุขู†ุŒ ู…ุนุทู„ุฉ ู„ู„ุชูˆุงูุฑ ุงู„ุนุงู… ููŠ ู‡ุฐุง ุงู„ูˆู‚ุช. ู„ู„ุชุณุฌูŠู„ ููŠ ู…ุฑุญู„ุฉ ุชุฌุฑูŠุจูŠุฉ ูˆุชู…ูƒูŠู† ู‡ุฐู‡ ุงู„ู†ู‚ุทุฉ ุงู„ู†ู‡ุงุฆูŠุฉุŒ ุงุชุตู„ ุจู…ุฏูŠุฑ ู†ุฌุงุญ ุนู…ู„ุงุก Fireblocks ุฃูˆ ุชูˆุงุตู„ ู…ุน [CSM@fireblocks.com](mailto:CSM@fireblocks.com).", + "parameters": [ + { + "name": "blockchainDescriptor", + "required": false, + "in": "query", + "description": "ู…ุฑุดุญ ูˆุตู ุงู„ุจู„ูˆูƒุดูŠู†", + "schema": { + "oneOf": [ + { + "const": "ETH" + }, + { + "const": "ETH_TEST3" + }, + { + "const": "POLYGON" + }, + { + "const": "POLYGON_TEST_MUMBAI" + } + ] + } + }, + { + "name": "vaultAccountIds", + "required": false, + "in": "query", + "description": "ู‚ุงุฆู…ุฉ ู…ู†ูุตู„ุฉ ุจููˆุงุตู„ ู„ู…ุนุฑูุงุช ุญุณุงุจุงุช Vault. ูŠูุณู…ุญ ุจู…ุง ูŠุตู„ ุฅู„ู‰ 100 ููŠ ุทู„ุจ ูˆุงุญุฏ", + "schema": { + "type": "string" + } + }, + { + "name": "ids", + "required": false, + "in": "query", + "description": "ู‚ุงุฆู…ุฉ ู…ู†ูุตู„ุฉ ุจููˆุงุตู„ ู…ู† ู…ุนุฑูุงุช NFT. ูŠูุณู…ุญ ุจู…ุง ูŠุตู„ ุฅู„ู‰ 100 ููŠ ุทู„ุจ ูˆุงุญุฏ.", + "schema": { + "type": "string" + } + }, + { + "name": "collectionIds", + "required": false, + "in": "query", + "description": "ู‚ุงุฆู…ุฉ ู…ู†ูุตู„ุฉ ุจููˆุงุตู„ ู…ู† ู…ุนุฑูุงุช ุงู„ู…ุฌู…ูˆุนุฉ. ูŠูุณู…ุญ ุจู…ุง ูŠุตู„ ุฅู„ู‰ 100 ููŠ ุทู„ุจ ูˆุงุญุฏ.", + "schema": { + "type": "string" + } + }, + { + "name": "pageCursor", + "required": false, + "in": "query", + "description": "ู…ุคุดุฑ ุงู„ุตูุญุฉ ู„ุฌู„ุจู‡ุง", + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "required": false, + "in": "query", + "description": "ุงู„ุนู†ุงุตุฑ ููŠ ูƒู„ ุตูุญุฉ (ุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ 100)", + "schema": { + "minimum": 1, + "maximum": 100, + "type": "number" + } + }, + { + "name": "sort", + "required": false, + "in": "query", + "description": "ุงู„ูุฑุฒ ุญุณุจ ุงู„ู…ุนู„ู…ุฉุŒ ูŠู…ูƒู† ุฃู† ูŠูƒูˆู† ู…ุนู„ู…ุฉ ูˆุงุญุฏุฉ ุฃูˆ ู‚ุงุฆู…ุฉ ู…ู† ุงู„ู…ุนู„ู…ุงุช ู…ูุตูˆู„ุฉ ุจูุงุตู„ุฉ", + "schema": { + "type": "array", + "items": { + "oneOf": [ + { + "const": "ownershipLastUpdateTime" + }, + { + "const": "name" + }, + { + "const": "collection.name" + }, + { + "const": "blockchainDescriptor" + } + ] + } + } + }, + { + "name": "order", + "required": false, + "in": "query", + "description": "ุงุชุฌุงู‡ ุงู„ุทู„ุจุŒ ูŠู…ูƒู† ุฃู† ูŠูƒูˆู† `ASC` ู„ู„ุชุตุงุนุฏูŠ ุฃูˆ `DESC` ู„ู„ุชู†ุงุฒู„ูŠ", + "schema": { + "oneOf": [ + { + "const": "DESC" + }, + { + "const": "ASC" + } + ] + } + }, + { + "name": "status", + "required": false, + "in": "query", + "description": "ุญุงู„ุฉ ู…ู„ูƒูŠุฉ ุงู„ุฑู…ุฒ", + "schema": { + "oneOf": [ + { + "const": "LISTED" + }, + { + "const": "ARCHIVED" + } + ] + } + }, + { + "name": "search", + "required": false, + "in": "query", + "description": "ุงุจุญุซ ุนู† ุงู„ุฑู…ูˆุฒ ุงู„ู…ู…ู„ูˆูƒุฉ ูˆู…ุฌู…ูˆุนุงุชู‡ุง. ุงู„ู…ุนุงูŠูŠุฑ ุงู„ู…ุญุชู…ู„ุฉ ู„ู„ุจุญุซ: ุงุณู… ุงู„ุฑู…ุฒ ูˆุงู„ู…ุนุฑู ุฏุงุฎู„ ุงู„ุนู‚ุฏ/ุงู„ู…ุฌู…ูˆุนุฉุŒ ูˆุงุณู… ุงู„ู…ุฌู…ูˆุนุฉุŒ ูˆูˆุตู ุณู„ุณู„ุฉ ุงู„ูƒุชู„ ูˆุงู„ุงุณู….", + "schema": { + "maximum": 100, + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "properties": { + "paging": { + "$ref": "#/components/schemas/Paging" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TokenOwnershipResponse" + } + } + } + } + } + } + } + }, + "tags": [ + "NFTs (Beta)" + ] + } + }, + "/nfts/ownership/collections": { + "get": { + "operationId": "listOwnedCollections", + "summary": "ู‚ุงุฆู…ุฉ ุงู„ู…ุฌู…ูˆุนุงุช ุงู„ู…ู…ู„ูˆูƒุฉ (ู…ู‚ุณู…ุฉ ุฅู„ู‰ ุตูุญุงุช)", + "description": "ูŠุนูŠุฏ ุฌู…ูŠุน ุงู„ู…ุฌู…ูˆุนุงุช ููŠ ู…ุณุงุญุฉ ุงู„ุนู…ู„ ุงู„ุฎุงุตุฉ ุจูƒ **ู…ู„ุงุญุธุฉ**: ู‡ุฐู‡ ุงู„ู†ู‚ุทุฉ ุงู„ู†ู‡ุงุฆูŠุฉ ููŠ ู…ุฑุญู„ุฉ ุชุฌุฑูŠุจูŠุฉ ุงู„ุขู†ุŒ ู…ุนุทู„ุฉ ู„ู„ุชูˆุงูุฑ ุงู„ุนุงู… ููŠ ู‡ุฐุง ุงู„ูˆู‚ุช. ู„ู„ุชุณุฌูŠู„ ููŠ ู…ุฑุญู„ุฉ ุชุฌุฑูŠุจูŠุฉ ูˆุชู…ูƒูŠู† ู‡ุฐู‡ ุงู„ู†ู‚ุทุฉ ุงู„ู†ู‡ุงุฆูŠุฉุŒ ุงุชุตู„ ุจู…ุฏูŠุฑ ู†ุฌุงุญ ุงู„ุนู…ู„ุงุก ููŠ Fireblocks ุฃูˆ ุชูˆุงุตู„ ู…ุน [CSM@fireblocks.com](mailto:CSM@fireblocks.com).", + "parameters": [ + { + "name": "search", + "required": false, + "in": "query", + "description": "ุงู„ุจุญุซ ุนู† ุงู„ู…ุฌู…ูˆุนุงุช ุงู„ู…ู…ู„ูˆูƒุฉ. ุงู„ู…ุนุงูŠูŠุฑ ุงู„ู…ุญุชู…ู„ุฉ ู„ู„ุจุญุซ: ุงุณู… ุงู„ู…ุฌู…ูˆุนุฉุŒ ุนู†ูˆุงู† ุนู‚ุฏ ุงู„ู…ุฌู…ูˆุนุฉ.", + "schema": { + "maximum": 100, + "type": "string" + } + }, + { + "name": "pageCursor", + "required": false, + "in": "query", + "description": "ู…ุคุดุฑ ุงู„ุตูุญุฉ ู„ุฌู„ุจู‡ุง", + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "required": false, + "in": "query", + "description": "ุงู„ุนู†ุงุตุฑ ููŠ ูƒู„ ุตูุญุฉ (ุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ 100)", + "schema": { + "minimum": 1, + "maximum": 100, + "type": "number" + } + }, + { + "name": "sort", + "required": false, + "in": "query", + "description": "ุงู„ูุฑุฒ ุญุณุจ ุงู„ู…ุนู„ู…ุฉุŒ ูŠู…ูƒู† ุฃู† ูŠูƒูˆู† ู…ุนู„ู…ุฉ ูˆุงุญุฏุฉ ุฃูˆ ู‚ุงุฆู…ุฉ ู…ู† ุงู„ู…ุนู„ู…ุงุช ู…ูุตูˆู„ุฉ ุจูุงุตู„ุฉ", + "schema": { + "type": "array", + "items": { + "const": "name" + } + } + }, + { + "name": "order", + "required": false, + "in": "query", + "description": "ุงุชุฌุงู‡ ุงู„ุทู„ุจุŒ ูŠู…ูƒู† ุฃู† ูŠูƒูˆู† `ASC` ู„ู„ุชุตุงุนุฏูŠ ุฃูˆ `DESC` ู„ู„ุชู†ุงุฒู„ูŠ", + "schema": { + "oneOf": [ + { + "const": "DESC" + }, + { + "const": "ASC" + } + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "properties": { + "paging": { + "$ref": "#/components/schemas/Paging" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CollectionOwnershipResponse" + } + } + } + } + } + } + } + }, + "tags": [ + "NFTs (Beta)" + ] + } + }, + "/nfts/tokens/{id}": { + "put": { + "operationId": "refreshNFTMetadata", + "summary": "ุชุญุฏูŠุซ ุจูŠุงู†ุงุช ุงู„ุชุนุฑูŠู ุงู„ุฎุงุตุฉ ุจุงู„ุฑู…ุฒ", + "description": "ุชุญุฏูŠุซ ุฃุญุฏุซ ุจูŠุงู†ุงุช ุงู„ุชุนุฑูŠู ุงู„ุฎุงุตุฉ ุจุงู„ุฑู…ุฒ. **ู…ู„ุงุญุธุฉ**: ู‡ุฐู‡ ุงู„ู†ู‚ุทุฉ ุงู„ู†ู‡ุงุฆูŠุฉ ููŠ ู…ุฑุญู„ุฉ ุชุฌุฑูŠุจูŠุฉ ุงู„ุขู†ุŒ ูˆู‡ูŠ ู…ุนุทู„ุฉ ู„ู„ุชูˆุงูุฑ ุงู„ุนุงู… ููŠ ู‡ุฐุง ุงู„ูˆู‚ุช. ู„ู„ุชุณุฌูŠู„ ููŠ ู…ุฑุญู„ุฉ ุชุฌุฑูŠุจูŠุฉ ูˆุชู…ูƒูŠู† ู‡ุฐู‡ ุงู„ู†ู‚ุทุฉ ุงู„ู†ู‡ุงุฆูŠุฉุŒ ุงุชุตู„ ุจู…ุฏูŠุฑ ู†ุฌุงุญ ุงู„ุนู…ู„ุงุก ููŠ Fireblocks ุฃูˆ ุชูˆุงุตู„ ู…ุนู‡ ุนู„ู‰ [CSM@fireblocks.com](mailto:CSM@fireblocks.com).", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "description": "ู…ุนุฑู NFT", + "example": "NFT-abcdefabcdefabcdefabcdefabcdefabcdefabcd", + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + } + }, + "tags": [ + "NFTs (Beta)" + ] + }, + "get": { + "operationId": "getNFT", + "summary": "ู‚ุงุฆู…ุฉ ุจูŠุงู†ุงุช ุงู„ุฑู…ุฒ ุญุณุจ ุงู„ู…ุนุฑู", + "description": "ูŠุนูŠุฏ ุจูŠุงู†ุงุช ุงู„ุฑู…ุฒ ุงู„ู…ุทู„ูˆุจุฉ. **ู…ู„ุงุญุธุฉ**: ู‡ุฐู‡ ุงู„ู†ู‚ุทุฉ ุงู„ู†ู‡ุงุฆูŠุฉ ููŠ ู…ุฑุญู„ุฉ ุชุฌุฑูŠุจูŠุฉ ุงู„ุขู†ุŒ ู…ุนุทู„ุฉ ู„ู„ุชูˆุงูุฑ ุงู„ุนุงู… ููŠ ู‡ุฐุง ุงู„ูˆู‚ุช. ู„ู„ุชุณุฌูŠู„ ููŠ ู…ุฑุญู„ุฉ ุชุฌุฑูŠุจูŠุฉ ูˆุชู…ูƒูŠู† ู‡ุฐู‡ ุงู„ู†ู‚ุทุฉ ุงู„ู†ู‡ุงุฆูŠุฉุŒ ุงุชุตู„ ุจู…ุฏูŠุฑ ู†ุฌุงุญ ุงู„ุนู…ู„ุงุก ููŠ Fireblocks ุฃูˆ ุชูˆุงุตู„ ู…ุน [CSM@fireblocks.com](mailto:CSM@fireblocks.com).", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "description": "ู…ุนุฑู NFT", + "example": "NFT-abcdefabcdefabcdefabcdefabcdefabcdefabcd", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TokenResponse" + } + } + } + } + }, + "tags": [ + "NFTs (Beta)" + ] + } + }, + "/nfts/tokens": { + "get": { + "operationId": "getNFTs", + "summary": "ู‚ุงุฆู…ุฉ ุงู„ุฑู…ูˆุฒ ุญุณุจ ุงู„ู…ุนุฑูุงุช", + "description": "ูŠุนูŠุฏ ุจูŠุงู†ุงุช ุงู„ุฑู…ูˆุฒ ุงู„ู…ุทู„ูˆุจุฉ **ู…ู„ุงุญุธุฉ**: ู‡ุฐู‡ ุงู„ู†ู‚ุทุฉ ุงู„ู†ู‡ุงุฆูŠุฉ ููŠ ู…ุฑุญู„ุฉ ุชุฌุฑูŠุจูŠุฉ ุงู„ุขู†ุŒ ู…ุนุทู„ุฉ ู„ู„ุชูˆุงูุฑ ุงู„ุนุงู… ููŠ ู‡ุฐุง ุงู„ูˆู‚ุช. ู„ู„ุชุณุฌูŠู„ ููŠ ู…ุฑุญู„ุฉ ุชุฌุฑูŠุจูŠุฉ ูˆุชู…ูƒูŠู† ู‡ุฐู‡ ุงู„ู†ู‚ุทุฉ ุงู„ู†ู‡ุงุฆูŠุฉุŒ ุงุชุตู„ ุจู…ุฏูŠุฑ ู†ุฌุงุญ ุงู„ุนู…ู„ุงุก ููŠ Fireblocks ุฃูˆ ุชูˆุงุตู„ ู…ุนู‡ ุนู„ู‰ [CSM@fireblocks.com](mailto:CSM@fireblocks.com).", + "parameters": [ + { + "name": "ids", + "required": true, + "in": "query", + "description": "ู‚ุงุฆู…ุฉ ู…ู†ูุตู„ุฉ ุจููˆุงุตู„ ู…ู† ู…ุนุฑูุงุช NFT. ูŠูุณู…ุญ ุจู…ุง ูŠุตู„ ุฅู„ู‰ 100 ููŠ ุทู„ุจ ูˆุงุญุฏ.", + "schema": { + "type": "string" + } + }, + { + "name": "pageCursor", + "required": false, + "in": "query", + "description": "ู…ุคุดุฑ ุงู„ุตูุญุฉ ู„ุฌู„ุจู‡ุง", + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "required": false, + "in": "query", + "description": "ุงู„ุนู†ุงุตุฑ ููŠ ูƒู„ ุตูุญุฉ (ุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ 100)", + "schema": { + "minimum": 1, + "maximum": 100, + "type": "number" + } + }, + { + "name": "sort", + "required": false, + "in": "query", + "description": "ุงู„ูุฑุฒ ุญุณุจ ุงู„ู…ุนู„ู…ุฉุŒ ูŠู…ูƒู† ุฃู† ูŠูƒูˆู† ู…ุนู„ู…ุฉ ูˆุงุญุฏุฉ ุฃูˆ ู‚ุงุฆู…ุฉ ู…ู† ุงู„ู…ุนู„ู…ุงุช ู…ูุตูˆู„ุฉ ุจูุงุตู„ุฉ", + "schema": { + "type": "array", + "items": { + "oneOf": [ + { + "const": "collection.name" + }, + { + "const": "name" + }, + { + "const": "blockchainDescriptor" + } + ] + } + } + }, + { + "name": "order", + "required": false, + "in": "query", + "description": "ุงุชุฌุงู‡ ุงู„ุทู„ุจุŒ ูŠู…ูƒู† ุฃู† ูŠูƒูˆู† `ASC` ู„ู„ุชุตุงุนุฏูŠ ุฃูˆ `DESC` ู„ู„ุชู†ุงุฒู„ูŠ", + "schema": { + "oneOf": [ + { + "const": "DESC" + }, + { + "const": "ASC" + } + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "properties": { + "paging": { + "$ref": "#/components/schemas/Paging" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TokenResponse" + } + } + } + } + } + } + } + }, + "tags": [ + "NFTs (Beta)" + ] + } + }, + "/nfts/ownership/tokens/{id}/status": { + "put": { + "operationId": "updateTokenOwnershipStatus", + "summary": "ุชุญุฏูŠุซ ุญุงู„ุฉ ู…ู„ูƒูŠุฉ ุงู„ุฑู…ุฒ", + "description": "ุชุญุฏูŠุซ ุญุงู„ุฉ ู…ู„ูƒูŠุฉ ุงู„ุฑู…ุฒ ู„ู„ู…ุณุชุฃุฌุฑุŒ ููŠ ุฌู…ูŠุน ุฎุฒุงุฆู† ุงู„ู…ุณุชุฃุฌุฑูŠู†. **ู…ู„ุงุญุธุฉ**: ู‡ุฐู‡ ุงู„ู†ู‚ุทุฉ ุงู„ู†ู‡ุงุฆูŠุฉ ุงู„ุขู† ููŠ ู…ุฑุญู„ุฉ ุชุฌุฑูŠุจูŠุฉุŒ ู…ุนุทู„ุฉ ู„ู„ุชูˆุงูุฑ ุงู„ุนุงู… ููŠ ู‡ุฐุง ุงู„ูˆู‚ุช. ู„ู„ุชุณุฌูŠู„ ููŠ ู…ุฑุญู„ุฉ ุชุฌุฑูŠุจูŠุฉ ูˆุชู…ูƒูŠู† ู‡ุฐู‡ ุงู„ู†ู‚ุทุฉ ุงู„ู†ู‡ุงุฆูŠุฉุŒ ุงุชุตู„ ุจู…ุฏูŠุฑ ู†ุฌุงุญ ุนู…ู„ุงุก Fireblocks ุฃูˆ ุชูˆุงุตู„ ู…ุน [CSM@fireblocks.com](mailto:CSM@fireblocks.com).", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "description": "ู…ุนุฑู NFT", + "example": "NFT-abcdefabcdefabcdefabcdefabcdefabcdefabcd", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateTokenOwnershipStatusDto" + } + } + } + }, + "responses": { + "200": { + "description": "", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + } + }, + "tags": [ + "NFTs (Beta)" + ] + } + }, + "/connections": { + "get": { + "operationId": "get", + "summary": "ู‚ุงุฆู…ุฉ ุจุฌู…ูŠุน ุงุชุตุงู„ุงุช Web3 ุงู„ู…ูุชูˆุญุฉ.", + "description": "ุงุญุตู„ ุนู„ู‰ ุงุชุตุงู„ุงุช Web3 ุงู„ู…ูุชูˆุญุฉ.", + "parameters": [ + { + "name": "order", + "required": false, + "in": "query", + "description": "ุชุฑุชูŠุจ ุงู„ู‚ุงุฆู…ุฉุ› ุชุตุงุนุฏูŠ ุฃูˆ ุชู†ุงุฒู„ูŠ.", + "schema": { + "oneOf": [ + { + "const": "ASC" + }, + { + "const": "DESC" + } + ] + } + }, + { + "name": "filter", + "required": false, + "in": "query", + "description": "ูƒุงุฆู† ู…ุฑุดุญ ู…ูุญู„ู„", + "examples": { + "object": { + "summary": "ูƒุงุฆู† ุงู„ูู„ุชุฑ", + "description": "", + "value": { + "id": "string", + "userId": "string", + "vaultAccountId": "number", + "connectionMethod": "string", + "feeLevel": "string", + "appUrl": "string", + "appName": "string" + } + }, + "stringified": { + "summary": "ุงู„ูƒุงุฆู† ุงู„ู…ูุณุฑ ุงู„ู…ุชุณู„ุณู„", + "description": "ุญูˆู„ ุงู„ูƒุงุฆู†ุงุช ุงู„ู…ุญู„ู„ุฉ ุนู„ู‰ ู‡ูŠุฆุฉ ุณู„ุณู„ุฉ ู†ุตูŠุฉ: * ูŠุชู… ูุตู„ ูƒู„ ุฒูˆุฌ ู…ู† ุงู„ู‚ูŠู…ุฉ ุงู„ุฑุฆูŠุณูŠุฉ ุจุนู„ุงู…ุฉ '='ุŒ ูˆูŠุชู… ูุตู„ ูƒู„ ุฒูˆุฌ ุจุนู„ุงู…ุฉ ',' (ูŠู…ูƒู†ูƒ ุงุณุชุฎุฏุงู… ุญุฒู…ุฉ [`qs`](https://www.npmjs.com/package/qs) ู„ู‡ุฐุง ุงู„ุบุฑุถ)", + "value": "id=string,userId=string,vaultAccountId=number,connectionMethod=string,feeLevel=string,appUrl=string,appName=string" + } + }, + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "userId": { + "type": "string" + }, + "vaultAccountId": { + "type": "number" + }, + "connectionMethod": { + "type": "string" + }, + "feeLevel": { + "type": "string" + }, + "appUrl": { + "type": "string" + }, + "appName": { + "type": "string" + } + } + } + }, + { + "name": "sort", + "required": false, + "in": "query", + "description": "ุฎุงุตูŠุฉ ูุฑุฒ ุงุชุตุงู„ุงุช Web3 ุญุณุจ.", + "schema": { + "oneOf": [ + { + "const": "id" + }, + { + "const": "userId" + }, + { + "const": "vaultAccountId" + }, + { + "const": "createdAt" + }, + { + "const": "feeLevel" + }, + { + "const": "appUrl" + }, + { + "const": "appName" + } + ] + } + }, + { + "name": "pageSize", + "required": false, + "in": "query", + "description": "ุนุฏุฏ ุงู„ู†ุชุงุฆุฌ ุงู„ุชูŠ ุณูŠุชู… ุฅุฑุฌุงุนู‡ุง ููŠ ุงู„ุตูุญุฉ ุงู„ุชุงู„ูŠุฉ.", + "schema": { + "type": "number", + "default": 10, + "maximum": 50 + } + }, + { + "name": "next", + "required": false, + "in": "query", + "description": "ุงู†ุชู‚ู„ ุฅู„ู‰ ุงู„ุตูุญุฉ ุงู„ุชุงู„ูŠุฉ", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetConnectionsResponse" + } + } + } + }, + "400": { + "description": "ู…ุนู„ู…ุงุช ุงู„ุงุณุชุนู„ุงู… ุบูŠุฑ ุตุงู„ุญุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + }, + "500": { + "description": "ู„ู‚ุฏ ุญุฏุซ ุฎุทุฃ ู…ุง", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + } + }, + "tags": [ + "Web3 connections" + ] + } + }, + "/connections/wc": { + "post": { + "operationId": "create", + "summary": "ุฅู†ุดุงุก ุงุชุตุงู„ Web3 ุฌุฏูŠุฏ.", + "description": "ุงุจุฏุฃ ุงุชุตุงู„ุงู‹ ุฌุฏูŠุฏู‹ุง ุจู€ Web3. * ู…ู„ุงุญุธุฉ: ุจุนุฏ ู†ุฌุงุญ ุฐู„ูƒุŒ ู‚ู… ุจุฅุฑุณุงู„ ุทู„ุจ ุฅู„ู‰ `PUT /v1/connections/wc/{id}` (ุฃุฏู†ุงู‡) ู„ู„ู…ูˆุงูู‚ุฉ ุนู„ู‰ ุงุชุตุงู„ Web3 ุงู„ุฌุฏูŠุฏ ุฃูˆ ุฑูุถู‡.", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateConnectionRequest" + } + } + } + }, + "responses": { + "201": { + "description": "ุชู… ุจุฏุก ุงุชุตุงู„ Web3 ุจู†ุฌุงุญ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateConnectionResponse" + } + } + } + }, + "400": { + "description": "ุชู… ุฅุฑุณุงู„ ุจูŠุงู†ุงุช ุบูŠุฑ ุตุงู„ุญุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + }, + "500": { + "description": "ู„ู‚ุฏ ุญุฏุซ ุฎุทุฃ ู…ุง", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + } + }, + "tags": [ + "Web3 connections" + ] + } + }, + "/connections/wc/{id}": { + "put": { + "operationId": "submit", + "summary": "ุงู„ุฑุฏ ุนู„ู‰ ุทู„ุจ ุงุชุตุงู„ Web3 ุงู„ู…ุนู„ู‚.", + "description": "ุฃุฑุณู„ ุงุณุชุฌุงุจุฉ ู„ู„ู…ูˆุงูู‚ุฉ ุฃูˆ ุงู„ุฑูุถ ู„ุงุชุตุงู„ Web3 ุงู„ุฐูŠ ุชู… ุงู„ุจุฏุก ููŠู‡. * ู…ู„ุงุญุธุฉ: ุชูุณุชุฎุฏู… ู‡ุฐู‡ ุงู„ู…ูƒุงู„ู…ุฉ ู„ุฅูƒู…ุงู„ ุทู„ุจ "POST /v1/connections/wc/". ุจุนุฏ ู†ุฌุงุญ ุฐู„ูƒุŒ ูŠุชู… ุฅู†ุดุงุก ุงุชุตุงู„ Web3 ุงู„ุฌุฏูŠุฏ ุงู„ุฎุงุต ุจูƒ ูˆุชุดุบูŠู„ู‡.", + "parameters": [ + { + "name": "id", + "description": "ู…ุนุฑู ุงุชุตุงู„ Web3 ุงู„ุฐูŠ ุชู… ุงู„ุจุฏุก ููŠู‡ ู„ู„ู…ูˆุงูู‚ุฉ ุนู„ูŠู‡.", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RespondToConnectionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "ุชู… ุฅุฑุณุงู„ ุงู„ุงุชุตุงู„ ุจู†ุฌุงุญ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + }, + "400": { + "description": "ุชู… ุฅุฑุณุงู„ ุจูŠุงู†ุงุช ุบูŠุฑ ุตุงู„ุญุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + }, + "404": { + "description": "ู„ู… ูŠุชู… ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุงุชุตุงู„", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + }, + "500": { + "description": "ู„ู‚ุฏ ุญุฏุซ ุฎุทุฃ ู…ุง", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + } + }, + "tags": [ + "Web3 connections" + ] + }, + "delete": { + "operationId": "remove", + "summary": "ุฅุฒุงู„ุฉ ุงุชุตุงู„ Web3 ุงู„ุญุงู„ูŠ.", + "description": "ุฅุฒุงู„ุฉ ุงุชุตุงู„ Web3", + "parameters": [ + { + "name": "id", + "description": "ู…ุนุฑู ุงุชุตุงู„ Web3 ุงู„ุญุงู„ูŠ ุงู„ู…ุฑุงุฏ ุฅุฒุงู„ุชู‡.", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "ุชู… ุฅุฒุงู„ุฉ ุงู„ุงุชุตุงู„ ุจู†ุฌุงุญ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + }, + "404": { + "description": "ู„ู… ูŠุชู… ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุงุชุตุงู„", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + }, + "500": { + "description": "ู„ู‚ุฏ ุญุฏุซ ุฎุทุฃ ู…ุง", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + } + } + }, + "tags": [ + "Web3 connections" + ] + } + }, + "/screening/travel_rule/transaction/validate": { + "post": { + "operationId": "TravelRuleApiController_validate", + "summary": "ุงู„ุชุญู‚ู‚ ู…ู† ุตุญุฉ ู…ุนุงู…ู„ุฉ ู‚ูˆุงุนุฏ ุงู„ุณูุฑ", + "description": "ุงู„ุชุญู‚ู‚ ู…ู† ุตุญุฉ ู…ุนุงู…ู„ุงุช ู‚ูˆุงุนุฏ ุงู„ุณูุฑ. ุงู„ุชุญู‚ู‚ ู…ู† ุชูุงุตูŠู„ ู…ุฒูˆุฏ ุฎุฏู…ุฉ ุงู„ุฃุตูˆู„ ุงู„ุงูุชุฑุงุถูŠุฉ ู„ู„ู…ุณุชููŠุฏ ุงู„ู…ุทู„ูˆุจุฉ ู…ู† ู‚ุจู„ ูˆู„ุงูŠุชูƒ ุงู„ู‚ุถุงุฆูŠุฉ ูˆูˆู„ุงูŠุฉ ุงู„ู…ุณุชููŠุฏ. **ู…ู„ุงุญุธุฉ:** ูŠูˆุซู‚ ู…ุญุชูˆู‰ ุงู„ู…ุฑุฌุน ููŠ ู‡ุฐุง ุงู„ู‚ุณู… ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ ุงู„ุฅุตุฏุงุฑ ุงู„ุชุฌุฑูŠุจูŠ ู„ู‚ูˆุงุนุฏ ุงู„ุณูุฑ. ุชุชุถู…ู† ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ ุงู„ุฅุตุฏุงุฑ ุงู„ุชุฌุฑูŠุจูŠ ูˆุงุฌู‡ุงุช ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ุงู„ุชูŠ ู‡ูŠ ุญุงู„ูŠู‹ุง ููŠ ู…ุฑุญู„ุฉ ุงู„ู…ุนุงูŠู†ุฉ ูˆู„ู… ุชุชูˆูุฑ ุจุนุฏ ุจุดูƒู„ ุนุงู…. ู„ู„ุชุณุฌูŠู„ ููŠ ุงู„ุฅุตุฏุงุฑ ุงู„ุชุฌุฑูŠุจูŠ ูˆุชู…ูƒูŠู† ู†ู‚ุทุฉ ุงู„ู†ู‡ุงูŠุฉ ู‡ุฐู‡ุŒ ุงุชุตู„ ุจู…ุฏูŠุฑ ู†ุฌุงุญ ุนู…ู„ุงุก Fireblocks ุฃูˆ ุฃุฑุณู„ ุจุฑูŠุฏู‹ุง ุฅู„ูƒุชุฑูˆู†ูŠู‹ุง ุฅู„ู‰ [CSM@fireblocks.com](mailto:CSM@fireblocks.com).", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TravelRuleValidateTransactionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "ุชู… ุงู„ุชุญู‚ู‚ ู…ู† ุตุญุฉ ุงู„ู…ุนุงู…ู„ุฉ ุจู†ุฌุงุญ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TravelRuleValidateTransactionResponse" + } + } + } + }, + "400": { + "description": "ู†ุต ุงู„ุทู„ุจ ุบูŠุฑ ุตุงู„ุญ" + }, + "500": { + "description": "ุฎุทุฃ ููŠ ุงู„ุฎุงุฏู… ุงู„ุฏุงุฎู„ูŠ" + } + }, + "tags": [ + "Travel Rule (Beta)" + ] + } + }, + "/screening/travel_rule/transaction/validate/full": { + "post": { + "operationId": "TravelRuleApiController_validateFull", + "summary": "ุงู„ุชุญู‚ู‚ ู…ู† ุตุญุฉ ู…ุนุงู…ู„ุฉ ู‚ุงุนุฏุฉ ุงู„ุณูุฑ ุงู„ูƒุงู…ู„ุฉ", + "description": "ุงู„ุชุญู‚ู‚ ู…ู† ุตุญุฉ ู…ุนุงู…ู„ุงุช ู‚ุงุนุฏุฉ ุงู„ุณูุฑ ุงู„ูƒุงู…ู„ุฉ. ุงู„ุชุญู‚ู‚ ู…ู† ุฌู…ูŠุน ุงู„ู…ุนู„ูˆู…ุงุช ุงู„ู…ุทู„ูˆุจุฉ ุนู† ู…ู‚ุฏู…ูŠ ุฎุฏู…ุงุช ุงู„ุฃุตูˆู„ ุงู„ุงูุชุฑุงุถูŠุฉ ุงู„ู…ุณุชููŠุฏูŠู† ูˆุงู„ู…ู†ุดุฆูŠู†. **ู…ู„ุงุญุธุฉ:** ูŠูˆุซู‚ ู…ุญุชูˆู‰ ุงู„ู…ุฑุฌุน ููŠ ู‡ุฐุง ุงู„ู‚ุณู… ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ ุงู„ุฅุตุฏุงุฑ ุงู„ุชุฌุฑูŠุจูŠ ู„ู‚ุงุนุฏุฉ ุงู„ุณูุฑ. ุชุชุถู…ู† ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ ุงู„ุฅุตุฏุงุฑ ุงู„ุชุฌุฑูŠุจูŠ ูˆุงุฌู‡ุงุช ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ุงู„ุชูŠ ู‡ูŠ ุญุงู„ูŠู‹ุง ููŠ ู…ุฑุญู„ุฉ ุงู„ู…ุนุงูŠู†ุฉ ูˆู„ู… ุชุชูˆูุฑ ุจุนุฏ ุจุดูƒู„ ุนุงู…. ู„ู„ุชุณุฌูŠู„ ููŠ ุงู„ุฅุตุฏุงุฑ ุงู„ุชุฌุฑูŠุจูŠ ูˆุชู…ูƒูŠู† ู†ู‚ุทุฉ ุงู„ู†ู‡ุงูŠุฉ ู‡ุฐู‡ุŒ ุงุชุตู„ ุจู…ุฏูŠุฑ ู†ุฌุงุญ ุงู„ุนู…ู„ุงุก ููŠ Fireblocks ุฃูˆ ุฃุฑุณู„ ุจุฑูŠุฏู‹ุง ุฅู„ูƒุชุฑูˆู†ูŠู‹ุง ุฅู„ู‰ [CSM@fireblocks.com](mailto:CSM@fireblocks.com).", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TravelRuleValidateFullTransactionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "ุชู… ุงู„ุชุญู‚ู‚ ู…ู† ุตุญุฉ ุงู„ู…ุนุงู…ู„ุฉ ุจู†ุฌุงุญ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TravelRuleValidateTransactionResponse" + } + } + } + }, + "400": { + "description": "ู†ุต ุงู„ุทู„ุจ ุบูŠุฑ ุตุงู„ุญ" + }, + "500": { + "description": "ุฎุทุฃ ููŠ ุงู„ุฎุงุฏู… ุงู„ุฏุงุฎู„ูŠ" + } + }, + "tags": [ + "Travel Rule (Beta)" + ] + } + }, + "/screening/travel_rule/vasp/{did}": { + "get": { + "operationId": "TravelRuleApiController_findVasp", + "summary": "ุงุญุตู„ ุนู„ู‰ ุชูุงุตูŠู„ VASP", + "description": "ุงุญุตู„ ุนู„ู‰ ุชูุงุตูŠู„ VASP. ูŠุนูŠุฏ ู…ุนู„ูˆู…ุงุช ุญูˆู„ VASP ุงู„ุฐูŠ ู„ุฏูŠู‡ DID ุงู„ู…ุญุฏุฏ. **ู…ู„ุงุญุธุฉ:** ูŠูˆุซู‚ ู…ุญุชูˆู‰ ุงู„ู…ุฑุฌุน ููŠ ู‡ุฐุง ุงู„ู‚ุณู… ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ ุงู„ุฅุตุฏุงุฑ ุงู„ุชุฌุฑูŠุจูŠ ู„ู‚ุงุนุฏุฉ ุงู„ุณูุฑ. ุชุชุถู…ู† ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ ุงู„ุฅุตุฏุงุฑ ุงู„ุชุฌุฑูŠุจูŠ ูˆุงุฌู‡ุงุช ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ุงู„ุชูŠ ู‡ูŠ ุญุงู„ูŠู‹ุง ููŠ ุงู„ู…ุนุงูŠู†ุฉ ูˆู„ู… ุชุชูˆูุฑ ุจุนุฏ ุจุดูƒู„ ุนุงู…. ู„ู„ุชุณุฌูŠู„ ููŠ ุงู„ุฅุตุฏุงุฑ ุงู„ุชุฌุฑูŠุจูŠ ูˆุชู…ูƒูŠู† ู†ู‚ุทุฉ ุงู„ู†ู‡ุงูŠุฉ ู‡ุฐู‡ุŒ ุงุชุตู„ ุจู…ุฏูŠุฑ ู†ุฌุงุญ ุนู…ู„ุงุก Fireblocks ุฃูˆ ุฃุฑุณู„ ุจุฑูŠุฏู‹ุง ุฅู„ูƒุชุฑูˆู†ูŠู‹ุง ุฅู„ู‰ [CSM@fireblocks.com](mailto:CSM@fireblocks.com).", + "parameters": [ + { + "name": "did", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + }, + { + "name": "fields", + "required": false, + "in": "query", + "description": "ู…ู„ู CSV ู„ู„ุญู‚ูˆู„ ุงู„ู…ุฑุงุฏ ุฅุฑุฌุงุนู‡ุง (ุงู„ูƒู„ุŒ "ูุงุฑุบ" ุฃูˆ ุฑุงุฌุน ู‚ุงุฆู…ุฉ ุฌู…ูŠุน ุฃุณู…ุงุก ุงู„ุญู‚ูˆู„ ุฃุฏู†ุงู‡)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "ุชู… ุงู„ุชุญู‚ู‚ ู…ู† ุตุญุฉ ุงู„ู…ุนุงู…ู„ุฉ ุจู†ุฌุงุญ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TravelRuleVASP" + } + } + } + }, + "400": { + "description": "ู†ุต ุงู„ุทู„ุจ ุบูŠุฑ ุตุงู„ุญ" + }, + "500": { + "description": "ุฎุทุฃ ููŠ ุงู„ุฎุงุฏู… ุงู„ุฏุงุฎู„ูŠ" + } + }, + "tags": [ + "Travel Rule (Beta)" + ] + } + }, + "/screening/travel_rule/vasp": { + "get": { + "operationId": "TravelRuleApiController_findAllVasp", + "summary": "ุงุญุตู„ ุนู„ู‰ ุฌู…ูŠุน ู…ุฒูˆุฏูŠ ุฎุฏู…ุงุช ุงู„ุฃุตูˆู„ ุงู„ุงูุชุฑุงุถูŠุฉ", + "description": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุฌู…ูŠุน ู…ุฒูˆุฏูŠ ุฎุฏู…ุงุช VASP. ูŠุนูŠุฏ ู‚ุงุฆู…ุฉ ุจู…ุฒูˆุฏูŠ ุฎุฏู…ุงุช VASP. ูŠู…ูƒู† ุงู„ุจุญุซ ุนู† ู…ุฒูˆุฏูŠ ุฎุฏู…ุงุช VASP ูˆูุฑุฒู‡ุง ูˆุชุตู†ูŠู ุงู„ู†ุชุงุฆุฌ. **ู…ู„ุงุญุธุฉ:** ูŠูˆุซู‚ ู…ุญุชูˆู‰ ุงู„ู…ุฑุฌุน ููŠ ู‡ุฐุง ุงู„ู‚ุณู… ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ ุงู„ุฅุตุฏุงุฑ ุงู„ุชุฌุฑูŠุจูŠ ู„ู‚ุงุนุฏุฉ ุงู„ุณูุฑ. ุชุชุถู…ู† ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ ุงู„ุฅุตุฏุงุฑ ุงู„ุชุฌุฑูŠุจูŠ ูˆุงุฌู‡ุงุช ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ุงู„ุชูŠ ู‡ูŠ ุญุงู„ูŠู‹ุง ููŠ ู…ุฑุญู„ุฉ ุงู„ู…ุนุงูŠู†ุฉ ูˆู„ู… ุชุชูˆูุฑ ุจุนุฏ ุจุดูƒู„ ุนุงู…. ู„ู„ุชุณุฌูŠู„ ููŠ ุงู„ุฅุตุฏุงุฑ ุงู„ุชุฌุฑูŠุจูŠ ูˆุชู…ูƒูŠู† ู†ู‚ุทุฉ ุงู„ู†ู‡ุงูŠุฉ ู‡ุฐู‡ุŒ ุงุชุตู„ ุจู…ุฏูŠุฑ ู†ุฌุงุญ ุนู…ู„ุงุก Fireblocks ุฃูˆ ุฃุฑุณู„ ุจุฑูŠุฏู‹ุง ุฅู„ูƒุชุฑูˆู†ูŠู‹ุง ุฅู„ู‰ [CSM@fireblocks.com](mailto:CSM@fireblocks.com).", + "parameters": [ + { + "name": "order", + "required": false, + "in": "query", + "description": "ุงู„ุญู‚ู„ ุงู„ู…ุทู„ูˆุจ ุงู„ุทู„ุจ ุนู„ูŠู‡", + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "required": false, + "in": "query", + "description": "ุนุฏุฏ ุงู„ุณุฌู„ุงุช ููŠ ูƒู„ ุตูุญุฉ", + "schema": { + "type": "number" + } + }, + { + "name": "page", + "required": false, + "in": "query", + "description": "ุฑู‚ู… ุงู„ุตูุญุฉ", + "schema": { + "type": "number" + } + }, + { + "name": "fields", + "required": false, + "in": "query", + "description": "ู…ู„ู CSV ู„ู„ุญู‚ูˆู„ ุงู„ู…ุฑุงุฏ ุฅุฑุฌุงุนู‡ุง (ุงู„ูƒู„ุŒ "ูุงุฑุบ" ุฃูˆ ุฑุงุฌุน ู‚ุงุฆู…ุฉ ุฌู…ูŠุน ุฃุณู…ุงุก ุงู„ุญู‚ูˆู„ ุฃุฏู†ุงู‡)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "ุงุญุตู„ ุนู„ู‰ ุฌู…ูŠุน VASPs", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TravelRuleGetAllVASPsResponse" + } + } + } + } + }, + "tags": [ + "Travel Rule (Beta)" + ] + } + }, + "/screeening/travel_rule/vasp/update": { + "put": { + "operationId": "TravelRuleApiController_updateVasp", + "summary": "ุฅุถุงูุฉ jsonDidKey ุฅู„ู‰ ุชูุงุตูŠู„ VASP", + "description": "ุชุญุฏูŠุซ ุชูุงุตูŠู„ VASP. ุชุญุฏูŠุซ VASP ุจุงู„ู…ุนู„ู…ุงุช ุงู„ู…ู‚ุฏู…ุฉ. ุงุณุชุฎุฏู… ู†ู‚ุทุฉ ุงู„ู†ู‡ุงูŠุฉ ู‡ุฐู‡ ู„ุฅุถุงูุฉ jsonDIDkey ุงู„ุนุงู… ุงู„ุฐูŠ ุชู… ุฅู†ุดุงุคู‡ ุจูˆุงุณุทุฉ Notabene. **ู…ู„ุงุญุธุฉ:** ูŠูˆุซู‚ ู…ุญุชูˆู‰ ุงู„ู…ุฑุฌุน ููŠ ู‡ุฐุง ุงู„ู‚ุณู… ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ ุงู„ุฅุตุฏุงุฑ ุงู„ุชุฌุฑูŠุจูŠ ู„ู‚ุงุนุฏุฉ ุงู„ุณูุฑ. ุชุชุถู…ู† ู†ู‚ุทุฉ ุงู„ู†ู‡ุงูŠุฉ ุงู„ุชุฌุฑูŠุจูŠุฉ ูˆุงุฌู‡ุงุช ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ุงู„ุชูŠ ู‡ูŠ ุญุงู„ูŠู‹ุง ููŠ ุงู„ู…ุนุงูŠู†ุฉ ูˆู„ู… ุชุชูˆูุฑ ุจุนุฏ ุจุดูƒู„ ุนุงู…. ู„ู„ุชุณุฌูŠู„ ููŠ ุงู„ุฅุตุฏุงุฑ ุงู„ุชุฌุฑูŠุจูŠ ูˆุชู…ูƒูŠู† ู†ู‚ุทุฉ ุงู„ู†ู‡ุงูŠุฉ ู‡ุฐู‡ุŒ ุงุชุตู„ ุจู…ุฏูŠุฑ ู†ุฌุงุญ ุนู…ู„ุงุก Fireblocks ุฃูˆ ุฃุฑุณู„ ุจุฑูŠุฏู‹ุง ุฅู„ูƒุชุฑูˆู†ูŠู‹ุง ุฅู„ู‰ [CSM@fireblocks.com](mailto:CSM@fireblocks.com).", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TravelRuleUpdateVASPDetails" + } + } + } + }, + "responses": { + "200": { + "description": "ุชู… ุชุญุฏูŠุซ VASP ุจู†ุฌุงุญ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TravelRuleUpdateVASPDetails" + } + } + } + }, + "400": { + "description": "ู†ุต ุงู„ุทู„ุจ ุบูŠุฑ ุตุงู„ุญ" + }, + "500": { + "description": "ุฎุทุฃ ููŠ ุงู„ุฎุงุฏู… ุงู„ุฏุงุฎู„ูŠ" + } + }, + "tags": [ + "Travel Rule (Beta)" + ] + } + }, + "/tap/active_policy": { + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ุงู„ุณูŠุงุณุฉ ุงู„ู†ุดุทุฉ ูˆุตู„ุงุญูŠุชู‡ุง", + "description": "ุฅุฑุฌุงุน ุงู„ุณูŠุงุณุฉ ุงู„ู†ุดุทุฉ ูˆุตู„ุงุญูŠุชู‡ุง.
**ู…ู„ุงุญุธุฉ:** ู‡ุฐู‡ ุงู„ู†ู‚ุงุท ุงู„ู†ู‡ุงุฆูŠุฉ ููŠ ู…ุฑุญู„ุฉ ุชุฌุฑูŠุจูŠุฉ ุญุงู„ูŠู‹ุง ูˆู‚ุฏ ุชุฎุถุน ู„ู„ุชุบูŠูŠุฑุงุช. ุฅุฐุง ูƒู†ุช ุชุฑุบุจ ููŠ ุงู„ู…ุดุงุฑูƒุฉ ูˆู…ุนุฑูุฉ ุงู„ู…ุฒูŠุฏ ุนู† Fireblocks TAPุŒ ููŠุฑุฌู‰ ุงู„ุงุชุตุงู„ ุจู…ุฏูŠุฑ ู†ุฌุงุญ ุงู„ุนู…ู„ุงุก ููŠ Fireblocks ุฃูˆ ุฅุฑุณุงู„ ุจุฑูŠุฏ ุฅู„ูƒุชุฑูˆู†ูŠ ุฅู„ู‰ CSM@fireblocks.com.", + "tags": [ + "Policy Editor (Beta)" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "policy = fireblocks.get_active_policy()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const policy = await fireblocks.getActivePolicy();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "ูƒุงุฆู† ุงู„ุณูŠุงุณุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PolicyAndValidationResponse" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/tap/draft": { + "get": { + "summary": "ุงุญุตู„ ุนู„ู‰ ุงู„ู…ุณูˆุฏุฉ ุงู„ู†ุดุทุฉ", + "description": "ุฅุฑุฌุงุน ุงู„ู…ุณูˆุฏุฉ ุงู„ู†ุดุทุฉ ูˆุตู„ุงุญูŠุชู‡ุง.
**ู…ู„ุงุญุธุฉ:** ู‡ุฐู‡ ุงู„ู†ู‚ุงุท ุงู„ู†ู‡ุงุฆูŠุฉ ููŠ ู…ุฑุญู„ุฉ ุชุฌุฑูŠุจูŠุฉ ุญุงู„ูŠู‹ุง ูˆู‚ุฏ ุชุฎุถุน ู„ู„ุชุบูŠูŠุฑุงุช. ุฅุฐุง ูƒู†ุช ุชุฑุบุจ ููŠ ุงู„ู…ุดุงุฑูƒุฉ ูˆู…ุนุฑูุฉ ุงู„ู…ุฒูŠุฏ ุนู† Fireblocks TAPุŒ ููŠุฑุฌู‰ ุงู„ุงุชุตุงู„ ุจู…ุฏูŠุฑ ู†ุฌุงุญ ุงู„ุนู…ู„ุงุก ููŠ Fireblocks ุฃูˆ ุฅุฑุณุงู„ ุจุฑูŠุฏ ุฅู„ูƒุชุฑูˆู†ูŠ ุฅู„ู‰ CSM@fireblocks.com.", + "tags": [ + "Policy Editor (Beta)" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "policy = fireblocks.get_draft()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const policy = await fireblocks.getDraft();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "ูƒุงุฆู† ุงุณุชุฌุงุจุฉ ุงู„ุชุญู‚ู‚ ู…ู† ุงู„ู…ุณูˆุฏุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/DraftReviewAndValidationResponse" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "put": { + "summary": "ุชุญุฏูŠุซ ุงู„ู…ุณูˆุฏุฉ ุจู…ุฌู…ูˆุนุฉ ุฌุฏูŠุฏุฉ ู…ู† ุงู„ู‚ูˆุงุนุฏ", + "description": "ุชุญุฏูŠุซ ุงู„ู…ุณูˆุฏุฉ ูˆุฅุฑุฌุงุน ุงู„ุชุญู‚ู‚ ู…ู†ู‡ุง.
**ู…ู„ุงุญุธุฉ:** ู‡ุฐู‡ ุงู„ู†ู‚ุงุท ุงู„ู†ู‡ุงุฆูŠุฉ ููŠ ู…ุฑุญู„ุฉ ุชุฌุฑูŠุจูŠุฉ ุญุงู„ูŠู‹ุง ูˆู‚ุฏ ุชุฎุถุน ู„ู„ุชุบูŠูŠุฑุงุช. ุฅุฐุง ูƒู†ุช ุชุฑุบุจ ููŠ ุงู„ู…ุดุงุฑูƒุฉ ูˆู…ุนุฑูุฉ ุงู„ู…ุฒูŠุฏ ุนู† Fireblocks TAPุŒ ููŠุฑุฌู‰ ุงู„ุงุชุตุงู„ ุจู…ุฏูŠุฑ ู†ุฌุงุญ ุงู„ุนู…ู„ุงุก ููŠ Fireblocks ุฃูˆ ุฅุฑุณุงู„ ุจุฑูŠุฏ ุฅู„ูƒุชุฑูˆู†ูŠ ุฅู„ู‰ CSM@fireblocks.com.", + "tags": [ + "Policy Editor (Beta)" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "policy = fireblocks.update_draft()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const policy = await fireblocks.updateDraft();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "rules": { + "description": "ู‚ูˆุงุนุฏ ู„ุชุญุฏูŠุซ ุงู„ู…ุณูˆุฏุฉ ู…ุน", + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicyRule" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "ูƒุงุฆู† ุงุณุชุฌุงุจุฉ ุงู„ุชุญู‚ู‚ ู…ู† ุงู„ู…ุณูˆุฏุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/DraftReviewAndValidationResponse" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "ุฅุฑุณุงู„ ุทู„ุจ ู†ุดุฑ ู„ู…ุนุฑู ู…ุณูˆุฏุฉ ู…ุนูŠู†", + "description": "ุฅุฑุณุงู„ ุทู„ุจ ู†ุดุฑ ู„ู…ุนุฑู ู…ุณูˆุฏุฉ ู…ุนูŠู† ูˆุฅุฑุฌุงุน ุงู„ุงุณุชุฌุงุจุฉ.
**ู…ู„ุงุญุธุฉ:** ู‡ุฐู‡ ุงู„ู†ู‚ุงุท ุงู„ู†ู‡ุงุฆูŠุฉ ููŠ ู…ุฑุญู„ุฉ ุชุฌุฑูŠุจูŠุฉ ุญุงู„ูŠู‹ุง ูˆู‚ุฏ ุชุฎุถุน ู„ู„ุชุบูŠูŠุฑุงุช. ุฅุฐุง ูƒู†ุช ุชุฑุบุจ ููŠ ุงู„ู…ุดุงุฑูƒุฉ ูˆู…ุนุฑูุฉ ุงู„ู…ุฒูŠุฏ ุนู† Fireblocks TAPุŒ ููŠุฑุฌู‰ ุงู„ุงุชุตุงู„ ุจู…ุฏูŠุฑ ู†ุฌุงุญ ุงู„ุนู…ู„ุงุก ููŠ Fireblocks ุฃูˆ ุฅุฑุณุงู„ ุจุฑูŠุฏ ุฅู„ูƒุชุฑูˆู†ูŠ ุฅู„ู‰ CSM@fireblocks.com.", + "tags": [ + "Policy Editor (Beta)" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "policy = fireblocks.publish_draft()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const policy = await fireblocks.publishDraft();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "draftId": { + "description": "ู…ุณูˆุฏุฉ ู…ุนุฑู ูุฑูŠุฏ", + "type": "string" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "ูƒุงุฆู† ู†ุชูŠุฌุฉ ู†ุดุฑ ุงู„ุณูŠุงุณุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PublishResult" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/tap/publish": { + "post": { + "summary": "ุฅุฑุณุงู„ ุทู„ุจ ู†ุดุฑ ู„ู…ุฌู…ูˆุนุฉ ู…ู† ู‚ูˆุงุนุฏ ุงู„ุณูŠุงุณุฉ", + "description": "ุฅุฑุณุงู„ ุทู„ุจ ู†ุดุฑ ู„ู…ุฌู…ูˆุนุฉ ู…ู† ู‚ูˆุงุนุฏ ุงู„ุณูŠุงุณุฉ ูˆุฅุฑุฌุงุน ุงู„ุงุณุชุฌุงุจุฉ.
**ู…ู„ุงุญุธุฉ:** ู‡ุฐู‡ ุงู„ู†ู‚ุงุท ุงู„ู†ู‡ุงุฆูŠุฉ ููŠ ู…ุฑุญู„ุฉ ุชุฌุฑูŠุจูŠุฉ ุญุงู„ูŠู‹ุง ูˆู‚ุฏ ุชุฎุถุน ู„ู„ุชุบูŠูŠุฑุงุช. ุฅุฐุง ูƒู†ุช ุชุฑุบุจ ููŠ ุงู„ู…ุดุงุฑูƒุฉ ูˆู…ุนุฑูุฉ ุงู„ู…ุฒูŠุฏ ุนู† Fireblocks TAPุŒ ููŠุฑุฌู‰ ุงู„ุงุชุตุงู„ ุจู…ุฏูŠุฑ ู†ุฌุงุญ ุงู„ุนู…ู„ุงุก ููŠ Fireblocks ุฃูˆ ุฅุฑุณุงู„ ุจุฑูŠุฏ ุฅู„ูƒุชุฑูˆู†ูŠ ุฅู„ู‰ CSM@fireblocks.com.", + "tags": [ + "Policy Editor (Beta)" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "policy = fireblocks.publish_rules()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const policy = await fireblocks.publishRules();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "rules": { + "description": "ู‚ูˆุงุนุฏ ุงู„ุณูŠุงุณุฉ ู„ู„ู†ุดุฑ", + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicyRule" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "ูƒุงุฆู† ู†ุชูŠุฌุฉ ู†ุดุฑ ุงู„ุณูŠุงุณุฉ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PublishResult" + } + } + } + }, + "default": { + "description": "ุงุณุชุฌุงุจุฉ ุงู„ุฎุทุฃ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "ู…ุนุฑู ูุฑูŠุฏ ู…ุฑุชุจุท ุจุทู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช. ูŠูุฑุฌู‰ ุชู‚ุฏูŠู…ู‡ ููŠ ุฃูŠ ุชุฐูƒุฑุฉ ุฏุนู… ุชู†ุดุฆู‡ุง ุฃูˆ ููŠ ู…ุดูƒู„ุงุช Github ุงู„ู…ุชุนู„ู‚ุฉ ุจู…ุฌู…ูˆุนุงุช ุชุทูˆูŠุฑ ุงู„ุจุฑุงู…ุฌ Fireblocks", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "MediaEntityResponse": { + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "ุนู†ูˆุงู† URL ุงู„ู…ุฎุฒู† ู…ุคู‚ุชู‹ุง" + }, + "contentType": { + "oneOf": [ + { + "const": "IMAGE" + }, + { + "const": "VIDEO" + }, + { + "const": "ANIMATION" + }, + { + "const": "THREE_D" + }, + { + "const": "TEXT" + }, + { + "const": "GIF" + }, + { + "const": "UNKNOWN_TYPE" + }, + { + "const": "SVG" + }, + { + "const": "AUDIO" + } + ], + "description": "ู†ูˆุน ุงู„ูˆุณุงุฆุท" + } + }, + "required": [ + "url", + "contentType" + ] + }, + "TokenCollectionResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "symbol": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "symbol" + ] + }, + "TokenResponse": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ู…ุนุฑู ุฃุตู„ Fireblocks NFT" + }, + "tokenId": { + "type": "string", + "description": "ู…ุนุฑู ุงู„ุฑู…ุฒ ุงู„ู…ู…ูŠุฒ ุถู…ู† ุงู„ุนู‚ุฏ/ุงู„ู…ุฌู…ูˆุนุฉ" + }, + "standard": { + "type": "string", + "description": "ERC721 / ERC1155" + }, + "metadataURI": { + "type": "string", + "description": "ุนู†ูˆุงู† URL ู„ุจูŠุงู†ุงุช JSON ุงู„ูˆุตููŠุฉ ุงู„ุฃุตู„ูŠุฉ ู„ู„ุฑู…ุฒ" + }, + "cachedMetadataURI": { + "type": "string", + "description": "ุนู†ูˆุงู† URL ู„ุจูŠุงู†ุงุช JSON ุงู„ูˆุตููŠุฉ ุงู„ู…ุฎุฒู†ุฉ ู…ุคู‚ุชู‹ุง" + }, + "media": { + "description": "ุนู†ุงุตุฑ ุงู„ูˆุณุงุฆุท ุงู„ู…ุณุชุฎุฑุฌุฉ ู…ู† ุงู„ุจูŠุงู†ุงุช ุงู„ูˆุตููŠุฉ JSON", + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaEntityResponse" + } + }, + "collection": { + "description": "ู…ุนู„ูˆู…ุงุช ุฌู…ุน ุงู„ูˆุงู„ุฏูŠู†", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "symbol": { + "type": "string" + } + } + }, + "blockchainDescriptor": { + "oneOf": [ + { + "const": "ETH" + }, + { + "const": "ETH_TEST3" + }, + { + "const": "POLYGON" + }, + { + "const": "POLYGON_TEST_MUMBAI" + } + ] + }, + "description": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "tokenId", + "standard", + "media", + "blockchainDescriptor", + "description", + "name" + ] + }, + "UpdateTokenOwnershipStatusDto": { + "type": "object", + "properties": { + "status": { + "oneOf": [ + { + "const": "LISTED" + }, + { + "const": "ARCHIVED" + } + ] + } + }, + "required": [ + "status" + ] + }, + "Paging": { + "type": "object", + "properties": { + "next": { + "type": "string", + "description": "ุงู†ุชู‚ู„ ุฅู„ู‰ ุงู„ุตูุญุฉ ุงู„ุชุงู„ูŠุฉ" + } + }, + "required": [ + "next" + ] + }, + "TokenOwnershipResponse": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ู…ุนุฑู ุฃุตู„ Fireblocks NFT" + }, + "tokenId": { + "type": "string", + "description": "ู…ุนุฑู ุงู„ุฑู…ุฒ ุงู„ู…ู…ูŠุฒ ุถู…ู† ุงู„ุนู‚ุฏ/ุงู„ู…ุฌู…ูˆุนุฉ" + }, + "standard": { + "type": "string", + "description": "ERC721 / ERC1155" + }, + "metadataURI": { + "type": "string", + "description": "ุนู†ูˆุงู† URL ู„ุจูŠุงู†ุงุช JSON ุงู„ูˆุตููŠุฉ ุงู„ุฃุตู„ูŠุฉ ู„ู„ุฑู…ุฒ" + }, + "cachedMetadataURI": { + "type": "string", + "description": "ุนู†ูˆุงู† URL ู„ุจูŠุงู†ุงุช JSON ุงู„ูˆุตููŠุฉ ุงู„ู…ุฎุฒู†ุฉ ู…ุคู‚ุชู‹ุง" + }, + "media": { + "description": "ุนู†ุงุตุฑ ุงู„ูˆุณุงุฆุท ุงู„ู…ุณุชุฎุฑุฌุฉ ู…ู† ุงู„ุจูŠุงู†ุงุช ุงู„ูˆุตููŠุฉ JSON", + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaEntityResponse" + } + }, + "collection": { + "description": "ู…ุนู„ูˆู…ุงุช ุฌู…ุน ุงู„ูˆุงู„ุฏูŠู†", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "symbol": { + "type": "string" + } + } + }, + "balance": { + "type": "string" + }, + "vaultAccountId": { + "type": "string" + }, + "ownershipStartTime": { + "type": "number" + }, + "ownershipLastUpdateTime": { + "type": "number" + }, + "blockchainDescriptor": { + "oneOf": [ + { + "const": "ETH" + }, + { + "const": "ETH_TEST3" + }, + { + "const": "POLYGON" + }, + { + "const": "POLYGON_TEST_MUMBAI" + } + ] + }, + "description": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "tokenId", + "standard", + "media", + "balance", + "vaultAccountId", + "ownershipStartTime", + "ownershipLastUpdateTime", + "blockchainDescriptor", + "description", + "name" + ] + }, + "CollectionOwnershipResponse": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ู…ุนุฑู ู…ุฌู…ูˆุนุฉ Fireblocks" + }, + "name": { + "type": "string", + "description": "ุงุณู… ุงู„ู…ุฌู…ูˆุนุฉ" + }, + "symbol": { + "type": "string", + "description": "ุฑู…ุฒ ุงู„ู…ุฌู…ูˆุนุฉ" + }, + "standard": { + "type": "string", + "description": "ู…ุนูŠุงุฑ ุนู‚ุฏ ุงู„ุชุญุตูŠู„" + }, + "blockchainDescriptor": { + "oneOf": [ + { + "const": "ETH" + }, + { + "const": "ETH_TEST3" + }, + { + "const": "POLYGON" + }, + { + "const": "POLYGON_TEST_MUMBAI" + } + ], + "description": "ุณู„ุณู„ุฉ ุงู„ูƒุชู„ ู„ู„ู…ุฌู…ูˆุนุฉ" + }, + "contractAddress": { + "type": "string", + "description": "ู…ุนูŠุงุฑ ุนู‚ุฏ ุงู„ุชุญุตูŠู„" + } + }, + "required": [ + "id", + "name", + "symbol", + "blockchainDescriptor" + ] + }, + "WalletAsset": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "balance": { + "type": "string" + }, + "lockedAmount": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/ConfigChangeRequestStatus" + }, + "address": { + "type": "string" + }, + "tag": { + "type": "string" + }, + "activationTime": { + "type": "string" + } + } + }, + "ExternalWalletAsset": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/ConfigChangeRequestStatus" + }, + "address": { + "type": "string" + }, + "tag": { + "type": "string" + }, + "activationTime": { + "type": "string" + }, + "additionalInfo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WalletAssetAdditionalInfo" + } + } + } + }, + "WalletAssetAdditionalInfo": { + "type": "object", + "properties": { + "accountHolderGivenName": { + "type": "string" + }, + "accountHolderSurname": { + "type": "string" + }, + "accountHolderCity": { + "type": "string" + }, + "accountHolderCountry": { + "type": "string" + }, + "accountHolderAddress1": { + "type": "string" + }, + "accountHolderAddress2": { + "type": "string" + }, + "accountHolderDistrict": { + "type": "string" + }, + "accountHolderPostalCode": { + "type": "string" + }, + "abaRoutingNumber": { + "type": "string" + }, + "abaAccountNumber": { + "type": "string" + }, + "abaCountry": { + "type": "string" + }, + "iban": { + "type": "string" + }, + "ibanCity": { + "type": "string" + }, + "ibanCountry": { + "type": "string" + }, + "speiClabe": { + "type": "string" + }, + "speiName": { + "type": "string" + } + } + }, + "ExchangeAsset": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "balance": { + "type": "string" + }, + "lockedAmount": { + "type": "string" + }, + "total": { + "type": "string" + }, + "available": { + "type": "string" + } + } + }, + "ExchangeTradingAccount": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "name": { + "type": "string" + }, + "assets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExchangeAsset" + } + } + } + }, + "FiatAsset": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "balance": { + "type": "string" + } + } + }, + "CreateVaultAssetResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "address": { + "type": "string" + }, + "legacyAddress": { + "type": "string" + }, + "enterpriseAddress": { + "type": "string" + }, + "tag": { + "type": "string" + }, + "eosAccountName": { + "type": "string" + }, + "status": { + "type": "string" + }, + "activationTxId": { + "type": "string" + } + } + }, + "RewardsInfo": { + "type": "object", + "properties": { + "pendingRewards": { + "description": "ุงู„ู…ุจู„ุบ ุงู„ู…ุนู„ู‚ ู„ู„ุญุตูˆู„ ุนู„ู‰ ุงู„ู…ูƒุงูุขุช", + "type": "string" + } + } + }, + "VaultAsset": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "total": { + "description": "ุฅุฌู…ุงู„ูŠ ุฑุตูŠุฏ ุงู„ู…ุญูุธุฉ. ููŠ EOSุŒ ุชุชุถู…ู† ู‡ุฐู‡ ุงู„ู‚ูŠู…ุฉ ุฑุตูŠุฏ ุงู„ุดุจูƒุฉุŒ ูˆุงู„ุฅูŠุฏุงุน ุงู„ุฐุงุชูŠุŒ ูˆุงุณุชุฑุฏุงุฏ ุงู„ุฃู…ูˆุงู„ ุงู„ู…ุนู„ู‚. ุจุงู„ู†ุณุจุฉ ู„ุฌู…ูŠุน ุงู„ุนู…ู„ุงุช ุงู„ุฃุฎุฑู‰ุŒ ูŠูƒูˆู† ุงู„ุฑุตูŠุฏ ูƒู…ุง ูŠุธู‡ุฑ ุนู„ู‰ blockchain.", + "type": "string" + }, + "balance": { + "deprecated": true, + "description": "ุชู… ุฅูŠู‚ุงู ุงุณุชุฎุฏุงู…ู‡ - ุชู… ุงุณุชุจุฏุงู„ู‡ ุจู€ "ุงู„ุฅุฌู…ุงู„ูŠ"", + "type": "string" + }, + "available": { + "description": "ุงู„ุฃู…ูˆุงู„ ุงู„ู…ุชุงุญุฉ ู„ู„ุชุญูˆูŠู„ ุชุณุงูˆูŠ ุฑุตูŠุฏ blockchain ู…ุทุฑูˆุญู‹ุง ู…ู†ู‡ ุฃูŠ ู…ุจุงู„ุบ ู…ู‚ูู„ุฉ", + "type": "string" + }, + "pending": { + "description": "ุงู„ุฑุตูŠุฏ ุงู„ุชุฑุงูƒู…ูŠ ู„ุฌู…ูŠุน ุงู„ู…ุนุงู…ู„ุงุช ุงู„ู…ุนู„ู‚ุฉ ู„ู„ุชุณูˆูŠุฉ", + "type": "string" + }, + "frozen": { + "description": "ุงู„ุฑุตูŠุฏ ุงู„ู…ุฌู…ุฏ ุงู„ุชุฑุงูƒู…ูŠ", + "type": "string" + }, + "lockedAmount": { + "description": "ุงู„ุฃู…ูˆุงู„ ููŠ ุงู„ู…ุนุงู…ู„ุงุช ุงู„ุตุงุฏุฑุฉ ุงู„ุชูŠ ู„ู… ูŠุชู… ู†ุดุฑู‡ุง ุจุนุฏ ุนู„ู‰ ุงู„ุดุจูƒุฉ", + "type": "string" + }, + "staked": { + "description": "ุงู„ุฑุตูŠุฏ ุงู„ู…ุชุฑุงูƒู…", + "type": "string" + }, + "totalStakedCPU": { + "type": "number", + "description": "ู…ูู‡ู…ู„" + }, + "totalStakedNetwork": { + "type": "string", + "description": "ู…ูู‡ู…ู„" + }, + "selfStakedCPU": { + "type": "string", + "description": "ู…ูู‡ู…ู„" + }, + "selfStakedNetwork": { + "type": "string", + "description": "ู…ูู‡ู…ู„" + }, + "pendingRefundCPU": { + "type": "string", + "description": "ู…ูู‡ู…ู„" + }, + "pendingRefundNetwork": { + "type": "string", + "description": "ู…ูู‡ู…ู„" + }, + "blockHeight": { + "type": "string" + }, + "blockHash": { + "type": "string" + }, + "rewardsInfo": { + "$ref": "#/components/schemas/RewardsInfo" + } + } + }, + "VaultWalletAddress": { + "type": "object", + "properties": { + "assetId": { + "type": "string", + "x-fb-entity": "asset" + }, + "address": { + "type": "string" + }, + "description": { + "type": "string" + }, + "tag": { + "type": "string" + }, + "type": { + "type": "string" + }, + "customerRefId": { + "type": "string" + }, + "addressFormat": { + "oneOf": [ + { + "const": "SEGWIT" + }, + { + "const": "LEGACY" + } + ] + }, + "legacyAddress": { + "type": "string" + }, + "enterpriseAddress": { + "type": "string" + }, + "bip44AddressIndex": { + "type": "integer" + }, + "userDefined": { + "type": "boolean" + } + } + }, + "CreateAddressResponse": { + "type": "object", + "properties": { + "address": { + "type": "string" + }, + "legacyAddress": { + "type": "string" + }, + "enterpriseAddress": { + "type": "string" + }, + "tag": { + "type": "string" + }, + "bip44AddressIndex": { + "type": "integer" + } + } + }, + "VaultAccountsPagedResponse": { + "type": "object", + "properties": { + "accounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VaultAccount" + } + }, + "paging": { + "type": "object", + "properties": { + "before": { + "type": "string" + }, + "after": { + "type": "string" + } + } + }, + "previousUrl": { + "type": "string" + }, + "nextUrl": { + "type": "string" + } + } + }, + "PaginatedAssetWalletResponse": { + "type": "object", + "properties": { + "assetWallets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AssetWallet" + } + }, + "paging": { + "type": "object", + "properties": { + "before": { + "description": "ุณู„ุณู„ุฉ ุชู…ุซู„ ู…ุคุดุฑู‹ุง. ูŠู…ูƒู† ู„ู„ู…ุณุชุฎุฏู…ูŠู† ุงุณุชุฎุฏุงู… ู‡ุฐุง ู…ุน ุทู„ุจ ุฌุฏูŠุฏ ุฅู„ู‰ ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ู‡ุฐู‡ ูƒู…ุนู„ู…ุฉ ุทู„ุจ "ู‚ุจู„" ู„ุฌู„ุจ ุงู„ุตูุญุฉ ุงู„ุณุงุจู‚ุฉ ู…ู† ุงู„ู†ุชุงุฆุฌ.", + "type": "string" + }, + "after": { + "description": "ุณู„ุณู„ุฉ ุชู…ุซู„ ู…ุคุดุฑู‹ุง. ูŠู…ูƒู† ู„ู„ู…ุณุชุฎุฏู…ูŠู† ุงุณุชุฎุฏุงู… ู‡ุฐุง ู…ุน ุทู„ุจ ุฌุฏูŠุฏ ุฅู„ู‰ ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ู‡ุฐู‡ ูƒู…ุนู„ู…ุฉ ุทู„ุจ "ู‚ุจู„" ู„ุฌู„ุจ ุงู„ุตูุญุฉ ุงู„ุชุงู„ูŠุฉ ู…ู† ุงู„ู†ุชุงุฆุฌ.", + "type": "string" + } + } + } + } + }, + "AssetWallet": { + "type": "object", + "properties": { + "vaultId": { + "description": "ู…ุนุฑู ุญุณุงุจ ุงู„ุฎุฒู†ุฉ. ูŠู…ูƒู†ูƒ [ุงู„ุญุตูˆู„ ุนู„ู‰ ุญุณุงุจ ุงู„ุฎุฒู†ุฉ ู…ู† ุฎู„ุงู„ ู‡ุฐุง ุงู„ู…ุนุฑู](https://developers.fireblocks.com/reference/get_vault-accounts-vaultaccountid) ู„ุงุณุชุฑุฏุงุฏ ุฎุตุงุฆุต ุงู„ุฎุฒู†ุฉ ู…ุซู„ ุงุณู…ู‡ุงุŒ ูˆุงู„ุชุฒูˆูŠุฏ ุงู„ุชู„ู‚ุงุฆูŠ ุจุงู„ูˆู‚ูˆุฏุŒ ุฃูˆ ุฅุฎูุงุคู‡ุง ููŠ ูˆุงุฌู‡ุฉ ุงู„ู…ุณุชุฎุฏู… ุฃูˆ ู…ุนุฑู ู…ุฑุฌุน ุงู„ุนู…ูŠู„.", + "type": "string" + }, + "assetId": { + "description": "ู…ุนุฑู ุงู„ุฃุตู„. ูŠู…ูƒู†ูƒ ุงู„ุญุตูˆู„ ุนู„ู‰ ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช ุญูˆู„ ู‡ุฐุง ุงู„ุฃุตู„ ุจุงุณุชุฎุฏุงู… [ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช ุงู„ุฃุตูˆู„ ุงู„ู…ุฏุนูˆู…ุฉ](https://developers.fireblocks.com/reference/get_supported-assets)", + "type": "string" + }, + "available": { + "description": "ุงู„ุฑุตูŠุฏ ุงู„ู…ุชุงุญุŒ ุงู„ู…ุชุงุญ ู„ู„ุงุณุชุฎุฏุงู… ููŠ ุงู„ู…ุนุงู…ู„ุฉ.", + "type": "string" + }, + "total": { + "description": "ุฅุฌู…ุงู„ูŠ ุงู„ุฑุตูŠุฏ ููŠ ู…ุญูุธุฉ ุงู„ุฃุตูˆู„ุŒ ูƒู…ุง ูŠุธู‡ุฑ ููŠ ู…ุณุชูƒุดูุงุช blockchain. ูŠุชุถู…ู† ู‡ุฐุง ุงู„ุฑุตูŠุฏ ุงู„ู…ุชุงุญุŒ ูˆุฃูŠ ู†ูˆุน ู…ู† ุงู„ุฑุตูŠุฏ ุบูŠุฑ ุงู„ู…ุชุงุญ ู…ุซู„ ุงู„ู…ู‚ูู„ ุฃูˆ ุงู„ู…ุฌู…ุฏ ุฃูˆ ุบูŠุฑ ุฐู„ูƒ.", + "type": "string" + }, + "pending": { + "description": "ุงู„ุฑุตูŠุฏ ุงู„ู…ุนู„ู‚.", + "type": "string" + }, + "staked": { + "description": "ุงู„ุฑุตูŠุฏ ุงู„ู…ุชุฑุงูƒู….", + "type": "string" + }, + "frozen": { + "description": "ุงู„ุฃู…ูˆุงู„ ู…ุฌู…ุฏุฉ ุจุณุจุจ ุณูŠุงุณุฉ ู…ูƒุงูุญุฉ ุบุณูŠู„ ุงู„ุฃู…ูˆุงู„ ููŠ ู…ุณุงุญุฉ ุงู„ุนู…ู„ ู‡ุฐู‡.", + "type": "string" + }, + "lockedAmount": { + "description": "ุงู„ุฑุตูŠุฏ ู…ู‚ูู„.", + "type": "string" + }, + "blockHeight": { + "description": "ุงุฑุชูุงุน (ุนุฏุฏ) ูƒุชู„ุฉ ุงู„ู…ูŠุฒุงู†. ูŠู…ูƒู† ุฃู† ุชูƒูˆู† ูุงุฑุบุฉ.", + "type": "string" + }, + "blockHash": { + "description": "ุชุฌุฒุฆุฉ ูƒุชู„ุฉ ุงู„ุฑุตูŠุฏ. ูŠู…ูƒู† ุฃู† ุชูƒูˆู† ูุงุฑุบุฉ.", + "type": "string" + }, + "creationTimestamp": { + "description": "ุทุงุจุน ุฒู…ู†ูŠ ูŠูˆู†ูƒุณ ู„ู„ูˆู‚ุช ุงู„ุฐูŠ ุชู… ููŠู‡ ุฅู†ุดุงุก ู…ุญูุธุฉ ุงู„ุฃุตูˆู„.", + "type": "string" + } + } + }, + "VaultAccount": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "assets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VaultAsset" + } + }, + "hiddenOnUI": { + "type": "boolean" + }, + "customerRefId": { + "type": "string" + }, + "autoFuel": { + "type": "boolean" + } + } + }, + "UnmanagedWallet": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "customerRefId": { + "type": "string" + }, + "assets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WalletAsset" + } + } + }, + "required": [ + "id", + "name", + "status" + ] + }, + "ExchangeAccount": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/ExchangeType" + }, + "name": { + "type": "string", + "description": "ุงุณู… ุงู„ุนุฑุถ ู„ุญุณุงุจ ุงู„ุชุจุงุฏู„" + }, + "status": { + "type": "string" + }, + "assets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExchangeAsset" + } + }, + "tradingAccounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExchangeTradingAccount" + } + }, + "isSubaccount": { + "description": "ุตุญูŠุญ ุฅุฐุง ูƒุงู† ุงู„ุญุณุงุจ ุญุณุงุจู‹ุง ูุฑุนูŠู‹ุง ููŠ ุงู„ุจูˆุฑุตุฉ", + "type": "boolean" + }, + "mainAccountId": { + "description": "ุฅุฐุง ูƒุงู† ุงู„ุญุณุงุจ ุญุณุงุจู‹ุง ูุฑุนูŠู‹ุงุŒ ููŠุฌุจ ุฅุฏุฎุงู„ ู…ุนุฑู ุงู„ุญุณุงุจ ุงู„ุฑุฆูŠุณูŠ", + "type": "string" + } + } + }, + "FiatAccount": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/FiatAccountType" + }, + "name": { + "type": "string", + "description": "ุงุณู… ุงู„ุนุฑุถ ู„ู„ุญุณุงุจ ุงู„ูˆุฑู‚ูŠ" + }, + "address": { + "type": "string" + }, + "assets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FiatAsset" + } + } + } + }, + "OneTimeAddress": { + "type": "object", + "properties": { + "address": { + "type": "string" + }, + "tag": { + "type": "string" + } + }, + "required": [ + "address" + ] + }, + "TransferPeerPath": { + "type": "object", + "properties": { + "type": { + "oneOf": [ + { + "const": "VAULT_ACCOUNT" + }, + { + "const": "EXCHANGE_ACCOUNT" + }, + { + "const": "INTERNAL_WALLET" + }, + { + "const": "EXTERNAL_WALLET" + }, + { + "const": "NETWORK_CONNECTION" + }, + { + "const": "FIAT_ACCOUNT" + }, + { + "const": "COMPOUND" + }, + { + "const": "GAS_STATION" + }, + { + "const": "ONE_TIME_ADDRESS" + }, + { + "const": "UNKNOWN" + }, + { + "const": "END_USER_WALLET" + } + ] + }, + "subType": { + "oneOf": [ + { + "const": "BINANCE" + }, + { + "const": "BINANCEUS" + }, + { + "const": "BITFINEX" + }, + { + "const": "BITHUMB" + }, + { + "const": "BITMEX" + }, + { + "const": "BITSO" + }, + { + "const": "BITSTAMP" + }, + { + "const": "BITTREX" + }, + { + "const": "BLINC" + }, + { + "const": "BYBIT" + }, + { + "const": "CIRCLE" + }, + { + "const": "COINBASEEXCHANGE" + }, + { + "const": "COINBASEPRO" + }, + { + "const": "COINMETRO" + }, + { + "const": "COINSPRO" + }, + { + "const": "CRYPTOCOM" + }, + { + "const": "DERIBIT" + }, + { + "const": "GEMINI" + }, + { + "const": "HITBTC" + }, + { + "const": "HUOBI" + }, + { + "const": "INDEPENDENTRESERVE" + }, + { + "const": "KORBIT" + }, + { + "const": "KRAKEN" + }, + { + "const": "KRAKENINTL" + }, + { + "const": "KUCOIN" + }, + { + "const": "LIQUID" + }, + { + "const": "OKCOIN" + }, + { + "const": "OKEX" + }, + { + "const": "PAXOS" + }, + { + "const": "POLONIEX" + }, + { + "const": "External" + }, + { + "const": "Internal" + } + ] + }, + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "walletId": { + "type": "string", + "format": "uuid" + } + }, + "required": [ + "type" + ] + }, + "DestinationTransferPeerPath": {}, + "CreateTransactionResponse": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ู…ุนุฑู ุงู„ู…ุนุงู…ู„ุฉ." + }, + "status": { + "type": "string", + "description": "ุงู„ุญุงู„ุฉ ุงู„ุฃุณุงุณูŠุฉ ู„ู„ู…ุนุงู…ู„ุฉ. ู„ู„ุญุตูˆู„ ุนู„ู‰ ุงู„ุชูุงุตูŠู„ุŒ ุฑุงุฌุน [ุญุงู„ุงุช ุงู„ู…ุนุงู…ู„ุงุช ุงู„ุฃุณุงุณูŠุฉ.] (https://developers.fireblocks.com/reference/primary-transaction-statuses)" + }, + "systemMessages": { + "$ref": "#/components/schemas/SystemMessageInfo" + } + } + }, + "SystemMessageInfo": { + "type": "object", + "properties": { + "type": { + "oneOf": [ + { + "const": "WARN" + }, + { + "const": "BLOCK" + } + ] + }, + "message": { + "type": "string", + "description": "ุงุณุชุฌุงุจุฉ ู…ู† Fireblocks ุชู†ู‚ู„ ุฑุณุงู„ุฉ ุญูˆู„ ุตุญุฉ ุงู„ุนู…ู„ูŠุฉ ุงู„ุชูŠ ูŠุชู… ุฅุฌุฑุงุคู‡ุง. ุฅุฐุง ุชู… ุฅุฑุฌุงุน ู‡ุฐุง ุงู„ูƒุงุฆู† ู…ุน ุงู„ุจูŠุงู†ุงุชุŒ ููŠุฌุจ ุฃู† ุชุชูˆู‚ุน ุชุฃุฎูŠุฑุงุช ู…ุญุชู…ู„ุฉ ุฃูˆ ุญุงู„ุงุช ู…ุนุงู…ู„ุงุช ุบูŠุฑ ู…ูƒุชู…ู„ุฉ.", + "example": "Slow transaction processing. Outgoing transactions might be stuck." + } + } + }, + "CancelTransactionResponse": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + } + } + }, + "UnfreezeTransactionResponse": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + } + } + }, + "FreezeTransactionResponse": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + } + } + }, + "AmlScreeningResult": { + "type": "object", + "description": "ู†ุชูŠุฌุฉ ูุญุต ู…ูƒุงูุญุฉ ุบุณู„ ุงู„ุฃู…ูˆุงู„.", + "properties": { + "provider": { + "type": "string" + }, + "payload": { + "type": "object" + } + } + }, + "FeeInfo": { + "type": "object", + "description": "ุชูุงุตูŠู„ ุฑุณูˆู… ุงู„ู…ุนุงู…ู„ุฉ.", + "properties": { + "networkFee": { + "description": "ุงู„ุฑุณูˆู… ุงู„ู…ุฏููˆุนุฉ ู„ู„ุดุจูƒุฉ", + "type": "string" + }, + "serviceFee": { + "description": "ุฅุฌู…ุงู„ูŠ ุงู„ุฑุณูˆู… ุงู„ุชูŠ ุชู… ุฎุตู…ู‡ุง ู…ู† ู‚ุจู„ ุงู„ุจูˆุฑุตุฉ ู…ู† ุงู„ู…ุจู„ุบ ุงู„ู…ุทู„ูˆุจ ูุนู„ูŠู‹ุง (ุฑุณูˆู… ุงู„ุฎุฏู…ุฉ = ุงู„ู…ุจู„ุบ - ุงู„ู…ุจู„ุบ ุงู„ุตุงููŠ)", + "type": "string" + }, + "gasPrice": { + "type": "string" + } + } + }, + "BlockInfo": { + "type": "object", + "description": "ุชุฌุฒุฆุฉ ุงู„ูƒุชู„ุฉ ูˆุงุฑุชูุงุน ุงู„ูƒุชู„ุฉ ุงู„ุชูŠ ุชู… ุชุนุฏูŠู† ู‡ุฐู‡ ุงู„ู…ุนุงู…ู„ุฉ ููŠู‡ุง. **ู…ู„ุงุญุธุฉ**: ุฅุฐุง ุงุณุชุฎุฏู…ุช ู…ุนุงู…ู„ุฉ ุตุงุฏุฑุฉ ูƒุงุฆู† ุงู„ูˆุฌู‡ุฉ ุจุฃูƒุซุฑ ู…ู† ู‚ูŠู…ุฉ ููŠ ุงู„ู…ุตููˆูุฉุŒ ูุณูŠุชู… ุชุนูŠูŠู† blockHash ุนู„ู‰ null.", + "properties": { + "blockHeight": { + "type": "string" + }, + "blockHash": { + "type": "string" + } + } + }, + "AuthorizationInfo": { + "type": "object", + "description": "ุงู„ู…ุนู„ูˆู…ุงุช ุงู„ู…ุชุนู„ู‚ุฉ ุจู€ [ุณูŠุงุณุฉ ุชููˆูŠุถ ุงู„ู…ุนุงู…ู„ุงุช (TAP).](https://developers.fireblocks.com/docs/capabilities#transaction-authorization-policy-tap)", + "properties": { + "allowOperatorAsAuthorizer": { + "type": "boolean" + }, + "logic": { + "oneOf": [ + { + "const": "AND" + }, + { + "const": "OR" + } + ] + }, + "groups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AuthorizationGroups" + } + } + } + }, + "AuthorizationGroups": { + "type": "object", + "properties": { + "th": { + "type": "number" + }, + "users": { + "type": "object", + "additionalProperties": { + "oneOf": [ + { + "const": "PENDING_AUTHORIZATION" + }, + { + "const": "APPROVED" + }, + { + "const": "REJECTED" + }, + { + "const": "NA" + } + ] + } + } + } + }, + "AmountInfo": { + "type": "object", + "description": "ุชูุงุตูŠู„ ุงู„ู…ุจู„ุบ ุงู„ู…ุทู„ูˆุจ ุชุญูˆูŠู„ู‡.", + "properties": { + "amount": { + "description": "ุฅุฐุง ูƒุงู† ุงู„ุชุญูˆูŠู„ ุนุจุงุฑุฉ ุนู† ุณุญุจ ู…ู† ุจูˆุฑุตุฉุŒ ูุณูŠุชู… ุชุญุฏูŠุฏ ุงู„ู…ุจู„ุบ ุงู„ูุนู„ูŠ ุงู„ู…ุทู„ูˆุจ ุชุญูˆูŠู„ู‡. ูˆุฅู„ุงุŒ ูุณูŠุชู… ุชุญุฏูŠุฏ ุงู„ู…ุจู„ุบ ุงู„ู…ุทู„ูˆุจ.", + "type": "string" + }, + "requestedAmount": { + "description": "ุงู„ู…ุจู„ุบ ุงู„ุฐูŠ ูŠุทู„ุจู‡ ุงู„ู…ุณุชุฎุฏู….", + "type": "string" + }, + "netAmount": { + "description": "ุงู„ู…ุจู„ุบ ุงู„ุตุงููŠ ู„ู„ู…ุนุงู…ู„ุฉ ุจุนุฏ ุฎุตู… ุงู„ุฑุณูˆู….", + "type": "string" + }, + "amountUSD": { + "description": "ุงู„ู‚ูŠู…ุฉ ุจุงู„ุฏูˆู„ุงุฑ ุงู„ุฃู…ุฑูŠูƒูŠ ู„ู„ู…ุจู„ุบ ุงู„ู…ุทู„ูˆุจ.", + "type": "string" + } + } + }, + "RewardInfo": { + "type": "object", + "description": "ู‡ุฐุง ุงู„ุญู‚ู„ ุฐูˆ ุตู„ุฉ ูู‚ุท ุจู…ุนุงู…ู„ุงุช Algorand. ุณูŠุธู‡ุฑ ูƒู„ ู…ู† `srcRewards` ูˆ`destRewards` ูู‚ุท ู„ู…ุนุงู…ู„ุงุช Vault to VaultุŒ ูˆุฅู„ุง ูุณุชุชู„ู‚ู‰ ุฌุงู†ุจ Fireblocks ูู‚ุท ู…ู† ุงู„ู…ุนุงู…ู„ุฉ.", + "properties": { + "srcRewards": { + "type": "string" + }, + "destRewards": { + "type": "string" + } + } + }, + "SourceTransferPeerPathResponse": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "subType": { + "type": "string", + "description": "ููŠ ุญุงู„ุฉ ุชุนูŠูŠู† ุงู„ู†ูˆุน ุนู„ู‰ `EXCHANGE_ACCOUNT` ุฃูˆ `FIAT_ACCOUNT`ุŒ ูŠุชู… ุชุนูŠูŠู† ุงุณู… ุจุงุฆุน ุงู„ุตุฑู ุงู„ู…ุญุฏุฏ ุฃูˆ ุงุณู… ุจุงุฆุน ุงู„ุนู…ู„ุฉ ุงู„ูˆุฑู‚ูŠุฉ. ููŠ ุญุงู„ุฉ ุชุนูŠูŠู† ุงู„ู†ูˆุน ุนู„ู‰ `INTERNAL_WALLET` ุฃูˆ `EXTERNAL_WALLET`ุŒ ูŠุชู… ุชุนูŠูŠู† ุงู„ู†ูˆุน ุงู„ูุฑุนูŠ ุนู„ู‰ `Internal` ุฃูˆ `External`." + }, + "id": { + "type": "string", + "description": "ู…ุนุฑู ุงู„ู†ุธูŠุฑ. ูŠู…ูƒู†ูƒ ุงุณุชุฑุฏุงุฏ ู…ุนุฑู ูƒู„ ูƒุงุฆู† ู…ูƒุงู† ุจุงุณุชุฎุฏุงู… ู†ู‚ุงุท ุงู„ู†ู‡ุงูŠุฉ ู„ู€ [ุฅุฏุฑุงุฌ ุญุณุงุจุงุช ุงู„ุฎุฒู†ุฉ](https://developers.fireblocks.com/reference/get_vault-accounts-paged)ุŒ [ุฅุฏุฑุงุฌ ุญุณุงุจ ุงู„ุชุจุงุฏู„](https://developers.fireblocks.com/reference/get_exchange-accounts)ุŒ [ุฅุฏุฑุงุฌ ุญุณุงุจุงุช fiat](https://developers.fireblocks.com/reference/get_fiat-accounts)ุŒ [ุฅุฏุฑุงุฌ ุงู„ู…ุญุงูุธ ุงู„ุฏุงุฎู„ูŠุฉ](https://developers.fireblocks.com/reference/get_internal-wallets)ุŒ [ุฅุฏุฑุงุฌ ุงู„ู…ุญุงูุธ ุงู„ุฎุงุฑุฌูŠุฉ](https://developers.fireblocks.com/reference/get_external-wallets)ุŒ [ุฅุฏุฑุงุฌ ุงุชุตุงู„ุงุช ุงู„ุดุจูƒุฉ](https://developers.fireblocks.com/reference/get_network-connections). ุจุงู„ู†ุณุจุฉ ู„ู„ุฃู†ูˆุงุน ุงู„ุฃุฎุฑู‰ุŒ ู„ุง ุชูƒูˆู† ู‡ุฐู‡ ุงู„ู…ุนู„ู…ุฉ ุถุฑูˆุฑูŠุฉ." + }, + "name": { + "type": "string", + "description": "ุงุณู… ุงู„ู†ุธูŠุฑ." + }, + "walletId": { + "type": "string", + "format": "uuid" + } + } + }, + "DestinationTransferPeerPathResponse": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "subType": { + "type": "string", + "description": "ููŠ ุญุงู„ุฉ ุชุนูŠูŠู† ุงู„ู†ูˆุน ุนู„ู‰ `EXCHANGE_ACCOUNT` ุฃูˆ `FIAT_ACCOUNT`ุŒ ุงุณู… ุจุงุฆุน ุงู„ุตุฑู ุงู„ู…ุญุฏุฏ ุฃูˆ ุงุณู… ุจุงุฆุน fiat. ููŠ ุญุงู„ุฉ ุชุนูŠูŠู† ุงู„ู†ูˆุน ุนู„ู‰ `INTERNAL_WALLET` ุฃูˆ `EXTERNAL_WALLET`ุŒ ูŠุชู… ุชุนูŠูŠู† ุงู„ู†ูˆุน ุงู„ูุฑุนูŠ ุนู„ู‰ `Internal` ุฃูˆ `External`." + }, + "id": { + "type": "string", + "description": "ู…ุนุฑู ุงู„ู†ุธูŠุฑ. ูŠู…ูƒู†ูƒ ุงุณุชุฑุฏุงุฏ ู…ุนุฑู ูƒู„ ูƒุงุฆู† ู…ูƒุงู† ุจุงุณุชุฎุฏุงู… ู†ู‚ุงุท ุงู„ู†ู‡ุงูŠุฉ ู„ู€ [ุฅุฏุฑุงุฌ ุญุณุงุจุงุช ุงู„ุฎุฒู†ุฉ](https://developers.fireblocks.com/reference/get_vault-accounts-paged)ุŒ [ุฅุฏุฑุงุฌ ุญุณุงุจ ุงู„ุชุจุงุฏู„](https://developers.fireblocks.com/reference/get_exchange-accounts)ุŒ [ุฅุฏุฑุงุฌ ุญุณุงุจุงุช fiat](https://developers.fireblocks.com/reference/get_fiat-accounts)ุŒ [ุฅุฏุฑุงุฌ ุงู„ู…ุญุงูุธ ุงู„ุฏุงุฎู„ูŠุฉ](https://developers.fireblocks.com/reference/get_internal-wallets)ุŒ [ุฅุฏุฑุงุฌ ุงู„ู…ุญุงูุธ ุงู„ุฎุงุฑุฌูŠุฉ](https://developers.fireblocks.com/reference/get_external-wallets)ุŒ [ุฅุฏุฑุงุฌ ุงุชุตุงู„ุงุช ุงู„ุดุจูƒุฉ](https://developers.fireblocks.com/reference/get_network-connections). ุจุงู„ู†ุณุจุฉ ู„ู„ุฃู†ูˆุงุน ุงู„ุฃุฎุฑู‰ุŒ ู„ุง ุชูƒูˆู† ู‡ุฐู‡ ุงู„ู…ุนู„ู…ุฉ ุถุฑูˆุฑูŠุฉ." + }, + "name": { + "type": "string", + "description": "ุงุณู… ุงู„ู†ุธูŠุฑ." + }, + "walletId": { + "type": "string", + "format": "uuid" + } + } + }, + "TransactionResponse": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ู…ุนุฑู ุงู„ู…ุนุงู…ู„ุฉ." + }, + "externalTxId": { + "type": "string", + "description": "ู…ุนุฑู ู…ุนุงู…ู„ุฉ ูุฑูŠุฏ ูŠู‚ุฏู…ู‡ ุงู„ู…ุณุชุฎุฏู…. ุชูˆุตูŠ Fireblocks ุจุดุฏุฉ ุจุชุนูŠูŠู† `externalTxId` ู„ูƒู„ ู…ุนุงู…ู„ุฉ ูŠุชู… ุฅู†ุดุงุคู‡ุงุŒ ู„ุชุฌู†ุจ ุฅุฑุณุงู„ ู†ูุณ ุงู„ู…ุนุงู…ู„ุฉ ู…ุฑุชูŠู†." + }, + "status": { + "type": "string", + "description": "ุงู„ุญุงู„ุฉ ุงู„ุฃุณุงุณูŠุฉ ู„ู„ู…ุนุงู…ู„ุฉ. ู„ู„ุญุตูˆู„ ุนู„ู‰ ุงู„ุชูุงุตูŠู„ุŒ ุฑุงุฌุน [ุญุงู„ุงุช ุงู„ู…ุนุงู…ู„ุงุช ุงู„ุฃุณุงุณูŠุฉ](https://developers.fireblocks.com/reference/primary-transaction-statuses)." + }, + "subStatus": { + "type": "string", + "description": "ุฑุงุฌุน [ุญุงู„ุงุช ุงู„ู…ุนุงู…ู„ุงุช ุงู„ูุฑุนูŠุฉ](https://developers.fireblocks.com/reference/transaction-substatuses) ู„ู„ุญุตูˆู„ ุนู„ู‰ ู‚ุงุฆู…ุฉ ุงู„ุญุงู„ุงุช ุงู„ูุฑุนูŠุฉ ู„ู„ู…ุนุงู…ู„ุงุช." + }, + "txHash": { + "type": "string", + "description": "ุชุฌุฒุฆุฉ ุงู„ู…ุนุงู…ู„ุฉ ุนู„ู‰ blockchain. * ุชูˆุฌุฏ ู‡ุฐู‡ ุงู„ู…ุนู„ู…ุฉ ุฅุฐุง ุชู… ุงุณุชูŠูุงุก ุฃุญุฏ ุงู„ุดุฑูˆุท ุงู„ุชุงู„ูŠุฉ ุนู„ู‰ ุงู„ุฃู‚ู„: 1. ู†ูˆุน ู…ุตุฏุฑ ุงู„ู…ุนุงู…ู„ุฉ ู‡ูˆ `UNKNOWN` ุฃูˆ `WHITELISTED_ADDRESS` ุฃูˆ `NETWORK_CONNECTION` ุฃูˆ `ONE_TIME_ADDRESS` ุฃูˆ `FIAT_ACCOUNT` ุฃูˆ `GAS_STATION`. 2. ู†ูˆุน ู…ุตุฏุฑ ุงู„ู…ุนุงู…ู„ุฉ ู‡ูˆ `VAULT` ูˆุงู„ุญุงู„ุฉ ู‡ูŠ ุฅู…ุง: `CONFIRMING` ุฃูˆ `COMPLETED` ุฃูˆ ูƒุงู†ุช ููŠ ุฃูŠ ู…ู† ู‡ุฐู‡ ุงู„ุญุงู„ุงุช ู‚ุจู„ ุงู„ุชุบูŠูŠุฑ ุฅู„ู‰ `FAILED` ุฃูˆ `REJECTED`. ููŠ ุจุนุถ ุงู„ุญุงู„ุงุชุŒ ุณุชุชุถู…ู† ุงู„ู…ุนุงู…ู„ุงุช ููŠ ุงู„ุญุงู„ุฉ `BROADCASTING` txHash ุฃูŠุถู‹ุง. 3. ู†ูˆุน ู…ุตุฏุฑ ุงู„ู…ุนุงู…ู„ุฉ ู‡ูˆ `EXCHANGE_ACCOUNT` ูˆู†ูˆุน ูˆุฌู‡ุฉ ุงู„ู…ุนุงู…ู„ุฉ ู‡ูˆ `VAULT`ุŒ ูˆุงู„ุญุงู„ุฉ ุฅู…ุง: `CONFIRMING` ุฃูˆ `COMPLETED` ุฃูˆ ูƒุงู†ุช ููŠ ุฃูŠ ู…ู† ู‡ุฐู‡ ุงู„ุญุงู„ุงุช ู‚ุจู„ ุงู„ุชุบูŠูŠุฑ ุฅู„ู‰ `FAILED`. * ุจุงู„ุฅุถุงูุฉ ุฅู„ู‰ ุฐู„ูƒุŒ ูŠุฌุจ ุงุณุชูŠูุงุก ุงู„ุดุฑูˆุท ุงู„ุชุงู„ูŠุฉ: 1. ุงู„ุฃุตู„ ู‡ูˆ ุฃุตู„ ู…ุดูุฑ (ูˆู„ูŠุณ ุนู…ู„ุฉ ูˆุฑู‚ูŠุฉ). 2. ุนู…ู„ูŠุฉ ุงู„ู…ุนุงู…ู„ุฉ ู„ูŠุณุช RAW ุฃูˆ `TYPED_MESSAGE`." + }, + "operation": { + "$ref": "#/components/schemas/GetTransactionOperation" + }, + "note": { + "type": "string", + "description": "ู…ู„ุงุญุธุฉ ู…ุฎุตุตุฉุŒ ู„ู… ูŠุชู… ุฅุฑุณุงู„ู‡ุง ุฅู„ู‰ blockchainุŒ ุชุตู ุงู„ู…ุนุงู…ู„ุฉ ููŠ ู…ุณุงุญุฉ ุนู…ู„ Fireblocks ุงู„ุฎุงุตุฉ ุจูƒ." + }, + "assetId": { + "type": "string", + "description": "ู…ุนุฑู ุงู„ุฃุตู„ ุงู„ู…ุฑุงุฏ ู†ู‚ู„ู‡ุŒ ู„ุนู…ู„ูŠุงุช `TRANSFER` ุฃูˆ `MINT` ุฃูˆ `BURN` ุฃูˆ `ENABLE_ASSET` ุฃูˆ `STAKE` ุฃูˆ `UNSTAKE` ุฃูˆ `WITHDRAW`. [ุฑุงุฌุน ู‚ุงุฆู…ุฉ ุงู„ุฃุตูˆู„ ุงู„ู…ุฏุนูˆู…ุฉ ูˆู…ุนุฑูุงุชู‡ุง ุนู„ู‰ Fireblocks.](https://developers.fireblocks.com/reference/get_supported-assets)", + "x-fb-entity": "asset" + }, + "source": { + "$ref": "#/components/schemas/SourceTransferPeerPathResponse" + }, + "sourceAddress": { + "type": "string", + "description": "ุจุงู„ู†ุณุจุฉ ู„ู„ุฃุตูˆู„ ุงู„ู‚ุงุฆู…ุฉ ุนู„ู‰ ุงู„ุญุณุงุจ ูู‚ุทุŒ ุนู†ูˆุงู† ุงู„ู…ุตุฏุฑ ู„ู„ู…ุนุงู…ู„ุฉ. **ู…ู„ุงุญุธุฉ:** ุฅุฐุง ูƒุงู†ุช ุงู„ุญุงู„ุฉ "ู…ุคูƒุฏุฉ"ุŒ ุฃูˆ "ู…ูƒุชู…ู„ุฉ"ุŒ ุฃูˆ ูƒุงู†ุช "ู…ุคูƒุฏุฉ"ุŒ ุซู… ุงู†ุชู‚ู„ุช ุฅู„ู‰ "ูุดู„ุช" ุฃูˆ "ุฑูุถุช"ุŒ ูุณุชุญุชูˆูŠ ู‡ุฐู‡ ุงู„ู…ุนู„ู…ุฉ ุนู„ู‰ ุนู†ูˆุงู† ุงู„ู…ุตุฏุฑ. ููŠ ุฃูŠ ุญุงู„ุฉ ุฃุฎุฑู‰ุŒ ุณุชูƒูˆู† ู‡ุฐู‡ ุงู„ู…ุนู„ู…ุฉ ูุงุฑุบุฉ." + }, + "tag": { + "type": "string", + "description": "ุนู„ุงู…ุฉ ุนู†ูˆุงู† ุงู„ู…ุตุฏุฑ ู„ู€ XRPุŒ ุชูุณุชุฎุฏู… ูƒู…ุฐูƒุฑุฉ ู„ู€ EOS/XLMุŒ ุฃูˆ ูˆุตู ุงู„ุชุญูˆูŠู„ ุงู„ู…ุตุฑููŠ ู„ู…ุฒูˆุฏ ุงู„ุนู…ู„ุฉ ุงู„ูˆุฑู‚ูŠุฉ BLINC (ู…ู† ู‚ูุจู„ ู…ุฌู…ูˆุนุฉ BCB)." + }, + "destination": { + "$ref": "#/components/schemas/DestinationTransferPeerPathResponse" + }, + "destinations": { + "type": "array", + "description": "ูˆุฌู‡ุงุช ุงู„ู…ุนุงู…ู„ุฉ. **ู…ู„ุงุญุธุฉ:** ููŠ ุญุงู„ุฉ ุฅุฑุณุงู„ ุงู„ู…ุนุงู…ู„ุฉ ุฅู„ู‰ ูˆุฌู‡ุฉ ูˆุงุญุฏุฉุŒ ูŠุชู… ุงุณุชุฎุฏุงู… ู…ุนู„ู…ุฉ `destination` ุจุฏู„ุงู‹ ู…ู† ู‡ุฐู‡.", + "items": { + "$ref": "#/components/schemas/TransactionResponseDestination" + } + }, + "destinationAddress": { + "type": "string", + "description": "ุงู„ุนู†ูˆุงู† ุงู„ุฐูŠ ุชู… ู†ู‚ู„ ุงู„ุฃุตูˆู„ ุฅู„ูŠู‡. ู…ู„ุงุญุธุงุช: - ุจุงู„ู†ุณุจุฉ ู„ู…ุนุงู…ู„ุงุช ู…ุชุนุฏุฏุฉ ุงู„ูˆุฌู‡ุงุช (https://support.fireblocks.io/hc/en-us/articles/360018447980-Multi-destination-transactions)ุŒ ุณุชูƒูˆู† ู‡ุฐู‡ ุงู„ู…ุนู„ู…ุฉ ูุงุฑุบุฉ. ููŠ ู‡ุฐู‡ ุงู„ุญุงู„ุฉุŒ ูŠุฌุจ ุนู„ูŠูƒ ุงู„ุฑุฌูˆุน ุฅู„ู‰ ุญู‚ู„ ุงู„ูˆุฌู‡ุงุช. - ุฅุฐุง ูƒุงู†ุช ุงู„ุญุงู„ุฉ "ุชุฃูƒูŠุฏ"ุŒ ุฃูˆ "ู…ูƒุชู…ู„"ุŒ ุฃูˆ ูƒุงู†ุช "ุชุฃูƒูŠุฏ"ุŒ ุซู… ุงู†ุชู‚ู„ุช ุฅู„ู‰ "ูุดู„" ุฃูˆ "ุฑูุถ"ุŒ ูุณุชุญุชูˆูŠ ู‡ุฐู‡ ุงู„ู…ุนู„ู…ุฉ ุนู„ู‰ ุนู†ูˆุงู† ุงู„ูˆุฌู‡ุฉ. ููŠ ุฃูŠ ุญุงู„ุฉ ุฃุฎุฑู‰ุŒ ุณุชูƒูˆู† ู‡ุฐู‡ ุงู„ู…ุนู„ู…ุฉ ูุงุฑุบุฉ." + }, + "destinationAddressDescription": { + "type": "string", + "description": "ูˆุตู ุงู„ุนู†ูˆุงู†." + }, + "destinationTag": { + "type": "string", + "description": "ุนู„ุงู…ุฉ ุนู†ูˆุงู† ุงู„ูˆุฌู‡ุฉ ู„ู€ XRPุŒ ุชูุณุชุฎุฏู… ูƒู…ุฐูƒุฑุฉ ู„ู€ EOS/XLMุŒ ุฃูˆ ูˆุตู ุงู„ุชุญูˆูŠู„ ุงู„ู…ุตุฑููŠ ู„ู…ุฒูˆุฏ ุงู„ุนู…ู„ุฉ ุงู„ูˆุฑู‚ูŠุฉ BLINC (ู…ู† ู‚ูุจู„ ู…ุฌู…ูˆุนุฉ BCB)." + }, + "contractCallDecodedData": { + "description": "ุงู„ุจูŠุงู†ุงุช ุงู„ู…ููƒูˆูƒุฉ ู„ุนู…ู„ูŠุงุช `CONTRACT_CALL`. ูŠูˆุตู‰ ุจุงุณุชุฎุฏุงู… [ู…ูƒุชุจุงุช ุงู„ุชุทูˆูŠุฑ] (https://developers.fireblocks.com/docs/ethereum-development#convenience-libraries) ููŠ Fireblocks ู„ุชุนูŠูŠู† ู‚ูŠู…ุฉ ู‡ุฐู‡ ุงู„ู…ุนู„ู…ุฉ.", + "type": "object", + "properties": { + "contractName": { + "type": "string" + }, + "functionCalls": { + "type": "array", + "items": { + "type": "object" + } + } + } + }, + "amountInfo": { + "$ref": "#/components/schemas/AmountInfo" + }, + "treatAsGrossAmount": { + "type": "boolean", + "description": "ุจุงู„ู†ุณุจุฉ ู„ู„ู…ุนุงู…ู„ุงุช ุงู„ุชูŠ ูŠุชู… ุงู„ุจุฏุก ููŠู‡ุง ุนุจุฑ ู…ุณุงุญุฉ ุนู…ู„ Fireblocks ู‡ุฐู‡ุŒ ุนู†ุฏ ุถุจุทู‡ุง ุนู„ู‰ "true"ุŒ ูŠุชู… ุฎุตู… ุงู„ุฑุณูˆู… ู…ู† ุงู„ู…ุจู„ุบ ุงู„ู…ุทู„ูˆุจ. **ู…ู„ุงุญุธุฉ**: ู„ุง ูŠู…ูƒู† ุงุนุชุจุงุฑ ู‡ุฐู‡ ุงู„ู…ุนู„ู…ุฉ ุฅู„ุง ุฅุฐุง ูƒุงู† ุฃุตู„ ุงู„ู…ุนุงู…ู„ุฉ ุฃุตู„ู‹ุง ุฃุณุงุณูŠู‹ุงุŒ ู…ุซู„ ETH ุฃูˆ MATIC. ุฅุฐุง ู„ู… ูŠูƒู† ู…ู† ุงู„ู…ู…ูƒู† ุงุณุชุฎุฏุงู… ุงู„ุฃุตู„ ู„ุฑุณูˆู… ุงู„ู…ุนุงู…ู„ุงุชุŒ ู…ุซู„ USDCุŒ ูŠุชู… ุชุฌุงู‡ู„ ู‡ุฐู‡ ุงู„ู…ุนู„ู…ุฉ ูˆูŠุชู… ุฎุตู… ุงู„ุฑุณูˆู… ู…ู† ู…ุญูุธุฉ ุงู„ุฃุตูˆู„ ุงู„ุฃุณุงุณูŠุฉ ุฐุงุช ุงู„ุตู„ุฉ ููŠ ุงู„ุญุณุงุจ ุงู„ู…ุตุฏุฑ." + }, + "feeInfo": { + "$ref": "#/components/schemas/FeeInfo" + }, + "feeCurrency": { + "type": "string", + "description": "ุงู„ุฃุตูˆู„ ุงู„ุชูŠ ุชู… ุณุญุจู‡ุง ู„ุฏูุน ุฑุณูˆู… ุงู„ู…ุนุงู…ู„ุฉุŒ ุนู„ู‰ ุณุจูŠู„ ุงู„ู…ุซุงู„ ETH ู„ุณู„ุงุณู„ ุงู„ูƒุชู„ ุงู„ู‚ุงุฆู…ุฉ ุนู„ู‰ EVMุŒ ูˆBTC ู„ู€ Tether Omni." + }, + "networkRecords": { + "type": "array", + "description": "ููŠ ุญุงู„ุฉ ุญุฏูˆุซ ู…ุนุงู…ู„ุฉ ูˆุงุญุฏุฉ ู…ุน ุนู…ู„ูŠุงุช ู†ู‚ู„ ู…ุชุนุฏุฏุฉุŒ ุนู„ู‰ ุณุจูŠู„ ุงู„ู…ุซุงู„ ู†ุชูŠุฌุฉ ุงุณุชุฏุนุงุก ุนู‚ุฏุŒ ูุฅู† ู‡ุฐู‡ ุงู„ู…ุนู„ู…ุฉ ุชุญุฏุฏ ูƒู„ ุนู…ู„ูŠุฉ ู†ู‚ู„ ุชู…ุช ุนู„ู‰ blockchain. ููŠ ุญุงู„ุฉ ู…ุนุงู…ู„ุฉ ู†ู‚ู„ ูˆุงุญุฏุฉุŒ ุชูƒูˆู† ู‡ุฐู‡ ุงู„ู…ุนู„ู…ุฉ ูุงุฑุบุฉ.", + "items": { + "$ref": "#/components/schemas/NetworkRecord" + } + }, + "createdAt": { + "type": "number", + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ุฅู†ุดุงุก ุงู„ู…ุนุงู…ู„ุฉุŒ ููŠ ุงู„ุทุงุจุน ุงู„ุฒู…ู†ูŠ ู„ู†ุธุงู… ูŠูˆู†ูƒุณ." + }, + "lastUpdated": { + "type": "number", + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ุขุฎุฑ ุชุญุฏูŠุซ ู„ู„ู…ุนุงู…ู„ุฉุŒ ููŠ ุงู„ุทุงุจุน ุงู„ุฒู…ู†ูŠ ู„ู†ุธุงู… ูŠูˆู†ูƒุณ." + }, + "createdBy": { + "type": "string", + "description": "ู…ุนุฑู ุงู„ู…ุณุชุฎุฏู… ู„ู…ู†ุดุฆ ุงู„ู…ุนุงู…ู„ุฉ." + }, + "signedBy": { + "type": "array", + "description": "ู…ุนุฑูุงุช ุงู„ู…ุณุชุฎุฏู… ู„ู„ู…ูˆู‚ุนูŠู† ุนู„ู‰ ุงู„ู…ุนุงู…ู„ุฉ.", + "items": { + "type": "string" + } + }, + "rejectedBy": { + "type": "string", + "description": "ู…ุนุฑู ุงู„ู…ุณุชุฎุฏู… ุงู„ุฐูŠ ุฑูุถ ุงู„ู…ุนุงู…ู„ุฉ (ููŠ ุญุงู„ุฉ ุฑูุถู‡ุง)." + }, + "authorizationInfo": { + "$ref": "#/components/schemas/AuthorizationInfo" + }, + "exchangeTxId": { + "type": "string", + "description": "ุฅุฐุง ูƒุงู†ุช ุงู„ู…ุนุงู…ู„ุฉ ุตุงุฏุฑุฉ ู…ู† ุจูˆุฑุตุฉุŒ ูู‡ุฐุง ู‡ูˆ ู…ุนุฑู ู‡ุฐู‡ ุงู„ู…ุนุงู…ู„ุฉ ููŠ ุงู„ุจูˆุฑุตุฉ." + }, + "customerRefId": { + "type": "string", + "description": "ู…ุนุฑู ู…ู‚ุฏู…ูŠ ุฎุฏู…ุงุช ู…ูƒุงูุญุฉ ุบุณู„ ุงู„ุฃู…ูˆุงู„ ู„ุฑุจุท ู…ุงู„ูƒ ุงู„ุฃู…ูˆุงู„ ุจุงู„ู…ุนุงู…ู„ุงุช." + }, + "amlScreeningResult": { + "$ref": "#/components/schemas/AmlScreeningResult" + }, + "extraParameters": { + "$ref": "#/components/schemas/ExtraParameters" + }, + "signedMessages": { + "$ref": "#/components/schemas/SignedMessage" + }, + "numOfConfirmations": { + "type": "number", + "description": "ุนุฏุฏ ุชุฃูƒูŠุฏุงุช ุงู„ู…ุนุงู…ู„ุฉุŒ ุณูŠุฒุฏุงุฏ ุงู„ุนุฏุฏ ุญุชู‰ ูŠุชู… ุงุนุชุจุงุฑ ุงู„ู…ุนุงู…ู„ุฉ ู…ูƒุชู…ู„ุฉ ูˆูู‚ู‹ุง ู„ุณูŠุงุณุฉ ุงู„ุชุฃูƒูŠุฏ." + }, + "blockInfo": { + "$ref": "#/components/schemas/BlockInfo" + }, + "index": { + "type": "number", + "description": "ุจุงู„ู†ุณุจุฉ ู„ู„ุฃุตูˆู„ ุงู„ู…ุณุชู†ุฏุฉ ุฅู„ู‰ UTXOุŒ ู‡ุฐุง ู‡ูˆ vOutุŒ ูˆุจุงู„ู†ุณุจุฉ ู„ู„ุฃุตูˆู„ ุงู„ู…ุณุชู†ุฏุฉ ุฅู„ู‰ EthereumุŒ ู‡ุฐุง ู‡ูˆ ู…ุคุดุฑ ุญุฏุซ ุงุณุชุฏุนุงุก ุงู„ุนู‚ุฏ. **ู…ู„ุงุญุธุฉ:** ู„ุง ูŠุชู… ุฅุฑุฌุงุน ู‡ุฐุง ุงู„ุญู‚ู„ ุฅุฐุง ุงุณุชุฎุฏู…ุช ุงู„ู…ุนุงู…ู„ุฉ ูƒุงุฆู† `destinations` ุจุฃูƒุซุฑ ู…ู† ู‚ูŠู…ุฉ." + }, + "rewardInfo": { + "$ref": "#/components/schemas/RewardInfo" + }, + "systemMessages": { + "$ref": "#/components/schemas/SystemMessageInfo" + }, + "addressType": { + "oneOf": [ + { + "const": "WHITELISTED" + }, + { + "const": "ONE_TIME" + } + ] + }, + "requestedAmount": { + "description": "ุงู„ู…ุจู„ุบ ุงู„ุฐูŠ ูŠุทู„ุจู‡ ุงู„ู…ุณุชุฎุฏู…. ุบูŠุฑ ู…ุณุชุฎุฏู… - ูŠุฑุฌู‰ ุงุณุชุฎุฏุงู… ุญู‚ู„ `amountInfo` ู„ู„ุญุตูˆู„ ุนู„ู‰ ุงู„ุฏู‚ุฉ.", + "type": "number", + "deprecated": true + }, + "amount": { + "description": "ุฅุฐุง ูƒุงู† ุงู„ุชุญูˆูŠู„ ุนุจุงุฑุฉ ุนู† ุณุญุจ ู…ู† ุจูˆุฑุตุฉุŒ ูุฅู† ุงู„ู…ุจู„ุบ ุงู„ูุนู„ูŠ ุงู„ู…ุทู„ูˆุจ ุชุญูˆูŠู„ู‡. ูˆุฅู„ุงุŒ ูุฅู† ุงู„ู…ุจู„ุบ ุงู„ู…ุทู„ูˆุจ. ุบูŠุฑ ู…ุณุชุฎุฏู… - ูŠุฑุฌู‰ ุงุณุชุฎุฏุงู… ุญู‚ู„ `amountInfo` ู„ู„ุฏู‚ุฉ.", + "type": "number", + "deprecated": true + }, + "netAmount": { + "description": "ุงู„ู…ุจู„ุบ ุงู„ุตุงููŠ ู„ู„ู…ุนุงู…ู„ุฉุŒ ุจุนุฏ ุฎุตู… ุงู„ุฑุณูˆู…. ุบูŠุฑ ู…ุณุชุฎุฏู… - ูŠุฑุฌู‰ ุงุณุชุฎุฏุงู… ุญู‚ู„ `amountInfo` ู„ู„ุฏู‚ุฉ.", + "type": "number", + "deprecated": true + }, + "amountUSD": { + "oneOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "description": "ุงู„ู‚ูŠู…ุฉ ุจุงู„ุฏูˆู„ุงุฑ ุงู„ุฃู…ุฑูŠูƒูŠ ู„ู„ู…ุจู„ุบ ุงู„ู…ุทู„ูˆุจ. ุบูŠุฑ ู…ุณุชุฎุฏู… - ูŠุฑุฌู‰ ุงุณุชุฎุฏุงู… ุญู‚ู„ `amountInfo` ู„ู„ุญุตูˆู„ ุนู„ู‰ ุงู„ุฏู‚ุฉ." + }, + "serviceFee": { + "description": "ุฅุฌู…ุงู„ูŠ ุงู„ุฑุณูˆู… ุงู„ุชูŠ ุฎุตู…ู‡ุง ุงู„ุจูˆุฑุตุฉ ู…ู† ุงู„ู…ุจู„ุบ ุงู„ู…ุทู„ูˆุจ ูุนู„ูŠู‹ุง (`serviceFee` = `amount` - `netAmount`). ุบูŠุฑ ู…ุณุชุฎุฏู… - ูŠุฑุฌู‰ ุงุณุชุฎุฏุงู… ุญู‚ู„ `feeInfo` ู„ู„ุฏู‚ุฉ.", + "type": "number", + "deprecated": true + }, + "fee": { + "description": "ุชู… ุฅูŠู‚ุงู ุงู„ุนู…ู„ ุจู‡ - ูŠุฑุฌู‰ ุงุณุชุฎุฏุงู… ุญู‚ู„ `feeInfo` ู„ู„ุญุตูˆู„ ุนู„ู‰ ุงู„ุฏู‚ุฉ.", + "type": "number", + "deprecated": true + }, + "networkFee": { + "description": "ุงู„ุฑุณูˆู… ุงู„ู…ุฏููˆุนุฉ ู„ู„ุดุจูƒุฉ. ุบูŠุฑ ู…ุณุชุฎุฏู…ุฉ - ูŠุฑุฌู‰ ุงุณุชุฎุฏุงู… ุญู‚ู„ `feeInfo` ู„ู„ุฏู‚ุฉ.", + "type": "number", + "deprecated": true + } + } + }, + "TransactionResponseDestination": { + "type": "object", + "properties": { + "destination": { + "$ref": "#/components/schemas/DestinationTransferPeerPathResponse" + }, + "destinationAddress": { + "description": "ุงู„ุนู†ูˆุงู† ุงู„ุฐูŠ ุชู… ููŠู‡ ู†ู‚ู„ ุงู„ุฃุตูˆู„." + }, + "destinationAddressDescription": { + "description": "ูˆุตู ุงู„ุนู†ูˆุงู†." + }, + "amount": { + "type": "string", + "description": "ุงู„ู…ุจู„ุบ ุงู„ู…ุฑุงุฏ ุฅุฑุณุงู„ู‡ ุฅู„ู‰ ู‡ุฐู‡ ุงู„ูˆุฌู‡ุฉ." + }, + "amountUSD": { + "type": "string", + "description": "ุงู„ู‚ูŠู…ุฉ ุจุงู„ุฏูˆู„ุงุฑ ุงู„ุฃู…ุฑูŠูƒูŠ ู„ู„ู…ุจู„ุบ ุงู„ู…ุทู„ูˆุจ." + }, + "amlScreeningResult": { + "$ref": "#/components/schemas/AmlScreeningResult" + }, + "customerRefId": { + "description": "ู…ุนุฑู ู…ู‚ุฏู…ูŠ ุฎุฏู…ุงุช ู…ูƒุงูุญุฉ ุบุณู„ ุงู„ุฃู…ูˆุงู„ ู„ุฑุจุท ู…ุงู„ูƒ ุงู„ุฃู…ูˆุงู„ ุจุงู„ู…ุนุงู…ู„ุงุช." + }, + "authorizationInfo": { + "$ref": "#/components/schemas/AuthorizationInfo" + } + } + }, + "NetworkRecord": { + "type": "object", + "properties": { + "source": { + "$ref": "#/components/schemas/SourceTransferPeerPathResponse" + }, + "destination": { + "$ref": "#/components/schemas/DestinationTransferPeerPathResponse" + }, + "txHash": { + "type": "string" + }, + "networkFee": { + "type": "string" + }, + "assetId": { + "type": "string", + "x-fb-entity": "asset" + }, + "netAmount": { + "description": "ุงู„ู…ุจู„ุบ ุงู„ุตุงููŠ ู„ู„ู…ุนุงู…ู„ุฉ ุจุนุฏ ุฎุตู… ุงู„ุฑุณูˆู…", + "type": "string" + }, + "isDropped": { + "type": "boolean" + }, + "type": { + "type": "string" + }, + "destinationAddress": { + "type": "string" + }, + "sourceAddress": { + "type": "string" + }, + "amountUSD": { + "type": "string" + }, + "index": { + "type": "number" + }, + "rewardInfo": { + "$ref": "#/components/schemas/RewardInfo" + } + } + }, + "AssetTypeResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "type": { + "oneOf": [ + { + "const": "ALGO_ASSET" + }, + { + "const": "BASE_ASSET" + }, + { + "const": "BEP20" + }, + { + "const": "COMPOUND" + }, + { + "const": "ERC20" + }, + { + "const": "FIAT" + }, + { + "const": "SOL_ASSET" + }, + { + "const": "TRON_TRC20" + }, + { + "const": "XLM_ASSET" + }, + { + "const": "XDB_ASSET" + } + ] + }, + "contractAddress": { + "type": "string" + }, + "nativeAsset": { + "type": "string" + }, + "decimals": { + "type": "number" + } + }, + "required": [ + "id", + "name", + "type" + ] + }, + "NetworkConnection": { + "type": "object", + "properties": { + "localNetworkId": { + "type": "string", + "description": "ู…ุนุฑู ุงู„ุดุจูƒุฉ ู„ู„ู…ู„ู ุงู„ุดุฎุตูŠ ุงู„ุฐูŠ ูŠุญุงูˆู„ ุฅู†ุดุงุก ุงู„ุงุชุตุงู„." + }, + "remoteNetworkId": { + "type": "string", + "description": "ู…ุนุฑู ุงู„ุดุจูƒุฉ ุงู„ุฐูŠ ูŠุญุงูˆู„ ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ ุงู„ุงุชุตุงู„ ุจู‡." + }, + "routingPolicy": { + "$ref": "#/components/schemas/NetworkConnectionRoutingPolicy" + } + }, + "required": [ + "localNetworkId", + "remoteNetworkId" + ] + }, + "NetworkConnectionResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "localChannel": { + "deprecated": true, + "description": "ุชู… ุฅูŠู‚ุงู ุงุณุชุฎุฏุงู…ู‡ - ุชู… ุงุณุชุจุฏุงู„ู‡ ุจู€ `localNetworkId`", + "type": "object", + "properties": { + "networkId": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "remoteChannel": { + "deprecated": true, + "description": "ุชู… ุฅูŠู‚ุงู ุงุณุชุฎุฏุงู…ู‡ - ุชู… ุงุณุชุจุฏุงู„ู‡ ุจู€ `remoteNetworkId`", + "type": "object", + "properties": { + "networkId": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "status": { + "$ref": "#/components/schemas/ConfigChangeRequestStatus" + }, + "localNetworkId": { + "$ref": "#/components/schemas/NetworkId" + }, + "remoteNetworkId": { + "$ref": "#/components/schemas/NetworkId" + }, + "routingPolicy": { + "$ref": "#/components/schemas/NetworkConnectionRoutingPolicy" + } + }, + "required": [ + "id", + "localNetworkId", + "remoteNetworkId", + "routingPolicy", + "status" + ] + }, + "EstimatedTransactionFeeResponse": { + "type": "object", + "properties": { + "low": { + "$ref": "#/components/schemas/TransactionFee" + }, + "medium": { + "$ref": "#/components/schemas/TransactionFee" + }, + "high": { + "$ref": "#/components/schemas/TransactionFee" + } + }, + "required": [ + "low", + "medium", + "high" + ] + }, + "EstimatedNetworkFeeResponse": { + "type": "object", + "properties": { + "low": { + "$ref": "#/components/schemas/NetworkFee" + }, + "medium": { + "$ref": "#/components/schemas/NetworkFee" + }, + "high": { + "$ref": "#/components/schemas/NetworkFee" + } + }, + "required": [ + "low", + "medium", + "high" + ] + }, + "GasStationPropertiesResponse": { + "type": "object", + "properties": { + "balance": { + "type": "object" + }, + "configuration": { + "$ref": "#/components/schemas/GasStationConfiguration" + } + }, + "required": [ + "low", + "medium", + "high" + ] + }, + "TransactionFee": { + "type": "object", + "properties": { + "feePerByte": { + "type": "string" + }, + "gasPrice": { + "type": "string" + }, + "gasLimit": { + "type": "string" + }, + "networkFee": { + "type": "string" + }, + "baseFee": { + "description": "(ุงุฎุชูŠุงุฑูŠ) ุฑุณูˆู… ุฃุณุงุณูŠุฉ ูˆูู‚ู‹ุง ู„ู€ EIP-1559 (ุฃุตูˆู„ ETH)", + "type": "string" + }, + "priorityFee": { + "description": "(ุงุฎุชูŠุงุฑูŠ) ุฑุณูˆู… ุงู„ุฃูˆู„ูˆูŠุฉ ูˆูู‚ู‹ุง ู„ู€ EIP-1559 (ุฃุตูˆู„ ETH)", + "type": "string" + } + } + }, + "NetworkFee": { + "type": "object", + "properties": { + "feePerByte": { + "type": "string" + }, + "gasPrice": { + "type": "string" + }, + "networkFee": { + "type": "string" + }, + "baseFee": { + "description": "(ุงุฎุชูŠุงุฑูŠ) ุฑุณูˆู… ุฃุณุงุณูŠุฉ ูˆูู‚ู‹ุง ู„ู€ EIP-1559 (ุฃุตูˆู„ ETH)", + "type": "string" + }, + "priorityFee": { + "description": "(ุงุฎุชูŠุงุฑูŠ) ุฑุณูˆู… ุงู„ุฃูˆู„ูˆูŠุฉ ูˆูู‚ู‹ุง ู„ู€ EIP-1559 (ุฃุตูˆู„ ETH)", + "type": "string" + } + } + }, + "GasStationConfiguration": { + "type": "object", + "properties": { + "gasThreshold": { + "type": "string" + }, + "gasCap": { + "type": "string" + }, + "maxGasPrice": { + "type": "string" + } + } + }, + "NetworkChannel": { + "deprecated": true, + "description": "ุชู… ุฅูŠู‚ุงู ุงุณุชุฎุฏุงู…ู‡ ููŠ ุงู„ู…ุฑุฌุน ุงู„ู…ุณุชุฎุฏู… ุงู„ูˆุญูŠุฏ - NetworkConnectionResponse", + "type": "object", + "properties": { + "networkId": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "NetworkId": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "name" + ] + }, + "NetworkIdResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "routingPolicy": { + "$ref": "#/components/schemas/NetworkIdRoutingPolicy" + }, + "isDiscoverable": { + "type": "boolean", + "description": "ุงู„ุดุจูƒุฉ ุงู„ู…ุญุฏุฏุฉ ู‚ุงุจู„ุฉ ู„ู„ุงูƒุชุดุงู." + } + } + }, + "TransactionRequest": { + "type": "object", + "properties": { + "operation": { + "$ref": "#/components/schemas/TransactionOperation" + }, + "note": { + "type": "string", + "description": "ู…ู„ุงุญุธุฉ ู…ุฎุตุตุฉุŒ ู„ู… ูŠุชู… ุฅุฑุณุงู„ู‡ุง ุฅู„ู‰ blockchainุŒ ู„ูˆุตู ุงู„ู…ุนุงู…ู„ุฉ ููŠ ู…ุณุงุญุฉ ุนู…ู„ Fireblocks ุงู„ุฎุงุตุฉ ุจูƒ.", + "example": "Ticket 123" + }, + "externalTxId": { + "type": "string", + "description": "ู…ุนู„ู…ุฉ ุงุฎุชูŠุงุฑูŠุฉ ูˆู„ูƒู†ู‡ุง ู…ูˆุตู‰ ุจู‡ุง ุจุดุฏุฉ. ุณูŠุฑูุถ Fireblocks ุงู„ู…ุนุงู…ู„ุงุช ุงู„ู…ุณุชู‚ุจู„ูŠุฉ ุจู†ูุณ ุงู„ู…ุนุฑู. ูŠุฌุจ ุนู„ูŠูƒ ุชุนูŠูŠู† ู‡ุฐุง ุนู„ู‰ ู…ุนุฑู ูุฑูŠุฏ ูŠู…ุซู„ ุงู„ู…ุนุงู…ู„ุฉุŒ ู„ุชุฌู†ุจ ุฅุฑุณุงู„ ู†ูุณ ุงู„ู…ุนุงู…ู„ุฉ ู…ุฑุชูŠู†. ูŠุณุงุนุฏ ู‡ุฐุง ููŠ ุงู„ุญุงู„ุงุช ุงู„ุชูŠ ูŠุณุชุฌูŠุจ ููŠู‡ุง ุฅุฑุณุงู„ ุงู„ู…ุนุงู…ู„ุฉ ุจุฑู…ุฒ ุฎุทุฃ ุจุณุจุจ ุงู†ู‚ุทุงุน ุงู„ุฅู†ุชุฑู†ุชุŒ ูˆู„ูƒู† ุงู„ู…ุนุงู…ู„ุฉ ุชู… ุฅุฑุณุงู„ู‡ุง ูˆู…ุนุงู„ุฌุชู‡ุง ุจุงู„ูุนู„. ู„ู„ุชุญู‚ู‚ ู…ู…ุง ุฅุฐุง ูƒุงู†ุช ุงู„ู…ุนุงู…ู„ุฉ ู‚ุฏ ุชู…ุช ู…ุนุงู„ุฌุชู‡ุงุŒ [ุงุจุญุซ ุนู† ู…ุนุงู…ู„ุฉ ู…ุญุฏุฏุฉ ู…ู† ุฎู„ุงู„ ู…ุนุฑู ุงู„ู…ุนุงู…ู„ุฉ ุงู„ุฎุงุฑุฌูŠุฉ](https://developers.fireblocks.com/reference/get_transactions-external-tx-id-externaltxid). ู„ุง ูŠูˆุฌุฏ ุชู†ุณูŠู‚ ู…ุญุฏุฏ ู…ุทู„ูˆุจ ู„ู‡ุฐู‡ ุงู„ู…ุนู„ู…ุฉ.", + "example": "00000000-0000-0000-0000-000000000000" + }, + "assetId": { + "type": "string", + "description": "ู…ุนุฑู ุงู„ุฃุตู„ ุงู„ู…ุฑุงุฏ ู†ู‚ู„ู‡ุŒ ู„ุนู…ู„ูŠุงุช `TRANSFER` ุฃูˆ `MINT` ุฃูˆ `BURN`. [ุฑุงุฌุน ู‚ุงุฆู…ุฉ ุงู„ุฃุตูˆู„ ุงู„ู…ุฏุนูˆู…ุฉ ูˆู…ุนุฑูุงุชู‡ุง ุนู„ู‰ Fireblocks.](https://developers.fireblocks.com/reference/get_supported-assets)", + "x-fb-entity": "asset", + "example": "ETH" + }, + "source": { + "$ref": "#/components/schemas/TransferPeerPath" + }, + "destination": { + "$ref": "#/components/schemas/DestinationTransferPeerPath" + }, + "destinations": { + "type": "array", + "description": "ุจุงู„ู†ุณุจุฉ ู„ุณู„ุงุณู„ ุงู„ูƒุชู„ ุงู„ู…ุณุชู†ุฏุฉ ุฅู„ู‰ UTXOุŒ ูŠู…ูƒู†ูƒ ุฅุฑุณุงู„ ู…ุนุงู…ู„ุฉ ูˆุงุญุฏุฉ ุฅู„ู‰ ูˆุฌู‡ุงุช ู…ุชุนุฏุฏุฉ.", + "items": { + "$ref": "#/components/schemas/TransactionRequestDestination" + } + }, + "amount": { + "oneOf": [ + { + "type": "string", + "description": "ุณู„ุณู„ุฉ ุฑู‚ู…ูŠุฉ (ู…ูˆุตู‰ ุจู‡ุง)", + "example": "0.02" + }, + { + "type": "number", + "description": "ุงู„ุฑู‚ู… (ุบูŠุฑ ู…ุณุชุฎุฏู…)", + "example": 0.02 + } + ], + "description": "ุจุงู„ู†ุณุจุฉ ู„ุนู…ู„ูŠุงุช `TRANSFER`ุŒ ุงู„ู…ุจู„ุบ ุงู„ู…ุทู„ูˆุจ ู†ู‚ู„ู‡ุŒ ุจูˆุญุฏุฉ ุงู„ุฃุตู„. ุชูˆุตูŠ Fireblocks ุจุงุณุชุฎุฏุงู… ุณู„ุณู„ุฉ ุฑู‚ู…ูŠุฉ ู„ู„ุญุตูˆู„ ุนู„ู‰ ุฏู‚ุฉ ุฏู‚ูŠู‚ุฉ. ุนู„ู‰ ุงู„ุฑุบู… ู…ู† ูˆุฌูˆุฏ ุฅุฏุฎุงู„ ุฑู‚ู…ูŠุŒ ุฅู„ุง ุฃู†ู‡ ุฃุตุจุญ ู‚ุฏูŠู…ู‹ุง." + }, + "treatAsGrossAmount": { + "type": "boolean", + "description": ""ุนู†ุฏ ุถุจุทู‡ ุนู„ู‰ "true"ุŒ ุณูŠุชู… ุฎุตู… ุงู„ุฑุณูˆู… ู…ู† ุงู„ู…ุจู„ุบ ุงู„ู…ุทู„ูˆุจ." **ู…ู„ุงุญุธุฉ**: ู„ุง ูŠู…ูƒู† ุงุนุชุจุงุฑ ู‡ุฐู‡ ุงู„ู…ุนู„ู…ุฉ ุฅู„ุง ุฅุฐุง ูƒุงู† ุฃุตู„ ุงู„ู…ุนุงู…ู„ุฉ ุฃุตู„ู‹ุง ุฃุณุงุณูŠู‹ุงุŒ ู…ุซู„ ETH ุฃูˆ MATIC. ุฅุฐุง ู„ู… ูŠูƒู† ู…ู† ุงู„ู…ู…ูƒู† ุงุณุชุฎุฏุงู… ุงู„ุฃุตู„ ู„ุฑุณูˆู… ุงู„ู…ุนุงู…ู„ุงุชุŒ ู…ุซู„ USDCุŒ ูุณูŠุชู… ุชุฌุงู‡ู„ ู‡ุฐู‡ ุงู„ู…ุนู„ู…ุฉ ูˆูŠุชู… ุฎุตู… ุงู„ุฑุณูˆู… ู…ู† ู…ุญูุธุฉ ุงู„ุฃุตูˆู„ ุงู„ุฃุณุงุณูŠุฉ ุฐุงุช ุงู„ุตู„ุฉ ููŠ ุงู„ุญุณุงุจ ุงู„ู…ุตุฏุฑ.", + "example": false + }, + "forceSweep": { + "type": "boolean", + "description": "ุจุงู„ู†ุณุจุฉ ู„ู…ุนุงู…ู„ุงุช Polkadot ูˆKusama ูˆWestend ูู‚ุท. ุนู†ุฏ ุถุจุทู‡ุง ุนู„ู‰ trueุŒ ุณุชู‚ูˆู… Fireblocks ุจุฅูุฑุงุบ ู…ุญูุธุฉ ุงู„ุฃุตูˆู„. **ู…ู„ุงุญุธุฉ:** ุฅุฐุง ุชู… ุถุจุทู‡ุง ุนู„ู‰ true ุนู†ุฏู…ุง ูŠูƒูˆู† ุญุณุงุจ ุงู„ู…ุตุฏุฑ 1 DOT ุจุงู„ุถุจุทุŒ ูุณุชูุดู„ ุงู„ู…ุนุงู…ู„ุฉ. ุฃูŠ ู…ุจู„ุบ ุฃูƒุจุฑ ุฃูˆ ุฃู‚ู„ ู…ู† 1 DOT ูŠู†ุฌุญ. ู‡ุฐุง ู‡ูˆ ุฃุญุฏ ู‚ูŠูˆุฏ ุณู„ุณู„ุฉ ุงู„ูƒุชู„ Polkadot.", + "example": false + }, + "feeLevel": { + "oneOf": [ + { + "const": "LOW" + }, + { + "const": "MEDIUM" + }, + { + "const": "HIGH" + } + ], + "description": "ู„ุณู„ุงุณู„ ุงู„ูƒุชู„ ุงู„ู…ุณุชู†ุฏุฉ ุฅู„ู‰ UTXO ุฃูˆ EVM ูู‚ุท. ูŠุญุฏุฏ ู…ุณุชูˆู‰ ุฑุณูˆู… ุณู„ุณู„ุฉ ุงู„ูƒุชู„ ุงู„ุชูŠ ุณูŠุชู… ุฏูุนู‡ุง ู…ู‚ุงุจู„ ุงู„ู…ุนุงู…ู„ุฉ. ุจุฏู„ุงู‹ ู…ู† ุฐู„ูƒุŒ ุชูˆุฌุฏ ู…ุนู„ู…ุงุช ุชู‚ุฏูŠุฑ ุฑุณูˆู… ู…ุญุฏุฏุฉ ุฃุฏู†ุงู‡.", + "example": "MEDIUM" + }, + "fee": { + "oneOf": [ + { + "type": "string", + "description": "ุณู„ุณู„ุฉ ุฑู‚ู…ูŠุฉ (ู…ูˆุตู‰ ุจู‡ุง)" + }, + { + "type": "number", + "description": "ุงู„ุฑู‚ู… (ุบูŠุฑ ู…ุณุชุฎุฏู…)" + } + ], + "description": "ุจุงู„ู†ุณุจุฉ ู„ุณู„ุงุณู„ ุงู„ูƒุชู„ ุงู„ู…ุณุชู†ุฏุฉ ุฅู„ู‰ UTXOุŒ ุงู„ุฑุณูˆู… ู„ูƒู„ ุจุงูŠุช ููŠ ุฃุตุบุฑ ูˆุญุฏุฉ ู„ู„ุฃุตู„ (ุณุงุชูˆุดูŠุŒ ู„ุงุชูˆุดูŠุŒ ุฅู„ุฎ). ุจุงู„ู†ุณุจุฉ ู„ู€ RippleุŒ ุงู„ุฑุณูˆู… ุงู„ุฎุงุตุฉ ุจุงู„ู…ุนุงู…ู„ุฉ. ุชูˆุตูŠ Fireblocks ุจุงุณุชุฎุฏุงู… ุณู„ุณู„ุฉ ุฑู‚ู…ูŠุฉ ู„ู„ุญุตูˆู„ ุนู„ู‰ ุฏู‚ุฉ ุฏู‚ูŠู‚ุฉ. ุนู„ู‰ ุงู„ุฑุบู… ู…ู† ูˆุฌูˆุฏ ุฅุฏุฎุงู„ ุฑู‚ู…ูŠุŒ ุฅู„ุง ุฃู†ู‡ ุฃุตุจุญ ู‚ุฏูŠู…ู‹ุง." + }, + "priorityFee": { + "oneOf": [ + { + "type": "string", + "description": "ุณู„ุณู„ุฉ ุฑู‚ู…ูŠุฉ (ู…ูˆุตู‰ ุจู‡ุง)", + "example": "2" + }, + { + "type": "number", + "description": "ุงู„ุฑู‚ู… (ุบูŠุฑ ู…ุณุชุฎุฏู…)", + "example": 2 + } + ], + "description": "ุจุงู„ู†ุณุจุฉ ู„ุณู„ุงุณู„ ุงู„ูƒุชู„ ุงู„ู…ุณุชู†ุฏุฉ ุฅู„ู‰ Ethereum ูู‚ุทุŒ ุงู„ุฑุณูˆู… ุงู„ุฎุงุตุฉ ุจุขู„ูŠุฉ ุชุณุนูŠุฑ ุงู„ู…ุนุงู…ู„ุงุช EIP-1559. ุงู„ู‚ูŠู…ุฉ ุจุงู„ุฌูŠูˆูŠ. ุชูˆุตูŠ Fireblocks ุจุงุณุชุฎุฏุงู… ุณู„ุณู„ุฉ ุฑู‚ู…ูŠุฉ ู„ู„ุญุตูˆู„ ุนู„ู‰ ุฏู‚ุฉ ุฏู‚ูŠู‚ุฉ. ุนู„ู‰ ุงู„ุฑุบู… ู…ู† ูˆุฌูˆุฏ ุฅุฏุฎุงู„ ุฑู‚ู…ูŠุŒ ุฅู„ุง ุฃู†ู‡ ุฃุตุจุญ ู‚ุฏูŠู…ู‹ุง." + }, + "failOnLowFee": { + "type": "boolean", + "description": "ุนู†ุฏ ุถุจุทู‡ ุนู„ู‰ "true"ุŒ ููŠ ุญุงู„ุฉ ุงุฑุชูุงุน ู…ุณุชูˆู‰ ุงู„ุฑุณูˆู… "MEDIUM" ุงู„ุญุงู„ูŠ ุนู† ุงู„ู…ุณุชูˆู‰ ุงู„ู…ุญุฏุฏ ููŠ ุงู„ู…ุนุงู…ู„ุฉุŒ ุณุชูุดู„ ุงู„ู…ุนุงู…ู„ุฉ ู„ุชุฌู†ุจ ุงู„ุชุนุทู„ ุจุฏูˆู† ุชุฃูƒูŠุฏุงุช." + }, + "maxFee": { + "description": "ุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ ู„ู„ุฑุณูˆู… (ุณุนุฑ ุงู„ุบุงุฒ ุฃูˆ ุงู„ุฑุณูˆู… ู„ูƒู„ ุจุงูŠุช) ุงู„ุชูŠ ูŠุฌุจ ุฏูุนู‡ุง ู…ู‚ุงุจู„ ุงู„ู…ุนุงู…ู„ุฉ. ููŠ ุญุงู„ุฉ ุฃู† ุงู„ู‚ูŠู…ุฉ ุงู„ุญุงู„ูŠุฉ ู„ู€ `feeLevel` ุงู„ู…ุทู„ูˆุจุฉ ุฃุนู„ู‰ ู…ู† ุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ ู„ู„ุฑุณูˆู… ุงู„ู…ุทู„ูˆุจุฉ. ูŠุชู… ุชู…ุซูŠู„ู‡ุง ุจุณู„ุณู„ุฉ ุฑู‚ู…ูŠุฉ ู„ู„ุญุตูˆู„ ุนู„ู‰ ุฏู‚ุฉ ุฏู‚ูŠู‚ุฉ.", + "type": "string", + "example": "120" + }, + "gasLimit": { + "oneOf": [ + { + "type": "string", + "description": "ุณู„ุณู„ุฉ ุฑู‚ู…ูŠุฉ (ู…ูˆุตู‰ ุจู‡ุง)", + "example": "21000" + }, + { + "type": "number", + "description": "ุงู„ุฑู‚ู… (ุบูŠุฑ ู…ุณุชุฎุฏู…)", + "example": 21000 + } + ], + "description": "ู„ุณู„ุงุณู„ ุงู„ูƒุชู„ ุงู„ู…ุณุชู†ุฏุฉ ุฅู„ู‰ EVM ูู‚ุท. ูˆุญุฏุงุช ุงู„ุบุงุฒ ุงู„ู…ุทู„ูˆุจุฉ ู„ู…ุนุงู„ุฌุฉ ุงู„ู…ุนุงู…ู„ุฉ. ู…ู„ุงุญุธุฉ: ู„ุง ูŠู…ูƒู† ุชุญุฏูŠุฏ ุณูˆู‰ ุงุซู†ูŠู† ู…ู† ุงู„ุญุฌุฌ ุงู„ุซู„ุงุซุฉ ููŠ ู…ุนุงู…ู„ุฉ ูˆุงุญุฏุฉ: `gasLimit` ูˆ`gasPrice` ูˆ`networkFee`. ุชูˆุตูŠ Fireblocks ุจุงุณุชุฎุฏุงู… ุณู„ุณู„ุฉ ุฑู‚ู…ูŠุฉ ู„ู„ุญุตูˆู„ ุนู„ู‰ ุฏู‚ุฉ ุฏู‚ูŠู‚ุฉ. ุนู„ู‰ ุงู„ุฑุบู… ู…ู† ูˆุฌูˆุฏ ุฅุฏุฎุงู„ ุฑู‚ู…ูŠุŒ ุฅู„ุง ุฃู†ู‡ ุฃุตุจุญ ู‚ุฏูŠู…ู‹ุง." + }, + "gasPrice": { + "oneOf": [ + { + "type": "string", + "description": "ุณู„ุณู„ุฉ ุฑู‚ู…ูŠุฉ (ู…ูˆุตู‰ ุจู‡ุง)" + }, + { + "type": "number", + "description": "ุงู„ุฑู‚ู… (ุบูŠุฑ ู…ุณุชุฎุฏู…)" + } + ], + "description": "ุจุงู„ู†ุณุจุฉ ู„ู„ู…ุนุงู…ู„ุงุช ุบูŠุฑ ุงู„ู…ุนุชู…ุฏุฉ ุนู„ู‰ EIP-1559ุŒ ุงู„ู‚ุงุฆู…ุฉ ุนู„ู‰ EVM. ุงู„ุณุนุฑ ู„ูƒู„ ูˆุญุฏุฉ ุบุงุฒ (ููŠ EthereumุŒ ูŠุชู… ุชุญุฏูŠุฏ ุฐู„ูƒ ููŠ Gwei). ู…ู„ุงุญุธุฉ: ู„ุง ูŠู…ูƒู† ุชุญุฏูŠุฏ ุณูˆู‰ ุงุซู†ูŠู† ู…ู† ุงู„ุญุฌุฌ ุงู„ุซู„ุงุซุฉ ููŠ ู…ุนุงู…ู„ุฉ ูˆุงุญุฏุฉ: `gasLimit` ูˆ`gasPrice` ูˆ`networkFee`. ุชูˆุตูŠ Fireblocks ุจุงุณุชุฎุฏุงู… ุณู„ุณู„ุฉ ุฑู‚ู…ูŠุฉ ู„ู„ุญุตูˆู„ ุนู„ู‰ ุฏู‚ุฉ ุฏู‚ูŠู‚ุฉ. ุนู„ู‰ ุงู„ุฑุบู… ู…ู† ูˆุฌูˆุฏ ุฅุฏุฎุงู„ ุฑู‚ู…ูŠุŒ ุฅู„ุง ุฃู†ู‡ ุฃุตุจุญ ู‚ุฏูŠู…ู‹ุง." + }, + "networkFee": { + "oneOf": [ + { + "type": "string", + "description": "ุณู„ุณู„ุฉ ุฑู‚ู…ูŠุฉ (ู…ูˆุตู‰ ุจู‡ุง)" + }, + { + "type": "number", + "description": "ุงู„ุฑู‚ู… (ุบูŠุฑ ู…ุณุชุฎุฏู…)" + } + ], + "description": "ู„ุณู„ุงุณู„ ุงู„ูƒุชู„ ุงู„ู…ุณุชู†ุฏุฉ ุฅู„ู‰ EVM ูู‚ุท. ุฅุฌู…ุงู„ูŠ ุฑุณูˆู… ุงู„ู…ุนุงู…ู„ุฉ ููŠ ุฃูƒุจุฑ ูˆุญุฏุฉ ููŠ ุณู„ุณู„ุฉ ุงู„ูƒุชู„. ู…ู„ุงุญุธุฉ: ู„ุง ูŠู…ูƒู† ุชุญุฏูŠุฏ ุณูˆู‰ ุงุซู†ูŠู† ู…ู† ุงู„ุญุฌุฌ ุงู„ุซู„ุงุซุฉ ููŠ ู…ุนุงู…ู„ุฉ ูˆุงุญุฏุฉ: `gasLimit` ูˆ`gasPrice` ูˆ`networkFee`. ุชูˆุตูŠ Fireblocks ุจุงุณุชุฎุฏุงู… ุณู„ุณู„ุฉ ุฑู‚ู…ูŠุฉ ู„ู„ุญุตูˆู„ ุนู„ู‰ ุฏู‚ุฉ ุฏู‚ูŠู‚ุฉ. ุนู„ู‰ ุงู„ุฑุบู… ู…ู† ูˆุฌูˆุฏ ุฅุฏุฎุงู„ ุฑู‚ู…ูŠุŒ ุฅู„ุง ุฃู†ู‡ ู‚ุฏูŠู…. - ุฑุณูˆู… ุณู„ุณู„ุฉ ุงู„ูƒุชู„ ู„ู„ู…ุนุงู…ู„ุงุช. - ุจุงู„ู†ุณุจุฉ ุฅู„ู‰ EthereumุŒ ู„ุง ูŠู…ูƒู†ูƒ ุชู…ุฑูŠุฑ gasPrice ูˆgasLimit ูˆnetworkFee ู…ุนู‹ุง. - ูŠู„ุฒู… ุชู…ุซูŠู„ ุงู„ู‚ูŠู…ุฉ ุงู„ุฑู‚ู…ูŠุฉ." + }, + "replaceTxByHash": { + "type": "string", + "description": "ู„ุณู„ุงุณู„ ุงู„ูƒุชู„ ุงู„ู…ุณุชู†ุฏุฉ ุฅู„ู‰ EVM ูู‚ุท. ููŠ ุญุงู„ุฉ ุชุนุทู„ ู…ุนุงู…ู„ุฉุŒ ุญุฏุฏ ุชุฌุฒุฆุฉ ุงู„ู…ุนุงู…ู„ุฉ ุงู„ู…ุชูˆู‚ูุฉ ู„ุงุณุชุจุฏุงู„ู‡ุง ุจู‡ุฐู‡ ุงู„ู…ุนุงู…ู„ุฉ ุจุฑุณูˆู… ุฃุนู„ู‰ุŒ ุฃูˆ ู„ุงุณุชุจุฏุงู„ู‡ุง ุจู‡ุฐู‡ ุงู„ู…ุนุงู…ู„ุฉ ุจุฑุณูˆู… ุตูุฑูŠุฉ ูˆุฅุณู‚ุงุทู‡ุง ู…ู† ุณู„ุณู„ุฉ ุงู„ูƒุชู„.", + "example": "00000000-0000-0000-0000-000000000000" + }, + "extraParameters": { + "$ref": "#/components/schemas/ExtraParameters" + }, + "customerRefId": { + "type": "string", + "description": "ู…ุนุฑู ู…ู‚ุฏู…ูŠ ุฎุฏู…ุงุช ู…ูƒุงูุญุฉ ุบุณู„ ุงู„ุฃู…ูˆุงู„ ู„ุฑุจุท ู…ุงู„ูƒ ุงู„ุฃู…ูˆุงู„ ุจุงู„ู…ุนุงู…ู„ุงุช.", + "example": "abcdef" + }, + "autoStaking": { + "type": "boolean", + "description": "ู„ู… ุชุนุฏ ู‡ุฐู‡ ุงู„ู…ูŠุฒุฉ ู…ุฏุนูˆู…ุฉ.", + "deprecated": true + }, + "networkStaking": { + "oneOf": [ + { + "type": "string", + "description": "ุณู„ุณู„ุฉ ุฑู‚ู…ูŠุฉ (ู…ูˆุตู‰ ุจู‡ุง)" + }, + { + "type": "number", + "description": "ุงู„ุฑู‚ู… (ุบูŠุฑ ู…ุณุชุฎุฏู…)" + } + ], + "description": "ู„ู… ุชุนุฏ ู‡ุฐู‡ ุงู„ู…ูŠุฒุฉ ู…ุฏุนูˆู…ุฉ." + }, + "cpuStaking": { + "oneOf": [ + { + "type": "string", + "description": "ุณู„ุณู„ุฉ ุฑู‚ู…ูŠุฉ (ู…ูˆุตู‰ ุจู‡ุง)" + }, + { + "type": "number", + "description": "ุงู„ุฑู‚ู… (ุบูŠุฑ ู…ุณุชุฎุฏู…)" + } + ], + "description": "ู„ู… ุชุนุฏ ู‡ุฐู‡ ุงู„ู…ูŠุฒุฉ ู…ุฏุนูˆู…ุฉ." + } + } + }, + "TransactionRequestDestination": { + "type": "object", + "properties": { + "amount": { + "type": "string" + }, + "destination": { + "$ref": "#/components/schemas/DestinationTransferPeerPath" + } + } + }, + "ExchangeType": { + "oneOf": [ + { + "const": "BINANCE" + }, + { + "const": "BINANCEUS" + }, + { + "const": "BITFINEX" + }, + { + "const": "BITHUMB" + }, + { + "const": "BITMEX" + }, + { + "const": "BITSO" + }, + { + "const": "BITSTAMP" + }, + { + "const": "BITTREX" + }, + { + "const": "CIRCLE" + }, + { + "const": "COINBASEPRO" + }, + { + "const": "COINMETRO" + }, + { + "const": "COINSPRO" + }, + { + "const": "CRYPTOCOM" + }, + { + "const": "DERIBIT" + }, + { + "const": "FTX" + }, + { + "const": "FIXUS" + }, + { + "const": "GEMINI" + }, + { + "const": "HITBTC" + }, + { + "const": "HUOBI" + }, + { + "const": "KORBIT" + }, + { + "const": "KRAKEN" + }, + { + "const": "LIQUID" + }, + { + "const": "POLONIEX" + }, + { + "const": "OKCOIN" + }, + { + "const": "OKEX" + }, + { + "const": "SEEDCX" + } + ] + }, + "FiatAccountType": { + "const": "BLINC" + }, + "ConfigChangeRequestStatus": { + "oneOf": [ + { + "const": "WAITING_FOR_APPROVAL" + }, + { + "const": "APPROVED" + }, + { + "const": "CANCELLED" + }, + { + "const": "REJECTED" + }, + { + "const": "FAILED" + } + ] + }, + "TransactionOperation": { + "oneOf": [ + { + "const": "TRANSFER" + }, + { + "const": "BURN" + }, + { + "const": "CONTRACT_CALL" + }, + { + "const": "MINT" + }, + { + "const": "RAW" + }, + { + "const": "TYPED_MESSAGE" + } + ], + "description": "* `TRANSFER` - ุงู„ู‚ูŠู…ุฉ ุงู„ุงูุชุฑุงุถูŠุฉ ู„ุนู…ู„ูŠุฉ ู…ุง. ุชู†ู‚ู„ ุงู„ุฃู…ูˆุงู„ ู…ู† ุญุณุงุจ ุฅู„ู‰ ุขุฎุฑ. ุชุณู…ุญ ุณู„ุงุณู„ ุงู„ูƒุชู„ UTXO ุจุงู„ุชุญูˆูŠู„ุงุช ู…ุชุนุฏุฏุฉ ุงู„ู…ุฏุฎู„ุงุช ูˆุงู„ู…ุฎุฑุฌุงุช. ุชุณู…ุญ ุฌู…ูŠุน ุณู„ุงุณู„ ุงู„ูƒุชู„ ุงู„ุฃุฎุฑู‰ ุจุงู„ุชุญูˆูŠู„ุงุช ุจุนู†ูˆุงู† ู…ุตุฏุฑ ูˆุงุญุฏ ูˆุนู†ูˆุงู† ูˆุฌู‡ุฉ ูˆุงุญุฏ. * `MINT` - ุชุทุจุน ุฑู…ูˆุฒู‹ุง ุฌุฏูŠุฏุฉ. ู…ุฏุนูˆู…ุฉ ู„ุณู„ุงุณู„ ุงู„ูƒุชู„ ุงู„ู‚ุงุฆู…ุฉ ุนู„ู‰ Stellar ูˆRipple ูˆEVM. * `BURN` - ุชุญุฑู‚ ุงู„ุฑู…ูˆุฒ. ู…ุฏุนูˆู…ุฉ ู„ุณู„ุงุณู„ ุงู„ูƒุชู„ ุงู„ู‚ุงุฆู…ุฉ ุนู„ู‰ Stellar ูˆRipple ูˆEVM. * `CONTRACT_CALL` - ุชุณุชุฏุนูŠ ุทุฑูŠู‚ุฉ ุนู‚ุฏ ุฐูƒูŠุฉ ู„ุนู…ู„ูŠุงุช ุงู„ูˆูŠุจ 3 ุนู„ู‰ ุฃูŠ ุณู„ุณู„ุฉ ูƒุชู„ EVM. ูŠูˆุตู‰ ุจุงุณุชุฎุฏุงู… [ู…ูƒุชุจุงุช ุงู„ุชุทูˆูŠุฑ] (https://developers.fireblocks.com/docs/ethereum-development#convenience-libraries) ููŠ Fireblocks ู„ุจู†ุงุก ู…ุนุงู…ู„ุงุช ุงุณุชุฏุนุงุก ุงู„ุนู‚ุฏ. * `TYPED_MESSAGE` - ุฑุณุงู„ุฉ ุฎุงุฑุฌ ุงู„ุณู„ุณู„ุฉ ุฅู…ุง ุจุชู†ุณูŠู‚ Ethereum Personal Message ุฃูˆ EIP712. ุงุณุชุฎุฏู…ู‡ ู„ุชูˆู‚ูŠุน ุฑุณุงุฆู„ ู…ุญุฏุฏุฉ ู‚ุงุจู„ุฉ ู„ู„ู‚ุฑุงุกุฉ ูˆู„ูŠุณุช ู…ุนุงู…ู„ุงุช ูุนู„ูŠุฉ. [ุชุนุฑู ุนู„ู‰ ุงู„ู…ุฒูŠุฏ ุญูˆู„ ุงู„ุฑุณุงุฆู„ ุงู„ู…ูƒุชูˆุจุฉ](https://developers.fireblocks.com/docs/typed-message-signing). * `RAW` - ุฑุณุงู„ุฉ ุฎุงุฑุฌ ุงู„ุณู„ุณู„ุฉ ุจุฏูˆู† ุชู†ุณูŠู‚ ู…ุญุฏุฏ ู…ุณุจู‚ู‹ุง. ุงุณุชุฎุฏู…ู‡ ู„ุชูˆู‚ูŠุน ุฃูŠ ุฑุณุงู„ุฉ ุจู…ูุชุงุญูƒ ุงู„ุฎุงุตุŒ ุจู…ุง ููŠ ุฐู„ูƒ ุงู„ุจุฑูˆุชูˆูƒูˆู„ุงุช ู…ุซู„ blockchains ูˆุฃู†ูˆุงุน ุงู„ู…ุนุงู…ู„ุงุช ุงู„ู…ุฎุตุตุฉ ุงู„ุชูŠ ู„ุง ูŠุฏุนู…ู‡ุง Fireblocks ุจุดูƒู„ ุฃุตู„ูŠ. [ุชุนุฑู ุนู„ู‰ ุงู„ู…ุฒูŠุฏ ุญูˆู„ ู…ุนุงู…ู„ุงุช ุงู„ุชูˆู‚ูŠุน ุงู„ุฎุงู….](https://developers.fireblocks.com/docs/raw-message-signing)" + }, + "GetTransactionOperation": { + "oneOf": [ + { + "const": "TRANSFER" + }, + { + "const": "BURN" + }, + { + "const": "CONTRACT_CALL" + }, + { + "const": "MINT" + }, + { + "const": "RAW" + }, + { + "const": "TYPED_MESSAGE" + }, + { + "const": "ENABLE_ASSET" + }, + { + "const": "STAKE" + }, + { + "const": "UNSTAKE" + }, + { + "const": "WITHDRAW" + }, + { + "const": "REDEEM_FROM_COMPOUND" + }, + { + "const": "SUPPLY_TO_COMPOUND" + } + ], + "description": "* `TRANSFER` - ูŠู†ู‚ู„ ุงู„ุฃู…ูˆุงู„ ู…ู† ุญุณุงุจ ุฅู„ู‰ ุขุฎุฑ. ุชุณู…ุญ ุณู„ุงุณู„ ุงู„ูƒุชู„ UTXO ุจุงู„ุชุญูˆูŠู„ุงุช ู…ุชุนุฏุฏุฉ ุงู„ู…ุฏุฎู„ุงุช ูˆุงู„ู…ุฎุฑุฌุงุช. ุชุณู…ุญ ุฌู…ูŠุน ุณู„ุงุณู„ ุงู„ูƒุชู„ ุงู„ุฃุฎุฑู‰ ุจุงู„ุชุญูˆูŠู„ุงุช ุจุนู†ูˆุงู† ู…ุตุฏุฑ ูˆุงุญุฏ ูˆุนู†ูˆุงู† ูˆุฌู‡ุฉ ูˆุงุญุฏ. * `MINT` - ูŠุทุจุน ุฑู…ูˆุฒู‹ุง ุฌุฏูŠุฏุฉ. ู…ุฏุนูˆู… ู„ุณู„ุงุณู„ ุงู„ูƒุชู„ ุงู„ู‚ุงุฆู…ุฉ ุนู„ู‰ Stellar ูˆRipple ูˆEVM. * `BURN` - ูŠุญุฑู‚ ุงู„ุฑู…ูˆุฒ. ู…ุฏุนูˆู… ู„ุณู„ุงุณู„ ุงู„ูƒุชู„ ุงู„ู‚ุงุฆู…ุฉ ุนู„ู‰ Stellar ูˆRipple ูˆEVM. * `CONTRACT_CALL` - ูŠุณุชุฏุนูŠ ุทุฑูŠู‚ุฉ ุนู‚ุฏ ุฐูƒูŠุฉ ู„ุนู…ู„ูŠุงุช ุงู„ูˆูŠุจ 3 ุนู„ู‰ ุฃูŠ ุณู„ุณู„ุฉ ูƒุชู„ EVM. ูŠูˆุตู‰ ุจุงุณุชุฎุฏุงู… [ู…ูƒุชุจุงุช ุงู„ุชุทูˆูŠุฑ] Fireblocks (https://developers.fireblocks.com/docs/ethereum-development#convenience-libraries) ู„ุจู†ุงุก ู…ุนุงู…ู„ุงุช ุงุณุชุฏุนุงุก ุงู„ุนู‚ุฏ. * `TYPED_MESSAGE` - ุฑุณุงู„ุฉ ุฎุงุฑุฌ ุงู„ุณู„ุณู„ุฉ ุฅู…ุง ุจุชู†ุณูŠู‚ Ethereum Personal Message ุฃูˆ EIP712. ุงุณุชุฎุฏู…ู‡ุง ู„ุชูˆู‚ูŠุน ุฑุณุงุฆู„ ู…ุญุฏุฏุฉ ู‚ุงุจู„ุฉ ู„ู„ู‚ุฑุงุกุฉ ู„ูŠุณุช ู…ุนุงู…ู„ุงุช ูุนู„ูŠุฉ. [ุชุนุฑู ุนู„ู‰ ุงู„ู…ุฒูŠุฏ ุญูˆู„ ุงู„ุฑุณุงุฆู„ ุงู„ู…ูƒุชูˆุจุฉ](https://developers.fireblocks.com/docs/typed-message-signing). * `RAW` - ุฑุณุงู„ุฉ ุฎุงุฑุฌ ุงู„ุณู„ุณู„ุฉ ุจุฏูˆู† ุชู†ุณูŠู‚ ู…ุญุฏุฏ ู…ุณุจู‚ู‹ุง. ุงุณุชุฎุฏู…ู‡ุง ู„ุชูˆู‚ูŠุน ุฃูŠ ุฑุณุงู„ุฉ ุจู…ูุชุงุญูƒ ุงู„ุฎุงุตุŒ ุจู…ุง ููŠ ุฐู„ูƒ ุงู„ุจุฑูˆุชูˆูƒูˆู„ุงุช ู…ุซู„ ุณู„ุงุณู„ ุงู„ูƒุชู„ ูˆุฃู†ูˆุงุน ุงู„ู…ุนุงู…ู„ุงุช ุงู„ู…ุฎุตุตุฉ ุงู„ุชูŠ ู„ุง ูŠุฏุนู…ู‡ุง Fireblocks ุจุดูƒู„ ุฃุตู„ูŠ. [ุชุนุฑู ุนู„ู‰ ุงู„ู…ุฒูŠุฏ ุญูˆู„ ู…ุนุงู…ู„ุงุช ุงู„ุชูˆู‚ูŠุน ุงู„ุฎุงู….](https://developers.fireblocks.com/docs/raw-message-signing) * `ENABLE_ASSET` - ุชุชุทู„ุจ Algorand ูˆDigitalBits ูˆSolana ูˆStellar ู…ุนุงู…ู„ุฉ ุนู„ู‰ ุงู„ุณู„ุณู„ุฉ ู„ุฅู†ุดุงุก ู…ุญูุธุฉ ุฃุตูˆู„ ูˆุชู…ูƒูŠู† ุนู†ูˆุงู† ุงู„ุฅูŠุฏุงุน. ูŠุชู… ุฅู†ุดุงุก ู‡ุฐู‡ ุงู„ู…ุนุงู…ู„ุฉ ุชู„ู‚ุงุฆูŠู‹ุง ุนู†ุฏ ุฅุถุงูุฉ ุฃุตูˆู„ ุนู„ู‰ ุณู„ุงุณู„ ุงู„ูƒุชู„ ู‡ุฐู‡ ููŠ ุญุณุงุจ ุฎุฒู†ุฉ. * `STAKE` - ุชุนูŠูŠู† ุฃุตูˆู„ ู„ู…ุฌู…ูˆุนุฉ ุชุฎุฒูŠู† ูŠุฏูŠุฑู‡ุง ู…ุญู‚ู‚ ุชุฎุฒูŠู†. ู…ุฏุนูˆู… ู„ุณู„ุงุณู„ ุงู„ูƒุชู„ ุงู„ู‚ุงุฆู…ุฉ ุนู„ู‰ Stellar ูˆEVM. ูŠุชู… ุฅู†ุดุงุก ู‡ุฐู‡ ุงู„ู…ุนุงู…ู„ุฉ ุชู„ู‚ุงุฆูŠู‹ุง ุนู†ุฏ ุฅุฌุฑุงุก ุนู…ู„ูŠุงุช ุงู„ุชุฎุฒูŠู†. * `UNSTAKE` - ุฅุฒุงู„ุฉ ุงู„ุฃุตูˆู„ ู…ู† ู…ุฌู…ูˆุนุฉ ุงู„ุชุฎุฒูŠู† ุงู„ุชูŠ ูŠุฏูŠุฑู‡ุง ู…ุญู‚ู‚ ุงู„ุชุฎุฒูŠู†. ู…ุฏุนูˆู… ู„ุณู„ุงุณู„ ุงู„ูƒุชู„ ุงู„ู‚ุงุฆู…ุฉ ุนู„ู‰ Stellar ูˆEVM. ูŠุชู… ุฅู†ุดุงุก ู‡ุฐู‡ ุงู„ู…ุนุงู…ู„ุฉ ุชู„ู‚ุงุฆูŠู‹ุง ุนู†ุฏ ุฅุฌุฑุงุก ุนู…ู„ูŠุงุช ุงู„ุชุฎุฒูŠู†. * `WITHDRAW` - ู†ู‚ู„ ุงู„ุฃุตูˆู„ ู…ู† ุญุณุงุจ ู…ุฎุฒู† ุชุฎุฒูŠู† ู…ุฎุตุต ุฅู„ู‰ ุนู†ูˆุงู† ุขุฎุฑ. ู…ุฏุนูˆู… ู„ุณู„ุงุณู„ ุงู„ูƒุชู„ ุงู„ู‚ุงุฆู…ุฉ ุนู„ู‰ Stellar ูˆEVM. ูŠุชู… ุฅู†ุดุงุก ู‡ุฐู‡ ุงู„ู…ุนุงู…ู„ุฉ ุชู„ู‚ุงุฆูŠู‹ุง ุนู†ุฏ ุฅุฌุฑุงุก ุนู…ู„ูŠุงุช ุงู„ุชุฎุฒูŠู†. **ู…ู„ุงุญุธุฉ:** ุณุชุนูŠุฏ Fireblocks ุชุณู…ูŠุฉ ู‡ุฐุง ุงู„ู†ูˆุน ู…ู† `WITHDRAW` ุฅู„ู‰ ุงุณู… ู†ูˆุน ู…ุฎุชู„ู ู‚ุฑูŠุจู‹ุง. ุณูŠูƒูˆู† ู‡ู†ุงูƒ ุฅุดุนุงุฑ ู„ู…ุฏุฉ 7 ุฃูŠุงู… ุจุฎุตูˆุต ุงุณู… ุงู„ู†ูˆุน ุงู„ุฌุฏูŠุฏ. * `SUPPLY_TO_COMPOUND` - ุชู… ุฅูŠู‚ุงูู‡ ู…ู†ุฐ 1 ุฃุจุฑูŠู„ 2023. ู‚ุฏ ูŠูƒูˆู† ู‡ุฐุง ู‡ูˆ ุชุดุบูŠู„ ุงู„ู…ุนุงู…ู„ุงุช ุงู„ู‚ุฏูŠู…ุฉุŒ ููŠ ุญุงู„ุฉ ุงุณุชุฎุฏุงู… ุงู„ู…ุณุชุฎุฏู…ูŠู† ููŠ ู…ุณุงุญุฉ ุงู„ุนู…ู„ ู„ู„ุชูƒุงู…ู„ ุงู„ู…ุจุงุดุฑ ุจูŠู† Fireblocks ูˆุจุฑูˆุชูˆูƒูˆู„ Compound DeFI. * `REDEEM_FROM_COMPOUND` - ุชู… ุฅูŠู‚ุงูู‡ ู…ู†ุฐ 1 ุฃุจุฑูŠู„ 2023. ู‚ุฏ ูŠูƒูˆู† ู‡ุฐุง ู‡ูˆ ุงู„ุชุดุบูŠู„ ู„ู„ู…ุนุงู…ู„ุงุช ุงู„ู‚ุฏูŠู…ุฉุŒ ููŠ ุญุงู„ุฉ ุงุณุชุฎุฏุงู… ุงู„ู…ุณุชุฎุฏู…ูŠู† ููŠ ู…ุณุงุญุฉ ุงู„ุนู…ู„ ู„ู„ุชูƒุงู…ู„ ุงู„ู…ุจุงุดุฑ ุจูŠู† Fireblocks ูˆุจุฑูˆุชูˆูƒูˆู„ Compound DeFI." + }, + "Error": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "code": { + "type": "number" + } + } + }, + "Term": { + "type": "object", + "properties": { + "networkConnectionId": { + "type": "string" + }, + "outgoing": { + "type": "boolean" + }, + "asset": { + "type": "string" + }, + "amount": { + "type": "string" + }, + "note": { + "type": "string" + }, + "operation": { + "type": "string" + } + } + }, + "SetConfirmationsThresholdRequest": { + "type": "object", + "properties": { + "numOfConfirmations": { + "type": "number" + } + } + }, + "SetConfirmationsThresholdResponse": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + }, + "transactions": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DropTransactionRequest": { + "type": "object", + "properties": { + "txId": { + "type": "string" + }, + "feeLevel": { + "type": "string" + }, + "gasPrice": { + "type": "string" + } + } + }, + "DropTransactionResponse": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + }, + "transactions": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "UnsignedMessage": { + "type": "object", + "properties": { + "content": { + "type": "string" + }, + "bip44addressIndex": { + "type": "integer" + }, + "bip44change": { + "type": "number" + }, + "derivationPath": { + "type": "array", + "items": { + "type": "number" + } + } + }, + "required": [ + "content" + ] + }, + "SignedMessage": { + "type": "object", + "description": "ู‚ุงุฆู…ุฉ ุงู„ุฑุณุงุฆู„ ุงู„ู…ูˆู‚ุนุฉ ุงู„ุชูŠ ุชู… ุฅุฑุฌุงุนู‡ุง ู„ู„ุชูˆู‚ูŠุน ุงู„ุฎุงู….", + "properties": { + "content": { + "type": "string" + }, + "algorithm": { + "oneOf": [ + { + "const": "MPC_ECDSA_SECP256K1" + }, + { + "const": "MPC_EDDSA_ED25519" + } + ] + }, + "derivationPath": { + "type": "array", + "items": { + "type": "number" + } + }, + "signature": { + "type": "object", + "properties": { + "fullSig": { + "type": "string" + }, + "r": { + "type": "string" + }, + "s": { + "type": "string" + }, + "v": { + "type": "number" + } + } + }, + "publicKey": { + "type": "string" + } + } + }, + "PublicKeyInformation": { + "type": "object", + "properties": { + "algorithm": { + "type": "string" + }, + "derivationPath": { + "type": "array", + "items": { + "type": "number" + } + }, + "publicKey": { + "type": "string" + } + } + }, + "TradingAccountType": { + "oneOf": [ + { + "const": "COIN_FUTURES" + }, + { + "const": "COIN_MARGINED_SWAP" + }, + { + "const": "EXCHANGE" + }, + { + "const": "FUNDING" + }, + { + "const": "FUNDABLE" + }, + { + "const": "FUTURES" + }, + { + "const": "FUTURES_CROSS" + }, + { + "const": "MARGIN" + }, + { + "const": "MARGIN_CROSS" + }, + { + "const": "OPTIONS" + }, + { + "const": "SPOT" + }, + { + "const": "USDT_MARGINED_SWAP_CROSS" + }, + { + "const": "USDT_FUTURES" + }, + { + "const": "UNIFIED" + } + ] + }, + "ValidateAddressResponse": { + "type": "object", + "properties": { + "isValid": { + "type": "boolean" + }, + "isActive": { + "type": "boolean" + }, + "requiresTag": { + "type": "boolean" + } + } + }, + "ResendWebhooksResponse": { + "type": "object", + "properties": { + "messagesCount": { + "type": "number" + } + } + }, + "UnspentInputsResponse": { + "type": "object", + "properties": { + "input": { + "$ref": "#/components/schemas/UnspentInput" + }, + "address": { + "type": "string" + }, + "amount": { + "type": "string" + }, + "confirmations": { + "type": "number" + }, + "status": { + "type": "string" + } + } + }, + "UnspentInput": { + "type": "object", + "properties": { + "txHash": { + "type": "string" + }, + "index": { + "type": "number" + } + } + }, + "GetUsersResponse": { + "type": "object", + "properties": { + "users": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserResponse" + } + } + } + }, + "ExtraParameters": { + "type": "object", + "properties": {}, + "description": "ู…ุนู„ู…ุงุช ู‚ูŠู…ุฉ ุงู„ู…ูุชุงุญ ุงู„ุฅุถุงููŠุฉ ุงู„ุฎุงุตุฉ ุจุงู„ุจุฑูˆุชูˆูƒูˆู„/ุงู„ุนู…ู„ูŠุฉ: ู„ุงุฎุชูŠุงุฑ ู…ุฏุฎู„ุงุช blockchain ุงู„ู…ุณุชู†ุฏุฉ ุฅู„ู‰ UTXOุŒ ุฃุถู ุงู„ู…ูุชุงุญ `inputsSelection` ู…ุน ุชุนูŠูŠู† ุงู„ู‚ูŠู…ุฉ ุฅู„ู‰ [ู‡ูŠูƒู„ ุงุฎุชูŠุงุฑ ุงู„ู…ุฏุฎู„ุงุช.](https://developers.fireblocks.com/reference/transaction-objects#inputsselection) ูŠู…ูƒู† ุงุณุชุฑุฏุงุฏ ุงู„ู…ุฏุฎู„ุงุช ู…ู† [ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ ุงุณุชุฑุฏุงุฏ ุงู„ู…ุฏุฎู„ุงุช ุบูŠุฑ ุงู„ู…ู†ูู‚ุฉ.](https://developers.fireblocks.com/reference/get_vault-accounts-vaultaccountid-assetid-unspent-inputs) ุจุงู„ู†ุณุจุฉ ู„ุนู…ู„ูŠุงุช `RAW`ุŒ ุฃุถู ุงู„ู…ูุชุงุญ `rawMessageData` ู…ุน ุชุนูŠูŠู† ุงู„ู‚ูŠู…ุฉ ุฅู„ู‰ [ู‡ูŠูƒู„ ุจูŠุงู†ุงุช ุงู„ุฑุณุงู„ุฉ ุงู„ุฎุงู….](https://developers.fireblocks.com/reference/raw-signing-objects#rawmessagedata) ุจุงู„ู†ุณุจุฉ ู„ุนู…ู„ูŠุงุช `CONTRACT_CALL`ุŒ ุฃุถู ุงู„ู…ูุชุงุญ `contractCallData` ู…ุน ุชุนูŠูŠู† ุงู„ู‚ูŠู…ุฉ ุฅู„ู‰ Ethereum ุญู…ูˆู„ุฉ ูˆุงุฌู‡ุฉ ุงู„ุชุทุจูŠู‚ ุงู„ุซู†ุงุฆูŠุฉ ู„ู„ุนู‚ูˆุฏ ุงู„ุฐูƒูŠุฉ (ABI). ูŠูˆุตู‰ ุจุงุณุชุฎุฏุงู… [ู…ูƒุชุจุงุช ุงู„ุชุทูˆูŠุฑ] (https://developers.fireblocks.com/docs/ethereum-development#convenience-libraries) ููŠ Fireblocks ู„ุจู†ุงุก ู…ุนุงู…ู„ุงุช ุงุณุชุฏุนุงุก ุงู„ุนู‚ูˆุฏ." + }, + "NetworkIdRoutingPolicy": { + "type": "object", + "properties": { + "crypto": { + "oneOf": [ + { + "$ref": "#/components/schemas/CustomCryptoRoutingDest" + }, + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + } + ] + }, + "sen": { + "oneOf": [ + { + "$ref": "#/components/schemas/CustomFiatRoutingDest" + }, + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + } + ] + }, + "signet": { + "oneOf": [ + { + "$ref": "#/components/schemas/CustomFiatRoutingDest" + }, + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + } + ] + }, + "sen_test": { + "oneOf": [ + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + }, + { + "$ref": "#/components/schemas/CustomFiatRoutingDest" + } + ] + }, + "signet_test": { + "oneOf": [ + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + }, + { + "$ref": "#/components/schemas/CustomFiatRoutingDest" + } + ] + } + } + }, + "NetworkConnectionRoutingPolicy": { + "type": "object", + "properties": { + "crypto": { + "oneOf": [ + { + "$ref": "#/components/schemas/CustomCryptoRoutingDest" + }, + { + "$ref": "#/components/schemas/DefaultNetworkRoutingDest" + }, + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + } + ] + }, + "sen": { + "oneOf": [ + { + "$ref": "#/components/schemas/CustomFiatRoutingDest" + }, + { + "$ref": "#/components/schemas/DefaultNetworkRoutingDest" + }, + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + } + ] + }, + "signet": { + "oneOf": [ + { + "$ref": "#/components/schemas/DefaultNetworkRoutingDest" + }, + { + "$ref": "#/components/schemas/CustomFiatRoutingDest" + }, + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + } + ] + }, + "sen_test": { + "oneOf": [ + { + "$ref": "#/components/schemas/DefaultNetworkRoutingDest" + }, + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + }, + { + "$ref": "#/components/schemas/CustomFiatRoutingDest" + } + ] + }, + "signet_test": { + "oneOf": [ + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + }, + { + "$ref": "#/components/schemas/CustomFiatRoutingDest" + }, + { + "$ref": "#/components/schemas/DefaultNetworkRoutingDest" + } + ] + } + } + }, + "CustomFiatRoutingDest": { + "type": "object", + "properties": { + "scheme": { + "const": "CUSTOM", + "description": "ู…ู†ุทู‚ ุชูˆุฌูŠู‡ ุงู„ุดุจูƒุฉ." + }, + "dstType": { + "const": "FIAT_ACCOUNT", + "description": "ุงู„ุญุณุงุจ ุงู„ูˆุฑู‚ูŠ ุงู„ุฐูŠ ูŠุชู… ุฅุฑุณุงู„ ุงู„ุฃู…ูˆุงู„ ุฅู„ูŠู‡." + }, + "dstId": { + "type": "string", + "description": "ู…ุนุฑู ุงู„ุญุณุงุจ ุงู„ูˆุฑู‚ูŠ ุงู„ุฐูŠ ูŠุชู… ุฅุฑุณุงู„ ุงู„ุฃู…ูˆุงู„ ุฅู„ูŠู‡." + } + }, + "required": [ + "scheme", + "dstType", + "dstId" + ] + }, + "CustomCryptoRoutingDest": { + "type": "object", + "properties": { + "scheme": { + "const": "CUSTOM", + "description": "ู…ู†ุทู‚ ุชูˆุฌูŠู‡ ุงู„ุดุจูƒุฉ." + }, + "dstType": { + "oneOf": [ + { + "const": "VAULT" + }, + { + "const": "EXCHANGE" + } + ], + "description": "ู†ูˆุน ุญุณุงุจ ุงู„ูˆุฌู‡ุฉ ุงู„ุฐูŠ ูŠุชู… ุฅุฑุณุงู„ ุงู„ุฃู…ูˆุงู„ ุฅู„ูŠู‡." + }, + "dstId": { + "type": "string", + "description": "ู…ุนุฑู ุงู„ุญุณุงุจ ุงู„ูˆุฌู‡ุฉ ุงู„ุฐูŠ ูŠุชู… ุฅุฑุณุงู„ ุงู„ุฃู…ูˆุงู„ ุฅู„ูŠู‡." + } + }, + "required": [ + "scheme", + "dstType", + "dstId" + ] + }, + "DefaultNetworkRoutingDest": { + "type": "object", + "properties": { + "scheme": { + "const": "DEFAULT", + "description": "ู…ู†ุทู‚ ุชูˆุฌูŠู‡ ุงู„ุดุจูƒุฉ." + } + }, + "required": [ + "scheme" + ] + }, + "NoneNetworkRoutingDest": { + "type": "object", + "properties": { + "scheme": { + "const": "NONE", + "description": "ู„ุง ูŠูˆุฌุฏ ู…ู†ุทู‚ ุชูˆุฌูŠู‡ ุงู„ุดุจูƒุฉ." + } + }, + "required": [ + "scheme" + ] + }, + "UserResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "role": { + "type": "string" + }, + "email": { + "type": "string" + }, + "enabled": { + "type": "boolean" + } + } + }, + "SessionMetadata": { + "type": "object", + "properties": { + "appUrl": { + "type": "string" + }, + "appName": { + "type": "string" + }, + "appDescription": { + "type": "string" + }, + "appIcon": { + "type": "string" + } + }, + "required": [ + "appUrl" + ] + }, + "SessionDTO": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ู…ุนุฑู ุงู„ุงุชุตุงู„", + "example": "4e9e7051-f3b2-48e9-8ee6-b12492552657" + }, + "userId": { + "type": "string", + "description": "ู…ุนุฑู ุงู„ู…ุณุชุฎุฏู… ุงู„ุฐูŠ ุฃู†ุดุฃ ุงู„ุงุชุตุงู„" + }, + "sessionMetadata": { + "description": "ุจูŠุงู†ุงุช ุงู„ุงุชุตุงู„ ุงู„ูˆุตููŠุฉ (ุงู„ู…ู‚ุฏู…ุฉ ุจูˆุงุณุทุฉ ุงู„ุชุทุจูŠู‚ ุงู„ู„ุงู…ุฑูƒุฒูŠ)", + "type": "object", + "properties": { + "appUrl": { + "type": "string" + }, + "appName": { + "type": "string" + }, + "appDescription": { + "type": "string" + }, + "appIcon": { + "type": "string" + } + } + }, + "vaultAccountId": { + "type": "number", + "description": "ุงู„ุฎุฒู†ุฉ ู„ู„ุงุชุตุงู„", + "example": 1 + }, + "feeLevel": { + "oneOf": [ + { + "const": "MEDIUM" + }, + { + "const": "HIGH" + } + ], + "description": "ู…ุณุชูˆู‰ ุงู„ุฑุณูˆู… ุงู„ุงูุชุฑุงุถูŠ", + "example": "MEDIUM" + }, + "chainIds": { + "description": "ุงู„ุณู„ุงุณู„ ุงู„ู…ุนุชู…ุฏุฉ ู„ู„ุชูˆุตูŠู„", + "example": [ + "ETH", + "ETH_TEST", + "SOL" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "connectionType": { + "const": "WalletConnect", + "description": "ู†ูˆุน ุงู„ุงุชุตุงู„", + "example": "WalletConnect" + }, + "connectionMethod": { + "oneOf": [ + { + "const": "DESKTOP" + }, + { + "const": "MOBILE" + }, + { + "const": "API" + } + ], + "description": "ุงู„ุทุฑูŠู‚ุฉ ุงู„ุชูŠ ุชู… ู…ู† ุฎู„ุงู„ู‡ุง ุฅู†ุดุงุก ุงู„ุงุชุตุงู„", + "example": "API" + }, + "creationDate": { + "format": "date-time", + "type": "string", + "description": "ุนู„ุงู…ุฉ ุฒู…ู†ูŠุฉ ู„ุฅู†ุดุงุก ุงู„ุฌู„ุณุฉ" + } + }, + "required": [ + "id", + "userId", + "sessionMetadata", + "vaultAccountId", + "feeLevel", + "chainIds", + "connectionType", + "connectionMethod", + "creationDate" + ] + }, + "GetConnectionsResponse": { + "type": "object", + "properties": { + "data": { + "description": "ู…ุตููˆูุฉ ุชุญุชูˆูŠ ุนู„ู‰ ุจูŠุงู†ุงุช ุงุชุตุงู„ Web3 ุงู„ู…ุทู„ูˆุจุฉ", + "type": "array", + "items": { + "$ref": "#/components/schemas/SessionDTO" + } + }, + "paging": { + "$ref": "#/components/schemas/Paging" + } + }, + "required": [ + "data" + ] + }, + "CreateConnectionRequest": { + "type": "object", + "properties": { + "vaultAccountId": { + "type": "number", + "description": "ู…ุนุฑู ุงู„ุฎุฒู†ุฉ ุงู„ู…ุฑุงุฏ ุงู„ุงุชุตุงู„ ุจู‡ุง ุจุงุชุตุงู„ Web3.", + "example": 1 + }, + "feeLevel": { + "oneOf": [ + { + "const": "MEDIUM" + }, + { + "const": "HIGH" + } + ], + "description": "ู…ุณุชูˆู‰ ุงู„ุฑุณูˆู… ุงู„ุงูุชุฑุงุถูŠ. ุงู„ู‚ูŠู… ุงู„ุตุงู„ุญุฉ ู‡ูŠ `MEDIUM` ูˆ`HIGH`.", + "example": "MEDIUM" + }, + "uri": { + "type": "string", + "description": "ุนู†ูˆุงู† URI ู„ู€ WalletConnect ุงู„ุฐูŠ ูŠูˆูุฑู‡ ุงู„ุชุทุจูŠู‚ ุงู„ู„ุงู…ุฑูƒุฒูŠ.", + "example": "wc:77752975-906f-48f5-b59f-047826ee947e@1?bridge=https%3A%2F%2F0.bridge.walletconnect.org&key=64be99adc6086b7a729b0ec8c7e1f174927ab92e84f5c6f9527050225344a637" + }, + "chainIds": { + "description": "ู…ุนุฑู ุดุจูƒุฉ blockchain ุงู„ู…ุณุชุฎุฏู…ุฉ ููŠ ุงุชุตุงู„ Web3.", + "example": [ + "ETH", + "ETH_TEST" + ], + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "vaultAccountId", + "feeLevel", + "uri", + "chainIds" + ] + }, + "CreateConnectionResponse": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ู…ุนุฑู ุงุชุตุงู„ Web3 ุงู„ุฐูŠ ุชู… ุงู„ุจุฏุก ุจู‡.", + "example": "4e9e7051-f3b2-48e9-8ee6-b12492552657" + }, + "sessionMetadata": { + "description": "ุจูŠุงู†ุงุช ุชุนุฑูŠููŠุฉ ู„ุงุชุตุงู„ Web3 (ุงู„ู…ู‚ุฏู…ุฉ ุจูˆุงุณุทุฉ DApp).", + "type": "object", + "properties": { + "appUrl": { + "type": "string" + }, + "appName": { + "type": "string" + }, + "appDescription": { + "type": "string" + }, + "appIcon": { + "type": "string" + } + } + } + }, + "required": [ + "id", + "sessionMetadata" + ] + }, + "RespondToConnectionRequest": { + "type": "object", + "properties": { + "approve": { + "type": "boolean", + "description": "ุงู„ู…ูˆุงูู‚ุฉ ุนู„ู‰ ุงุชุตุงู„ Web3 ุงู„ุฐูŠ ุชู… ุงู„ุจุฏุก ููŠู‡.", + "example": true + } + }, + "required": [ + "approve" + ] + }, + "AddCollateralRequestBody": { + "type": "object", + "properties": { + "transactionRequest": { + "$ref": "#/components/schemas/TransactionRequest" + }, + "isSrcCollateral": { + "type": "boolean", + "description": "ุฎูŠุงุฑูŠ" + } + } + }, + "RemoveCollateralRequestBody": { + "type": "object", + "properties": { + "transactionRequest": { + "$ref": "#/components/schemas/TransactionRequest" + }, + "isDstCollateral": { + "type": "boolean", + "description": "ุฎูŠุงุฑูŠ" + } + } + }, + "SettlementRequestBody": { + "type": "object", + "properties": { + "mainExchangeAccountId": { + "type": "string" + } + } + }, + "SettlementResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "initiator": { + "type": "string" + }, + "exchangeReply": { + "type": "string" + }, + "fireblocksInitiatedTransactions": { + "type": "object" + }, + "exchangeRequestedTransactions": { + "$ref": "#/components/schemas/SettlementResponse" + } + } + }, + "GetSettlementResponse": { + "$ref": "#/components/schemas/SettlementResponse" + }, + "ToExchangeTransaction": { + "type": "object", + "properties": { + "assetId": { + "type": "string" + }, + "amount": { + "type": "string" + }, + "dstAddress": { + "type": "string" + }, + "dstTag": { + "type": "string", + "description": "ุฎูŠุงุฑูŠ" + } + } + }, + "ToCollateralTransaction": { + "type": "object", + "properties": { + "asset": { + "type": "string" + }, + "amount": { + "type": "string" + }, + "srcAddress": { + "type": "string" + }, + "srcTag": { + "type": "string", + "description": "ุฎูŠุงุฑูŠ" + }, + "fee": { + "type": "string", + "description": "ุฎูŠุงุฑูŠ" + } + } + }, + "XBSettlementConfigCreationRequestBody": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "ุงุณู… ุชูƒูˆูŠู† ุงู„ุชุณูˆูŠุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ" + }, + "corridorId": { + "$ref": "#/components/schemas/XBSettlementCorridorId" + }, + "steps": { + "$ref": "#/components/schemas/XBSettlementConfigStepsRecord" + }, + "conversionSlippageBasisPoints": { + "$ref": "#/components/schemas/XBSettlementConversionSlippageBasisPoints" + } + }, + "required": [ + "name", + "corridorId", + "steps" + ] + }, + "XBSettlementConfigCreationResponse": { + "$ref": "#/components/schemas/XBSettlementConfigModel" + }, + "XBSettlementConfigEditRequestBody": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "ุงุณู… ุชูƒูˆูŠู† ุงู„ุชุณูˆูŠุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ" + }, + "steps": { + "$ref": "#/components/schemas/XBSettlementConfigStepsRecord" + }, + "conversionSlippageBasisPoints": { + "$ref": "#/components/schemas/XBSettlementConversionSlippageBasisPoints" + } + }, + "required": [ + "name", + "steps" + ] + }, + "XBSettlementConfigEditResponse": { + "$ref": "#/components/schemas/XBSettlementConfigModel" + }, + "XBSettlementConfigDeletionResponse": { + "$ref": "#/components/schemas/XBSettlementConfigModel" + }, + "XBSettlementGetConfigResponse": { + "$ref": "#/components/schemas/XBSettlementConfigModel" + }, + "XBSettlementGetAllConfigsResponse": { + "type": "object", + "properties": { + "configurations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/XBSettlementConfigModel" + } + } + }, + "required": [ + "configurations" + ] + }, + "XBSettlementFlowExecutionRequestBody": { + "type": "object", + "properties": { + "conversionSlippageBasisPoints": { + "$ref": "#/components/schemas/XBSettlementConversionSlippageBasisPoints" + } + } + }, + "XBSettlementFlowExecutionResponse": { + "$ref": "#/components/schemas/XBSettlementFlowExecutionModel" + }, + "XBSettlementFlowExecutionStep": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ู„ุชู†ููŠุฐ ุงู„ุฎุทูˆุฉ" + }, + "accountId": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/XBSettlementFlowExecutionStepStatus" + }, + "inputAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "outputAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "fee": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "startedAt": { + "type": "number", + "description": "ูˆู‚ุช ุจุฏุก ุชู†ููŠุฐ ุงู„ุฎุทูˆุฉ ุจุชู†ุณูŠู‚ ุงู„ุนุตุฑ." + }, + "completedAt": { + "type": "number", + "description": "ูˆู‚ุช ุงู†ุชู‡ุงุก ุชู†ููŠุฐ ุงู„ุฎุทูˆุฉ ุจุชู†ุณูŠู‚ ุงู„ุนุตุฑ." + }, + "isSignRequired": { + "type": "boolean", + "description": "ู…ุง ุฅุฐุง ูƒุงู† ุงู„ุชูˆู‚ูŠุน ู…ุทู„ูˆุจู‹ุง ุฃู… ู„ุง ู„ุชู†ููŠุฐ ุงู„ุฎุทูˆุฉ." + } + }, + "required": [ + "id", + "accountId", + "status", + "inputAmount", + "isSignRequired" + ] + }, + "XBSettlementFlowExecutionStepStatus": { + "oneOf": [ + { + "const": "NOT_STARTED" + }, + { + "const": "PROCESSING" + }, + { + "const": "COMPLETED" + }, + { + "const": "FAILED" + } + ] + }, + "XBSettlementFlowExecutionStatus": { + "oneOf": [ + { + "const": "NOT_LAUNCHED" + }, + { + "const": "PROCESSING" + }, + { + "const": "COMPLETED" + }, + { + "const": "FAILED" + } + ] + }, + "XBSettlementConfigId": { + "type": "string", + "format": "uuid", + "description": "ู…ุนุฑู ูุฑูŠุฏ ู„ุชูƒูˆูŠู† Cross Bodrder" + }, + "XBSettlementConfigModel": { + "type": "object", + "properties": { + "configId": { + "$ref": "#/components/schemas/XBSettlementConfigId" + }, + "corridorId": { + "$ref": "#/components/schemas/XBSettlementCorridorId" + }, + "name": { + "type": "string", + "description": "ุงุณู… ุชูƒูˆูŠู† ุงู„ุงุณุชูŠุทุงู† ุนุจุฑ ุงู„ุญุฏูˆุฏ" + }, + "steps": { + "$ref": "#/components/schemas/XBSettlementConfigStepsRecord" + }, + "conversionSlippageBasisPoints": { + "$ref": "#/components/schemas/XBSettlementConversionSlippageBasisPoints" + }, + "createdAt": { + "type": "number", + "description": "ูˆู‚ุช ุงู„ุฅู†ุดุงุก ุจุตูŠุบุฉ ุงู„ุนุตุฑ." + } + }, + "required": [ + "configId", + "name", + "corridorId", + "steps", + "conversionSlippageBasisPoints", + "createdAt" + ] + }, + "XBSettlementCorridorId": { + "oneOf": [ + { + "const": "MX_US" + }, + { + "const": "CO_US" + }, + { + "const": "US_MX" + }, + { + "const": "US_EU" + }, + { + "const": "US_UK" + } + ], + "description": "- MX_US: ุงู„ู…ูƒุณูŠูƒ (MXN) ุฅู„ู‰ ุงู„ูˆู„ุงูŠุงุช ุงู„ู…ุชุญุฏุฉ ุงู„ุฃู…ุฑูŠูƒูŠุฉ (USD) - CO_US: ูƒูˆู„ูˆู…ุจูŠุง (COP) ุฅู„ู‰ ุงู„ูˆู„ุงูŠุงุช ุงู„ู…ุชุญุฏุฉ ุงู„ุฃู…ุฑูŠูƒูŠุฉ (USD) - US_MX: ุงู„ูˆู„ุงูŠุงุช ุงู„ู…ุชุญุฏุฉ ุงู„ุฃู…ุฑูŠูƒูŠุฉ (USD) ุฅู„ู‰ ุงู„ู…ูƒุณูŠูƒ (MXN) - US_EU: ุงู„ูˆู„ุงูŠุงุช ุงู„ู…ุชุญุฏุฉ ุงู„ุฃู…ุฑูŠูƒูŠุฉ (USD) ุฅู„ู‰ ุงู„ุงุชุญุงุฏ ุงู„ุฃูˆุฑูˆุจูŠ (EUR) - US_UK: ุงู„ูˆู„ุงูŠุงุช ุงู„ู…ุชุญุฏุฉ ุงู„ุฃู…ุฑูŠูƒูŠุฉ (USD) ุฅู„ู‰ ุงู„ู…ู…ู„ูƒุฉ ุงู„ู…ุชุญุฏุฉ (GBP)" + }, + "XBSettlementConfigStep": { + "type": "object", + "properties": { + "stepType": { + "$ref": "#/components/schemas/XBSettlementStepType" + }, + "accountId": { + "type": "string" + } + }, + "required": [ + "stepType", + "accountId" + ] + }, + "XBSettlementStepType": { + "oneOf": [ + { + "const": "ON_RAMP" + }, + { + "const": "VAULT_ACCOUNT" + }, + { + "const": "OFF_RAMP" + }, + { + "const": "FIAT_DESTINATION" + } + ], + "description": "- ON_RAMP: ุฎุฏู…ุฉ ุชุณู…ุญ ุจุชุจุงุฏู„ ุงู„ุนู…ู„ุงุช ุงู„ูˆุฑู‚ูŠุฉ ู…ู‚ุงุจู„ ุงู„ุนู…ู„ุงุช ุงู„ู…ุดูุฑุฉ. ุณุชูƒูˆู† ู‚ูŠู…ุฉ ุงู„ุฅุฏุฎุงู„ ููŠ OnRamp ุฏุงุฆู…ู‹ุง ุนู…ู„ุฉ ูˆุฑู‚ูŠุฉ ูˆุณุชูƒูˆู† ู‚ูŠู…ุฉ ุงู„ุฅุฎุฑุงุฌ ุฃุตู„ู‹ุง ู…ุดูุฑู‹ุง. - VAULT_ACCOUNT: ุญุณุงุจ Fireblocks Vault - OFF_RAMP: ุฎุฏู…ุฉ ุชุณู…ุญ ุจุชุจุงุฏู„ ุงู„ุนู…ู„ุงุช ุงู„ู…ุดูุฑุฉ ู…ู‚ุงุจู„ ุงู„ุนู…ู„ุงุช ุงู„ูˆุฑู‚ูŠุฉ. ุณุชูƒูˆู† ู‚ูŠู…ุฉ ุงู„ุฅุฏุฎุงู„ ููŠ OffRamp ุฏุงุฆู…ู‹ุง ุฃุตู„ู‹ุง ู…ุดูุฑู‹ุง ูˆุณุชูƒูˆู† ู‚ูŠู…ุฉ ุงู„ุฅุฎุฑุงุฌ ุนู…ู„ุฉ ูˆุฑู‚ูŠุฉ. - FIAT_DESTINATION: ุญุณุงุจ ููŠุงุช" + }, + "XBSettlementFlowSetupStep": { + "type": "object", + "properties": { + "accountId": { + "type": "string" + }, + "inputAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "outputAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "estimatedFeeAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "estimatedTime": { + "type": "number", + "description": "ุงู„ูˆู‚ุช ุงู„ู…ู‚ุฏุฑ ู„ุชู†ููŠุฐ ุงู„ุฎุทูˆุฉ." + }, + "isSignRequired": { + "type": "boolean", + "description": "ู…ุง ุฅุฐุง ูƒุงู† ุงู„ุชูˆู‚ูŠุน ู…ุทู„ูˆุจู‹ุง ุฃู… ู„ุง ู„ุชู†ููŠุฐ ุงู„ุฎุทูˆุฉ." + } + }, + "required": [ + "accountId", + "inputAmount", + "outputAmount", + "estimatedFeeAmount", + "estimatedTime", + "isSignRequired" + ] + }, + "XBSettlementGetFlowResponse": { + "type": "object", + "properties": { + "preview": { + "$ref": "#/components/schemas/XBSettlementFlowPreviewModel" + }, + "execution": { + "$ref": "#/components/schemas/XBSettlementFlowExecutionModel" + } + } + }, + "XBSettlementFlowPreviewModel": { + "type": "object", + "properties": { + "flowId": { + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ู„ู„ุชุฏูู‚ ุนุจุฑ ุงู„ุญุฏูˆุฏ." + }, + "configId": { + "$ref": "#/components/schemas/XBSettlementConfigId" + }, + "conversionRate": { + "type": "string", + "description": "ู…ุนุฏู„ ุงู„ุชุญูˆูŠู„ ุงู„ู…ุณุชู„ู… ู…ู† ุงู„ู…ู†ุญุฏุฑ ุฃูˆ ุงู„ู…ู†ุญุฏุฑ ุงู„ุฎุงุฑุฌูŠ." + }, + "inputAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "estimatedOutputAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "totalEstimatedFee": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "totalEstimatedTime": { + "type": "number", + "description": "ุฅุฌู…ุงู„ูŠ ุงู„ูˆู‚ุช ุงู„ู…ู‚ุฏุฑ ู„ุชู†ููŠุฐ ุงู„ุชุฏูู‚ ุนุจุฑ ุงู„ุญุฏูˆุฏ." + }, + "steps": { + "$ref": "#/components/schemas/XBSettlementFlowStepsRecord" + } + }, + "required": [ + "flowId", + "configId", + "steps", + "inputAmount", + "estimatedOutputAmount", + "totalEstimatedFee", + "totalEstimatedTime", + "conversionRate" + ] + }, + "XBSettlementCreateFlowRequestBody": { + "type": "object", + "properties": { + "configId": { + "$ref": "#/components/schemas/XBSettlementConfigId" + }, + "amount": { + "type": "string", + "description": "ุงู„ู…ุจู„ุบ ุงู„ู…ุฑุงุฏ ุชุญูˆูŠู„ู‡ ููŠ ู‡ุฐุง ุงู„ุชุฏูู‚ ุนุจุฑ ุงู„ุญุฏูˆุฏ. ูŠุชู… ุชุญุฏูŠุฏ ู†ูˆุน ุงู„ุฃุตูˆู„ ู…ู† ุฎู„ุงู„ ุชูƒูˆูŠู† ุงู„ุชุณูˆูŠุฉ ุนุจุฑ ุงู„ุญุฏูˆุฏ." + } + }, + "required": [ + "configId", + "amount" + ] + }, + "XBSettlementCreateFlowResponse": { + "$ref": "#/components/schemas/XBSettlementFlowPreviewModel" + }, + "XBSettlementFlowExecutionModel": { + "type": "object", + "properties": { + "flowId": { + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ู„ู„ุชุฏูู‚ ุนุจุฑ ุงู„ุญุฏูˆุฏ." + }, + "configId": { + "$ref": "#/components/schemas/XBSettlementConfigId" + }, + "inputAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "outputAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "totalFee": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "initiatedAt": { + "type": "number", + "description": "ุงู„ูˆู‚ุช ุงู„ุฐูŠ ุชู… ููŠู‡ ุชู†ููŠุฐ ุงู„ุชุฏูู‚ ุนุจุฑ ุงู„ุญุฏูˆุฏ ุจุชู†ุณูŠู‚ ุงู„ุนุตุฑ." + }, + "initiatedBy": { + "description": "ู…ุนุฑู ุงู„ู…ุณุชุฎุฏู… ุงู„ุฐูŠ ู‚ุงู… ุจุชุดุบูŠู„ ุงู„ุชุฏูู‚", + "type": "string" + }, + "state": { + "$ref": "#/components/schemas/XBSettlementFlowExecutionStatus" + }, + "steps": { + "$ref": "#/components/schemas/XBSettlementFlowStepsExecutionRecord" + }, + "selectedConversionSlippage": { + "type": "object", + "description": "ูŠุดูŠุฑ ุฅู„ู‰ ุงู„ุงู†ุฒู„ุงู‚ ุงู„ู…ุญุฏุฏ ุงู„ู…ุณุชุฎุฏู… ุฃุซู†ุงุก ุงู„ุชุฏูู‚ ู†ุธุฑู‹ุง ู„ุฃู† ู…ู†ุทู‚ ุงู„ุชุฌุงูˆุฒ ุฑุจู…ุง ุญุฏุซ.", + "properties": { + "basisPoints": { + "type": "number" + }, + "reason": { + "$ref": "#/components/schemas/XBSettlementFlowSelectedConversionSlippageReason" + } + }, + "required": [ + "basisPoints", + "reason" + ] + } + }, + "required": [ + "flowId", + "configId", + "steps", + "inputAmount", + "outputAmount", + "totalFee", + "initiatedAt", + "initiatedBy", + "state", + "selectedConversionSlippage" + ] + }, + "XBSettlementFlowSelectedConversionSlippageReason": { + "oneOf": [ + { + "const": "DEFAULT" + }, + { + "const": "CONFIG" + }, + { + "const": "FLOW" + } + ] + }, + "XBSettlementFlowStepsExecutionRecord": { + "type": "object", + "properties": { + "stepType": { + "$ref": "#/components/schemas/XBSettlementStepType" + } + }, + "additionalProperties": { + "$ref": "#/components/schemas/XBSettlementFlowExecutionStep" + } + }, + "XBSettlementConfigStepsRecord": { + "type": "object", + "properties": { + "stepType": { + "$ref": "#/components/schemas/XBSettlementStepType" + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "accountId": { + "type": "string" + }, + "inputAssetId": { + "$ref": "#/components/schemas/XBSettlementAssetID" + }, + "outputAssetId": { + "$ref": "#/components/schemas/XBSettlementAssetID" + } + }, + "required": [ + "accountId" + ] + } + }, + "XBSettlementConversionSlippageBasisPoints": { + "type": "integer", + "minimum": 0, + "maximum": 10000, + "default": 10000, + "description": "ุชูƒูˆูŠู† ุงู„ุงู†ุฒู„ุงู‚ ุจุงู„ู†ู‚ุงุท ุงู„ุฃุณุงุณูŠุฉุŒ ุงู„ู‚ูŠู…ุฉ ุงู„ุงูุชุฑุงุถูŠุฉ ู‡ูŠ 10%" + }, + "XBSettlementFlowStepsRecord": { + "type": "object", + "properties": { + "stepType": { + "$ref": "#/components/schemas/XBSettlementStepType" + } + }, + "additionalProperties": { + "$ref": "#/components/schemas/XBSettlementFlowSetupStep" + } + }, + "XBSettlementAsset": { + "type": "object", + "properties": { + "amount": { + "type": "string" + }, + "assetId": { + "$ref": "#/components/schemas/XBSettlementAssetID" + } + }, + "required": [ + "amount" + ] + }, + "XBSettlementAssetID": { + "oneOf": [ + { + "$ref": "#/components/schemas/XBSettlementFiatAsset" + }, + { + "$ref": "#/components/schemas/XBSettlementCryptoAsset" + } + ] + }, + "XBSettlementFiatAsset": { + "oneOf": [ + { + "const": "USD" + }, + { + "const": "MXN" + }, + { + "const": "COP" + }, + { + "const": "EUR" + }, + { + "const": "GBP" + } + ] + }, + "XBSettlementCryptoAsset": { + "oneOf": [ + { + "const": "XLM_USDC_5F3T" + }, + { + "const": "XLM" + } + ], + "description": "- XLM_USDC_5F3T: USDC ุนุจุฑ ุดุจูƒุฉ Stellar" + }, + "CreatePayoutRequest": { + "type": "object", + "properties": { + "paymentAccount": { + "$ref": "#/components/schemas/PaymentAccount" + }, + "instructionSet": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PayoutInstruction" + } + } + }, + "required": [ + "paymentAccount", + "instructionSet" + ] + }, + "PaymentAccount": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/PaymentAccountType" + } + }, + "required": [ + "id", + "type" + ] + }, + "PayoutInstruction": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "payeeAccount": { + "$ref": "#/components/schemas/PayeeAccount" + }, + "amount": { + "$ref": "#/components/schemas/InstructionAmount" + } + }, + "required": [ + "amount", + "payeeAccount" + ] + }, + "PaymentAccountType": { + "oneOf": [ + { + "const": "VAULT_ACCOUNT" + }, + { + "const": "EXCHANGE_ACCOUNT" + }, + { + "const": "FIAT_ACCOUNT" + } + ] + }, + "PayeeAccount": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/PayeeAccountType" + } + }, + "required": [ + "id", + "type" + ] + }, + "InstructionAmount": { + "type": "object", + "properties": { + "amount": { + "type": "string" + }, + "assetId": { + "type": "string" + } + }, + "required": [ + "amount", + "assetId" + ] + }, + "PayeeAccountType": { + "oneOf": [ + { + "const": "VAULT_ACCOUNT" + }, + { + "const": "EXCHANGE_ACCOUNT" + }, + { + "const": "INTERNAL_WALLET" + }, + { + "const": "EXTERNAL_WALLET" + }, + { + "const": "NETWORK_CONNECTION" + }, + { + "const": "FIAT_ACCOUNT" + } + ], + "description": "- VAULT_ACCOUNT ุญุณุงุจ ู…ุฎุฒู† Fireblocks ุงู„ุฃุตู„ูŠ - EXCHANGE_ACCOUNT ุญุณุงุจ ุชุจุงุฏู„ ุชุงุจุน ู„ุฌู‡ุฉ ุฎุงุฑุฌูŠุฉ - INTERNAL_WALLET ุนู†ูˆุงู† ู…ุฏุฑุฌ ููŠ ุงู„ู‚ุงุฆู…ุฉ ุงู„ุจูŠุถุงุก ูˆู…ูู…ูŠุฒ ุจุฃู†ู‡ ุฏุงุฎู„ูŠ ู„ู…ุณุงุญุฉ ุงู„ุนู…ู„/ุงู„ู…ุคุณุณุฉ - EXTERNAL_WALLET ุนู†ูˆุงู† ู…ุฏุฑุฌ ููŠ ุงู„ู‚ุงุฆู…ุฉ ุงู„ุจูŠุถุงุก ูˆู…ูู…ูŠุฒ ุจุฃู†ู‡ ุฎุงุฑุฌูŠ - NETWORK_CONNECTION ุนุถูˆ ููŠ ุดุจูƒุฉ Fireblocks - FIAT_ACCOUNT ุญุณุงุจ ุชุงุจุน ู„ุฌู‡ุฉ ุฎุงุฑุฌูŠุฉ ู„ุจู†ูƒ ููŠุงุช (ุงู„ุชูˆู‚ูŠุนุŒ BCBุŒ ุฅู„ุฎ)" + }, + "PayoutResponse": { + "type": "object", + "properties": { + "payoutId": { + "type": "string" + }, + "paymentAccount": { + "$ref": "#/components/schemas/PaymentAccountResponse" + }, + "createdAt": { + "type": "number" + }, + "state": { + "$ref": "#/components/schemas/PayoutState" + }, + "status": { + "$ref": "#/components/schemas/PayoutStatus" + }, + "reasonOfFailure": { + "type": "string", + "description": "
  • ุชูˆุงุฒู† ุบูŠุฑ ูƒุงู
  • ุงู„ู…ุตุฏุฑ_ุงู„ุชุฑุฌู…ุฉ
  • ุงู„ู…ุตุฏุฑ_ู„ูŠุณ_ูุฑูŠุฏุง
  • ุงู„ู…ุตุฏุฑ_ู„ู…_ูŠูˆุฌุฏ
  • ู†ูˆุน ุงู„ู…ุตุฏุฑ ุบูŠุฑ ู…ุฏุนูˆู…
  • ุงู„ู…ุตุฏุฑ ูุงุฑุบ
  • ุงู„ูˆุฌู‡ุฉ_ุงู„ุชุฑุฌู…ุฉ
  • ุงู„ูˆุฌู‡ุฉ_ู„ูŠุณุช_ูุฑูŠุฏุฉ
  • ุงู„ูˆุฌู‡ุฉ_ู„ู…_ุชูˆุฌุฏ
  • ุงู„ูˆุฌู‡ุฉ ูุงุฑุบุฉ
  • ุงู„ุชุญู„ูŠู„
  • ู…ุฌู‡ูˆู„
  • ูƒุชู„ุฉ ุงู„ู†ุงุฑ_ุงู„ุนู…ูŠู„
  • ุฅุฑุณุงู„ ุงู„ู…ุนุงู…ู„ุฉ
" + }, + "initMethod": { + "$ref": "#/components/schemas/PayoutInitMethod" + }, + "instructionSet": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PayoutInstructionResponse" + } + }, + "reportUrl": { + "type": "string" + } + }, + "required": [ + "payoutId", + "createdAt", + "state", + "status", + "paymentAccount", + "instructionSet" + ] + }, + "PaymentAccountResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/PaymentAccountType" + } + } + }, + "PayoutState": { + "oneOf": [ + { + "const": "CREATED" + }, + { + "const": "FILE_FOUND" + }, + { + "const": "REQUESTED" + }, + { + "const": "TRANSLATED" + }, + { + "const": "PROCESSING" + }, + { + "const": "SUBMITTED" + }, + { + "const": "FINALIZED" + }, + { + "const": "INSUFFICIENT_BALANCE" + }, + { + "const": "FAILED" + } + ], + "description": "- CREATED - ุชู… ุฅู†ุดุงุก ู…ุฌู…ูˆุนุฉ ุชุนู„ูŠู…ุงุช ุงู„ุฏูุน ู…ุน ุฌู…ูŠุน ุชูุงุตูŠู„ู‡ุง - FILE_FOUND - ุชู… ุงู„ุนุซูˆุฑ ุนู„ู‰ ู…ู„ู ุฌุฏูŠุฏ ููŠ FTP - REQUESTED - ุชู… ุทู„ุจ ุงู„ุฏูุน ู…ุน ุฌู…ูŠุน ุชูุงุตูŠู„ู‡ - TRANSLATED - ุชู… ุชุญุฏูŠุฏ ู…ุนุฑูุงุช ุญุณุงุจ ุชุนู„ูŠู…ุงุช ุงู„ุฏูุน ูˆุชุฑุฌู…ุชู‡ุง - PROCESSING - ุชู… ุชู†ููŠุฐ ู…ุฌู…ูˆุนุฉ ุชุนู„ูŠู…ุงุช ุงู„ุฏูุน ูˆู…ุนุงู„ุฌุชู‡ุง - SUBMITTED - ุงู„ู…ุนุงู…ู„ุงุช ุงู„ู…ู‚ุฏู…ุฉ ู„ู„ุญุตูˆู„ ุนู„ู‰ ุชุนู„ูŠู…ุงุช ุงู„ุฏูุน - FINALIZED - ุงู†ุชู‡ุช ู…ุนุงู„ุฌุฉ ุงู„ุฏูุนุŒ ูˆุชู…ุช ู…ุนุงู„ุฌุฉ ุฌู…ูŠุน ุงู„ู…ุนุงู…ู„ุงุช ุจู†ุฌุงุญ - INSUFFICIENT_BALANCE - ุฑุตูŠุฏ ุบูŠุฑ ูƒุงูู ููŠ ุญุณุงุจ ุงู„ุฏูุน (ูŠู…ูƒู† ุฃู† ุชูƒูˆู† ุญุงู„ุฉ ู…ุคู‚ุชุฉ) - FAILED - ูุดู„ ูˆุงุญุฏ ุฃูˆ ุฃูƒุซุฑ ู…ู† ุชุนู„ูŠู…ุงุช ุงู„ุฏูุน" + }, + "PayoutStatus": { + "oneOf": [ + { + "const": "REGISTERED" + }, + { + "const": "VERIFYING" + }, + { + "const": "IN_PROGRESS" + }, + { + "const": "DONE" + }, + { + "const": "INSUFFICIENT_BALANCE" + }, + { + "const": "FAILED" + } + ], + "description": "- ุชู… ุทู„ุจ ุงู„ุฏูุนุฉ ุงู„ู…ุทู„ูˆุจุฉ ู…ุน ุฌู…ูŠุน ุชูุงุตูŠู„ู‡ุง - ุชู… ุงู„ุชุญู‚ู‚ ู…ู† ุชูุงุตูŠู„ ู…ุฌู…ูˆุนุฉ ุชุนู„ูŠู…ุงุช ุงู„ุฏูุน - ุชู… ุชู†ููŠุฐ ู…ุฌู…ูˆุนุฉ ุชุนู„ูŠู…ุงุช ุงู„ุฏูุน PROCESSING ูˆุฌุงุฑูŠ ู…ุนุงู„ุฌุชู‡ุง - ุชู… ุงู„ุงู†ุชู‡ุงุก ู…ู† ุงู„ุฏูุนุฉ (ุชู… ุฅูƒู…ุงู„ ุฌู…ูŠุน ุชุนู„ูŠู…ุงุช ุงู„ุฏูุน ุจู†ุฌุงุญ) - INSUFFICIENT_BALANCE ุฑุตูŠุฏ ุบูŠุฑ ูƒุงูู ููŠ ุญุณุงุจ ุงู„ุฏูุน (ูŠู…ูƒู† ุฃู† ุชูƒูˆู† ุญุงู„ุฉ ู…ุคู‚ุชุฉ) - ูุดู„ ูุดู„ ูˆุงุญุฏ ุฃูˆ ุฃูƒุซุฑ ู…ู† ุชุนู„ูŠู…ุงุช ุงู„ุฏูุน" + }, + "PayoutInitMethod": { + "oneOf": [ + { + "const": "FILE" + }, + { + "const": "API" + } + ] + }, + "PayoutInstructionResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "payeeAccount": { + "$ref": "#/components/schemas/PayeeAccountResponse" + }, + "amount": { + "$ref": "#/components/schemas/InstructionAmount" + }, + "state": { + "$ref": "#/components/schemas/PayoutInstructionState" + }, + "transactions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Transaction" + } + } + }, + "required": [ + "amount", + "payeeAccount", + "state", + "transactions" + ] + }, + "PayeeAccountResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/PayeeAccountType" + } + } + }, + "PayoutInstructionState": { + "oneOf": [ + { + "const": "NOT_STARTED" + }, + { + "const": "TRANSACTION_SENT" + }, + { + "const": "COMPLETED" + }, + { + "const": "FAILED" + }, + { + "const": "TRANSLATION_ERROR" + }, + { + "const": "SKIPPED" + } + ], + "description": "- NOT_STARTED - ููŠ ุงู†ุชุธุงุฑ ุงู„ุจุฏุก - TRANSACTION_SENT - ุชู… ุฅุฑุณุงู„ ู…ุนุงู…ู„ุฉ ุฃุณุงุณูŠุฉ - COMPLETED - ุชู… ุงู„ุงู†ุชู‡ุงุก ุจู†ุฌุงุญ - FAILED - ูุดู„ - TRANSLATION_ERROR - ูุดู„ ุงู„ุจุญุซ ุนู† ุงู„ูˆุฌู‡ุฉ (ุจุณุจุจ ุงู„ุชุบูŠูŠุฑุงุช ููŠ ุงู„ู…ุญูุธุฉ ุงู„ุฎุงุฑุฌูŠุฉ ุงู„ู…ุฏุฑุฌุฉ ููŠ ุงู„ู‚ุงุฆู…ุฉ ุงู„ุจูŠุถุงุก ุงู„ุฃุณุงุณูŠุฉ ุฃูˆ ู…ุง ุดุงุจู‡) - SKIPPED - ู„ู… ูŠุชู… ุฅู†ุดุงุก ุฃูŠ ู…ุนุงู…ู„ุฉ (ู…ุนุงู…ู„ุงุช) ู„ู‡ุฐู‡ ุงู„ุชุนู„ูŠู…ุงุช" + }, + "Transaction": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "state": { + "oneOf": [ + { + "const": "SUBMITTED" + }, + { + "const": "QUEUED" + }, + { + "const": "PENDING_AUTHORIZATION" + }, + { + "const": "PENDING_SIGNATURE" + }, + { + "const": "BROADCASTING" + }, + { + "const": "PENDING_3RD_PARTY_MANUAL_APPROVAL" + }, + { + "const": "PENDING_3RD_PARTY" + }, + { + "const": "PENDING" + }, + { + "const": "CONFIRMING" + }, + { + "const": "CONFIRMED" + }, + { + "const": "COMPLETED" + }, + { + "const": "PARTIALLY_COMPLETED" + }, + { + "const": "PENDING_AML_SCREENING" + }, + { + "const": "CANCELLING" + }, + { + "const": "CANCELLED" + }, + { + "const": "REJECTED" + }, + { + "const": "BLOCKED" + }, + { + "const": "FAILED" + }, + { + "const": "TIMEOUT" + } + ] + }, + "timestamp": { + "type": "number", + "format": "date-time" + }, + "instructionId": { + "type": "string" + } + }, + "required": [ + "id", + "state" + ] + }, + "DispatchPayoutResponse": { + "type": "object", + "properties": { + "payoutId": { + "type": "string" + } + }, + "required": [ + "payoutId" + ] + }, + "TravelRuleAddress": { + "type": "object", + "properties": { + "street": { + "type": "string", + "example": "1234 Example St", + "description": ".ุนู†ูˆุงู† ุงู„ุดุงุฑุน" + }, + "city": { + "type": "string", + "example": "New York", + "description": "ู…ุฏูŠู†ุฉ" + }, + "state": { + "type": "string", + "example": "NY", + "description": "ุงู„ุฏูˆู„ุฉ ุฃูˆ ุงู„ู…ู‚ุงุทุนุฉ" + }, + "postalCode": { + "type": "string", + "example": "10001", + "description": "ุงู„ุฑู…ุฒ ุงู„ุจุฑูŠุฏูŠ ุฃูˆ ุงู„ุฑู…ุฒ ุงู„ุจุฑูŠุฏูŠ" + } + }, + "required": [ + "street", + "city", + "state", + "postalCode" + ] + }, + "TravelRuleValidateTransactionRequest": { + "type": "object", + "properties": { + "transactionAsset": { + "type": "string", + "example": "BTC", + "description": "ุฑู…ุฒ ุฃุตู„ ุงู„ู…ุนุงู…ู„ุฉ BTCุŒETH)" + }, + "destination": { + "type": "string", + "example": "bc1qxy2kgdygjrsqtzq2n0yrf1234p83kkfjhx0wlh", + "description": "ุนู†ูˆุงู† ูˆุฌู‡ุฉ ุงู„ู…ุนุงู…ู„ุฉ" + }, + "transactionAmount": { + "type": "string", + "example": "10", + "description": "ู…ุจู„ุบ ุงู„ู…ุนุงู…ู„ุฉ ููŠ ุฃุตู„ ุงู„ู…ุนุงู…ู„ุฉ" + }, + "originatorVASPdid": { + "type": "string", + "example": "did:ethr:0x44957e75d6ce4a5bf37aae117da86422c848f7c2", + "description": "ู‡ุฐุง ู‡ูˆ ุงู„ู…ุนุฑู ุงู„ู…ุฎุตุต ู„ู€ VASP ุงู„ุฎุงุต ุจูƒ" + }, + "originatorEqualsBeneficiary": { + "type": "boolean", + "example": false, + "description": ""ุตุญูŠุญ" ุฅุฐุง ูƒุงู† ุงู„ู…ูู†ุดุฆ ูˆุงู„ู…ุณุชููŠุฏ ู‡ูˆ ู†ูุณ ุงู„ุดุฎุต ูˆุจุงู„ุชุงู„ูŠ ู„ุง ุชุญุชุงุฌ ุฅู„ู‰ ุฌู…ุน ุฃูŠ ู…ุนู„ูˆู…ุงุช. "ุฎุทุฃ" ุฅุฐุง ูƒุงู† ู†ู‚ู„ู‹ุง ู„ุทุฑู ุซุงู„ุซ." + }, + "travelRuleBehavior": { + "type": "boolean", + "example": true, + "description": "ุณูŠุคุฏูŠ ู‡ุฐุง ุฃูŠุถู‹ุง ุฅู„ู‰ ุงู„ุชุญู‚ู‚ ู…ู…ุง ุฅุฐุง ูƒุงู†ุช ุงู„ู…ุนุงู…ู„ุฉ ุนุจุงุฑุฉ ุนู† TRAVEL_RULE ููŠ ู†ุทุงู‚ ุงุฎุชุตุงุต ู…ุฒูˆุฏ ุฎุฏู…ุฉ VASP ุงู„ู…ุณุชููŠุฏ" + }, + "beneficiaryVASPdid": { + "type": "string", + "example": "did:ethr:0x46a7ed5813ce735387df2bfb245bd7722e0de992", + "description": "ู‡ุฐุง ู‡ูˆ ุงู„ู…ุนุฑู ุงู„ู…ุฎุตุต ู„ู€ VASP ุงู„ุฐูŠ ูŠุชู… ุฅุฑุณุงู„ ุงู„ุฃู…ูˆุงู„ ุฅู„ูŠู‡" + }, + "beneficiaryVASPname": { + "type": "string", + "example": "HelloCrypto", + "description": "ุงุณู… ุงู„ู…ุณุชููŠุฏ ู…ู† VASP" + }, + "beneficiaryName": { + "type": "string", + "example": "John Doe", + "description": "ุงุณู… ุงู„ู…ุณุชููŠุฏ" + }, + "beneficiaryAccountNumber": { + "type": "string", + "example": "1234-1234-1234-12234", + "description": "ุงุณู… ุงู„ู…ุณุชููŠุฏ" + }, + "beneficiaryAddress": { + "example": "{\"addressLine: [Wayne Manor, Gotham City, New York, USA]\"}", + "description": "ุงุณู… ุงู„ู…ุณุชููŠุฏ", + "type": "object", + "properties": { + "street": { + "type": "string", + "example": "1234 Example St", + "description": ".ุนู†ูˆุงู† ุงู„ุดุงุฑุน" + }, + "city": { + "type": "string", + "example": "New York", + "description": "ู…ุฏูŠู†ุฉ" + }, + "state": { + "type": "string", + "example": "NY", + "description": "ุงู„ุฏูˆู„ุฉ ุฃูˆ ุงู„ู…ู‚ุงุทุนุฉ" + }, + "postalCode": { + "type": "string", + "example": "10001", + "description": "ุงู„ุฑู…ุฒ ุงู„ุจุฑูŠุฏูŠ ุฃูˆ ุงู„ุฑู…ุฒ ุงู„ุจุฑูŠุฏูŠ" + } + } + } + }, + "required": [ + "transactionAsset", + "destination", + "transactionAmount", + "originatorVASPdid", + "originatorEqualsBeneficiary", + "travelRuleBehavior", + "beneficiaryVASPdid", + "beneficiaryVASPname", + "beneficiaryName", + "beneficiaryAccountNumber", + "beneficiaryAddress" + ] + }, + "TravelRuleValidateTransactionResponse": { + "type": "object", + "properties": { + "isValid": { + "type": "boolean", + "description": "ุณูŠุฎุจุฑูƒ "isValid" ู…ุง ุฅุฐุง ูƒู†ุช ู‚ุฏ ุฌู…ุนุช ูƒู„ ุงู„ู…ุนู„ูˆู…ุงุช ุงู„ู…ุทู„ูˆุจุฉ ู„ู†ู‚ู„ ุจูŠุงู†ุงุช ู‚ุงุนุฏุฉ ุงู„ุณูุฑ. ุจู…ุฌุฑุฏ ุฃู† ูŠุตุจุญ ู‡ุฐุง ุงู„ุญู‚ู„ "true"ุŒ ูŠู…ูƒู†ูƒ ุงู„ุงู†ุชู‚ุงู„ ุฅู„ู‰ ุงู„ุฎุทูˆุฉ ุงู„ุชุงู„ูŠุฉ ูˆู‡ูŠ ู†ู‚ู„ ู…ุนู„ูˆู…ุงุช ุงู„ูˆุงุฌู‡ุฉ ุงู„ุฃู…ุงู…ูŠุฉ ุฅู„ู‰ ุงู„ูˆุงุฌู‡ุฉ ุงู„ุฎู„ููŠุฉ ูˆุฅุฌุฑุงุก ุฅู†ุดุงุก ู…ุนุงู…ู„ุฉ ู‚ุงุนุฏุฉ ุงู„ุณูุฑ", + "example": true + }, + "type": { + "type": "string", + "description": "ุณูŠุฎุจุฑูƒ "ุงู„ู†ูˆุน" ู…ุง ุฅุฐุง ูƒุงู†ุช ู‚ูŠู…ุฉ ุงู„ุฃุตูˆู„ ุงู„ุงูุชุฑุงุถูŠุฉ ุงู„ู…ุญูˆู„ุฉ ุฅู„ู‰ ู‚ูŠู…ุฉ FIAT ู„ุทู„ุจ ุงู„ุณุญุจ ุฃุนู„ู‰ (=TRAVELRULE) ุฃูˆ ุฃู‚ู„ (=BELOW_THRESHOLD) ู…ู† ุงู„ุญุฏ ุงู„ุฃุฏู†ู‰ ููŠ ูˆู„ุงูŠุชูƒ ุงู„ู‚ุถุงุฆูŠุฉ. ุฅุฐุง ูƒุงู†ุช ุฅู„ู‰ ู…ุญูุธุฉ ุบูŠุฑ ู…ุณุชุถุงูุฉ ู„ุง ุชุชุทู„ุจ ุฅุฑุณุงู„ ู…ุนู„ูˆู…ุงุช ู‚ูˆุงุนุฏ ุงู„ุณูุฑ ูˆุฌู…ุนู‡ุง ูู‚ุทุŒ ูุณุชู‚ูˆู„ NON_CUSTODIAL.", + "example": "TRAVELRULE" + }, + "beneficiaryAddressType": { + "type": "string", + "description": "ุณูŠุฎุจุฑูƒ "beneficiaryAddressType" ู…ุง ุฅุฐุง ูƒุงู† ู…ุฒูˆุฏ ุชุญู„ูŠู„ุงุช blockchain ุฃูˆ ุฏูุชุฑ ุงู„ุนู†ุงูˆูŠู† ุงู„ุฏุงุฎู„ูŠ ุงู„ุฎุงุต ุจูƒ ู‚ุงุฏุฑู‹ุง ุนู„ู‰ ุชุญุฏูŠุฏ ุนู†ูˆุงู† ุงู„ู…ุญูุธุฉ.", + "example": "UNKNOWN" + }, + "addressSource": { + "type": "string", + "description": "ุณูŠุฎุจุฑูƒ "addressSource" ุฅุฐุง ุชู… ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุนู†ูˆุงู† ููŠ ุฏูุชุฑ ุงู„ุนู†ุงูˆูŠู† ุงู„ุฏุงุฎู„ูŠ ุงู„ุฎุงุต ุจูƒ ุฃูˆ ุชู… ุชุญุฏูŠุฏู‡ ุจูˆุงุณุทุฉ ู…ุฒูˆุฏ ุชุญู„ูŠู„ุงุช blockchain.", + "example": "UNKNOWN" + }, + "beneficiaryVASPdid": { + "type": "string", + "description": "ุฑู‚ู… DID ุงู„ุฎุงุต ุจู€ VASP ู„ู„ู…ุณุชููŠุฏ VASP", + "example": "did:ethr:0x46a7ed5813ce735387df2bfb245bd7722e0de992" + }, + "beneficiaryVASPname": { + "type": "string", + "description": "ุณูŠุฎุจุฑูƒ "beneficiaryVASPname" ุจุงุณู… VASP ุงู„ุฐูŠ ุชู… ุชุญุฏูŠุฏู‡ ุจุงุนุชุจุงุฑู‡ ู…ุงู„ูƒ ุนู†ูˆุงู† ุงู„ู…ุญูุธุฉ. ูŠุชู… ุงุณุชุฎุฏุงู… ู‡ุฐุง ุงู„ุงุณู… ููŠ ู…ูƒุงู„ู…ุฉ ู„ุงุญู‚ุฉ ู„ู„ุญุตูˆู„ ุนู„ู‰ DID ุงู„ุฎุงุต ุจู‡.", + "example": "Fireblocks" + }, + "warnings": { + "description": ""ุงู„ุฃุฎุทุงุก/ุงู„ุชุญุฐูŠุฑุงุช" ุณุชุฎุจุฑูƒ ุจุงู„ู…ุนู„ูˆู…ุงุช ุงู„ุชูŠ ุชุญุชุงุฌ ุฅู„ู‰ ุฌู…ุนู‡ุง ู…ู† ุงู„ู…ุฑุณู„ ุญูˆู„ ุงู„ู…ุณุชููŠุฏ.", + "example": [ + "optional-beneficiaryAccountNumber" + ], + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "isValid", + "type", + "beneficiaryAddressType", + "addressSource", + "beneficiaryVASPdid", + "beneficiaryVASPname", + "warnings" + ] + }, + "TravelRuleTransactionBlockchainInfo": { + "type": "object", + "properties": { + "txHash": { + "type": "string" + }, + "origin": { + "type": "string" + }, + "destination": { + "type": "string" + } + }, + "required": [ + "txHash", + "origin", + "destination" + ] + }, + "TravelRulePiiIVMS": { + "type": "object", + "properties": { + "fullName": { + "type": "string" + }, + "dateOfBirth": { + "type": "string" + }, + "placeOfBirth": { + "type": "string" + }, + "address": { + "type": "string" + }, + "identificationNumber": { + "type": "string" + }, + "nationality": { + "type": "string" + }, + "countryOfResidence": { + "type": "string" + }, + "taxIdentificationNumber": { + "type": "string" + }, + "customerNumber": { + "type": "string" + } + }, + "required": [ + "fullName", + "dateOfBirth", + "placeOfBirth", + "address", + "identificationNumber", + "nationality", + "countryOfResidence", + "taxIdentificationNumber", + "customerNumber" + ] + }, + "TravelRuleOwnershipProof": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "passport", + "description": "ู†ูˆุน ุฅุซุจุงุช ุงู„ู…ู„ูƒูŠุฉ" + }, + "id": { + "type": "string", + "example": "123456789", + "description": "ุฑู‚ู… ุงู„ู‡ูˆูŠุฉ" + }, + "name": { + "type": "string", + "example": "Alice", + "description": "ุงุณู… ุงู„ู…ุงู„ูƒ" + }, + "country": { + "type": "string", + "example": "US", + "description": "ุจู„ุฏ ุงู„ุฅุตุฏุงุฑ" + }, + "issueDate": { + "type": "string", + "example": "2022-01-01", + "description": "ุชุงุฑูŠุฎ ุงู„ุฅุตุฏุงุฑ" + }, + "issuer": { + "type": "string", + "example": "US Government", + "description": "ุงุณู… ุงู„ุฌู‡ุฉ ุงู„ู…ุตุฏุฑุฉ" + } + }, + "required": [ + "type", + "id", + "name", + "country", + "issueDate", + "issuer" + ] + }, + "TravelRuleValidateFullTransactionRequest": { + "type": "object", + "properties": { + "transactionAsset": { + "type": "string", + "description": "ุงู„ุฃุตูˆู„ ุงู„ู…ุดุงุฑูƒุฉ ููŠ ุงู„ู…ุนุงู…ู„ุฉ" + }, + "transactionAmount": { + "type": "string", + "description": "ู…ุจู„ุบ ุงู„ุตูู‚ุฉ" + }, + "originatorDid": { + "type": "string", + "description": "ุฑู‚ู… DID ู„ู…ู†ุดุฆ ุงู„ู…ุนุงู…ู„ุฉ" + }, + "beneficiaryDid": { + "type": "string", + "description": "ุฑู‚ู… DID ู„ู„ู…ุณุชููŠุฏ ู…ู† ุงู„ู…ุนุงู…ู„ุฉ" + }, + "originatorVASPdid": { + "type": "string", + "description": "ู…ุนุฑู VASP ู„ู…ู†ุดุฆ ุงู„ู…ุนุงู…ู„ุฉ" + }, + "beneficiaryVASPdid": { + "type": "string", + "description": "ู…ุนุฑู VASP ู„ู„ู…ุณุชููŠุฏ ู…ู† ุงู„ู…ุนุงู…ู„ุฉ" + }, + "beneficiaryVASPname": { + "type": "string", + "description": "ุงุณู… ู…ุฒูˆุฏ ุฎุฏู…ุฉ ุงู„ุฃุตูˆู„ ุงู„ุงูุชุฑุงุถูŠุฉ ุงู„ุฐูŠ ูŠุนู…ู„ ูƒู…ุณุชููŠุฏ" + }, + "transactionBlockchainInfo": { + "description": "ู…ุนู„ูˆู…ุงุช ุญูˆู„ ู…ุนุงู…ู„ุงุช ุงู„ุจู„ูˆูƒุดูŠู†", + "type": "object", + "properties": { + "txHash": { + "type": "string" + }, + "origin": { + "type": "string" + }, + "destination": { + "type": "string" + } + } + }, + "originator": { + "description": "ู…ุนู„ูˆู…ุงุช ุญูˆู„ ุตุงุญุจ ุงู„ู…ุนุงู…ู„ุฉ", + "type": "object", + "properties": { + "fullName": { + "type": "string" + }, + "dateOfBirth": { + "type": "string" + }, + "placeOfBirth": { + "type": "string" + }, + "address": { + "type": "string" + }, + "identificationNumber": { + "type": "string" + }, + "nationality": { + "type": "string" + }, + "countryOfResidence": { + "type": "string" + }, + "taxIdentificationNumber": { + "type": "string" + }, + "customerNumber": { + "type": "string" + } + } + }, + "beneficiary": { + "description": "ู…ุนู„ูˆู…ุงุช ุนู† ุงู„ู…ุณุชููŠุฏ ู…ู† ุงู„ู…ุนุงู…ู„ุฉ", + "type": "object", + "properties": { + "fullName": { + "type": "string" + }, + "dateOfBirth": { + "type": "string" + }, + "placeOfBirth": { + "type": "string" + }, + "address": { + "type": "string" + }, + "identificationNumber": { + "type": "string" + }, + "nationality": { + "type": "string" + }, + "countryOfResidence": { + "type": "string" + }, + "taxIdentificationNumber": { + "type": "string" + }, + "customerNumber": { + "type": "string" + } + } + }, + "encrypted": { + "type": "string", + "description": "ุงู„ุจูŠุงู†ุงุช ุงู„ู…ุดูุฑุฉ ุงู„ู…ุชุนู„ู‚ุฉ ุจุงู„ู…ุนุงู…ู„ุฉ" + }, + "protocol": { + "type": "string", + "description": "ุงู„ุจุฑูˆุชูˆูƒูˆู„ ุงู„ู…ุณุชุฎุฏู… ู„ุชู†ููŠุฐ ู‚ุงุนุฏุฉ ุงู„ุณูุฑ" + }, + "notificationEmail": { + "type": "string", + "description": "ุนู†ูˆุงู† ุงู„ุจุฑูŠุฏ ุงู„ุฅู„ูƒุชุฑูˆู†ูŠ ุงู„ุฐูŠ ูŠุฌุจ ุฅุฑุณุงู„ ุงู„ุฅุดุนุงุฑ ุฅู„ูŠู‡ ุนู†ุฏ ุงู„ุงู†ุชู‡ุงุก ู…ู† ู‚ุงุนุฏุฉ ุงู„ุณูุฑ" + }, + "skipBeneficiaryDataValidation": { + "type": "boolean", + "description": "ู‡ู„ ูŠุฌุจ ุชุฎุทูŠ ุงู„ุชุญู‚ู‚ ู…ู† ุตุญุฉ ุจูŠุงู†ุงุช ุงู„ู…ุณุชููŠุฏุŸ" + }, + "travelRuleBehavior": { + "type": "boolean", + "description": "ู…ุง ุฅุฐุง ูƒุงู† ูŠุฌุจ ุงู„ุชุญู‚ู‚ ู…ู…ุง ุฅุฐุง ูƒุงู†ุช ุงู„ู…ุนุงู…ู„ุฉ ู‡ูŠ TRAVEL_RULE ููŠ ู†ุทุงู‚ ุงุฎุชุตุงุต ู…ุฒูˆุฏ ุฎุฏู…ุฉ VASP ุงู„ู…ุณุชููŠุฏ" + }, + "originatorProof": { + "description": "ุฅุซุจุงุช ุงู„ู…ู„ูƒูŠุฉ ุงู„ู…ุชุนู„ู‚ ุจุตุงุญุจ ุงู„ู…ุนุงู…ู„ุฉ", + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "passport", + "description": "ู†ูˆุน ุฅุซุจุงุช ุงู„ู…ู„ูƒูŠุฉ" + }, + "id": { + "type": "string", + "example": "123456789", + "description": "ุฑู‚ู… ุงู„ู‡ูˆูŠุฉ" + }, + "name": { + "type": "string", + "example": "Alice", + "description": "ุงุณู… ุงู„ู…ุงู„ูƒ" + }, + "country": { + "type": "string", + "example": "US", + "description": "ุจู„ุฏ ุงู„ุฅุตุฏุงุฑ" + }, + "issueDate": { + "type": "string", + "example": "2022-01-01", + "description": "ุชุงุฑูŠุฎ ุงู„ุฅุตุฏุงุฑ" + }, + "issuer": { + "type": "string", + "example": "US Government", + "description": "ุงุณู… ุงู„ุฌู‡ุฉ ุงู„ู…ุตุฏุฑุฉ" + } + } + }, + "beneficiaryProof": { + "description": "ุฅุซุจุงุช ุงู„ู…ู„ูƒูŠุฉ ุงู„ู…ุชุนู„ู‚ ุจุงู„ู…ุณุชููŠุฏ ู…ู† ุงู„ู…ุนุงู…ู„ุฉ", + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "passport", + "description": "ู†ูˆุน ุฅุซุจุงุช ุงู„ู…ู„ูƒูŠุฉ" + }, + "id": { + "type": "string", + "example": "123456789", + "description": "ุฑู‚ู… ุงู„ู‡ูˆูŠุฉ" + }, + "name": { + "type": "string", + "example": "Alice", + "description": "ุงุณู… ุงู„ู…ุงู„ูƒ" + }, + "country": { + "type": "string", + "example": "US", + "description": "ุจู„ุฏ ุงู„ุฅุตุฏุงุฑ" + }, + "issueDate": { + "type": "string", + "example": "2022-01-01", + "description": "ุชุงุฑูŠุฎ ุงู„ุฅุตุฏุงุฑ" + }, + "issuer": { + "type": "string", + "example": "US Government", + "description": "ุงุณู… ุงู„ุฌู‡ุฉ ุงู„ู…ุตุฏุฑุฉ" + } + } + }, + "pii": { + "description": "ุงู„ู…ุนู„ูˆู…ุงุช ุงู„ุดุฎุตูŠุฉ ุงู„ู‚ุงุจู„ุฉ ู„ู„ุชุนุฑูŠู ูˆุงู„ู…ุชุนู„ู‚ุฉ ุจุงู„ู…ุนุงู…ู„ุฉ", + "type": "object", + "properties": { + "fullName": { + "type": "string" + }, + "dateOfBirth": { + "type": "string" + }, + "placeOfBirth": { + "type": "string" + }, + "address": { + "type": "string" + }, + "identificationNumber": { + "type": "string" + }, + "nationality": { + "type": "string" + }, + "countryOfResidence": { + "type": "string" + }, + "taxIdentificationNumber": { + "type": "string" + }, + "customerNumber": { + "type": "string" + } + } + } + }, + "required": [ + "transactionAsset", + "transactionAmount", + "originatorDid", + "beneficiaryDid", + "originatorVASPdid", + "beneficiaryVASPdid", + "beneficiaryVASPname", + "transactionBlockchainInfo", + "originator", + "beneficiary", + "encrypted", + "protocol", + "notificationEmail", + "skipBeneficiaryDataValidation", + "travelRuleBehavior", + "originatorProof", + "beneficiaryProof", + "pii" + ] + }, + "TravelRuleIssuer": { + "type": "object", + "properties": { + "issuerDid": { + "type": "string" + } + }, + "required": [ + "issuerDid" + ] + }, + "TravelRuleIssuers": { + "type": "object", + "properties": { + "yearFounded": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "isRegulated": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "regulatoryAuthorities": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "name": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "logo": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "website": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "legalName": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "legalStructure": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "incorporationCountry": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "businessNumber": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "addressLine1": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "city": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "country": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "description": { + "$ref": "#/components/schemas/TravelRuleIssuer" + } + }, + "required": [ + "yearFounded", + "isRegulated", + "regulatoryAuthorities", + "name", + "logo", + "website", + "legalName", + "legalStructure", + "incorporationCountry", + "businessNumber", + "addressLine1", + "city", + "country", + "description" + ] + }, + "TravelRuleVASP": { + "type": "object", + "properties": { + "did": { + "type": "string" + }, + "name": { + "type": "string" + }, + "verificationStatus": { + "type": "string" + }, + "addressLine1": { + "type": "string" + }, + "addressLine2": { + "type": "string" + }, + "city": { + "type": "string" + }, + "country": { + "type": "string" + }, + "emailDomains": { + "type": "string" + }, + "website": { + "type": "string" + }, + "logo": { + "type": "string" + }, + "legalStructure": { + "type": "string" + }, + "legalName": { + "type": "string" + }, + "yearFounded": { + "type": "string" + }, + "incorporationCountry": { + "type": "string" + }, + "isRegulated": { + "type": "string" + }, + "otherNames": { + "type": "string" + }, + "identificationType": { + "type": "string" + }, + "identificationCountry": { + "type": "string" + }, + "businessNumber": { + "type": "string" + }, + "regulatoryAuthorities": { + "type": "string" + }, + "jurisdictions": { + "type": "string" + }, + "street": { + "type": "string" + }, + "number": { + "type": "string" + }, + "unit": { + "type": "string" + }, + "postCode": { + "type": "string" + }, + "state": { + "type": "string" + }, + "certificates": { + "type": "string" + }, + "description": { + "type": "string" + }, + "travelRule_OPENVASP": { + "type": "string" + }, + "travelRule_SYGNA": { + "type": "string" + }, + "travelRule_TRISA": { + "type": "string" + }, + "travelRule_TRLIGHT": { + "type": "string" + }, + "travelRule_EMAIL": { + "type": "string" + }, + "travelRule_TRP": { + "type": "string" + }, + "travelRule_SHYFT": { + "type": "string" + }, + "travelRule_USTRAVELRULEWG": { + "type": "string" + }, + "createdAt": { + "type": "string" + }, + "createdBy": { + "type": "string" + }, + "updatedAt": { + "type": "string" + }, + "updatedBy": { + "type": "string" + }, + "lastSentDate": { + "type": "string" + }, + "lastReceivedDate": { + "type": "string" + }, + "documents": { + "type": "string" + }, + "hasAdmin": { + "type": "boolean" + }, + "isNotifiable": { + "type": "boolean" + }, + "issuers": { + "$ref": "#/components/schemas/TravelRuleIssuers" + } + }, + "required": [ + "did", + "name", + "verificationStatus", + "addressLine1", + "addressLine2", + "city", + "country", + "emailDomains", + "website", + "logo", + "legalStructure", + "legalName", + "yearFounded", + "incorporationCountry", + "isRegulated", + "otherNames", + "identificationType", + "identificationCountry", + "businessNumber", + "regulatoryAuthorities", + "jurisdictions", + "street", + "number", + "unit", + "postCode", + "state", + "certificates", + "description", + "travelRule_OPENVASP", + "travelRule_SYGNA", + "travelRule_TRISA", + "travelRule_TRLIGHT", + "travelRule_EMAIL", + "travelRule_TRP", + "travelRule_SHYFT", + "travelRule_USTRAVELRULEWG", + "createdAt", + "createdBy", + "updatedAt", + "updatedBy", + "lastSentDate", + "lastReceivedDate", + "documents", + "hasAdmin", + "isNotifiable", + "issuers" + ] + }, + "TravelRuleGetAllVASPsResponse": { + "type": "object", + "properties": { + "vasps": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TravelRuleVASP" + } + } + }, + "required": [ + "vasps" + ] + }, + "TravelRuleUpdateVASPDetails": { + "type": "object", + "properties": { + "did": { + "type": "string", + "example": "did:ethr:0x44957e75d6ce4a5bf37aae117da86422c848f7c2", + "description": "ุงู„ู…ุนุฑู ุงู„ู„ุงู…ุฑูƒุฒูŠ ู„ู€VASP" + }, + "pii_didkey": { + "type": "string", + "example": "did:key:z6Mks5CZRaiooKYhq5TwtXQC1gWhwiZnmiKfFrMnYY62MhYf", + "description": "ู…ูุชุงุญ PII DID ุงู„ุฎุงุต ุจู€ VASP" + } + }, + "required": [ + "did", + "pii_didkey" + ] + }, + "PolicySrcOrDestType": { + "oneOf": [ + { + "const": "EXCHANGE" + }, + { + "const": "UNMANAGED" + }, + { + "const": "VAULT" + }, + { + "const": "NETWORK_CONNECTION" + }, + { + "const": "COMPOUND" + }, + { + "const": "FIAT_ACCOUNT" + }, + { + "const": "ONE_TIME_ADDRESS" + }, + { + "const": "*" + } + ], + "description": "* EXCHANGE - ุญุณุงุจ ุชุจุงุฏู„ ุชุงุจุน ู„ุฌู‡ุฉ ุฎุงุฑุฌูŠุฉ ู…ุชุตู„ ุจู…ุณุงุญุฉ ุนู…ู„ูƒ * UNMANAGED - ู…ุญูุธุฉ ุบูŠุฑ ู…ูุฏุงุฑุฉ ุฎุงุฑุฌ ู…ุณุงุญุฉ ุนู…ู„ Fireblocks * VAULT - ุญุณุงุจ ููŠ Fireblocks Vault * NETWORK_CONNECTION - ุงุชุตุงู„ ููŠ ุดุจูƒุฉ Fireblocks * COMPOUND - (ุบูŠุฑ ู…ุณุชุฎุฏู…) ุฃุตู„ ุชู… ุงุณุชุฑุฏุงุฏู‡ ุจุงุณุชุฎุฏุงู… ุจุฑูˆุชูˆูƒูˆู„ Compound DeFI * FIAT_ACCOUNT - ุญุณุงุจ fiat ุชุงุจุน ู„ุฌู‡ุฉ ุฎุงุฑุฌูŠุฉ ู…ุชุตู„ ุจู…ุณุงุญุฉ ุนู…ู„ูƒ * ONE_TIME_ADDRESS - ุฃุตู„ ุบูŠุฑ ู…ุฏุฑุฌ ููŠ ุงู„ู‚ุงุฆู…ุฉ ุงู„ุจูŠุถุงุก ู…ู† ู…ุณุงุญุฉ ุนู…ู„ Fireblocks * "*" - ุฌู…ูŠุน ุงู„ุฃู†ูˆุงุน" + }, + "PolicySrcOrDestSubType": { + "oneOf": [ + { + "const": "EXTERNAL" + }, + { + "const": "INTERNAL" + }, + { + "const": "CONTRACT" + }, + { + "const": "EXCHANGETEST" + }, + { + "const": "*" + } + ], + "description": "* ุฎุงุฑุฌูŠ - ุงู„ู…ุญูุธุฉ ุงู„ู…ุฏุฑุฌุฉ ููŠ ุงู„ู‚ุงุฆู…ุฉ ุงู„ุจูŠุถุงุก ูˆุงู„ู…ุฎุตุตุฉ ูƒู…ุญูุธุฉ ุฎุงุฑุฌูŠุฉ ุชูุณุชุฎุฏู… ุนุงุฏุฉู‹ ู„ู„ุนู†ุงูˆูŠู† ุงู„ุชูŠ ูŠุฏูŠุฑู‡ุง ุนู…ู„ุงุคูƒ ูˆุงู„ุฃุทุฑุงู ุงู„ู…ู‚ุงุจู„ุฉ ู„ูƒ * ุฏุงุฎู„ูŠ - ุงู„ู…ุญูุธุฉ ุงู„ู…ุฏุฑุฌุฉ ููŠ ุงู„ู‚ุงุฆู…ุฉ ุงู„ุจูŠุถุงุก ูˆุงู„ู…ุฎุตุตุฉ ูƒู…ุญูุธุฉ ุฏุงุฎู„ูŠุฉ ุชูุณุชุฎุฏู… ุนุงุฏุฉู‹ ู„ู„ุนู†ุงูˆูŠู† ุงู„ุชูŠ ุชุชุญูƒู… ููŠู‡ุง ุฎุงุฑุฌ ู…ุณุงุญุฉ ุนู…ู„ Fireblocks ุงู„ุฎุงุตุฉ ุจูƒ * ุงู„ุนู‚ุฏ - ุงู„ู…ุญูุธุฉ ุงู„ู…ุฏุฑุฌุฉ ููŠ ุงู„ู‚ุงุฆู…ุฉ ุงู„ุจูŠุถุงุก ูˆุงู„ู…ุฎุตุตุฉ ูƒุนู‚ุฏ ุชูุณุชุฎุฏู… ู„ุชุญุฏูŠุฏ ูˆุฅุฏุงุฑุฉ ุงู„ุนู‚ูˆุฏ ุงู„ุฐูƒูŠุฉ ุงู„ุฎุงุฑุฌูŠุฉ * EXCHANGETEST - ุงู„ุจูˆุฑุตุงุช ุงู„ุชูŠ ุชุนู…ู„ ูู‚ุท ุนู„ู‰ ุฃุตูˆู„ ุงู„ุดุจูƒุฉ ุงู„ุชุฌุฑูŠุจูŠุฉ * "*" - ุฌู…ูŠุน ุงู„ุฃู†ูˆุงุน ุงู„ูุฑุนูŠุฉ" + }, + "PolicySrcOrDestId": { + "type": "string", + "description": "ูŠุญุฏุฏ ู…ุนุฑู ุงู„ุญุณุงุจุŒ ุงู„ุฎูŠุงุฑุงุช ู‡ูŠ * "*" - ุฌู…ูŠุน ุงู„ุญุณุงุจุงุช * ู…ุนุฑู ุญุณุงุจ ู…ุญุฏุฏ" + }, + "AmountAggregationTimePeriodMethod": { + "oneOf": [ + { + "const": "PER_SINGLE_MATCH" + }, + { + "const": "ACROSS_ALL_MATCHES" + } + ], + "description": "* PER_SINGLE_MATCH - ุชุทุจูŠู‚ ุงู„ุญุฏ ุนู„ู‰ ูƒู„ ูƒูŠุงู† ู…ุฏุฑุฌ * ACROSS_ALL_MATCHES - ุชุทุจูŠู‚ ุงู„ุญุฏ ุนู„ู‰ ู…ุฌู…ูˆุน ูƒู„ ุงู„ูƒูŠุงู†ุงุช ุงู„ู…ุฏุฑุฌุฉ" + }, + "PolicyRule": { + "type": "object", + "description": "ู‚ุงุนุฏุฉ ุงู„ุณูŠุงุณุฉ ุงู„ุชูŠ ูŠุชู… ุชุทุจูŠู‚ู‡ุง ุนู„ู‰ ุงู„ู…ุนุงู…ู„ุงุช", + "properties": { + "operator": { + "type": "string", + "description": "(ุชู… ุฅูŠู‚ุงูู‡ - ุชู… ุงุณุชุจุฏุงู„ู‡ ุจู€ "operators") | ูŠุญุฏุฏ ุงู„ู…ุณุชุฎุฏู…ูŠู† ุงู„ุฐูŠู† ูŠู…ูƒู†ู‡ู… ุจุฏุก ู†ูˆุน ุงู„ู…ุนุงู…ู„ุฉ ุงู„ุชูŠ ุชู†ุทุจู‚ ุนู„ูŠู‡ุง ุงู„ู‚ุงุนุฏุฉ. ุงู„ุฎูŠุงุฑุงุช ู‡ูŠ * "*" - ูŠูุณู…ุญ ู„ุฌู…ูŠุน ุงู„ู…ุณุชุฎุฏู…ูŠู† * ู…ุนุฑู ู…ุณุชุฎุฏู… ู…ุญุฏุฏ", + "deprecated": true + }, + "operators": { + "type": "object", + "description": "ูŠุญุฏุฏ ุงู„ู…ุณุชุฎุฏู…ูŠู†/ุงู„ู…ุฌู…ูˆุนุงุช ุงู„ุฐูŠู† ูŠู…ูƒู†ู‡ู… ุจุฏุก ู†ูˆุน ุงู„ู…ุนุงู…ู„ุฉ ุงู„ุชูŠ ุชู†ุทุจู‚ ุนู„ูŠู‡ุง ุงู„ู‚ุงุนุฏุฉ.", + "properties": { + "wildcard": { + "const": "*", + "description": "ุฅุฐุง ุชู… ุงุณุชุฎุฏุงู…ู‡ุงุŒ ููŠุฌุจ ุฃู† ุชุธู‡ุฑ ู‡ุฐู‡ ุงู„ุฎุงุตูŠุฉ ุจุงุนุชุจุงุฑู‡ุง ุงู„ุฎุงุตูŠุฉ ุงู„ูุฑุนูŠุฉ ุงู„ูˆุญูŠุฏุฉ * "*" - ูŠูุณู…ุญ ู„ุฌู…ูŠุน ุงู„ู…ุณุชุฎุฏู…ูŠู†" + }, + "users": { + "type": "array", + "description": "ู…ุฌู…ูˆุนุฉ ู…ุนุฑูุงุช ุงู„ู…ุณุชุฎุฏู…ูŠู†", + "items": { + "type": "string" + } + }, + "usersGroups": { + "type": "array", + "description": "ู…ุฌู…ูˆุนุฉ ู…ู† ู…ุนุฑูุงุช ุงู„ู…ุฌู…ูˆุนุฉ", + "items": { + "type": "string" + } + }, + "services": { + "type": "array", + "description": "ู…ุฌู…ูˆุนุฉ ู…ู† ุงู„ุฎุฏู…ุงุช ู„ุจุฏุก ุงู„ู…ุนุงู…ู„ุงุช", + "items": { + "type": "string" + } + } + } + }, + "transactionType": { + "oneOf": [ + { + "const": "TRANSFER" + }, + { + "const": "CONTRACT_CALL" + }, + { + "const": "APPROVE" + }, + { + "const": "MINT" + }, + { + "const": "BURN" + }, + { + "const": "SUPPLY" + }, + { + "const": "REDEEM" + }, + { + "const": "STAKE" + }, + { + "const": "RAW" + }, + { + "const": "TYPED_MESSAGE" + } + ], + "description": "ูŠุญุฏุฏ ู†ูˆุน ุงู„ู…ุนุงู…ู„ุฉ ุงู„ุชูŠ ุชู†ุทุจู‚ ุนู„ูŠู‡ุง ุงู„ู‚ุงุนุฏุฉ. * TRANSFER - ุงูุชุฑุงุถูŠ. ูŠู†ู‚ู„ ุงู„ุฃู…ูˆุงู„ ู…ู† ุญุณุงุจ ุฅู„ู‰ ุขุฎุฑ * CONTRACT_CALL - ูŠุณุชุฏุนูŠ ุนู‚ุฏู‹ุง ุฐูƒูŠู‹ุงุŒ ุจุดูƒู„ ุฃุณุงุณูŠ ู„ุนู…ู„ูŠุงุช DeFi. * APPROVE - ูŠุณู…ุญ ู„ุนู‚ุฏ ุฐูƒูŠ ุจุงู„ุณุญุจ ู…ู† ู…ุญูุธุฉ ู…ุนูŠู†ุฉ. * MINT - ู‚ู… ุจุฅุฌุฑุงุก ุนู…ู„ูŠุฉ mint (ุฒูŠุงุฏุฉ ุงู„ุนุฑุถ) ุนู„ู‰ ุฑู…ุฒ ู…ุฏุนูˆู… * BURN - ู‚ู… ุจุฅุฌุฑุงุก ุนู…ู„ูŠุฉ ุญุฑู‚ (ุชู‚ู„ูŠู„ ุงู„ุนุฑุถ) ุนู„ู‰ ุฑู…ุฒ ู…ุฏุนูˆู… * SUPPLY - ูŠุณุชุฎุฏู… ู„ู€ DeFi ู„ุฅู‚ุฑุงุถ ุงู„ุฃุตูˆู„ * REDEEM - ูŠุณุชุฎุฏู… ู„ู€ DeFi ู„ุงุณุชุนุงุฏุฉ ุงู„ุฅู‚ุฑุงุถ * STAKE - ูŠุณู…ุญ ู„ูƒ ุจุชุฎุตูŠุต ูˆู‚ูู„ ุฃุตูˆู„ ู…ุนูŠู†ุฉ ู„ูƒุณุจ ู…ูƒุงูุขุช ุงู„ุชุฎุฒูŠู†. * RAW - ุฑุณุงู„ุฉ ุฎุงุฑุฌ ุงู„ุณู„ุณู„ุฉ ุจุฏูˆู† ุชู†ุณูŠู‚ ู…ุญุฏุฏ ู…ุณุจู‚ู‹ุงุŒ ุงุณุชุฎุฏู…ู‡ุง ู„ุชูˆู‚ูŠุน ุฃูŠ ุฑุณุงู„ุฉ ุจู…ูุชุงุญูƒ ุงู„ุฎุงุต. * TYPED_MESSAGE - ู†ูˆุน ุฑุณุงู„ุฉ ุฎุงุฑุฌ ุงู„ุณู„ุณู„ุฉ ูŠุชุจุน ุชู†ุณูŠู‚ู‹ุง ู…ุญุฏุฏู‹ุง ู…ุณุจู‚ู‹ุงุŒ ูŠุณุชุฎุฏู… ู„ุชูˆู‚ูŠุน ุฑุณุงุฆู„ ู…ุญุฏุฏุฉ ู„ูŠุณุช ู…ุนุงู…ู„ุงุช ูุนู„ูŠุฉ." + }, + "designatedSigner": { + "type": "string", + "description": "(ุชู… ุฅูŠู‚ุงู ุงุณุชุฎุฏุงู…ู‡ - ุชู… ุงุณุชุจุฏุงู„ู‡ ุจู€ "designatedSigners") ู…ุนุฑู ูŠู…ุซู„ ุงู„ู…ุณุชุฎุฏู… ุงู„ุฐูŠ ูŠูˆู‚ุน ุงู„ู…ุนุงู…ู„ุงุช ุงู„ุชูŠ ุชุชุทุงุจู‚ ู…ุน ู‚ุงุนุฏุฉ ู…ุนูŠู†ุฉ", + "deprecated": true + }, + "designatedSigners": { + "type": "object", + "description": "ู…ุฌู…ูˆุนุฉ ู…ู† ุงู„ู…ุนุฑูุงุช ุงู„ุชูŠ ุชู…ุซู„ ุงู„ู…ุณุชุฎุฏู…ูŠู† ุงู„ุฐูŠู† ูŠูˆู‚ุนูˆู† ุนู„ู‰ ุงู„ู…ุนุงู…ู„ุงุช ุงู„ุชูŠ ุชุทุงุจู‚ ู‚ุงุนุฏุฉ ู…ุนูŠู†ุฉ", + "properties": { + "users": { + "type": "array", + "description": "ู…ุฌู…ูˆุนุฉ ู…ุนุฑูุงุช ุงู„ู…ุณุชุฎุฏู…ูŠู†", + "items": { + "type": "string" + } + }, + "usersGroups": { + "type": "array", + "description": "ู…ุฌู…ูˆุนุฉ ู…ู† ู…ุนุฑูุงุช ุงู„ู…ุฌู…ูˆุนุฉ", + "items": { + "type": "string" + } + } + } + }, + "type": { + "const": "TRANSFER", + "description": "ู†ูˆุน ู‚ุงุนุฏุฉ ุงู„ุณูŠุงุณุฉ" + }, + "action": { + "oneOf": [ + { + "const": "ALLOW" + }, + { + "const": "BLOCK" + }, + { + "const": "2-TIER" + } + ], + "description": "ูŠุญุฏุฏ ู…ุง ูŠุญุฏุซ ุนู†ุฏู…ุง ุชู„ุจูŠ ุงู„ู…ุนุงู…ู„ุฉ ู…ุนุงูŠูŠุฑ ุงู„ู‚ุงุนุฏุฉ * ุงู„ุณู…ุงุญ - ุชุชู… ุงู„ู…ุนุงู…ู„ุฉ ูˆูŠู…ูƒู† ุชูˆู‚ูŠุนู‡ุง ุฏูˆู† ุงู„ุญุงุฌุฉ ุฅู„ู‰ ู…ูˆุงูู‚ุงุช ุฅุถุงููŠุฉ * ุงู„ุญุธุฑ - ูŠุชู… ุญุธุฑ ุงู„ู…ุนุงู…ู„ุฉ ุชู„ู‚ุงุฆูŠู‹ุง * 2-TIER - ูŠู…ูƒู† ูู‚ุท ู„ู‡ุคู„ุงุก ุงู„ู…ุณุชุฎุฏู…ูŠู† ุฃูˆ ู…ุฌู…ูˆุนุงุช ุงู„ู…ุณุชุฎุฏู…ูŠู† ุงู„ู…ูˆุงูู‚ุฉ ุฅุฐุง ุฑูุถ ุฃูŠ ู…ู†ู‡ู… ุงู„ู…ุนุงู…ู„ุฉ ู‚ุจู„ ุงุณุชูŠูุงุก ุญุฏ ุงู„ู…ูˆุงูู‚ุฉ ุงู„ู…ุทู„ูˆุจุŒ ูู„ู† ุชุชู… ุงู„ู…ุนุงู…ู„ุฉ ูŠุชู… ุชุนูŠูŠู† ู‚ุงุฆู…ุฉ ุงู„ูƒูŠุงู†ุงุช ููŠ ุญู‚ู„ "authorizationGroups"" + }, + "asset": { + "type": "string", + "description": "ูŠุญุฏุฏ ู†ูˆุน ุงู„ุฃุตูˆู„ ุงู„ุชูŠ ูŠุชู… ุงู„ุชุนุงู…ู„ ุนู„ูŠู‡ุงุŒ ูˆุงู„ุฎูŠุงุฑุงุช ู‡ูŠ * "*" - ุฌู…ูŠุน ุงู„ุฃุตูˆู„ * ุฃุตู„ ู…ุญุฏุฏ" + }, + "srcType": { + "description": "(ุชู… ุฅูŠู‚ุงู ุงุณุชุฎุฏุงู…ู‡ - ุชู… ุงุณุชุจุฏุงู„ู‡ ุจู€ "src") ู†ูˆุน ุญุณุงุจ ุงู„ู…ุตุฏุฑ" + }, + "srcSubType": { + "description": "(ุชู… ุฅูŠู‚ุงู ุงุณุชุฎุฏุงู…ู‡ - ุชู… ุงุณุชุจุฏุงู„ู‡ ุจู€ "src") ู†ูˆุน ุงู„ุญุณุงุจ ุงู„ูุฑุนูŠ ุงู„ู…ุตุฏุฑ" + }, + "srcId": { + "description": "(ุชู… ุฅูŠู‚ุงู ุงุณุชุฎุฏุงู…ู‡ - ุชู… ุงุณุชุจุฏุงู„ู‡ ุจู€ "src") ู…ุนุฑู ุญุณุงุจ ุงู„ู…ุตุฏุฑ" + }, + "src": { + "type": "object", + "description": "ูŠุญุฏุฏ ุญุณุงุจุงุช ุงู„ู…ุตุฏุฑ ุงู„ุชูŠ ุชุณู…ุญ ุงู„ู‚ุงุนุฏุฉ ุจุฅุฌุฑุงุก ุงู„ุชุญูˆูŠู„ุงุช ู…ู†ู‡ุง", + "properties": { + "ids": { + "type": "array", + "description": "ู…ุฌู…ูˆุนุฉ ู…ู† ุงู„ู…ุนุฑูุงุช", + "items": { + "type": "array", + "description": "ู…ุฌู…ูˆุนุฉ ู…ู† ุงู„ู…ุนุฑูุงุช ุจุชู†ุณูŠู‚ tuple", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/PolicySrcOrDestId" + }, + { + "$ref": "#/components/schemas/PolicySrcOrDestType" + }, + { + "$ref": "#/components/schemas/PolicySrcOrDestSubType" + } + ] + }, + "minItems": 1, + "maxItems": 3 + } + } + } + }, + "dstType": { + "description": "(ุชู… ุฅูŠู‚ุงู ุงุณุชุฎุฏุงู…ู‡ - ุชู… ุงุณุชุจุฏุงู„ู‡ ุจู€ "dst") ู†ูˆุน ุญุณุงุจ ุงู„ูˆุฌู‡ุฉ" + }, + "dstSubType": { + "description": "(ุชู… ุฅูŠู‚ุงู ุงุณุชุฎุฏุงู…ู‡ - ุชู… ุงุณุชุจุฏุงู„ู‡ ุจู€ "dst") ู†ูˆุน ุงู„ุญุณุงุจ ุงู„ูุฑุนูŠ ู„ู„ูˆุฌู‡ุฉ" + }, + "dstId": { + "description": "(ุชู… ุฅูŠู‚ุงู ุงุณุชุฎุฏุงู…ู‡ - ุชู… ุงุณุชุจุฏุงู„ู‡ ุจู€ "dst") ู…ุนุฑู ุญุณุงุจ ุงู„ูˆุฌู‡ุฉ" + }, + "dst": { + "type": "object", + "description": "ูŠุญุฏุฏ ุญุณุงุจุงุช ุงู„ูˆุฌู‡ุฉ ุงู„ุชูŠ ุชุณู…ุญ ุงู„ู‚ุงุนุฏุฉ ุจุงู„ุชุญูˆูŠู„ุงุช ุฅู„ูŠู‡ุง", + "properties": { + "ids": { + "type": "array", + "description": "ู…ุฌู…ูˆุนุฉ ู…ู† ุงู„ู…ุนุฑูุงุช", + "items": { + "type": "array", + "description": "ู…ุฌู…ูˆุนุฉ ู…ู† ุงู„ู…ุนุฑูุงุช ุจุชู†ุณูŠู‚ tuple", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/PolicySrcOrDestId" + }, + { + "$ref": "#/components/schemas/PolicySrcOrDestType" + }, + { + "$ref": "#/components/schemas/PolicySrcOrDestSubType" + } + ] + }, + "minItems": 1, + "maxItems": 3 + } + } + } + }, + "dstAddressType": { + "oneOf": [ + { + "const": "WHITELISTED" + }, + { + "const": "ONE_TIME" + }, + { + "const": "*" + } + ], + "description": "ูŠุญุฏุฏ ู…ุง ุฅุฐุง ูƒุงู† ูŠุฌุจ ุฅุฏุฑุงุฌ ุงู„ูˆุฌู‡ุฉ ุงู„ุชูŠ ุชุฑุณู„ ุฅู„ูŠู‡ุง ุงู„ุฃู…ูˆุงู„ ููŠ ุงู„ู‚ุงุฆู…ุฉ ุงู„ุจูŠุถุงุกุŒ ู„ู„ุณู…ุงุญ ุจุงู„ุชุญูˆูŠู„ุงุช ู„ู…ุฑุฉ ูˆุงุญุฏุฉ ุฅู„ู‰ ุนู†ุงูˆูŠู† ุฎุงุฑุฌูŠุฉ ุบูŠุฑ ู…ุฏุฑุฌุฉ ููŠ ุงู„ู‚ุงุฆู…ุฉ ุงู„ุจูŠุถุงุกุŒ ุฃูˆ ูƒู„ูŠู‡ู…ุง. ุจุดูƒู„ ุงูุชุฑุงุถูŠุŒ ูŠู…ูƒู†ูƒ ุงู„ุชุญูˆูŠู„ ุฅู„ู‰ ุนู†ูˆุงู† ุฎุงุฑุฌูŠ ูู‚ุท ุจุนุฏ ุฅุฏุฑุงุฌู‡ ููŠ ุงู„ู‚ุงุฆู…ุฉ ุงู„ุจูŠุถุงุก. * WHITELISTED - ูŠู…ูƒู† ุฅุฑุณุงู„ู‡ุง ูู‚ุท ุฅู„ู‰ ุนู†ุงูˆูŠู† ู…ุฏุฑุฌุฉ ููŠ ุงู„ู‚ุงุฆู…ุฉ ุงู„ุจูŠุถุงุก. * ONE_TIME - ูŠู…ูƒู† ุฅุฑุณุงู„ู‡ุง ูู‚ุท ุฅู„ู‰ ุนู†ุงูˆูŠู† ุฎุงุฑุฌูŠุฉ ุบูŠุฑ ู…ุฏุฑุฌุฉ ููŠ ุงู„ู‚ุงุฆู…ุฉ ุงู„ุจูŠุถุงุก. * "*" - ูŠู…ูƒู† ุฅุฑุณุงู„ู‡ุง ุฅู„ู‰ ุนู†ุงูˆูŠู† ู…ุฏุฑุฌุฉ ููŠ ุงู„ู‚ุงุฆู…ุฉ ุงู„ุจูŠุถุงุก ุฃูˆ ุนู†ุงูˆูŠู† ุฎุงุฑุฌูŠุฉ ุบูŠุฑ ู…ุฏุฑุฌุฉ ููŠ ุงู„ู‚ุงุฆู…ุฉ ุงู„ุจูŠุถุงุก" + }, + "amountCurrency": { + "oneOf": [ + { + "const": "USD" + }, + { + "const": "EUR" + }, + { + "const": "NATIVE" + } + ], + "description": "* USD - ูŠุญุฏ ู…ู† ู…ู‚ุฏุงุฑ ุฃูŠ ุฃุตู„ ูŠู…ูƒู† ู„ู„ู…ุณุชุฎุฏู…ูŠู† ู†ู‚ู„ู‡ ุจู†ุงุกู‹ ุนู„ู‰ ู…ุง ูŠุนุงุฏู„ู‡ ุจุงู„ุฏูˆู„ุงุฑ ุงู„ุฃู…ุฑูŠูƒูŠ ู…ู† ุงู„ุฃุตู„. * EUR - ูŠุญุฏ ู…ู† ู…ู‚ุฏุงุฑ ุฃูŠ ุฃุตู„ ูŠู…ูƒู† ู„ู„ู…ุณุชุฎุฏู…ูŠู† ู†ู‚ู„ู‡ ุจู†ุงุกู‹ ุนู„ู‰ ู…ุง ูŠุนุงุฏู„ู‡ ุจุงู„ูŠูˆุฑูˆ ู…ู† ุงู„ุฃุตู„. * NATIVE - ูŠุญุฏ ู…ู† ู…ู‚ุฏุงุฑ ุงู„ุฃุตู„ ุงู„ุฐูŠ ูŠู…ูƒู† ู„ู„ู…ุณุชุฎุฏู… ู†ู‚ู„ู‡ ุนู†ุฏ ุงุณุชุฎุฏุงู… ุฃุตู„ ู…ุนูŠู†." + }, + "amountScope": { + "oneOf": [ + { + "const": "SINGLE_TX" + }, + { + "const": "TIMEFRAME" + } + ], + "description": "* SINGLE_TX - ูŠู†ุทุจู‚ ุงู„ุญุฏ ุนู„ู‰ ู…ุนุงู…ู„ุฉ ูˆุงุญุฏุฉ * TIMEFRAME - ูŠู†ุทุจู‚ ุงู„ุญุฏ ุนู„ู‰ ุฌู…ูŠุน ุงู„ู…ุนุงู…ู„ุงุช ุถู…ู† ุงู„ูุชุฑุฉ ุงู„ุฒู…ู†ูŠุฉ ุงู„ู…ุญุฏุฏุฉ" + }, + "amount": { + "type": "number", + "description": "ูŠุญุฏุฏ ุงู„ู‚ูŠู…ุฉ ุงู„ุชูŠ ูŠุฌุจ ุฃู† ุชุชุฌุงูˆุฒู‡ุง ุงู„ู…ุนุงู…ู„ุฉ ุญุชู‰ ูŠุชู… ุชุทุจูŠู‚ ุงู„ู‚ุงุนุฏุฉ ุนู„ูŠู‡ุง (ูˆูู‚ู‹ุง ู„ุญู‚ู„ amountCurrency)" + }, + "periodSec": { + "type": "number", + "description": "ุงู„ูุชุฑุฉ ุงู„ุฒู…ู†ูŠุฉ ุจุงู„ุซูˆุงู†ูŠ ุงู„ุชูŠ ูŠุชู… ุชุทุจูŠู‚ู‡ุง ุจูˆุงุณุทุฉ ุญู‚ู„ amountScope ู„ุชุฌู…ูŠุน ุงู„ู…ุจุงู„ุบ ุงู„ู…ุญูˆู„ุฉ ููŠ ุงู„ู…ุนุงู…ู„ุงุช ุงู„ุชูŠ ุชุชุทุงุจู‚ ู…ุน ุงู„ู‚ุงุนุฏุฉุŒ ุญุชู‰ ูŠุชุฌุงูˆุฒ ุงู„ุฅุฌู…ุงู„ูŠ ุงู„ู‚ูŠู…ุฉ ุงู„ุชูŠ ุชุญุฏุฏู‡ุง ุถู…ู† ุงู„ุญุฏ ุงู„ุฃุฏู†ู‰. ุนู†ุฏู…ุง ูŠุชู… ุงู„ูˆุตูˆู„ ุฅู„ู‰ ุงู„ู…ุจู„ุบ ุงู„ู…ุญุฏุฏ ุฎู„ุงู„ ุชู„ูƒ ุงู„ูุชุฑุฉุŒ ุณูˆุงุก ู…ู† ุฎู„ุงู„ ู…ุนุงู…ู„ุฉ ูˆุงุญุฏุฉ ุฃูˆ ุงู„ุนุฏูŠุฏ ู…ู† ุงู„ู…ุนุงู…ู„ุงุชุŒ ูุฅู† ุงู„ู…ุนุงู…ู„ุงุช ุงู„ุฃุฎุฑู‰ ููŠ ุชู„ูƒ ุงู„ูุชุฑุฉ ุฅู…ุง ุชูุดู„ ุฃูˆ ุชุชุทู„ุจ ู…ูˆุงูู‚ุงุช ุฃูƒุซุฑ." + }, + "authorizers": { + "type": "array", + "description": "(ุชู… ุฅูŠู‚ุงู ุงุณุชุฎุฏุงู…ู‡ - ุชู… ุงุณุชุจุฏุงู„ู‡ ุจู€ "authorizationGroups") ุงู„ูƒูŠุงู†ุงุช ุงู„ู…ุณู…ูˆุญ ุจู‡ุง ูˆุงู„ุชูŠ ูŠู…ูƒู†ู‡ุง ุงู„ู…ูˆุงูู‚ุฉ ุนู„ู‰ ุงู„ู…ุนุงู…ู„ุฉ", + "deprecated": true, + "items": { + "type": "string" + } + }, + "authorizersCount": { + "type": "number", + "description": "(ุชู… ุฅูŠู‚ุงู ุงุณุชุฎุฏุงู…ู‡ - ุชู… ุงุณุชุจุฏุงู„ู‡ ุจู€ "authorizationGroups") ุงู„ุญุฏ ุงู„ุฃุฏู†ู‰ ู„ุนุฏุฏ ุงู„ูƒูŠุงู†ุงุช ุงู„ู…ุทู„ูˆุจุฉ ู„ู„ู…ูˆุงูู‚ุฉ ุนู„ู‰ ุงู„ู…ุนุงู…ู„ุฉ", + "deprecated": true + }, + "authorizationGroups": { + "type": "object", + "description": "ูŠุญุฏุฏ ุดุฑูˆุท ุงู„ู…ูˆุงูู‚ุฉ ุนู„ู‰ ุงู„ู…ุนุงู…ู„ุฉ", + "properties": { + "logic": { + "oneOf": [ + { + "const": "AND" + }, + { + "const": "OR" + } + ], + "description": "* AND - ูŠุชุทู„ุจ ู…ูˆุงูู‚ุฉ ุฌู…ูŠุน ู…ุฌู…ูˆุนุงุช ุงู„ุชููˆูŠุถ * OR - ูŠุชุทู„ุจ ู…ูˆุงูู‚ุฉ ูˆุงุญุฏุฉ ุนู„ู‰ ุงู„ุฃู‚ู„ ู…ู† ู…ุฌู…ูˆุนุงุช ุงู„ุชููˆูŠุถ" + }, + "allowOperatorAsAuthorizer": { + "type": "boolean", + "description": "ูŠุญุฏุฏ ู…ุง ุฅุฐุง ูƒุงู† ุงู„ู…ุณุชุฎุฏู… ุงู„ุฐูŠ ูŠุจุฏุฃ ู…ุนุงู…ู„ุฉ ูŠู…ูƒู†ู‡ ุงู„ู…ูˆุงูู‚ุฉ ุนู„ู‰ ู…ุนุงู…ู„ุชู‡ ุงู„ุฎุงุตุฉ ูˆุงู„ุงุญุชุณุงุจ ุถู…ู† ุนุชุจุฉ ุงู„ู…ูˆุงูู‚ุฉ ู„ู…ุนุงู…ู„ุชู‡" + }, + "groups": { + "type": "array", + "description": "ู…ุฌู…ูˆุนุงุช ุงู„ูƒูŠุงู†ุงุช ุงู„ุชูŠ ูŠู…ูƒู†ู‡ุง ุงู„ู…ูˆุงูู‚ุฉ ุนู„ู‰ ุงู„ู…ุนุงู…ู„ุฉ", + "items": { + "type": "object", + "properties": { + "users": { + "type": "array", + "description": "ู…ุนุฑูุงุช ุงู„ู…ุณุชุฎุฏู…", + "items": { + "type": "string" + } + }, + "usersGroups": { + "type": "array", + "description": "ู…ุนุฑูุงุช ุงู„ู…ุฌู…ูˆุนุฉ", + "items": { + "type": "string" + } + }, + "th": { + "type": "number", + "description": "ูŠู…ุซู„ ุงู„ุญุฏ ุงู„ุฃุฏู†ู‰ ู„ุนุฏุฏ ุงู„ูƒูŠุงู†ุงุช ุงู„ู…ุทู„ูˆุจุฉ ู„ู„ู…ูˆุงูู‚ุฉ ุนู„ู‰ ุงู„ู…ุนุงู…ู„ุฉุŒ ูˆุงู„ุงูุชุฑุงุถูŠ ู‡ูˆ 1." + } + } + } + } + } + }, + "amountAggregation": { + "type": "object", + "description": "ูŠุญุฏุฏ ุงู„ุทุฑูŠู‚ุฉ ุงู„ุชูŠ ูŠุญุณุจ ุจู‡ุง ู…ุญุฑูƒ ุงู„ุณูŠุงุณุฉ ุงู„ุชุฑุงูƒู…. ูู‡ูˆ ูŠุณุชุฎุฏู… ุงู„ู…ุจุฏุฆ ูˆุงู„ู…ุตุฏุฑ ูˆุงู„ูˆุฌู‡ุฉ ู„ุญุณุงุจ ุงู„ุชุฑุงูƒู… ู†ุญูˆ ุงู„ู‚ูŠู…ุฉ ุงู„ู…ูˆุฌูˆุฏุฉ ุถู…ู† ุงู„ุญุฏ ุงู„ุฃุฏู†ู‰ุŒ ู„ู„ูˆู‚ุช ุงู„ู…ูˆุฌูˆุฏ ุถู…ู† ุงู„ูุชุฑุฉ ุงู„ุฒู…ู†ูŠุฉ.", + "properties": { + "operators": { + "$ref": "#/components/schemas/AmountAggregationTimePeriodMethod" + }, + "srcTransferPeers": { + "$ref": "#/components/schemas/AmountAggregationTimePeriodMethod" + }, + "dstTransferPeers": { + "$ref": "#/components/schemas/AmountAggregationTimePeriodMethod" + } + } + }, + "rawMessageSigning": { + "type": "object", + "description": "ุชูƒูˆูŠู† ุชูˆู‚ูŠุน ุงู„ุฑุณุงู„ุฉ ุงู„ุฎุงู…", + "properties": { + "algorithm": { + "type": "string" + }, + "derivationPath": { + "type": "object", + "properties": { + "path": { + "type": "array", + "items": { + "type": "number" + } + } + } + } + } + }, + "applyForApprove": { + "type": "boolean", + "description": "ุชุทุจูŠู‚ ู‡ุฐู‡ ุงู„ู‚ุงุนุฏุฉ ุนู„ู‰ ู…ุนุงู…ู„ุงุช ู†ูˆุน ุงู„ู…ูˆุงูู‚ุฉ (ูŠู…ูƒู† ุชู…ูƒูŠู†ู‡ุง ูู‚ุท ุนู†ุฏู…ุง ูŠูƒูˆู† ู†ูˆุน ู…ุนุงู…ู„ุฉ ุงู„ู‚ุงุนุฏุฉ ู‡ูˆ ุงู„ู†ู‚ู„)" + }, + "applyForTypedMessage": { + "type": "boolean", + "description": "ุชุทุจูŠู‚ ู‡ุฐู‡ ุงู„ู‚ุงุนุฏุฉ ุนู„ู‰ ู…ุนุงู…ู„ุงุช ู†ูˆุน TYPED_MESSAGE (ูŠู…ูƒู† ุชู…ูƒูŠู†ู‡ุง ูู‚ุท ุนู†ุฏู…ุง ูŠูƒูˆู† ู†ูˆุน ู…ุนุงู…ู„ุฉ ุงู„ู‚ุงุนุฏุฉ ู‡ูˆ CONTRACT_CALL)" + }, + "externalDescriptor": { + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ูŠุญุฏุฏ ุงู„ู‚ุงุนุฏุฉ" + } + }, + "required": [ + "type", + "action", + "asset", + "amountCurrency", + "amountScope", + "amount", + "periodSec", + "externalDescriptor" + ] + }, + "PublishResult": { + "type": "object", + "description": "ูƒุงุฆู† ุงู„ุงุณุชุฌุงุจุฉ ู„ุนู…ู„ูŠุฉ ุณูŠุงุณุฉ ุงู„ู†ุดุฑ", + "properties": { + "status": { + "$ref": "#/components/schemas/PolicyStatus" + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicyRule" + } + }, + "checkResult": { + "$ref": "#/components/schemas/PolicyCheckResult" + }, + "metadata": { + "$ref": "#/components/schemas/PolicyMetadata" + } + }, + "required": [ + "status", + "rules", + "checkResult", + "metadata" + ] + }, + "PolicyStatus": { + "oneOf": [ + { + "const": "SUCCESS" + }, + { + "const": "UNVALIDATED" + }, + { + "const": "INVALID_CONFIGURATION" + }, + { + "const": "PENDING" + }, + { + "const": "PENDING_CONSOLE_APPROVAL" + }, + { + "const": "AWAITING_QUORUM" + }, + { + "const": "UNHANDLED_ERROR" + } + ], + "description": "* SUCCESS - ู†ุฌุงุญ * UNVALIDATED - ู„ู… ูŠุชู… ุงู„ุชุญู‚ู‚ ู…ู† ุตุญุชู‡ ุจุนุฏ * INVALID_CONFIGURATION - ู‡ู†ุงูƒ ู‚ุงุนุฏุฉ ูˆุงุญุฏุฉ ุนู„ู‰ ุงู„ุฃู‚ู„ ุบูŠุฑ ุตุงู„ุญุฉ * PENDING - ุงู†ุชุธุงุฑ ุงู„ู…ูˆุงูู‚ุฉ * PENDING_CONSOLE_APPROVAL - ุงู†ุชุธุงุฑ ุงู„ู…ูˆุงูู‚ุฉ ู…ู† ุชุทุจูŠู‚ ูˆุญุฏุฉ ุงู„ุชุญูƒู… * AWAITING_QUORUM - ุงู†ุชุธุงุฑ ู…ูˆุงูู‚ุฉ ุงู„ู†ุตุงุจ ุงู„ู‚ุงู†ูˆู†ูŠ * UNHANDLED_ERROR - ุฎุทุฃ ุบูŠุฑ ู…ุนุงู„ุฌ" + }, + "PolicyMetadata": { + "type": "object", + "description": "ุงู„ุจูŠุงู†ุงุช ุงู„ูˆุตููŠุฉ ุงู„ู…ุชุนู„ู‚ุฉ ุจุงู„ุณูŠุงุณุฉ", + "properties": { + "editedBy": { + "type": "string", + "description": "ู…ุนุฑู ุงู„ู…ุณุชุฎุฏู… ู„ู„ู…ุณุชุฎุฏู… ุงู„ุฐูŠ ู‚ุงู… ุจุชุญุฑูŠุฑ ุงู„ุณูŠุงุณุฉ ุขุฎุฑ ู…ุฑุฉ" + }, + "editedAt": { + "type": "string", + "description": "ุงู„ุทุงุจุน ุงู„ุฒู…ู†ูŠ ู„ุขุฎุฑ ุชุนุฏูŠู„ ู„ู„ุณูŠุงุณุฉ" + }, + "publishedBy": { + "type": "string", + "description": "ู…ุนุฑู ุงู„ู…ุณุชุฎุฏู… ู„ู„ู…ุณุชุฎุฏู… ุงู„ุฐูŠ ู†ุดุฑ ุงู„ุณูŠุงุณุฉ ุขุฎุฑ ู…ุฑุฉ" + }, + "publishedAt": { + "type": "string", + "description": "ุงู„ุทุงุจุน ุงู„ุฒู…ู†ูŠ ู„ุขุฎุฑ ู†ุดุฑ ู„ู„ุณูŠุงุณุฉ" + } + } + }, + "PolicyCheckResult": { + "type": "object", + "description": "ู†ุชูŠุฌุฉ ุงู„ุชุญู‚ู‚ ู…ู† ู‚ูˆุงุนุฏ ุงู„ุณูŠุงุณุฉ", + "properties": { + "errors": { + "type": "number", + "description": "ุนุฏุฏ ุงู„ุฃุฎุทุงุก" + }, + "result": { + "type": "array", + "description": "ู…ุฌู…ูˆุนุฉ ู…ู† ู†ุชุงุฆุฌ ุงู„ุชุญู‚ู‚", + "items": { + "$ref": "#/components/schemas/PolicyRuleCheckResult" + } + } + }, + "required": [ + "errors", + "result" + ] + }, + "PolicyRuleCheckResult": { + "type": "object", + "description": "ู†ุชูŠุฌุฉ ุงู„ุชุญู‚ู‚ ู…ู† ุตุญุฉ ุงู„ู‚ุงุนุฏุฉ", + "properties": { + "index": { + "type": "number", + "description": "ุฑู‚ู… ู…ุคุดุฑ ุงู„ู‚ุงุนุฏุฉ ููŠ ุงู„ุณูŠุงุณุฉ" + }, + "status": { + "oneOf": [ + { + "const": "ok" + }, + { + "const": "failure" + } + ], + "description": "ุญุงู„ุฉ ุงู„ุชุญู‚ู‚" + }, + "errors": { + "type": "array", + "description": "ู…ุฌู…ูˆุนุฉ ู…ู† ูƒุงุฆู†ุงุช ุฎุทุฃ ุงู„ุชุญู‚ู‚ ู…ู† ุตุญุฉ ุงู„ู‚ุงุนุฏุฉ", + "items": { + "$ref": "#/components/schemas/PolicyRuleError" + } + } + }, + "required": [ + "index", + "status", + "errors" + ] + }, + "PolicyRuleError": { + "type": "object", + "description": "ุฎุทุฃ ููŠ ู†ุชูŠุฌุฉ ุงู„ุชุญู‚ู‚ ู…ู† ุงู„ู‚ุงุนุฏุฉ", + "properties": { + "errorMessage": { + "type": "string", + "description": "ุฑุณุงู„ุฉ ุงู„ุฎุทุฃ" + }, + "errorCode": { + "type": "number", + "description": "ุฑู…ุฒ ุงู„ุฎุทุฃ" + }, + "errorCodeName": { + "type": "string", + "description": "ุงุณู… ุฑู…ุฒ ุงู„ุฎุทุฃ" + }, + "errorField": { + "oneOf": [ + { + "const": "operator" + }, + { + "const": "operators" + }, + { + "const": "authorizationGroups" + }, + { + "const": "designatedSigner" + }, + { + "const": "designatedSigners" + }, + { + "const": "contractMethods" + }, + { + "const": "amountAggregation" + }, + { + "const": "src" + }, + { + "const": "dst" + } + ], + "description": "ุงู„ุญู‚ู„ ุงู„ุฐูŠ ูŠุชุนู„ู‚ ุจู‡ ุงู„ุฎุทุฃ * ุงู„ู…ุดุบู„ - ู…ูู†ุดุฆ ุงู„ู…ุนุงู…ู„ุฉ * ุงู„ู…ุดุบู„ูˆู† - ู…ูู†ุดุฆูˆ ุงู„ู…ุนุงู…ู„ุฉ * AuthorizationGroups - ู…ุฌู…ูˆุนุงุช ู…ูุตุฑุญูŠ ุงู„ู…ุนุงู…ู„ุฉ * assignedSigner - ู…ููˆู‚ูู‘ุน ุงู„ู…ุนุงู…ู„ุฉ * assignedSigners - ู…ููˆู‚ูู‘ุนูŠ ุงู„ู…ุนุงู…ู„ุฉ * contractMethods - ุทุฑู‚ ุงู„ุนู‚ุฏ * amountAggregation - ุชูƒูˆูŠู† ุชุฌู…ูŠุน ู…ุจู„ุบ ุงู„ู…ุนุงู…ู„ุฉ * src - ุชูƒูˆูŠู† ุฃุตู„ ู…ุตุฏุฑ ุงู„ู…ุนุงู…ู„ุฉ * dst - ุชูƒูˆูŠู† ุฃุตู„ ูˆุฌู‡ุฉ ุงู„ู…ุนุงู…ู„ุฉ" + } + }, + "required": [ + "errorMessage", + "errorCode", + "errorCodeName", + "errorField" + ] + }, + "DraftReviewAndValidationResponse": { + "type": "object", + "description": "ุงู„ุชุญู‚ู‚ ู…ู† ุตุญุฉ ุงู„ู…ุณูˆุฏุฉ", + "properties": { + "draftResponse": { + "$ref": "#/components/schemas/DraftResponse" + }, + "validation": { + "$ref": "#/components/schemas/PolicyValidation" + } + }, + "required": [ + "draftResponse", + "validation" + ] + }, + "PolicyAndValidationResponse": { + "type": "object", + "description": "ุงู„ุชุญู‚ู‚ ู…ู† ุตุญุฉ ุงู„ุณูŠุงุณุฉ", + "properties": { + "policy": { + "$ref": "#/components/schemas/PolicyResponse" + }, + "validation": { + "$ref": "#/components/schemas/PolicyValidation" + } + }, + "required": [ + "policy", + "validation" + ] + }, + "DraftResponse": { + "type": "object", + "description": "ูƒุงุฆู† ุงู„ุงุณุชุฌุงุจุฉ ู„ุนู…ู„ูŠุงุช ุงู„ู…ุณูˆุฏุฉ", + "properties": { + "status": { + "type": "string", + "description": "ุญุงู„ุฉ ุงู„ุชุดุบูŠู„" + }, + "rules": { + "type": "array", + "description": "ู…ุณูˆุฏุฉ ุงู„ู‚ูˆุงุนุฏ", + "items": { + "$ref": "#/components/schemas/PolicyRule" + } + }, + "draftId": { + "type": "string", + "description": "ู…ุณูˆุฏุฉ ู…ุนุฑู ูุฑูŠุฏ" + }, + "metadata": { + "$ref": "#/components/schemas/PolicyMetadata" + } + }, + "required": [ + "draftId", + "status", + "rules", + "metadata" + ] + }, + "PolicyResponse": { + "type": "object", + "description": "ูƒุงุฆู† ุงู„ุงุณุชุฌุงุจุฉ ู„ุนู…ู„ูŠุงุช ุงู„ุณูŠุงุณุฉ", + "properties": { + "rules": { + "type": "array", + "description": "ู…ุฌู…ูˆุนุฉ ู…ู† ู‚ูˆุงุนุฏ ุงู„ุณูŠุงุณุฉ", + "items": { + "$ref": "#/components/schemas/PolicyRule" + } + }, + "metadata": { + "$ref": "#/components/schemas/PolicyMetadata" + } + }, + "required": [ + "rules", + "metadata" + ] + }, + "PolicyValidation": { + "type": "object", + "description": "ูƒุงุฆู† ุงู„ุชุญู‚ู‚ ู…ู† ุตุญุฉ ุงู„ุณูŠุงุณุฉ", + "properties": { + "status": { + "type": "string", + "description": "ุญุงู„ุฉ ุงู„ุชุญู‚ู‚" + }, + "checkResult": { + "$ref": "#/components/schemas/PolicyCheckResult" + } + }, + "required": [ + "status", + "checkResult" + ] + }, + "ErrorResponse": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "type": { + "oneOf": [ + { + "const": "INTERNAL" + }, + { + "const": "AUTHENTICATION" + }, + { + "const": "AUTHORIZATION" + }, + { + "const": "VALIDATION" + }, + { + "const": "NOT_FOUND" + }, + { + "const": "UNPROCESSABLE_ENTITY" + }, + { + "const": "FORBIDDEN" + } + ] + }, + "message": { + "type": "string" + } + }, + "required": [ + "type", + "message" + ] + } + }, + "required": [ + "error" + ] + } + }, + "securitySchemes": { + "bearerTokenAuth": { + "type": "http", + "scheme": "bearer", + "bearerFormat": "JWT" + }, + "ApiKeyAuth": { + "type": "apiKey", + "in": "header", + "name": "X-API-Key" + } + } + }, + "x-samchon-emended": true +} \ No newline at end of file diff --git a/assets/output/fireblocks.swagger.ja.json b/assets/output/fireblocks.swagger.ja.json new file mode 100644 index 0000000..57d9f6b --- /dev/null +++ b/assets/output/fireblocks.swagger.ja.json @@ -0,0 +1,16347 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "ใƒ•ใ‚กใ‚คใ‚ขใƒ–ใƒญใƒƒใ‚ฏAPI", + "version": "1.0.0", + "contact": { + "email": "support@fireblocks.com" + } + }, + "servers": [ + { + "url": "https://api.fireblocks.io/v1" + } + ], + "x-readme": { + "explorer-enabled": false, + "samples-languages": [ + "curl", + "javascript", + "python" + ] + }, + "paths": { + "/vault/accounts": { + "get": { + "summary": "ไฟ็ฎกๅบซใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎไธ€่ฆง", + "description": "ใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚นๅ†…ใฎใ™ในใฆใฎ Vault ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’ๅ–ๅพ—ใ—ใพใ™.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vault_accounts = fireblocks.get_vault_accounts()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAccounts = await fireblocks.getVaultAccounts();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "query", + "name": "namePrefix", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "nameSuffix", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minAmountThreshold", + "required": false, + "schema": { + "type": "number" + } + }, + { + "in": "query", + "name": "assetId", + "required": false, + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "้‡‘ๅบซใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎใƒชใ‚นใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VaultAccount" + } + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "ๆ–ฐใ—ใ„Vaultใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’ไฝœๆˆใ™ใ‚‹", + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸๅๅ‰ใงๆ–ฐใ—ใ„ Vault ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’ไฝœๆˆใ—ใพใ™.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAccount = fireblocks.create_vault_account(name, hiddenOnUI, customer_ref_id, auto_fueling)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAccount = await fireblocks.createVaultAccount(name, hiddenOnUI, customerRefId, autoFueling);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "description": "ใ‚ขใ‚ซใ‚ฆใƒณใƒˆๅ", + "type": "string" + }, + "hiddenOnUI": { + "description": "ใ‚ชใƒ—ใ‚ทใƒงใƒณ - true ใฎๅ ดๅˆใ€ไฝœๆˆใ•ใ‚ŒใŸใ‚ขใ‚ซใ‚ฆใƒณใƒˆใจ้–ข้€ฃใ™ใ‚‹ใ™ในใฆใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏ Fireblocks ใ‚ณใƒณใ‚ฝใƒผใƒซใซ่กจ็คบใ•ใ‚Œใพใ›ใ‚“ใ€‚", + "type": "boolean" + }, + "customerRefId": { + "description": "ใ‚ชใƒ—ใ‚ทใƒงใƒณ - ้กงๅฎขๅ‚็…งIDใ‚’่จญๅฎšใ—ใพใ™", + "type": "string" + }, + "autoFuel": { + "description": "ใ‚ชใƒ—ใ‚ทใƒงใƒณ - ใƒœใƒผใƒซใƒˆใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎ autoFuel ใƒ—ใƒญใƒ‘ใƒ†ใ‚ฃใ‚’่จญๅฎšใ—ใพใ™", + "type": "boolean" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Vault ใ‚ขใ‚ซใ‚ฆใƒณใƒˆ ใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/VaultAccount" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts_paged": { + "get": { + "summary": "ไฟ็ฎกๅบซใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎไธ€่ฆง่กจ็คบ๏ผˆใƒšใƒผใ‚ธๅŒบๅˆ‡ใ‚Š๏ผ‰", + "description": "ใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚นๅ†…ใฎใ™ในใฆใฎ Vault ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’ๅ–ๅพ—ใ—ใพใ™ใ€‚ใ“ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฏใ€็Ÿญใ„ๅฟœ็ญ”ๆ™‚้–“ใง้™ใ‚‰ใ‚ŒใŸๆ•ฐใฎ็ตๆžœใ‚’่ฟ”ใ—ใพใ™ใ€‚.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vault_accounts = fireblocks.get_vault_accounts_with_page_info(filters)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAccounts = await fireblocks.getVaultAccountsWithPageInfo(filters);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "query", + "name": "namePrefix", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "nameSuffix", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minAmountThreshold", + "required": false, + "schema": { + "type": "number" + } + }, + { + "in": "query", + "name": "assetId", + "required": false, + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + }, + { + "in": "query", + "name": "orderBy", + "required": false, + "schema": { + "oneOf": [ + { + "const": "ASC" + }, + { + "const": "DESC" + } + ] + } + }, + { + "in": "query", + "name": "before", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "after", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "number", + "minimum": 1, + "maximum": 500, + "default": 200 + } + } + ], + "responses": { + "200": { + "description": "VaultAccountsPagedResponse ใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/VaultAccountsPagedResponse" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}": { + "get": { + "summary": "IDใงVaultใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’ๆคœ็ดขใ™ใ‚‹", + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸVaultใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’่ฟ”ใ—ใพใ™.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vault_account = fireblocks.get_vault_account(vault_account_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAccount = await fireblocks.getVaultAccount(vault_account_id);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "่ฟ”ใ•ใ‚Œใ‚‹ใƒœใƒผใƒซใƒˆใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎID ๅž‹: ๆ–‡ๅญ—ๅˆ—", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + } + ], + "responses": { + "200": { + "description": "Vault ใ‚ขใ‚ซใ‚ฆใƒณใƒˆ ใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/VaultAccount" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "put": { + "summary": "ใƒœใƒผใƒซใƒˆใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎๅๅ‰ใ‚’ๅค‰ๆ›ดใ™ใ‚‹", + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸVaultใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎๅๅ‰ใ‚’ๅค‰ๆ›ดใ—ใพใ™.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAccount = fireblocks.update_vault_account(vault_account_id, name)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAccount = await fireblocks.updateVaultAccount(vautlAccountId, name);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "็ทจ้›†ใ™ใ‚‹ใƒœใƒผใƒซใƒˆใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎID", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "description": "ใ‚ขใ‚ซใ‚ฆใƒณใƒˆๅ", + "type": "string" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "ใ‚ใ‹ใ‚Šใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/asset_wallets": { + "get": { + "summary": "่ณ‡็”ฃใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎไธ€่ฆง๏ผˆใƒšใƒผใ‚ธๅŒบๅˆ‡ใ‚Š๏ผ‰", + "description": "ใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚นๅ†…ใฎใ™ในใฆใฎ Vault ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎใ™ในใฆใฎใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚’ๅ–ๅพ—ใ—ใพใ™ใ€‚ใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฏใ€Vault ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎใ‚ขใ‚ปใƒƒใƒˆใงใ™ใ€‚ใ“ใฎใƒกใ‚ฝใƒƒใƒ‰ใ‚’ไฝฟ็”จใ™ใ‚‹ใจใ€ใ™ในใฆใฎใ‚ขใ‚ซใ‚ฆใƒณใƒˆๆฎ‹้ซ˜ใ‚’้ซ˜้€Ÿใซใƒˆใƒฉใƒใƒผใ‚นใงใใพใ™ใ€‚**ๆณจ:** - ใ“ใฎ API ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฏใ€้™ใ‚‰ใ‚ŒใŸใƒฆใƒผใ‚ถใƒผใฎใฟใŒๅˆฉ็”จใงใใพใ™ใ€‚ใ“ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซๆ—ฉๆœŸใ‚ขใ‚ฏใ‚ปใ‚นใ—ใŸใ„ๅ ดๅˆใฏใ€[Fireblocks ใ‚ตใƒใƒผใƒˆ](https://support.fireblocks.io/hc/en-us/requests/new?ticket_form_id=36000337220) ใซใŠๅ•ใ„ๅˆใ‚ใ›ใใ ใ•ใ„ใ€‚ - ใ“ใฎ API ๅ‘ผใณๅ‡บใ—ใซใฏใ€[ใƒฌใƒผใƒˆๅˆถ้™](https://developers.fireblocks.com/reference/rate-limiting) ใŒ้ฉ็”จใ•ใ‚Œใพใ™ใ€‚.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vault_accounts = fireblocks.get_asset_wallets(filters)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAccounts = await fireblocks.getAssetWallets(filters);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "query", + "name": "totalAmountLargerThan", + "description": "ๆŒ‡ๅฎšใ™ใ‚‹ใจใ€ๅˆ่จˆๆฎ‹้ซ˜ใŒใ“ใฎ้‡‘้กใ‚ˆใ‚Šๅคงใใ„่ณ‡็”ฃใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎใฟใŒ่ฟ”ใ•ใ‚Œใพใ™ใ€‚.", + "required": false, + "schema": { + "type": "number" + } + }, + { + "in": "query", + "name": "assetId", + "required": false, + "description": "ๆŒ‡ๅฎšใ™ใ‚‹ใจใ€ใ“ใฎ่ณ‡็”ฃIDใ‚’ๆŒใคVaultใ‚ขใ‚ซใ‚ฆใƒณใƒˆ้–“ใฎ่ณ‡็”ฃใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎใฟใŒ่ฟ”ใ•ใ‚Œใพใ™ใ€‚.", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + }, + { + "in": "query", + "name": "before", + "required": false, + "description": "ใ“ใฎ่ฆ็ด ใฎๅ‰ใฎๆฌกใฎใƒšใƒผใ‚ธๅŒบๅˆ‡ใ‚Šใฎใƒฌใ‚นใƒใƒณใ‚นใ‚’ๅ–ๅพ—ใ—ใพใ™ใ€‚ใ“ใฎ่ฆ็ด ใฏใ‚ซใƒผใ‚ฝใƒซใงใ‚ใ‚Šใ€ๅ‰ใฎใƒšใƒผใ‚ธใฎใƒฌใ‚นใƒใƒณใ‚นใง่ฟ”ใ•ใ‚Œใพใ™ใ€‚.", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "after", + "required": false, + "description": "ใ“ใฎ่ฆ็ด ใฎๆฌกใฎใƒšใƒผใ‚ธๅŒบๅˆ‡ใ‚Šใฎใƒฌใ‚นใƒใƒณใ‚นใ‚’ๅ–ๅพ—ใ—ใพใ™ใ€‚ใ“ใฎ่ฆ็ด ใฏใ‚ซใƒผใ‚ฝใƒซใงใ‚ใ‚Šใ€ๅ‰ใฎใƒšใƒผใ‚ธใฎใƒฌใ‚นใƒใƒณใ‚นใง่ฟ”ใ•ใ‚Œใพใ™ใ€‚.", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "limit", + "required": false, + "description": "1ๅ›žใฎใƒฌใ‚นใƒใƒณใ‚นใงๆ‰ฑใˆใ‚‹่ณ‡็”ฃใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎๆœ€ๅคงๆ•ฐใ€‚ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใฏ200ใ€ๆœ€ๅคงๅ€คใฏ1000ใงใ™ใ€‚.", + "schema": { + "type": "number", + "minimum": 1, + "maximum": 1000, + "default": 200 + } + } + ], + "responses": { + "200": { + "description": "PaginatedAssetWalletResponse ใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PaginatedAssetWalletResponse" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/hide": { + "post": { + "summary": "ใ‚ณใƒณใ‚ฝใƒผใƒซใงVaultใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’้ž่กจ็คบใซใ™ใ‚‹", + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸ Vault ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’ Web ใ‚ณใƒณใ‚ฝใƒผใƒซ ใƒ“ใƒฅใƒผใ‹ใ‚‰้ž่กจ็คบใซใ—ใพใ™.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAsset = fireblocks.hide_vault_account(vault_account_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAsset = await fireblocks.hideVaultAccount(vaultAccountId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "้š ใ™ใŸใ‚ใฎ้‡‘ๅบซใ‚ขใ‚ซใ‚ฆใƒณใƒˆ", + "schema": { + "type": "string", + "minimum": 1, + "format": "numeric", + "x-fb-entity": "vault_account" + } + } + ], + "responses": { + "201": { + "description": "ใ‚ใ‹ใ‚Šใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/unhide": { + "post": { + "summary": "ใ‚ณใƒณใ‚ฝใƒผใƒซใง Vault ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’่กจ็คบใ™ใ‚‹", + "description": "้ž่กจ็คบใฎ Vault ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’ Web ใ‚ณใƒณใ‚ฝใƒผใƒซ ใƒ“ใƒฅใƒผใง่กจ็คบใ—ใพใ™.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAsset = fireblocks.unhide_vault_account(vault_account_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAsset = await fireblocks.unhideVaultAccount(vaultAccountId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "้ž่กจ็คบใ‚’่งฃ้™คใ™ใ‚‹Vaultใ‚ขใ‚ซใ‚ฆใƒณใƒˆ", + "schema": { + "type": "string", + "minimum": 1, + "format": "numeric", + "x-fb-entity": "vault_account" + } + } + ], + "responses": { + "201": { + "description": "ใ‚ใ‹ใ‚Šใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/activate": { + "post": { + "summary": "้‡‘ๅบซใ‚ขใ‚ซใ‚ฆใƒณใƒˆใงใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚’ๆœ‰ๅŠนๅŒ–ใ™ใ‚‹", + "description": "้‡‘ๅบซใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎใ‚ขใ‚ฏใƒ†ใ‚ฃใƒ™ใƒผใ‚ทใƒงใƒณใ‚’้–‹ๅง‹ใ—ใพใ™.", + "tags": [ + "Vaults" + ], + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "่ฟ”ใ•ใ‚Œใ‚‹ใƒœใƒผใƒซใƒˆ ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎ IDใ€ใพใŸใฏใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใฎใƒœใƒผใƒซใƒˆ ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎๅ ดๅˆใฏใ€Œdefaultใ€", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "่ณ‡็”ฃใฎID", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "ใ‚ใ‹ใ‚Šใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateVaultAssetResponse" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/set_customer_ref_id": { + "post": { + "summary": "้‡‘ๅบซใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎAML/KYT้กงๅฎขๅ‚็…งIDใ‚’่จญๅฎšใ™ใ‚‹", + "description": "้‡‘ๅบซใ‚ขใ‚ซใ‚ฆใƒณใƒˆใซAML/KYT้กงๅฎขๅ‚็…งIDใ‚’ๅ‰ฒใ‚Šๅฝ“ใฆใพใ™.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAsset = fireblocks.set_vault_account_customer_ref_id(vault_account_id, customer_ref_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAsset = await fireblocks.setCustomerRefIdForVaultAccount(vaultAccountId, customerRefId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "ใƒœใƒผใƒซใƒˆใ‚ขใ‚ซใ‚ฆใƒณใƒˆID", + "schema": { + "type": "string", + "minimum": 1, + "format": "numeric", + "x-fb-entity": "vault_account" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "customerRefId": { + "description": "้กงๅฎขๅ‚็…งID", + "type": "string" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "ใ‚ใ‹ใ‚Šใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/set_auto_fuel": { + "post": { + "summary": "่‡ชๅ‹•็ตฆๆฒนใ‚’ใ‚ชใƒณใพใŸใฏใ‚ชใƒ•ใซใ™ใ‚‹", + "description": "ใƒœใƒผใƒซใƒˆใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎ่‡ชๅ‹•็‡ƒๆ–™ไพ›็ตฆใƒ—ใƒญใƒ‘ใƒ†ใ‚ฃใ‚’ๆœ‰ๅŠนใพใŸใฏ็„กๅŠนใซ่จญๅฎšใ—ใพใ™.", + "tags": [ + "Vaults" + ], + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "ใƒœใƒผใƒซใƒˆใ‚ขใ‚ซใ‚ฆใƒณใƒˆID", + "schema": { + "type": "string", + "minimum": 1, + "format": "numeric", + "x-fb-entity": "vault_account" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "autoFuel": { + "description": "่‡ชๅ‹•่ปŠ็‡ƒๆ–™", + "type": "boolean" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "ใ‚ใ‹ใ‚Šใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}": { + "get": { + "summary": "้‡‘ๅบซใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎ่ณ‡็”ฃๆฎ‹้ซ˜ใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "description": "ใƒœใƒผใƒซใƒˆใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎ็‰นๅฎšใฎ่ณ‡็”ฃใฎใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚’่ฟ”ใ—ใพใ™.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAsset = fireblocks.get_vault_account_asset(vault_account_id, asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAsset = await fireblocks.getVaultAccountAsset(vaultAccountId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "่ฟ”ใ•ใ‚Œใ‚‹ใƒœใƒผใƒซใƒˆใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎID", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "่ณ‡็”ฃใฎID", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "VaultAsset ใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/VaultAsset" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "ๆ–ฐใ—ใ„ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚’ไฝœๆˆใ™ใ‚‹", + "description": "็‰นๅฎšใฎ่ณ‡็”ฃ็”จใฎใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚’Vaultใ‚ขใ‚ซใ‚ฆใƒณใƒˆใซไฝœๆˆใ—ใพใ™.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAsset = fireblocks.create_vault_asset(vault_account_id, asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAsset = await fireblocks.createVaultAsset(vaultAccountId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "่ฟ”ใ•ใ‚Œใ‚‹ใƒœใƒผใƒซใƒˆ ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎ IDใ€ใพใŸใฏใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใฎใƒœใƒผใƒซใƒˆ ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎๅ ดๅˆใฏใ€Œdefaultใ€", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "่ณ‡็”ฃใฎID", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "eosAccountName": { + "description": "ใ‚ชใƒ—ใ‚ทใƒงใƒณ - EOSใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚’ไฝœๆˆใ™ใ‚‹ใจใใฎใ‚ขใ‚ซใ‚ฆใƒณใƒˆๅใ€‚ๆŒ‡ๅฎšใ—ใชใ„ๅ ดๅˆใฏใƒฉใƒณใƒ€ใƒ ใชๅๅ‰ใŒ็”Ÿๆˆใ•ใ‚Œใพใ™", + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "ใ‚ใ‹ใ‚Šใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateVaultAssetResponse" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/balance": { + "post": { + "summary": "่ณ‡็”ฃๆฎ‹้ซ˜ใƒ‡ใƒผใ‚ฟใฎๆ›ดๆ–ฐ", + "description": "้‡‘ๅบซใ‚ขใ‚ซใ‚ฆใƒณใƒˆๅ†…ใฎ็‰นๅฎšใฎ่ณ‡็”ฃใฎๆฎ‹้ซ˜ใ‚’ๆ›ดๆ–ฐใ—ใพใ™.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAsset = fireblocks.refresh_vault_asset_balance(vault_account_id, asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAsset = await fireblocks.refreshVaultAssetBalance(vaultAccountId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "่ฟ”ใ•ใ‚Œใ‚‹ใƒœใƒผใƒซใƒˆใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎID", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "่ณ‡็”ฃใฎID", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "requestBody": { + "required": false, + "content": { + "*/*": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "VaultAsset ใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/VaultAsset" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/addresses": { + "get": { + "summary": "่ณ‡็”ฃใ‚ขใƒ‰ใƒฌใ‚นใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "description": "ใƒœใƒผใƒซใƒˆใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎ็‰นๅฎšใฎ่ณ‡็”ฃใฎใ™ในใฆใฎใ‚ขใƒ‰ใƒฌใ‚นใ‚’ไธ€่ฆง่กจ็คบใ—ใพใ™.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "depositAddresses = fireblocks.get_deposit_addresses(vault_account_id, asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const depositAddresses = await fireblocks.getDepositAddresses(vaultAccountId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "่ฟ”ใ•ใ‚Œใ‚‹ใƒœใƒผใƒซใƒˆใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎID", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "่ณ‡็”ฃใฎID", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "ๅ…ฅ้‡‘ๅ…ˆใƒชใ‚นใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VaultWalletAddress" + } + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "ๆ–ฐใ—ใ„่ณ‡็”ฃ้ ๅ…ฅใ‚ขใƒ‰ใƒฌใ‚นใ‚’ไฝœๆˆใ™ใ‚‹", + "description": "้‡‘ๅบซใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎ่ณ‡็”ฃใฎๆ–ฐใ—ใ„ๅ…ฅ้‡‘ใ‚ขใƒ‰ใƒฌใ‚นใ‚’ไฝœๆˆใ—ใพใ™.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "address = fireblocks.generate_new_address(vault_account_id, asset_id, description, customer_ref_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const address = await fireblocks.generateNewAddress(vaultAccountId, assetId, description, customerRefId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "description": { + "description": "๏ผˆใ‚ชใƒ—ใ‚ทใƒงใƒณ๏ผ‰ๆ–ฐใ—ใ„ไฝๆ‰€ใซ่ชฌๆ˜Žใ‚’ๆทปไป˜ใ™ใ‚‹", + "type": "string" + }, + "customerRefId": { + "description": "ใ‚ชใƒ—ใ‚ทใƒงใƒณ - ้กงๅฎขๅ‚็…งIDใ‚’่จญๅฎšใ—ใพใ™", + "type": "string" + } + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "่ฟ”ใ•ใ‚Œใ‚‹ใƒœใƒผใƒซใƒˆใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎID", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "่ณ‡็”ฃใฎID", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "ไฝœๆˆใ•ใ‚ŒใŸใ‚ขใƒ‰ใƒฌใ‚น", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateAddressResponse" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/max_spendable_amount": { + "get": { + "summary": "1ๅ›žใฎๅ–ๅผ•ใงๆœ€ๅคง้™ใซไฝฟใˆใ‚‹้‡‘้กใ‚’ๅ–ๅพ—ใ™ใ‚‹.", + "description": "ๆŒ‡ๅฎšใ•ใ‚ŒใŸ้‡‘ๅบซใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‹ใ‚‰ใ€1ๅ›žใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใงไฝฟ็”จใงใใ‚‹็‰นๅฎšใฎ่ณ‡็”ฃใฎๆœ€ๅคง้กใ‚’ๅ–ๅพ—ใ—ใพใ™๏ผˆUTXO่ณ‡็”ฃใฎใฟใ€ๅŸ‹ใ‚่พผใพใ‚ŒใŸๅ…ฅๅŠ›ใฎๆ•ฐใซๅˆถ้™ใŒใ‚ใ‚Šใพใ™๏ผ‰ใ€‚ๆœ€ๅคงไฝฟ็”จๅฏ่ƒฝ้กใ‚’่ถ…ใˆใฆไฝฟ็”จใ—ใŸใ„ๅ ดๅˆใฏใ€่ค‡ๆ•ฐใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚’้€ไฟกใ—ใพใ™ใ€‚.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "address = fireblocks.set_address_description(vault_account_id, asset_id, address, tag, description)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const address = await fireblocks.setAddressDescription(vaultAccountId, assetId, address, tag, description);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "ใƒœใƒผใƒซใƒˆ ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎ IDใ€ใพใŸใฏใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใฎใƒœใƒผใƒซใƒˆ ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎๅ ดๅˆใฏใ€Œdefaultใ€", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "่ณ‡็”ฃใฎID", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + }, + { + "in": "query", + "name": "manualSignging", + "required": false, + "description": "ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใงใฏFalseใงใ™ใ€‚ๅ…ฅๅŠ›ใฎๆœ€ๅคงๆ•ฐใฏใ€ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใŒ่‡ชๅ‹•็ฝฒๅ่€…ใ‚ตใƒผใƒใƒผใซใ‚ˆใฃใฆ็ฝฒๅใ•ใ‚Œใ‚‹ใ‹ใ€ใƒขใƒใ‚คใƒซใƒ‡ใƒใ‚คใ‚นใง็ฝฒๅใ•ใ‚Œใ‚‹ใ‹ใซใ‚ˆใฃใฆ็•ฐใชใ‚Šใพใ™ใ€‚.", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "ใ‚ใ‹ใ‚Šใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}": { + "put": { + "summary": "ไฝๆ‰€ใฎ่ชฌๆ˜Žใ‚’ๆ›ดๆ–ฐ", + "description": "ใƒœใƒผใƒซใƒˆใ‚ขใ‚ซใ‚ฆใƒณใƒˆๅ†…ใฎ่ณ‡็”ฃใฎๆ—ขๅญ˜ใฎใ‚ขใƒ‰ใƒฌใ‚นใฎ่ชฌๆ˜Žใ‚’ๆ›ดๆ–ฐใ—ใพใ™.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "address = fireblocks.set_address_description(vault_account_id, asset_id, address, tag, description)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const address = await fireblocks.setAddressDescription(vaultAccountId, assetId, address, tag, description);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "description": { + "description": "ไฝๆ‰€ใฎ่ชฌๆ˜Ž", + "type": "string" + } + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "ใƒœใƒผใƒซใƒˆใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎID", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "่ณ‡็”ฃใฎID", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + }, + { + "in": "path", + "name": "addressId", + "required": true, + "description": "่ชฌๆ˜Žใ‚’่ฟฝๅŠ ใ™ใ‚‹ใ‚ขใƒ‰ใƒฌใ‚นใ€‚XRPใฎๅ ดๅˆใฏใ€
:ใใฎไป–ใฎ่ณ‡็”ฃใซใคใ„ใฆใฏใ€ใ‚ขใƒ‰ใƒฌใ‚นใฎใฟใ‚’ไฝฟ็”จใ—ใฆใใ ใ•ใ„", + "schema": { + "type": "string" + } + } + ], + "responses": { + "201": { + "description": "ใ‚ใ‹ใ‚Šใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/set_customer_ref_id": { + "post": { + "summary": "AML้กงๅฎขๅ‚็…งIDใ‚’ๅ‰ฒใ‚Šๅฝ“ใฆใ‚‹", + "description": "็‰นๅฎšใฎไฝๆ‰€ใฎAML/KYT้กงๅฎขๅ‚็…งIDใ‚’่จญๅฎšใ—ใพใ™.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAsset = fireblocks.set_customer_ref_id_for_address(vault_account_id, asset_id, address_id, customer_ref_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAsset = await fireblocks.setCustomerRefIdForAddress(vaultAccountId, assetId, addressId, customerRefId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "ใƒœใƒผใƒซใƒˆใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎID", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "่ณ‡็”ฃใฎID", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + }, + { + "in": "path", + "name": "addressId", + "required": true, + "description": "่ชฌๆ˜Žใ‚’่ฟฝๅŠ ใ™ใ‚‹ใ‚ขใƒ‰ใƒฌใ‚นใ€‚XRPใฎๅ ดๅˆใฏใ€
:ใใฎไป–ใฎ่ณ‡็”ฃใซใคใ„ใฆใฏใ€ใ‚ขใƒ‰ใƒฌใ‚นใฎใฟใ‚’ไฝฟ็”จใ—ใฆใใ ใ•ใ„", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "customerRefId": { + "description": "้กงๅฎขๅ‚็…งID", + "type": "string" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "ใ‚ใ‹ใ‚Šใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/create_legacy": { + "post": { + "summary": "Segwit ใ‚ขใƒ‰ใƒฌใ‚นใ‚’ใƒฌใ‚ฌใ‚ทใƒผๅฝขๅผใซๅค‰ๆ›ใ™ใ‚‹", + "description": "ๆ—ขๅญ˜ใฎsegwitใ‚ขใƒ‰ใƒฌใ‚นใ‚’ๅพ“ๆฅใฎๅฝขๅผใซๅค‰ๆ›ใ—ใพใ™.", + "tags": [ + "Vaults" + ], + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "ใƒœใƒผใƒซใƒˆใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎID", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "่ณ‡็”ฃใฎID", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + }, + { + "in": "path", + "name": "addressId", + "required": true, + "description": "ๅค‰ๆ›ใ™ใ‚‹segwitใ‚ขใƒ‰ใƒฌใ‚น", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "ไฝœๆˆใ•ใ‚ŒใŸใ‚ขใƒ‰ใƒฌใ‚น", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateAddressResponse" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/unspent_inputs": { + "get": { + "summary": "UTXOๆœชไฝฟ็”จๅ…ฅๅŠ›ๆƒ…ๅ ฑใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "description": "ใƒœใƒผใƒซใƒˆใ‚ขใ‚ซใ‚ฆใƒณใƒˆๅ†…ใฎ่ณ‡็”ฃใฎๆœชไฝฟ็”จๅ…ฅๅŠ›ๆƒ…ๅ ฑใ‚’่ฟ”ใ—ใพใ™.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAsset = fireblocks.get_unspent_inputs(vault_account_id, asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAsset = await fireblocks.getUnspentInputs(vaultAccountId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "ใƒœใƒผใƒซใƒˆใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎID", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "่ณ‡็”ฃใฎID", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "ๅ…ฅๅŠ›ใ”ใจใฎๆœชไฝฟ็”จๆƒ…ๅ ฑใฎใƒชใ‚นใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UnspentInputsResponse" + } + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/public_key_info/": { + "get": { + "summary": "ๅ…ฌ้–‹้ตๆƒ…ๅ ฑใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "description": "ๅฐŽๅ‡บใƒ‘ใ‚นใจ็ฝฒๅใ‚ขใƒซใ‚ดใƒชใ‚บใƒ ใซๅŸบใฅใ„ใฆๅ…ฌ้–‹้ตๆƒ…ๅ ฑใ‚’ๅ–ๅพ—ใ—ใพใ™.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "pubKey = fireblocks.get_public_key_info(algorithm, derivation_path, compressed)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const PublicKeyInfoArgs = { algorithm: 'MPC_ECDSA_SECP256K1', derivationPath: '[44,0,0,0,0]' } const pubKey = await fireblocks.getPublicKeyInfo(PublicKeyInfoArgs);\n", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "query", + "name": "derivationPath", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "algorithm", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "compressed", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "ๅ…ฌ้–‹้ตๆƒ…ๅ ฑ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PublicKeyInformation" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/{change}/{addressIndex}/public_key_info": { + "get": { + "summary": "ใƒœใƒผใƒซใƒˆใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎๅ…ฌ้–‹้ตใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "description": "ใƒœใƒผใƒซใƒˆใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎๅ…ฌ้–‹้ตๆƒ…ๅ ฑใ‚’ๅ–ๅพ—ใ—ใพใ™.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "pubKey = fireblocks.get_public_key_info_for_vault_account(asset_id, vault_account_id, change, address_index, compressed)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const PublicKeyInfoArgs = { assetId: 'ETH', vaultAccountId: 0, change: 0, addressIndex: 0, compressed: true } const pubKey = await fireblocks.getPublicKeyInfoForVaultAccount(PublicKeyInfoArgs);\n", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + }, + { + "in": "path", + "name": "change", + "required": true, + "schema": { + "type": "number" + } + }, + { + "in": "path", + "name": "addressIndex", + "required": true, + "schema": { + "type": "number" + } + }, + { + "in": "query", + "name": "compressed", + "required": false, + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "ๅ…ฌ้–‹้ตๆƒ…ๅ ฑ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PublicKeyInformation" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/assets": { + "get": { + "summary": "้ธๆŠžใ—ใŸ่ณ‡็”ฃใฎ่ณ‡็”ฃๆฎ‹้ซ˜ใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "description": "ใ™ในใฆใฎใ‚ขใ‚ซใ‚ฆใƒณใƒˆใพใŸใฏใƒ•ใ‚ฃใƒซใ‚ฟใƒชใƒณใ‚ฐใ•ใ‚ŒใŸใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎ่ณ‡็”ฃ้กใฎๆฆ‚่ฆใ‚’ๅ–ๅพ—ใ—ใพใ™.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "assets_balance = fireblocks.get_vault_assets_balance(accout_name_prefix, account_name_suffix)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const assetsBalance = await fireblocks.getVaultAssetsBalance(accountNamePrefix, accountNameSuffix);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "query", + "name": "accountNamePrefix", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "accountNameSuffix", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "่ณ‡็”ฃๅˆฅ้‡‘้ก", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VaultAsset" + } + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/assets/{assetId}": { + "get": { + "summary": "่ณ‡็”ฃๅˆฅใซ้‡‘ๅบซๆฎ‹้ซ˜ใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "description": "่ณ‡็”ฃใฎ้‡‘ๅบซๆฎ‹้ซ˜ใฎๆฆ‚่ฆใ‚’ๅ–ๅพ—ใ—ใพใ™.", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "assets_balance = fireblocks.get_vault_balance_by_asset(asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const assetsBalance = await fireblocks.getVaultBalanceByAsset(assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "assetId", + "required": true, + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "่ณ‡็”ฃๅˆฅใฎ้‡‘ๅบซ้‡‘้ก", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/VaultAsset" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/exchange_accounts": { + "get": { + "summary": "ไบคๆ›ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎไธ€่ฆง", + "description": "ใ™ในใฆใฎไบคๆ›ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’่ฟ”ใ—ใพใ™.", + "tags": [ + "Exchange accounts" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "exchangeAccounts = fireblocks.get_exchange_accounts()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const exchangeAccounts = await fireblocks.getExchangeAccounts();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "ExchangeAccount ใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExchangeAccount" + } + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/exchange_accounts/{exchangeAccountId}": { + "get": { + "summary": "็‰นๅฎšใฎๅ–ๅผ•ๆ‰€ใฎใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’ๆŽขใ™", + "description": "IDใงไบคๆ›ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’่ฟ”ใ—ใพใ™.", + "tags": [ + "Exchange accounts" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "exchangeAccount = fireblocks.get_exchange_account(exchangeAccountId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const exchnageAccount = await fireblocks.get_exchange_account(exchangeAccountId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "exchangeAccountId", + "required": true, + "description": "่ฟ”ใ•ใ‚Œใ‚‹ไบคๆ›ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ExchangeAccount ใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ExchangeAccount" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/exchange_accounts/{exchangeAccountId}/internal_transfer": { + "post": { + "summary": "ไบคๆ›ๅฃๅบงใฎๅ†…้ƒจๆŒฏๆ›ฟ", + "description": "ๅŒใ˜ๅ–ๅผ•ๅฃๅบงๅ†…ใฎๅ–ๅผ•ๅฃๅบง้–“ใง่ณ‡้‡‘ใ‚’็งปๅ‹•ใ—ใพใ™.", + "tags": [ + "Exchange accounts" + ], + "parameters": [ + { + "in": "path", + "name": "exchangeAccountId", + "required": true, + "description": "่ฟ”ใ•ใ‚Œใ‚‹ไบคๆ›ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "201": { + "description": "่ปข้€ใซๆˆๅŠŸใ—ใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "asset": { + "type": "string" + }, + "amount": { + "type": "string" + }, + "sourceType": { + "$ref": "#/components/schemas/TradingAccountType" + }, + "destType": { + "$ref": "#/components/schemas/TradingAccountType" + } + } + } + } + } + } + } + }, + "/exchange_accounts/{exchangeAccountId}/convert": { + "post": { + "summary": "ไบคๆ›ๅฃๅบงใฎ่ณ‡้‡‘ใ‚’ใ‚ฝใƒผใ‚น่ณ‡็”ฃใ‹ใ‚‰ๅฎ›ๅ…ˆ่ณ‡็”ฃใซๅค‰ๆ›ใ—ใพใ™ใ€‚Coinbase๏ผˆUSDใ‹ใ‚‰USDCใ€USDCใ‹ใ‚‰USD๏ผ‰ใจBitso๏ผˆMXNใ‹ใ‚‰USD๏ผ‰ใŒใ‚ตใƒใƒผใƒˆใ•ใ‚Œใฆใ„ใ‚‹ๅค‰ๆ›ใงใ™ใ€‚.", + "tags": [ + "Exchange accounts" + ], + "parameters": [ + { + "in": "path", + "name": "exchangeAccountId", + "required": true, + "description": "ๅ–ๅผ•ๆ‰€ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎIDใ€‚ๅ–ๅผ•ๆ‰€ใŒๅค‰ๆ›ใ‚’ใ‚ตใƒใƒผใƒˆใ—ใฆใ„ใ‚‹ใ“ใจใ‚’็ขบ่ชใ—ใฆใใ ใ•ใ„ใ€‚ๅ–ๅผ•ๆ‰€ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎIDใ‚’่ฆ‹ใคใ‘ใ‚‹ใซใฏใ€GET/exchange_accountsใ‚’ไฝฟ็”จใ—ใพใ™ใ€‚.", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ๅค‰ๆ›ใซๆˆๅŠŸใ—ใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "srcAsset": { + "type": "string", + "description": "ใ‚ฝใƒผใ‚น่ณ‡็”ฃใฎๅๅ‰๏ผˆๅ–ๅผ•ๆ‰€ ID ใซๅฏพๅฟœใ™ใ‚‹้ธๆŠžใ—ใŸๅ–ๅผ•ๆ‰€ใ‚ฟใ‚คใƒ—ใงๅค‰ๆ›ใŒใ‚ตใƒใƒผใƒˆใ•ใ‚Œใฆใ„ใ‚‹้€š่ฒจใงใ‚ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™๏ผ‰" + }, + "destAsset": { + "type": "string", + "description": "ๅฎ›ๅ…ˆ่ณ‡็”ฃใฎๅๅ‰๏ผˆไบคๆ› ID ใซๅฏพๅฟœใ™ใ‚‹้ธๆŠžใ—ใŸไบคๆ›ใ‚ฟใ‚คใƒ—ใงๅค‰ๆ›ใŒใ‚ตใƒใƒผใƒˆใ•ใ‚Œใฆใ„ใ‚‹้€š่ฒจใงใ‚ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™๏ผ‰" + }, + "amount": { + "type": "number", + "description": "้€้‡‘ใ™ใ‚‹้‡‘้ก๏ผˆ้€้‡‘ๅ…ƒ่ณ‡็”ฃใฎ้€š่ฒจ๏ผ‰" + } + }, + "required": [ + "srcAsset", + "destAsset", + "amount" + ] + } + } + } + } + } + }, + "/exchange_accounts/{exchangeAccountId}/{assetId}": { + "get": { + "summary": "ไบคๆ›ๅฃๅบงใฎ่ณ‡็”ฃใ‚’ๆŽขใ™", + "description": "ไบคๆ›ๅฃๅบงใฎ่ณ‡็”ฃใ‚’่ฟ”ใ™.", + "tags": [ + "Exchange accounts" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "exchangeAsset = fireblocks.get_exchange_account_asset(exchangeAccountId, assetId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const exchangeAsset = await fireblocks.getExchangeAsset(exchangeAccountId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "exchangeAccountId", + "required": true, + "description": "่ฟ”ใ•ใ‚Œใ‚‹ไบคๆ›ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "่ฟ”ใ•ใ‚Œใ‚‹่ณ‡็”ฃใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ExchangeAccountAsset ใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ExchangeAsset" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/fiat_accounts": { + "get": { + "summary": "ๆณ•ๅฎš้€š่ฒจๅฃๅบงใ‚’ไธ€่ฆง่กจ็คบใ™ใ‚‹", + "description": "ใ™ในใฆใฎๆณ•ๅฎš้€š่ฒจๅฃๅบงใ‚’่ฟ”ใ™.", + "tags": [ + "Fiat accounts" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "transactions = fireblocks.get_fiat_accounts()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const transactions = await fireblocks.getFiatAccounts();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "ๆณ•ๅฎš้€š่ฒจใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FiatAccount" + } + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/fiat_accounts/{accountId}": { + "get": { + "summary": "็‰นๅฎšใฎๆณ•ๅฎš้€š่ฒจๅฃๅบงใ‚’ๆŽขใ™", + "description": "IDใงๆณ•ๅฎš้€š่ฒจใฎๅฃๅบงใ‚’่ฟ”ใ—ใพใ™.", + "tags": [ + "Fiat accounts" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "transactions = fireblocks.get_fiat_account_by_id(account_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const transactions = await fireblocks.getFiatAccountById(accountId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "accountId", + "required": true, + "description": "่ฟ”ใ•ใ‚Œใ‚‹ๆณ•ๅฎš้€š่ฒจๅฃๅบงใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ๆณ•ๅฎš้€š่ฒจใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/FiatAccount" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/fiat_accounts/{accountId}/redeem_to_linked_dda": { + "post": { + "summary": "DDAใธใฎ่ณ‡้‡‘ใฎๅผ•ใๆ›ใˆ", + "description": "ใƒชใƒณใ‚ฏใ•ใ‚ŒใŸDDAใซ่ณ‡้‡‘ใ‚’ๅ„Ÿ้‚„ใ™ใ‚‹.", + "tags": [ + "Fiat accounts" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "transactions = fireblocks.redeem_to_linked_dda(account_id, amount)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const transactions = await fireblocks.redeemToLinkedDDA(accountId, amount);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "accountId", + "required": true, + "description": "ไฝฟ็”จใ™ใ‚‹ๆณ•ๅฎš้€š่ฒจๅฃๅบงใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "201": { + "description": "่ปข้€ใซๆˆๅŠŸใ—ใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "amount": { + "type": "number" + } + } + } + } + } + } + } + }, + "/fiat_accounts/{accountId}/deposit_from_linked_dda": { + "post": { + "summary": "DDAใ‹ใ‚‰ใฎๅ…ฅ้‡‘", + "description": "ใƒชใƒณใ‚ฏใ•ใ‚ŒใŸDDAใ‹ใ‚‰่ณ‡้‡‘ใ‚’ๅ…ฅ้‡‘ใ™ใ‚‹.", + "tags": [ + "Fiat accounts" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "transactions = fireblocks.deposit_from_linked_dda(account_id, amount)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const transactions = await fireblocks.depositFromLinkedDDA(accountId, amount);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "accountId", + "required": true, + "description": "ไฝฟ็”จใ™ใ‚‹ๆณ•ๅฎš้€š่ฒจๅฃๅบงใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "201": { + "description": "่ปข้€ใซๆˆๅŠŸใ—ใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "amount": { + "type": "number" + } + } + } + } + } + } + } + }, + "/network_connections": { + "get": { + "summary": "ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถšใ‚’ไธ€่ฆง่กจ็คบใ™ใ‚‹", + "description": "ใ™ในใฆใฎใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถšใ‚’่ฟ”ใ—ใพใ™ใ€‚**ๆณจ:** ใ“ใฎ API ๅ‘ผใณๅ‡บใ—ใฏใ€ๆŸ”่ปŸใชใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใ‚นใ‚ญใƒผใƒ ใฎๅฏพ่ฑกใงใ™ใ€‚ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใƒใƒชใ‚ทใƒผใซใ‚ˆใฃใฆใ€ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐๆ–นๆณ•ใŒๅฎš็พฉใ•ใ‚Œใพใ™ใ€‚ๅ„ใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใซๅฏพใ—ใฆใ€ไปฅไธ‹ใฎ 3 ใคใฎ็•ฐใชใ‚‹ใ‚นใ‚ญใƒผใƒ ใฎใ„ใšใ‚Œใ‹ใ‚’้ธๆŠžใงใใพใ™ใ€‚- **ใชใ—**; ใใฎใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใซๅฏพใ—ใฆใ€ๅฎ›ๅ…ˆใฎใชใ„ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ‚’ๅฎš็พฉใ—ใพใ™ใ€‚`ใชใ—` ใซใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ•ใ‚ŒใŸใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใธใฎ็€ไฟกใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏๅคฑๆ•—ใ—ใพใ™ใ€‚- **ใ‚ซใ‚นใ‚ฟใƒ **; ้ธๆŠžใ—ใŸใ‚ขใ‚ซใ‚ฆใƒณใƒˆใซใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ—ใพใ™ใ€‚ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’ๅ‰Š้™คใ™ใ‚‹ใจใ€ๅˆฅใฎใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’้ธๆŠžใ™ใ‚‹ใพใง็€ไฟกใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏๅคฑๆ•—ใ—ใพใ™ใ€‚- **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ**; ๆŽฅ็ถšใŒๆŽฅ็ถšใ•ใ‚Œใฆใ„ใ‚‹ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซใงๆŒ‡ๅฎšใ•ใ‚ŒใŸใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ‚’ไฝฟ็”จใ—ใพใ™ใ€‚ใ“ใฎใ‚นใ‚ญใƒผใƒ ใฏใ€ใ€Œใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ€ใจใ‚‚ๅ‘ผใฐใ‚Œใพใ™ใ€‚ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใฎใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚น ใƒ—ใƒชใ‚ปใƒƒใƒˆ: - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซๆš—ๅท โ†’ **ใ‚ซใ‚นใ‚ฟใƒ ** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ FIAT โ†’ **ใชใ—** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถšๆš—ๅท โ†’ **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถš FIAT โ†’ **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ** - **ๆณจ**: ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใงใฏใ€ใ‚ซใ‚นใ‚ฟใƒ  ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใ‚นใ‚ญใƒผใƒ ใฏ (`dstId` = `0`ใ€`dstType` = `VAULT`) ใ‚’ไฝฟ็”จใ—ใพใ™ใ€‚.", + "tags": [ + "Network connections" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "network_connections = fireblocks.get_network_connections()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const networkConnections = await fireblocks.getNetworkConnections();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถšใฎใƒชใ‚นใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkConnectionResponse" + } + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "ๆ–ฐใ—ใ„ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถšใ‚’ไฝœๆˆใ—ใพใ™", + "description": "ๆ–ฐใ—ใ„ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถšใ‚’้–‹ๅง‹ใ—ใพใ™ใ€‚**ๆณจ:** ใ“ใฎ API ๅ‘ผใณๅ‡บใ—ใฏใ€ๆŸ”่ปŸใชใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใ‚นใ‚ญใƒผใƒ ใฎๅฏพ่ฑกใงใ™ใ€‚ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใƒใƒชใ‚ทใƒผใซใ‚ˆใฃใฆใ€ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐๆ–นๆณ•ใŒๅฎš็พฉใ•ใ‚Œใพใ™ใ€‚ๅ„ใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใซๅฏพใ—ใฆใ€ไปฅไธ‹ใซ็คบใ™ 3 ใคใฎ็•ฐใชใ‚‹ใ‚นใ‚ญใƒผใƒ ใฎใ„ใšใ‚Œใ‹ใ‚’้ธๆŠžใงใใพใ™ใ€‚- **ใชใ—**; ใใฎใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใซๅฏพใ—ใฆใ€ๅฎ›ๅ…ˆใฎใชใ„ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ‚’ๅฎš็พฉใ—ใพใ™ใ€‚`ใชใ—` ใซใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ•ใ‚ŒใŸใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใธใฎๅ—ไฟกใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏๅคฑๆ•—ใ—ใพใ™ใ€‚- **ใ‚ซใ‚นใ‚ฟใƒ **; ้ธๆŠžใ—ใŸใ‚ขใ‚ซใ‚ฆใƒณใƒˆใซใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ—ใพใ™ใ€‚ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’ๅ‰Š้™คใ™ใ‚‹ใจใ€ๅˆฅใฎใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’้ธๆŠžใ™ใ‚‹ใพใงๅ—ไฟกใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏๅคฑๆ•—ใ—ใพใ™ใ€‚- **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ**; ๆŽฅ็ถšๅ…ˆใฎใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซใงๆŒ‡ๅฎšใ•ใ‚ŒใŸใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ‚’ไฝฟ็”จใ—ใพใ™ใ€‚ใ“ใฎใ‚นใ‚ญใƒผใƒ ใฏใ€ใ€Œใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ€ใจใ‚‚ๅ‘ผใฐใ‚Œใพใ™ใ€‚ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใฎใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚น ใƒ—ใƒชใ‚ปใƒƒใƒˆ: - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ๆš—ๅท โ†’ **ใ‚ซใ‚นใ‚ฟใƒ ** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ FIAT โ†’ **ใชใ—** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถš ๆš—ๅท โ†’ **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถš FIAT โ†’ **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ** - **ๆณจ**: ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใงใฏใ€ใ‚ซใ‚นใ‚ฟใƒ  ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใ‚นใ‚ญใƒผใƒ ใฏ (`dstId` = `0`ใ€`dstType` = `VAULT`) ใ‚’ไฝฟ็”จใ—ใพใ™ใ€‚.", + "tags": [ + "Network connections" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NetworkConnection" + } + } + } + }, + "responses": { + "201": { + "description": "ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถšใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/NetworkConnectionResponse" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/network_connections/{connectionId}/set_routing_policy": { + "patch": { + "summary": "ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถšใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใƒใƒชใ‚ทใƒผใ‚’ๆ›ดๆ–ฐใ™ใ‚‹.", + "description": "ๆ—ขๅญ˜ใฎใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถšใฎใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใƒใƒชใ‚ทใƒผใ‚’ๆ›ดๆ–ฐใ—ใพใ™ใ€‚**ๆณจ:** ใ“ใฎ API ๅ‘ผใณๅ‡บใ—ใฏใ€ๆŸ”่ปŸใชใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใ‚นใ‚ญใƒผใƒ ใฎๅฏพ่ฑกใจใชใ‚Šใพใ™ใ€‚ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใƒใƒชใ‚ทใƒผใซใ‚ˆใฃใฆใ€ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐๆ–นๆณ•ใŒๅฎš็พฉใ•ใ‚Œใพใ™ใ€‚ๅ„ใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใซๅฏพใ—ใฆใ€ไปฅไธ‹ใฎ 3 ใคใฎ็•ฐใชใ‚‹ใ‚นใ‚ญใƒผใƒ ใ‹ใ‚‰ 1 ใคใ‚’้ธๆŠžใงใใพใ™ใ€‚- **ใชใ—**; ใใฎใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใซๅฏพใ—ใฆใ€ๅฎ›ๅ…ˆใฎใชใ„ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ‚’ๅฎš็พฉใ—ใพใ™ใ€‚`ใชใ—` ใซใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ•ใ‚ŒใŸใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใธใฎๅ—ไฟกใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏๅคฑๆ•—ใ—ใพใ™ใ€‚- **ใ‚ซใ‚นใ‚ฟใƒ **; ้ธๆŠžใ—ใŸใ‚ขใ‚ซใ‚ฆใƒณใƒˆใซใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ—ใพใ™ใ€‚ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’ๅ‰Š้™คใ™ใ‚‹ใจใ€ๅˆฅใฎใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’้ธๆŠžใ™ใ‚‹ใพใงๅ—ไฟกใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏๅคฑๆ•—ใ—ใพใ™ใ€‚- **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ**; ๆŽฅ็ถšใŒๆŽฅ็ถšใ•ใ‚Œใฆใ„ใ‚‹ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซใงๆŒ‡ๅฎšใ•ใ‚ŒใŸใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ‚’ไฝฟ็”จใ—ใพใ™ใ€‚ใ“ใฎใ‚นใ‚ญใƒผใƒ ใฏใ€ใ€Œใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ€ใจใ‚‚ๅ‘ผใฐใ‚Œใพใ™ใ€‚ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใฎใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚น ใƒ—ใƒชใ‚ปใƒƒใƒˆ: - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ๆš—ๅท โ†’ **ใ‚ซใ‚นใ‚ฟใƒ ** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ FIAT โ†’ **ใชใ—** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถš ๆš—ๅท โ†’ **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถš FIAT โ†’ **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ** - **ๆณจ**: ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใงใฏใ€ใ‚ซใ‚นใ‚ฟใƒ  ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใ‚นใ‚ญใƒผใƒ ใฏ (`dstId` = `0`ใ€`dstType` = `VAULT`) ใ‚’ไฝฟ็”จใ—ใพใ™ใ€‚.", + "tags": [ + "Network connections" + ], + "parameters": [ + { + "in": "path", + "name": "connectionId", + "required": true, + "description": "ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถšใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "routingPolicy": { + "$ref": "#/components/schemas/NetworkConnectionRoutingPolicy" + } + }, + "required": [ + "routingPolicy" + ] + } + } + } + }, + "responses": { + "200": { + "description": "ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏID", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "properties": { + "success": { + "type": "boolean" + } + }, + "required": [ + "success" + ] + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/network_connections/{connectionId}/is_third_party_routing/{assetType}": { + "get": { + "summary": "่ณ‡็”ฃใ‚ฟใ‚คใƒ—ๅˆฅใซใ‚ตใƒผใƒ‰ใƒ‘ใƒผใƒ†ใ‚ฃใฎใƒใƒƒใƒˆใƒฏใƒผใ‚ฏใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐๆคœ่จผใ‚’ๅ–ๅพ—ใ™ใ‚‹.", + "description": "Fireblocksใƒใƒƒใƒˆใƒฏใƒผใ‚ฏใฏใ€ๅ…ฅ้‡‘ใซ้–ขใ™ใ‚‹ๆŸ”่ปŸๆ€งใ‚’ๆไพ›ใ—ใพใ™ใ€‚ๅ—ไฟก่€…ใฏใ€Fireblocksไปฅๅค–ใฎๅ ดๆ‰€ใธใฎใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๅ…ฅ้‡‘ใ‚’ๅ—ใ‘ๅ–ใ‚‹ใ“ใจใŒใงใใพใ™ใ€‚ใ“ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฏใ€ๅฐ†ๆฅใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใŒ่กจ็คบใ•ใ‚ŒใŸๅ—ไฟก่€…ใซใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ•ใ‚Œใ‚‹ใ‹ใ€ใ‚ตใƒผใƒ‰ใƒ‘ใƒผใƒ†ใ‚ฃใซใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ•ใ‚Œใ‚‹ใ‹ใ‚’ๆคœ่จผใ—ใพใ™ใ€‚.", + "tags": [ + "Network connections" + ], + "parameters": [ + { + "in": "path", + "name": "connectionId", + "required": true, + "description": "ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถšใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + }, + { + "in": "path", + "name": "assetType", + "required": true, + "description": "ๅฎ›ๅ…ˆ่ณ‡็”ฃใ‚ฟใ‚คใƒ—", + "schema": { + "oneOf": [ + { + "const": "CRYPTO" + }, + { + "const": "SIGNET" + }, + { + "const": "SEN" + }, + { + "const": "SIGNET_TEST" + }, + { + "const": "SEN_TEST" + } + ] + } + } + ], + "responses": { + "200": { + "description": "ๆคœ่จผ็ตๆžœ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "properties": { + "isThirdPartyRouting": { + "type": "boolean" + }, + "description": { + "type": "string" + } + } + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/network_connections/{connectionId}": { + "get": { + "summary": "ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถšใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "description": "ID ใงใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถšใ‚’ๅ–ๅพ—ใ—ใพใ™ใ€‚**ๆณจ:** ใ“ใฎ API ๅ‘ผใณๅ‡บใ—ใฏใ€ๆŸ”่ปŸใชใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใ‚นใ‚ญใƒผใƒ ใฎๅฏพ่ฑกใงใ™ใ€‚ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใƒใƒชใ‚ทใƒผใซใ‚ˆใฃใฆใ€ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐๆ–นๆณ•ใŒๅฎš็พฉใ•ใ‚Œใพใ™ใ€‚ๅ„ใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใซๅฏพใ—ใฆใ€ไปฅไธ‹ใซ็คบใ™ 3 ใคใฎ็•ฐใชใ‚‹ใ‚นใ‚ญใƒผใƒ ใฎใ„ใšใ‚Œใ‹ใ‚’้ธๆŠžใงใใพใ™ใ€‚- **ใชใ—**; ใใฎใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใซๅฏพใ—ใฆใ€ๅฎ›ๅ…ˆใฎใชใ„ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ‚’ๅฎš็พฉใ—ใพใ™ใ€‚`ใชใ—` ใซใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ•ใ‚ŒใŸใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใธใฎๅ—ไฟกใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏๅคฑๆ•—ใ—ใพใ™ใ€‚- **ใ‚ซใ‚นใ‚ฟใƒ **; ้ธๆŠžใ—ใŸใ‚ขใ‚ซใ‚ฆใƒณใƒˆใซใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ—ใพใ™ใ€‚ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’ๅ‰Š้™คใ™ใ‚‹ใจใ€ๅˆฅใฎใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’้ธๆŠžใ™ใ‚‹ใพใงๅ—ไฟกใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏๅคฑๆ•—ใ—ใพใ™ใ€‚- **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ**; ๆŽฅ็ถšใŒๆŽฅ็ถšใ•ใ‚Œใฆใ„ใ‚‹ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซใงๆŒ‡ๅฎšใ•ใ‚ŒใŸใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ‚’ไฝฟ็”จใ—ใพใ™ใ€‚ใ“ใฎใ‚นใ‚ญใƒผใƒ ใฏใ€ใ€Œใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ€ใจใ‚‚ๅ‘ผใฐใ‚Œใพใ™ใ€‚ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใฎใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚น ใƒ—ใƒชใ‚ปใƒƒใƒˆ: - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ๆš—ๅท โ†’ **ใ‚ซใ‚นใ‚ฟใƒ ** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ FIAT โ†’ **ใชใ—** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถš ๆš—ๅท โ†’ **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถš FIAT โ†’ **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ** - **ๆณจ**: ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใงใฏใ€ใ‚ซใ‚นใ‚ฟใƒ  ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใ‚นใ‚ญใƒผใƒ ใฏ (`dstId` = `0`ใ€`dstType` = `VAULT`) ใ‚’ไฝฟ็”จใ—ใพใ™ใ€‚.", + "tags": [ + "Network connections" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "network_connection = fireblocks.get_network_connection_by_id(connectionId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const network_connection = await fireblocks.getNetworkConnection(connectionId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "connectionId", + "required": true, + "description": "ๆŽฅ็ถšใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถš", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/NetworkConnectionResponse" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "delete": { + "summary": "IDใงใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถšใ‚’ๅ‰Š้™คใ—ใพใ™", + "description": "ๆŽฅ็ถš ID ใงๆŒ‡ๅฎšใ•ใ‚ŒใŸๆ—ขๅญ˜ใฎใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถšใ‚’ๅ‰Š้™คใ—ใพใ™ใ€‚**ๆณจ:** ใ“ใฎ API ๅ‘ผใณๅ‡บใ—ใฏใ€ๆŸ”่ปŸใชใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใ‚นใ‚ญใƒผใƒ ใฎๅฏพ่ฑกใงใ™ใ€‚ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใƒใƒชใ‚ทใƒผใซใ‚ˆใฃใฆใ€ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐๆ–นๆณ•ใŒๅฎš็พฉใ•ใ‚Œใพใ™ใ€‚ๅ„ใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใซๅฏพใ—ใฆใ€ไปฅไธ‹ใซ็คบใ™ 3 ใคใฎ็•ฐใชใ‚‹ใ‚นใ‚ญใƒผใƒ ใฎใ„ใšใ‚Œใ‹ใ‚’้ธๆŠžใงใใพใ™ใ€‚- **ใชใ—**; ใใฎใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใซๅฏพใ—ใฆใ€ๅฎ›ๅ…ˆใฎใชใ„ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ‚’ๅฎš็พฉใ—ใพใ™ใ€‚`ใชใ—` ใซใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ•ใ‚ŒใŸใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใธใฎๅ—ไฟกใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏๅคฑๆ•—ใ—ใพใ™ใ€‚- **ใ‚ซใ‚นใ‚ฟใƒ **; ้ธๆŠžใ—ใŸใ‚ขใ‚ซใ‚ฆใƒณใƒˆใซใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ—ใพใ™ใ€‚ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’ๅ‰Š้™คใ™ใ‚‹ใจใ€ๅˆฅใฎใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’้ธๆŠžใ™ใ‚‹ใพใงๅ—ไฟกใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏๅคฑๆ•—ใ—ใพใ™ใ€‚- **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ**; ๆŽฅ็ถšใŒๆŽฅ็ถšใ•ใ‚Œใฆใ„ใ‚‹ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซใงๆŒ‡ๅฎšใ•ใ‚ŒใŸใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ‚’ไฝฟ็”จใ—ใพใ™ใ€‚ใ“ใฎใ‚นใ‚ญใƒผใƒ ใฏใ€ใ€Œใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ€ใจใ‚‚ๅ‘ผใฐใ‚Œใพใ™ใ€‚ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใฎใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚น ใƒ—ใƒชใ‚ปใƒƒใƒˆ: - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ๆš—ๅท โ†’ **ใ‚ซใ‚นใ‚ฟใƒ ** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ FIAT โ†’ **ใชใ—** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถš ๆš—ๅท โ†’ **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถš FIAT โ†’ **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ** - **ๆณจ**: ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใงใฏใ€ใ‚ซใ‚นใ‚ฟใƒ  ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใ‚นใ‚ญใƒผใƒ ใฏ (`dstId` = `0`ใ€`dstType` = `VAULT`) ใ‚’ไฝฟ็”จใ—ใพใ™ใ€‚.", + "tags": [ + "Network connections" + ], + "parameters": [ + { + "in": "path", + "name": "connectionId", + "required": true, + "description": "ๅ‰Š้™คใ™ใ‚‹ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถšใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏID", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "properties": { + "success": { + "type": "boolean" + } + }, + "required": [ + "success" + ] + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/network_ids": { + "get": { + "summary": "ใƒญใƒผใ‚ซใƒซIDใจๆคœๅ‡บๅฏ่ƒฝใชใƒชใƒขใƒผใƒˆIDใฎไธกๆ–นใ‚’ๅซใ‚€ใ™ในใฆใฎใƒใƒƒใƒˆใƒฏใƒผใ‚ฏIDใ‚’่ฟ”ใ—ใพใ™ใ€‚", + "description": "ใ™ในใฆใฎใƒญใƒผใ‚ซใƒซใŠใ‚ˆใณๆคœๅ‡บๅฏ่ƒฝใชใƒชใƒขใƒผใƒˆ ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ID ใฎใƒชใ‚นใƒˆใ‚’ๅ–ๅพ—ใ—ใพใ™ใ€‚**ๆณจ:** ใ“ใฎ API ๅ‘ผใณๅ‡บใ—ใฏใ€ๆŸ”่ปŸใชใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใ‚นใ‚ญใƒผใƒ ใฎๅฏพ่ฑกใงใ™ใ€‚ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใƒใƒชใ‚ทใƒผใซใ‚ˆใฃใฆใ€ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐๆ–นๆณ•ใŒๅฎš็พฉใ•ใ‚Œใพใ™ใ€‚ๅ„ใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใซๅฏพใ—ใฆใ€ไปฅไธ‹ใซ็คบใ™ 3 ใคใฎ็•ฐใชใ‚‹ใ‚นใ‚ญใƒผใƒ ใฎใ„ใšใ‚Œใ‹ใ‚’้ธๆŠžใงใใพใ™ใ€‚- **ใชใ—**; ใใฎใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใซๅฏพใ—ใฆใ€ๅฎ›ๅ…ˆใฎใชใ„ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ‚’ๅฎš็พฉใ—ใพใ™ใ€‚`ใชใ—` ใซใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ•ใ‚ŒใŸใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใธใฎๅ—ไฟกใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏๅคฑๆ•—ใ—ใพใ™ใ€‚- **ใ‚ซใ‚นใ‚ฟใƒ **; ้ธๆŠžใ—ใŸใ‚ขใ‚ซใ‚ฆใƒณใƒˆใซใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ—ใพใ™ใ€‚ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’ๅ‰Š้™คใ™ใ‚‹ใจใ€ๅˆฅใฎใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’้ธๆŠžใ™ใ‚‹ใพใงๅ—ไฟกใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏๅคฑๆ•—ใ—ใพใ™ใ€‚- **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ**; ๆŽฅ็ถšๅ…ˆใฎใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซใงๆŒ‡ๅฎšใ•ใ‚ŒใŸใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ‚’ไฝฟ็”จใ—ใพใ™ใ€‚ใ“ใฎใ‚นใ‚ญใƒผใƒ ใฏใ€ใ€Œใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ€ใจใ‚‚ๅ‘ผใฐใ‚Œใพใ™ใ€‚ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใฎใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚น ใƒ—ใƒชใ‚ปใƒƒใƒˆ: - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ๆš—ๅท โ†’ **ใ‚ซใ‚นใ‚ฟใƒ ** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ FIAT โ†’ **ใชใ—** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถš ๆš—ๅท โ†’ **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถš FIAT โ†’ **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ** - **ๆณจ**: ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใงใฏใ€ใ‚ซใ‚นใ‚ฟใƒ  ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใ‚นใ‚ญใƒผใƒ ใฏ (`dstId` = `0`ใ€`dstType` = `VAULT`) ใ‚’ไฝฟ็”จใ—ใพใ™ใ€‚.", + "tags": [ + "Network connections" + ], + "responses": { + "200": { + "description": "ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏIDใฎใƒชใ‚นใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": {} + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "ๆ–ฐใ—ใ„ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏIDใ‚’ไฝœๆˆใ—ใพใ™", + "description": "ๆ–ฐใ—ใ„ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ID ใ‚’ไฝœๆˆใ—ใพใ™ใ€‚**ๆณจ:** ใ“ใฎ API ๅ‘ผใณๅ‡บใ—ใฏใ€ๆŸ”่ปŸใชใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใ‚นใ‚ญใƒผใƒ ใฎๅฏพ่ฑกใงใ™ใ€‚ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใƒใƒชใ‚ทใƒผใซใ‚ˆใฃใฆใ€ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐๆ–นๆณ•ใŒๅฎš็พฉใ•ใ‚Œใพใ™ใ€‚ๅ„ใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใซๅฏพใ—ใฆใ€ไปฅไธ‹ใซ็คบใ™ 3 ใคใฎ็•ฐใชใ‚‹ใ‚นใ‚ญใƒผใƒ ใฎใ„ใšใ‚Œใ‹ใ‚’้ธๆŠžใงใใพใ™ใ€‚- **ใชใ—**; ใใฎใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใซๅฏพใ—ใฆใ€ๅฎ›ๅ…ˆใฎใชใ„ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ‚’ๅฎš็พฉใ—ใพใ™ใ€‚`ใชใ—` ใซใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ•ใ‚ŒใŸใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใธใฎๅ—ไฟกใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏๅคฑๆ•—ใ—ใพใ™ใ€‚- **ใ‚ซใ‚นใ‚ฟใƒ **; ้ธๆŠžใ—ใŸใ‚ขใ‚ซใ‚ฆใƒณใƒˆใซใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ—ใพใ™ใ€‚ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’ๅ‰Š้™คใ™ใ‚‹ใจใ€ๅˆฅใฎใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’้ธๆŠžใ™ใ‚‹ใพใงๅ—ไฟกใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏๅคฑๆ•—ใ—ใพใ™ใ€‚- **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ**; ๆŽฅ็ถšๅ…ˆใฎใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซใงๆŒ‡ๅฎšใ•ใ‚ŒใŸใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ‚’ไฝฟ็”จใ—ใพใ™ใ€‚ใ“ใฎใ‚นใ‚ญใƒผใƒ ใฏใ€ใ€Œใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ€ใจใ‚‚ๅ‘ผใฐใ‚Œใพใ™ใ€‚ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใฎใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚น ใƒ—ใƒชใ‚ปใƒƒใƒˆ: - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ๆš—ๅท โ†’ **ใ‚ซใ‚นใ‚ฟใƒ ** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ FIAT โ†’ **ใชใ—** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถš ๆš—ๅท โ†’ **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถš FIAT โ†’ **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ** - **ๆณจ**: ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใงใฏใ€ใ‚ซใ‚นใ‚ฟใƒ  ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใ‚นใ‚ญใƒผใƒ ใฏ (`dstId` = `0`ใ€`dstType` = `VAULT`) ใ‚’ไฝฟ็”จใ—ใพใ™ใ€‚.", + "tags": [ + "Network connections" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "type": "string" + }, + "routingPolicy": { + "$ref": "#/components/schemas/NetworkIdRoutingPolicy" + } + }, + "required": [ + "name" + ] + } + } + } + }, + "responses": { + "201": { + "description": "ใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚นๅ†…ใฎๆ–ฐใ—ใ„ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏIDใ‚’่ฟ”ใ—ใพใ™", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/NetworkIdResponse" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/network_ids/{networkId}": { + "get": { + "summary": "็‰นๅฎšใฎใƒใƒƒใƒˆใƒฏใƒผใ‚ฏIDใ‚’่ฟ”ใ—ใพใ™.", + "description": "ID ใงใƒใƒƒใƒˆใƒฏใƒผใ‚ฏใ‚’ๅ–ๅพ—ใ—ใพใ™ใ€‚**ๆณจ:** ใ“ใฎ API ๅ‘ผใณๅ‡บใ—ใฏใ€ๆŸ”่ปŸใชใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใ‚นใ‚ญใƒผใƒ ใฎๅฏพ่ฑกใงใ™ใ€‚ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใƒใƒชใ‚ทใƒผใซใ‚ˆใฃใฆใ€ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐๆ–นๆณ•ใŒๅฎš็พฉใ•ใ‚Œใพใ™ใ€‚ๅ„ใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใซๅฏพใ—ใฆใ€ไปฅไธ‹ใฎ 3 ใคใฎ็•ฐใชใ‚‹ใ‚นใ‚ญใƒผใƒ ใ‹ใ‚‰ 1 ใคใ‚’้ธๆŠžใงใใพใ™ใ€‚- **ใชใ—**; ใใฎใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใซๅฏพใ—ใฆใ€ๅฎ›ๅ…ˆใฎใชใ„ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ‚’ๅฎš็พฉใ—ใพใ™ใ€‚`ใชใ—` ใซใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ•ใ‚ŒใŸใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใธใฎๅ—ไฟกใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏๅคฑๆ•—ใ—ใพใ™ใ€‚- **ใ‚ซใ‚นใ‚ฟใƒ **; ้ธๆŠžใ—ใŸใ‚ขใ‚ซใ‚ฆใƒณใƒˆใซใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ—ใพใ™ใ€‚ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’ๅ‰Š้™คใ™ใ‚‹ใจใ€ๅˆฅใฎใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’้ธๆŠžใ™ใ‚‹ใพใงๅ—ไฟกใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏๅคฑๆ•—ใ—ใพใ™ใ€‚- **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ**; ๆŽฅ็ถšๅ…ˆใฎใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซใงๆŒ‡ๅฎšใ•ใ‚ŒใŸใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ‚’ไฝฟ็”จใ—ใพใ™ใ€‚ใ“ใฎใ‚นใ‚ญใƒผใƒ ใฏใ€ใ€Œใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ€ใจใ‚‚ๅ‘ผใฐใ‚Œใพใ™ใ€‚ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใฎใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚น ใƒ—ใƒชใ‚ปใƒƒใƒˆ: - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ๆš—ๅท โ†’ **ใ‚ซใ‚นใ‚ฟใƒ ** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ FIAT โ†’ **ใชใ—** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถš ๆš—ๅท โ†’ **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถš FIAT โ†’ **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ** - **ๆณจ**: ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใงใฏใ€ใ‚ซใ‚นใ‚ฟใƒ  ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใ‚นใ‚ญใƒผใƒ ใฏ (`dstId` = `0`ใ€`dstType` = `VAULT`) ใ‚’ไฝฟ็”จใ—ใพใ™ใ€‚.", + "tags": [ + "Network connections" + ], + "parameters": [ + { + "in": "path", + "name": "networkId", + "required": true, + "description": "ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏID", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/NetworkIdResponse" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "delete": { + "summary": "็‰นๅฎšใฎใƒใƒƒใƒˆใƒฏใƒผใ‚ฏIDใ‚’ๅ‰Š้™คใ—ใพใ™.", + "description": "ID ใงใƒใƒƒใƒˆใƒฏใƒผใ‚ฏใ‚’ๅ‰Š้™คใ—ใพใ™ใ€‚**ๆณจ:** ใ“ใฎ API ๅ‘ผใณๅ‡บใ—ใฏใ€ๆŸ”่ปŸใชใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใ‚นใ‚ญใƒผใƒ ใฎๅฏพ่ฑกใงใ™ใ€‚ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใƒใƒชใ‚ทใƒผใซใ‚ˆใฃใฆใ€ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐๆ–นๆณ•ใŒๆฑบใพใ‚Šใพใ™ใ€‚ๅ„ใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใซๅฏพใ—ใฆใ€ไปฅไธ‹ใฎ 3 ใคใฎ็•ฐใชใ‚‹ใ‚นใ‚ญใƒผใƒ ใ‹ใ‚‰ 1 ใคใ‚’้ธๆŠžใงใใพใ™ใ€‚- **ใชใ—**; ใใฎใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใซๅฏพใ—ใฆใ€ๅฎ›ๅ…ˆใฎใชใ„ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ‚’ๅฎš็พฉใ—ใพใ™ใ€‚`ใชใ—` ใซใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ•ใ‚ŒใŸใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใธใฎๅ—ไฟกใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏๅคฑๆ•—ใ—ใพใ™ใ€‚- **ใ‚ซใ‚นใ‚ฟใƒ **; ้ธๆŠžใ—ใŸใ‚ขใ‚ซใ‚ฆใƒณใƒˆใซใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ—ใพใ™ใ€‚ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’ๅ‰Š้™คใ™ใ‚‹ใจใ€ๅˆฅใฎใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’้ธๆŠžใ™ใ‚‹ใพใงๅ—ไฟกใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏๅคฑๆ•—ใ—ใพใ™ใ€‚- **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ**; ๆŽฅ็ถšๅ…ˆใฎใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซใงๆŒ‡ๅฎšใ•ใ‚ŒใŸใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ‚’ไฝฟ็”จใ—ใพใ™ใ€‚ใ“ใฎใ‚นใ‚ญใƒผใƒ ใฏใ€ใ€Œใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ€ใจใ‚‚ๅ‘ผใฐใ‚Œใพใ™ใ€‚ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใฎใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚น ใƒ—ใƒชใ‚ปใƒƒใƒˆ: - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ๆš—ๅท โ†’ **ใ‚ซใ‚นใ‚ฟใƒ ** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ FIAT โ†’ **ใชใ—** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถš ๆš—ๅท โ†’ **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถš FIAT โ†’ **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ** - **ๆณจ**: ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใงใฏใ€ใ‚ซใ‚นใ‚ฟใƒ  ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใ‚นใ‚ญใƒผใƒ ใฏ (`dstId` = `0`ใ€`dstType` = `VAULT`) ใ‚’ไฝฟ็”จใ—ใพใ™ใ€‚.", + "tags": [ + "Network connections" + ], + "parameters": [ + { + "in": "path", + "name": "networkId", + "required": true, + "description": "ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏID", + "content": { + "*/*": { + "schema": { + "properties": { + "success": { + "type": "boolean" + } + }, + "required": [ + "success" + ] + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/network_ids/{networkId}/set_routing_policy": { + "patch": { + "summary": "ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ID ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใƒใƒชใ‚ทใƒผใ‚’ๆ›ดๆ–ฐใ™ใ‚‹.", + "description": "ๆŒ‡ๅฎšใ•ใ‚ŒใŸใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ID ใฎใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใƒใƒชใ‚ทใƒผใ‚’ๆ›ดๆ–ฐใ—ใพใ™ใ€‚**ๆณจ:** ใ“ใฎ API ๅ‘ผใณๅ‡บใ—ใฏใ€ๆŸ”่ปŸใชใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใ‚นใ‚ญใƒผใƒ ใฎๅฏพ่ฑกใงใ™ใ€‚ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใƒใƒชใ‚ทใƒผใซใ‚ˆใฃใฆใ€ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐๆ–นๆณ•ใŒๅฎš็พฉใ•ใ‚Œใพใ™ใ€‚ๅ„ใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใซๅฏพใ—ใฆใ€ไปฅไธ‹ใซ็คบใ™ 3 ใคใฎ็•ฐใชใ‚‹ใ‚นใ‚ญใƒผใƒ ใฎใ„ใšใ‚Œใ‹ใ‚’้ธๆŠžใงใใพใ™ใ€‚- **ใชใ—**; ใใฎใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใซๅฏพใ—ใฆใ€ๅฎ›ๅ…ˆใฎใชใ„ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ‚’ๅฎš็พฉใ—ใพใ™ใ€‚`ใชใ—` ใซใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ•ใ‚ŒใŸใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใธใฎๅ—ไฟกใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏๅคฑๆ•—ใ—ใพใ™ใ€‚- **ใ‚ซใ‚นใ‚ฟใƒ **; ้ธๆŠžใ—ใŸใ‚ขใ‚ซใ‚ฆใƒณใƒˆใซใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ—ใพใ™ใ€‚ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’ๅ‰Š้™คใ™ใ‚‹ใจใ€ๅˆฅใฎใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’้ธๆŠžใ™ใ‚‹ใพใงๅ—ไฟกใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏๅคฑๆ•—ใ—ใพใ™ใ€‚- **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ**; ๆŽฅ็ถšๅ…ˆใฎใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซใงๆŒ‡ๅฎšใ•ใ‚ŒใŸใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ‚’ไฝฟ็”จใ—ใพใ™ใ€‚ใ“ใฎใ‚นใ‚ญใƒผใƒ ใฏใ€ใ€Œใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ€ใจใ‚‚ๅ‘ผใฐใ‚Œใพใ™ใ€‚ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใฎใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚น ใƒ—ใƒชใ‚ปใƒƒใƒˆ: - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ๆš—ๅท โ†’ **ใ‚ซใ‚นใ‚ฟใƒ ** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ FIAT โ†’ **ใชใ—** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถš ๆš—ๅท โ†’ **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถš FIAT โ†’ **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ** - **ๆณจ**: ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใงใฏใ€ใ‚ซใ‚นใ‚ฟใƒ  ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใ‚นใ‚ญใƒผใƒ ใฏ (`dstId` = `0`ใ€`dstType` = `VAULT`) ใ‚’ไฝฟ็”จใ—ใพใ™ใ€‚.", + "tags": [ + "Network connections" + ], + "parameters": [ + { + "in": "path", + "name": "networkId", + "required": true, + "description": "ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "routingPolicy": { + "$ref": "#/components/schemas/NetworkIdRoutingPolicy" + } + }, + "required": [ + "routingPolicy" + ] + } + } + } + }, + "responses": { + "200": { + "description": "ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏID", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "properties": { + "success": { + "type": "boolean" + } + }, + "required": [ + "success" + ] + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/network_ids/{networkId}/set_discoverability": { + "patch": { + "summary": "ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏIDใฎๆคœๅ‡บๅฏ่ƒฝๆ€งใ‚’ๆ›ดๆ–ฐใ™ใ‚‹.", + "description": "ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ID ใŒไป–ใฎใƒฆใƒผใ‚ถใƒผใซใ‚ˆใฃใฆๆคœๅ‡บๅฏ่ƒฝใ‹ใฉใ†ใ‹ใ‚’ๆ›ดๆ–ฐใ—ใพใ™ใ€‚**ๆณจ:** ใ“ใฎ API ๅ‘ผใณๅ‡บใ—ใฏใ€ๆŸ”่ปŸใชใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใ‚นใ‚ญใƒผใƒ ใฎๅฏพ่ฑกใงใ™ใ€‚ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใƒใƒชใ‚ทใƒผใซใ‚ˆใฃใฆใ€ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐๆ–นๆณ•ใŒๅฎš็พฉใ•ใ‚Œใพใ™ใ€‚ๅ„ใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใซๅฏพใ—ใฆใ€ไปฅไธ‹ใซ็คบใ™ 3 ใคใฎ็•ฐใชใ‚‹ใ‚นใ‚ญใƒผใƒ ใฎใ„ใšใ‚Œใ‹ใ‚’้ธๆŠžใงใใพใ™ใ€‚- **ใชใ—**; ใใฎใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใซๅฏพใ—ใฆใ€ๅฎ›ๅ…ˆใฎใชใ„ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ‚’ๅฎš็พฉใ—ใพใ™ใ€‚`ใชใ—` ใซใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ•ใ‚ŒใŸใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใธใฎๅ—ไฟกใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏๅคฑๆ•—ใ—ใพใ™ใ€‚- **ใ‚ซใ‚นใ‚ฟใƒ **; ้ธๆŠžใ—ใŸใ‚ขใ‚ซใ‚ฆใƒณใƒˆใซใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ—ใพใ™ใ€‚ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’ๅ‰Š้™คใ™ใ‚‹ใจใ€ๅˆฅใฎใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’้ธๆŠžใ™ใ‚‹ใพใงๅ—ไฟกใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏๅคฑๆ•—ใ—ใพใ™ใ€‚- **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ**; ๆŽฅ็ถšๅ…ˆใฎใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซใงๆŒ‡ๅฎšใ•ใ‚ŒใŸใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ‚’ไฝฟ็”จใ—ใพใ™ใ€‚ใ“ใฎใ‚นใ‚ญใƒผใƒ ใฏใ€ใ€Œใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ€ใจใ‚‚ๅ‘ผใฐใ‚Œใพใ™ใ€‚ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใฎใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚น ใƒ—ใƒชใ‚ปใƒƒใƒˆ: - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ๆš—ๅท โ†’ **ใ‚ซใ‚นใ‚ฟใƒ ** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ FIAT โ†’ **ใชใ—** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถš ๆš—ๅท โ†’ **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถš FIAT โ†’ **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ** - **ๆณจ**: ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใงใฏใ€ใ‚ซใ‚นใ‚ฟใƒ  ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใ‚นใ‚ญใƒผใƒ ใฏ (`dstId` = `0`ใ€`dstType` = `VAULT`) ใ‚’ไฝฟ็”จใ—ใพใ™ใ€‚.", + "tags": [ + "Network connections" + ], + "parameters": [ + { + "in": "path", + "name": "networkId", + "required": true, + "description": "ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "isDiscoverable": { + "type": "boolean" + } + }, + "required": [ + "isDiscoverable" + ] + } + } + } + }, + "responses": { + "200": { + "description": "ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏID", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "properties": { + "success": { + "type": "boolean" + } + }, + "required": [ + "success" + ] + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/network_ids/{networkId}/set_name": { + "patch": { + "summary": "ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏIDใฎๅๅ‰ใ‚’ๆ›ดๆ–ฐ.", + "description": "ๆŒ‡ๅฎšใ•ใ‚ŒใŸใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ID ใฎๅๅ‰ใ‚’ๆ›ดๆ–ฐใ—ใพใ™ใ€‚**ๆณจ:** ใ“ใฎ API ๅ‘ผใณๅ‡บใ—ใฏใ€ๆŸ”่ปŸใชใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใ‚นใ‚ญใƒผใƒ ใฎๅฏพ่ฑกใงใ™ใ€‚ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใƒใƒชใ‚ทใƒผใซใ‚ˆใฃใฆใ€ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐๆ–นๆณ•ใŒๆฑบใพใ‚Šใพใ™ใ€‚ๅ„ใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใซๅฏพใ—ใฆใ€ไปฅไธ‹ใฎ 3 ใคใฎ็•ฐใชใ‚‹ใ‚นใ‚ญใƒผใƒ ใ‹ใ‚‰ 1 ใคใ‚’้ธๆŠžใงใใพใ™ใ€‚- **ใชใ—**; ใใฎใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใซๅฏพใ—ใฆใ€ๅฎ›ๅ…ˆใฎใชใ„ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ‚’ๅฎš็พฉใ—ใพใ™ใ€‚`ใชใ—` ใซใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ•ใ‚ŒใŸใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใธใฎๅ—ไฟกใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏๅคฑๆ•—ใ—ใพใ™ใ€‚- **ใ‚ซใ‚นใ‚ฟใƒ **; ้ธๆŠžใ—ใŸใ‚ขใ‚ซใ‚ฆใƒณใƒˆใซใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ—ใพใ™ใ€‚ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’ๅ‰Š้™คใ™ใ‚‹ใจใ€ๅˆฅใฎใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’้ธๆŠžใ™ใ‚‹ใพใงๅ—ไฟกใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏๅคฑๆ•—ใ—ใพใ™ใ€‚- **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ**; ๆŽฅ็ถšๅ…ˆใฎใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซใงๆŒ‡ๅฎšใ•ใ‚ŒใŸใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ‚’ไฝฟ็”จใ—ใพใ™ใ€‚ใ“ใฎใ‚นใ‚ญใƒผใƒ ใฏใ€ใ€Œใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใ€ใจใ‚‚ๅ‘ผใฐใ‚Œใพใ™ใ€‚ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใฎใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚น ใƒ—ใƒชใ‚ปใƒƒใƒˆ: - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ ๆš—ๅท โ†’ **ใ‚ซใ‚นใ‚ฟใƒ ** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซ FIAT โ†’ **ใชใ—** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถš ๆš—ๅท โ†’ **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ** - ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถš FIAT โ†’ **ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆ** - **ๆณจ**: ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใงใฏใ€ใ‚ซใ‚นใ‚ฟใƒ  ใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐ ใ‚นใ‚ญใƒผใƒ ใฏ (`dstId` = `0`ใ€`dstType` = `VAULT`) ใ‚’ไฝฟ็”จใ—ใพใ™ใ€‚.", + "tags": [ + "Network connections" + ], + "parameters": [ + { + "in": "path", + "name": "networkId", + "required": true, + "description": "ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "type": "string" + } + }, + "required": [ + "name" + ] + } + } + } + }, + "responses": { + "200": { + "description": "ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏID", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "properties": { + "success": { + "type": "boolean" + } + }, + "required": [ + "success" + ] + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/internal_wallets": { + "get": { + "summary": "ๅ†…้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚’ไธ€่ฆง่กจ็คบใ™ใ‚‹", + "tags": [ + "Internal wallets" + ], + "description": "ๅ†…้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎใƒชใ‚นใƒˆใ‚’ๅ–ๅพ—ใ—ใพใ™ใ€‚**ๆณจๆ„**: ใƒ›ใƒฏใ‚คใƒˆใƒชใ‚นใƒˆใซ็™ป้Œฒใ•ใ‚ŒใŸใ‚ขใƒ‰ใƒฌใ‚นใซๅฑžใ™ใ‚‹ BTC ใƒ™ใƒผใ‚นใฎ่ณ‡็”ฃใฏใ€ใ‚ตใƒผใƒ‰ใƒ‘ใƒผใƒ†ใ‚ฃ ใƒ—ใƒญใƒใ‚คใƒ€ใƒผใฎ Blockchair ใŒใ“ใฎ 60 ็ง’้–“ๅˆฉ็”จใงใใชใ„ใŸใ‚ใ€ๆฏŽๆ—ฅ 00:00 UTC ใ‹ใ‚‰ 00:01 UTC ใฎ้–“ๅ–ๅพ—ใงใใพใ›ใ‚“ใ€‚BTC ใƒ™ใƒผใ‚นใฎ่ณ‡็”ฃใ‚’ๅ–ๅพ—ใ™ใ‚‹ใซใฏใ€ๆฌกใฎ 1 ๅˆ†ใพใงใŠๅพ…ใกใใ ใ•ใ„ใ€‚.", + "responses": { + "200": { + "description": "ๅ†…้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎใƒชใ‚นใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "ๅ†…้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚’ไฝœๆˆใ™ใ‚‹", + "tags": [ + "Internal wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "internalWallet = fireblocks.create_internal_wallet(name, customer_ref_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const internalWallet = await fireblocks.createInternalWallet(name, customerRefId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸๅๅ‰ใงๆ–ฐใ—ใ„ๅ†…้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚’ไฝœๆˆใ—ใพใ™.", + "responses": { + "200": { + "description": "ๆ–ฐใ—ใ„ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "type": "string", + "description": "ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎ่กจ็คบๅ" + }, + "customerRefId": { + "description": "ใ‚ชใƒ—ใ‚ทใƒงใƒณ - ้กงๅฎขๅ‚็…งIDใ‚’่จญๅฎšใ—ใพใ™", + "type": "string" + } + } + } + } + } + } + } + }, + "/internal_wallets/{walletId}": { + "get": { + "summary": "ๅ†…้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎ่ณ‡็”ฃใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "tags": [ + "Internal wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "internalWallet = fireblocks.get_internal_wallet(walletId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.getInternalWallet(walletId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "description": "ๅ†…้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆๅ†…ใฎใ™ในใฆใฎ่ณ‡็”ฃใ‚’IDใง่ฟ”ใ—ใพใ™.", + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "่ฟ”ใ•ใ‚Œใ‚‹ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "delete": { + "summary": "ๅ†…้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚’ๅ‰Š้™คใ™ใ‚‹", + "tags": [ + "Internal wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = firebocks.delete_internal_wallet(walletId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.deleteInternalWallet(walletId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "description": "IDใงๅ†…้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚’ๅ‰Š้™คใ—ใพใ™.", + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "ๅ‰Š้™คใ™ใ‚‹ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "201": { + "description": "ใ‚ใ‹ใ‚Šใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/internal_wallets/{walletId}/set_customer_ref_id": { + "post": { + "summary": "ๅ†…้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎAML/KYT้กงๅฎขๅ‚็…งIDใ‚’่จญๅฎšใ™ใ‚‹", + "tags": [ + "Internal wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = firebocks.set_customer_ref_id_for_internal_wallet(wallet_id, customer_ref_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.setCustomerRefIdForInternalWallet(walletId, customerRefId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "description": "็‰นๅฎšใฎๅ†…้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎAML/KYT้กงๅฎขๅ‚็…งIDใ‚’่จญๅฎšใ—ใพใ™.", + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "customerRefId": { + "description": "้กงๅฎขๅ‚็…งID", + "type": "string" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "ใ‚ใ‹ใ‚Šใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/internal_wallets/{walletId}/{assetId}": { + "get": { + "summary": "ๅ†…้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‹ใ‚‰่ณ‡็”ฃใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "tags": [ + "Internal wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "internalWalletAsset = fireblocks.get_internal_wallet_asset(walletId, assetId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const internalWalletAsset = fireblocks.getInternalWalletAsset(walletId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "description": "ๅ†…้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆๅ†…ใฎ่ณ‡็”ฃใฎๆƒ…ๅ ฑใ‚’่ฟ”ใ—ใพใ™.", + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "่ฟ”ใ•ใ‚Œใ‚‹่ณ‡็”ฃใฎID", + "schema": { + "type": "string", + "minimum": 1, + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚ขใ‚ปใƒƒใƒˆใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/WalletAsset" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "ๅ†…้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใซ่ณ‡็”ฃใ‚’่ฟฝๅŠ ใ™ใ‚‹", + "tags": [ + "Internal wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "internalWalletAsset = fireblocks.create_internal_wallet_asset(walletId, assetId, address, tag)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const internalWalletAsset = await fireblocks.createInternalWalletAsset(walletContainerId, assetId, address, tag);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "description": "ๆ—ขๅญ˜ใฎๅ†…้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใซ่ณ‡็”ฃใ‚’่ฟฝๅŠ ใ—ใพใ™.", + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎID", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "่ฟฝๅŠ ใ™ใ‚‹ใ‚ขใ‚ปใƒƒใƒˆใฎID", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚ขใ‚ปใƒƒใƒˆใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/WalletAsset" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "address": { + "type": "string", + "description": "ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎใ‚ขใƒ‰ใƒฌใ‚นใ€ใพใŸใฏEOSใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎๅ ดๅˆใฏใ‚ขใ‚ซใ‚ฆใƒณใƒˆๅ" + }, + "tag": { + "type": "string", + "description": "XRPใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎๅ ดๅˆใฏๅฎ›ๅ…ˆใ‚ฟใ‚ฐใ€EOSใฎๅ ดๅˆใฏใƒกใƒขใ€ๆณ•ๅฎš้€š่ฒจใƒ—ใƒญใƒใ‚คใƒ€ใƒผ๏ผˆBCBใ‚ฐใƒซใƒผใƒ—ใฎBLINC๏ผ‰ใฎๅ ดๅˆใฏ้Š€่กŒๆŒฏ่พผใฎ่ชฌๆ˜Ž" + } + }, + "required": [ + "address" + ] + } + } + } + } + }, + "delete": { + "summary": "ๅ†…้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‹ใ‚‰ใƒ›ใƒฏใ‚คใƒˆใƒชใ‚นใƒˆใซ็™ป้Œฒใ•ใ‚ŒใŸใ‚ขใƒ‰ใƒฌใ‚นใ‚’ๅ‰Š้™คใ™ใ‚‹", + "tags": [ + "Internal wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = fireblocks.delete_internal_wallet_asset(walletId, assetId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.deleteInternalWalletAsset(walletId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "description": "ๅ†…้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‹ใ‚‰ใƒ›ใƒฏใ‚คใƒˆใƒชใ‚นใƒˆใซ็™ป้Œฒใ•ใ‚ŒใŸใ‚ขใƒ‰ใƒฌใ‚น๏ผˆ่ณ‡็”ฃ็”จ๏ผ‰ใ‚’ๅ‰Š้™คใ—ใพใ™.", + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "ๅ‰Š้™คใ™ใ‚‹ใ‚ขใ‚ปใƒƒใƒˆใฎID", + "schema": { + "type": "string", + "minimum": 1, + "x-fb-entity": "asset" + } + } + ], + "responses": { + "201": { + "description": "ใ‚ใ‹ใ‚Šใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/external_wallets": { + "get": { + "summary": "ๅค–้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚’ไธ€่ฆง่กจ็คบใ™ใ‚‹", + "description": "ใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚นใฎๅค–้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎใƒชใ‚นใƒˆใ‚’ๅ–ๅพ—ใ—ใพใ™.", + "tags": [ + "External wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "externalWallets = fireblocks.get_external_wallets()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const externalWallets = await fireblocks.getExternalWallets();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "ๅค–้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎใƒชใ‚นใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "ๅค–้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚’ไฝœๆˆใ™ใ‚‹", + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸๅๅ‰ใงๆ–ฐใ—ใ„ๅค–้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚’ไฝœๆˆใ—ใพใ™.", + "tags": [ + "External wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "externalWallet = fireblocks.create_external_wallet(name, customer_ref_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const externalWallet = await fireblocks.createExternalWallet(name, customerRefId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "type": "string", + "description": "ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎ่กจ็คบๅ" + }, + "customerRefId": { + "description": "ใ‚ชใƒ—ใ‚ทใƒงใƒณ - ้กงๅฎขๅ‚็…งIDใ‚’่จญๅฎšใ—ใพใ™", + "type": "string" + } + } + } + } + } + } + } + }, + "/external_wallets/{walletId}": { + "get": { + "summary": "ๅค–้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚’ๆŽขใ™", + "description": "IDใงๅค–้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚’่ฟ”ใ—ใพใ™.", + "tags": [ + "External wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "externalWallet = fireblocks.get_external_wallet(walletId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const externalWallet = await fireblocks.getExternalWallet(walletId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "่ฟ”ใ•ใ‚Œใ‚‹ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "delete": { + "summary": "ๅค–้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚’ๅ‰Š้™คใ™ใ‚‹", + "description": "IDใงๅค–้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚’ๅ‰Š้™คใ—ใพใ™.", + "tags": [ + "External wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = firebocks.delete_external_wallet(walletId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.deleteExternalWallet(walletId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "ๅ‰Š้™คใ™ใ‚‹ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "201": { + "description": "ใ‚ใ‹ใ‚Šใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/external_wallets/{walletId}/set_customer_ref_id": { + "post": { + "summary": "ๅค–้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎAML้กงๅฎขๅ‚็…งIDใ‚’่จญๅฎšใ™ใ‚‹", + "description": "็‰นๅฎšใฎๅค–้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎAML/KYT้กงๅฎขๅ‚็…งIDใ‚’่จญๅฎšใ—ใพใ™.", + "tags": [ + "External wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = firebocks.set_customer_ref_id_for_external_wallet(wallet_id, customer_ref_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.setCustomerRefIdForExternalWallet(walletId, customerRefId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "customerRefId": { + "description": "้กงๅฎขๅ‚็…งID", + "type": "string" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "ใ‚ใ‹ใ‚Šใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/external_wallets/{walletId}/{assetId}": { + "get": { + "summary": "ๅค–้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‹ใ‚‰่ณ‡็”ฃใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "description": "ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆIDใจใ‚ขใ‚ปใƒƒใƒˆIDใงๅค–้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚’่ฟ”ใ—ใพใ™.", + "tags": [ + "External wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "externalWalletAsset = fireblocks.get_external_wallet_asset(walletId, assetId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const externalWalletAsset = fireblocks.getExternalWalletAsset(walletId, assetId)", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "่ฟ”ใ•ใ‚Œใ‚‹่ณ‡็”ฃใฎID", + "schema": { + "type": "string", + "minimum": 1, + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚ขใ‚ปใƒƒใƒˆใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ExternalWalletAsset" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "ๅค–้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใซ่ณ‡็”ฃใ‚’่ฟฝๅŠ ใ™ใ‚‹.", + "description": "ๆ—ขๅญ˜ใฎๅค–้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใซ่ณ‡็”ฃใ‚’่ฟฝๅŠ ใ™ใ‚‹.", + "tags": [ + "External wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "externalWalletAsset = fireblocks.create_external_wallet_asset(walletId, assetId, address, tag)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const externalWalletAsset = await fireblocks.createExternalWalletAsset(walletContainerId, assetId, address, tag);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎID", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "่ฟฝๅŠ ใ™ใ‚‹ใ‚ขใ‚ปใƒƒใƒˆใฎID", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚ขใ‚ปใƒƒใƒˆใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ExternalWalletAsset" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "properties": { + "address": { + "type": "string", + "description": "ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎใ‚ขใƒ‰ใƒฌใ‚น๏ผˆใพใŸใฏxpub๏ผ‰" + }, + "tag": { + "type": "string", + "description": "XRPใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎๅ ดๅˆใฏๅฎ›ๅ…ˆใ‚ฟใ‚ฐใ€EOS/XLMใฎๅ ดๅˆใฏใƒกใƒขใ€ๆณ•ๅฎš้€š่ฒจใƒ—ใƒญใƒใ‚คใƒ€ใƒผ๏ผˆBCBใ‚ฐใƒซใƒผใƒ—ใฎBLINC๏ผ‰ใฎๅ ดๅˆใฏ้Š€่กŒๆŒฏ่พผใฎ่ชฌๆ˜Ž" + } + }, + "required": [ + "address" + ] + }, + { + "properties": { + "additionalInfo": { + "type": "object", + "oneOf": [ + { + "properties": { + "accountHolderGivenName": { + "type": "string" + }, + "accountHolderSurname": { + "type": "string" + }, + "accountHolderCity": { + "type": "string" + }, + "accountHolderCountry": { + "type": "string" + }, + "accountHolderAddress1": { + "type": "string" + }, + "accountHolderAddress2": { + "type": "string" + }, + "accountHolderDistrict": { + "type": "string" + }, + "accountHolderPostalCode": { + "type": "string" + }, + "iban": { + "type": "string" + }, + "ibanCity": { + "type": "string" + }, + "ibanCountry": { + "type": "string" + } + }, + "required": [ + "accountHolderGivenName", + "accountHolderCity", + "accountHolderCountry", + "accountHolderAddress1", + "accountHolderPostalCode", + "iban", + "ibanCity", + "ibanCountry" + ] + }, + { + "properties": { + "accountHolderGivenName": { + "type": "string" + }, + "accountHolderSurname": { + "type": "string" + }, + "accountHolderCity": { + "type": "string" + }, + "accountHolderCountry": { + "type": "string" + }, + "accountHolderAddress1": { + "type": "string" + }, + "accountHolderAddress2": { + "type": "string" + }, + "accountHolderDistrict": { + "type": "string" + }, + "accountHolderPostalCode": { + "type": "string" + }, + "abaRoutingNumber": { + "type": "string" + }, + "abaAccountNumber": { + "type": "string" + }, + "abaCountry": { + "type": "string" + } + }, + "required": [ + "accountHolderGivenName", + "accountHolderCity", + "accountHolderCountry", + "accountHolderAddress1", + "accountHolderPostalCode", + "abaRoutingNumber", + "abaAccountNumber", + "abaCountry" + ] + }, + { + "properties": { + "speiClabe": { + "type": "string" + }, + "speiName": { + "type": "string" + } + }, + "required": [ + "speiClabe" + ] + } + ] + } + }, + "required": [ + "additionalInfo" + ] + } + ] + } + } + } + } + }, + "delete": { + "summary": "ๅค–้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‹ใ‚‰่ณ‡็”ฃใ‚’ๅ‰Š้™คใ™ใ‚‹", + "description": "IDใงๅค–้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆ่ณ‡็”ฃใ‚’ๅ‰Š้™คใ—ใพใ™.", + "tags": [ + "External wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = fireblocks.delete_external_wallet_asset(walletId, assetId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.deleteExternalWalletAsset(walletId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "ๅ‰Š้™คใ™ใ‚‹ใ‚ขใ‚ปใƒƒใƒˆใฎID", + "schema": { + "type": "string", + "minimum": 1, + "x-fb-entity": "asset" + } + } + ], + "responses": { + "201": { + "description": "ใ‚ใ‹ใ‚Šใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/contracts": { + "get": { + "summary": "ๅฅ‘็ด„ใฎไธ€่ฆง", + "description": "ๅฅ‘็ด„ใฎใƒชใ‚นใƒˆใ‚’ๅ–ๅพ—ใ—ใพใ™.", + "tags": [ + "Contracts" + ], + "responses": { + "200": { + "description": "ๅฅ‘็ด„ใƒชใ‚นใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "ๅฅ‘็ด„ๆ›ธใ‚’ไฝœๆˆใ™ใ‚‹", + "description": "ๆ–ฐใ—ใ„ๅฅ‘็ด„ใ‚’ไฝœๆˆใ—ใพใ™.", + "tags": [ + "Contracts" + ], + "responses": { + "200": { + "description": "ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "type": "string", + "description": "ๅฅ‘็ด„ใฎ่กจ็คบๅ" + } + } + } + } + } + } + } + }, + "/contracts/{contractId}": { + "get": { + "summary": "็‰นๅฎšใฎๅฅ‘็ด„ใ‚’ๆŽขใ™", + "description": "IDใงๅฅ‘็ด„ใ‚’่ฟ”ใ—ใพใ™.", + "tags": [ + "Contracts" + ], + "parameters": [ + { + "in": "path", + "name": "contractId", + "required": true, + "description": "่ฟ”ใ•ใ‚Œใ‚‹ๅฅ‘็ด„ใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "delete": { + "summary": "ๅฅ‘็ด„ใ‚’ๅ‰Š้™คใ™ใ‚‹", + "description": "IDใงๅฅ‘็ด„ใ‚’ๅ‰Š้™คใ—ใพใ™.", + "tags": [ + "Contracts" + ], + "parameters": [ + { + "in": "path", + "name": "contractId", + "required": true, + "description": "ๅ‰Š้™คใ™ใ‚‹ๅฅ‘็ด„ใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "201": { + "description": "ใ‚ใ‹ใ‚Šใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/contracts/{contractId}/{assetId}": { + "get": { + "summary": "ๅฅ‘็ด„่ณ‡็”ฃใ‚’ๆŽขใ™", + "description": "IDใงๅฅ‘็ด„่ณ‡็”ฃใ‚’่ฟ”ใ—ใพใ™.", + "tags": [ + "Contracts" + ], + "parameters": [ + { + "in": "path", + "name": "contractId", + "required": true, + "description": "ๅฅ‘็ด„ใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "่ฟ”ใ•ใ‚Œใ‚‹่ณ‡็”ฃใฎID", + "schema": { + "type": "string", + "minimum": 1, + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚ขใ‚ปใƒƒใƒˆใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ExternalWalletAsset" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "ๅฅ‘็ด„ใซ่ณ‡็”ฃใ‚’่ฟฝๅŠ ใ™ใ‚‹", + "description": "ๆ—ขๅญ˜ใฎๅฅ‘็ด„ใซ่ณ‡็”ฃใ‚’่ฟฝๅŠ ใ—ใพใ™.", + "tags": [ + "Contracts" + ], + "parameters": [ + { + "in": "path", + "name": "contractId", + "required": true, + "description": "ๅฅ‘็ด„ใฎID", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "่ฟฝๅŠ ใ™ใ‚‹ใ‚ขใ‚ปใƒƒใƒˆใฎID", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚ขใ‚ปใƒƒใƒˆใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ExternalWalletAsset" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "address": { + "type": "string", + "description": "ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎๅฅ‘็ด„ใ‚ขใƒ‰ใƒฌใ‚น๏ผˆใพใŸใฏxpub๏ผ‰" + }, + "tag": { + "type": "string", + "description": "XRPใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎๅฎ›ๅ…ˆใ‚ฟใ‚ฐ" + } + }, + "required": [ + "address" + ] + } + } + } + } + }, + "delete": { + "summary": "ๅฅ‘็ด„่ณ‡็”ฃใ‚’ๅ‰Š้™คใ™ใ‚‹", + "description": "IDใงๅฅ‘็ด„่ณ‡็”ฃใ‚’ๅ‰Š้™คใ—ใพใ™.", + "tags": [ + "Contracts" + ], + "parameters": [ + { + "in": "path", + "name": "contractId", + "required": true, + "description": "ๅฅ‘็ด„ใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "ๅ‰Š้™คใ™ใ‚‹ใ‚ขใ‚ปใƒƒใƒˆใฎID", + "schema": { + "type": "string", + "minimum": 1, + "x-fb-entity": "asset" + } + } + ], + "responses": { + "201": { + "description": "ใ‚ใ‹ใ‚Šใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/supported_assets": { + "get": { + "summary": "Fireblocks ใงใ‚ตใƒใƒผใƒˆใ•ใ‚Œใฆใ„ใ‚‹ใ™ในใฆใฎใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใ‚’ไธ€่ฆง่กจ็คบใ—ใพใ™", + "description": "Fireblocks ใงใ‚ตใƒใƒผใƒˆใ•ใ‚Œใฆใ„ใ‚‹ใ™ในใฆใฎใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฟใ‚คใƒ—ใ‚’่ฟ”ใ—ใพใ™.", + "tags": [ + "Blockchains & assets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "supportedAssets = fireblocks.get_supported_assets()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const supportedAssets = await fireblocks.getSupportedAssets();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AssetTypeResponse" + } + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/estimate_network_fee": { + "get": { + "summary": "่ณ‡็”ฃใซๅฟ…่ฆใชๆ‰‹ๆ•ฐๆ–™ใ‚’่ฆ‹็ฉใ‚‚ใ‚‹", + "description": "่ณ‡็”ฃใซๅฟ…่ฆใชๆ‰‹ๆ•ฐๆ–™ใฎ่ฆ‹็ฉใ‚‚ใ‚Šใ‚’ๅ–ๅพ—ใ—ใพใ™ใ€‚UTXOใƒ™ใƒผใ‚นใฎ่ณ‡็”ฃใฎๅ ดๅˆใ€ๅฟœ็ญ”ใซใฏใƒใ‚คใƒˆใ‚ใŸใ‚ŠใฎๆŽจๅฅจๆ‰‹ๆ•ฐๆ–™ใ€ETH/ETCใƒ™ใƒผใ‚นใฎ่ณ‡็”ฃใฎๅ ดๅˆใฏๆŽจๅฅจใ‚ฌใ‚นไพกๆ ผใ€XRP/XLMใฎๅ ดๅˆใฏใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณๆ‰‹ๆ•ฐๆ–™ใŒๅซใพใ‚Œใพใ™ใ€‚.", + "tags": [ + "Blockchains & assets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "fee_result = fireblocks.get_fee_for_asset(asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const feeResult = await fireblocks.getFeeForAsset(assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "query", + "name": "assetId", + "description": "ๆ‰‹ๆ•ฐๆ–™ใ‚’่ฆ‹็ฉใ‚‚ใ‚‹่ณ‡็”ฃ", + "required": true, + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "ๆŽจๅฎšๆ–™้‡‘ใฎๅ›ž็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/EstimatedNetworkFeeResponse" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/transactions/validate_address/{assetId}/{address}": { + "get": { + "summary": "ๅฎ›ๅ…ˆใ‚ขใƒ‰ใƒฌใ‚นใ‚’ๆคœ่จผใ™ใ‚‹", + "description": "ใ‚ขใƒ‰ใƒฌใ‚นใŒๆœ‰ๅŠนใ‹ใฉใ†ใ‹ใ‚’็ขบ่ชใ—ใพใ™๏ผˆXRPใ€DOTใ€XLMใ€EOS ใฎๅ ดๅˆ๏ผ‰.", + "tags": [ + "Blockchains & assets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "const result = await fireblocks.validate_address(assetID, address)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.validateAddress(assetID, address)", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "assetId", + "required": true, + "description": "ใ‚ขใƒ‰ใƒฌใ‚นใฎ่ณ‡็”ฃ", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + }, + { + "in": "path", + "name": "address", + "required": true, + "description": "ๆคœ่จผใ™ใ‚‹ใ‚ขใƒ‰ใƒฌใ‚น", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ValidateAddressResponse" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/transactions": { + "get": { + "summary": "ๅ–ๅผ•ๅฑฅๆญดใฎไธ€่ฆง", + "description": "ใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚นใฎๅ–ๅผ•ๅฑฅๆญดใ‚’ไธ€่ฆง่กจ็คบใ—ใพใ™.", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "transactions = fireblocks.get_transactions(status, after)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const transactions = await fireblocks.getTransactions({\n status: args.status,\nafter: from });\n", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "query", + "name": "before", + "description": "ใƒŸใƒช็ง’ๅ˜ไฝใฎ Unix ใ‚ฟใ‚คใƒ ใ‚นใ‚ฟใƒณใƒ—ใ€‚ๆŒ‡ๅฎšใ•ใ‚ŒใŸๆ—ฅไป˜ใ‚ˆใ‚Šๅ‰ใซไฝœๆˆใ•ใ‚ŒใŸใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎใฟใ‚’่ฟ”ใ—ใพใ™ใ€‚", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "after", + "description": "ใƒŸใƒช็ง’ๅ˜ไฝใฎ Unix ใ‚ฟใ‚คใƒ ใ‚นใ‚ฟใƒณใƒ—ใ€‚ๆŒ‡ๅฎšใ•ใ‚ŒใŸๆ—ฅไป˜ไปฅ้™ใซไฝœๆˆใ•ใ‚ŒใŸใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎใฟใ‚’่ฟ”ใ—ใพใ™ใ€‚", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "status", + "description": "ใ„ใšใ‚Œใ‹ใฎใ‚นใƒ†ใƒผใ‚ฟใ‚นใงใƒ•ใ‚ฃใƒซใ‚ฟใƒชใƒณใ‚ฐใงใใพใ™.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "orderBy", + "description": "็ตๆžœใ‚’ไธฆในๆ›ฟใˆใ‚‹ใƒ•ใ‚ฃใƒผใƒซใƒ‰ **ๆณจ**: createdAt ใงใฏใชใ„ใƒ•ใ‚ฃใƒผใƒซใƒ‰ใงไธฆในๆ›ฟใˆใ‚‹ใจใ€ๆฌกใฎใƒšใƒผใ‚ธใพใŸใฏๅ‰ใฎใƒšใƒผใ‚ธใฎ็ตๆžœใ‚’่ฆๆฑ‚ใ™ใ‚‹ใจใใซๆ›ดๆ–ฐใ‚’ๅ—ใ‘ๅ–ใ‚‹ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใŒ็™บ็”Ÿใ—ใ€ใใ‚Œใ‚‰ใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใŒๆฌ ่ฝใ™ใ‚‹ๅฏ่ƒฝๆ€งใŒใ‚ใ‚Šใพใ™ใ€‚.", + "required": false, + "schema": { + "oneOf": [ + { + "const": "createdAt" + }, + { + "const": "lastUpdated" + } + ] + } + }, + { + "in": "query", + "name": "sort", + "description": "็ตๆžœใ‚’ไธฆในๆ›ฟใˆใ‚‹ๆ–นๅ‘", + "required": false, + "schema": { + "oneOf": [ + { + "const": "ASC" + }, + { + "const": "DESC" + } + ] + } + }, + { + "in": "query", + "name": "limit", + "description": "็ตๆžœใฎๆ•ฐใ‚’ๅˆถ้™ใ—ใพใ™ใ€‚ๆŒ‡ๅฎšใ—ใชใ„ๅ ดๅˆใฏใ€200 ใฎๅˆถ้™ใŒไฝฟ็”จใ•ใ‚Œใพใ™ใ€‚ๆœ€ๅคง่จฑๅฎนๅˆถ้™ใฏ 500 ใงใ™ใ€‚", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "default": 200 + } + }, + { + "in": "query", + "name": "sourceType", + "description": "ๅ–ๅผ•ใฎใ‚ฝใƒผใ‚นใ‚ฟใ‚คใƒ—", + "required": false, + "schema": { + "oneOf": [ + { + "const": "VAULT_ACCOUNT" + }, + { + "const": "EXCHANGE_ACCOUNT" + }, + { + "const": "INTERNAL_WALLET" + }, + { + "const": "EXTERNAL_WALLET" + }, + { + "const": "FIAT_ACCOUNT" + }, + { + "const": "NETWORK_CONNECTION" + }, + { + "const": "COMPOUND" + }, + { + "const": "UNKNOWN" + }, + { + "const": "GAS_STATION" + }, + { + "const": "END_USER_WALLET" + } + ] + } + }, + { + "in": "query", + "name": "sourceId", + "description": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎใ‚ฝใƒผใ‚นID", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "destType", + "description": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎๅฎ›ๅ…ˆใ‚ฟใ‚คใƒ—", + "required": false, + "schema": { + "oneOf": [ + { + "const": "VAULT_ACCOUNT" + }, + { + "const": "EXCHANGE_ACCOUNT" + }, + { + "const": "INTERNAL_WALLET" + }, + { + "const": "EXTERNAL_WALLET" + }, + { + "const": "FIAT_ACCOUNT" + }, + { + "const": "NETWORK_CONNECTION" + }, + { + "const": "COMPOUND" + }, + { + "const": "ONE_TIME_ADDRESS" + }, + { + "const": "END_USER_WALLET" + } + ] + } + }, + { + "in": "query", + "name": "destId", + "description": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎๅฎ›ๅ…ˆID", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "assets", + "description": "ใƒ•ใ‚ฃใƒซใ‚ฟใƒชใƒณใ‚ฐใ™ใ‚‹่ณ‡็”ฃใฎใƒชใ‚นใƒˆ๏ผˆใ‚ซใƒณใƒžใงๅŒบๅˆ‡ใ‚‹๏ผ‰", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "txHash", + "description": "ๆŒ‡ๅฎšใ•ใ‚ŒใŸtxHashใ‚’ๆŒใค็ตๆžœใฎใฟใ‚’่ฟ”ใ—ใพใ™", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "sourceWalletId", + "description": "ใ‚ฝใƒผใ‚นใŒ็‰นๅฎšใฎใ‚จใƒณใƒ‰ใƒฆใƒผใ‚ถใƒผใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใงใ‚ใ‚‹็ตๆžœใฎใฟใ‚’่ฟ”ใ—ใพใ™", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "destWalletId", + "description": "ๅฎ›ๅ…ˆใŒ็‰นๅฎšใฎใ‚จใƒณใƒ‰ใƒฆใƒผใ‚ถใƒผใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใงใ‚ใ‚‹็ตๆžœใฎใฟใ‚’่ฟ”ใ—ใพใ™", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "ๅ–ๅผ•ใƒชใ‚นใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + }, + "next-page": { + "schema": { + "type": "string" + }, + "description": "ๆฌกใฎ็ตๆžœใƒšใƒผใ‚ธใ‚’ๅ—ใ‘ๅ–ใ‚‹ใŸใ‚ใซใ“ใฎ API ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซๆ–ฐใ—ใ„ใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’่กจใ™ URL.", + "in": "header" + }, + "prev-page": { + "schema": { + "type": "string" + }, + "description": "ๅ‰ใฎใƒšใƒผใ‚ธใฎ็ตๆžœใ‚’ๅ—ใ‘ๅ–ใ‚‹ใŸใ‚ใซใ“ใฎ API ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซๆ–ฐใ—ใ„ใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’่กจใ™ URL.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TransactionResponse" + } + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "ๆ–ฐใ—ใ„ๅ–ๅผ•ใ‚’ไฝœๆˆใ™ใ‚‹", + "description": "ๆ–ฐใ—ใ„ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚’ไฝœๆˆใ—ใพใ™.", + "tags": [ + "Transactions" + ], + "parameters": [ + { + "in": "header", + "name": "X-End-User-Wallet-Id", + "schema": { + "$ref": "#/components/headers/X-End-User-Wallet-Id" + } + } + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "tx_result = client.create_transaction( asset_id=\"BTC\", amount=\"50\", source=TransferPeerPath(VAULT_ACCOUNT, from_vault_account_id), destination=DestinationTransferPeerPath(VAULT_ACCOUNT, to_vault_account_id) )\n", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const payload: TransactionArguments = { assetId: asset, source: { type: sourceType, id: sourceId || 0 }, destination: { type: destinationType, id: String(destinationId) }, amount: String(amount), fee: String(fee), note: \"Created by fireblocks SDK\" }; const result = await fireblocks.createTransaction(payload);\n", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateTransactionResponse" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TransactionRequest" + } + } + } + } + } + }, + "/transactions/estimate_fee": { + "post": { + "summary": "ๅ–ๅผ•ๆ‰‹ๆ•ฐๆ–™ใฎ่ฆ‹็ฉใ‚‚ใ‚Š", + "description": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใƒชใ‚ฏใ‚จใ‚นใƒˆใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณๆ‰‹ๆ•ฐๆ–™ใ‚’่ฆ‹็ฉใ‚‚ใ‚Šใพใ™ใ€‚ * ๆณจ: ZCash (ZEC) ใ‚’้™คใใ™ในใฆใฎ Fireblocks ใ‚ขใ‚ปใƒƒใƒˆใ‚’ใ‚ตใƒใƒผใƒˆใ—ใพใ™ใ€‚.", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "estimated_fee = client.estimate_fee_for_transaction( asset_id=\"BTC\", amount=\"50\", source=TransferPeerPath(VAULT_ACCOUNT, from_vault_account_id), destination=DestinationTransferPeerPath(VAULT_ACCOUNT, to_vault_account_id) )\n", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const payload: TransactionArguments = { assetId: asset, source: { type: sourceType, id: sourceId || 0 }, destination: { type: destinationType, id: String(destinationId) }, amount: Number(amount) }; const estimatedFee = await fireblocks.estimateFeeForTransaction(payload);\n", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TransactionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "ๆŽจๅฎšๆ–™้‡‘ใฎๅ›ž็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/EstimatedTransactionFeeResponse" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/transactions/{txId}": { + "get": { + "summary": "Fireblocks ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณ ID ใง็‰นๅฎšใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚’ๆคœ็ดขใ™ใ‚‹", + "description": "IDใงใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚’่ฟ”ใ—ใพใ™.", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "tx = fireblocks.get_transaction_by_id(txId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const tx = await fireblocks.getTransactionById(txId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "txId", + "required": true, + "example": "00000000-0000-0000-0000-000000000000", + "description": "่ฟ”ใ•ใ‚Œใ‚‹ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/TransactionResponse" + } + } + } + }, + "400": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/transactions/external_tx_id/{externalTxId}/": { + "get": { + "summary": "ๅค–้ƒจใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณIDใง็‰นๅฎšใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚’ๆคœ็ดขใ™ใ‚‹", + "description": "ๅค–้ƒจใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณIDใงใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚’่ฟ”ใ—ใพใ™.", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "tx = fireblocks.get_transaction_by_external_tx_id(externalTxId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const tx = await fireblocks.getTransactionByExternalTxId(externalTxId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "externalTxId", + "example": "00000000-0000-0000-0000-000000000000", + "required": true, + "description": "่ฟ”ใ•ใ‚Œใ‚‹ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎๅค–้ƒจID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/TransactionResponse" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/transactions/{txId}/set_confirmation_threshold": { + "post": { + "summary": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณIDใซใ‚ˆใ‚‹็ขบ่ชใ—ใใ„ๅ€คใฎ่จญๅฎš", + "description": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณIDใซใ‚ˆใฃใฆใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณๅฎŒไบ†ใซๅฟ…่ฆใช็ขบ่ชๅ›žๆ•ฐใ‚’ไธŠๆ›ธใใ—ใพใ™.", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "set_conf_threshold = client.set_confirmation_threshold_by_tx_id(body)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const setConfThreshold = await fireblocks.setConfirmationThresholdByTxId(body);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SetConfirmationsThresholdRequest" + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "txId", + "required": true, + "description": "ๅ–ๅผ•ใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ๆญฃๅธธใซ่จญๅฎšใ•ใ‚Œใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SetConfirmationsThresholdResponse" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/transactions/{txId}/drop": { + "post": { + "summary": "IDใซใ‚ˆใ‚‹ETHใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎใƒ‰ใƒญใƒƒใƒ—", + "description": "ใ‚นใ‚ฟใƒƒใ‚ฏใ—ใŸETHใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚’ๅ‰Š้™คใ—ใ€ไปฃใ‚ใ‚Šใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚’ไฝœๆˆใ—ใพใ™.", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = fireblocks.drop_transaction(txId, fee_level)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.dropTransaction(txId, feeLevel);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DropTransactionRequest" + } + } + } + }, + "parameters": [ + { + "in": "header", + "name": "X-End-User-Wallet-Id", + "schema": { + "$ref": "#/components/headers/X-End-User-Wallet-Id" + } + }, + { + "in": "path", + "name": "txId", + "required": true, + "description": "ๅ–ๅผ•ใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ๆญฃๅธธใซไฝœๆˆใ•ใ‚Œใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/DropTransactionResponse" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/transactions/{txId}/cancel": { + "post": { + "summary": "ๅ–ๅผ•ใ‚’ใ‚ญใƒฃใƒณใ‚ปใƒซใ™ใ‚‹", + "description": "IDใงๅ–ๅผ•ใ‚’ใ‚ญใƒฃใƒณใ‚ปใƒซใ™ใ‚‹.", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = fireblocks.cancel_transaction_by_id(txId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.cancelTransactionById(txId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "header", + "name": "X-End-User-Wallet-Id", + "schema": { + "$ref": "#/components/headers/X-End-User-Wallet-Id" + } + }, + { + "in": "path", + "name": "txId", + "required": true, + "description": "ใ‚ญใƒฃใƒณใ‚ปใƒซใ™ใ‚‹ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CancelTransactionResponse" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/transactions/{txId}/freeze": { + "post": { + "summary": "ๅ–ๅผ•ใ‚’ๅ‡็ตใ™ใ‚‹", + "description": "IDใงๅ–ๅผ•ใ‚’ๅ‡็ตใ™ใ‚‹.", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = fireblocks.freeze_transaction(txId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.freezeTransaction(txId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "header", + "name": "X-End-User-Wallet-Id", + "schema": { + "$ref": "#/components/headers/X-End-User-Wallet-Id" + } + }, + { + "in": "path", + "name": "txId", + "required": true, + "description": "ๅ‡็ตใ™ใ‚‹ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ใƒ•ใƒชใƒผใ‚บๅๅฟœ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/FreezeTransactionResponse" + } + } + } + } + } + } + }, + "/transactions/{txId}/unfreeze": { + "post": { + "summary": "ๅ–ๅผ•ใฎๅ‡็ตใ‚’่งฃ้™คใ™ใ‚‹", + "description": "ID ใซใ‚ˆใฃใฆใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚’ๅ‡็ต่งฃ้™คใ—ใ€ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚’ๅ†ใณๅˆฉ็”จใงใใ‚‹ใ‚ˆใ†ใซใ—ใพใ™ใ€‚.", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = fireblocks.unfreeze_transaction(txId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.unfreezeTransaction(txId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "header", + "name": "X-End-User-Wallet-Id", + "schema": { + "$ref": "#/components/headers/X-End-User-Wallet-Id" + } + }, + { + "in": "path", + "name": "txId", + "required": true, + "description": "ๅ‡็ต่งฃ้™คใ™ใ‚‹ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ๅฟœ็ญ”ใ‚’่งฃๅ‡ใ™ใ‚‹", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/UnfreezeTransactionResponse" + } + } + } + } + } + } + }, + "/txHash/{txHash}/set_confirmation_threshold": { + "post": { + "summary": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใƒใƒƒใ‚ทใƒฅใซใ‚ˆใ‚‹็ขบ่ชใ—ใใ„ๅ€คใ‚’่จญๅฎšใ™ใ‚‹", + "description": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใƒใƒƒใ‚ทใƒฅใซใ‚ˆใ‚‹ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณๅฎŒไบ†ใซๅฟ…่ฆใช็ขบ่ชๅ›žๆ•ฐใ‚’ไธŠๆ›ธใใ™ใ‚‹.", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "set_conf_threshold = client.set_confirmation_threshold_by_tx_hash(body)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const setConfThreshold = await fireblocks.setConfirmationThresholdByTxHash(body);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SetConfirmationsThresholdRequest" + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "txHash", + "required": true, + "description": "TxHash ใฏ", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ๅค‰ๆ›ดใฎๅฝฑ้Ÿฟใ‚’ๅ—ใ‘ใ‚‹ๅ–ๅผ•ใฎใƒชใ‚นใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SetConfirmationsThresholdResponse" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/payments/xb-settlements/configs": { + "post": { + "tags": [ + "Payments - cross-border settlement" + ], + "summary": "ๆ–ฐใ—ใ„่ถŠๅขƒๆฑบๆธˆๆง‹ๆˆใ‚’ไฝœๆˆใ™ใ‚‹", + "description": "ๆ–ฐใ—ใ„ๅ›ฝๅขƒใ‚’่ถŠใˆใŸๆฑบๆธˆๆง‹ๆˆใ‚’ไฝœๆˆใ—ใพใ™ใ€‚
ๆง‹ๆˆใงใฏใ€ๅ›ฝๅขƒใ‚’่ถŠใˆใŸๆฑบๆธˆใซไฝฟ็”จใ™ใ‚‹ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใฎ่ณ‡็”ฃใ€ใ‚ชใƒณใƒฉใƒณใƒ—ใ€ใ‚ชใƒ•ใƒฉใƒณใƒ—ใ‚’ๅฎš็พฉใ—ใพใ™ใ€‚
ๆง‹ๆˆใซใฏใ€ๅฐ‘ใชใใจใ‚‚ `ON_RAMP` ใจ `VAULT_ACCOUNT` ใฎ 2 ใคใฎใ‚นใƒ†ใƒƒใƒ—ใŒๅซใพใ‚Œใฆใ„ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚
ใใฎไป–ใฎใ™ในใฆใฎใ‚นใƒ†ใƒƒใƒ— (ไพ‹: `OFF_RAMP`ใ€`FIAT_DESTINATION` ใชใฉ) ใฏใ‚ชใƒ—ใ‚ทใƒงใƒณใงใ™ใ€‚
ๅ„ใ‚นใƒ†ใƒƒใƒ—ใซใฏใ€ไฝฟ็”จใ™ใ‚‹ `accountId` ใ‚’ๅซใ‚ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใŒใ€`inputAssetId` ใจ `outputAssetId` ใฏใ‚ชใƒ—ใ‚ทใƒงใƒณใงใ™ใ€‚ใ“ใ‚Œใ‚‰ใŒๆŒ‡ๅฎšใ•ใ‚Œใฆใ„ใชใ„ๅ ดๅˆใฏใ€Corridor Settings ใฎใƒ‡ใƒ•ใ‚ฉใƒซใƒˆๅ€คใŒไฝฟ็”จใ•ใ‚Œใพใ™ใ€‚
ใ„ใšใ‚Œใ‹ใฎใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆใซ inputAssetId ใพใŸใฏ outputAssetId ใŒๆŒ‡ๅฎšใ•ใ‚Œใฆใ„ใ‚‹ๅ ดๅˆใ€ใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆๅ†…ใฎใ™ในใฆใฎ่ณ‡็”ฃใฏไธ€่‡ดใ—ใฆใ„ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚ใŸใจใˆใฐใ€ON_RAMP ใฎๅ‡บๅŠ›่ณ‡็”ฃใŒ XLM_USDC_5F3T ใฎๅ ดๅˆใ€VAULT_ACCOUNT ใฎๅ…ฅๅŠ›่ณ‡็”ฃใ‚‚ XLM_USDC_5F3T ใงใ‚ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚
่จญๅฎšใซๅฟœใ˜ใฆใ‚นใƒชใƒƒใƒšใƒผใ‚ธ้‡ใ‚’่จญๅฎšใงใใพใ™ใ€‚ใ‚นใƒชใƒƒใƒšใƒผใ‚ธใฏใƒ™ใƒผใ‚ทใ‚น ใƒใ‚คใƒณใƒˆ (bps) ใงๅฎš็พฉใ•ใ‚Œใพใ™ใ€‚ใ“ใฎๅ€คใฏๅฎŸ่กŒๆ™‚ใซใ‚ชใƒผใƒใƒผใƒญใƒผใƒ‰ใ•ใ‚Œใ‚‹ๅฏ่ƒฝๆ€งใŒใ‚ใ‚Šใพใ™ใ€‚ใ‚นใƒชใƒƒใƒšใƒผใ‚ธ้‡ใ‚’่จญๅฎšใ—ใชใ„ๅ ดๅˆใฏใ€ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใฎใ‚นใƒชใƒƒใƒšใƒผใ‚ธ 10000 bps (10%) ใŒไฝฟ็”จใ•ใ‚Œใพใ™ใ€‚
**ๆณจ:** ใ“ใฎใ‚ปใ‚ฏใ‚ทใƒงใƒณใฎๅ‚็…งใ‚ณใƒณใƒ†ใƒณใƒ„ใฏใ€Payments Engine ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซใคใ„ใฆ่ชฌๆ˜Žใ—ใฆใ„ใพใ™ใ€‚Payments Engine ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซใฏใ€ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใง Payments Engine ใŒๆœ‰ๅŠนใซใชใฃใฆใ„ใ‚‹้กงๅฎขใฎใฟใŒๅˆฉ็”จใงใใ‚‹ API ใŒๅซใพใ‚Œใฆใ„ใพใ™ใ€‚ใ“ใ‚Œใ‚‰ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฏ็พๅœจใƒ™ใƒผใ‚ฟ็‰ˆใงใ‚ใ‚Šใ€ๅค‰ๆ›ดใ•ใ‚Œใ‚‹ๅฏ่ƒฝๆ€งใŒใ‚ใ‚Šใพใ™ใ€‚Fireblocks Payments Engine ใซใคใ„ใฆ่ฉณใ—ใ็Ÿฅใ‚ŠใŸใ„ๅ ดๅˆใฏใ€Fireblocks ใ‚ซใ‚นใ‚ฟใƒžใƒผ ใ‚ตใ‚ฏใ‚ปใ‚น ใƒžใƒใƒผใ‚ธใƒฃใƒผใซๅ•ใ„ๅˆใ‚ใ›ใ‚‹ใ‹ใ€CSM@fireblocks.com ใซใƒกใƒผใƒซใ‚’้€ไฟกใ—ใฆใใ ใ•ใ„ใ€‚.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementConfigCreationRequestBody" + }, + "example": { + "name": "Flow Config Example", + "corridorId": "CO_US", + "steps": { + "ON_RAMP": { + "accountId": "3b7a1451-3453-4c96-a6a5-683cc8971d04" + }, + "VAULT_ACCOUNT": { + "accountId": "2" + }, + "OFF_RAMP": { + "accountId": "f2f74204-93ec-4614-870a-4ea2ad13aa0b" + } + }, + "conversionSlippageBasisPoints": 75 + } + } + } + }, + "responses": { + "200": { + "description": "ๅ›ฝๅขƒใ‚’่ถŠใˆใŸๆฑบๆธˆ่จญๅฎšใŒๆญฃๅธธใซไฝœๆˆใ•ใ‚Œใพใ—ใŸ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementConfigCreationResponse" + }, + "example": { + "configId": "074791cc-ef32-4920-8373-95efbeea66c5", + "corridorId": "CO_US", + "name": "Flow Config Example", + "steps": { + "ON_RAMP": { + "accountId": "3b7a1451-3453-4c96-a6a5-683cc8971d04", + "inputAssetId": "COP", + "outputAssetId": "USD" + }, + "VAULT_ACCOUNT": { + "accountId": "2", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + }, + "OFF_RAMP": { + "accountId": "f2f74204-93ec-4614-870a-4ea2ad13aa0b", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + } + }, + "conversionSlippageBasisPoints": 75, + "createdAt": 1680625226267 + } + } + } + }, + "400": { + "description": "ๅ›ฝๅขƒใ‚’่ถŠใˆใŸใƒชใ‚ฏใ‚จใ‚นใƒˆใฎไฝœๆˆไธญใซใ‚จใƒฉใƒผใŒ็™บ็”Ÿใ—ใพใ—ใŸ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "่จฑๅฏใ•ใ‚Œใฆใ„ใพใ›ใ‚“ใ€‚Authorization ใƒ˜ใƒƒใƒ€ใƒผใซ JWT ใƒˆใƒผใ‚ฏใƒณใŒ่ฆ‹ใคใ‹ใ‚‰ใชใ„ใ‹็„กๅŠนใงใ™.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "ๅ†…้ƒจใ‚จใƒฉใƒผ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "get": { + "tags": [ + "Payments - cross-border settlement" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "summary": "ๅ›ฝๅขƒใ‚’่ถŠใˆใŸๆฑบๆธˆ่จญๅฎšใ‚’ใ™ในใฆๅ–ๅพ—", + "description": "ใ™ในใฆใฎๅ›ฝๅขƒใ‚’่ถŠใˆใŸๆฑบๆธˆๆง‹ๆˆใ‚’ๅ–ๅพ—ใ—ใพใ™ใ€‚
**ๆณจ:** ใ“ใฎใ‚ปใ‚ฏใ‚ทใƒงใƒณใฎๅ‚็…งใ‚ณใƒณใƒ†ใƒณใƒ„ใฏใ€Payments Engine ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซใคใ„ใฆ่ชฌๆ˜Žใ—ใฆใ„ใพใ™ใ€‚Payments Engine ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซใฏใ€ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใง Payments Engine ใŒๆœ‰ๅŠนใซใชใฃใฆใ„ใ‚‹้กงๅฎขใฎใฟใŒๅˆฉ็”จใงใใ‚‹ API ใŒๅซใพใ‚Œใฆใ„ใพใ™ใ€‚ใ“ใ‚Œใ‚‰ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฏ็พๅœจใƒ™ใƒผใ‚ฟ็‰ˆใงใ‚ใ‚Šใ€ๅค‰ๆ›ดใ•ใ‚Œใ‚‹ๅฏ่ƒฝๆ€งใŒใ‚ใ‚Šใพใ™ใ€‚Fireblocks Payments Engine ใซใคใ„ใฆ่ฉณใ—ใ็Ÿฅใ‚ŠใŸใ„ๅ ดๅˆใฏใ€Fireblocks ใ‚ซใ‚นใ‚ฟใƒžใƒผ ใ‚ตใ‚ฏใ‚ปใ‚น ใƒžใƒใƒผใ‚ธใƒฃใƒผใซๅ•ใ„ๅˆใ‚ใ›ใ‚‹ใ‹ใ€CSM@fireblocks.com ใซใƒกใƒผใƒซใ‚’้€ไฟกใ—ใฆใใ ใ•ใ„ใ€‚.", + "responses": { + "200": { + "description": "ใ™ในใฆใฎๅ›ฝๅขƒใ‚’่ถŠใˆใŸๆฑบๆธˆ่จญๅฎšใ‚’่ฟ”ใ—ใพใ™", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementGetAllConfigsResponse" + }, + "example": { + "configurations": [ + { + "configId": "074791cc-ef32-4920-8373-95efbeea66c5", + "corridorId": "CO_US", + "name": "Flow Config Example", + "steps": { + "ON_RAMP": { + "accountId": "3b7a1451-3453-4c96-a6a5-683cc8971d04", + "inputAssetId": "COP", + "outputAssetId": "USD" + }, + "VAULT_ACCOUNT": { + "accountId": "2", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + }, + "OFF_RAMP": { + "accountId": "f2f74204-93ec-4614-870a-4ea2ad13aa0b", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + } + }, + "conversionSlippageBasisPoints": 75, + "createdAt": 1680625226267 + }, + { + "configId": "a4b0a706-4578-4467-bd5b-a852761dd2aa", + "corridorId": "MX_US", + "name": "MX to US flow", + "steps": { + "ON_RAMP": { + "accountId": "3d6241ad-879b-4a11-842f-4cee9cd7fbba", + "inputAssetId": "MXN", + "outputAssetId": "USD" + }, + "VAULT_ACCOUNT": { + "accountId": "1", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + }, + "OFF_RAMP": { + "accountId": "1cf7f750-117f-4c36-b4ef-14c420d118ce", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + } + }, + "conversionSlippageBasisPoints": 10, + "createdAt": 1665166171134 + } + ] + } + } + } + }, + "401": { + "description": "่จฑๅฏใ•ใ‚Œใฆใ„ใพใ›ใ‚“ใ€‚Authorization ใƒ˜ใƒƒใƒ€ใƒผใซ JWT ใƒˆใƒผใ‚ฏใƒณใŒ่ฆ‹ใคใ‹ใ‚‰ใชใ„ใ‹็„กๅŠนใงใ™.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "ๅ†…้ƒจใ‚จใƒฉใƒผ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/payments/xb-settlements/configs/{configId}": { + "get": { + "tags": [ + "Payments - cross-border settlement" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "summary": "็‰นๅฎšใฎ่ถŠๅขƒๆฑบๆธˆๆง‹ๆˆใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "description": "็‰นๅฎšใฎๅ›ฝๅขƒใ‚’่ถŠใˆใŸๆฑบๆธˆๆง‹ๆˆใ‚’ๅ–ๅพ—ใ—ใพใ™ใ€‚
**ๆณจ:** ใ“ใฎใ‚ปใ‚ฏใ‚ทใƒงใƒณใฎๅ‚็…งใ‚ณใƒณใƒ†ใƒณใƒ„ใฏใ€Payments Engine ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซใคใ„ใฆ่ชฌๆ˜Žใ—ใฆใ„ใพใ™ใ€‚Payments Engine ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซใฏใ€ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใง Payments Engine ใŒๆœ‰ๅŠนใซใชใฃใฆใ„ใ‚‹้กงๅฎขใฎใฟใŒๅˆฉ็”จใงใใ‚‹ API ใŒๅซใพใ‚Œใฆใ„ใพใ™ใ€‚ใ“ใ‚Œใ‚‰ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฏ็พๅœจใƒ™ใƒผใ‚ฟ็‰ˆใงใ‚ใ‚Šใ€ๅค‰ๆ›ดใ•ใ‚Œใ‚‹ๅฏ่ƒฝๆ€งใŒใ‚ใ‚Šใพใ™ใ€‚Fireblocks Payments Engine ใซใคใ„ใฆ่ฉณใ—ใ็Ÿฅใ‚ŠใŸใ„ๅ ดๅˆใฏใ€Fireblocks ใ‚ซใ‚นใ‚ฟใƒžใƒผ ใ‚ตใ‚ฏใ‚ปใ‚น ใƒžใƒใƒผใ‚ธใƒฃใƒผใซๅ•ใ„ๅˆใ‚ใ›ใ‚‹ใ‹ใ€CSM@fireblocks.com ใซใƒกใƒผใƒซใ‚’้€ไฟกใ—ใฆใใ ใ•ใ„ใ€‚.", + "parameters": [ + { + "in": "path", + "name": "configId", + "required": true, + "description": "ๅ›ฝๅขƒใ‚’่ถŠใˆใŸๆฑบๆธˆ่จญๅฎšID.", + "schema": { + "type": "string" + }, + "example": "074791cc-ef32-4920-8373-95efbeea66c5" + } + ], + "responses": { + "200": { + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸๅ›ฝๅขƒใ‚’่ถŠใˆใŸๆฑบๆธˆ่จญๅฎšใ‚’่ฟ”ใ—ใพใ™", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementGetConfigResponse" + }, + "example": { + "configId": "074791cc-ef32-4920-8373-95efbeea66c5", + "corridorId": "CO_US", + "name": "Flow Config Example", + "steps": { + "ON_RAMP": { + "accountId": "3b7a1451-3453-4c96-a6a5-683cc8971d04", + "inputAssetId": "COP", + "outputAssetId": "USD" + }, + "VAULT_ACCOUNT": { + "accountId": "2", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + }, + "OFF_RAMP": { + "accountId": "f2f74204-93ec-4614-870a-4ea2ad13aa0b", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + } + }, + "conversionSlippageBasisPoints": 75, + "createdAt": 1680625226267 + } + } + } + }, + "401": { + "description": "่จฑๅฏใ•ใ‚Œใฆใ„ใพใ›ใ‚“ใ€‚Authorization ใƒ˜ใƒƒใƒ€ใƒผใซ JWT ใƒˆใƒผใ‚ฏใƒณใŒ่ฆ‹ใคใ‹ใ‚‰ใชใ„ใ‹็„กๅŠนใงใ™.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "ๆไพ›ใ•ใ‚ŒใŸIDใงใฏๅ›ฝๅขƒใ‚’่ถŠใˆใŸๆฑบๆธˆ่จญๅฎšใฏๅญ˜ๅœจใ—ใพใ›ใ‚“.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "ๅ†…้ƒจใ‚จใƒฉใƒผ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "Payments - cross-border settlement" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "summary": "ๅ›ฝๅขƒใ‚’่ถŠใˆใŸๆฑบๆธˆ่จญๅฎšใ‚’็ทจ้›†ใ™ใ‚‹", + "description": "ๅ›ฝๅขƒใ‚’่ถŠใˆใŸๆฑบๆธˆใฎ่จญๅฎšใ‚’็ทจ้›†ใ—ใพใ™ใ€‚่จญๅฎšใ‚’็ทจ้›†ใ—ใฆใ‚‚ใ€ใใฎ่จญๅฎšใ‚’ไฝฟ็”จใ—ใฆไปฅๅ‰ใซๅฎŸ่กŒใ•ใ‚ŒใŸใƒ•ใƒญใƒผใซใฏๅฝฑ้Ÿฟใ—ใพใ›ใ‚“ใ€‚**ๆณจ:** ใ“ใฎใ‚ปใ‚ฏใ‚ทใƒงใƒณใฎๅ‚็…งใ‚ณใƒณใƒ†ใƒณใƒ„ใฏใ€ๆ”ฏๆ‰•ใ„ใ‚จใƒณใ‚ธใƒณ ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซใคใ„ใฆ่ชฌๆ˜Žใ—ใฆใ„ใพใ™ใ€‚ๆ”ฏๆ‰•ใ„ใ‚จใƒณใ‚ธใƒณ ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซใฏใ€ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใงๆ”ฏๆ‰•ใ„ใ‚จใƒณใ‚ธใƒณใŒๆœ‰ๅŠนใซใชใฃใฆใ„ใ‚‹้กงๅฎขใฎใฟใŒๅˆฉ็”จใงใใ‚‹ API ใŒๅซใพใ‚Œใฆใ„ใพใ™ใ€‚ใ“ใ‚Œใ‚‰ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฏ็พๅœจใƒ™ใƒผใ‚ฟ็‰ˆใงใ‚ใ‚Šใ€ๅค‰ๆ›ดใ•ใ‚Œใ‚‹ๅฏ่ƒฝๆ€งใŒใ‚ใ‚Šใพใ™ใ€‚Fireblocks ๆ”ฏๆ‰•ใ„ใ‚จใƒณใ‚ธใƒณใซใคใ„ใฆ่ฉณใ—ใ็Ÿฅใ‚ŠใŸใ„ๅ ดๅˆใฏใ€Fireblocks ใ‚ซใ‚นใ‚ฟใƒžใƒผ ใ‚ตใ‚ฏใ‚ปใ‚น ใƒžใƒใƒผใ‚ธใƒฃใƒผใซๅ•ใ„ๅˆใ‚ใ›ใ‚‹ใ‹ใ€CSM@fireblocks.com ใซใƒกใƒผใƒซใ‚’้€ไฟกใ—ใฆใใ ใ•ใ„ใ€‚.", + "parameters": [ + { + "in": "path", + "name": "configId", + "required": true, + "description": "ๅ›ฝๅขƒใ‚’่ถŠใˆใŸๆฑบๆธˆ่จญๅฎšID.", + "schema": { + "type": "string" + }, + "example": "074791cc-ef32-4920-8373-95efbeea66c5" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementConfigEditRequestBody" + }, + "example": { + "name": "Flow Config Example - Edited", + "steps": { + "ON_RAMP": { + "accountId": "e9dec04a-3c57-4052-a89a-288c545f6430" + }, + "VAULT_ACCOUNT": { + "accountId": "2" + }, + "OFF_RAMP": { + "accountId": "f2f74204-93ec-4614-870a-4ea2ad13aa0b" + } + }, + "corridorId": "CO_US", + "conversionSlippageBasisPoints": 30 + } + } + } + }, + "responses": { + "200": { + "description": "ๅ›ฝๅขƒใ‚’่ถŠใˆใŸๆฑบๆธˆใฎ่จญๅฎšใŒๆญฃๅธธใซ็ทจ้›†ใ•ใ‚Œใพใ—ใŸ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementConfigEditResponse" + }, + "example": { + "configId": "074791cc-ef32-4920-8373-95efbeea66c5", + "corridorId": "CO_US", + "name": "Flow Config Example - Edited", + "steps": { + "ON_RAMP": { + "accountId": "e9dec04a-3c57-4052-a89a-288c545f6430", + "inputAssetId": "COP", + "outputAssetId": "USD" + }, + "VAULT_ACCOUNT": { + "accountId": "2", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + }, + "OFF_RAMP": { + "accountId": "f2f74204-93ec-4614-870a-4ea2ad13aa0b", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + } + }, + "conversionSlippageBasisPoints": 30, + "createdAt": 1680625226267 + } + } + } + }, + "400": { + "description": "ๅ›ฝๅขƒใ‚’่ถŠใˆใŸใƒชใ‚ฏใ‚จใ‚นใƒˆใฎไฝœๆˆไธญใซใ‚จใƒฉใƒผใŒ็™บ็”Ÿใ—ใพใ—ใŸใ€‚ๆง‹ๆˆใฏๅค‰ๆ›ดใ•ใ‚Œใฆใ„ใพใ›ใ‚“.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "่จฑๅฏใ•ใ‚Œใฆใ„ใพใ›ใ‚“ใ€‚Authorization ใƒ˜ใƒƒใƒ€ใƒผใซ JWT ใƒˆใƒผใ‚ฏใƒณใŒ่ฆ‹ใคใ‹ใ‚‰ใชใ„ใ‹็„กๅŠนใงใ™.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "ๆไพ›ใ•ใ‚ŒใŸIDใงใฏๅ›ฝๅขƒใ‚’่ถŠใˆใŸๆฑบๆธˆ่จญๅฎšใฏๅญ˜ๅœจใ—ใพใ›ใ‚“.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "ๅ†…้ƒจใ‚จใƒฉใƒผ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Payments - cross-border settlement" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "configId", + "required": true, + "description": "ๅ›ฝๅขƒใ‚’่ถŠใˆใŸๆฑบๆธˆ่จญๅฎšID.", + "schema": { + "type": "string" + }, + "example": "074791cc-ef32-4920-8373-95efbeea66c5" + } + ], + "summary": "ๅ›ฝๅขƒใ‚’่ถŠใˆใŸๆฑบๆธˆ่จญๅฎšใ‚’ๅ‰Š้™คใ™ใ‚‹", + "description": "ๅ›ฝๅขƒใ‚’่ถŠใˆใŸๆฑบๆธˆ่จญๅฎšใ‚’ๅ‰Š้™คใ—ใพใ™ใ€‚ใ“ใฎ่จญๅฎšใ‚’ไฝฟ็”จใ—ใฆไปฅๅ‰ใซๅฎŸ่กŒใ•ใ‚ŒใŸใƒ•ใƒญใƒผใฏๅ‰Š้™คใ•ใ‚Œใพใ›ใ‚“ใ€‚**ๆณจ:** ใ“ใฎใ‚ปใ‚ฏใ‚ทใƒงใƒณใฎๅ‚็…งใ‚ณใƒณใƒ†ใƒณใƒ„ใฏใ€ๆ”ฏๆ‰•ใ„ใ‚จใƒณใ‚ธใƒณ ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซใคใ„ใฆ่ชฌๆ˜Žใ—ใฆใ„ใพใ™ใ€‚ๆ”ฏๆ‰•ใ„ใ‚จใƒณใ‚ธใƒณ ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซใฏใ€ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใงๆ”ฏๆ‰•ใ„ใ‚จใƒณใ‚ธใƒณใŒๆœ‰ๅŠนใซใชใฃใฆใ„ใ‚‹้กงๅฎขใฎใฟใŒๅˆฉ็”จใงใใ‚‹ API ใŒๅซใพใ‚Œใฆใ„ใพใ™ใ€‚ใ“ใ‚Œใ‚‰ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฏ็พๅœจใƒ™ใƒผใ‚ฟ็‰ˆใงใ‚ใ‚Šใ€ๅค‰ๆ›ดใ•ใ‚Œใ‚‹ๅฏ่ƒฝๆ€งใŒใ‚ใ‚Šใพใ™ใ€‚Fireblocks ๆ”ฏๆ‰•ใ„ใ‚จใƒณใ‚ธใƒณใซใคใ„ใฆ่ฉณใ—ใ็Ÿฅใ‚ŠใŸใ„ๅ ดๅˆใฏใ€Fireblocks ใ‚ซใ‚นใ‚ฟใƒžใƒผ ใ‚ตใ‚ฏใ‚ปใ‚น ใƒžใƒใƒผใ‚ธใƒฃใƒผใซๅ•ใ„ๅˆใ‚ใ›ใ‚‹ใ‹ใ€CSM@fireblocks.com ใซใƒกใƒผใƒซใ‚’้€ไฟกใ—ใฆใใ ใ•ใ„ใ€‚.", + "responses": { + "200": { + "description": "ๅ›ฝๅขƒใ‚’่ถŠใˆใŸๆฑบๆธˆ่จญๅฎšใŒๆญฃๅธธใซๅ‰Š้™คใ•ใ‚Œใพใ—ใŸใ€‚ๅ‰Š้™คใ•ใ‚ŒใŸ่จญๅฎšใ‚’่ฟ”ใ—ใพใ™.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementConfigDeletionResponse" + }, + "example": { + "configId": "074791cc-ef32-4920-8373-95efbeea66c5", + "corridorId": "CO_US", + "name": "Flow Config Example - Edited", + "steps": { + "ON_RAMP": { + "accountId": "e9dec04a-3c57-4052-a89a-288c545f6430", + "inputAssetId": "COP", + "outputAssetId": "USD" + }, + "VAULT_ACCOUNT": { + "accountId": "2", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + }, + "OFF_RAMP": { + "accountId": "f2f74204-93ec-4614-870a-4ea2ad13aa0b", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + } + }, + "conversionSlippageBasisPoints": 30, + "createdAt": 1680625226267 + } + } + } + }, + "401": { + "description": "่จฑๅฏใ•ใ‚Œใฆใ„ใพใ›ใ‚“ใ€‚Authorization ใƒ˜ใƒƒใƒ€ใƒผใซ JWT ใƒˆใƒผใ‚ฏใƒณใŒ่ฆ‹ใคใ‹ใ‚‰ใชใ„ใ‹็„กๅŠนใงใ™.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "ๆไพ›ใ•ใ‚ŒใŸIDใงใฏๅ›ฝๅขƒใ‚’่ถŠใˆใŸๆฑบๆธˆ่จญๅฎšใฏๅญ˜ๅœจใ—ใพใ›ใ‚“.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "ๅ†…้ƒจใ‚จใƒฉใƒผ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/payments/xb-settlements/flows": { + "post": { + "tags": [ + "Payments - cross-border settlement" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "summary": "ๆ–ฐใŸใช่ถŠๅขƒๆฑบๆธˆใƒ•ใƒญใƒผใฎๆง‹็ฏ‰", + "description": "้€้‡‘ใ™ใ‚‹้‡‘้กใ‚’ๆŒ‡ๅฎšใ—ใฆใ€ใ‚ฏใƒญใ‚นใƒœใƒผใƒ€ใƒผใƒ•ใƒญใƒผ๏ผˆใ‚ฏใƒญใ‚นใƒœใƒผใƒ€ใƒผ่จญๅฎšใซๅŸบใฅใ๏ผ‰ใ‚’ไฝœๆˆใ—ใพใ™ใ€‚assetId ใฏใ‚ฏใƒญใ‚นใƒœใƒผใƒ€ใƒผ่จญๅฎšใซใ‚ˆใฃใฆๅฎš็พฉใ•ใ‚Œใพใ™ใ€‚ใƒ•ใƒญใƒผใ‚’ไฝœๆˆใ™ใ‚‹ใจใ€ๆŒ‡ๅฎšใ•ใ‚ŒใŸ้‡‘้กใซๅŸบใฅใ„ใฆใ€FX ใƒฌใƒผใƒˆใ€ๆ™‚้–“ใ€ๆ‰‹ๆ•ฐๆ–™ใชใฉใฎใƒ•ใƒญใƒผๆŽจๅฎšๅ€คใฎ่จˆ็ฎ—ใŒใƒˆใƒชใ‚ฌใƒผใ•ใ‚Œใพใ™ใ€‚ใ‚ฏใƒญใ‚นใƒœใƒผใƒ€ใƒผใƒ•ใƒญใƒผใ‚’ไฝœๆˆใ—ใฆใ‚‚ใ€ใƒ•ใƒญใƒผใฏๅฎŸ่กŒใ•ใ‚Œใพใ›ใ‚“ใ€‚**ๆณจ:** ใ“ใฎใ‚ปใ‚ฏใ‚ทใƒงใƒณใฎๅ‚็…งใ‚ณใƒณใƒ†ใƒณใƒ„ใฏใ€ๆ”ฏๆ‰•ใ„ใ‚จใƒณใ‚ธใƒณใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซใคใ„ใฆ่ชฌๆ˜Žใ—ใฆใ„ใพใ™ใ€‚ๆ”ฏๆ‰•ใ„ใ‚จใƒณใ‚ธใƒณใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซใฏใ€ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใงๆ”ฏๆ‰•ใ„ใ‚จใƒณใ‚ธใƒณใŒๆœ‰ๅŠนใซใชใฃใฆใ„ใ‚‹้กงๅฎขใฎใฟใŒๅˆฉ็”จใงใใ‚‹ API ใŒๅซใพใ‚Œใฆใ„ใพใ™ใ€‚ใ“ใ‚Œใ‚‰ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฏ็พๅœจใƒ™ใƒผใ‚ฟ็‰ˆใงใ‚ใ‚Šใ€ๅค‰ๆ›ดใ•ใ‚Œใ‚‹ๅฏ่ƒฝๆ€งใŒใ‚ใ‚Šใพใ™ใ€‚Fireblocks ๆ”ฏๆ‰•ใ„ใ‚จใƒณใ‚ธใƒณใซใคใ„ใฆ่ฉณใ—ใ็Ÿฅใ‚ŠใŸใ„ๅ ดๅˆใฏใ€Fireblocks ใ‚ซใ‚นใ‚ฟใƒžใƒผ ใ‚ตใ‚ฏใ‚ปใ‚น ใƒžใƒใƒผใ‚ธใƒฃใƒผใซๅ•ใ„ๅˆใ‚ใ›ใ‚‹ใ‹ใ€CSM@fireblocks.com ใซใƒกใƒผใƒซใ‚’้€ไฟกใ—ใฆใใ ใ•ใ„ใ€‚.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementCreateFlowRequestBody" + }, + "example": { + "configId": "a4b0a706-4578-4467-bd5b-a852761dd2aa", + "amount": "100" + } + } + } + }, + "responses": { + "200": { + "description": "ๅ›ฝๅขƒใ‚’่ถŠใˆใŸๆฑบๆธˆใƒ•ใƒญใƒผใฎๆง‹็ฏ‰ใซๆˆๅŠŸ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementCreateFlowResponse" + }, + "example": { + "flowId": "98fb5a8b-65ff-4f15-b89c-80910aedbfb3", + "configId": "a4b0a706-4578-4467-bd5b-a852761dd2aa", + "conversionRate": "0.05481268", + "inputAmount": { + "amount": "100", + "assetId": "MXN" + }, + "estimatedOutputAmount": { + "amount": "5.461268", + "assetId": "XLM_USDC_5F3T" + }, + "totalEstimatedFee": { + "amount": "0.063503", + "assetId": "XLM_USDC_5F3T" + }, + "steps": { + "ON_RAMP": { + "accountId": "3d6241ad-879b-4a11-842f-4cee9cd7fbba", + "inputAmount": { + "amount": "100", + "assetId": "MXN" + }, + "outputAmount": { + "amount": "5.48126865", + "assetId": "USD" + }, + "estimatedFeeAmount": { + "amount": "0.043503", + "assetId": "USD" + }, + "estimatedTime": 10, + "isSignRequired": false + }, + "VAULT_ACCOUNT": { + "accountId": "1", + "inputAmount": { + "amount": "5.48126865", + "assetId": "USD" + }, + "outputAmount": { + "amount": "5.471268", + "assetId": "XLM_USDC_5F3T" + }, + "estimatedFeeAmount": { + "amount": "0.01", + "assetId": "XLM_USDC_5F3T" + }, + "estimatedTime": 63, + "isSignRequired": true + }, + "OFF_RAMP": { + "accountId": "1cf7f750-117f-4c36-b4ef-14c420d118ce", + "inputAmount": { + "amount": "5.471268", + "assetId": "XLM_USDC_5F3T" + }, + "outputAmount": { + "amount": "5.461268", + "assetId": "XLM_USDC_5F3T" + }, + "estimatedFeeAmount": { + "amount": "0.01", + "assetId": "XLM_USDC_5F3T" + }, + "estimatedTime": 95, + "isSignRequired": true + } + }, + "totalEstimatedTime": 696 + } + } + } + }, + "400": { + "description": "ๅ›ฝๅขƒใ‚’่ถŠใˆใŸใƒ•ใƒญใƒผใ‚’ไฝœๆˆใงใใพใ›ใ‚“ใ€‚ๆง‹ๆˆ ID ใŒ็„กๅŠนใงใ™.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "่จฑๅฏใ•ใ‚Œใฆใ„ใพใ›ใ‚“ใ€‚Authorization ใƒ˜ใƒƒใƒ€ใƒผใซ JWT ใƒˆใƒผใ‚ฏใƒณใŒ่ฆ‹ใคใ‹ใ‚‰ใชใ„ใ‹็„กๅŠนใงใ™.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "ๅ†…้ƒจใ‚จใƒฉใƒผ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/payments/xb-settlements/flows/{flowId}": { + "get": { + "tags": [ + "Payments - cross-border settlement" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "flowId", + "required": true, + "description": "ใ‚ฏใƒญใ‚นใƒœใƒผใƒ€ใƒผๆฑบๆธˆใƒ•ใƒญใƒผID.", + "schema": { + "type": "string" + }, + "example": "98fb5a8b-65ff-4f15-b89c-80910aedbfb3" + } + ], + "summary": "ๅ›ฝๅขƒใ‚’่ถŠใˆใŸๆฑบๆธˆใƒ•ใƒญใƒผใฎ่ฉณ็ดฐใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "description": "็‰นๅฎšใฎใ‚ฏใƒญใ‚นใƒœใƒผใƒ€ใƒผๆฑบๆธˆใƒ•ใƒญใƒผใฎ่ฉณ็ดฐใ‚’ๅ–ๅพ—ใ—ใพใ™ **ๆณจ:** ใ“ใฎใ‚ปใ‚ฏใ‚ทใƒงใƒณใฎๅ‚็…งใ‚ณใƒณใƒ†ใƒณใƒ„ใฏใ€ๆ”ฏๆ‰•ใ„ใ‚จใƒณใ‚ธใƒณใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซใคใ„ใฆ่ชฌๆ˜Žใ—ใฆใ„ใพใ™ใ€‚ๆ”ฏๆ‰•ใ„ใ‚จใƒณใ‚ธใƒณใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซใฏใ€ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใงๆ”ฏๆ‰•ใ„ใ‚จใƒณใ‚ธใƒณใŒๆœ‰ๅŠนใซใชใฃใฆใ„ใ‚‹้กงๅฎขใฎใฟใŒๅˆฉ็”จใงใใ‚‹ API ใŒๅซใพใ‚Œใฆใ„ใพใ™ใ€‚ใ“ใ‚Œใ‚‰ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฏ็พๅœจใƒ™ใƒผใ‚ฟ็‰ˆใงใ‚ใ‚Šใ€ๅค‰ๆ›ดใ•ใ‚Œใ‚‹ๅฏ่ƒฝๆ€งใŒใ‚ใ‚Šใพใ™ใ€‚Fireblocks ๆ”ฏๆ‰•ใ„ใ‚จใƒณใ‚ธใƒณใซใคใ„ใฆ่ฉณใ—ใ็Ÿฅใ‚ŠใŸใ„ๅ ดๅˆใฏใ€Fireblocks ใ‚ซใ‚นใ‚ฟใƒžใƒผ ใ‚ตใ‚ฏใ‚ปใ‚น ใƒžใƒใƒผใ‚ธใƒฃใƒผใซๅ•ใ„ๅˆใ‚ใ›ใ‚‹ใ‹ใ€CSM@fireblocks.com ใซใƒกใƒผใƒซใ‚’้€ไฟกใ—ใฆใใ ใ•ใ„ใ€‚.", + "responses": { + "200": { + "description": "ๅ›ฝๅขƒใ‚’่ถŠใˆใŸๆฑบๆธˆใƒ•ใƒญใƒผใฎ่ฉณ็ดฐใ‚’่ฟ”ใ—ใพใ™ใ€‚ๅฎŸ่กŒใ•ใ‚Œใฆใ„ใชใ„ใƒ•ใƒญใƒผใซใคใ„ใฆใฏใ€ใƒ—ใƒฌใƒ“ใƒฅใƒผ ใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆใŒ่ฟ”ใ•ใ‚Œใ€ๆŽจๅฎšๆ™‚้–“ใ€้‡‘้กใ€ๆ‰‹ๆ•ฐๆ–™ใŒ่กจ็คบใ•ใ‚Œใพใ™ใ€‚ใ“ใฎใƒ‡ใƒผใ‚ฟๆง‹้€ ใฏใ€ใƒ•ใƒญใƒผใฎ้€ฒ่กŒใซๅฟœใ˜ใฆใ€ๅˆ่จˆๆ‰‹ๆ•ฐๆ–™ (็ดฏ็ฉ)ใ€็Šถๆ…‹ใ€ๆ‰‹้ †ใชใฉใ€ๆ›ดๆ–ฐใ•ใ‚Œใ‚‹ใ“ใจใซๆณจๆ„ใ—ใฆใใ ใ•ใ„ใ€‚.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementGetFlowResponse" + }, + "examples": { + "not executed": { + "value": { + "preview": { + "flowId": "98fb5a8b-65ff-4f15-b89c-80910aedbfb3", + "configId": "a4b0a706-4578-4467-bd5b-a852761dd2aa", + "conversionRate": "0.055369", + "inputAmount": { + "amount": "32", + "assetId": "MXN" + }, + "estimatedOutputAmount": { + "amount": "1.741824", + "assetId": "XLM_USDC_5F3T" + }, + "totalEstimatedFee": { + "amount": "0.044063", + "assetId": "XLM_USDC_5F3T" + }, + "totalEstimatedTime": 831, + "steps": { + "ON_RAMP": { + "accountId": "3d6241ad-879b-4a11-842f-4cee9cd7fbba", + "inputAmount": { + "amount": "32", + "assetId": "MXN" + }, + "outputAmount": { + "amount": "1.77182407", + "assetId": "USD" + }, + "estimatedFeeAmount": { + "amount": "0.014063", + "assetId": "USD" + }, + "estimatedTime": 10, + "isSignRequired": false + }, + "VAULT_ACCOUNT": { + "accountId": "1", + "inputAmount": { + "amount": "1.77182407", + "assetId": "XLM_USDC_5F3T" + }, + "outputAmount": { + "amount": "1.761824", + "assetId": "XLM_USDC_5F3T" + }, + "estimatedFeeAmount": { + "amount": "0.01", + "assetId": "XLM_USDC_5F3T" + }, + "estimatedTime": 111, + "isSignRequired": true + }, + "OFF_RAMP": { + "accountId": "1cf7f750-117f-4c36-b4ef-14c420d118ce", + "inputAmount": { + "amount": "1.761824", + "assetId": "XLM_USDC_5F3T" + }, + "outputAmount": { + "amount": "1.751824", + "assetId": "XLM_USDC_5F3T" + }, + "estimatedFeeAmount": { + "amount": "0.01", + "assetId": "XLM_USDC_5F3T" + }, + "estimatedTime": 293, + "isSignRequired": true + } + } + } + } + }, + "in progress": { + "value": { + "execution": { + "flowId": "98fb5a8b-65ff-4f15-b89c-80910aedbfb3", + "configId": "a4b0a706-4578-4467-bd5b-a852761dd2aa", + "inputAmount": { + "amount": "32", + "assetId": "MXN" + }, + "outputAmount": { + "amount": "1.471824", + "assetId": "XLM_USDC_5F3T" + }, + "totalFee": { + "amount": "0.004415", + "assetId": "XLM_USDC_5F3T" + }, + "initiatedAt": 1684919822759, + "initiatedBy": "a92e87a0-5231-531e-a624-fb29c1283764", + "state": "PROCESSING", + "selectedConversionSlippage": { + "basisPoints": 10, + "reason": "FLOW" + }, + "steps": { + "ON_RAMP": { + "id": "c1863abf-e7fa-4f3a-908a-bcd6381f7eb4", + "accountId": "3d6241ad-879b-4a11-842f-4cee9cd7fbba", + "status": "COMPLETED", + "inputAmount": { + "amount": "32", + "assetId": "MXN" + }, + "outputAmount": { + "amount": "1.77182407", + "assetId": "USD" + }, + "fee": { + "amount": "0.014063", + "assetId": "USD" + }, + "startedAt": 1684919823052, + "completedAt": 1684919830456, + "isSignRequired": false + }, + "VAULT_ACCOUNT": { + "id": "2aa2634d-2bab-44ac-9b4e-36e2e4db5d49", + "accountId": "1", + "status": "COMPLETED", + "inputAmount": { + "amount": "1.77182407", + "assetId": "XLM_USDC_5F3T" + }, + "outputAmount": { + "amount": "1.761824", + "assetId": "XLM_USDC_5F3T" + }, + "fee": { + "amount": "0.01", + "assetId": "XLM" + }, + "startedAt": 1684919831385, + "completedAt": 1684920680227, + "isSignRequired": true + }, + "OFF_RAMP": { + "id": "b221ed63-a05c-4e78-b2f2-205dcffeabda", + "accountId": "1cf7f750-117f-4c36-b4ef-14c420d118ce", + "status": "PROCESSING", + "inputAmount": { + "amount": "1.761824", + "assetId": "XLM_USDC_5F3T" + }, + "startedAt": 1684920681088, + "isSignRequired": true + } + } + } + } + }, + "completed": { + "value": { + "execution": { + "flowId": "98fb5a8b-65ff-4f15-b89c-80910aedbfb3", + "configId": "a4b0a706-4578-4467-bd5b-a852761dd2aa", + "inputAmount": { + "amount": "32", + "assetId": "MXN" + }, + "outputAmount": { + "amount": "1.471824", + "assetId": "XLM_USDC_5F3T" + }, + "totalFee": { + "amount": "0.004415", + "assetId": "XLM_USDC_5F3T" + }, + "initiatedAt": 1684919822759, + "initiatedBy": "a92e87a0-5231-531e-a624-fb29c1283764", + "state": "COMPLETED", + "selectedConversionSlippage": { + "basisPoints": 10, + "reason": "FLOW" + }, + "steps": { + "ON_RAMP": { + "id": "b1bec144-c4dd-4ff8-80ed-4204c83dd422", + "accountId": "3d6241ad-879b-4a11-842f-4cee9cd7fbba", + "status": "COMPLETED", + "inputAmount": { + "amount": "32", + "assetId": "MXN" + }, + "outputAmount": { + "amount": "1.77182407", + "assetId": "USD" + }, + "fee": { + "amount": "0.014063", + "assetId": "USD" + }, + "startedAt": 1684919823052, + "completedAt": 1684919830456, + "isSignRequired": false + }, + "VAULT_ACCOUNT": { + "id": "df7e0103-04cf-4508-9654-aa5e4b90dd50", + "accountId": "1", + "status": "COMPLETED", + "inputAmount": { + "amount": "1.77182407", + "assetId": "XLM_USDC_5F3T" + }, + "outputAmount": { + "amount": "1.761824", + "assetId": "XLM_USDC_5F3T" + }, + "fee": { + "amount": "0.01", + "assetId": "XLM" + }, + "startedAt": 1684919831385, + "completedAt": 1684920680227, + "isSignRequired": true + }, + "OFF_RAMP": { + "id": "34c2d597-271a-4c11-937a-3c246f5d39c2", + "accountId": "1cf7f750-117f-4c36-b4ef-14c420d118ce", + "status": "COMPLETED", + "inputAmount": { + "amount": "1.761824", + "assetId": "XLM_USDC_5F3T" + }, + "outputAmount": { + "amount": "1.761823", + "assetId": "XLM_USDC_5F3T" + }, + "fee": { + "amount": "0.00001", + "assetId": "XLM" + }, + "startedAt": 1684920681088, + "completedAt": 1684921261453, + "isSignRequired": true + } + } + } + } + } + } + } + } + }, + "401": { + "description": "่จฑๅฏใ•ใ‚Œใฆใ„ใพใ›ใ‚“ใ€‚Authorization ใƒ˜ใƒƒใƒ€ใƒผใซ JWT ใƒˆใƒผใ‚ฏใƒณใŒ่ฆ‹ใคใ‹ใ‚‰ใชใ„ใ‹็„กๅŠนใงใ™.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "็„กๅŠนใชใƒ•ใƒญใƒผID.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "ๅ†…้ƒจใ‚จใƒฉใƒผ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/payments/xb-settlements/flows/{flowId}/actions/execute": { + "post": { + "tags": [ + "Payments - cross-border settlement" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "flowId", + "required": true, + "description": "ใ‚ฏใƒญใ‚นใƒœใƒผใƒ€ใƒผๆฑบๆธˆใƒ•ใƒญใƒผID.", + "schema": { + "type": "string" + }, + "example": "98fb5a8b-65ff-4f15-b89c-80910aedbfb3" + } + ], + "summary": "ใ‚ฏใƒญใ‚นใƒœใƒผใƒ€ใƒผๆฑบๆธˆใƒ•ใƒญใƒผใฎๅฎŸ่กŒ", + "description": "ๅฎŸ่กŒใฎใŸใ‚ใซใ€ŒflowIdใ€ใ‚’ๅซใ‚€ๆ”ฏๆ‰•ใ„ใƒ•ใƒญใƒผใ‚’้€ไฟกใ—ใพใ™ใ€‚ใ“ใฎๅฎŸ่กŒใซใƒ•ใƒญใƒผๆง‹ๆˆใงๆง‹ๆˆใ•ใ‚Œใฆใ„ใ‚‹ใ‚‚ใฎใจ็•ฐใชใ‚‹ใ‚นใƒชใƒƒใƒšใƒผใ‚ธๆง‹ๆˆใŒๅฟ…่ฆใชๅ ดๅˆใฏใ€ใƒชใ‚ฏใ‚จใ‚นใƒˆๆœฌๆ–‡ใงใ“ใฎๅฎŸ่กŒใซๅฟ…่ฆใชใ‚นใƒชใƒƒใƒšใƒผใ‚ธๆง‹ๆˆใ‚’ๅฎš็พฉใ™ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚**ๆณจ:** ใ“ใฎใ‚ปใ‚ฏใ‚ทใƒงใƒณใฎๅ‚็…งใ‚ณใƒณใƒ†ใƒณใƒ„ใฏใ€ๆ”ฏๆ‰•ใ„ใ‚จใƒณใ‚ธใƒณ ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซใคใ„ใฆ่ชฌๆ˜Žใ—ใฆใ„ใพใ™ใ€‚ๆ”ฏๆ‰•ใ„ใ‚จใƒณใ‚ธใƒณ ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซใฏใ€ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใงๆ”ฏๆ‰•ใ„ใ‚จใƒณใ‚ธใƒณใŒๆœ‰ๅŠนใซใชใฃใฆใ„ใ‚‹้กงๅฎขใฎใฟใŒๅˆฉ็”จใงใใ‚‹ API ใŒๅซใพใ‚Œใฆใ„ใพใ™ใ€‚ใ“ใ‚Œใ‚‰ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฏ็พๅœจใƒ™ใƒผใ‚ฟ็‰ˆใงใ‚ใ‚Šใ€ๅค‰ๆ›ดใ•ใ‚Œใ‚‹ๅฏ่ƒฝๆ€งใŒใ‚ใ‚Šใพใ™ใ€‚Fireblocks ๆ”ฏๆ‰•ใ„ใ‚จใƒณใ‚ธใƒณใซใคใ„ใฆ่ฉณใ—ใ็Ÿฅใ‚ŠใŸใ„ๅ ดๅˆใฏใ€Fireblocks ใ‚ซใ‚นใ‚ฟใƒžใƒผ ใ‚ตใ‚ฏใ‚ปใ‚น ใƒžใƒใƒผใ‚ธใƒฃใƒผใซๅ•ใ„ๅˆใ‚ใ›ใ‚‹ใ‹ใ€CSM@fireblocks.com ใซใƒกใƒผใƒซใ‚’้€ไฟกใ—ใฆใใ ใ•ใ„ใ€‚.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementFlowExecutionRequestBody" + }, + "example": { + "conversionSlippageBasisPoints": 10 + } + } + } + }, + "responses": { + "200": { + "description": "ๅ›ฝๅขƒใ‚’่ถŠใˆใŸๆฑบๆธˆใƒ•ใƒญใƒผใŒๆญฃๅธธใซๅฎŸ่กŒใ•ใ‚Œๅง‹ใ‚ใพใ—ใŸ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementFlowExecutionResponse" + }, + "example": { + "flowId": "98fb5a8b-65ff-4f15-b89c-80910aedbfb3", + "configId": "a4b0a706-4578-4467-bd5b-a852761dd2aa", + "inputAmount": { + "amount": "32", + "assetId": "MXN" + }, + "outputAmount": { + "amount": "1.471824", + "assetId": "XLM_USDC_5F3T" + }, + "totalFee": { + "amount": "0.004415", + "assetId": "XLM_USDC_5F3T" + }, + "initiatedAt": 1684919822759, + "initiatedBy": "a92e87a0-5231-531e-a624-fb29c1283764", + "state": "PROCESSING", + "selectedConversionSlippage": { + "basisPoints": 10, + "reason": "FLOW" + }, + "steps": { + "ON_RAMP": { + "id": "c1863abf-e7fa-4f3a-908a-bcd6381f7eb4", + "accountId": "3d6241ad-879b-4a11-842f-4cee9cd7fbba", + "status": "COMPLETED", + "inputAmount": { + "amount": "32", + "assetId": "MXN" + }, + "outputAmount": { + "amount": "1.77182407", + "assetId": "USD" + }, + "fee": { + "amount": "0.014063", + "assetId": "USD" + }, + "startedAt": 1684919823052, + "completedAt": 1684919830456, + "isSignRequired": false + }, + "VAULT_ACCOUNT": { + "id": "2aa2634d-2bab-44ac-9b4e-36e2e4db5d49", + "accountId": "1", + "status": "PROCESSING", + "inputAmount": { + "amount": "1.77182407", + "assetId": "XLM_USDC_5F3T" + }, + "outputAmount": { + "amount": "1.761824", + "assetId": "XLM_USDC_5F3T" + }, + "fee": { + "amount": "0.01", + "assetId": "XLM" + }, + "startedAt": 1684919831385, + "isSignRequired": true + }, + "OFF_RAMP": { + "id": "b221ed63-a05c-4e78-b2f2-205dcffeabda", + "accountId": "1cf7f750-117f-4c36-b4ef-14c420d118ce", + "status": "NOT_STARTED", + "inputAmount": { + "amount": "1.761824", + "assetId": "XLM_USDC_5F3T" + }, + "isSignRequired": true + } + } + } + } + } + }, + "400": { + "description": "ๅ›ฝๅขƒใ‚’่ถŠใˆใŸใƒ•ใƒญใƒผใ‚’ๅฎŸ่กŒไธญใซใ‚จใƒฉใƒผใŒ็™บ็”Ÿใ—ใพใ—ใŸ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "่จฑๅฏใ•ใ‚Œใฆใ„ใพใ›ใ‚“ใ€‚Authorization ใƒ˜ใƒƒใƒ€ใƒผใซ JWT ใƒˆใƒผใ‚ฏใƒณใŒ่ฆ‹ใคใ‹ใ‚‰ใชใ„ใ‹็„กๅŠนใงใ™.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "็„กๅŠนใชใƒ•ใƒญใƒผID.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "ๅ†…้ƒจใ‚จใƒฉใƒผ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/payments/payout": { + "post": { + "tags": [ + "Payments - Payout" + ], + "description": "**ๆณจ:** ใ“ใฎใ‚ปใ‚ฏใ‚ทใƒงใƒณใฎๅ‚็…งใ‚ณใƒณใƒ†ใƒณใƒ„ใงใฏใ€ๆ”ฏๆ‰•ใ„ใ‚จใƒณใ‚ธใƒณ ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซใคใ„ใฆ่ชฌๆ˜Žใ—ใพใ™ใ€‚ๆ”ฏๆ‰•ใ„ใ‚จใƒณใ‚ธใƒณ ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซใฏใ€ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใงๆ”ฏๆ‰•ใ„ใ‚จใƒณใ‚ธใƒณใŒๆœ‰ๅŠนใซใชใฃใฆใ„ใ‚‹้กงๅฎขใฎใฟใŒๅˆฉ็”จใงใใ‚‹ API ใŒๅซใพใ‚Œใพใ™ใ€‚

ใ“ใ‚Œใ‚‰ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฏ็พๅœจใƒ™ใƒผใ‚ฟ็‰ˆใงใ‚ใ‚Šใ€ๅค‰ๆ›ดใ•ใ‚Œใ‚‹ๅฏ่ƒฝๆ€งใŒใ‚ใ‚Šใพใ™ใ€‚

Fireblocks Payments Engine ใซใคใ„ใฆ่ฉณใ—ใ็Ÿฅใ‚ŠใŸใ„ๅ ดๅˆใฏใ€Fireblocks ใ‚ซใ‚นใ‚ฟใƒžใƒผ ใ‚ตใ‚ฏใ‚ปใ‚น ใƒžใƒใƒผใ‚ธใƒฃใƒผใซใŠๅ•ใ„ๅˆใ‚ใ›ใ„ใŸใ ใใ‹ใ€CSM@fireblocks.com ใพใงใƒกใƒผใƒซใงใŠๅ•ใ„ๅˆใ‚ใ›ใใ ใ•ใ„ใ€‚

ๆ”ฏๆ‰•ใ„ๆŒ‡็คบใ‚ปใƒƒใƒˆใ‚’ไฝœๆˆใ—ใพใ™ใ€‚
ๆ”ฏๆ‰•ใ„ๆŒ‡็คบใ‚ปใƒƒใƒˆใฏใ€ๅ˜ไธ€ใฎๆ”ฏๆ‰•ใ„ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‹ใ‚‰ๅ—ๅ–ไบบใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎใƒชใ‚นใƒˆใซๆ”ฏๆ‰•ใ„ใ‚’ๅˆ†้…ใ™ใ‚‹ใŸใ‚ใฎไธ€้€ฃใฎๆŒ‡็คบใงใ™ใ€‚
ๅ‘ฝไปคใ‚ปใƒƒใƒˆใฏไปฅไธ‹ใ‚’ๅฎš็พฉใ—ใพใ™ใ€‚
  • ๆ”ฏๆ‰•ใ„ๅฃๅบงใจใใฎๅฃๅบงใ‚ฟใ‚คใƒ—๏ผˆ้‡‘ๅบซใ€ๅ–ๅผ•ๆ‰€ใ€ๆณ•ๅฎš้€š่ฒจ๏ผ‰ใ€‚
  • ๅ„ๅ—ๅ–ไบบใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚ฟใ‚คใƒ—๏ผˆ้‡‘ๅบซใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ€ไบคๆ›ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ€ใƒ›ใƒฏใ‚คใƒˆใƒชใ‚นใƒˆใ‚ขใƒ‰ใƒฌใ‚นใ€ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถšใ€ๆณ•ๅฎš้€š่ฒจใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ€ใพใŸใฏ่ฒฉๅฃฒ่€…ใ‚ขใ‚ซใ‚ฆใƒณใƒˆ๏ผ‰ใ€้‡‘้กใ€ใŠใ‚ˆใณๆ”ฏๆ‰•ใ„่ณ‡็”ฃใ€‚
", + "security": [ + { + "bearerAuth": [] + } + ], + "summary": "ๆ”ฏๆ‰•ใ„ๆŒ‡็คบใ‚ปใƒƒใƒˆใ‚’ไฝœๆˆใ™ใ‚‹", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreatePayoutRequest" + }, + "example": { + "paymentAccount": { + "id": "EX_SUB3", + "type": "EXCHANGE_ACCOUNT" + }, + "instructionSet": [ + { + "payeeAccount": { + "id": "bef85a1c-b605-4b2e-bdb5-2d400f4d0bf3", + "type": "EXTERNAL_WALLET" + }, + "amount": { + "amount": "43", + "assetId": "USDC" + } + }, + { + "payeeAccount": { + "id": "3adc1f92-e791-44a8-9aee-7f31c2108b78", + "type": "NETWORK_CONNECTION" + }, + "amount": { + "amount": "4423", + "assetId": "USDC" + } + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "ๆ”ฏๆ‰•ใ„ๅ‘ฝไปคใ‚ปใƒƒใƒˆใฎไฝœๆˆใŒๆˆๅŠŸใ—ใ€ไธ€ๆ„ใฎๆ”ฏๆ‰•ใ„IDใ‚’ๆŒใค็”Ÿๆˆใ•ใ‚ŒใŸๅ‘ฝไปคใ‚ปใƒƒใƒˆใŒ่ฟ”ใ•ใ‚Œใพใ™ใ€‚ๆ”ฏๆ‰•ใ„IDใฏๆ”ฏๆ‰•ใ„ใฎๅฎŸ่กŒใจๆ”ฏๆ‰•ใ„ใ‚นใƒ†ใƒผใ‚ฟใ‚นใฎ็ขบ่ชใซไฝฟ็”จใ•ใ‚Œใพใ™ใ€‚.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PayoutResponse" + }, + "example": { + "payoutId": "1fe3b61f-7e1f-4a19-aff0-4f0a524d44d7", + "paymentAccount": { + "id": "EX_SUB3", + "type": "EXCHANGE_ACCOUNT" + }, + "createdAt": 1645365800, + "state": "REQUESTED", + "status": "REGISTERED", + "initMethod": "API", + "instructionSet": [ + { + "id": "6ea4a016-536b-49af-b1a0-40b343ccf879", + "name": "payee-wallet-name", + "payeeAccount": { + "id": "bef85a1c-b605-4b2e-bdb5-2d400f4d0bf3", + "type": "EXTERNAL_WALLET" + }, + "amount": { + "amount": "43", + "assetId": "USDC" + }, + "state": "NOT_STARTED", + "transactions": [] + }, + { + "id": "e783a79b-6acc-4d18-885d-ed533cad8eeb", + "name": "payee-by-network", + "payeeAccount": { + "id": "3adc1f92-e791-44a8-9aee-7f31c2108b78", + "type": "NETWORK_CONNECTION" + }, + "amount": { + "amount": "4423.23", + "assetId": "USDC" + }, + "state": "NOT_STARTED", + "transactions": [] + } + ] + } + } + } + }, + "400": { + "description": "่ฆๆฑ‚ใฎๅฝขๅผใŒๆญฃใ—ใใ‚ใ‚Šใพใ›ใ‚“", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "่จฑๅฏใ•ใ‚Œใฆใ„ใพใ›ใ‚“ใ€‚Authorization ใƒ˜ใƒƒใƒ€ใƒผใซ JWT ใƒˆใƒผใ‚ฏใƒณใŒ่ฆ‹ใคใ‹ใ‚‰ใชใ„ใ‹็„กๅŠนใงใ™.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "ๅ†…้ƒจใ‚จใƒฉใƒผ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/payments/payout/{payoutId}/actions/execute": { + "post": { + "tags": [ + "Payments - Payout" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "summary": "ๆ”ฏๆ‰•ใ„ๅ‘ฝไปคใ‚ปใƒƒใƒˆใ‚’ๅฎŸ่กŒใ™ใ‚‹", + "description": "**ๆณจ:** ใ“ใฎใ‚ปใ‚ฏใ‚ทใƒงใƒณใฎๅ‚็…งใ‚ณใƒณใƒ†ใƒณใƒ„ใงใฏใ€ๆ”ฏๆ‰•ใ„ใ‚จใƒณใ‚ธใƒณ ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซใคใ„ใฆ่ชฌๆ˜Žใ—ใพใ™ใ€‚ๆ”ฏๆ‰•ใ„ใ‚จใƒณใ‚ธใƒณ ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซใฏใ€ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใงๆ”ฏๆ‰•ใ„ใ‚จใƒณใ‚ธใƒณใŒๆœ‰ๅŠนใซใชใฃใฆใ„ใ‚‹้กงๅฎขใฎใฟใŒๅˆฉ็”จใงใใ‚‹ API ใŒๅซใพใ‚Œใพใ™ใ€‚

ใ“ใ‚Œใ‚‰ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฏ็พๅœจใƒ™ใƒผใ‚ฟ็‰ˆใงใ‚ใ‚Šใ€ๅค‰ๆ›ดใ•ใ‚Œใ‚‹ๅฏ่ƒฝๆ€งใŒใ‚ใ‚Šใพใ™ใ€‚

Fireblocks Payments Engine ใซใคใ„ใฆ่ฉณใ—ใ็Ÿฅใ‚ŠใŸใ„ๅ ดๅˆใฏใ€Fireblocks ใ‚ซใ‚นใ‚ฟใƒžใƒผ ใ‚ตใ‚ฏใ‚ปใ‚น ใƒžใƒใƒผใ‚ธใƒฃใƒผใซใŠๅ•ใ„ๅˆใ‚ใ›ใ„ใŸใ ใใ‹ใ€CSM@fireblocks.com ใพใงใƒกใƒผใƒซใงใŠๅ•ใ„ๅˆใ‚ใ›ใใ ใ•ใ„ใ€‚

ๆ”ฏๆ‰•ใ„ๅ‘ฝไปคใ‚ปใƒƒใƒˆใ‚’ๅฎŸ่กŒใ—ใพใ™ใ€‚

ๅ‘ฝไปคใ‚ปใƒƒใƒˆใŒๆคœ่จผใ•ใ‚ŒๅฎŸ่กŒใ•ใ‚Œใพใ™ใ€‚
ใ‚ฝใƒผใ‚นใƒญใƒƒใ‚ฏ
ใ™ใงใซใ‚ขใ‚ฏใƒ†ใ‚ฃใƒ–ใชๆ”ฏๆ‰•ใ„ใŒใ‚ใ‚‹ๆ”ฏๆ‰•ใ„ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‹ใ‚‰ๆ”ฏๆ‰•ใ„ๆŒ‡็คบใ‚ปใƒƒใƒˆใ‚’ๅฎŸ่กŒใ™ใ‚‹ๅ ดๅˆใ€ๆ–ฐใ—ใ„ๆ”ฏๆ‰•ใ„ๆŒ‡็คบใ‚ปใƒƒใƒˆใ‚’ๅฎŸ่กŒใ™ใ‚‹ๅ‰ใซใ‚ขใ‚ฏใƒ†ใ‚ฃใƒ–ใชๆ”ฏๆ‰•ใ„ใŒๅฎŒไบ†ใ—ใพใ™ใ€‚
ๅŒใ˜ๆ”ฏๆ‰•ใ„ๅ‘ฝไปคใ‚ปใƒƒใƒˆใ‚’่ค‡ๆ•ฐๅ›žๅฎŸ่กŒใ™ใ‚‹ใ“ใจใฏใงใใพใ›ใ‚“.", + "parameters": [ + { + "name": "payoutId", + "description": "ๆ”ฏๆ‰•ใ„ๆŒ‡็คบใ‚ปใƒƒใƒˆใฎไฝœๆˆใ‹ใ‚‰ๅ—ใ‘ๅ–ใฃใŸๆ”ฏๆ‰•ใ„ID", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "example": "1fe3b61f-7e1f-4a19-aff0-4f0a524d44d7" + } + ], + "responses": { + "200": { + "description": "ๆ”ฏๆ‰•ใ„ๅ‘ฝไปคใ‚ปใƒƒใƒˆใ‚’ๅฎŸ่กŒใ—ใพใ—ใŸ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DispatchPayoutResponse" + }, + "example": { + "payoutId": "1fe3b61f-7e1f-4a19-aff0-4f0a524d44d7" + } + } + } + }, + "400": { + "description": "่ฆๆฑ‚ใฎๅฝขๅผใŒๆญฃใ—ใใ‚ใ‚Šใพใ›ใ‚“", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "่จฑๅฏใ•ใ‚Œใฆใ„ใพใ›ใ‚“ใ€‚Authorization ใƒ˜ใƒƒใƒ€ใƒผใซ JWT ใƒˆใƒผใ‚ฏใƒณใŒ่ฆ‹ใคใ‹ใ‚‰ใชใ„ใ‹็„กๅŠนใงใ™.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "ๅ†…้ƒจใ‚จใƒฉใƒผ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/payments/payout/{payoutId}": { + "get": { + "tags": [ + "Payments - Payout" + ], + "summary": "ๆ”ฏๆ‰•ใ„ๆŒ‡็คบใ‚ปใƒƒใƒˆใฎใ‚นใƒ†ใƒผใ‚ฟใ‚นใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "description": "**ๆณจ:** ใ“ใฎใ‚ปใ‚ฏใ‚ทใƒงใƒณใฎๅ‚็…งใ‚ณใƒณใƒ†ใƒณใƒ„ใงใฏใ€ๆ”ฏๆ‰•ใ„ใ‚จใƒณใ‚ธใƒณ ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซใคใ„ใฆ่ชฌๆ˜Žใ—ใพใ™ใ€‚ๆ”ฏๆ‰•ใ„ใ‚จใƒณใ‚ธใƒณ ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซใฏใ€ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใงๆ”ฏๆ‰•ใ„ใ‚จใƒณใ‚ธใƒณใŒๆœ‰ๅŠนใซใชใฃใฆใ„ใ‚‹้กงๅฎขใฎใฟใŒๅˆฉ็”จใงใใ‚‹ API ใŒๅซใพใ‚Œใพใ™ใ€‚

ใ“ใ‚Œใ‚‰ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฏ็พๅœจใƒ™ใƒผใ‚ฟ็‰ˆใงใ‚ใ‚Šใ€ๅค‰ๆ›ดใ•ใ‚Œใ‚‹ๅฏ่ƒฝๆ€งใŒใ‚ใ‚Šใพใ™ใ€‚

Fireblocks Payments Engine ใซใคใ„ใฆ่ฉณใ—ใ็Ÿฅใ‚ŠใŸใ„ๅ ดๅˆใฏใ€Fireblocks ใ‚ซใ‚นใ‚ฟใƒžใƒผ ใ‚ตใ‚ฏใ‚ปใ‚น ใƒžใƒใƒผใ‚ธใƒฃใƒผใซใŠๅ•ใ„ๅˆใ‚ใ›ใ„ใŸใ ใใ‹ใ€CSM@fireblocks.com ใพใงใƒกใƒผใƒซใงใŠๅ•ใ„ๅˆใ‚ใ›ใใ ใ•ใ„ใ€‚
", + "security": [ + { + "bearerAuth": [] + } + ], + "parameters": [ + { + "name": "payoutId", + "description": "ๆ”ฏๆ‰•ใ„ๆŒ‡็คบใ‚ปใƒƒใƒˆใฎไฝœๆˆใ‹ใ‚‰ๅ—ใ‘ๅ–ใฃใŸๆ”ฏๆ‰•ใ„ID", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "example": "1fe3b61f-7e1f-4a19-aff0-4f0a524d44d7" + } + ], + "responses": { + "200": { + "description": "ๅ„ๆ”ฏๆ‰•ใ„ๆŒ‡็คบใฎใ‚นใƒ†ใƒผใ‚ฟใ‚นใจใƒ—ใƒญใ‚ปใ‚นใงไฝœๆˆใ•ใ‚ŒใŸใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚’ๅซใ‚€ใ€ๆ”ฏๆ‰•ใ„ๆŒ‡็คบใ‚ปใƒƒใƒˆใฎ็พๅœจใฎใ‚นใƒ†ใƒผใ‚ฟใ‚นใ‚’่ฟ”ใ—ใพใ™ใ€‚.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PayoutResponse" + }, + "example": { + "payoutId": "1fe3b61f-7e1f-4a19-aff0-4f0a524d44d7", + "paymentAccount": { + "id": "EX_SUB3", + "type": "EXCHANGE_ACCOUNT" + }, + "createdAt": 1645365800, + "state": "FINALIZED", + "status": "DONE", + "initMethod": "API", + "instructionSet": [ + { + "id": "6ea4a016-536b-49af-b1a0-40b343ccf879", + "name": "payee-wallet-name", + "payeeAccount": { + "id": "bef85a1c-b605-4b2e-bdb5-2d400f4d0bf3", + "type": "EXTERNAL_WALLET" + }, + "amount": { + "amount": "4312", + "assetId": "USDC" + }, + "state": "COMPLETED", + "transactions": [ + { + "id": "35a4b10c-1f83-4f0b-ba2a-da0e73be2d6e", + "state": "COMPLETED", + "timestamp": 1645367429 + } + ] + }, + { + "id": "e783a79b-6acc-4d18-885d-ed533cad8eeb", + "name": "payee-by-network", + "payeeAccount": { + "id": "3adc1f92-e791-44a8-9aee-7f31c2108b78", + "type": "NETWORK_CONNECTION" + }, + "amount": { + "amount": "4423.23", + "assetId": "USDC" + }, + "state": "COMPLETED", + "transactions": [ + { + "id": "4505e7d9-bfc7-41bc-9750-54311fcbbf26", + "state": "COMPLETED", + "timestamp": 1645367449 + } + ] + } + ], + "reportUrl": "https://some-url.com/reports/cc5777c1-75a9-4337-aebd-f1f5a40a9391" + } + } + } + }, + "401": { + "description": "่จฑๅฏใ•ใ‚Œใฆใ„ใพใ›ใ‚“ใ€‚Authorization ใƒ˜ใƒƒใƒ€ใƒผใซ JWT ใƒˆใƒผใ‚ฏใƒณใŒ่ฆ‹ใคใ‹ใ‚‰ใชใ„ใ‹็„กๅŠนใงใ™.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "ๆŒ‡ๅฎšใ•ใ‚ŒใŸๆ”ฏๆ‰•ใ„IDใฎๆ”ฏๆ‰•ใ„ใฏๅญ˜ๅœจใ—ใพใ›ใ‚“.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "ๅ†…้ƒจใ‚จใƒฉใƒผ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/gas_station": { + "get": { + "summary": "ใ‚ฌใ‚ฝใƒชใƒณใ‚นใ‚ฟใƒณใƒ‰ใฎ่จญๅฎšใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "description": "ใ‚ฌใ‚ฝใƒชใƒณใ‚นใ‚ฟใƒณใƒ‰ใฎ่จญๅฎšใจETHๆฎ‹้ซ˜ใ‚’่ฟ”ใ—ใพใ™.", + "tags": [ + "Gas stations" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "gas_station_info = fireblocks.get_gas_station_info()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const gasStationInfo = await fireblocks.gasStationInfo();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "ใ‚ฌใ‚ฝใƒชใƒณใ‚นใ‚ฟใƒณใƒ‰ใฎ็‰ฉไปถ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/GasStationPropertiesResponse" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/gas_station/{assetId}": { + "get": { + "summary": "ใ‚ขใ‚ปใƒƒใƒˆๅˆฅใซใ‚ฌใ‚ฝใƒชใƒณใ‚นใ‚ฟใƒณใƒ‰ใฎ่จญๅฎšใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸ่ณ‡็”ฃใฎใ‚ฌใ‚ฝใƒชใƒณใ‚นใ‚ฟใƒณใƒ‰ใฎ่จญๅฎšใจๆฎ‹้ซ˜ใ‚’่ฟ”ใ—ใพใ™.", + "tags": [ + "Gas stations" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "gas_station_info = fireblocks.get_gas_station_info(asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const gasStationInfo = await fireblocks.gasStationInfo(assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "assetId", + "description": "่ณ‡็”ฃใฎID", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "ใ‚ฌใ‚ฝใƒชใƒณใ‚นใ‚ฟใƒณใƒ‰ใฎ็‰ฉไปถ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/GasStationPropertiesResponse" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/gas_station/configuration": { + "put": { + "summary": "ใ‚ฌใ‚ฝใƒชใƒณใ‚นใ‚ฟใƒณใƒ‰ใฎ่จญๅฎšใ‚’็ทจ้›†ใ™ใ‚‹", + "description": "ETHใฎใ‚ฌใ‚ฝใƒชใƒณใ‚นใ‚ฟใƒณใƒ‰ใฎ่จญๅฎšใ‚’ๆง‹ๆˆใ™ใ‚‹.", + "tags": [ + "Gas stations" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "gas_station = fireblocks.set_gas_station_configuration(gas_threshold, gas_cap, max_gas_price, asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const gasStation = await fireblocks.setGasStationConfiguration(gasThreshold, gasCap, maxGasPrice)", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GasStationConfiguration" + } + } + } + }, + "responses": { + "201": { + "description": "ใ‚ใ‹ใ‚Šใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/gas_station/configuration/{assetId}": { + "put": { + "summary": "ใ‚ขใ‚ปใƒƒใƒˆใฎใ‚ฌใ‚ฝใƒชใƒณใ‚นใ‚ฟใƒณใƒ‰่จญๅฎšใ‚’็ทจ้›†ใ™ใ‚‹", + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸ่ณ‡็”ฃใฎใ‚ฌใ‚ฝใƒชใƒณใ‚นใ‚ฟใƒณใƒ‰่จญๅฎšใ‚’ๆง‹ๆˆใ™ใ‚‹.", + "tags": [ + "Gas stations" + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "assetId", + "description": "่ณ‡็”ฃใฎID", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GasStationConfiguration" + } + } + } + }, + "responses": { + "201": { + "description": "ใ‚ใ‹ใ‚Šใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/users": { + "get": { + "summary": "ใƒฆใƒผใ‚ถใƒผใ‚’ไธ€่ฆง่กจ็คบใ™ใ‚‹", + "description": "ใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚นใฎใ™ในใฆใฎใƒฆใƒผใ‚ถใƒผใ‚’ไธ€่ฆง่กจ็คบใ—ใพใ™ใ€‚ใ“ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฏใ€็ฎก็†่€…ๆจฉ้™ใ‚’ๆŒใค API ใ‚ญใƒผใงใฎใฟไฝฟ็”จๅฏ่ƒฝใงใ™ใ€‚.", + "tags": [ + "Users" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "users = fireblocks.get_users()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const users = await fireblocks.getUsers();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "ใƒฆใƒผใ‚ถใƒผใƒชใ‚นใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/GetUsersResponse" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/audits": { + "get": { + "summary": "็›ฃๆŸปใƒญใ‚ฐใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "tags": [ + "Audit Logs" + ], + "parameters": [ + { + "in": "query", + "name": "timePeriod", + "required": true, + "description": "็›ฃๆŸปใƒญใ‚ฐใ‚’ๅ–ๅพ—ใ™ใ‚‹ๆœ€็ต‚ๆœŸ้–“", + "schema": { + "oneOf": [ + { + "const": "DAY" + }, + { + "const": "WEEK" + } + ] + } + } + ], + "responses": { + "200": { + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸๆœŸ้–“ใฎ็›ฃๆŸปใƒญใ‚ฐ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/off_exchange/add": { + "post": { + "summary": "ๆ‹…ไฟใ‚’่ฟฝๅŠ ใ™ใ‚‹", + "description": "ๆ‹…ไฟใ‚’่ฟฝๅŠ ใ—ใ€ๅ…ฅ้‡‘ใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’ไฝœๆˆใ™ใ‚‹", + "tags": [ + "Off exchanges" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AddCollateralRequestBody" + } + } + } + }, + "responses": { + "200": { + "description": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateTransactionResponse" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/off_exchange/remove": { + "post": { + "summary": "ๆ‹…ไฟใ‚’ๅ–ใ‚Š้™คใ", + "description": "ๆ‹…ไฟใ‚’ๅ‰Š้™คใ—ใ€ๅผ•ใๅ‡บใ—ใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’ไฝœๆˆใ™ใ‚‹", + "tags": [ + "Off exchanges" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RemoveCollateralRequestBody" + } + } + } + }, + "responses": { + "200": { + "description": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateTransactionResponse" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/off_exchange/settlements/trader": { + "post": { + "summary": "ใƒˆใƒฌใƒผใƒ€ใƒผใฎๆฑบๆธˆใ‚’ไฝœๆˆใ™ใ‚‹", + "description": "ใƒˆใƒฌใƒผใƒ€ใƒผใฎๆฑบๆธˆใ‚’ไฝœๆˆใ™ใ‚‹", + "tags": [ + "Off exchanges" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SettlementRequestBody" + } + } + } + }, + "responses": { + "201": { + "description": "้›†่ฝใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SettlementResponse" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/off_exchange/settlements/transactions": { + "get": { + "summary": "ๅ–ๅผ•ๆ‰€ใ‹ใ‚‰ๆฑบๆธˆๅ–ๅผ•ใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "description": "ๅ–ๅผ•ๆ‰€ใ‹ใ‚‰ๆฑบๆธˆๅ–ๅผ•ใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "tags": [ + "Off exchanges" + ], + "parameters": [ + { + "in": "query", + "name": "mainExchangeAccountId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "ๆฑบๆธˆๅ–ๅผ•", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/GetSettlementResponse" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/off_exchange/collateral_accounts/{mainExchangeAccountId}": { + "get": { + "summary": "็‰นๅฎšใฎๆ‹…ไฟไบคๆ›ๅฃๅบงใ‚’ๆŽขใ™", + "description": "mainExchangeAccountIdใงๆ‹…ไฟใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’่ฟ”ใ—ใพใ™.", + "tags": [ + "Off exchanges" + ], + "parameters": [ + { + "in": "path", + "name": "mainExchangeAccountId", + "required": true, + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸๆ‹…ไฟๅฃๅบงใŒ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚Œใฆใ„ใ‚‹ใƒกใ‚คใƒณใฎๅ–ๅผ•ๆ‰€ๅฃๅบงใฎID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ExchangeAccount ใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ExchangeAccount" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/webhooks/resend": { + "post": { + "summary": "ๅคฑๆ•—ใ—ใŸWebhookใ‚’ๅ†้€ไฟกใ™ใ‚‹", + "description": "ๅคฑๆ•—ใ—ใŸใ™ในใฆใฎWebhook้€š็Ÿฅใ‚’ๅ†้€ไฟกใ—ใพใ™.", + "tags": [ + "Webhooks" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = fireblocks.resend_webhooks()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.resendWebhooks();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "ใ‚ใ‹ใ‚Šใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ResendWebhooksResponse" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/webhooks/resend/{txId}": { + "post": { + "summary": "ID ใซใ‚ˆใ‚‹ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎๅคฑๆ•—ใ—ใŸ Webhook ใ‚’ๅ†้€ไฟกใ™ใ‚‹", + "description": "ID ใซใ‚ˆใ‚‹ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎๅคฑๆ•—ใ—ใŸ Webhook ้€š็Ÿฅใ‚’ๅ†้€ไฟกใ—ใพใ™.", + "tags": [ + "Webhooks" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = fireblocks.resend_transaction_webhooks_by_id(txId, resend_created, resend_status_updated)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.resendTransactionWebhooksById(txId, resendCreated, resendStatusUpdated);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "txId", + "required": true, + "description": "Webhookใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "resendCreated": { + "type": "boolean" + }, + "resendStatusUpdated": { + "type": "boolean" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "ใ‚ใ‹ใ‚Šใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/nfts/ownership/tokens": { + "put": { + "operationId": "refreshNFTOwnershipByVault", + "summary": "ใƒœใƒผใƒซใƒˆใ‚ขใ‚ซใ‚ฆใƒณใƒˆใƒˆใƒผใ‚ฏใƒณใ‚’ๆ›ดๆ–ฐใ™ใ‚‹", + "description": "ใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใจ Vault ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ”ใจใซใ™ในใฆใฎใƒˆใƒผใ‚ฏใƒณใจๆฎ‹้ซ˜ใ‚’ๆ›ดๆ–ฐใ—ใพใ™ใ€‚**ๆณจ**: ใ“ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฏ็พๅœจใƒ™ใƒผใ‚ฟ็‰ˆใงใ‚ใ‚Šใ€็พๆ™‚็‚นใงใฏไธ€่ˆฌๅ…ฌ้–‹ใ•ใ‚Œใฆใ„ใพใ›ใ‚“ใ€‚ใƒ™ใƒผใ‚ฟ็‰ˆใซ็™ป้Œฒใ—ใฆใ“ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใ‚’ๆœ‰ๅŠนใซใ™ใ‚‹ใซใฏใ€Fireblocks ใ‚ซใ‚นใ‚ฟใƒžใƒผ ใ‚ตใ‚ฏใ‚ปใ‚น ใƒžใƒใƒผใ‚ธใƒฃใƒผใซ้€ฃ็ตกใ™ใ‚‹ใ‹ใ€[CSM@fireblocks.com](mailto:CSM@fireblocks.com) ใพใงใ”้€ฃ็ตกใใ ใ•ใ„ใ€‚.", + "parameters": [ + { + "name": "blockchainDescriptor", + "required": true, + "in": "query", + "description": "ใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณ่จ˜่ฟฐๅญใƒ•ใ‚ฃใƒซใ‚ฟใƒผ", + "schema": { + "oneOf": [ + { + "const": "ETH" + }, + { + "const": "ETH_TEST3" + }, + { + "const": "POLYGON" + }, + { + "const": "POLYGON_TEST_MUMBAI" + } + ] + } + }, + { + "name": "vaultAccountId", + "required": true, + "in": "query", + "description": "Vault ใ‚ขใ‚ซใ‚ฆใƒณใƒˆ ใƒ•ใ‚ฃใƒซใ‚ฟใƒผ", + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + } + }, + "tags": [ + "NFTs (Beta)" + ] + }, + "get": { + "operationId": "getOwnedNFTs", + "summary": "ๆ‰€ๆœ‰ใ—ใฆใ„ใ‚‹ใ™ในใฆใฎใƒˆใƒผใ‚ฏใƒณใ‚’ไธ€่ฆง่กจ็คบใ—ใพใ™๏ผˆใƒšใƒผใ‚ธๅŒบๅˆ‡ใ‚Š๏ผ‰", + "description": "ใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚นๅ†…ใฎใ™ในใฆใฎใƒˆใƒผใ‚ฏใƒณใจใใฎใƒ‡ใƒผใ‚ฟใ‚’่ฟ”ใ—ใพใ™ใ€‚**ๆณจ**: ใ“ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฏ็พๅœจใƒ™ใƒผใ‚ฟ็‰ˆใงใ‚ใ‚Šใ€็พๆ™‚็‚นใงใฏไธ€่ˆฌๅ…ฌ้–‹ใ•ใ‚Œใฆใ„ใพใ›ใ‚“ใ€‚ใƒ™ใƒผใ‚ฟ็‰ˆใซ็™ป้Œฒใ—ใฆใ“ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใ‚’ๆœ‰ๅŠนใซใ™ใ‚‹ใซใฏใ€Fireblocks ใ‚ซใ‚นใ‚ฟใƒžใƒผ ใ‚ตใ‚ฏใ‚ปใ‚น ใƒžใƒใƒผใ‚ธใƒฃใƒผใซ้€ฃ็ตกใ™ใ‚‹ใ‹ใ€[CSM@fireblocks.com](mailto:CSM@fireblocks.com) ใพใงใ”้€ฃ็ตกใใ ใ•ใ„ใ€‚.", + "parameters": [ + { + "name": "blockchainDescriptor", + "required": false, + "in": "query", + "description": "ใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณ่จ˜่ฟฐๅญใƒ•ใ‚ฃใƒซใ‚ฟใƒผ", + "schema": { + "oneOf": [ + { + "const": "ETH" + }, + { + "const": "ETH_TEST3" + }, + { + "const": "POLYGON" + }, + { + "const": "POLYGON_TEST_MUMBAI" + } + ] + } + }, + { + "name": "vaultAccountIds", + "required": false, + "in": "query", + "description": "Vault ใ‚ขใ‚ซใ‚ฆใƒณใƒˆ ID ใฎใ‚ณใƒณใƒžๅŒบๅˆ‡ใ‚Šใƒชใ‚นใƒˆใ€‚1 ๅ›žใฎใƒชใ‚ฏใ‚จใ‚นใƒˆใงๆœ€ๅคง 100 ๅ€‹ใพใง่จฑๅฏใ•ใ‚Œใพใ™ใ€‚", + "schema": { + "type": "string" + } + }, + { + "name": "ids", + "required": false, + "in": "query", + "description": "NFT ID ใฎใ‚ณใƒณใƒžๅŒบๅˆ‡ใ‚Šใƒชใ‚นใƒˆใ€‚1 ๅ›žใฎใƒชใ‚ฏใ‚จใ‚นใƒˆใงๆœ€ๅคง 100 ๅ€‹ใพใง่จฑๅฏใ•ใ‚Œใพใ™ใ€‚.", + "schema": { + "type": "string" + } + }, + { + "name": "collectionIds", + "required": false, + "in": "query", + "description": "ใ‚ณใƒฌใ‚ฏใ‚ทใƒงใƒณ ID ใฎใ‚ซใƒณใƒžๅŒบๅˆ‡ใ‚Šใƒชใ‚นใƒˆใ€‚1 ๅ›žใฎใƒชใ‚ฏใ‚จใ‚นใƒˆใงๆœ€ๅคง 100 ๅ€‹ใพใง่จฑๅฏใ•ใ‚Œใพใ™ใ€‚.", + "schema": { + "type": "string" + } + }, + { + "name": "pageCursor", + "required": false, + "in": "query", + "description": "ๅ–ๅพ—ใ™ใ‚‹ใƒšใƒผใ‚ธใ‚ซใƒผใ‚ฝใƒซ", + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "required": false, + "in": "query", + "description": "1 ใƒšใƒผใ‚ธใ‚ใŸใ‚Šใฎ้ …็›ฎๆ•ฐ (ๆœ€ๅคง 100)", + "schema": { + "minimum": 1, + "maximum": 100, + "type": "number" + } + }, + { + "name": "sort", + "required": false, + "in": "query", + "description": "ใƒ‘ใƒฉใƒกใƒผใ‚ฟใงไธฆในๆ›ฟใˆใพใ™ใ€‚1 ใคใฎใƒ‘ใƒฉใƒกใƒผใ‚ฟใ€ใพใŸใฏใ‚ซใƒณใƒžใงๅŒบๅˆ‡ใ‚‰ใ‚ŒใŸใƒ‘ใƒฉใƒกใƒผใ‚ฟใฎใƒชใ‚นใƒˆใ‚’ๆŒ‡ๅฎšใงใใพใ™ใ€‚", + "schema": { + "type": "array", + "items": { + "oneOf": [ + { + "const": "ownershipLastUpdateTime" + }, + { + "const": "name" + }, + { + "const": "collection.name" + }, + { + "const": "blockchainDescriptor" + } + ] + } + } + }, + { + "name": "order", + "required": false, + "in": "query", + "description": "้ †ๅบใฎๆ–นๅ‘ใ€‚ๆ˜‡้ †ใฎๅ ดๅˆใฏใ€ŒASCใ€ใ€้™้ †ใฎๅ ดๅˆใฏใ€ŒDESCใ€ใซใชใ‚Šใพใ™ใ€‚", + "schema": { + "oneOf": [ + { + "const": "DESC" + }, + { + "const": "ASC" + } + ] + } + }, + { + "name": "status", + "required": false, + "in": "query", + "description": "ใƒˆใƒผใ‚ฏใƒณใฎๆ‰€ๆœ‰ๆจฉใ‚นใƒ†ใƒผใ‚ฟใ‚น", + "schema": { + "oneOf": [ + { + "const": "LISTED" + }, + { + "const": "ARCHIVED" + } + ] + } + }, + { + "name": "search", + "required": false, + "in": "query", + "description": "ๆ‰€ๆœ‰ใƒˆใƒผใ‚ฏใƒณใจใใฎใ‚ณใƒฌใ‚ฏใ‚ทใƒงใƒณใ‚’ๆคœ็ดขใ—ใพใ™ใ€‚ๆคœ็ดขใฎๅฏ่ƒฝใชๅŸบๆบ–: ใ‚ณใƒณใƒˆใƒฉใ‚ฏใƒˆ/ใ‚ณใƒฌใ‚ฏใ‚ทใƒงใƒณๅ†…ใฎใƒˆใƒผใ‚ฏใƒณๅใจIDใ€ใ‚ณใƒฌใ‚ฏใ‚ทใƒงใƒณๅใ€ใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณ่จ˜่ฟฐๅญใจๅๅ‰.", + "schema": { + "maximum": 100, + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "properties": { + "paging": { + "$ref": "#/components/schemas/Paging" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TokenOwnershipResponse" + } + } + } + } + } + } + } + }, + "tags": [ + "NFTs (Beta)" + ] + } + }, + "/nfts/ownership/collections": { + "get": { + "operationId": "listOwnedCollections", + "summary": "ๆ‰€ๆœ‰ใ‚ณใƒฌใ‚ฏใ‚ทใƒงใƒณใฎไธ€่ฆง๏ผˆใƒšใƒผใ‚ธๅŒบๅˆ‡ใ‚Š๏ผ‰", + "description": "ใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚นๅ†…ใฎใ™ในใฆใฎใ‚ณใƒฌใ‚ฏใ‚ทใƒงใƒณใ‚’่ฟ”ใ—ใพใ™ **ๆณจ**: ใ“ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฏ็พๅœจใƒ™ใƒผใ‚ฟ็‰ˆใงใ‚ใ‚Šใ€็พๆ™‚็‚นใงใฏไธ€่ˆฌๅ…ฌ้–‹ใ•ใ‚Œใฆใ„ใพใ›ใ‚“ใ€‚ใƒ™ใƒผใ‚ฟ็‰ˆใซ็™ป้Œฒใ—ใฆใ“ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใ‚’ๆœ‰ๅŠนใซใ™ใ‚‹ใซใฏใ€Fireblocks ใ‚ซใ‚นใ‚ฟใƒžใƒผ ใ‚ตใ‚ฏใ‚ปใ‚น ใƒžใƒใƒผใ‚ธใƒฃใƒผใซ้€ฃ็ตกใ™ใ‚‹ใ‹ใ€[CSM@fireblocks.com](mailto:CSM@fireblocks.com) ใพใงใ”้€ฃ็ตกใใ ใ•ใ„ใ€‚.", + "parameters": [ + { + "name": "search", + "required": false, + "in": "query", + "description": "ๆ‰€ๆœ‰ใ‚ณใƒฌใ‚ฏใ‚ทใƒงใƒณใ‚’ๆคœ็ดขใ—ใพใ™ใ€‚ๆคœ็ดขใฎๅฏ่ƒฝใชๆกไปถ: ใ‚ณใƒฌใ‚ฏใ‚ทใƒงใƒณๅใ€ใ‚ณใƒฌใ‚ฏใ‚ทใƒงใƒณๅฅ‘็ด„ใ‚ขใƒ‰ใƒฌใ‚น.", + "schema": { + "maximum": 100, + "type": "string" + } + }, + { + "name": "pageCursor", + "required": false, + "in": "query", + "description": "ๅ–ๅพ—ใ™ใ‚‹ใƒšใƒผใ‚ธใ‚ซใƒผใ‚ฝใƒซ", + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "required": false, + "in": "query", + "description": "1 ใƒšใƒผใ‚ธใ‚ใŸใ‚Šใฎ้ …็›ฎๆ•ฐ (ๆœ€ๅคง 100)", + "schema": { + "minimum": 1, + "maximum": 100, + "type": "number" + } + }, + { + "name": "sort", + "required": false, + "in": "query", + "description": "ใƒ‘ใƒฉใƒกใƒผใ‚ฟใงไธฆในๆ›ฟใˆใพใ™ใ€‚1 ใคใฎใƒ‘ใƒฉใƒกใƒผใ‚ฟใ€ใพใŸใฏใ‚ซใƒณใƒžใงๅŒบๅˆ‡ใ‚‰ใ‚ŒใŸใƒ‘ใƒฉใƒกใƒผใ‚ฟใฎใƒชใ‚นใƒˆใ‚’ๆŒ‡ๅฎšใงใใพใ™ใ€‚", + "schema": { + "type": "array", + "items": { + "const": "name" + } + } + }, + { + "name": "order", + "required": false, + "in": "query", + "description": "้ †ๅบใฎๆ–นๅ‘ใ€‚ๆ˜‡้ †ใฎๅ ดๅˆใฏใ€ŒASCใ€ใ€้™้ †ใฎๅ ดๅˆใฏใ€ŒDESCใ€ใซใชใ‚Šใพใ™ใ€‚", + "schema": { + "oneOf": [ + { + "const": "DESC" + }, + { + "const": "ASC" + } + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "properties": { + "paging": { + "$ref": "#/components/schemas/Paging" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CollectionOwnershipResponse" + } + } + } + } + } + } + } + }, + "tags": [ + "NFTs (Beta)" + ] + } + }, + "/nfts/tokens/{id}": { + "put": { + "operationId": "refreshNFTMetadata", + "summary": "ใƒชใƒ•ใƒฌใƒƒใ‚ทใƒฅใƒˆใƒผใ‚ฏใƒณใฎใƒกใ‚ฟใƒ‡ใƒผใ‚ฟ", + "description": "ๆœ€ๆ–ฐใฎใƒˆใƒผใ‚ฏใƒณ ใƒกใ‚ฟใƒ‡ใƒผใ‚ฟใ‚’ๆ›ดๆ–ฐใ—ใพใ™ใ€‚**ๆณจ**: ใ“ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฏ็พๅœจใƒ™ใƒผใ‚ฟ็‰ˆใงใ‚ใ‚Šใ€็พๆ™‚็‚นใงใฏไธ€่ˆฌๅ…ฌ้–‹ใ•ใ‚Œใฆใ„ใพใ›ใ‚“ใ€‚ใƒ™ใƒผใ‚ฟ็‰ˆใซ็™ป้Œฒใ—ใฆใ“ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใ‚’ๆœ‰ๅŠนใซใ™ใ‚‹ใซใฏใ€Fireblocks ใ‚ซใ‚นใ‚ฟใƒžใƒผ ใ‚ตใ‚ฏใ‚ปใ‚น ใƒžใƒใƒผใ‚ธใƒฃใƒผใซ้€ฃ็ตกใ™ใ‚‹ใ‹ใ€[CSM@fireblocks.com](mailto:CSM@fireblocks.com) ใพใงใ”้€ฃ็ตกใใ ใ•ใ„ใ€‚.", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "description": "NFT ID", + "example": "NFT-abcdefabcdefabcdefabcdefabcdefabcdefabcd", + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + } + }, + "tags": [ + "NFTs (Beta)" + ] + }, + "get": { + "operationId": "getNFT", + "summary": "IDๅˆฅใซใƒˆใƒผใ‚ฏใƒณใƒ‡ใƒผใ‚ฟใ‚’ไธ€่ฆง่กจ็คบใ™ใ‚‹", + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸใƒˆใƒผใ‚ฏใƒณ ใƒ‡ใƒผใ‚ฟใ‚’่ฟ”ใ—ใพใ™ใ€‚**ๆณจ**: ใ“ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฏ็พๅœจใƒ™ใƒผใ‚ฟ็‰ˆใงใ‚ใ‚Šใ€็พๆ™‚็‚นใงใฏไธ€่ˆฌๅ…ฌ้–‹ใ•ใ‚Œใฆใ„ใพใ›ใ‚“ใ€‚ใƒ™ใƒผใ‚ฟ็‰ˆใซ็™ป้Œฒใ—ใฆใ“ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใ‚’ๆœ‰ๅŠนใซใ™ใ‚‹ใซใฏใ€Fireblocks ใ‚ซใ‚นใ‚ฟใƒžใƒผ ใ‚ตใ‚ฏใ‚ปใ‚น ใƒžใƒใƒผใ‚ธใƒฃใƒผใซ้€ฃ็ตกใ™ใ‚‹ใ‹ใ€[CSM@fireblocks.com](mailto:CSM@fireblocks.com) ใพใงใ”้€ฃ็ตกใใ ใ•ใ„ใ€‚.", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "description": "NFT ID", + "example": "NFT-abcdefabcdefabcdefabcdefabcdefabcdefabcd", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TokenResponse" + } + } + } + } + }, + "tags": [ + "NFTs (Beta)" + ] + } + }, + "/nfts/tokens": { + "get": { + "operationId": "getNFTs", + "summary": "IDๅˆฅใซใƒˆใƒผใ‚ฏใƒณใ‚’ไธ€่ฆง่กจ็คบใ™ใ‚‹", + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸใƒˆใƒผใ‚ฏใƒณ ใƒ‡ใƒผใ‚ฟใ‚’่ฟ”ใ—ใพใ™ **ๆณจ**: ใ“ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฏ็พๅœจใƒ™ใƒผใ‚ฟ็‰ˆใงใ‚ใ‚Šใ€็พๆ™‚็‚นใงใฏไธ€่ˆฌๅ…ฌ้–‹ใ•ใ‚Œใฆใ„ใพใ›ใ‚“ใ€‚ใƒ™ใƒผใ‚ฟ็‰ˆใซ็™ป้Œฒใ—ใฆใ“ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใ‚’ๆœ‰ๅŠนใซใ™ใ‚‹ใซใฏใ€Fireblocks ใ‚ซใ‚นใ‚ฟใƒžใƒผ ใ‚ตใ‚ฏใ‚ปใ‚น ใƒžใƒใƒผใ‚ธใƒฃใƒผใซ้€ฃ็ตกใ™ใ‚‹ใ‹ใ€[CSM@fireblocks.com](mailto:CSM@fireblocks.com) ใพใงใ”้€ฃ็ตกใใ ใ•ใ„ใ€‚.", + "parameters": [ + { + "name": "ids", + "required": true, + "in": "query", + "description": "NFT ID ใฎใ‚ณใƒณใƒžๅŒบๅˆ‡ใ‚Šใƒชใ‚นใƒˆใ€‚1 ๅ›žใฎใƒชใ‚ฏใ‚จใ‚นใƒˆใงๆœ€ๅคง 100 ๅ€‹ใพใง่จฑๅฏใ•ใ‚Œใพใ™ใ€‚.", + "schema": { + "type": "string" + } + }, + { + "name": "pageCursor", + "required": false, + "in": "query", + "description": "ๅ–ๅพ—ใ™ใ‚‹ใƒšใƒผใ‚ธใ‚ซใƒผใ‚ฝใƒซ", + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "required": false, + "in": "query", + "description": "1 ใƒšใƒผใ‚ธใ‚ใŸใ‚Šใฎ้ …็›ฎๆ•ฐ (ๆœ€ๅคง 100)", + "schema": { + "minimum": 1, + "maximum": 100, + "type": "number" + } + }, + { + "name": "sort", + "required": false, + "in": "query", + "description": "ใƒ‘ใƒฉใƒกใƒผใ‚ฟใงไธฆในๆ›ฟใˆใพใ™ใ€‚1 ใคใฎใƒ‘ใƒฉใƒกใƒผใ‚ฟใ€ใพใŸใฏใ‚ซใƒณใƒžใงๅŒบๅˆ‡ใ‚‰ใ‚ŒใŸใƒ‘ใƒฉใƒกใƒผใ‚ฟใฎใƒชใ‚นใƒˆใ‚’ๆŒ‡ๅฎšใงใใพใ™ใ€‚", + "schema": { + "type": "array", + "items": { + "oneOf": [ + { + "const": "collection.name" + }, + { + "const": "name" + }, + { + "const": "blockchainDescriptor" + } + ] + } + } + }, + { + "name": "order", + "required": false, + "in": "query", + "description": "้ †ๅบใฎๆ–นๅ‘ใ€‚ๆ˜‡้ †ใฎๅ ดๅˆใฏใ€ŒASCใ€ใ€้™้ †ใฎๅ ดๅˆใฏใ€ŒDESCใ€ใซใชใ‚Šใพใ™ใ€‚", + "schema": { + "oneOf": [ + { + "const": "DESC" + }, + { + "const": "ASC" + } + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "properties": { + "paging": { + "$ref": "#/components/schemas/Paging" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TokenResponse" + } + } + } + } + } + } + } + }, + "tags": [ + "NFTs (Beta)" + ] + } + }, + "/nfts/ownership/tokens/{id}/status": { + "put": { + "operationId": "updateTokenOwnershipStatus", + "summary": "ใƒˆใƒผใ‚ฏใƒณใฎๆ‰€ๆœ‰ๆจฉใ‚นใƒ†ใƒผใ‚ฟใ‚นใ‚’ๆ›ดๆ–ฐใ™ใ‚‹", + "description": "ใ™ในใฆใฎใƒ†ใƒŠใƒณใƒˆ ใƒœใƒผใƒซใƒˆใงใ€ใƒ†ใƒŠใƒณใƒˆใฎใƒˆใƒผใ‚ฏใƒณๆ‰€ๆœ‰ๆจฉใ‚นใƒ†ใƒผใ‚ฟใ‚นใ‚’ๆ›ดๆ–ฐใ—ใพใ™ใ€‚**ๆณจ**: ใ“ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฏ็พๅœจใƒ™ใƒผใ‚ฟ็‰ˆใงใ‚ใ‚Šใ€็พๆ™‚็‚นใงใฏไธ€่ˆฌๅ…ฌ้–‹ใ•ใ‚Œใฆใ„ใพใ›ใ‚“ใ€‚ใƒ™ใƒผใ‚ฟ็‰ˆใซ็™ป้Œฒใ—ใฆใ“ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใ‚’ๆœ‰ๅŠนใซใ™ใ‚‹ใซใฏใ€Fireblocks ใ‚ซใ‚นใ‚ฟใƒžใƒผ ใ‚ตใ‚ฏใ‚ปใ‚น ใƒžใƒใƒผใ‚ธใƒฃใƒผใซ้€ฃ็ตกใ™ใ‚‹ใ‹ใ€[CSM@fireblocks.com](mailto:CSM@fireblocks.com) ใพใงใ”้€ฃ็ตกใใ ใ•ใ„ใ€‚.", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "description": "NFT ID", + "example": "NFT-abcdefabcdefabcdefabcdefabcdefabcdefabcd", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateTokenOwnershipStatusDto" + } + } + } + }, + "responses": { + "200": { + "description": "", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + } + }, + "tags": [ + "NFTs (Beta)" + ] + } + }, + "/connections": { + "get": { + "operationId": "get", + "summary": "้–‹ใ„ใฆใ„ใ‚‹ใ™ในใฆใฎWeb3ๆŽฅ็ถšใ‚’ไธ€่ฆง่กจ็คบใ™ใ‚‹.", + "description": "ใ‚ชใƒผใƒ—ใƒณใชWeb3ๆŽฅ็ถšใ‚’ๅ–ๅพ—ใ™ใ‚‹.", + "parameters": [ + { + "name": "order", + "required": false, + "in": "query", + "description": "ใƒชใ‚นใƒˆใฎ้ †ๅบ๏ผˆๆ˜‡้ †ใพใŸใฏ้™้ †๏ผ‰.", + "schema": { + "oneOf": [ + { + "const": "ASC" + }, + { + "const": "DESC" + } + ] + } + }, + { + "name": "filter", + "required": false, + "in": "query", + "description": "่งฃๆžใ•ใ‚ŒใŸใƒ•ใ‚ฃใƒซใ‚ฟใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "examples": { + "object": { + "summary": "ใƒ•ใ‚ฃใƒซใ‚ฟใƒผใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "description": "", + "value": { + "id": "string", + "userId": "string", + "vaultAccountId": "number", + "connectionMethod": "string", + "feeLevel": "string", + "appUrl": "string", + "appName": "string" + } + }, + "stringified": { + "summary": "ๆ–‡ๅญ—ๅˆ—ๅŒ–ใ•ใ‚ŒใŸ่งฃๆžใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "description": "ๆ–‡ๅญ—ๅˆ—ๅŒ–ใ•ใ‚ŒใŸ่งฃๆžใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆใซใคใ„ใฆ: * ๅ„ใ‚ญใƒผใจๅ€คใฎใƒšใ‚ขใฏ '=' ใงๅŒบๅˆ‡ใ‚‰ใ‚Œใ€ๅ„ใƒšใ‚ขใฏ ',' ใงๅŒบๅˆ‡ใ‚‰ใ‚Œใพใ™ (ใ“ใ‚Œใซใฏ [`qs`](https://www.npmjs.com/package/qs) ใƒ‘ใƒƒใ‚ฑใƒผใ‚ธใ‚’ไฝฟ็”จใงใใพใ™)", + "value": "id=string,userId=string,vaultAccountId=number,connectionMethod=string,feeLevel=string,appUrl=string,appName=string" + } + }, + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "userId": { + "type": "string" + }, + "vaultAccountId": { + "type": "number" + }, + "connectionMethod": { + "type": "string" + }, + "feeLevel": { + "type": "string" + }, + "appUrl": { + "type": "string" + }, + "appName": { + "type": "string" + } + } + } + }, + { + "name": "sort", + "required": false, + "in": "query", + "description": "Web3ๆŽฅ็ถšใ‚’ไธฆในๆ›ฟใˆใ‚‹ใƒ—ใƒญใƒ‘ใƒ†ใ‚ฃ.", + "schema": { + "oneOf": [ + { + "const": "id" + }, + { + "const": "userId" + }, + { + "const": "vaultAccountId" + }, + { + "const": "createdAt" + }, + { + "const": "feeLevel" + }, + { + "const": "appUrl" + }, + { + "const": "appName" + } + ] + } + }, + { + "name": "pageSize", + "required": false, + "in": "query", + "description": "ๆฌกใฎใƒšใƒผใ‚ธใง่ฟ”ใ•ใ‚Œใ‚‹็ตๆžœใฎๆ•ฐ.", + "schema": { + "type": "number", + "default": 10, + "maximum": 50 + } + }, + { + "name": "next", + "required": false, + "in": "query", + "description": "ๆฌกใฎใƒšใƒผใ‚ธใซใ‚ซใƒผใ‚ฝใƒซใ‚’็งปๅ‹•", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetConnectionsResponse" + } + } + } + }, + "400": { + "description": "ใ‚ฏใ‚จใƒชใƒ‘ใƒฉใƒกใƒผใ‚ฟใŒ็„กๅŠนใงใ™", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + }, + "500": { + "description": "ๅ•้กŒใŒ็™บ็”Ÿใ—ใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + } + }, + "tags": [ + "Web3 connections" + ] + } + }, + "/connections/wc": { + "post": { + "operationId": "create", + "summary": "ๆ–ฐใ—ใ„Web3ๆŽฅ็ถšใ‚’ไฝœๆˆใ™ใ‚‹.", + "description": "ๆ–ฐใ—ใ„ Web3 ๆŽฅ็ถšใ‚’้–‹ๅง‹ใ—ใพใ™ใ€‚ * ๆณจ: ใ“ใ‚ŒใŒๆˆๅŠŸใ—ใŸใ‚‰ใ€ๆ–ฐใ—ใ„ Web3 ๆŽฅ็ถšใ‚’ๆ‰ฟ่ชใพใŸใฏๆ‹’ๅฆใ™ใ‚‹ใŸใ‚ใซใ€`PUT /v1/connections/wc/{id}` (ไปฅไธ‹) ใซใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’้€ไฟกใ—ใพใ™ใ€‚.", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateConnectionRequest" + } + } + } + }, + "responses": { + "201": { + "description": "Web3ๆŽฅ็ถšใŒๆญฃๅธธใซ้–‹ๅง‹ใ•ใ‚Œใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateConnectionResponse" + } + } + } + }, + "400": { + "description": "็„กๅŠนใชใƒ‡ใƒผใ‚ฟใŒ้€ไฟกใ•ใ‚Œใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + }, + "500": { + "description": "ๅ•้กŒใŒ็™บ็”Ÿใ—ใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + } + }, + "tags": [ + "Web3 connections" + ] + } + }, + "/connections/wc/{id}": { + "put": { + "operationId": "submit", + "summary": "ไฟ็•™ไธญใฎWeb3ๆŽฅ็ถš่ฆๆฑ‚ใซๅฟœ็ญ”ใ™ใ‚‹.", + "description": "้–‹ๅง‹ใ•ใ‚ŒใŸ Web3 ๆŽฅ็ถšใ‚’ *ๆ‰ฟ่ช* ใพใŸใฏ *ๆ‹’ๅฆ* ใ™ใ‚‹ๅฟœ็ญ”ใ‚’้€ไฟกใ—ใพใ™ใ€‚ * ๆณจ: ใ“ใฎๅ‘ผใณๅ‡บใ—ใฏใ€`POST /v1/connections/wc/` ่ฆๆฑ‚ใ‚’ๅฎŒไบ†ใ™ใ‚‹ใŸใ‚ใซไฝฟ็”จใ•ใ‚Œใพใ™ใ€‚ใ“ใ‚ŒใŒๆˆๅŠŸใ™ใ‚‹ใจใ€ๆ–ฐใ—ใ„ Web3 ๆŽฅ็ถšใŒไฝœๆˆใ•ใ‚Œใ€ๆฉŸ่ƒฝใ—ใพใ™ใ€‚.", + "parameters": [ + { + "name": "id", + "description": "ๆ‰ฟ่ชใ™ใ‚‹้–‹ๅง‹ใ•ใ‚ŒใŸWeb3ๆŽฅ็ถšใฎID.", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RespondToConnectionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "ๆŽฅ็ถšใŒๆญฃๅธธใซ้€ไฟกใ•ใ‚Œใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + }, + "400": { + "description": "็„กๅŠนใชใƒ‡ใƒผใ‚ฟใŒ้€ไฟกใ•ใ‚Œใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + }, + "404": { + "description": "ๆŽฅ็ถšใŒ่ฆ‹ใคใ‹ใ‚Šใพใ›ใ‚“", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + }, + "500": { + "description": "ๅ•้กŒใŒ็™บ็”Ÿใ—ใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + } + }, + "tags": [ + "Web3 connections" + ] + }, + "delete": { + "operationId": "remove", + "summary": "ๆ—ขๅญ˜ใฎWeb3ๆŽฅ็ถšใ‚’ๅ‰Š้™คใ™ใ‚‹.", + "description": "Web3ๆŽฅ็ถšใ‚’ๅ‰Š้™คใ™ใ‚‹", + "parameters": [ + { + "name": "id", + "description": "ๅ‰Š้™คใ™ใ‚‹ๆ—ขๅญ˜ใฎWeb3ๆŽฅ็ถšใฎID.", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "ๆŽฅ็ถšใŒๆญฃๅธธใซๅ‰Š้™คใ•ใ‚Œใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + }, + "404": { + "description": "ๆŽฅ็ถšใŒ่ฆ‹ใคใ‹ใ‚Šใพใ›ใ‚“", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + }, + "500": { + "description": "ๅ•้กŒใŒ็™บ็”Ÿใ—ใพใ—ใŸ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + } + } + }, + "tags": [ + "Web3 connections" + ] + } + }, + "/screening/travel_rule/transaction/validate": { + "post": { + "operationId": "TravelRuleApiController_validate", + "summary": "ใƒˆใƒฉใƒ™ใƒซใƒซใƒผใƒซใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎๆคœ่จผ", + "description": "ใƒˆใƒฉใƒ™ใƒซ ใƒซใƒผใƒซ ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚’ๆคœ่จผใ—ใพใ™ใ€‚็ฎก่ฝ„ๅŒบๅŸŸใจๅ—็›Š่€…ใฎ็ฎก่ฝ„ๅŒบๅŸŸใงๅฟ…่ฆใชๅ—็›Š่€… VASP ใฎ่ฉณ็ดฐใ‚’็ขบ่ชใ—ใพใ™ใ€‚**ๆณจ:** ใ“ใฎใ‚ปใ‚ฏใ‚ทใƒงใƒณใฎๅ‚็…งใ‚ณใƒณใƒ†ใƒณใƒ„ใฏใ€ใƒˆใƒฉใƒ™ใƒซ ใƒซใƒผใƒซ ใƒ™ใƒผใ‚ฟ ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซใคใ„ใฆ่ชฌๆ˜Žใ—ใฆใ„ใพใ™ใ€‚ใƒ™ใƒผใ‚ฟ ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซใฏใ€็พๅœจใƒ—ใƒฌใƒ“ใƒฅใƒผๆฎต้šŽใซใ‚ใ‚Šใ€ใพใ ไธ€่ˆฌใซใฏๅˆฉ็”จใงใใชใ„ API ใŒๅซใพใ‚Œใฆใ„ใพใ™ใ€‚ใƒ™ใƒผใ‚ฟใซ็™ป้Œฒใ—ใฆใ“ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใ‚’ๆœ‰ๅŠนใซใ™ใ‚‹ใซใฏใ€Fireblocks ใ‚ซใ‚นใ‚ฟใƒžใƒผ ใ‚ตใ‚ฏใ‚ปใ‚น ใƒžใƒใƒผใ‚ธใƒฃใƒผใซ้€ฃ็ตกใ™ใ‚‹ใ‹ใ€[CSM@fireblocks.com](mailto:CSM@fireblocks.com) ใซใƒกใƒผใƒซใ‚’้€ไฟกใ—ใฆใใ ใ•ใ„ใ€‚.", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TravelRuleValidateTransactionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "ๅ–ๅผ•ใŒๆญฃๅธธใซๆคœ่จผใ•ใ‚Œใพใ—ใŸ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TravelRuleValidateTransactionResponse" + } + } + } + }, + "400": { + "description": "ใƒชใ‚ฏใ‚จใ‚นใƒˆๆœฌๆ–‡ใŒ็„กๅŠนใงใ™" + }, + "500": { + "description": "ๅ†…้ƒจใ‚ตใƒผใƒใƒผใ‚จใƒฉใƒผ" + } + }, + "tags": [ + "Travel Rule (Beta)" + ] + } + }, + "/screening/travel_rule/transaction/validate/full": { + "post": { + "operationId": "TravelRuleApiController_validateFull", + "summary": "ๅฎŒๅ…จใชใƒˆใƒฉใƒ™ใƒซใƒซใƒผใƒซใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚’ๆคœ่จผใ™ใ‚‹", + "description": "ๅฎŒๅ…จใชใƒˆใƒฉใƒ™ใƒซ ใƒซใƒผใƒซ ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚’ๆคœ่จผใ—ใพใ™ใ€‚็™บไฟก่€…ใจๅ—็›Š่€…ใฎ VASP ใซ้–ขใ™ใ‚‹ใ™ในใฆใฎๅฟ…่ฆใชๆƒ…ๅ ฑใ‚’็ขบ่ชใ—ใพใ™ใ€‚**ๆณจ:** ใ“ใฎใ‚ปใ‚ฏใ‚ทใƒงใƒณใฎๅ‚็…งใ‚ณใƒณใƒ†ใƒณใƒ„ใฏใ€ใƒˆใƒฉใƒ™ใƒซ ใƒซใƒผใƒซ ใƒ™ใƒผใ‚ฟ ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซใคใ„ใฆ่ชฌๆ˜Žใ—ใฆใ„ใพใ™ใ€‚ใƒ™ใƒผใ‚ฟ ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซใฏใ€็พๅœจใƒ—ใƒฌใƒ“ใƒฅใƒผๆฎต้šŽใซใ‚ใ‚Šใ€ใพใ ไธ€่ˆฌใซใฏๅˆฉ็”จใงใใชใ„ API ใŒๅซใพใ‚Œใฆใ„ใพใ™ใ€‚ใƒ™ใƒผใ‚ฟใซ็™ป้Œฒใ—ใฆใ“ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใ‚’ๆœ‰ๅŠนใซใ™ใ‚‹ใซใฏใ€Fireblocks ใ‚ซใ‚นใ‚ฟใƒžใƒผ ใ‚ตใ‚ฏใ‚ปใ‚น ใƒžใƒใƒผใ‚ธใƒฃใƒผใซ้€ฃ็ตกใ™ใ‚‹ใ‹ใ€[CSM@fireblocks.com](mailto:CSM@fireblocks.com) ใซใƒกใƒผใƒซใ‚’้€ไฟกใ—ใฆใใ ใ•ใ„ใ€‚.", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TravelRuleValidateFullTransactionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "ๅ–ๅผ•ใŒๆญฃๅธธใซๆคœ่จผใ•ใ‚Œใพใ—ใŸ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TravelRuleValidateTransactionResponse" + } + } + } + }, + "400": { + "description": "ใƒชใ‚ฏใ‚จใ‚นใƒˆๆœฌๆ–‡ใŒ็„กๅŠนใงใ™" + }, + "500": { + "description": "ๅ†…้ƒจใ‚ตใƒผใƒใƒผใ‚จใƒฉใƒผ" + } + }, + "tags": [ + "Travel Rule (Beta)" + ] + } + }, + "/screening/travel_rule/vasp/{did}": { + "get": { + "operationId": "TravelRuleApiController_findVasp", + "summary": "VASPใฎ่ฉณ็ดฐใ‚’่ฆ‹ใ‚‹", + "description": "VASP ใฎ่ฉณ็ดฐใ‚’ๅ–ๅพ—ใ—ใพใ™ใ€‚ๆŒ‡ๅฎšใ•ใ‚ŒใŸ DID ใ‚’ๆŒใค VASP ใซ้–ขใ™ใ‚‹ๆƒ…ๅ ฑใ‚’่ฟ”ใ—ใพใ™ใ€‚**ๆณจ:** ใ“ใฎใ‚ปใ‚ฏใ‚ทใƒงใƒณใฎๅ‚็…งใ‚ณใƒณใƒ†ใƒณใƒ„ใฏใ€Travel Rule ใƒ™ใƒผใ‚ฟ ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซใคใ„ใฆ่ชฌๆ˜Žใ—ใฆใ„ใพใ™ใ€‚ใƒ™ใƒผใ‚ฟ ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซใฏใ€็พๅœจใƒ—ใƒฌใƒ“ใƒฅใƒผๆฎต้šŽใซใ‚ใ‚Šใ€ใพใ ไธ€่ˆฌใซใฏๅˆฉ็”จใงใใชใ„ API ใŒๅซใพใ‚Œใฆใ„ใพใ™ใ€‚ใƒ™ใƒผใ‚ฟใซ็™ป้Œฒใ—ใฆใ“ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใ‚’ๆœ‰ๅŠนใซใ™ใ‚‹ใซใฏใ€Fireblocks ใ‚ซใ‚นใ‚ฟใƒžใƒผ ใ‚ตใ‚ฏใ‚ปใ‚น ใƒžใƒใƒผใ‚ธใƒฃใƒผใซ้€ฃ็ตกใ™ใ‚‹ใ‹ใ€[CSM@fireblocks.com](mailto:CSM@fireblocks.com) ใซใƒกใƒผใƒซใ‚’้€ไฟกใ—ใฆใใ ใ•ใ„ใ€‚.", + "parameters": [ + { + "name": "did", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + }, + { + "name": "fields", + "required": false, + "in": "query", + "description": "่ฟ”ใ•ใ‚Œใ‚‹ใƒ•ใ‚ฃใƒผใƒซใƒ‰ใฎ CSV (ใ™ในใฆใ€็ฉบ็™ฝใ€ใพใŸใฏไปฅไธ‹ใฎใ™ในใฆใฎใƒ•ใ‚ฃใƒผใƒซใƒ‰ๅใฎใƒชใ‚นใƒˆใ‚’ๅ‚็…ง)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "ๅ–ๅผ•ใŒๆญฃๅธธใซๆคœ่จผใ•ใ‚Œใพใ—ใŸ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TravelRuleVASP" + } + } + } + }, + "400": { + "description": "ใƒชใ‚ฏใ‚จใ‚นใƒˆๆœฌๆ–‡ใŒ็„กๅŠนใงใ™" + }, + "500": { + "description": "ๅ†…้ƒจใ‚ตใƒผใƒใƒผใ‚จใƒฉใƒผ" + } + }, + "tags": [ + "Travel Rule (Beta)" + ] + } + }, + "/screening/travel_rule/vasp": { + "get": { + "operationId": "TravelRuleApiController_findAllVasp", + "summary": "ใ™ในใฆใฎVASPใ‚’ๅ–ๅพ—", + "description": "ใ™ในใฆใฎ VASP ใ‚’ๅ–ๅพ—ใ—ใพใ™ใ€‚VASP ใฎใƒชใ‚นใƒˆใ‚’่ฟ”ใ—ใพใ™ใ€‚VASP ใฏๆคœ็ดขใŠใ‚ˆใณไธฆในๆ›ฟใˆใŒๅฏ่ƒฝใงใ€็ตๆžœใฏใƒšใƒผใ‚ธๅˆ†ใ‘ใ•ใ‚Œใพใ™ใ€‚**ๆณจ:** ใ“ใฎใ‚ปใ‚ฏใ‚ทใƒงใƒณใฎๅ‚็…งใ‚ณใƒณใƒ†ใƒณใƒ„ใฏใ€Travel Rule ใƒ™ใƒผใ‚ฟ ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซใคใ„ใฆ่ชฌๆ˜Žใ—ใฆใ„ใพใ™ใ€‚ใƒ™ใƒผใ‚ฟ ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซใฏใ€็พๅœจใƒ—ใƒฌใƒ“ใƒฅใƒผๆฎต้šŽใซใ‚ใ‚Šใ€ใพใ ไธ€่ˆฌใซใฏๅˆฉ็”จใงใใชใ„ API ใŒๅซใพใ‚Œใฆใ„ใพใ™ใ€‚ใƒ™ใƒผใ‚ฟใซ็™ป้Œฒใ—ใฆใ“ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใ‚’ๆœ‰ๅŠนใซใ™ใ‚‹ใซใฏใ€Fireblocks ใ‚ซใ‚นใ‚ฟใƒžใƒผ ใ‚ตใ‚ฏใ‚ปใ‚น ใƒžใƒใƒผใ‚ธใƒฃใƒผใซ้€ฃ็ตกใ™ใ‚‹ใ‹ใ€[CSM@fireblocks.com](mailto:CSM@fireblocks.com) ใซใƒกใƒผใƒซใ‚’้€ไฟกใ—ใฆใใ ใ•ใ„ใ€‚.", + "parameters": [ + { + "name": "order", + "required": false, + "in": "query", + "description": "ไธฆในๆ›ฟใˆใฎๅŸบๆบ–ใจใชใ‚‹ใƒ•ใ‚ฃใƒผใƒซใƒ‰", + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "required": false, + "in": "query", + "description": "ใƒšใƒผใ‚ธใ‚ใŸใ‚Šใฎใƒฌใ‚ณใƒผใƒ‰ๆ•ฐ", + "schema": { + "type": "number" + } + }, + { + "name": "page", + "required": false, + "in": "query", + "description": "ใƒšใƒผใ‚ธ็•ชๅท", + "schema": { + "type": "number" + } + }, + { + "name": "fields", + "required": false, + "in": "query", + "description": "่ฟ”ใ•ใ‚Œใ‚‹ใƒ•ใ‚ฃใƒผใƒซใƒ‰ใฎ CSV (ใ™ในใฆใ€็ฉบ็™ฝใ€ใพใŸใฏไปฅไธ‹ใฎใ™ในใฆใฎใƒ•ใ‚ฃใƒผใƒซใƒ‰ๅใฎใƒชใ‚นใƒˆใ‚’ๅ‚็…ง)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "ใ™ในใฆใฎVASPใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TravelRuleGetAllVASPsResponse" + } + } + } + } + }, + "tags": [ + "Travel Rule (Beta)" + ] + } + }, + "/screeening/travel_rule/vasp/update": { + "put": { + "operationId": "TravelRuleApiController_updateVasp", + "summary": "VASPใฎ่ฉณ็ดฐใซjsonDidKeyใ‚’่ฟฝๅŠ ใ™ใ‚‹", + "description": "VASP ใฎ่ฉณ็ดฐใ‚’ๆ›ดๆ–ฐใ—ใพใ™ใ€‚ๆŒ‡ๅฎšใ•ใ‚ŒใŸใƒ‘ใƒฉใƒกใƒผใ‚ฟใ‚’ไฝฟ็”จใ—ใฆ VASP ใ‚’ๆ›ดๆ–ฐใ—ใพใ™ใ€‚ใ“ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใ‚’ไฝฟ็”จใ—ใฆใ€Notabene ใซใ‚ˆใฃใฆ็”Ÿๆˆใ•ใ‚ŒใŸๅ…ฌ้–‹ jsonDIDkey ใ‚’่ฟฝๅŠ ใ—ใพใ™ใ€‚**ๆณจ:** ใ“ใฎใ‚ปใ‚ฏใ‚ทใƒงใƒณใฎๅ‚็…งใ‚ณใƒณใƒ†ใƒณใƒ„ใฏใ€Travel Rule ใƒ™ใƒผใ‚ฟ ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซใคใ„ใฆ่ชฌๆ˜Žใ—ใฆใ„ใพใ™ใ€‚ใƒ™ใƒผใ‚ฟ ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใซใฏใ€็พๅœจใƒ—ใƒฌใƒ“ใƒฅใƒผไธญใงใพใ ไธ€่ˆฌใซใฏๅˆฉ็”จใงใใชใ„ API ใŒๅซใพใ‚Œใฆใ„ใพใ™ใ€‚ใƒ™ใƒผใ‚ฟใซ็™ป้Œฒใ—ใฆใ“ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใ‚’ๆœ‰ๅŠนใซใ™ใ‚‹ใซใฏใ€Fireblocks ใ‚ซใ‚นใ‚ฟใƒžใƒผ ใ‚ตใ‚ฏใ‚ปใ‚น ใƒžใƒใƒผใ‚ธใƒฃใƒผใซ้€ฃ็ตกใ™ใ‚‹ใ‹ใ€[CSM@fireblocks.com](mailto:CSM@fireblocks.com) ใซใƒกใƒผใƒซใ‚’้€ไฟกใ—ใฆใใ ใ•ใ„ใ€‚.", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TravelRuleUpdateVASPDetails" + } + } + } + }, + "responses": { + "200": { + "description": "VASP ใŒๆญฃๅธธใซๆ›ดๆ–ฐใ•ใ‚Œใพใ—ใŸ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TravelRuleUpdateVASPDetails" + } + } + } + }, + "400": { + "description": "ใƒชใ‚ฏใ‚จใ‚นใƒˆๆœฌๆ–‡ใŒ็„กๅŠนใงใ™" + }, + "500": { + "description": "ๅ†…้ƒจใ‚ตใƒผใƒใƒผใ‚จใƒฉใƒผ" + } + }, + "tags": [ + "Travel Rule (Beta)" + ] + } + }, + "/tap/active_policy": { + "get": { + "summary": "ใ‚ขใ‚ฏใƒ†ใ‚ฃใƒ–ใชใƒใƒชใ‚ทใƒผใจใใฎๆคœ่จผใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "description": "ใ‚ขใ‚ฏใƒ†ใ‚ฃใƒ–ใชใƒใƒชใ‚ทใƒผใจใใฎๆคœ่จผใ‚’่ฟ”ใ—ใพใ™ใ€‚
**ๆณจ:** ใ“ใ‚Œใ‚‰ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฏ็พๅœจใƒ™ใƒผใ‚ฟ็‰ˆใงใ‚ใ‚Šใ€ๅค‰ๆ›ดใ•ใ‚Œใ‚‹ๅฏ่ƒฝๆ€งใŒใ‚ใ‚Šใพใ™ใ€‚Fireblocks TAP ใซๅ‚ๅŠ ใ—ใฆ่ฉณ็ดฐใ‚’็Ÿฅใ‚ŠใŸใ„ๅ ดๅˆใฏใ€Fireblocks ใ‚ซใ‚นใ‚ฟใƒžใƒผ ใ‚ตใ‚ฏใ‚ปใ‚น ใƒžใƒใƒผใ‚ธใƒฃใƒผใซ้€ฃ็ตกใ™ใ‚‹ใ‹ใ€CSM@fireblocks.com ใซใƒกใƒผใƒซใ‚’้€ไฟกใ—ใฆใใ ใ•ใ„ใ€‚.", + "tags": [ + "Policy Editor (Beta)" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "policy = fireblocks.get_active_policy()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const policy = await fireblocks.getActivePolicy();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "ใƒใƒชใ‚ทใƒผใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PolicyAndValidationResponse" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/tap/draft": { + "get": { + "summary": "ใ‚ขใ‚ฏใƒ†ใ‚ฃใƒ–ใชใƒ‰ใƒฉใƒ•ใƒˆใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "description": "ใ‚ขใ‚ฏใƒ†ใ‚ฃใƒ–ใชใƒ‰ใƒฉใƒ•ใƒˆใจใใฎๆคœ่จผใ‚’่ฟ”ใ—ใพใ™ใ€‚
**ๆณจ:** ใ“ใ‚Œใ‚‰ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฏ็พๅœจใƒ™ใƒผใ‚ฟ็‰ˆใงใ‚ใ‚Šใ€ๅค‰ๆ›ดใ•ใ‚Œใ‚‹ๅฏ่ƒฝๆ€งใŒใ‚ใ‚Šใพใ™ใ€‚Fireblocks TAP ใซๅ‚ๅŠ ใ—ใฆ่ฉณ็ดฐใ‚’็Ÿฅใ‚ŠใŸใ„ๅ ดๅˆใฏใ€Fireblocks ใ‚ซใ‚นใ‚ฟใƒžใƒผ ใ‚ตใ‚ฏใ‚ปใ‚น ใƒžใƒใƒผใ‚ธใƒฃใƒผใซ้€ฃ็ตกใ™ใ‚‹ใ‹ใ€CSM@fireblocks.com ใซใƒกใƒผใƒซใ‚’้€ไฟกใ—ใฆใใ ใ•ใ„ใ€‚.", + "tags": [ + "Policy Editor (Beta)" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "policy = fireblocks.get_draft()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const policy = await fireblocks.getDraft();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "ใƒ‰ใƒฉใƒ•ใƒˆๆคœ่จผๅฟœ็ญ”ใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/DraftReviewAndValidationResponse" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "put": { + "summary": "ๆ–ฐใ—ใ„ใƒซใƒผใƒซใ‚ปใƒƒใƒˆใงใƒ‰ใƒฉใƒ•ใƒˆใ‚’ๆ›ดๆ–ฐใ™ใ‚‹", + "description": "ใƒ‰ใƒฉใƒ•ใƒˆใ‚’ๆ›ดๆ–ฐใ—ใ€ๆคœ่จผใ‚’่ฟ”ใ—ใพใ™ใ€‚
**ๆณจ:** ใ“ใ‚Œใ‚‰ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฏ็พๅœจใƒ™ใƒผใ‚ฟ็‰ˆใงใ‚ใ‚Šใ€ๅค‰ๆ›ดใ•ใ‚Œใ‚‹ๅฏ่ƒฝๆ€งใŒใ‚ใ‚Šใพใ™ใ€‚Fireblocks TAP ใซๅ‚ๅŠ ใ—ใฆ่ฉณ็ดฐใ‚’็Ÿฅใ‚ŠใŸใ„ๅ ดๅˆใฏใ€Fireblocks ใ‚ซใ‚นใ‚ฟใƒžใƒผ ใ‚ตใ‚ฏใ‚ปใ‚น ใƒžใƒใƒผใ‚ธใƒฃใƒผใซ้€ฃ็ตกใ™ใ‚‹ใ‹ใ€CSM@fireblocks.com ใซใƒกใƒผใƒซใ‚’้€ไฟกใ—ใฆใใ ใ•ใ„ใ€‚.", + "tags": [ + "Policy Editor (Beta)" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "policy = fireblocks.update_draft()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const policy = await fireblocks.updateDraft();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "rules": { + "description": "ใƒ‰ใƒฉใƒ•ใƒˆใ‚’ๆ›ดๆ–ฐใ™ใ‚‹ใƒซใƒผใƒซ", + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicyRule" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "ใƒ‰ใƒฉใƒ•ใƒˆๆคœ่จผๅฟœ็ญ”ใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/DraftReviewAndValidationResponse" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "็‰นๅฎšใฎไธ‹ๆ›ธใIDใฎๅ…ฌ้–‹ใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’้€ไฟกใ™ใ‚‹", + "description": "็‰นๅฎšใฎใƒ‰ใƒฉใƒ•ใƒˆ ID ใฎๅ…ฌ้–‹ใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’้€ไฟกใ—ใ€ๅฟœ็ญ”ใ‚’่ฟ”ใ—ใพใ™ใ€‚
**ๆณจ:** ใ“ใ‚Œใ‚‰ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฏ็พๅœจใƒ™ใƒผใ‚ฟ็‰ˆใงใ‚ใ‚Šใ€ๅค‰ๆ›ดใ•ใ‚Œใ‚‹ๅฏ่ƒฝๆ€งใŒใ‚ใ‚Šใพใ™ใ€‚Fireblocks TAP ใซๅ‚ๅŠ ใ—ใฆ่ฉณ็ดฐใ‚’็Ÿฅใ‚ŠใŸใ„ๅ ดๅˆใฏใ€Fireblocks ใ‚ซใ‚นใ‚ฟใƒžใƒผ ใ‚ตใ‚ฏใ‚ปใ‚น ใƒžใƒใƒผใ‚ธใƒฃใƒผใซ้€ฃ็ตกใ™ใ‚‹ใ‹ใ€CSM@fireblocks.com ใซใƒกใƒผใƒซใ‚’้€ไฟกใ—ใฆใใ ใ•ใ„ใ€‚.", + "tags": [ + "Policy Editor (Beta)" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "policy = fireblocks.publish_draft()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const policy = await fireblocks.publishDraft();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "draftId": { + "description": "ใƒ‰ใƒฉใƒ•ใƒˆๅ›บๆœ‰่ญ˜ๅˆฅๅญ", + "type": "string" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "ใƒใƒชใ‚ทใƒผๅ…ฌ้–‹็ตๆžœใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PublishResult" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/tap/publish": { + "post": { + "summary": "ใƒใƒชใ‚ทใƒผใƒซใƒผใƒซใ‚ปใƒƒใƒˆใฎๅ…ฌ้–‹ใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚’้€ไฟกใ™ใ‚‹", + "description": "ใƒใƒชใ‚ทใƒผ ใƒซใƒผใƒซ ใ‚ปใƒƒใƒˆใฎๅ…ฌ้–‹่ฆๆฑ‚ใ‚’้€ไฟกใ—ใ€ๅฟœ็ญ”ใ‚’่ฟ”ใ—ใพใ™ใ€‚
**ๆณจ:** ใ“ใ‚Œใ‚‰ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฏ็พๅœจใƒ™ใƒผใ‚ฟ็‰ˆใงใ‚ใ‚Šใ€ๅค‰ๆ›ดใ•ใ‚Œใ‚‹ๅฏ่ƒฝๆ€งใŒใ‚ใ‚Šใพใ™ใ€‚Fireblocks TAP ใซๅ‚ๅŠ ใ—ใฆ่ฉณ็ดฐใ‚’็Ÿฅใ‚ŠใŸใ„ๅ ดๅˆใฏใ€Fireblocks ใ‚ซใ‚นใ‚ฟใƒžใƒผ ใ‚ตใ‚ฏใ‚ปใ‚น ใƒžใƒใƒผใ‚ธใƒฃใƒผใซ้€ฃ็ตกใ™ใ‚‹ใ‹ใ€CSM@fireblocks.com ใซใƒกใƒผใƒซใ‚’้€ไฟกใ—ใฆใใ ใ•ใ„ใ€‚.", + "tags": [ + "Policy Editor (Beta)" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "policy = fireblocks.publish_rules()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const policy = await fireblocks.publishRules();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "rules": { + "description": "ๅ…ฌ้–‹ใ™ใ‚‹ใƒใƒชใ‚ทใƒผใƒซใƒผใƒซ", + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicyRule" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "ใƒใƒชใ‚ทใƒผๅ…ฌ้–‹็ตๆžœใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PublishResult" + } + } + } + }, + "default": { + "description": "ใ‚จใƒฉใƒผๅฟœ็ญ”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ใƒชใ‚ฏใ‚จใ‚นใƒˆใซ้–ข้€ฃไป˜ใ‘ใ‚‰ใ‚ŒใŸไธ€ๆ„ใฎ IDใ€‚ไฝœๆˆใ™ใ‚‹ใ‚ตใƒใƒผใƒˆ ใƒใ‚ฑใƒƒใƒˆใพใŸใฏ Fireblocks SDK ใซ้–ข้€ฃใ™ใ‚‹ Github ใฎๅ•้กŒใซใ“ใฎ ID ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "MediaEntityResponse": { + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "ใ‚ญใƒฃใƒƒใ‚ทใƒฅใ•ใ‚ŒใŸใ‚ขใ‚ฏใ‚ปใ‚นๅฏ่ƒฝใช URL" + }, + "contentType": { + "oneOf": [ + { + "const": "IMAGE" + }, + { + "const": "VIDEO" + }, + { + "const": "ANIMATION" + }, + { + "const": "THREE_D" + }, + { + "const": "TEXT" + }, + { + "const": "GIF" + }, + { + "const": "UNKNOWN_TYPE" + }, + { + "const": "SVG" + }, + { + "const": "AUDIO" + } + ], + "description": "ใƒกใƒ‡ใ‚ฃใ‚ขใ‚ฟใ‚คใƒ—" + } + }, + "required": [ + "url", + "contentType" + ] + }, + "TokenCollectionResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "symbol": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "symbol" + ] + }, + "TokenResponse": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Fireblocks NFTใ‚ขใ‚ปใƒƒใƒˆID" + }, + "tokenId": { + "type": "string", + "description": "ๅฅ‘็ด„/ใ‚ณใƒฌใ‚ฏใ‚ทใƒงใƒณๅ†…ใฎใƒˆใƒผใ‚ฏใƒณID" + }, + "standard": { + "type": "string", + "description": "ERC721 / ERC1155" + }, + "metadataURI": { + "type": "string", + "description": "ๅ…ƒใฎใƒˆใƒผใ‚ฏใƒณใฎJSONใƒกใ‚ฟใƒ‡ใƒผใ‚ฟใฎURL" + }, + "cachedMetadataURI": { + "type": "string", + "description": "ใ‚ญใƒฃใƒƒใ‚ทใƒฅใ•ใ‚ŒใŸใƒˆใƒผใ‚ฏใƒณใฎJSONใƒกใ‚ฟใƒ‡ใƒผใ‚ฟใฎURL" + }, + "media": { + "description": "ใƒกใ‚ฟใƒ‡ใƒผใ‚ฟJSONใ‹ใ‚‰ๆŠฝๅ‡บใ•ใ‚ŒใŸใƒกใƒ‡ใ‚ฃใ‚ขใ‚ขใ‚คใƒ†ใƒ ", + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaEntityResponse" + } + }, + "collection": { + "description": "่ฆชใ‚ณใƒฌใ‚ฏใ‚ทใƒงใƒณๆƒ…ๅ ฑ", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "symbol": { + "type": "string" + } + } + }, + "blockchainDescriptor": { + "oneOf": [ + { + "const": "ETH" + }, + { + "const": "ETH_TEST3" + }, + { + "const": "POLYGON" + }, + { + "const": "POLYGON_TEST_MUMBAI" + } + ] + }, + "description": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "tokenId", + "standard", + "media", + "blockchainDescriptor", + "description", + "name" + ] + }, + "UpdateTokenOwnershipStatusDto": { + "type": "object", + "properties": { + "status": { + "oneOf": [ + { + "const": "LISTED" + }, + { + "const": "ARCHIVED" + } + ] + } + }, + "required": [ + "status" + ] + }, + "Paging": { + "type": "object", + "properties": { + "next": { + "type": "string", + "description": "ๆฌกใฎใƒšใƒผใ‚ธใซใ‚ซใƒผใ‚ฝใƒซใ‚’็งปๅ‹•" + } + }, + "required": [ + "next" + ] + }, + "TokenOwnershipResponse": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Fireblocks NFTใ‚ขใ‚ปใƒƒใƒˆID" + }, + "tokenId": { + "type": "string", + "description": "ๅฅ‘็ด„/ใ‚ณใƒฌใ‚ฏใ‚ทใƒงใƒณๅ†…ใฎใƒˆใƒผใ‚ฏใƒณID" + }, + "standard": { + "type": "string", + "description": "ERC721 / ERC1155" + }, + "metadataURI": { + "type": "string", + "description": "ๅ…ƒใฎใƒˆใƒผใ‚ฏใƒณใฎJSONใƒกใ‚ฟใƒ‡ใƒผใ‚ฟใฎURL" + }, + "cachedMetadataURI": { + "type": "string", + "description": "ใ‚ญใƒฃใƒƒใ‚ทใƒฅใ•ใ‚ŒใŸใƒˆใƒผใ‚ฏใƒณใฎJSONใƒกใ‚ฟใƒ‡ใƒผใ‚ฟใฎURL" + }, + "media": { + "description": "ใƒกใ‚ฟใƒ‡ใƒผใ‚ฟJSONใ‹ใ‚‰ๆŠฝๅ‡บใ•ใ‚ŒใŸใƒกใƒ‡ใ‚ฃใ‚ขใ‚ขใ‚คใƒ†ใƒ ", + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaEntityResponse" + } + }, + "collection": { + "description": "่ฆชใ‚ณใƒฌใ‚ฏใ‚ทใƒงใƒณๆƒ…ๅ ฑ", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "symbol": { + "type": "string" + } + } + }, + "balance": { + "type": "string" + }, + "vaultAccountId": { + "type": "string" + }, + "ownershipStartTime": { + "type": "number" + }, + "ownershipLastUpdateTime": { + "type": "number" + }, + "blockchainDescriptor": { + "oneOf": [ + { + "const": "ETH" + }, + { + "const": "ETH_TEST3" + }, + { + "const": "POLYGON" + }, + { + "const": "POLYGON_TEST_MUMBAI" + } + ] + }, + "description": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "tokenId", + "standard", + "media", + "balance", + "vaultAccountId", + "ownershipStartTime", + "ownershipLastUpdateTime", + "blockchainDescriptor", + "description", + "name" + ] + }, + "CollectionOwnershipResponse": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Fireblocks ใ‚ณใƒฌใ‚ฏใ‚ทใƒงใƒณ ID" + }, + "name": { + "type": "string", + "description": "ใ‚ณใƒฌใ‚ฏใ‚ทใƒงใƒณๅ" + }, + "symbol": { + "type": "string", + "description": "ใ‚ณใƒฌใ‚ฏใ‚ทใƒงใƒณใ‚ทใƒณใƒœใƒซ" + }, + "standard": { + "type": "string", + "description": "ๅ›žๅŽๅฅ‘็ด„ๅŸบๆบ–" + }, + "blockchainDescriptor": { + "oneOf": [ + { + "const": "ETH" + }, + { + "const": "ETH_TEST3" + }, + { + "const": "POLYGON" + }, + { + "const": "POLYGON_TEST_MUMBAI" + } + ], + "description": "ใ‚ณใƒฌใ‚ฏใ‚ทใƒงใƒณใฎใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณ" + }, + "contractAddress": { + "type": "string", + "description": "ๅ›žๅŽๅฅ‘็ด„ๅŸบๆบ–" + } + }, + "required": [ + "id", + "name", + "symbol", + "blockchainDescriptor" + ] + }, + "WalletAsset": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "balance": { + "type": "string" + }, + "lockedAmount": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/ConfigChangeRequestStatus" + }, + "address": { + "type": "string" + }, + "tag": { + "type": "string" + }, + "activationTime": { + "type": "string" + } + } + }, + "ExternalWalletAsset": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/ConfigChangeRequestStatus" + }, + "address": { + "type": "string" + }, + "tag": { + "type": "string" + }, + "activationTime": { + "type": "string" + }, + "additionalInfo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WalletAssetAdditionalInfo" + } + } + } + }, + "WalletAssetAdditionalInfo": { + "type": "object", + "properties": { + "accountHolderGivenName": { + "type": "string" + }, + "accountHolderSurname": { + "type": "string" + }, + "accountHolderCity": { + "type": "string" + }, + "accountHolderCountry": { + "type": "string" + }, + "accountHolderAddress1": { + "type": "string" + }, + "accountHolderAddress2": { + "type": "string" + }, + "accountHolderDistrict": { + "type": "string" + }, + "accountHolderPostalCode": { + "type": "string" + }, + "abaRoutingNumber": { + "type": "string" + }, + "abaAccountNumber": { + "type": "string" + }, + "abaCountry": { + "type": "string" + }, + "iban": { + "type": "string" + }, + "ibanCity": { + "type": "string" + }, + "ibanCountry": { + "type": "string" + }, + "speiClabe": { + "type": "string" + }, + "speiName": { + "type": "string" + } + } + }, + "ExchangeAsset": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "balance": { + "type": "string" + }, + "lockedAmount": { + "type": "string" + }, + "total": { + "type": "string" + }, + "available": { + "type": "string" + } + } + }, + "ExchangeTradingAccount": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "name": { + "type": "string" + }, + "assets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExchangeAsset" + } + } + } + }, + "FiatAsset": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "balance": { + "type": "string" + } + } + }, + "CreateVaultAssetResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "address": { + "type": "string" + }, + "legacyAddress": { + "type": "string" + }, + "enterpriseAddress": { + "type": "string" + }, + "tag": { + "type": "string" + }, + "eosAccountName": { + "type": "string" + }, + "status": { + "type": "string" + }, + "activationTxId": { + "type": "string" + } + } + }, + "RewardsInfo": { + "type": "object", + "properties": { + "pendingRewards": { + "description": "ๅ ฑ้…ฌไฟ็•™ไธญใฎ้‡‘้ก", + "type": "string" + } + } + }, + "VaultAsset": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "total": { + "description": "ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎๅˆ่จˆๆฎ‹้ซ˜ใ€‚EOSใงใฏใ€ใ“ใฎๅ€คใซใฏใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆฎ‹้ซ˜ใ€่‡ชๅทฑใ‚นใƒ†ใƒผใ‚ญใƒณใ‚ฐใ€ไฟ็•™ไธญใฎๆ‰•ใ„ๆˆปใ—ใŒๅซใพใ‚Œใพใ™ใ€‚ไป–ใฎใ™ในใฆใฎใ‚ณใ‚คใƒณใงใฏใ€ใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใซ่กจ็คบใ•ใ‚Œใ‚‹ๆฎ‹้ซ˜ใงใ™ใ€‚.", + "type": "string" + }, + "balance": { + "deprecated": true, + "description": "้žๆŽจๅฅจ - ใ€Œtotalใ€ใซ็ฝฎใๆ›ใˆใ‚‰ใ‚Œใพใ—ใŸ", + "type": "string" + }, + "available": { + "description": "้€้‡‘ๅฏ่ƒฝใช่ณ‡้‡‘ใ€‚ใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใฎๆฎ‹้ซ˜ใ‹ใ‚‰ใƒญใƒƒใ‚ฏใ•ใ‚ŒใŸ้‡‘้กใ‚’ๅทฎใ—ๅผ•ใ„ใŸ้‡‘้กใซ็ญ‰ใ—ใ„", + "type": "string" + }, + "pending": { + "description": "ๆฑบๆธˆๅพ…ใกใฎใ™ในใฆใฎๅ–ๅผ•ใฎ็ดฏ็ฉๆฎ‹้ซ˜", + "type": "string" + }, + "frozen": { + "description": "็ดฏ็ฉๅ‡็ตๆฎ‹้ซ˜", + "type": "string" + }, + "lockedAmount": { + "description": "ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏใซใพใ ๅ…ฌ้–‹ใ•ใ‚Œใฆใ„ใชใ„้€้‡‘ๅ–ๅผ•ใฎ่ณ‡้‡‘", + "type": "string" + }, + "staked": { + "description": "่ณญใ‘ใ‚‰ใ‚ŒใŸใƒใƒฉใƒณใ‚น", + "type": "string" + }, + "totalStakedCPU": { + "type": "number", + "description": "้žๆŽจๅฅจ" + }, + "totalStakedNetwork": { + "type": "string", + "description": "้žๆŽจๅฅจ" + }, + "selfStakedCPU": { + "type": "string", + "description": "้žๆŽจๅฅจ" + }, + "selfStakedNetwork": { + "type": "string", + "description": "้žๆŽจๅฅจ" + }, + "pendingRefundCPU": { + "type": "string", + "description": "้žๆŽจๅฅจ" + }, + "pendingRefundNetwork": { + "type": "string", + "description": "้žๆŽจๅฅจ" + }, + "blockHeight": { + "type": "string" + }, + "blockHash": { + "type": "string" + }, + "rewardsInfo": { + "$ref": "#/components/schemas/RewardsInfo" + } + } + }, + "VaultWalletAddress": { + "type": "object", + "properties": { + "assetId": { + "type": "string", + "x-fb-entity": "asset" + }, + "address": { + "type": "string" + }, + "description": { + "type": "string" + }, + "tag": { + "type": "string" + }, + "type": { + "type": "string" + }, + "customerRefId": { + "type": "string" + }, + "addressFormat": { + "oneOf": [ + { + "const": "SEGWIT" + }, + { + "const": "LEGACY" + } + ] + }, + "legacyAddress": { + "type": "string" + }, + "enterpriseAddress": { + "type": "string" + }, + "bip44AddressIndex": { + "type": "integer" + }, + "userDefined": { + "type": "boolean" + } + } + }, + "CreateAddressResponse": { + "type": "object", + "properties": { + "address": { + "type": "string" + }, + "legacyAddress": { + "type": "string" + }, + "enterpriseAddress": { + "type": "string" + }, + "tag": { + "type": "string" + }, + "bip44AddressIndex": { + "type": "integer" + } + } + }, + "VaultAccountsPagedResponse": { + "type": "object", + "properties": { + "accounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VaultAccount" + } + }, + "paging": { + "type": "object", + "properties": { + "before": { + "type": "string" + }, + "after": { + "type": "string" + } + } + }, + "previousUrl": { + "type": "string" + }, + "nextUrl": { + "type": "string" + } + } + }, + "PaginatedAssetWalletResponse": { + "type": "object", + "properties": { + "assetWallets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AssetWallet" + } + }, + "paging": { + "type": "object", + "properties": { + "before": { + "description": "ใ‚ซใƒผใ‚ฝใƒซใ‚’่กจใ™ๆ–‡ๅญ—ๅˆ—ใ€‚ใƒฆใƒผใ‚ถใƒผใฏใ€ใ“ใฎAPIใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใธใฎๆ–ฐใ—ใ„ใƒชใ‚ฏใ‚จใ‚นใƒˆใงใ“ใ‚Œใ‚’ใ€Œๅ‰ใ€ใƒชใ‚ฏใ‚จใ‚นใƒˆใƒ‘ใƒฉใƒกใƒผใ‚ฟใจใ—ใฆไฝฟ็”จใ—ใ€ๅ‰ใฎใƒšใƒผใ‚ธใฎ็ตๆžœใ‚’ๅ–ๅพ—ใงใใพใ™ใ€‚.", + "type": "string" + }, + "after": { + "description": "ใ‚ซใƒผใ‚ฝใƒซใ‚’่กจใ™ๆ–‡ๅญ—ๅˆ—ใ€‚ใƒฆใƒผใ‚ถใƒผใฏใ€ใ“ใฎAPIใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใธใฎๆ–ฐใ—ใ„ใƒชใ‚ฏใ‚จใ‚นใƒˆใงใ“ใ‚Œใ‚’ใ€Œๅ‰ใ€ใƒชใ‚ฏใ‚จใ‚นใƒˆใƒ‘ใƒฉใƒกใƒผใ‚ฟใจใ—ใฆไฝฟ็”จใ—ใ€ๆฌกใฎ็ตๆžœใƒšใƒผใ‚ธใ‚’ๅ–ๅพ—ใงใใพใ™ใ€‚.", + "type": "string" + } + } + } + } + }, + "AssetWallet": { + "type": "object", + "properties": { + "vaultId": { + "description": "ใƒœใƒผใƒซใƒˆ ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎ IDใ€‚[ใ“ใฎ ID ใงใƒœใƒผใƒซใƒˆ ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’ๅ–ๅพ—](https://developers.fireblocks.com/reference/get_vault-accounts-vaultaccountid) ใ—ใฆใ€ๅๅ‰ใ€่‡ชๅ‹•็ตฆๆฒนใ€UI ใง้ž่กจ็คบใ€้กงๅฎขๅ‚็…ง ID ใชใฉใฎใƒœใƒผใƒซใƒˆ ใƒ—ใƒญใƒ‘ใƒ†ใ‚ฃใ‚’ๅ–ๅพ—ใงใใพใ™ใ€‚.", + "type": "string" + }, + "assetId": { + "description": "ใ‚ขใ‚ปใƒƒใƒˆใฎ IDใ€‚[ใ‚ตใƒใƒผใƒˆใ•ใ‚Œใฆใ„ใ‚‹ใ‚ขใ‚ปใƒƒใƒˆ API](https://developers.fireblocks.com/reference/get_supported-assets) ใ‚’ไฝฟ็”จใ™ใ‚‹ใจใ€ใ“ใฎใ‚ขใ‚ปใƒƒใƒˆใซ้–ขใ™ใ‚‹่ฉณ็ดฐๆƒ…ๅ ฑใ‚’ๅ–ๅพ—ใงใใพใ™ใ€‚", + "type": "string" + }, + "available": { + "description": "ๅ–ๅผ•ใซไฝฟ็”จใงใใ‚‹ๅˆฉ็”จๅฏ่ƒฝๆฎ‹้ซ˜.", + "type": "string" + }, + "total": { + "description": "ใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใ‚จใ‚ฏใ‚นใƒ—ใƒญใƒผใƒฉใƒผใซ่กจ็คบใ•ใ‚Œใ‚‹่ณ‡็”ฃใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎๅˆ่จˆๆฎ‹้ซ˜ใ€‚ใ“ใ‚Œใซใฏใ€ๅˆฉ็”จๅฏ่ƒฝใชๆฎ‹้ซ˜ใจใ€ใƒญใƒƒใ‚ฏใ€ๅ‡็ตใ€ใใฎไป–ใฎๅˆฉ็”จใงใใชใ„ๆฎ‹้ซ˜ใŒๅซใพใ‚Œใพใ™ใ€‚.", + "type": "string" + }, + "pending": { + "description": "ไฟ็•™ไธญใฎๆฎ‹้ซ˜.", + "type": "string" + }, + "staked": { + "description": "่ณญใ‘ใ‚‰ใ‚ŒใŸใƒใƒฉใƒณใ‚น.", + "type": "string" + }, + "frozen": { + "description": "ใ“ใฎใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚นใฎใƒžใƒใƒผใƒญใƒณใƒ€ใƒชใƒณใ‚ฐ้˜ฒๆญขใƒใƒชใ‚ทใƒผใซใ‚ˆใ‚Š่ณ‡้‡‘ใŒๅ‡็ตใ•ใ‚Œใพใ—ใŸ.", + "type": "string" + }, + "lockedAmount": { + "description": "ใƒญใƒƒใ‚ฏใ•ใ‚ŒใŸๆฎ‹้ซ˜.", + "type": "string" + }, + "blockHeight": { + "description": "ใƒใƒฉใƒณใ‚นใฎใƒ–ใƒญใƒƒใ‚ฏใฎ้ซ˜ใ•๏ผˆๆ•ฐ๏ผ‰ใ€‚็ฉบใซใ™ใ‚‹ใ“ใจใŒใงใใพใ™.", + "type": "string" + }, + "blockHash": { + "description": "ๆฎ‹้ซ˜ใฎใƒ–ใƒญใƒƒใ‚ฏใฎใƒใƒƒใ‚ทใƒฅใ€‚็ฉบใงใ‚‚ๅฏ.", + "type": "string" + }, + "creationTimestamp": { + "description": "่ณ‡็”ฃใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใŒไฝœๆˆใ•ใ‚ŒใŸๆ™‚ๅˆปใฎ Unix ใ‚ฟใ‚คใƒ ใ‚นใ‚ฟใƒณใƒ—.", + "type": "string" + } + } + }, + "VaultAccount": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "assets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VaultAsset" + } + }, + "hiddenOnUI": { + "type": "boolean" + }, + "customerRefId": { + "type": "string" + }, + "autoFuel": { + "type": "boolean" + } + } + }, + "UnmanagedWallet": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "customerRefId": { + "type": "string" + }, + "assets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WalletAsset" + } + } + }, + "required": [ + "id", + "name", + "status" + ] + }, + "ExchangeAccount": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/ExchangeType" + }, + "name": { + "type": "string", + "description": "ๅ–ๅผ•ๆ‰€ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎ่กจ็คบๅ" + }, + "status": { + "type": "string" + }, + "assets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExchangeAsset" + } + }, + "tradingAccounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExchangeTradingAccount" + } + }, + "isSubaccount": { + "description": "ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใŒๅ–ๅผ•ๆ‰€ใฎใ‚ตใƒ–ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใงใ‚ใ‚‹ๅ ดๅˆใฏ True", + "type": "boolean" + }, + "mainAccountId": { + "description": "ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใŒใ‚ตใƒ–ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎๅ ดๅˆใ€ใƒกใ‚คใƒณใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎID", + "type": "string" + } + } + }, + "FiatAccount": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/FiatAccountType" + }, + "name": { + "type": "string", + "description": "ๆณ•ๅฎš้€š่ฒจใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎ่กจ็คบๅ" + }, + "address": { + "type": "string" + }, + "assets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FiatAsset" + } + } + } + }, + "OneTimeAddress": { + "type": "object", + "properties": { + "address": { + "type": "string" + }, + "tag": { + "type": "string" + } + }, + "required": [ + "address" + ] + }, + "TransferPeerPath": { + "type": "object", + "properties": { + "type": { + "oneOf": [ + { + "const": "VAULT_ACCOUNT" + }, + { + "const": "EXCHANGE_ACCOUNT" + }, + { + "const": "INTERNAL_WALLET" + }, + { + "const": "EXTERNAL_WALLET" + }, + { + "const": "NETWORK_CONNECTION" + }, + { + "const": "FIAT_ACCOUNT" + }, + { + "const": "COMPOUND" + }, + { + "const": "GAS_STATION" + }, + { + "const": "ONE_TIME_ADDRESS" + }, + { + "const": "UNKNOWN" + }, + { + "const": "END_USER_WALLET" + } + ] + }, + "subType": { + "oneOf": [ + { + "const": "BINANCE" + }, + { + "const": "BINANCEUS" + }, + { + "const": "BITFINEX" + }, + { + "const": "BITHUMB" + }, + { + "const": "BITMEX" + }, + { + "const": "BITSO" + }, + { + "const": "BITSTAMP" + }, + { + "const": "BITTREX" + }, + { + "const": "BLINC" + }, + { + "const": "BYBIT" + }, + { + "const": "CIRCLE" + }, + { + "const": "COINBASEEXCHANGE" + }, + { + "const": "COINBASEPRO" + }, + { + "const": "COINMETRO" + }, + { + "const": "COINSPRO" + }, + { + "const": "CRYPTOCOM" + }, + { + "const": "DERIBIT" + }, + { + "const": "GEMINI" + }, + { + "const": "HITBTC" + }, + { + "const": "HUOBI" + }, + { + "const": "INDEPENDENTRESERVE" + }, + { + "const": "KORBIT" + }, + { + "const": "KRAKEN" + }, + { + "const": "KRAKENINTL" + }, + { + "const": "KUCOIN" + }, + { + "const": "LIQUID" + }, + { + "const": "OKCOIN" + }, + { + "const": "OKEX" + }, + { + "const": "PAXOS" + }, + { + "const": "POLONIEX" + }, + { + "const": "External" + }, + { + "const": "Internal" + } + ] + }, + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "walletId": { + "type": "string", + "format": "uuid" + } + }, + "required": [ + "type" + ] + }, + "DestinationTransferPeerPath": {}, + "CreateTransactionResponse": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ๅ–ๅผ•ใฎID." + }, + "status": { + "type": "string", + "description": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎไธปใชใ‚นใƒ†ใƒผใ‚ฟใ‚นใ€‚่ฉณ็ดฐใซใคใ„ใฆใฏใ€[ไธปใชใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณ ใ‚นใƒ†ใƒผใ‚ฟใ‚น] (https://developers.fireblocks.com/reference/primary-transaction-statuses) ใ‚’ๅ‚็…งใ—ใฆใใ ใ•ใ„ใ€‚" + }, + "systemMessages": { + "$ref": "#/components/schemas/SystemMessageInfo" + } + } + }, + "SystemMessageInfo": { + "type": "object", + "properties": { + "type": { + "oneOf": [ + { + "const": "WARN" + }, + { + "const": "BLOCK" + } + ] + }, + "message": { + "type": "string", + "description": "Fireblocks ใ‹ใ‚‰ใฎๅฟœ็ญ”ใงใ€ๅฎŸ่กŒไธญใฎใƒ—ใƒญใ‚ปใ‚นใฎๅฅๅ…จๆ€งใซ้–ขใ™ใ‚‹ใƒกใƒƒใ‚ปใƒผใ‚ธใ‚’ไผใˆใพใ™ใ€‚ใ“ใฎใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆใŒใƒ‡ใƒผใ‚ฟใจใจใ‚‚ใซ่ฟ”ใ•ใ‚ŒใŸๅ ดๅˆใ€้…ๅปถใ‚„ไธๅฎŒๅ…จใชใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณ ใ‚นใƒ†ใƒผใ‚ฟใ‚นใŒ็™บ็”Ÿใ™ใ‚‹ๅฏ่ƒฝๆ€งใŒใ‚ใ‚Šใพใ™ใ€‚.", + "example": "Slow transaction processing. Outgoing transactions might be stuck." + } + } + }, + "CancelTransactionResponse": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + } + } + }, + "UnfreezeTransactionResponse": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + } + } + }, + "FreezeTransactionResponse": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + } + } + }, + "AmlScreeningResult": { + "type": "object", + "description": "AMLๆคœๆŸปใฎ็ตๆžœ.", + "properties": { + "provider": { + "type": "string" + }, + "payload": { + "type": "object" + } + } + }, + "FeeInfo": { + "type": "object", + "description": "ๅ–ๅผ•ๆ‰‹ๆ•ฐๆ–™ใฎ่ฉณ็ดฐ.", + "properties": { + "networkFee": { + "description": "ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏใซๆ”ฏๆ‰•ใ‚ใ‚Œใ‚‹ๆ‰‹ๆ•ฐๆ–™", + "type": "string" + }, + "serviceFee": { + "description": "ๅ–ๅผ•ๆ‰€ใŒๅฎŸ้š›ใซ่ซ‹ๆฑ‚ใ—ใŸ้‡‘้กใ‹ใ‚‰ๅทฎใ—ๅผ•ใ„ใŸๅˆ่จˆๆ‰‹ๆ•ฐๆ–™๏ผˆใ‚ตใƒผใƒ“ใ‚นๆ‰‹ๆ•ฐๆ–™ = ้‡‘้ก - ็ด”้ก๏ผ‰", + "type": "string" + }, + "gasPrice": { + "type": "string" + } + } + }, + "BlockInfo": { + "type": "object", + "description": "ใ“ใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใŒใƒžใ‚คใƒ‹ใƒณใ‚ฐใ•ใ‚ŒใŸใƒ–ใƒญใƒƒใ‚ฏใฎใƒ–ใƒญใƒƒใ‚ฏใƒใƒƒใ‚ทใƒฅใจ้ซ˜ใ•ใ€‚**ๆณจ**: ้€ไฟกใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใŒ้…ๅˆ—ใซ่ค‡ๆ•ฐใฎๅ€คใ‚’ๆŒใค destinations ใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆใ‚’ไฝฟ็”จใ™ใ‚‹ๅ ดๅˆใ€blockHash ใฏ null ใซ่จญๅฎšใ•ใ‚Œใพใ™ใ€‚.", + "properties": { + "blockHeight": { + "type": "string" + }, + "blockHash": { + "type": "string" + } + } + }, + "AuthorizationInfo": { + "type": "object", + "description": "[ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณๆ‰ฟ่ชใƒใƒชใ‚ทใƒผ (TAP)](https://developers.fireblocks.com/docs/capabilities#transaction-authorization-policy-tap) ใซ้–ขใ™ใ‚‹ๆƒ…ๅ ฑ", + "properties": { + "allowOperatorAsAuthorizer": { + "type": "boolean" + }, + "logic": { + "oneOf": [ + { + "const": "AND" + }, + { + "const": "OR" + } + ] + }, + "groups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AuthorizationGroups" + } + } + } + }, + "AuthorizationGroups": { + "type": "object", + "properties": { + "th": { + "type": "number" + }, + "users": { + "type": "object", + "additionalProperties": { + "oneOf": [ + { + "const": "PENDING_AUTHORIZATION" + }, + { + "const": "APPROVED" + }, + { + "const": "REJECTED" + }, + { + "const": "NA" + } + ] + } + } + } + }, + "AmountInfo": { + "type": "object", + "description": "้€้‡‘ๅธŒๆœ›้‡‘้กใฎ่ฉณ็ดฐ.", + "properties": { + "amount": { + "description": "้€้‡‘ใŒๅ–ๅผ•ๆ‰€ใ‹ใ‚‰ใฎๅผ•ใๅ‡บใ—ใงใ‚ใ‚‹ๅ ดๅˆใ€ๅฎŸ้š›ใซ้€้‡‘ใ‚’ไพ้ ผใ•ใ‚ŒใŸ้‡‘้กใ€‚ใใ‚Œไปฅๅค–ใฎๅ ดๅˆใฏใ€ไพ้ ผใ•ใ‚ŒใŸ้‡‘้ก.", + "type": "string" + }, + "requestedAmount": { + "description": "ใƒฆใƒผใ‚ถใƒผใŒ่ฆๆฑ‚ใ—ใŸ้‡‘้ก.", + "type": "string" + }, + "netAmount": { + "description": "ๆ‰‹ๆ•ฐๆ–™ใ‚’ๅทฎใ—ๅผ•ใ„ใŸๅ–ๅผ•ใฎ็ด”้ก.", + "type": "string" + }, + "amountUSD": { + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸ้‡‘้กใฎ็ฑณใƒ‰ใƒซไพกๅ€ค.", + "type": "string" + } + } + }, + "RewardInfo": { + "type": "object", + "description": "ใ“ใฎใƒ•ใ‚ฃใƒผใƒซใƒ‰ใฏใ€Algorand ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใซใฎใฟ้–ข้€ฃใ—ใพใ™ใ€‚`srcRewards` ใจ `destRewards` ใฏไธกๆ–นใจใ‚‚ Vault ้–“ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใซใฎใฟ่กจ็คบใ•ใ‚Œใพใ™ใ€‚ใใ‚Œไปฅๅค–ใฎๅ ดๅˆใฏใ€ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎ Fireblocks ๅดใฎใฟใ‚’ๅ—ใ‘ๅ–ใ‚Šใพใ™ใ€‚.", + "properties": { + "srcRewards": { + "type": "string" + }, + "destRewards": { + "type": "string" + } + } + }, + "SourceTransferPeerPathResponse": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "subType": { + "type": "string", + "description": "ใ‚ฟใ‚คใƒ—ใŒ `EXCHANGE_ACCOUNT` ใพใŸใฏ `FIAT_ACCOUNT` ใซ่จญๅฎšใ•ใ‚Œใฆใ„ใ‚‹ๅ ดๅˆใ€็‰นๅฎšใฎๅ–ๅผ•ๆ‰€ใƒ™ใƒณใƒ€ใƒผๅใพใŸใฏๆณ•ๅฎš้€š่ฒจใƒ™ใƒณใƒ€ใƒผๅใ€‚ใ‚ฟใ‚คใƒ—ใŒ `INTERNAL_WALLET` ใพใŸใฏ `EXTERNAL_WALLET` ใซ่จญๅฎšใ•ใ‚Œใฆใ„ใ‚‹ๅ ดๅˆใ€ใ‚ตใƒ–ใ‚ฟใ‚คใƒ—ใฏ `Internal` ใพใŸใฏ `External` ใซ่จญๅฎšใ•ใ‚Œใพใ™ใ€‚." + }, + "id": { + "type": "string", + "description": "ใƒ”ใ‚ขใฎ IDใ€‚ๅ„ไผšๅ ดใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆใฎ ID ใฏใ€[Vault ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎไธ€่ฆง่กจ็คบ](https://developers.fireblocks.com/reference/get_vault-accounts-paged)ใ€[Exchange ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎไธ€่ฆง่กจ็คบ](https://developers.fireblocks.com/reference/get_exchange-accounts)ใ€[ๆณ•ๅฎš้€š่ฒจใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎไธ€่ฆง่กจ็คบ](https://developers.fireblocks.com/reference/get_fiat-accounts)ใ€[ๅ†…้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎไธ€่ฆง่กจ็คบ](https://developers.fireblocks.com/reference/get_internal-wallets)ใ€[ๅค–้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎไธ€่ฆง่กจ็คบ](https://developers.fireblocks.com/reference/get_external-wallets)ใ€[ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถšใฎไธ€่ฆง่กจ็คบ](https://developers.fireblocks.com/reference/get_network-connections) ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใ‚’ไฝฟ็”จใ—ใฆๅ–ๅพ—ใงใใพใ™ใ€‚ใใฎไป–ใฎใ‚ฟใ‚คใƒ—ใงใฏใ€ใ“ใฎใƒ‘ใƒฉใƒกใƒผใ‚ฟใฏๅฟ…่ฆใ‚ใ‚Šใพใ›ใ‚“ใ€‚." + }, + "name": { + "type": "string", + "description": "ใƒ”ใ‚ขใฎๅๅ‰." + }, + "walletId": { + "type": "string", + "format": "uuid" + } + } + }, + "DestinationTransferPeerPathResponse": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "subType": { + "type": "string", + "description": "ใ‚ฟใ‚คใƒ—ใŒ `EXCHANGE_ACCOUNT` ใพใŸใฏ `FIAT_ACCOUNT` ใซ่จญๅฎšใ•ใ‚Œใฆใ„ใ‚‹ๅ ดๅˆใ€็‰นๅฎšใฎๅ–ๅผ•ๆ‰€ใƒ™ใƒณใƒ€ใƒผๅใพใŸใฏๆณ•ๅฎš้€š่ฒจใƒ™ใƒณใƒ€ใƒผๅใ€‚ใ‚ฟใ‚คใƒ—ใŒ `INTERNAL_WALLET` ใพใŸใฏ `EXTERNAL_WALLET` ใซ่จญๅฎšใ•ใ‚Œใฆใ„ใ‚‹ๅ ดๅˆใ€ใ‚ตใƒ–ใ‚ฟใ‚คใƒ—ใฏ `Internal` ใพใŸใฏ `External` ใซ่จญๅฎšใ•ใ‚Œใพใ™ใ€‚." + }, + "id": { + "type": "string", + "description": "ใƒ”ใ‚ขใฎ IDใ€‚ๅ„ไผšๅ ดใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆใฎ ID ใฏใ€[Vault ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎไธ€่ฆง่กจ็คบ](https://developers.fireblocks.com/reference/get_vault-accounts-paged)ใ€[Exchange ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎไธ€่ฆง่กจ็คบ](https://developers.fireblocks.com/reference/get_exchange-accounts)ใ€[ๆณ•ๅฎš้€š่ฒจใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎไธ€่ฆง่กจ็คบ](https://developers.fireblocks.com/reference/get_fiat-accounts)ใ€[ๅ†…้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎไธ€่ฆง่กจ็คบ](https://developers.fireblocks.com/reference/get_internal-wallets)ใ€[ๅค–้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎไธ€่ฆง่กจ็คบ](https://developers.fireblocks.com/reference/get_external-wallets)ใ€[ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๆŽฅ็ถšใฎไธ€่ฆง่กจ็คบ](https://developers.fireblocks.com/reference/get_network-connections) ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใ‚’ไฝฟ็”จใ—ใฆๅ–ๅพ—ใงใใพใ™ใ€‚ใใฎไป–ใฎใ‚ฟใ‚คใƒ—ใงใฏใ€ใ“ใฎใƒ‘ใƒฉใƒกใƒผใ‚ฟใฏๅฟ…่ฆใ‚ใ‚Šใพใ›ใ‚“ใ€‚." + }, + "name": { + "type": "string", + "description": "ใƒ”ใ‚ขใฎๅๅ‰." + }, + "walletId": { + "type": "string", + "format": "uuid" + } + } + }, + "TransactionResponse": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ๅ–ๅผ•ใฎID." + }, + "externalTxId": { + "type": "string", + "description": "ใƒฆใƒผใ‚ถใƒผใŒๆŒ‡ๅฎšใ—ใŸไธ€ๆ„ใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณ IDใ€‚Fireblocks ใงใฏใ€ๅŒใ˜ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚’ 2 ๅ›ž้€ไฟกใ™ใ‚‹ใ“ใจใ‚’้ฟใ‘ใ‚‹ใŸใ‚ใซใ€ไฝœๆˆใ•ใ‚Œใ‚‹ใ™ในใฆใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใซ `externalTxId` ใ‚’่จญๅฎšใ™ใ‚‹ใ“ใจใ‚’ๅผทใใŠๅ‹งใ‚ใ—ใพใ™ใ€‚." + }, + "status": { + "type": "string", + "description": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎไธปใชใ‚นใƒ†ใƒผใ‚ฟใ‚นใ€‚่ฉณ็ดฐใซใคใ„ใฆใฏใ€[ไธปใชใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณ ใ‚นใƒ†ใƒผใ‚ฟใ‚น](https://developers.fireblocks.com/reference/primary-transaction-statuses) ใ‚’ๅ‚็…งใ—ใฆใใ ใ•ใ„ใ€‚." + }, + "subStatus": { + "type": "string", + "description": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚ตใƒ–ใ‚นใƒ†ใƒผใ‚ฟใ‚นใฎใƒชใ‚นใƒˆใซใคใ„ใฆใฏใ€[ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚ตใƒ–ใ‚นใƒ†ใƒผใ‚ฟใ‚น](https://developers.fireblocks.com/reference/transaction-substatuses)ใ‚’ๅ‚็…งใ—ใฆใใ ใ•ใ„ใ€‚." + }, + "txHash": { + "type": "string", + "description": "ใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณไธŠใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎใƒใƒƒใ‚ทใƒฅใ€‚ * ใ“ใฎใƒ‘ใƒฉใƒกใƒผใ‚ฟใฏใ€ๆฌกใฎๆกไปถใฎๅฐ‘ใชใใจใ‚‚ 1 ใคใŒๆบ€ใŸใ•ใ‚Œใฆใ„ใ‚‹ๅ ดๅˆใซๅญ˜ๅœจใ—ใพใ™ใ€‚1. ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎใ‚ฝใƒผใ‚น ใ‚ฟใ‚คใƒ—ใŒ `UNKNOWN`ใ€`WHITELISTED_ADDRESS`ใ€`NETWORK_CONNECTION`ใ€`ONE_TIME_ADDRESS`ใ€`FIAT_ACCOUNT`ใ€ใพใŸใฏ `GAS_STATION` ใงใ‚ใ‚‹ใ€‚2. ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎใ‚ฝใƒผใ‚น ใ‚ฟใ‚คใƒ—ใŒ `VAULT` ใงใ‚ใ‚Šใ€ใ‚นใƒ†ใƒผใ‚ฟใ‚นใŒ `CONFIRMING`ใ€`COMPLETED`ใ€ใพใŸใฏ `FAILED` ใพใŸใฏ `REJECTED` ใซๅค‰ๆ›ดใ•ใ‚Œใ‚‹ๅ‰ใซใ“ใ‚Œใ‚‰ใฎใ‚นใƒ†ใƒผใ‚ฟใ‚นใฎใ„ใšใ‚Œใ‹ใงใ‚ใฃใŸใ€‚ๅ ดๅˆใซใ‚ˆใฃใฆใฏใ€ใ‚นใƒ†ใƒผใ‚ฟใ‚นใŒ `BROADCASTING` ใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใซใ‚‚ txHash ใŒๅซใพใ‚Œใพใ™ใ€‚ 3. ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎใ‚ฝใƒผใ‚นใ‚ฟใ‚คใƒ—ใŒ `EXCHANGE_ACCOUNT` ใงใ‚ใ‚Šใ€ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎๅฎ›ๅ…ˆใ‚ฟใ‚คใƒ—ใŒ `VAULT` ใงใ‚ใ‚Šใ€ใ‚นใƒ†ใƒผใ‚ฟใ‚นใŒ `CONFIRMING`ใ€`COMPLETED`ใ€ใพใŸใฏ `FAILED` ใซๅค‰ๆ›ดใ•ใ‚Œใ‚‹ๅ‰ใซใ“ใ‚Œใ‚‰ใฎใ‚นใƒ†ใƒผใ‚ฟใ‚นใฎใ„ใšใ‚Œใ‹ใงใ‚ใฃใŸใ“ใจใ€‚ * ใ•ใ‚‰ใซใ€ๆฌกใฎๆกไปถใ‚’ๆบ€ใŸใ™ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚ 1. ่ณ‡็”ฃใฏๆš—ๅท่ณ‡็”ฃ๏ผˆๆณ•ๅฎš้€š่ฒจใงใฏใชใ„๏ผ‰ใ€‚ 2. ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณๆ“ไฝœใŒ RAW ใพใŸใฏ `TYPED_MESSAGE` ใงใฏใชใ„ใ€‚." + }, + "operation": { + "$ref": "#/components/schemas/GetTransactionOperation" + }, + "note": { + "type": "string", + "description": "Fireblocks ใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚นใงใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚’่ชฌๆ˜Žใ™ใ‚‹ใ€ใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใซ้€ไฟกใ•ใ‚Œใชใ„ใ‚ซใ‚นใ‚ฟใƒ  ใƒŽใƒผใƒˆ." + }, + "assetId": { + "type": "string", + "description": "`TRANSFER`ใ€`MINT`ใ€`BURN`ใ€`ENABLE_ASSET`ใ€`STAKE`ใ€`UNSTAKE`ใ€ใพใŸใฏ `WITHDRAW` ๆ“ไฝœใง่ปข้€ใ™ใ‚‹ใ‚ขใ‚ปใƒƒใƒˆใฎ IDใ€‚[Fireblocks ใงใ‚ตใƒใƒผใƒˆใ•ใ‚Œใฆใ„ใ‚‹ใ‚ขใ‚ปใƒƒใƒˆใจใใฎ ID ใฎใƒชใ‚นใƒˆใ‚’ๅ‚็…งใ—ใฆใใ ใ•ใ„ใ€‚](https://developers.fireblocks.com/reference/get_supported-assets)", + "x-fb-entity": "asset" + }, + "source": { + "$ref": "#/components/schemas/SourceTransferPeerPathResponse" + }, + "sourceAddress": { + "type": "string", + "description": "ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใƒ™ใƒผใ‚นใฎ่ณ‡็”ฃใฎใฟใ€ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎ้€ไฟกๅ…ƒใ‚ขใƒ‰ใƒฌใ‚นใ€‚**ๆณจ:** ใ‚นใƒ†ใƒผใ‚ฟใ‚นใŒใ€Œ็ขบ่ชไธญใ€ใ€ใ€ŒๅฎŒไบ†ใ€ใ€ใพใŸใฏใ€Œ็ขบ่ชไธญใ€ใ‹ใ‚‰ใ€Œๅคฑๆ•—ใ€ใพใŸใฏใ€Œๆ‹’ๅฆใ€ใซ็งป่กŒใ—ใŸๅ ดๅˆใ€ใ“ใฎใƒ‘ใƒฉใƒกใƒผใ‚ฟใซใฏ้€ไฟกๅ…ƒใ‚ขใƒ‰ใƒฌใ‚นใŒๅซใพใ‚Œใพใ™ใ€‚ใใ‚Œไปฅๅค–ใฎๅ ดๅˆใ€ใ“ใฎใƒ‘ใƒฉใƒกใƒผใ‚ฟใฏ็ฉบใซใชใ‚Šใพใ™ใ€‚." + }, + "tag": { + "type": "string", + "description": "XRP ใฎใ‚ฝใƒผใ‚น ใ‚ขใƒ‰ใƒฌใ‚น ใ‚ฟใ‚ฐใ€‚EOS/XLM ใฎใƒกใƒขใจใ—ใฆใ€ใพใŸใฏๆณ•ๅฎš้€š่ฒจใƒ—ใƒญใƒใ‚คใƒ€ใƒผ BLINC (BCB ใ‚ฐใƒซใƒผใƒ—ๆไพ›) ใฎ้Š€่กŒๆŒฏ่พผใฎ่ชฌๆ˜Žใจใ—ใฆไฝฟ็”จใ•ใ‚Œใพใ™ใ€‚." + }, + "destination": { + "$ref": "#/components/schemas/DestinationTransferPeerPathResponse" + }, + "destinations": { + "type": "array", + "description": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎ้€ไฟกๅ…ˆใ€‚**ๆณจ:** ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใŒๅ˜ไธ€ใฎ้€ไฟกๅ…ˆใซ้€ไฟกใ•ใ‚Œใ‚‹ๅ ดๅˆใฏใ€ใ“ใฎใƒ‘ใƒฉใƒกใƒผใ‚ฟใฎไปฃใ‚ใ‚Šใซ`destination`ใƒ‘ใƒฉใƒกใƒผใ‚ฟใŒไฝฟ็”จใ•ใ‚Œใพใ™ใ€‚.", + "items": { + "$ref": "#/components/schemas/TransactionResponseDestination" + } + }, + "destinationAddress": { + "type": "string", + "description": "่ณ‡็”ฃใŒ่ปข้€ใ•ใ‚ŒใŸใ‚ขใƒ‰ใƒฌใ‚นใ€‚ๆณจ: - [่ค‡ๆ•ฐใฎๅฎ›ๅ…ˆใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณ](https://support.fireblocks.io/hc/en-us/articles/360018447980-Multi-destination-transactions)ใฎๅ ดๅˆใ€ใ“ใฎใƒ‘ใƒฉใƒกใƒผใ‚ฟใฏ็ฉบใซใชใ‚Šใพใ™ใ€‚ใ“ใฎๅ ดๅˆใ€ๅฎ›ๅ…ˆใƒ•ใ‚ฃใƒผใƒซใƒ‰ใ‚’ๅ‚็…งใ™ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚ - ใ‚นใƒ†ใƒผใ‚ฟใ‚นใŒ `CONFIRMING`ใ€`COMPLETED`ใ€ใพใŸใฏ `CONFIRMING` ใงใ‚ใฃใŸๅพŒใซ `FAILED` ใพใŸใฏ `REJECTED` ใซ็งป่กŒใ—ใŸๅ ดๅˆใ€ใ“ใฎใƒ‘ใƒฉใƒกใƒผใ‚ฟใซใฏๅฎ›ๅ…ˆใ‚ขใƒ‰ใƒฌใ‚นใŒๅซใพใ‚Œใพใ™ใ€‚ใใ‚Œไปฅๅค–ใฎๅ ดๅˆใ€ใ“ใฎใƒ‘ใƒฉใƒกใƒผใ‚ฟใฏ็ฉบใซใชใ‚Šใพใ™ใ€‚." + }, + "destinationAddressDescription": { + "type": "string", + "description": "ไฝๆ‰€ใฎ่ชฌๆ˜Ž." + }, + "destinationTag": { + "type": "string", + "description": "XRP ใฎๅฎ›ๅ…ˆใ‚ขใƒ‰ใƒฌใ‚น ใ‚ฟใ‚ฐใ€‚EOS/XLM ใฎใƒกใƒขใจใ—ใฆใ€ใพใŸใฏๆณ•ๅฎš้€š่ฒจใƒ—ใƒญใƒใ‚คใƒ€ใƒผ BLINC (BCB ใ‚ฐใƒซใƒผใƒ—ๆไพ›) ใฎ้Š€่กŒๆŒฏ่พผใฎ่ชฌๆ˜Žใจใ—ใฆไฝฟ็”จใ•ใ‚Œใพใ™ใ€‚." + }, + "contractCallDecodedData": { + "description": "`CONTRACT_CALL` ๆ“ไฝœใฎใƒ‡ใ‚ณใƒผใƒ‰ใ•ใ‚ŒใŸใƒ‡ใƒผใ‚ฟใ€‚ใ“ใฎใƒ‘ใƒฉใƒกใƒผใ‚ฟใฎๅ€คใ‚’่จญๅฎšใ™ใ‚‹ใซใฏใ€Fireblocks [้–‹็™บใƒฉใ‚คใƒ–ใƒฉใƒช](https://developers.fireblocks.com/docs/ethereum-development#convenience-libraries) ใŒๆŽจๅฅจใ•ใ‚Œใพใ™ใ€‚.", + "type": "object", + "properties": { + "contractName": { + "type": "string" + }, + "functionCalls": { + "type": "array", + "items": { + "type": "object" + } + } + } + }, + "amountInfo": { + "$ref": "#/components/schemas/AmountInfo" + }, + "treatAsGrossAmount": { + "type": "boolean", + "description": "ใ“ใฎ Fireblocks ใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚นใ‚’ไป‹ใ—ใฆ้–‹ๅง‹ใ•ใ‚ŒใŸใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎๅ ดๅˆใ€`true` ใซ่จญๅฎšใ™ใ‚‹ใจใ€ๆ‰‹ๆ•ฐๆ–™ใฏ่ฆๆฑ‚ใ•ใ‚ŒใŸ้‡‘้กใ‹ใ‚‰ๅทฎใ—ๅผ•ใ‹ใ‚Œใพใ™ใ€‚**ๆณจ**: ใ“ใฎใƒ‘ใƒฉใƒกใƒผใ‚ฟใฏใ€ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎ่ณ‡็”ฃใŒ ETH ใ‚„ MATIC ใชใฉใฎๅŸบๆœฌ่ณ‡็”ฃใงใ‚ใ‚‹ๅ ดๅˆใซใฎใฟ่€ƒๆ…ฎใ•ใ‚Œใพใ™ใ€‚USDC ใฎใ‚ˆใ†ใซ่ณ‡็”ฃใŒใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณๆ‰‹ๆ•ฐๆ–™ใซไฝฟ็”จใงใใชใ„ๅ ดๅˆใ€ใ“ใฎใƒ‘ใƒฉใƒกใƒผใ‚ฟใฏ็„ก่ฆ–ใ•ใ‚Œใ€ๆ‰‹ๆ•ฐๆ–™ใฏใ‚ฝใƒผใ‚น ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎ้–ข้€ฃใ™ใ‚‹ๅŸบๆœฌ่ณ‡็”ฃใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‹ใ‚‰ๅทฎใ—ๅผ•ใ‹ใ‚Œใพใ™ใ€‚." + }, + "feeInfo": { + "$ref": "#/components/schemas/FeeInfo" + }, + "feeCurrency": { + "type": "string", + "description": "ๅ–ๅผ•ๆ‰‹ๆ•ฐๆ–™ใ‚’ๆ”ฏๆ‰•ใ†ใŸใ‚ใซๅผ•ใๅ‡บใ•ใ‚ŒใŸ่ณ‡็”ฃใ€‚ไพ‹ใˆใฐใ€EVMใƒ™ใƒผใ‚นใฎใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใฎๅ ดๅˆใฏETHใ€Tether Omniใฎๅ ดๅˆใฏBTC." + }, + "networkRecords": { + "type": "array", + "description": "ๅ˜ไธ€ใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใŒ่ค‡ๆ•ฐใฎ่ปข้€ใ‚’ไผดใ†ๅ ดๅˆ๏ผˆใŸใจใˆใฐใ€ๅฅ‘็ด„ๅ‘ผใณๅ‡บใ—ใฎ็ตๆžœ๏ผ‰ใ€ใ“ใฎใƒ‘ใƒฉใƒกใƒผใ‚ฟใฏใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณไธŠใง่กŒใ‚ใ‚ŒใŸๅ„่ปข้€ใ‚’ๆŒ‡ๅฎšใ—ใพใ™ใ€‚ๅ˜ไธ€ใฎ่ปข้€ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎๅ ดๅˆใ€ใ“ใฎใƒ‘ใƒฉใƒกใƒผใ‚ฟใฏ็ฉบใงใ™ใ€‚.", + "items": { + "$ref": "#/components/schemas/NetworkRecord" + } + }, + "createdAt": { + "type": "number", + "description": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎไฝœๆˆๆ—ฅๆ™‚๏ผˆUNIXใ‚ฟใ‚คใƒ ใ‚นใ‚ฟใƒณใƒ—๏ผ‰." + }, + "lastUpdated": { + "type": "number", + "description": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎๆœ€็ต‚ๆ›ดๆ–ฐๆ—ฅๆ™‚๏ผˆUNIXใ‚ฟใ‚คใƒ ใ‚นใ‚ฟใƒณใƒ—๏ผ‰." + }, + "createdBy": { + "type": "string", + "description": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎ้–‹ๅง‹่€…ใฎใƒฆใƒผใ‚ถใƒผID." + }, + "signedBy": { + "type": "array", + "description": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎ็ฝฒๅ่€…ใฎใƒฆใƒผใ‚ถใƒผID.", + "items": { + "type": "string" + } + }, + "rejectedBy": { + "type": "string", + "description": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚’ๆ‹’ๅฆใ—ใŸใƒฆใƒผใ‚ถใƒผใฎใƒฆใƒผใ‚ถใƒผ ID (ๆ‹’ๅฆใ•ใ‚ŒใŸๅ ดๅˆ)." + }, + "authorizationInfo": { + "$ref": "#/components/schemas/AuthorizationInfo" + }, + "exchangeTxId": { + "type": "string", + "description": "ๅ–ๅผ•ใŒๅ–ๅผ•ๆ‰€ใ‹ใ‚‰็™บไฟกใ•ใ‚ŒใŸๅ ดๅˆใ€ใ“ใ‚Œใฏๅ–ๅผ•ๆ‰€ใซใŠใ‘ใ‚‹ใ“ใฎๅ–ๅผ•ใฎIDใงใ™ใ€‚." + }, + "customerRefId": { + "type": "string", + "description": "AMLใƒ—ใƒญใƒใ‚คใƒ€ใƒผใŒ่ณ‡้‡‘ใฎๆ‰€ๆœ‰่€…ใจๅ–ๅผ•ใ‚’้–ข้€ฃไป˜ใ‘ใ‚‹ใŸใ‚ใฎID." + }, + "amlScreeningResult": { + "$ref": "#/components/schemas/AmlScreeningResult" + }, + "extraParameters": { + "$ref": "#/components/schemas/ExtraParameters" + }, + "signedMessages": { + "$ref": "#/components/schemas/SignedMessage" + }, + "numOfConfirmations": { + "type": "number", + "description": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎ็ขบ่ชๆ•ฐใ€‚็ขบ่ชใƒใƒชใ‚ทใƒผใซๅพ“ใฃใฆใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใŒๅฎŒไบ†ใ—ใŸใจใฟใชใ•ใ‚Œใ‚‹ใพใงใ€ใ“ใฎๆ•ฐใŒๅข—ๅŠ ใ—ใพใ™ใ€‚." + }, + "blockInfo": { + "$ref": "#/components/schemas/BlockInfo" + }, + "index": { + "type": "number", + "description": "UTXOใƒ™ใƒผใ‚นใฎ่ณ‡็”ฃใฎๅ ดๅˆใ€ใ“ใ‚ŒใฏvOutใงใ™ใ€‚Ethereumใƒ™ใƒผใ‚นใฎๅ ดๅˆใ€ใ“ใ‚Œใฏๅฅ‘็ด„ๅ‘ผใณๅ‡บใ—ใฎใ‚คใƒ™ใƒณใƒˆใฎใ‚คใƒณใƒ‡ใƒƒใ‚ฏใ‚นใงใ™ใ€‚**ๆณจ:** ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใŒ่ค‡ๆ•ฐใฎๅ€คใ‚’ๆŒใค`destinations`ใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆใ‚’ไฝฟ็”จใ™ใ‚‹ๅ ดๅˆใ€ใ“ใฎใƒ•ใ‚ฃใƒผใƒซใƒ‰ใฏ่ฟ”ใ•ใ‚Œใพใ›ใ‚“ใ€‚." + }, + "rewardInfo": { + "$ref": "#/components/schemas/RewardInfo" + }, + "systemMessages": { + "$ref": "#/components/schemas/SystemMessageInfo" + }, + "addressType": { + "oneOf": [ + { + "const": "WHITELISTED" + }, + { + "const": "ONE_TIME" + } + ] + }, + "requestedAmount": { + "description": "ใƒฆใƒผใ‚ถใƒผใŒ่ฆๆฑ‚ใ—ใŸ้‡‘้กใ€‚้žๆŽจๅฅจ - ๆญฃ็ขบใ•ใ‚’ไฟใคใซใฏ `amountInfo` ใƒ•ใ‚ฃใƒผใƒซใƒ‰ใ‚’ไฝฟ็”จใ—ใฆใใ ใ•ใ„.", + "type": "number", + "deprecated": true + }, + "amount": { + "description": "้€้‡‘ใŒๅ–ๅผ•ๆ‰€ใ‹ใ‚‰ใฎๅ‡บ้‡‘ใงใ‚ใ‚‹ๅ ดๅˆใ€ๅฎŸ้š›ใซ้€้‡‘ใ‚’่ฆๆฑ‚ใ•ใ‚ŒใŸ้‡‘้กใ€‚ใใ‚Œไปฅๅค–ใฎๅ ดๅˆใฏใ€่ฆๆฑ‚ใ•ใ‚ŒใŸ้‡‘้กใ€‚้žๆŽจๅฅจ - ๆญฃ็ขบใ•ใฎใŸใ‚ใซ `amountInfo` ใƒ•ใ‚ฃใƒผใƒซใƒ‰ใ‚’ไฝฟ็”จใ—ใฆใใ ใ•ใ„ใ€‚.", + "type": "number", + "deprecated": true + }, + "netAmount": { + "description": "ๆ‰‹ๆ•ฐๆ–™ใ‚’ๅทฎใ—ๅผ•ใ„ใŸๅพŒใฎๅ–ๅผ•ใฎ็ด”้กใ€‚้žๆŽจๅฅจ - ๆญฃ็ขบใ•ใ‚’ไฟใคใซใฏ `amountInfo` ใƒ•ใ‚ฃใƒผใƒซใƒ‰ใ‚’ไฝฟ็”จใ—ใฆใใ ใ•ใ„.", + "type": "number", + "deprecated": true + }, + "amountUSD": { + "oneOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸ้‡‘้กใฎ USD ๅ€คใ€‚้žๆŽจๅฅจ - ๆญฃ็ขบใ•ใ‚’ไฟใคใซใฏ `amountInfo` ใƒ•ใ‚ฃใƒผใƒซใƒ‰ใ‚’ไฝฟ็”จใ—ใฆใใ ใ•ใ„." + }, + "serviceFee": { + "description": "ๅฎŸ้š›ใฎ่ซ‹ๆฑ‚้กใ‹ใ‚‰ๅ–ๅผ•ๆ‰€ใซใ‚ˆใฃใฆๅทฎใ—ๅผ•ใ‹ใ‚Œใ‚‹ๅˆ่จˆๆ‰‹ๆ•ฐๆ–™ (`serviceFee` = `amount` - `netAmount`)ใ€‚้žๆŽจๅฅจ - ๆญฃ็ขบๆ€งใ‚’ไฟใคใซใฏ `feeInfo` ใƒ•ใ‚ฃใƒผใƒซใƒ‰ใ‚’ไฝฟ็”จใ—ใฆใใ ใ•ใ„ใ€‚.", + "type": "number", + "deprecated": true + }, + "fee": { + "description": "้žๆŽจๅฅจ - ๆญฃ็ขบใ•ใ‚’ไฟใคใŸใ‚ใซใ€ŒfeeInfoใ€ใƒ•ใ‚ฃใƒผใƒซใƒ‰ใ‚’ไฝฟ็”จใ—ใฆใใ ใ•ใ„.", + "type": "number", + "deprecated": true + }, + "networkFee": { + "description": "ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏใซๆ”ฏๆ‰•ใ‚ใ‚Œใ‚‹ๆ‰‹ๆ•ฐๆ–™ใ€‚้žๆŽจๅฅจ - ๆญฃ็ขบใ•ใ‚’ไฟใคใซใฏ `feeInfo` ใƒ•ใ‚ฃใƒผใƒซใƒ‰ใ‚’ไฝฟ็”จใ—ใฆใใ ใ•ใ„.", + "type": "number", + "deprecated": true + } + } + }, + "TransactionResponseDestination": { + "type": "object", + "properties": { + "destination": { + "$ref": "#/components/schemas/DestinationTransferPeerPathResponse" + }, + "destinationAddress": { + "description": "่ณ‡็”ฃใŒ็งป่ปขใ•ใ‚ŒใŸไฝๆ‰€." + }, + "destinationAddressDescription": { + "description": "ไฝๆ‰€ใฎ่ชฌๆ˜Ž." + }, + "amount": { + "type": "string", + "description": "ใ“ใฎๅฎ›ๅ…ˆใซ้€้‡‘ใ™ใ‚‹้‡‘้ก." + }, + "amountUSD": { + "type": "string", + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸ้‡‘้กใฎ็ฑณใƒ‰ใƒซไพกๅ€ค." + }, + "amlScreeningResult": { + "$ref": "#/components/schemas/AmlScreeningResult" + }, + "customerRefId": { + "description": "AMLใƒ—ใƒญใƒใ‚คใƒ€ใƒผใŒ่ณ‡้‡‘ใฎๆ‰€ๆœ‰่€…ใจๅ–ๅผ•ใ‚’้–ข้€ฃไป˜ใ‘ใ‚‹ใŸใ‚ใฎID." + }, + "authorizationInfo": { + "$ref": "#/components/schemas/AuthorizationInfo" + } + } + }, + "NetworkRecord": { + "type": "object", + "properties": { + "source": { + "$ref": "#/components/schemas/SourceTransferPeerPathResponse" + }, + "destination": { + "$ref": "#/components/schemas/DestinationTransferPeerPathResponse" + }, + "txHash": { + "type": "string" + }, + "networkFee": { + "type": "string" + }, + "assetId": { + "type": "string", + "x-fb-entity": "asset" + }, + "netAmount": { + "description": "ๆ‰‹ๆ•ฐๆ–™ใ‚’ๅทฎใ—ๅผ•ใ„ใŸๅ–ๅผ•ใฎ็ด”้ก", + "type": "string" + }, + "isDropped": { + "type": "boolean" + }, + "type": { + "type": "string" + }, + "destinationAddress": { + "type": "string" + }, + "sourceAddress": { + "type": "string" + }, + "amountUSD": { + "type": "string" + }, + "index": { + "type": "number" + }, + "rewardInfo": { + "$ref": "#/components/schemas/RewardInfo" + } + } + }, + "AssetTypeResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "type": { + "oneOf": [ + { + "const": "ALGO_ASSET" + }, + { + "const": "BASE_ASSET" + }, + { + "const": "BEP20" + }, + { + "const": "COMPOUND" + }, + { + "const": "ERC20" + }, + { + "const": "FIAT" + }, + { + "const": "SOL_ASSET" + }, + { + "const": "TRON_TRC20" + }, + { + "const": "XLM_ASSET" + }, + { + "const": "XDB_ASSET" + } + ] + }, + "contractAddress": { + "type": "string" + }, + "nativeAsset": { + "type": "string" + }, + "decimals": { + "type": "number" + } + }, + "required": [ + "id", + "name", + "type" + ] + }, + "NetworkConnection": { + "type": "object", + "properties": { + "localNetworkId": { + "type": "string", + "description": "ๆŽฅ็ถšใ‚’ไฝœๆˆใ—ใ‚ˆใ†ใจใ—ใฆใ„ใ‚‹ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซใฎใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ID." + }, + "remoteNetworkId": { + "type": "string", + "description": "ใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซใŒๆŽฅ็ถšใ—ใ‚ˆใ†ใจใ—ใฆใ„ใ‚‹ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏ ID." + }, + "routingPolicy": { + "$ref": "#/components/schemas/NetworkConnectionRoutingPolicy" + } + }, + "required": [ + "localNetworkId", + "remoteNetworkId" + ] + }, + "NetworkConnectionResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "localChannel": { + "deprecated": true, + "description": "้žๆŽจๅฅจ - `localNetworkId` ใซ็ฝฎใๆ›ใˆใ‚‰ใ‚Œใพใ—ใŸ", + "type": "object", + "properties": { + "networkId": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "remoteChannel": { + "deprecated": true, + "description": "้žๆŽจๅฅจ - `remoteNetworkId` ใซ็ฝฎใๆ›ใˆใ‚‰ใ‚Œใพใ—ใŸ", + "type": "object", + "properties": { + "networkId": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "status": { + "$ref": "#/components/schemas/ConfigChangeRequestStatus" + }, + "localNetworkId": { + "$ref": "#/components/schemas/NetworkId" + }, + "remoteNetworkId": { + "$ref": "#/components/schemas/NetworkId" + }, + "routingPolicy": { + "$ref": "#/components/schemas/NetworkConnectionRoutingPolicy" + } + }, + "required": [ + "id", + "localNetworkId", + "remoteNetworkId", + "routingPolicy", + "status" + ] + }, + "EstimatedTransactionFeeResponse": { + "type": "object", + "properties": { + "low": { + "$ref": "#/components/schemas/TransactionFee" + }, + "medium": { + "$ref": "#/components/schemas/TransactionFee" + }, + "high": { + "$ref": "#/components/schemas/TransactionFee" + } + }, + "required": [ + "low", + "medium", + "high" + ] + }, + "EstimatedNetworkFeeResponse": { + "type": "object", + "properties": { + "low": { + "$ref": "#/components/schemas/NetworkFee" + }, + "medium": { + "$ref": "#/components/schemas/NetworkFee" + }, + "high": { + "$ref": "#/components/schemas/NetworkFee" + } + }, + "required": [ + "low", + "medium", + "high" + ] + }, + "GasStationPropertiesResponse": { + "type": "object", + "properties": { + "balance": { + "type": "object" + }, + "configuration": { + "$ref": "#/components/schemas/GasStationConfiguration" + } + }, + "required": [ + "low", + "medium", + "high" + ] + }, + "TransactionFee": { + "type": "object", + "properties": { + "feePerByte": { + "type": "string" + }, + "gasPrice": { + "type": "string" + }, + "gasLimit": { + "type": "string" + }, + "networkFee": { + "type": "string" + }, + "baseFee": { + "description": "(ใ‚ชใƒ—ใ‚ทใƒงใƒณ) EIP-1559 ใซๅŸบใฅใๅŸบๆœฌๆ–™้‡‘ (ETH ่ณ‡็”ฃ)", + "type": "string" + }, + "priorityFee": { + "description": "(ใ‚ชใƒ—ใ‚ทใƒงใƒณ) EIP-1559 ใซๅŸบใฅใๅ„ชๅ…ˆๆ‰‹ๆ•ฐๆ–™ (ETH ่ณ‡็”ฃ)", + "type": "string" + } + } + }, + "NetworkFee": { + "type": "object", + "properties": { + "feePerByte": { + "type": "string" + }, + "gasPrice": { + "type": "string" + }, + "networkFee": { + "type": "string" + }, + "baseFee": { + "description": "(ใ‚ชใƒ—ใ‚ทใƒงใƒณ) EIP-1559 ใซๅŸบใฅใๅŸบๆœฌๆ–™้‡‘ (ETH ่ณ‡็”ฃ)", + "type": "string" + }, + "priorityFee": { + "description": "(ใ‚ชใƒ—ใ‚ทใƒงใƒณ) EIP-1559 ใซๅŸบใฅใๅ„ชๅ…ˆๆ‰‹ๆ•ฐๆ–™ (ETH ่ณ‡็”ฃ)", + "type": "string" + } + } + }, + "GasStationConfiguration": { + "type": "object", + "properties": { + "gasThreshold": { + "type": "string" + }, + "gasCap": { + "type": "string" + }, + "maxGasPrice": { + "type": "string" + } + } + }, + "NetworkChannel": { + "deprecated": true, + "description": "ๅ”ฏไธ€ไฝฟ็”จใ•ใ‚Œใ‚‹ๅ‚็…ง - NetworkConnectionResponse ใงใฏ้žๆŽจๅฅจใงใ™", + "type": "object", + "properties": { + "networkId": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "NetworkId": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "name" + ] + }, + "NetworkIdResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "routingPolicy": { + "$ref": "#/components/schemas/NetworkIdRoutingPolicy" + }, + "isDiscoverable": { + "type": "boolean", + "description": "็‰นๅฎšใฎใƒใƒƒใƒˆใƒฏใƒผใ‚ฏใŒๆคœๅ‡บๅฏ่ƒฝ." + } + } + }, + "TransactionRequest": { + "type": "object", + "properties": { + "operation": { + "$ref": "#/components/schemas/TransactionOperation" + }, + "note": { + "type": "string", + "description": "Fireblocks ใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚นใงใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚’่ชฌๆ˜Žใ™ใ‚‹ใ€ใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใซ้€ไฟกใ•ใ‚Œใชใ„ใ‚ซใ‚นใ‚ฟใƒ  ใƒŽใƒผใƒˆ.", + "example": "Ticket 123" + }, + "externalTxId": { + "type": "string", + "description": "ใ‚ชใƒ—ใ‚ทใƒงใƒณใงใ™ใŒใ€ๅผทใๆŽจๅฅจใ•ใ‚Œใ‚‹ใƒ‘ใƒฉใƒกใƒผใ‚ฟใงใ™ใ€‚Fireblocks ใฏใ€ๅŒใ˜ ID ใ‚’ๆŒใคๅฐ†ๆฅใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚’ๆ‹’ๅฆใ—ใพใ™ใ€‚ๅŒใ˜ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚’ 2 ๅ›ž้€ไฟกใ—ใชใ„ใ‚ˆใ†ใซใ™ใ‚‹ใซใฏใ€ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚’่กจใ™ไธ€ๆ„ใฎ ID ใซ่จญๅฎšใ™ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚ใ“ใ‚Œใฏใ€ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎ้€ไฟกๆ™‚ใซใ‚คใƒณใ‚ฟใƒผใƒใƒƒใƒˆใฎไธญๆ–ญใซใ‚ˆใ‚Šใ‚จใƒฉใƒผ ใ‚ณใƒผใƒ‰ใŒ่ฟ”ใ•ใ‚Œใ‚‹ใŒใ€ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏๅฎŸ้š›ใซใฏ้€ไฟกใ•ใ‚Œใ€ๅ‡ฆ็†ใ•ใ‚Œใฆใ„ใ‚‹ๅ ดๅˆใซๅฝน็ซ‹ใกใพใ™ใ€‚ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใŒๅ‡ฆ็†ใ•ใ‚ŒใŸใ‹ใฉใ†ใ‹ใ‚’็ขบ่ชใ™ใ‚‹ใซใฏใ€[ๅค–้ƒจใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณ ID ใง็‰นๅฎšใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚’ๆคœ็ดข](https://developers.fireblocks.com/reference/get_transactions-external-tx-id-externaltxid) ใ‚’ๅฎŸ่กŒใ—ใพใ™ใ€‚ใ“ใฎใƒ‘ใƒฉใƒกใƒผใ‚ฟใซใฏ็‰นๅฎšใฎๅฝขๅผใฏๅฟ…่ฆใ‚ใ‚Šใพใ›ใ‚“ใ€‚.", + "example": "00000000-0000-0000-0000-000000000000" + }, + "assetId": { + "type": "string", + "description": "`TRANSFER`ใ€`MINT`ใ€ใพใŸใฏ `BURN` ๆ“ไฝœใง่ปข้€ใ™ใ‚‹ใ‚ขใ‚ปใƒƒใƒˆใฎ IDใ€‚[Fireblocks ใงใ‚ตใƒใƒผใƒˆใ•ใ‚Œใฆใ„ใ‚‹ใ‚ขใ‚ปใƒƒใƒˆใจใใฎ ID ใฎใƒชใ‚นใƒˆใ‚’ๅ‚็…งใ—ใฆใใ ใ•ใ„ใ€‚](https://developers.fireblocks.com/reference/get_supported-assets)", + "x-fb-entity": "asset", + "example": "ETH" + }, + "source": { + "$ref": "#/components/schemas/TransferPeerPath" + }, + "destination": { + "$ref": "#/components/schemas/DestinationTransferPeerPath" + }, + "destinations": { + "type": "array", + "description": "UTXOใƒ™ใƒผใ‚นใฎใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใงใฏใ€ๅ˜ไธ€ใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚’่ค‡ๆ•ฐใฎๅฎ›ๅ…ˆใซ้€ไฟกใงใใพใ™ใ€‚.", + "items": { + "$ref": "#/components/schemas/TransactionRequestDestination" + } + }, + "amount": { + "oneOf": [ + { + "type": "string", + "description": "ๆ•ฐๅ€คๆ–‡ๅญ—ๅˆ—๏ผˆๆŽจๅฅจ๏ผ‰", + "example": "0.02" + }, + { + "type": "number", + "description": "็•ชๅท๏ผˆ้žๆŽจๅฅจ๏ผ‰", + "example": 0.02 + } + ], + "description": "`TRANSFER` ๆ“ไฝœใฎๅ ดๅˆใ€่ณ‡็”ฃๅ˜ไฝใงใฎ่ปข้€่ฆๆฑ‚้‡‘้กใ€‚Fireblocks ใงใฏใ€็ฒพๅบฆใ‚’ไธŠใ’ใ‚‹ใŸใ‚ใซๆ•ฐๅ€คๆ–‡ๅญ—ๅˆ—ใฎไฝฟ็”จใ‚’ๆŽจๅฅจใ—ใฆใ„ใพใ™ใ€‚ๆ•ฐๅ€คๅ…ฅๅŠ›ใฏๅญ˜ๅœจใ—ใพใ™ใŒใ€้žๆŽจๅฅจใงใ™ใ€‚." + }, + "treatAsGrossAmount": { + "type": "boolean", + "description": "ใ€Œ`true` ใซ่จญๅฎšใ™ใ‚‹ใจใ€ๆ‰‹ๆ•ฐๆ–™ใฏ่ฆๆฑ‚ใ•ใ‚ŒใŸ้‡‘้กใ‹ใ‚‰ๅทฎใ—ๅผ•ใ‹ใ‚Œใพใ™ใ€‚ใ€**ๆณจ**: ใ“ใฎใƒ‘ใƒฉใƒกใƒผใ‚ฟใฏใ€ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎ่ณ‡็”ฃใŒ ETH ใ‚„ MATIC ใชใฉใฎๅŸบๆœฌ่ณ‡็”ฃใงใ‚ใ‚‹ๅ ดๅˆใซใฎใฟ่€ƒๆ…ฎใ•ใ‚Œใพใ™ใ€‚USDC ใฎใ‚ˆใ†ใซใ€่ณ‡็”ฃใŒใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณๆ‰‹ๆ•ฐๆ–™ใซไฝฟ็”จใงใใชใ„ๅ ดๅˆใ€ใ“ใฎใƒ‘ใƒฉใƒกใƒผใ‚ฟใฏ็„ก่ฆ–ใ•ใ‚Œใ€ๆ‰‹ๆ•ฐๆ–™ใฏใ‚ฝใƒผใ‚น ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎ้–ข้€ฃใ™ใ‚‹ๅŸบๆœฌ่ณ‡็”ฃใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‹ใ‚‰ๅทฎใ—ๅผ•ใ‹ใ‚Œใพใ™ใ€‚.", + "example": false + }, + "forceSweep": { + "type": "boolean", + "description": "Polkadotใ€Kusamaใ€Westend ใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎใฟใ€‚true ใซ่จญๅฎšใ™ใ‚‹ใจใ€Fireblocks ใฏใ‚ขใ‚ปใƒƒใƒˆ ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚’็ฉบใซใ—ใพใ™ใ€‚**ๆณจ:** ใ‚ฝใƒผใ‚น ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใŒใกใ‚‡ใ†ใฉ 1 DOT ใฎใจใใซ true ใซ่จญๅฎšใ™ใ‚‹ใจใ€ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏๅคฑๆ•—ใ—ใพใ™ใ€‚1 DOT ใ‚ˆใ‚Šๅคšใ„ใพใŸใฏๅฐ‘ใชใ„้‡‘้กใฏๆˆๅŠŸใ—ใพใ™ใ€‚ใ“ใ‚Œใฏ Polkadot ใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใฎๅˆถ้™ใงใ™ใ€‚.", + "example": false + }, + "feeLevel": { + "oneOf": [ + { + "const": "LOW" + }, + { + "const": "MEDIUM" + }, + { + "const": "HIGH" + } + ], + "description": "UTXOใพใŸใฏEVMใƒ™ใƒผใ‚นใฎใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใฎใฟใ€‚ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใซๅฏพใ—ใฆๆ”ฏๆ‰•ใ‚ใ‚Œใ‚‹ใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณๆ‰‹ๆ•ฐๆ–™ใƒฌใƒ™ใƒซใ‚’ๅฎš็พฉใ—ใพใ™ใ€‚ใพใŸใฏใ€็‰นๅฎšใฎๆ‰‹ๆ•ฐๆ–™ๆŽจๅฎšใƒ‘ใƒฉใƒกใƒผใ‚ฟใŒไปฅไธ‹ใซใ‚ใ‚Šใพใ™ใ€‚.", + "example": "MEDIUM" + }, + "fee": { + "oneOf": [ + { + "type": "string", + "description": "ๆ•ฐๅ€คๆ–‡ๅญ—ๅˆ—๏ผˆๆŽจๅฅจ๏ผ‰" + }, + { + "type": "number", + "description": "็•ชๅท๏ผˆ้žๆŽจๅฅจ๏ผ‰" + } + ], + "description": "UTXOใƒ™ใƒผใ‚นใฎใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใฎๅ ดๅˆใ€่ณ‡็”ฃใฎๆœ€ๅฐๅ˜ไฝ๏ผˆSatoshiใ€Latoshiใชใฉ๏ผ‰ใฎใƒใ‚คใƒˆใ‚ใŸใ‚Šใฎๆ‰‹ๆ•ฐๆ–™ใ€‚Rippleใฎๅ ดๅˆใ€ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎๆ‰‹ๆ•ฐๆ–™ใ€‚Fireblocksใงใฏใ€ๆญฃ็ขบใช็ฒพๅบฆใ‚’ๅพ—ใ‚‹ใŸใ‚ใซๆ•ฐๅ€คๆ–‡ๅญ—ๅˆ—ใฎไฝฟ็”จใ‚’ๆŽจๅฅจใ—ใฆใ„ใพใ™ใ€‚ๆ•ฐๅ€คๅ…ฅๅŠ›ใฏๅญ˜ๅœจใ—ใพใ™ใŒใ€้žๆŽจๅฅจใงใ™ใ€‚." + }, + "priorityFee": { + "oneOf": [ + { + "type": "string", + "description": "ๆ•ฐๅ€คๆ–‡ๅญ—ๅˆ—๏ผˆๆŽจๅฅจ๏ผ‰", + "example": "2" + }, + { + "type": "number", + "description": "็•ชๅท๏ผˆ้žๆŽจๅฅจ๏ผ‰", + "example": 2 + } + ], + "description": "Ethereumใƒ™ใƒผใ‚นใฎใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใฎใฟใ€EIP-1559ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณไพกๆ ผ่จญๅฎšใƒกใ‚ซใƒ‹ใ‚บใƒ ใฎๆ‰‹ๆ•ฐๆ–™ใ€‚ๅ€คใฏGweiๅ˜ไฝใงใ™ใ€‚Fireblocksใงใฏใ€ๆญฃ็ขบใช็ฒพๅบฆใ‚’ๅพ—ใ‚‹ใŸใ‚ใซๆ•ฐๅ€คๆ–‡ๅญ—ๅˆ—ใ‚’ไฝฟ็”จใ™ใ‚‹ใ“ใจใ‚’ใŠๅ‹งใ‚ใ—ใพใ™ใ€‚ๆ•ฐๅ€คๅ…ฅๅŠ›ใฏๅญ˜ๅœจใ—ใพใ™ใŒใ€้žๆŽจๅฅจใงใ™ใ€‚." + }, + "failOnLowFee": { + "type": "boolean", + "description": "`true`ใซ่จญๅฎšใ™ใ‚‹ใจใ€็พๅœจใฎ`MEDIUM`ๆ‰‹ๆ•ฐๆ–™ใƒฌใƒ™ใƒซใŒใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใงๆŒ‡ๅฎšใ•ใ‚ŒใŸใ‚‚ใฎใ‚ˆใ‚Šใ‚‚้ซ˜ใ„ๅ ดๅˆใ€ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏๅคฑๆ•—ใ—ใ€็ขบ่ชใชใ—ใงๅœๆญขใ™ใ‚‹ใฎใ‚’ๅ›ž้ฟใ—ใพใ™ใ€‚." + }, + "maxFee": { + "description": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใซๆ”ฏๆ‰•ใ‚ใ‚Œใ‚‹ในใๆœ€ๅคงๆ‰‹ๆ•ฐๆ–™๏ผˆใ‚ฌใ‚นๆ–™้‡‘ใพใŸใฏใƒใ‚คใƒˆใ‚ใŸใ‚Šใฎๆ‰‹ๆ•ฐๆ–™๏ผ‰ใ€‚่ฆๆฑ‚ใ•ใ‚ŒใŸ `feeLevel` ใฎ็พๅœจใฎๅ€คใŒใ€ใ“ใฎ่ฆๆฑ‚ใ•ใ‚ŒใŸๆœ€ๅคงๆ‰‹ๆ•ฐๆ–™ใ‚ˆใ‚Šใ‚‚้ซ˜ใ„ๅ ดๅˆใ€‚ๆญฃ็ขบใช็ฒพๅบฆใฎใŸใ‚ใซๆ•ฐๅ€คๆ–‡ๅญ—ๅˆ—ใง่กจใ•ใ‚Œใพใ™ใ€‚.", + "type": "string", + "example": "120" + }, + "gasLimit": { + "oneOf": [ + { + "type": "string", + "description": "ๆ•ฐๅ€คๆ–‡ๅญ—ๅˆ—๏ผˆๆŽจๅฅจ๏ผ‰", + "example": "21000" + }, + { + "type": "number", + "description": "็•ชๅท๏ผˆ้žๆŽจๅฅจ๏ผ‰", + "example": 21000 + } + ], + "description": "EVM ใƒ™ใƒผใ‚นใฎใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใฎใฟใ€‚ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎๅ‡ฆ็†ใซๅฟ…่ฆใชใ‚ฌใ‚นใฎๅ˜ไฝใ€‚ๆณจ: 1 ใคใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใงๆŒ‡ๅฎšใงใใ‚‹ใฎใฏใ€3 ใคใฎๅผ•ๆ•ฐใฎใ†ใก 2 ใคใ ใ‘ใงใ™: `gasLimit`ใ€`gasPrice`ใ€`networkFee`ใ€‚Fireblocks ใงใฏใ€็ฒพๅบฆใ‚’ไธŠใ’ใ‚‹ใŸใ‚ใซๆ•ฐๅ€คๆ–‡ๅญ—ๅˆ—ใฎไฝฟ็”จใ‚’ๆŽจๅฅจใ—ใฆใ„ใพใ™ใ€‚ๆ•ฐๅ€คๅ…ฅๅŠ›ใฏๅญ˜ๅœจใ—ใพใ™ใŒใ€้žๆŽจๅฅจใงใ™ใ€‚." + }, + "gasPrice": { + "oneOf": [ + { + "type": "string", + "description": "ๆ•ฐๅ€คๆ–‡ๅญ—ๅˆ—๏ผˆๆŽจๅฅจ๏ผ‰" + }, + { + "type": "number", + "description": "็•ชๅท๏ผˆ้žๆŽจๅฅจ๏ผ‰" + } + ], + "description": "EIP-1559 ไปฅๅค–ใฎ EVM ใƒ™ใƒผใ‚นใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎๅ ดๅˆใ€‚ใ‚ฌใ‚นๅ˜ไฝใ‚ใŸใ‚Šใฎไพกๆ ผ (Ethereum ใงใฏ Gwei ใงๆŒ‡ๅฎšใ•ใ‚Œใพใ™)ใ€‚ๆณจ: 1 ใคใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใงๆŒ‡ๅฎšใงใใ‚‹ใฎใฏใ€3 ใคใฎๅผ•ๆ•ฐใฎใ†ใก 2 ใคใ ใ‘ใงใ™: `gasLimit`ใ€`gasPrice`ใ€ใŠใ‚ˆใณ `networkFee`ใ€‚Fireblocks ใงใฏใ€็ฒพๅบฆใ‚’ไธŠใ’ใ‚‹ใŸใ‚ใซๆ•ฐๅ€คๆ–‡ๅญ—ๅˆ—ใ‚’ไฝฟ็”จใ™ใ‚‹ใ“ใจใ‚’ใŠๅ‹งใ‚ใ—ใพใ™ใ€‚ๆ•ฐๅ€คๅ…ฅๅŠ›ใฏๅญ˜ๅœจใ—ใพใ™ใŒใ€้žๆŽจๅฅจใงใ™ใ€‚." + }, + "networkFee": { + "oneOf": [ + { + "type": "string", + "description": "ๆ•ฐๅ€คๆ–‡ๅญ—ๅˆ—๏ผˆๆŽจๅฅจ๏ผ‰" + }, + { + "type": "number", + "description": "็•ชๅท๏ผˆ้žๆŽจๅฅจ๏ผ‰" + } + ], + "description": "EVM ใƒ™ใƒผใ‚นใฎใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใฎใฟใ€‚ใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใฎๆœ€ๅคงๅ˜ไฝใฎๅˆ่จˆใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณๆ‰‹ๆ•ฐๆ–™ใ€‚ๆณจ: 1 ใคใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใงๆŒ‡ๅฎšใงใใ‚‹ใฎใฏใ€3 ใคใฎๅผ•ๆ•ฐใฎใ†ใก 2 ใคใ ใ‘ใงใ™: `gasLimit`ใ€`gasPrice`ใ€ใŠใ‚ˆใณ `networkFee`ใ€‚Fireblocks ใงใฏใ€็ฒพๅบฆใ‚’ไธŠใ’ใ‚‹ใŸใ‚ใซๆ•ฐๅ€คๆ–‡ๅญ—ๅˆ—ใ‚’ไฝฟ็”จใ™ใ‚‹ใ“ใจใ‚’ใŠๅ‹งใ‚ใ—ใพใ™ใ€‚ๆ•ฐๅ€คๅ…ฅๅŠ›ใฏๅญ˜ๅœจใ—ใพใ™ใŒใ€้žๆŽจๅฅจใงใ™ใ€‚ - ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณ ใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณๆ‰‹ๆ•ฐๆ–™ใ€‚ - Ethereum ใฎๅ ดๅˆใ€gasPriceใ€gasLimitใ€ใŠใ‚ˆใณ networkFee ใ‚’ใ™ในใฆไธ€็ท’ใซๆธกใ™ใ“ใจใฏใงใใพใ›ใ‚“ใ€‚ - ๆ•ฐๅ€ค่กจ็พใŒๅฟ…่ฆใงใ™." + }, + "replaceTxByHash": { + "type": "string", + "description": "EVMใƒ™ใƒผใ‚นใฎใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใฎใฟใ€‚ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใŒใ‚นใ‚ฟใƒƒใ‚ฏใ—ใŸๅ ดๅˆใ€ใ‚นใ‚ฟใƒƒใ‚ฏใ—ใŸใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎใƒใƒƒใ‚ทใƒฅใ‚’ๆŒ‡ๅฎšใ—ใฆใ€ๆ‰‹ๆ•ฐๆ–™ใฎ้ซ˜ใ„ใ“ใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใซ็ฝฎใๆ›ใˆใ‚‹ใ‹ใ€ๆ‰‹ๆ•ฐๆ–™ใŒใ‚ผใƒญใฎใ“ใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใซ็ฝฎใๆ›ใˆใฆใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใ‹ใ‚‰ๅ‰Š้™คใ—ใพใ™ใ€‚.", + "example": "00000000-0000-0000-0000-000000000000" + }, + "extraParameters": { + "$ref": "#/components/schemas/ExtraParameters" + }, + "customerRefId": { + "type": "string", + "description": "AMLใƒ—ใƒญใƒใ‚คใƒ€ใƒผใŒ่ณ‡้‡‘ใฎๆ‰€ๆœ‰่€…ใจๅ–ๅผ•ใ‚’้–ข้€ฃไป˜ใ‘ใ‚‹ใŸใ‚ใฎID.", + "example": "abcdef" + }, + "autoStaking": { + "type": "boolean", + "description": "ใ“ใฎๆฉŸ่ƒฝใฏใ‚ตใƒใƒผใƒˆใ•ใ‚Œใชใใชใ‚Šใพใ—ใŸ.", + "deprecated": true + }, + "networkStaking": { + "oneOf": [ + { + "type": "string", + "description": "ๆ•ฐๅ€คๆ–‡ๅญ—ๅˆ—๏ผˆๆŽจๅฅจ๏ผ‰" + }, + { + "type": "number", + "description": "็•ชๅท๏ผˆ้žๆŽจๅฅจ๏ผ‰" + } + ], + "description": "ใ“ใฎๆฉŸ่ƒฝใฏใ‚ตใƒใƒผใƒˆใ•ใ‚Œใชใใชใ‚Šใพใ—ใŸ." + }, + "cpuStaking": { + "oneOf": [ + { + "type": "string", + "description": "ๆ•ฐๅ€คๆ–‡ๅญ—ๅˆ—๏ผˆๆŽจๅฅจ๏ผ‰" + }, + { + "type": "number", + "description": "็•ชๅท๏ผˆ้žๆŽจๅฅจ๏ผ‰" + } + ], + "description": "ใ“ใฎๆฉŸ่ƒฝใฏใ‚ตใƒใƒผใƒˆใ•ใ‚Œใชใใชใ‚Šใพใ—ใŸ." + } + } + }, + "TransactionRequestDestination": { + "type": "object", + "properties": { + "amount": { + "type": "string" + }, + "destination": { + "$ref": "#/components/schemas/DestinationTransferPeerPath" + } + } + }, + "ExchangeType": { + "oneOf": [ + { + "const": "BINANCE" + }, + { + "const": "BINANCEUS" + }, + { + "const": "BITFINEX" + }, + { + "const": "BITHUMB" + }, + { + "const": "BITMEX" + }, + { + "const": "BITSO" + }, + { + "const": "BITSTAMP" + }, + { + "const": "BITTREX" + }, + { + "const": "CIRCLE" + }, + { + "const": "COINBASEPRO" + }, + { + "const": "COINMETRO" + }, + { + "const": "COINSPRO" + }, + { + "const": "CRYPTOCOM" + }, + { + "const": "DERIBIT" + }, + { + "const": "FTX" + }, + { + "const": "FIXUS" + }, + { + "const": "GEMINI" + }, + { + "const": "HITBTC" + }, + { + "const": "HUOBI" + }, + { + "const": "KORBIT" + }, + { + "const": "KRAKEN" + }, + { + "const": "LIQUID" + }, + { + "const": "POLONIEX" + }, + { + "const": "OKCOIN" + }, + { + "const": "OKEX" + }, + { + "const": "SEEDCX" + } + ] + }, + "FiatAccountType": { + "const": "BLINC" + }, + "ConfigChangeRequestStatus": { + "oneOf": [ + { + "const": "WAITING_FOR_APPROVAL" + }, + { + "const": "APPROVED" + }, + { + "const": "CANCELLED" + }, + { + "const": "REJECTED" + }, + { + "const": "FAILED" + } + ] + }, + "TransactionOperation": { + "oneOf": [ + { + "const": "TRANSFER" + }, + { + "const": "BURN" + }, + { + "const": "CONTRACT_CALL" + }, + { + "const": "MINT" + }, + { + "const": "RAW" + }, + { + "const": "TYPED_MESSAGE" + } + ], + "description": "* `TRANSFER` - ๆ“ไฝœใฎใƒ‡ใƒ•ใ‚ฉใƒซใƒˆๅ€คใ€‚ใ‚ใ‚‹ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‹ใ‚‰ๅˆฅใฎใ‚ขใ‚ซใ‚ฆใƒณใƒˆใซ่ณ‡้‡‘ใ‚’่ปข้€ใ—ใพใ™ใ€‚UTXOใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใงใฏใ€ใƒžใƒซใƒๅ…ฅๅŠ›ใŠใ‚ˆใณใƒžใƒซใƒๅ‡บๅŠ›ใฎ่ปข้€ใŒๅฏ่ƒฝใงใ™ใ€‚ไป–ใฎใ™ในใฆใฎใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใงใฏใ€1ใคใฎ้€ไฟกๅ…ƒใ‚ขใƒ‰ใƒฌใ‚นใจ1ใคใฎ้€ไฟกๅ…ˆใ‚ขใƒ‰ใƒฌใ‚นใงใฎ่ปข้€ใŒๅฏ่ƒฝใงใ™ใ€‚ * `MINT` - ๆ–ฐใ—ใ„ใƒˆใƒผใ‚ฏใƒณใ‚’ไฝœๆˆใ—ใพใ™ใ€‚Stellarใ€Rippleใ€EVMใƒ™ใƒผใ‚นใฎใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใงใ‚ตใƒใƒผใƒˆใ•ใ‚Œใฆใ„ใพใ™ใ€‚ * `BURN` - ใƒˆใƒผใ‚ฏใƒณใ‚’ใƒใƒผใƒณใ—ใพใ™ใ€‚Stellarใ€Rippleใ€EVMใƒ™ใƒผใ‚นใฎใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใงใ‚ตใƒใƒผใƒˆใ•ใ‚Œใฆใ„ใพใ™ใ€‚ * `CONTRACT_CALL` - ไปปๆ„ใฎEVMใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใงWeb3ๆ“ไฝœใฎใ‚นใƒžใƒผใƒˆใ‚ณใƒณใƒˆใƒฉใ‚ฏใƒˆใƒกใ‚ฝใƒƒใƒ‰ใ‚’ๅ‘ผใณๅ‡บใ—ใพใ™ใ€‚ใ‚ณใƒณใƒˆใƒฉใ‚ฏใƒˆๅ‘ผใณๅ‡บใ—ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎๆง‹็ฏ‰ใซใฏใ€Fireblocks [้–‹็™บใƒฉใ‚คใƒ–ใƒฉใƒช](https://developers.fireblocks.com/docs/ethereum-development#convenience-libraries)ใŒๆŽจๅฅจใ•ใ‚Œใพใ™ใ€‚ * `TYPED_MESSAGE` - Ethereum Personal MessageใพใŸใฏEIP712ๅฝขๅผใฎใ‚ชใƒ•ใƒใ‚งใƒผใƒณใƒกใƒƒใ‚ปใƒผใ‚ธใ€‚ๅฎŸ้š›ใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใงใฏใชใ„็‰นๅฎšใฎ่ชญใฟๅ–ใ‚Šๅฏ่ƒฝใชใƒกใƒƒใ‚ปใƒผใ‚ธใซ็ฝฒๅใ™ใ‚‹ใŸใ‚ใซไฝฟ็”จใ—ใพใ™ใ€‚ [ๅž‹ไป˜ใใƒกใƒƒใ‚ปใƒผใ‚ธใฎ่ฉณ็ดฐ](https://developers.fireblocks.com/docs/typed-message-signing)ใ‚’ใ”่ฆงใใ ใ•ใ„ใ€‚ * `RAW` - ไบ‹ๅ‰ๅฎš็พฉใ•ใ‚ŒใŸๅฝขๅผใ‚’ๆŒใŸใชใ„ใ‚ชใƒ•ใƒใ‚งใƒผใƒณ ใƒกใƒƒใ‚ปใƒผใ‚ธใ€‚ใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใชใฉใฎใƒ—ใƒญใƒˆใ‚ณใƒซใ‚„ใ€Fireblocks ใงใƒใ‚คใƒ†ใ‚ฃใƒ–ใซใ‚ตใƒใƒผใƒˆใ•ใ‚Œใฆใ„ใชใ„ใ‚ซใ‚นใ‚ฟใƒ  ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณ ใ‚ฟใ‚คใƒ—ใชใฉใ€็ง˜ๅฏ†้ตใ‚’ไฝฟ็”จใ—ใฆไปปๆ„ใฎใƒกใƒƒใ‚ปใƒผใ‚ธใซ็ฝฒๅใ™ใ‚‹ใŸใ‚ใซไฝฟ็”จใ—ใพใ™ใ€‚[raw ็ฝฒๅใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎ่ฉณ็ดฐ](https://developers.fireblocks.com/docs/raw-message-signing)" + }, + "GetTransactionOperation": { + "oneOf": [ + { + "const": "TRANSFER" + }, + { + "const": "BURN" + }, + { + "const": "CONTRACT_CALL" + }, + { + "const": "MINT" + }, + { + "const": "RAW" + }, + { + "const": "TYPED_MESSAGE" + }, + { + "const": "ENABLE_ASSET" + }, + { + "const": "STAKE" + }, + { + "const": "UNSTAKE" + }, + { + "const": "WITHDRAW" + }, + { + "const": "REDEEM_FROM_COMPOUND" + }, + { + "const": "SUPPLY_TO_COMPOUND" + } + ], + "description": "* `TRANSFER` - ใ‚ใ‚‹ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‹ใ‚‰ๅˆฅใฎใ‚ขใ‚ซใ‚ฆใƒณใƒˆใซ่ณ‡้‡‘ใ‚’่ปข้€ใ—ใพใ™ใ€‚UTXO ใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใงใฏใ€่ค‡ๆ•ฐๅ…ฅๅŠ›ใŠใ‚ˆใณ่ค‡ๆ•ฐๅ‡บๅŠ›ใฎ่ปข้€ใŒๅฏ่ƒฝใงใ™ใ€‚ไป–ใฎใ™ในใฆใฎใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใงใฏใ€1 ใคใฎ้€ไฟกๅ…ƒใ‚ขใƒ‰ใƒฌใ‚นใจ 1 ใคใฎ้€ไฟกๅ…ˆใ‚ขใƒ‰ใƒฌใ‚นใงใฎ่ปข้€ใŒๅฏ่ƒฝใงใ™ใ€‚ * `MINT` - ๆ–ฐใ—ใ„ใƒˆใƒผใ‚ฏใƒณใ‚’ไฝœๆˆใ—ใพใ™ใ€‚Stellarใ€Rippleใ€EVM ใƒ™ใƒผใ‚นใฎใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใงใ‚ตใƒใƒผใƒˆใ•ใ‚Œใฆใ„ใพใ™ใ€‚ * `BURN` - ใƒˆใƒผใ‚ฏใƒณใ‚’ใƒใƒผใƒณใ—ใพใ™ใ€‚Stellarใ€Rippleใ€EVM ใƒ™ใƒผใ‚นใฎใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใงใ‚ตใƒใƒผใƒˆใ•ใ‚Œใฆใ„ใพใ™ใ€‚ * `CONTRACT_CALL` - ไปปๆ„ใฎ EVM ใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใง web3 ๆ“ไฝœ็”จใฎใ‚นใƒžใƒผใƒˆ ใ‚ณใƒณใƒˆใƒฉใ‚ฏใƒˆ ใƒกใ‚ฝใƒƒใƒ‰ใ‚’ๅ‘ผใณๅ‡บใ—ใพใ™ใ€‚ใ‚ณใƒณใƒˆใƒฉใ‚ฏใƒˆๅ‘ผใณๅ‡บใ—ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎๆง‹็ฏ‰ใซใฏใ€Fireblocks [้–‹็™บใƒฉใ‚คใƒ–ใƒฉใƒช](https://developers.fireblocks.com/docs/ethereum-development#convenience-libraries) ใŒๆŽจๅฅจใ•ใ‚Œใพใ™ใ€‚ * `TYPED_MESSAGE` - Ethereum Personal Message ใพใŸใฏ EIP712 ๅฝขๅผใฎใ‚ชใƒ•ใƒใ‚งใƒผใƒณ ใƒกใƒƒใ‚ปใƒผใ‚ธใ€‚ๅฎŸ้š›ใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใงใฏใชใ„็‰นๅฎšใฎ่ชญใฟๅ–ใ‚Šๅฏ่ƒฝใชใƒกใƒƒใ‚ปใƒผใ‚ธใซ็ฝฒๅใ™ใ‚‹ใŸใ‚ใซไฝฟ็”จใ—ใพใ™ใ€‚ [ๅž‹ไป˜ใใƒกใƒƒใ‚ปใƒผใ‚ธใฎ่ฉณ็ดฐ](https://developers.fireblocks.com/docs/typed-message-signing)ใ€‚ * `RAW` - ๅฎš็พฉๆธˆใฟใฎๅฝขๅผใŒใชใ„ใ‚ชใƒ•ใƒใ‚งใƒผใƒณ ใƒกใƒƒใ‚ปใƒผใ‚ธใ€‚Fireblocks ใงใƒใ‚คใƒ†ใ‚ฃใƒ–ใซใ‚ตใƒใƒผใƒˆใ•ใ‚Œใฆใ„ใชใ„ใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใ‚„ใ‚ซใ‚นใ‚ฟใƒ  ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณ ใ‚ฟใ‚คใƒ—ใชใฉใฎใƒ—ใƒญใƒˆใ‚ณใƒซใ‚’ๅซใ‚€ใ€็ง˜ๅฏ†้ตใงไปปๆ„ใฎใƒกใƒƒใ‚ปใƒผใ‚ธใซ็ฝฒๅใ™ใ‚‹ใŸใ‚ใซไฝฟ็”จใ—ใพใ™ใ€‚[raw ็ฝฒๅใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎ่ฉณ็ดฐ](https://developers.fireblocks.com/docs/raw-message-signing) * `ENABLE_ASSET` - Algorandใ€DigitalBitsใ€Solanaใ€ใŠใ‚ˆใณ Stellar ใงใฏใ€ใ‚ชใƒณใƒใ‚งใƒผใƒณ ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใง่ณ‡็”ฃใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚’ไฝœๆˆใ—ใ€ๅ…ฅ้‡‘ใ‚ขใƒ‰ใƒฌใ‚นใ‚’ๆœ‰ๅŠนใซใ™ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚ใ“ใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏใ€Vault ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใงใ“ใ‚Œใ‚‰ใฎใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใซ่ณ‡็”ฃใ‚’่ฟฝๅŠ ใ™ใ‚‹ใจ่‡ชๅ‹•็š„ใซไฝœๆˆใ•ใ‚Œใพใ™ใ€‚ * `STAKE` - ใ‚นใƒ†ใƒผใ‚ญใƒณใ‚ฐ ใƒใƒชใƒ‡ใƒผใ‚ฟใƒผใซใ‚ˆใฃใฆ็ฎก็†ใ•ใ‚Œใ‚‹ใ‚นใƒ†ใƒผใ‚ญใƒณใ‚ฐ ใƒ—ใƒผใƒซใซ่ณ‡็”ฃใ‚’ๅ‰ฒใ‚Šๅฝ“ใฆใพใ™ใ€‚Stellar ใŠใ‚ˆใณ EVM ใƒ™ใƒผใ‚นใฎใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใงใ‚ตใƒใƒผใƒˆใ•ใ‚Œใฆใ„ใพใ™ใ€‚ใ“ใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏใ€ใ‚นใƒ†ใƒผใ‚ญใƒณใ‚ฐๆ“ไฝœใ‚’ๅฎŸ่กŒใ™ใ‚‹ใจ่‡ชๅ‹•็š„ใซไฝœๆˆใ•ใ‚Œใพใ™ใ€‚ * `UNSTAKE` - ใ‚นใƒ†ใƒผใ‚ญใƒณใ‚ฐใƒใƒชใƒ‡ใƒผใ‚ฟใƒผใซใ‚ˆใฃใฆ็ฎก็†ใ•ใ‚Œใ‚‹ใ‚นใƒ†ใƒผใ‚ญใƒณใ‚ฐใƒ—ใƒผใƒซใ‹ใ‚‰่ณ‡็”ฃใ‚’ๅ‰Š้™คใ—ใพใ™ใ€‚StellarใŠใ‚ˆใณEVMใƒ™ใƒผใ‚นใฎใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใงใ‚ตใƒใƒผใƒˆใ•ใ‚Œใฆใ„ใพใ™ใ€‚ใ“ใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏใ€ใ‚นใƒ†ใƒผใ‚ญใƒณใ‚ฐๆ“ไฝœใ‚’ๅฎŸ่กŒใ™ใ‚‹ใจใใซ่‡ชๅ‹•็š„ใซไฝœๆˆใ•ใ‚Œใพใ™ใ€‚ * `WITHDRAW` - ๅฐ‚็”จใฎใ‚นใƒ†ใƒผใ‚ญใƒณใ‚ฐใƒœใƒผใƒซใƒˆใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‹ใ‚‰ๅˆฅใฎใ‚ขใƒ‰ใƒฌใ‚นใซ่ณ‡็”ฃใ‚’่ปข้€ใ—ใพใ™ใ€‚StellarใŠใ‚ˆใณEVMใƒ™ใƒผใ‚นใฎใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใงใ‚ตใƒใƒผใƒˆใ•ใ‚Œใฆใ„ใพใ™ใ€‚ใ“ใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏใ€ใ‚นใƒ†ใƒผใ‚ญใƒณใ‚ฐๆ“ไฝœใ‚’ๅฎŸ่กŒใ™ใ‚‹ใจใใซ่‡ชๅ‹•็š„ใซไฝœๆˆใ•ใ‚Œใพใ™ใ€‚ **ๆณจ๏ผš** Fireblocksใฏใ€ใ“ใฎใ‚ฟใ‚คใƒ—ใฎๅๅ‰ใ‚’ใพใ‚‚ใชใ`WITHDRAW`ใ‹ใ‚‰ๅˆฅใฎใ‚ฟใ‚คใƒ—ๅใซๅค‰ๆ›ดใ—ใพใ™ใ€‚ๆ–ฐใ—ใ„ใ‚ฟใ‚คใƒ—ๅใซใคใ„ใฆใฏใ€7ๆ—ฅๅ‰ใซ้€š็Ÿฅใ•ใ‚Œใพใ™ใ€‚ * `SUPPLY_TO_COMPOUND` - 2023ๅนด4ๆœˆ1ๆ—ฅใ‹ใ‚‰้žๆŽจๅฅจใ€‚ใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚นใฎใƒฆใƒผใ‚ถใƒผใŒFireblocksใจCompound DeFIใƒ—ใƒญใƒˆใ‚ณใƒซ้–“ใฎ็›ดๆŽฅ็ตฑๅˆใ‚’ไฝฟ็”จใ—ใŸๅ ดๅˆใ€ๅคใ„ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใงใฏใ“ใ‚ŒใŒๆ“ไฝœใจใ—ใฆไฝฟ็”จใ•ใ‚Œใ‚‹ใ“ใจใŒใ‚ใ‚Šใพใ™ใ€‚ * `REDEEM_FROM_COMPOUND` - 2023ๅนด4ๆœˆ1ๆ—ฅไปฅ้™้žๆŽจๅฅจใ€‚ใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚นใฎใƒฆใƒผใ‚ถใƒผใŒFireblocksใจCompound DeFIใƒ—ใƒญใƒˆใ‚ณใƒซใฎ็›ดๆŽฅ็ตฑๅˆใ‚’ไฝฟ็”จใ—ใฆใ„ใ‚‹ๅ ดๅˆใ€ๅคใ„ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใงใฏใ“ใ‚ŒใŒๆ“ไฝœใจใ—ใฆไฝฟ็”จใ•ใ‚Œใ‚‹ใ“ใจใŒใ‚ใ‚Šใพใ™ใ€‚." + }, + "Error": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "code": { + "type": "number" + } + } + }, + "Term": { + "type": "object", + "properties": { + "networkConnectionId": { + "type": "string" + }, + "outgoing": { + "type": "boolean" + }, + "asset": { + "type": "string" + }, + "amount": { + "type": "string" + }, + "note": { + "type": "string" + }, + "operation": { + "type": "string" + } + } + }, + "SetConfirmationsThresholdRequest": { + "type": "object", + "properties": { + "numOfConfirmations": { + "type": "number" + } + } + }, + "SetConfirmationsThresholdResponse": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + }, + "transactions": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DropTransactionRequest": { + "type": "object", + "properties": { + "txId": { + "type": "string" + }, + "feeLevel": { + "type": "string" + }, + "gasPrice": { + "type": "string" + } + } + }, + "DropTransactionResponse": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + }, + "transactions": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "UnsignedMessage": { + "type": "object", + "properties": { + "content": { + "type": "string" + }, + "bip44addressIndex": { + "type": "integer" + }, + "bip44change": { + "type": "number" + }, + "derivationPath": { + "type": "array", + "items": { + "type": "number" + } + } + }, + "required": [ + "content" + ] + }, + "SignedMessage": { + "type": "object", + "description": "็”Ÿ็ฝฒๅใฎใŸใ‚ใซ่ฟ”ใ•ใ‚ŒใŸ็ฝฒๅๆธˆใฟใƒกใƒƒใ‚ปใƒผใ‚ธใฎใƒชใ‚นใƒˆ.", + "properties": { + "content": { + "type": "string" + }, + "algorithm": { + "oneOf": [ + { + "const": "MPC_ECDSA_SECP256K1" + }, + { + "const": "MPC_EDDSA_ED25519" + } + ] + }, + "derivationPath": { + "type": "array", + "items": { + "type": "number" + } + }, + "signature": { + "type": "object", + "properties": { + "fullSig": { + "type": "string" + }, + "r": { + "type": "string" + }, + "s": { + "type": "string" + }, + "v": { + "type": "number" + } + } + }, + "publicKey": { + "type": "string" + } + } + }, + "PublicKeyInformation": { + "type": "object", + "properties": { + "algorithm": { + "type": "string" + }, + "derivationPath": { + "type": "array", + "items": { + "type": "number" + } + }, + "publicKey": { + "type": "string" + } + } + }, + "TradingAccountType": { + "oneOf": [ + { + "const": "COIN_FUTURES" + }, + { + "const": "COIN_MARGINED_SWAP" + }, + { + "const": "EXCHANGE" + }, + { + "const": "FUNDING" + }, + { + "const": "FUNDABLE" + }, + { + "const": "FUTURES" + }, + { + "const": "FUTURES_CROSS" + }, + { + "const": "MARGIN" + }, + { + "const": "MARGIN_CROSS" + }, + { + "const": "OPTIONS" + }, + { + "const": "SPOT" + }, + { + "const": "USDT_MARGINED_SWAP_CROSS" + }, + { + "const": "USDT_FUTURES" + }, + { + "const": "UNIFIED" + } + ] + }, + "ValidateAddressResponse": { + "type": "object", + "properties": { + "isValid": { + "type": "boolean" + }, + "isActive": { + "type": "boolean" + }, + "requiresTag": { + "type": "boolean" + } + } + }, + "ResendWebhooksResponse": { + "type": "object", + "properties": { + "messagesCount": { + "type": "number" + } + } + }, + "UnspentInputsResponse": { + "type": "object", + "properties": { + "input": { + "$ref": "#/components/schemas/UnspentInput" + }, + "address": { + "type": "string" + }, + "amount": { + "type": "string" + }, + "confirmations": { + "type": "number" + }, + "status": { + "type": "string" + } + } + }, + "UnspentInput": { + "type": "object", + "properties": { + "txHash": { + "type": "string" + }, + "index": { + "type": "number" + } + } + }, + "GetUsersResponse": { + "type": "object", + "properties": { + "users": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserResponse" + } + } + } + }, + "ExtraParameters": { + "type": "object", + "properties": {}, + "description": "่ฟฝๅŠ ใฎใƒ—ใƒญใƒˆใ‚ณใƒซ/ๆ“ไฝœๅ›บๆœ‰ใฎใ‚ญใƒผๅ€คใƒ‘ใƒฉใƒกใƒผใ‚ฟ: UTXO ใƒ™ใƒผใ‚นใฎใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณๅ…ฅๅŠ›้ธๆŠžใฎๅ ดๅˆใ€ใ‚ญใƒผ `inputsSelection` ใ‚’่ฟฝๅŠ ใ—ใ€ๅ€คใ‚’ [ๅ…ฅๅŠ›้ธๆŠžๆง‹้€ ](https://developers.fireblocks.com/reference/transaction-objects#inputsselection) ใซ่จญๅฎšใ—ใพใ™ใ€‚ๅ…ฅๅŠ›ใฏใ€[ๆœชไฝฟ็”จใฎๅ…ฅๅŠ›ใฎๅ–ๅพ—ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆ](https://developers.fireblocks.com/reference/get_vault-accounts-vaultaccountid-assetid-unspent-inputs) ใ‹ใ‚‰ๅ–ๅพ—ใงใใพใ™ใ€‚`RAW` ๆ“ไฝœใฎๅ ดๅˆใ€ใ‚ญใƒผ `rawMessageData` ใ‚’่ฟฝๅŠ ใ—ใ€ๅ€คใ‚’ [็”Ÿใฎใƒกใƒƒใ‚ปใƒผใ‚ธ ใƒ‡ใƒผใ‚ฟๆง‹้€ ](https://developers.fireblocks.com/reference/raw-signing-objects#rawmessagedata) ใซ่จญๅฎšใ—ใพใ™ใ€‚`CONTRACT_CALL` ๆ“ไฝœใฎๅ ดๅˆใ€ใ‚ญใƒผ `contractCallData` ใ‚’่ฟฝๅŠ ใ—ใ€ๅ€คใ‚’ Ethereum ใ‚นใƒžใƒผใƒˆ ใ‚ณใƒณใƒˆใƒฉใ‚ฏใƒˆใฎใ‚ขใƒ—ใƒชใ‚ฑใƒผใ‚ทใƒงใƒณ ใƒใ‚คใƒŠใƒช ใ‚คใƒณใ‚ฟใƒผใƒ•ใ‚งใ‚คใ‚น (ABI) ใƒšใ‚คใƒญใƒผใƒ‰ใซ่จญๅฎšใ—ใพใ™ใ€‚ Fireblocks [้–‹็™บใƒฉใ‚คใƒ–ใƒฉใƒช](https://developers.fireblocks.com/docs/ethereum-development#convenience-libraries)ใฏใ€ใ‚ณใƒณใƒˆใƒฉใ‚ฏใƒˆๅ‘ผใณๅ‡บใ—ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎๆง‹็ฏ‰ใซๆŽจๅฅจใ•ใ‚Œใพใ™ใ€‚." + }, + "NetworkIdRoutingPolicy": { + "type": "object", + "properties": { + "crypto": { + "oneOf": [ + { + "$ref": "#/components/schemas/CustomCryptoRoutingDest" + }, + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + } + ] + }, + "sen": { + "oneOf": [ + { + "$ref": "#/components/schemas/CustomFiatRoutingDest" + }, + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + } + ] + }, + "signet": { + "oneOf": [ + { + "$ref": "#/components/schemas/CustomFiatRoutingDest" + }, + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + } + ] + }, + "sen_test": { + "oneOf": [ + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + }, + { + "$ref": "#/components/schemas/CustomFiatRoutingDest" + } + ] + }, + "signet_test": { + "oneOf": [ + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + }, + { + "$ref": "#/components/schemas/CustomFiatRoutingDest" + } + ] + } + } + }, + "NetworkConnectionRoutingPolicy": { + "type": "object", + "properties": { + "crypto": { + "oneOf": [ + { + "$ref": "#/components/schemas/CustomCryptoRoutingDest" + }, + { + "$ref": "#/components/schemas/DefaultNetworkRoutingDest" + }, + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + } + ] + }, + "sen": { + "oneOf": [ + { + "$ref": "#/components/schemas/CustomFiatRoutingDest" + }, + { + "$ref": "#/components/schemas/DefaultNetworkRoutingDest" + }, + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + } + ] + }, + "signet": { + "oneOf": [ + { + "$ref": "#/components/schemas/DefaultNetworkRoutingDest" + }, + { + "$ref": "#/components/schemas/CustomFiatRoutingDest" + }, + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + } + ] + }, + "sen_test": { + "oneOf": [ + { + "$ref": "#/components/schemas/DefaultNetworkRoutingDest" + }, + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + }, + { + "$ref": "#/components/schemas/CustomFiatRoutingDest" + } + ] + }, + "signet_test": { + "oneOf": [ + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + }, + { + "$ref": "#/components/schemas/CustomFiatRoutingDest" + }, + { + "$ref": "#/components/schemas/DefaultNetworkRoutingDest" + } + ] + } + } + }, + "CustomFiatRoutingDest": { + "type": "object", + "properties": { + "scheme": { + "const": "CUSTOM", + "description": "ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใƒญใ‚ธใƒƒใ‚ฏ." + }, + "dstType": { + "const": "FIAT_ACCOUNT", + "description": "่ณ‡้‡‘ใŒ้€้‡‘ใ•ใ‚Œใ‚‹ๆณ•ๅฎš้€š่ฒจๅฃๅบง." + }, + "dstId": { + "type": "string", + "description": "่ณ‡้‡‘ใŒ้€้‡‘ใ•ใ‚Œใ‚‹ๆณ•ๅฎš้€š่ฒจๅฃๅบงใฎID." + } + }, + "required": [ + "scheme", + "dstType", + "dstId" + ] + }, + "CustomCryptoRoutingDest": { + "type": "object", + "properties": { + "scheme": { + "const": "CUSTOM", + "description": "ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใƒญใ‚ธใƒƒใ‚ฏ." + }, + "dstType": { + "oneOf": [ + { + "const": "VAULT" + }, + { + "const": "EXCHANGE" + } + ], + "description": "่ณ‡้‡‘ใŒ้€้‡‘ใ•ใ‚Œใ‚‹้€้‡‘ๅ…ˆๅฃๅบงใฎ็จฎ้กž." + }, + "dstId": { + "type": "string", + "description": "่ณ‡้‡‘ใฎ้€้‡‘ๅ…ˆๅฃๅบงใฎID." + } + }, + "required": [ + "scheme", + "dstType", + "dstId" + ] + }, + "DefaultNetworkRoutingDest": { + "type": "object", + "properties": { + "scheme": { + "const": "DEFAULT", + "description": "ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใƒญใ‚ธใƒƒใ‚ฏ." + } + }, + "required": [ + "scheme" + ] + }, + "NoneNetworkRoutingDest": { + "type": "object", + "properties": { + "scheme": { + "const": "NONE", + "description": "ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏใƒซใƒผใƒ†ใ‚ฃใƒณใ‚ฐใƒญใ‚ธใƒƒใ‚ฏใชใ—." + } + }, + "required": [ + "scheme" + ] + }, + "UserResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "role": { + "type": "string" + }, + "email": { + "type": "string" + }, + "enabled": { + "type": "boolean" + } + } + }, + "SessionMetadata": { + "type": "object", + "properties": { + "appUrl": { + "type": "string" + }, + "appName": { + "type": "string" + }, + "appDescription": { + "type": "string" + }, + "appIcon": { + "type": "string" + } + }, + "required": [ + "appUrl" + ] + }, + "SessionDTO": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ๆŽฅ็ถšใฎID", + "example": "4e9e7051-f3b2-48e9-8ee6-b12492552657" + }, + "userId": { + "type": "string", + "description": "ๆŽฅ็ถšใ‚’ไฝœๆˆใ—ใŸใƒฆใƒผใ‚ถใƒผใฎID" + }, + "sessionMetadata": { + "description": "ๆŽฅ็ถšใฎใƒกใ‚ฟใƒ‡ใƒผใ‚ฟ๏ผˆdappใซใ‚ˆใฃใฆๆไพ›ใ•ใ‚Œใ‚‹๏ผ‰", + "type": "object", + "properties": { + "appUrl": { + "type": "string" + }, + "appName": { + "type": "string" + }, + "appDescription": { + "type": "string" + }, + "appIcon": { + "type": "string" + } + } + }, + "vaultAccountId": { + "type": "number", + "description": "ๆŽฅ็ถšใ™ใ‚‹้‡‘ๅบซ", + "example": 1 + }, + "feeLevel": { + "oneOf": [ + { + "const": "MEDIUM" + }, + { + "const": "HIGH" + } + ], + "description": "ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใฎๆ–™้‡‘ใƒฌใƒ™ใƒซ", + "example": "MEDIUM" + }, + "chainIds": { + "description": "ๆŽฅ็ถšใซๆ‰ฟ่ชใ•ใ‚ŒใŸใƒใ‚งใƒผใƒณ", + "example": [ + "ETH", + "ETH_TEST", + "SOL" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "connectionType": { + "const": "WalletConnect", + "description": "ๆŽฅ็ถšใฎ็จฎ้กž", + "example": "WalletConnect" + }, + "connectionMethod": { + "oneOf": [ + { + "const": "DESKTOP" + }, + { + "const": "MOBILE" + }, + { + "const": "API" + } + ], + "description": "ๆŽฅ็ถšใŒ็ขบ็ซ‹ใ•ใ‚ŒใŸๆ–นๆณ•", + "example": "API" + }, + "creationDate": { + "format": "date-time", + "type": "string", + "description": "ใ‚ปใƒƒใ‚ทใƒงใƒณไฝœๆˆใฎใ‚ฟใ‚คใƒ ใ‚นใ‚ฟใƒณใƒ—" + } + }, + "required": [ + "id", + "userId", + "sessionMetadata", + "vaultAccountId", + "feeLevel", + "chainIds", + "connectionType", + "connectionMethod", + "creationDate" + ] + }, + "GetConnectionsResponse": { + "type": "object", + "properties": { + "data": { + "description": "่ฆๆฑ‚ใ•ใ‚ŒใŸWeb3ๆŽฅ็ถšใฎใƒ‡ใƒผใ‚ฟใฎ้…ๅˆ—", + "type": "array", + "items": { + "$ref": "#/components/schemas/SessionDTO" + } + }, + "paging": { + "$ref": "#/components/schemas/Paging" + } + }, + "required": [ + "data" + ] + }, + "CreateConnectionRequest": { + "type": "object", + "properties": { + "vaultAccountId": { + "type": "number", + "description": "Web3ๆŽฅ็ถšใซๆŽฅ็ถšใ™ใ‚‹ใƒœใƒผใƒซใƒˆใฎID.", + "example": 1 + }, + "feeLevel": { + "oneOf": [ + { + "const": "MEDIUM" + }, + { + "const": "HIGH" + } + ], + "description": "ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใฎๆ–™้‡‘ใƒฌใƒ™ใƒซใ€‚ๆœ‰ๅŠนใชๅ€คใฏ `MEDIUM` ใจ `HIGH` ใงใ™ใ€‚.", + "example": "MEDIUM" + }, + "uri": { + "type": "string", + "description": "dappใŒๆไพ›ใ™ใ‚‹WalletConnect uri.", + "example": "wc:77752975-906f-48f5-b59f-047826ee947e@1?bridge=https%3A%2F%2F0.bridge.walletconnect.org&key=64be99adc6086b7a729b0ec8c7e1f174927ab92e84f5c6f9527050225344a637" + }, + "chainIds": { + "description": "Web3ๆŽฅ็ถšใงไฝฟ็”จใ•ใ‚Œใ‚‹ใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณใƒใƒƒใƒˆใƒฏใƒผใ‚ฏใฎID.", + "example": [ + "ETH", + "ETH_TEST" + ], + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "vaultAccountId", + "feeLevel", + "uri", + "chainIds" + ] + }, + "CreateConnectionResponse": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "้–‹ๅง‹ใ•ใ‚ŒใŸWeb3ๆŽฅ็ถšใฎID.", + "example": "4e9e7051-f3b2-48e9-8ee6-b12492552657" + }, + "sessionMetadata": { + "description": "Web3ๆŽฅ็ถšใฎใƒกใ‚ฟใƒ‡ใƒผใ‚ฟ๏ผˆDAppใซใ‚ˆใฃใฆๆไพ›๏ผ‰.", + "type": "object", + "properties": { + "appUrl": { + "type": "string" + }, + "appName": { + "type": "string" + }, + "appDescription": { + "type": "string" + }, + "appIcon": { + "type": "string" + } + } + } + }, + "required": [ + "id", + "sessionMetadata" + ] + }, + "RespondToConnectionRequest": { + "type": "object", + "properties": { + "approve": { + "type": "boolean", + "description": "้–‹ๅง‹ใ•ใ‚ŒใŸWeb3ๆŽฅ็ถšใฎๆ‰ฟ่ช.", + "example": true + } + }, + "required": [ + "approve" + ] + }, + "AddCollateralRequestBody": { + "type": "object", + "properties": { + "transactionRequest": { + "$ref": "#/components/schemas/TransactionRequest" + }, + "isSrcCollateral": { + "type": "boolean", + "description": "ใ‚ชใƒ—ใ‚ทใƒงใƒณ" + } + } + }, + "RemoveCollateralRequestBody": { + "type": "object", + "properties": { + "transactionRequest": { + "$ref": "#/components/schemas/TransactionRequest" + }, + "isDstCollateral": { + "type": "boolean", + "description": "ใ‚ชใƒ—ใ‚ทใƒงใƒณ" + } + } + }, + "SettlementRequestBody": { + "type": "object", + "properties": { + "mainExchangeAccountId": { + "type": "string" + } + } + }, + "SettlementResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "initiator": { + "type": "string" + }, + "exchangeReply": { + "type": "string" + }, + "fireblocksInitiatedTransactions": { + "type": "object" + }, + "exchangeRequestedTransactions": { + "$ref": "#/components/schemas/SettlementResponse" + } + } + }, + "GetSettlementResponse": { + "$ref": "#/components/schemas/SettlementResponse" + }, + "ToExchangeTransaction": { + "type": "object", + "properties": { + "assetId": { + "type": "string" + }, + "amount": { + "type": "string" + }, + "dstAddress": { + "type": "string" + }, + "dstTag": { + "type": "string", + "description": "ใ‚ชใƒ—ใ‚ทใƒงใƒณ" + } + } + }, + "ToCollateralTransaction": { + "type": "object", + "properties": { + "asset": { + "type": "string" + }, + "amount": { + "type": "string" + }, + "srcAddress": { + "type": "string" + }, + "srcTag": { + "type": "string", + "description": "ใ‚ชใƒ—ใ‚ทใƒงใƒณ" + }, + "fee": { + "type": "string", + "description": "ใ‚ชใƒ—ใ‚ทใƒงใƒณ" + } + } + }, + "XBSettlementConfigCreationRequestBody": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "ๅ›ฝๅขƒใ‚’่ถŠใˆใŸๆฑบๆธˆๆง‹ๆˆใฎๅ็งฐ" + }, + "corridorId": { + "$ref": "#/components/schemas/XBSettlementCorridorId" + }, + "steps": { + "$ref": "#/components/schemas/XBSettlementConfigStepsRecord" + }, + "conversionSlippageBasisPoints": { + "$ref": "#/components/schemas/XBSettlementConversionSlippageBasisPoints" + } + }, + "required": [ + "name", + "corridorId", + "steps" + ] + }, + "XBSettlementConfigCreationResponse": { + "$ref": "#/components/schemas/XBSettlementConfigModel" + }, + "XBSettlementConfigEditRequestBody": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "ๅ›ฝๅขƒใ‚’่ถŠใˆใŸๆฑบๆธˆๆง‹ๆˆใฎๅ็งฐ" + }, + "steps": { + "$ref": "#/components/schemas/XBSettlementConfigStepsRecord" + }, + "conversionSlippageBasisPoints": { + "$ref": "#/components/schemas/XBSettlementConversionSlippageBasisPoints" + } + }, + "required": [ + "name", + "steps" + ] + }, + "XBSettlementConfigEditResponse": { + "$ref": "#/components/schemas/XBSettlementConfigModel" + }, + "XBSettlementConfigDeletionResponse": { + "$ref": "#/components/schemas/XBSettlementConfigModel" + }, + "XBSettlementGetConfigResponse": { + "$ref": "#/components/schemas/XBSettlementConfigModel" + }, + "XBSettlementGetAllConfigsResponse": { + "type": "object", + "properties": { + "configurations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/XBSettlementConfigModel" + } + } + }, + "required": [ + "configurations" + ] + }, + "XBSettlementFlowExecutionRequestBody": { + "type": "object", + "properties": { + "conversionSlippageBasisPoints": { + "$ref": "#/components/schemas/XBSettlementConversionSlippageBasisPoints" + } + } + }, + "XBSettlementFlowExecutionResponse": { + "$ref": "#/components/schemas/XBSettlementFlowExecutionModel" + }, + "XBSettlementFlowExecutionStep": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ใ‚นใƒ†ใƒƒใƒ—ๅฎŸ่กŒใฎไธ€ๆ„ใฎID" + }, + "accountId": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/XBSettlementFlowExecutionStepStatus" + }, + "inputAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "outputAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "fee": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "startedAt": { + "type": "number", + "description": "ใ‚จใƒใƒƒใ‚ฏๅฝขๅผใงใฎใ‚นใƒ†ใƒƒใƒ—ๅฎŸ่กŒ้–‹ๅง‹ๆ™‚ๅˆป." + }, + "completedAt": { + "type": "number", + "description": "ใ‚จใƒใƒƒใ‚ฏๅฝขๅผใงใฎใ‚นใƒ†ใƒƒใƒ—ๅฎŸ่กŒ็ต‚ไบ†ๆ™‚ๅˆป." + }, + "isSignRequired": { + "type": "boolean", + "description": "ใ‚นใƒ†ใƒƒใƒ—ใ‚’ๅฎŸ่กŒใ™ใ‚‹ใŸใ‚ใซ็ฝฒๅใŒๅฟ…่ฆใ‹ใฉใ†ใ‹." + } + }, + "required": [ + "id", + "accountId", + "status", + "inputAmount", + "isSignRequired" + ] + }, + "XBSettlementFlowExecutionStepStatus": { + "oneOf": [ + { + "const": "NOT_STARTED" + }, + { + "const": "PROCESSING" + }, + { + "const": "COMPLETED" + }, + { + "const": "FAILED" + } + ] + }, + "XBSettlementFlowExecutionStatus": { + "oneOf": [ + { + "const": "NOT_LAUNCHED" + }, + { + "const": "PROCESSING" + }, + { + "const": "COMPLETED" + }, + { + "const": "FAILED" + } + ] + }, + "XBSettlementConfigId": { + "type": "string", + "format": "uuid", + "description": "ใ‚ฏใƒญใ‚นใƒœใƒผใƒ€ใƒผๆง‹ๆˆใฎๅ›บๆœ‰ ID" + }, + "XBSettlementConfigModel": { + "type": "object", + "properties": { + "configId": { + "$ref": "#/components/schemas/XBSettlementConfigId" + }, + "corridorId": { + "$ref": "#/components/schemas/XBSettlementCorridorId" + }, + "name": { + "type": "string", + "description": "ๅ›ฝๅขƒใ‚’่ถŠใˆใŸๆฑบๆธˆๆง‹ๆˆใฎๅ็งฐ" + }, + "steps": { + "$ref": "#/components/schemas/XBSettlementConfigStepsRecord" + }, + "conversionSlippageBasisPoints": { + "$ref": "#/components/schemas/XBSettlementConversionSlippageBasisPoints" + }, + "createdAt": { + "type": "number", + "description": "ใ‚จใƒใƒƒใ‚ฏๅฝขๅผใฎไฝœๆˆๆ™‚้–“." + } + }, + "required": [ + "configId", + "name", + "corridorId", + "steps", + "conversionSlippageBasisPoints", + "createdAt" + ] + }, + "XBSettlementCorridorId": { + "oneOf": [ + { + "const": "MX_US" + }, + { + "const": "CO_US" + }, + { + "const": "US_MX" + }, + { + "const": "US_EU" + }, + { + "const": "US_UK" + } + ], + "description": "- MX_US : ใƒกใ‚ญใ‚ทใ‚ณ (MXN) ใ‹ใ‚‰็ฑณๅ›ฝ (USD) - CO_US : ใ‚ณใƒญใƒณใƒ“ใ‚ข (COP) ใ‹ใ‚‰็ฑณๅ›ฝ (USD) - US_MX : ็ฑณๅ›ฝ (USD) ใ‹ใ‚‰ใƒกใ‚ญใ‚ทใ‚ณ (MXN) - US_EU : ็ฑณๅ›ฝ (USD) ใ‹ใ‚‰ๆฌงๅทž้€ฃๅˆ (EUR) - US_UK : ็ฑณๅ›ฝ (USD) ใ‹ใ‚‰่‹ฑๅ›ฝ (GBP)" + }, + "XBSettlementConfigStep": { + "type": "object", + "properties": { + "stepType": { + "$ref": "#/components/schemas/XBSettlementStepType" + }, + "accountId": { + "type": "string" + } + }, + "required": [ + "stepType", + "accountId" + ] + }, + "XBSettlementStepType": { + "oneOf": [ + { + "const": "ON_RAMP" + }, + { + "const": "VAULT_ACCOUNT" + }, + { + "const": "OFF_RAMP" + }, + { + "const": "FIAT_DESTINATION" + } + ], + "description": "- ON_RAMP: ๆณ•ๅฎš้€š่ฒจใ‚’ๆš—ๅท้€š่ฒจใซไบคๆ›ใงใใ‚‹ใ‚ตใƒผใƒ“ใ‚นใ€‚OnRamp ใฎๅ…ฅๅŠ›ๅ€คใฏๅธธใซๆณ•ๅฎš้€š่ฒจใงใ€ๅ‡บๅŠ›ๅ€คใฏๆš—ๅท่ณ‡็”ฃใซใชใ‚Šใพใ™ใ€‚ - VAULT_ACCOUNT: Fireblocks Vault ใ‚ขใ‚ซใ‚ฆใƒณใƒˆ - OFF_RAMP: ๆš—ๅท้€š่ฒจใ‚’ๆณ•ๅฎš้€š่ฒจใซไบคๆ›ใงใใ‚‹ใ‚ตใƒผใƒ“ใ‚นใ€‚OffRamp ใฎๅ…ฅๅŠ›ๅ€คใฏๅธธใซๆš—ๅท่ณ‡็”ฃใงใ€ๅ‡บๅŠ›ๅ€คใฏๆณ•ๅฎš้€š่ฒจใซใชใ‚Šใพใ™ใ€‚ - FIAT_DESTINATION: ๆณ•ๅฎš้€š่ฒจใ‚ขใ‚ซใ‚ฆใƒณใƒˆ" + }, + "XBSettlementFlowSetupStep": { + "type": "object", + "properties": { + "accountId": { + "type": "string" + }, + "inputAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "outputAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "estimatedFeeAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "estimatedTime": { + "type": "number", + "description": "ใ‚นใƒ†ใƒƒใƒ—ใฎๅฎŸ่กŒใซใ‹ใ‹ใ‚‹ๆŽจๅฎšๆ™‚้–“." + }, + "isSignRequired": { + "type": "boolean", + "description": "ใ‚นใƒ†ใƒƒใƒ—ใ‚’ๅฎŸ่กŒใ™ใ‚‹ใŸใ‚ใซ็ฝฒๅใŒๅฟ…่ฆใ‹ใฉใ†ใ‹." + } + }, + "required": [ + "accountId", + "inputAmount", + "outputAmount", + "estimatedFeeAmount", + "estimatedTime", + "isSignRequired" + ] + }, + "XBSettlementGetFlowResponse": { + "type": "object", + "properties": { + "preview": { + "$ref": "#/components/schemas/XBSettlementFlowPreviewModel" + }, + "execution": { + "$ref": "#/components/schemas/XBSettlementFlowExecutionModel" + } + } + }, + "XBSettlementFlowPreviewModel": { + "type": "object", + "properties": { + "flowId": { + "type": "string", + "description": "ๅ›ฝๅขƒใ‚’่ถŠใˆใŸใƒ•ใƒญใƒผใฎไธ€ๆ„ใฎID." + }, + "configId": { + "$ref": "#/components/schemas/XBSettlementConfigId" + }, + "conversionRate": { + "type": "string", + "description": "ใ‚ชใƒณใƒฉใƒณใƒ—ใพใŸใฏใ‚ชใƒ•ใƒฉใƒณใƒ—ใ‹ใ‚‰ๅ—ใ‘ๅ–ใฃใŸใ‚ณใƒณใƒใƒผใ‚ธใƒงใƒณ็Ž‡." + }, + "inputAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "estimatedOutputAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "totalEstimatedFee": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "totalEstimatedTime": { + "type": "number", + "description": "ๅ›ฝๅขƒใ‚’่ถŠใˆใŸใƒ•ใƒญใƒผใ‚’ๅฎŸ่กŒใ™ใ‚‹ใŸใ‚ใฎๅˆ่จˆ*ๆŽจๅฎš*ๆ™‚้–“." + }, + "steps": { + "$ref": "#/components/schemas/XBSettlementFlowStepsRecord" + } + }, + "required": [ + "flowId", + "configId", + "steps", + "inputAmount", + "estimatedOutputAmount", + "totalEstimatedFee", + "totalEstimatedTime", + "conversionRate" + ] + }, + "XBSettlementCreateFlowRequestBody": { + "type": "object", + "properties": { + "configId": { + "$ref": "#/components/schemas/XBSettlementConfigId" + }, + "amount": { + "type": "string", + "description": "ใ“ใฎใ‚ฏใƒญใ‚นใƒœใƒผใƒ€ใƒผใƒ•ใƒญใƒผใง่ปข้€ใ™ใ‚‹้‡‘้กใ€‚่ณ‡็”ฃใฎ็จฎ้กžใฏใ‚ฏใƒญใ‚นใƒœใƒผใƒ€ใƒผๆฑบๆธˆ่จญๅฎšใซใ‚ˆใฃใฆๅฎš็พฉใ•ใ‚Œใพใ™ใ€‚." + } + }, + "required": [ + "configId", + "amount" + ] + }, + "XBSettlementCreateFlowResponse": { + "$ref": "#/components/schemas/XBSettlementFlowPreviewModel" + }, + "XBSettlementFlowExecutionModel": { + "type": "object", + "properties": { + "flowId": { + "type": "string", + "description": "ๅ›ฝๅขƒใ‚’่ถŠใˆใŸใƒ•ใƒญใƒผใฎไธ€ๆ„ใฎID." + }, + "configId": { + "$ref": "#/components/schemas/XBSettlementConfigId" + }, + "inputAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "outputAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "totalFee": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "initiatedAt": { + "type": "number", + "description": "ๅ›ฝๅขƒใ‚’่ถŠใˆใŸใƒ•ใƒญใƒผใŒๅฎŸ่กŒใ•ใ‚ŒใŸๆ™‚้–“ใ‚’ใ‚จใƒใƒƒใ‚ฏๅฝขๅผใง่กจใ—ใŸใ‚‚ใฎ." + }, + "initiatedBy": { + "description": "ใƒ•ใƒญใƒผใ‚’้–‹ๅง‹ใ—ใŸใƒฆใƒผใ‚ถใƒผใฎID", + "type": "string" + }, + "state": { + "$ref": "#/components/schemas/XBSettlementFlowExecutionStatus" + }, + "steps": { + "$ref": "#/components/schemas/XBSettlementFlowStepsExecutionRecord" + }, + "selectedConversionSlippage": { + "type": "object", + "description": "ใ‚ชใƒผใƒใƒผใƒฉใ‚คใƒ‰ใƒญใ‚ธใƒƒใ‚ฏใŒๅฎŸ่กŒใ•ใ‚ŒใŸๅฏ่ƒฝๆ€งใŒใ‚ใ‚‹ใŸใ‚ใ€ใƒ•ใƒญใƒผไธญใซไฝฟ็”จใ•ใ‚ŒใŸ้ธๆŠžใ•ใ‚ŒใŸใ‚นใƒชใƒƒใƒ—ใ‚’็คบใ—ใพใ™ใ€‚.", + "properties": { + "basisPoints": { + "type": "number" + }, + "reason": { + "$ref": "#/components/schemas/XBSettlementFlowSelectedConversionSlippageReason" + } + }, + "required": [ + "basisPoints", + "reason" + ] + } + }, + "required": [ + "flowId", + "configId", + "steps", + "inputAmount", + "outputAmount", + "totalFee", + "initiatedAt", + "initiatedBy", + "state", + "selectedConversionSlippage" + ] + }, + "XBSettlementFlowSelectedConversionSlippageReason": { + "oneOf": [ + { + "const": "DEFAULT" + }, + { + "const": "CONFIG" + }, + { + "const": "FLOW" + } + ] + }, + "XBSettlementFlowStepsExecutionRecord": { + "type": "object", + "properties": { + "stepType": { + "$ref": "#/components/schemas/XBSettlementStepType" + } + }, + "additionalProperties": { + "$ref": "#/components/schemas/XBSettlementFlowExecutionStep" + } + }, + "XBSettlementConfigStepsRecord": { + "type": "object", + "properties": { + "stepType": { + "$ref": "#/components/schemas/XBSettlementStepType" + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "accountId": { + "type": "string" + }, + "inputAssetId": { + "$ref": "#/components/schemas/XBSettlementAssetID" + }, + "outputAssetId": { + "$ref": "#/components/schemas/XBSettlementAssetID" + } + }, + "required": [ + "accountId" + ] + } + }, + "XBSettlementConversionSlippageBasisPoints": { + "type": "integer", + "minimum": 0, + "maximum": 10000, + "default": 10000, + "description": "ใ‚นใƒชใƒƒใƒšใƒผใ‚ธ่จญๅฎšใฏใƒ™ใƒผใ‚ทใ‚นใƒใ‚คใƒณใƒˆใงใ€ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆๅ€คใฏ10%ใงใ™ใ€‚" + }, + "XBSettlementFlowStepsRecord": { + "type": "object", + "properties": { + "stepType": { + "$ref": "#/components/schemas/XBSettlementStepType" + } + }, + "additionalProperties": { + "$ref": "#/components/schemas/XBSettlementFlowSetupStep" + } + }, + "XBSettlementAsset": { + "type": "object", + "properties": { + "amount": { + "type": "string" + }, + "assetId": { + "$ref": "#/components/schemas/XBSettlementAssetID" + } + }, + "required": [ + "amount" + ] + }, + "XBSettlementAssetID": { + "oneOf": [ + { + "$ref": "#/components/schemas/XBSettlementFiatAsset" + }, + { + "$ref": "#/components/schemas/XBSettlementCryptoAsset" + } + ] + }, + "XBSettlementFiatAsset": { + "oneOf": [ + { + "const": "USD" + }, + { + "const": "MXN" + }, + { + "const": "COP" + }, + { + "const": "EUR" + }, + { + "const": "GBP" + } + ] + }, + "XBSettlementCryptoAsset": { + "oneOf": [ + { + "const": "XLM_USDC_5F3T" + }, + { + "const": "XLM" + } + ], + "description": "- XLM_USDC_5F3T : Stellar ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏไธŠใฎ USDC" + }, + "CreatePayoutRequest": { + "type": "object", + "properties": { + "paymentAccount": { + "$ref": "#/components/schemas/PaymentAccount" + }, + "instructionSet": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PayoutInstruction" + } + } + }, + "required": [ + "paymentAccount", + "instructionSet" + ] + }, + "PaymentAccount": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/PaymentAccountType" + } + }, + "required": [ + "id", + "type" + ] + }, + "PayoutInstruction": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "payeeAccount": { + "$ref": "#/components/schemas/PayeeAccount" + }, + "amount": { + "$ref": "#/components/schemas/InstructionAmount" + } + }, + "required": [ + "amount", + "payeeAccount" + ] + }, + "PaymentAccountType": { + "oneOf": [ + { + "const": "VAULT_ACCOUNT" + }, + { + "const": "EXCHANGE_ACCOUNT" + }, + { + "const": "FIAT_ACCOUNT" + } + ] + }, + "PayeeAccount": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/PayeeAccountType" + } + }, + "required": [ + "id", + "type" + ] + }, + "InstructionAmount": { + "type": "object", + "properties": { + "amount": { + "type": "string" + }, + "assetId": { + "type": "string" + } + }, + "required": [ + "amount", + "assetId" + ] + }, + "PayeeAccountType": { + "oneOf": [ + { + "const": "VAULT_ACCOUNT" + }, + { + "const": "EXCHANGE_ACCOUNT" + }, + { + "const": "INTERNAL_WALLET" + }, + { + "const": "EXTERNAL_WALLET" + }, + { + "const": "NETWORK_CONNECTION" + }, + { + "const": "FIAT_ACCOUNT" + } + ], + "description": "- VAULT_ACCOUNT ใƒใ‚คใƒ†ใ‚ฃใƒ– Fireblocks ใƒœใƒผใƒซใƒˆ ใ‚ขใ‚ซใ‚ฆใƒณใƒˆ - EXCHANGE_ACCOUNT ใ‚ตใƒผใƒ‰ใƒ‘ใƒผใƒ†ใ‚ฃ Exchange ใ‚ขใ‚ซใ‚ฆใƒณใƒˆ - INTERNAL_WALLET ใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚น/็ต„็น”ใฎๅ†…้ƒจใจใ—ใฆใƒžใƒผใ‚ฏใ•ใ‚ŒใŸใƒ›ใƒฏใ‚คใƒˆใƒชใ‚นใƒˆ ใ‚ขใƒ‰ใƒฌใ‚น - EXTERNAL_WALLET ๅค–้ƒจใจใ—ใฆใƒžใƒผใ‚ฏใ•ใ‚ŒใŸใƒ›ใƒฏใ‚คใƒˆใƒชใ‚นใƒˆ ใ‚ขใƒ‰ใƒฌใ‚น - NETWORK_CONNECTION Fireblocks ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏใฎใƒกใƒณใƒใƒผ - FIAT_ACCOUNT ๆณ•ๅฎš้Š€่กŒใฎใ‚ตใƒผใƒ‰ใƒ‘ใƒผใƒ†ใ‚ฃ ใ‚ขใ‚ซใ‚ฆใƒณใƒˆ (็ฝฒๅใ€BCB ใชใฉ)" + }, + "PayoutResponse": { + "type": "object", + "properties": { + "payoutId": { + "type": "string" + }, + "paymentAccount": { + "$ref": "#/components/schemas/PaymentAccountResponse" + }, + "createdAt": { + "type": "number" + }, + "state": { + "$ref": "#/components/schemas/PayoutState" + }, + "status": { + "$ref": "#/components/schemas/PayoutStatus" + }, + "reasonOfFailure": { + "type": "string", + "description": "
  • ๆฎ‹้ซ˜ไธ่ถณ
  • ใ‚ฝใƒผใ‚น็ฟป่จณ
  • ใ‚ฝใƒผใ‚นใŒไธ€ๆ„ใงใฏใชใ„
  • ใ‚ฝใƒผใ‚นใŒ่ฆ‹ใคใ‹ใ‚Šใพใ›ใ‚“
  • ใ‚ฝใƒผใ‚นใ‚ฟใ‚คใƒ—ใŒใ‚ตใƒใƒผใƒˆใ•ใ‚Œใฆใ„ใพใ›ใ‚“
  • ็ฉบใฎใ‚ฝใƒผใ‚น
  • ๅฎ›ๅ…ˆ_็ฟป่จณ
  • ๅฎ›ๅ…ˆใŒไธ€ๆ„ใงใฏใชใ„
  • ๅฎ›ๅ…ˆใŒ่ฆ‹ใคใ‹ใ‚Šใพใ›ใ‚“
  • ็ฉบใฎๅฎ›ๅ…ˆ
  • ่งฃๆž
  • ๆœช็Ÿฅ
  • ใƒ•ใ‚กใ‚คใ‚ขใƒ–ใƒญใƒƒใ‚ฏใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆ
  • ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณ้€ไฟก
" + }, + "initMethod": { + "$ref": "#/components/schemas/PayoutInitMethod" + }, + "instructionSet": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PayoutInstructionResponse" + } + }, + "reportUrl": { + "type": "string" + } + }, + "required": [ + "payoutId", + "createdAt", + "state", + "status", + "paymentAccount", + "instructionSet" + ] + }, + "PaymentAccountResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/PaymentAccountType" + } + } + }, + "PayoutState": { + "oneOf": [ + { + "const": "CREATED" + }, + { + "const": "FILE_FOUND" + }, + { + "const": "REQUESTED" + }, + { + "const": "TRANSLATED" + }, + { + "const": "PROCESSING" + }, + { + "const": "SUBMITTED" + }, + { + "const": "FINALIZED" + }, + { + "const": "INSUFFICIENT_BALANCE" + }, + { + "const": "FAILED" + } + ], + "description": "- CREATED - ๆ”ฏๆ‰•ใ„ๆŒ‡็คบใ‚ปใƒƒใƒˆใจใใฎใ™ในใฆใฎ่ฉณ็ดฐใŒไฝœๆˆใ•ใ‚Œใพใ—ใŸ - FILE_FOUND - FTP ใงๆ–ฐใ—ใ„ใƒ•ใ‚กใ‚คใƒซใŒ่ฆ‹ใคใ‹ใ‚Šใพใ—ใŸ - REQUESTED - ๆ”ฏๆ‰•ใ„ใŒใใฎใ™ในใฆใฎ่ฉณ็ดฐใจใจใ‚‚ใซ่ฆๆฑ‚ใ•ใ‚Œใพใ—ใŸ - TRANSLATED - ๆ”ฏๆ‰•ใ„ๆŒ‡็คบใ‚ขใ‚ซใ‚ฆใƒณใƒˆ ID ใŒ่ญ˜ๅˆฅใ•ใ‚Œใ€็ฟป่จณใ•ใ‚Œใพใ—ใŸ - PROCESSING - ๆ”ฏๆ‰•ใ„ๆŒ‡็คบใ‚ปใƒƒใƒˆใŒๅฎŸ่กŒใ•ใ‚Œใ€ๅ‡ฆ็†ไธญใงใ™ - SUBMITTED - ๆ”ฏๆ‰•ใ„ๆŒ‡็คบใฎใŸใ‚ใซ้€ไฟกใ•ใ‚ŒใŸใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณ - FINALIZED - ๆ”ฏๆ‰•ใ„ๅ‡ฆ็†ใŒ็ต‚ไบ†ใ—ใ€ใ™ในใฆใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใŒๆญฃๅธธใซๅ‡ฆ็†ใ•ใ‚Œใพใ—ใŸ - INSUFFICIENT_BALANCE - ๆ”ฏๆ‰•ใ„ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎๆฎ‹้ซ˜ใŒไธ่ถณใ—ใฆใ„ใพใ™ (ไธ€ๆ™‚็š„ใช็Šถๆ…‹ใฎๅ ดๅˆใŒใ‚ใ‚Šใพใ™) - FAILED - 1 ใคไปฅไธŠใฎๆ”ฏๆ‰•ใ„ๆŒ‡็คบใŒๅคฑๆ•—ใ—ใพใ—ใŸ" + }, + "PayoutStatus": { + "oneOf": [ + { + "const": "REGISTERED" + }, + { + "const": "VERIFYING" + }, + { + "const": "IN_PROGRESS" + }, + { + "const": "DONE" + }, + { + "const": "INSUFFICIENT_BALANCE" + }, + { + "const": "FAILED" + } + ], + "description": "- REQUESTED ๆ”ฏๆ‰•ใ„ใŒใ™ในใฆใฎ่ฉณ็ดฐใจใจใ‚‚ใซใƒชใ‚ฏใ‚จใ‚นใƒˆใ•ใ‚Œใพใ—ใŸ - VERIFIED ๆ”ฏๆ‰•ใ„ๆŒ‡็คบใ‚ปใƒƒใƒˆใฎ่ฉณ็ดฐใŒๆคœ่จผใ•ใ‚Œใพใ—ใŸ - PROCESSING ๆ”ฏๆ‰•ใ„ๆŒ‡็คบใ‚ปใƒƒใƒˆใŒๅฎŸ่กŒใ•ใ‚Œใ€ๅ‡ฆ็†ไธญใงใ™ - FINALIZED ๆ”ฏๆ‰•ใ„ใŒๅฎŒไบ†ใ—ใพใ—ใŸ๏ผˆใ™ในใฆใฎๆ”ฏๆ‰•ใ„ๆŒ‡็คบใŒๆญฃๅธธใซๅฎŒไบ†ใ—ใพใ—ใŸ๏ผ‰ - INSUFFICIENT_BALANCE ๆ”ฏๆ‰•ใ„ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎๆฎ‹้ซ˜ใŒไธ่ถณใ—ใฆใ„ใพใ™๏ผˆไธ€ๆ™‚็š„ใช็Šถๆ…‹ใฎๅ ดๅˆใŒใ‚ใ‚Šใพใ™๏ผ‰ - FAILED 1 ใคไปฅไธŠใฎๆ”ฏๆ‰•ใ„ๆŒ‡็คบใŒๅคฑๆ•—ใ—ใพใ—ใŸ" + }, + "PayoutInitMethod": { + "oneOf": [ + { + "const": "FILE" + }, + { + "const": "API" + } + ] + }, + "PayoutInstructionResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "payeeAccount": { + "$ref": "#/components/schemas/PayeeAccountResponse" + }, + "amount": { + "$ref": "#/components/schemas/InstructionAmount" + }, + "state": { + "$ref": "#/components/schemas/PayoutInstructionState" + }, + "transactions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Transaction" + } + } + }, + "required": [ + "amount", + "payeeAccount", + "state", + "transactions" + ] + }, + "PayeeAccountResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/PayeeAccountType" + } + } + }, + "PayoutInstructionState": { + "oneOf": [ + { + "const": "NOT_STARTED" + }, + { + "const": "TRANSACTION_SENT" + }, + { + "const": "COMPLETED" + }, + { + "const": "FAILED" + }, + { + "const": "TRANSLATION_ERROR" + }, + { + "const": "SKIPPED" + } + ], + "description": "- NOT_STARTED - ้–‹ๅง‹ใ‚’ๅพ…ๆฉŸไธญ - TRANSACTION_SENT - ๅŸบ็คŽใจใชใ‚‹ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใŒ้€ไฟกใ•ใ‚Œใพใ—ใŸ - COMPLETED - ๆญฃๅธธใซๅฎŒไบ†ใ—ใพใ—ใŸ - FAILED - ๅคฑๆ•—ใ—ใพใ—ใŸ - TRANSLATION_ERROR - ๅฎ›ๅ…ˆใฎๆคœ็ดขใซๅคฑๆ•—ใ—ใพใ—ใŸ๏ผˆๅŸบ็คŽใจใชใ‚‹ใƒ›ใƒฏใ‚คใƒˆใƒชใ‚นใƒˆใฎๅค–้ƒจใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎๅค‰ๆ›ดใชใฉใซใ‚ˆใ‚Š๏ผ‰ - SKIPPED - ใ“ใฎๆŒ‡็คบใซๅฏพใ—ใฆใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏไฝœๆˆใ•ใ‚Œใฆใ„ใพใ›ใ‚“" + }, + "Transaction": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "state": { + "oneOf": [ + { + "const": "SUBMITTED" + }, + { + "const": "QUEUED" + }, + { + "const": "PENDING_AUTHORIZATION" + }, + { + "const": "PENDING_SIGNATURE" + }, + { + "const": "BROADCASTING" + }, + { + "const": "PENDING_3RD_PARTY_MANUAL_APPROVAL" + }, + { + "const": "PENDING_3RD_PARTY" + }, + { + "const": "PENDING" + }, + { + "const": "CONFIRMING" + }, + { + "const": "CONFIRMED" + }, + { + "const": "COMPLETED" + }, + { + "const": "PARTIALLY_COMPLETED" + }, + { + "const": "PENDING_AML_SCREENING" + }, + { + "const": "CANCELLING" + }, + { + "const": "CANCELLED" + }, + { + "const": "REJECTED" + }, + { + "const": "BLOCKED" + }, + { + "const": "FAILED" + }, + { + "const": "TIMEOUT" + } + ] + }, + "timestamp": { + "type": "number", + "format": "date-time" + }, + "instructionId": { + "type": "string" + } + }, + "required": [ + "id", + "state" + ] + }, + "DispatchPayoutResponse": { + "type": "object", + "properties": { + "payoutId": { + "type": "string" + } + }, + "required": [ + "payoutId" + ] + }, + "TravelRuleAddress": { + "type": "object", + "properties": { + "street": { + "type": "string", + "example": "1234 Example St", + "description": "ไฝๆ‰€" + }, + "city": { + "type": "string", + "example": "New York", + "description": "ๅธ‚" + }, + "state": { + "type": "string", + "example": "NY", + "description": "ๅทžใพใŸใฏ็œŒ" + }, + "postalCode": { + "type": "string", + "example": "10001", + "description": "้ƒตไพฟ็•ชๅท" + } + }, + "required": [ + "street", + "city", + "state", + "postalCode" + ] + }, + "TravelRuleValidateTransactionRequest": { + "type": "object", + "properties": { + "transactionAsset": { + "type": "string", + "example": "BTC", + "description": "ๅ–ๅผ•่ณ‡็”ฃใ‚ทใƒณใƒœใƒซ BTCใ€ETH)" + }, + "destination": { + "type": "string", + "example": "bc1qxy2kgdygjrsqtzq2n0yrf1234p83kkfjhx0wlh", + "description": "ๅ–ๅผ•ๅ…ˆใ‚ขใƒ‰ใƒฌใ‚น" + }, + "transactionAmount": { + "type": "string", + "example": "10", + "description": "ๅ–ๅผ•่ณ‡็”ฃใฎๅ–ๅผ•้‡‘้ก" + }, + "originatorVASPdid": { + "type": "string", + "example": "did:ethr:0x44957e75d6ce4a5bf37aae117da86422c848f7c2", + "description": "ใ“ใ‚ŒใฏVASPใซๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚ŒใŸ่ญ˜ๅˆฅๅญใงใ™" + }, + "originatorEqualsBeneficiary": { + "type": "boolean", + "example": false, + "description": "้€้‡‘่€…ใจๅ—ๅ–ไบบใŒๅŒไธ€ไบบ็‰ฉใงใ€ๆƒ…ๅ ฑใ‚’ๅŽ้›†ใ™ใ‚‹ๅฟ…่ฆใŒใชใ„ๅ ดๅˆใฏใ€Œใฏใ„ใ€ใ€‚็ฌฌไธ‰่€…้€้‡‘ใฎๅ ดๅˆใฏใ€Œใ„ใ„ใˆใ€ใ€‚." + }, + "travelRuleBehavior": { + "type": "boolean", + "example": true, + "description": "ใ“ใ‚Œใซใ‚ˆใ‚Šใ€ๅ–ๅผ•ใŒๅ—็›Š่€…VASPใฎ็ฎก่ฝ„ๅŒบๅŸŸใซใŠใ‘ใ‚‹TRAVEL_RULEใงใ‚ใ‚‹ใ‹ใฉใ†ใ‹ใ‚‚็ขบ่ชใ•ใ‚Œใพใ™ใ€‚" + }, + "beneficiaryVASPdid": { + "type": "string", + "example": "did:ethr:0x46a7ed5813ce735387df2bfb245bd7722e0de992", + "description": "ใ“ใ‚Œใฏ่ณ‡้‡‘ใŒ้€ใ‚‰ใ‚Œใ‚‹VASPใซๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚ŒใŸ่ญ˜ๅˆฅๅญใงใ™" + }, + "beneficiaryVASPname": { + "type": "string", + "example": "HelloCrypto", + "description": "ๅ—็›Š่€…VASPๅ" + }, + "beneficiaryName": { + "type": "string", + "example": "John Doe", + "description": "ๅ—ๅ–ไบบๅ" + }, + "beneficiaryAccountNumber": { + "type": "string", + "example": "1234-1234-1234-12234", + "description": "ๅ—ๅ–ไบบๅ" + }, + "beneficiaryAddress": { + "example": "{\"addressLine: [Wayne Manor, Gotham City, New York, USA]\"}", + "description": "ๅ—ๅ–ไบบๅ", + "type": "object", + "properties": { + "street": { + "type": "string", + "example": "1234 Example St", + "description": "ไฝๆ‰€" + }, + "city": { + "type": "string", + "example": "New York", + "description": "ๅธ‚" + }, + "state": { + "type": "string", + "example": "NY", + "description": "ๅทžใพใŸใฏ็œŒ" + }, + "postalCode": { + "type": "string", + "example": "10001", + "description": "้ƒตไพฟ็•ชๅท" + } + } + } + }, + "required": [ + "transactionAsset", + "destination", + "transactionAmount", + "originatorVASPdid", + "originatorEqualsBeneficiary", + "travelRuleBehavior", + "beneficiaryVASPdid", + "beneficiaryVASPname", + "beneficiaryName", + "beneficiaryAccountNumber", + "beneficiaryAddress" + ] + }, + "TravelRuleValidateTransactionResponse": { + "type": "object", + "properties": { + "isValid": { + "type": "boolean", + "description": "ใ€ŒisValidใ€ใฏใ€ๆ—…่กŒใƒซใƒผใƒซใƒ‡ใƒผใ‚ฟ่ปข้€ใซๅฟ…่ฆใชใ™ในใฆใฎๆƒ…ๅ ฑใ‚’ๅŽ้›†ใ—ใŸใ‹ใฉใ†ใ‹ใ‚’็คบใ—ใพใ™ใ€‚ใ“ใฎใƒ•ใ‚ฃใƒผใƒซใƒ‰ใŒใ€Œtrueใ€ใซใชใ‚‹ใจใ€ใƒ•ใƒญใƒณใƒˆใ‚จใƒณใƒ‰ๆƒ…ๅ ฑใ‚’ใƒใƒƒใ‚ฏใ‚จใƒณใƒ‰ใซ่ปข้€ใ—ใ€ๆ—…่กŒใƒซใƒผใƒซใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎไฝœๆˆใ‚’ๅฎŸ่กŒใ™ใ‚‹ๆฌกใฎใ‚นใƒ†ใƒƒใƒ—ใซ้€ฒใ‚€ใ“ใจใŒใงใใพใ™ใ€‚", + "example": true + }, + "type": { + "type": "string", + "description": "ใ€Œtypeใ€ใฏใ€ๅ‡บ้‡‘ใƒชใ‚ฏใ‚จใ‚นใƒˆใฎไปฎๆƒณ่ณ‡็”ฃไพกๅ€คใ‚’ๆณ•ๅฎš้€š่ฒจไพกๅ€คใซๅค‰ๆ›ใ—ใŸๅ€คใŒใ€็ฎก่ฝ„ๅŒบๅŸŸใฎใ—ใใ„ๅ€คใ‚’่ถ…ใˆใฆใ„ใ‚‹๏ผˆ=TRAVELRULE๏ผ‰ใ‹ใ€ไธ‹ๅ›žใฃใฆใ„ใ‚‹๏ผˆ=BELOW_THRESHOLD๏ผ‰ใ‹ใ‚’็คบใ—ใพใ™ใ€‚ใƒˆใƒฉใƒ™ใƒซใƒซใƒผใƒซๆƒ…ๅ ฑใ‚’้€ไฟกใ™ใ‚‹ๅฟ…่ฆใŒใชใใ€ๅŽ้›†ใฎใฟใŒๅฟ…่ฆใช้žใƒ›ใ‚นใƒˆๅž‹ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฎๅ ดๅˆใฏใ€NON_CUSTODIALใจ่กจ็คบใ•ใ‚Œใพใ™ใ€‚.", + "example": "TRAVELRULE" + }, + "beneficiaryAddressType": { + "type": "string", + "description": "ใ€ŒbeneficiaryAddressTypeใ€ใฏใ€ใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณๅˆ†ๆžใƒ—ใƒญใƒใ‚คใƒ€ใƒผใพใŸใฏๅ†…้ƒจใ‚ขใƒ‰ใƒฌใ‚นๅธณใŒใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚ขใƒ‰ใƒฌใ‚นใ‚’่ญ˜ๅˆฅใงใใŸใ‹ใฉใ†ใ‹ใ‚’็คบใ—ใพใ™ใ€‚.", + "example": "UNKNOWN" + }, + "addressSource": { + "type": "string", + "description": "ใ€ŒaddressSourceใ€ใฏใ€ใ‚ขใƒ‰ใƒฌใ‚นใŒๅ†…้ƒจใ‚ขใƒ‰ใƒฌใ‚นๅธณใง่ฆ‹ใคใ‹ใฃใŸใ‹ใ€ใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณๅˆ†ๆžใƒ—ใƒญใƒใ‚คใƒ€ใƒผใซใ‚ˆใฃใฆ่ญ˜ๅˆฅใ•ใ‚ŒใŸใ‹ใ‚’็คบใ—ใพใ™ใ€‚.", + "example": "UNKNOWN" + }, + "beneficiaryVASPdid": { + "type": "string", + "description": "ๅ—็›Š่€…VASPใฎVASP DID", + "example": "did:ethr:0x46a7ed5813ce735387df2bfb245bd7722e0de992" + }, + "beneficiaryVASPname": { + "type": "string", + "description": "ใ€ŒbeneficiaryVASPnameใ€ใฏใ€ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‚ขใƒ‰ใƒฌใ‚นใฎๆ‰€ๆœ‰่€…ใจใ—ใฆ่ญ˜ๅˆฅใ•ใ‚ŒใŸVASPใฎๅๅ‰ใ‚’็คบใ—ใพใ™ใ€‚ใ“ใฎๅๅ‰ใฏใ€ใใฎๅพŒใฎๅ‘ผใณๅ‡บใ—ใงDIDใ‚’ๅ–ๅพ—ใ™ใ‚‹ใŸใ‚ใซไฝฟ็”จใ•ใ‚Œใพใ™ใ€‚.", + "example": "Fireblocks" + }, + "warnings": { + "description": "ใ€Œใ‚จใƒฉใƒผ/่ญฆๅ‘Šใ€ใฏใ€้€ไฟก่€…ใ‹ใ‚‰ๅ—ๅ–ไบบใซ้–ขใ™ใ‚‹ใฉใฎใ‚ˆใ†ใชๆƒ…ๅ ฑใ‚’ๅŽ้›†ใ™ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚‹ใ‹ใ‚’็คบใ—ใพใ™ใ€‚.", + "example": [ + "optional-beneficiaryAccountNumber" + ], + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "isValid", + "type", + "beneficiaryAddressType", + "addressSource", + "beneficiaryVASPdid", + "beneficiaryVASPname", + "warnings" + ] + }, + "TravelRuleTransactionBlockchainInfo": { + "type": "object", + "properties": { + "txHash": { + "type": "string" + }, + "origin": { + "type": "string" + }, + "destination": { + "type": "string" + } + }, + "required": [ + "txHash", + "origin", + "destination" + ] + }, + "TravelRulePiiIVMS": { + "type": "object", + "properties": { + "fullName": { + "type": "string" + }, + "dateOfBirth": { + "type": "string" + }, + "placeOfBirth": { + "type": "string" + }, + "address": { + "type": "string" + }, + "identificationNumber": { + "type": "string" + }, + "nationality": { + "type": "string" + }, + "countryOfResidence": { + "type": "string" + }, + "taxIdentificationNumber": { + "type": "string" + }, + "customerNumber": { + "type": "string" + } + }, + "required": [ + "fullName", + "dateOfBirth", + "placeOfBirth", + "address", + "identificationNumber", + "nationality", + "countryOfResidence", + "taxIdentificationNumber", + "customerNumber" + ] + }, + "TravelRuleOwnershipProof": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "passport", + "description": "ๆ‰€ๆœ‰ๆจฉ่จผๆ˜Žใฎ็จฎ้กž" + }, + "id": { + "type": "string", + "example": "123456789", + "description": "่ญ˜ๅˆฅ็•ชๅท" + }, + "name": { + "type": "string", + "example": "Alice", + "description": "ๆ‰€ๆœ‰่€…ๅ" + }, + "country": { + "type": "string", + "example": "US", + "description": "็™บ่กŒๅ›ฝ" + }, + "issueDate": { + "type": "string", + "example": "2022-01-01", + "description": "็™บ่กŒๆ—ฅ" + }, + "issuer": { + "type": "string", + "example": "US Government", + "description": "็™บ่กŒๆฉŸ้–ขๅ" + } + }, + "required": [ + "type", + "id", + "name", + "country", + "issueDate", + "issuer" + ] + }, + "TravelRuleValidateFullTransactionRequest": { + "type": "object", + "properties": { + "transactionAsset": { + "type": "string", + "description": "ๅ–ๅผ•ใซ้–ขไฟ‚ใ™ใ‚‹่ณ‡็”ฃ" + }, + "transactionAmount": { + "type": "string", + "description": "ๅ–ๅผ•้‡‘้ก" + }, + "originatorDid": { + "type": "string", + "description": "ๅ–ๅผ•็™บไฟก่€…ใฎDID" + }, + "beneficiaryDid": { + "type": "string", + "description": "ๅ–ๅผ•ๅ—็›Š่€…ใฎDID" + }, + "originatorVASPdid": { + "type": "string", + "description": "ๅ–ๅผ•็™บไฟก่€…ใฎVASP ID" + }, + "beneficiaryVASPdid": { + "type": "string", + "description": "ๅ–ๅผ•ๅ—็›Š่€…ใฎVASP ID" + }, + "beneficiaryVASPname": { + "type": "string", + "description": "ๅ—็›Š่€…ใจใชใ‚‹VASPใฎๅๅ‰" + }, + "transactionBlockchainInfo": { + "description": "ใƒ–ใƒญใƒƒใ‚ฏใƒใ‚งใƒผใƒณๅ–ๅผ•ใซ้–ขใ™ใ‚‹ๆƒ…ๅ ฑ", + "type": "object", + "properties": { + "txHash": { + "type": "string" + }, + "origin": { + "type": "string" + }, + "destination": { + "type": "string" + } + } + }, + "originator": { + "description": "ๅ–ๅผ•ใฎ็™บไฟก่€…ใซ้–ขใ™ใ‚‹ๆƒ…ๅ ฑ", + "type": "object", + "properties": { + "fullName": { + "type": "string" + }, + "dateOfBirth": { + "type": "string" + }, + "placeOfBirth": { + "type": "string" + }, + "address": { + "type": "string" + }, + "identificationNumber": { + "type": "string" + }, + "nationality": { + "type": "string" + }, + "countryOfResidence": { + "type": "string" + }, + "taxIdentificationNumber": { + "type": "string" + }, + "customerNumber": { + "type": "string" + } + } + }, + "beneficiary": { + "description": "ๅ–ๅผ•ใฎๅ—็›Š่€…ใซ้–ขใ™ใ‚‹ๆƒ…ๅ ฑ", + "type": "object", + "properties": { + "fullName": { + "type": "string" + }, + "dateOfBirth": { + "type": "string" + }, + "placeOfBirth": { + "type": "string" + }, + "address": { + "type": "string" + }, + "identificationNumber": { + "type": "string" + }, + "nationality": { + "type": "string" + }, + "countryOfResidence": { + "type": "string" + }, + "taxIdentificationNumber": { + "type": "string" + }, + "customerNumber": { + "type": "string" + } + } + }, + "encrypted": { + "type": "string", + "description": "ๅ–ๅผ•ใซ้–ข้€ฃใ™ใ‚‹ๆš—ๅทๅŒ–ใ•ใ‚ŒใŸใƒ‡ใƒผใ‚ฟ" + }, + "protocol": { + "type": "string", + "description": "ใƒˆใƒฉใƒ™ใƒซใƒซใƒผใƒซใ‚’ๅฎŸ่กŒใ™ใ‚‹ใŸใ‚ใซไฝฟ็”จใ•ใ‚Œใ‚‹ใƒ—ใƒญใƒˆใ‚ณใƒซ" + }, + "notificationEmail": { + "type": "string", + "description": "ๆ—…่กŒใƒซใƒผใƒซใฎๅฎŒไบ†ๆ™‚ใซ้€š็Ÿฅใ‚’้€ไฟกใ™ใ‚‹ใƒกใƒผใƒซใ‚ขใƒ‰ใƒฌใ‚น" + }, + "skipBeneficiaryDataValidation": { + "type": "boolean", + "description": "ๅ—็›Š่€…ใƒ‡ใƒผใ‚ฟใฎๆคœ่จผใ‚’ใ‚นใ‚ญใƒƒใƒ—ใ™ใ‚‹ใ‹ใฉใ†ใ‹" + }, + "travelRuleBehavior": { + "type": "boolean", + "description": "ๅ–ๅผ•ใŒๅ—็›Š่€…VASPใฎ็ฎก่ฝ„ๅŒบๅŸŸๅ†…ใฎTRAVEL_RULEใงใ‚ใ‚‹ใ‹ใฉใ†ใ‹ใ‚’็ขบ่ชใ™ใ‚‹ใ‹ใฉใ†ใ‹" + }, + "originatorProof": { + "description": "ๅ–ๅผ•ใฎ็™บไฟก่€…ใซ้–ข้€ฃใ™ใ‚‹ๆ‰€ๆœ‰ๆจฉ่จผๆ˜Ž", + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "passport", + "description": "ๆ‰€ๆœ‰ๆจฉ่จผๆ˜Žใฎ็จฎ้กž" + }, + "id": { + "type": "string", + "example": "123456789", + "description": "่ญ˜ๅˆฅ็•ชๅท" + }, + "name": { + "type": "string", + "example": "Alice", + "description": "ๆ‰€ๆœ‰่€…ๅ" + }, + "country": { + "type": "string", + "example": "US", + "description": "็™บ่กŒๅ›ฝ" + }, + "issueDate": { + "type": "string", + "example": "2022-01-01", + "description": "็™บ่กŒๆ—ฅ" + }, + "issuer": { + "type": "string", + "example": "US Government", + "description": "็™บ่กŒๆฉŸ้–ขๅ" + } + } + }, + "beneficiaryProof": { + "description": "ๅ–ๅผ•ใฎๅ—็›Š่€…ใซ้–ขใ™ใ‚‹ๆ‰€ๆœ‰ๆจฉ่จผๆ˜Ž", + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "passport", + "description": "ๆ‰€ๆœ‰ๆจฉ่จผๆ˜Žใฎ็จฎ้กž" + }, + "id": { + "type": "string", + "example": "123456789", + "description": "่ญ˜ๅˆฅ็•ชๅท" + }, + "name": { + "type": "string", + "example": "Alice", + "description": "ๆ‰€ๆœ‰่€…ๅ" + }, + "country": { + "type": "string", + "example": "US", + "description": "็™บ่กŒๅ›ฝ" + }, + "issueDate": { + "type": "string", + "example": "2022-01-01", + "description": "็™บ่กŒๆ—ฅ" + }, + "issuer": { + "type": "string", + "example": "US Government", + "description": "็™บ่กŒๆฉŸ้–ขๅ" + } + } + }, + "pii": { + "description": "ๅ–ๅผ•ใซ้–ข้€ฃใ™ใ‚‹ๅ€‹ไบบ่ญ˜ๅˆฅๆƒ…ๅ ฑ", + "type": "object", + "properties": { + "fullName": { + "type": "string" + }, + "dateOfBirth": { + "type": "string" + }, + "placeOfBirth": { + "type": "string" + }, + "address": { + "type": "string" + }, + "identificationNumber": { + "type": "string" + }, + "nationality": { + "type": "string" + }, + "countryOfResidence": { + "type": "string" + }, + "taxIdentificationNumber": { + "type": "string" + }, + "customerNumber": { + "type": "string" + } + } + } + }, + "required": [ + "transactionAsset", + "transactionAmount", + "originatorDid", + "beneficiaryDid", + "originatorVASPdid", + "beneficiaryVASPdid", + "beneficiaryVASPname", + "transactionBlockchainInfo", + "originator", + "beneficiary", + "encrypted", + "protocol", + "notificationEmail", + "skipBeneficiaryDataValidation", + "travelRuleBehavior", + "originatorProof", + "beneficiaryProof", + "pii" + ] + }, + "TravelRuleIssuer": { + "type": "object", + "properties": { + "issuerDid": { + "type": "string" + } + }, + "required": [ + "issuerDid" + ] + }, + "TravelRuleIssuers": { + "type": "object", + "properties": { + "yearFounded": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "isRegulated": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "regulatoryAuthorities": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "name": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "logo": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "website": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "legalName": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "legalStructure": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "incorporationCountry": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "businessNumber": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "addressLine1": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "city": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "country": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "description": { + "$ref": "#/components/schemas/TravelRuleIssuer" + } + }, + "required": [ + "yearFounded", + "isRegulated", + "regulatoryAuthorities", + "name", + "logo", + "website", + "legalName", + "legalStructure", + "incorporationCountry", + "businessNumber", + "addressLine1", + "city", + "country", + "description" + ] + }, + "TravelRuleVASP": { + "type": "object", + "properties": { + "did": { + "type": "string" + }, + "name": { + "type": "string" + }, + "verificationStatus": { + "type": "string" + }, + "addressLine1": { + "type": "string" + }, + "addressLine2": { + "type": "string" + }, + "city": { + "type": "string" + }, + "country": { + "type": "string" + }, + "emailDomains": { + "type": "string" + }, + "website": { + "type": "string" + }, + "logo": { + "type": "string" + }, + "legalStructure": { + "type": "string" + }, + "legalName": { + "type": "string" + }, + "yearFounded": { + "type": "string" + }, + "incorporationCountry": { + "type": "string" + }, + "isRegulated": { + "type": "string" + }, + "otherNames": { + "type": "string" + }, + "identificationType": { + "type": "string" + }, + "identificationCountry": { + "type": "string" + }, + "businessNumber": { + "type": "string" + }, + "regulatoryAuthorities": { + "type": "string" + }, + "jurisdictions": { + "type": "string" + }, + "street": { + "type": "string" + }, + "number": { + "type": "string" + }, + "unit": { + "type": "string" + }, + "postCode": { + "type": "string" + }, + "state": { + "type": "string" + }, + "certificates": { + "type": "string" + }, + "description": { + "type": "string" + }, + "travelRule_OPENVASP": { + "type": "string" + }, + "travelRule_SYGNA": { + "type": "string" + }, + "travelRule_TRISA": { + "type": "string" + }, + "travelRule_TRLIGHT": { + "type": "string" + }, + "travelRule_EMAIL": { + "type": "string" + }, + "travelRule_TRP": { + "type": "string" + }, + "travelRule_SHYFT": { + "type": "string" + }, + "travelRule_USTRAVELRULEWG": { + "type": "string" + }, + "createdAt": { + "type": "string" + }, + "createdBy": { + "type": "string" + }, + "updatedAt": { + "type": "string" + }, + "updatedBy": { + "type": "string" + }, + "lastSentDate": { + "type": "string" + }, + "lastReceivedDate": { + "type": "string" + }, + "documents": { + "type": "string" + }, + "hasAdmin": { + "type": "boolean" + }, + "isNotifiable": { + "type": "boolean" + }, + "issuers": { + "$ref": "#/components/schemas/TravelRuleIssuers" + } + }, + "required": [ + "did", + "name", + "verificationStatus", + "addressLine1", + "addressLine2", + "city", + "country", + "emailDomains", + "website", + "logo", + "legalStructure", + "legalName", + "yearFounded", + "incorporationCountry", + "isRegulated", + "otherNames", + "identificationType", + "identificationCountry", + "businessNumber", + "regulatoryAuthorities", + "jurisdictions", + "street", + "number", + "unit", + "postCode", + "state", + "certificates", + "description", + "travelRule_OPENVASP", + "travelRule_SYGNA", + "travelRule_TRISA", + "travelRule_TRLIGHT", + "travelRule_EMAIL", + "travelRule_TRP", + "travelRule_SHYFT", + "travelRule_USTRAVELRULEWG", + "createdAt", + "createdBy", + "updatedAt", + "updatedBy", + "lastSentDate", + "lastReceivedDate", + "documents", + "hasAdmin", + "isNotifiable", + "issuers" + ] + }, + "TravelRuleGetAllVASPsResponse": { + "type": "object", + "properties": { + "vasps": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TravelRuleVASP" + } + } + }, + "required": [ + "vasps" + ] + }, + "TravelRuleUpdateVASPDetails": { + "type": "object", + "properties": { + "did": { + "type": "string", + "example": "did:ethr:0x44957e75d6ce4a5bf37aae117da86422c848f7c2", + "description": "VASPใฎๅˆ†ๆ•ฃ่ญ˜ๅˆฅๅญ" + }, + "pii_didkey": { + "type": "string", + "example": "did:key:z6Mks5CZRaiooKYhq5TwtXQC1gWhwiZnmiKfFrMnYY62MhYf", + "description": "VASPใฎPII DIDใ‚ญใƒผ" + } + }, + "required": [ + "did", + "pii_didkey" + ] + }, + "PolicySrcOrDestType": { + "oneOf": [ + { + "const": "EXCHANGE" + }, + { + "const": "UNMANAGED" + }, + { + "const": "VAULT" + }, + { + "const": "NETWORK_CONNECTION" + }, + { + "const": "COMPOUND" + }, + { + "const": "FIAT_ACCOUNT" + }, + { + "const": "ONE_TIME_ADDRESS" + }, + { + "const": "*" + } + ], + "description": "* EXCHANGE - ใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚นใซๆŽฅ็ถšใ•ใ‚ŒใŸใ‚ตใƒผใƒ‰ใƒ‘ใƒผใƒ†ใ‚ฃใฎๅ–ๅผ•ๆ‰€ใ‚ขใ‚ซใ‚ฆใƒณใƒˆ * UNMANAGED - Fireblocks ใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚นๅค–ใฎ็ฎก็†ใ•ใ‚Œใฆใ„ใชใ„ใ‚ฆใ‚ฉใƒฌใƒƒใƒˆ * VAULT - Fireblocks Vault ๅ†…ใฎใ‚ขใ‚ซใ‚ฆใƒณใƒˆ * NETWORK_CONNECTION - Fireblocks ใƒใƒƒใƒˆใƒฏใƒผใ‚ฏๅ†…ใฎๆŽฅ็ถš * COMPOUND - (้žๆŽจๅฅจ) Compound DeFI ใƒ—ใƒญใƒˆใ‚ณใƒซใ‚’ไฝฟ็”จใ—ใฆๅ–ๅพ—ใ•ใ‚ŒใŸ่ณ‡็”ฃ * FIAT_ACCOUNT - ใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚นใซๆŽฅ็ถšใ•ใ‚ŒใŸใ‚ตใƒผใƒ‰ใƒ‘ใƒผใƒ†ใ‚ฃใฎๆณ•ๅฎš้€š่ฒจใ‚ขใ‚ซใ‚ฆใƒณใƒˆ * ONE_TIME_ADDRESS - Fireblocks ใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚นใ‹ใ‚‰ใฎใƒ›ใƒฏใ‚คใƒˆใƒชใ‚นใƒˆใซ็™ป้Œฒใ•ใ‚Œใฆใ„ใชใ„่ณ‡็”ฃ * "*" - ใ™ในใฆใฎใ‚ฟใ‚คใƒ—" + }, + "PolicySrcOrDestSubType": { + "oneOf": [ + { + "const": "EXTERNAL" + }, + { + "const": "INTERNAL" + }, + { + "const": "CONTRACT" + }, + { + "const": "EXCHANGETEST" + }, + { + "const": "*" + } + ], + "description": "* EXTERNAL - ๅค–้ƒจใจใ—ใฆๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚ŒใŸใƒ›ใƒฏใ‚คใƒˆใƒชใ‚นใƒˆใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฏใ€้€šๅธธใ€ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚„ๅ–ๅผ•็›ธๆ‰‹ใŒ็ฎก็†ใ™ใ‚‹ใ‚ขใƒ‰ใƒฌใ‚นใซไฝฟ็”จใ•ใ‚Œใพใ™ใ€‚ * INTERNAL - ๅ†…้ƒจใจใ—ใฆๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚ŒใŸใƒ›ใƒฏใ‚คใƒˆใƒชใ‚นใƒˆใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฏใ€้€šๅธธใ€Fireblocksใƒฏใƒผใ‚ฏใ‚นใƒšใƒผใ‚นใฎๅค–้ƒจใง็ฎก็†ใ™ใ‚‹ใ‚ขใƒ‰ใƒฌใ‚นใซไฝฟ็”จใ•ใ‚Œใพใ™ใ€‚ * CONTRACT - ใ‚ณใƒณใƒˆใƒฉใ‚ฏใƒˆใจใ—ใฆๅ‰ฒใ‚Šๅฝ“ใฆใ‚‰ใ‚ŒใŸใƒ›ใƒฏใ‚คใƒˆใƒชใ‚นใƒˆใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใฏใ€ๅค–้ƒจใ‚นใƒžใƒผใƒˆใ‚ณใƒณใƒˆใƒฉใ‚ฏใƒˆใ‚’่ญ˜ๅˆฅใŠใ‚ˆใณ็ฎก็†ใ™ใ‚‹ใŸใ‚ใฎใ‚‚ใฎใงใ™ใ€‚ * EXCHANGETEST - ใƒ†ใ‚นใƒˆใƒใƒƒใƒˆ่ณ‡็”ฃใฎใฟใงๅ‹•ไฝœใ™ใ‚‹ๅ–ๅผ•ๆ‰€ใ€‚ * "*" - ใ™ในใฆใฎใ‚ตใƒ–ใ‚ฟใ‚คใƒ—" + }, + "PolicySrcOrDestId": { + "type": "string", + "description": "ใ‚ขใ‚ซใ‚ฆใƒณใƒˆIDใ‚’ๅฎš็พฉใ—ใพใ™ใ€‚ใ‚ชใƒ—ใ‚ทใƒงใƒณใฏ* "*" - ใ™ในใฆใฎใ‚ขใ‚ซใ‚ฆใƒณใƒˆ * ็‰นๅฎšใฎใ‚ขใ‚ซใ‚ฆใƒณใƒˆID" + }, + "AmountAggregationTimePeriodMethod": { + "oneOf": [ + { + "const": "PER_SINGLE_MATCH" + }, + { + "const": "ACROSS_ALL_MATCHES" + } + ], + "description": "* PER_SINGLE_MATCH - ใƒชใ‚นใƒˆใ•ใ‚ŒใŸๅ„ใ‚จใƒณใƒ†ใ‚ฃใƒ†ใ‚ฃใซๅˆถ้™ใ‚’้ฉ็”จใ—ใพใ™ * ACROSS_ALL_MATCHES - ใƒชใ‚นใƒˆใ•ใ‚ŒใŸใ™ในใฆใฎใ‚จใƒณใƒ†ใ‚ฃใƒ†ใ‚ฃใฎๅˆ่จˆใซๅˆถ้™ใ‚’้ฉ็”จใ—ใพใ™" + }, + "PolicyRule": { + "type": "object", + "description": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใซ้ฉ็”จใ•ใ‚Œใ‚‹ใƒใƒชใ‚ทใƒผใƒซใƒผใƒซ", + "properties": { + "operator": { + "type": "string", + "description": "(้žๆŽจๅฅจ - ใ€Œๆผ”็ฎ—ๅญใ€ใซ็ฝฎใๆ›ใˆใ‚‰ใ‚Œใพใ—ใŸ) | ใƒซใƒผใƒซใŒ้ฉ็”จใ•ใ‚Œใ‚‹ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎ็จฎ้กžใ‚’้–‹ๅง‹ใงใใ‚‹ใƒฆใƒผใ‚ถใƒผใ‚’ๅฎš็พฉใ—ใพใ™ใ€‚ใ‚ชใƒ—ใ‚ทใƒงใƒณใฏๆฌกใฎใจใŠใ‚Šใงใ™ * ใ€Œ*ใ€ - ใ™ในใฆใฎใƒฆใƒผใ‚ถใƒผใŒ่จฑๅฏใ•ใ‚Œใพใ™ * ็‰นๅฎšใฎใƒฆใƒผใ‚ถใƒผ ID", + "deprecated": true + }, + "operators": { + "type": "object", + "description": "ใƒซใƒผใƒซใŒ้ฉ็”จใ•ใ‚Œใ‚‹ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎ็จฎ้กžใ‚’้–‹ๅง‹ใงใใ‚‹ใƒฆใƒผใ‚ถใƒผ/ใ‚ฐใƒซใƒผใƒ—ใ‚’ๅฎš็พฉใ—ใพใ™.", + "properties": { + "wildcard": { + "const": "*", + "description": "ไฝฟ็”จใ™ใ‚‹ๅ ดๅˆใ€ใ“ใฎใƒ—ใƒญใƒ‘ใƒ†ใ‚ฃใฏๅ”ฏไธ€ใฎๅญใƒ—ใƒญใƒ‘ใƒ†ใ‚ฃใจใ—ใฆ่กจ็คบใ•ใ‚Œใพใ™ * "*" - ใ™ในใฆใฎใƒฆใƒผใ‚ถใƒผใŒ่จฑๅฏใ•ใ‚Œใพใ™" + }, + "users": { + "type": "array", + "description": "ใƒฆใƒผใ‚ถใƒผIDใฎใ‚ปใƒƒใƒˆ", + "items": { + "type": "string" + } + }, + "usersGroups": { + "type": "array", + "description": "ใ‚ฐใƒซใƒผใƒ—IDใฎใ‚ปใƒƒใƒˆ", + "items": { + "type": "string" + } + }, + "services": { + "type": "array", + "description": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚’้–‹ๅง‹ใ™ใ‚‹ใŸใ‚ใฎใ‚ตใƒผใƒ“ใ‚นใฎใ‚ปใƒƒใƒˆ", + "items": { + "type": "string" + } + } + } + }, + "transactionType": { + "oneOf": [ + { + "const": "TRANSFER" + }, + { + "const": "CONTRACT_CALL" + }, + { + "const": "APPROVE" + }, + { + "const": "MINT" + }, + { + "const": "BURN" + }, + { + "const": "SUPPLY" + }, + { + "const": "REDEEM" + }, + { + "const": "STAKE" + }, + { + "const": "RAW" + }, + { + "const": "TYPED_MESSAGE" + } + ], + "description": "ใƒซใƒผใƒซใŒ้ฉ็”จใ•ใ‚Œใ‚‹ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎใ‚ฟใ‚คใƒ—ใ‚’ๅฎš็พฉใ—ใพใ™ใ€‚ * TRANSFER - ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใ€‚ใ‚ใ‚‹ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‹ใ‚‰ๅˆฅใฎใ‚ขใ‚ซใ‚ฆใƒณใƒˆใซ่ณ‡้‡‘ใ‚’่ปข้€ใ—ใพใ™ใ€‚ * CONTRACT_CALL - ไธปใซ DeFi ๆ“ไฝœใฎใŸใ‚ใซใ‚นใƒžใƒผใƒˆ ใ‚ณใƒณใƒˆใƒฉใ‚ฏใƒˆใ‚’ๅ‘ผใณๅ‡บใ—ใพใ™ใ€‚ * APPROVE - ใ‚นใƒžใƒผใƒˆ ใ‚ณใƒณใƒˆใƒฉใ‚ฏใƒˆใŒๆŒ‡ๅฎšใ•ใ‚ŒใŸใ‚ฆใ‚ฉใƒฌใƒƒใƒˆใ‹ใ‚‰ๅผ•ใๅ‡บใ—ใงใใ‚‹ใ‚ˆใ†ใซใ—ใพใ™ใ€‚ * MINT - ใ‚ตใƒใƒผใƒˆใ•ใ‚Œใฆใ„ใ‚‹ใƒˆใƒผใ‚ฏใƒณใซๅฏพใ—ใฆใƒŸใƒณใƒˆๆ“ไฝœ (ไพ›็ตฆใฎๅข—ๅŠ ) ใ‚’ๅฎŸ่กŒใ—ใพใ™ใ€‚ * BURN - ใ‚ตใƒใƒผใƒˆใ•ใ‚Œใฆใ„ใ‚‹ใƒˆใƒผใ‚ฏใƒณใซๅฏพใ—ใฆใƒใƒผใƒณๆ“ไฝœ (ไพ›็ตฆใฎๅ‰Šๆธ›) ใ‚’ๅฎŸ่กŒใ—ใพใ™ใ€‚ * SUPPLY - DeFi ใง่ณ‡็”ฃใ‚’่ฒธใ—ๅ‡บใ™ใŸใ‚ใซไฝฟ็”จใ—ใพใ™ใ€‚ * REDEEM - DeFi ใง่ฒธใ—ๅ‡บใ—ใ‚’ๅ–ใ‚Šๆˆปใ™ใŸใ‚ใซไฝฟ็”จใ—ใพใ™ใ€‚ * STAKE - ใ‚นใƒ†ใƒผใ‚ญใƒณใ‚ฐๅ ฑ้…ฌใ‚’็ฒๅพ—ใ™ใ‚‹ใŸใ‚ใซ็‰นๅฎšใฎ่ณ‡็”ฃใ‚’ๅ‰ฒใ‚Šๅฝ“ใฆใฆใƒญใƒƒใ‚ฏใงใใ‚‹ใ‚ˆใ†ใซใ—ใพใ™ใ€‚ * RAW - ไบ‹ๅ‰ๅฎš็พฉใ•ใ‚ŒใŸๅฝขๅผใฎใชใ„ใ‚ชใƒ•ใƒใ‚งใƒผใƒณ ใƒกใƒƒใ‚ปใƒผใ‚ธใ€‚็ง˜ๅฏ†้ตใ‚’ไฝฟ็”จใ—ใฆไปปๆ„ใฎใƒกใƒƒใ‚ปใƒผใ‚ธใซ็ฝฒๅใ™ใ‚‹ใŸใ‚ใซไฝฟ็”จใ—ใพใ™ใ€‚ * TYPED_MESSAGE - ไบ‹ๅ‰ๅฎš็พฉใ•ใ‚ŒใŸๅฝขๅผใซๅพ“ใ†ใ‚ชใƒ•ใƒใ‚งใƒผใƒณ ใƒกใƒƒใ‚ปใƒผใ‚ธ ใ‚ฟใ‚คใƒ—ใ€‚ๅฎŸ้š›ใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใงใฏใชใ„็‰นๅฎšใฎใƒกใƒƒใ‚ปใƒผใ‚ธใซ็ฝฒๅใ™ใ‚‹ใŸใ‚ใซไฝฟ็”จใ•ใ‚Œใพใ™ใ€‚." + }, + "designatedSigner": { + "type": "string", + "description": "(้žๆŽจๅฅจ - ใ€ŒdesignatedSignersใ€ใซ็ฝฎใๆ›ใˆใ‚‰ใ‚Œใพใ—ใŸ) ็‰นๅฎšใฎใƒซใƒผใƒซใซไธ€่‡ดใ™ใ‚‹ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใซ็ฝฒๅใ™ใ‚‹ใƒฆใƒผใ‚ถใƒผใ‚’่กจใ™ ID", + "deprecated": true + }, + "designatedSigners": { + "type": "object", + "description": "็‰นๅฎšใฎใƒซใƒผใƒซใซไธ€่‡ดใ™ใ‚‹ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใซ็ฝฒๅใ™ใ‚‹ใƒฆใƒผใ‚ถใƒผใ‚’่กจใ™ ID ใฎใ‚ปใƒƒใƒˆ", + "properties": { + "users": { + "type": "array", + "description": "ใƒฆใƒผใ‚ถใƒผIDใฎใ‚ปใƒƒใƒˆ", + "items": { + "type": "string" + } + }, + "usersGroups": { + "type": "array", + "description": "ใ‚ฐใƒซใƒผใƒ—IDใฎใ‚ปใƒƒใƒˆ", + "items": { + "type": "string" + } + } + } + }, + "type": { + "const": "TRANSFER", + "description": "ใƒใƒชใ‚ทใƒผใƒซใƒผใƒซใฎ็จฎ้กž" + }, + "action": { + "oneOf": [ + { + "const": "ALLOW" + }, + { + "const": "BLOCK" + }, + { + "const": "2-TIER" + } + ], + "description": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใŒใƒซใƒผใƒซใฎๅŸบๆบ–ใ‚’ๆบ€ใŸใ—ใŸๅ ดๅˆใซไฝ•ใŒ่ตทใ“ใ‚‹ใ‹ใ‚’ๅฎš็พฉใ—ใพใ™ * ALLOW - ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏ้€š้Žใ—ใ€่ฟฝๅŠ ใฎๆ‰ฟ่ชใ‚’ๅฟ…่ฆใจใ›ใšใซ็ฝฒๅใงใใพใ™ * BLOCK - ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏ่‡ชๅ‹•็š„ใซใƒ–ใƒญใƒƒใ‚ฏใ•ใ‚Œใพใ™ * 2-TIER - ใ“ใ‚Œใ‚‰ใฎใƒฆใƒผใ‚ถใƒผใพใŸใฏใƒฆใƒผใ‚ถใƒผใ‚ฐใƒซใƒผใƒ—ใฎใฟใŒๆ‰ฟ่ชใงใใพใ™ ๅฟ…่ฆใชๆ‰ฟ่ชใ—ใใ„ๅ€คใŒๆบ€ใŸใ•ใ‚Œใ‚‹ๅ‰ใซใใ‚Œใ‚‰ใฎใ„ใšใ‚Œใ‹ใŒใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚’ๆ‹’ๅฆใ—ใŸๅ ดๅˆใ€ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏ้€š้Žใ—ใพใ›ใ‚“ ่จญๅฎšใ•ใ‚Œใ‚‹ใ‚จใƒณใƒ†ใ‚ฃใƒ†ใ‚ฃใฎใƒชใ‚นใƒˆใฏใ€ŒauthorizationGroupsใ€ใƒ•ใ‚ฃใƒผใƒซใƒ‰ใงใ™" + }, + "asset": { + "type": "string", + "description": "ๅ–ๅผ•ใ•ใ‚Œใ‚‹่ณ‡็”ฃใฎ็จฎ้กžใ‚’ๅฎš็พฉใ—ใพใ™ใ€‚ใ‚ชใƒ—ใ‚ทใƒงใƒณใฏ * "*" - ใ™ในใฆใฎ่ณ‡็”ฃ * ็‰นๅฎšใฎ่ณ‡็”ฃ" + }, + "srcType": { + "description": "(้žๆŽจๅฅจ - ใ€Œsrcใ€ใซ็ฝฎใๆ›ใˆใ‚‰ใ‚Œใพใ—ใŸ) ใ‚ฝใƒผใ‚น ใ‚ขใ‚ซใ‚ฆใƒณใƒˆ ใ‚ฟใ‚คใƒ—" + }, + "srcSubType": { + "description": "(้žๆŽจๅฅจ - ใ€Œsrcใ€ใซ็ฝฎใๆ›ใˆใ‚‰ใ‚Œใพใ—ใŸ) ใ‚ฝใƒผใ‚นใ‚ตใƒ–ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚ฟใ‚คใƒ—" + }, + "srcId": { + "description": "(้žๆŽจๅฅจ - ใ€Œsrcใ€ใซ็ฝฎใๆ›ใˆใ‚‰ใ‚Œใพใ—ใŸ) ใ‚ฝใƒผใ‚น ใ‚ขใ‚ซใ‚ฆใƒณใƒˆ ID" + }, + "src": { + "type": "object", + "description": "ใƒซใƒผใƒซใŒ่ปข้€ๅ…ƒใ‚’่จฑๅฏใ™ใ‚‹ใ‚ฝใƒผใ‚นใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’ๅฎš็พฉใ—ใพใ™", + "properties": { + "ids": { + "type": "array", + "description": "IDใฎใ‚ปใƒƒใƒˆ", + "items": { + "type": "array", + "description": "ใ‚ฟใƒ—ใƒซๅฝขๅผใฎIDใฎใ‚ปใƒƒใƒˆ", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/PolicySrcOrDestId" + }, + { + "$ref": "#/components/schemas/PolicySrcOrDestType" + }, + { + "$ref": "#/components/schemas/PolicySrcOrDestSubType" + } + ] + }, + "minItems": 1, + "maxItems": 3 + } + } + } + }, + "dstType": { + "description": "(้žๆŽจๅฅจ - ใ€Œdstใ€ใซ็ฝฎใๆ›ใˆใ‚‰ใ‚Œใพใ—ใŸ) ้€ไฟกๅ…ˆใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎ็จฎ้กž" + }, + "dstSubType": { + "description": "(้žๆŽจๅฅจ - ใ€Œdstใ€ใซ็ฝฎใๆ›ใˆใ‚‰ใ‚Œใพใ—ใŸ) ้€ไฟกๅ…ˆใ‚ตใƒ–ใ‚ขใ‚ซใ‚ฆใƒณใƒˆ ใ‚ฟใ‚คใƒ—" + }, + "dstId": { + "description": "(้žๆŽจๅฅจ - ใ€Œdstใ€ใซ็ฝฎใๆ›ใˆใ‚‰ใ‚Œใพใ—ใŸ) ๅฎ›ๅ…ˆใ‚ขใ‚ซใ‚ฆใƒณใƒˆ ID" + }, + "dst": { + "type": "object", + "description": "ใƒซใƒผใƒซใŒ่ปข้€ใ‚’่จฑๅฏใ™ใ‚‹ๅฎ›ๅ…ˆๅฃๅบงใ‚’ๅฎš็พฉใ—ใพใ™", + "properties": { + "ids": { + "type": "array", + "description": "IDใฎใ‚ปใƒƒใƒˆ", + "items": { + "type": "array", + "description": "ใ‚ฟใƒ—ใƒซๅฝขๅผใฎIDใฎใ‚ปใƒƒใƒˆ", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/PolicySrcOrDestId" + }, + { + "$ref": "#/components/schemas/PolicySrcOrDestType" + }, + { + "$ref": "#/components/schemas/PolicySrcOrDestSubType" + } + ] + }, + "minItems": 1, + "maxItems": 3 + } + } + } + }, + "dstAddressType": { + "oneOf": [ + { + "const": "WHITELISTED" + }, + { + "const": "ONE_TIME" + }, + { + "const": "*" + } + ], + "description": "่ณ‡้‡‘ใฎ้€้‡‘ๅ…ˆใŒใƒ›ใƒฏใ‚คใƒˆใƒชใ‚นใƒˆใซ็™ป้Œฒใ•ใ‚Œใฆใ„ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚‹ใ‹ใ€ใƒ›ใƒฏใ‚คใƒˆใƒชใ‚นใƒˆใซ็™ป้Œฒใ•ใ‚Œใฆใ„ใชใ„ๅค–้ƒจใ‚ขใƒ‰ใƒฌใ‚นใธใฎ 1 ๅ›ž้™ใ‚Šใฎ้€้‡‘ใ‚’่จฑๅฏใ™ใ‚‹ใ‹ใ€ใพใŸใฏใใฎไธกๆ–นใ‹ใ‚’ๅฎš็พฉใ—ใพใ™ใ€‚ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใงใฏใ€ใƒ›ใƒฏใ‚คใƒˆใƒชใ‚นใƒˆใซ็™ป้Œฒใ•ใ‚ŒใŸๅค–้ƒจใ‚ขใƒ‰ใƒฌใ‚นใซใฎใฟ้€้‡‘ใงใใพใ™ใ€‚ * WHITELISTED - ใƒ›ใƒฏใ‚คใƒˆใƒชใ‚นใƒˆใซ็™ป้Œฒใ•ใ‚ŒใŸใ‚ขใƒ‰ใƒฌใ‚นใซใฎใฟ้€ไฟกใงใใพใ™ใ€‚ * ONE_TIME - ใƒ›ใƒฏใ‚คใƒˆใƒชใ‚นใƒˆใซ็™ป้Œฒใ•ใ‚Œใฆใ„ใชใ„ๅค–้ƒจใ‚ขใƒ‰ใƒฌใ‚นใซใฎใฟ้€ไฟกใงใใพใ™ใ€‚ * "*" - ใƒ›ใƒฏใ‚คใƒˆใƒชใ‚นใƒˆใซ็™ป้Œฒใ•ใ‚ŒใŸใ‚ขใƒ‰ใƒฌใ‚นใพใŸใฏใƒ›ใƒฏใ‚คใƒˆใƒชใ‚นใƒˆใซ็™ป้Œฒใ•ใ‚Œใฆใ„ใชใ„ๅค–้ƒจใ‚ขใƒ‰ใƒฌใ‚นใซ้€ไฟกใงใใพใ™ใ€‚" + }, + "amountCurrency": { + "oneOf": [ + { + "const": "USD" + }, + { + "const": "EUR" + }, + { + "const": "NATIVE" + } + ], + "description": "* USD - ใƒฆใƒผใ‚ถใƒผใŒ่ปข้€ใงใใ‚‹่ณ‡็”ฃใฎ้‡ใ‚’ใ€่ณ‡็”ฃใฎ USD ็›ธๅฝ“้กใซๅŸบใฅใ„ใฆๅˆถ้™ใ—ใพใ™ใ€‚ * EUR - ใƒฆใƒผใ‚ถใƒผใŒ่ปข้€ใงใใ‚‹่ณ‡็”ฃใฎ้‡ใ‚’ใ€่ณ‡็”ฃใฎ EUR ็›ธๅฝ“้กใซๅŸบใฅใ„ใฆๅˆถ้™ใ—ใพใ™ใ€‚ * NATIVE - ็‰นๅฎšใฎ่ณ‡็”ฃใ‚’ไฝฟ็”จใ™ใ‚‹ใจใใซใƒฆใƒผใ‚ถใƒผใŒ่ปข้€ใงใใ‚‹่ณ‡็”ฃใฎ้‡ใ‚’ๅˆถ้™ใ—ใพใ™ใ€‚." + }, + "amountScope": { + "oneOf": [ + { + "const": "SINGLE_TX" + }, + { + "const": "TIMEFRAME" + } + ], + "description": "* SINGLE_TX - ๅˆถ้™ใฏๅ˜ไธ€ใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใซ้ฉ็”จใ•ใ‚Œใพใ™ * TIMEFRAME - ๅˆถ้™ใฏๅฎš็พฉใ•ใ‚ŒใŸๆœŸ้–“ๅ†…ใฎใ™ในใฆใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใซ้ฉ็”จใ•ใ‚Œใพใ™" + }, + "amount": { + "type": "number", + "description": "ใƒซใƒผใƒซใ‚’้ฉ็”จใ™ใ‚‹ใŸใ‚ใซๅ–ๅผ•ใŒ่ถ…้Žใ™ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚‹ๅ€คใ‚’ๅฎš็พฉใ—ใพใ™๏ผˆamountCurrency ใƒ•ใ‚ฃใƒผใƒซใƒ‰ใซๅพ“ใฃใฆ๏ผ‰" + }, + "periodSec": { + "type": "number", + "description": "amountScope ใƒ•ใ‚ฃใƒผใƒซใƒ‰ใซใ‚ˆใฃใฆใ€ใƒซใƒผใƒซใซไธ€่‡ดใ™ใ‚‹ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎ่ปข้€้กใ‚’็ดฏ็ฉใ™ใ‚‹ใŸใ‚ใซ้ฉ็”จใ•ใ‚Œใ‚‹็ง’ๅ˜ไฝใฎๆ™‚้–“ใ€‚ๅˆ่จˆใŒ Minimum ใงๆŒ‡ๅฎšใ—ใŸๅ€คใ‚’่ถ…ใˆใ‚‹ใพใง็ดฏ็ฉใ•ใ‚Œใพใ™ใ€‚ๆŒ‡ๅฎšใ—ใŸ้‡‘้กใŒใใฎๆœŸ้–“ๅ†…ใซ 1 ๅ›žใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใพใŸใฏ่ค‡ๆ•ฐใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใซใ‚ˆใฃใฆ้”ใ—ใŸๅ ดๅˆใ€ใใฎๆœŸ้–“ๅ†…ใฎใใ‚Œไปฅ้™ใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฏๅคฑๆ•—ใ™ใ‚‹ใ‹ใ€่ฟฝๅŠ ใฎๆ‰ฟ่ชใŒๅฟ…่ฆใซใชใ‚Šใพใ™ใ€‚." + }, + "authorizers": { + "type": "array", + "description": "(้žๆŽจๅฅจ - ใ€ŒauthorizationGroupsใ€ใซ็ฝฎใๆ›ใˆใ‚‰ใ‚Œใพใ—ใŸ) ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚’ๆ‰ฟ่ชใงใใ‚‹่จฑๅฏใ•ใ‚ŒใŸใ‚จใƒณใƒ†ใ‚ฃใƒ†ใ‚ฃ", + "deprecated": true, + "items": { + "type": "string" + } + }, + "authorizersCount": { + "type": "number", + "description": "(้žๆŽจๅฅจ - ใ€ŒauthorizationGroupsใ€ใซ็ฝฎใๆ›ใˆใ‚‰ใ‚Œใพใ—ใŸ) ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚’ๆ‰ฟ่ชใ™ใ‚‹ใŸใ‚ใซๅฟ…่ฆใชใ‚จใƒณใƒ†ใ‚ฃใƒ†ใ‚ฃใฎๆœ€ๅฐๆ•ฐ", + "deprecated": true + }, + "authorizationGroups": { + "type": "object", + "description": "ๅ–ๅผ•ๆ‰ฟ่ชๆกไปถใ‚’ๅฎš็พฉใ™ใ‚‹", + "properties": { + "logic": { + "oneOf": [ + { + "const": "AND" + }, + { + "const": "OR" + } + ], + "description": "* AND - ใ™ในใฆใฎๆ‰ฟ่ชใ‚ฐใƒซใƒผใƒ—ใฎๆ‰ฟ่ชใŒๅฟ…่ฆ * OR - ๅฐ‘ใชใใจใ‚‚ 1 ใคใฎๆ‰ฟ่ชใ‚ฐใƒซใƒผใƒ—ใฎๆ‰ฟ่ชใŒๅฟ…่ฆ" + }, + "allowOperatorAsAuthorizer": { + "type": "boolean", + "description": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚’้–‹ๅง‹ใ—ใŸใƒฆใƒผใ‚ถใƒผใŒ่‡ชๅˆ†ใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚’ๆ‰ฟ่ชใ—ใ€ใใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใฎๆ‰ฟ่ชใ—ใใ„ๅ€คใซใ‚ซใ‚ฆใƒณใƒˆใงใใ‚‹ใ‹ใฉใ†ใ‹ใ‚’ๅฎš็พฉใ—ใพใ™ใ€‚" + }, + "groups": { + "type": "array", + "description": "ๅ–ๅผ•ใ‚’ๆ‰ฟ่ชใงใใ‚‹ใ‚จใƒณใƒ†ใ‚ฃใƒ†ใ‚ฃใฎใ‚ฐใƒซใƒผใƒ—", + "items": { + "type": "object", + "properties": { + "users": { + "type": "array", + "description": "ใƒฆใƒผใ‚ถใƒผID", + "items": { + "type": "string" + } + }, + "usersGroups": { + "type": "array", + "description": "ใ‚ฐใƒซใƒผใƒ—ID", + "items": { + "type": "string" + } + }, + "th": { + "type": "number", + "description": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚’ๆ‰ฟ่ชใ™ใ‚‹ใŸใ‚ใซๅฟ…่ฆใชใ‚จใƒณใƒ†ใ‚ฃใƒ†ใ‚ฃใฎๆœ€ๅฐๆ•ฐใ‚’่กจใ—ใพใ™ใ€‚ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใฏ 1 ใงใ™ใ€‚." + } + } + } + } + } + }, + "amountAggregation": { + "type": "object", + "description": "ใƒใƒชใ‚ทใƒผ ใ‚จใƒณใ‚ธใƒณใŒ็ดฏ็ฉใ‚’่จˆ็ฎ—ใ™ใ‚‹ๆ–นๆณ•ใ‚’ๅฎš็พฉใ—ใพใ™ใ€‚ใ‚คใƒ‹ใ‚ทใ‚จใƒผใ‚ฟใ€ใ‚ฝใƒผใ‚นใ€ใŠใ‚ˆใณๅฎ›ๅ…ˆใ‚’ไฝฟ็”จใ—ใฆใ€ๆœŸ้–“ใฎๆœŸ้–“ใฎๆœ€ๅฐๅ€คใซๅฏพใ™ใ‚‹็ดฏ็ฉใ‚’่จˆ็ฎ—ใ—ใพใ™ใ€‚.", + "properties": { + "operators": { + "$ref": "#/components/schemas/AmountAggregationTimePeriodMethod" + }, + "srcTransferPeers": { + "$ref": "#/components/schemas/AmountAggregationTimePeriodMethod" + }, + "dstTransferPeers": { + "$ref": "#/components/schemas/AmountAggregationTimePeriodMethod" + } + } + }, + "rawMessageSigning": { + "type": "object", + "description": "็”Ÿใฎใƒกใƒƒใ‚ปใƒผใ‚ธ็ฝฒๅ่จญๅฎš", + "properties": { + "algorithm": { + "type": "string" + }, + "derivationPath": { + "type": "object", + "properties": { + "path": { + "type": "array", + "items": { + "type": "number" + } + } + } + } + } + }, + "applyForApprove": { + "type": "boolean", + "description": "ใ“ใฎใƒซใƒผใƒซใ‚’ APPROVE ใ‚ฟใ‚คใƒ—ใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใซ้ฉ็”จใ—ใพใ™ (ใƒซใƒผใƒซใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณ ใ‚ฟใ‚คใƒ—ใŒ TRANSFER ใฎๅ ดๅˆใซใฎใฟๆœ‰ๅŠนใซใงใใพใ™)" + }, + "applyForTypedMessage": { + "type": "boolean", + "description": "ใ“ใฎใƒซใƒผใƒซใ‚’ TYPED_MESSAGE ใ‚ฟใ‚คใƒ—ใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใซ้ฉ็”จใ—ใพใ™ (ใƒซใƒผใƒซใฎใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณ ใ‚ฟใ‚คใƒ—ใŒ CONTRACT_CALL ใฎๅ ดๅˆใซใฎใฟๆœ‰ๅŠนใซใงใใพใ™)" + }, + "externalDescriptor": { + "type": "string", + "description": "ใƒซใƒผใƒซใ‚’่ญ˜ๅˆฅใ™ใ‚‹ไธ€ๆ„ใฎID" + } + }, + "required": [ + "type", + "action", + "asset", + "amountCurrency", + "amountScope", + "amount", + "periodSec", + "externalDescriptor" + ] + }, + "PublishResult": { + "type": "object", + "description": "ๅ…ฌ้–‹ใƒใƒชใ‚ทใƒผๆ“ไฝœใฎๅฟœ็ญ”ใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "properties": { + "status": { + "$ref": "#/components/schemas/PolicyStatus" + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicyRule" + } + }, + "checkResult": { + "$ref": "#/components/schemas/PolicyCheckResult" + }, + "metadata": { + "$ref": "#/components/schemas/PolicyMetadata" + } + }, + "required": [ + "status", + "rules", + "checkResult", + "metadata" + ] + }, + "PolicyStatus": { + "oneOf": [ + { + "const": "SUCCESS" + }, + { + "const": "UNVALIDATED" + }, + { + "const": "INVALID_CONFIGURATION" + }, + { + "const": "PENDING" + }, + { + "const": "PENDING_CONSOLE_APPROVAL" + }, + { + "const": "AWAITING_QUORUM" + }, + { + "const": "UNHANDLED_ERROR" + } + ], + "description": "* SUCCESS - ๆˆๅŠŸ * UNVALIDATED - ใพใ ๆคœ่จผใ•ใ‚Œใฆใ„ใพใ›ใ‚“ * INVALID_CONFIGURATION - ๅฐ‘ใชใใจใ‚‚ 1 ใคใฎใƒซใƒผใƒซใŒ็„กๅŠนใงใ™ * PENDING - ๆ‰ฟ่ชๅพ…ใก * PENDING_CONSOLE_APPROVAL - ใ‚ณใƒณใ‚ฝใƒผใƒซ ใ‚ขใƒ—ใƒชใ‹ใ‚‰ใฎๆ‰ฟ่ชๅพ…ใก * AWAITING_QUORUM - ใ‚ฏใ‚ฉใƒผใƒฉใƒ ๆ‰ฟ่ชๅพ…ใก * UNHANDLED_ERROR - ๆœชๅ‡ฆ็†ใฎใ‚จใƒฉใƒผ" + }, + "PolicyMetadata": { + "type": "object", + "description": "ใƒใƒชใ‚ทใƒผ้–ข้€ฃใฎใƒกใ‚ฟใƒ‡ใƒผใ‚ฟ", + "properties": { + "editedBy": { + "type": "string", + "description": "ใƒใƒชใ‚ทใƒผใ‚’ๆœ€ๅพŒใซ็ทจ้›†ใ—ใŸใƒฆใƒผใ‚ถใƒผใฎใƒฆใƒผใ‚ถใƒผID" + }, + "editedAt": { + "type": "string", + "description": "ใƒใƒชใ‚ทใƒผใฎๆœ€็ต‚็ทจ้›†ใฎใ‚ฟใ‚คใƒ ใ‚นใ‚ฟใƒณใƒ—" + }, + "publishedBy": { + "type": "string", + "description": "ๆœ€ๅพŒใซใƒใƒชใ‚ทใƒผใ‚’ๅ…ฌ้–‹ใ—ใŸใƒฆใƒผใ‚ถใƒผใฎใƒฆใƒผใ‚ถใƒผID" + }, + "publishedAt": { + "type": "string", + "description": "ใƒใƒชใ‚ทใƒผใฎๆœ€็ต‚ๅ…ฌ้–‹ใฎใ‚ฟใ‚คใƒ ใ‚นใ‚ฟใƒณใƒ—" + } + } + }, + "PolicyCheckResult": { + "type": "object", + "description": "ใƒใƒชใ‚ทใƒผใƒซใƒผใƒซใฎๆคœ่จผ็ตๆžœ", + "properties": { + "errors": { + "type": "number", + "description": "ใ‚จใƒฉใƒผๆ•ฐ" + }, + "result": { + "type": "array", + "description": "ๆคœ่จผ็ตๆžœใฎใ‚ปใƒƒใƒˆ", + "items": { + "$ref": "#/components/schemas/PolicyRuleCheckResult" + } + } + }, + "required": [ + "errors", + "result" + ] + }, + "PolicyRuleCheckResult": { + "type": "object", + "description": "ใƒซใƒผใƒซๆคœ่จผ็ตๆžœ", + "properties": { + "index": { + "type": "number", + "description": "ใƒใƒชใ‚ทใƒผๅ†…ใฎใƒซใƒผใƒซใ‚คใƒณใƒ‡ใƒƒใ‚ฏใ‚น็•ชๅท" + }, + "status": { + "oneOf": [ + { + "const": "ok" + }, + { + "const": "failure" + } + ], + "description": "ๆคœ่จผใ‚นใƒ†ใƒผใ‚ฟใ‚น" + }, + "errors": { + "type": "array", + "description": "ใƒซใƒผใƒซๆคœ่จผใ‚จใƒฉใƒผใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆใฎใ‚ปใƒƒใƒˆ", + "items": { + "$ref": "#/components/schemas/PolicyRuleError" + } + } + }, + "required": [ + "index", + "status", + "errors" + ] + }, + "PolicyRuleError": { + "type": "object", + "description": "ใƒซใƒผใƒซๆคœ่จผ็ตๆžœใ‚จใƒฉใƒผ", + "properties": { + "errorMessage": { + "type": "string", + "description": "ใ‚จใƒฉใƒผใƒกใƒƒใ‚ปใƒผใ‚ธ" + }, + "errorCode": { + "type": "number", + "description": "ใ‚จใƒฉใƒผใ‚ณใƒผใƒ‰" + }, + "errorCodeName": { + "type": "string", + "description": "ใ‚จใƒฉใƒผใ‚ณใƒผใƒ‰ๅ" + }, + "errorField": { + "oneOf": [ + { + "const": "operator" + }, + { + "const": "operators" + }, + { + "const": "authorizationGroups" + }, + { + "const": "designatedSigner" + }, + { + "const": "designatedSigners" + }, + { + "const": "contractMethods" + }, + { + "const": "amountAggregation" + }, + { + "const": "src" + }, + { + "const": "dst" + } + ], + "description": "ใ‚จใƒฉใƒผใŒ้–ขไฟ‚ใ™ใ‚‹ใƒ•ใ‚ฃใƒผใƒซใƒ‰ * operator - ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณ ใ‚คใƒ‹ใ‚ทใ‚จใƒผใ‚ฟใƒผ * operators - ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณ ใ‚คใƒ‹ใ‚ทใ‚จใƒผใ‚ฟใƒผ * authorizationGroups - ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณ ๆ‰ฟ่ช่€…ใ‚ฐใƒซใƒผใƒ— * designatedSigner - ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณ็ฝฒๅ่€… * designatedSigners - ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณ็ฝฒๅ่€… * contractMethods - ๅฅ‘็ด„ๆ–นๆณ• * amountAggregation - ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณ้‡‘้ก้›†่จˆ่จญๅฎš * src - ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณ ใ‚ฝใƒผใ‚น่ณ‡็”ฃ่จญๅฎš * dst - ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณ ใƒ‡ใ‚นใƒ†ใ‚ฃใƒใƒผใ‚ทใƒงใƒณ่ณ‡็”ฃ่จญๅฎš" + } + }, + "required": [ + "errorMessage", + "errorCode", + "errorCodeName", + "errorField" + ] + }, + "DraftReviewAndValidationResponse": { + "type": "object", + "description": "ใƒ‰ใƒฉใƒ•ใƒˆๆคœ่จผ", + "properties": { + "draftResponse": { + "$ref": "#/components/schemas/DraftResponse" + }, + "validation": { + "$ref": "#/components/schemas/PolicyValidation" + } + }, + "required": [ + "draftResponse", + "validation" + ] + }, + "PolicyAndValidationResponse": { + "type": "object", + "description": "ใƒใƒชใ‚ทใƒผใฎๆคœ่จผ", + "properties": { + "policy": { + "$ref": "#/components/schemas/PolicyResponse" + }, + "validation": { + "$ref": "#/components/schemas/PolicyValidation" + } + }, + "required": [ + "policy", + "validation" + ] + }, + "DraftResponse": { + "type": "object", + "description": "ใƒ‰ใƒฉใƒ•ใƒˆๆ“ไฝœใฎใƒฌใ‚นใƒใƒณใ‚นใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "properties": { + "status": { + "type": "string", + "description": "ๆ“ไฝœ็Šถๆณ" + }, + "rules": { + "type": "array", + "description": "ใƒ‰ใƒฉใƒ•ใƒˆใƒซใƒผใƒซ", + "items": { + "$ref": "#/components/schemas/PolicyRule" + } + }, + "draftId": { + "type": "string", + "description": "ใƒ‰ใƒฉใƒ•ใƒˆใฎๅ›บๆœ‰ID" + }, + "metadata": { + "$ref": "#/components/schemas/PolicyMetadata" + } + }, + "required": [ + "draftId", + "status", + "rules", + "metadata" + ] + }, + "PolicyResponse": { + "type": "object", + "description": "ใƒใƒชใ‚ทใƒผๆ“ไฝœใฎๅฟœ็ญ”ใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "properties": { + "rules": { + "type": "array", + "description": "ไธ€้€ฃใฎใƒใƒชใ‚ทใƒผใƒซใƒผใƒซ", + "items": { + "$ref": "#/components/schemas/PolicyRule" + } + }, + "metadata": { + "$ref": "#/components/schemas/PolicyMetadata" + } + }, + "required": [ + "rules", + "metadata" + ] + }, + "PolicyValidation": { + "type": "object", + "description": "ใƒใƒชใ‚ทใƒผๆคœ่จผใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ", + "properties": { + "status": { + "type": "string", + "description": "ๆคœ่จผใ‚นใƒ†ใƒผใ‚ฟใ‚น" + }, + "checkResult": { + "$ref": "#/components/schemas/PolicyCheckResult" + } + }, + "required": [ + "status", + "checkResult" + ] + }, + "ErrorResponse": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "type": { + "oneOf": [ + { + "const": "INTERNAL" + }, + { + "const": "AUTHENTICATION" + }, + { + "const": "AUTHORIZATION" + }, + { + "const": "VALIDATION" + }, + { + "const": "NOT_FOUND" + }, + { + "const": "UNPROCESSABLE_ENTITY" + }, + { + "const": "FORBIDDEN" + } + ] + }, + "message": { + "type": "string" + } + }, + "required": [ + "type", + "message" + ] + } + }, + "required": [ + "error" + ] + } + }, + "securitySchemes": { + "bearerTokenAuth": { + "type": "http", + "scheme": "bearer", + "bearerFormat": "JWT" + }, + "ApiKeyAuth": { + "type": "apiKey", + "in": "header", + "name": "X-API-Key" + } + } + }, + "x-samchon-emended": true +} \ No newline at end of file diff --git a/assets/output/fireblocks.swagger.ko.json b/assets/output/fireblocks.swagger.ko.json new file mode 100644 index 0000000..14d86c3 --- /dev/null +++ b/assets/output/fireblocks.swagger.ko.json @@ -0,0 +1,16347 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "ํŒŒ์ด์–ด๋ธ”๋ก API", + "version": "1.0.0", + "contact": { + "email": "support@fireblocks.com" + } + }, + "servers": [ + { + "url": "https://api.fireblocks.io/v1" + } + ], + "x-readme": { + "explorer-enabled": false, + "samples-languages": [ + "curl", + "javascript", + "python" + ] + }, + "paths": { + "/vault/accounts": { + "get": { + "summary": "๋ณผํŠธ ๊ณ„์ • ๋ชฉ๋ก", + "description": "์ž‘์—… ๊ณต๊ฐ„์˜ ๋ชจ๋“  ๋ณผํŠธ ๊ณ„์ •์„ ๊ฐ€์ ธ์˜ต๋‹ˆ๋‹ค..", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vault_accounts = fireblocks.get_vault_accounts()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAccounts = await fireblocks.getVaultAccounts();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "query", + "name": "namePrefix", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "nameSuffix", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minAmountThreshold", + "required": false, + "schema": { + "type": "number" + } + }, + { + "in": "query", + "name": "assetId", + "required": false, + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "๋ณผํŠธ ๊ณ„์ • ๋ชฉ๋ก", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VaultAccount" + } + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "์ƒˆ๋กœ์šด ๋ณผํŠธ ๊ณ„์ •์„ ๋งŒ๋“œ์„ธ์š”", + "description": "์š”์ฒญ๋œ ์ด๋ฆ„์œผ๋กœ ์ƒˆ ๋ณผํŠธ ๊ณ„์ •์„ ๋งŒ๋“ญ๋‹ˆ๋‹ค..", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAccount = fireblocks.create_vault_account(name, hiddenOnUI, customer_ref_id, auto_fueling)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAccount = await fireblocks.createVaultAccount(name, hiddenOnUI, customerRefId, autoFueling);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "description": "๊ณ„์ • ์ด๋ฆ„", + "type": "string" + }, + "hiddenOnUI": { + "description": "์„ ํƒ ์‚ฌํ•ญ - true์ธ ๊ฒฝ์šฐ ์ƒ์„ฑ๋œ ๊ณ„์ •๊ณผ ๋ชจ๋“  ๊ด€๋ จ ๊ฑฐ๋ž˜๊ฐ€ Fireblocks ์ฝ˜์†”์— ํ‘œ์‹œ๋˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค.", + "type": "boolean" + }, + "customerRefId": { + "description": "์„ ํƒ ์‚ฌํ•ญ - ๊ณ ๊ฐ ์ฐธ์กฐ ID๋ฅผ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค.", + "type": "string" + }, + "autoFuel": { + "description": "์„ ํƒ ์‚ฌํ•ญ - ๋ณผํŠธ ๊ณ„์ •์˜ autoFuel ์†์„ฑ์„ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค.", + "type": "boolean" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "๋ณผํŠธ ๊ณ„์ • ๊ฐœ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/VaultAccount" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts_paged": { + "get": { + "summary": "๋ณผํŠธ ๊ณ„์ • ๋ชฉ๋ก(ํŽ˜์ด์ง€๋ณ„)", + "description": "์ž‘์—… ๊ณต๊ฐ„์˜ ๋ชจ๋“  ๋ณผํŠธ ๊ณ„์ •์„ ๊ฐ€์ ธ์˜ต๋‹ˆ๋‹ค. ์ด ์—”๋“œํฌ์ธํŠธ๋Š” ๋น ๋ฅธ ์‘๋‹ต ์‹œ๊ฐ„์œผ๋กœ ์ œํ•œ๋œ ์–‘์˜ ๊ฒฐ๊ณผ๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vault_accounts = fireblocks.get_vault_accounts_with_page_info(filters)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAccounts = await fireblocks.getVaultAccountsWithPageInfo(filters);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "query", + "name": "namePrefix", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "nameSuffix", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minAmountThreshold", + "required": false, + "schema": { + "type": "number" + } + }, + { + "in": "query", + "name": "assetId", + "required": false, + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + }, + { + "in": "query", + "name": "orderBy", + "required": false, + "schema": { + "oneOf": [ + { + "const": "ASC" + }, + { + "const": "DESC" + } + ] + } + }, + { + "in": "query", + "name": "before", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "after", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "number", + "minimum": 1, + "maximum": 500, + "default": 200 + } + } + ], + "responses": { + "200": { + "description": "VaultAccountsPagedResponse ๊ฐœ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/VaultAccountsPagedResponse" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}": { + "get": { + "summary": "ID๋กœ ๋ณผํŠธ ๊ณ„์ • ์ฐพ๊ธฐ", + "description": "์š”์ฒญ๋œ ๋ณผํŠธ ๊ณ„์ •์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vault_account = fireblocks.get_vault_account(vault_account_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAccount = await fireblocks.getVaultAccount(vault_account_id);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "๋ฐ˜ํ™˜ํ•  ๋ณผํŠธ ๊ณ„์ •์˜ ID ์œ ํ˜•: ๋ฌธ์ž์—ด", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + } + ], + "responses": { + "200": { + "description": "๋ณผํŠธ ๊ณ„์ • ๊ฐœ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/VaultAccount" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "put": { + "summary": "๋ณผํŠธ ๊ณ„์ • ์ด๋ฆ„ ๋ฐ”๊พธ๊ธฐ", + "description": "์š”์ฒญ๋œ ๋ณผํŠธ ๊ณ„์ •์˜ ์ด๋ฆ„์„ ๋ณ€๊ฒฝํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAccount = fireblocks.update_vault_account(vault_account_id, name)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAccount = await fireblocks.updateVaultAccount(vautlAccountId, name);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "ํŽธ์ง‘ํ•  ๋ณผํŠธ ๊ณ„์ •์˜ ID", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "description": "๊ณ„์ • ์ด๋ฆ„", + "type": "string" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "์ข‹์•„์š”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/asset_wallets": { + "get": { + "summary": "์ž์‚ฐ ์ง€๊ฐ‘ ๋ชฉ๋ก(ํŽ˜์ด์ง€๋ณ„)", + "description": "์ž‘์—… ๊ณต๊ฐ„์˜ ๋ชจ๋“  ๋ณผํŠธ ๊ณ„์ •์—์„œ ๋ชจ๋“  ์ž์‚ฐ ์ง€๊ฐ‘์„ ๊ฐ€์ ธ์˜ต๋‹ˆ๋‹ค. ์ž์‚ฐ ์ง€๊ฐ‘์€ ๋ณผํŠธ ๊ณ„์ •์˜ ์ž์‚ฐ์ž…๋‹ˆ๋‹ค. ์ด ๋ฐฉ๋ฒ•์„ ์‚ฌ์šฉํ•˜๋ฉด ๋ชจ๋“  ๊ณ„์ • ์ž”์•ก์„ ๋น ๋ฅด๊ฒŒ ํƒ์ƒ‰ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. **์ฐธ๊ณ :** - ์ด API ์—”๋“œํฌ์ธํŠธ๋Š” ์ œํ•œ์ ์œผ๋กœ ์ œ๊ณต๋˜๋ฉฐ ์ผ๋ถ€ ๊ณ ๊ฐ์—๊ฒŒ๋งŒ ์ œ๊ณต๋ฉ๋‹ˆ๋‹ค. ์ด ์—”๋“œํฌ์ธํŠธ์— ๋Œ€ํ•œ ์กฐ๊ธฐ ์•ก์„ธ์Šค๋ฅผ ์›ํ•˜์‹œ๋ฉด [Fireblocks ์ง€์›](https://support.fireblocks.io/hc/en-us/requests/new?ticket_form_id=36000337220)์— ๋ฌธ์˜ํ•˜์„ธ์š”. - ์ด API ํ˜ธ์ถœ์—๋Š” [์š”๊ธˆ ์ œํ•œ](https://developers.fireblocks.com/reference/rate-limiting)์ด ์ ์šฉ๋ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vault_accounts = fireblocks.get_asset_wallets(filters)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAccounts = await fireblocks.getAssetWallets(filters);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "query", + "name": "totalAmountLargerThan", + "description": "์ง€์ •๋œ ๊ฒฝ์šฐ ์ด ๊ธˆ์•ก๋ณด๋‹ค ์ด ์ž”์•ก์ด ํฐ ์ž์‚ฐ ์ง€๊ฐ‘๋งŒ ๋ฐ˜ํ™˜๋ฉ๋‹ˆ๋‹ค..", + "required": false, + "schema": { + "type": "number" + } + }, + { + "in": "query", + "name": "assetId", + "required": false, + "description": "์ง€์ •๋œ ๊ฒฝ์šฐ ์ด ์ž์‚ฐ ID๊ฐ€ ์žˆ๋Š” ๋ณผํŠธ ๊ณ„์ • ๊ฐ„ ์ž์‚ฐ ์ง€๊ฐ‘๋งŒ ๋ฐ˜ํ™˜๋ฉ๋‹ˆ๋‹ค..", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + }, + { + "in": "query", + "name": "before", + "required": false, + "description": "์ด ์š”์†Œ ์ด์ „์˜ ๋‹ค์Œ ํŽ˜์ด์ง€ ๋งค๊น€ ์‘๋‹ต์„ ๊ฐ€์ ธ์˜ต๋‹ˆ๋‹ค. ์ด ์š”์†Œ๋Š” ์ปค์„œ์ด๋ฉฐ ์ด์ „ ํŽ˜์ด์ง€์˜ ์‘๋‹ต์—์„œ ๋ฐ˜ํ™˜๋ฉ๋‹ˆ๋‹ค..", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "after", + "required": false, + "description": "์ด ์š”์†Œ ๋‹ค์Œ์— ์žˆ๋Š” ๋‹ค์Œ ํŽ˜์ด์ง€ ๋งค๊น€ ์‘๋‹ต์„ ๊ฐ€์ ธ์˜ต๋‹ˆ๋‹ค. ์ด ์š”์†Œ๋Š” ์ปค์„œ์ด๋ฉฐ ์ด์ „ ํŽ˜์ด์ง€์˜ ์‘๋‹ต์—์„œ ๋ฐ˜ํ™˜๋ฉ๋‹ˆ๋‹ค..", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "limit", + "required": false, + "description": "๋‹จ์ผ ์‘๋‹ต์—์„œ ์ž์‚ฐ ์ง€๊ฐ‘์˜ ์ตœ๋Œ€ ์ˆ˜์ž…๋‹ˆ๋‹ค. ๊ธฐ๋ณธ๊ฐ’์€ 200์ด๊ณ  ์ตœ๋Œ€๊ฐ’์€ 1000์ž…๋‹ˆ๋‹ค..", + "schema": { + "type": "number", + "minimum": 1, + "maximum": 1000, + "default": 200 + } + } + ], + "responses": { + "200": { + "description": "PaginatedAssetWalletResponse ๊ฐ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PaginatedAssetWalletResponse" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/hide": { + "post": { + "summary": "์ฝ˜์†”์—์„œ ๋ณผํŠธ ๊ณ„์ • ์ˆจ๊ธฐ๊ธฐ", + "description": "์›น ์ฝ˜์†” ๋ณด๊ธฐ์—์„œ ์š”์ฒญ๋œ ๋ณผํŠธ ๊ณ„์ •์„ ์ˆจ๊น๋‹ˆ๋‹ค..", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAsset = fireblocks.hide_vault_account(vault_account_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAsset = await fireblocks.hideVaultAccount(vaultAccountId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "์ˆจ๊ธธ ๋ณผํŠธ ๊ณ„์ •", + "schema": { + "type": "string", + "minimum": 1, + "format": "numeric", + "x-fb-entity": "vault_account" + } + } + ], + "responses": { + "201": { + "description": "์ข‹์•„์š”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/unhide": { + "post": { + "summary": "์ฝ˜์†”์—์„œ ๋ณผํŠธ ๊ณ„์ • ์ˆจ๊ธฐ๊ธฐ ํ•ด์ œ", + "description": "์›น ์ฝ˜์†” ๋ณด๊ธฐ์—์„œ ์ˆจ๊ฒจ์ง„ ๋ณผํŠธ ๊ณ„์ •์„ ํ‘œ์‹œํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAsset = fireblocks.unhide_vault_account(vault_account_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAsset = await fireblocks.unhideVaultAccount(vaultAccountId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "์ˆจ๊ฒจ์ง„ ๋ณผํŠธ ๊ณ„์ •์„ ํ•ด์ œํ•ฉ๋‹ˆ๋‹ค", + "schema": { + "type": "string", + "minimum": 1, + "format": "numeric", + "x-fb-entity": "vault_account" + } + } + ], + "responses": { + "201": { + "description": "์ข‹์•„์š”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/activate": { + "post": { + "summary": "๋ณผํŠธ ๊ณ„์ •์—์„œ ์ง€๊ฐ‘ ํ™œ์„ฑํ™”", + "description": "๋ณผํŠธ ๊ณ„์ •์˜ ์ง€๊ฐ‘ ํ™œ์„ฑํ™”๋ฅผ ์‹œ์ž‘ํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Vaults" + ], + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "๋ฐ˜ํ™˜ํ•  ๋ณผํŠธ ๊ณ„์ •์˜ ID ๋˜๋Š” ๊ธฐ๋ณธ ๋ณผํŠธ ๊ณ„์ •์˜ ๊ฒฝ์šฐ '๊ธฐ๋ณธ๊ฐ’'", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "์ž์‚ฐ์˜ ID", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "์ข‹์•„์š”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateVaultAssetResponse" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/set_customer_ref_id": { + "post": { + "summary": "๋ณผํŠธ ๊ณ„์ •์— ๋Œ€ํ•œ AML/KYT ๊ณ ๊ฐ ์ฐธ์กฐ ID ์„ค์ •", + "description": "๋ณผํŠธ ๊ณ„์ •์— ๋Œ€ํ•œ AML/KYT ๊ณ ๊ฐ ์ฐธ์กฐ ID๋ฅผ ํ• ๋‹นํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAsset = fireblocks.set_vault_account_customer_ref_id(vault_account_id, customer_ref_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAsset = await fireblocks.setCustomerRefIdForVaultAccount(vaultAccountId, customerRefId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "๋ณผํŠธ ๊ณ„์ • ID", + "schema": { + "type": "string", + "minimum": 1, + "format": "numeric", + "x-fb-entity": "vault_account" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "customerRefId": { + "description": "๊ณ ๊ฐ ์ฐธ์กฐ ID", + "type": "string" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "์ข‹์•„์š”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/set_auto_fuel": { + "post": { + "summary": "์ž๋™ ์—ฐ๋ฃŒ ๊ณต๊ธ‰ ์ผœ๊ธฐ ๋˜๋Š” ๋„๊ธฐ", + "description": "๋ณผํŠธ ๊ณ„์ •์˜ ์ž๋™ ์—ฐ๋ฃŒ ๊ณต๊ธ‰ ์†์„ฑ์„ ํ™œ์„ฑํ™” ๋˜๋Š” ๋น„ํ™œ์„ฑํ™”๋กœ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Vaults" + ], + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "๋ณผํŠธ ๊ณ„์ • ID", + "schema": { + "type": "string", + "minimum": 1, + "format": "numeric", + "x-fb-entity": "vault_account" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "autoFuel": { + "description": "์ž๋™์ฐจ ์—ฐ๋ฃŒ", + "type": "boolean" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "์ข‹์•„์š”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}": { + "get": { + "summary": "๊ธˆ๊ณ  ๊ณ„์ •์˜ ์ž์‚ฐ ์ž”์•ก์„ ์–ป์œผ์„ธ์š”", + "description": "๋ณผํŠธ ๊ณ„์ •์˜ ํŠน์ • ์ž์‚ฐ์— ๋Œ€ํ•œ ์ง€๊ฐ‘์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAsset = fireblocks.get_vault_account_asset(vault_account_id, asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAsset = await fireblocks.getVaultAccountAsset(vaultAccountId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "๋ฐ˜ํ™˜ํ•  ๋ณผํŠธ ๊ณ„์ •์˜ ID", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "์ž์‚ฐ์˜ ID", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "VaultAsset ๊ฐ์ฒด", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/VaultAsset" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "์ƒˆ๋กœ์šด ์ง€๊ฐ‘์„ ๋งŒ๋“œ์„ธ์š”", + "description": "๋ณผํŠธ ๊ณ„์ •์˜ ํŠน์ • ์ž์‚ฐ์— ๋Œ€ํ•œ ์ง€๊ฐ‘์„ ์ƒ์„ฑํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAsset = fireblocks.create_vault_asset(vault_account_id, asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAsset = await fireblocks.createVaultAsset(vaultAccountId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "๋ฐ˜ํ™˜ํ•  ๋ณผํŠธ ๊ณ„์ •์˜ ID ๋˜๋Š” ๊ธฐ๋ณธ ๋ณผํŠธ ๊ณ„์ •์˜ ๊ฒฝ์šฐ '๊ธฐ๋ณธ๊ฐ’'", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "์ž์‚ฐ์˜ ID", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "eosAccountName": { + "description": "์„ ํƒ ์‚ฌํ•ญ - EOS ์ง€๊ฐ‘์„ ์ƒ์„ฑํ•  ๋•Œ ๊ณ„์ • ์ด๋ฆ„์ž…๋‹ˆ๋‹ค. ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ์ž„์˜์˜ ์ด๋ฆ„์ด ์ƒ์„ฑ๋ฉ๋‹ˆ๋‹ค.", + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "์ข‹์•„์š”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateVaultAssetResponse" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/balance": { + "post": { + "summary": "์ž์‚ฐ ์ž”์•ก ๋ฐ์ดํ„ฐ ์ƒˆ๋กœ ๊ณ ์นจ", + "description": "๋ณผํŠธ ๊ณ„์ •์˜ ํŠน์ • ์ž์‚ฐ ์ž”์•ก์„ ์—…๋ฐ์ดํŠธํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAsset = fireblocks.refresh_vault_asset_balance(vault_account_id, asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAsset = await fireblocks.refreshVaultAssetBalance(vaultAccountId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "๋ฐ˜ํ™˜ํ•  ๋ณผํŠธ ๊ณ„์ •์˜ ID", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "์ž์‚ฐ์˜ ID", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "requestBody": { + "required": false, + "content": { + "*/*": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "VaultAsset ๊ฐ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/VaultAsset" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/addresses": { + "get": { + "summary": "์ž์‚ฐ ์ฃผ์†Œ ๊ฐ€์ ธ์˜ค๊ธฐ", + "description": "๊ธˆ๊ณ  ๊ณ„์ •์˜ ํŠน์ • ์ž์‚ฐ์— ๋Œ€ํ•œ ๋ชจ๋“  ์ฃผ์†Œ๋ฅผ ๋‚˜์—ดํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "depositAddresses = fireblocks.get_deposit_addresses(vault_account_id, asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const depositAddresses = await fireblocks.getDepositAddresses(vaultAccountId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "๋ฐ˜ํ™˜ํ•  ๋ณผํŠธ ๊ณ„์ •์˜ ID", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "์ž์‚ฐ์˜ ID", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "์ž…๊ธˆ์ฃผ์†Œ ๋ชฉ๋ก", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VaultWalletAddress" + } + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "์‹ ๊ทœ ์ž์‚ฐ ์ž…๊ธˆ ์ฃผ์†Œ ์ƒ์„ฑ", + "description": "๊ธˆ๊ณ  ๊ณ„์ •์˜ ์ž์‚ฐ์— ๋Œ€ํ•œ ์ƒˆ๋กœ์šด ์ž…๊ธˆ ์ฃผ์†Œ๋ฅผ ์ƒ์„ฑํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "address = fireblocks.generate_new_address(vault_account_id, asset_id, description, customer_ref_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const address = await fireblocks.generateNewAddress(vaultAccountId, assetId, description, customerRefId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "description": { + "description": "(์„ ํƒ ์‚ฌํ•ญ) ์ƒˆ ์ฃผ์†Œ์— ์„ค๋ช…์„ ์ฒจ๋ถ€ํ•˜์„ธ์š”", + "type": "string" + }, + "customerRefId": { + "description": "์„ ํƒ ์‚ฌํ•ญ - ๊ณ ๊ฐ ์ฐธ์กฐ ID๋ฅผ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค.", + "type": "string" + } + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "๋ฐ˜ํ™˜ํ•  ๋ณผํŠธ ๊ณ„์ •์˜ ID", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "์ž์‚ฐ์˜ ID", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "์ƒ์„ฑ๋œ ์ฃผ์†Œ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateAddressResponse" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/max_spendable_amount": { + "get": { + "summary": "๋‹จ์ผ ๊ฑฐ๋ž˜์—์„œ ์ตœ๋Œ€ ์ง€์ถœ ๊ฐ€๋Šฅ ๊ธˆ์•ก์„ ์–ป์œผ์„ธ์š”.", + "description": "์ง€์ •๋œ ๋ณผํŠธ ๊ณ„์ •์—์„œ ๋‹จ์ผ ๊ฑฐ๋ž˜์—์„œ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ๋Š” ํŠน์ • ์ž์‚ฐ์˜ ์ตœ๋Œ€ ๊ธˆ์•ก์„ ๊ฐ€์ ธ์˜ต๋‹ˆ๋‹ค(UTXO ์ž์‚ฐ๋งŒ, ์ž„๋ฒ ๋””๋“œ ์ž…๋ ฅ ์ˆ˜์— ์ œํ•œ์ด ์žˆ์Œ). ์ตœ๋Œ€ ์‚ฌ์šฉ ๊ฐ€๋Šฅ ๊ธˆ์•ก ์ด์ƒ์„ ์‚ฌ์šฉํ•˜๋ ค๋Š” ๊ฒฝ์šฐ ์—ฌ๋Ÿฌ ๊ฑฐ๋ž˜๋ฅผ ๋ณด๋ƒ…๋‹ˆ๋‹ค..", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "address = fireblocks.set_address_description(vault_account_id, asset_id, address, tag, description)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const address = await fireblocks.setAddressDescription(vaultAccountId, assetId, address, tag, description);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "๋ณผํŠธ ๊ณ„์ •์˜ ID ๋˜๋Š” ๊ธฐ๋ณธ ๋ณผํŠธ ๊ณ„์ •์˜ ๊ฒฝ์šฐ '๊ธฐ๋ณธ๊ฐ’'", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "์ž์‚ฐ์˜ ID", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + }, + { + "in": "query", + "name": "manualSignging", + "required": false, + "description": "๊ธฐ๋ณธ์ ์œผ๋กœ False์ž…๋‹ˆ๋‹ค. ์ตœ๋Œ€ ์ž…๋ ฅ ์ˆ˜๋Š” ๊ฑฐ๋ž˜๊ฐ€ ์ž๋™ํ™”๋œ ๊ณต๋™ ์„œ๋ช…์ž ์„œ๋ฒ„ ๋˜๋Š” ๋ชจ๋ฐ”์ผ ๊ธฐ๊ธฐ์—์„œ ์„œ๋ช…๋˜๋Š”์ง€ ์—ฌ๋ถ€์— ๋”ฐ๋ผ ๋‹ฌ๋ผ์ง‘๋‹ˆ๋‹ค..", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "์ข‹์•„์š”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}": { + "put": { + "summary": "์ฃผ์†Œ ์„ค๋ช… ์—…๋ฐ์ดํŠธ", + "description": "๋ณผํŠธ ๊ณ„์ •์˜ ์ž์‚ฐ์— ๋Œ€ํ•œ ๊ธฐ์กด ์ฃผ์†Œ ์„ค๋ช…์„ ์—…๋ฐ์ดํŠธํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "address = fireblocks.set_address_description(vault_account_id, asset_id, address, tag, description)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const address = await fireblocks.setAddressDescription(vaultAccountId, assetId, address, tag, description);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "description": { + "description": "์ฃผ์†Œ ์„ค๋ช…", + "type": "string" + } + } + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "๋ณผํŠธ ๊ณ„์ •์˜ ID", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "์ž์‚ฐ์˜ ID", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + }, + { + "in": "path", + "name": "addressId", + "required": true, + "description": "์„ค๋ช…์„ ์ถ”๊ฐ€ํ•  ์ฃผ์†Œ์ž…๋‹ˆ๋‹ค. XRP์˜ ๊ฒฝ์šฐ ๋‹ค์Œ์„ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค.
: , ๋‹ค๋ฅธ ๋ชจ๋“  ์ž์‚ฐ์˜ ๊ฒฝ์šฐ ์ฃผ์†Œ๋งŒ ์‚ฌ์šฉํ•˜์„ธ์š”.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "201": { + "description": "์ข‹์•„์š”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/set_customer_ref_id": { + "post": { + "summary": "AML ๊ณ ๊ฐ ์ฐธ์กฐ ID ์ง€์ •", + "description": "ํŠน์ • ์ฃผ์†Œ์— ๋Œ€ํ•œ AML/KYT ๊ณ ๊ฐ ์ฐธ์กฐ ID๋ฅผ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAsset = fireblocks.set_customer_ref_id_for_address(vault_account_id, asset_id, address_id, customer_ref_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAsset = await fireblocks.setCustomerRefIdForAddress(vaultAccountId, assetId, addressId, customerRefId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "๋ณผํŠธ ๊ณ„์ •์˜ ID", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "์ž์‚ฐ์˜ ID", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + }, + { + "in": "path", + "name": "addressId", + "required": true, + "description": "์„ค๋ช…์„ ์ถ”๊ฐ€ํ•  ์ฃผ์†Œ์ž…๋‹ˆ๋‹ค. XRP์˜ ๊ฒฝ์šฐ ๋‹ค์Œ์„ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค.
: , ๋‹ค๋ฅธ ๋ชจ๋“  ์ž์‚ฐ์˜ ๊ฒฝ์šฐ ์ฃผ์†Œ๋งŒ ์‚ฌ์šฉํ•˜์„ธ์š”.", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "customerRefId": { + "description": "๊ณ ๊ฐ ์ฐธ์กฐ ID", + "type": "string" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "์ข‹์•„์š”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/create_legacy": { + "post": { + "summary": "Segwit ์ฃผ์†Œ๋ฅผ ๋ ˆ๊ฑฐ์‹œ ํ˜•์‹์œผ๋กœ ๋ณ€ํ™˜", + "description": "๊ธฐ์กด segwit ์ฃผ์†Œ๋ฅผ ๋ ˆ๊ฑฐ์‹œ ํ˜•์‹์œผ๋กœ ๋ณ€ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Vaults" + ], + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "๋ณผํŠธ ๊ณ„์ •์˜ ID", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "์ž์‚ฐ์˜ ID", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + }, + { + "in": "path", + "name": "addressId", + "required": true, + "description": "๋ฒˆ์—ญํ•  segwit ์ฃผ์†Œ", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "์ƒ์„ฑ๋œ ์ฃผ์†Œ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateAddressResponse" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/unspent_inputs": { + "get": { + "summary": "UTXO ๋ฏธ์‚ฌ์šฉ ์ž…๋ ฅ ์ •๋ณด ๊ฐ€์ ธ์˜ค๊ธฐ", + "description": "๋ณผํŠธ ๊ณ„์ •์˜ ์ž์‚ฐ์— ๋Œ€ํ•œ ์‚ฌ์šฉ๋˜์ง€ ์•Š์€ ์ž…๋ ฅ ์ •๋ณด๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "vaultAsset = fireblocks.get_unspent_inputs(vault_account_id, asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const vaultAsset = await fireblocks.getUnspentInputs(vaultAccountId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "description": "๋ณผํŠธ ๊ณ„์ •์˜ ID", + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "์ž์‚ฐ์˜ ID", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "์ž…๋ ฅ๋‹น ์‚ฌ์šฉ๋˜์ง€ ์•Š์€ ์ •๋ณด ๋ชฉ๋ก", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UnspentInputsResponse" + } + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/public_key_info/": { + "get": { + "summary": "๊ณต๊ฐœ ํ‚ค ์ •๋ณด๋ฅผ ์–ป์œผ์„ธ์š”", + "description": "ํŒŒ์ƒ ๊ฒฝ๋กœ ๋ฐ ์„œ๋ช… ์•Œ๊ณ ๋ฆฌ์ฆ˜์„ ๊ธฐ๋ฐ˜์œผ๋กœ ๊ณต๊ฐœ ํ‚ค ์ •๋ณด๋ฅผ ๊ฐ€์ ธ์˜ต๋‹ˆ๋‹ค..", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "pubKey = fireblocks.get_public_key_info(algorithm, derivation_path, compressed)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const PublicKeyInfoArgs = { algorithm: 'MPC_ECDSA_SECP256K1', derivationPath: '[44,0,0,0,0]' } const pubKey = await fireblocks.getPublicKeyInfo(PublicKeyInfoArgs);\n", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "query", + "name": "derivationPath", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "algorithm", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "compressed", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "๊ณต๊ฐœ ํ‚ค ์ •๋ณด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PublicKeyInformation" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/accounts/{vaultAccountId}/{assetId}/{change}/{addressIndex}/public_key_info": { + "get": { + "summary": "๋ณผํŠธ ๊ณ„์ •์˜ ๊ณต๊ฐœ ํ‚ค ๊ฐ€์ ธ์˜ค๊ธฐ", + "description": "๋ณผํŠธ ๊ณ„์ •์— ๋Œ€ํ•œ ๊ณต๊ฐœ ํ‚ค ์ •๋ณด๋ฅผ ๊ฐ€์ ธ์˜ต๋‹ˆ๋‹ค..", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "pubKey = fireblocks.get_public_key_info_for_vault_account(asset_id, vault_account_id, change, address_index, compressed)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const PublicKeyInfoArgs = { assetId: 'ETH', vaultAccountId: 0, change: 0, addressIndex: 0, compressed: true } const pubKey = await fireblocks.getPublicKeyInfoForVaultAccount(PublicKeyInfoArgs);\n", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "vaultAccountId", + "required": true, + "schema": { + "type": "string", + "format": "numeric", + "x-fb-entity": "vault_account" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + }, + { + "in": "path", + "name": "change", + "required": true, + "schema": { + "type": "number" + } + }, + { + "in": "path", + "name": "addressIndex", + "required": true, + "schema": { + "type": "number" + } + }, + { + "in": "query", + "name": "compressed", + "required": false, + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "๊ณต๊ฐœ ํ‚ค ์ •๋ณด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PublicKeyInformation" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/assets": { + "get": { + "summary": "์„ ํƒํ•œ ์ž์‚ฐ์— ๋Œ€ํ•œ ์ž์‚ฐ ์ž”์•ก์„ ์–ป์œผ์„ธ์š”", + "description": "๋ชจ๋“  ๊ณ„์ • ๋˜๋Š” ํ•„ํ„ฐ๋ง๋œ ๊ณ„์ •์— ๋Œ€ํ•œ ์ž์‚ฐ ๊ธˆ์•ก ์š”์•ฝ์„ ๊ฐ€์ ธ์˜ต๋‹ˆ๋‹ค..", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "assets_balance = fireblocks.get_vault_assets_balance(accout_name_prefix, account_name_suffix)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const assetsBalance = await fireblocks.getVaultAssetsBalance(accountNamePrefix, accountNameSuffix);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "query", + "name": "accountNamePrefix", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "accountNameSuffix", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "์ž์‚ฐ๋ณ„ ๊ธˆ์•ก", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VaultAsset" + } + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/vault/assets/{assetId}": { + "get": { + "summary": "์ž์‚ฐ๋ณ„ ๊ธˆ๊ณ  ์ž”์•ก ๊ฐ€์ ธ์˜ค๊ธฐ", + "description": "์ž์‚ฐ์— ๋Œ€ํ•œ ๋ณผํŠธ ์ž”์•ก ์š”์•ฝ์„ ๊ฐ€์ ธ์˜ต๋‹ˆ๋‹ค..", + "tags": [ + "Vaults" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "assets_balance = fireblocks.get_vault_balance_by_asset(asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const assetsBalance = await fireblocks.getVaultBalanceByAsset(assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "assetId", + "required": true, + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "์ž์‚ฐ๋ณ„ ๊ธˆ๊ณ  ๊ธˆ์•ก", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/VaultAsset" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/exchange_accounts": { + "get": { + "summary": "๊ฑฐ๋ž˜์†Œ ๊ณ„์ • ๋ชฉ๋ก", + "description": "๋ชจ๋“  ๊ฑฐ๋ž˜์†Œ ๊ณ„์ •์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค.", + "tags": [ + "Exchange accounts" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "exchangeAccounts = fireblocks.get_exchange_accounts()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const exchangeAccounts = await fireblocks.getExchangeAccounts();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "ExchangeAccount ๊ฐœ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExchangeAccount" + } + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/exchange_accounts/{exchangeAccountId}": { + "get": { + "summary": "ํŠน์ • ๊ฑฐ๋ž˜์†Œ ๊ณ„์ • ์ฐพ๊ธฐ", + "description": "ID๋กœ ๊ฑฐ๋ž˜์†Œ ๊ณ„์ •์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Exchange accounts" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "exchangeAccount = fireblocks.get_exchange_account(exchangeAccountId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const exchnageAccount = await fireblocks.get_exchange_account(exchangeAccountId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "exchangeAccountId", + "required": true, + "description": "๋ฐ˜ํ™˜ํ•  ๊ฑฐ๋ž˜์†Œ ๊ณ„์ •์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ExchangeAccount ๊ฐœ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ExchangeAccount" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/exchange_accounts/{exchangeAccountId}/internal_transfer": { + "post": { + "summary": "๊ฑฐ๋ž˜์†Œ ๊ณ„์ขŒ ๋‚ด๋ถ€ ์ด์ฒด", + "description": "๋™์ผํ•œ ๊ฑฐ๋ž˜์†Œ ๊ณ„์ • ๋‚ด์˜ ๊ฑฐ๋ž˜ ๊ณ„์ • ๊ฐ„์— ์ž๊ธˆ์„ ์ด์ฒดํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Exchange accounts" + ], + "parameters": [ + { + "in": "path", + "name": "exchangeAccountId", + "required": true, + "description": "๋ฐ˜ํ™˜ํ•  ๊ฑฐ๋ž˜์†Œ ๊ณ„์ •์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "201": { + "description": "์ „์†ก์ด ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "asset": { + "type": "string" + }, + "amount": { + "type": "string" + }, + "sourceType": { + "$ref": "#/components/schemas/TradingAccountType" + }, + "destType": { + "$ref": "#/components/schemas/TradingAccountType" + } + } + } + } + } + } + } + }, + "/exchange_accounts/{exchangeAccountId}/convert": { + "post": { + "summary": "์†Œ์Šค ์ž์‚ฐ์—์„œ ๋ชฉ์ ์ง€ ์ž์‚ฐ์œผ๋กœ ๊ฑฐ๋ž˜์†Œ ๊ณ„์ • ์ž๊ธˆ์„ ๋ณ€ํ™˜ํ•ฉ๋‹ˆ๋‹ค. Coinbase(USD์—์„œ USDC, USDC์—์„œ USD) ๋ฐ Bitso(MXN์—์„œ USD)๊ฐ€ ์ง€์›๋˜๋Š” ๋ณ€ํ™˜์ž…๋‹ˆ๋‹ค..", + "tags": [ + "Exchange accounts" + ], + "parameters": [ + { + "in": "path", + "name": "exchangeAccountId", + "required": true, + "description": "๊ฑฐ๋ž˜์†Œ ๊ณ„์ •์˜ ID์ž…๋‹ˆ๋‹ค. ๊ฑฐ๋ž˜์†Œ๊ฐ€ ๋ณ€ํ™˜์„ ์ง€์›ํ•˜๋Š”์ง€ ํ™•์ธํ•˜์„ธ์š”. ๊ฑฐ๋ž˜์†Œ ๊ณ„์ •์˜ ID๋ฅผ ์ฐพ์œผ๋ ค๋ฉด GET/exchange_accounts๋ฅผ ์‚ฌ์šฉํ•˜์„ธ์š”..", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "๋ณ€ํ™˜ ์„ฑ๊ณต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "srcAsset": { + "type": "string", + "description": "์†Œ์Šค ์ž์‚ฐ์˜ ์ด๋ฆ„(์„ ํƒํ•œ ๊ฑฐ๋ž˜์†Œ ์œ ํ˜•์—์„œ ๋ณ€ํ™˜์ด ์ง€์›๋˜๋Š” ํ†ตํ™”์—ฌ์•ผ ํ•˜๋ฉฐ ๊ฑฐ๋ž˜์†Œ ID์— ํ•ด๋‹นํ•ด์•ผ ํ•จ)" + }, + "destAsset": { + "type": "string", + "description": "๋Œ€์ƒ ์ž์‚ฐ์˜ ์ด๋ฆ„(์„ ํƒํ•œ ๊ฑฐ๋ž˜์†Œ ์œ ํ˜•์—์„œ ๋ณ€ํ™˜์ด ์ง€์›๋˜๋Š” ํ†ตํ™”์—ฌ์•ผ ํ•˜๋ฉฐ ๊ฑฐ๋ž˜์†Œ ID์— ํ•ด๋‹นํ•ด์•ผ ํ•จ)" + }, + "amount": { + "type": "number", + "description": "์ด์ฒดํ•  ๊ธˆ์•ก(์†Œ์Šค ์ž์‚ฐ์˜ ํ†ตํ™”๋กœ)" + } + }, + "required": [ + "srcAsset", + "destAsset", + "amount" + ] + } + } + } + } + } + }, + "/exchange_accounts/{exchangeAccountId}/{assetId}": { + "get": { + "summary": "๊ตํ™˜ ๊ณ„์ขŒ์— ๋Œ€ํ•œ ์ž์‚ฐ ์ฐพ๊ธฐ", + "description": "๊ตํ™˜ ๊ณ„์ •์— ๋Œ€ํ•œ ์ž์‚ฐ์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Exchange accounts" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "exchangeAsset = fireblocks.get_exchange_account_asset(exchangeAccountId, assetId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const exchangeAsset = await fireblocks.getExchangeAsset(exchangeAccountId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "exchangeAccountId", + "required": true, + "description": "๋ฐ˜ํ™˜ํ•  ๊ฑฐ๋ž˜์†Œ ๊ณ„์ •์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "๋ฐ˜ํ™˜ํ•  ์ž์‚ฐ์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ExchangeAccountAsset ๊ฐœ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ExchangeAsset" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/fiat_accounts": { + "get": { + "summary": "๋ฒ•์ •ํ™”ํ ๊ณ„์ขŒ ๋ชฉ๋ก", + "description": "๋ชจ๋“  ๋ฒ•์ • ํ†ตํ™” ๊ณ„์ •์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Fiat accounts" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "transactions = fireblocks.get_fiat_accounts()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const transactions = await fireblocks.getFiatAccounts();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "๋ฒ•์ • ํ†ตํ™” ๊ณ„์ • ๊ฐ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FiatAccount" + } + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/fiat_accounts/{accountId}": { + "get": { + "summary": "ํŠน์ • ๋ฒ•์ • ํ†ตํ™” ๊ณ„์ขŒ ์ฐพ๊ธฐ", + "description": "ID๋กœ ๋ฒ•์ •ํ™”ํ ๊ณ„์ •์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Fiat accounts" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "transactions = fireblocks.get_fiat_account_by_id(account_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const transactions = await fireblocks.getFiatAccountById(accountId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "accountId", + "required": true, + "description": "๋ฐ˜ํ™˜ํ•  Fiat ๊ณ„์ •์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "๋ฒ•์ • ํ†ตํ™” ๊ณ„์ • ๊ฐ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/FiatAccount" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/fiat_accounts/{accountId}/redeem_to_linked_dda": { + "post": { + "summary": "DDA์— ์ž๊ธˆ์„ ํ™˜์ˆ˜ํ•ฉ๋‹ˆ๋‹ค", + "description": "์—ฐ๊ฒฐ๋œ DDA์— ์ž๊ธˆ์„ ํ™˜์ˆ˜ํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Fiat accounts" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "transactions = fireblocks.redeem_to_linked_dda(account_id, amount)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const transactions = await fireblocks.redeemToLinkedDDA(accountId, amount);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "accountId", + "required": true, + "description": "์‚ฌ์šฉํ•  Fiat ๊ณ„์ •์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "201": { + "description": "์ „์†ก์ด ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "amount": { + "type": "number" + } + } + } + } + } + } + } + }, + "/fiat_accounts/{accountId}/deposit_from_linked_dda": { + "post": { + "summary": "DDA์—์„œ ์ž๊ธˆ ์ž…๊ธˆ", + "description": "์—ฐ๊ณ„๋œ DDA์—์„œ ์ž๊ธˆ์„ ์ž…๊ธˆํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Fiat accounts" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "transactions = fireblocks.deposit_from_linked_dda(account_id, amount)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const transactions = await fireblocks.depositFromLinkedDDA(accountId, amount);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "accountId", + "required": true, + "description": "์‚ฌ์šฉํ•  Fiat ๊ณ„์ •์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "201": { + "description": "์ „์†ก์ด ์„ฑ๊ณตํ–ˆ์Šต๋‹ˆ๋‹ค", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "amount": { + "type": "number" + } + } + } + } + } + } + } + }, + "/network_connections": { + "get": { + "summary": "๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ ๋ชฉ๋ก", + "description": "๋ชจ๋“  ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค. **์ฐธ๊ณ :** ์ด API ํ˜ธ์ถœ์€ ์œ ์—ฐํ•œ ๋ผ์šฐํŒ… ์ฒด๊ณ„์˜ ์ ์šฉ์„ ๋ฐ›์Šต๋‹ˆ๋‹ค. ๋ผ์šฐํŒ… ์ •์ฑ…์€ ํŠธ๋žœ์žญ์…˜์ด ๋ผ์šฐํŒ…๋˜๋Š” ๋ฐฉ์‹์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค. ๊ฐ ์ž์‚ฐ ์œ ํ˜•์— ๋Œ€ํ•ด ์•„๋ž˜์— ์–ธ๊ธ‰๋œ 3๊ฐ€์ง€ ์ฒด๊ณ„ ์ค‘ ํ•˜๋‚˜๋ฅผ ์„ ํƒํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. - **์—†์Œ**: ํ•ด๋‹น ์ž์‚ฐ ์œ ํ˜•์— ๋Œ€ํ•œ ๋Œ€์ƒ ์—†์Œ์œผ๋กœ์˜ ํ”„๋กœํ•„ ๋ผ์šฐํŒ…์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค. `์—†์Œ`์œผ๋กœ ๋ผ์šฐํŒ…๋œ ์ž์‚ฐ ์œ ํ˜•์œผ๋กœ ๋“ค์–ด์˜ค๋Š” ํŠธ๋žœ์žญ์…˜์€ ์‹คํŒจํ•ฉ๋‹ˆ๋‹ค. - **์‚ฌ์šฉ์ž ์ง€์ •**: ์„ ํƒํ•œ ๊ณ„์ •์œผ๋กœ ๋ผ์šฐํŒ…ํ•ฉ๋‹ˆ๋‹ค. ๊ณ„์ •์„ ์ œ๊ฑฐํ•˜๋ฉด ๋‹ค๋ฅธ ๊ณ„์ •์„ ์„ ํƒํ•  ๋•Œ๊นŒ์ง€ ๋“ค์–ด์˜ค๋Š” ํŠธ๋žœ์žญ์…˜์€ ์‹คํŒจํ•ฉ๋‹ˆ๋‹ค. - **๊ธฐ๋ณธ๊ฐ’**: ์—ฐ๊ฒฐ์ด ์—ฐ๊ฒฐ๋œ ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„์—์„œ ์ง€์ •ํ•œ ๋ผ์šฐํŒ…์„ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค. ์ด ์ฒด๊ณ„๋Š” "ํ”„๋กœํ•„ ๋ผ์šฐํŒ…"์ด๋ผ๊ณ ๋„ ํ•ฉ๋‹ˆ๋‹ค. ๊ธฐ๋ณธ ์ž‘์—… ๊ณต๊ฐ„ ์‚ฌ์ „ ์„ค์ •: - ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„ ์•”ํ˜ธํ™” โ†’ **์‚ฌ์šฉ์ž ์ง€์ •** - ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„ FIAT โ†’ **์—†์Œ** - ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ ์•”ํ˜ธํ™” โ†’ **๊ธฐ๋ณธ๊ฐ’** - ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ FIAT โ†’ **๊ธฐ๋ณธ๊ฐ’** - **์ฐธ๊ณ **: ๊ธฐ๋ณธ์ ์œผ๋กœ ์‚ฌ์šฉ์ž ์ง€์ • ๋ผ์šฐํŒ… ์ฒด๊ณ„๋Š” (`dstId` = `0`, `dstType` = `VAULT`)๋ฅผ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Network connections" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "network_connections = fireblocks.get_network_connections()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const networkConnections = await fireblocks.getNetworkConnections();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ ๋ชฉ๋ก", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkConnectionResponse" + } + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "์ƒˆ๋กœ์šด ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ์„ ๋งŒ๋“ญ๋‹ˆ๋‹ค", + "description": "์ƒˆ ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ์„ ์‹œ์ž‘ํ•ฉ๋‹ˆ๋‹ค. **์ฐธ๊ณ :** ์ด API ํ˜ธ์ถœ์€ ์œ ์—ฐํ•œ ๋ผ์šฐํŒ… ์ฒด๊ณ„์˜ ์ ์šฉ์„ ๋ฐ›์Šต๋‹ˆ๋‹ค. ๋ผ์šฐํŒ… ์ •์ฑ…์€ ๊ฑฐ๋ž˜๊ฐ€ ๋ผ์šฐํŒ…๋˜๋Š” ๋ฐฉ์‹์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค. ๊ฐ ์ž์‚ฐ ์œ ํ˜•์— ๋Œ€ํ•ด ์•„๋ž˜์— ์–ธ๊ธ‰๋œ 3๊ฐ€์ง€ ์ฒด๊ณ„ ์ค‘ ํ•˜๋‚˜๋ฅผ ์„ ํƒํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. - **์—†์Œ**: ํ•ด๋‹น ์ž์‚ฐ ์œ ํ˜•์— ๋Œ€ํ•œ ๋Œ€์ƒ ์—†์Œ์œผ๋กœ์˜ ํ”„๋กœํ•„ ๋ผ์šฐํŒ…์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค. `์—†์Œ`์œผ๋กœ ๋ผ์šฐํŒ…๋œ ์ž์‚ฐ ์œ ํ˜•์œผ๋กœ ๋“ค์–ด์˜ค๋Š” ๊ฑฐ๋ž˜๋Š” ์‹คํŒจํ•ฉ๋‹ˆ๋‹ค. - **์‚ฌ์šฉ์ž ์ง€์ •**: ์„ ํƒํ•œ ๊ณ„์ •์œผ๋กœ ๋ผ์šฐํŒ…ํ•ฉ๋‹ˆ๋‹ค. ๊ณ„์ •์„ ์ œ๊ฑฐํ•˜๋ฉด ๋‹ค๋ฅธ ๊ณ„์ •์„ ์„ ํƒํ•  ๋•Œ๊นŒ์ง€ ๋“ค์–ด์˜ค๋Š” ๊ฑฐ๋ž˜๋Š” ์‹คํŒจํ•ฉ๋‹ˆ๋‹ค. - **๊ธฐ๋ณธ๊ฐ’**: ์—ฐ๊ฒฐ์ด ์—ฐ๊ฒฐ๋œ ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„์—์„œ ์ง€์ •ํ•œ ๋ผ์šฐํŒ…์„ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค. ์ด ์ฒด๊ณ„๋Š” "ํ”„๋กœํ•„ ๋ผ์šฐํŒ…"์ด๋ผ๊ณ ๋„ ํ•ฉ๋‹ˆ๋‹ค. ๊ธฐ๋ณธ ์ž‘์—… ๊ณต๊ฐ„ ์‚ฌ์ „ ์„ค์ •: - ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„ ์•”ํ˜ธํ™” โ†’ **์‚ฌ์šฉ์ž ์ง€์ •** - ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„ FIAT โ†’ **์—†์Œ** - ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ ์•”ํ˜ธํ™” โ†’ **๊ธฐ๋ณธ๊ฐ’** - ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ FIAT โ†’ **๊ธฐ๋ณธ๊ฐ’** - **์ฐธ๊ณ **: ๊ธฐ๋ณธ์ ์œผ๋กœ ์‚ฌ์šฉ์ž ์ง€์ • ๋ผ์šฐํŒ… ์ฒด๊ณ„๋Š” (`dstId` = `0`, `dstType` = `VAULT`)๋ฅผ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Network connections" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NetworkConnection" + } + } + } + }, + "responses": { + "201": { + "description": "๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ ๊ฐœ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/NetworkConnectionResponse" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/network_connections/{connectionId}/set_routing_policy": { + "patch": { + "summary": "๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ ๋ผ์šฐํŒ… ์ •์ฑ… ์—…๋ฐ์ดํŠธ.", + "description": "๊ธฐ์กด ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ์˜ ๋ผ์šฐํŒ… ์ •์ฑ…์„ ์—…๋ฐ์ดํŠธํ•ฉ๋‹ˆ๋‹ค. **์ฐธ๊ณ :** ์ด API ํ˜ธ์ถœ์€ ์œ ์—ฐํ•œ ๋ผ์šฐํŒ… ์ฒด๊ณ„์˜ ์ ์šฉ์„ ๋ฐ›์Šต๋‹ˆ๋‹ค. ๋ผ์šฐํŒ… ์ •์ฑ…์€ ํŠธ๋žœ์žญ์…˜์ด ๋ผ์šฐํŒ…๋˜๋Š” ๋ฐฉ์‹์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค. ๊ฐ ์ž์‚ฐ ์œ ํ˜•์— ๋Œ€ํ•ด ์•„๋ž˜์— ์–ธ๊ธ‰๋œ 3๊ฐ€์ง€ ์ฒด๊ณ„ ์ค‘ ํ•˜๋‚˜๋ฅผ ์„ ํƒํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. - **์—†์Œ**: ํ•ด๋‹น ์ž์‚ฐ ์œ ํ˜•์— ๋Œ€ํ•œ ๋Œ€์ƒ ์—†์Œ์œผ๋กœ์˜ ํ”„๋กœํ•„ ๋ผ์šฐํŒ…์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค. `์—†์Œ`์œผ๋กœ ๋ผ์šฐํŒ…๋œ ์ž์‚ฐ ์œ ํ˜•์œผ๋กœ ๋“ค์–ด์˜ค๋Š” ํŠธ๋žœ์žญ์…˜์€ ์‹คํŒจํ•ฉ๋‹ˆ๋‹ค. - **์‚ฌ์šฉ์ž ์ง€์ •**: ์„ ํƒํ•œ ๊ณ„์ •์œผ๋กœ ๋ผ์šฐํŒ…ํ•ฉ๋‹ˆ๋‹ค. ๊ณ„์ •์„ ์ œ๊ฑฐํ•˜๋ฉด ๋‹ค๋ฅธ ๊ณ„์ •์„ ์„ ํƒํ•  ๋•Œ๊นŒ์ง€ ๋“ค์–ด์˜ค๋Š” ํŠธ๋žœ์žญ์…˜์€ ์‹คํŒจํ•ฉ๋‹ˆ๋‹ค. - **๊ธฐ๋ณธ๊ฐ’**: ์—ฐ๊ฒฐ์ด ์—ฐ๊ฒฐ๋œ ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„์—์„œ ์ง€์ •ํ•œ ๋ผ์šฐํŒ…์„ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค. ์ด ์ฒด๊ณ„๋Š” "ํ”„๋กœํ•„ ๋ผ์šฐํŒ…"์ด๋ผ๊ณ ๋„ ํ•ฉ๋‹ˆ๋‹ค. ๊ธฐ๋ณธ ์ž‘์—… ๊ณต๊ฐ„ ์‚ฌ์ „ ์„ค์ •: - ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„ ์•”ํ˜ธํ™” โ†’ **์‚ฌ์šฉ์ž ์ง€์ •** - ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„ FIAT โ†’ **์—†์Œ** - ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ ์•”ํ˜ธํ™” โ†’ **๊ธฐ๋ณธ๊ฐ’** - ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ FIAT โ†’ **๊ธฐ๋ณธ๊ฐ’** - **์ฐธ๊ณ **: ๊ธฐ๋ณธ์ ์œผ๋กœ ์‚ฌ์šฉ์ž ์ง€์ • ๋ผ์šฐํŒ… ์ฒด๊ณ„๋Š” (`dstId` = `0`, `dstType` = `VAULT`)๋ฅผ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Network connections" + ], + "parameters": [ + { + "in": "path", + "name": "connectionId", + "required": true, + "description": "๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "routingPolicy": { + "$ref": "#/components/schemas/NetworkConnectionRoutingPolicy" + } + }, + "required": [ + "routingPolicy" + ] + } + } + } + }, + "responses": { + "200": { + "description": "๋„คํŠธ์›Œํฌ ID", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "properties": { + "success": { + "type": "boolean" + } + }, + "required": [ + "success" + ] + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/network_connections/{connectionId}/is_third_party_routing/{assetType}": { + "get": { + "summary": "์ž์‚ฐ ์œ ํ˜•๋ณ„๋กœ ํƒ€์‚ฌ ๋„คํŠธ์›Œํฌ ๋ผ์šฐํŒ… ๊ฒ€์ฆ ๊ฒ€์ƒ‰.", + "description": "Fireblocks Network๋Š” ์œ ์ž… ์ž…๊ธˆ์— ๋Œ€ํ•œ ์œ ์—ฐ์„ฑ์„ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค. ์ˆ˜์‹ ์ž๋Š” Fireblocks ์™ธ์˜ ๋‹ค๋ฅธ ์œ„์น˜๋กœ ๋„คํŠธ์›Œํฌ ์ž…๊ธˆ์„ ์ˆ˜์‹ ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์ด ์—”๋“œํฌ์ธํŠธ๋Š” ํ–ฅํ›„ ๊ฑฐ๋ž˜๊ฐ€ ํ‘œ์‹œ๋œ ์ˆ˜์‹ ์ž์—๊ฒŒ ๋ผ์šฐํŒ…๋˜๋Š”์ง€ ์•„๋‹ˆ๋ฉด ์ œ3์ž์—๊ฒŒ ๋ผ์šฐํŒ…๋˜๋Š”์ง€ ๊ฒ€์ฆํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Network connections" + ], + "parameters": [ + { + "in": "path", + "name": "connectionId", + "required": true, + "description": "๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + }, + { + "in": "path", + "name": "assetType", + "required": true, + "description": "๋ชฉ์ ์ง€ ์ž์‚ฐ ์œ ํ˜•", + "schema": { + "oneOf": [ + { + "const": "CRYPTO" + }, + { + "const": "SIGNET" + }, + { + "const": "SEN" + }, + { + "const": "SIGNET_TEST" + }, + { + "const": "SEN_TEST" + } + ] + } + } + ], + "responses": { + "200": { + "description": "๊ฒ€์ฆ ๊ฒฐ๊ณผ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "properties": { + "isThirdPartyRouting": { + "type": "boolean" + }, + "description": { + "type": "string" + } + } + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/network_connections/{connectionId}": { + "get": { + "summary": "๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ์„ ์–ป์œผ์„ธ์š”", + "description": "ID๋กœ ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ์„ ๊ฐ€์ ธ์˜ต๋‹ˆ๋‹ค. **์ฐธ๊ณ :** ์ด API ํ˜ธ์ถœ์€ ์œ ์—ฐํ•œ ๋ผ์šฐํŒ… ์ฒด๊ณ„์˜ ์ ์šฉ์„ ๋ฐ›์Šต๋‹ˆ๋‹ค. ๋ผ์šฐํŒ… ์ •์ฑ…์€ ํŠธ๋žœ์žญ์…˜์ด ๋ผ์šฐํŒ…๋˜๋Š” ๋ฐฉ์‹์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค. ๊ฐ ์ž์‚ฐ ์œ ํ˜•์— ๋Œ€ํ•ด ์•„๋ž˜์— ์–ธ๊ธ‰๋œ 3๊ฐ€์ง€ ์ฒด๊ณ„ ์ค‘ ํ•˜๋‚˜๋ฅผ ์„ ํƒํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. - **์—†์Œ**: ํ•ด๋‹น ์ž์‚ฐ ์œ ํ˜•์— ๋Œ€ํ•œ ๋Œ€์ƒ ์—†์Œ์œผ๋กœ์˜ ํ”„๋กœํ•„ ๋ผ์šฐํŒ…์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค. `์—†์Œ`์œผ๋กœ ๋ผ์šฐํŒ…๋œ ์ž์‚ฐ ์œ ํ˜•์œผ๋กœ ๋“ค์–ด์˜ค๋Š” ํŠธ๋žœ์žญ์…˜์€ ์‹คํŒจํ•ฉ๋‹ˆ๋‹ค. - **์‚ฌ์šฉ์ž ์ง€์ •**: ์„ ํƒํ•œ ๊ณ„์ •์œผ๋กœ ๋ผ์šฐํŒ…ํ•ฉ๋‹ˆ๋‹ค. ๊ณ„์ •์„ ์ œ๊ฑฐํ•˜๋ฉด ๋‹ค๋ฅธ ๊ณ„์ •์„ ์„ ํƒํ•  ๋•Œ๊นŒ์ง€ ๋“ค์–ด์˜ค๋Š” ํŠธ๋žœ์žญ์…˜์€ ์‹คํŒจํ•ฉ๋‹ˆ๋‹ค. - **๊ธฐ๋ณธ๊ฐ’**: ์—ฐ๊ฒฐ์ด ์—ฐ๊ฒฐ๋œ ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„์—์„œ ์ง€์ •ํ•œ ๋ผ์šฐํŒ…์„ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค. ์ด ์ฒด๊ณ„๋Š” "ํ”„๋กœํ•„ ๋ผ์šฐํŒ…"์ด๋ผ๊ณ ๋„ ํ•ฉ๋‹ˆ๋‹ค. ๊ธฐ๋ณธ ์ž‘์—… ๊ณต๊ฐ„ ์‚ฌ์ „ ์„ค์ •: - ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„ ์•”ํ˜ธํ™” โ†’ **์‚ฌ์šฉ์ž ์ง€์ •** - ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„ FIAT โ†’ **์—†์Œ** - ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ ์•”ํ˜ธํ™” โ†’ **๊ธฐ๋ณธ๊ฐ’** - ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ FIAT โ†’ **๊ธฐ๋ณธ๊ฐ’** - **์ฐธ๊ณ **: ๊ธฐ๋ณธ์ ์œผ๋กœ ์‚ฌ์šฉ์ž ์ง€์ • ๋ผ์šฐํŒ… ์ฒด๊ณ„๋Š” (`dstId` = `0`, `dstType` = `VAULT`)๋ฅผ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Network connections" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "network_connection = fireblocks.get_network_connection_by_id(connectionId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const network_connection = await fireblocks.getNetworkConnection(connectionId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "connectionId", + "required": true, + "description": "์—ฐ๊ฒฐ์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/NetworkConnectionResponse" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "delete": { + "summary": "ID๋กœ ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ์„ ์‚ญ์ œํ•ฉ๋‹ˆ๋‹ค.", + "description": "์—ฐ๊ฒฐ ID๋กœ ์ง€์ •๋œ ๊ธฐ์กด ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ์„ ์‚ญ์ œํ•ฉ๋‹ˆ๋‹ค. **์ฐธ๊ณ :** ์ด API ํ˜ธ์ถœ์€ ์œ ์—ฐํ•œ ๋ผ์šฐํŒ… ์ฒด๊ณ„์˜ ์ ์šฉ์„ ๋ฐ›์Šต๋‹ˆ๋‹ค. ๋ผ์šฐํŒ… ์ •์ฑ…์€ ํŠธ๋žœ์žญ์…˜์ด ๋ผ์šฐํŒ…๋˜๋Š” ๋ฐฉ์‹์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค. ๊ฐ ์ž์‚ฐ ์œ ํ˜•์— ๋Œ€ํ•ด ์•„๋ž˜์— ์–ธ๊ธ‰๋œ 3๊ฐ€์ง€ ์ฒด๊ณ„ ์ค‘ ํ•˜๋‚˜๋ฅผ ์„ ํƒํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. - **์—†์Œ**: ํ•ด๋‹น ์ž์‚ฐ ์œ ํ˜•์— ๋Œ€ํ•œ ๋Œ€์ƒ ์—†์Œ์œผ๋กœ์˜ ํ”„๋กœํ•„ ๋ผ์šฐํŒ…์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค. `์—†์Œ`์œผ๋กœ ๋ผ์šฐํŒ…๋œ ์ž์‚ฐ ์œ ํ˜•์œผ๋กœ ๋“ค์–ด์˜ค๋Š” ํŠธ๋žœ์žญ์…˜์€ ์‹คํŒจํ•ฉ๋‹ˆ๋‹ค. - **์‚ฌ์šฉ์ž ์ง€์ •**: ์„ ํƒํ•œ ๊ณ„์ •์œผ๋กœ ๋ผ์šฐํŒ…ํ•ฉ๋‹ˆ๋‹ค. ๊ณ„์ •์„ ์ œ๊ฑฐํ•˜๋ฉด ๋‹ค๋ฅธ ๊ณ„์ •์„ ์„ ํƒํ•  ๋•Œ๊นŒ์ง€ ๋“ค์–ด์˜ค๋Š” ํŠธ๋žœ์žญ์…˜์€ ์‹คํŒจํ•ฉ๋‹ˆ๋‹ค. - **๊ธฐ๋ณธ๊ฐ’**: ์—ฐ๊ฒฐ์ด ์—ฐ๊ฒฐ๋œ ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„์—์„œ ์ง€์ •ํ•œ ๋ผ์šฐํŒ…์„ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค. ์ด ์ฒด๊ณ„๋Š” "ํ”„๋กœํ•„ ๋ผ์šฐํŒ…"์ด๋ผ๊ณ ๋„ ํ•ฉ๋‹ˆ๋‹ค. ๊ธฐ๋ณธ ์ž‘์—… ๊ณต๊ฐ„ ์‚ฌ์ „ ์„ค์ •: - ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„ ์•”ํ˜ธํ™” โ†’ **์‚ฌ์šฉ์ž ์ง€์ •** - ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„ FIAT โ†’ **์—†์Œ** - ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ ์•”ํ˜ธํ™” โ†’ **๊ธฐ๋ณธ๊ฐ’** - ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ FIAT โ†’ **๊ธฐ๋ณธ๊ฐ’** - **์ฐธ๊ณ **: ๊ธฐ๋ณธ์ ์œผ๋กœ ์‚ฌ์šฉ์ž ์ง€์ • ๋ผ์šฐํŒ… ์ฒด๊ณ„๋Š” (`dstId` = `0`, `dstType` = `VAULT`)๋ฅผ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Network connections" + ], + "parameters": [ + { + "in": "path", + "name": "connectionId", + "required": true, + "description": "์‚ญ์ œํ•  ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "๋„คํŠธ์›Œํฌ ID", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "properties": { + "success": { + "type": "boolean" + } + }, + "required": [ + "success" + ] + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/network_ids": { + "get": { + "summary": "๋กœ์ปฌ ID์™€ ๊ฒ€์ƒ‰ ๊ฐ€๋Šฅํ•œ ์›๊ฒฉ ID๋ฅผ ํฌํ•จํ•œ ๋ชจ๋“  ๋„คํŠธ์›Œํฌ ID๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค.", + "description": "๋ชจ๋“  ๋กœ์ปฌ ๋ฐ ๊ฒ€์ƒ‰ ๊ฐ€๋Šฅํ•œ ์›๊ฒฉ ๋„คํŠธ์›Œํฌ ID ๋ชฉ๋ก์„ ๊ฒ€์ƒ‰ํ•ฉ๋‹ˆ๋‹ค. **์ฐธ๊ณ :** ์ด API ํ˜ธ์ถœ์€ ์œ ์—ฐํ•œ ๋ผ์šฐํŒ… ์ฒด๊ณ„์˜ ์ ์šฉ์„ ๋ฐ›์Šต๋‹ˆ๋‹ค. ๋ผ์šฐํŒ… ์ •์ฑ…์€ ํŠธ๋žœ์žญ์…˜์ด ๋ผ์šฐํŒ…๋˜๋Š” ๋ฐฉ์‹์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค. ๊ฐ ์ž์‚ฐ ์œ ํ˜•์— ๋Œ€ํ•ด ์•„๋ž˜์— ์–ธ๊ธ‰๋œ 3๊ฐ€์ง€ ์ฒด๊ณ„ ์ค‘ ํ•˜๋‚˜๋ฅผ ์„ ํƒํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. - **์—†์Œ**: ํ•ด๋‹น ์ž์‚ฐ ์œ ํ˜•์— ๋Œ€ํ•œ ๋Œ€์ƒ ์—†์Œ์œผ๋กœ์˜ ํ”„๋กœํ•„ ๋ผ์šฐํŒ…์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค. `์—†์Œ`์œผ๋กœ ๋ผ์šฐํŒ…๋œ ์ž์‚ฐ ์œ ํ˜•์œผ๋กœ ๋“ค์–ด์˜ค๋Š” ํŠธ๋žœ์žญ์…˜์€ ์‹คํŒจํ•ฉ๋‹ˆ๋‹ค. - **์‚ฌ์šฉ์ž ์ง€์ •**: ์„ ํƒํ•œ ๊ณ„์ •์œผ๋กœ ๋ผ์šฐํŒ…ํ•ฉ๋‹ˆ๋‹ค. ๊ณ„์ •์„ ์ œ๊ฑฐํ•˜๋ฉด ๋‹ค๋ฅธ ๊ณ„์ •์„ ์„ ํƒํ•  ๋•Œ๊นŒ์ง€ ๋“ค์–ด์˜ค๋Š” ํŠธ๋žœ์žญ์…˜์€ ์‹คํŒจํ•ฉ๋‹ˆ๋‹ค. - **๊ธฐ๋ณธ๊ฐ’**: ์—ฐ๊ฒฐ์ด ์—ฐ๊ฒฐ๋œ ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„์—์„œ ์ง€์ •ํ•œ ๋ผ์šฐํŒ…์„ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค. ์ด ๊ตฌ์„ฑํ‘œ๋Š” "ํ”„๋กœํ•„ ๋ผ์šฐํŒ…"์ด๋ผ๊ณ ๋„ ํ•ฉ๋‹ˆ๋‹ค. ๊ธฐ๋ณธ ์ž‘์—… ๊ณต๊ฐ„ ์‚ฌ์ „ ์„ค์ •: - ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„ ์•”ํ˜ธํ™” โ†’ **์‚ฌ์šฉ์ž ์ •์˜** - ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„ FIAT โ†’ **์—†์Œ** - ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ ์•”ํ˜ธํ™” โ†’ **๊ธฐ๋ณธ๊ฐ’** - ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ FIAT โ†’ **๊ธฐ๋ณธ๊ฐ’** - **์ฐธ๊ณ **: ๊ธฐ๋ณธ์ ์œผ๋กœ ์‚ฌ์šฉ์ž ์ •์˜ ๋ผ์šฐํŒ… ๊ตฌ์„ฑํ‘œ๋Š” (`dstId` = `0`, `dstType` = `VAULT`)๋ฅผ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Network connections" + ], + "responses": { + "200": { + "description": "๋„คํŠธ์›Œํฌ ID ๋ชฉ๋ก", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": {} + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "์ƒˆ๋กœ์šด ๋„คํŠธ์›Œํฌ ID๋ฅผ ์ƒ์„ฑํ•ฉ๋‹ˆ๋‹ค", + "description": "์ƒˆ ๋„คํŠธ์›Œํฌ ID๋ฅผ ๋งŒ๋“ญ๋‹ˆ๋‹ค. **์ฐธ๊ณ :** ์ด API ํ˜ธ์ถœ์€ ์œ ์—ฐํ•œ ๋ผ์šฐํŒ… ์ฒด๊ณ„์˜ ์ ์šฉ์„ ๋ฐ›์Šต๋‹ˆ๋‹ค. ๋ผ์šฐํŒ… ์ •์ฑ…์€ ํŠธ๋žœ์žญ์…˜์ด ๋ผ์šฐํŒ…๋˜๋Š” ๋ฐฉ์‹์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค. ๊ฐ ์ž์‚ฐ ์œ ํ˜•์— ๋Œ€ํ•ด ์•„๋ž˜์— ์–ธ๊ธ‰๋œ 3๊ฐ€์ง€ ์ฒด๊ณ„ ์ค‘ ํ•˜๋‚˜๋ฅผ ์„ ํƒํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. - **์—†์Œ**: ํ•ด๋‹น ์ž์‚ฐ ์œ ํ˜•์— ๋Œ€ํ•œ ๋Œ€์ƒ ์—†์Œ์œผ๋กœ์˜ ํ”„๋กœํ•„ ๋ผ์šฐํŒ…์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค. `์—†์Œ`์œผ๋กœ ๋ผ์šฐํŒ…๋œ ์ž์‚ฐ ์œ ํ˜•์œผ๋กœ ๋“ค์–ด์˜ค๋Š” ํŠธ๋žœ์žญ์…˜์€ ์‹คํŒจํ•ฉ๋‹ˆ๋‹ค. - **์‚ฌ์šฉ์ž ์ง€์ •**: ์„ ํƒํ•œ ๊ณ„์ •์œผ๋กœ ๋ผ์šฐํŒ…ํ•ฉ๋‹ˆ๋‹ค. ๊ณ„์ •์„ ์ œ๊ฑฐํ•˜๋ฉด ๋‹ค๋ฅธ ๊ณ„์ •์„ ์„ ํƒํ•  ๋•Œ๊นŒ์ง€ ๋“ค์–ด์˜ค๋Š” ํŠธ๋žœ์žญ์…˜์€ ์‹คํŒจํ•ฉ๋‹ˆ๋‹ค. - **๊ธฐ๋ณธ๊ฐ’**: ์—ฐ๊ฒฐ์ด ์—ฐ๊ฒฐ๋œ ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„์—์„œ ์ง€์ •ํ•œ ๋ผ์šฐํŒ…์„ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค. ์ด ์ฒด๊ณ„๋Š” "ํ”„๋กœํ•„ ๋ผ์šฐํŒ…"์ด๋ผ๊ณ ๋„ ํ•ฉ๋‹ˆ๋‹ค. ๊ธฐ๋ณธ ์ž‘์—… ๊ณต๊ฐ„ ์‚ฌ์ „ ์„ค์ •: - ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„ ์•”ํ˜ธํ™” โ†’ **์‚ฌ์šฉ์ž ์ง€์ •** - ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„ FIAT โ†’ **์—†์Œ** - ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ ์•”ํ˜ธํ™” โ†’ **๊ธฐ๋ณธ๊ฐ’** - ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ FIAT โ†’ **๊ธฐ๋ณธ๊ฐ’** - **์ฐธ๊ณ **: ๊ธฐ๋ณธ์ ์œผ๋กœ ์‚ฌ์šฉ์ž ์ง€์ • ๋ผ์šฐํŒ… ์ฒด๊ณ„๋Š” (`dstId` = `0`, `dstType` = `VAULT`)๋ฅผ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Network connections" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "type": "string" + }, + "routingPolicy": { + "$ref": "#/components/schemas/NetworkIdRoutingPolicy" + } + }, + "required": [ + "name" + ] + } + } + } + }, + "responses": { + "201": { + "description": "์ž‘์—… ๊ณต๊ฐ„์—์„œ ์ƒˆ ๋„คํŠธ์›Œํฌ ID๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค.", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/NetworkIdResponse" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/network_ids/{networkId}": { + "get": { + "summary": "ํŠน์ • ๋„คํŠธ์›Œํฌ ID๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค.", + "description": "ID๋กœ ๋„คํŠธ์›Œํฌ๋ฅผ ๊ฒ€์ƒ‰ํ•ฉ๋‹ˆ๋‹ค. **์ฐธ๊ณ :** ์ด API ํ˜ธ์ถœ์€ ์œ ์—ฐํ•œ ๋ผ์šฐํŒ… ์ฒด๊ณ„์˜ ์ ์šฉ์„ ๋ฐ›์Šต๋‹ˆ๋‹ค. ๋ผ์šฐํŒ… ์ •์ฑ…์€ ํŠธ๋žœ์žญ์…˜์ด ๋ผ์šฐํŒ…๋˜๋Š” ๋ฐฉ์‹์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค. ๊ฐ ์ž์‚ฐ ์œ ํ˜•์— ๋Œ€ํ•ด ์•„๋ž˜์— ์–ธ๊ธ‰๋œ 3๊ฐ€์ง€ ์ฒด๊ณ„ ์ค‘ ํ•˜๋‚˜๋ฅผ ์„ ํƒํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. - **์—†์Œ**: ํ•ด๋‹น ์ž์‚ฐ ์œ ํ˜•์— ๋Œ€ํ•œ ๋Œ€์ƒ ์—†์Œ์œผ๋กœ์˜ ํ”„๋กœํ•„ ๋ผ์šฐํŒ…์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค. `์—†์Œ`์œผ๋กœ ๋ผ์šฐํŒ…๋œ ์ž์‚ฐ ์œ ํ˜•์œผ๋กœ ๋“ค์–ด์˜ค๋Š” ํŠธ๋žœ์žญ์…˜์€ ์‹คํŒจํ•ฉ๋‹ˆ๋‹ค. - **์‚ฌ์šฉ์ž ์ง€์ •**: ์„ ํƒํ•œ ๊ณ„์ •์œผ๋กœ ๋ผ์šฐํŒ…ํ•ฉ๋‹ˆ๋‹ค. ๊ณ„์ •์„ ์ œ๊ฑฐํ•˜๋ฉด ๋‹ค๋ฅธ ๊ณ„์ •์„ ์„ ํƒํ•  ๋•Œ๊นŒ์ง€ ๋“ค์–ด์˜ค๋Š” ํŠธ๋žœ์žญ์…˜์€ ์‹คํŒจํ•ฉ๋‹ˆ๋‹ค. - **๊ธฐ๋ณธ๊ฐ’**: ์—ฐ๊ฒฐ์ด ์—ฐ๊ฒฐ๋œ ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„์—์„œ ์ง€์ •ํ•œ ๋ผ์šฐํŒ…์„ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค. ์ด ์ฒด๊ณ„๋Š” "ํ”„๋กœํ•„ ๋ผ์šฐํŒ…"์ด๋ผ๊ณ ๋„ ํ•ฉ๋‹ˆ๋‹ค. ๊ธฐ๋ณธ ์ž‘์—… ๊ณต๊ฐ„ ์‚ฌ์ „ ์„ค์ •: - ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„ ์•”ํ˜ธํ™” โ†’ **์‚ฌ์šฉ์ž ์ง€์ •** - ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„ FIAT โ†’ **์—†์Œ** - ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ ์•”ํ˜ธํ™” โ†’ **๊ธฐ๋ณธ๊ฐ’** - ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ FIAT โ†’ **๊ธฐ๋ณธ๊ฐ’** - **์ฐธ๊ณ **: ๊ธฐ๋ณธ์ ์œผ๋กœ ์‚ฌ์šฉ์ž ์ง€์ • ๋ผ์šฐํŒ… ์ฒด๊ณ„๋Š” (`dstId` = `0`, `dstType` = `VAULT`)๋ฅผ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Network connections" + ], + "parameters": [ + { + "in": "path", + "name": "networkId", + "required": true, + "description": "๋„คํŠธ์›Œํฌ์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "๋„คํŠธ์›Œํฌ ID", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/NetworkIdResponse" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "delete": { + "summary": "ํŠน์ • ๋„คํŠธ์›Œํฌ ID๋ฅผ ์‚ญ์ œํ•ฉ๋‹ˆ๋‹ค.", + "description": "ID๋กœ ๋„คํŠธ์›Œํฌ๋ฅผ ์‚ญ์ œํ•ฉ๋‹ˆ๋‹ค. **์ฐธ๊ณ :** ์ด API ํ˜ธ์ถœ์€ ์œ ์—ฐํ•œ ๋ผ์šฐํŒ… ์ฒด๊ณ„์˜ ์ ์šฉ์„ ๋ฐ›์Šต๋‹ˆ๋‹ค. ๋ผ์šฐํŒ… ์ •์ฑ…์€ ํŠธ๋žœ์žญ์…˜์ด ๋ผ์šฐํŒ…๋˜๋Š” ๋ฐฉ์‹์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค. ๊ฐ ์ž์‚ฐ ์œ ํ˜•์— ๋Œ€ํ•ด ์•„๋ž˜์— ์–ธ๊ธ‰๋œ 3๊ฐ€์ง€ ์ฒด๊ณ„ ์ค‘ ํ•˜๋‚˜๋ฅผ ์„ ํƒํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. - **์—†์Œ**: ํ•ด๋‹น ์ž์‚ฐ ์œ ํ˜•์— ๋Œ€ํ•œ ๋Œ€์ƒ ์—†์Œ์œผ๋กœ์˜ ํ”„๋กœํ•„ ๋ผ์šฐํŒ…์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค. `์—†์Œ`์œผ๋กœ ๋ผ์šฐํŒ…๋œ ์ž์‚ฐ ์œ ํ˜•์œผ๋กœ ๋“ค์–ด์˜ค๋Š” ํŠธ๋žœ์žญ์…˜์€ ์‹คํŒจํ•ฉ๋‹ˆ๋‹ค. - **์‚ฌ์šฉ์ž ์ง€์ •**: ์„ ํƒํ•œ ๊ณ„์ •์œผ๋กœ ๋ผ์šฐํŒ…ํ•ฉ๋‹ˆ๋‹ค. ๊ณ„์ •์„ ์ œ๊ฑฐํ•˜๋ฉด ๋‹ค๋ฅธ ๊ณ„์ •์„ ์„ ํƒํ•  ๋•Œ๊นŒ์ง€ ๋“ค์–ด์˜ค๋Š” ํŠธ๋žœ์žญ์…˜์€ ์‹คํŒจํ•ฉ๋‹ˆ๋‹ค. - **๊ธฐ๋ณธ๊ฐ’**: ์—ฐ๊ฒฐ์ด ์—ฐ๊ฒฐ๋œ ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„์—์„œ ์ง€์ •ํ•œ ๋ผ์šฐํŒ…์„ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค. ์ด ์ฒด๊ณ„๋Š” "ํ”„๋กœํ•„ ๋ผ์šฐํŒ…"์ด๋ผ๊ณ ๋„ ํ•ฉ๋‹ˆ๋‹ค. ๊ธฐ๋ณธ ์ž‘์—… ๊ณต๊ฐ„ ์‚ฌ์ „ ์„ค์ •: - ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„ ์•”ํ˜ธํ™” โ†’ **์‚ฌ์šฉ์ž ์ง€์ •** - ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„ FIAT โ†’ **์—†์Œ** - ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ ์•”ํ˜ธํ™” โ†’ **๊ธฐ๋ณธ๊ฐ’** - ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ FIAT โ†’ **๊ธฐ๋ณธ๊ฐ’** - **์ฐธ๊ณ **: ๊ธฐ๋ณธ์ ์œผ๋กœ ์‚ฌ์šฉ์ž ์ง€์ • ๋ผ์šฐํŒ… ์ฒด๊ณ„๋Š” (`dstId` = `0`, `dstType` = `VAULT`)๋ฅผ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Network connections" + ], + "parameters": [ + { + "in": "path", + "name": "networkId", + "required": true, + "description": "๋„คํŠธ์›Œํฌ์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "๋„คํŠธ์›Œํฌ ID", + "content": { + "*/*": { + "schema": { + "properties": { + "success": { + "type": "boolean" + } + }, + "required": [ + "success" + ] + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/network_ids/{networkId}/set_routing_policy": { + "patch": { + "summary": "๋„คํŠธ์›Œํฌ ID ๋ผ์šฐํŒ… ์ •์ฑ… ์—…๋ฐ์ดํŠธ.", + "description": "์ง€์ •๋œ ๋„คํŠธ์›Œํฌ ID์˜ ๋ผ์šฐํŒ… ์ •์ฑ…์„ ์—…๋ฐ์ดํŠธํ•ฉ๋‹ˆ๋‹ค. **์ฐธ๊ณ :** ์ด API ํ˜ธ์ถœ์€ ์œ ์—ฐํ•œ ๋ผ์šฐํŒ… ์ฒด๊ณ„์˜ ์ ์šฉ์„ ๋ฐ›์Šต๋‹ˆ๋‹ค. ๋ผ์šฐํŒ… ์ •์ฑ…์€ ํŠธ๋žœ์žญ์…˜์ด ๋ผ์šฐํŒ…๋˜๋Š” ๋ฐฉ์‹์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค. ๊ฐ ์ž์‚ฐ ์œ ํ˜•์— ๋Œ€ํ•ด ์•„๋ž˜์— ์–ธ๊ธ‰๋œ 3๊ฐ€์ง€ ์ฒด๊ณ„ ์ค‘ ํ•˜๋‚˜๋ฅผ ์„ ํƒํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. - **์—†์Œ**: ํ•ด๋‹น ์ž์‚ฐ ์œ ํ˜•์— ๋Œ€ํ•œ ๋Œ€์ƒ ์—†์Œ์œผ๋กœ์˜ ํ”„๋กœํ•„ ๋ผ์šฐํŒ…์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค. `์—†์Œ`์œผ๋กœ ๋ผ์šฐํŒ…๋œ ์ž์‚ฐ ์œ ํ˜•์œผ๋กœ ๋“ค์–ด์˜ค๋Š” ํŠธ๋žœ์žญ์…˜์€ ์‹คํŒจํ•ฉ๋‹ˆ๋‹ค. - **์‚ฌ์šฉ์ž ์ง€์ •**: ์„ ํƒํ•œ ๊ณ„์ •์œผ๋กœ ๋ผ์šฐํŒ…ํ•ฉ๋‹ˆ๋‹ค. ๊ณ„์ •์„ ์ œ๊ฑฐํ•˜๋ฉด ๋‹ค๋ฅธ ๊ณ„์ •์„ ์„ ํƒํ•  ๋•Œ๊นŒ์ง€ ๋“ค์–ด์˜ค๋Š” ํŠธ๋žœ์žญ์…˜์€ ์‹คํŒจํ•ฉ๋‹ˆ๋‹ค. - **๊ธฐ๋ณธ๊ฐ’**: ์—ฐ๊ฒฐ์ด ์—ฐ๊ฒฐ๋œ ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„์—์„œ ์ง€์ •ํ•œ ๋ผ์šฐํŒ…์„ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค. ์ด ์ฒด๊ณ„๋Š” "ํ”„๋กœํ•„ ๋ผ์šฐํŒ…"์ด๋ผ๊ณ ๋„ ํ•ฉ๋‹ˆ๋‹ค. ๊ธฐ๋ณธ ์ž‘์—… ๊ณต๊ฐ„ ์‚ฌ์ „ ์„ค์ •: - ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„ ์•”ํ˜ธํ™” โ†’ **์‚ฌ์šฉ์ž ์ง€์ •** - ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„ FIAT โ†’ **์—†์Œ** - ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ ์•”ํ˜ธํ™” โ†’ **๊ธฐ๋ณธ๊ฐ’** - ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ FIAT โ†’ **๊ธฐ๋ณธ๊ฐ’** - **์ฐธ๊ณ **: ๊ธฐ๋ณธ์ ์œผ๋กœ ์‚ฌ์šฉ์ž ์ง€์ • ๋ผ์šฐํŒ… ์ฒด๊ณ„๋Š” (`dstId` = `0`, `dstType` = `VAULT`)๋ฅผ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Network connections" + ], + "parameters": [ + { + "in": "path", + "name": "networkId", + "required": true, + "description": "๋„คํŠธ์›Œํฌ์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "routingPolicy": { + "$ref": "#/components/schemas/NetworkIdRoutingPolicy" + } + }, + "required": [ + "routingPolicy" + ] + } + } + } + }, + "responses": { + "200": { + "description": "๋„คํŠธ์›Œํฌ ID", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "properties": { + "success": { + "type": "boolean" + } + }, + "required": [ + "success" + ] + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/network_ids/{networkId}/set_discoverability": { + "patch": { + "summary": "๋„คํŠธ์›Œํฌ ID์˜ ๊ฒ€์ƒ‰ ๊ฐ€๋Šฅ์„ฑ ์—…๋ฐ์ดํŠธ.", + "description": "๋„คํŠธ์›Œํฌ ID๋ฅผ ๋‹ค๋ฅธ ์‚ฌ๋žŒ์ด ๊ฒ€์ƒ‰ํ•  ์ˆ˜ ์žˆ๋Š”์ง€ ์—ฌ๋ถ€๋ฅผ ์—…๋ฐ์ดํŠธํ•ฉ๋‹ˆ๋‹ค. **์ฐธ๊ณ :** ์ด API ํ˜ธ์ถœ์€ ์œ ์—ฐํ•œ ๋ผ์šฐํŒ… ์ฒด๊ณ„์˜ ์ ์šฉ์„ ๋ฐ›์Šต๋‹ˆ๋‹ค. ๋ผ์šฐํŒ… ์ •์ฑ…์€ ํŠธ๋žœ์žญ์…˜์ด ๋ผ์šฐํŒ…๋˜๋Š” ๋ฐฉ์‹์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค. ๊ฐ ์ž์‚ฐ ์œ ํ˜•์— ๋Œ€ํ•ด ์•„๋ž˜์— ์–ธ๊ธ‰๋œ 3๊ฐ€์ง€ ์ฒด๊ณ„ ์ค‘ ํ•˜๋‚˜๋ฅผ ์„ ํƒํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. - **์—†์Œ**: ํ•ด๋‹น ์ž์‚ฐ ์œ ํ˜•์— ๋Œ€ํ•œ ๋Œ€์ƒ ์—†์Œ์œผ๋กœ์˜ ํ”„๋กœํ•„ ๋ผ์šฐํŒ…์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค. `์—†์Œ`์œผ๋กœ ๋ผ์šฐํŒ…๋œ ์ž์‚ฐ ์œ ํ˜•์œผ๋กœ ๋“ค์–ด์˜ค๋Š” ํŠธ๋žœ์žญ์…˜์€ ์‹คํŒจํ•ฉ๋‹ˆ๋‹ค. - **์‚ฌ์šฉ์ž ์ง€์ •**: ์„ ํƒํ•œ ๊ณ„์ •์œผ๋กœ ๋ผ์šฐํŒ…ํ•ฉ๋‹ˆ๋‹ค. ๊ณ„์ •์„ ์ œ๊ฑฐํ•˜๋ฉด ๋‹ค๋ฅธ ๊ณ„์ •์„ ์„ ํƒํ•  ๋•Œ๊นŒ์ง€ ๋“ค์–ด์˜ค๋Š” ํŠธ๋žœ์žญ์…˜์€ ์‹คํŒจํ•ฉ๋‹ˆ๋‹ค. - **๊ธฐ๋ณธ๊ฐ’**: ์—ฐ๊ฒฐ์ด ์—ฐ๊ฒฐ๋œ ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„์—์„œ ์ง€์ •ํ•œ ๋ผ์šฐํŒ…์„ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค. ์ด ๊ตฌ์„ฑํ‘œ๋Š” "ํ”„๋กœํ•„ ๋ผ์šฐํŒ…"์ด๋ผ๊ณ ๋„ ํ•ฉ๋‹ˆ๋‹ค. ๊ธฐ๋ณธ ์ž‘์—… ๊ณต๊ฐ„ ์‚ฌ์ „ ์„ค์ •: - ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„ ์•”ํ˜ธํ™” โ†’ **์‚ฌ์šฉ์ž ์ •์˜** - ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„ FIAT โ†’ **์—†์Œ** - ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ ์•”ํ˜ธํ™” โ†’ **๊ธฐ๋ณธ๊ฐ’** - ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ FIAT โ†’ **๊ธฐ๋ณธ๊ฐ’** - **์ฐธ๊ณ **: ๊ธฐ๋ณธ์ ์œผ๋กœ ์‚ฌ์šฉ์ž ์ •์˜ ๋ผ์šฐํŒ… ๊ตฌ์„ฑํ‘œ๋Š” (`dstId` = `0`, `dstType` = `VAULT`)๋ฅผ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Network connections" + ], + "parameters": [ + { + "in": "path", + "name": "networkId", + "required": true, + "description": "๋„คํŠธ์›Œํฌ์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "isDiscoverable": { + "type": "boolean" + } + }, + "required": [ + "isDiscoverable" + ] + } + } + } + }, + "responses": { + "200": { + "description": "๋„คํŠธ์›Œํฌ ID", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "properties": { + "success": { + "type": "boolean" + } + }, + "required": [ + "success" + ] + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/network_ids/{networkId}/set_name": { + "patch": { + "summary": "๋„คํŠธ์›Œํฌ ID ์ด๋ฆ„ ์—…๋ฐ์ดํŠธ.", + "description": "์ง€์ •๋œ ๋„คํŠธ์›Œํฌ ID์˜ ์ด๋ฆ„์„ ์—…๋ฐ์ดํŠธํ•ฉ๋‹ˆ๋‹ค. **์ฐธ๊ณ :** ์ด API ํ˜ธ์ถœ์€ ์œ ์—ฐํ•œ ๋ผ์šฐํŒ… ์ฒด๊ณ„์˜ ์ ์šฉ์„ ๋ฐ›์Šต๋‹ˆ๋‹ค. ๋ผ์šฐํŒ… ์ •์ฑ…์€ ํŠธ๋žœ์žญ์…˜์ด ๋ผ์šฐํŒ…๋˜๋Š” ๋ฐฉ์‹์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค. ๊ฐ ์ž์‚ฐ ์œ ํ˜•์— ๋Œ€ํ•ด ์•„๋ž˜์— ์–ธ๊ธ‰๋œ 3๊ฐ€์ง€ ์ฒด๊ณ„ ์ค‘ ํ•˜๋‚˜๋ฅผ ์„ ํƒํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. - **์—†์Œ**: ํ•ด๋‹น ์ž์‚ฐ ์œ ํ˜•์— ๋Œ€ํ•œ ๋Œ€์ƒ ์—†์Œ์œผ๋กœ์˜ ํ”„๋กœํ•„ ๋ผ์šฐํŒ…์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค. `์—†์Œ`์œผ๋กœ ๋ผ์šฐํŒ…๋œ ์ž์‚ฐ ์œ ํ˜•์œผ๋กœ ๋“ค์–ด์˜ค๋Š” ํŠธ๋žœ์žญ์…˜์€ ์‹คํŒจํ•ฉ๋‹ˆ๋‹ค. - **์‚ฌ์šฉ์ž ์ง€์ •**: ์„ ํƒํ•œ ๊ณ„์ •์œผ๋กœ ๋ผ์šฐํŒ…ํ•ฉ๋‹ˆ๋‹ค. ๊ณ„์ •์„ ์ œ๊ฑฐํ•˜๋ฉด ๋‹ค๋ฅธ ๊ณ„์ •์„ ์„ ํƒํ•  ๋•Œ๊นŒ์ง€ ๋“ค์–ด์˜ค๋Š” ํŠธ๋žœ์žญ์…˜์€ ์‹คํŒจํ•ฉ๋‹ˆ๋‹ค. - **๊ธฐ๋ณธ๊ฐ’**: ์—ฐ๊ฒฐ์ด ์—ฐ๊ฒฐ๋œ ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„์—์„œ ์ง€์ •ํ•œ ๋ผ์šฐํŒ…์„ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค. ์ด ์ฒด๊ณ„๋Š” "ํ”„๋กœํ•„ ๋ผ์šฐํŒ…"์ด๋ผ๊ณ ๋„ ํ•ฉ๋‹ˆ๋‹ค. ๊ธฐ๋ณธ ์ž‘์—… ๊ณต๊ฐ„ ์‚ฌ์ „ ์„ค์ •: - ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„ ์•”ํ˜ธํ™” โ†’ **์‚ฌ์šฉ์ž ์ง€์ •** - ๋„คํŠธ์›Œํฌ ํ”„๋กœํ•„ FIAT โ†’ **์—†์Œ** - ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ ์•”ํ˜ธํ™” โ†’ **๊ธฐ๋ณธ๊ฐ’** - ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ FIAT โ†’ **๊ธฐ๋ณธ๊ฐ’** - **์ฐธ๊ณ **: ๊ธฐ๋ณธ์ ์œผ๋กœ ์‚ฌ์šฉ์ž ์ง€์ • ๋ผ์šฐํŒ… ์ฒด๊ณ„๋Š” (`dstId` = `0`, `dstType` = `VAULT`)๋ฅผ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Network connections" + ], + "parameters": [ + { + "in": "path", + "name": "networkId", + "required": true, + "description": "๋„คํŠธ์›Œํฌ์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "type": "string" + } + }, + "required": [ + "name" + ] + } + } + } + }, + "responses": { + "200": { + "description": "๋„คํŠธ์›Œํฌ ID", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "properties": { + "success": { + "type": "boolean" + } + }, + "required": [ + "success" + ] + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/internal_wallets": { + "get": { + "summary": "๋‚ด๋ถ€ ์ง€๊ฐ‘ ๋ชฉ๋ก", + "tags": [ + "Internal wallets" + ], + "description": "๋‚ด๋ถ€ ์ง€๊ฐ‘ ๋ชฉ๋ก์„ ๊ฐ€์ ธ์˜ต๋‹ˆ๋‹ค. **์ฐธ๊ณ **: ํ—ˆ์šฉ๋œ ์ฃผ์†Œ์— ์†ํ•œ BTC ๊ธฐ๋ฐ˜ ์ž์‚ฐ์€ ๋งค์ผ 00:00 UTC์™€ 00:01 UTC ์‚ฌ์ด์— ํƒ€์‚ฌ ๊ณต๊ธ‰์—…์ฒด์ธ Blockchair๊ฐ€ ์ด 60์ดˆ ๋™์•ˆ ์‚ฌ์šฉํ•  ์ˆ˜ ์—†๊ธฐ ๋•Œ๋ฌธ์— ๊ฒ€์ƒ‰ํ•  ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค. BTC ๊ธฐ๋ฐ˜ ์ž์‚ฐ์„ ๊ฒ€์ƒ‰ํ•˜๋ ค๋ฉด ๋‹ค์Œ ๋ถ„๊นŒ์ง€ ๊ธฐ๋‹ค๋ ค ์ฃผ์‹ญ์‹œ์˜ค..", + "responses": { + "200": { + "description": "๋‚ด๋ถ€ ์ง€๊ฐ‘ ๋ชฉ๋ก", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "๋‚ด๋ถ€ ์ง€๊ฐ‘ ์ƒ์„ฑ", + "tags": [ + "Internal wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "internalWallet = fireblocks.create_internal_wallet(name, customer_ref_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const internalWallet = await fireblocks.createInternalWallet(name, customerRefId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "description": "์š”์ฒญ๋œ ์ด๋ฆ„์œผ๋กœ ์ƒˆ ๋‚ด๋ถ€ ์ง€๊ฐ‘์„ ์ƒ์„ฑํ•ฉ๋‹ˆ๋‹ค..", + "responses": { + "200": { + "description": "์ƒˆ๋กœ์šด ์ง€๊ฐ‘ ๊ฐ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "type": "string", + "description": "์ง€๊ฐ‘์˜ ํ‘œ์‹œ ์ด๋ฆ„" + }, + "customerRefId": { + "description": "์„ ํƒ ์‚ฌํ•ญ - ๊ณ ๊ฐ ์ฐธ์กฐ ID๋ฅผ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค.", + "type": "string" + } + } + } + } + } + } + } + }, + "/internal_wallets/{walletId}": { + "get": { + "summary": "๋‚ด๋ถ€ ์ง€๊ฐ‘์— ๋Œ€ํ•œ ์ž์‚ฐ ๊ฐ€์ ธ์˜ค๊ธฐ", + "tags": [ + "Internal wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "internalWallet = fireblocks.get_internal_wallet(walletId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.getInternalWallet(walletId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "description": "ID๋ณ„๋กœ ๋‚ด๋ถ€ ์ง€๊ฐ‘์˜ ๋ชจ๋“  ์ž์‚ฐ์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "๋ฐ˜ํ™˜ํ•  ์ง€๊ฐ‘์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "Wallet ๊ฐ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "delete": { + "summary": "๋‚ด๋ถ€ ์ง€๊ฐ‘ ์‚ญ์ œ", + "tags": [ + "Internal wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = firebocks.delete_internal_wallet(walletId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.deleteInternalWallet(walletId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "description": "ID๋กœ ๋‚ด๋ถ€ ์ง€๊ฐ‘์„ ์‚ญ์ œํ•ฉ๋‹ˆ๋‹ค..", + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "์‚ญ์ œํ•  ์ง€๊ฐ‘์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "201": { + "description": "์ข‹์•„์š”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/internal_wallets/{walletId}/set_customer_ref_id": { + "post": { + "summary": "๋‚ด๋ถ€ ์ง€๊ฐ‘์— ๋Œ€ํ•œ AML/KYT ๊ณ ๊ฐ ์ฐธ์กฐ ID ์„ค์ •", + "tags": [ + "Internal wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = firebocks.set_customer_ref_id_for_internal_wallet(wallet_id, customer_ref_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.setCustomerRefIdForInternalWallet(walletId, customerRefId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "description": "ํŠน์ • ๋‚ด๋ถ€ ์ง€๊ฐ‘์— ๋Œ€ํ•œ AML/KYT ๊ณ ๊ฐ ์ฐธ์กฐ ID๋ฅผ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค..", + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "์ง€๊ฐ‘ ID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "customerRefId": { + "description": "๊ณ ๊ฐ ์ฐธ์กฐ ID", + "type": "string" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "์ข‹์•„์š”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/internal_wallets/{walletId}/{assetId}": { + "get": { + "summary": "๋‚ด๋ถ€ ์ง€๊ฐ‘์—์„œ ์ž์‚ฐ ๊ฐ€์ ธ์˜ค๊ธฐ", + "tags": [ + "Internal wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "internalWalletAsset = fireblocks.get_internal_wallet_asset(walletId, assetId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const internalWalletAsset = fireblocks.getInternalWalletAsset(walletId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "description": "๋‚ด๋ถ€ ์ง€๊ฐ‘์˜ ์ž์‚ฐ์— ๋Œ€ํ•œ ์ •๋ณด๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "์ง€๊ฐ‘์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "๋ฐ˜ํ™˜ํ•  ์ž์‚ฐ์˜ ID", + "schema": { + "type": "string", + "minimum": 1, + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "์ง€๊ฐ‘ ์ž์‚ฐ ๊ฐ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/WalletAsset" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "๋‚ด๋ถ€ ์ง€๊ฐ‘์— ์ž์‚ฐ ์ถ”๊ฐ€", + "tags": [ + "Internal wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "internalWalletAsset = fireblocks.create_internal_wallet_asset(walletId, assetId, address, tag)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const internalWalletAsset = await fireblocks.createInternalWalletAsset(walletContainerId, assetId, address, tag);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "description": "๊ธฐ์กด ๋‚ด๋ถ€ ์ง€๊ฐ‘์— ์ž์‚ฐ์„ ์ถ”๊ฐ€ํ•ฉ๋‹ˆ๋‹ค..", + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "์ง€๊ฐ‘์˜ ID", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "์ถ”๊ฐ€ํ•  ์ž์‚ฐ์˜ ID", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "์ง€๊ฐ‘ ์ž์‚ฐ ๊ฐ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/WalletAsset" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "address": { + "type": "string", + "description": "์ง€๊ฐ‘ ์ฃผ์†Œ ๋˜๋Š” EOS ์ง€๊ฐ‘์˜ ๊ฒฝ์šฐ ๊ณ„์ • ์ด๋ฆ„" + }, + "tag": { + "type": "string", + "description": "XRP ์ง€๊ฐ‘์˜ ๊ฒฝ์šฐ ๋ชฉ์ ์ง€ ํƒœ๊ทธ, EOS์˜ ๊ฒฝ์šฐ ๋ฉ”๋ชจ, ๋ฒ•์ • ํ†ตํ™” ๊ณต๊ธ‰์ž(BCB ๊ทธ๋ฃน์˜ BLINC)์˜ ๊ฒฝ์šฐ ์€ํ–‰ ์†ก๊ธˆ ์„ค๋ช…" + } + }, + "required": [ + "address" + ] + } + } + } + } + }, + "delete": { + "summary": "๋‚ด๋ถ€ ์ง€๊ฐ‘์—์„œ ํ—ˆ์šฉ ๋ชฉ๋ก์— ์žˆ๋Š” ์ฃผ์†Œ ์‚ญ์ œ", + "tags": [ + "Internal wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = fireblocks.delete_internal_wallet_asset(walletId, assetId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.deleteInternalWalletAsset(walletId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "description": "๋‚ด๋ถ€ ์ง€๊ฐ‘์—์„œ ํ—ˆ์šฉ ๋ชฉ๋ก์— ์žˆ๋Š” ์ฃผ์†Œ(์ž์‚ฐ)๋ฅผ ์‚ญ์ œํ•ฉ๋‹ˆ๋‹ค..", + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "์ง€๊ฐ‘์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "์‚ญ์ œํ•  ์ž์‚ฐ์˜ ID", + "schema": { + "type": "string", + "minimum": 1, + "x-fb-entity": "asset" + } + } + ], + "responses": { + "201": { + "description": "์ข‹์•„์š”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/external_wallets": { + "get": { + "summary": "์™ธ๋ถ€ ์ง€๊ฐ‘ ๋ชฉ๋ก", + "description": "์ž‘์—… ๊ณต๊ฐ„ ์•„๋ž˜์— ์™ธ๋ถ€ ์ง€๊ฐ‘ ๋ชฉ๋ก์„ ๊ฐ€์ ธ์˜ต๋‹ˆ๋‹ค..", + "tags": [ + "External wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "externalWallets = fireblocks.get_external_wallets()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const externalWallets = await fireblocks.getExternalWallets();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "์™ธ๋ถ€ ์ง€๊ฐ‘ ๋ชฉ๋ก", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "์™ธ๋ถ€ ์ง€๊ฐ‘ ์ƒ์„ฑ", + "description": "์š”์ฒญ๋œ ์ด๋ฆ„์œผ๋กœ ์ƒˆ ์™ธ๋ถ€ ์ง€๊ฐ‘์„ ์ƒ์„ฑํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "External wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "externalWallet = fireblocks.create_external_wallet(name, customer_ref_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const externalWallet = await fireblocks.createExternalWallet(name, customerRefId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "Wallet ๊ฐ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "type": "string", + "description": "์ง€๊ฐ‘์˜ ํ‘œ์‹œ ์ด๋ฆ„" + }, + "customerRefId": { + "description": "์„ ํƒ ์‚ฌํ•ญ - ๊ณ ๊ฐ ์ฐธ์กฐ ID๋ฅผ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค.", + "type": "string" + } + } + } + } + } + } + } + }, + "/external_wallets/{walletId}": { + "get": { + "summary": "์™ธ๋ถ€ ์ง€๊ฐ‘ ์ฐพ๊ธฐ", + "description": "ID๋กœ ์™ธ๋ถ€ ์ง€๊ฐ‘์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "External wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "externalWallet = fireblocks.get_external_wallet(walletId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const externalWallet = await fireblocks.getExternalWallet(walletId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "๋ฐ˜ํ™˜ํ•  ์ง€๊ฐ‘์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "Wallet ๊ฐ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "delete": { + "summary": "์™ธ๋ถ€ ์ง€๊ฐ‘ ์‚ญ์ œ", + "description": "ID๋กœ ์™ธ๋ถ€ ์ง€๊ฐ‘์„ ์‚ญ์ œํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "External wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = firebocks.delete_external_wallet(walletId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.deleteExternalWallet(walletId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "์‚ญ์ œํ•  ์ง€๊ฐ‘์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "201": { + "description": "์ข‹์•„์š”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/external_wallets/{walletId}/set_customer_ref_id": { + "post": { + "summary": "์™ธ๋ถ€ ์ง€๊ฐ‘์— ๋Œ€ํ•œ AML ๊ณ ๊ฐ ์ฐธ์กฐ ID ์„ค์ •", + "description": "ํŠน์ • ์™ธ๋ถ€ ์ง€๊ฐ‘์— ๋Œ€ํ•œ AML/KYT ๊ณ ๊ฐ ์ฐธ์กฐ ID๋ฅผ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "External wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = firebocks.set_customer_ref_id_for_external_wallet(wallet_id, customer_ref_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.setCustomerRefIdForExternalWallet(walletId, customerRefId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "์ง€๊ฐ‘ ID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "customerRefId": { + "description": "๊ณ ๊ฐ ์ฐธ์กฐ ID", + "type": "string" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "์ข‹์•„์š”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/external_wallets/{walletId}/{assetId}": { + "get": { + "summary": "์™ธ๋ถ€ ์ง€๊ฐ‘์—์„œ ์ž์‚ฐ ๊ฐ€์ ธ์˜ค๊ธฐ", + "description": "์ง€๊ฐ‘ ID ๋ฐ ์ž์‚ฐ ID๋กœ ์™ธ๋ถ€ ์ง€๊ฐ‘์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "External wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "externalWalletAsset = fireblocks.get_external_wallet_asset(walletId, assetId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const externalWalletAsset = fireblocks.getExternalWalletAsset(walletId, assetId)", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "์ง€๊ฐ‘์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "๋ฐ˜ํ™˜ํ•  ์ž์‚ฐ์˜ ID", + "schema": { + "type": "string", + "minimum": 1, + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "์ง€๊ฐ‘ ์ž์‚ฐ ๊ฐ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ExternalWalletAsset" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "์™ธ๋ถ€ ์ง€๊ฐ‘์— ์ž์‚ฐ ์ถ”๊ฐ€.", + "description": "๊ธฐ์กด ์™ธ๋ถ€ ์ง€๊ฐ‘์— ์ž์‚ฐ์„ ์ถ”๊ฐ€ํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "External wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "externalWalletAsset = fireblocks.create_external_wallet_asset(walletId, assetId, address, tag)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const externalWalletAsset = await fireblocks.createExternalWalletAsset(walletContainerId, assetId, address, tag);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "์ง€๊ฐ‘์˜ ID", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "์ถ”๊ฐ€ํ•  ์ž์‚ฐ์˜ ID", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "์ง€๊ฐ‘ ์ž์‚ฐ ๊ฐ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ExternalWalletAsset" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "properties": { + "address": { + "type": "string", + "description": "์ง€๊ฐ‘์˜ ์ฃผ์†Œ(๋˜๋Š” xpub)" + }, + "tag": { + "type": "string", + "description": "XRP ์ง€๊ฐ‘์˜ ๊ฒฝ์šฐ ๋ชฉ์ ์ง€ ํƒœ๊ทธ, EOS/XLM์˜ ๊ฒฝ์šฐ ๋ฉ”๋ชจ, ๋ฒ•์ • ํ†ตํ™” ๊ณต๊ธ‰์ž(BCB ๊ทธ๋ฃน์˜ BLINC)์˜ ๊ฒฝ์šฐ ์€ํ–‰ ์†ก๊ธˆ ์„ค๋ช…" + } + }, + "required": [ + "address" + ] + }, + { + "properties": { + "additionalInfo": { + "type": "object", + "oneOf": [ + { + "properties": { + "accountHolderGivenName": { + "type": "string" + }, + "accountHolderSurname": { + "type": "string" + }, + "accountHolderCity": { + "type": "string" + }, + "accountHolderCountry": { + "type": "string" + }, + "accountHolderAddress1": { + "type": "string" + }, + "accountHolderAddress2": { + "type": "string" + }, + "accountHolderDistrict": { + "type": "string" + }, + "accountHolderPostalCode": { + "type": "string" + }, + "iban": { + "type": "string" + }, + "ibanCity": { + "type": "string" + }, + "ibanCountry": { + "type": "string" + } + }, + "required": [ + "accountHolderGivenName", + "accountHolderCity", + "accountHolderCountry", + "accountHolderAddress1", + "accountHolderPostalCode", + "iban", + "ibanCity", + "ibanCountry" + ] + }, + { + "properties": { + "accountHolderGivenName": { + "type": "string" + }, + "accountHolderSurname": { + "type": "string" + }, + "accountHolderCity": { + "type": "string" + }, + "accountHolderCountry": { + "type": "string" + }, + "accountHolderAddress1": { + "type": "string" + }, + "accountHolderAddress2": { + "type": "string" + }, + "accountHolderDistrict": { + "type": "string" + }, + "accountHolderPostalCode": { + "type": "string" + }, + "abaRoutingNumber": { + "type": "string" + }, + "abaAccountNumber": { + "type": "string" + }, + "abaCountry": { + "type": "string" + } + }, + "required": [ + "accountHolderGivenName", + "accountHolderCity", + "accountHolderCountry", + "accountHolderAddress1", + "accountHolderPostalCode", + "abaRoutingNumber", + "abaAccountNumber", + "abaCountry" + ] + }, + { + "properties": { + "speiClabe": { + "type": "string" + }, + "speiName": { + "type": "string" + } + }, + "required": [ + "speiClabe" + ] + } + ] + } + }, + "required": [ + "additionalInfo" + ] + } + ] + } + } + } + } + }, + "delete": { + "summary": "์™ธ๋ถ€ ์ง€๊ฐ‘์—์„œ ์ž์‚ฐ ์‚ญ์ œ", + "description": "ID๋กœ ์™ธ๋ถ€ ์ง€๊ฐ‘ ์ž์‚ฐ์„ ์‚ญ์ œํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "External wallets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = fireblocks.delete_external_wallet_asset(walletId, assetId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.deleteExternalWalletAsset(walletId, assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "walletId", + "required": true, + "description": "์ง€๊ฐ‘์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "์‚ญ์ œํ•  ์ž์‚ฐ์˜ ID", + "schema": { + "type": "string", + "minimum": 1, + "x-fb-entity": "asset" + } + } + ], + "responses": { + "201": { + "description": "์ข‹์•„์š”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/contracts": { + "get": { + "summary": "๊ณ„์•ฝ ๋ชฉ๋ก", + "description": "๊ณ„์•ฝ ๋ชฉ๋ก์„ ๊ฐ€์ ธ์˜ต๋‹ˆ๋‹ค.", + "tags": [ + "Contracts" + ], + "responses": { + "200": { + "description": "๊ณ„์•ฝ ๋ชฉ๋ก", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "๊ณ„์•ฝ์„œ ์ž‘์„ฑ", + "description": "์ƒˆ๋กœ์šด ๊ณ„์•ฝ์„ ์ƒ์„ฑํ•ฉ๋‹ˆ๋‹ค.", + "tags": [ + "Contracts" + ], + "responses": { + "200": { + "description": "Wallet ๊ฐ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "type": "string", + "description": "๊ณ„์•ฝ์„œ์˜ ํ‘œ์‹œ ์ด๋ฆ„" + } + } + } + } + } + } + } + }, + "/contracts/{contractId}": { + "get": { + "summary": "ํŠน์ • ๊ณ„์•ฝ ์ฐพ๊ธฐ", + "description": "ID๋กœ ๊ณ„์•ฝ์„œ ๋ฐ˜ํ™˜.", + "tags": [ + "Contracts" + ], + "parameters": [ + { + "in": "path", + "name": "contractId", + "required": true, + "description": "๋ฐ˜ํ™˜ํ•  ๊ณ„์•ฝ์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "Wallet ๊ฐ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/UnmanagedWallet" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "delete": { + "summary": "๊ณ„์•ฝ ์‚ญ์ œ", + "description": "ID๋กœ ๊ณ„์•ฝ์„ ์‚ญ์ œํ•ฉ๋‹ˆ๋‹ค.", + "tags": [ + "Contracts" + ], + "parameters": [ + { + "in": "path", + "name": "contractId", + "required": true, + "description": "์‚ญ์ œํ•  ๊ณ„์•ฝ์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "201": { + "description": "์ข‹์•„์š”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/contracts/{contractId}/{assetId}": { + "get": { + "summary": "๊ณ„์•ฝ ์ž์‚ฐ ์ฐพ๊ธฐ", + "description": "ID๋กœ ๊ณ„์•ฝ ์ž์‚ฐ์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Contracts" + ], + "parameters": [ + { + "in": "path", + "name": "contractId", + "required": true, + "description": "๊ณ„์•ฝ์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "๋ฐ˜ํ™˜ํ•  ์ž์‚ฐ์˜ ID", + "schema": { + "type": "string", + "minimum": 1, + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "์ง€๊ฐ‘ ์ž์‚ฐ ๊ฐ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ExternalWalletAsset" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "๊ณ„์•ฝ์— ์ž์‚ฐ ์ถ”๊ฐ€", + "description": "๊ธฐ์กด ๊ณ„์•ฝ์— ์ž์‚ฐ์„ ์ถ”๊ฐ€ํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Contracts" + ], + "parameters": [ + { + "in": "path", + "name": "contractId", + "required": true, + "description": "๊ณ„์•ฝ์˜ ID", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "์ถ”๊ฐ€ํ•  ์ž์‚ฐ์˜ ID", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "์ง€๊ฐ‘ ์ž์‚ฐ ๊ฐ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ExternalWalletAsset" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "address": { + "type": "string", + "description": "์ง€๊ฐ‘์˜ ๊ณ„์•ฝ ์ฃผ์†Œ(๋˜๋Š” xpub)" + }, + "tag": { + "type": "string", + "description": "XRP ์ง€๊ฐ‘์˜ ๋ชฉ์ ์ง€ ํƒœ๊ทธ" + } + }, + "required": [ + "address" + ] + } + } + } + } + }, + "delete": { + "summary": "๊ณ„์•ฝ ์ž์‚ฐ ์‚ญ์ œ", + "description": "ID๋กœ ๊ณ„์•ฝ ์ž์‚ฐ์„ ์‚ญ์ œํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Contracts" + ], + "parameters": [ + { + "in": "path", + "name": "contractId", + "required": true, + "description": "๊ณ„์•ฝ์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + }, + { + "in": "path", + "name": "assetId", + "required": true, + "description": "์‚ญ์ œํ•  ์ž์‚ฐ์˜ ID", + "schema": { + "type": "string", + "minimum": 1, + "x-fb-entity": "asset" + } + } + ], + "responses": { + "201": { + "description": "์ข‹์•„์š”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/supported_assets": { + "get": { + "summary": "Fireblocks์—์„œ ์ง€์›ํ•˜๋Š” ๋ชจ๋“  ์ž์‚ฐ ์œ ํ˜•์„ ๋‚˜์—ดํ•ฉ๋‹ˆ๋‹ค.", + "description": "Fireblocks์—์„œ ์ง€์›ํ•˜๋Š” ๋ชจ๋“  ์ž์‚ฐ ์œ ํ˜•์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Blockchains & assets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "supportedAssets = fireblocks.get_supported_assets()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const supportedAssets = await fireblocks.getSupportedAssets();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "๊ฑฐ๋ž˜ ๊ฐ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AssetTypeResponse" + } + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/estimate_network_fee": { + "get": { + "summary": "์ž์‚ฐ์— ํ•„์š”ํ•œ ์ˆ˜์ˆ˜๋ฃŒ๋ฅผ ์ถ”์ •ํ•˜์„ธ์š”", + "description": "์ž์‚ฐ์— ํ•„์š”ํ•œ ์˜ˆ์ƒ ์ˆ˜์ˆ˜๋ฃŒ๋ฅผ ๊ฐ€์ ธ์˜ต๋‹ˆ๋‹ค. UTXO ๊ธฐ๋ฐ˜ ์ž์‚ฐ์˜ ๊ฒฝ์šฐ ์‘๋‹ต์—๋Š” ๋ฐ”์ดํŠธ๋‹น ์ œ์•ˆ ์ˆ˜์ˆ˜๋ฃŒ, ETH/ETC ๊ธฐ๋ฐ˜ ์ž์‚ฐ์˜ ๊ฒฝ์šฐ ์ œ์•ˆ ๊ฐ€์Šค ๊ฐ€๊ฒฉ, XRP/XLM์˜ ๊ฒฝ์šฐ ๊ฑฐ๋ž˜ ์ˆ˜์ˆ˜๋ฃŒ๊ฐ€ ํฌํ•จ๋ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Blockchains & assets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "fee_result = fireblocks.get_fee_for_asset(asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const feeResult = await fireblocks.getFeeForAsset(assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "query", + "name": "assetId", + "description": "์ˆ˜์ˆ˜๋ฃŒ๋ฅผ ์ถ”์ •ํ•  ์ž์‚ฐ", + "required": true, + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "์˜ˆ์ƒ ์ˆ˜์ˆ˜๋ฃŒ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/EstimatedNetworkFeeResponse" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/transactions/validate_address/{assetId}/{address}": { + "get": { + "summary": "๋ชฉ์ ์ง€ ์ฃผ์†Œ ๊ฒ€์ฆ", + "description": "์ฃผ์†Œ๊ฐ€ ์œ ํšจํ•œ์ง€ ํ™•์ธํ•ฉ๋‹ˆ๋‹ค(XRP, DOT, XLM ๋ฐ EOS์˜ ๊ฒฝ์šฐ).", + "tags": [ + "Blockchains & assets" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "const result = await fireblocks.validate_address(assetID, address)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.validateAddress(assetID, address)", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "assetId", + "required": true, + "description": "์ฃผ์†Œ์˜ ์ž์‚ฐ", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + }, + { + "in": "path", + "name": "address", + "required": true, + "description": "๊ฒ€์ฆํ•  ์ฃผ์†Œ", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "๊ฑฐ๋ž˜ ๊ฐ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ValidateAddressResponse" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/transactions": { + "get": { + "summary": "๊ฑฐ๋ž˜๋‚ด์—ญ ๋ชฉ๋ก", + "description": "์ž‘์—… ๊ณต๊ฐ„์˜ ๊ฑฐ๋ž˜ ๋‚ด์—ญ์„ ๋‚˜์—ดํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "transactions = fireblocks.get_transactions(status, after)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const transactions = await fireblocks.getTransactions({\n status: args.status,\nafter: from });\n", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "query", + "name": "before", + "description": "๋ฐ€๋ฆฌ์ดˆ ๋‹จ์œ„์˜ Unix ํƒ€์ž„์Šคํƒฌํ”„. ์ง€์ •๋œ ๋‚ ์งœ ์ด์ „์— ์ƒ์„ฑ๋œ ๊ฑฐ๋ž˜๋งŒ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "after", + "description": "๋ฐ€๋ฆฌ์ดˆ ๋‹จ์œ„์˜ Unix ํƒ€์ž„์Šคํƒฌํ”„์ž…๋‹ˆ๋‹ค. ์ง€์ •๋œ ๋‚ ์งœ ์ดํ›„์— ์ƒ์„ฑ๋œ ๊ฑฐ๋ž˜๋งŒ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "status", + "description": "๋‹ค์Œ ์ƒํƒœ ์ค‘ ํ•˜๋‚˜๋กœ ํ•„ํ„ฐ๋งํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค..", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "orderBy", + "description": "๊ฒฐ๊ณผ๋ฅผ ์ •๋ ฌํ•  ํ•„๋“œ **์ฐธ๊ณ **: createdAt๊ฐ€ ์•„๋‹Œ ํ•„๋“œ๋กœ ์ •๋ ฌํ•˜๋ฉด ๋‹ค์Œ ๋˜๋Š” ์ด์ „ ํŽ˜์ด์ง€ ๊ฒฐ๊ณผ๋ฅผ ์š”์ฒญํ•  ๋•Œ ์—…๋ฐ์ดํŠธ๋ฅผ ๋ฐ›๋Š” ๊ฑฐ๋ž˜๊ฐ€ ๋ฐœ์ƒํ•˜์—ฌ ํ•ด๋‹น ๊ฑฐ๋ž˜๊ฐ€ ๋ˆ„๋ฝ๋  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค..", + "required": false, + "schema": { + "oneOf": [ + { + "const": "createdAt" + }, + { + "const": "lastUpdated" + } + ] + } + }, + { + "in": "query", + "name": "sort", + "description": "๊ฒฐ๊ณผ๋ฅผ ์ •๋ ฌํ•˜๋Š” ๋ฐฉํ–ฅ", + "required": false, + "schema": { + "oneOf": [ + { + "const": "ASC" + }, + { + "const": "DESC" + } + ] + } + }, + { + "in": "query", + "name": "limit", + "description": "๊ฒฐ๊ณผ ์ˆ˜๋ฅผ ์ œํ•œํ•ฉ๋‹ˆ๋‹ค. ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด 200์œผ๋กœ ์ œํ•œ๋ฉ๋‹ˆ๋‹ค. ํ—ˆ์šฉ๋˜๋Š” ์ตœ๋Œ€ ํ•œ๋„๋Š” 500์ž…๋‹ˆ๋‹ค.", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "default": 200 + } + }, + { + "in": "query", + "name": "sourceType", + "description": "๊ฑฐ๋ž˜์˜ ์†Œ์Šค ์œ ํ˜•", + "required": false, + "schema": { + "oneOf": [ + { + "const": "VAULT_ACCOUNT" + }, + { + "const": "EXCHANGE_ACCOUNT" + }, + { + "const": "INTERNAL_WALLET" + }, + { + "const": "EXTERNAL_WALLET" + }, + { + "const": "FIAT_ACCOUNT" + }, + { + "const": "NETWORK_CONNECTION" + }, + { + "const": "COMPOUND" + }, + { + "const": "UNKNOWN" + }, + { + "const": "GAS_STATION" + }, + { + "const": "END_USER_WALLET" + } + ] + } + }, + { + "in": "query", + "name": "sourceId", + "description": "๊ฑฐ๋ž˜์˜ ์†Œ์Šค ID", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "destType", + "description": "๊ฑฐ๋ž˜์˜ ๋ชฉ์ ์ง€ ์œ ํ˜•", + "required": false, + "schema": { + "oneOf": [ + { + "const": "VAULT_ACCOUNT" + }, + { + "const": "EXCHANGE_ACCOUNT" + }, + { + "const": "INTERNAL_WALLET" + }, + { + "const": "EXTERNAL_WALLET" + }, + { + "const": "FIAT_ACCOUNT" + }, + { + "const": "NETWORK_CONNECTION" + }, + { + "const": "COMPOUND" + }, + { + "const": "ONE_TIME_ADDRESS" + }, + { + "const": "END_USER_WALLET" + } + ] + } + }, + { + "in": "query", + "name": "destId", + "description": "๊ฑฐ๋ž˜์˜ ๋ชฉ์ ์ง€ ID", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "assets", + "description": "์‰ผํ‘œ๋กœ ๊ตฌ๋ถ„๋œ ํ•„ํ„ฐ๋ง ๋Œ€์ƒ ์ž์‚ฐ ๋ชฉ๋ก", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "txHash", + "description": "์ง€์ •๋œ txHash๋ฅผ ํฌํ•จํ•˜๋Š” ๊ฒฐ๊ณผ๋งŒ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "sourceWalletId", + "description": "์†Œ์Šค๊ฐ€ ํŠน์ • ์ตœ์ข… ์‚ฌ์šฉ์ž ์ง€๊ฐ‘์ธ ๊ฒฝ์šฐ์—๋งŒ ๊ฒฐ๊ณผ๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "destWalletId", + "description": "๋Œ€์ƒ์ด ํŠน์ • ์ตœ์ข… ์‚ฌ์šฉ์ž ์ง€๊ฐ‘์ธ ๊ฒฝ์šฐ์—๋งŒ ๊ฒฐ๊ณผ๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค.", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "๊ฑฐ๋ž˜ ๋ชฉ๋ก", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + }, + "next-page": { + "schema": { + "type": "string" + }, + "description": "๋‹ค์Œ ํŽ˜์ด์ง€์˜ ๊ฒฐ๊ณผ๋ฅผ ์ˆ˜์‹ ํ•˜๊ธฐ ์œ„ํ•œ ์ด API ์—”๋“œํฌ์ธํŠธ์— ๋Œ€ํ•œ ์ƒˆ ์š”์ฒญ์„ ๋‚˜ํƒ€๋‚ด๋Š” URL.", + "in": "header" + }, + "prev-page": { + "schema": { + "type": "string" + }, + "description": "์ด์ „ ํŽ˜์ด์ง€์˜ ๊ฒฐ๊ณผ๋ฅผ ์ˆ˜์‹ ํ•˜๊ธฐ ์œ„ํ•œ ์ด API ์—”๋“œํฌ์ธํŠธ์— ๋Œ€ํ•œ ์ƒˆ ์š”์ฒญ์„ ๋‚˜ํƒ€๋‚ด๋Š” URL.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TransactionResponse" + } + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "์ƒˆ๋กœ์šด ๊ฑฐ๋ž˜๋ฅผ ์ƒ์„ฑํ•˜์„ธ์š”", + "description": "์ƒˆ๋กœ์šด ๊ฑฐ๋ž˜๋ฅผ ์ƒ์„ฑํ•ฉ๋‹ˆ๋‹ค.", + "tags": [ + "Transactions" + ], + "parameters": [ + { + "in": "header", + "name": "X-End-User-Wallet-Id", + "schema": { + "$ref": "#/components/headers/X-End-User-Wallet-Id" + } + } + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "tx_result = client.create_transaction( asset_id=\"BTC\", amount=\"50\", source=TransferPeerPath(VAULT_ACCOUNT, from_vault_account_id), destination=DestinationTransferPeerPath(VAULT_ACCOUNT, to_vault_account_id) )\n", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const payload: TransactionArguments = { assetId: asset, source: { type: sourceType, id: sourceId || 0 }, destination: { type: destinationType, id: String(destinationId) }, amount: String(amount), fee: String(fee), note: \"Created by fireblocks SDK\" }; const result = await fireblocks.createTransaction(payload);\n", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "๊ฑฐ๋ž˜ ๊ฐ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateTransactionResponse" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TransactionRequest" + } + } + } + } + } + }, + "/transactions/estimate_fee": { + "post": { + "summary": "๊ฑฐ๋ž˜ ์ˆ˜์ˆ˜๋ฃŒ ์ถ”์ •", + "description": "๊ฑฐ๋ž˜ ์š”์ฒญ์— ๋Œ€ํ•œ ๊ฑฐ๋ž˜ ์ˆ˜์ˆ˜๋ฃŒ๋ฅผ ์ถ”์ •ํ•ฉ๋‹ˆ๋‹ค. * ์ฐธ๊ณ : ZCash(ZEC)๋ฅผ ์ œ์™ธํ•œ ๋ชจ๋“  Fireblocks ์ž์‚ฐ์„ ์ง€์›ํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "estimated_fee = client.estimate_fee_for_transaction( asset_id=\"BTC\", amount=\"50\", source=TransferPeerPath(VAULT_ACCOUNT, from_vault_account_id), destination=DestinationTransferPeerPath(VAULT_ACCOUNT, to_vault_account_id) )\n", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const payload: TransactionArguments = { assetId: asset, source: { type: sourceType, id: sourceId || 0 }, destination: { type: destinationType, id: String(destinationId) }, amount: Number(amount) }; const estimatedFee = await fireblocks.estimateFeeForTransaction(payload);\n", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TransactionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "์˜ˆ์ƒ ์ˆ˜์ˆ˜๋ฃŒ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/EstimatedTransactionFeeResponse" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/transactions/{txId}": { + "get": { + "summary": "Fireblocks ๊ฑฐ๋ž˜ ID๋กœ ํŠน์ • ๊ฑฐ๋ž˜ ์ฐพ๊ธฐ", + "description": "ID๋กœ ๊ฑฐ๋ž˜๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค.", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "tx = fireblocks.get_transaction_by_id(txId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const tx = await fireblocks.getTransactionById(txId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "txId", + "required": true, + "example": "00000000-0000-0000-0000-000000000000", + "description": "๋ฐ˜ํ™˜ํ•  ๊ฑฐ๋ž˜์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "๊ฑฐ๋ž˜ ๊ฐ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/TransactionResponse" + } + } + } + }, + "400": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/transactions/external_tx_id/{externalTxId}/": { + "get": { + "summary": "์™ธ๋ถ€ ๊ฑฐ๋ž˜ ID๋กœ ํŠน์ • ๊ฑฐ๋ž˜ ์ฐพ๊ธฐ", + "description": "์™ธ๋ถ€ ๊ฑฐ๋ž˜ ID๋กœ ๊ฑฐ๋ž˜๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "tx = fireblocks.get_transaction_by_external_tx_id(externalTxId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const tx = await fireblocks.getTransactionByExternalTxId(externalTxId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "externalTxId", + "example": "00000000-0000-0000-0000-000000000000", + "required": true, + "description": "๋ฐ˜ํ™˜ํ•  ๊ฑฐ๋ž˜์˜ ์™ธ๋ถ€ ID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "๊ฑฐ๋ž˜ ๊ฐ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/TransactionResponse" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/transactions/{txId}/set_confirmation_threshold": { + "post": { + "summary": "๊ฑฐ๋ž˜ ID๋กœ ํ™•์ธ ์ž„๊ณ„๊ฐ’ ์„ค์ •", + "description": "๊ฑฐ๋ž˜ ID์— ๋”ฐ๋ฅธ ๊ฑฐ๋ž˜ ์™„๋ฃŒ์— ํ•„์š”ํ•œ ํ™•์ธ ํšŸ์ˆ˜๋ฅผ ์žฌ์ •์˜ํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "set_conf_threshold = client.set_confirmation_threshold_by_tx_id(body)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const setConfThreshold = await fireblocks.setConfirmationThresholdByTxId(body);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SetConfirmationsThresholdRequest" + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "txId", + "required": true, + "description": "๊ฑฐ๋ž˜์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์œผ๋กœ ์„ค์ •๋˜์—ˆ์Šต๋‹ˆ๋‹ค", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SetConfirmationsThresholdResponse" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/transactions/{txId}/drop": { + "post": { + "summary": "ID๋กœ ETH ๊ฑฐ๋ž˜ ์‚ญ์ œ", + "description": "์ค‘๋‹จ๋œ ETH ๊ฑฐ๋ž˜๋ฅผ ์‚ญ์ œํ•˜๊ณ  ๋Œ€์ฒด ๊ฑฐ๋ž˜๋ฅผ ์ƒ์„ฑํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = fireblocks.drop_transaction(txId, fee_level)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.dropTransaction(txId, feeLevel);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DropTransactionRequest" + } + } + } + }, + "parameters": [ + { + "in": "header", + "name": "X-End-User-Wallet-Id", + "schema": { + "$ref": "#/components/headers/X-End-User-Wallet-Id" + } + }, + { + "in": "path", + "name": "txId", + "required": true, + "description": "๊ฑฐ๋ž˜์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์œผ๋กœ ์ƒ์„ฑ๋˜์—ˆ์Šต๋‹ˆ๋‹ค", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/DropTransactionResponse" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/transactions/{txId}/cancel": { + "post": { + "summary": "๊ฑฐ๋ž˜ ์ทจ์†Œ", + "description": "ID๋กœ ๊ฑฐ๋ž˜ ์ทจ์†Œ.", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = fireblocks.cancel_transaction_by_id(txId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.cancelTransactionById(txId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "header", + "name": "X-End-User-Wallet-Id", + "schema": { + "$ref": "#/components/headers/X-End-User-Wallet-Id" + } + }, + { + "in": "path", + "name": "txId", + "required": true, + "description": "์ทจ์†Œํ•  ๊ฑฐ๋ž˜์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "๊ฑฐ๋ž˜ ๊ฐ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CancelTransactionResponse" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/transactions/{txId}/freeze": { + "post": { + "summary": "๊ฑฐ๋ž˜ ๋™๊ฒฐ", + "description": "ID๋กœ ๊ฑฐ๋ž˜๋ฅผ ๋™๊ฒฐํ•ฉ๋‹ˆ๋‹ค.", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = fireblocks.freeze_transaction(txId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.freezeTransaction(txId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "header", + "name": "X-End-User-Wallet-Id", + "schema": { + "$ref": "#/components/headers/X-End-User-Wallet-Id" + } + }, + { + "in": "path", + "name": "txId", + "required": true, + "description": "๋™๊ฒฐํ•  ๊ฑฐ๋ž˜์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "๋™๊ฒฐ ๋ฐ˜์‘", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/FreezeTransactionResponse" + } + } + } + } + } + } + }, + "/transactions/{txId}/unfreeze": { + "post": { + "summary": "๊ฑฐ๋ž˜ ํ•ด์ œ", + "description": "ID๋กœ ๊ฑฐ๋ž˜๋ฅผ ๋™๊ฒฐ ํ•ด์ œํ•˜๊ณ  ๊ฑฐ๋ž˜๋ฅผ ๋‹ค์‹œ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ๊ฒŒ ํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = fireblocks.unfreeze_transaction(txId)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.unfreezeTransaction(txId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "header", + "name": "X-End-User-Wallet-Id", + "schema": { + "$ref": "#/components/headers/X-End-User-Wallet-Id" + } + }, + { + "in": "path", + "name": "txId", + "required": true, + "description": "๋™๊ฒฐ ํ•ด์ œํ•  ๊ฑฐ๋ž˜์˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "๋™๊ฒฐ ํ•ด์ œ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/UnfreezeTransactionResponse" + } + } + } + } + } + } + }, + "/txHash/{txHash}/set_confirmation_threshold": { + "post": { + "summary": "๊ฑฐ๋ž˜ ํ•ด์‹œ๋กœ ํ™•์ธ ์ž„๊ณ„๊ฐ’ ์„ค์ •", + "description": "๊ฑฐ๋ž˜ ํ•ด์‹œ๋กœ ๊ฑฐ๋ž˜ ์™„๋ฃŒ์— ํ•„์š”ํ•œ ํ™•์ธ ํšŸ์ˆ˜๋ฅผ ์žฌ์ •์˜ํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Transactions" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "set_conf_threshold = client.set_confirmation_threshold_by_tx_hash(body)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const setConfThreshold = await fireblocks.setConfirmationThresholdByTxHash(body);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SetConfirmationsThresholdRequest" + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "txHash", + "required": true, + "description": "Txํ•ด์‹œ", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "๋ณ€๊ฒฝ์œผ๋กœ ์ธํ•ด ์˜ํ–ฅ์„ ๋ฐ›๋Š” ๊ฑฐ๋ž˜ ๋ชฉ๋ก", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SetConfirmationsThresholdResponse" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/payments/xb-settlements/configs": { + "post": { + "tags": [ + "Payments - cross-border settlement" + ], + "summary": "์ƒˆ๋กœ์šด ๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ๊ตฌ์„ฑ์„ ๋งŒ๋“ญ๋‹ˆ๋‹ค.", + "description": "์ƒˆ๋กœ์šด ๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ๊ตฌ์„ฑ์„ ๋งŒ๋“ญ๋‹ˆ๋‹ค.
๊ตฌ์„ฑ์—์„œ๋Š” ๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ์— ์‚ฌ์šฉํ•  ๊ธฐ๋ณธ ์ž์‚ฐ, ์˜จ๋žจํ”„, ์˜คํ”„๋žจํ”„๋ฅผ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค.
๊ตฌ์„ฑ์—๋Š” ์ตœ์†Œํ•œ `ON_RAMP`์™€ `VAULT_ACCOUNT`์˜ ๋‘ ๋‹จ๊ณ„๊ฐ€ ํฌํ•จ๋˜์–ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.
๋‹ค๋ฅธ ๋ชจ๋“  ๋‹จ๊ณ„(์˜ˆ: `OFF_RAMP`, `FIAT_DESTINATION` ๋“ฑ)๋Š” ์„ ํƒ ์‚ฌํ•ญ์ž…๋‹ˆ๋‹ค.
๋ชจ๋“  ๋‹จ๊ณ„์—๋Š” ์‚ฌ์šฉํ•  `accountId`๊ฐ€ ํฌํ•จ๋˜์–ด์•ผ ํ•˜๋ฉฐ, `inputAssetId`์™€ `outputAssetId`๋Š” ์„ ํƒ ์‚ฌํ•ญ์ž…๋‹ˆ๋‹ค. ์ด๋Ÿฌํ•œ ํ•ญ๋ชฉ์ด ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด Corridor Settings์˜ ๊ธฐ๋ณธ๊ฐ’์ด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค.
inputAssetId ๋˜๋Š” outputAssetId๊ฐ€ ๊ฐ์ฒด ์ค‘ ํ•˜๋‚˜์— ์ œ๊ณต๋œ ๊ฒฝ์šฐ ๊ฐ์ฒด์˜ ๋ชจ๋“  ์ž์‚ฐ์€ ์ผ๊ด€๋˜์–ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ์˜ˆ๋ฅผ ๋“ค์–ด ON_RAMP์˜ ์ถœ๋ ฅ ์ž์‚ฐ์ด XLM_USDC_5F3T์ธ ๊ฒฝ์šฐ VAULT_ACCOUNT์˜ ์ž…๋ ฅ ์ž์‚ฐ๋„ XLM_USDC_5F3T์—ฌ์•ผ ํ•ฉ๋‹ˆ๋‹ค.
๊ตฌ์„ฑ์— ๋Œ€ํ•œ ์Šฌ๋ฆฌํ”ผ์ง€ ๊ธˆ์•ก์„ ์„ค์ •ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์Šฌ๋ฆฌํ”ผ์ง€๋Š” ๊ธฐ์ค€์ (bps)์œผ๋กœ ์ •์˜๋ฉ๋‹ˆ๋‹ค. ์ด ๊ฐ’์€ ์‹คํ–‰ ์‹œ ์˜ค๋ฒ„๋กœ๋“œ๋  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์Šฌ๋ฆฌํ”ผ์ง€ ๊ธˆ์•ก์„ ๊ตฌ์„ฑํ•˜์ง€ ์•Š์œผ๋ฉด ๊ธฐ๋ณธ ์Šฌ๋ฆฌํ”ผ์ง€์ธ 10000bps(10%)๊ฐ€ ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค.
**์ฐธ๊ณ :** ์ด ์„น์…˜์˜ ์ฐธ์กฐ ์ฝ˜ํ…์ธ ๋Š” Payments Engine ์—”๋“œํฌ์ธํŠธ๋ฅผ ์„ค๋ช…ํ•ฉ๋‹ˆ๋‹ค. Payments Engine ์—”๋“œํฌ์ธํŠธ์—๋Š” ๊ณ„์ •์—์„œ Payments Engine์„ ํ™œ์„ฑํ™”ํ•œ ๊ณ ๊ฐ์—๊ฒŒ๋งŒ ์ œ๊ณต๋˜๋Š” API๊ฐ€ ํฌํ•จ๋ฉ๋‹ˆ๋‹ค. ์ด๋Ÿฌํ•œ ์—”๋“œํฌ์ธํŠธ๋Š” ํ˜„์žฌ ๋ฒ ํƒ€ ์ƒํƒœ์ด๋ฉฐ ๋ณ€๊ฒฝ๋  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. Fireblocks Payments Engine์— ๋Œ€ํ•ด ์ž์„ธํžˆ ์•Œ์•„๋ณด๋ ค๋ฉด Fireblocks ๊ณ ๊ฐ ์„ฑ๊ณต ๊ด€๋ฆฌ์ž์—๊ฒŒ ๋ฌธ์˜ํ•˜๊ฑฐ๋‚˜ CSM@fireblocks.com์œผ๋กœ ์ด๋ฉ”์ผ์„ ๋ณด๋‚ด์ฃผ์„ธ์š”..", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementConfigCreationRequestBody" + }, + "example": { + "name": "Flow Config Example", + "corridorId": "CO_US", + "steps": { + "ON_RAMP": { + "accountId": "3b7a1451-3453-4c96-a6a5-683cc8971d04" + }, + "VAULT_ACCOUNT": { + "accountId": "2" + }, + "OFF_RAMP": { + "accountId": "f2f74204-93ec-4614-870a-4ea2ad13aa0b" + } + }, + "conversionSlippageBasisPoints": 75 + } + } + } + }, + "responses": { + "200": { + "description": "๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ๊ตฌ์„ฑ์ด ์„ฑ๊ณต์ ์œผ๋กœ ์ƒ์„ฑ๋˜์—ˆ์Šต๋‹ˆ๋‹ค.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementConfigCreationResponse" + }, + "example": { + "configId": "074791cc-ef32-4920-8373-95efbeea66c5", + "corridorId": "CO_US", + "name": "Flow Config Example", + "steps": { + "ON_RAMP": { + "accountId": "3b7a1451-3453-4c96-a6a5-683cc8971d04", + "inputAssetId": "COP", + "outputAssetId": "USD" + }, + "VAULT_ACCOUNT": { + "accountId": "2", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + }, + "OFF_RAMP": { + "accountId": "f2f74204-93ec-4614-870a-4ea2ad13aa0b", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + } + }, + "conversionSlippageBasisPoints": 75, + "createdAt": 1680625226267 + } + } + } + }, + "400": { + "description": "๊ตญ๊ฒฝ ๊ฐ„ ์š”์ฒญ ์ƒ์„ฑ ์ค‘ ์˜ค๋ฅ˜ ๋ฐœ์ƒ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "์Šน์ธ๋˜์ง€ ์•Š์Œ. Authorization ํ—ค๋”์— JWT ํ† ํฐ์ด ์—†๊ฑฐ๋‚˜ ์ž˜๋ชป๋จ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "๋‚ด๋ถ€ ์˜ค๋ฅ˜.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "get": { + "tags": [ + "Payments - cross-border settlement" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "summary": "๋ชจ๋“  ๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ๊ตฌ์„ฑ์„ ์–ป์œผ์„ธ์š”", + "description": "๋ชจ๋“  ๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ๊ตฌ์„ฑ์„ ํ™•์ธํ•˜์„ธ์š”.
**์ฐธ๊ณ :** ์ด ์„น์…˜์˜ ์ฐธ์กฐ ์ฝ˜ํ…์ธ ๋Š” Payments Engine ์—”๋“œํฌ์ธํŠธ๋ฅผ ์„ค๋ช…ํ•ฉ๋‹ˆ๋‹ค. Payments Engine ์—”๋“œํฌ์ธํŠธ์—๋Š” ๊ณ„์ •์—์„œ Payments Engine์„ ํ™œ์„ฑํ™”ํ•œ ๊ณ ๊ฐ์—๊ฒŒ๋งŒ ์ œ๊ณต๋˜๋Š” API๊ฐ€ ํฌํ•จ๋ฉ๋‹ˆ๋‹ค. ์ด๋Ÿฌํ•œ ์—”๋“œํฌ์ธํŠธ๋Š” ํ˜„์žฌ ๋ฒ ํƒ€ ์ƒํƒœ์ด๋ฉฐ ๋ณ€๊ฒฝ๋  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. Fireblocks Payments Engine์— ๋Œ€ํ•ด ์ž์„ธํžˆ ์•Œ์•„๋ณด๋ ค๋ฉด Fireblocks ๊ณ ๊ฐ ์„ฑ๊ณต ๊ด€๋ฆฌ์ž์—๊ฒŒ ๋ฌธ์˜ํ•˜๊ฑฐ๋‚˜ CSM@fireblocks.com์œผ๋กœ ์ด๋ฉ”์ผ์„ ๋ณด๋‚ด์ฃผ์„ธ์š”..", + "responses": { + "200": { + "description": "๋ชจ๋“  ๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ๊ตฌ์„ฑ์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementGetAllConfigsResponse" + }, + "example": { + "configurations": [ + { + "configId": "074791cc-ef32-4920-8373-95efbeea66c5", + "corridorId": "CO_US", + "name": "Flow Config Example", + "steps": { + "ON_RAMP": { + "accountId": "3b7a1451-3453-4c96-a6a5-683cc8971d04", + "inputAssetId": "COP", + "outputAssetId": "USD" + }, + "VAULT_ACCOUNT": { + "accountId": "2", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + }, + "OFF_RAMP": { + "accountId": "f2f74204-93ec-4614-870a-4ea2ad13aa0b", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + } + }, + "conversionSlippageBasisPoints": 75, + "createdAt": 1680625226267 + }, + { + "configId": "a4b0a706-4578-4467-bd5b-a852761dd2aa", + "corridorId": "MX_US", + "name": "MX to US flow", + "steps": { + "ON_RAMP": { + "accountId": "3d6241ad-879b-4a11-842f-4cee9cd7fbba", + "inputAssetId": "MXN", + "outputAssetId": "USD" + }, + "VAULT_ACCOUNT": { + "accountId": "1", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + }, + "OFF_RAMP": { + "accountId": "1cf7f750-117f-4c36-b4ef-14c420d118ce", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + } + }, + "conversionSlippageBasisPoints": 10, + "createdAt": 1665166171134 + } + ] + } + } + } + }, + "401": { + "description": "์Šน์ธ๋˜์ง€ ์•Š์Œ. Authorization ํ—ค๋”์— JWT ํ† ํฐ์ด ์—†๊ฑฐ๋‚˜ ์ž˜๋ชป๋จ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "๋‚ด๋ถ€ ์˜ค๋ฅ˜.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/payments/xb-settlements/configs/{configId}": { + "get": { + "tags": [ + "Payments - cross-border settlement" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "summary": "ํŠน์ • ๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ๊ตฌ์„ฑ์„ ์–ป์œผ์„ธ์š”", + "description": "ํŠน์ • ๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ๊ตฌ์„ฑ์„ ๋ฐ›์œผ์„ธ์š”.
**์ฐธ๊ณ :** ์ด ์„น์…˜์˜ ์ฐธ์กฐ ์ฝ˜ํ…์ธ ๋Š” Payments Engine ์—”๋“œํฌ์ธํŠธ๋ฅผ ์„ค๋ช…ํ•ฉ๋‹ˆ๋‹ค. Payments Engine ์—”๋“œํฌ์ธํŠธ์—๋Š” ๊ณ„์ •์—์„œ Payments Engine์„ ํ™œ์„ฑํ™”ํ•œ ๊ณ ๊ฐ์—๊ฒŒ๋งŒ ์ œ๊ณต๋˜๋Š” API๊ฐ€ ํฌํ•จ๋ฉ๋‹ˆ๋‹ค. ์ด๋Ÿฌํ•œ ์—”๋“œํฌ์ธํŠธ๋Š” ํ˜„์žฌ ๋ฒ ํƒ€ ์ƒํƒœ์ด๋ฉฐ ๋ณ€๊ฒฝ๋  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. Fireblocks Payments Engine์— ๋Œ€ํ•ด ์ž์„ธํžˆ ์•Œ์•„๋ณด๋ ค๋ฉด Fireblocks ๊ณ ๊ฐ ์„ฑ๊ณต ๊ด€๋ฆฌ์ž์—๊ฒŒ ๋ฌธ์˜ํ•˜๊ฑฐ๋‚˜ CSM@fireblocks.com์œผ๋กœ ์ด๋ฉ”์ผ์„ ๋ณด๋‚ด์ฃผ์„ธ์š”..", + "parameters": [ + { + "in": "path", + "name": "configId", + "required": true, + "description": "๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ๊ตฌ์„ฑ ID.", + "schema": { + "type": "string" + }, + "example": "074791cc-ef32-4920-8373-95efbeea66c5" + } + ], + "responses": { + "200": { + "description": "์š”์ฒญ๋œ ๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ๊ตฌ์„ฑ์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementGetConfigResponse" + }, + "example": { + "configId": "074791cc-ef32-4920-8373-95efbeea66c5", + "corridorId": "CO_US", + "name": "Flow Config Example", + "steps": { + "ON_RAMP": { + "accountId": "3b7a1451-3453-4c96-a6a5-683cc8971d04", + "inputAssetId": "COP", + "outputAssetId": "USD" + }, + "VAULT_ACCOUNT": { + "accountId": "2", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + }, + "OFF_RAMP": { + "accountId": "f2f74204-93ec-4614-870a-4ea2ad13aa0b", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + } + }, + "conversionSlippageBasisPoints": 75, + "createdAt": 1680625226267 + } + } + } + }, + "401": { + "description": "์Šน์ธ๋˜์ง€ ์•Š์Œ. Authorization ํ—ค๋”์— JWT ํ† ํฐ์ด ์—†๊ฑฐ๋‚˜ ์ž˜๋ชป๋จ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "์ œ๊ณต๋œ ID๋กœ๋Š” ๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ๊ตฌ์„ฑ์ด ์กด์žฌํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "๋‚ด๋ถ€ ์˜ค๋ฅ˜.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "Payments - cross-border settlement" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "summary": "๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ๊ตฌ์„ฑ ํŽธ์ง‘", + "description": "๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ๊ตฌ์„ฑ์„ ํŽธ์ง‘ํ•ฉ๋‹ˆ๋‹ค. ๊ตฌ์„ฑ์„ ํŽธ์ง‘ํ•ด๋„ ๊ตฌ์„ฑ์„ ์‚ฌ์šฉํ•œ ์ด์ „์— ์‹คํ–‰๋œ ํ๋ฆ„์—๋Š” ์˜ํ–ฅ์„ ๋ฏธ์น˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค. **์ฐธ๊ณ :** ์ด ์„น์…˜์˜ ์ฐธ์กฐ ์ฝ˜ํ…์ธ ๋Š” ๊ฒฐ์ œ ์—”์ง„ ์—”๋“œํฌ์ธํŠธ๋ฅผ ์„ค๋ช…ํ•ฉ๋‹ˆ๋‹ค. ๊ฒฐ์ œ ์—”์ง„ ์—”๋“œํฌ์ธํŠธ์—๋Š” ๊ณ„์ •์—์„œ ๊ฒฐ์ œ ์—”์ง„์„ ํ™œ์„ฑํ™”ํ•œ ๊ณ ๊ฐ์—๊ฒŒ๋งŒ ์ œ๊ณต๋˜๋Š” API๊ฐ€ ํฌํ•จ๋ฉ๋‹ˆ๋‹ค. ์ด๋Ÿฌํ•œ ์—”๋“œํฌ์ธํŠธ๋Š” ํ˜„์žฌ ๋ฒ ํƒ€ ์ƒํƒœ์ด๋ฉฐ ๋ณ€๊ฒฝ๋  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. Fireblocks ๊ฒฐ์ œ ์—”์ง„์— ๋Œ€ํ•ด ์ž์„ธํžˆ ์•Œ์•„๋ณด๋ ค๋ฉด Fireblocks ๊ณ ๊ฐ ์„ฑ๊ณต ๊ด€๋ฆฌ์ž์—๊ฒŒ ๋ฌธ์˜ํ•˜๊ฑฐ๋‚˜ CSM@fireblocks.com์œผ๋กœ ์ด๋ฉ”์ผ์„ ๋ณด๋‚ด์ฃผ์„ธ์š”..", + "parameters": [ + { + "in": "path", + "name": "configId", + "required": true, + "description": "๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ๊ตฌ์„ฑ ID.", + "schema": { + "type": "string" + }, + "example": "074791cc-ef32-4920-8373-95efbeea66c5" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementConfigEditRequestBody" + }, + "example": { + "name": "Flow Config Example - Edited", + "steps": { + "ON_RAMP": { + "accountId": "e9dec04a-3c57-4052-a89a-288c545f6430" + }, + "VAULT_ACCOUNT": { + "accountId": "2" + }, + "OFF_RAMP": { + "accountId": "f2f74204-93ec-4614-870a-4ea2ad13aa0b" + } + }, + "corridorId": "CO_US", + "conversionSlippageBasisPoints": 30 + } + } + } + }, + "responses": { + "200": { + "description": "๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ๊ตฌ์„ฑ์ด ์„ฑ๊ณต์ ์œผ๋กœ ํŽธ์ง‘๋˜์—ˆ์Šต๋‹ˆ๋‹ค.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementConfigEditResponse" + }, + "example": { + "configId": "074791cc-ef32-4920-8373-95efbeea66c5", + "corridorId": "CO_US", + "name": "Flow Config Example - Edited", + "steps": { + "ON_RAMP": { + "accountId": "e9dec04a-3c57-4052-a89a-288c545f6430", + "inputAssetId": "COP", + "outputAssetId": "USD" + }, + "VAULT_ACCOUNT": { + "accountId": "2", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + }, + "OFF_RAMP": { + "accountId": "f2f74204-93ec-4614-870a-4ea2ad13aa0b", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + } + }, + "conversionSlippageBasisPoints": 30, + "createdAt": 1680625226267 + } + } + } + }, + "400": { + "description": "๊ตญ๊ฒฝ ๊ฐ„ ์š”์ฒญ์„ ๋งŒ๋“œ๋Š” ์ค‘ ์˜ค๋ฅ˜๊ฐ€ ๋ฐœ์ƒํ–ˆ์Šต๋‹ˆ๋‹ค. ๊ตฌ์„ฑ์ด ์ˆ˜์ •๋˜์ง€ ์•Š์•˜์Šต๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "์Šน์ธ๋˜์ง€ ์•Š์Œ. Authorization ํ—ค๋”์— JWT ํ† ํฐ์ด ์—†๊ฑฐ๋‚˜ ์ž˜๋ชป๋จ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "์ œ๊ณต๋œ ID๋กœ๋Š” ๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ๊ตฌ์„ฑ์ด ์กด์žฌํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "๋‚ด๋ถ€ ์˜ค๋ฅ˜.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Payments - cross-border settlement" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "configId", + "required": true, + "description": "๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ๊ตฌ์„ฑ ID.", + "schema": { + "type": "string" + }, + "example": "074791cc-ef32-4920-8373-95efbeea66c5" + } + ], + "summary": "๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ๊ตฌ์„ฑ ์‚ญ์ œ", + "description": "๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ๊ตฌ์„ฑ์„ ์‚ญ์ œํ•ฉ๋‹ˆ๋‹ค. ์ด ๊ตฌ์„ฑ์„ ์‚ฌ์šฉํ•˜์—ฌ ์ด์ „์— ์‹คํ–‰ํ•œ ํ๋ฆ„์€ ์‚ญ์ œํ•˜๊ฑฐ๋‚˜ ์ œ๊ฑฐํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค. **์ฐธ๊ณ :** ์ด ์„น์…˜์˜ ์ฐธ์กฐ ์ฝ˜ํ…์ธ ๋Š” ๊ฒฐ์ œ ์—”์ง„ ์—”๋“œํฌ์ธํŠธ๋ฅผ ์„ค๋ช…ํ•ฉ๋‹ˆ๋‹ค. ๊ฒฐ์ œ ์—”์ง„ ์—”๋“œํฌ์ธํŠธ์—๋Š” ๊ณ„์ •์—์„œ ๊ฒฐ์ œ ์—”์ง„์„ ํ™œ์„ฑํ™”ํ•œ ๊ณ ๊ฐ์—๊ฒŒ๋งŒ ์ œ๊ณต๋˜๋Š” API๊ฐ€ ํฌํ•จ๋ฉ๋‹ˆ๋‹ค. ์ด๋Ÿฌํ•œ ์—”๋“œํฌ์ธํŠธ๋Š” ํ˜„์žฌ ๋ฒ ํƒ€ ์ƒํƒœ์ด๋ฉฐ ๋ณ€๊ฒฝ๋  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. Fireblocks ๊ฒฐ์ œ ์—”์ง„์— ๋Œ€ํ•ด ์ž์„ธํžˆ ์•Œ์•„๋ณด๋ ค๋ฉด Fireblocks ๊ณ ๊ฐ ์„ฑ๊ณต ๊ด€๋ฆฌ์ž์—๊ฒŒ ๋ฌธ์˜ํ•˜๊ฑฐ๋‚˜ CSM@fireblocks.com์œผ๋กœ ์ด๋ฉ”์ผ์„ ๋ณด๋‚ด์ฃผ์„ธ์š”..", + "responses": { + "200": { + "description": "๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ๊ตฌ์„ฑ์ด ์„ฑ๊ณต์ ์œผ๋กœ ์‚ญ์ œ๋˜์—ˆ์Šต๋‹ˆ๋‹ค. ์‚ญ์ œ๋œ ๊ตฌ์„ฑ์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementConfigDeletionResponse" + }, + "example": { + "configId": "074791cc-ef32-4920-8373-95efbeea66c5", + "corridorId": "CO_US", + "name": "Flow Config Example - Edited", + "steps": { + "ON_RAMP": { + "accountId": "e9dec04a-3c57-4052-a89a-288c545f6430", + "inputAssetId": "COP", + "outputAssetId": "USD" + }, + "VAULT_ACCOUNT": { + "accountId": "2", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + }, + "OFF_RAMP": { + "accountId": "f2f74204-93ec-4614-870a-4ea2ad13aa0b", + "inputAssetId": "XLM_USDC_5F3T", + "outputAssetId": "XLM_USDC_5F3T" + } + }, + "conversionSlippageBasisPoints": 30, + "createdAt": 1680625226267 + } + } + } + }, + "401": { + "description": "์Šน์ธ๋˜์ง€ ์•Š์Œ. Authorization ํ—ค๋”์— JWT ํ† ํฐ์ด ์—†๊ฑฐ๋‚˜ ์ž˜๋ชป๋จ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "์ œ๊ณต๋œ ID๋กœ๋Š” ๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ๊ตฌ์„ฑ์ด ์กด์žฌํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "๋‚ด๋ถ€ ์˜ค๋ฅ˜.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/payments/xb-settlements/flows": { + "post": { + "tags": [ + "Payments - cross-border settlement" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "summary": "์ƒˆ๋กœ์šด ๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ํ๋ฆ„ ์ƒ์„ฑ", + "description": "๊ตญ๊ฒฝ ๊ฐ„ ํ”Œ๋กœ์šฐ(๊ตญ๊ฒฝ ๊ฐ„ ๊ตฌ์„ฑ ๊ธฐ๋ฐ˜)๋ฅผ ์ด์ฒดํ•  ๊ธˆ์•ก์œผ๋กœ ๋งŒ๋“ญ๋‹ˆ๋‹ค. assetId๋Š” ๊ตญ๊ฒฝ ๊ฐ„ ๊ตฌ์„ฑ์— ์˜ํ•ด ์ •์˜๋ฉ๋‹ˆ๋‹ค. ํ”Œ๋กœ์šฐ๋ฅผ ๋งŒ๋“ค๋ฉด ์ œ๊ณต๋œ ๊ธˆ์•ก์— ๋”ฐ๋ผ ํ™˜์œจ, ์‹œ๊ฐ„, ์ˆ˜์ˆ˜๋ฃŒ๋ฅผ ํฌํ•จํ•œ ํ”Œ๋กœ์šฐ ์ถ”์ •์น˜ ๊ณ„์‚ฐ์ด ํŠธ๋ฆฌ๊ฑฐ๋ฉ๋‹ˆ๋‹ค. ๊ตญ๊ฒฝ ๊ฐ„ ํ”Œ๋กœ์šฐ๋ฅผ ๋งŒ๋“ค์–ด๋„ ํ”Œ๋กœ์šฐ๊ฐ€ ์‹คํ–‰๋˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค. **์ฐธ๊ณ :** ์ด ์„น์…˜์˜ ์ฐธ์กฐ ์ฝ˜ํ…์ธ ๋Š” ๊ฒฐ์ œ ์—”์ง„ ์—”๋“œํฌ์ธํŠธ๋ฅผ ์„ค๋ช…ํ•ฉ๋‹ˆ๋‹ค. ๊ฒฐ์ œ ์—”์ง„ ์—”๋“œํฌ์ธํŠธ์—๋Š” ๊ณ„์ •์—์„œ ๊ฒฐ์ œ ์—”์ง„์„ ํ™œ์„ฑํ™”ํ•œ ๊ณ ๊ฐ์—๊ฒŒ๋งŒ ์ œ๊ณต๋˜๋Š” API๊ฐ€ ํฌํ•จ๋ฉ๋‹ˆ๋‹ค. ์ด๋Ÿฌํ•œ ์—”๋“œํฌ์ธํŠธ๋Š” ํ˜„์žฌ ๋ฒ ํƒ€ ์ƒํƒœ์ด๋ฉฐ ๋ณ€๊ฒฝ๋  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. Fireblocks ๊ฒฐ์ œ ์—”์ง„์— ๋Œ€ํ•ด ์ž์„ธํžˆ ์•Œ์•„๋ณด๋ ค๋ฉด Fireblocks ๊ณ ๊ฐ ์„ฑ๊ณต ๊ด€๋ฆฌ์ž์—๊ฒŒ ๋ฌธ์˜ํ•˜๊ฑฐ๋‚˜ CSM@fireblocks.com์œผ๋กœ ์ด๋ฉ”์ผ์„ ๋ณด๋‚ด์ฃผ์„ธ์š”..", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementCreateFlowRequestBody" + }, + "example": { + "configId": "a4b0a706-4578-4467-bd5b-a852761dd2aa", + "amount": "100" + } + } + } + }, + "responses": { + "200": { + "description": "๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ํ๋ฆ„์ด ์„ฑ๊ณต์ ์œผ๋กœ ์ƒ์„ฑ๋˜์—ˆ์Šต๋‹ˆ๋‹ค.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementCreateFlowResponse" + }, + "example": { + "flowId": "98fb5a8b-65ff-4f15-b89c-80910aedbfb3", + "configId": "a4b0a706-4578-4467-bd5b-a852761dd2aa", + "conversionRate": "0.05481268", + "inputAmount": { + "amount": "100", + "assetId": "MXN" + }, + "estimatedOutputAmount": { + "amount": "5.461268", + "assetId": "XLM_USDC_5F3T" + }, + "totalEstimatedFee": { + "amount": "0.063503", + "assetId": "XLM_USDC_5F3T" + }, + "steps": { + "ON_RAMP": { + "accountId": "3d6241ad-879b-4a11-842f-4cee9cd7fbba", + "inputAmount": { + "amount": "100", + "assetId": "MXN" + }, + "outputAmount": { + "amount": "5.48126865", + "assetId": "USD" + }, + "estimatedFeeAmount": { + "amount": "0.043503", + "assetId": "USD" + }, + "estimatedTime": 10, + "isSignRequired": false + }, + "VAULT_ACCOUNT": { + "accountId": "1", + "inputAmount": { + "amount": "5.48126865", + "assetId": "USD" + }, + "outputAmount": { + "amount": "5.471268", + "assetId": "XLM_USDC_5F3T" + }, + "estimatedFeeAmount": { + "amount": "0.01", + "assetId": "XLM_USDC_5F3T" + }, + "estimatedTime": 63, + "isSignRequired": true + }, + "OFF_RAMP": { + "accountId": "1cf7f750-117f-4c36-b4ef-14c420d118ce", + "inputAmount": { + "amount": "5.471268", + "assetId": "XLM_USDC_5F3T" + }, + "outputAmount": { + "amount": "5.461268", + "assetId": "XLM_USDC_5F3T" + }, + "estimatedFeeAmount": { + "amount": "0.01", + "assetId": "XLM_USDC_5F3T" + }, + "estimatedTime": 95, + "isSignRequired": true + } + }, + "totalEstimatedTime": 696 + } + } + } + }, + "400": { + "description": "๊ตญ๊ฒฝ ๊ฐ„ ํ๋ฆ„์„ ์ƒ์„ฑํ•  ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค. ๊ตฌ์„ฑ ID๊ฐ€ ์ž˜๋ชป๋˜์—ˆ์Šต๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "์Šน์ธ๋˜์ง€ ์•Š์Œ. Authorization ํ—ค๋”์— JWT ํ† ํฐ์ด ์—†๊ฑฐ๋‚˜ ์ž˜๋ชป๋จ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "๋‚ด๋ถ€ ์˜ค๋ฅ˜.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/payments/xb-settlements/flows/{flowId}": { + "get": { + "tags": [ + "Payments - cross-border settlement" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "flowId", + "required": true, + "description": "๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ํ๋ฆ„ ID.", + "schema": { + "type": "string" + }, + "example": "98fb5a8b-65ff-4f15-b89c-80910aedbfb3" + } + ], + "summary": "ํŠน์ • ๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ํ๋ฆ„์— ๋Œ€ํ•œ ์„ธ๋ถ€ ์ •๋ณด๋ฅผ ์–ป์œผ์„ธ์š”", + "description": "ํŠน์ • ๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ํ๋ฆ„์— ๋Œ€ํ•œ ์„ธ๋ถ€ ์ •๋ณด๋ฅผ ๊ฐ€์ ธ์˜ต๋‹ˆ๋‹ค. **์ฐธ๊ณ :** ์ด ์„น์…˜์˜ ์ฐธ์กฐ ์ฝ˜ํ…์ธ ๋Š” ๊ฒฐ์ œ ์—”์ง„ ์—”๋“œํฌ์ธํŠธ๋ฅผ ์„ค๋ช…ํ•ฉ๋‹ˆ๋‹ค. ๊ฒฐ์ œ ์—”์ง„ ์—”๋“œํฌ์ธํŠธ์—๋Š” ๊ณ„์ •์—์„œ ๊ฒฐ์ œ ์—”์ง„์„ ํ™œ์„ฑํ™”ํ•œ ๊ณ ๊ฐ์—๊ฒŒ๋งŒ ์ œ๊ณต๋˜๋Š” API๊ฐ€ ํฌํ•จ๋ฉ๋‹ˆ๋‹ค. ์ด๋Ÿฌํ•œ ์—”๋“œํฌ์ธํŠธ๋Š” ํ˜„์žฌ ๋ฒ ํƒ€ ์ƒํƒœ์ด๋ฉฐ ๋ณ€๊ฒฝ๋  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. Fireblocks ๊ฒฐ์ œ ์—”์ง„์— ๋Œ€ํ•ด ์ž์„ธํžˆ ์•Œ์•„๋ณด๋ ค๋ฉด Fireblocks ๊ณ ๊ฐ ์„ฑ๊ณต ๊ด€๋ฆฌ์ž์—๊ฒŒ ๋ฌธ์˜ํ•˜๊ฑฐ๋‚˜ CSM@fireblocks.com์œผ๋กœ ์ด๋ฉ”์ผ์„ ๋ณด๋‚ด์ฃผ์„ธ์š”..", + "responses": { + "200": { + "description": "๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ํ๋ฆ„ ์„ธ๋ถ€ ์ •๋ณด๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค. ์‹คํ–‰๋˜์ง€ ์•Š์€ ํ๋ฆ„์˜ ๊ฒฝ์šฐ, ์˜ˆ์ƒ ์‹œ๊ฐ„, ๊ธˆ์•ก ๋ฐ ์ˆ˜์ˆ˜๋ฃŒ๋ฅผ ๋ณด์—ฌ์ฃผ๋Š” ๋ฏธ๋ฆฌ๋ณด๊ธฐ ๊ฐ์ฒด๊ฐ€ ๋ฐ˜ํ™˜๋ฉ๋‹ˆ๋‹ค. ์ด ๋ฐ์ดํ„ฐ ๊ตฌ์กฐ๋Š” ํ๋ฆ„์ด ์ง„ํ–‰๋จ์— ๋”ฐ๋ผ ์ด ์ˆ˜์ˆ˜๋ฃŒ(๋ˆ„์ ), ์ƒํƒœ ๋ฐ ๋‹จ๊ณ„๋ฅผ ํฌํ•จํ•˜์—ฌ ์—…๋ฐ์ดํŠธ๋ฉ๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementGetFlowResponse" + }, + "examples": { + "not executed": { + "value": { + "preview": { + "flowId": "98fb5a8b-65ff-4f15-b89c-80910aedbfb3", + "configId": "a4b0a706-4578-4467-bd5b-a852761dd2aa", + "conversionRate": "0.055369", + "inputAmount": { + "amount": "32", + "assetId": "MXN" + }, + "estimatedOutputAmount": { + "amount": "1.741824", + "assetId": "XLM_USDC_5F3T" + }, + "totalEstimatedFee": { + "amount": "0.044063", + "assetId": "XLM_USDC_5F3T" + }, + "totalEstimatedTime": 831, + "steps": { + "ON_RAMP": { + "accountId": "3d6241ad-879b-4a11-842f-4cee9cd7fbba", + "inputAmount": { + "amount": "32", + "assetId": "MXN" + }, + "outputAmount": { + "amount": "1.77182407", + "assetId": "USD" + }, + "estimatedFeeAmount": { + "amount": "0.014063", + "assetId": "USD" + }, + "estimatedTime": 10, + "isSignRequired": false + }, + "VAULT_ACCOUNT": { + "accountId": "1", + "inputAmount": { + "amount": "1.77182407", + "assetId": "XLM_USDC_5F3T" + }, + "outputAmount": { + "amount": "1.761824", + "assetId": "XLM_USDC_5F3T" + }, + "estimatedFeeAmount": { + "amount": "0.01", + "assetId": "XLM_USDC_5F3T" + }, + "estimatedTime": 111, + "isSignRequired": true + }, + "OFF_RAMP": { + "accountId": "1cf7f750-117f-4c36-b4ef-14c420d118ce", + "inputAmount": { + "amount": "1.761824", + "assetId": "XLM_USDC_5F3T" + }, + "outputAmount": { + "amount": "1.751824", + "assetId": "XLM_USDC_5F3T" + }, + "estimatedFeeAmount": { + "amount": "0.01", + "assetId": "XLM_USDC_5F3T" + }, + "estimatedTime": 293, + "isSignRequired": true + } + } + } + } + }, + "in progress": { + "value": { + "execution": { + "flowId": "98fb5a8b-65ff-4f15-b89c-80910aedbfb3", + "configId": "a4b0a706-4578-4467-bd5b-a852761dd2aa", + "inputAmount": { + "amount": "32", + "assetId": "MXN" + }, + "outputAmount": { + "amount": "1.471824", + "assetId": "XLM_USDC_5F3T" + }, + "totalFee": { + "amount": "0.004415", + "assetId": "XLM_USDC_5F3T" + }, + "initiatedAt": 1684919822759, + "initiatedBy": "a92e87a0-5231-531e-a624-fb29c1283764", + "state": "PROCESSING", + "selectedConversionSlippage": { + "basisPoints": 10, + "reason": "FLOW" + }, + "steps": { + "ON_RAMP": { + "id": "c1863abf-e7fa-4f3a-908a-bcd6381f7eb4", + "accountId": "3d6241ad-879b-4a11-842f-4cee9cd7fbba", + "status": "COMPLETED", + "inputAmount": { + "amount": "32", + "assetId": "MXN" + }, + "outputAmount": { + "amount": "1.77182407", + "assetId": "USD" + }, + "fee": { + "amount": "0.014063", + "assetId": "USD" + }, + "startedAt": 1684919823052, + "completedAt": 1684919830456, + "isSignRequired": false + }, + "VAULT_ACCOUNT": { + "id": "2aa2634d-2bab-44ac-9b4e-36e2e4db5d49", + "accountId": "1", + "status": "COMPLETED", + "inputAmount": { + "amount": "1.77182407", + "assetId": "XLM_USDC_5F3T" + }, + "outputAmount": { + "amount": "1.761824", + "assetId": "XLM_USDC_5F3T" + }, + "fee": { + "amount": "0.01", + "assetId": "XLM" + }, + "startedAt": 1684919831385, + "completedAt": 1684920680227, + "isSignRequired": true + }, + "OFF_RAMP": { + "id": "b221ed63-a05c-4e78-b2f2-205dcffeabda", + "accountId": "1cf7f750-117f-4c36-b4ef-14c420d118ce", + "status": "PROCESSING", + "inputAmount": { + "amount": "1.761824", + "assetId": "XLM_USDC_5F3T" + }, + "startedAt": 1684920681088, + "isSignRequired": true + } + } + } + } + }, + "completed": { + "value": { + "execution": { + "flowId": "98fb5a8b-65ff-4f15-b89c-80910aedbfb3", + "configId": "a4b0a706-4578-4467-bd5b-a852761dd2aa", + "inputAmount": { + "amount": "32", + "assetId": "MXN" + }, + "outputAmount": { + "amount": "1.471824", + "assetId": "XLM_USDC_5F3T" + }, + "totalFee": { + "amount": "0.004415", + "assetId": "XLM_USDC_5F3T" + }, + "initiatedAt": 1684919822759, + "initiatedBy": "a92e87a0-5231-531e-a624-fb29c1283764", + "state": "COMPLETED", + "selectedConversionSlippage": { + "basisPoints": 10, + "reason": "FLOW" + }, + "steps": { + "ON_RAMP": { + "id": "b1bec144-c4dd-4ff8-80ed-4204c83dd422", + "accountId": "3d6241ad-879b-4a11-842f-4cee9cd7fbba", + "status": "COMPLETED", + "inputAmount": { + "amount": "32", + "assetId": "MXN" + }, + "outputAmount": { + "amount": "1.77182407", + "assetId": "USD" + }, + "fee": { + "amount": "0.014063", + "assetId": "USD" + }, + "startedAt": 1684919823052, + "completedAt": 1684919830456, + "isSignRequired": false + }, + "VAULT_ACCOUNT": { + "id": "df7e0103-04cf-4508-9654-aa5e4b90dd50", + "accountId": "1", + "status": "COMPLETED", + "inputAmount": { + "amount": "1.77182407", + "assetId": "XLM_USDC_5F3T" + }, + "outputAmount": { + "amount": "1.761824", + "assetId": "XLM_USDC_5F3T" + }, + "fee": { + "amount": "0.01", + "assetId": "XLM" + }, + "startedAt": 1684919831385, + "completedAt": 1684920680227, + "isSignRequired": true + }, + "OFF_RAMP": { + "id": "34c2d597-271a-4c11-937a-3c246f5d39c2", + "accountId": "1cf7f750-117f-4c36-b4ef-14c420d118ce", + "status": "COMPLETED", + "inputAmount": { + "amount": "1.761824", + "assetId": "XLM_USDC_5F3T" + }, + "outputAmount": { + "amount": "1.761823", + "assetId": "XLM_USDC_5F3T" + }, + "fee": { + "amount": "0.00001", + "assetId": "XLM" + }, + "startedAt": 1684920681088, + "completedAt": 1684921261453, + "isSignRequired": true + } + } + } + } + } + } + } + } + }, + "401": { + "description": "์Šน์ธ๋˜์ง€ ์•Š์Œ. Authorization ํ—ค๋”์— JWT ํ† ํฐ์ด ์—†๊ฑฐ๋‚˜ ์ž˜๋ชป๋จ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "์ž˜๋ชป๋œ flowId.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "๋‚ด๋ถ€ ์˜ค๋ฅ˜.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/payments/xb-settlements/flows/{flowId}/actions/execute": { + "post": { + "tags": [ + "Payments - cross-border settlement" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "parameters": [ + { + "in": "path", + "name": "flowId", + "required": true, + "description": "๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ํ๋ฆ„ ID.", + "schema": { + "type": "string" + }, + "example": "98fb5a8b-65ff-4f15-b89c-80910aedbfb3" + } + ], + "summary": "๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ํ๋ฆ„ ์‹คํ–‰", + "description": "์‹คํ–‰์„ ์œ„ํ•ด 'flowId'๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ๊ฒฐ์ œ ํ๋ฆ„์„ ๋ณด๋ƒ…๋‹ˆ๋‹ค. ์ด ์‹คํ–‰์— ํ๋ฆ„ ๊ตฌ์„ฑ์—์„œ ๊ตฌ์„ฑ๋œ ๊ฒƒ๊ณผ ๋‹ค๋ฅธ ์Šฌ๋ฆฌํ”ผ์ง€ ๊ตฌ์„ฑ์ด ํ•„์š”ํ•œ ๊ฒฝ์šฐ ์š”์ฒญ ๋ณธ๋ฌธ์€ ์ด ์‹คํ–‰์— ๋Œ€ํ•œ ์›ํ•˜๋Š” ์Šฌ๋ฆฌํ”ผ์ง€ ๊ตฌ์„ฑ์„ ์ •์˜ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. **์ฐธ๊ณ :** ์ด ์„น์…˜์˜ ์ฐธ์กฐ ์ฝ˜ํ…์ธ ๋Š” ๊ฒฐ์ œ ์—”์ง„ ์—”๋“œํฌ์ธํŠธ๋ฅผ ์„ค๋ช…ํ•ฉ๋‹ˆ๋‹ค. ๊ฒฐ์ œ ์—”์ง„ ์—”๋“œํฌ์ธํŠธ์—๋Š” ๊ณ„์ •์—์„œ ๊ฒฐ์ œ ์—”์ง„์„ ํ™œ์„ฑํ™”ํ•œ ๊ณ ๊ฐ์—๊ฒŒ๋งŒ ์ œ๊ณต๋˜๋Š” API๊ฐ€ ํฌํ•จ๋ฉ๋‹ˆ๋‹ค. ์ด๋Ÿฌํ•œ ์—”๋“œํฌ์ธํŠธ๋Š” ํ˜„์žฌ ๋ฒ ํƒ€ ์ƒํƒœ์ด๋ฉฐ ๋ณ€๊ฒฝ๋  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. Fireblocks ๊ฒฐ์ œ ์—”์ง„์— ๋Œ€ํ•ด ์ž์„ธํžˆ ์•Œ์•„๋ณด๋ ค๋ฉด Fireblocks ๊ณ ๊ฐ ์„ฑ๊ณต ๊ด€๋ฆฌ์ž์—๊ฒŒ ๋ฌธ์˜ํ•˜๊ฑฐ๋‚˜ CSM@fireblocks.com์œผ๋กœ ์ด๋ฉ”์ผ์„ ๋ณด๋‚ด์ฃผ์„ธ์š”..", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementFlowExecutionRequestBody" + }, + "example": { + "conversionSlippageBasisPoints": 10 + } + } + } + }, + "responses": { + "200": { + "description": "๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ํ๋ฆ„์ด ์„ฑ๊ณต์ ์œผ๋กœ ์‹คํ–‰๋˜๊ธฐ ์‹œ์ž‘ํ–ˆ์Šต๋‹ˆ๋‹ค.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/XBSettlementFlowExecutionResponse" + }, + "example": { + "flowId": "98fb5a8b-65ff-4f15-b89c-80910aedbfb3", + "configId": "a4b0a706-4578-4467-bd5b-a852761dd2aa", + "inputAmount": { + "amount": "32", + "assetId": "MXN" + }, + "outputAmount": { + "amount": "1.471824", + "assetId": "XLM_USDC_5F3T" + }, + "totalFee": { + "amount": "0.004415", + "assetId": "XLM_USDC_5F3T" + }, + "initiatedAt": 1684919822759, + "initiatedBy": "a92e87a0-5231-531e-a624-fb29c1283764", + "state": "PROCESSING", + "selectedConversionSlippage": { + "basisPoints": 10, + "reason": "FLOW" + }, + "steps": { + "ON_RAMP": { + "id": "c1863abf-e7fa-4f3a-908a-bcd6381f7eb4", + "accountId": "3d6241ad-879b-4a11-842f-4cee9cd7fbba", + "status": "COMPLETED", + "inputAmount": { + "amount": "32", + "assetId": "MXN" + }, + "outputAmount": { + "amount": "1.77182407", + "assetId": "USD" + }, + "fee": { + "amount": "0.014063", + "assetId": "USD" + }, + "startedAt": 1684919823052, + "completedAt": 1684919830456, + "isSignRequired": false + }, + "VAULT_ACCOUNT": { + "id": "2aa2634d-2bab-44ac-9b4e-36e2e4db5d49", + "accountId": "1", + "status": "PROCESSING", + "inputAmount": { + "amount": "1.77182407", + "assetId": "XLM_USDC_5F3T" + }, + "outputAmount": { + "amount": "1.761824", + "assetId": "XLM_USDC_5F3T" + }, + "fee": { + "amount": "0.01", + "assetId": "XLM" + }, + "startedAt": 1684919831385, + "isSignRequired": true + }, + "OFF_RAMP": { + "id": "b221ed63-a05c-4e78-b2f2-205dcffeabda", + "accountId": "1cf7f750-117f-4c36-b4ef-14c420d118ce", + "status": "NOT_STARTED", + "inputAmount": { + "amount": "1.761824", + "assetId": "XLM_USDC_5F3T" + }, + "isSignRequired": true + } + } + } + } + } + }, + "400": { + "description": "๊ตญ๊ฒฝ ๊ฐ„ ํ๋ฆ„์„ ์‹คํ–‰ํ•˜๋ ค๊ณ  ํ•˜๋Š” ๋™์•ˆ ์˜ค๋ฅ˜๊ฐ€ ๋ฐœ์ƒํ–ˆ์Šต๋‹ˆ๋‹ค.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "์Šน์ธ๋˜์ง€ ์•Š์Œ. Authorization ํ—ค๋”์— JWT ํ† ํฐ์ด ์—†๊ฑฐ๋‚˜ ์ž˜๋ชป๋จ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "์ž˜๋ชป๋œ flowId.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "๋‚ด๋ถ€ ์˜ค๋ฅ˜.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/payments/payout": { + "post": { + "tags": [ + "Payments - Payout" + ], + "description": "**์ฐธ๊ณ :** ์ด ์„น์…˜์˜ ์ฐธ์กฐ ์ฝ˜ํ…์ธ ๋Š” ๊ฒฐ์ œ ์—”์ง„ ์—”๋“œํฌ์ธํŠธ๋ฅผ ์„ค๋ช…ํ•ฉ๋‹ˆ๋‹ค. ๊ฒฐ์ œ ์—”์ง„ ์—”๋“œํฌ์ธํŠธ์—๋Š” ๊ณ„์ •์—์„œ ๊ฒฐ์ œ ์—”์ง„์ด ํ™œ์„ฑํ™”๋œ ๊ณ ๊ฐ์—๊ฒŒ๋งŒ ์ œ๊ณต๋˜๋Š” API๊ฐ€ ํฌํ•จ๋ฉ๋‹ˆ๋‹ค.

์ด๋Ÿฌํ•œ ์—”๋“œํฌ์ธํŠธ๋Š” ํ˜„์žฌ ๋ฒ ํƒ€ ์ƒํƒœ์ด๋ฏ€๋กœ ๋ณ€๊ฒฝ๋  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

Fireblocks Payments Engine์— ๋Œ€ํ•ด ์ž์„ธํžˆ ์•Œ์•„๋ณด๋ ค๋ฉด Fireblocks ๊ณ ๊ฐ ์„ฑ๊ณต ๊ด€๋ฆฌ์ž์—๊ฒŒ ๋ฌธ์˜ํ•˜๊ฑฐ๋‚˜ CSM@fireblocks.com์œผ๋กœ ์ด๋ฉ”์ผ์„ ๋ณด๋‚ด์ฃผ์„ธ์š”.

์ง€๊ธ‰ ์ง€์นจ ์„ธํŠธ๋ฅผ ๋งŒ๋“ญ๋‹ˆ๋‹ค.
์ง€๊ธ‰ ์ง€์‹œ ์‚ฌํ•ญ ์„ธํŠธ๋Š” ๋‹จ์ผ ์ง€๊ธ‰ ๊ณ„์ขŒ์—์„œ ์ˆ˜์ทจ์ธ ๊ณ„์ขŒ ๋ชฉ๋ก์œผ๋กœ ์ง€๊ธ‰์„ ๋ถ„๋ฐฐํ•˜๊ธฐ ์œ„ํ•œ ์ง€์‹œ ์‚ฌํ•ญ ์„ธํŠธ์ž…๋‹ˆ๋‹ค.
๋ช…๋ น์–ด ์„ธํŠธ๋Š” ๋‹ค์Œ์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค.
  • ์ง€๋ถˆ ๊ณ„์ขŒ์™€ ๊ณ„์ขŒ ์œ ํ˜•(๊ธˆ๊ณ , ๊ฑฐ๋ž˜์†Œ ๋˜๋Š” ๋ฒ•์ •ํ™”ํ)
  • ๊ณ„์ขŒ ์œ ํ˜•(๊ธˆ๊ณ  ๊ณ„์ขŒ, ๊ฑฐ๋ž˜์†Œ ๊ณ„์ขŒ, ํ—ˆ์šฉ ์ฃผ์†Œ, ๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ, ๋ฒ•์ • ํ†ตํ™” ๊ณ„์ขŒ ๋˜๋Š” ํŒ๋งค์ž ๊ณ„์ขŒ), ๊ธˆ์•ก, ๊ฐ ์ˆ˜์ทจ์ธ ๊ณ„์ขŒ์˜ ์ง€๋ถˆ ์ž์‚ฐ์ž…๋‹ˆ๋‹ค.
", + "security": [ + { + "bearerAuth": [] + } + ], + "summary": "์ง€๊ธ‰ ์ง€์นจ ์„ธํŠธ ์ƒ์„ฑ", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreatePayoutRequest" + }, + "example": { + "paymentAccount": { + "id": "EX_SUB3", + "type": "EXCHANGE_ACCOUNT" + }, + "instructionSet": [ + { + "payeeAccount": { + "id": "bef85a1c-b605-4b2e-bdb5-2d400f4d0bf3", + "type": "EXTERNAL_WALLET" + }, + "amount": { + "amount": "43", + "assetId": "USDC" + } + }, + { + "payeeAccount": { + "id": "3adc1f92-e791-44a8-9aee-7f31c2108b78", + "type": "NETWORK_CONNECTION" + }, + "amount": { + "amount": "4423", + "assetId": "USDC" + } + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "์ง€๊ธ‰ ๋ช…๋ น ์„ธํŠธ ์ƒ์„ฑ์ด ์„ฑ๊ณตํ–ˆ์œผ๋ฉฐ ๊ณ ์œ ํ•œ ์ง€๊ธ‰ ID์™€ ํ•จ๊ป˜ ์ƒ์„ฑ๋œ ๋ช…๋ น ์„ธํŠธ๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค. ์ง€๊ธ‰ ID๋Š” ์ง€๊ธ‰์„ ์‹คํ–‰ํ•˜๊ณ  ์ง€๊ธ‰ ์ƒํƒœ๋ฅผ ํ™•์ธํ•˜๋Š” ๋ฐ ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PayoutResponse" + }, + "example": { + "payoutId": "1fe3b61f-7e1f-4a19-aff0-4f0a524d44d7", + "paymentAccount": { + "id": "EX_SUB3", + "type": "EXCHANGE_ACCOUNT" + }, + "createdAt": 1645365800, + "state": "REQUESTED", + "status": "REGISTERED", + "initMethod": "API", + "instructionSet": [ + { + "id": "6ea4a016-536b-49af-b1a0-40b343ccf879", + "name": "payee-wallet-name", + "payeeAccount": { + "id": "bef85a1c-b605-4b2e-bdb5-2d400f4d0bf3", + "type": "EXTERNAL_WALLET" + }, + "amount": { + "amount": "43", + "assetId": "USDC" + }, + "state": "NOT_STARTED", + "transactions": [] + }, + { + "id": "e783a79b-6acc-4d18-885d-ed533cad8eeb", + "name": "payee-by-network", + "payeeAccount": { + "id": "3adc1f92-e791-44a8-9aee-7f31c2108b78", + "type": "NETWORK_CONNECTION" + }, + "amount": { + "amount": "4423.23", + "assetId": "USDC" + }, + "state": "NOT_STARTED", + "transactions": [] + } + ] + } + } + } + }, + "400": { + "description": "์ž˜๋ชป๋œ ์š”์ฒญ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "์Šน์ธ๋˜์ง€ ์•Š์Œ. Authorization ํ—ค๋”์— JWT ํ† ํฐ์ด ์—†๊ฑฐ๋‚˜ ์ž˜๋ชป๋จ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "๋‚ด๋ถ€ ์˜ค๋ฅ˜.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/payments/payout/{payoutId}/actions/execute": { + "post": { + "tags": [ + "Payments - Payout" + ], + "security": [ + { + "bearerAuth": [] + } + ], + "summary": "์ง€๋ถˆ ๋ช…๋ น ์„ธํŠธ ์‹คํ–‰", + "description": "**์ฐธ๊ณ :** ์ด ์„น์…˜์˜ ์ฐธ์กฐ ์ฝ˜ํ…์ธ ๋Š” ๊ฒฐ์ œ ์—”์ง„ ์—”๋“œํฌ์ธํŠธ๋ฅผ ์„ค๋ช…ํ•ฉ๋‹ˆ๋‹ค. ๊ฒฐ์ œ ์—”์ง„ ์—”๋“œํฌ์ธํŠธ์—๋Š” ๊ณ„์ •์—์„œ ๊ฒฐ์ œ ์—”์ง„์ด ํ™œ์„ฑํ™”๋œ ๊ณ ๊ฐ์—๊ฒŒ๋งŒ ์ œ๊ณต๋˜๋Š” API๊ฐ€ ํฌํ•จ๋ฉ๋‹ˆ๋‹ค.

์ด๋Ÿฌํ•œ ์—”๋“œํฌ์ธํŠธ๋Š” ํ˜„์žฌ ๋ฒ ํƒ€ ์ƒํƒœ์ด๋ฏ€๋กœ ๋ณ€๊ฒฝ๋  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

Fireblocks Payments Engine์— ๋Œ€ํ•ด ์ž์„ธํžˆ ์•Œ์•„๋ณด๋ ค๋ฉด Fireblocks ๊ณ ๊ฐ ์„ฑ๊ณต ๊ด€๋ฆฌ์ž์—๊ฒŒ ๋ฌธ์˜ํ•˜๊ฑฐ๋‚˜ CSM@fireblocks.com์œผ๋กœ ์ด๋ฉ”์ผ์„ ๋ณด๋‚ด์ฃผ์„ธ์š”.

์ง€๋ถˆ ๋ช…๋ น ์„ธํŠธ๋ฅผ ์‹คํ–‰ํ•ฉ๋‹ˆ๋‹ค.

๋ช…๋ น์–ด ์„ธํŠธ๊ฐ€ ๊ฒ€์ฆ๋˜๊ณ  ์‹คํ–‰๋ฉ๋‹ˆ๋‹ค.
์†Œ์Šค ์ž ๊ธˆ
์ด๋ฏธ ํ™œ์„ฑํ™”๋œ ์ง€๊ธ‰์ด ์žˆ๋Š” ์ง€๊ธ‰ ๊ณ„์ •์—์„œ ์ง€๊ธ‰ ์ง€์นจ ์„ธํŠธ๋ฅผ ์‹คํ–‰ํ•˜๋Š” ๊ฒฝ์šฐ, ์ƒˆ๋กœ์šด ์ง€๊ธ‰ ์ง€์นจ ์„ธํŠธ๊ฐ€ ์‹คํ–‰๋˜๊ธฐ ์ „์— ํ™œ์„ฑํ™”๋œ ์ง€๊ธ‰์ด ์™„๋ฃŒ๋˜์–ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.
๋™์ผํ•œ ์ง€๊ธ‰ ๋ช…๋ น ์„ธํŠธ๋ฅผ ๋‘ ๋ฒˆ ์ด์ƒ ์‹คํ–‰ํ•  ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค..", + "parameters": [ + { + "name": "payoutId", + "description": "์ง€๋ถˆ ๋ช…๋ น ์„ธํŠธ ์ƒ์„ฑ์—์„œ ์ˆ˜์‹ ๋œ ์ง€๋ถˆ ID", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "example": "1fe3b61f-7e1f-4a19-aff0-4f0a524d44d7" + } + ], + "responses": { + "200": { + "description": "์ง€๋ถˆ ๋ช…๋ น ์„ธํŠธ๋ฅผ ์‹คํ–‰ํ–ˆ์Šต๋‹ˆ๋‹ค", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DispatchPayoutResponse" + }, + "example": { + "payoutId": "1fe3b61f-7e1f-4a19-aff0-4f0a524d44d7" + } + } + } + }, + "400": { + "description": "์ž˜๋ชป๋œ ์š”์ฒญ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "์Šน์ธ๋˜์ง€ ์•Š์Œ. Authorization ํ—ค๋”์— JWT ํ† ํฐ์ด ์—†๊ฑฐ๋‚˜ ์ž˜๋ชป๋จ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "๋‚ด๋ถ€ ์˜ค๋ฅ˜.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/payments/payout/{payoutId}": { + "get": { + "tags": [ + "Payments - Payout" + ], + "summary": "์ง€๊ธ‰ ์ง€์‹œ ์„ธํŠธ์˜ ์ƒํƒœ๋ฅผ ๊ฐ€์ ธ์˜ต๋‹ˆ๋‹ค", + "description": "**์ฐธ๊ณ :** ์ด ์„น์…˜์˜ ์ฐธ์กฐ ์ฝ˜ํ…์ธ ๋Š” ๊ฒฐ์ œ ์—”์ง„ ์—”๋“œํฌ์ธํŠธ๋ฅผ ์„ค๋ช…ํ•ฉ๋‹ˆ๋‹ค. ๊ฒฐ์ œ ์—”์ง„ ์—”๋“œํฌ์ธํŠธ์—๋Š” ๊ณ„์ •์—์„œ ๊ฒฐ์ œ ์—”์ง„์ด ํ™œ์„ฑํ™”๋œ ๊ณ ๊ฐ์—๊ฒŒ๋งŒ ์ œ๊ณต๋˜๋Š” API๊ฐ€ ํฌํ•จ๋ฉ๋‹ˆ๋‹ค.

์ด๋Ÿฌํ•œ ์—”๋“œํฌ์ธํŠธ๋Š” ํ˜„์žฌ ๋ฒ ํƒ€ ์ƒํƒœ์ด๋ฏ€๋กœ ๋ณ€๊ฒฝ๋  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

Fireblocks Payments Engine์— ๋Œ€ํ•ด ์ž์„ธํžˆ ์•Œ์•„๋ณด๋ ค๋ฉด Fireblocks ๊ณ ๊ฐ ์„ฑ๊ณต ๊ด€๋ฆฌ์ž์—๊ฒŒ ๋ฌธ์˜ํ•˜๊ฑฐ๋‚˜ CSM@fireblocks.com์œผ๋กœ ์ด๋ฉ”์ผ์„ ๋ณด๋‚ด์ฃผ์„ธ์š”.
", + "security": [ + { + "bearerAuth": [] + } + ], + "parameters": [ + { + "name": "payoutId", + "description": "์ง€๋ถˆ ๋ช…๋ น ์„ธํŠธ ์ƒ์„ฑ์—์„œ ์ˆ˜์‹ ๋œ ์ง€๋ถˆ ID", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "example": "1fe3b61f-7e1f-4a19-aff0-4f0a524d44d7" + } + ], + "responses": { + "200": { + "description": "๊ฐ ์ง€๊ธ‰ ๋ช…๋ น์˜ ์ƒํƒœ์™€ ํ”„๋กœ์„ธ์Šค์—์„œ ์ƒ์„ฑ๋œ ๊ฑฐ๋ž˜๋ฅผ ํฌํ•จํ•˜์—ฌ ์ง€๊ธ‰ ๋ช…๋ น ์„ธํŠธ์˜ ํ˜„์žฌ ์ƒํƒœ๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PayoutResponse" + }, + "example": { + "payoutId": "1fe3b61f-7e1f-4a19-aff0-4f0a524d44d7", + "paymentAccount": { + "id": "EX_SUB3", + "type": "EXCHANGE_ACCOUNT" + }, + "createdAt": 1645365800, + "state": "FINALIZED", + "status": "DONE", + "initMethod": "API", + "instructionSet": [ + { + "id": "6ea4a016-536b-49af-b1a0-40b343ccf879", + "name": "payee-wallet-name", + "payeeAccount": { + "id": "bef85a1c-b605-4b2e-bdb5-2d400f4d0bf3", + "type": "EXTERNAL_WALLET" + }, + "amount": { + "amount": "4312", + "assetId": "USDC" + }, + "state": "COMPLETED", + "transactions": [ + { + "id": "35a4b10c-1f83-4f0b-ba2a-da0e73be2d6e", + "state": "COMPLETED", + "timestamp": 1645367429 + } + ] + }, + { + "id": "e783a79b-6acc-4d18-885d-ed533cad8eeb", + "name": "payee-by-network", + "payeeAccount": { + "id": "3adc1f92-e791-44a8-9aee-7f31c2108b78", + "type": "NETWORK_CONNECTION" + }, + "amount": { + "amount": "4423.23", + "assetId": "USDC" + }, + "state": "COMPLETED", + "transactions": [ + { + "id": "4505e7d9-bfc7-41bc-9750-54311fcbbf26", + "state": "COMPLETED", + "timestamp": 1645367449 + } + ] + } + ], + "reportUrl": "https://some-url.com/reports/cc5777c1-75a9-4337-aebd-f1f5a40a9391" + } + } + } + }, + "401": { + "description": "์Šน์ธ๋˜์ง€ ์•Š์Œ. Authorization ํ—ค๋”์— JWT ํ† ํฐ์ด ์—†๊ฑฐ๋‚˜ ์ž˜๋ชป๋จ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "404": { + "description": "์ฃผ์–ด์ง„ ์ง€๊ธ‰ ID๋กœ ์ง€๊ธ‰์ด ์กด์žฌํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค..", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "5XX": { + "description": "๋‚ด๋ถ€ ์˜ค๋ฅ˜.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/gas_station": { + "get": { + "summary": "์ฃผ์œ ์†Œ ์„ค์ • ๊ฐ€์ ธ์˜ค๊ธฐ", + "description": "์ฃผ์œ ์†Œ ์„ค์ • ๋ฐ ETH ์ž”์•ก์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Gas stations" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "gas_station_info = fireblocks.get_gas_station_info()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const gasStationInfo = await fireblocks.gasStationInfo();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "์ฃผ์œ ์†Œ ๋ถ€๋™์‚ฐ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/GasStationPropertiesResponse" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/gas_station/{assetId}": { + "get": { + "summary": "์ž์‚ฐ๋ณ„ ์ฃผ์œ ์†Œ ์„ค์ • ๊ฐ€์ ธ์˜ค๊ธฐ", + "description": "์š”์ฒญ๋œ ์ž์‚ฐ์— ๋Œ€ํ•œ ์ฃผ์œ ์†Œ ์„ค์ • ๋ฐ ์ž”์•ก์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Gas stations" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "gas_station_info = fireblocks.get_gas_station_info(asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const gasStationInfo = await fireblocks.gasStationInfo(assetId);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "required": true, + "name": "assetId", + "description": "์ž์‚ฐ์˜ ID", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "responses": { + "200": { + "description": "์ฃผ์œ ์†Œ ๋ถ€๋™์‚ฐ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/GasStationPropertiesResponse" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/gas_station/configuration": { + "put": { + "summary": "์ฃผ์œ ์†Œ ์„ค์ • ํŽธ์ง‘", + "description": "ETH์— ๋Œ€ํ•œ ์ฃผ์œ ์†Œ ์„ค์ •์„ ๊ตฌ์„ฑํ•ฉ๋‹ˆ๋‹ค.", + "tags": [ + "Gas stations" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "gas_station = fireblocks.set_gas_station_configuration(gas_threshold, gas_cap, max_gas_price, asset_id)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const gasStation = await fireblocks.setGasStationConfiguration(gasThreshold, gasCap, maxGasPrice)", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GasStationConfiguration" + } + } + } + }, + "responses": { + "201": { + "description": "์ข‹์•„์š”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/gas_station/configuration/{assetId}": { + "put": { + "summary": "์ž์‚ฐ์— ๋Œ€ํ•œ ์ฃผ์œ ์†Œ ์„ค์ • ํŽธ์ง‘", + "description": "์š”์ฒญ๋œ ์ž์‚ฐ์— ๋Œ€ํ•œ ์ฃผ์œ ์†Œ ์„ค์ •์„ ๊ตฌ์„ฑํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Gas stations" + ], + "parameters": [ + { + "in": "path", + "required": true, + "name": "assetId", + "description": "์ž์‚ฐ์˜ ID", + "schema": { + "type": "string", + "x-fb-entity": "asset" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GasStationConfiguration" + } + } + } + }, + "responses": { + "201": { + "description": "์ข‹์•„์š”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/users": { + "get": { + "summary": "์‚ฌ์šฉ์ž ๋ชฉ๋ก", + "description": "์ž‘์—… ๊ณต๊ฐ„์˜ ๋ชจ๋“  ์‚ฌ์šฉ์ž๋ฅผ ๋‚˜์—ดํ•ฉ๋‹ˆ๋‹ค. ์ด ์—”๋“œํฌ์ธํŠธ๋Š” ๊ด€๋ฆฌ์ž ๊ถŒํ•œ์ด ์žˆ๋Š” API ํ‚ค์—๋งŒ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค..", + "tags": [ + "Users" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "users = fireblocks.get_users()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const users = await fireblocks.getUsers();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "์‚ฌ์šฉ์ž ๋ชฉ๋ก", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/GetUsersResponse" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/audits": { + "get": { + "summary": "๊ฐ์‚ฌ ๋กœ๊ทธ ๊ฐ€์ ธ์˜ค๊ธฐ", + "tags": [ + "Audit Logs" + ], + "parameters": [ + { + "in": "query", + "name": "timePeriod", + "required": true, + "description": "๊ฐ์‚ฌ ๋กœ๊ทธ๋ฅผ ๊ฐ€์ ธ์˜ค๋Š” ๋งˆ์ง€๋ง‰ ๊ธฐ๊ฐ„", + "schema": { + "oneOf": [ + { + "const": "DAY" + }, + { + "const": "WEEK" + } + ] + } + } + ], + "responses": { + "200": { + "description": "์š”์ฒญ๋œ ๊ธฐ๊ฐ„์˜ ๊ฐ์‚ฌ ๋กœ๊ทธ", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/off_exchange/add": { + "post": { + "summary": "๋‹ด๋ณด๋ฅผ ์ถ”๊ฐ€ํ•˜๋‹ค", + "description": "๋‹ด๋ณด ์ถ”๊ฐ€, ์ž…๊ธˆ ์š”์ฒญ ์ƒ์„ฑ", + "tags": [ + "Off exchanges" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AddCollateralRequestBody" + } + } + } + }, + "responses": { + "200": { + "description": "๊ฑฐ๋ž˜ ๊ฐ์ฒด", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateTransactionResponse" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/off_exchange/remove": { + "post": { + "summary": "๋‹ด๋ณด๋ฅผ ์ œ๊ฑฐํ•˜๋‹ค", + "description": "๋‹ด๋ณด ์ œ๊ฑฐ, ์ธ์ถœ ์š”์ฒญ ์ƒ์„ฑ", + "tags": [ + "Off exchanges" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RemoveCollateralRequestBody" + } + } + } + }, + "responses": { + "200": { + "description": "๊ฑฐ๋ž˜ ๊ฐ์ฒด", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateTransactionResponse" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/off_exchange/settlements/trader": { + "post": { + "summary": "์ƒ์ธ์„ ์œ„ํ•œ ์ •์‚ฐ์„ ์ƒ์„ฑํ•˜๋‹ค", + "description": "์ƒ์ธ์„ ์œ„ํ•œ ์ •์‚ฐ์„ ์ƒ์„ฑํ•˜๋‹ค", + "tags": [ + "Off exchanges" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SettlementRequestBody" + } + } + } + }, + "responses": { + "201": { + "description": "์ •์ฐฉ ๋Œ€์ƒ", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SettlementResponse" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/off_exchange/settlements/transactions": { + "get": { + "summary": "๊ฑฐ๋ž˜์†Œ์—์„œ ๊ฒฐ์ œ ๊ฑฐ๋ž˜๋ฅผ ๋ฐ›๋‹ค", + "description": "๊ฑฐ๋ž˜์†Œ์—์„œ ๊ฒฐ์ œ ๊ฑฐ๋ž˜๋ฅผ ๋ฐ›๋‹ค", + "tags": [ + "Off exchanges" + ], + "parameters": [ + { + "in": "query", + "name": "mainExchangeAccountId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "๊ฒฐ์ œ๊ฑฐ๋ž˜", + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/GetSettlementResponse" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/off_exchange/collateral_accounts/{mainExchangeAccountId}": { + "get": { + "summary": "ํŠน์ • ๋‹ด๋ณด ๊ตํ™˜ ๊ณ„์ขŒ ์ฐพ๊ธฐ", + "description": "mainExchangeAccountId๋กœ ๋‹ด๋ณด ๊ณ„์ •์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "Off exchanges" + ], + "parameters": [ + { + "in": "path", + "name": "mainExchangeAccountId", + "required": true, + "description": "์š”์ฒญ๋œ ๋‹ด๋ณด ๊ณ„์ •์ด ์—ฐ๊ด€๋œ ์ฃผ์š” ๊ฑฐ๋ž˜์†Œ ๊ณ„์ •์˜ ID์ž…๋‹ˆ๋‹ค.", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "responses": { + "200": { + "description": "ExchangeAccount ๊ฐœ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ExchangeAccount" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/webhooks/resend": { + "post": { + "summary": "์‹คํŒจํ•œ ์›นํ›… ์žฌ์ „์†ก", + "description": "์‹คํŒจํ•œ ๋ชจ๋“  ์›นํ›… ์•Œ๋ฆผ์„ ๋‹ค์‹œ ๋ณด๋ƒ…๋‹ˆ๋‹ค..", + "tags": [ + "Webhooks" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = fireblocks.resend_webhooks()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.resendWebhooks();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "์ข‹์•„์š”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ResendWebhooksResponse" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/webhooks/resend/{txId}": { + "post": { + "summary": "ID๋กœ ๊ฑฐ๋ž˜์— ์‹คํŒจํ•œ ์›นํ›…์„ ๋‹ค์‹œ ๋ณด๋ƒ…๋‹ˆ๋‹ค.", + "description": "ID๋ณ„ ๊ฑฐ๋ž˜์— ๋Œ€ํ•œ ์‹คํŒจํ•œ ์›นํ›… ์•Œ๋ฆผ์„ ๋‹ค์‹œ ๋ณด๋ƒ…๋‹ˆ๋‹ค..", + "tags": [ + "Webhooks" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "result = fireblocks.resend_transaction_webhooks_by_id(txId, resend_created, resend_status_updated)", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const result = await fireblocks.resendTransactionWebhooksById(txId, resendCreated, resendStatusUpdated);", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "parameters": [ + { + "in": "path", + "name": "txId", + "required": true, + "description": "์›นํ›…์— ๋Œ€ํ•œ ๊ฑฐ๋ž˜ ID", + "schema": { + "type": "string", + "minimum": 1 + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "resendCreated": { + "type": "boolean" + }, + "resendStatusUpdated": { + "type": "boolean" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "์ข‹์•„์š”", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/nfts/ownership/tokens": { + "put": { + "operationId": "refreshNFTOwnershipByVault", + "summary": "๋ณผํŠธ ๊ณ„์ • ํ† ํฐ ์ƒˆ๋กœ ๊ณ ์นจ", + "description": "๋ธ”๋ก์ฒด์ธ ๋ฐ ๋ณผํŠธ ๊ณ„์ •๋‹น ๋ชจ๋“  ํ† ํฐ๊ณผ ์ž”์•ก์„ ์—…๋ฐ์ดํŠธํ•ฉ๋‹ˆ๋‹ค. **์ฐธ๊ณ **: ์ด ์—”๋“œํฌ์ธํŠธ๋Š” ํ˜„์žฌ ๋ฒ ํƒ€ ์ƒํƒœ์ด๋ฉฐ, ํ˜„์žฌ๋Š” ์ผ๋ฐ˜ ์ด์šฉ์ด ๋ถˆ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค. ๋ฒ ํƒ€์— ๋“ฑ๋กํ•˜๊ณ  ์ด ์—”๋“œํฌ์ธํŠธ๋ฅผ ํ™œ์„ฑํ™”ํ•˜๋ ค๋ฉด Fireblocks ๊ณ ๊ฐ ์„ฑ๊ณต ๊ด€๋ฆฌ์ž์—๊ฒŒ ๋ฌธ์˜ํ•˜๊ฑฐ๋‚˜ [CSM@fireblocks.com](mailto:CSM@fireblocks.com)์œผ๋กœ ์—ฐ๋ฝํ•˜์„ธ์š”..", + "parameters": [ + { + "name": "blockchainDescriptor", + "required": true, + "in": "query", + "description": "๋ธ”๋ก์ฒด์ธ ์„ค๋ช…์ž ํ•„ํ„ฐ", + "schema": { + "oneOf": [ + { + "const": "ETH" + }, + { + "const": "ETH_TEST3" + }, + { + "const": "POLYGON" + }, + { + "const": "POLYGON_TEST_MUMBAI" + } + ] + } + }, + { + "name": "vaultAccountId", + "required": true, + "in": "query", + "description": "๋ณผํŠธ ๊ณ„์ • ํ•„ํ„ฐ", + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + } + }, + "tags": [ + "NFTs (Beta)" + ] + }, + "get": { + "operationId": "getOwnedNFTs", + "summary": "์†Œ์œ ํ•œ ๋ชจ๋“  ํ† ํฐ ๋‚˜์—ด(ํŽ˜์ด์ง€๋ณ„)", + "description": "์ž‘์—… ๊ณต๊ฐ„์— ์žˆ๋Š” ๋ชจ๋“  ํ† ํฐ๊ณผ ํ•ด๋‹น ๋ฐ์ดํ„ฐ๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค. **์ฐธ๊ณ **: ์ด ์—”๋“œํฌ์ธํŠธ๋Š” ํ˜„์žฌ ๋ฒ ํƒ€ ์ƒํƒœ์ด๋ฉฐ, ํ˜„์žฌ๋Š” ์ผ๋ฐ˜ ์ด์šฉ์ด ๋ถˆ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค. ๋ฒ ํƒ€์— ๋“ฑ๋กํ•˜๊ณ  ์ด ์—”๋“œํฌ์ธํŠธ๋ฅผ ํ™œ์„ฑํ™”ํ•˜๋ ค๋ฉด Fireblocks ๊ณ ๊ฐ ์„ฑ๊ณต ๊ด€๋ฆฌ์ž์—๊ฒŒ ๋ฌธ์˜ํ•˜๊ฑฐ๋‚˜ [CSM@fireblocks.com](mailto:CSM@fireblocks.com)์œผ๋กœ ์—ฐ๋ฝํ•˜์„ธ์š”..", + "parameters": [ + { + "name": "blockchainDescriptor", + "required": false, + "in": "query", + "description": "๋ธ”๋ก์ฒด์ธ ์„ค๋ช…์ž ํ•„ํ„ฐ", + "schema": { + "oneOf": [ + { + "const": "ETH" + }, + { + "const": "ETH_TEST3" + }, + { + "const": "POLYGON" + }, + { + "const": "POLYGON_TEST_MUMBAI" + } + ] + } + }, + { + "name": "vaultAccountIds", + "required": false, + "in": "query", + "description": "Vault ๊ณ„์ • ID์˜ ์‰ผํ‘œ๋กœ ๊ตฌ๋ถ„๋œ ๋ชฉ๋ก์ž…๋‹ˆ๋‹ค. ๋‹จ์ผ ์š”์ฒญ์—์„œ ์ตœ๋Œ€ 100๊ฐœ๊ฐ€ ํ—ˆ์šฉ๋ฉ๋‹ˆ๋‹ค.", + "schema": { + "type": "string" + } + }, + { + "name": "ids", + "required": false, + "in": "query", + "description": "NFT ID์˜ ์‰ผํ‘œ๋กœ ๊ตฌ๋ถ„๋œ ๋ชฉ๋ก์ž…๋‹ˆ๋‹ค. ๋‹จ์ผ ์š”์ฒญ์—์„œ ์ตœ๋Œ€ 100๊ฐœ๊ฐ€ ํ—ˆ์šฉ๋ฉ๋‹ˆ๋‹ค..", + "schema": { + "type": "string" + } + }, + { + "name": "collectionIds", + "required": false, + "in": "query", + "description": "์ปฌ๋ ‰์…˜ ID์˜ ์‰ผํ‘œ๋กœ ๊ตฌ๋ถ„๋œ ๋ชฉ๋ก์ž…๋‹ˆ๋‹ค. ๋‹จ์ผ ์š”์ฒญ์—์„œ ์ตœ๋Œ€ 100๊ฐœ๊ฐ€ ํ—ˆ์šฉ๋ฉ๋‹ˆ๋‹ค..", + "schema": { + "type": "string" + } + }, + { + "name": "pageCursor", + "required": false, + "in": "query", + "description": "๊ฐ€์ ธ์˜ฌ ํŽ˜์ด์ง€ ์ปค์„œ", + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "required": false, + "in": "query", + "description": "ํŽ˜์ด์ง€๋‹น ํ•ญ๋ชฉ(์ตœ๋Œ€ 100๊ฐœ)", + "schema": { + "minimum": 1, + "maximum": 100, + "type": "number" + } + }, + { + "name": "sort", + "required": false, + "in": "query", + "description": "๋งค๊ฐœ๋ณ€์ˆ˜๋กœ ์ •๋ ฌํ•ฉ๋‹ˆ๋‹ค. ๋งค๊ฐœ๋ณ€์ˆ˜ ํ•˜๋‚˜์ผ ์ˆ˜๋„ ์žˆ๊ณ  ์‰ผํ‘œ๋กœ ๊ตฌ๋ถ„๋œ ๋งค๊ฐœ๋ณ€์ˆ˜ ๋ชฉ๋ก์ผ ์ˆ˜๋„ ์žˆ์Šต๋‹ˆ๋‹ค.", + "schema": { + "type": "array", + "items": { + "oneOf": [ + { + "const": "ownershipLastUpdateTime" + }, + { + "const": "name" + }, + { + "const": "collection.name" + }, + { + "const": "blockchainDescriptor" + } + ] + } + } + }, + { + "name": "order", + "required": false, + "in": "query", + "description": "์ฃผ๋ฌธ ๋ฐฉํ–ฅ์€ ์˜ค๋ฆ„์ฐจ์ˆœ์˜ ๊ฒฝ์šฐ `ASC`, ๋‚ด๋ฆผ์ฐจ์ˆœ์˜ ๊ฒฝ์šฐ `DESC`์ž…๋‹ˆ๋‹ค.", + "schema": { + "oneOf": [ + { + "const": "DESC" + }, + { + "const": "ASC" + } + ] + } + }, + { + "name": "status", + "required": false, + "in": "query", + "description": "ํ† ํฐ ์†Œ์œ ๊ถŒ ์ƒํƒœ", + "schema": { + "oneOf": [ + { + "const": "LISTED" + }, + { + "const": "ARCHIVED" + } + ] + } + }, + { + "name": "search", + "required": false, + "in": "query", + "description": "์†Œ์œ ํ•œ ํ† ํฐ๊ณผ ๊ทธ ์ปฌ๋ ‰์…˜์„ ๊ฒ€์ƒ‰ํ•ฉ๋‹ˆ๋‹ค. ๊ฒ€์ƒ‰ ๊ฐ€๋Šฅํ•œ ๊ธฐ์ค€: ๊ณ„์•ฝ/์ปฌ๋ ‰์…˜ ๋‚ด์˜ ํ† ํฐ ์ด๋ฆ„๊ณผ ID, ์ปฌ๋ ‰์…˜ ์ด๋ฆ„, ๋ธ”๋ก์ฒด์ธ ์„ค๋ช…์ž ๋ฐ ์ด๋ฆ„.", + "schema": { + "maximum": 100, + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "properties": { + "paging": { + "$ref": "#/components/schemas/Paging" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TokenOwnershipResponse" + } + } + } + } + } + } + } + }, + "tags": [ + "NFTs (Beta)" + ] + } + }, + "/nfts/ownership/collections": { + "get": { + "operationId": "listOwnedCollections", + "summary": "์†Œ์œ ํ•œ ์ปฌ๋ ‰์…˜ ๋ชฉ๋ก(ํŽ˜์ด์ง€๋ณ„)", + "description": "์ž‘์—… ๊ณต๊ฐ„์˜ ๋ชจ๋“  ์ปฌ๋ ‰์…˜์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค. **์ฐธ๊ณ **: ์ด ์—”๋“œํฌ์ธํŠธ๋Š” ํ˜„์žฌ ๋ฒ ํƒ€ ๋ฒ„์ „์ด๋ฉฐ, ํ˜„์žฌ๋Š” ์ผ๋ฐ˜์— ๊ณต๊ฐœ๋˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค. ๋ฒ ํƒ€์— ๋“ฑ๋กํ•˜๊ณ  ์ด ์—”๋“œํฌ์ธํŠธ๋ฅผ ํ™œ์„ฑํ™”ํ•˜๋ ค๋ฉด Fireblocks ๊ณ ๊ฐ ์„ฑ๊ณต ๊ด€๋ฆฌ์ž์—๊ฒŒ ๋ฌธ์˜ํ•˜๊ฑฐ๋‚˜ [CSM@fireblocks.com](mailto:CSM@fireblocks.com)์œผ๋กœ ์—ฐ๋ฝํ•˜์„ธ์š”..", + "parameters": [ + { + "name": "search", + "required": false, + "in": "query", + "description": "์†Œ์œ ํ•œ ์ปฌ๋ ‰์…˜์„ ๊ฒ€์ƒ‰ํ•ฉ๋‹ˆ๋‹ค. ๊ฒ€์ƒ‰ ๊ฐ€๋Šฅํ•œ ๊ธฐ์ค€: ์ปฌ๋ ‰์…˜ ์ด๋ฆ„, ์ปฌ๋ ‰์…˜ ๊ณ„์•ฝ ์ฃผ์†Œ.", + "schema": { + "maximum": 100, + "type": "string" + } + }, + { + "name": "pageCursor", + "required": false, + "in": "query", + "description": "๊ฐ€์ ธ์˜ฌ ํŽ˜์ด์ง€ ์ปค์„œ", + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "required": false, + "in": "query", + "description": "ํŽ˜์ด์ง€๋‹น ํ•ญ๋ชฉ(์ตœ๋Œ€ 100๊ฐœ)", + "schema": { + "minimum": 1, + "maximum": 100, + "type": "number" + } + }, + { + "name": "sort", + "required": false, + "in": "query", + "description": "๋งค๊ฐœ๋ณ€์ˆ˜๋กœ ์ •๋ ฌํ•ฉ๋‹ˆ๋‹ค. ๋งค๊ฐœ๋ณ€์ˆ˜ ํ•˜๋‚˜์ผ ์ˆ˜๋„ ์žˆ๊ณ  ์‰ผํ‘œ๋กœ ๊ตฌ๋ถ„๋œ ๋งค๊ฐœ๋ณ€์ˆ˜ ๋ชฉ๋ก์ผ ์ˆ˜๋„ ์žˆ์Šต๋‹ˆ๋‹ค.", + "schema": { + "type": "array", + "items": { + "const": "name" + } + } + }, + { + "name": "order", + "required": false, + "in": "query", + "description": "์ฃผ๋ฌธ ๋ฐฉํ–ฅ์€ ์˜ค๋ฆ„์ฐจ์ˆœ์˜ ๊ฒฝ์šฐ `ASC`, ๋‚ด๋ฆผ์ฐจ์ˆœ์˜ ๊ฒฝ์šฐ `DESC`์ž…๋‹ˆ๋‹ค.", + "schema": { + "oneOf": [ + { + "const": "DESC" + }, + { + "const": "ASC" + } + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "properties": { + "paging": { + "$ref": "#/components/schemas/Paging" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CollectionOwnershipResponse" + } + } + } + } + } + } + } + }, + "tags": [ + "NFTs (Beta)" + ] + } + }, + "/nfts/tokens/{id}": { + "put": { + "operationId": "refreshNFTMetadata", + "summary": "ํ† ํฐ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ ์ƒˆ๋กœ ๊ณ ์นจ", + "description": "์ตœ์‹  ํ† ํฐ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์—…๋ฐ์ดํŠธํ•ฉ๋‹ˆ๋‹ค. **์ฐธ๊ณ **: ์ด ์—”๋“œํฌ์ธํŠธ๋Š” ํ˜„์žฌ ๋ฒ ํƒ€ ์ƒํƒœ์ด๋ฉฐ, ํ˜„์žฌ ์ผ๋ฐ˜ ๊ฐ€์šฉ์„ฑ์„ ์œ„ํ•ด ๋น„ํ™œ์„ฑํ™”๋˜์–ด ์žˆ์Šต๋‹ˆ๋‹ค. ๋ฒ ํƒ€์— ๋“ฑ๋กํ•˜๊ณ  ์ด ์—”๋“œํฌ์ธํŠธ๋ฅผ ํ™œ์„ฑํ™”ํ•˜๋ ค๋ฉด Fireblocks ๊ณ ๊ฐ ์„ฑ๊ณต ๊ด€๋ฆฌ์ž์—๊ฒŒ ๋ฌธ์˜ํ•˜๊ฑฐ๋‚˜ [CSM@fireblocks.com](mailto:CSM@fireblocks.com)์œผ๋กœ ์—ฐ๋ฝํ•˜์„ธ์š”..", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "description": "NFT ID", + "example": "NFT-abcdefabcdefabcdefabcdefabcdefabcdefabcd", + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + } + }, + "tags": [ + "NFTs (Beta)" + ] + }, + "get": { + "operationId": "getNFT", + "summary": "ID๋กœ ํ† ํฐ ๋ฐ์ดํ„ฐ ๋‚˜์—ด", + "description": "์š”์ฒญ๋œ ํ† ํฐ ๋ฐ์ดํ„ฐ๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค. **์ฐธ๊ณ **: ์ด ์—”๋“œํฌ์ธํŠธ๋Š” ํ˜„์žฌ ๋ฒ ํƒ€ ์ƒํƒœ์ด๋ฉฐ, ํ˜„์žฌ ์ผ๋ฐ˜ ๊ฐ€์šฉ์„ฑ์„ ์œ„ํ•ด ๋น„ํ™œ์„ฑํ™”๋˜์–ด ์žˆ์Šต๋‹ˆ๋‹ค. ๋ฒ ํƒ€์— ๋“ฑ๋กํ•˜๊ณ  ์ด ์—”๋“œํฌ์ธํŠธ๋ฅผ ํ™œ์„ฑํ™”ํ•˜๋ ค๋ฉด Fireblocks ๊ณ ๊ฐ ์„ฑ๊ณต ๊ด€๋ฆฌ์ž์—๊ฒŒ ๋ฌธ์˜ํ•˜๊ฑฐ๋‚˜ [CSM@fireblocks.com](mailto:CSM@fireblocks.com)์œผ๋กœ ์—ฐ๋ฝํ•˜์„ธ์š”..", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "description": "NFT ID", + "example": "NFT-abcdefabcdefabcdefabcdefabcdefabcdefabcd", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TokenResponse" + } + } + } + } + }, + "tags": [ + "NFTs (Beta)" + ] + } + }, + "/nfts/tokens": { + "get": { + "operationId": "getNFTs", + "summary": "ID๋กœ ํ† ํฐ ๋‚˜์—ด", + "description": "์š”์ฒญ๋œ ํ† ํฐ ๋ฐ์ดํ„ฐ๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค. **์ฐธ๊ณ **: ์ด ์—”๋“œํฌ์ธํŠธ๋Š” ํ˜„์žฌ ๋ฒ ํƒ€ ๋ฒ„์ „์ด๋ฉฐ, ํ˜„์žฌ๋Š” ์ผ๋ฐ˜ ์ด์šฉ์ด ๋ถˆ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค. ๋ฒ ํƒ€์— ๋“ฑ๋กํ•˜๊ณ  ์ด ์—”๋“œํฌ์ธํŠธ๋ฅผ ํ™œ์„ฑํ™”ํ•˜๋ ค๋ฉด Fireblocks ๊ณ ๊ฐ ์„ฑ๊ณต ๊ด€๋ฆฌ์ž์—๊ฒŒ ๋ฌธ์˜ํ•˜๊ฑฐ๋‚˜ [CSM@fireblocks.com](mailto:CSM@fireblocks.com)์œผ๋กœ ์—ฐ๋ฝํ•˜์„ธ์š”..", + "parameters": [ + { + "name": "ids", + "required": true, + "in": "query", + "description": "NFT ID์˜ ์‰ผํ‘œ๋กœ ๊ตฌ๋ถ„๋œ ๋ชฉ๋ก์ž…๋‹ˆ๋‹ค. ๋‹จ์ผ ์š”์ฒญ์—์„œ ์ตœ๋Œ€ 100๊ฐœ๊ฐ€ ํ—ˆ์šฉ๋ฉ๋‹ˆ๋‹ค..", + "schema": { + "type": "string" + } + }, + { + "name": "pageCursor", + "required": false, + "in": "query", + "description": "๊ฐ€์ ธ์˜ฌ ํŽ˜์ด์ง€ ์ปค์„œ", + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "required": false, + "in": "query", + "description": "ํŽ˜์ด์ง€๋‹น ํ•ญ๋ชฉ(์ตœ๋Œ€ 100๊ฐœ)", + "schema": { + "minimum": 1, + "maximum": 100, + "type": "number" + } + }, + { + "name": "sort", + "required": false, + "in": "query", + "description": "๋งค๊ฐœ๋ณ€์ˆ˜๋กœ ์ •๋ ฌํ•ฉ๋‹ˆ๋‹ค. ๋งค๊ฐœ๋ณ€์ˆ˜ ํ•˜๋‚˜์ผ ์ˆ˜๋„ ์žˆ๊ณ  ์‰ผํ‘œ๋กœ ๊ตฌ๋ถ„๋œ ๋งค๊ฐœ๋ณ€์ˆ˜ ๋ชฉ๋ก์ผ ์ˆ˜๋„ ์žˆ์Šต๋‹ˆ๋‹ค.", + "schema": { + "type": "array", + "items": { + "oneOf": [ + { + "const": "collection.name" + }, + { + "const": "name" + }, + { + "const": "blockchainDescriptor" + } + ] + } + } + }, + { + "name": "order", + "required": false, + "in": "query", + "description": "์ฃผ๋ฌธ ๋ฐฉํ–ฅ์€ ์˜ค๋ฆ„์ฐจ์ˆœ์˜ ๊ฒฝ์šฐ `ASC`, ๋‚ด๋ฆผ์ฐจ์ˆœ์˜ ๊ฒฝ์šฐ `DESC`์ž…๋‹ˆ๋‹ค.", + "schema": { + "oneOf": [ + { + "const": "DESC" + }, + { + "const": "ASC" + } + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "properties": { + "paging": { + "$ref": "#/components/schemas/Paging" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TokenResponse" + } + } + } + } + } + } + } + }, + "tags": [ + "NFTs (Beta)" + ] + } + }, + "/nfts/ownership/tokens/{id}/status": { + "put": { + "operationId": "updateTokenOwnershipStatus", + "summary": "ํ† ํฐ ์†Œ์œ ๊ถŒ ์ƒํƒœ ์—…๋ฐ์ดํŠธ", + "description": "๋ชจ๋“  ํ…Œ๋„ŒํŠธ ๋ณผํŠธ์—์„œ ํ…Œ๋„ŒํŠธ์˜ ํ† ํฐ ์†Œ์œ ๊ถŒ ์ƒํƒœ๋ฅผ ์—…๋ฐ์ดํŠธํ•ฉ๋‹ˆ๋‹ค. **์ฐธ๊ณ **: ์ด ์—”๋“œํฌ์ธํŠธ๋Š” ํ˜„์žฌ ๋ฒ ํƒ€ ์ƒํƒœ์ด๋ฉฐ, ํ˜„์žฌ ์ผ๋ฐ˜ ๊ฐ€์šฉ์„ฑ์„ ์œ„ํ•ด ๋น„ํ™œ์„ฑํ™”๋˜์–ด ์žˆ์Šต๋‹ˆ๋‹ค. ๋ฒ ํƒ€์— ๋“ฑ๋กํ•˜๊ณ  ์ด ์—”๋“œํฌ์ธํŠธ๋ฅผ ํ™œ์„ฑํ™”ํ•˜๋ ค๋ฉด Fireblocks ๊ณ ๊ฐ ์„ฑ๊ณต ๊ด€๋ฆฌ์ž์—๊ฒŒ ๋ฌธ์˜ํ•˜๊ฑฐ๋‚˜ [CSM@fireblocks.com](mailto:CSM@fireblocks.com)์œผ๋กœ ์—ฐ๋ฝํ•˜์„ธ์š”..", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "description": "NFT ID", + "example": "NFT-abcdefabcdefabcdefabcdefabcdefabcdefabcd", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateTokenOwnershipStatusDto" + } + } + } + }, + "responses": { + "200": { + "description": "", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + } + }, + "tags": [ + "NFTs (Beta)" + ] + } + }, + "/connections": { + "get": { + "operationId": "get", + "summary": "์—ด๋ ค ์žˆ๋Š” ๋ชจ๋“  Web3 ์—ฐ๊ฒฐ ๋‚˜์—ด.", + "description": "์˜คํ”ˆ Web3 ์—ฐ๊ฒฐ ์–ป๊ธฐ.", + "parameters": [ + { + "name": "order", + "required": false, + "in": "query", + "description": "๋ชฉ๋ก ์ˆœ์„œ; ์˜ค๋ฆ„์ฐจ์ˆœ ๋˜๋Š” ๋‚ด๋ฆผ์ฐจ์ˆœ.", + "schema": { + "oneOf": [ + { + "const": "ASC" + }, + { + "const": "DESC" + } + ] + } + }, + { + "name": "filter", + "required": false, + "in": "query", + "description": "ํŒŒ์‹ฑ๋œ ํ•„ํ„ฐ ๊ฐ์ฒด", + "examples": { + "object": { + "summary": "ํ•„ํ„ฐ ๊ฐ์ฒด", + "description": "", + "value": { + "id": "string", + "userId": "string", + "vaultAccountId": "number", + "connectionMethod": "string", + "feeLevel": "string", + "appUrl": "string", + "appName": "string" + } + }, + "stringified": { + "summary": "๋ฌธ์ž์—ดํ™”๋œ ๊ตฌ๋ฌธ ๋ถ„์„๋œ ๊ฐ์ฒด", + "description": "๋ฌธ์ž์—ดํ™”๋œ ๊ตฌ๋ฌธ ๋ถ„์„๋œ ๊ฐ์ฒด์— ๊ด€ํ•˜์—ฌ: * ๊ฐ ํ‚ค-๊ฐ’ ์Œ์€ '='๋กœ ๊ตฌ๋ถ„๋˜๊ณ , ๊ฐ ์Œ์€ ','๋กœ ๊ตฌ๋ถ„๋ฉ๋‹ˆ๋‹ค. (์ด๋ฅผ ์œ„ํ•ด [`qs`](https://www.npmjs.com/package/qs) ํŒจํ‚ค์ง€๋ฅผ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.)", + "value": "id=string,userId=string,vaultAccountId=number,connectionMethod=string,feeLevel=string,appUrl=string,appName=string" + } + }, + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "userId": { + "type": "string" + }, + "vaultAccountId": { + "type": "number" + }, + "connectionMethod": { + "type": "string" + }, + "feeLevel": { + "type": "string" + }, + "appUrl": { + "type": "string" + }, + "appName": { + "type": "string" + } + } + } + }, + { + "name": "sort", + "required": false, + "in": "query", + "description": "Web3 ์—ฐ๊ฒฐ์„ ์ •๋ ฌํ•˜๋Š” ์†์„ฑ.", + "schema": { + "oneOf": [ + { + "const": "id" + }, + { + "const": "userId" + }, + { + "const": "vaultAccountId" + }, + { + "const": "createdAt" + }, + { + "const": "feeLevel" + }, + { + "const": "appUrl" + }, + { + "const": "appName" + } + ] + } + }, + { + "name": "pageSize", + "required": false, + "in": "query", + "description": "๋‹ค์Œ ํŽ˜์ด์ง€์—์„œ ๋ฐ˜ํ™˜ํ•  ๊ฒฐ๊ณผ์˜ ์–‘.", + "schema": { + "type": "number", + "default": 10, + "maximum": 50 + } + }, + { + "name": "next", + "required": false, + "in": "query", + "description": "๋‹ค์Œ ํŽ˜์ด์ง€๋กœ ์ปค์„œ ์ด๋™", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetConnectionsResponse" + } + } + } + }, + "400": { + "description": "์ฟผ๋ฆฌ ๋งค๊ฐœ๋ณ€์ˆ˜๊ฐ€ ์ž˜๋ชป๋˜์—ˆ์Šต๋‹ˆ๋‹ค.", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + }, + "500": { + "description": "๋ฌธ์ œ๊ฐ€ ๋ฐœ์ƒํ–ˆ์Šต๋‹ˆ๋‹ค", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + } + }, + "tags": [ + "Web3 connections" + ] + } + }, + "/connections/wc": { + "post": { + "operationId": "create", + "summary": "์ƒˆ๋กœ์šด Web3 ์—ฐ๊ฒฐ์„ ๋งŒ๋“ญ๋‹ˆ๋‹ค.", + "description": "์ƒˆ๋กœ์šด Web3 ์—ฐ๊ฒฐ์„ ์‹œ์ž‘ํ•ฉ๋‹ˆ๋‹ค. * ์ฐธ๊ณ : ์ด๊ฒƒ์ด ์„ฑ๊ณตํ•œ ํ›„ `PUT /v1/connections/wc/{id}`(์•„๋ž˜)์— ๋Œ€ํ•œ ์š”์ฒญ์„ ํ•˜์—ฌ ์ƒˆ๋กœ์šด Web3 ์—ฐ๊ฒฐ์„ ์Šน์ธํ•˜๊ฑฐ๋‚˜ ๊ฑฐ๋ถ€ํ•ฉ๋‹ˆ๋‹ค..", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateConnectionRequest" + } + } + } + }, + "responses": { + "201": { + "description": "Web3 ์—ฐ๊ฒฐ์ด ์„ฑ๊ณต์ ์œผ๋กœ ์‹œ์ž‘๋˜์—ˆ์Šต๋‹ˆ๋‹ค.", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateConnectionResponse" + } + } + } + }, + "400": { + "description": "์ž˜๋ชป๋œ ๋ฐ์ดํ„ฐ๊ฐ€ ์ „์†ก๋˜์—ˆ์Šต๋‹ˆ๋‹ค.", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + }, + "500": { + "description": "๋ฌธ์ œ๊ฐ€ ๋ฐœ์ƒํ–ˆ์Šต๋‹ˆ๋‹ค", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + } + }, + "tags": [ + "Web3 connections" + ] + } + }, + "/connections/wc/{id}": { + "put": { + "operationId": "submit", + "summary": "๋ณด๋ฅ˜ ์ค‘์ธ Web3 ์—ฐ๊ฒฐ ์š”์ฒญ์— ์‘๋‹ต.", + "description": "์‹œ์ž‘๋œ Web3 ์—ฐ๊ฒฐ์„ *์Šน์ธ* ๋˜๋Š” *๊ฑฐ๋ถ€*ํ•˜๊ธฐ ์œ„ํ•œ ์‘๋‹ต์„ ์ œ์ถœํ•ฉ๋‹ˆ๋‹ค. * ์ฐธ๊ณ : ์ด ํ˜ธ์ถœ์€ `POST /v1/connections/wc/` ์š”์ฒญ์„ ์™„๋ฃŒํ•˜๋Š” ๋ฐ ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ์ด๊ฒƒ์ด ์„ฑ๊ณตํ•˜๋ฉด ์ƒˆ Web3 ์—ฐ๊ฒฐ์ด ์ƒ์„ฑ๋˜๊ณ  ์ž‘๋™ํ•ฉ๋‹ˆ๋‹ค..", + "parameters": [ + { + "name": "id", + "description": "์Šน์ธ์„ ์œ„ํ•œ ์‹œ์ž‘๋œ Web3 ์—ฐ๊ฒฐ์˜ ID.", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RespondToConnectionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "์—ฐ๊ฒฐ์ด ์„ฑ๊ณต์ ์œผ๋กœ ์ „์†ก๋˜์—ˆ์Šต๋‹ˆ๋‹ค", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + }, + "400": { + "description": "์ž˜๋ชป๋œ ๋ฐ์ดํ„ฐ๊ฐ€ ์ „์†ก๋˜์—ˆ์Šต๋‹ˆ๋‹ค.", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + }, + "404": { + "description": "์—ฐ๊ฒฐ์„ ์ฐพ์„ ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + }, + "500": { + "description": "๋ฌธ์ œ๊ฐ€ ๋ฐœ์ƒํ–ˆ์Šต๋‹ˆ๋‹ค", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + } + }, + "tags": [ + "Web3 connections" + ] + }, + "delete": { + "operationId": "remove", + "summary": "๊ธฐ์กด Web3 ์—ฐ๊ฒฐ ์ œ๊ฑฐ.", + "description": "Web3 ์—ฐ๊ฒฐ ์ œ๊ฑฐ", + "parameters": [ + { + "name": "id", + "description": "์ œ๊ฑฐํ•  ๊ธฐ์กด Web3 ์—ฐ๊ฒฐ์˜ ID.", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "์—ฐ๊ฒฐ์ด ์„ฑ๊ณต์ ์œผ๋กœ ์ œ๊ฑฐ๋˜์—ˆ์Šต๋‹ˆ๋‹ค.", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + }, + "404": { + "description": "์—ฐ๊ฒฐ์„ ์ฐพ์„ ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + }, + "500": { + "description": "๋ฌธ์ œ๊ฐ€ ๋ฐœ์ƒํ–ˆ์Šต๋‹ˆ๋‹ค", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + } + } + }, + "tags": [ + "Web3 connections" + ] + } + }, + "/screening/travel_rule/transaction/validate": { + "post": { + "operationId": "TravelRuleApiController_validate", + "summary": "์—ฌํ–‰ ๊ทœ์น™ ๊ฑฐ๋ž˜ ๊ฒ€์ฆ", + "description": "์—ฌํ–‰ ๊ทœ์น™ ๊ฑฐ๋ž˜ ๊ฒ€์ฆ. ๊ท€ํ•˜์˜ ๊ด€ํ• ๊ถŒ๊ณผ ์ˆ˜ํ˜œ์ž์˜ ๊ด€ํ• ๊ถŒ์—์„œ ์š”๊ตฌํ•˜๋Š” ์ˆ˜ํ˜œ์ž VASP ์„ธ๋ถ€ ์ •๋ณด๋ฅผ ํ™•์ธํ•ฉ๋‹ˆ๋‹ค. **์ฐธ๊ณ :** ์ด ์„น์…˜์˜ ์ฐธ์กฐ ์ฝ˜ํ…์ธ ๋Š” ์—ฌํ–‰ ๊ทœ์น™ ๋ฒ ํƒ€ ์—”๋“œํฌ์ธํŠธ๋ฅผ ์„ค๋ช…ํ•ฉ๋‹ˆ๋‹ค. ๋ฒ ํƒ€ ์—”๋“œํฌ์ธํŠธ์—๋Š” ํ˜„์žฌ ๋ฏธ๋ฆฌ๋ณด๊ธฐ ์ƒํƒœ์ด๋ฉฐ ์•„์ง ์ผ๋ฐ˜์ ์œผ๋กœ ์‚ฌ์šฉํ•  ์ˆ˜ ์—†๋Š” API๊ฐ€ ํฌํ•จ๋ฉ๋‹ˆ๋‹ค. ๋ฒ ํƒ€์— ๋“ฑ๋กํ•˜๊ณ  ์ด ์—”๋“œํฌ์ธํŠธ๋ฅผ ํ™œ์„ฑํ™”ํ•˜๋ ค๋ฉด Fireblocks ๊ณ ๊ฐ ์„ฑ๊ณต ๊ด€๋ฆฌ์ž์—๊ฒŒ ๋ฌธ์˜ํ•˜๊ฑฐ๋‚˜ [CSM@fireblocks.com](mailto:CSM@fireblocks.com)์œผ๋กœ ์ด๋ฉ”์ผ์„ ๋ณด๋‚ด์„ธ์š”..", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TravelRuleValidateTransactionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "๊ฑฐ๋ž˜๊ฐ€ ์„ฑ๊ณต์ ์œผ๋กœ ๊ฒ€์ฆ๋˜์—ˆ์Šต๋‹ˆ๋‹ค", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TravelRuleValidateTransactionResponse" + } + } + } + }, + "400": { + "description": "์ž˜๋ชป๋œ ์š”์ฒญ ๋ณธ๋ฌธ" + }, + "500": { + "description": "๋‚ด๋ถ€ ์„œ๋ฒ„ ์˜ค๋ฅ˜" + } + }, + "tags": [ + "Travel Rule (Beta)" + ] + } + }, + "/screening/travel_rule/transaction/validate/full": { + "post": { + "operationId": "TravelRuleApiController_validateFull", + "summary": "์ „์ฒด ์—ฌํ–‰ ๊ทœ์น™ ๊ฑฐ๋ž˜ ํ™•์ธ", + "description": "์ „์ฒด ์—ฌํ–‰ ๊ทœ์น™ ๊ฑฐ๋ž˜๋ฅผ ๊ฒ€์ฆํ•ฉ๋‹ˆ๋‹ค. ๋ฐœ์‹ ์ž ๋ฐ ์ˆ˜ํ˜œ์ž VASP์— ๋Œ€ํ•œ ๋ชจ๋“  ํ•„์ˆ˜ ์ •๋ณด๋ฅผ ํ™•์ธํ•ฉ๋‹ˆ๋‹ค. **์ฐธ๊ณ :** ์ด ์„น์…˜์˜ ์ฐธ์กฐ ์ฝ˜ํ…์ธ ๋Š” ์—ฌํ–‰ ๊ทœ์น™ ๋ฒ ํƒ€ ์—”๋“œํฌ์ธํŠธ๋ฅผ ์„ค๋ช…ํ•ฉ๋‹ˆ๋‹ค. ๋ฒ ํƒ€ ์—”๋“œํฌ์ธํŠธ์—๋Š” ํ˜„์žฌ ๋ฏธ๋ฆฌ๋ณด๊ธฐ ์ƒํƒœ์ด๋ฉฐ ์•„์ง ์ผ๋ฐ˜์ ์œผ๋กœ ์‚ฌ์šฉํ•  ์ˆ˜ ์—†๋Š” API๊ฐ€ ํฌํ•จ๋ฉ๋‹ˆ๋‹ค. ๋ฒ ํƒ€์— ๋“ฑ๋กํ•˜๊ณ  ์ด ์—”๋“œํฌ์ธํŠธ๋ฅผ ํ™œ์„ฑํ™”ํ•˜๋ ค๋ฉด Fireblocks ๊ณ ๊ฐ ์„ฑ๊ณต ๊ด€๋ฆฌ์ž์—๊ฒŒ ๋ฌธ์˜ํ•˜๊ฑฐ๋‚˜ [CSM@fireblocks.com](mailto:CSM@fireblocks.com)์œผ๋กœ ์ด๋ฉ”์ผ์„ ๋ณด๋‚ด์„ธ์š”..", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TravelRuleValidateFullTransactionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "๊ฑฐ๋ž˜๊ฐ€ ์„ฑ๊ณต์ ์œผ๋กœ ๊ฒ€์ฆ๋˜์—ˆ์Šต๋‹ˆ๋‹ค", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TravelRuleValidateTransactionResponse" + } + } + } + }, + "400": { + "description": "์ž˜๋ชป๋œ ์š”์ฒญ ๋ณธ๋ฌธ" + }, + "500": { + "description": "๋‚ด๋ถ€ ์„œ๋ฒ„ ์˜ค๋ฅ˜" + } + }, + "tags": [ + "Travel Rule (Beta)" + ] + } + }, + "/screening/travel_rule/vasp/{did}": { + "get": { + "operationId": "TravelRuleApiController_findVasp", + "summary": "VASP ์„ธ๋ถ€ ์ •๋ณด ๋ฐ›๊ธฐ", + "description": "VASP ์„ธ๋ถ€ ์ •๋ณด ๊ฐ€์ ธ์˜ค๊ธฐ. ์ง€์ •๋œ DID๊ฐ€ ์žˆ๋Š” VASP์— ๋Œ€ํ•œ ์ •๋ณด๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค. **์ฐธ๊ณ :** ์ด ์„น์…˜์˜ ์ฐธ์กฐ ์ฝ˜ํ…์ธ ๋Š” Travel Rule ๋ฒ ํƒ€ ์—”๋“œํฌ์ธํŠธ๋ฅผ ์„ค๋ช…ํ•ฉ๋‹ˆ๋‹ค. ๋ฒ ํƒ€ ์—”๋“œํฌ์ธํŠธ์—๋Š” ํ˜„์žฌ ๋ฏธ๋ฆฌ ๋ณด๊ธฐ ์ค‘์ด๋ฉฐ ์•„์ง ์ผ๋ฐ˜์ ์œผ๋กœ ์‚ฌ์šฉํ•  ์ˆ˜ ์—†๋Š” API๊ฐ€ ํฌํ•จ๋ฉ๋‹ˆ๋‹ค. ๋ฒ ํƒ€์— ๋“ฑ๋กํ•˜๊ณ  ์ด ์—”๋“œํฌ์ธํŠธ๋ฅผ ํ™œ์„ฑํ™”ํ•˜๋ ค๋ฉด Fireblocks ๊ณ ๊ฐ ์„ฑ๊ณต ๊ด€๋ฆฌ์ž์—๊ฒŒ ๋ฌธ์˜ํ•˜๊ฑฐ๋‚˜ [CSM@fireblocks.com](mailto:CSM@fireblocks.com)์œผ๋กœ ์ด๋ฉ”์ผ์„ ๋ณด๋‚ด์„ธ์š”..", + "parameters": [ + { + "name": "did", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + }, + { + "name": "fields", + "required": false, + "in": "query", + "description": "๋ฐ˜ํ™˜ํ•  ํ•„๋“œ์˜ CSV(๋ชจ๋‘, "๊ณต๋ฐฑ" ๋˜๋Š” ์•„๋ž˜ ๋ชจ๋“  ํ•„๋“œ ์ด๋ฆ„ ๋ชฉ๋ก ์ฐธ์กฐ)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "๊ฑฐ๋ž˜๊ฐ€ ์„ฑ๊ณต์ ์œผ๋กœ ๊ฒ€์ฆ๋˜์—ˆ์Šต๋‹ˆ๋‹ค", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TravelRuleVASP" + } + } + } + }, + "400": { + "description": "์ž˜๋ชป๋œ ์š”์ฒญ ๋ณธ๋ฌธ" + }, + "500": { + "description": "๋‚ด๋ถ€ ์„œ๋ฒ„ ์˜ค๋ฅ˜" + } + }, + "tags": [ + "Travel Rule (Beta)" + ] + } + }, + "/screening/travel_rule/vasp": { + "get": { + "operationId": "TravelRuleApiController_findAllVasp", + "summary": "๋ชจ๋“  VASP ๊ฐ€์ ธ์˜ค๊ธฐ", + "description": "๋ชจ๋“  VASP ๊ฐ€์ ธ์˜ค๊ธฐ. VASP ๋ชฉ๋ก์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค. VASP๋ฅผ ๊ฒ€์ƒ‰ํ•˜๊ณ  ์ •๋ ฌํ•  ์ˆ˜ ์žˆ์œผ๋ฉฐ ๊ฒฐ๊ณผ๋Š” ํŽ˜์ด์ง€๋ณ„๋กœ ๊ตฌ๋ถ„๋ฉ๋‹ˆ๋‹ค. **์ฐธ๊ณ :** ์ด ์„น์…˜์˜ ์ฐธ์กฐ ์ฝ˜ํ…์ธ ๋Š” Travel Rule ๋ฒ ํƒ€ ์—”๋“œํฌ์ธํŠธ๋ฅผ ์„ค๋ช…ํ•ฉ๋‹ˆ๋‹ค. ๋ฒ ํƒ€ ์—”๋“œํฌ์ธํŠธ์—๋Š” ํ˜„์žฌ ๋ฏธ๋ฆฌ๋ณด๊ธฐ ์ƒํƒœ์ด๋ฉฐ ์•„์ง ์ผ๋ฐ˜์ ์œผ๋กœ ์‚ฌ์šฉํ•  ์ˆ˜ ์—†๋Š” API๊ฐ€ ํฌํ•จ๋ฉ๋‹ˆ๋‹ค. ๋ฒ ํƒ€์— ๋“ฑ๋กํ•˜๊ณ  ์ด ์—”๋“œํฌ์ธํŠธ๋ฅผ ํ™œ์„ฑํ™”ํ•˜๋ ค๋ฉด Fireblocks ๊ณ ๊ฐ ์„ฑ๊ณต ๊ด€๋ฆฌ์ž์—๊ฒŒ ๋ฌธ์˜ํ•˜๊ฑฐ๋‚˜ [CSM@fireblocks.com](mailto:CSM@fireblocks.com)์œผ๋กœ ์ด๋ฉ”์ผ์„ ๋ณด๋‚ด์„ธ์š”..", + "parameters": [ + { + "name": "order", + "required": false, + "in": "query", + "description": "์ฃผ๋ฌธํ•  ํ•„๋“œ", + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "required": false, + "in": "query", + "description": "ํŽ˜์ด์ง€๋‹น ๋ ˆ์ฝ”๋“œ ์ˆ˜", + "schema": { + "type": "number" + } + }, + { + "name": "page", + "required": false, + "in": "query", + "description": "ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ", + "schema": { + "type": "number" + } + }, + { + "name": "fields", + "required": false, + "in": "query", + "description": "๋ฐ˜ํ™˜ํ•  ํ•„๋“œ์˜ CSV(๋ชจ๋‘, "๊ณต๋ฐฑ" ๋˜๋Š” ์•„๋ž˜ ๋ชจ๋“  ํ•„๋“œ ์ด๋ฆ„ ๋ชฉ๋ก ์ฐธ์กฐ)", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "๋ชจ๋“  VASP๋ฅผ ์–ป์œผ์„ธ์š”", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TravelRuleGetAllVASPsResponse" + } + } + } + } + }, + "tags": [ + "Travel Rule (Beta)" + ] + } + }, + "/screeening/travel_rule/vasp/update": { + "put": { + "operationId": "TravelRuleApiController_updateVasp", + "summary": "VASP ์„ธ๋ถ€ ์ •๋ณด์— jsonDidKey ์ถ”๊ฐ€", + "description": "VASP ์„ธ๋ถ€ ์ •๋ณด ์—…๋ฐ์ดํŠธ. ์ œ๊ณต๋œ ๋งค๊ฐœ๋ณ€์ˆ˜๋กœ VASP๋ฅผ ์—…๋ฐ์ดํŠธํ•ฉ๋‹ˆ๋‹ค. ์ด ์—”๋“œํฌ์ธํŠธ๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ Notabene์—์„œ ์ƒ์„ฑํ•œ ๊ณต๊ฐœ jsonDIDkey๋ฅผ ์ถ”๊ฐ€ํ•ฉ๋‹ˆ๋‹ค. **์ฐธ๊ณ :** ์ด ์„น์…˜์˜ ์ฐธ์กฐ ์ฝ˜ํ…์ธ ๋Š” Travel Rule ๋ฒ ํƒ€ ์—”๋“œํฌ์ธํŠธ๋ฅผ ์„ค๋ช…ํ•ฉ๋‹ˆ๋‹ค. ๋ฒ ํƒ€ ์—”๋“œํฌ์ธํŠธ์—๋Š” ํ˜„์žฌ ๋ฏธ๋ฆฌ ๋ณด๊ธฐ ์ค‘์ด๋ฉฐ ์•„์ง ์ผ๋ฐ˜์ ์œผ๋กœ ์‚ฌ์šฉํ•  ์ˆ˜ ์—†๋Š” API๊ฐ€ ํฌํ•จ๋ฉ๋‹ˆ๋‹ค. ๋ฒ ํƒ€์— ๋“ฑ๋กํ•˜๊ณ  ์ด ์—”๋“œํฌ์ธํŠธ๋ฅผ ํ™œ์„ฑํ™”ํ•˜๋ ค๋ฉด Fireblocks ๊ณ ๊ฐ ์„ฑ๊ณต ๊ด€๋ฆฌ์ž์—๊ฒŒ ๋ฌธ์˜ํ•˜๊ฑฐ๋‚˜ [CSM@fireblocks.com](mailto:CSM@fireblocks.com)์œผ๋กœ ์ด๋ฉ”์ผ์„ ๋ณด๋‚ด์„ธ์š”..", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TravelRuleUpdateVASPDetails" + } + } + } + }, + "responses": { + "200": { + "description": "VASP๊ฐ€ ์„ฑ๊ณต์ ์œผ๋กœ ์—…๋ฐ์ดํŠธ๋˜์—ˆ์Šต๋‹ˆ๋‹ค", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TravelRuleUpdateVASPDetails" + } + } + } + }, + "400": { + "description": "์ž˜๋ชป๋œ ์š”์ฒญ ๋ณธ๋ฌธ" + }, + "500": { + "description": "๋‚ด๋ถ€ ์„œ๋ฒ„ ์˜ค๋ฅ˜" + } + }, + "tags": [ + "Travel Rule (Beta)" + ] + } + }, + "/tap/active_policy": { + "get": { + "summary": "ํ™œ์„ฑ ์ •์ฑ… ๋ฐ ํ•ด๋‹น ์œ ํšจ์„ฑ ๊ฒ€์‚ฌ ๊ฐ€์ ธ์˜ค๊ธฐ", + "description": "ํ™œ์„ฑ ์ •์ฑ…๊ณผ ํ•ด๋‹น ๊ฒ€์ฆ์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค.
**์ฐธ๊ณ :** ์ด๋Ÿฌํ•œ ์—”๋“œํฌ์ธํŠธ๋Š” ํ˜„์žฌ ๋ฒ ํƒ€ ์ƒํƒœ์ด๋ฉฐ ๋ณ€๊ฒฝ๋  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. Fireblocks TAP์— ์ฐธ์—ฌํ•˜๊ณ  ์ž์„ธํžˆ ์•Œ์•„๋ณด๋ ค๋ฉด Fireblocks ๊ณ ๊ฐ ์„ฑ๊ณต ๊ด€๋ฆฌ์ž์—๊ฒŒ ๋ฌธ์˜ํ•˜๊ฑฐ๋‚˜ CSM@fireblocks.com์œผ๋กœ ์ด๋ฉ”์ผ์„ ๋ณด๋‚ด์ฃผ์„ธ์š”..", + "tags": [ + "Policy Editor (Beta)" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "policy = fireblocks.get_active_policy()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const policy = await fireblocks.getActivePolicy();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "์ •์ฑ… ๊ฐ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PolicyAndValidationResponse" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/tap/draft": { + "get": { + "summary": "ํ™œ์„ฑ ์ดˆ์•ˆ์„ ๋ฐ›์œผ์„ธ์š”", + "description": "ํ™œ์„ฑ ์ดˆ์•ˆ๊ณผ ํ•ด๋‹น ๊ฒ€์ฆ์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค.
**์ฐธ๊ณ :** ์ด๋Ÿฌํ•œ ์—”๋“œํฌ์ธํŠธ๋Š” ํ˜„์žฌ ๋ฒ ํƒ€ ์ƒํƒœ์ด๋ฉฐ ๋ณ€๊ฒฝ๋  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. Fireblocks TAP์— ์ฐธ์—ฌํ•˜๊ณ  ์ž์„ธํžˆ ์•Œ์•„๋ณด๋ ค๋ฉด Fireblocks ๊ณ ๊ฐ ์„ฑ๊ณต ๊ด€๋ฆฌ์ž์—๊ฒŒ ๋ฌธ์˜ํ•˜๊ฑฐ๋‚˜ CSM@fireblocks.com์œผ๋กœ ์ด๋ฉ”์ผ์„ ๋ณด๋‚ด์ฃผ์„ธ์š”..", + "tags": [ + "Policy Editor (Beta)" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "policy = fireblocks.get_draft()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const policy = await fireblocks.getDraft();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "responses": { + "200": { + "description": "์ดˆ์•ˆ ๊ฒ€์ฆ ์‘๋‹ต ๊ฐ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/DraftReviewAndValidationResponse" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "put": { + "summary": "์ƒˆ๋กœ์šด ๊ทœ์น™ ์„ธํŠธ๋กœ ์ดˆ์•ˆ์„ ์—…๋ฐ์ดํŠธํ•˜์„ธ์š”", + "description": "์ดˆ์•ˆ์„ ์—…๋ฐ์ดํŠธํ•˜๊ณ  ๊ฒ€์ฆ์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค.
**์ฐธ๊ณ :** ์ด๋Ÿฌํ•œ ์—”๋“œํฌ์ธํŠธ๋Š” ํ˜„์žฌ ๋ฒ ํƒ€ ์ƒํƒœ์ด๋ฉฐ ๋ณ€๊ฒฝ๋  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. Fireblocks TAP์— ์ฐธ์—ฌํ•˜๊ณ  ์ž์„ธํžˆ ์•Œ์•„๋ณด๋ ค๋ฉด Fireblocks ๊ณ ๊ฐ ์„ฑ๊ณต ๊ด€๋ฆฌ์ž์—๊ฒŒ ๋ฌธ์˜ํ•˜๊ฑฐ๋‚˜ CSM@fireblocks.com์œผ๋กœ ์ด๋ฉ”์ผ์„ ๋ณด๋‚ด์ฃผ์„ธ์š”..", + "tags": [ + "Policy Editor (Beta)" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "policy = fireblocks.update_draft()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const policy = await fireblocks.updateDraft();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "rules": { + "description": "์ดˆ์•ˆ์„ ์—…๋ฐ์ดํŠธํ•˜๊ธฐ ์œ„ํ•œ ๊ทœ์น™", + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicyRule" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "์ดˆ์•ˆ ๊ฒ€์ฆ ์‘๋‹ต ๊ฐ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/DraftReviewAndValidationResponse" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "summary": "ํŠน์ • ์ดˆ์•ˆ ID์— ๋Œ€ํ•œ ๊ฒŒ์‹œ ์š”์ฒญ ๋ณด๋‚ด๊ธฐ", + "description": "ํŠน์ • ์ดˆ์•ˆ ID์˜ ๊ฒŒ์‹œ ์š”์ฒญ์„ ๋ณด๋‚ด๊ณ  ์‘๋‹ต์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค.
**์ฐธ๊ณ :** ์ด๋Ÿฌํ•œ ์—”๋“œํฌ์ธํŠธ๋Š” ํ˜„์žฌ ๋ฒ ํƒ€ ์ƒํƒœ์ด๋ฉฐ ๋ณ€๊ฒฝ๋  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. Fireblocks TAP์— ์ฐธ์—ฌํ•˜๊ณ  ์ž์„ธํžˆ ์•Œ์•„๋ณด๋ ค๋ฉด Fireblocks ๊ณ ๊ฐ ์„ฑ๊ณต ๊ด€๋ฆฌ์ž์—๊ฒŒ ๋ฌธ์˜ํ•˜๊ฑฐ๋‚˜ CSM@fireblocks.com์œผ๋กœ ์ด๋ฉ”์ผ์„ ๋ณด๋‚ด์ฃผ์„ธ์š”..", + "tags": [ + "Policy Editor (Beta)" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "policy = fireblocks.publish_draft()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const policy = await fireblocks.publishDraft();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "draftId": { + "description": "์ดˆ์•ˆ ๊ณ ์œ  ์‹๋ณ„์ž", + "type": "string" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "์ •์ฑ… ๊ฒŒ์‹œ ๊ฒฐ๊ณผ ๊ฐœ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PublishResult" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/tap/publish": { + "post": { + "summary": "์ •์ฑ… ๊ทœ์น™ ์„ธํŠธ์— ๋Œ€ํ•œ ๊ฒŒ์‹œ ์š”์ฒญ ๋ณด๋‚ด๊ธฐ", + "description": "์ •์ฑ… ๊ทœ์น™ ์ง‘ํ•ฉ์— ๋Œ€ํ•œ ๊ฒŒ์‹œ ์š”์ฒญ์„ ๋ณด๋‚ด๊ณ  ์‘๋‹ต์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค.
**์ฐธ๊ณ :** ์ด๋Ÿฌํ•œ ์—”๋“œํฌ์ธํŠธ๋Š” ํ˜„์žฌ ๋ฒ ํƒ€ ์ƒํƒœ์ด๋ฉฐ ๋ณ€๊ฒฝ๋  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. Fireblocks TAP์— ์ฐธ์—ฌํ•˜๊ณ  ์ž์„ธํžˆ ์•Œ์•„๋ณด๋ ค๋ฉด Fireblocks ๊ณ ๊ฐ ์„ฑ๊ณต ๊ด€๋ฆฌ์ž์—๊ฒŒ ๋ฌธ์˜ํ•˜๊ฑฐ๋‚˜ CSM@fireblocks.com์œผ๋กœ ์ด๋ฉ”์ผ์„ ๋ณด๋‚ด์ฃผ์„ธ์š”..", + "tags": [ + "Policy Editor (Beta)" + ], + "x-readme": { + "code-samples": [ + { + "language": "python", + "code": "policy = fireblocks.publish_rules()", + "name": "Fireblocks SDK Python example" + }, + { + "language": "javascript", + "code": "const policy = await fireblocks.publishRules();", + "name": "Fireblocks SDK Javascript example" + } + ] + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "rules": { + "description": "๊ฒŒ์‹œํ•  ์ •์ฑ… ๊ทœ์น™", + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicyRule" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "์ •์ฑ… ๊ฒŒ์‹œ ๊ฒฐ๊ณผ ๊ฐœ์ฒด", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PublishResult" + } + } + } + }, + "default": { + "description": "์˜ค๋ฅ˜ ์‘๋‹ต", + "headers": { + "X-Request-ID": { + "schema": { + "type": "string" + }, + "description": "API ์š”์ฒญ๊ณผ ๊ด€๋ จ๋œ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค. Fireblocks SDK์™€ ๊ด€๋ จ๋œ Github ๋ฌธ์ œ๋‚˜ ์ƒ์„ฑํ•œ ์ง€์› ํ‹ฐ์ผ“์— ์ œ๊ณตํ•˜์„ธ์š”.", + "in": "header" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "MediaEntityResponse": { + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "์บ์‹œ๋œ ์ ‘๊ทผ ๊ฐ€๋Šฅํ•œ URL" + }, + "contentType": { + "oneOf": [ + { + "const": "IMAGE" + }, + { + "const": "VIDEO" + }, + { + "const": "ANIMATION" + }, + { + "const": "THREE_D" + }, + { + "const": "TEXT" + }, + { + "const": "GIF" + }, + { + "const": "UNKNOWN_TYPE" + }, + { + "const": "SVG" + }, + { + "const": "AUDIO" + } + ], + "description": "๋ฏธ๋””์–ด ์œ ํ˜•" + } + }, + "required": [ + "url", + "contentType" + ] + }, + "TokenCollectionResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "symbol": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "symbol" + ] + }, + "TokenResponse": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Fireblocks NFT ์ž์‚ฐ ID" + }, + "tokenId": { + "type": "string", + "description": "๊ณ„์•ฝ/์ปฌ๋ ‰์…˜ ๋‚ด ํ† ํฐ ID" + }, + "standard": { + "type": "string", + "description": "ERC721 / ERC1155" + }, + "metadataURI": { + "type": "string", + "description": "์›๋ž˜ ํ† ํฐ JSON ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ์˜ URL" + }, + "cachedMetadataURI": { + "type": "string", + "description": "์บ์‹œ๋œ ํ† ํฐ JSON ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ์˜ URL" + }, + "media": { + "description": "๋ฉ”ํƒ€๋ฐ์ดํ„ฐ JSON์—์„œ ์ถ”์ถœ๋œ ๋ฏธ๋””์–ด ํ•ญ๋ชฉ", + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaEntityResponse" + } + }, + "collection": { + "description": "๋ถ€๋ชจ ์ปฌ๋ ‰์…˜ ์ •๋ณด", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "symbol": { + "type": "string" + } + } + }, + "blockchainDescriptor": { + "oneOf": [ + { + "const": "ETH" + }, + { + "const": "ETH_TEST3" + }, + { + "const": "POLYGON" + }, + { + "const": "POLYGON_TEST_MUMBAI" + } + ] + }, + "description": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "tokenId", + "standard", + "media", + "blockchainDescriptor", + "description", + "name" + ] + }, + "UpdateTokenOwnershipStatusDto": { + "type": "object", + "properties": { + "status": { + "oneOf": [ + { + "const": "LISTED" + }, + { + "const": "ARCHIVED" + } + ] + } + }, + "required": [ + "status" + ] + }, + "Paging": { + "type": "object", + "properties": { + "next": { + "type": "string", + "description": "๋‹ค์Œ ํŽ˜์ด์ง€๋กœ ์ปค์„œ ์ด๋™" + } + }, + "required": [ + "next" + ] + }, + "TokenOwnershipResponse": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Fireblocks NFT ์ž์‚ฐ ID" + }, + "tokenId": { + "type": "string", + "description": "๊ณ„์•ฝ/์ปฌ๋ ‰์…˜ ๋‚ด ํ† ํฐ ID" + }, + "standard": { + "type": "string", + "description": "ERC721 / ERC1155" + }, + "metadataURI": { + "type": "string", + "description": "์›๋ž˜ ํ† ํฐ JSON ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ์˜ URL" + }, + "cachedMetadataURI": { + "type": "string", + "description": "์บ์‹œ๋œ ํ† ํฐ JSON ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ์˜ URL" + }, + "media": { + "description": "๋ฉ”ํƒ€๋ฐ์ดํ„ฐ JSON์—์„œ ์ถ”์ถœ๋œ ๋ฏธ๋””์–ด ํ•ญ๋ชฉ", + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaEntityResponse" + } + }, + "collection": { + "description": "๋ถ€๋ชจ ์ปฌ๋ ‰์…˜ ์ •๋ณด", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "symbol": { + "type": "string" + } + } + }, + "balance": { + "type": "string" + }, + "vaultAccountId": { + "type": "string" + }, + "ownershipStartTime": { + "type": "number" + }, + "ownershipLastUpdateTime": { + "type": "number" + }, + "blockchainDescriptor": { + "oneOf": [ + { + "const": "ETH" + }, + { + "const": "ETH_TEST3" + }, + { + "const": "POLYGON" + }, + { + "const": "POLYGON_TEST_MUMBAI" + } + ] + }, + "description": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "tokenId", + "standard", + "media", + "balance", + "vaultAccountId", + "ownershipStartTime", + "ownershipLastUpdateTime", + "blockchainDescriptor", + "description", + "name" + ] + }, + "CollectionOwnershipResponse": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Fireblocks ์ปฌ๋ ‰์…˜ ID" + }, + "name": { + "type": "string", + "description": "์ปฌ๋ ‰์…˜ ์ด๋ฆ„" + }, + "symbol": { + "type": "string", + "description": "์ปฌ๋ ‰์…˜ ์‹ฌ๋ณผ" + }, + "standard": { + "type": "string", + "description": "์ˆ˜์ง‘๊ณ„์•ฝ๊ธฐ์ค€" + }, + "blockchainDescriptor": { + "oneOf": [ + { + "const": "ETH" + }, + { + "const": "ETH_TEST3" + }, + { + "const": "POLYGON" + }, + { + "const": "POLYGON_TEST_MUMBAI" + } + ], + "description": "์ปฌ๋ ‰์…˜์˜ ๋ธ”๋ก์ฒด์ธ" + }, + "contractAddress": { + "type": "string", + "description": "์ˆ˜์ง‘๊ณ„์•ฝ๊ธฐ์ค€" + } + }, + "required": [ + "id", + "name", + "symbol", + "blockchainDescriptor" + ] + }, + "WalletAsset": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "balance": { + "type": "string" + }, + "lockedAmount": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/ConfigChangeRequestStatus" + }, + "address": { + "type": "string" + }, + "tag": { + "type": "string" + }, + "activationTime": { + "type": "string" + } + } + }, + "ExternalWalletAsset": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/ConfigChangeRequestStatus" + }, + "address": { + "type": "string" + }, + "tag": { + "type": "string" + }, + "activationTime": { + "type": "string" + }, + "additionalInfo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WalletAssetAdditionalInfo" + } + } + } + }, + "WalletAssetAdditionalInfo": { + "type": "object", + "properties": { + "accountHolderGivenName": { + "type": "string" + }, + "accountHolderSurname": { + "type": "string" + }, + "accountHolderCity": { + "type": "string" + }, + "accountHolderCountry": { + "type": "string" + }, + "accountHolderAddress1": { + "type": "string" + }, + "accountHolderAddress2": { + "type": "string" + }, + "accountHolderDistrict": { + "type": "string" + }, + "accountHolderPostalCode": { + "type": "string" + }, + "abaRoutingNumber": { + "type": "string" + }, + "abaAccountNumber": { + "type": "string" + }, + "abaCountry": { + "type": "string" + }, + "iban": { + "type": "string" + }, + "ibanCity": { + "type": "string" + }, + "ibanCountry": { + "type": "string" + }, + "speiClabe": { + "type": "string" + }, + "speiName": { + "type": "string" + } + } + }, + "ExchangeAsset": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "balance": { + "type": "string" + }, + "lockedAmount": { + "type": "string" + }, + "total": { + "type": "string" + }, + "available": { + "type": "string" + } + } + }, + "ExchangeTradingAccount": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "name": { + "type": "string" + }, + "assets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExchangeAsset" + } + } + } + }, + "FiatAsset": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "balance": { + "type": "string" + } + } + }, + "CreateVaultAssetResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "address": { + "type": "string" + }, + "legacyAddress": { + "type": "string" + }, + "enterpriseAddress": { + "type": "string" + }, + "tag": { + "type": "string" + }, + "eosAccountName": { + "type": "string" + }, + "status": { + "type": "string" + }, + "activationTxId": { + "type": "string" + } + } + }, + "RewardsInfo": { + "type": "object", + "properties": { + "pendingRewards": { + "description": "๋ณด์ƒ์— ๋Œ€ํ•œ ๋ณด๋ฅ˜ ์ค‘์ธ ๊ธˆ์•ก", + "type": "string" + } + } + }, + "VaultAsset": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "total": { + "description": "์ด ์ง€๊ฐ‘ ์ž”์•ก. EOS์—์„œ ์ด ๊ฐ’์—๋Š” ๋„คํŠธ์›Œํฌ ์ž”์•ก, ์…€ํ”„ ์Šคํ…Œ์ดํ‚น ๋ฐ ๋ณด๋ฅ˜ ์ค‘์ธ ํ™˜๋ถˆ์ด ํฌํ•จ๋ฉ๋‹ˆ๋‹ค. ๋‹ค๋ฅธ ๋ชจ๋“  ์ฝ”์ธ์˜ ๊ฒฝ์šฐ ๋ธ”๋ก์ฒด์ธ์— ๋‚˜ํƒ€๋‚˜๋Š” ์ž”์•ก์ž…๋‹ˆ๋‹ค..", + "type": "string" + }, + "balance": { + "deprecated": true, + "description": "๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ - "total"๋กœ ๋Œ€์ฒด๋จ", + "type": "string" + }, + "available": { + "description": "์ด์ฒด ๊ฐ€๋Šฅํ•œ ์ž๊ธˆ. ๋ธ”๋ก์ฒด์ธ ์ž”์•ก์—์„œ ์ž ๊ธด ๊ธˆ์•ก์„ ๋บ€ ๊ฐ’๊ณผ ๊ฐ™์Šต๋‹ˆ๋‹ค.", + "type": "string" + }, + "pending": { + "description": "์ •์‚ฐ ๋Œ€๊ธฐ ์ค‘์ธ ๋ชจ๋“  ๊ฑฐ๋ž˜์˜ ๋ˆ„์  ์ž”์•ก", + "type": "string" + }, + "frozen": { + "description": "๋ˆ„์  ๋™๊ฒฐ ์ž”์•ก", + "type": "string" + }, + "lockedAmount": { + "description": "์•„์ง ๋„คํŠธ์›Œํฌ์— ๊ณต๊ฐœ๋˜์ง€ ์•Š์€ ๋ฐœ์‹  ๊ฑฐ๋ž˜์˜ ์ž๊ธˆ", + "type": "string" + }, + "staked": { + "description": "์ง€๋ถ„ ์ž”์•ก", + "type": "string" + }, + "totalStakedCPU": { + "type": "number", + "description": "๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ" + }, + "totalStakedNetwork": { + "type": "string", + "description": "๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ" + }, + "selfStakedCPU": { + "type": "string", + "description": "๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ" + }, + "selfStakedNetwork": { + "type": "string", + "description": "๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ" + }, + "pendingRefundCPU": { + "type": "string", + "description": "๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ" + }, + "pendingRefundNetwork": { + "type": "string", + "description": "๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ" + }, + "blockHeight": { + "type": "string" + }, + "blockHash": { + "type": "string" + }, + "rewardsInfo": { + "$ref": "#/components/schemas/RewardsInfo" + } + } + }, + "VaultWalletAddress": { + "type": "object", + "properties": { + "assetId": { + "type": "string", + "x-fb-entity": "asset" + }, + "address": { + "type": "string" + }, + "description": { + "type": "string" + }, + "tag": { + "type": "string" + }, + "type": { + "type": "string" + }, + "customerRefId": { + "type": "string" + }, + "addressFormat": { + "oneOf": [ + { + "const": "SEGWIT" + }, + { + "const": "LEGACY" + } + ] + }, + "legacyAddress": { + "type": "string" + }, + "enterpriseAddress": { + "type": "string" + }, + "bip44AddressIndex": { + "type": "integer" + }, + "userDefined": { + "type": "boolean" + } + } + }, + "CreateAddressResponse": { + "type": "object", + "properties": { + "address": { + "type": "string" + }, + "legacyAddress": { + "type": "string" + }, + "enterpriseAddress": { + "type": "string" + }, + "tag": { + "type": "string" + }, + "bip44AddressIndex": { + "type": "integer" + } + } + }, + "VaultAccountsPagedResponse": { + "type": "object", + "properties": { + "accounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VaultAccount" + } + }, + "paging": { + "type": "object", + "properties": { + "before": { + "type": "string" + }, + "after": { + "type": "string" + } + } + }, + "previousUrl": { + "type": "string" + }, + "nextUrl": { + "type": "string" + } + } + }, + "PaginatedAssetWalletResponse": { + "type": "object", + "properties": { + "assetWallets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AssetWallet" + } + }, + "paging": { + "type": "object", + "properties": { + "before": { + "description": "์ปค์„œ๋ฅผ ๋‚˜ํƒ€๋‚ด๋Š” ๋ฌธ์ž์—ด์ž…๋‹ˆ๋‹ค. ์‚ฌ์šฉ์ž๋Š” ์ด API ์—”๋“œํฌ์ธํŠธ์— ๋Œ€ํ•œ ์ƒˆ ์š”์ฒญ๊ณผ ํ•จ๊ป˜ "before" ์š”์ฒญ ๋งค๊ฐœ๋ณ€์ˆ˜๋กœ ์‚ฌ์šฉํ•˜์—ฌ ์ด์ „ ํŽ˜์ด์ง€์˜ ๊ฒฐ๊ณผ๋ฅผ ๊ฐ€์ ธ์˜ฌ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค..", + "type": "string" + }, + "after": { + "description": "์ปค์„œ๋ฅผ ๋‚˜ํƒ€๋‚ด๋Š” ๋ฌธ์ž์—ด์ž…๋‹ˆ๋‹ค. ์‚ฌ์šฉ์ž๋Š” ์ด API ์—”๋“œํฌ์ธํŠธ์— ๋Œ€ํ•œ ์ƒˆ ์š”์ฒญ๊ณผ ํ•จ๊ป˜ "before" ์š”์ฒญ ๋งค๊ฐœ๋ณ€์ˆ˜๋กœ ์‚ฌ์šฉํ•˜์—ฌ ๋‹ค์Œ ํŽ˜์ด์ง€์˜ ๊ฒฐ๊ณผ๋ฅผ ๊ฐ€์ ธ์˜ฌ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค..", + "type": "string" + } + } + } + } + }, + "AssetWallet": { + "type": "object", + "properties": { + "vaultId": { + "description": "๋ณผํŠธ ๊ณ„์ •์˜ ID์ž…๋‹ˆ๋‹ค. [์ด ID๋กœ ๋ณผํŠธ ๊ณ„์ •์„ ๊ฐ€์ ธ์˜ฌ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค](https://developers.fireblocks.com/reference/get_vault-accounts-vaultaccountid) ์ด๋ฆ„, ์ž๋™ ์—ฐ๋ฃŒ ๊ณต๊ธ‰, UI์— ์ˆจ๊ฒจ์ง„ ๋ณผํŠธ ์†์„ฑ ๋˜๋Š” ๊ณ ๊ฐ ์ฐธ์กฐ ID์™€ ๊ฐ™์€ ๋ณผํŠธ ์†์„ฑ์„ ๊ฒ€์ƒ‰ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค..", + "type": "string" + }, + "assetId": { + "description": "์ž์‚ฐ์˜ ID์ž…๋‹ˆ๋‹ค. [์ง€์›๋˜๋Š” ์ž์‚ฐ API](https://developers.fireblocks.com/reference/get_supported-assets)๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ์ด ์ž์‚ฐ์— ๋Œ€ํ•œ ์ž์„ธํ•œ ์ •๋ณด๋ฅผ ์–ป์„ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.", + "type": "string" + }, + "available": { + "description": "๊ฑฐ๋ž˜์— ์‚ฌ์šฉ ๊ฐ€๋Šฅํ•œ ์ž”์•ก.", + "type": "string" + }, + "total": { + "description": "๋ธ”๋ก์ฒด์ธ ํƒ์ƒ‰๊ธฐ์—์„œ ๋ณผ ์ˆ˜ ์žˆ๋Š” ์ž์‚ฐ ์ง€๊ฐ‘์˜ ์ด ์ž”์•ก์ž…๋‹ˆ๋‹ค. ์—ฌ๊ธฐ์—๋Š” ์‚ฌ์šฉ ๊ฐ€๋Šฅํ•œ ์ž”์•ก๊ณผ ์ž ๊ธด, ๋™๊ฒฐ๋œ ๋˜๋Š” ๊ธฐํƒ€์™€ ๊ฐ™์€ ์‚ฌ์šฉํ•  ์ˆ˜ ์—†๋Š” ๋ชจ๋“  ์ข…๋ฅ˜์˜ ์ž”์•ก์ด ํฌํ•จ๋ฉ๋‹ˆ๋‹ค..", + "type": "string" + }, + "pending": { + "description": "๋ณด๋ฅ˜์ค‘์ธ ์ž”์•ก.", + "type": "string" + }, + "staked": { + "description": "์ง€๋ถ„ ์ž”์•ก.", + "type": "string" + }, + "frozen": { + "description": "์ด ์ž‘์—… ๊ณต๊ฐ„์˜ ์ž๊ธˆ์„ธํƒ ๋ฐฉ์ง€ ์ •์ฑ…์œผ๋กœ ์ธํ•ด ์ž๊ธˆ์ด ๋™๊ฒฐ๋˜์—ˆ์Šต๋‹ˆ๋‹ค..", + "type": "string" + }, + "lockedAmount": { + "description": "์ž ๊ธด ์ž”์•ก.", + "type": "string" + }, + "blockHeight": { + "description": "์ €์šธ์˜ ๋ธ”๋ก ๋†’์ด(์ˆซ์ž)์ž…๋‹ˆ๋‹ค. ๋น„์–ด ์žˆ์Œ์œผ๋กœ ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค..", + "type": "string" + }, + "blockHash": { + "description": "์ž”์•ก ๋ธ”๋ก์˜ ํ•ด์‹œ. ๋น„์–ด ์žˆ์Œ์œผ๋กœ ํ•  ์ˆ˜ ์žˆ์Œ.", + "type": "string" + }, + "creationTimestamp": { + "description": "์ž์‚ฐ ์ง€๊ฐ‘์ด ์ƒ์„ฑ๋œ ์‹œ๊ฐ„์˜ Unix ํƒ€์ž„์Šคํƒฌํ”„.", + "type": "string" + } + } + }, + "VaultAccount": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "assets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VaultAsset" + } + }, + "hiddenOnUI": { + "type": "boolean" + }, + "customerRefId": { + "type": "string" + }, + "autoFuel": { + "type": "boolean" + } + } + }, + "UnmanagedWallet": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "customerRefId": { + "type": "string" + }, + "assets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WalletAsset" + } + } + }, + "required": [ + "id", + "name", + "status" + ] + }, + "ExchangeAccount": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/ExchangeType" + }, + "name": { + "type": "string", + "description": "๊ฑฐ๋ž˜์†Œ ๊ณ„์ •์˜ ํ‘œ์‹œ ์ด๋ฆ„" + }, + "status": { + "type": "string" + }, + "assets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExchangeAsset" + } + }, + "tradingAccounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExchangeTradingAccount" + } + }, + "isSubaccount": { + "description": "ํ•ด๋‹น ๊ณ„์ •์ด ๊ฑฐ๋ž˜์†Œ์˜ ํ•˜์œ„ ๊ณ„์ •์ธ ๊ฒฝ์šฐ ์ฐธ์ž…๋‹ˆ๋‹ค.", + "type": "boolean" + }, + "mainAccountId": { + "description": "๊ณ„์ •์ด ํ•˜์œ„ ๊ณ„์ •์ธ ๊ฒฝ์šฐ ๋ฉ”์ธ ๊ณ„์ •์˜ ID", + "type": "string" + } + } + }, + "FiatAccount": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/FiatAccountType" + }, + "name": { + "type": "string", + "description": "๋ฒ•์ • ํ†ตํ™” ๊ณ„์ •์˜ ํ‘œ์‹œ ์ด๋ฆ„" + }, + "address": { + "type": "string" + }, + "assets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FiatAsset" + } + } + } + }, + "OneTimeAddress": { + "type": "object", + "properties": { + "address": { + "type": "string" + }, + "tag": { + "type": "string" + } + }, + "required": [ + "address" + ] + }, + "TransferPeerPath": { + "type": "object", + "properties": { + "type": { + "oneOf": [ + { + "const": "VAULT_ACCOUNT" + }, + { + "const": "EXCHANGE_ACCOUNT" + }, + { + "const": "INTERNAL_WALLET" + }, + { + "const": "EXTERNAL_WALLET" + }, + { + "const": "NETWORK_CONNECTION" + }, + { + "const": "FIAT_ACCOUNT" + }, + { + "const": "COMPOUND" + }, + { + "const": "GAS_STATION" + }, + { + "const": "ONE_TIME_ADDRESS" + }, + { + "const": "UNKNOWN" + }, + { + "const": "END_USER_WALLET" + } + ] + }, + "subType": { + "oneOf": [ + { + "const": "BINANCE" + }, + { + "const": "BINANCEUS" + }, + { + "const": "BITFINEX" + }, + { + "const": "BITHUMB" + }, + { + "const": "BITMEX" + }, + { + "const": "BITSO" + }, + { + "const": "BITSTAMP" + }, + { + "const": "BITTREX" + }, + { + "const": "BLINC" + }, + { + "const": "BYBIT" + }, + { + "const": "CIRCLE" + }, + { + "const": "COINBASEEXCHANGE" + }, + { + "const": "COINBASEPRO" + }, + { + "const": "COINMETRO" + }, + { + "const": "COINSPRO" + }, + { + "const": "CRYPTOCOM" + }, + { + "const": "DERIBIT" + }, + { + "const": "GEMINI" + }, + { + "const": "HITBTC" + }, + { + "const": "HUOBI" + }, + { + "const": "INDEPENDENTRESERVE" + }, + { + "const": "KORBIT" + }, + { + "const": "KRAKEN" + }, + { + "const": "KRAKENINTL" + }, + { + "const": "KUCOIN" + }, + { + "const": "LIQUID" + }, + { + "const": "OKCOIN" + }, + { + "const": "OKEX" + }, + { + "const": "PAXOS" + }, + { + "const": "POLONIEX" + }, + { + "const": "External" + }, + { + "const": "Internal" + } + ] + }, + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "walletId": { + "type": "string", + "format": "uuid" + } + }, + "required": [ + "type" + ] + }, + "DestinationTransferPeerPath": {}, + "CreateTransactionResponse": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "๊ฑฐ๋ž˜์˜ ID." + }, + "status": { + "type": "string", + "description": "๊ฑฐ๋ž˜์˜ ๊ธฐ๋ณธ ์ƒํƒœ์ž…๋‹ˆ๋‹ค. ์ž์„ธํ•œ ๋‚ด์šฉ์€ [๊ธฐ๋ณธ ๊ฑฐ๋ž˜ ์ƒํƒœ]๋ฅผ ์ฐธ์กฐํ•˜์„ธ์š”. (https://developers.fireblocks.com/reference/primary-transaction-statuses)" + }, + "systemMessages": { + "$ref": "#/components/schemas/SystemMessageInfo" + } + } + }, + "SystemMessageInfo": { + "type": "object", + "properties": { + "type": { + "oneOf": [ + { + "const": "WARN" + }, + { + "const": "BLOCK" + } + ] + }, + "message": { + "type": "string", + "description": "์ˆ˜ํ–‰ ์ค‘์ธ ํ”„๋กœ์„ธ์Šค์˜ ์ƒํƒœ์— ๋Œ€ํ•œ ๋ฉ”์‹œ์ง€๋ฅผ ์ „๋‹ฌํ•˜๋Š” Fireblocks์˜ ์‘๋‹ต์ž…๋‹ˆ๋‹ค. ์ด ๊ฐ์ฒด๊ฐ€ ๋ฐ์ดํ„ฐ์™€ ํ•จ๊ป˜ ๋ฐ˜ํ™˜๋˜๋ฉด ์ž ์žฌ์ ์ธ ์ง€์—ฐ ๋˜๋Š” ๋ถˆ์™„์ „ํ•œ ํŠธ๋žœ์žญ์…˜ ์ƒํƒœ๋ฅผ ์˜ˆ์ƒํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค..", + "example": "Slow transaction processing. Outgoing transactions might be stuck." + } + } + }, + "CancelTransactionResponse": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + } + } + }, + "UnfreezeTransactionResponse": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + } + } + }, + "FreezeTransactionResponse": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + } + } + }, + "AmlScreeningResult": { + "type": "object", + "description": "AML ๊ฒ€์‚ฌ ๊ฒฐ๊ณผ.", + "properties": { + "provider": { + "type": "string" + }, + "payload": { + "type": "object" + } + } + }, + "FeeInfo": { + "type": "object", + "description": "๊ฑฐ๋ž˜ ์ˆ˜์ˆ˜๋ฃŒ ์„ธ๋ถ€ ์ •๋ณด.", + "properties": { + "networkFee": { + "description": "๋„คํŠธ์›Œํฌ์— ์ง€๋ถˆ๋œ ์ˆ˜์ˆ˜๋ฃŒ", + "type": "string" + }, + "serviceFee": { + "description": "๊ฑฐ๋ž˜์†Œ๊ฐ€ ์‹ค์ œ ์š”์ฒญ ๊ธˆ์•ก์—์„œ ๊ณต์ œํ•˜๋Š” ์ด ์ˆ˜์ˆ˜๋ฃŒ(serviceFee = amount - netAmount)", + "type": "string" + }, + "gasPrice": { + "type": "string" + } + } + }, + "BlockInfo": { + "type": "object", + "description": "์ด ๊ฑฐ๋ž˜๊ฐ€ ์ฑ„๊ตด๋œ ๋ธ”๋ก์˜ ํ•ด์‹œ ๋ฐ ๋†’์ด์ž…๋‹ˆ๋‹ค. **์ฐธ๊ณ **: ๋‚˜๊ฐ€๋Š” ๊ฑฐ๋ž˜๊ฐ€ ๋ฐฐ์—ด์— ๋‘ ๊ฐœ ์ด์ƒ์˜ ๊ฐ’์ด ์žˆ๋Š” ๋Œ€์ƒ ๊ฐ์ฒด๋ฅผ ์‚ฌ์šฉํ•˜๋Š” ๊ฒฝ์šฐ blockHash๊ฐ€ null๋กœ ์„ค์ •๋ฉ๋‹ˆ๋‹ค..", + "properties": { + "blockHeight": { + "type": "string" + }, + "blockHash": { + "type": "string" + } + } + }, + "AuthorizationInfo": { + "type": "object", + "description": "[๊ฑฐ๋ž˜ ์Šน์ธ ์ •์ฑ…(TAP)](https://developers.fireblocks.com/docs/capabilities#transaction-authorization-policy-tap)์— ๋Œ€ํ•œ ์ •๋ณด", + "properties": { + "allowOperatorAsAuthorizer": { + "type": "boolean" + }, + "logic": { + "oneOf": [ + { + "const": "AND" + }, + { + "const": "OR" + } + ] + }, + "groups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AuthorizationGroups" + } + } + } + }, + "AuthorizationGroups": { + "type": "object", + "properties": { + "th": { + "type": "number" + }, + "users": { + "type": "object", + "additionalProperties": { + "oneOf": [ + { + "const": "PENDING_AUTHORIZATION" + }, + { + "const": "APPROVED" + }, + { + "const": "REJECTED" + }, + { + "const": "NA" + } + ] + } + } + } + }, + "AmountInfo": { + "type": "object", + "description": "์ด์ฒด ์š”์ฒญ ๊ธˆ์•ก์˜ ์„ธ๋ถ€ ์ •๋ณด.", + "properties": { + "amount": { + "description": "์ด์ฒด๊ฐ€ ๊ฑฐ๋ž˜์†Œ์—์„œ ์ถœ๊ธˆ์ธ ๊ฒฝ์šฐ, ์ด์ฒด๋ฅผ ์š”์ฒญํ•œ ์‹ค์ œ ๊ธˆ์•ก. ๊ทธ๋ ‡์ง€ ์•Š์€ ๊ฒฝ์šฐ, ์š”์ฒญํ•œ ๊ธˆ์•ก.", + "type": "string" + }, + "requestedAmount": { + "description": "์‚ฌ์šฉ์ž๊ฐ€ ์š”์ฒญํ•œ ๊ธˆ์•ก.", + "type": "string" + }, + "netAmount": { + "description": "์ˆ˜์ˆ˜๋ฃŒ๋ฅผ ๊ณต์ œํ•œ ํ›„์˜ ๊ฑฐ๋ž˜ ์ˆœ์•ก.", + "type": "string" + }, + "amountUSD": { + "description": "์š”์ฒญํ•˜์‹  ๊ธˆ์•ก์˜ USD ๊ฐ€์น˜.", + "type": "string" + } + } + }, + "RewardInfo": { + "type": "object", + "description": "์ด ํ•„๋“œ๋Š” Algorand ๊ฑฐ๋ž˜์—๋งŒ ํ•ด๋‹น๋ฉ๋‹ˆ๋‹ค. `srcRewards`์™€ `destRewards`๋Š” ๋ชจ๋‘ Vault to Vault ๊ฑฐ๋ž˜์—๋งŒ ํ‘œ์‹œ๋˜๋ฉฐ, ๊ทธ๋ ‡์ง€ ์•Š์œผ๋ฉด ๊ฑฐ๋ž˜์˜ Fireblocks ์ธก๋งŒ ๋ฐ›๊ฒŒ ๋ฉ๋‹ˆ๋‹ค..", + "properties": { + "srcRewards": { + "type": "string" + }, + "destRewards": { + "type": "string" + } + } + }, + "SourceTransferPeerPathResponse": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "subType": { + "type": "string", + "description": "์œ ํ˜•์ด `EXCHANGE_ACCOUNT` ๋˜๋Š” `FIAT_ACCOUNT`๋กœ ์„ค์ •๋œ ๊ฒฝ์šฐ ํŠน์ • ๊ฑฐ๋ž˜์†Œ ๊ณต๊ธ‰์—…์ฒด ์ด๋ฆ„ ๋˜๋Š” Fiat ๊ณต๊ธ‰์—…์ฒด ์ด๋ฆ„์ž…๋‹ˆ๋‹ค. ์œ ํ˜•์ด `INTERNAL_WALLET` ๋˜๋Š” `EXTERNAL_WALLET`์œผ๋กœ ์„ค์ •๋œ ๊ฒฝ์šฐ ํ•˜์œ„ ์œ ํ˜•์€ `Internal` ๋˜๋Š” `External`๋กœ ์„ค์ •๋ฉ๋‹ˆ๋‹ค.." + }, + "id": { + "type": "string", + "description": "ํ”ผ์–ด์˜ ID์ž…๋‹ˆ๋‹ค. [๋ณผํŠธ ๊ณ„์ • ๋‚˜์—ด](https://developers.fireblocks.com/reference/get_vault-accounts-paged), [๊ฑฐ๋ž˜์†Œ ๊ณ„์ • ๋‚˜์—ด](https://developers.fireblocks.com/reference/get_exchange-accounts), [๋ฒ•์ • ํ†ตํ™” ๊ณ„์ • ๋‚˜์—ด](https://developers.fireblocks.com/reference/get_fiat-accounts), [๋‚ด๋ถ€ ์ง€๊ฐ‘ ๋‚˜์—ด](https://developers.fireblocks.com/reference/get_internal-wallets), [์™ธ๋ถ€ ์ง€๊ฐ‘ ๋‚˜์—ด](https://developers.fireblocks.com/reference/get_external-wallets), [๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ ๋‚˜์—ด](https://developers.fireblocks.com/reference/get_network-connections)์˜ ์—”๋“œํฌ์ธํŠธ๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ๊ฐ ์žฅ์†Œ ๊ฐ์ฒด์˜ ID๋ฅผ ๊ฒ€์ƒ‰ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๋‹ค๋ฅธ ์œ ํ˜•์˜ ๊ฒฝ์šฐ ์ด ๋งค๊ฐœ๋ณ€์ˆ˜๋Š” ํ•„์š”ํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค.." + }, + "name": { + "type": "string", + "description": "๋™๋ฃŒ์˜ ์ด๋ฆ„." + }, + "walletId": { + "type": "string", + "format": "uuid" + } + } + }, + "DestinationTransferPeerPathResponse": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "subType": { + "type": "string", + "description": "์œ ํ˜•์ด `EXCHANGE_ACCOUNT` ๋˜๋Š” `FIAT_ACCOUNT`๋กœ ์„ค์ •๋œ ๊ฒฝ์šฐ ํŠน์ • ๊ฑฐ๋ž˜์†Œ ๊ณต๊ธ‰์—…์ฒด ์ด๋ฆ„ ๋˜๋Š” ๋ฒ•์ • ํ†ตํ™” ๊ณต๊ธ‰์—…์ฒด ์ด๋ฆ„์ž…๋‹ˆ๋‹ค. ์œ ํ˜•์ด `INTERNAL_WALLET` ๋˜๋Š” `EXTERNAL_WALLET`์œผ๋กœ ์„ค์ •๋œ ๊ฒฝ์šฐ ํ•˜์œ„ ์œ ํ˜•์€ `Internal` ๋˜๋Š” `External`๋กœ ์„ค์ •๋ฉ๋‹ˆ๋‹ค.." + }, + "id": { + "type": "string", + "description": "ํ”ผ์–ด์˜ ID์ž…๋‹ˆ๋‹ค. [๋ณผํŠธ ๊ณ„์ • ๋‚˜์—ด](https://developers.fireblocks.com/reference/get_vault-accounts-paged), [๊ฑฐ๋ž˜์†Œ ๊ณ„์ • ๋‚˜์—ด](https://developers.fireblocks.com/reference/get_exchange-accounts), [๋ฒ•์ • ํ†ตํ™” ๊ณ„์ • ๋‚˜์—ด](https://developers.fireblocks.com/reference/get_fiat-accounts), [๋‚ด๋ถ€ ์ง€๊ฐ‘ ๋‚˜์—ด](https://developers.fireblocks.com/reference/get_internal-wallets), [์™ธ๋ถ€ ์ง€๊ฐ‘ ๋‚˜์—ด](https://developers.fireblocks.com/reference/get_external-wallets), [๋„คํŠธ์›Œํฌ ์—ฐ๊ฒฐ ๋‚˜์—ด](https://developers.fireblocks.com/reference/get_network-connections)์˜ ์—”๋“œํฌ์ธํŠธ๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ๊ฐ ์žฅ์†Œ ๊ฐ์ฒด์˜ ID๋ฅผ ๊ฒ€์ƒ‰ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๋‹ค๋ฅธ ์œ ํ˜•์˜ ๊ฒฝ์šฐ ์ด ๋งค๊ฐœ๋ณ€์ˆ˜๋Š” ํ•„์š”ํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค.." + }, + "name": { + "type": "string", + "description": "๋™๋ฃŒ์˜ ์ด๋ฆ„." + }, + "walletId": { + "type": "string", + "format": "uuid" + } + } + }, + "TransactionResponse": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "๊ฑฐ๋ž˜์˜ ID." + }, + "externalTxId": { + "type": "string", + "description": "์‚ฌ์šฉ์ž๊ฐ€ ์ œ๊ณตํ•œ ๊ณ ์œ ํ•œ ๊ฑฐ๋ž˜ ID. Fireblocks๋Š” ๋™์ผํ•œ ๊ฑฐ๋ž˜๋ฅผ ๋‘ ๋ฒˆ ์ œ์ถœํ•˜์ง€ ์•Š๋„๋ก ์ƒ์„ฑ๋œ ๋ชจ๋“  ๊ฑฐ๋ž˜์— ๋Œ€ํ•ด `externalTxId`๋ฅผ ์„ค์ •ํ•˜๋Š” ๊ฒƒ์„ ์ ๊ทน ๊ถŒ์žฅํ•ฉ๋‹ˆ๋‹ค.." + }, + "status": { + "type": "string", + "description": "๊ฑฐ๋ž˜์˜ ๊ธฐ๋ณธ ์ƒํƒœ์ž…๋‹ˆ๋‹ค. ์ž์„ธํ•œ ๋‚ด์šฉ์€ [๊ธฐ๋ณธ ๊ฑฐ๋ž˜ ์ƒํƒœ](https://developers.fireblocks.com/reference/primary-transaction-statuses)๋ฅผ ์ฐธ์กฐํ•˜์„ธ์š”.." + }, + "subStatus": { + "type": "string", + "description": "๊ฑฐ๋ž˜ ํ•˜์œ„ ์ƒํƒœ ๋ชฉ๋ก์€ [๊ฑฐ๋ž˜ ํ•˜์œ„ ์ƒํƒœ](https://developers.fireblocks.com/reference/transaction-substatuses)๋ฅผ ์ฐธ์กฐํ•˜์„ธ์š”.." + }, + "txHash": { + "type": "string", + "description": "๋ธ”๋ก์ฒด์ธ์˜ ๊ฑฐ๋ž˜ ํ•ด์‹œ. * ์ด ๋งค๊ฐœ๋ณ€์ˆ˜๋Š” ๋‹ค์Œ ์กฐ๊ฑด ์ค‘ ํ•˜๋‚˜ ์ด์ƒ์ด ์ถฉ์กฑ๋˜๋Š” ๊ฒฝ์šฐ ์กด์žฌํ•ฉ๋‹ˆ๋‹ค. 1. ๊ฑฐ๋ž˜์˜ ์†Œ์Šค ์œ ํ˜•์ด `UNKNOWN`, `WHITELISTED_ADDRESS`, `NETWORK_CONNECTION`, `ONE_TIME_ADDRESS`, `FIAT_ACCOUNT` ๋˜๋Š” `GAS_STATION`์ž…๋‹ˆ๋‹ค. 2. ๊ฑฐ๋ž˜์˜ ์†Œ์Šค ์œ ํ˜•์ด `VAULT`์ด๊ณ  ์ƒํƒœ๊ฐ€ `CONFIRMING`, `COMPLETED`์ด๊ฑฐ๋‚˜ `FAILED` ๋˜๋Š” `REJECTED`๋กœ ๋ณ€๊ฒฝ๋˜๊ธฐ ์ „์— ์ด๋Ÿฌํ•œ ์ƒํƒœ ์ค‘ ํ•˜๋‚˜์˜€์Šต๋‹ˆ๋‹ค. ์–ด๋–ค ๊ฒฝ์šฐ์—๋Š” ์ƒํƒœ๊ฐ€ `BROADCASTING`์ธ ๊ฑฐ๋ž˜์—๋„ txHash๊ฐ€ ํฌํ•จ๋ฉ๋‹ˆ๋‹ค. 3. ๊ฑฐ๋ž˜์˜ ์†Œ์Šค ์œ ํ˜•์ด `EXCHANGE_ACCOUNT`์ด๊ณ  ๊ฑฐ๋ž˜์˜ ๋Œ€์ƒ ์œ ํ˜•์ด `VAULT`์ด๊ณ  ์ƒํƒœ๊ฐ€ `CONFIRMING`, `COMPLETED`์ด๊ฑฐ๋‚˜ `FAILED`๋กœ ๋ณ€๊ฒฝ๋˜๊ธฐ ์ „์— ์ด๋Ÿฌํ•œ ์ƒํƒœ ์ค‘ ํ•˜๋‚˜์˜€์Šต๋‹ˆ๋‹ค. * ๋˜ํ•œ ๋‹ค์Œ ์กฐ๊ฑด์„ ์ถฉ์กฑํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. 1. ์ž์‚ฐ์ด ์•”ํ˜ธ ์ž์‚ฐ(๋ฒ•์ •ํ™”ํ ์•„๋‹˜)์ž…๋‹ˆ๋‹ค. 2. ๊ฑฐ๋ž˜ ์ž‘์—…์ด RAW ๋˜๋Š” `TYPED_MESSAGE`๊ฐ€ ์•„๋‹™๋‹ˆ๋‹ค.." + }, + "operation": { + "$ref": "#/components/schemas/GetTransactionOperation" + }, + "note": { + "type": "string", + "description": "๋ธ”๋ก์ฒด์ธ์œผ๋กœ ์ „์†ก๋˜์ง€ ์•Š๋Š” ์‚ฌ์šฉ์ž ์ง€์ • ๋ฉ”๋ชจ๋กœ, Fireblocks ์ž‘์—… ๊ณต๊ฐ„์—์„œ์˜ ๊ฑฐ๋ž˜๋ฅผ ์„ค๋ช…ํ•ฉ๋‹ˆ๋‹ค.." + }, + "assetId": { + "type": "string", + "description": "`TRANSFER`, `MINT`, `BURN`, `ENABLE_ASSET`, `STAKE`, `UNSTAKE` ๋˜๋Š” `WITHDRAW` ์ž‘์—…์„ ์œ„ํ•ด ์ „์†กํ•  ์ž์‚ฐ์˜ ID์ž…๋‹ˆ๋‹ค. [Fireblocks์—์„œ ์ง€์›๋˜๋Š” ์ž์‚ฐ ๋ฐ ํ•ด๋‹น ID ๋ชฉ๋ก์„ ์ฐธ์กฐํ•˜์„ธ์š”.](https://developers.fireblocks.com/reference/get_supported-assets)", + "x-fb-entity": "asset" + }, + "source": { + "$ref": "#/components/schemas/SourceTransferPeerPathResponse" + }, + "sourceAddress": { + "type": "string", + "description": "๊ณ„์ • ๊ธฐ๋ฐ˜ ์ž์‚ฐ์— ํ•œํ•ด ๊ฑฐ๋ž˜์˜ ์†Œ์Šค ์ฃผ์†Œ์ž…๋‹ˆ๋‹ค. **์ฐธ๊ณ :** ์ƒํƒœ๊ฐ€ `CONFIRMING`, `COMPLETED` ๋˜๋Š” `CONFIRMING`์ธ ๊ฒฝ์šฐ, ๊ทธ ํ›„ `FAILED` ๋˜๋Š” `REJECTED`๋กœ ์ด๋™ํ•œ ๊ฒฝ์šฐ ์ด ๋งค๊ฐœ๋ณ€์ˆ˜๋Š” ์†Œ์Šค ์ฃผ์†Œ๋ฅผ ํฌํ•จํ•ฉ๋‹ˆ๋‹ค. ๋‹ค๋ฅธ ๊ฒฝ์šฐ ์ด ๋งค๊ฐœ๋ณ€์ˆ˜๋Š” ๋น„์–ด ์žˆ์Šต๋‹ˆ๋‹ค.." + }, + "tag": { + "type": "string", + "description": "XRP์˜ ์†Œ์Šค ์ฃผ์†Œ ํƒœ๊ทธ๋Š” EOS/XLM์˜ ๋ฉ”๋ชจ๋กœ ์‚ฌ์šฉ๋˜๊ฑฐ๋‚˜, ๋ฒ•์ • ํ†ตํ™” ๊ณต๊ธ‰์ž BLINC์˜ ์€ํ–‰ ์†ก๊ธˆ ์„ค๋ช…(BCB ๊ทธ๋ฃน ์ œ๊ณต)์œผ๋กœ ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค.." + }, + "destination": { + "$ref": "#/components/schemas/DestinationTransferPeerPathResponse" + }, + "destinations": { + "type": "array", + "description": "๊ฑฐ๋ž˜์˜ ๋ชฉ์ ์ง€. **์ฐธ๊ณ :** ๊ฑฐ๋ž˜๊ฐ€ ๋‹จ์ผ ๋ชฉ์ ์ง€๋กœ ์ „์†ก๋˜๋Š” ๊ฒฝ์šฐ ์ด ๋งค๊ฐœ๋ณ€์ˆ˜ ๋Œ€์‹  `destination` ๋งค๊ฐœ๋ณ€์ˆ˜๊ฐ€ ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค..", + "items": { + "$ref": "#/components/schemas/TransactionResponseDestination" + } + }, + "destinationAddress": { + "type": "string", + "description": "์ž์‚ฐ์ด ์ด์ „๋œ ์ฃผ์†Œ. ์ฐธ๊ณ : - [๋‹ค์ค‘ ๋ชฉ์ ์ง€ ๊ฑฐ๋ž˜](https://support.fireblocks.io/hc/en-us/articles/360018447980-Multi-destination-transactions)์˜ ๊ฒฝ์šฐ ์ด ๋งค๊ฐœ๋ณ€์ˆ˜๋Š” ๋น„์–ด ์žˆ์Šต๋‹ˆ๋‹ค. ์ด ๊ฒฝ์šฐ ๋ชฉ์ ์ง€ ํ•„๋“œ๋ฅผ ์ฐธ์กฐํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. - ์ƒํƒœ๊ฐ€ `ํ™•์ธ ์ค‘`, `์™„๋ฃŒ๋จ` ๋˜๋Š” `ํ™•์ธ ์ค‘`์ด์—ˆ๋‹ค๊ฐ€ `์‹คํŒจ` ๋˜๋Š” `๊ฑฐ๋ถ€๋จ`์œผ๋กœ ์ด๋™ํ•œ ๊ฒฝ์šฐ ์ด ๋งค๊ฐœ๋ณ€์ˆ˜์—๋Š” ๋ชฉ์ ์ง€ ์ฃผ์†Œ๊ฐ€ ํฌํ•จ๋ฉ๋‹ˆ๋‹ค. ๋‹ค๋ฅธ ๊ฒฝ์šฐ ์ด ๋งค๊ฐœ๋ณ€์ˆ˜๋Š” ๋น„์–ด ์žˆ์Šต๋‹ˆ๋‹ค.." + }, + "destinationAddressDescription": { + "type": "string", + "description": "์ฃผ์†Œ ์„ค๋ช…." + }, + "destinationTag": { + "type": "string", + "description": "EOS/XLM์˜ ๋ฉ”๋ชจ๋กœ ์‚ฌ์šฉ๋˜๋Š” XRP์˜ ๋Œ€์ƒ ์ฃผ์†Œ ํƒœ๊ทธ ๋˜๋Š” ๋ฒ•์ • ํ†ตํ™” ๊ณต๊ธ‰์ž BLINC์˜ ์€ํ–‰ ์†ก๊ธˆ ์„ค๋ช…(BCB ๊ทธ๋ฃน ์ œ๊ณต)." + }, + "contractCallDecodedData": { + "description": "`CONTRACT_CALL` ์ž‘์—…์— ๋Œ€ํ•œ ๋””์ฝ”๋”ฉ๋œ ๋ฐ์ดํ„ฐ์ž…๋‹ˆ๋‹ค. Fireblocks [๊ฐœ๋ฐœ ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ](https://developers.fireblocks.com/docs/ethereum-development#convenience-libraries)๋Š” ์ด ๋งค๊ฐœ๋ณ€์ˆ˜์˜ ๊ฐ’์„ ์„ค์ •ํ•˜๋Š” ๋ฐ ๊ถŒ์žฅ๋ฉ๋‹ˆ๋‹ค..", + "type": "object", + "properties": { + "contractName": { + "type": "string" + }, + "functionCalls": { + "type": "array", + "items": { + "type": "object" + } + } + } + }, + "amountInfo": { + "$ref": "#/components/schemas/AmountInfo" + }, + "treatAsGrossAmount": { + "type": "boolean", + "description": "์ด Fireblocks ์ž‘์—… ๊ณต๊ฐ„์„ ํ†ตํ•ด ์‹œ์ž‘๋œ ๊ฑฐ๋ž˜์˜ ๊ฒฝ์šฐ `true`๋กœ ์„ค์ •ํ•˜๋ฉด ์ˆ˜์ˆ˜๋ฃŒ๊ฐ€ ์š”์ฒญ๋œ ๊ธˆ์•ก์—์„œ ๊ณต์ œ๋ฉ๋‹ˆ๋‹ค. **์ฐธ๊ณ **: ์ด ๋งค๊ฐœ๋ณ€์ˆ˜๋Š” ๊ฑฐ๋ž˜ ์ž์‚ฐ์ด ETH ๋˜๋Š” MATIC๊ณผ ๊ฐ™์€ ๊ธฐ๋ณธ ์ž์‚ฐ์ธ ๊ฒฝ์šฐ์—๋งŒ ๊ณ ๋ คํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์ž์‚ฐ์„ USDC์™€ ๊ฐ™์ด ๊ฑฐ๋ž˜ ์ˆ˜์ˆ˜๋ฃŒ์— ์‚ฌ์šฉํ•  ์ˆ˜ ์—†๋Š” ๊ฒฝ์šฐ ์ด ๋งค๊ฐœ๋ณ€์ˆ˜๋Š” ๋ฌด์‹œ๋˜๊ณ  ์ˆ˜์ˆ˜๋ฃŒ๋Š” ์†Œ์Šค ๊ณ„์ •์˜ ๊ด€๋ จ ๊ธฐ๋ณธ ์ž์‚ฐ ์ง€๊ฐ‘์—์„œ ๊ณต์ œ๋ฉ๋‹ˆ๋‹ค.." + }, + "feeInfo": { + "$ref": "#/components/schemas/FeeInfo" + }, + "feeCurrency": { + "type": "string", + "description": "๊ฑฐ๋ž˜ ์ˆ˜์ˆ˜๋ฃŒ๋ฅผ ์ง€๋ถˆํ•˜๊ธฐ ์œ„ํ•ด ์ธ์ถœ๋œ ์ž์‚ฐ, ์˜ˆ๋ฅผ ๋“ค์–ด EVM ๊ธฐ๋ฐ˜ ๋ธ”๋ก์ฒด์ธ์˜ ๊ฒฝ์šฐ ETH, Tether Omni์˜ ๊ฒฝ์šฐ BTC." + }, + "networkRecords": { + "type": "array", + "description": "๋‹จ์ผ ๊ฑฐ๋ž˜๊ฐ€ ์—ฌ๋Ÿฌ ๋ฒˆ์˜ ์ด์ฒด๋กœ ์ด๋ฃจ์–ด์ง„ ๊ฒฝ์šฐ(์˜ˆ: ๊ณ„์•ฝ ํ˜ธ์ถœ์˜ ๊ฒฐ๊ณผ) ์ด ๋งค๊ฐœ๋ณ€์ˆ˜๋Š” ๋ธ”๋ก์ฒด์ธ์—์„œ ๋ฐœ์ƒํ•œ ๊ฐ ์ด์ฒด๋ฅผ ์ง€์ •ํ•ฉ๋‹ˆ๋‹ค. ๋‹จ์ผ ์ด์ฒด ๊ฑฐ๋ž˜์˜ ๊ฒฝ์šฐ ์ด ๋งค๊ฐœ๋ณ€์ˆ˜๋Š” ๋น„์–ด ์žˆ์Šต๋‹ˆ๋‹ค..", + "items": { + "$ref": "#/components/schemas/NetworkRecord" + } + }, + "createdAt": { + "type": "number", + "description": "๊ฑฐ๋ž˜ ์ƒ์„ฑ ๋‚ ์งœ ๋ฐ ์‹œ๊ฐ„(์œ ๋‹‰์Šค ํƒ€์ž„์Šคํƒฌํ”„)." + }, + "lastUpdated": { + "type": "number", + "description": "๊ฑฐ๋ž˜์˜ ๋งˆ์ง€๋ง‰ ์—…๋ฐ์ดํŠธ ๋‚ ์งœ ๋ฐ ์‹œ๊ฐ„(์œ ๋‹‰์Šค ํƒ€์ž„์Šคํƒฌํ”„)." + }, + "createdBy": { + "type": "string", + "description": "๊ฑฐ๋ž˜ ๊ฐœ์‹œ์ž์˜ ์‚ฌ์šฉ์ž ID." + }, + "signedBy": { + "type": "array", + "description": "๊ฑฐ๋ž˜ ์„œ๋ช…์ž์˜ ์‚ฌ์šฉ์ž ID.", + "items": { + "type": "string" + } + }, + "rejectedBy": { + "type": "string", + "description": "๊ฑฐ๋ž˜๋ฅผ ๊ฑฐ๋ถ€ํ•œ ์‚ฌ์šฉ์ž์˜ ์‚ฌ์šฉ์ž ID(๊ฑฐ๋ž˜๊ฐ€ ๊ฑฐ๋ถ€๋œ ๊ฒฝ์šฐ)." + }, + "authorizationInfo": { + "$ref": "#/components/schemas/AuthorizationInfo" + }, + "exchangeTxId": { + "type": "string", + "description": "๊ฑฐ๋ž˜๊ฐ€ ๊ฑฐ๋ž˜์†Œ์—์„œ ๋ฐœ์ƒํ•œ ๊ฒฝ์šฐ ์ด๋Š” ๊ฑฐ๋ž˜์†Œ์—์„œ์˜ ํ•ด๋‹น ๊ฑฐ๋ž˜์˜ ID์ž…๋‹ˆ๋‹ค.." + }, + "customerRefId": { + "type": "string", + "description": "AML ์ œ๊ณต์ž๊ฐ€ ์ž๊ธˆ ์†Œ์œ ์ž๋ฅผ ๊ฑฐ๋ž˜์™€ ์—ฐ๊ด€์‹œํ‚ค๊ธฐ ์œ„ํ•œ ID." + }, + "amlScreeningResult": { + "$ref": "#/components/schemas/AmlScreeningResult" + }, + "extraParameters": { + "$ref": "#/components/schemas/ExtraParameters" + }, + "signedMessages": { + "$ref": "#/components/schemas/SignedMessage" + }, + "numOfConfirmations": { + "type": "number", + "description": "๊ฑฐ๋ž˜ ํ™•์ธ ํšŸ์ˆ˜์ž…๋‹ˆ๋‹ค. ํ™•์ธ ์ •์ฑ…์— ๋”ฐ๋ผ ๊ฑฐ๋ž˜๊ฐ€ ์™„๋ฃŒ๋œ ๊ฒƒ์œผ๋กœ ๊ฐ„์ฃผ๋  ๋•Œ๊นŒ์ง€ ์ˆซ์ž๊ฐ€ ์ฆ๊ฐ€ํ•ฉ๋‹ˆ๋‹ค.." + }, + "blockInfo": { + "$ref": "#/components/schemas/BlockInfo" + }, + "index": { + "type": "number", + "description": "UTXO ๊ธฐ๋ฐ˜ ์ž์‚ฐ์˜ ๊ฒฝ์šฐ ์ด๋Š” vOut์ด๊ณ , Ethereum ๊ธฐ๋ฐ˜ ์ž์‚ฐ์˜ ๊ฒฝ์šฐ ์ด๋Š” ๊ณ„์•ฝ ํ˜ธ์ถœ ์ด๋ฒคํŠธ์˜ ์ธ๋ฑ์Šค์ž…๋‹ˆ๋‹ค. **์ฐธ๊ณ :** ํŠธ๋žœ์žญ์…˜์ด ๋‘ ๊ฐœ ์ด์ƒ์˜ ๊ฐ’์„ ๊ฐ–๋Š” `destinations` ๊ฐ์ฒด๋ฅผ ์‚ฌ์šฉํ•˜๋Š” ๊ฒฝ์šฐ ์ด ํ•„๋“œ๋Š” ๋ฐ˜ํ™˜๋˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค.." + }, + "rewardInfo": { + "$ref": "#/components/schemas/RewardInfo" + }, + "systemMessages": { + "$ref": "#/components/schemas/SystemMessageInfo" + }, + "addressType": { + "oneOf": [ + { + "const": "WHITELISTED" + }, + { + "const": "ONE_TIME" + } + ] + }, + "requestedAmount": { + "description": "์‚ฌ์šฉ์ž๊ฐ€ ์š”์ฒญํ•œ ๊ธˆ์•ก์ž…๋‹ˆ๋‹ค. ๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ - ์ •ํ™•์„ฑ์„ ์œ„ํ•ด `amountInfo` ํ•„๋“œ๋ฅผ ์‚ฌ์šฉํ•˜์„ธ์š”..", + "type": "number", + "deprecated": true + }, + "amount": { + "description": "์ด์ฒด๊ฐ€ ๊ฑฐ๋ž˜์†Œ์—์„œ ์ธ์ถœํ•˜๋Š” ๊ฒฝ์šฐ, ์ด์ฒด ์š”์ฒญ๋œ ์‹ค์ œ ๊ธˆ์•ก์ž…๋‹ˆ๋‹ค. ๊ทธ๋ ‡์ง€ ์•Š์€ ๊ฒฝ์šฐ, ์š”์ฒญ๋œ ๊ธˆ์•ก์ž…๋‹ˆ๋‹ค. ๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ - ์ •ํ™•์„ฑ์„ ์œ„ํ•ด `amountInfo` ํ•„๋“œ๋ฅผ ์‚ฌ์šฉํ•˜์„ธ์š”..", + "type": "number", + "deprecated": true + }, + "netAmount": { + "description": "์ˆ˜์ˆ˜๋ฃŒ ๊ณต์ œ ํ›„ ๊ฑฐ๋ž˜์˜ ์ˆœ ๊ธˆ์•ก์ž…๋‹ˆ๋‹ค. ๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ - ์ •ํ™•์„ฑ์„ ์œ„ํ•ด `amountInfo` ํ•„๋“œ๋ฅผ ์‚ฌ์šฉํ•˜์„ธ์š”..", + "type": "number", + "deprecated": true + }, + "amountUSD": { + "oneOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "description": "์š”์ฒญ๋œ ๊ธˆ์•ก์˜ USD ๊ฐ’์ž…๋‹ˆ๋‹ค. ๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ - ์ •ํ™•์„ฑ์„ ์œ„ํ•ด `amountInfo` ํ•„๋“œ๋ฅผ ์‚ฌ์šฉํ•˜์„ธ์š”.." + }, + "serviceFee": { + "description": "์‹ค์ œ ์š”์ฒญ ๊ธˆ์•ก์—์„œ ๊ฑฐ๋ž˜์†Œ๊ฐ€ ๊ณต์ œํ•˜๋Š” ์ด ์ˆ˜์ˆ˜๋ฃŒ(`serviceFee` = `amount` - `netAmount`). ๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ - ์ •ํ™•์„ฑ์„ ์œ„ํ•ด `feeInfo` ํ•„๋“œ๋ฅผ ์‚ฌ์šฉํ•˜์„ธ์š”.", + "type": "number", + "deprecated": true + }, + "fee": { + "description": "๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ - ์ •ํ™•์„ฑ์„ ์œ„ํ•ด `feeInfo` ํ•„๋“œ๋ฅผ ์‚ฌ์šฉํ•˜์„ธ์š”.", + "type": "number", + "deprecated": true + }, + "networkFee": { + "description": "๋„คํŠธ์›Œํฌ์— ์ง€๋ถˆ๋œ ์ˆ˜์ˆ˜๋ฃŒ์ž…๋‹ˆ๋‹ค. ๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ - ์ •ํ™•์„ฑ์„ ์œ„ํ•ด `feeInfo` ํ•„๋“œ๋ฅผ ์‚ฌ์šฉํ•˜์„ธ์š”..", + "type": "number", + "deprecated": true + } + } + }, + "TransactionResponseDestination": { + "type": "object", + "properties": { + "destination": { + "$ref": "#/components/schemas/DestinationTransferPeerPathResponse" + }, + "destinationAddress": { + "description": "์ž์‚ฐ์ด ์ด์ „๋œ ์ฃผ์†Œ." + }, + "destinationAddressDescription": { + "description": "์ฃผ์†Œ ์„ค๋ช…." + }, + "amount": { + "type": "string", + "description": "์ด ๋ชฉ์ ์ง€๋กœ ๋ณด๋‚ผ ๊ธˆ์•ก." + }, + "amountUSD": { + "type": "string", + "description": "์š”์ฒญํ•˜์‹  ๊ธˆ์•ก์˜ USD ๊ฐ€์น˜." + }, + "amlScreeningResult": { + "$ref": "#/components/schemas/AmlScreeningResult" + }, + "customerRefId": { + "description": "AML ์ œ๊ณต์ž๊ฐ€ ์ž๊ธˆ ์†Œ์œ ์ž๋ฅผ ๊ฑฐ๋ž˜์™€ ์—ฐ๊ด€์‹œํ‚ค๊ธฐ ์œ„ํ•œ ID." + }, + "authorizationInfo": { + "$ref": "#/components/schemas/AuthorizationInfo" + } + } + }, + "NetworkRecord": { + "type": "object", + "properties": { + "source": { + "$ref": "#/components/schemas/SourceTransferPeerPathResponse" + }, + "destination": { + "$ref": "#/components/schemas/DestinationTransferPeerPathResponse" + }, + "txHash": { + "type": "string" + }, + "networkFee": { + "type": "string" + }, + "assetId": { + "type": "string", + "x-fb-entity": "asset" + }, + "netAmount": { + "description": "์ˆ˜์ˆ˜๋ฃŒ๋ฅผ ๊ณต์ œํ•œ ํ›„์˜ ๊ฑฐ๋ž˜ ์ˆœ์•ก", + "type": "string" + }, + "isDropped": { + "type": "boolean" + }, + "type": { + "type": "string" + }, + "destinationAddress": { + "type": "string" + }, + "sourceAddress": { + "type": "string" + }, + "amountUSD": { + "type": "string" + }, + "index": { + "type": "number" + }, + "rewardInfo": { + "$ref": "#/components/schemas/RewardInfo" + } + } + }, + "AssetTypeResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "type": { + "oneOf": [ + { + "const": "ALGO_ASSET" + }, + { + "const": "BASE_ASSET" + }, + { + "const": "BEP20" + }, + { + "const": "COMPOUND" + }, + { + "const": "ERC20" + }, + { + "const": "FIAT" + }, + { + "const": "SOL_ASSET" + }, + { + "const": "TRON_TRC20" + }, + { + "const": "XLM_ASSET" + }, + { + "const": "XDB_ASSET" + } + ] + }, + "contractAddress": { + "type": "string" + }, + "nativeAsset": { + "type": "string" + }, + "decimals": { + "type": "number" + } + }, + "required": [ + "id", + "name", + "type" + ] + }, + "NetworkConnection": { + "type": "object", + "properties": { + "localNetworkId": { + "type": "string", + "description": "์—ฐ๊ฒฐ์„ ์ƒ์„ฑํ•˜๋ ค๋Š” ํ”„๋กœํ•„์˜ ๋„คํŠธ์›Œํฌ ID." + }, + "remoteNetworkId": { + "type": "string", + "description": "ํ”„๋กœํ•„์ด ์—ฐ๊ฒฐํ•˜๋ ค๊ณ  ํ•˜๋Š” ๋„คํŠธ์›Œํฌ ID." + }, + "routingPolicy": { + "$ref": "#/components/schemas/NetworkConnectionRoutingPolicy" + } + }, + "required": [ + "localNetworkId", + "remoteNetworkId" + ] + }, + "NetworkConnectionResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "localChannel": { + "deprecated": true, + "description": "๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ - `localNetworkId`๋กœ ๋Œ€์ฒด๋จ", + "type": "object", + "properties": { + "networkId": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "remoteChannel": { + "deprecated": true, + "description": "๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ - `remoteNetworkId`๋กœ ๋Œ€์ฒด๋จ", + "type": "object", + "properties": { + "networkId": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "status": { + "$ref": "#/components/schemas/ConfigChangeRequestStatus" + }, + "localNetworkId": { + "$ref": "#/components/schemas/NetworkId" + }, + "remoteNetworkId": { + "$ref": "#/components/schemas/NetworkId" + }, + "routingPolicy": { + "$ref": "#/components/schemas/NetworkConnectionRoutingPolicy" + } + }, + "required": [ + "id", + "localNetworkId", + "remoteNetworkId", + "routingPolicy", + "status" + ] + }, + "EstimatedTransactionFeeResponse": { + "type": "object", + "properties": { + "low": { + "$ref": "#/components/schemas/TransactionFee" + }, + "medium": { + "$ref": "#/components/schemas/TransactionFee" + }, + "high": { + "$ref": "#/components/schemas/TransactionFee" + } + }, + "required": [ + "low", + "medium", + "high" + ] + }, + "EstimatedNetworkFeeResponse": { + "type": "object", + "properties": { + "low": { + "$ref": "#/components/schemas/NetworkFee" + }, + "medium": { + "$ref": "#/components/schemas/NetworkFee" + }, + "high": { + "$ref": "#/components/schemas/NetworkFee" + } + }, + "required": [ + "low", + "medium", + "high" + ] + }, + "GasStationPropertiesResponse": { + "type": "object", + "properties": { + "balance": { + "type": "object" + }, + "configuration": { + "$ref": "#/components/schemas/GasStationConfiguration" + } + }, + "required": [ + "low", + "medium", + "high" + ] + }, + "TransactionFee": { + "type": "object", + "properties": { + "feePerByte": { + "type": "string" + }, + "gasPrice": { + "type": "string" + }, + "gasLimit": { + "type": "string" + }, + "networkFee": { + "type": "string" + }, + "baseFee": { + "description": "(์„ ํƒ) EIP-1559์— ๋”ฐ๋ฅธ ๊ธฐ๋ณธ ์ˆ˜์ˆ˜๋ฃŒ(ETH ์ž์‚ฐ)", + "type": "string" + }, + "priorityFee": { + "description": "(์„ ํƒ) EIP-1559์— ๋”ฐ๋ฅธ ์šฐ์„  ์ˆ˜์ˆ˜๋ฃŒ(ETH ์ž์‚ฐ)", + "type": "string" + } + } + }, + "NetworkFee": { + "type": "object", + "properties": { + "feePerByte": { + "type": "string" + }, + "gasPrice": { + "type": "string" + }, + "networkFee": { + "type": "string" + }, + "baseFee": { + "description": "(์„ ํƒ) EIP-1559์— ๋”ฐ๋ฅธ ๊ธฐ๋ณธ ์ˆ˜์ˆ˜๋ฃŒ(ETH ์ž์‚ฐ)", + "type": "string" + }, + "priorityFee": { + "description": "(์„ ํƒ) EIP-1559์— ๋”ฐ๋ฅธ ์šฐ์„  ์ˆ˜์ˆ˜๋ฃŒ(ETH ์ž์‚ฐ)", + "type": "string" + } + } + }, + "GasStationConfiguration": { + "type": "object", + "properties": { + "gasThreshold": { + "type": "string" + }, + "gasCap": { + "type": "string" + }, + "maxGasPrice": { + "type": "string" + } + } + }, + "NetworkChannel": { + "deprecated": true, + "description": "์œ ์ผํ•˜๊ฒŒ ์‚ฌ์šฉ๋œ ์ฐธ์กฐ์—์„œ ๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ - NetworkConnectionResponse", + "type": "object", + "properties": { + "networkId": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "NetworkId": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "name" + ] + }, + "NetworkIdResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "routingPolicy": { + "$ref": "#/components/schemas/NetworkIdRoutingPolicy" + }, + "isDiscoverable": { + "type": "boolean", + "description": "ํŠน์ • ๋„คํŠธ์›Œํฌ๋ฅผ ๊ฒ€์ƒ‰ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค." + } + } + }, + "TransactionRequest": { + "type": "object", + "properties": { + "operation": { + "$ref": "#/components/schemas/TransactionOperation" + }, + "note": { + "type": "string", + "description": "Fireblocks ์ž‘์—… ๊ณต๊ฐ„์—์„œ ๊ฑฐ๋ž˜๋ฅผ ์„ค๋ช…ํ•˜๋Š” ๋ธ”๋ก์ฒด์ธ์œผ๋กœ ์ „์†ก๋˜์ง€ ์•Š๋Š” ์‚ฌ์šฉ์ž ์ง€์ • ๋ฉ”๋ชจ.", + "example": "Ticket 123" + }, + "externalTxId": { + "type": "string", + "description": "์„ ํƒ ์‚ฌํ•ญ์ด์ง€๋งŒ ๊ฐ•๋ ฅํžˆ ๊ถŒ์žฅํ•˜๋Š” ๋งค๊ฐœ๋ณ€์ˆ˜์ž…๋‹ˆ๋‹ค. Fireblocks๋Š” ๋™์ผํ•œ ID๋ฅผ ๊ฐ€์ง„ ํ–ฅํ›„ ๊ฑฐ๋ž˜๋ฅผ ๊ฑฐ๋ถ€ํ•ฉ๋‹ˆ๋‹ค. ๋™์ผํ•œ ๊ฑฐ๋ž˜๋ฅผ ๋‘ ๋ฒˆ ์ œ์ถœํ•˜์ง€ ์•Š์œผ๋ ค๋ฉด ๊ฑฐ๋ž˜๋ฅผ ๋‚˜ํƒ€๋‚ด๋Š” ๊ณ ์œ  ID๋กœ ์„ค์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ์ด๋Š” ์ธํ„ฐ๋„ท ์ค‘๋‹จ์œผ๋กœ ์ธํ•ด ๊ฑฐ๋ž˜ ์ œ์ถœ ์‹œ ์˜ค๋ฅ˜ ์ฝ”๋“œ๊ฐ€ ํ‘œ์‹œ๋˜์ง€๋งŒ ์‹ค์ œ๋กœ ๊ฑฐ๋ž˜๊ฐ€ ์ „์†ก๋˜๊ณ  ์ฒ˜๋ฆฌ๋œ ๊ฒฝ์šฐ์— ๋„์›€์ด ๋ฉ๋‹ˆ๋‹ค. ๊ฑฐ๋ž˜๊ฐ€ ์ฒ˜๋ฆฌ๋˜์—ˆ๋Š”์ง€ ํ™•์ธํ•˜๋ ค๋ฉด [์™ธ๋ถ€ ๊ฑฐ๋ž˜ ID๋กœ ํŠน์ • ๊ฑฐ๋ž˜ ์ฐพ๊ธฐ](https://developers.fireblocks.com/reference/get_transactions-external-tx-id-externaltxid). ์ด ๋งค๊ฐœ๋ณ€์ˆ˜์— ๋Œ€ํ•œ ํŠน์ • ํ˜•์‹์€ ํ•„์š”ํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค..", + "example": "00000000-0000-0000-0000-000000000000" + }, + "assetId": { + "type": "string", + "description": "`TRANSFER`, `MINT` ๋˜๋Š” `BURN` ์ž‘์—…์„ ์œ„ํ•ด ์ „์†กํ•  ์ž์‚ฐ์˜ ID์ž…๋‹ˆ๋‹ค. [Fireblocks์—์„œ ์ง€์›๋˜๋Š” ์ž์‚ฐ ๋ฐ ํ•ด๋‹น ID ๋ชฉ๋ก์„ ์ฐธ์กฐํ•˜์„ธ์š”.](https://developers.fireblocks.com/reference/get_supported-assets)", + "x-fb-entity": "asset", + "example": "ETH" + }, + "source": { + "$ref": "#/components/schemas/TransferPeerPath" + }, + "destination": { + "$ref": "#/components/schemas/DestinationTransferPeerPath" + }, + "destinations": { + "type": "array", + "description": "UTXO ๊ธฐ๋ฐ˜ ๋ธ”๋ก์ฒด์ธ์˜ ๊ฒฝ์šฐ ๋‹จ์ผ ๊ฑฐ๋ž˜๋ฅผ ์—ฌ๋Ÿฌ ๋ชฉ์ ์ง€๋กœ ๋ณด๋‚ผ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค..", + "items": { + "$ref": "#/components/schemas/TransactionRequestDestination" + } + }, + "amount": { + "oneOf": [ + { + "type": "string", + "description": "์ˆซ์žํ˜• ๋ฌธ์ž์—ด(๊ถŒ์žฅ)", + "example": "0.02" + }, + { + "type": "number", + "description": "์ˆซ์ž (๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ)", + "example": 0.02 + } + ], + "description": "`TRANSFER` ์ž‘์—…์˜ ๊ฒฝ์šฐ, ์ž์‚ฐ ๋‹จ์œ„๋กœ ์ „์†ก ์š”์ฒญ ๊ธˆ์•ก์ž…๋‹ˆ๋‹ค. Fireblocks๋Š” ์ •ํ™•ํ•œ ์ •๋ฐ€๋„๋ฅผ ์œ„ํ•ด ์ˆซ์ž ๋ฌธ์ž์—ด์„ ์‚ฌ์šฉํ•˜๋Š” ๊ฒƒ์ด ์ข‹์Šต๋‹ˆ๋‹ค. ์ˆซ์ž ์ž…๋ ฅ์ด ์žˆ์ง€๋งŒ ๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค.." + }, + "treatAsGrossAmount": { + "type": "boolean", + "description": ""`true`๋กœ ์„ค์ •ํ•˜๋ฉด ์ˆ˜์ˆ˜๋ฃŒ๊ฐ€ ์š”์ฒญ๋œ ๊ธˆ์•ก์—์„œ ๊ณต์ œ๋ฉ๋‹ˆ๋‹ค." **์ฐธ๊ณ **: ์ด ๋งค๊ฐœ๋ณ€์ˆ˜๋Š” ๊ฑฐ๋ž˜ ์ž์‚ฐ์ด ETH ๋˜๋Š” MATIC๊ณผ ๊ฐ™์€ ๊ธฐ๋ณธ ์ž์‚ฐ์ธ ๊ฒฝ์šฐ์—๋งŒ ๊ณ ๋ คํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์ž์‚ฐ์„ USDC์™€ ๊ฐ™์ด ๊ฑฐ๋ž˜ ์ˆ˜์ˆ˜๋ฃŒ์— ์‚ฌ์šฉํ•  ์ˆ˜ ์—†๋Š” ๊ฒฝ์šฐ ์ด ๋งค๊ฐœ๋ณ€์ˆ˜๋Š” ๋ฌด์‹œ๋˜๊ณ  ์ˆ˜์ˆ˜๋ฃŒ๋Š” ์†Œ์Šค ๊ณ„์ •์˜ ๊ด€๋ จ ๊ธฐ๋ณธ ์ž์‚ฐ ์ง€๊ฐ‘์—์„œ ๊ณต์ œ๋ฉ๋‹ˆ๋‹ค..", + "example": false + }, + "forceSweep": { + "type": "boolean", + "description": "Polkadot, Kusama ๋ฐ Westend ๊ฑฐ๋ž˜์—๋งŒ ํ•ด๋‹น๋ฉ๋‹ˆ๋‹ค. true๋กœ ์„ค์ •ํ•˜๋ฉด Fireblocks๊ฐ€ ์ž์‚ฐ ์ง€๊ฐ‘์„ ๋น„์›๋‹ˆ๋‹ค. **์ฐธ๊ณ :** ์†Œ์Šค ๊ณ„์ •์ด ์ •ํ™•ํžˆ 1 DOT์ผ ๋•Œ true๋กœ ์„ค์ •ํ•˜๋ฉด ๊ฑฐ๋ž˜๊ฐ€ ์‹คํŒจํ•ฉ๋‹ˆ๋‹ค. 1 DOT๋ณด๋‹ค ๋งŽ๊ฑฐ๋‚˜ ์ ์€ ๊ธˆ์•ก์€ ์„ฑ๊ณตํ•ฉ๋‹ˆ๋‹ค. ์ด๋Š” Polkadot ๋ธ”๋ก์ฒด์ธ ์ œํ•œ ์‚ฌํ•ญ์ž…๋‹ˆ๋‹ค..", + "example": false + }, + "feeLevel": { + "oneOf": [ + { + "const": "LOW" + }, + { + "const": "MEDIUM" + }, + { + "const": "HIGH" + } + ], + "description": "UTXO ๋˜๋Š” EVM ๊ธฐ๋ฐ˜ ๋ธ”๋ก์ฒด์ธ์—๋งŒ ํ•ด๋‹น. ๊ฑฐ๋ž˜์— ๋Œ€ํ•ด ์ง€๋ถˆ๋˜๋Š” ๋ธ”๋ก์ฒด์ธ ์ˆ˜์ˆ˜๋ฃŒ ์ˆ˜์ค€์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค. ๋˜๋Š” ํŠน์ • ์ˆ˜์ˆ˜๋ฃŒ ์ถ”์ • ๋งค๊ฐœ๋ณ€์ˆ˜๊ฐ€ ์•„๋ž˜์— ์žˆ์Šต๋‹ˆ๋‹ค..", + "example": "MEDIUM" + }, + "fee": { + "oneOf": [ + { + "type": "string", + "description": "์ˆซ์žํ˜• ๋ฌธ์ž์—ด(๊ถŒ์žฅ)" + }, + { + "type": "number", + "description": "์ˆซ์ž (๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ)" + } + ], + "description": "UTXO ๊ธฐ๋ฐ˜ ๋ธ”๋ก์ฒด์ธ์˜ ๊ฒฝ์šฐ ์ž์‚ฐ์˜ ๊ฐ€์žฅ ์ž‘์€ ๋‹จ์œ„(์‚ฌํ† ์‹œ, ๋ผํ† ์‹œ ๋“ฑ)์˜ ๋ฐ”์ดํŠธ๋‹น ์ˆ˜์ˆ˜๋ฃŒ์ž…๋‹ˆ๋‹ค. Ripple์˜ ๊ฒฝ์šฐ ๊ฑฐ๋ž˜ ์ˆ˜์ˆ˜๋ฃŒ์ž…๋‹ˆ๋‹ค. Fireblocks๋Š” ์ •ํ™•ํ•œ ์ •๋ฐ€๋„๋ฅผ ์œ„ํ•ด ์ˆซ์ž ๋ฌธ์ž์—ด์„ ์‚ฌ์šฉํ•˜๋Š” ๊ฒƒ์ด ์ข‹์Šต๋‹ˆ๋‹ค. ์ˆซ์ž ์ž…๋ ฅ์ด ์žˆ์ง€๋งŒ ๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค.." + }, + "priorityFee": { + "oneOf": [ + { + "type": "string", + "description": "์ˆซ์žํ˜• ๋ฌธ์ž์—ด(๊ถŒ์žฅ)", + "example": "2" + }, + { + "type": "number", + "description": "์ˆซ์ž (๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ)", + "example": 2 + } + ], + "description": "์ด๋”๋ฆฌ์›€ ๊ธฐ๋ฐ˜ ๋ธ”๋ก์ฒด์ธ์— ํ•œํ•ด EIP-1559 ๊ฑฐ๋ž˜ ๊ฐ€๊ฒฉ ์ฑ…์ • ๋ฉ”์ปค๋‹ˆ์ฆ˜์˜ ์ˆ˜์ˆ˜๋ฃŒ์ž…๋‹ˆ๋‹ค. ๊ฐ’์€ Gwei์ž…๋‹ˆ๋‹ค. Fireblocks๋Š” ์ •ํ™•ํ•œ ์ •๋ฐ€๋„๋ฅผ ์œ„ํ•ด ์ˆซ์ž ๋ฌธ์ž์—ด์„ ์‚ฌ์šฉํ•  ๊ฒƒ์„ ๊ถŒ์žฅํ•ฉ๋‹ˆ๋‹ค. ์ˆซ์ž ์ž…๋ ฅ์ด ์žˆ์ง€๋งŒ ๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค.." + }, + "failOnLowFee": { + "type": "boolean", + "description": "`true`๋กœ ์„ค์ •ํ•˜๋ฉด ํ˜„์žฌ `MEDIUM` ์ˆ˜์ˆ˜๋ฃŒ ์ˆ˜์ค€์ด ๊ฑฐ๋ž˜์— ์ง€์ •๋œ ์ˆ˜์ค€๋ณด๋‹ค ๋†’์„ ๊ฒฝ์šฐ ๊ฑฐ๋ž˜๊ฐ€ ์‹คํŒจํ•˜์—ฌ ํ™•์ธ ์—†์ด ์ค‘๋‹จ๋˜๋Š” ์ƒํ™ฉ์„ ํ”ผํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.." + }, + "maxFee": { + "description": "๊ฑฐ๋ž˜์— ๋Œ€ํ•ด ์ง€๋ถˆํ•ด์•ผ ํ•˜๋Š” ์ตœ๋Œ€ ์ˆ˜์ˆ˜๋ฃŒ(๊ฐ€์Šค ๊ฐ€๊ฒฉ ๋˜๋Š” ๋ฐ”์ดํŠธ๋‹น ์ˆ˜์ˆ˜๋ฃŒ). ์š”์ฒญ๋œ `feeLevel`์˜ ํ˜„์žฌ ๊ฐ’์ด ์ด ์š”์ฒญ๋œ ์ตœ๋Œ€ ์ˆ˜์ˆ˜๋ฃŒ๋ณด๋‹ค ๋†’์€ ๊ฒฝ์šฐ. ์ •ํ™•ํ•œ ์ •๋ฐ€๋„๋ฅผ ์œ„ํ•ด ์ˆซ์ž ๋ฌธ์ž์—ด๋กœ ํ‘œํ˜„.", + "type": "string", + "example": "120" + }, + "gasLimit": { + "oneOf": [ + { + "type": "string", + "description": "์ˆซ์žํ˜• ๋ฌธ์ž์—ด(๊ถŒ์žฅ)", + "example": "21000" + }, + { + "type": "number", + "description": "์ˆซ์ž (๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ)", + "example": 21000 + } + ], + "description": "EVM ๊ธฐ๋ฐ˜ ๋ธ”๋ก์ฒด์ธ์—๋งŒ ํ•ด๋‹น. ํŠธ๋žœ์žญ์…˜์„ ์ฒ˜๋ฆฌํ•˜๋Š” ๋ฐ ํ•„์š”ํ•œ ๊ฐ€์Šค ๋‹จ์œ„. ์ฐธ๊ณ : ๋‹จ์ผ ํŠธ๋žœ์žญ์…˜์—์„œ ์„ธ ๊ฐ€์ง€ ์ธ์ˆ˜ ์ค‘ ๋‘ ๊ฐ€์ง€๋งŒ ์ง€์ •ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. `gasLimit`, `gasPrice` ๋ฐ `networkFee`. Fireblocks๋Š” ์ •ํ™•ํ•œ ์ •๋ฐ€๋„๋ฅผ ์œ„ํ•ด ์ˆซ์ž ๋ฌธ์ž์—ด์„ ์‚ฌ์šฉํ•˜๋Š” ๊ฒƒ์ด ์ข‹์Šต๋‹ˆ๋‹ค. ์ˆซ์ž ์ž…๋ ฅ์ด ์žˆ์ง€๋งŒ ๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค.." + }, + "gasPrice": { + "oneOf": [ + { + "type": "string", + "description": "์ˆซ์žํ˜• ๋ฌธ์ž์—ด(๊ถŒ์žฅ)" + }, + { + "type": "number", + "description": "์ˆซ์ž (๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ)" + } + ], + "description": "EIP-1559๊ฐ€ ์•„๋‹Œ EVM ๊ธฐ๋ฐ˜ ๊ฑฐ๋ž˜์˜ ๊ฒฝ์šฐ ๊ฐ€์Šค ๋‹จ์œ„๋‹น ๊ฐ€๊ฒฉ(Ethereum์—์„œ๋Š” Gwei๋กœ ์ง€์ •). ์ฐธ๊ณ : ๋‹จ์ผ ๊ฑฐ๋ž˜์—์„œ ์„ธ ๊ฐ€์ง€ ์ธ์ˆ˜ ์ค‘ ๋‘ ๊ฐ€์ง€๋งŒ ์ง€์ •ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. `gasLimit`, `gasPrice` ๋ฐ `networkFee`. Fireblocks๋Š” ์ •ํ™•ํ•œ ์ •๋ฐ€๋„๋ฅผ ์œ„ํ•ด ์ˆซ์ž ๋ฌธ์ž์—ด์„ ์‚ฌ์šฉํ•˜๋Š” ๊ฒƒ์ด ์ข‹์Šต๋‹ˆ๋‹ค. ์ˆซ์ž ์ž…๋ ฅ์ด ์žˆ์ง€๋งŒ ๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค.." + }, + "networkFee": { + "oneOf": [ + { + "type": "string", + "description": "์ˆซ์žํ˜• ๋ฌธ์ž์—ด(๊ถŒ์žฅ)" + }, + { + "type": "number", + "description": "์ˆซ์ž (๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ)" + } + ], + "description": "EVM ๊ธฐ๋ฐ˜ ๋ธ”๋ก์ฒด์ธ์—๋งŒ ํ•ด๋‹น. ๋ธ”๋ก์ฒด์ธ์˜ ๊ฐ€์žฅ ํฐ ๋‹จ์œ„๋กœ ์ด ๊ฑฐ๋ž˜ ์ˆ˜์ˆ˜๋ฃŒ. ์ฐธ๊ณ : ์„ธ ๊ฐ€์ง€ ์ธ์ˆ˜ ์ค‘ ๋‘ ๊ฐ€์ง€๋งŒ ๋‹จ์ผ ๊ฑฐ๋ž˜์—์„œ ์ง€์ •ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. `gasLimit`, `gasPrice` ๋ฐ `networkFee`. Fireblocks๋Š” ์ •ํ™•ํ•œ ์ •๋ฐ€๋„๋ฅผ ์œ„ํ•ด ์ˆซ์ž ๋ฌธ์ž์—ด์„ ์‚ฌ์šฉํ•˜๋Š” ๊ฒƒ์ด ์ข‹์Šต๋‹ˆ๋‹ค. ์ˆซ์ž ์ž…๋ ฅ์ด ์žˆ์ง€๋งŒ ๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค. - ๊ฑฐ๋ž˜ ๋ธ”๋ก์ฒด์ธ ์ˆ˜์ˆ˜๋ฃŒ. - Ethereum์˜ ๊ฒฝ์šฐ gasPrice, gasLimit ๋ฐ networkFee๋ฅผ ๋ชจ๋‘ ํ•จ๊ป˜ ์ „๋‹ฌํ•  ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค. - ์ˆซ์ž ๊ฐ’ ํ‘œํ˜„์ด ํ•„์š”ํ•ฉ๋‹ˆ๋‹ค.." + }, + "replaceTxByHash": { + "type": "string", + "description": "EVM ๊ธฐ๋ฐ˜ ๋ธ”๋ก์ฒด์ธ์—๋งŒ ํ•ด๋‹นํ•ฉ๋‹ˆ๋‹ค. ๊ฑฐ๋ž˜๊ฐ€ ์ค‘๋‹จ๋œ ๊ฒฝ์šฐ ์ค‘๋‹จ๋œ ๊ฑฐ๋ž˜์˜ ํ•ด์‹œ๋ฅผ ์ง€์ •ํ•˜์—ฌ ์ˆ˜์ˆ˜๋ฃŒ๊ฐ€ ๋” ๋†’์€ ์ด ๊ฑฐ๋ž˜๋กœ ๋Œ€์ฒดํ•˜๊ฑฐ๋‚˜ ์ˆ˜์ˆ˜๋ฃŒ๊ฐ€ 0์ธ ์ด ๊ฑฐ๋ž˜๋กœ ๋Œ€์ฒดํ•˜์—ฌ ๋ธ”๋ก์ฒด์ธ์—์„œ ์‚ญ์ œํ•ฉ๋‹ˆ๋‹ค..", + "example": "00000000-0000-0000-0000-000000000000" + }, + "extraParameters": { + "$ref": "#/components/schemas/ExtraParameters" + }, + "customerRefId": { + "type": "string", + "description": "AML ์ œ๊ณต์ž๊ฐ€ ์ž๊ธˆ ์†Œ์œ ์ž๋ฅผ ๊ฑฐ๋ž˜์™€ ์—ฐ๊ด€์‹œํ‚ค๊ธฐ ์œ„ํ•œ ID.", + "example": "abcdef" + }, + "autoStaking": { + "type": "boolean", + "description": "์ด ๊ธฐ๋Šฅ์€ ๋” ์ด์ƒ ์ง€์›๋˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค..", + "deprecated": true + }, + "networkStaking": { + "oneOf": [ + { + "type": "string", + "description": "์ˆซ์žํ˜• ๋ฌธ์ž์—ด(๊ถŒ์žฅ)" + }, + { + "type": "number", + "description": "์ˆซ์ž (๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ)" + } + ], + "description": "์ด ๊ธฐ๋Šฅ์€ ๋” ์ด์ƒ ์ง€์›๋˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค.." + }, + "cpuStaking": { + "oneOf": [ + { + "type": "string", + "description": "์ˆซ์žํ˜• ๋ฌธ์ž์—ด(๊ถŒ์žฅ)" + }, + { + "type": "number", + "description": "์ˆซ์ž (๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ)" + } + ], + "description": "์ด ๊ธฐ๋Šฅ์€ ๋” ์ด์ƒ ์ง€์›๋˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค.." + } + } + }, + "TransactionRequestDestination": { + "type": "object", + "properties": { + "amount": { + "type": "string" + }, + "destination": { + "$ref": "#/components/schemas/DestinationTransferPeerPath" + } + } + }, + "ExchangeType": { + "oneOf": [ + { + "const": "BINANCE" + }, + { + "const": "BINANCEUS" + }, + { + "const": "BITFINEX" + }, + { + "const": "BITHUMB" + }, + { + "const": "BITMEX" + }, + { + "const": "BITSO" + }, + { + "const": "BITSTAMP" + }, + { + "const": "BITTREX" + }, + { + "const": "CIRCLE" + }, + { + "const": "COINBASEPRO" + }, + { + "const": "COINMETRO" + }, + { + "const": "COINSPRO" + }, + { + "const": "CRYPTOCOM" + }, + { + "const": "DERIBIT" + }, + { + "const": "FTX" + }, + { + "const": "FIXUS" + }, + { + "const": "GEMINI" + }, + { + "const": "HITBTC" + }, + { + "const": "HUOBI" + }, + { + "const": "KORBIT" + }, + { + "const": "KRAKEN" + }, + { + "const": "LIQUID" + }, + { + "const": "POLONIEX" + }, + { + "const": "OKCOIN" + }, + { + "const": "OKEX" + }, + { + "const": "SEEDCX" + } + ] + }, + "FiatAccountType": { + "const": "BLINC" + }, + "ConfigChangeRequestStatus": { + "oneOf": [ + { + "const": "WAITING_FOR_APPROVAL" + }, + { + "const": "APPROVED" + }, + { + "const": "CANCELLED" + }, + { + "const": "REJECTED" + }, + { + "const": "FAILED" + } + ] + }, + "TransactionOperation": { + "oneOf": [ + { + "const": "TRANSFER" + }, + { + "const": "BURN" + }, + { + "const": "CONTRACT_CALL" + }, + { + "const": "MINT" + }, + { + "const": "RAW" + }, + { + "const": "TYPED_MESSAGE" + } + ], + "description": "* `TRANSFER` - ์ž‘์—…์˜ ๊ธฐ๋ณธ๊ฐ’์ž…๋‹ˆ๋‹ค. ํ•œ ๊ณ„์ •์—์„œ ๋‹ค๋ฅธ ๊ณ„์ •์œผ๋กœ ์ž๊ธˆ์„ ์ด์ฒดํ•ฉ๋‹ˆ๋‹ค. UTXO ๋ธ”๋ก์ฒด์ธ์€ ๋‹ค์ค‘ ์ž…๋ ฅ ๋ฐ ๋‹ค์ค‘ ์ถœ๋ ฅ ์ด์ฒด๋ฅผ ํ—ˆ์šฉํ•ฉ๋‹ˆ๋‹ค. ๋‹ค๋ฅธ ๋ชจ๋“  ๋ธ”๋ก์ฒด์ธ์€ ํ•˜๋‚˜์˜ ์†Œ์Šค ์ฃผ์†Œ์™€ ํ•˜๋‚˜์˜ ๋Œ€์ƒ ์ฃผ์†Œ๋กœ ์ด์ฒด๋ฅผ ํ—ˆ์šฉํ•ฉ๋‹ˆ๋‹ค. * `MINT` - ์ƒˆ๋กœ์šด ํ† ํฐ์„ ์ฃผ์กฐํ•ฉ๋‹ˆ๋‹ค. Stellar, Ripple ๋ฐ EVM ๊ธฐ๋ฐ˜ ๋ธ”๋ก์ฒด์ธ์—์„œ ์ง€์›๋ฉ๋‹ˆ๋‹ค. * `BURN` - ํ† ํฐ์„ ์†Œ๊ฐํ•ฉ๋‹ˆ๋‹ค. Stellar, Ripple ๋ฐ EVM ๊ธฐ๋ฐ˜ ๋ธ”๋ก์ฒด์ธ์—์„œ ์ง€์›๋ฉ๋‹ˆ๋‹ค. * `CONTRACT_CALL` - ๋ชจ๋“  EVM ๋ธ”๋ก์ฒด์ธ์—์„œ web3 ์ž‘์—…์„ ์œ„ํ•œ ์Šค๋งˆํŠธ ๊ณ„์•ฝ ๋ฉ”์„œ๋“œ๋ฅผ ํ˜ธ์ถœํ•ฉ๋‹ˆ๋‹ค. ๊ณ„์•ฝ ํ˜ธ์ถœ ํŠธ๋žœ์žญ์…˜์„ ๋นŒ๋“œํ•˜๋ ค๋ฉด Fireblocks [๊ฐœ๋ฐœ ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ](https://developers.fireblocks.com/docs/ethereum-development#convenience-libraries)๋ฅผ ์‚ฌ์šฉํ•˜๋Š” ๊ฒƒ์ด ์ข‹์Šต๋‹ˆ๋‹ค. * `TYPED_MESSAGE` - Ethereum Personal Message ๋˜๋Š” EIP712 ํ˜•์‹์˜ ์˜คํ”„์ฒด์ธ ๋ฉ”์‹œ์ง€์ž…๋‹ˆ๋‹ค. ์‹ค์ œ ํŠธ๋žœ์žญ์…˜์ด ์•„๋‹Œ ํŠน์ • ์ฝ๊ธฐ ๊ฐ€๋Šฅ ๋ฉ”์‹œ์ง€์— ์„œ๋ช…ํ•˜๋Š” ๋ฐ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค. [์ž…๋ ฅ๋œ ๋ฉ”์‹œ์ง€์— ๋Œ€ํ•ด ์ž์„ธํžˆ ์•Œ์•„๋ณด๊ธฐ](https://developers.fireblocks.com/docs/typed-message-signing). * `RAW` - ์‚ฌ์ „ ์ •์˜๋œ ํ˜•์‹์ด ์—†๋Š” ์˜คํ”„์ฒด์ธ ๋ฉ”์‹œ์ง€์ž…๋‹ˆ๋‹ค. ์ด๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ Fireblocks์—์„œ ๊ธฐ๋ณธ์ ์œผ๋กœ ์ง€์›ํ•˜์ง€ ์•Š๋Š” ๋ธ”๋ก์ฒด์ธ ๋ฐ ์‚ฌ์šฉ์ž ์ง€์ • ๊ฑฐ๋ž˜ ์œ ํ˜•๊ณผ ๊ฐ™์€ ํ”„๋กœํ† ์ฝœ์„ ํฌํ•จํ•˜์—ฌ ๊ฐœ์ธ ํ‚ค๋กœ ๋ชจ๋“  ๋ฉ”์‹œ์ง€์— ์„œ๋ช…ํ•ฉ๋‹ˆ๋‹ค. [์›์‹œ ์„œ๋ช… ๊ฑฐ๋ž˜์— ๋Œ€ํ•ด ์ž์„ธํžˆ ์•Œ์•„๋ณด๊ธฐ](https://developers.fireblocks.com/docs/raw-message-signing)" + }, + "GetTransactionOperation": { + "oneOf": [ + { + "const": "TRANSFER" + }, + { + "const": "BURN" + }, + { + "const": "CONTRACT_CALL" + }, + { + "const": "MINT" + }, + { + "const": "RAW" + }, + { + "const": "TYPED_MESSAGE" + }, + { + "const": "ENABLE_ASSET" + }, + { + "const": "STAKE" + }, + { + "const": "UNSTAKE" + }, + { + "const": "WITHDRAW" + }, + { + "const": "REDEEM_FROM_COMPOUND" + }, + { + "const": "SUPPLY_TO_COMPOUND" + } + ], + "description": "* `TRANSFER` - ํ•œ ๊ณ„์ •์—์„œ ๋‹ค๋ฅธ ๊ณ„์ •์œผ๋กœ ์ž๊ธˆ์„ ์ด์ฒดํ•ฉ๋‹ˆ๋‹ค. UTXO ๋ธ”๋ก์ฒด์ธ์€ ๋‹ค์ค‘ ์ž…๋ ฅ ๋ฐ ๋‹ค์ค‘ ์ถœ๋ ฅ ์ด์ฒด๋ฅผ ํ—ˆ์šฉํ•ฉ๋‹ˆ๋‹ค. ๋‹ค๋ฅธ ๋ชจ๋“  ๋ธ”๋ก์ฒด์ธ์€ ํ•˜๋‚˜์˜ ์†Œ์Šค ์ฃผ์†Œ์™€ ํ•˜๋‚˜์˜ ๋Œ€์ƒ ์ฃผ์†Œ๋กœ ์ด์ฒด๋ฅผ ํ—ˆ์šฉํ•ฉ๋‹ˆ๋‹ค. * `MINT` - ์ƒˆ๋กœ์šด ํ† ํฐ์„ ์ฃผ์กฐํ•ฉ๋‹ˆ๋‹ค. Stellar, Ripple ๋ฐ EVM ๊ธฐ๋ฐ˜ ๋ธ”๋ก์ฒด์ธ์—์„œ ์ง€์›๋ฉ๋‹ˆ๋‹ค. * `BURN` - ํ† ํฐ์„ ์†Œ๊ฐํ•ฉ๋‹ˆ๋‹ค. Stellar, Ripple ๋ฐ EVM ๊ธฐ๋ฐ˜ ๋ธ”๋ก์ฒด์ธ์—์„œ ์ง€์›๋ฉ๋‹ˆ๋‹ค. * `CONTRACT_CALL` - ๋ชจ๋“  EVM ๋ธ”๋ก์ฒด์ธ์—์„œ web3 ์ž‘์—…์„ ์œ„ํ•œ ์Šค๋งˆํŠธ ๊ณ„์•ฝ ๋ฉ”์„œ๋“œ๋ฅผ ํ˜ธ์ถœํ•ฉ๋‹ˆ๋‹ค. ๊ณ„์•ฝ ํ˜ธ์ถœ ํŠธ๋žœ์žญ์…˜์„ ๋นŒ๋“œํ•˜๋ ค๋ฉด Fireblocks [๊ฐœ๋ฐœ ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ](https://developers.fireblocks.com/docs/ethereum-development#convenience-libraries)๋ฅผ ์‚ฌ์šฉํ•˜๋Š” ๊ฒƒ์ด ์ข‹์Šต๋‹ˆ๋‹ค. * `TYPED_MESSAGE` - Ethereum Personal Message ๋˜๋Š” EIP712 ํ˜•์‹์˜ ์˜คํ”„์ฒด์ธ ๋ฉ”์‹œ์ง€์ž…๋‹ˆ๋‹ค. ์‹ค์ œ ํŠธ๋žœ์žญ์…˜์ด ์•„๋‹Œ ํŠน์ • ์ฝ๊ธฐ ๊ฐ€๋Šฅ ๋ฉ”์‹œ์ง€์— ์„œ๋ช…ํ•˜๋Š” ๋ฐ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค. [์ž…๋ ฅ๋œ ๋ฉ”์‹œ์ง€์— ๋Œ€ํ•ด ์ž์„ธํžˆ ์•Œ์•„๋ณด๊ธฐ](https://developers.fireblocks.com/docs/typed-message-signing). * `RAW` - ์‚ฌ์ „ ์ •์˜๋œ ํ˜•์‹์ด ์—†๋Š” ์˜คํ”„์ฒด์ธ ๋ฉ”์‹œ์ง€์ž…๋‹ˆ๋‹ค. ๋ธ”๋ก์ฒด์ธ ๋ฐ Fireblocks์—์„œ ๊ธฐ๋ณธ์ ์œผ๋กœ ์ง€์›ํ•˜์ง€ ์•Š๋Š” ์‚ฌ์šฉ์ž ์ง€์ • ๊ฑฐ๋ž˜ ์œ ํ˜•๊ณผ ๊ฐ™์€ ํ”„๋กœํ† ์ฝœ์„ ํฌํ•จํ•˜์—ฌ ๊ฐœ์ธ ํ‚ค๋กœ ๋ชจ๋“  ๋ฉ”์‹œ์ง€์— ์„œ๋ช…ํ•˜๋Š” ๋ฐ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค. [์›์‹œ ์„œ๋ช… ๊ฑฐ๋ž˜์— ๋Œ€ํ•ด ์ž์„ธํžˆ ์•Œ์•„๋ณด๊ธฐ](https://developers.fireblocks.com/docs/raw-message-signing) * `ENABLE_ASSET` - Algorand, DigitalBits, Solana ๋ฐ Stellar๋Š” ์ž์‚ฐ ์ง€๊ฐ‘์„ ๋งŒ๋“ค๊ณ  ์ž…๊ธˆ ์ฃผ์†Œ๋ฅผ ํ™œ์„ฑํ™”ํ•˜๊ธฐ ์œ„ํ•ด ์˜จ์ฒด์ธ ๊ฑฐ๋ž˜๊ฐ€ ํ•„์š”ํ•ฉ๋‹ˆ๋‹ค. ์ด ๊ฑฐ๋ž˜๋Š” ๋ณผํŠธ ๊ณ„์ •์—์„œ ์ด๋Ÿฌํ•œ ๋ธ”๋ก์ฒด์ธ์— ์ž์‚ฐ์„ ์ถ”๊ฐ€ํ•  ๋•Œ ์ž๋™์œผ๋กœ ์ƒ์„ฑ๋ฉ๋‹ˆ๋‹ค. * `STAKE` - ์Šคํ…Œ์ดํ‚น ๊ฒ€์ฆ์ž๊ฐ€ ๊ด€๋ฆฌํ•˜๋Š” ์Šคํ…Œ์ดํ‚น ํ’€์— ์ž์‚ฐ์„ ํ• ๋‹นํ•ฉ๋‹ˆ๋‹ค. Stellar ๋ฐ EVM ๊ธฐ๋ฐ˜ ๋ธ”๋ก์ฒด์ธ์—์„œ ์ง€์›๋ฉ๋‹ˆ๋‹ค. ์ด ๊ฑฐ๋ž˜๋Š” ์Šคํ…Œ์ดํ‚น ์ž‘์—…์„ ์ˆ˜ํ–‰ํ•  ๋•Œ ์ž๋™์œผ๋กœ ์ƒ์„ฑ๋ฉ๋‹ˆ๋‹ค. * `UNSTAKE` - ์Šคํ…Œ์ดํ‚น ๊ฒ€์ฆ์ž๊ฐ€ ๊ด€๋ฆฌํ•˜๋Š” ์Šคํ…Œ์ดํ‚น ํ’€์—์„œ ์ž์‚ฐ์„ ์ œ๊ฑฐํ•ฉ๋‹ˆ๋‹ค. Stellar ๋ฐ EVM ๊ธฐ๋ฐ˜ ๋ธ”๋ก์ฒด์ธ์—์„œ ์ง€์›๋ฉ๋‹ˆ๋‹ค. ์ด ํŠธ๋žœ์žญ์…˜์€ ์Šคํ…Œ์ดํ‚น ์ž‘์—…์„ ์ˆ˜ํ–‰ํ•  ๋•Œ ์ž๋™์œผ๋กœ ์ƒ์„ฑ๋ฉ๋‹ˆ๋‹ค. * `WITHDRAW` - ์ „์šฉ ์Šคํ…Œ์ดํ‚น ๋ณผํŠธ ๊ณ„์ •์—์„œ ๋‹ค๋ฅธ ์ฃผ์†Œ๋กœ ์ž์‚ฐ์„ ์ด์ฒดํ•ฉ๋‹ˆ๋‹ค. Stellar ๋ฐ EVM ๊ธฐ๋ฐ˜ ๋ธ”๋ก์ฒด์ธ์—์„œ ์ง€์›๋ฉ๋‹ˆ๋‹ค. ์ด ํŠธ๋žœ์žญ์…˜์€ ์Šคํ…Œ์ดํ‚น ์ž‘์—…์„ ์ˆ˜ํ–‰ํ•  ๋•Œ ์ž๋™์œผ๋กœ ์ƒ์„ฑ๋ฉ๋‹ˆ๋‹ค. **์ฐธ๊ณ :** Fireblocks๋Š” ์ด ์œ ํ˜•์˜ ์ด๋ฆ„์„ ๊ณง `WITHDRAW`์—์„œ ๋‹ค๋ฅธ ์œ ํ˜• ์ด๋ฆ„์œผ๋กœ ๋ฐ”๊ฟ€ ์˜ˆ์ •์ž…๋‹ˆ๋‹ค. ์ƒˆ ์œ ํ˜• ์ด๋ฆ„์— ๋Œ€ํ•œ 7์ผ ๊ณต์ง€๊ฐ€ ์žˆ์„ ์˜ˆ์ •์ž…๋‹ˆ๋‹ค. * `SUPPLY_TO_COMPOUND` - 2023๋…„ 4์›” 1์ผ๋ถ€ํ„ฐ ๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค. ์ž‘์—… ๊ณต๊ฐ„์˜ ์‚ฌ์šฉ์ž๊ฐ€ Fireblocks์™€ Compound DeFI ํ”„๋กœํ† ์ฝœ ๊ฐ„์˜ ์ง์ ‘ ํ†ตํ•ฉ์„ ์‚ฌ์šฉํ•œ ๊ฒฝ์šฐ ์ด์ „ ํŠธ๋žœ์žญ์…˜์—์„œ ์ด ์ž‘์—…์„ ์ˆ˜ํ–‰ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. * `REDEEM_FROM_COMPOUND` - 2023๋…„ 4์›” 1์ผ๋ถ€ํ„ฐ ๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค. ์ž‘์—… ๊ณต๊ฐ„์˜ ์‚ฌ์šฉ์ž๊ฐ€ Fireblocks์™€ Compound DeFI ํ”„๋กœํ† ์ฝœ ๊ฐ„์˜ ์ง์ ‘ ํ†ตํ•ฉ์„ ์‚ฌ์šฉํ•œ ๊ฒฝ์šฐ ์ด์ „ ํŠธ๋žœ์žญ์…˜์—์„œ ์ด ๊ธฐ๋Šฅ์ด ์ž‘๋™ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.." + }, + "Error": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "code": { + "type": "number" + } + } + }, + "Term": { + "type": "object", + "properties": { + "networkConnectionId": { + "type": "string" + }, + "outgoing": { + "type": "boolean" + }, + "asset": { + "type": "string" + }, + "amount": { + "type": "string" + }, + "note": { + "type": "string" + }, + "operation": { + "type": "string" + } + } + }, + "SetConfirmationsThresholdRequest": { + "type": "object", + "properties": { + "numOfConfirmations": { + "type": "number" + } + } + }, + "SetConfirmationsThresholdResponse": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + }, + "transactions": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DropTransactionRequest": { + "type": "object", + "properties": { + "txId": { + "type": "string" + }, + "feeLevel": { + "type": "string" + }, + "gasPrice": { + "type": "string" + } + } + }, + "DropTransactionResponse": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + }, + "transactions": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "UnsignedMessage": { + "type": "object", + "properties": { + "content": { + "type": "string" + }, + "bip44addressIndex": { + "type": "integer" + }, + "bip44change": { + "type": "number" + }, + "derivationPath": { + "type": "array", + "items": { + "type": "number" + } + } + }, + "required": [ + "content" + ] + }, + "SignedMessage": { + "type": "object", + "description": "์›์‹œ ์„œ๋ช…์„ ์œ„ํ•ด ๋ฐ˜ํ™˜๋œ ์„œ๋ช…๋œ ๋ฉ”์‹œ์ง€ ๋ชฉ๋ก.", + "properties": { + "content": { + "type": "string" + }, + "algorithm": { + "oneOf": [ + { + "const": "MPC_ECDSA_SECP256K1" + }, + { + "const": "MPC_EDDSA_ED25519" + } + ] + }, + "derivationPath": { + "type": "array", + "items": { + "type": "number" + } + }, + "signature": { + "type": "object", + "properties": { + "fullSig": { + "type": "string" + }, + "r": { + "type": "string" + }, + "s": { + "type": "string" + }, + "v": { + "type": "number" + } + } + }, + "publicKey": { + "type": "string" + } + } + }, + "PublicKeyInformation": { + "type": "object", + "properties": { + "algorithm": { + "type": "string" + }, + "derivationPath": { + "type": "array", + "items": { + "type": "number" + } + }, + "publicKey": { + "type": "string" + } + } + }, + "TradingAccountType": { + "oneOf": [ + { + "const": "COIN_FUTURES" + }, + { + "const": "COIN_MARGINED_SWAP" + }, + { + "const": "EXCHANGE" + }, + { + "const": "FUNDING" + }, + { + "const": "FUNDABLE" + }, + { + "const": "FUTURES" + }, + { + "const": "FUTURES_CROSS" + }, + { + "const": "MARGIN" + }, + { + "const": "MARGIN_CROSS" + }, + { + "const": "OPTIONS" + }, + { + "const": "SPOT" + }, + { + "const": "USDT_MARGINED_SWAP_CROSS" + }, + { + "const": "USDT_FUTURES" + }, + { + "const": "UNIFIED" + } + ] + }, + "ValidateAddressResponse": { + "type": "object", + "properties": { + "isValid": { + "type": "boolean" + }, + "isActive": { + "type": "boolean" + }, + "requiresTag": { + "type": "boolean" + } + } + }, + "ResendWebhooksResponse": { + "type": "object", + "properties": { + "messagesCount": { + "type": "number" + } + } + }, + "UnspentInputsResponse": { + "type": "object", + "properties": { + "input": { + "$ref": "#/components/schemas/UnspentInput" + }, + "address": { + "type": "string" + }, + "amount": { + "type": "string" + }, + "confirmations": { + "type": "number" + }, + "status": { + "type": "string" + } + } + }, + "UnspentInput": { + "type": "object", + "properties": { + "txHash": { + "type": "string" + }, + "index": { + "type": "number" + } + } + }, + "GetUsersResponse": { + "type": "object", + "properties": { + "users": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserResponse" + } + } + } + }, + "ExtraParameters": { + "type": "object", + "properties": {}, + "description": "์ถ”๊ฐ€ ํ”„๋กœํ† ์ฝœ/์ž‘์—…๋ณ„ ํ‚ค-๊ฐ’ ๋งค๊ฐœ๋ณ€์ˆ˜: UTXO ๊ธฐ๋ฐ˜ ๋ธ”๋ก์ฒด์ธ ์ž…๋ ฅ ์„ ํƒ์˜ ๊ฒฝ์šฐ ํ‚ค `inputsSelection`์„ ์ถ”๊ฐ€ํ•˜๊ณ  ๊ฐ’์€ [์ž…๋ ฅ ์„ ํƒ ๊ตฌ์กฐ](https://developers.fireblocks.com/reference/transaction-objects#inputsselection)๋กœ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค. ์ž…๋ ฅ์€ [์‚ฌ์šฉ๋˜์ง€ ์•Š์€ ์ž…๋ ฅ ๊ฒ€์ƒ‰ ์—”๋“œํฌ์ธํŠธ](https://developers.fireblocks.com/reference/get_vault-accounts-vaultaccountid-assetid-unspent-inputs)์—์„œ ๊ฒ€์ƒ‰ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. `RAW` ์ž‘์—…์˜ ๊ฒฝ์šฐ ํ‚ค `rawMessageData`๋ฅผ ์ถ”๊ฐ€ํ•˜๊ณ  ๊ฐ’์€ [์›์‹œ ๋ฉ”์‹œ์ง€ ๋ฐ์ดํ„ฐ ๊ตฌ์กฐ](https://developers.fireblocks.com/reference/raw-signing-objects#rawmessagedata)๋กœ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค. `CONTRACT_CALL` ์ž‘์—…์˜ ๊ฒฝ์šฐ ํ‚ค `contractCallData`๋ฅผ ์ถ”๊ฐ€ํ•˜๊ณ  ๊ฐ’์€ Ethereum ์Šค๋งˆํŠธ ๊ณ„์•ฝ Application Binary Interface(ABI) ํŽ˜์ด๋กœ๋“œ๋กœ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค. Fireblocks [๊ฐœ๋ฐœ ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ](https://developers.fireblocks.com/docs/ethereum-development#convenience-libraries)๋Š” ๊ณ„์•ฝ ํ˜ธ์ถœ ํŠธ๋žœ์žญ์…˜์„ ๋นŒ๋“œํ•˜๋Š” ๋ฐ ๊ถŒ์žฅ๋ฉ๋‹ˆ๋‹ค.." + }, + "NetworkIdRoutingPolicy": { + "type": "object", + "properties": { + "crypto": { + "oneOf": [ + { + "$ref": "#/components/schemas/CustomCryptoRoutingDest" + }, + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + } + ] + }, + "sen": { + "oneOf": [ + { + "$ref": "#/components/schemas/CustomFiatRoutingDest" + }, + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + } + ] + }, + "signet": { + "oneOf": [ + { + "$ref": "#/components/schemas/CustomFiatRoutingDest" + }, + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + } + ] + }, + "sen_test": { + "oneOf": [ + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + }, + { + "$ref": "#/components/schemas/CustomFiatRoutingDest" + } + ] + }, + "signet_test": { + "oneOf": [ + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + }, + { + "$ref": "#/components/schemas/CustomFiatRoutingDest" + } + ] + } + } + }, + "NetworkConnectionRoutingPolicy": { + "type": "object", + "properties": { + "crypto": { + "oneOf": [ + { + "$ref": "#/components/schemas/CustomCryptoRoutingDest" + }, + { + "$ref": "#/components/schemas/DefaultNetworkRoutingDest" + }, + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + } + ] + }, + "sen": { + "oneOf": [ + { + "$ref": "#/components/schemas/CustomFiatRoutingDest" + }, + { + "$ref": "#/components/schemas/DefaultNetworkRoutingDest" + }, + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + } + ] + }, + "signet": { + "oneOf": [ + { + "$ref": "#/components/schemas/DefaultNetworkRoutingDest" + }, + { + "$ref": "#/components/schemas/CustomFiatRoutingDest" + }, + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + } + ] + }, + "sen_test": { + "oneOf": [ + { + "$ref": "#/components/schemas/DefaultNetworkRoutingDest" + }, + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + }, + { + "$ref": "#/components/schemas/CustomFiatRoutingDest" + } + ] + }, + "signet_test": { + "oneOf": [ + { + "$ref": "#/components/schemas/NoneNetworkRoutingDest" + }, + { + "$ref": "#/components/schemas/CustomFiatRoutingDest" + }, + { + "$ref": "#/components/schemas/DefaultNetworkRoutingDest" + } + ] + } + } + }, + "CustomFiatRoutingDest": { + "type": "object", + "properties": { + "scheme": { + "const": "CUSTOM", + "description": "๋„คํŠธ์›Œํฌ ๋ผ์šฐํŒ… ๋กœ์ง." + }, + "dstType": { + "const": "FIAT_ACCOUNT", + "description": "์ž๊ธˆ์ด ์ „์†ก๋˜๋Š” ๋ฒ•์ • ํ†ตํ™” ๊ณ„์ •." + }, + "dstId": { + "type": "string", + "description": "์ž๊ธˆ์ด ์ „์†ก๋˜๋Š” ๋ฒ•์ • ๊ณ„์ขŒ์˜ ID." + } + }, + "required": [ + "scheme", + "dstType", + "dstId" + ] + }, + "CustomCryptoRoutingDest": { + "type": "object", + "properties": { + "scheme": { + "const": "CUSTOM", + "description": "๋„คํŠธ์›Œํฌ ๋ผ์šฐํŒ… ๋กœ์ง." + }, + "dstType": { + "oneOf": [ + { + "const": "VAULT" + }, + { + "const": "EXCHANGE" + } + ], + "description": "์ž๊ธˆ์ด ์ „์†ก๋˜๋Š” ๋Œ€์ƒ ๊ณ„์ • ์œ ํ˜•." + }, + "dstId": { + "type": "string", + "description": "์ž๊ธˆ์ด ์ „์†ก๋˜๋Š” ๋Œ€์ƒ ๊ณ„์ •์˜ ID." + } + }, + "required": [ + "scheme", + "dstType", + "dstId" + ] + }, + "DefaultNetworkRoutingDest": { + "type": "object", + "properties": { + "scheme": { + "const": "DEFAULT", + "description": "๋„คํŠธ์›Œํฌ ๋ผ์šฐํŒ… ๋กœ์ง." + } + }, + "required": [ + "scheme" + ] + }, + "NoneNetworkRoutingDest": { + "type": "object", + "properties": { + "scheme": { + "const": "NONE", + "description": "๋„คํŠธ์›Œํฌ ๋ผ์šฐํŒ… ๋กœ์ง์ด ์—†์Šต๋‹ˆ๋‹ค." + } + }, + "required": [ + "scheme" + ] + }, + "UserResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "role": { + "type": "string" + }, + "email": { + "type": "string" + }, + "enabled": { + "type": "boolean" + } + } + }, + "SessionMetadata": { + "type": "object", + "properties": { + "appUrl": { + "type": "string" + }, + "appName": { + "type": "string" + }, + "appDescription": { + "type": "string" + }, + "appIcon": { + "type": "string" + } + }, + "required": [ + "appUrl" + ] + }, + "SessionDTO": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "์—ฐ๊ฒฐ์˜ ID", + "example": "4e9e7051-f3b2-48e9-8ee6-b12492552657" + }, + "userId": { + "type": "string", + "description": "์—ฐ๊ฒฐ์„ ์ƒ์„ฑํ•œ ์‚ฌ์šฉ์ž์˜ ID" + }, + "sessionMetadata": { + "description": "์—ฐ๊ฒฐ์˜ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ(dapp์—์„œ ์ œ๊ณต)", + "type": "object", + "properties": { + "appUrl": { + "type": "string" + }, + "appName": { + "type": "string" + }, + "appDescription": { + "type": "string" + }, + "appIcon": { + "type": "string" + } + } + }, + "vaultAccountId": { + "type": "number", + "description": "์—ฐ๊ฒฐํ•  ๊ธˆ๊ณ ", + "example": 1 + }, + "feeLevel": { + "oneOf": [ + { + "const": "MEDIUM" + }, + { + "const": "HIGH" + } + ], + "description": "๊ธฐ๋ณธ ์ˆ˜์ˆ˜๋ฃŒ ์ˆ˜์ค€", + "example": "MEDIUM" + }, + "chainIds": { + "description": "์—ฐ๊ฒฐ์— ์Šน์ธ๋œ ์ฒด์ธ", + "example": [ + "ETH", + "ETH_TEST", + "SOL" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "connectionType": { + "const": "WalletConnect", + "description": "์—ฐ๊ฒฐ ์œ ํ˜•", + "example": "WalletConnect" + }, + "connectionMethod": { + "oneOf": [ + { + "const": "DESKTOP" + }, + { + "const": "MOBILE" + }, + { + "const": "API" + } + ], + "description": "์—ฐ๊ฒฐ์ด ์„ค์ •๋œ ๋ฐฉ๋ฒ•", + "example": "API" + }, + "creationDate": { + "format": "date-time", + "type": "string", + "description": "์„ธ์…˜ ์ƒ์„ฑ ํƒ€์ž„์Šคํƒฌํ”„" + } + }, + "required": [ + "id", + "userId", + "sessionMetadata", + "vaultAccountId", + "feeLevel", + "chainIds", + "connectionType", + "connectionMethod", + "creationDate" + ] + }, + "GetConnectionsResponse": { + "type": "object", + "properties": { + "data": { + "description": "์š”์ฒญ๋œ Web3 ์—ฐ๊ฒฐ์˜ ๋ฐ์ดํ„ฐ๊ฐ€ ํฌํ•จ๋œ ๋ฐฐ์—ด", + "type": "array", + "items": { + "$ref": "#/components/schemas/SessionDTO" + } + }, + "paging": { + "$ref": "#/components/schemas/Paging" + } + }, + "required": [ + "data" + ] + }, + "CreateConnectionRequest": { + "type": "object", + "properties": { + "vaultAccountId": { + "type": "number", + "description": "Web3 ์—ฐ๊ฒฐ์— ์—ฐ๊ฒฐํ•  ๋ณผํŠธ์˜ ID.", + "example": 1 + }, + "feeLevel": { + "oneOf": [ + { + "const": "MEDIUM" + }, + { + "const": "HIGH" + } + ], + "description": "๊ธฐ๋ณธ ์ˆ˜์ˆ˜๋ฃŒ ์ˆ˜์ค€์ž…๋‹ˆ๋‹ค. ์œ ํšจํ•œ ๊ฐ’์€ `MEDIUM` ๋ฐ `HIGH`์ž…๋‹ˆ๋‹ค..", + "example": "MEDIUM" + }, + "uri": { + "type": "string", + "description": "dapp์—์„œ ์ œ๊ณตํ•˜๋Š” WalletConnect uri.", + "example": "wc:77752975-906f-48f5-b59f-047826ee947e@1?bridge=https%3A%2F%2F0.bridge.walletconnect.org&key=64be99adc6086b7a729b0ec8c7e1f174927ab92e84f5c6f9527050225344a637" + }, + "chainIds": { + "description": "Web3 ์—ฐ๊ฒฐ์— ์‚ฌ์šฉ๋˜๋Š” ๋ธ”๋ก์ฒด์ธ ๋„คํŠธ์›Œํฌ์˜ ID.", + "example": [ + "ETH", + "ETH_TEST" + ], + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "vaultAccountId", + "feeLevel", + "uri", + "chainIds" + ] + }, + "CreateConnectionResponse": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "์‹œ์ž‘๋œ Web3 ์—ฐ๊ฒฐ์˜ ID.", + "example": "4e9e7051-f3b2-48e9-8ee6-b12492552657" + }, + "sessionMetadata": { + "description": "Web3 ์—ฐ๊ฒฐ์˜ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ(DApp์—์„œ ์ œ๊ณต).", + "type": "object", + "properties": { + "appUrl": { + "type": "string" + }, + "appName": { + "type": "string" + }, + "appDescription": { + "type": "string" + }, + "appIcon": { + "type": "string" + } + } + } + }, + "required": [ + "id", + "sessionMetadata" + ] + }, + "RespondToConnectionRequest": { + "type": "object", + "properties": { + "approve": { + "type": "boolean", + "description": "์‹œ์ž‘๋œ Web3 ์—ฐ๊ฒฐ ์Šน์ธ.", + "example": true + } + }, + "required": [ + "approve" + ] + }, + "AddCollateralRequestBody": { + "type": "object", + "properties": { + "transactionRequest": { + "$ref": "#/components/schemas/TransactionRequest" + }, + "isSrcCollateral": { + "type": "boolean", + "description": "์„ ํƒ ๊ณผ๋ชฉ" + } + } + }, + "RemoveCollateralRequestBody": { + "type": "object", + "properties": { + "transactionRequest": { + "$ref": "#/components/schemas/TransactionRequest" + }, + "isDstCollateral": { + "type": "boolean", + "description": "์„ ํƒ ๊ณผ๋ชฉ" + } + } + }, + "SettlementRequestBody": { + "type": "object", + "properties": { + "mainExchangeAccountId": { + "type": "string" + } + } + }, + "SettlementResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "initiator": { + "type": "string" + }, + "exchangeReply": { + "type": "string" + }, + "fireblocksInitiatedTransactions": { + "type": "object" + }, + "exchangeRequestedTransactions": { + "$ref": "#/components/schemas/SettlementResponse" + } + } + }, + "GetSettlementResponse": { + "$ref": "#/components/schemas/SettlementResponse" + }, + "ToExchangeTransaction": { + "type": "object", + "properties": { + "assetId": { + "type": "string" + }, + "amount": { + "type": "string" + }, + "dstAddress": { + "type": "string" + }, + "dstTag": { + "type": "string", + "description": "์„ ํƒ ๊ณผ๋ชฉ" + } + } + }, + "ToCollateralTransaction": { + "type": "object", + "properties": { + "asset": { + "type": "string" + }, + "amount": { + "type": "string" + }, + "srcAddress": { + "type": "string" + }, + "srcTag": { + "type": "string", + "description": "์„ ํƒ ๊ณผ๋ชฉ" + }, + "fee": { + "type": "string", + "description": "์„ ํƒ ๊ณผ๋ชฉ" + } + } + }, + "XBSettlementConfigCreationRequestBody": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ๊ตฌ์„ฑ์˜ ์ด๋ฆ„" + }, + "corridorId": { + "$ref": "#/components/schemas/XBSettlementCorridorId" + }, + "steps": { + "$ref": "#/components/schemas/XBSettlementConfigStepsRecord" + }, + "conversionSlippageBasisPoints": { + "$ref": "#/components/schemas/XBSettlementConversionSlippageBasisPoints" + } + }, + "required": [ + "name", + "corridorId", + "steps" + ] + }, + "XBSettlementConfigCreationResponse": { + "$ref": "#/components/schemas/XBSettlementConfigModel" + }, + "XBSettlementConfigEditRequestBody": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ๊ตฌ์„ฑ์˜ ์ด๋ฆ„" + }, + "steps": { + "$ref": "#/components/schemas/XBSettlementConfigStepsRecord" + }, + "conversionSlippageBasisPoints": { + "$ref": "#/components/schemas/XBSettlementConversionSlippageBasisPoints" + } + }, + "required": [ + "name", + "steps" + ] + }, + "XBSettlementConfigEditResponse": { + "$ref": "#/components/schemas/XBSettlementConfigModel" + }, + "XBSettlementConfigDeletionResponse": { + "$ref": "#/components/schemas/XBSettlementConfigModel" + }, + "XBSettlementGetConfigResponse": { + "$ref": "#/components/schemas/XBSettlementConfigModel" + }, + "XBSettlementGetAllConfigsResponse": { + "type": "object", + "properties": { + "configurations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/XBSettlementConfigModel" + } + } + }, + "required": [ + "configurations" + ] + }, + "XBSettlementFlowExecutionRequestBody": { + "type": "object", + "properties": { + "conversionSlippageBasisPoints": { + "$ref": "#/components/schemas/XBSettlementConversionSlippageBasisPoints" + } + } + }, + "XBSettlementFlowExecutionResponse": { + "$ref": "#/components/schemas/XBSettlementFlowExecutionModel" + }, + "XBSettlementFlowExecutionStep": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "๋‹จ๊ณ„ ์‹คํ–‰์„ ์œ„ํ•œ ๊ณ ์œ  ID" + }, + "accountId": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/XBSettlementFlowExecutionStepStatus" + }, + "inputAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "outputAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "fee": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "startedAt": { + "type": "number", + "description": "์—ํฌํฌ ํ˜•์‹์˜ ๋‹จ๊ณ„ ์‹คํ–‰ ์‹œ์ž‘ ์‹œ๊ฐ„." + }, + "completedAt": { + "type": "number", + "description": "์—ํฌํฌ ํ˜•์‹์˜ ๋‹จ๊ณ„ ์‹คํ–‰ ์ข…๋ฃŒ ์‹œ๊ฐ„." + }, + "isSignRequired": { + "type": "boolean", + "description": "๋‹จ๊ณ„ ์‹คํ–‰์— ์„œ๋ช…์ด ํ•„์š”ํ•œ์ง€ ์—ฌ๋ถ€." + } + }, + "required": [ + "id", + "accountId", + "status", + "inputAmount", + "isSignRequired" + ] + }, + "XBSettlementFlowExecutionStepStatus": { + "oneOf": [ + { + "const": "NOT_STARTED" + }, + { + "const": "PROCESSING" + }, + { + "const": "COMPLETED" + }, + { + "const": "FAILED" + } + ] + }, + "XBSettlementFlowExecutionStatus": { + "oneOf": [ + { + "const": "NOT_LAUNCHED" + }, + { + "const": "PROCESSING" + }, + { + "const": "COMPLETED" + }, + { + "const": "FAILED" + } + ] + }, + "XBSettlementConfigId": { + "type": "string", + "format": "uuid", + "description": "ํฌ๋กœ์Šค ๋ณด๋“œ ๊ตฌ์„ฑ ๊ณ ์œ  ID" + }, + "XBSettlementConfigModel": { + "type": "object", + "properties": { + "configId": { + "$ref": "#/components/schemas/XBSettlementConfigId" + }, + "corridorId": { + "$ref": "#/components/schemas/XBSettlementCorridorId" + }, + "name": { + "type": "string", + "description": "๊ตญ๊ฒฝ ๊ฐ„ ์ •์ฐฉ ๊ตฌ์„ฑ์˜ ์ด๋ฆ„" + }, + "steps": { + "$ref": "#/components/schemas/XBSettlementConfigStepsRecord" + }, + "conversionSlippageBasisPoints": { + "$ref": "#/components/schemas/XBSettlementConversionSlippageBasisPoints" + }, + "createdAt": { + "type": "number", + "description": "์—ํฌํฌ ํ˜•์‹์˜ ์ƒ์„ฑ ์‹œ๊ฐ„." + } + }, + "required": [ + "configId", + "name", + "corridorId", + "steps", + "conversionSlippageBasisPoints", + "createdAt" + ] + }, + "XBSettlementCorridorId": { + "oneOf": [ + { + "const": "MX_US" + }, + { + "const": "CO_US" + }, + { + "const": "US_MX" + }, + { + "const": "US_EU" + }, + { + "const": "US_UK" + } + ], + "description": "- MX_US : ๋ฉ•์‹œ์ฝ”(MXN)์—์„œ ๋ฏธ๊ตญ(USD)์œผ๋กœ - CO_US : ์ฝœ๋กฌ๋น„์•„(COP)์—์„œ ๋ฏธ๊ตญ(USD)์œผ๋กœ - US_MX : ๋ฏธ๊ตญ(USD)์—์„œ ๋ฉ•์‹œ์ฝ”(MXN)์œผ๋กœ - US_EU : ๋ฏธ๊ตญ(USD)์—์„œ ์œ ๋Ÿฝ ์—ฐํ•ฉ(EUR)์œผ๋กœ - US_UK : ๋ฏธ๊ตญ(USD)์—์„œ ์˜๊ตญ(GBP)์œผ๋กœ" + }, + "XBSettlementConfigStep": { + "type": "object", + "properties": { + "stepType": { + "$ref": "#/components/schemas/XBSettlementStepType" + }, + "accountId": { + "type": "string" + } + }, + "required": [ + "stepType", + "accountId" + ] + }, + "XBSettlementStepType": { + "oneOf": [ + { + "const": "ON_RAMP" + }, + { + "const": "VAULT_ACCOUNT" + }, + { + "const": "OFF_RAMP" + }, + { + "const": "FIAT_DESTINATION" + } + ], + "description": "- ON_RAMP: ๋ฒ•์ • ํ†ตํ™”๋ฅผ ์•”ํ˜ธํ™”ํ๋กœ ๊ตํ™˜ํ•  ์ˆ˜ ์žˆ๋Š” ์„œ๋น„์Šค์ž…๋‹ˆ๋‹ค. OnRamp ์ž…๋ ฅ ๊ฐ’์€ ํ•ญ์ƒ ๋ฒ•์ • ํ†ตํ™”์ด๊ณ  ์ถœ๋ ฅ ๊ฐ’์€ ์•”ํ˜ธ ์ž์‚ฐ์ž…๋‹ˆ๋‹ค. - VAULT_ACCOUNT: Fireblocks Vault ๊ณ„์ • - OFF_RAMP: ๋ฒ•์ • ํ†ตํ™”๋ฅผ ์•”ํ˜ธํ™”ํ๋กœ ๊ตํ™˜ํ•  ์ˆ˜ ์žˆ๋Š” ์„œ๋น„์Šค์ž…๋‹ˆ๋‹ค. OffRamp ์ž…๋ ฅ ๊ฐ’์€ ํ•ญ์ƒ ์•”ํ˜ธ ์ž์‚ฐ์ด๊ณ  ์ถœ๋ ฅ ๊ฐ’์€ ๋ฒ•์ • ํ†ตํ™”์ž…๋‹ˆ๋‹ค. - FIAT_DESTINATION: ๋ฒ•์ • ํ†ตํ™” ๊ณ„์ •" + }, + "XBSettlementFlowSetupStep": { + "type": "object", + "properties": { + "accountId": { + "type": "string" + }, + "inputAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "outputAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "estimatedFeeAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "estimatedTime": { + "type": "number", + "description": "๋‹จ๊ณ„ ์‹คํ–‰์— ํ•„์š”ํ•œ ์˜ˆ์ƒ ์‹œ๊ฐ„." + }, + "isSignRequired": { + "type": "boolean", + "description": "๋‹จ๊ณ„ ์‹คํ–‰์— ์„œ๋ช…์ด ํ•„์š”ํ•œ์ง€ ์—ฌ๋ถ€." + } + }, + "required": [ + "accountId", + "inputAmount", + "outputAmount", + "estimatedFeeAmount", + "estimatedTime", + "isSignRequired" + ] + }, + "XBSettlementGetFlowResponse": { + "type": "object", + "properties": { + "preview": { + "$ref": "#/components/schemas/XBSettlementFlowPreviewModel" + }, + "execution": { + "$ref": "#/components/schemas/XBSettlementFlowExecutionModel" + } + } + }, + "XBSettlementFlowPreviewModel": { + "type": "object", + "properties": { + "flowId": { + "type": "string", + "description": "๊ตญ๊ฒฝ ๊ฐ„ ํ๋ฆ„์„ ์œ„ํ•œ ๊ณ ์œ  ID." + }, + "configId": { + "$ref": "#/components/schemas/XBSettlementConfigId" + }, + "conversionRate": { + "type": "string", + "description": "์˜จ๋žจํ”„ ๋˜๋Š” ์˜คํ”„๋žจํ”„์—์„œ ์ˆ˜์‹ ๋œ ๋ณ€ํ™˜์œจ." + }, + "inputAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "estimatedOutputAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "totalEstimatedFee": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "totalEstimatedTime": { + "type": "number", + "description": "๊ตญ๊ฒฝ ๊ฐ„ ํ๋ฆ„์„ ์‹คํ–‰ํ•˜๋Š” ๋ฐ ๊ฑธ๋ฆฌ๋Š” ์ด *์ถ”์ •* ์‹œ๊ฐ„." + }, + "steps": { + "$ref": "#/components/schemas/XBSettlementFlowStepsRecord" + } + }, + "required": [ + "flowId", + "configId", + "steps", + "inputAmount", + "estimatedOutputAmount", + "totalEstimatedFee", + "totalEstimatedTime", + "conversionRate" + ] + }, + "XBSettlementCreateFlowRequestBody": { + "type": "object", + "properties": { + "configId": { + "$ref": "#/components/schemas/XBSettlementConfigId" + }, + "amount": { + "type": "string", + "description": "์ด ๊ตญ๊ฒฝ ๊ฐ„ ํ๋ฆ„์—์„œ ์ด์ฒดํ•  ๊ธˆ์•ก์ž…๋‹ˆ๋‹ค. ์ž์‚ฐ ์œ ํ˜•์€ ๊ตญ๊ฒฝ ๊ฐ„ ๊ฒฐ์ œ ๊ตฌ์„ฑ์— ์˜ํ•ด ์ •์˜๋ฉ๋‹ˆ๋‹ค.." + } + }, + "required": [ + "configId", + "amount" + ] + }, + "XBSettlementCreateFlowResponse": { + "$ref": "#/components/schemas/XBSettlementFlowPreviewModel" + }, + "XBSettlementFlowExecutionModel": { + "type": "object", + "properties": { + "flowId": { + "type": "string", + "description": "๊ตญ๊ฒฝ ๊ฐ„ ํ๋ฆ„์„ ์œ„ํ•œ ๊ณ ์œ  ID." + }, + "configId": { + "$ref": "#/components/schemas/XBSettlementConfigId" + }, + "inputAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "outputAmount": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "totalFee": { + "$ref": "#/components/schemas/XBSettlementAsset" + }, + "initiatedAt": { + "type": "number", + "description": "์—ํฌํฌ ํ˜•์‹์œผ๋กœ ๊ตญ๊ฒฝ ๊ฐ„ ํ๋ฆ„์ด ์‹คํ–‰๋˜๋Š” ์‹œ๊ฐ„." + }, + "initiatedBy": { + "description": "ํ๋ฆ„์„ ์‹œ์ž‘ํ•œ ์‚ฌ์šฉ์ž์˜ ID", + "type": "string" + }, + "state": { + "$ref": "#/components/schemas/XBSettlementFlowExecutionStatus" + }, + "steps": { + "$ref": "#/components/schemas/XBSettlementFlowStepsExecutionRecord" + }, + "selectedConversionSlippage": { + "type": "object", + "description": "์˜ค๋ฒ„๋ผ์ด๋“œ ๋…ผ๋ฆฌ๊ฐ€ ๋ฐœ์ƒํ–ˆ์„ ์ˆ˜ ์žˆ์œผ๋ฏ€๋กœ ํ๋ฆ„ ์ค‘์— ์‚ฌ์šฉ๋œ ์„ ํƒ๋œ ๋ฏธ๋„๋Ÿฌ์ง์„ ๋‚˜ํƒ€๋ƒ…๋‹ˆ๋‹ค..", + "properties": { + "basisPoints": { + "type": "number" + }, + "reason": { + "$ref": "#/components/schemas/XBSettlementFlowSelectedConversionSlippageReason" + } + }, + "required": [ + "basisPoints", + "reason" + ] + } + }, + "required": [ + "flowId", + "configId", + "steps", + "inputAmount", + "outputAmount", + "totalFee", + "initiatedAt", + "initiatedBy", + "state", + "selectedConversionSlippage" + ] + }, + "XBSettlementFlowSelectedConversionSlippageReason": { + "oneOf": [ + { + "const": "DEFAULT" + }, + { + "const": "CONFIG" + }, + { + "const": "FLOW" + } + ] + }, + "XBSettlementFlowStepsExecutionRecord": { + "type": "object", + "properties": { + "stepType": { + "$ref": "#/components/schemas/XBSettlementStepType" + } + }, + "additionalProperties": { + "$ref": "#/components/schemas/XBSettlementFlowExecutionStep" + } + }, + "XBSettlementConfigStepsRecord": { + "type": "object", + "properties": { + "stepType": { + "$ref": "#/components/schemas/XBSettlementStepType" + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "accountId": { + "type": "string" + }, + "inputAssetId": { + "$ref": "#/components/schemas/XBSettlementAssetID" + }, + "outputAssetId": { + "$ref": "#/components/schemas/XBSettlementAssetID" + } + }, + "required": [ + "accountId" + ] + } + }, + "XBSettlementConversionSlippageBasisPoints": { + "type": "integer", + "minimum": 0, + "maximum": 10000, + "default": 10000, + "description": "๊ธฐ์ค€์  ๋‹จ์œ„์˜ ๋ฏธ๋„๋Ÿฌ์ง ๊ตฌ์„ฑ, ๊ธฐ๋ณธ๊ฐ’์€ 10%์ž…๋‹ˆ๋‹ค." + }, + "XBSettlementFlowStepsRecord": { + "type": "object", + "properties": { + "stepType": { + "$ref": "#/components/schemas/XBSettlementStepType" + } + }, + "additionalProperties": { + "$ref": "#/components/schemas/XBSettlementFlowSetupStep" + } + }, + "XBSettlementAsset": { + "type": "object", + "properties": { + "amount": { + "type": "string" + }, + "assetId": { + "$ref": "#/components/schemas/XBSettlementAssetID" + } + }, + "required": [ + "amount" + ] + }, + "XBSettlementAssetID": { + "oneOf": [ + { + "$ref": "#/components/schemas/XBSettlementFiatAsset" + }, + { + "$ref": "#/components/schemas/XBSettlementCryptoAsset" + } + ] + }, + "XBSettlementFiatAsset": { + "oneOf": [ + { + "const": "USD" + }, + { + "const": "MXN" + }, + { + "const": "COP" + }, + { + "const": "EUR" + }, + { + "const": "GBP" + } + ] + }, + "XBSettlementCryptoAsset": { + "oneOf": [ + { + "const": "XLM_USDC_5F3T" + }, + { + "const": "XLM" + } + ], + "description": "- XLM_USDC_5F3T : Stellar ๋„คํŠธ์›Œํฌ๋ฅผ ํ†ตํ•œ USDC" + }, + "CreatePayoutRequest": { + "type": "object", + "properties": { + "paymentAccount": { + "$ref": "#/components/schemas/PaymentAccount" + }, + "instructionSet": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PayoutInstruction" + } + } + }, + "required": [ + "paymentAccount", + "instructionSet" + ] + }, + "PaymentAccount": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/PaymentAccountType" + } + }, + "required": [ + "id", + "type" + ] + }, + "PayoutInstruction": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "payeeAccount": { + "$ref": "#/components/schemas/PayeeAccount" + }, + "amount": { + "$ref": "#/components/schemas/InstructionAmount" + } + }, + "required": [ + "amount", + "payeeAccount" + ] + }, + "PaymentAccountType": { + "oneOf": [ + { + "const": "VAULT_ACCOUNT" + }, + { + "const": "EXCHANGE_ACCOUNT" + }, + { + "const": "FIAT_ACCOUNT" + } + ] + }, + "PayeeAccount": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/PayeeAccountType" + } + }, + "required": [ + "id", + "type" + ] + }, + "InstructionAmount": { + "type": "object", + "properties": { + "amount": { + "type": "string" + }, + "assetId": { + "type": "string" + } + }, + "required": [ + "amount", + "assetId" + ] + }, + "PayeeAccountType": { + "oneOf": [ + { + "const": "VAULT_ACCOUNT" + }, + { + "const": "EXCHANGE_ACCOUNT" + }, + { + "const": "INTERNAL_WALLET" + }, + { + "const": "EXTERNAL_WALLET" + }, + { + "const": "NETWORK_CONNECTION" + }, + { + "const": "FIAT_ACCOUNT" + } + ], + "description": "- VAULT_ACCOUNT ๊ธฐ๋ณธ Fireblocks ๋ณผํŠธ ๊ณ„์ • - EXCHANGE_ACCOUNT ํƒ€์‚ฌ ๊ฑฐ๋ž˜์†Œ ๊ณ„์ • - INTERNAL_WALLET ์ž‘์—… ๊ณต๊ฐ„/์กฐ์ง์—์„œ ๋‚ด๋ถ€๋กœ ํ‘œ์‹œ๋œ ํ—ˆ์šฉ ๋ชฉ๋ก ์ฃผ์†Œ - EXTERNAL_WALLET ์™ธ๋ถ€๋กœ ํ‘œ์‹œ๋œ ํ—ˆ์šฉ ๋ชฉ๋ก ์ฃผ์†Œ - NETWORK_CONNECTION Fireblocks ๋„คํŠธ์›Œํฌ์˜ ๊ตฌ์„ฑ์› - FIAT_ACCOUNT ๋ฒ•์ • ํ†ตํ™” ์€ํ–‰์˜ ํƒ€์‚ฌ ๊ณ„์ •(Signature, BCB ๋“ฑ)" + }, + "PayoutResponse": { + "type": "object", + "properties": { + "payoutId": { + "type": "string" + }, + "paymentAccount": { + "$ref": "#/components/schemas/PaymentAccountResponse" + }, + "createdAt": { + "type": "number" + }, + "state": { + "$ref": "#/components/schemas/PayoutState" + }, + "status": { + "$ref": "#/components/schemas/PayoutStatus" + }, + "reasonOfFailure": { + "type": "string", + "description": "
  • ๋ถˆ์ถฉ๋ถ„ํ•œ ๊ท ํ˜•
  • ์†Œ์Šค ๋ฒˆ์—ญ
  • ๊ณ ์œ ํ•˜์ง€ ์•Š์€ ์†Œ์Šค
  • ์ถœ์ฒ˜๋ฅผ ์ฐพ์„ ์ˆ˜ ์—†์Œ
  • ์†Œ์Šค ์œ ํ˜•์ด ์ง€์›๋˜์ง€ ์•Š์Œ
  • ๋น„์–ด์žˆ๋Š” ์†Œ์Šค
  • ๋ชฉ์ ์ง€_๋ฒˆ์—ญ
  • ๋ชฉ์ ์ง€_๊ณ ์œ ํ•˜์ง€_์•Š์Œ
  • ๋ชฉ์ ์ง€๋ฅผ ์ฐพ์„ ์ˆ˜ ์—†์Œ
  • ๋น„์–ด์žˆ๋Š” ๋ชฉ์ ์ง€
  • ํŒŒ์‹ฑ
  • ์•Œ๋ ค์ง€์ง€ ์•Š์€
  • ํŒŒ์ด์–ด๋ธ”๋ก_ํด๋ผ์ด์–ธํŠธ
  • ๊ฑฐ๋ž˜_์ œ์ถœ
" + }, + "initMethod": { + "$ref": "#/components/schemas/PayoutInitMethod" + }, + "instructionSet": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PayoutInstructionResponse" + } + }, + "reportUrl": { + "type": "string" + } + }, + "required": [ + "payoutId", + "createdAt", + "state", + "status", + "paymentAccount", + "instructionSet" + ] + }, + "PaymentAccountResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/PaymentAccountType" + } + } + }, + "PayoutState": { + "oneOf": [ + { + "const": "CREATED" + }, + { + "const": "FILE_FOUND" + }, + { + "const": "REQUESTED" + }, + { + "const": "TRANSLATED" + }, + { + "const": "PROCESSING" + }, + { + "const": "SUBMITTED" + }, + { + "const": "FINALIZED" + }, + { + "const": "INSUFFICIENT_BALANCE" + }, + { + "const": "FAILED" + } + ], + "description": "- CREATED - ๋ชจ๋“  ์„ธ๋ถ€ ์ •๋ณด์™€ ํ•จ๊ป˜ ์ƒ์„ฑ๋œ ์ง€๊ธ‰ ๋ช…๋ น ์„ธํŠธ - FILE_FOUND - FTP์—์„œ ์ฐพ์€ ์ƒˆ ํŒŒ์ผ - REQUESTED - ๋ชจ๋“  ์„ธ๋ถ€ ์ •๋ณด์™€ ํ•จ๊ป˜ ์š”์ฒญ๋œ ์ง€๊ธ‰ - TRANSLATED - ์ง€๊ธ‰ ๋ช…๋ น ๊ณ„์ • ID๊ฐ€ ์‹๋ณ„๋˜๊ณ  ๋ณ€ํ™˜๋จ - PROCESSING - ์ง€๊ธ‰ ๋ช…๋ น ์„ธํŠธ๊ฐ€ ์‹คํ–‰๋˜๊ณ  ์ฒ˜๋ฆฌ ์ค‘ - SUBMITTED - ์ง€๊ธ‰ ๋ช…๋ น์— ๋Œ€ํ•œ ๊ฑฐ๋ž˜๊ฐ€ ์ œ์ถœ๋จ - FINALIZED - ์ง€๊ธ‰ ์ฒ˜๋ฆฌ๊ฐ€ ์™„๋ฃŒ๋˜์—ˆ์œผ๋ฉฐ ๋ชจ๋“  ๊ฑฐ๋ž˜๊ฐ€ ์„ฑ๊ณต์ ์œผ๋กœ ์ฒ˜๋ฆฌ๋จ - INSUFFICIENT_BALANCE - ์ง€๊ธ‰ ๊ณ„์ •์˜ ์ž”์•ก์ด ๋ถ€์กฑํ•จ(์ผ์‹œ์ ์ธ ์ƒํƒœ์ผ ์ˆ˜ ์žˆ์Œ) - FAILED - ํ•˜๋‚˜ ์ด์ƒ์˜ ์ง€๊ธ‰ ๋ช…๋ น์ด ์‹คํŒจํ•จ" + }, + "PayoutStatus": { + "oneOf": [ + { + "const": "REGISTERED" + }, + { + "const": "VERIFYING" + }, + { + "const": "IN_PROGRESS" + }, + { + "const": "DONE" + }, + { + "const": "INSUFFICIENT_BALANCE" + }, + { + "const": "FAILED" + } + ], + "description": "- REQUESTED ๋ชจ๋“  ์„ธ๋ถ€ ์ •๋ณด์™€ ํ•จ๊ป˜ ์ง€๊ธ‰ ์š”์ฒญ๋จ - VERIFIED ์ง€๊ธ‰ ์ง€์นจ ์„ธํŠธ ์„ธ๋ถ€ ์ •๋ณด๊ฐ€ ๊ฒ€์ฆ๋จ - PROCESSING ์ง€๊ธ‰ ์ง€์นจ ์„ธํŠธ๊ฐ€ ์‹คํ–‰๋˜์–ด ์ฒ˜๋ฆฌ ์ค‘ - FINALIZED ์ง€๊ธ‰ ์™„๋ฃŒ(๋ชจ๋“  ์ง€๊ธ‰ ์ง€์นจ์ด ์„ฑ๊ณต์ ์œผ๋กœ ์™„๋ฃŒ๋จ) - INSUFFICIENT_BALANCE ์ง€๊ธ‰ ๊ณ„์ขŒ์˜ ์ž”์•ก์ด ๋ถ€์กฑํ•จ(์ผ์‹œ์ ์ธ ์ƒํƒœ์ผ ์ˆ˜ ์žˆ์Œ) - FAILED ํ•˜๋‚˜ ์ด์ƒ์˜ ์ง€๊ธ‰ ์ง€์นจ์ด ์‹คํŒจํ•จ" + }, + "PayoutInitMethod": { + "oneOf": [ + { + "const": "FILE" + }, + { + "const": "API" + } + ] + }, + "PayoutInstructionResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "payeeAccount": { + "$ref": "#/components/schemas/PayeeAccountResponse" + }, + "amount": { + "$ref": "#/components/schemas/InstructionAmount" + }, + "state": { + "$ref": "#/components/schemas/PayoutInstructionState" + }, + "transactions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Transaction" + } + } + }, + "required": [ + "amount", + "payeeAccount", + "state", + "transactions" + ] + }, + "PayeeAccountResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/PayeeAccountType" + } + } + }, + "PayoutInstructionState": { + "oneOf": [ + { + "const": "NOT_STARTED" + }, + { + "const": "TRANSACTION_SENT" + }, + { + "const": "COMPLETED" + }, + { + "const": "FAILED" + }, + { + "const": "TRANSLATION_ERROR" + }, + { + "const": "SKIPPED" + } + ], + "description": "- NOT_STARTED - ์‹œ์ž‘ ๋Œ€๊ธฐ - TRANSACTION_SENT - ๊ธฐ๋ณธ ํŠธ๋žœ์žญ์…˜์ด ์ „์†ก๋จ - COMPLETED - ์„ฑ๊ณต์ ์œผ๋กœ ์™„๋ฃŒ๋จ - FAILED - ์‹คํŒจ - TRANSLATION_ERROR - ๋Œ€์ƒ ์กฐํšŒ ์‹คํŒจ(๊ธฐ๋ณธ ํ—ˆ์šฉ ๋ชฉ๋ก ์™ธ๋ถ€ ์ง€๊ฐ‘ ๋˜๋Š” ์œ ์‚ฌํ•œ ํ•ญ๋ชฉ์˜ ๋ณ€๊ฒฝ์œผ๋กœ ์ธํ•ด) - SKIPPED - ์ด ๋ช…๋ น์— ๋Œ€ํ•œ ํŠธ๋žœ์žญ์…˜์ด ์ƒ์„ฑ๋˜์ง€ ์•Š์Œ" + }, + "Transaction": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "state": { + "oneOf": [ + { + "const": "SUBMITTED" + }, + { + "const": "QUEUED" + }, + { + "const": "PENDING_AUTHORIZATION" + }, + { + "const": "PENDING_SIGNATURE" + }, + { + "const": "BROADCASTING" + }, + { + "const": "PENDING_3RD_PARTY_MANUAL_APPROVAL" + }, + { + "const": "PENDING_3RD_PARTY" + }, + { + "const": "PENDING" + }, + { + "const": "CONFIRMING" + }, + { + "const": "CONFIRMED" + }, + { + "const": "COMPLETED" + }, + { + "const": "PARTIALLY_COMPLETED" + }, + { + "const": "PENDING_AML_SCREENING" + }, + { + "const": "CANCELLING" + }, + { + "const": "CANCELLED" + }, + { + "const": "REJECTED" + }, + { + "const": "BLOCKED" + }, + { + "const": "FAILED" + }, + { + "const": "TIMEOUT" + } + ] + }, + "timestamp": { + "type": "number", + "format": "date-time" + }, + "instructionId": { + "type": "string" + } + }, + "required": [ + "id", + "state" + ] + }, + "DispatchPayoutResponse": { + "type": "object", + "properties": { + "payoutId": { + "type": "string" + } + }, + "required": [ + "payoutId" + ] + }, + "TravelRuleAddress": { + "type": "object", + "properties": { + "street": { + "type": "string", + "example": "1234 Example St", + "description": "๊ฑฐ๋ฆฌ ์ฃผ์†Œ" + }, + "city": { + "type": "string", + "example": "New York", + "description": "๋„์‹œ" + }, + "state": { + "type": "string", + "example": "NY", + "description": "์ฃผ ๋˜๋Š” ๋„" + }, + "postalCode": { + "type": "string", + "example": "10001", + "description": "์šฐํŽธ๋ฒˆํ˜ธ" + } + }, + "required": [ + "street", + "city", + "state", + "postalCode" + ] + }, + "TravelRuleValidateTransactionRequest": { + "type": "object", + "properties": { + "transactionAsset": { + "type": "string", + "example": "BTC", + "description": "๊ฑฐ๋ž˜ ์ž์‚ฐ ๊ธฐํ˜ธ BTC,ETH)" + }, + "destination": { + "type": "string", + "example": "bc1qxy2kgdygjrsqtzq2n0yrf1234p83kkfjhx0wlh", + "description": "๊ฑฐ๋ž˜ ๋ชฉ์ ์ง€ ์ฃผ์†Œ" + }, + "transactionAmount": { + "type": "string", + "example": "10", + "description": "๊ฑฐ๋ž˜์ž์‚ฐ์˜ ๊ฑฐ๋ž˜๊ธˆ์•ก" + }, + "originatorVASPdid": { + "type": "string", + "example": "did:ethr:0x44957e75d6ce4a5bf37aae117da86422c848f7c2", + "description": "์ด๋Š” ๊ท€ํ•˜์˜ VASP์— ํ• ๋‹น๋œ ์‹๋ณ„์ž์ž…๋‹ˆ๋‹ค." + }, + "originatorEqualsBeneficiary": { + "type": "boolean", + "example": false, + "description": "๋ฐœ์‹ ์ž์™€ ์ˆ˜ํ˜œ์ž๊ฐ€ ๊ฐ™์€ ์‚ฌ๋žŒ์ด์–ด์„œ ์ •๋ณด๋ฅผ ์ˆ˜์ง‘ํ•  ํ•„์š”๊ฐ€ ์—†๋Š” ๊ฒฝ์šฐ "์ฐธ"์ž…๋‹ˆ๋‹ค. ์ œ3์ž ์ด์ฒด์ธ ๊ฒฝ์šฐ "๊ฑฐ์ง“"์ž…๋‹ˆ๋‹ค.." + }, + "travelRuleBehavior": { + "type": "boolean", + "example": true, + "description": "์ด๋Š” ๋˜ํ•œ ํ•ด๋‹น ๊ฑฐ๋ž˜๊ฐ€ ์ˆ˜ํ˜œ์ž VASP์˜ ๊ด€ํ• ๊ถŒ์—์„œ TRAVEL_RULE์ธ์ง€ ํ™•์ธํ•ฉ๋‹ˆ๋‹ค." + }, + "beneficiaryVASPdid": { + "type": "string", + "example": "did:ethr:0x46a7ed5813ce735387df2bfb245bd7722e0de992", + "description": "์ด๋Š” ์ž๊ธˆ์ด ์ „์†ก๋˜๋Š” VASP์— ํ• ๋‹น๋œ ์‹๋ณ„์ž์ž…๋‹ˆ๋‹ค." + }, + "beneficiaryVASPname": { + "type": "string", + "example": "HelloCrypto", + "description": "์ˆ˜ํ˜œ์ž VASP ์ด๋ฆ„" + }, + "beneficiaryName": { + "type": "string", + "example": "John Doe", + "description": "์ˆ˜ํ˜œ์ž ์ด๋ฆ„" + }, + "beneficiaryAccountNumber": { + "type": "string", + "example": "1234-1234-1234-12234", + "description": "์ˆ˜ํ˜œ์ž ์ด๋ฆ„" + }, + "beneficiaryAddress": { + "example": "{\"addressLine: [Wayne Manor, Gotham City, New York, USA]\"}", + "description": "์ˆ˜ํ˜œ์ž ์ด๋ฆ„", + "type": "object", + "properties": { + "street": { + "type": "string", + "example": "1234 Example St", + "description": "๊ฑฐ๋ฆฌ ์ฃผ์†Œ" + }, + "city": { + "type": "string", + "example": "New York", + "description": "๋„์‹œ" + }, + "state": { + "type": "string", + "example": "NY", + "description": "์ฃผ ๋˜๋Š” ๋„" + }, + "postalCode": { + "type": "string", + "example": "10001", + "description": "์šฐํŽธ๋ฒˆํ˜ธ" + } + } + } + }, + "required": [ + "transactionAsset", + "destination", + "transactionAmount", + "originatorVASPdid", + "originatorEqualsBeneficiary", + "travelRuleBehavior", + "beneficiaryVASPdid", + "beneficiaryVASPname", + "beneficiaryName", + "beneficiaryAccountNumber", + "beneficiaryAddress" + ] + }, + "TravelRuleValidateTransactionResponse": { + "type": "object", + "properties": { + "isValid": { + "type": "boolean", + "description": ""isValid"๋Š” ์—ฌํ–‰ ๊ทœ์น™ ๋ฐ์ดํ„ฐ ์ „์†ก์— ํ•„์š”ํ•œ ๋ชจ๋“  ์ •๋ณด๋ฅผ ์ˆ˜์ง‘ํ–ˆ๋Š”์ง€ ์•Œ๋ ค์ค๋‹ˆ๋‹ค. ์ด ํ•„๋“œ๊ฐ€ "true"์ด๋ฉด ๋‹ค์Œ ๋‹จ๊ณ„๋กœ ๋„˜์–ด๊ฐ€ ํ”„๋ŸฐํŠธ์—”๋“œ ์ •๋ณด๋ฅผ ๋ฐฑ์—”๋“œ๋กœ ์ „์†กํ•˜๊ณ  ์—ฌํ–‰ ๊ทœ์น™ ๊ฑฐ๋ž˜ ์ƒ์„ฑ์„ ์ˆ˜ํ–‰ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.", + "example": true + }, + "type": { + "type": "string", + "description": ""type"์€ ์ถœ๊ธˆ ์š”์ฒญ์˜ FIAT ๊ฐ€์น˜๋กœ ๋ณ€ํ™˜๋œ ๊ฐ€์ƒ ์ž์‚ฐ ๊ฐ€์น˜๊ฐ€ ๊ด€ํ• ๊ถŒ์˜ ์ž„๊ณ„๊ฐ’๋ณด๋‹ค ๋†’๊ฑฐ๋‚˜(=TRAVELRULE) ๋‚ฎ๊ฑฐ๋‚˜(=BELOW_THRESHOLD) ๋‚ฎ์€์ง€ ์•Œ๋ ค์ค๋‹ˆ๋‹ค. ์—ฌํ–‰ ๊ทœ์น™ ์ •๋ณด๋ฅผ ๋ณด๋‚ด์ง€ ์•Š๊ณ  ์ˆ˜์ง‘๋งŒ ํ•˜๋Š” ํ˜ธ์ŠคํŒ…๋˜์ง€ ์•Š์€ ์ง€๊ฐ‘์ธ ๊ฒฝ์šฐ NON_CUSTODIAL์ด๋ผ๊ณ  ํ‘œ์‹œ๋ฉ๋‹ˆ๋‹ค..", + "example": "TRAVELRULE" + }, + "beneficiaryAddressType": { + "type": "string", + "description": ""beneficiaryAddressType"์€ ๋ธ”๋ก์ฒด์ธ ๋ถ„์„ ์ œ๊ณต์ž ๋˜๋Š” ๋‚ด๋ถ€ ์ฃผ์†Œ๋ก์ด ์ง€๊ฐ‘ ์ฃผ์†Œ๋ฅผ ์‹๋ณ„ํ•  ์ˆ˜ ์žˆ์—ˆ๋Š”์ง€ ์•Œ๋ ค์ค๋‹ˆ๋‹ค..", + "example": "UNKNOWN" + }, + "addressSource": { + "type": "string", + "description": ""addressSource"๋Š” ์ฃผ์†Œ๊ฐ€ ๋‚ด๋ถ€ ์ฃผ์†Œ๋ก์—์„œ ๋ฐœ๊ฒฌ๋˜์—ˆ๋Š”์ง€ ๋˜๋Š” ๋ธ”๋ก์ฒด์ธ ๋ถ„์„ ์ œ๊ณต์ž๊ฐ€ ์‹๋ณ„ํ–ˆ๋Š”์ง€ ์•Œ๋ ค์ค๋‹ˆ๋‹ค..", + "example": "UNKNOWN" + }, + "beneficiaryVASPdid": { + "type": "string", + "description": "์ˆ˜ํ˜œ์ž VASP์˜ VASP DID", + "example": "did:ethr:0x46a7ed5813ce735387df2bfb245bd7722e0de992" + }, + "beneficiaryVASPname": { + "type": "string", + "description": ""beneficiaryVASPname"์€ ์ง€๊ฐ‘ ์ฃผ์†Œ์˜ ์†Œ์œ ์ž๋กœ ์‹๋ณ„๋œ VASP์˜ ์ด๋ฆ„์„ ์•Œ๋ ค์ค๋‹ˆ๋‹ค. ์ด ์ด๋ฆ„์€ ํ›„์† ํ˜ธ์ถœ์—์„œ DID๋ฅผ ๊ฐ€์ ธ์˜ค๋Š” ๋ฐ ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค..", + "example": "Fireblocks" + }, + "warnings": { + "description": ""์˜ค๋ฅ˜/๊ฒฝ๊ณ "๋Š” ๋ฐœ์‹ ์ž๋กœ๋ถ€ํ„ฐ ์ˆ˜ํ˜œ์ž์— ๋Œ€ํ•œ ์–ด๋–ค ์ •๋ณด๋ฅผ ์ˆ˜์ง‘ํ•ด์•ผ ํ•˜๋Š”์ง€ ์•Œ๋ ค์ค๋‹ˆ๋‹ค..", + "example": [ + "optional-beneficiaryAccountNumber" + ], + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "isValid", + "type", + "beneficiaryAddressType", + "addressSource", + "beneficiaryVASPdid", + "beneficiaryVASPname", + "warnings" + ] + }, + "TravelRuleTransactionBlockchainInfo": { + "type": "object", + "properties": { + "txHash": { + "type": "string" + }, + "origin": { + "type": "string" + }, + "destination": { + "type": "string" + } + }, + "required": [ + "txHash", + "origin", + "destination" + ] + }, + "TravelRulePiiIVMS": { + "type": "object", + "properties": { + "fullName": { + "type": "string" + }, + "dateOfBirth": { + "type": "string" + }, + "placeOfBirth": { + "type": "string" + }, + "address": { + "type": "string" + }, + "identificationNumber": { + "type": "string" + }, + "nationality": { + "type": "string" + }, + "countryOfResidence": { + "type": "string" + }, + "taxIdentificationNumber": { + "type": "string" + }, + "customerNumber": { + "type": "string" + } + }, + "required": [ + "fullName", + "dateOfBirth", + "placeOfBirth", + "address", + "identificationNumber", + "nationality", + "countryOfResidence", + "taxIdentificationNumber", + "customerNumber" + ] + }, + "TravelRuleOwnershipProof": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "passport", + "description": "์†Œ์œ ๊ถŒ ์ฆ๋ช…์˜ ์ข…๋ฅ˜" + }, + "id": { + "type": "string", + "example": "123456789", + "description": "์‹๋ณ„๋ฒˆํ˜ธ" + }, + "name": { + "type": "string", + "example": "Alice", + "description": "์†Œ์œ ์ž ์ด๋ฆ„" + }, + "country": { + "type": "string", + "example": "US", + "description": "๋ฐœํ–‰ ๊ตญ๊ฐ€" + }, + "issueDate": { + "type": "string", + "example": "2022-01-01", + "description": "๋ฐœํ–‰์ผ์ž" + }, + "issuer": { + "type": "string", + "example": "US Government", + "description": "๋ฐœ๊ธ‰ ๊ธฐ๊ด€ ์ด๋ฆ„" + } + }, + "required": [ + "type", + "id", + "name", + "country", + "issueDate", + "issuer" + ] + }, + "TravelRuleValidateFullTransactionRequest": { + "type": "object", + "properties": { + "transactionAsset": { + "type": "string", + "description": "๊ฑฐ๋ž˜์— ๊ด€๋ จ๋œ ์ž์‚ฐ" + }, + "transactionAmount": { + "type": "string", + "description": "๊ฑฐ๋ž˜๊ธˆ์•ก" + }, + "originatorDid": { + "type": "string", + "description": "๊ฑฐ๋ž˜ ๋ฐœ์‹ ์ž์˜ DID" + }, + "beneficiaryDid": { + "type": "string", + "description": "๊ฑฐ๋ž˜ ์ˆ˜ํ˜œ์ž์˜ DID" + }, + "originatorVASPdid": { + "type": "string", + "description": "๊ฑฐ๋ž˜ ๋ฐœ์‹ ์ž์˜ VASP ID" + }, + "beneficiaryVASPdid": { + "type": "string", + "description": "๊ฑฐ๋ž˜ ์ˆ˜ํ˜œ์ž์˜ VASP ID" + }, + "beneficiaryVASPname": { + "type": "string", + "description": "์ˆ˜ํ˜œ์ž๋กœ์„œ ํ™œ๋™ํ•˜๋Š” VASP์˜ ์ด๋ฆ„" + }, + "transactionBlockchainInfo": { + "description": "๋ธ”๋ก์ฒด์ธ ๊ฑฐ๋ž˜์— ๋Œ€ํ•œ ์ •๋ณด", + "type": "object", + "properties": { + "txHash": { + "type": "string" + }, + "origin": { + "type": "string" + }, + "destination": { + "type": "string" + } + } + }, + "originator": { + "description": "๊ฑฐ๋ž˜ ๋ฐœ์‹ ์ž์— ๋Œ€ํ•œ ์ •๋ณด", + "type": "object", + "properties": { + "fullName": { + "type": "string" + }, + "dateOfBirth": { + "type": "string" + }, + "placeOfBirth": { + "type": "string" + }, + "address": { + "type": "string" + }, + "identificationNumber": { + "type": "string" + }, + "nationality": { + "type": "string" + }, + "countryOfResidence": { + "type": "string" + }, + "taxIdentificationNumber": { + "type": "string" + }, + "customerNumber": { + "type": "string" + } + } + }, + "beneficiary": { + "description": "๊ฑฐ๋ž˜ ์ˆ˜ํ˜œ์ž์— ๋Œ€ํ•œ ์ •๋ณด", + "type": "object", + "properties": { + "fullName": { + "type": "string" + }, + "dateOfBirth": { + "type": "string" + }, + "placeOfBirth": { + "type": "string" + }, + "address": { + "type": "string" + }, + "identificationNumber": { + "type": "string" + }, + "nationality": { + "type": "string" + }, + "countryOfResidence": { + "type": "string" + }, + "taxIdentificationNumber": { + "type": "string" + }, + "customerNumber": { + "type": "string" + } + } + }, + "encrypted": { + "type": "string", + "description": "๊ฑฐ๋ž˜์™€ ๊ด€๋ จ๋œ ์•”ํ˜ธํ™”๋œ ๋ฐ์ดํ„ฐ" + }, + "protocol": { + "type": "string", + "description": "์—ฌํ–‰ ๊ทœ์น™์„ ์ˆ˜ํ–‰ํ•˜๋Š” ๋ฐ ์‚ฌ์šฉ๋˜๋Š” ํ”„๋กœํ† ์ฝœ" + }, + "notificationEmail": { + "type": "string", + "description": "์—ฌํ–‰ ๊ทœ์ • ์™„๋ฃŒ ์‹œ ์•Œ๋ฆผ์„ ๋ณด๋‚ด์•ผ ํ•˜๋Š” ์ด๋ฉ”์ผ ์ฃผ์†Œ" + }, + "skipBeneficiaryDataValidation": { + "type": "boolean", + "description": "์ˆ˜ํ˜œ์ž ๋ฐ์ดํ„ฐ ๊ฒ€์ฆ์„ ๊ฑด๋„ˆ๋›ธ์ง€ ์—ฌ๋ถ€" + }, + "travelRuleBehavior": { + "type": "boolean", + "description": "์ˆ˜ํ˜œ์ž VASP์˜ ๊ด€ํ• ๊ถŒ์—์„œ ๊ฑฐ๋ž˜๊ฐ€ TRAVEL_RULE์ธ์ง€ ํ™•์ธํ• ์ง€ ์—ฌ๋ถ€" + }, + "originatorProof": { + "description": "๊ฑฐ๋ž˜ ๋ฐœ์ฃผ์ž์™€ ๊ด€๋ จ๋œ ์†Œ์œ ๊ถŒ ์ฆ๋ช…", + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "passport", + "description": "์†Œ์œ ๊ถŒ ์ฆ๋ช…์˜ ์ข…๋ฅ˜" + }, + "id": { + "type": "string", + "example": "123456789", + "description": "์‹๋ณ„๋ฒˆํ˜ธ" + }, + "name": { + "type": "string", + "example": "Alice", + "description": "์†Œ์œ ์ž ์ด๋ฆ„" + }, + "country": { + "type": "string", + "example": "US", + "description": "๋ฐœํ–‰ ๊ตญ๊ฐ€" + }, + "issueDate": { + "type": "string", + "example": "2022-01-01", + "description": "๋ฐœํ–‰์ผ์ž" + }, + "issuer": { + "type": "string", + "example": "US Government", + "description": "๋ฐœ๊ธ‰ ๊ธฐ๊ด€ ์ด๋ฆ„" + } + } + }, + "beneficiaryProof": { + "description": "๊ฑฐ๋ž˜ ์ˆ˜ํ˜œ์ž์™€ ๊ด€๋ จ๋œ ์†Œ์œ ๊ถŒ ์ฆ๋น™", + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "passport", + "description": "์†Œ์œ ๊ถŒ ์ฆ๋ช…์˜ ์ข…๋ฅ˜" + }, + "id": { + "type": "string", + "example": "123456789", + "description": "์‹๋ณ„๋ฒˆํ˜ธ" + }, + "name": { + "type": "string", + "example": "Alice", + "description": "์†Œ์œ ์ž ์ด๋ฆ„" + }, + "country": { + "type": "string", + "example": "US", + "description": "๋ฐœํ–‰ ๊ตญ๊ฐ€" + }, + "issueDate": { + "type": "string", + "example": "2022-01-01", + "description": "๋ฐœํ–‰์ผ์ž" + }, + "issuer": { + "type": "string", + "example": "US Government", + "description": "๋ฐœ๊ธ‰ ๊ธฐ๊ด€ ์ด๋ฆ„" + } + } + }, + "pii": { + "description": "๊ฑฐ๋ž˜์™€ ๊ด€๋ จ๋œ ๊ฐœ์ธ์‹๋ณ„์ •๋ณด", + "type": "object", + "properties": { + "fullName": { + "type": "string" + }, + "dateOfBirth": { + "type": "string" + }, + "placeOfBirth": { + "type": "string" + }, + "address": { + "type": "string" + }, + "identificationNumber": { + "type": "string" + }, + "nationality": { + "type": "string" + }, + "countryOfResidence": { + "type": "string" + }, + "taxIdentificationNumber": { + "type": "string" + }, + "customerNumber": { + "type": "string" + } + } + } + }, + "required": [ + "transactionAsset", + "transactionAmount", + "originatorDid", + "beneficiaryDid", + "originatorVASPdid", + "beneficiaryVASPdid", + "beneficiaryVASPname", + "transactionBlockchainInfo", + "originator", + "beneficiary", + "encrypted", + "protocol", + "notificationEmail", + "skipBeneficiaryDataValidation", + "travelRuleBehavior", + "originatorProof", + "beneficiaryProof", + "pii" + ] + }, + "TravelRuleIssuer": { + "type": "object", + "properties": { + "issuerDid": { + "type": "string" + } + }, + "required": [ + "issuerDid" + ] + }, + "TravelRuleIssuers": { + "type": "object", + "properties": { + "yearFounded": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "isRegulated": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "regulatoryAuthorities": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "name": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "logo": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "website": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "legalName": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "legalStructure": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "incorporationCountry": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "businessNumber": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "addressLine1": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "city": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "country": { + "$ref": "#/components/schemas/TravelRuleIssuer" + }, + "description": { + "$ref": "#/components/schemas/TravelRuleIssuer" + } + }, + "required": [ + "yearFounded", + "isRegulated", + "regulatoryAuthorities", + "name", + "logo", + "website", + "legalName", + "legalStructure", + "incorporationCountry", + "businessNumber", + "addressLine1", + "city", + "country", + "description" + ] + }, + "TravelRuleVASP": { + "type": "object", + "properties": { + "did": { + "type": "string" + }, + "name": { + "type": "string" + }, + "verificationStatus": { + "type": "string" + }, + "addressLine1": { + "type": "string" + }, + "addressLine2": { + "type": "string" + }, + "city": { + "type": "string" + }, + "country": { + "type": "string" + }, + "emailDomains": { + "type": "string" + }, + "website": { + "type": "string" + }, + "logo": { + "type": "string" + }, + "legalStructure": { + "type": "string" + }, + "legalName": { + "type": "string" + }, + "yearFounded": { + "type": "string" + }, + "incorporationCountry": { + "type": "string" + }, + "isRegulated": { + "type": "string" + }, + "otherNames": { + "type": "string" + }, + "identificationType": { + "type": "string" + }, + "identificationCountry": { + "type": "string" + }, + "businessNumber": { + "type": "string" + }, + "regulatoryAuthorities": { + "type": "string" + }, + "jurisdictions": { + "type": "string" + }, + "street": { + "type": "string" + }, + "number": { + "type": "string" + }, + "unit": { + "type": "string" + }, + "postCode": { + "type": "string" + }, + "state": { + "type": "string" + }, + "certificates": { + "type": "string" + }, + "description": { + "type": "string" + }, + "travelRule_OPENVASP": { + "type": "string" + }, + "travelRule_SYGNA": { + "type": "string" + }, + "travelRule_TRISA": { + "type": "string" + }, + "travelRule_TRLIGHT": { + "type": "string" + }, + "travelRule_EMAIL": { + "type": "string" + }, + "travelRule_TRP": { + "type": "string" + }, + "travelRule_SHYFT": { + "type": "string" + }, + "travelRule_USTRAVELRULEWG": { + "type": "string" + }, + "createdAt": { + "type": "string" + }, + "createdBy": { + "type": "string" + }, + "updatedAt": { + "type": "string" + }, + "updatedBy": { + "type": "string" + }, + "lastSentDate": { + "type": "string" + }, + "lastReceivedDate": { + "type": "string" + }, + "documents": { + "type": "string" + }, + "hasAdmin": { + "type": "boolean" + }, + "isNotifiable": { + "type": "boolean" + }, + "issuers": { + "$ref": "#/components/schemas/TravelRuleIssuers" + } + }, + "required": [ + "did", + "name", + "verificationStatus", + "addressLine1", + "addressLine2", + "city", + "country", + "emailDomains", + "website", + "logo", + "legalStructure", + "legalName", + "yearFounded", + "incorporationCountry", + "isRegulated", + "otherNames", + "identificationType", + "identificationCountry", + "businessNumber", + "regulatoryAuthorities", + "jurisdictions", + "street", + "number", + "unit", + "postCode", + "state", + "certificates", + "description", + "travelRule_OPENVASP", + "travelRule_SYGNA", + "travelRule_TRISA", + "travelRule_TRLIGHT", + "travelRule_EMAIL", + "travelRule_TRP", + "travelRule_SHYFT", + "travelRule_USTRAVELRULEWG", + "createdAt", + "createdBy", + "updatedAt", + "updatedBy", + "lastSentDate", + "lastReceivedDate", + "documents", + "hasAdmin", + "isNotifiable", + "issuers" + ] + }, + "TravelRuleGetAllVASPsResponse": { + "type": "object", + "properties": { + "vasps": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TravelRuleVASP" + } + } + }, + "required": [ + "vasps" + ] + }, + "TravelRuleUpdateVASPDetails": { + "type": "object", + "properties": { + "did": { + "type": "string", + "example": "did:ethr:0x44957e75d6ce4a5bf37aae117da86422c848f7c2", + "description": "VASP์˜ ๋ถ„์‚ฐ ์‹๋ณ„์ž" + }, + "pii_didkey": { + "type": "string", + "example": "did:key:z6Mks5CZRaiooKYhq5TwtXQC1gWhwiZnmiKfFrMnYY62MhYf", + "description": "VASP์˜ PII DID ํ‚ค" + } + }, + "required": [ + "did", + "pii_didkey" + ] + }, + "PolicySrcOrDestType": { + "oneOf": [ + { + "const": "EXCHANGE" + }, + { + "const": "UNMANAGED" + }, + { + "const": "VAULT" + }, + { + "const": "NETWORK_CONNECTION" + }, + { + "const": "COMPOUND" + }, + { + "const": "FIAT_ACCOUNT" + }, + { + "const": "ONE_TIME_ADDRESS" + }, + { + "const": "*" + } + ], + "description": "* EXCHANGE - ์ž‘์—… ๊ณต๊ฐ„์— ์—ฐ๊ฒฐ๋œ ํƒ€์‚ฌ ๊ฑฐ๋ž˜์†Œ ๊ณ„์ • * UNMANAGED - Fireblocks ์ž‘์—… ๊ณต๊ฐ„ ์™ธ๋ถ€์˜ ๊ด€๋ฆฌ๋˜์ง€ ์•Š๋Š” ์ง€๊ฐ‘ * VAULT - Fireblocks Vault์˜ ๊ณ„์ • * NETWORK_CONNECTION - Fireblocks ๋„คํŠธ์›Œํฌ์˜ ์—ฐ๊ฒฐ * COMPOUND - (๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ) Compound DeFI ํ”„๋กœํ† ์ฝœ์„ ์‚ฌ์šฉํ•˜์—ฌ ๊ฒ€์ƒ‰ํ•œ ์ž์‚ฐ * FIAT_ACCOUNT - ์ž‘์—… ๊ณต๊ฐ„์— ์—ฐ๊ฒฐ๋œ ํƒ€์‚ฌ ๋ฒ•์ • ํ†ตํ™” ๊ณ„์ • * ONE_TIME_ADDRESS - Fireblocks ์ž‘์—… ๊ณต๊ฐ„์˜ ํ—ˆ์šฉ ๋ชฉ๋ก์— ์—†๋Š” ์ž์‚ฐ * "*" - ๋ชจ๋“  ์œ ํ˜•" + }, + "PolicySrcOrDestSubType": { + "oneOf": [ + { + "const": "EXTERNAL" + }, + { + "const": "INTERNAL" + }, + { + "const": "CONTRACT" + }, + { + "const": "EXCHANGETEST" + }, + { + "const": "*" + } + ], + "description": "* EXTERNAL - ์™ธ๋ถ€๋กœ ์ง€์ •๋œ ํ—ˆ์šฉ ๋ชฉ๋ก ์ง€๊ฐ‘์€ ์ผ๋ฐ˜์ ์œผ๋กœ ํด๋ผ์ด์–ธํŠธ์™€ ์ƒ๋Œ€๋ฐฉ์ด ๊ด€๋ฆฌํ•˜๋Š” ์ฃผ์†Œ์— ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. * INTERNAL - ๋‚ด๋ถ€๋กœ ์ง€์ •๋œ ํ—ˆ์šฉ ๋ชฉ๋ก ์ง€๊ฐ‘์€ ์ผ๋ฐ˜์ ์œผ๋กœ Fireblocks ์ž‘์—… ๊ณต๊ฐ„ ์™ธ๋ถ€์—์„œ ์ œ์–ดํ•˜๋Š” ์ฃผ์†Œ์— ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. * CONTRACT - ๊ณ„์•ฝ์œผ๋กœ ์ง€์ •๋œ ํ—ˆ์šฉ ๋ชฉ๋ก ์ง€๊ฐ‘์€ ์™ธ๋ถ€ ์Šค๋งˆํŠธ ๊ณ„์•ฝ์„ ์‹๋ณ„ํ•˜๊ณ  ๊ด€๋ฆฌํ•˜๊ธฐ ์œ„ํ•œ ๊ฒƒ์ž…๋‹ˆ๋‹ค. * EXCHANGETEST - ํ…Œ์ŠคํŠธ๋„ท ์ž์‚ฐ์—์„œ๋งŒ ์ž‘๋™ํ•˜๋Š” ๊ฑฐ๋ž˜์†Œ * "*" - ๋ชจ๋“  ํ•˜์œ„ ์œ ํ˜•" + }, + "PolicySrcOrDestId": { + "type": "string", + "description": "๊ณ„์ • ID๋ฅผ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค. ์˜ต์…˜์€ ๋‹ค์Œ๊ณผ ๊ฐ™์Šต๋‹ˆ๋‹ค. * "*" - ๋ชจ๋“  ๊ณ„์ • * ํŠน์ • ๊ณ„์ • ID" + }, + "AmountAggregationTimePeriodMethod": { + "oneOf": [ + { + "const": "PER_SINGLE_MATCH" + }, + { + "const": "ACROSS_ALL_MATCHES" + } + ], + "description": "* PER_SINGLE_MATCH - ๋‚˜์—ด๋œ ๊ฐ ์—”ํ„ฐํ‹ฐ์— ์ œํ•œ์„ ์ ์šฉํ•ฉ๋‹ˆ๋‹ค. * ACROSS_ALL_MATCHES - ๋‚˜์—ด๋œ ๋ชจ๋“  ์—”ํ„ฐํ‹ฐ์˜ ํ•ฉ๊ณ„์— ์ œํ•œ์„ ์ ์šฉํ•ฉ๋‹ˆ๋‹ค." + }, + "PolicyRule": { + "type": "object", + "description": "๊ฑฐ๋ž˜์— ์ ์šฉ๋˜๋Š” ์ •์ฑ… ๊ทœ์น™", + "properties": { + "operator": { + "type": "string", + "description": "(๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ - "์—ฐ์‚ฐ์ž"๋กœ ๋Œ€์ฒด๋จ) | ๊ทœ์น™์ด ์ ์šฉ๋˜๋Š” ๊ฑฐ๋ž˜ ์œ ํ˜•์„ ์‹œ์ž‘ํ•  ์ˆ˜ ์žˆ๋Š” ์‚ฌ์šฉ์ž๋ฅผ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค. ์˜ต์…˜์€ ๋‹ค์Œ๊ณผ ๊ฐ™์Šต๋‹ˆ๋‹ค. * "*" - ๋ชจ๋“  ์‚ฌ์šฉ์ž๊ฐ€ ํ—ˆ์šฉ๋ฉ๋‹ˆ๋‹ค. * ํŠน์ • ์‚ฌ์šฉ์ž ID", + "deprecated": true + }, + "operators": { + "type": "object", + "description": "๊ทœ์น™์ด ์ ์šฉ๋˜๋Š” ๊ฑฐ๋ž˜ ์œ ํ˜•์„ ์‹œ์ž‘ํ•  ์ˆ˜ ์žˆ๋Š” ์‚ฌ์šฉ์ž/๊ทธ๋ฃน์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค..", + "properties": { + "wildcard": { + "const": "*", + "description": "์‚ฌ์šฉํ•˜๋Š” ๊ฒฝ์šฐ ์ด ์†์„ฑ์€ ์œ ์ผํ•œ ์ž์‹ ์†์„ฑ์œผ๋กœ ํ‘œ์‹œ๋˜์–ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. * "*" - ๋ชจ๋“  ์‚ฌ์šฉ์ž๊ฐ€ ํ—ˆ์šฉ๋ฉ๋‹ˆ๋‹ค." + }, + "users": { + "type": "array", + "description": "์‚ฌ์šฉ์ž ID ์„ธํŠธ", + "items": { + "type": "string" + } + }, + "usersGroups": { + "type": "array", + "description": "๊ทธ๋ฃน ID ์„ธํŠธ", + "items": { + "type": "string" + } + }, + "services": { + "type": "array", + "description": "๊ฑฐ๋ž˜๋ฅผ ์‹œ์ž‘ํ•˜๊ธฐ ์œ„ํ•œ ์„œ๋น„์Šค ์„ธํŠธ", + "items": { + "type": "string" + } + } + } + }, + "transactionType": { + "oneOf": [ + { + "const": "TRANSFER" + }, + { + "const": "CONTRACT_CALL" + }, + { + "const": "APPROVE" + }, + { + "const": "MINT" + }, + { + "const": "BURN" + }, + { + "const": "SUPPLY" + }, + { + "const": "REDEEM" + }, + { + "const": "STAKE" + }, + { + "const": "RAW" + }, + { + "const": "TYPED_MESSAGE" + } + ], + "description": "๊ทœ์น™์ด ์ ์šฉ๋˜๋Š” ๊ฑฐ๋ž˜ ์œ ํ˜•์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค. * TRANSFER - ๊ธฐ๋ณธ๊ฐ’. ํ•œ ๊ณ„์ •์—์„œ ๋‹ค๋ฅธ ๊ณ„์ •์œผ๋กœ ์ž๊ธˆ์„ ์ด์ฒดํ•ฉ๋‹ˆ๋‹ค. * CONTRACT_CALL - ์ฃผ๋กœ DeFi ์ž‘์—…์„ ์œ„ํ•œ ์Šค๋งˆํŠธ ๊ณ„์•ฝ์„ ํ˜ธ์ถœํ•ฉ๋‹ˆ๋‹ค. * APPROVE - ์Šค๋งˆํŠธ ๊ณ„์•ฝ์ด ์ง€์ •๋œ ์ง€๊ฐ‘์—์„œ ์ธ์ถœํ•  ์ˆ˜ ์žˆ๋„๋ก ํ•ฉ๋‹ˆ๋‹ค. * MINT - ์ง€์›๋˜๋Š” ํ† ํฐ์—์„œ ๋ฏผํŠธ ์ž‘์—…(๊ณต๊ธ‰ ์ฆ๊ฐ€)์„ ์ˆ˜ํ–‰ํ•ฉ๋‹ˆ๋‹ค. * BURN - ์ง€์›๋˜๋Š” ํ† ํฐ์—์„œ ์†Œ๊ฐ ์ž‘์—…(๊ณต๊ธ‰ ๊ฐ์†Œ)์„ ์ˆ˜ํ–‰ํ•ฉ๋‹ˆ๋‹ค. * SUPPLY - DeFi์—์„œ ์ž์‚ฐ์„ ๋Œ€์ถœํ•˜๋Š” ๋ฐ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค. * REDEEM - DeFi์—์„œ ๋Œ€์ถœ๊ธˆ์„ ๋Œ๋ ค๋ฐ›๋Š” ๋ฐ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค. * STAKE - ์Šคํ…Œ์ดํ‚น ๋ณด์ƒ์„ ๋ฐ›๊ธฐ ์œ„ํ•ด ํŠน์ • ์ž์‚ฐ์„ ํ• ๋‹นํ•˜๊ณ  ์ž ๊ธ€ ์ˆ˜ ์žˆ๋„๋ก ํ•ฉ๋‹ˆ๋‹ค. * RAW - ์‚ฌ์ „ ์ •์˜๋œ ํ˜•์‹์ด ์—†๋Š” ์˜คํ”„์ฒด์ธ ๋ฉ”์‹œ์ง€๋กœ, ๊ฐœ์ธ ํ‚ค๋กœ ๋ชจ๋“  ๋ฉ”์‹œ์ง€์— ์„œ๋ช…ํ•˜๋Š” ๋ฐ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค. * TYPED_MESSAGE - ์‚ฌ์ „ ์ •์˜๋œ ํ˜•์‹์„ ๋”ฐ๋ฅด๋Š” ์˜คํ”„์ฒด์ธ ๋ฉ”์‹œ์ง€ ์œ ํ˜•์œผ๋กœ, ์‹ค์ œ ๊ฑฐ๋ž˜๊ฐ€ ์•„๋‹Œ ํŠน์ • ๋ฉ”์‹œ์ง€์— ์„œ๋ช…ํ•˜๋Š” ๋ฐ ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค.." + }, + "designatedSigner": { + "type": "string", + "description": "(๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ - "designatedSigners"๋กœ ๋Œ€์ฒด๋จ) ํŠน์ • ๊ทœ์น™๊ณผ ์ผ์น˜ํ•˜๋Š” ๊ฑฐ๋ž˜์— ์„œ๋ช…ํ•˜๋Š” ์‚ฌ์šฉ์ž๋ฅผ ๋‚˜ํƒ€๋‚ด๋Š” ID", + "deprecated": true + }, + "designatedSigners": { + "type": "object", + "description": "ํŠน์ • ๊ทœ์น™๊ณผ ์ผ์น˜ํ•˜๋Š” ๊ฑฐ๋ž˜์— ์„œ๋ช…ํ•˜๋Š” ์‚ฌ์šฉ์ž๋ฅผ ๋‚˜ํƒ€๋‚ด๋Š” ID ์„ธํŠธ", + "properties": { + "users": { + "type": "array", + "description": "์‚ฌ์šฉ์ž ID ์„ธํŠธ", + "items": { + "type": "string" + } + }, + "usersGroups": { + "type": "array", + "description": "๊ทธ๋ฃน ID ์„ธํŠธ", + "items": { + "type": "string" + } + } + } + }, + "type": { + "const": "TRANSFER", + "description": "์ •์ฑ… ๊ทœ์น™ ์œ ํ˜•" + }, + "action": { + "oneOf": [ + { + "const": "ALLOW" + }, + { + "const": "BLOCK" + }, + { + "const": "2-TIER" + } + ], + "description": "๊ฑฐ๋ž˜๊ฐ€ ๊ทœ์น™ ๊ธฐ์ค€์„ ์ถฉ์กฑํ•  ๋•Œ ๋ฐœ์ƒํ•˜๋Š” ์ƒํ™ฉ์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค. * ํ—ˆ์šฉ - ๊ฑฐ๋ž˜๊ฐ€ ์ง„ํ–‰๋˜์–ด ์ถ”๊ฐ€ ์Šน์ธ ์—†์ด ์„œ๋ช…ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. * ์ฐจ๋‹จ - ๊ฑฐ๋ž˜๊ฐ€ ์ž๋™์œผ๋กœ ์ฐจ๋‹จ๋ฉ๋‹ˆ๋‹ค. * 2๋‹จ๊ณ„ - ์ด๋Ÿฌํ•œ ์‚ฌ์šฉ์ž ๋˜๋Š” ์‚ฌ์šฉ์ž ๊ทธ๋ฃน๋งŒ ์Šน์ธํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ํ•„์š”ํ•œ ์Šน์ธ ์ž„๊ณ„๊ฐ’์— ๋„๋‹ฌํ•˜๊ธฐ ์ „์— ๊ฑฐ๋ž˜๋ฅผ ๊ฑฐ๋ถ€ํ•˜๋Š” ๊ฒฝ์šฐ ๊ฑฐ๋ž˜๊ฐ€ ์ง„ํ–‰๋˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค. ์„ค์ •๋œ ์—”ํ„ฐํ‹ฐ ๋ชฉ๋ก์€ "authorizationGroups" ํ•„๋“œ์ž…๋‹ˆ๋‹ค." + }, + "asset": { + "type": "string", + "description": "๊ฑฐ๋ž˜๋˜๋Š” ์ž์‚ฐ์˜ ์œ ํ˜•์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค. ์˜ต์…˜์€ ๋‹ค์Œ๊ณผ ๊ฐ™์Šต๋‹ˆ๋‹ค. * "*" - ๋ชจ๋“  ์ž์‚ฐ * ํŠน์ • ์ž์‚ฐ" + }, + "srcType": { + "description": "(๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ - "src"๋กœ ๋Œ€์ฒด๋จ) ์†Œ์Šค ๊ณ„์ • ์œ ํ˜•" + }, + "srcSubType": { + "description": "(๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ - "src"๋กœ ๋Œ€์ฒด๋จ) ์†Œ์Šค ํ•˜์œ„ ๊ณ„์ • ์œ ํ˜•" + }, + "srcId": { + "description": "(๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ - "src"๋กœ ๋Œ€์ฒด๋จ) ์†Œ์Šค ๊ณ„์ • ID" + }, + "src": { + "type": "object", + "description": "๊ทœ์น™์ด ์ „์†ก์„ ์‹œ์ž‘ํ•  ์ˆ˜ ์žˆ๋Š” ์†Œ์Šค ๊ณ„์ •์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค.", + "properties": { + "ids": { + "type": "array", + "description": "ID์˜ ์ง‘ํ•ฉ", + "items": { + "type": "array", + "description": "ํŠœํ”Œ ํ˜•์‹์˜ ID ์„ธํŠธ", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/PolicySrcOrDestId" + }, + { + "$ref": "#/components/schemas/PolicySrcOrDestType" + }, + { + "$ref": "#/components/schemas/PolicySrcOrDestSubType" + } + ] + }, + "minItems": 1, + "maxItems": 3 + } + } + } + }, + "dstType": { + "description": "(๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ - "dst"๋กœ ๋Œ€์ฒด๋จ) ๋Œ€์ƒ ๊ณ„์ • ์œ ํ˜•" + }, + "dstSubType": { + "description": "(๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ - "dst"๋กœ ๋Œ€์ฒด๋จ) ๋Œ€์ƒ ํ•˜์œ„ ๊ณ„์ • ์œ ํ˜•" + }, + "dstId": { + "description": "(๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ - "dst"๋กœ ๋Œ€์ฒด๋จ) ๋Œ€์ƒ ๊ณ„์ • ID" + }, + "dst": { + "type": "object", + "description": "๊ทœ์น™์ด ์ „์†ก์„ ํ—ˆ์šฉํ•˜๋Š” ๋Œ€์ƒ ๊ณ„์ •์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค.", + "properties": { + "ids": { + "type": "array", + "description": "ID์˜ ์ง‘ํ•ฉ", + "items": { + "type": "array", + "description": "ํŠœํ”Œ ํ˜•์‹์˜ ID ์„ธํŠธ", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/PolicySrcOrDestId" + }, + { + "$ref": "#/components/schemas/PolicySrcOrDestType" + }, + { + "$ref": "#/components/schemas/PolicySrcOrDestSubType" + } + ] + }, + "minItems": 1, + "maxItems": 3 + } + } + } + }, + "dstAddressType": { + "oneOf": [ + { + "const": "WHITELISTED" + }, + { + "const": "ONE_TIME" + }, + { + "const": "*" + } + ], + "description": "์ž๊ธˆ์„ ๋ณด๋‚ด๋Š” ๋ชฉ์ ์ง€๊ฐ€ ํ—ˆ์šฉ ๋ชฉ๋ก์— ํฌํ•จ๋˜์–ด์•ผ ํ•˜๋Š”์ง€, ํ—ˆ์šฉ ๋ชฉ๋ก์— ์—†๋Š” ์™ธ๋ถ€ ์ฃผ์†Œ๋กœ์˜ ์ผํšŒ์„ฑ ์ด์ฒด๋ฅผ ํ—ˆ์šฉํ•ด์•ผ ํ•˜๋Š”์ง€, ์•„๋‹ˆ๋ฉด ๋‘˜ ๋‹ค ํ—ˆ์šฉ ๋ชฉ๋ก์— ํฌํ•จ๋˜์–ด์•ผ ํ•˜๋Š”์ง€ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค. ๊ธฐ๋ณธ์ ์œผ๋กœ ํ—ˆ์šฉ ๋ชฉ๋ก์— ์ถ”๊ฐ€๋œ ์ดํ›„์—๋งŒ ์™ธ๋ถ€ ์ฃผ์†Œ๋กœ ์ด์ฒดํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. * ํ—ˆ์šฉ ๋ชฉ๋ก์— ์ถ”๊ฐ€๋จ - ํ—ˆ์šฉ ๋ชฉ๋ก์— ์žˆ๋Š” ์ฃผ์†Œ๋กœ๋งŒ ๋ณด๋‚ผ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. * ONE_TIME - ํ—ˆ์šฉ ๋ชฉ๋ก์— ์—†๋Š” ์™ธ๋ถ€ ์ฃผ์†Œ๋กœ๋งŒ ๋ณด๋‚ผ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. * "*" - ํ—ˆ์šฉ ๋ชฉ๋ก์— ์žˆ๋Š” ์ฃผ์†Œ ๋˜๋Š” ํ—ˆ์šฉ ๋ชฉ๋ก์— ์—†๋Š” ์™ธ๋ถ€ ์ฃผ์†Œ๋กœ ๋ณด๋‚ผ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค." + }, + "amountCurrency": { + "oneOf": [ + { + "const": "USD" + }, + { + "const": "EUR" + }, + { + "const": "NATIVE" + } + ], + "description": "* USD - ์ž์‚ฐ์˜ USD ํ™˜์‚ฐ์•ก์„ ๊ธฐ์ค€์œผ๋กœ ์‚ฌ์šฉ์ž๊ฐ€ ์ „์†กํ•  ์ˆ˜ ์žˆ๋Š” ์ž์‚ฐ์˜ ๊ธˆ์•ก์„ ์ œํ•œํ•ฉ๋‹ˆ๋‹ค. * EUR - ์ž์‚ฐ์˜ EUR ํ™˜์‚ฐ์•ก์„ ๊ธฐ์ค€์œผ๋กœ ์‚ฌ์šฉ์ž๊ฐ€ ์ „์†กํ•  ์ˆ˜ ์žˆ๋Š” ์ž์‚ฐ์˜ ๊ธˆ์•ก์„ ์ œํ•œํ•ฉ๋‹ˆ๋‹ค. * NATIVE - ํŠน์ • ์ž์‚ฐ์„ ์‚ฌ์šฉํ•  ๋•Œ ์‚ฌ์šฉ์ž๊ฐ€ ์ „์†กํ•  ์ˆ˜ ์žˆ๋Š” ์ž์‚ฐ์˜ ๊ธˆ์•ก์„ ์ œํ•œํ•ฉ๋‹ˆ๋‹ค.." + }, + "amountScope": { + "oneOf": [ + { + "const": "SINGLE_TX" + }, + { + "const": "TIMEFRAME" + } + ], + "description": "* SINGLE_TX - ํ•œ๋„๋Š” ๋‹จ์ผ ๊ฑฐ๋ž˜์— ์ ์šฉ๋ฉ๋‹ˆ๋‹ค. * TIMEFRAME - ํ•œ๋„๋Š” ์ •์˜๋œ ๊ธฐ๊ฐ„ ๋‚ด์˜ ๋ชจ๋“  ๊ฑฐ๋ž˜์— ์ ์šฉ๋ฉ๋‹ˆ๋‹ค." + }, + "amount": { + "type": "number", + "description": "๊ทœ์น™์ด ์ ์šฉ๋˜๊ธฐ ์œ„ํ•ด ๊ฑฐ๋ž˜๊ฐ€ ์ดˆ๊ณผํ•ด์•ผ ํ•˜๋Š” ๊ฐ’์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค(amountCurrency ํ•„๋“œ์— ๋”ฐ๋ผ)" + }, + "periodSec": { + "type": "number", + "description": "amountScope ํ•„๋“œ์—์„œ ๊ทœ์น™๊ณผ ์ผ์น˜ํ•˜๋Š” ๊ฑฐ๋ž˜์—์„œ ์ด์ฒด๋œ ๊ธˆ์•ก์„ ๋ˆ„์ ํ•˜๋Š” ๋ฐ ์ ์šฉ๋˜๋Š” ์ดˆ ๋‹จ์œ„ ๊ธฐ๊ฐ„์œผ๋กœ, ์ด๊ณ„๊ฐ€ ์ตœ์†Œ๊ฐ’์—์„œ ์ง€์ •ํ•œ ๊ฐ’์„ ์ดˆ๊ณผํ•  ๋•Œ๊นŒ์ง€์ž…๋‹ˆ๋‹ค. ํ•ด๋‹น ๊ธฐ๊ฐ„ ๋‚ด์— ์ง€์ •๋œ ๊ธˆ์•ก์— ๋„๋‹ฌํ•˜๋ฉด(๊ฑฐ๋ž˜ ํ•˜๋‚˜ ๋˜๋Š” ์—ฌ๋Ÿฌ ๊ฐœ) ํ•ด๋‹น ๊ธฐ๊ฐ„์˜ ์ถ”๊ฐ€ ๊ฑฐ๋ž˜๋Š” ์‹คํŒจํ•˜๊ฑฐ๋‚˜ ์ถ”๊ฐ€ ์Šน์ธ์ด ํ•„์š”ํ•ฉ๋‹ˆ๋‹ค.." + }, + "authorizers": { + "type": "array", + "description": "(๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ - "authorizationGroups"๋กœ ๋Œ€์ฒด๋จ) ๊ฑฐ๋ž˜๋ฅผ ์Šน์ธํ•  ์ˆ˜ ์žˆ๋Š” ํ—ˆ์šฉ๋œ ์—”ํ„ฐํ‹ฐ", + "deprecated": true, + "items": { + "type": "string" + } + }, + "authorizersCount": { + "type": "number", + "description": "(๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์Œ - "authorizationGroups"๋กœ ๋Œ€์ฒด๋จ) ๊ฑฐ๋ž˜๋ฅผ ์Šน์ธํ•˜๋Š” ๋ฐ ํ•„์š”ํ•œ ์ตœ์†Œ ์—”ํ„ฐํ‹ฐ ์ˆ˜", + "deprecated": true + }, + "authorizationGroups": { + "type": "object", + "description": "๊ฑฐ๋ž˜ ์Šน์ธ ์กฐ๊ฑด์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค", + "properties": { + "logic": { + "oneOf": [ + { + "const": "AND" + }, + { + "const": "OR" + } + ], + "description": "* AND - ๋ชจ๋“  ์Šน์ธ ๊ทธ๋ฃน์˜ ์Šน์ธ์ด ํ•„์š”ํ•ฉ๋‹ˆ๋‹ค. * OR - ์ตœ์†Œํ•œ ํ•˜๋‚˜์˜ ์Šน์ธ ๊ทธ๋ฃน์˜ ์Šน์ธ์ด ํ•„์š”ํ•ฉ๋‹ˆ๋‹ค." + }, + "allowOperatorAsAuthorizer": { + "type": "boolean", + "description": "๊ฑฐ๋ž˜๋ฅผ ์‹œ์ž‘ํ•œ ์‚ฌ์šฉ์ž๊ฐ€ ์ž์‹ ์˜ ๊ฑฐ๋ž˜๋ฅผ ์Šน์ธํ•˜๊ณ  ํ•ด๋‹น ๊ฑฐ๋ž˜์˜ ์Šน์ธ ์ž„๊ณ„๊ฐ’์— ํฌํ•จ๋  ์ˆ˜ ์žˆ๋Š”์ง€ ์—ฌ๋ถ€๋ฅผ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค." + }, + "groups": { + "type": "array", + "description": "๊ฑฐ๋ž˜๋ฅผ ์Šน์ธํ•  ์ˆ˜ ์žˆ๋Š” ์—”ํ„ฐํ‹ฐ ๊ทธ๋ฃน", + "items": { + "type": "object", + "properties": { + "users": { + "type": "array", + "description": "์‚ฌ์šฉ์ž ID", + "items": { + "type": "string" + } + }, + "usersGroups": { + "type": "array", + "description": "๊ทธ๋ฃน ID", + "items": { + "type": "string" + } + }, + "th": { + "type": "number", + "description": "๊ฑฐ๋ž˜๋ฅผ ์Šน์ธํ•˜๋Š” ๋ฐ ํ•„์š”ํ•œ ์ตœ์†Œ ์—”ํ„ฐํ‹ฐ ์ˆ˜๋ฅผ ๋‚˜ํƒ€๋ƒ…๋‹ˆ๋‹ค. ๊ธฐ๋ณธ๊ฐ’์€ 1์ž…๋‹ˆ๋‹ค.." + } + } + } + } + } + }, + "amountAggregation": { + "type": "object", + "description": "์ •์ฑ… ์—”์ง„์ด ๋ˆ„์ ์„ ๊ณ„์‚ฐํ•˜๋Š” ๋ฐฉ๋ฒ•์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค. ์‹œ์ž‘์ž, ์†Œ์Šค ๋ฐ ๋Œ€์ƒ์„ ์‚ฌ์šฉํ•˜์—ฌ ์ตœ์†Œ๊ฐ’ ์•„๋ž˜์˜ ๊ฐ’์— ๋Œ€ํ•œ ๋ˆ„์ ์„ ๊ณ„์‚ฐํ•˜๊ณ  ๊ธฐ๊ฐ„ ์•„๋ž˜์˜ ์‹œ๊ฐ„ ๋™์•ˆ ๋ˆ„์ ์„ ๊ณ„์‚ฐํ•ฉ๋‹ˆ๋‹ค..", + "properties": { + "operators": { + "$ref": "#/components/schemas/AmountAggregationTimePeriodMethod" + }, + "srcTransferPeers": { + "$ref": "#/components/schemas/AmountAggregationTimePeriodMethod" + }, + "dstTransferPeers": { + "$ref": "#/components/schemas/AmountAggregationTimePeriodMethod" + } + } + }, + "rawMessageSigning": { + "type": "object", + "description": "์›์‹œ ๋ฉ”์‹œ์ง€ ์„œ๋ช… ๊ตฌ์„ฑ", + "properties": { + "algorithm": { + "type": "string" + }, + "derivationPath": { + "type": "object", + "properties": { + "path": { + "type": "array", + "items": { + "type": "number" + } + } + } + } + } + }, + "applyForApprove": { + "type": "boolean", + "description": "APPROVE ์œ ํ˜• ๊ฑฐ๋ž˜์— ์ด ๊ทœ์น™์„ ์ ์šฉํ•ฉ๋‹ˆ๋‹ค(๊ทœ์น™์˜ ๊ฑฐ๋ž˜ ์œ ํ˜•์ด TRANSFER์ธ ๊ฒฝ์šฐ์—๋งŒ ํ™œ์„ฑํ™”ํ•  ์ˆ˜ ์žˆ์Œ)" + }, + "applyForTypedMessage": { + "type": "boolean", + "description": "TYPED_MESSAGE ์œ ํ˜• ๊ฑฐ๋ž˜์— ์ด ๊ทœ์น™์„ ์ ์šฉํ•ฉ๋‹ˆ๋‹ค(๊ทœ์น™์˜ ๊ฑฐ๋ž˜ ์œ ํ˜•์ด CONTRACT_CALL์ธ ๊ฒฝ์šฐ์—๋งŒ ํ™œ์„ฑํ™”ํ•  ์ˆ˜ ์žˆ์Œ)" + }, + "externalDescriptor": { + "type": "string", + "description": "๊ทœ์น™์„ ์‹๋ณ„ํ•˜๋Š” ๊ณ ์œ  ID" + } + }, + "required": [ + "type", + "action", + "asset", + "amountCurrency", + "amountScope", + "amount", + "periodSec", + "externalDescriptor" + ] + }, + "PublishResult": { + "type": "object", + "description": "๊ฒŒ์‹œ ์ •์ฑ… ์ž‘์—…์˜ ์‘๋‹ต ๊ฐ์ฒด", + "properties": { + "status": { + "$ref": "#/components/schemas/PolicyStatus" + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PolicyRule" + } + }, + "checkResult": { + "$ref": "#/components/schemas/PolicyCheckResult" + }, + "metadata": { + "$ref": "#/components/schemas/PolicyMetadata" + } + }, + "required": [ + "status", + "rules", + "checkResult", + "metadata" + ] + }, + "PolicyStatus": { + "oneOf": [ + { + "const": "SUCCESS" + }, + { + "const": "UNVALIDATED" + }, + { + "const": "INVALID_CONFIGURATION" + }, + { + "const": "PENDING" + }, + { + "const": "PENDING_CONSOLE_APPROVAL" + }, + { + "const": "AWAITING_QUORUM" + }, + { + "const": "UNHANDLED_ERROR" + } + ], + "description": "* SUCCESS - ์„ฑ๊ณต * UNVALIDATED - ์•„์ง ๊ฒ€์ฆ๋˜์ง€ ์•Š์Œ * INVALID_CONFIGURATION - ์ ์–ด๋„ ํ•˜๋‚˜์˜ ๊ทœ์น™์ด ์ž˜๋ชป๋จ * PENDING - ์Šน์ธ ๋ณด๋ฅ˜ ์ค‘ * PENDING_CONSOLE_APPROVAL - ์ฝ˜์†” ์•ฑ์—์„œ ์Šน์ธ ๋ณด๋ฅ˜ ์ค‘ * AWAITING_QUORUM - ์ฟผ๋Ÿผ ์Šน์ธ ๋ณด๋ฅ˜ ์ค‘ * UNHANDLED_ERROR - ์ฒ˜๋ฆฌ๋˜์ง€ ์•Š์€ ์˜ค๋ฅ˜" + }, + "PolicyMetadata": { + "type": "object", + "description": "์ •์ฑ… ๊ด€๋ จ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ", + "properties": { + "editedBy": { + "type": "string", + "description": "์ •์ฑ…์„ ๋งˆ์ง€๋ง‰์œผ๋กœ ํŽธ์ง‘ํ•œ ์‚ฌ์šฉ์ž์˜ ์‚ฌ์šฉ์ž ID" + }, + "editedAt": { + "type": "string", + "description": "์ •์ฑ…์˜ ๋งˆ์ง€๋ง‰ ํŽธ์ง‘ ํƒ€์ž„์Šคํƒฌํ”„" + }, + "publishedBy": { + "type": "string", + "description": "์ •์ฑ…์„ ๋งˆ์ง€๋ง‰์œผ๋กœ ๊ฒŒ์‹œํ•œ ์‚ฌ์šฉ์ž์˜ ์‚ฌ์šฉ์ž ID" + }, + "publishedAt": { + "type": "string", + "description": "์ •์ฑ…์˜ ๋งˆ์ง€๋ง‰ ๊ฒŒ์‹œ ํƒ€์ž„์Šคํƒฌํ”„" + } + } + }, + "PolicyCheckResult": { + "type": "object", + "description": "์ •์ฑ… ๊ทœ์น™ ๊ฒ€์ฆ ๊ฒฐ๊ณผ", + "properties": { + "errors": { + "type": "number", + "description": "์˜ค๋ฅ˜์˜ ์ˆ˜" + }, + "result": { + "type": "array", + "description": "๊ฒ€์ฆ ๊ฒฐ๊ณผ ์„ธํŠธ", + "items": { + "$ref": "#/components/schemas/PolicyRuleCheckResult" + } + } + }, + "required": [ + "errors", + "result" + ] + }, + "PolicyRuleCheckResult": { + "type": "object", + "description": "๊ทœ์น™ ๊ฒ€์ฆ ๊ฒฐ๊ณผ", + "properties": { + "index": { + "type": "number", + "description": "์ •์ฑ…์˜ ๊ทœ์น™ ์ธ๋ฑ์Šค ๋ฒˆํ˜ธ" + }, + "status": { + "oneOf": [ + { + "const": "ok" + }, + { + "const": "failure" + } + ], + "description": "๊ฒ€์ฆ ์ƒํƒœ" + }, + "errors": { + "type": "array", + "description": "๊ทœ์น™ ๊ฒ€์ฆ ์˜ค๋ฅ˜ ๊ฐœ์ฒด ์„ธํŠธ", + "items": { + "$ref": "#/components/schemas/PolicyRuleError" + } + } + }, + "required": [ + "index", + "status", + "errors" + ] + }, + "PolicyRuleError": { + "type": "object", + "description": "๊ทœ์น™ ๊ฒ€์ฆ ๊ฒฐ๊ณผ ์˜ค๋ฅ˜", + "properties": { + "errorMessage": { + "type": "string", + "description": "์˜ค๋ฅ˜ ๋ฉ”์‹œ์ง€" + }, + "errorCode": { + "type": "number", + "description": "์˜ค๋ฅ˜ ์ฝ”๋“œ" + }, + "errorCodeName": { + "type": "string", + "description": "์˜ค๋ฅ˜ ์ฝ”๋“œ ์ด๋ฆ„" + }, + "errorField": { + "oneOf": [ + { + "const": "operator" + }, + { + "const": "operators" + }, + { + "const": "authorizationGroups" + }, + { + "const": "designatedSigner" + }, + { + "const": "designatedSigners" + }, + { + "const": "contractMethods" + }, + { + "const": "amountAggregation" + }, + { + "const": "src" + }, + { + "const": "dst" + } + ], + "description": "์˜ค๋ฅ˜๊ฐ€ ๊ด€๋ จ๋œ ํ•„๋“œ * operator - ๊ฑฐ๋ž˜ ๊ฐœ์‹œ์ž * operators - ๊ฑฐ๋ž˜ ๊ฐœ์‹œ์ž * authorizationGroups - ๊ฑฐ๋ž˜ ์Šน์ธ์ž ๊ทธ๋ฃน * designatedSigner - ๊ฑฐ๋ž˜ ์„œ๋ช…์ž * designatedSigners - ๊ฑฐ๋ž˜ ์„œ๋ช…์ž * contractMethods - ๊ณ„์•ฝ ๋ฐฉ๋ฒ• * amountAggregation - ๊ฑฐ๋ž˜ ๊ธˆ์•ก ์ง‘๊ณ„ ๊ตฌ์„ฑ * src - ๊ฑฐ๋ž˜ ์†Œ์Šค ์ž์‚ฐ ๊ตฌ์„ฑ * dst - ๊ฑฐ๋ž˜ ๋Œ€์ƒ ์ž์‚ฐ ๊ตฌ์„ฑ" + } + }, + "required": [ + "errorMessage", + "errorCode", + "errorCodeName", + "errorField" + ] + }, + "DraftReviewAndValidationResponse": { + "type": "object", + "description": "์ดˆ์•ˆ ๊ฒ€์ฆ", + "properties": { + "draftResponse": { + "$ref": "#/components/schemas/DraftResponse" + }, + "validation": { + "$ref": "#/components/schemas/PolicyValidation" + } + }, + "required": [ + "draftResponse", + "validation" + ] + }, + "PolicyAndValidationResponse": { + "type": "object", + "description": "์ •์ฑ… ๊ฒ€์ฆ", + "properties": { + "policy": { + "$ref": "#/components/schemas/PolicyResponse" + }, + "validation": { + "$ref": "#/components/schemas/PolicyValidation" + } + }, + "required": [ + "policy", + "validation" + ] + }, + "DraftResponse": { + "type": "object", + "description": "์ดˆ์•ˆ ์ž‘์—…์— ๋Œ€ํ•œ ์‘๋‹ต ๊ฐ์ฒด", + "properties": { + "status": { + "type": "string", + "description": "์ž‘์—… ์ƒํƒœ" + }, + "rules": { + "type": "array", + "description": "์ดˆ์•ˆ ๊ทœ์น™", + "items": { + "$ref": "#/components/schemas/PolicyRule" + } + }, + "draftId": { + "type": "string", + "description": "๊ณ ์œ  ID ์ดˆ์•ˆ" + }, + "metadata": { + "$ref": "#/components/schemas/PolicyMetadata" + } + }, + "required": [ + "draftId", + "status", + "rules", + "metadata" + ] + }, + "PolicyResponse": { + "type": "object", + "description": "์ •์ฑ… ์ž‘์—…์— ๋Œ€ํ•œ ์‘๋‹ต ๊ฐœ์ฒด", + "properties": { + "rules": { + "type": "array", + "description": "์ •์ฑ… ๊ทœ์น™ ์„ธํŠธ", + "items": { + "$ref": "#/components/schemas/PolicyRule" + } + }, + "metadata": { + "$ref": "#/components/schemas/PolicyMetadata" + } + }, + "required": [ + "rules", + "metadata" + ] + }, + "PolicyValidation": { + "type": "object", + "description": "์ •์ฑ… ๊ฒ€์ฆ ๊ฐ์ฒด", + "properties": { + "status": { + "type": "string", + "description": "๊ฒ€์ฆ ์ƒํƒœ" + }, + "checkResult": { + "$ref": "#/components/schemas/PolicyCheckResult" + } + }, + "required": [ + "status", + "checkResult" + ] + }, + "ErrorResponse": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "type": { + "oneOf": [ + { + "const": "INTERNAL" + }, + { + "const": "AUTHENTICATION" + }, + { + "const": "AUTHORIZATION" + }, + { + "const": "VALIDATION" + }, + { + "const": "NOT_FOUND" + }, + { + "const": "UNPROCESSABLE_ENTITY" + }, + { + "const": "FORBIDDEN" + } + ] + }, + "message": { + "type": "string" + } + }, + "required": [ + "type", + "message" + ] + } + }, + "required": [ + "error" + ] + } + }, + "securitySchemes": { + "bearerTokenAuth": { + "type": "http", + "scheme": "bearer", + "bearerFormat": "JWT" + }, + "ApiKeyAuth": { + "type": "apiKey", + "in": "header", + "name": "X-API-Key" + } + } + }, + "x-samchon-emended": true +} \ No newline at end of file diff --git a/assets/output/iamport.swagger.ar.json b/assets/output/iamport.swagger.ar.json new file mode 100644 index 0000000..dfd1fc8 --- /dev/null +++ b/assets/output/iamport.swagger.ar.json @@ -0,0 +1,5056 @@ +{ + "openapi": "3.1.0", + "servers": [ + { + "url": "http://localhost:10851", + "description": "ู…ุฒูŠู" + }, + { + "url": "https://api.iamport.kr", + "description": "ุญู‚ูŠู‚ูŠ" + } + ], + "info": { + "title": "ุงุณุชูŠุฑุงุฏ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช", + "description": "ุชู… ุฅู†ุดุงุคู‡ ุจูˆุงุณุทุฉ [fake-iamport-server](https://github.com/samchon/fake-iamport-server) ู…ุน [nestia](https://github.com/samchon/nestia)", + "version": "2.0.1", + "license": { + "name": "MIT" + } + }, + "paths": { + "/certifications/{imp_uid}": { + "get": { + "tags": [], + "parameters": [ + { + "name": "imp_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "ุงุณุชู‡ุฏุงู ู…ุนู„ูˆู…ุงุช ุงู„ู…ุตุงุฏู‚ุฉ ุงู„ุดุฎุตูŠุฉ", + "required": true + } + ], + "responses": { + "200": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ู…ุตุงุฏู‚ุฉ ุงู„ุดุฎุตูŠุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportCertification_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ุนุฑุถ ู…ุนู„ูˆู…ุงุช ุงู„ู…ุตุงุฏู‚ุฉ ุงู„ุดุฎุตูŠุฉ", + "description": "ุนุฑุถ ู…ุนู„ูˆู…ุงุช ุงู„ู…ุตุงุฏู‚ุฉ ุงู„ุฎุงุตุฉ ุจูƒ. `certiciations.at` ู‡ูŠ ุฅุญุฏู‰ ูˆุธุงุฆู API ุงู„ู…ุณุชุฎุฏู…ุฉ ู„ุนุฑุถ ู…ุนู„ูˆู…ุงุช ุงู„ู…ุตุงุฏู‚ุฉ ุงู„ุดุฎุตูŠุฉ. ูˆู…ุน ุฐู„ูƒุŒ ู„ูŠุณ ู‡ู†ุงูƒ ู…ุง ูŠุถู…ู† ุฃู† ู…ุนู„ูˆู…ุงุช ุงู„ู…ุตุงุฏู‚ุฉ ุงู„ุดุฎุตูŠุฉ {@link IIamportCertification} ุงู„ุชูŠ ูŠุชู… ุนุฑุถู‡ุง ู…ู† ุฎู„ุงู„ ูˆุธูŠูุฉ API ู‡ุฐู‡ ู‡ูŠ ุณุฌู„ ุชู… ููŠู‡ ุฅูƒู…ุงู„ ุฌู…ูŠุน ุงู„ู…ุตุงุฏู‚ุฉ ุงู„ุดุฎุตูŠุฉุŒ ุจู…ุง ููŠ ุฐู„ูƒ ู…ุตุงุฏู‚ุฉ OTP. ูˆุฐู„ูƒ ู„ุฃู†ู‡ ู„ุง ูŠู…ูƒู†ูƒ ู…ุนุฑูุฉ ู…ุง ุฅุฐุง ูƒุงู†ุช ู…ุตุงุฏู‚ุฉ ู‡ูˆูŠุชูƒ ู…ูƒุชู…ู„ุฉ ุฅู„ุง ู…ู† ุฎู„ุงู„ ุงู„ุชุญู‚ู‚ ู…ุจุงุดุฑุฉ ู…ู† ุงู„ู‚ูŠู…ุฉ {@link IIamportCertification.certified }..", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "certifications.at", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "imp_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋Œ€์ƒ ๋ณธ์ธ์ธ์ฆ ์ •๋ณด์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "IIamportCertification.imp_uid", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-iamport-server/src/api/structures/IIamportCertification.ts", + "textSpan": { + "start": 488, + "length": 16 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๋ณธ์ธ์ธ์ฆ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "GET" + }, + "delete": { + "tags": [], + "parameters": [ + { + "name": "imp_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "ุงุณุชู‡ุฏุงู ู…ุนู„ูˆู…ุงุช ุงู„ู…ุตุงุฏู‚ุฉ ุงู„ุดุฎุตูŠุฉ", + "required": true + } + ], + "responses": { + "200": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ู…ุตุงุฏู‚ุฉ ุงู„ุดุฎุตูŠุฉ ุงู„ู…ุญุฐูˆูุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportCertification_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ุญุฐู ู…ุนู„ูˆู…ุงุช ุงู„ู…ุตุงุฏู‚ุฉ ุงู„ุดุฎุตูŠุฉ", + "description": "ุญุฐู ู…ุนู„ูˆู…ุงุช ุงู„ู…ุตุงุฏู‚ุฉ ุงู„ุดุฎุตูŠุฉ.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "certifications.erase", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "imp_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋Œ€์ƒ ๋ณธ์ธ์ธ์ฆ ์ •๋ณด์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "IIamportCertification.imp_uid", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-iamport-server/src/api/structures/IIamportCertification.ts", + "textSpan": { + "start": 488, + "length": 16 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์‚ญ์ œ๋œ ๋ณธ์ธ์ธ์ฆ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "DELETE" + } + }, + "/certifications/otp/request": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "ู…ุนู„ูˆู…ุงุช ุทู„ุจ ุงู„ู…ุตุงุฏู‚ุฉ ุงู„ุดุฎุตูŠุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportCertification.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ู…ุนุฑู ู„ู„ุชุญู‚ู‚ ู…ู† ุงู„ู‡ูˆูŠุฉ ู‚ูŠุฏ ุงู„ุชู‚ุฏู…", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportCertification.IAccessor_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ุทู„ุจ ุงู„ุชุญู‚ู‚ ู…ู† ุงู„ู‡ูˆูŠุฉ", + "description": "ุทู„ุจ ุงู„ุชุญู‚ู‚ ู…ู† ุงู„ู‡ูˆูŠุฉ. `certifications.otp.request` ู‡ูŠ ุฅุญุฏู‰ ูˆุธุงุฆู API ุงู„ุชูŠ ุชุทู„ุจ ู…ุตุงุฏู‚ุฉ ุงู„ู‡ูˆูŠุฉ ู…ู† ุฎุงุฏู… ุงู„ุงุณุชูŠุฑุงุฏ. ุนู†ุฏู…ุง ูŠุชู… ุงุณุชุฏุนุงุก ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ู‡ุฐู‡ุŒ ูŠุชู… ุฅุฑุณุงู„ ุฑุณุงู„ุฉ ู†ุตูŠุฉ ู„ู…ุฑุฉ ูˆุงุญุฏุฉ (OTP) ุฅู„ู‰ ุงู„ู‡ุงุชู ุงู„ู…ุญู…ูˆู„ ู„ู„ุดุฎุต ุงู„ุฐูŠ ุชุชู… ู…ุตุงุฏู‚ุชู‡ุŒ ูˆูŠุชู… ุฅูƒู…ุงู„ ุงู„ุชุญู‚ู‚ ู…ู† ุงู„ู‡ูˆูŠุฉ ุนู† ุทุฑูŠู‚ ุฅุฏุฎุงู„ ุฑู‚ู… OTP ู‡ุฐุง ุจุฏู‚ุฉ ู…ู† ุฎู„ุงู„ {@link ุงู„ุดู‡ุงุฏุงุช.otp.confirm}. ุจุงู„ุฅุถุงูุฉ ุฅู„ู‰ ุฐู„ูƒุŒ ุญุชู‰ ู‚ุจู„ ุฃู† ูŠู‚ูˆู… ู…ุณุชู„ู… ุงู„ุชุญู‚ู‚ ู…ู† ุงู„ู‡ูˆูŠุฉ ุจุฅุฏุฎุงู„ ุงู„ุฑุณุงู„ุฉ ุงู„ู†ุตูŠุฉ ู„ู…ุฑุฉ ูˆุงุญุฏุฉ (OTP) ุงู„ู…ุฑุณู„ุฉ ุฅู„ู‰ ู‡ุงุชูู‡ ุงู„ู…ุญู…ูˆู„ุŒ ู„ุง ูŠุฒุงู„ ู…ู† ุงู„ู…ู…ูƒู† ุนุฑุถ ุชูุงุตูŠู„ ุงู„ุชุญู‚ู‚ ู…ู† ุงู„ู‡ูˆูŠุฉ ู…ู† ุฎู„ุงู„ ูˆุธูŠูุฉ {@link ุงู„ุดู‡ุงุฏุงุช.at}. ูˆู…ุน ุฐู„ูƒุŒ ููŠ {@link IIamportCertification } ุงู„ุชูŠ ุชู… ุฅุฑุฌุงุนู‡ุง ููŠ ู‡ุฐุง ุงู„ูˆู‚ุชุŒ ุชูƒูˆู† ู‚ูŠู…ุฉ {@link IIamportCertification.certified }ุŒ ุงู„ุชูŠ ุชุดูŠุฑ ุฅู„ู‰ ู…ุง ุฅุฐุง ูƒุงู†ุช ุงู„ู…ุตุงุฏู‚ุฉ ู‚ุฏ ุงูƒุชู…ู„ุชุŒ ู‡ูŠ "ุฎุทุฃ"..", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "certifications.otp.request.request", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋ณธ์ธ์ธ์ฆ ์š”์ฒญ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์ง„ํ–‰ ์ค‘์ธ ๋ณธ์ธ์ธ์ฆ์˜ ์‹๋ณ„์ž ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/certifications/otp/confirm/{imp_uid}": { + "post": { + "tags": [], + "parameters": [ + { + "name": "imp_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "ุงุณุชู‡ุฏุงู ู…ุนู„ูˆู…ุงุช ุงู„ู…ุตุงุฏู‚ุฉ ุงู„ุดุฎุตูŠุฉ", + "required": true + } + ], + "requestBody": { + "description": "ุฑู…ุฒ ู…ูƒุชุจ ุงู„ู…ุฏุนูŠ ุงู„ุนุงู…", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportCertification.IConfirm" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ู…ุตุงุฏู‚ุฉ ุงู„ุดุฎุตูŠุฉ ุงู„ุชูŠ ุชู… ุงู„ุชุญู‚ู‚ ู…ู†ู‡ุง", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportCertification_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ุฃุฏุฎู„ ุฑู…ุฒ OTP ุงู„ุตุงุฏุฑ ุนู†ุฏ ุงู„ุชุญู‚ู‚ ู…ู† ู‡ูˆูŠุชูƒ.", + "description": "ุฃุฏุฎู„ ุฑู…ุฒ OTP ุงู„ุตุงุฏุฑ ุฃุซู†ุงุก ุงู„ุชุญู‚ู‚ ู…ู† ุงู„ู‡ูˆูŠุฉ. `certifications.otp.confirm` ูŠุชุญู‚ู‚ ู…ู† ุฑู‚ู… OTP ุงู„ู…ุฑุณู„ ุฅู„ู‰ ุงู„ู‡ุงุชู ุงู„ู…ุญู…ูˆู„ ู„ู„ุดุฎุต ุงู„ู…ุฑุงุฏ ุงู„ู…ุตุงุฏู‚ุฉ ุนู„ูŠู‡ ู„ู„ุชุญู‚ู‚ ู…ู† ุงู„ู‡ูˆูŠุฉ ุงู„ุตุงุฏุฑุฉ ู…ู† ุฎู„ุงู„ {@link ุงู„ุดู‡ุงุฏุงุช.otp.request }ุŒ ูˆุฅุฐุง ูƒุงู† ุฑู‚ู… OTP ุงู„ุฐูŠ ุชู… ุฅุฏุฎุงู„ู‡ ุตุญูŠุญู‹ุงุŒ ูู‡ุฐู‡ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช (API) ุงู„ูˆุธูŠูุฉ ุงู„ุชูŠ ุชูˆุงูู‚ ุนู„ู‰ ุทู„ุจ ุงู„ู…ุตุงุฏู‚ุฉ ูˆุชูƒู…ู„ู‡. ุนู†ุฏ ุงูƒุชู…ุงู„ ุงู„ุชุญู‚ู‚ ู…ู† ุงู„ู‡ูˆูŠุฉ ุจู‡ุฐู‡ ุงู„ุทุฑูŠู‚ุฉุŒ ูŠุชู… ุชุบูŠูŠุฑ ู‚ูŠู…ุฉ {@link IIamportCertification.certified} ู„ู…ุตุงุฏู‚ุฉ ุงู„ู‡ูˆูŠุฉ ุงู„ู…ู‚ุงุจู„ุฉ {@link IIamportCertification } ุฃุฎูŠุฑู‹ุง ุฅู„ู‰ "true"ุŒ ูˆูŠุชู… ุฅูƒู…ุงู„ู‡ุง ุฃุฎูŠุฑู‹ุง..", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "certifications.otp.confirm.confirm", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "imp_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋Œ€์ƒ ๋ณธ์ธ์ธ์ฆ ์ •๋ณด์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "IIamportCertification.imp_uid", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-iamport-server/src/api/structures/IIamportCertification.ts", + "textSpan": { + "start": 488, + "length": 16 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "OTP ์ฝ”๋“œ", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์ธ์ฆ ์™„๋ฃŒ๋œ ๋ณธ์ธ์ธ์ฆ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/internal/webhook": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "ู…ุนู„ูˆู…ุงุช ุญุฏุซ Webhook", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportPayment.IWebhook" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "", + "x-nestia-encrypted": false + } + }, + "summary": "ุงู„ู…ุณุชู…ุน ุงู„ูˆู‡ู…ูŠ ู„ุญุฏุซ Webhook", + "description": "ู…ุณุชู…ุน ูˆู‡ู…ูŠ ู„ุญุฏุซ Webhook. `internal.webhook` ู‡ูˆ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช ุบูŠุฑ ู…ูˆุฌูˆุฏุฉ ููŠ ุฎุงุฏู… Iimport ุงู„ูุนู„ูŠ. ุฅุฐุง ู„ู… ูŠุชู… ุชุนูŠูŠู† ุนู†ูˆุงู† URL ููŠ {@link Configuration.WEBHOOK_URL} ู„ู€ `fake-impoart-server`ุŒ ูุฅู†ู‡ ูŠุญุฏุซ ู…ู† `fake-iamport-server`. ูŠุชู… ุฅุฑุณุงู„ ุฌู…ูŠุน ุฃู†ูˆุงุน ุฃุญุฏุงุซ webhook ุฅู„ู‰ ู‡ุฐุง ุงู„ู…ูƒุงู† ูˆุชุฎุชููŠ ุจู„ุง ู…ุนู†ู‰. ู„ุฐู„ูƒุŒ ุนู†ุฏู…ุง ุชุฑูŠุฏ ุงุณุชุฎุฏุงู… "fake-iamport-server" ู„ู„ุชุญู‚ู‚ ู…ู† ุงู„ุงุชุตุงู„ ุจุฎุงุฏู… ุงู„ุงุณุชูŠุฑุงุฏ ู…ุณุจู‚ู‹ุงุŒ ุชุฃูƒุฏ ู…ู† ุชุนูŠูŠู† {@link Configuration.WEBHOOK_URL } ู„ู„ุชุฃูƒุฏ ู…ู† ุชุณู„ูŠู… ุญุฏุซ webhook ุจุดูƒู„ ุตุญูŠุญ ุฅู„ู‰ ุฎุงุฏู… ุงู„ูˆุงุฌู‡ุฉ ุงู„ุฎู„ููŠุฉ ู„ุฏูŠูƒ..", + "x-nestia-namespace": "internal.webhook.webhook", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์›นํ›… ์ด๋ฒคํŠธ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/internal/deposit/{imp_uid}": { + "get": { + "tags": [], + "parameters": [ + { + "name": "imp_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "ุงู„ุฏูุน ุงู„ู…ุณุชู‡ุฏู", + "required": true + } + ], + "responses": { + "200": { + "description": "", + "x-nestia-encrypted": false + } + }, + "summary": "ู‚ู… ุจุฅูŠุฏุงุน ุงู„ุฃู…ูˆุงู„ ููŠ ุญุณุงุจูƒ ุงู„ุงูุชุฑุงุถูŠ", + "description": "ู‚ู… ุจุฅูŠุฏุงุน ุงู„ุฃู…ูˆุงู„ ููŠ ุญุณุงุจูƒ ุงู„ุงูุชุฑุงุถูŠ. `internal.deposit` ุนุจุงุฑุฉ ุนู† ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช ุบูŠุฑ ู…ูˆุฌูˆุฏุฉ ููŠ ุฎุงุฏู… ุฏูุน I'mport ุงู„ูุนู„ูŠุŒ ูˆู‡ูŠ ูˆุธูŠูุฉ ูŠู…ูƒู†ู‡ุง ู…ุญุงูƒุงุฉ ุงู„ู…ูˆู‚ู ุญูŠุซ ูŠู‚ูˆู… ุงู„ุนู…ูŠู„ ุงู„ุฐูŠ ุชู‚ุฏู… ุจุทู„ุจ ู„ู„ุญุตูˆู„ ุนู„ู‰ ุฏูุนุฉ ู…ู† ุญุณุงุจ ุงูุชุฑุงุถูŠ ุจุฅูŠุฏุงุน ุงู„ู…ุจู„ุบ ุงู„ู…ุณุชู‡ุฏู ู„ุงุญู‚ู‹ุง ููŠ ุงู„ุญุณุงุจ ุงู„ุงูุชุฑุงุถูŠ . ุจู…ุนู†ู‰ ุขุฎุฑุŒ "internal.deposit" ู‡ูˆ ุงุฎุชุจุงุฑ ู…ุตู…ู… ู„ู…ุญุงูƒุงุฉ ุณู„ุณู„ุฉ ู…ู† ุงู„ู…ูˆุงู‚ู ุงู„ุชูŠ ูŠู‚ูˆู… ููŠู‡ุง ุงู„ุนู…ูŠู„ ุจุฅูŠุฏุงุน ุฃู…ูˆุงู„ ููŠ ุญุณุงุจ ุตุงุฏุฑ ู„ู‡ ูุนู„ูŠู‹ุงุŒ ูˆุจู†ุงุกู‹ ุนู„ู‰ ุฐู„ูƒ ูŠุชู… ุฅู†ุดุงุก ุญุฏุซ webhook ุนู„ู‰ ุฎุงุฏู… ุงู„ุงุณุชูŠุฑุงุฏ ูˆู†ู‚ู„ู‡ ุฅู„ู‰ ุญุณุงุจูƒ ุฅู†ู‡ุง ูˆุธูŠูุฉ.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "internal.deposit.deposit", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "imp_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋Œ€์ƒ ๊ฒฐ์ œ์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "IIamportVBankPayment.imp_uid ", + "kind": "linkText" + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "GET" + } + }, + "/payments/{imp_uid}": { + "get": { + "tags": [], + "parameters": [ + { + "name": "imp_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "ู…ู† ุณุฌู„ุงุช ุงู„ุฏูุน ุงู„ู…ุณุชู‡ุฏูุฉ", + "required": true + }, + { + "name": "query", + "in": "query", + "schema": { + "$ref": "#/components/schemas/IIamportPayment.IQuery" + }, + "description": "ุชุณุชุฎุฏู… ุนู†ุฏู…ุง ุชูƒูˆู† ุทุฑูŠู‚ุฉ ุงู„ุฏูุน ู‡ูŠ PayPal", + "required": true + } + ], + "responses": { + "200": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportPayment_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ุนุฑุถ ุชุงุฑูŠุฎ ุงู„ุฏูุน", + "description": "ุนุฑุถ ุณุฌู„ ุงู„ุฏูุน ุงู„ุฎุงุต ุจูƒ. ุนุฑุถ ุณุฌู„ุงุช ุงู„ุฏูุน ุงู„ุชูŠ ุชู… ุฅู†ุดุงุคู‡ุง ู…ู† ุฎู„ุงู„ Iimport..", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "payments.at", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "imp_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋Œ€์ƒ ๊ฒฐ์ œ ๊ธฐ๋ก์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "IIamportPayment.imp_uid", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-iamport-server/src/api/structures/IIamportPayment.ts", + "textSpan": { + "start": 2339, + "length": 16 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "query", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฒฐ์ œ ์ˆ˜๋‹จ์ด ํŽ˜์ดํŒ”์ธ ๊ฒฝ์šฐ์— ์‚ฌ์šฉ", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "GET" + } + }, + "/payments/cancel": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "ู…ุนู„ูˆู…ุงุช ุฅุฏุฎุงู„ ุฅู„ุบุงุก ุงู„ุฏูุน", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportPaymentCancel.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน ุงู„ู…ู„ุบุงุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportPayment_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ุฅู„ุบุงุก ุงู„ุฏูุน", + "description": "ุฅู„ุบุงุก ุงู„ุฏูุน. ุฅุฐุง ุชู… ุงู„ุฏูุน ู…ู† ุฎู„ุงู„ ุญุณุงุจ ุงูุชุฑุงุถูŠุŒ ููŠุฌุจ ุนู„ูŠูƒ ุฅุฏุฎุงู„ ู…ุนู„ูˆู…ุงุช ุญุณุงุจ ุงู„ุงุณุชุฑุฏุงุฏ..", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "payments.cancel.cancel", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฒฐ์ œ ์ทจ์†Œ ์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์ทจ์†Œ๋œ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/receipts/{imp_uid}": { + "get": { + "tags": [], + "parameters": [ + { + "name": "imp_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "ู…ู† ุงู„ุฏูุน ุงู„ู…ู†ุณูˆุจ", + "required": true + } + ], + "responses": { + "200": { + "description": "ู…ุนู„ูˆู…ุงุช ุงุณุชู„ุงู… ุงู„ู†ู‚ุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportReceipt_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ุนุฑุถ ุฅูŠุตุงู„ ุงู„ู†ู‚ุฏูŠุฉ", + "description": "ุนุฑุถ ุฅูŠุตุงู„ ุงู„ู†ู‚ุฏูŠุฉ.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "receipts.at", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "imp_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ท€์† ๊ฒฐ์ œ์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "IIamportPayment.imp_uid", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-iamport-server/src/api/structures/IIamportPayment.ts", + "textSpan": { + "start": 2339, + "length": 16 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "GET" + }, + "post": { + "tags": [], + "parameters": [ + { + "name": "imp_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "ู…ู† ุงู„ุฏูุน ุงู„ู…ู†ุณูˆุจ", + "required": true + } + ], + "requestBody": { + "description": "ู…ุนู„ูˆู…ุงุช ุฅุฏุฎุงู„ ุฅูŠุตุงู„ ุงู„ู†ู‚ุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportReceipt.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ู…ุนู„ูˆู…ุงุช ุงุณุชู„ุงู… ุงู„ู†ู‚ุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportReceipt_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ุฅุตุฏุงุฑ ุฅูŠุตุงู„ ู†ู‚ุฏูŠ", + "description": "ุฅุตุฏุงุฑ ุฅูŠุตุงู„ ู†ู‚ุฏูŠ.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "receipts.store", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "imp_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ท€์† ๊ฒฐ์ œ์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "IIamportPayment.imp_uid", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-iamport-server/src/api/structures/IIamportPayment.ts", + "textSpan": { + "start": 2339, + "length": 16 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + }, + "delete": { + "tags": [], + "parameters": [ + { + "name": "imp_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "ู…ู† ุงู„ุฏูุน ุงู„ู…ู†ุณูˆุจ", + "required": true + } + ], + "responses": { + "200": { + "description": "ู…ุนู„ูˆู…ุงุช ุงุณุชู„ุงู… ุงู„ู†ู‚ุฏ ุงู„ู…ู„ุบุงุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportReceipt_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ุฅู„ุบุงุก ุฅูŠุตุงู„ ู†ู‚ุฏูŠ", + "description": "ุฅู„ุบุงุก ุฅูŠุตุงู„ ู†ู‚ุฏูŠ.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "receipts.erase", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "imp_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ท€์† ๊ฒฐ์ œ์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "IIamportPayment.imp_uid", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-iamport-server/src/api/structures/IIamportPayment.ts", + "textSpan": { + "start": 2339, + "length": 16 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์ทจ์†Œ๋œ ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "DELETE" + } + }, + "/users/getToken": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "I'mport's API ูˆุงู„ู…ุนู„ูˆู…ุงุช ุงู„ุฑุฆูŠุณูŠุฉ ุงู„ุณุฑูŠุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportUser.IAccessor" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ู…ุนู„ูˆู…ุงุช ุฑู…ุฒ ู…ุตุงุฏู‚ุฉ ุงู„ู…ุณุชุฎุฏู…", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportUser_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ุฅุตุฏุงุฑ ุฑู…ุฒ ู…ุตุงุฏู‚ุฉ ุงู„ู…ุณุชุฎุฏู…", + "description": "ุฅุตุฏุงุฑ ุฑู…ุฒ ู…ุตุงุฏู‚ุฉ ุงู„ู…ุณุชุฎุฏู…. ูŠุชู… ุฅุตุฏุงุฑ ุฑู…ุฒ ู…ุตุงุฏู‚ุฉ ุงู„ู…ุณุชุฎุฏู… ุงุณุชู†ุงุฏู‹ุง ุฅู„ู‰ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช (API) ูˆุงู„ู…ูุชุงุญ ุงู„ุณุฑูŠ ุงู„ู…ู…ู†ูˆุญ ู…ู† ุฎู„ุงู„ ุงู„ุงุดุชุฑุงูƒ ููŠ I'mport. ูˆู…ุน ุฐู„ูƒุŒ ูุฅู† ุฑู…ุฒ ู…ุตุงุฏู‚ุฉ ุงู„ู…ุณุชุฎุฏู… ุงู„ุตุงุฏุฑ ุนู† Iimport ู„ู‡ ูˆู‚ุช ุงู†ุชู‡ุงุก ุตู„ุงุญูŠุฉ {@link IIamportUser.expired_at}ุŒ ูˆุนู†ุฏู…ุง ูŠู†ู‚ุถูŠ ู‡ุฐุง ุงู„ูˆู‚ุชุŒ ุชู†ุชู‡ูŠ ุตู„ุงุญูŠุฉ ุงู„ุฑู…ุฒ ุงู„ู…ู…ูŠุฒ ุงู„ุฐูŠ ุชู… ุฅุตุฏุงุฑู‡ ู…ุณุจู‚ู‹ุง ูˆู„ุง ูŠู…ูƒู† ุงุณุชุฎุฏุงู…ู‡ ุจุนุฏ ุฐู„ูƒ. ู„ุฐู„ูƒุŒ ุฅุฐุง ูƒู†ุช ุชุฑูŠุฏ ุงุณุชุฎุฏุงู… ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ุงู„ุฎุงุตุฉ ุจุงู„ุงุณุชูŠุฑุงุฏ ุจุญุฑูŠุฉ ุฏูˆู† ุงู„ุชู‚ูŠุฏ ุจุงู„ู‚ูŠูˆุฏ ุงู„ุฒู…ู†ูŠุฉ ู„ู„ุงุณุชูŠุฑุงุฏุŒ ูุงุณุชุฎุฏู… {@link IamportConnector } ุงู„ู…ู‚ุฏู… ู…ู† `iamport-server-api`..", + "x-nestia-namespace": "users.getToken.getToken", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์•„์ž„ํฌํŠธ์˜ API ๋ฐ secret ํ‚ค ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์œ ์ € ์ธ์ฆ ํ† ํฐ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/vbanks": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "ู…ุนู„ูˆู…ุงุช ุฅุฏุฎุงู„ ุงู„ุญุณุงุจ ุงู„ุธุงู‡ุฑูŠ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportVBankPayment.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน ุจุงู„ุญุณุงุจ ุงู„ุงูุชุฑุงุถูŠ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportVBankPayment_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ุฅุตุฏุงุฑ ุญุณุงุจ ุงูุชุฑุงุถูŠ", + "description": "ุฅุตุฏุงุฑ ุญุณุงุจ ุงูุชุฑุงุถูŠ.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "vbanks.store", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฐ€์ƒ ๊ณ„์ขŒ ์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฐ€์ƒ ๊ณ„์ขŒ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + }, + "put": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "ุงู„ุญุณุงุจ ุงู„ุธุงู‡ุฑูŠ ุชุญุฑูŠุฑ ู…ุนู„ูˆู…ุงุช ุงู„ุฅุฏุฎุงู„", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportVBankPayment.IUpdate" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ุชุนุฏูŠู„ ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน ู„ู„ุญุณุงุจ ุงู„ุงูุชุฑุงุถูŠ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportVBankPayment_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ุชุญุฑูŠุฑ ุญุณุงุจ ุงูุชุฑุงุถูŠ", + "description": "ุชุญุฑูŠุฑ ุญุณุงุจ ุงูุชุฑุงุถูŠ.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "vbanks.update", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฐ€์ƒ ๊ณ„์ขŒ ํŽธ์ง‘ ์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "ํŽธ์ง‘๋œ ๊ฐ€์ƒ ๊ณ„์ขŒ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "PUT" + } + }, + "/subscribe/customers/{customer_uid}": { + "get": { + "tags": [], + "parameters": [ + { + "name": "customer_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "ู…ูุชุงุญ ู…ุนุฑู ุงู„ุนู…ูŠู„ (ุจุทุงู‚ุฉ ุงู„ุฏูุน ุงู„ุจุณูŠุทุฉ).", + "required": true + } + ], + "responses": { + "200": { + "description": "ู…ุนู„ูˆู…ุงุช ุจุทุงู‚ุฉ ุงู„ุฏูุน ุงู„ุจุณูŠุทุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportSubscription_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ุงู„ุชุญู‚ู‚ ู…ู† ู…ุนู„ูˆู…ุงุช ุจุทุงู‚ุฉ ุงู„ุฏูุน ุจุณู‡ูˆู„ุฉ", + "description": "ุงู„ุชุญู‚ู‚ ู…ู† ู…ุนู„ูˆู…ุงุช ุจุทุงู‚ุฉ ุงู„ุฏูุน ุจุณู‡ูˆู„ุฉ. `subscribe.customers.at` ู‡ูŠ ุฅุญุฏู‰ ูˆุธุงุฆู ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช (API) ุงู„ุชูŠ ุชุจุญุซ ููŠ ู…ุนู„ูˆู…ุงุช ุจุทุงู‚ุฉ ุงู„ุฏูุน ุงู„ุจุณูŠุทุฉ ุงู„ุชูŠ ุญูุธู‡ุง ุงู„ุนู…ูŠู„ ุจุงุณุชุฎุฏุงู… {@link store} ุฃูˆ ู†ุงูุฐุฉ ุชุณุฌูŠู„ ุจุทุงู‚ุฉ ุงู„ุฏูุน ุงู„ุจุณูŠุทุฉ ุงู„ู…ู‚ุฏู…ุฉ ู…ู† Import..", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "subscribe.customers.at", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "customer_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ณ ๊ฐ (๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ) ์‹๋ณ„์ž ํ‚ค", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "GET" + }, + "post": { + "tags": [], + "parameters": [ + { + "name": "customer_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "ู…ูุชุงุญ ู…ุนุฑู ุงู„ุนู…ูŠู„ (ุจุทุงู‚ุฉ ุงู„ุฏูุน ุงู„ุจุณูŠุทุฉ).", + "required": true + } + ], + "requestBody": { + "description": "ู…ุนู„ูˆู…ุงุช ุฅุฏุฎุงู„ ุงู„ุจุทุงู‚ุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportSubscription.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ู…ุนู„ูˆู…ุงุช ุจุทุงู‚ุฉ ุงู„ุฏูุน ุงู„ุจุณูŠุทุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportSubscription_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ุชุณุฌูŠู„ ุจุทุงู‚ุฉ ุฏูุน ุจุณูŠุทุฉ", + "description": "ุชุณุฌูŠู„ ุจุทุงู‚ุฉ ุฏูุน ุจุณูŠุทุฉ. `subscribe.customers.stoer` ู‡ูŠ ูˆุธูŠูุฉ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช (API) ุชูุณุชุฎุฏู… ุนู†ุฏู…ุง ูŠุณุฌู„ ุงู„ุนู…ูŠู„ ุจุทุงู‚ุชู‡ ุนู„ู‰ ุงู„ุฎุงุฏู… ูˆูŠุฑูŠุฏ ุฅุฌุฑุงุก ุงู„ุฏูุน ุจุณู‡ูˆู„ุฉ ุฏูˆู† ุงู„ุญุงุฌุฉ ุฅู„ู‰ ุฅุฏุฎุงู„ ู…ุนู„ูˆู…ุงุช ุงู„ุจุทุงู‚ุฉ ุจุดูƒู„ ู…ุชูƒุฑุฑ ููŠ ูƒู„ ู…ุฑุฉ ูŠูุทู„ุจ ููŠู‡ุง ุงู„ุฏูุน. ูƒู…ุฑุฌุนุŒ ุฅุฐุง ูƒุงู† ุชุทุจูŠู‚ ุงู„ุนู…ูŠู„ ุงู„ุฎุงุต ุจู€ "subscribe.customers.store" ูŠุณุชุฎุฏู… ู†ุงูุฐุฉ ุชุณุฌูŠู„ ุจุทุงู‚ุฉ ุงู„ุฏูุน ุงู„ุจุณูŠุทุฉ ุงู„ุชูŠ ุชูˆูุฑู‡ุง iImportุŒ ูู„ู† ูŠุณุชุฏุนูŠ ุฎุงุฏู… ุงู„ูˆุงุฌู‡ุฉ ุงู„ุฎู„ููŠุฉ ู‡ุฐุง ููŠ ุงู„ุฎุฏู…ุฉ ุงู„ูุนู„ูŠุฉ. ูˆู…ุน ุฐู„ูƒุŒ ูŠู…ูƒู† ุงุณุชุฎุฏุงู…ู‡ ุนู„ู‰ ู…ุณุชูˆู‰ ุจุฑู†ุงู…ุฌ ุฃุชู…ุชุฉ ุงู„ุงุฎุชุจุงุฑ ู„ู…ุญุงูƒุงุฉ ุงู„ู…ูˆู‚ู ุญูŠุซ ูŠู‚ูˆู… ุงู„ุนู…ูŠู„ ุจุชุณุฌูŠู„ ุจุทุงู‚ุฉ ุฏูุน ุจุณูŠุทุฉ..", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "subscribe.customers.store", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "customer_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ณ ๊ฐ (๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ) ์‹๋ณ„์ž ํ‚ค", + "kind": "text" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์นด๋“œ ์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + }, + "delete": { + "tags": [], + "parameters": [ + { + "name": "customer_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "ู…ูุชุงุญ ู…ุนุฑู ุงู„ุนู…ูŠู„ (ุจุทุงู‚ุฉ ุงู„ุฏูุน ุงู„ุจุณูŠุทุฉ).", + "required": true + } + ], + "responses": { + "200": { + "description": "ุชู… ุญุฐู ู…ุนู„ูˆู…ุงุช ุจุทุงู‚ุฉ ุงู„ุฏูุน ุงู„ุจุณูŠุทุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportSubscription_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ุญุฐู ุจุทุงู‚ุฉ ุฏูุน ุจุณูŠุทุฉ", + "description": "ุญุฐู ุจุทุงู‚ุฉ ุฏูุน ุจุณูŠุทุฉ. ู‚ู… ุจุฅุฒุงู„ุฉ ุงู„ุจุทุงู‚ุฉ ุงู„ู…ุณุฌู„ุฉ ู„ุชุณู‡ูŠู„ ุงู„ุฏูุน.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "subscribe.customers.erase", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "customer_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ณ ๊ฐ (๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ) ์‹๋ณ„์ž ํ‚ค", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์‚ญ์ œ๋œ ๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "DELETE" + } + }, + "/subscribe/payments/onetime": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "ู…ุนู„ูˆู…ุงุช ุทู„ุจ ุงู„ุฏูุน ุจุงู„ุจุทุงู‚ุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportSubscription.IOnetime" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน ุจุงู„ุจุทุงู‚ุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportCardPayment_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ูŠู…ูƒู†ูƒ ุงู„ุฏูุน ุนู† ุทุฑูŠู‚ ุงู„ุจุทุงู‚ุฉ ูˆุงู„ุชุณุฌูŠู„ ู„ู„ุฏูุน ุงู„ุจุณูŠุท.", + "description": "ุจุงู„ุฅุถุงูุฉ ุฅู„ู‰ ุงู„ุฏูุน ุนู† ุทุฑูŠู‚ ุงู„ุจุทุงู‚ุฉุŒ ูŠู…ูƒู†ูƒ ุฃูŠุถู‹ุง ุงู„ุชุณุฌูŠู„ ู„ู„ุฏูุน ุงู„ุจุณูŠุท. `subscribe. Payments.onetime` ู‡ูŠ ูˆุธูŠูุฉ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ูŠุชู… ุงุณุชุฏุนุงุคู‡ุง ุนู†ุฏ ุฅุฌุฑุงุก ุงู„ุฏูุน ุนุจุฑ ุงู„ุจุทุงู‚ุฉ. ุจุงู„ุฅุถุงูุฉ ุฅู„ู‰ ุฐู„ูƒุŒ ุฅุฐุง ู‚ู…ุช ุจุฅุฏุฎุงู„ {@link IIamportSubscription.IOnetime.customer_uid } ููŠ ู‚ูŠู…ุฉ ุงู„ุฅุฏุฎุงู„ุŒ ูุณูŠุชู… ุชุณุฌูŠู„ ุงู„ุจุทุงู‚ุฉ ุงู„ู…ุณุชุฎุฏู…ุฉ ู„ู„ุฏูุน ูƒุจุทุงู‚ุฉ ุฏูุน ุจุณูŠุทุฉ {@link IIamportSubscription }. ูˆู…ุน ุฐู„ูƒุŒ ุฅุฐุง ูƒู†ุช ุชุฑูŠุฏ ุญู‚ู‹ุง ุฅุฌุฑุงุก ุชุณุฌูŠู„ ุจุณูŠุท ู„ู„ุจุทุงู‚ุฉ ูˆุงู„ุฏูุน ููŠ ู†ูุณ ุงู„ูˆู‚ุชุŒ ูุจุฏู„ุงู‹ ู…ู† ุฅุถุงูุฉ {@link IIamportSubscription.IOnetime.customer_uid } ุฅู„ู‰ `subscribe.Payments.onetime`ุŒ ุฃุถู {@link Submit.customers.store } ูˆ {@linkุงุดุชุฑุงูƒ.ุงู„ู…ุฏููˆุนุงุช ูŠูˆุตู‰ ุจุงู„ุงุชุตุงู„ ุจู€ .ู…ุฑุฉ ุฃุฎุฑู‰ } ุจุดูƒู„ ู…ู†ูุตู„. ูˆุฐู„ูƒ ู„ุฃู†ู‡ ูŠุชูŠุญ ู„ู†ุง ุงู„ุงุณุชุฌุงุจุฉ ุจุดูƒู„ ุฃูƒุซุฑ ุฃู…ุงู†ู‹ุง ู„ู„ู…ูˆุงู‚ู ุงู„ุงุณุชุซู†ุงุฆูŠุฉ. ุจุงู„ุฅุถุงูุฉ ุฅู„ู‰ ุฐู„ูƒุŒ ู„ู† ูŠุชู… ุงุณุชุฏุนุงุก `subscribe.Payments.onetime` ุจูˆุงุณุทุฉ ุฎุงุฏู… ุงู„ูˆุงุฌู‡ุฉ ุงู„ุฎู„ููŠุฉ ู„ุฏูŠูƒ ููŠ ุงู„ุฎุฏู…ุฉ ุงู„ูุนู„ูŠุฉ ุฅุฐุง ูƒุงู† ุชุทุจูŠู‚ ุงู„ุนู…ูŠู„ ูŠุณุชุฎุฏู… ู†ุงูุฐุฉ ุงู„ุฏูุน ุงู„ุชูŠ ูŠูˆูุฑู‡ุง ุงู„ุงุณุชูŠุฑุงุฏ. ูˆู…ุน ุฐู„ูƒุŒ ูŠู…ูƒู† ุงุณุชุฎุฏุงู…ู‡ ุนู„ู‰ ู…ุณุชูˆู‰ ุจุฑู†ุงู…ุฌ ุฃุชู…ุชุฉ ุงู„ุงุฎุชุจุงุฑ ู„ู…ุญุงูƒุงุฉ ุงู„ู…ูˆู‚ู ุงู„ุฐูŠ ูŠุฏูุน ููŠู‡ ุงู„ุนู…ูŠู„ ุจุงู„ุจุทุงู‚ุฉ..", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "subscribe.payments.onetime.onetime", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์นด๋“œ ๊ฒฐ์ œ ์‹ ์ฒญ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์นด๋“œ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/subscribe/payments/again": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "ู…ุนู„ูˆู…ุงุช ุทู„ุจ ุงู„ุฏูุน ุจุงุณุชุฎุฏุงู… ุจุทุงู‚ุฉ ู…ุณุฌู„ุฉ ู…ุณุจู‚ู‹ุง", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportSubscription.IAgain" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน ุจุงู„ุจุทุงู‚ุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportCardPayment_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ุงุฏูุน ุจุงุณุชุฎุฏุงู… ุจุทุงู‚ุฉ ู…ุณุฌู„ุฉ ู„ู„ุฏูุน ุงู„ุจุณูŠุท", + "description": "ุงุฏูุน ุจุงุณุชุฎุฏุงู… ุจุทุงู‚ุฉ ู…ุณุฌู„ุฉ ู„ู„ุฏูุน ุงู„ุจุณูŠุท. `subscribe. Payments.again` ู‡ูŠ ุฅุญุฏู‰ ูˆุธุงุฆู ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช (API) ุงู„ุชูŠ ูŠุชู… ุงุณุชุฏุนุงุคู‡ุง ุนู†ุฏู…ุง ูŠุฑูŠุฏ ุงู„ุนู…ูŠู„ ุฅุฌุฑุงุก ุงู„ุฏูุน ุจุงุณุชุฎุฏุงู… ุงู„ุจุทุงู‚ุฉ ุงู„ู…ุณุฌู„ุฉ ู„ู„ุฏูุน ุงู„ุจุณูŠุท. ุจุบุถ ุงู„ู†ุธุฑ ุนู…ุง ุฅุฐุง ูƒุงู† ุฐู„ูƒ ู…ู†ุงุณุจู‹ุง ุฃู… ุบูŠุฑ ู…ู†ุงุณุจุŒ ูŠุนุฏ ู‡ุฐุง ููŠ ุงู„ุฃุณุงุณ ุฌุฒุกู‹ุง ู…ู† ุงู„ุฏูุน ุจุงู„ุจุทุงู‚ุฉุŒ ูˆุจุงู„ุชุงู„ูŠ ูุฅู† ู‚ูŠู…ุฉ ุงู„ุฅุฑุฌุงุน ู‡ูŠ {@link IIamportCardPayment }ุŒ ูˆู‡ูŠ ู†ูุณ ู‚ูŠู…ุฉ ุฏูุนุงุช ุงู„ุจุทุงู‚ุฉ ุงู„ุนุงุฏูŠุฉ. ูˆ"subscribe. Payments.again" ู‡ูŠ ุทุฑูŠู‚ุฉ ุงู„ุฏูุน ุงู„ูˆุญูŠุฏุฉ ุงู„ุชูŠ ุชู†ุทุจู‚ ุนู„ู‰ ุงู„ุญุงู„ุงุช ุงู„ุชูŠ ู„ุง ูŠุชู…ูƒู† ููŠู‡ุง ุชุทุจูŠู‚ ุงู„ุนู…ูŠู„ ู…ู† ุงุณุชุฎุฏุงู… ู†ุงูุฐุฉ ุงู„ุฏูุน ุงู„ุชูŠ ุชูˆูุฑู‡ุง I'mportุŒ ูˆูŠุฌุจ ุฃู† ูŠู‚ูˆู… ุฎุงุฏู… ุงู„ูˆุงุฌู‡ุฉ ุงู„ุฎู„ููŠุฉ ู„ุฏูŠูƒ ุจุงุณุชุฏุนุงุก ูˆุธูŠูุฉ I'mport's API ู…ุจุงุดุฑุฉู‹. ู„ุฐู„ูƒุŒ ุนู†ุฏ ุชุทูˆูŠุฑ ุฎูˆุงุฏู… ุงู„ูˆุงุฌู‡ุฉ ุงู„ุฎู„ููŠุฉ ูˆุงู„ุชุทุจูŠู‚ุงุช ุงู„ุฃู…ุงู…ูŠุฉ ุงู„ุชูŠ ุชุฑุชุจุท ุจุฎุงุฏู… ุงู„ุงุณุชูŠุฑุงุฏ ู„ู„ู…ุฏููˆุนุงุช ุงู„ุจุณูŠุทุฉุŒ ูŠู„ุฒู… ุชุตู…ูŠู… ูˆุชุทูˆูŠุฑ ู…ู†ูุตู„ูŠู† ู„ู‡ุฐู‡ ุงู„ุญุงู„ุฉุŒ ู„ุฐุง ูŠุฑุฌู‰ ูˆุถุน ุฐู„ูƒ ููŠ ุงู„ุงุนุชุจุงุฑ..", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "subscribe.payments.again.again", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋ฏธ๋ฆฌ ๋“ฑ๋กํ•œ ์นด๋“œ๋ฅผ ์ด์šฉํ•œ ๊ฒฐ์ œ ์‹ ์ฒญ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์นด๋“œ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + } + }, + "components": { + "schemas": { + "IIamportResponse_lt_IIamportCertification_gt_": { + "type": "object", + "properties": { + "code": { + "description": "ุฑู…ุฒ ุงู„ุฎุทุฃ. ุงู„ู‚ูŠู…ุฉ 0 ุชุนู†ูŠ ุนุฏู… ูˆุฌูˆุฏ ุฎุทุฃ..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "message": { + "description": "ุฑุณุงู„ุฉ ุงู„ู†ุฌุงุญ ุฃูˆ ุงู„ุฎุทุฃ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/IIamportCertification" + } + }, + "required": [ + "code", + "message", + "response" + ], + "description": "ุฃู‚ูˆู… ุจุงุณุชูŠุฑุงุฏ ุจูŠุงู†ุงุช ุงู„ุงุณุชุฌุงุจุฉ ุงู„ูุฑูŠุฏุฉ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportCertification": { + "type": "object", + "properties": { + "imp_uid": { + "description": "ุฑู‚ู… ุงู„ุชุนุฑูŠู ุงู„ุตุงุฏุฑ ุนู† ุงู„ุงุณุชูŠุฑุงุฏ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "merchant_uid": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "description": "ู…ูุชุงุญ ุงู„ู…ุนุฑู ู…ู† ุงู„ุฎุฏู…ุฉ. ูˆู„ุง ูŠุชู… ุฅุตุฏุงุฑู‡ ูˆุฅุฏุงุฑุชู‡ ุจูˆุงุณุทุฉ ุฎุงุฏู… ุงู„ุงุณุชูŠุฑุงุฏุŒ ูˆู„ูƒู† ุจูˆุงุณุทุฉ ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู…ู‡..", + "x-typia-required": true, + "x-typia-optional": false + }, + "name": { + "description": "ุงุณู… ุงู„ุดุฎุต ุงู„ุฎุงุถุน ู„ู„ุชุญู‚ู‚ ู…ู† ุงู„ู‡ูˆูŠุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "gender": { + "description": "ุฌู†ุณ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "birth": { + "description": "ุชุงุฑูŠุฎ ุงู„ู…ูŠู„ุงุฏ. ูŠุชู… ุงุณุชุฎุฏุงู… ูˆู‚ุช Linux.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "birthday": { + "description": "ุชุงุฑูŠุฎ ุงู„ู…ูŠู„ุงุฏ ุจุงู„ุตูŠุบุฉ YYYYMMDD.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^([0-9]{4})(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$" + }, + "foreigner": { + "description": "ุฃุฌู†ุจูŠ ุฃู… ู„ุง.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "phone": { + "description": "ุฑู‚ู… ุงู„ู‡ุงุชู ุงู„ู…ุญู…ูˆู„ ู„ู„ุดุฎุต ู„ู„ุชุญู‚ู‚ ู…ู† ุงู„ู‡ูˆูŠุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "carrier": { + "oneOf": [ + { + "const": "SKT" + }, + { + "const": "KT" + }, + { + "const": "LGT" + } + ], + "description": "ุฑู…ุฒ ุดุฑูƒุฉ ุงู„ุงุชุตุงู„ุงุช ู„ู„ุชุญู‚ู‚ ู…ู† ุงู„ู‡ูˆูŠุฉ.", + "x-typia-required": true, + "x-typia-optional": false + }, + "certified": { + "description": "ุญุงู„ุฉ ู…ุตุงุฏู‚ุฉ OTP.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "certified_at": { + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ู…ุตุงุฏู‚ุฉ OTP. ูŠุชู… ุงุณุชุฎุฏุงู… ูˆู‚ุช LinuxุŒ ูˆูŠุชู… ุงุณุชุฎุฏุงู… 0 ุจุฏู„ุงู‹ ู…ู† `null`.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "unique_key": { + "description": "ู„ุง ุฃุนุฑู ู…ุง ู‡ูˆุŒ ู‡ู„ ูŠุนุฑู ุฃุญุฏ ู…ุง ู‡ูˆุŸ", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "unique_in_site": { + "description": "ู„ุง ุฃุนุฑู ู…ุง ู‡ูˆุŒ ู‡ู„ ูŠุนุฑู ุฃุญุฏ ู…ุง ู‡ูˆุŸ", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_tid": { + "description": "ู„ุง ุฃุนุฑู ู…ุง ู‡ูˆุŒ ู‡ู„ ูŠุนุฑู ุฃุญุฏ ู…ุง ู‡ูˆุŸ", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_provider": { + "description": "ู…ุฒูˆุฏ PG.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "origin": { + "description": "ู„ุง ุฃุนุฑู ู…ุง ู‡ูˆุŒ ู‡ู„ ูŠุนุฑู ุฃุญุฏ ู…ุง ู‡ูˆุŸ", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "__otp": { + "description": "(ู„ู„ุงุฎุชุจุงุฑ ูู‚ุท) ุฑู…ุฒ OTP. ู‡ุฐู‡ ุฎุงุตูŠุฉ ุชูุณุชุฎุฏู… ูู‚ุท ููŠ `fake-iamport-server`ุŒ ูˆุชูุณุชุฎุฏู… ู„ู„ุชุญู‚ู‚ ู…ู† ุฑู…ุฒ OTP ุงู„ุฐูŠ ุชู… ุฅุตุฏุงุฑู‡ ุนู†ุฏ ู…ุญุงูƒุงุฉ ู…ุตุงุฏู‚ุฉ ุงู„ู‡ูˆูŠุฉ. ุจุงุณุชุฎุฏุงู… ู‡ุฐุง ู„ู„ุงุชุตุงู„ ุจูˆุธูŠูุฉ {@linkfunctional.certifications.otp.confirm }ุŒ ูŠู…ูƒู†ูƒ ุฅูƒู…ุงู„ ุนู…ู„ูŠุฉ ุงู„ุชุญู‚ู‚ ู…ู† ู‡ูˆูŠุชูƒ..", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + } + }, + "required": [ + "imp_uid", + "merchant_uid", + "name", + "gender", + "birth", + "birthday", + "foreigner", + "phone", + "carrier", + "certified", + "certified_at", + "unique_key", + "unique_in_site", + "pg_tid", + "pg_provider", + "origin" + ], + "description": "ุชูุงุตูŠู„ ุงู„ู…ุตุงุฏู‚ุฉ ุงู„ุดุฎุตูŠุฉ. `IIamportCertification` ู‡ูŠ ูˆุงุฌู‡ุฉ ุจู†ูŠุฉ ุจูŠุงู†ุงุช ุชุฌุณุฏ ู…ุนู„ูˆู…ุงุช ุงู„ู…ุตุงุฏู‚ุฉ ุงู„ุดุฎุตูŠุฉ ู„ู€ Iimport. ูˆู…ุน ุฐู„ูƒุŒ ูุฅู† ูˆุฌูˆุฏ ุณุฌู„ `IIamportCertification` ู„ุง ูŠุนู†ูŠ ุงูƒุชู…ุงู„ ู…ุตุงุฏู‚ุฉ ุงู„ู‡ูˆูŠุฉ. ูู‚ุท ุนู†ุฏู…ุง ุชูƒูˆู† ู‚ูŠู…ุฉ {@link IIamportCertification.certified } "ุตุญูŠุญุฉ"ุŒ ูู‡ุฐุง ูŠุนู†ูŠ ุฃู† ุงู„ุดุฎุต ุงู„ู…ุทู„ูˆุจ ุงู„ู…ุตุงุฏู‚ุฉ ุนู„ูŠู‡ ู‚ุฏ ุฃูƒู…ู„ ุงู„ู…ุตุงุฏู‚ุฉ ุนู† ุทุฑูŠู‚ ูƒุชุงุจุฉ ูƒู„ู…ุฉ ุงู„ู…ุฑูˆุฑ ู„ู…ุฑุฉ ูˆุงุญุฏุฉ (OTP) ุงู„ู…ุฑุณู„ุฉ ุฅู„ู‰ ุฑู‚ู… ู‡ุงุชูู‡ ุงู„ู…ุญู…ูˆู„ ุจุฏู‚ุฉ ููŠ ู†ุงูุฐุฉ ู…ุตุงุฏู‚ุฉ iAmport ุงู„ู…ู†ุจุซู‚ุฉ..", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportCertification.IStore": { + "type": "object", + "properties": { + "name": { + "description": "ุงุณู… ุงู„ุดุฎุต ุงู„ุฎุงุถุน ู„ู„ุชุญู‚ู‚ ู…ู† ุงู„ู‡ูˆูŠุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "phone": { + "description": "ุฑู‚ู… ุงู„ู‡ุงุชู ุงู„ู…ุญู…ูˆู„ ู„ู„ุดุฎุต ุงู„ุฐูŠ ูŠุชุญู‚ู‚ ู…ู† ู‡ูˆูŠุชู‡. ู„ุง ูŠู‡ู… ู…ุง ุฅุฐุง ูƒุงู† ุฑู‚ู… ุงู„ู‡ุงุชู ุงู„ุฎู„ูŠูˆูŠ ูŠุญุชูˆูŠ ุนู„ู‰ "-" ุฃู… ู„ุง. ูˆู…ุน ุฐู„ูƒุŒ ุชุชู… ู…ุนุงู„ุฌุชู‡ ุฏุงุฎู„ูŠู‹ุง ุนู† ุทุฑูŠู‚ ุฅุฒุงู„ุฉ ุงู„ู‚ูŠู…ุฉ "-"..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "birth": { + "description": "ุชุงุฑูŠุฎ ุงู„ู…ูŠู„ุงุฏ. ุชู†ุณูŠู‚ YYYYMMDD.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^([0-9]{4})(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$" + }, + "gender_digit": { + "description": "ุงู„ุฑู‚ู… ุงู„ุฃูˆู„ ููŠ ุงู„ุฌุฒุก ุงู„ุฎู„ููŠ ู…ู† ุชุณุฌูŠู„ ุงู„ู…ู‚ูŠู….", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "carrier": { + "oneOf": [ + { + "const": "SKT" + }, + { + "const": "KT" + }, + { + "const": "LGT" + } + ], + "description": "ุฑู…ุฒ ุดุฑูƒุฉ ุงู„ุงุชุตุงู„ุงุช ู„ู„ุชุญู‚ู‚ ู…ู† ุงู„ู‡ูˆูŠุฉ.", + "x-typia-required": true, + "x-typia-optional": false + }, + "is_mvno": { + "description": "ู‡ุงุชู ุงู„ู…ูŠุฒุงู†ูŠุฉ ุฃู… ู„ุงุŸ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "boolean" + }, + "commpany": { + "description": "ุงุณู… ุฎุฏู…ุฉ ุงู„ุชุงุฌุฑ ุฃูˆ ุนู†ูˆุงู† URL ู„ู„ู†ุทุงู‚. ุงุณู… ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุณูŠุชู… ุงู„ุฅุนู„ุงู† ุนู†ู‡ุง ููŠ ุงู„ุฑุณุงู„ุฉ ุงู„ู†ุตูŠุฉ ุงู„ู‚ุตูŠุฑุฉ ุงู„ู…ุฑุณู„ุฉ ู…ู† KISA ุฅู„ู‰ ุงู„ุดุฎุต ุงู„ู…ุณุชู‡ุฏู.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "merchant_uid": { + "description": "ู…ูุชุงุญ ู…ุนุฑู ู…ุตุงุฏู‚ุฉ ุงู„ู‡ูˆูŠุฉ ู„ุฎุฏู…ุฉ ุดุฑูƒุชูƒ. ูˆู„ุง ูŠุชู… ุฅุตุฏุงุฑู‡ ูˆุฅุฏุงุฑุชู‡ ุจูˆุงุณุทุฉ ุฎุงุฏู… ุงู„ุงุณุชูŠุฑุงุฏุŒ ูˆู„ูƒู† ุจูˆุงุณุทุฉ ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู…ู‡..", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "pg": { + "description": "ูุงุตู„ ุดุฑูƒุฉ PG. ูŠู…ูƒู†ูƒ ุถุจุท ู‡ุฐุง ุฅุฐุง ูƒู†ุช ุชุฑูŠุฏ ุงุณุชุฎุฏุงู… ู…ุนุฑููŠู† ุฃูˆ ุฃูƒุซุฑ ู„ู…ุชุฌุฑ Danal ููŠ ู†ูุณ ุงู„ูˆู‚ุช. ู…ุญุฏุฏ ููŠ ุงู„ู†ู…ูˆุฐุฌ **danal.{store ID}**.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + } + }, + "required": [ + "name", + "phone", + "birth", + "gender_digit", + "carrier" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุฅุฏุฎุงู„ ุงู„ู…ุตุงุฏู‚ุฉ ุงู„ุดุฎุตูŠุฉ.", + "x-typia-jsDocTags": [] + }, + "IIamportResponse_lt_IIamportCertification.IAccessor_gt_": { + "type": "object", + "properties": { + "code": { + "description": "ุฑู…ุฒ ุงู„ุฎุทุฃ. ุงู„ู‚ูŠู…ุฉ 0 ุชุนู†ูŠ ุนุฏู… ูˆุฌูˆุฏ ุฎุทุฃ..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "message": { + "description": "ุฑุณุงู„ุฉ ุงู„ู†ุฌุงุญ ุฃูˆ ุงู„ุฎุทุฃ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/IIamportCertification.IAccessor" + } + }, + "required": [ + "code", + "message", + "response" + ], + "description": "ุฃู‚ูˆู… ุจุงุณุชูŠุฑุงุฏ ุจูŠุงู†ุงุช ุงู„ุงุณุชุฌุงุจุฉ ุงู„ูุฑูŠุฏุฉ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportCertification.IAccessor": { + "type": "object", + "properties": { + "imp_uid": { + "description": "ู…ูุชุงุญ ุงู„ู…ุนุฑู ู„ู…ุนู„ูˆู…ุงุช ุงู„ู…ุตุงุฏู‚ุฉ ุงู„ุดุฎุตูŠุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "imp_uid" + ], + "description": "ู‡ูŠูƒู„ ุงู„ูˆุตูˆู„ ู„ู…ุนู„ูˆู…ุงุช ุงู„ู…ุตุงุฏู‚ุฉ ุงู„ุดุฎุตูŠุฉ.", + "x-typia-jsDocTags": [] + }, + "IIamportCertification.IConfirm": { + "type": "object", + "properties": { + "otp": { + "description": "ูŠุชู… ุฅุฑุณุงู„ ุฑู‚ู… ุงู„ุชุญู‚ู‚ ู…ู† ุงู„ู‡ูˆูŠุฉ ุนุจุฑ ุงู„ุฑุณุงุฆู„ ุงู„ู‚ุตูŠุฑุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "otp" + ], + "description": "ุฅุฏุฎุงู„ ุงู„ู…ุนู„ูˆู…ุงุช ู„ู„ู…ูˆุงูู‚ุฉ ุนู„ู‰ ุงู„ุชุญู‚ู‚ ู…ู† ุงู„ู‡ูˆูŠุฉ.", + "x-typia-jsDocTags": [] + }, + "IIamportPayment.IWebhook": { + "type": "object", + "properties": { + "imp_uid": { + "description": "ู…ูุชุงุญ ุงู„ู…ุนุฑู ู„ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน {@link IIamportPayment }.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "merchant_uid": { + "description": "ู…ูุชุงุญ ู…ุนุฑู ุงู„ุทู„ุจ. ูˆู„ุง ูŠุชู… ุฅุตุฏุงุฑู‡ ูˆุฅุฏุงุฑุชู‡ ุจูˆุงุณุทุฉ ุฎุงุฏู… ุงู„ุงุณุชูŠุฑุงุฏุŒ ูˆู„ูƒู† ุจูˆุงุณุทุฉ ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู…ู‡..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "status": { + "oneOf": [ + { + "const": "paid" + }, + { + "const": "ready" + }, + { + "const": "failed" + }, + { + "const": "cancelled" + } + ], + "description": "ุงู„ูˆุถุน ุงู„ุญุงู„ูŠ.", + "x-typia-required": true, + "x-typia-optional": false + } + }, + "required": [ + "imp_uid", + "merchant_uid", + "status" + ], + "description": "ุจูŠุงู†ุงุช ุงู„ูˆูŠุจ ู‡ูˆูƒ.", + "x-typia-jsDocTags": [] + }, + "IIamportPayment.IQuery": { + "type": "object", + "properties": { + "extension": { + "description": "ุจุงู„ู†ุณุจุฉ ู„ู€ PayPalุŒ ู‚ู… ุจุชุนูŠูŠู† ู‡ุฐู‡ ุงู„ู‚ูŠู…ุฉ ุนู„ู‰ "ุตุญูŠุญ"..", + "x-typia-required": false, + "x-typia-optional": true, + "type": "boolean" + } + }, + "description": "ุฅุฐุง ูƒุงู†ุช ุทุฑูŠู‚ุฉ ุงู„ุฏูุน ู‡ูŠ PayPalุŒ ูุณูŠุชู… ุชุนูŠูŠู† ุงู„ุญุงู„ุฉ ุฅู„ู‰ ู…ุนู„ู‚ ููŠ ูˆู‚ุช ุงู„ู…ูˆุงูู‚ุฉ ุนู„ู‰ ุงู„ุฏูุน ูˆูู‚ู‹ุง ู„ุณูŠุงุณุฉ ุญู…ุงูŠุฉ ุงู„ู…ุดุชุฑูŠ ููŠ PayPalุŒ ุซู… ูŠุชู… ุชุบูŠูŠุฑู‡ุง ุฅู„ู‰ ุงู„ุฏูุน ุงู„ู†ู‡ุงุฆูŠ ุงู„ู…ูƒุชู…ู„ ู…ู† ุฎู„ุงู„ ุงู„ู…ุฑุงุฌุนุฉ ุงู„ุฏุงุฎู„ูŠุฉ. ุจุณุจุจ ู…ุดูƒู„ุฉ ูู†ูŠุฉ ููŠ `iamport`ุŒ ูŠุชู… ุชุณุฌูŠู„ ุงู„ุญุงู„ุฉ ุจุงู„ุญุงู„ุฉ: ูุดู„. ุฅุฐุง ุชู… ุชุบูŠูŠุฑ ุงู„ุฏูุนุฉ ุงู„ู†ู‡ุงุฆูŠุฉ ู„ุงุญู‚ู‹ุง ู„ุฅูƒู…ุงู„ู‡ุง ููŠ PayPalุŒ ูู‚ู… ุจุชุบูŠูŠุฑ "iamport" ุฅู„ู‰ "ู…ุฏููˆุน" ูˆุฃุฑุณู„ ุฎุทุงูู‹ุง ุนุจุฑ ุงู„ูˆูŠุจ ู„ู„ุญุงู„ุฉ. ูŠูˆุงุฌู‡ ุงู„ุนู…ู„ุงุก ุงู„ุฐูŠู† ูŠุณุชุฎุฏู…ูˆู† iamport ู…ุดูƒู„ุฉ ููŠ ุชู„ู‚ูŠ ุฎุทุงูุงุช ุงู„ูˆูŠุจ ุงู„ู…ุฏููˆุนุฉ ู„ู„ู…ุฏููˆุนุงุช ุงู„ุชูŠ ุชู…ุช ู…ุนุงู„ุฌุชู‡ุง ุจุงู„ูุนู„ ุนู„ู‰ ุฃู†ู‡ุง ูุงุดู„ุฉ. ูˆุจู†ุงุกู‹ ุนู„ู‰ ุฐู„ูƒุŒ ูŠุฌุจ ุฅุถุงูุฉ ุงู„ุฎูŠุงุฑ `extension=true` ูƒุณู„ุณู„ุฉ ุงุณุชุนู„ุงู… ุฅู„ู‰ `/Payment/{imp_uid}` ุงู„ู…ู‚ุฏู… ู…ู† `iamport`.", + "x-typia-jsDocTags": [ + { + "name": "issue", + "text": [ + { + "text": "https://github.com/samchon/fake-iamport-server/issues/13", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Sangjin Han - https://github.com/ltnscp9028", + "kind": "text" + } + ] + } + ] + }, + "IIamportResponse_lt_IIamportPayment_gt_": { + "type": "object", + "properties": { + "code": { + "description": "ุฑู…ุฒ ุงู„ุฎุทุฃ. ุงู„ู‚ูŠู…ุฉ 0 ุชุนู†ูŠ ุนุฏู… ูˆุฌูˆุฏ ุฎุทุฃ..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "message": { + "description": "ุฑุณุงู„ุฉ ุงู„ู†ุฌุงุญ ุฃูˆ ุงู„ุฎุทุฃ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/IIamportPayment" + } + }, + "required": [ + "code", + "message", + "response" + ], + "description": "ุฃู‚ูˆู… ุจุงุณุชูŠุฑุงุฏ ุจูŠุงู†ุงุช ุงู„ุงุณุชุฌุงุจุฉ ุงู„ูุฑูŠุฏุฉ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportPayment": { + "oneOf": [ + { + "$ref": "#/components/schemas/IIamportCardPayment" + }, + { + "$ref": "#/components/schemas/IIamportTransferPayment" + }, + { + "$ref": "#/components/schemas/IIamportVBankPayment" + }, + { + "$ref": "#/components/schemas/IIamportPayment.IBase_lt__doublequote_phone_doublequote__space__or__space__doublequote_kpay_doublequote__space__or__space__doublequote_kakaopay_doublequote__space__or__space__doublequote_payco_doublequote__space__or__space__doublequote_lpay_doublequote__space__or__space__doublequote_ssgpay_doublequote__space__or__space__doublequote_tosspay_doublequote__space__or__space__doublequote_cultureland_doublequote__space__or__space__doublequote_smartculture_doublequote__space__or__space__doublequote_happymoney_doublequote__space__or__space__doublequote_booknlife_doublequote__space__or__space__doublequote_point_doublequote__gt_" + } + ], + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน. "IIamportPayment" ุนุจุงุฑุฉ ุนู† ุจู†ูŠุฉ ุจูŠุงู†ุงุช ุชุฌุณุฏ ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน ุงู„ุฎุงุตุฉ ุจู€ Iimport ูˆูˆุงุฌู‡ุฉ ู†ูˆุน ุงู„ุงุชุญุงุฏ ุนู†ุฏู…ุง ูŠุชู… ุชุญุฏูŠุฏ ู‚ูŠู…ุฉ ุงู„ุทุฑูŠู‚ุฉ ู…ู† ุฎู„ุงู„ ุงู„ุดุฑุทุŒ ูŠุชู… ุชุญุฏูŠุฏ ุงู„ู†ูˆุน ุงู„ู…ุดุชู‚ ุชู„ู‚ุงุฆูŠู‹ุง. ```ู†ูˆุน ุงู„ู†ุต ุฅุฐุง (Payment.pay_method === "card") Payment.card_number; // ุงู„ุฏูุน ูŠูƒูˆู† IIamportCardPayment ```", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportCardPayment": { + "type": "object", + "properties": { + "card_code": { + "description": "ุฑู…ุฒ ู…ุนุฑู ุงู„ุจุทุงู‚ุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "card_name": { + "description": "ุงุณู… ุงู„ุจุทุงู‚ุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "card_number": { + "description": "ุฑู‚ู… ุงู„ุจุทุงู‚ุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "\\d{4}-\\d{4}-\\d{4}-\\d{4}" + }, + "card_quota": { + "description": "ุนุฏุฏ ุงู„ุฃู‚ุณุงุท.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "integer" + }, + "apply_num": { + "description": "ุฑู‚ู… ู…ูˆุงูู‚ุฉ ุดุฑูƒุฉ ุงู„ุจุทุงู‚ุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pay_method": { + "oneOf": [ + { + "const": "card" + }, + { + "const": "samsung" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "imp_uid": { + "description": "ู…ูุชุงุญ ุงู„ู…ุนุฑู ู„ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน {@link IIamportPayment }.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "merchant_uid": { + "description": "ู…ูุชุงุญ ู…ุนุฑู ุงู„ุทู„ุจ. ูˆู„ุง ูŠุชู… ุฅุตุฏุงุฑู‡ ูˆุฅุฏุงุฑุชู‡ ุจูˆุงุณุทุฉ ุฎุงุฏู… ุงู„ุงุณุชูŠุฑุงุฏุŒ ูˆู„ูƒู† ุจูˆุงุณุทุฉ ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู…ู‡..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "name": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "description": "ุงุณู… ุงู„ุทู„ุจุŒ ู‚ุฏ ูŠุชู… ุญุฐูู‡.", + "x-typia-required": true, + "x-typia-optional": false + }, + "amount": { + "description": "ุฅุฌู…ุงู„ูŠ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancel_amount": { + "description": "ุฅู„ุบุงุก ุงู„ุฏูุนุŒ ุงุณุชุฑุฏุงุฏ ุงู„ู…ุจู„ุบ ุงู„ุฅุฌู…ุงู„ูŠ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "currency": { + "$ref": "#/components/schemas/IIamportPayment.Currency" + }, + "receipt_url": { + "description": "ุนู†ูˆุงู† URL ู„ู„ุฅูŠุตุงู„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "url" + }, + "cash_receipt_issue": { + "description": "ุฅุตุฏุงุฑ ุฅูŠุตุงู„ุงุช ู†ู‚ุฏูŠุฉุŸ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "channel": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_provider": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "emb_pg_provider": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "pg_id": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_tid": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "escrow": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "buyer_name": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_email": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "email" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_tel": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_addr": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_postcode": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_uid": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_uid_usage": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "custom_data": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "user_agent": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "status": { + "$ref": "#/components/schemas/IIamportPayment.Status" + }, + "started_at": { + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ุทู„ุจ ุงู„ุฏูุน. ูŠุชู… ุงุณุชุฎุฏุงู… ูˆู‚ุช Linux.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "paid_at": { + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ุฅุชู…ุงู… ุงู„ุฏูุน (ุงู„ุฏูุน). ูŠุชู… ุงุณุชุฎุฏุงู… ูˆู‚ุช LinuxุŒ ูˆูŠุชู… ุงุณุชุฎุฏุงู… 0 ุจุฏู„ุงู‹ ู…ู† `null`.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "failed_at": { + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ูุดู„ ุงู„ุฏูุน. ูŠุชู… ุงุณุชุฎุฏุงู… ูˆู‚ุช LinuxุŒ ูˆูŠุชู… ุงุณุชุฎุฏุงู… 0 ุจุฏู„ุงู‹ ู…ู† `null`.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancelled_at": { + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ุฅู„ุบุงุก ุงู„ุฏูุน. ูŠุชู… ุงุณุชุฎุฏุงู… ูˆู‚ุช LinuxุŒ ูˆูŠุชู… ุงุณุชุฎุฏุงู… 0 ุจุฏู„ุงู‹ ู…ู† `null`.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "fail_reason": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "cancel_reason": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "cancel_history": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/IIamportPaymentCancel" + } + } + }, + "required": [ + "card_code", + "card_name", + "card_number", + "card_quota", + "apply_num", + "pay_method", + "imp_uid", + "merchant_uid", + "name", + "amount", + "cancel_amount", + "currency", + "receipt_url", + "cash_receipt_issue", + "channel", + "pg_provider", + "emb_pg_provider", + "pg_id", + "pg_tid", + "escrow", + "buyer_name", + "buyer_email", + "buyer_tel", + "buyer_addr", + "buyer_postcode", + "customer_uid", + "customer_uid_usage", + "custom_data", + "user_agent", + "status", + "started_at", + "paid_at", + "failed_at", + "cancelled_at", + "fail_reason", + "cancel_reason", + "cancel_history" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน ุจุงู„ุจุทุงู‚ุฉ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportPayment.Currency": { + "oneOf": [ + { + "const": "KRW" + }, + { + "const": "USD" + }, + { + "const": "EUR" + }, + { + "const": "JPY" + } + ] + }, + "IIamportPayment.Status": { + "oneOf": [ + { + "const": "paid" + }, + { + "const": "ready" + }, + { + "const": "failed" + }, + { + "const": "cancelled" + } + ] + }, + "IIamportPaymentCancel": { + "type": "object", + "properties": { + "pg_id": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_tid": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancelled_at": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "reason": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "receipt_url": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "url" + } + }, + "required": [ + "pg_id", + "pg_tid", + "amount", + "cancelled_at", + "reason", + "receipt_url" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุฅู„ุบุงุก ุงู„ุฏูุน.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportTransferPayment": { + "type": "object", + "properties": { + "bank_code": { + "description": "ุฑู…ุฒ ู…ุนุฑู ุงู„ุจู†ูƒ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "bank_name": { + "description": "ุงุณู… ุงู„ุจู†ูƒ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pay_method": { + "const": "trans", + "x-typia-required": true, + "x-typia-optional": false + }, + "imp_uid": { + "description": "ู…ูุชุงุญ ุงู„ู…ุนุฑู ู„ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน {@link IIamportPayment }.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "merchant_uid": { + "description": "ู…ูุชุงุญ ู…ุนุฑู ุงู„ุทู„ุจ. ูˆู„ุง ูŠุชู… ุฅุตุฏุงุฑู‡ ูˆุฅุฏุงุฑุชู‡ ุจูˆุงุณุทุฉ ุฎุงุฏู… ุงู„ุงุณุชูŠุฑุงุฏุŒ ูˆู„ูƒู† ุจูˆุงุณุทุฉ ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู…ู‡..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "name": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "description": "ุงุณู… ุงู„ุทู„ุจุŒ ู‚ุฏ ูŠุชู… ุญุฐูู‡.", + "x-typia-required": true, + "x-typia-optional": false + }, + "amount": { + "description": "ุฅุฌู…ุงู„ูŠ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancel_amount": { + "description": "ุฅู„ุบุงุก ุงู„ุฏูุนุŒ ุงุณุชุฑุฏุงุฏ ุงู„ู…ุจู„ุบ ุงู„ุฅุฌู…ุงู„ูŠ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "currency": { + "$ref": "#/components/schemas/IIamportPayment.Currency" + }, + "receipt_url": { + "description": "ุนู†ูˆุงู† URL ู„ู„ุฅูŠุตุงู„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "url" + }, + "cash_receipt_issue": { + "description": "ุฅุตุฏุงุฑ ุฅูŠุตุงู„ุงุช ู†ู‚ุฏูŠุฉุŸ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "channel": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_provider": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "emb_pg_provider": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "pg_id": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_tid": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "escrow": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "buyer_name": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_email": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "email" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_tel": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_addr": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_postcode": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_uid": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_uid_usage": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "custom_data": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "user_agent": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "status": { + "$ref": "#/components/schemas/IIamportPayment.Status" + }, + "started_at": { + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ุทู„ุจ ุงู„ุฏูุน. ูŠุชู… ุงุณุชุฎุฏุงู… ูˆู‚ุช Linux.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "paid_at": { + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ุฅุชู…ุงู… ุงู„ุฏูุน (ุงู„ุฏูุน). ูŠุชู… ุงุณุชุฎุฏุงู… ูˆู‚ุช LinuxุŒ ูˆูŠุชู… ุงุณุชุฎุฏุงู… 0 ุจุฏู„ุงู‹ ู…ู† `null`.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "failed_at": { + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ูุดู„ ุงู„ุฏูุน. ูŠุชู… ุงุณุชุฎุฏุงู… ูˆู‚ุช LinuxุŒ ูˆูŠุชู… ุงุณุชุฎุฏุงู… 0 ุจุฏู„ุงู‹ ู…ู† `null`.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancelled_at": { + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ุฅู„ุบุงุก ุงู„ุฏูุน. ูŠุชู… ุงุณุชุฎุฏุงู… ูˆู‚ุช LinuxุŒ ูˆูŠุชู… ุงุณุชุฎุฏุงู… 0 ุจุฏู„ุงู‹ ู…ู† `null`.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "fail_reason": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "cancel_reason": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "cancel_history": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/IIamportPaymentCancel" + } + } + }, + "required": [ + "bank_code", + "bank_name", + "pay_method", + "imp_uid", + "merchant_uid", + "name", + "amount", + "cancel_amount", + "currency", + "receipt_url", + "cash_receipt_issue", + "channel", + "pg_provider", + "emb_pg_provider", + "pg_id", + "pg_tid", + "escrow", + "buyer_name", + "buyer_email", + "buyer_tel", + "buyer_addr", + "buyer_postcode", + "customer_uid", + "customer_uid_usage", + "custom_data", + "user_agent", + "status", + "started_at", + "paid_at", + "failed_at", + "cancelled_at", + "fail_reason", + "cancel_reason", + "cancel_history" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน ุนู† ุทุฑูŠู‚ ุชุญูˆูŠู„ ุงู„ุญุณุงุจ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportVBankPayment": { + "type": "object", + "properties": { + "vbank_code": { + "description": "ุฑู…ุฒ ู…ุนุฑู ุงู„ุญุณุงุจ ุงู„ุงูุชุฑุงุถูŠ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "vbank_name": { + "description": "ุงุณู… ุงู„ุญุณุงุจ ุงู„ุงูุชุฑุงุถูŠ", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "vbank_num": { + "description": "ุฑู‚ู… ุงู„ุญุณุงุจ ุงู„ุงูุชุฑุงุถูŠ", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "vbank_holder": { + "description": "ู…ูˆุฏุน ุงู„ุญุณุงุจ ุงู„ุธุงู‡ุฑูŠ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "vbank_date": { + "description": "ุชุงุฑูŠุฎ ุงู†ุชู‡ุงุก ุตู„ุงุญูŠุฉ ุฅูŠุฏุงุน ุงู„ุญุณุงุจ ุงู„ุงูุชุฑุงุถูŠ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vbank_issued_at": { + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ูุชุญ ุงู„ุญุณุงุจ ุงู„ุงูุชุฑุงุถูŠ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "pay_method": { + "const": "vbank", + "x-typia-required": true, + "x-typia-optional": false + }, + "imp_uid": { + "description": "ู…ูุชุงุญ ุงู„ู…ุนุฑู ู„ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน {@link IIamportPayment }.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "merchant_uid": { + "description": "ู…ูุชุงุญ ู…ุนุฑู ุงู„ุทู„ุจ. ูˆู„ุง ูŠุชู… ุฅุตุฏุงุฑู‡ ูˆุฅุฏุงุฑุชู‡ ุจูˆุงุณุทุฉ ุฎุงุฏู… ุงู„ุงุณุชูŠุฑุงุฏุŒ ูˆู„ูƒู† ุจูˆุงุณุทุฉ ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู…ู‡..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "name": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "description": "ุงุณู… ุงู„ุทู„ุจุŒ ู‚ุฏ ูŠุชู… ุญุฐูู‡.", + "x-typia-required": true, + "x-typia-optional": false + }, + "amount": { + "description": "ุฅุฌู…ุงู„ูŠ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancel_amount": { + "description": "ุฅู„ุบุงุก ุงู„ุฏูุนุŒ ุงุณุชุฑุฏุงุฏ ุงู„ู…ุจู„ุบ ุงู„ุฅุฌู…ุงู„ูŠ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "currency": { + "$ref": "#/components/schemas/IIamportPayment.Currency" + }, + "receipt_url": { + "description": "ุนู†ูˆุงู† URL ู„ู„ุฅูŠุตุงู„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "url" + }, + "cash_receipt_issue": { + "description": "ุฅุตุฏุงุฑ ุฅูŠุตุงู„ุงุช ู†ู‚ุฏูŠุฉุŸ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "channel": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_provider": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "emb_pg_provider": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "pg_id": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_tid": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "escrow": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "buyer_name": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_email": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "email" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_tel": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_addr": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_postcode": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_uid": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_uid_usage": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "custom_data": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "user_agent": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "status": { + "$ref": "#/components/schemas/IIamportPayment.Status" + }, + "started_at": { + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ุทู„ุจ ุงู„ุฏูุน. ูŠุชู… ุงุณุชุฎุฏุงู… ูˆู‚ุช Linux.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "paid_at": { + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ุฅุชู…ุงู… ุงู„ุฏูุน (ุงู„ุฏูุน). ูŠุชู… ุงุณุชุฎุฏุงู… ูˆู‚ุช LinuxุŒ ูˆูŠุชู… ุงุณุชุฎุฏุงู… 0 ุจุฏู„ุงู‹ ู…ู† `null`.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "failed_at": { + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ูุดู„ ุงู„ุฏูุน. ูŠุชู… ุงุณุชุฎุฏุงู… ูˆู‚ุช LinuxุŒ ูˆูŠุชู… ุงุณุชุฎุฏุงู… 0 ุจุฏู„ุงู‹ ู…ู† `null`.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancelled_at": { + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ุฅู„ุบุงุก ุงู„ุฏูุน. ูŠุชู… ุงุณุชุฎุฏุงู… ูˆู‚ุช LinuxุŒ ูˆูŠุชู… ุงุณุชุฎุฏุงู… 0 ุจุฏู„ุงู‹ ู…ู† `null`.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "fail_reason": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "cancel_reason": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "cancel_history": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/IIamportPaymentCancel" + } + } + }, + "required": [ + "vbank_code", + "vbank_name", + "vbank_num", + "vbank_holder", + "vbank_date", + "vbank_issued_at", + "pay_method", + "imp_uid", + "merchant_uid", + "name", + "amount", + "cancel_amount", + "currency", + "receipt_url", + "cash_receipt_issue", + "channel", + "pg_provider", + "emb_pg_provider", + "pg_id", + "pg_tid", + "escrow", + "buyer_name", + "buyer_email", + "buyer_tel", + "buyer_addr", + "buyer_postcode", + "customer_uid", + "customer_uid_usage", + "custom_data", + "user_agent", + "status", + "started_at", + "paid_at", + "failed_at", + "cancelled_at", + "fail_reason", + "cancel_reason", + "cancel_history" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน ุจุงู„ุญุณุงุจ ุงู„ุงูุชุฑุงุถูŠ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportPayment.IBase_lt__doublequote_phone_doublequote__space__or__space__doublequote_kpay_doublequote__space__or__space__doublequote_kakaopay_doublequote__space__or__space__doublequote_payco_doublequote__space__or__space__doublequote_lpay_doublequote__space__or__space__doublequote_ssgpay_doublequote__space__or__space__doublequote_tosspay_doublequote__space__or__space__doublequote_cultureland_doublequote__space__or__space__doublequote_smartculture_doublequote__space__or__space__doublequote_happymoney_doublequote__space__or__space__doublequote_booknlife_doublequote__space__or__space__doublequote_point_doublequote__gt_": { + "type": "object", + "properties": { + "pay_method": { + "oneOf": [ + { + "const": "phone" + }, + { + "const": "kpay" + }, + { + "const": "kakaopay" + }, + { + "const": "payco" + }, + { + "const": "lpay" + }, + { + "const": "ssgpay" + }, + { + "const": "tosspay" + }, + { + "const": "cultureland" + }, + { + "const": "smartculture" + }, + { + "const": "happymoney" + }, + { + "const": "booknlife" + }, + { + "const": "point" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "imp_uid": { + "description": "ู…ูุชุงุญ ุงู„ู…ุนุฑู ู„ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน {@link IIamportPayment }.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "merchant_uid": { + "description": "ู…ูุชุงุญ ู…ุนุฑู ุงู„ุทู„ุจ. ูˆู„ุง ูŠุชู… ุฅุตุฏุงุฑู‡ ูˆุฅุฏุงุฑุชู‡ ุจูˆุงุณุทุฉ ุฎุงุฏู… ุงู„ุงุณุชูŠุฑุงุฏุŒ ูˆู„ูƒู† ุจูˆุงุณุทุฉ ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู…ู‡..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "name": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "description": "ุงุณู… ุงู„ุทู„ุจุŒ ู‚ุฏ ูŠุชู… ุญุฐูู‡.", + "x-typia-required": true, + "x-typia-optional": false + }, + "amount": { + "description": "ุฅุฌู…ุงู„ูŠ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancel_amount": { + "description": "ุฅู„ุบุงุก ุงู„ุฏูุนุŒ ุงุณุชุฑุฏุงุฏ ุงู„ู…ุจู„ุบ ุงู„ุฅุฌู…ุงู„ูŠ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "currency": { + "$ref": "#/components/schemas/IIamportPayment.Currency" + }, + "receipt_url": { + "description": "ุนู†ูˆุงู† URL ู„ู„ุฅูŠุตุงู„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "url" + }, + "cash_receipt_issue": { + "description": "ุฅุตุฏุงุฑ ุฅูŠุตุงู„ุงุช ู†ู‚ุฏูŠุฉุŸ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "channel": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_provider": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "emb_pg_provider": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "pg_id": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_tid": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "escrow": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "buyer_name": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_email": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "email" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_tel": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_addr": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_postcode": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_uid": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_uid_usage": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "custom_data": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "user_agent": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "status": { + "$ref": "#/components/schemas/IIamportPayment.Status" + }, + "started_at": { + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ุทู„ุจ ุงู„ุฏูุน. ูŠุชู… ุงุณุชุฎุฏุงู… ูˆู‚ุช Linux.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "paid_at": { + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ุฅุชู…ุงู… ุงู„ุฏูุน (ุงู„ุฏูุน). ูŠุชู… ุงุณุชุฎุฏุงู… ูˆู‚ุช LinuxุŒ ูˆูŠุชู… ุงุณุชุฎุฏุงู… 0 ุจุฏู„ุงู‹ ู…ู† `null`.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "failed_at": { + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ูุดู„ ุงู„ุฏูุน. ูŠุชู… ุงุณุชุฎุฏุงู… ูˆู‚ุช LinuxุŒ ูˆูŠุชู… ุงุณุชุฎุฏุงู… 0 ุจุฏู„ุงู‹ ู…ู† `null`.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancelled_at": { + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ุฅู„ุบุงุก ุงู„ุฏูุน. ูŠุชู… ุงุณุชุฎุฏุงู… ูˆู‚ุช LinuxุŒ ูˆูŠุชู… ุงุณุชุฎุฏุงู… 0 ุจุฏู„ุงู‹ ู…ู† `null`.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "fail_reason": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "cancel_reason": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "cancel_history": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/IIamportPaymentCancel" + } + } + }, + "required": [ + "pay_method", + "imp_uid", + "merchant_uid", + "name", + "amount", + "cancel_amount", + "currency", + "receipt_url", + "cash_receipt_issue", + "channel", + "pg_provider", + "emb_pg_provider", + "pg_id", + "pg_tid", + "escrow", + "buyer_name", + "buyer_email", + "buyer_tel", + "buyer_addr", + "buyer_postcode", + "customer_uid", + "customer_uid_usage", + "custom_data", + "user_agent", + "status", + "started_at", + "paid_at", + "failed_at", + "cancelled_at", + "fail_reason", + "cancel_reason", + "cancel_history" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน ุงู„ุฃุณุงุณูŠุฉ (ุงู„ู…ุดุชุฑูƒุฉ)..", + "x-typia-jsDocTags": [] + }, + "IIamportPaymentCancel.IStore": { + "type": "object", + "properties": { + "imp_uid": { + "description": "ู…ูุชุงุญ ุงู„ู…ุนุฑู ู„ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน {@link IIamportPayment }.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "merchant_uid": { + "description": "ู…ูุชุงุญ ู…ุนุฑู ุงู„ุทู„ุจ. ูˆู„ุง ูŠุชู… ุฅุตุฏุงุฑู‡ ูˆุฅุฏุงุฑุชู‡ ุจูˆุงุณุทุฉ ุฎุงุฏู… ุงู„ุงุณุชูŠุฑุงุฏุŒ ูˆู„ูƒู† ุจูˆุงุณุทุฉ ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู…ู‡..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "ู…ุจู„ุบ ุงู„ุฅู„ุบุงุก ูˆุงู„ุฅู„ุบุงุก ุงู„ุฌุฒุฆูŠ ู…ู…ูƒู†ุงู† ุฃูŠุถู‹ุง. ุงู„ุฅู„ุบุงุก ุงู„ูƒุงู…ู„ ููŠ ุญุงู„ุฉ ุงู„ุฅุบูุงู„.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "checksum": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + { + "type": "null" + } + ], + "description": "ุงู„ุฅู„ุบุงุก ุงู„ุฑุตูŠุฏ ุงู„ุญุงู„ูŠ ุงู„ู‚ุงุจู„ ู„ู„ุฅู„ุบุงุก ู‚ุจู„ ุชู†ููŠุฐ ุงู„ู…ุนุงู…ู„ุฉ. ูŠุชู… ุงู„ุชุญู‚ู‚ ู…ู‚ุฏู…ู‹ุง ู…ู…ุง ุฅุฐุง ูƒุงู† ุงู„ุฑุตูŠุฏ ุงู„ู‚ุงุจู„ ู„ู„ุฅู„ุบุงุก ุงู„ู…ุณุฌู„ ุจูˆุงุณุทุฉ ุทุงู„ุจ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช (API) ูŠุชุทุงุจู‚ ู…ุน ุงู„ุฑุตูŠุฏ ุงู„ู‚ุงุจู„ ู„ู„ุฅู„ุบุงุก ุงู„ู…ุณุฌู„ ุจูˆุงุณุทุฉ I'mportุŒ ูˆุฅุฐุง ูุดู„ ุงู„ุชุญู‚ู‚ุŒ ูู„ู† ูŠุชู… ุชู†ููŠุฐ ุงู„ู…ุนุงู…ู„ุฉ. ุฅุฐุง ูƒุงู† "ูุงุฑุบู‹ุง"ุŒ ูุณูŠุชู… ุชุฎุทูŠ ุนู…ู„ูŠุฉ ุงู„ุชุญู‚ู‚..", + "x-typia-required": true, + "x-typia-optional": false + }, + "reason": { + "description": "ุณุจุจ ุงู„ุฅู„ุบุงุก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "tax_free": { + "description": "ู…ุจู„ุบ ู…ุนูู‰ ู…ู† ุงู„ุถุฑุงุฆุจ ุจูŠู† ู…ุจู„ุบ ุทู„ุจ ุงู„ุฅู„ุบุงุก.", + "x-typia-jsDocTags": [ + { + "name": "default", + "text": [ + { + "text": "0", + "kind": "text" + } + ] + } + ], + "x-typia-required": false, + "x-typia-optional": true, + "type": "number", + "default": 0 + }, + "refund_holder": { + "description": "ุงุณุชุฑุฏุงุฏ ุญุณุงุจ ุงู„ู…ูˆุฏุน.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "refund_bank": { + "description": "ุฑู…ุฒ ุงุณุชุฑุฏุงุฏ ุญุณุงุจ ุงู„ุจู†ูƒ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "refund_account": { + "description": "ุฑู‚ู… ุญุณุงุจ ุญุณุงุจ ุงู„ุงุณุชุฑุฏุงุฏ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "refund_tel": { + "description": "ุงุณุชุฑุฏุงุฏ ู…ุนู„ูˆู…ุงุช ุงู„ุงุชุตุงู„ ุจุตุงุญุจ ุงู„ุญุณุงุจ", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + } + }, + "required": [ + "imp_uid", + "merchant_uid", + "checksum", + "reason" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุฅุฏุฎุงู„ ุฅู„ุบุงุก ุงู„ุฏูุน.", + "x-typia-jsDocTags": [] + }, + "IIamportResponse_lt_IIamportReceipt_gt_": { + "type": "object", + "properties": { + "code": { + "description": "ุฑู…ุฒ ุงู„ุฎุทุฃ. ุงู„ู‚ูŠู…ุฉ 0 ุชุนู†ูŠ ุนุฏู… ูˆุฌูˆุฏ ุฎุทุฃ..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "message": { + "description": "ุฑุณุงู„ุฉ ุงู„ู†ุฌุงุญ ุฃูˆ ุงู„ุฎุทุฃ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/IIamportReceipt" + } + }, + "required": [ + "code", + "message", + "response" + ], + "description": "ุฃู‚ูˆู… ุจุงุณุชูŠุฑุงุฏ ุจูŠุงู†ุงุช ุงู„ุงุณุชุฌุงุจุฉ ุงู„ูุฑูŠุฏุฉ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportReceipt": { + "type": "object", + "properties": { + "imp_uid": { + "description": "{@link IIamportPayment.imp_uid } ู…ู† ุงู„ุฏูุนุฉ ุงู„ู…ุญุชุณุจุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "receipt_uid": { + "description": "ู…ุนุฑู ู…ุนุฑู ูุฑูŠุฏ ู„ุฅูŠุตุงู„ ุงู„ู†ู‚ุฏูŠุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "apply_num": { + "description": "ุฑู‚ู… ุงู„ู…ูˆุงูู‚ุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/IIamportReceipt.Type" + }, + "amount": { + "description": "ุฅุฌู…ุงู„ูŠ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vat": { + "description": "ุถุฑูŠุจุฉ ุฅุถุงููŠุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "receipt_url": { + "description": "ุนู†ูˆุงู† URL ู„ู„ุงุณุชุนู„ุงู… ุนู† ุฅูŠุตุงู„ ุงู„ุฏูุน ุงู„ู†ู‚ุฏูŠ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "url" + }, + "applied_at": { + "description": "ูˆู‚ุช ุฅุตุฏุงุฑ ุฅูŠุตุงู„ ุงู„ู†ู‚ุฏูŠุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancelled_at": { + "description": "ูˆู‚ุช ุฅู„ุบุงุก ุฅูŠุตุงู„ ุงู„ู†ู‚ุฏูŠุฉ. ูŠุชู… ุงุณุชุฎุฏุงู… ูˆู‚ุช LinuxุŒ ูˆูŠุชู… ุงุณุชุฎุฏุงู… 0 ุจุฏู„ุงู‹ ู…ู† `null`.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + } + }, + "required": [ + "imp_uid", + "receipt_uid", + "apply_num", + "type", + "amount", + "vat", + "receipt_url", + "applied_at", + "cancelled_at" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุงุณุชู„ุงู… ุงู„ู†ู‚ุฏ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportReceipt.Type": { + "oneOf": [ + { + "const": "person" + }, + { + "const": "company" + } + ], + "description": "ู†ูˆุน ุฅุตุฏุงุฑ ุฅูŠุตุงู„ ุงู„ู†ู‚ุฏูŠุฉ (ุงู„ู‡ุฏู)." + }, + "IIamportReceipt.IStore": { + "type": "object", + "properties": { + "imp_uid": { + "description": "{@link IIamportPayment.imp_uid } ู…ู† ุงู„ุฏูุนุฉ ุงู„ู…ุญุชุณุจุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "identifier": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุชุนุฑูŠู ู„ู„ุฅูŠุตุงู„ุงุช ุงู„ู†ู‚ุฏูŠุฉ. - ุจุทุงู‚ุฉ ุฅูŠุตุงู„ ู†ู‚ุฏูŠ ู„ุฏุงุฆุฑุฉ ุงู„ุถุฑุงุฆุจ ุงู„ูˆุทู†ูŠุฉ - ุฑู‚ู… ุงู„ู‡ุงุชู ุงู„ู…ุญู…ูˆู„ - ุฑู‚ู… ุชุณุฌูŠู„ ุงู„ู…ู‚ูŠู… - ุฑู‚ู… ุชุณุฌูŠู„ ุงู„ุฃุนู…ุงู„", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "identifier_type": { + "oneOf": [ + { + "const": "phone" + }, + { + "const": "person" + }, + { + "const": "business" + }, + { + "const": "taxcard" + } + ], + "description": "ู†ูˆุน ุงู„ุฅูŠุตุงู„ ุงู„ู†ู‚ุฏูŠ ุงู„ุตุงุฏุฑ. - ุงู„ุดุฎุต: ุฑู‚ู… ุชุณุฌูŠู„ ุงู„ู…ู‚ูŠู… - ุงู„ุนู…ู„: ุฑู‚ู… ุชุณุฌูŠู„ ุงู„ู†ุดุงุท ุงู„ุชุฌุงุฑูŠ - ุงู„ู‡ุงุชู: ุฑู‚ู… ุงู„ู‡ุงุชู ุงู„ู…ุญู…ูˆู„ - ุงู„ุจุทุงู‚ุฉ ุงู„ุถุฑูŠุจูŠุฉ: ุจุทุงู‚ุฉ ุงู„ุฅูŠุตุงู„ ุงู„ู†ู‚ุฏูŠ ู„ุฏุงุฆุฑุฉ ุงู„ุถุฑุงุฆุจ ุงู„ูˆุทู†ูŠุฉ ุจุนุถ ุดุฑูƒุงุช PG ู„ูŠุณ ู„ุฏูŠู‡ุง ู‡ุฐุง ุงู„ุนู†ุตุฑุŒ ูˆู„ูƒู† ููŠ ู…ุนุธู… ุงู„ุญุงู„ุงุชุŒ ุงุณุชุฎุฏู…ู‡ ูู‚ุท..", + "x-typia-required": false, + "x-typia-optional": true + }, + "type": { + "oneOf": [ + { + "const": "person" + }, + { + "const": "company" + } + ], + "description": "ู†ูˆุน ุฅุตุฏุงุฑ ุฅูŠุตุงู„ ุงู„ู†ู‚ุฏูŠุฉ (ุงู„ู‡ุฏู). ููŠ ุญุงู„ุฉ ูู‚ุฏุงู†ู‡ุŒ ูŠุชู… ุงุณุชุฎุฏุงู… ุงู„ุดุฎุต.", + "x-typia-required": false, + "x-typia-optional": true + }, + "buyer_name": { + "description": "ุงุณู… ุงู„ู…ุดุชุฑูŠ. ูŠุฑุฌู‰ ุฅุฏุฎุงู„ ุฃูƒุจุฑ ู‚ุฏุฑ ู…ู…ูƒู† ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช ู„ู„ุชุชุจุน ุงู„ู„ุงุญู‚ ู„ุฅุตุฏุงุฑ ุฅูŠุตุงู„ ุงู„ุบุฑุงู…ุฉ..", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_email": { + "description": "ุงู„ุจุฑูŠุฏ ุงู„ุฅู„ูƒุชุฑูˆู†ูŠ ู„ู„ู…ุดุชุฑูŠ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_tel": { + "description": "ุฑู‚ู… ู‡ุงุชู ุงู„ู…ุดุชุฑูŠ. ู„ุฅุตุฏุงุฑ ุฅูŠุตุงู„ ู†ู‚ุฏูŠุŒ ูŠุฑุฌู‰ ุฅุฏุฎุงู„ู‡ ู‚ุฏุฑ ุงู„ุฅู…ูƒุงู† ู„ู„ู…ุชุงุจุนุฉ..", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "tax_free": { + "description": "ู…ุจู„ุบ ู…ุนูู‰ ู…ู† ุงู„ุถุฑุงุฆุจ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + } + }, + "required": [ + "imp_uid", + "identifier" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุฅุฏุฎุงู„ ุฅูŠุตุงู„ ุงู„ู†ู‚ุฏูŠุฉ.", + "x-typia-jsDocTags": [] + }, + "IIamportUser.IAccessor": { + "type": "object", + "properties": { + "imp_key": { + "description": "ู…ูุชุงุญ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "imp_secret": { + "description": "ุงู„ู…ูุชุงุญ ุงู„ุณุฑูŠ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "imp_key", + "imp_secret" + ], + "description": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช (API) ูˆุงู„ู…ูุชุงุญ ุงู„ุณุฑูŠ ุงู„ู…ู‚ุฏู… ู…ู† ุฎู„ุงู„ ุงู„ุงุณุชูŠุฑุงุฏ.", + "x-typia-jsDocTags": [] + }, + "IIamportResponse_lt_IIamportUser_gt_": { + "type": "object", + "properties": { + "code": { + "description": "ุฑู…ุฒ ุงู„ุฎุทุฃ. ุงู„ู‚ูŠู…ุฉ 0 ุชุนู†ูŠ ุนุฏู… ูˆุฌูˆุฏ ุฎุทุฃ..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "message": { + "description": "ุฑุณุงู„ุฉ ุงู„ู†ุฌุงุญ ุฃูˆ ุงู„ุฎุทุฃ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/IIamportUser" + } + }, + "required": [ + "code", + "message", + "response" + ], + "description": "ุฃู‚ูˆู… ุจุงุณุชูŠุฑุงุฏ ุจูŠุงู†ุงุช ุงู„ุงุณุชุฌุงุจุฉ ุงู„ูุฑูŠุฏุฉ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportUser": { + "type": "object", + "properties": { + "now": { + "description": "ูˆู‚ุช ุฅุตุฏุงุฑ ุงู„ุฑู…ุฒ ุงู„ู…ู…ูŠุฒ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "expired_at": { + "description": "ูˆู‚ุช ุงู†ุชู‡ุงุก ุงู„ุฑู…ุฒ ุงู„ู…ู…ูŠุฒ. ูˆู‚ุช Linux ู‡ูˆ ุงู„ู…ุนูŠุงุฑุŒ ูˆุฅุฐุง ูƒู†ุช ุชุฑูŠุฏ ุงุณุชุฎุฏุงู…ู‡ ููŠ JSุŒ ููŠุฌุจ ุนู„ูŠูƒ ุชุญูˆูŠู„ู‡ ุนู„ู‰ ุงู„ู†ุญูˆ ุงู„ุชุงู„ูŠ. ```ู†ูˆุน ุงู„ู†ุต ุงู„ุฌุฏูŠุฏ Date(user.expired_at * 1_000); ```", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "access_token": { + "description": "ุฑู…ุฒ ู…ุตุงุฏู‚ุฉ ุงู„ู…ุณุชุฎุฏู….", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "now", + "expired_at", + "access_token" + ], + "description": "ุงุณุชูŠุฑุงุฏ ู…ุนู„ูˆู…ุงุช ู…ุตุงุฏู‚ุฉ ุงู„ู…ุณุชุฎุฏู…. ูŠู‚ูˆู… Iimport ุจุฅุตุฏุงุฑ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช (API) ูˆู…ุนู„ูˆู…ุงุช ุงู„ู…ูุชุงุญ ุงู„ุณุฑูŠุŒ {@link IIamportUser.IAccessor }ุŒ ู„ู„ุนู…ู„ุงุก. ูˆู…ุน ุฐู„ูƒุŒ ู„ุง ูŠู…ูƒู† ุงุณุชุฎุฏุงู… ู‡ุฐุง ู…ุจุงุดุฑุฉ ู„ู…ุตุงุฏู‚ุฉ ู…ุณุชุฎุฏู… IimportุŒ ูˆูŠุฌุจ ุฅุตุฏุงุฑ ุฑู…ุฒ ู…ู…ูŠุฒ ู„ู…ุตุงุฏู‚ุฉ ุงู„ู…ุณุชุฎุฏู… ุจู†ุงุกู‹ ุนู„ู‰ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ุงู„ู…ู‚ุงุจู„ุฉ ูˆุงู„ู…ูุชุงุญ ุงู„ุณุฑูŠุŒ ูˆู„ูƒู† ุฑู…ุฒ ู…ุตุงุฏู‚ุฉ ุงู„ู…ุณุชุฎุฏู… ู‡ุฐุง ู„ู‡ ุญุชู…ู‹ุง ุญุฏ ุฒู…ู†ูŠ ุฎุงุต ุจู‡. `IIamportUser` ู‡ูŠ ูˆุงุฌู‡ุฉ ุจู†ูŠุฉ ุจูŠุงู†ุงุช ุชู…ุซู„ ุฑู…ุฒ ู…ุตุงุฏู‚ุฉ ุงู„ู…ุณุชุฎุฏู… ู‡ุฐุง ูˆูˆู‚ุช ุงู†ุชู‡ุงุก ุตู„ุงุญูŠุชู‡. ุจุงู„ุฅุถุงูุฉ ุฅู„ู‰ ุฐู„ูƒุŒ ู†ุธุฑู‹ุง ู„ุทุจูŠุนุฉ ุฑู…ุฒ ู…ุตุงุฏู‚ุฉ ุงู„ู…ุณุชุฎุฏู… ุงู„ุฎุงุต ุจู€ I'mportุŒ ูˆุงู„ุฐูŠ ู„ู‡ ูˆู‚ุช ุงู†ุชู‡ุงุก ุตู„ุงุญูŠุฉุŒ ูู…ู† ุงู„ุตุนุจ ุฌุฏู‹ุง ุฅุฏุงุฑุชู‡ ุจุญูŠุซ ู„ุง ูŠุชุฌุงูˆุฒ ูˆู‚ุช ุงู†ุชู‡ุงุก ุตู„ุงุญูŠุชู‡. ูˆุจู†ุงุกู‹ ุนู„ู‰ ุฐู„ูƒุŒ ูŠูˆูุฑ `iamport-server-api` ูุฆุฉ {@link IamportConnector }ุŒ ูˆุงู„ุชูŠ ุชู‚ูˆู… ุชู„ู‚ุงุฆูŠู‹ุง ุจุชุฌุฏูŠุฏ ุฑู…ุฒ ู…ุตุงุฏู‚ุฉ ู…ุณุชุฎุฏู… Iamport ุนู†ุฏ ุงู†ุชู‡ุงุก ุตู„ุงุญูŠุชู‡..", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportVBankPayment.IStore": { + "type": "object", + "properties": { + "merchant_uid": { + "description": "ู…ูุชุงุญ ู…ุนุฑู ุงู„ุทู„ุจ. ูˆู„ุง ูŠุชู… ุฅุตุฏุงุฑู‡ ูˆุฅุฏุงุฑุชู‡ ุจูˆุงุณุทุฉ ุฎุงุฏู… ุงู„ุงุณุชูŠุฑุงุฏุŒ ูˆู„ูƒู† ุจูˆุงุณุทุฉ ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู…ู‡..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "ุงู„ู…ุจู„ุบ ุงู„ุฅุฌู…ุงู„ูŠ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vbank_code": { + "description": "ุฑู…ุฒ ุงู„ุจู†ูƒ ู„ู„ุญุณุงุจ ุงู„ุงูุชุฑุงุถูŠ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "vbank_due": { + "description": "ุงู„ู…ูˆุนุฏ ุงู„ู†ู‡ุงุฆูŠ ู„ุฅูŠุฏุงุน ุงู„ุญุณุงุจ ุงู„ุงูุชุฑุงุถูŠุŒ ุจุชูˆู‚ูŠุช ูŠูˆู†ูƒุณ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vbank_holder": { + "description": "ุงู„ู…ูˆุฏุน.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "name": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_name": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_email": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_tel": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_addr": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_postcode": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "pg": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "notice_url": { + "description": "ุนู†ูˆุงู† URL ู„ุชู„ู‚ูŠ ู…ุนู„ูˆู…ุงุช ุฅูŠุฏุงุน ุงู„ุญุณุงุจ ุงู„ุงูุชุฑุงุถูŠ. ุงุณุชุฎุฏู… ุนู†ูˆุงู† URL ุงู„ุงูุชุฑุงุถูŠ ู„ุฎุทุงู ุงู„ูˆูŠุจ ุฅุฐุง ูƒุงู† ู…ูู‚ูˆุฏู‹ุง.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "custom_data": { + "description": "ุงู„ุจูŠุงู†ุงุช ุงู„ู…ุฎุตุตุฉุŒ ู…ุชุงุญุฉ ุจุญุฑูŠุฉ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "pg_api_key": { + "description": "[Inicis ูู‚ุท] ุชู… ุชุฃูƒูŠุฏ ู‚ูŠู…ุฉ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช (API) ููŠ ูˆุญุฏุฉ ุชุญูƒู… ุงู„ุชุงุฌุฑ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + } + }, + "required": [ + "merchant_uid", + "amount", + "vbank_code", + "vbank_due", + "vbank_holder" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุฅุฏุฎุงู„ ุงู„ุฏูุน ู„ู„ุญุณุงุจ ุงู„ุงูุชุฑุงุถูŠ. ูŠู…ูƒู† ุฅู†ุดุงุก ุงู„ุญุณุงุจุงุช ุงู„ุงูุชุฑุงุถูŠุฉ ุจุดูƒู„ ุนุดูˆุงุฆูŠ. ูˆู…ุน ุฐู„ูƒุŒ ู„ุง ูŠุชูˆูุฑ ุณูˆู‰ ุจุนุถ ุดุฑูƒุงุช PG ุฃูˆ "ุฎุงุฏู… ุงุณุชูŠุฑุงุฏ ู…ุฒูŠู". - ุจู†ูƒ ุงู„ุชุณูˆูŠุฉ - ุงู„ู…ุฏููˆุนุงุช ุงู„ู„ุทูŠูุฉ - KG Inicis", + "x-typia-jsDocTags": [] + }, + "IIamportResponse_lt_IIamportVBankPayment_gt_": { + "type": "object", + "properties": { + "code": { + "description": "ุฑู…ุฒ ุงู„ุฎุทุฃ. ุงู„ู‚ูŠู…ุฉ 0 ุชุนู†ูŠ ุนุฏู… ูˆุฌูˆุฏ ุฎุทุฃ..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "message": { + "description": "ุฑุณุงู„ุฉ ุงู„ู†ุฌุงุญ ุฃูˆ ุงู„ุฎุทุฃ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/IIamportVBankPayment" + } + }, + "required": [ + "code", + "message", + "response" + ], + "description": "ุฃู‚ูˆู… ุจุงุณุชูŠุฑุงุฏ ุจูŠุงู†ุงุช ุงู„ุงุณุชุฌุงุจุฉ ุงู„ูุฑูŠุฏุฉ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportVBankPayment.IUpdate": { + "type": "object", + "properties": { + "imp_uid": { + "description": "{@link IIamportPayment.imp_uid } ููŠ ุณุฌู„ ุงู„ุฏูุน ุงู„ู…ุณุชู‡ุฏู.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "ู…ุจู„ุบ ุงู„ุฏูุน ู„ู„ุชุญุฑูŠุฑ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "vbank_due": { + "description": "ุงู„ู…ูˆุนุฏ ุงู„ู†ู‡ุงุฆูŠ ู„ุฅูŠุฏุงุน ุงู„ุญุณุงุจ ุงู„ุงูุชุฑุงุถูŠ ู„ู„ุชุนุฏูŠู„.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + } + }, + "required": [ + "imp_uid" + ], + "description": "ุชุญุฑูŠุฑ ู…ุนู„ูˆู…ุงุช ุงู„ุฅุฏุฎุงู„ ู„ู…ุฏููˆุนุงุช ุงู„ุญุณุงุจ ุงู„ุงูุชุฑุงุถูŠ. ูŠู…ูƒู†ูƒ ุชุนุฏูŠู„ ุงู„ู…ูˆุนุฏ ุงู„ู†ู‡ุงุฆูŠ ู„ู„ุฅูŠุฏุงุน ุฃูˆ ู…ุจู„ุบ ุงู„ุฅูŠุฏุงุน ุงู„ุฎุงุต ุจุงู„ุญุณุงุจ ุงู„ุงูุชุฑุงุถูŠ ุงู„ุฐูŠ ู„ู… ูŠุชู… ุฅูŠุฏุงุนู‡ ุจุนุฏ. ูˆู…ุน ุฐู„ูƒุŒ ูŠุชูˆูุฑ ูู‚ุท Settlebank ุฃูˆ "ุฎุงุฏู… ุงุณุชูŠุฑุงุฏ ู…ุฒูŠู"..", + "x-typia-jsDocTags": [] + }, + "IIamportResponse_lt_IIamportSubscription_gt_": { + "type": "object", + "properties": { + "code": { + "description": "ุฑู…ุฒ ุงู„ุฎุทุฃ. ุงู„ู‚ูŠู…ุฉ 0 ุชุนู†ูŠ ุนุฏู… ูˆุฌูˆุฏ ุฎุทุฃ..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "message": { + "description": "ุฑุณุงู„ุฉ ุงู„ู†ุฌุงุญ ุฃูˆ ุงู„ุฎุทุฃ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/IIamportSubscription" + } + }, + "required": [ + "code", + "message", + "response" + ], + "description": "ุฃู‚ูˆู… ุจุงุณุชูŠุฑุงุฏ ุจูŠุงู†ุงุช ุงู„ุงุณุชุฌุงุจุฉ ุงู„ูุฑูŠุฏุฉ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportSubscription": { + "type": "object", + "properties": { + "pg_provider": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_id": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "card_name": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "card_code": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "card_number": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "card_type": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "customer_name": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_tel": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_email": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_addr": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_postcode": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "inserted": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "updated": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "customer_uid": { + "description": "ู…ูุชุงุญ ู…ุนุฑู ุงู„ุนู…ูŠู„. ู…ูุชุงุญ ู…ุนุฑู ุชุชู… ุฅุฏุงุฑุชู‡ ุจูˆุงุณุทุฉ ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู…ู‡ุŒ ูˆู„ูŠุณ ุนู† ุทุฑูŠู‚ ุงู„ุงุณุชูŠุฑุงุฏ. ูˆู…ุน ุฐู„ูƒุŒ ูŠุฌุจ ุงุณุชุฎุฏุงู…ู‡ ูุนู„ูŠู‹ุง ูƒู…ูุชุงุญ ู…ุนุฑู ุงู„ุจุทุงู‚ุฉ ุจุฏู„ุงู‹ ู…ู† ุงุณุชุฎุฏุงู…ู‡ ูƒุนู…ูŠู„..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "pg_provider", + "pg_id", + "card_name", + "card_code", + "card_number", + "card_type", + "customer_name", + "customer_tel", + "customer_email", + "customer_addr", + "customer_postcode", + "inserted", + "updated", + "customer_uid" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุจุทุงู‚ุฉ ุงู„ุฏูุน ุงู„ุจุณูŠุทุฉ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportSubscription.IStore": { + "type": "object", + "properties": { + "card_number": { + "description": "ุฑู‚ู… ุงู„ุจุทุงู‚ุฉ. ุงู„ุชู†ุณูŠู‚: XXXX-XXXX-XXXX-XXXX", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "\\d{4}-\\d{4}-\\d{4}-\\d{4}" + }, + "expiry": { + "description": "ุชุงุฑูŠุฎ ุงู†ุชู‡ุงุก ุงู„ุจุทุงู‚ุฉ. ุงู„ุชู†ุณูŠู‚: YYYY-MM", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^([0-9]{4})-(0[1-9]|1[012])$" + }, + "birth": { + "description": "ุชุงุฑูŠุฎ ุงู„ู…ูŠู„ุงุฏ YYMMDD ุฃูˆ ุฑู‚ู… ุงู„ุชุณุฌูŠู„ ุงู„ุชุฌุงุฑูŠ ุงู„ู…ูƒูˆู† ู…ู† 10 ุฃุฑู‚ุงู….", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^(([0-9]{2})(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01]))|(\\d{10})$" + }, + "pwd_2digit": { + "description": "ุฃูˆู„ ุฑู‚ู…ูŠู† ู…ู† ูƒู„ู…ุฉ ู…ุฑูˆุฑ ุงู„ุจุทุงู‚ุฉ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "pattern": "\\d{2}" + }, + "cvc": { + "description": "ุฑู‚ู… ุชูˆุซูŠู‚ ุงู„ุจุทุงู‚ุฉ (3 ุฃุฑู‚ุงู… ุฎู„ู ุงู„ุจุทุงู‚ุฉ).", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "pattern": "\\d{2}" + }, + "customer_name": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customer_tel": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customer_email": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "format": "email" + }, + "customr_addr": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customer_postcode": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customer_uid": { + "description": "ู…ูุชุงุญ ู…ุนุฑู ุงู„ุนู…ูŠู„. ู…ูุชุงุญ ู…ุนุฑู ุชุชู… ุฅุฏุงุฑุชู‡ ุจูˆุงุณุทุฉ ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู…ู‡ุŒ ูˆู„ูŠุณ ุนู† ุทุฑูŠู‚ ุงู„ุงุณุชูŠุฑุงุฏ. ูˆู…ุน ุฐู„ูƒุŒ ูŠุฌุจ ุงุณุชุฎุฏุงู…ู‡ ูุนู„ูŠู‹ุง ูƒู…ูุชุงุญ ู…ุนุฑู ุงู„ุจุทุงู‚ุฉ ุจุฏู„ุงู‹ ู…ู† ุงุณุชุฎุฏุงู…ู‡ ูƒุนู…ูŠู„..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "card_number", + "expiry", + "birth", + "customer_uid" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุฅุฏุฎุงู„ ุจุทุงู‚ุฉ ุงู„ุฏูุน ุงู„ุจุณูŠุทุฉ.", + "x-typia-jsDocTags": [] + }, + "IIamportSubscription.IOnetime": { + "type": "object", + "properties": { + "customer_uid": { + "description": "ู…ูุชุงุญ ู…ุนุฑู ุงู„ุนู…ูŠู„. ู…ูุชุงุญ ู…ุนุฑู ุชุชู… ุฅุฏุงุฑุชู‡ ุจูˆุงุณุทุฉ ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู…ู‡ุŒ ูˆู„ูŠุณ ุนู† ุทุฑูŠู‚ ุงู„ุงุณุชูŠุฑุงุฏ. ูˆู…ุน ุฐู„ูƒุŒ ูŠุฌุจ ุงุณุชุฎุฏุงู…ู‡ ูุนู„ูŠู‹ุง ูƒู…ูุชุงุญ ู…ุนุฑู ุงู„ุจุทุงู‚ุฉ ุจุฏู„ุงู‹ ู…ู† ุงุณุชุฎุฏุงู…ู‡ ูƒุนู…ูŠู„. ุฅุฐุง ุชู… ุญุฐู ุฐู„ูƒุŒ ูุณูŠุชู… ุฅุฌุฑุงุก ุฏูุนุฉ ุจุณูŠุทุฉ ูู‚ุทุŒ ูˆู„ุง ูŠุชู… ุชุณุฌูŠู„ ู…ุนู„ูˆู…ุงุช ุงู„ุจุทุงู‚ุฉ ู„ู„ุฏูุน ุงู„ุจุณูŠุท..", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "card_number": { + "description": "ุฑู‚ู… ุงู„ุจุทุงู‚ุฉ. ุงู„ุชู†ุณูŠู‚: XXXX-XXXX-XXXX-XXXX", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "\\d{4}-\\d{4}-\\d{4}-\\d{4}" + }, + "expiry": { + "description": "ุชุงุฑูŠุฎ ุงู†ุชู‡ุงุก ุงู„ุจุทุงู‚ุฉ. ุงู„ุชู†ุณูŠู‚: YYYY-MM", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^([0-9]{4})-(0[1-9]|1[012])$" + }, + "birth": { + "description": "ุชุงุฑูŠุฎ ุงู„ู…ูŠู„ุงุฏ YYMMDD ุฃูˆ ุฑู‚ู… ุงู„ุชุณุฌูŠู„ ุงู„ุชุฌุงุฑูŠ ุงู„ู…ูƒูˆู† ู…ู† 10 ุฃุฑู‚ุงู….", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^(([0-9]{2})(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01]))|(\\d{10})$" + }, + "pwd_2digit": { + "description": "ุฃูˆู„ ุฑู‚ู…ูŠู† ู…ู† ูƒู„ู…ุฉ ู…ุฑูˆุฑ ุงู„ุจุทุงู‚ุฉ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "pattern": "\\d{2}" + }, + "cvc": { + "description": "ุฑู‚ู… ุชูˆุซูŠู‚ ุงู„ุจุทุงู‚ุฉ (3 ุฃุฑู‚ุงู… ุฎู„ู ุงู„ุจุทุงู‚ุฉ).", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "pattern": "\\d{2}" + }, + "customer_name": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customer_tel": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customer_email": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "format": "email" + }, + "customr_addr": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customer_postcode": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "merchant_uid": { + "description": "ู…ูุชุงุญ ู…ุนุฑู ุงู„ุทู„ุจ. ู…ูุชุงุญ ุงู„ู…ุนุฑู ุชุชู… ุฅุฏุงุฑุชู‡ ุจูˆุงุณุทุฉ ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู…ู‡ุŒ ูˆู„ูŠุณ ุจูˆุงุณุทุฉ I'mport..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "ุฅุฌู…ุงู„ูŠ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "name": { + "description": "ุงุณู… ุงู„ุทู„ุจ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "currency": { + "oneOf": [ + { + "const": "KRW" + }, + { + "const": "USD" + }, + { + "const": "EUR" + }, + { + "const": "JPY" + } + ], + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ู…ูƒุงู„ู…ุฉ.", + "x-typia-required": false, + "x-typia-optional": true + }, + "tax_free": { + "description": "ู‚ูŠู…ุฉ ุงู„ุนุฑุถ ุงู„ู…ุนูุงุฉ ู…ู† ุงู„ุถุฑุงุฆุจ. ุงู„ู‚ูŠู…ุฉ ุงู„ุงูุชุฑุงุถูŠุฉ ู‡ูŠ 0ุŒ ู„ุฐุง ุชุชู… ู…ุนุงู„ุฌุฉ ุถุฑูŠุจุฉ ุงู„ู‚ูŠู…ุฉ ุงู„ู…ุถุงูุฉ ุชู„ู‚ุงุฆูŠู‹ุง ุนู„ู‰ ุฃู†ู‡ุง 1/11 ู…ู† ุงู„ู…ุจู„ุบ..", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "card_quota": { + "description": "ุนุฏุฏ ุฃุดู‡ุฑ ุงู„ู‚ุณุท. ุฏูุน ุงู„ู…ุจู„ุบ ุงู„ู…ู‚ุทูˆุน ู‡ูˆ 0.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "buyer_name": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_email": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "format": "email" + }, + "buyer_tel": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_addr": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_postcode": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "interest_free_by_merchant": { + "description": "ุนู†ุฏ ู…ุนุงู„ุฌุฉ ุฃู‚ุณุงุท ุจุทุงู‚ุฉ ุงู„ุงุฆุชู…ุงู†ุŒ ุชุชุฑุงูƒู… ูุงุฆุฏุฉ ุงู„ู‚ุณุท (ุจุงุณุชุซู†ุงุก ุงู„ุนุฑูˆุถ ุงู„ุชุฑูˆูŠุฌูŠุฉ ุจุฏูˆู† ููˆุงุฆุฏ ู„ุดุฑูƒุฉ ุจุทุงู‚ุงุช ุงู„ุงุฆุชู…ุงู†). ุนู†ุฏ ุฅุจุฑุงู… ุนู‚ุฏ ู…ุน ุดุฑูƒุฉ PG ู„ูŠู‚ูˆู… ุงู„ู…ุชุฌุฑ ุงู„ุชุงุจุน ุจุฏูุน ูุงุฆุฏุฉ ุงู„ู‚ุณุท ุงู„ู…ูุฑูˆุถุฉ ู†ูŠุงุจุฉ ุนู† ุงู„ุนู…ูŠู„ (ููŠ ุงู„ูˆู‚ุช ุงู„ุญุงู„ูŠุŒ ูŠุชู… ุฏุนู… Nice Payments ูู‚ุท)", + "x-typia-required": false, + "x-typia-optional": true, + "type": "boolean" + }, + "use_card_point": { + "description": "ุนู†ุฏ ุทู„ุจ ุงู„ู…ูˆุงูู‚ุฉุŒ ุถุน ุนู„ุงู…ุฉ ุนู„ู‰ ู…ุง ุฅุฐุง ูƒุงู† ุณูŠุชู… ุฎุตู… ู†ู‚ุงุท ุดุฑูƒุฉ ุงู„ุจุทุงู‚ุฉ ูˆุณูŠุชู… ุงู„ู…ูˆุงูู‚ุฉ ุนู„ู‰ ุงู„ุฏูุน. ู…ุทู„ูˆุจ ุงู„ุชุดุงูˆุฑ ุงู„ู…ุณุจู‚ ู…ุน ู…ู†ุฏูˆุจ ู…ุจูŠุนุงุช ุดุฑูƒุฉ PG ููŠ ูˆู‚ุช ุชูˆู‚ูŠุน ุงู„ุนู‚ุฏ (ุญุงู„ูŠู‹ุงุŒ ูŠุชู… ุฏุนู… Nice Payments ูู‚ุท)", + "x-typia-required": false, + "x-typia-optional": true, + "type": "boolean" + }, + "custom_data": { + "description": "ูŠู…ูƒู† ุฅุฏุฎุงู„ ุงู„ู…ุนู„ูˆู…ุงุช ุงู„ุชุนุณููŠุฉ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "notice_url": { + "description": "ุณูŠุชู… ุฅุฎุทุงุฑ ุงู„ุฅุดุนุงุฑ ูˆุนู†ูˆุงู† URL ู„ู„ุฎุทุงู ุงู„ุฅู„ูƒุชุฑูˆู†ูŠ ุนู†ุฏ ุงู„ุฏูุน ุงู„ู†ุงุฌุญ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "format": "url" + } + }, + "required": [ + "card_number", + "expiry", + "birth", + "merchant_uid", + "amount", + "name" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุฅุฏุฎุงู„ ุทู„ุจ ุงู„ุฏูุน.", + "x-typia-jsDocTags": [] + }, + "IIamportResponse_lt_IIamportCardPayment_gt_": { + "type": "object", + "properties": { + "code": { + "description": "ุฑู…ุฒ ุงู„ุฎุทุฃ. ุงู„ู‚ูŠู…ุฉ 0 ุชุนู†ูŠ ุนุฏู… ูˆุฌูˆุฏ ุฎุทุฃ..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "message": { + "description": "ุฑุณุงู„ุฉ ุงู„ู†ุฌุงุญ ุฃูˆ ุงู„ุฎุทุฃ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/IIamportCardPayment" + } + }, + "required": [ + "code", + "message", + "response" + ], + "description": "ุฃู‚ูˆู… ุจุงุณุชูŠุฑุงุฏ ุจูŠุงู†ุงุช ุงู„ุงุณุชุฌุงุจุฉ ุงู„ูุฑูŠุฏุฉ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportSubscription.IAgain": { + "type": "object", + "properties": { + "merchant_uid": { + "description": "ู…ูุชุงุญ ู…ุนุฑู ุงู„ุทู„ุจ. ู…ูุชุงุญ ุงู„ู…ุนุฑู ุชุชู… ุฅุฏุงุฑุชู‡ ุจูˆุงุณุทุฉ ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู…ู‡ุŒ ูˆู„ูŠุณ ุจูˆุงุณุทุฉ I'mport..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "ุฅุฌู…ุงู„ูŠ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "name": { + "description": "ุงุณู… ุงู„ุทู„ุจ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "currency": { + "oneOf": [ + { + "const": "KRW" + }, + { + "const": "USD" + }, + { + "const": "EUR" + }, + { + "const": "JPY" + } + ], + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ู…ูƒุงู„ู…ุฉ.", + "x-typia-required": false, + "x-typia-optional": true + }, + "tax_free": { + "description": "ู‚ูŠู…ุฉ ุงู„ุนุฑุถ ุงู„ู…ุนูุงุฉ ู…ู† ุงู„ุถุฑุงุฆุจ. ุงู„ู‚ูŠู…ุฉ ุงู„ุงูุชุฑุงุถูŠุฉ ู‡ูŠ 0ุŒ ู„ุฐุง ุชุชู… ู…ุนุงู„ุฌุฉ ุถุฑูŠุจุฉ ุงู„ู‚ูŠู…ุฉ ุงู„ู…ุถุงูุฉ ุชู„ู‚ุงุฆูŠู‹ุง ุนู„ู‰ ุฃู†ู‡ุง 1/11 ู…ู† ุงู„ู…ุจู„ุบ..", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "card_quota": { + "description": "ุนุฏุฏ ุฃุดู‡ุฑ ุงู„ู‚ุณุท. ุฏูุน ุงู„ู…ุจู„ุบ ุงู„ู…ู‚ุทูˆุน ู‡ูˆ 0.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "buyer_name": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_email": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "format": "email" + }, + "buyer_tel": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_addr": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_postcode": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "interest_free_by_merchant": { + "description": "ุนู†ุฏ ู…ุนุงู„ุฌุฉ ุฃู‚ุณุงุท ุจุทุงู‚ุฉ ุงู„ุงุฆุชู…ุงู†ุŒ ุชุชุฑุงูƒู… ูุงุฆุฏุฉ ุงู„ู‚ุณุท (ุจุงุณุชุซู†ุงุก ุงู„ุนุฑูˆุถ ุงู„ุชุฑูˆูŠุฌูŠุฉ ุจุฏูˆู† ููˆุงุฆุฏ ู„ุดุฑูƒุฉ ุจุทุงู‚ุงุช ุงู„ุงุฆุชู…ุงู†). ุนู†ุฏ ุฅุจุฑุงู… ุนู‚ุฏ ู…ุน ุดุฑูƒุฉ PG ู„ูŠู‚ูˆู… ุงู„ู…ุชุฌุฑ ุงู„ุชุงุจุน ุจุฏูุน ูุงุฆุฏุฉ ุงู„ู‚ุณุท ุงู„ู…ูุฑูˆุถุฉ ู†ูŠุงุจุฉ ุนู† ุงู„ุนู…ูŠู„ (ููŠ ุงู„ูˆู‚ุช ุงู„ุญุงู„ูŠุŒ ูŠุชู… ุฏุนู… Nice Payments ูู‚ุท)", + "x-typia-required": false, + "x-typia-optional": true, + "type": "boolean" + }, + "use_card_point": { + "description": "ุนู†ุฏ ุทู„ุจ ุงู„ู…ูˆุงูู‚ุฉุŒ ุถุน ุนู„ุงู…ุฉ ุนู„ู‰ ู…ุง ุฅุฐุง ูƒุงู† ุณูŠุชู… ุฎุตู… ู†ู‚ุงุท ุดุฑูƒุฉ ุงู„ุจุทุงู‚ุฉ ูˆุณูŠุชู… ุงู„ู…ูˆุงูู‚ุฉ ุนู„ู‰ ุงู„ุฏูุน. ู…ุทู„ูˆุจ ุงู„ุชุดุงูˆุฑ ุงู„ู…ุณุจู‚ ู…ุน ู…ู†ุฏูˆุจ ู…ุจูŠุนุงุช ุดุฑูƒุฉ PG ููŠ ูˆู‚ุช ุชูˆู‚ูŠุน ุงู„ุนู‚ุฏ (ุญุงู„ูŠู‹ุงุŒ ูŠุชู… ุฏุนู… Nice Payments ูู‚ุท)", + "x-typia-required": false, + "x-typia-optional": true, + "type": "boolean" + }, + "custom_data": { + "description": "ูŠู…ูƒู† ุฅุฏุฎุงู„ ุงู„ู…ุนู„ูˆู…ุงุช ุงู„ุชุนุณููŠุฉ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "notice_url": { + "description": "ุณูŠุชู… ุฅุฎุทุงุฑ ุงู„ุฅุดุนุงุฑ ูˆุนู†ูˆุงู† URL ู„ู„ุฎุทุงู ุงู„ุฅู„ูƒุชุฑูˆู†ูŠ ุนู†ุฏ ุงู„ุฏูุน ุงู„ู†ุงุฌุญ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "format": "url" + }, + "customer_uid": { + "description": "ู…ูุชุงุญ ู…ุนุฑู ุงู„ุนู…ูŠู„. ู…ูุชุงุญ ู…ุนุฑู ุชุชู… ุฅุฏุงุฑุชู‡ ุจูˆุงุณุทุฉ ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู…ู‡ุŒ ูˆู„ูŠุณ ุนู† ุทุฑูŠู‚ ุงู„ุงุณุชูŠุฑุงุฏ. ูˆู…ุน ุฐู„ูƒุŒ ูŠุฌุจ ุงุณุชุฎุฏุงู…ู‡ ูุนู„ูŠู‹ุง ูƒู…ูุชุงุญ ู…ุนุฑู ุงู„ุจุทุงู‚ุฉ ุจุฏู„ุงู‹ ู…ู† ุงุณุชุฎุฏุงู…ู‡ ูƒุนู…ูŠู„..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "merchant_uid", + "amount", + "name", + "customer_uid" + ], + "description": "ู…ุนู„ูˆู…ุงุช ู„ุชู‚ุฏูŠู… ุทู„ุจ ุงู„ุฏูุน ุนู† ุทุฑูŠู‚ ุจุทุงู‚ุฉ ุงู„ุฏูุน ุงู„ุจุณูŠุทุฉ.", + "x-typia-jsDocTags": [] + } + }, + "securitySchemes": { + "bearer": { + "type": "apiKey", + "name": "Authorization", + "in": "header" + } + } + }, + "x-samchon-emended": true +} \ No newline at end of file diff --git a/assets/output/iamport.swagger.en.json b/assets/output/iamport.swagger.en.json new file mode 100644 index 0000000..8c216c5 --- /dev/null +++ b/assets/output/iamport.swagger.en.json @@ -0,0 +1,5056 @@ +{ + "openapi": "3.1.0", + "servers": [ + { + "url": "http://localhost:10851", + "description": "fake" + }, + { + "url": "https://api.iamport.kr", + "description": "real" + } + ], + "info": { + "title": "Iamport API", + "description": "Built by [fake-iamport-server](https://github.com/samchon/fake-iamport-server) with [nestia](https://github.com/samchon/nestia)", + "version": "2.0.1", + "license": { + "name": "MIT" + } + }, + "paths": { + "/certifications/{imp_uid}": { + "get": { + "tags": [], + "parameters": [ + { + "name": "imp_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "The target's personal authentication information", + "required": true + } + ], + "responses": { + "200": { + "description": "Personal authentication information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportCertification_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "View your personal authentication information", + "description": "Viewing authentication information. `certiciations.at` is an API function used to view authentication information. However, there is no guarantee that the authentication information {@link IIamportCertification} viewed through this API function is a record that has completed authentication, including OTP authentication. This is because the completion of authentication can only be known by directly checking the {@link IIamportCertification.certified} value..", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "certifications.at", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "imp_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋Œ€์ƒ ๋ณธ์ธ์ธ์ฆ ์ •๋ณด์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "IIamportCertification.imp_uid", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-iamport-server/src/api/structures/IIamportCertification.ts", + "textSpan": { + "start": 488, + "length": 16 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๋ณธ์ธ์ธ์ฆ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "GET" + }, + "delete": { + "tags": [], + "parameters": [ + { + "name": "imp_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "The target's personal authentication information", + "required": true + } + ], + "responses": { + "200": { + "description": "Deleted authentication information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportCertification_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "Delete your personal authentication information", + "description": "Delete your personal authentication information.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "certifications.erase", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "imp_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋Œ€์ƒ ๋ณธ์ธ์ธ์ฆ ์ •๋ณด์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "IIamportCertification.imp_uid", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-iamport-server/src/api/structures/IIamportCertification.ts", + "textSpan": { + "start": 488, + "length": 16 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์‚ญ์ œ๋œ ๋ณธ์ธ์ธ์ฆ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "DELETE" + } + }, + "/certifications/otp/request": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "Request for identity verification information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportCertification.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "Identifier information for ongoing identity verification", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportCertification.IAccessor_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "Request identity verification", + "description": "Request identity verification. `certifications.otp.request` is an API function that requests identity verification to the Iamport server. When this API is called, an OTP text message is sent to the mobile phone of the person subject to identity verification, and the person subject to identity verification completes identity verification by accurately entering this OTP number through {@link certifications.otp.confirm}. In addition, even before the person subject to identity verification enters the OTP text message sent to his or her mobile phone, the identity verification details can still be viewed through the {@link certifications.at} function. However, the {@link IIamportCertification.certified} value, which indicates whether the authentication is complete in the {@link IIamportCertification} returned at this time, is `false`..", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "certifications.otp.request.request", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋ณธ์ธ์ธ์ฆ ์š”์ฒญ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์ง„ํ–‰ ์ค‘์ธ ๋ณธ์ธ์ธ์ฆ์˜ ์‹๋ณ„์ž ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/certifications/otp/confirm/{imp_uid}": { + "post": { + "tags": [], + "parameters": [ + { + "name": "imp_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "The target's personal authentication information", + "required": true + } + ], + "requestBody": { + "description": "OTP Code", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportCertification.IConfirm" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "Completed authentication information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportCertification_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "Enter the OTP code issued during identity verification", + "description": "Enter the OTP code issued during identity verification. `certifications.otp.confirm` is an API function that verifies the OTP number sent to the mobile phone of the person subject to identity verification for the identity verification issued through {@link certifications.otp.request}, and approves and completes the identity verification if the entered OTP number is correct. When identity verification is completed in this way, the {@link IIamportCertification.certified} value of the identity verification {@link IIamportCertification} changes to `true`, and it is finally completed..", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "certifications.otp.confirm.confirm", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "imp_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋Œ€์ƒ ๋ณธ์ธ์ธ์ฆ ์ •๋ณด์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "IIamportCertification.imp_uid", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-iamport-server/src/api/structures/IIamportCertification.ts", + "textSpan": { + "start": 488, + "length": 16 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "OTP ์ฝ”๋“œ", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์ธ์ฆ ์™„๋ฃŒ๋œ ๋ณธ์ธ์ธ์ฆ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/internal/webhook": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "Webhook event information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportPayment.IWebhook" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "", + "x-nestia-encrypted": false + } + }, + "summary": "Webhook event dummy listener", + "description": "Webhook event dummy listener. `internal.webhook` is an API that does not exist in the actual Impoot server. If you do not set any URL in {@link Configuration.WEBHOOK_URL } of `fake-impoart-server`, all kinds of webhook events occurring from `fake-iamport-server` will be forwarded to this and disappear meaninglessly. Therefore, when you want to verify the connection with the Impoot server in advance using `fake-iamport-server`, be sure to set {@link Configuration.WEBHOOK_URL } so that the webhook event will be properly forwarded to your backend server..", + "x-nestia-namespace": "internal.webhook.webhook", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์›นํ›… ์ด๋ฒคํŠธ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/internal/deposit/{imp_uid}": { + "get": { + "tags": [], + "parameters": [ + { + "name": "imp_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "Target payment", + "required": true + } + ], + "responses": { + "200": { + "description": "", + "x-nestia-encrypted": false + } + }, + "summary": "Deposit to virtual account", + "description": "Deposit to a virtual account. `internal.deposit` is an API that does not exist in the actual import payment server. It is a function that can simulate a situation where a customer who applied for a virtual account payment deposits the target amount into the virtual account. In other words, `internal.deposit` is a test function designed to simulate a series of situations where a customer deposits money into a virtual account issued to him/herself, and a webhook event occurs on the import server accordingly, which is then transmitted to your backend server..", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "internal.deposit.deposit", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "imp_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋Œ€์ƒ ๊ฒฐ์ œ์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "IIamportVBankPayment.imp_uid ", + "kind": "linkText" + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "GET" + } + }, + "/payments/{imp_uid}": { + "get": { + "tags": [], + "parameters": [ + { + "name": "imp_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "The target payment record", + "required": true + }, + { + "name": "query", + "in": "query", + "schema": { + "$ref": "#/components/schemas/IIamportPayment.IQuery" + }, + "description": "Use when your payment method is PayPal", + "required": true + } + ], + "responses": { + "200": { + "description": "Payment Information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportPayment_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "View payment records", + "description": "View payment records. View payment records made through Aimport..", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "payments.at", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "imp_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋Œ€์ƒ ๊ฒฐ์ œ ๊ธฐ๋ก์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "IIamportPayment.imp_uid", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-iamport-server/src/api/structures/IIamportPayment.ts", + "textSpan": { + "start": 2339, + "length": 16 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "query", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฒฐ์ œ ์ˆ˜๋‹จ์ด ํŽ˜์ดํŒ”์ธ ๊ฒฝ์šฐ์— ์‚ฌ์šฉ", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "GET" + } + }, + "/payments/cancel": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "Payment Cancellation Input Information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportPaymentCancel.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "Cancelled Payment Information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportPayment_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "Cancel payment", + "description": "Cancel payment. If payment was made through a virtual account, you must enter the refund account information..", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "payments.cancel.cancel", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฒฐ์ œ ์ทจ์†Œ ์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์ทจ์†Œ๋œ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/receipts/{imp_uid}": { + "get": { + "tags": [], + "parameters": [ + { + "name": "imp_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "Attribution payment", + "required": true + } + ], + "responses": { + "200": { + "description": "Cash Receipt Information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportReceipt_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "Check cash receipt", + "description": "Check cash receipt.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "receipts.at", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "imp_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ท€์† ๊ฒฐ์ œ์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "IIamportPayment.imp_uid", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-iamport-server/src/api/structures/IIamportPayment.ts", + "textSpan": { + "start": 2339, + "length": 16 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "GET" + }, + "post": { + "tags": [], + "parameters": [ + { + "name": "imp_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "Attribution payment", + "required": true + } + ], + "requestBody": { + "description": "Cash receipt entry information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportReceipt.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "Cash Receipt Information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportReceipt_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "Issue a cash receipt", + "description": "Issue a cash receipt.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "receipts.store", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "imp_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ท€์† ๊ฒฐ์ œ์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "IIamportPayment.imp_uid", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-iamport-server/src/api/structures/IIamportPayment.ts", + "textSpan": { + "start": 2339, + "length": 16 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + }, + "delete": { + "tags": [], + "parameters": [ + { + "name": "imp_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "Attribution payment", + "required": true + } + ], + "responses": { + "200": { + "description": "Cancelled Cash Receipt Information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportReceipt_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "Cancel a cash receipt", + "description": "Cancel a cash receipt.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "receipts.erase", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "imp_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ท€์† ๊ฒฐ์ œ์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "IIamportPayment.imp_uid", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-iamport-server/src/api/structures/IIamportPayment.ts", + "textSpan": { + "start": 2339, + "length": 16 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์ทจ์†Œ๋œ ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "DELETE" + } + }, + "/users/getToken": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "Import's API and secret key information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportUser.IAccessor" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "User authentication token information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportUser_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "Issue user authentication token", + "description": "Issue a user authentication token. Issue a user authentication token based on the API and secret key granted by signing up for Iamport. However, the user authentication token issued by Iamport has a validity time {@link IIamportUser.expired_at }, and when the time elapses, the previously issued token expires and can no longer be used. Therefore, if you want to freely use Iamport's API without being restricted by this time limit of Iamport, let's use {@link IamportConnector } provided by `iamport-server-api`..", + "x-nestia-namespace": "users.getToken.getToken", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์•„์ž„ํฌํŠธ์˜ API ๋ฐ secret ํ‚ค ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์œ ์ € ์ธ์ฆ ํ† ํฐ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/vbanks": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "Virtual account entry information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportVBankPayment.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "Virtual Account Payment Information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportVBankPayment_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "Issuing a virtual account", + "description": "Issuing a virtual account.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "vbanks.store", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฐ€์ƒ ๊ณ„์ขŒ ์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฐ€์ƒ ๊ณ„์ขŒ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + }, + "put": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "Edit Virtual Account Input Information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportVBankPayment.IUpdate" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "Edited Virtual Account Payment Information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportVBankPayment_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "Editing a virtual account", + "description": "Editing a virtual account.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "vbanks.update", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฐ€์ƒ ๊ณ„์ขŒ ํŽธ์ง‘ ์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "ํŽธ์ง‘๋œ ๊ฐ€์ƒ ๊ณ„์ขŒ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "PUT" + } + }, + "/subscribe/customers/{customer_uid}": { + "get": { + "tags": [], + "parameters": [ + { + "name": "customer_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "Customer (simple payment card) identifier key", + "required": true + } + ], + "responses": { + "200": { + "description": "Easy Payment Card Information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportSubscription_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "Check your easy payment card information", + "description": "Search for simple payment card information. `subscribe.customers.at` is an API function that searches for simple payment card information saved by customers using {@link store} or the simple payment card registration window provided by I'mport..", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "subscribe.customers.at", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "customer_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ณ ๊ฐ (๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ) ์‹๋ณ„์ž ํ‚ค", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "GET" + }, + "post": { + "tags": [], + "parameters": [ + { + "name": "customer_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "Customer (simple payment card) identifier key", + "required": true + } + ], + "requestBody": { + "description": "Card entry information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportSubscription.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "Easy Payment Card Information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportSubscription_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "Register a simple payment card", + "description": "Registering a simple payment card. `subscribe.customers.stoer` is an API function used when a customer wants to register his/her card on the server and make a simple payment without having to repeatedly enter the card information every time a payment is needed. Please note that `subscribe.customers.store` will not be called by your backend server in the actual service if the client application uses the simple payment card registration window provided by Aimport. However, it can be used at the test automation program level to simulate a situation where a customer registers a simple payment card..", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "subscribe.customers.store", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "customer_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ณ ๊ฐ (๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ) ์‹๋ณ„์ž ํ‚ค", + "kind": "text" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์นด๋“œ ์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + }, + "delete": { + "tags": [], + "parameters": [ + { + "name": "customer_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "Customer (simple payment card) identifier key", + "required": true + } + ], + "responses": { + "200": { + "description": "Deleted Easy Payment Card Information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportSubscription_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "Delete Easy Payment Card", + "description": "Delete a simple payment card. Remove the card registered for simple payment..", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "subscribe.customers.erase", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "customer_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ณ ๊ฐ (๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ) ์‹๋ณ„์ž ํ‚ค", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์‚ญ์ œ๋œ ๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "DELETE" + } + }, + "/subscribe/payments/onetime": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "Card Payment Application Information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportSubscription.IOnetime" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "Card Payment Information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportCardPayment_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "Pay by card, and register for easy payment", + "description": "Pay by card, and also register for simple payment. `subscribe.payments.onetime` is an API function called when you want to make a payment using a card. In addition, if you enter {@link IIamportSubscription.IOnetime.customer_uid} in the input value, the card used for payment will be registered as a simple payment card {@link IIamportSubscription}. However, if you really want to register a simple card and make a payment at the same time, it is recommended to call {@link subscribe.customers.store} and {@link subscribe.payments.again} separately rather than adding {@link IIamportSubscription.IOnetime.customer_uid} to `subscribe.payments.onetime`. This is because it can handle exceptional situations more safely. In addition, if the client application uses the payment window provided by Aimport as it is, `subscribe.payments.onetime` will not be called by your backend server in the actual service. However, it can be used at the test automation program level to simulate a situation where a customer pays using a card..", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "subscribe.payments.onetime.onetime", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์นด๋“œ ๊ฒฐ์ œ ์‹ ์ฒญ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์นด๋“œ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/subscribe/payments/again": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "Payment application information using a pre-registered card", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportSubscription.IAgain" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "Card Payment Information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportCardPayment_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "Pay with a card registered for easy payment", + "description": "Pay with a card registered for easy payment. `subscribe.payments.again` is an API function called when a customer wants to make a payment with a card registered for easy payment. Regardless of whether it is convenient or inconvenient, it is essentially a part of card payment, so the return value is {@link IIamportCardPayment }, which is the same as for general card payment. And `subscribe.payments.again` is the only payment method that applies when the client application cannot use the payment window provided by Iamport, and only your backend server must directly call Iamport's API function. Therefore, when developing a backend server and front-end application that are linked with the Iamport server for easy payment, separate design and development for this situation is required, so please keep this in mind..", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "subscribe.payments.again.again", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋ฏธ๋ฆฌ ๋“ฑ๋กํ•œ ์นด๋“œ๋ฅผ ์ด์šฉํ•œ ๊ฒฐ์ œ ์‹ ์ฒญ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์นด๋“œ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + } + }, + "components": { + "schemas": { + "IIamportResponse_lt_IIamportCertification_gt_": { + "type": "object", + "properties": { + "code": { + "description": "Error code. A value of 0 means there is no error..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "message": { + "description": "Success or error message.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/IIamportCertification" + } + }, + "required": [ + "code", + "message", + "response" + ], + "description": "Import-specific response data.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportCertification": { + "type": "object", + "properties": { + "imp_uid": { + "description": "Identifier number issued by Import.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "merchant_uid": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "description": "An identifier key from a service. It is issued and managed by the service that uses it, not by the import server..", + "x-typia-required": true, + "x-typia-optional": false + }, + "name": { + "description": "Name of person to be authenticated.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "gender": { + "description": "gender.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "birth": { + "description": "Date of birth. Linux time is used..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "birthday": { + "description": "Date of birth, YYYYMMDD format.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^([0-9]{4})(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$" + }, + "foreigner": { + "description": "Whether you are a foreigner.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "phone": { + "description": "Mobile phone number of the person to be authenticated.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "carrier": { + "oneOf": [ + { + "const": "SKT" + }, + { + "const": "KT" + }, + { + "const": "LGT" + } + ], + "description": "Telecommunications company code of the person being authenticated.", + "x-typia-required": true, + "x-typia-optional": false + }, + "certified": { + "description": "Whether OTP authentication is required.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "certified_at": { + "description": "OTP authentication date and time. Linux time is used, and 0 is used instead of `null`..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "unique_key": { + "description": "I'm not sure what this is, does anyone know what it's used for?", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "unique_in_site": { + "description": "I'm not sure what this is, does anyone know what it's used for?", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_tid": { + "description": "I'm not sure what this is, does anyone know what it's used for?", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_provider": { + "description": "PG Provider.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "origin": { + "description": "I'm not sure what this is, does anyone know what it's used for?", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "__otp": { + "description": "(For testing only) OTP code. This is an attribute used only in `fake-iamport-server`, and is used to check what OTP code was issued when simulating identity verification. Using this, you can complete identity verification by calling the {@link functional.certifications.otp.confirm } function..", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + } + }, + "required": [ + "imp_uid", + "merchant_uid", + "name", + "gender", + "birth", + "birthday", + "foreigner", + "phone", + "carrier", + "certified", + "certified_at", + "unique_key", + "unique_in_site", + "pg_tid", + "pg_provider", + "origin" + ], + "description": "Identity verification details. `IIamportCertification` is a data structure interface that visualizes identity verification information of Iamport. However, the existence of the `IIamportCertification` record does not mean that identity verification is complete. Only when the value of {@link IIamportCertification.certified } is `true` does it mean that the identity verification target has completed identity verification by accurately entering the OTP sent to his/her mobile phone number in the identity verification pop-up window of Iamport..", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportCertification.IStore": { + "type": "object", + "properties": { + "name": { + "description": "Name of person to be authenticated.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "phone": { + "description": "The mobile phone number of the person being authenticated. It doesn't matter whether the mobile phone number contains a "-" value or not. However, internally, the "-" value is removed and processed..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "birth": { + "description": "Date of birth. YYYYMMDD format.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^([0-9]{4})(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$" + }, + "gender_digit": { + "description": "The first digit of the last part of the resident registration number.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "carrier": { + "oneOf": [ + { + "const": "SKT" + }, + { + "const": "KT" + }, + { + "const": "LGT" + } + ], + "description": "Telecommunications company code of the person being authenticated.", + "x-typia-required": true, + "x-typia-optional": false + }, + "is_mvno": { + "description": "Whether it is a budget phone or not.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "boolean" + }, + "commpany": { + "description": "Merchant service name or domain URL. Service name to be notified in SMS sent to target by KISA.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "merchant_uid": { + "description": "The identity verification key for your service. It is issued and managed by the service that uses it, not the import server..", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "pg": { + "description": "PG store separator. Set this when you want to use more than two Danal store IDs at the same time. Specify in the format **danal.{store ID}**.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + } + }, + "required": [ + "name", + "phone", + "birth", + "gender_digit", + "carrier" + ], + "description": "Enter your personal authentication information.", + "x-typia-jsDocTags": [] + }, + "IIamportResponse_lt_IIamportCertification.IAccessor_gt_": { + "type": "object", + "properties": { + "code": { + "description": "Error code. A value of 0 means there is no error..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "message": { + "description": "Success or error message.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/IIamportCertification.IAccessor" + } + }, + "required": [ + "code", + "message", + "response" + ], + "description": "Import-specific response data.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportCertification.IAccessor": { + "type": "object", + "properties": { + "imp_uid": { + "description": "Identifier key of your authentication information.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "imp_uid" + ], + "description": "Accessor structure for authentication information.", + "x-typia-jsDocTags": [] + }, + "IIamportCertification.IConfirm": { + "type": "object", + "properties": { + "otp": { + "description": "Authentication number sent via SMS.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "otp" + ], + "description": "Input information for identity verification approval.", + "x-typia-jsDocTags": [] + }, + "IIamportPayment.IWebhook": { + "type": "object", + "properties": { + "imp_uid": { + "description": "Identifier key of payment information {@link IIamportPayment}.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "merchant_uid": { + "description": "Order identifier key. Issued and managed by the service that uses it, not the import server..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "status": { + "oneOf": [ + { + "const": "paid" + }, + { + "const": "ready" + }, + { + "const": "failed" + }, + { + "const": "cancelled" + } + ], + "description": "Current status.", + "x-typia-required": true, + "x-typia-optional": false + } + }, + "required": [ + "imp_uid", + "merchant_uid", + "status" + ], + "description": "Webhook data.", + "x-typia-jsDocTags": [] + }, + "IIamportPayment.IQuery": { + "type": "object", + "properties": { + "extension": { + "description": "For PayPal, this value should be `true`.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "boolean" + } + }, + "description": "If the payment method is PayPal, the status is created as Pending at the time of payment approval due to PayPal's buyer protection policy, and then changed to final payment completion through internal review, etc. Due to a technical issue with `iamport`, the status is recorded as status: failed. If it is later changed to final payment completion in PayPal, `iamport` is changed to `paid` and a webhook is sent for the case. Customers who use `iamport` have a problem receiving a webhook of the paid status for a payment that has already been processed as failed. Therefore, the `extension=true` option must be added as a query-string to `/payment/{imp_uid}` provided by `iamport`.", + "x-typia-jsDocTags": [ + { + "name": "issue", + "text": [ + { + "text": "https://github.com/samchon/fake-iamport-server/issues/13", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Sangjin Han - https://github.com/ltnscp9028", + "kind": "text" + } + ] + } + ] + }, + "IIamportResponse_lt_IIamportPayment_gt_": { + "type": "object", + "properties": { + "code": { + "description": "Error code. A value of 0 means there is no error..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "message": { + "description": "Success or error message.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/IIamportPayment" + } + }, + "required": [ + "code", + "message", + "response" + ], + "description": "Import-specific response data.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportPayment": { + "oneOf": [ + { + "$ref": "#/components/schemas/IIamportCardPayment" + }, + { + "$ref": "#/components/schemas/IIamportTransferPayment" + }, + { + "$ref": "#/components/schemas/IIamportVBankPayment" + }, + { + "$ref": "#/components/schemas/IIamportPayment.IBase_lt__doublequote_phone_doublequote__space__or__space__doublequote_kpay_doublequote__space__or__space__doublequote_kakaopay_doublequote__space__or__space__doublequote_payco_doublequote__space__or__space__doublequote_lpay_doublequote__space__or__space__doublequote_ssgpay_doublequote__space__or__space__doublequote_tosspay_doublequote__space__or__space__doublequote_cultureland_doublequote__space__or__space__doublequote_smartculture_doublequote__space__or__space__doublequote_happymoney_doublequote__space__or__space__doublequote_booknlife_doublequote__space__or__space__doublequote_point_doublequote__gt_" + } + ], + "description": "Payment information. `IIamportPayment` is a data structure that visualizes the payment information of Iamport, and is a union type interface. If the method value is specified through the if condition, the derived type is automatically specified. ```typescript if (payment.pay_method === "card") payment.card_number; // payment be IIamportCardPayment ```", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportCardPayment": { + "type": "object", + "properties": { + "card_code": { + "description": "Card identifier code.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "card_name": { + "description": "Card name.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "card_number": { + "description": "Card number.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "\\d{4}-\\d{4}-\\d{4}-\\d{4}" + }, + "card_quota": { + "description": "Number of installment months.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "integer" + }, + "apply_num": { + "description": "Card company approval number.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pay_method": { + "oneOf": [ + { + "const": "card" + }, + { + "const": "samsung" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "imp_uid": { + "description": "Identifier key of payment information {@link IIamportPayment}.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "merchant_uid": { + "description": "Order identifier key. Issued and managed by the service that uses it, not the import server..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "name": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Order name, may be missing.", + "x-typia-required": true, + "x-typia-optional": false + }, + "amount": { + "description": "Total payment amount.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancel_amount": { + "description": "Cancellation of payment, total refund amount.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "currency": { + "$ref": "#/components/schemas/IIamportPayment.Currency" + }, + "receipt_url": { + "description": "Receipt URL.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "url" + }, + "cash_receipt_issue": { + "description": "Whether to issue a cash receipt.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "channel": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_provider": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "emb_pg_provider": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "pg_id": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_tid": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "escrow": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "buyer_name": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_email": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "email" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_tel": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_addr": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_postcode": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_uid": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_uid_usage": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "custom_data": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "user_agent": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "status": { + "$ref": "#/components/schemas/IIamportPayment.Status" + }, + "started_at": { + "description": "Payment request date and time. Linux time is used..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "paid_at": { + "description": "The date and time of payment completion. Linux time is used, and 0 is used instead of `null`..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "failed_at": { + "description": "The date and time of the payment failure. Linux time is used, and 0 is used instead of `null`..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancelled_at": { + "description": "The date and time of the cancellation. Linux time is used, and 0 is used instead of `null`..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "fail_reason": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "cancel_reason": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "cancel_history": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/IIamportPaymentCancel" + } + } + }, + "required": [ + "card_code", + "card_name", + "card_number", + "card_quota", + "apply_num", + "pay_method", + "imp_uid", + "merchant_uid", + "name", + "amount", + "cancel_amount", + "currency", + "receipt_url", + "cash_receipt_issue", + "channel", + "pg_provider", + "emb_pg_provider", + "pg_id", + "pg_tid", + "escrow", + "buyer_name", + "buyer_email", + "buyer_tel", + "buyer_addr", + "buyer_postcode", + "customer_uid", + "customer_uid_usage", + "custom_data", + "user_agent", + "status", + "started_at", + "paid_at", + "failed_at", + "cancelled_at", + "fail_reason", + "cancel_reason", + "cancel_history" + ], + "description": "Card Payment Information.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportPayment.Currency": { + "oneOf": [ + { + "const": "KRW" + }, + { + "const": "USD" + }, + { + "const": "EUR" + }, + { + "const": "JPY" + } + ] + }, + "IIamportPayment.Status": { + "oneOf": [ + { + "const": "paid" + }, + { + "const": "ready" + }, + { + "const": "failed" + }, + { + "const": "cancelled" + } + ] + }, + "IIamportPaymentCancel": { + "type": "object", + "properties": { + "pg_id": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_tid": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancelled_at": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "reason": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "receipt_url": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "url" + } + }, + "required": [ + "pg_id", + "pg_tid", + "amount", + "cancelled_at", + "reason", + "receipt_url" + ], + "description": "Payment Cancellation Information.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportTransferPayment": { + "type": "object", + "properties": { + "bank_code": { + "description": "Bank identifier code.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "bank_name": { + "description": "Bank name.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pay_method": { + "const": "trans", + "x-typia-required": true, + "x-typia-optional": false + }, + "imp_uid": { + "description": "Identifier key of payment information {@link IIamportPayment}.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "merchant_uid": { + "description": "Order identifier key. Issued and managed by the service that uses it, not the import server..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "name": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Order name, may be missing.", + "x-typia-required": true, + "x-typia-optional": false + }, + "amount": { + "description": "Total payment amount.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancel_amount": { + "description": "Cancellation of payment, total refund amount.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "currency": { + "$ref": "#/components/schemas/IIamportPayment.Currency" + }, + "receipt_url": { + "description": "Receipt URL.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "url" + }, + "cash_receipt_issue": { + "description": "Whether to issue a cash receipt.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "channel": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_provider": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "emb_pg_provider": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "pg_id": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_tid": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "escrow": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "buyer_name": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_email": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "email" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_tel": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_addr": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_postcode": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_uid": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_uid_usage": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "custom_data": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "user_agent": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "status": { + "$ref": "#/components/schemas/IIamportPayment.Status" + }, + "started_at": { + "description": "Payment request date and time. Linux time is used..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "paid_at": { + "description": "The date and time of payment completion. Linux time is used, and 0 is used instead of `null`..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "failed_at": { + "description": "The date and time of the payment failure. Linux time is used, and 0 is used instead of `null`..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancelled_at": { + "description": "The date and time of the cancellation. Linux time is used, and 0 is used instead of `null`..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "fail_reason": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "cancel_reason": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "cancel_history": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/IIamportPaymentCancel" + } + } + }, + "required": [ + "bank_code", + "bank_name", + "pay_method", + "imp_uid", + "merchant_uid", + "name", + "amount", + "cancel_amount", + "currency", + "receipt_url", + "cash_receipt_issue", + "channel", + "pg_provider", + "emb_pg_provider", + "pg_id", + "pg_tid", + "escrow", + "buyer_name", + "buyer_email", + "buyer_tel", + "buyer_addr", + "buyer_postcode", + "customer_uid", + "customer_uid_usage", + "custom_data", + "user_agent", + "status", + "started_at", + "paid_at", + "failed_at", + "cancelled_at", + "fail_reason", + "cancel_reason", + "cancel_history" + ], + "description": "Account transfer payment information.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportVBankPayment": { + "type": "object", + "properties": { + "vbank_code": { + "description": "Virtual Account Identifier Code.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "vbank_name": { + "description": "Virtual account name", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "vbank_num": { + "description": "Virtual account number", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "vbank_holder": { + "description": "Virtual account depositor.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "vbank_date": { + "description": "Virtual account deposit expiration date.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vbank_issued_at": { + "description": "Virtual account opening date.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "pay_method": { + "const": "vbank", + "x-typia-required": true, + "x-typia-optional": false + }, + "imp_uid": { + "description": "Identifier key of payment information {@link IIamportPayment}.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "merchant_uid": { + "description": "Order identifier key. Issued and managed by the service that uses it, not the import server..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "name": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Order name, may be missing.", + "x-typia-required": true, + "x-typia-optional": false + }, + "amount": { + "description": "Total payment amount.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancel_amount": { + "description": "Cancellation of payment, total refund amount.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "currency": { + "$ref": "#/components/schemas/IIamportPayment.Currency" + }, + "receipt_url": { + "description": "Receipt URL.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "url" + }, + "cash_receipt_issue": { + "description": "Whether to issue a cash receipt.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "channel": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_provider": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "emb_pg_provider": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "pg_id": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_tid": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "escrow": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "buyer_name": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_email": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "email" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_tel": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_addr": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_postcode": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_uid": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_uid_usage": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "custom_data": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "user_agent": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "status": { + "$ref": "#/components/schemas/IIamportPayment.Status" + }, + "started_at": { + "description": "Payment request date and time. Linux time is used..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "paid_at": { + "description": "The date and time of payment completion. Linux time is used, and 0 is used instead of `null`..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "failed_at": { + "description": "The date and time of the payment failure. Linux time is used, and 0 is used instead of `null`..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancelled_at": { + "description": "The date and time of the cancellation. Linux time is used, and 0 is used instead of `null`..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "fail_reason": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "cancel_reason": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "cancel_history": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/IIamportPaymentCancel" + } + } + }, + "required": [ + "vbank_code", + "vbank_name", + "vbank_num", + "vbank_holder", + "vbank_date", + "vbank_issued_at", + "pay_method", + "imp_uid", + "merchant_uid", + "name", + "amount", + "cancel_amount", + "currency", + "receipt_url", + "cash_receipt_issue", + "channel", + "pg_provider", + "emb_pg_provider", + "pg_id", + "pg_tid", + "escrow", + "buyer_name", + "buyer_email", + "buyer_tel", + "buyer_addr", + "buyer_postcode", + "customer_uid", + "customer_uid_usage", + "custom_data", + "user_agent", + "status", + "started_at", + "paid_at", + "failed_at", + "cancelled_at", + "fail_reason", + "cancel_reason", + "cancel_history" + ], + "description": "Virtual Account Payment Information.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportPayment.IBase_lt__doublequote_phone_doublequote__space__or__space__doublequote_kpay_doublequote__space__or__space__doublequote_kakaopay_doublequote__space__or__space__doublequote_payco_doublequote__space__or__space__doublequote_lpay_doublequote__space__or__space__doublequote_ssgpay_doublequote__space__or__space__doublequote_tosspay_doublequote__space__or__space__doublequote_cultureland_doublequote__space__or__space__doublequote_smartculture_doublequote__space__or__space__doublequote_happymoney_doublequote__space__or__space__doublequote_booknlife_doublequote__space__or__space__doublequote_point_doublequote__gt_": { + "type": "object", + "properties": { + "pay_method": { + "oneOf": [ + { + "const": "phone" + }, + { + "const": "kpay" + }, + { + "const": "kakaopay" + }, + { + "const": "payco" + }, + { + "const": "lpay" + }, + { + "const": "ssgpay" + }, + { + "const": "tosspay" + }, + { + "const": "cultureland" + }, + { + "const": "smartculture" + }, + { + "const": "happymoney" + }, + { + "const": "booknlife" + }, + { + "const": "point" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "imp_uid": { + "description": "Identifier key of payment information {@link IIamportPayment}.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "merchant_uid": { + "description": "Order identifier key. Issued and managed by the service that uses it, not the import server..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "name": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Order name, may be missing.", + "x-typia-required": true, + "x-typia-optional": false + }, + "amount": { + "description": "Total payment amount.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancel_amount": { + "description": "Cancellation of payment, total refund amount.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "currency": { + "$ref": "#/components/schemas/IIamportPayment.Currency" + }, + "receipt_url": { + "description": "Receipt URL.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "url" + }, + "cash_receipt_issue": { + "description": "Whether to issue a cash receipt.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "channel": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_provider": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "emb_pg_provider": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "pg_id": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_tid": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "escrow": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "buyer_name": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_email": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "email" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_tel": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_addr": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_postcode": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_uid": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_uid_usage": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "custom_data": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "user_agent": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "status": { + "$ref": "#/components/schemas/IIamportPayment.Status" + }, + "started_at": { + "description": "Payment request date and time. Linux time is used..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "paid_at": { + "description": "The date and time of payment completion. Linux time is used, and 0 is used instead of `null`..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "failed_at": { + "description": "The date and time of the payment failure. Linux time is used, and 0 is used instead of `null`..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancelled_at": { + "description": "The date and time of the cancellation. Linux time is used, and 0 is used instead of `null`..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "fail_reason": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "cancel_reason": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "cancel_history": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/IIamportPaymentCancel" + } + } + }, + "required": [ + "pay_method", + "imp_uid", + "merchant_uid", + "name", + "amount", + "cancel_amount", + "currency", + "receipt_url", + "cash_receipt_issue", + "channel", + "pg_provider", + "emb_pg_provider", + "pg_id", + "pg_tid", + "escrow", + "buyer_name", + "buyer_email", + "buyer_tel", + "buyer_addr", + "buyer_postcode", + "customer_uid", + "customer_uid_usage", + "custom_data", + "user_agent", + "status", + "started_at", + "paid_at", + "failed_at", + "cancelled_at", + "fail_reason", + "cancel_reason", + "cancel_history" + ], + "description": "Payment Basics (Common) Information.", + "x-typia-jsDocTags": [] + }, + "IIamportPaymentCancel.IStore": { + "type": "object", + "properties": { + "imp_uid": { + "description": "Identifier key of payment information {@link IIamportPayment}.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "merchant_uid": { + "description": "Order identifier key. Issued and managed by the service that uses it, not the import server..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "Cancellation amount, partial cancellation is also possible. Full cancellation in case of omission.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "checksum": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + { + "type": "null" + } + ], + "description": "Before performing a cancellation transaction, the current cancelable balance. Verify in advance whether the cancelable balance recorded by the API requester matches the cancelable balance recorded by Import, and if verification fails, the transaction is not performed. If it is `null`, the verification process is skipped..", + "x-typia-required": true, + "x-typia-optional": false + }, + "reason": { + "description": "Reason for cancellation.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "tax_free": { + "description": "Tax-free amount among cancellation request amounts.", + "x-typia-jsDocTags": [ + { + "name": "default", + "text": [ + { + "text": "0", + "kind": "text" + } + ] + } + ], + "x-typia-required": false, + "x-typia-optional": true, + "type": "number", + "default": 0 + }, + "refund_holder": { + "description": "Refund account depositor.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "refund_bank": { + "description": "Refund account bank code.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "refund_account": { + "description": "Refund account account number.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "refund_tel": { + "description": "Refund account depositor contact information", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + } + }, + "required": [ + "imp_uid", + "merchant_uid", + "checksum", + "reason" + ], + "description": "Payment Cancellation Input Information.", + "x-typia-jsDocTags": [] + }, + "IIamportResponse_lt_IIamportReceipt_gt_": { + "type": "object", + "properties": { + "code": { + "description": "Error code. A value of 0 means there is no error..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "message": { + "description": "Success or error message.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/IIamportReceipt" + } + }, + "required": [ + "code", + "message", + "response" + ], + "description": "Import-specific response data.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportReceipt": { + "type": "object", + "properties": { + "imp_uid": { + "description": "{@link IIamportPayment.imp_uid } of the attribution payment.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "receipt_uid": { + "description": "Unique identifier ID of cash receipt.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "apply_num": { + "description": "Approval Number.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/IIamportReceipt.Type" + }, + "amount": { + "description": "Total payment amount.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vat": { + "description": "surtax.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "receipt_url": { + "description": "Cash receipt inquiry URL.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "url" + }, + "applied_at": { + "description": "Cash receipt issuance time.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancelled_at": { + "description": "Cash receipt cancellation time. Linux time is used, and 0 is used instead of `null`..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + } + }, + "required": [ + "imp_uid", + "receipt_uid", + "apply_num", + "type", + "amount", + "vat", + "receipt_url", + "applied_at", + "cancelled_at" + ], + "description": "Cash Receipt Information.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportReceipt.Type": { + "oneOf": [ + { + "const": "person" + }, + { + "const": "company" + } + ], + "description": "Cash receipt issuance type (target)." + }, + "IIamportReceipt.IStore": { + "type": "object", + "properties": { + "imp_uid": { + "description": "{@link IIamportPayment.imp_uid } of the attribution payment.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "identifier": { + "description": "Cash receipt issuance target identification information. - National Tax Service Cash Receipt Card - Mobile phone number - Resident registration number - Business registration number", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "identifier_type": { + "oneOf": [ + { + "const": "phone" + }, + { + "const": "person" + }, + { + "const": "business" + }, + { + "const": "taxcard" + } + ], + "description": "Types of cash receipt issuance targets. - person: Resident registration number - business: Business registration number - phone: Mobile phone number - taxcard: National Tax Service Cash Receipt Card Some PG companies say this item is not required, but if possible, just use it..", + "x-typia-required": false, + "x-typia-optional": true + }, + "type": { + "oneOf": [ + { + "const": "person" + }, + { + "const": "company" + } + ], + "description": "Cash receipt issuance type (target). If omitted, person is used..", + "x-typia-required": false, + "x-typia-optional": true + }, + "buyer_name": { + "description": "Buyer's name. Please enter it if possible for tracking the issuance of the receipt..", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_email": { + "description": "Buyer Email.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_tel": { + "description": "Buyer's phone number. Please enter it if possible for tracking cash receipts..", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "tax_free": { + "description": "Tax-free amount.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + } + }, + "required": [ + "imp_uid", + "identifier" + ], + "description": "Cash receipt input information.", + "x-typia-jsDocTags": [] + }, + "IIamportUser.IAccessor": { + "type": "object", + "properties": { + "imp_key": { + "description": "API Key.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "imp_secret": { + "description": "Secret Key.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "imp_key", + "imp_secret" + ], + "description": "API and secret key provided by Import.", + "x-typia-jsDocTags": [] + }, + "IIamportResponse_lt_IIamportUser_gt_": { + "type": "object", + "properties": { + "code": { + "description": "Error code. A value of 0 means there is no error..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "message": { + "description": "Success or error message.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/IIamportUser" + } + }, + "required": [ + "code", + "message", + "response" + ], + "description": "Import-specific response data.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportUser": { + "type": "object", + "properties": { + "now": { + "description": "Token issuance time.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "expired_at": { + "description": "Token expiration time. It is based on Linux time, and if you want to use it in JS, you need to convert it like this: ```typescript new Date(user.expired_at * 1_000); ```", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "access_token": { + "description": "User authentication token.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "now", + "expired_at", + "access_token" + ], + "description": "Import user authentication information. Import issues API and secret key information, {@link IIamportUser.IAccessor} to clients. However, this cannot be used directly for Import user authentication. A user authentication token must be issued based on the API and secret key. Unfortunately, this user authentication token has an expiration time. `IIamportUser` is a data structure interface that visualizes this user authentication token and its expiration time. In addition, due to the nature of Import's user authentication tokens that have expiration times, it is very difficult to manage them so that their expiration time does not exceed. Therefore, `iamport-server-api` provides the {@link IamportConnector} class, which automatically renews the Import user authentication token whenever it expires..", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportVBankPayment.IStore": { + "type": "object", + "properties": { + "merchant_uid": { + "description": "Order identifier key. Issued and managed by the service that uses it, not the import server..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "total amount.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vbank_code": { + "description": "Virtual account bank code.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "vbank_due": { + "description": "Virtual account deposit deadline, Unix time.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vbank_holder": { + "description": "Depositor.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "name": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_name": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_email": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_tel": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_addr": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_postcode": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "pg": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "notice_url": { + "description": "URL to receive virtual account deposit information. If omitted, use default webhook URL..", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "custom_data": { + "description": "Custom data, freely available.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "pg_api_key": { + "description": "[Inicis only] API values confirmed in the merchant console.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + } + }, + "required": [ + "merchant_uid", + "amount", + "vbank_code", + "vbank_due", + "vbank_holder" + ], + "description": "Virtual account payment input information. You can create a virtual account arbitrarily. However, only some PG companies or `fake-iamport-server` are available. - Settle Bank - Nice Payments - KG Inicis", + "x-typia-jsDocTags": [] + }, + "IIamportResponse_lt_IIamportVBankPayment_gt_": { + "type": "object", + "properties": { + "code": { + "description": "Error code. A value of 0 means there is no error..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "message": { + "description": "Success or error message.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/IIamportVBankPayment" + } + }, + "required": [ + "code", + "message", + "response" + ], + "description": "Import-specific response data.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportVBankPayment.IUpdate": { + "type": "object", + "properties": { + "imp_uid": { + "description": "{@link IIamportPayment.imp_uid } of the target payment record.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "Payment amount to be modified.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "vbank_due": { + "description": "Deadline for depositing virtual account to be modified.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + } + }, + "required": [ + "imp_uid" + ], + "description": "Modification input information for virtual account payment. You can modify the deposit deadline or deposit amount of a virtual account that has not yet been deposited. However, only settlement bank or `fake-iamport-server` is possible..", + "x-typia-jsDocTags": [] + }, + "IIamportResponse_lt_IIamportSubscription_gt_": { + "type": "object", + "properties": { + "code": { + "description": "Error code. A value of 0 means there is no error..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "message": { + "description": "Success or error message.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/IIamportSubscription" + } + }, + "required": [ + "code", + "message", + "response" + ], + "description": "Import-specific response data.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportSubscription": { + "type": "object", + "properties": { + "pg_provider": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_id": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "card_name": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "card_code": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "card_number": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "card_type": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "customer_name": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_tel": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_email": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_addr": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_postcode": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "inserted": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "updated": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "customer_uid": { + "description": "Customer identifier key. An identifier key managed by the service that uses it, not by Aimport. However, it should actually be used as the card identifier key rather than the customer identifier key..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "pg_provider", + "pg_id", + "card_name", + "card_code", + "card_number", + "card_type", + "customer_name", + "customer_tel", + "customer_email", + "customer_addr", + "customer_postcode", + "inserted", + "updated", + "customer_uid" + ], + "description": "Easy Payment Card Information.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportSubscription.IStore": { + "type": "object", + "properties": { + "card_number": { + "description": "Card number. Format: XXXX-XXXX-XXXX-XXXX", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "\\d{4}-\\d{4}-\\d{4}-\\d{4}" + }, + "expiry": { + "description": "Card expiration date. Format: YYYY-MM", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^([0-9]{4})-(0[1-9]|1[012])$" + }, + "birth": { + "description": "Date of birth YYMMDD or 10-digit business registration number.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^(([0-9]{2})(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01]))|(\\d{10})$" + }, + "pwd_2digit": { + "description": "The first two digits of your card password.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "pattern": "\\d{2}" + }, + "cvc": { + "description": "Card authentication number (3 digits on the back of the card).", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "pattern": "\\d{2}" + }, + "customer_name": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customer_tel": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customer_email": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "format": "email" + }, + "customr_addr": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customer_postcode": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customer_uid": { + "description": "Customer identifier key. An identifier key managed by the service that uses it, not by Aimport. However, it should actually be used as the card identifier key rather than the customer identifier key..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "card_number", + "expiry", + "birth", + "customer_uid" + ], + "description": "Easy payment card entry information.", + "x-typia-jsDocTags": [] + }, + "IIamportSubscription.IOnetime": { + "type": "object", + "properties": { + "customer_uid": { + "description": "Customer identifier key. An identifier key managed by the service that uses it, not by Aimport. However, it should actually be used as a card identifier key rather than a customer identifier key. If this is omitted, it will only end in simple payment, and the card information will not be registered for easy payment..", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "card_number": { + "description": "Card number. Format: XXXX-XXXX-XXXX-XXXX", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "\\d{4}-\\d{4}-\\d{4}-\\d{4}" + }, + "expiry": { + "description": "Card expiration date. Format: YYYY-MM", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^([0-9]{4})-(0[1-9]|1[012])$" + }, + "birth": { + "description": "Date of birth YYMMDD or 10-digit business registration number.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^(([0-9]{2})(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01]))|(\\d{10})$" + }, + "pwd_2digit": { + "description": "The first two digits of your card password.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "pattern": "\\d{2}" + }, + "cvc": { + "description": "Card authentication number (3 digits on the back of the card).", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "pattern": "\\d{2}" + }, + "customer_name": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customer_tel": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customer_email": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "format": "email" + }, + "customr_addr": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customer_postcode": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "merchant_uid": { + "description": "Order identifier key. An identifier key managed by the service that uses it, not by Aimport..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "Total payment amount.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "name": { + "description": "Order name.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "currency": { + "oneOf": [ + { + "const": "KRW" + }, + { + "const": "USD" + }, + { + "const": "EUR" + }, + { + "const": "JPY" + } + ], + "description": "Currency Information.", + "x-typia-required": false, + "x-typia-optional": true + }, + "tax_free": { + "description": "Duty-free supply amount. The default value is 0, and VAT is automatically processed as 1/11 of the amount..", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "card_quota": { + "description": "Number of installment months. Lump sum payment is 0.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "buyer_name": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_email": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "format": "email" + }, + "buyer_tel": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_addr": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_postcode": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "interest_free_by_merchant": { + "description": "When processing card installments, if installment interest occurs (excluding card company interest-free promotions), if the merchant has a contract with the PG company to pay the installment interest on behalf of the customer (currently, only Nice Payments is supported)", + "x-typia-required": false, + "x-typia-optional": true, + "type": "boolean" + }, + "use_card_point": { + "description": "Flag whether to deduct card company points and process payment approval when requesting approval. Prior consultation with PG company sales representative is required at the time of contract (currently, only Nice Payments is supported)", + "x-typia-required": false, + "x-typia-optional": true, + "type": "boolean" + }, + "custom_data": { + "description": "You can enter arbitrary information.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "notice_url": { + "description": "Notification and webhook URL to be notified when payment is successful.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "format": "url" + } + }, + "required": [ + "card_number", + "expiry", + "birth", + "merchant_uid", + "amount", + "name" + ], + "description": "Payment application input information.", + "x-typia-jsDocTags": [] + }, + "IIamportResponse_lt_IIamportCardPayment_gt_": { + "type": "object", + "properties": { + "code": { + "description": "Error code. A value of 0 means there is no error..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "message": { + "description": "Success or error message.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/IIamportCardPayment" + } + }, + "required": [ + "code", + "message", + "response" + ], + "description": "Import-specific response data.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportSubscription.IAgain": { + "type": "object", + "properties": { + "merchant_uid": { + "description": "Order identifier key. An identifier key managed by the service that uses it, not by Aimport..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "Total payment amount.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "name": { + "description": "Order name.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "currency": { + "oneOf": [ + { + "const": "KRW" + }, + { + "const": "USD" + }, + { + "const": "EUR" + }, + { + "const": "JPY" + } + ], + "description": "Currency Information.", + "x-typia-required": false, + "x-typia-optional": true + }, + "tax_free": { + "description": "Duty-free supply amount. The default value is 0, and VAT is automatically processed as 1/11 of the amount..", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "card_quota": { + "description": "Number of installment months. Lump sum payment is 0.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "buyer_name": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_email": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "format": "email" + }, + "buyer_tel": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_addr": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_postcode": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "interest_free_by_merchant": { + "description": "When processing card installments, if installment interest occurs (excluding card company interest-free promotions), if the merchant has a contract with the PG company to pay the installment interest on behalf of the customer (currently, only Nice Payments is supported)", + "x-typia-required": false, + "x-typia-optional": true, + "type": "boolean" + }, + "use_card_point": { + "description": "Flag whether to deduct card company points and process payment approval when requesting approval. Prior consultation with PG company sales representative is required at the time of contract (currently, only Nice Payments is supported)", + "x-typia-required": false, + "x-typia-optional": true, + "type": "boolean" + }, + "custom_data": { + "description": "You can enter arbitrary information.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "notice_url": { + "description": "Notification and webhook URL to be notified when payment is successful.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "format": "url" + }, + "customer_uid": { + "description": "Customer identifier key. An identifier key managed by the service that uses it, not by Aimport. However, it should actually be used as the card identifier key rather than the customer identifier key..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "merchant_uid", + "amount", + "name", + "customer_uid" + ], + "description": "Enter information to apply for payment using a simple payment card.", + "x-typia-jsDocTags": [] + } + }, + "securitySchemes": { + "bearer": { + "type": "apiKey", + "name": "Authorization", + "in": "header" + } + } + }, + "x-samchon-emended": true +} \ No newline at end of file diff --git a/assets/output/iamport.swagger.ja.json b/assets/output/iamport.swagger.ja.json new file mode 100644 index 0000000..fe8c7d2 --- /dev/null +++ b/assets/output/iamport.swagger.ja.json @@ -0,0 +1,5056 @@ +{ + "openapi": "3.1.0", + "servers": [ + { + "url": "http://localhost:10851", + "description": "fake" + }, + { + "url": "https://api.iamport.kr", + "description": "real" + } + ], + "info": { + "title": "Iamport API", + "description": "Built by [fake-iamport-server](https://github.com/samchon/fake-iamport-server) with [nestia](https://github.com/samchon/nestia)", + "version": "2.0.1", + "license": { + "name": "MIT" + } + }, + "paths": { + "/certifications/{imp_uid}": { + "get": { + "tags": [], + "parameters": [ + { + "name": "imp_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "ๅฏพ่ฑกๆœฌไบบ่ช่จผๆƒ…ๅ ฑใฎ", + "required": true + } + ], + "responses": { + "200": { + "description": "ๆœฌไบบ่ช่จผๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportCertification_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ๆœฌไบบ่ช่จผๆƒ…ๅ ฑใ‚’่ฆ‹ใ‚‹", + "description": "ๆœฌไบบ่ช่จผๆƒ…ๅ ฑใ‚’้–ฒ่ฆงใ™ใ‚‹ใ€‚ `certiciations.at`ใฏใ€ๆœฌไบบ่ช่จผๆƒ…ๅ ฑใ‚’้–ฒ่ฆงใ™ใ‚‹ใจใใซไฝฟ็”จใ™ใ‚‹API้–ขๆ•ฐใงใ™ใ€‚ใŸใ ใ—ใ€ใ“ใฎAPI้–ขๆ•ฐใ‚’้€šใ˜ใฆ้–ฒ่ฆงใ—ใŸๆœฌไบบ่ช่จผๆƒ…ๅ ฑ{@link IIamportCertification}ใŒใพใ‚‚ใชใOTP่ช่จผใพใง็ต‚ไบ†ใ—ใ€ๆœฌไบบ่ช่จผใ‚’ใ™ในใฆ็ต‚ใˆใŸใƒฌใ‚ณใƒผใƒ‰ใจใ„ใ†ไฟ่จผใฏใชใ„ใ€‚ๆœฌไบบ่ช่จผใŒๅฎŒไบ†ใ™ใ‚‹ใ‹ใฉใ†ใ‹ใฏใ€{@link IIamportCertification.certified}ใฎๅ€คใ‚’็›ดๆŽฅ่ชฟในใฆใฟใ‚‹ใจใ‚ใ‹ใ‚Šใพใ›ใ‚“ใ€‚.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "certifications.at", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "imp_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋Œ€์ƒ ๋ณธ์ธ์ธ์ฆ ์ •๋ณด์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "IIamportCertification.imp_uid", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-iamport-server/src/api/structures/IIamportCertification.ts", + "textSpan": { + "start": 488, + "length": 16 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๋ณธ์ธ์ธ์ฆ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "GET" + }, + "delete": { + "tags": [], + "parameters": [ + { + "name": "imp_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "ๅฏพ่ฑกๆœฌไบบ่ช่จผๆƒ…ๅ ฑใฎ", + "required": true + } + ], + "responses": { + "200": { + "description": "ๅ‰Š้™คใ•ใ‚ŒใŸๆœฌไบบ่ช่จผๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportCertification_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ๆœฌไบบ่ช่จผๆƒ…ๅ ฑใ‚’ๅ‰Š้™คใ™ใ‚‹", + "description": "ๆœฌไบบ่ช่จผๆƒ…ๅ ฑใ‚’ๅ‰Š้™คใ™ใ‚‹.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "certifications.erase", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "imp_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋Œ€์ƒ ๋ณธ์ธ์ธ์ฆ ์ •๋ณด์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "IIamportCertification.imp_uid", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-iamport-server/src/api/structures/IIamportCertification.ts", + "textSpan": { + "start": 488, + "length": 16 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์‚ญ์ œ๋œ ๋ณธ์ธ์ธ์ฆ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "DELETE" + } + }, + "/certifications/otp/request": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "ๆœฌไบบ่ช่จผ่ฆๆฑ‚ๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportCertification.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "้€ฒ่กŒไธญใฎๆœฌไบบ่ช่จผใฎ่ญ˜ๅˆฅๅญๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportCertification.IAccessor_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ๆœฌไบบ่ช่จผใ‚’่ฆๆฑ‚ใ™ใ‚‹", + "description": "ๆœฌไบบ่ช่จผใ‚’่ฆๆฑ‚ใ™ใ‚‹ใ€‚ `certifications.otp.request`ใฏใ€Importใ‚ตใƒผใƒใƒผใซๆœฌไบบ่ช่จผใ‚’่ฆๆฑ‚ใ™ใ‚‹API้–ขๆ•ฐใงใ™ใ€‚ใ“ใฎAPIใ‚’ๅ‘ผใณๅ‡บใ™ใจใ€ๆœฌไบบ่ช่จผๅฏพ่ฑก่€…ใฎๆบๅธฏ้›ป่ฉฑใซOTPๆ–‡ๅญ—ใŒ้€ไฟกใ•ใ‚Œใ€ๆœฌไบบ่ช่จผๅฏพ่ฑก่€…ใŒ{@link certifications.otp.confirm}ใ‚’ไป‹ใ—ใฆใ“ใฎOTP็•ชๅทใ‚’ๆญฃ็ขบใซๅ…ฅๅŠ›ใ™ใ‚‹ใ“ใจใงใ€ๆœฌไบบ่ช่จผใŒๅฎŒไบ†ใ™ใ‚‹ใ€‚ใพใŸใ€ๆœฌไบบ่ช่จผๅฏพ่ฑก่€…ใŒ่‡ชๅˆ†ใฎๆบๅธฏ้›ป่ฉฑใซ้€ไฟกใ•ใ‚ŒใŸOTPๆ–‡ๅญ—ใ‚’ๅ…ฅๅŠ›ใ™ใ‚‹ๅ‰ใงใ‚ใฃใฆใ‚‚ใ€ไพ็„ถใจใ—ใฆๆœฌไบบ่ช่จผๅฑฅๆญดใฏ{@link certifications.at}้–ขๆ•ฐใ‚’้€šใ˜ใฆ็…งไผšใ™ใ‚‹ใ“ใจใŒใงใใ‚‹ใ€‚ใŸใ ใ—ใ€ใ“ใฎใจใใซ่ฟ”ใ•ใ‚Œใ‚‹{@link IIamportCertification}ใง่ช่จผใŒๅฎŒไบ†ใ—ใŸใ‹ใฉใ†ใ‹ใ‚’็คบใ™{@link IIamportCertification.certified}ๅ€คใฏ `false`.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "certifications.otp.request.request", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋ณธ์ธ์ธ์ฆ ์š”์ฒญ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์ง„ํ–‰ ์ค‘์ธ ๋ณธ์ธ์ธ์ฆ์˜ ์‹๋ณ„์ž ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/certifications/otp/confirm/{imp_uid}": { + "post": { + "tags": [], + "parameters": [ + { + "name": "imp_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "ๅฏพ่ฑกๆœฌไบบ่ช่จผๆƒ…ๅ ฑใฎ", + "required": true + } + ], + "requestBody": { + "description": "OTPใ‚ณใƒผใƒ‰", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportCertification.IConfirm" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "่ช่จผๆธˆใฟใฎๆœฌไบบ่ช่จผๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportCertification_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ๆœฌไบบ่ช่จผๆ™‚ใซ็™บ่กŒใ•ใ‚ŒใŸOTPใ‚ณใƒผใƒ‰ใ‚’ๅ…ฅๅŠ›ใ™ใ‚‹", + "description": "ๆœฌไบบ่ช่จผๆ™‚ใซ็™บ่กŒใ•ใ‚ŒใŸOTPใ‚ณใƒผใƒ‰ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚ `certifications.otp.confirm`ใฏ{@link certifications.otp.request}ใ‚’้€šใ˜ใฆ็™บ่กŒใ•ใ‚ŒใŸๆœฌไบบ่ช่จผไปถใซๅฏพใ—ใฆใ€ๆœฌไบบ่ช่จผๅฏพ่ฑก่€…ใฎๆบๅธฏ้›ป่ฉฑใซ้€ไฟกใ•ใ‚ŒใŸOTP็•ชๅทใ‚’ๆคœ่จผใ—ใ€ๅ…ฅๅŠ›ใ—ใŸOTP็•ชๅทใŒๅˆใˆใฐ่ฉฒๅฝ“ๆœฌไบบ่ช่จผใ‚ฌใƒณใ‚’ๆ‰ฟ่ชใ—ใฆๅฎŒไบ†ๅ‡ฆ็†ใ™ใ‚‹API้–ขๆ•ฐใงใ‚ใ‚‹ใ€‚ใ“ใฎใ‚ˆใ†ใซๆœฌไบบ่ช่จผใ‚’ๅฎŒไบ†ใ™ใ‚Œใฐใ€่ฉฒๅฝ“ๆœฌไบบ่ช่จผไปถ{@link IIamportCertification}ใฎ{@link IIamportCertification.certified}ใฎๅ€คใŒๅˆใ‚ใฆ `true` ใซๅค‰ๆ›ดใ•ใ‚Œใ€ๅˆใ‚ใฆๅฎŒ็ตใ™ใ‚‹.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "certifications.otp.confirm.confirm", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "imp_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋Œ€์ƒ ๋ณธ์ธ์ธ์ฆ ์ •๋ณด์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "IIamportCertification.imp_uid", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-iamport-server/src/api/structures/IIamportCertification.ts", + "textSpan": { + "start": 488, + "length": 16 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "OTP ์ฝ”๋“œ", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์ธ์ฆ ์™„๋ฃŒ๋œ ๋ณธ์ธ์ธ์ฆ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/internal/webhook": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "Webใƒ•ใƒƒใ‚ฏใ‚คใƒ™ใƒณใƒˆๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportPayment.IWebhook" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "", + "x-nestia-encrypted": false + } + }, + "summary": "Webใƒ•ใƒƒใ‚ฏใ‚คใƒ™ใƒณใƒˆใƒ€ใƒŸใƒผใƒชใ‚นใƒŠใƒผ", + "description": "Webใƒ•ใƒƒใ‚ฏใ‚คใƒ™ใƒณใƒˆใƒ€ใƒŸใƒผใƒชใ‚นใƒŠใƒผใ€‚ `internal.webhook` ใฏๅฎŸ้š›ใฎใ‚คใƒณใƒใƒผใƒˆใƒใƒผใƒˆใฎใ‚ตใƒผใƒใซใฏๅญ˜ๅœจใ—ใชใ„ API ใงใ€ `fake-impoart-server` ใฎ {@link Configuration.WEBHOOK_URL } ใซไฝ•ใ‚‚ URL ใ‚’่จญๅฎšใ—ใชใ„ใจใ€ `fake-iamport-server` ใ‹ใ‚‰็™บ็”Ÿใ™ใ‚‹ใ‚ใ‚‰ใ‚†ใ‚‹็จฎ้กžใฎใ‚ฆใ‚งใƒ–ใƒ•ใƒƒใ‚ฏใ‚คใƒ™ใƒณใƒˆใฏใ“ใ“ใซไผใˆใ‚‰ใ‚Œใ€็„กๆ„ๅ‘ณใซๆถˆใˆใ‚‹ใ€‚ใ—ใŸใŒใฃใฆใ€ `fake-iamport-server`ใ‚’ไฝฟ็”จใ—ใฆImportใ‚ตใƒผใƒใƒผใจใฎ้€ฃๆบใ‚’ไบ‹ๅ‰ใซๆคœ่จผใ™ใ‚‹ๅ ดๅˆใฏใ€ๅฟ…ใš{@link Configuration.WEBHOOK_URL}ใ‚’่จญๅฎšใ—ใฆWebใƒ•ใƒƒใ‚ฏใ‚คใƒ™ใƒณใƒˆใŒใ‚ใชใŸใฎใƒใƒƒใ‚ฏใ‚จใƒณใƒ‰ใ‚ตใƒผใƒใƒผใซๆญฃใ—ใ้…ไฟกใ•ใ‚Œใ‚‹ใ‚ˆใ†ใซใ—ใพใ—ใ‚‡ใ†ใ€‚.", + "x-nestia-namespace": "internal.webhook.webhook", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์›นํ›… ์ด๋ฒคํŠธ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/internal/deposit/{imp_uid}": { + "get": { + "tags": [], + "parameters": [ + { + "name": "imp_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "ๅฏพ่ฑกๆฑบๆธˆ", + "required": true + } + ], + "responses": { + "200": { + "description": "", + "x-nestia-encrypted": false + } + }, + "summary": "ไปฎๆƒณใ‚ขใ‚ซใ‚ฆใƒณใƒˆใซๅ…ฅ้‡‘ใ™ใ‚‹", + "description": "ไปฎๆƒณๅฃๅบงใซๅ…ฅ้‡‘ใ™ใ‚‹ใ€‚ `internal.deposit`ใฏๅฎŸ้š›ใฎImportๆฑบๆธˆใ‚ตใƒผใƒใซใฏๅญ˜ๅœจใ—ใชใ„APIใงใ€ไปฎๆƒณๅฃๅบงๆฑบๆธˆใ‚’็”ณ่ซ‹ใ—ใŸ้กงๅฎขใŒใ€ใใฎๅพŒไปฎๆƒณๅฃๅบงใซ็›ฎๆจ™้‡‘้กใ‚’ๅ…ฅ้‡‘ใ™ใ‚‹็Šถๆณใ‚’ใ‚ทใƒŸใƒฅใƒฌใƒผใƒˆใงใใ‚‹้–ขๆ•ฐใงใ‚ใ‚‹ใ€‚ใคใพใ‚Šใ€ `internal.deposit` ใฏใ€้กงๅฎขใŒ่‡ชใ‚‰ใซไปฎๆƒณ็š„ใซ็™บ่กŒใ•ใ‚ŒใŸๅฃๅบงใซๅ…ฅ้‡‘ใ‚’่กŒใ„ใ€ใใ‚Œใซๅฟœใ˜ใฆใ‚ขใ‚คใƒ ใƒใƒผใƒˆใ‚ตใƒผใƒใƒผใง webhook ใ‚คใƒ™ใƒณใƒˆใŒ็™บ็”Ÿใ—ใ€ใ“ใ‚Œใ‚’ใ‚ใชใŸใฎใƒใƒƒใ‚ฏใ‚จใƒณใƒ‰ใ‚ตใƒผใƒใƒผใซ้€ไฟกใ™ใ‚‹ไธ€้€ฃใฎ็Šถๆณใ‚’ใ‚ทใƒŸใƒฅใƒฌใƒผใƒˆใ™ใ‚‹ใ‚ˆใ†ใซ่จญ่จˆใ•ใ‚ŒใŸใƒ†ใ‚นใƒˆๆฉŸ่ƒฝใ™ใ‚‹.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "internal.deposit.deposit", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "imp_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋Œ€์ƒ ๊ฒฐ์ œ์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "IIamportVBankPayment.imp_uid ", + "kind": "linkText" + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "GET" + } + }, + "/payments/{imp_uid}": { + "get": { + "tags": [], + "parameters": [ + { + "name": "imp_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "ๅฏพ่ฑกๆฑบๆธˆ่จ˜้Œฒใฎ", + "required": true + }, + { + "name": "query", + "in": "query", + "schema": { + "$ref": "#/components/schemas/IIamportPayment.IQuery" + }, + "description": "ใŠๆ”ฏๆ‰•ใ„ๆ–นๆณ•ใŒPayPalใฎๅ ดๅˆใซไฝฟ็”จ", + "required": true + } + ], + "responses": { + "200": { + "description": "ใŠๆ”ฏๆ‰•ใ„ๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportPayment_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ใŠๆ”ฏๆ‰•ใ„ๅฑฅๆญดใ‚’้–ฒ่ฆงใ™ใ‚‹", + "description": "ใŠๆ”ฏๆ‰•ใ„ๅฑฅๆญดใ‚’้–ฒ่ฆงใ™ใ‚‹ใ€‚ใ‚ขใ‚คใƒ ใƒใƒผใƒˆใ‚’้€šใ˜ใฆ็™บ็”Ÿใ—ใŸๆฑบๆธˆ่จ˜้Œฒใ‚’้–ฒ่ฆงใ™ใ‚‹.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "payments.at", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "imp_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋Œ€์ƒ ๊ฒฐ์ œ ๊ธฐ๋ก์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "IIamportPayment.imp_uid", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-iamport-server/src/api/structures/IIamportPayment.ts", + "textSpan": { + "start": 2339, + "length": 16 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "query", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฒฐ์ œ ์ˆ˜๋‹จ์ด ํŽ˜์ดํŒ”์ธ ๊ฒฝ์šฐ์— ์‚ฌ์šฉ", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "GET" + } + }, + "/payments/cancel": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "ใŠๆ”ฏๆ‰•ใ„ใ‚ญใƒฃใƒณใ‚ปใƒซใฎๅ…ฅๅŠ›ๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportPaymentCancel.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ใ‚ญใƒฃใƒณใ‚ปใƒซใ•ใ‚ŒใŸใŠๆ”ฏๆ‰•ใ„ๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportPayment_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ใŠๆ”ฏๆ‰•ใ„ใ‚’ใ‚ญใƒฃใƒณใ‚ปใƒซใ™ใ‚‹", + "description": "ใŠๆ”ฏๆ‰•ใ„ใ‚’ใ‚ญใƒฃใƒณใ‚ปใƒซใ—ใพใ™ใ€‚ไปฎๆƒณๅฃๅบงใซใ‚ˆใ‚‹ๆฑบๆธˆใงใ‚ใ‚Œใฐใ€ๆ‰•ใ„ๆˆปใ—ๅฃๅบงๆƒ…ๅ ฑใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "payments.cancel.cancel", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฒฐ์ œ ์ทจ์†Œ ์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์ทจ์†Œ๋œ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/receipts/{imp_uid}": { + "get": { + "tags": [], + "parameters": [ + { + "name": "imp_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "ๅธฐๅฑžๆฑบๆธˆ", + "required": true + } + ], + "responses": { + "200": { + "description": "็พ้‡‘้ ˜ๅŽๆ›ธๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportReceipt_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "็พ้‡‘้ ˜ๅŽๆ›ธใ‚’่ฆ‹ใ‚‹", + "description": "็พ้‡‘้ ˜ๅŽๆ›ธใ‚’่ฆ‹ใ‚‹.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "receipts.at", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "imp_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ท€์† ๊ฒฐ์ œ์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "IIamportPayment.imp_uid", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-iamport-server/src/api/structures/IIamportPayment.ts", + "textSpan": { + "start": 2339, + "length": 16 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "GET" + }, + "post": { + "tags": [], + "parameters": [ + { + "name": "imp_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "ๅธฐๅฑžๆฑบๆธˆ", + "required": true + } + ], + "requestBody": { + "description": "็พ้‡‘้ ˜ๅŽๆ›ธๅ…ฅๅŠ›ๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportReceipt.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "็พ้‡‘้ ˜ๅŽๆ›ธๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportReceipt_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "็พ้‡‘้ ˜ๅŽๆ›ธใฎ็™บ่กŒ", + "description": "็พ้‡‘้ ˜ๅŽๆ›ธใฎ็™บ่กŒ.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "receipts.store", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "imp_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ท€์† ๊ฒฐ์ œ์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "IIamportPayment.imp_uid", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-iamport-server/src/api/structures/IIamportPayment.ts", + "textSpan": { + "start": 2339, + "length": 16 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + }, + "delete": { + "tags": [], + "parameters": [ + { + "name": "imp_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "ๅธฐๅฑžๆฑบๆธˆ", + "required": true + } + ], + "responses": { + "200": { + "description": "ใ‚ญใƒฃใƒณใ‚ปใƒซใ•ใ‚ŒใŸ็พ้‡‘้ ˜ๅŽๆ›ธๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportReceipt_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "็พ้‡‘้ ˜ๅŽๆ›ธใ‚’ใ‚ญใƒฃใƒณใ‚ปใƒซใ™ใ‚‹", + "description": "็พ้‡‘้ ˜ๅŽๆ›ธใ‚’ใ‚ญใƒฃใƒณใ‚ปใƒซใ™ใ‚‹.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "receipts.erase", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "imp_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ท€์† ๊ฒฐ์ œ์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "IIamportPayment.imp_uid", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-iamport-server/src/api/structures/IIamportPayment.ts", + "textSpan": { + "start": 2339, + "length": 16 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์ทจ์†Œ๋œ ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "DELETE" + } + }, + "/users/getToken": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "ใ‚ขใ‚คใƒ ใƒใƒผใƒˆใฎAPIใจ็ง˜ๅฏ†้ตๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportUser.IAccessor" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ใƒฆใƒผใ‚ถใƒผ่ช่จผใƒˆใƒผใ‚ฏใƒณๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportUser_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ใƒฆใƒผใ‚ถใƒผ่ช่จผใƒˆใƒผใ‚ฏใƒณใ‚’็™บ่กŒใ™ใ‚‹", + "description": "ใƒฆใƒผใ‚ถใƒผ่ช่จผใƒˆใƒผใ‚ฏใƒณใ‚’็™บ่กŒใ™ใ‚‹ใ€‚ใ‚ขใ‚คใƒ ใƒใƒผใƒˆใซๅŠ ๅ…ฅใ—ใฆไป˜ไธŽใ•ใ‚ŒใŸAPIใŠใ‚ˆใณ็ง˜ๅฏ†้ตใซๅŸบใฅใ„ใฆใ€ใƒฆใƒผใ‚ถใƒผ่ช่จผใƒˆใƒผใ‚ฏใƒณใ‚’็™บ่กŒใ™ใ‚‹ใ€‚ใŸใ ใ—ใ€ImportใŒ็™บ่กŒใ—ใฆใ„ใ‚‹ใƒฆใƒผใ‚ถใƒผ่ช่จผใƒˆใƒผใ‚ฏใƒณใซใฏๆœ‰ๅŠนๆ™‚้–“{@link IIamportUser.expired_at}ใŒใ‚ใ‚Šใ€ใใฎๆ™‚้–“ใŒ้ŽใŽใ‚‹ใจๆœŸ็™บ่กŒใƒˆใƒผใ‚ฏใƒณใŒๆœŸ้™ๅˆ‡ใ‚Œใซใชใ‚Šใ€ใ“ใ‚ŒไปฅไธŠๆ›ธใ่พผใ‚ใชใใชใ‚‹ใ€‚ใใฎใŸใ‚ใ€Importใฎๆ™‚้–“ๅˆถ้™ใซๆ‹˜ๆŸใ•ใ‚ŒใšใซImportใฎAPIใ‚’่‡ช็”ฑใซๅˆฉ็”จใ—ใŸใ„ๅ ดๅˆใฏใ€ `iamport-server-api`ใงๆไพ›ใ•ใ‚Œใฆใ„ใ‚‹{@link IamportConnector}ใ‚’ๆดป็”จใ—ใฆใใ ใ•ใ„ใ€‚.", + "x-nestia-namespace": "users.getToken.getToken", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์•„์ž„ํฌํŠธ์˜ API ๋ฐ secret ํ‚ค ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์œ ์ € ์ธ์ฆ ํ† ํฐ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/vbanks": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "ไปฎๆƒณๅฃๅบงๅ…ฅๅŠ›ๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportVBankPayment.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ไปฎๆƒณใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎใŠๆ”ฏๆ‰•ใ„ๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportVBankPayment_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ไปฎๆƒณใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’็™บ่กŒใ™ใ‚‹", + "description": "ไปฎๆƒณใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’็™บ่กŒใ™ใ‚‹.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "vbanks.store", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฐ€์ƒ ๊ณ„์ขŒ ์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฐ€์ƒ ๊ณ„์ขŒ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + }, + "put": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "ไปฎๆƒณใ‚ขใ‚ซใ‚ฆใƒณใƒˆ็ทจ้›†ๅ…ฅๅŠ›ๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportVBankPayment.IUpdate" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "็ทจ้›†ใ—ใŸไปฎๆƒณใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎใŠๆ”ฏๆ‰•ใ„ๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportVBankPayment_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ไปฎๆƒณใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎ็ทจ้›†", + "description": "ไปฎๆƒณใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎ็ทจ้›†.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "vbanks.update", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฐ€์ƒ ๊ณ„์ขŒ ํŽธ์ง‘ ์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "ํŽธ์ง‘๋œ ๊ฐ€์ƒ ๊ณ„์ขŒ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "PUT" + } + }, + "/subscribe/customers/{customer_uid}": { + "get": { + "tags": [], + "parameters": [ + { + "name": "customer_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "้กงๅฎข๏ผˆ็ฐกๅ˜ๆฑบๆธˆใ‚ซใƒผใƒ‰๏ผ‰่ญ˜ๅˆฅๅญใ‚ญใƒผ", + "required": true + } + ], + "responses": { + "200": { + "description": "็ฐกๅ˜ๆฑบๆธˆใ‚ซใƒผใƒ‰ๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportSubscription_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "็ฐกๅ˜ๆฑบๆธˆใ‚ซใƒผใƒ‰ๆƒ…ๅ ฑใ‚’่ฆ‹ใ‚‹", + "description": "็ฐกๅ˜ๆฑบๆธˆใ‚ซใƒผใƒ‰ๆƒ…ๅ ฑใ‚’่ฆ‹ใ‚‹ใ€‚ `subscribe.customers.at`ใฏใ€้กงๅฎขใŒ{@link store}ใพใŸใฏImportใŒๆไพ›ใ™ใ‚‹็ฐกๅ˜ใชๆ”ฏๆ‰•ใ„ใ‚ซใƒผใƒ‰็™ป้Œฒใ‚ฆใ‚ฃใƒณใƒ‰ใ‚ฆใ‚’ไฝฟ็”จใ—ใฆไฟๅญ˜ใ—ใŸ็ฐกๅ˜ใชๆ”ฏๆ‰•ใ„ใ‚ซใƒผใƒ‰ๆƒ…ๅ ฑใ‚’็…งไผšใ™ใ‚‹API้–ขๆ•ฐใงใ™ใ€‚.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "subscribe.customers.at", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "customer_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ณ ๊ฐ (๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ) ์‹๋ณ„์ž ํ‚ค", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "GET" + }, + "post": { + "tags": [], + "parameters": [ + { + "name": "customer_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "้กงๅฎข๏ผˆ็ฐกๅ˜ๆฑบๆธˆใ‚ซใƒผใƒ‰๏ผ‰่ญ˜ๅˆฅๅญใ‚ญใƒผ", + "required": true + } + ], + "requestBody": { + "description": "ใ‚ซใƒผใƒ‰ๅ…ฅๅŠ›ๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportSubscription.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "็ฐกๅ˜ๆฑบๆธˆใ‚ซใƒผใƒ‰ๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportSubscription_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "็ฐกๅ˜ๆฑบๆธˆใ‚ซใƒผใƒ‰ใ‚’็™ป้Œฒใ™ใ‚‹", + "description": "็ฐกๅ˜ๆฑบๆธˆใ‚ซใƒผใƒ‰ใ‚’็™ป้Œฒใ™ใ‚‹ใ€‚ `subscribe.customers.stoer` ใฏใ€้กงๅฎขใŒ่‡ชๅˆ†ใฎใ‚ซใƒผใƒ‰ใ‚’ใ‚ตใƒผใƒใƒผใซ็™ป้Œฒใ—ใฆใŠใใ€ๆฏŽๅ›žๆฑบๆธˆใŒๅฟ…่ฆใชใจใใฏใ„ใคใงใ‚‚ใ‚ซใƒผใƒ‰ๆƒ…ๅ ฑใ‚’็นฐใ‚Š่ฟ”ใ—ๅ…ฅๅŠ›ใ™ใ‚‹ใ“ใจใชใใ€ๆ‰‹่ปฝใซๆฑบๆธˆใ‚’้€ฒใ‚ใŸใ„ใจใใซไฝฟ็”จใ™ใ‚‹API้–ขๆ•ฐใงใ‚ใ‚‹ใ€‚ใกใชใฟใซใ€ `subscribe.customers.store` ใฏใ€ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚ขใƒ—ใƒชใ‚ฑใƒผใ‚ทใƒงใƒณใŒImportใŒๆไพ›ใ™ใ‚‹็ฐกๅ˜ใชๆฑบๆธˆใ‚ซใƒผใƒ‰็™ป้Œฒใ‚ฆใ‚ฃใƒณใƒ‰ใ‚ฆใ‚’ไฝฟ็”จใ—ใฆใ„ใ‚‹ๅ ดๅˆใ€ใ‚ใชใŸใฎใƒใƒƒใ‚ฏใ‚จใƒณใƒ‰ใ‚ตใƒผใƒใƒผใŒใใ‚Œใ‚’ๅฎŸ้š›ใฎใ‚ตใƒผใƒ“ใ‚นใ‹ใ‚‰ๅ‘ผใณๅ‡บใ™ใ“ใจใฏใ‚ใ‚Šใพใ›ใ‚“ใ€‚ใŸใ ใ—ใ€้กงๅฎขใŒๅฎนๆ˜“ใชๆ”ฏๆ‰•ใ„ใ‚ซใƒผใƒ‰ใ‚’็™ป้Œฒใ™ใ‚‹็Šถๆณใ‚’ใ‚ทใƒŸใƒฅใƒฌใƒผใƒˆใ™ใ‚‹ใŸใ‚ใซใ€ใƒ†ใ‚นใƒˆ่‡ชๅ‹•ๅŒ–ใƒ—ใƒญใ‚ฐใƒฉใƒ ใฎใƒฌใƒ™ใƒซใงไฝฟ็”จใ™ใ‚‹ใ“ใจใŒใงใใ‚‹.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "subscribe.customers.store", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "customer_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ณ ๊ฐ (๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ) ์‹๋ณ„์ž ํ‚ค", + "kind": "text" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์นด๋“œ ์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + }, + "delete": { + "tags": [], + "parameters": [ + { + "name": "customer_uid", + "in": "path", + "schema": { + "type": "string" + }, + "description": "้กงๅฎข๏ผˆ็ฐกๅ˜ๆฑบๆธˆใ‚ซใƒผใƒ‰๏ผ‰่ญ˜ๅˆฅๅญใ‚ญใƒผ", + "required": true + } + ], + "responses": { + "200": { + "description": "ๅ‰Š้™คใ•ใ‚ŒใŸ็ฐกๅ˜ๆฑบๆธˆใ‚ซใƒผใƒ‰ๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportSubscription_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "็ฐกๅ˜ๆฑบๆธˆใ‚ซใƒผใƒ‰ใ‚’ๅ‰Š้™คใ™ใ‚‹", + "description": "็ฐกๅ˜ๆฑบๆธˆใ‚ซใƒผใƒ‰ใ‚’ๅ‰Š้™คใ™ใ‚‹ใ€‚็ฐกๅ˜ๆฑบๆธˆใฎใŸใ‚ใซ็™ป้Œฒใ—ใŸใ‚ซใƒผใƒ‰ใ‚’ๅ–ใ‚Š้™คใ.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "subscribe.customers.erase", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "customer_uid", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ณ ๊ฐ (๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ) ์‹๋ณ„์ž ํ‚ค", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์‚ญ์ œ๋œ ๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "DELETE" + } + }, + "/subscribe/payments/onetime": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "ใ‚ซใƒผใƒ‰ๆฑบๆธˆ็”ณ่ซ‹ๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportSubscription.IOnetime" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ใ‚ซใƒผใƒ‰ๆฑบๆธˆๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportCardPayment_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ใ‚ซใƒผใƒ‰ใงใŠๆ”ฏๆ‰•ใ„ใ„ใŸใ ใใ€็ฐกๅ˜ใŠๆ”ฏๆ‰•ใ„็”จใซ็™ป้Œฒๅฏ่ƒฝ", + "description": "ใ‚ซใƒผใƒ‰ใงใŠๆ”ฏๆ‰•ใ„ใ„ใŸใ ใใ€ๆ‰‹่ปฝใซใŠๆ”ฏๆ‰•ใ„็”จใซ็™ป้Œฒๅฏ่ƒฝใ€‚ `subscribe.payments.onetime`ใฏใ€ใ‚ซใƒผใƒ‰ใ‚’ไป‹ใ—ใŸๆ”ฏๆ‰•ใ„ใ‚’ใ—ใŸใ„ใจใใซๅ‘ผใณๅ‡บใ™API้–ขๆ•ฐใงใ™ใ€‚ใ•ใ‚‰ใซใ€ๅ…ฅๅŠ›ๅ€คใซ{@link IIamportSubscription.IOnetime.customer_uid}ใ‚’่จ˜ๅ…ฅใ™ใ‚‹ๅ ดๅˆใ€ๆฑบๆธˆใซไฝฟ็”จใ—ใŸใ‚ซใƒผใƒ‰ใ‚’ใใฎใพใพ็ฐกๅ˜ๆฑบๆธˆ็”จใ‚ซใƒผใƒ‰{@link IIamportSubscription}ใจใ—ใฆ็™ป้Œฒใ—ใฆใ—ใพใ†ใ€‚ใŸใ ใ—ใ€็ฐกๅ˜ใซ็ฐกๅ˜ใซใ‚ซใƒผใƒ‰็™ป้Œฒใจๆฑบๆธˆใ‚’ใ—ใŸใ„ๅ ดๅˆใฏใ€ `subscribe.payments.onetime`ใซ{@link IIamportSubscription.IOnetime.customer_uid}ใ‚’่ฟฝๅŠ ใ™ใ‚‹ใ‚ˆใ‚Šใ‚‚ใ€{@link subscribe.customers.store}ใจ{@link subscribe.payments .again}ใ‚’ใใ‚Œใžใ‚Œๅ‘ผใณๅ‡บใ™ใ“ใจใ‚’ใŠๅ‹งใ‚ใ—ใพใ™ใ€‚ใใ‚ŒใŒไพ‹ๅค–็š„ใช็Šถๆณใซใ€ใ‚ˆใ‚Šๅฎ‰ๅ…จใซๅฏพๅ‡ฆใงใใ‚‹ใ‹ใ‚‰ใ ใ€‚ใ•ใ‚‰ใซใ€ `subscribe.payments.onetime` ใฏใ€ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚ขใƒ—ใƒชใ‚ฑใƒผใ‚ทใƒงใƒณใŒImportใŒๆไพ›ใ™ใ‚‹ๆ”ฏๆ‰•ใ„ใ‚ฆใ‚ฃใƒณใƒ‰ใ‚ฆใ‚’ใใฎใพใพไฝฟ็”จใ™ใ‚‹ๅ ดๅˆใ€ใ‚ใชใŸใฎใƒใƒƒใ‚ฏใ‚จใƒณใƒ‰ใ‚ตใƒผใƒใƒผใŒใใ‚Œใ‚’ๅฎŸ้š›ใฎใ‚ตใƒผใƒ“ใ‚นใ‹ใ‚‰ๅ‘ผใณๅ‡บใ™ใ“ใจใฏใชใ„ใงใ—ใ‚‡ใ†ใ€‚ใŸใ ใ—ใ€้กงๅฎขใŒใ‚ซใƒผใƒ‰ใ‚’้€šใ—ใฆๆ”ฏๆ‰•ใ†็Šถๆณใ‚’ใ‚ทใƒŸใƒฅใƒฌใƒผใƒˆใ™ใ‚‹ใŸใ‚ใซใ€ใƒ†ใ‚นใƒˆ่‡ชๅ‹•ๅŒ–ใƒ—ใƒญใ‚ฐใƒฉใƒ ใƒฌใƒ™ใƒซใงไฝฟ็”จใ™ใ‚‹ใ“ใจใŒใงใใ‚‹.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "subscribe.payments.onetime.onetime", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์นด๋“œ ๊ฒฐ์ œ ์‹ ์ฒญ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์นด๋“œ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/subscribe/payments/again": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "ใ‚ใ‚‰ใ‹ใ˜ใ‚็™ป้Œฒใ—ใŸใ‚ซใƒผใƒ‰ใ‚’ๅˆฉ็”จใ—ใŸๆฑบๆธˆ็”ณ่ซ‹ๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportSubscription.IAgain" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ใ‚ซใƒผใƒ‰ๆฑบๆธˆๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IIamportResponse_lt_IIamportCardPayment_gt_" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "็ฐกๅ˜ๆฑบๆธˆใซ็™ป้Œฒใ•ใ‚ŒใŸใ‚ซใƒผใƒ‰ใงๆฑบๆธˆใ™ใ‚‹", + "description": "็ฐกๅ˜ๆฑบๆธˆใซ็™ป้Œฒใ•ใ‚ŒใŸใ‚ซใƒผใƒ‰ใงใŠๆ”ฏๆ‰•ใ„ใใ ใ•ใ„ใ€‚ `subscribe.payments.again`ใฏใ€้กงๅฎขใŒ็ฐกๅ˜ใซๆ”ฏๆ‰•ใ„ใซ็™ป้Œฒใ—ใŸใ‚ซใƒผใƒ‰ใงๆ”ฏๆ‰•ใ„ใ‚’้€ฒใ‚ใŸใ„ใจใใซๅ‘ผใณๅ‡บใ™API้–ขๆ•ฐใงใ™ใ€‚ใ“ใ‚Œใฏ็ฐกๅ˜ใงไธไพฟใงใ‚ใ‚Šใ€ๆœฌ่ณช็š„ใซใ‚ซใƒผใƒ‰ๆฑบๆธˆใฎไธ€้ƒจใงใ‚ใ‚‹ใŸใ‚ใ€ๆˆปใ‚Šๅ€คใฏ้€šๅธธใฎใ‚ซใƒผใƒ‰ๆฑบๆธˆใจๅŒใ˜{@link IIamportCardPayment}ใงใ™ใ€‚ใใ—ใฆ`subscribe.payments.again`ใฏๆฑบๆธˆๆ‰‹ๆฎตใฎไธญใงๅ”ฏไธ€ใ€ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚ขใƒ—ใƒชใ‚ฑใƒผใ‚ทใƒงใƒณใŒImportใŒๆไพ›ใ™ใ‚‹ๆฑบๆธˆใ‚ฆใ‚ฃใƒณใƒ‰ใ‚ฆใ‚’ไฝฟ็”จใ™ใ‚‹ใ“ใจใŒใงใใšใ€ใ‚ใชใŸใฎใƒใƒƒใ‚ฏใ‚จใƒณใƒ‰ใ‚ตใƒผใƒใƒผใŒImportใฎAPI้–ขๆ•ฐใ‚’็›ดๆŽฅๅ‘ผใณๅ‡บใ™ๅฟ…่ฆใŒใ‚ใ‚‹ๅ ดๅˆใซ่ฉฒๅฝ“ใ—ใพใ™ใ€‚ใ—ใŸใŒใฃใฆใ€็ฐกๆ˜“ๆฑบๆธˆใซ้–ขใ—ใฆใ‚ขใ‚คใƒ ใƒใƒผใƒˆใ‚ตใƒผใƒใƒผใจ้€ฃๅ‹•ใ™ใ‚‹ใƒใƒƒใ‚ฏใ‚จใƒณใƒ‰ใ‚ตใƒผใƒใƒผใŠใ‚ˆใณใƒ•ใƒญใƒณใƒˆใ‚ขใƒ—ใƒชใ‚ฑใƒผใ‚ทใƒงใƒณใ‚’้–‹็™บใ™ใ‚‹้š›ใซใฏใ€ๅฟ…ใšใ“ใฎ็Šถๆณใซๅฏพใ™ใ‚‹ๅˆฅ้€”ใฎ่จญ่จˆใŠใ‚ˆใณ้–‹็™บใŒๅฟ…่ฆใจใชใ‚Šใพใ™ใฎใงใ€ใ“ใฎ็‚นใ‚’ๅฟต้ ญใซ็ฝฎใ„ใฆใใ ใ•ใ„ใ€‚.", + "security": [ + { + "bearer": [] + } + ], + "x-nestia-namespace": "subscribe.payments.again.again", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋ฏธ๋ฆฌ ๋“ฑ๋กํ•œ ์นด๋“œ๋ฅผ ์ด์šฉํ•œ ๊ฒฐ์ œ ์‹ ์ฒญ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์นด๋“œ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "bearer", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + } + }, + "components": { + "schemas": { + "IIamportResponse_lt_IIamportCertification_gt_": { + "type": "object", + "properties": { + "code": { + "description": "ใ‚จใƒฉใƒผใ‚ณใƒผใƒ‰ใ€‚ๅ€คใŒ0ใฎๅ ดๅˆใ€ใ‚จใƒฉใƒผใŒใชใ„ใ“ใจใ‚’ๆ„ๅ‘ณใ—ใพใ™.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "message": { + "description": "ๆˆๅŠŸใพใŸใฏใ‚จใƒฉใƒผใƒกใƒƒใ‚ปใƒผใ‚ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/IIamportCertification" + } + }, + "required": [ + "code", + "message", + "response" + ], + "description": "ใ‚ขใ‚คใƒ ใƒใƒผใƒˆๅ›บๆœ‰ใฎๅฟœ็ญ”ใƒ‡ใƒผใ‚ฟ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportCertification": { + "type": "object", + "properties": { + "imp_uid": { + "description": "ใ‚ขใ‚คใƒ ใƒใƒผใƒˆใŒ็™บ่กŒใ—ใŸ่ญ˜ๅˆฅๅญ็•ชๅท.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "merchant_uid": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "description": "ใ‚ตใƒผใƒ“ใ‚นใ‹ใ‚‰ใฎ่ญ˜ๅˆฅๅญใ‚ญใƒผใ€‚ใ‚ขใ‚คใƒ ใƒใƒผใƒˆใ‚ตใƒผใƒใƒผใงใฏใชใใ€ใใ‚Œใ‚’ไฝฟ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใŒ็‹ฌ่‡ชใซ็™บ่กŒใ—ใฆ็ฎก็†ใ™ใ‚‹.", + "x-typia-required": true, + "x-typia-optional": false + }, + "name": { + "description": "ๆœฌไบบ่ช่จผๅฏพ่ฑก่€…ใฎๆฐๅ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "gender": { + "description": "ๆ€งๅˆฅ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "birth": { + "description": "็”Ÿๅนดๆœˆๆ—ฅใ€‚ Linuxใ‚ฟใ‚คใƒ ใŒไฝฟใ‚ใ‚Œใ‚‹.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "birthday": { + "description": "็”Ÿๅนดๆœˆๆ—ฅใ€YYYYMMDDๅฝขๅผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^([0-9]{4})(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$" + }, + "foreigner": { + "description": "ๅค–ๅ›ฝไบบใ‹ใฉใ†ใ‹.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "phone": { + "description": "ๆœฌไบบ่ช่จผๅฏพ่ฑก่€…ใฎๆบๅธฏ้›ป่ฉฑ็•ชๅท.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "carrier": { + "oneOf": [ + { + "const": "SKT" + }, + { + "const": "KT" + }, + { + "const": "LGT" + } + ], + "description": "ๆœฌไบบ่ช่จผๅฏพ่ฑก่€…้€šไฟกไบ‹ๆฅญ่€…ใ‚ณใƒผใƒ‰.", + "x-typia-required": true, + "x-typia-optional": false + }, + "certified": { + "description": "OTP่ช่จผใ‹ใฉใ†ใ‹.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "certified_at": { + "description": "OTP่ช่จผๆ—ฅๆ™‚ใ€‚ Linuxใ‚ฟใ‚คใƒ ใŒไฝฟใ‚ใ‚Œใ€ `null`ใฎไปฃใ‚ใ‚Šใซ0ใ‚’่จ€ใ†.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "unique_key": { + "description": "ไฝ•ใ‹ใ‚ˆใๅˆ†ใ‹ใ‚‰ใชใ„ใ€็”จ้€”ใ”ๅญ˜็Ÿฅใฎๆ–น๏ผŸ", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "unique_in_site": { + "description": "ไฝ•ใ‹ใ‚ˆใๅˆ†ใ‹ใ‚‰ใชใ„ใ€็”จ้€”ใ”ๅญ˜็Ÿฅใฎๆ–น๏ผŸ", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_tid": { + "description": "ไฝ•ใ‹ใ‚ˆใๅˆ†ใ‹ใ‚‰ใชใ„ใ€็”จ้€”ใ”ๅญ˜็Ÿฅใฎๆ–น๏ผŸ", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_provider": { + "description": "PGใƒ—ใƒญใƒใ‚คใƒ€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "origin": { + "description": "ไฝ•ใ‹ใ‚ˆใๅˆ†ใ‹ใ‚‰ใชใ„ใ€็”จ้€”ใ”ๅญ˜็Ÿฅใฎๆ–น๏ผŸ", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "__otp": { + "description": "๏ผˆใƒ†ใ‚นใƒˆใฎใฟ๏ผ‰OTPใ‚ณใƒผใƒ‰ใ€‚ `fake-iamport-server`ใงใฎใฟไฝฟใ‚ใ‚Œใ‚‹ๅฑžๆ€งใงใ€ๆœฌไบบ่ช่จผใ‚’ใ‚ทใƒŸใƒฅใƒฌใƒผใƒˆใ™ใ‚‹ใจใใซใ€ใฉใฎOTPใ‚ณใƒผใƒ‰ใŒ็™บ่กŒใ•ใ‚ŒใŸใ‹ใ‚’็ขบ่ชใ™ใ‚‹ใŸใ‚ใซไฝฟ็”จใ•ใ‚Œใ‚‹ใ€‚ใ“ใ‚Œใ‚’ไฝฟ็”จใ—ใฆ{@link functional.certifications.otp.confirm}้–ขๆ•ฐใ‚’ๅ‘ผใณๅ‡บใ™ใจใ€ๆœฌไบบ่ช่จผใ‚’ๅฎŒไบ†ใงใใพใ™ใ€‚.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + } + }, + "required": [ + "imp_uid", + "merchant_uid", + "name", + "gender", + "birth", + "birthday", + "foreigner", + "phone", + "carrier", + "certified", + "certified_at", + "unique_key", + "unique_in_site", + "pg_tid", + "pg_provider", + "origin" + ], + "description": "ๆœฌไบบ่ช่จผๅฑฅๆญดใ€‚ ใ€ŒIIamportCertificationใ€ใฏใ‚ขใ‚คใƒ ใƒใƒผใƒˆใฎๆœฌไบบ่ช่จผๆƒ…ๅ ฑใ‚’ๅฝข่ฑกๅŒ–ใ—ใŸใƒ‡ใƒผใ‚ฟๆง‹้€ ใ‚คใƒณใ‚ฟใƒผใƒ•ใ‚งใƒผใ‚นใงใ‚ใ‚‹ใ€‚ใŸใ ใ—ใ€ใ€ŒIIamportCertificationใ€ใƒฌใ‚ณใƒผใƒ‰ใฎๅญ˜ๅœจใŒใพใ‚‚ใชใๆœฌไบบ่ช่จผใฎๅฎŒ็ตใ‚’ๆ„ๅ‘ณใ™ใ‚‹ใ‚‚ใฎใงใฏใชใ„ใ€‚ {@link IIamportCertification.certified}ๅ€คใŒ `true`ใงใชใ‘ใ‚Œใฐใชใ‚‰ใšใ€ๆœฌไบบ่ช่จผใฎๅฏพ่ฑก่€…ใŒ่‡ชๅˆ†ใฎๆบๅธฏ้›ป่ฉฑ็•ชๅทใซ้€ไฟกใ•ใ‚ŒใŸOTPใ‚’Importใฎๆœฌไบบ่ช่จผใƒใƒƒใƒ—ใ‚ขใƒƒใƒ—ใ‚ฆใ‚ฃใƒณใƒ‰ใ‚ฆใซๆญฃ็ขบใซๆ›ธใ็•™ใ‚ใฆใ€ๆœฌไบบ่ช่จผใ‚’ๅฎŒไบ†ใ—ใŸใ“ใจใ‚’ๆ„ๅ‘ณใ™ใ‚‹.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportCertification.IStore": { + "type": "object", + "properties": { + "name": { + "description": "ๆœฌไบบ่ช่จผๅฏพ่ฑก่€…ใฎๆฐๅ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "phone": { + "description": "ๆœฌไบบ่ช่จผๅฏพ่ฑก่€…ใฎๆบๅธฏ้›ป่ฉฑ็•ชๅทใ€‚ๆบๅธฏ้›ป่ฉฑ็•ชๅทใซใ€Œ-ใ€ๅ€คใŒๅ…ฅใฃใฆใ„ใชใ‹ใฃใŸๆฐ—ใซใ—ใชใ„ใ€‚ใŸใ ใ—ใ€ๅ†…้ƒจ็š„ใซใฏใ€Œ-ใ€ๅ€คใ‚’้™คๅŽปใ—ใฆๅ‡ฆ็†ใ™ใ‚‹.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "birth": { + "description": "็”Ÿๅนดๆœˆๆ—ฅใ€‚ YYYYMMDDๅฝขๅผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^([0-9]{4})(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$" + }, + "gender_digit": { + "description": "ไฝๆฐ‘็™ป้ŒฒใฎๅพŒๅŠใฎๆœ€ๅˆใฎๅธญ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "carrier": { + "oneOf": [ + { + "const": "SKT" + }, + { + "const": "KT" + }, + { + "const": "LGT" + } + ], + "description": "ๆœฌไบบ่ช่จผๅฏพ่ฑก่€…้€šไฟกไบ‹ๆฅญ่€…ใ‚ณใƒผใƒ‰.", + "x-typia-required": true, + "x-typia-optional": false + }, + "is_mvno": { + "description": "ใŠใฃใฑใ„ใ‹ใฉใ†ใ‹.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "boolean" + }, + "commpany": { + "description": "ๅŠ ็›Ÿๅบ—ใ‚ตใƒผใƒ“ใ‚นๅใพใŸใฏใƒ‰ใƒกใ‚คใƒณURLใ€‚ KISAใŒๅฏพ่ฑก่€…ใซ้€ไฟกใ™ใ‚‹SMSใซๆกˆๅ†…ใ•ใ‚Œใ‚‹ใ‚ตใƒผใƒ“ใ‚นๅ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "merchant_uid": { + "description": "ใ‚ใชใŸใฎใ‚ตใƒผใƒ“ใ‚นใฎๆœฌไบบ่ช่จผ่ญ˜ๅˆฅๅญใ‚ญใƒผใ€‚ใ‚ขใ‚คใƒ ใƒใƒผใƒˆใ‚ตใƒผใƒใƒผใงใฏใชใใ€ใใ‚Œใ‚’ไฝฟ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใŒ็‹ฌ่‡ชใซ็™บ่กŒใ—ใฆ็ฎก็†ใ™ใ‚‹.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "pg": { + "description": "PG็คพใฎๅŒบๅˆ‡ใ‚Šๆ–‡ๅญ—ใ€‚ๆฏŽๆ—ฅใฎๅบ—IDใ‚’2ใคไปฅไธŠๅŒๆ™‚ใซไฝฟ็”จใ—ใŸใ„ๅ ดๅˆใซ่จญๅฎšใ™ใ‚Œใฐใ‚ˆใ„ใ€‚ **danal.{ใ‚นใƒˆใ‚ขID}**ใฎๅฝขๅผใงๆŒ‡ๅฎš.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + } + }, + "required": [ + "name", + "phone", + "birth", + "gender_digit", + "carrier" + ], + "description": "ๆœฌไบบ่ช่จผๅ…ฅๅŠ›ๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [] + }, + "IIamportResponse_lt_IIamportCertification.IAccessor_gt_": { + "type": "object", + "properties": { + "code": { + "description": "ใ‚จใƒฉใƒผใ‚ณใƒผใƒ‰ใ€‚ๅ€คใŒ0ใฎๅ ดๅˆใ€ใ‚จใƒฉใƒผใŒใชใ„ใ“ใจใ‚’ๆ„ๅ‘ณใ—ใพใ™.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "message": { + "description": "ๆˆๅŠŸใพใŸใฏใ‚จใƒฉใƒผใƒกใƒƒใ‚ปใƒผใ‚ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/IIamportCertification.IAccessor" + } + }, + "required": [ + "code", + "message", + "response" + ], + "description": "ใ‚ขใ‚คใƒ ใƒใƒผใƒˆๅ›บๆœ‰ใฎๅฟœ็ญ”ใƒ‡ใƒผใ‚ฟ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportCertification.IAccessor": { + "type": "object", + "properties": { + "imp_uid": { + "description": "ๆœฌไบบ่ช่จผๆƒ…ๅ ฑใฎ่ญ˜ๅˆฅๅญใ‚ญใƒผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "imp_uid" + ], + "description": "ๆœฌไบบ่ช่จผๆƒ…ๅ ฑใฎใ‚ขใ‚ฏใ‚ปใ‚ตๆง‹้€ ไฝ“.", + "x-typia-jsDocTags": [] + }, + "IIamportCertification.IConfirm": { + "type": "object", + "properties": { + "otp": { + "description": "SMSใซ้€ไฟกใ•ใ‚ŒใŸๆœฌไบบ่ช่จผ็•ชๅท.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "otp" + ], + "description": "ๆœฌไบบ่ช่จผๆ‰ฟ่ชใฎใŸใ‚ใฎๅ…ฅๅŠ›ๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [] + }, + "IIamportPayment.IWebhook": { + "type": "object", + "properties": { + "imp_uid": { + "description": "ใŠๆ”ฏๆ‰•ใ„ๆƒ…ๅ ฑ{@link IIamportPayment}ใฎ่ญ˜ๅˆฅๅญใ‚ญใƒผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "merchant_uid": { + "description": "ๆณจๆ–‡่ญ˜ๅˆฅๅญใ‚ญใƒผใ€‚ใ‚ขใ‚คใƒ ใƒใƒผใƒˆใ‚ตใƒผใƒใƒผใงใฏใชใใ€ใใ‚Œใ‚’ไฝฟ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใŒ็‹ฌ่‡ชใซ็™บ่กŒใ—ใฆ็ฎก็†ใ™ใ‚‹.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "status": { + "oneOf": [ + { + "const": "paid" + }, + { + "const": "ready" + }, + { + "const": "failed" + }, + { + "const": "cancelled" + } + ], + "description": "็พ็Šถ.", + "x-typia-required": true, + "x-typia-optional": false + } + }, + "required": [ + "imp_uid", + "merchant_uid", + "status" + ], + "description": "ใ‚ฆใ‚งใƒ–ใƒ•ใƒƒใ‚ฏใƒ‡ใƒผใ‚ฟ.", + "x-typia-jsDocTags": [] + }, + "IIamportPayment.IQuery": { + "type": "object", + "properties": { + "extension": { + "description": "Paypalใฎๅ ดๅˆใ€ใ“ใฎๅ€คใ‚’ `true`ใซใ™ใ‚‹ใ“ใจ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "boolean" + } + }, + "description": "ๆฑบๆธˆๆ‰‹ๆฎตใŒPayPalใฎๅ ดๅˆใ€PayPalใฎ่ณผๅ…ฅ่€…ไฟ่ญทๆ”ฟ็ญ–ใซใ‚ˆใ‚Šๆฑบๆธˆๆ‰ฟ่ชๆ™‚็‚นใงPending็Šถๆ…‹ใ‚’ไฝœๆˆใ—ใŸๅพŒใ€ๅ†…้ƒจๅฏฉๆŸป็ญ‰ใ‚’้€šใ˜ใฆๆœ€็ต‚ๆฑบๆธˆๅฎŒไบ†ใจๅค‰ๆ›ดใ™ใ‚‹ใ€‚ `iamport`ใฎๆŠ€่ก“็š„ๅ•้กŒใงใ€ใใฎ็Šถๆ…‹ใ‚’status๏ผšfailedใจใ—ใฆ่จ˜้Œฒใ™ใ‚‹ใ€‚ไปŠๅพŒPayPalใ‹ใ‚‰ๆœ€็ต‚ๆฑบๆธˆๅฎŒไบ†ใซๅค‰ๆ›ดใ•ใ‚ŒใŸๅ ดๅˆใ€ `iamport` ใ‹ใ‚‰ `paid` ใซๅค‰ๆ›ดๅพŒใ€่ฉฒๅฝ“ไปถใซๅฏพใ™ใ‚‹ใ‚ฆใ‚งใƒ–ใƒ•ใƒƒใ‚ฏ็™บ้€ใ€‚ `iamport` ใ‚’ไฝฟ็”จใ™ใ‚‹ใŠๅฎขๆง˜ใงใฏใ€ failed ใงๆ—ขใซๅ‡ฆ็†ใ•ใ‚ŒใŸๆฑบๆธˆไปถใซๅฏพใ—ใฆ paid ็Šถๆ…‹ใฎ Web ใƒ•ใƒƒใ‚ฏใ‚’ๅ—ใ‘ใ‚‹ใจใ„ใ†ๅ•้กŒ็‚นใŒ็”Ÿใ˜ใ‚‹ใ€‚ใใฎใŸใ‚ใ€ `iamport` ใซใ‚ˆใฃใฆๆไพ›ใ•ใ‚Œใ‚‹ `/payment/{imp_uid}` ใซ query-string ใจใ—ใฆ `extension=true` ใ‚ชใƒ—ใ‚ทใƒงใƒณใ‚’่ฟฝๅŠ ใ—ใชใ‘ใ‚Œใฐใชใ‚‰ใชใ„", + "x-typia-jsDocTags": [ + { + "name": "issue", + "text": [ + { + "text": "https://github.com/samchon/fake-iamport-server/issues/13", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Sangjin Han - https://github.com/ltnscp9028", + "kind": "text" + } + ] + } + ] + }, + "IIamportResponse_lt_IIamportPayment_gt_": { + "type": "object", + "properties": { + "code": { + "description": "ใ‚จใƒฉใƒผใ‚ณใƒผใƒ‰ใ€‚ๅ€คใŒ0ใฎๅ ดๅˆใ€ใ‚จใƒฉใƒผใŒใชใ„ใ“ใจใ‚’ๆ„ๅ‘ณใ—ใพใ™.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "message": { + "description": "ๆˆๅŠŸใพใŸใฏใ‚จใƒฉใƒผใƒกใƒƒใ‚ปใƒผใ‚ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/IIamportPayment" + } + }, + "required": [ + "code", + "message", + "response" + ], + "description": "ใ‚ขใ‚คใƒ ใƒใƒผใƒˆๅ›บๆœ‰ใฎๅฟœ็ญ”ใƒ‡ใƒผใ‚ฟ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportPayment": { + "oneOf": [ + { + "$ref": "#/components/schemas/IIamportCardPayment" + }, + { + "$ref": "#/components/schemas/IIamportTransferPayment" + }, + { + "$ref": "#/components/schemas/IIamportVBankPayment" + }, + { + "$ref": "#/components/schemas/IIamportPayment.IBase_lt__doublequote_phone_doublequote__space__or__space__doublequote_kpay_doublequote__space__or__space__doublequote_kakaopay_doublequote__space__or__space__doublequote_payco_doublequote__space__or__space__doublequote_lpay_doublequote__space__or__space__doublequote_ssgpay_doublequote__space__or__space__doublequote_tosspay_doublequote__space__or__space__doublequote_cultureland_doublequote__space__or__space__doublequote_smartculture_doublequote__space__or__space__doublequote_happymoney_doublequote__space__or__space__doublequote_booknlife_doublequote__space__or__space__doublequote_point_doublequote__gt_" + } + ], + "description": "ใŠๆ”ฏๆ‰•ใ„ๆƒ…ๅ ฑใ€ŒIIamportPaymentใ€ใฏใ€Importใฎๆฑบๆธˆๆƒ…ๅ ฑใ‚’ๅฝข็ŠถๅŒ–ใ—ใŸใƒ‡ใƒผใ‚ฟๆง‹้€ ใงใƒฆใƒ‹ใ‚ชใƒณใ‚ฟใ‚คใƒ—ใฎใ‚คใƒณใ‚ฟใƒ•ใ‚งใƒผใ‚นใงใ‚ใ‚Šใ€if conditionใ‚’้€šใ˜ใฆใƒกใ‚ฝใƒƒใƒ‰ๅ€คใ‚’ๆŒ‡ๅฎšใ™ใ‚‹ใจใ€ๆดพ็”Ÿใ‚ฟใ‚คใƒ—ใŒ่‡ชๅ‹•็š„ใซๆŒ‡ๅฎšใ•ใ‚Œใ‚‹ใ€‚ `` typescript if(payment.pay_method === "card") payment.card_number; // payment be IIamportCardPayment ``", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportCardPayment": { + "type": "object", + "properties": { + "card_code": { + "description": "ใ‚ซใƒผใƒ‰่ญ˜ๅˆฅใ‚ณใƒผใƒ‰.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "card_name": { + "description": "ใ‚ซใƒผใƒ‰ๅ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "card_number": { + "description": "ใ‚ซใƒผใƒ‰็•ชๅท.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "\\d{4}-\\d{4}-\\d{4}-\\d{4}" + }, + "card_quota": { + "description": "ๅˆ†ๅ‰ฒๆ‰•ใ„ๆœˆๆ•ฐ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "integer" + }, + "apply_num": { + "description": "ใ‚ซใƒผใƒ‰ไผš็คพๆ‰ฟ่ช็•ชๅท.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pay_method": { + "oneOf": [ + { + "const": "card" + }, + { + "const": "samsung" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "imp_uid": { + "description": "ใŠๆ”ฏๆ‰•ใ„ๆƒ…ๅ ฑ{@link IIamportPayment}ใฎ่ญ˜ๅˆฅๅญใ‚ญใƒผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "merchant_uid": { + "description": "ๆณจๆ–‡่ญ˜ๅˆฅๅญใ‚ญใƒผใ€‚ใ‚ขใ‚คใƒ ใƒใƒผใƒˆใ‚ตใƒผใƒใƒผใงใฏใชใใ€ใใ‚Œใ‚’ไฝฟ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใŒ็‹ฌ่‡ชใซ็™บ่กŒใ—ใฆ็ฎก็†ใ™ใ‚‹.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "name": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "description": "ๆณจๆ–‡ๅใ€ๆฌ ่ฝๅฏ่ƒฝ.", + "x-typia-required": true, + "x-typia-optional": false + }, + "amount": { + "description": "ใŠๆ”ฏๆ‰•ใ„็ท้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancel_amount": { + "description": "ใŠๆ”ฏๆ‰•ใ„ใฎใ‚ญใƒฃใƒณใ‚ปใƒซใ€ๆ‰•ใ„ๆˆปใ—ใฎ็ท้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "currency": { + "$ref": "#/components/schemas/IIamportPayment.Currency" + }, + "receipt_url": { + "description": "้ ˜ๅŽๆ›ธURL.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "url" + }, + "cash_receipt_issue": { + "description": "็พ้‡‘้ ˜ๅŽๆ›ธใฎ็™บ่กŒๅฏๅฆ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "channel": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_provider": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "emb_pg_provider": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "pg_id": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_tid": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "escrow": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "buyer_name": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_email": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "email" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_tel": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_addr": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_postcode": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_uid": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_uid_usage": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "custom_data": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "user_agent": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "status": { + "$ref": "#/components/schemas/IIamportPayment.Status" + }, + "started_at": { + "description": "ๆฑบๆธˆ็”ณ่ซ‹ๆ—ฅๆ™‚ใ€‚ Linuxใ‚ฟใ‚คใƒ ใŒไฝฟ็”จ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "paid_at": { + "description": "ใŠๆ”ฏๆ‰•ใ„๏ผˆใŠๆ”ฏๆ‰•ใ„๏ผ‰ๅฎŒไบ†ๆ—ฅๆ™‚ใ€‚ Linuxใ‚ฟใ‚คใƒ ใŒไฝฟใ‚ใ‚Œใ€ `null`ใฎไปฃใ‚ใ‚Šใซ0ใ‚’่จ€ใ†.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "failed_at": { + "description": "ๆ”ฏๆ‰•ใ„ๅคฑๆ•—ๆ—ฅๆ™‚ใ€‚ Linuxใ‚ฟใ‚คใƒ ใŒไฝฟใ‚ใ‚Œใ€ `null`ใฎไปฃใ‚ใ‚Šใซ0ใ‚’่จ€ใ†.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancelled_at": { + "description": "ใŠๆ”ฏๆ‰•ใ„ใ‚ญใƒฃใƒณใ‚ปใƒซๆ—ฅๆ™‚ใ€‚ Linuxใ‚ฟใ‚คใƒ ใŒไฝฟใ‚ใ‚Œใ€ `null`ใฎไปฃใ‚ใ‚Šใซ0ใ‚’่จ€ใ†.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "fail_reason": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "cancel_reason": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "cancel_history": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/IIamportPaymentCancel" + } + } + }, + "required": [ + "card_code", + "card_name", + "card_number", + "card_quota", + "apply_num", + "pay_method", + "imp_uid", + "merchant_uid", + "name", + "amount", + "cancel_amount", + "currency", + "receipt_url", + "cash_receipt_issue", + "channel", + "pg_provider", + "emb_pg_provider", + "pg_id", + "pg_tid", + "escrow", + "buyer_name", + "buyer_email", + "buyer_tel", + "buyer_addr", + "buyer_postcode", + "customer_uid", + "customer_uid_usage", + "custom_data", + "user_agent", + "status", + "started_at", + "paid_at", + "failed_at", + "cancelled_at", + "fail_reason", + "cancel_reason", + "cancel_history" + ], + "description": "ใ‚ซใƒผใƒ‰ๆฑบๆธˆๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportPayment.Currency": { + "oneOf": [ + { + "const": "KRW" + }, + { + "const": "USD" + }, + { + "const": "EUR" + }, + { + "const": "JPY" + } + ] + }, + "IIamportPayment.Status": { + "oneOf": [ + { + "const": "paid" + }, + { + "const": "ready" + }, + { + "const": "failed" + }, + { + "const": "cancelled" + } + ] + }, + "IIamportPaymentCancel": { + "type": "object", + "properties": { + "pg_id": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_tid": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancelled_at": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "reason": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "receipt_url": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "url" + } + }, + "required": [ + "pg_id", + "pg_tid", + "amount", + "cancelled_at", + "reason", + "receipt_url" + ], + "description": "ใŠๆ”ฏๆ‰•ใ„ใ‚ญใƒฃใƒณใ‚ปใƒซใซใคใ„ใฆ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportTransferPayment": { + "type": "object", + "properties": { + "bank_code": { + "description": "้Š€่กŒ่ญ˜ๅˆฅใ‚ณใƒผใƒ‰.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "bank_name": { + "description": "้Š€่กŒๅ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pay_method": { + "const": "trans", + "x-typia-required": true, + "x-typia-optional": false + }, + "imp_uid": { + "description": "ใŠๆ”ฏๆ‰•ใ„ๆƒ…ๅ ฑ{@link IIamportPayment}ใฎ่ญ˜ๅˆฅๅญใ‚ญใƒผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "merchant_uid": { + "description": "ๆณจๆ–‡่ญ˜ๅˆฅๅญใ‚ญใƒผใ€‚ใ‚ขใ‚คใƒ ใƒใƒผใƒˆใ‚ตใƒผใƒใƒผใงใฏใชใใ€ใใ‚Œใ‚’ไฝฟ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใŒ็‹ฌ่‡ชใซ็™บ่กŒใ—ใฆ็ฎก็†ใ™ใ‚‹.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "name": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "description": "ๆณจๆ–‡ๅใ€ๆฌ ่ฝๅฏ่ƒฝ.", + "x-typia-required": true, + "x-typia-optional": false + }, + "amount": { + "description": "ใŠๆ”ฏๆ‰•ใ„็ท้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancel_amount": { + "description": "ใŠๆ”ฏๆ‰•ใ„ใฎใ‚ญใƒฃใƒณใ‚ปใƒซใ€ๆ‰•ใ„ๆˆปใ—ใฎ็ท้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "currency": { + "$ref": "#/components/schemas/IIamportPayment.Currency" + }, + "receipt_url": { + "description": "้ ˜ๅŽๆ›ธURL.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "url" + }, + "cash_receipt_issue": { + "description": "็พ้‡‘้ ˜ๅŽๆ›ธใฎ็™บ่กŒๅฏๅฆ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "channel": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_provider": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "emb_pg_provider": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "pg_id": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_tid": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "escrow": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "buyer_name": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_email": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "email" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_tel": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_addr": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_postcode": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_uid": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_uid_usage": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "custom_data": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "user_agent": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "status": { + "$ref": "#/components/schemas/IIamportPayment.Status" + }, + "started_at": { + "description": "ๆฑบๆธˆ็”ณ่ซ‹ๆ—ฅๆ™‚ใ€‚ Linuxใ‚ฟใ‚คใƒ ใŒไฝฟ็”จ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "paid_at": { + "description": "ใŠๆ”ฏๆ‰•ใ„๏ผˆใŠๆ”ฏๆ‰•ใ„๏ผ‰ๅฎŒไบ†ๆ—ฅๆ™‚ใ€‚ Linuxใ‚ฟใ‚คใƒ ใŒไฝฟใ‚ใ‚Œใ€ `null`ใฎไปฃใ‚ใ‚Šใซ0ใ‚’่จ€ใ†.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "failed_at": { + "description": "ๆ”ฏๆ‰•ใ„ๅคฑๆ•—ๆ—ฅๆ™‚ใ€‚ Linuxใ‚ฟใ‚คใƒ ใŒไฝฟใ‚ใ‚Œใ€ `null`ใฎไปฃใ‚ใ‚Šใซ0ใ‚’่จ€ใ†.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancelled_at": { + "description": "ใŠๆ”ฏๆ‰•ใ„ใ‚ญใƒฃใƒณใ‚ปใƒซๆ—ฅๆ™‚ใ€‚ Linuxใ‚ฟใ‚คใƒ ใŒไฝฟใ‚ใ‚Œใ€ `null`ใฎไปฃใ‚ใ‚Šใซ0ใ‚’่จ€ใ†.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "fail_reason": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "cancel_reason": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "cancel_history": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/IIamportPaymentCancel" + } + } + }, + "required": [ + "bank_code", + "bank_name", + "pay_method", + "imp_uid", + "merchant_uid", + "name", + "amount", + "cancel_amount", + "currency", + "receipt_url", + "cash_receipt_issue", + "channel", + "pg_provider", + "emb_pg_provider", + "pg_id", + "pg_tid", + "escrow", + "buyer_name", + "buyer_email", + "buyer_tel", + "buyer_addr", + "buyer_postcode", + "customer_uid", + "customer_uid_usage", + "custom_data", + "user_agent", + "status", + "started_at", + "paid_at", + "failed_at", + "cancelled_at", + "fail_reason", + "cancel_reason", + "cancel_history" + ], + "description": "ๅฃๅบงๆŒฏๆ›ฟๆฑบๆธˆๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportVBankPayment": { + "type": "object", + "properties": { + "vbank_code": { + "description": "ไปฎๆƒณใ‚ขใ‚ซใ‚ฆใƒณใƒˆ่ญ˜ๅˆฅๅญใ‚ณใƒผใƒ‰.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "vbank_name": { + "description": "ไปฎๆƒณใ‚ฒใƒผใ‚ธๅ", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "vbank_num": { + "description": "ไปฎๆƒณๅฃๅบง็•ชๅท", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "vbank_holder": { + "description": "ไปฎๆƒณๅฃๅบง้ ้‡‘ๆ ชๅผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "vbank_date": { + "description": "ไปฎๆƒณๅฃๅบงๅ…ฅ้‡‘ใฎๆœ‰ๅŠนๆœŸ้™.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vbank_issued_at": { + "description": "ไปฎๆƒณๅฃๅบง้–‹่จญๆ—ฅๆ™‚.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "pay_method": { + "const": "vbank", + "x-typia-required": true, + "x-typia-optional": false + }, + "imp_uid": { + "description": "ใŠๆ”ฏๆ‰•ใ„ๆƒ…ๅ ฑ{@link IIamportPayment}ใฎ่ญ˜ๅˆฅๅญใ‚ญใƒผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "merchant_uid": { + "description": "ๆณจๆ–‡่ญ˜ๅˆฅๅญใ‚ญใƒผใ€‚ใ‚ขใ‚คใƒ ใƒใƒผใƒˆใ‚ตใƒผใƒใƒผใงใฏใชใใ€ใใ‚Œใ‚’ไฝฟ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใŒ็‹ฌ่‡ชใซ็™บ่กŒใ—ใฆ็ฎก็†ใ™ใ‚‹.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "name": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "description": "ๆณจๆ–‡ๅใ€ๆฌ ่ฝๅฏ่ƒฝ.", + "x-typia-required": true, + "x-typia-optional": false + }, + "amount": { + "description": "ใŠๆ”ฏๆ‰•ใ„็ท้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancel_amount": { + "description": "ใŠๆ”ฏๆ‰•ใ„ใฎใ‚ญใƒฃใƒณใ‚ปใƒซใ€ๆ‰•ใ„ๆˆปใ—ใฎ็ท้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "currency": { + "$ref": "#/components/schemas/IIamportPayment.Currency" + }, + "receipt_url": { + "description": "้ ˜ๅŽๆ›ธURL.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "url" + }, + "cash_receipt_issue": { + "description": "็พ้‡‘้ ˜ๅŽๆ›ธใฎ็™บ่กŒๅฏๅฆ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "channel": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_provider": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "emb_pg_provider": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "pg_id": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_tid": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "escrow": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "buyer_name": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_email": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "email" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_tel": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_addr": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_postcode": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_uid": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_uid_usage": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "custom_data": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "user_agent": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "status": { + "$ref": "#/components/schemas/IIamportPayment.Status" + }, + "started_at": { + "description": "ๆฑบๆธˆ็”ณ่ซ‹ๆ—ฅๆ™‚ใ€‚ Linuxใ‚ฟใ‚คใƒ ใŒไฝฟ็”จ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "paid_at": { + "description": "ใŠๆ”ฏๆ‰•ใ„๏ผˆใŠๆ”ฏๆ‰•ใ„๏ผ‰ๅฎŒไบ†ๆ—ฅๆ™‚ใ€‚ Linuxใ‚ฟใ‚คใƒ ใŒไฝฟใ‚ใ‚Œใ€ `null`ใฎไปฃใ‚ใ‚Šใซ0ใ‚’่จ€ใ†.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "failed_at": { + "description": "ๆ”ฏๆ‰•ใ„ๅคฑๆ•—ๆ—ฅๆ™‚ใ€‚ Linuxใ‚ฟใ‚คใƒ ใŒไฝฟใ‚ใ‚Œใ€ `null`ใฎไปฃใ‚ใ‚Šใซ0ใ‚’่จ€ใ†.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancelled_at": { + "description": "ใŠๆ”ฏๆ‰•ใ„ใ‚ญใƒฃใƒณใ‚ปใƒซๆ—ฅๆ™‚ใ€‚ Linuxใ‚ฟใ‚คใƒ ใŒไฝฟใ‚ใ‚Œใ€ `null`ใฎไปฃใ‚ใ‚Šใซ0ใ‚’่จ€ใ†.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "fail_reason": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "cancel_reason": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "cancel_history": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/IIamportPaymentCancel" + } + } + }, + "required": [ + "vbank_code", + "vbank_name", + "vbank_num", + "vbank_holder", + "vbank_date", + "vbank_issued_at", + "pay_method", + "imp_uid", + "merchant_uid", + "name", + "amount", + "cancel_amount", + "currency", + "receipt_url", + "cash_receipt_issue", + "channel", + "pg_provider", + "emb_pg_provider", + "pg_id", + "pg_tid", + "escrow", + "buyer_name", + "buyer_email", + "buyer_tel", + "buyer_addr", + "buyer_postcode", + "customer_uid", + "customer_uid_usage", + "custom_data", + "user_agent", + "status", + "started_at", + "paid_at", + "failed_at", + "cancelled_at", + "fail_reason", + "cancel_reason", + "cancel_history" + ], + "description": "ไปฎๆƒณใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎใŠๆ”ฏๆ‰•ใ„ๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportPayment.IBase_lt__doublequote_phone_doublequote__space__or__space__doublequote_kpay_doublequote__space__or__space__doublequote_kakaopay_doublequote__space__or__space__doublequote_payco_doublequote__space__or__space__doublequote_lpay_doublequote__space__or__space__doublequote_ssgpay_doublequote__space__or__space__doublequote_tosspay_doublequote__space__or__space__doublequote_cultureland_doublequote__space__or__space__doublequote_smartculture_doublequote__space__or__space__doublequote_happymoney_doublequote__space__or__space__doublequote_booknlife_doublequote__space__or__space__doublequote_point_doublequote__gt_": { + "type": "object", + "properties": { + "pay_method": { + "oneOf": [ + { + "const": "phone" + }, + { + "const": "kpay" + }, + { + "const": "kakaopay" + }, + { + "const": "payco" + }, + { + "const": "lpay" + }, + { + "const": "ssgpay" + }, + { + "const": "tosspay" + }, + { + "const": "cultureland" + }, + { + "const": "smartculture" + }, + { + "const": "happymoney" + }, + { + "const": "booknlife" + }, + { + "const": "point" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "imp_uid": { + "description": "ใŠๆ”ฏๆ‰•ใ„ๆƒ…ๅ ฑ{@link IIamportPayment}ใฎ่ญ˜ๅˆฅๅญใ‚ญใƒผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "merchant_uid": { + "description": "ๆณจๆ–‡่ญ˜ๅˆฅๅญใ‚ญใƒผใ€‚ใ‚ขใ‚คใƒ ใƒใƒผใƒˆใ‚ตใƒผใƒใƒผใงใฏใชใใ€ใใ‚Œใ‚’ไฝฟ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใŒ็‹ฌ่‡ชใซ็™บ่กŒใ—ใฆ็ฎก็†ใ™ใ‚‹.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "name": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "description": "ๆณจๆ–‡ๅใ€ๆฌ ่ฝๅฏ่ƒฝ.", + "x-typia-required": true, + "x-typia-optional": false + }, + "amount": { + "description": "ใŠๆ”ฏๆ‰•ใ„็ท้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancel_amount": { + "description": "ใŠๆ”ฏๆ‰•ใ„ใฎใ‚ญใƒฃใƒณใ‚ปใƒซใ€ๆ‰•ใ„ๆˆปใ—ใฎ็ท้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "currency": { + "$ref": "#/components/schemas/IIamportPayment.Currency" + }, + "receipt_url": { + "description": "้ ˜ๅŽๆ›ธURL.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "url" + }, + "cash_receipt_issue": { + "description": "็พ้‡‘้ ˜ๅŽๆ›ธใฎ็™บ่กŒๅฏๅฆ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "channel": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_provider": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "emb_pg_provider": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "pg_id": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_tid": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "escrow": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "buyer_name": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_email": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "email" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_tel": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_addr": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "buyer_postcode": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_uid": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_uid_usage": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "custom_data": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "user_agent": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "status": { + "$ref": "#/components/schemas/IIamportPayment.Status" + }, + "started_at": { + "description": "ๆฑบๆธˆ็”ณ่ซ‹ๆ—ฅๆ™‚ใ€‚ Linuxใ‚ฟใ‚คใƒ ใŒไฝฟ็”จ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "paid_at": { + "description": "ใŠๆ”ฏๆ‰•ใ„๏ผˆใŠๆ”ฏๆ‰•ใ„๏ผ‰ๅฎŒไบ†ๆ—ฅๆ™‚ใ€‚ Linuxใ‚ฟใ‚คใƒ ใŒไฝฟใ‚ใ‚Œใ€ `null`ใฎไปฃใ‚ใ‚Šใซ0ใ‚’่จ€ใ†.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "failed_at": { + "description": "ๆ”ฏๆ‰•ใ„ๅคฑๆ•—ๆ—ฅๆ™‚ใ€‚ Linuxใ‚ฟใ‚คใƒ ใŒไฝฟใ‚ใ‚Œใ€ `null`ใฎไปฃใ‚ใ‚Šใซ0ใ‚’่จ€ใ†.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancelled_at": { + "description": "ใŠๆ”ฏๆ‰•ใ„ใ‚ญใƒฃใƒณใ‚ปใƒซๆ—ฅๆ™‚ใ€‚ Linuxใ‚ฟใ‚คใƒ ใŒไฝฟใ‚ใ‚Œใ€ `null`ใฎไปฃใ‚ใ‚Šใซ0ใ‚’่จ€ใ†.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "fail_reason": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "cancel_reason": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "cancel_history": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/IIamportPaymentCancel" + } + } + }, + "required": [ + "pay_method", + "imp_uid", + "merchant_uid", + "name", + "amount", + "cancel_amount", + "currency", + "receipt_url", + "cash_receipt_issue", + "channel", + "pg_provider", + "emb_pg_provider", + "pg_id", + "pg_tid", + "escrow", + "buyer_name", + "buyer_email", + "buyer_tel", + "buyer_addr", + "buyer_postcode", + "customer_uid", + "customer_uid_usage", + "custom_data", + "user_agent", + "status", + "started_at", + "paid_at", + "failed_at", + "cancelled_at", + "fail_reason", + "cancel_reason", + "cancel_history" + ], + "description": "ใŠๆ”ฏๆ‰•ใ„ๅŸบๆœฌ๏ผˆๅ…ฑ้€š๏ผ‰ๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [] + }, + "IIamportPaymentCancel.IStore": { + "type": "object", + "properties": { + "imp_uid": { + "description": "ใŠๆ”ฏๆ‰•ใ„ๆƒ…ๅ ฑ{@link IIamportPayment}ใฎ่ญ˜ๅˆฅๅญใ‚ญใƒผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "merchant_uid": { + "description": "ๆณจๆ–‡่ญ˜ๅˆฅๅญใ‚ญใƒผใ€‚ใ‚ขใ‚คใƒ ใƒใƒผใƒˆใ‚ตใƒผใƒใƒผใงใฏใชใใ€ใใ‚Œใ‚’ไฝฟ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใŒ็‹ฌ่‡ชใซ็™บ่กŒใ—ใฆ็ฎก็†ใ™ใ‚‹.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "ใ‚ญใƒฃใƒณใ‚ปใƒซ้‡‘้กใ€้ƒจๅˆ†ใ‚ญใƒฃใƒณใ‚ปใƒซใ‚‚ๅฏ่ƒฝใงใ™ใ€‚ๆฌ ่ฝๆ™‚ใฎๅ…จ้กใ‚ญใƒฃใƒณใ‚ปใƒซ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "checksum": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + { + "type": "null" + } + ], + "description": "ใ‚ญใƒฃใƒณใ‚ปใƒซใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚’ๅฎŸ่กŒใ™ใ‚‹ๅ‰ใซใ€็พๅœจใฎๆ™‚็‚นใงใ‚ญใƒฃใƒณใ‚ปใƒซๅฏ่ƒฝใชๆฎ‹้ซ˜ใ€‚ API่ฆๆฑ‚่€…ใŒ่จ˜้Œฒใ—ใฆใ„ใ‚‹ใ‚ญใƒฃใƒณใ‚ปใƒซๅฏ่ƒฝๆฎ‹้ซ˜ใจใ€ImportใŒ่จ˜้Œฒใ—ใฆใ„ใ‚‹ใ‚ญใƒฃใƒณใ‚ปใƒซๅฏ่ƒฝๆฎ‹้ซ˜ใŒไธ€่‡ดใ™ใ‚‹ใ‹ใฉใ†ใ‹ใ‚’ไบ‹ๅ‰ใซๆคœ่จผใ—ใ€ๆคœ่จผใซๅคฑๆ•—ใ—ใŸๅ ดๅˆใฏใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณใ‚’ๅฎŸ่กŒใ—ใพใ›ใ‚“ใ€‚ `null`ใฎๅ ดๅˆใฏๆคœ่จผใƒ—ใƒญใ‚ปใ‚นใ‚’็œ็•ฅ.", + "x-typia-required": true, + "x-typia-optional": false + }, + "reason": { + "description": "ใ‚ญใƒฃใƒณใ‚ปใƒซ็†็”ฑ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "tax_free": { + "description": "ใ‚ญใƒฃใƒณใ‚ปใƒซ่ฆๆฑ‚้‡‘้กใฎใ†ใกๅ…็จŽ้‡‘้ก.", + "x-typia-jsDocTags": [ + { + "name": "default", + "text": [ + { + "text": "0", + "kind": "text" + } + ] + } + ], + "x-typia-required": false, + "x-typia-optional": true, + "type": "number", + "default": 0 + }, + "refund_holder": { + "description": "ๆ‰•ใ„ๆˆปใ—ๅฃๅบง้ ้‡‘ๆ ชๅผ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "refund_bank": { + "description": "ๆ‰•ใ„ๆˆปใ—ๅฃๅบง้Š€่กŒใ‚ณใƒผใƒ‰.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "refund_account": { + "description": "ๆ‰•ใ„ๆˆปใ—ๅฃๅบงๅฃๅบง็•ชๅท.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "refund_tel": { + "description": "ๆ‰•ใ„ๆˆปใ—ๅฃๅบง้ ้‡‘ๆ ชๅผ้€ฃ็ตกๅ…ˆ", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + } + }, + "required": [ + "imp_uid", + "merchant_uid", + "checksum", + "reason" + ], + "description": "ใŠๆ”ฏๆ‰•ใ„ใ‚ญใƒฃใƒณใ‚ปใƒซใฎๅ…ฅๅŠ›ๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [] + }, + "IIamportResponse_lt_IIamportReceipt_gt_": { + "type": "object", + "properties": { + "code": { + "description": "ใ‚จใƒฉใƒผใ‚ณใƒผใƒ‰ใ€‚ๅ€คใŒ0ใฎๅ ดๅˆใ€ใ‚จใƒฉใƒผใŒใชใ„ใ“ใจใ‚’ๆ„ๅ‘ณใ—ใพใ™.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "message": { + "description": "ๆˆๅŠŸใพใŸใฏใ‚จใƒฉใƒผใƒกใƒƒใ‚ปใƒผใ‚ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/IIamportReceipt" + } + }, + "required": [ + "code", + "message", + "response" + ], + "description": "ใ‚ขใ‚คใƒ ใƒใƒผใƒˆๅ›บๆœ‰ใฎๅฟœ็ญ”ใƒ‡ใƒผใ‚ฟ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportReceipt": { + "type": "object", + "properties": { + "imp_uid": { + "description": "ๅธฐๅฑž่ซ‹ๆฑ‚ใฎ{@link IIamportPayment.imp_uid}.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "receipt_uid": { + "description": "็พ้‡‘้ ˜ๅŽๆ›ธใฎไธ€ๆ„ใฎ่ญ˜ๅˆฅๅญID.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "apply_num": { + "description": "ๆ‰ฟ่ช็•ชๅท.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/IIamportReceipt.Type" + }, + "amount": { + "description": "ใŠๆ”ฏๆ‰•ใ„็ท้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vat": { + "description": "ไป˜ๅŠ ไพกๅ€ค็จŽ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "receipt_url": { + "description": "็พ้‡‘้ ˜ๅŽๆ›ธๆคœ็ดขURL.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "url" + }, + "applied_at": { + "description": "็พ้‡‘้ ˜ๅŽๆ›ธ็™บ่กŒๆ™‚้–“.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancelled_at": { + "description": "็พ้‡‘้ ˜ๅŽๆ›ธใฎใ‚ญใƒฃใƒณใ‚ปใƒซๆ™‚้–“ใ€‚ Linuxใ‚ฟใ‚คใƒ ใŒไฝฟใ‚ใ‚Œใ€ `null`ใฎไปฃใ‚ใ‚Šใซ0ใ‚’่จ€ใ†.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + } + }, + "required": [ + "imp_uid", + "receipt_uid", + "apply_num", + "type", + "amount", + "vat", + "receipt_url", + "applied_at", + "cancelled_at" + ], + "description": "็พ้‡‘้ ˜ๅŽๆ›ธๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportReceipt.Type": { + "oneOf": [ + { + "const": "person" + }, + { + "const": "company" + } + ], + "description": "็พ้‡‘้ ˜ๅŽๆ›ธ็™บ่กŒใ‚ฟใ‚คใƒ—๏ผˆๅฏพ่ฑก๏ผ‰." + }, + "IIamportReceipt.IStore": { + "type": "object", + "properties": { + "imp_uid": { + "description": "ๅธฐๅฑž่ซ‹ๆฑ‚ใฎ{@link IIamportPayment.imp_uid}.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "identifier": { + "description": "็พ้‡‘้ ˜ๅŽๆ›ธใฎ็™บ็”Ÿๅฏพ่ฑก่ญ˜ๅˆฅๆƒ…ๅ ฑใ€‚ - ๅ›ฝ็จŽๅบ็พ้‡‘้ ˜ๅŽ่จผใ‚ซใƒผใƒ‰ - ๆบๅธฏ้›ป่ฉฑ็•ชๅท - ไฝๆฐ‘็™ป้Œฒ็•ชๅท - ไบ‹ๆฅญ่€…็™ป้Œฒ็•ชๅท", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "identifier_type": { + "oneOf": [ + { + "const": "phone" + }, + { + "const": "person" + }, + { + "const": "business" + }, + { + "const": "taxcard" + } + ], + "description": "็พ้‡‘้ ˜ๅŽๆ›ธ็™บ่กŒๅฏพ่ฑกใ‚ฟใ‚คใƒ—ใ€‚ - person : ไฝๆฐ‘็™ป้Œฒ็•ชๅท.", + "x-typia-required": false, + "x-typia-optional": true + }, + "type": { + "oneOf": [ + { + "const": "person" + }, + { + "const": "company" + } + ], + "description": "็พ้‡‘้ ˜ๅŽๆ›ธ็™บ่กŒใ‚ฟใ‚คใƒ—๏ผˆๅฏพ่ฑก๏ผ‰ใ€‚่กŒๆ–นไธๆ˜Žใฎๅ ดๅˆใซ person ใŒไฝฟ็”จใ•ใ‚Œใ‚‹.", + "x-typia-required": false, + "x-typia-optional": true + }, + "buyer_name": { + "description": "ใƒใ‚คใƒคใƒผๅใ€‚้‡‘้Šญ้ ˜ๅŽๆ›ธ็™บ่กŒไปถไบ‹ๅพŒ่ฟฝ่ทกใฎใŸใ‚ใซใชใ‚‹ในใๅ…ฅๅŠ›ใ™ใ‚‹.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_email": { + "description": "่ณผๅ…ฅ่€…ใฎใƒกใƒผใƒซ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_tel": { + "description": "ใƒใ‚คใƒคใƒผใฎ้›ป่ฉฑ็•ชๅทใ€‚็พ้‡‘้ ˜ๅŽๆ›ธ็™บ่กŒไปถไบ‹ๅพŒ่ฟฝ่ทกใฎใŸใ‚ใซใชใ‚‹ในใๅ…ฅๅŠ›ใ™ใ‚‹.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "tax_free": { + "description": "ๅ…็จŽ้ก.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + } + }, + "required": [ + "imp_uid", + "identifier" + ], + "description": "็พ้‡‘้ ˜ๅŽๆ›ธใฎๅ…ฅๅŠ›ๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [] + }, + "IIamportUser.IAccessor": { + "type": "object", + "properties": { + "imp_key": { + "description": "APIใ‚ญใƒผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "imp_secret": { + "description": "Secret ใ‚ญใƒผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "imp_key", + "imp_secret" + ], + "description": "IMPORTใŒไป˜ไธŽใ—ใŸAPIใจ็ง˜ๅฏ†้ต.", + "x-typia-jsDocTags": [] + }, + "IIamportResponse_lt_IIamportUser_gt_": { + "type": "object", + "properties": { + "code": { + "description": "ใ‚จใƒฉใƒผใ‚ณใƒผใƒ‰ใ€‚ๅ€คใŒ0ใฎๅ ดๅˆใ€ใ‚จใƒฉใƒผใŒใชใ„ใ“ใจใ‚’ๆ„ๅ‘ณใ—ใพใ™.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "message": { + "description": "ๆˆๅŠŸใพใŸใฏใ‚จใƒฉใƒผใƒกใƒƒใ‚ปใƒผใ‚ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/IIamportUser" + } + }, + "required": [ + "code", + "message", + "response" + ], + "description": "ใ‚ขใ‚คใƒ ใƒใƒผใƒˆๅ›บๆœ‰ใฎๅฟœ็ญ”ใƒ‡ใƒผใ‚ฟ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportUser": { + "type": "object", + "properties": { + "now": { + "description": "ใƒˆใƒผใ‚ฏใƒณ็™บ่กŒๆ™‚้–“.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "expired_at": { + "description": "ใƒˆใƒผใ‚ฏใƒณใฎๆœ‰ๅŠนๆœŸ้™ใ€‚ Linuxใ‚ฟใ‚คใƒ ใŒๅŸบๆบ–ใงใ‚ใ‚Šใ€ใ“ใ‚Œใ‚’JSใงไฝฟ็”จใ—ใ‚ˆใ†ใจใ™ใ‚Œใฐใ€ไปฅไธ‹ใฎใ‚ˆใ†ใซๅค‰ๆ›ใ—ใชใ‘ใ‚Œใฐใชใ‚‰ใชใ„ใ€‚ `` typescript new Date๏ผˆuser.expired_at * 1_000๏ผ‰; ใ€Œใ€", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "access_token": { + "description": "ใƒฆใƒผใ‚ถใƒผ่ช่จผใƒˆใƒผใ‚ฏใƒณ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "now", + "expired_at", + "access_token" + ], + "description": "ใ‚คใƒณใƒใƒผใƒˆใƒใƒผใƒˆใƒฆใƒผใ‚ถใƒผ่ช่จผๆƒ…ๅ ฑใ€‚ IMPORTใฏ้กงๅฎขใซAPIใจ็ง˜ๅฏ†้ตๆƒ…ๅ ฑใ€{@link IIamportUser.IAccessor}ใ‚’็™บ่กŒใ—ใพใ™ใ€‚ใ—ใ‹ใ—ใ€ใ“ใ‚Œใ‚’ใพใ‚‚ใชใใ‚ขใ‚คใƒ ใƒใƒผใƒˆใฎใƒฆใƒผใ‚ถใƒผ่ช่จผใซไฝฟ็”จใ™ใ‚‹ใ“ใจใฏใงใใšใ€ใใฎAPIใŠใ‚ˆใณ็ง˜ๅฏ†้ตใซๅŸบใฅใ„ใฆใƒฆใƒผใ‚ถใƒผ่ช่จผใƒˆใƒผใ‚ฏใƒณใ‚’็™บ่กŒใ™ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚ ใ€ŒIIamportUserใ€ใฏใ€ใ“ใฎใ‚ˆใ†ใชใƒฆใƒผใ‚ถใƒผ่ช่จผใƒˆใƒผใ‚ฏใƒณใจใใฎๆœ‰ๅŠนๆœŸ้™ใ‚’ๅฝข่ฑกๅŒ–ใ—ใŸใƒ‡ใƒผใ‚ฟๆง‹้€ ใ‚คใƒณใ‚ฟใƒผใƒ•ใ‚งใƒผใ‚นใงใ™ใ€‚ใ•ใ‚‰ใซใ€ใ“ใฎใ‚ˆใ†ใซๆœ‰ๅŠนๆœŸ้™ใŒๅญ˜ๅœจใ™ใ‚‹ใ‚ขใ‚คใƒ ใƒใƒผใƒˆใฎใƒฆใƒผใ‚ถ่ช่จผใƒˆใƒผใ‚ฏใƒณใฎ็‰นๆ€งไธŠใ€ใ“ใ‚Œใฎๆœ‰ๅŠนๆœŸ้™ใŒ่ถ…้Žใ—ใชใ„ใ‚ˆใ†ใซ็ฎก็†ใ™ใ‚‹ใ“ใจใฏ้žๅธธใซ้›ฃใ—ใ„ใ“ใจใงใ‚ใ‚‹ใ€‚ใ“ใ‚Œใซใ‚ˆใ‚Šใ€ `iamport-server-api` ใฏใ€Import ใƒฆใƒผใ‚ถ่ช่จผใƒˆใƒผใ‚ฏใƒณใŒๆœŸ้™ๅˆ‡ใ‚Œใซใชใ‚‹ใŸใณใซ่‡ชๅ‹•ๆ›ดๆ–ฐใ™ใ‚‹ใ€{@link IamportConnector } ใ‚ฏใƒฉใ‚นใ‚’ๆไพ›ใ™ใ‚‹.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportVBankPayment.IStore": { + "type": "object", + "properties": { + "merchant_uid": { + "description": "ๆณจๆ–‡่ญ˜ๅˆฅๅญใ‚ญใƒผใ€‚ใ‚ขใ‚คใƒ ใƒใƒผใƒˆใ‚ตใƒผใƒใƒผใงใฏใชใใ€ใใ‚Œใ‚’ไฝฟ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใŒ็‹ฌ่‡ชใซ็™บ่กŒใ—ใฆ็ฎก็†ใ™ใ‚‹.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "็ท้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vbank_code": { + "description": "ไปฎๆƒณๅฃๅบง้Š€่กŒใ‚ณใƒผใƒ‰.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "vbank_due": { + "description": "ไปฎๆƒณๅฃๅบงๅ…ฅ้‡‘ๆœŸ้™ใ€UNIXใ‚ฟใ‚คใƒ .", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vbank_holder": { + "description": "้ ้‡‘ๆ ช.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "name": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_name": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_email": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_tel": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_addr": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_postcode": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "pg": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "notice_url": { + "description": "ไปฎๆƒณใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎๅ…ฅ้‡‘ๆƒ…ๅ ฑใ‚’ๅ—ใ‘ๅ–ใ‚‹URLใ€‚ๆฌ ่ฝๆ™‚ใซใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใฎWebใƒ•ใƒƒใ‚ฏURLใ‚’ไฝฟ็”จใ™ใ‚‹.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "custom_data": { + "description": "ใ‚ซใ‚นใ‚ฟใƒ ใƒ‡ใƒผใ‚ฟใ€่‡ช็”ฑใซๅˆฉ็”จๅฏ่ƒฝ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "pg_api_key": { + "description": "[ใ‚คใƒ‹ใ‚ทใ‚นใฎใฟ]ๅŠ ็›Ÿๅบ—ใ‚ณใƒณใ‚ฝใƒผใƒซใง็ขบ่ชใ—ใŸAPIๅ€ค.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + } + }, + "required": [ + "merchant_uid", + "amount", + "vbank_code", + "vbank_due", + "vbank_holder" + ], + "description": "ไปฎๆƒณๅฃๅบงๆฑบๆธˆๅ…ฅๅŠ›ๆƒ…ๅ ฑใ€‚ไปฎๆƒณใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’ไปปๆ„ใซไฝœๆˆใงใใพใ™ใ€‚ใŸใ ใ—ใ€ไธ€้ƒจใฎPG็คพใพใŸใฏใ€Œfake-iamport-serverใ€ใฎใฟๅฏ่ƒฝใ€‚ - ใ‚ปใƒˆใƒซใƒใƒณใ‚ฏ - ใƒŠใ‚คใ‚นใƒšใ‚คใƒกใƒณใƒ„ - KGใ‚คใƒ‹ใ‚ทใ‚น", + "x-typia-jsDocTags": [] + }, + "IIamportResponse_lt_IIamportVBankPayment_gt_": { + "type": "object", + "properties": { + "code": { + "description": "ใ‚จใƒฉใƒผใ‚ณใƒผใƒ‰ใ€‚ๅ€คใŒ0ใฎๅ ดๅˆใ€ใ‚จใƒฉใƒผใŒใชใ„ใ“ใจใ‚’ๆ„ๅ‘ณใ—ใพใ™.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "message": { + "description": "ๆˆๅŠŸใพใŸใฏใ‚จใƒฉใƒผใƒกใƒƒใ‚ปใƒผใ‚ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/IIamportVBankPayment" + } + }, + "required": [ + "code", + "message", + "response" + ], + "description": "ใ‚ขใ‚คใƒ ใƒใƒผใƒˆๅ›บๆœ‰ใฎๅฟœ็ญ”ใƒ‡ใƒผใ‚ฟ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportVBankPayment.IUpdate": { + "type": "object", + "properties": { + "imp_uid": { + "description": "ๅฏพ่ฑกใฎใŠๆ”ฏๆ‰•ใ„ๅฑฅๆญดใฎ{@link IIamportPayment.imp_uid}.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "็ทจ้›†ใ™ใ‚‹ใŠๆ”ฏๆ‰•ใ„้ก.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "vbank_due": { + "description": "ๅค‰ๆ›ดใ™ใ‚‹ไปฎๆƒณใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎๅ…ฅ้‡‘ๆœŸ้™.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + } + }, + "required": [ + "imp_uid" + ], + "description": "ไปฎๆƒณๅฃๅบงๆฑบๆธˆใฎไฟฎๆญฃๅ…ฅๅŠ›ๆƒ…ๅ ฑใ€‚ใพใ ๅ…ฅ้‡‘ใ•ใ‚Œใฆใ„ใชใ„ไปฎๆƒณๅฃๅบงใฎๅ…ฅ้‡‘ๆœŸ้™ใพใŸใฏๅ…ฅ้‡‘้‡‘้กใ‚’ไฟฎๆญฃใ™ใ‚‹ใ“ใจใŒใงใใ‚‹ใ€‚ใŸใ ใ—ใ€ใ‚ปใƒˆใƒซใƒใƒณใ‚ฏใพใŸใฏ `fake-iamport-server`ใฎใฟๅฏ่ƒฝ.", + "x-typia-jsDocTags": [] + }, + "IIamportResponse_lt_IIamportSubscription_gt_": { + "type": "object", + "properties": { + "code": { + "description": "ใ‚จใƒฉใƒผใ‚ณใƒผใƒ‰ใ€‚ๅ€คใŒ0ใฎๅ ดๅˆใ€ใ‚จใƒฉใƒผใŒใชใ„ใ“ใจใ‚’ๆ„ๅ‘ณใ—ใพใ™.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "message": { + "description": "ๆˆๅŠŸใพใŸใฏใ‚จใƒฉใƒผใƒกใƒƒใ‚ปใƒผใ‚ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/IIamportSubscription" + } + }, + "required": [ + "code", + "message", + "response" + ], + "description": "ใ‚ขใ‚คใƒ ใƒใƒผใƒˆๅ›บๆœ‰ใฎๅฟœ็ญ”ใƒ‡ใƒผใ‚ฟ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportSubscription": { + "type": "object", + "properties": { + "pg_provider": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "pg_id": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "card_name": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "card_code": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "card_number": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "card_type": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "customer_name": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_tel": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_email": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_addr": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "customer_postcode": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + { + "type": "null" + } + ], + "x-typia-required": true, + "x-typia-optional": false + }, + "inserted": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "updated": { + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "customer_uid": { + "description": "้กงๅฎข่ญ˜ๅˆฅๅญใ‚ญใƒผใ€‚ใ‚คใƒณใƒใƒผใƒˆใƒใƒผใƒˆใงใฏใชใใ€ใใ‚Œใ‚’ๅˆฉ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใง็‹ฌ่‡ชใซ็ฎก็†ใ™ใ‚‹่ญ˜ๅˆฅๅญใ‚ญใƒผใ€‚ใŸใ ใ—ใ€้กงๅฎขใจใ„ใ†ใ‚ˆใ‚ŠใฏๅฎŸ้š›ใซใฏใ‚ซใƒผใƒ‰ใฎ่ญ˜ๅˆฅๅญใ‚ญใƒผใงๆ›ธใ‹ใชใ‘ใ‚Œใฐใชใ‚‰ใชใ„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "pg_provider", + "pg_id", + "card_name", + "card_code", + "card_number", + "card_type", + "customer_name", + "customer_tel", + "customer_email", + "customer_addr", + "customer_postcode", + "inserted", + "updated", + "customer_uid" + ], + "description": "็ฐกๅ˜ๆฑบๆธˆใ‚ซใƒผใƒ‰ๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportSubscription.IStore": { + "type": "object", + "properties": { + "card_number": { + "description": "ใ‚ซใƒผใƒ‰็•ชๅทใ€‚ใƒ•ใ‚ฉใƒผใƒžใƒƒใƒˆ: XXXX-XXXX-XXXX-XXXX", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "\\d{4}-\\d{4}-\\d{4}-\\d{4}" + }, + "expiry": { + "description": "ใ‚ซใƒผใƒ‰ใฎๆœ‰ๅŠนๆœŸ้–“ใ€‚ใƒ•ใ‚ฉใƒผใƒžใƒƒใƒˆ: YYYY-MM", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^([0-9]{4})-(0[1-9]|1[012])$" + }, + "birth": { + "description": "็”Ÿๅนดๆœˆๆ—ฅYYMMDDใพใŸใฏไบ‹ๆฅญ่€…็™ป้Œฒ็•ชๅท10ๆก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^(([0-9]{2})(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01]))|(\\d{10})$" + }, + "pwd_2digit": { + "description": "ใ‚ซใƒผใƒ‰ใƒ‘ใ‚นใƒฏใƒผใƒ‰ใฎๅ‰ใฎ2ๆก.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "pattern": "\\d{2}" + }, + "cvc": { + "description": "ใ‚ซใƒผใƒ‰่ช่จผ็•ชๅท๏ผˆใ‚ซใƒผใƒ‰่ฃ้ข3ๆก๏ผ‰.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "pattern": "\\d{2}" + }, + "customer_name": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customer_tel": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customer_email": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "format": "email" + }, + "customr_addr": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customer_postcode": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customer_uid": { + "description": "้กงๅฎข่ญ˜ๅˆฅๅญใ‚ญใƒผใ€‚ใ‚คใƒณใƒใƒผใƒˆใƒใƒผใƒˆใงใฏใชใใ€ใใ‚Œใ‚’ๅˆฉ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใง็‹ฌ่‡ชใซ็ฎก็†ใ™ใ‚‹่ญ˜ๅˆฅๅญใ‚ญใƒผใ€‚ใŸใ ใ—ใ€้กงๅฎขใจใ„ใ†ใ‚ˆใ‚ŠใฏๅฎŸ้š›ใซใฏใ‚ซใƒผใƒ‰ใฎ่ญ˜ๅˆฅๅญใ‚ญใƒผใงๆ›ธใ‹ใชใ‘ใ‚Œใฐใชใ‚‰ใชใ„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "card_number", + "expiry", + "birth", + "customer_uid" + ], + "description": "็ฐกๅ˜ๆฑบๆธˆใ‚ซใƒผใƒ‰ๅ…ฅๅŠ›ๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [] + }, + "IIamportSubscription.IOnetime": { + "type": "object", + "properties": { + "customer_uid": { + "description": "้กงๅฎข่ญ˜ๅˆฅๅญใ‚ญใƒผใ€‚ใ‚คใƒณใƒใƒผใƒˆใƒใƒผใƒˆใงใฏใชใใ€ใใ‚Œใ‚’ๅˆฉ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใง็‹ฌ่‡ชใซ็ฎก็†ใ™ใ‚‹่ญ˜ๅˆฅๅญใ‚ญใƒผใ€‚ใŸใ ใ—ใ€้กงๅฎขใจใ„ใ†ใ‚ˆใ‚ŠใฏๅฎŸ้š›ใซใฏใ‚ซใƒผใƒ‰ใฎ่ญ˜ๅˆฅๅญใ‚ญใƒผใงๆ›ธใ‹ใชใ‘ใ‚Œใฐใชใ‚‰ใชใ„ใ€‚ใ“ใ‚Œใ‚’็œ็•ฅใ—ใŸๅ ดๅˆใฏ็ฐกๅ˜ใชๆฑบๆธˆใงใฎใฟ็ต‚ไบ†ใ—ใ€ใ‚ซใƒผใƒ‰ๆƒ…ๅ ฑใฏ็ฐกๅ˜ใชๆฑบๆธˆ็”จใซ็™ป้Œฒใ•ใ‚Œใพใ›ใ‚“ใ€‚.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "card_number": { + "description": "ใ‚ซใƒผใƒ‰็•ชๅทใ€‚ใƒ•ใ‚ฉใƒผใƒžใƒƒใƒˆ: XXXX-XXXX-XXXX-XXXX", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "\\d{4}-\\d{4}-\\d{4}-\\d{4}" + }, + "expiry": { + "description": "ใ‚ซใƒผใƒ‰ใฎๆœ‰ๅŠนๆœŸ้–“ใ€‚ใƒ•ใ‚ฉใƒผใƒžใƒƒใƒˆ: YYYY-MM", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^([0-9]{4})-(0[1-9]|1[012])$" + }, + "birth": { + "description": "็”Ÿๅนดๆœˆๆ—ฅYYMMDDใพใŸใฏไบ‹ๆฅญ่€…็™ป้Œฒ็•ชๅท10ๆก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^(([0-9]{2})(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01]))|(\\d{10})$" + }, + "pwd_2digit": { + "description": "ใ‚ซใƒผใƒ‰ใƒ‘ใ‚นใƒฏใƒผใƒ‰ใฎๅ‰ใฎ2ๆก.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "pattern": "\\d{2}" + }, + "cvc": { + "description": "ใ‚ซใƒผใƒ‰่ช่จผ็•ชๅท๏ผˆใ‚ซใƒผใƒ‰่ฃ้ข3ๆก๏ผ‰.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "pattern": "\\d{2}" + }, + "customer_name": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customer_tel": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customer_email": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "format": "email" + }, + "customr_addr": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customer_postcode": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "merchant_uid": { + "description": "ๆณจๆ–‡่ญ˜ๅˆฅๅญใ‚ญใƒผใ€‚ใƒใƒผใƒˆไปฅๅค–ใฎใ‚ตใƒผใƒ“ใ‚นใ‚’ไฝฟ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใซใ‚ˆใฃใฆ็‹ฌ่‡ชใซ็ฎก็†ใ•ใ‚Œใ‚‹่ญ˜ๅˆฅๅญใ‚ญใƒผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "ใŠๆ”ฏๆ‰•ใ„็ท้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "name": { + "description": "ๆณจๆ–‡ๅ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "currency": { + "oneOf": [ + { + "const": "KRW" + }, + { + "const": "USD" + }, + { + "const": "EUR" + }, + { + "const": "JPY" + } + ], + "description": "้€š่ฉฑๆƒ…ๅ ฑ.", + "x-typia-required": false, + "x-typia-optional": true + }, + "tax_free": { + "description": "ๅ…็จŽไพ›็ตฆไพก้กใ€‚ๆ—ขๅฎšๅ€คใฏ 0 ใจใ—ใฆใ€ๅˆ†ใ‹ใฃใฆ amount ใฎ 1/11 ใจใ—ใฆไป˜ๅŠ ็จŽๅ‡ฆ็†ใ•ใ‚Œใ‚‹.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "card_quota": { + "description": "ๅ‰ฒ่ณฆๆœˆๆ•ฐใ€‚ไธ€ๆ™‚ๆ‰•ใ„ใฏ0.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "buyer_name": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_email": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "format": "email" + }, + "buyer_tel": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_addr": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_postcode": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "interest_free_by_merchant": { + "description": "ใ‚ซใƒผใƒ‰ๅˆ†ๅ‰ฒๆ‰•ใ„ๅ‡ฆ็†ใฎ้š›ใ€ๅ‰ฒ่ณฆๅˆฉๅญใŒ็™บ็”Ÿใ™ใ‚‹ๅ ดๅˆ๏ผˆใ‚ซใƒผใƒ‰ไผš็คพ็„กๅˆฉๅญใƒ—ใƒญใƒขใƒผใ‚ทใƒงใƒณใ‚’้™คใ๏ผ‰ใ€‚่ชฒใ•ใ‚Œใ‚‹ๅ‰ฒ่ณฆๅˆฉๅญใ‚’้กงๅฎขใฎไปฃใ‚ใ‚ŠใซๅŠ ็›Ÿๅบ—ใŒๆ”ฏๆ‰•ใ†ใŸใ‚ใซPG็คพใจๅฅ‘็ด„ใ•ใ‚ŒใŸๅ ดๅˆ๏ผˆ็พๅœจใ€ใƒŠใ‚คใ‚นใƒšใƒผใƒกใƒณใƒ„ใฎใฟใ‚ตใƒใƒผใƒˆใ•ใ‚Œใฆใ„ใ‚‹๏ผ‰", + "x-typia-required": false, + "x-typia-optional": true, + "type": "boolean" + }, + "use_card_point": { + "description": "ๆ‰ฟ่ช่ฆๆฑ‚ๆ™‚ใซใ‚ซใƒผใƒ‰ไผš็คพใƒใ‚คใƒณใƒˆใ‚’ๅทฎใ—ๅผ•ใ„ใฆๆฑบๆธˆๆ‰ฟ่ชๅ‡ฆ็†ใ™ใ‚‹ใ‹flagใ€‚ PG็คพๅ–ถๆฅญๆ‹…ๅฝ“่€…ใจๅฅ‘็ด„ๅฝ“ๆ™‚ใ€ไบ‹ๅ‰ๅ”่ญฐใŒๅฟ…่ฆ", + "x-typia-required": false, + "x-typia-optional": true, + "type": "boolean" + }, + "custom_data": { + "description": "ไปปๆ„ๆƒ…ๅ ฑใ‚’่จ˜่ผ‰ใ™ใ‚‹ใ“ใจใŒใงใใ‚‹.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "notice_url": { + "description": "ๆ”ฏๆ‰•ใ„ใŒๆˆๅŠŸใ—ใŸใจใใซ้€š็Ÿฅใ•ใ‚Œใ‚‹้€š็Ÿฅใ€Webใƒ•ใƒƒใ‚ฏURL.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "format": "url" + } + }, + "required": [ + "card_number", + "expiry", + "birth", + "merchant_uid", + "amount", + "name" + ], + "description": "ๆฑบๆธˆ็”ณ่ซ‹ๅ…ฅๅŠ›ๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [] + }, + "IIamportResponse_lt_IIamportCardPayment_gt_": { + "type": "object", + "properties": { + "code": { + "description": "ใ‚จใƒฉใƒผใ‚ณใƒผใƒ‰ใ€‚ๅ€คใŒ0ใฎๅ ดๅˆใ€ใ‚จใƒฉใƒผใŒใชใ„ใ“ใจใ‚’ๆ„ๅ‘ณใ—ใพใ™.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "message": { + "description": "ๆˆๅŠŸใพใŸใฏใ‚จใƒฉใƒผใƒกใƒƒใ‚ปใƒผใ‚ธ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "response": { + "$ref": "#/components/schemas/IIamportCardPayment" + } + }, + "required": [ + "code", + "message", + "response" + ], + "description": "ใ‚ขใ‚คใƒ ใƒใƒผใƒˆๅ›บๆœ‰ใฎๅฟœ็ญ”ใƒ‡ใƒผใ‚ฟ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "IIamportSubscription.IAgain": { + "type": "object", + "properties": { + "merchant_uid": { + "description": "ๆณจๆ–‡่ญ˜ๅˆฅๅญใ‚ญใƒผใ€‚ใƒใƒผใƒˆไปฅๅค–ใฎใ‚ตใƒผใƒ“ใ‚นใ‚’ไฝฟ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใซใ‚ˆใฃใฆ็‹ฌ่‡ชใซ็ฎก็†ใ•ใ‚Œใ‚‹่ญ˜ๅˆฅๅญใ‚ญใƒผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "ใŠๆ”ฏๆ‰•ใ„็ท้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "name": { + "description": "ๆณจๆ–‡ๅ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "currency": { + "oneOf": [ + { + "const": "KRW" + }, + { + "const": "USD" + }, + { + "const": "EUR" + }, + { + "const": "JPY" + } + ], + "description": "้€š่ฉฑๆƒ…ๅ ฑ.", + "x-typia-required": false, + "x-typia-optional": true + }, + "tax_free": { + "description": "ๅ…็จŽไพ›็ตฆไพก้กใ€‚ๆ—ขๅฎšๅ€คใฏ 0 ใจใ—ใฆใ€ๅˆ†ใ‹ใฃใฆ amount ใฎ 1/11 ใจใ—ใฆไป˜ๅŠ ็จŽๅ‡ฆ็†ใ•ใ‚Œใ‚‹.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "card_quota": { + "description": "ๅ‰ฒ่ณฆๆœˆๆ•ฐใ€‚ไธ€ๆ™‚ๆ‰•ใ„ใฏ0.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "buyer_name": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_email": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "format": "email" + }, + "buyer_tel": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_addr": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "buyer_postcode": { + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "interest_free_by_merchant": { + "description": "ใ‚ซใƒผใƒ‰ๅˆ†ๅ‰ฒๆ‰•ใ„ๅ‡ฆ็†ใฎ้š›ใ€ๅ‰ฒ่ณฆๅˆฉๅญใŒ็™บ็”Ÿใ™ใ‚‹ๅ ดๅˆ๏ผˆใ‚ซใƒผใƒ‰ไผš็คพ็„กๅˆฉๅญใƒ—ใƒญใƒขใƒผใ‚ทใƒงใƒณใ‚’้™คใ๏ผ‰ใ€‚่ชฒใ•ใ‚Œใ‚‹ๅ‰ฒ่ณฆๅˆฉๅญใ‚’้กงๅฎขใฎไปฃใ‚ใ‚ŠใซๅŠ ็›Ÿๅบ—ใŒๆ”ฏๆ‰•ใ†ใŸใ‚ใซPG็คพใจๅฅ‘็ด„ใ•ใ‚ŒใŸๅ ดๅˆ๏ผˆ็พๅœจใ€ใƒŠใ‚คใ‚นใƒšใƒผใƒกใƒณใƒ„ใฎใฟใ‚ตใƒใƒผใƒˆใ•ใ‚Œใฆใ„ใ‚‹๏ผ‰", + "x-typia-required": false, + "x-typia-optional": true, + "type": "boolean" + }, + "use_card_point": { + "description": "ๆ‰ฟ่ช่ฆๆฑ‚ๆ™‚ใซใ‚ซใƒผใƒ‰ไผš็คพใƒใ‚คใƒณใƒˆใ‚’ๅทฎใ—ๅผ•ใ„ใฆๆฑบๆธˆๆ‰ฟ่ชๅ‡ฆ็†ใ™ใ‚‹ใ‹flagใ€‚ PG็คพๅ–ถๆฅญๆ‹…ๅฝ“่€…ใจๅฅ‘็ด„ๅฝ“ๆ™‚ใ€ไบ‹ๅ‰ๅ”่ญฐใŒๅฟ…่ฆ", + "x-typia-required": false, + "x-typia-optional": true, + "type": "boolean" + }, + "custom_data": { + "description": "ไปปๆ„ๆƒ…ๅ ฑใ‚’่จ˜่ผ‰ใ™ใ‚‹ใ“ใจใŒใงใใ‚‹.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "notice_url": { + "description": "ๆ”ฏๆ‰•ใ„ใŒๆˆๅŠŸใ—ใŸใจใใซ้€š็Ÿฅใ•ใ‚Œใ‚‹้€š็Ÿฅใ€Webใƒ•ใƒƒใ‚ฏURL.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "format": "url" + }, + "customer_uid": { + "description": "้กงๅฎข่ญ˜ๅˆฅๅญใ‚ญใƒผใ€‚ใ‚คใƒณใƒใƒผใƒˆใƒใƒผใƒˆใงใฏใชใใ€ใใ‚Œใ‚’ๅˆฉ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใง็‹ฌ่‡ชใซ็ฎก็†ใ™ใ‚‹่ญ˜ๅˆฅๅญใ‚ญใƒผใ€‚ใŸใ ใ—ใ€้กงๅฎขใจใ„ใ†ใ‚ˆใ‚ŠใฏๅฎŸ้š›ใซใฏใ‚ซใƒผใƒ‰ใฎ่ญ˜ๅˆฅๅญใ‚ญใƒผใงๆ›ธใ‹ใชใ‘ใ‚Œใฐใชใ‚‰ใชใ„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "merchant_uid", + "amount", + "name", + "customer_uid" + ], + "description": "็ฐกๅ˜ๆฑบๆธˆใ‚ซใƒผใƒ‰ใงๆฑบๆธˆ็”ณ่ซ‹ๅ…ฅๅŠ›ๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [] + } + }, + "securitySchemes": { + "bearer": { + "type": "apiKey", + "name": "Authorization", + "in": "header" + } + } + }, + "x-samchon-emended": true +} \ No newline at end of file diff --git a/assets/output/marketing.swagger.ar.json b/assets/output/marketing.swagger.ar.json index 20ffe8f..3dcc8d0 100644 --- a/assets/output/marketing.swagger.ar.json +++ b/assets/output/marketing.swagger.ar.json @@ -3732,7 +3732,7 @@ } }, "summary": "ุฅุถุงูุฉ ุดุฑุงุฆุญ ุตูˆุฑ ู…ู† ุงู„ู†ูˆุน "ุงู„ุนู…ูˆุฏูŠ" ุฅู„ู‰ ุนุฑุถ ุชู‚ุฏูŠู…ูŠ ููŠ Google Slides", - "description": "ุฅุถุงูุฉ ุดุฑุงุฆุญ ู…ู† ุงู„ู†ูˆุน "ุงู„ุนู…ูˆุฏูŠ" ุฅู„ู‰ ุนุฑุถ ุชู‚ุฏูŠู…ูŠ ุนู„ู‰ Google Slides. ุงู„ู†ูˆุน "ุงู„ุนู…ูˆุฏูŠ" ูŠุดุจู‡ ุงู„ุดุฑูŠุญุฉ ู…ู† ุงู„ู†ูˆุน ุงู„ู…ุฑุจุนุŒ ู…ุน ุตูˆุฑุฉ ุนู„ู‰ ุงู„ูŠุณุงุฑ ูˆู†ุต ุนู„ู‰ ุงู„ูŠู…ูŠู†. ููŠ ู‡ุฐู‡ ุงู„ุญุงู„ุฉุŒ ุนู„ู‰ ุนูƒุณ ุงู„ู†ูˆุน ุงู„ู…ุฑุจุนุŒ ูŠุชู… ู…ู„ุก ุงู„ุตูˆุฑุฉ ุญุชู‰ ุงุฑุชูุงุน ุงู„ุนุฑุถ ุงู„ุชู‚ุฏูŠู…ูŠ ู…ุน ุงู„ุญูุงุธ ุนู„ู‰ ุงู„ู†ุณุจุฉ. ูŠุณู…ุญ ู‡ุฐุง ุฃูŠุถู‹ุง ุจู†ุต ูƒุงูู. ู‚ุฏ ุชุญุชุงุฌ ุฅู„ู‰ ุตูˆุฑุฉ ุนู†ุฏู…ุง ูŠุทู„ุจ ู…ู†ูƒ ุงู„ู…ุณุชุฎุฏู… ุฅุถุงูุฉ ุดุฑูŠุญุฉ. ููŠ ู‡ุฐู‡ ุงู„ุญุงู„ุฉุŒ ุจุฏู„ุงู‹ ู…ู† ุฅุฏุฑุงุฌ ุฃูŠ ุตูˆุฑุฉุŒ ูŠุฌุจ ุนู„ูŠูƒ ุฃูˆู„ุงู‹ ุชุฃู…ูŠู† ุงู„ุตูˆุฑุฉ ุจุงุณุชุฎุฏุงู… ู…ูˆุตู„ ุจุญุซ ุฃูˆ ู…ูˆุตู„ ุฅู†ุดุงุก ุตูˆุฑุฉ. ู…ู† ุงู„ุขู…ู† ุฃู† ุชุทู„ุจ ู…ู† ุงู„ู…ุณุชุฎุฏู… ุงู„ู…ูˆุงูู‚ุฉ ุนู„ู‰ ู‡ุฐู‡ ุงู„ุนู…ู„ูŠุฉ.", + "description": "ุฅุถุงูุฉ ุดุฑุงุฆุญ ู…ู† ุงู„ู†ูˆุน "ุงู„ุนู…ูˆุฏูŠ" ุฅู„ู‰ ุนุฑุถ ุชู‚ุฏูŠู…ูŠ ุนู„ู‰ Google Slides. ุงู„ู†ูˆุน "ุงู„ุนู…ูˆุฏูŠ" ูŠุดุจู‡ ุงู„ุดุฑูŠุญุฉ ู…ู† ุงู„ู†ูˆุน ุงู„ู…ุฑุจุนุŒ ู…ุน ุตูˆุฑุฉ ุนู„ู‰ ุงู„ูŠุณุงุฑ ูˆู†ุต ุนู„ู‰ ุงู„ูŠู…ูŠู†. ููŠ ู‡ุฐู‡ ุงู„ุญุงู„ุฉุŒ ุนู„ู‰ ุนูƒุณ ุงู„ู†ูˆุน ุงู„ู…ุฑุจุนุŒ ูŠุชู… ู…ู„ุก ุงู„ุตูˆุฑุฉ ุญุชู‰ ุงุฑุชูุงุน ุงู„ุนุฑุถ ุงู„ุชู‚ุฏูŠู…ูŠ ู…ุน ุงู„ุญูุงุธ ุนู„ู‰ ุงู„ู†ุณุจุฉ. ูˆู‡ุฐุง ูŠุณู…ุญ ุฃูŠุถู‹ุง ุจุฅุถุงูุฉ ู†ุต ูƒุงูู. ู‚ุฏ ุชุญุชุงุฌ ุฅู„ู‰ ุตูˆุฑุฉ ุนู†ุฏู…ุง ูŠุทู„ุจ ู…ู†ูƒ ุงู„ู…ุณุชุฎุฏู… ุฅุถุงูุฉ ุดุฑูŠุญุฉ. ููŠ ู‡ุฐู‡ ุงู„ุญุงู„ุฉุŒ ุจุฏู„ุงู‹ ู…ู† ุฅุฏุฑุงุฌ ุฃูŠ ุตูˆุฑุฉุŒ ูŠุฌุจ ุนู„ูŠูƒ ุฃูˆู„ุงู‹ ุชุฃู…ูŠู† ุงู„ุตูˆุฑุฉ ุจุงุณุชุฎุฏุงู… ู…ูˆุตู„ ุจุญุซ ุฃูˆ ู…ูˆุตู„ ุฅู†ุดุงุก ุตูˆุฑุฉ. ู…ู† ุงู„ุขู…ู† ุฃู† ุชุทู„ุจ ู…ู† ุงู„ู…ุณุชุฎุฏู… ุงู„ู…ูˆุงูู‚ุฉ ุนู„ู‰ ู‡ุฐู‡ ุงู„ุนู…ู„ูŠุฉ.", "tags": [ "Google Slide" ] @@ -3807,7 +3807,7 @@ } } }, - "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุนุฑุถ ุงู„ุชู‚ุฏูŠู…ูŠ ุงู„ู…ูˆู„ุฏุฉ DTO" + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุนุฑุถ ุงู„ุชู‚ุฏูŠู…ูŠ ุงู„ุชูŠ ุชู… ุฅู†ุดุงุคู‡ุง ุจูˆุงุณุทุฉ DTO" } }, "summary": "ุฅู†ุดุงุก ุนุฑุถ ุชู‚ุฏูŠู…ูŠ ุนู„ู‰ Google Slides", @@ -5593,7 +5593,7 @@ } }, "summary": "ุงุณุชุฑุฌุงุน ู‚ุงุฆู…ุฉ ุฅุนู„ุงู†ุงุช ุงู„ุญู…ู„ุฉ", - "description": "ุงุญุตู„ ุนู„ู‰ ู‚ุงุฆู…ุฉ ุงู„ุฅุนู„ุงู†ุงุช ู…ู† ุญุณุงุจ ุนู…ูŠู„ Google ู…ุฑุฑ `customerId` ุฅู„ู‰ ุงู„ู…ุณุชุฎุฏู… ูˆุงุจุญุซ ุนู† ุงู„ุฅุนู„ุงู†ุงุช (=ad) ููŠ ุญุณุงุจ ุฅุนู„ุงู† ุงู„ุนู…ูŠู„. ุฅุฐุง ู„ู… ูŠุชู… ุชู…ุฑูŠุฑ `customerId`ุŒ ูุณูŠุชู… ุชุญุฏูŠุฏู‡ ุชู„ู‚ุงุฆูŠู‹ุง ูู‚ุท ุฅุฐุง ูƒุงู† ู‡ู†ุงูƒ ุญุณุงุจ ุฅุนู„ุงู† ูˆุงุญุฏ ูู‚ุท ูŠู…ูƒู† ุงู„ูˆุตูˆู„ ุฅู„ูŠู‡ ุจูˆุงุณุทุฉ `Wrtn` ู…ู† ุงู„ู…ุณุชุฎุฏู…. ุงู„ุฅุนู„ุงู† ู‡ูˆ ุนู‚ุฏุฉ ููŠ ู†ู‡ุงูŠุฉ ุจู†ูŠุฉ ุดุฌุฑุฉ ุชุชูƒูˆู† ู…ู† ุงู„ุญู…ู„ุงุช ูˆู…ุฌู…ูˆุนุงุช ุงู„ุฅุนู„ุงู†ุงุช ูˆุงู„ุฅุนู„ุงู†ุงุชุŒ ูˆู‡ูˆ ู‚ุณู… ู…ุณุคูˆู„ ุนู† ุงู„ู…ูˆุงุฏุŒ ูˆู‡ูˆ ุฃูŠุถู‹ุง ูˆุญุฏุฉ ู…ูƒุดูˆูุฉ ู„ู„ู…ุณุชุฎุฏู…ูŠู† ุงู„ู†ู‡ุงุฆูŠูŠู†. ุฅุฐุง ุชู… ุชู…ุฑูŠุฑ ุงุณู… ุงู„ู…ูˆุฑุฏ ู„ู…ุฌู…ูˆุนุฉ ุฅุนู„ุงู†ุงุช (=adGroup) ูƒุญุฌุฉุŒ ูุณูŠุชู… ุงู„ุจุญุซ ุนู† ุงู„ุฅุนู„ุงู†ุงุช ุงู„ุชูŠ ุชู†ุชู…ูŠ ุฅู„ู‰ ู…ุฌู…ูˆุนุฉ ุงู„ุฅุนู„ุงู†ุงุช ู‡ุฐู‡ ูู‚ุท. ุงู„ุบุฑุถ ู…ู† ู‡ุฐุง ุงู„ู…ูˆุตู„ ู‡ูˆ ุชุญุฏูŠุฏ ู…ุง ุฅุฐุง ูƒุงู† ุฅุนู„ุงู† ุงู„ู…ุณุชุฎุฏู… ู‚ูŠุฏ ุงู„ุชุดุบูŠู„ ุญุงู„ูŠู‹ุง ุฃู… ู„ุง. ููŠ ุญุงู„ุฉ ู…ุฏูŠุฑูŠ `Wrtn`ุŒ ู„ุง ูŠุชู… ุชุบูŠูŠุฑ ุงู„ุญู…ู„ุงุช ูˆู…ุฌู…ูˆุนุงุช ุงู„ุฅุนู„ุงู†ุงุช ุฅู„ู‰ ุญุงู„ุฉ `PAUSED` ู…ุง ู„ู… ูŠุบูŠุฑ ุงู„ู…ุณุชุฎุฏู… ุญุงู„ุฉ ุงู„ุญู…ู„ุฉ ูˆู…ุฌู…ูˆุนุฉ ุงู„ุฅุนู„ุงู†ุงุช ู…ุจุงุดุฑุฉู‹ ููŠ ู„ูˆุญุฉ ู…ุนู„ูˆู…ุงุช ุฅุนู„ุงู†ุงุช Google. ู„ุฐู„ูƒุŒ ุจุดูƒู„ ุนุงู…ุŒ ุฅุฐุง ูƒุงู†ุช ุญุงู„ุฉ ุงู„ุฅุนู„ุงู† ู‡ูŠ ENABLEDุŒ ูุฅู† ุงู„ุฅุนู„ุงู† ู‚ูŠุฏ ุงู„ุชุดุบูŠู„ุŒ ูˆุฅุฐุง ูƒุงู†ุช ENABLEDุŒ ูุฅู† ุงู„ุฅุนู„ุงู† ู…ุชูˆู‚ู. ู…ุฑุฉ ุฃุฎุฑู‰ุŒ ู„ุง ูŠุบูŠุฑ ู…ูˆุตู„ Wrtn ุญุงู„ุฉ ุงู„ุญู…ู„ุฉ ุฃูˆ ู…ุฌู…ูˆุนุฉ ุงู„ุฅุนู„ุงู†ุงุช. ูŠู…ูƒู† ุฃูŠุถู‹ุง ุงุณุชุฎุฏุงู… ู‡ุฐู‡ ุงู„ูˆุธูŠูุฉ ู„ู„ุชุญู‚ู‚ ู…ู…ุง ุฅุฐุง ูƒุงู† ูŠุชู… ุชู†ููŠุฐ ุงู„ุฅุนู„ุงู† ุจุดูƒู„ ุตุญูŠุญ ุจุงู„ุฅุถุงูุฉ ุฅู„ู‰ ุนุฑุถ ุงู„ุฅุนู„ุงู†. ูŠุญุชูˆูŠ ูƒู„ ุฅุนู„ุงู† ุนู„ู‰ ุณุฌู„ ุชู‚ูŠูŠู… ู„ู…ุฑุงุฌุนุฉ ุงู„ุฅุนู„ุงู† ูˆุงู„ุณูŠุงุณุฉุŒ ูˆุงู„ุฐูŠ ูŠูˆุฌุฏ ูƒุฎุงุตูŠุฉ ุชุณู…ู‰ PolicySummary. ุชุญุชูˆูŠ ู‡ุฐู‡ ุงู„ุฎุงุตูŠุฉ ุนู„ู‰ ู…ุง ุฅุฐุง ูƒุงู† ุงู„ุฅุนู„ุงู† ู‚ุฏ ุชู…ุช ุงู„ู…ูˆุงูู‚ุฉ ุนู„ูŠู‡ุŒ ูˆุชุนู†ูŠ ุญุงู„ุฉ APPROVED ุฃู† Google ู‚ุฏ ูˆุงูู‚ุช ุนู„ู‰ ุงู„ู…ุฑุงุฌุนุฉ ูˆู‚ุฑุฑุช ุฃู†ู‡ ู…ุคู‡ู„. ูŠู…ูƒู†ูƒ ุชุบูŠูŠุฑ ุญุงู„ุฉ ุงู„ุฅุนู„ุงู† ููŠ PATCH connector/google-ads/campaigns/ads/status. ู‚ุจู„ ุงุณุชุฏุนุงุก ุงู„ูˆุธูŠูุฉุŒ ูŠุฌุจ ุฃู† ุชุทู„ุจ ู…ู† ุงู„ู…ุณุชุฎุฏู… ู…ุนุฑู ุงู„ุนู…ูŠู„ ุงู„ุฎุงุต ุจู‡ุŒ ู„ุฐุง ูŠุฌุจ ุฃู† ุชู‚ุชุฑุญ ู…ูˆุตู„ู‹ุง ูŠู…ูƒู†ู‡ ุงู„ุชุญู‚ู‚ ู…ู† ู…ุนุฑู ุงู„ุนู…ูŠู„ ุงู„ุฎุงุต ุจู‡.", + "description": "ุงุญุตู„ ุนู„ู‰ ู‚ุงุฆู…ุฉ ุงู„ุฅุนู„ุงู†ุงุช ู…ู† ุญุณุงุจ ุนู…ูŠู„ Google ู…ุฑุฑ `customerId` ุฅู„ู‰ ุงู„ู…ุณุชุฎุฏู… ูˆุงุจุญุซ ุนู† ุงู„ุฅุนู„ุงู†ุงุช (=ad) ููŠ ุญุณุงุจ ุฅุนู„ุงู† ุงู„ุนู…ูŠู„. ุฅุฐุง ู„ู… ูŠุชู… ุชู…ุฑูŠุฑ `customerId`ุŒ ูุณูŠุชู… ุชุญุฏูŠุฏู‡ ุชู„ู‚ุงุฆูŠู‹ุง ูู‚ุท ุฅุฐุง ูƒุงู† ู‡ู†ุงูƒ ุญุณุงุจ ุฅุนู„ุงู† ูˆุงุญุฏ ูู‚ุท ูŠู…ูƒู† ุงู„ูˆุตูˆู„ ุฅู„ูŠู‡ ุจูˆุงุณุทุฉ `Wrtn` ู…ู† ุงู„ู…ุณุชุฎุฏู…. ุงู„ุฅุนู„ุงู† ู‡ูˆ ุนู‚ุฏุฉ ููŠ ู†ู‡ุงูŠุฉ ุจู†ูŠุฉ ุดุฌุฑุฉ ุชุชูƒูˆู† ู…ู† ุงู„ุญู…ู„ุงุช ูˆู…ุฌู…ูˆุนุงุช ุงู„ุฅุนู„ุงู†ุงุช ูˆุงู„ุฅุนู„ุงู†ุงุชุŒ ูˆู‡ูˆ ู‚ุณู… ู…ุณุคูˆู„ ุนู† ุงู„ู…ูˆุงุฏุŒ ูˆู‡ูˆ ุฃูŠุถู‹ุง ูˆุญุฏุฉ ู…ูƒุดูˆูุฉ ู„ู„ู…ุณุชุฎุฏู…ูŠู† ุงู„ู†ู‡ุงุฆูŠูŠู†. ุฅุฐุง ุชู… ุชู…ุฑูŠุฑ ุงุณู… ุงู„ู…ูˆุฑุฏ ู„ู…ุฌู…ูˆุนุฉ ุฅุนู„ุงู†ุงุช (=adGroup) ูƒุญุฌุฉุŒ ูุณูŠุชู… ุงู„ุจุญุซ ุนู† ุงู„ุฅุนู„ุงู†ุงุช ุงู„ุชูŠ ุชู†ุชู…ูŠ ุฅู„ู‰ ู…ุฌู…ูˆุนุฉ ุงู„ุฅุนู„ุงู†ุงุช ู‡ุฐู‡ ูู‚ุท. ุงู„ุบุฑุถ ู…ู† ู‡ุฐุง ุงู„ู…ูˆุตู„ ู‡ูˆ ุชุญุฏูŠุฏ ู…ุง ุฅุฐุง ูƒุงู† ุฅุนู„ุงู† ุงู„ู…ุณุชุฎุฏู… ู‚ูŠุฏ ุงู„ุชุดุบูŠู„ ุญุงู„ูŠู‹ุง ุฃู… ู„ุง. ููŠ ุญุงู„ุฉ ู…ุฏูŠุฑูŠ `Wrtn`ุŒ ู„ุง ูŠุชู… ุชุบูŠูŠุฑ ุงู„ุญู…ู„ุงุช ูˆู…ุฌู…ูˆุนุงุช ุงู„ุฅุนู„ุงู†ุงุช ุฅู„ู‰ ุญุงู„ุฉ `PAUSED` ู…ุง ู„ู… ูŠุบูŠุฑ ุงู„ู…ุณุชุฎุฏู… ุญุงู„ุฉ ุงู„ุญู…ู„ุฉ ูˆู…ุฌู…ูˆุนุฉ ุงู„ุฅุนู„ุงู†ุงุช ู…ุจุงุดุฑุฉู‹ ููŠ ู„ูˆุญุฉ ู…ุนู„ูˆู…ุงุช ุฅุนู„ุงู†ุงุช Google. ู„ุฐู„ูƒุŒ ุจุดูƒู„ ุนุงู…ุŒ ุฅุฐุง ูƒุงู†ุช ุญุงู„ุฉ ุงู„ุฅุนู„ุงู† ู‡ูŠ `ENABLED`ุŒ ูุฅู† ุงู„ุฅุนู„ุงู† ู‚ูŠุฏ ุงู„ุชุดุบูŠู„ุŒ ูˆุฅุฐุง ูƒุงู†ุช `PAUSED`ุŒ ูุฅู† ุงู„ุฅุนู„ุงู† ู…ุชูˆู‚ู. ู…ุฑุฉ ุฃุฎุฑู‰ุŒ ู„ุง ูŠุบูŠุฑ ู…ูˆุตู„ `Wrtn` ุญุงู„ุฉ ุงู„ุญู…ู„ุฉ ุฃูˆ ู…ุฌู…ูˆุนุฉ ุงู„ุฅุนู„ุงู†ุงุช. ูŠู…ูƒู† ุฃูŠุถู‹ุง ุงุณุชุฎุฏุงู… ู‡ุฐู‡ ุงู„ูˆุธูŠูุฉ ู„ู„ุชุญู‚ู‚ ู…ู…ุง ุฅุฐุง ูƒุงู† ูŠุชู… ุชู†ููŠุฐ ุงู„ุฅุนู„ุงู† ุจุดูƒู„ ุตุญูŠุญ ุจุงู„ุฅุถุงูุฉ ุฅู„ู‰ ุนุฑุถ ุงู„ุฅุนู„ุงู†. ูŠุญุชูˆูŠ ูƒู„ ุฅุนู„ุงู† ุนู„ู‰ ุณุฌู„ ุชู‚ูŠูŠู… ู„ู…ุฑุงุฌุนุฉ ุงู„ุฅุนู„ุงู† ูˆุงู„ุณูŠุงุณุฉุŒ ูˆุงู„ุฐูŠ ูŠูˆุฌุฏ ูƒุฎุงุตูŠุฉ ุชุณู…ู‰ `PolicySummary`. ุชุญุชูˆูŠ ู‡ุฐู‡ ุงู„ุฎุงุตูŠุฉ ุนู„ู‰ ู…ุง ุฅุฐุง ูƒุงู† ุงู„ุฅุนู„ุงู† ู‚ุฏ ุชู…ุช ุงู„ู…ูˆุงูู‚ุฉ ุนู„ูŠู‡ุŒ ูˆุชุนู†ูŠ ุญุงู„ุฉ `APPROVED` ุฃู† Google ู‚ุฏ ูˆุงูู‚ุช ุนู„ู‰ ุงู„ู…ุฑุงุฌุนุฉ ูˆู‚ุฑุฑุช ุฃู†ู‡ ู…ุคู‡ู„. ูŠู…ูƒู†ูƒ ุชุบูŠูŠุฑ ุญุงู„ุฉ ุงู„ุฅุนู„ุงู† ููŠ `PATCH connector/google-ads/campaigns/ads/status`. ู‚ุจู„ ุงุณุชุฏุนุงุก ุงู„ูˆุธูŠูุฉุŒ ูŠุฌุจ ุฃู† ุชุทู„ุจ ู…ู† ุงู„ู…ุณุชุฎุฏู… `customerId` ุงู„ุฎุงุต ุจู‡ุŒ ู„ุฐู„ูƒ ูŠุฌุจ ุฃู† ุชู‚ุชุฑุญ ู…ูˆุตู„ู‹ุง ูŠู…ูƒู†ู‡ ุงู„ุชุญู‚ู‚ ู…ู† `customerId` ุงู„ุฎุงุต ุจู‡.", "tags": [ "Google Ads" ] @@ -5842,7 +5842,7 @@ } } }, - "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุฅุนู„ุงู† ุงู„ู…ููˆู„ุฏุฉ" + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุฅุนู„ุงู† ุงู„ู…ููˆู„ูŽู‘ุฏ" } }, "summary": "ุฅู†ุดุงุก ุฅุนู„ุงู†", @@ -6417,7 +6417,7 @@ } }, "summary": "ุฅุถุงูุฉ ูƒุชู„ุฉ ุจุชู†ุณูŠู‚ Markdown", - "description": "ุฅุถุงูุฉ ูƒุชู„ุฉ ุจุชู†ุณูŠู‚ Markdown ูŠู…ูƒู†ูƒ ุฅุถุงูุฉ ูƒุชู„ ุฅู„ู‰ ุงู„ุตูุญุฉ ุนู„ู‰ ุงู„ููˆุฑ ุจุงุณุชุฎุฏุงู… ู‚ูˆุงุนุฏ Markdown ูู‚ุท. ูŠู…ูƒู†ูƒ ุฅู†ุดุงุก ุตูุญุงุช ุจุดูƒู„ ุฃูƒุซุฑ ูุนุงู„ูŠุฉ ู…ู† ุงู„ู…ูˆุตู„ุงุช ุงู„ุฃุฎุฑู‰ุŒ ู„ุฐุง ูŠู…ูƒู†ูƒ ุฅุนุทุงุก ุงู„ุฃูˆู„ูˆูŠุฉ ู„ุฐู„ูƒ. ุฅุฐุง ูƒุงู†ุช ู‡ู†ุงูƒ ูƒุชู„ ูุฑูŠุฏุฉ ู…ู† ุงู„ู…ู„ุงุญุธุฉ ู„ุง ูŠู…ูƒู† ุฅู†ุดุงุคู‡ุง ุจุงุณุชุฎุฏุงู… ู‚ูˆุงุนุฏ MarkdownุŒ ููŠุฌุจ ุฑุจุทู‡ุง ุจู…ูˆุตู„ุงุช ุฅู†ุดุงุก ูƒุชู„ ุฃุฎุฑู‰. ู†ุธุฑู‹ุง ู„ุฃู† ุงู„ู…ุณุชุฎุฏู…ูŠู† ู‚ุฏ ู„ุง ูŠุนุฑููˆู† ู‚ูˆุงุนุฏ MarkdownุŒ ูู…ู† ุงู„ุฃูุถู„ ุงุณุชุฎุฏุงู… ู‚ูˆุงุนุฏ Markdown ุจุฏู„ุงู‹ ู…ู† ุชูˆุฌูŠู‡ู‡ู…. ูŠุฏุนู… Markdown ุงู„ู†ุต ูˆุงู„ุนู†ุงูˆูŠู† 1 ูˆ2 ูˆ3 ูˆู‚ูˆุงุนุฏ ู…ุฎุชู„ูุฉ ู…ุซู„ ุงู„ุฌุฏูˆู„ ุฃูˆ ุงู„ู‚ุงุฆู…ุฉ ุงู„ุณูˆุฏุงุก ูˆู‚ุงุฆู…ุฉ ุงู„ุฃุฑู‚ุงู… ูˆุฅุฑูุงู‚ ุงู„ุตูˆุฑ ูˆุงู„ุฎุท ุงู„ุนุฑูŠุถ ูˆุงู„ู…ุงุฆู„ ูˆู…ุง ุฅู„ู‰ ุฐู„ูƒ.", + "description": "ุฅุถุงูุฉ ูƒุชู„ุฉ ุจุชู†ุณูŠู‚ Markdown ูŠู…ูƒู†ูƒ ุฅุถุงูุฉ ูƒุชู„ ุฅู„ู‰ ุงู„ุตูุญุฉ ุนู„ู‰ ุงู„ููˆุฑ ุจุงุณุชุฎุฏุงู… ู‚ูˆุงุนุฏ Markdown ูู‚ุท. ูŠู…ูƒู†ูƒ ุฅู†ุดุงุก ุตูุญุงุช ุจุดูƒู„ ุฃูƒุซุฑ ูุนุงู„ูŠุฉ ู…ู† ุงู„ู…ูˆุตู„ุงุช ุงู„ุฃุฎุฑู‰ุŒ ู„ุฐุง ูŠู…ูƒู†ูƒ ุฅุนุทุงุก ุงู„ุฃูˆู„ูˆูŠุฉ ู„ุฐู„ูƒ. ุฅุฐุง ูƒุงู†ุช ู‡ู†ุงูƒ ูƒุชู„ ูุฑูŠุฏุฉ ู…ู† ุงู„ู…ู„ุงุญุธุฉ ู„ุง ูŠู…ูƒู† ุฅู†ุดุงุคู‡ุง ุจุงุณุชุฎุฏุงู… ู‚ูˆุงุนุฏ MarkdownุŒ ููŠุฌุจ ุฑุจุทู‡ุง ุจู…ูˆุตู„ุงุช ุฅู†ุดุงุก ูƒุชู„ ุฃุฎุฑู‰. ู†ุธุฑู‹ุง ู„ุฃู† ุงู„ู…ุณุชุฎุฏู…ูŠู† ู‚ุฏ ู„ุง ูŠุนุฑููˆู† ู‚ูˆุงุนุฏ MarkdownุŒ ูู…ู† ุงู„ุฃูุถู„ ุงุณุชุฎุฏุงู… ู‚ูˆุงุนุฏ Markdown ุจุฏู„ุงู‹ ู…ู† ุชูˆุฌูŠู‡ู‡ู…. ูŠุฏุนู… Markdown ุงู„ู†ุต ูˆุงู„ุนู†ุงูˆูŠู† 1 ูˆ2 ูˆ3 ูˆู‚ูˆุงุนุฏ ู…ุฎุชู„ูุฉ ู…ุซู„ ุงู„ุฌุฏูˆู„ ุฃูˆ ู‚ุงุฆู…ุฉ ุงู„ุซูˆุฑ ูˆู‚ุงุฆู…ุฉ ุงู„ุฃุฑู‚ุงู… ูˆุฅุฑูุงู‚ ุงู„ุตูˆุฑ ูˆุงู„ุฎุท ุงู„ุนุฑูŠุถ ูˆุงู„ู…ุงุฆู„ ูˆู…ุง ุฅู„ู‰ ุฐู„ูƒ.", "tags": [ "Notion" ] @@ -8434,7 +8434,7 @@ } } }, - "description": "ู‚ุงุฆู…ุฉ ู…ู‚ุณู…ุฉ ุฅู„ู‰ ุตูุญุงุช ู„ู„ู…ุดุงุฑูŠุน ุงู„ู…ุฑุฆูŠุฉ ู„ู„ู…ุณุชุฎุฏู…" + "description": "ู‚ุงุฆู…ุฉ ู…ู‚ุณู…ุฉ ุฅู„ู‰ ุตูุญุงุช ู…ู† ุงู„ู…ุดุงุฑูŠุน ุงู„ู…ุฑุฆูŠุฉ ู„ู„ู…ุณุชุฎุฏู…" } }, "summary": "ุงู„ุจุญุซ ุนู† ู…ุดุงุฑูŠุน Jira.", @@ -12847,8 +12847,8 @@ "_namespace_swagger.MyPartialIMarketingCopyComponents": { "properties": { "title": { - "title": "ุนู†ูˆุงู† ู†ุตูƒ ุงู„ุชุณูˆูŠู‚ูŠ", - "description": "ุนู†ูˆุงู† ู†ุตูƒ ุงู„ุชุณูˆูŠู‚ูŠ.", + "title": "ุนู†ูˆุงู† ู†ุต ุงู„ุชุณูˆูŠู‚ ุงู„ุฎุงุต ุจูƒ", + "description": "ุนู†ูˆุงู† ู†ุต ุงู„ุชุณูˆูŠู‚ ุงู„ุฎุงุต ุจูƒ.", "type": "string" }, "cta": { @@ -12858,7 +12858,7 @@ }, "subtitle": { "title": "ูˆุตู ุงู„ู†ุต ุงู„ุชุณูˆูŠู‚ูŠ", - "description": "ููŠู…ุง ูŠู„ูŠ ูˆุตู ู„ู†ุต ุงู„ุชุณูˆูŠู‚.", + "description": "ููŠู…ุง ูŠู„ูŠ ูˆุตู ู„ู†ุณุฎุฉ ุงู„ุชุณูˆูŠู‚.", "type": "string" } }, @@ -12999,8 +12999,8 @@ "imageUrl": { "format": "iri", "contentMediaType": "image/*", - "title": "ุนู†ูˆุงู† URL ู„ุตูˆุฑุฉ ู…ุณูˆุฏุฉ ุงู„ู†ุณุฎุฉ ุงู„ุชุณูˆูŠู‚ูŠุฉ ุงู„ู…ููˆู„ุฏุฉ", - "description": "ุนู†ูˆุงู† URL ู„ุตูˆุฑุฉ ู…ุณูˆุฏุฉ ุงู„ู†ุณุฎุฉ ุงู„ุชุณูˆูŠู‚ูŠุฉ ุงู„ู…ููˆู„ุฏุฉ.", + "title": "ุนู†ูˆุงู† URL ู„ุตูˆุฑุฉ ู…ุณูˆุฏุฉ ุงู„ู†ุณุฎุฉ ุงู„ุชุณูˆูŠู‚ูŠุฉ ุงู„ู…ูˆู„ุฏุฉ", + "description": "ุนู†ูˆุงู† URL ู„ุตูˆุฑุฉ ู…ุณูˆุฏุฉ ุงู„ู†ุณุฎุฉ ุงู„ุชุณูˆูŠู‚ูŠุฉ ุงู„ู…ูˆู„ุฏุฉ.", "type": "string" } }, @@ -15441,8 +15441,8 @@ "_namespace_swagger.IGoogleDrive.ICreateFileGoogleDriveOutput": { "properties": { "id": { - "title": "ู…ุนุฑู ู…ู„ู ู…ุญุฑูƒ ุงู„ุฃู‚ุฑุงุต ุงู„ุฐูŠ ุชู… ุฅู†ุดุงุคู‡", - "description": "ู…ุนุฑู ู…ู„ู ู…ุญุฑูƒ ุงู„ุฃู‚ุฑุงุต ุงู„ุฐูŠ ุชู… ุฅู†ุดุงุคู‡.", + "title": "ู…ุนุฑู ู…ู„ู ู…ุญุฑูƒ ุงู„ุฃู‚ุฑุงุต ุงู„ู…ูู†ุดุฃ", + "description": "ู…ุนุฑู ู…ู„ู ู…ุญุฑูƒ ุงู„ุฃู‚ุฑุงุต ุงู„ู…ูู†ุดุฃ.", "type": "string" } }, @@ -15665,7 +15665,7 @@ "type": "object" }, "fileExtension": { - "title": "ุงู…ุชุฏุงุฏ ุงู„ู…ู„ู", + "title": "ู…ู„ู ุงู„ุงู…ุชุฏุงุฏ", "type": "string" }, "ownerNames": { @@ -17008,7 +17008,7 @@ "type": "string" }, "plugin_data": { - "title": "ู‚ุงุฆู…ุฉ ู…ู†ูุตู„ุฉ ุจููˆุงุตู„ ู…ู† ู…ุนุฑูุงุช ุงู„ู…ูƒูˆู†ุงุช ุงู„ุฅุถุงููŠุฉ ูˆ/ุฃูˆ ุงู„ุณู„ุณู„ุฉ "ู…ุดุชุฑูƒุฉ"", + "title": "ู‚ุงุฆู…ุฉ ู…ู†ูุตู„ุฉ ุจููˆุงุตู„ ุจูŠู† ู…ุนุฑูุงุช ุงู„ู…ูƒูˆู†ุงุช ุงู„ุฅุถุงููŠุฉ ูˆ/ุฃูˆ ุงู„ุณู„ุณู„ุฉ "ู…ุดุชุฑูƒุฉ"", "description": "ู‚ุงุฆู…ุฉ ู…ู†ูุตู„ุฉ ุจููˆุงุตู„ ู…ู† ู…ุนุฑูุงุช ุงู„ู…ูƒูˆู†ุงุช ุงู„ุฅุถุงููŠุฉ ูˆ/ุฃูˆ ุงู„ุณู„ุณู„ุฉ "shared". ุณูŠุชู… ุชุถู…ูŠู† ุฌู…ูŠุน ุงู„ุจูŠุงู†ุงุช ุงู„ู…ูˆุฌูˆุฏุฉ ููŠ ุงู„ู…ุณุชู†ุฏ ุงู„ุฐูŠ ุชู… ุฅู†ุดุงุคู‡ ุจูˆุงุณุทุฉ ู‡ุฐุง ุงู„ู…ูƒูˆู† ุงู„ุฅุถุงููŠ ููŠ ุฎุตุงุฆุต `pluginData` ูˆ`sharedPluginData` ู„ู„ู†ุชูŠุฌุฉ.", "type": "string" }, @@ -17419,8 +17419,8 @@ "type": "string" }, "as_md": { - "title": "ุฅุฐุง ุชู… ุชู…ูƒูŠู†ู‡ุŒ ูุณูŠุชู… ุฅุฑุฌุงุน ุงู„ุชุนู„ูŠู‚ุงุช ูƒู…ูƒุงูุฆุงุช ู„ู‡ุง ููŠ ูˆุถุน ุงู„ุนู„ุงู…ุงุช ุนู†ุฏ ุงู„ุงู‚ุชุถุงุก", - "description": "ุฅุฐุง ุชู… ุชู…ูƒูŠู†ู‡ุŒ ูุณูŠุชู… ุฅุฑุฌุงุน ุงู„ุชุนู„ูŠู‚ุงุช ูƒู…ูƒุงูุฆุงุช ู„ู‡ุง ููŠ ูˆุถุน ุงู„ุนู„ุงู…ุงุช ุนู†ุฏ ุงู„ุงู‚ุชุถุงุก.", + "title": "ุฅุฐุง ุชู… ุชู…ูƒูŠู†ู‡ุŒ ูุณูŠุชู… ุฅุฑุฌุงุน ุงู„ุชุนู„ูŠู‚ุงุช ูƒู…ูƒุงูุฆุงุช ู„ู‡ุง ุนู†ุฏ ุงู„ุญุงุฌุฉ", + "description": "ุฅุฐุง ุชู… ุชู…ูƒูŠู†ู‡ุŒ ูุณูŠุชู… ุฅุฑุฌุงุน ุงู„ุชุนู„ูŠู‚ุงุช ูƒู…ูƒุงูุฆุงุช ู„ู‡ุง ุนู†ุฏ ุงู„ุญุงุฌุฉ.", "type": "boolean" } }, @@ -17626,8 +17626,8 @@ "type": "string" }, "as_md": { - "title": "ุฅุฐุง ุชู… ุชู…ูƒูŠู†ู‡ุŒ ูุณูŠุชู… ุฅุฑุฌุงุน ุงู„ุชุนู„ูŠู‚ุงุช ูƒู…ูƒุงูุฆุงุช ู„ู‡ุง ููŠ ูˆุถุน ุงู„ุนู„ุงู…ุงุช ุนู†ุฏ ุงู„ุงู‚ุชุถุงุก", - "description": "ุฅุฐุง ุชู… ุชู…ูƒูŠู†ู‡ุŒ ูุณูŠุชู… ุฅุฑุฌุงุน ุงู„ุชุนู„ูŠู‚ุงุช ูƒู…ูƒุงูุฆุงุช ู„ู‡ุง ููŠ ูˆุถุน ุงู„ุนู„ุงู…ุงุช ุนู†ุฏ ุงู„ุงู‚ุชุถุงุก.", + "title": "ุฅุฐุง ุชู… ุชู…ูƒูŠู†ู‡ุŒ ูุณูŠุชู… ุฅุฑุฌุงุน ุงู„ุชุนู„ูŠู‚ุงุช ูƒู…ูƒุงูุฆุงุช ู„ู‡ุง ุนู†ุฏ ุงู„ุญุงุฌุฉ", + "description": "ุฅุฐุง ุชู… ุชู…ูƒูŠู†ู‡ุŒ ูุณูŠุชู… ุฅุฑุฌุงุน ุงู„ุชุนู„ูŠู‚ุงุช ูƒู…ูƒุงูุฆุงุช ู„ู‡ุง ุนู†ุฏ ุงู„ุญุงุฌุฉ.", "type": "boolean" }, "teamId": { @@ -20367,7 +20367,7 @@ }, { "title": "ุฃุฑุฌูˆุงู†ูŠ", - "description": "ุฃุจ47 ู‚ุจู„ ุงู„ู…ูŠู„ุงุฏ", + "description": "ุฃูŠู‡ ุจูŠ 47 ู‚ุจู„ ุงู„ู…ูŠู„ุงุฏ", "const": "MAGENTA" }, { @@ -20397,7 +20397,7 @@ "title", "time" ], - "title": "ุญุฏุซ ุชู… ุฅู†ุดุงุคู‡ ููŠ ุชู‚ูˆูŠู… KakaoTalk", + "title": "ุชู… ุฅู†ุดุงุก ุงู„ุญุฏุซ ููŠ ุชู‚ูˆูŠู… KakaoTalk", "type": "object" }, "_namespace_swagger.IKakaoTalk.Time": { @@ -20728,7 +20728,7 @@ }, { "title": "ุฃุฑุฌูˆุงู†ูŠ", - "description": "ุฃุจ47 ู‚ุจู„ ุงู„ู…ูŠู„ุงุฏ", + "description": "ุฃูŠู‡ ุจูŠ 47 ู‚ุจู„ ุงู„ู…ูŠู„ุงุฏ", "const": "MAGENTA" }, { @@ -20985,7 +20985,7 @@ }, { "title": "ุฃุฑุฌูˆุงู†ูŠ", - "description": "ุฃุจ47 ู‚ุจู„ ุงู„ู…ูŠู„ุงุฏ", + "description": "ุฃูŠู‡ ุจูŠ 47 ู‚ุจู„ ุงู„ู…ูŠู„ุงุฏ", "const": "MAGENTA" }, { @@ -21110,7 +21110,7 @@ }, { "title": "ุฃุฑุฌูˆุงู†ูŠ", - "description": "ุฃุจ47 ู‚ุจู„ ุงู„ู…ูŠู„ุงุฏ", + "description": "ุฃูŠู‡ ุจูŠ 47 ู‚ุจู„ ุงู„ู…ูŠู„ุงุฏ", "const": "MAGENTA" }, { @@ -21336,7 +21336,7 @@ "const": "AG2" }, { - "title": "๊ณต๊ณต๊ธฐ๊ด€", + "title": "ู…ู‚ุงู„ุงุช ู…ุชุนู„ู‚ุฉ", "const": "PO3" }, { @@ -21417,7 +21417,7 @@ "const": "์ค‘๊ฐœ์—…์†Œ" }, { - "title": "๊ณต๊ณต๊ธฐ๊ด€", + "title": "ู…ู‚ุงู„ุงุช ู…ุชุนู„ู‚ุฉ", "const": "๊ณต๊ณต๊ธฐ๊ด€" }, { @@ -21464,7 +21464,7 @@ }, "x": { "title": "ู‚ูŠู…ุฉ ุฅุญุฏุงุซูŠุงุช X", - "description": "ุฎุท ุงู„ุทูˆู„ (Longitude) ููŠ ุญุงู„ุฉ ุฎุทูˆุท ุงู„ุนุฑุถ ูˆุงู„ุทูˆู„", + "description": "ุฎุท ุงู„ุทูˆู„ (ุงู„ุฎุท ุงู„ุทูˆู„ูŠ) ููŠ ุญุงู„ุฉ ุฎุทูˆุท ุงู„ุนุฑุถ ูˆุงู„ุทูˆู„", "type": "string" }, "y": { @@ -21611,7 +21611,7 @@ "const": 0 }, { - "title": "ู‡ุฐุง ู‡ูˆ ุงู„ุณุจุจ ููŠ ุฃู† ู‡ุฐุง ู‡ูˆ ู…ุง ุชุจุญุซ ุนู†ู‡", + "title": "ู‡ุฐุง ู‡ูˆ ู…ุง ุชุจุญุซ ุนู†ู‡", "const": 1 }, { @@ -21663,11 +21663,11 @@ "const": 205 }, { - "title": "๋‹ค์ค‘ ์ถœ๋ฐœ์ง€: ๋ชฉ์ ์ง€ ์ฃผ๋ณ€์˜ ๊ณ  ๊ณ  ์ •๋ณด(๊ตํ†ต ์žฅ์• ) ุฃูˆ ๋กœ ํ•œ ํ†ตํ–‰ ๋ถˆ๊ฐ€", + "title": "๋‹ค์ค‘ ์ถœ๋ฐœ์ง€: ๋ชฉ์ ์ง€ ์ฃผ๋ณ€์˜ ์œ ๊ณ  ์ •๋ณด(๊ตํ†ต ์žฅ์• ) ุฃูˆ ๋กœ ํ•œ ํ†ตํ–‰ ๋ถˆ๊ฐ€", "const": 206 }, { - "title": "๋‹ค์ค‘ ์ถœ๋ฐœ์ง€: ุฃูุถู„ ู…ุง ููŠ ุงู„ุฃู…ุฑ ุจุงู„ู†ุณุจุฉ ู„ูƒ", + "title": "๋‹ค์ค‘ ์ถœ๋ฐœ์ง€: ู…ุณุชู„ุฒู…ุงุชูƒ ุงู„ู…ูุถู„ุฉ", "const": 207 }, { @@ -21967,7 +21967,7 @@ "const": 7 }, { - "title": "ู‡ุฐุง ู‡ูˆ ู…ุง ุชุจุญุซ ุนู†ู‡", + "title": "ุฃูุถู„ ู…ุง ููŠ ุงู„ุฃู…ุฑ", "const": 8 }, { @@ -22055,7 +22055,7 @@ "const": 30 }, { - "title": "ู…ูƒุงูุฃุฉ ู†ู‡ุงูŠุฉ ุงู„ุฃุณุจูˆุน 2", + "title": "ุงู„ุฌุฒุก ุงู„ุซุงู†ูŠ ู…ู† ุงู„ู„ุนุจุฉ", "const": 31 }, { @@ -22107,7 +22107,7 @@ "const": 43 }, { - "title": "ุฃูุถู„ ู…ุง ููŠ ุงู„ุฃู…ุฑ ู‡ูˆ ุฃู† ุชูƒูˆู† ู‚ุงุฏุฑู‹ุง ุนู„ู‰ ุงู„ุนู…ู„", + "title": "ุฃูุถู„ ู…ุง ููŠ ุงู„ุฃู…ุฑ ู‡ูˆ ุงู„ุญุตูˆู„ ุนู„ู‰ ุจุทุงู‚ุฉ ุงู„ุงุฆุชู…ุงู† ุงู„ุฎุงุตุฉ ุจูƒ", "const": 44 }, { @@ -22119,7 +22119,7 @@ "const": 46 }, { - "title": "ุฃูุถู„ ู…ุง ููŠ ุงู„ุฃู…ุฑ ู‡ูˆ ุงู„ุญุตูˆู„ ุนู„ู‰ ุงู„ู…ุงู„", + "title": "ุฃูุถู„ ู…ุง ููŠ ุงู„ุฃู…ุฑ ู‡ูˆ ุฃู† ุชูƒูˆู† ู‚ุงุฏุฑู‹ุง ุนู„ู‰ ุงู„ุนู…ู„", "const": 47 }, { @@ -22127,7 +22127,7 @@ "const": 48 }, { - "title": "ู‡ุฐุง ู‡ูˆ ุงู„ู…ูƒุงู† ุงู„ู…ู†ุงุณุจ ู„ูƒ", + "title": "ู‡ุฐุง ู‡ูˆ ู…ุง ุชุจุญุซ ุนู†ู‡", "const": 49 }, { @@ -22159,7 +22159,7 @@ "const": 74 }, { - "title": "6 ู†ู‚ุงุท ุงู„ุงุชุตุงู„", + "title": "ุฃูุถู„ 6 ู†ู‚ุงุท ููŠ ุงู„ุฃุณุจูˆุน", "const": 75 }, { @@ -22171,7 +22171,7 @@ "const": 77 }, { - "title": "9 ุณู†ูˆุงุช ู…ู† ุชุงุฑูŠุฎ ุงู„ู…ูŠู„ุงุฏ", + "title": "ุฃูุถู„ ู…ุง ููŠ 9 ุณู†ูˆุงุช ู…ู† ุงู„ุฎุจุฑุฉ", "const": 78 }, { @@ -22971,7 +22971,7 @@ "type", "contents" ], - "title": "ู…ุฑุจุน ู…ูƒูˆู† ู…ู† 4 ุฃุฌุฒุงุก (ู‚ุทุน ู…ู† ู†ูˆุน ุงู„ูƒุฑุชูˆู†)", + "title": "ู…ุฑุจุน ู…ูƒูˆู† ู…ู† 4 ุฃุฌุฒุงุก (ู†ูˆุน ุงู„ูƒุฑุชูˆู† ุงู„ู…ู‚ุทูˆุน)", "type": "object" }, "_namespace_swagger.IGoogleSlides.ICreatePresentationInput": { @@ -23696,7 +23696,7 @@ "cmmMsgHeader": { "properties": { "totalCount": { - "title": "ุงู„ู…ุฌู…ูˆุน ุงู„ูƒู„ูŠ", + "title": "ู…ุฌู…ูˆุน ุงู„ุนุฏุฏ", "type": "integer" }, "countPerPage": { @@ -24887,7 +24887,7 @@ "type": "number" }, "indrAutoUtcnt": { - "title": "ู…ุฎุฒูˆู† ุฏุงุฎู„ูŠ ู…ูƒุชูู ุฐุงุชูŠู‹ุง (ูƒุจูŠุฑ)", + "title": "ู…ุฎุฒูˆู† ู…ูƒุชู ุฐุงุชูŠุง ุฏุงุฎู„ูŠุง (ูƒุจูŠุฑ)", "type": "number" }, "indrAutoArea": { @@ -26103,7 +26103,7 @@ "properties": { "user_request": { "title": "ุทู„ุจ ุงู„ู…ุณุชุฎุฏู…", - "x-wrtn-placeholder": "ู„ุง ุฏุงุนูŠ ู„ู„ู‚ู„ู‚ ุจุดุฃู† ูƒูŠููŠุฉ ุงุณุชุฎุฏุงู… ุจุทุงู‚ุฉ ุงู„ุงุฆุชู…ุงู† ุงู„ุฎุงุตุฉ ุจูƒ.", + "x-wrtn-placeholder": "ุฅู† ุงู„ุญุตูˆู„ ุนู„ู‰ ุจุทุงู‚ุฉ ุงู„ุงุฆุชู…ุงู† ุงู„ุฎุงุตุฉ ุจูƒ ู‡ูˆ ุฃู…ุฑ ุฑุงุฆุน ุจุงู„ู†ุณุจุฉ ู„ูƒ.", "type": "string" }, "system_prompt": { @@ -26226,7 +26226,7 @@ "format": "iri", "contentMediaType": "image/*", "title": "ุฑุงุจุท ุงู„ุตูˆุฑุฉ ุงู„ู…ูˆู„ุฏุฉ", - "description": "ุชู… ุฅู†ุดุงุก ุนู†ูˆุงู† URL ู„ู„ุตูˆุฑุฉ", + "description": "ุนู†ูˆุงู† URL ู„ู„ุตูˆุฑุฉ ุงู„ู…ูˆู„ุฏุฉ", "type": "string" } }, @@ -26352,7 +26352,7 @@ "format": "iri", "contentMediaType": "image/*", "title": "ุฑุงุจุท ุงู„ุตูˆุฑุฉ ุงู„ู…ูˆู„ุฏุฉ", - "description": "ุชู… ุฅู†ุดุงุก ุนู†ูˆุงู† URL ู„ู„ุตูˆุฑุฉ", + "description": "ุนู†ูˆุงู† URL ู„ู„ุตูˆุฑุฉ ุงู„ู…ูˆู„ุฏุฉ", "type": "string" } }, @@ -27202,7 +27202,7 @@ "const": "SEARCH_STANDARD" }, { - "title": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ุชูุงุตูŠู„", + "title": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ุชูุงุตูŠู„ ุญูˆู„ ุฏูŠุณูŠุจุงุชุง", "const": "DISPLAY_STANDARD" } ] @@ -27251,7 +27251,7 @@ "const": "APPROVED_LIMITED" }, { - "title": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู…ูƒุงูุฃุฉ ู†ู‡ุงูŠุฉ ุงู„ุฃุณุจูˆุน", + "title": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุจุทุงู‚ุฉ ุงู„ุงุฆุชู…ุงู† ุงู„ุฎุงุตุฉ ุจูƒ", "const": "AREA_OF_INTEREST_ONLY" }, { @@ -27346,7 +27346,7 @@ "const": "PHRASE" }, { - "title": "ู‡ุงูŠุฑุฌูŠู†", + "title": "ู‡ุงูŠุฑุฌูŠู†ุฌูŠู†", "const": "BROAD" } ] @@ -27457,7 +27457,7 @@ "const": "APPROVED_LIMITED" }, { - "title": "ุงู„ุญุตูˆู„ ุนู„ู‰ ู…ูƒุงูุฃุฉ ู†ู‡ุงูŠุฉ ุงู„ุฃุณุจูˆุน", + "title": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุจุทุงู‚ุฉ ุงู„ุงุฆุชู…ุงู† ุงู„ุฎุงุตุฉ ุจูƒ", "const": "AREA_OF_INTEREST_ONLY" }, { @@ -27760,7 +27760,7 @@ "const": "PHRASE" }, { - "title": "ู‡ุงูŠุฑุฌูŠู†", + "title": "ู‡ุงูŠุฑุฌูŠู†ุฌูŠู†", "const": "BROAD" } ] @@ -27803,7 +27803,7 @@ "const": "PHRASE" }, { - "title": "ู‡ุงูŠุฑุฌูŠู†", + "title": "ู‡ุงูŠุฑุฌูŠู†ุฌูŠู†", "const": "BROAD" } ] @@ -28501,7 +28501,7 @@ "const": "SEARCH" }, { - "title": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ุชูุงุตูŠู„", + "title": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ุชูุงุตูŠู„ ุญูˆู„ ุฏูŠุณูŠุจุงุชุง", "description": "ุฃูุถู„ ู…ุง ููŠ ุงู„ุฃู…ุฑ ู‡ูˆ ุฃู† ุชูƒูˆู† ุนู„ู‰ ุฏุฑุงูŠุฉ ุจู€ 3 ู†ู‚ุงุท ุฑุฆูŠุณูŠุฉ ููŠ ุฑุญู„ุชูƒ", "const": "DISPLAY" } @@ -28686,7 +28686,7 @@ "const": "SEARCH" }, { - "title": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ุชูุงุตูŠู„", + "title": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ุชูุงุตูŠู„ ุญูˆู„ ุฏูŠุณูŠุจุงุชุง", "description": "ุฃูุถู„ ู…ุง ููŠ ุงู„ุฃู…ุฑ ู‡ูˆ ุฃู† ุชูƒูˆู† ุนู„ู‰ ุฏุฑุงูŠุฉ ุจู€ 3 ู†ู‚ุงุท ุฑุฆูŠุณูŠุฉ ููŠ ุฑุญู„ุชูƒ", "const": "DISPLAY" } @@ -29045,8 +29045,8 @@ "default": 10, "minimum": 1, "maximum": 50, - "title": "ุนุฏุฏ ุงู„ู…ุณุชู†ุฏุงุช ุงู„ู…ุทู„ูˆุจ ุนุฑุถู‡ุง ููŠ ุงู„ุตูุญุฉ ุงู„ูˆุงุญุฏุฉ", - "description": "ุนุฏุฏ ุงู„ู…ุณุชู†ุฏุงุช ุงู„ู…ุทู„ูˆุจ ุนุฑุถู‡ุง ููŠ ุงู„ุตูุญุฉ ุงู„ูˆุงุญุฏุฉ.", + "title": "ุนุฏุฏ ุงู„ู…ุณุชู†ุฏุงุช ุงู„ู…ุทู„ูˆุจ ุนุฑุถู‡ุง ููŠ ุตูุญุฉ ูˆุงุญุฏุฉ", + "description": "ุนุฏุฏ ุงู„ู…ุณุชู†ุฏุงุช ุงู„ู…ุทู„ูˆุจ ุนุฑุถู‡ุง ููŠ ุตูุญุฉ ูˆุงุญุฏุฉ.", "type": "number" } }, @@ -29178,8 +29178,8 @@ "display", "items" ], - "title": "ุจูŠุงู†ุงุช ู†ุชูŠุฌุฉ ุงู„ุจุญุซ ููŠ Naver Cafe", - "description": "ุจูŠุงู†ุงุช ู†ุชูŠุฌุฉ ุงู„ุจุญุซ ููŠ Naver Cafe.", + "title": "ุจูŠุงู†ุงุช ู†ุชูŠุฌุฉ ุงู„ุจุญุซ ููŠ ู…ู‚ู‡ู‰ Naver", + "description": "ุจูŠุงู†ุงุช ู†ุชูŠุฌุฉ ุงู„ุจุญุซ ููŠ ู…ู‚ู‡ู‰ Naver.", "type": "object" } }, @@ -29268,7 +29268,7 @@ }, { "title": "ุชุงุฑูŠุฎ", - "description": "ู†ุงูŠูƒ ู†ุงูŠูƒ ู†ุงูŠูƒ", + "description": "ู†ุงูŠูƒ ู†ุงูŠูƒ ู†ุงูŠูƒ ู†ุงูŠูƒ", "x-wrtn-placeholder": "ุณูŠู…", "const": "date" } @@ -29812,7 +29812,7 @@ "title": "ู…ุนุฑู ุงู„ูƒุชู„ุฉ", "oneOf": [ { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:pageId, label:title}", "method": "post", @@ -29821,7 +29821,7 @@ "type": "string" }, { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", "method": "post", @@ -29870,7 +29870,7 @@ "title": "ู…ุนุฑู ุงู„ุตูุญุฉ", "oneOf": [ { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:pageId, label:title}", "method": "post", @@ -29879,7 +29879,7 @@ "type": "string" }, { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", "method": "post", @@ -29985,7 +29985,7 @@ "title": "ู…ุนุฑู ุงู„ุตูุญุฉ", "oneOf": [ { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:pageId, label:title}", "method": "post", @@ -29994,7 +29994,7 @@ "type": "string" }, { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", "method": "post", @@ -30076,7 +30076,7 @@ "title": "ู…ุนุฑู ุงู„ุตูุญุฉ", "oneOf": [ { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:pageId, label:title}", "method": "post", @@ -30085,7 +30085,7 @@ "type": "string" }, { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", "method": "post", @@ -30167,7 +30167,7 @@ "title": "ู…ุนุฑู ุงู„ุตูุญุฉ", "oneOf": [ { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:pageId, label:title}", "method": "post", @@ -30176,7 +30176,7 @@ "type": "string" }, { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", "method": "post", @@ -30268,7 +30268,7 @@ "title": "ู…ุนุฑู ุงู„ุตูุญุฉ", "oneOf": [ { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:pageId, label:title}", "method": "post", @@ -30277,7 +30277,7 @@ "type": "string" }, { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", "method": "post", @@ -30367,7 +30367,7 @@ "title": "ู…ุนุฑู ุงู„ุตูุญุฉ", "oneOf": [ { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:pageId, label:title}", "method": "post", @@ -30376,7 +30376,7 @@ "type": "string" }, { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", "method": "post", @@ -30468,7 +30468,7 @@ "title": "ู…ุนุฑู ุงู„ุตูุญุฉ", "oneOf": [ { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:pageId, label:title}", "method": "post", @@ -30477,7 +30477,7 @@ "type": "string" }, { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", "method": "post", @@ -30816,7 +30816,7 @@ "title": "ู…ุนุฑู ุงู„ุตูุญุฉ", "oneOf": [ { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:pageId, label:title}", "method": "post", @@ -30825,7 +30825,7 @@ "type": "string" }, { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", "method": "post", @@ -30869,7 +30869,7 @@ "title": "ู…ุนุฑู ุงู„ุตูุญุฉ", "oneOf": [ { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:pageId, label:title}", "method": "post", @@ -30878,7 +30878,7 @@ "type": "string" }, { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", "method": "post", @@ -30913,7 +30913,7 @@ "title": "ู…ุนุฑู ุงู„ุตูุญุฉ", "oneOf": [ { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:pageId, label:title}", "method": "post", @@ -30922,7 +30922,7 @@ "type": "string" }, { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", "method": "post", @@ -30948,7 +30948,7 @@ "_namespace_swagger.INotion.ICreateChildContentTypeBreadcrumbInput": { "properties": { "breadcrumb": { - "title": "ู…ุณุงุฑ ุงู„ุชู†ู‚ู„ุŒ ูƒู„ ู…ุง ุนู„ูŠูƒ ูุนู„ู‡ ู‡ูˆ ู…ุทุงุจู‚ุฉ ุงุณู… ุงู„ู…ูุชุงุญ ุจุดูƒู„ ุตุญูŠุญุŒ ู„ุฐุง ู…ุง ุนู„ูŠูƒ ุณูˆู‰ ุชู…ุฑูŠุฑ ูƒุงุฆู† ูุงุฑุบ.", + "title": "ู…ุณุงุฑ ุงู„ุชู†ู‚ู„ุŒ ู…ุง ุนู„ูŠูƒ ุณูˆู‰ ู…ุทุงุจู‚ุฉ ุงุณู… ุงู„ู…ูุชุงุญ ุจุดูƒู„ ุตุญูŠุญุŒ ู„ุฐุง ู…ุง ุนู„ูŠูƒ ุณูˆู‰ ุชู…ุฑูŠุฑ ูƒุงุฆู† ูุงุฑุบ.", "$ref": "#/components/schemas/_namespace_swagger.Recordstringnever" }, "secretKey": { @@ -30962,7 +30962,7 @@ "title": "ู…ุนุฑู ุงู„ุตูุญุฉ", "oneOf": [ { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:pageId, label:title}", "method": "post", @@ -30971,7 +30971,7 @@ "type": "string" }, { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", "method": "post", @@ -31074,7 +31074,7 @@ "title": "ู…ุนุฑู ุงู„ุตูุญุฉ", "oneOf": [ { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:pageId, label:title}", "method": "post", @@ -31083,7 +31083,7 @@ "type": "string" }, { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", "method": "post", @@ -31110,7 +31110,7 @@ "title": "ู…ุนุฑู ุงู„ุตูุญุฉ", "oneOf": [ { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:pageId, label:title}", "method": "post", @@ -31119,7 +31119,7 @@ "type": "string" }, { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", "method": "post", @@ -31147,7 +31147,7 @@ "title": "ู…ุนุฑู ุงู„ุตูุญุฉ", "oneOf": [ { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:pageId, label:title}", "method": "post", @@ -31156,7 +31156,7 @@ "type": "string" }, { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", "method": "post", @@ -31187,7 +31187,7 @@ "title": "ู…ุนุฑู ุงู„ุตูุญุฉ", "oneOf": [ { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:pageId, label:title}", "method": "post", @@ -31196,7 +31196,7 @@ "type": "string" }, { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", "method": "post", @@ -31723,7 +31723,7 @@ "parentPageId": { "oneOf": [ { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:pageId, label:title}", "method": "post", @@ -31732,7 +31732,7 @@ "type": "string" }, { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", "method": "post", @@ -31791,11 +31791,11 @@ "_namespace_swagger.INotion.IReadPageContentInput": { "properties": { "block_id": { - "description": "ูŠุดูŠุฑ ุฅู„ู‰ ู…ุนุฑู ุงู„ุตูุญุฉ. ูŠู…ูƒู†ูƒ ุฅุนุงุฏุฉ ุฅุฏุฎุงู„ ู…ุนุฑู ุงู„ูƒุชู„ุฉ ููŠ ู‡ุฐุง ุงู„ุนุงู…ู„ ูˆุงุณุชุฎุฏุงู…ู‡ ู„ู„ุจุญุซ ุนู† ุงู„ูƒุชู„ ุงู„ูุฑุนูŠุฉ.", + "description": "ูŠุดูŠุฑ ุฅู„ู‰ ู…ุนุฑู ุงู„ุตูุญุฉ. ูŠู…ูƒู†ูƒ ุฅุนุงุฏุฉ ูˆุถุน ู…ุนุฑู ุงู„ูƒุชู„ุฉ ููŠ ู‡ุฐุง ุงู„ุนุงู…ู„ ูˆุงุณุชุฎุฏุงู…ู‡ ู„ู„ุจุญุซ ุนู† ุงู„ูƒุชู„ ุงู„ูุฑุนูŠุฉ.", "title": "ู…ุนุฑู ุงู„ูƒุชู„ุฉ", "oneOf": [ { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:pageId, label:title}", "method": "post", @@ -31804,7 +31804,7 @@ "type": "string" }, { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", "method": "post", @@ -32758,7 +32758,7 @@ "type", "people" ], - "title": "ุฎุตุงุฆุต ู‚ุงุนุฏุฉ ุงู„ุจูŠุงู†ุงุช ู„ู„ุฃุดุฎุงุต", + "title": "ุฎุตุงุฆุต ุงู„ุฃุดุฎุงุต ููŠ ู‚ุงุนุฏุฉ ุงู„ุจูŠุงู†ุงุช", "type": "object" }, "_namespace_swagger.INotion.FilesDatabaseProperty": { @@ -33736,7 +33736,7 @@ "properties": { "bold": { "title": "ุนุฑูŠุถ", - "description": "ุนู†ูˆุงู† ุงู„ู†ุต ุบุงู…ู‚", + "description": "ู†ุต ุงู„ุนู†ูˆุงู† ุบุงู…ู‚", "type": "boolean" }, "italic": { @@ -33850,7 +33850,7 @@ "parentPageId": { "oneOf": [ { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:pageId, label:title}", "method": "post", @@ -33859,7 +33859,7 @@ "type": "string" }, { - "x-wrtn-placeholder": "ุงู„ู…ุฒูŠุฏ ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช.", + "x-wrtn-placeholder": "ุดูƒุฑุง ู„ูƒ.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", "method": "post", @@ -34162,7 +34162,7 @@ "const": "23" }, { - "title": "ู…ูŠูƒุงุฑุง", + "title": "ู…ูŠุฑุงูƒุง", "const": "24" } ] @@ -38568,7 +38568,7 @@ "issuetype": { "properties": { "id": { - "description": "ู…ุนุฑู ุงู„ู…ุดูƒู„ุฉ. ููŠ ุจุนุถ ุงู„ุฃุญูŠุงู†ุŒ ูŠู…ูƒู† ู„ู„ู…ุณุชุฎุฏู… ุฃู† ูŠุฐูƒุฑ ุงุณู… ู†ูˆุน ุงู„ู…ุดูƒู„ุฉุŒ ู…ุซู„ "bug" ุฃูˆ "story"ุŒ ูˆู„ูƒู† ู„ุง ูŠู…ูƒู†ูƒ ุชุญุฏูŠุฏ ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ ุจุงุณุชุฎุฏุงู… ุงุณู… ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ. ู„ุฃู†ู‡ ู‚ุฏ ูŠูƒูˆู† ู‡ู†ุงูƒ ุฃู†ูˆุงุน ุชุญู…ู„ ู†ูุณ ุงู„ุงุณู…. ู„ุฐู„ูƒุŒ ูŠุฌุจ ุนู„ูŠูƒ ุงู„ุชุญู‚ู‚ ู…ู† ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ ุจุงุณุชุฎุฏุงู… ู…ูˆุตู„ ู…ุฎุชู„ู ู„ู„ุชุฃูƒุฏ ู…ู† ุฃู†ู‡ ู†ูˆุน ู…ุดูƒู„ุฉ ูŠู…ูƒู† ุงุณุชุฎุฏุงู…ู‡ ููŠ ุงู„ู…ุดุฑูˆุน. ูˆู…ุน ุฐู„ูƒุŒ ุฅุฐุง ุณู„ู…ุช ู†ูˆุน ุงู„ุณู„ุณู„ุฉ ุงู„ุฑู‚ู…ูŠุฉ ู…ู† ุงู„ุจุฏุงูŠุฉุŒ ูู‚ุฏ ูŠูƒูˆู† ู…ุนุฑู ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ.", + "description": "ู…ุนุฑู ุงู„ู…ุดูƒู„ุฉ. ููŠ ุจุนุถ ุงู„ุฃุญูŠุงู†ุŒ ูŠู…ูƒู† ู„ู„ู…ุณุชุฎุฏู… ุฃู† ูŠุฐูƒุฑ ุงุณู… ู†ูˆุน ุงู„ู…ุดูƒู„ุฉุŒ ู…ุซู„ "bug" ุฃูˆ "story"ุŒ ูˆู„ูƒู† ู„ุง ูŠู…ูƒู†ูƒ ุชุญุฏูŠุฏ ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ ุจุงุณุชุฎุฏุงู… ุงุณู… ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ. ู„ุฃู†ู‡ ู‚ุฏ ูŠูƒูˆู† ู‡ู†ุงูƒ ุฃู†ูˆุงุน ุชุญู…ู„ ู†ูุณ ุงู„ุงุณู…. ู„ุฐู„ูƒุŒ ูŠุฌุจ ุนู„ูŠูƒ ุงู„ุชุญู‚ู‚ ู…ู† ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ ุจุงุณุชุฎุฏุงู… ู…ูˆุตู„ ู…ุฎุชู„ู ู„ู„ุชุฃูƒุฏ ู…ู† ุฃู†ู‡ ู†ูˆุน ู…ุดูƒู„ุฉ ูŠู…ูƒู† ุงุณุชุฎุฏุงู…ู‡ ููŠ ุงู„ู…ุดุฑูˆุน. ูˆู…ุน ุฐู„ูƒุŒ ุฅุฐุง ู‚ู…ุช ุจุชุณู„ูŠู… ู†ูˆุน ุงู„ุณู„ุณู„ุฉ ุงู„ุฑู‚ู…ูŠุฉ ู…ู† ุงู„ุจุฏุงูŠุฉุŒ ูู‚ุฏ ูŠูƒูˆู† ู…ุนุฑู ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ.", "title": "ู…ุนุฑู ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ", "oneOf": [ { @@ -38806,7 +38806,7 @@ "issuetype": { "properties": { "id": { - "description": "ู…ุนุฑู ุงู„ู…ุดูƒู„ุฉ. ููŠ ุจุนุถ ุงู„ุฃุญูŠุงู†ุŒ ูŠู…ูƒู† ู„ู„ู…ุณุชุฎุฏู… ุฃู† ูŠุฐูƒุฑ ุงุณู… ู†ูˆุน ุงู„ู…ุดูƒู„ุฉุŒ ู…ุซู„ "bug" ุฃูˆ "story"ุŒ ูˆู„ูƒู† ู„ุง ูŠู…ูƒู†ูƒ ุชุญุฏูŠุฏ ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ ุจุงุณุชุฎุฏุงู… ุงุณู… ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ. ู„ุฃู†ู‡ ู‚ุฏ ูŠูƒูˆู† ู‡ู†ุงูƒ ุฃู†ูˆุงุน ุชุญู…ู„ ู†ูุณ ุงู„ุงุณู…. ู„ุฐู„ูƒุŒ ูŠุฌุจ ุนู„ูŠูƒ ุงู„ุชุญู‚ู‚ ู…ู† ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ ุจุงุณุชุฎุฏุงู… ู…ูˆุตู„ ู…ุฎุชู„ู ู„ู„ุชุฃูƒุฏ ู…ู† ุฃู†ู‡ ู†ูˆุน ู…ุดูƒู„ุฉ ูŠู…ูƒู† ุงุณุชุฎุฏุงู…ู‡ ููŠ ุงู„ู…ุดุฑูˆุน. ูˆู…ุน ุฐู„ูƒุŒ ุฅุฐุง ุณู„ู…ุช ู†ูˆุน ุงู„ุณู„ุณู„ุฉ ุงู„ุฑู‚ู…ูŠุฉ ู…ู† ุงู„ุจุฏุงูŠุฉุŒ ูู‚ุฏ ูŠูƒูˆู† ู…ุนุฑู ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ.", + "description": "ู…ุนุฑู ุงู„ู…ุดูƒู„ุฉ. ููŠ ุจุนุถ ุงู„ุฃุญูŠุงู†ุŒ ูŠู…ูƒู† ู„ู„ู…ุณุชุฎุฏู… ุฃู† ูŠุฐูƒุฑ ุงุณู… ู†ูˆุน ุงู„ู…ุดูƒู„ุฉุŒ ู…ุซู„ "bug" ุฃูˆ "story"ุŒ ูˆู„ูƒู† ู„ุง ูŠู…ูƒู†ูƒ ุชุญุฏูŠุฏ ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ ุจุงุณุชุฎุฏุงู… ุงุณู… ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ. ู„ุฃู†ู‡ ู‚ุฏ ูŠูƒูˆู† ู‡ู†ุงูƒ ุฃู†ูˆุงุน ุชุญู…ู„ ู†ูุณ ุงู„ุงุณู…. ู„ุฐู„ูƒุŒ ูŠุฌุจ ุนู„ูŠูƒ ุงู„ุชุญู‚ู‚ ู…ู† ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ ุจุงุณุชุฎุฏุงู… ู…ูˆุตู„ ู…ุฎุชู„ู ู„ู„ุชุฃูƒุฏ ู…ู† ุฃู†ู‡ ู†ูˆุน ู…ุดูƒู„ุฉ ูŠู…ูƒู† ุงุณุชุฎุฏุงู…ู‡ ููŠ ุงู„ู…ุดุฑูˆุน. ูˆู…ุน ุฐู„ูƒุŒ ุฅุฐุง ู‚ู…ุช ุจุชุณู„ูŠู… ู†ูˆุน ุงู„ุณู„ุณู„ุฉ ุงู„ุฑู‚ู…ูŠุฉ ู…ู† ุงู„ุจุฏุงูŠุฉุŒ ูู‚ุฏ ูŠูƒูˆู† ู…ุนุฑู ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ.", "title": "ู…ุนุฑู ู†ูˆุน ุงู„ู…ุดูƒู„ุฉ", "oneOf": [ { @@ -40193,7 +40193,7 @@ "traffic" ], "title": "ุฃูุถู„ ู…ุง ููŠ ุงู„ุฃู…ุฑ ู‡ูˆ ุงู„ุญุตูˆู„ ุนู„ู‰ ุงู„ู…ุงู„", - "description": "ู‡ุฐุง ู‡ูˆ ุงู„ุณุจุจ ููŠ ุฃู† ู‡ุฐุง ู‡ูˆ ุงู„ุญุงู„ ุจุงู„ู†ุณุจุฉ ู„ูƒ..", + "description": "ู‡ุฐุง ู‡ูˆ ุงู„ุณุจุจ ููŠ ุฃู† ู‡ุฐุง ู‡ูˆ ุงู„ุณุจุจ ููŠ ุฐู„ูƒ..", "type": "object" }, "_namespace_swagger.IGoogleTrend.IRequest": { @@ -44057,7 +44057,7 @@ "_namespace_swagger.IGithub.ReviewComment": { "properties": { "pull_request_review_id": { - "title": "ุณุญุจ ุทู„ุจ ุงู„ู…ุฑุงุฌุนุฉ", + "title": "ู…ุนุฑู ุทู„ุจ ุงู„ู…ุฑุงุฌุนุฉ", "type": "integer" }, "diff_hunk": { @@ -46664,7 +46664,7 @@ "type": "string" }, "profile_repository": { - "title": "ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ_ุงู„ู…ุณุชูˆุฏุน", + "title": "ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ ู„ู„ู…ุณุชูˆุฏุน", "oneOf": [ { "type": "null" @@ -49189,7 +49189,7 @@ "_namespace_swagger.IDiscord.ICreateDMRequest": { "properties": { "recipient_id": { - "title": "ุณูˆู†ู…ุง", + "title": "ุณู†ูˆุจูˆ", "description": "DM ู‡ูˆ ุนู†ูˆุงู† ุงู„ุจุฑูŠุฏ ุงู„ุฅู„ูƒุชุฑูˆู†ูŠ ุงู„ุฎุงุต ุจู†ุง.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:user.id, label:user.username}", @@ -49452,7 +49452,7 @@ "name", "secretKey" ], - "title": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุจุทุงู‚ุฉ ุงู„ุงุฆุชู…ุงู† ุงู„ุฎุงุตุฉ ุจูƒ", + "title": "ู…ุง ุนู„ูŠูƒ ุณูˆู‰ ุงู„ุงุชุตุงู„ ุจู†ุง", "type": "object" }, "_namespace_swagger.IDiscord.ISecret": { @@ -49544,7 +49544,7 @@ "userId", "secretKey" ], - "title": "ุฃูุถู„ ู…ุง ููŠ ุงู„ุฃู…ุฑ ู‡ูˆ ุงู„ุญุตูˆู„ ุนู„ู‰ ุจุทุงู‚ุฉ ุงู„ุงุฆุชู…ุงู† ุงู„ุฎุงุตุฉ ุจูƒ", + "title": "ุฃูุถู„ ู…ุง ููŠ ุงู„ุฃู…ุฑ ู‡ูˆ ุงู„ุญุตูˆู„ ุนู„ู‰ ุจุทุงู‚ุฉ ุงู„ุงุฆุชู…ุงู†", "type": "object" }, "_namespace_swagger.IDiscord.IModifyChannelRequest": { @@ -52015,7 +52015,7 @@ "maxLength": 55, "title": "ุงุณู…", "description": "ุงุณู… ู†ูˆุน ุงู„ุญุฏุซ", - "x-wrtn-placeholder": "ุงุฌุชู…ุงุนู‰", + "x-wrtn-placeholder": "ุงุฌุชู…ุงุนูŠ", "type": "string" }, "host": { @@ -54616,7 +54616,7 @@ }, "GlobalCategoryRank": { "title": "ุงู„ุชุตู†ูŠู ุงู„ุนุงู„ู…ูŠ ู„ู„ูุฆุฉ", - "description": "ุงู„ุชุตู†ูŠู ุงู„ุนุงู„ู…ูŠ ู„ู„ูุฆุฉ" + "description": "ุชุตู†ูŠู ุงู„ูุฆุฉ ุงู„ุนุงู„ู…ูŠุฉ" }, "IsSmall": { "title": "ู‡ู„ ู‡ูˆ ุตุบูŠุฑุŸ", diff --git a/assets/output/marketing.swagger.ja.json b/assets/output/marketing.swagger.ja.json index 030e8a6..0cf7133 100644 --- a/assets/output/marketing.swagger.ja.json +++ b/assets/output/marketing.swagger.ja.json @@ -156,7 +156,7 @@ } }, "summary": "ใ‚ญใƒผใƒฏใƒผใƒ‰ๆŠฝๅ‡บ", - "description": "ไธŽใˆใ‚‰ใ‚ŒใŸๅ…ฅๅŠ›ใซ้–ข้€ฃๆ€งใฎ้ซ˜ใ„ใ‚ญใƒผใƒฏใƒผใƒ‰ใ‚’ๆŠฝๅ‡บใ—ใพใ™ใ€‚ใƒžใƒผใ‚ฑใƒ†ใ‚ฃใƒณใ‚ฐใ‚ณใƒ”ใƒผใ‚’็”Ÿๆˆใ™ใ‚‹ใจใใซไฝฟ็”จใ™ใ‚‹ใ‚ณใƒใ‚ฏใ‚ฟใงใ™ใ€‚.", + "description": "ไธŽใˆใ‚‰ใ‚ŒใŸๅ…ฅๅŠ›ใซ้–ข้€ฃๆ€งใฎ้ซ˜ใ„ใ‚ญใƒผใƒฏใƒผใƒ‰ใ‚’ๆŠฝๅ‡บใ—ใพใ™ใ€‚ใƒžใƒผใ‚ฑใƒ†ใ‚ฃใƒณใ‚ฐใ‚ณใƒ”ใƒผใ‚’็”Ÿๆˆใ™ใ‚‹ใจใใซไฝฟ็”จใ•ใ‚Œใ‚‹ใ‚ณใƒใ‚ฏใ‚ฟใงใ™ใ€‚.", "tags": [] } }, @@ -172,7 +172,7 @@ } } }, - "description": "ไธฆในๆ›ฟใˆใ‚‹ๅ€™่ฃœ่€…ๆƒ…ๅ ฑ", + "description": "ไธฆในๆ›ฟใˆใ‚‹ๅ€™่ฃœๆƒ…ๅ ฑ", "required": true }, "responses": { @@ -188,7 +188,7 @@ } }, "summary": "ๆกไปถใงไธฆในๆ›ฟใˆ", - "description": "ๆŒ‡ๅฎšใ•ใ‚ŒใŸใ‚ขใ‚คใƒ†ใƒ ใฎ้…ๅˆ—ใ‚’ๆœ€้ซ˜ใ‚นใ‚ณใ‚ขใฎ้ †ใซไธฆในๆ›ฟใˆใพใ™", + "description": "ๆŒ‡ๅฎšใ•ใ‚ŒใŸใ‚ขใ‚คใƒ†ใƒ ใฎ้…ๅˆ—ใ‚’ๆœ€้ซ˜ใ‚นใ‚ณใ‚ข้ †ใซไธฆในๆ›ฟใˆใพใ™", "tags": [], "deprecated": true } @@ -3222,7 +3222,7 @@ "description": "ใ‚คใƒ™ใƒณใƒˆๆƒ…ๅ ฑใ‚’ๅซใ‚€DTO." } }, - "summary": "ใ‚ซใ‚ซใ‚ชใƒˆใƒผใ‚ฏ(์นด์นด์˜คํ†ก)ใ‚ซใƒฌใƒณใƒ€ใƒผใ‚คใƒ™ใƒณใƒˆใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "summary": "ใ‚ซใ‚ซใ‚ชใƒˆใƒผใ‚ฏ(์นด์นด์˜คํ†ก)ใฎใ‚ซใƒฌใƒณใƒ€ใƒผใ‚คใƒ™ใƒณใƒˆใ‚’ๅ–ๅพ—ใ™ใ‚‹", "description": "KakaoTalk(ใ‚ซใ‚ซใ‚ชใƒˆใƒผใ‚ฏ) ใ‚ซใƒฌใƒณใƒ€ใƒผใ‚คใƒ™ใƒณใƒˆใ‚’ๅ–ๅพ—ใ—ใพใ™ใ€‚ใƒฆใƒผใ‚ถใƒผใฏๅ…ฅๅŠ›ใƒ‘ใƒฉใƒกใƒผใ‚ฟใจใ—ใฆใ‚ซใƒฌใƒณใƒ€ใƒผ ID ใ‚’ๆŒ‡ๅฎšใ™ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚ใ‚ซใƒฌใƒณใƒ€ใƒผใŒๆŒ‡ๅฎšใ•ใ‚Œใฆใ„ใชใ„ๅ ดๅˆใฏใ€ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใงใƒฆใƒผใ‚ถใƒผ่‡ช่บซใฎใ‚ซใƒฌใƒณใƒ€ใƒผใŒๅ–ๅพ—ใ•ใ‚Œใพใ™ใ€‚ใ—ใŸใŒใฃใฆใ€ใ“ใฎๆฉŸ่ƒฝใฏใ‚ซใƒฌใƒณใƒ€ใƒผ ID ใŒๆŒ‡ๅฎšใ•ใ‚Œใฆใ„ใชใใฆใ‚‚ไฝฟ็”จใงใใพใ™ใ€‚ใ‚คใƒ™ใƒณใƒˆใ‚’ๅ–ๅพ—ใ™ใ‚‹ใŸใ‚ใฎๆกไปถใซใฏใ€ใ‚คใƒ™ใƒณใƒˆใ‚’ๅ–ๅพ—ใ™ใ‚‹ๆœŸ้–“ใฎๆŒ‡ๅฎšใŒๅซใพใ‚Œใพใ™ใ€‚ใ“ใฎใ‚ณใƒใ‚ฏใ‚ฟใฏใ€1 ้€ฑ้–“ใพใŸใฏ 1 ใ‹ๆœˆใฎใƒ‡ใƒผใ‚ฟใ‚’่กจ็คบใ™ใ‚‹ใ‚ˆใ†ใซ่จญ่จˆใ•ใ‚Œใฆใ„ใพใ™ใ€‚KakaoTalk(ใ‚ซใ‚ซใ‚ชใƒˆใƒผใ‚ฏ) ใฏ้Ÿ“ๅ›ฝใฎใƒขใƒใ‚คใƒซ ใƒกใƒƒใ‚ปใƒผใ‚ธใƒณใ‚ฐ ใ‚ขใƒ—ใƒชใ‚ฑใƒผใ‚ทใƒงใƒณใงใ‚ใ‚Šใ€่ฟฝๅŠ ใฎใ‚ตใƒผใƒ“ใ‚นใ‚‚ๆไพ›ใ—ใฆใ„ใพใ™ใ€‚.", "tags": [ "KakaoTalk" @@ -5444,7 +5444,7 @@ } }, "summary": "Rutten ใ‚’็ฎก็†่€…ใจใ—ใฆ็™ป้Œฒใ™ใ‚‹", - "description": "Rutten ใ‚’ใƒฆใƒผใ‚ถใƒผใฎๅบƒๅ‘Šใ‚ขใ‚ซใ‚ฆใƒณใƒˆ็ฎก็†่€…ใซๆŒ‡ๅฎšใ—ใพใ™ใ€‚็‰นๅฎšใฎ Google ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎ Google ๅบƒๅ‘Š API ใ‚’ๅ‘ผใณๅ‡บใ™ใซใฏใ€ๅบƒๅ‘Šใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’ๆ‰€ๆœ‰ใ—ใฆใ„ใ‚‹ใ‹ใ€็ฎก็†่€…ใจใ—ใฆ็™ป้Œฒใ•ใ‚Œใฆใ„ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚ใ“ใฎใ‚ณใƒใ‚ฏใ‚ฟใฏใ€ใƒฆใƒผใ‚ถใƒผใฎใ™ในใฆใฎ Google ๅบƒๅ‘Šใ‚ขใ‚ซใ‚ฆใƒณใƒˆใซใ€`Wrtn` ๅบƒๅ‘Šใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’้กงๅฎขใฎ็ฎก็†่€…ใจใ—ใฆ็™ป้Œฒใ™ใ‚‹ใŸใ‚ใฎไธ€็จฎใฎๆ‹›ๅพ…็Šถใ‚’้€ไฟกใ™ใ‚‹ใ‚ณใƒใ‚ฏใ‚ฟใงใ™ใ€‚ใ‚ณใƒใ‚ฏใ‚ฟใ‚’ๅฎŸ่กŒใ™ใ‚‹ใจใ€้กงๅฎขใ‚ขใ‚ซใ‚ฆใƒณใƒˆใซ็™ป้Œฒใ•ใ‚ŒใŸใƒกใƒผใƒซใŒ Gmail ็ตŒ็”ฑใง้€ไฟกใ•ใ‚Œใพใ™ใ€‚ใƒกใƒผใƒซใ‚’ๅ—ใ‘ๅ–ใฃใŸไบบใฏใ€ใƒกใƒผใƒซใ‚’้€šใ˜ใฆใƒ€ใƒƒใ‚ทใƒฅใƒœใƒผใƒ‰ใซ็งปๅ‹•ใ—ใ€`Wrtn` ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใซ็ฎก็†่€…ๆจฉ้™ใ‚’ไธŽใˆใ‚‹ใ“ใจใŒใงใใพใ™ใ€‚`Wrtn` ใŒ็ฎก็†่€…ใจใ—ใฆ็™ป้Œฒใ•ใ‚Œใฆใ„ใ‚‹ๅ ดๅˆใ€Google ๅบƒๅ‘Šใงไฝœๆˆใ•ใ‚ŒใŸไป–ใฎ API ใ‚’ไฝฟ็”จใงใใ‚‹ใ‚ˆใ†ใซใชใ‚Šใพใ™ใ€‚ใ“ใฎ็ฎก็†่€…ๆŒ‡ๅฎšใฏใ€ใ‚ญใƒผใƒฏใƒผใƒ‰ๆŽจๅฅจใชใฉใ€`customerId` ใ‚’ๅผ•ๆ•ฐใจใ—ใฆๅ—ใ‘ๅ–ใ‚‰ใชใ„ใ‚ณใƒใ‚ฏใ‚ฟใ‚’้™คใใ™ในใฆใฎ Google ๅบƒๅ‘Šใ‚ณใƒใ‚ฏใ‚ฟใ‚’ๅ‘ผใณๅ‡บใ™ๅ‰ใซ่กŒใ†ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚ใŸใ ใ—ใ€ใ“ใฎใ‚ณใƒใ‚ฏใ‚ฟใŒๅ‘ผใณๅ‡บใ•ใ‚Œใฆใ‚‚ใ€ใƒฆใƒผใ‚ถใƒผใฎๆ‰ฟ่ชใชใ—ใซ `Wrtn` ใŒ็ฎก็†่€…ใซๆŒ‡ๅฎšใ•ใ‚Œใ‚‹ใ“ใจใฏใ‚ใ‚Šใพใ›ใ‚“ใฎใงใ€ๅฟƒ้…ใ™ใ‚‹ๅฟ…่ฆใฏใ‚ใ‚Šใพใ›ใ‚“ใ€‚้–ขๆ•ฐใ‚’ๅ‘ผใณๅ‡บใ™ๅ‰ใซใ€ใƒฆใƒผใ‚ถใƒผใซ `customerId` ใ‚’ๅฐ‹ใญใ‚‹ๅฟ…่ฆใŒใ‚ใ‚‹ใŸใ‚ใ€ `customerId` ใ‚’ใƒใ‚งใƒƒใ‚ฏใงใใ‚‹ใ‚ณใƒใ‚ฏใ‚ฟใ‚’ๆๆกˆใ™ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚.", + "description": "ใƒฆใƒผใ‚ถใƒผใฎๅบƒๅ‘Šใ‚ขใ‚ซใ‚ฆใƒณใƒˆ็ฎก็†่€…ใซ Rutten ใ‚’ๆŒ‡ๅฎšใ—ใพใ™ใ€‚็‰นๅฎšใฎ Google ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎ Google ๅบƒๅ‘Š API ใ‚’ๅ‘ผใณๅ‡บใ™ใซใฏใ€ๅบƒๅ‘Šใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’ๆ‰€ๆœ‰ใ—ใฆใ„ใ‚‹ใ‹ใ€็ฎก็†่€…ใจใ—ใฆ็™ป้Œฒใ•ใ‚Œใฆใ„ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚ใ“ใฎใ‚ณใƒใ‚ฏใ‚ฟใฏใ€ใƒฆใƒผใ‚ถใƒผใฎใ™ในใฆใฎ Google ๅบƒๅ‘Šใ‚ขใ‚ซใ‚ฆใƒณใƒˆใซใ€`Wrtn` ๅบƒๅ‘Šใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’้กงๅฎขใฎ็ฎก็†่€…ใจใ—ใฆ็™ป้Œฒใ™ใ‚‹ใŸใ‚ใฎไธ€็จฎใฎๆ‹›ๅพ…็Šถใ‚’้€ไฟกใ™ใ‚‹ใ‚ณใƒใ‚ฏใ‚ฟใงใ™ใ€‚ใ‚ณใƒใ‚ฏใ‚ฟใ‚’ๅฎŸ่กŒใ™ใ‚‹ใจใ€้กงๅฎขใ‚ขใ‚ซใ‚ฆใƒณใƒˆใซ็™ป้Œฒใ•ใ‚ŒใŸใƒกใƒผใƒซใŒ Gmail ็ตŒ็”ฑใง้€ไฟกใ•ใ‚Œใพใ™ใ€‚ใƒกใƒผใƒซใ‚’ๅ—ใ‘ๅ–ใฃใŸไบบใฏใ€ใƒกใƒผใƒซใ‚’้€šใ˜ใฆใƒ€ใƒƒใ‚ทใƒฅใƒœใƒผใƒ‰ใซ็งปๅ‹•ใ—ใ€`Wrtn` ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใซ็ฎก็†่€…ๆจฉ้™ใ‚’ไธŽใˆใ‚‹ใ“ใจใŒใงใใพใ™ใ€‚`Wrtn` ใŒ็ฎก็†่€…ใจใ—ใฆ็™ป้Œฒใ•ใ‚Œใฆใ„ใ‚‹ๅ ดๅˆใ€Google ๅบƒๅ‘Šใงไฝœๆˆใ•ใ‚ŒใŸไป–ใฎ API ใ‚’ไฝฟ็”จใงใใ‚‹ใ‚ˆใ†ใซใชใ‚Šใพใ™ใ€‚ใ“ใฎ็ฎก็†่€…ๆŒ‡ๅฎšใฏใ€ใ‚ญใƒผใƒฏใƒผใƒ‰ๆŽจๅฅจใชใฉใ€`customerId` ใ‚’ๅผ•ๆ•ฐใจใ—ใฆๅ—ใ‘ๅ–ใ‚‰ใชใ„ใ‚ณใƒใ‚ฏใ‚ฟใ‚’้™คใใ™ในใฆใฎ Google ๅบƒๅ‘Šใ‚ณใƒใ‚ฏใ‚ฟใ‚’ๅ‘ผใณๅ‡บใ™ๅ‰ใซ่กŒใ†ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚ใŸใ ใ—ใ€ใ“ใฎใ‚ณใƒใ‚ฏใ‚ฟใŒๅ‘ผใณๅ‡บใ•ใ‚Œใฆใ‚‚ใ€ใƒฆใƒผใ‚ถใƒผใฎๆ‰ฟ่ชใชใ—ใซ `Wrtn` ใŒ็ฎก็†่€…ใจใ—ใฆๆŒ‡ๅฎšใ•ใ‚Œใ‚‹ใ“ใจใฏใ‚ใ‚Šใพใ›ใ‚“ใฎใงใ€ๅฟƒ้…ใ™ใ‚‹ๅฟ…่ฆใฏใ‚ใ‚Šใพใ›ใ‚“ใ€‚้–ขๆ•ฐใ‚’ๅ‘ผใณๅ‡บใ™ๅ‰ใซใ€ใƒฆใƒผใ‚ถใƒผใซ`customerId`ใ‚’ๅฐ‹ใญใ‚‹ๅฟ…่ฆใŒใ‚ใ‚‹ใŸใ‚ใ€`customerId`ใ‚’ใƒใ‚งใƒƒใ‚ฏใงใใ‚‹ใ‚ณใƒใ‚ฏใ‚ฟใ‚’ๆๆกˆใ™ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚.", "tags": [ "Google Ads" ] @@ -5482,7 +5482,7 @@ } }, "summary": "ๅบƒๅ‘Šใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’ๅ–ๅพ—", - "description": "้กงๅฎขใฎๅบƒๅ‘Šใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’ๅ–ๅพ—ใ™ใ‚‹ ใƒฆใƒผใ‚ถใƒผใฎใ‚ขใ‚ฏใ‚ปใ‚นใƒˆใƒผใ‚ฏใƒณใ‚’ไฝฟ็”จใ—ใฆใ€`Wrtn` ใŒ็ฎก็†่€…ใงใ‚ใ‚‹ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎไธญใ‹ใ‚‰ใ€ใƒฆใƒผใ‚ถใƒผใฎๅบƒๅ‘Šใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ€ใคใพใ‚Š `customer` ใ‚’ๆคœ็ดขใ—ใพใ™ใ€‚ใƒฆใƒผใ‚ถใƒผใŒๅบƒๅ‘Šใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’ๆŒใฃใฆใ„ใฆใ‚‚ใ€`Wrtn` ใŒ็ฎก็†่€…ใงใชใ„ๅ ดๅˆใฏใƒชใ‚นใƒˆใ•ใ‚Œใพใ›ใ‚“ใ€‚ใ—ใŸใŒใฃใฆใ€`Wrtn` ใŒ็ฎก็†่€…ใจใ—ใฆ็™ป้Œฒใ•ใ‚ŒใŸใ“ใจใŒใชใ„ๅ ดๅˆใฏใ€`POST connector/google-ads/customerClientLink` ใ‚ณใƒใ‚ฏใ‚ฟใ‚’ๅ‘ผใณๅ‡บใ™ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚ใพใŸใ€ใ“ใฎใ‚ณใƒใ‚ฏใ‚ฟใฏใ€้Ÿ“ๅ›ฝใฎ้€š่ฒจๅ˜ไฝ `KRW` ใ‚’ไฝฟ็”จใ—ใฆใ„ใชใ„ๅบƒๅ‘Šใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’้™คๅค–ใ—ใพใ™ใ€‚ใ“ใ‚Œใฏใ€ไปŠๅพŒใ€ไป–ใฎใ‚ญใƒฃใƒณใƒšใƒผใƒณไบˆ็ฎ—ใฎๅค‰ๆ›ดใ‚„ๅบƒๅ‘Šใ‚นใƒ†ใƒผใ‚ฟใ‚นใฎๅค‰ๆ›ดใ‚ณใƒใ‚ฏใ‚ฟใง้–“้•ใ„ใŒ็™บ็”Ÿใ—ใชใ„ใ‚ˆใ†ใซใ™ใ‚‹ใŸใ‚ใงใ™ใ€‚Google Ads ใ‚ณใƒใ‚ฏใ‚ฟใ‚’ไฝฟ็”จใ—ใฆๅบƒๅ‘Šใ‚’ไฝœๆˆใ™ใ‚‹ๅ ดๅˆใ€ๅ„ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎ้€š่ฒจๅ˜ไฝใซๅฟœใ˜ใฆไบˆ็ฎ—่จญๅฎšใงไบบ็‚บ็š„ใ‚จใƒฉใƒผใŒ็™บ็”Ÿใ™ใ‚‹ๅฏ่ƒฝๆ€งใŒใ‚ใ‚Šใพใ™ใ€‚ใŸใจใˆใฐใ€้€š่ฒจๅ˜ไฝใŒ `USD` ใฎใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎไบˆ็ฎ—ใ‚’ใ€้€š่ฒจๅ˜ไฝใŒ `KRW` ใฎใ‚ขใ‚ซใ‚ฆใƒณใƒˆใจใ—ใฆ็™ป้Œฒใ™ใ‚‹ใจใ€็‚บๆ›ฟใƒฌใƒผใƒˆใฎไบˆ็ฎ—ๅทฎใŒ็™บ็”Ÿใ™ใ‚‹ๅฏ่ƒฝๆ€งใŒใ‚ใ‚Šใพใ™ใ€‚้–ขๆ•ฐใ‚’ๅ‘ผใณๅ‡บใ™ๅ‰ใซใ€ใƒฆใƒผใ‚ถใƒผใซ `customerId` ใ‚’ๅฐ‹ใญใ‚‹ๅฟ…่ฆใŒใ‚ใ‚‹ใŸใ‚ใ€ `customerId` ใ‚’ใƒใ‚งใƒƒใ‚ฏใงใใ‚‹ใ‚ณใƒใ‚ฏใ‚ฟใ‚’ๆๆกˆใ™ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚.", + "description": "้กงๅฎขใฎๅบƒๅ‘Šใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’ๅ–ๅพ—ใ™ใ‚‹ ใƒฆใƒผใ‚ถใƒผใฎใ‚ขใ‚ฏใ‚ปใ‚นใƒˆใƒผใ‚ฏใƒณใ‚’ไฝฟ็”จใ—ใฆใ€`Wrtn` ใŒ็ฎก็†่€…ใงใ‚ใ‚‹ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎไธญใ‹ใ‚‰ใ€ใƒฆใƒผใ‚ถใƒผใฎๅบƒๅ‘Šใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ€ใคใพใ‚Š `customer` ใ‚’ๆคœ็ดขใ—ใพใ™ใ€‚ใƒฆใƒผใ‚ถใƒผใŒๅบƒๅ‘Šใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’ๆŒใฃใฆใ„ใฆใ‚‚ใ€`Wrtn` ใŒ็ฎก็†่€…ใงใชใ„ๅ ดๅˆใฏใƒชใ‚นใƒˆใ•ใ‚Œใพใ›ใ‚“ใ€‚ใ—ใŸใŒใฃใฆใ€`Wrtn` ใŒ็ฎก็†่€…ใจใ—ใฆ็™ป้Œฒใ•ใ‚ŒใŸใ“ใจใŒใชใ„ๅ ดๅˆใฏใ€`POST connector/google-ads/customerClientLink` ใ‚ณใƒใ‚ฏใ‚ฟใ‚’ๅ‘ผใณๅ‡บใ™ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚ใพใŸใ€ใ“ใฎใ‚ณใƒใ‚ฏใ‚ฟใฏใ€้Ÿ“ๅ›ฝใฎ้€š่ฒจๅ˜ไฝ `KRW` ใ‚’ไฝฟ็”จใ—ใฆใ„ใชใ„ๅบƒๅ‘Šใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚’้™คๅค–ใ—ใพใ™ใ€‚ใ“ใ‚Œใฏใ€ไปŠๅพŒใ€ไป–ใฎใ‚ญใƒฃใƒณใƒšใƒผใƒณไบˆ็ฎ—ใฎๅค‰ๆ›ดใ‚„ๅบƒๅ‘Šใ‚นใƒ†ใƒผใ‚ฟใ‚นใฎๅค‰ๆ›ดใ‚ณใƒใ‚ฏใ‚ฟใง้–“้•ใ„ใŒ็™บ็”Ÿใ—ใชใ„ใ‚ˆใ†ใซใ™ใ‚‹ใŸใ‚ใงใ™ใ€‚Google Ads ใ‚ณใƒใ‚ฏใ‚ฟใ‚’ไฝฟ็”จใ—ใฆๅบƒๅ‘Šใ‚’ไฝœๆˆใ™ใ‚‹ๅ ดๅˆใ€ๅ„ใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎ้€š่ฒจๅ˜ไฝใซๅฟœใ˜ใฆไบˆ็ฎ—่จญๅฎšใงไบบ็‚บ็š„ใ‚จใƒฉใƒผใŒ็™บ็”Ÿใ™ใ‚‹ๅฏ่ƒฝๆ€งใŒใ‚ใ‚Šใพใ™ใ€‚ใŸใจใˆใฐใ€้€š่ฒจๅ˜ไฝใŒ `USD` ใฎใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎไบˆ็ฎ—ใ‚’ใ€้€š่ฒจๅ˜ไฝใŒ `KRW` ใฎใ‚ขใ‚ซใ‚ฆใƒณใƒˆใจใ—ใฆ็™ป้Œฒใ™ใ‚‹ใจใ€็‚บๆ›ฟใƒฌใƒผใƒˆใฎไบˆ็ฎ—ๅทฎใŒ็™บ็”Ÿใ™ใ‚‹ๅฏ่ƒฝๆ€งใŒใ‚ใ‚Šใพใ™ใ€‚้–ขๆ•ฐใ‚’ๅ‘ผใณๅ‡บใ™ๅ‰ใซใ€ใƒฆใƒผใ‚ถใƒผใซ`customerId`ใ‚’ๅฐ‹ใญใ‚‹ๅฟ…่ฆใŒใ‚ใ‚‹ใŸใ‚ใ€`customerId`ใ‚’ใƒใ‚งใƒƒใ‚ฏใงใใ‚‹ใ‚ณใƒใ‚ฏใ‚ฟใ‚’ๆๆกˆใ™ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™ใ€‚.", "tags": [ "Google Ads" ] @@ -8537,7 +8537,7 @@ } }, "summary": "ๅ•้กŒใฎใ‚นใƒ†ใƒผใ‚ฟใ‚นใ‚’็ขบ่ชใ™ใ‚‹", - "description": "ๅ•้กŒใฎๆคœ็ดขใซ้–ขใ™ใ‚‹ๅ•้กŒใฎใ‚นใƒ†ใƒผใ‚ฟใ‚นใ‚’่ฆ‹ใคใ‘ใ‚‹", + "description": "ๅ•้กŒใ‚’ๆคœ็ดขใ™ใ‚‹ใŸใ‚ใฎๅ•้กŒใ‚นใƒ†ใƒผใ‚ฟใ‚นใ‚’่ฆ‹ใคใ‘ใ‚‹", "tags": [ "Jira" ] @@ -12700,7 +12700,7 @@ "type": "string" }, "type": { - "description": "ใƒ“ใƒ‡ใ‚ชใ€็”ปๅƒใ€ใƒ‹ใƒฅใƒผใ‚น่จ˜ไบ‹ใ€็ ”็ฉถ่ซ–ๆ–‡ ๆฌกใฎใ„ใšใ‚Œใ‹ใงใ‚ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™: ใƒ“ใƒ‡ใ‚ชใ€็”ปๅƒใ€ใƒ‹ใƒฅใƒผใ‚น่จ˜ไบ‹ใ€็ ”็ฉถ่ซ–ๆ–‡", + "description": "ใƒ“ใƒ‡ใ‚ชใ€็”ปๅƒใ€ใƒ‹ใƒฅใƒผใ‚น่จ˜ไบ‹ใ€็ ”็ฉถ่ซ–ๆ–‡ ๆฌกใฎใฉใ‚Œใ‹ใงใ‚ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™: ใƒ“ใƒ‡ใ‚ชใ€็”ปๅƒใ€ใƒ‹ใƒฅใƒผใ‚น่จ˜ไบ‹ใ€็ ”็ฉถ่ซ–ๆ–‡", "title": "ๅ‡บๅŠ›ใ‚ฟใ‚คใƒ—", "oneOf": [ { @@ -14170,7 +14170,7 @@ "properties": { "url": { "title": "ใ‚ทใƒผใƒˆใฎURL", - "description": "่กŒใ‚’่ชญใฟๅ–ใ‚‹ใ‚ทใƒผใƒˆใฎ URL.", + "description": "่กŒใ‚’่ชญใฟๅ–ใ‚‹ใ‚ทใƒผใƒˆใฎURL.", "type": "string" }, "workSheetTitle": { @@ -15548,7 +15548,7 @@ "properties": { "email": { "format": "email", - "title": "ใ‚ขใ‚ฏใ‚ปใ‚นใ‚’่จฑๅฏใ™ใ‚‹ใƒฆใƒผใ‚ถใƒผใฎใƒกใƒผใƒซใ‚ขใƒ‰ใƒฌใ‚น", + "title": "ใ‚ขใ‚ฏใ‚ปใ‚นใ‚’่จฑๅฏใ—ใŸใ„ใƒฆใƒผใ‚ถใƒผใฎใƒกใƒผใƒซใ‚ขใƒ‰ใƒฌใ‚น", "description": "Google ใƒ‰ใƒฉใ‚คใƒ–ใธใฎใ‚ขใ‚ฏใ‚ปใ‚นใ‚’่จฑๅฏใ™ใ‚‹ใƒฆใƒผใ‚ถใƒผใฎใƒกใƒผใƒซใ‚ขใƒ‰ใƒฌใ‚นใ€‚ใ‚ฟใ‚คใƒ—ใŒใƒฆใƒผใ‚ถใƒผใ‚ฟใ‚คใƒ—ใฎๅ ดๅˆใซใฎใฟๅฟ…่ฆใงใ™ใ€‚.", "type": "string" }, @@ -16396,7 +16396,7 @@ }, "labelIds": { "title": "ใƒ•ใ‚ฃใƒซใ‚ฟใƒชใƒณใ‚ฐใ™ใ‚‹ใƒฉใƒ™ใƒซใฎใƒชใ‚นใƒˆ", - "description": "ๆŒ‡ๅฎšใ•ใ‚ŒใŸใƒฉใƒ™ใƒซIDใซไธ€่‡ดใ™ใ‚‹ใƒฉใƒ™ใƒซใ‚’ๆŒใคใƒกใƒผใƒซใฎใฟใ‚’่ฟ”ใ™ใƒฉใƒ™ใƒซใฎใƒชใ‚นใƒˆ.", + "description": "ๆŒ‡ๅฎšใ•ใ‚ŒใŸใƒฉใƒ™ใƒซ ID ใซใ™ในใฆไธ€่‡ดใ™ใ‚‹ใƒฉใƒ™ใƒซใ‚’ๆŒใคใƒกใƒผใƒซใฎใฟใ‚’่ฟ”ใ™ใƒฉใƒ™ใƒซใฎใƒชใ‚นใƒˆ.", "items": { "type": "string" }, @@ -17375,7 +17375,7 @@ "secretKey", "message" ], - "description": "็‰นๅฎšใฎ้ ˜ๅŸŸใซใ‚ณใƒกใƒณใƒˆใ‚’่ฟฝๅŠ ใ™ใ‚‹ใŸใ‚ใฎDTOใ€‚ไธ€ๅบฆใซ1ใคใฎใ‚ณใƒกใƒณใƒˆใ‚’ๆ›ธใ่พผใ‚€ใ“ใจใŒใงใใ€ๅบงๆจ™ๅ€คใ€ใƒŽใƒผใƒ‰ใ€ใพใŸใฏ่ฆชใ‚ณใƒกใƒณใƒˆ๏ผˆใƒซใƒผใƒˆใ‚ณใƒกใƒณใƒˆ๏ผ‰ใ‚’ไฝฟ็”จใ—ใฆใ‚ณใƒกใƒณใƒˆใ‚’ๆ›ธใ่พผใ‚€ใ“ใจใŒใงใใพใ™ใ€‚.", + "description": "็‰นๅฎšใฎ้ ˜ๅŸŸใซใ‚ณใƒกใƒณใƒˆใ‚’่ฟฝๅŠ ใ™ใ‚‹ใŸใ‚ใฎ DTOใ€‚ไธ€ๅบฆใซ 1 ใคใฎใ‚ณใƒกใƒณใƒˆใ‚’ๆ›ธใ่พผใ‚€ใ“ใจใŒใงใใ€ๅบงๆจ™ๅ€คใ€ใƒŽใƒผใƒ‰ใ€ใพใŸใฏ่ฆชใ‚ณใƒกใƒณใƒˆ (ใƒซใƒผใƒˆใ‚ณใƒกใƒณใƒˆ) ใ‚’ไฝฟ็”จใ—ใฆใ‚ณใƒกใƒณใƒˆใ‚’ๆ›ธใ่พผใ‚€ใ“ใจใŒใงใใพใ™ใ€‚.", "type": "object" }, "_namespace_swagger.GetCommentsResponse": { @@ -19047,7 +19047,7 @@ "_namespace_swagger.ISweetTracker.TrackingDetail": { "properties": { "code": { - "title": "้…้€ใ‚นใƒ†ใƒผใ‚ฟใ‚นใ‚ณใƒผใƒ‰", + "title": "้…้€็Šถๆณใ‚ณใƒผใƒ‰", "oneOf": [ { "type": "null" @@ -19956,7 +19956,7 @@ "contents": { "minItems": 2, "maxItems": 3, - "title": "ใƒชใ‚นใƒˆใซ่กจ็คบใ•ใ‚Œใ‚‹ใ‚ณใƒณใƒ†ใƒณใƒ„ใฎไธ€่ฆง", + "title": "ใƒชใ‚นใƒˆใซ่กจ็คบใ•ใ‚Œใ‚‹ใ‚ณใƒณใƒ†ใƒณใƒ„ใฎใƒชใ‚นใƒˆ", "items": { "oneOf": [ { @@ -20473,7 +20473,7 @@ "type": "integer" }, "after_url": { - "title": "ๅ‹้”ใƒชใ‚นใƒˆใฎๆฌกใฎใƒšใƒผใ‚ธใฎURL", + "title": "ๆฌกใฎใƒšใƒผใ‚ธใฎๅ‹้”ใƒชใ‚นใƒˆใฎURL", "oneOf": [ { "type": "null" @@ -21459,7 +21459,7 @@ "type": "string" }, "road_address_name": { - "title": "้“่ทฏๅไฝๆ‰€", + "title": "ๅฎŒๅ…จใช้“่ทฏๅไฝๆ‰€", "type": "string" }, "x": { @@ -22019,7 +22019,7 @@ "const": 21 }, { - "title": "ใ‚ขใƒฉใƒ–้ฆ–้•ทๅ›ฝ้€ฃ้‚ฆ5้ƒฝๅธ‚", + "title": "ใ‚ชใƒผใ‚ทใƒฃใƒณใƒ“ใƒฅใƒผ5้šŽ", "const": 22 }, { @@ -23511,7 +23511,7 @@ "type": "boolean" }, "is_culture_benefit": { - "title": "ๆ–‡ๅŒ–ๅ…ฌๆผ”ๆ‰€ๅพ—ๆŽง้™ค", + "title": "ๆ–‡ๅŒ–ใƒ‘ใƒ•ใ‚ฉใƒผใƒžใƒณใ‚นๆ‰€ๅพ—ๆŽง้™ค", "type": "boolean" }, "order_made": { @@ -23544,7 +23544,7 @@ "type": "integer" }, "member_maximum_purchase_quantity": { - "title": "ไผšๅ“กใ”ใจใฎ่ณผๅ…ฅๆœ€ๅคงๆ•ฐ้‡", + "title": "ไผšๅ“กใ”ใจใฎ่ณผๅ…ฅๅฏ่ƒฝๆ•ฐ้‡", "type": "integer" }, "optional_limit_type": { @@ -24364,7 +24364,7 @@ }, "AIS_TP_CD_NM": { "title": "ไพ›็ตฆใ‚ฟใ‚คใƒ—ๅ", - "x-wrtn-placeholder": "ๆ•™่‚ฒๅง”ๅ“กไผš", + "x-wrtn-placeholder": "ใ‚ฐใƒผใƒŸใ‚ธใƒงใƒณ", "type": "string" }, "SBD_LGO_NM": { @@ -24494,7 +24494,7 @@ "title": "ไพ›็ตฆใ‚ฟใ‚คใƒ—ใ‚ณใƒผใƒ‰", "oneOf": [ { - "title": "ๆ•™่‚ฒๅง”ๅ“กไผš", + "title": "ใ‚ฐใƒผใƒŸใ‚ธใƒงใƒณ", "const": "07" }, { @@ -24510,7 +24510,7 @@ "const": "10" }, { - "title": "ใ‚ธใƒฃใƒณใ‚ฏ", + "title": "ใ‚ธใƒฃใ‚ฐใ‚ธใƒผ", "const": "11" }, { @@ -24973,7 +24973,7 @@ ] }, "pmsnoGbCdNm": { - "title": "่จฑๅฏ็•ชๅท ๅˆ†้กžใ‚ณใƒผใƒ‰ๅ", + "title": "่จฑๅฏ็•ชๅทๅˆ†้กžใ‚ณใƒผใƒ‰ๅ", "type": "string" }, "hoCnt": { @@ -25987,7 +25987,7 @@ "nx", "ny" ], - "title": "ๅคฉๆฐ—ไบˆๅ ฑใ‚ฏใ‚จใƒชใฎใƒชใ‚ฏใ‚จใ‚นใƒˆๆกไปถ", + "title": "ๅคฉๆฐ—ใ‚ฏใ‚จใƒชใƒชใ‚ฏใ‚จใ‚นใƒˆๆกไปถ", "type": "object" }, "_namespace_swagger.KoreaCopyrightCommission.IGetCopyRightOutput": { @@ -27255,7 +27255,7 @@ "const": "AREA_OF_INTEREST_ONLY" }, { - "title": "ใƒ“ใƒจใƒณใƒ‰", + "title": "ใƒ“ใ‚ทใ‚งใƒณ", "const": "DISAPPROVED" }, { @@ -27461,7 +27461,7 @@ "const": "AREA_OF_INTEREST_ONLY" }, { - "title": "ใƒ“ใƒจใƒณใƒ‰", + "title": "ใƒ“ใ‚ทใ‚งใƒณ", "const": "DISAPPROVED" }, { @@ -28354,7 +28354,7 @@ "businessName": { "minLength": 1, "maxLength": 25, - "title": "ไบ‹ๆฅญๅใจใƒ–ใƒฉใƒณใƒ‰ๅ", + "title": "ไบ‹ๆฅญๅใŠใ‚ˆใณใƒ–ใƒฉใƒณใƒ‰ๅ", "type": "string" }, "landscapeImages": { @@ -28789,7 +28789,7 @@ "businessName": { "minLength": 1, "maxLength": 25, - "title": "ไบ‹ๆฅญๅใจใƒ–ใƒฉใƒณใƒ‰ๅ", + "title": "ไบ‹ๆฅญๅใŠใ‚ˆใณใƒ–ใƒฉใƒณใƒ‰ๅ", "type": "string" }, "landscapeImages": { @@ -29178,8 +29178,8 @@ "display", "items" ], - "title": "Naver Cafeๆคœ็ดข็ตๆžœใƒ‡ใƒผใ‚ฟ", - "description": "Naver Cafeๆคœ็ดข็ตๆžœใƒ‡ใƒผใ‚ฟ.", + "title": "ใƒใ‚คใƒใƒผใ‚ซใƒ•ใ‚งๆคœ็ดข็ตๆžœใƒ‡ใƒผใ‚ฟ", + "description": "ใƒใ‚คใƒใƒผใ‚ซใƒ•ใ‚งๆคœ็ดข็ตๆžœใƒ‡ใƒผใ‚ฟ.", "type": "object" } }, @@ -29326,7 +29326,7 @@ "properties": { "title": { "title": "ๆŠ•็จฟใ‚ฟใ‚คใƒˆใƒซ", - "description": "Naverใƒ–ใƒญใ‚ฐๆŠ•็จฟใฎใ‚ฟใ‚คใƒˆใƒซ.", + "description": "Naverใƒ–ใƒญใ‚ฐ่จ˜ไบ‹ใฎใ‚ฟใ‚คใƒˆใƒซ.", "type": "string" }, "link": { @@ -34187,7 +34187,7 @@ "const": "3" }, { - "title": "4ๆ™‚้–“ๅ‰", + "title": "4ๆœˆ", "const": "4" }, { @@ -34574,7 +34574,7 @@ "outbound_date": { "format": "date", "title": "ๅ‡บ็™บๆ—ฅ", - "description": "ๅ‡บ็™บๆ—ฅใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚ไปŠๆ—ฅใฎๆ—ฅไป˜ใ‚ˆใ‚ŠๅพŒใฎๆ—ฅไป˜ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„.", + "description": "ๅ‡บ็™บๆ—ฅใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„ใ€‚ๆœฌๆ—ฅไปฅ้™ใฎๆ—ฅไป˜ใ‚’ๅ…ฅๅŠ›ใ—ใฆใใ ใ•ใ„.", "type": "string" }, "return_date": { @@ -35640,7 +35640,7 @@ "type": "string" }, "ts_date": { - "title": "`ts`ใฎๆ—ฅไป˜ๅฝขๅผใ“ใ‚Œใฏใ€็พๅœจใฎๆ™‚ๅˆปๅ€คใ‚’ 'ts' ใงๅŒบๅˆ‡ใฃใฆ่ช่ญ˜ใ—ใ‚„ใ™ใใ™ใ‚‹ใŸใ‚ใซ ISO ๆ–‡ๅญ—ๅˆ—ใซๅค‰ๆ›ดใ•ใ‚ŒใŸๅ€คใงใ™ใ€‚.", + "title": "`ts`ใฎๆ—ฅไป˜ๅฝขๅผใ“ใ‚Œใฏใ€'ts'ใงๅŒบๅˆ‡ใ‚‹ใ“ใจใง็พๅœจใฎๆ™‚ๅˆปๅ€คใ‚’่ช่ญ˜ใ—ใ‚„ใ™ใใ™ใ‚‹ใŸใ‚ใซISOๆ–‡ๅญ—ๅˆ—ใซๅค‰ๆ›ดใ•ใ‚ŒใŸๅ€คใงใ™ใ€‚.", "type": "string" } }, @@ -35860,7 +35860,7 @@ "type": "number" }, "ts_date": { - "title": "`ts`ใฎๆ—ฅไป˜ๅฝขๅผใ“ใ‚Œใฏใ€็พๅœจใฎๆ™‚ๅˆปๅ€คใ‚’ 'ts' ใงๅŒบๅˆ‡ใฃใฆ่ช่ญ˜ใ—ใ‚„ใ™ใใ™ใ‚‹ใŸใ‚ใซ ISO ๆ–‡ๅญ—ๅˆ—ใซๅค‰ๆ›ดใ•ใ‚ŒใŸๅ€คใงใ™ใ€‚.", + "title": "`ts`ใฎๆ—ฅไป˜ๅฝขๅผใ“ใ‚Œใฏใ€'ts'ใงๅŒบๅˆ‡ใ‚‹ใ“ใจใง็พๅœจใฎๆ™‚ๅˆปๅ€คใ‚’่ช่ญ˜ใ—ใ‚„ใ™ใใ™ใ‚‹ใŸใ‚ใซISOๆ–‡ๅญ—ๅˆ—ใซๅค‰ๆ›ดใ•ใ‚ŒใŸๅ€คใงใ™ใ€‚.", "type": "string" }, "links": { @@ -36052,7 +36052,7 @@ "type": "number" }, "ts_date": { - "title": "`ts`ใฎๆ—ฅไป˜ๅฝขๅผใ“ใ‚Œใฏใ€็พๅœจใฎๆ™‚ๅˆปๅ€คใ‚’ 'ts' ใงๅŒบๅˆ‡ใฃใฆ่ช่ญ˜ใ—ใ‚„ใ™ใใ™ใ‚‹ใŸใ‚ใซ ISO ๆ–‡ๅญ—ๅˆ—ใซๅค‰ๆ›ดใ•ใ‚ŒใŸๅ€คใงใ™ใ€‚.", + "title": "`ts`ใฎๆ—ฅไป˜ๅฝขๅผใ“ใ‚Œใฏใ€'ts'ใงๅŒบๅˆ‡ใ‚‹ใ“ใจใง็พๅœจใฎๆ™‚ๅˆปๅ€คใ‚’่ช่ญ˜ใ—ใ‚„ใ™ใใ™ใ‚‹ใŸใ‚ใซISOๆ–‡ๅญ—ๅˆ—ใซๅค‰ๆ›ดใ•ใ‚ŒใŸๅ€คใงใ™ใ€‚.", "type": "string" } }, @@ -36621,7 +36621,7 @@ "type": "array" }, "isLast": { - "title": "ใ‚ฆใ‚งใ‚ถใƒผใฏๆœ€ๅพŒใฎใƒšใƒผใ‚ธใงใ™", + "title": "ๅคฉๆฐ—ใฏๆœ€ๅพŒใฎใƒšใƒผใ‚ธใงใ™", "type": "boolean" }, "total": { @@ -39446,7 +39446,7 @@ "type": "array" }, "isLast": { - "title": "ใ‚ฆใ‚งใ‚ถใƒผใฏๆœ€ๅพŒใฎใƒšใƒผใ‚ธใงใ™", + "title": "ๅคฉๆฐ—ใฏๆœ€ๅพŒใฎใƒšใƒผใ‚ธใงใ™", "type": "boolean" }, "total": { @@ -39684,7 +39684,7 @@ "type": "array" }, "isLast": { - "title": "ใ‚ฆใ‚งใ‚ถใƒผใฏๆœ€ๅพŒใฎใƒšใƒผใ‚ธใงใ™", + "title": "ๅคฉๆฐ—ใฏๆœ€ๅพŒใฎใƒšใƒผใ‚ธใงใ™", "type": "boolean" }, "total": { @@ -39821,7 +39821,7 @@ "type": "array" }, "isLast": { - "title": "ใ‚ฆใ‚งใ‚ถใƒผใฏๆœ€ๅพŒใฎใƒšใƒผใ‚ธใงใ™", + "title": "ๅคฉๆฐ—ใฏๆœ€ๅพŒใฎใƒšใƒผใ‚ธใงใ™", "type": "boolean" }, "total": { @@ -40148,7 +40148,7 @@ "type": "string" }, "name": { - "title": "ใ‚นใƒ†ใƒผใ‚ฟใ‚น ใ‚ซใƒ†ใ‚ดใƒชใฎๅๅ‰", + "title": "ใ‚นใƒ†ใƒผใ‚ฟใ‚นใ‚ซใƒ†ใ‚ดใƒชใฎๅๅ‰", "type": "string" } }, @@ -40218,7 +40218,7 @@ }, "place_id": { "title": "ๅ›บๆœ‰ID", - "description": "ใ“ใ‚Œใฏใƒฌใ‚นใƒˆใƒฉใƒณใฎๅ›บๆœ‰ใฎIDใงใ™ใ€‚ใ“ใ‚Œใฏใƒฌใƒ“ใƒฅใƒผใ‚’ๆคœ็ดขใ™ใ‚‹ใŸใ‚ใซๅฟ…่ฆใชๆƒ…ๅ ฑใงใ™.", + "description": "ใ“ใ‚Œใฏใƒฌใ‚นใƒˆใƒฉใƒณใฎๅ›บๆœ‰IDใงใ™ใ€‚ใƒฌใƒ“ใƒฅใƒผใ‚’ๆคœ็ดขใ™ใ‚‹ใŸใ‚ใซๅฟ…่ฆใชๆƒ…ๅ ฑใงใ™.", "type": "string" }, "gps_coordinate": { @@ -40666,7 +40666,7 @@ "$ref": "#/components/schemas/_namespace_swagger.IGithub.Issue" }, "comment": { - "title": "ใ‚ณใƒกใƒณใƒˆ ใ‚ณใƒกใƒณใƒˆใฎใ‚คใƒ™ใƒณใƒˆใฎๅ ดๅˆใฏใ€ใ‚ณใƒกใƒณใƒˆๆƒ…ๅ ฑใ‚’ๅซใ‚ใพใ™.", + "title": "ใ‚ณใƒกใƒณใƒˆ ใ‚ณใƒกใƒณใƒˆใฎใ‚คใƒ™ใƒณใƒˆใฎๅ ดๅˆใฏใ€ใ‚ณใƒกใƒณใƒˆๆƒ…ๅ ฑใ‚’ๅซใ‚ใ‚‹.", "$ref": "#/components/schemas/_namespace_swagger.IGithub.Comment" } }, @@ -45550,7 +45550,7 @@ "type": "string" } }, - "description": "T ๅ†…ใฎใ™ในใฆใฎใƒ—ใƒญใƒ‘ใƒ†ใ‚ฃใ‚’ใ‚ชใƒ—ใ‚ทใƒงใƒณใซใ™ใ‚‹", + "description": "T ใฎใ™ในใฆใฎใƒ—ใƒญใƒ‘ใƒ†ใ‚ฃใ‚’ใ‚ชใƒ—ใ‚ทใƒงใƒณใซใ™ใ‚‹", "type": "object" }, "_namespace_swagger.IGithub.IFetchRepositoryPullRequestOutput": { @@ -50048,7 +50048,7 @@ "type": "boolean" } }, - "description": "T ๅ†…ใฎใ™ในใฆใฎใƒ—ใƒญใƒ‘ใƒ†ใ‚ฃใ‚’ใ‚ชใƒ—ใ‚ทใƒงใƒณใซใ™ใ‚‹", + "description": "T ใฎใ™ในใฆใฎใƒ—ใƒญใƒ‘ใƒ†ใ‚ฃใ‚’ใ‚ชใƒ—ใ‚ทใƒงใƒณใซใ™ใ‚‹", "type": "object" }, "_namespace_swagger.IDiscord.IGetPinnedMessagesRequest": { @@ -50457,7 +50457,7 @@ ] }, "description_html": { - "title": "description_html ใ‚คใƒ™ใƒณใƒˆใ‚ฟใ‚คใƒ—ใฎ่ชฌๆ˜Ž๏ผˆHTML ๅฝขๅผ๏ผ‰", + "title": "description_html ใ‚คใƒ™ใƒณใƒˆใ‚ฟใ‚คใƒ—ใฎ่ชฌๆ˜Ž๏ผˆHTMLๅฝขๅผ๏ผ‰", "oneOf": [ { "type": "null" @@ -51575,7 +51575,7 @@ ] }, "utm_content": { - "title": "utm_content UTMใ‚ณใƒณใƒ†ใƒณใƒ„ใƒˆใƒฉใƒƒใ‚ญใƒณใ‚ฐใƒ‘ใƒฉใƒกใƒผใ‚ฟ", + "title": "utm_content UTMใ‚ณใƒณใƒ†ใƒณใƒ„่ฟฝ่ทกใƒ‘ใƒฉใƒกใƒผใ‚ฟ", "oneOf": [ { "type": "null" diff --git a/assets/output/marketing.swagger.ko.json b/assets/output/marketing.swagger.ko.json index 79cf6d9..de21e25 100644 --- a/assets/output/marketing.swagger.ko.json +++ b/assets/output/marketing.swagger.ko.json @@ -658,7 +658,7 @@ "description": "" } }, - "summary": "๊ณต๊ฒฉ ํŒŒ์ผ ๋งํฌ๋ฅผ ํ™œ์šฉ ์…€ ์ƒ์„ฑ ๋ฐ ์ถ”๊ฐ€ ๋ฐ์ดํ„ฐ", + "summary": "๊ณต๊ฒฉ ํŒŒ์ผ ๋งํฌ๋ฅผ ๊ฐ€์ง€๊ณ  ์…€ ์ƒ์„ฑ ๋ฐ ์ถ”๊ฐ€ ๋ฐ์ดํ„ฐ ์ƒ์„ฑ", "description": "Excel ํŒŒ์ผ ๋งํฌ๋กœ Excel ํŒŒ์ผ์— ๋ฐ์ดํ„ฐ ์ถ”๊ฐ€ Excel์— ๋ฐ์ดํ„ฐ๋ฅผ ์ถ”๊ฐ€ํ•  ๋•Œ ์•„์ง ์กด์žฌํ•˜์ง€ ์•Š๋Š” ์‹œํŠธ์ธ ๊ฒฝ์šฐ ์‹œํŠธ ์ƒ์„ฑ์ด ์„ ํ–‰ํ•ฉ๋‹ˆ๋‹ค. ๋”ฐ๋ผ์„œ ์ด ๊ธฐ๋Šฅ์€ ์‹œํŠธ ์ƒ์„ฑ์—๋„ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์‹œํŠธ๋งŒ ๋งŒ๋“ค๊ณ  ๋ฐ์ดํ„ฐ๊ฐ€ ์—†๋Š” ๋นˆ ํŒŒ์ผ์„ ๋งŒ๋“ค๋ ค๋ฉด ๋ฐ์ดํ„ฐ๊ฐ€ ์—†๋Š” ์‹œํŠธ ์ด๋ฆ„๋งŒ ์ง€์ •ํ•˜๋ฉด ๋ฉ๋‹ˆ๋‹ค. ๊ธฐ์กด ์‹œํŠธ์— ํ–‰์„ ์ถ”๊ฐ€ํ•  ๋•Œ๋Š” ๊ฐ€์žฅ ์•„๋ž˜ ์ค„์— ์ถ”๊ฐ€ํ•˜๋„๋ก ๋˜์–ด ์žˆ์œผ๋ฏ€๋กœ ์ถ”๊ฐ€ํ•˜๊ธฐ ์ „์— ๋ฐ์ดํ„ฐ๋ฅผ ํ™•์ธํ•˜๋Š” ๊ฒƒ์ด ์ข‹์Šต๋‹ˆ๋‹ค. fileUrl์„ ์ œ๊ณตํ•˜๋ฉด ์ž‘์—… ํ›„ ์ˆ˜์ •ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์ˆ˜์ • ํ›„ ํŒŒ์ผ์€ ์ƒˆ๋กœ์šด ๋งํฌ๋กœ ๋ฐœ๊ธ‰๋ฉ๋‹ˆ๋‹ค. ์ด์ „ ๋ฐœํ™”์—์„œ ํŒŒ์ผ ๋งํฌ๋ฅผ ์•Œ๊ณ  ์žˆ๊ฑฐ๋‚˜ ์‚ฌ์šฉ์ž๋กœ๋ถ€ํ„ฐ ๋ฐœํ™”์—์„œ ํŒŒ์ผ ๋งํฌ๋ฅผ ๋ฐ›์€ ๊ฒฝ์šฐ ํŒŒ์ผ์„ ์—…๋กœ๋“œํ•˜์ง€ ์•Š๊ณ ๋„ ํŒŒ์ผ์„ ์—…๋ฐ์ดํŠธํ•  ์ˆ˜ ์žˆ๋Š” ์ปค๋„ฅํ„ฐ์ž…๋‹ˆ๋‹ค. Excel ํŒŒ์ผ์ด ์ƒ์„ฑ๋œ ์งํ›„์— Excel ํŒŒ์ผ์— ๋Œ€ํ•œ ๋งํฌ๊ฐ€ ์ƒ์„ฑ๋˜๋ฏ€๋กœ ์—…๋กœ๋“œ๋ฅผ ํ†ตํ•ด ๋ฐ์ดํ„ฐ๋ฅผ ์ถ”๊ฐ€ํ•˜๋Š” ๊ฒƒ๋ณด๋‹ค ์ด ์ปค๋„ฅํ„ฐ๋ฅผ ํ˜ธ์ถœํ•˜๋Š” ๊ฒƒ์ด ์‚ฌ์šฉ์ž ๊ฒฝํ—˜ ์ธก๋ฉด์—์„œ ๋” ์œ ๋ฆฌํ•ฉ๋‹ˆ๋‹ค..", "tags": [ "Excel" @@ -4352,7 +4352,7 @@ "const": 3 }, { - "title": "๋‹ค์ค‘ ์ œํ•œ ์ถœํ‡ด๊ทผ", + "title": "๋‹ค์ค‘ ์ œํ•œ ์šด์†ก", "const": 4 } ] @@ -10646,7 +10646,7 @@ "description": "" } }, - "summary": "์ €์žฅ์†Œ์— ๋Œ€ํ•œ ๋ผ๋ฒจ ๋ชฉ๋ก", + "summary": "์ €์žฅ์†Œ์˜ ๋ผ๋ฒจ ๋ชฉ๋ก", "description": "์ €์žฅ์†Œ์— ๋Œ€ํ•œ ๋ ˆ์ด๋ธ” ๋‚˜์—ด ํ•ด๋‹น ์ €์žฅ์†Œ์—์„œ ์ƒ์„ฑ๋˜๊ณ  ์‚ฌ์šฉ๋œ ์ด์Šˆ ๋ชฉ๋ก์„ ๋ด…๋‹ˆ๋‹ค. ๊ฐ ์ด์Šˆ์—๋Š” ์ด ์ €์žฅ์†Œ์— ์ด๋ฏธ ๋“ฑ๋ก๋œ ๋ ˆ์ด๋ธ”๋งŒ ์žˆ์Šต๋‹ˆ๋‹ค. ๋ฌผ๋ก  ์ด์Šˆ๋ฅผ ์ƒ์„ฑํ•  ๋•Œ ๋ฐ˜๋“œ์‹œ ์—ฌ๊ธฐ์˜ ๋ ˆ์ด๋ธ”๋งŒ ์‚ฌ์šฉํ•ด์•ผ ํ•œ๋‹ค๋Š” ๊ฒƒ์€ ์•„๋‹ˆ์ง€๋งŒ ์—ฌ๊ธฐ์˜ ๋ ˆ์ด๋ธ”์„ ์ฐธ์กฐํ•˜์—ฌ ํ• ๋‹นํ•˜๋Š” ๊ฒƒ์ด ์ข‹์Šต๋‹ˆ๋‹ค..", "tags": [ "Github" @@ -11768,7 +11768,7 @@ { "name": "workspaceId", "required": true, - "description": "์‚ญ์ œํ•  ์ž‘์—… ๊ณต๊ฐ„ ID", + "description": "์‚ญ์ œํ•  ์ž‘์—…๊ณต๊ฐ„ ID", "in": "path", "schema": { "x-wrtn-prerequisite": { @@ -12124,7 +12124,7 @@ } }, "summary": "crunchbase์—์„œ ์กฐ์ง ๋ฐ์ดํ„ฐ ๊ฐ€์ ธ์˜ค๊ธฐ", - "description": "๊ธฐ์—… ์ •๋ณด ๋ฌธ์˜ ๊ธฐ์—… ์ •๋ณด์—๋Š” ํšŒ์‚ฌ์— ๋Œ€ํ•œ ๊ฐ„๋žตํ•œ ์†Œ๊ฐœ์™€ ์˜จ๋งˆํฌ ์ˆœ์œ„, ์‚ฐ์—… ๊ทธ๋ฃน, ์†Œ์…œ ๋ฏธ๋””์–ด, ์›น์‚ฌ์ดํŠธ, ์ž๊ธˆ ์กฐ๋‹ฌ ๊ธˆ์•ก ๋ฐ ๋ผ์šด๋“œ๋ฅผ ํฌํ•จํ•œ ์ž๊ธˆ ์กฐ๋‹ฌ ์ •๋ณด, ์—ฐ๋ฝ์ฒ˜, ์œ ์‚ฌ ์„œ๋น„์Šค ๋ฐ ๊ฒฝ์Ÿ์ž๊ฐ€ ํฌํ•จ๋ฉ๋‹ˆ๋‹ค. ๊ทธ ์™ธ์—๋„ ํšŒ์‚ฌ๋Š” ์–ธ๊ธ‰๋œ ๊ธฐ์‚ฌ ๋ฐ ์ง์› ์ˆ˜, ์ฐฝ๋ฆฝ์ž ๋ชฉ๋ก์„ ํฌํ•จํ•œ ๋ชจ๋“  ์ „๋ฐ˜์ ์ธ ์ •๋ณด๋ฅผ ์–ป์„ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค..", + "description": "๊ธฐ์—… ์ •๋ณด ๋ฌธ์˜ ๊ธฐ์—… ์ •๋ณด์—๋Š” ๊ธฐ์—…์— ๋Œ€ํ•œ ๊ฐ„๋žตํ•œ ์†Œ๊ฐœ์™€ ์˜จ๋งˆํฌ ์ˆœ์œ„, ์‚ฐ์—… ๊ทธ๋ฃน, ์†Œ์…œ ๋ฏธ๋””์–ด, ์›น์‚ฌ์ดํŠธ, ์ž๊ธˆ ์กฐ๋‹ฌ ๊ธˆ์•ก ๋ฐ ๋ผ์šด๋“œ๋ฅผ ํฌํ•จํ•œ ์ž๊ธˆ ์กฐ๋‹ฌ ์ •๋ณด, ์—ฐ๋ฝ์ฒ˜, ์œ ์‚ฌ ์„œ๋น„์Šค ๋ฐ ๊ฒฝ์Ÿ์ž๊ฐ€ ํฌํ•จ๋ฉ๋‹ˆ๋‹ค. ๊ทธ ์™ธ์—๋„ ๊ธฐ์—…์€ ์–ธ๊ธ‰๋œ ๊ธฐ์‚ฌ ๋ฐ ์ง์› ์ˆ˜, ์ฐฝ๋ฆฝ์ž ๋ชฉ๋ก์„ ํฌํ•จํ•œ ๋ชจ๋“  ์ „๋ฐ˜์ ์ธ ์ •๋ณด๋ฅผ ์–ป์„ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค..", "tags": [] } }, @@ -13648,7 +13648,7 @@ ] }, "type": { - "description": "๋ถ€์—ฌํ•  ๊ถŒํ•œ ์œ ํ˜•์ž…๋‹ˆ๋‹ค. user - ํŠน์ • ์‚ฌ์šฉ์ž. ์ด ๊ฒฝ์šฐ emailAddress ํ•„๋“œ์— ๊ถŒํ•œ์„ ๋ถ€์—ฌํ•  ์‚ฌ์šฉ์ž์˜ ์ด๋ฉ”์ผ ์ฃผ์†Œ๋ฅผ ์ง€์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. group - ํŠน์ • ๊ทธ๋ฃน. ์ด ๊ฒฝ์šฐ emailAddress ํ•„๋“œ์— ๊ถŒํ•œ์„ ๋ถ€์—ฌํ•  ๊ทธ๋ฃน์˜ ์ด๋ฉ”์ผ ์ฃผ์†Œ๋ฅผ ์ง€์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. domain - ํŠน์ • ๋„๋ฉ”์ธ. ์ด ๊ฒฝ์šฐ domain ํ•„๋“œ์— ๊ถŒํ•œ์„ ๋ถ€์—ฌํ•  ๋„๋ฉ”์ธ์„ ์ง€์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. anyone - ๋ชจ๋“  ์‚ฌ์šฉ์ž ๊ฐ€๋Šฅํ•œ ๊ฐ’์€ "user", "group", "domain", "anyone"์˜ ๋„ค ๊ฐ€์ง€๋ฟ์ž…๋‹ˆ๋‹ค..", + "description": "๋ถ€์—ฌํ•  ๊ถŒํ•œ ์œ ํ˜•. user - ํŠน์ • ์‚ฌ์šฉ์ž. ์ด ๊ฒฝ์šฐ emailAddress ํ•„๋“œ์— ๊ถŒํ•œ์„ ๋ถ€์—ฌํ•  ์‚ฌ์šฉ์ž์˜ ์ด๋ฉ”์ผ ์ฃผ์†Œ๋ฅผ ์ง€์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. group - ํŠน์ • ๊ทธ๋ฃน. ์ด ๊ฒฝ์šฐ emailAddress ํ•„๋“œ์— ๊ถŒํ•œ์„ ๋ถ€์—ฌํ•  ๊ทธ๋ฃน์˜ ์ด๋ฉ”์ผ ์ฃผ์†Œ๋ฅผ ์ง€์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. domain - ํŠน์ • ๋„๋ฉ”์ธ. ์ด ๊ฒฝ์šฐ domain ํ•„๋“œ์— ๊ถŒํ•œ์„ ๋ถ€์—ฌํ•  ๋„๋ฉ”์ธ์„ ์ง€์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. anyone - ๋ชจ๋“  ์‚ฌ์šฉ์ž ๊ฐ€๋Šฅํ•œ ๊ฐ’์€ "user", "group", "domain", "anyone"์˜ ๋„ค ๊ฐ€์ง€๋ฟ์ž…๋‹ˆ๋‹ค..", "title": "ํ—ˆ๊ฐ€์˜ ์ข…๋ฅ˜", "oneOf": [ { @@ -13678,7 +13678,7 @@ "properties": { "data": { "title": "Google ๋ฌธ์„œ ๋ฐ์ดํ„ฐ", - "description": "์ด๊ฑด ๋‚ด๊ฐ€ ์ฝ์€ Google ๋ฌธ์„œ์˜ ๋ฐ์ดํ„ฐ์ž…๋‹ˆ๋‹ค..", + "description": "๋‚ด๊ฐ€ ์ฝ์€ Google ๋ฌธ์„œ์˜ ๋ฐ์ดํ„ฐ์ž…๋‹ˆ๋‹ค..", "$ref": "#/components/schemas/_namespace_swagger.IGoogleDocs" } }, @@ -14986,8 +14986,8 @@ "_namespace_swagger.IGoogleCalendar.ICreateQuickEventInput": { "properties": { "text": { - "title": "๋น ๋ฅธ ์ผ์ • ์ด๋ฒคํŠธ๋ฅผ ๋งŒ๋“œ๋Š” ํ…์ŠคํŠธ์ž…๋‹ˆ๋‹ค.", - "description": "๋น ๋ฅธ ์ผ์ • ์ด๋ฒคํŠธ๋ฅผ ๋งŒ๋“œ๋Š” ํ…์ŠคํŠธ์ž…๋‹ˆ๋‹ค..", + "title": "๋น ๋ฅธ ์บ˜๋ฆฐ๋” ์ด๋ฒคํŠธ๋ฅผ ๋งŒ๋“œ๋Š” ํ…์ŠคํŠธ์ž…๋‹ˆ๋‹ค.", + "description": "๋น ๋ฅธ ์บ˜๋ฆฐ๋” ์ด๋ฒคํŠธ๋ฅผ ๋งŒ๋“œ๋Š” ํ…์ŠคํŠธ์ž…๋‹ˆ๋‹ค..", "type": "string" }, "secretKey": { @@ -15577,7 +15577,7 @@ ] }, "type": { - "description": "๋ถ€์—ฌํ•  ๊ถŒํ•œ ์œ ํ˜•์ž…๋‹ˆ๋‹ค. user - ํŠน์ • ์‚ฌ์šฉ์ž. ์ด ๊ฒฝ์šฐ emailAddress ํ•„๋“œ์— ๊ถŒํ•œ์„ ๋ถ€์—ฌํ•  ์‚ฌ์šฉ์ž์˜ ์ด๋ฉ”์ผ ์ฃผ์†Œ๋ฅผ ์ง€์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. group - ํŠน์ • ๊ทธ๋ฃน. ์ด ๊ฒฝ์šฐ emailAddress ํ•„๋“œ์— ๊ถŒํ•œ์„ ๋ถ€์—ฌํ•  ๊ทธ๋ฃน์˜ ์ด๋ฉ”์ผ ์ฃผ์†Œ๋ฅผ ์ง€์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. domain - ํŠน์ • ๋„๋ฉ”์ธ. ์ด ๊ฒฝ์šฐ domain ํ•„๋“œ์— ๊ถŒํ•œ์„ ๋ถ€์—ฌํ•  ๋„๋ฉ”์ธ์„ ์ง€์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. anyone - ๋ชจ๋“  ์‚ฌ์šฉ์ž ๊ฐ€๋Šฅํ•œ ๊ฐ’์€ "user", "group", "domain", "anyone"์˜ ๋„ค ๊ฐ€์ง€๋ฟ์ž…๋‹ˆ๋‹ค..", + "description": "๋ถ€์—ฌํ•  ๊ถŒํ•œ ์œ ํ˜•. user - ํŠน์ • ์‚ฌ์šฉ์ž. ์ด ๊ฒฝ์šฐ emailAddress ํ•„๋“œ์— ๊ถŒํ•œ์„ ๋ถ€์—ฌํ•  ์‚ฌ์šฉ์ž์˜ ์ด๋ฉ”์ผ ์ฃผ์†Œ๋ฅผ ์ง€์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. group - ํŠน์ • ๊ทธ๋ฃน. ์ด ๊ฒฝ์šฐ emailAddress ํ•„๋“œ์— ๊ถŒํ•œ์„ ๋ถ€์—ฌํ•  ๊ทธ๋ฃน์˜ ์ด๋ฉ”์ผ ์ฃผ์†Œ๋ฅผ ์ง€์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. domain - ํŠน์ • ๋„๋ฉ”์ธ. ์ด ๊ฒฝ์šฐ domain ํ•„๋“œ์— ๊ถŒํ•œ์„ ๋ถ€์—ฌํ•  ๋„๋ฉ”์ธ์„ ์ง€์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. anyone - ๋ชจ๋“  ์‚ฌ์šฉ์ž ๊ฐ€๋Šฅํ•œ ๊ฐ’์€ "user", "group", "domain", "anyone"์˜ ๋„ค ๊ฐ€์ง€๋ฟ์ž…๋‹ˆ๋‹ค..", "title": "ํ—ˆ๊ฐ€์˜ ์ข…๋ฅ˜", "oneOf": [ { @@ -15839,7 +15839,7 @@ }, "lastViewedByMeDate": { "format": "date-time", - "title": "๋‚ด๊ฐ€ ๋งˆ์ง€๋ง‰์œผ๋กœ ๋ณธ ๋‚ ์งœ", + "title": "lastViewedByMe๋‚ ์งœ", "type": "string" }, "markedViewedByMeDate": { @@ -21619,7 +21619,7 @@ "const": 101 }, { - "title": "์‹œ์ž‘ํ•˜๊ธฐ ์ฃผ๋ณ€์„ ํƒ์ƒ‰ํ•  ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค.", + "title": "์‹œ์ž‘ ์ฃผ๋ณ€ ์ง€์—ญ์„ ํƒ์ƒ‰ํ•  ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค.", "const": 102 }, { @@ -21663,7 +21663,7 @@ "const": 205 }, { - "title": "๋‹ค์ค‘ ์ถœ๋ฐœ์ง€: ์—ฌ๋Ÿฌ๋ถ„์˜ ์™ธ๊ณฝ์˜ ์œ ๊ณ  ์ •๋ณด(๊ตํ†ต ์žฅ์• )๋กœ ๋ณ€ํ™˜ ์žฅ์น˜", + "title": "๋‹ค์ค‘ ์ถœ๋ฐœ์ง€: ์—ฌ๋Ÿฌ๋ถ„์˜ ์™ธ๊ณฝ์˜ ์œ ๊ณ  ์ •๋ณด(๊ตํ†ต ์žฅ์• )๋กœ ๋ณ€ํ™˜ ๊ฐ€๋Šฅ", "const": 206 }, { @@ -22091,7 +22091,7 @@ "const": 39 }, { - "title": "๋กœํ„ฐ๋ฆฌ์—์„œ 11์‹œ๋ฐฉํ–ฅ", + "title": "๋กœํ„ฐ๋ฆฌ์—์„œ 11์‹œ ๋ฐฉํ–ฅ", "const": 40 }, { @@ -22155,7 +22155,7 @@ "const": 73 }, { - "title": "ํšŒ์ „์œผ๋กœ ์˜ค๋ฅธ์ชฝ 5์‹œ ๋ฐฉํ–ฅ", + "title": "ํšŒ์ „ ๋ฐฉํ–ฅ์—์„œ ์˜ค๋ฅธ์ชฝ 5์‹œ ์ชฝ์œผ๋กœ", "const": 74 }, { @@ -22163,7 +22163,7 @@ "const": 75 }, { - "title": "ํšŒ์ „ ๊ฑฐ๋ฆฌ์—์„œ 7์‹œ ๋ฐฉํ–ฅ", + "title": "ํšŒ์ „ ๋ฐฉํ–ฅ์—์„œ 7์‹œ ๋ฐฉํ–ฅ", "const": 76 }, { @@ -22171,7 +22171,7 @@ "const": 77 }, { - "title": "ํšŒ์ „๊ต์ฐจ๋กœ์—์„œ ์™ผ์ชฝ 9์‹œ๋ฐฉํ–ฅ", + "title": "ํšŒ์ „์œผ๋กœ ์ธํ•ด 9์‹œ ๋ฐฉํ–ฅ", "const": 78 }, { @@ -23346,7 +23346,7 @@ }, "value": { "pattern": "^([+-]?\\d+(?:\\.\\d+)?(?:[eE][+-]?\\d+)?)$", - "title": "`value_type`์ด percent์ธ ๊ฒฝ์šฐ ๋ฐฑ๋ถ„์œจ๋กœ ๊ณ„์‚ฐ๋œ Point Value", + "title": "`value_type`์ด percent์ธ ๊ฒฝ์šฐ Point Value๋Š” ๋ฐฑ๋ถ„์œจ๋กœ ๊ณ„์‚ฐ๋ฉ๋‹ˆ๋‹ค.", "type": "string" } }, @@ -23559,7 +23559,7 @@ "const": "limit" }, { - "title": "1๊ฐœ๋งŒ ๊ตฌ๋งค ๊ฐ€๋Šฅ", + "title": "ํ•˜๋‚˜๋งŒ ๊ตฌ๋งค ๊ฐ€๋Šฅ", "const": "unique" } ] @@ -25360,7 +25360,7 @@ "type": "string" }, "bjdongCd": { - "title": "๋ฒ•์  ๋™ ์ฝ”๋“œ", + "title": "๋ฒ•์ •๋™ ์ฝ”๋“œ", "description": "๋„์‹œ/๋งˆ์„ ์ฝ”๋“œ์™€ ๋ฆฌ ์ฝ”๋“œ์˜ ์กฐํ•ฉ", "type": "string" }, @@ -26103,7 +26103,7 @@ "properties": { "user_request": { "title": "์‚ฌ์šฉ์ž ์š”์ฒญ", - "x-wrtn-placeholder": "์ œํ’ˆ ์ด๋ฆ„๊ณผ ์ œํ’ˆ์˜ ํŠน์ง•์„ ์ฐธ๊ณ ํ•ด์„œ ๊ด‘๊ณ  ๋ฌธ๊ตฌ๋ฅผ ๊ธฐ๋ฐœํ•˜๊ณ  ์บ๋ฆญํ„ฐ๋Ÿฌ์Šคํ•˜๊ฒŒ ๋งŒ๋“ค์–ด์ฃผ์„ธ์š”.", + "x-wrtn-placeholder": "์ œํ’ˆ ์ด๋ฆ„๊ณผ ์ œํ’ˆ์˜ ํŠน์ง•์„ ์ฐธ๊ณ ํ•ด์„œ ๊ด‘๊ณ  ๋ฌธ์•ˆ์„ ๊ธฐ๋ฐœํ•˜๊ณ  ์บ๋ฆญํ„ฐ๋Ÿฌ์Šคํ•˜๊ฒŒ ๋งŒ๋“ค์–ด์ฃผ์„ธ์š”.", "type": "string" }, "system_prompt": { @@ -26131,7 +26131,7 @@ "type": "string" }, "storyLine": { - "title": "๋‹ค์Œ ์Šคํ† ๋ฆฌ ๋ผ์ธ์„ ์ƒ์„ฑํ•  ์ˆ˜ ์žˆ๋‹ค๋ฉด ์—ฌ๊ธฐ์— ์ œ๊ณตํ•˜์„ธ์š”", + "title": "๋‹ค์Œ ์Šคํ† ๋ฆฌ ๋ผ์ธ์„ ์ƒ์„ฑํ•  ์ˆ˜ ์žˆ๋‹ค๋ฉด ์—ฌ๊ธฐ์— ์ œ๊ณตํ•˜์„ธ์š”.", "description": "๋‹ค์Œ ์Šคํ† ๋ฆฌ ๋ผ์ธ์„ ์ƒ์„ฑํ•  ์ˆ˜ ์žˆ๋‹ค๋ฉด ์—ฌ๊ธฐ์— ์ œ๊ณตํ•˜์„ธ์š”. ์‚ฌ์šฉ์ž๊ฐ€ ์›ํ•˜๋Š” ๊ฒƒ์ด ๋ฌด์—‡์ธ์ง€ ์ž˜ ์•Œ๊ณ  ์žˆ์„ ๋•Œ๋งŒ ์Šคํ† ๋ฆฌ๋ฅผ ์ƒ์„ฑํ•˜์„ธ์š”. ์‚ฌ์šฉ์ž๊ฐ€ ํ™•์‹ ํ•˜์ง€ ๋ชปํ•˜๋Š” ๊ฒฝ์šฐ ์Šคํ† ๋ฆฌ๋ฅผ ์ œ์•ˆํ•  ์ˆ˜ ์žˆ์ง€๋งŒ ์Šคํ† ๋ฆฌ ๋ผ์ธ์„ ์ƒ์„ฑํ•˜๊ธฐ ์ „์— ๋จผ์ € ์‚ฌ์šฉ์ž์—๊ฒŒ ๋ฌผ์–ด๋ณด์„ธ์š”..", "type": "string" }, @@ -26747,7 +26747,7 @@ "customerId": { "pattern": "([+-]?\\d+(?:\\.\\d+)?(?:[eE][+-]?\\d+)?)", "title": "๊ณ ๊ฐ ๋ฆฌ์†Œ์Šค ID", - "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ 'customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", + "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ `customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", "x-wrtn-placeholder": "1", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", @@ -26801,7 +26801,7 @@ "customerId": { "pattern": "([+-]?\\d+(?:\\.\\d+)?(?:[eE][+-]?\\d+)?)", "title": "๊ณ ๊ฐ ๋ฆฌ์†Œ์Šค ID", - "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ 'customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", + "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ `customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", "x-wrtn-placeholder": "1", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", @@ -26846,7 +26846,7 @@ "customerId": { "pattern": "([+-]?\\d+(?:\\.\\d+)?(?:[eE][+-]?\\d+)?)", "title": "๊ณ ๊ฐ ๋ฆฌ์†Œ์Šค ID", - "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ 'customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", + "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ `customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", "x-wrtn-placeholder": "1", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", @@ -26876,7 +26876,7 @@ "customerId": { "pattern": "([+-]?\\d+(?:\\.\\d+)?(?:[eE][+-]?\\d+)?)", "title": "๊ณ ๊ฐ ๋ฆฌ์†Œ์Šค ID", - "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ 'customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", + "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ `customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", "x-wrtn-placeholder": "1", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", @@ -26919,7 +26919,7 @@ "type": "string" }, "currencyCode": { - "title": "ํ™”ํ ๋‹จ์œ„, ํ†ตํ™” ์ฝ”๋“œ", + "title": "ํ™”ํ ๋‹จ์œ„, ํ™”ํ ์ฝ”๋“œ", "description": "'USD', 'EUR', 'KRW' ๋“ฑ์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค..", "type": "string" } @@ -27384,7 +27384,7 @@ "customerId": { "pattern": "([+-]?\\d+(?:\\.\\d+)?(?:[eE][+-]?\\d+)?)", "title": "๊ณ ๊ฐ ๋ฆฌ์†Œ์Šค ID", - "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ 'customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", + "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ `customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", "x-wrtn-placeholder": "1", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", @@ -27536,7 +27536,7 @@ "customerId": { "pattern": "([+-]?\\d+(?:\\.\\d+)?(?:[eE][+-]?\\d+)?)", "title": "๊ณ ๊ฐ ๋ฆฌ์†Œ์Šค ID", - "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ 'customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", + "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ `customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", "x-wrtn-placeholder": "1", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", @@ -27654,7 +27654,7 @@ "customerId": { "pattern": "([+-]?\\d+(?:\\.\\d+)?(?:[eE][+-]?\\d+)?)", "title": "๊ณ ๊ฐ ๋ฆฌ์†Œ์Šค ID", - "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ 'customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", + "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ `customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", "x-wrtn-placeholder": "1", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", @@ -27831,7 +27831,7 @@ "customerId": { "pattern": "([+-]?\\d+(?:\\.\\d+)?(?:[eE][+-]?\\d+)?)", "title": "๊ณ ๊ฐ ๋ฆฌ์†Œ์Šค ID", - "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ 'customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", + "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ `customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", "x-wrtn-placeholder": "1", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", @@ -27886,7 +27886,7 @@ "customerId": { "pattern": "([+-]?\\d+(?:\\.\\d+)?(?:[eE][+-]?\\d+)?)", "title": "๊ณ ๊ฐ ๋ฆฌ์†Œ์Šค ID", - "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ 'customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", + "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ `customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", "x-wrtn-placeholder": "1", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", @@ -27931,7 +27931,7 @@ "customerId": { "pattern": "([+-]?\\d+(?:\\.\\d+)?(?:[eE][+-]?\\d+)?)", "title": "๊ณ ๊ฐ ๋ฆฌ์†Œ์Šค ID", - "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ 'customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", + "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ `customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", "x-wrtn-placeholder": "1", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", @@ -27980,7 +27980,7 @@ "customerId": { "pattern": "([+-]?\\d+(?:\\.\\d+)?(?:[eE][+-]?\\d+)?)", "title": "๊ณ ๊ฐ ๋ฆฌ์†Œ์Šค ID", - "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ 'customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", + "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ `customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", "x-wrtn-placeholder": "1", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", @@ -28185,7 +28185,7 @@ "customerId": { "pattern": "([+-]?\\d+(?:\\.\\d+)?(?:[eE][+-]?\\d+)?)", "title": "๊ณ ๊ฐ ๋ฆฌ์†Œ์Šค ID", - "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ 'customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", + "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ `customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", "x-wrtn-placeholder": "1", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", @@ -28215,7 +28215,7 @@ "customerId": { "pattern": "([+-]?\\d+(?:\\.\\d+)?(?:[eE][+-]?\\d+)?)", "title": "๊ณ ๊ฐ ๋ฆฌ์†Œ์Šค ID", - "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ 'customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", + "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ `customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", "x-wrtn-placeholder": "1", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", @@ -28300,7 +28300,7 @@ "customerId": { "pattern": "([+-]?\\d+(?:\\.\\d+)?(?:[eE][+-]?\\d+)?)", "title": "๊ณ ๊ฐ ๋ฆฌ์†Œ์Šค ID", - "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ 'customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", + "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ `customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", "x-wrtn-placeholder": "1", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", @@ -28473,7 +28473,7 @@ "customerId": { "pattern": "([+-]?\\d+(?:\\.\\d+)?(?:[eE][+-]?\\d+)?)", "title": "๊ณ ๊ฐ ๋ฆฌ์†Œ์Šค ID", - "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ 'customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", + "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ `customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", "x-wrtn-placeholder": "1", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", @@ -28530,7 +28530,7 @@ "customerId": { "pattern": "([+-]?\\d+(?:\\.\\d+)?(?:[eE][+-]?\\d+)?)", "title": "๊ณ ๊ฐ ๋ฆฌ์†Œ์Šค ID", - "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ 'customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", + "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ `customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", "x-wrtn-placeholder": "1", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", @@ -28588,7 +28588,7 @@ "customerId": { "pattern": "([+-]?\\d+(?:\\.\\d+)?(?:[eE][+-]?\\d+)?)", "title": "๊ณ ๊ฐ ๋ฆฌ์†Œ์Šค ID", - "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ 'customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", + "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ `customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", "x-wrtn-placeholder": "1", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", @@ -28717,7 +28717,7 @@ "customerId": { "pattern": "([+-]?\\d+(?:\\.\\d+)?(?:[eE][+-]?\\d+)?)", "title": "๊ณ ๊ฐ ๋ฆฌ์†Œ์Šค ID", - "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ 'customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", + "description": "์ด๋Š” ๊ณ ๊ฐ์˜ ๋ฆฌ์†Œ์Šค ID์ž…๋‹ˆ๋‹ค. `customers/${number}` ํ˜•์‹์—์„œ `customers/'๋ฅผ ์ œ๊ฑฐํ•œ ํ›„ ๋‚จ์€ ์ˆซ์ž ํ˜•์‹์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. `Wrtn`์˜ `google ads` ๊ด€๋ จ ์ปค๋„ฅํ„ฐ๋Š” `customerId` ์†์„ฑ์„ ์ˆ˜์‹ ํ•˜์—ฌ ๊ณ ๊ฐ์ด ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ๊ฐ€์ง€๊ณ  ์žˆ๋Š”์ง€, ์ฆ‰ ๊ณ ๊ฐ ์ค‘ ์–ด๋–ค ๊ด‘๊ณ  ๊ณ„์ •์„ ์‚ฌ์šฉํ• ์ง€ ๊ฒฐ์ •ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„ ์‚ฌ์šฉ์ž๋Š” ๊ด‘๊ณ  ๊ณ„์ •์ด ํ•˜๋‚˜๋ฟ์ด๋ฏ€๋กœ `customerId`๊ฐ€ ์ธ์ˆ˜๋กœ ์ œ๊ณต๋˜์ง€ ์•Š์œผ๋ฉด ์ˆซ์ž 0์œผ๋กœ ๊ฒ€์ƒ‰๋œ ๊ด‘๊ณ  ๊ณ„์ •์ด ๋ฌด์กฐ๊ฑด ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค. ๊ด‘๊ณ  ๊ณ„์ •์ด ๋‘ ๊ฐœ ์ด์ƒ์ธ ์‚ฌ์šฉ์ž๊ฐ€ `customerId`๋ฅผ ์ œ๊ณตํ•˜์ง€ ์•Š์œผ๋ฉด ํ•ญ์ƒ ์‹คํŒจ๋กœ ๊ฐ„์ฃผ๋ฉ๋‹ˆ๋‹ค..", "x-wrtn-placeholder": "1", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:id}", @@ -31106,7 +31106,7 @@ "link_to_page": { "properties": { "page_id": { - "description": "Notion ๋งํฌ ๋์— ํŽ˜์ด์ง€ ID๋ฅผ ๋งค๊ฐœ๋ณ€์ˆ˜๋กœ ์ „๋‹ฌํ•˜์—ฌ ํŽ˜์ด์ง€๋ฅผ ์กฐํšŒํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์˜ˆ๋ฅผ ๋“ค์–ด, 'https://www.notion.so/ :pageId' ํ˜•์‹์ž…๋‹ˆ๋‹ค..", + "description": "Notion ๋งํฌ ๋์— ํŽ˜์ด์ง€ ID๋ฅผ ๋งค๊ฐœ๋ณ€์ˆ˜๋กœ ์ „๋‹ฌํ•˜์—ฌ ํŽ˜์ด์ง€๋ฅผ ์กฐํšŒํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์˜ˆ๋ฅผ ๋“ค์–ด, 'https://www.notion.so/ :pageId' ํ˜•์‹์œผ๋กœ.", "title": "ํŽ˜์ด์ง€_์•„์ด๋””", "oneOf": [ { @@ -34138,7 +34138,7 @@ "const": "17" }, { - "title": "์ŠคํŒŒ ํ˜ธํ…”", + "title": "์ŠคํŒŒํ˜ธํ…”", "const": "18" }, { @@ -35244,7 +35244,7 @@ "_namespace_swagger.MyPickISlack.Attachmenttitleid": { "properties": { "title": { - "title": "์ œ๋ชฉ ์ฒจ๋ถ€ ํŒŒ์ผ ์ƒ๋‹จ ๊ทผ์ฒ˜์˜ ํฐ ์ œ๋ชฉ ํ…์ŠคํŠธ.", + "title": "์ œ๋ชฉ ์ฒจ๋ถ€ ํŒŒ์ผ ์ƒ๋‹จ ๋ถ€๊ทผ์˜ ํฐ ์ œ๋ชฉ ํ…์ŠคํŠธ.", "type": "string" }, "id": { @@ -40201,7 +40201,7 @@ "date": { "format": "date", "title": "๋‚ ์งœ", - "description": "๋ฐ์ผ๋ฆฌ๋กœ ์กฐํšŒํ•  ๋ฐ์ดํŠธ์ž…๋‹ˆ๋‹ค. ์ž…๋ ฅํ•˜๋Š” ๋‚ ์งœ๋ฅผ ๊ด€๊ณ„๋กœ ์กฐํšŒํ•ฉ๋‹ˆ๋‹ค. ๋…„-์›”-์ผ ํ˜•์‹์˜ ๋‚ ์งœ ์œ ํ˜• ๋ฌธ์ž์—ด์„ ์—ฐ๊ฒฐํ•˜๋Š” ๊ฒƒ์ž…๋‹ˆ๋‹ค.", + "description": "๋ฐ์ผ๋ฆฌ๋กœ ์กฐํšŒํ•  ๋ฐ์ดํŠธ์ž…๋‹ˆ๋‹ค. ์ž…๋ ฅํ•˜๋Š” ๋‚ ์งœ๋ฅผ ๊ด€๊ณ„๋กœ ์กฐํšŒํ•ฉ๋‹ˆ๋‹ค. ๋…„-์›”-์ผ ํ˜•์‹์˜ ๋‚ ์งœ ์œ ํ˜• ๋ฌธ์ž์—ด์„ ์—ฐ๊ฒฐํ•˜๊ธฐ ๋•Œ๋ฌธ์—.", "type": "string" } }, @@ -40453,7 +40453,7 @@ }, { "title": "๊ณต๊ณต ์ด๋ฒคํŠธ", - "description": "๊ฐœ์ธ ์ €์žฅ์†Œ๊ฐ€ ๊ณต๊ฐœ๋˜๋ฉด ํŠธ๋ฆฌ๊ฑฐ๋ฉ๋‹ˆ๋‹ค..", + "description": "๊ฐœ์ธ ์ €์žฅ์†Œ๊ฐ€ ๊ณต๊ฐœ๋  ๋•Œ ํŠธ๋ฆฌ๊ฑฐ๋ฉ๋‹ˆ๋‹ค..", "const": "PublicEvent" }, { @@ -40462,7 +40462,7 @@ "const": "PullRequestEvent" }, { - "title": "PullRequestReviewEvent", + "title": "PullRequestReview์ด๋ฒคํŠธ", "description": "ํ’€ ๋ฆฌํ€˜์ŠคํŠธ์— ๋Œ€ํ•œ ๋ฆฌ๋ทฐ๊ฐ€ ์ œ์ถœ๋  ๋•Œ ํŠธ๋ฆฌ๊ฑฐ๋จ.", "const": "PullRequestReviewEvent" }, @@ -46344,7 +46344,7 @@ ] }, "sort": { - "title": "๋ฐฉํ–ฅ์˜ ์กฐ๊ฑด์€ "CREATED_AT", "UPDATED_AT", "COMMENTS" ์ค‘ ํ•˜๋‚˜์—ฌ์•ผ ํ•ฉ๋‹ˆ๋‹ค..", + "title": "๋ฐฉํ–ฅ ์กฐ๊ฑด์€ "CREATED_AT", "UPDATED_AT", "COMMENTS" ์ค‘ ํ•˜๋‚˜์—ฌ์•ผ ํ•ฉ๋‹ˆ๋‹ค..", "oneOf": [ { "title": "์ƒ์„ฑ๋จ_์‹œ๊ฐ„", @@ -48082,7 +48082,7 @@ "type": "string" }, "author": { - "title": "์ž‘์„ฑ์ž GitHub ์‚ฌ์šฉ์ž ์ด๋ฆ„ ๋˜๋Š” ์ด๋ฉ”์ผ ์ฃผ์†Œ๋Š” ์ปค๋ฐ‹ ์ž‘์„ฑ์ž๋ณ„๋กœ ํ•„ํ„ฐ๋งํ•˜๋Š” ๋ฐ ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค..", + "title": "์ž‘์„ฑ์ž GitHub ์‚ฌ์šฉ์ž ์ด๋ฆ„ ๋˜๋Š” ์ด๋ฉ”์ผ ์ฃผ์†Œ๋กœ ์ปค๋ฐ‹ ์ž‘์„ฑ์ž๋ฅผ ํ•„ํ„ฐ๋งํ•˜๋Š” ๋ฐ ์‚ฌ์šฉ.", "type": "string" }, "committer": { @@ -50055,7 +50055,7 @@ "properties": { "channelId": { "title": "์ฑ„๋„", - "description": "์ €์žฅ๋œ ๊ณ ์ •๋œ ๋กœ๊ทธ๋ฅผ ์ฑ„๋„์„ ์„ ํƒํ•ด์ฃผ์„ธ์š”.", + "description": "๊ณ ์ •๋œ ๋กœ๊ทธ๋ฅผ ๋ณด๊ด€ํ•˜๋Š” ์ฑ„๋„์„ ์„ ํƒํ•ด์ฃผ์„ธ์š”.", "x-wrtn-prerequisite": { "jmesPath": "[].{value:id, label:name}", "method": "post", @@ -51046,7 +51046,7 @@ "invitees_counter": { "properties": { "total": { - "title": "์ด ์ดˆ๋Œ€์ž ์ˆ˜ ์ด๋ฒคํŠธ์— ์ดˆ๋Œ€๋œ ์ด ์‚ฌ๋žŒ ์ˆ˜(์ทจ์†Œ๋œ ์ดˆ๋Œ€์ž ํฌํ•จ)", + "title": "์ด ์ดˆ๋Œ€์ž ์ˆ˜ ์ด๋ฒคํŠธ์— ์ดˆ๋Œ€๋œ ์ด ์‚ฌ๋žŒ ์ˆ˜(์ทจ์†Œํ•œ ์ดˆ๋Œ€์ž ํฌํ•จ)", "type": "integer" }, "active": { @@ -51670,7 +51670,7 @@ "type": "string" }, "routing_form_submission": { - "description": "์ดˆ๋Œ€์ž๋ฅผ ์˜ˆ์•ฝ ํŽ˜์ด์ง€๋กœ ๋ฆฌ๋””๋ ‰์…˜ํ•˜๋Š” ๋ผ์šฐํŒ… ์–‘์‹ ์ œ์ถœ์— ๋Œ€ํ•œ ์ฐธ์กฐ.", + "description": "์ดˆ๋Œ€๋ฐ›์€ ์‚ฌ๋žŒ์„ ์˜ˆ์•ฝ ํŽ˜์ด์ง€๋กœ ๋ฆฌ๋””๋ ‰์…˜ํ•˜๋Š” ๋ผ์šฐํŒ… ์–‘์‹ ์ œ์ถœ์— ๋Œ€ํ•œ ์ฐธ์กฐ.", "title": "๋ผ์šฐํŒ…_์–‘์‹_์ œ์ถœ", "oneOf": [ { @@ -52153,7 +52153,7 @@ }, "timezone": { "title": "์‹œ๊ฐ„๋Œ€", - "description": "์‚ฌ์šฉ์ž์—๊ฒŒ ์‹œ๊ฐ„์„ ํ‘œ์‹œํ•  ๋•Œ ์‚ฌ์šฉํ•  ์‹œ๊ฐ„๋Œ€", + "description": "์‚ฌ์šฉ์ž์—๊ฒŒ ์‹œ๊ฐ„์„ ํ‘œ์‹œํ•  ๋•Œ ์‚ฌ์šฉํ•  ํ‘œ์ค€ ์‹œ๊ฐ„๋Œ€", "x-wrtn-placeholder": "์•„์‹œ์•„/๋„์ฟ„", "type": "string" }, @@ -52344,7 +52344,7 @@ }, "name": { "title": "์–‘์‹ ์ด๋ฆ„", - "description": "์ƒ์„ฑ๋œ ์–‘์‹์˜ ์ด๋ฆ„.", + "description": "์ƒ์„ฑ๋œ ํผ์˜ ์ด๋ฆ„.", "type": "string" }, "type": { @@ -54120,7 +54120,7 @@ ] }, "type": { - "title": "value ํŽ€๋”ฉ ๋ผ์šด๋“œ์˜ ์œ ํ˜•.", + "title": "๊ฐ€์น˜ ํŽ€๋”ฉ ๋ผ์šด๋“œ์˜ ์œ ํ˜•.", "type": "string" }, "value": { @@ -54645,7 +54645,7 @@ }, "IsDataFromGa": { "title": "GA์—์„œ ๊ฐ€์ ธ์˜จ ๋ฐ์ดํ„ฐ์ธ๊ฐ€", - "description": "๋ฐ์ดํ„ฐ๊ฐ€ Google Analytics์—์„œ ๋‚˜์˜จ ๊ฒƒ์ธ์ง€ ๋‚˜ํƒ€๋ƒ…๋‹ˆ๋‹ค.", + "description": "๋ฐ์ดํ„ฐ๊ฐ€ Google Analytics์—์„œ ๋‚˜์˜จ ๊ฒƒ์ธ์ง€ ์—ฌ๋ถ€๋ฅผ ๋‚˜ํƒ€๋ƒ…๋‹ˆ๋‹ค.", "type": "boolean" }, "Competitors": { diff --git a/assets/output/petstore.swagger.ar.json b/assets/output/petstore.swagger.ar.json new file mode 100644 index 0000000..60e1628 --- /dev/null +++ b/assets/output/petstore.swagger.ar.json @@ -0,0 +1,1212 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "ู…ุชุฌุฑ Swagger Petstore - OpenAPI 3.0", + "description": "ู‡ุฐุง ู‡ูˆ ุฎุงุฏู… ู…ุชุฌุฑ ุงู„ุญูŠูˆุงู†ุงุช ุงู„ุฃู„ูŠูุฉ ุงู„ู†ู…ูˆุฐุฌูŠ ุงู„ู…ุณุชู†ุฏ ุฅู„ู‰ ู…ูˆุงุตูุงุช OpenAPI 3.0. ูŠู…ูƒู†ูƒ ู…ุนุฑูุฉ ุงู„ู…ุฒูŠุฏ ุนู† Swagger ุนู„ู‰ [http://swagger.io](http://swagger.io). ููŠ ุงู„ุฅุตุฏุงุฑ ุงู„ุซุงู„ุซ ู…ู† ู…ุชุฌุฑ ุงู„ุญูŠูˆุงู†ุงุช ุงู„ุฃู„ูŠูุฉุŒ ุชุญูˆู„ู†ุง ุฅู„ู‰ ู†ู‡ุฌ ุงู„ุชุตู…ูŠู… ุฃูˆู„ุงู‹! ูŠู…ูƒู†ูƒ ุงู„ุขู† ู…ุณุงุนุฏุชู†ุง ููŠ ุชุญุณูŠู† ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ุณูˆุงุก ู…ู† ุฎู„ุงู„ ุฅุฌุฑุงุก ุชุบูŠูŠุฑุงุช ุนู„ู‰ ุงู„ุชุนุฑูŠู ู†ูุณู‡ ุฃูˆ ุนู„ู‰ ุงู„ูƒูˆุฏ. ุจู‡ุฐู‡ ุงู„ุทุฑูŠู‚ุฉุŒ ู…ุน ู…ุฑูˆุฑ ุงู„ูˆู‚ุชุŒ ูŠู…ูƒู†ู†ุง ุชุญุณูŠู† ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ุจุดูƒู„ ุนุงู…ุŒ ูˆูƒุดู ุจุนุถ ุงู„ู…ูŠุฒุงุช ุงู„ุฌุฏูŠุฏุฉ ููŠ OAS3. ุจุนุถ ุงู„ุฑูˆุงุจุท ุงู„ู…ููŠุฏุฉ: - [ู…ุณุชูˆุฏุน ู…ุชุฌุฑ ุงู„ุญูŠูˆุงู†ุงุช ุงู„ุฃู„ูŠูุฉ](https://github.com/swagger-api/swagger-petstore) - [ุชุนุฑูŠู ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ุงู„ู…ุตุฏุฑ ู„ู…ุชุฌุฑ ุงู„ุญูŠูˆุงู†ุงุช ุงู„ุฃู„ูŠูุฉ](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml)", + "termsOfService": "http://swagger.io/terms/", + "contact": { + "email": "apiteam@swagger.io" + }, + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0.html" + }, + "version": "1.0.17" + }, + "externalDocs": { + "description": "ุงูƒุชุดู ุงู„ู…ุฒูŠุฏ ุนู† Swagger", + "url": "http://swagger.io" + }, + "servers": [ + { + "url": "/api/v3" + } + ], + "tags": [ + { + "name": "pet", + "description": "ูƒู„ ุดูŠุก ุนู† ุญูŠูˆุงู†ุงุชูƒ ุงู„ุฃู„ูŠูุฉ", + "externalDocs": { + "description": "ุฅุนุฑู ุงู„ู…ุฒูŠุฏ", + "url": "http://swagger.io" + } + }, + { + "name": "store", + "description": "ุงู„ูˆุตูˆู„ ุฅู„ู‰ ุทู„ุจุงุช ู…ุชุฌุฑ ุงู„ุญูŠูˆุงู†ุงุช ุงู„ุฃู„ูŠูุฉ", + "externalDocs": { + "description": "ุชุนุฑู ุนู„ู‰ ุงู„ู…ุฒูŠุฏ ุนู† ู…ุชุฌุฑู†ุง", + "url": "http://swagger.io" + } + }, + { + "name": "user", + "description": "ุนู…ู„ูŠุงุช ุญูˆู„ ุงู„ู…ุณุชุฎุฏู…" + } + ], + "paths": { + "/pet": { + "put": { + "tags": [ + "pet" + ], + "summary": "ุชุญุฏูŠุซ ุญูŠูˆุงู† ุฃู„ูŠู ู…ูˆุฌูˆุฏ", + "description": "ุชุญุฏูŠุซ ุญูŠูˆุงู† ุฃู„ูŠู ู…ูˆุฌูˆุฏ ุนู† ุทุฑูŠู‚ ู…ุนุฑู", + "operationId": "updatePet", + "requestBody": { + "description": "ุชุญุฏูŠุซ ุญูŠูˆุงู† ุฃู„ูŠู ู…ูˆุฌูˆุฏ ููŠ ุงู„ู…ุชุฌุฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "ุนู…ู„ูŠุฉ ู†ุงุฌุญุฉ", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + } + } + }, + "400": { + "description": "ุชู… ุชู‚ุฏูŠู… ู…ุนุฑู ุบูŠุฑ ุตุงู„ุญ" + }, + "404": { + "description": "ู„ู… ูŠุชู… ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุญูŠูˆุงู† ุงู„ุฃู„ูŠู" + }, + "405": { + "description": "ุงุณุชุซู†ุงุก ุงู„ุชุญู‚ู‚" + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + }, + "post": { + "tags": [ + "pet" + ], + "summary": "ุฃุถู ุญูŠูˆุงู†ู‹ุง ุฃู„ูŠูู‹ุง ุฌุฏูŠุฏู‹ุง ุฅู„ู‰ ุงู„ู…ุชุฌุฑ", + "description": "ุฃุถู ุญูŠูˆุงู†ู‹ุง ุฃู„ูŠูู‹ุง ุฌุฏูŠุฏู‹ุง ุฅู„ู‰ ุงู„ู…ุชุฌุฑ", + "operationId": "addPet", + "requestBody": { + "description": "ุฅู†ุดุงุก ุญูŠูˆุงู† ุฃู„ูŠู ุฌุฏูŠุฏ ููŠ ุงู„ู…ุชุฌุฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "ุนู…ู„ูŠุฉ ู†ุงุฌุญุฉ", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + } + } + }, + "405": { + "description": "ุฅุฏุฎุงู„ ุบูŠุฑ ุตุงู„ุญ" + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + } + }, + "/pet/findByStatus": { + "get": { + "tags": [ + "pet" + ], + "summary": "ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุญูŠูˆุงู†ุงุช ุงู„ุฃู„ูŠูุฉ ุญุณุจ ุงู„ุญุงู„ุฉ", + "description": "ูŠู…ูƒู† ุชูˆููŠุฑ ู‚ูŠู… ุญุงู„ุฉ ู…ุชุนุฏุฏุฉ ุจุณู„ุงุณู„ ู…ูุตูˆู„ุฉ ุจูุงุตู„ุฉ", + "operationId": "findPetsByStatus", + "parameters": [ + { + "name": "status", + "in": "query", + "description": "ู‚ูŠู… ุงู„ุญุงู„ุฉ ุงู„ุชูŠ ูŠุฌุจ ู…ุฑุงุนุงุชู‡ุง ู„ู„ุชุตููŠุฉ", + "required": false, + "explode": true, + "schema": { + "oneOf": [ + { + "const": "available" + }, + { + "const": "pending" + }, + { + "const": "sold" + } + ] + } + } + ], + "responses": { + "200": { + "description": "ุนู…ู„ูŠุฉ ู†ุงุฌุญุฉ", + "content": { + "application/xml": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Pet" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Pet" + } + } + } + } + }, + "400": { + "description": "ู‚ูŠู…ุฉ ุงู„ุญุงู„ุฉ ุบูŠุฑ ุตุงู„ุญุฉ" + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + } + }, + "/pet/findByTags": { + "get": { + "tags": [ + "pet" + ], + "summary": "ุงู„ุจุญุซ ุนู† ุงู„ุญูŠูˆุงู†ุงุช ุงู„ุฃู„ูŠูุฉ ุนู† ุทุฑูŠู‚ ุงู„ุนู„ุงู…ุงุช", + "description": "ูŠู…ูƒู† ุชูˆููŠุฑ ุนู„ุงู…ุงุช ู…ุชุนุฏุฏุฉ ุจุณู„ุงุณู„ ู…ู†ูุตู„ุฉ ุจูุงุตู„ุฉ. ุงุณุชุฎุฏู… tag1 ูˆtag2 ูˆtag3 ู„ู„ุงุฎุชุจุงุฑ.", + "operationId": "findPetsByTags", + "parameters": [ + { + "name": "tags", + "in": "query", + "description": "ุงู„ุนู„ุงู…ุงุช ุงู„ุชูŠ ูŠุฌุจ ุชุตููŠุชู‡ุง", + "required": false, + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "ุนู…ู„ูŠุฉ ู†ุงุฌุญุฉ", + "content": { + "application/xml": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Pet" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Pet" + } + } + } + } + }, + "400": { + "description": "ู‚ูŠู…ุฉ ุงู„ุนู„ุงู…ุฉ ุบูŠุฑ ุตุงู„ุญุฉ" + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + } + }, + "/pet/{petId}": { + "get": { + "tags": [ + "pet" + ], + "summary": "ุงู„ุจุญุซ ุนู† ุงู„ุญูŠูˆุงู† ุงู„ุฃู„ูŠู ุนู† ุทุฑูŠู‚ ู…ุนุฑูู‡", + "description": "ูŠุนูŠุฏ ุญูŠูˆุงู† ุฃู„ูŠู ูˆุงุญุฏ", + "operationId": "getPetById", + "parameters": [ + { + "name": "petId", + "in": "path", + "description": "ู…ุนุฑู ุงู„ุญูŠูˆุงู† ุงู„ุฃู„ูŠู ุงู„ู…ุฑุงุฏ ุฅุฑุฌุงุนู‡", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "ุนู…ู„ูŠุฉ ู†ุงุฌุญุฉ", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + } + } + }, + "400": { + "description": "ุชู… ุชู‚ุฏูŠู… ู…ุนุฑู ุบูŠุฑ ุตุงู„ุญ" + }, + "404": { + "description": "ู„ู… ูŠุชู… ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุญูŠูˆุงู† ุงู„ุฃู„ูŠู" + } + }, + "security": [ + { + "api_key": [] + }, + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + }, + "post": { + "tags": [ + "pet" + ], + "summary": "ุชุญุฏูŠุซ ุญูŠูˆุงู† ุฃู„ูŠู ููŠ ุงู„ู…ุชุฌุฑ ุจุงุณุชุฎุฏุงู… ุจูŠุงู†ุงุช ุงู„ู†ู…ูˆุฐุฌ", + "description": "", + "operationId": "updatePetWithForm", + "parameters": [ + { + "name": "petId", + "in": "path", + "description": "ู…ุนุฑู ุงู„ุญูŠูˆุงู† ุงู„ุฃู„ูŠู ุงู„ุฐูŠ ูŠุญุชุงุฌ ุฅู„ู‰ ุงู„ุชุญุฏูŠุซ", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "name", + "in": "query", + "description": "ุงุณู… ุงู„ุญูŠูˆุงู† ุงู„ุฃู„ูŠู ุงู„ุฐูŠ ูŠุญุชุงุฌ ุฅู„ู‰ ุงู„ุชุญุฏูŠุซ", + "schema": { + "type": "string" + } + }, + { + "name": "status", + "in": "query", + "description": "ุญุงู„ุฉ ุงู„ุญูŠูˆุงู† ุงู„ุฃู„ูŠู ุงู„ุฐูŠ ูŠุญุชุงุฌ ุฅู„ู‰ ุชุญุฏูŠุซ", + "schema": { + "type": "string" + } + } + ], + "responses": { + "405": { + "description": "ุฅุฏุฎุงู„ ุบูŠุฑ ุตุงู„ุญ" + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + }, + "delete": { + "tags": [ + "pet" + ], + "summary": "ูŠุญุฐู ุญูŠูˆุงู† ุฃู„ูŠู", + "description": "", + "operationId": "deletePet", + "parameters": [ + { + "name": "api_key", + "in": "header", + "description": "", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "petId", + "in": "path", + "description": "ู…ุนุฑู ุงู„ุญูŠูˆุงู† ุงู„ุฃู„ูŠู ุงู„ุฐูŠ ุณูŠุชู… ุญุฐูู‡", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "400": { + "description": "ู‚ูŠู…ุฉ ุญูŠูˆุงู† ุฃู„ูŠู ุบูŠุฑ ุตุงู„ุญุฉ" + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + } + }, + "/pet/{petId}/uploadImage": { + "post": { + "tags": [ + "pet" + ], + "summary": "ูŠู‚ูˆู… ุจุชุญู…ูŠู„ ุตูˆุฑุฉ", + "description": "", + "operationId": "uploadFile", + "parameters": [ + { + "name": "petId", + "in": "path", + "description": "ู…ุนุฑู ุงู„ุญูŠูˆุงู† ุงู„ุฃู„ูŠู ุงู„ู…ุฑุงุฏ ุชุญุฏูŠุซู‡", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "additionalMetadata", + "in": "query", + "description": "ุจูŠุงู†ุงุช ูˆุตููŠุฉ ุฅุถุงููŠุฉ", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + }, + "responses": { + "200": { + "description": "ุนู…ู„ูŠุฉ ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + } + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + } + }, + "/store/inventory": { + "get": { + "tags": [ + "store" + ], + "summary": "ุฅุฑุฌุงุน ู…ุฎุฒูˆู†ุงุช ุงู„ุญูŠูˆุงู†ุงุช ุงู„ุฃู„ูŠูุฉ ุญุณุจ ุงู„ุญุงู„ุฉ", + "description": "ุฅุฑุฌุงุน ุฎุฑูŠุทุฉ ู„ุฑู…ูˆุฒ ุงู„ุญุงู„ุฉ ู„ู„ูƒู…ูŠุงุช", + "operationId": "getInventory", + "responses": { + "200": { + "description": "ุนู…ู„ูŠุฉ ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "type": "integer", + "format": "int32" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/store/order": { + "post": { + "tags": [ + "store" + ], + "summary": "ูˆุถุน ุทู„ุจ ู„ุดุฑุงุก ุญูŠูˆุงู† ุฃู„ูŠู", + "description": "ูˆุถุน ุทู„ุจ ุฌุฏูŠุฏ ููŠ ุงู„ู…ุชุฌุฑ", + "operationId": "placeOrder", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Order" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Order" + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/Order" + } + } + } + }, + "responses": { + "200": { + "description": "ุนู…ู„ูŠุฉ ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Order" + } + } + } + }, + "405": { + "description": "ุฅุฏุฎุงู„ ุบูŠุฑ ุตุงู„ุญ" + } + } + } + }, + "/store/order/{orderId}": { + "get": { + "tags": [ + "store" + ], + "summary": "ุงู„ุจุญุซ ุนู† ุทู„ุจ ุงู„ุดุฑุงุก ุนู† ุทุฑูŠู‚ ู…ุนุฑู", + "description": "ู„ู„ุญุตูˆู„ ุนู„ู‰ ุงุณุชุฌุงุจุฉ ุตุงู„ุญุฉุŒ ุฌุฑู‘ุจ ู…ุนุฑูุงุช ุนุฏุฏูŠุฉ ุตุญูŠุญุฉ ุจู‚ูŠู…ุฉ <= 5 ุฃูˆ > 10. ุณุชุคุฏูŠ ุงู„ู‚ูŠู… ุงู„ุฃุฎุฑู‰ ุฅู„ู‰ ุชูˆู„ูŠุฏ ุงุณุชุซู†ุงุกุงุช.", + "operationId": "getOrderById", + "parameters": [ + { + "name": "orderId", + "in": "path", + "description": "ู…ุนุฑู ุงู„ุทู„ุจ ุงู„ุฐูŠ ูŠุญุชุงุฌ ุฅู„ู‰ ุฌู„ุจู‡", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "ุนู…ู„ูŠุฉ ู†ุงุฌุญุฉ", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Order" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Order" + } + } + } + }, + "400": { + "description": "ุชู… ุชู‚ุฏูŠู… ู…ุนุฑู ุบูŠุฑ ุตุงู„ุญ" + }, + "404": { + "description": "ู„ู… ูŠุชู… ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุทู„ุจ" + } + } + }, + "delete": { + "tags": [ + "store" + ], + "summary": "ุญุฐู ุทู„ุจ ุงู„ุดุฑุงุก ุนู† ุทุฑูŠู‚ ุงู„ู…ุนุฑู", + "description": "ู„ู„ุญุตูˆู„ ุนู„ู‰ ุงุณุชุฌุงุจุฉ ุตุงู„ุญุฉุŒ ุฌุฑูู‘ุจ ู…ุนุฑูุงุช ุนุฏุฏูŠุฉ ุตุญูŠุญุฉ ุจู‚ูŠู…ุฉ < 1000. ุฃูŠ ุดูŠุก ุฃุนู„ู‰ ู…ู† 1000 ุฃูˆ ุบูŠุฑ ุตุญูŠุญ ุณูŠุคุฏูŠ ุฅู„ู‰ ุฅู†ุดุงุก ุฃุฎุทุงุก API", + "operationId": "deleteOrder", + "parameters": [ + { + "name": "orderId", + "in": "path", + "description": "ู…ุนุฑู ุงู„ุทู„ุจ ุงู„ุฐูŠ ูŠุญุชุงุฌ ุฅู„ู‰ ุงู„ุญุฐู", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "400": { + "description": "ุชู… ุชู‚ุฏูŠู… ู…ุนุฑู ุบูŠุฑ ุตุงู„ุญ" + }, + "404": { + "description": "ู„ู… ูŠุชู… ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ุทู„ุจ" + } + } + } + }, + "/user": { + "post": { + "tags": [ + "user" + ], + "summary": "ุฅู†ุดุงุก ุงู„ู…ุณุชุฎุฏู…", + "description": "ู„ุง ูŠู…ูƒู† ุงู„ู‚ูŠุงู… ุจุฐู„ูƒ ุฅู„ุง ู…ู† ู‚ุจู„ ุงู„ู…ุณุชุฎุฏู… ุงู„ู…ุณุฌู„ ุงู„ุฏุฎูˆู„.", + "operationId": "createUser", + "requestBody": { + "description": "ุชู… ุฅู†ุดุงุก ูƒุงุฆู† ุงู„ู…ุณุชุฎุฏู…", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "responses": { + "default": { + "description": "ุนู…ู„ูŠุฉ ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + } + } + } + }, + "/user/createWithList": { + "post": { + "tags": [ + "user" + ], + "summary": "ุฅู†ุดุงุก ู‚ุงุฆู…ุฉ ุจุงู„ู…ุณุชุฎุฏู…ูŠู† ุจุงุณุชุฎุฏุงู… ู…ุฌู…ูˆุนุฉ ุงู„ุฅุฏุฎุงู„ ุงู„ู…ุญุฏุฏุฉ", + "description": "ุฅู†ุดุงุก ู‚ุงุฆู…ุฉ ุจุงู„ู…ุณุชุฎุฏู…ูŠู† ุจุงุณุชุฎุฏุงู… ู…ุฌู…ูˆุนุฉ ุงู„ุฅุฏุฎุงู„ ุงู„ู…ุญุฏุฏุฉ", + "operationId": "createUsersWithListInput", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + } + } + } + }, + "responses": { + "200": { + "description": "ุนู…ู„ูŠุฉ ู†ุงุฌุญุฉ", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "default": { + "description": "ุนู…ู„ูŠุฉ ู†ุงุฌุญุฉ" + } + } + } + }, + "/user/login": { + "get": { + "tags": [ + "user" + ], + "summary": "ุชุณุฌูŠู„ ุฏุฎูˆู„ ุงู„ู…ุณุชุฎุฏู… ุฅู„ู‰ ุงู„ู†ุธุงู…", + "description": "", + "operationId": "loginUser", + "parameters": [ + { + "name": "username", + "in": "query", + "description": "ุงุณู… ุงู„ู…ุณุชุฎุฏู… ู„ุชุณุฌูŠู„ ุงู„ุฏุฎูˆู„", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "password", + "in": "query", + "description": "ูƒู„ู…ุฉ ุงู„ู…ุฑูˆุฑ ู„ุชุณุฌูŠู„ ุงู„ุฏุฎูˆู„ ุจู†ุต ูˆุงุถุญ", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "ุนู…ู„ูŠุฉ ู†ุงุฌุญุฉ", + "headers": { + "X-Rate-Limit": { + "description": "ุนุฏุฏ ุงู„ู…ูƒุงู„ู…ุงุช ุงู„ู…ุณู…ูˆุญ ุจู‡ุง ู„ู„ู…ุณุชุฎุฏู… ููŠ ุงู„ุณุงุนุฉ", + "schema": { + "type": "integer", + "format": "int32" + }, + "in": "header" + }, + "X-Expires-After": { + "description": "ุงู„ุชุงุฑูŠุฎ ุจุงู„ุชูˆู‚ูŠุช ุงู„ุนุงู„ู…ูŠ ุงู„ู…ู†ุณู‚ ุนู†ุฏู…ุง ุชู†ุชู‡ูŠ ุตู„ุงุญูŠุฉ ุงู„ุฑู…ุฒ ุงู„ู…ู…ูŠุฒ", + "schema": { + "type": "string", + "format": "date-time" + }, + "in": "header" + } + }, + "content": { + "application/xml": { + "schema": { + "type": "string" + } + }, + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "ุชู… ุฅุฏุฎุงู„ ุงุณู… ู…ุณุชุฎุฏู…/ูƒู„ู…ุฉ ู…ุฑูˆุฑ ุบูŠุฑ ุตุงู„ุญุฉ" + } + } + } + }, + "/user/logout": { + "get": { + "tags": [ + "user" + ], + "summary": "ุชุณุฌูŠู„ ุฎุฑูˆุฌ ุงู„ู…ุณุชุฎุฏู… ุงู„ู…ุณุฌู„ ุงู„ุฏุฎูˆู„ ุฅู„ู‰ ุงู„ุฌู„ุณุฉ ุงู„ุญุงู„ูŠุฉ", + "description": "", + "operationId": "logoutUser", + "parameters": [], + "responses": { + "default": { + "description": "ุนู…ู„ูŠุฉ ู†ุงุฌุญุฉ" + } + } + } + }, + "/user/{username}": { + "get": { + "tags": [ + "user" + ], + "summary": "ุงู„ุญุตูˆู„ ุนู„ู‰ ุงู„ู…ุณุชุฎุฏู… ุนู† ุทุฑูŠู‚ ุงุณู… ุงู„ู…ุณุชุฎุฏู…", + "description": "", + "operationId": "getUserByName", + "parameters": [ + { + "name": "username", + "in": "path", + "description": "ุงู„ุงุณู… ุงู„ุฐูŠ ูŠุฌุจ ุฌู„ุจู‡. ุงุณุชุฎุฏู… user1 ู„ู„ุงุฎุชุจุงุฑ.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "ุนู…ู„ูŠุฉ ู†ุงุฌุญุฉ", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "400": { + "description": "ุชู… ุฅุฏุฎุงู„ ุงุณู… ู…ุณุชุฎุฏู… ุบูŠุฑ ุตุงู„ุญ" + }, + "404": { + "description": "ู„ู… ูŠุชู… ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ู…ุณุชุฎุฏู…" + } + } + }, + "put": { + "tags": [ + "user" + ], + "summary": "ุชุญุฏูŠุซ ุงู„ู…ุณุชุฎุฏู…", + "description": "ู„ุง ูŠู…ูƒู† ุงู„ู‚ูŠุงู… ุจุฐู„ูƒ ุฅู„ุง ู…ู† ู‚ุจู„ ุงู„ู…ุณุชุฎุฏู… ุงู„ู…ุณุฌู„ ุงู„ุฏุฎูˆู„.", + "operationId": "updateUser", + "parameters": [ + { + "name": "username", + "in": "path", + "description": "ุงู„ุงุณู… ุงู„ุฐูŠ ูŠุฌุจ ุญุฐูู‡", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "ุชุญุฏูŠุซ ู…ุณุชุฎุฏู… ู…ูˆุฌูˆุฏ ููŠ ุงู„ู…ุชุฌุฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "responses": { + "default": { + "description": "ุนู…ู„ูŠุฉ ู†ุงุฌุญุฉ" + } + } + }, + "delete": { + "tags": [ + "user" + ], + "summary": "ุญุฐู ุงู„ู…ุณุชุฎุฏู…", + "description": "ู„ุง ูŠู…ูƒู† ุงู„ู‚ูŠุงู… ุจุฐู„ูƒ ุฅู„ุง ู…ู† ู‚ุจู„ ุงู„ู…ุณุชุฎุฏู… ุงู„ู…ุณุฌู„ ุงู„ุฏุฎูˆู„.", + "operationId": "deleteUser", + "parameters": [ + { + "name": "username", + "in": "path", + "description": "ุงู„ุงุณู… ุงู„ุฐูŠ ูŠุฌุจ ุญุฐูู‡", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "400": { + "description": "ุชู… ุฅุฏุฎุงู„ ุงุณู… ู…ุณุชุฎุฏู… ุบูŠุฑ ุตุงู„ุญ" + }, + "404": { + "description": "ู„ู… ูŠุชู… ุงู„ุนุซูˆุฑ ุนู„ู‰ ุงู„ู…ุณุชุฎุฏู…" + } + } + } + } + }, + "components": { + "schemas": { + "Order": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 10 + }, + "petId": { + "type": "integer", + "format": "int64", + "example": 198772 + }, + "quantity": { + "type": "integer", + "format": "int32", + "example": 7 + }, + "shipDate": { + "type": "string", + "format": "date-time" + }, + "status": { + "oneOf": [ + { + "const": "placed" + }, + { + "const": "approved" + }, + { + "const": "delivered" + } + ], + "description": "ุญุงู„ุฉ ุงู„ุทู„ุจ", + "example": "approved" + }, + "complete": { + "type": "boolean" + } + }, + "xml": { + "name": "order" + } + }, + "Customer": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 100000 + }, + "username": { + "type": "string", + "example": "fehguy" + }, + "address": { + "type": "array", + "xml": { + "name": "addresses", + "wrapped": true + }, + "items": { + "$ref": "#/components/schemas/Address" + } + } + }, + "xml": { + "name": "customer" + } + }, + "Address": { + "type": "object", + "properties": { + "street": { + "type": "string", + "example": "437 Lytton" + }, + "city": { + "type": "string", + "example": "Palo Alto" + }, + "state": { + "type": "string", + "example": "CA" + }, + "zip": { + "type": "string", + "example": "94301" + } + }, + "xml": { + "name": "address" + } + }, + "Category": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "name": { + "type": "string", + "example": "Dogs" + } + }, + "xml": { + "name": "category" + } + }, + "User": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 10 + }, + "username": { + "type": "string", + "example": "theUser" + }, + "firstName": { + "type": "string", + "example": "John" + }, + "lastName": { + "type": "string", + "example": "James" + }, + "email": { + "type": "string", + "example": "john@email.com" + }, + "password": { + "type": "string", + "example": "12345" + }, + "phone": { + "type": "string", + "example": "12345" + }, + "userStatus": { + "type": "integer", + "description": "ุญุงู„ุฉ ุงู„ู…ุณุชุฎุฏู…", + "format": "int32", + "example": 1 + } + }, + "xml": { + "name": "user" + } + }, + "Tag": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + } + }, + "xml": { + "name": "tag" + } + }, + "Pet": { + "required": [ + "name", + "photoUrls" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 10 + }, + "name": { + "type": "string", + "example": "doggie" + }, + "category": { + "$ref": "#/components/schemas/Category" + }, + "photoUrls": { + "type": "array", + "xml": { + "wrapped": true + }, + "items": { + "type": "string", + "xml": { + "name": "photoUrl" + } + } + }, + "tags": { + "type": "array", + "xml": { + "wrapped": true + }, + "items": { + "$ref": "#/components/schemas/Tag" + } + }, + "status": { + "oneOf": [ + { + "const": "available" + }, + { + "const": "pending" + }, + { + "const": "sold" + } + ], + "description": "ุญุงู„ุฉ ุงู„ุญูŠูˆุงู† ุงู„ุฃู„ูŠู ููŠ ุงู„ู…ุชุฌุฑ" + } + }, + "xml": { + "name": "pet" + } + }, + "ApiResponse": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "type": { + "type": "string" + }, + "message": { + "type": "string" + } + }, + "xml": { + "name": "##default" + } + } + }, + "securitySchemes": { + "petstore_auth": { + "type": "oauth2", + "flows": { + "implicit": { + "authorizationUrl": "https://petstore3.swagger.io/oauth/authorize", + "scopes": { + "write:pets": "modify pets in your account", + "read:pets": "read your pets" + } + } + } + }, + "api_key": { + "type": "apiKey", + "name": "api_key", + "in": "header" + } + } + }, + "x-samchon-emended": true +} \ No newline at end of file diff --git a/assets/output/petstore.swagger.ja.json b/assets/output/petstore.swagger.ja.json new file mode 100644 index 0000000..ab69e6e --- /dev/null +++ b/assets/output/petstore.swagger.ja.json @@ -0,0 +1,1212 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "Swagger ใƒšใƒƒใƒˆใ‚นใƒˆใ‚ข - OpenAPI 3.0", + "description": "ใ“ใ‚Œใฏใ€OpenAPI 3.0 ไป•ๆง˜ใซๅŸบใฅใ„ใŸใ‚ตใƒณใƒ—ใƒซใฎ Pet Store Server ใงใ™ใ€‚Swagger ใฎ่ฉณ็ดฐใซใคใ„ใฆใฏใ€[http://swagger.io](http://swagger.io) ใ‚’ๅ‚็…งใ—ใฆใใ ใ•ใ„ใ€‚ใƒšใƒƒใƒˆ ใ‚นใƒˆใ‚ขใฎ 3 ๅ›ž็›ฎใฎใ‚คใƒ†ใƒฌใƒผใ‚ทใƒงใƒณใงใฏใ€่จญ่จˆๅ„ชๅ…ˆใฎใ‚ขใƒ—ใƒญใƒผใƒใซๅˆ‡ใ‚Šๆ›ฟใˆใพใ—ใŸใ€‚ๅฎš็พฉ่‡ชไฝ“ใพใŸใฏใ‚ณใƒผใƒ‰ใซๅค‰ๆ›ดใ‚’ๅŠ ใˆใ‚‹ใ“ใจใงใ€API ใฎๆ”นๅ–„ใซใ”ๅ”ๅŠ›ใ„ใŸใ ใ‘ใ‚‹ใ‚ˆใ†ใซใชใ‚Šใพใ—ใŸใ€‚ใใ†ใ™ใ‚‹ใ“ใจใงใ€ๆ™‚้–“ใฎ็ตŒ้Žใจใจใ‚‚ใซ API ๅ…จไฝ“ใ‚’ๆ”นๅ–„ใ—ใ€OAS3 ใฎๆ–ฐๆฉŸ่ƒฝใฎไธ€้ƒจใ‚’ๅ…ฌ้–‹ใ™ใ‚‹ใ“ใจใŒใงใใพใ™ใ€‚ๅฝน็ซ‹ใคใƒชใƒณใ‚ฏใ‚’ใ„ใใคใ‹ใ”็ดนไป‹ใ—ใพใ™ใ€‚ - [ใƒšใƒƒใƒˆ ใ‚นใƒˆใ‚ขใฎใƒชใƒใ‚ธใƒˆใƒช](https://github.com/swagger-api/swagger-petstore) - [ใƒšใƒƒใƒˆ ใ‚นใƒˆใ‚ขใฎใ‚ฝใƒผใ‚น API ๅฎš็พฉ](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml)", + "termsOfService": "http://swagger.io/terms/", + "contact": { + "email": "apiteam@swagger.io" + }, + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0.html" + }, + "version": "1.0.17" + }, + "externalDocs": { + "description": "Swaggerใซใคใ„ใฆ่ฉณใ—ใ็Ÿฅใ‚‹", + "url": "http://swagger.io" + }, + "servers": [ + { + "url": "/api/v3" + } + ], + "tags": [ + { + "name": "pet", + "description": "ใƒšใƒƒใƒˆใซ้–ขใ™ใ‚‹ใ™ในใฆ", + "externalDocs": { + "description": "่ฉณ็ดฐใฏใ“ใกใ‚‰", + "url": "http://swagger.io" + } + }, + { + "name": "store", + "description": "ใƒšใƒƒใƒˆใ‚นใƒˆใ‚ขใฎๆณจๆ–‡ใธใฎใ‚ขใ‚ฏใ‚ปใ‚น", + "externalDocs": { + "description": "ๅฝ“ๅบ—ใซใคใ„ใฆใ‚‚ใฃใจ็Ÿฅใ‚‹", + "url": "http://swagger.io" + } + }, + { + "name": "user", + "description": "ใƒฆใƒผใ‚ถใƒผใซ้–ขใ™ใ‚‹ๆ“ไฝœ" + } + ], + "paths": { + "/pet": { + "put": { + "tags": [ + "pet" + ], + "summary": "ๆ—ขๅญ˜ใฎใƒšใƒƒใƒˆใ‚’ๆ›ดๆ–ฐใ™ใ‚‹", + "description": "ๆ—ขๅญ˜ใฎใƒšใƒƒใƒˆใ‚’IDใงๆ›ดๆ–ฐใ™ใ‚‹", + "operationId": "updatePet", + "requestBody": { + "description": "ใ‚นใƒˆใ‚ขๅ†…ใฎๆ—ขๅญ˜ใฎใƒšใƒƒใƒˆใ‚’ๆ›ดๆ–ฐใ™ใ‚‹", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "ๆ“ไฝœใฏๆˆๅŠŸใ—ใพใ—ใŸ", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + } + } + }, + "400": { + "description": "็„กๅŠนใชIDใŒๆŒ‡ๅฎšใ•ใ‚Œใพใ—ใŸ" + }, + "404": { + "description": "ใƒšใƒƒใƒˆใŒ่ฆ‹ใคใ‹ใ‚Šใพใ›ใ‚“" + }, + "405": { + "description": "ๆคœ่จผไพ‹ๅค–" + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + }, + "post": { + "tags": [ + "pet" + ], + "summary": "ใ‚นใƒˆใ‚ขใซๆ–ฐใ—ใ„ใƒšใƒƒใƒˆใ‚’่ฟฝๅŠ ใ™ใ‚‹", + "description": "ใ‚นใƒˆใ‚ขใซๆ–ฐใ—ใ„ใƒšใƒƒใƒˆใ‚’่ฟฝๅŠ ใ™ใ‚‹", + "operationId": "addPet", + "requestBody": { + "description": "ใ‚นใƒˆใ‚ขใงๆ–ฐใ—ใ„ใƒšใƒƒใƒˆใ‚’ไฝœๆˆใ™ใ‚‹", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "ๆ“ไฝœใฏๆˆๅŠŸใ—ใพใ—ใŸ", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + } + } + }, + "405": { + "description": "็„กๅŠนใชๅ…ฅๅŠ›" + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + } + }, + "/pet/findByStatus": { + "get": { + "tags": [ + "pet" + ], + "summary": "ใƒšใƒƒใƒˆใ‚’ใ‚นใƒ†ใƒผใ‚ฟใ‚นๅˆฅใซๆคœ็ดข", + "description": "่ค‡ๆ•ฐใฎใ‚นใƒ†ใƒผใ‚ฟใ‚นๅ€คใฏใ‚ณใƒณใƒžๅŒบๅˆ‡ใ‚Šใฎๆ–‡ๅญ—ๅˆ—ใงๆŒ‡ๅฎšใงใใพใ™", + "operationId": "findPetsByStatus", + "parameters": [ + { + "name": "status", + "in": "query", + "description": "ใƒ•ใ‚ฃใƒซใ‚ฟใƒผใง่€ƒๆ…ฎใ™ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚‹ใ‚นใƒ†ใƒผใ‚ฟใ‚นๅ€ค", + "required": false, + "explode": true, + "schema": { + "oneOf": [ + { + "const": "available" + }, + { + "const": "pending" + }, + { + "const": "sold" + } + ] + } + } + ], + "responses": { + "200": { + "description": "ๆˆๅŠŸใ—ใŸๆ“ไฝœ", + "content": { + "application/xml": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Pet" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Pet" + } + } + } + } + }, + "400": { + "description": "ใ‚นใƒ†ใƒผใ‚ฟใ‚นๅ€คใŒ็„กๅŠนใงใ™" + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + } + }, + "/pet/findByTags": { + "get": { + "tags": [ + "pet" + ], + "summary": "ใ‚ฟใ‚ฐใงใƒšใƒƒใƒˆใ‚’ๆคœ็ดข", + "description": "่ค‡ๆ•ฐใฎใ‚ฟใ‚ฐใฏใ‚ซใƒณใƒžๅŒบๅˆ‡ใ‚Šใฎๆ–‡ๅญ—ๅˆ—ใงๆŒ‡ๅฎšใงใใพใ™ใ€‚ใƒ†ใ‚นใƒˆใซใฏtag1ใ€tag2ใ€tag3ใ‚’ไฝฟ็”จใ—ใพใ™ใ€‚.", + "operationId": "findPetsByTags", + "parameters": [ + { + "name": "tags", + "in": "query", + "description": "ใƒ•ใ‚ฃใƒซใ‚ฟใƒชใƒณใ‚ฐใ™ใ‚‹ใ‚ฟใ‚ฐ", + "required": false, + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "ๆˆๅŠŸใ—ใŸๆ“ไฝœ", + "content": { + "application/xml": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Pet" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Pet" + } + } + } + } + }, + "400": { + "description": "ใ‚ฟใ‚ฐๅ€คใŒ็„กๅŠนใงใ™" + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + } + }, + "/pet/{petId}": { + "get": { + "tags": [ + "pet" + ], + "summary": "IDใงใƒšใƒƒใƒˆใ‚’ๆŽขใ™", + "description": "ใƒšใƒƒใƒˆใ‚’1ๅŒน่ฟ”ใ™", + "operationId": "getPetById", + "parameters": [ + { + "name": "petId", + "in": "path", + "description": "่ฟ”ๅดใ™ใ‚‹ใƒšใƒƒใƒˆใฎID", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "ๆˆๅŠŸใ—ใŸๆ“ไฝœ", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + } + } + }, + "400": { + "description": "็„กๅŠนใชIDใŒๆŒ‡ๅฎšใ•ใ‚Œใพใ—ใŸ" + }, + "404": { + "description": "ใƒšใƒƒใƒˆใŒ่ฆ‹ใคใ‹ใ‚Šใพใ›ใ‚“" + } + }, + "security": [ + { + "api_key": [] + }, + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + }, + "post": { + "tags": [ + "pet" + ], + "summary": "ใƒ•ใ‚ฉใƒผใƒ ใƒ‡ใƒผใ‚ฟใ‚’ไฝฟ็”จใ—ใฆใ‚นใƒˆใ‚ขๅ†…ใฎใƒšใƒƒใƒˆใ‚’ๆ›ดๆ–ฐใ—ใพใ™", + "description": "", + "operationId": "updatePetWithForm", + "parameters": [ + { + "name": "petId", + "in": "path", + "description": "ๆ›ดๆ–ฐใŒๅฟ…่ฆใชใƒšใƒƒใƒˆใฎID", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "name", + "in": "query", + "description": "ๆ›ดๆ–ฐใŒๅฟ…่ฆใชใƒšใƒƒใƒˆใฎๅๅ‰", + "schema": { + "type": "string" + } + }, + { + "name": "status", + "in": "query", + "description": "ๆ›ดๆ–ฐใŒๅฟ…่ฆใชใƒšใƒƒใƒˆใฎใ‚นใƒ†ใƒผใ‚ฟใ‚น", + "schema": { + "type": "string" + } + } + ], + "responses": { + "405": { + "description": "็„กๅŠนใชๅ…ฅๅŠ›" + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + }, + "delete": { + "tags": [ + "pet" + ], + "summary": "ใƒšใƒƒใƒˆใ‚’ๅ‰Š้™คใ—ใพใ™", + "description": "", + "operationId": "deletePet", + "parameters": [ + { + "name": "api_key", + "in": "header", + "description": "", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "petId", + "in": "path", + "description": "ๅ‰Š้™คใ™ใ‚‹ใƒšใƒƒใƒˆID", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "400": { + "description": "ใƒšใƒƒใƒˆใฎๅ€คใŒ็„กๅŠนใงใ™" + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + } + }, + "/pet/{petId}/uploadImage": { + "post": { + "tags": [ + "pet" + ], + "summary": "็”ปๅƒใ‚’ใ‚ขใƒƒใƒ—ใƒญใƒผใƒ‰ใ™ใ‚‹", + "description": "", + "operationId": "uploadFile", + "parameters": [ + { + "name": "petId", + "in": "path", + "description": "ๆ›ดๆ–ฐใ™ใ‚‹ใƒšใƒƒใƒˆใฎID", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "additionalMetadata", + "in": "query", + "description": "่ฟฝๅŠ ใฎใƒกใ‚ฟใƒ‡ใƒผใ‚ฟ", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + }, + "responses": { + "200": { + "description": "ๆˆๅŠŸใ—ใŸๆ“ไฝœ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + } + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + } + }, + "/store/inventory": { + "get": { + "tags": [ + "store" + ], + "summary": "ใƒšใƒƒใƒˆใฎๅœจๅบซใ‚’ใ‚นใƒ†ใƒผใ‚ฟใ‚นๅˆฅใซ่ฟ”ใ—ใพใ™", + "description": "ใ‚นใƒ†ใƒผใ‚ฟใ‚นใ‚ณใƒผใƒ‰ใจๆ•ฐ้‡ใฎใƒžใƒƒใƒ—ใ‚’่ฟ”ใ—ใพใ™", + "operationId": "getInventory", + "responses": { + "200": { + "description": "ๆˆๅŠŸใ—ใŸๆ“ไฝœ", + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "type": "integer", + "format": "int32" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/store/order": { + "post": { + "tags": [ + "store" + ], + "summary": "ใƒšใƒƒใƒˆใฎๆณจๆ–‡ใ‚’ใ™ใ‚‹", + "description": "ใ‚นใƒˆใ‚ขใงๆ–ฐใ—ใ„ๆณจๆ–‡ใ‚’ใ™ใ‚‹", + "operationId": "placeOrder", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Order" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Order" + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/Order" + } + } + } + }, + "responses": { + "200": { + "description": "ๆˆๅŠŸใ—ใŸๆ“ไฝœ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Order" + } + } + } + }, + "405": { + "description": "็„กๅŠนใชๅ…ฅๅŠ›" + } + } + } + }, + "/store/order/{orderId}": { + "get": { + "tags": [ + "store" + ], + "summary": "IDใงๆณจๆ–‡ๆ›ธใ‚’ๆคœ็ดขใ™ใ‚‹", + "description": "ๆœ‰ๅŠนใชๅฟœ็ญ”ใ‚’ๅพ—ใ‚‹ใซใฏใ€ๅ€คใŒ 5 ไปฅไธ‹ใพใŸใฏ 10 ใ‚’่ถ…ใˆใ‚‹ๆ•ดๆ•ฐ ID ใ‚’่ฉฆใ—ใฆใใ ใ•ใ„ใ€‚ใใฎไป–ใฎๅ€คใงใฏไพ‹ๅค–ใŒ็™บ็”Ÿใ—ใพใ™ใ€‚.", + "operationId": "getOrderById", + "parameters": [ + { + "name": "orderId", + "in": "path", + "description": "ๅ–ๅพ—ใ™ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚‹ๆณจๆ–‡ใฎID", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "ๆˆๅŠŸใ—ใŸๆ“ไฝœ", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Order" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Order" + } + } + } + }, + "400": { + "description": "็„กๅŠนใชIDใŒๆŒ‡ๅฎšใ•ใ‚Œใพใ—ใŸ" + }, + "404": { + "description": "ๆณจๆ–‡ใŒ่ฆ‹ใคใ‹ใ‚Šใพใ›ใ‚“" + } + } + }, + "delete": { + "tags": [ + "store" + ], + "summary": "IDใซใ‚ˆใ‚‹ๆณจๆ–‡ๆ›ธใฎๅ‰Š้™ค", + "description": "ๆœ‰ๅŠนใชๅฟœ็ญ”ใ‚’ๅพ—ใ‚‹ใซใฏใ€ๅ€คใŒ 1000 ๆœชๆบ€ใฎๆ•ดๆ•ฐ ID ใ‚’่ฉฆใ—ใฆใใ ใ•ใ„ใ€‚1000 ใ‚’่ถ…ใˆใ‚‹ๅ€คใพใŸใฏๆ•ดๆ•ฐไปฅๅค–ใฎๅ€คใ‚’ๆŒ‡ๅฎšใ™ใ‚‹ใจใ€API ใ‚จใƒฉใƒผใŒ็™บ็”Ÿใ—ใพใ™ใ€‚", + "operationId": "deleteOrder", + "parameters": [ + { + "name": "orderId", + "in": "path", + "description": "ๅ‰Š้™คใ™ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚‹ๆณจๆ–‡ใฎID", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "400": { + "description": "็„กๅŠนใชIDใŒๆŒ‡ๅฎšใ•ใ‚Œใพใ—ใŸ" + }, + "404": { + "description": "ๆณจๆ–‡ใŒ่ฆ‹ใคใ‹ใ‚Šใพใ›ใ‚“" + } + } + } + }, + "/user": { + "post": { + "tags": [ + "user" + ], + "summary": "ใƒฆใƒผใ‚ถใƒผใ‚’ไฝœๆˆ", + "description": "ใ“ใ‚Œใฏใƒญใ‚ฐใ‚คใƒณใ—ใŸใƒฆใƒผใ‚ถใƒผใฎใฟใŒๅฎŸ่กŒใงใใพใ™.", + "operationId": "createUser", + "requestBody": { + "description": "ใƒฆใƒผใ‚ถใƒผใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆใ‚’ไฝœๆˆใ—ใพใ—ใŸ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "responses": { + "default": { + "description": "ๆˆๅŠŸใ—ใŸๆ“ไฝœ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + } + } + } + }, + "/user/createWithList": { + "post": { + "tags": [ + "user" + ], + "summary": "ๆŒ‡ๅฎšใ•ใ‚ŒใŸๅ…ฅๅŠ›้…ๅˆ—ใ‚’ๆŒใคใƒฆใƒผใ‚ถใƒผใฎใƒชใ‚นใƒˆใ‚’ไฝœๆˆใ—ใพใ™", + "description": "ๆŒ‡ๅฎšใ•ใ‚ŒใŸๅ…ฅๅŠ›้…ๅˆ—ใ‚’ๆŒใคใƒฆใƒผใ‚ถใƒผใฎใƒชใ‚นใƒˆใ‚’ไฝœๆˆใ—ใพใ™", + "operationId": "createUsersWithListInput", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + } + } + } + }, + "responses": { + "200": { + "description": "ๆ“ไฝœใฏๆˆๅŠŸใ—ใพใ—ใŸ", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "default": { + "description": "ๆˆๅŠŸใ—ใŸๆ“ไฝœ" + } + } + } + }, + "/user/login": { + "get": { + "tags": [ + "user" + ], + "summary": "ใƒฆใƒผใ‚ถใƒผใ‚’ใ‚ทใ‚นใƒ†ใƒ ใซใƒญใ‚ฐใ‚คใƒณใ•ใ›ใ‚‹", + "description": "", + "operationId": "loginUser", + "parameters": [ + { + "name": "username", + "in": "query", + "description": "ใƒญใ‚ฐใ‚คใƒณๆ™‚ใฎใƒฆใƒผใ‚ถใƒผๅ", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "password", + "in": "query", + "description": "ใƒญใ‚ฐใ‚คใƒณ็”จใฎใƒ‘ใ‚นใƒฏใƒผใƒ‰๏ผˆๅนณๆ–‡๏ผ‰", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "ๆˆๅŠŸใ—ใŸๆ“ไฝœ", + "headers": { + "X-Rate-Limit": { + "description": "ใƒฆใƒผใ‚ถใƒผใŒ่จฑๅฏใ™ใ‚‹1ๆ™‚้–“ใ‚ใŸใ‚Šใฎ้€š่ฉฑๆ•ฐ", + "schema": { + "type": "integer", + "format": "int32" + }, + "in": "header" + }, + "X-Expires-After": { + "description": "ใƒˆใƒผใ‚ฏใƒณใฎๆœ‰ๅŠนๆœŸ้™๏ผˆUTC๏ผ‰", + "schema": { + "type": "string", + "format": "date-time" + }, + "in": "header" + } + }, + "content": { + "application/xml": { + "schema": { + "type": "string" + } + }, + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "็„กๅŠนใชใƒฆใƒผใ‚ถใƒผๅ/ใƒ‘ใ‚นใƒฏใƒผใƒ‰ใŒๅ…ฅๅŠ›ใ•ใ‚Œใพใ—ใŸ" + } + } + } + }, + "/user/logout": { + "get": { + "tags": [ + "user" + ], + "summary": "็พๅœจใƒญใ‚ฐใ‚คใƒณใ—ใฆใ„ใ‚‹ใƒฆใƒผใ‚ถใƒผใ‚ปใƒƒใ‚ทใƒงใƒณใ‚’ใƒญใ‚ฐใ‚ขใ‚ฆใƒˆใ—ใพใ™", + "description": "", + "operationId": "logoutUser", + "parameters": [], + "responses": { + "default": { + "description": "ๆˆๅŠŸใ—ใŸๆ“ไฝœ" + } + } + } + }, + "/user/{username}": { + "get": { + "tags": [ + "user" + ], + "summary": "ใƒฆใƒผใ‚ถใƒผๅใงใƒฆใƒผใ‚ถใƒผใ‚’ๅ–ๅพ—ใ™ใ‚‹", + "description": "", + "operationId": "getUserByName", + "parameters": [ + { + "name": "username", + "in": "path", + "description": "ๅ–ๅพ—ใ™ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚‹ๅๅ‰ใ€‚ใƒ†ใ‚นใƒˆใซใฏuser1ใ‚’ไฝฟ็”จใ—ใพใ™.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "ๆˆๅŠŸใ—ใŸๆ“ไฝœ", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "400": { + "description": "็„กๅŠนใชใƒฆใƒผใ‚ถใƒผๅใŒๅ…ฅๅŠ›ใ•ใ‚Œใพใ—ใŸ" + }, + "404": { + "description": "ใƒฆใƒผใ‚ถใƒผใŒ่ฆ‹ใคใ‹ใ‚Šใพใ›ใ‚“" + } + } + }, + "put": { + "tags": [ + "user" + ], + "summary": "ใƒฆใƒผใ‚ถใƒผใ‚’ๆ›ดๆ–ฐ", + "description": "ใ“ใ‚Œใฏใƒญใ‚ฐใ‚คใƒณใ—ใŸใƒฆใƒผใ‚ถใƒผใฎใฟใŒๅฎŸ่กŒใงใใพใ™.", + "operationId": "updateUser", + "parameters": [ + { + "name": "username", + "in": "path", + "description": "ๅ‰Š้™คใ™ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚‹ๅๅ‰", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "ใ‚นใƒˆใ‚ขๅ†…ใฎๆ—ขๅญ˜ใฎใƒฆใƒผใ‚ถใƒผใ‚’ๆ›ดๆ–ฐใ™ใ‚‹", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "responses": { + "default": { + "description": "ๆˆๅŠŸใ—ใŸๆ“ไฝœ" + } + } + }, + "delete": { + "tags": [ + "user" + ], + "summary": "ใƒฆใƒผใ‚ถใƒผใ‚’ๅ‰Š้™ค", + "description": "ใ“ใ‚Œใฏใƒญใ‚ฐใ‚คใƒณใ—ใŸใƒฆใƒผใ‚ถใƒผใฎใฟใŒๅฎŸ่กŒใงใใพใ™.", + "operationId": "deleteUser", + "parameters": [ + { + "name": "username", + "in": "path", + "description": "ๅ‰Š้™คใ™ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚‹ๅๅ‰", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "400": { + "description": "็„กๅŠนใชใƒฆใƒผใ‚ถใƒผๅใŒๅ…ฅๅŠ›ใ•ใ‚Œใพใ—ใŸ" + }, + "404": { + "description": "ใƒฆใƒผใ‚ถใƒผใŒ่ฆ‹ใคใ‹ใ‚Šใพใ›ใ‚“" + } + } + } + } + }, + "components": { + "schemas": { + "Order": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 10 + }, + "petId": { + "type": "integer", + "format": "int64", + "example": 198772 + }, + "quantity": { + "type": "integer", + "format": "int32", + "example": 7 + }, + "shipDate": { + "type": "string", + "format": "date-time" + }, + "status": { + "oneOf": [ + { + "const": "placed" + }, + { + "const": "approved" + }, + { + "const": "delivered" + } + ], + "description": "ๆณจๆ–‡็Šถๆณ", + "example": "approved" + }, + "complete": { + "type": "boolean" + } + }, + "xml": { + "name": "order" + } + }, + "Customer": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 100000 + }, + "username": { + "type": "string", + "example": "fehguy" + }, + "address": { + "type": "array", + "xml": { + "name": "addresses", + "wrapped": true + }, + "items": { + "$ref": "#/components/schemas/Address" + } + } + }, + "xml": { + "name": "customer" + } + }, + "Address": { + "type": "object", + "properties": { + "street": { + "type": "string", + "example": "437 Lytton" + }, + "city": { + "type": "string", + "example": "Palo Alto" + }, + "state": { + "type": "string", + "example": "CA" + }, + "zip": { + "type": "string", + "example": "94301" + } + }, + "xml": { + "name": "address" + } + }, + "Category": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "name": { + "type": "string", + "example": "Dogs" + } + }, + "xml": { + "name": "category" + } + }, + "User": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 10 + }, + "username": { + "type": "string", + "example": "theUser" + }, + "firstName": { + "type": "string", + "example": "John" + }, + "lastName": { + "type": "string", + "example": "James" + }, + "email": { + "type": "string", + "example": "john@email.com" + }, + "password": { + "type": "string", + "example": "12345" + }, + "phone": { + "type": "string", + "example": "12345" + }, + "userStatus": { + "type": "integer", + "description": "ใƒฆใƒผใ‚ถใƒผใ‚นใƒ†ใƒผใ‚ฟใ‚น", + "format": "int32", + "example": 1 + } + }, + "xml": { + "name": "user" + } + }, + "Tag": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + } + }, + "xml": { + "name": "tag" + } + }, + "Pet": { + "required": [ + "name", + "photoUrls" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 10 + }, + "name": { + "type": "string", + "example": "doggie" + }, + "category": { + "$ref": "#/components/schemas/Category" + }, + "photoUrls": { + "type": "array", + "xml": { + "wrapped": true + }, + "items": { + "type": "string", + "xml": { + "name": "photoUrl" + } + } + }, + "tags": { + "type": "array", + "xml": { + "wrapped": true + }, + "items": { + "$ref": "#/components/schemas/Tag" + } + }, + "status": { + "oneOf": [ + { + "const": "available" + }, + { + "const": "pending" + }, + { + "const": "sold" + } + ], + "description": "ๅบ—ๅ†…ใฎใƒšใƒƒใƒˆใฎ็Šถๆ…‹" + } + }, + "xml": { + "name": "pet" + } + }, + "ApiResponse": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "type": { + "type": "string" + }, + "message": { + "type": "string" + } + }, + "xml": { + "name": "##default" + } + } + }, + "securitySchemes": { + "petstore_auth": { + "type": "oauth2", + "flows": { + "implicit": { + "authorizationUrl": "https://petstore3.swagger.io/oauth/authorize", + "scopes": { + "write:pets": "modify pets in your account", + "read:pets": "read your pets" + } + } + } + }, + "api_key": { + "type": "apiKey", + "name": "api_key", + "in": "header" + } + } + }, + "x-samchon-emended": true +} \ No newline at end of file diff --git a/assets/output/petstore.swagger.ko.json b/assets/output/petstore.swagger.ko.json new file mode 100644 index 0000000..45654a2 --- /dev/null +++ b/assets/output/petstore.swagger.ko.json @@ -0,0 +1,1212 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "์Šค์›จ๊ฑฐ ํŽซ์Šคํ† ์–ด - OpenAPI 3.0", + "description": "์ด๊ฒƒ์€ OpenAPI 3.0 ์‚ฌ์–‘์„ ๊ธฐ๋ฐ˜์œผ๋กœ ํ•œ ์ƒ˜ํ”Œ ์• ์™„๋™๋ฌผ ๊ฐ€๊ฒŒ ์„œ๋ฒ„์ž…๋‹ˆ๋‹ค. Swagger์— ๋Œ€ํ•œ ์ž์„ธํ•œ ๋‚ด์šฉ์€ [http://swagger.io](http://swagger.io)์—์„œ ํ™•์ธํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์• ์™„๋™๋ฌผ ๊ฐ€๊ฒŒ์˜ ์„ธ ๋ฒˆ์งธ ๋ฐ˜๋ณต์—์„œ ์šฐ๋ฆฌ๋Š” ๋””์ž์ธ์„ ์šฐ์„ ํ•˜๋Š” ์ ‘๊ทผ ๋ฐฉ์‹์œผ๋กœ ์ „ํ™˜ํ–ˆ์Šต๋‹ˆ๋‹ค! ์ด์ œ ์ •์˜ ์ž์ฒด๋‚˜ ์ฝ”๋“œ๋ฅผ ๋ณ€๊ฒฝํ•˜์—ฌ API๋ฅผ ๊ฐœ์„ ํ•˜๋Š” ๋ฐ ๋„์›€์„ ์ค„ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์ด๋Ÿฐ ๋ฐฉ์‹์œผ๋กœ ์‹œ๊ฐ„์ด ์ง€๋‚จ์— ๋”ฐ๋ผ API๋ฅผ ์ „๋ฐ˜์ ์œผ๋กœ ๊ฐœ์„ ํ•˜๊ณ  OAS3์˜ ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ์ค‘ ์ผ๋ถ€๋ฅผ ๊ณต๊ฐœํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์œ ์šฉํ•œ ๋งํฌ: - [์• ์™„๋™๋ฌผ ๊ฐ€๊ฒŒ ๋ฆฌํฌ์ง€ํ† ๋ฆฌ](https://github.com/swagger-api/swagger-petstore) - [์• ์™„๋™๋ฌผ ๊ฐ€๊ฒŒ์˜ ์†Œ์Šค API ์ •์˜](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml)", + "termsOfService": "http://swagger.io/terms/", + "contact": { + "email": "apiteam@swagger.io" + }, + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0.html" + }, + "version": "1.0.17" + }, + "externalDocs": { + "description": "Swagger์— ๋Œ€ํ•ด ์ž์„ธํžˆ ์•Œ์•„๋ณด์„ธ์š”", + "url": "http://swagger.io" + }, + "servers": [ + { + "url": "/api/v3" + } + ], + "tags": [ + { + "name": "pet", + "description": "์• ์™„๋™๋ฌผ์— ๋Œ€ํ•œ ๋ชจ๋“  ๊ฒƒ", + "externalDocs": { + "description": "๋” ์•Œ์•„๋ณด๊ธฐ", + "url": "http://swagger.io" + } + }, + { + "name": "store", + "description": "Petstore ์ฃผ๋ฌธ์— ๋Œ€ํ•œ ์ ‘๊ทผ", + "externalDocs": { + "description": "์ €ํฌ ๋งค์žฅ์— ๋Œ€ํ•ด ๋” ์•Œ์•„๋ณด์„ธ์š”", + "url": "http://swagger.io" + } + }, + { + "name": "user", + "description": "์‚ฌ์šฉ์ž์— ๋Œ€ํ•œ ์ž‘์—…" + } + ], + "paths": { + "/pet": { + "put": { + "tags": [ + "pet" + ], + "summary": "๊ธฐ์กด ๋ฐ˜๋ ค๋™๋ฌผ ์—…๋ฐ์ดํŠธ", + "description": "ID๋กœ ๊ธฐ์กด ๋ฐ˜๋ ค๋™๋ฌผ ์—…๋ฐ์ดํŠธ", + "operationId": "updatePet", + "requestBody": { + "description": "์ƒ์ ์— ์žˆ๋Š” ๊ธฐ์กด ์• ์™„๋™๋ฌผ์„ ์—…๋ฐ์ดํŠธํ•˜์„ธ์š”", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์ž‘์—…", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + } + } + }, + "400": { + "description": "์ž˜๋ชป๋œ ID๊ฐ€ ์ œ๊ณต๋˜์—ˆ์Šต๋‹ˆ๋‹ค" + }, + "404": { + "description": "๋ฐ˜๋ ค๋™๋ฌผ์„ ์ฐพ์„ ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค" + }, + "405": { + "description": "๊ฒ€์ฆ ์˜ˆ์™ธ" + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + }, + "post": { + "tags": [ + "pet" + ], + "summary": "์ƒ์ ์— ์ƒˆ๋กœ์šด ์• ์™„๋™๋ฌผ์„ ์ถ”๊ฐ€ํ•˜์„ธ์š”", + "description": "์ƒ์ ์— ์ƒˆ๋กœ์šด ์• ์™„๋™๋ฌผ์„ ์ถ”๊ฐ€ํ•˜์„ธ์š”", + "operationId": "addPet", + "requestBody": { + "description": "์ƒ์ ์—์„œ ์ƒˆ๋กœ์šด ์• ์™„๋™๋ฌผ์„ ๋งŒ๋“œ์„ธ์š”", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์ž‘์—…", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + } + } + }, + "405": { + "description": "์ž˜๋ชป๋œ ์ž…๋ ฅ์ž…๋‹ˆ๋‹ค" + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + } + }, + "/pet/findByStatus": { + "get": { + "tags": [ + "pet" + ], + "summary": "์ƒํƒœ๋ณ„๋กœ ์• ์™„๋™๋ฌผ ์ฐพ๊ธฐ", + "description": "์—ฌ๋Ÿฌ ์ƒํƒœ ๊ฐ’์„ ์‰ผํ‘œ๋กœ ๊ตฌ๋ถ„๋œ ๋ฌธ์ž์—ด๋กœ ์ œ๊ณตํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.", + "operationId": "findPetsByStatus", + "parameters": [ + { + "name": "status", + "in": "query", + "description": "ํ•„ํ„ฐ์— ๊ณ ๋ คํ•ด์•ผ ํ•  ์ƒํƒœ ๊ฐ’", + "required": false, + "explode": true, + "schema": { + "oneOf": [ + { + "const": "available" + }, + { + "const": "pending" + }, + { + "const": "sold" + } + ] + } + } + ], + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์ž‘์—…", + "content": { + "application/xml": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Pet" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Pet" + } + } + } + } + }, + "400": { + "description": "์ž˜๋ชป๋œ ์ƒํƒœ ๊ฐ’์ž…๋‹ˆ๋‹ค" + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + } + }, + "/pet/findByTags": { + "get": { + "tags": [ + "pet" + ], + "summary": "ํƒœ๊ทธ๋กœ ์• ์™„๋™๋ฌผ ์ฐพ๊ธฐ", + "description": "์—ฌ๋Ÿฌ ํƒœ๊ทธ๋ฅผ ์‰ผํ‘œ๋กœ ๊ตฌ๋ถ„๋œ ๋ฌธ์ž์—ด๋กœ ์ œ๊ณตํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ํ…Œ์ŠคํŠธ์—๋Š” tag1, tag2, tag3์„ ์‚ฌ์šฉํ•˜์„ธ์š”..", + "operationId": "findPetsByTags", + "parameters": [ + { + "name": "tags", + "in": "query", + "description": "ํ•„ํ„ฐ๋งํ•  ํƒœ๊ทธ", + "required": false, + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์ž‘์—…", + "content": { + "application/xml": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Pet" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Pet" + } + } + } + } + }, + "400": { + "description": "์ž˜๋ชป๋œ ํƒœ๊ทธ ๊ฐ’์ž…๋‹ˆ๋‹ค" + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + } + }, + "/pet/{petId}": { + "get": { + "tags": [ + "pet" + ], + "summary": "ID๋กœ ๋ฐ˜๋ ค๋™๋ฌผ ์ฐพ๊ธฐ", + "description": "๋‹จ์ผ ์• ์™„๋™๋ฌผ์„ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค.", + "operationId": "getPetById", + "parameters": [ + { + "name": "petId", + "in": "path", + "description": "๋ฐ˜๋‚ฉํ•  ๋ฐ˜๋ ค๋™๋ฌผ์˜ ID", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์ž‘์—…", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + } + } + }, + "400": { + "description": "์ž˜๋ชป๋œ ID๊ฐ€ ์ œ๊ณต๋˜์—ˆ์Šต๋‹ˆ๋‹ค" + }, + "404": { + "description": "๋ฐ˜๋ ค๋™๋ฌผ์„ ์ฐพ์„ ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค" + } + }, + "security": [ + { + "api_key": [] + }, + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + }, + "post": { + "tags": [ + "pet" + ], + "summary": "์ƒ์ ์˜ ์• ์™„๋™๋ฌผ์„ ์–‘์‹ ๋ฐ์ดํ„ฐ๋กœ ์—…๋ฐ์ดํŠธํ•ฉ๋‹ˆ๋‹ค.", + "description": "", + "operationId": "updatePetWithForm", + "parameters": [ + { + "name": "petId", + "in": "path", + "description": "์—…๋ฐ์ดํŠธ๊ฐ€ ํ•„์š”ํ•œ ๋ฐ˜๋ ค๋™๋ฌผ์˜ ID", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "name", + "in": "query", + "description": "์—…๋ฐ์ดํŠธ๊ฐ€ ํ•„์š”ํ•œ ๋ฐ˜๋ ค๋™๋ฌผ์˜ ์ด๋ฆ„", + "schema": { + "type": "string" + } + }, + { + "name": "status", + "in": "query", + "description": "์—…๋ฐ์ดํŠธ๊ฐ€ ํ•„์š”ํ•œ ๋ฐ˜๋ ค๋™๋ฌผ์˜ ์ƒํƒœ", + "schema": { + "type": "string" + } + } + ], + "responses": { + "405": { + "description": "์ž˜๋ชป๋œ ์ž…๋ ฅ์ž…๋‹ˆ๋‹ค" + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + }, + "delete": { + "tags": [ + "pet" + ], + "summary": "์• ์™„๋™๋ฌผ์„ ์‚ญ์ œํ•ฉ๋‹ˆ๋‹ค", + "description": "", + "operationId": "deletePet", + "parameters": [ + { + "name": "api_key", + "in": "header", + "description": "", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "petId", + "in": "path", + "description": "์‚ญ์ œํ•  ๋ฐ˜๋ ค๋™๋ฌผ ID", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "400": { + "description": "์ž˜๋ชป๋œ ์• ์™„๋™๋ฌผ ๊ฐ’" + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + } + }, + "/pet/{petId}/uploadImage": { + "post": { + "tags": [ + "pet" + ], + "summary": "์ด๋ฏธ์ง€๋ฅผ ์—…๋กœ๋“œํ•ฉ๋‹ˆ๋‹ค", + "description": "", + "operationId": "uploadFile", + "parameters": [ + { + "name": "petId", + "in": "path", + "description": "์—…๋ฐ์ดํŠธํ•  ๋ฐ˜๋ ค๋™๋ฌผ ID", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "additionalMetadata", + "in": "query", + "description": "์ถ”๊ฐ€ ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + }, + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์ž‘์—…", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + } + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + } + }, + "/store/inventory": { + "get": { + "tags": [ + "store" + ], + "summary": "์ƒํƒœ๋ณ„ ์• ์™„๋™๋ฌผ ์žฌ๊ณ ๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค.", + "description": "์ƒํƒœ ์ฝ”๋“œ์˜ ๋งต์„ ์ˆ˜๋Ÿ‰์œผ๋กœ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค.", + "operationId": "getInventory", + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์ž‘์—…", + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "type": "integer", + "format": "int32" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/store/order": { + "post": { + "tags": [ + "store" + ], + "summary": "๋ฐ˜๋ ค๋™๋ฌผ ์ฃผ๋ฌธํ•˜๊ธฐ", + "description": "๋งค์žฅ์—์„œ ์ƒˆ๋กœ์šด ์ฃผ๋ฌธ์„ ํ•˜์„ธ์š”", + "operationId": "placeOrder", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Order" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Order" + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/Order" + } + } + } + }, + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์ž‘์—…", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Order" + } + } + } + }, + "405": { + "description": "์ž˜๋ชป๋œ ์ž…๋ ฅ์ž…๋‹ˆ๋‹ค" + } + } + } + }, + "/store/order/{orderId}": { + "get": { + "tags": [ + "store" + ], + "summary": "ID๋กœ ๊ตฌ๋งค ์ฃผ๋ฌธ ์ฐพ๊ธฐ", + "description": "์œ ํšจํ•œ ์‘๋‹ต์„ ์œ„ํ•ด ๊ฐ’์ด <= 5 ๋˜๋Š” > 10์ธ ์ •์ˆ˜ ID๋ฅผ ์‹œ๋„ํ•˜์„ธ์š”. ๋‹ค๋ฅธ ๊ฐ’์€ ์˜ˆ์™ธ๋ฅผ ์ƒ์„ฑํ•ฉ๋‹ˆ๋‹ค..", + "operationId": "getOrderById", + "parameters": [ + { + "name": "orderId", + "in": "path", + "description": "๊ฐ€์ ธ์™€์•ผ ํ•  ์ฃผ๋ฌธ์˜ ID", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์ž‘์—…", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Order" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Order" + } + } + } + }, + "400": { + "description": "์ž˜๋ชป๋œ ID๊ฐ€ ์ œ๊ณต๋˜์—ˆ์Šต๋‹ˆ๋‹ค" + }, + "404": { + "description": "์ฃผ๋ฌธ์„ ์ฐพ์„ ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค" + } + } + }, + "delete": { + "tags": [ + "store" + ], + "summary": "ID๋กœ ๊ตฌ๋งค ์ฃผ๋ฌธ ์‚ญ์ œ", + "description": "์œ ํšจํ•œ ์‘๋‹ต์„ ์œ„ํ•ด ๊ฐ’์ด 1000 ๋ฏธ๋งŒ์ธ ์ •์ˆ˜ ID๋ฅผ ์‹œ๋„ํ•˜์„ธ์š”. 1000๋ณด๋‹ค ํฌ๊ฑฐ๋‚˜ ์ •์ˆ˜๊ฐ€ ์•„๋‹Œ ๊ฒฝ์šฐ API ์˜ค๋ฅ˜๊ฐ€ ๋ฐœ์ƒํ•ฉ๋‹ˆ๋‹ค.", + "operationId": "deleteOrder", + "parameters": [ + { + "name": "orderId", + "in": "path", + "description": "์‚ญ์ œํ•ด์•ผ ํ•  ์ฃผ๋ฌธ์˜ ID", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "400": { + "description": "์ž˜๋ชป๋œ ID๊ฐ€ ์ œ๊ณต๋˜์—ˆ์Šต๋‹ˆ๋‹ค" + }, + "404": { + "description": "์ฃผ๋ฌธ์„ ์ฐพ์„ ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค" + } + } + } + }, + "/user": { + "post": { + "tags": [ + "user" + ], + "summary": "์‚ฌ์šฉ์ž ์ƒ์„ฑ", + "description": "์ด ์ž‘์—…์€ ๋กœ๊ทธ์ธํ•œ ์‚ฌ์šฉ์ž๋งŒ ์ˆ˜ํ–‰ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค..", + "operationId": "createUser", + "requestBody": { + "description": "์‚ฌ์šฉ์ž ๊ฐ์ฒด ์ƒ์„ฑ๋จ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "responses": { + "default": { + "description": "์„ฑ๊ณต์ ์ธ ์ž‘์—…", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + } + } + } + }, + "/user/createWithList": { + "post": { + "tags": [ + "user" + ], + "summary": "์ฃผ์–ด์ง„ ์ž…๋ ฅ ๋ฐฐ์—ด์„ ์‚ฌ์šฉํ•˜์—ฌ ์‚ฌ์šฉ์ž ๋ชฉ๋ก์„ ์ƒ์„ฑํ•ฉ๋‹ˆ๋‹ค.", + "description": "์ฃผ์–ด์ง„ ์ž…๋ ฅ ๋ฐฐ์—ด์„ ์‚ฌ์šฉํ•˜์—ฌ ์‚ฌ์šฉ์ž ๋ชฉ๋ก์„ ์ƒ์„ฑํ•ฉ๋‹ˆ๋‹ค.", + "operationId": "createUsersWithListInput", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + } + } + } + }, + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์ž‘์—…", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "default": { + "description": "์„ฑ๊ณต์ ์ธ ์ž‘์—…" + } + } + } + }, + "/user/login": { + "get": { + "tags": [ + "user" + ], + "summary": "์‚ฌ์šฉ์ž๋ฅผ ์‹œ์Šคํ…œ์— ๋กœ๊ทธ์ธํ•ฉ๋‹ˆ๋‹ค", + "description": "", + "operationId": "loginUser", + "parameters": [ + { + "name": "username", + "in": "query", + "description": "๋กœ๊ทธ์ธ์„ ์œ„ํ•œ ์‚ฌ์šฉ์ž ์ด๋ฆ„", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "password", + "in": "query", + "description": "์ผ๋ฐ˜ ํ…์ŠคํŠธ๋กœ ๋กœ๊ทธ์ธํ•˜๊ธฐ ์œ„ํ•œ ๋น„๋ฐ€๋ฒˆํ˜ธ", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์ž‘์—…", + "headers": { + "X-Rate-Limit": { + "description": "์‚ฌ์šฉ์ž๊ฐ€ ํ—ˆ์šฉํ•œ ์‹œ๊ฐ„๋‹น ํ†ตํ™” ์ˆ˜", + "schema": { + "type": "integer", + "format": "int32" + }, + "in": "header" + }, + "X-Expires-After": { + "description": "ํ† ํฐ์ด ๋งŒ๋ฃŒ๋˜๋Š” UTC ๋‚ ์งœ", + "schema": { + "type": "string", + "format": "date-time" + }, + "in": "header" + } + }, + "content": { + "application/xml": { + "schema": { + "type": "string" + } + }, + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "์ž˜๋ชป๋œ ์‚ฌ์šฉ์ž ์ด๋ฆ„/์•”ํ˜ธ๊ฐ€ ์ œ๊ณต๋˜์—ˆ์Šต๋‹ˆ๋‹ค." + } + } + } + }, + "/user/logout": { + "get": { + "tags": [ + "user" + ], + "summary": "ํ˜„์žฌ ๋กœ๊ทธ์ธํ•œ ์‚ฌ์šฉ์ž ์„ธ์…˜์—์„œ ๋กœ๊ทธ์•„์›ƒํ•ฉ๋‹ˆ๋‹ค.", + "description": "", + "operationId": "logoutUser", + "parameters": [], + "responses": { + "default": { + "description": "์„ฑ๊ณต์ ์ธ ์ž‘์—…" + } + } + } + }, + "/user/{username}": { + "get": { + "tags": [ + "user" + ], + "summary": "์‚ฌ์šฉ์ž ์ด๋ฆ„์œผ๋กœ ์‚ฌ์šฉ์ž ๊ฐ€์ ธ์˜ค๊ธฐ", + "description": "", + "operationId": "getUserByName", + "parameters": [ + { + "name": "username", + "in": "path", + "description": "ํŽ˜์น˜ํ•ด์•ผ ํ•  ์ด๋ฆ„์ž…๋‹ˆ๋‹ค. ํ…Œ์ŠคํŠธ์—๋Š” user1์„ ์‚ฌ์šฉํ•˜์„ธ์š”..", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "์„ฑ๊ณต์ ์ธ ์ž‘์—…", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "400": { + "description": "์ž˜๋ชป๋œ ์‚ฌ์šฉ์ž ์ด๋ฆ„์ด ์ œ๊ณต๋˜์—ˆ์Šต๋‹ˆ๋‹ค" + }, + "404": { + "description": "์‚ฌ์šฉ์ž๋ฅผ ์ฐพ์„ ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค" + } + } + }, + "put": { + "tags": [ + "user" + ], + "summary": "์‚ฌ์šฉ์ž ์—…๋ฐ์ดํŠธ", + "description": "์ด ์ž‘์—…์€ ๋กœ๊ทธ์ธํ•œ ์‚ฌ์šฉ์ž๋งŒ ์ˆ˜ํ–‰ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค..", + "operationId": "updateUser", + "parameters": [ + { + "name": "username", + "in": "path", + "description": "์‚ญ์ œํ•ด์•ผ ํ•  ์ด๋ฆ„", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "์Šคํ† ์–ด์— ์žˆ๋Š” ๊ธฐ์กด ์‚ฌ์šฉ์ž ์—…๋ฐ์ดํŠธ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "responses": { + "default": { + "description": "์„ฑ๊ณต์ ์ธ ์ž‘์—…" + } + } + }, + "delete": { + "tags": [ + "user" + ], + "summary": "์‚ฌ์šฉ์ž ์‚ญ์ œ", + "description": "์ด ์ž‘์—…์€ ๋กœ๊ทธ์ธํ•œ ์‚ฌ์šฉ์ž๋งŒ ์ˆ˜ํ–‰ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค..", + "operationId": "deleteUser", + "parameters": [ + { + "name": "username", + "in": "path", + "description": "์‚ญ์ œํ•ด์•ผ ํ•  ์ด๋ฆ„", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "400": { + "description": "์ž˜๋ชป๋œ ์‚ฌ์šฉ์ž ์ด๋ฆ„์ด ์ œ๊ณต๋˜์—ˆ์Šต๋‹ˆ๋‹ค" + }, + "404": { + "description": "์‚ฌ์šฉ์ž๋ฅผ ์ฐพ์„ ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค" + } + } + } + } + }, + "components": { + "schemas": { + "Order": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 10 + }, + "petId": { + "type": "integer", + "format": "int64", + "example": 198772 + }, + "quantity": { + "type": "integer", + "format": "int32", + "example": 7 + }, + "shipDate": { + "type": "string", + "format": "date-time" + }, + "status": { + "oneOf": [ + { + "const": "placed" + }, + { + "const": "approved" + }, + { + "const": "delivered" + } + ], + "description": "์ฃผ๋ฌธ ์ƒํƒœ", + "example": "approved" + }, + "complete": { + "type": "boolean" + } + }, + "xml": { + "name": "order" + } + }, + "Customer": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 100000 + }, + "username": { + "type": "string", + "example": "fehguy" + }, + "address": { + "type": "array", + "xml": { + "name": "addresses", + "wrapped": true + }, + "items": { + "$ref": "#/components/schemas/Address" + } + } + }, + "xml": { + "name": "customer" + } + }, + "Address": { + "type": "object", + "properties": { + "street": { + "type": "string", + "example": "437 Lytton" + }, + "city": { + "type": "string", + "example": "Palo Alto" + }, + "state": { + "type": "string", + "example": "CA" + }, + "zip": { + "type": "string", + "example": "94301" + } + }, + "xml": { + "name": "address" + } + }, + "Category": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "name": { + "type": "string", + "example": "Dogs" + } + }, + "xml": { + "name": "category" + } + }, + "User": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 10 + }, + "username": { + "type": "string", + "example": "theUser" + }, + "firstName": { + "type": "string", + "example": "John" + }, + "lastName": { + "type": "string", + "example": "James" + }, + "email": { + "type": "string", + "example": "john@email.com" + }, + "password": { + "type": "string", + "example": "12345" + }, + "phone": { + "type": "string", + "example": "12345" + }, + "userStatus": { + "type": "integer", + "description": "์‚ฌ์šฉ์ž ์ƒํƒœ", + "format": "int32", + "example": 1 + } + }, + "xml": { + "name": "user" + } + }, + "Tag": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + } + }, + "xml": { + "name": "tag" + } + }, + "Pet": { + "required": [ + "name", + "photoUrls" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 10 + }, + "name": { + "type": "string", + "example": "doggie" + }, + "category": { + "$ref": "#/components/schemas/Category" + }, + "photoUrls": { + "type": "array", + "xml": { + "wrapped": true + }, + "items": { + "type": "string", + "xml": { + "name": "photoUrl" + } + } + }, + "tags": { + "type": "array", + "xml": { + "wrapped": true + }, + "items": { + "$ref": "#/components/schemas/Tag" + } + }, + "status": { + "oneOf": [ + { + "const": "available" + }, + { + "const": "pending" + }, + { + "const": "sold" + } + ], + "description": "๋งค์žฅ ๋‚ด ๋ฐ˜๋ ค๋™๋ฌผ ์ƒํƒœ" + } + }, + "xml": { + "name": "pet" + } + }, + "ApiResponse": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "type": { + "type": "string" + }, + "message": { + "type": "string" + } + }, + "xml": { + "name": "##default" + } + } + }, + "securitySchemes": { + "petstore_auth": { + "type": "oauth2", + "flows": { + "implicit": { + "authorizationUrl": "https://petstore3.swagger.io/oauth/authorize", + "scopes": { + "write:pets": "modify pets in your account", + "read:pets": "read your pets" + } + } + } + }, + "api_key": { + "type": "apiKey", + "name": "api_key", + "in": "header" + } + } + }, + "x-samchon-emended": true +} \ No newline at end of file diff --git a/assets/output/shopping.swagger.ar.json b/assets/output/shopping.swagger.ar.json index 4213a71..7428e45 100644 --- a/assets/output/shopping.swagger.ar.json +++ b/assets/output/shopping.swagger.ar.json @@ -1868,7 +1868,7 @@ "/shoppings/admins/sales/{saleId}/snapshots/{id}/flip": { "get": { "summary": "ุงุญุตู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช ู„ู‚ุทุฉ ู…ู‚ู„ูˆุจุฉ", - "description": "ุงุญุตู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช ู„ู‚ุทุฉ ู…ู‚ู„ูˆุจุฉ. ุงุญุตู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช {@link IShoppingSale sale} ู„ู„ู‚ุทุฉ ู…ู‚ู„ูˆุจุฉ. ูƒู…ุง ุชุฑู‰ ู…ู† ู†ูˆุน ุงู„ุฅุฑุฌุงุนุŒ ุชุนูŠุฏ ู‡ุฐู‡ ุงู„ุฏุงู„ุฉ ู…ุนู„ูˆู…ุงุช {@link IShoppingSale sale}. ุจุงู„ู…ู†ุงุณุจุฉุŒ ู…ุนู„ูˆู…ุงุช ุงู„ู„ู‚ุทุฉ ู„ูŠุณุช ุงู„ุฃุญุฏุซุŒ ุจู„ ู‡ูŠ ู…ุนู„ูˆู…ุงุช ู…ู‚ู„ูˆุจุฉ ููŠ ุฌุงู†ุจ ุงู„ู„ู‚ุทุฉ. ุฃูŠุถู‹ุงุŒ ุฅุฐุง ูƒู†ุช ุจุงุฆุนู‹ุง ููŠ {@link IShoppingSeller}ุŒ ููŠู…ูƒู†ูƒ ูู‚ุท ุงู„ูˆุตูˆู„ ุฅู„ู‰ ู„ู‚ุทุงุช {@link IShoppingSale sale} ุงู„ุฎุงุตุฉ ุจูƒ. ุจุฎู„ุงู ุฐู„ูƒุŒ ูŠู…ูƒู†ูƒ ุงู„ูˆุตูˆู„ ุฅู„ู‰ ูƒู„ ู„ู‚ุทุงุช ุงู„ู…ุจูŠุนุงุช ุญุชู‰ ู„ูˆ ุชู… ุฅุบู„ุงู‚ ุงู„ุจูŠุน ุฃูˆ ุชุนู„ูŠู‚ู‡.", + "description": "ุงุญุตู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช ู„ู‚ุทุฉ ู…ู‚ู„ูˆุจุฉ. ุงุญุตู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช {@link IShoppingSale sale} ู„ู„ู‚ุทุฉ ู…ู‚ู„ูˆุจุฉ. ูƒู…ุง ุชุฑู‰ ู…ู† ู†ูˆุน ุงู„ุฅุฑุฌุงุนุŒ ุชุนูŠุฏ ู‡ุฐู‡ ุงู„ุฏุงู„ุฉ ู…ุนู„ูˆู…ุงุช {@link IShoppingSale sale}. ุจุงู„ู…ู†ุงุณุจุฉุŒ ู…ุนู„ูˆู…ุงุช ุงู„ุชุฎููŠุถ ู„ูŠุณุช ุงู„ุฃุญุฏุซุŒ ุจู„ ู‡ูŠ ู…ุนู„ูˆู…ุงุช ู…ู‚ู„ูˆุจุฉ ููŠ ุฌุงู†ุจ ุงู„ู„ู‚ุทุฉ. ุฃูŠุถู‹ุงุŒ ุฅุฐุง ูƒู†ุช ุจุงุฆุนู‹ุง ููŠ {@link IShoppingSeller}ุŒ ููŠู…ูƒู†ูƒ ูู‚ุท ุงู„ูˆุตูˆู„ ุฅู„ู‰ ู„ู‚ุทุงุช {@link IShoppingSale sale} ุงู„ุฎุงุตุฉ ุจูƒ. ุจุฎู„ุงู ุฐู„ูƒุŒ ูŠู…ูƒู†ูƒ ุงู„ูˆุตูˆู„ ุฅู„ู‰ ูƒู„ ู„ู‚ุทุงุช ุงู„ู…ุจูŠุนุงุช ุญุชู‰ ู„ูˆ ุชู… ุฅุบู„ุงู‚ ุงู„ุจูŠุน ุฃูˆ ุชุนู„ูŠู‚ู‡.", "tags": [ "Sale" ], @@ -3173,7 +3173,7 @@ ] }, "post": { - "summary": "ุฅู†ุดุงุก ุทู„ุจ ุฑุณูˆู… ุฅูŠุฏุงุน ุฌุฏูŠุฏ", + "summary": "ุฅู†ุดุงุก ุทู„ุจ ุฅูŠุฏุงุน ุฌุฏูŠุฏ", "description": "ุฅู†ุดุงุก ุชุทุจูŠู‚ ุฌุฏูŠุฏ ู„ุฑุณูˆู… ุงู„ุฅูŠุฏุงุน. ุฅู†ุดุงุก ุชุทุจูŠู‚ ุฌุฏูŠุฏ ู„ุฑุณูˆู… ุงู„ุฅูŠุฏุงุน {@link IShoppingDepositCharge}. ุจุงู„ู…ู†ุงุณุจุฉุŒ ู‡ุฐู‡ ุงู„ูˆุธูŠูุฉ ู„ุง ุชุนู†ูŠ ุฅูƒู…ุงู„ ุฑุณูˆู… ุงู„ุฅูŠุฏุงุนุŒ ุจู„ ุชุนู†ูŠ ูู‚ุท ุฃู† {@link IShoppingCustomer customer} ูŠุทุจู‚ ุฑุณูˆู… ุงู„ุฅูŠุฏุงุน. ู„ุง ุชูƒุชู…ู„ ุฑุณูˆู… ุงู„ุฅูŠุฏุงุน ุฅู„ุง ุนู†ุฏู…ุง ูŠุฏูุน ุงู„ุนู…ูŠู„ {@link IShoppingDepositChargePublish.publish} ุฑุณูˆู… ุงู„ุฅูŠุฏุงุน.", "tags": [ "Discount" @@ -5605,7 +5605,7 @@ "/shoppings/customers/sales/{saleId}/snapshots/{id}/flip": { "get": { "summary": "ุงุญุตู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช ู„ู‚ุทุฉ ู…ู‚ู„ูˆุจุฉ", - "description": "ุงุญุตู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช ู„ู‚ุทุฉ ู…ู‚ู„ูˆุจุฉ. ุงุญุตู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช {@link IShoppingSale sale} ู„ู„ู‚ุทุฉ ู…ู‚ู„ูˆุจุฉ. ูƒู…ุง ุชุฑู‰ ู…ู† ู†ูˆุน ุงู„ุฅุฑุฌุงุนุŒ ุชุนูŠุฏ ู‡ุฐู‡ ุงู„ุฏุงู„ุฉ ู…ุนู„ูˆู…ุงุช {@link IShoppingSale sale}. ุจุงู„ู…ู†ุงุณุจุฉุŒ ู…ุนู„ูˆู…ุงุช ุงู„ู„ู‚ุทุฉ ู„ูŠุณุช ุงู„ุฃุญุฏุซุŒ ุจู„ ู‡ูŠ ู…ุนู„ูˆู…ุงุช ู…ู‚ู„ูˆุจุฉ ููŠ ุฌุงู†ุจ ุงู„ู„ู‚ุทุฉ. ุฃูŠุถู‹ุงุŒ ุฅุฐุง ูƒู†ุช ุจุงุฆุนู‹ุง ููŠ {@link IShoppingSeller}ุŒ ููŠู…ูƒู†ูƒ ูู‚ุท ุงู„ูˆุตูˆู„ ุฅู„ู‰ ู„ู‚ุทุงุช {@link IShoppingSale sale} ุงู„ุฎุงุตุฉ ุจูƒ. ุจุฎู„ุงู ุฐู„ูƒุŒ ูŠู…ูƒู†ูƒ ุงู„ูˆุตูˆู„ ุฅู„ู‰ ูƒู„ ู„ู‚ุทุงุช ุงู„ู…ุจูŠุนุงุช ุญุชู‰ ู„ูˆ ุชู… ุฅุบู„ุงู‚ ุงู„ุจูŠุน ุฃูˆ ุชุนู„ูŠู‚ู‡.", + "description": "ุงุญุตู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช ู„ู‚ุทุฉ ู…ู‚ู„ูˆุจุฉ. ุงุญุตู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช {@link IShoppingSale sale} ู„ู„ู‚ุทุฉ ู…ู‚ู„ูˆุจุฉ. ูƒู…ุง ุชุฑู‰ ู…ู† ู†ูˆุน ุงู„ุฅุฑุฌุงุนุŒ ุชุนูŠุฏ ู‡ุฐู‡ ุงู„ุฏุงู„ุฉ ู…ุนู„ูˆู…ุงุช {@link IShoppingSale sale}. ุจุงู„ู…ู†ุงุณุจุฉุŒ ู…ุนู„ูˆู…ุงุช ุงู„ุชุฎููŠุถ ู„ูŠุณุช ุงู„ุฃุญุฏุซุŒ ุจู„ ู‡ูŠ ู…ุนู„ูˆู…ุงุช ู…ู‚ู„ูˆุจุฉ ููŠ ุฌุงู†ุจ ุงู„ู„ู‚ุทุฉ. ุฃูŠุถู‹ุงุŒ ุฅุฐุง ูƒู†ุช ุจุงุฆุนู‹ุง ููŠ {@link IShoppingSeller}ุŒ ููŠู…ูƒู†ูƒ ูู‚ุท ุงู„ูˆุตูˆู„ ุฅู„ู‰ ู„ู‚ุทุงุช {@link IShoppingSale sale} ุงู„ุฎุงุตุฉ ุจูƒ. ุจุฎู„ุงู ุฐู„ูƒุŒ ูŠู…ูƒู†ูƒ ุงู„ูˆุตูˆู„ ุฅู„ู‰ ูƒู„ ู„ู‚ุทุงุช ุงู„ู…ุจูŠุนุงุช ุญุชู‰ ู„ูˆ ุชู… ุฅุบู„ุงู‚ ุงู„ุจูŠุน ุฃูˆ ุชุนู„ูŠู‚ู‡.", "tags": [ "Sale" ], @@ -8208,7 +8208,7 @@ "/shoppings/sellers/sales/{saleId}/snapshots/{id}/flip": { "get": { "summary": "ุงุญุตู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช ู„ู‚ุทุฉ ู…ู‚ู„ูˆุจุฉ", - "description": "ุงุญุตู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช ู„ู‚ุทุฉ ู…ู‚ู„ูˆุจุฉ. ุงุญุตู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช {@link IShoppingSale sale} ู„ู„ู‚ุทุฉ ู…ู‚ู„ูˆุจุฉ. ูƒู…ุง ุชุฑู‰ ู…ู† ู†ูˆุน ุงู„ุฅุฑุฌุงุนุŒ ุชุนูŠุฏ ู‡ุฐู‡ ุงู„ุฏุงู„ุฉ ู…ุนู„ูˆู…ุงุช {@link IShoppingSale sale}. ุจุงู„ู…ู†ุงุณุจุฉุŒ ู…ุนู„ูˆู…ุงุช ุงู„ู„ู‚ุทุฉ ู„ูŠุณุช ุงู„ุฃุญุฏุซุŒ ุจู„ ู‡ูŠ ู…ุนู„ูˆู…ุงุช ู…ู‚ู„ูˆุจุฉ ููŠ ุฌุงู†ุจ ุงู„ู„ู‚ุทุฉ. ุฃูŠุถู‹ุงุŒ ุฅุฐุง ูƒู†ุช ุจุงุฆุนู‹ุง ููŠ {@link IShoppingSeller}ุŒ ููŠู…ูƒู†ูƒ ูู‚ุท ุงู„ูˆุตูˆู„ ุฅู„ู‰ ู„ู‚ุทุงุช {@link IShoppingSale sale} ุงู„ุฎุงุตุฉ ุจูƒ. ุจุฎู„ุงู ุฐู„ูƒุŒ ูŠู…ูƒู†ูƒ ุงู„ูˆุตูˆู„ ุฅู„ู‰ ูƒู„ ู„ู‚ุทุงุช ุงู„ู…ุจูŠุนุงุช ุญุชู‰ ู„ูˆ ุชู… ุฅุบู„ุงู‚ ุงู„ุจูŠุน ุฃูˆ ุชุนู„ูŠู‚ู‡.", + "description": "ุงุญุตู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช ู„ู‚ุทุฉ ู…ู‚ู„ูˆุจุฉ. ุงุญุตู„ ุนู„ู‰ ู…ุนู„ูˆู…ุงุช {@link IShoppingSale sale} ู„ู„ู‚ุทุฉ ู…ู‚ู„ูˆุจุฉ. ูƒู…ุง ุชุฑู‰ ู…ู† ู†ูˆุน ุงู„ุฅุฑุฌุงุนุŒ ุชุนูŠุฏ ู‡ุฐู‡ ุงู„ุฏุงู„ุฉ ู…ุนู„ูˆู…ุงุช {@link IShoppingSale sale}. ุจุงู„ู…ู†ุงุณุจุฉุŒ ู…ุนู„ูˆู…ุงุช ุงู„ุชุฎููŠุถ ู„ูŠุณุช ุงู„ุฃุญุฏุซุŒ ุจู„ ู‡ูŠ ู…ุนู„ูˆู…ุงุช ู…ู‚ู„ูˆุจุฉ ููŠ ุฌุงู†ุจ ุงู„ู„ู‚ุทุฉ. ุฃูŠุถู‹ุงุŒ ุฅุฐุง ูƒู†ุช ุจุงุฆุนู‹ุง ููŠ {@link IShoppingSeller}ุŒ ููŠู…ูƒู†ูƒ ูู‚ุท ุงู„ูˆุตูˆู„ ุฅู„ู‰ ู„ู‚ุทุงุช {@link IShoppingSale sale} ุงู„ุฎุงุตุฉ ุจูƒ. ุจุฎู„ุงู ุฐู„ูƒุŒ ูŠู…ูƒู†ูƒ ุงู„ูˆุตูˆู„ ุฅู„ู‰ ูƒู„ ู„ู‚ุทุงุช ุงู„ู…ุจูŠุนุงุช ุญุชู‰ ู„ูˆ ุชู… ุฅุบู„ุงู‚ ุงู„ุจูŠุน ุฃูˆ ุชุนู„ูŠู‚ู‡.", "tags": [ "Sale" ], @@ -10202,7 +10202,7 @@ } ], "title": "ูˆู‚ุช ุชุนู„ูŠู‚ ุงู„ุจูŠุน", - "description": "ูˆู‚ุช ุชุนู„ูŠู‚ ุงู„ุจูŠุน. ุชู… ุชุนู„ูŠู‚ ุงู„ุจูŠุน ู…ู† ู‚ุจู„ ุงู„ุจุงุฆุน ู„ุณุจุจ ู…ุง. ู„ุง ูŠู…ูƒู† ู„ุนู…ู„ุงุก {@link IShoppingCustomer} ุฑุคูŠุฉ ุงู„ุจูŠุน ููŠ ูƒู„ ู…ู† ุตูุญุงุช ุงู„ู‚ุงุฆู…ุฉ ูˆุงู„ุชูุงุตูŠู„. ุงู„ุฃู…ุฑ ู…ุดุงุจู‡ ุชู‚ุฑูŠุจู‹ุง ู„ู„ุญุฐู ุงู„ู†ุงุนู…ุŒ ูˆู„ูƒู† ู‡ู†ุงูƒ ุงุฎุชู„ุงู ุจุณูŠุท ูˆู‡ูˆ ุฃู† ุงู„ู…ุงู„ูƒ {@link IShoppingSeller seller} ู„ุง ูŠุฒุงู„ ุจุฅู…ูƒุงู†ู‡ ุฑุคูŠุฉ ุงู„ุจูŠุน ูˆุงุณุชุฆู†ุงูู‡. ุจุงู„ุทุจุนุŒ ู„ุง ูŠุฒุงู„ ุจุฅู…ูƒุงู† ุนู…ู„ุงุก {@link IShoppingCustomer} ุงู„ุฐูŠู† ุงุดุชุฑูˆุง ุงู„ุจูŠุน ุจุงู„ูุนู„ ุฑุคูŠุฉ ุงู„ุจูŠุน ููŠ ุตูุญุฉ {@link IShoppingOrder order}." + "description": "ูˆู‚ุช ุชุนู„ูŠู‚ ุงู„ุจูŠุน. ุชู… ุชุนู„ูŠู‚ ุงู„ุจูŠุน ู…ู† ู‚ุจู„ ุงู„ุจุงุฆุน ู„ุณุจุจ ู…ุง. ู„ุง ูŠู…ูƒู† ู„ุนู…ู„ุงุก {@link IShoppingCustomer} ุฑุคูŠุฉ ุงู„ุจูŠุน ููŠ ูƒู„ ู…ู† ุตูุญุชูŠ ุงู„ู‚ุงุฆู…ุฉ ูˆุงู„ุชูุงุตูŠู„. ุงู„ุฃู…ุฑ ู…ุดุงุจู‡ ุชู‚ุฑูŠุจู‹ุง ู„ู„ุญุฐู ุงู„ู†ุงุนู…ุŒ ูˆู„ูƒู† ู‡ู†ุงูƒ ุงุฎุชู„ุงู ุจุณูŠุท ูˆู‡ูˆ ุฃู† ุงู„ู…ุงู„ูƒ {@link IShoppingSeller ุงู„ุจุงุฆุน} ู„ุง ูŠุฒุงู„ ุจุฅู…ูƒุงู†ู‡ ุฑุคูŠุฉ ุงู„ุจูŠุน ูˆุงุณุชุฆู†ุงูู‡. ุจุงู„ุทุจุนุŒ ู„ุง ูŠุฒุงู„ ุจุฅู…ูƒุงู† ุนู…ู„ุงุก {@link IShoppingCustomer} ุงู„ุฐูŠู† ุงุดุชุฑูˆุง ุงู„ุจูŠุน ุจุงู„ูุนู„ ุฑุคูŠุฉ ุงู„ุจูŠุน ููŠ ุตูุญุฉ {@link IShoppingOrder order}." }, "opened_at": { "oneOf": [ @@ -12175,7 +12175,7 @@ } ], "title": "ูˆู‚ุช ุชุนู„ูŠู‚ ุงู„ุจูŠุน", - "description": "ูˆู‚ุช ุชุนู„ูŠู‚ ุงู„ุจูŠุน. ุชู… ุชุนู„ูŠู‚ ุงู„ุจูŠุน ู…ู† ู‚ุจู„ ุงู„ุจุงุฆุน ู„ุณุจุจ ู…ุง. ู„ุง ูŠู…ูƒู† ู„ุนู…ู„ุงุก {@link IShoppingCustomer} ุฑุคูŠุฉ ุงู„ุจูŠุน ููŠ ูƒู„ ู…ู† ุตูุญุงุช ุงู„ู‚ุงุฆู…ุฉ ูˆุงู„ุชูุงุตูŠู„. ุงู„ุฃู…ุฑ ู…ุดุงุจู‡ ุชู‚ุฑูŠุจู‹ุง ู„ู„ุญุฐู ุงู„ู†ุงุนู…ุŒ ูˆู„ูƒู† ู‡ู†ุงูƒ ุงุฎุชู„ุงู ุจุณูŠุท ูˆู‡ูˆ ุฃู† ุงู„ู…ุงู„ูƒ {@link IShoppingSeller seller} ู„ุง ูŠุฒุงู„ ุจุฅู…ูƒุงู†ู‡ ุฑุคูŠุฉ ุงู„ุจูŠุน ูˆุงุณุชุฆู†ุงูู‡. ุจุงู„ุทุจุนุŒ ู„ุง ูŠุฒุงู„ ุจุฅู…ูƒุงู† ุนู…ู„ุงุก {@link IShoppingCustomer} ุงู„ุฐูŠู† ุงุดุชุฑูˆุง ุงู„ุจูŠุน ุจุงู„ูุนู„ ุฑุคูŠุฉ ุงู„ุจูŠุน ููŠ ุตูุญุฉ {@link IShoppingOrder order}." + "description": "ูˆู‚ุช ุชุนู„ูŠู‚ ุงู„ุจูŠุน. ุชู… ุชุนู„ูŠู‚ ุงู„ุจูŠุน ู…ู† ู‚ุจู„ ุงู„ุจุงุฆุน ู„ุณุจุจ ู…ุง. ู„ุง ูŠู…ูƒู† ู„ุนู…ู„ุงุก {@link IShoppingCustomer} ุฑุคูŠุฉ ุงู„ุจูŠุน ููŠ ูƒู„ ู…ู† ุตูุญุชูŠ ุงู„ู‚ุงุฆู…ุฉ ูˆุงู„ุชูุงุตูŠู„. ุงู„ุฃู…ุฑ ู…ุดุงุจู‡ ุชู‚ุฑูŠุจู‹ุง ู„ู„ุญุฐู ุงู„ู†ุงุนู…ุŒ ูˆู„ูƒู† ู‡ู†ุงูƒ ุงุฎุชู„ุงู ุจุณูŠุท ูˆู‡ูˆ ุฃู† ุงู„ู…ุงู„ูƒ {@link IShoppingSeller ุงู„ุจุงุฆุน} ู„ุง ูŠุฒุงู„ ุจุฅู…ูƒุงู†ู‡ ุฑุคูŠุฉ ุงู„ุจูŠุน ูˆุงุณุชุฆู†ุงูู‡. ุจุงู„ุทุจุนุŒ ู„ุง ูŠุฒุงู„ ุจุฅู…ูƒุงู† ุนู…ู„ุงุก {@link IShoppingCustomer} ุงู„ุฐูŠู† ุงุดุชุฑูˆุง ุงู„ุจูŠุน ุจุงู„ูุนู„ ุฑุคูŠุฉ ุงู„ุจูŠุน ููŠ ุตูุญุฉ {@link IShoppingOrder order}." }, "opened_at": { "oneOf": [ @@ -13569,7 +13569,7 @@ } ], "title": "ูˆู‚ุช ุชุนู„ูŠู‚ ุงู„ุจูŠุน", - "description": "ูˆู‚ุช ุชุนู„ูŠู‚ ุงู„ุจูŠุน. ุชู… ุชุนู„ูŠู‚ ุงู„ุจูŠุน ู…ู† ู‚ุจู„ ุงู„ุจุงุฆุน ู„ุณุจุจ ู…ุง. ู„ุง ูŠู…ูƒู† ู„ุนู…ู„ุงุก {@link IShoppingCustomer} ุฑุคูŠุฉ ุงู„ุจูŠุน ููŠ ูƒู„ ู…ู† ุตูุญุงุช ุงู„ู‚ุงุฆู…ุฉ ูˆุงู„ุชูุงุตูŠู„. ุงู„ุฃู…ุฑ ู…ุดุงุจู‡ ุชู‚ุฑูŠุจู‹ุง ู„ู„ุญุฐู ุงู„ู†ุงุนู…ุŒ ูˆู„ูƒู† ู‡ู†ุงูƒ ุงุฎุชู„ุงู ุจุณูŠุท ูˆู‡ูˆ ุฃู† ุงู„ู…ุงู„ูƒ {@link IShoppingSeller seller} ู„ุง ูŠุฒุงู„ ุจุฅู…ูƒุงู†ู‡ ุฑุคูŠุฉ ุงู„ุจูŠุน ูˆุงุณุชุฆู†ุงูู‡. ุจุงู„ุทุจุนุŒ ู„ุง ูŠุฒุงู„ ุจุฅู…ูƒุงู† ุนู…ู„ุงุก {@link IShoppingCustomer} ุงู„ุฐูŠู† ุงุดุชุฑูˆุง ุงู„ุจูŠุน ุจุงู„ูุนู„ ุฑุคูŠุฉ ุงู„ุจูŠุน ููŠ ุตูุญุฉ {@link IShoppingOrder order}." + "description": "ูˆู‚ุช ุชุนู„ูŠู‚ ุงู„ุจูŠุน. ุชู… ุชุนู„ูŠู‚ ุงู„ุจูŠุน ู…ู† ู‚ุจู„ ุงู„ุจุงุฆุน ู„ุณุจุจ ู…ุง. ู„ุง ูŠู…ูƒู† ู„ุนู…ู„ุงุก {@link IShoppingCustomer} ุฑุคูŠุฉ ุงู„ุจูŠุน ููŠ ูƒู„ ู…ู† ุตูุญุชูŠ ุงู„ู‚ุงุฆู…ุฉ ูˆุงู„ุชูุงุตูŠู„. ุงู„ุฃู…ุฑ ู…ุดุงุจู‡ ุชู‚ุฑูŠุจู‹ุง ู„ู„ุญุฐู ุงู„ู†ุงุนู…ุŒ ูˆู„ูƒู† ู‡ู†ุงูƒ ุงุฎุชู„ุงู ุจุณูŠุท ูˆู‡ูˆ ุฃู† ุงู„ู…ุงู„ูƒ {@link IShoppingSeller ุงู„ุจุงุฆุน} ู„ุง ูŠุฒุงู„ ุจุฅู…ูƒุงู†ู‡ ุฑุคูŠุฉ ุงู„ุจูŠุน ูˆุงุณุชุฆู†ุงูู‡. ุจุงู„ุทุจุนุŒ ู„ุง ูŠุฒุงู„ ุจุฅู…ูƒุงู† ุนู…ู„ุงุก {@link IShoppingCustomer} ุงู„ุฐูŠู† ุงุดุชุฑูˆุง ุงู„ุจูŠุน ุจุงู„ูุนู„ ุฑุคูŠุฉ ุงู„ุจูŠุน ููŠ ุตูุญุฉ {@link IShoppingOrder order}." }, "opened_at": { "oneOf": [ @@ -14688,7 +14688,7 @@ "snapshots", "created_at" ], - "description": "ุฅุฌุงุจุงุช ุนู„ู‰ ุงู„ุฃุณุฆู„ุฉ ุญูˆู„ ู„ู‚ุทุงุช ุงู„ุจูŠุน. `IShoppingSaleInquiryAnswer` ู‡ูˆ ูƒูŠุงู† ูŠุฌุณุฏ ุงู„ุฅุฌุงุจุฉ ุงู„ุฑุณู…ูŠุฉ ุงู„ุชูŠ ูƒุชุจู‡ุง {@link IShoppingSeller ุงู„ุจุงุฆุน} ุนู„ู‰ {@link IShoppingSaleInquiry queries} ุงู„ุชูŠ ูƒุชุจู‡ุง {@link IShoppingCustomer customer}. ุจุงู„ุทุจุนุŒ ุจุงู„ุฅุถุงูุฉ ุฅู„ู‰ ูƒุชุงุจุฉ ุงุณุชุฌุงุจุฉ ุฑุณู…ูŠุฉ ู…ุซู„ ู‡ุฐู‡ุŒ ู…ู† ุงู„ู…ู…ูƒู† ุฃูŠุถู‹ุง ู„ู„ุจุงุฆุน ุงู„ุชูˆุงุตู„ ู…ุน ุงู„ุนู…ูŠู„ ุงู„ู…ูƒุชูˆุจ ููŠ ุงู„ุงุณุชุนู„ุงู… ูˆุงู„ุนู…ู„ุงุก ุงู„ู…ุชุนุฏุฏูŠู† ู…ู† ุฎู„ุงู„ {@link IShoppingSaleInquiryComment comments} ููŠ ุงุณุชูุณุงุฑ ุงู„ุฅุณู†ุงุฏ. ู„ู„ุฅุดุงุฑุฉุŒ ู„ุง ูŠู…ูƒู† ูƒุชุงุจุฉ ุชุนู„ูŠู‚ุงุช ุนู„ู‰ ู‡ุฐู‡ ุงู„ุฅุฌุงุจุฉ. ุดุฌุน ุงู„ุฃุดุฎุงุต ุนู„ู‰ ูƒุชุงุจุฉ ุชุนู„ูŠู‚ุงุช ุนู„ู‰ ู…ู‚ุงู„ ุงู„ุงุณุชูุณุงุฑ. ู‡ุฐุง ู„ู…ู†ุน ุชู†ุงุซุฑ ุงู„ุชุนู„ูŠู‚ุงุช ููŠ ูƒู„ ู…ู† ู…ู‚ุงู„ ุงู„ุงุณุชูุณุงุฑ ูˆู…ู‚ุงู„ุงุช ุงู„ุฅุฌุงุจุฉ." + "description": "ุฅุฌุงุจุงุช ุนู„ู‰ ุงู„ุฃุณุฆู„ุฉ ุญูˆู„ ู„ู‚ุทุงุช ุงู„ุจูŠุน. `IShoppingSaleInquiryAnswer` ู‡ูˆ ูƒูŠุงู† ูŠุฌุณุฏ ุงู„ุฅุฌุงุจุฉ ุงู„ุฑุณู…ูŠุฉ ุงู„ุชูŠ ูƒุชุจู‡ุง {@link IShoppingSeller ุงู„ุจุงุฆุน} ุนู„ู‰ {@link IShoppingSaleInquiry queries} ุงู„ุชูŠ ูƒุชุจู‡ุง {@link IShoppingCustomer customer}. ุจุงู„ุทุจุนุŒ ุจุงู„ุฅุถุงูุฉ ุฅู„ู‰ ูƒุชุงุจุฉ ุงุณุชุฌุงุจุฉ ุฑุณู…ูŠุฉ ู…ุซู„ ู‡ุฐู‡ุŒ ู…ู† ุงู„ู…ู…ูƒู† ุฃูŠุถู‹ุง ู„ู„ุจุงุฆุน ุงู„ุชูˆุงุตู„ ู…ุน ุงู„ุนู…ูŠู„ ุงู„ู…ูƒุชูˆุจ ููŠ ุงู„ุงุณุชูุณุงุฑ ูˆุงู„ุนู…ู„ุงุก ุงู„ู…ุชุนุฏุฏูŠู† ู…ู† ุฎู„ุงู„ {@link IShoppingSaleInquiryComment comments} ููŠ ุงุณุชูุณุงุฑ ุงู„ุฅุณู†ุงุฏ. ู„ู„ุฅุดุงุฑุฉุŒ ู„ุง ูŠู…ูƒู† ูƒุชุงุจุฉ ุชุนู„ูŠู‚ุงุช ุนู„ู‰ ู‡ุฐู‡ ุงู„ุฅุฌุงุจุฉ. ุดุฌุน ุงู„ุฃุดุฎุงุต ุนู„ู‰ ูƒุชุงุจุฉ ุชุนู„ูŠู‚ุงุช ุนู„ู‰ ู…ู‚ุงู„ ุงู„ุงุณุชูุณุงุฑ. ู‡ุฐุง ู„ู…ู†ุน ุชุดุชุช ุงู„ุชุนู„ูŠู‚ุงุช ููŠ ูƒู„ ู…ู† ู…ู‚ุงู„ ุงู„ุงุณุชูุณุงุฑ ูˆุงู„ุฅุฌุงุจุฉ." }, "IBbsArticle.ISnapshot": { "type": "object", diff --git a/assets/output/shopping.swagger.ja.json b/assets/output/shopping.swagger.ja.json index a03cd08..50ca408 100644 --- a/assets/output/shopping.swagger.ja.json +++ b/assets/output/shopping.swagger.ja.json @@ -6381,7 +6381,7 @@ } ], "requestBody": { - "description": "ๆ—…็จ‹ใฎๅฎŒไบ†ๆ™‚้–“", + "description": "ๆ—…ใฎๅฎŒไบ†ๆ™‚้–“", "content": { "application/json": { "schema": { @@ -10061,7 +10061,7 @@ "type", "direction" ], - "description": "ๅ‰ฒๅผ•ใ‚ฏใƒผใƒใƒณใฎ่ฒฉๅฃฒ่€…ใฎๆกไปถใ€‚`IShoppingCouponSellerCriteria` ใฏ {@link IShoppingCouponCriteriaBase} ใฎใ‚ตใƒ–ใ‚ฟใ‚คใƒ—ใ‚จใƒณใƒ†ใ‚ฃใƒ†ใ‚ฃใงใ‚ใ‚Šใ€็‰นๅฎšใฎ {@link IShoppingSeller} ใฎๆกไปถใ‚’่จญๅฎšใ™ใ‚‹ใจใใซไฝฟ็”จใ•ใ‚Œใพใ™ใ€‚{@link direction} ใฎๅ€คใŒ "include" ใฎๅ ดๅˆใ€ใ‚ฏใƒผใƒใƒณใฏๅฏพ่ฑกใฎ {@link sellers} ใซๅฏพใ—ใฆใฎใฟไฝฟ็”จใงใใพใ™ใ€‚้€†ใซใ€"exclude" ใฎๅ ดๅˆใ€ใ‚ฏใƒผใƒใƒณใฏไฝฟ็”จใงใใพใ›ใ‚“ใ€‚." + "description": "ๅ‰ฒๅผ•ใ‚ฏใƒผใƒใƒณใฎ่ฒฉๅฃฒ่€…ใฎๆกไปถใ€‚`IShoppingCouponSellerCriteria` ใฏ {@link IShoppingCouponCriteriaBase} ใฎใ‚ตใƒ–ใ‚ฟใ‚คใƒ—ใ‚จใƒณใƒ†ใ‚ฃใƒ†ใ‚ฃใงใ‚ใ‚Šใ€็‰นๅฎšใฎ {@link IShoppingSeller ่ฒฉๅฃฒ่€…} ใฎๆกไปถใ‚’่จญๅฎšใ™ใ‚‹ใจใใซไฝฟ็”จใ•ใ‚Œใพใ™ใ€‚{@link direction} ใฎๅ€คใŒ "include" ใฎๅ ดๅˆใ€ใ‚ฏใƒผใƒใƒณใฏๅฏพ่ฑกใฎ {@link sellers} ใซๅฏพใ—ใฆใฎใฟไฝฟ็”จใงใใพใ™ใ€‚้€†ใซใ€"exclude" ใฎๅ ดๅˆใ€ใ‚ฏใƒผใƒใƒณใฏไฝฟ็”จใงใใพใ›ใ‚“ใ€‚." }, "IShoppingCouponSaleCriteria": { "type": "object", @@ -12496,8 +12496,8 @@ "deposit": { "type": "number", "minimum": 0, - "title": "้ ใ‹ใ‚Š้‡‘ๆ”ฏๆ‰•้ก", - "description": "้ ใ‹ใ‚Š้‡‘ๆ”ฏๆ‰•้ก." + "title": "้ ใ‹ใ‚Š้‡‘ใฎ้‡‘้ก", + "description": "้ ใ‹ใ‚Š้‡‘ใฎ้‡‘้ก." }, "mileage": { "type": "number", @@ -12532,7 +12532,7 @@ "nominal", "real" ], - "description": "ๆณจๆ–‡ไพกๆ ผใฎ่ฆ็ด„ๆƒ…ๅ ฑ." + "description": "ๆณจๆ–‡ไพกๆ ผใฎๆฆ‚่ฆๆƒ…ๅ ฑ." }, "IShoppingOrderPrice": { "type": "object", @@ -12554,8 +12554,8 @@ "deposit": { "type": "number", "minimum": 0, - "title": "้ ใ‹ใ‚Š้‡‘ๆ”ฏๆ‰•้ก", - "description": "้ ใ‹ใ‚Š้‡‘ๆ”ฏๆ‰•้ก." + "title": "้ ใ‹ใ‚Š้‡‘ใฎ้‡‘้ก", + "description": "้ ใ‹ใ‚Š้‡‘ใฎ้‡‘้ก." }, "mileage": { "type": "number", @@ -12939,8 +12939,8 @@ "format": "date-time" } ], - "title": "ๆ—…็จ‹ใฎๅฎŒไบ†ๆ™‚้–“", - "description": "ๆ—…็จ‹ใฎๅฎŒไบ†ๆ™‚้–“." + "title": "ๆ—…ใฎๅฎŒไบ†ๆ™‚้–“", + "description": "ๆ—…ใฎๅฎŒไบ†ๆ™‚้–“." } }, "required": [ @@ -18078,8 +18078,8 @@ "format": "date-time" } ], - "title": "ๆ—…็จ‹ใฎๅฎŒไบ†ๆ™‚้–“", - "description": "ๆ—…็จ‹ใฎๅฎŒไบ†ๆ™‚้–“." + "title": "ๆ—…ใฎๅฎŒไบ†ๆ™‚้–“", + "description": "ๆ—…ใฎๅฎŒไบ†ๆ™‚้–“." } }, "required": [ @@ -18145,8 +18145,8 @@ "format": "date-time" } ], - "title": "ๆ—…็จ‹ใฎๅฎŒไบ†ๆ™‚้–“", - "description": "ๆ—…็จ‹ใฎๅฎŒไบ†ๆ™‚้–“." + "title": "ๆ—…ใฎๅฎŒไบ†ๆ™‚้–“", + "description": "ๆ—…ใฎๅฎŒไบ†ๆ™‚้–“." } }, "required": [ diff --git a/assets/output/shopping.swagger.ko.json b/assets/output/shopping.swagger.ko.json index feea333..7f0a342 100644 --- a/assets/output/shopping.swagger.ko.json +++ b/assets/output/shopping.swagger.ko.json @@ -845,7 +845,7 @@ "/shoppings/admins/orders": { "patch": { "summary": "๋ชจ๋“  ์ฃผ๋ฌธ์„ ๋‚˜์—ดํ•˜์„ธ์š”", - "description": "๋ชจ๋“  ์ฃผ๋ฌธ์„ ๋‚˜์—ดํ•ฉ๋‹ˆ๋‹ค. ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ๊ฐ€ ์žˆ๋Š” ๋ชจ๋“  {@link IShoppingOrder ์ฃผ๋ฌธ}์„ ๋‚˜์—ดํ•ฉ๋‹ˆ๋‹ค. ์›ํ•˜๋Š” ๊ฒฝ์šฐ ์š”์ฒญ ๋ณธ๋ฌธ์—์„œ {@link IShoppingOrder.IRequest.search ๊ฒ€์ƒ‰ ์กฐ๊ฑด}์„ ๊ตฌ์„ฑํ•˜์—ฌ ๊ฒฐ๊ณผ๋ฅผ ์ œํ•œํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๋˜ํ•œ {@link IShoppingOrder.IRequest.sort ์ •๋ ฌ ์กฐ๊ฑด}์„ ๊ตฌ์„ฑํ•˜์—ฌ ๋ ˆ์ฝ”๋“œ์˜ ์‹œํ€€์Šค ์ˆœ์„œ๋ฅผ ์‚ฌ์šฉ์ž ์ •์˜ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์ฐธ๊ณ ๋กœ, {@link IShoppingCustomer ๊ณ ๊ฐ}์ธ ๊ฒฝ์šฐ ์ž์‹ ์˜ ์ฃผ๋ฌธ์„ ๋‚˜์—ดํ•  ์ˆ˜ ์žˆ์œผ๋ฉฐ ์ฃผ๋ฌธ์ด {@link IShoppingOrderPublish.paid_at paid}๋˜์—ˆ๋Š”์ง€ ์—ฌ๋ถ€๋Š” ์ค‘์š”ํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค. ๊ทธ๋ ‡์ง€ ์•Š์€ ๊ฒฝ์šฐ {@link IShoppingSeller ํŒ๋งค์ž} ๋˜๋Š” {@link IShoppingAdministrator ๊ด€๋ฆฌ์ž}์ธ ๊ฒฝ์šฐ ์œ ๋ฃŒ ์ฃผ๋ฌธ๋งŒ ๋‚˜์—ดํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๋˜ํ•œ ํŒ๋งค์ž์˜ ๊ฒฝ์šฐ ๊ด€๋ จ {@link IShoppingOrder.goods ์ƒํ’ˆ}๋งŒ ์ฃผ๋ฌธ์— ๋‚˜์—ด๋ฉ๋‹ˆ๋‹ค..", + "description": "๋ชจ๋“  ์ฃผ๋ฌธ์„ ๋‚˜์—ดํ•ฉ๋‹ˆ๋‹ค. ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ๊ฐ€ ์žˆ๋Š” ๋ชจ๋“  {@link IShoppingOrder ์ฃผ๋ฌธ}์„ ๋‚˜์—ดํ•ฉ๋‹ˆ๋‹ค. ์›ํ•˜๋Š” ๊ฒฝ์šฐ ์š”์ฒญ ๋ณธ๋ฌธ์—์„œ {@link IShoppingOrder.IRequest.search ๊ฒ€์ƒ‰ ์กฐ๊ฑด}์„ ๊ตฌ์„ฑํ•˜์—ฌ ๊ฒฐ๊ณผ๋ฅผ ์ œํ•œํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๋˜ํ•œ {@link IShoppingOrder.IRequest.sort ์ •๋ ฌ ์กฐ๊ฑด}์„ ๊ตฌ์„ฑํ•˜์—ฌ ๋ ˆ์ฝ”๋“œ์˜ ์‹œํ€€์Šค ์ˆœ์„œ๋ฅผ ์‚ฌ์šฉ์ž ์ •์˜ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์ฐธ๊ณ ๋กœ, {@link IShoppingCustomer ๊ณ ๊ฐ}์ธ ๊ฒฝ์šฐ ์ง์ ‘ ์ฃผ๋ฌธ์„ ๋‚˜์—ดํ•  ์ˆ˜ ์žˆ์œผ๋ฉฐ ์ฃผ๋ฌธ์ด {@link IShoppingOrderPublish.paid_at paid}๋˜์—ˆ๋Š”์ง€ ์—ฌ๋ถ€๋Š” ์ค‘์š”ํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค. ๊ทธ๋ ‡์ง€ ์•Š์€ ๊ฒฝ์šฐ {@link IShoppingSeller ํŒ๋งค์ž} ๋˜๋Š” {@link IShoppingAdministrator ๊ด€๋ฆฌ์ž}์ธ ๊ฒฝ์šฐ ์œ ๋ฃŒ ์ฃผ๋ฌธ๋งŒ ๋‚˜์—ดํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๋˜ํ•œ ํŒ๋งค์ž์˜ ๊ฒฝ์šฐ ๊ด€๋ จ {@link IShoppingOrder.goods ์ƒํ’ˆ}๋งŒ ์ฃผ๋ฌธ์— ๋‚˜์—ด๋ฉ๋‹ˆ๋‹ค..", "tags": [ "Order" ], @@ -3774,7 +3774,7 @@ ] }, "put": { - "summary": "์ƒํ’ˆ(์ˆ˜๋Ÿ‰) ์—…๋ฐ์ดํŠธ", + "summary": "์ƒํ’ˆ(๋ณผ๋ฅจ) ์—…๋ฐ์ดํŠธ", "description": "์ƒํ’ˆ(๋ณผ๋ฅจ)์„ ์—…๋ฐ์ดํŠธํ•ฉ๋‹ˆ๋‹ค. ์‡ผํ•‘ ์นดํŠธ์—์„œ {@link IShoppingCartCommodity ์ƒํ’ˆ}์˜ ๋ณผ๋ฅจ์„ ์—…๋ฐ์ดํŠธํ•ฉ๋‹ˆ๋‹ค. *cartId*๊ฐ€ ์†ํ•œ ์นดํŠธ์˜ ID์™€ ๋‹ค๋ฅด๋ฉด 404 ์ฐพ์„ ์ˆ˜ ์—†์Œ ์˜ˆ์™ธ๊ฐ€ ๋ฐœ์ƒํ•ฉ๋‹ˆ๋‹ค. ๊ทธ๋ ‡์ง€ ์•Š์œผ๋ฉด *cartId*์— `null` ๊ฐ’์ด ์žˆ๋Š” ๊ฒฝ์šฐ ์ด๋Ÿฌํ•œ ์ข…์†์„ฑ ๊ฒ€์‚ฌ๋Š” ๊ฑด๋„ˆ๋›ฐ์ง€๋งŒ ์†Œ์œ ๊ถŒ์€ ์—ฌ์ „ํžˆ ๊ฒ€์ฆ๋ฉ๋‹ˆ๋‹ค. ๋˜ํ•œ ๋Œ€์ƒ {@link IShoppingSale ํŒ๋งค}๊ฐ€ ์ค‘๋‹จ๋˜๊ฑฐ๋‚˜ {@link IShoppingSaleUnitStockInventory ์žฌ๊ณ  ์—†์Œ}์ด ๊ฐ‘์ž๊ธฐ ๋ฐœ์ƒํ•˜๋ฉด 410 gone ์˜ค๋ฅ˜๊ฐ€ ๋ฐœ์ƒํ•ฉ๋‹ˆ๋‹ค..", "tags": [ "Order" @@ -4032,7 +4032,7 @@ }, "patch": { "summary": "๋ชจ๋“  ์ฃผ๋ฌธ์„ ๋‚˜์—ดํ•˜์„ธ์š”", - "description": "๋ชจ๋“  ์ฃผ๋ฌธ์„ ๋‚˜์—ดํ•ฉ๋‹ˆ๋‹ค. ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ๊ฐ€ ์žˆ๋Š” ๋ชจ๋“  {@link IShoppingOrder ์ฃผ๋ฌธ}์„ ๋‚˜์—ดํ•ฉ๋‹ˆ๋‹ค. ์›ํ•˜๋Š” ๊ฒฝ์šฐ ์š”์ฒญ ๋ณธ๋ฌธ์—์„œ {@link IShoppingOrder.IRequest.search ๊ฒ€์ƒ‰ ์กฐ๊ฑด}์„ ๊ตฌ์„ฑํ•˜์—ฌ ๊ฒฐ๊ณผ๋ฅผ ์ œํ•œํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๋˜ํ•œ {@link IShoppingOrder.IRequest.sort ์ •๋ ฌ ์กฐ๊ฑด}์„ ๊ตฌ์„ฑํ•˜์—ฌ ๋ ˆ์ฝ”๋“œ์˜ ์‹œํ€€์Šค ์ˆœ์„œ๋ฅผ ์‚ฌ์šฉ์ž ์ •์˜ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์ฐธ๊ณ ๋กœ, {@link IShoppingCustomer ๊ณ ๊ฐ}์ธ ๊ฒฝ์šฐ ์ž์‹ ์˜ ์ฃผ๋ฌธ์„ ๋‚˜์—ดํ•  ์ˆ˜ ์žˆ์œผ๋ฉฐ ์ฃผ๋ฌธ์ด {@link IShoppingOrderPublish.paid_at paid}๋˜์—ˆ๋Š”์ง€ ์—ฌ๋ถ€๋Š” ์ค‘์š”ํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค. ๊ทธ๋ ‡์ง€ ์•Š์€ ๊ฒฝ์šฐ {@link IShoppingSeller ํŒ๋งค์ž} ๋˜๋Š” {@link IShoppingAdministrator ๊ด€๋ฆฌ์ž}์ธ ๊ฒฝ์šฐ ์œ ๋ฃŒ ์ฃผ๋ฌธ๋งŒ ๋‚˜์—ดํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๋˜ํ•œ ํŒ๋งค์ž์˜ ๊ฒฝ์šฐ ๊ด€๋ จ {@link IShoppingOrder.goods ์ƒํ’ˆ}๋งŒ ์ฃผ๋ฌธ์— ๋‚˜์—ด๋ฉ๋‹ˆ๋‹ค..", + "description": "๋ชจ๋“  ์ฃผ๋ฌธ์„ ๋‚˜์—ดํ•ฉ๋‹ˆ๋‹ค. ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ๊ฐ€ ์žˆ๋Š” ๋ชจ๋“  {@link IShoppingOrder ์ฃผ๋ฌธ}์„ ๋‚˜์—ดํ•ฉ๋‹ˆ๋‹ค. ์›ํ•˜๋Š” ๊ฒฝ์šฐ ์š”์ฒญ ๋ณธ๋ฌธ์—์„œ {@link IShoppingOrder.IRequest.search ๊ฒ€์ƒ‰ ์กฐ๊ฑด}์„ ๊ตฌ์„ฑํ•˜์—ฌ ๊ฒฐ๊ณผ๋ฅผ ์ œํ•œํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๋˜ํ•œ {@link IShoppingOrder.IRequest.sort ์ •๋ ฌ ์กฐ๊ฑด}์„ ๊ตฌ์„ฑํ•˜์—ฌ ๋ ˆ์ฝ”๋“œ์˜ ์‹œํ€€์Šค ์ˆœ์„œ๋ฅผ ์‚ฌ์šฉ์ž ์ •์˜ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์ฐธ๊ณ ๋กœ, {@link IShoppingCustomer ๊ณ ๊ฐ}์ธ ๊ฒฝ์šฐ ์ง์ ‘ ์ฃผ๋ฌธ์„ ๋‚˜์—ดํ•  ์ˆ˜ ์žˆ์œผ๋ฉฐ ์ฃผ๋ฌธ์ด {@link IShoppingOrderPublish.paid_at paid}๋˜์—ˆ๋Š”์ง€ ์—ฌ๋ถ€๋Š” ์ค‘์š”ํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค. ๊ทธ๋ ‡์ง€ ์•Š์€ ๊ฒฝ์šฐ {@link IShoppingSeller ํŒ๋งค์ž} ๋˜๋Š” {@link IShoppingAdministrator ๊ด€๋ฆฌ์ž}์ธ ๊ฒฝ์šฐ ์œ ๋ฃŒ ์ฃผ๋ฌธ๋งŒ ๋‚˜์—ดํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๋˜ํ•œ ํŒ๋งค์ž์˜ ๊ฒฝ์šฐ ๊ด€๋ จ {@link IShoppingOrder.goods ์ƒํ’ˆ}๋งŒ ์ฃผ๋ฌธ์— ๋‚˜์—ด๋ฉ๋‹ˆ๋‹ค..", "tags": [ "Order" ], @@ -6642,7 +6642,7 @@ "/shoppings/sellers/orders": { "patch": { "summary": "๋ชจ๋“  ์ฃผ๋ฌธ์„ ๋‚˜์—ดํ•˜์„ธ์š”", - "description": "๋ชจ๋“  ์ฃผ๋ฌธ์„ ๋‚˜์—ดํ•ฉ๋‹ˆ๋‹ค. ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ๊ฐ€ ์žˆ๋Š” ๋ชจ๋“  {@link IShoppingOrder ์ฃผ๋ฌธ}์„ ๋‚˜์—ดํ•ฉ๋‹ˆ๋‹ค. ์›ํ•˜๋Š” ๊ฒฝ์šฐ ์š”์ฒญ ๋ณธ๋ฌธ์—์„œ {@link IShoppingOrder.IRequest.search ๊ฒ€์ƒ‰ ์กฐ๊ฑด}์„ ๊ตฌ์„ฑํ•˜์—ฌ ๊ฒฐ๊ณผ๋ฅผ ์ œํ•œํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๋˜ํ•œ {@link IShoppingOrder.IRequest.sort ์ •๋ ฌ ์กฐ๊ฑด}์„ ๊ตฌ์„ฑํ•˜์—ฌ ๋ ˆ์ฝ”๋“œ์˜ ์‹œํ€€์Šค ์ˆœ์„œ๋ฅผ ์‚ฌ์šฉ์ž ์ •์˜ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์ฐธ๊ณ ๋กœ, {@link IShoppingCustomer ๊ณ ๊ฐ}์ธ ๊ฒฝ์šฐ ์ž์‹ ์˜ ์ฃผ๋ฌธ์„ ๋‚˜์—ดํ•  ์ˆ˜ ์žˆ์œผ๋ฉฐ ์ฃผ๋ฌธ์ด {@link IShoppingOrderPublish.paid_at paid}๋˜์—ˆ๋Š”์ง€ ์—ฌ๋ถ€๋Š” ์ค‘์š”ํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค. ๊ทธ๋ ‡์ง€ ์•Š์€ ๊ฒฝ์šฐ {@link IShoppingSeller ํŒ๋งค์ž} ๋˜๋Š” {@link IShoppingAdministrator ๊ด€๋ฆฌ์ž}์ธ ๊ฒฝ์šฐ ์œ ๋ฃŒ ์ฃผ๋ฌธ๋งŒ ๋‚˜์—ดํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๋˜ํ•œ ํŒ๋งค์ž์˜ ๊ฒฝ์šฐ ๊ด€๋ จ {@link IShoppingOrder.goods ์ƒํ’ˆ}๋งŒ ์ฃผ๋ฌธ์— ๋‚˜์—ด๋ฉ๋‹ˆ๋‹ค..", + "description": "๋ชจ๋“  ์ฃผ๋ฌธ์„ ๋‚˜์—ดํ•ฉ๋‹ˆ๋‹ค. ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ๊ฐ€ ์žˆ๋Š” ๋ชจ๋“  {@link IShoppingOrder ์ฃผ๋ฌธ}์„ ๋‚˜์—ดํ•ฉ๋‹ˆ๋‹ค. ์›ํ•˜๋Š” ๊ฒฝ์šฐ ์š”์ฒญ ๋ณธ๋ฌธ์—์„œ {@link IShoppingOrder.IRequest.search ๊ฒ€์ƒ‰ ์กฐ๊ฑด}์„ ๊ตฌ์„ฑํ•˜์—ฌ ๊ฒฐ๊ณผ๋ฅผ ์ œํ•œํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๋˜ํ•œ {@link IShoppingOrder.IRequest.sort ์ •๋ ฌ ์กฐ๊ฑด}์„ ๊ตฌ์„ฑํ•˜์—ฌ ๋ ˆ์ฝ”๋“œ์˜ ์‹œํ€€์Šค ์ˆœ์„œ๋ฅผ ์‚ฌ์šฉ์ž ์ •์˜ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์ฐธ๊ณ ๋กœ, {@link IShoppingCustomer ๊ณ ๊ฐ}์ธ ๊ฒฝ์šฐ ์ง์ ‘ ์ฃผ๋ฌธ์„ ๋‚˜์—ดํ•  ์ˆ˜ ์žˆ์œผ๋ฉฐ ์ฃผ๋ฌธ์ด {@link IShoppingOrderPublish.paid_at paid}๋˜์—ˆ๋Š”์ง€ ์—ฌ๋ถ€๋Š” ์ค‘์š”ํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค. ๊ทธ๋ ‡์ง€ ์•Š์€ ๊ฒฝ์šฐ {@link IShoppingSeller ํŒ๋งค์ž} ๋˜๋Š” {@link IShoppingAdministrator ๊ด€๋ฆฌ์ž}์ธ ๊ฒฝ์šฐ ์œ ๋ฃŒ ์ฃผ๋ฌธ๋งŒ ๋‚˜์—ดํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๋˜ํ•œ ํŒ๋งค์ž์˜ ๊ฒฝ์šฐ ๊ด€๋ จ {@link IShoppingOrder.goods ์ƒํ’ˆ}๋งŒ ์ฃผ๋ฌธ์— ๋‚˜์—ด๋ฉ๋‹ˆ๋‹ค..", "tags": [ "Order" ], @@ -13834,7 +13834,7 @@ "option_id": { "type": "string", "format": "uuid", - "description": "ํƒ€๊ฒŸ ์˜ต์…˜์˜ {@link IShoppingSaleUnitOption.id}" + "description": "๋Œ€์ƒ ์˜ต์…˜์˜ {@link IShoppingSaleUnitOption.id}" }, "candidate_id": { "type": "string", @@ -14214,8 +14214,8 @@ "$ref": "#/components/schemas/IShoppingSaleInquiryAnswer.ISummary" } ], - "title": "ํŒ๋งค์ž์˜ ๋ฌธ์˜์— ๋Œ€ํ•œ ๊ณต์‹ ๋‹ต๋ณ€", - "description": "ํŒ๋งค์ž์˜ ๋ฌธ์˜์— ๋Œ€ํ•œ ๊ณต์‹ ๋‹ต๋ณ€." + "title": "ํŒ๋งค์ž ๋ฌธ์˜์— ๋Œ€ํ•œ ๊ณต์‹ ๋‹ต๋ณ€", + "description": "ํŒ๋งค์ž ๋ฌธ์˜์— ๋Œ€ํ•œ ๊ณต์‹ ๋‹ต๋ณ€." }, "read_by_seller": { "type": "boolean", @@ -14439,8 +14439,8 @@ "$ref": "#/components/schemas/IShoppingSaleInquiryAnswer.IAbridge" } ], - "title": "ํŒ๋งค์ž์˜ ๋ฌธ์˜์— ๋Œ€ํ•œ ๊ณต์‹ ๋‹ต๋ณ€", - "description": "ํŒ๋งค์ž์˜ ๋ฌธ์˜์— ๋Œ€ํ•œ ๊ณต์‹ ๋‹ต๋ณ€." + "title": "ํŒ๋งค์ž ๋ฌธ์˜์— ๋Œ€ํ•œ ๊ณต์‹ ๋‹ต๋ณ€", + "description": "ํŒ๋งค์ž ๋ฌธ์˜์— ๋Œ€ํ•œ ๊ณต์‹ ๋‹ต๋ณ€." }, "read_by_seller": { "type": "boolean", @@ -14610,8 +14610,8 @@ "$ref": "#/components/schemas/IShoppingSaleInquiryAnswer" } ], - "title": "ํŒ๋งค์ž์˜ ๋ฌธ์˜์— ๋Œ€ํ•œ ๊ณต์‹ ๋‹ต๋ณ€", - "description": "ํŒ๋งค์ž์˜ ๋ฌธ์˜์— ๋Œ€ํ•œ ๊ณต์‹ ๋‹ต๋ณ€." + "title": "ํŒ๋งค์ž ๋ฌธ์˜์— ๋Œ€ํ•œ ๊ณต์‹ ๋‹ต๋ณ€", + "description": "ํŒ๋งค์ž ๋ฌธ์˜์— ๋Œ€ํ•œ ๊ณต์‹ ๋‹ต๋ณ€." }, "read_by_seller": { "type": "boolean", @@ -14793,8 +14793,8 @@ "$ref": "#/components/schemas/IShoppingSaleInquiryAnswer.ISummary" } ], - "title": "ํŒ๋งค์ž์˜ ๋ฌธ์˜์— ๋Œ€ํ•œ ๊ณต์‹ ๋‹ต๋ณ€", - "description": "ํŒ๋งค์ž์˜ ๋ฌธ์˜์— ๋Œ€ํ•œ ๊ณต์‹ ๋‹ต๋ณ€." + "title": "ํŒ๋งค์ž ๋ฌธ์˜์— ๋Œ€ํ•œ ๊ณต์‹ ๋‹ต๋ณ€", + "description": "ํŒ๋งค์ž ๋ฌธ์˜์— ๋Œ€ํ•œ ๊ณต์‹ ๋‹ต๋ณ€." }, "read_by_seller": { "type": "boolean", @@ -14998,8 +14998,8 @@ "$ref": "#/components/schemas/IShoppingSaleInquiryAnswer.IAbridge" } ], - "title": "ํŒ๋งค์ž์˜ ๋ฌธ์˜์— ๋Œ€ํ•œ ๊ณต์‹ ๋‹ต๋ณ€", - "description": "ํŒ๋งค์ž์˜ ๋ฌธ์˜์— ๋Œ€ํ•œ ๊ณต์‹ ๋‹ต๋ณ€." + "title": "ํŒ๋งค์ž ๋ฌธ์˜์— ๋Œ€ํ•œ ๊ณต์‹ ๋‹ต๋ณ€", + "description": "ํŒ๋งค์ž ๋ฌธ์˜์— ๋Œ€ํ•œ ๊ณต์‹ ๋‹ต๋ณ€." }, "read_by_seller": { "type": "boolean", @@ -15095,8 +15095,8 @@ "$ref": "#/components/schemas/IShoppingSaleInquiryAnswer" } ], - "title": "ํŒ๋งค์ž์˜ ๋ฌธ์˜์— ๋Œ€ํ•œ ๊ณต์‹ ๋‹ต๋ณ€", - "description": "ํŒ๋งค์ž์˜ ๋ฌธ์˜์— ๋Œ€ํ•œ ๊ณต์‹ ๋‹ต๋ณ€." + "title": "ํŒ๋งค์ž ๋ฌธ์˜์— ๋Œ€ํ•œ ๊ณต์‹ ๋‹ต๋ณ€", + "description": "ํŒ๋งค์ž ๋ฌธ์˜์— ๋Œ€ํ•œ ๊ณต์‹ ๋‹ต๋ณ€." }, "read_by_seller": { "type": "boolean", @@ -17037,8 +17037,8 @@ "option_id": { "type": "string", "format": "uuid", - "title": "ํƒ€๊ฒŸ ์˜ต์…˜์˜ {@link IShoppingSaleUnitOption.id}", - "description": "ํƒ€๊ฒŸ ์˜ต์…˜์˜ {@link IShoppingSaleUnitOption.id}." + "title": "๋Œ€์ƒ ์˜ต์…˜์˜ {@link IShoppingSaleUnitOption.id}", + "description": "๋Œ€์ƒ ์˜ต์…˜์˜ {@link IShoppingSaleUnitOption.id}." }, "candidate_id": { "oneOf": [ @@ -18294,7 +18294,7 @@ "type": "string", "format": "uuid" }, - "title": "ํƒ€๊ฒŸ ์นดํ…Œ๊ณ ๋ฆฌ ๋ชฉ๋ก {@link IShoppingChannelCategory.id}", + "title": "๋Œ€์ƒ ์นดํ…Œ๊ณ ๋ฆฌ ๋ชฉ๋ก {@link IShoppingChannelCategory.id}", "description": "๋Œ€์ƒ ์นดํ…Œ๊ณ ๋ฆฌ์˜ {@link IShoppingChannelCategory.id} ๋ชฉ๋ก์ž…๋‹ˆ๋‹ค. ๋น„์–ด ์žˆ์œผ๋ฉด ์ฑ„๋„์˜ ๋ชจ๋“  ์นดํ…Œ๊ณ ๋ฆฌ๊ฐ€ ํŒ๋งค๋ฅผ ๋‚˜์—ดํ•˜๊ณ  ์žˆ์Œ์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค.." } }, diff --git a/assets/output/toss.swagger.ar.json b/assets/output/toss.swagger.ar.json new file mode 100644 index 0000000..048a007 --- /dev/null +++ b/assets/output/toss.swagger.ar.json @@ -0,0 +1,3641 @@ +{ + "openapi": "3.1.0", + "servers": [ + { + "url": "http://localhost:30771", + "description": "ู…ุฒูŠู" + }, + { + "url": "https://api.tosspayments.com", + "description": "ุญู‚ูŠู‚ูŠ" + } + ], + "info": { + "title": "ุฅุฑู… ุงู„ู…ุฏููˆุนุงุช API", + "description": "ุชู… ุฅู†ุดุงุคู‡ ุจูˆุงุณุทุฉ [fake-toss-Payments-server](https://github.com/samchon/fake-toss-Payments-server) ู…ุน [nestia](https://github.com/samchon/nestia)", + "version": "2.0.0", + "license": { + "name": "MIT" + } + }, + "paths": { + "/v1/billing/authorizations/card": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "ู…ุนู„ูˆู…ุงุช ุชุณุฌูŠู„ ุจุทุงู‚ุฉ ุงู„ุฏูุน ุณู‡ู„ุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossBilling.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ู…ุนู„ูˆู…ุงุช ุจุณูŠุทุฉ ุนู† ุจุทุงู‚ุฉ ุงู„ุฏูุน", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossBilling" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ุชุณุฌูŠู„ ุจุทุงู‚ุฉ ุฏูุน ุจุณูŠุทุฉ", + "description": "ุชุณุฌูŠู„ ุจุทุงู‚ุฉ ุฏูุน ุจุณูŠุทุฉ. `billing.authorizations.card.store` ู‡ูŠ ูˆุธูŠูุฉ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ูŠุชู… ุงุณุชุฏุนุงุคู‡ุง ุนู†ุฏู…ุง ูŠุณุฌู„ ุงู„ุนู…ูŠู„ ุจุทุงู‚ุชู‡ ุงู„ุฌุฏูŠุฏุฉ ุนู„ู‰ ุงู„ุฎุงุฏู… ูˆูŠุฑูŠุฏ ุฅุฌุฑุงุก ุงู„ุฏูุน ุจุณู‡ูˆู„ุฉ ุฏูˆู† ุงู„ุญุงุฌุฉ ุฅู„ู‰ ุฅุฏุฎุงู„ ู…ุนู„ูˆู…ุงุช ุงู„ุจุทุงู‚ุฉ ุจุดูƒู„ ู…ุชูƒุฑุฑ ููŠ ูƒู„ ู…ุฑุฉ ูŠู„ุฒู… ููŠู‡ุง ุงู„ุฏูุน. ูƒู…ุฑุฌุนุŒ ุฅุฐุง ูƒุงู† ุชุทุจูŠู‚ ุงู„ุนู…ูŠู„ ูŠุณุชุฎุฏู… ู†ุงูุฐุฉ ุชุณุฌูŠู„ ุจุทุงู‚ุฉ ุงู„ุฏูุน ุงู„ุจุณูŠุทุฉ ุงู„ุชูŠ ุชูˆูุฑู‡ุง Toss PaymentsุŒ ูู„ู† ูŠุชู… ุงุณุชุฏุนุงุก `billing.authorizations.card.store` ุจูˆุงุณุทุฉ ุฎุงุฏู… ุงู„ูˆุงุฌู‡ุฉ ุงู„ุฎู„ููŠุฉ ู„ุฏูŠูƒ ููŠ ุงู„ุฎุฏู…ุฉ ุงู„ูุนู„ูŠุฉ. ูˆู…ุน ุฐู„ูƒุŒ ูŠู…ูƒู† ุงุณุชุฎุฏุงู…ู‡ ุนู„ู‰ ู…ุณุชูˆู‰ ุจุฑู†ุงู…ุฌ ุฃุชู…ุชุฉ ุงู„ุงุฎุชุจุงุฑ ู„ู…ุญุงูƒุงุฉ ุงู„ู…ูˆู‚ู ุญูŠุซ ูŠู‚ูˆู… ุงู„ุนู…ูŠู„ ุจุชุณุฌูŠู„ ุจุทุงู‚ุฉ ุฏูุน ุจุณูŠุทุฉ..", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.billing.authorizations.card.store", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ๋“ฑ๋ก ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/v1/billing/authorizations/{billingKey}": { + "post": { + "tags": [], + "parameters": [ + { + "name": "billingKey", + "in": "path", + "schema": { + "type": "string" + }, + "description": "ู…ู† ุงู„ู…ุนู„ูˆู…ุงุช ุงู„ู…ุณุชู‡ุฏูุฉ", + "required": true + } + ], + "requestBody": { + "description": "ู…ูุชุงุญ ู…ุนุฑู ุงู„ุนู…ูŠู„", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossBilling.ICustomerKey" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ู…ุนู„ูˆู…ุงุช ุทุฑูŠู‚ุฉ ุงู„ุฏูุน ุงู„ุจุณูŠุทุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossBilling" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ุชุญู‚ู‚ ู…ู† ุงู„ุทุฑูŠู‚ุฉ ุงู„ู…ุณุฌู„ุฉ ู„ู„ุฏูุน ุงู„ุจุณูŠุท", + "description": "ุชุญู‚ู‚ ู…ู† ุงู„ุทุฑูŠู‚ุฉ ุงู„ู…ุณุฌู„ุฉ ู„ู„ุฏูุน ุงู„ุจุณูŠุท. `billing.authorizations.at` ู‡ูŠ ูˆุธูŠูุฉ ุชุจุญุซ ููŠ ุทุฑูŠู‚ุฉ ุงู„ุฏูุน ุงู„ุชูŠ ุณุฌู„ู‡ุง ุงู„ุนู…ูŠู„ ุนู„ู‰ ุฎุงุฏู… Toss Payments ู„ู„ุฏูุน ุงู„ุจุณูŠุท. ุจุดูƒู„ ุฃุณุงุณูŠุŒ ุนู†ุฏู…ุง ูŠุณุชุฎุฏู… ุชุทุจูŠู‚ ุงู„ุนู…ูŠู„ ู†ุงูุฐุฉ ุงู„ุฏูุน ุงู„ุชูŠ ุชูˆูุฑู‡ุง Toss Payments ู†ูุณู‡ุงุŒ ูŠุฑุณู„ ุงู„ุชุทุจูŠู‚ ุงู„ุฃู…ุงู…ูŠ "ู…ูุชุงุญ ุงู„ููˆุงุชูŠุฑ" ูˆ"ู…ูุชุงุญ ุงู„ุนู…ูŠู„" ูู‚ุท ุฅู„ู‰ ุฎุงุฏู… ุงู„ูˆุงุฌู‡ุฉ ุงู„ุฎู„ููŠุฉ ู„ุฏูŠูƒุŒ ูˆูŠุชู… ุงุณุชุฎุฏุงู…ู‡ ุนู†ุฏ ุงู„ุญุงุฌุฉ ุฅู„ู‰ ู…ุนู„ูˆู…ุงุช ู…ูุตู„ุฉ ุนู† ุทุฑูŠู‚ุฉ ุงู„ุฏูุน ุงู„ุจุณูŠุทุฉ..", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.billing.authorizations.at", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "billingKey", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋Œ€์ƒ ์ •๋ณด์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "ITossBilling.billingKey", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-toss-payments-server/src/api/structures/ITossBilling.ts", + "textSpan": { + "start": 500, + "length": 19 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ณ ๊ฐ ์‹๋ณ„์ž ํ‚ค", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์ˆ˜๋‹จ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/v1/billing/{billingKey}": { + "post": { + "tags": [], + "parameters": [ + { + "name": "billingKey", + "in": "path", + "schema": { + "type": "string" + }, + "description": "ู…ู† ุงู„ุทุฑูŠู‚ุฉ ุงู„ู…ุณุฌู„ุฉ ู„ู„ุฏูุน ุงู„ุจุณูŠุท.", + "required": true + } + ], + "requestBody": { + "description": "ุทู„ุจ ุงู„ู…ุนู„ูˆู…ุงุช", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossBilling.IPaymentStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossPayment" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ุงุฏูุน ุจุงุณุชุฎุฏุงู… ุงู„ุทุฑูŠู‚ุฉ ุงู„ู…ุณุฌู„ุฉ ู„ู„ุฏูุน ุงู„ุจุณูŠุท", + "description": "ุงุฏูุน ุจุงุณุชุฎุฏุงู… ุงู„ุทุฑูŠู‚ุฉ ุงู„ู…ุณุฌู„ุฉ ู„ู„ุฏูุน ุงู„ุจุณูŠุท. `billing.pay` ู‡ูŠ ุฅุญุฏู‰ ูˆุธุงุฆู ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช (API) ูŠุชู… ุงุณุชุฏุนุงุคู‡ุง ุนู†ุฏู…ุง ุชุฑูŠุฏ ุฅุฌุฑุงุก ุงู„ุฏูุน ุจุงุณุชุฎุฏุงู… ุงู„ุทุฑูŠู‚ุฉ ุงู„ู…ุณุฌู„ุฉ ู„ู„ุฏูุน ุงู„ุจุณูŠุท. ูˆ"billing.pay" ู‡ูŠ ุทุฑูŠู‚ุฉ ุงู„ุฏูุน ุงู„ูˆุญูŠุฏุฉ ุงู„ู…ุณุชุฎุฏู…ุฉ ููŠ ุงู„ุญุงู„ุงุช ุงู„ุชูŠ ู„ุง ูŠุชู…ูƒู† ููŠู‡ุง ุชุทุจูŠู‚ ุงู„ุนู…ูŠู„ ู…ู† ุงุณุชุฎุฏุงู… ู†ุงูุฐุฉ ุงู„ุฏูุน ุงู„ุชูŠ ุชูˆูุฑู‡ุง Toss PaymentsุŒ ูˆูŠุฌุจ ุนู„ู‰ ุฎุงุฏู… ุงู„ูˆุงุฌู‡ุฉ ุงู„ุฎู„ููŠุฉ ู„ุฏูŠูƒ ุงู„ุงุชุตุงู„ ู…ุจุงุดุฑุฉ ุจูˆุธูŠูุฉ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช Toss Payments. ู„ุฐู„ูƒุŒ ุนู†ุฏ ุชุทูˆูŠุฑ ุฎูˆุงุฏู… ุฎู„ููŠุฉ ูˆุชุทุจูŠู‚ุงุช ุฃู…ุงู…ูŠุฉ ุชุฑุชุจุท ุจู€ Toss Payments ููŠู…ุง ูŠุชุนู„ู‚ ุจุงู„ู…ุฏููˆุนุงุช ุงู„ุจุณูŠุทุฉุŒ ูŠู„ุฒู… ุชุตู…ูŠู… ูˆุชุทูˆูŠุฑ ู…ู†ูุตู„ูŠู† ู„ู‡ุฐุง ุงู„ู…ูˆู‚ูุŒ ู„ุฐุง ูŠุฑุฌู‰ ูˆุถุน ุฐู„ูƒ ููŠ ุงู„ุงุนุชุจุงุฑ. ุจุงู„ุฅุถุงูุฉ ุฅู„ู‰ ุฐู„ูƒุŒ `billing.pay` ู‡ูŠ ูˆุธูŠูุฉ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช (API) ุงู„ุชูŠ ูŠุชู… ุงุณุชุฏุนุงุคู‡ุง ุจุดูƒู„ ุตุงุฑู… ูˆูู‚ู‹ุง ู„ุญูƒู… ุฎุงุฏู… ุงู„ูˆุงุฌู‡ุฉ ุงู„ุฎู„ููŠุฉ ู„ุดุฑูƒุชูƒุŒ ู„ุฐุง ูุฅู† ุงู„ุฏูุนุงุช ุงู„ุชูŠ ุชุชู… ู…ู† ุฎู„ุงู„ู‡ุง ู„ุง ุชุชุทู„ุจ {@link Payments.approve } ุนู„ู‰ ุงู„ุฅุทู„ุงู‚. ูˆู…ุน ุฐู„ูƒุŒ ู†ุธุฑู‹ุง ู„ุฃู† `billing.pay` ูŠููƒู…ู„ ุงู„ุฏูุน ุนู„ู‰ ุงู„ููˆุฑ ุฏูˆู† ุงู„ุญุงุฌุฉ ุฅู„ู‰ ุนู…ู„ูŠุฉ ู…ูˆุงูู‚ุฉ ุซุงู†ูˆูŠุฉุŒ ููŠุฌุจ ุนู„ูŠูƒ ุงู„ุงู†ุชุจุงู‡ ุฌูŠุฏู‹ุง ู„ู„ุธุฑูˆู ุงู„ุชูŠ ูŠุชู… ุงุณุชุฏุนุงุคู‡ุง.", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.billing.pay", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "billingKey", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฐ„ํŽธ ๊ฒฐ์ œ์— ๋“ฑ๋กํ•œ ์ˆ˜๋‹จ์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "ITossBilling.billingKey", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-toss-payments-server/src/api/structures/ITossBilling.ts", + "textSpan": { + "start": 500, + "length": 19 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์ฃผ๋ฌธ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/v1/cash-receipts": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุฅุฏุฎุงู„", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossCashReceipt.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ู…ุนู„ูˆู…ุงุช ุงุณุชู„ุงู… ุงู„ู†ู‚ุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossCashReceipt" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ุฅุตุฏุงุฑ ุฅูŠุตุงู„ ู†ู‚ุฏูŠ", + "description": "ุฅุตุฏุงุฑ ุฅูŠุตุงู„ ู†ู‚ุฏูŠ.", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.cash-receipts.store", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/v1/cash-receipts/{receiptKey}/cancel": { + "post": { + "tags": [], + "parameters": [ + { + "name": "receiptKey", + "in": "path", + "schema": { + "type": "string" + }, + "description": "ุฅูŠุตุงู„ ู†ู‚ุฏูŠ", + "required": true + } + ], + "requestBody": { + "description": "ุฅู„ุบุงุก ู…ุนู„ูˆู…ุงุช ุงู„ุฅุฏุฎุงู„", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossCashReceipt.ICancel" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ู…ุนู„ูˆู…ุงุช ุงุณุชู„ุงู… ุงู„ู†ู‚ุฏ ุงู„ู…ู„ุบุงุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossCashReceipt" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ุฅู„ุบุงุก ุฅูŠุตุงู„ ู†ู‚ุฏูŠ", + "description": "ุฅู„ุบุงุก ุฅูŠุตุงู„ ู†ู‚ุฏูŠ.", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.cash-receipts.cancel.cancel", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "receiptKey", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "ITossCashReceipt.receiptKey", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-toss-payments-server/src/api/structures/ITossCashReceipt.ts", + "textSpan": { + "start": 199, + "length": 19 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์ทจ์†Œ ์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์ทจ์†Œ๋œ ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/internal/webhook": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "ู…ุนู„ูˆู…ุงุช ุญุฏุซ Webhook", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossPaymentWebhook" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "", + "x-nestia-encrypted": false + } + }, + "summary": "ุงู„ู…ุณุชู…ุน ุงู„ูˆู‡ู…ูŠ ู„ุญุฏุซ Webhook", + "description": "ุงู„ู…ุณุชู…ุน ุงู„ูˆู‡ู…ูŠ ู„ุญุฏุซ Webhook. `internal.webhook` ุนุจุงุฑุฉ ุนู† ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช ุบูŠุฑ ู…ูˆุฌูˆุฏุฉ ููŠ ุฎุงุฏู… ุฏูุน Toss Payments ุงู„ูุนู„ูŠ. ุฅุฐุง ู„ู… ูŠุชู… ุชุนูŠูŠู† ุนู†ูˆุงู† URL ููŠ {@link Configuration.WEBHOOK_URL} ู„ู€ `fake-toss- Payments-server`ุŒ `fake-toss- ุงู„ูƒู„. ูŠุชู… ุชุณู„ูŠู… ุฃู†ูˆุงุน ุฃุญุฏุงุซ webhook ุงู„ุชูŠ ุชุญุฏุซ ู…ู† Payments-server` ุฅู„ู‰ ู‡ุฐุง ุงู„ู…ูƒุงู† ูˆุชุฎุชููŠ ุจู„ุง ู…ุนู†ู‰. ู„ุฐู„ูƒุŒ ุนู†ุฏู…ุง ุชุฑูŠุฏ ุงู„ุชุญู‚ู‚ ู…ู† ุงู„ุงุชุตุงู„ ุจุฎุงุฏู… Toss Payments ู…ู‚ุฏู…ู‹ุง ุจุงุณุชุฎุฏุงู… "fake-toss- Payments-server"ุŒ ุชุฃูƒุฏ ู…ู† ุชุนูŠูŠู† {@link Configuration.WEBHOOK_URL } ู„ู„ุชุฃูƒุฏ ู…ู† ุชุณู„ูŠู… ุญุฏุซ webhook ุจุดูƒู„ ุตุญูŠุญ ุฅู„ู‰ ุงู„ูˆุงุฌู‡ุฉ ุงู„ุฎู„ููŠุฉ ู„ุฏูŠูƒ ุงู„ุฎุงุฏู…..", + "x-nestia-namespace": "internal.webhook.webhook", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์›นํ›… ์ด๋ฒคํŠธ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/internal/{paymentKey}/deposit": { + "get": { + "tags": [], + "parameters": [ + { + "name": "paymentKey", + "in": "path", + "schema": { + "type": "string" + }, + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน ุงู„ุฎุงุตุฉ ุจุงู„ุญุณุงุจ ุงู„ุงูุชุฑุงุถูŠ ุงู„ู…ุณุชู‡ุฏู", + "required": true + } + ], + "responses": { + "200": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน ู„ู„ุญุณุงุจ ุงู„ุงูุชุฑุงุถูŠ ุงู„ู…ูˆุฏุน", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossPayment" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ู‚ู… ุจุฅูŠุฏุงุน ุงู„ุฃู…ูˆุงู„ ููŠ ุญุณุงุจูƒ ุงู„ุงูุชุฑุงุถูŠ", + "description": "ู‚ู… ุจุฅูŠุฏุงุน ุงู„ุฃู…ูˆุงู„ ููŠ ุญุณุงุจูƒ ุงู„ุงูุชุฑุงุถูŠ. `internal.virtual_accounts.deposit` ู‡ูŠ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช ุบูŠุฑ ู…ูˆุฌูˆุฏุฉ ููŠ ุฎุงุฏู… ุงู„ุฏูุน ุงู„ูุนู„ูŠ ู„ู€ Toss PaymentsุŒ ูˆู‡ูŠ ูˆุธูŠูุฉ ูŠู…ูƒู†ู‡ุง ู…ุญุงูƒุงุฉ ุงู„ู…ูˆู‚ู ุญูŠุซ ูŠู‚ูˆู… ุงู„ุนู…ูŠู„ ุงู„ุฐูŠ ุชู‚ุฏู… ุจุทู„ุจ ู„ู„ุญุตูˆู„ ุนู„ู‰ ุฏูุนุฉ ู…ู† ุญุณุงุจ ุงูุชุฑุงุถูŠ ุจุฅูŠุฏุงุน ุงู„ู…ุจู„ุบ ุงู„ู…ุณุชู‡ุฏู ู„ุงุญู‚ู‹ุง ููŠ ุงู„ุญุณุงุจ ุงู„ุงูุชุฑุงุถูŠ ุญุณุงุจ. ุจู…ุนู†ู‰ ุขุฎุฑุŒ ูŠุชู… ุงุณุชุฎุฏุงู… `internal.virtual_accounts.deposit` ู„ุงุฎุชุจุงุฑ ุณู„ุณู„ุฉ ู…ู† ุงู„ู…ูˆุงู‚ู ุงู„ุชูŠ ูŠู‚ูˆู… ููŠู‡ุง ุงู„ุนู…ูŠู„ ุจุฅูŠุฏุงุน ุงู„ุฃู…ูˆุงู„ ููŠ ุญุณุงุจ ุตุงุฏุฑ ู„ู‡/ู„ู‡ุง ุงูุชุฑุงุถูŠู‹ุงุŒ ูˆุจู†ุงุกู‹ ุนู„ู‰ ุฐู„ูƒ ูŠุชู… ุฅู†ุดุงุก ุญุฏุซ webhook ุนู„ู‰ ุฎุงุฏู… Toss Payments ูˆุฅุฑุณุงู„ู‡ ุฅู„ู‰ ุฎุงุฏู… ุงู„ูˆุงุฌู‡ุฉ ุงู„ุฎู„ููŠุฉ ุงู„ุฎุงุต ุจูƒ.", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "internal.deposit.deposit", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "paymentKey", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋Œ€์ƒ ๊ฐ€์ƒ ๊ณ„์ขŒ ๊ฒฐ์ œ ์ •๋ณด์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "ITossPayment.paymentKey", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-toss-payments-server/src/api/structures/ITossPayment.ts", + "textSpan": { + "start": 2480, + "length": 19 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์ž…๊ธˆ ์™„๋ฃŒ๋œ ๊ฐ€์ƒ ๊ผ์ขŒ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "GET" + } + }, + "/v1/payments/{paymentKey}": { + "get": { + "tags": [], + "parameters": [ + { + "name": "paymentKey", + "in": "path", + "schema": { + "type": "string" + }, + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน", + "required": true + } + ], + "responses": { + "200": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossPayment" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ุงู„ุชุญู‚ู‚ ู…ู† ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน", + "description": "ุนุฑุถ ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน. "ุงู„ู…ุฏููˆุนุงุช.at" ู‡ูŠ ูˆุธูŠูุฉ ุชุจุญุซ ููŠ ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน. ุจุดูƒู„ ุฃุณุงุณูŠุŒ ุนู†ุฏู…ุง ูŠุณุชุฎุฏู… ุชุทุจูŠู‚ ุงู„ุนู…ูŠู„ ู†ุงูุฐุฉ ุงู„ุฏูุน ุงู„ุชูŠ ุชูˆูุฑู‡ุง Toss Payments ู†ูุณู‡ุงุŒ ูŠุฑุณู„ ุงู„ุชุทุจูŠู‚ ุงู„ุฃู…ุงู…ูŠ ูู‚ุท ูƒู…ูŠุฉ ุตุบูŠุฑุฉ ู…ู† ู…ุนู„ูˆู…ุงุช ุงู„ู…ุนุฑูุŒ ู…ุซู„ "PaymentKey"ุŒ ุฅู„ู‰ ุฎุงุฏู…ูƒ ุงู„ุฎู„ููŠุŒ ูˆูŠุชู… ุงุณุชุฎุฏุงู…ู‡ ุนู†ุฏ ุงู„ุญุงุฌุฉ ุฅู„ู‰ ู…ุนู„ูˆู…ุงุช ุฏูุน ู…ูุตู„ุฉ. ูŠุฑุฌู‰ ู…ู„ุงุญุธุฉ ุฃู†ู‡ุŒ ุนู„ู‰ ุนูƒุณ ุดุฑูƒุงุช ุงู„ุฏูุน ุงู„ุฃุฎุฑู‰ ุงู„ุชุงุจุนุฉ ู„ุดุฑูƒุฉ PGุŒ ู„ุง ุชุคูƒุฏ Toss Payments ุนู„ู‰ ุงู„ููˆุฑ ุงู„ู…ุฏููˆุนุงุช ุงู„ุชูŠ ุชู… ุฅุฌุฑุงุคู‡ุง ุจุงุณุชุฎุฏุงู… ู†ุงูุฐุฉ ุงู„ุฏูุน Toss Payments ููŠ ุชุทุจูŠู‚ ุงู„ุนู…ูŠู„. ูŠุฑุฌู‰ ู…ู„ุงุญุธุฉ ุฃู†ู‡ ู„ู† ูŠุชู… ุชุฃูƒูŠุฏ ุงู„ุฏูุน ุญุชู‰ ูŠุชุญู‚ู‚ ุฎุงุฏู… ุงู„ูˆุงุฌู‡ุฉ ุงู„ุฎู„ููŠุฉ ู„ุฏูŠูƒ ู…ู† ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน ู…ู† ุฎู„ุงู„ "ุงู„ู…ุฏููˆุนุงุช.at" ุงู„ุญุงู„ูŠุฉ ูˆูŠูˆุงูู‚ ุนู„ูŠู‡ุง ู…ุจุงุดุฑุฉ ุนู† ุทุฑูŠู‚ ุงู„ุงุชุตุงู„ ุจู€ {@link ู…ูˆุงูู‚ุฉ}..", + "x-nestia-namespace": "v1.payments.at", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "paymentKey", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฒฐ์ œ ์ •๋ณด์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "ITossPayment.paymentKey", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-toss-payments-server/src/api/structures/ITossPayment.ts", + "textSpan": { + "start": 2480, + "length": 19 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "GET" + }, + "post": { + "tags": [], + "parameters": [ + { + "name": "paymentKey", + "in": "path", + "schema": { + "type": "string" + }, + "description": "ุงู„ุฏูุน ุงู„ู…ุณุชู‡ุฏู", + "required": true + } + ], + "requestBody": { + "description": "ุชุฃูƒูŠุฏ ู…ุนู„ูˆู…ุงุช ุงู„ุทู„ุจ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossPayment.IApproval" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน ุงู„ู…ุนุชู…ุฏุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossPayment" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ุงู„ู…ูˆุงูู‚ุฉ ุนู„ู‰ ุงู„ุฏูุน", + "description": "ุชููˆูŠุถ ุงู„ุฏูุน. ู„ุง ุชุคูƒุฏ Toss Payments ุงู„ุฏูุนุงุช ุงู„ุชูŠ ุชู… ุฅุฌุฑุงุคู‡ุง ููŠ ู†ุงูุฐุฉ ุงู„ุฏูุน ู„ู„ุชุทุจูŠู‚ ุงู„ุฃู…ุงู…ูŠ ูˆู„ูŠุณ ููŠ ุงู„ูˆุงุฌู‡ุฉ ุงู„ุฎู„ููŠุฉ ู„ุดุฑูƒุชูƒ ุญุชู‰ ุชุชู… ุงู„ู…ูˆุงูู‚ุฉ ุนู„ู‰ ุงู„ุฏูุน ุจูˆุงุณุทุฉ ุงู„ุฎุงุฏู… ุงู„ุฎู„ููŠ ู„ู„ุฎุฏู…ุฉ. "ุงู„ู…ุฏููˆุนุงุช.ุงู„ู…ูˆุงูู‚ุฉ" ู‡ูŠ ูˆุธูŠูุฉ ุชูˆุงูู‚ ุนู„ู‰ ุงู„ุฏูุน ููŠ ู‡ุฐู‡ ุงู„ุญุงู„ุฉ. ุฅุฐุง ูƒู†ุช ุชุญุงูƒูŠ ุนู…ู„ูŠุฉ ุฏูุน ุจุงุณุชุฎุฏุงู… `fake-toss-Payments-server`ุŒ ูุงุณุชุฎุฏู… {@link ITossCardPayment.IStore.__approved } ุฃูˆ {@link ITossVirtualAccountPayment.IStore.__approved } ุนู†ุฏ ุงุณุชุฏุนุงุก ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ุงู„ู…ุชุนู„ู‚ุฉ ุจุงู„ุฏูุน ุนู† ุทุฑูŠู‚ ุชุนูŠูŠู†ู‡ุง ุนู„ู‰ false ุŒ ูŠู…ูƒู†ูƒ ู…ุญุงูƒุงุฉ ู‡ุฐุง ุงู„ู…ูˆู‚ู ุญูŠุซ ูŠู„ุฒู… ุงู„ุญุตูˆู„ ุนู„ู‰ ู…ูˆุงูู‚ุฉ ู…ู†ูุตู„ุฉ..", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.payments.approve", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "paymentKey", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋Œ€์ƒ ๊ฒฐ์ œ์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "ITossPayment.paymentKey", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-toss-payments-server/src/api/structures/ITossPayment.ts", + "textSpan": { + "start": 2480, + "length": 19 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์ฃผ๋ฌธ ์ •๋ณด ํ™•์ธ", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์Šน์ธ๋œ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/v1/payments/key-in": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "ู…ุนู„ูˆู…ุงุช ุฅุฏุฎุงู„ ุงู„ุฏูุน ุจุงู„ุจุทุงู‚ุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossCardPayment.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน ุจุงู„ุจุทุงู‚ุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossCardPayment" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ุงู„ุฏูุน ุจุงู„ุจุทุงู‚ุฉ", + "description": "ุงู„ุฏูุน ุนู† ุทุฑูŠู‚ ุงู„ุจุทุงู‚ุฉ. `ุงู„ู…ุฏููˆุนุงุช.key_in` ู‡ูŠ ูˆุธูŠูุฉ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ูŠุชู… ุงุณุชุฏุนุงุคู‡ุง ุนู†ุฏ ุฅุฌุฑุงุก ุงู„ุฏูุน ุจุงุณุชุฎุฏุงู… ุงู„ุจุทุงู‚ุฉ. ูƒู…ุฑุฌุนุŒ ุฅุฐุง ูƒุงู† ุชุทุจูŠู‚ ุงู„ุนู…ูŠู„ ูŠุณุชุฎุฏู… ู†ุงูุฐุฉ ุงู„ุฏูุน ุงู„ุชูŠ ุชูˆูุฑู‡ุง Toss Payments ู†ูุณู‡ุงุŒ ูู„ู† ูŠุชู… ุงุณุชุฏุนุงุก "ุงู„ู…ุฏููˆุนุงุช.key_in" ุจูˆุงุณุทุฉ ุฎุงุฏู… ุงู„ูˆุงุฌู‡ุฉ ุงู„ุฎู„ููŠุฉ ู„ุฏูŠูƒ ููŠ ุงู„ุฎุฏู…ุฉ ุงู„ูุนู„ูŠุฉ. ูˆู…ุน ุฐู„ูƒุŒ ูŠู…ูƒู† ุงุณุชุฎุฏุงู…ู‡ ุนู„ู‰ ู…ุณุชูˆู‰ ุจุฑู†ุงู…ุฌ ุฃุชู…ุชุฉ ุงู„ุงุฎุชุจุงุฑ ู„ู…ุญุงูƒุงุฉ ุงู„ู…ูˆู‚ู ุงู„ุฐูŠ ูŠุฏูุน ููŠู‡ ุงู„ุนู…ูŠู„ ุจุงู„ุจุทุงู‚ุฉ. ูˆุฅุฐุง ูƒุงู† ุฎุงุฏู… ุงู„ูˆุงุฌู‡ุฉ ุงู„ุฎู„ููŠุฉ ุงู„ุฎุงุต ุจูƒ ูŠุชุตู„ ุจู€ "Payments.key-in" ู…ุจุงุดุฑุฉุŒ ูุฅู† ุฎุงุฏู… Toss Payments ูŠุฑู‰ ุฐู„ูƒ ูƒุฏูุนุฉ ู…ุนุชู…ุฏุฉ ุจุงู„ูƒุงู…ู„ ูˆูŠุคูƒุฏู‡ุง ุนู„ู‰ ุงู„ููˆุฑ. ูˆู„ุฐู„ูƒุŒ ุนู†ุฏ ุงู„ุงุชุตุงู„ ุจู€ `Payments.key-in` ู…ุจุงุดุฑุฉู‹ุŒ ูŠุชุทู„ุจ ุงู„ุฃู…ุฑ ู…ุฒูŠุฏู‹ุง ู…ู† ุงู„ุงู‡ุชู…ุงู… ุงู„ุฏู‚ูŠู‚ ู…ู‚ุงุฑู†ุฉู‹ ุนู†ุฏู…ุง ุชูƒูˆู† ู‡ู†ุงูƒ ุญุงุฌุฉ ุฅู„ู‰ {@link ู…ูˆุงูู‚ุฉ } ู…ู†ูุตู„ุฉ ุจุงุณุชุฎุฏุงู… ู†ุงูุฐุฉ ุงู„ุฏูุน Toss Payments. ุจุงู„ุฅุถุงูุฉ ุฅู„ู‰ ุฐู„ูƒุŒ ุฅุฐุง ูƒุงู† ุฎุงุฏู… ุงู„ูˆุงุฌู‡ุฉ ุงู„ุฎู„ููŠุฉ ู„ุฏูŠูƒ ูŠุณุชุฎุฏู… "fake-toss- Payments-server" ู„ู…ุญุงูƒุงุฉ ุงู„ุฏูุน ุจุจุทุงู‚ุฉ ุงู„ุนู…ูŠู„ุŒ ูุฅู†ู‡ ูŠุนูŠู† ู‚ูŠู…ุฉ {@link ITossCardPayment.IStore.__approved } ุนู…ุฏู‹ุง ุฅู„ู‰ "ุฎุทุฃ" ู„ุชุฃูƒูŠุฏ ุงู„ุฏูุน ุจุงู„ุจุทุงู‚ุฉ ุชู… ุชุฌู†ุจู‡. ู…ู† ุฎู„ุงู„ ู‡ุฐุงุŒ ูŠู…ูƒู†ูƒ ู…ุญุงูƒุงุฉ ู…ูˆู‚ู ุญูŠุซ ูŠู„ุฒู… {@link ู…ูˆุงูู‚ุฉ} ู…ู†ูุตู„ ููŠ ุญุงู„ุฉ ุงู„ุฏูุน ุจุงู„ุจุทุงู‚ุฉ ุจุงุณุชุฎุฏุงู… ู†ุงูุฐุฉ ุงู„ุฏูุน Toss Payments..", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.payments.key-in.key_in", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์นด๋“œ ๊ฒฐ์ œ ์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์นด๋“œ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/v1/payments/{paymentKey}/cancel": { + "post": { + "tags": [], + "parameters": [ + { + "name": "paymentKey", + "in": "path", + "schema": { + "type": "string" + }, + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน", + "required": true + } + ], + "requestBody": { + "description": "ุฅู„ุบุงุก ู…ุนู„ูˆู…ุงุช ุงู„ุฅุฏุฎุงู„", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossPaymentCancel.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน ุงู„ู…ู„ุบุงุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossPayment" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ุฅู„ุบุงุก ุงู„ุฏูุน", + "description": "ุฅู„ุบุงุก ุงู„ุฏูุน. "ุงู„ู…ุฏููˆุนุงุช.ุฅู„ุบุงุก" ู‡ูŠ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช (API) ุงู„ุชูŠ ุชู„ุบูŠ ุงู„ุฏูุนุงุช. ููŠ ู…ุนู„ูˆู…ุงุช ุฅุฏุฎุงู„ ุฅู„ุบุงุก ุงู„ุฏูุน {@link ITossPaymentCancel.IStore}ุŒ ูŠุฌุจ ุนู„ูŠูƒ ุฅุฏุฎุงู„ ุณุจุจ ุงู„ุฅู„ุบุงุก ูˆุงู„ู…ุจู„ุบ ุงู„ู…ุฑุงุฏ ุฑุฏู‡ ุฅู„ู‰ ุงู„ุนู…ูŠู„ ูˆุถุฑูŠุจุฉ ุงู„ู‚ูŠู…ุฉ ุงู„ู…ุถุงูุฉ ูˆู…ุนู„ูˆู…ุงุช ุญุณุงุจ ุงู„ุงุณุชุฑุฏุงุฏ ุฅุฐุง ู„ุฒู… ุงู„ุฃู…ุฑ..", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.payments.cancel.cancel", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "paymentKey", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฒฐ์ œ ์ •๋ณด์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "ITossPayment.paymentKey", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-toss-payments-server/src/api/structures/ITossPayment.ts", + "textSpan": { + "start": 2480, + "length": 19 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์ทจ์†Œ ์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์ทจ์†Œ๋œ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/v1/virtual-accounts": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "ู…ุนู„ูˆู…ุงุช ุชุทุจูŠู‚ ุงู„ุฏูุน ุงู„ุงูุชุฑุงุถูŠ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossVirtualAccountPayment.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน ุจุงู„ุญุณุงุจ ุงู„ุงูุชุฑุงุถูŠ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossVirtualAccountPayment" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ุชู‚ุฏู… ุจุทู„ุจ ุงู„ุฏูุน ุจุงุณุชุฎุฏุงู… ุงู„ุญุณุงุจ ุงู„ุงูุชุฑุงุถูŠ", + "description": "ุชู‚ุฏู… ุจุทู„ุจ ุงู„ุฏูุน ุจุงุณุชุฎุฏุงู… ุญุณุงุจ ุงูุชุฑุงุถูŠ. `virtual_accounts.store` ู‡ูŠ ูˆุธูŠูุฉ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ูŠุชู… ุงุณุชุฏุนุงุคู‡ุง ุนู†ุฏู…ุง ูŠุญุฏุฏ ุงู„ุนู…ูŠู„ ุญุณุงุจู‹ุง ุงูุชุฑุงุถูŠู‹ุง ูƒุทุฑูŠู‚ุฉ ู„ู„ุฏูุน. ุจุงู„ุทุจุนุŒ ุฅุฐุง ุงุฎุชุงุฑ ุงู„ุนู…ูŠู„ ุญุณุงุจู‹ุง ุงูุชุฑุงุถูŠู‹ุง ู…ุซู„ ู‡ุฐุงุŒ ูู„ู† ุชูƒุชู…ู„ ุนู…ู„ูŠุฉ ุงู„ุฏูุน ุญุชู‰ ูŠู‚ูˆู… ุงู„ุนู…ูŠู„ ุจุฅูŠุฏุงุน ุงู„ุฃู…ูˆุงู„ ููŠ ุงู„ุญุณุงุจ ุงู„ู…ุฎุตุตุŒ ูˆุจุงู„ุชุงู„ูŠ ุชุตุจุญ ู‚ูŠู…ุฉ {@link ITossPayment.status } `WAITING_FOR_DEPOSIT`. ูƒู…ุฑุฌุนุŒ ุฅุฐุง ูƒุงู† ุชุทุจูŠู‚ ุงู„ุนู…ูŠู„ ูŠุณุชุฎุฏู… ู†ุงูุฐุฉ ุงู„ุฏูุน ุงู„ุชูŠ ุชูˆูุฑู‡ุง Toss Payments ู†ูุณู‡ุงุŒ ูู„ู† ูŠุชู… ุงุณุชุฏุนุงุก "virtual_accounts.store" ุจูˆุงุณุทุฉ ุฎุงุฏู… ุงู„ูˆุงุฌู‡ุฉ ุงู„ุฎู„ููŠุฉ ู„ุฏูŠูƒ ููŠ ุงู„ุฎุฏู…ุฉ ุงู„ูุนู„ูŠุฉ. ูˆู…ุน ุฐู„ูƒุŒ ูŠู…ูƒู† ุงุณุชุฎุฏุงู…ู‡ ุนู„ู‰ ู…ุณุชูˆู‰ ุจุฑู†ุงู…ุฌ ุฃุชู…ุชุฉ ุงู„ุงุฎุชุจุงุฑ ู„ู…ุญุงูƒุงุฉ ู…ูˆู‚ู ูŠู‚ูˆู… ููŠู‡ ุงู„ุนู…ูŠู„ ุจุงู„ุฏูุน ุจุงุณุชุฎุฏุงู… ุญุณุงุจ ุงูุชุฑุงุถูŠ. ูˆุนู†ุฏู…ุง ูŠู‚ูˆู… ุงู„ุนู…ูŠู„ ุจุฅูŠุฏุงุน ุงู„ุฃู…ูˆุงู„ ููŠ ุงู„ุญุณุงุจ ุงู„ู…ุฎุตุต ุจุนุฏ "virtual_accounts.store"ุŒ ูŠุชู… ุฅู†ุดุงุก ุญุฏุซ webhook ู…ู† ุฎุงุฏู… Toss Payments ูˆุฅุฑุณุงู„ู‡ ุฅู„ู‰ ุฎุงุฏู… ุงู„ูˆุงุฌู‡ุฉ ุงู„ุฎู„ููŠุฉ ู„ุฏูŠูƒ. ุฅุฐุง ูƒุงู† ุฎุงุฏู… Toss Payments ุงู„ู…ุฑุงุฏ ุฑุจุทู‡ ู„ูŠุณ ุญู‚ูŠู‚ูŠู‹ุง ูˆู„ูƒู†ู‡ "ุฎุงุฏู… ู…ุฏููˆุนุงุช ู…ุฒูŠู"ุŒ ููŠู…ูƒู†ูƒ ู…ุญุงูƒุงุฉ ู…ูˆู‚ู ูŠู‚ูˆู… ููŠู‡ ุงู„ุนู…ูŠู„ ุจุฅูŠุฏุงุน ุฃู…ูˆุงู„ ููŠ ุญุณุงุจ ุงูุชุฑุงุถูŠ ุนู† ุทุฑูŠู‚ ุงู„ุงุชุตุงู„ ุจู€ {@link Internal.virtual_accounts.deposit }..", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.virtual-accounts.store", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฐ€์ƒ ๊ฒฐ์ œ ์‹ ์ฒญ ์ •๋ณด.", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฐ€์ƒ ๊ณ„์ขŒ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + } + }, + "components": { + "schemas": { + "ITossBilling.IStore": { + "type": "object", + "properties": { + "cardNumber": { + "description": "ุฑู‚ู… ุงู„ุจุทุงู‚ุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "[0-9]{16}" + }, + "cardExpirationYear": { + "description": "ุณู†ุฉ ุงู†ุชู‡ุงุก ุงู„ุจุทุงู‚ุฉ (ุฑู‚ู…ูŠู†).", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "\\d{2}" + }, + "cardExpirationMonth": { + "description": "ุดู‡ุฑ ุงู†ุชู‡ุงุก ุงู„ุจุทุงู‚ุฉ (ุฑู‚ู…ูŠู†).", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^(0[1-9]|1[012])$" + }, + "cardPassword": { + "description": "ูƒู„ู…ุฉ ู…ุฑูˆุฑ ุงู„ุจุทุงู‚ุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "customerBirthday": { + "description": "ุชุงุฑูŠุฎ ู…ูŠู„ุงุฏ ุงู„ุนู…ูŠู„. ุชู†ุณูŠู‚ ุงู„ุชุฏูˆูŠู† YYMMDD.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^([0-9]{2})(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$" + }, + "consumerName": { + "description": "ุงุณู… ุงู„ุนู…ูŠู„.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customerEmail": { + "description": "ุงู„ุจุฑูŠุฏ ุงู„ุฅู„ูƒุชุฑูˆู†ูŠ ู„ู„ุนู…ูŠู„.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "format": "email" + }, + "vbv": { + "$ref": "#/components/schemas/__type" + }, + "customerKey": { + "description": "ู…ูุชุงุญ ู…ุนุฑู ุงู„ุนู…ูŠู„. ู…ูุชุงุญ ู…ุนุฑู ุชุชู… ุฅุฏุงุฑุชู‡ ุจูˆุงุณุทุฉ ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู…ู‡ุŒ ูˆู„ูŠุณ ุจูˆุงุณุทุฉ Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "cardNumber", + "cardExpirationYear", + "cardExpirationMonth", + "cardPassword", + "customerBirthday", + "customerKey" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุชุณุฌูŠู„ ุจุทุงู‚ุฉ ุงู„ุฏูุน ุณู‡ู„ุฉ.", + "x-typia-jsDocTags": [] + }, + "__type": { + "type": "object", + "properties": { + "cavv": { + "description": "ู‚ูŠู… ุงู„ู…ุตุงุฏู‚ุฉ ู„ุฌู„ุณุงุช ุงู„ู…ุตุงุฏู‚ุฉ ุงู„ุขู…ู†ุฉ ุซู„ุงุซูŠุฉ ุงู„ุฃุจุนุงุฏ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "xid": { + "description": "ู…ุนุฑู ุงู„ู…ุนุงู…ู„ุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "eci": { + "description": "ู‚ูŠู…ุฉ ุงู„ุฑู…ุฒ ู„ู†ุชูŠุฌุฉ ู…ุตุงุฏู‚ุฉ 3DS.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "cavv", + "xid", + "eci" + ], + "x-typia-jsDocTags": [] + }, + "ITossBilling": { + "type": "object", + "properties": { + "mId": { + "description": "ู…ุนุฑู ุงู„ุชุงุฌุฑ. ูŠุชู… ุงุณุชุฎุฏุงู… ุฏูุนุงุช ุงู„ู‚ุฐู ุญุงู„ูŠู‹ุง.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "billingKey": { + "description": "ู…ูุชุงุญ ู…ุนุฑู {@link ITossBilling }.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "method": { + "const": "์นด๋“œ", + "description": "ุทุฑูŠู‚ุฉ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cardCompany": { + "description": "ุงุณู… ุดุฑูƒุฉ ุงู„ุจุทุงู‚ุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "cardNumber": { + "description": "ุฑู‚ู… ุงู„ุจุทุงู‚ุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "[0-9]{16}" + }, + "authenticatedAt": { + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ุงู„ุดู‡ุงุฏุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + "customerKey": { + "description": "ู…ูุชุงุญ ู…ุนุฑู ุงู„ุนู…ูŠู„. ู…ูุชุงุญ ู…ุนุฑู ุชุชู… ุฅุฏุงุฑุชู‡ ุจูˆุงุณุทุฉ ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู…ู‡ุŒ ูˆู„ูŠุณ ุจูˆุงุณุทุฉ Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "mId", + "billingKey", + "method", + "cardCompany", + "cardNumber", + "authenticatedAt", + "customerKey" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุทุฑูŠู‚ุฉ ุชุณุฌูŠู„ ุงู„ุฏูุน ุงู„ุจุณูŠุทุฉ. "ITossBilling" ู‡ูŠ ูˆุงุฌู‡ุฉ ุจู†ูŠุฉ ุจูŠุงู†ุงุช ุชุฌุณุฏ ุทุฑูŠู‚ุฉ ุจุณูŠุทุฉ ู„ุชุณุฌูŠู„ ุงู„ุฏูุนุŒ ูˆูŠุชู… ุงุณุชุฎุฏุงู…ู‡ุง ุนู†ุฏู…ุง ูŠู‚ูˆู… ุงู„ุนู…ูŠู„ ุจุชุณุฌูŠู„ ุจุทุงู‚ุชู‡ ุงู„ุงุฆุชู…ุงู†ูŠุฉ ุนู„ู‰ ุงู„ุฎุงุฏู… ูˆูŠุฑูŠุฏ ุฅุฌุฑุงุก ุงู„ุฏูุน ุจุณู‡ูˆู„ุฉ ุฏูˆู† ุงู„ุญุงุฌุฉ ุฅู„ู‰ ุฅุฏุฎุงู„ ู…ุนู„ูˆู…ุงุช ุงู„ุจุทุงู‚ุฉ ุจุดูƒู„ ู…ุชูƒุฑุฑ ููŠ ูƒู„ ู…ุฑุฉ ูŠุชู… ููŠู‡ุง ุงู„ุฏูุน. ู…ุทู„ูˆุจ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossBilling.ICustomerKey": { + "type": "object", + "properties": { + "customerKey": { + "description": "ู…ูุชุงุญ ู…ุนุฑู ุงู„ุนู…ูŠู„. ู…ูุชุงุญ ู…ุนุฑู ุชุชู… ุฅุฏุงุฑุชู‡ ุจูˆุงุณุทุฉ ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู…ู‡ุŒ ูˆู„ูŠุณ ุจูˆุงุณุทุฉ Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "customerKey" + ], + "description": "ู…ุนู„ูˆู…ุงุช ู…ุนุฑู ุงู„ุนู…ูŠู„.", + "x-typia-jsDocTags": [] + }, + "ITossBilling.IPaymentStore": { + "type": "object", + "properties": { + "method": { + "const": "billing", + "description": "ูŠุดูŠุฑ ุฅู„ู‰ ุฃู† ุทุฑูŠู‚ุฉ ุงู„ุฏูุน ู‡ูŠ ุงู„ุฏูุน ุงู„ุจุณูŠุท.", + "x-typia-required": true, + "x-typia-optional": false + }, + "billingKey": { + "description": "ู…ูุชุงุญ ู…ุนุฑู {@link IPaymentStore }.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderId": { + "description": "ู…ูุชุงุญ ู…ุนุฑู ุงู„ุทู„ุจ. ู…ูุชุงุญ ู…ุนุฑู ุชุชู… ุฅุฏุงุฑุชู‡ ุจูˆุงุณุทุฉ ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู…ู‡ุŒ ูˆู„ูŠุณ ุจูˆุงุณุทุฉ Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "ุฅุฌู…ุงู„ูŠ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "customerKey": { + "description": "ู…ูุชุงุญ ู…ุนุฑู ุงู„ุนู…ูŠู„. ู…ูุชุงุญ ู…ุนุฑู ุชุชู… ุฅุฏุงุฑุชู‡ ุจูˆุงุณุทุฉ ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู…ู‡ุŒ ูˆู„ูŠุณ ุจูˆุงุณุทุฉ Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "method", + "billingKey", + "orderId", + "amount", + "customerKey" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุทู„ุจ ุงู„ุฏูุน ุจุงุณุชุฎุฏุงู… ุงู„ุฏูุน ุงู„ุจุณูŠุท.", + "x-typia-jsDocTags": [] + }, + "ITossPayment": { + "oneOf": [ + { + "$ref": "#/components/schemas/ITossCardPayment" + }, + { + "$ref": "#/components/schemas/ITossGiftCertificatePayment" + }, + { + "$ref": "#/components/schemas/ITossMobilePhonePayment" + }, + { + "$ref": "#/components/schemas/ITossTransferPayment" + }, + { + "$ref": "#/components/schemas/ITossVirtualAccountPayment" + } + ], + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน. "ITossPayment" ุนุจุงุฑุฉ ุนู† ุจู†ูŠุฉ ุจูŠุงู†ุงุช ุชุฌุณุฏ ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน ุงู„ุฎุงุตุฉ ุจู€ Toss Payments ูˆู‡ูŠ ูˆุงุฌู‡ุฉ ู…ู† ุงู„ู†ูˆุน ุงู„ู…ูˆุญุฏ ุนู†ุฏู…ุง ูŠุชู… ุชุญุฏูŠุฏ ู‚ูŠู…ุฉ ุงู„ุทุฑูŠู‚ุฉ ู…ู† ุฎู„ุงู„ ุญุงู„ุฉ ุงู„ุดุฑุทุŒ ูŠุชู… ุชุญุฏูŠุฏ ุงู„ู†ูˆุน ุงู„ู…ุดุชู‚ ุชู„ู‚ุงุฆูŠู‹ุง. ```ู†ูˆุน ุงู„ู†ุต ุฅุฐุง (ุทุฑูŠู‚ุฉ ุงู„ุฏูุน === "ุจุทุงู‚ุฉ") Payment.card; // ุงู„ุฏูุน ูŠูƒูˆู† ITossCardPayment ```", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossCardPayment": { + "type": "object", + "properties": { + "card": { + "$ref": "#/components/schemas/ITossCardPayment.ICard" + }, + "discount": { + "$ref": "#/components/schemas/ITossCardPayment.IDiscount.Nullable" + }, + "easyPay": { + "oneOf": [ + { + "const": "ํ† ์Šค๊ฒฐ์ œ" + }, + { + "const": "ํŽ˜์ด์ฝ”" + }, + { + "const": "์‚ผ์„ฑํŽ˜์ด" + }, + { + "type": "null" + } + ], + "description": "ุฅุฐุง ุชู… ุงู„ุฏูุน ู…ู† ุฎู„ุงู„ ุงู„ุฏูุน ุงู„ุจุณูŠุทุŒ ู…ุนู„ูˆู…ุงุช ุจุณูŠุทุฉ ุนู† ู†ูˆุน ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false + }, + "method": { + "const": "์นด๋“œ", + "description": "ุทุฑูŠู‚ุฉ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false + }, + "type": { + "oneOf": [ + { + "const": "NORMAL" + }, + { + "const": "BILLING" + } + ], + "description": "ู†ูˆุน ุงู„ุฏูุน. - ุนุงุฏูŠ: ุงู„ุฏูุน ุงู„ุนุงุฏูŠ - ุงู„ููˆุงุชูŠุฑ: ุฏูุน ุจุณูŠุท ุจุงุณุชุฎุฏุงู… ุจุทุงู‚ุฉ ู…ุณุฌู„ุฉ ู…ุณุจู‚ู‹ุง.", + "x-typia-required": true, + "x-typia-optional": false + }, + "status": { + "oneOf": [ + { + "const": "READY" + }, + { + "const": "IN_PROGRESS" + }, + { + "const": "WAITING_FOR_DEPOSIT" + }, + { + "const": "DONE" + }, + { + "const": "CANCELED" + }, + { + "const": "PARTIAL_CANCELED" + }, + { + "const": "ABORTED" + }, + { + "const": "EXPIRED" + } + ], + "description": "ุญุงู„ุฉ ุงู„ุฏูุน. - ุฌุงู‡ุฒ - ู‚ูŠุฏ_ุงู„ุชู‚ุฏู… - ููŠ ุงู†ุชุธุงุฑ_FOR_DEPOSIT - ุชู… - ุชู… ุฅู„ุบุงุคู‡ - ุฌุฒุฆูŠ_ุชู… ุฅู„ุบุงุคู‡ - ุชู… ุฅุญุจุงุทู‡ - ุงู†ุชู‡ุช ุตู„ุงุญูŠุชู‡", + "x-typia-required": true, + "x-typia-optional": false + }, + "mId": { + "description": "ู…ุนุฑู ุงู„ุชุงุฌุฑ. ูŠุชู… ุงุณุชุฎุฏุงู… ุฏูุนุงุช ุงู„ู‚ุฐู ุญุงู„ูŠู‹ุง.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "version": { + "description": "ุฅุตุฏุงุฑ Toss Payments API ู‚ูŠุฏ ุงู„ุงุณุชุฎุฏุงู….", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "paymentKey": { + "description": "ุฑู‚ู… ุงู„ุชุนุฑูŠู ู…ู† ุชูุงุตูŠู„ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderId": { + "description": "ู…ูุชุงุญ ู…ุนุฑู ุงู„ุทู„ุจ. ู…ูุชุงุญ ู…ุนุฑู ุชุชู… ุฅุฏุงุฑุชู‡ ุจูˆุงุณุทุฉ ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู…ู‡ุŒ ูˆู„ูŠุณ ุจูˆุงุณุทุฉ Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "transactionKey": { + "description": "ู‚ูŠู…ุฉ ุฑุฆูŠุณูŠุฉ ูุฑูŠุฏุฉ ู„ู„ู…ุนุงู…ู„ุฉ. ุนู„ู‰ ุนูƒุณ {@link PaymentKey }ุŒ ู„ูŠุณุช ู‡ู†ุงูƒ ุญุงุฌุฉ ู„ุงุณุชุฎุฏุงู…ู‡..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "ุงุณู… ุงู„ุทู„ุจ. ุงุณู… ุงู„ุทู„ุจ ุงู„ุตุงุฏุฑ ุนู† ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู… Toss PaymentsุŒ ูˆู„ูŠุณ ุนู† ุทุฑูŠู‚ Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "currency": { + "description": "ุงู„ูˆุญุฏุฉ ุงู„ู†ู‚ุฏูŠุฉ. ุญุงู„ูŠู‹ุงุŒ ูŠุชูˆูุฑ KRW ูู‚ุท ู„ู…ุฏููˆุนุงุช Toss..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "totalAmount": { + "description": "ุฅุฌู…ุงู„ูŠ ู…ุจู„ุบ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "balanceAmount": { + "description": "ุงู„ู…ุจู„ุบ ุงู„ุฐูŠ ูŠู…ูƒู† ุฅู„ุบุงุคู‡.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "suppliedAmount": { + "description": "ุณุนุฑ ุงู„ุนุฑุถ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxFreeAmount": { + "description": "ู…ุจู„ุบ ู…ุนูุงุฉ ู…ู† ุงู„ุฑุณูˆู… ุงู„ุฌู…ุฑูƒูŠุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vat": { + "description": "ุถุฑูŠุจุฉ ุฅุถุงููŠุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "useEscrow": { + "description": "ู…ุง ุฅุฐุง ูƒุงู† ุณูŠุชู… ุงุณุชุฎุฏุงู… ุงู„ุถู…ุงู†.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "cultureExpense": { + "description": "ุณูˆุงุก ู„ุฅู†ูุงู‚ ุงู„ู…ุงู„ ุนู„ู‰ ุงู„ุซู‚ุงูุฉ. ุชุฐุงูƒุฑ ุงู„ุฏุฎูˆู„ุŒ ูˆุชุฐุงูƒุฑ ุงู„ุฃุฏุงุกุŒ ูˆุชุฐุงูƒุฑ ุงู„ุฏุฎูˆู„ ุฅู„ู‰ ุงู„ู…ุชุญู/ุงู„ู…ุนุฑุถ ุงู„ูู†ูŠุŒ ูˆู…ุง ุฅู„ู‰ ุฐู„ูƒ..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "requestedAt": { + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ุทู„ุจ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + "approvedAt": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ุงู„ู…ูˆุงูู‚ุฉ ุนู„ู‰ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cancels": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/ITossPaymentCancel" + } + }, + { + "type": "null" + } + ], + "description": "ุณุฌู„ ุฅู„ุบุงุก ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cashReceipt": { + "$ref": "#/components/schemas/ITossCashReceipt.ISummary.Nullable" + } + }, + "required": [ + "card", + "discount", + "easyPay", + "method", + "type", + "status", + "mId", + "version", + "paymentKey", + "orderId", + "transactionKey", + "orderName", + "currency", + "totalAmount", + "balanceAmount", + "suppliedAmount", + "taxFreeAmount", + "vat", + "useEscrow", + "cultureExpense", + "requestedAt", + "approvedAt", + "cancels", + "cashReceipt" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน ุจุงู„ุจุทุงู‚ุฉ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossCardPayment.ICard": { + "type": "object", + "properties": { + "company": { + "description": "ุงุณู… ุดุฑูƒุฉ ุงู„ุจุทุงู‚ุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "number": { + "description": "ุฑู‚ู… ุงู„ุจุทุงู‚ุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "[0-9]{16}" + }, + "installmentPlanMonths": { + "description": "ุนุฏุฏ ุงู„ุฃู‚ุณุงุท.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "isInterestFree": { + "description": "ู‡ู„ ูŠุชู… ุชุทุจูŠู‚ ุงู„ุชู‚ุณูŠุท ุจุฏูˆู† ููˆุงุฆุฏุŸ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "approveNo": { + "description": "ุฑู‚ู… ุงู„ู…ูˆุงูู‚ุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "useCardPoint": { + "const": false, + "description": "ู…ุง ุฅุฐุง ูƒุงู† ุณูŠุชู… ุงุณุชุฎุฏุงู… ู†ู‚ุงุท ุงู„ุจุทุงู‚ุฉ.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cardType": { + "oneOf": [ + { + "const": "์‹ ์šฉ" + }, + { + "const": "์ฒดํฌ" + }, + { + "const": "๊ธฐํ”„ํŠธ" + } + ], + "description": "ู†ูˆุน ุงู„ุจุทุงู‚ุฉ.", + "x-typia-required": true, + "x-typia-optional": false + }, + "ownerType": { + "oneOf": [ + { + "const": "๊ฐœ์ธ" + }, + { + "const": "๋ฒ•์ธ" + } + ], + "description": "ู†ูˆุน ุตุงุญุจ ุงู„ุจุทุงู‚ุฉ.", + "x-typia-required": true, + "x-typia-optional": false + }, + "acquireStatus": { + "oneOf": [ + { + "const": "READY" + }, + { + "const": "CANCELED" + }, + { + "const": "REQUESTED" + }, + { + "const": "COMPLETED" + }, + { + "const": "CANCEL_REQUESTED" + } + ], + "description": "ุญุงู„ุฉ ุดุฑุงุก ุงู„ุฏูุน ุจุงู„ุจุทุงู‚ุฉ. - ุฌุงู‡ุฒ: ููŠ ุงู†ุชุธุงุฑ ุงู„ุดุฑุงุก - ู…ุทู„ูˆุจ: ุชู… ุทู„ุจ ุงู„ุดุฑุงุก - ู…ูƒุชู…ู„: ุงูƒุชู…ู„ุช ุนู…ู„ูŠุฉ ุงู„ุดุฑุงุก - CANCEL_REQUESTED: ุชู… ุทู„ุจ ุฅู„ุบุงุก ุงู„ุดุฑุงุก - ุชู… ุงู„ุฅู„ุบุงุก: ุชู… ุฅู„ุบุงุก ุงู„ุดุฑุงุก", + "x-typia-required": true, + "x-typia-optional": false + }, + "receiptUrl": { + "description": "ุนู†ูˆุงู† URL ู„ู„ุฅูŠุตุงู„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "url" + } + }, + "required": [ + "company", + "number", + "installmentPlanMonths", + "isInterestFree", + "approveNo", + "useCardPoint", + "cardType", + "ownerType", + "acquireStatus", + "receiptUrl" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุจุทุงู‚ุฉ.", + "x-typia-jsDocTags": [] + }, + "ITossCardPayment.IDiscount.Nullable": { + "oneOf": [ + { + "type": "object", + "properties": { + "amount": { + "description": "ุงู„ู…ุจู„ุบ ุงู„ู…ุทุจู‚ ู…ุน ุนุฑุถ ุงู„ุฎุตู… ุงู„ููˆุฑูŠ ู„ุดุฑูƒุฉ ุงู„ุจุทุงู‚ุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + } + }, + "required": [ + "amount" + ], + "x-typia-jsDocTags": [] + }, + { + "type": "null" + } + ], + "description": "ู…ุนู„ูˆู…ุงุช ุชุฑูˆูŠุฌูŠุฉ ู„ู„ุฎุตู… ุงู„ููˆุฑูŠ ู…ู† ุดุฑูƒุงุช ุจุทุงู‚ุงุช ุงู„ุงุฆุชู…ุงู†.", + "x-typia-jsDocTags": [] + }, + "ITossPaymentCancel": { + "type": "object", + "properties": { + "cancelAmount": { + "description": "ุฅุฌู…ุงู„ูŠ ุงู„ุฅู„ุบุงุก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancelReason": { + "description": "ุณุจุจ ุงู„ุฅู„ุบุงุก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "taxFreeAmount": { + "description": "ุงู„ู…ุจู„ุบ ุงู„ู…ุนูู‰ ู…ู† ุงู„ุถุฑุงุฆุจ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxAmount": { + "description": "ุงู„ู…ุจู„ุบ ุงู„ุฐูŠ ูŠุชู… ุงู„ุชุนุงู…ู„ ู…ุนู‡ ุนู„ู‰ ุฃู†ู‡ ุฎุงุถุน ู„ู„ุถุฑูŠุจุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "refundableAmount": { + "description": "ุฑุตูŠุฏ ู‚ุงุจู„ ู„ู„ุงุณุชุฑุฏุงุฏ ุจุนุฏ ุฅู„ุบุงุก ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "canceledAt": { + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ุงู„ุฅู„ุบุงุก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + } + }, + "required": [ + "cancelAmount", + "cancelReason", + "taxFreeAmount", + "taxAmount", + "refundableAmount", + "canceledAt" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุฅู„ุบุงุก ุงู„ุฏูุน.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossCashReceipt.ISummary.Nullable": { + "oneOf": [ + { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/ITossCashReceipt.Type" + }, + "amount": { + "description": "ู…ุจู„ุบ ู…ุนุงู„ุฌุฉ ุฅูŠุตุงู„ ุงู„ู†ู‚ุฏ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxFreeAmount": { + "description": "ุงู„ู…ุจู„ุบ ุงู„ู…ุนูู‰ ู…ู† ุงู„ุถุฑุงุฆุจ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "issueNumber": { + "description": "ุฑู‚ู… ุฅุตุฏุงุฑ ุฅูŠุตุงู„ ุงู„ู†ู‚ุฏูŠุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "receiptUrl": { + "description": "ุนู†ูˆุงู† ุตูุญุฉ ุงู„ุงุณุชุนู„ุงู… ุนู† ุฅูŠุตุงู„ ุงู„ู†ู‚ุฏ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "type", + "amount", + "taxFreeAmount", + "issueNumber", + "receiptUrl" + ], + "x-typia-jsDocTags": [] + }, + { + "type": "null" + } + ], + "description": "ู…ุนู„ูˆู…ุงุช ู…ู„ุฎุต ุงุณุชู„ุงู… ุงู„ู†ู‚ุฏ.", + "x-typia-jsDocTags": [] + }, + "ITossCashReceipt.Type": { + "oneOf": [ + { + "const": "์†Œ๋“๊ณต์ œ" + }, + { + "const": "์ง€์ถœ์ฆ๋น™" + } + ], + "description": "ุฃู†ูˆุงุน ุงู„ู…ู‚ุจูˆุถุงุช ุงู„ู†ู‚ุฏูŠุฉ." + }, + "ITossGiftCertificatePayment": { + "type": "object", + "properties": { + "giftCertificate": { + "$ref": "#/components/schemas/ITossGiftCertificatePayment.IGiftCertificate" + }, + "method": { + "const": "์ƒํ’ˆ๊ถŒ", + "description": "ุทุฑูŠู‚ุฉ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false + }, + "type": { + "const": "NORMAL", + "description": "ู†ูˆุน ุงู„ุฏูุน. - ุนุงุฏูŠ: ุงู„ุฏูุน ุงู„ุนุงุฏูŠ - ุงู„ููˆุงุชูŠุฑ: ุฏูุน ุจุณูŠุท ุจุงุณุชุฎุฏุงู… ุจุทุงู‚ุฉ ู…ุณุฌู„ุฉ ู…ุณุจู‚ู‹ุง.", + "x-typia-required": true, + "x-typia-optional": false + }, + "status": { + "oneOf": [ + { + "const": "READY" + }, + { + "const": "IN_PROGRESS" + }, + { + "const": "WAITING_FOR_DEPOSIT" + }, + { + "const": "DONE" + }, + { + "const": "CANCELED" + }, + { + "const": "PARTIAL_CANCELED" + }, + { + "const": "ABORTED" + }, + { + "const": "EXPIRED" + } + ], + "description": "ุญุงู„ุฉ ุงู„ุฏูุน. - ุฌุงู‡ุฒ - ู‚ูŠุฏ_ุงู„ุชู‚ุฏู… - ููŠ ุงู†ุชุธุงุฑ_FOR_DEPOSIT - ุชู… - ุชู… ุฅู„ุบุงุคู‡ - ุฌุฒุฆูŠ_ุชู… ุฅู„ุบุงุคู‡ - ุชู… ุฅุญุจุงุทู‡ - ุงู†ุชู‡ุช ุตู„ุงุญูŠุชู‡", + "x-typia-required": true, + "x-typia-optional": false + }, + "mId": { + "description": "ู…ุนุฑู ุงู„ุชุงุฌุฑ. ูŠุชู… ุงุณุชุฎุฏุงู… ุฏูุนุงุช ุงู„ู‚ุฐู ุญุงู„ูŠู‹ุง.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "version": { + "description": "ุฅุตุฏุงุฑ Toss Payments API ู‚ูŠุฏ ุงู„ุงุณุชุฎุฏุงู….", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "paymentKey": { + "description": "ุฑู‚ู… ุงู„ุชุนุฑูŠู ู…ู† ุชูุงุตูŠู„ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderId": { + "description": "ู…ูุชุงุญ ู…ุนุฑู ุงู„ุทู„ุจ. ู…ูุชุงุญ ู…ุนุฑู ุชุชู… ุฅุฏุงุฑุชู‡ ุจูˆุงุณุทุฉ ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู…ู‡ุŒ ูˆู„ูŠุณ ุจูˆุงุณุทุฉ Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "transactionKey": { + "description": "ู‚ูŠู…ุฉ ุฑุฆูŠุณูŠุฉ ูุฑูŠุฏุฉ ู„ู„ู…ุนุงู…ู„ุฉ. ุนู„ู‰ ุนูƒุณ {@link PaymentKey }ุŒ ู„ูŠุณุช ู‡ู†ุงูƒ ุญุงุฌุฉ ู„ุงุณุชุฎุฏุงู…ู‡..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "ุงุณู… ุงู„ุทู„ุจ. ุงุณู… ุงู„ุทู„ุจ ุงู„ุตุงุฏุฑ ุนู† ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู… Toss PaymentsุŒ ูˆู„ูŠุณ ุนู† ุทุฑูŠู‚ Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "currency": { + "description": "ุงู„ูˆุญุฏุฉ ุงู„ู†ู‚ุฏูŠุฉ. ุญุงู„ูŠู‹ุงุŒ ูŠุชูˆูุฑ KRW ูู‚ุท ู„ู…ุฏููˆุนุงุช Toss..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "totalAmount": { + "description": "ุฅุฌู…ุงู„ูŠ ู…ุจู„ุบ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "balanceAmount": { + "description": "ุงู„ู…ุจู„ุบ ุงู„ุฐูŠ ูŠู…ูƒู† ุฅู„ุบุงุคู‡.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "suppliedAmount": { + "description": "ุณุนุฑ ุงู„ุนุฑุถ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxFreeAmount": { + "description": "ู…ุจู„ุบ ู…ุนูุงุฉ ู…ู† ุงู„ุฑุณูˆู… ุงู„ุฌู…ุฑูƒูŠุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vat": { + "description": "ุถุฑูŠุจุฉ ุฅุถุงููŠุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "useEscrow": { + "description": "ู…ุง ุฅุฐุง ูƒุงู† ุณูŠุชู… ุงุณุชุฎุฏุงู… ุงู„ุถู…ุงู†.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "cultureExpense": { + "description": "ุณูˆุงุก ู„ุฅู†ูุงู‚ ุงู„ู…ุงู„ ุนู„ู‰ ุงู„ุซู‚ุงูุฉ. ุชุฐุงูƒุฑ ุงู„ุฏุฎูˆู„ุŒ ูˆุชุฐุงูƒุฑ ุงู„ุฃุฏุงุกุŒ ูˆุชุฐุงูƒุฑ ุงู„ุฏุฎูˆู„ ุฅู„ู‰ ุงู„ู…ุชุญู/ุงู„ู…ุนุฑุถ ุงู„ูู†ูŠุŒ ูˆู…ุง ุฅู„ู‰ ุฐู„ูƒ..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "requestedAt": { + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ุทู„ุจ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + "approvedAt": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ุงู„ู…ูˆุงูู‚ุฉ ุนู„ู‰ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cancels": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/ITossPaymentCancel" + } + }, + { + "type": "null" + } + ], + "description": "ุณุฌู„ ุฅู„ุบุงุก ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cashReceipt": { + "$ref": "#/components/schemas/ITossCashReceipt.ISummary.Nullable" + } + }, + "required": [ + "giftCertificate", + "method", + "type", + "status", + "mId", + "version", + "paymentKey", + "orderId", + "transactionKey", + "orderName", + "currency", + "totalAmount", + "balanceAmount", + "suppliedAmount", + "taxFreeAmount", + "vat", + "useEscrow", + "cultureExpense", + "requestedAt", + "approvedAt", + "cancels", + "cashReceipt" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุฏูุน ุดู‡ุงุฏุฉ ุงู„ู‡ุฏูŠุฉ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossGiftCertificatePayment.IGiftCertificate": { + "type": "object", + "properties": { + "approveNo": { + "description": "ุฑู‚ู… ุงู„ู…ูˆุงูู‚ุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "settlementStatus": { + "oneOf": [ + { + "const": "COMPLETE" + }, + { + "const": "INCOMPLETE" + } + ], + "description": "ุญุงู„ุฉ ุงู„ุชุณูˆูŠุฉ.", + "x-typia-required": true, + "x-typia-optional": false + } + }, + "required": [ + "approveNo", + "settlementStatus" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุดู‡ุงุฏุฉ ุงู„ู‡ุฏูŠุฉ.", + "x-typia-jsDocTags": [] + }, + "ITossMobilePhonePayment": { + "type": "object", + "properties": { + "mobilePhone": { + "$ref": "#/components/schemas/ITossMobilePhonePayment.IMobilePhone" + }, + "method": { + "const": "ํœด๋Œ€ํฐ", + "description": "ุทุฑูŠู‚ุฉ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false + }, + "type": { + "const": "NORMAL", + "description": "ู†ูˆุน ุงู„ุฏูุน. - ุนุงุฏูŠ: ุงู„ุฏูุน ุงู„ุนุงุฏูŠ - ุงู„ููˆุงุชูŠุฑ: ุฏูุน ุจุณูŠุท ุจุงุณุชุฎุฏุงู… ุจุทุงู‚ุฉ ู…ุณุฌู„ุฉ ู…ุณุจู‚ู‹ุง.", + "x-typia-required": true, + "x-typia-optional": false + }, + "status": { + "oneOf": [ + { + "const": "READY" + }, + { + "const": "IN_PROGRESS" + }, + { + "const": "WAITING_FOR_DEPOSIT" + }, + { + "const": "DONE" + }, + { + "const": "CANCELED" + }, + { + "const": "PARTIAL_CANCELED" + }, + { + "const": "ABORTED" + }, + { + "const": "EXPIRED" + } + ], + "description": "ุญุงู„ุฉ ุงู„ุฏูุน. - ุฌุงู‡ุฒ - ู‚ูŠุฏ_ุงู„ุชู‚ุฏู… - ููŠ ุงู†ุชุธุงุฑ_FOR_DEPOSIT - ุชู… - ุชู… ุฅู„ุบุงุคู‡ - ุฌุฒุฆูŠ_ุชู… ุฅู„ุบุงุคู‡ - ุชู… ุฅุญุจุงุทู‡ - ุงู†ุชู‡ุช ุตู„ุงุญูŠุชู‡", + "x-typia-required": true, + "x-typia-optional": false + }, + "mId": { + "description": "ู…ุนุฑู ุงู„ุชุงุฌุฑ. ูŠุชู… ุงุณุชุฎุฏุงู… ุฏูุนุงุช ุงู„ู‚ุฐู ุญุงู„ูŠู‹ุง.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "version": { + "description": "ุฅุตุฏุงุฑ Toss Payments API ู‚ูŠุฏ ุงู„ุงุณุชุฎุฏุงู….", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "paymentKey": { + "description": "ุฑู‚ู… ุงู„ุชุนุฑูŠู ู…ู† ุชูุงุตูŠู„ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderId": { + "description": "ู…ูุชุงุญ ู…ุนุฑู ุงู„ุทู„ุจ. ู…ูุชุงุญ ู…ุนุฑู ุชุชู… ุฅุฏุงุฑุชู‡ ุจูˆุงุณุทุฉ ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู…ู‡ุŒ ูˆู„ูŠุณ ุจูˆุงุณุทุฉ Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "transactionKey": { + "description": "ู‚ูŠู…ุฉ ุฑุฆูŠุณูŠุฉ ูุฑูŠุฏุฉ ู„ู„ู…ุนุงู…ู„ุฉ. ุนู„ู‰ ุนูƒุณ {@link PaymentKey }ุŒ ู„ูŠุณุช ู‡ู†ุงูƒ ุญุงุฌุฉ ู„ุงุณุชุฎุฏุงู…ู‡..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "ุงุณู… ุงู„ุทู„ุจ. ุงุณู… ุงู„ุทู„ุจ ุงู„ุตุงุฏุฑ ุนู† ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู… Toss PaymentsุŒ ูˆู„ูŠุณ ุนู† ุทุฑูŠู‚ Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "currency": { + "description": "ุงู„ูˆุญุฏุฉ ุงู„ู†ู‚ุฏูŠุฉ. ุญุงู„ูŠู‹ุงุŒ ูŠุชูˆูุฑ KRW ูู‚ุท ู„ู…ุฏููˆุนุงุช Toss..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "totalAmount": { + "description": "ุฅุฌู…ุงู„ูŠ ู…ุจู„ุบ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "balanceAmount": { + "description": "ุงู„ู…ุจู„ุบ ุงู„ุฐูŠ ูŠู…ูƒู† ุฅู„ุบุงุคู‡.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "suppliedAmount": { + "description": "ุณุนุฑ ุงู„ุนุฑุถ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxFreeAmount": { + "description": "ู…ุจู„ุบ ู…ุนูุงุฉ ู…ู† ุงู„ุฑุณูˆู… ุงู„ุฌู…ุฑูƒูŠุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vat": { + "description": "ุถุฑูŠุจุฉ ุฅุถุงููŠุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "useEscrow": { + "description": "ู…ุง ุฅุฐุง ูƒุงู† ุณูŠุชู… ุงุณุชุฎุฏุงู… ุงู„ุถู…ุงู†.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "cultureExpense": { + "description": "ุณูˆุงุก ู„ุฅู†ูุงู‚ ุงู„ู…ุงู„ ุนู„ู‰ ุงู„ุซู‚ุงูุฉ. ุชุฐุงูƒุฑ ุงู„ุฏุฎูˆู„ุŒ ูˆุชุฐุงูƒุฑ ุงู„ุฃุฏุงุกุŒ ูˆุชุฐุงูƒุฑ ุงู„ุฏุฎูˆู„ ุฅู„ู‰ ุงู„ู…ุชุญู/ุงู„ู…ุนุฑุถ ุงู„ูู†ูŠุŒ ูˆู…ุง ุฅู„ู‰ ุฐู„ูƒ..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "requestedAt": { + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ุทู„ุจ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + "approvedAt": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ุงู„ู…ูˆุงูู‚ุฉ ุนู„ู‰ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cancels": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/ITossPaymentCancel" + } + }, + { + "type": "null" + } + ], + "description": "ุณุฌู„ ุฅู„ุบุงุก ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cashReceipt": { + "$ref": "#/components/schemas/ITossCashReceipt.ISummary.Nullable" + } + }, + "required": [ + "mobilePhone", + "method", + "type", + "status", + "mId", + "version", + "paymentKey", + "orderId", + "transactionKey", + "orderName", + "currency", + "totalAmount", + "balanceAmount", + "suppliedAmount", + "taxFreeAmount", + "vat", + "useEscrow", + "cultureExpense", + "requestedAt", + "approvedAt", + "cancels", + "cashReceipt" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน ุนุจุฑ ุงู„ู‡ุงุชู ุงู„ู…ุญู…ูˆู„.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossMobilePhonePayment.IMobilePhone": { + "type": "object", + "properties": { + "carrier": { + "description": "ูˆูƒุงู„ุฉ ุฃู†ุจุงุก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "customerMobilePhone": { + "description": "ุฑู‚ู… ุงู„ู‡ุงุชู ุงู„ู…ุญู…ูˆู„ ู„ู„ุนู…ูŠู„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "settlementStatus": { + "oneOf": [ + { + "const": "COMPLETED" + }, + { + "const": "INCOMPLETED" + } + ], + "description": "ุญุงู„ุฉ ุงู„ุชุณูˆูŠุฉ.", + "x-typia-required": true, + "x-typia-optional": false + } + }, + "required": [ + "carrier", + "customerMobilePhone", + "settlementStatus" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ู‡ุงุชู ุงู„ุฎู„ูŠูˆูŠ.", + "x-typia-jsDocTags": [] + }, + "ITossTransferPayment": { + "type": "object", + "properties": { + "transfer": { + "$ref": "#/components/schemas/ITossTransferPayment.ITransfer" + }, + "method": { + "const": "๊ณ„์ขŒ์ด์ฒด", + "description": "ุทุฑูŠู‚ุฉ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false + }, + "type": { + "const": "NORMAL", + "description": "ู†ูˆุน ุงู„ุฏูุน. - ุนุงุฏูŠ: ุงู„ุฏูุน ุงู„ุนุงุฏูŠ - ุงู„ููˆุงุชูŠุฑ: ุฏูุน ุจุณูŠุท ุจุงุณุชุฎุฏุงู… ุจุทุงู‚ุฉ ู…ุณุฌู„ุฉ ู…ุณุจู‚ู‹ุง.", + "x-typia-required": true, + "x-typia-optional": false + }, + "status": { + "oneOf": [ + { + "const": "READY" + }, + { + "const": "IN_PROGRESS" + }, + { + "const": "WAITING_FOR_DEPOSIT" + }, + { + "const": "DONE" + }, + { + "const": "CANCELED" + }, + { + "const": "PARTIAL_CANCELED" + }, + { + "const": "ABORTED" + }, + { + "const": "EXPIRED" + } + ], + "description": "ุญุงู„ุฉ ุงู„ุฏูุน. - ุฌุงู‡ุฒ - ู‚ูŠุฏ_ุงู„ุชู‚ุฏู… - ููŠ ุงู†ุชุธุงุฑ_FOR_DEPOSIT - ุชู… - ุชู… ุฅู„ุบุงุคู‡ - ุฌุฒุฆูŠ_ุชู… ุฅู„ุบุงุคู‡ - ุชู… ุฅุญุจุงุทู‡ - ุงู†ุชู‡ุช ุตู„ุงุญูŠุชู‡", + "x-typia-required": true, + "x-typia-optional": false + }, + "mId": { + "description": "ู…ุนุฑู ุงู„ุชุงุฌุฑ. ูŠุชู… ุงุณุชุฎุฏุงู… ุฏูุนุงุช ุงู„ู‚ุฐู ุญุงู„ูŠู‹ุง.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "version": { + "description": "ุฅุตุฏุงุฑ Toss Payments API ู‚ูŠุฏ ุงู„ุงุณุชุฎุฏุงู….", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "paymentKey": { + "description": "ุฑู‚ู… ุงู„ุชุนุฑูŠู ู…ู† ุชูุงุตูŠู„ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderId": { + "description": "ู…ูุชุงุญ ู…ุนุฑู ุงู„ุทู„ุจ. ู…ูุชุงุญ ู…ุนุฑู ุชุชู… ุฅุฏุงุฑุชู‡ ุจูˆุงุณุทุฉ ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู…ู‡ุŒ ูˆู„ูŠุณ ุจูˆุงุณุทุฉ Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "transactionKey": { + "description": "ู‚ูŠู…ุฉ ุฑุฆูŠุณูŠุฉ ูุฑูŠุฏุฉ ู„ู„ู…ุนุงู…ู„ุฉ. ุนู„ู‰ ุนูƒุณ {@link PaymentKey }ุŒ ู„ูŠุณุช ู‡ู†ุงูƒ ุญุงุฌุฉ ู„ุงุณุชุฎุฏุงู…ู‡..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "ุงุณู… ุงู„ุทู„ุจ. ุงุณู… ุงู„ุทู„ุจ ุงู„ุตุงุฏุฑ ุนู† ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู… Toss PaymentsุŒ ูˆู„ูŠุณ ุนู† ุทุฑูŠู‚ Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "currency": { + "description": "ุงู„ูˆุญุฏุฉ ุงู„ู†ู‚ุฏูŠุฉ. ุญุงู„ูŠู‹ุงุŒ ูŠุชูˆูุฑ KRW ูู‚ุท ู„ู…ุฏููˆุนุงุช Toss..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "totalAmount": { + "description": "ุฅุฌู…ุงู„ูŠ ู…ุจู„ุบ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "balanceAmount": { + "description": "ุงู„ู…ุจู„ุบ ุงู„ุฐูŠ ูŠู…ูƒู† ุฅู„ุบุงุคู‡.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "suppliedAmount": { + "description": "ุณุนุฑ ุงู„ุนุฑุถ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxFreeAmount": { + "description": "ู…ุจู„ุบ ู…ุนูุงุฉ ู…ู† ุงู„ุฑุณูˆู… ุงู„ุฌู…ุฑูƒูŠุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vat": { + "description": "ุถุฑูŠุจุฉ ุฅุถุงููŠุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "useEscrow": { + "description": "ู…ุง ุฅุฐุง ูƒุงู† ุณูŠุชู… ุงุณุชุฎุฏุงู… ุงู„ุถู…ุงู†.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "cultureExpense": { + "description": "ุณูˆุงุก ู„ุฅู†ูุงู‚ ุงู„ู…ุงู„ ุนู„ู‰ ุงู„ุซู‚ุงูุฉ. ุชุฐุงูƒุฑ ุงู„ุฏุฎูˆู„ุŒ ูˆุชุฐุงูƒุฑ ุงู„ุฃุฏุงุกุŒ ูˆุชุฐุงูƒุฑ ุงู„ุฏุฎูˆู„ ุฅู„ู‰ ุงู„ู…ุชุญู/ุงู„ู…ุนุฑุถ ุงู„ูู†ูŠุŒ ูˆู…ุง ุฅู„ู‰ ุฐู„ูƒ..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "requestedAt": { + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ุทู„ุจ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + "approvedAt": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ุงู„ู…ูˆุงูู‚ุฉ ุนู„ู‰ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cancels": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/ITossPaymentCancel" + } + }, + { + "type": "null" + } + ], + "description": "ุณุฌู„ ุฅู„ุบุงุก ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cashReceipt": { + "$ref": "#/components/schemas/ITossCashReceipt.ISummary.Nullable" + } + }, + "required": [ + "transfer", + "method", + "type", + "status", + "mId", + "version", + "paymentKey", + "orderId", + "transactionKey", + "orderName", + "currency", + "totalAmount", + "balanceAmount", + "suppliedAmount", + "taxFreeAmount", + "vat", + "useEscrow", + "cultureExpense", + "requestedAt", + "approvedAt", + "cancels", + "cashReceipt" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน ุนู† ุทุฑูŠู‚ ุชุญูˆูŠู„ ุงู„ุญุณุงุจ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossTransferPayment.ITransfer": { + "type": "object", + "properties": { + "bank": { + "description": "ุงุณู… ุงู„ุจู†ูƒ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "settlementStatus": { + "oneOf": [ + { + "const": "COMPLETED" + }, + { + "const": "INCOMPLETED" + } + ], + "description": "ุญุงู„ุฉ ุงู„ู†ู‚ู„.", + "x-typia-required": true, + "x-typia-optional": false + } + }, + "required": [ + "bank", + "settlementStatus" + ], + "description": "ู…ุนู„ูˆู…ุงุช ู†ู‚ู„ ุงู„ุญุณุงุจ.", + "x-typia-jsDocTags": [] + }, + "ITossVirtualAccountPayment": { + "type": "object", + "properties": { + "secret": { + "description": "ู‚ูŠู…ุฉ ุงู„ุชุญู‚ู‚ ู…ู† ุตุญุฉ ุฑุฏ ุงุชุตุงู„ ุงู„ุฅูŠุฏุงุน ุงู„ู…ุฑุณู„ ุนู†ุฏ ุงู„ุฏูุน ุจุงุณุชุฎุฏุงู… ุญุณุงุจ ุงูุชุฑุงุถูŠ..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "virtualAccount": { + "$ref": "#/components/schemas/ITossVirtualAccountPayment.IVirtualAccount" + }, + "method": { + "const": "๊ฐ€์ƒ๊ณ„์ขŒ", + "description": "ุทุฑูŠู‚ุฉ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false + }, + "type": { + "const": "NORMAL", + "description": "ู†ูˆุน ุงู„ุฏูุน. - ุนุงุฏูŠ: ุงู„ุฏูุน ุงู„ุนุงุฏูŠ - ุงู„ููˆุงุชูŠุฑ: ุฏูุน ุจุณูŠุท ุจุงุณุชุฎุฏุงู… ุจุทุงู‚ุฉ ู…ุณุฌู„ุฉ ู…ุณุจู‚ู‹ุง.", + "x-typia-required": true, + "x-typia-optional": false + }, + "status": { + "oneOf": [ + { + "const": "READY" + }, + { + "const": "IN_PROGRESS" + }, + { + "const": "WAITING_FOR_DEPOSIT" + }, + { + "const": "DONE" + }, + { + "const": "CANCELED" + }, + { + "const": "PARTIAL_CANCELED" + }, + { + "const": "ABORTED" + }, + { + "const": "EXPIRED" + } + ], + "description": "ุญุงู„ุฉ ุงู„ุฏูุน. - ุฌุงู‡ุฒ - ู‚ูŠุฏ_ุงู„ุชู‚ุฏู… - ููŠ ุงู†ุชุธุงุฑ_FOR_DEPOSIT - ุชู… - ุชู… ุฅู„ุบุงุคู‡ - ุฌุฒุฆูŠ_ุชู… ุฅู„ุบุงุคู‡ - ุชู… ุฅุญุจุงุทู‡ - ุงู†ุชู‡ุช ุตู„ุงุญูŠุชู‡", + "x-typia-required": true, + "x-typia-optional": false + }, + "mId": { + "description": "ู…ุนุฑู ุงู„ุชุงุฌุฑ. ูŠุชู… ุงุณุชุฎุฏุงู… ุฏูุนุงุช ุงู„ู‚ุฐู ุญุงู„ูŠู‹ุง.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "version": { + "description": "ุฅุตุฏุงุฑ Toss Payments API ู‚ูŠุฏ ุงู„ุงุณุชุฎุฏุงู….", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "paymentKey": { + "description": "ุฑู‚ู… ุงู„ุชุนุฑูŠู ู…ู† ุชูุงุตูŠู„ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderId": { + "description": "ู…ูุชุงุญ ู…ุนุฑู ุงู„ุทู„ุจ. ู…ูุชุงุญ ู…ุนุฑู ุชุชู… ุฅุฏุงุฑุชู‡ ุจูˆุงุณุทุฉ ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู…ู‡ุŒ ูˆู„ูŠุณ ุจูˆุงุณุทุฉ Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "transactionKey": { + "description": "ู‚ูŠู…ุฉ ุฑุฆูŠุณูŠุฉ ูุฑูŠุฏุฉ ู„ู„ู…ุนุงู…ู„ุฉ. ุนู„ู‰ ุนูƒุณ {@link PaymentKey }ุŒ ู„ูŠุณุช ู‡ู†ุงูƒ ุญุงุฌุฉ ู„ุงุณุชุฎุฏุงู…ู‡..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "ุงุณู… ุงู„ุทู„ุจ. ุงุณู… ุงู„ุทู„ุจ ุงู„ุตุงุฏุฑ ุนู† ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู… Toss PaymentsุŒ ูˆู„ูŠุณ ุนู† ุทุฑูŠู‚ Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "currency": { + "description": "ุงู„ูˆุญุฏุฉ ุงู„ู†ู‚ุฏูŠุฉ. ุญุงู„ูŠู‹ุงุŒ ูŠุชูˆูุฑ KRW ูู‚ุท ู„ู…ุฏููˆุนุงุช Toss..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "totalAmount": { + "description": "ุฅุฌู…ุงู„ูŠ ู…ุจู„ุบ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "balanceAmount": { + "description": "ุงู„ู…ุจู„ุบ ุงู„ุฐูŠ ูŠู…ูƒู† ุฅู„ุบุงุคู‡.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "suppliedAmount": { + "description": "ุณุนุฑ ุงู„ุนุฑุถ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxFreeAmount": { + "description": "ู…ุจู„ุบ ู…ุนูุงุฉ ู…ู† ุงู„ุฑุณูˆู… ุงู„ุฌู…ุฑูƒูŠุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vat": { + "description": "ุถุฑูŠุจุฉ ุฅุถุงููŠุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "useEscrow": { + "description": "ู…ุง ุฅุฐุง ูƒุงู† ุณูŠุชู… ุงุณุชุฎุฏุงู… ุงู„ุถู…ุงู†.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "cultureExpense": { + "description": "ุณูˆุงุก ู„ุฅู†ูุงู‚ ุงู„ู…ุงู„ ุนู„ู‰ ุงู„ุซู‚ุงูุฉ. ุชุฐุงูƒุฑ ุงู„ุฏุฎูˆู„ุŒ ูˆุชุฐุงูƒุฑ ุงู„ุฃุฏุงุกุŒ ูˆุชุฐุงูƒุฑ ุงู„ุฏุฎูˆู„ ุฅู„ู‰ ุงู„ู…ุชุญู/ุงู„ู…ุนุฑุถ ุงู„ูู†ูŠุŒ ูˆู…ุง ุฅู„ู‰ ุฐู„ูƒ..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "requestedAt": { + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ุทู„ุจ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + "approvedAt": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ุงู„ู…ูˆุงูู‚ุฉ ุนู„ู‰ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cancels": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/ITossPaymentCancel" + } + }, + { + "type": "null" + } + ], + "description": "ุณุฌู„ ุฅู„ุบุงุก ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cashReceipt": { + "$ref": "#/components/schemas/ITossCashReceipt.ISummary.Nullable" + } + }, + "required": [ + "secret", + "virtualAccount", + "method", + "type", + "status", + "mId", + "version", + "paymentKey", + "orderId", + "transactionKey", + "orderName", + "currency", + "totalAmount", + "balanceAmount", + "suppliedAmount", + "taxFreeAmount", + "vat", + "useEscrow", + "cultureExpense", + "requestedAt", + "approvedAt", + "cancels", + "cashReceipt" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุฏูุน ุจุงู„ุญุณุงุจ ุงู„ุงูุชุฑุงุถูŠ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossVirtualAccountPayment.IVirtualAccount": { + "type": "object", + "properties": { + "accountNumber": { + "description": "ุฑู‚ู… ุงู„ุญุณุงุจ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "accountType": { + "oneOf": [ + { + "const": "์ผ๋ฐ˜" + }, + { + "const": "๊ณ ์ •" + } + ], + "description": "ู†ูˆุน ุงู„ุญุณุงุจ ุงู„ุงูุชุฑุงุถูŠ.", + "x-typia-required": true, + "x-typia-optional": false + }, + "bank": { + "description": "ุงุณู… ุงู„ุจู†ูƒ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "customerName": { + "description": "ุงุณู… ุงู„ุนู…ูŠู„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "dueDate": { + "description": "ุชุงุฑูŠุฎ ุงุณุชุญู‚ุงู‚ ุงู„ุฅูŠุฏุงุน.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date" + }, + "expired": { + "description": "ู‡ู„ ุชู†ุชู‡ูŠ ุตู„ุงุญูŠุฉ ุญุณุงุจูƒ ุงู„ุงูุชุฑุงุถูŠุŸ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "settlementStatus": { + "oneOf": [ + { + "const": "COMPLETED" + }, + { + "const": "INCOMPLETED" + } + ], + "description": "ุญุงู„ุฉ ุงู„ุชุณูˆูŠุฉ.", + "x-typia-required": true, + "x-typia-optional": false + }, + "refundStatus": { + "oneOf": [ + { + "const": "COMPLETED" + }, + { + "const": "NONE" + }, + { + "const": "FAILED" + }, + { + "const": "PENDING" + }, + { + "const": "PARTIAL_FAILED" + } + ], + "description": "ุญุงู„ุฉ ู…ุนุงู„ุฌุฉ ุงุณุชุฑุฏุงุฏ ุงู„ุฃู…ูˆุงู„. - ู„ุง ุดูŠุก: ู„ุง ูŠู†ุทุจู‚ - ูุดู„: ูุดู„ ุงุณุชุฑุฏุงุฏ ุงู„ุฃู…ูˆุงู„ - ู…ุนู„ู‚: ู…ุนุงู„ุฌุฉ ุงุณุชุฑุฏุงุฏ ุงู„ุฃู…ูˆุงู„ - PARTIAL_FAILED: ูุดู„ ุงุณุชุฑุฏุงุฏ ุฌุฒุฆูŠ - ู…ูƒุชู…ู„: ุงูƒุชู…ู„ ุงุณุชุฑุฏุงุฏ ุงู„ุฃู…ูˆุงู„", + "x-typia-required": true, + "x-typia-optional": false + } + }, + "required": [ + "accountNumber", + "accountType", + "bank", + "customerName", + "dueDate", + "expired", + "settlementStatus", + "refundStatus" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุญุณุงุจ ุงู„ุงูุชุฑุงุถูŠ.", + "x-typia-jsDocTags": [] + }, + "ITossCashReceipt.IStore": { + "type": "object", + "properties": { + "type": { + "oneOf": [ + { + "const": "์†Œ๋“๊ณต์ œ" + }, + { + "const": "์ง€์ถœ์ฆ๋น™" + } + ], + "description": "ุฃู†ูˆุงุน ุงู„ู…ู‚ุจูˆุถุงุช ุงู„ู†ู‚ุฏูŠุฉ.", + "x-typia-required": true, + "x-typia-optional": false + }, + "paymentKey": { + "description": "{@link ITossPayment. PaymentKey } ู„ู„ุฏูุนุฉ ุงู„ู…ู†ุณูˆุจุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderId": { + "description": "ู…ุนุฑู ู…ุนุฑู ุงู„ุทู„ุจ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "ุงุณู… ุงู„ุทู„ุจ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "registrationNumber": { + "description": "ุฑู‚ู… ุงู„ุชุนุฑูŠู ุงู„ุดุฎุตูŠ ู„ุฅุตุฏุงุฑ ุงู„ุฅูŠุตุงู„ุงุช ุงู„ู†ู‚ุฏูŠุฉ. ุงุนุชู…ุงุฏู‹ุง ุนู„ู‰ ู†ูˆุน ุงู„ุฅูŠุตุงู„ ุงู„ู†ู‚ุฏูŠุŒ ูŠู…ูƒู†ูƒ ุฅุฏุฎุงู„ ุฑู‚ู… ู‡ุงุชููƒ ุงู„ู…ุญู…ูˆู„ ุฃูˆ ุฑู‚ู… ุชุณุฌูŠู„ ุงู„ู…ู‚ูŠู… ุฃูˆ ุฑู‚ู… ุชุณุฌูŠู„ ุงู„ุฃุนู…ุงู„ ุฃูˆ ุฑู‚ู… ุงู„ุจุทุงู‚ุฉ..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "ุงู„ู…ุจู„ุบ ุงู„ุฐูŠ ุณูŠุชู… ุฅุตุฏุงุฑ ุฅูŠุตุงู„ ู†ู‚ุฏูŠ ุจู‡.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxFreeAmount": { + "description": "ู…ุจู„ุบ ู…ุนูู‰ ู…ู† ุงู„ุถุฑุงุฆุจ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "businessNumber": { + "description": "ุฑู‚ู… ุงู„ุณุฌู„ ุงู„ุชุฌุงุฑูŠ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + } + }, + "required": [ + "type", + "paymentKey", + "orderId", + "orderName", + "registrationNumber", + "amount" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุฅุฏุฎุงู„ ุฅูŠุตุงู„ ุงู„ู†ู‚ุฏ.", + "x-typia-jsDocTags": [] + }, + "ITossCashReceipt": { + "type": "object", + "properties": { + "receiptKey": { + "description": "ู…ูุชุงุญ ู…ุนุฑู ู„ุฅูŠุตุงู„ ุงู„ู†ู‚ุฏูŠุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/ITossCashReceipt.Type" + }, + "orderId": { + "description": "ู…ุนุฑู ู…ุนุฑู ุงู„ุทู„ุจ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "ุงุณู… ุงู„ุทู„ุจ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "approvalNumber": { + "description": "ุฑู‚ู… ุชููˆูŠุถ ุงุณุชู„ุงู… ุงู„ู†ู‚ุฏ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "approvedAt": { + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ุงู„ู…ูˆุงูู‚ุฉ ุนู„ู‰ ุงุณุชู„ุงู… ุงู„ู†ู‚ุฏ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + "canceledAt": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "description": "ุชุงุฑูŠุฎ ูˆูˆู‚ุช ุฅู„ุบุงุก ุงุณุชู„ุงู… ุงู„ู†ู‚ุฏ.", + "x-typia-required": true, + "x-typia-optional": false + }, + "receiptUrl": { + "description": "ุนู†ูˆุงู† URL ู„ู„ุฅูŠุตุงู„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "receiptKey", + "type", + "orderId", + "orderName", + "approvalNumber", + "approvedAt", + "canceledAt", + "receiptUrl" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุงุณุชู„ุงู… ุงู„ู†ู‚ุฏ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossCashReceipt.ICancel": { + "type": "object", + "properties": { + "amount": { + "description": "ู…ุจู„ุบ ุงู„ุฅู„ุบุงุก. ุฅุฐุง ู„ู… ูŠุชู… ุฅุฏุฎุงู„ู‡ุŒ ุณูŠุชู… ุฅู„ุบุงุก {@link ITossCashReceipt.amount ุงู„ู…ุจู„ุบ ุงู„ุฅุฌู…ุงู„ูŠ} ุงู„ู…ุฐูƒูˆุฑ ููŠ ุงู„ุฅูŠุตุงู„ ุงู„ู†ู‚ุฏูŠ..", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + } + }, + "description": "ู…ุนู„ูˆู…ุงุช ุฅุฏุฎุงู„ ุฅู„ุบุงุก ุฅูŠุตุงู„ ุงู„ู†ู‚ุฏ.", + "x-typia-jsDocTags": [] + }, + "ITossPaymentWebhook": { + "type": "object", + "properties": { + "eventType": { + "const": "PAYMENT_STATUS_CHANGED", + "description": "ู†ูˆุน ุงู„ุญุฏุซ.", + "x-typia-required": true, + "x-typia-optional": false + }, + "data": { + "$ref": "#/components/schemas/ITossPaymentWebhook.IData" + } + }, + "required": [ + "eventType", + "data" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุญุฏุซ Webhook.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossPaymentWebhook.IData": { + "type": "object", + "properties": { + "paymentKey": { + "description": "ู…ูุชุงุญ ู…ุนุฑู {@link ITossPayment }.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderId": { + "description": "ู…ูุชุงุญ ู…ุนุฑู ุงู„ุทู„ุจ. ู…ูุชุงุญ ู…ุนุฑู ุชุชู… ุฅุฏุงุฑุชู‡ ุจูˆุงุณุทุฉ ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู…ู‡ุŒ ูˆู„ูŠุณ ุจูˆุงุณุทุฉ Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "status": { + "oneOf": [ + { + "const": "WAITING_FOR_DEPOSIT" + }, + { + "const": "DONE" + }, + { + "const": "CANCELED" + }, + { + "const": "PARTIAL_CANCELED" + } + ], + "description": "ุญุงู„ุฉ ุงู„ุฏูุน. - ุชู…: ุงูƒุชู…ู„ ุงู„ุฏูุน - ุชู… ุงู„ุฅู„ุบุงุก: ุชู… ุฅู„ุบุงุก ุงู„ุฏูุน - PARTIAL_CANCELED: ุชู… ุฅู„ุบุงุก ุงู„ุฏูุน ุฌุฒุฆูŠู‹ุง - WAITING_FOR_DEPOSIT: ููŠ ุงู†ุชุธุงุฑ ุงู„ุฅูŠุฏุงุน", + "x-typia-required": true, + "x-typia-optional": false + } + }, + "required": [ + "paymentKey", + "orderId", + "status" + ], + "description": "ุจูŠุงู†ุงุช ุญุฏุซ Webhook.", + "x-typia-jsDocTags": [] + }, + "ITossCardPayment.IStore": { + "type": "object", + "properties": { + "method": { + "const": "card", + "description": "ูŠุนู†ูŠ ุฃู† ุทุฑูŠู‚ุฉ ุงู„ุฏูุน ู‡ูŠ ุจุทุงู‚ุฉ ุงู„ุงุฆุชู…ุงู†.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cardNumber": { + "description": "ุฑู‚ู… ุงู„ุจุทุงู‚ุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "[0-9]{16}" + }, + "cardExpirationYear": { + "description": "ุณู†ุฉ ุงู†ุชู‡ุงุก ุงู„ุจุทุงู‚ุฉ (ุฑู‚ู…ูŠู†).", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "\\d{2}" + }, + "cardExpirationMonth": { + "description": "ุดู‡ุฑ ุงู†ุชู‡ุงุก ุงู„ุจุทุงู‚ุฉ (ุฑู‚ู…ูŠู†).", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^(0[1-9]|1[012])$" + }, + "cardPassword": { + "description": "ูƒู„ู…ุฉ ู…ุฑูˆุฑ ุงู„ุจุทุงู‚ุฉ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "cardInstallmentPlan": { + "description": "ุนุฏุฏ ุงู„ุฃู‚ุณุงุท.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "amount": { + "description": "ุงู„ู…ุจู„ุบ ุงู„ุฅุฌู…ุงู„ูŠ ุงู„ู…ุฏููˆุน.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxFreeAmount": { + "description": "ุฅุฌู…ุงู„ูŠ ุงู„ุฅุนูุงุก ุงู„ุถุฑูŠุจูŠ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "orderId": { + "description": "ู…ูุชุงุญ ู…ุนุฑู ุงู„ุทู„ุจ. ู…ูุชุงุญ ู…ุนุฑู ุชุชู… ุฅุฏุงุฑุชู‡ ุจูˆุงุณุทุฉ ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู…ู‡ุŒ ูˆู„ูŠุณ ุจูˆุงุณุทุฉ Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "ุงุณู… ุงู„ุทู„ุจ. ุงุณู… ุงู„ุทู„ุจ ุงู„ุตุงุฏุฑ ุนู† ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู… Toss PaymentsุŒ ูˆู„ูŠุณ ุนู† ุทุฑูŠู‚ Toss Payments..", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customerBirthday": { + "description": "ุชุงุฑูŠุฎ ู…ูŠู„ุงุฏ ุงู„ุนู…ูŠู„. ุชู†ุณูŠู‚ ุงู„ุชุฏูˆูŠู† YYMMDD.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "pattern": "^([0-9]{2})(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$" + }, + "customerEmail": { + "description": "ุงู„ุจุฑูŠุฏ ุงู„ุฅู„ูƒุชุฑูˆู†ูŠ ู„ู„ุนู…ูŠู„.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "format": "email" + }, + "vbv": { + "$ref": "#/components/schemas/__type.o1" + }, + "__approved": { + "description": "ู…ุง ุฅุฐุง ุชู…ุช ุงู„ู…ูˆุงูู‚ุฉ ุนู„ู‰ ุงู„ุฏูุน. ูŠุชู… ุงุณุชุฎุฏุงู… ู‡ุฐู‡ ุงู„ู‚ูŠู…ุฉ ูู‚ุท ููŠ ุฎุงุฏู… ุงู„ู…ุฏููˆุนุงุช ุงู„ูˆู‡ู…ูŠุฉ "Fake-toss- Payments-server"ุŒ ูˆูŠุชู… ุงุณุชุฎุฏุงู…ู‡ุง ุนู†ุฏ ุชุฃุฎูŠุฑ ุงู„ู…ูˆุงูู‚ุฉ ุนู„ู‰ ุงู„ุฏูุน ุนู…ุฏู‹ุง. ุฅุฐุง ู‚ู…ุช ุจุชุนูŠูŠู† ู‡ุฐู‡ ุงู„ู‚ูŠู…ุฉ ุนู„ู‰ "ุฎุทุฃ"ุŒ ููŠู…ูƒู†ูƒ ู…ุญุงูƒุงุฉ ู…ูˆู‚ู ูŠู‚ูˆู… ููŠู‡ ุงู„ุชุทุจูŠู‚ ุงู„ุฃู…ุงู…ูŠ ุจุงู„ุฏูุน ุจุงุณุชุฎุฏุงู… ู†ุงูุฐุฉ ุงู„ุฏูุน ุงู„ุชูŠ ุชูˆูุฑู‡ุง Toss Payments. ุจุดูƒู„ ุฃุณุงุณูŠุŒ ุนู†ุฏู…ุง ูŠุทู„ุจ ุฎุงุฏู… Toss Payments ุงู„ุฏูุน ู…ุจุงุดุฑุฉู‹ ุจุงุณุชุฎุฏุงู… ู†ุงูุฐุฉ ุงู„ุฏูุน ุงู„ุชูŠ ุชูˆูุฑู‡ุง Toss Payments ุฏูˆู† ุงู„ู…ุฑูˆุฑ ุนุจุฑ ุงู„ุฎุงุฏู… ุงู„ุฎู„ููŠ ููŠ ุงู„ุชุทุจูŠู‚ ุงู„ุฃู…ุงู…ูŠุŒ ูุฅู† ุงู„ูˆุงุฌู‡ุฉ ุงู„ุฎู„ููŠุฉ ุชุนุงู„ุฌู‡ ุจุดูƒู„ ู…ู†ูุตู„ ุญุชู‰ ูŠุชู… {@linkfunctional.payments.approve ู…ูˆุงูู‚ุฉ} ู„ุง ูŠุชู… ู‚ุจูˆู„ู‡ุง ูƒุฏูุนุฉ ุฑุณู…ูŠุฉ. ู…ู† ู†ุงุญูŠุฉ ุฃุฎุฑู‰ุŒ ุนู†ุฏู…ุง ูŠุณุชุฏุนูŠ ุฎุงุฏู… ุงู„ูˆุงุฌู‡ุฉ ุงู„ุฎู„ููŠุฉ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ู„ุฎุงุฏู… Toss PaymentsุŒ ูุฅู† Toss Payments ูŠูˆุงูู‚ ุนู„ูŠู‡ุง ุนู„ู‰ ุงู„ููˆุฑ ุชุญุชุงุฌ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "boolean" + } + }, + "required": [ + "method", + "cardNumber", + "cardExpirationYear", + "cardExpirationMonth", + "amount", + "orderId" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุทู„ุจ ุงู„ุฏูุน ุจุงุณุชุฎุฏุงู… ุจุทุงู‚ุฉ ุงู„ุงุฆุชู…ุงู†.", + "x-typia-jsDocTags": [] + }, + "__type.o1": { + "type": "object", + "properties": { + "cavv": { + "description": "ู‚ูŠู… ุงู„ู…ุตุงุฏู‚ุฉ ู„ุฌู„ุณุงุช ุงู„ู…ุตุงุฏู‚ุฉ ุงู„ุขู…ู†ุฉ ุซู„ุงุซูŠุฉ ุงู„ุฃุจุนุงุฏ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "xid": { + "description": "ู…ุนุฑู ุงู„ู…ุนุงู…ู„ุฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "eci": { + "description": "ู‚ูŠู…ุฉ ุงู„ุฑู…ุฒ ู„ู†ุชูŠุฌุฉ ู…ุตุงุฏู‚ุฉ 3DS.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "cavv", + "xid", + "eci" + ], + "x-typia-jsDocTags": [] + }, + "ITossPayment.IApproval": { + "type": "object", + "properties": { + "orderId": { + "description": "ู…ูุชุงุญ ู…ุนุฑู ุงู„ุทู„ุจ. ู…ูุชุงุญ ู…ุนุฑู ุชุชู… ุฅุฏุงุฑุชู‡ ุจูˆุงุณุทุฉ ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู…ู‡ุŒ ูˆู„ูŠุณ ุจูˆุงุณุทุฉ Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "ุฅุฌู…ุงู„ูŠ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + } + }, + "required": [ + "orderId", + "amount" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุชุฑุฎูŠุต ุงู„ุฏูุน.", + "x-typia-jsDocTags": [] + }, + "ITossPaymentCancel.IStore": { + "type": "object", + "properties": { + "paymentKey": { + "description": "ู…ูุชุงุญ ู…ุนุฑู {@link ITossPayment }.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "cancelReason": { + "description": "ุณุจุจ ุงู„ุฅู„ุบุงุก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "cancelAmount": { + "description": "ุฅุฌู…ุงู„ูŠ ุงู„ุฅู„ุบุงุก.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "refundReceiveAccount": { + "$ref": "#/components/schemas/__type.o2" + }, + "taxAmount": { + "description": "ู…ุจู„ุบ ุงู„ู…ุนุงู…ู„ุฉ ุงู„ุถุฑูŠุจูŠุฉ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "taxFreeAmount": { + "description": "ู…ุจู„ุบ ุงู„ู…ุนุงู…ู„ุฉ ุงู„ู…ุนูุงุฉ ู…ู† ุงู„ุถุฑุงุฆุจ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "refundableAmount": { + "description": "ุฑุตูŠุฏ ู‚ุงุจู„ ู„ู„ุงุณุชุฑุฏุงุฏ ุจุนุฏ ุฅู„ุบุงุก ุงู„ุฏูุน.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + } + }, + "required": [ + "paymentKey", + "cancelReason" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุทู„ุจ ุฅู„ุบุงุก ุงู„ุฏูุน.", + "x-typia-jsDocTags": [] + }, + "__type.o2": { + "type": "object", + "properties": { + "bank": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุจู†ูƒ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "accountNumber": { + "description": "ุฑู‚ู… ุงู„ุญุณุงุจ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^[0-9]{0,20}$" + }, + "holderName": { + "description": "ุงู„ู…ูˆุฏุน.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "bank", + "accountNumber", + "holderName" + ], + "x-typia-jsDocTags": [] + }, + "ITossVirtualAccountPayment.IStore": { + "type": "object", + "properties": { + "method": { + "const": "virtual-account", + "description": "ูŠุนู†ูŠ ุฃู† ุทุฑูŠู‚ุฉ ุงู„ุฏูุน ู‡ูŠ ุญุณุงุจ ุงูุชุฑุงุถูŠ.", + "x-typia-required": true, + "x-typia-optional": false + }, + "orderId": { + "description": "ุฑู‚ู… ุชุนุฑูŠู ุงู„ุทู„ุจ. ู…ูุชุงุญ ู…ุนุฑู ุชุชู… ุฅุฏุงุฑุชู‡ ุจูˆุงุณุทุฉ ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู…ู‡ุŒ ูˆู„ูŠุณ ุจูˆุงุณุทุฉ Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "ุงุณู… ุงู„ุทู„ุจ. ุงุณู… ุงู„ุทู„ุจ ุงู„ุตุงุฏุฑ ุนู† ุงู„ุฎุฏู…ุฉ ุงู„ุชูŠ ุชุณุชุฎุฏู… Toss PaymentsุŒ ูˆู„ูŠุณ ุนู† ุทุฑูŠู‚ Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "bank": { + "description": "ุงุณู… ุงู„ุจู†ูƒ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "customerName": { + "description": "ุงุณู… ุงู„ุนู…ูŠู„.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "ุฅุฌู…ุงู„ูŠ ุงู„ุฏูุน.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "__approved": { + "description": "ู…ุง ุฅุฐุง ุชู…ุช ุงู„ู…ูˆุงูู‚ุฉ ุนู„ู‰ ุงู„ุฏูุน. ูŠุชู… ุงุณุชุฎุฏุงู… ู‡ุฐู‡ ุงู„ู‚ูŠู…ุฉ ูู‚ุท ููŠ ุฎุงุฏู… ุงู„ู…ุฏููˆุนุงุช ุงู„ูˆู‡ู…ูŠุฉ "Fake-toss- Payments-server"ุŒ ูˆูŠุชู… ุงุณุชุฎุฏุงู…ู‡ุง ุนู†ุฏ ุชุฃุฎูŠุฑ ุงู„ู…ูˆุงูู‚ุฉ ุนู„ู‰ ุงู„ุฏูุน ุนู…ุฏู‹ุง. ุฅุฐุง ู‚ู…ุช ุจุชุนูŠูŠู† ู‡ุฐู‡ ุงู„ู‚ูŠู…ุฉ ุนู„ู‰ "ุฎุทุฃ"ุŒ ููŠู…ูƒู†ูƒ ู…ุญุงูƒุงุฉ ู…ูˆู‚ู ูŠู‚ูˆู… ููŠู‡ ุงู„ุชุทุจูŠู‚ ุงู„ุฃู…ุงู…ูŠ ุจุงู„ุฏูุน ุจุงุณุชุฎุฏุงู… ู†ุงูุฐุฉ ุงู„ุฏูุน ุงู„ุชูŠ ุชูˆูุฑู‡ุง Toss Payments. ุจุดูƒู„ ุฃุณุงุณูŠุŒ ุนู†ุฏู…ุง ูŠุทู„ุจ ุฎุงุฏู… Toss Payments ุงู„ุฏูุน ู…ุจุงุดุฑุฉู‹ ุจุงุณุชุฎุฏุงู… ู†ุงูุฐุฉ ุงู„ุฏูุน ุงู„ุชูŠ ุชูˆูุฑู‡ุง Toss Payments ุฏูˆู† ุงู„ู…ุฑูˆุฑ ุนุจุฑ ุงู„ุฎุงุฏู… ุงู„ุฎู„ููŠ ููŠ ุงู„ุชุทุจูŠู‚ ุงู„ุฃู…ุงู…ูŠุŒ ูุฅู† ุงู„ูˆุงุฌู‡ุฉ ุงู„ุฎู„ููŠุฉ ุชุนุงู„ุฌู‡ ุจุดูƒู„ ู…ู†ูุตู„ ุญุชู‰ ูŠุชู… {@linkfunctional.payments.approve ู…ูˆุงูู‚ุฉ} ู„ุง ูŠุชู… ู‚ุจูˆู„ู‡ุง ูƒุฏูุนุฉ ุฑุณู…ูŠุฉ. ู…ู† ู†ุงุญูŠุฉ ุฃุฎุฑู‰ุŒ ุนู†ุฏู…ุง ูŠุณุชุฏุนูŠ ุฎุงุฏู… ุงู„ูˆุงุฌู‡ุฉ ุงู„ุฎู„ููŠุฉ ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ู„ุฎุงุฏู… Toss PaymentsุŒ ูุฅู† Toss Payments ูŠูˆุงูู‚ ุนู„ูŠู‡ุง ุนู„ู‰ ุงู„ููˆุฑ ุชุญุชุงุฌ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "boolean" + } + }, + "required": [ + "method", + "orderId", + "orderName", + "bank", + "customerName", + "amount" + ], + "description": "ู…ุนู„ูˆู…ุงุช ุทู„ุจ ุงู„ุฏูุน ุจุงุณุชุฎุฏุงู… ุงู„ุญุณุงุจ ุงู„ุงูุชุฑุงุถูŠ.", + "x-typia-jsDocTags": [] + } + }, + "securitySchemes": { + "basic": { + "type": "apiKey", + "name": "Authorization", + "in": "header" + } + } + }, + "x-samchon-emended": true +} \ No newline at end of file diff --git a/assets/output/toss.swagger.en.json b/assets/output/toss.swagger.en.json new file mode 100644 index 0000000..a966eb6 --- /dev/null +++ b/assets/output/toss.swagger.en.json @@ -0,0 +1,3641 @@ +{ + "openapi": "3.1.0", + "servers": [ + { + "url": "http://localhost:30771", + "description": "fake" + }, + { + "url": "https://api.tosspayments.com", + "description": "real" + } + ], + "info": { + "title": "Toss Payments API", + "description": "Built by [fake-toss-payments-server](https://github.com/samchon/fake-toss-payments-server) with [nestia](https://github.com/samchon/nestia)", + "version": "2.0.0", + "license": { + "name": "MIT" + } + }, + "paths": { + "/v1/billing/authorizations/card": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "Easy Payment Card Registration Information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossBilling.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "Easy Payment Card Information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossBilling" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "Register a simple payment card", + "description": "Registering a simple payment card. `billing.authorizations.card.store` is an API function called when a customer wants to register his or her personal card on the server and make a simple payment without having to repeatedly enter the card information every time a payment is needed. Please note that `billing.authorizations.card.store` will not be called by your backend server in the actual service if the client application uses the simple payment card registration window provided by Toss Payments. However, it can be used at the test automation program level to simulate a situation where a customer registers a simple payment card..", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.billing.authorizations.card.store", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ๋“ฑ๋ก ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/v1/billing/authorizations/{billingKey}": { + "post": { + "tags": [], + "parameters": [ + { + "name": "billingKey", + "in": "path", + "schema": { + "type": "string" + }, + "description": "Target information", + "required": true + } + ], + "requestBody": { + "description": "Customer Identifier Key", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossBilling.ICustomerKey" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "Easy payment method information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossBilling" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "Check the registered payment method", + "description": "Check the payment method registered for easy payment. `billing.authorizations.at` is a function that checks the payment method registered by the customer on the Toss Payments server for easy payment. It is mainly used when the client application uses the payment window provided by Toss Payments itself, so the front application only sends `billingKey` and `customerKey` to your backend server, and detailed easy payment method information is needed..", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.billing.authorizations.at", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "billingKey", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋Œ€์ƒ ์ •๋ณด์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "ITossBilling.billingKey", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-toss-payments-server/src/api/structures/ITossBilling.ts", + "textSpan": { + "start": 500, + "length": 19 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ณ ๊ฐ ์‹๋ณ„์ž ํ‚ค", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์ˆ˜๋‹จ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/v1/billing/{billingKey}": { + "post": { + "tags": [], + "parameters": [ + { + "name": "billingKey", + "in": "path", + "schema": { + "type": "string" + }, + "description": "The method registered for easy payment", + "required": true + } + ], + "requestBody": { + "description": "Order Information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossBilling.IPaymentStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "Payment Information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossPayment" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "Pay using a method registered for easy payment", + "description": "Pay with a method registered for easy payment. `billing.pay` is an API function called when you want to make a payment with a method registered for easy payment. And `billing.pay` is the only payment method that is applicable when the client application cannot use the payment window provided by Toss Payments, and your backend server must directly call the API function of Toss Payments. Therefore, when developing a backend server and frontend application that are linked to Toss Payments for easy payment, separate design and development for this situation is required, so please keep this in mind. In addition, `billing.pay` is an API function that is called strictly under the judgment of your company's backend server, so payments made through it do not require {@link payments.approve} at all. However, since `billing.pay` completes the payment immediately without any secondary approval process, you need to pay close attention to the situation in which it is called.", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.billing.pay", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "billingKey", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฐ„ํŽธ ๊ฒฐ์ œ์— ๋“ฑ๋กํ•œ ์ˆ˜๋‹จ์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "ITossBilling.billingKey", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-toss-payments-server/src/api/structures/ITossBilling.ts", + "textSpan": { + "start": 500, + "length": 19 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์ฃผ๋ฌธ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/v1/cash-receipts": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "Input information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossCashReceipt.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "Cash Receipt Information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossCashReceipt" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "Issue a cash receipt", + "description": "Issue a cash receipt.", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.cash-receipts.store", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/v1/cash-receipts/{receiptKey}/cancel": { + "post": { + "tags": [], + "parameters": [ + { + "name": "receiptKey", + "in": "path", + "schema": { + "type": "string" + }, + "description": "Cash receipt", + "required": true + } + ], + "requestBody": { + "description": "Cancellation Input Information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossCashReceipt.ICancel" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "Cancelled Cash Receipt Information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossCashReceipt" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "Cancel a cash receipt", + "description": "Cancel a cash receipt.", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.cash-receipts.cancel.cancel", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "receiptKey", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "ITossCashReceipt.receiptKey", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-toss-payments-server/src/api/structures/ITossCashReceipt.ts", + "textSpan": { + "start": 199, + "length": 19 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์ทจ์†Œ ์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์ทจ์†Œ๋œ ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/internal/webhook": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "Webhook event information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossPaymentWebhook" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "", + "x-nestia-encrypted": false + } + }, + "summary": "Webhook event dummy listener", + "description": "Webhook event dummy listener. `internal.webhook` is an API that does not exist in the actual Toss Payments payment server. If you do not set any URL in {@link Configuration.WEBHOOK_URL } of `fake-toss-payments-server`, all types of webhook events occurring from `fake-toss-payments-server` will be forwarded here and disappear meaninglessly. Therefore, when you want to verify the connection with the Toss Payments server in advance using `fake-toss-payments-server`, be sure to set {@link Configuration.WEBHOOK_URL } to ensure that the webhook event is properly forwarded to your backend server..", + "x-nestia-namespace": "internal.webhook.webhook", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์›นํ›… ์ด๋ฒคํŠธ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/internal/{paymentKey}/deposit": { + "get": { + "tags": [], + "parameters": [ + { + "name": "paymentKey", + "in": "path", + "schema": { + "type": "string" + }, + "description": "Target virtual account payment information", + "required": true + } + ], + "responses": { + "200": { + "description": "Virtual account payment information for completed deposit", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossPayment" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "Deposit to virtual account", + "description": "Deposit to a virtual account. `internal.virtual_accounts.deposit` is an API that does not exist in the actual Toss Payments payment server. It is a function that can simulate a situation where a customer who applied for a virtual account payment deposits the target amount into the virtual account. In other words, `internal.virtual_accounts.deposit` is a function for testing a series of situations where a customer deposits money into a virtual account issued to him/herself, and a webhook event occurs on the Toss Payments server accordingly, which is then transmitted to your backend server..", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "internal.deposit.deposit", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "paymentKey", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋Œ€์ƒ ๊ฐ€์ƒ ๊ณ„์ขŒ ๊ฒฐ์ œ ์ •๋ณด์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "ITossPayment.paymentKey", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-toss-payments-server/src/api/structures/ITossPayment.ts", + "textSpan": { + "start": 2480, + "length": 19 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์ž…๊ธˆ ์™„๋ฃŒ๋œ ๊ฐ€์ƒ ๊ผ์ขŒ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "GET" + } + }, + "/v1/payments/{paymentKey}": { + "get": { + "tags": [], + "parameters": [ + { + "name": "paymentKey", + "in": "path", + "schema": { + "type": "string" + }, + "description": "Payment information", + "required": true + } + ], + "responses": { + "200": { + "description": "Payment Information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossPayment" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "Check payment information", + "description": "Check payment information. `payments.at` is a function to check payment information. It is mainly used when the client application uses the payment window provided by Toss Payments itself, so the front application sends only a very small amount of identifier information such as `paymentKey` to your backend server, and detailed payment information is needed. Please note that Toss Payments is different from other payment PG companies in that payments made using the Toss Payments payment window in the client application are not immediately confirmed. Please note that the payment is not confirmed until your backend server checks the payment information through the current `payments.at` and calls {@link approve } to directly approve it..", + "x-nestia-namespace": "v1.payments.at", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "paymentKey", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฒฐ์ œ ์ •๋ณด์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "ITossPayment.paymentKey", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-toss-payments-server/src/api/structures/ITossPayment.ts", + "textSpan": { + "start": 2480, + "length": 19 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "GET" + }, + "post": { + "tags": [], + "parameters": [ + { + "name": "paymentKey", + "in": "path", + "schema": { + "type": "string" + }, + "description": "Target payment", + "required": true + } + ], + "requestBody": { + "description": "Check order information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossPayment.IApproval" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "Approved payment information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossPayment" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "Authorize payment", + "description": "Approve payment. Toss Payments does not confirm payments made in the payment window of the front application, not in your backend, until the payment is approved by the backend server of the service. `payments.approve` is a function that approves the payment in this situation. If you are simulating payment using `fake-toss-payments-server`, you can simulate this situation that requires separate approval by setting {@link ITossCardPayment.IStore.__approved } or {@link ITossVirtualAccountPayment.IStore.__approved } to `false` when calling the payment-related API..", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.payments.approve", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "paymentKey", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋Œ€์ƒ ๊ฒฐ์ œ์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "ITossPayment.paymentKey", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-toss-payments-server/src/api/structures/ITossPayment.ts", + "textSpan": { + "start": 2480, + "length": 19 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์ฃผ๋ฌธ ์ •๋ณด ํ™•์ธ", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์Šน์ธ๋œ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/v1/payments/key-in": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "Card payment input information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossCardPayment.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "Card Payment Information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossCardPayment" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "Pay by card", + "description": "Pay by card. `payments.key_in` is an API function called when making a payment using a card. Please note that `payments.key_in` will not be called by your backend server in the actual service if the client application uses the payment window provided by Toss Payments itself. However, it can be used at the test automation program level to simulate a situation where a customer pays using a card. Also, if your backend server directly calls `payments.key-in`, the Toss Payments server sees it as a fully approved payment and confirms it right away. Therefore, if you call `payments.key-in` directly, you need to be much more careful than when you use the payment window of Toss Payments, which requires a separate {@link approve}. In addition, if your backend server simulates a customer's card payment using `fake-toss-payments-server`, you can intentionally avoid confirming the card payment by setting the {@link ITossCardPayment.IStore.__approved} value to `false`. This allows you to simulate a situation where a separate {@link approve} is required for card payments using the Toss Payments payment window..", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.payments.key-in.key_in", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์นด๋“œ ๊ฒฐ์ œ ์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์นด๋“œ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/v1/payments/{paymentKey}/cancel": { + "post": { + "tags": [], + "parameters": [ + { + "name": "paymentKey", + "in": "path", + "schema": { + "type": "string" + }, + "description": "Payment information", + "required": true + } + ], + "requestBody": { + "description": "Cancellation Input Information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossPaymentCancel.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "Cancelled Payment Information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossPayment" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "Cancel payment", + "description": "Cancel payment. `payments.cancel` is an API for canceling payments. The payment cancellation input information {@link ITossPaymentCancel.IStore} contains the reason for cancellation, the amount to be refunded to the customer, VAT, and refund account information if necessary..", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.payments.cancel.cancel", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "paymentKey", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฒฐ์ œ ์ •๋ณด์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "ITossPayment.paymentKey", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-toss-payments-server/src/api/structures/ITossPayment.ts", + "textSpan": { + "start": 2480, + "length": 19 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์ทจ์†Œ ์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์ทจ์†Œ๋œ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/v1/virtual-accounts": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "Virtual Payment Application Information.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossVirtualAccountPayment.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "Virtual Account Payment Information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossVirtualAccountPayment" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "Apply for payment with a virtual account", + "description": "Apply for payment with a virtual account. `virtual_accounts.store` is an API function called when a customer selects a virtual account as a payment method. Of course, when a customer selects a virtual account in this way, the payment is not completed until the customer deposits money into the designated account, so the {@link ITossPayment.status} value becomes `WAITING_FOR_DEPOSIT`. As a reference, `virtual_accounts.store` will not be called by your backend server in the actual service if the client application uses the payment window provided by Toss Payments itself. However, it can be used at the test automation program level to simulate a situation where a customer makes a payment with a virtual account. And after `virtual_accounts.store`, if the customer deposits money into the designated account, a webhook event is generated from the Toss Payments server and sent to your backend server. If the linked target Toss Payments server is not real but `fake-toss-payments-server`, you can simulate a situation where a customer deposits money into a virtual account by calling {@link internal.virtual_accounts.deposit}..", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.virtual-accounts.store", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฐ€์ƒ ๊ฒฐ์ œ ์‹ ์ฒญ ์ •๋ณด.", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฐ€์ƒ ๊ณ„์ขŒ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + } + }, + "components": { + "schemas": { + "ITossBilling.IStore": { + "type": "object", + "properties": { + "cardNumber": { + "description": "Card number.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "[0-9]{16}" + }, + "cardExpirationYear": { + "description": "Card expiration year (2 digits).", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "\\d{2}" + }, + "cardExpirationMonth": { + "description": "Card expiration month (2 digits).", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^(0[1-9]|1[012])$" + }, + "cardPassword": { + "description": "Card password.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "customerBirthday": { + "description": "Customer's date of birth. Format YYMMDD.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^([0-9]{2})(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$" + }, + "consumerName": { + "description": "Customer's name.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customerEmail": { + "description": "Customer's Email.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "format": "email" + }, + "vbv": { + "$ref": "#/components/schemas/__type" + }, + "customerKey": { + "description": "Customer identifier key. An identifier key managed by the service that uses it, not by Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "cardNumber", + "cardExpirationYear", + "cardExpirationMonth", + "cardPassword", + "customerBirthday", + "customerKey" + ], + "description": "Easy Payment Card Registration Information.", + "x-typia-jsDocTags": [] + }, + "__type": { + "type": "object", + "properties": { + "cavv": { + "description": "Authentication values for 3D Secure authentication sessions.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "xid": { + "description": "Transaction ID.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "eci": { + "description": "Code value for 3DS authentication result.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "cavv", + "xid", + "eci" + ], + "x-typia-jsDocTags": [] + }, + "ITossBilling": { + "type": "object", + "properties": { + "mId": { + "description": "Merchant ID. Currently tosspayments is used..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "billingKey": { + "description": "Identifier key of {@link ITossBilling }.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "method": { + "const": "์นด๋“œ", + "description": "payment method.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cardCompany": { + "description": "Card company name.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "cardNumber": { + "description": "Card number.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "[0-9]{16}" + }, + "authenticatedAt": { + "description": "Date of certification.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + "customerKey": { + "description": "Customer identifier key. An identifier key managed by the service that uses it, not by Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "mId", + "billingKey", + "method", + "cardCompany", + "cardNumber", + "authenticatedAt", + "customerKey" + ], + "description": "Easy payment registration method information. `ITossBilling` is a data structure interface that visualizes an easy payment registration method. It is used when a customer wants to register his or her credit card on the server and easily make a payment without having to repeatedly enter card information every time a payment is needed..", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossBilling.ICustomerKey": { + "type": "object", + "properties": { + "customerKey": { + "description": "Customer identifier key. An identifier key managed by the service that uses it, not by Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "customerKey" + ], + "description": "Customer Identifier Information.", + "x-typia-jsDocTags": [] + }, + "ITossBilling.IPaymentStore": { + "type": "object", + "properties": { + "method": { + "const": "billing", + "description": "This means that the payment method is simple payment..", + "x-typia-required": true, + "x-typia-optional": false + }, + "billingKey": { + "description": "Identifier key of {@link IPaymentStore}.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderId": { + "description": "Order identifier key. An identifier key managed by the service that uses it, not by Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "Total payment amount.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "customerKey": { + "description": "Customer identifier key. An identifier key managed by the service that uses it, not by Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "method", + "billingKey", + "orderId", + "amount", + "customerKey" + ], + "description": "Payment application information using simple payment.", + "x-typia-jsDocTags": [] + }, + "ITossPayment": { + "oneOf": [ + { + "$ref": "#/components/schemas/ITossCardPayment" + }, + { + "$ref": "#/components/schemas/ITossGiftCertificatePayment" + }, + { + "$ref": "#/components/schemas/ITossMobilePhonePayment" + }, + { + "$ref": "#/components/schemas/ITossTransferPayment" + }, + { + "$ref": "#/components/schemas/ITossVirtualAccountPayment" + } + ], + "description": "Payment information. `ITossPayment` is a data structure that visualizes the payment information of Toss Payments and is a union type interface. If the method value is specified through the if condition, the derived type is automatically specified. ```typescript if (payment.method === "card") payment.card; // payment be ITossCardPayment ```", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossCardPayment": { + "type": "object", + "properties": { + "card": { + "$ref": "#/components/schemas/ITossCardPayment.ICard" + }, + "discount": { + "$ref": "#/components/schemas/ITossCardPayment.IDiscount.Nullable" + }, + "easyPay": { + "oneOf": [ + { + "const": "ํ† ์Šค๊ฒฐ์ œ" + }, + { + "const": "ํŽ˜์ด์ฝ”" + }, + { + "const": "์‚ผ์„ฑํŽ˜์ด" + }, + { + "type": "null" + } + ], + "description": "If you pay with simple payment, simple payment type information.", + "x-typia-required": true, + "x-typia-optional": false + }, + "method": { + "const": "์นด๋“œ", + "description": "payment method.", + "x-typia-required": true, + "x-typia-optional": false + }, + "type": { + "oneOf": [ + { + "const": "NORMAL" + }, + { + "const": "BILLING" + } + ], + "description": "Payment Type. - NORMAL: General payment - BILLING: Easy payment using a pre-registered card.", + "x-typia-required": true, + "x-typia-optional": false + }, + "status": { + "oneOf": [ + { + "const": "READY" + }, + { + "const": "IN_PROGRESS" + }, + { + "const": "WAITING_FOR_DEPOSIT" + }, + { + "const": "DONE" + }, + { + "const": "CANCELED" + }, + { + "const": "PARTIAL_CANCELED" + }, + { + "const": "ABORTED" + }, + { + "const": "EXPIRED" + } + ], + "description": "Payment status. - READY - IN_PROGRESS - WAITING_FOR_DEPOSIT - DONE - CANCELED - PARTIAL_CANCELED - ABORTED - EXPIRED", + "x-typia-required": true, + "x-typia-optional": false + }, + "mId": { + "description": "Merchant ID. Currently tosspayments is used..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "version": { + "description": "The version of Toss Payments API you are using.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "paymentKey": { + "description": "Identifier number of payment details.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderId": { + "description": "Order identifier key. An identifier key managed by the service that uses it, not by Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "transactionKey": { + "description": "A unique key value for the transaction. Unlike {@link paymentKey }, this is not used..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "Order name. The order name issued by the service that uses it, not Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "currency": { + "description": "Currency unit. Currently, Toss Payments only accepts KRW..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "totalAmount": { + "description": "Total payment amount.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "balanceAmount": { + "description": "Amount that can be cancelled.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "suppliedAmount": { + "description": "Supply price.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxFreeAmount": { + "description": "Duty Free Amount.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vat": { + "description": "surtax.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "useEscrow": { + "description": "Whether to use escrow.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "cultureExpense": { + "description": "Whether you spend money on cultural expenses, such as a stone tablet, performance tickets, museum/art gallery admission tickets, etc..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "requestedAt": { + "description": "Payment request date and time.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + "approvedAt": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "description": "Payment approval date and time.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cancels": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/ITossPaymentCancel" + } + }, + { + "type": "null" + } + ], + "description": "Payment Cancellation History.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cashReceipt": { + "$ref": "#/components/schemas/ITossCashReceipt.ISummary.Nullable" + } + }, + "required": [ + "card", + "discount", + "easyPay", + "method", + "type", + "status", + "mId", + "version", + "paymentKey", + "orderId", + "transactionKey", + "orderName", + "currency", + "totalAmount", + "balanceAmount", + "suppliedAmount", + "taxFreeAmount", + "vat", + "useEscrow", + "cultureExpense", + "requestedAt", + "approvedAt", + "cancels", + "cashReceipt" + ], + "description": "Card Payment Information.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossCardPayment.ICard": { + "type": "object", + "properties": { + "company": { + "description": "Card company name.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "number": { + "description": "Card number.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "[0-9]{16}" + }, + "installmentPlanMonths": { + "description": "Number of installment months.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "isInterestFree": { + "description": "Whether interest-free installment applies.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "approveNo": { + "description": "Approval Number.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "useCardPoint": { + "const": false, + "description": "Whether to use card points.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cardType": { + "oneOf": [ + { + "const": "์‹ ์šฉ" + }, + { + "const": "์ฒดํฌ" + }, + { + "const": "๊ธฐํ”„ํŠธ" + } + ], + "description": "Card Type.", + "x-typia-required": true, + "x-typia-optional": false + }, + "ownerType": { + "oneOf": [ + { + "const": "๊ฐœ์ธ" + }, + { + "const": "๋ฒ•์ธ" + } + ], + "description": "Card owner type.", + "x-typia-required": true, + "x-typia-optional": false + }, + "acquireStatus": { + "oneOf": [ + { + "const": "READY" + }, + { + "const": "CANCELED" + }, + { + "const": "REQUESTED" + }, + { + "const": "COMPLETED" + }, + { + "const": "CANCEL_REQUESTED" + } + ], + "description": "Card payment purchase status. - READY: Purchase pending - REQUESTED: Purchase requested - COMPLETED: Purchase completed - CANCEL_REQUESTED: Purchase cancellation requested - CANCELD: Purchase cancelled", + "x-typia-required": true, + "x-typia-optional": false + }, + "receiptUrl": { + "description": "Receipt URL.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "url" + } + }, + "required": [ + "company", + "number", + "installmentPlanMonths", + "isInterestFree", + "approveNo", + "useCardPoint", + "cardType", + "ownerType", + "acquireStatus", + "receiptUrl" + ], + "description": "Card information.", + "x-typia-jsDocTags": [] + }, + "ITossCardPayment.IDiscount.Nullable": { + "oneOf": [ + { + "type": "object", + "properties": { + "amount": { + "description": "Amount subject to the card company's immediate discount promotion.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + } + }, + "required": [ + "amount" + ], + "x-typia-jsDocTags": [] + }, + { + "type": "null" + } + ], + "description": "Information on instant discount promotions from credit card companies.", + "x-typia-jsDocTags": [] + }, + "ITossPaymentCancel": { + "type": "object", + "properties": { + "cancelAmount": { + "description": "Cancellation Total.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancelReason": { + "description": "Reason for cancellation.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "taxFreeAmount": { + "description": "Tax-exempt amount.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxAmount": { + "description": "Amount taxed.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "refundableAmount": { + "description": "Refundable balance after cancellation.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "canceledAt": { + "description": "Cancellation date.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + } + }, + "required": [ + "cancelAmount", + "cancelReason", + "taxFreeAmount", + "taxAmount", + "refundableAmount", + "canceledAt" + ], + "description": "Payment Cancellation Information.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossCashReceipt.ISummary.Nullable": { + "oneOf": [ + { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/ITossCashReceipt.Type" + }, + "amount": { + "description": "Cash receipt processed amount.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxFreeAmount": { + "description": "Tax-exempt amount.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "issueNumber": { + "description": "Cash receipt issuance number.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "receiptUrl": { + "description": "Cash receipt inquiry page address.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "type", + "amount", + "taxFreeAmount", + "issueNumber", + "receiptUrl" + ], + "x-typia-jsDocTags": [] + }, + { + "type": "null" + } + ], + "description": "Cash Receipt Summary Information.", + "x-typia-jsDocTags": [] + }, + "ITossCashReceipt.Type": { + "oneOf": [ + { + "const": "์†Œ๋“๊ณต์ œ" + }, + { + "const": "์ง€์ถœ์ฆ๋น™" + } + ], + "description": "Types of Cash Receipts." + }, + "ITossGiftCertificatePayment": { + "type": "object", + "properties": { + "giftCertificate": { + "$ref": "#/components/schemas/ITossGiftCertificatePayment.IGiftCertificate" + }, + "method": { + "const": "์ƒํ’ˆ๊ถŒ", + "description": "payment method.", + "x-typia-required": true, + "x-typia-optional": false + }, + "type": { + "const": "NORMAL", + "description": "Payment Type. - NORMAL: General payment - BILLING: Easy payment using a pre-registered card.", + "x-typia-required": true, + "x-typia-optional": false + }, + "status": { + "oneOf": [ + { + "const": "READY" + }, + { + "const": "IN_PROGRESS" + }, + { + "const": "WAITING_FOR_DEPOSIT" + }, + { + "const": "DONE" + }, + { + "const": "CANCELED" + }, + { + "const": "PARTIAL_CANCELED" + }, + { + "const": "ABORTED" + }, + { + "const": "EXPIRED" + } + ], + "description": "Payment status. - READY - IN_PROGRESS - WAITING_FOR_DEPOSIT - DONE - CANCELED - PARTIAL_CANCELED - ABORTED - EXPIRED", + "x-typia-required": true, + "x-typia-optional": false + }, + "mId": { + "description": "Merchant ID. Currently tosspayments is used..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "version": { + "description": "The version of Toss Payments API you are using.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "paymentKey": { + "description": "Identifier number of payment details.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderId": { + "description": "Order identifier key. An identifier key managed by the service that uses it, not by Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "transactionKey": { + "description": "A unique key value for the transaction. Unlike {@link paymentKey }, this is not used..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "Order name. The order name issued by the service that uses it, not Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "currency": { + "description": "Currency unit. Currently, Toss Payments only accepts KRW..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "totalAmount": { + "description": "Total payment amount.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "balanceAmount": { + "description": "Amount that can be cancelled.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "suppliedAmount": { + "description": "Supply price.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxFreeAmount": { + "description": "Duty Free Amount.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vat": { + "description": "surtax.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "useEscrow": { + "description": "Whether to use escrow.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "cultureExpense": { + "description": "Whether you spend money on cultural expenses, such as a stone tablet, performance tickets, museum/art gallery admission tickets, etc..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "requestedAt": { + "description": "Payment request date and time.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + "approvedAt": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "description": "Payment approval date and time.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cancels": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/ITossPaymentCancel" + } + }, + { + "type": "null" + } + ], + "description": "Payment Cancellation History.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cashReceipt": { + "$ref": "#/components/schemas/ITossCashReceipt.ISummary.Nullable" + } + }, + "required": [ + "giftCertificate", + "method", + "type", + "status", + "mId", + "version", + "paymentKey", + "orderId", + "transactionKey", + "orderName", + "currency", + "totalAmount", + "balanceAmount", + "suppliedAmount", + "taxFreeAmount", + "vat", + "useEscrow", + "cultureExpense", + "requestedAt", + "approvedAt", + "cancels", + "cashReceipt" + ], + "description": "Gift Certificate Payment Information.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossGiftCertificatePayment.IGiftCertificate": { + "type": "object", + "properties": { + "approveNo": { + "description": "Approval Number.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "settlementStatus": { + "oneOf": [ + { + "const": "COMPLETE" + }, + { + "const": "INCOMPLETE" + } + ], + "description": "Settlement status.", + "x-typia-required": true, + "x-typia-optional": false + } + }, + "required": [ + "approveNo", + "settlementStatus" + ], + "description": "Gift Certificate Information.", + "x-typia-jsDocTags": [] + }, + "ITossMobilePhonePayment": { + "type": "object", + "properties": { + "mobilePhone": { + "$ref": "#/components/schemas/ITossMobilePhonePayment.IMobilePhone" + }, + "method": { + "const": "ํœด๋Œ€ํฐ", + "description": "payment method.", + "x-typia-required": true, + "x-typia-optional": false + }, + "type": { + "const": "NORMAL", + "description": "Payment Type. - NORMAL: General payment - BILLING: Easy payment using a pre-registered card.", + "x-typia-required": true, + "x-typia-optional": false + }, + "status": { + "oneOf": [ + { + "const": "READY" + }, + { + "const": "IN_PROGRESS" + }, + { + "const": "WAITING_FOR_DEPOSIT" + }, + { + "const": "DONE" + }, + { + "const": "CANCELED" + }, + { + "const": "PARTIAL_CANCELED" + }, + { + "const": "ABORTED" + }, + { + "const": "EXPIRED" + } + ], + "description": "Payment status. - READY - IN_PROGRESS - WAITING_FOR_DEPOSIT - DONE - CANCELED - PARTIAL_CANCELED - ABORTED - EXPIRED", + "x-typia-required": true, + "x-typia-optional": false + }, + "mId": { + "description": "Merchant ID. Currently tosspayments is used..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "version": { + "description": "The version of Toss Payments API you are using.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "paymentKey": { + "description": "Identifier number of payment details.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderId": { + "description": "Order identifier key. An identifier key managed by the service that uses it, not by Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "transactionKey": { + "description": "A unique key value for the transaction. Unlike {@link paymentKey }, this is not used..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "Order name. The order name issued by the service that uses it, not Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "currency": { + "description": "Currency unit. Currently, Toss Payments only accepts KRW..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "totalAmount": { + "description": "Total payment amount.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "balanceAmount": { + "description": "Amount that can be cancelled.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "suppliedAmount": { + "description": "Supply price.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxFreeAmount": { + "description": "Duty Free Amount.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vat": { + "description": "surtax.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "useEscrow": { + "description": "Whether to use escrow.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "cultureExpense": { + "description": "Whether you spend money on cultural expenses, such as a stone tablet, performance tickets, museum/art gallery admission tickets, etc..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "requestedAt": { + "description": "Payment request date and time.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + "approvedAt": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "description": "Payment approval date and time.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cancels": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/ITossPaymentCancel" + } + }, + { + "type": "null" + } + ], + "description": "Payment Cancellation History.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cashReceipt": { + "$ref": "#/components/schemas/ITossCashReceipt.ISummary.Nullable" + } + }, + "required": [ + "mobilePhone", + "method", + "type", + "status", + "mId", + "version", + "paymentKey", + "orderId", + "transactionKey", + "orderName", + "currency", + "totalAmount", + "balanceAmount", + "suppliedAmount", + "taxFreeAmount", + "vat", + "useEscrow", + "cultureExpense", + "requestedAt", + "approvedAt", + "cancels", + "cashReceipt" + ], + "description": "Mobile phone payment information.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossMobilePhonePayment.IMobilePhone": { + "type": "object", + "properties": { + "carrier": { + "description": "news agency.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "customerMobilePhone": { + "description": "Customer mobile phone number.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "settlementStatus": { + "oneOf": [ + { + "const": "COMPLETED" + }, + { + "const": "INCOMPLETED" + } + ], + "description": "Settlement status.", + "x-typia-required": true, + "x-typia-optional": false + } + }, + "required": [ + "carrier", + "customerMobilePhone", + "settlementStatus" + ], + "description": "Mobile phone information.", + "x-typia-jsDocTags": [] + }, + "ITossTransferPayment": { + "type": "object", + "properties": { + "transfer": { + "$ref": "#/components/schemas/ITossTransferPayment.ITransfer" + }, + "method": { + "const": "๊ณ„์ขŒ์ด์ฒด", + "description": "payment method.", + "x-typia-required": true, + "x-typia-optional": false + }, + "type": { + "const": "NORMAL", + "description": "Payment Type. - NORMAL: General payment - BILLING: Easy payment using a pre-registered card.", + "x-typia-required": true, + "x-typia-optional": false + }, + "status": { + "oneOf": [ + { + "const": "READY" + }, + { + "const": "IN_PROGRESS" + }, + { + "const": "WAITING_FOR_DEPOSIT" + }, + { + "const": "DONE" + }, + { + "const": "CANCELED" + }, + { + "const": "PARTIAL_CANCELED" + }, + { + "const": "ABORTED" + }, + { + "const": "EXPIRED" + } + ], + "description": "Payment status. - READY - IN_PROGRESS - WAITING_FOR_DEPOSIT - DONE - CANCELED - PARTIAL_CANCELED - ABORTED - EXPIRED", + "x-typia-required": true, + "x-typia-optional": false + }, + "mId": { + "description": "Merchant ID. Currently tosspayments is used..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "version": { + "description": "The version of Toss Payments API you are using.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "paymentKey": { + "description": "Identifier number of payment details.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderId": { + "description": "Order identifier key. An identifier key managed by the service that uses it, not by Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "transactionKey": { + "description": "A unique key value for the transaction. Unlike {@link paymentKey }, this is not used..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "Order name. The order name issued by the service that uses it, not Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "currency": { + "description": "Currency unit. Currently, Toss Payments only accepts KRW..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "totalAmount": { + "description": "Total payment amount.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "balanceAmount": { + "description": "Amount that can be cancelled.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "suppliedAmount": { + "description": "Supply price.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxFreeAmount": { + "description": "Duty Free Amount.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vat": { + "description": "surtax.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "useEscrow": { + "description": "Whether to use escrow.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "cultureExpense": { + "description": "Whether you spend money on cultural expenses, such as a stone tablet, performance tickets, museum/art gallery admission tickets, etc..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "requestedAt": { + "description": "Payment request date and time.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + "approvedAt": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "description": "Payment approval date and time.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cancels": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/ITossPaymentCancel" + } + }, + { + "type": "null" + } + ], + "description": "Payment Cancellation History.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cashReceipt": { + "$ref": "#/components/schemas/ITossCashReceipt.ISummary.Nullable" + } + }, + "required": [ + "transfer", + "method", + "type", + "status", + "mId", + "version", + "paymentKey", + "orderId", + "transactionKey", + "orderName", + "currency", + "totalAmount", + "balanceAmount", + "suppliedAmount", + "taxFreeAmount", + "vat", + "useEscrow", + "cultureExpense", + "requestedAt", + "approvedAt", + "cancels", + "cashReceipt" + ], + "description": "Account transfer payment information.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossTransferPayment.ITransfer": { + "type": "object", + "properties": { + "bank": { + "description": "Bank name.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "settlementStatus": { + "oneOf": [ + { + "const": "COMPLETED" + }, + { + "const": "INCOMPLETED" + } + ], + "description": "Transfer status.", + "x-typia-required": true, + "x-typia-optional": false + } + }, + "required": [ + "bank", + "settlementStatus" + ], + "description": "Account transfer information.", + "x-typia-jsDocTags": [] + }, + "ITossVirtualAccountPayment": { + "type": "object", + "properties": { + "secret": { + "description": "A value to verify the deposit callback sent when making a payment to a virtual account..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "virtualAccount": { + "$ref": "#/components/schemas/ITossVirtualAccountPayment.IVirtualAccount" + }, + "method": { + "const": "๊ฐ€์ƒ๊ณ„์ขŒ", + "description": "payment method.", + "x-typia-required": true, + "x-typia-optional": false + }, + "type": { + "const": "NORMAL", + "description": "Payment Type. - NORMAL: General payment - BILLING: Easy payment using a pre-registered card.", + "x-typia-required": true, + "x-typia-optional": false + }, + "status": { + "oneOf": [ + { + "const": "READY" + }, + { + "const": "IN_PROGRESS" + }, + { + "const": "WAITING_FOR_DEPOSIT" + }, + { + "const": "DONE" + }, + { + "const": "CANCELED" + }, + { + "const": "PARTIAL_CANCELED" + }, + { + "const": "ABORTED" + }, + { + "const": "EXPIRED" + } + ], + "description": "Payment status. - READY - IN_PROGRESS - WAITING_FOR_DEPOSIT - DONE - CANCELED - PARTIAL_CANCELED - ABORTED - EXPIRED", + "x-typia-required": true, + "x-typia-optional": false + }, + "mId": { + "description": "Merchant ID. Currently tosspayments is used..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "version": { + "description": "The version of Toss Payments API you are using.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "paymentKey": { + "description": "Identifier number of payment details.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderId": { + "description": "Order identifier key. An identifier key managed by the service that uses it, not by Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "transactionKey": { + "description": "A unique key value for the transaction. Unlike {@link paymentKey }, this is not used..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "Order name. The order name issued by the service that uses it, not Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "currency": { + "description": "Currency unit. Currently, Toss Payments only accepts KRW..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "totalAmount": { + "description": "Total payment amount.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "balanceAmount": { + "description": "Amount that can be cancelled.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "suppliedAmount": { + "description": "Supply price.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxFreeAmount": { + "description": "Duty Free Amount.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vat": { + "description": "surtax.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "useEscrow": { + "description": "Whether to use escrow.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "cultureExpense": { + "description": "Whether you spend money on cultural expenses, such as a stone tablet, performance tickets, museum/art gallery admission tickets, etc..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "requestedAt": { + "description": "Payment request date and time.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + "approvedAt": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "description": "Payment approval date and time.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cancels": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/ITossPaymentCancel" + } + }, + { + "type": "null" + } + ], + "description": "Payment Cancellation History.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cashReceipt": { + "$ref": "#/components/schemas/ITossCashReceipt.ISummary.Nullable" + } + }, + "required": [ + "secret", + "virtualAccount", + "method", + "type", + "status", + "mId", + "version", + "paymentKey", + "orderId", + "transactionKey", + "orderName", + "currency", + "totalAmount", + "balanceAmount", + "suppliedAmount", + "taxFreeAmount", + "vat", + "useEscrow", + "cultureExpense", + "requestedAt", + "approvedAt", + "cancels", + "cashReceipt" + ], + "description": "Virtual Account Payment Information.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossVirtualAccountPayment.IVirtualAccount": { + "type": "object", + "properties": { + "accountNumber": { + "description": "account number.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "accountType": { + "oneOf": [ + { + "const": "์ผ๋ฐ˜" + }, + { + "const": "๊ณ ์ •" + } + ], + "description": "Virtual account type.", + "x-typia-required": true, + "x-typia-optional": false + }, + "bank": { + "description": "Bank name.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "customerName": { + "description": "Customer Name.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "dueDate": { + "description": "Deposit deadline.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date" + }, + "expired": { + "description": "Whether the virtual account has expired.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "settlementStatus": { + "oneOf": [ + { + "const": "COMPLETED" + }, + { + "const": "INCOMPLETED" + } + ], + "description": "Settlement status.", + "x-typia-required": true, + "x-typia-optional": false + }, + "refundStatus": { + "oneOf": [ + { + "const": "COMPLETED" + }, + { + "const": "NONE" + }, + { + "const": "FAILED" + }, + { + "const": "PENDING" + }, + { + "const": "PARTIAL_FAILED" + } + ], + "description": "Refund processing status. - NONE: Not applicable - FAILED: Refund failed - PENDING: Refund processing in progress - PARTIAL_FAILED: Partial refund failed - COMPLETED: Refund completed", + "x-typia-required": true, + "x-typia-optional": false + } + }, + "required": [ + "accountNumber", + "accountType", + "bank", + "customerName", + "dueDate", + "expired", + "settlementStatus", + "refundStatus" + ], + "description": "Virtual account information.", + "x-typia-jsDocTags": [] + }, + "ITossCashReceipt.IStore": { + "type": "object", + "properties": { + "type": { + "oneOf": [ + { + "const": "์†Œ๋“๊ณต์ œ" + }, + { + "const": "์ง€์ถœ์ฆ๋น™" + } + ], + "description": "Types of Cash Receipts.", + "x-typia-required": true, + "x-typia-optional": false + }, + "paymentKey": { + "description": "{@link ITossPayment.paymentKey } for the attributed payment.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderId": { + "description": "Order identifier ID.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "Order name.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "registrationNumber": { + "description": "Personal identification number for issuing cash receipts. Depending on the type of cash receipt, you can enter your mobile phone number, resident registration number, business registration number, or card number..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "Amount for which a cash receipt will be issued.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxFreeAmount": { + "description": "Tax-free amount.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "businessNumber": { + "description": "Business registration number.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + } + }, + "required": [ + "type", + "paymentKey", + "orderId", + "orderName", + "registrationNumber", + "amount" + ], + "description": "Cash receipt entry information.", + "x-typia-jsDocTags": [] + }, + "ITossCashReceipt": { + "type": "object", + "properties": { + "receiptKey": { + "description": "Identifier key of cash receipt.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/ITossCashReceipt.Type" + }, + "orderId": { + "description": "Order identifier ID.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "Order name.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "approvalNumber": { + "description": "Cash Receipt Authorization Number.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "approvedAt": { + "description": "Cash receipt approval date and time.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + "canceledAt": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "description": "Cash receipt cancellation date.", + "x-typia-required": true, + "x-typia-optional": false + }, + "receiptUrl": { + "description": "Receipt URL.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "receiptKey", + "type", + "orderId", + "orderName", + "approvalNumber", + "approvedAt", + "canceledAt", + "receiptUrl" + ], + "description": "Cash Receipt Information.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossCashReceipt.ICancel": { + "type": "object", + "properties": { + "amount": { + "description": "Cancellation amount. If not entered, {@link ITossCashReceipt.amount total amount} written on the cash receipt will be cancelled..", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + } + }, + "description": "Cash Receipt Cancellation Input Information.", + "x-typia-jsDocTags": [] + }, + "ITossPaymentWebhook": { + "type": "object", + "properties": { + "eventType": { + "const": "PAYMENT_STATUS_CHANGED", + "description": "Event Type.", + "x-typia-required": true, + "x-typia-optional": false + }, + "data": { + "$ref": "#/components/schemas/ITossPaymentWebhook.IData" + } + }, + "required": [ + "eventType", + "data" + ], + "description": "Webhook event information.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossPaymentWebhook.IData": { + "type": "object", + "properties": { + "paymentKey": { + "description": "Identifier key of {@link ITossPayment }.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderId": { + "description": "Order identifier key. An identifier key managed by the service that uses it, not by Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "status": { + "oneOf": [ + { + "const": "WAITING_FOR_DEPOSIT" + }, + { + "const": "DONE" + }, + { + "const": "CANCELED" + }, + { + "const": "PARTIAL_CANCELED" + } + ], + "description": "Payment status. - DONE: Payment completed - CANCELED: Payment canceled - PARTIAL_CANCELED: Payment partially canceled - WAITING_FOR_DEPOSIT: Waiting for deposit", + "x-typia-required": true, + "x-typia-optional": false + } + }, + "required": [ + "paymentKey", + "orderId", + "status" + ], + "description": "Webhook event data.", + "x-typia-jsDocTags": [] + }, + "ITossCardPayment.IStore": { + "type": "object", + "properties": { + "method": { + "const": "card", + "description": "Indicates that the payment method is a credit card.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cardNumber": { + "description": "Card number.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "[0-9]{16}" + }, + "cardExpirationYear": { + "description": "Card expiration year (2 digits).", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "\\d{2}" + }, + "cardExpirationMonth": { + "description": "Card expiration month (2 digits).", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^(0[1-9]|1[012])$" + }, + "cardPassword": { + "description": "Card password.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "cardInstallmentPlan": { + "description": "Number of installment months.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "amount": { + "description": "Total amount paid.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxFreeAmount": { + "description": "Total amount of tax exemption.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "orderId": { + "description": "Order identifier key. An identifier key managed by the service that uses it, not by Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "Order name. The order name issued by the service that uses it, not Toss Payments..", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customerBirthday": { + "description": "Customer's date of birth. Format YYMMDD.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "pattern": "^([0-9]{2})(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$" + }, + "customerEmail": { + "description": "Customer's Email.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "format": "email" + }, + "vbv": { + "$ref": "#/components/schemas/__type.o1" + }, + "__approved": { + "description": "Payment approval status. This value is only used by the fake payments server `fake-toss-payments-server`, and is used when intentionally delaying payment approval. If this value is `false`, you can simulate a situation where the front application uses the payment window provided by Toss Payments to proceed with payment. Originally, Toss Payments Server does not accept payment as official payment until the backend separately processes {@link functional.payments.approve approval} when the front application directly requests payment using the payment window provided by Toss Payments without going through the backend server. On the other hand, when the backend server calls the Toss Payments Server API, Toss Payments approves it immediately, so this property is necessary to simulate a situation where separate approval processing is required in `fake-toss-payments-server`..", + "x-typia-required": false, + "x-typia-optional": true, + "type": "boolean" + } + }, + "required": [ + "method", + "cardNumber", + "cardExpirationYear", + "cardExpirationMonth", + "amount", + "orderId" + ], + "description": "Information on applying for payment using a credit card.", + "x-typia-jsDocTags": [] + }, + "__type.o1": { + "type": "object", + "properties": { + "cavv": { + "description": "Authentication values for 3D Secure authentication sessions.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "xid": { + "description": "Transaction ID.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "eci": { + "description": "Code value for 3DS authentication result.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "cavv", + "xid", + "eci" + ], + "x-typia-jsDocTags": [] + }, + "ITossPayment.IApproval": { + "type": "object", + "properties": { + "orderId": { + "description": "Order identifier key. An identifier key managed by the service that uses it, not by Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "Total payment amount.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + } + }, + "required": [ + "orderId", + "amount" + ], + "description": "Payment Authorization Information.", + "x-typia-jsDocTags": [] + }, + "ITossPaymentCancel.IStore": { + "type": "object", + "properties": { + "paymentKey": { + "description": "Identifier key of {@link ITossPayment }.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "cancelReason": { + "description": "Reason for cancellation.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "cancelAmount": { + "description": "Cancellation Total.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "refundReceiveAccount": { + "$ref": "#/components/schemas/__type.o2" + }, + "taxAmount": { + "description": "Taxable amount.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "taxFreeAmount": { + "description": "Tax-free processing amount.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "refundableAmount": { + "description": "Refundable balance after cancellation.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + } + }, + "required": [ + "paymentKey", + "cancelReason" + ], + "description": "Payment Cancellation Request Information.", + "x-typia-jsDocTags": [] + }, + "__type.o2": { + "type": "object", + "properties": { + "bank": { + "description": "Bank information.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "accountNumber": { + "description": "account number.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^[0-9]{0,20}$" + }, + "holderName": { + "description": "Depositor.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "bank", + "accountNumber", + "holderName" + ], + "x-typia-jsDocTags": [] + }, + "ITossVirtualAccountPayment.IStore": { + "type": "object", + "properties": { + "method": { + "const": "virtual-account", + "description": "This means that the payment method is a virtual account..", + "x-typia-required": true, + "x-typia-optional": false + }, + "orderId": { + "description": "Order identifier number. An identifier key managed by the service that uses it, not by Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "Order name. The order name issued by the service that uses it, not Toss Payments..", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "bank": { + "description": "Bank name.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "customerName": { + "description": "Customer Name.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "Total payment amount.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "__approved": { + "description": "Payment approval status. This value is only used by the fake payments server `fake-toss-payments-server`, and is used when intentionally delaying payment approval. If this value is `false`, you can simulate a situation where the front application uses the payment window provided by Toss Payments to proceed with payment. Originally, Toss Payments Server does not accept payment as official payment until the backend separately processes {@link functional.payments.approve approval} when the front application directly requests payment using the payment window provided by Toss Payments without going through the backend server. On the other hand, when the backend server calls the Toss Payments Server API, Toss Payments approves it immediately, so this property is necessary to simulate a situation where separate approval processing is required in `fake-toss-payments-server`..", + "x-typia-required": false, + "x-typia-optional": true, + "type": "boolean" + } + }, + "required": [ + "method", + "orderId", + "orderName", + "bank", + "customerName", + "amount" + ], + "description": "Payment application information using a virtual account.", + "x-typia-jsDocTags": [] + } + }, + "securitySchemes": { + "basic": { + "type": "apiKey", + "name": "Authorization", + "in": "header" + } + } + }, + "x-samchon-emended": true +} \ No newline at end of file diff --git a/assets/output/toss.swagger.ja.json b/assets/output/toss.swagger.ja.json new file mode 100644 index 0000000..fa19f2d --- /dev/null +++ b/assets/output/toss.swagger.ja.json @@ -0,0 +1,3641 @@ +{ + "openapi": "3.1.0", + "servers": [ + { + "url": "http://localhost:30771", + "description": "fake" + }, + { + "url": "https://api.tosspayments.com", + "description": "real" + } + ], + "info": { + "title": "Toss Payments API", + "description": "Built by [fake-toss-payments-server](https://github.com/samchon/fake-toss-payments-server) with [nestia](https://github.com/samchon/nestia)", + "version": "2.0.0", + "license": { + "name": "MIT" + } + }, + "paths": { + "/v1/billing/authorizations/card": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "็ฐกๅ˜ๆฑบๆธˆใ‚ซใƒผใƒ‰ใฎใƒ—ใƒญใƒ‘ใƒ†ใ‚ฃ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossBilling.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "็ฐกๅ˜ๆฑบๆธˆใ‚ซใƒผใƒ‰ๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossBilling" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "็ฐกๅ˜ๆฑบๆธˆใ‚ซใƒผใƒ‰ใ‚’็™ป้Œฒใ™ใ‚‹", + "description": "็ฐกๅ˜ๆฑบๆธˆใ‚ซใƒผใƒ‰ใ‚’็™ป้Œฒใ™ใ‚‹ใ€‚ `billing.authorizations.card.store`ใฏใ€้กงๅฎขใŒ่‡ชๅˆ†ใฎๆ–ฐ็€ใ‚ซใƒผใƒ‰ใ‚’ใ‚ตใƒผใƒใƒผใซ็™ป้Œฒใ—ใฆใŠใใ€ๆฏŽๅ›žๆฑบๆธˆใŒๅฟ…่ฆใชใจใใฏใ„ใคใงใ‚‚ใ‚ซใƒผใƒ‰ๆƒ…ๅ ฑใ‚’็นฐใ‚Š่ฟ”ใ—ๅ…ฅๅŠ›ใ™ใ‚‹ใ“ใจใชใ็ฐกๅ˜ใซๆฑบๆธˆใ‚’้€ฒใ‚ใŸใ„ใจใใซๅ‘ผใณๅ‡บใ•ใ‚Œใ‚‹API้–ขๆ•ฐใงใ™ใ€‚ใกใชใฟใซใ€ `billing.authorizations.card.store` ใฏใ€ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚ขใƒ—ใƒชใ‚ฑใƒผใ‚ทใƒงใƒณใŒใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใŒๆไพ›ใ™ใ‚‹็ฐกๆ˜“ๆฑบๆธˆใ‚ซใƒผใƒ‰็™ป้Œฒใ‚ฆใ‚ฃใƒณใƒ‰ใ‚ฆใ‚’ไฝฟ็”จใ™ใ‚‹ๅ ดๅˆใ€ใ‚ใชใŸใฎใƒใƒƒใ‚ฏใ‚จใƒณใƒ‰ใ‚ตใƒผใƒใŒใ“ใ‚Œใ‚’ๅฎŸใ‚ตใƒผใƒ“ใ‚นใ‹ใ‚‰ๅ‘ผใณๅ‡บใ™ใ“ใจใฏใชใ„ใ ใ‚ใ†ใ€‚ใŸใ ใ—ใ€้กงๅฎขใŒๅฎนๆ˜“ใชๆ”ฏๆ‰•ใ„ใ‚ซใƒผใƒ‰ใ‚’็™ป้Œฒใ™ใ‚‹็Šถๆณใ‚’ใ‚ทใƒŸใƒฅใƒฌใƒผใƒˆใ™ใ‚‹ใŸใ‚ใซใ€ใƒ†ใ‚นใƒˆ่‡ชๅ‹•ๅŒ–ใƒ—ใƒญใ‚ฐใƒฉใƒ ใฎใƒฌใƒ™ใƒซใงไฝฟ็”จใ™ใ‚‹ใ“ใจใŒใงใใ‚‹.", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.billing.authorizations.card.store", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ๋“ฑ๋ก ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์นด๋“œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/v1/billing/authorizations/{billingKey}": { + "post": { + "tags": [], + "parameters": [ + { + "name": "billingKey", + "in": "path", + "schema": { + "type": "string" + }, + "description": "ๅฏพ่ฑกๆƒ…ๅ ฑใฎ", + "required": true + } + ], + "requestBody": { + "description": "้กงๅฎข่ญ˜ๅˆฅๅญใ‚ญใƒผ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossBilling.ICustomerKey" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "็ฐกๅ˜ๆฑบๆธˆๆ‰‹ๆฎตๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossBilling" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "็ฐกๅ˜ๆฑบๆธˆใง็™ป้Œฒใ—ใŸๆ‰‹ๆฎตใ‚’่ฆ‹ใ‚‹", + "description": "็ฐกๅ˜ๆฑบๆธˆใง็™ป้Œฒใ—ใŸๆ‰‹ๆฎตใ‚’่ฆ‹ใ‚‹ใ€‚ `billing.authorizations.at`ใฏใ€้กงๅฎขใŒ็ฐกๅ˜ใซๆ”ฏๆ‰•ใ†ใŸใ‚ใซใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใ‚ตใƒผใƒใƒผใซ็™ป้Œฒใ—ใŸๆ”ฏๆ‰•ใ„ๆ–นๆณ•ใ‚’็…งไผšใ™ใ‚‹้–ขๆ•ฐใงใ™ใ€‚ไธปใซใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚ขใƒ—ใƒชใ‚ฑใƒผใ‚ทใƒงใƒณใŒใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใŒ็‹ฌ่‡ชใซๆไพ›ใ™ใ‚‹ๆฑบๆธˆใ‚ฆใ‚ฃใƒณใƒ‰ใ‚ฆใ‚’ไฝฟ็”จใ™ใ‚‹ๅ ดๅˆใ€ๅพ“ใฃใฆใƒ•ใƒญใƒณใƒˆใ‚ขใƒ—ใƒชใ‚ฑใƒผใ‚ทใƒงใƒณใŒใ‚ใชใŸใฎใƒใƒƒใ‚ฏใ‚จใƒณใƒ‰ใ‚ตใƒผใƒใซ `billingKey` ใจ ` customerKey` ใ ใ‘ใ‚’ๆธกใ—ใ€่ฉณ็ดฐใช็ฐกๆ˜“ๆฑบๆธˆๆ‰‹ๆฎตๆƒ…ๅ ฑใŒๅฟ…่ฆใชใจใใซไฝฟ็”จใ™ใ‚‹.", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.billing.authorizations.at", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "billingKey", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋Œ€์ƒ ์ •๋ณด์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "ITossBilling.billingKey", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-toss-payments-server/src/api/structures/ITossBilling.ts", + "textSpan": { + "start": 500, + "length": 19 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ณ ๊ฐ ์‹๋ณ„์ž ํ‚ค", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฐ„ํŽธ ๊ฒฐ์ œ ์ˆ˜๋‹จ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/v1/billing/{billingKey}": { + "post": { + "tags": [], + "parameters": [ + { + "name": "billingKey", + "in": "path", + "schema": { + "type": "string" + }, + "description": "็ฐกๅ˜ๆฑบๆธˆใซ็™ป้Œฒใ—ใŸๆ‰‹ๆฎตใฎ", + "required": true + } + ], + "requestBody": { + "description": "ๆณจๆ–‡ๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossBilling.IPaymentStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ใŠๆ”ฏๆ‰•ใ„ๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossPayment" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "็ฐกๅ˜ๆฑบๆธˆใซ็™ป้Œฒใ—ใŸๆ‰‹ๆฎตใงๆฑบๆธˆใ™ใ‚‹", + "description": "็ฐกๅ˜ๆฑบๆธˆใซ็™ป้Œฒใ—ใŸๆ‰‹ๆฎตใงๆฑบๆธˆใ™ใ‚‹ใ€‚ `billing.pay`ใฏใ€็ฐกๅ˜ใชๆ”ฏๆ‰•ใ„ใซ็™ป้Œฒใ—ใŸๆ‰‹ๆฎตใงๆ”ฏๆ‰•ใ„ใ‚’้€ฒใ‚ใŸใ„ใจใใซๅ‘ผใณๅ‡บใ™API้–ขๆ•ฐใงใ™ใ€‚ใใ—ใฆ `billing.pay` ใฏๆฑบๆธˆๆ‰‹ๆฎตใฎไธญใงๅ”ฏไธ€ใ€ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚ขใƒ—ใƒชใ‚ฑใƒผใ‚ทใƒงใƒณใŒใƒˆใƒผใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใŒๆไพ›ใ™ใ‚‹ๆฑบๆธˆใ‚ฆใ‚ฃใƒณใƒ‰ใ‚ฆใ‚’ไฝฟ็”จใงใใšใ€ใ‚ใชใŸใฎใƒใƒƒใ‚ฏใ‚จใƒณใƒ‰ใ‚ตใƒผใƒใŒใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใฎ API ้–ขๆ•ฐใ‚’็›ดๆŽฅๅ‘ผใณๅ‡บใ™ๅฟ…่ฆใŒใ‚ใ‚‹ๅ ดๅˆใซ่ฉฒๅฝ“ใ™ใ‚‹ใ€‚ใ—ใŸใŒใฃใฆใ€็ฐกๆ˜“ๆฑบๆธˆใซ้–ขใ—ใฆใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใจ้€ฃๅ‹•ใ™ใ‚‹ใƒใƒƒใ‚ฏใ‚จใƒณใƒ‰ใ‚ตใƒผใƒใŠใ‚ˆใณใƒ•ใƒญใƒณใƒˆใ‚ขใƒ—ใƒชใ‚ฑใƒผใ‚ทใƒงใƒณใ‚’้–‹็™บใ™ใ‚‹้š›ใซใฏใ€ๅฟ…ใšใ“ใฎ็Šถๆณใซๅฏพใ™ใ‚‹ๅˆฅ้€”ใฎ่จญ่จˆใŠใ‚ˆใณ้–‹็™บใŒๅฟ…่ฆใจใชใ‚‹ใฎใงใ€ใ“ใฎ็‚นใ‚’ๅฟต้ ญใซ็ฝฎใ„ใฆใŠใใŸใ„ใ€‚ใ•ใ‚‰ใซใ€ `billing.pay` ใฏๅพนๅบ•็š„ใซใ‚ใชใŸใฎใƒใƒƒใ‚ฏใ‚จใƒณใƒ‰ใ‚ตใƒผใƒใƒผใฎๅˆคๆ–ญใฎไธ‹ใงๅ‘ผใณๅ‡บใ•ใ‚Œใ‚‹API้–ขๆ•ฐใชใฎใงใ€ใใ‚Œใ‚’ไป‹ใ—ใฆ่กŒใ‚ใ‚Œใ‚‹ๆ”ฏๆ‰•ใ„ใฏไธ€ๅˆ‡{@link payments.approve}ใ‚’ๅฟ…่ฆใจใ—ใพใ›ใ‚“ใ€‚ใŸใ ใ—ใ€ `billing.pay` ใฏใ“ใฎใ‚ˆใ†ใซๅ‰ฏๆฌก็š„ใชๆ‰ฟ่ช้Ž็จ‹ใ‚’ๅฟ…่ฆใจใ›ใšใ€ใใฎ็›ดใกใซๆฑบๆธˆใŒๅฎŒไบ†ใ™ใ‚‹ใฎใงใ€ใ“ใ‚Œใ‚’ๅ‘ผใณๅ‡บใ™็Šถๆณใซๆณจๆ„ๆทฑใๆณจๆ„ใ‚’ๆ‰•ใ†ๅฟ…่ฆใŒใ‚ใ‚‹ใ€‚", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.billing.pay", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "billingKey", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฐ„ํŽธ ๊ฒฐ์ œ์— ๋“ฑ๋กํ•œ ์ˆ˜๋‹จ์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "ITossBilling.billingKey", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-toss-payments-server/src/api/structures/ITossBilling.ts", + "textSpan": { + "start": 500, + "length": 19 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์ฃผ๋ฌธ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/v1/cash-receipts": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "ๅ…ฅๅŠ›ๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossCashReceipt.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "็พ้‡‘้ ˜ๅŽๆ›ธๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossCashReceipt" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "็พ้‡‘้ ˜ๅŽๆ›ธใฎ็™บ่กŒ", + "description": "็พ้‡‘้ ˜ๅŽๆ›ธใฎ็™บ่กŒ.", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.cash-receipts.store", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/v1/cash-receipts/{receiptKey}/cancel": { + "post": { + "tags": [], + "parameters": [ + { + "name": "receiptKey", + "in": "path", + "schema": { + "type": "string" + }, + "description": "็พ้‡‘้ ˜ๅŽๆ›ธ", + "required": true + } + ], + "requestBody": { + "description": "ใ‚ญใƒฃใƒณใ‚ปใƒซๅ…ฅๅŠ›ๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossCashReceipt.ICancel" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ใ‚ญใƒฃใƒณใ‚ปใƒซใ•ใ‚ŒใŸ็พ้‡‘้ ˜ๅŽๆ›ธๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossCashReceipt" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "็พ้‡‘้ ˜ๅŽๆ›ธใ‚’ใ‚ญใƒฃใƒณใ‚ปใƒซใ™ใ‚‹", + "description": "็พ้‡‘้ ˜ๅŽๆ›ธใ‚’ใ‚ญใƒฃใƒณใ‚ปใƒซใ™ใ‚‹.", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.cash-receipts.cancel.cancel", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "receiptKey", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "ํ˜„๊ธˆ ์˜์ˆ˜์ฆ์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "ITossCashReceipt.receiptKey", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-toss-payments-server/src/api/structures/ITossCashReceipt.ts", + "textSpan": { + "start": 199, + "length": 19 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์ทจ์†Œ ์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์ทจ์†Œ๋œ ํ˜„๊ธˆ ์˜์ˆ˜์ฆ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/internal/webhook": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "Webใƒ•ใƒƒใ‚ฏใ‚คใƒ™ใƒณใƒˆๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossPaymentWebhook" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "", + "x-nestia-encrypted": false + } + }, + "summary": "Webใƒ•ใƒƒใ‚ฏใ‚คใƒ™ใƒณใƒˆใƒ€ใƒŸใƒผใƒชใ‚นใƒŠใƒผ", + "description": "Webใƒ•ใƒƒใ‚ฏใ‚คใƒ™ใƒณใƒˆใƒ€ใƒŸใƒผใƒชใ‚นใƒŠใƒผใ€‚ `internal.webhook` ใฏๅฎŸ้š›ใฎใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใฎๆฑบๆธˆใ‚ตใƒผใƒใซใฏๅญ˜ๅœจใ—ใชใ„ API ใงใ€ `fake-toss-payments-server` ใฎ {@link Configuration.WEBHOOK_URL } ใซไฝ•ใ‚‚ URL ใ‚’่จญๅฎšใ—ใชใ„ใจใ€ `fake-toss- payments-server` ใ‹ใ‚‰็™บ็”Ÿใ™ใ‚‹ใ‚ใ‚‰ใ‚†ใ‚‹็จฎ้กžใฎ Webhook ใ‚คใƒ™ใƒณใƒˆใฏใ“ใ“ใซ้€ใ‚‰ใ‚Œใ€็„กๆ„ๅ‘ณใซๆถˆใˆใ‚‹ใ€‚ใ—ใŸใŒใฃใฆใ€ `fake-toss-payments-server` ใ‚’ไฝฟใฃใฆใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใ‚ตใƒผใƒใƒผใจใฎ้€ฃๅ‹•ใ‚’ไบ‹ๅ‰ๆคœ่จผใ‚ณใ‚ถใ™ใ‚‹ใจใใฏใ€ๅฟ…ใš{@link Configuration.WEBHOOK_URL } ใ‚’่จญๅฎšใ—ใฆWebใƒ•ใƒƒใ‚ฏใ‚คใƒ™ใƒณใƒˆใŒใ‚ใชใŸใฎใƒใƒƒใ‚ฏใ‚จใƒณใƒ‰ใ‚ตใƒผใƒใƒผใซๆญฃใ—ใ้…ไฟกใ•ใ‚Œใ‚‹ใ‚ˆใ†ใซใ—ใ‚ˆใ†.", + "x-nestia-namespace": "internal.webhook.webhook", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์›นํ›… ์ด๋ฒคํŠธ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/internal/{paymentKey}/deposit": { + "get": { + "tags": [], + "parameters": [ + { + "name": "paymentKey", + "in": "path", + "schema": { + "type": "string" + }, + "description": "ๅฏพ่ฑกไปฎๆƒณๅฃๅบงๆฑบๆธˆๆƒ…ๅ ฑใฎ", + "required": true + } + ], + "responses": { + "200": { + "description": "ๅ…ฅ้‡‘ๅฎŒไบ†ใ—ใŸไปฎๆƒณๅฃๅบงๆฑบๆธˆๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossPayment" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ไปฎๆƒณใ‚ขใ‚ซใ‚ฆใƒณใƒˆใซๅ…ฅ้‡‘ใ™ใ‚‹", + "description": "ไปฎๆƒณๅฃๅบงใซๅ…ฅ้‡‘ใ™ใ‚‹ใ€‚ `internal.virtual_accounts.deposit` ใฏๅฎŸ้š›ใฎใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใฎๆฑบๆธˆใ‚ตใƒผใƒใซใฏๅญ˜ๅœจใ—ใชใ„APIใงใ€ไปฎๆƒณๅฃๅบงๆฑบๆธˆใ‚’็”ณ่ซ‹ใ—ใŸ้กงๅฎขใŒใ€ใใฎๅพŒไปฎๆƒณๅฃๅบงใซ็›ฎๆจ™้‡‘้กใ‚’ๅ…ฅ้‡‘ใ™ใ‚‹็Šถๆณใ‚’ใ‚ทใƒŸใƒฅใƒฌใƒผใƒˆใงใใ‚‹้–ขๆ•ฐใงใ‚ใ‚‹ใ€‚ใคใพใ‚Š `internal.virtual_accounts.deposit` ใฏ้กงๅฎขใŒ่‡ชใ‚‰ใซไปฎๆƒณ็š„ใซ็™บ่กŒใ•ใ‚ŒใŸๅฃๅบงใซๅ…ฅ้‡‘ใ‚’่กŒใ„ใ€ใใ‚Œใซๅฟœใ˜ใฆใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใ‚ตใƒผใƒใƒผใง webhook ใ‚คใƒ™ใƒณใƒˆใŒ็™บ็”Ÿใ—ใฆใ“ใ‚Œใ‚’ใ‚ใชใŸใฎใƒใƒƒใ‚ฏใ‚จใƒณใƒ‰ใ‚ตใƒผใƒใƒผใซ่ปข้€ใ™ใ‚‹ไธ€้€ฃใฎ็Šถๆณใ‚’ใƒ†ใ‚นใƒˆใ™ใ‚‹ใŸใ‚ใฎ้–ขๆ•ฐใงใ™ใ€‚.", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "internal.deposit.deposit", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "paymentKey", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋Œ€์ƒ ๊ฐ€์ƒ ๊ณ„์ขŒ ๊ฒฐ์ œ ์ •๋ณด์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "ITossPayment.paymentKey", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-toss-payments-server/src/api/structures/ITossPayment.ts", + "textSpan": { + "start": 2480, + "length": 19 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์ž…๊ธˆ ์™„๋ฃŒ๋œ ๊ฐ€์ƒ ๊ผ์ขŒ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "GET" + } + }, + "/v1/payments/{paymentKey}": { + "get": { + "tags": [], + "parameters": [ + { + "name": "paymentKey", + "in": "path", + "schema": { + "type": "string" + }, + "description": "ใŠๆ”ฏๆ‰•ใ„ๆƒ…ๅ ฑใฎ", + "required": true + } + ], + "responses": { + "200": { + "description": "ใŠๆ”ฏๆ‰•ใ„ๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossPayment" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ใŠๆ”ฏๆ‰•ใ„ๆƒ…ๅ ฑใ‚’่ฆ‹ใ‚‹", + "description": "ใŠๆ”ฏๆ‰•ใ„ๆƒ…ๅ ฑใ‚’็ขบ่ชใ—ใฆใใ ใ•ใ„ใ€‚ `payments.at`ใฏๆ”ฏๆ‰•ใ„ๆƒ…ๅ ฑใ‚’็…งไผšใ™ใ‚‹้–ขๆ•ฐใงใ™ใ€‚ไธปใซใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚ขใƒ—ใƒชใ‚ฑใƒผใ‚ทใƒงใƒณใŒใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒˆใŒ็‹ฌ่‡ชใซๆไพ›ใ™ใ‚‹ๆฑบๆธˆใ‚ฆใ‚ฃใƒณใƒ‰ใ‚ฆใ‚’ไฝฟ็”จใ™ใ‚‹ๅ ดๅˆใ€ๅพ“ใฃใฆใƒ•ใƒญใƒณใƒˆใ‚ขใƒ—ใƒชใ‚ฑใƒผใ‚ทใƒงใƒณใŒใ‚ใชใŸใฎใƒใƒƒใ‚ฏใ‚จใƒณใƒ‰ใ‚ตใƒผใƒใซ `paymentKey' ใชใฉใ”ใไธ€้ƒจใฎ่ญ˜ๅˆฅๅญๆƒ…ๅ ฑใ ใ‘ใ‚’ๆธกใ—ใฆใใ‚Œใ€่ฉณ็ดฐๆฑบๆธˆๆƒ…ๅ ฑใŒๅฟ…่ฆใชใจใใซไฝฟ็”จใ™ใ‚‹ใ€‚ใกใชใฟใซใ€ใƒˆใ‚นใƒšใ‚คใƒกใƒณใƒˆใฏไป–ใฎๆฑบๆธˆPG็คพใจใฏ็•ฐใชใ‚Šใ€ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚ขใƒ—ใƒชใ‚ฑใƒผใ‚ทใƒงใƒณใงใƒˆใ‚นใƒšใ‚คใƒกใƒณใƒˆใฎๆฑบๆธˆใ‚ฆใ‚ฃใƒณใƒ‰ใ‚ฆใ‚’ๅˆฉ็”จใ—ใฆ้€ฒ่กŒใ—ใŸๆฑบๆธˆใŒใ™ใใซ็ขบๅฎšใ•ใ‚Œใ‚‹ใ‚ใ‘ใงใฏใชใ„ใ€‚่ฒด็คพใฎใƒใƒƒใ‚ฏใ‚จใƒณใƒ‰ใ‚ตใƒผใƒใƒผใŒ็พๅœจใฎ `payments.at` ใ‚’้€šใ˜ใฆ่ฉฒๅฝ“ใฎๆฑบๆธˆๆƒ…ๅ ฑใ‚’็ขบ่ชใ—ใ€{@link approve } ใ‚’ๅ‘ผใณๅ‡บใ—ใฆ็›ดๆŽฅๆ‰ฟ่ชใ™ใ‚‹ใพใงใ€ๅฝ“่ฉฒๆฑบๆธˆใฏ็ขบๅฎšใ•ใ‚Œใชใ„ใฎใงใ€ใ“ใฎ็‚นใซ็•™ๆ„ใ—ใฆใใ ใ•ใ„ใ€‚.", + "x-nestia-namespace": "v1.payments.at", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "paymentKey", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฒฐ์ œ ์ •๋ณด์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "ITossPayment.paymentKey", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-toss-payments-server/src/api/structures/ITossPayment.ts", + "textSpan": { + "start": 2480, + "length": 19 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "GET" + }, + "post": { + "tags": [], + "parameters": [ + { + "name": "paymentKey", + "in": "path", + "schema": { + "type": "string" + }, + "description": "ๅฏพ่ฑกๆฑบๆธˆ", + "required": true + } + ], + "requestBody": { + "description": "ๆณจๆ–‡ๆƒ…ๅ ฑใฎ็ขบ่ช", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossPayment.IApproval" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ๆ‰ฟ่ชใ•ใ‚ŒใŸใŠๆ”ฏๆ‰•ใ„ๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossPayment" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ใŠๆ”ฏๆ‰•ใ„ใ‚’ๆ‰ฟ่ชใ™ใ‚‹", + "description": "ๆ”ฏๆ‰•ใ„ใ‚’ๆ‰ฟ่ชใ™ใ‚‹ใ€‚ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใฏใ€่ฒด็คพใฎใƒใƒƒใ‚ฏใ‚จใƒณใƒ‰ใง่กŒใ‚ใ‚ŒใŸๆฑบๆธˆใงใฏใชใใ€ใƒ•ใƒญใƒณใƒˆใ‚ขใƒ—ใƒชใ‚ฑใƒผใ‚ทใƒงใƒณใฎๆฑบๆธˆใ‚ฆใ‚ฃใƒณใƒ‰ใ‚ฆใง่กŒใ‚ใ‚Œใ‚‹ๆฑบๆธˆใฎๅ ดๅˆใ€่ฉฒๅฝ“ใ‚ตใƒผใƒ“ใ‚นใŒใƒใƒƒใ‚ฏใ‚จใƒณใƒ‰ใ‚ตใƒผใƒใƒผใ‹ใ‚‰ๆฑบๆธˆใ‚’ๆ‰ฟ่ชใ•ใ‚Œใ‚‹ใพใงใ€ใ“ใ‚Œใ‚’็ขบๅฎšใ—ใชใ„ใ€‚ `payments.approve` ใฏใพใ•ใซใ“ใฎใ‚ˆใ†ใช็Šถๆณใงใ€ใใฎๆฑบๆธˆใ‚’ๆ‰ฟ่ชใ™ใ‚‹้–ขๆ•ฐใงใ‚ใ‚‹ใ€‚ `fake-toss-payments-server`ใ‚’ไฝฟ็”จใ—ใฆๆ”ฏๆ‰•ใ„ใ‚’ใ‚ทใƒŸใƒฅใƒฌใƒผใƒˆใ™ใ‚‹ๅ ดๅˆใฏใ€ๆ”ฏๆ‰•ใ„้–ข้€ฃAPIใ‚’ๅ‘ผใณๅ‡บใ™ใจใใซ{@link ITossCardPayment.IStore.__approved}ใ‹ใ‚‰{@link ITossVirtualAccountPayment.IStore.__approved}ใ‚’false` ใซใ™ใ‚‹ใ“ใจใงใ€ๅˆฅ้€”ๆ‰ฟ่ชใŒๅฟ…่ฆใชใ“ใฎใ‚ˆใ†ใช็Šถๆณใ‚’ใ‚ทใƒŸใƒฅใƒฌใƒผใƒˆใงใใพใ™ใ€‚.", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.payments.approve", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "paymentKey", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๋Œ€์ƒ ๊ฒฐ์ œ์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "ITossPayment.paymentKey", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-toss-payments-server/src/api/structures/ITossPayment.ts", + "textSpan": { + "start": 2480, + "length": 19 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์ฃผ๋ฌธ ์ •๋ณด ํ™•์ธ", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์Šน์ธ๋œ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/v1/payments/key-in": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "ใ‚ซใƒผใƒ‰ๆฑบๆธˆๅ…ฅๅŠ›ๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossCardPayment.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ใ‚ซใƒผใƒ‰ๆฑบๆธˆๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossCardPayment" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ใ‚ซใƒผใƒ‰ใงใŠๆ”ฏๆ‰•ใ„", + "description": "ใ‚ซใƒผใƒ‰ใงใŠๆ”ฏๆ‰•ใ„ใใ ใ•ใ„ใ€‚ `payments.key_in`ใฏใ€ใ‚ซใƒผใƒ‰ใ‚’ไฝฟใฃใฆๆ”ฏๆ‰•ใ„ใ‚’ใ™ใ‚‹ใจใใซๅ‘ผใณๅ‡บใ•ใ‚Œใ‚‹API้–ขๆ•ฐใงใ™ใ€‚ใกใชใฟใซใ€ `payments.key_in` ใฏใ€ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚ขใƒ—ใƒชใ‚ฑใƒผใ‚ทใƒงใƒณใŒใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใŒ็‹ฌ่‡ชใซๆไพ›ใ™ใ‚‹ๆฑบๆธˆใ‚ฆใ‚ฃใƒณใƒ‰ใ‚ฆใ‚’ไฝฟ็”จใ™ใ‚‹ๅ ดๅˆใ€ใ‚ใชใŸใฎใƒใƒƒใ‚ฏใ‚จใƒณใƒ‰ใ‚ตใƒผใƒใƒผใŒใใ‚Œใ‚’ๅฎŸใ‚ตใƒผใƒ“ใ‚นใ‹ใ‚‰ๅ‘ผใณๅ‡บใ™ใ“ใจใฏใชใ„ใงใ—ใ‚‡ใ†ใ€‚ใŸใ ใ—ใ€้กงๅฎขใŒใ‚ซใƒผใƒ‰ใ‚’้€šใ—ใฆๆ”ฏๆ‰•ใ†็Šถๆณใ‚’ใ‚ทใƒŸใƒฅใƒฌใƒผใƒˆใ™ใ‚‹ใŸใ‚ใซใ€ใƒ†ใ‚นใƒˆ่‡ชๅ‹•ๅŒ–ใƒ—ใƒญใ‚ฐใƒฉใƒ ใƒฌใƒ™ใƒซใงไฝฟ็”จใ™ใ‚‹ใ“ใจใŒใงใใ‚‹ใ€‚ใใ—ใฆใ€ใ‚ใชใŸใฎใƒใƒƒใ‚ฏใ‚จใƒณใƒ‰ใ‚ตใƒผใƒใƒผใŒ `payments.key-in` ใ‚’็›ดๆŽฅๅ‘ผใณๅ‡บใ™ๅ ดๅˆใ€ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใ‚ตใƒผใƒใƒผใฏใใ‚Œใ‚’ๅฎŒๅ…จใซๆ‰ฟ่ชใ•ใ‚ŒใŸๆ”ฏๆ‰•ใ„ใจ่ฆ‹ใฆใ™ใใซ็ขบๅฎšใ—ใพใ™ใ€‚ใใฎใŸใ‚ `payments.key-in` ใ‚’็›ดๆŽฅๅ‘ผใณๅ‡บใ™ๅ ดๅˆใ€ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใฎๆฑบๆธˆใ‚ฆใ‚ฃใƒณใƒ‰ใ‚ฆใ‚’ๅˆฉ็”จใ—ใฆๅˆฅใฎ {@link approve } ใŒๅฟ…่ฆใชใจใใซๅ‚™ใˆใฆใ€ใฏใ‚‹ใ‹ใซ็ดฐๅฟƒใฎๆณจๆ„ใŒๆฑ‚ใ‚ใ‚‰ใ‚Œใ‚‹ใ€‚ใ•ใ‚‰ใซใ€ใŠๅฎขๆง˜ใฎใƒใƒƒใ‚ฏใ‚จใƒณใƒ‰ใ‚ตใƒผใƒใƒผใŒ `fake-toss-payments-server` ใ‚’ไฝฟ็”จใ—ใฆใŠๅฎขๆง˜ใฎใ‚ซใƒผใƒ‰ๆฑบๆธˆใ‚’ใ‚ทใƒŸใƒฅใƒฌใƒผใƒˆใ™ใ‚‹ๅ ดๅˆใ€{@link ITossCardPayment.IStore.__approved } ๅ€คใ‚’ `false` ใซใ—ใฆใ‚ซใƒผใƒ‰ๆฑบๆธˆใฎ็ขบๅฎšใ‚’ๆ„ๅ›ณ็š„ใซๅ›ž้ฟใงใใ‚‹ใ€‚ใ“ใ‚Œใซใ‚ˆใ‚Šใ€ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใฎๆฑบๆธˆใ‚ฆใ‚ฃใƒณใƒ‰ใ‚ฆใ‚’ๅˆฉ็”จใ—ใŸใ‚ซใƒผใƒ‰ๆฑบๆธˆใฎๅ ดๅˆใ€ๅˆฅ้€”{@link approve}ใŒๅฟ…่ฆใช็Šถๆณใ‚’ใ‚ทใƒŸใƒฅใƒฌใƒผใƒˆใ™ใ‚‹ใ“ใจใŒใงใใ‚‹ใ€‚.", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.payments.key-in.key_in", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์นด๋“œ ๊ฒฐ์ œ ์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์นด๋“œ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/v1/payments/{paymentKey}/cancel": { + "post": { + "tags": [], + "parameters": [ + { + "name": "paymentKey", + "in": "path", + "schema": { + "type": "string" + }, + "description": "ใŠๆ”ฏๆ‰•ใ„ๆƒ…ๅ ฑใฎ", + "required": true + } + ], + "requestBody": { + "description": "ใ‚ญใƒฃใƒณใ‚ปใƒซๅ…ฅๅŠ›ๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossPaymentCancel.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ใ‚ญใƒฃใƒณใ‚ปใƒซใ•ใ‚ŒใŸใŠๆ”ฏๆ‰•ใ„ๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossPayment" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ใŠๆ”ฏๆ‰•ใ„ใ‚’ใ‚ญใƒฃใƒณใ‚ปใƒซใ™ใ‚‹", + "description": "ใŠๆ”ฏๆ‰•ใ„ใ‚’ใ‚ญใƒฃใƒณใ‚ปใƒซใ—ใพใ™ใ€‚ `payments.cancel`ใฏๆฑบๆธˆใ‚’ใ‚ญใƒฃใƒณใ‚ปใƒซใ™ใ‚‹APIใงใ™ใ€‚ใŠๆ”ฏๆ‰•ใ„ใ‚ญใƒฃใƒณใ‚ปใƒซๅ…ฅๅŠ›ๆƒ…ๅ ฑ{@link ITossPaymentCancel.IStore}ใซใฏใ€ใ‚ญใƒฃใƒณใ‚ปใƒซ็†็”ฑใ‚’ใฏใ˜ใ‚ใ€ใŠๅฎขๆง˜ใซๆ‰•ใ„ๆˆปใ™้‡‘้กใจ็จŽ้‡‘ใ€ๅฟ…่ฆใซๅฟœใ˜ใฆๆ‰•ใ„ๆˆปใ—ๅฃๅบงๆƒ…ๅ ฑใชใฉใ‚’ๅ…ฅๅŠ›ใ™ใ‚‹ใ“ใจใซใชใฃใฆใ„ใพใ™ใ€‚.", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.payments.cancel.cancel", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "paymentKey", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฒฐ์ œ ์ •๋ณด์˜ ", + "kind": "text" + }, + { + "text": "{@link ", + "kind": "link" + }, + { + "text": "ITossPayment.paymentKey", + "kind": "linkName", + "target": { + "fileName": "C:/github/samchon/fake-toss-payments-server/src/api/structures/ITossPayment.ts", + "textSpan": { + "start": 2480, + "length": 19 + } + } + }, + { + "text": "}", + "kind": "link" + } + ] + }, + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "์ทจ์†Œ ์ž…๋ ฅ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "์ทจ์†Œ๋œ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + }, + "/v1/virtual-accounts": { + "post": { + "tags": [], + "parameters": [], + "requestBody": { + "description": "ไปฎๆƒณๆฑบๆธˆ็”ณ่ซ‹ๆƒ…ๅ ฑ.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossVirtualAccountPayment.IStore" + } + } + }, + "required": true, + "x-nestia-encrypted": false + }, + "responses": { + "201": { + "description": "ไปฎๆƒณใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎใŠๆ”ฏๆ‰•ใ„ๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ITossVirtualAccountPayment" + } + } + }, + "x-nestia-encrypted": false + } + }, + "summary": "ไปฎๆƒณๅฃๅบงใซใŠๆ”ฏๆ‰•ใ„ใ‚’็”ณ่ซ‹ใ™ใ‚‹", + "description": "ไปฎๆƒณๅฃๅบงใซใŠๆ”ฏๆ‰•ใ„ใ‚’็”ณใ—่พผใ‚€ใ€‚ `virtual_accounts.store`ใฏใ€้กงๅฎขใŒๆฑบๆธˆๆ‰‹ๆฎตใ‚’ไปฎๆƒณใ‚ขใ‚ซใ‚ฆใƒณใƒˆใจใ—ใฆ้ธๆŠžใ—ใŸใจใใซๅ‘ผใณๅ‡บใ•ใ‚Œใ‚‹API้–ขๆ•ฐใงใ™ใ€‚ใ‚‚ใกใ‚ใ‚“ใ€้กงๅฎขใŒใ“ใฎใ‚ˆใ†ใซไปฎๆƒณๅฃๅบงใ‚’้ธๆŠžใ—ใŸๅ ดๅˆใ€้กงๅฎขใŒๆŒ‡ๅฎšใ•ใ‚ŒใŸๅฃๅบงใซใŠ้‡‘ใ‚’ๅ…ฅ้‡‘ใ™ใ‚‹ใพใงใฏๆฑบๆธˆใŒ็ต‚ใ‚ใฃใŸใ‚ใ‘ใงใฏใชใ„ใฎใงใ€{@link ITossPayment.status}ใฎๅ€คใฏ `WAITING_FOR_DEPOSIT`ใซใชใ‚‹ใ€‚ใกใชใฟใซใ€ `virtual_accounts.store` ใฏใ€ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆใ‚ขใƒ—ใƒชใ‚ฑใƒผใ‚ทใƒงใƒณใŒใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใŒ็‹ฌ่‡ชใซๆไพ›ใ™ใ‚‹ๆฑบๆธˆใ‚ฆใ‚ฃใƒณใƒ‰ใ‚ฆใ‚’ไฝฟ็”จใ™ใ‚‹ๅ ดๅˆใ€ใ‚ใชใŸใฎใƒใƒƒใ‚ฏใ‚จใƒณใƒ‰ใ‚ตใƒผใƒใƒผใŒใ“ใ‚Œใ‚’ๅฎŸใ‚ตใƒผใƒ“ใ‚นใ‹ใ‚‰ๅ‘ผใณๅ‡บใ™ใ“ใจใฏใชใ„ใงใ—ใ‚‡ใ†ใ€‚ใŸใ ใ—ใ€้กงๅฎขใŒไปฎๆƒณใ‚ขใ‚ซใ‚ฆใƒณใƒˆใซๆ”ฏๆ‰•ใ„ใ‚’้€ฒใ‚ใ‚‹็Šถๆณใ‚’ใ‚ทใƒŸใƒฅใƒฌใƒผใƒˆใ™ใ‚‹ใŸใ‚ใซใ€ใƒ†ใ‚นใƒˆ่‡ชๅ‹•ๅŒ–ใƒ—ใƒญใ‚ฐใƒฉใƒ ใƒฌใƒ™ใƒซใงไฝฟ็”จใ™ใ‚‹ใ“ใจใŒใงใใพใ™ใ€‚ใใ—ใฆ`virtual_accounts.store`ใฎๅพŒใซ้กงๅฎขใŒๆŒ‡ๅฎšใ•ใ‚ŒใŸๅฃๅบงใซ้‡‘้กใ‚’ๅ…ฅ้‡‘ใ™ใ‚‹ใจใ€ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใ‚ตใƒผใƒใƒผใ‹ใ‚‰ใ‚ฆใ‚งใƒ–ใƒ•ใƒƒใ‚ฏใ‚คใƒ™ใƒณใƒˆใŒ็™บ็”Ÿใ—ใฆใ‚ใชใŸใฎใƒใƒƒใ‚ฏใ‚จใƒณใƒ‰ใ‚ตใƒผใƒใƒผใซ้€ไฟกใ•ใ‚Œใ‚‹ใ€‚้€ฃๆบๅ…ˆใฎใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใ‚ตใƒผใƒใƒผใŒๅฎŸ้š›ใงใฏใชใ„ `fake-toss-payments-server` ใชใ‚‰ใ€{@link internal.virtual_accounts.deposit } ใ‚’ๅ‘ผใณๅ‡บใ—ใฆใ€้กงๅฎขใŒไปฎๆƒณๅฃๅบงใซๅ…ฅ้‡‘ใ™ใ‚‹็Šถๆณใ‚’ใ‚ทใƒŸใƒฅใƒฌใƒผใƒˆใงใใพใ™ใ€‚.", + "security": [ + { + "basic": [] + } + ], + "x-nestia-namespace": "v1.virtual-accounts.store", + "x-nestia-jsDocTags": [ + { + "name": "param", + "text": [ + { + "text": "input", + "kind": "parameterName" + }, + { + "text": " ", + "kind": "space" + }, + { + "text": "๊ฐ€์ƒ ๊ฒฐ์ œ ์‹ ์ฒญ ์ •๋ณด.", + "kind": "text" + } + ] + }, + { + "name": "returns", + "text": [ + { + "text": "๊ฐ€์ƒ ๊ณ„์ขŒ ๊ฒฐ์ œ ์ •๋ณด", + "kind": "text" + } + ] + }, + { + "name": "security", + "text": [ + { + "text": "basic", + "kind": "text" + } + ] + }, + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ], + "x-nestia-method": "POST" + } + } + }, + "components": { + "schemas": { + "ITossBilling.IStore": { + "type": "object", + "properties": { + "cardNumber": { + "description": "ใ‚ซใƒผใƒ‰็•ชๅท.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "[0-9]{16}" + }, + "cardExpirationYear": { + "description": "ใ‚ซใƒผใƒ‰ใฎๆœ‰ๅŠนๆœŸ้™๏ผˆ2ๆก๏ผ‰.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "\\d{2}" + }, + "cardExpirationMonth": { + "description": "ใ‚ซใƒผใƒ‰ๆœ‰ๅŠนๆœŸ้™ๆœˆ๏ผˆ2ๆก๏ผ‰.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^(0[1-9]|1[012])$" + }, + "cardPassword": { + "description": "ใ‚ซใƒผใƒ‰ใƒ‘ใ‚นใƒฏใƒผใƒ‰.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "customerBirthday": { + "description": "้กงๅฎขใฎ็”Ÿๅนดๆœˆๆ—ฅใ€‚่กจ่จ˜ๅฝขๅผYYMMDD.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^([0-9]{2})(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$" + }, + "consumerName": { + "description": "้กงๅฎขใฎๅๅ‰.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customerEmail": { + "description": "ใŠๅฎขๆง˜ใฎใƒกใƒผใƒซ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "format": "email" + }, + "vbv": { + "$ref": "#/components/schemas/__type" + }, + "customerKey": { + "description": "้กงๅฎข่ญ˜ๅˆฅๅญใ‚ญใƒผใ€‚ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใงใฏใชใใ€ใใ‚Œใ‚’ๅˆฉ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใง็‹ฌ่‡ชใซ็ฎก็†ใ™ใ‚‹่ญ˜ๅˆฅๅญใ‚ญใƒผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "cardNumber", + "cardExpirationYear", + "cardExpirationMonth", + "cardPassword", + "customerBirthday", + "customerKey" + ], + "description": "็ฐกๅ˜ๆฑบๆธˆใ‚ซใƒผใƒ‰ใฎใƒ—ใƒญใƒ‘ใƒ†ใ‚ฃ.", + "x-typia-jsDocTags": [] + }, + "__type": { + "type": "object", + "properties": { + "cavv": { + "description": "3D Secure่ช่จผใ‚ปใƒƒใ‚ทใƒงใƒณใฎ่ช่จผๅ€ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "xid": { + "description": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณID.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "eci": { + "description": "3DS่ช่จผ็ตๆžœใฎใ‚ณใƒผใƒ‰ๅ€ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "cavv", + "xid", + "eci" + ], + "x-typia-jsDocTags": [] + }, + "ITossBilling": { + "type": "object", + "properties": { + "mId": { + "description": "ๅŠ ็›Ÿๅบ—IDใ€‚็พๅœจใฎtosspaymentsใŒไฝฟใ‚ใ‚Œใฆใ„ใพใ™.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "billingKey": { + "description": "{@link ITossBilling}ใฎ่ญ˜ๅˆฅๅญใ‚ญใƒผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "method": { + "const": "์นด๋“œ", + "description": "ใŠๆ”ฏๆ‰•ใ„ๆ–นๆณ•.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cardCompany": { + "description": "ใ‚ซใƒผใƒ‰ไผš็คพๅ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "cardNumber": { + "description": "ใ‚ซใƒผใƒ‰็•ชๅท.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "[0-9]{16}" + }, + "authenticatedAt": { + "description": "่ช่จผๆ—ฅๆ™‚.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + "customerKey": { + "description": "้กงๅฎข่ญ˜ๅˆฅๅญใ‚ญใƒผใ€‚ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใงใฏใชใใ€ใใ‚Œใ‚’ๅˆฉ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใง็‹ฌ่‡ชใซ็ฎก็†ใ™ใ‚‹่ญ˜ๅˆฅๅญใ‚ญใƒผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "mId", + "billingKey", + "method", + "cardCompany", + "cardNumber", + "authenticatedAt", + "customerKey" + ], + "description": "็ฐกๅ˜ๆฑบๆธˆ็™ป้Œฒๆ‰‹ๆฎตๆƒ…ๅ ฑใ€‚ ใ€ŒITossBillingใ€ใฏใ€็ฐกๆ˜“ๆฑบๆธˆ็™ป้Œฒๆ‰‹ๆฎตใ‚’ๅฝข่ฑกๅŒ–ใ—ใŸใƒ‡ใƒผใ‚ฟๆง‹้€ ใ‚คใƒณใ‚ฟใƒผใƒ•ใ‚งใƒผใ‚นใงใ€้กงๅฎขใŒ่‡ชๅˆ†ใฎใ‚ฏใƒฌใ‚ธใƒƒใƒˆใ‚ซใƒผใƒ‰ใ‚’ใ‚ตใƒผใƒใƒผใซ็™ป้Œฒใ—ใฆใŠใใ€ๆฏŽๅ›žๆฑบๆธˆใŒๅฟ…่ฆใชใจใใฏใ„ใคใงใ‚‚ใ‚ซใƒผใƒ‰ๆƒ…ๅ ฑใ‚’็นฐใ‚Š่ฟ”ใ—ๅ…ฅใ‚Œใ‚ˆใ†ใจใ™ใ‚‹ใ“ใจใชใๆ‰‹่ปฝใซๆฑบๆธˆใ‚’้€ฒใ‚ใŸใ„ใจใใซไฝฟ็”จใ™ใ‚‹.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossBilling.ICustomerKey": { + "type": "object", + "properties": { + "customerKey": { + "description": "้กงๅฎข่ญ˜ๅˆฅๅญใ‚ญใƒผใ€‚ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใงใฏใชใใ€ใใ‚Œใ‚’ๅˆฉ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใง็‹ฌ่‡ชใซ็ฎก็†ใ™ใ‚‹่ญ˜ๅˆฅๅญใ‚ญใƒผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "customerKey" + ], + "description": "้กงๅฎข่ญ˜ๅˆฅๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [] + }, + "ITossBilling.IPaymentStore": { + "type": "object", + "properties": { + "method": { + "const": "billing", + "description": "ใŠๆ”ฏๆ‰•ใ„ๆ–นๆณ•ใŒ็ฐกๅ˜ใชใŠๆ”ฏๆ‰•ใ„ใงใ‚ใ‚‹ใ“ใจใ‚’ๆ„ๅ‘ณใ—ใพใ™.", + "x-typia-required": true, + "x-typia-optional": false + }, + "billingKey": { + "description": "{@link IPaymentStore}ใฎ่ญ˜ๅˆฅๅญใ‚ญใƒผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderId": { + "description": "ๆณจๆ–‡่ญ˜ๅˆฅๅญใ‚ญใƒผใ€‚ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใงใฏใชใใ€ใใ‚Œใ‚’ๅˆฉ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใง็‹ฌ่‡ชใซ็ฎก็†ใ™ใ‚‹่ญ˜ๅˆฅๅญใ‚ญใƒผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "ใŠๆ”ฏๆ‰•ใ„็ท้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "customerKey": { + "description": "้กงๅฎข่ญ˜ๅˆฅๅญใ‚ญใƒผใ€‚ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใงใฏใชใใ€ใใ‚Œใ‚’ๅˆฉ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใง็‹ฌ่‡ชใซ็ฎก็†ใ™ใ‚‹่ญ˜ๅˆฅๅญใ‚ญใƒผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "method", + "billingKey", + "orderId", + "amount", + "customerKey" + ], + "description": "็ฐกๆ˜“ๆฑบๆธˆใ‚’ๅˆฉ็”จใ—ใŸๆฑบๆธˆ็”ณ่ซ‹ๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [] + }, + "ITossPayment": { + "oneOf": [ + { + "$ref": "#/components/schemas/ITossCardPayment" + }, + { + "$ref": "#/components/schemas/ITossGiftCertificatePayment" + }, + { + "$ref": "#/components/schemas/ITossMobilePhonePayment" + }, + { + "$ref": "#/components/schemas/ITossTransferPayment" + }, + { + "$ref": "#/components/schemas/ITossVirtualAccountPayment" + } + ], + "description": "ใŠๆ”ฏๆ‰•ใ„ๆƒ…ๅ ฑใ€ŒITossPaymentใ€ใฏใ€ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใฎๆฑบๆธˆๆƒ…ๅ ฑใ‚’ๅฝข็ŠถๅŒ–ใ—ใŸใƒ‡ใƒผใ‚ฟๆง‹้€ ใงใƒฆใƒ‹ใ‚ชใƒณใ‚ฟใ‚คใƒ—ใฎใ‚คใƒณใ‚ฟใƒ•ใ‚งใƒผใ‚นใงใ‚ใ‚Šใ€if condition ใ‚’้€šใ˜ใฆใƒกใ‚ฝใƒƒใƒ‰ๅ€คใ‚’ๆŒ‡ๅฎšใ™ใ‚‹ใจใ€ๆดพ็”Ÿใ‚ฟใ‚คใƒ—ใŒ่‡ชๅ‹•็š„ใซๆŒ‡ๅฎšใ•ใ‚Œใ‚‹ใ€‚ `` typescript if๏ผˆpayment.method ===ใ€Œใ‚ซใƒผใƒ‰ใ€๏ผ‰payment.card; // payment be ITossCardPayment ``", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossCardPayment": { + "type": "object", + "properties": { + "card": { + "$ref": "#/components/schemas/ITossCardPayment.ICard" + }, + "discount": { + "$ref": "#/components/schemas/ITossCardPayment.IDiscount.Nullable" + }, + "easyPay": { + "oneOf": [ + { + "const": "ํ† ์Šค๊ฒฐ์ œ" + }, + { + "const": "ํŽ˜์ด์ฝ”" + }, + { + "const": "์‚ผ์„ฑํŽ˜์ด" + }, + { + "type": "null" + } + ], + "description": "็ฐกๆ˜“ๆฑบๆธˆใงๆฑบๆธˆใ—ใŸๅ ดๅˆใฎ็ฐกๆ˜“ๆฑบๆธˆใ‚ฟใ‚คใƒ—ๆƒ…ๅ ฑ.", + "x-typia-required": true, + "x-typia-optional": false + }, + "method": { + "const": "์นด๋“œ", + "description": "ใŠๆ”ฏๆ‰•ใ„ๆ–นๆณ•.", + "x-typia-required": true, + "x-typia-optional": false + }, + "type": { + "oneOf": [ + { + "const": "NORMAL" + }, + { + "const": "BILLING" + } + ], + "description": "ใŠๆ”ฏๆ‰•ใ„ใ‚ฟใ‚คใƒ—ใ€‚ - NORMAL๏ผšไธ€่ˆฌๆฑบๆธˆ - BILLING๏ผšใ‚ใ‚‰ใ‹ใ˜ใ‚็™ป้Œฒใ—ใŸใ‚ซใƒผใƒ‰ใซใ‚ˆใ‚‹็ฐกๅ˜ๆฑบๆธˆ.", + "x-typia-required": true, + "x-typia-optional": false + }, + "status": { + "oneOf": [ + { + "const": "READY" + }, + { + "const": "IN_PROGRESS" + }, + { + "const": "WAITING_FOR_DEPOSIT" + }, + { + "const": "DONE" + }, + { + "const": "CANCELED" + }, + { + "const": "PARTIAL_CANCELED" + }, + { + "const": "ABORTED" + }, + { + "const": "EXPIRED" + } + ], + "description": "ใŠๆ”ฏๆ‰•ใ„็Šถๆณใ€‚ - READY - IN_PROGRESS - WAITING_FOR_DEPOSIT - DONE - CANCELED - PARTIAL_CANCELED - ABORTED - EXPIRED", + "x-typia-required": true, + "x-typia-optional": false + }, + "mId": { + "description": "ๅŠ ็›Ÿๅบ—IDใ€‚็พๅœจใฎtosspaymentsใŒไฝฟใ‚ใ‚Œใฆใ„ใพใ™.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "version": { + "description": "ไฝฟ็”จใ—ใฆใ„ใ‚‹ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„APIใฎใƒใƒผใ‚ธใƒงใƒณ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "paymentKey": { + "description": "ใŠๆ”ฏๆ‰•ใ„ๅฑฅๆญดใฎ่ญ˜ๅˆฅ็•ชๅท.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderId": { + "description": "ๆณจๆ–‡่ญ˜ๅˆฅๅญใ‚ญใƒผใ€‚ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใงใฏใชใใ€ใใ‚Œใ‚’ๅˆฉ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใง็‹ฌ่‡ชใซ็ฎก็†ใ™ใ‚‹่ญ˜ๅˆฅๅญใ‚ญใƒผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "transactionKey": { + "description": "ๅ–ๅผ•ใ‚ฌใƒณใฎไธ€ๆ„ใฎใ‚ญใƒผๅ€คใ€‚ {@link paymentKey}ใจใฏ็•ฐใชใ‚Šใ€ใ“ใ‚Œใ‚’ไฝฟ็”จใ™ใ‚‹ใ“ใจใฏใ‚ใ‚Šใพใ›ใ‚“ใงใ—ใŸใ€‚.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "ๆณจๆ–‡ๅใ€‚ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒˆใงใฏใชใใ€ใ“ใ‚Œใ‚’ๅˆฉ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใง็™บ่กŒใ—ใŸๆณจๆ–‡ๅ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "currency": { + "description": "้€š่ฒจๅ˜ไฝใ€‚็พๅœจใ€ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใฏJPYใฎใฟๅˆฉ็”จๅฏ่ƒฝ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "totalAmount": { + "description": "็ทๆฑบๆธˆ้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "balanceAmount": { + "description": "ใ‚ญใƒฃใƒณใ‚ปใƒซใงใใ‚‹้‡‘้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "suppliedAmount": { + "description": "ไพ›็ตฆไพกๆ ผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxFreeAmount": { + "description": "ๅ…็จŽ้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vat": { + "description": "ไป˜ๅŠ ไพกๅ€ค็จŽ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "useEscrow": { + "description": "ใ‚จใ‚นใ‚ฏใƒญใƒผใจใ—ใฆไฝฟ็”จใ™ใ‚‹ใ‹ใฉใ†ใ‹.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "cultureExpense": { + "description": "ๆ–‡ๅŒ–่ฒปใ‚’่ฒปใ‚„ใ™ใ‹ใฉใ†ใ‹ใ€‚้™ถ็Ÿณๅ…ฅใ€ๅ…ฌๆผ”ใƒใ‚ฑใƒƒใƒˆใ€ๅš็‰ฉ้คจ/็พŽ่ก“้คจๅ…ฅๅ ดๅˆธใชใฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "requestedAt": { + "description": "ใŠๆ”ฏๆ‰•ใ„ใƒชใ‚ฏใ‚จใ‚นใƒˆใฎๆ—ฅๆ™‚.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + "approvedAt": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "description": "ๆ”ฏๆ‰•ใ„ๆ‰ฟ่ชๆ—ฅๆ™‚.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cancels": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/ITossPaymentCancel" + } + }, + { + "type": "null" + } + ], + "description": "ใŠๆ”ฏๆ‰•ใ„ใ‚ญใƒฃใƒณใ‚ปใƒซๅฑฅๆญด.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cashReceipt": { + "$ref": "#/components/schemas/ITossCashReceipt.ISummary.Nullable" + } + }, + "required": [ + "card", + "discount", + "easyPay", + "method", + "type", + "status", + "mId", + "version", + "paymentKey", + "orderId", + "transactionKey", + "orderName", + "currency", + "totalAmount", + "balanceAmount", + "suppliedAmount", + "taxFreeAmount", + "vat", + "useEscrow", + "cultureExpense", + "requestedAt", + "approvedAt", + "cancels", + "cashReceipt" + ], + "description": "ใ‚ซใƒผใƒ‰ๆฑบๆธˆๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossCardPayment.ICard": { + "type": "object", + "properties": { + "company": { + "description": "ใ‚ซใƒผใƒ‰ไผš็คพๅ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "number": { + "description": "ใ‚ซใƒผใƒ‰็•ชๅท.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "[0-9]{16}" + }, + "installmentPlanMonths": { + "description": "ๅˆ†ๅ‰ฒๆ‰•ใ„ๆœˆๆ•ฐ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "isInterestFree": { + "description": "็„กๅˆฉๅญๅˆ†ๅ‰ฒๆ‰•ใ„ใ‚’้ฉ็”จใ™ใ‚‹ใ‹ใฉใ†ใ‹.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "approveNo": { + "description": "ๆ‰ฟ่ช็•ชๅท.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "useCardPoint": { + "const": false, + "description": "ใ‚ซใƒผใƒ‰ใƒใ‚คใƒณใƒˆใ‚’ไฝฟ็”จใ™ใ‚‹ใ‹ใฉใ†ใ‹.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cardType": { + "oneOf": [ + { + "const": "์‹ ์šฉ" + }, + { + "const": "์ฒดํฌ" + }, + { + "const": "๊ธฐํ”„ํŠธ" + } + ], + "description": "ใ‚ซใƒผใƒ‰ใ‚ฟใ‚คใƒ—.", + "x-typia-required": true, + "x-typia-optional": false + }, + "ownerType": { + "oneOf": [ + { + "const": "๊ฐœ์ธ" + }, + { + "const": "๋ฒ•์ธ" + } + ], + "description": "ใ‚ซใƒผใƒ‰ใฎๆ‰€ๆœ‰่€…ใ‚ฟใ‚คใƒ—.", + "x-typia-required": true, + "x-typia-optional": false + }, + "acquireStatus": { + "oneOf": [ + { + "const": "READY" + }, + { + "const": "CANCELED" + }, + { + "const": "REQUESTED" + }, + { + "const": "COMPLETED" + }, + { + "const": "CANCEL_REQUESTED" + } + ], + "description": "ใ‚ซใƒผใƒ‰ๆฑบๆธˆใฎ่ณผๅ…ฅ็Šถๆณใ€‚ - READY๏ผš่ณผๅ…ฅๅพ…ใก - REQUESTED๏ผš่ณผๅ…ฅ่ฆๆฑ‚ๆธˆใฟ - COMPLETED๏ผš่ณผๅ…ฅๅฎŒไบ† - CANCEL_REQUESTED๏ผš่ณผๅ…ฅใ‚ญใƒฃใƒณใ‚ปใƒซ่ฆๆฑ‚ๆธˆใฟ - CANCELD๏ผš่ณผๅ…ฅ่งฃ้™ค", + "x-typia-required": true, + "x-typia-optional": false + }, + "receiptUrl": { + "description": "้ ˜ๅŽๆ›ธURL.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "url" + } + }, + "required": [ + "company", + "number", + "installmentPlanMonths", + "isInterestFree", + "approveNo", + "useCardPoint", + "cardType", + "ownerType", + "acquireStatus", + "receiptUrl" + ], + "description": "ใ‚ซใƒผใƒ‰ๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [] + }, + "ITossCardPayment.IDiscount.Nullable": { + "oneOf": [ + { + "type": "object", + "properties": { + "amount": { + "description": "ใ‚ซใƒผใƒ‰ไผš็คพใฎๅณๆ™‚ๅ‰ฒๅผ•ใƒ—ใƒญใƒขใƒผใ‚ทใƒงใƒณใ‚’้ฉ็”จใ—ใŸ้‡‘้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + } + }, + "required": [ + "amount" + ], + "x-typia-jsDocTags": [] + }, + { + "type": "null" + } + ], + "description": "ใ‚ซใƒผใƒ‰ไผš็คพใฎๅณๅ‰ฒๅผ•ใƒ—ใƒญใƒขใƒผใ‚ทใƒงใƒณๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [] + }, + "ITossPaymentCancel": { + "type": "object", + "properties": { + "cancelAmount": { + "description": "ใ‚ญใƒฃใƒณใ‚ปใƒซ็ท้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "cancelReason": { + "description": "ใ‚ญใƒฃใƒณใ‚ปใƒซ็†็”ฑ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "taxFreeAmount": { + "description": "ๅ…็จŽใ•ใ‚ŒใŸ้‡‘้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxAmount": { + "description": "่ชฒ็จŽใ•ใ‚ŒใŸ้‡‘้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "refundableAmount": { + "description": "ใŠๆ”ฏๆ‰•ใ„ใฎใ‚ญใƒฃใƒณใ‚ปใƒซๅพŒใฎๆ‰•ใ„ๆˆปใ—ๅฏ่ƒฝๆฎ‹้ซ˜.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "canceledAt": { + "description": "ใ‚ญใƒฃใƒณใ‚ปใƒซๆ—ฅๆ™‚.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + } + }, + "required": [ + "cancelAmount", + "cancelReason", + "taxFreeAmount", + "taxAmount", + "refundableAmount", + "canceledAt" + ], + "description": "ใŠๆ”ฏๆ‰•ใ„ใ‚ญใƒฃใƒณใ‚ปใƒซใซใคใ„ใฆ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossCashReceipt.ISummary.Nullable": { + "oneOf": [ + { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/ITossCashReceipt.Type" + }, + "amount": { + "description": "็พ้‡‘้ ˜ๅŽๆ›ธๅ‡ฆ็†ใ•ใ‚ŒใŸ้‡‘้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxFreeAmount": { + "description": "ๅ…็จŽใ•ใ‚ŒใŸ้‡‘้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "issueNumber": { + "description": "็พ้‡‘้ ˜ๅŽๆ›ธ็™บ่กŒ็•ชๅท.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "receiptUrl": { + "description": "็พ้‡‘้ ˜ๅŽๆ›ธใฎ้–ฒ่ฆงใƒšใƒผใ‚ธใฎไฝๆ‰€.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "type", + "amount", + "taxFreeAmount", + "issueNumber", + "receiptUrl" + ], + "x-typia-jsDocTags": [] + }, + { + "type": "null" + } + ], + "description": "็พ้‡‘้ ˜ๅŽๆ›ธใฎๆฆ‚่ฆใซใคใ„ใฆ.", + "x-typia-jsDocTags": [] + }, + "ITossCashReceipt.Type": { + "oneOf": [ + { + "const": "์†Œ๋“๊ณต์ œ" + }, + { + "const": "์ง€์ถœ์ฆ๋น™" + } + ], + "description": "็พ้‡‘้ ˜ๅŽๆ›ธใฎ็จฎ้กž." + }, + "ITossGiftCertificatePayment": { + "type": "object", + "properties": { + "giftCertificate": { + "$ref": "#/components/schemas/ITossGiftCertificatePayment.IGiftCertificate" + }, + "method": { + "const": "์ƒํ’ˆ๊ถŒ", + "description": "ใŠๆ”ฏๆ‰•ใ„ๆ–นๆณ•.", + "x-typia-required": true, + "x-typia-optional": false + }, + "type": { + "const": "NORMAL", + "description": "ใŠๆ”ฏๆ‰•ใ„ใ‚ฟใ‚คใƒ—ใ€‚ - NORMAL๏ผšไธ€่ˆฌๆฑบๆธˆ - BILLING๏ผšใ‚ใ‚‰ใ‹ใ˜ใ‚็™ป้Œฒใ—ใŸใ‚ซใƒผใƒ‰ใซใ‚ˆใ‚‹็ฐกๅ˜ๆฑบๆธˆ.", + "x-typia-required": true, + "x-typia-optional": false + }, + "status": { + "oneOf": [ + { + "const": "READY" + }, + { + "const": "IN_PROGRESS" + }, + { + "const": "WAITING_FOR_DEPOSIT" + }, + { + "const": "DONE" + }, + { + "const": "CANCELED" + }, + { + "const": "PARTIAL_CANCELED" + }, + { + "const": "ABORTED" + }, + { + "const": "EXPIRED" + } + ], + "description": "ใŠๆ”ฏๆ‰•ใ„็Šถๆณใ€‚ - READY - IN_PROGRESS - WAITING_FOR_DEPOSIT - DONE - CANCELED - PARTIAL_CANCELED - ABORTED - EXPIRED", + "x-typia-required": true, + "x-typia-optional": false + }, + "mId": { + "description": "ๅŠ ็›Ÿๅบ—IDใ€‚็พๅœจใฎtosspaymentsใŒไฝฟใ‚ใ‚Œใฆใ„ใพใ™.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "version": { + "description": "ไฝฟ็”จใ—ใฆใ„ใ‚‹ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„APIใฎใƒใƒผใ‚ธใƒงใƒณ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "paymentKey": { + "description": "ใŠๆ”ฏๆ‰•ใ„ๅฑฅๆญดใฎ่ญ˜ๅˆฅ็•ชๅท.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderId": { + "description": "ๆณจๆ–‡่ญ˜ๅˆฅๅญใ‚ญใƒผใ€‚ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใงใฏใชใใ€ใใ‚Œใ‚’ๅˆฉ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใง็‹ฌ่‡ชใซ็ฎก็†ใ™ใ‚‹่ญ˜ๅˆฅๅญใ‚ญใƒผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "transactionKey": { + "description": "ๅ–ๅผ•ใ‚ฌใƒณใฎไธ€ๆ„ใฎใ‚ญใƒผๅ€คใ€‚ {@link paymentKey}ใจใฏ็•ฐใชใ‚Šใ€ใ“ใ‚Œใ‚’ไฝฟ็”จใ™ใ‚‹ใ“ใจใฏใ‚ใ‚Šใพใ›ใ‚“ใงใ—ใŸใ€‚.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "ๆณจๆ–‡ๅใ€‚ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒˆใงใฏใชใใ€ใ“ใ‚Œใ‚’ๅˆฉ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใง็™บ่กŒใ—ใŸๆณจๆ–‡ๅ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "currency": { + "description": "้€š่ฒจๅ˜ไฝใ€‚็พๅœจใ€ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใฏJPYใฎใฟๅˆฉ็”จๅฏ่ƒฝ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "totalAmount": { + "description": "็ทๆฑบๆธˆ้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "balanceAmount": { + "description": "ใ‚ญใƒฃใƒณใ‚ปใƒซใงใใ‚‹้‡‘้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "suppliedAmount": { + "description": "ไพ›็ตฆไพกๆ ผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxFreeAmount": { + "description": "ๅ…็จŽ้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vat": { + "description": "ไป˜ๅŠ ไพกๅ€ค็จŽ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "useEscrow": { + "description": "ใ‚จใ‚นใ‚ฏใƒญใƒผใจใ—ใฆไฝฟ็”จใ™ใ‚‹ใ‹ใฉใ†ใ‹.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "cultureExpense": { + "description": "ๆ–‡ๅŒ–่ฒปใ‚’่ฒปใ‚„ใ™ใ‹ใฉใ†ใ‹ใ€‚้™ถ็Ÿณๅ…ฅใ€ๅ…ฌๆผ”ใƒใ‚ฑใƒƒใƒˆใ€ๅš็‰ฉ้คจ/็พŽ่ก“้คจๅ…ฅๅ ดๅˆธใชใฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "requestedAt": { + "description": "ใŠๆ”ฏๆ‰•ใ„ใƒชใ‚ฏใ‚จใ‚นใƒˆใฎๆ—ฅๆ™‚.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + "approvedAt": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "description": "ๆ”ฏๆ‰•ใ„ๆ‰ฟ่ชๆ—ฅๆ™‚.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cancels": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/ITossPaymentCancel" + } + }, + { + "type": "null" + } + ], + "description": "ใŠๆ”ฏๆ‰•ใ„ใ‚ญใƒฃใƒณใ‚ปใƒซๅฑฅๆญด.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cashReceipt": { + "$ref": "#/components/schemas/ITossCashReceipt.ISummary.Nullable" + } + }, + "required": [ + "giftCertificate", + "method", + "type", + "status", + "mId", + "version", + "paymentKey", + "orderId", + "transactionKey", + "orderName", + "currency", + "totalAmount", + "balanceAmount", + "suppliedAmount", + "taxFreeAmount", + "vat", + "useEscrow", + "cultureExpense", + "requestedAt", + "approvedAt", + "cancels", + "cashReceipt" + ], + "description": "ๅ•†ๅ“ๅˆธๆฑบๆธˆๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossGiftCertificatePayment.IGiftCertificate": { + "type": "object", + "properties": { + "approveNo": { + "description": "ๆ‰ฟ่ช็•ชๅท.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "settlementStatus": { + "oneOf": [ + { + "const": "COMPLETE" + }, + { + "const": "INCOMPLETE" + } + ], + "description": "ๆฑบๆธˆ็Šถๆณ.", + "x-typia-required": true, + "x-typia-optional": false + } + }, + "required": [ + "approveNo", + "settlementStatus" + ], + "description": "ๅ•†ๅ“ๅˆธๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [] + }, + "ITossMobilePhonePayment": { + "type": "object", + "properties": { + "mobilePhone": { + "$ref": "#/components/schemas/ITossMobilePhonePayment.IMobilePhone" + }, + "method": { + "const": "ํœด๋Œ€ํฐ", + "description": "ใŠๆ”ฏๆ‰•ใ„ๆ–นๆณ•.", + "x-typia-required": true, + "x-typia-optional": false + }, + "type": { + "const": "NORMAL", + "description": "ใŠๆ”ฏๆ‰•ใ„ใ‚ฟใ‚คใƒ—ใ€‚ - NORMAL๏ผšไธ€่ˆฌๆฑบๆธˆ - BILLING๏ผšใ‚ใ‚‰ใ‹ใ˜ใ‚็™ป้Œฒใ—ใŸใ‚ซใƒผใƒ‰ใซใ‚ˆใ‚‹็ฐกๅ˜ๆฑบๆธˆ.", + "x-typia-required": true, + "x-typia-optional": false + }, + "status": { + "oneOf": [ + { + "const": "READY" + }, + { + "const": "IN_PROGRESS" + }, + { + "const": "WAITING_FOR_DEPOSIT" + }, + { + "const": "DONE" + }, + { + "const": "CANCELED" + }, + { + "const": "PARTIAL_CANCELED" + }, + { + "const": "ABORTED" + }, + { + "const": "EXPIRED" + } + ], + "description": "ใŠๆ”ฏๆ‰•ใ„็Šถๆณใ€‚ - READY - IN_PROGRESS - WAITING_FOR_DEPOSIT - DONE - CANCELED - PARTIAL_CANCELED - ABORTED - EXPIRED", + "x-typia-required": true, + "x-typia-optional": false + }, + "mId": { + "description": "ๅŠ ็›Ÿๅบ—IDใ€‚็พๅœจใฎtosspaymentsใŒไฝฟใ‚ใ‚Œใฆใ„ใพใ™.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "version": { + "description": "ไฝฟ็”จใ—ใฆใ„ใ‚‹ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„APIใฎใƒใƒผใ‚ธใƒงใƒณ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "paymentKey": { + "description": "ใŠๆ”ฏๆ‰•ใ„ๅฑฅๆญดใฎ่ญ˜ๅˆฅ็•ชๅท.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderId": { + "description": "ๆณจๆ–‡่ญ˜ๅˆฅๅญใ‚ญใƒผใ€‚ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใงใฏใชใใ€ใใ‚Œใ‚’ๅˆฉ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใง็‹ฌ่‡ชใซ็ฎก็†ใ™ใ‚‹่ญ˜ๅˆฅๅญใ‚ญใƒผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "transactionKey": { + "description": "ๅ–ๅผ•ใ‚ฌใƒณใฎไธ€ๆ„ใฎใ‚ญใƒผๅ€คใ€‚ {@link paymentKey}ใจใฏ็•ฐใชใ‚Šใ€ใ“ใ‚Œใ‚’ไฝฟ็”จใ™ใ‚‹ใ“ใจใฏใ‚ใ‚Šใพใ›ใ‚“ใงใ—ใŸใ€‚.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "ๆณจๆ–‡ๅใ€‚ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒˆใงใฏใชใใ€ใ“ใ‚Œใ‚’ๅˆฉ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใง็™บ่กŒใ—ใŸๆณจๆ–‡ๅ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "currency": { + "description": "้€š่ฒจๅ˜ไฝใ€‚็พๅœจใ€ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใฏJPYใฎใฟๅˆฉ็”จๅฏ่ƒฝ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "totalAmount": { + "description": "็ทๆฑบๆธˆ้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "balanceAmount": { + "description": "ใ‚ญใƒฃใƒณใ‚ปใƒซใงใใ‚‹้‡‘้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "suppliedAmount": { + "description": "ไพ›็ตฆไพกๆ ผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxFreeAmount": { + "description": "ๅ…็จŽ้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vat": { + "description": "ไป˜ๅŠ ไพกๅ€ค็จŽ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "useEscrow": { + "description": "ใ‚จใ‚นใ‚ฏใƒญใƒผใจใ—ใฆไฝฟ็”จใ™ใ‚‹ใ‹ใฉใ†ใ‹.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "cultureExpense": { + "description": "ๆ–‡ๅŒ–่ฒปใ‚’่ฒปใ‚„ใ™ใ‹ใฉใ†ใ‹ใ€‚้™ถ็Ÿณๅ…ฅใ€ๅ…ฌๆผ”ใƒใ‚ฑใƒƒใƒˆใ€ๅš็‰ฉ้คจ/็พŽ่ก“้คจๅ…ฅๅ ดๅˆธใชใฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "requestedAt": { + "description": "ใŠๆ”ฏๆ‰•ใ„ใƒชใ‚ฏใ‚จใ‚นใƒˆใฎๆ—ฅๆ™‚.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + "approvedAt": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "description": "ๆ”ฏๆ‰•ใ„ๆ‰ฟ่ชๆ—ฅๆ™‚.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cancels": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/ITossPaymentCancel" + } + }, + { + "type": "null" + } + ], + "description": "ใŠๆ”ฏๆ‰•ใ„ใ‚ญใƒฃใƒณใ‚ปใƒซๅฑฅๆญด.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cashReceipt": { + "$ref": "#/components/schemas/ITossCashReceipt.ISummary.Nullable" + } + }, + "required": [ + "mobilePhone", + "method", + "type", + "status", + "mId", + "version", + "paymentKey", + "orderId", + "transactionKey", + "orderName", + "currency", + "totalAmount", + "balanceAmount", + "suppliedAmount", + "taxFreeAmount", + "vat", + "useEscrow", + "cultureExpense", + "requestedAt", + "approvedAt", + "cancels", + "cashReceipt" + ], + "description": "ๆบๅธฏ้›ป่ฉฑใฎใŠๆ”ฏๆ‰•ใ„ๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossMobilePhonePayment.IMobilePhone": { + "type": "object", + "properties": { + "carrier": { + "description": "้€šไฟกไผš็คพ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "customerMobilePhone": { + "description": "้กงๅฎขใฎๆบๅธฏ้›ป่ฉฑ็•ชๅท.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "settlementStatus": { + "oneOf": [ + { + "const": "COMPLETED" + }, + { + "const": "INCOMPLETED" + } + ], + "description": "ๆฑบๆธˆ็Šถๆณ.", + "x-typia-required": true, + "x-typia-optional": false + } + }, + "required": [ + "carrier", + "customerMobilePhone", + "settlementStatus" + ], + "description": "ๆบๅธฏ้›ป่ฉฑๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [] + }, + "ITossTransferPayment": { + "type": "object", + "properties": { + "transfer": { + "$ref": "#/components/schemas/ITossTransferPayment.ITransfer" + }, + "method": { + "const": "๊ณ„์ขŒ์ด์ฒด", + "description": "ใŠๆ”ฏๆ‰•ใ„ๆ–นๆณ•.", + "x-typia-required": true, + "x-typia-optional": false + }, + "type": { + "const": "NORMAL", + "description": "ใŠๆ”ฏๆ‰•ใ„ใ‚ฟใ‚คใƒ—ใ€‚ - NORMAL๏ผšไธ€่ˆฌๆฑบๆธˆ - BILLING๏ผšใ‚ใ‚‰ใ‹ใ˜ใ‚็™ป้Œฒใ—ใŸใ‚ซใƒผใƒ‰ใซใ‚ˆใ‚‹็ฐกๅ˜ๆฑบๆธˆ.", + "x-typia-required": true, + "x-typia-optional": false + }, + "status": { + "oneOf": [ + { + "const": "READY" + }, + { + "const": "IN_PROGRESS" + }, + { + "const": "WAITING_FOR_DEPOSIT" + }, + { + "const": "DONE" + }, + { + "const": "CANCELED" + }, + { + "const": "PARTIAL_CANCELED" + }, + { + "const": "ABORTED" + }, + { + "const": "EXPIRED" + } + ], + "description": "ใŠๆ”ฏๆ‰•ใ„็Šถๆณใ€‚ - READY - IN_PROGRESS - WAITING_FOR_DEPOSIT - DONE - CANCELED - PARTIAL_CANCELED - ABORTED - EXPIRED", + "x-typia-required": true, + "x-typia-optional": false + }, + "mId": { + "description": "ๅŠ ็›Ÿๅบ—IDใ€‚็พๅœจใฎtosspaymentsใŒไฝฟใ‚ใ‚Œใฆใ„ใพใ™.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "version": { + "description": "ไฝฟ็”จใ—ใฆใ„ใ‚‹ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„APIใฎใƒใƒผใ‚ธใƒงใƒณ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "paymentKey": { + "description": "ใŠๆ”ฏๆ‰•ใ„ๅฑฅๆญดใฎ่ญ˜ๅˆฅ็•ชๅท.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderId": { + "description": "ๆณจๆ–‡่ญ˜ๅˆฅๅญใ‚ญใƒผใ€‚ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใงใฏใชใใ€ใใ‚Œใ‚’ๅˆฉ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใง็‹ฌ่‡ชใซ็ฎก็†ใ™ใ‚‹่ญ˜ๅˆฅๅญใ‚ญใƒผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "transactionKey": { + "description": "ๅ–ๅผ•ใ‚ฌใƒณใฎไธ€ๆ„ใฎใ‚ญใƒผๅ€คใ€‚ {@link paymentKey}ใจใฏ็•ฐใชใ‚Šใ€ใ“ใ‚Œใ‚’ไฝฟ็”จใ™ใ‚‹ใ“ใจใฏใ‚ใ‚Šใพใ›ใ‚“ใงใ—ใŸใ€‚.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "ๆณจๆ–‡ๅใ€‚ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒˆใงใฏใชใใ€ใ“ใ‚Œใ‚’ๅˆฉ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใง็™บ่กŒใ—ใŸๆณจๆ–‡ๅ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "currency": { + "description": "้€š่ฒจๅ˜ไฝใ€‚็พๅœจใ€ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใฏJPYใฎใฟๅˆฉ็”จๅฏ่ƒฝ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "totalAmount": { + "description": "็ทๆฑบๆธˆ้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "balanceAmount": { + "description": "ใ‚ญใƒฃใƒณใ‚ปใƒซใงใใ‚‹้‡‘้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "suppliedAmount": { + "description": "ไพ›็ตฆไพกๆ ผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxFreeAmount": { + "description": "ๅ…็จŽ้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vat": { + "description": "ไป˜ๅŠ ไพกๅ€ค็จŽ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "useEscrow": { + "description": "ใ‚จใ‚นใ‚ฏใƒญใƒผใจใ—ใฆไฝฟ็”จใ™ใ‚‹ใ‹ใฉใ†ใ‹.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "cultureExpense": { + "description": "ๆ–‡ๅŒ–่ฒปใ‚’่ฒปใ‚„ใ™ใ‹ใฉใ†ใ‹ใ€‚้™ถ็Ÿณๅ…ฅใ€ๅ…ฌๆผ”ใƒใ‚ฑใƒƒใƒˆใ€ๅš็‰ฉ้คจ/็พŽ่ก“้คจๅ…ฅๅ ดๅˆธใชใฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "requestedAt": { + "description": "ใŠๆ”ฏๆ‰•ใ„ใƒชใ‚ฏใ‚จใ‚นใƒˆใฎๆ—ฅๆ™‚.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + "approvedAt": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "description": "ๆ”ฏๆ‰•ใ„ๆ‰ฟ่ชๆ—ฅๆ™‚.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cancels": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/ITossPaymentCancel" + } + }, + { + "type": "null" + } + ], + "description": "ใŠๆ”ฏๆ‰•ใ„ใ‚ญใƒฃใƒณใ‚ปใƒซๅฑฅๆญด.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cashReceipt": { + "$ref": "#/components/schemas/ITossCashReceipt.ISummary.Nullable" + } + }, + "required": [ + "transfer", + "method", + "type", + "status", + "mId", + "version", + "paymentKey", + "orderId", + "transactionKey", + "orderName", + "currency", + "totalAmount", + "balanceAmount", + "suppliedAmount", + "taxFreeAmount", + "vat", + "useEscrow", + "cultureExpense", + "requestedAt", + "approvedAt", + "cancels", + "cashReceipt" + ], + "description": "ๅฃๅบงๆŒฏๆ›ฟๆฑบๆธˆๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossTransferPayment.ITransfer": { + "type": "object", + "properties": { + "bank": { + "description": "้Š€่กŒๅ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "settlementStatus": { + "oneOf": [ + { + "const": "COMPLETED" + }, + { + "const": "INCOMPLETED" + } + ], + "description": "ๆŒฏๆ›ฟ็Šถๆ…‹.", + "x-typia-required": true, + "x-typia-optional": false + } + }, + "required": [ + "bank", + "settlementStatus" + ], + "description": "ๅฃๅบงๆŒฏๆ›ฟๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [] + }, + "ITossVirtualAccountPayment": { + "type": "object", + "properties": { + "secret": { + "description": "ไปฎๆƒณๅฃๅบงใธใฎใŠๆ”ฏๆ‰•ใ„ๆ™‚ใซ่ปข้€ใ•ใ‚Œใ‚‹ใƒ‡ใƒใ‚ธใƒƒใƒˆใ‚ณใƒผใƒซใƒใƒƒใ‚ฏใ‚’ๆคœ่จผใ™ใ‚‹ใŸใ‚ใฎๅ€ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "virtualAccount": { + "$ref": "#/components/schemas/ITossVirtualAccountPayment.IVirtualAccount" + }, + "method": { + "const": "๊ฐ€์ƒ๊ณ„์ขŒ", + "description": "ใŠๆ”ฏๆ‰•ใ„ๆ–นๆณ•.", + "x-typia-required": true, + "x-typia-optional": false + }, + "type": { + "const": "NORMAL", + "description": "ใŠๆ”ฏๆ‰•ใ„ใ‚ฟใ‚คใƒ—ใ€‚ - NORMAL๏ผšไธ€่ˆฌๆฑบๆธˆ - BILLING๏ผšใ‚ใ‚‰ใ‹ใ˜ใ‚็™ป้Œฒใ—ใŸใ‚ซใƒผใƒ‰ใซใ‚ˆใ‚‹็ฐกๅ˜ๆฑบๆธˆ.", + "x-typia-required": true, + "x-typia-optional": false + }, + "status": { + "oneOf": [ + { + "const": "READY" + }, + { + "const": "IN_PROGRESS" + }, + { + "const": "WAITING_FOR_DEPOSIT" + }, + { + "const": "DONE" + }, + { + "const": "CANCELED" + }, + { + "const": "PARTIAL_CANCELED" + }, + { + "const": "ABORTED" + }, + { + "const": "EXPIRED" + } + ], + "description": "ใŠๆ”ฏๆ‰•ใ„็Šถๆณใ€‚ - READY - IN_PROGRESS - WAITING_FOR_DEPOSIT - DONE - CANCELED - PARTIAL_CANCELED - ABORTED - EXPIRED", + "x-typia-required": true, + "x-typia-optional": false + }, + "mId": { + "description": "ๅŠ ็›Ÿๅบ—IDใ€‚็พๅœจใฎtosspaymentsใŒไฝฟใ‚ใ‚Œใฆใ„ใพใ™.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "version": { + "description": "ไฝฟ็”จใ—ใฆใ„ใ‚‹ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„APIใฎใƒใƒผใ‚ธใƒงใƒณ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "paymentKey": { + "description": "ใŠๆ”ฏๆ‰•ใ„ๅฑฅๆญดใฎ่ญ˜ๅˆฅ็•ชๅท.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderId": { + "description": "ๆณจๆ–‡่ญ˜ๅˆฅๅญใ‚ญใƒผใ€‚ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใงใฏใชใใ€ใใ‚Œใ‚’ๅˆฉ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใง็‹ฌ่‡ชใซ็ฎก็†ใ™ใ‚‹่ญ˜ๅˆฅๅญใ‚ญใƒผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "transactionKey": { + "description": "ๅ–ๅผ•ใ‚ฌใƒณใฎไธ€ๆ„ใฎใ‚ญใƒผๅ€คใ€‚ {@link paymentKey}ใจใฏ็•ฐใชใ‚Šใ€ใ“ใ‚Œใ‚’ไฝฟ็”จใ™ใ‚‹ใ“ใจใฏใ‚ใ‚Šใพใ›ใ‚“ใงใ—ใŸใ€‚.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "ๆณจๆ–‡ๅใ€‚ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒˆใงใฏใชใใ€ใ“ใ‚Œใ‚’ๅˆฉ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใง็™บ่กŒใ—ใŸๆณจๆ–‡ๅ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "currency": { + "description": "้€š่ฒจๅ˜ไฝใ€‚็พๅœจใ€ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใฏJPYใฎใฟๅˆฉ็”จๅฏ่ƒฝ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "totalAmount": { + "description": "็ทๆฑบๆธˆ้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "balanceAmount": { + "description": "ใ‚ญใƒฃใƒณใ‚ปใƒซใงใใ‚‹้‡‘้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "suppliedAmount": { + "description": "ไพ›็ตฆไพกๆ ผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxFreeAmount": { + "description": "ๅ…็จŽ้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "vat": { + "description": "ไป˜ๅŠ ไพกๅ€ค็จŽ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "useEscrow": { + "description": "ใ‚จใ‚นใ‚ฏใƒญใƒผใจใ—ใฆไฝฟ็”จใ™ใ‚‹ใ‹ใฉใ†ใ‹.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "cultureExpense": { + "description": "ๆ–‡ๅŒ–่ฒปใ‚’่ฒปใ‚„ใ™ใ‹ใฉใ†ใ‹ใ€‚้™ถ็Ÿณๅ…ฅใ€ๅ…ฌๆผ”ใƒใ‚ฑใƒƒใƒˆใ€ๅš็‰ฉ้คจ/็พŽ่ก“้คจๅ…ฅๅ ดๅˆธใชใฉ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "requestedAt": { + "description": "ใŠๆ”ฏๆ‰•ใ„ใƒชใ‚ฏใ‚จใ‚นใƒˆใฎๆ—ฅๆ™‚.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + "approvedAt": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "description": "ๆ”ฏๆ‰•ใ„ๆ‰ฟ่ชๆ—ฅๆ™‚.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cancels": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "array", + "items": { + "$ref": "#/components/schemas/ITossPaymentCancel" + } + }, + { + "type": "null" + } + ], + "description": "ใŠๆ”ฏๆ‰•ใ„ใ‚ญใƒฃใƒณใ‚ปใƒซๅฑฅๆญด.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cashReceipt": { + "$ref": "#/components/schemas/ITossCashReceipt.ISummary.Nullable" + } + }, + "required": [ + "secret", + "virtualAccount", + "method", + "type", + "status", + "mId", + "version", + "paymentKey", + "orderId", + "transactionKey", + "orderName", + "currency", + "totalAmount", + "balanceAmount", + "suppliedAmount", + "taxFreeAmount", + "vat", + "useEscrow", + "cultureExpense", + "requestedAt", + "approvedAt", + "cancels", + "cashReceipt" + ], + "description": "ไปฎๆƒณใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎใŠๆ”ฏๆ‰•ใ„ๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossVirtualAccountPayment.IVirtualAccount": { + "type": "object", + "properties": { + "accountNumber": { + "description": "ๅฃๅบง็•ชๅท.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "accountType": { + "oneOf": [ + { + "const": "์ผ๋ฐ˜" + }, + { + "const": "๊ณ ์ •" + } + ], + "description": "ไปฎๆƒณใ‚ขใ‚ซใ‚ฆใƒณใƒˆใ‚ฟใ‚คใƒ—.", + "x-typia-required": true, + "x-typia-optional": false + }, + "bank": { + "description": "้Š€่กŒๅ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "customerName": { + "description": "้กงๅฎขๅ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "dueDate": { + "description": "ๅ…ฅ้‡‘ๆœŸ้™.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date" + }, + "expired": { + "description": "ไปฎๆƒณใ‚ขใ‚ซใ‚ฆใƒณใƒˆใฎๆœ‰ๅŠนๆœŸ้™.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "boolean" + }, + "settlementStatus": { + "oneOf": [ + { + "const": "COMPLETED" + }, + { + "const": "INCOMPLETED" + } + ], + "description": "ๆฑบๆธˆ็Šถๆณ.", + "x-typia-required": true, + "x-typia-optional": false + }, + "refundStatus": { + "oneOf": [ + { + "const": "COMPLETED" + }, + { + "const": "NONE" + }, + { + "const": "FAILED" + }, + { + "const": "PENDING" + }, + { + "const": "PARTIAL_FAILED" + } + ], + "description": "ๆ‰•ใ„ๆˆปใ—ๅ‡ฆ็†ใ‚นใƒ†ใƒผใ‚ฟใ‚นใ€‚ - NONE๏ผš่ฉฒๅฝ“ใชใ— - FAILED๏ผšๆ‰•ใ„ๆˆปใ—ๅคฑๆ•— - PENDING๏ผšๆ‰•ใ„ๆˆปใ—ๅ‡ฆ็†ไธญ - PARTIAL_FAILED๏ผš้ƒจๅˆ†ๆ‰•ใ„ๆˆปใ—ๅคฑๆ•— - COMPLETED๏ผšๆ‰•ใ„ๆˆปใ—ๅฎŒไบ†", + "x-typia-required": true, + "x-typia-optional": false + } + }, + "required": [ + "accountNumber", + "accountType", + "bank", + "customerName", + "dueDate", + "expired", + "settlementStatus", + "refundStatus" + ], + "description": "ไปฎๆƒณใ‚ขใ‚ซใ‚ฆใƒณใƒˆๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [] + }, + "ITossCashReceipt.IStore": { + "type": "object", + "properties": { + "type": { + "oneOf": [ + { + "const": "์†Œ๋“๊ณต์ œ" + }, + { + "const": "์ง€์ถœ์ฆ๋น™" + } + ], + "description": "็พ้‡‘้ ˜ๅŽๆ›ธใฎ็จฎ้กž.", + "x-typia-required": true, + "x-typia-optional": false + }, + "paymentKey": { + "description": "ๅธฐๅฑž่ซ‹ๆฑ‚ใฎ{@link ITossPayment.paymentKey}.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderId": { + "description": "ๆณจๆ–‡ใฎ่ญ˜ๅˆฅๅญID.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "ๆณจๆ–‡ๅ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "registrationNumber": { + "description": "็พ้‡‘้ ˜ๅŽๆ›ธใ‚’็™บ่กŒใ™ใ‚‹ใŸใ‚ใฎๅ€‹ไบบ่ญ˜ๅˆฅ็•ชๅทใ€‚็พ้‡‘้ ˜ๅŽๆ›ธใฎ็จฎ้กžใซๅฟœใ˜ใฆๆบๅธฏ้›ป่ฉฑ็•ชๅทใ‚„ไฝๆฐ‘็™ป้Œฒ็•ชๅทใพใŸใฏไบ‹ๆฅญ่€…็™ป้Œฒ็•ชๅทใŠใ‚ˆใณใ‚ซใƒผใƒ‰็•ชๅทใ‚’ๅ…ฅๅŠ›ใ™ใ‚‹ใ“ใจใŒใงใใ‚‹.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "็พ้‡‘้ ˜ๅŽๆ›ธใ‚’็™บ่กŒใ™ใ‚‹้‡‘้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxFreeAmount": { + "description": "ๅ…็จŽ้ก.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "businessNumber": { + "description": "ไบ‹ๆฅญ่€…็™ป้Œฒ็•ชๅท.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + } + }, + "required": [ + "type", + "paymentKey", + "orderId", + "orderName", + "registrationNumber", + "amount" + ], + "description": "็พ้‡‘้ ˜ๅŽๆ›ธๅ…ฅๅŠ›ๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [] + }, + "ITossCashReceipt": { + "type": "object", + "properties": { + "receiptKey": { + "description": "็พ้‡‘้ ˜ๅŽๆ›ธใฎ่ญ˜ๅˆฅๅญใ‚ญใƒผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/ITossCashReceipt.Type" + }, + "orderId": { + "description": "ๆณจๆ–‡ใฎ่ญ˜ๅˆฅๅญID.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "ๆณจๆ–‡ๅ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "approvalNumber": { + "description": "็พ้‡‘้ ˜ๅŽๆ›ธๆ‰ฟ่ช็•ชๅท.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "approvedAt": { + "description": "็พ้‡‘้ ˜ๅŽๆ›ธๆ‰ฟ่ชๆ—ฅๆ™‚.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + "canceledAt": { + "oneOf": [ + { + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "description": "็พ้‡‘้ ˜ๅŽๆ›ธใฎใ‚ญใƒฃใƒณใ‚ปใƒซๆ—ฅๆ™‚.", + "x-typia-required": true, + "x-typia-optional": false + }, + "receiptUrl": { + "description": "้ ˜ๅŽๆ›ธURL.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "receiptKey", + "type", + "orderId", + "orderName", + "approvalNumber", + "approvedAt", + "canceledAt", + "receiptUrl" + ], + "description": "็พ้‡‘้ ˜ๅŽๆ›ธๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossCashReceipt.ICancel": { + "type": "object", + "properties": { + "amount": { + "description": "ใ‚ญใƒฃใƒณใ‚ปใƒซ้‡‘้กใ€‚ๆœชๅ…ฅๅŠ›ใฎๅ ดๅˆใ€็พ้‡‘้ ˜ๅŽๆ›ธใซ่จ˜่ผ‰ใ•ใ‚Œใฆใ„ใ‚‹{@link ITossCashReceipt.amount็ท้ก}ใŒใ‚ญใƒฃใƒณใ‚ปใƒซใ•ใ‚Œใพใ—ใŸ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + } + }, + "description": "็พ้‡‘้ ˜ๅŽๆ›ธใ‚ญใƒฃใƒณใ‚ปใƒซๅ…ฅๅŠ›ๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [] + }, + "ITossPaymentWebhook": { + "type": "object", + "properties": { + "eventType": { + "const": "PAYMENT_STATUS_CHANGED", + "description": "ใ‚คใƒ™ใƒณใƒˆใ‚ฟใ‚คใƒ—.", + "x-typia-required": true, + "x-typia-optional": false + }, + "data": { + "$ref": "#/components/schemas/ITossPaymentWebhook.IData" + } + }, + "required": [ + "eventType", + "data" + ], + "description": "Webใƒ•ใƒƒใ‚ฏใ‚คใƒ™ใƒณใƒˆๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [ + { + "name": "author", + "text": [ + { + "text": "Jeongho Nam - https://github.com/samchon", + "kind": "text" + } + ] + } + ] + }, + "ITossPaymentWebhook.IData": { + "type": "object", + "properties": { + "paymentKey": { + "description": "{@link ITossPayment}ใฎ่ญ˜ๅˆฅๅญใ‚ญใƒผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderId": { + "description": "ๆณจๆ–‡่ญ˜ๅˆฅๅญใ‚ญใƒผใ€‚ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใงใฏใชใใ€ใใ‚Œใ‚’ๅˆฉ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใง็‹ฌ่‡ชใซ็ฎก็†ใ™ใ‚‹่ญ˜ๅˆฅๅญใ‚ญใƒผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "status": { + "oneOf": [ + { + "const": "WAITING_FOR_DEPOSIT" + }, + { + "const": "DONE" + }, + { + "const": "CANCELED" + }, + { + "const": "PARTIAL_CANCELED" + } + ], + "description": "ใŠๆ”ฏๆ‰•ใ„็Šถๆณใ€‚ - DONE๏ผšๆ”ฏๆ‰•ใ„ใŒๅฎŒไบ†ใ—ใพใ—ใŸ - CANCELED๏ผšๆ”ฏๆ‰•ใ„ใŒใ‚ญใƒฃใƒณใ‚ปใƒซใ•ใ‚Œใพใ—ใŸ - PARTIAL_CANCELED๏ผšๆ”ฏๆ‰•ใ„ใŒ้ƒจๅˆ†็š„ใซใ‚ญใƒฃใƒณใ‚ปใƒซใ•ใ‚Œใพใ—ใŸ - WAITING_FOR_DEPOSIT๏ผšๅ…ฅ้‡‘ๅพ…ๆฉŸไธญ", + "x-typia-required": true, + "x-typia-optional": false + } + }, + "required": [ + "paymentKey", + "orderId", + "status" + ], + "description": "Webใƒ•ใƒƒใ‚ฏใ‚คใƒ™ใƒณใƒˆใƒ‡ใƒผใ‚ฟ.", + "x-typia-jsDocTags": [] + }, + "ITossCardPayment.IStore": { + "type": "object", + "properties": { + "method": { + "const": "card", + "description": "ใŠๆ”ฏๆ‰•ใ„ๆ–นๆณ•ใŒใ‚ฏใƒฌใ‚ธใƒƒใƒˆใ‚ซใƒผใƒ‰ใงใ‚ใ‚‹ใ“ใจใ‚’ๆ„ๅ‘ณใ—ใพใ™.", + "x-typia-required": true, + "x-typia-optional": false + }, + "cardNumber": { + "description": "ใ‚ซใƒผใƒ‰็•ชๅท.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "[0-9]{16}" + }, + "cardExpirationYear": { + "description": "ใ‚ซใƒผใƒ‰ใฎๆœ‰ๅŠนๆœŸ้™๏ผˆ2ๆก๏ผ‰.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "\\d{2}" + }, + "cardExpirationMonth": { + "description": "ใ‚ซใƒผใƒ‰ๆœ‰ๅŠนๆœŸ้™ๆœˆ๏ผˆ2ๆก๏ผ‰.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^(0[1-9]|1[012])$" + }, + "cardPassword": { + "description": "ใ‚ซใƒผใƒ‰ใƒ‘ใ‚นใƒฏใƒผใƒ‰.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "cardInstallmentPlan": { + "description": "ๅˆ†ๅ‰ฒๆ‰•ใ„ๆœˆๆ•ฐ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "amount": { + "description": "ๆ”ฏๆ‰•็ท้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "taxFreeAmount": { + "description": "ๅ…็จŽ้‡‘็ท้ก.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "orderId": { + "description": "ๆณจๆ–‡่ญ˜ๅˆฅๅญใ‚ญใƒผใ€‚ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใงใฏใชใใ€ใใ‚Œใ‚’ๅˆฉ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใง็‹ฌ่‡ชใซ็ฎก็†ใ™ใ‚‹่ญ˜ๅˆฅๅญใ‚ญใƒผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "ๆณจๆ–‡ๅใ€‚ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒˆใงใฏใชใใ€ใ“ใ‚Œใ‚’ๅˆฉ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใง็™บ่กŒใ—ใŸๆณจๆ–‡ๅ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string" + }, + "customerBirthday": { + "description": "้กงๅฎขใฎ็”Ÿๅนดๆœˆๆ—ฅใ€‚่กจ่จ˜ๅฝขๅผYYMMDD.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "pattern": "^([0-9]{2})(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$" + }, + "customerEmail": { + "description": "ใŠๅฎขๆง˜ใฎใƒกใƒผใƒซ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "string", + "format": "email" + }, + "vbv": { + "$ref": "#/components/schemas/__type.o1" + }, + "__approved": { + "description": "ๆ”ฏๆ‰•ใ„ใ‚’ๆ‰ฟ่ชใ™ใ‚‹ใ‹ใฉใ†ใ‹ใ€‚ๅฝใฎใƒ•ใ‚งใ‚คใƒกใƒณใƒˆใ‚ตใƒผใƒใƒผ `fake-toss-payments-server` ใงใฎใฟไฝฟ็”จใ•ใ‚Œใ‚‹ๅ€คใจใ—ใฆใ€ๆฑบๆธˆๆ‰ฟ่ชใ‚’ๆ„ๅ›ณ็š„ใซ้…ๅปถใ•ใ›ใŸใ‚Šใ™ใ‚‹ใจใใซไฝฟ็”จใ•ใ‚Œใ‚‹ใ€‚ใ“ใฎๅ€คใ‚’ `false` ใซใ™ใ‚‹ใจใ€ใƒ•ใƒญใƒณใƒˆใ‚ขใƒ—ใƒชใ‚ฑใƒผใ‚ทใƒงใƒณใŒใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใŒๆไพ›ใ™ใ‚‹ๆฑบๆธˆใ‚ฆใ‚ฃใƒณใƒ‰ใ‚ฆใ‚’ไฝฟใฃใฆๆฑบๆธˆใ‚’้€ฒ่กŒใ™ใ‚‹็Šถๆณใ‚’ใ‚ทใƒŸใƒฅใƒฌใƒผใƒˆใงใใพใ™ใ€‚ใƒœใƒณใƒ‡ใ‚ฃใƒผใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใ‚ตใƒผใƒใƒผใฏใƒ•ใƒญใƒณใƒˆใ‚ขใƒ—ใƒชใ‚ฑใƒผใ‚ทใƒงใƒณใงใƒใƒƒใ‚ฏใ‚จใƒณใƒ‰ใ‚ตใƒผใƒใƒผใ‚’็ตŒ็”ฑใ›ใšใ€ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใŒๆไพ›ใ™ใ‚‹ๆฑบๆธˆใ‚ฆใ‚ฃใƒณใƒ‰ใ‚ฆใ‚’ๅˆฉ็”จใ—ใฆ็›ดๆŽฅๆฑบๆธˆใ‚’่ฆๆฑ‚ใ™ใ‚‹ๅ ดๅˆใ€ใƒใƒƒใ‚ฏใ‚จใƒณใƒ‰ใงใ“ใ‚Œใ‚’ๅˆฅ้€”{@link functional.payments.approveๆ‰ฟ่ช}ๅ‡ฆ็†ใ™ใ‚‹ใพใงๆญฃๅผๆฑบๆธˆใงไบบๆธ…ๆฒปใ—ใชใ„ใ€‚ไธ€ๆ–นใ€ใƒใƒƒใ‚ฏใ‚จใƒณใƒ‰ใ‚ตใƒผใƒใƒผใงใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใ‚ตใƒผใƒใƒผใฎAPIใ‚’ๅ‘ผใณๅ‡บใ™ๅ ดๅˆใ€ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใฏใใ‚Œใ‚’ๅณๅบงใซๆ‰ฟ่ชใ—ใ€ `fake-toss-payments-server` ใงๅˆฅ้€”ใฎๆ‰ฟ่ชๅ‡ฆ็†ใŒๅฟ…่ฆใช็Šถๆณใ‚’ใ‚ทใƒŸใƒฅใƒฌใƒผใƒˆใ™ใ‚‹ใŸใ‚ใซใฏใ€ใ“ใ‚Œใ‚‰ใฎๅฑžๆ€งใŒๅฟ…่ฆใชใ‚‚ใฎ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "boolean" + } + }, + "required": [ + "method", + "cardNumber", + "cardExpirationYear", + "cardExpirationMonth", + "amount", + "orderId" + ], + "description": "ใ‚ฏใƒฌใ‚ธใƒƒใƒˆใ‚ซใƒผใƒ‰ใ‚’ๅˆฉ็”จใ—ใŸๆฑบๆธˆ็”ณ่ซ‹ๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [] + }, + "__type.o1": { + "type": "object", + "properties": { + "cavv": { + "description": "3D Secure่ช่จผใ‚ปใƒƒใ‚ทใƒงใƒณใฎ่ช่จผๅ€ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "xid": { + "description": "ใƒˆใƒฉใƒณใ‚ถใ‚ฏใ‚ทใƒงใƒณID.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "eci": { + "description": "3DS่ช่จผ็ตๆžœใฎใ‚ณใƒผใƒ‰ๅ€ค.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "cavv", + "xid", + "eci" + ], + "x-typia-jsDocTags": [] + }, + "ITossPayment.IApproval": { + "type": "object", + "properties": { + "orderId": { + "description": "ๆณจๆ–‡่ญ˜ๅˆฅๅญใ‚ญใƒผใ€‚ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใงใฏใชใใ€ใใ‚Œใ‚’ๅˆฉ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใง็‹ฌ่‡ชใซ็ฎก็†ใ™ใ‚‹่ญ˜ๅˆฅๅญใ‚ญใƒผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "ใŠๆ”ฏๆ‰•ใ„็ท้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + } + }, + "required": [ + "orderId", + "amount" + ], + "description": "ใŠๆ”ฏๆ‰•ใ„ๆ‰ฟ่ชๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [] + }, + "ITossPaymentCancel.IStore": { + "type": "object", + "properties": { + "paymentKey": { + "description": "{@link ITossPayment}ใฎ่ญ˜ๅˆฅๅญใ‚ญใƒผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "cancelReason": { + "description": "ใ‚ญใƒฃใƒณใ‚ปใƒซ็†็”ฑ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "cancelAmount": { + "description": "ใ‚ญใƒฃใƒณใ‚ปใƒซ็ท้ก.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "refundReceiveAccount": { + "$ref": "#/components/schemas/__type.o2" + }, + "taxAmount": { + "description": "่ชฒ็จŽๅ‡ฆ็†้ก.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "taxFreeAmount": { + "description": "ๅ…็จŽๅ‡ฆ็†้ก.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + }, + "refundableAmount": { + "description": "ใŠๆ”ฏๆ‰•ใ„ใฎใ‚ญใƒฃใƒณใ‚ปใƒซๅพŒใฎๆ‰•ใ„ๆˆปใ—ๅฏ่ƒฝๆฎ‹้ซ˜.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "number" + } + }, + "required": [ + "paymentKey", + "cancelReason" + ], + "description": "ๆฑบๆธˆใ‚ญใƒฃใƒณใ‚ปใƒซ็”ณ่ซ‹ๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [] + }, + "__type.o2": { + "type": "object", + "properties": { + "bank": { + "description": "้Š€่กŒๆƒ…ๅ ฑ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "accountNumber": { + "description": "ๅฃๅบง็•ชๅท.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string", + "pattern": "^[0-9]{0,20}$" + }, + "holderName": { + "description": "้ ้‡‘ๆ ช.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + } + }, + "required": [ + "bank", + "accountNumber", + "holderName" + ], + "x-typia-jsDocTags": [] + }, + "ITossVirtualAccountPayment.IStore": { + "type": "object", + "properties": { + "method": { + "const": "virtual-account", + "description": "ใŠๆ”ฏๆ‰•ใ„ๆ–นๆณ•ใŒไปฎๆƒณใ‚ขใ‚ซใ‚ฆใƒณใƒˆใงใ‚ใ‚‹ใ“ใจใ‚’ๆ„ๅ‘ณใ—ใพใ™.", + "x-typia-required": true, + "x-typia-optional": false + }, + "orderId": { + "description": "ๆณจๆ–‡่ญ˜ๅˆฅๅญ็•ชๅทใ€‚ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใงใฏใชใใ€ใใ‚Œใ‚’ๅˆฉ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใง็‹ฌ่‡ชใซ็ฎก็†ใ™ใ‚‹่ญ˜ๅˆฅๅญใ‚ญใƒผ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "orderName": { + "description": "ๆณจๆ–‡ๅใ€‚ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒˆใงใฏใชใใ€ใ“ใ‚Œใ‚’ๅˆฉ็”จใ™ใ‚‹ใ‚ตใƒผใƒ“ใ‚นใง็™บ่กŒใ—ใŸๆณจๆ–‡ๅ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "bank": { + "description": "้Š€่กŒๅ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "customerName": { + "description": "้กงๅฎขๅ.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "string" + }, + "amount": { + "description": "ใŠๆ”ฏๆ‰•ใ„็ท้ก.", + "x-typia-required": true, + "x-typia-optional": false, + "type": "number" + }, + "__approved": { + "description": "ๆ”ฏๆ‰•ใ„ใ‚’ๆ‰ฟ่ชใ™ใ‚‹ใ‹ใฉใ†ใ‹ใ€‚ๅฝใฎใƒ•ใ‚งใ‚คใƒกใƒณใƒˆใ‚ตใƒผใƒใƒผ `fake-toss-payments-server` ใงใฎใฟไฝฟ็”จใ•ใ‚Œใ‚‹ๅ€คใจใ—ใฆใ€ๆฑบๆธˆๆ‰ฟ่ชใ‚’ๆ„ๅ›ณ็š„ใซ้…ๅปถใ•ใ›ใŸใ‚Šใ™ใ‚‹ใจใใซไฝฟ็”จใ•ใ‚Œใ‚‹ใ€‚ใ“ใฎๅ€คใ‚’ `false` ใซใ™ใ‚‹ใจใ€ใƒ•ใƒญใƒณใƒˆใ‚ขใƒ—ใƒชใ‚ฑใƒผใ‚ทใƒงใƒณใŒใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใŒๆไพ›ใ™ใ‚‹ๆฑบๆธˆใ‚ฆใ‚ฃใƒณใƒ‰ใ‚ฆใ‚’ไฝฟใฃใฆๆฑบๆธˆใ‚’้€ฒ่กŒใ™ใ‚‹็Šถๆณใ‚’ใ‚ทใƒŸใƒฅใƒฌใƒผใƒˆใงใใพใ™ใ€‚ใƒœใƒณใƒ‡ใ‚ฃใƒผใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใ‚ตใƒผใƒใƒผใฏใƒ•ใƒญใƒณใƒˆใ‚ขใƒ—ใƒชใ‚ฑใƒผใ‚ทใƒงใƒณใงใƒใƒƒใ‚ฏใ‚จใƒณใƒ‰ใ‚ตใƒผใƒใƒผใ‚’็ตŒ็”ฑใ›ใšใ€ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใŒๆไพ›ใ™ใ‚‹ๆฑบๆธˆใ‚ฆใ‚ฃใƒณใƒ‰ใ‚ฆใ‚’ๅˆฉ็”จใ—ใฆ็›ดๆŽฅๆฑบๆธˆใ‚’่ฆๆฑ‚ใ™ใ‚‹ๅ ดๅˆใ€ใƒใƒƒใ‚ฏใ‚จใƒณใƒ‰ใงใ“ใ‚Œใ‚’ๅˆฅ้€”{@link functional.payments.approveๆ‰ฟ่ช}ๅ‡ฆ็†ใ™ใ‚‹ใพใงๆญฃๅผๆฑบๆธˆใงไบบๆธ…ๆฒปใ—ใชใ„ใ€‚ไธ€ๆ–นใ€ใƒใƒƒใ‚ฏใ‚จใƒณใƒ‰ใ‚ตใƒผใƒใƒผใงใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใ‚ตใƒผใƒใƒผใฎAPIใ‚’ๅ‘ผใณๅ‡บใ™ๅ ดๅˆใ€ใƒˆใ‚นใƒ•ใ‚งใ‚คใƒกใƒณใƒ„ใฏใใ‚Œใ‚’ๅณๅบงใซๆ‰ฟ่ชใ—ใ€ `fake-toss-payments-server` ใงๅˆฅ้€”ใฎๆ‰ฟ่ชๅ‡ฆ็†ใŒๅฟ…่ฆใช็Šถๆณใ‚’ใ‚ทใƒŸใƒฅใƒฌใƒผใƒˆใ™ใ‚‹ใŸใ‚ใซใฏใ€ใ“ใ‚Œใ‚‰ใฎๅฑžๆ€งใŒๅฟ…่ฆใชใ‚‚ใฎ.", + "x-typia-required": false, + "x-typia-optional": true, + "type": "boolean" + } + }, + "required": [ + "method", + "orderId", + "orderName", + "bank", + "customerName", + "amount" + ], + "description": "ไปฎๆƒณๅฃๅบงใ‚’ๅˆฉ็”จใ—ใŸๆฑบๆธˆ็”ณ่ซ‹ๆƒ…ๅ ฑ.", + "x-typia-jsDocTags": [] + } + }, + "securitySchemes": { + "basic": { + "type": "apiKey", + "name": "Authorization", + "in": "header" + } + } + }, + "x-samchon-emended": true +} \ No newline at end of file diff --git a/assets/output/uber.swagger.ar.json b/assets/output/uber.swagger.ar.json new file mode 100644 index 0000000..1f2b54d --- /dev/null +++ b/assets/output/uber.swagger.ar.json @@ -0,0 +1,482 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช ุฃูˆุจุฑ", + "description": "ุงู†ู‚ู„ ุชุทุจูŠู‚ูƒ ุฅู„ู‰ ุงู„ุฃู…ุงู… ุจุงุณุชุฎุฏุงู… ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุชุทุจูŠู‚ุงุช Uber", + "version": "1.0.0" + }, + "components": { + "schemas": { + "Product": { + "properties": { + "product_id": { + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ูŠู…ุซู„ ู…ู†ุชุฌู‹ุง ู…ุนูŠู†ู‹ุง ู„ุฎุท ุนุฑุถ ูˆุฎุท ุทูˆู„ ู…ุนูŠู†ูŠู†. ุนู„ู‰ ุณุจูŠู„ ุงู„ู…ุซุงู„ุŒ ุณูŠูƒูˆู† ู„ุฏู‰ uberX ููŠ ุณุงู† ูุฑุงู†ุณูŠุณูƒูˆ ู…ุนุฑู ู…ู†ุชุฌ ู…ุฎุชู„ู ุนู† uberX ููŠ ู„ูˆุณ ุฃู†ุฌู„ูˆุณ." + }, + "description": { + "type": "string", + "description": "ูˆุตู ุงู„ู…ู†ุชุฌ." + }, + "display_name": { + "type": "string", + "description": "ุงุณู… ุงู„ุนุฑุถ ู„ู„ู…ู†ุชุฌ." + }, + "capacity": { + "type": "string", + "description": "ุณุนุฉ ุงู„ู…ู†ุชุฌ. ุนู„ู‰ ุณุจูŠู„ ุงู„ู…ุซุงู„ุŒ 4 ุฃุดุฎุงุต." + }, + "image": { + "type": "string", + "description": "ุนู†ูˆุงู† URL ู„ู„ุตูˆุฑุฉ ุงู„ุชูŠ ุชู…ุซู„ ุงู„ู…ู†ุชุฌ." + } + } + }, + "PriceEstimate": { + "properties": { + "product_id": { + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ูŠู…ุซู„ ู…ู†ุชุฌู‹ุง ู…ุนูŠู†ู‹ุง ู„ุฎุท ุนุฑุถ ูˆุฎุท ุทูˆู„ ู…ุนูŠู†ูŠู†. ุนู„ู‰ ุณุจูŠู„ ุงู„ู…ุซุงู„ุŒ ุณูŠูƒูˆู† ู„ุฏู‰ uberX ููŠ ุณุงู† ูุฑุงู†ุณูŠุณูƒูˆ ู…ุนุฑู ู…ู†ุชุฌ ู…ุฎุชู„ู ุนู† uberX ููŠ ู„ูˆุณ ุฃู†ุฌู„ูˆุณ" + }, + "currency_code": { + "type": "string", + "description": "[ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) ุฑู…ุฒ ุงู„ุนู…ู„ุฉ." + }, + "display_name": { + "type": "string", + "description": "ุงุณู… ุงู„ุนุฑุถ ู„ู„ู…ู†ุชุฌ." + }, + "estimate": { + "type": "string", + "description": "ุณู„ุณู„ุฉ ู…ู†ุณู‚ุฉ ู…ู† ุงู„ุชู‚ุฏูŠุฑุงุช ุจุงู„ุนู…ู„ุฉ ุงู„ู…ุญู„ูŠุฉ ู„ู…ูˆู‚ุน ุงู„ุจุฏุงูŠุฉ. ูŠู…ูƒู† ุฃู† ูŠูƒูˆู† ุงู„ุชู‚ุฏูŠุฑ ุนุจุงุฑุฉ ุนู† ู†ุทุงู‚ ุฃูˆ ุฑู‚ู… ูˆุงุญุฏ (ุณุนุฑ ุซุงุจุช) ุฃูˆ "ู…ุญุฏุฏ ุจุงู„ุนุฏุงุฏ" ู„ุณูŠุงุฑุงุช ุงู„ุฃุฌุฑุฉ." + }, + "low_estimate": { + "type": "number", + "description": "ุงู„ุญุฏ ุงู„ุฃุฏู†ู‰ ู„ู„ุณุนุฑ ุงู„ุชู‚ุฏูŠุฑูŠ." + }, + "high_estimate": { + "type": "number", + "description": "ุงู„ุญุฏ ุงู„ุฃุนู„ู‰ ู„ู„ุณุนุฑ ุงู„ุชู‚ุฏูŠุฑูŠ." + }, + "surge_multiplier": { + "type": "number", + "description": "ู…ุถุงุนู ุงู„ุงุฑุชูุงุน ุงู„ู…ุชูˆู‚ุน. ูŠูƒูˆู† ุงู„ุงุฑุชูุงุน ู†ุดุทู‹ุง ุฅุฐุง ูƒุงู† ู…ุถุงุนู ุงู„ุงุฑุชูุงุน ุฃูƒุจุฑ ู…ู† 1. ูŠุฃุฎุฐ ุชู‚ุฏูŠุฑ ุงู„ุณุนุฑ ููŠ ุงู„ุงุนุชุจุงุฑ ุจุงู„ูุนู„ ู…ุถุงุนู ุงู„ุงุฑุชูุงุน." + } + } + }, + "Profile": { + "properties": { + "first_name": { + "type": "string", + "description": "ุงู„ุงุณู… ุงู„ุฃูˆู„ ู„ู…ุณุชุฎุฏู… ุฃูˆุจุฑ." + }, + "last_name": { + "type": "string", + "description": "ุงู„ู„ู‚ุจ ุงู„ุฎุงุต ุจู…ุณุชุฎุฏู… ุฃูˆุจุฑ." + }, + "email": { + "type": "string", + "description": "ุนู†ูˆุงู† ุงู„ุจุฑูŠุฏ ุงู„ุฅู„ูƒุชุฑูˆู†ูŠ ู„ู…ุณุชุฎุฏู… ุฃูˆุจุฑ" + }, + "picture": { + "type": "string", + "description": "ุฑุงุจุท ุตูˆุฑุฉ ู…ุณุชุฎุฏู… ุฃูˆุจุฑ." + }, + "promo_code": { + "type": "string", + "description": "ูƒูˆุฏ ุฎุตู… ุงูˆุจุฑ ู„ู„ู…ุณุชุฎุฏู…." + } + } + }, + "Activity": { + "properties": { + "uuid": { + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ู„ู„ู†ุดุงุท" + } + } + }, + "Activities": { + "properties": { + "offset": { + "type": "integer", + "format": "int32", + "description": "ุงู„ู…ูˆุถุน ููŠ ุงู„ุชุฑู‚ูŠู…." + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "ุนุฏุฏ ุงู„ุนู†ุงุตุฑ ุงู„ู…ุทู„ูˆุจ ุงุณุชุฑุฌุงุนู‡ุง (100 ูƒุญุฏ ุฃู‚ุตู‰)." + }, + "count": { + "type": "integer", + "format": "int32", + "description": "ุงู„ุนุฏุฏ ุงู„ุฅุฌู…ุงู„ูŠ ู„ู„ุนู†ุงุตุฑ ุงู„ู…ุชุงุญุฉ." + }, + "history": { + "type": "array", + "items": { + "$ref": "#/definitions/Activity" + } + } + } + }, + "Error": { + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "fields": { + "type": "string" + } + } + } + } + }, + "paths": { + "/products": { + "get": { + "summary": "ุฃู†ูˆุงุน ุงู„ู…ู†ุชุฌุงุช", + "description": "ุชุนูŠุฏ ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ ุงู„ู…ู†ุชุฌุงุช ู…ุนู„ูˆู…ุงุช ุญูˆู„ ู…ู†ุชุฌุงุช Uber ุงู„ู…ุนุฑูˆุถุฉ ููŠ ู…ูˆู‚ุน ู…ุนูŠู†. ุชุชุถู…ู† ุงู„ุงุณุชุฌุงุจุฉ ุงุณู… ุงู„ุนุฑุถ ูˆุชูุงุตูŠู„ ุฃุฎุฑู‰ ุญูˆู„ ูƒู„ ู…ู†ุชุฌุŒ ูˆุชุณุฑุฏ ุงู„ู…ู†ุชุฌุงุช ุจุงู„ุชุฑุชูŠุจ ุงู„ุตุญูŠุญ ู„ู„ุนุฑุถ.", + "parameters": [ + { + "name": "latitude", + "in": "query", + "description": "ู…ูƒูˆู† ุฎุท ุงู„ุนุฑุถ ู„ู„ู…ูˆู‚ุน.", + "schema": { + "name": "latitude", + "in": "query", + "description": "ู…ูƒูˆู† ุฎุท ุงู„ุนุฑุถ ู„ู„ู…ูˆู‚ุน.", + "required": true, + "type": "number", + "format": "double" + }, + "required": true + }, + { + "name": "longitude", + "in": "query", + "description": "ู…ูƒูˆู† ุฎุท ุงู„ุทูˆู„ ู„ู„ู…ูˆู‚ุน.", + "schema": { + "name": "longitude", + "in": "query", + "description": "ู…ูƒูˆู† ุฎุท ุงู„ุทูˆู„ ู„ู„ู…ูˆู‚ุน.", + "required": true, + "type": "number", + "format": "double" + }, + "required": true + } + ], + "tags": [ + "Products" + ], + "responses": { + "200": { + "description": "ู…ุฌู…ูˆุนุฉ ู…ู† ุงู„ู…ู†ุชุฌุงุช", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + } + } + } + }, + "default": { + "description": "ุฎุทุฃ ุบูŠุฑ ู…ุชูˆู‚ุน", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/estimates/price": { + "get": { + "summary": "ุชู‚ุฏูŠุฑุงุช ุงู„ุฃุณุนุงุฑ", + "description": "ุชุนูŠุฏ ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ ุชู‚ุฏูŠุฑุงุช ุงู„ุฃุณุนุงุฑ ู†ุทุงู‚ ุงู„ุณุนุฑ ุงู„ุชู‚ุฏูŠุฑูŠ ู„ูƒู„ ู…ู†ุชุฌ ู…ุนุฑูˆุถ ููŠ ู…ูˆู‚ุน ู…ุนูŠู†. ูŠุชู… ุชูˆููŠุฑ ุชู‚ุฏูŠุฑ ุงู„ุณุนุฑ ูƒุณู„ุณู„ุฉ ู…ู†ุณู‚ุฉ ุชุชุถู…ู† ู†ุทุงู‚ ุงู„ุณุนุฑ ุงู„ูƒุงู…ู„ ูˆุฑู…ุฒ ุงู„ุนู…ู„ุฉ ุงู„ู…ุญู„ูŠุฉ.

ุชุชุถู…ู† ุงู„ุงุณุชุฌุงุจุฉ ุฃูŠุถู‹ุง ุชู‚ุฏูŠุฑุงุช ู…ู†ุฎูุถุฉ ูˆู…ุฑุชูุนุฉุŒ ูˆุฑู…ุฒ ุงู„ุนู…ู„ุฉ [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) ู„ู„ู…ูˆุงู‚ู ุงู„ุชูŠ ุชุชุทู„ุจ ุชุญูˆูŠู„ ุงู„ุนู…ู„ุงุช. ุนู†ุฏู…ุง ูŠูƒูˆู† surge ู†ุดุทู‹ุง ู„ู…ู†ุชุฌ ู…ุนูŠู†ุŒ ูุฅู† ู…ุถุงุนู surge ุงู„ุฎุงุต ุจู‡ ุณูŠูƒูˆู† ุฃูƒุจุฑ ู…ู† 1ุŒ ู„ูƒู† ุชู‚ุฏูŠุฑ ุงู„ุณุนุฑ ูŠุฃุฎุฐ ู‡ุฐุง ุงู„ู…ุถุงุนู ููŠ ุงู„ุงุนุชุจุงุฑ ุจุงู„ูุนู„.", + "parameters": [ + { + "name": "start_latitude", + "in": "query", + "description": "ู…ูƒูˆู† ุฎุท ุงู„ุนุฑุถ ู„ู…ูˆู‚ุน ุงู„ุจุฏุงูŠุฉ.", + "schema": { + "name": "start_latitude", + "in": "query", + "description": "ู…ูƒูˆู† ุฎุท ุงู„ุนุฑุถ ู„ู…ูˆู‚ุน ุงู„ุจุฏุงูŠุฉ.", + "required": true, + "type": "number", + "format": "double" + }, + "required": true + }, + { + "name": "start_longitude", + "in": "query", + "description": "ู…ูƒูˆู† ุฎุท ุงู„ุทูˆู„ ู„ู…ูˆู‚ุน ุงู„ุจุฏุงูŠุฉ.", + "schema": { + "name": "start_longitude", + "in": "query", + "description": "ู…ูƒูˆู† ุฎุท ุงู„ุทูˆู„ ู„ู…ูˆู‚ุน ุงู„ุจุฏุงูŠุฉ.", + "required": true, + "type": "number", + "format": "double" + }, + "required": true + }, + { + "name": "end_latitude", + "in": "query", + "description": "ู…ูƒูˆู† ุฎุท ุงู„ุนุฑุถ ู„ู„ู…ูˆู‚ุน ุงู„ู†ู‡ุงุฆูŠ.", + "schema": { + "name": "end_latitude", + "in": "query", + "description": "ู…ูƒูˆู† ุฎุท ุงู„ุนุฑุถ ู„ู„ู…ูˆู‚ุน ุงู„ู†ู‡ุงุฆูŠ.", + "required": true, + "type": "number", + "format": "double" + }, + "required": true + }, + { + "name": "end_longitude", + "in": "query", + "description": "ู…ูƒูˆู† ุฎุท ุงู„ุทูˆู„ ู„ู„ู…ูˆู‚ุน ุงู„ู†ู‡ุงุฆูŠ.", + "schema": { + "name": "end_longitude", + "in": "query", + "description": "ู…ูƒูˆู† ุฎุท ุงู„ุทูˆู„ ู„ู„ู…ูˆู‚ุน ุงู„ู†ู‡ุงุฆูŠ.", + "required": true, + "type": "number", + "format": "double" + }, + "required": true + } + ], + "tags": [ + "Estimates" + ], + "responses": { + "200": { + "description": "ู…ุฌู…ูˆุนุฉ ู…ู† ุชู‚ุฏูŠุฑุงุช ุงู„ุฃุณุนุงุฑ ุญุณุจ ุงู„ู…ู†ุชุฌ", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PriceEstimate" + } + } + } + } + }, + "default": { + "description": "ุฎุทุฃ ุบูŠุฑ ู…ุชูˆู‚ุน", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/estimates/time": { + "get": { + "summary": "ุชู‚ุฏูŠุฑุงุช ุงู„ูˆู‚ุช", + "description": "ุชุนูŠุฏ ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ ุชู‚ุฏูŠุฑุงุช ุงู„ูˆู‚ุช ุชู‚ุฏูŠุฑุงุช ุงู„ูˆุตูˆู„ ุงู„ู…ุชูˆู‚ุนุฉ ู„ุฌู…ูŠุน ุงู„ู…ู†ุชุฌุงุช ุงู„ู…ุนุฑูˆุถุฉ ููŠ ู…ูˆู‚ุน ู…ุนูŠู†ุŒ ู…ุน ุงู„ุชุนุจูŠุฑ ุนู† ุงู„ุงุณุชุฌุงุจุงุช ูƒุฃุนุฏุงุฏ ุตุญูŠุญุฉ ุจุงู„ุซูˆุงู†ูŠ. ู†ูˆุตูŠ ุจุงุณุชุฏุนุงุก ู‡ุฐู‡ ุงู„ู†ู‚ุทุฉ ุงู„ู†ู‡ุงุฆูŠุฉ ูƒู„ ุฏู‚ูŠู‚ุฉ ู„ุชูˆููŠุฑ ุชู‚ุฏูŠุฑุงุช ุงู„ูˆุตูˆู„ ุงู„ู…ุชูˆู‚ุนุฉ ุงู„ุฃูƒุซุฑ ุฏู‚ุฉ ูˆุญุฏุงุซุฉ.", + "parameters": [ + { + "name": "start_latitude", + "in": "query", + "description": "ู…ูƒูˆู† ุฎุท ุงู„ุนุฑุถ ู„ู…ูˆู‚ุน ุงู„ุจุฏุงูŠุฉ.", + "schema": { + "name": "start_latitude", + "in": "query", + "description": "ู…ูƒูˆู† ุฎุท ุงู„ุนุฑุถ ู„ู…ูˆู‚ุน ุงู„ุจุฏุงูŠุฉ.", + "required": true, + "type": "number", + "format": "double" + }, + "required": true + }, + { + "name": "start_longitude", + "in": "query", + "description": "ู…ูƒูˆู† ุฎุท ุงู„ุทูˆู„ ู„ู…ูˆู‚ุน ุงู„ุจุฏุงูŠุฉ.", + "schema": { + "name": "start_longitude", + "in": "query", + "description": "ู…ูƒูˆู† ุฎุท ุงู„ุทูˆู„ ู„ู…ูˆู‚ุน ุงู„ุจุฏุงูŠุฉ.", + "required": true, + "type": "number", + "format": "double" + }, + "required": true + }, + { + "name": "customer_uuid", + "in": "query", + "description": "ู…ุนุฑู ุนู…ูŠู„ ูุฑูŠุฏ ุณูŠุชู… ุงุณุชุฎุฏุงู…ู‡ ู„ุชุฎุตูŠุต ุงู„ุชุฌุฑุจุฉ.", + "schema": { + "name": "customer_uuid", + "in": "query", + "type": "string", + "format": "uuid", + "description": "ู…ุนุฑู ุนู…ูŠู„ ูุฑูŠุฏ ุณูŠุชู… ุงุณุชุฎุฏุงู…ู‡ ู„ุชุฎุตูŠุต ุงู„ุชุฌุฑุจุฉ." + }, + "required": true + }, + { + "name": "product_id", + "in": "query", + "description": "ู…ุนุฑู ูุฑูŠุฏ ูŠู…ุซู„ ู…ู†ุชุฌู‹ุง ู…ุญุฏุฏู‹ุง ู„ุฎุท ุนุฑุถ ูˆุฎุท ุทูˆู„ ู…ุนูŠู†ูŠู†.", + "schema": { + "name": "product_id", + "in": "query", + "type": "string", + "description": "ู…ุนุฑู ูุฑูŠุฏ ูŠู…ุซู„ ู…ู†ุชุฌู‹ุง ู…ุญุฏุฏู‹ุง ู„ุฎุท ุนุฑุถ ูˆุฎุท ุทูˆู„ ู…ุนูŠู†ูŠู†." + }, + "required": true + } + ], + "tags": [ + "Estimates" + ], + "responses": { + "200": { + "description": "ู…ุฌู…ูˆุนุฉ ู…ู† ุงู„ู…ู†ุชุฌุงุช", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + } + } + } + }, + "default": { + "description": "ุฎุทุฃ ุบูŠุฑ ู…ุชูˆู‚ุน", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/me": { + "get": { + "summary": "ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ ู„ู„ู…ุณุชุฎุฏู…", + "description": "ุชุนูŠุฏ ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ ู…ู„ู ุชุนุฑูŠู ุงู„ู…ุณุชุฎุฏู… ู…ุนู„ูˆู…ุงุช ุญูˆู„ ู…ุณุชุฎุฏู… Uber ุงู„ุฐูŠ ุชู… ุชููˆูŠุถู‡ ุจุงู„ุชุทุจูŠู‚.", + "tags": [ + "User" + ], + "responses": { + "200": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ู…ู„ู ุงู„ุดุฎุตูŠ ู„ู„ู…ุณุชุฎุฏู…", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Profile" + } + } + } + }, + "default": { + "description": "ุฎุทุฃ ุบูŠุฑ ู…ุชูˆู‚ุน", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/history": { + "get": { + "summary": "ู†ุดุงุท ุงู„ู…ุณุชุฎุฏู…", + "description": "ุชุนูŠุฏ ู†ู‚ุทุฉ ู†ู‡ุงูŠุฉ ู†ุดุงุท ุงู„ู…ุณุชุฎุฏู… ุจูŠุงู†ุงุช ุญูˆู„ ู†ุดุงุท ุงู„ู…ุณุชุฎุฏู… ุทูˆุงู„ ุญูŠุงุชู‡ ู…ุน ุฃูˆุจุฑ. ุณุชุชุถู…ู† ุงู„ุงุณุชุฌุงุจุฉ ู…ูˆุงู‚ุน ูˆุฃูˆู‚ุงุช ุงู„ุงุณุชู„ุงู…ุŒ ูˆู…ูˆุงู‚ุน ูˆุฃูˆู‚ุงุช ุงู„ุชุณู„ูŠู…ุŒ ูˆุงู„ู…ุณุงูุฉ ุงู„ุชูŠ ู‚ุทุนุชู‡ุง ุงู„ุทู„ุจุงุช ุงู„ุณุงุจู‚ุฉุŒ ูˆู…ุนู„ูˆู…ุงุช ุญูˆู„ ุงู„ู…ู†ุชุฌุงุช ุงู„ุชูŠ ุชู… ุทู„ุจู‡ุง.

ุณูŠูƒูˆู† ู„ู…ุตููˆูุฉ ุงู„ุชุงุฑูŠุฎ ููŠ ุงู„ุงุณุชุฌุงุจุฉ ุทูˆู„ ุฃู‚ุตู‰ ุจู†ุงุกู‹ ุนู„ู‰ ู…ุนู„ู…ุฉ ุงู„ุญุฏ. ู‚ุฏ ูŠุชุฌุงูˆุฒ ุนุฏุฏ ู‚ูŠู… ุงู„ุงุณุชุฌุงุจุฉ ุงู„ุญุฏุŒ ูˆุจุงู„ุชุงู„ูŠ ู‚ุฏ ุชูƒูˆู† ุทู„ุจุงุช API ุงู„ู„ุงุญู‚ุฉ ุถุฑูˆุฑูŠุฉ.", + "parameters": [ + { + "name": "offset", + "in": "query", + "description": "ุชุนูˆูŠุถ ู‚ุงุฆู…ุฉ ุงู„ู†ุชุงุฆุฌ ุงู„ุชูŠ ุชู… ุฅุฑุฌุงุนู‡ุง ุจู‡ุฐุง ุงู„ู…ุจู„ุบ. ุงู„ู‚ูŠู…ุฉ ุงู„ุงูุชุฑุงุถูŠุฉ ู‡ูŠ ุตูุฑ.", + "schema": { + "name": "offset", + "in": "query", + "type": "integer", + "format": "int32", + "description": "ุชุนูˆูŠุถ ู‚ุงุฆู…ุฉ ุงู„ู†ุชุงุฆุฌ ุงู„ุชูŠ ุชู… ุฅุฑุฌุงุนู‡ุง ุจู‡ุฐุง ุงู„ู…ุจู„ุบ. ุงู„ู‚ูŠู…ุฉ ุงู„ุงูุชุฑุงุถูŠุฉ ู‡ูŠ ุตูุฑ." + }, + "required": true + }, + { + "name": "limit", + "in": "query", + "description": "ุนุฏุฏ ุงู„ุนู†ุงุตุฑ ุงู„ู…ุทู„ูˆุจ ุงุณุชุฑุฌุงุนู‡ุง. ุงู„ุงูุชุฑุงุถูŠ ู‡ูˆ 5ุŒ ูˆุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ ู‡ูˆ 100.", + "schema": { + "name": "limit", + "in": "query", + "type": "integer", + "format": "int32", + "description": "ุนุฏุฏ ุงู„ุนู†ุงุตุฑ ุงู„ู…ุทู„ูˆุจ ุงุณุชุฑุฌุงุนู‡ุง. ุงู„ุงูุชุฑุงุถูŠ ู‡ูˆ 5ุŒ ูˆุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ ู‡ูˆ 100." + }, + "required": true + } + ], + "tags": [ + "User" + ], + "responses": { + "200": { + "description": "ู…ุนู„ูˆู…ุงุช ุงู„ุชุงุฑูŠุฎ ู„ู„ู…ุณุชุฎุฏู… ุงู„ู…ุญุฏุฏ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Activities" + } + } + } + }, + "default": { + "description": "ุฎุทุฃ ุบูŠุฑ ู…ุชูˆู‚ุน", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + } + }, + "servers": [ + { + "url": "api.uber.com" + } + ], + "x-samchon-emended": true +} \ No newline at end of file diff --git a/assets/output/uber.swagger.ja.json b/assets/output/uber.swagger.ja.json new file mode 100644 index 0000000..fed16fa --- /dev/null +++ b/assets/output/uber.swagger.ja.json @@ -0,0 +1,482 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "ใ‚ฆใƒผใƒใƒผAPI", + "description": "Uber API ใงใ‚ขใƒ—ใƒชใ‚’ๅ‰้€ฒใ•ใ›ใพใ—ใ‚‡ใ†", + "version": "1.0.0" + }, + "components": { + "schemas": { + "Product": { + "properties": { + "product_id": { + "type": "string", + "description": "็‰นๅฎšใฎ็ทฏๅบฆใจ็ตŒๅบฆใซๅฏพๅฟœใ™ใ‚‹็‰นๅฎšใฎ่ฃฝๅ“ใ‚’่กจใ™ไธ€ๆ„ใฎ่ญ˜ๅˆฅๅญใ€‚ใŸใจใˆใฐใ€ใ‚ตใƒณใƒ•ใƒฉใƒณใ‚ทใ‚นใ‚ณใฎ uberX ใฏใ€ใƒญใ‚ตใƒณใ‚ผใƒซใ‚นใฎ uberX ใจใฏ็•ฐใชใ‚‹ product_id ใ‚’ๆŒใกใพใ™ใ€‚." + }, + "description": { + "type": "string", + "description": "่ฃฝๅ“ใฎ่ชฌๆ˜Ž." + }, + "display_name": { + "type": "string", + "description": "่ฃฝๅ“ใฎ่กจ็คบๅ." + }, + "capacity": { + "type": "string", + "description": "่ฃฝๅ“ใฎๅŽๅฎนไบบๆ•ฐใ€‚ไพ‹๏ผš4ไบบ." + }, + "image": { + "type": "string", + "description": "่ฃฝๅ“ใ‚’่กจใ™็”ปๅƒใฎURL." + } + } + }, + "PriceEstimate": { + "properties": { + "product_id": { + "type": "string", + "description": "็‰นๅฎšใฎ็ทฏๅบฆใจ็ตŒๅบฆใซๅฏพๅฟœใ™ใ‚‹็‰นๅฎšใฎ่ฃฝๅ“ใ‚’่กจใ™ไธ€ๆ„ใฎ่ญ˜ๅˆฅๅญใ€‚ใŸใจใˆใฐใ€ใ‚ตใƒณใƒ•ใƒฉใƒณใ‚ทใ‚นใ‚ณใฎ uberX ใฏใ€ใƒญใ‚ตใƒณใ‚ผใƒซใ‚นใฎ uberX ใจใฏ็•ฐใชใ‚‹ product_id ใ‚’ๆŒใกใพใ™ใ€‚" + }, + "currency_code": { + "type": "string", + "description": "[ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) ้€š่ฒจใ‚ณใƒผใƒ‰." + }, + "display_name": { + "type": "string", + "description": "่ฃฝๅ“ใฎ่กจ็คบๅ." + }, + "estimate": { + "type": "string", + "description": "ๅ‡บ็™บๅœฐใฎ็พๅœฐ้€š่ฒจใงใฎ่ฆ‹็ฉใ‚Šใฎใƒ•ใ‚ฉใƒผใƒžใƒƒใƒˆใ•ใ‚ŒใŸๆ–‡ๅญ—ๅˆ—ใ€‚่ฆ‹็ฉใ‚Šใฏ็ฏ„ๅ›ฒใ€ๅ˜ไธ€ใฎๆ•ฐๅญ—๏ผˆๅฎš้ก๏ผ‰ใพใŸใฏใ‚ฟใ‚ฏใ‚ทใƒผใฎใ€Œๅพ“้‡ๅˆถใ€ใซใชใ‚Šใพใ™ใ€‚." + }, + "low_estimate": { + "type": "number", + "description": "ๆŽจๅฎšไพกๆ ผใฎไธ‹้™." + }, + "high_estimate": { + "type": "number", + "description": "ๆŽจๅฎšไพกๆ ผใฎไธŠ้™." + }, + "surge_multiplier": { + "type": "number", + "description": "ไบˆๆƒณใ•ใ‚Œใ‚‹ใ‚ตใƒผใ‚ธไน—ๆ•ฐใ€‚ใ‚ตใƒผใ‚ธใฏใ€surge_multiplier ใŒ 1 ใ‚ˆใ‚Šๅคงใใ„ๅ ดๅˆใซใ‚ขใ‚ฏใƒ†ใ‚ฃใƒ–ใซใชใ‚Šใพใ™ใ€‚ไพกๆ ผ่ฆ‹็ฉใ‚‚ใ‚Šใซใฏใ‚ตใƒผใ‚ธไน—ๆ•ฐใŒใ™ใงใซ่€ƒๆ…ฎใ•ใ‚Œใฆใ„ใพใ™ใ€‚." + } + } + }, + "Profile": { + "properties": { + "first_name": { + "type": "string", + "description": "Uberใƒฆใƒผใ‚ถใƒผใฎๅ." + }, + "last_name": { + "type": "string", + "description": "Uberใƒฆใƒผใ‚ถใƒผใฎๅง“." + }, + "email": { + "type": "string", + "description": "Uberใƒฆใƒผใ‚ถใƒผใฎใƒกใƒผใƒซใ‚ขใƒ‰ใƒฌใ‚น" + }, + "picture": { + "type": "string", + "description": "Uberใƒฆใƒผใ‚ถใƒผใฎ็”ปๅƒURL." + }, + "promo_code": { + "type": "string", + "description": "Uberใƒฆใƒผใ‚ถใƒผใฎใƒ—ใƒญใƒขใƒผใ‚ทใƒงใƒณใ‚ณใƒผใƒ‰." + } + } + }, + "Activity": { + "properties": { + "uuid": { + "type": "string", + "description": "ใ‚ขใ‚ฏใƒ†ใ‚ฃใƒ“ใƒ†ใ‚ฃใฎไธ€ๆ„ใฎ่ญ˜ๅˆฅๅญ" + } + } + }, + "Activities": { + "properties": { + "offset": { + "type": "integer", + "format": "int32", + "description": "ใƒšใƒผใ‚ธใƒใƒผใ‚ทใƒงใƒณใฎไฝ็ฝฎ." + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "ๅ–ๅพ—ใ™ใ‚‹ใ‚ขใ‚คใƒ†ใƒ ใฎๆ•ฐ๏ผˆๆœ€ๅคง 100 ๅ€‹๏ผ‰." + }, + "count": { + "type": "integer", + "format": "int32", + "description": "ๅ…ฅๆ‰‹ๅฏ่ƒฝใชใ‚ขใ‚คใƒ†ใƒ ใฎ็ทๆ•ฐ." + }, + "history": { + "type": "array", + "items": { + "$ref": "#/definitions/Activity" + } + } + } + }, + "Error": { + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "fields": { + "type": "string" + } + } + } + } + }, + "paths": { + "/products": { + "get": { + "summary": "่ฃฝๅ“ใ‚ฟใ‚คใƒ—", + "description": "่ฃฝๅ“ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฏใ€็‰นๅฎšใฎๅ ดๆ‰€ใงๆไพ›ใ•ใ‚Œใฆใ„ใ‚‹ Uber ่ฃฝๅ“ใซ้–ขใ™ใ‚‹ๆƒ…ๅ ฑใ‚’่ฟ”ใ—ใพใ™ใ€‚ๅฟœ็ญ”ใซใฏใ€ๅ„่ฃฝๅ“ใฎ่กจ็คบๅใ‚„ใใฎไป–ใฎ่ฉณ็ดฐใŒๅซใพใ‚Œใ€้ฉๅˆ‡ใช่กจ็คบ้ †ๅบใง่ฃฝๅ“ใŒใƒชใ‚นใƒˆใ•ใ‚Œใพใ™ใ€‚.", + "parameters": [ + { + "name": "latitude", + "in": "query", + "description": "ๅ ดๆ‰€ใฎ็ทฏๅบฆๆˆๅˆ†.", + "schema": { + "name": "latitude", + "in": "query", + "description": "ๅ ดๆ‰€ใฎ็ทฏๅบฆๆˆๅˆ†.", + "required": true, + "type": "number", + "format": "double" + }, + "required": true + }, + { + "name": "longitude", + "in": "query", + "description": "ไฝ็ฝฎใฎ็ตŒๅบฆๆˆๅˆ†.", + "schema": { + "name": "longitude", + "in": "query", + "description": "ไฝ็ฝฎใฎ็ตŒๅบฆๆˆๅˆ†.", + "required": true, + "type": "number", + "format": "double" + }, + "required": true + } + ], + "tags": [ + "Products" + ], + "responses": { + "200": { + "description": "ใ•ใพใ–ใพใช่ฃฝๅ“", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + } + } + } + }, + "default": { + "description": "ไบˆๆœŸใ—ใชใ„ใ‚จใƒฉใƒผ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/estimates/price": { + "get": { + "summary": "ไพกๆ ผ่ฆ‹็ฉใ‚‚ใ‚Š", + "description": "ไพกๆ ผ่ฆ‹็ฉใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฏใ€็‰นๅฎšใฎๅ ดๆ‰€ใงๆไพ›ใ•ใ‚Œใ‚‹ๅ„่ฃฝๅ“ใฎ่ฆ‹็ฉไพกๆ ผ็ฏ„ๅ›ฒใ‚’่ฟ”ใ—ใพใ™ใ€‚ไพกๆ ผ่ฆ‹็ฉใฏใ€ๅฎŒๅ…จใชไพกๆ ผ็ฏ„ๅ›ฒใจใƒญใƒผใ‚ซใƒฉใ‚คใ‚บใ•ใ‚ŒใŸ้€š่ฒจ่จ˜ๅทใ‚’ๅซใ‚€ใƒ•ใ‚ฉใƒผใƒžใƒƒใƒˆใ•ใ‚ŒใŸๆ–‡ๅญ—ๅˆ—ใจใ—ใฆๆไพ›ใ•ใ‚Œใพใ™ใ€‚

ๅฟœ็ญ”ใซใฏใ€ไฝŽใ„่ฆ‹็ฉใ‚‚ใ‚Šใจ้ซ˜ใ„่ฆ‹็ฉใ‚‚ใ‚Šใ€ใŠใ‚ˆใณ้€š่ฒจๆ›็ฎ—ใŒๅฟ…่ฆใชๅ ดๅˆใฎใŸใ‚ใฎ [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) ้€š่ฒจใ‚ณใƒผใƒ‰ใ‚‚ๅซใพใ‚Œใฆใ„ใพใ™ใ€‚็‰นๅฎšใฎ่ฃฝๅ“ใซๅฏพใ—ใฆใ‚ตใƒผใ‚ธใŒใ‚ขใ‚ฏใƒ†ใ‚ฃใƒ–ใซใชใฃใฆใ„ใ‚‹ๅ ดๅˆใ€ใใฎใ‚ตใƒผใ‚ธไน—ๆ•ฐใฏ 1 ใ‚ˆใ‚Šๅคงใใใชใ‚Šใพใ™ใŒใ€ไพกๆ ผ่ฆ‹็ฉใ‚‚ใ‚Šใซใฏใ™ใงใซใ“ใฎไน—ๆ•ฐใŒ่€ƒๆ…ฎใ•ใ‚Œใฆใ„ใพใ™ใ€‚.", + "parameters": [ + { + "name": "start_latitude", + "in": "query", + "description": "ๅ‡บ็™บๅœฐใฎ็ทฏๅบฆๆˆๅˆ†.", + "schema": { + "name": "start_latitude", + "in": "query", + "description": "ๅ‡บ็™บๅœฐใฎ็ทฏๅบฆๆˆๅˆ†.", + "required": true, + "type": "number", + "format": "double" + }, + "required": true + }, + { + "name": "start_longitude", + "in": "query", + "description": "้–‹ๅง‹ไฝ็ฝฎใฎ็ตŒๅบฆๆˆๅˆ†.", + "schema": { + "name": "start_longitude", + "in": "query", + "description": "้–‹ๅง‹ไฝ็ฝฎใฎ็ตŒๅบฆๆˆๅˆ†.", + "required": true, + "type": "number", + "format": "double" + }, + "required": true + }, + { + "name": "end_latitude", + "in": "query", + "description": "็ต‚ไบ†ไฝ็ฝฎใฎ็ทฏๅบฆๆˆๅˆ†.", + "schema": { + "name": "end_latitude", + "in": "query", + "description": "็ต‚ไบ†ไฝ็ฝฎใฎ็ทฏๅบฆๆˆๅˆ†.", + "required": true, + "type": "number", + "format": "double" + }, + "required": true + }, + { + "name": "end_longitude", + "in": "query", + "description": "็ต‚ไบ†ไฝ็ฝฎใฎ็ตŒๅบฆๆˆๅˆ†.", + "schema": { + "name": "end_longitude", + "in": "query", + "description": "็ต‚ไบ†ไฝ็ฝฎใฎ็ตŒๅบฆๆˆๅˆ†.", + "required": true, + "type": "number", + "format": "double" + }, + "required": true + } + ], + "tags": [ + "Estimates" + ], + "responses": { + "200": { + "description": "่ฃฝๅ“ๅˆฅใฎไพกๆ ผ่ฆ‹็ฉใ‚‚ใ‚Š", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PriceEstimate" + } + } + } + } + }, + "default": { + "description": "ไบˆๆœŸใ—ใชใ„ใ‚จใƒฉใƒผ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/estimates/time": { + "get": { + "summary": "ๆ‰€่ฆๆ™‚้–“", + "description": "ๆ™‚้–“่ฆ‹็ฉใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฏใ€็‰นๅฎšใฎๅ ดๆ‰€ใงๆไพ›ใ•ใ‚Œใ‚‹ใ™ในใฆใฎ่ฃฝๅ“ใฎๅˆฐ็€ไบˆๅฎšๆ™‚ๅˆปใ‚’็ง’ๅ˜ไฝใฎๆ•ดๆ•ฐใง่ฟ”ใ—ใพใ™ใ€‚ๆœ€ใ‚‚ๆญฃ็ขบใงๆœ€ๆ–ฐใฎๅˆฐ็€ไบˆๅฎšๆ™‚ๅˆปใ‚’ๆไพ›ใ™ใ‚‹ใŸใ‚ใซใ€ใ“ใฎใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใ‚’1ๅˆ†ใ”ใจใซๅ‘ผใณๅ‡บใ™ใ“ใจใ‚’ใŠๅ‹งใ‚ใ—ใพใ™ใ€‚.", + "parameters": [ + { + "name": "start_latitude", + "in": "query", + "description": "ๅ‡บ็™บๅœฐใฎ็ทฏๅบฆๆˆๅˆ†.", + "schema": { + "name": "start_latitude", + "in": "query", + "description": "ๅ‡บ็™บๅœฐใฎ็ทฏๅบฆๆˆๅˆ†.", + "required": true, + "type": "number", + "format": "double" + }, + "required": true + }, + { + "name": "start_longitude", + "in": "query", + "description": "้–‹ๅง‹ไฝ็ฝฎใฎ็ตŒๅบฆๆˆๅˆ†.", + "schema": { + "name": "start_longitude", + "in": "query", + "description": "้–‹ๅง‹ไฝ็ฝฎใฎ็ตŒๅบฆๆˆๅˆ†.", + "required": true, + "type": "number", + "format": "double" + }, + "required": true + }, + { + "name": "customer_uuid", + "in": "query", + "description": "ใ‚จใ‚ฏใ‚นใƒšใƒชใ‚จใƒณใ‚นใฎใ‚ซใ‚นใ‚ฟใƒžใ‚คใ‚บใซไฝฟ็”จใ•ใ‚Œใ‚‹ๅ›บๆœ‰ใฎ้กงๅฎข่ญ˜ๅˆฅๅญ.", + "schema": { + "name": "customer_uuid", + "in": "query", + "type": "string", + "format": "uuid", + "description": "ใ‚จใ‚ฏใ‚นใƒšใƒชใ‚จใƒณใ‚นใฎใ‚ซใ‚นใ‚ฟใƒžใ‚คใ‚บใซไฝฟ็”จใ•ใ‚Œใ‚‹ๅ›บๆœ‰ใฎ้กงๅฎข่ญ˜ๅˆฅๅญ." + }, + "required": true + }, + { + "name": "product_id", + "in": "query", + "description": "็‰นๅฎšใฎ็ทฏๅบฆใจ็ตŒๅบฆใซๅฏพๅฟœใ™ใ‚‹็‰นๅฎšใฎ่ฃฝๅ“ใ‚’่กจใ™ไธ€ๆ„ใฎ่ญ˜ๅˆฅๅญ.", + "schema": { + "name": "product_id", + "in": "query", + "type": "string", + "description": "็‰นๅฎšใฎ็ทฏๅบฆใจ็ตŒๅบฆใซๅฏพๅฟœใ™ใ‚‹็‰นๅฎšใฎ่ฃฝๅ“ใ‚’่กจใ™ไธ€ๆ„ใฎ่ญ˜ๅˆฅๅญ." + }, + "required": true + } + ], + "tags": [ + "Estimates" + ], + "responses": { + "200": { + "description": "ใ•ใพใ–ใพใช่ฃฝๅ“", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + } + } + } + }, + "default": { + "description": "ไบˆๆœŸใ—ใชใ„ใ‚จใƒฉใƒผ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/me": { + "get": { + "summary": "ใƒฆใƒผใ‚ถใƒผใƒ—ใƒญใƒ•ใ‚ฃใƒผใƒซ", + "description": "ใƒฆใƒผใ‚ถใƒผใƒ—ใƒญใƒ•ใ‚กใ‚คใƒซใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฏใ€ใ‚ขใƒ—ใƒชใ‚ฑใƒผใ‚ทใƒงใƒณใง่ช่จผใ•ใ‚ŒใŸUberใƒฆใƒผใ‚ถใƒผใซ้–ขใ™ใ‚‹ๆƒ…ๅ ฑใ‚’่ฟ”ใ—ใพใ™ใ€‚.", + "tags": [ + "User" + ], + "responses": { + "200": { + "description": "ใƒฆใƒผใ‚ถใƒผใฎใƒ—ใƒญใƒ•ใ‚ฃใƒผใƒซๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Profile" + } + } + } + }, + "default": { + "description": "ไบˆๆœŸใ—ใชใ„ใ‚จใƒฉใƒผ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/history": { + "get": { + "summary": "ใƒฆใƒผใ‚ถใƒผใ‚ขใ‚ฏใƒ†ใ‚ฃใƒ“ใƒ†ใ‚ฃ", + "description": "ใƒฆใƒผใ‚ถใƒผ ใ‚ขใ‚ฏใƒ†ใ‚ฃใƒ“ใƒ†ใ‚ฃ ใ‚จใƒณใƒ‰ใƒใ‚คใƒณใƒˆใฏใ€Uber ใงใฎใƒฆใƒผใ‚ถใƒผใฎ็”Ÿๆถฏใ‚ขใ‚ฏใƒ†ใ‚ฃใƒ“ใƒ†ใ‚ฃใซ้–ขใ™ใ‚‹ใƒ‡ใƒผใ‚ฟใ‚’่ฟ”ใ—ใพใ™ใ€‚ๅฟœ็ญ”ใซใฏใ€ไน—่ปŠๅ ดๆ‰€ใจๆ™‚้–“ใ€้™่ปŠๅ ดๆ‰€ใจๆ™‚้–“ใ€้ŽๅŽปใฎใƒชใ‚ฏใ‚จใ‚นใƒˆใฎ่ท้›ขใ€ใƒชใ‚ฏใ‚จใ‚นใƒˆใ•ใ‚ŒใŸ่ฃฝๅ“ใซ้–ขใ™ใ‚‹ๆƒ…ๅ ฑใŒๅซใพใ‚Œใพใ™ใ€‚

ๅฟœ็ญ”ใฎๅฑฅๆญด้…ๅˆ—ใฏใ€ๅˆถ้™ใƒ‘ใƒฉใƒกใƒผใ‚ฟใซๅŸบใฅใ„ใฆๆœ€ๅคง้•ทใ‚’ๆŒใกใพใ™ใ€‚ๅฟœ็ญ”ๅ€คใฎๆ•ฐใŒๅˆถ้™ใ‚’่ถ…ใˆใ‚‹ๅฏ่ƒฝๆ€งใŒใ‚ใ‚‹ใŸใ‚ใ€ๅพŒ็ถšใฎAPIใƒชใ‚ฏใ‚จใ‚นใƒˆใŒๅฟ…่ฆใซใชใ‚‹ๅ ดๅˆใŒใ‚ใ‚Šใพใ™ใ€‚.", + "parameters": [ + { + "name": "offset", + "in": "query", + "description": "่ฟ”ใ•ใ‚Œใ‚‹็ตๆžœใฎใƒชใ‚นใƒˆใ‚’ใ“ใฎ้‡ใ ใ‘ใ‚ชใƒ•ใ‚ปใƒƒใƒˆใ—ใพใ™ใ€‚ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใฏใ‚ผใƒญใงใ™.", + "schema": { + "name": "offset", + "in": "query", + "type": "integer", + "format": "int32", + "description": "่ฟ”ใ•ใ‚Œใ‚‹็ตๆžœใฎใƒชใ‚นใƒˆใ‚’ใ“ใฎ้‡ใ ใ‘ใ‚ชใƒ•ใ‚ปใƒƒใƒˆใ—ใพใ™ใ€‚ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใฏใ‚ผใƒญใงใ™." + }, + "required": true + }, + { + "name": "limit", + "in": "query", + "description": "ๅ–ๅพ—ใ™ใ‚‹ใ‚ขใ‚คใƒ†ใƒ ใฎๆ•ฐใ€‚ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใฏ 5ใ€ๆœ€ๅคงใฏ 100 ใงใ™ใ€‚.", + "schema": { + "name": "limit", + "in": "query", + "type": "integer", + "format": "int32", + "description": "ๅ–ๅพ—ใ™ใ‚‹ใ‚ขใ‚คใƒ†ใƒ ใฎๆ•ฐใ€‚ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใฏ 5ใ€ๆœ€ๅคงใฏ 100 ใงใ™ใ€‚." + }, + "required": true + } + ], + "tags": [ + "User" + ], + "responses": { + "200": { + "description": "ๆŒ‡ๅฎšใ•ใ‚ŒใŸใƒฆใƒผใ‚ถใƒผใฎๅฑฅๆญดๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Activities" + } + } + } + }, + "default": { + "description": "ไบˆๆœŸใ—ใชใ„ใ‚จใƒฉใƒผ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + } + }, + "servers": [ + { + "url": "api.uber.com" + } + ], + "x-samchon-emended": true +} \ No newline at end of file diff --git a/assets/output/uber.swagger.ko.json b/assets/output/uber.swagger.ko.json new file mode 100644 index 0000000..41da77c --- /dev/null +++ b/assets/output/uber.swagger.ko.json @@ -0,0 +1,482 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "์šฐ๋ฒ„ API", + "description": "Uber API๋กœ ์•ฑ์„ ํ•œ ๋‹จ๊ณ„ ๋ฐœ์ „์‹œํ‚ค์„ธ์š”", + "version": "1.0.0" + }, + "components": { + "schemas": { + "Product": { + "properties": { + "product_id": { + "type": "string", + "description": "์ฃผ์–ด์ง„ ์œ„๋„ ๋ฐ ๊ฒฝ๋„์— ๋Œ€ํ•œ ํŠน์ • ์ œํ’ˆ์„ ๋‚˜ํƒ€๋‚ด๋Š” ๊ณ ์œ  ์‹๋ณ„์ž์ž…๋‹ˆ๋‹ค. ์˜ˆ๋ฅผ ๋“ค์–ด, ์ƒŒํ”„๋ž€์‹œ์Šค์ฝ”์˜ uberX๋Š” ๋กœ์Šค์•ค์ ค๋ ˆ์Šค์˜ uberX์™€ ๋‹ค๋ฅธ product_id๋ฅผ ๊ฐ–์Šต๋‹ˆ๋‹ค.." + }, + "description": { + "type": "string", + "description": "์ œํ’ˆ ์„ค๋ช…." + }, + "display_name": { + "type": "string", + "description": "์ œํ’ˆ์˜ ํ‘œ์‹œ ์ด๋ฆ„." + }, + "capacity": { + "type": "string", + "description": "์ œํ’ˆ ์šฉ๋Ÿ‰. ์˜ˆ๋ฅผ ๋“ค์–ด, 4๋ช…." + }, + "image": { + "type": "string", + "description": "์ œํ’ˆ์„ ๋‚˜ํƒ€๋‚ด๋Š” ์ด๋ฏธ์ง€ URL." + } + } + }, + "PriceEstimate": { + "properties": { + "product_id": { + "type": "string", + "description": "์ฃผ์–ด์ง„ ์œ„๋„ ๋ฐ ๊ฒฝ๋„์— ๋Œ€ํ•œ ํŠน์ • ์ œํ’ˆ์„ ๋‚˜ํƒ€๋‚ด๋Š” ๊ณ ์œ  ์‹๋ณ„์ž์ž…๋‹ˆ๋‹ค. ์˜ˆ๋ฅผ ๋“ค์–ด, ์ƒŒํ”„๋ž€์‹œ์Šค์ฝ”์˜ uberX๋Š” ๋กœ์Šค์•ค์ ค๋ ˆ์Šค์˜ uberX์™€ ๋‹ค๋ฅธ product_id๋ฅผ ๊ฐ–์Šต๋‹ˆ๋‹ค." + }, + "currency_code": { + "type": "string", + "description": "[ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) ํ†ตํ™” ์ฝ”๋“œ." + }, + "display_name": { + "type": "string", + "description": "์ œํ’ˆ์˜ ํ‘œ์‹œ ์ด๋ฆ„." + }, + "estimate": { + "type": "string", + "description": "์‹œ์ž‘ ์œ„์น˜์˜ ํ˜„์ง€ ํ†ตํ™”๋กœ ๋œ ์ถ”์ •์น˜์˜ ํ˜•์‹ํ™”๋œ ๋ฌธ์ž์—ด. ์ถ”์ •์น˜๋Š” ๋ฒ”์œ„, ๋‹จ์ผ ์ˆซ์ž(์ •์•ก ์š”๊ธˆ) ๋˜๋Š” ํƒ์‹œ์˜ ๊ฒฝ์šฐ "๋ฏธํ„ฐ๋ง"์ผ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.." + }, + "low_estimate": { + "type": "number", + "description": "์ถ”์ • ๊ฐ€๊ฒฉ์˜ ํ•˜ํ•œ." + }, + "high_estimate": { + "type": "number", + "description": "์˜ˆ์ƒ ๊ฐ€๊ฒฉ์˜ ์ƒํ•œ." + }, + "surge_multiplier": { + "type": "number", + "description": "์˜ˆ์ƒ ์„œ์ง€ ์Šน์ˆ˜. ์„œ์ง€๋Š” surge_multiplier๊ฐ€ 1๋ณด๋‹ค ํฐ ๊ฒฝ์šฐ ํ™œ์„ฑํ™”๋ฉ๋‹ˆ๋‹ค. ๊ฐ€๊ฒฉ ์ถ”์ •์—๋Š” ์ด๋ฏธ ์„œ์ง€ ์Šน์ˆ˜๊ฐ€ ๋ฐ˜์˜๋ฉ๋‹ˆ๋‹ค.." + } + } + }, + "Profile": { + "properties": { + "first_name": { + "type": "string", + "description": "Uber ์‚ฌ์šฉ์ž์˜ ์ด๋ฆ„." + }, + "last_name": { + "type": "string", + "description": "Uber ์‚ฌ์šฉ์ž์˜ ์„ฑ." + }, + "email": { + "type": "string", + "description": "Uber ์‚ฌ์šฉ์ž์˜ ์ด๋ฉ”์ผ ์ฃผ์†Œ" + }, + "picture": { + "type": "string", + "description": "Uber ์‚ฌ์šฉ์ž์˜ ์ด๋ฏธ์ง€ URL." + }, + "promo_code": { + "type": "string", + "description": "์šฐ๋ฒ„ ์‚ฌ์šฉ์ž์˜ ํ”„๋กœ๋ชจ ์ฝ”๋“œ." + } + } + }, + "Activity": { + "properties": { + "uuid": { + "type": "string", + "description": "ํ™œ๋™์— ๋Œ€ํ•œ ๊ณ ์œ  ์‹๋ณ„์ž" + } + } + }, + "Activities": { + "properties": { + "offset": { + "type": "integer", + "format": "int32", + "description": "ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ์˜ ์œ„์น˜." + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "๊ฒ€์ƒ‰ํ•  ํ•ญ๋ชฉ ์ˆ˜(์ตœ๋Œ€ 100๊ฐœ)." + }, + "count": { + "type": "integer", + "format": "int32", + "description": "์‚ฌ์šฉ ๊ฐ€๋Šฅํ•œ ์ด ํ•ญ๋ชฉ ์ˆ˜." + }, + "history": { + "type": "array", + "items": { + "$ref": "#/definitions/Activity" + } + } + } + }, + "Error": { + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "fields": { + "type": "string" + } + } + } + } + }, + "paths": { + "/products": { + "get": { + "summary": "์ œํ’ˆ ์œ ํ˜•", + "description": "Products ์—”๋“œํฌ์ธํŠธ๋Š” ์ฃผ์–ด์ง„ ์œ„์น˜์—์„œ ์ œ๊ณต๋˜๋Š” Uber ์ œํ’ˆ์— ๋Œ€ํ•œ ์ •๋ณด๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค. ์‘๋‹ต์—๋Š” ๊ฐ ์ œํ’ˆ์— ๋Œ€ํ•œ ํ‘œ์‹œ ์ด๋ฆ„๊ณผ ๊ธฐํƒ€ ์„ธ๋ถ€ ์ •๋ณด๊ฐ€ ํฌํ•จ๋˜๋ฉฐ ์ ์ ˆํ•œ ํ‘œ์‹œ ์ˆœ์„œ๋กœ ์ œํ’ˆ์„ ๋‚˜์—ดํ•ฉ๋‹ˆ๋‹ค..", + "parameters": [ + { + "name": "latitude", + "in": "query", + "description": "์œ„์น˜์˜ ์œ„๋„ ๊ตฌ์„ฑ ์š”์†Œ.", + "schema": { + "name": "latitude", + "in": "query", + "description": "์œ„์น˜์˜ ์œ„๋„ ๊ตฌ์„ฑ ์š”์†Œ.", + "required": true, + "type": "number", + "format": "double" + }, + "required": true + }, + { + "name": "longitude", + "in": "query", + "description": "์œ„์น˜์˜ ๊ฒฝ๋„ ๊ตฌ์„ฑ ์š”์†Œ.", + "schema": { + "name": "longitude", + "in": "query", + "description": "์œ„์น˜์˜ ๊ฒฝ๋„ ๊ตฌ์„ฑ ์š”์†Œ.", + "required": true, + "type": "number", + "format": "double" + }, + "required": true + } + ], + "tags": [ + "Products" + ], + "responses": { + "200": { + "description": "๋‹ค์–‘ํ•œ ์ œํ’ˆ", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + } + } + } + }, + "default": { + "description": "์˜ˆ์ƒ์น˜ ๋ชปํ•œ ์˜ค๋ฅ˜", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/estimates/price": { + "get": { + "summary": "๊ฐ€๊ฒฉ ์ถ”์ •", + "description": "๊ฐ€๊ฒฉ ์ถ”์ • ์—”๋“œํฌ์ธํŠธ๋Š” ์ฃผ์–ด์ง„ ์œ„์น˜์—์„œ ์ œ๊ณต๋˜๋Š” ๊ฐ ์ œํ’ˆ์— ๋Œ€ํ•œ ์ถ”์ • ๊ฐ€๊ฒฉ ๋ฒ”์œ„๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค. ๊ฐ€๊ฒฉ ์ถ”์ •์€ ์ „์ฒด ๊ฐ€๊ฒฉ ๋ฒ”์œ„์™€ ํ˜„์ง€ํ™”๋œ ํ†ตํ™” ๊ธฐํ˜ธ๊ฐ€ ์žˆ๋Š” ํ˜•์‹ํ™”๋œ ๋ฌธ์ž์—ด๋กœ ์ œ๊ณต๋ฉ๋‹ˆ๋‹ค.

์‘๋‹ต์—๋Š” ๋‚ฎ์€ ์ถ”์ •์น˜์™€ ๋†’์€ ์ถ”์ •์น˜, ๊ทธ๋ฆฌ๊ณ  ํ†ตํ™” ๋ณ€ํ™˜์ด ํ•„์š”ํ•œ ์ƒํ™ฉ์„ ์œ„ํ•œ [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) ํ†ตํ™” ์ฝ”๋“œ๋„ ํฌํ•จ๋ฉ๋‹ˆ๋‹ค. ํŠน์ • ์ œํ’ˆ์— ๋Œ€ํ•ด ์„œ์ง€๊ฐ€ ํ™œ์„ฑํ™”๋˜๋ฉด ํ•ด๋‹น ์„œ์ง€_์Šน์ˆ˜๋Š” 1๋ณด๋‹ค ํฌ์ง€๋งŒ ๊ฐ€๊ฒฉ ์ถ”์ •์น˜๋Š” ์ด๋ฏธ ์ด ์Šน์ˆ˜๋ฅผ ๊ณ ๋ คํ•ฉ๋‹ˆ๋‹ค..", + "parameters": [ + { + "name": "start_latitude", + "in": "query", + "description": "์‹œ์ž‘ ์œ„์น˜์˜ ์œ„๋„ ๊ตฌ์„ฑ ์š”์†Œ.", + "schema": { + "name": "start_latitude", + "in": "query", + "description": "์‹œ์ž‘ ์œ„์น˜์˜ ์œ„๋„ ๊ตฌ์„ฑ ์š”์†Œ.", + "required": true, + "type": "number", + "format": "double" + }, + "required": true + }, + { + "name": "start_longitude", + "in": "query", + "description": "์‹œ์ž‘ ์œ„์น˜์˜ ๊ฒฝ๋„ ๊ตฌ์„ฑ ์š”์†Œ.", + "schema": { + "name": "start_longitude", + "in": "query", + "description": "์‹œ์ž‘ ์œ„์น˜์˜ ๊ฒฝ๋„ ๊ตฌ์„ฑ ์š”์†Œ.", + "required": true, + "type": "number", + "format": "double" + }, + "required": true + }, + { + "name": "end_latitude", + "in": "query", + "description": "์ตœ์ข… ์œ„์น˜์˜ ์œ„๋„ ๊ตฌ์„ฑ ์š”์†Œ.", + "schema": { + "name": "end_latitude", + "in": "query", + "description": "์ตœ์ข… ์œ„์น˜์˜ ์œ„๋„ ๊ตฌ์„ฑ ์š”์†Œ.", + "required": true, + "type": "number", + "format": "double" + }, + "required": true + }, + { + "name": "end_longitude", + "in": "query", + "description": "์ข…๋ฃŒ ์œ„์น˜์˜ ๊ฒฝ๋„ ๊ตฌ์„ฑ ์š”์†Œ.", + "schema": { + "name": "end_longitude", + "in": "query", + "description": "์ข…๋ฃŒ ์œ„์น˜์˜ ๊ฒฝ๋„ ๊ตฌ์„ฑ ์š”์†Œ.", + "required": true, + "type": "number", + "format": "double" + }, + "required": true + } + ], + "tags": [ + "Estimates" + ], + "responses": { + "200": { + "description": "์ œํ’ˆ๋ณ„ ๋‹ค์–‘ํ•œ ๊ฐ€๊ฒฉ ์ถ”์ •", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PriceEstimate" + } + } + } + } + }, + "default": { + "description": "์˜ˆ์ƒ์น˜ ๋ชปํ•œ ์˜ค๋ฅ˜", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/estimates/time": { + "get": { + "summary": "์‹œ๊ฐ„ ์ถ”์ •", + "description": "Time Estimates ์—”๋“œํฌ์ธํŠธ๋Š” ์ฃผ์–ด์ง„ ์œ„์น˜์—์„œ ์ œ๊ณต๋˜๋Š” ๋ชจ๋“  ์ œํ’ˆ์— ๋Œ€ํ•œ ETA๋ฅผ ๋ฐ˜ํ™˜ํ•˜๋ฉฐ, ์‘๋‹ต์€ ์ดˆ ๋‹จ์œ„์˜ ์ •์ˆ˜๋กœ ํ‘œํ˜„๋ฉ๋‹ˆ๋‹ค. ๊ฐ€์žฅ ์ •ํ™•ํ•˜๊ณ  ์ตœ์‹ ์˜ ETA๋ฅผ ์ œ๊ณตํ•˜๊ธฐ ์œ„ํ•ด ์ด ์—”๋“œํฌ์ธํŠธ๋ฅผ ๋งค๋ถ„ ํ˜ธ์ถœํ•˜๋Š” ๊ฒƒ์ด ์ข‹์Šต๋‹ˆ๋‹ค..", + "parameters": [ + { + "name": "start_latitude", + "in": "query", + "description": "์‹œ์ž‘ ์œ„์น˜์˜ ์œ„๋„ ๊ตฌ์„ฑ ์š”์†Œ.", + "schema": { + "name": "start_latitude", + "in": "query", + "description": "์‹œ์ž‘ ์œ„์น˜์˜ ์œ„๋„ ๊ตฌ์„ฑ ์š”์†Œ.", + "required": true, + "type": "number", + "format": "double" + }, + "required": true + }, + { + "name": "start_longitude", + "in": "query", + "description": "์‹œ์ž‘ ์œ„์น˜์˜ ๊ฒฝ๋„ ๊ตฌ์„ฑ ์š”์†Œ.", + "schema": { + "name": "start_longitude", + "in": "query", + "description": "์‹œ์ž‘ ์œ„์น˜์˜ ๊ฒฝ๋„ ๊ตฌ์„ฑ ์š”์†Œ.", + "required": true, + "type": "number", + "format": "double" + }, + "required": true + }, + { + "name": "customer_uuid", + "in": "query", + "description": "์‚ฌ์šฉ์ž ๊ฒฝํ—˜ ๋งž์ถคํ™”๋ฅผ ์œ„ํ•ด ์‚ฌ์šฉํ•  ๊ณ ์œ  ๊ณ ๊ฐ ์‹๋ณ„์ž.", + "schema": { + "name": "customer_uuid", + "in": "query", + "type": "string", + "format": "uuid", + "description": "์‚ฌ์šฉ์ž ๊ฒฝํ—˜ ๋งž์ถคํ™”๋ฅผ ์œ„ํ•ด ์‚ฌ์šฉํ•  ๊ณ ์œ  ๊ณ ๊ฐ ์‹๋ณ„์ž." + }, + "required": true + }, + { + "name": "product_id", + "in": "query", + "description": "์ง€์ •๋œ ์œ„๋„ ๋ฐ ๊ฒฝ๋„์— ๋Œ€ํ•œ ํŠน์ • ์ œํ’ˆ์„ ๋‚˜ํƒ€๋‚ด๋Š” ๊ณ ์œ  ์‹๋ณ„์ž.", + "schema": { + "name": "product_id", + "in": "query", + "type": "string", + "description": "์ง€์ •๋œ ์œ„๋„ ๋ฐ ๊ฒฝ๋„์— ๋Œ€ํ•œ ํŠน์ • ์ œํ’ˆ์„ ๋‚˜ํƒ€๋‚ด๋Š” ๊ณ ์œ  ์‹๋ณ„์ž." + }, + "required": true + } + ], + "tags": [ + "Estimates" + ], + "responses": { + "200": { + "description": "๋‹ค์–‘ํ•œ ์ œํ’ˆ", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + } + } + } + }, + "default": { + "description": "์˜ˆ์ƒ์น˜ ๋ชปํ•œ ์˜ค๋ฅ˜", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/me": { + "get": { + "summary": "์‚ฌ์šฉ์ž ํ”„๋กœํ•„", + "description": "์‚ฌ์šฉ์ž ํ”„๋กœํ•„ ์—”๋“œํฌ์ธํŠธ๋Š” ์• ํ”Œ๋ฆฌ์ผ€์ด์…˜์— ๊ถŒํ•œ์ด ๋ถ€์—ฌ๋œ Uber ์‚ฌ์šฉ์ž์— ๋Œ€ํ•œ ์ •๋ณด๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค..", + "tags": [ + "User" + ], + "responses": { + "200": { + "description": "์‚ฌ์šฉ์ž์˜ ํ”„๋กœํ•„ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Profile" + } + } + } + }, + "default": { + "description": "์˜ˆ์ƒ์น˜ ๋ชปํ•œ ์˜ค๋ฅ˜", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/history": { + "get": { + "summary": "์‚ฌ์šฉ์ž ํ™œ๋™", + "description": "์‚ฌ์šฉ์ž ํ™œ๋™ ์—”๋“œํฌ์ธํŠธ๋Š” Uber์—์„œ ์‚ฌ์šฉ์ž์˜ ํ‰์ƒ ํ™œ๋™์— ๋Œ€ํ•œ ๋ฐ์ดํ„ฐ๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค. ์‘๋‹ต์—๋Š” ํ”ฝ์—… ์œ„์น˜ ๋ฐ ์‹œ๊ฐ„, ํ•˜์ฐจ ์œ„์น˜ ๋ฐ ์‹œ๊ฐ„, ์ด์ „ ์š”์ฒญ์˜ ๊ฑฐ๋ฆฌ, ์š”์ฒญ๋œ ์ œํ’ˆ์— ๋Œ€ํ•œ ์ •๋ณด๊ฐ€ ํฌํ•จ๋ฉ๋‹ˆ๋‹ค.

์‘๋‹ต์˜ history ๋ฐฐ์—ด์€ limit ๋งค๊ฐœ๋ณ€์ˆ˜์— ๋”ฐ๋ผ ์ตœ๋Œ€ ๊ธธ์ด๋ฅผ ๊ฐ–์Šต๋‹ˆ๋‹ค. ์‘๋‹ต ๊ฐ’ ๊ฐœ์ˆ˜๊ฐ€ limit์„ ์ดˆ๊ณผํ•  ์ˆ˜ ์žˆ์œผ๋ฏ€๋กœ ํ›„์† API ์š”์ฒญ์ด ํ•„์š”ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค..", + "parameters": [ + { + "name": "offset", + "in": "query", + "description": "๋ฐ˜ํ™˜๋œ ๊ฒฐ๊ณผ ๋ชฉ๋ก์„ ์ด ์–‘๋งŒํผ ์˜คํ”„์…‹ํ•ฉ๋‹ˆ๋‹ค. ๊ธฐ๋ณธ๊ฐ’์€ 0์ž…๋‹ˆ๋‹ค..", + "schema": { + "name": "offset", + "in": "query", + "type": "integer", + "format": "int32", + "description": "๋ฐ˜ํ™˜๋œ ๊ฒฐ๊ณผ ๋ชฉ๋ก์„ ์ด ์–‘๋งŒํผ ์˜คํ”„์…‹ํ•ฉ๋‹ˆ๋‹ค. ๊ธฐ๋ณธ๊ฐ’์€ 0์ž…๋‹ˆ๋‹ค.." + }, + "required": true + }, + { + "name": "limit", + "in": "query", + "description": "๊ฒ€์ƒ‰ํ•  ํ•ญ๋ชฉ ์ˆ˜. ๊ธฐ๋ณธ๊ฐ’์€ 5์ด๊ณ  ์ตœ๋Œ€๊ฐ’์€ 100์ž…๋‹ˆ๋‹ค..", + "schema": { + "name": "limit", + "in": "query", + "type": "integer", + "format": "int32", + "description": "๊ฒ€์ƒ‰ํ•  ํ•ญ๋ชฉ ์ˆ˜. ๊ธฐ๋ณธ๊ฐ’์€ 5์ด๊ณ  ์ตœ๋Œ€๊ฐ’์€ 100์ž…๋‹ˆ๋‹ค.." + }, + "required": true + } + ], + "tags": [ + "User" + ], + "responses": { + "200": { + "description": "์ง€์ •๋œ ์‚ฌ์šฉ์ž์— ๋Œ€ํ•œ ๊ธฐ๋ก ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Activities" + } + } + } + }, + "default": { + "description": "์˜ˆ์ƒ์น˜ ๋ชปํ•œ ์˜ค๋ฅ˜", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + } + }, + "servers": [ + { + "url": "api.uber.com" + } + ], + "x-samchon-emended": true +} \ No newline at end of file diff --git a/assets/output/wanted.swagger.ar.json b/assets/output/wanted.swagger.ar.json new file mode 100644 index 0000000..c577c4b --- /dev/null +++ b/assets/output/wanted.swagger.ar.json @@ -0,0 +1,3432 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "ู…ุทู„ูˆุจ ุฎุงุฏู… OpenAPI V1", + "version": "1.0.0" + }, + "servers": [ + { + "url": "/v1" + } + ], + "paths": { + "/ai/pass/text-prediction/async": { + "post": { + "tags": [ + "AI" + ], + "summary": "[ู…ุฏููˆุน] ุชู†ููŠุฐ ุงู„ุชู†ุจุค ุจู‚ุจูˆู„ ุงู„ู…ุณุชู†ุฏ ุงู„ู†ุตูŠ (ุบูŠุฑ ู…ุชุฒุงู…ู†)", + "description": "**ูŠู…ูƒู† ุงุณุชุฎุฏุงู… ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ู‡ุฐู‡ ุจุนุฏ ุนู‚ุฏ ู…ู†ูุตู„. (ุงู„ุงุณุชูุณุงุฑ: team-ml@wantedlab.com)** ู†ุธุฑู‹ุง ู„ุฃู†ู‡ ูŠุชู… ุชู†ููŠุฐ ุงู„ุชู†ุจุค ุจุดูƒู„ ุบูŠุฑ ู…ุชุฒุงู…ู†ุŒ ูŠุชู… ุฅูƒู…ุงู„ ุงุณุชุฏุนุงุก ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ุนู„ู‰ ุงู„ููˆุฑ ูˆูŠุชู… ุชุณู„ูŠู… ุงู„ู†ุชูŠุฌุฉ ุฅู„ู‰ callback_url.** (ุงุชุตู„ ู…ุฑุฉ ูˆุงุญุฏุฉ ุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ ู„ุนุฏุฏ ุจูŠุงู†ุงุช ุงู„ุฅุฏุฎุงู„ ู‡ูˆ 50.)**", + "operationId": "_์œ ๋ฃŒ__ํ…์ŠคํŠธ_์„œ๋ฅ˜ํ•ฉ๊ฒฉ์˜ˆ์ธก_์‹คํ–‰_๋น„๋™๊ธฐ__ai_pass_text_prediction_async_post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "title": "ุจูŠุงู†ุงุช ุงู„ุฅุฏุฎุงู„", + "description": "ู…ุง ูŠุตู„ ุฅู„ู‰ 50", + "type": "object", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/ResumeJdTextPredictionItemSerializer" + }, + "type": "array", + "title": "ู‚ุงุฆู…ุฉ ุจูŠุงู†ุงุช ุทู„ุจ ุงู„ุชู†ุจุค" + }, + "callback_url": { + "type": "string", + "title": "ุนู†ูˆุงู† ุฑุฏ ุงู„ุงุชุตุงู„", + "description": "ุนู†ูˆุงู† URL ู„ูŠุชู… ุฅุนู„ุงู…ูƒ ุจุงู„ู†ุชูŠุฌุฉ ุจุนุฏ ุงู„ู…ุนุงู„ุฌุฉ ุบูŠุฑ ุงู„ู…ุชุฒุงู…ู†ุฉ", + "example": "http://my-server.com/v1/pass/callback" + }, + "request_id": { + "type": "string", + "title": "ู…ุนุฑู ุงู„ุทู„ุจ", + "description": "ุนู†ุฏ ุฅุนู„ุงู… ู†ุชูŠุฌุฉ ุงู„ู…ุนุงู„ุฌุฉุŒ ูŠุชู… ุฅุฑุณุงู„ ู…ุนุฑู ุงู„ุทู„ุจ ู…ุนู‹ุง. ุงูุชุฑุงุถูŠู‹ุงุŒ ูŠุชู… ุฅู†ุดุงุคู‡ ุชู„ู‚ุงุฆูŠู‹ุง ุจุชู†ุณูŠู‚ UUIDุŒ ูˆู„ูƒู† ุฅุฐุง ุชู… ุฅุฌุฑุงุก ุงุณุชุฏุนุงุก ุนู†ูˆุงู† URL ู„ู„ุฅุดุนุงุฑ ู‚ุจู„ ุนู…ู„ูŠุฉ ุงู„ุทู„ุจ ุบูŠุฑ ุงู„ู…ุชุฒุงู…ู† ุจุณุจุจ ู…ู†ุทู‚ ุฌุงู†ุจ ุงู„ุนู…ูŠู„ุŒ ููŠุฌุจ ุชุญุฏูŠุฏ request_id ู…ุณุจู‚ู‹ุง.", + "example": "55e41f9f-a5a6-4836-8490-68914ff51b64" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "ุงู„ุงุณุชุฌุงุจุฉ ุงู„ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AsyncPredictionResponseSerializer" + } + } + } + }, + "401": { + "description": "ู…ุณุชุฎุฏู… ุบูŠุฑ ู…ุตุงุฏู‚ ุนู„ูŠู‡", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ุจูŠุงู†ุงุช ุงู„ุทู„ุจ ุงู„ู…ุทู„ูˆุจุฉ ู…ูู‚ูˆุฏุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/ai/apply/text-prediction/async": { + "post": { + "tags": [ + "AI" + ], + "summary": "[ู…ุฏููˆุน] ุชู†ููŠุฐ ุชู†ุจุค ุฏุนู… ุงู„ู†ุต (ุบูŠุฑ ู…ุชุฒุงู…ู†)", + "description": "**ูŠู…ูƒู† ุงุณุชุฎุฏุงู… ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ู‡ุฐู‡ ุจุนุฏ ุนู‚ุฏ ู…ู†ูุตู„. (ุงู„ุงุณุชูุณุงุฑ: team-ml@wantedlab.com)** ู†ุธุฑู‹ุง ู„ุฃู†ู‡ ูŠุชู… ุชู†ููŠุฐ ุงู„ุชู†ุจุค ุจุดูƒู„ ุบูŠุฑ ู…ุชุฒุงู…ู†ุŒ ูŠุชู… ุฅูƒู…ุงู„ ุงุณุชุฏุนุงุก ูˆุงุฌู‡ุฉ ุจุฑู…ุฌุฉ ุงู„ุชุทุจูŠู‚ุงุช ุนู„ู‰ ุงู„ููˆุฑ ูˆูŠุชู… ุชุณู„ูŠู… ุงู„ู†ุชูŠุฌุฉ ุฅู„ู‰ callback_url.** (ุงุชุตู„ ู…ุฑุฉ ูˆุงุญุฏุฉ ุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ ู„ุนุฏุฏ ุจูŠุงู†ุงุช ุงู„ุฅุฏุฎุงู„ ู‡ูˆ 50.)**", + "operationId": "_์œ ๋ฃŒ__ํ…์ŠคํŠธ_์ง€์›์˜ˆ์ธก_์‹คํ–‰_๋น„๋™๊ธฐ__ai_apply_text_prediction_async_post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "title": "ุจูŠุงู†ุงุช ุงู„ุฅุฏุฎุงู„", + "description": "ู…ุง ูŠุตู„ ุฅู„ู‰ 50", + "type": "object", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/ResumeJdTextPredictionItemSerializer" + }, + "type": "array", + "title": "ู‚ุงุฆู…ุฉ ุจูŠุงู†ุงุช ุทู„ุจ ุงู„ุชู†ุจุค" + }, + "callback_url": { + "type": "string", + "title": "ุนู†ูˆุงู† ุฑุฏ ุงู„ุงุชุตุงู„", + "description": "ุนู†ูˆุงู† URL ู„ูŠุชู… ุฅุนู„ุงู…ูƒ ุจุงู„ู†ุชูŠุฌุฉ ุจุนุฏ ุงู„ู…ุนุงู„ุฌุฉ ุบูŠุฑ ุงู„ู…ุชุฒุงู…ู†ุฉ", + "example": "http://my-server.com/v1/apply/callback" + }, + "request_id": { + "type": "string", + "title": "ู…ุนุฑู ุงู„ุทู„ุจ", + "description": "ุนู†ุฏ ุฅุนู„ุงู… ู†ุชูŠุฌุฉ ุงู„ู…ุนุงู„ุฌุฉุŒ ูŠุชู… ุฅุฑุณุงู„ ู…ุนุฑู ุงู„ุทู„ุจ ู…ุนู‹ุง. ุงูุชุฑุงุถูŠู‹ุงุŒ ูŠุชู… ุฅู†ุดุงุคู‡ ุชู„ู‚ุงุฆูŠู‹ุง ุจุชู†ุณูŠู‚ UUIDุŒ ูˆู„ูƒู† ุฅุฐุง ุชู… ุฅุฌุฑุงุก ุงุณุชุฏุนุงุก ุนู†ูˆุงู† URL ู„ู„ุฅุดุนุงุฑ ู‚ุจู„ ุนู…ู„ูŠุฉ ุงู„ุทู„ุจ ุบูŠุฑ ุงู„ู…ุชุฒุงู…ู† ุจุณุจุจ ู…ู†ุทู‚ ุฌุงู†ุจ ุงู„ุนู…ูŠู„ุŒ ููŠุฌุจ ุชุญุฏูŠุฏ request_id ู…ุณุจู‚ู‹ุง.", + "example": "55e41f9f-a5a6-4836-8490-68914ff51b64" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "ุงู„ุงุณุชุฌุงุจุฉ ุงู„ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AsyncPredictionResponseSerializer" + } + } + } + }, + "401": { + "description": "ู…ุณุชุฎุฏู… ุบูŠุฑ ู…ุตุงุฏู‚ ุนู„ูŠู‡", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ุจูŠุงู†ุงุช ุงู„ุทู„ุจ ุงู„ู…ุทู„ูˆุจุฉ ู…ูู‚ูˆุฏุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/applications": { + "get": { + "tags": [ + "Application" + ], + "summary": "ุนุฑุถ ู‚ุงุฆู…ุฉ ุงู„ุฏุนู…", + "operationId": "get_application_list_applications_get", + "parameters": [ + { + "description": "ู…ุตุทู„ุญ ุงู„ุจุญุซ (ุงุณู… ุงู„ุดุฑูƒุฉ/ุงุณู… ุงู„ู…ู†ุตุจ/ุงุณู… ู…ู‚ุฏู… ุงู„ุทู„ุจ)", + "required": false, + "schema": { + "type": "string", + "title": "ุณ", + "description": "ู…ุตุทู„ุญ ุงู„ุจุญุซ (ุงุณู… ุงู„ุดุฑูƒุฉ/ุงุณู… ุงู„ู…ู†ุตุจ/ุงุณู… ู…ู‚ุฏู… ุงู„ุทู„ุจ)" + }, + "name": "q", + "in": "query" + }, + { + "description": "ู…ุนุฑู ุงู„ู…ู†ุตุจ", + "required": false, + "schema": { + "type": "integer", + "title": "ู…ุนุฑู ุงู„ูˆุธูŠูุฉ", + "description": "ู…ุนุฑู ุงู„ู…ู†ุตุจ" + }, + "name": "job_id", + "in": "query" + }, + { + "description": "ุญุงู„ุฉ ุงู„ุทู„ุจุ› ูƒุงู…ู„ (ุชู… ุงุณุชู„ุงู… ุงู„ุทู„ุจ)ุŒ ุงุฌุชูŠุงุฒ (ุชู… ุชู…ุฑูŠุฑ ุงู„ู…ุณุชู†ุฏุงุช)ุŒ ุฑูุถ (ู„ู… ูŠุชู… ุงุฌุชูŠุงุฒู‡)ุŒ ุชูˆุธูŠู (ุงู„ู‚ุจูˆู„ ุงู„ู†ู‡ุงุฆูŠ)", + "required": false, + "schema": { + "items": { + "$ref": "#/components/schemas/ApplicationStatusSearchEnum" + }, + "type": "array", + "description": "ุญุงู„ุฉ ุงู„ุทู„ุจุ› ูƒุงู…ู„ (ุชู… ุงุณุชู„ุงู… ุงู„ุทู„ุจ)ุŒ ุงุฌุชูŠุงุฒ (ุชู… ุชู…ุฑูŠุฑ ุงู„ู…ุณุชู†ุฏุงุช)ุŒ ุฑูุถ (ู„ู… ูŠุชู… ุงุฌุชูŠุงุฒู‡)ุŒ ุชูˆุธูŠู (ุงู„ู‚ุจูˆู„ ุงู„ู†ู‡ุงุฆูŠ)" + }, + "name": "status", + "in": "query" + }, + { + "description": "ู†ุทุงู‚ ุจุฏุก ุชุงุฑูŠุฎ ุชู‚ุฏูŠู… ุงู„ุทู„ุจ (ุงู„ุชู†ุณูŠู‚: YYYY-MM-DD)", + "required": false, + "schema": { + "type": "string", + "format": "date", + "title": "ุชุงุฑูŠุฎ ุงู„ุจุฏุก", + "description": "ู†ุทุงู‚ ุจุฏุก ุชุงุฑูŠุฎ ุชู‚ุฏูŠู… ุงู„ุทู„ุจ (ุงู„ุชู†ุณูŠู‚: YYYY-MM-DD)" + }, + "name": "start_date", + "in": "query" + }, + { + "description": "ุงู„ู†ุทุงู‚ ุงู„ู†ู‡ุงุฆูŠ ู„ุชุงุฑูŠุฎ ุชู‚ุฏูŠู… ุงู„ุทู„ุจ (ุงู„ุชู†ุณูŠู‚: YYYY-MM-DD)", + "required": false, + "schema": { + "type": "string", + "format": "date", + "title": "ุชุงุฑูŠุฎ ุงู„ุงู†ุชู‡ุงุก", + "description": "ุงู„ู†ุทุงู‚ ุงู„ู†ู‡ุงุฆูŠ ู„ุชุงุฑูŠุฎ ุชู‚ุฏูŠู… ุงู„ุทู„ุจ (ุงู„ุชู†ุณูŠู‚: YYYY-MM-DD)" + }, + "name": "end_date", + "in": "query" + }, + { + "description": "ุตุญูŠุญ ุนู†ุฏ ุนุฑุถ ุงู„ุชุทุจูŠู‚ ุงู„ู…ู„ุบู‰", + "required": false, + "schema": { + "type": "boolean", + "title": "ู‡ู„ ุงู„ุฅู„ุบุงุก", + "description": "ุตุญูŠุญ ุนู†ุฏ ุนุฑุถ ุงู„ุชุทุจูŠู‚ ุงู„ู…ู„ุบู‰", + "default": false + }, + "name": "is_cancel", + "in": "query" + }, + { + "required": false, + "schema": { + "type": "integer", + "title": "ุฅุฒุงุญุฉ", + "default": 0 + }, + "name": "offset", + "in": "query" + }, + { + "required": false, + "schema": { + "type": "integer", + "title": "ุญุฏ", + "default": 20 + }, + "name": "limit", + "in": "query" + } + ], + "responses": { + "200": { + "description": "ุงู„ุงุณุชุฌุงุจุฉ ุงู„ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationListResponseSerializer" + } + } + } + }, + "401": { + "description": "ู…ุณุชุฎุฏู… ุบูŠุฑ ู…ุตุงุฏู‚ ุนู„ูŠู‡", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ุจูŠุงู†ุงุช ุงู„ุทู„ุจ ุงู„ู…ุทู„ูˆุจุฉ ู…ูู‚ูˆุฏุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + }, + { + "PermissionsDependency": [] + } + ] + }, + "post": { + "tags": [ + "Application" + ], + "summary": "ุชุทุจูŠู‚ ุงู„ู…ูˆู‚ู", + "operationId": "apply_for_job_applications_post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplyJobRequestSerializer" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "ุงู„ุงุณุชุฌุงุจุฉ ุงู„ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationResponseSerializer" + } + } + } + }, + "400": { + "description": "ุงู‚ุชุฑุงุญ ุบูŠุฑ ุฌูŠุฏ", + "content": { + "application/json": { + "examples": { + "AlreadyAppliedJob": { + "value": { + "error_code": "AlreadyAppliedJob", + "message": "์ด๋ฏธ ์ง€์›ํ•œ ํฌ์ง€์…˜์ž…๋‹ˆ๋‹ค." + } + }, + "JobNotExists": { + "value": { + "error_code": "JobNotExists", + "message": "์กด์žฌํ•˜์ง€ ์•Š๋Š” ํฌ์ง€์…˜์ž…๋‹ˆ๋‹ค." + } + }, + "FileNotFound": { + "value": { + "error_code": "FileNotFound", + "message": "์กด์žฌํ•˜์ง€ ์•Š๋Š” ํŒŒ์ผ์ž…๋‹ˆ๋‹ค." + } + }, + "DuplicateFile": { + "value": { + "error_code": "DuplicateFile", + "message": "์ค‘๋ณต๋œ ํŒŒ์ผ๋กœ ์ง€์›ํ•  ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค." + } + } + } + } + } + }, + "401": { + "description": "ู…ุณุชุฎุฏู… ุบูŠุฑ ู…ุตุงุฏู‚ ุนู„ูŠู‡", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ุจูŠุงู†ุงุช ุงู„ุทู„ุจ ุงู„ู…ุทู„ูˆุจุฉ ู…ูู‚ูˆุฏุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/applications/{application_id}/cancel": { + "patch": { + "tags": [ + "Application" + ], + "summary": "ุฅู„ุบุงุก ุงู„ุฏุนู…", + "operationId": "cancel_application_applications__application_id__cancel_patch", + "parameters": [ + { + "required": true, + "schema": { + "type": "integer", + "title": "ู…ุนุฑู ุงู„ุชุทุจูŠู‚" + }, + "name": "application_id", + "in": "path" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CancelApplicationRequestSerializer" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "ุงู„ุงุณุชุฌุงุจุฉ ุงู„ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": {} + } + } + }, + "400": { + "description": "ุงู‚ุชุฑุงุญ ุบูŠุฑ ุฌูŠุฏ", + "content": { + "application/json": { + "examples": { + "ApplicationNotFound": { + "value": { + "error_code": "ApplicationNotFound", + "message": "์กด์žฌํ•˜์ง€ ์•Š๋Š” ์ง€์›์„œ์ž…๋‹ˆ๋‹ค." + } + } + } + } + } + }, + "401": { + "description": "ู…ุณุชุฎุฏู… ุบูŠุฑ ู…ุตุงุฏู‚ ุนู„ูŠู‡", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ุจูŠุงู†ุงุช ุงู„ุทู„ุจ ุงู„ู…ุทู„ูˆุจุฉ ู…ูู‚ูˆุฏุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/companies/{company_id}": { + "get": { + "tags": [ + "Company" + ], + "summary": "ุงู„ุงุณุชูุณุงุฑ ุนู† ุชูุงุตูŠู„ ุงู„ุดุฑูƒุฉ", + "operationId": "get_company_companies__company_id__get", + "parameters": [ + { + "required": true, + "schema": { + "type": "integer", + "title": "ู…ุนุฑู ุงู„ุดุฑูƒุฉ" + }, + "name": "company_id", + "in": "path" + } + ], + "responses": { + "200": { + "description": "ุงู„ุงุณุชุฌุงุจุฉ ุงู„ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompanyResponseSerializer" + } + } + } + }, + "400": { + "description": "ุงู‚ุชุฑุงุญ ุบูŠุฑ ุฌูŠุฏ", + "content": { + "application/json": { + "examples": { + "JobNotExists": { + "value": { + "error_code": "JobNotExists", + "message": "์กด์žฌํ•˜์ง€ ์•Š๋Š” ํฌ์ง€์…˜์ž…๋‹ˆ๋‹ค." + } + } + } + } + } + }, + "401": { + "description": "ู…ุณุชุฎุฏู… ุบูŠุฑ ู…ุตุงุฏู‚ ุนู„ูŠู‡", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ุจูŠุงู†ุงุช ุงู„ุทู„ุจ ุงู„ู…ุทู„ูˆุจุฉ ู…ูู‚ูˆุฏุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/companies/{company_id}/jobs": { + "get": { + "tags": [ + "Company" + ], + "summary": "ุนุฑุถ ู‚ุงุฆู…ุฉ ุงู„ูˆุธุงุฆู ุงู„ุชูŠ ูŠุชู… ุชุนูŠูŠู†ู‡ุง ุญุงู„ูŠุง ู…ู† ู‚ุจู„ ุงู„ุดุฑูƒุฉ", + "operationId": "get_company_job_list_companies__company_id__jobs_get", + "parameters": [ + { + "required": true, + "schema": { + "type": "integer", + "title": "ู…ุนุฑู ุงู„ุดุฑูƒุฉ" + }, + "name": "company_id", + "in": "path" + }, + { + "required": false, + "schema": { + "type": "integer", + "title": "ุฅุฒุงุญุฉ", + "default": 0 + }, + "name": "offset", + "in": "query" + }, + { + "required": false, + "schema": { + "type": "integer", + "title": "ุญุฏ", + "default": 12 + }, + "name": "limit", + "in": "query" + } + ], + "responses": { + "200": { + "description": "ุงู„ุงุณุชุฌุงุจุฉ ุงู„ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompanyJobListResponseSerializer" + } + } + } + }, + "401": { + "description": "ู…ุณุชุฎุฏู… ุบูŠุฑ ู…ุตุงุฏู‚ ุนู„ูŠู‡", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ุจูŠุงู†ุงุช ุงู„ุทู„ุจ ุงู„ู…ุทู„ูˆุจุฉ ู…ูู‚ูˆุฏุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/jobs": { + "get": { + "tags": [ + "Job" + ], + "summary": "(ุจุญุซ) ู‚ุงุฆู…ุฉ ู…ูˆุงู‚ุน ุงู„ุจุญุซ", + "operationId": "get_job_list_jobs_get", + "parameters": [ + { + "description": "ู…ุนุฑู ุนู„ุงู…ุฉ ุงู„ูˆุธูŠูุฉ/ุงู„ูˆุธูŠูุฉ (ุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ 5)", + "required": false, + "schema": { + "items": { + "type": "integer" + }, + "type": "array", + "maxItems": 5, + "minItems": 0, + "title": "ุนู„ุงู…ุงุช ุงู„ูุฆุฉ", + "description": "ู…ุนุฑู ุนู„ุงู…ุฉ ุงู„ูˆุธูŠูุฉ/ุงู„ูˆุธูŠูุฉ (ุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ 5)" + }, + "name": "category_tags", + "in": "query" + }, + { + "description": "ู…ุนุฑู ุนู„ุงู…ุฉ ุงู„ู…ู‡ุงุฑุฉ (ุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ 5)", + "required": false, + "schema": { + "items": { + "type": "integer" + }, + "type": "array", + "maxItems": 5, + "minItems": 0, + "title": "ุนู„ุงู…ุงุช ุงู„ู…ู‡ุงุฑุฉ", + "description": "ู…ุนุฑู ุนู„ุงู…ุฉ ุงู„ู…ู‡ุงุฑุฉ (ุงู„ุญุฏ ุงู„ุฃู‚ุตู‰ 5)" + }, + "name": "skill_tags", + "in": "query" + }, + { + "description": "ุงู„ุชุงุฑูŠุฎ ุงู„ุดุฎุตูŠ. ุนู†ุฏ ุฏุฎูˆู„ ุงู„ุฑู‚ู… 10ุŒ ูŠุชู… ุนุฑุถ ุงู„ูˆุธุงุฆู ุงู„ุชูŠ ุชุชู…ุชุน ุจุฎุจุฑุฉ ุชุฒูŠุฏ ุนู† 10 ุณู†ูˆุงุช.", + "required": false, + "schema": { + "items": { + "type": "integer", + "maximum": 10, + "minimum": 0 + }, + "type": "array", + "maximum": 10, + "minimum": 0, + "maxItems": 2, + "title": "ุณู†ูŠู†", + "description": "ุงู„ุชุงุฑูŠุฎ ุงู„ุดุฎุตูŠ. ุนู†ุฏ ุฏุฎูˆู„ ุงู„ุฑู‚ู… 10ุŒ ูŠุชู… ุนุฑุถ ุงู„ูˆุธุงุฆู ุงู„ุชูŠ ุชุชู…ุชุน ุจุฎุจุฑุฉ ุชุฒูŠุฏ ุนู† 10 ุณู†ูˆุงุช." + }, + "name": "years", + "in": "query" + }, + { + "description": "ู…ู†ุทู‚ุฉ. ุฃู…ุฉ", + "required": false, + "schema": { + "items": { + "type": "string" + }, + "type": "array", + "title": "ุงู„ู…ูˆุงู‚ุน", + "description": "ู…ู†ุทู‚ุฉ. ุฃู…ุฉ" + }, + "name": "locations", + "in": "query" + }, + { + "description": "ุตููŠู", + "required": false, + "schema": { + "description": "ุตููŠู" + }, + "name": "sort", + "in": "query" + }, + { + "required": false, + "schema": { + "type": "integer", + "title": "ุฅุฒุงุญุฉ", + "default": 0 + }, + "name": "offset", + "in": "query" + }, + { + "required": false, + "schema": { + "type": "integer", + "title": "ุญุฏ", + "default": 20 + }, + "name": "limit", + "in": "query" + } + ], + "responses": { + "200": { + "description": "ุงู„ุงุณุชุฌุงุจุฉ ุงู„ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JobListResponseSerializer" + } + } + } + }, + "401": { + "description": "ู…ุณุชุฎุฏู… ุบูŠุฑ ู…ุตุงุฏู‚ ุนู„ูŠู‡", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ุจูŠุงู†ุงุช ุงู„ุทู„ุจ ุงู„ู…ุทู„ูˆุจุฉ ู…ูู‚ูˆุฏุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/jobs/{job_id}": { + "get": { + "tags": [ + "Job" + ], + "summary": "ุงู„ุงุณุชุนู„ุงู… ุนู† ุชูุงุตูŠู„ ุงู„ูˆุธูŠูุฉ", + "operationId": "get_job_jobs__job_id__get", + "parameters": [ + { + "required": true, + "schema": { + "type": "integer", + "title": "ู…ุนุฑู ุงู„ู…ู†ุตุจ" + }, + "name": "job_id", + "in": "path" + } + ], + "responses": { + "200": { + "description": "ุงู„ุงุณุชุฌุงุจุฉ ุงู„ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/openapi__apis__v1__jobs__serializers__JobResponseSerializer" + } + } + } + }, + "400": { + "description": "ุงู‚ุชุฑุงุญ ุบูŠุฑ ุฌูŠุฏ", + "content": { + "application/json": { + "examples": { + "JobNotExists": { + "value": { + "error_code": "JobNotExists", + "message": "์กด์žฌํ•˜์ง€ ์•Š๋Š” ํฌ์ง€์…˜์ž…๋‹ˆ๋‹ค." + } + } + } + } + } + }, + "401": { + "description": "ู…ุณุชุฎุฏู… ุบูŠุฑ ู…ุตุงุฏู‚ ุนู„ูŠู‡", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ุจูŠุงู†ุงุช ุงู„ุทู„ุจ ุงู„ู…ุทู„ูˆุจุฉ ู…ูู‚ูˆุฏุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/tags/categories": { + "get": { + "tags": [ + "Tag" + ], + "summary": "ุงู„ุจุญุซ ุนู† ูˆุธูŠูุฉ/ู‚ุงุฆู…ุฉ ุงู„ูˆุธุงุฆู", + "operationId": "get_categories_tags_categories_get", + "responses": { + "200": { + "description": "ุงู„ุงุณุชุฌุงุจุฉ ุงู„ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagListResponseSerializer" + } + } + } + }, + "401": { + "description": "ู…ุณุชุฎุฏู… ุบูŠุฑ ู…ุตุงุฏู‚ ุนู„ูŠู‡", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ุจูŠุงู†ุงุช ุงู„ุทู„ุจ ุงู„ู…ุทู„ูˆุจุฉ ู…ูู‚ูˆุฏุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/tags/skills": { + "get": { + "tags": [ + "Tag" + ], + "summary": "ุงู„ุงุณุชุนู„ุงู… ุนู† ู‚ุงุฆู…ุฉ ุงู„ู…ู‡ุงุฑุงุช", + "operationId": "get_skills_tags_skills_get", + "parameters": [ + { + "required": true, + "schema": { + "type": "string", + "title": "ุงู„ูƒู„ู…ุฉ ุงู„ุฑุฆูŠุณูŠุฉ" + }, + "name": "keyword", + "in": "query" + } + ], + "responses": { + "200": { + "description": "ุงู„ุงุณุชุฌุงุจุฉ ุงู„ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SkillListResponseSerializer" + } + } + } + }, + "401": { + "description": "ู…ุณุชุฎุฏู… ุบูŠุฑ ู…ุตุงุฏู‚ ุนู„ูŠู‡", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ุจูŠุงู†ุงุช ุงู„ุทู„ุจ ุงู„ู…ุทู„ูˆุจุฉ ู…ูู‚ูˆุฏุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/search/company/autocomplate": { + "get": { + "tags": [ + "Search" + ], + "summary": "ู…ุตุงุฏู‚ุฉ", + "operationId": "authcomplate_search_company_autocomplate_get", + "parameters": [ + { + "description": "ุงุณู… ุงู„ุดุฑูƒุฉ ู„ู„ุจุญุซ", + "required": false, + "schema": { + "type": "string", + "title": "ุงุณุชูุณุงุฑ", + "description": "ุงุณู… ุงู„ุดุฑูƒุฉ ู„ู„ุจุญุซ" + }, + "name": "query", + "in": "query" + } + ], + "responses": { + "200": { + "description": "ุงู„ุงุณุชุฌุงุจุฉ ุงู„ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompanyAutoCompleteResponseSerializer" + } + } + } + }, + "401": { + "description": "ู…ุณุชุฎุฏู… ุบูŠุฑ ู…ุตุงุฏู‚ ุนู„ูŠู‡", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ุจูŠุงู†ุงุช ุงู„ุทู„ุจ ุงู„ู…ุทู„ูˆุจุฉ ู…ูู‚ูˆุฏุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/search/company": { + "get": { + "tags": [ + "Search" + ], + "summary": "ุดุฑูƒุงุช ุงู„ุจุญุซ", + "operationId": "search_companies_search_company_get", + "parameters": [ + { + "description": "ุงุณู… ุงู„ุดุฑูƒุฉ ุฃูˆ ุฑู‚ู… ุงู„ุณุฌู„ ุงู„ุชุฌุงุฑูŠ ู„ู„ุจุญุซ ุนู†ู‡", + "required": true, + "schema": { + "type": "string", + "title": "ุงุณุชูุณุงุฑ", + "description": "ุงุณู… ุงู„ุดุฑูƒุฉ ุฃูˆ ุฑู‚ู… ุงู„ุณุฌู„ ุงู„ุชุฌุงุฑูŠ ู„ู„ุจุญุซ ุนู†ู‡" + }, + "name": "query", + "in": "query" + }, + { + "required": false, + "schema": { + "type": "integer", + "title": "ุฅุฒุงุญุฉ", + "default": 0 + }, + "name": "offset", + "in": "query" + }, + { + "required": false, + "schema": { + "type": "integer", + "title": "ุญุฏ", + "default": 20 + }, + "name": "limit", + "in": "query" + } + ], + "responses": { + "200": { + "description": "ุงู„ุงุณุชุฌุงุจุฉ ุงู„ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchCompanyResponseSerializer" + } + } + } + }, + "401": { + "description": "ู…ุณุชุฎุฏู… ุบูŠุฑ ู…ุตุงุฏู‚ ุนู„ูŠู‡", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ุจูŠุงู†ุงุช ุงู„ุทู„ุจ ุงู„ู…ุทู„ูˆุจุฉ ู…ูู‚ูˆุฏุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/files": { + "get": { + "tags": [ + "File" + ], + "summary": "ุนุฑุถ ู‚ุงุฆู…ุฉ ุงู„ู…ู„ูุงุช ุงู„ู…ุฑูู‚ุฉ", + "operationId": "get_file_list_files_get", + "parameters": [ + { + "required": false, + "schema": { + "type": "integer", + "title": "ุฅุฒุงุญุฉ", + "default": 0 + }, + "name": "offset", + "in": "query" + }, + { + "required": false, + "schema": { + "type": "integer", + "title": "ุญุฏ", + "default": 20 + }, + "name": "limit", + "in": "query" + } + ], + "responses": { + "200": { + "description": "ุงู„ุงุณุชุฌุงุจุฉ ุงู„ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetFileListResponseSerializer" + } + } + } + }, + "401": { + "description": "ู…ุณุชุฎุฏู… ุบูŠุฑ ู…ุตุงุฏู‚ ุนู„ูŠู‡", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ุจูŠุงู†ุงุช ุงู„ุทู„ุจ ุงู„ู…ุทู„ูˆุจุฉ ู…ูู‚ูˆุฏุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + }, + { + "PermissionsDependency": [] + } + ] + }, + "post": { + "tags": [ + "File" + ], + "summary": "ุชุญู…ูŠู„ ู…ู„ู ู…ุฑูู‚ ุงู„ุชุทุจูŠู‚", + "description": "**ูƒูŠููŠุฉ ุชุญู…ูŠู„ ู…ู„ู** 1. ุงุทู„ุจ `POST /v1/files/upload-url` 2. ู‚ู… ุจุชุญู…ูŠู„ ู…ู„ู ู…ุคู‚ุช ู…ู† ุฎู„ุงู„ ุงู„ุงุณุชุฌุงุจุฉ 1 `presigned_url` ุฃ. `presigned_url` ุตุงู„ุญ ู„ู…ุฏุฉ 60 ุฏู‚ูŠู‚ุฉ ุจ. ูŠุทู„ุจ `presigned_url` ุฃุณู„ูˆุจ PUT ูˆุฑุฃุณ ู†ูˆุน ุงู„ู…ุญุชูˆู‰ ูƒู€ "application/binary" 3. ูŠูƒุชู…ู„ ุชุญู…ูŠู„ ุงู„ู…ู„ู ุนู† ุทุฑูŠู‚ ุฅุฏุฑุงุฌ `upload_key` ุงู„ุฎุงุต ุจุงู„ุงุณุชุฌุงุจุฉ 1 ููŠ ุจูŠุงู†ุงุช ุทู„ุจ `POST /v1/files`.", + "operationId": "upload_file_files_post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UploadFileRequestSerializer" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "ุงู„ุงุณุชุฌุงุจุฉ ุงู„ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UploadFileResponseSerializer" + } + } + } + }, + "401": { + "description": "ู…ุณุชุฎุฏู… ุบูŠุฑ ู…ุตุงุฏู‚ ุนู„ูŠู‡", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ุจูŠุงู†ุงุช ุงู„ุทู„ุจ ุงู„ู…ุทู„ูˆุจุฉ ู…ูู‚ูˆุฏุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/files/{file_key}/download": { + "get": { + "tags": [ + "File" + ], + "summary": "ุชุญู…ูŠู„ ุงู„ู…ู„ู ุงู„ู…ุฑูู‚", + "operationId": "get_download_url_files__file_key__download_get", + "parameters": [ + { + "required": true, + "schema": { + "type": "string", + "title": "ู…ูุชุงุญ ุงู„ู…ู„ู" + }, + "name": "file_key", + "in": "path" + } + ], + "responses": { + "200": { + "description": "ุงู„ุงุณุชุฌุงุจุฉ ุงู„ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetDownloadUrlResponseSerializer" + } + } + } + }, + "400": { + "description": "ุงู‚ุชุฑุงุญ ุบูŠุฑ ุฌูŠุฏ", + "content": { + "application/json": { + "examples": { + "FileNotFound": { + "value": { + "error_code": "FileNotFound", + "message": "์กด์žฌํ•˜์ง€ ์•Š๋Š” ํŒŒ์ผ์ž…๋‹ˆ๋‹ค." + } + } + } + } + } + }, + "401": { + "description": "ู…ุณุชุฎุฏู… ุบูŠุฑ ู…ุตุงุฏู‚ ุนู„ูŠู‡", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ุจูŠุงู†ุงุช ุงู„ุทู„ุจ ุงู„ู…ุทู„ูˆุจุฉ ู…ูู‚ูˆุฏุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/files/upload-url": { + "post": { + "tags": [ + "File" + ], + "summary": "ู‚ู… ุจุฅู†ุดุงุก ุนู†ูˆุงู† URL ู…ุญุฏุฏ ู…ุณุจู‚ู‹ุง ู„ุชุญู…ูŠู„ ุงู„ู…ู„ูุงุช ุงู„ู…ุฑูู‚ุฉ", + "operationId": "generate_presigned_url_files_upload_url_post", + "responses": { + "200": { + "description": "ุงู„ุงุณุชุฌุงุจุฉ ุงู„ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreatePresignedURLResponseSerializer" + } + } + } + }, + "401": { + "description": "ู…ุณุชุฎุฏู… ุบูŠุฑ ู…ุตุงุฏู‚ ุนู„ูŠู‡", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ุจูŠุงู†ุงุช ุงู„ุทู„ุจ ุงู„ู…ุทู„ูˆุจุฉ ู…ูู‚ูˆุฏุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/stat/application/summary": { + "get": { + "tags": [ + "Stat" + ], + "summary": "ุนุฑุถ ู…ู„ุฎุต ุญุงู„ุฉ ุงู„ุฏุนู… (ุญุณุจ ุงู„ุนู…ูŠู„)", + "operationId": "get_application_summary_by_client_stat_application_summary_get", + "parameters": [ + { + "description": "ู†ุทุงู‚ ุจุฏุก ุชุงุฑูŠุฎ ุชู‚ุฏูŠู… ุงู„ุทู„ุจ (ุงู„ุชู†ุณูŠู‚: YYYY-MM-DD)", + "required": false, + "schema": { + "type": "string", + "format": "date", + "title": "ุชุงุฑูŠุฎ ุงู„ุจุฏุก", + "description": "ู†ุทุงู‚ ุจุฏุก ุชุงุฑูŠุฎ ุชู‚ุฏูŠู… ุงู„ุทู„ุจ (ุงู„ุชู†ุณูŠู‚: YYYY-MM-DD)", + "default": "2023-11-24" + }, + "name": "start_date", + "in": "query" + }, + { + "description": "ุงู„ู†ุทุงู‚ ุงู„ู†ู‡ุงุฆูŠ ู„ุชุงุฑูŠุฎ ุชู‚ุฏูŠู… ุงู„ุทู„ุจ (ุงู„ุชู†ุณูŠู‚: YYYY-MM-DD)", + "required": false, + "schema": { + "type": "string", + "format": "date", + "title": "ุชุงุฑูŠุฎ ุงู„ุงู†ุชู‡ุงุก", + "description": "ุงู„ู†ุทุงู‚ ุงู„ู†ู‡ุงุฆูŠ ู„ุชุงุฑูŠุฎ ุชู‚ุฏูŠู… ุงู„ุทู„ุจ (ุงู„ุชู†ุณูŠู‚: YYYY-MM-DD)", + "default": "2024-02-22" + }, + "name": "end_date", + "in": "query" + } + ], + "responses": { + "200": { + "description": "ุงู„ุงุณุชุฌุงุจุฉ ุงู„ู†ุงุฌุญุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationSummaryResponseSerializer" + } + } + } + }, + "400": { + "description": "ุงู‚ุชุฑุงุญ ุบูŠุฑ ุฌูŠุฏ", + "content": { + "application/json": { + "examples": { + "InvalidDateRange": { + "value": { + "error_code": "InvalidDateRange", + "message": "์‹œ์ž‘ ๋‚ ์งœ์™€ ์ข…๋ฃŒ ๋‚ ์งœ์˜ ์ฐจ์ด๋Š” 90์ผ์„ ๋„˜์„ ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค." + } + } + } + } + } + }, + "401": { + "description": "ู…ุณุชุฎุฏู… ุบูŠุฑ ู…ุตุงุฏู‚ ุนู„ูŠู‡", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ุจูŠุงู†ุงุช ุงู„ุทู„ุจ ุงู„ู…ุทู„ูˆุจุฉ ู…ูู‚ูˆุฏุฉ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + } + }, + "components": { + "schemas": { + "AddressResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "ุจุทุงู‚ุฉ ุชุนุฑูŠู" + }, + "country": { + "type": "string", + "title": "ุฃู…ุฉ" + }, + "country_code": { + "type": "string", + "title": "ุฑู…ุฒ ุงู„ุจู„ุฏ" + }, + "location": { + "type": "string", + "title": "ู…ูˆู‚ุน" + }, + "full_location": { + "type": "string", + "title": "ุงู„ุนู†ูˆุงู† ุงู„ูƒุงู…ู„" + }, + "geo_location": { + "type": "object", + "title": "ุงู„ู…ูˆู‚ุน ุงู„ุฌุบุฑุงููŠ" + } + }, + "type": "object", + "title": "AddressResponseSerializer" + }, + "ApplicationListResponseSerializer": { + "properties": { + "links": { + "$ref": "#/components/schemas/LinksSchema" + }, + "applications": { + "items": { + "$ref": "#/components/schemas/ApplicationResponseSerializer" + }, + "type": "array", + "title": "ุงู„ุชุทุจูŠู‚ุงุช" + } + }, + "type": "object", + "title": "ApplicationListResponseSerializer" + }, + "ApplicationResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "ุจุทุงู‚ุฉ ุชุนุฑูŠู", + "description": "ู…ุนุฑู ุงู„ุชุทุจูŠู‚" + }, + "oneid": { + "type": "string", + "title": "ุฃูˆู†ูŠุฏ", + "description": "ู…ุนุฑู ู…ู‚ุฏู… ุงู„ุทู„ุจ" + }, + "username": { + "type": "string", + "title": "ุงุณู… ุงู„ู…ุณุชุฎุฏู…", + "description": "ุงุณู… ู…ู‚ุฏู… ุงู„ุทู„ุจ" + }, + "email": { + "type": "string", + "title": "ุจุฑูŠุฏ ุฅู„ูƒุชุฑูˆู†ูŠ", + "description": "ุงู„ุจุฑูŠุฏ ุงู„ุฅู„ูƒุชุฑูˆู†ูŠ ู„ู…ู‚ุฏู… ุงู„ุทู„ุจ" + }, + "mobile": { + "type": "string", + "title": "ู…ุชุญุฑูƒ", + "description": "ุฑู‚ู… ุงู„ู‡ุงุชู ุงู„ู…ู†ุณู‚ (ุนู„ู‰ ุณุจูŠู„ ุงู„ู…ุซุงู„ +821086388688)" + }, + "application_status": { + "description": "ุญุงู„ุฉ ุงู„ุชุทุจูŠู‚" + }, + "apply_time": { + "type": "string", + "format": "date-time", + "title": "ุชุทุจูŠู‚ ุงู„ูˆู‚ุช", + "description": "ูˆู‚ุช ุชู‚ุฏูŠู… ุงู„ุทู„ุจ" + }, + "edited_time": { + "type": "string", + "format": "date-time", + "title": "ุงู„ูˆู‚ุช ุงู„ู…ุญุฑุฑ", + "description": "ูˆู‚ุช ุชุนุฏูŠู„ ุงู„ุชุทุจูŠู‚" + }, + "open_time": { + "type": "string", + "format": "date-time", + "title": "ุงู„ูˆู‚ุช ุงู„ู…ูุชูˆุญ", + "description": "ุงู„ุชุทุจูŠู‚ ุฃูˆู„ ู…ุฑุฉ ู…ุดุงู‡ุฏุฉ" + }, + "cancel_time": { + "type": "string", + "format": "date-time", + "title": "ุฅู„ุบุงุก ุงู„ูˆู‚ุช", + "description": "ุฏุนู… ูˆู‚ุช ุงู„ุฅู„ุบุงุก" + }, + "cancel_reason": { + "type": "string", + "title": "ุฅู„ุบุงุก ุงู„ุณุจุจ", + "description": "ุณุจุจ ุฅู„ุบุงุก ุงู„ุทู„ุจ" + }, + "company_id": { + "type": "integer", + "title": "ู…ุนุฑู ุงู„ุดุฑูƒุฉ" + }, + "company_name": { + "type": "string", + "title": "ุงุณู… ุงู„ุดุฑูƒุฉ", + "description": "ุงุณู… ุงู„ุดุฑูƒุฉ" + }, + "job_id": { + "type": "integer", + "title": "ู…ุนุฑู ุงู„ูˆุธูŠูุฉ", + "description": "ู…ุนุฑู ุงู„ู…ู†ุตุจ" + }, + "job_name": { + "type": "string", + "title": "ุงุณู… ุงู„ูˆุธูŠูุฉ", + "description": "ุงุณู… ุงู„ูˆุธูŠูุฉ ูˆู‚ุช ุงู„ุชู‚ุฏูŠู…" + }, + "job_detail": { + "title": "ุชูุงุตูŠู„ ุงู„ูˆุธูŠูุฉ", + "description": "ุชูุงุตูŠู„ ุงู„ู…ูˆู‚ู", + "type": "object", + "properties": { + "id": { + "type": "integer", + "title": "ุจุทุงู‚ุฉ ุชุนุฑูŠู" + }, + "status": { + "$ref": "#/components/schemas/JobStatusEnum" + }, + "company_id": { + "type": "integer", + "title": "ู…ุนุฑู ุงู„ุดุฑูƒุฉ" + }, + "due_time": { + "type": "string", + "format": "date", + "title": "ุงู„ูˆู‚ุช ุงู„ู…ู†ุงุณุจ", + "description": "ู…ูˆุนุฏ ุงู„ุชุณู„ูŠู…" + }, + "logo_url": { + "$ref": "#/components/schemas/ImageUrlResponseSerializer" + } + } + }, + "resumes": { + "items": { + "$ref": "#/components/schemas/FilesResponseSerializer" + }, + "type": "array", + "title": "ูŠุณุชุฃู†ู", + "description": "ู‚ุงุฆู…ุฉ ุงู„ู…ุฑูู‚ุงุช" + } + }, + "type": "object", + "required": [ + "id", + "oneid", + "username", + "email", + "mobile", + "application_status", + "apply_time", + "company_id", + "job_id" + ], + "title": "ApplicationResponseSerializer", + "example": { + "id": 688129, + "oneid": "QrKSEkh74AFf", + "username": "์ง€์›์ž๋ช…", + "email": "user@test.com", + "mobile": "+821023456789", + "application_status": "complte", + "apply_time": "2023-03-15T02:09:27.883418", + "company_id": 1422, + "company_name": "์›ํ‹ฐ๋“œ๋žฉ", + "job_id": 23920, + "job_name": "ํฌ์ง€์…˜๋ช…", + "job_detail": { + "id": 23920, + "status": "active", + "company_id": 1, + "logo_url": { + "origin": "https://...", + "thumb": "https://..." + } + }, + "files": [ + { + "key": "qwefew-qweifj-1234", + "title": "ุงู„ุณูŠุฑุฉ ุงู„ุฐุงุชูŠุฉ.pdf", + "update_time": "2023-03-15T02:09:27.883418" + } + ] + } + }, + "ApplicationStatusSearchEnum": { + "oneOf": [ + { + "const": "complete", + "title": "ุญุงู„ุฉ ุงู„ุจุญุซ ุนู† ุงู„ุชุทุจูŠู‚", + "description": "ุงู„ุชุนุฏุงุฏ." + }, + { + "const": "pass", + "title": "ุญุงู„ุฉ ุงู„ุจุญุซ ุนู† ุงู„ุชุทุจูŠู‚", + "description": "ุงู„ุชุนุฏุงุฏ." + }, + { + "const": "reject", + "title": "ุญุงู„ุฉ ุงู„ุจุญุซ ุนู† ุงู„ุชุทุจูŠู‚", + "description": "ุงู„ุชุนุฏุงุฏ." + }, + { + "const": "hire", + "title": "ุญุงู„ุฉ ุงู„ุจุญุซ ุนู† ุงู„ุชุทุจูŠู‚", + "description": "ุงู„ุชุนุฏุงุฏ." + } + ], + "title": "ุญุงู„ุฉ ุงู„ุจุญุซ ุนู† ุงู„ุชุทุจูŠู‚", + "description": "ุงู„ุชุนุฏุงุฏ." + }, + "ApplicationSummaryResponseSerializer": { + "properties": { + "complete": { + "type": "integer", + "title": "ู…ูƒุชู…ู„", + "default": 0 + }, + "document_pass": { + "type": "integer", + "title": "ู…ู…ุฑ ุงู„ูˆุซูŠู‚ุฉ", + "default": 0 + }, + "hire": { + "type": "integer", + "title": "ุฃู‡ู„ุงู‹", + "default": 0 + }, + "reject": { + "type": "integer", + "title": "ูŠุฑูุถ", + "default": 0 + }, + "total": { + "type": "integer", + "title": "ุงู„ู…ุฌู…ูˆุน", + "default": 0 + } + }, + "type": "object", + "title": "ู…ู„ุฎุต ุงู„ุชุทุจูŠู‚ุงู„ุงุณุชุฌุงุจุฉSerializer", + "example": { + "complete": 1, + "document_pass": 1, + "hire": 0, + "reject": 1, + "total": 3 + } + }, + "ApplyJobRequestSerializer": { + "properties": { + "job_id": { + "type": "integer", + "title": "ู…ุนุฑู ุงู„ูˆุธูŠูุฉ" + }, + "username": { + "type": "string", + "title": "ุงุณู… ุงู„ู…ุณุชุฎุฏู…" + }, + "email": { + "type": "string", + "title": "ุจุฑูŠุฏ ุฅู„ูƒุชุฑูˆู†ูŠ" + }, + "mobile": { + "type": "string", + "title": "ู…ุชุญุฑูƒ" + }, + "resume_keys": { + "items": { + "type": "string" + }, + "type": "array", + "title": "ุงุณุชุฆู†ุงู ุงู„ู…ูุงุชูŠุญ", + "description": "ู‚ุงุฆู…ุฉ ุงู„ู…ู„ูุงุช ุงู„ุชูŠ ูŠุฌุจ ุฅุฑูุงู‚ู‡ุง ุนู†ุฏ ุงู„ุชู‚ุฏูŠู…" + } + }, + "type": "object", + "required": [ + "job_id", + "username", + "email", + "mobile", + "resume_keys" + ], + "title": "ApplyJobRequestSerializer" + }, + "ApplyTextPredictionRequestSerializer": { + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/ResumeJdTextPredictionItemSerializer" + }, + "type": "array", + "title": "ู‚ุงุฆู…ุฉ ุจูŠุงู†ุงุช ุทู„ุจ ุงู„ุชู†ุจุค" + }, + "callback_url": { + "type": "string", + "title": "ุนู†ูˆุงู† ุฑุฏ ุงู„ุงุชุตุงู„", + "description": "ุนู†ูˆุงู† URL ู„ูŠุชู… ุฅุนู„ุงู…ูƒ ุจุงู„ู†ุชูŠุฌุฉ ุจุนุฏ ุงู„ู…ุนุงู„ุฌุฉ ุบูŠุฑ ุงู„ู…ุชุฒุงู…ู†ุฉ", + "example": "http://my-server.com/v1/apply/callback" + }, + "request_id": { + "type": "string", + "title": "ู…ุนุฑู ุงู„ุทู„ุจ", + "description": "ุนู†ุฏ ุฅุนู„ุงู… ู†ุชูŠุฌุฉ ุงู„ู…ุนุงู„ุฌุฉุŒ ูŠุชู… ุฅุฑุณุงู„ ู…ุนุฑู ุงู„ุทู„ุจ ู…ุนู‹ุง. ุงูุชุฑุงุถูŠู‹ุงุŒ ูŠุชู… ุฅู†ุดุงุคู‡ ุชู„ู‚ุงุฆูŠู‹ุง ุจุชู†ุณูŠู‚ UUIDุŒ ูˆู„ูƒู† ุฅุฐุง ุชู… ุฅุฌุฑุงุก ุงุณุชุฏุนุงุก ุนู†ูˆุงู† URL ู„ู„ุฅุดุนุงุฑ ู‚ุจู„ ุนู…ู„ูŠุฉ ุงู„ุทู„ุจ ุบูŠุฑ ุงู„ู…ุชุฒุงู…ู† ุจุณุจุจ ู…ู†ุทู‚ ุฌุงู†ุจ ุงู„ุนู…ูŠู„ุŒ ููŠุฌุจ ุชุญุฏูŠุฏ request_id ู…ุณุจู‚ู‹ุง.", + "example": "55e41f9f-a5a6-4836-8490-68914ff51b64" + } + }, + "type": "object", + "required": [ + "data", + "callback_url" + ], + "title": "ApplyTextPredictionRequestSerializer" + }, + "AsyncPredictionResponseSerializer": { + "properties": { + "request_id": { + "type": "string", + "title": "ู…ุนุฑู ุงู„ุทู„ุจ", + "description": "ุนู†ุฏ ุงู„ุงุชุตุงู„ ุจู€ CallbackURLุŒ ูŠุชู… ุฃูŠุถู‹ุง ุชู…ุฑูŠุฑ ู…ุนุฑู ุงู„ุทู„ุจ ู„ุชู…ูŠูŠุฒ ุงู„ุทู„ุจ ุงู„ุฐูŠ ุฌุงุกุช ุงู„ู†ุชูŠุฌุฉ ู…ู†ู‡.", + "example": "55e41f9f-a5a6-4836-8490-68914ff51b64" + } + }, + "type": "object", + "required": [ + "request_id" + ], + "title": "AsyncPredictionResponseSerializer" + }, + "CancelApplicationRequestSerializer": { + "properties": { + "cancel_reason": { + "type": "string", + "title": "ุฅู„ุบุงุก ุงู„ุณุจุจ" + } + }, + "type": "object", + "title": "CancelApplicationRequestSerializer" + }, + "CategoryTagResponseSerializer": { + "properties": { + "parent_tag": { + "title": "ุฅุดุบุงู„", + "type": "object", + "properties": { + "id": { + "type": "integer", + "title": "ู…ุนุฑู ุงู„ุนู„ุงู…ุฉ" + }, + "text": { + "type": "string", + "title": "ุงุณู… ุงู„ุนู„ุงู…ุฉ" + } + } + }, + "child_tags": { + "items": { + "$ref": "#/components/schemas/openapi__apis__v1__jobs__serializers__TagResponseSerializer" + }, + "type": "array", + "title": "ูˆุธูŠูุฉ" + } + }, + "type": "object", + "title": "ูุฆุฉ TagResponseSerializer" + }, + "CompanyAutoCompleteResponseSerializer": { + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/_CompanyAutoCompleteSerializer" + }, + "type": "array", + "title": "ุจูŠุงู†ุงุช" + } + }, + "type": "object", + "title": "CompanyAutoCompleteResponseSerializer", + "example": { + "data": [ + { + "company_id": 518, + "name": "์›ํ‹ฐ๋“œ๋žฉ", + "logo_image": "https://image.jpg" + } + ] + } + }, + "CompanyDetailResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "ู…ุนุฑู ุงู„ุดุฑูƒุฉ" + }, + "company_confirm": { + "type": "boolean", + "title": "ู…ูˆุงูู‚ุฉ ุงู„ุดุฑูƒุฉ", + "description": "ุตุญูŠุญ: ุชู…ุช ุงู„ู…ูˆุงูู‚ุฉ ุนู„ูŠู‡ุŒ ุฎุทุฃ: ุชู…ุช ุงู„ู…ูˆุงูู‚ุฉ ุนู„ูŠู‡ ู…ุฑููˆุถุŒ ุชู… ุทู„ุจ ุงู„ู…ูˆุงูู‚ุฉุŒ ู„ู… ูŠุชู… ุทู„ุจ ุงู„ู…ูˆุงูู‚ุฉ" + }, + "registration_number": { + "type": "string", + "title": "ุฑู‚ู… ุงู„ุณุฌู„ ุงู„ุชุฌุงุฑูŠ" + }, + "name": { + "type": "string", + "title": "ุงุณู… ุงู„ุดุฑูƒุฉ" + }, + "logo_url": { + "$ref": "#/components/schemas/ImageUrlSchema" + }, + "images": { + "items": { + "type": "object" + }, + "type": "array", + "title": "ุตูˆุฑุฉ ุงู„ุดุฑูƒุฉ" + }, + "description": { + "type": "string", + "title": "ู…ู‚ุฏู…ุฉ ุงู„ุดุฑูƒุฉ" + }, + "link": { + "type": "string", + "title": "ุฑุงุจุท ุตูุญุฉ ุงู„ุดุฑูƒุฉ" + }, + "url": { + "type": "string", + "title": "ุนู†ูˆุงู† URL ู„ุตูุญุฉ ุชูุงุตูŠู„ ุงู„ุดุฑูƒุฉ" + } + }, + "type": "object", + "required": [ + "id", + "company_confirm", + "name", + "url" + ], + "title": "ุชูุงุตูŠู„ ุงู„ุดุฑูƒุฉุงู„ุงุณุชุฌุงุจุฉSerializer" + }, + "CompanyJobListResponseSerializer": { + "properties": { + "links": { + "$ref": "#/components/schemas/LinksSchema" + }, + "jobs": { + "items": { + "$ref": "#/components/schemas/openapi__apis__v1__companies__serializers__JobResponseSerializer" + }, + "type": "array", + "title": "ูˆุธุงุฆู" + } + }, + "type": "object", + "title": "CompanyJobListResponseSerializer", + "example": { + "links": { + "next": "/v1/companies/79/jobs?offset=12&limit=12" + }, + "jobs": [ + { + "id": 23617, + "name": "VR ์—”์ง€๋‹ˆ์–ด", + "reward": { + "country": "KR", + "total": "100๋งŒ์›", + "recommender": "50๋งŒ์›", + "recommendee": "50๋งŒ์›" + }, + "url": "https://www.wanted.co.kr/wd/10002" + }, + { + "id": 23652, + "name": "QA", + "due_time": "2023-03-21" + } + ] + } + }, + "CompanyResponseSerializer": { + "properties": { + "company": { + "$ref": "#/components/schemas/CompanyDetailResponseSerializer" + } + }, + "type": "object", + "title": "ุงู„ุดุฑูƒุฉResponseSerializer", + "example": { + "company": { + "id": 79, + "company_confirm": true, + "registration_number": "12622032023", + "name": "์›ํ‹ฐ๋“œ๋žฉ", + "logo_url": { + "origin": "https://...", + "thumb": "https://..." + }, + "images": [ + { + "id": 1894, + "is_title": true, + "origin": "https://...", + "thumb": "https://..." + }, + { + "id": 1889, + "is_title": false, + "origin": "https://...", + "thumb": "https://..." + } + ], + "description": "ู…ุทู„ูˆุจ ุดุฑูƒุฉ ู…ุฎุชุจุฑ ู…ู‚ุฏู…ุฉ", + "link": "http://wanted.co.kr/", + "url": "https://www.wanted.co.kr/company/79?client_id=xxxx" + } + } + }, + "CompanyTagResponseSerializer": { + "properties": { + "tag_type_id": { + "type": "integer", + "title": "ู…ุนุฑู ุงู„ุนู„ุงู…ุฉ" + }, + "text": { + "type": "string", + "title": "ุงุณู… ุงู„ุนู„ุงู…ุฉ" + } + }, + "type": "object", + "title": "ุดุฑูƒุฉ TagResponseSerializer" + }, + "CountryEnum": { + "oneOf": [ + { + "const": "KR", + "title": "CountryEnum", + "description": "ุงู„ุชุนุฏุงุฏ." + }, + { + "const": "JP", + "title": "CountryEnum", + "description": "ุงู„ุชุนุฏุงุฏ." + }, + { + "const": "TW", + "title": "CountryEnum", + "description": "ุงู„ุชุนุฏุงุฏ." + }, + { + "const": "HK", + "title": "CountryEnum", + "description": "ุงู„ุชุนุฏุงุฏ." + }, + { + "const": "SG", + "title": "CountryEnum", + "description": "ุงู„ุชุนุฏุงุฏ." + }, + { + "const": "WW", + "title": "CountryEnum", + "description": "ุงู„ุชุนุฏุงุฏ." + } + ], + "title": "CountryEnum", + "description": "ุงู„ุชุนุฏุงุฏ." + }, + "CreatePresignedURLResponseSerializer": { + "properties": { + "presigned_url": { + "type": "string", + "title": "ุนู†ุงูˆูŠู† URL ุงู„ู…ุญุฏุฏุฉ" + }, + "upload_key": { + "type": "string", + "title": "ู…ูุชุงุญ ุงู„ุชุญู…ูŠู„" + } + }, + "type": "object", + "required": [ + "presigned_url", + "upload_key" + ], + "title": "CreatePresignedURLResponseSerializer", + "example": { + "presigned_url": "https://...", + "upload_key": "qwe0982awfwef" + } + }, + "FilesResponseSerializer": { + "properties": { + "key": { + "type": "string", + "title": "ู…ูุชุงุญ" + }, + "title": { + "type": "string", + "title": "ุนู†ูˆุงู†" + }, + "update_time": { + "type": "string", + "format": "date-time", + "title": "ูˆู‚ุช ุงู„ุชุญุฏูŠุซ" + } + }, + "type": "object", + "required": [ + "key", + "update_time" + ], + "title": "FilesResponseSerializer" + }, + "GetDownloadUrlResponseSerializer": { + "properties": { + "presigned_url": { + "type": "string", + "title": "ุนู†ุงูˆูŠู† URL ุงู„ู…ุญุฏุฏุฉ" + } + }, + "type": "object", + "required": [ + "presigned_url" + ], + "title": "ุงู„ุญุตูˆู„ ุนู„ู‰DownloadUrlResponseSerializer", + "example": { + "url": "https://..." + } + }, + "GetFileListResponseSerializer": { + "properties": { + "links": { + "$ref": "#/components/schemas/LinksSchema" + }, + "data": { + "items": { + "$ref": "#/components/schemas/FilesResponseSerializer" + }, + "type": "array", + "title": "ุจูŠุงู†ุงุช" + } + }, + "type": "object", + "title": "GetFileListResponseSerializer", + "example": { + "data": [ + { + "key": "AAUIBQQDSgdNVQ==", + "title": "string.pdf", + "update_time": "2023-04-10T16:53:23" + } + ], + "links": { + "prev": "http://...", + "next": "http://..." + } + } + }, + "ImageUrlResponseSerializer": { + "properties": { + "origin": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "ุฃุตู„" + }, + "thumb": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "ุฅุจู‡ุงู…" + }, + "is_title": { + "type": "boolean", + "title": "ู‡ูˆ ุงู„ุนู†ูˆุงู†", + "default": false + } + }, + "type": "object", + "title": "ImageUrlResponseSerializer" + }, + "ImageUrlSchema": { + "properties": { + "origin": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "ุฃุตู„", + "description": "ุนู†ูˆุงู† URL ู„ู„ุตูˆุฑุฉ ุงู„ุฃุตู„ูŠุฉ" + }, + "thumb": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "ุฅุจู‡ุงู…", + "description": "ุนู†ูˆุงู† URL ู„ู„ุตูˆุฑุฉ ุงู„ู…ุตุบุฑุฉ" + } + }, + "type": "object", + "title": "ImageUrlSchema" + }, + "JobCompanyResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "ู…ุนุฑู ุงู„ุดุฑูƒุฉ" + }, + "name": { + "type": "string", + "title": "ุงุณู… ุงู„ุดุฑูƒุฉ" + }, + "link": { + "type": "string", + "title": "ุฑุงุจุท ุตูุญุฉ ุงู„ุดุฑูƒุฉ" + }, + "registration_number": { + "type": "string", + "title": "ุฑู‚ู… ุงู„ุณุฌู„ ุงู„ุชุฌุงุฑูŠ" + }, + "logo_img": { + "title": "ุตูˆุฑุฉ ุงู„ุดุนุงุฑ", + "type": "object", + "properties": { + "origin": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "ุฃุตู„" + }, + "thumb": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "ุฅุจู‡ุงู…" + }, + "is_title": { + "type": "boolean", + "title": "ู‡ูˆ ุงู„ุนู†ูˆุงู†", + "default": false + } + } + }, + "description": { + "type": "string", + "title": "ู…ู‚ุฏู…ุฉ ุงู„ุดุฑูƒุฉ" + }, + "company_tags": { + "items": { + "$ref": "#/components/schemas/CompanyTagResponseSerializer" + }, + "type": "array", + "title": "ุนู„ุงู…ุงุช ุงู„ุดุฑูƒุงุช", + "default": [] + } + }, + "type": "object", + "title": "JobCompanyResponseSerializer" + }, + "JobListAddressResponseSerializer": { + "properties": { + "country": { + "type": "string", + "title": "ุฏูˆู„ุฉ" + }, + "location": { + "type": "string", + "title": "ู…ูˆู‚ุน" + }, + "full_location": { + "type": "string", + "title": "ุงู„ู…ูˆู‚ุน ุงู„ูƒุงู…ู„" + } + }, + "type": "object", + "title": "JobListAddressResponseSerializer" + }, + "JobListDetailResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "ู…ุนุฑู ุงู„ู…ู†ุตุจ" + }, + "status": { + "$ref": "#/components/schemas/JobStatusEnum" + }, + "due_time": { + "type": "string", + "format": "date", + "title": "ู…ูˆุนุฏ ุงู„ุชุณู„ูŠู…" + }, + "position": { + "type": "string", + "title": "ุงุณู… ุงู„ู…ู†ุตุจ" + }, + "company": { + "title": "ุดุฑูƒุฉ", + "type": "object", + "properties": { + "id": { + "type": "integer", + "title": "ู…ุนุฑู ุงู„ุดุฑูƒุฉ" + }, + "name": { + "type": "string", + "title": "ุงุณู… ุงู„ุดุฑูƒุฉ" + }, + "link": { + "type": "string", + "title": "ุฑุงุจุท ุตูุญุฉ ุงู„ุดุฑูƒุฉ" + }, + "registration_number": { + "type": "string", + "title": "ุฑู‚ู… ุงู„ุณุฌู„ ุงู„ุชุฌุงุฑูŠ" + }, + "logo_img": { + "title": "ุตูˆุฑุฉ ุงู„ุดุนุงุฑ", + "type": "object", + "properties": { + "origin": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "ุฃุตู„" + }, + "thumb": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "ุฅุจู‡ุงู…" + }, + "is_title": { + "type": "boolean", + "title": "ู‡ูˆ ุงู„ุนู†ูˆุงู†", + "default": false + } + } + }, + "description": { + "type": "string", + "title": "ู…ู‚ุฏู…ุฉ ุงู„ุดุฑูƒุฉ" + }, + "company_tags": { + "items": { + "$ref": "#/components/schemas/CompanyTagResponseSerializer" + }, + "type": "array", + "title": "ุนู„ุงู…ุงุช ุงู„ุดุฑูƒุงุช", + "default": [] + } + } + }, + "reward": { + "title": "ุชุนูˆูŠุถ", + "type": "object", + "properties": { + "country": { + "$ref": "#/components/schemas/CountryEnum" + }, + "formatted_total": { + "type": "string", + "title": "ุงู„ู…ุฌู…ูˆุน ุงู„ู…ู†ุณู‚", + "description": "ุงู„ุชุนูˆูŠุถ ุงู„ูƒุงู…ู„", + "default": "0" + }, + "formatted_recommender": { + "type": "string", + "title": "ุชูˆุตูŠุฉ ู…ู†ุณู‚ุฉ", + "description": "ู…ูƒุงูุฃุฉ ุงู„ู…ุฑุฌุน", + "default": "0" + }, + "formatted_recommendee": { + "type": "string", + "title": "ุงู„ู…ูˆุตู‰ ุจู‡ุง ู…ู†ุณู‚ุฉ", + "description": "ุชุนูˆูŠุถ ู…ู‚ุฏู… ุงู„ุทู„ุจ", + "default": "0" + } + } + }, + "address": { + "title": "ุนู†ูˆุงู†", + "type": "object", + "properties": { + "country": { + "type": "string", + "title": "ุฏูˆู„ุฉ" + }, + "location": { + "type": "string", + "title": "ู…ูˆู‚ุน" + }, + "full_location": { + "type": "string", + "title": "ุงู„ู…ูˆู‚ุน ุงู„ูƒุงู…ู„" + } + } + }, + "title_img": { + "$ref": "#/components/schemas/ImageUrlResponseSerializer" + }, + "logo_img": { + "$ref": "#/components/schemas/ImageUrlResponseSerializer" + }, + "category_tags": { + "title": "ุงู„ู…ู‡ู†ุฉ/ุงู„ุนู„ุงู…ุฉ ุงู„ูˆุธูŠููŠุฉ", + "type": "object", + "properties": { + "parent_tag": { + "title": "ุฅุดุบุงู„", + "type": "object", + "properties": { + "id": { + "type": "integer", + "title": "ู…ุนุฑู ุงู„ุนู„ุงู…ุฉ" + }, + "text": { + "type": "string", + "title": "ุงุณู… ุงู„ุนู„ุงู…ุฉ" + } + } + }, + "child_tags": { + "items": { + "$ref": "#/components/schemas/openapi__apis__v1__jobs__serializers__TagResponseSerializer" + }, + "type": "array", + "title": "ูˆุธูŠูุฉ" + } + } + }, + "url": { + "type": "string", + "title": "ุนู†ูˆุงู† URL ู„ุชูุงุตูŠู„ ุตูุญุฉ ุงู„ู…ูˆุถุน" + } + }, + "type": "object", + "required": [ + "id", + "status", + "position", + "company", + "url" + ], + "title": "JobListDetailResponseSerializer" + }, + "JobListResponseSerializer": { + "properties": { + "links": { + "$ref": "#/components/schemas/LinksSchema" + }, + "data": { + "items": { + "$ref": "#/components/schemas/JobListDetailResponseSerializer" + }, + "type": "array", + "title": "ุจูŠุงู†ุงุช" + } + }, + "type": "object", + "title": "JobListResponseSerializer", + "example": { + "data": [ + { + "id": 24049, + "status": "active", + "due_time": "2023-05-01", + "name": "ํฌ์ง€์…˜๋ช…", + "address": { + "country": "ํ•œ๊ตญ", + "location": "์„œ์šธ" + }, + "title_img": { + "origin": "https://...", + "thumb": "https://..." + }, + "logo_img": { + "origin": "https://...", + "thumb": "https://..." + }, + "company": { + "id": 7565, + "name": "๊ธฐ์—…๋ช…" + }, + "reward": { + "total": "100๋งŒ์›", + "recommender": "50๋งŒ์›", + "recommendee": "50๋งŒ์›" + } + } + ], + "links": { + "prev": "/api/chaos/jobs/v1?country=KR&sort=company.response_rate_order&offset=1&limit=1", + "next": "/api/chaos/jobs/v1?country=KR&sort=company.response_rate_order&offset=1&limit=1" + } + } + }, + "JobSortEnum": { + "enum": [ + "job.latest_order", + "job.popularity_order", + "company.response_rate_order" + ], + "title": "JobSortEnum", + "description": "ุงู„ุชุนุฏุงุฏ." + }, + "JobStatusEnum": { + "oneOf": [ + { + "const": "request", + "title": "JobStatusEnum", + "description": "ุงู„ุชุนุฏุงุฏ." + }, + { + "const": "draft", + "title": "JobStatusEnum", + "description": "ุงู„ุชุนุฏุงุฏ." + }, + { + "const": "active", + "title": "JobStatusEnum", + "description": "ุงู„ุชุนุฏุงุฏ." + }, + { + "const": "archived", + "title": "JobStatusEnum", + "description": "ุงู„ุชุนุฏุงุฏ." + }, + { + "const": "close", + "title": "JobStatusEnum", + "description": "ุงู„ุชุนุฏุงุฏ." + }, + { + "const": "saved", + "title": "JobStatusEnum", + "description": "ุงู„ุชุนุฏุงุฏ." + } + ], + "title": "JobStatusEnum", + "description": "ุงู„ุชุนุฏุงุฏ." + }, + "LinksSchema": { + "properties": { + "prev": { + "type": "string", + "title": "ุงู„ุณุงุจู‚", + "description": "ุงู„ุตูุญุฉ ุงู„ุณุงุจู‚ุฉ" + }, + "next": { + "type": "string", + "title": "ุงู„ุชุงู„ูŠ", + "description": "ุงู„ุตูุญุฉ ุงู„ุชุงู„ูŠุฉ" + } + }, + "type": "object", + "title": "ู…ุฎุทุท ุงู„ุฑูˆุงุจุท" + }, + "OpenAPIExceptionResponse": { + "properties": { + "error_code": { + "type": "string", + "title": "ุฑู…ุฒ ุงู„ุฎุทุฃ" + }, + "message": { + "type": "string", + "title": "ุฑุณุงู„ุฉ" + }, + "data": { + "type": "object", + "title": "ุจูŠุงู†ุงุช" + } + }, + "type": "object", + "required": [ + "error_code", + "message" + ], + "title": "OpenAPIExceptionResponse" + }, + "ParentTagResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "ุจุทุงู‚ุฉ ุชุนุฑูŠู", + "description": "ู…ุนุฑู ุงู„ุนู„ุงู…ุฉ" + }, + "parent_id": { + "type": "integer", + "title": "ู…ุนุฑู ุงู„ูˆุงู„ุฏูŠู†", + "description": "ู…ุนุฑู ุงู„ุนู„ุงู…ุฉ ุงู„ุฃุตู„" + }, + "title": { + "type": "string", + "title": "ุนู†ูˆุงู†", + "description": "ุงุณู… ุงู„ุนู„ุงู…ุฉ" + }, + "title_thumb_img": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "ุนู†ูˆุงู† ุงู„ุฅุจู‡ุงู… ุงู„ุตูˆุฑุฉ", + "description": "ุนู†ูˆุงู† URL ู„ุตูˆุฑุฉ ุงู„ุนู„ุงู…ุฉ" + }, + "sub_tags": { + "items": { + "$ref": "#/components/schemas/openapi__apis__v1__tags__serializers__TagResponseSerializer" + }, + "type": "array", + "title": "ุงู„ุนู„ุงู…ุงุช ุงู„ูุฑุนูŠุฉ" + } + }, + "type": "object", + "required": [ + "id", + "title" + ], + "title": "ParentTagResponseSerializer" + }, + "PassTextPredictionRequestSerializer": { + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/ResumeJdTextPredictionItemSerializer" + }, + "type": "array", + "title": "ู‚ุงุฆู…ุฉ ุจูŠุงู†ุงุช ุทู„ุจ ุงู„ุชู†ุจุค" + }, + "callback_url": { + "type": "string", + "title": "ุนู†ูˆุงู† ุฑุฏ ุงู„ุงุชุตุงู„", + "description": "ุนู†ูˆุงู† URL ู„ูŠุชู… ุฅุนู„ุงู…ูƒ ุจุงู„ู†ุชูŠุฌุฉ ุจุนุฏ ุงู„ู…ุนุงู„ุฌุฉ ุบูŠุฑ ุงู„ู…ุชุฒุงู…ู†ุฉ", + "example": "http://my-server.com/v1/pass/callback" + }, + "request_id": { + "type": "string", + "title": "ู…ุนุฑู ุงู„ุทู„ุจ", + "description": "ุนู†ุฏ ุฅุนู„ุงู… ู†ุชูŠุฌุฉ ุงู„ู…ุนุงู„ุฌุฉุŒ ูŠุชู… ุฅุฑุณุงู„ ู…ุนุฑู ุงู„ุทู„ุจ ู…ุนู‹ุง. ุงูุชุฑุงุถูŠู‹ุงุŒ ูŠุชู… ุฅู†ุดุงุคู‡ ุชู„ู‚ุงุฆูŠู‹ุง ุจุชู†ุณูŠู‚ UUIDุŒ ูˆู„ูƒู† ุฅุฐุง ุชู… ุฅุฌุฑุงุก ุงุณุชุฏุนุงุก ุนู†ูˆุงู† URL ู„ู„ุฅุดุนุงุฑ ู‚ุจู„ ุนู…ู„ูŠุฉ ุงู„ุทู„ุจ ุบูŠุฑ ุงู„ู…ุชุฒุงู…ู† ุจุณุจุจ ู…ู†ุทู‚ ุฌุงู†ุจ ุงู„ุนู…ูŠู„ุŒ ููŠุฌุจ ุชุญุฏูŠุฏ request_id ู…ุณุจู‚ู‹ุง.", + "example": "55e41f9f-a5a6-4836-8490-68914ff51b64" + } + }, + "type": "object", + "required": [ + "data", + "callback_url" + ], + "title": "PassTextPredictionRequestSerializer" + }, + "ResumeJdTextPredictionItemSerializer": { + "properties": { + "resume": { + "type": "string", + "title": "ุงุณุชุฆู†ุงู ุงู„ู†ุต", + "example": "5๋…„์ฐจ ์†Œํ”„ํŠธ์›จ์–ด ์—”์ง€๋‹ˆ์–ด ์ž…๋‹ˆ๋‹ค..." + }, + "jd": { + "type": "string", + "title": "ู†ุต ุฏูŠู†ุงุฑ", + "example": "5๋…„์ฐจ ์†Œํ”„ํŠธ์›จ์–ด ์—”์ง€๋‹ˆ์–ด ๊ตฌํ•ฉ๋‹ˆ๋‹ค..." + } + }, + "type": "object", + "required": [ + "resume", + "jd" + ], + "title": "ุงุณุชุฆู†ุงูJdTextPredictionItemSerializer" + }, + "RewardResponseSerializer": { + "properties": { + "country": { + "$ref": "#/components/schemas/CountryEnum" + }, + "formatted_total": { + "type": "string", + "title": "ุงู„ู…ุฌู…ูˆุน ุงู„ู…ู†ุณู‚", + "description": "ุงู„ุชุนูˆูŠุถ ุงู„ูƒุงู…ู„", + "default": "0" + }, + "formatted_recommender": { + "type": "string", + "title": "ุชูˆุตูŠุฉ ู…ู†ุณู‚ุฉ", + "description": "ู…ูƒุงูุฃุฉ ุงู„ู…ุฑุฌุน", + "default": "0" + }, + "formatted_recommendee": { + "type": "string", + "title": "ุงู„ู…ูˆุตู‰ ุจู‡ุง ู…ู†ุณู‚ุฉ", + "description": "ุชุนูˆูŠุถ ู…ู‚ุฏู… ุงู„ุทู„ุจ", + "default": "0" + } + }, + "type": "object", + "title": "RewardResponseSerializer" + }, + "SearchCompanyResponseSerializer": { + "properties": { + "links": { + "$ref": "#/components/schemas/LinksSchema" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_SearchCompanySchema" + }, + "type": "array", + "title": "ุจูŠุงู†ุงุช" + } + }, + "type": "object", + "title": "SearchCompanyResponseSerializer", + "example": { + "links": { + "next": "/api/chaos/search/v1/company?query=%EC%9B%90%ED%8B%B0%EB%93%9C&offset=1&limit=1&offset=1&limit=1" + }, + "companies": [ + { + "id": 79, + "name": "์›ํ‹ฐ๋“œ๋žฉ", + "logo_img": { + "origin": "https://static.wanted.co.kr/nextweek/images/wdes/0_4.7d6ea9b0.test_nextweek.jpg", + "thumb": "https://static.wanted.co.kr/nextweek/images/wdes/0_5.7d6ea9b0.test_nextweek.jpg" + }, + "title_img": { + "origin": "https://static.wanted.co.kr/images/company/79/15562_2_6.__1080_790.jpg", + "thumb": "https://static.wanted.co.kr/images/company/79/15562_2_6.__400_400.jpg" + }, + "description": "ู…ุทู„ูˆุจ ู…ุฎุชุจุฑ ู‡ูˆ ุงู„ุฃูุถู„", + "url": "https://www.wanted.co.kr/company/79?client_id=xxxx" + } + ] + } + }, + "SkillListResponseSerializer": { + "properties": { + "skills": { + "items": { + "$ref": "#/components/schemas/ParentTagResponseSerializer" + }, + "type": "array", + "title": "ู…ู‡ุงุฑุงุช" + } + }, + "type": "object", + "title": "SkillListResponseSerializer", + "example": { + "data": [ + { + "id": 1540, + "title": "ุฌุงูุง" + } + ] + } + }, + "TagListResponseSerializer": { + "properties": { + "tags": { + "items": { + "$ref": "#/components/schemas/ParentTagResponseSerializer" + }, + "type": "array", + "title": "ุงู„ุนู„ุงู…ุงุช" + } + }, + "type": "object", + "title": "TagListResponseSerializer", + "example": { + "data": [ + { + "id": 518, + "title": "ุชุทูˆูŠุฑ", + "image_url": "https://...", + "sub_tags": [ + { + "id": 873, + "parent_id": 518, + "title": "ู…ุทูˆุฑ ุงู„ูˆูŠุจ", + "image_url": "https://..." + }, + { + "id": 872, + "parent_id": 518, + "title": "ู…ุทูˆุฑ ุงู„ุฎุงุฏู…", + "image_url": "https://..." + } + ] + } + ] + } + }, + "UploadFileRequestSerializer": { + "properties": { + "upload_key": { + "type": "string", + "title": "ู…ูุชุงุญ ุงู„ุชุญู…ูŠู„", + "description": "upload_key ุฑุฏู‹ุง ุนู„ู‰ `/v1/files/upload-url`" + }, + "title": { + "type": "string", + "title": "ุงุณู… ุงู„ู…ู„ู", + "description": "ุงุณู… ุงู„ู…ู„ู ุจู…ุง ููŠ ุฐู„ูƒ ุงู…ุชุฏุงุฏ ุงู„ู…ู„ู ุงู„ุฐูŠ ุชู… ุชุญู…ูŠู„ู‡ ุจุงุณุชุฎุฏุงู… `presigned_url` ููŠ ุงู„ุงุณุชุฌุงุจุฉ `/v1/files/upload-url`." + } + }, + "type": "object", + "required": [ + "upload_key", + "title" + ], + "title": "UploadFileRequestSerializer", + "example": { + "upload_key": "0362e393-45b7-4bca-9e33-676cffcc5cbe", + "title": "ุงู„ู…ู„ู ุงู„ู…ุฑูู‚.pdf" + } + }, + "UploadFileResponseSerializer": { + "properties": { + "key": { + "type": "string", + "title": "ู…ูุชุงุญ" + } + }, + "type": "object", + "required": [ + "key" + ], + "title": "UploadFileResponseSerializer", + "example": { + "key": "AAUIBQQGSgdNVQ==" + } + }, + "_CompanyAutoCompleteSerializer": { + "properties": { + "company_id": { + "type": "integer", + "title": "ู…ุนุฑู ุงู„ุดุฑูƒุฉ", + "description": "ู…ุนุฑู ุงู„ุดุฑูƒุฉ" + }, + "name_ko": { + "type": "string", + "title": "ุงู„ุงุณู… ูƒูˆ", + "description": "ุงุณู… ุงู„ุดุฑูƒุฉ" + }, + "logo_image": { + "type": "string", + "title": "ุตูˆุฑุฉ ุงู„ุดุนุงุฑ", + "description": "ุฑุงุจุท ุตูˆุฑุฉ ุดุนุงุฑ ุงู„ุดุฑูƒุฉ" + } + }, + "type": "object", + "required": [ + "company_id", + "name_ko" + ], + "title": "_CompanyAutoCompleteSerializer" + }, + "_SearchCompanySchema": { + "properties": { + "id": { + "type": "integer", + "title": "ุจุทุงู‚ุฉ ุชุนุฑูŠู", + "description": "ู…ุนุฑู ุงู„ุดุฑูƒุฉ" + }, + "name": { + "type": "string", + "title": "ุงุณู…", + "description": "ุงุณู… ุงู„ุดุฑูƒุฉ" + }, + "logo_img": { + "$ref": "#/components/schemas/ImageUrlSchema" + }, + "title_img": { + "$ref": "#/components/schemas/ImageUrlSchema" + }, + "description": { + "type": "string", + "title": "ูˆุตู", + "description": "ูˆุตู ุงู„ุดุฑูƒุฉ" + }, + "url": { + "type": "string", + "title": "ุนู†ูˆุงู† URL", + "description": "ุนู†ูˆุงู† URL ู„ุตูุญุฉ ุชูุงุตูŠู„ ุงู„ุดุฑูƒุฉ" + } + }, + "type": "object", + "required": [ + "id", + "name", + "url" + ], + "title": "_SearchCompanySchema" + }, + "openapi__apis__v1__applications__serializers__JobDetailResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "ุจุทุงู‚ุฉ ุชุนุฑูŠู" + }, + "status": { + "$ref": "#/components/schemas/JobStatusEnum" + }, + "company_id": { + "type": "integer", + "title": "ู…ุนุฑู ุงู„ุดุฑูƒุฉ" + }, + "due_time": { + "type": "string", + "format": "date", + "title": "ุงู„ูˆู‚ุช ุงู„ู…ู†ุงุณุจ", + "description": "ู…ูˆุนุฏ ุงู„ุชุณู„ูŠู…" + }, + "logo_url": { + "$ref": "#/components/schemas/ImageUrlResponseSerializer" + } + }, + "type": "object", + "required": [ + "id", + "status" + ], + "title": "JobDetailResponseSerializer" + }, + "openapi__apis__v1__companies__serializers__JobResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "ุจุทุงู‚ุฉ ุชุนุฑูŠู", + "description": "ู…ุนุฑู ุงู„ู…ู†ุตุจ" + }, + "name": { + "type": "string", + "title": "ุงุณู…", + "description": "ุงุณู… ุงู„ู…ู†ุตุจ" + }, + "due_time": { + "type": "string", + "format": "date", + "title": "ุงู„ูˆู‚ุช ุงู„ู…ู†ุงุณุจ", + "description": "ู…ูˆุนุฏ ุงู„ุชุณู„ูŠู…" + }, + "reward": { + "title": "ุฌุงุฆุฒุฉ", + "description": "ุชุนูˆูŠุถ", + "type": "object", + "properties": { + "country": { + "$ref": "#/components/schemas/CountryEnum" + }, + "formatted_total": { + "type": "string", + "title": "ุงู„ู…ุฌู…ูˆุน ุงู„ู…ู†ุณู‚", + "description": "ุงู„ุชุนูˆูŠุถ ุงู„ูƒุงู…ู„", + "default": "0" + }, + "formatted_recommender": { + "type": "string", + "title": "ุชูˆุตูŠุฉ ู…ู†ุณู‚ุฉ", + "description": "ู…ูƒุงูุฃุฉ ุงู„ู…ุฑุฌุน", + "default": "0" + }, + "formatted_recommendee": { + "type": "string", + "title": "ุงู„ู…ูˆุตู‰ ุจู‡ุง ู…ู†ุณู‚ุฉ", + "description": "ุชุนูˆูŠุถ ู…ู‚ุฏู… ุงู„ุทู„ุจ", + "default": "0" + } + } + }, + "url": { + "type": "string", + "title": "ุนู†ูˆุงู† URL ู„ุชูุงุตูŠู„ ุตูุญุฉ ุงู„ู…ูˆุถุน" + } + }, + "type": "object", + "required": [ + "id", + "name", + "url" + ], + "title": "JobResponseSerializer" + }, + "openapi__apis__v1__jobs__serializers__JobDetailResponseSerializer": { + "properties": { + "position": { + "type": "string", + "title": "ุงุณู… ุงู„ู…ู†ุตุจ" + }, + "intro": { + "type": "string", + "title": "ู…ู‚ุฏู…ุฉ" + }, + "main_tasks": { + "type": "string", + "title": "ุงู„ู…ู‡ุงู… ุงู„ุฑุฆูŠุณูŠุฉ" + }, + "requirements": { + "type": "string", + "title": "ุงู„ู…ุคู‡ู„ุงุช" + }, + "preferred_points": { + "type": "string", + "title": "ู…ุนุงู…ู„ุฉ ุชูุถูŠู„ูŠุฉ" + }, + "benefits": { + "type": "string", + "title": "ุงู„ููˆุงุฆุฏ ูˆุงู„ุฑูุงู‡ูŠุฉ" + } + }, + "type": "object", + "title": "JobDetailResponseSerializer" + }, + "openapi__apis__v1__jobs__serializers__JobResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "ู…ุนุฑู ุงู„ู…ู†ุตุจ" + }, + "status": { + "$ref": "#/components/schemas/JobStatusEnum" + }, + "due_time": { + "type": "string", + "format": "date", + "title": "ู…ูˆุนุฏ ุงู„ุชุณู„ูŠู…" + }, + "detail": { + "$ref": "#/components/schemas/openapi__apis__v1__jobs__serializers__JobDetailResponseSerializer" + }, + "category_tags": { + "title": "ุงู„ู…ู‡ู†ุฉ/ุงู„ุนู„ุงู…ุฉ ุงู„ูˆุธูŠููŠุฉ", + "type": "object", + "properties": { + "parent_tag": { + "title": "ุฅุดุบุงู„", + "type": "object", + "properties": { + "id": { + "type": "integer", + "title": "ู…ุนุฑู ุงู„ุนู„ุงู…ุฉ" + }, + "text": { + "type": "string", + "title": "ุงุณู… ุงู„ุนู„ุงู…ุฉ" + } + } + }, + "child_tags": { + "items": { + "$ref": "#/components/schemas/openapi__apis__v1__jobs__serializers__TagResponseSerializer" + }, + "type": "array", + "title": "ูˆุธูŠูุฉ" + } + } + }, + "skill_tags": { + "items": { + "$ref": "#/components/schemas/openapi__apis__v1__jobs__serializers__TagResponseSerializer" + }, + "type": "array", + "title": "ุนู„ุงู…ุฉ ุงู„ู…ู‡ุงุฑุฉ" + }, + "company": { + "title": "ุดุฑูƒุฉ", + "type": "object", + "properties": { + "id": { + "type": "integer", + "title": "ู…ุนุฑู ุงู„ุดุฑูƒุฉ" + }, + "name": { + "type": "string", + "title": "ุงุณู… ุงู„ุดุฑูƒุฉ" + }, + "link": { + "type": "string", + "title": "ุฑุงุจุท ุตูุญุฉ ุงู„ุดุฑูƒุฉ" + }, + "registration_number": { + "type": "string", + "title": "ุฑู‚ู… ุงู„ุณุฌู„ ุงู„ุชุฌุงุฑูŠ" + }, + "logo_img": { + "title": "ุตูˆุฑุฉ ุงู„ุดุนุงุฑ", + "type": "object", + "properties": { + "origin": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "ุฃุตู„" + }, + "thumb": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "ุฅุจู‡ุงู…" + }, + "is_title": { + "type": "boolean", + "title": "ู‡ูˆ ุงู„ุนู†ูˆุงู†", + "default": false + } + } + }, + "description": { + "type": "string", + "title": "ู…ู‚ุฏู…ุฉ ุงู„ุดุฑูƒุฉ" + }, + "company_tags": { + "items": { + "$ref": "#/components/schemas/CompanyTagResponseSerializer" + }, + "type": "array", + "title": "ุนู„ุงู…ุงุช ุงู„ุดุฑูƒุงุช", + "default": [] + } + } + }, + "reward": { + "title": "ุชุนูˆูŠุถ", + "type": "object", + "properties": { + "country": { + "$ref": "#/components/schemas/CountryEnum" + }, + "formatted_total": { + "type": "string", + "title": "ุงู„ู…ุฌู…ูˆุน ุงู„ู…ู†ุณู‚", + "description": "ุงู„ุชุนูˆูŠุถ ุงู„ูƒุงู…ู„", + "default": "0" + }, + "formatted_recommender": { + "type": "string", + "title": "ุชูˆุตูŠุฉ ู…ู†ุณู‚ุฉ", + "description": "ู…ูƒุงูุฃุฉ ุงู„ู…ุฑุฌุน", + "default": "0" + }, + "formatted_recommendee": { + "type": "string", + "title": "ุงู„ู…ูˆุตู‰ ุจู‡ุง ู…ู†ุณู‚ุฉ", + "description": "ุชุนูˆูŠุถ ู…ู‚ุฏู… ุงู„ุทู„ุจ", + "default": "0" + } + } + }, + "address": { + "title": "ุนู†ูˆุงู†", + "type": "object", + "properties": { + "id": { + "type": "integer", + "title": "ุจุทุงู‚ุฉ ุชุนุฑูŠู" + }, + "country": { + "type": "string", + "title": "ุฃู…ุฉ" + }, + "country_code": { + "type": "string", + "title": "ุฑู…ุฒ ุงู„ุจู„ุฏ" + }, + "location": { + "type": "string", + "title": "ู…ูˆู‚ุน" + }, + "full_location": { + "type": "string", + "title": "ุงู„ุนู†ูˆุงู† ุงู„ูƒุงู…ู„" + }, + "geo_location": { + "type": "object", + "title": "ุงู„ู…ูˆู‚ุน ุงู„ุฌุบุฑุงููŠ" + } + } + }, + "images": { + "items": { + "$ref": "#/components/schemas/ImageUrlResponseSerializer" + }, + "type": "array", + "title": "ุงู„ุตูˆุฑ" + }, + "url": { + "type": "string", + "title": "ุนู†ูˆุงู† URL ู„ุชูุงุตูŠู„ ุตูุญุฉ ุงู„ู…ูˆุถุน" + } + }, + "type": "object", + "required": [ + "url" + ], + "title": "JobResponseSerializer", + "example": { + "id": 24090, + "status": "active", + "due_time": "2023-05-01", + "detail": { + "intro": "โ€˜์›ํ‹ฐ๋“œ๋žฉโ€™์€ ์ „ ์„ธ๊ณ„ ๋ชจ๋“  ๊ธฐ์—…๊ณผ ์ง์žฅ์ธ์˜ ๊ณ ๋ฏผ์„ ํ•ด๊ฒฐํ•˜๊ธฐ ์œ„ํ•œ HR ์Šคํƒ€ํŠธ์—…์ž…๋‹ˆ๋‹ค. ์ง์žฅ์ธ์˜ 90%๋Š” ์ด์ง์„ ์ƒ๊ฐํ•˜์ง€๋งŒ, ์–ด๋–ค ๊ธฐ์—…์ด ์ž์‹ ์—๊ฒŒ ์ตœ์„ ์˜ ์„ ํƒ์ธ์ง€ ์•Œ์ง€ ๋ชปํ•œ ์ฑ„ ์—…๋ฌด์— ์ž์‹ ์„ ๋งž์ถ”๊ณ  ์žˆ์Šต๋‹ˆ๋‹ค. ๊ธฐ์—…์€ ๋ˆ„๊ตฐ๊ฐ€์— ์˜ํ•ด ๊ฒ€์ฆ๋œ ์ธ์žฌ๋ฅผ ์ฑ„์šฉํ•˜๊ณ  ์‹ถ์ง€๋งŒ, ๊ทธ ๋น„์šฉ๊ณผ ์‹œ๊ฐ„์ด ๋งŒ๋งŒ์น˜ ์•Š์•„ ์žกํฌํ„ธ ๊ด‘๊ณ ์™€ ์˜คํ”„๋ผ์ธ ํ—ค๋“œํ—ŒํŒ…์— ์˜์กดํ•˜๊ณ  ์žˆ์Šต๋‹ˆ๋‹ค. \n\n์šฐ๋ฆฌ๋Š” ๋‹จ์ˆœํ•œ ์ฑ„์šฉ ์„œ๋น„์Šค๊ฐ€ ๋˜๋ ค๋Š” ๊ฒƒ์ด ์•„๋‹™๋‹ˆ๋‹ค. ์šฐ๋ฆฌ๋Š” โ€˜์ข‹์€ ์ผ์ž๋ฆฌ์™€ ์ˆจ์€ ์ธ์žฌ๋ฅผ ์—ฐ๊ฒฐํ•˜๋Š” ๊ฐ€์žฅ ํšจ์œจ์ ์ด๊ณ  ์ธ๊ฐ„์ ์ธ ๋ฐฉ๋ฒ•โ€™์ด๋ผ๋Š” ๋ฌธ์ œ๋ฅผ ํ’€๊ณ ์ž ํ•ฉ๋‹ˆ๋‹ค. ์ธ์žฌ์—๊ฒŒ๋Š” ์ž์‹ ์˜ ์—ญ๋Ÿ‰์„ ์œ ๊ฐ์—†์ด ๋ฐœํœ˜ํ•  ์ˆ˜ ์žˆ๋Š” ์ผ์ž๋ฆฌ๋ฅผ ์ถ”์ฒœํ•˜๊ณ , ๊ธฐ์—…์—๊ฒŒ๋Š” ํ•„์š”ํ•œ ์ž๋ฆฌ์— ๋”ฑ ๋งž๋Š” ์ธ์žฌ๋ฅผ ์ถ”์ฒœํ•˜๋Š” ์„œ๋น„์Šค์ž…๋‹ˆ๋‹ค. ์ด๋ฅผ ์œ„ํ•ด ๋ชจ๋ฐ”์ผ / ์†Œ์…œ ๋„คํŠธ์›Œํฌ / ๋น…๋ฐ์ดํ„ฐ์— ๊ธฐ๋ฐ˜ํ•œ HR ์†”๋ฃจ์…˜๋“ค์„ ํ•˜๋‚˜์”ฉ ๋งŒ๋“ค์–ด๋‚˜๊ฐ€๊ณ  ์žˆ์Šต๋‹ˆ๋‹ค. ์šฐ๋ฆฌ์˜ ์‹œ์„ ์€ ํ•œ๊ตญ์— ๋จธ๋ฌผ๋Ÿฌ ์žˆ์ง€ ์•Š์Šต๋‹ˆ๋‹ค. \n\n2015๋…„ 5์›” ์„œ๋น„์Šค๋ฅผ ์‹œ์ž‘ํ•˜์—ฌ, 2019๋…„ 3์›” ํ˜„์žฌ 4000์—ฌ ๊ธฐ์—…, 60๋งŒ ์œ ์ €(ํ•œ๊ตญ ๊ธฐ์ค€)๊ฐ€ ์ด์šฉ ์ค‘์— ์žˆ์Šต๋‹ˆ๋‹ค. 2017๋…„ 5์›”์—๋Š” 100์–ต ํˆฌ์ž๋ฅผ ๋ฐ›์•˜์œผ๋ฉฐ, ํ•œ๊ตญ/์ผ๋ณธ/๋Œ€๋งŒ/์‹ฑ๊ฐ€ํด/ํ™์ฝฉ ์˜คํ”ผ์Šค์— 65์—ฌ๋ช…์˜ ๊ตฌ์„ฑ์›๋“ค๊ณผ ํ•จ๊ป˜ ์•„์‹œ์•„ HR ์‹œ์žฅ์„ ์„ ๋„ํ•˜๊ณ ์ž ํ•ฉ๋‹ˆ๋‹ค. \n \n2016๋…„ ์•„์‹œ์•„ ์ตœ์ดˆ๋กœ ์„ค๋ฆฝ๋œ Google Campus์˜ ์ฒซ ๋ฒˆ์งธ ์ž…์ฃผ๊ธฐ์—…์œผ๋กœ ์„ ๋ฐœ๋˜์—ˆ์œผ๋ฉฐ, 2016๋…„ KMA ๋Œ€ํ•œ๋ฏผ๊ตญ๋ชจ๋ฐ”์ผ์–ด์›Œ๋“œ ๋Œ€์ƒ ์ˆ˜์ƒ, 2017๋…„ AWS์˜ ๋– ์˜ค๋ฅด๋Š” ์Šคํƒ€ํŠธ์—… ์„ ์ •, Facebook Korea๊ฐ€ ์„ ์ •ํ•œ ๋Œ€ํ‘œ์ ์ธ ํŒŒํŠธ๋„ˆ์‹ญ ์‚ฌ๋ก€๋กœ ์†Œ๊ฐœ, 2018๋…„ Forbes๊ฐ€ ์„ ์ •ํ•œ 2018๋…„ ์ฃผ๋ชฉํ•ด์•ผ ํ•  ํ•œ๊ตญ ์Šคํƒ€ํŠธ์—…์œผ๋กœ ์„ ์ •๋˜์—ˆ๊ณ , ๋˜ํ•œ Google TensorFlow๋ฅผ ํ™œ์šฉํ•˜์—ฌ ๋งค์นญ ์„œ๋น„์Šค๋ฅผ ํ•˜๊ณ  ์žˆ๋Š” ๊ตญ๋‚ด ์ฒซ ์‚ฌ๋ก€๋กœ ๊ตฌ๊ธ€ ๊ฐœ๋ฐœ์ž ํ–‰์‚ฌ์—์„œ ์‚ฌ๋ก€๋ฅผ ๋ฐœํ‘œํ•˜๊ธฐ๋„ ํ•˜์˜€์Šต๋‹ˆ๋‹ค.", + "main_tasks": "โ€ข ๋ฉ”์ดํ”Œ ์Šคํ† ๋ฆฌ2 ๊ธฐํš ์—…๋ฌด \nโ€ข ๊ฒŒ์ž„์˜ ์žฌ๋ฏธ๋ฅผ ์œ„ํ•œ ๋‹ค์–‘ํ•œ ๋ฃฐ์ด๋‚˜ ์‹œ์Šคํ…œ์„ ๊ธฐํšํ•˜๊ณ  ์ด๋ฅผ ๊ตฌํ˜„", + "requirements": "โ€ข ์‹ค๋ฌด์—์„œ MS Office๋ฅผ ํ™œ์šฉํ•˜๋Š”๋ฐ ํฐ ๋ฌธ์ œ๊ฐ€ ์—†๋Š” ๋ถ„ \nโ€ข ๊ฒŒ์ž„์„ ์ฆ๊ธฐ๊ณ  ์ข‹์•„ํ•˜์‹œ๋Š” ๋ถ„", + "preferred_points": "โ€ข ๋…ํŠนํ•˜๊ณ  ์ฐฝ์˜์ ์ธ ์•„์ด๋””์–ด๊ฐ€ ๋„˜์น˜๋Š” ๋ถ„ \nโ€ข ํŠน์ • ํฌ์ง€์…˜์— ์ข…์†๋˜์ง€ ์•Š๊ณ  ๊ฒŒ์ž„ ๊ธฐํš ์ „๋ฐ˜์˜ ๋‹ค์–‘ํ•œ ์—ญํ• ์„ ์ˆ˜ํ–‰ํ•  ์ˆ˜ ์žˆ์œผ์‹  ๋ถ„ \nโ€ข ๋ฉ”์ดํ”Œ ์Šคํ† ๋ฆฌ2์˜ ํ”Œ๋ ˆ์ด ๊ฒฝํ—˜๊ณผ ์ดํ•ด๋„๊ฐ€ ์žˆ์œผ์‹  ๋ถ„", + "benefits": "โ€ข ์ „ ์ง์žฅ๋ณด๋‹ค ์‹œ๊ฐ„์ /๊ฒฝ์ œ์ ์œผ๋กœ ๋” ๋‚˜์€ ์‚ถ ์ถ”๊ตฌ\nโ€ข ํ•˜๋ฃจ 8์‹œ๊ฐ„, ์•ผ๊ทผ์—†์ด ์ง‘์ค‘ํ•˜๋Š” ๋ฌธํ™” ์ •์ฐฉ\nโ€ข ํŽธ๋ฆฌํ•œ ์ถœํ‡ด๊ทผ (์—ญ์‚ผ์—ญ 3๋ฒˆ ์ถœ๊ตฌ ๋„๋ณด 10์ดˆ)\nโ€ข ์ž์œจ์  ์—…๋ฌดํ™˜๊ฒฝ (์œ„์›Œํฌ ์‚ฌ๋ฌด์‹ค, ๋ผ์šด์ง€/๋ถ€์Šค, ์ˆ˜ํ‰์  ์กฐ์ง, ๋งฅ์ฃผ ๋ฌดํ•œ๋Œ€)\nโ€ข ํœด๊ฐ€๋‹ค์šด ํœด๊ฐ€ (์‚ฌ์œ ๋‚˜ ์Šน์ธ์—†์ด ์Šค์Šค๋กœ ํœด๊ฐ€ ๊ณ„ํš, 3/5/7๋…„ ๋งŒ๊ทผ์‹œ 2์ฃผ ๋ฆฌํ”„๋ ˆ์‹œ ํœด๊ฐ€)\nโ€ข ๋ฐ˜๋ ค๋™๋ฌผ, ํœด๋Œ€๊ฐ€๋Šฅํ•œ ์•…๊ธฐ, ์ž์ „๊ฑฐ์™€ ๋™๋ฐ˜์ถœ๊ทผ ๊ฐ€๋Šฅ\nโ€ข ์—…๋ฌด๊ด€๋ จ ์ปจํผ๋Ÿฐ์Šค/๊ต์œก/๋„์„œ๊ตฌ๋งค๋น„ ์ง€์›\nโ€ข ์›” 1ํšŒ ํŒ€ ์‹์‚ฌ ๋ฐ ํ‹ฐํƒ€์ž„ ์ œ๊ณต\nโ€ข ์ง๋ฌด ์ˆ˜ํ–‰์— ํ•„์š”ํ•œ ์ตœ์‹ ์žฅ๋น„/์†Œํ”„ํŠธ์›จ์–ด ์ œ๊ณต\nโ€ข ์ตœ๊ณ ์˜ ์—…๋ฌด ํ™˜๊ฒฝ์ธ Wework ์—ญ์‚ผ์—ญ์  ์ž…์ฃผ์‚ฌ์ž…๋‹ˆ๋‹ค. ์•ˆ๋ฝํ•œ ํ™˜๊ฒฝ, ๊ตญ๋‚ด/์™ธ ์ง€์  ์ž์œ ๋กœ์šด ์ด์šฉ, ๋งฅ์ฃผ์™€ ์ปคํ”ผ ๋ฌดํ•œ์ œ๊ณต, ์ˆ˜์‹œ ์ด๋ฒคํŠธ ๋“ฑ์˜ ์„œ๋น„์Šค๋ฅผ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค.\n\n๊ธฐํƒ€\nโ€ข ๋ณธ ์ฑ„์šฉ์€ ์‚ฌ์—… ํ™•์žฅ์— ๋”ฐ๋ฅธ ์‹ ๊ทœ ์ฑ„์šฉ์ž…๋‹ˆ๋‹ค. \nโ€ข ์ผ์„ ๋” ์ž˜ํ•˜๊ธฐ ์œ„ํ•œ ๋ฐฉ๋ฒ• ์ค‘ ํ•˜๋‚˜๋กœ ์›” 2ํšŒ ๋ฆฌ๋ชจํŠธ ๊ทผ๋ฌด๋ฅผ ํ•˜์‹ค ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.", + "name": "ํ…Œ์ŠคํŠธ ํฌ์ง€์…˜" + }, + "url": "https://www.wanted.co.kr/wd/24090", + "company": { + "id": 79, + "name": "์›ํ‹ฐ๋“œ๋žฉ", + "description": "ุฑุจู…ุง ุชูƒูˆู† ุฃุบู†ูŠุฉ ุฑุงุจ ู…ุทู„ูˆุจุฉ.", + "link": "https://", + "registration_number": "2991023012", + "company_tags": [ + { + "id": 9962, + "text": "๋งฅ์ฃผ" + } + ], + "logo_img": { + "origin": "https://...", + "thumb": "https://..." + } + }, + "address": { + "id": 5873, + "country": "ํ•œ๊ตญ", + "country_code": "kr", + "location": "์„œ์šธ", + "district": "seoul.songpa-gu", + "full_location": "์„œ์šธ์‹œ ์†กํŒŒ๊ตฌ ์˜ฌ๋ฆผํ”ฝ๋กœ 300", + "geo_location": { + "bounds": { + "northeast": { + "lat": 37.5137876, + "lng": 127.1047335 + }, + "southwest": { + "lat": 37.5130537, + "lng": 127.1034478 + } + }, + "location": { + "lat": 37.5134449, + "lng": 127.1041611 + }, + "location_type": "ROOFTOP", + "viewport": { + "northeast": { + "lat": 37.5147696302915, + "lng": 127.1054396302915 + }, + "southwest": { + "lat": 37.5120716697085, + "lng": 127.1027416697085 + } + } + } + }, + "reward": { + "total": "100๋งŒ์›", + "recommender": "50๋งŒ์›", + "recommendee": "50๋งŒ์›" + }, + "category_tags": { + "parent_tag": { + "id": 530, + "text": "์˜์—…" + }, + "child_tags": [ + { + "id": 768, + "text": "์ฃผ์š”๊ณ ๊ฐ์‚ฌ ๋‹ด๋‹น์ž" + } + ] + }, + "skill_tags": [ + { + "id": 1630, + "text": "์˜์—…" + } + ], + "images": [ + { + "origin": "https://...", + "thumb": "https://...", + "is_title": true + }, + { + "origin": "https://...", + "thumb": "https://...", + "is_title": false + } + ] + } + }, + "openapi__apis__v1__jobs__serializers__TagResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "ู…ุนุฑู ุงู„ุนู„ุงู…ุฉ" + }, + "text": { + "type": "string", + "title": "ุงุณู… ุงู„ุนู„ุงู…ุฉ" + } + }, + "type": "object", + "title": "TagResponseSerializer" + }, + "openapi__apis__v1__tags__serializers__TagResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "ุจุทุงู‚ุฉ ุชุนุฑูŠู", + "description": "ู…ุนุฑู ุงู„ุนู„ุงู…ุฉ" + }, + "parent_id": { + "type": "integer", + "title": "ู…ุนุฑู ุงู„ูˆุงู„ุฏูŠู†", + "description": "ู…ุนุฑู ุงู„ุนู„ุงู…ุฉ ุงู„ุฃุตู„" + }, + "title": { + "type": "string", + "title": "ุนู†ูˆุงู†", + "description": "ุงุณู… ุงู„ุนู„ุงู…ุฉ" + }, + "title_thumb_img": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "ุนู†ูˆุงู† ุงู„ุฅุจู‡ุงู… ุงู„ุตูˆุฑุฉ", + "description": "ุนู†ูˆุงู† URL ู„ุตูˆุฑุฉ ุงู„ุนู„ุงู…ุฉ" + } + }, + "type": "object", + "required": [ + "id", + "title" + ], + "title": "TagResponseSerializer" + } + }, + "securitySchemes": { + "ClientIdHeader": { + "type": "apiKey", + "in": "header", + "name": "wanted-client-id" + }, + "ClientSecretHeader": { + "type": "apiKey", + "in": "header", + "name": "wanted-client-secret" + }, + "PermissionsDependency": { + "type": "apiKey", + "in": "header", + "name": "Authorization" + } + } + }, + "x-samchon-emended": true +} \ No newline at end of file diff --git a/assets/output/wanted.swagger.en.json b/assets/output/wanted.swagger.en.json new file mode 100644 index 0000000..4074c00 --- /dev/null +++ b/assets/output/wanted.swagger.en.json @@ -0,0 +1,3432 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "Wanted OpenAPI V1 Server", + "version": "1.0.0" + }, + "servers": [ + { + "url": "/v1" + } + ], + "paths": { + "/ai/pass/text-prediction/async": { + "post": { + "tags": [ + "AI" + ], + "summary": "[Paid] Text Document Pass Prediction Execution (Asynchronous)", + "description": "**This API can be used after a separate contract. (Contact: team-ml@wantedlab.com)** Since predictions are executed asynchronously, the API call is completed immediately and the results are delivered to the callback_url.**(Up to 50 input data per call.)**", + "operationId": "_์œ ๋ฃŒ__ํ…์ŠคํŠธ_์„œ๋ฅ˜ํ•ฉ๊ฒฉ์˜ˆ์ธก_์‹คํ–‰_๋น„๋™๊ธฐ__ai_pass_text_prediction_async_post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "title": "Input data", + "description": "Up to 50", + "type": "object", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/ResumeJdTextPredictionItemSerializer" + }, + "type": "array", + "title": "Prediction request data list" + }, + "callback_url": { + "type": "string", + "title": "CallbackURL", + "description": "URL to be notified of results after asynchronous processing", + "example": "http://my-server.com/v1/pass/callback" + }, + "request_id": { + "type": "string", + "title": "Request ID", + "description": "When notifying the processing result, the request ID is transmitted together. By default, it is automatically generated in UUID format, but if the notification URL call is made before the asynchronous request process due to client-side logic, the request_id must be specified in advance.", + "example": "55e41f9f-a5a6-4836-8490-68914ff51b64" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AsyncPredictionResponseSerializer" + } + } + } + }, + "401": { + "description": "Unauthenticated user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "Missing required request data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/ai/apply/text-prediction/async": { + "post": { + "tags": [ + "AI" + ], + "summary": "[Paid] Text support prediction execution (asynchronous)", + "description": "**This API can be used after a separate contract. (Contact: team-ml@wantedlab.com)** Since predictions are executed asynchronously, the API call is completed immediately and the results are delivered to the callback_url.**(Up to 50 input data per call.)**", + "operationId": "_์œ ๋ฃŒ__ํ…์ŠคํŠธ_์ง€์›์˜ˆ์ธก_์‹คํ–‰_๋น„๋™๊ธฐ__ai_apply_text_prediction_async_post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "title": "Input data", + "description": "Up to 50", + "type": "object", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/ResumeJdTextPredictionItemSerializer" + }, + "type": "array", + "title": "Prediction request data list" + }, + "callback_url": { + "type": "string", + "title": "CallbackURL", + "description": "URL to be notified of results after asynchronous processing", + "example": "http://my-server.com/v1/apply/callback" + }, + "request_id": { + "type": "string", + "title": "Request ID", + "description": "When notifying the processing result, the request ID is transmitted together. By default, it is automatically generated in UUID format, but if the notification URL call is made before the asynchronous request process due to client-side logic, the request_id must be specified in advance.", + "example": "55e41f9f-a5a6-4836-8490-68914ff51b64" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AsyncPredictionResponseSerializer" + } + } + } + }, + "401": { + "description": "Unauthenticated user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "Missing required request data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/applications": { + "get": { + "tags": [ + "Application" + ], + "summary": "View Support List", + "operationId": "get_application_list_applications_get", + "parameters": [ + { + "description": "Search terms (company name/position name/applicant name)", + "required": false, + "schema": { + "type": "string", + "title": "Q", + "description": "Search terms (company name/position name/applicant name)" + }, + "name": "q", + "in": "query" + }, + { + "description": "Position ID", + "required": false, + "schema": { + "type": "integer", + "title": "Job Id", + "description": "Position ID" + }, + "name": "job_id", + "in": "query" + }, + { + "description": "Application status; complete (application received), pass (document passed), reject (failure), hire (final acceptance)", + "required": false, + "schema": { + "items": { + "$ref": "#/components/schemas/ApplicationStatusSearchEnum" + }, + "type": "array", + "description": "Application status; complete (application received), pass (document passed), reject (failure), hire (final acceptance)" + }, + "name": "status", + "in": "query" + }, + { + "description": "Application submission date start range (format: YYYY-MM-DD)", + "required": false, + "schema": { + "type": "string", + "format": "date", + "title": "Start Date", + "description": "Application submission date start range (format: YYYY-MM-DD)" + }, + "name": "start_date", + "in": "query" + }, + { + "description": "Application submission date end range (format: YYYY-MM-DD)", + "required": false, + "schema": { + "type": "string", + "format": "date", + "title": "End Date", + "description": "Application submission date end range (format: YYYY-MM-DD)" + }, + "name": "end_date", + "in": "query" + }, + { + "description": "True when checking for cancelled applications", + "required": false, + "schema": { + "type": "boolean", + "title": "Is Cancel", + "description": "True when checking for cancelled applications", + "default": false + }, + "name": "is_cancel", + "in": "query" + }, + { + "required": false, + "schema": { + "type": "integer", + "title": "Offset", + "default": 0 + }, + "name": "offset", + "in": "query" + }, + { + "required": false, + "schema": { + "type": "integer", + "title": "Limit", + "default": 20 + }, + "name": "limit", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationListResponseSerializer" + } + } + } + }, + "401": { + "description": "Unauthenticated user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "Missing required request data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + }, + { + "PermissionsDependency": [] + } + ] + }, + "post": { + "tags": [ + "Application" + ], + "summary": "Position Support", + "operationId": "apply_for_job_applications_post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplyJobRequestSerializer" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationResponseSerializer" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "examples": { + "AlreadyAppliedJob": { + "value": { + "error_code": "AlreadyAppliedJob", + "message": "์ด๋ฏธ ์ง€์›ํ•œ ํฌ์ง€์…˜์ž…๋‹ˆ๋‹ค." + } + }, + "JobNotExists": { + "value": { + "error_code": "JobNotExists", + "message": "์กด์žฌํ•˜์ง€ ์•Š๋Š” ํฌ์ง€์…˜์ž…๋‹ˆ๋‹ค." + } + }, + "FileNotFound": { + "value": { + "error_code": "FileNotFound", + "message": "์กด์žฌํ•˜์ง€ ์•Š๋Š” ํŒŒ์ผ์ž…๋‹ˆ๋‹ค." + } + }, + "DuplicateFile": { + "value": { + "error_code": "DuplicateFile", + "message": "์ค‘๋ณต๋œ ํŒŒ์ผ๋กœ ์ง€์›ํ•  ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค." + } + } + } + } + } + }, + "401": { + "description": "Unauthenticated user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "Missing required request data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/applications/{application_id}/cancel": { + "patch": { + "tags": [ + "Application" + ], + "summary": "Cancel Support", + "operationId": "cancel_application_applications__application_id__cancel_patch", + "parameters": [ + { + "required": true, + "schema": { + "type": "integer", + "title": "Application Id" + }, + "name": "application_id", + "in": "path" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CancelApplicationRequestSerializer" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "examples": { + "ApplicationNotFound": { + "value": { + "error_code": "ApplicationNotFound", + "message": "์กด์žฌํ•˜์ง€ ์•Š๋Š” ์ง€์›์„œ์ž…๋‹ˆ๋‹ค." + } + } + } + } + } + }, + "401": { + "description": "Unauthenticated user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "Missing required request data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/companies/{company_id}": { + "get": { + "tags": [ + "Company" + ], + "summary": "Company Details Inquiry", + "operationId": "get_company_companies__company_id__get", + "parameters": [ + { + "required": true, + "schema": { + "type": "integer", + "title": "Company Id" + }, + "name": "company_id", + "in": "path" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompanyResponseSerializer" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "examples": { + "JobNotExists": { + "value": { + "error_code": "JobNotExists", + "message": "์กด์žฌํ•˜์ง€ ์•Š๋Š” ํฌ์ง€์…˜์ž…๋‹ˆ๋‹ค." + } + } + } + } + } + }, + "401": { + "description": "Unauthenticated user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "Missing required request data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/companies/{company_id}/jobs": { + "get": { + "tags": [ + "Company" + ], + "summary": "View a list of positions the company is hiring for", + "operationId": "get_company_job_list_companies__company_id__jobs_get", + "parameters": [ + { + "required": true, + "schema": { + "type": "integer", + "title": "Company Id" + }, + "name": "company_id", + "in": "path" + }, + { + "required": false, + "schema": { + "type": "integer", + "title": "Offset", + "default": 0 + }, + "name": "offset", + "in": "query" + }, + { + "required": false, + "schema": { + "type": "integer", + "title": "Limit", + "default": 12 + }, + "name": "limit", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompanyJobListResponseSerializer" + } + } + } + }, + "401": { + "description": "Unauthenticated user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "Missing required request data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/jobs": { + "get": { + "tags": [ + "Job" + ], + "summary": "(Explore) View position list", + "operationId": "get_job_list_jobs_get", + "parameters": [ + { + "description": "Job/Job Tag ID (up to 5)", + "required": false, + "schema": { + "items": { + "type": "integer" + }, + "type": "array", + "maxItems": 5, + "minItems": 0, + "title": "Category Tags", + "description": "Job/Job Tag ID (up to 5)" + }, + "name": "category_tags", + "in": "query" + }, + { + "description": "Skill Tag ID (up to 5)", + "required": false, + "schema": { + "items": { + "type": "integer" + }, + "type": "array", + "maxItems": 5, + "minItems": 0, + "title": "Skill Tags", + "description": "Skill Tag ID (up to 5)" + }, + "name": "skill_tags", + "in": "query" + }, + { + "description": "Career. When 10 is entered, positions with 10 or more years of experience are exposed.", + "required": false, + "schema": { + "items": { + "type": "integer", + "maximum": 10, + "minimum": 0 + }, + "type": "array", + "maximum": 10, + "minimum": 0, + "maxItems": 2, + "title": "Years", + "description": "Career. When 10 is entered, positions with 10 or more years of experience are exposed." + }, + "name": "years", + "in": "query" + }, + { + "description": "Region. Country", + "required": false, + "schema": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Locations", + "description": "Region. Country" + }, + "name": "locations", + "in": "query" + }, + { + "description": "array", + "required": false, + "schema": { + "description": "array" + }, + "name": "sort", + "in": "query" + }, + { + "required": false, + "schema": { + "type": "integer", + "title": "Offset", + "default": 0 + }, + "name": "offset", + "in": "query" + }, + { + "required": false, + "schema": { + "type": "integer", + "title": "Limit", + "default": 20 + }, + "name": "limit", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JobListResponseSerializer" + } + } + } + }, + "401": { + "description": "Unauthenticated user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "Missing required request data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/jobs/{job_id}": { + "get": { + "tags": [ + "Job" + ], + "summary": "View position details", + "operationId": "get_job_jobs__job_id__get", + "parameters": [ + { + "required": true, + "schema": { + "type": "integer", + "title": "Position ID" + }, + "name": "job_id", + "in": "path" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/openapi__apis__v1__jobs__serializers__JobResponseSerializer" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "examples": { + "JobNotExists": { + "value": { + "error_code": "JobNotExists", + "message": "์กด์žฌํ•˜์ง€ ์•Š๋Š” ํฌ์ง€์…˜์ž…๋‹ˆ๋‹ค." + } + } + } + } + } + }, + "401": { + "description": "Unauthenticated user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "Missing required request data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/tags/categories": { + "get": { + "tags": [ + "Tag" + ], + "summary": "View job/job list", + "operationId": "get_categories_tags_categories_get", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagListResponseSerializer" + } + } + } + }, + "401": { + "description": "Unauthenticated user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "Missing required request data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/tags/skills": { + "get": { + "tags": [ + "Tag" + ], + "summary": "View skill list", + "operationId": "get_skills_tags_skills_get", + "parameters": [ + { + "required": true, + "schema": { + "type": "string", + "title": "Keyword" + }, + "name": "keyword", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SkillListResponseSerializer" + } + } + } + }, + "401": { + "description": "Unauthenticated user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "Missing required request data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/search/company/autocomplate": { + "get": { + "tags": [ + "Search" + ], + "summary": "Authcomplate", + "operationId": "authcomplate_search_company_autocomplate_get", + "parameters": [ + { + "description": "Company name to search", + "required": false, + "schema": { + "type": "string", + "title": "Queries", + "description": "Company name to search" + }, + "name": "query", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompanyAutoCompleteResponseSerializer" + } + } + } + }, + "401": { + "description": "Unauthenticated user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "Missing required request data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/search/company": { + "get": { + "tags": [ + "Search" + ], + "summary": "Search Companies", + "operationId": "search_companies_search_company_get", + "parameters": [ + { + "description": "Company name or business registration number to search", + "required": true, + "schema": { + "type": "string", + "title": "Queries", + "description": "Company name or business registration number to search" + }, + "name": "query", + "in": "query" + }, + { + "required": false, + "schema": { + "type": "integer", + "title": "Offset", + "default": 0 + }, + "name": "offset", + "in": "query" + }, + { + "required": false, + "schema": { + "type": "integer", + "title": "Limit", + "default": 20 + }, + "name": "limit", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchCompanyResponseSerializer" + } + } + } + }, + "401": { + "description": "Unauthenticated user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "Missing required request data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/files": { + "get": { + "tags": [ + "File" + ], + "summary": "View attached file list", + "operationId": "get_file_list_files_get", + "parameters": [ + { + "required": false, + "schema": { + "type": "integer", + "title": "Offset", + "default": 0 + }, + "name": "offset", + "in": "query" + }, + { + "required": false, + "schema": { + "type": "integer", + "title": "Limit", + "default": 20 + }, + "name": "limit", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetFileListResponseSerializer" + } + } + } + }, + "401": { + "description": "Unauthenticated user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "Missing required request data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + }, + { + "PermissionsDependency": [] + } + ] + }, + "post": { + "tags": [ + "File" + ], + "summary": "Upload application attachments", + "description": "**How to upload a file** 1. Request `POST /v1/files/upload-url` 2. Upload a temporary file via `presigned_url` in response 1 a. `presigned_url` is valid for 60 minutes b. `presigned_url` is requested with PUT method, Content-Type header as 'application/binary' 3. Complete the file upload by inserting `upload_key` in response 1 into the `POST /v1/files` request data", + "operationId": "upload_file_files_post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UploadFileRequestSerializer" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UploadFileResponseSerializer" + } + } + } + }, + "401": { + "description": "Unauthenticated user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "Missing required request data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/files/{file_key}/download": { + "get": { + "tags": [ + "File" + ], + "summary": "Download attached file", + "operationId": "get_download_url_files__file_key__download_get", + "parameters": [ + { + "required": true, + "schema": { + "type": "string", + "title": "File Key" + }, + "name": "file_key", + "in": "path" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetDownloadUrlResponseSerializer" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "examples": { + "FileNotFound": { + "value": { + "error_code": "FileNotFound", + "message": "์กด์žฌํ•˜์ง€ ์•Š๋Š” ํŒŒ์ผ์ž…๋‹ˆ๋‹ค." + } + } + } + } + } + }, + "401": { + "description": "Unauthenticated user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "Missing required request data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/files/upload-url": { + "post": { + "tags": [ + "File" + ], + "summary": "Generate presigned url for uploading attachments", + "operationId": "generate_presigned_url_files_upload_url_post", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreatePresignedURLResponseSerializer" + } + } + } + }, + "401": { + "description": "Unauthenticated user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "Missing required request data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/stat/application/summary": { + "get": { + "tags": [ + "Stat" + ], + "summary": "(Client-specific) Support status summary inquiry", + "operationId": "get_application_summary_by_client_stat_application_summary_get", + "parameters": [ + { + "description": "Application submission date start range (format: YYYY-MM-DD)", + "required": false, + "schema": { + "type": "string", + "format": "date", + "title": "Start Date", + "description": "Application submission date start range (format: YYYY-MM-DD)", + "default": "2023-11-24" + }, + "name": "start_date", + "in": "query" + }, + { + "description": "Application submission date end range (format: YYYY-MM-DD)", + "required": false, + "schema": { + "type": "string", + "format": "date", + "title": "End Date", + "description": "Application submission date end range (format: YYYY-MM-DD)", + "default": "2024-02-22" + }, + "name": "end_date", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationSummaryResponseSerializer" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "examples": { + "InvalidDateRange": { + "value": { + "error_code": "InvalidDateRange", + "message": "์‹œ์ž‘ ๋‚ ์งœ์™€ ์ข…๋ฃŒ ๋‚ ์งœ์˜ ์ฐจ์ด๋Š” 90์ผ์„ ๋„˜์„ ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค." + } + } + } + } + } + }, + "401": { + "description": "Unauthenticated user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "Missing required request data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + } + }, + "components": { + "schemas": { + "AddressResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "Id" + }, + "country": { + "type": "string", + "title": "nation" + }, + "country_code": { + "type": "string", + "title": "country code" + }, + "location": { + "type": "string", + "title": "Location" + }, + "full_location": { + "type": "string", + "title": "Full address" + }, + "geo_location": { + "type": "object", + "title": "Geo Location" + } + }, + "type": "object", + "title": "AddressResponseSerializer" + }, + "ApplicationListResponseSerializer": { + "properties": { + "links": { + "$ref": "#/components/schemas/LinksSchema" + }, + "applications": { + "items": { + "$ref": "#/components/schemas/ApplicationResponseSerializer" + }, + "type": "array", + "title": "Applications" + } + }, + "type": "object", + "title": "ApplicationListResponseSerializer" + }, + "ApplicationResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "Id", + "description": "Application ID" + }, + "oneid": { + "type": "string", + "title": "Oneid", + "description": "Applicant ID" + }, + "username": { + "type": "string", + "title": "Username", + "description": "Applicant Name" + }, + "email": { + "type": "string", + "title": "Email", + "description": "Applicant Email" + }, + "mobile": { + "type": "string", + "title": "Mobile", + "description": "Formatted phone number (eg +821086388688)" + }, + "application_status": { + "description": "Application Status" + }, + "apply_time": { + "type": "string", + "format": "date-time", + "title": "Apply Time", + "description": "Application submission time" + }, + "edited_time": { + "type": "string", + "format": "date-time", + "title": "Edited Time", + "description": "Application Modification Time" + }, + "open_time": { + "type": "string", + "format": "date-time", + "title": "Open Time", + "description": "First viewing time of application form" + }, + "cancel_time": { + "type": "string", + "format": "date-time", + "title": "Cancel Time", + "description": "Support Cancellation Time" + }, + "cancel_reason": { + "type": "string", + "title": "Cancel Reason", + "description": "Reason for cancellation of support" + }, + "company_id": { + "type": "integer", + "title": "Company Id" + }, + "company_name": { + "type": "string", + "title": "Company Name", + "description": "Company name" + }, + "job_id": { + "type": "integer", + "title": "Job Id", + "description": "Position ID" + }, + "job_name": { + "type": "string", + "title": "Job Name", + "description": "Position name at the time of application" + }, + "job_detail": { + "title": "Job Details", + "description": "Position Details", + "type": "object", + "properties": { + "id": { + "type": "integer", + "title": "Id" + }, + "status": { + "$ref": "#/components/schemas/JobStatusEnum" + }, + "company_id": { + "type": "integer", + "title": "Company Id" + }, + "due_time": { + "type": "string", + "format": "date", + "title": "Due Time", + "description": "Deadline" + }, + "logo_url": { + "$ref": "#/components/schemas/ImageUrlResponseSerializer" + } + } + }, + "resumes": { + "items": { + "$ref": "#/components/schemas/FilesResponseSerializer" + }, + "type": "array", + "title": "Resumes", + "description": "List of attachments" + } + }, + "type": "object", + "required": [ + "id", + "oneid", + "username", + "email", + "mobile", + "application_status", + "apply_time", + "company_id", + "job_id" + ], + "title": "ApplicationResponseSerializer", + "example": { + "id": 688129, + "oneid": "QrKSEkh74AFf", + "username": "์ง€์›์ž๋ช…", + "email": "user@test.com", + "mobile": "+821023456789", + "application_status": "complte", + "apply_time": "2023-03-15T02:09:27.883418", + "company_id": 1422, + "company_name": "์›ํ‹ฐ๋“œ๋žฉ", + "job_id": 23920, + "job_name": "ํฌ์ง€์…˜๋ช…", + "job_detail": { + "id": 23920, + "status": "active", + "company_id": 1, + "logo_url": { + "origin": "https://...", + "thumb": "https://..." + } + }, + "files": [ + { + "key": "qwefew-qweifj-1234", + "title": "Resume.pdf", + "update_time": "2023-03-15T02:09:27.883418" + } + ] + } + }, + "ApplicationStatusSearchEnum": { + "oneOf": [ + { + "const": "complete", + "title": "ApplicationStatusSearchEnum", + "description": "An enumeration." + }, + { + "const": "pass", + "title": "ApplicationStatusSearchEnum", + "description": "An enumeration." + }, + { + "const": "reject", + "title": "ApplicationStatusSearchEnum", + "description": "An enumeration." + }, + { + "const": "hire", + "title": "ApplicationStatusSearchEnum", + "description": "An enumeration." + } + ], + "title": "ApplicationStatusSearchEnum", + "description": "An enumeration." + }, + "ApplicationSummaryResponseSerializer": { + "properties": { + "complete": { + "type": "integer", + "title": "Complete", + "default": 0 + }, + "document_pass": { + "type": "integer", + "title": "Document Pass", + "default": 0 + }, + "hire": { + "type": "integer", + "title": "Hire", + "default": 0 + }, + "reject": { + "type": "integer", + "title": "Reject", + "default": 0 + }, + "total": { + "type": "integer", + "title": "Total", + "default": 0 + } + }, + "type": "object", + "title": "ApplicationSummaryResponseSerializer", + "example": { + "complete": 1, + "document_pass": 1, + "hire": 0, + "reject": 1, + "total": 3 + } + }, + "ApplyJobRequestSerializer": { + "properties": { + "job_id": { + "type": "integer", + "title": "Job Id" + }, + "username": { + "type": "string", + "title": "Username" + }, + "email": { + "type": "string", + "title": "Email" + }, + "mobile": { + "type": "string", + "title": "Mobile" + }, + "resume_keys": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Resume Keys", + "description": "List of files to attach when applying" + } + }, + "type": "object", + "required": [ + "job_id", + "username", + "email", + "mobile", + "resume_keys" + ], + "title": "ApplyJobRequestSerializer" + }, + "ApplyTextPredictionRequestSerializer": { + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/ResumeJdTextPredictionItemSerializer" + }, + "type": "array", + "title": "Prediction request data list" + }, + "callback_url": { + "type": "string", + "title": "CallbackURL", + "description": "URL to be notified of results after asynchronous processing", + "example": "http://my-server.com/v1/apply/callback" + }, + "request_id": { + "type": "string", + "title": "Request ID", + "description": "When notifying the processing result, the request ID is transmitted together. By default, it is automatically generated in UUID format, but if the notification URL call is made before the asynchronous request process due to client-side logic, the request_id must be specified in advance.", + "example": "55e41f9f-a5a6-4836-8490-68914ff51b64" + } + }, + "type": "object", + "required": [ + "data", + "callback_url" + ], + "title": "ApplyTextPredictionRequestSerializer" + }, + "AsyncPredictionResponseSerializer": { + "properties": { + "request_id": { + "type": "string", + "title": "Request ID", + "description": "When calling CallbackURL, a request ID is passed along to distinguish which request it is the result of.", + "example": "55e41f9f-a5a6-4836-8490-68914ff51b64" + } + }, + "type": "object", + "required": [ + "request_id" + ], + "title": "AsyncPredictionResponseSerializer" + }, + "CancelApplicationRequestSerializer": { + "properties": { + "cancel_reason": { + "type": "string", + "title": "Cancel Reason" + } + }, + "type": "object", + "title": "CancelApplicationRequestSerializer" + }, + "CategoryTagResponseSerializer": { + "properties": { + "parent_tag": { + "title": "Occupation", + "type": "object", + "properties": { + "id": { + "type": "integer", + "title": "Tag ID" + }, + "text": { + "type": "string", + "title": "Tag name" + } + } + }, + "child_tags": { + "items": { + "$ref": "#/components/schemas/openapi__apis__v1__jobs__serializers__TagResponseSerializer" + }, + "type": "array", + "title": "job" + } + }, + "type": "object", + "title": "CategoryTagResponseSerializer" + }, + "CompanyAutoCompleteResponseSerializer": { + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/_CompanyAutoCompleteSerializer" + }, + "type": "array", + "title": "Data" + } + }, + "type": "object", + "title": "CompanyAutoCompleteResponseSerializer", + "example": { + "data": [ + { + "company_id": 518, + "name": "์›ํ‹ฐ๋“œ๋žฉ", + "logo_image": "https://image.jpg" + } + ] + } + }, + "CompanyDetailResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "Company ID" + }, + "company_confirm": { + "type": "boolean", + "title": "Whether the company is approved", + "description": "True: Approval completed, False: Approval rejected, Approval requested, Approval not requested" + }, + "registration_number": { + "type": "string", + "title": "Business registration number" + }, + "name": { + "type": "string", + "title": "Company name" + }, + "logo_url": { + "$ref": "#/components/schemas/ImageUrlSchema" + }, + "images": { + "items": { + "type": "object" + }, + "type": "array", + "title": "Company Image" + }, + "description": { + "type": "string", + "title": "About Us" + }, + "link": { + "type": "string", + "title": "Company Page Link" + }, + "url": { + "type": "string", + "title": "Company details page url" + } + }, + "type": "object", + "required": [ + "id", + "company_confirm", + "name", + "url" + ], + "title": "CompanyDetailResponseSerializer" + }, + "CompanyJobListResponseSerializer": { + "properties": { + "links": { + "$ref": "#/components/schemas/LinksSchema" + }, + "jobs": { + "items": { + "$ref": "#/components/schemas/openapi__apis__v1__companies__serializers__JobResponseSerializer" + }, + "type": "array", + "title": "Jobs" + } + }, + "type": "object", + "title": "CompanyJobListResponseSerializer", + "example": { + "links": { + "next": "/v1/companies/79/jobs?offset=12&limit=12" + }, + "jobs": [ + { + "id": 23617, + "name": "VR ์—”์ง€๋‹ˆ์–ด", + "reward": { + "country": "KR", + "total": "100๋งŒ์›", + "recommender": "50๋งŒ์›", + "recommendee": "50๋งŒ์›" + }, + "url": "https://www.wanted.co.kr/wd/10002" + }, + { + "id": 23652, + "name": "QA", + "due_time": "2023-03-21" + } + ] + } + }, + "CompanyResponseSerializer": { + "properties": { + "company": { + "$ref": "#/components/schemas/CompanyDetailResponseSerializer" + } + }, + "type": "object", + "title": "CompanyResponseSerializer", + "example": { + "company": { + "id": 79, + "company_confirm": true, + "registration_number": "12622032023", + "name": "์›ํ‹ฐ๋“œ๋žฉ", + "logo_url": { + "origin": "https://...", + "thumb": "https://..." + }, + "images": [ + { + "id": 1894, + "is_title": true, + "origin": "https://...", + "thumb": "https://..." + }, + { + "id": 1889, + "is_title": false, + "origin": "https://...", + "thumb": "https://..." + } + ], + "description": "Wanted Lab Company Introduction", + "link": "http://wanted.co.kr/", + "url": "https://www.wanted.co.kr/company/79?client_id=xxxx" + } + } + }, + "CompanyTagResponseSerializer": { + "properties": { + "tag_type_id": { + "type": "integer", + "title": "Tag ID" + }, + "text": { + "type": "string", + "title": "Tag name" + } + }, + "type": "object", + "title": "CompanyTagResponseSerializer" + }, + "CountryEnum": { + "oneOf": [ + { + "const": "KR", + "title": "CountryEnum", + "description": "An enumeration." + }, + { + "const": "JP", + "title": "CountryEnum", + "description": "An enumeration." + }, + { + "const": "TW", + "title": "CountryEnum", + "description": "An enumeration." + }, + { + "const": "HK", + "title": "CountryEnum", + "description": "An enumeration." + }, + { + "const": "SG", + "title": "CountryEnum", + "description": "An enumeration." + }, + { + "const": "WW", + "title": "CountryEnum", + "description": "An enumeration." + } + ], + "title": "CountryEnum", + "description": "An enumeration." + }, + "CreatePresignedURLResponseSerializer": { + "properties": { + "presigned_url": { + "type": "string", + "title": "Presigned Url" + }, + "upload_key": { + "type": "string", + "title": "Upload Key" + } + }, + "type": "object", + "required": [ + "presigned_url", + "upload_key" + ], + "title": "CreatePresignedURLResponseSerializer", + "example": { + "presigned_url": "https://...", + "upload_key": "qwe0982awfwef" + } + }, + "FilesResponseSerializer": { + "properties": { + "key": { + "type": "string", + "title": "Key" + }, + "title": { + "type": "string", + "title": "Title" + }, + "update_time": { + "type": "string", + "format": "date-time", + "title": "Update Time" + } + }, + "type": "object", + "required": [ + "key", + "update_time" + ], + "title": "FilesResponseSerializer" + }, + "GetDownloadUrlResponseSerializer": { + "properties": { + "presigned_url": { + "type": "string", + "title": "Presigned Url" + } + }, + "type": "object", + "required": [ + "presigned_url" + ], + "title": "GetDownloadUrlResponseSerializer", + "example": { + "url": "https://..." + } + }, + "GetFileListResponseSerializer": { + "properties": { + "links": { + "$ref": "#/components/schemas/LinksSchema" + }, + "data": { + "items": { + "$ref": "#/components/schemas/FilesResponseSerializer" + }, + "type": "array", + "title": "Data" + } + }, + "type": "object", + "title": "GetFileListResponseSerializer", + "example": { + "data": [ + { + "key": "AAUIBQQDSgdNVQ==", + "title": "string.pdf", + "update_time": "2023-04-10T16:53:23" + } + ], + "links": { + "prev": "http://...", + "next": "http://..." + } + } + }, + "ImageUrlResponseSerializer": { + "properties": { + "origin": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "Origin" + }, + "thumb": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "Thumb" + }, + "is_title": { + "type": "boolean", + "title": "Is Title", + "default": false + } + }, + "type": "object", + "title": "ImageUrlResponseSerializer" + }, + "ImageUrlSchema": { + "properties": { + "origin": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "Origin", + "description": "Original image URL" + }, + "thumb": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "Thumb", + "description": "Thumbnail image URL" + } + }, + "type": "object", + "title": "ImageUrlSchema" + }, + "JobCompanyResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "Company ID" + }, + "name": { + "type": "string", + "title": "Company name" + }, + "link": { + "type": "string", + "title": "Company Page Link" + }, + "registration_number": { + "type": "string", + "title": "Business registration number" + }, + "logo_img": { + "title": "Logo Image", + "type": "object", + "properties": { + "origin": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "Origin" + }, + "thumb": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "Thumb" + }, + "is_title": { + "type": "boolean", + "title": "Is Title", + "default": false + } + } + }, + "description": { + "type": "string", + "title": "About Us" + }, + "company_tags": { + "items": { + "$ref": "#/components/schemas/CompanyTagResponseSerializer" + }, + "type": "array", + "title": "Corporate Tags", + "default": [] + } + }, + "type": "object", + "title": "JobCompanyResponseSerializer" + }, + "JobListAddressResponseSerializer": { + "properties": { + "country": { + "type": "string", + "title": "Country" + }, + "location": { + "type": "string", + "title": "Location" + }, + "full_location": { + "type": "string", + "title": "Full Location" + } + }, + "type": "object", + "title": "JobListAddressResponseSerializer" + }, + "JobListDetailResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "Position ID" + }, + "status": { + "$ref": "#/components/schemas/JobStatusEnum" + }, + "due_time": { + "type": "string", + "format": "date", + "title": "Deadline" + }, + "position": { + "type": "string", + "title": "Position Name" + }, + "company": { + "title": "company", + "type": "object", + "properties": { + "id": { + "type": "integer", + "title": "Company ID" + }, + "name": { + "type": "string", + "title": "Company name" + }, + "link": { + "type": "string", + "title": "Company Page Link" + }, + "registration_number": { + "type": "string", + "title": "Business registration number" + }, + "logo_img": { + "title": "Logo Image", + "type": "object", + "properties": { + "origin": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "Origin" + }, + "thumb": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "Thumb" + }, + "is_title": { + "type": "boolean", + "title": "Is Title", + "default": false + } + } + }, + "description": { + "type": "string", + "title": "About Us" + }, + "company_tags": { + "items": { + "$ref": "#/components/schemas/CompanyTagResponseSerializer" + }, + "type": "array", + "title": "Corporate Tags", + "default": [] + } + } + }, + "reward": { + "title": "Compensation", + "type": "object", + "properties": { + "country": { + "$ref": "#/components/schemas/CountryEnum" + }, + "formatted_total": { + "type": "string", + "title": "Formatted Total", + "description": "Total compensation", + "default": "0" + }, + "formatted_recommender": { + "type": "string", + "title": "Formatted Recommender", + "description": "Referral Bonus", + "default": "0" + }, + "formatted_recommendee": { + "type": "string", + "title": "Formatted Recommendee", + "description": "Applicant Compensation", + "default": "0" + } + } + }, + "address": { + "title": "address", + "type": "object", + "properties": { + "country": { + "type": "string", + "title": "Country" + }, + "location": { + "type": "string", + "title": "Location" + }, + "full_location": { + "type": "string", + "title": "Full Location" + } + } + }, + "title_img": { + "$ref": "#/components/schemas/ImageUrlResponseSerializer" + }, + "logo_img": { + "$ref": "#/components/schemas/ImageUrlResponseSerializer" + }, + "category_tags": { + "title": "Job/Job Tags", + "type": "object", + "properties": { + "parent_tag": { + "title": "Occupation", + "type": "object", + "properties": { + "id": { + "type": "integer", + "title": "Tag ID" + }, + "text": { + "type": "string", + "title": "Tag name" + } + } + }, + "child_tags": { + "items": { + "$ref": "#/components/schemas/openapi__apis__v1__jobs__serializers__TagResponseSerializer" + }, + "type": "array", + "title": "job" + } + } + }, + "url": { + "type": "string", + "title": "Position Page Detail URL" + } + }, + "type": "object", + "required": [ + "id", + "status", + "position", + "company", + "url" + ], + "title": "JobListDetailResponseSerializer" + }, + "JobListResponseSerializer": { + "properties": { + "links": { + "$ref": "#/components/schemas/LinksSchema" + }, + "data": { + "items": { + "$ref": "#/components/schemas/JobListDetailResponseSerializer" + }, + "type": "array", + "title": "Data" + } + }, + "type": "object", + "title": "JobListResponseSerializer", + "example": { + "data": [ + { + "id": 24049, + "status": "active", + "due_time": "2023-05-01", + "name": "ํฌ์ง€์…˜๋ช…", + "address": { + "country": "ํ•œ๊ตญ", + "location": "์„œ์šธ" + }, + "title_img": { + "origin": "https://...", + "thumb": "https://..." + }, + "logo_img": { + "origin": "https://...", + "thumb": "https://..." + }, + "company": { + "id": 7565, + "name": "๊ธฐ์—…๋ช…" + }, + "reward": { + "total": "100๋งŒ์›", + "recommender": "50๋งŒ์›", + "recommendee": "50๋งŒ์›" + } + } + ], + "links": { + "prev": "/api/chaos/jobs/v1?country=KR&sort=company.response_rate_order&offset=1&limit=1", + "next": "/api/chaos/jobs/v1?country=KR&sort=company.response_rate_order&offset=1&limit=1" + } + } + }, + "JobSortEnum": { + "enum": [ + "job.latest_order", + "job.popularity_order", + "company.response_rate_order" + ], + "title": "JobSortEnum", + "description": "An enumeration." + }, + "JobStatusEnum": { + "oneOf": [ + { + "const": "request", + "title": "JobStatusEnum", + "description": "An enumeration." + }, + { + "const": "draft", + "title": "JobStatusEnum", + "description": "An enumeration." + }, + { + "const": "active", + "title": "JobStatusEnum", + "description": "An enumeration." + }, + { + "const": "archived", + "title": "JobStatusEnum", + "description": "An enumeration." + }, + { + "const": "close", + "title": "JobStatusEnum", + "description": "An enumeration." + }, + { + "const": "saved", + "title": "JobStatusEnum", + "description": "An enumeration." + } + ], + "title": "JobStatusEnum", + "description": "An enumeration." + }, + "LinksSchema": { + "properties": { + "prev": { + "type": "string", + "title": "Prev", + "description": "Previous page" + }, + "next": { + "type": "string", + "title": "Next", + "description": "Next page" + } + }, + "type": "object", + "title": "LinksSchema" + }, + "OpenAPIExceptionResponse": { + "properties": { + "error_code": { + "type": "string", + "title": "Error Code" + }, + "message": { + "type": "string", + "title": "Message" + }, + "data": { + "type": "object", + "title": "Data" + } + }, + "type": "object", + "required": [ + "error_code", + "message" + ], + "title": "OpenAPIExceptionResponse" + }, + "ParentTagResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "Id", + "description": "Tag ID" + }, + "parent_id": { + "type": "integer", + "title": "Parent Id", + "description": "Parent Tag ID" + }, + "title": { + "type": "string", + "title": "Title", + "description": "Tag name" + }, + "title_thumb_img": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "Title Thumb Img", + "description": "Tag Image URL" + }, + "sub_tags": { + "items": { + "$ref": "#/components/schemas/openapi__apis__v1__tags__serializers__TagResponseSerializer" + }, + "type": "array", + "title": "Sub Tags" + } + }, + "type": "object", + "required": [ + "id", + "title" + ], + "title": "ParentTagResponseSerializer" + }, + "PassTextPredictionRequestSerializer": { + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/ResumeJdTextPredictionItemSerializer" + }, + "type": "array", + "title": "Prediction request data list" + }, + "callback_url": { + "type": "string", + "title": "CallbackURL", + "description": "URL to be notified of results after asynchronous processing", + "example": "http://my-server.com/v1/pass/callback" + }, + "request_id": { + "type": "string", + "title": "Request ID", + "description": "When notifying the processing result, the request ID is transmitted together. By default, it is automatically generated in UUID format, but if the notification URL call is made before the asynchronous request process due to client-side logic, the request_id must be specified in advance.", + "example": "55e41f9f-a5a6-4836-8490-68914ff51b64" + } + }, + "type": "object", + "required": [ + "data", + "callback_url" + ], + "title": "PassTextPredictionRequestSerializer" + }, + "ResumeJdTextPredictionItemSerializer": { + "properties": { + "resume": { + "type": "string", + "title": "Resume text", + "example": "5๋…„์ฐจ ์†Œํ”„ํŠธ์›จ์–ด ์—”์ง€๋‹ˆ์–ด ์ž…๋‹ˆ๋‹ค..." + }, + "jd": { + "type": "string", + "title": "JD Text", + "example": "5๋…„์ฐจ ์†Œํ”„ํŠธ์›จ์–ด ์—”์ง€๋‹ˆ์–ด ๊ตฌํ•ฉ๋‹ˆ๋‹ค..." + } + }, + "type": "object", + "required": [ + "resume", + "jd" + ], + "title": "ResumeJdTextPredictionItemSerializer" + }, + "RewardResponseSerializer": { + "properties": { + "country": { + "$ref": "#/components/schemas/CountryEnum" + }, + "formatted_total": { + "type": "string", + "title": "Formatted Total", + "description": "Total compensation", + "default": "0" + }, + "formatted_recommender": { + "type": "string", + "title": "Formatted Recommender", + "description": "Referral Bonus", + "default": "0" + }, + "formatted_recommendee": { + "type": "string", + "title": "Formatted Recommendee", + "description": "Applicant Compensation", + "default": "0" + } + }, + "type": "object", + "title": "RewardResponseSerializer" + }, + "SearchCompanyResponseSerializer": { + "properties": { + "links": { + "$ref": "#/components/schemas/LinksSchema" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_SearchCompanySchema" + }, + "type": "array", + "title": "Data" + } + }, + "type": "object", + "title": "SearchCompanyResponseSerializer", + "example": { + "links": { + "next": "/api/chaos/search/v1/company?query=%EC%9B%90%ED%8B%B0%EB%93%9C&offset=1&limit=1&offset=1&limit=1" + }, + "companies": [ + { + "id": 79, + "name": "์›ํ‹ฐ๋“œ๋žฉ", + "logo_img": { + "origin": "https://static.wanted.co.kr/nextweek/images/wdes/0_4.7d6ea9b0.test_nextweek.jpg", + "thumb": "https://static.wanted.co.kr/nextweek/images/wdes/0_5.7d6ea9b0.test_nextweek.jpg" + }, + "title_img": { + "origin": "https://static.wanted.co.kr/images/company/79/15562_2_6.__1080_790.jpg", + "thumb": "https://static.wanted.co.kr/images/company/79/15562_2_6.__400_400.jpg" + }, + "description": "Wanted Lab is the best", + "url": "https://www.wanted.co.kr/company/79?client_id=xxxx" + } + ] + } + }, + "SkillListResponseSerializer": { + "properties": { + "skills": { + "items": { + "$ref": "#/components/schemas/ParentTagResponseSerializer" + }, + "type": "array", + "title": "Skills" + } + }, + "type": "object", + "title": "SkillListResponseSerializer", + "example": { + "data": [ + { + "id": 1540, + "title": "Java" + } + ] + } + }, + "TagListResponseSerializer": { + "properties": { + "tags": { + "items": { + "$ref": "#/components/schemas/ParentTagResponseSerializer" + }, + "type": "array", + "title": "Tags" + } + }, + "type": "object", + "title": "TagListResponseSerializer", + "example": { + "data": [ + { + "id": 518, + "title": "development", + "image_url": "https://...", + "sub_tags": [ + { + "id": 873, + "parent_id": 518, + "title": "Web Developer", + "image_url": "https://..." + }, + { + "id": 872, + "parent_id": 518, + "title": "Server Developer", + "image_url": "https://..." + } + ] + } + ] + } + }, + "UploadFileRequestSerializer": { + "properties": { + "upload_key": { + "type": "string", + "title": "Upload Key", + "description": "upload_key in response `/v1/files/upload-url`" + }, + "title": { + "type": "string", + "title": "File name", + "description": "The file name including the extension of the file uploaded using `presigned_url` of the `/v1/files/upload-url` response." + } + }, + "type": "object", + "required": [ + "upload_key", + "title" + ], + "title": "UploadFileRequestSerializer", + "example": { + "upload_key": "0362e393-45b7-4bca-9e33-676cffcc5cbe", + "title": "Attachment.pdf" + } + }, + "UploadFileResponseSerializer": { + "properties": { + "key": { + "type": "string", + "title": "Key" + } + }, + "type": "object", + "required": [ + "key" + ], + "title": "UploadFileResponseSerializer", + "example": { + "key": "AAUIBQQGSgdNVQ==" + } + }, + "_CompanyAutoCompleteSerializer": { + "properties": { + "company_id": { + "type": "integer", + "title": "Company Id", + "description": "Company ID" + }, + "name_ko": { + "type": "string", + "title": "Name Ko", + "description": "Company name" + }, + "logo_image": { + "type": "string", + "title": "Logo Image", + "description": "company logo image url" + } + }, + "type": "object", + "required": [ + "company_id", + "name_ko" + ], + "title": "_CompanyAutoCompleteSerializer" + }, + "_SearchCompanySchema": { + "properties": { + "id": { + "type": "integer", + "title": "Id", + "description": "Company ID" + }, + "name": { + "type": "string", + "title": "Name", + "description": "Company name" + }, + "logo_img": { + "$ref": "#/components/schemas/ImageUrlSchema" + }, + "title_img": { + "$ref": "#/components/schemas/ImageUrlSchema" + }, + "description": { + "type": "string", + "title": "Description", + "description": "Company Description" + }, + "url": { + "type": "string", + "title": "Url", + "description": "Company details page url" + } + }, + "type": "object", + "required": [ + "id", + "name", + "url" + ], + "title": "_SearchCompanySchema" + }, + "openapi__apis__v1__applications__serializers__JobDetailResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "Id" + }, + "status": { + "$ref": "#/components/schemas/JobStatusEnum" + }, + "company_id": { + "type": "integer", + "title": "Company Id" + }, + "due_time": { + "type": "string", + "format": "date", + "title": "Due Time", + "description": "Deadline" + }, + "logo_url": { + "$ref": "#/components/schemas/ImageUrlResponseSerializer" + } + }, + "type": "object", + "required": [ + "id", + "status" + ], + "title": "JobDetailResponseSerializer" + }, + "openapi__apis__v1__companies__serializers__JobResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "Id", + "description": "Position ID" + }, + "name": { + "type": "string", + "title": "Name", + "description": "Position Name" + }, + "due_time": { + "type": "string", + "format": "date", + "title": "Due Time", + "description": "Deadline" + }, + "reward": { + "title": "Reward", + "description": "Compensation", + "type": "object", + "properties": { + "country": { + "$ref": "#/components/schemas/CountryEnum" + }, + "formatted_total": { + "type": "string", + "title": "Formatted Total", + "description": "Total compensation", + "default": "0" + }, + "formatted_recommender": { + "type": "string", + "title": "Formatted Recommender", + "description": "Referral Bonus", + "default": "0" + }, + "formatted_recommendee": { + "type": "string", + "title": "Formatted Recommendee", + "description": "Applicant Compensation", + "default": "0" + } + } + }, + "url": { + "type": "string", + "title": "Position Page Detail URL" + } + }, + "type": "object", + "required": [ + "id", + "name", + "url" + ], + "title": "JobResponseSerializer" + }, + "openapi__apis__v1__jobs__serializers__JobDetailResponseSerializer": { + "properties": { + "position": { + "type": "string", + "title": "Position Name" + }, + "intro": { + "type": "string", + "title": "Intro" + }, + "main_tasks": { + "type": "string", + "title": "Main tasks" + }, + "requirements": { + "type": "string", + "title": "Qualifications" + }, + "preferred_points": { + "type": "string", + "title": "Preferential treatment" + }, + "benefits": { + "type": "string", + "title": "Benefits and Welfare" + } + }, + "type": "object", + "title": "JobDetailResponseSerializer" + }, + "openapi__apis__v1__jobs__serializers__JobResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "Position ID" + }, + "status": { + "$ref": "#/components/schemas/JobStatusEnum" + }, + "due_time": { + "type": "string", + "format": "date", + "title": "Deadline" + }, + "detail": { + "$ref": "#/components/schemas/openapi__apis__v1__jobs__serializers__JobDetailResponseSerializer" + }, + "category_tags": { + "title": "Job/Job Tags", + "type": "object", + "properties": { + "parent_tag": { + "title": "Occupation", + "type": "object", + "properties": { + "id": { + "type": "integer", + "title": "Tag ID" + }, + "text": { + "type": "string", + "title": "Tag name" + } + } + }, + "child_tags": { + "items": { + "$ref": "#/components/schemas/openapi__apis__v1__jobs__serializers__TagResponseSerializer" + }, + "type": "array", + "title": "job" + } + } + }, + "skill_tags": { + "items": { + "$ref": "#/components/schemas/openapi__apis__v1__jobs__serializers__TagResponseSerializer" + }, + "type": "array", + "title": "Skill Tag" + }, + "company": { + "title": "company", + "type": "object", + "properties": { + "id": { + "type": "integer", + "title": "Company ID" + }, + "name": { + "type": "string", + "title": "Company name" + }, + "link": { + "type": "string", + "title": "Company Page Link" + }, + "registration_number": { + "type": "string", + "title": "Business registration number" + }, + "logo_img": { + "title": "Logo Image", + "type": "object", + "properties": { + "origin": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "Origin" + }, + "thumb": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "Thumb" + }, + "is_title": { + "type": "boolean", + "title": "Is Title", + "default": false + } + } + }, + "description": { + "type": "string", + "title": "About Us" + }, + "company_tags": { + "items": { + "$ref": "#/components/schemas/CompanyTagResponseSerializer" + }, + "type": "array", + "title": "Corporate Tags", + "default": [] + } + } + }, + "reward": { + "title": "Compensation", + "type": "object", + "properties": { + "country": { + "$ref": "#/components/schemas/CountryEnum" + }, + "formatted_total": { + "type": "string", + "title": "Formatted Total", + "description": "Total compensation", + "default": "0" + }, + "formatted_recommender": { + "type": "string", + "title": "Formatted Recommender", + "description": "Referral Bonus", + "default": "0" + }, + "formatted_recommendee": { + "type": "string", + "title": "Formatted Recommendee", + "description": "Applicant Compensation", + "default": "0" + } + } + }, + "address": { + "title": "address", + "type": "object", + "properties": { + "id": { + "type": "integer", + "title": "Id" + }, + "country": { + "type": "string", + "title": "nation" + }, + "country_code": { + "type": "string", + "title": "country code" + }, + "location": { + "type": "string", + "title": "Location" + }, + "full_location": { + "type": "string", + "title": "Full address" + }, + "geo_location": { + "type": "object", + "title": "Geo Location" + } + } + }, + "images": { + "items": { + "$ref": "#/components/schemas/ImageUrlResponseSerializer" + }, + "type": "array", + "title": "Images" + }, + "url": { + "type": "string", + "title": "Position Page Detail URL" + } + }, + "type": "object", + "required": [ + "url" + ], + "title": "JobResponseSerializer", + "example": { + "id": 24090, + "status": "active", + "due_time": "2023-05-01", + "detail": { + "intro": "โ€˜์›ํ‹ฐ๋“œ๋žฉโ€™์€ ์ „ ์„ธ๊ณ„ ๋ชจ๋“  ๊ธฐ์—…๊ณผ ์ง์žฅ์ธ์˜ ๊ณ ๋ฏผ์„ ํ•ด๊ฒฐํ•˜๊ธฐ ์œ„ํ•œ HR ์Šคํƒ€ํŠธ์—…์ž…๋‹ˆ๋‹ค. ์ง์žฅ์ธ์˜ 90%๋Š” ์ด์ง์„ ์ƒ๊ฐํ•˜์ง€๋งŒ, ์–ด๋–ค ๊ธฐ์—…์ด ์ž์‹ ์—๊ฒŒ ์ตœ์„ ์˜ ์„ ํƒ์ธ์ง€ ์•Œ์ง€ ๋ชปํ•œ ์ฑ„ ์—…๋ฌด์— ์ž์‹ ์„ ๋งž์ถ”๊ณ  ์žˆ์Šต๋‹ˆ๋‹ค. ๊ธฐ์—…์€ ๋ˆ„๊ตฐ๊ฐ€์— ์˜ํ•ด ๊ฒ€์ฆ๋œ ์ธ์žฌ๋ฅผ ์ฑ„์šฉํ•˜๊ณ  ์‹ถ์ง€๋งŒ, ๊ทธ ๋น„์šฉ๊ณผ ์‹œ๊ฐ„์ด ๋งŒ๋งŒ์น˜ ์•Š์•„ ์žกํฌํ„ธ ๊ด‘๊ณ ์™€ ์˜คํ”„๋ผ์ธ ํ—ค๋“œํ—ŒํŒ…์— ์˜์กดํ•˜๊ณ  ์žˆ์Šต๋‹ˆ๋‹ค. \n\n์šฐ๋ฆฌ๋Š” ๋‹จ์ˆœํ•œ ์ฑ„์šฉ ์„œ๋น„์Šค๊ฐ€ ๋˜๋ ค๋Š” ๊ฒƒ์ด ์•„๋‹™๋‹ˆ๋‹ค. ์šฐ๋ฆฌ๋Š” โ€˜์ข‹์€ ์ผ์ž๋ฆฌ์™€ ์ˆจ์€ ์ธ์žฌ๋ฅผ ์—ฐ๊ฒฐํ•˜๋Š” ๊ฐ€์žฅ ํšจ์œจ์ ์ด๊ณ  ์ธ๊ฐ„์ ์ธ ๋ฐฉ๋ฒ•โ€™์ด๋ผ๋Š” ๋ฌธ์ œ๋ฅผ ํ’€๊ณ ์ž ํ•ฉ๋‹ˆ๋‹ค. ์ธ์žฌ์—๊ฒŒ๋Š” ์ž์‹ ์˜ ์—ญ๋Ÿ‰์„ ์œ ๊ฐ์—†์ด ๋ฐœํœ˜ํ•  ์ˆ˜ ์žˆ๋Š” ์ผ์ž๋ฆฌ๋ฅผ ์ถ”์ฒœํ•˜๊ณ , ๊ธฐ์—…์—๊ฒŒ๋Š” ํ•„์š”ํ•œ ์ž๋ฆฌ์— ๋”ฑ ๋งž๋Š” ์ธ์žฌ๋ฅผ ์ถ”์ฒœํ•˜๋Š” ์„œ๋น„์Šค์ž…๋‹ˆ๋‹ค. ์ด๋ฅผ ์œ„ํ•ด ๋ชจ๋ฐ”์ผ / ์†Œ์…œ ๋„คํŠธ์›Œํฌ / ๋น…๋ฐ์ดํ„ฐ์— ๊ธฐ๋ฐ˜ํ•œ HR ์†”๋ฃจ์…˜๋“ค์„ ํ•˜๋‚˜์”ฉ ๋งŒ๋“ค์–ด๋‚˜๊ฐ€๊ณ  ์žˆ์Šต๋‹ˆ๋‹ค. ์šฐ๋ฆฌ์˜ ์‹œ์„ ์€ ํ•œ๊ตญ์— ๋จธ๋ฌผ๋Ÿฌ ์žˆ์ง€ ์•Š์Šต๋‹ˆ๋‹ค. \n\n2015๋…„ 5์›” ์„œ๋น„์Šค๋ฅผ ์‹œ์ž‘ํ•˜์—ฌ, 2019๋…„ 3์›” ํ˜„์žฌ 4000์—ฌ ๊ธฐ์—…, 60๋งŒ ์œ ์ €(ํ•œ๊ตญ ๊ธฐ์ค€)๊ฐ€ ์ด์šฉ ์ค‘์— ์žˆ์Šต๋‹ˆ๋‹ค. 2017๋…„ 5์›”์—๋Š” 100์–ต ํˆฌ์ž๋ฅผ ๋ฐ›์•˜์œผ๋ฉฐ, ํ•œ๊ตญ/์ผ๋ณธ/๋Œ€๋งŒ/์‹ฑ๊ฐ€ํด/ํ™์ฝฉ ์˜คํ”ผ์Šค์— 65์—ฌ๋ช…์˜ ๊ตฌ์„ฑ์›๋“ค๊ณผ ํ•จ๊ป˜ ์•„์‹œ์•„ HR ์‹œ์žฅ์„ ์„ ๋„ํ•˜๊ณ ์ž ํ•ฉ๋‹ˆ๋‹ค. \n \n2016๋…„ ์•„์‹œ์•„ ์ตœ์ดˆ๋กœ ์„ค๋ฆฝ๋œ Google Campus์˜ ์ฒซ ๋ฒˆ์งธ ์ž…์ฃผ๊ธฐ์—…์œผ๋กœ ์„ ๋ฐœ๋˜์—ˆ์œผ๋ฉฐ, 2016๋…„ KMA ๋Œ€ํ•œ๋ฏผ๊ตญ๋ชจ๋ฐ”์ผ์–ด์›Œ๋“œ ๋Œ€์ƒ ์ˆ˜์ƒ, 2017๋…„ AWS์˜ ๋– ์˜ค๋ฅด๋Š” ์Šคํƒ€ํŠธ์—… ์„ ์ •, Facebook Korea๊ฐ€ ์„ ์ •ํ•œ ๋Œ€ํ‘œ์ ์ธ ํŒŒํŠธ๋„ˆ์‹ญ ์‚ฌ๋ก€๋กœ ์†Œ๊ฐœ, 2018๋…„ Forbes๊ฐ€ ์„ ์ •ํ•œ 2018๋…„ ์ฃผ๋ชฉํ•ด์•ผ ํ•  ํ•œ๊ตญ ์Šคํƒ€ํŠธ์—…์œผ๋กœ ์„ ์ •๋˜์—ˆ๊ณ , ๋˜ํ•œ Google TensorFlow๋ฅผ ํ™œ์šฉํ•˜์—ฌ ๋งค์นญ ์„œ๋น„์Šค๋ฅผ ํ•˜๊ณ  ์žˆ๋Š” ๊ตญ๋‚ด ์ฒซ ์‚ฌ๋ก€๋กœ ๊ตฌ๊ธ€ ๊ฐœ๋ฐœ์ž ํ–‰์‚ฌ์—์„œ ์‚ฌ๋ก€๋ฅผ ๋ฐœํ‘œํ•˜๊ธฐ๋„ ํ•˜์˜€์Šต๋‹ˆ๋‹ค.", + "main_tasks": "โ€ข ๋ฉ”์ดํ”Œ ์Šคํ† ๋ฆฌ2 ๊ธฐํš ์—…๋ฌด \nโ€ข ๊ฒŒ์ž„์˜ ์žฌ๋ฏธ๋ฅผ ์œ„ํ•œ ๋‹ค์–‘ํ•œ ๋ฃฐ์ด๋‚˜ ์‹œ์Šคํ…œ์„ ๊ธฐํšํ•˜๊ณ  ์ด๋ฅผ ๊ตฌํ˜„", + "requirements": "โ€ข ์‹ค๋ฌด์—์„œ MS Office๋ฅผ ํ™œ์šฉํ•˜๋Š”๋ฐ ํฐ ๋ฌธ์ œ๊ฐ€ ์—†๋Š” ๋ถ„ \nโ€ข ๊ฒŒ์ž„์„ ์ฆ๊ธฐ๊ณ  ์ข‹์•„ํ•˜์‹œ๋Š” ๋ถ„", + "preferred_points": "โ€ข ๋…ํŠนํ•˜๊ณ  ์ฐฝ์˜์ ์ธ ์•„์ด๋””์–ด๊ฐ€ ๋„˜์น˜๋Š” ๋ถ„ \nโ€ข ํŠน์ • ํฌ์ง€์…˜์— ์ข…์†๋˜์ง€ ์•Š๊ณ  ๊ฒŒ์ž„ ๊ธฐํš ์ „๋ฐ˜์˜ ๋‹ค์–‘ํ•œ ์—ญํ• ์„ ์ˆ˜ํ–‰ํ•  ์ˆ˜ ์žˆ์œผ์‹  ๋ถ„ \nโ€ข ๋ฉ”์ดํ”Œ ์Šคํ† ๋ฆฌ2์˜ ํ”Œ๋ ˆ์ด ๊ฒฝํ—˜๊ณผ ์ดํ•ด๋„๊ฐ€ ์žˆ์œผ์‹  ๋ถ„", + "benefits": "โ€ข ์ „ ์ง์žฅ๋ณด๋‹ค ์‹œ๊ฐ„์ /๊ฒฝ์ œ์ ์œผ๋กœ ๋” ๋‚˜์€ ์‚ถ ์ถ”๊ตฌ\nโ€ข ํ•˜๋ฃจ 8์‹œ๊ฐ„, ์•ผ๊ทผ์—†์ด ์ง‘์ค‘ํ•˜๋Š” ๋ฌธํ™” ์ •์ฐฉ\nโ€ข ํŽธ๋ฆฌํ•œ ์ถœํ‡ด๊ทผ (์—ญ์‚ผ์—ญ 3๋ฒˆ ์ถœ๊ตฌ ๋„๋ณด 10์ดˆ)\nโ€ข ์ž์œจ์  ์—…๋ฌดํ™˜๊ฒฝ (์œ„์›Œํฌ ์‚ฌ๋ฌด์‹ค, ๋ผ์šด์ง€/๋ถ€์Šค, ์ˆ˜ํ‰์  ์กฐ์ง, ๋งฅ์ฃผ ๋ฌดํ•œ๋Œ€)\nโ€ข ํœด๊ฐ€๋‹ค์šด ํœด๊ฐ€ (์‚ฌ์œ ๋‚˜ ์Šน์ธ์—†์ด ์Šค์Šค๋กœ ํœด๊ฐ€ ๊ณ„ํš, 3/5/7๋…„ ๋งŒ๊ทผ์‹œ 2์ฃผ ๋ฆฌํ”„๋ ˆ์‹œ ํœด๊ฐ€)\nโ€ข ๋ฐ˜๋ ค๋™๋ฌผ, ํœด๋Œ€๊ฐ€๋Šฅํ•œ ์•…๊ธฐ, ์ž์ „๊ฑฐ์™€ ๋™๋ฐ˜์ถœ๊ทผ ๊ฐ€๋Šฅ\nโ€ข ์—…๋ฌด๊ด€๋ จ ์ปจํผ๋Ÿฐ์Šค/๊ต์œก/๋„์„œ๊ตฌ๋งค๋น„ ์ง€์›\nโ€ข ์›” 1ํšŒ ํŒ€ ์‹์‚ฌ ๋ฐ ํ‹ฐํƒ€์ž„ ์ œ๊ณต\nโ€ข ์ง๋ฌด ์ˆ˜ํ–‰์— ํ•„์š”ํ•œ ์ตœ์‹ ์žฅ๋น„/์†Œํ”„ํŠธ์›จ์–ด ์ œ๊ณต\nโ€ข ์ตœ๊ณ ์˜ ์—…๋ฌด ํ™˜๊ฒฝ์ธ Wework ์—ญ์‚ผ์—ญ์  ์ž…์ฃผ์‚ฌ์ž…๋‹ˆ๋‹ค. ์•ˆ๋ฝํ•œ ํ™˜๊ฒฝ, ๊ตญ๋‚ด/์™ธ ์ง€์  ์ž์œ ๋กœ์šด ์ด์šฉ, ๋งฅ์ฃผ์™€ ์ปคํ”ผ ๋ฌดํ•œ์ œ๊ณต, ์ˆ˜์‹œ ์ด๋ฒคํŠธ ๋“ฑ์˜ ์„œ๋น„์Šค๋ฅผ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค.\n\n๊ธฐํƒ€\nโ€ข ๋ณธ ์ฑ„์šฉ์€ ์‚ฌ์—… ํ™•์žฅ์— ๋”ฐ๋ฅธ ์‹ ๊ทœ ์ฑ„์šฉ์ž…๋‹ˆ๋‹ค. \nโ€ข ์ผ์„ ๋” ์ž˜ํ•˜๊ธฐ ์œ„ํ•œ ๋ฐฉ๋ฒ• ์ค‘ ํ•˜๋‚˜๋กœ ์›” 2ํšŒ ๋ฆฌ๋ชจํŠธ ๊ทผ๋ฌด๋ฅผ ํ•˜์‹ค ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.", + "name": "ํ…Œ์ŠคํŠธ ํฌ์ง€์…˜" + }, + "url": "https://www.wanted.co.kr/wd/24090", + "company": { + "id": 79, + "name": "์›ํ‹ฐ๋“œ๋žฉ", + "description": "I think it's wanted lab", + "link": "https://", + "registration_number": "2991023012", + "company_tags": [ + { + "id": 9962, + "text": "๋งฅ์ฃผ" + } + ], + "logo_img": { + "origin": "https://...", + "thumb": "https://..." + } + }, + "address": { + "id": 5873, + "country": "ํ•œ๊ตญ", + "country_code": "kr", + "location": "์„œ์šธ", + "district": "seoul.songpa-gu", + "full_location": "์„œ์šธ์‹œ ์†กํŒŒ๊ตฌ ์˜ฌ๋ฆผํ”ฝ๋กœ 300", + "geo_location": { + "bounds": { + "northeast": { + "lat": 37.5137876, + "lng": 127.1047335 + }, + "southwest": { + "lat": 37.5130537, + "lng": 127.1034478 + } + }, + "location": { + "lat": 37.5134449, + "lng": 127.1041611 + }, + "location_type": "ROOFTOP", + "viewport": { + "northeast": { + "lat": 37.5147696302915, + "lng": 127.1054396302915 + }, + "southwest": { + "lat": 37.5120716697085, + "lng": 127.1027416697085 + } + } + } + }, + "reward": { + "total": "100๋งŒ์›", + "recommender": "50๋งŒ์›", + "recommendee": "50๋งŒ์›" + }, + "category_tags": { + "parent_tag": { + "id": 530, + "text": "์˜์—…" + }, + "child_tags": [ + { + "id": 768, + "text": "์ฃผ์š”๊ณ ๊ฐ์‚ฌ ๋‹ด๋‹น์ž" + } + ] + }, + "skill_tags": [ + { + "id": 1630, + "text": "์˜์—…" + } + ], + "images": [ + { + "origin": "https://...", + "thumb": "https://...", + "is_title": true + }, + { + "origin": "https://...", + "thumb": "https://...", + "is_title": false + } + ] + } + }, + "openapi__apis__v1__jobs__serializers__TagResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "Tag ID" + }, + "text": { + "type": "string", + "title": "Tag name" + } + }, + "type": "object", + "title": "TagResponseSerializer" + }, + "openapi__apis__v1__tags__serializers__TagResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "Id", + "description": "Tag ID" + }, + "parent_id": { + "type": "integer", + "title": "Parent Id", + "description": "Parent Tag ID" + }, + "title": { + "type": "string", + "title": "Title", + "description": "Tag name" + }, + "title_thumb_img": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "Title Thumb Img", + "description": "Tag Image URL" + } + }, + "type": "object", + "required": [ + "id", + "title" + ], + "title": "TagResponseSerializer" + } + }, + "securitySchemes": { + "ClientIdHeader": { + "type": "apiKey", + "in": "header", + "name": "wanted-client-id" + }, + "ClientSecretHeader": { + "type": "apiKey", + "in": "header", + "name": "wanted-client-secret" + }, + "PermissionsDependency": { + "type": "apiKey", + "in": "header", + "name": "Authorization" + } + } + }, + "x-samchon-emended": true +} \ No newline at end of file diff --git a/assets/output/wanted.swagger.ja.json b/assets/output/wanted.swagger.ja.json new file mode 100644 index 0000000..82ea51b --- /dev/null +++ b/assets/output/wanted.swagger.ja.json @@ -0,0 +1,3432 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "Wanted OpenAPI V1 Server", + "version": "1.0.0" + }, + "servers": [ + { + "url": "/v1" + } + ], + "paths": { + "/ai/pass/text-prediction/async": { + "post": { + "tags": [ + "AI" + ], + "summary": "[ๆœ‰ๆ–™]ใƒ†ใ‚ญใ‚นใƒˆๆ›ธ้กžๅˆๆ ผไบˆๆธฌๅฎŸ่กŒ๏ผˆ้žๅŒๆœŸ๏ผ‰", + "description": "**ใ“ใฎAPIใฏๅˆฅใ€…ใฎๅฅ‘็ด„ๅพŒใซไฝฟ็”จใ™ใ‚‹ใ“ใจใŒใงใใพใ™ใ€‚ๆ™‚ใฎๅ…ฅๅŠ›ใƒ‡ใƒผใ‚ฟใฏๆœ€ๅคง50ๅ€‹ใงใ™ใ€‚๏ผ‰**", + "operationId": "_์œ ๋ฃŒ__ํ…์ŠคํŠธ_์„œ๋ฅ˜ํ•ฉ๊ฒฉ์˜ˆ์ธก_์‹คํ–‰_๋น„๋™๊ธฐ__ai_pass_text_prediction_async_post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "title": "ๅ…ฅๅŠ›ใƒ‡ใƒผใ‚ฟ", + "description": "ๆœ€ๅคง50ๅ€‹", + "type": "object", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/ResumeJdTextPredictionItemSerializer" + }, + "type": "array", + "title": "ไบˆๆธฌ่ฆๆฑ‚ใƒ‡ใƒผใ‚ฟใƒชใ‚นใƒˆ" + }, + "callback_url": { + "type": "string", + "title": "CallbackURL", + "description": "้žๅŒๆœŸๅ‡ฆ็†ๅพŒใซ็ตๆžœใ‚’้€š็Ÿฅใ•ใ‚Œใ‚‹URL", + "example": "http://my-server.com/v1/pass/callback" + }, + "request_id": { + "type": "string", + "title": "ใƒชใ‚ฏใ‚จใ‚นใƒˆID", + "description": "ๅ‡ฆ็†็ตๆžœใŒ้€š็Ÿฅใ•ใ‚Œใ‚‹ใจใ€่ฆๆฑ‚IDใŒไธ€็ท’ใซๆธกใ•ใ‚Œใพใ™ใ€‚ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใงใฏUUIDๅฝขๅผใง่‡ชๅ‹•็”Ÿๆˆใ•ใ‚Œใพใ™ใŒใ€ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆๅดใฎใƒญใ‚ธใƒƒใ‚ฏใซใ‚ˆใฃใฆ้žๅŒๆœŸ่ฆๆฑ‚ใƒ—ใƒญใ‚ปใ‚นใ‚ˆใ‚Šใ‚‚้€š็ŸฅURLๅ‘ผใณๅ‡บใ—ใŒๆœ€ๅˆใซ่กŒใ‚ใ‚Œใ‚‹ๅ ดๅˆใฏใ€ไบ‹ๅ‰ใซrequest_idใ‚’ๆŒ‡ๅฎšใ™ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™", + "example": "55e41f9f-a5a6-4836-8490-68914ff51b64" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AsyncPredictionResponseSerializer" + } + } + } + }, + "401": { + "description": "้ž่ช่จผใƒฆใƒผใ‚ถใƒผ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ๅฟ…้ ˆใƒชใ‚ฏใ‚จใ‚นใƒˆใƒ‡ใƒผใ‚ฟใŒใ‚ใ‚Šใพใ›ใ‚“", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/ai/apply/text-prediction/async": { + "post": { + "tags": [ + "AI" + ], + "summary": "[ๆœ‰ๆ–™]ใƒ†ใ‚ญใ‚นใƒˆๆ”ฏๆดไบˆๆธฌๅฎŸ่กŒ๏ผˆ้žๅŒๆœŸ๏ผ‰", + "description": "**ใ“ใฎAPIใฏๅˆฅใ€…ใฎๅฅ‘็ด„ๅพŒใซไฝฟ็”จใ™ใ‚‹ใ“ใจใŒใงใใพใ™ใ€‚ๆ™‚ใฎๅ…ฅๅŠ›ใƒ‡ใƒผใ‚ฟใฏๆœ€ๅคง50ๅ€‹ใงใ™ใ€‚๏ผ‰**", + "operationId": "_์œ ๋ฃŒ__ํ…์ŠคํŠธ_์ง€์›์˜ˆ์ธก_์‹คํ–‰_๋น„๋™๊ธฐ__ai_apply_text_prediction_async_post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "title": "ๅ…ฅๅŠ›ใƒ‡ใƒผใ‚ฟ", + "description": "ๆœ€ๅคง50ๅ€‹", + "type": "object", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/ResumeJdTextPredictionItemSerializer" + }, + "type": "array", + "title": "ไบˆๆธฌ่ฆๆฑ‚ใƒ‡ใƒผใ‚ฟใƒชใ‚นใƒˆ" + }, + "callback_url": { + "type": "string", + "title": "CallbackURL", + "description": "้žๅŒๆœŸๅ‡ฆ็†ๅพŒใซ็ตๆžœใ‚’้€š็Ÿฅใ•ใ‚Œใ‚‹URL", + "example": "http://my-server.com/v1/apply/callback" + }, + "request_id": { + "type": "string", + "title": "ใƒชใ‚ฏใ‚จใ‚นใƒˆID", + "description": "ๅ‡ฆ็†็ตๆžœใŒ้€š็Ÿฅใ•ใ‚Œใ‚‹ใจใ€่ฆๆฑ‚IDใŒไธ€็ท’ใซๆธกใ•ใ‚Œใพใ™ใ€‚ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใงใฏUUIDๅฝขๅผใง่‡ชๅ‹•็”Ÿๆˆใ•ใ‚Œใพใ™ใŒใ€ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆๅดใฎใƒญใ‚ธใƒƒใ‚ฏใซใ‚ˆใฃใฆ้žๅŒๆœŸ่ฆๆฑ‚ใƒ—ใƒญใ‚ปใ‚นใ‚ˆใ‚Šใ‚‚้€š็ŸฅURLๅ‘ผใณๅ‡บใ—ใŒๆœ€ๅˆใซ่กŒใ‚ใ‚Œใ‚‹ๅ ดๅˆใฏใ€ไบ‹ๅ‰ใซrequest_idใ‚’ๆŒ‡ๅฎšใ™ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™", + "example": "55e41f9f-a5a6-4836-8490-68914ff51b64" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AsyncPredictionResponseSerializer" + } + } + } + }, + "401": { + "description": "้ž่ช่จผใƒฆใƒผใ‚ถใƒผ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ๅฟ…้ ˆใƒชใ‚ฏใ‚จใ‚นใƒˆใƒ‡ใƒผใ‚ฟใŒใ‚ใ‚Šใพใ›ใ‚“", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/applications": { + "get": { + "tags": [ + "Application" + ], + "summary": "ใ‚ตใƒใƒผใƒˆใƒชใ‚นใƒˆใฎ็…งไผš", + "operationId": "get_application_list_applications_get", + "parameters": [ + { + "description": "ๆคœ็ดข่ชž๏ผˆไผš็คพๅ/ใƒใ‚ธใ‚ทใƒงใƒณๅ/ๆ”ฏๆด่€…ๅ๏ผ‰", + "required": false, + "schema": { + "type": "string", + "title": "Q", + "description": "ๆคœ็ดข่ชž๏ผˆไผš็คพๅ/ใƒใ‚ธใ‚ทใƒงใƒณๅ/ๆ”ฏๆด่€…ๅ๏ผ‰" + }, + "name": "q", + "in": "query" + }, + { + "description": "ใƒใ‚ธใ‚ทใƒงใƒณID", + "required": false, + "schema": { + "type": "integer", + "title": "Job Id", + "description": "ใƒใ‚ธใ‚ทใƒงใƒณID" + }, + "name": "job_id", + "in": "query" + }, + { + "description": "็”ณ่ซ‹ๆ›ธใฎใ‚นใƒ†ใƒผใ‚ฟใ‚นcomplete๏ผˆใ‚ตใƒใƒผใƒˆๅ—ไป˜๏ผ‰ใ€pass๏ผˆๆ›ธ้กž้€š้Ž๏ผ‰ใ€reject๏ผˆไธๅˆๆ ผ๏ผ‰ใ€hire๏ผˆๆœ€็ต‚ๅˆๆ ผ๏ผ‰", + "required": false, + "schema": { + "items": { + "$ref": "#/components/schemas/ApplicationStatusSearchEnum" + }, + "type": "array", + "description": "็”ณ่ซ‹ๆ›ธใฎใ‚นใƒ†ใƒผใ‚ฟใ‚นcomplete๏ผˆใ‚ตใƒใƒผใƒˆๅ—ไป˜๏ผ‰ใ€pass๏ผˆๆ›ธ้กž้€š้Ž๏ผ‰ใ€reject๏ผˆไธๅˆๆ ผ๏ผ‰ใ€hire๏ผˆๆœ€็ต‚ๅˆๆ ผ๏ผ‰" + }, + "name": "status", + "in": "query" + }, + { + "description": "็”ณ่ซ‹ๆ›ธๆๅ‡บๆ—ฅ้–‹ๅง‹็ฏ„ๅ›ฒ๏ผˆใƒ•ใ‚ฉใƒผใƒžใƒƒใƒˆ๏ผšYYYY-MM-DD๏ผ‰", + "required": false, + "schema": { + "type": "string", + "format": "date", + "title": "Start Date", + "description": "็”ณ่ซ‹ๆ›ธๆๅ‡บๆ—ฅ้–‹ๅง‹็ฏ„ๅ›ฒ๏ผˆใƒ•ใ‚ฉใƒผใƒžใƒƒใƒˆ๏ผšYYYY-MM-DD๏ผ‰" + }, + "name": "start_date", + "in": "query" + }, + { + "description": "็”ณ่ซ‹ๆ›ธๆๅ‡บๆ—ฅใฎ็ต‚ไบ†็ฏ„ๅ›ฒ๏ผˆใƒ•ใ‚ฉใƒผใƒžใƒƒใƒˆ๏ผšYYYY-MM-DD๏ผ‰", + "required": false, + "schema": { + "type": "string", + "format": "date", + "title": "End Date", + "description": "็”ณ่ซ‹ๆ›ธๆๅ‡บๆ—ฅใฎ็ต‚ไบ†็ฏ„ๅ›ฒ๏ผˆใƒ•ใ‚ฉใƒผใƒžใƒƒใƒˆ๏ผšYYYY-MM-DD๏ผ‰" + }, + "name": "end_date", + "in": "query" + }, + { + "description": "ใ‚ญใƒฃใƒณใ‚ปใƒซใ•ใ‚ŒใŸ็”ณ่ซ‹ๆ›ธใฎ็…งไผšๆ™‚ใซTrue", + "required": false, + "schema": { + "type": "boolean", + "title": "Is Cancel", + "description": "ใ‚ญใƒฃใƒณใ‚ปใƒซใ•ใ‚ŒใŸ็”ณ่ซ‹ๆ›ธใฎ็…งไผšๆ™‚ใซTrue", + "default": false + }, + "name": "is_cancel", + "in": "query" + }, + { + "required": false, + "schema": { + "type": "integer", + "title": "ใ‚ชใƒ•ใ‚ปใƒƒใƒˆ", + "default": 0 + }, + "name": "offset", + "in": "query" + }, + { + "required": false, + "schema": { + "type": "integer", + "title": "Limit", + "default": 20 + }, + "name": "limit", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationListResponseSerializer" + } + } + } + }, + "401": { + "description": "้ž่ช่จผใƒฆใƒผใ‚ถใƒผ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ๅฟ…้ ˆใƒชใ‚ฏใ‚จใ‚นใƒˆใƒ‡ใƒผใ‚ฟใŒใ‚ใ‚Šใพใ›ใ‚“", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + }, + { + "PermissionsDependency": [] + } + ] + }, + "post": { + "tags": [ + "Application" + ], + "summary": "ใƒใ‚ธใ‚ทใƒงใƒณใ‚ตใƒใƒผใƒˆ", + "operationId": "apply_for_job_applications_post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplyJobRequestSerializer" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationResponseSerializer" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "examples": { + "AlreadyAppliedJob": { + "value": { + "error_code": "AlreadyAppliedJob", + "message": "์ด๋ฏธ ์ง€์›ํ•œ ํฌ์ง€์…˜์ž…๋‹ˆ๋‹ค." + } + }, + "JobNotExists": { + "value": { + "error_code": "JobNotExists", + "message": "์กด์žฌํ•˜์ง€ ์•Š๋Š” ํฌ์ง€์…˜์ž…๋‹ˆ๋‹ค." + } + }, + "FileNotFound": { + "value": { + "error_code": "FileNotFound", + "message": "์กด์žฌํ•˜์ง€ ์•Š๋Š” ํŒŒ์ผ์ž…๋‹ˆ๋‹ค." + } + }, + "DuplicateFile": { + "value": { + "error_code": "DuplicateFile", + "message": "์ค‘๋ณต๋œ ํŒŒ์ผ๋กœ ์ง€์›ํ•  ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค." + } + } + } + } + } + }, + "401": { + "description": "้ž่ช่จผใƒฆใƒผใ‚ถใƒผ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ๅฟ…้ ˆใƒชใ‚ฏใ‚จใ‚นใƒˆใƒ‡ใƒผใ‚ฟใŒใ‚ใ‚Šใพใ›ใ‚“", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/applications/{application_id}/cancel": { + "patch": { + "tags": [ + "Application" + ], + "summary": "ใ‚ตใƒใƒผใƒˆใ‚’ใ‚ญใƒฃใƒณใ‚ปใƒซ", + "operationId": "cancel_application_applications__application_id__cancel_patch", + "parameters": [ + { + "required": true, + "schema": { + "type": "integer", + "title": "ใ‚ขใƒ—ใƒชใ‚ฑใƒผใ‚ทใƒงใƒณID" + }, + "name": "application_id", + "in": "path" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CancelApplicationRequestSerializer" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "examples": { + "ApplicationNotFound": { + "value": { + "error_code": "ApplicationNotFound", + "message": "์กด์žฌํ•˜์ง€ ์•Š๋Š” ์ง€์›์„œ์ž…๋‹ˆ๋‹ค." + } + } + } + } + } + }, + "401": { + "description": "้ž่ช่จผใƒฆใƒผใ‚ถใƒผ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ๅฟ…้ ˆใƒชใ‚ฏใ‚จใ‚นใƒˆใƒ‡ใƒผใ‚ฟใŒใ‚ใ‚Šใพใ›ใ‚“", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/companies/{company_id}": { + "get": { + "tags": [ + "Company" + ], + "summary": "ไผๆฅญ่ฉณ็ดฐ็…งไผš", + "operationId": "get_company_companies__company_id__get", + "parameters": [ + { + "required": true, + "schema": { + "type": "integer", + "title": "Company Id" + }, + "name": "company_id", + "in": "path" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompanyResponseSerializer" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "examples": { + "JobNotExists": { + "value": { + "error_code": "JobNotExists", + "message": "์กด์žฌํ•˜์ง€ ์•Š๋Š” ํฌ์ง€์…˜์ž…๋‹ˆ๋‹ค." + } + } + } + } + } + }, + "401": { + "description": "้ž่ช่จผใƒฆใƒผใ‚ถใƒผ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ๅฟ…้ ˆใƒชใ‚ฏใ‚จใ‚นใƒˆใƒ‡ใƒผใ‚ฟใŒใ‚ใ‚Šใพใ›ใ‚“", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/companies/{company_id}/jobs": { + "get": { + "tags": [ + "Company" + ], + "summary": "ไผๆฅญใฎๆŽก็”จไธญใฎใƒใ‚ธใ‚ทใƒงใƒณใฎใƒชใ‚นใƒˆใ‚’่ฆ‹ใ‚‹", + "operationId": "get_company_job_list_companies__company_id__jobs_get", + "parameters": [ + { + "required": true, + "schema": { + "type": "integer", + "title": "Company Id" + }, + "name": "company_id", + "in": "path" + }, + { + "required": false, + "schema": { + "type": "integer", + "title": "ใ‚ชใƒ•ใ‚ปใƒƒใƒˆ", + "default": 0 + }, + "name": "offset", + "in": "query" + }, + { + "required": false, + "schema": { + "type": "integer", + "title": "Limit", + "default": 12 + }, + "name": "limit", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompanyJobListResponseSerializer" + } + } + } + }, + "401": { + "description": "้ž่ช่จผใƒฆใƒผใ‚ถใƒผ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ๅฟ…้ ˆใƒชใ‚ฏใ‚จใ‚นใƒˆใƒ‡ใƒผใ‚ฟใŒใ‚ใ‚Šใพใ›ใ‚“", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/jobs": { + "get": { + "tags": [ + "Job" + ], + "summary": "๏ผˆๆŽข็ดข๏ผ‰ใƒใ‚ธใ‚ทใƒงใƒณใƒชใ‚นใƒˆ็…งไผš", + "operationId": "get_job_list_jobs_get", + "parameters": [ + { + "description": "่ท่ป/่ทๅ‹™ใ‚ฟใ‚ฐID๏ผˆๆœ€ๅคง5ๅ€‹๏ผ‰", + "required": false, + "schema": { + "items": { + "type": "integer" + }, + "type": "array", + "maxItems": 5, + "minItems": 0, + "title": "Category Tags", + "description": "่ท่ป/่ทๅ‹™ใ‚ฟใ‚ฐID๏ผˆๆœ€ๅคง5ๅ€‹๏ผ‰" + }, + "name": "category_tags", + "in": "query" + }, + { + "description": "ใ‚นใ‚ญใƒซใ‚ฟใ‚ฐID๏ผˆๆœ€ๅคง5ๅ€‹๏ผ‰", + "required": false, + "schema": { + "items": { + "type": "integer" + }, + "type": "array", + "maxItems": 5, + "minItems": 0, + "title": "Skill Tags", + "description": "ใ‚นใ‚ญใƒซใ‚ฟใ‚ฐID๏ผˆๆœ€ๅคง5ๅ€‹๏ผ‰" + }, + "name": "skill_tags", + "in": "query" + }, + { + "description": "ใ‚ญใƒฃใƒชใ‚ขใ€‚ 10ๅ…ฅๅŠ›ๆ™‚ๅนดๆฌก10ๅนดไปฅไธŠใฎใƒใ‚ธใ‚ทใƒงใƒณ้œฒๅ‡บ", + "required": false, + "schema": { + "items": { + "type": "integer", + "maximum": 10, + "minimum": 0 + }, + "type": "array", + "maximum": 10, + "minimum": 0, + "maxItems": 2, + "title": "Years", + "description": "ใ‚ญใƒฃใƒชใ‚ขใ€‚ 10ๅ…ฅๅŠ›ๆ™‚ๅนดๆฌก10ๅนดไปฅไธŠใฎใƒใ‚ธใ‚ทใƒงใƒณ้œฒๅ‡บ" + }, + "name": "years", + "in": "query" + }, + { + "description": "ๅœฐๅŸŸใ€‚ๅ›ฝ", + "required": false, + "schema": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Locations", + "description": "ๅœฐๅŸŸใ€‚ๅ›ฝ" + }, + "name": "locations", + "in": "query" + }, + { + "description": "ใ‚ฝใƒผใƒˆ", + "required": false, + "schema": { + "description": "ใ‚ฝใƒผใƒˆ" + }, + "name": "sort", + "in": "query" + }, + { + "required": false, + "schema": { + "type": "integer", + "title": "ใ‚ชใƒ•ใ‚ปใƒƒใƒˆ", + "default": 0 + }, + "name": "offset", + "in": "query" + }, + { + "required": false, + "schema": { + "type": "integer", + "title": "Limit", + "default": 20 + }, + "name": "limit", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JobListResponseSerializer" + } + } + } + }, + "401": { + "description": "้ž่ช่จผใƒฆใƒผใ‚ถใƒผ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ๅฟ…้ ˆใƒชใ‚ฏใ‚จใ‚นใƒˆใƒ‡ใƒผใ‚ฟใŒใ‚ใ‚Šใพใ›ใ‚“", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/jobs/{job_id}": { + "get": { + "tags": [ + "Job" + ], + "summary": "ใƒใ‚ธใ‚ทใƒงใƒณ่ฉณ็ดฐๆคœ็ดข", + "operationId": "get_job_jobs__job_id__get", + "parameters": [ + { + "required": true, + "schema": { + "type": "integer", + "title": "ใƒใ‚ธใ‚ทใƒงใƒณID" + }, + "name": "job_id", + "in": "path" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/openapi__apis__v1__jobs__serializers__JobResponseSerializer" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "examples": { + "JobNotExists": { + "value": { + "error_code": "JobNotExists", + "message": "์กด์žฌํ•˜์ง€ ์•Š๋Š” ํฌ์ง€์…˜์ž…๋‹ˆ๋‹ค." + } + } + } + } + } + }, + "401": { + "description": "้ž่ช่จผใƒฆใƒผใ‚ถใƒผ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ๅฟ…้ ˆใƒชใ‚ฏใ‚จใ‚นใƒˆใƒ‡ใƒผใ‚ฟใŒใ‚ใ‚Šใพใ›ใ‚“", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/tags/categories": { + "get": { + "tags": [ + "Tag" + ], + "summary": "่ทๅ‹™/่ทๅ‹™ใƒชใ‚นใƒˆใฎ็…งไผš", + "operationId": "get_categories_tags_categories_get", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagListResponseSerializer" + } + } + } + }, + "401": { + "description": "้ž่ช่จผใƒฆใƒผใ‚ถใƒผ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ๅฟ…้ ˆใƒชใ‚ฏใ‚จใ‚นใƒˆใƒ‡ใƒผใ‚ฟใŒใ‚ใ‚Šใพใ›ใ‚“", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/tags/skills": { + "get": { + "tags": [ + "Tag" + ], + "summary": "ใ‚นใ‚ญใƒซใƒชใ‚นใƒˆใฎ็…งไผš", + "operationId": "get_skills_tags_skills_get", + "parameters": [ + { + "required": true, + "schema": { + "type": "string", + "title": "ใ‚ญใƒผใƒฏใƒผใƒ‰" + }, + "name": "keyword", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SkillListResponseSerializer" + } + } + } + }, + "401": { + "description": "้ž่ช่จผใƒฆใƒผใ‚ถใƒผ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ๅฟ…้ ˆใƒชใ‚ฏใ‚จใ‚นใƒˆใƒ‡ใƒผใ‚ฟใŒใ‚ใ‚Šใพใ›ใ‚“", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/search/company/autocomplate": { + "get": { + "tags": [ + "Search" + ], + "summary": "Authcomplate", + "operationId": "authcomplate_search_company_autocomplate_get", + "parameters": [ + { + "description": "ๆคœ็ดขใ™ใ‚‹ไผš็คพๅ", + "required": false, + "schema": { + "type": "string", + "title": "Query", + "description": "ๆคœ็ดขใ™ใ‚‹ไผš็คพๅ" + }, + "name": "query", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompanyAutoCompleteResponseSerializer" + } + } + } + }, + "401": { + "description": "้ž่ช่จผใƒฆใƒผใ‚ถใƒผ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ๅฟ…้ ˆใƒชใ‚ฏใ‚จใ‚นใƒˆใƒ‡ใƒผใ‚ฟใŒใ‚ใ‚Šใพใ›ใ‚“", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/search/company": { + "get": { + "tags": [ + "Search" + ], + "summary": "ๆคœ็ดขไผš็คพ", + "operationId": "search_companies_search_company_get", + "parameters": [ + { + "description": "ๆคœ็ดขใ™ใ‚‹ไผš็คพๅใ€ใพใŸใฏไบ‹ๆฅญ่€…็•ชๅท", + "required": true, + "schema": { + "type": "string", + "title": "Query", + "description": "ๆคœ็ดขใ™ใ‚‹ไผš็คพๅใ€ใพใŸใฏไบ‹ๆฅญ่€…็•ชๅท" + }, + "name": "query", + "in": "query" + }, + { + "required": false, + "schema": { + "type": "integer", + "title": "ใ‚ชใƒ•ใ‚ปใƒƒใƒˆ", + "default": 0 + }, + "name": "offset", + "in": "query" + }, + { + "required": false, + "schema": { + "type": "integer", + "title": "Limit", + "default": 20 + }, + "name": "limit", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchCompanyResponseSerializer" + } + } + } + }, + "401": { + "description": "้ž่ช่จผใƒฆใƒผใ‚ถใƒผ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ๅฟ…้ ˆใƒชใ‚ฏใ‚จใ‚นใƒˆใƒ‡ใƒผใ‚ฟใŒใ‚ใ‚Šใพใ›ใ‚“", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/files": { + "get": { + "tags": [ + "File" + ], + "summary": "ๆทปไป˜ใƒ•ใ‚กใ‚คใƒซใƒชใ‚นใƒˆใฎ็…งไผš", + "operationId": "get_file_list_files_get", + "parameters": [ + { + "required": false, + "schema": { + "type": "integer", + "title": "ใ‚ชใƒ•ใ‚ปใƒƒใƒˆ", + "default": 0 + }, + "name": "offset", + "in": "query" + }, + { + "required": false, + "schema": { + "type": "integer", + "title": "Limit", + "default": 20 + }, + "name": "limit", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetFileListResponseSerializer" + } + } + } + }, + "401": { + "description": "้ž่ช่จผใƒฆใƒผใ‚ถใƒผ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ๅฟ…้ ˆใƒชใ‚ฏใ‚จใ‚นใƒˆใƒ‡ใƒผใ‚ฟใŒใ‚ใ‚Šใพใ›ใ‚“", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + }, + { + "PermissionsDependency": [] + } + ] + }, + "post": { + "tags": [ + "File" + ], + "summary": "็”ณ่ซ‹ๆ›ธๆทปไป˜ใƒ•ใ‚กใ‚คใƒซใฎใ‚ขใƒƒใƒ—ใƒญใƒผใƒ‰", + "description": "**ใƒ•ใ‚กใ‚คใƒซใฎใ‚ขใƒƒใƒ—ใƒญใƒผใƒ‰ๆ–นๆณ•** 1. `POST /v1/files/upload-url`ใƒชใ‚ฏใ‚จใ‚นใƒˆ2. 1ๅ›žใฎๅฟœ็ญ” `presigned_url`ใ‚’ไป‹ใ—ใŸไธ€ๆ™‚ใƒ•ใ‚กใ‚คใƒซใฎใ‚ขใƒƒใƒ—ใƒญใƒผใƒ‰`presigned_url`ใฏ60ๅˆ†้–“ๆœ‰ๅŠนใงใ™ใ€‚ `presigned_url`ใฏPUTใƒกใ‚ฝใƒƒใƒ‰ใ€Content-Typeใƒ˜ใƒƒใƒ€ใƒผใ‚’ 'application/binary'ใจใ—ใฆ่ฆๆฑ‚ใ—ใพใ™ใ€‚", + "operationId": "upload_file_files_post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UploadFileRequestSerializer" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UploadFileResponseSerializer" + } + } + } + }, + "401": { + "description": "้ž่ช่จผใƒฆใƒผใ‚ถใƒผ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ๅฟ…้ ˆใƒชใ‚ฏใ‚จใ‚นใƒˆใƒ‡ใƒผใ‚ฟใŒใ‚ใ‚Šใพใ›ใ‚“", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/files/{file_key}/download": { + "get": { + "tags": [ + "File" + ], + "summary": "ๆทปไป˜ใƒ•ใ‚กใ‚คใƒซใฎใƒ€ใ‚ฆใƒณใƒญใƒผใƒ‰", + "operationId": "get_download_url_files__file_key__download_get", + "parameters": [ + { + "required": true, + "schema": { + "type": "string", + "title": "File Key" + }, + "name": "file_key", + "in": "path" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetDownloadUrlResponseSerializer" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "examples": { + "FileNotFound": { + "value": { + "error_code": "FileNotFound", + "message": "์กด์žฌํ•˜์ง€ ์•Š๋Š” ํŒŒ์ผ์ž…๋‹ˆ๋‹ค." + } + } + } + } + } + }, + "401": { + "description": "้ž่ช่จผใƒฆใƒผใ‚ถใƒผ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ๅฟ…้ ˆใƒชใ‚ฏใ‚จใ‚นใƒˆใƒ‡ใƒผใ‚ฟใŒใ‚ใ‚Šใพใ›ใ‚“", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/files/upload-url": { + "post": { + "tags": [ + "File" + ], + "summary": "ๆทปไป˜ใƒ•ใ‚กใ‚คใƒซใ‚’ใ‚ขใƒƒใƒ—ใƒญใƒผใƒ‰ใ™ใ‚‹ใŸใ‚ใฎpresigned urlใ‚’ไฝœๆˆใ™ใ‚‹", + "operationId": "generate_presigned_url_files_upload_url_post", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreatePresignedURLResponseSerializer" + } + } + } + }, + "401": { + "description": "้ž่ช่จผใƒฆใƒผใ‚ถใƒผ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ๅฟ…้ ˆใƒชใ‚ฏใ‚จใ‚นใƒˆใƒ‡ใƒผใ‚ฟใŒใ‚ใ‚Šใพใ›ใ‚“", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + }, + { + "PermissionsDependency": [] + } + ] + } + }, + "/stat/application/summary": { + "get": { + "tags": [ + "Stat" + ], + "summary": "(ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆๅˆฅ) ใ‚ตใƒใƒผใƒˆ็Šถๆณ summary ็…งไผš", + "operationId": "get_application_summary_by_client_stat_application_summary_get", + "parameters": [ + { + "description": "็”ณ่ซ‹ๆ›ธๆๅ‡บๆ—ฅ้–‹ๅง‹็ฏ„ๅ›ฒ๏ผˆใƒ•ใ‚ฉใƒผใƒžใƒƒใƒˆ๏ผšYYYY-MM-DD๏ผ‰", + "required": false, + "schema": { + "type": "string", + "format": "date", + "title": "Start Date", + "description": "็”ณ่ซ‹ๆ›ธๆๅ‡บๆ—ฅ้–‹ๅง‹็ฏ„ๅ›ฒ๏ผˆใƒ•ใ‚ฉใƒผใƒžใƒƒใƒˆ๏ผšYYYY-MM-DD๏ผ‰", + "default": "2023-11-24" + }, + "name": "start_date", + "in": "query" + }, + { + "description": "็”ณ่ซ‹ๆ›ธๆๅ‡บๆ—ฅใฎ็ต‚ไบ†็ฏ„ๅ›ฒ๏ผˆใƒ•ใ‚ฉใƒผใƒžใƒƒใƒˆ๏ผšYYYY-MM-DD๏ผ‰", + "required": false, + "schema": { + "type": "string", + "format": "date", + "title": "End Date", + "description": "็”ณ่ซ‹ๆ›ธๆๅ‡บๆ—ฅใฎ็ต‚ไบ†็ฏ„ๅ›ฒ๏ผˆใƒ•ใ‚ฉใƒผใƒžใƒƒใƒˆ๏ผšYYYY-MM-DD๏ผ‰", + "default": "2024-02-22" + }, + "name": "end_date", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationSummaryResponseSerializer" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "examples": { + "InvalidDateRange": { + "value": { + "error_code": "InvalidDateRange", + "message": "์‹œ์ž‘ ๋‚ ์งœ์™€ ์ข…๋ฃŒ ๋‚ ์งœ์˜ ์ฐจ์ด๋Š” 90์ผ์„ ๋„˜์„ ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค." + } + } + } + } + } + }, + "401": { + "description": "้ž่ช่จผใƒฆใƒผใ‚ถใƒผ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + }, + "422": { + "description": "ๅฟ…้ ˆใƒชใ‚ฏใ‚จใ‚นใƒˆใƒ‡ใƒผใ‚ฟใŒใ‚ใ‚Šใพใ›ใ‚“", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenAPIExceptionResponse" + } + } + } + } + }, + "security": [ + { + "ClientIdHeader": [] + }, + { + "ClientSecretHeader": [] + }, + { + "PermissionsDependency": [] + } + ] + } + } + }, + "components": { + "schemas": { + "AddressResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "Id" + }, + "country": { + "type": "string", + "title": "ๅ›ฝ" + }, + "country_code": { + "type": "string", + "title": "ๅ›ฝใ‚ณใƒผใƒ‰" + }, + "location": { + "type": "string", + "title": "Location" + }, + "full_location": { + "type": "string", + "title": "ๅฎŒๅ…จใชไฝๆ‰€" + }, + "geo_location": { + "type": "object", + "title": "Geo Location" + } + }, + "type": "object", + "title": "AddressResponseSerializer" + }, + "ApplicationListResponseSerializer": { + "properties": { + "links": { + "$ref": "#/components/schemas/LinksSchema" + }, + "applications": { + "items": { + "$ref": "#/components/schemas/ApplicationResponseSerializer" + }, + "type": "array", + "title": "ใ‚ขใƒ—ใƒชใ‚ฑใƒผใ‚ทใƒงใƒณ" + } + }, + "type": "object", + "title": "ApplicationListResponseSerializer" + }, + "ApplicationResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "Id", + "description": "็”ณ่ซ‹ID" + }, + "oneid": { + "type": "string", + "title": "Oneid", + "description": "็”ณ่ซ‹่€…ID" + }, + "username": { + "type": "string", + "title": "Username", + "description": "ๅฟœๅ‹Ÿ่€…ๅ" + }, + "email": { + "type": "string", + "title": "Email", + "description": "ๅฟœๅ‹Ÿ่€…ใƒกใƒผใƒซ" + }, + "mobile": { + "type": "string", + "title": "Mobile", + "description": "ใƒ•ใ‚ฉใƒผใƒžใƒƒใƒˆใ•ใ‚ŒใŸ้›ป่ฉฑ็•ชๅท๏ผˆeg +821086388688๏ผ‰" + }, + "application_status": { + "description": "็”ณ่ซ‹็Šถๆณ" + }, + "apply_time": { + "type": "string", + "format": "date-time", + "title": "้ฉ็”จๆ™‚้–“", + "description": "็”ณ่ซ‹ๆ›ธๆๅ‡บๆ™‚้–“" + }, + "edited_time": { + "type": "string", + "format": "date-time", + "title": "Edited Time", + "description": "็”ณ่ซ‹ๆ›ธใฎไฟฎๆญฃๆ™‚้–“" + }, + "open_time": { + "type": "string", + "format": "date-time", + "title": "ใ‚ชใƒผใƒ—ใƒณใ‚ฟใ‚คใƒ ", + "description": "็”ณ่พผๆ›ธๅˆ้–ฒ่ฆงๆ™‚้–“" + }, + "cancel_time": { + "type": "string", + "format": "date-time", + "title": "Cancel Time", + "description": "ใ‚ตใƒใƒผใƒˆใ‚ญใƒฃใƒณใ‚ปใƒซๆ™‚้–“" + }, + "cancel_reason": { + "type": "string", + "title": "Cancel Reason", + "description": "ใ‚ตใƒใƒผใƒˆใ‚ญใƒฃใƒณใ‚ปใƒซ็†็”ฑ" + }, + "company_id": { + "type": "integer", + "title": "Company Id" + }, + "company_name": { + "type": "string", + "title": "ไผš็คพๅ", + "description": "ไผš็คพๅ" + }, + "job_id": { + "type": "integer", + "title": "Job Id", + "description": "ใƒใ‚ธใ‚ทใƒงใƒณID" + }, + "job_name": { + "type": "string", + "title": "ใ‚ธใƒงใƒ–ๅ", + "description": "ๆ”ฏๆดๆ™‚็‚นใฎใƒใ‚ธใ‚ทใƒงใƒณๅ" + }, + "job_detail": { + "title": "ใ‚ธใƒงใƒ–่ฉณ็ดฐ", + "description": "ใƒใ‚ธใ‚ทใƒงใƒณ่ฉณ็ดฐ", + "type": "object", + "properties": { + "id": { + "type": "integer", + "title": "Id" + }, + "status": { + "$ref": "#/components/schemas/JobStatusEnum" + }, + "company_id": { + "type": "integer", + "title": "Company Id" + }, + "due_time": { + "type": "string", + "format": "date", + "title": "Due Time", + "description": "็ท ใ‚ๅˆ‡ใ‚Š" + }, + "logo_url": { + "$ref": "#/components/schemas/ImageUrlResponseSerializer" + } + } + }, + "resumes": { + "items": { + "$ref": "#/components/schemas/FilesResponseSerializer" + }, + "type": "array", + "title": "Resumes", + "description": "ๆทปไป˜ใƒ•ใ‚กใ‚คใƒซไธ€่ฆง" + } + }, + "type": "object", + "required": [ + "id", + "oneid", + "username", + "email", + "mobile", + "application_status", + "apply_time", + "company_id", + "job_id" + ], + "title": "ApplicationResponseSerializer", + "example": { + "id": 688129, + "oneid": "QrKSEkh74AFf", + "username": "์ง€์›์ž๋ช…", + "email": "user@test.com", + "mobile": "+821023456789", + "application_status": "complte", + "apply_time": "2023-03-15T02:09:27.883418", + "company_id": 1422, + "company_name": "์›ํ‹ฐ๋“œ๋žฉ", + "job_id": 23920, + "job_name": "ํฌ์ง€์…˜๋ช…", + "job_detail": { + "id": 23920, + "status": "active", + "company_id": 1, + "logo_url": { + "origin": "https://...", + "thumb": "https://..." + } + }, + "files": [ + { + "key": "qwefew-qweifj-1234", + "title": "ๅฑฅๆญดๆ›ธ.pdf", + "update_time": "2023-03-15T02:09:27.883418" + } + ] + } + }, + "ApplicationStatusSearchEnum": { + "oneOf": [ + { + "const": "complete", + "title": "ApplicationStatusSearchEnum", + "description": "An enumeration." + }, + { + "const": "pass", + "title": "ApplicationStatusSearchEnum", + "description": "An enumeration." + }, + { + "const": "reject", + "title": "ApplicationStatusSearchEnum", + "description": "An enumeration." + }, + { + "const": "hire", + "title": "ApplicationStatusSearchEnum", + "description": "An enumeration." + } + ], + "title": "ApplicationStatusSearchEnum", + "description": "An enumeration." + }, + "ApplicationSummaryResponseSerializer": { + "properties": { + "complete": { + "type": "integer", + "title": "Complete", + "default": 0 + }, + "document_pass": { + "type": "integer", + "title": "Document Pass", + "default": 0 + }, + "hire": { + "type": "integer", + "title": "Hire", + "default": 0 + }, + "reject": { + "type": "integer", + "title": "ๆ‹’ๅฆ", + "default": 0 + }, + "total": { + "type": "integer", + "title": "Total", + "default": 0 + } + }, + "type": "object", + "title": "ApplicationSummaryResponseSerializer", + "example": { + "complete": 1, + "document_pass": 1, + "hire": 0, + "reject": 1, + "total": 3 + } + }, + "ApplyJobRequestSerializer": { + "properties": { + "job_id": { + "type": "integer", + "title": "Job Id" + }, + "username": { + "type": "string", + "title": "Username" + }, + "email": { + "type": "string", + "title": "Email" + }, + "mobile": { + "type": "string", + "title": "Mobile" + }, + "resume_keys": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Resume Keys", + "description": "ใ‚ตใƒใƒผใƒˆๆ™‚ใซๆทปไป˜ใ™ใ‚‹ใƒ•ใ‚กใ‚คใƒซใฎใƒชใ‚นใƒˆ" + } + }, + "type": "object", + "required": [ + "job_id", + "username", + "email", + "mobile", + "resume_keys" + ], + "title": "ApplyJobRequestSerializer" + }, + "ApplyTextPredictionRequestSerializer": { + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/ResumeJdTextPredictionItemSerializer" + }, + "type": "array", + "title": "ไบˆๆธฌ่ฆๆฑ‚ใƒ‡ใƒผใ‚ฟใƒชใ‚นใƒˆ" + }, + "callback_url": { + "type": "string", + "title": "CallbackURL", + "description": "้žๅŒๆœŸๅ‡ฆ็†ๅพŒใซ็ตๆžœใ‚’้€š็Ÿฅใ•ใ‚Œใ‚‹URL", + "example": "http://my-server.com/v1/apply/callback" + }, + "request_id": { + "type": "string", + "title": "ใƒชใ‚ฏใ‚จใ‚นใƒˆID", + "description": "ๅ‡ฆ็†็ตๆžœใŒ้€š็Ÿฅใ•ใ‚Œใ‚‹ใจใ€่ฆๆฑ‚IDใŒไธ€็ท’ใซๆธกใ•ใ‚Œใพใ™ใ€‚ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใงใฏUUIDๅฝขๅผใง่‡ชๅ‹•็”Ÿๆˆใ•ใ‚Œใพใ™ใŒใ€ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆๅดใฎใƒญใ‚ธใƒƒใ‚ฏใซใ‚ˆใฃใฆ้žๅŒๆœŸ่ฆๆฑ‚ใƒ—ใƒญใ‚ปใ‚นใ‚ˆใ‚Šใ‚‚้€š็ŸฅURLๅ‘ผใณๅ‡บใ—ใŒๆœ€ๅˆใซ่กŒใ‚ใ‚Œใ‚‹ๅ ดๅˆใฏใ€ไบ‹ๅ‰ใซrequest_idใ‚’ๆŒ‡ๅฎšใ™ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™", + "example": "55e41f9f-a5a6-4836-8490-68914ff51b64" + } + }, + "type": "object", + "required": [ + "data", + "callback_url" + ], + "title": "ApplyTextPredictionRequestSerializer" + }, + "AsyncPredictionResponseSerializer": { + "properties": { + "request_id": { + "type": "string", + "title": "ใƒชใ‚ฏใ‚จใ‚นใƒˆID", + "description": "CallbackURLใ‚’ๅ‘ผใณๅ‡บใ™ใจใใซใฉใฎใƒชใ‚ฏใ‚จใ‚นใƒˆใŒ็ตๆžœใงใ‚ใ‚‹ใ‹ใ‚’ๅŒบๅˆฅใ™ใ‚‹ใŸใ‚ใซใƒชใ‚ฏใ‚จใ‚นใƒˆIDใ‚’ไธ€็ท’ใซๆธกใ—ใพใ™", + "example": "55e41f9f-a5a6-4836-8490-68914ff51b64" + } + }, + "type": "object", + "required": [ + "request_id" + ], + "title": "AsyncPredictionResponseSerializer" + }, + "CancelApplicationRequestSerializer": { + "properties": { + "cancel_reason": { + "type": "string", + "title": "Cancel Reason" + } + }, + "type": "object", + "title": "CancelApplicationRequestSerializer" + }, + "CategoryTagResponseSerializer": { + "properties": { + "parent_tag": { + "title": "็›ด่ป", + "type": "object", + "properties": { + "id": { + "type": "integer", + "title": "ใ‚ฟใ‚ฐID" + }, + "text": { + "type": "string", + "title": "ใ‚ฟใ‚ฐๅ" + } + } + }, + "child_tags": { + "items": { + "$ref": "#/components/schemas/openapi__apis__v1__jobs__serializers__TagResponseSerializer" + }, + "type": "array", + "title": "่ทๅ‹™" + } + }, + "type": "object", + "title": "CategoryTagResponseSerializer" + }, + "CompanyAutoCompleteResponseSerializer": { + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/_CompanyAutoCompleteSerializer" + }, + "type": "array", + "title": "ใƒ‡ใƒผใ‚ฟ" + } + }, + "type": "object", + "title": "CompanyAutoCompleteResponseSerializer", + "example": { + "data": [ + { + "company_id": 518, + "name": "์›ํ‹ฐ๋“œ๋žฉ", + "logo_image": "https://image.jpg" + } + ] + } + }, + "CompanyDetailResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "ไผๆฅญID" + }, + "company_confirm": { + "type": "boolean", + "title": "ไผๆฅญๆ‰ฟ่ชๅฏๅฆ", + "description": "True๏ผšๆ‰ฟ่ชๅฎŒไบ†ใ€False๏ผšๆ‰ฟ่ชๆ‹’ๅฆใ€ๆ‰ฟ่ช่ฆๆฑ‚ไธญใ€ๆ‰ฟ่ช่ฆๆฑ‚ใชใ—" + }, + "registration_number": { + "type": "string", + "title": "ไบ‹ๆฅญ่€…็•ชๅท" + }, + "name": { + "type": "string", + "title": "ไผš็คพๅ" + }, + "logo_url": { + "$ref": "#/components/schemas/ImageUrlSchema" + }, + "images": { + "items": { + "type": "object" + }, + "type": "array", + "title": "ไผš็คพใ‚คใƒกใƒผใ‚ธ" + }, + "description": { + "type": "string", + "title": "ไผš็คพ็ดนไป‹" + }, + "link": { + "type": "string", + "title": "ไผๆฅญใƒšใƒผใ‚ธใƒชใƒณใ‚ฏ" + }, + "url": { + "type": "string", + "title": "ไผš็คพ่ฉณ็ดฐใƒšใƒผใ‚ธ url" + } + }, + "type": "object", + "required": [ + "id", + "company_confirm", + "name", + "url" + ], + "title": "CompanyDetailResponseSerializer" + }, + "CompanyJobListResponseSerializer": { + "properties": { + "links": { + "$ref": "#/components/schemas/LinksSchema" + }, + "jobs": { + "items": { + "$ref": "#/components/schemas/openapi__apis__v1__companies__serializers__JobResponseSerializer" + }, + "type": "array", + "title": "Jobs" + } + }, + "type": "object", + "title": "CompanyJobListResponseSerializer", + "example": { + "links": { + "next": "/v1/companies/79/jobs?offset=12&limit=12" + }, + "jobs": [ + { + "id": 23617, + "name": "VR ์—”์ง€๋‹ˆ์–ด", + "reward": { + "country": "KR", + "total": "100๋งŒ์›", + "recommender": "50๋งŒ์›", + "recommendee": "50๋งŒ์›" + }, + "url": "https://www.wanted.co.kr/wd/10002" + }, + { + "id": 23652, + "name": "QA", + "due_time": "2023-03-21" + } + ] + } + }, + "CompanyResponseSerializer": { + "properties": { + "company": { + "$ref": "#/components/schemas/CompanyDetailResponseSerializer" + } + }, + "type": "object", + "title": "CompanyResponseSerializer", + "example": { + "company": { + "id": 79, + "company_confirm": true, + "registration_number": "12622032023", + "name": "์›ํ‹ฐ๋“œ๋žฉ", + "logo_url": { + "origin": "https://...", + "thumb": "https://..." + }, + "images": [ + { + "id": 1894, + "is_title": true, + "origin": "https://...", + "thumb": "https://..." + }, + { + "id": 1889, + "is_title": false, + "origin": "https://...", + "thumb": "https://..." + } + ], + "description": "ใƒฏใƒณใƒ†ใ‚ฃใƒ‰ใƒฉใƒƒใƒ—ไผš็คพ็ดนไป‹", + "link": "http://wanted.co.kr/", + "url": "https://www.wanted.co.kr/company/79?client_id=xxxx" + } + } + }, + "CompanyTagResponseSerializer": { + "properties": { + "tag_type_id": { + "type": "integer", + "title": "ใ‚ฟใ‚ฐID" + }, + "text": { + "type": "string", + "title": "ใ‚ฟใ‚ฐๅ" + } + }, + "type": "object", + "title": "CompanyTagResponseSerializer" + }, + "CountryEnum": { + "oneOf": [ + { + "const": "KR", + "title": "CountryEnum", + "description": "An enumeration." + }, + { + "const": "JP", + "title": "CountryEnum", + "description": "An enumeration." + }, + { + "const": "TW", + "title": "CountryEnum", + "description": "An enumeration." + }, + { + "const": "HK", + "title": "CountryEnum", + "description": "An enumeration." + }, + { + "const": "SG", + "title": "CountryEnum", + "description": "An enumeration." + }, + { + "const": "WW", + "title": "CountryEnum", + "description": "An enumeration." + } + ], + "title": "CountryEnum", + "description": "An enumeration." + }, + "CreatePresignedURLResponseSerializer": { + "properties": { + "presigned_url": { + "type": "string", + "title": "Presigned Url" + }, + "upload_key": { + "type": "string", + "title": "Upload Key" + } + }, + "type": "object", + "required": [ + "presigned_url", + "upload_key" + ], + "title": "CreatePresignedURLResponseSerializer", + "example": { + "presigned_url": "https://...", + "upload_key": "qwe0982awfwef" + } + }, + "FilesResponseSerializer": { + "properties": { + "key": { + "type": "string", + "title": "ใ‚ญใƒผ" + }, + "title": { + "type": "string", + "title": "ใ‚ฟใ‚คใƒˆใƒซ" + }, + "update_time": { + "type": "string", + "format": "date-time", + "title": "Update Time" + } + }, + "type": "object", + "required": [ + "key", + "update_time" + ], + "title": "FilesResponseSerializer" + }, + "GetDownloadUrlResponseSerializer": { + "properties": { + "presigned_url": { + "type": "string", + "title": "Presigned Url" + } + }, + "type": "object", + "required": [ + "presigned_url" + ], + "title": "GetDownloadUrlResponseSerializer", + "example": { + "url": "https://..." + } + }, + "GetFileListResponseSerializer": { + "properties": { + "links": { + "$ref": "#/components/schemas/LinksSchema" + }, + "data": { + "items": { + "$ref": "#/components/schemas/FilesResponseSerializer" + }, + "type": "array", + "title": "ใƒ‡ใƒผใ‚ฟ" + } + }, + "type": "object", + "title": "GetFileListResponseSerializer", + "example": { + "data": [ + { + "key": "AAUIBQQDSgdNVQ==", + "title": "string.pdf", + "update_time": "2023-04-10T16:53:23" + } + ], + "links": { + "prev": "http://...", + "next": "http://..." + } + } + }, + "ImageUrlResponseSerializer": { + "properties": { + "origin": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "Origin" + }, + "thumb": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "Thumb" + }, + "is_title": { + "type": "boolean", + "title": "Is Title", + "default": false + } + }, + "type": "object", + "title": "ImageUrlResponseSerializer" + }, + "ImageUrlSchema": { + "properties": { + "origin": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "Origin", + "description": "ๅ…ƒใฎ็”ปๅƒURL" + }, + "thumb": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "Thumb", + "description": "ใ‚ตใƒ ใƒใ‚คใƒซ็”ปๅƒใฎURL" + } + }, + "type": "object", + "title": "ImageUrlSchema" + }, + "JobCompanyResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "ไผๆฅญID" + }, + "name": { + "type": "string", + "title": "ไผš็คพๅ" + }, + "link": { + "type": "string", + "title": "ไผๆฅญใƒšใƒผใ‚ธใƒชใƒณใ‚ฏ" + }, + "registration_number": { + "type": "string", + "title": "ไบ‹ๆฅญ่€…็•ชๅท" + }, + "logo_img": { + "title": "ใƒญใ‚ด็”ปๅƒ", + "type": "object", + "properties": { + "origin": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "Origin" + }, + "thumb": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "Thumb" + }, + "is_title": { + "type": "boolean", + "title": "Is Title", + "default": false + } + } + }, + "description": { + "type": "string", + "title": "ไผš็คพ็ดนไป‹" + }, + "company_tags": { + "items": { + "$ref": "#/components/schemas/CompanyTagResponseSerializer" + }, + "type": "array", + "title": "ไผๆฅญใ‚ฟใ‚ฐ", + "default": [] + } + }, + "type": "object", + "title": "JobCompanyResponseSerializer" + }, + "JobListAddressResponseSerializer": { + "properties": { + "country": { + "type": "string", + "title": "ๅ›ฝ" + }, + "location": { + "type": "string", + "title": "Location" + }, + "full_location": { + "type": "string", + "title": "ใƒ•ใƒซใƒญใ‚ฑใƒผใ‚ทใƒงใƒณ" + } + }, + "type": "object", + "title": "JobListAddressResponseSerializer" + }, + "JobListDetailResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "ใƒใ‚ธใ‚ทใƒงใƒณID" + }, + "status": { + "$ref": "#/components/schemas/JobStatusEnum" + }, + "due_time": { + "type": "string", + "format": "date", + "title": "็ท ใ‚ๅˆ‡ใ‚Š" + }, + "position": { + "type": "string", + "title": "ใƒใ‚ธใ‚ทใƒงใƒณๅ" + }, + "company": { + "title": "ไผš็คพ", + "type": "object", + "properties": { + "id": { + "type": "integer", + "title": "ไผๆฅญID" + }, + "name": { + "type": "string", + "title": "ไผš็คพๅ" + }, + "link": { + "type": "string", + "title": "ไผๆฅญใƒšใƒผใ‚ธใƒชใƒณใ‚ฏ" + }, + "registration_number": { + "type": "string", + "title": "ไบ‹ๆฅญ่€…็•ชๅท" + }, + "logo_img": { + "title": "ใƒญใ‚ด็”ปๅƒ", + "type": "object", + "properties": { + "origin": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "Origin" + }, + "thumb": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "Thumb" + }, + "is_title": { + "type": "boolean", + "title": "Is Title", + "default": false + } + } + }, + "description": { + "type": "string", + "title": "ไผš็คพ็ดนไป‹" + }, + "company_tags": { + "items": { + "$ref": "#/components/schemas/CompanyTagResponseSerializer" + }, + "type": "array", + "title": "ไผๆฅญใ‚ฟใ‚ฐ", + "default": [] + } + } + }, + "reward": { + "title": "ๅ ฑ้…ฌ", + "type": "object", + "properties": { + "country": { + "$ref": "#/components/schemas/CountryEnum" + }, + "formatted_total": { + "type": "string", + "title": "Formatted Total", + "description": "ๅ…จๅ ฑ้…ฌ", + "default": "0" + }, + "formatted_recommender": { + "type": "string", + "title": "Formatted Recommender", + "description": "ใŠใ™ใ™ใ‚ใฎๅ ฑ้…ฌ", + "default": "0" + }, + "formatted_recommendee": { + "type": "string", + "title": "Formatted Recommendee", + "description": "ๅฟœๅ‹Ÿ่€…ๅ ฑ้…ฌ", + "default": "0" + } + } + }, + "address": { + "title": "ไฝๆ‰€", + "type": "object", + "properties": { + "country": { + "type": "string", + "title": "ๅ›ฝ" + }, + "location": { + "type": "string", + "title": "Location" + }, + "full_location": { + "type": "string", + "title": "ใƒ•ใƒซใƒญใ‚ฑใƒผใ‚ทใƒงใƒณ" + } + } + }, + "title_img": { + "$ref": "#/components/schemas/ImageUrlResponseSerializer" + }, + "logo_img": { + "$ref": "#/components/schemas/ImageUrlResponseSerializer" + }, + "category_tags": { + "title": "่ทๅ‹™/่ทๅ‹™ใ‚ฟใ‚ฐ", + "type": "object", + "properties": { + "parent_tag": { + "title": "็›ด่ป", + "type": "object", + "properties": { + "id": { + "type": "integer", + "title": "ใ‚ฟใ‚ฐID" + }, + "text": { + "type": "string", + "title": "ใ‚ฟใ‚ฐๅ" + } + } + }, + "child_tags": { + "items": { + "$ref": "#/components/schemas/openapi__apis__v1__jobs__serializers__TagResponseSerializer" + }, + "type": "array", + "title": "่ทๅ‹™" + } + } + }, + "url": { + "type": "string", + "title": "ใƒใ‚ธใ‚ทใƒงใƒณใƒšใƒผใ‚ธ่ฉณ็ดฐURL" + } + }, + "type": "object", + "required": [ + "id", + "status", + "position", + "company", + "url" + ], + "title": "JobListDetailResponseSerializer" + }, + "JobListResponseSerializer": { + "properties": { + "links": { + "$ref": "#/components/schemas/LinksSchema" + }, + "data": { + "items": { + "$ref": "#/components/schemas/JobListDetailResponseSerializer" + }, + "type": "array", + "title": "ใƒ‡ใƒผใ‚ฟ" + } + }, + "type": "object", + "title": "JobListResponseSerializer", + "example": { + "data": [ + { + "id": 24049, + "status": "active", + "due_time": "2023-05-01", + "name": "ํฌ์ง€์…˜๋ช…", + "address": { + "country": "ํ•œ๊ตญ", + "location": "์„œ์šธ" + }, + "title_img": { + "origin": "https://...", + "thumb": "https://..." + }, + "logo_img": { + "origin": "https://...", + "thumb": "https://..." + }, + "company": { + "id": 7565, + "name": "๊ธฐ์—…๋ช…" + }, + "reward": { + "total": "100๋งŒ์›", + "recommender": "50๋งŒ์›", + "recommendee": "50๋งŒ์›" + } + } + ], + "links": { + "prev": "/api/chaos/jobs/v1?country=KR&sort=company.response_rate_order&offset=1&limit=1", + "next": "/api/chaos/jobs/v1?country=KR&sort=company.response_rate_order&offset=1&limit=1" + } + } + }, + "JobSortEnum": { + "enum": [ + "job.latest_order", + "job.popularity_order", + "company.response_rate_order" + ], + "title": "JobSortEnum", + "description": "An enumeration." + }, + "JobStatusEnum": { + "oneOf": [ + { + "const": "request", + "title": "JobStatusEnum", + "description": "An enumeration." + }, + { + "const": "draft", + "title": "JobStatusEnum", + "description": "An enumeration." + }, + { + "const": "active", + "title": "JobStatusEnum", + "description": "An enumeration." + }, + { + "const": "archived", + "title": "JobStatusEnum", + "description": "An enumeration." + }, + { + "const": "close", + "title": "JobStatusEnum", + "description": "An enumeration." + }, + { + "const": "saved", + "title": "JobStatusEnum", + "description": "An enumeration." + } + ], + "title": "JobStatusEnum", + "description": "An enumeration." + }, + "LinksSchema": { + "properties": { + "prev": { + "type": "string", + "title": "Prev", + "description": "ๅ‰ใฎใƒšใƒผใ‚ธ" + }, + "next": { + "type": "string", + "title": "Next", + "description": "ๆฌกใฎใƒšใƒผใ‚ธ" + } + }, + "type": "object", + "title": "LinksSchema" + }, + "OpenAPIExceptionResponse": { + "properties": { + "error_code": { + "type": "string", + "title": "ใ‚จใƒฉใƒผใ‚ณใƒผใƒ‰" + }, + "message": { + "type": "string", + "title": "ใƒกใƒƒใ‚ปใƒผใ‚ธ" + }, + "data": { + "type": "object", + "title": "ใƒ‡ใƒผใ‚ฟ" + } + }, + "type": "object", + "required": [ + "error_code", + "message" + ], + "title": "OpenAPIExceptionResponse" + }, + "ParentTagResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "Id", + "description": "ใ‚ฟใ‚ฐID" + }, + "parent_id": { + "type": "integer", + "title": "Parent Id", + "description": "่ฆชใ‚ฟใ‚ฐID" + }, + "title": { + "type": "string", + "title": "ใ‚ฟใ‚คใƒˆใƒซ", + "description": "ใ‚ฟใ‚ฐๅ" + }, + "title_thumb_img": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "Title Thumb Img", + "description": "ใ‚ฟใ‚ฐ็”ปๅƒURL" + }, + "sub_tags": { + "items": { + "$ref": "#/components/schemas/openapi__apis__v1__tags__serializers__TagResponseSerializer" + }, + "type": "array", + "title": "ใ‚ตใƒ–ใ‚ฟใ‚ฐ" + } + }, + "type": "object", + "required": [ + "id", + "title" + ], + "title": "ParentTagResponseSerializer" + }, + "PassTextPredictionRequestSerializer": { + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/ResumeJdTextPredictionItemSerializer" + }, + "type": "array", + "title": "ไบˆๆธฌ่ฆๆฑ‚ใƒ‡ใƒผใ‚ฟใƒชใ‚นใƒˆ" + }, + "callback_url": { + "type": "string", + "title": "CallbackURL", + "description": "้žๅŒๆœŸๅ‡ฆ็†ๅพŒใซ็ตๆžœใ‚’้€š็Ÿฅใ•ใ‚Œใ‚‹URL", + "example": "http://my-server.com/v1/pass/callback" + }, + "request_id": { + "type": "string", + "title": "ใƒชใ‚ฏใ‚จใ‚นใƒˆID", + "description": "ๅ‡ฆ็†็ตๆžœใŒ้€š็Ÿฅใ•ใ‚Œใ‚‹ใจใ€่ฆๆฑ‚IDใŒไธ€็ท’ใซๆธกใ•ใ‚Œใพใ™ใ€‚ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใงใฏUUIDๅฝขๅผใง่‡ชๅ‹•็”Ÿๆˆใ•ใ‚Œใพใ™ใŒใ€ใ‚ฏใƒฉใ‚คใ‚ขใƒณใƒˆๅดใฎใƒญใ‚ธใƒƒใ‚ฏใซใ‚ˆใฃใฆ้žๅŒๆœŸ่ฆๆฑ‚ใƒ—ใƒญใ‚ปใ‚นใ‚ˆใ‚Šใ‚‚้€š็ŸฅURLๅ‘ผใณๅ‡บใ—ใŒๆœ€ๅˆใซ่กŒใ‚ใ‚Œใ‚‹ๅ ดๅˆใฏใ€ไบ‹ๅ‰ใซrequest_idใ‚’ๆŒ‡ๅฎšใ™ใ‚‹ๅฟ…่ฆใŒใ‚ใ‚Šใพใ™", + "example": "55e41f9f-a5a6-4836-8490-68914ff51b64" + } + }, + "type": "object", + "required": [ + "data", + "callback_url" + ], + "title": "PassTextPredictionRequestSerializer" + }, + "ResumeJdTextPredictionItemSerializer": { + "properties": { + "resume": { + "type": "string", + "title": "ๅฑฅๆญดใ‚ตใƒผใƒ†ใ‚ญใ‚นใƒˆ", + "example": "5๋…„์ฐจ ์†Œํ”„ํŠธ์›จ์–ด ์—”์ง€๋‹ˆ์–ด ์ž…๋‹ˆ๋‹ค..." + }, + "jd": { + "type": "string", + "title": "JDใƒ†ใ‚ญใ‚นใƒˆ", + "example": "5๋…„์ฐจ ์†Œํ”„ํŠธ์›จ์–ด ์—”์ง€๋‹ˆ์–ด ๊ตฌํ•ฉ๋‹ˆ๋‹ค..." + } + }, + "type": "object", + "required": [ + "resume", + "jd" + ], + "title": "ResumeJdTextPredictionItemSerializer" + }, + "RewardResponseSerializer": { + "properties": { + "country": { + "$ref": "#/components/schemas/CountryEnum" + }, + "formatted_total": { + "type": "string", + "title": "Formatted Total", + "description": "ๅ…จๅ ฑ้…ฌ", + "default": "0" + }, + "formatted_recommender": { + "type": "string", + "title": "Formatted Recommender", + "description": "ใŠใ™ใ™ใ‚ใฎๅ ฑ้…ฌ", + "default": "0" + }, + "formatted_recommendee": { + "type": "string", + "title": "Formatted Recommendee", + "description": "ๅฟœๅ‹Ÿ่€…ๅ ฑ้…ฌ", + "default": "0" + } + }, + "type": "object", + "title": "RewardResponseSerializer" + }, + "SearchCompanyResponseSerializer": { + "properties": { + "links": { + "$ref": "#/components/schemas/LinksSchema" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_SearchCompanySchema" + }, + "type": "array", + "title": "ใƒ‡ใƒผใ‚ฟ" + } + }, + "type": "object", + "title": "SearchCompanyResponseSerializer", + "example": { + "links": { + "next": "/api/chaos/search/v1/company?query=%EC%9B%90%ED%8B%B0%EB%93%9C&offset=1&limit=1&offset=1&limit=1" + }, + "companies": [ + { + "id": 79, + "name": "์›ํ‹ฐ๋“œ๋žฉ", + "logo_img": { + "origin": "https://static.wanted.co.kr/nextweek/images/wdes/0_4.7d6ea9b0.test_nextweek.jpg", + "thumb": "https://static.wanted.co.kr/nextweek/images/wdes/0_5.7d6ea9b0.test_nextweek.jpg" + }, + "title_img": { + "origin": "https://static.wanted.co.kr/images/company/79/15562_2_6.__1080_790.jpg", + "thumb": "https://static.wanted.co.kr/images/company/79/15562_2_6.__400_400.jpg" + }, + "description": "ใƒฏใƒณใƒ†ใ‚ฃใƒผใƒ‰ใƒฉใƒƒใƒ—ๆœ€้ซ˜", + "url": "https://www.wanted.co.kr/company/79?client_id=xxxx" + } + ] + } + }, + "SkillListResponseSerializer": { + "properties": { + "skills": { + "items": { + "$ref": "#/components/schemas/ParentTagResponseSerializer" + }, + "type": "array", + "title": "Skills" + } + }, + "type": "object", + "title": "SkillListResponseSerializer", + "example": { + "data": [ + { + "id": 1540, + "title": "Java" + } + ] + } + }, + "TagListResponseSerializer": { + "properties": { + "tags": { + "items": { + "$ref": "#/components/schemas/ParentTagResponseSerializer" + }, + "type": "array", + "title": "ใ‚ฟใ‚ฐ" + } + }, + "type": "object", + "title": "TagListResponseSerializer", + "example": { + "data": [ + { + "id": 518, + "title": "้–‹็™บ", + "image_url": "https://...", + "sub_tags": [ + { + "id": 873, + "parent_id": 518, + "title": "Web้–‹็™บ่€…", + "image_url": "https://..." + }, + { + "id": 872, + "parent_id": 518, + "title": "ใ‚ตใƒผใƒใƒผ้–‹็™บ่€…", + "image_url": "https://..." + } + ] + } + ] + } + }, + "UploadFileRequestSerializer": { + "properties": { + "upload_key": { + "type": "string", + "title": "Upload Key", + "description": "`/v1/files/upload-url`ๅฟœ็ญ”ใฎupload_key" + }, + "title": { + "type": "string", + "title": "ใƒ•ใ‚กใ‚คใƒซๅ", + "description": "`/v1/files/upload-url`ใƒฌใ‚นใƒใƒณใ‚นใฎ `presigned_url`ใ‚’ไฝฟใฃใฆใ‚ขใƒƒใƒ—ใƒญใƒผใƒ‰ใ—ใŸใƒ•ใ‚กใ‚คใƒซใฎๆ‹กๅผตๅญใ‚’ๅซใ‚€ใƒ•ใ‚กใ‚คใƒซๅ" + } + }, + "type": "object", + "required": [ + "upload_key", + "title" + ], + "title": "UploadFileRequestSerializer", + "example": { + "upload_key": "0362e393-45b7-4bca-9e33-676cffcc5cbe", + "title": "ๆทปไป˜ใƒ•ใ‚กใ‚คใƒซ.pdf" + } + }, + "UploadFileResponseSerializer": { + "properties": { + "key": { + "type": "string", + "title": "ใ‚ญใƒผ" + } + }, + "type": "object", + "required": [ + "key" + ], + "title": "UploadFileResponseSerializer", + "example": { + "key": "AAUIBQQGSgdNVQ==" + } + }, + "_CompanyAutoCompleteSerializer": { + "properties": { + "company_id": { + "type": "integer", + "title": "Company Id", + "description": "ไผš็คพID" + }, + "name_ko": { + "type": "string", + "title": "ๅๅญ", + "description": "ไผš็คพๅ" + }, + "logo_image": { + "type": "string", + "title": "Logo Image", + "description": "ไผš็คพใƒญใ‚ด ใ‚คใƒกใƒผใ‚ธ url" + } + }, + "type": "object", + "required": [ + "company_id", + "name_ko" + ], + "title": "_CompanyAutoCompleteSerializer" + }, + "_SearchCompanySchema": { + "properties": { + "id": { + "type": "integer", + "title": "Id", + "description": "ไผš็คพID" + }, + "name": { + "type": "string", + "title": "ๅๅ‰", + "description": "ไผš็คพๅ" + }, + "logo_img": { + "$ref": "#/components/schemas/ImageUrlSchema" + }, + "title_img": { + "$ref": "#/components/schemas/ImageUrlSchema" + }, + "description": { + "type": "string", + "title": "Description", + "description": "ไผš็คพใฎ่ชฌๆ˜Ž" + }, + "url": { + "type": "string", + "title": "Url", + "description": "ไผš็คพ่ฉณ็ดฐใƒšใƒผใ‚ธ url" + } + }, + "type": "object", + "required": [ + "id", + "name", + "url" + ], + "title": "_SearchCompanySchema" + }, + "openapi__apis__v1__applications__serializers__JobDetailResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "Id" + }, + "status": { + "$ref": "#/components/schemas/JobStatusEnum" + }, + "company_id": { + "type": "integer", + "title": "Company Id" + }, + "due_time": { + "type": "string", + "format": "date", + "title": "Due Time", + "description": "็ท ใ‚ๅˆ‡ใ‚Š" + }, + "logo_url": { + "$ref": "#/components/schemas/ImageUrlResponseSerializer" + } + }, + "type": "object", + "required": [ + "id", + "status" + ], + "title": "JobDetailResponseSerializer" + }, + "openapi__apis__v1__companies__serializers__JobResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "Id", + "description": "ใƒใ‚ธใ‚ทใƒงใƒณID" + }, + "name": { + "type": "string", + "title": "ๅๅ‰", + "description": "ใƒใ‚ธใ‚ทใƒงใƒณๅ" + }, + "due_time": { + "type": "string", + "format": "date", + "title": "Due Time", + "description": "็ท ใ‚ๅˆ‡ใ‚Š" + }, + "reward": { + "title": "ๅ ฑ้…ฌ", + "description": "ๅ ฑ้…ฌ", + "type": "object", + "properties": { + "country": { + "$ref": "#/components/schemas/CountryEnum" + }, + "formatted_total": { + "type": "string", + "title": "Formatted Total", + "description": "ๅ…จๅ ฑ้…ฌ", + "default": "0" + }, + "formatted_recommender": { + "type": "string", + "title": "Formatted Recommender", + "description": "ใŠใ™ใ™ใ‚ใฎๅ ฑ้…ฌ", + "default": "0" + }, + "formatted_recommendee": { + "type": "string", + "title": "Formatted Recommendee", + "description": "ๅฟœๅ‹Ÿ่€…ๅ ฑ้…ฌ", + "default": "0" + } + } + }, + "url": { + "type": "string", + "title": "ใƒใ‚ธใ‚ทใƒงใƒณใƒšใƒผใ‚ธ่ฉณ็ดฐURL" + } + }, + "type": "object", + "required": [ + "id", + "name", + "url" + ], + "title": "JobResponseSerializer" + }, + "openapi__apis__v1__jobs__serializers__JobDetailResponseSerializer": { + "properties": { + "position": { + "type": "string", + "title": "ใƒใ‚ธใ‚ทใƒงใƒณๅ" + }, + "intro": { + "type": "string", + "title": "ใ‚คใƒณใƒˆใƒญ" + }, + "main_tasks": { + "type": "string", + "title": "ไธปใชไป•ไบ‹" + }, + "requirements": { + "type": "string", + "title": "่ณ‡ๆ ผ่ฆไปถ" + }, + "preferred_points": { + "type": "string", + "title": "ๅ„ช้‡ไบ‹้ …" + }, + "benefits": { + "type": "string", + "title": "็‰นๅ…ธใจ็ฆ็ฅ‰" + } + }, + "type": "object", + "title": "JobDetailResponseSerializer" + }, + "openapi__apis__v1__jobs__serializers__JobResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "ใƒใ‚ธใ‚ทใƒงใƒณID" + }, + "status": { + "$ref": "#/components/schemas/JobStatusEnum" + }, + "due_time": { + "type": "string", + "format": "date", + "title": "็ท ใ‚ๅˆ‡ใ‚Š" + }, + "detail": { + "$ref": "#/components/schemas/openapi__apis__v1__jobs__serializers__JobDetailResponseSerializer" + }, + "category_tags": { + "title": "่ทๅ‹™/่ทๅ‹™ใ‚ฟใ‚ฐ", + "type": "object", + "properties": { + "parent_tag": { + "title": "็›ด่ป", + "type": "object", + "properties": { + "id": { + "type": "integer", + "title": "ใ‚ฟใ‚ฐID" + }, + "text": { + "type": "string", + "title": "ใ‚ฟใ‚ฐๅ" + } + } + }, + "child_tags": { + "items": { + "$ref": "#/components/schemas/openapi__apis__v1__jobs__serializers__TagResponseSerializer" + }, + "type": "array", + "title": "่ทๅ‹™" + } + } + }, + "skill_tags": { + "items": { + "$ref": "#/components/schemas/openapi__apis__v1__jobs__serializers__TagResponseSerializer" + }, + "type": "array", + "title": "ใ‚นใ‚ญใƒซใ‚ฟใ‚ฐ" + }, + "company": { + "title": "ไผš็คพ", + "type": "object", + "properties": { + "id": { + "type": "integer", + "title": "ไผๆฅญID" + }, + "name": { + "type": "string", + "title": "ไผš็คพๅ" + }, + "link": { + "type": "string", + "title": "ไผๆฅญใƒšใƒผใ‚ธใƒชใƒณใ‚ฏ" + }, + "registration_number": { + "type": "string", + "title": "ไบ‹ๆฅญ่€…็•ชๅท" + }, + "logo_img": { + "title": "ใƒญใ‚ด็”ปๅƒ", + "type": "object", + "properties": { + "origin": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "Origin" + }, + "thumb": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "Thumb" + }, + "is_title": { + "type": "boolean", + "title": "Is Title", + "default": false + } + } + }, + "description": { + "type": "string", + "title": "ไผš็คพ็ดนไป‹" + }, + "company_tags": { + "items": { + "$ref": "#/components/schemas/CompanyTagResponseSerializer" + }, + "type": "array", + "title": "ไผๆฅญใ‚ฟใ‚ฐ", + "default": [] + } + } + }, + "reward": { + "title": "ๅ ฑ้…ฌ", + "type": "object", + "properties": { + "country": { + "$ref": "#/components/schemas/CountryEnum" + }, + "formatted_total": { + "type": "string", + "title": "Formatted Total", + "description": "ๅ…จๅ ฑ้…ฌ", + "default": "0" + }, + "formatted_recommender": { + "type": "string", + "title": "Formatted Recommender", + "description": "ใŠใ™ใ™ใ‚ใฎๅ ฑ้…ฌ", + "default": "0" + }, + "formatted_recommendee": { + "type": "string", + "title": "Formatted Recommendee", + "description": "ๅฟœๅ‹Ÿ่€…ๅ ฑ้…ฌ", + "default": "0" + } + } + }, + "address": { + "title": "ไฝๆ‰€", + "type": "object", + "properties": { + "id": { + "type": "integer", + "title": "Id" + }, + "country": { + "type": "string", + "title": "ๅ›ฝ" + }, + "country_code": { + "type": "string", + "title": "ๅ›ฝใ‚ณใƒผใƒ‰" + }, + "location": { + "type": "string", + "title": "Location" + }, + "full_location": { + "type": "string", + "title": "ๅฎŒๅ…จใชไฝๆ‰€" + }, + "geo_location": { + "type": "object", + "title": "Geo Location" + } + } + }, + "images": { + "items": { + "$ref": "#/components/schemas/ImageUrlResponseSerializer" + }, + "type": "array", + "title": "็”ปๅƒ" + }, + "url": { + "type": "string", + "title": "ใƒใ‚ธใ‚ทใƒงใƒณใƒšใƒผใ‚ธ่ฉณ็ดฐURL" + } + }, + "type": "object", + "required": [ + "url" + ], + "title": "JobResponseSerializer", + "example": { + "id": 24090, + "status": "active", + "due_time": "2023-05-01", + "detail": { + "intro": "โ€˜์›ํ‹ฐ๋“œ๋žฉโ€™์€ ์ „ ์„ธ๊ณ„ ๋ชจ๋“  ๊ธฐ์—…๊ณผ ์ง์žฅ์ธ์˜ ๊ณ ๋ฏผ์„ ํ•ด๊ฒฐํ•˜๊ธฐ ์œ„ํ•œ HR ์Šคํƒ€ํŠธ์—…์ž…๋‹ˆ๋‹ค. ์ง์žฅ์ธ์˜ 90%๋Š” ์ด์ง์„ ์ƒ๊ฐํ•˜์ง€๋งŒ, ์–ด๋–ค ๊ธฐ์—…์ด ์ž์‹ ์—๊ฒŒ ์ตœ์„ ์˜ ์„ ํƒ์ธ์ง€ ์•Œ์ง€ ๋ชปํ•œ ์ฑ„ ์—…๋ฌด์— ์ž์‹ ์„ ๋งž์ถ”๊ณ  ์žˆ์Šต๋‹ˆ๋‹ค. ๊ธฐ์—…์€ ๋ˆ„๊ตฐ๊ฐ€์— ์˜ํ•ด ๊ฒ€์ฆ๋œ ์ธ์žฌ๋ฅผ ์ฑ„์šฉํ•˜๊ณ  ์‹ถ์ง€๋งŒ, ๊ทธ ๋น„์šฉ๊ณผ ์‹œ๊ฐ„์ด ๋งŒ๋งŒ์น˜ ์•Š์•„ ์žกํฌํ„ธ ๊ด‘๊ณ ์™€ ์˜คํ”„๋ผ์ธ ํ—ค๋“œํ—ŒํŒ…์— ์˜์กดํ•˜๊ณ  ์žˆ์Šต๋‹ˆ๋‹ค. \n\n์šฐ๋ฆฌ๋Š” ๋‹จ์ˆœํ•œ ์ฑ„์šฉ ์„œ๋น„์Šค๊ฐ€ ๋˜๋ ค๋Š” ๊ฒƒ์ด ์•„๋‹™๋‹ˆ๋‹ค. ์šฐ๋ฆฌ๋Š” โ€˜์ข‹์€ ์ผ์ž๋ฆฌ์™€ ์ˆจ์€ ์ธ์žฌ๋ฅผ ์—ฐ๊ฒฐํ•˜๋Š” ๊ฐ€์žฅ ํšจ์œจ์ ์ด๊ณ  ์ธ๊ฐ„์ ์ธ ๋ฐฉ๋ฒ•โ€™์ด๋ผ๋Š” ๋ฌธ์ œ๋ฅผ ํ’€๊ณ ์ž ํ•ฉ๋‹ˆ๋‹ค. ์ธ์žฌ์—๊ฒŒ๋Š” ์ž์‹ ์˜ ์—ญ๋Ÿ‰์„ ์œ ๊ฐ์—†์ด ๋ฐœํœ˜ํ•  ์ˆ˜ ์žˆ๋Š” ์ผ์ž๋ฆฌ๋ฅผ ์ถ”์ฒœํ•˜๊ณ , ๊ธฐ์—…์—๊ฒŒ๋Š” ํ•„์š”ํ•œ ์ž๋ฆฌ์— ๋”ฑ ๋งž๋Š” ์ธ์žฌ๋ฅผ ์ถ”์ฒœํ•˜๋Š” ์„œ๋น„์Šค์ž…๋‹ˆ๋‹ค. ์ด๋ฅผ ์œ„ํ•ด ๋ชจ๋ฐ”์ผ / ์†Œ์…œ ๋„คํŠธ์›Œํฌ / ๋น…๋ฐ์ดํ„ฐ์— ๊ธฐ๋ฐ˜ํ•œ HR ์†”๋ฃจ์…˜๋“ค์„ ํ•˜๋‚˜์”ฉ ๋งŒ๋“ค์–ด๋‚˜๊ฐ€๊ณ  ์žˆ์Šต๋‹ˆ๋‹ค. ์šฐ๋ฆฌ์˜ ์‹œ์„ ์€ ํ•œ๊ตญ์— ๋จธ๋ฌผ๋Ÿฌ ์žˆ์ง€ ์•Š์Šต๋‹ˆ๋‹ค. \n\n2015๋…„ 5์›” ์„œ๋น„์Šค๋ฅผ ์‹œ์ž‘ํ•˜์—ฌ, 2019๋…„ 3์›” ํ˜„์žฌ 4000์—ฌ ๊ธฐ์—…, 60๋งŒ ์œ ์ €(ํ•œ๊ตญ ๊ธฐ์ค€)๊ฐ€ ์ด์šฉ ์ค‘์— ์žˆ์Šต๋‹ˆ๋‹ค. 2017๋…„ 5์›”์—๋Š” 100์–ต ํˆฌ์ž๋ฅผ ๋ฐ›์•˜์œผ๋ฉฐ, ํ•œ๊ตญ/์ผ๋ณธ/๋Œ€๋งŒ/์‹ฑ๊ฐ€ํด/ํ™์ฝฉ ์˜คํ”ผ์Šค์— 65์—ฌ๋ช…์˜ ๊ตฌ์„ฑ์›๋“ค๊ณผ ํ•จ๊ป˜ ์•„์‹œ์•„ HR ์‹œ์žฅ์„ ์„ ๋„ํ•˜๊ณ ์ž ํ•ฉ๋‹ˆ๋‹ค. \n \n2016๋…„ ์•„์‹œ์•„ ์ตœ์ดˆ๋กœ ์„ค๋ฆฝ๋œ Google Campus์˜ ์ฒซ ๋ฒˆ์งธ ์ž…์ฃผ๊ธฐ์—…์œผ๋กœ ์„ ๋ฐœ๋˜์—ˆ์œผ๋ฉฐ, 2016๋…„ KMA ๋Œ€ํ•œ๋ฏผ๊ตญ๋ชจ๋ฐ”์ผ์–ด์›Œ๋“œ ๋Œ€์ƒ ์ˆ˜์ƒ, 2017๋…„ AWS์˜ ๋– ์˜ค๋ฅด๋Š” ์Šคํƒ€ํŠธ์—… ์„ ์ •, Facebook Korea๊ฐ€ ์„ ์ •ํ•œ ๋Œ€ํ‘œ์ ์ธ ํŒŒํŠธ๋„ˆ์‹ญ ์‚ฌ๋ก€๋กœ ์†Œ๊ฐœ, 2018๋…„ Forbes๊ฐ€ ์„ ์ •ํ•œ 2018๋…„ ์ฃผ๋ชฉํ•ด์•ผ ํ•  ํ•œ๊ตญ ์Šคํƒ€ํŠธ์—…์œผ๋กœ ์„ ์ •๋˜์—ˆ๊ณ , ๋˜ํ•œ Google TensorFlow๋ฅผ ํ™œ์šฉํ•˜์—ฌ ๋งค์นญ ์„œ๋น„์Šค๋ฅผ ํ•˜๊ณ  ์žˆ๋Š” ๊ตญ๋‚ด ์ฒซ ์‚ฌ๋ก€๋กœ ๊ตฌ๊ธ€ ๊ฐœ๋ฐœ์ž ํ–‰์‚ฌ์—์„œ ์‚ฌ๋ก€๋ฅผ ๋ฐœํ‘œํ•˜๊ธฐ๋„ ํ•˜์˜€์Šต๋‹ˆ๋‹ค.", + "main_tasks": "โ€ข ๋ฉ”์ดํ”Œ ์Šคํ† ๋ฆฌ2 ๊ธฐํš ์—…๋ฌด \nโ€ข ๊ฒŒ์ž„์˜ ์žฌ๋ฏธ๋ฅผ ์œ„ํ•œ ๋‹ค์–‘ํ•œ ๋ฃฐ์ด๋‚˜ ์‹œ์Šคํ…œ์„ ๊ธฐํšํ•˜๊ณ  ์ด๋ฅผ ๊ตฌํ˜„", + "requirements": "โ€ข ์‹ค๋ฌด์—์„œ MS Office๋ฅผ ํ™œ์šฉํ•˜๋Š”๋ฐ ํฐ ๋ฌธ์ œ๊ฐ€ ์—†๋Š” ๋ถ„ \nโ€ข ๊ฒŒ์ž„์„ ์ฆ๊ธฐ๊ณ  ์ข‹์•„ํ•˜์‹œ๋Š” ๋ถ„", + "preferred_points": "โ€ข ๋…ํŠนํ•˜๊ณ  ์ฐฝ์˜์ ์ธ ์•„์ด๋””์–ด๊ฐ€ ๋„˜์น˜๋Š” ๋ถ„ \nโ€ข ํŠน์ • ํฌ์ง€์…˜์— ์ข…์†๋˜์ง€ ์•Š๊ณ  ๊ฒŒ์ž„ ๊ธฐํš ์ „๋ฐ˜์˜ ๋‹ค์–‘ํ•œ ์—ญํ• ์„ ์ˆ˜ํ–‰ํ•  ์ˆ˜ ์žˆ์œผ์‹  ๋ถ„ \nโ€ข ๋ฉ”์ดํ”Œ ์Šคํ† ๋ฆฌ2์˜ ํ”Œ๋ ˆ์ด ๊ฒฝํ—˜๊ณผ ์ดํ•ด๋„๊ฐ€ ์žˆ์œผ์‹  ๋ถ„", + "benefits": "โ€ข ์ „ ์ง์žฅ๋ณด๋‹ค ์‹œ๊ฐ„์ /๊ฒฝ์ œ์ ์œผ๋กœ ๋” ๋‚˜์€ ์‚ถ ์ถ”๊ตฌ\nโ€ข ํ•˜๋ฃจ 8์‹œ๊ฐ„, ์•ผ๊ทผ์—†์ด ์ง‘์ค‘ํ•˜๋Š” ๋ฌธํ™” ์ •์ฐฉ\nโ€ข ํŽธ๋ฆฌํ•œ ์ถœํ‡ด๊ทผ (์—ญ์‚ผ์—ญ 3๋ฒˆ ์ถœ๊ตฌ ๋„๋ณด 10์ดˆ)\nโ€ข ์ž์œจ์  ์—…๋ฌดํ™˜๊ฒฝ (์œ„์›Œํฌ ์‚ฌ๋ฌด์‹ค, ๋ผ์šด์ง€/๋ถ€์Šค, ์ˆ˜ํ‰์  ์กฐ์ง, ๋งฅ์ฃผ ๋ฌดํ•œ๋Œ€)\nโ€ข ํœด๊ฐ€๋‹ค์šด ํœด๊ฐ€ (์‚ฌ์œ ๋‚˜ ์Šน์ธ์—†์ด ์Šค์Šค๋กœ ํœด๊ฐ€ ๊ณ„ํš, 3/5/7๋…„ ๋งŒ๊ทผ์‹œ 2์ฃผ ๋ฆฌํ”„๋ ˆ์‹œ ํœด๊ฐ€)\nโ€ข ๋ฐ˜๋ ค๋™๋ฌผ, ํœด๋Œ€๊ฐ€๋Šฅํ•œ ์•…๊ธฐ, ์ž์ „๊ฑฐ์™€ ๋™๋ฐ˜์ถœ๊ทผ ๊ฐ€๋Šฅ\nโ€ข ์—…๋ฌด๊ด€๋ จ ์ปจํผ๋Ÿฐ์Šค/๊ต์œก/๋„์„œ๊ตฌ๋งค๋น„ ์ง€์›\nโ€ข ์›” 1ํšŒ ํŒ€ ์‹์‚ฌ ๋ฐ ํ‹ฐํƒ€์ž„ ์ œ๊ณต\nโ€ข ์ง๋ฌด ์ˆ˜ํ–‰์— ํ•„์š”ํ•œ ์ตœ์‹ ์žฅ๋น„/์†Œํ”„ํŠธ์›จ์–ด ์ œ๊ณต\nโ€ข ์ตœ๊ณ ์˜ ์—…๋ฌด ํ™˜๊ฒฝ์ธ Wework ์—ญ์‚ผ์—ญ์  ์ž…์ฃผ์‚ฌ์ž…๋‹ˆ๋‹ค. ์•ˆ๋ฝํ•œ ํ™˜๊ฒฝ, ๊ตญ๋‚ด/์™ธ ์ง€์  ์ž์œ ๋กœ์šด ์ด์šฉ, ๋งฅ์ฃผ์™€ ์ปคํ”ผ ๋ฌดํ•œ์ œ๊ณต, ์ˆ˜์‹œ ์ด๋ฒคํŠธ ๋“ฑ์˜ ์„œ๋น„์Šค๋ฅผ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค.\n\n๊ธฐํƒ€\nโ€ข ๋ณธ ์ฑ„์šฉ์€ ์‚ฌ์—… ํ™•์žฅ์— ๋”ฐ๋ฅธ ์‹ ๊ทœ ์ฑ„์šฉ์ž…๋‹ˆ๋‹ค. \nโ€ข ์ผ์„ ๋” ์ž˜ํ•˜๊ธฐ ์œ„ํ•œ ๋ฐฉ๋ฒ• ์ค‘ ํ•˜๋‚˜๋กœ ์›” 2ํšŒ ๋ฆฌ๋ชจํŠธ ๊ทผ๋ฌด๋ฅผ ํ•˜์‹ค ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.", + "name": "ํ…Œ์ŠคํŠธ ํฌ์ง€์…˜" + }, + "url": "https://www.wanted.co.kr/wd/24090", + "company": { + "id": 79, + "name": "์›ํ‹ฐ๋“œ๋žฉ", + "description": "ใƒฏใƒณใƒ†ใ‚ฃใƒผใƒ‰ใƒฉใƒƒใƒ—ใงใ™ใ€‚", + "link": "https://", + "registration_number": "2991023012", + "company_tags": [ + { + "id": 9962, + "text": "๋งฅ์ฃผ" + } + ], + "logo_img": { + "origin": "https://...", + "thumb": "https://..." + } + }, + "address": { + "id": 5873, + "country": "ํ•œ๊ตญ", + "country_code": "kr", + "location": "์„œ์šธ", + "district": "seoul.songpa-gu", + "full_location": "์„œ์šธ์‹œ ์†กํŒŒ๊ตฌ ์˜ฌ๋ฆผํ”ฝ๋กœ 300", + "geo_location": { + "bounds": { + "northeast": { + "lat": 37.5137876, + "lng": 127.1047335 + }, + "southwest": { + "lat": 37.5130537, + "lng": 127.1034478 + } + }, + "location": { + "lat": 37.5134449, + "lng": 127.1041611 + }, + "location_type": "ROOFTOP", + "viewport": { + "northeast": { + "lat": 37.5147696302915, + "lng": 127.1054396302915 + }, + "southwest": { + "lat": 37.5120716697085, + "lng": 127.1027416697085 + } + } + } + }, + "reward": { + "total": "100๋งŒ์›", + "recommender": "50๋งŒ์›", + "recommendee": "50๋งŒ์›" + }, + "category_tags": { + "parent_tag": { + "id": 530, + "text": "์˜์—…" + }, + "child_tags": [ + { + "id": 768, + "text": "์ฃผ์š”๊ณ ๊ฐ์‚ฌ ๋‹ด๋‹น์ž" + } + ] + }, + "skill_tags": [ + { + "id": 1630, + "text": "์˜์—…" + } + ], + "images": [ + { + "origin": "https://...", + "thumb": "https://...", + "is_title": true + }, + { + "origin": "https://...", + "thumb": "https://...", + "is_title": false + } + ] + } + }, + "openapi__apis__v1__jobs__serializers__TagResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "ใ‚ฟใ‚ฐID" + }, + "text": { + "type": "string", + "title": "ใ‚ฟใ‚ฐๅ" + } + }, + "type": "object", + "title": "TagResponseSerializer" + }, + "openapi__apis__v1__tags__serializers__TagResponseSerializer": { + "properties": { + "id": { + "type": "integer", + "title": "Id", + "description": "ใ‚ฟใ‚ฐID" + }, + "parent_id": { + "type": "integer", + "title": "Parent Id", + "description": "่ฆชใ‚ฟใ‚ฐID" + }, + "title": { + "type": "string", + "title": "ใ‚ฟใ‚คใƒˆใƒซ", + "description": "ใ‚ฟใ‚ฐๅ" + }, + "title_thumb_img": { + "type": "string", + "maxLength": 2083, + "minLength": 1, + "format": "uri", + "title": "Title Thumb Img", + "description": "ใ‚ฟใ‚ฐ็”ปๅƒURL" + } + }, + "type": "object", + "required": [ + "id", + "title" + ], + "title": "TagResponseSerializer" + } + }, + "securitySchemes": { + "ClientIdHeader": { + "type": "apiKey", + "in": "header", + "name": "wanted-client-id" + }, + "ClientSecretHeader": { + "type": "apiKey", + "in": "header", + "name": "wanted-client-secret" + }, + "PermissionsDependency": { + "type": "apiKey", + "in": "header", + "name": "Authorization" + } + } + }, + "x-samchon-emended": true +} \ No newline at end of file diff --git a/assets/output/webhook.swagger.ar.json b/assets/output/webhook.swagger.ar.json new file mode 100644 index 0000000..4eb3105 --- /dev/null +++ b/assets/output/webhook.swagger.ar.json @@ -0,0 +1,51 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "ู…ุซุงู„ ุนู„ู‰ Webhook", + "version": "1.0.0" + }, + "webhooks": { + "newPet": { + "post": { + "requestBody": { + "description": "ู…ุนู„ูˆู…ุงุช ุนู† ุญูŠูˆุงู† ุฃู„ูŠู ุฌุฏูŠุฏ ููŠ ุงู„ู†ุธุงู…", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + } + } + }, + "responses": { + "200": { + "description": "ุฅุฑุฌุงุน ุญุงู„ุฉ 200 ู„ู„ุฅุดุงุฑุฉ ุฅู„ู‰ ุฃู†ู‡ ุชู… ุงุณุชู„ุงู… ุงู„ุจูŠุงู†ุงุช ุจู†ุฌุงุญ" + } + } + } + } + }, + "components": { + "schemas": { + "Pet": { + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "tag": { + "type": "string" + } + } + } + } + }, + "x-samchon-emended": true +} \ No newline at end of file diff --git a/assets/output/webhook.swagger.ja.json b/assets/output/webhook.swagger.ja.json new file mode 100644 index 0000000..121e5bc --- /dev/null +++ b/assets/output/webhook.swagger.ja.json @@ -0,0 +1,51 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "Webhook ใฎไพ‹", + "version": "1.0.0" + }, + "webhooks": { + "newPet": { + "post": { + "requestBody": { + "description": "ใ‚ทใ‚นใƒ†ใƒ ๅ†…ใฎๆ–ฐใ—ใ„ใƒšใƒƒใƒˆใซ้–ขใ™ใ‚‹ๆƒ…ๅ ฑ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + } + } + }, + "responses": { + "200": { + "description": "ใƒ‡ใƒผใ‚ฟใŒๆญฃๅธธใซๅ—ไฟกใ•ใ‚ŒใŸใ“ใจใ‚’็คบใ™ใŸใ‚ใซ200ใ‚นใƒ†ใƒผใ‚ฟใ‚นใ‚’่ฟ”ใ—ใพใ™" + } + } + } + } + }, + "components": { + "schemas": { + "Pet": { + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "tag": { + "type": "string" + } + } + } + } + }, + "x-samchon-emended": true +} \ No newline at end of file diff --git a/assets/output/webhook.swagger.ko.json b/assets/output/webhook.swagger.ko.json new file mode 100644 index 0000000..6d93c70 --- /dev/null +++ b/assets/output/webhook.swagger.ko.json @@ -0,0 +1,51 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "์›นํ›… ์˜ˆ์ œ", + "version": "1.0.0" + }, + "webhooks": { + "newPet": { + "post": { + "requestBody": { + "description": "์‹œ์Šคํ…œ์˜ ์ƒˆ๋กœ์šด ์• ์™„๋™๋ฌผ์— ๋Œ€ํ•œ ์ •๋ณด", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + } + } + }, + "responses": { + "200": { + "description": "๋ฐ์ดํ„ฐ๊ฐ€ ์„ฑ๊ณต์ ์œผ๋กœ ์ˆ˜์‹ ๋˜์—ˆ์Œ์„ ๋‚˜ํƒ€๋‚ด๊ธฐ ์œ„ํ•ด 200 ์ƒํƒœ๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค." + } + } + } + } + }, + "components": { + "schemas": { + "Pet": { + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "tag": { + "type": "string" + } + } + } + } + }, + "x-samchon-emended": true +} \ No newline at end of file diff --git a/test/features/test_connector_swagger.ts b/test/features/test_connector_swagger.ts deleted file mode 100644 index ca69197..0000000 --- a/test/features/test_connector_swagger.ts +++ /dev/null @@ -1,30 +0,0 @@ -import { JsonTranslator } from "@samchon/json-translator"; -import { OpenApi } from "@samchon/openapi"; -import fs from "fs"; -import typia from "typia"; - -import input from "../../assets/input/connector.swagger.json"; - -export const test_connector_swagger = async ( - translator: JsonTranslator, -): Promise => { - typia.assertGuard(input); - for (const lang of ["ko", "ja", "ar"]) { - const output: OpenApi.IDocument = await translator.translate({ - input, - target: lang, - filter: (explore) => - explore.key === "title" || - explore.key === "description" || - explore.key === "summary" || - explore.key === "termsOfService" || - explore.key === "x-wrtn-placeholder", - }); - typia.assert(output); - await fs.promises.writeFile( - `${__dirname}/../../../assets/output/connector.swagger.${lang}.json`, - JSON.stringify(output, null, 2), - "utf8", - ); - } -}; diff --git a/test/features/test_marketing_swagger.ts b/test/features/test_marketing_swagger.ts deleted file mode 100644 index 2e173d4..0000000 --- a/test/features/test_marketing_swagger.ts +++ /dev/null @@ -1,30 +0,0 @@ -import { JsonTranslator } from "@samchon/json-translator"; -import { OpenApi } from "@samchon/openapi"; -import fs from "fs"; -import typia from "typia"; - -import input from "../../assets/input/marketing.swagger.json"; - -export const test_marketing_swagger = async ( - translator: JsonTranslator, -): Promise => { - typia.assertGuard(input); - for (const lang of ["ko", "ja", "ar"]) { - const output: OpenApi.IDocument = await translator.translate({ - input, - target: lang, - filter: (explore) => - explore.key === "title" || - explore.key === "description" || - explore.key === "summary" || - explore.key === "termsOfService" || - explore.key === "x-wrtn-placeholder", - }); - typia.assert(output); - await fs.promises.writeFile( - `${__dirname}/../../../assets/output/marketing.swagger.${lang}.json`, - JSON.stringify(output, null, 2), - "utf8", - ); - } -}; diff --git a/test/features/test_shopping_swagger.ts b/test/features/test_shopping_swagger.ts deleted file mode 100644 index 5abf030..0000000 --- a/test/features/test_shopping_swagger.ts +++ /dev/null @@ -1,30 +0,0 @@ -import { JsonTranslator } from "@samchon/json-translator"; -import { OpenApi } from "@samchon/openapi"; -import fs from "fs"; -import typia from "typia"; - -import input from "../../assets/input/shopping.swagger.json"; - -export const test_shopping_swagger = async ( - translator: JsonTranslator, -): Promise => { - typia.assertGuard(input); - for (const lang of ["ko", "ja", "ar"]) { - const output: OpenApi.IDocument = await translator.translate({ - input, - target: lang, - filter: (explore) => - explore.key === "title" || - explore.key === "description" || - explore.key === "summary" || - explore.key === "termsOfService" || - explore.key === "x-wrtn-placeholder", - }); - typia.assert(output); - await fs.promises.writeFile( - `${__dirname}/../../../assets/output/shopping.swagger.${lang}.json`, - JSON.stringify(output, null, 2), - "utf8", - ); - } -}; diff --git a/test/features/test_swaggers.ts b/test/features/test_swaggers.ts new file mode 100644 index 0000000..568bd59 --- /dev/null +++ b/test/features/test_swaggers.ts @@ -0,0 +1,61 @@ +import { JsonTranslator } from "@samchon/json-translator"; +import { OpenApi } from "@samchon/openapi"; +import fs from "fs"; +import typia from "typia"; + +export const test_swaggers = async ( + translator: JsonTranslator, +): Promise => { + for (const asset of await getAssets()) { + const original = await translator.detect({ + input: asset.document, + }); + for (const lang of ["en", "ko", "ja", "ar"]) { + if (lang === original) continue; + const start: number = Date.now(); + const output: OpenApi.IDocument = await translator.translate({ + input: asset.document, + target: lang, + filter: (explore) => + explore.key === "title" || + explore.key === "description" || + explore.key === "summary" || + explore.key === "termsOfService" || + explore.key === "x-wrtn-placeholder", + }); + typia.assert(output); + console.log( + ` - ${asset.name}, ${lang} (${(Date.now() - start).toLocaleString()} ms)`, + ); + await fs.promises.writeFile( + `${__dirname}/../../../assets/output/${asset.name}.swagger.${lang}.json`, + JSON.stringify(output, null, 2), + "utf8", + ); + } + } +}; + +const getAssets = async (): Promise => { + const directory: string[] = await fs.promises.readdir( + `${__dirname}/../../../assets/input`, + ); + const output: IAsset[] = []; + for (const file of directory) { + if (file.endsWith(".swagger.json") === false) continue; + const content: string = await fs.promises.readFile( + `${__dirname}/../../../assets/input/${file}`, + "utf8", + ); + output.push({ + name: file.replace(".swagger.json", ""), + document: OpenApi.convert(JSON.parse(content)), + }); + } + return output; +}; + +interface IAsset { + name: string; + document: OpenApi.IDocument; +}