@sigmaott/base-next 1.0.6

package/src/schemas/vastControlApi.json

@@ -0,0 +1,961 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "Sigma Vast Control",
+    "description": "Sigma Vast Control API",
+    "version": "3.x",
+    "contact": {}
+  },
+  "tags": [],
+  "servers": [],
+  "components": {
+    "securitySchemes": {
+      "basic": {
+        "type": "http",
+        "scheme": "basic"
+      }
+    },
+    "schemas": {
+      "CreatePolicyDto": {
+        "type": "object",
+        "properties": {
+          "key": {
+            "type": "string"
+          },
+          "value": {
+            "type": "string"
+          },
+          "isNot": {
+            "type": "boolean"
+          },
+          "policyType": {
+            "type": "string",
+            "enum": [
+              "DEFINED_PARAMETER",
+              "CUSTOM",
+              "SCHEDULE"
+            ]
+          },
+          "startDate": {
+            "format": "date-time",
+            "type": "string"
+          },
+          "endDate": {
+            "format": "date-time",
+            "type": "string"
+          }
+        },
+        "required": [
+          "key",
+          "value",
+          "policyType",
+          "startDate",
+          "endDate"
+        ]
+      },
+      "CreateVastTagDto": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string"
+          },
+          "enable": {
+            "type": "boolean"
+          },
+          "vastTagUrl": {
+            "type": "string"
+          },
+          "allocation": {
+            "type": "number",
+            "minimum": 0,
+            "maximum": 10000
+          },
+          "agency": {
+            "type": "string"
+          },
+          "policies": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/CreatePolicyDto"
+            }
+          },
+          "startDate": {
+            "format": "date-time",
+            "type": "string"
+          },
+          "endDate": {
+            "format": "date-time",
+            "type": "string"
+          }
+        },
+        "required": [
+          "name",
+          "enable",
+          "vastTagUrl",
+          "allocation",
+          "agency",
+          "policies",
+          "startDate",
+          "endDate"
+        ]
+      },
+      "CreateCampaignDto": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string"
+          },
+          "description": {
+            "type": "string"
+          },
+          "vastTags": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/CreateVastTagDto"
+            }
+          },
+          "appId": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "name",
+          "appId"
+        ]
+      },
+      "PolicyEntity": {
+        "type": "object",
+        "properties": {
+          "key": {
+            "type": "string",
+            "filterable": true,
+            "sortable": true
+          },
+          "value": {
+            "type": "string"
+          },
+          "isNot": {
+            "type": "boolean"
+          },
+          "policyType": {
+            "enum": [
+              "DEFINED_PARAMETER",
+              "CUSTOM",
+              "SCHEDULE"
+            ],
+            "type": "string"
+          },
+          "startDate": {
+            "format": "date-time",
+            "type": "string"
+          },
+          "endDate": {
+            "format": "date-time",
+            "type": "string"
+          }
+        },
+        "required": [
+          "value",
+          "isNot",
+          "policyType",
+          "startDate",
+          "endDate"
+        ]
+      },
+      "VastTagEntity": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string",
+            "filterable": true,
+            "sortable": true
+          },
+          "enable": {
+            "type": "boolean"
+          },
+          "vastTagUrl": {
+            "type": "string"
+          },
+          "allocation": {
+            "type": "number"
+          },
+          "agency": {
+            "type": "string"
+          },
+          "policies": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/PolicyEntity"
+            }
+          },
+          "startDate": {
+            "format": "date-time",
+            "type": "string"
+          },
+          "endDate": {
+            "format": "date-time",
+            "type": "string"
+          }
+        },
+        "required": [
+          "enable",
+          "vastTagUrl",
+          "allocation",
+          "agency",
+          "policies",
+          "startDate",
+          "endDate"
+        ]
+      },
+      "CampaignEntity": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "filterable": true
+          },
+          "name": {
+            "type": "string",
+            "filterable": true,
+            "sortable": true
+          },
+          "description": {
+            "type": "string",
+            "filterable": true
+          },
+          "createdAt": {
+            "format": "date-time",
+            "type": "string",
+            "filterable": true,
+            "sortable": true
+          },
+          "updatedAt": {
+            "format": "date-time",
+            "type": "string",
+            "filterable": true,
+            "sortable": true
+          },
+          "vastTags": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/VastTagEntity"
+            }
+          },
+          "appId": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "vastTags",
+          "appId"
+        ]
+      },
+      "CampaignCollection": {
+        "type": "object",
+        "properties": {
+          "data": {
+            "readOnly": true,
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/CampaignEntity"
+            }
+          },
+          "count": {
+            "type": "number",
+            "readOnly": true
+          },
+          "total": {
+            "type": "number",
+            "readOnly": true
+          },
+          "page": {
+            "type": "number",
+            "readOnly": true
+          },
+          "perPage": {
+            "type": "number",
+            "readOnly": true
+          }
+        },
+        "required": [
+          "count",
+          "total",
+          "page",
+          "perPage"
+        ]
+      },
+      "UpdateCampaignDto": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string"
+          },
+          "description": {
+            "type": "string"
+          },
+          "vastTags": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/CreateVastTagDto"
+            }
+          },
+          "appId": {
+            "type": "string"
+          }
+        }
+      },
+      "CreateDefinedParameterDto": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Unique identifier",
+            "format": "uuid"
+          },
+          "key": {
+            "type": "string",
+            "description": "Key of the defined parameter",
+            "example": "maxUsers"
+          },
+          "paramType": {
+            "enum": [
+              "STRING",
+              "NUMBER",
+              "BOOLEAN",
+              "ENUM"
+            ],
+            "type": "string",
+            "description": "Type of the parameter"
+          },
+          "enumValues": {
+            "description": "Possible enum values",
+            "example": [
+              "ADMIN",
+              "USER",
+              "GUEST"
+            ],
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "min": {
+            "type": "number",
+            "description": "Minimum value",
+            "example": 1
+          },
+          "max": {
+            "type": "number",
+            "description": "Maximum value",
+            "example": 100
+          },
+          "appId": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "key",
+          "paramType",
+          "appId"
+        ]
+      },
+      "DefinedParameter": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "filterable": true
+          },
+          "key": {
+            "type": "string",
+            "filterable": true,
+            "sortable": true
+          },
+          "createdAt": {
+            "format": "date-time",
+            "type": "string",
+            "filterable": true,
+            "sortable": true
+          },
+          "updatedAt": {
+            "format": "date-time",
+            "type": "string",
+            "filterable": true,
+            "sortable": true
+          },
+          "paramType": {
+            "enum": [
+              "STRING",
+              "NUMBER",
+              "BOOLEAN",
+              "ENUM"
+            ],
+            "type": "string"
+          },
+          "enumValues": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "min": {
+            "type": "number"
+          },
+          "max": {
+            "type": "number"
+          },
+          "appId": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "paramType",
+          "enumValues",
+          "min",
+          "max",
+          "appId"
+        ]
+      },
+      "DefinedParameterCollection": {
+        "type": "object",
+        "properties": {
+          "data": {
+            "readOnly": true,
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/DefinedParameter"
+            }
+          },
+          "count": {
+            "type": "number",
+            "readOnly": true
+          },
+          "total": {
+            "type": "number",
+            "readOnly": true
+          },
+          "page": {
+            "type": "number",
+            "readOnly": true
+          },
+          "perPage": {
+            "type": "number",
+            "readOnly": true
+          }
+        },
+        "required": [
+          "count",
+          "total",
+          "page",
+          "perPage"
+        ]
+      },
+      "UpdateDefinedParameterDto": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Unique identifier",
+            "format": "uuid"
+          },
+          "key": {
+            "type": "string",
+            "description": "Key of the defined parameter",
+            "example": "maxUsers"
+          },
+          "paramType": {
+            "enum": [
+              "STRING",
+              "NUMBER",
+              "BOOLEAN",
+              "ENUM"
+            ],
+            "type": "string",
+            "description": "Type of the parameter"
+          },
+          "enumValues": {
+            "description": "Possible enum values",
+            "example": [
+              "ADMIN",
+              "USER",
+              "GUEST"
+            ],
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "min": {
+            "type": "number",
+            "description": "Minimum value",
+            "example": 1
+          },
+          "max": {
+            "type": "number",
+            "description": "Maximum value",
+            "example": 100
+          },
+          "appId": {
+            "type": "string"
+          }
+        }
+      }
+    }
+  },
+  "paths": {
+    "/api/app/vast-control/campaigns": {
+      "post": {
+        "operationId": "CampaignController_create",
+        "summary": "Create Campaign",
+        "description": "Create Campaign",
+        "parameters": [],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/CreateCampaignDto"
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object"
+                }
+              }
+            }
+          }
+        },
+        "tags": [
+          "Campaign Resource Api"
+        ]
+      },
+      "get": {
+        "operationId": "CampaignController_findAll",
+        "summary": "Get list Campaign",
+        "description": "Get list Campaign",
+        "parameters": [
+          {
+            "name": "sort",
+            "required": false,
+            "in": "query",
+            "example": "created_at|desc;filename|asc",
+            "description": "Use only allowed properties separated by semicolon; default is ascending created_at; prefix name with hyphen/minus sign to get descending order",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "q",
+            "required": false,
+            "in": "query",
+            "example": "{\"$and\": [{\"isActive\": true}, {\"createdAt\": {\"$ne\": \"2008-10-01T17:04:32\"}}]}",
+            "description": "search conditions ($and, $or with all possible variations)",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "page",
+            "required": false,
+            "in": "query",
+            "example": "1",
+            "description": "pagination number",
+            "schema": {
+              "type": "number"
+            }
+          },
+          {
+            "name": "customFields",
+            "required": false,
+            "in": "query",
+            "example": "{delta:$abs{$subtract:[\"$userData.vipDuration\",$count]}}",
+            "description": "CustomField via addField Mongoose",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "perPage",
+            "required": false,
+            "in": "query",
+            "example": "10",
+            "description": "",
+            "schema": {
+              "type": "number"
+            }
+          },
+          {
+            "name": "fields",
+            "required": false,
+            "in": "query",
+            "example": "id,name,url",
+            "description": "Nevertheless, you may choose that some fields would always be sent along with the requested fields, in the response payload. Like the id for example.",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "populates",
+            "required": false,
+            "in": "query",
+            "example": "author,book",
+            "description": "Nevertheless, you may choose that some fields would always be sent along with the requested fields, in the response payload. Like the id for example.",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/CampaignCollection"
+                }
+              }
+            }
+          }
+        },
+        "tags": [
+          "Campaign Resource Api"
+        ]
+      }
+    },
+    "/api/app/vast-control/campaigns/{id}": {
+      "get": {
+        "operationId": "CampaignController_findOne",
+        "summary": "Get Campaign by Id",
+        "description": "Get Campaign by Id",
+        "parameters": [
+          {
+            "name": "id",
+            "required": true,
+            "in": "path",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/CampaignEntity"
+                }
+              }
+            }
+          }
+        },
+        "tags": [
+          "Campaign Resource Api"
+        ]
+      },
+      "patch": {
+        "operationId": "CampaignController_update",
+        "summary": "Update Campaign by Id",
+        "description": "Update Campaign by Id",
+        "parameters": [
+          {
+            "name": "id",
+            "required": true,
+            "in": "path",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/UpdateCampaignDto"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/CampaignEntity"
+                }
+              }
+            }
+          }
+        },
+        "tags": [
+          "Campaign Resource Api"
+        ]
+      },
+      "delete": {
+        "operationId": "CampaignController_remove",
+        "summary": "Delete Campaign by Id",
+        "description": "Delete Campaign by Id",
+        "parameters": [
+          {
+            "name": "id",
+            "required": true,
+            "in": "path",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/CampaignEntity"
+                }
+              }
+            }
+          }
+        },
+        "tags": [
+          "Campaign Resource Api"
+        ]
+      }
+    },
+    "/api/app/vast-control/defined-parameters": {
+      "post": {
+        "operationId": "DefinedParameterController_create",
+        "summary": "Create DefinedParameter",
+        "description": "Create DefinedParameter",
+        "parameters": [],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/CreateDefinedParameterDto"
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object"
+                }
+              }
+            }
+          }
+        },
+        "tags": [
+          "Defined Parameter Resource Api"
+        ]
+      },
+      "get": {
+        "operationId": "DefinedParameterController_findAll",
+        "summary": "Get list DefinedParameter",
+        "description": "Get list DefinedParameter",
+        "parameters": [
+          {
+            "name": "sort",
+            "required": false,
+            "in": "query",
+            "example": "created_at|desc;filename|asc",
+            "description": "Use only allowed properties separated by semicolon; default is ascending created_at; prefix name with hyphen/minus sign to get descending order",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "q",
+            "required": false,
+            "in": "query",
+            "example": "{\"$and\": [{\"isActive\": true}, {\"createdAt\": {\"$ne\": \"2008-10-01T17:04:32\"}}]}",
+            "description": "search conditions ($and, $or with all possible variations)",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "page",
+            "required": false,
+            "in": "query",
+            "example": "1",
+            "description": "pagination number",
+            "schema": {
+              "type": "number"
+            }
+          },
+          {
+            "name": "customFields",
+            "required": false,
+            "in": "query",
+            "example": "{delta:$abs{$subtract:[\"$userData.vipDuration\",$count]}}",
+            "description": "CustomField via addField Mongoose",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "perPage",
+            "required": false,
+            "in": "query",
+            "example": "10",
+            "description": "",
+            "schema": {
+              "type": "number"
+            }
+          },
+          {
+            "name": "fields",
+            "required": false,
+            "in": "query",
+            "example": "id,name,url",
+            "description": "Nevertheless, you may choose that some fields would always be sent along with the requested fields, in the response payload. Like the id for example.",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "populates",
+            "required": false,
+            "in": "query",
+            "example": "author,book",
+            "description": "Nevertheless, you may choose that some fields would always be sent along with the requested fields, in the response payload. Like the id for example.",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/DefinedParameterCollection"
+                }
+              }
+            }
+          }
+        },
+        "tags": [
+          "Defined Parameter Resource Api"
+        ]
+      }
+    },
+    "/api/app/vast-control/defined-parameters/{id}": {
+      "get": {
+        "operationId": "DefinedParameterController_findOne",
+        "summary": "Get DefinedParameter by Id",
+        "description": "Get DefinedParameter by Id",
+        "parameters": [
+          {
+            "name": "id",
+            "required": true,
+            "in": "path",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/DefinedParameter"
+                }
+              }
+            }
+          }
+        },
+        "tags": [
+          "Defined Parameter Resource Api"
+        ]
+      },
+      "patch": {
+        "operationId": "DefinedParameterController_update",
+        "summary": "Update DefinedParameter by Id",
+        "description": "Update DefinedParameter by Id",
+        "parameters": [
+          {
+            "name": "id",
+            "required": true,
+            "in": "path",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/UpdateDefinedParameterDto"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/DefinedParameter"
+                }
+              }
+            }
+          }
+        },
+        "tags": [
+          "Defined Parameter Resource Api"
+        ]
+      },
+      "delete": {
+        "operationId": "DefinedParameterController_remove",
+        "summary": "Delete DefinedParameter by Id",
+        "description": "Delete DefinedParameter by Id",
+        "parameters": [
+          {
+            "name": "id",
+            "required": true,
+            "in": "path",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/DefinedParameter"
+                }
+              }
+            }
+          }
+        },
+        "tags": [
+          "Defined Parameter Resource Api"
+        ]
+      }
+    }
+  }
+}