UNPKG

@tcatche/swagger-ts

Version:

Codegen from swagger to TS & Axios Functions

1,332 lines (1,331 loc) 878 kB
{ "swagger": "2.0", "info": { "description": "活动服务接口文档", "version": "1.0", "title": "Activity Restful API" }, "host": "tsp-ag-dev.mosi-tech.com", "basePath": "/activity-customaward/", "tags": [ { "name": "approve-controller", "description": "Approve Controller" }, { "name": "auto-ground-controller", "description": "Auto Ground Controller" }, { "name": "award-goods-relation-controller", "description": "Award Goods Relation Controller" }, { "name": "award-pool-goods-relation-controller", "description": "Award Pool Goods Relation Controller" }, { "name": "award-pool-setting-controller", "description": "Award Pool Setting Controller" }, { "name": "award-public-controller", "description": "Award Public Controller" }, { "name": "award-setting-controller", "description": "Award Setting Controller" }, { "name": "content-activity-public-controller", "description": "Content Activity Public Controller" }, { "name": "coupon-controller", "description": "Coupon Controller" }, { "name": "dominating-screen-public-controller", "description": "Dominating Screen Public Controller" }, { "name": "examination-paper-public-controller", "description": "Examination Paper Public Controller" }, { "name": "extension-activity-public-controller", "description": "Extension Activity Public Controller" }, { "name": "goods-special-configuration-controller", "description": "Goods Special Configuration Controller" }, { "name": "lottery-page-setting-controller", "description": "Lottery Page Setting Controller" }, { "name": "lucky-draw-lottery-result-controller", "description": "Lucky Draw Lottery Result Controller" }, { "name": "right-mgt-controller", "description": "Right Mgt Controller" }, { "name": "right-mgt-type-controller", "description": "Right Mgt Type Controller" }, { "name": "tsp-activity-info-public-controller", "description": "Tsp Activity Info Public Controller" }, { "name": "中奖信息查询", "description": "Lottery Result Controller" }, { "name": "内容管理相关接口", "description": "Content Management Controller" }, { "name": "分类管理相关接口", "description": "Classification Controller" }, { "name": "库存接口", "description": "Receive Controller" }, { "name": "抽奖处理相关接口", "description": "Activity Award Lottery Controller" }, { "name": "抽奖管理相关接口", "description": "Lucky Draw Controller" }, { "name": "推广活动相关接口", "description": "Extension Activity Controller" }, { "name": "标签管理相关接口", "description": "Lable Management Controller" }, { "name": "活动信息接口", "description": "Tsp Activity Info Controller" }, { "name": "活动内容相关接口", "description": "Content Activity Controller" }, { "name": "积分发奖", "description": "Integral Prizes Controller" }, { "name": "积分用户", "description": "Integral User Info Controller" }, { "name": "考卷相关接口", "description": "Examination Paper Controller" }, { "name": "适用用户和权益查询接口", "description": "User Series Model Controller" }, { "name": "霸屏相关接口", "description": "Dominating Screen Controller" }, { "name": "题库相关接口", "description": "Question Bank Controller" }, { "name": "题目相关接口", "description": "Subject Controller" } ], "paths": { "/admin/api/v1/award/getAwardListByActivityIdFromResult": { "post": { "tags": [ "award-public-controller" ], "summary": "中奖结果信息查询", "operationId": "AwardPublicgetAwardListByActivityIdFromResult", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "request", "description": "request", "required": true, "schema": { "$ref": "#/definitions/GetAwardListByActivityIdFromResultRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/公共响应对象«List«AwardVO»»" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/admin/api/v1/classification/addClassification": { "post": { "tags": [ "分类管理相关接口" ], "summary": "新增分类管理", "operationId": "ClassificationaddClassification", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "classificationVO", "description": "classificationVO", "required": true, "schema": { "$ref": "#/definitions/ClassificationVO" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/公共响应对象" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/admin/api/v1/classification/checkClassification": { "post": { "tags": [ "分类管理相关接口" ], "summary": "删除分类管理校验", "operationId": "ClassificationcheckClassification", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "id", "description": "id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/公共响应对象" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/admin/api/v1/classification/checkClassificationName": { "post": { "tags": [ "分类管理相关接口" ], "summary": "分类管理名称唯一校验", "operationId": "ClassificationcheckClassificationName", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "classificationVO", "description": "classificationVO", "required": true, "schema": { "$ref": "#/definitions/ClassificationVO" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/公共响应对象«校验提示»" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/admin/api/v1/classification/delete": { "post": { "tags": [ "分类管理相关接口" ], "summary": "删除分类管理", "operationId": "Classificationdelete", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "id", "description": "id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/公共响应对象" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/admin/api/v1/classification/info/{id}": { "get": { "tags": [ "分类管理相关接口" ], "summary": "分类管理详情查看", "operationId": "Classificationinfo", "produces": [ "*/*" ], "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/公共响应对象«分类管理»" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/admin/api/v1/classification/list": { "get": { "tags": [ "分类管理相关接口" ], "summary": "分类管理列表", "operationId": "Classificationlist", "produces": [ "*/*" ], "parameters": [ { "name": "classificationDescribe", "in": "query", "description": "分类描述", "required": false, "type": "string" }, { "name": "classificationName", "in": "query", "description": "分类名称", "required": false, "type": "string" }, { "name": "id", "in": "query", "description": "分类id", "required": false, "type": "integer", "format": "int32" }, { "name": "level", "in": "query", "description": "级别", "required": false, "type": "integer", "format": "int32" }, { "name": "parentId", "in": "query", "description": "父id", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/公共响应对象«List«分类管理»»" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/admin/api/v1/classification/updateClassification": { "post": { "tags": [ "分类管理相关接口" ], "summary": "编辑分类管理", "operationId": "ClassificationupdateClassification", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "classificationVO", "description": "classificationVO", "required": true, "schema": { "$ref": "#/definitions/ClassificationVO" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/公共响应对象" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/admin/api/v1/contentActivity/addContentActivity": { "post": { "tags": [ "活动内容相关接口" ], "summary": "新增活动内容", "operationId": "ContentActivityaddContentActivity", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "contentActivityVO", "description": "contentActivityVO", "required": true, "schema": { "$ref": "#/definitions/ContentActivityVO" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/公共响应对象«校验提示»" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/admin/api/v1/contentActivity/checkContentActivity": { "post": { "tags": [ "活动内容相关接口" ], "summary": "删除和编辑内容内容活动校验", "operationId": "ContentActivitycheckContentActivity", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "checkActivityVO", "description": "checkActivityVO", "required": true, "schema": { "$ref": "#/definitions/CheckActivityVO" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/公共响应对象«校验提示»" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/admin/api/v1/contentActivity/contentActivity/export": { "get": { "tags": [ "活动内容相关接口" ], "summary": "活动内容导出", "operationId": "ContentActivityexportContentActivity", "produces": [ "*/*" ], "parameters": [ { "name": "activityCode", "in": "query", "description": "所属活动code", "required": false, "type": "string" }, { "name": "activityName", "in": "query", "description": "所属活动名称", "required": false, "type": "string" }, { "name": "contentActivitySettingVOList[0].applicableUserDetailedVOList[0].applicableUser", "in": "query", "description": "适用用户:1-全选,2-CNS,3-CRS,4-非CNS非CRS,5-车联网用户", "required": false, "type": "integer", "format": "int32" }, { "name": "contentActivitySettingVOList[0].applicableUserDetailedVOList[0].applicableUserType", "in": "query", "description": "类型 1:内容管理-适用用户 2:内容活动-适用用户 3:题库管理-适用用户 4:推广活动-适用用户", "required": false, "type": "integer", "format": "int32" }, { "name": "contentActivitySettingVOList[0].applicableUserDetailedVOList[0].vehicleModel", "in": "query", "description": "车型", "required": false, "type": "string" }, { "name": "contentActivitySettingVOList[0].applicableUserDetailedVOList[0].vehicleSeries", "in": "query", "description": "车系", "required": false, "type": "string" }, { "name": "contentActivitySettingVOList[0].contentActivitySettingContentVOList[0].activityCode", "in": "query", "description": "活动code", "required": false, "type": "string" }, { "name": "contentActivitySettingVOList[0].contentActivitySettingContentVOList[0].applicableUserName", "in": "query", "description": "适用用户(新增查询和回显适用):1-全选,2-CNS,3-CRS,4-非CNS非CRS,5-车联网用户", "required": false, "type": "string" }, { "name": "contentActivitySettingVOList[0].contentActivitySettingContentVOList[0].bannerUrl", "in": "query", "description": "banner图URL", "required": false, "type": "string" }, { "name": "contentActivitySettingVOList[0].contentActivitySettingContentVOList[0].contentActivitySettingContentId", "in": "query", "description": "内容设置视频id", "required": false, "type": "integer", "format": "int64" }, { "name": "contentActivitySettingVOList[0].contentActivitySettingContentVOList[0].contentActivitySettingId", "in": "query", "description": "内容设置id", "required": false, "type": "integer", "format": "int64" }, { "name": "contentActivitySettingVOList[0].contentActivitySettingContentVOList[0].contentManagementId", "in": "query", "description": "内容管理id", "required": false, "type": "integer", "format": "int64" }, { "name": "contentActivitySettingVOList[0].contentActivitySettingContentVOList[0].contentTitle", "in": "query", "description": "内容标题", "required": false, "type": "string" }, { "name": "contentActivitySettingVOList[0].contentActivitySettingContentVOList[0].dominatingScreen", "in": "query", "description": "霸屏推送-(列表展示)", "required": false, "type": "string" }, { "name": "contentActivitySettingVOList[0].contentActivitySettingContentVOList[0].goldCoinNumber", "in": "query", "description": "系统权益-获得金币数量", "required": false, "type": "integer", "format": "int32" }, { "name": "contentActivitySettingVOList[0].contentActivitySettingContentVOList[0].pushContent", "in": "query", "description": "推送内容 1:推送图片 2:推送权益", "required": false, "type": "integer", "format": "int32" }, { "name": "contentActivitySettingVOList[0].contentActivitySettingContentVOList[0].pushImageUrl", "in": "query", "description": "推送图片URL", "required": false, "type": "string" }, { "name": "contentActivitySettingVOList[0].contentActivitySettingContentVOList[0].pushType", "in": "query", "description": "推送 1:观看完毕后推送 2:不推送", "required": false, "type": "integer", "format": "int32" }, { "name": "contentActivitySettingVOList[0].contentActivitySettingContentVOList[0].reward", "in": "query", "description": "奖励-(列表展示)", "required": false, "type": "string" }, { "name": "contentActivitySettingVOList[0].contentActivitySettingContentVOList[0].rightsDetailedVOList[0].rightsImageUrl", "in": "query", "description": "权益图片URL", "required": false, "type": "string" }, { "name": "contentActivitySettingVOList[0].contentActivitySettingContentVOList[0].rightsDetailedVOList[0].rightsInterests", "in": "query", "description": "选择权益", "required": false, "type": "integer", "format": "int32" }, { "name": "contentActivitySettingVOList[0].contentActivitySettingContentVOList[0].rightsDetailedVOList[0].rightsName", "in": "query", "description": "权益名称", "required": false, "type": "string" }, { "name": "contentActivitySettingVOList[0].contentActivitySettingContentVOList[0].rightsDetailedVOList[0].rightsType", "in": "query", "description": "类型 1:内容管理权益卡券 2:内容管理推送权益 3:考卷奖励权益 4:推广活动 5:霸屏", "required": false, "type": "integer", "format": "int32" }, { "name": "contentActivitySettingVOList[0].contentActivitySettingContentVOList[0].rightsDetailedVOList[0].selectType", "in": "query", "description": "权益类型 0-权益 2-实物奖品", "required": false, "type": "integer", "format": "int32" }, { "name": "contentActivitySettingVOList[0].contentActivitySettingContentVOList[0].rightsDetailedVOList[0].skuInfoId", "in": "query", "description": "权益id(sku_info表id)", "required": false, "type": "integer", "format": "int64" }, { "name": "contentActivitySettingVOList[0].contentActivitySettingContentVOList[0].rightsId", "in": "query", "description": "权益id", "required": false, "type": "integer", "format": "int64" }, { "name": "contentActivitySettingVOList[0].contentActivitySettingContentVOList[0].sortNumber", "in": "query", "description": "序号", "required": false, "type": "integer", "format": "int32" }, { "name": "contentActivitySettingVOList[0].contentActivitySettingContentVOList[0].systemRights", "in": "query", "description": "系统权益 1:获得金币 2:权益卡券", "required": false, "type": "string" }, { "name": "contentActivitySettingVOList[0].contentActivitySettingContentVOList[0].vehicleModel", "in": "query", "description": "车型", "required": false, "type": "string" }, { "name": "contentActivitySettingVOList[0].contentActivitySettingContentVOList[0].vehicleSeries", "in": "query", "description": "车系", "required": false, "type": "string" }, { "name": "contentActivitySettingVOList[0].unlockActivity", "in": "query", "description": "解锁活动 1:是 2 否", "required": false, "type": "integer", "format": "int32" }, { "name": "contentActivitySettingVOList[0].unlockActivityNumber", "in": "query", "description": "解锁活动设置观看次数可查看活跃活动", "required": false, "type": "integer", "format": "int32" }, { "name": "contentActivitySettingVOList[0].unlockAnswer", "in": "query", "description": "解锁答题 1:是 2 否", "required": false, "type": "integer", "format": "int32" }, { "name": "contentActivitySettingVOList[0].unlockAnswerNumber", "in": "query", "description": "解锁答题设置观看次数可答题", "required": false, "type": "integer", "format": "int32" }, { "name": "contentActivityStatus", "in": "query", "description": "上下架状态 1-上架 2-下架 3-发布", "required": false, "type": "integer", "format": "int32" }, { "name": "contentActivityStatusName", "in": "query", "description": "(查询列表)状态", "required": false, "type": "string" }, { "name": "contentActivityTitle", "in": "query", "description": "内容活动标题", "required": false, "type": "string" }, { "name": "createdTime", "in": "query", "description": "创建时间", "required": false, "type": "string", "format": "date-time" }, { "name": "endCreatedTime", "in": "query", "description": "创建时间结束", "required": false, "type": "string" }, { "name": "endTime", "in": "query", "description": "有效期结束时间", "required": false, "type": "string", "format": "date-time" }, { "name": "from", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "id", "in": "query", "description": "内容活动id", "required": false, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "required": false, "type": "string" }, { "name": "page", "in": "query", "description": "分页", "required": false, "type": "integer", "format": "int32" }, { "name": "size", "in": "query", "description": "每页数量", "required": false, "type": "integer", "format": "int32" }, { "name": "startCreatedTime", "in": "query", "description": "创建时间开始", "required": false, "type": "string" }, { "name": "startTime", "in": "query", "description": "有效期开始时间", "required": false, "type": "string", "format": "date-time" }, { "name": "status", "in": "query", "description": "状态(1-未开始 2-进行中 3-已结束)", "required": false, "type": "integer", "format": "int32" }, { "name": "validityEndTime", "in": "query", "description": "(查询条件)有效期结束", "required": false, "type": "string" }, { "name": "validityStartTime", "in": "query", "description": "(查询条件)有效期开始", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/admin/api/v1/contentActivity/delete": { "post": { "tags": [ "活动内容相关接口" ], "summary": "删除活动内容", "operationId": "ContentActivitydelete", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "ids", "description": "ids", "required": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/公共响应对象" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/admin/api/v1/contentActivity/getContentManagementList": { "get": { "tags": [ "活动内容相关接口" ], "summary": "根据适用用户,车系,车型查询内容管理", "operationId": "ContentActivitygetContentManagementList", "produces": [ "*/*" ], "parameters": [ { "name": "applicableUser", "in": "query", "description": "适用用户(查询适用):1-全选,2-CNS,3-CRS,4-非CNS非CRS,5-车联网用户", "required": false, "type": "integer", "format": "int32" }, { "name": "applicableUserDetailedVOList[0].applicableUser", "in": "query", "description": "适用用户:1-全选,2-CNS,3-CRS,4-非CNS非CRS,5-车联网用户", "required": false, "type": "integer", "format": "int32" }, { "name": "applicableUserDetailedVOList[0].applicableUserType", "in": "query", "description": "类型 1:内容管理-适用用户 2:内容活动-适用用户 3:题库管理-适用用户 4:推广活动-适用用户", "required": false, "type": "integer", "format": "int32" }, { "name": "applicableUserDetailedVOList[0].vehicleModel", "in": "query", "description": "车型", "required": false, "type": "string" }, { "name": "applicableUserDetailedVOList[0].vehicleSeries", "in": "query", "description": "车系", "required": false, "type": "string" }, { "name": "applicableUserName", "in": "query", "description": "适用用户(新增查询适用):1-全选,2-CNS,3-CRS,4-非CNS非CRS,5-车联网用户", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "bannerUrl", "in": "query", "description": "banner图URL", "required": false, "type": "string" }, { "name": "buttonName", "in": "query", "description": "按钮名称", "required": false, "type": "string" }, { "name": "classificationIds", "in": "query", "description": "内容分类", "required": false, "type": "array", "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi" }, { "name": "classificationName", "in": "query", "description": "内容分类(列表查询适用)", "required": false, "type": "string" }, { "name": "contentTitle", "in": "query", "description": "内容标题", "required": false, "type": "string" }, { "name": "createdTime", "in": "query", "description": "创建时间", "required": false, "type": "string", "format": "date-time" }, { "name": "detailsContentImageUrl", "in": "query", "description": "详情内容-图片URL", "required": false, "type": "string" }, { "name": "detailsContentType", "in": "query", "description": "详情内容 1-单视频,2-视频+图片,3-单图片", "required": false, "type": "integer", "format": "int32" }, { "name": "detailsContentVideoUrl", "in": "query", "description": "详情内容-视频URL", "required": false, "type": "string" }, { "name": "displayHoverButtonDetails", "in": "query", "description": "是否显示详情的悬浮按钮 1-显示,2-不显示", "required": false, "type": "integer", "format": "int32" }, { "name": "endCreatedTime", "in": "query", "description": "创建时间结束", "required": false, "type": "string" }, { "name": "from", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "goldCoinNumber", "in": "query", "description": "系统权益-获得金币数量", "required": false, "type": "integer", "format": "int32" }, { "name": "id", "in": "query", "description": "内容管理id", "required": false, "type": "integer", "format": "int64" }, { "name": "internalJumpUrl", "in": "query", "description": "内部跳转URL", "required": false, "type": "string" }, { "name": "lableManagementIds", "in": "query", "description": "标签", "required": false, "type": "array", "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi" }, { "name": "lableManagementName", "in": "query", "description": "标签(列表查询适用)", "required": false, "type": "string" }, { "name": "page", "in": "query", "description": "分页", "required": false, "type": "integer", "format": "int32" }, { "name": "pushContent", "in": "query", "description": "推送内容 1:推送图片 2:推送权益", "required": false, "type": "integer", "format": "int32" }, { "name": "pushImageUrl", "in": "query", "description": "推送图片URL", "required": false, "type": "string" }, { "name": "pushType", "in": "query", "description": "推送 1:观看完毕后推送 2:不推送", "required": false, "type": "integer", "format": "int32" }, { "name": "rightsDetailedVOList[0].rightsImageUrl", "in": "query", "description": "权益图片URL", "required": false, "type": "string" }, { "name": "rightsDetailedVOList[0].rightsInterests", "in": "query", "description": "选择权益",