@sigmaott/base-next 1.0.6

package/src/schemas/billingApi.json

@@ -0,0 +1,1083 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "Sigma Billing System API",
+    "description": "This is a sample swagger for Sigma Billing System API",
+    "contact": {},
+    "license": {
+      "name": "Apache 2.0",
+      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
+    },
+    "version": "1.0"
+  },
+  "servers": [
+    {
+      "url": "/api/billing"
+    }
+  ],
+  "paths": {
+    "/api/billing/app-billings/detail": {
+      "get": {
+        "tags": [
+          "app-billings"
+        ],
+        "summary": "Get app billing detail",
+        "parameters": [
+          {
+            "name": "X-App-Id",
+            "in": "header",
+            "description": "App ID",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/model.AppBillingInfo"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/billing/app-billings/info": {
+      "get": {
+        "tags": [
+          "app-billings"
+        ],
+        "summary": "Get app billing info",
+        "parameters": [
+          {
+            "name": "X-App-Id",
+            "in": "header",
+            "description": "App ID",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/dto.GetAppBillingInfoResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/billing/invoices": {
+      "get": {
+        "tags": [
+          "invoice"
+        ],
+        "summary": "FindAll",
+        "description": "all payment methods",
+        "parameters": [
+          {
+            "name": "X-App-Id",
+            "in": "header",
+            "description": "App ID",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "page",
+            "in": "query",
+            "description": "Number of page",
+            "schema": {
+              "type": "integer"
+            }
+          },
+          {
+            "name": "perPage",
+            "in": "query",
+            "description": "Number of records per page",
+            "schema": {
+              "type": "integer"
+            }
+          },
+          {
+            "name": "issuingDateFrom",
+            "in": "query",
+            "description": "Date from",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "issuingDateTo",
+            "in": "query",
+            "description": "Date to",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "status",
+            "in": "query",
+            "description": "Date to",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "allOf": [
+                    {
+                      "$ref": "#/components/schemas/common.PaginateResponse"
+                    },
+                    {
+                      "type": "object",
+                      "properties": {
+                        "data": {
+                          "type": "array",
+                          "items": {
+                            "$ref": "#/components/schemas/model.Invoice"
+                          }
+                        }
+                      }
+                    }
+                  ]
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/billing/invoices/draft": {
+      "post": {
+        "tags": [
+          "invoice"
+        ],
+        "summary": "Create Draft Invoice",
+        "description": "Create Draft Invoice",
+        "requestBody": {
+          "description": "Request body for CreateDraftInvoice API",
+          "content": {
+            "*/*": {
+              "schema": {
+                "$ref": "#/components/schemas/dto.CreateDraftInvoiceRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/dto.CreateDraftInvoiceResponse"
+                }
+              }
+            }
+          }
+        },
+        "x-codegen-request-body-name": "createDraftInvoiceRequest"
+      }
+    },
+    "/api/billing/invoices/{id}/retry-payment": {
+      "post": {
+        "tags": [
+          "invoice"
+        ],
+        "summary": "Retry payment an invoice by invoiceID",
+        "description": "retry-payment invoice",
+        "parameters": [
+          {
+            "name": "X-App-Id",
+            "in": "header",
+            "description": "App ID",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "id",
+            "in": "path",
+            "description": "model.Invoice ID",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ]
+      }
+    },
+    "/api/billing/payment-methods": {
+      "get": {
+        "tags": [
+          "payment-methods"
+        ],
+        "summary": "FindAll",
+        "description": "all payment methods",
+        "parameters": [
+          {
+            "name": "X-App-Id",
+            "in": "header",
+            "description": "App ID",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "sort",
+            "in": "query",
+            "description": "Use only allowed properties separated by semicolon; default is ascending created_at; prefix name with hyphen/minus sign to get descending order",
+            "style": "form",
+            "explode": false,
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          },
+          {
+            "name": "page",
+            "in": "query",
+            "description": "pagination number",
+            "schema": {
+              "type": "integer"
+            }
+          },
+          {
+            "name": "perPage",
+            "in": "query",
+            "description": "per Page",
+            "schema": {
+              "type": "integer"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "allOf": [
+                    {
+                      "$ref": "#/components/schemas/common.PaginateResponse"
+                    },
+                    {
+                      "type": "object",
+                      "properties": {
+                        "data": {
+                          "type": "array",
+                          "items": {
+                            "$ref": "#/components/schemas/model.PaymentMethod"
+                          }
+                        }
+                      }
+                    }
+                  ]
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/billing/payment-methods/vnpay/cancel-uri": {
+      "get": {
+        "tags": [
+          "vnpay-provider"
+        ],
+        "summary": "Return callback after cancel creating payment method",
+        "responses": {
+          "201": {
+            "description": "Created",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/model.PaymentMethod"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/billing/payment-methods/vnpay/get-form": {
+      "get": {
+        "tags": [
+          "vnpay-provider"
+        ],
+        "summary": "Get VNPay callback to create payment method",
+        "parameters": [
+          {
+            "name": "X-App-Id",
+            "in": "header",
+            "description": "App ID",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "draftInvoiceId",
+            "in": "query",
+            "description": "draft invoice id",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "201": {
+            "description": "Created",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/dto.CreateVNPayCardForm"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/billing/payment-methods/vnpay/ipn-callback": {
+      "get": {
+        "tags": [
+          "vnpay-provider"
+        ],
+        "summary": "Return callback after create payment method has result",
+        "responses": {
+          "201": {
+            "description": "Created",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/model.PaymentMethod"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/billing/payment-methods/vnpay/return-uri": {
+      "get": {
+        "tags": [
+          "vnpay-provider"
+        ],
+        "summary": "Return callback after create payment method",
+        "responses": {
+          "201": {
+            "description": "Created",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/dto.ReturnUriResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/billing/payment-methods/{id}": {
+      "get": {
+        "tags": [
+          "payment-methods"
+        ],
+        "summary": "FindOne a payment-method by ID",
+        "parameters": [
+          {
+            "name": "X-App-Id",
+            "in": "header",
+            "description": "App ID",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "id",
+            "in": "path",
+            "description": "model.PaymentMethod ID",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/model.PaymentMethod"
+                }
+              }
+            }
+          }
+        }
+      },
+      "delete": {
+        "tags": [
+          "payment-methods"
+        ],
+        "summary": "Delete a payment-method by ID",
+        "parameters": [
+          {
+            "name": "X-App-Id",
+            "in": "header",
+            "description": "App ID",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "id",
+            "in": "path",
+            "description": "model.PaymentMethod ID",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/model.PaymentMethod"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/billing/payment-methods/{id}/primary": {
+      "patch": {
+        "tags": [
+          "payment-methods"
+        ],
+        "summary": "SetPrimary payment-method by ID",
+        "parameters": [
+          {
+            "name": "X-App-Id",
+            "in": "header",
+            "description": "App ID",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "id",
+            "in": "path",
+            "description": "model.PaymentMethod ID",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "201": {
+            "description": "Created",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/model.PaymentMethod"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/billing/payment-plans": {
+      "get": {
+        "tags": [
+          "payment-plan"
+        ],
+        "summary": "FindAll",
+        "description": "Get all payment plan",
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/model.Subscription"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/billing/subscriptions": {
+      "get": {
+        "tags": [
+          "subscriptions"
+        ],
+        "summary": "FindAll",
+        "description": "subscriptions",
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "allOf": [
+                    {
+                      "$ref": "#/components/schemas/common.PaginateResponse"
+                    },
+                    {
+                      "type": "object",
+                      "properties": {
+                        "data": {
+                          "type": "array",
+                          "items": {
+                            "$ref": "#/components/schemas/model.Subscription"
+                          }
+                        }
+                      }
+                    }
+                  ]
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/billing/usages": {
+      "get": {
+        "tags": [
+          "usages"
+        ],
+        "summary": "FindOne a usage by appId",
+        "parameters": [
+          {
+            "name": "X-App-Id",
+            "in": "header",
+            "description": "App ID",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/model.UsagePayment"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "common.PaginateResponse": {
+        "type": "object",
+        "properties": {
+          "data": {
+            "type": "object"
+          },
+          "page": {
+            "type": "integer"
+          },
+          "perPage": {
+            "type": "integer"
+          },
+          "total": {
+            "type": "integer"
+          }
+        }
+      },
+      "dto.BillingContract": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string"
+          },
+          "value": {
+            "type": "number"
+          }
+        }
+      },
+      "dto.BillingItem": {
+        "type": "object",
+        "properties": {
+          "billingMetricCode": {
+            "type": "string"
+          },
+          "units": {
+            "type": "number"
+          }
+        }
+      },
+      "dto.BillingItemInfo": {
+        "type": "object",
+        "properties": {
+          "amountCents": {
+            "type": "number"
+          },
+          "billingMetricCode": {
+            "type": "string"
+          },
+          "currency": {
+            "type": "string"
+          },
+          "itemName": {
+            "type": "string"
+          },
+          "unitAmountCents": {
+            "type": "integer"
+          },
+          "units": {
+            "type": "string"
+          }
+        }
+      },
+      "dto.CreateDraftInvoiceRequest": {
+        "type": "object",
+        "properties": {
+          "billingItem": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/dto.BillingItem"
+            }
+          }
+        }
+      },
+      "dto.CreateDraftInvoiceResponse": {
+        "type": "object",
+        "properties": {
+          "billingItemInfo": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/dto.BillingItemInfo"
+            }
+          },
+          "createdAt": {
+            "type": "string"
+          },
+          "currency": {
+            "type": "string"
+          },
+          "tax": {
+            "type": "number"
+          },
+          "totalAmountCents": {
+            "type": "number"
+          }
+        }
+      },
+      "dto.CreateVNPayCardForm": {
+        "type": "object",
+        "properties": {
+          "dataKey": {
+            "type": "string"
+          },
+          "formCardUrl": {
+            "type": "string"
+          },
+          "tmnCode": {
+            "type": "string"
+          },
+          "transactionId": {
+            "type": "string"
+          }
+        }
+      },
+      "dto.GetAppBillingInfoResponse": {
+        "type": "object",
+        "properties": {
+          "contractInfo": {
+            "$ref": "#/components/schemas/dto.BillingContract"
+          },
+          "endOfPeriod": {
+            "type": "string"
+          },
+          "paymentMethod": {
+            "type": "string"
+          },
+          "paymentPeriod": {
+            "type": "string"
+          },
+          "pricingModel": {
+            "type": "string"
+          }
+        }
+      },
+      "dto.ReturnUriResponse": {
+        "type": "object",
+        "properties": {
+          "planCode": {
+            "type": "string"
+          }
+        }
+      },
+      "model.AppBillingInfo": {
+        "type": "object",
+        "properties": {
+          "appID": {
+            "type": "string"
+          },
+          "contract": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/model.ContractInfo"
+            }
+          },
+          "createdAt": {
+            "type": "string"
+          },
+          "id": {
+            "type": "string"
+          },
+          "lagoBillingPlanCode": {
+            "type": "string"
+          },
+          "lagoCustomerID": {
+            "type": "string"
+          },
+          "paymentMethodType": {
+            "type": "string"
+          },
+          "pricingModel": {
+            "$ref": "#/components/schemas/model.PricingModel"
+          },
+          "primaryPaymentMethodId": {
+            "type": "string"
+          },
+          "updatedAt": {
+            "type": "string"
+          }
+        }
+      },
+      "model.ChargesUsage": {
+        "type": "object",
+        "properties": {
+          "chargeModel": {
+            "type": "string"
+          },
+          "code": {
+            "type": "string"
+          },
+          "description": {
+            "type": "string"
+          },
+          "items": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/model.ItemUsage"
+            }
+          },
+          "name": {
+            "type": "string"
+          }
+        }
+      },
+      "model.ContractInfo": {
+        "type": "object",
+        "properties": {
+          "contractName": {
+            "type": "string"
+          },
+          "contractValue": {
+            "type": "number"
+          },
+          "createdAt": {
+            "type": "string"
+          },
+          "id": {
+            "type": "string"
+          },
+          "isPaid": {
+            "type": "boolean"
+          }
+        }
+      },
+      "model.Invoice": {
+        "type": "object",
+        "properties": {
+          "currency": {
+            "type": "string"
+          },
+          "fileUrl": {
+            "type": "string"
+          },
+          "invoiceType": {
+            "type": "string"
+          },
+          "issuingDate": {
+            "type": "string"
+          },
+          "lagoId": {
+            "type": "string"
+          },
+          "number": {
+            "type": "string"
+          },
+          "paymentStatus": {
+            "type": "string",
+            "enum": [
+              "pending",
+              "succeeded",
+              "failed"
+            ]
+          },
+          "sequentialId": {
+            "type": "integer"
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "draft",
+              "finalized"
+            ]
+          },
+          "totalAmountCents": {
+            "type": "string",
+            "description": "FeesAmountCents                int `json:\"feesAmountCents,omitempty\"`\nVatAmountCents                 int `json:\"vatAmountCents,omitempty\"`\nCouponsAmountCents             int `json:\"couponsAmountCents,omitempty\"`\nCreditNotesAmountCents         int `json:\"creditNotesAmountCents,omitempty\"`\nSubTotalVatExcludedAmountCents int `json:\"subTotalVatExcludedAmountCents,omitempty\"`\nSubTotalVatIncludedAmountCents int `json:\"subTotalVatIncludedAmountCents,omitempty\"`"
+          },
+          "totalAmountCurrency": {
+            "type": "string",
+            "description": "// Deprecated: Will be removed in the future\nLegacy            bool          `json:\"legacy,omitempty\"`\nAmountCurrency    lago.Currency `json:\"amountCurrency,omitempty\"`\nAmountCents       int           `json:\"amountCents,omitempty\"`\nCreditAmountCents int           `json:\"creditAmountCents,omitempty\"`\nCreditAmountCurrency lago.Currency `json:\"creditAmountCurrency,omitempty\"`"
+          }
+        }
+      },
+      "model.ItemUsage": {
+        "type": "object",
+        "properties": {
+          "amountCents": {
+            "type": "integer"
+          },
+          "amountCurrency": {
+            "type": "string"
+          },
+          "description": {
+            "type": "string"
+          },
+          "price": {
+            "type": "string"
+          },
+          "units": {
+            "type": "string"
+          }
+        }
+      },
+      "model.PaymentMethod": {
+        "type": "object",
+        "properties": {
+          "appId": {
+            "type": "string"
+          },
+          "bankCode": {
+            "type": "string"
+          },
+          "cardNumber": {
+            "type": "string"
+          },
+          "cardType": {
+            "type": "string",
+            "enum": [
+              "JCB",
+              "MASTERCARD",
+              "UPI",
+              "VISA"
+            ]
+          },
+          "createdAt": {
+            "type": "string"
+          },
+          "expMonth": {
+            "type": "string"
+          },
+          "expYear": {
+            "type": "string"
+          },
+          "id": {
+            "type": "string"
+          },
+          "isPrimary": {
+            "type": "boolean"
+          },
+          "locale": {
+            "type": "string",
+            "enum": [
+              "vn",
+              "en"
+            ]
+          },
+          "provider": {
+            "type": "string",
+            "enum": [
+              "VNPAY"
+            ]
+          },
+          "providerId": {
+            "type": "string"
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "PENDING",
+              "CREATED"
+            ]
+          },
+          "updatedAt": {
+            "type": "string"
+          }
+        }
+      },
+      "model.PricingModel": {
+        "type": "object",
+        "properties": {
+          "endDate": {
+            "type": "string"
+          },
+          "name": {
+            "type": "string"
+          },
+          "recurringType": {
+            "type": "string"
+          },
+          "startDate": {
+            "type": "string"
+          },
+          "type": {
+            "type": "string"
+          }
+        }
+      },
+      "model.Subscription": {
+        "type": "object",
+        "properties": {
+          "canceled_at": {
+            "type": "string"
+          },
+          "created_at": {
+            "type": "string"
+          },
+          "external_customer_id": {
+            "type": "string"
+          },
+          "external_id": {
+            "type": "string"
+          },
+          "lago_customer_id": {
+            "type": "string"
+          },
+          "lago_id": {
+            "type": "string"
+          },
+          "plan_code": {
+            "type": "string"
+          },
+          "started_at": {
+            "type": "string"
+          },
+          "status": {
+            "type": "string"
+          },
+          "terminated_at": {
+            "type": "string"
+          }
+        }
+      },
+      "model.UsagePayment": {
+        "type": "object",
+        "properties": {
+          "amountCents": {
+            "type": "integer"
+          },
+          "amountCurrency": {
+            "type": "string"
+          },
+          "chargesUsage": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/model.ChargesUsage"
+            }
+          },
+          "contractName": {
+            "type": "string"
+          },
+          "contractValue": {
+            "type": "number"
+          },
+          "fromDate": {
+            "type": "string"
+          },
+          "issuingDate": {
+            "type": "string"
+          },
+          "pricingModel": {
+            "type": "string"
+          },
+          "toDate": {
+            "type": "string"
+          },
+          "totalAmountCents": {
+            "type": "integer"
+          },
+          "totalAmountCurrency": {
+            "type": "string"
+          },
+          "vatAmountCents": {
+            "type": "integer"
+          },
+          "vatAmountCurrency": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "securitySchemes": {
+      "BasicAuth": {
+        "type": "http",
+        "scheme": "basic"
+      }
+    }
+  },
+  "x-original-swagger-version": "2.0"
+}