Added offer and charge

2025-04-30 12:48:34 +01:00
parent d1b9d80c84
commit 9bec2b2e9f
15 changed files with 775 additions and 28 deletions
@@ -0,0 +1,95 @@
+{
+  "get": {
+    "tags": ["Charges"],
+    "summary": "Get all charges with optional filtering",
+    "description": "Retrieve charges with various filter options including offer ID, charge code, etc.",
+    "operationId": "getCharges",
+    "parameters": [
+      {
+        "name": "offer_id",
+        "in": "query",
+        "description": "Filter by offer ID",
+        "required": false,
+        "schema": {
+          "type": "string"
+        },
+        "example": "SAL30"
+      },
+      {
+        "name": "code",
+        "in": "query",
+        "description": "Filter by charge code",
+        "required": false,
+        "schema": {
+          "type": "string"
+        },
+        "example": "INTEREST"
+      },
+      {
+        "name": "start_date",
+        "in": "query",
+        "description": "Filter by start date (ISO format)",
+        "required": false,
+        "schema": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "example": "2023-01-01T00:00:00Z"
+      },
+      {
+        "name": "end_date",
+        "in": "query",
+        "description": "Filter by end date (ISO format)",
+        "required": false,
+        "schema": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "example": "2023-12-31T23:59:59Z"
+      },
+      {
+        "name": "page",
+        "in": "query",
+        "description": "Page number for pagination",
+        "required": false,
+        "schema": {
+          "type": "integer",
+          "default": 1,
+          "minimum": 1
+        },
+        "example": 1
+      },
+      {
+        "name": "limit",
+        "in": "query",
+        "description": "Number of items per page (max 100)",
+        "required": false,
+        "schema": {
+          "type": "integer",
+          "default": 20,
+          "minimum": 1,
+          "maximum": 100
+        },
+        "example": 20
+      }
+    ],
+    "responses": {
+      "200": {
+        "description": "Successful operation",
+        "content": {
+          "application/json": {
+            "schema": {
+              "$ref": "../schemas/ChargesResponse.json"
+            }
+          }
+        }
+      },
+      "400": {
+        "description": "Invalid request"
+      },
+      "500": {
+        "description": "Internal server error"
+      }
+    }
+  }
+}
@@ -0,0 +1,95 @@
+{
+  "get": {
+    "tags": ["Offers"],
+    "summary": "Get all offers with optional filtering",
+    "description": "Retrieve offers with various filter options including offer ID, product ID, etc.",
+    "operationId": "getOffers",
+    "parameters": [
+      {
+        "name": "id",
+        "in": "query",
+        "description": "Filter by offer ID",
+        "required": false,
+        "schema": {
+          "type": "string"
+        },
+        "example": "SAL30"
+      },
+      {
+        "name": "product_id",
+        "in": "query",
+        "description": "Filter by product ID",
+        "required": false,
+        "schema": {
+          "type": "string"
+        },
+        "example": "2030"
+      },
+      {
+        "name": "start_date",
+        "in": "query",
+        "description": "Filter by start date (ISO format)",
+        "required": false,
+        "schema": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "example": "2023-01-01T00:00:00Z"
+      },
+      {
+        "name": "end_date",
+        "in": "query",
+        "description": "Filter by end date (ISO format)",
+        "required": false,
+        "schema": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "example": "2023-12-31T23:59:59Z"
+      },
+      {
+        "name": "page",
+        "in": "query",
+        "description": "Page number for pagination",
+        "required": false,
+        "schema": {
+          "type": "integer",
+          "default": 1,
+          "minimum": 1
+        },
+        "example": 1
+      },
+      {
+        "name": "limit",
+        "in": "query",
+        "description": "Number of items per page (max 100)",
+        "required": false,
+        "schema": {
+          "type": "integer",
+          "default": 20,
+          "minimum": 1,
+          "maximum": 100
+        },
+        "example": 20
+      }
+    ],
+    "responses": {
+      "200": {
+        "description": "Successful operation",
+        "content": {
+          "application/json": {
+            "schema": {
+              "$ref": "../schemas/OffersResponse.json"
+            }
+          }
+        }
+      },
+      "400": {
+        "description": "Invalid request"
+      },
+      "500": {
+        "description": "Internal server error"
+      }
+    }
+  }
+}
@@ -25,6 +25,16 @@
        },
        "example": "101"
      },
+      {
+        "name": "transaction_id",
+        "in": "query",
+        "description": "Filter by transaction ID",
+        "required": false,
+        "schema": {
+          "type": "string"
+        },
+        "example": "TRX789"
+      },
      {
        "name": "paid",
        "in": "query",