Rezoo
/
niki
forked from ebhomengo/niki
1
0
Fork 0
Code Pull Requests Activity
niki/docs/docs.go

3980 lines
133 KiB
Go
Raw Normal View History

feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
// Package docs Code generated by swaggo/swag. DO NOT EDIT
package docs
import "github.com/swaggo/swag"
const docTemplate = `{
"schemes": {{ marshal .Schemes }},
"swagger": "2.0",
"info": {
"description": "{{escape .Description}}",
"title": "{{.Title}}",
"contact": {},
"version": "{{.Version}}"
},
"host": "{{.Host}}",
"basePath": "{{.BasePath}}",
"paths": {
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"/admins/agents": {
feat(niki): add benefactor get address
2024-06-01 00:29:11 +00:00
"get": {
"security": [
{
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"AuthBearerAdmin": []
feat(niki): add benefactor get address
2024-06-01 00:29:11 +00:00
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"Admins"
feat(niki): add benefactor get address
2024-06-01 00:29:11 +00:00
],
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"summary": "Get all agents by admin",
feat(niki): add benefactor get address
2024-06-01 00:29:11 +00:00
"responses": {
"200": {
"description": "OK",
"schema": {
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"$ref": "#/definitions/adminagentparam.GetAllAgentResponse"
feat(niki): add benefactor edit address
2024-06-06 17:54:56 +00:00
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "string"
}
}
}
}
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"/admins/kindboxes": {
feat(niki): get all kindboxes by admin
2024-07-09 17:17:04 +00:00
"get": {
"security": [
{
"AuthBearerAdmin": []
}
],
"description": "Retrieves a list of all KindBoxes with filtering, sorting, and pagination options",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"Admins KindBoxes"
feat(niki): get all kindboxes by admin
2024-07-09 17:17:04 +00:00
],
"summary": "Get all KindBoxes by admin",
"parameters": [
{
"type": "integer",
"description": "Filter by ID",
"name": "filter_id",
"in": "query"
},
{
"type": "integer",
"description": "Filter by KindBox request ID",
"name": "filter_kind_box_req_id",
"in": "query"
},
{
"type": "integer",
"description": "Filter by benefactor ID",
"name": "filter_benefactor_id",
"in": "query"
},
{
"enum": [
"on-table",
"cylindrical",
"stand-up"
],
"type": "string",
"description": "Filter by KindBox type",
"name": "filter_kind_box_type",
"in": "query"
},
{
"type": "integer",
"description": "Filter by amount",
"name": "filter_amount",
"in": "query"
},
{
"type": "string",
"description": "Filter by serial number",
"name": "filter_serial_number",
"in": "query"
},
{
"enum": [
"delivered",
"ready-to-return",
"assigned-receiver-agent",
"returned",
"enumerated"
],
"type": "string",
"description": "Filter by status",
"name": "filter_status",
"in": "query"
},
{
"type": "string",
"format": "date-time",
"description": "Filter by delivered at",
"name": "filter_delivered_at",
"in": "query"
},
{
"type": "integer",
"description": "Filter by return refer time ID",
"name": "filter_return_refer_time_id",
"in": "query"
},
{
"type": "string",
"format": "date",
"description": "Filter by return refer date",
"name": "filter_return_refer_date",
"in": "query"
},
{
"type": "integer",
"description": "Filter by return address ID",
"name": "filter_return_address_id",
"in": "query"
},
{
"type": "integer",
"description": "Filter by receiver agent ID",
"name": "filter_receiver_agent_id",
"in": "query"
},
{
"type": "string",
"format": "date-time",
"description": "Filter by returned at",
"name": "filter_returned_at",
"in": "query"
},
{
"type": "integer",
"description": "Filter by sender agent ID",
"name": "filter_sender_agent_id",
"in": "query"
},
{
"type": "string",
"format": "date",
"description": "Filter by deliver refer date",
"name": "filter_deliver_refer_date",
"in": "query"
},
{
"type": "integer",
"description": "Filter by deliver address ID",
"name": "filter_deliver_address_id",
"in": "query"
},
feat(niki): benefactor get/getall kindbox sort/filter/pagination
2024-07-21 13:38:54 +00:00
{
"type": "integer",
"description": "Filter by deliver refer time ID",
"name": "filter_deliver_refer_time_id",
"in": "query"
},
feat(niki): get all kindboxes by admin
2024-07-09 17:17:04 +00:00
{
"type": "integer",
"description": "Page number",
"name": "page_number",
"in": "query"
},
{
"type": "integer",
"description": "Page size",
"name": "page_size",
"in": "query"
},
{
"enum": [
"id",
"kind_box_req_id",
"benefactor_id",
"kind_box_type",
"amount",
"serial_number",
"status",
"delivered_at",
"return_refer_time_id",
"return_refer_date",
"return_address_id",
"receiver_agent_id",
"returned_at",
"sender_agent_id",
"deliver_refer_date",
feat(niki): benefactor get/getall kindbox sort/filter/pagination
2024-07-21 13:38:54 +00:00
"deliver_address_id",
"deliver_refer_time_id"
feat(niki): get all kindboxes by admin
2024-07-09 17:17:04 +00:00
],
"type": "string",
"description": "Sort by field",
"name": "sort_field",
"in": "query"
},
{
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort order",
"name": "sort_direction",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/adminkindboxparam.KindBoxGetAllResponse"
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "string"
}
}
}
}
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"/admins/kindboxes/{id}": {
"get": {
feat(niki): admin get kindbox
2024-07-01 17:13:28 +00:00
"security": [
{
"AuthBearerAdmin": []
}
],
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"description": "This endpoint retrieves a specific kind box by admin",
feat(niki): admin get kindbox
2024-07-01 17:13:28 +00:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"Admins KindBoxes"
feat(niki): admin get kindbox
2024-07-01 17:13:28 +00:00
],
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"summary": "Get a specific kind box by admin",
feat(niki): admin get kindbox
2024-07-01 17:13:28 +00:00
"parameters": [
{
"type": "integer",
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"description": "Kind box ID",
feat(niki): admin get kindbox
2024-07-01 17:13:28 +00:00
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/adminkindboxparam.KindBoxGetResponse"
}
feat(niki): admin get kindbox
2024-07-01 17:13:28 +00:00
},
"400": {
"description": "Bad request",
"schema": {
"type": "string"
}
}
}
}
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"/admins/kindboxes/{id}/assign-receiver-agent": {
"patch": {
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
"security": [
{
"AuthBearerAdmin": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"Admins KindBoxes"
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
],
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"summary": "Admin assign receiver agent to kindbox",
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
"parameters": [
{
"type": "integer",
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"description": "KindBox ID",
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
"name": "id",
"in": "path",
"required": true
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
},
{
"description": "Assign Receiver Agent Request Body",
"name": "Request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/adminkindboxparam.AssignReceiverRequest"
}
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
}
],
"responses": {
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"204": {
"description": "No Content"
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
},
"400": {
"description": "Bad request",
"schema": {
"type": "string"
}
}
}
}
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"/admins/kindboxes/{id}/enumerate": {
feat(niki): admin enumerate(count) kindbox amount (#80)
2024-07-23 21:37:27 +00:00
"patch": {
"security": [
{
"AuthBearerAdmin": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"Admins KindBoxes"
feat(niki): admin enumerate(count) kindbox amount (#80)
2024-07-23 21:37:27 +00:00
],
"summary": "Admin enumerate kindbox",
"parameters": [
{
"type": "integer",
"description": "KindBox ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "Request",
"name": "Request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/adminkindboxparam.EnumerateKindBoxRequest"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"schema": {
"type": "string"
}
},
"401": {
"description": "invalid or expired jwt",
"schema": {
"type": "string"
}
},
"403": {
"description": "user not allowed",
"schema": {
"type": "string"
}
},
"422": {
"description": "Unprocessable Entity",
"schema": {
"$ref": "#/definitions/httpmsg.ErrorResponse"
}
},
"500": {
"description": "something went wrong",
"schema": {
"type": "string"
}
}
}
}
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"/admins/kindboxreqs": {
"get": {
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
"security": [
{
"AuthBearerAdmin": []
}
],
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"description": "Retrieves a list of all KindBox requests with filtering, sorting, and pagination options",
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"Admins KindBoxReqs"
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
],
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"summary": "Admin get all kindboxreq",
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
"parameters": [
{
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"type": "integer",
"description": "Filter by ID",
"name": "filter_id",
"in": "query"
},
{
"type": "integer",
"description": "Filter by benefactor ID",
"name": "filter_benefactor_id",
"in": "query"
},
{
"type": "integer",
"description": "Filter by sender agent ID",
"name": "filter_sender_agent_id",
"in": "query"
},
{
"enum": [
"on-table",
"cylindrical",
"stand-up"
],
"type": "string",
"format": "enum",
"description": "Filter by KindBox type",
"name": "filter_kind_box_type",
"in": "query"
},
{
"enum": [
"pending",
"accepted",
"assigned-sender-agent",
"rejected",
"delivered"
],
"type": "string",
"format": "enum",
"description": "Filter by KindBoxReq status",
"name": "filter_status",
"in": "query"
},
{
"type": "integer",
"description": "Filter by count requested",
"name": "filter_count_requested",
"in": "query"
},
{
"type": "integer",
"description": "Filter by count accepted",
"name": "filter_count_accepted",
"in": "query"
},
{
"type": "integer",
"description": "Filter by deliver refer time ID",
"name": "filter_deliver_refer_time_id",
"in": "query"
},
{
"type": "string",
"format": "date",
"description": "Filter by deliver refer date",
"name": "filter_deliver_refer_date",
"in": "query"
},
{
"type": "integer",
"description": "Filter by deliver address ID",
"name": "filter_deliver_address_id",
"in": "query"
},
{
"type": "string",
"format": "date",
"description": "Filter by delivered at",
"name": "filter_delivered_at",
"in": "query"
},
{
"type": "integer",
"description": "Page number",
"name": "page_number",
"in": "query"
},
{
"type": "integer",
"description": "Page size",
"name": "page_size",
"in": "query"
},
{
"enum": [
"id",
"benefactor_id",
"sender_agent_id",
"kind_box_type",
"status",
"count_requested",
"count_accepted",
"deliver_refer_time_id",
"deliver_refer_date",
"deliver_address_id",
"delivered_at"
],
"type": "string",
"description": "Sort by field",
"name": "sort_field",
"in": "query"
},
{
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort order",
"name": "sort_direction",
"in": "query"
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"$ref": "#/definitions/adminkindboxreqparam.KindBoxReqGetAllResponse"
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
}
},
"400": {
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"description": "Bad Request",
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
"schema": {
"type": "string"
}
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"401": {
"description": "invalid or expired jwt",
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"schema": {
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"type": "string"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
}
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
},
"403": {
"description": "user not allowed",
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"schema": {
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"type": "string"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
}
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"422": {
"description": "Unprocessable Entity",
"schema": {
"$ref": "#/definitions/httpmsg.ErrorResponse"
}
},
"500": {
"description": "something went wrong",
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"schema": {
"type": "string"
}
}
}
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
},
"post": {
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"security": [
{
"AuthBearerAdmin": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"Admins KindBoxReqs"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
],
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"summary": "Add a new kind box request for a benefactor by admin",
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"parameters": [
{
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"description": "New kind box request details",
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"name": "Request",
"in": "body",
"required": true,
"schema": {
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"$ref": "#/definitions/adminkindboxreqparam.KindBoxReqAddRequest"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"$ref": "#/definitions/adminkindboxreqparam.KindBoxReqAddResponse"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "string"
}
}
}
}
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"/admins/kindboxreqs/awaiting-delivery": {
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
"get": {
"security": [
{
"AuthBearerAdmin": []
}
],
"description": "Retrieves a list of all awaiting KindBox requests with filtering, sorting, and pagination options",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"Admins KindBoxReqs"
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
],
"summary": "Get all awaiting delivery KindBox requests",
"parameters": [
{
"type": "integer",
"description": "Filter by ID",
"name": "filter_id",
"in": "query"
},
{
"type": "integer",
"description": "Filter by benefactor ID",
"name": "filter_benefactor_id",
"in": "query"
},
{
"enum": [
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"on-table",
"cylindrical",
"stand-up"
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
],
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "string",
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
"format": "enum",
"description": "Filter by KindBox type",
"name": "filter_kind_box_type",
"in": "query"
},
{
"type": "integer",
"description": "Filter by count requested",
"name": "filter_count_requested",
"in": "query"
},
{
"type": "integer",
"description": "Filter by count accepted",
"name": "filter_count_accepted",
"in": "query"
},
{
"type": "integer",
"description": "Filter by deliver refer time ID",
"name": "filter_deliver_refer_time_id",
"in": "query"
},
{
"type": "string",
"format": "date",
"description": "Filter by deliver refer date",
"name": "filter_deliver_refer_date",
"in": "query"
},
{
"type": "integer",
"description": "Filter by deliver address ID",
"name": "filter_deliver_address_id",
"in": "query"
},
{
"type": "integer",
"description": "Page number",
"name": "page_number",
"in": "query"
},
{
"type": "integer",
"description": "Page size",
"name": "page_size",
"in": "query"
},
{
"enum": [
"id",
"benefactor_id",
"kind_box_type",
"count_requested",
"count_accepted",
"deliver_refer_time_id",
"deliver_refer_date",
"deliver_address_id"
],
"type": "string",
"description": "Sort by field",
"name": "sort_field",
"in": "query"
},
{
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort order",
"name": "sort_direction",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/adminkindboxreqparam.DeliveryAwaitingGetAllResponse"
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "string"
}
}
}
}
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"/admins/kindboxreqs/awaiting-delivery/{id}": {
feat(niki): add get an awaiting-for-delivery kindbox request by agent
2024-06-10 22:54:16 +00:00
"get": {
"security": [
{
"AuthBearerAdmin": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"Admins KindBoxReqs"
feat(niki): add get an awaiting-for-delivery kindbox request by agent
2024-06-10 22:54:16 +00:00
],
"summary": "Get a kind box reqs that is awaiting delivery by agent",
"parameters": [
{
"type": "integer",
"description": "KindBoxReq ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/adminkindboxreqparam.DeliveryAwaitingGetResponse"
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "string"
}
}
}
}
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"/admins/kindboxreqs/{id}": {
"get": {
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"security": [
{
"AuthBearerAdmin": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"Admins KindBoxReqs"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
],
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"summary": "Get a specific kind box req by ID",
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"parameters": [
{
"type": "integer",
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"description": "KindBoxReq ID",
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"$ref": "#/definitions/adminkindboxreqparam.GetKindBoxReqResponse"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
}
},
"400": {
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"description": "Bad Request",
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"schema": {
"type": "string"
}
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"401": {
"description": "invalid or expired jwt",
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"schema": {
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"type": "string"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
}
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
},
"403": {
"description": "user not allowed",
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"schema": {
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"type": "string"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
}
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"422": {
"description": "Unprocessable Entity",
"schema": {
"$ref": "#/definitions/httpmsg.ErrorResponse"
}
},
"500": {
"description": "something went wrong",
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"schema": {
"type": "string"
}
}
}
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
},
fix(niki): update kindbox request by admin
2024-07-10 01:21:03 +00:00
"put": {
"security": [
{
"AuthBearerAdmin": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"Admins KindBoxReqs"
fix(niki): update kindbox request by admin
2024-07-10 01:21:03 +00:00
],
"summary": "Update kind box request by admin",
"parameters": [
{
"type": "integer",
"description": "KindBoxReq ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "Update KindBoxReq Request Body",
"name": "Request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/adminkindboxreqparam.KindBoxReqUpdateRequest"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad request",
"schema": {
"type": "string"
}
}
}
}
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"/admins/kindboxreqs/{id}/accept-kind-box-req": {
"patch": {
feat(niki): add get all agents by admin
2024-06-10 14:49:13 +00:00
"security": [
{
"AuthBearerAdmin": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"Admins KindBoxReqs"
],
"summary": "Accept kind box request by admin",
"parameters": [
{
"type": "integer",
"description": "KindBoxReq ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "Accept KindBoxReq Request Body",
"name": "Request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/adminkindboxreqparam.KindBoxReqAcceptRequest"
}
}
feat(niki): add get all agents by admin
2024-06-10 14:49:13 +00:00
],
"responses": {
"200": {
"description": "OK",
"schema": {
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"$ref": "#/definitions/adminkindboxreqparam.KindBoxReqAcceptResponse"
feat(niki): add get all agents by admin
2024-06-10 14:49:13 +00:00
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "string"
}
}
}
}
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"/admins/kindboxreqs/{id}/assign-sender-agent": {
"patch": {
feat(niki): implement validation and generate swagger docs
2024-07-21 13:10:22 +00:00
"security": [
{
"AuthBearerAdmin": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"Admins KindBoxReqs"
feat(niki): implement validation and generate swagger docs
2024-07-21 13:10:22 +00:00
],
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"summary": "Admin Assign Sender Agent to kindboxreq",
feat(niki): implement validation and generate swagger docs
2024-07-21 13:10:22 +00:00
"parameters": [
{
"type": "integer",
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"description": "KindBoxReq ID",
"name": "id",
"in": "path",
"required": true
feat(niki): implement validation and generate swagger docs
2024-07-21 13:10:22 +00:00
},
{
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"description": "Assign Sender Agent Request Body",
"name": "Request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/adminkindboxreqparam.AssignSenderRequest"
}
feat(niki): implement validation and generate swagger docs
2024-07-21 13:10:22 +00:00
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"$ref": "#/definitions/adminkindboxreqparam.AssignSenderResponse"
feat(niki): implement validation and generate swagger docs
2024-07-21 13:10:22 +00:00
}
},
"400": {
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"description": "Bad request",
feat(niki): implement validation and generate swagger docs
2024-07-21 13:10:22 +00:00
"schema": {
"type": "string"
}
}
}
}
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"/admins/kindboxreqs/{id}/deliver-kind-box-req": {
"patch": {
feat(niki): implement get kind box req by id for admin
2024-07-21 14:16:01 +00:00
"security": [
{
"AuthBearerAdmin": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"Admins KindBoxReqs"
feat(niki): implement get kind box req by id for admin
2024-07-21 14:16:01 +00:00
],
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"summary": "Admin deliver a kindboxreq",
feat(niki): implement get kind box req by id for admin
2024-07-21 14:16:01 +00:00
"parameters": [
{
"type": "integer",
"description": "KindBoxReq ID",
"name": "id",
"in": "path",
"required": true
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
},
{
"description": "KindBoxReq deliver request details",
"name": "Request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/adminkindboxreqparam.DeliverKindBoxReqRequest"
}
feat(niki): implement get kind box req by id for admin
2024-07-21 14:16:01 +00:00
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"$ref": "#/definitions/adminkindboxreqparam.DeliverKindBoxReqResponse"
feat(niki): implement get kind box req by id for admin
2024-07-21 14:16:01 +00:00
}
},
"400": {
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"description": "Bad request",
feat(niki): implement get kind box req by id for admin
2024-07-21 14:16:01 +00:00
"schema": {
"type": "string"
}
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
}
}
}
},
"/admins/kindboxreqs/{id}/reject-kind-box-req": {
"patch": {
"security": [
{
"AuthBearerAdmin": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Admins KindBoxReqs"
],
"summary": "Reject a kindboxreq by admin",
"parameters": [
{
"type": "integer",
"description": "KindBoxReq id",
"name": "id",
"in": "path",
"required": true
feat(niki): implement get kind box req by id for admin
2024-07-21 14:16:01 +00:00
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
{
"description": "KindBoxReq Reject Request Body",
"name": "Request",
"in": "body",
"required": true,
feat(niki): implement get kind box req by id for admin
2024-07-21 14:16:01 +00:00
"schema": {
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"$ref": "#/definitions/adminkindboxreqparam.KindBoxReqRejectRequest"
feat(niki): implement get kind box req by id for admin
2024-07-21 14:16:01 +00:00
}
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
}
],
"responses": {
"200": {
"description": "OK",
feat(niki): implement get kind box req by id for admin
2024-07-21 14:16:01 +00:00
"schema": {
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"$ref": "#/definitions/adminkindboxreqparam.KindBoxReqRejectResponse"
feat(niki): implement get kind box req by id for admin
2024-07-21 14:16:01 +00:00
}
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"400": {
"description": "Bad request",
feat(niki): implement get kind box req by id for admin
2024-07-21 14:16:01 +00:00
"schema": {
"type": "string"
}
}
}
}
},
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"/admins/login-by-phone": {
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"Admins"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
],
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"summary": "Admin login by\tPhoneNumber",
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"parameters": [
{
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"description": "Admin login request body",
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"name": "Request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/adminserviceparam.LoginWithPhoneNumberRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/adminserviceparam.LoginWithPhoneNumberResponse"
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "string"
}
}
}
}
},
"/admins/register": {
"post": {
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"security": [
{
"AuthBearerAdmin": []
}
],
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"Admins"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
],
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"summary": "Register an admin by super-admin",
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"parameters": [
{
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"description": "Admin Register Request Body",
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"name": "Request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/adminserviceparam.RegisterRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/adminserviceparam.RegisterResponse"
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "string"
}
}
}
}
},
feat(niki): agent get all return awaiting kindboxes (#82)
2024-07-14 08:58:37 +00:00
"/agents/kindboxes": {
"get": {
"security": [
{
"AuthBearerAdmin": []
}
],
"description": "Retrieves a list of all awaiting return KindBoxes for agent with filtering, sorting, and pagination options",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"Agents KindBoxes"
feat(niki): agent get all return awaiting kindboxes (#82)
2024-07-14 08:58:37 +00:00
],
"summary": "Get all awaiting return KindBoxes by agent",
"parameters": [
{
"type": "integer",
"description": "Filter by ID",
"name": "filter_id",
"in": "query"
},
{
"type": "integer",
"description": "Filter by benefactor ID",
"name": "filter_benefactor_id",
"in": "query"
},
{
"enum": [
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"on-table",
"cylindrical",
"stand-up"
feat(niki): agent get all return awaiting kindboxes (#82)
2024-07-14 08:58:37 +00:00
],
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "string",
feat(niki): agent get all return awaiting kindboxes (#82)
2024-07-14 08:58:37 +00:00
"format": "enum",
"description": "Filter by KindBox type",
"name": "filter_type",
"in": "query"
},
{
"type": "string",
"description": "Filter by serial number",
"name": "filter_serial_number",
"in": "query"
},
{
"type": "integer",
"description": "Filter by return refer time ID",
"name": "filter_return_refer_time_id",
"in": "query"
},
{
"type": "string",
"format": "date",
"description": "Filter by return refer date",
"name": "filter_return_refer_date",
"in": "query"
},
{
"type": "integer",
"description": "Filter by return address ID",
"name": "filter_return_address_id",
"in": "query"
},
{
"type": "integer",
"description": "Page number",
"name": "page_number",
"in": "query"
},
{
"type": "integer",
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"description": "Page size",
"name": "page_size",
"in": "query"
},
{
"enum": [
"id",
"benefactor_id",
"type",
"serial_number",
"return_refer_time_id",
"return_refer_date",
"return_address_id"
],
"type": "string",
"description": "Sort by field",
"name": "sort_field",
"in": "query"
},
{
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort order",
"name": "sort_direction",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/agentkindboxparam.GetAllResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"type": "string"
}
},
"401": {
"description": "invalid or expired jwt",
"schema": {
"type": "string"
}
},
"403": {
"description": "user not allowed",
"schema": {
"type": "string"
}
},
"422": {
"description": "Unprocessable Entity",
"schema": {
"$ref": "#/definitions/httpmsg.ErrorResponse"
}
},
"500": {
"description": "something went wrong",
"schema": {
"type": "string"
}
}
}
}
},
"/agents/kindboxes/{id}": {
"get": {
"security": [
{
"AuthBearerAdmin": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Agents KindBoxes"
],
"summary": "Get a kind box that is awaiting return by agent",
"parameters": [
{
"type": "integer",
"description": "KindBox ID",
"name": "id",
"in": "path",
"required": true
feat(niki): agent get all return awaiting kindboxes (#82)
2024-07-14 08:58:37 +00:00
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"$ref": "#/definitions/agentkindboxparam.GetKindBoxResponse"
feat(niki): agent get all return awaiting kindboxes (#82)
2024-07-14 08:58:37 +00:00
}
},
"400": {
"description": "Bad Request",
"schema": {
"type": "string"
}
},
"401": {
"description": "invalid or expired jwt",
"schema": {
"type": "string"
}
},
"403": {
"description": "user not allowed",
"schema": {
"type": "string"
}
},
"422": {
"description": "Unprocessable Entity",
"schema": {
"$ref": "#/definitions/httpmsg.ErrorResponse"
}
},
"500": {
"description": "something went wrong",
"schema": {
"type": "string"
}
}
}
}
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"/agents/kindboxes/{id}/return": {
feat(niki): return kindbox from benefactor by agent (#83)
2024-07-16 11:47:09 +00:00
"patch": {
"security": [
{
"AuthBearerAdmin": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"Agents KindBoxes"
feat(niki): return kindbox from benefactor by agent (#83)
2024-07-16 11:47:09 +00:00
],
"summary": "Return KindBox from benefactor by agent",
"parameters": [
{
"type": "integer",
"description": "KindBox ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "Return KindBox Request Body",
"name": "Request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/agentkindboxparam.ReturnKindBoxRequest"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"schema": {
"type": "string"
}
},
"401": {
"description": "invalid or expired jwt",
"schema": {
"type": "string"
}
},
"403": {
"description": "user not allowed",
"schema": {
"type": "string"
}
},
"422": {
"description": "Unprocessable Entity",
"schema": {
"$ref": "#/definitions/httpmsg.ErrorResponse"
}
},
"500": {
"description": "something went wrong",
"schema": {
"type": "string"
}
}
}
}
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"/benefactors/addresses": {
feat(niki): agent get return awaiting kindbox (#81)
2024-07-13 12:33:07 +00:00
"get": {
"security": [
{
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"AuthBearerBenefactor": []
feat(niki): agent get return awaiting kindbox (#81)
2024-07-13 12:33:07 +00:00
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"Benefactors Addresses"
feat(niki): agent get return awaiting kindbox (#81)
2024-07-13 12:33:07 +00:00
],
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"summary": "Get all benefactor addresses",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/addressparam.GetAllAddressesResponse"
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "string"
}
}
}
},
"post": {
"security": [
{
"AuthBearerBenefactor": []
}
],
"description": "This endpoint allows an authenticated benefactor to add a new address to their account.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Benefactors Addresses"
],
"summary": "Add a new address for a benefactor",
feat(niki): agent get return awaiting kindbox (#81)
2024-07-13 12:33:07 +00:00
"parameters": [
{
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"description": "New address details",
"name": "Request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/addressparam.BenefactorAddAddressRequest"
}
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/addressparam.BenefactorAddAddressResponse"
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "string"
}
feat(niki): agent get return awaiting kindbox (#81)
2024-07-13 12:33:07 +00:00
}
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
}
}
},
"/benefactors/addresses/cities": {
"get": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Benefactors Addresses"
feat(niki): agent get return awaiting kindbox (#81)
2024-07-13 12:33:07 +00:00
],
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"summary": "Get all cities",
feat(niki): agent get return awaiting kindbox (#81)
2024-07-13 12:33:07 +00:00
"responses": {
"200": {
"description": "OK",
"schema": {
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"$ref": "#/definitions/addressparam.GetAllCitiesResponse"
feat(niki): agent get return awaiting kindbox (#81)
2024-07-13 12:33:07 +00:00
}
},
"400": {
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"description": "Bad request",
feat(niki): agent get return awaiting kindbox (#81)
2024-07-13 12:33:07 +00:00
"schema": {
"type": "string"
}
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
}
}
}
},
"/benefactors/addresses/provinces": {
"get": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Benefactors Addresses"
],
"summary": "Get all provinces",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/addressparam.GetAllProvincesResponse"
}
feat(niki): agent get return awaiting kindbox (#81)
2024-07-13 12:33:07 +00:00
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"400": {
"description": "Bad request",
feat(niki): agent get return awaiting kindbox (#81)
2024-07-13 12:33:07 +00:00
"schema": {
"type": "string"
}
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
}
}
}
},
"/benefactors/addresses/{id}": {
"get": {
"security": [
{
"AuthBearerBenefactor": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Benefactors Addresses"
],
"summary": "Get a benefactor address",
"parameters": [
{
"type": "integer",
"description": "Address ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/addressparam.GetAddressResponse"
}
feat(niki): agent get return awaiting kindbox (#81)
2024-07-13 12:33:07 +00:00
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"400": {
"description": "Bad request",
feat(niki): agent get return awaiting kindbox (#81)
2024-07-13 12:33:07 +00:00
"schema": {
"type": "string"
}
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
}
}
},
"put": {
"security": [
{
"AuthBearerBenefactor": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Benefactors Addresses"
],
"summary": "Update benefactor address",
"parameters": [
{
"type": "integer",
"description": "Address ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "Edit address details",
"name": "Request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/addressparam.UpdateAddressRequest"
}
}
],
"responses": {
"204": {
"description": "No Content"
feat(niki): agent get return awaiting kindbox (#81)
2024-07-13 12:33:07 +00:00
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"400": {
"description": "Bad request",
feat(niki): agent get return awaiting kindbox (#81)
2024-07-13 12:33:07 +00:00
"schema": {
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"type": "string"
feat(niki): agent get return awaiting kindbox (#81)
2024-07-13 12:33:07 +00:00
}
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
}
}
},
"delete": {
"security": [
{
"AuthBearerBenefactor": []
}
],
"description": "This endpoint is used to delete an address by benefactor",
"tags": [
"Benefactors Addresses"
],
"summary": "Delete address by benefactor",
"parameters": [
{
"type": "integer",
"description": "Address ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "No Content"
feat(niki): agent get return awaiting kindbox (#81)
2024-07-13 12:33:07 +00:00
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"400": {
"description": "Bad request",
feat(niki): agent get return awaiting kindbox (#81)
2024-07-13 12:33:07 +00:00
"schema": {
"type": "string"
}
}
}
}
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"/benefactors/kindboxes": {
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"get": {
"security": [
{
"AuthBearerBenefactor": []
}
],
feat(niki): benefactor get/getall kindbox sort/filter/pagination
2024-07-21 13:38:54 +00:00
"description": "Retrieves a list of all KindBoxes with filtering, sorting, and pagination options",
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"Benefactors KindBoxes"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
],
feat(niki): benefactor get/getall kindbox sort/filter/pagination
2024-07-21 13:38:54 +00:00
"summary": "Get all KindBoxes by benefactor",
"parameters": [
{
"type": "integer",
"description": "Filter by ID",
"name": "filter_id",
"in": "query"
},
{
"type": "integer",
"description": "Filter by KindBox request ID",
"name": "filter_kind_box_req_id",
"in": "query"
},
{
"type": "integer",
"description": "Filter by benefactor ID",
"name": "filter_benefactor_id",
"in": "query"
},
{
"enum": [
"on-table",
"cylindrical",
"stand-up"
],
"type": "string",
"description": "Filter by KindBox type",
"name": "filter_kind_box_type",
"in": "query"
},
{
"type": "integer",
"description": "Filter by amount",
"name": "filter_amount",
"in": "query"
},
{
"type": "string",
"description": "Filter by serial number",
"name": "filter_serial_number",
"in": "query"
},
{
"enum": [
"delivered",
"ready-to-return",
"assigned-receiver-agent",
"returned",
"enumerated"
],
"type": "string",
"description": "Filter by status",
"name": "filter_status",
"in": "query"
},
{
"type": "string",
"format": "date-time",
"description": "Filter by delivered at",
"name": "filter_delivered_at",
"in": "query"
},
{
"type": "integer",
"description": "Filter by return refer time ID",
"name": "filter_return_refer_time_id",
"in": "query"
},
{
"type": "string",
"format": "date",
"description": "Filter by return refer date",
"name": "filter_return_refer_date",
"in": "query"
},
{
"type": "integer",
"description": "Filter by return address ID",
"name": "filter_return_address_id",
"in": "query"
},
{
"type": "integer",
"description": "Filter by receiver agent ID",
"name": "filter_receiver_agent_id",
"in": "query"
},
{
"type": "string",
"format": "date-time",
"description": "Filter by returned at",
"name": "filter_returned_at",
"in": "query"
},
{
"type": "integer",
"description": "Filter by sender agent ID",
"name": "filter_sender_agent_id",
"in": "query"
},
{
"type": "string",
"format": "date",
"description": "Filter by deliver refer date",
"name": "filter_deliver_refer_date",
"in": "query"
},
{
"type": "integer",
"description": "Filter by deliver address ID",
"name": "filter_deliver_address_id",
"in": "query"
},
{
"type": "integer",
"description": "Filter by deliver refer time ID",
"name": "filter_deliver_refer_time_id",
"in": "query"
},
{
"type": "integer",
"description": "Page number",
"name": "page_number",
"in": "query"
},
{
"type": "integer",
"description": "Page size",
"name": "page_size",
"in": "query"
},
{
"enum": [
"id",
"kind_box_req_id",
"benefactor_id",
"kind_box_type",
"amount",
"serial_number",
"status",
"delivered_at",
"return_refer_time_id",
"return_refer_date",
"return_address_id",
"receiver_agent_id",
"returned_at",
"sender_agent_id",
"deliver_refer_date",
"deliver_address_id",
"deliver_refer_time_id"
],
"type": "string",
"description": "Sort by field",
"name": "sort_field",
"in": "query"
},
{
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort order",
"name": "sort_direction",
"in": "query"
}
],
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"responses": {
"200": {
"description": "OK",
"schema": {
feat(niki): benefactor get/getall kindbox sort/filter/pagination
2024-07-21 13:38:54 +00:00
"$ref": "#/definitions/benefactorkindboxparam.KindBoxGetAllResponse"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "string"
}
}
}
}
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"/benefactors/kindboxes/{id}": {
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"get": {
"security": [
{
"AuthBearerBenefactor": []
}
],
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"description": "This endpoint retrieves a specific kind box associated with an authenticated benefactor.",
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"Benefactors KindBoxes"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
],
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"summary": "Get a specific kind box for a benefactor",
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"parameters": [
{
"type": "integer",
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"description": "Kind box ID",
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/benefactorkindboxparam.KindBoxGetResponse"
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "string"
}
}
}
}
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"/benefactors/kindboxes/{id}/emptying-requests": {
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
"patch": {
"security": [
{
"AuthBearerBenefactor": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"Benefactors KindBoxes"
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
],
"summary": "Register a new emptying request for a kind box by benefactor",
"parameters": [
{
"type": "integer",
"description": "KindBox ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "Request body",
"name": "Request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/benefactorkindboxparam.KindBoxRegisterEmptyingRequest"
}
}
],
"responses": {
"204": {
"description": "No content",
"schema": {
"type": "string"
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "string"
}
}
}
}
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"/benefactors/kindboxreqs": {
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
"get": {
"security": [
{
"AuthBearerBenefactor": []
}
],
"description": "Retrieves a list of all KindBox requests with filtering, sorting, and pagination options",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"Benefactors KindBoxReqs"
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
],
"summary": "Get all KindBox requests",
"parameters": [
{
"type": "integer",
"description": "Filter by ID",
"name": "filter_id",
"in": "query"
},
{
"type": "integer",
"description": "Filter by benefactor ID",
"name": "filter_benefactor_id",
"in": "query"
},
{
"enum": [
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"on-table",
"cylindrical",
"stand-up"
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
],
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "string",
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
"format": "enum",
"description": "Filter by KindBox type",
"name": "filter_kind_box_type",
"in": "query"
},
{
"enum": [
"pending",
"accepted",
"assigned-sender-agent",
"rejected",
"delivered"
],
"type": "string",
"description": "Filter by KindBoxReq Status",
"name": "filter_status",
"in": "query"
},
{
"type": "integer",
"description": "Filter by count requested",
"name": "filter_count_requested",
"in": "query"
},
{
"type": "integer",
"description": "Filter by count accepted",
"name": "filter_count_accepted",
"in": "query"
},
{
"type": "integer",
"description": "Filter by deliver refer time ID",
"name": "filter_deliver_refer_time_id",
"in": "query"
},
{
"type": "string",
"format": "date",
"description": "Filter by deliver refer date",
"name": "filter_deliver_refer_date",
"in": "query"
},
{
"type": "integer",
"description": "Filter by deliver address ID",
"name": "filter_deliver_address_id",
"in": "query"
},
{
"type": "integer",
"description": "Page number",
"name": "page_number",
"in": "query"
},
{
"type": "integer",
"description": "Page size",
"name": "page_size",
"in": "query"
},
{
"enum": [
"id",
"benefactor_id",
"kind_box_type",
"count_requested",
"count_accepted",
"deliver_refer_time_id",
"deliver_refer_date",
"deliver_address_id"
],
"type": "string",
"description": "Sort by field",
"name": "sort_field",
"in": "query"
},
{
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort order",
"name": "sort_direction",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/benefactorkindboxreqparam.GetAllResponse"
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "string"
}
}
}
},
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"post": {
"security": [
{
"AuthBearerBenefactor": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"Benefactors KindBoxReqs"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
],
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"summary": "Add a new kind box request for a benefactor",
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"parameters": [
{
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"description": "New kind box request details",
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"name": "Request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/benefactorkindboxreqparam.KindBoxReqAddRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/benefactorkindboxreqparam.KindBoxReqAddResponse"
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "string"
}
}
}
}
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"/benefactors/kindboxreqs/{id}": {
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"get": {
"security": [
{
"AuthBearerBenefactor": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"Benefactors KindBoxReqs"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
],
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"summary": "Get a kind box request for a benefactor",
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"parameters": [
{
"type": "integer",
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"description": "Kind box request ID",
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/benefactorkindboxreqparam.KindBoxReqGetResponse"
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "string"
}
}
}
feat(niki): add `delete kind_box_req by benefactor`
2024-05-31 14:49:04 +00:00
},
feat(kindboxreq): added edit kindboxreq by benefactor
2024-07-23 19:21:02 +00:00
"put": {
"security": [
{
"AuthBearerBenefactor": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"Benefactors KindBoxReqs"
feat(kindboxreq): added edit kindboxreq by benefactor
2024-07-23 19:21:02 +00:00
],
"summary": "Update kind box request by benefactor",
"parameters": [
{
"type": "integer",
"description": "KindBoxReq ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "Update KindBoxReq Request Body",
"name": "Request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/benefactorkindboxreqparam.KindBoxReqUpdateRequest"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"schema": {
"type": "string"
}
},
"401": {
"description": "invalid or expired jwt",
"schema": {
"type": "string"
}
},
"403": {
"description": "user not allowed",
"schema": {
"type": "string"
}
},
"422": {
"description": "Unprocessable Entity",
"schema": {
"$ref": "#/definitions/httpmsg.ErrorResponse"
}
},
"500": {
"description": "something went wrong",
"schema": {
"type": "string"
}
}
}
},
feat(niki): add `delete kind_box_req by benefactor`
2024-05-31 14:49:04 +00:00
"delete": {
"security": [
{
"AuthBearerBenefactor": []
}
],
"description": "This endpoint is used to delete benefactor's kindboxreq at pending status",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"Benefactors KindBoxReqs"
feat(niki): add `delete kind_box_req by benefactor`
2024-05-31 14:49:04 +00:00
],
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"summary": "Delete kindboxreq by benefactor",
feat(niki): add `delete kind_box_req by benefactor`
2024-05-31 14:49:04 +00:00
"parameters": [
{
"type": "integer",
"description": "Kind box request ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/benefactorkindboxreqparam.KindBoxReqDeleteResponse"
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "string"
}
}
}
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
}
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"/benefactors/login-register": {
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
"post": {
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"description": "This endpoint is used to authenticate an existing benefactor account or register a new one.",
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"Benefactors"
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
],
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"summary": "Login or register a benefactor",
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
"parameters": [
{
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"description": "Login or register request details",
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
"name": "Request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/benefactoreparam.LoginOrRegisterRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/benefactoreparam.LoginOrRegisterResponse"
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "string"
}
}
}
}
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"/benefactors/send-otp": {
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
"post": {
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"description": "This endpoint sends an OTP to the benefactor's phone number for verification purposes.",
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"Benefactors"
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
],
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"summary": "Send OTP to benefactor",
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
"parameters": [
{
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"description": "Send OTP request details",
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
"name": "Request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/benefactoreparam.SendOtpRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/benefactoreparam.SendOtpResponse"
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "string"
}
}
}
}
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
}
},
"definitions": {
"addressparam.BenefactorAddAddressRequest": {
"type": "object",
"properties": {
"address": {
"type": "string",
"example": "tehran"
},
"city_id": {
"type": "integer",
"example": 1
},
"lat": {
"type": "number",
"example": 22.23
},
"lon": {
"type": "number",
"example": 22.22
},
fix(niki): remove is_main from address and add ame to address
2024-05-30 12:57:33 +00:00
"name": {
"type": "string",
"example": "home"
},
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"postal_code": {
"type": "string",
"example": "1234567890"
}
}
},
"addressparam.BenefactorAddAddressResponse": {
"type": "object",
"properties": {
"address": {
"$ref": "#/definitions/entity.Address"
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"field_errors": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "object",
"additionalProperties": {
"type": "string"
}
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
}
}
},
feat(niki): add benefactor get address
2024-06-01 00:29:11 +00:00
"addressparam.GetAddressResponse": {
"type": "object",
"properties": {
"address": {
"$ref": "#/definitions/entity.Address"
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"field_errors": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "object",
"additionalProperties": {
"type": "string"
}
feat(niki): add benefactor get address
2024-06-01 00:29:11 +00:00
}
}
},
feat(niki): add benefactor get all addresses
2024-06-01 18:01:00 +00:00
"addressparam.GetAllAddressesResponse": {
"type": "object",
"properties": {
"all_addresses": {
"type": "array",
"items": {
"$ref": "#/definitions/entity.Address"
}
}
}
},
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"addressparam.GetAllCitiesResponse": {
"type": "object",
"properties": {
"cities": {
"type": "array",
"items": {
"$ref": "#/definitions/entity.City"
}
}
}
},
"addressparam.GetAllProvincesResponse": {
"type": "object",
"properties": {
"provinces": {
"type": "array",
"items": {
"$ref": "#/definitions/entity.Province"
}
}
}
},
feat(niki): add benefactor edit address
2024-06-06 17:54:56 +00:00
"addressparam.UpdateAddressRequest": {
"type": "object",
"properties": {
"address": {
"type": "string",
"example": "Zanjan Province, Zanjan, Etemadieh, 6th St, Iran"
},
"city_id": {
"type": "integer",
"example": 163
},
"lat": {
"type": "number",
"example": 123.456
},
"lon": {
"type": "number",
"example": 123.456
},
"name": {
"type": "string",
"example": "Home"
},
"postal_code": {
"type": "string",
"example": "1234567890"
}
}
},
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"adminagentparam.Agent": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"example": "John"
},
"id": {
"type": "integer",
"example": 1
},
"last_name": {
"type": "string",
"example": "Doe"
},
"phone_number": {
"type": "string",
"example": "09123456789"
}
}
},
"adminagentparam.GetAllAgentResponse": {
"type": "object",
"properties": {
"agents": {
"type": "array",
"items": {
"$ref": "#/definitions/adminagentparam.Agent"
}
}
}
},
feat(niki): admin assign kindbox to a agent
2024-07-02 20:17:40 +00:00
"adminkindboxparam.AssignReceiverRequest": {
feat(niki): admin get kindbox
2024-07-01 17:13:28 +00:00
"type": "object",
"properties": {
feat(niki): admin assign kindbox to a agent
2024-07-02 20:17:40 +00:00
"receiver_agent_id": {
feat(niki): admin get kindbox
2024-07-01 17:13:28 +00:00
"type": "integer"
}
}
},
feat(niki): admin enumerate(count) kindbox amount (#80)
2024-07-23 21:37:27 +00:00
"adminkindboxparam.EnumerateKindBoxRequest": {
"type": "object",
"properties": {
"amount": {
"type": "integer"
}
}
},
feat(niki): get all kindboxes by admin
2024-07-09 17:17:04 +00:00
"adminkindboxparam.KindBoxGetAllResponse": {
"type": "object",
"properties": {
"all_kind_box": {
"type": "array",
"items": {
"$ref": "#/definitions/entity.KindBox"
}
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"field_errors": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "object",
"additionalProperties": {
"type": "string"
}
},
feat(niki): get all kindboxes by admin
2024-07-09 17:17:04 +00:00
"pagination": {
"$ref": "#/definitions/param.PaginationResponse"
}
}
},
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
"adminkindboxparam.KindBoxGetResponse": {
"type": "object",
"properties": {
"amount": {
"type": "integer"
},
"benefactorID": {
"type": "integer"
},
"deliverAddressID": {
"type": "integer"
},
"deliverReferDate": {
"type": "string"
},
feat(niki): agent deliver kindboxreq (transactional)
2024-07-12 21:25:20 +00:00
"deliverReferTimeID": {
"type": "integer"
},
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
"deliveredAt": {
"type": "string"
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"field_errors": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "object",
"additionalProperties": {
"type": "string"
}
},
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
"id": {
"type": "integer"
},
"kindBoxReqID": {
"type": "integer"
},
"kindBoxType": {
"$ref": "#/definitions/entity.KindBoxType"
},
"receiverAgentID": {
"type": "integer"
},
"returnAddressID": {
"type": "integer"
},
"returnReferDate": {
"type": "string"
},
"returnReferTimeID": {
"type": "integer"
},
"returnedAt": {
"type": "string"
},
"senderAgentID": {
"type": "integer"
},
"serialNumber": {
"type": "string"
},
"status": {
"$ref": "#/definitions/entity.KindBoxStatus"
}
}
},
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"adminkindboxreqparam.AssignSenderRequest": {
"type": "object",
"properties": {
"sender_agent_id": {
"type": "integer"
}
}
},
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"adminkindboxreqparam.AssignSenderResponse": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "object",
"properties": {
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"field_errors": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
},
feat(niki): agent deliver kindboxreq (transactional)
2024-07-12 21:25:20 +00:00
"adminkindboxreqparam.DeliverKindBoxReqRequest": {
"type": "object",
"properties": {
"serial_numbers": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"1",
"2",
"3"
]
}
}
},
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"adminkindboxreqparam.DeliverKindBoxReqResponse": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "object",
"properties": {
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"field_errors": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
},
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
"adminkindboxreqparam.DeliveryAwaitingGetAllResponse": {
"type": "object",
"properties": {
"all_awaiting_kind_box_req": {
"type": "array",
"items": {
"$ref": "#/definitions/entity.KindBoxReq"
}
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"field_errors": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "object",
"additionalProperties": {
"type": "string"
}
},
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
"pagination": {
"$ref": "#/definitions/param.PaginationResponse"
}
}
},
feat(niki): add get an awaiting-for-delivery kindbox request by agent
2024-06-10 22:54:16 +00:00
"adminkindboxreqparam.DeliveryAwaitingGetResponse": {
"type": "object",
"properties": {
"benefactorID": {
"type": "integer"
},
"countAccepted": {
"type": "integer"
},
"countRequested": {
"type": "integer"
},
"deliverAddressID": {
"type": "integer"
},
"deliverReferDate": {
"type": "string"
},
"deliverReferTimeID": {
"type": "integer"
},
"deliveredAt": {
"type": "string"
},
feat(niki): implement get kind box req by id for admin
2024-07-21 14:16:01 +00:00
"description": {
"type": "string"
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"field_errors": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "object",
"additionalProperties": {
"type": "string"
}
},
feat(niki): implement get kind box req by id for admin
2024-07-21 14:16:01 +00:00
"id": {
"type": "integer"
},
"kindBoxType": {
"$ref": "#/definitions/entity.KindBoxType"
},
"senderAgentID": {
"type": "integer"
},
"status": {
"$ref": "#/definitions/entity.KindBoxReqStatus"
}
}
},
"adminkindboxreqparam.GetKindBoxReqResponse": {
"type": "object",
"properties": {
"benefactorID": {
"type": "integer"
},
"countAccepted": {
"type": "integer"
},
"countRequested": {
"type": "integer"
},
"deliverAddressID": {
"type": "integer"
},
"deliverReferDate": {
"type": "string"
},
"deliverReferTimeID": {
"type": "integer"
},
"deliveredAt": {
"type": "string"
},
feat(niki): add get an awaiting-for-delivery kindbox request by agent
2024-06-10 22:54:16 +00:00
"description": {
"type": "string"
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"field_errors": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "object",
"additionalProperties": {
"type": "string"
}
},
feat(niki): add get an awaiting-for-delivery kindbox request by agent
2024-06-10 22:54:16 +00:00
"id": {
"type": "integer"
},
"kindBoxType": {
"$ref": "#/definitions/entity.KindBoxType"
},
"senderAgentID": {
"type": "integer"
},
"status": {
"$ref": "#/definitions/entity.KindBoxReqStatus"
}
}
},
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"adminkindboxreqparam.KindBoxReqAcceptRequest": {
"type": "object",
"properties": {
"count_accepted": {
"type": "integer"
}
}
},
"adminkindboxreqparam.KindBoxReqAcceptResponse": {
"type": "object",
"properties": {
"count_accepted": {
"type": "integer"
},
"count_requested": {
"type": "integer"
},
"deliver_address_id": {
"type": "integer"
},
"deliver_refer_date": {
"type": "string"
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"field_errors": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "object",
"additionalProperties": {
"type": "string"
}
},
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"kind_box_req_id": {
"type": "integer"
},
"kind_box_req_status": {
"$ref": "#/definitions/entity.KindBoxReqStatus"
}
}
},
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
"adminkindboxreqparam.KindBoxReqAddRequest": {
"type": "object",
"properties": {
"benefactor_id": {
"type": "integer",
"example": 1
},
"count_requested": {
"type": "integer",
"example": 2
},
"deliver_address_id": {
"type": "integer",
"example": 1
},
"deliver_refer_date": {
"type": "string",
"example": "2025-01-02 15:04:05"
},
"kind_box_type": {
"allOf": [
{
"$ref": "#/definitions/entity.KindBoxType"
}
],
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"example": "on-table"
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
}
}
},
"adminkindboxreqparam.KindBoxReqAddResponse": {
"type": "object",
"properties": {
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"field_errors": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "object",
"additionalProperties": {
"type": "string"
}
},
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
"kindBoxReq": {
"$ref": "#/definitions/entity.KindBoxReq"
}
}
},
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"adminkindboxreqparam.KindBoxReqGetAllResponse": {
"type": "object",
"properties": {
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
"all_awaiting_kind_box_req": {
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"type": "array",
"items": {
"$ref": "#/definitions/entity.KindBoxReq"
}
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"field_errors": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "object",
"additionalProperties": {
"type": "string"
}
},
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"pagination": {
"$ref": "#/definitions/param.PaginationResponse"
}
}
},
"adminkindboxreqparam.KindBoxReqRejectRequest": {
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
"type": "object",
"properties": {
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"description": {
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"type": "string",
"example": "description"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
}
}
},
"adminkindboxreqparam.KindBoxReqRejectResponse": {
"type": "object",
"properties": {
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
"benefactor_id": {
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"type": "integer",
"example": 1
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
},
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"count_requested": {
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"type": "integer",
"example": 1
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
},
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"deliver_address_id": {
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"type": "integer",
"example": 1
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
},
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"deliver_refer_date": {
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"type": "string",
"example": "2025-01-02 15:04:05"
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
},
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"description": {
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"type": "string",
"example": "description"
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"field_errors": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "object",
"additionalProperties": {
"type": "string"
}
},
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"id": {
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"type": "integer",
"example": 1
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
},
"kind_box_type": {
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"allOf": [
{
"$ref": "#/definitions/entity.KindBoxType"
}
],
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"example": "on-table"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
},
"status": {
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"allOf": [
{
"$ref": "#/definitions/entity.KindBoxReqStatus"
}
],
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"example": "pending"
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
}
}
},
fix(niki): update kindbox request by admin
2024-07-10 01:21:03 +00:00
"adminkindboxreqparam.KindBoxReqUpdateRequest": {
"type": "object",
"properties": {
"count_accepted": {
"type": "integer",
"example": 3
},
"count_requested": {
"type": "integer",
"example": 5
},
"deliver_address_id": {
"type": "integer",
"example": 1
},
"deliver_refer_date": {
"type": "string",
"example": "2025-01-02T15:04:05Z"
},
"deliver_refer_time_id": {
"type": "integer",
"example": 1
},
"description": {
"type": "string",
"example": "description"
},
"kind_box_type": {
"allOf": [
{
"$ref": "#/definitions/entity.KindBoxType"
}
],
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"example": "cylindrical"
fix(niki): update kindbox request by admin
2024-07-10 01:21:03 +00:00
},
"sender_agent_id": {
"type": "integer",
"example": 1
}
}
},
fix(niki): update swagger
2024-05-21 16:57:21 +00:00
"adminserviceparam.AdminInfo": {
"type": "object",
"properties": {
"description": {
fix(param): add json tag to fields
2024-05-21 22:10:16 +00:00
"type": "string",
"example": "This is a description"
fix(niki): update swagger
2024-05-21 16:57:21 +00:00
},
"email": {
fix(param): add json tag to fields
2024-05-21 22:10:16 +00:00
"type": "string",
"example": "example@gmail.com"
fix(niki): update swagger
2024-05-21 16:57:21 +00:00
},
"first_name": {
fix(param): add json tag to fields
2024-05-21 22:10:16 +00:00
"type": "string",
"example": "John"
fix(niki): update swagger
2024-05-21 16:57:21 +00:00
},
"gender": {
fix(param): add json tag to fields
2024-05-21 22:10:16 +00:00
"allOf": [
{
"$ref": "#/definitions/entity.Gender"
}
],
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"example": "male"
fix(niki): update swagger
2024-05-21 16:57:21 +00:00
},
"id": {
fix(param): add json tag to fields
2024-05-21 22:10:16 +00:00
"type": "integer",
"example": 1
fix(niki): update swagger
2024-05-21 16:57:21 +00:00
},
"last_name": {
fix(param): add json tag to fields
2024-05-21 22:10:16 +00:00
"type": "string",
"example": "Doe"
fix(niki): update swagger
2024-05-21 16:57:21 +00:00
},
"phone_number": {
fix(param): add json tag to fields
2024-05-21 22:10:16 +00:00
"type": "string",
"example": "09123456789"
fix(niki): update swagger
2024-05-21 16:57:21 +00:00
},
"role": {
fix(param): add json tag to fields
2024-05-21 22:10:16 +00:00
"allOf": [
{
"$ref": "#/definitions/entity.AdminRole"
}
],
"example": 2
fix(niki): update swagger
2024-05-21 16:57:21 +00:00
},
"status": {
fix(param): add json tag to fields
2024-05-21 22:10:16 +00:00
"allOf": [
{
"$ref": "#/definitions/entity.AdminStatus"
}
],
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"example": "active"
feat(niki): add get all agents by admin
2024-06-10 14:49:13 +00:00
}
}
},
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"adminserviceparam.LoginWithPhoneNumberRequest": {
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
"type": "object",
"properties": {
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"password": {
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"type": "string",
"example": "password123"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
},
"phone_number": {
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"type": "string",
"example": "09123456789"
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
}
}
},
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"adminserviceparam.LoginWithPhoneNumberResponse": {
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
"type": "object",
"properties": {
fix(niki): update swagger
2024-05-21 16:57:21 +00:00
"admin_info": {
"$ref": "#/definitions/adminserviceparam.AdminInfo"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"field_errors": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "object",
"additionalProperties": {
"type": "string"
}
},
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"tokens": {
"$ref": "#/definitions/adminserviceparam.Tokens"
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
}
}
},
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"adminserviceparam.RegisterRequest": {
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
"type": "object",
"properties": {
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"description": {
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"type": "string",
"example": "this is a description"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
},
"email": {
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"type": "string",
"example": "miaad.66@gmail.com"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
},
"first_name": {
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"type": "string",
"example": "miaad"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
},
"gender": {
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"allOf": [
{
"$ref": "#/definitions/entity.Gender"
}
],
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"example": "male"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
},
"last_name": {
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"type": "string",
"example": "shahi"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
},
"password": {
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"type": "string",
"example": "Abc123456"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
},
"phone_number": {
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"type": "string",
"example": "09183723447"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
},
"role": {
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"allOf": [
{
"$ref": "#/definitions/entity.AdminRole"
}
],
"example": 2
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
},
"status": {
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"allOf": [
{
"$ref": "#/definitions/entity.AdminStatus"
}
],
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"example": "active"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
}
}
},
"adminserviceparam.RegisterResponse": {
"type": "object",
"properties": {
"admin": {
"$ref": "#/definitions/entity.Admin"
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"field_errors": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "object",
"additionalProperties": {
"type": "string"
}
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
}
}
},
"adminserviceparam.Tokens": {
"type": "object",
"properties": {
"access_token": {
"type": "string"
},
"refresh_token": {
"type": "string"
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
}
}
},
feat(niki): agent get all return awaiting kindboxes (#82)
2024-07-14 08:58:37 +00:00
"agentkindboxparam.GetAllResponse": {
"type": "object",
"properties": {
"all_kind_boxes": {
"type": "array",
"items": {
"$ref": "#/definitions/entity.KindBox"
}
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"field_errors": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "object",
"additionalProperties": {
"type": "string"
}
},
feat(niki): agent get all return awaiting kindboxes (#82)
2024-07-14 08:58:37 +00:00
"pagination": {
"$ref": "#/definitions/param.PaginationResponse"
}
}
},
feat(niki): return kindbox from benefactor by agent (#83)
2024-07-16 11:47:09 +00:00
"agentkindboxparam.GetKindBoxResponse": {
"type": "object",
"properties": {
"amount": {
"type": "integer"
},
"benefactorID": {
"type": "integer"
},
"deliverAddressID": {
"type": "integer"
},
"deliverReferDate": {
"type": "string"
},
"deliverReferTimeID": {
"type": "integer"
},
"deliveredAt": {
"type": "string"
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"field_errors": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "object",
"additionalProperties": {
"type": "string"
}
},
feat(niki): return kindbox from benefactor by agent (#83)
2024-07-16 11:47:09 +00:00
"id": {
"type": "integer"
},
"kindBoxReqID": {
"type": "integer"
},
"kindBoxType": {
"$ref": "#/definitions/entity.KindBoxType"
},
"receiverAgentID": {
"type": "integer"
},
"returnAddressID": {
"type": "integer"
},
"returnReferDate": {
"type": "string"
},
"returnReferTimeID": {
"type": "integer"
},
"returnedAt": {
"type": "string"
},
"senderAgentID": {
"type": "integer"
},
"serialNumber": {
"type": "string"
},
"status": {
"$ref": "#/definitions/entity.KindBoxStatus"
}
}
},
"agentkindboxparam.ReturnKindBoxRequest": {
"type": "object",
"properties": {
"serial_number": {
"type": "string"
}
}
},
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
"benefactoreparam.BenefactroInfo": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"example": "mehdi"
},
"id": {
"type": "integer",
"example": 1
},
"last_name": {
"type": "string",
"example": "rez"
},
"role": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"allOf": [
{
"$ref": "#/definitions/entity.UserRole"
}
],
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
"example": "benefactor"
}
}
},
"benefactoreparam.LoginOrRegisterRequest": {
"type": "object",
"properties": {
"phone_number": {
"type": "string",
"example": "09198829528"
},
"verification_code": {
"type": "string",
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"example": "12345"
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
}
}
},
"benefactoreparam.LoginOrRegisterResponse": {
"type": "object",
"properties": {
"benefactore_info": {
"$ref": "#/definitions/benefactoreparam.BenefactroInfo"
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"field_errors": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "object",
"additionalProperties": {
"type": "string"
}
},
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
"tokens": {
"$ref": "#/definitions/benefactoreparam.Tokens"
}
}
},
"benefactoreparam.SendOtpRequest": {
"type": "object",
"properties": {
"phone_number": {
"type": "string",
"example": "09198829528"
}
}
},
"benefactoreparam.SendOtpResponse": {
"type": "object",
"properties": {
"code": {
"description": "this just use in test .env\n\t\tTODO - remove it after test",
"type": "string"
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"field_errors": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "object",
"additionalProperties": {
"type": "string"
}
},
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
"phone_number": {
"type": "string",
"example": "09198829528"
}
}
},
"benefactoreparam.Tokens": {
"type": "object",
"properties": {
"access_token": {
"type": "string"
},
"refresh_token": {
"type": "string"
}
}
},
feat(niki): benefactor get/getall kindbox sort/filter/pagination
2024-07-21 13:38:54 +00:00
"benefactorkindboxparam.KindBoxGetAllResponse": {
"type": "object",
"properties": {
"all_kind_box": {
"type": "array",
"items": {
"$ref": "#/definitions/entity.KindBox"
}
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"field_errors": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "object",
"additionalProperties": {
"type": "string"
}
},
feat(niki): benefactor get/getall kindbox sort/filter/pagination
2024-07-21 13:38:54 +00:00
"pagination": {
"$ref": "#/definitions/param.PaginationResponse"
}
}
},
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"benefactorkindboxparam.KindBoxGetResponse": {
"type": "object",
"properties": {
"amount": {
"type": "integer"
},
"benefactorID": {
"type": "integer"
},
"deliverAddressID": {
"type": "integer"
},
"deliverReferDate": {
"type": "string"
},
feat(niki): agent deliver kindboxreq (transactional)
2024-07-12 21:25:20 +00:00
"deliverReferTimeID": {
"type": "integer"
},
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"deliveredAt": {
"type": "string"
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"field_errors": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "object",
"additionalProperties": {
"type": "string"
}
},
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"id": {
"type": "integer"
},
"kindBoxReqID": {
"type": "integer"
},
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
"kindBoxType": {
"$ref": "#/definitions/entity.KindBoxType"
},
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"receiverAgentID": {
"type": "integer"
},
"returnAddressID": {
"type": "integer"
},
"returnReferDate": {
"type": "string"
},
feat(niki): benefactor requests emptying a KindBox
2024-06-25 21:58:11 +00:00
"returnReferTimeID": {
"type": "integer"
},
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"returnedAt": {
"type": "string"
},
"senderAgentID": {
"type": "integer"
},
"serialNumber": {
"type": "string"
},
"status": {
"$ref": "#/definitions/entity.KindBoxStatus"
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
}
}
},
"benefactorkindboxparam.KindBoxRegisterEmptyingRequest": {
"type": "object",
"properties": {
"return_address_id": {
"type": "integer",
"example": 1
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
},
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
"return_refer_date": {
"type": "string",
"example": "2025-01-02T15:04:05Z"
},
"return_refer_time_id": {
"type": "integer",
"example": 1
}
}
},
"benefactorkindboxreqparam.GetAllResponse": {
"type": "object",
"properties": {
"all_kind_box_req": {
"type": "array",
"items": {
"$ref": "#/definitions/entity.KindBoxReq"
}
},
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"field_errors": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "object",
"additionalProperties": {
"type": "string"
}
},
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
"pagination": {
"$ref": "#/definitions/param.PaginationResponse"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
}
}
},
"benefactorkindboxreqparam.KindBoxReqAddRequest": {
"type": "object",
"properties": {
"count_requested": {
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"type": "integer",
"example": 2
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
},
"deliver_address_id": {
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"type": "integer",
"example": 1
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
},
"deliver_refer_date": {
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"type": "string",
fix(niki): add refer time duration when creating kind box req by benefactor
2024-05-31 12:36:48 +00:00
"example": "2025-01-02T15:04:05Z"
},
"deliver_refer_time_id": {
"type": "integer",
"example": 1
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
},
feat(niki): get-getall kindboxreq with page-filter-sort by benefactor
2024-07-03 17:18:06 +00:00
"kind_box_type": {
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"allOf": [
{
"$ref": "#/definitions/entity.KindBoxType"
}
],
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"example": "on-table"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
}
}
},
"benefactorkindboxreqparam.KindBoxReqAddResponse": {
"type": "object",
"properties": {
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"field_errors": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "object",
"additionalProperties": {
"type": "string"
}
},
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"kind_box_req": {
"$ref": "#/definitions/entity.KindBoxReq"
}
}
},
feat(niki): add `delete kind_box_req by benefactor`
2024-05-31 14:49:04 +00:00
"benefactorkindboxreqparam.KindBoxReqDeleteResponse": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "object",
"properties": {
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"field_errors": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
feat(niki): add `delete kind_box_req by benefactor`
2024-05-31 14:49:04 +00:00
},
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"benefactorkindboxreqparam.KindBoxReqGetResponse": {
"type": "object",
"properties": {
docs(niki): update swagger api documentation
2024-08-27 17:49:34 +00:00
"field_errors": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "object",
"additionalProperties": {
"type": "string"
}
},
fix(param): add json tag to fields
2024-05-21 22:10:16 +00:00
"kind_box_req": {
"$ref": "#/definitions/entity.KindBoxReq"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
}
}
},
feat(kindboxreq): added edit kindboxreq by benefactor
2024-07-23 19:21:02 +00:00
"benefactorkindboxreqparam.KindBoxReqUpdateRequest": {
"type": "object",
"properties": {
"count_requested": {
"type": "integer",
"example": 5
},
"deliver_address_id": {
"type": "integer",
"example": 1
},
"deliver_refer_date": {
"type": "string",
"example": "2025-01-02T15:04:05Z"
},
"deliver_refer_time_id": {
"type": "integer",
"example": 1
},
"description": {
"type": "string",
"example": "description"
},
"kind_box_type": {
"allOf": [
{
"$ref": "#/definitions/entity.KindBoxType"
}
],
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"example": "cylindrical"
feat(kindboxreq): added edit kindboxreq by benefactor
2024-07-23 19:21:02 +00:00
}
}
},
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
"entity.Address": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"benefactorID": {
"type": "integer"
},
"cityID": {
"type": "integer"
},
"id": {
"type": "integer"
},
"lat": {
"type": "number"
},
"lon": {
"type": "number"
},
fix(niki): remove is_main from address and add ame to address
2024-05-30 12:57:33 +00:00
"name": {
"type": "string"
},
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
"postalCode": {
"type": "string"
},
"provinceID": {
"type": "integer"
}
}
},
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"entity.Admin": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"email": {
"type": "string"
},
"firstName": {
"type": "string"
},
"gender": {
"$ref": "#/definitions/entity.Gender"
},
"id": {
"type": "integer"
},
"lastName": {
"type": "string"
},
"password": {
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"role": {
"$ref": "#/definitions/entity.AdminRole"
},
"status": {
"$ref": "#/definitions/entity.AdminStatus"
}
}
},
"entity.AdminRole": {
"type": "integer",
"enum": [
1,
2,
3
],
"x-enum-varnames": [
"AdminSuperAdminRole",
"AdminAdminRole",
"AdminAgentRole"
]
},
"entity.AdminStatus": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "string",
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"enum": [
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"active",
"inactive"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
],
"x-enum-varnames": [
"AdminActiveStatus",
"AdminInactiveStatus"
]
},
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
"entity.City": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"provinceID": {
"type": "integer"
}
}
},
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"entity.Gender": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "string",
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"enum": [
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"male",
"female"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
],
"x-enum-varnames": [
"MaleGender",
"FemaleGender"
]
},
feat(niki): get all kindboxes by admin
2024-07-09 17:17:04 +00:00
"entity.KindBox": {
"type": "object",
"properties": {
"amount": {
"type": "integer"
},
"benefactorID": {
"type": "integer"
},
"deliverAddressID": {
"type": "integer"
},
"deliverReferDate": {
"type": "string"
},
feat(niki): agent deliver kindboxreq (transactional)
2024-07-12 21:25:20 +00:00
"deliverReferTimeID": {
"type": "integer"
},
feat(niki): get all kindboxes by admin
2024-07-09 17:17:04 +00:00
"deliveredAt": {
"type": "string"
},
"id": {
"type": "integer"
},
"kindBoxReqID": {
"type": "integer"
},
"kindBoxType": {
"$ref": "#/definitions/entity.KindBoxType"
},
"receiverAgentID": {
"type": "integer"
},
"returnAddressID": {
"type": "integer"
},
"returnReferDate": {
"type": "string"
},
"returnReferTimeID": {
"type": "integer"
},
"returnedAt": {
"type": "string"
},
"senderAgentID": {
"type": "integer"
},
"serialNumber": {
"type": "string"
},
"status": {
"$ref": "#/definitions/entity.KindBoxStatus"
}
}
},
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"entity.KindBoxReq": {
"type": "object",
"properties": {
"benefactorID": {
"type": "integer"
},
"countAccepted": {
"type": "integer"
},
"countRequested": {
"type": "integer"
},
"deliverAddressID": {
"type": "integer"
},
"deliverReferDate": {
"type": "string"
},
fix(niki): add refer time duration when creating kind box req by benefactor
2024-05-31 12:36:48 +00:00
"deliverReferTimeID": {
"type": "integer"
},
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"deliveredAt": {
"type": "string"
},
"description": {
"type": "string"
},
"id": {
"type": "integer"
},
"kindBoxType": {
"$ref": "#/definitions/entity.KindBoxType"
},
"senderAgentID": {
"type": "integer"
},
"status": {
"$ref": "#/definitions/entity.KindBoxReqStatus"
}
}
},
"entity.KindBoxReqStatus": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "string",
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"enum": [
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"pending",
"accepted",
"assigned-sender-agent",
"rejected",
"delivered"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
],
"x-enum-varnames": [
"KindBoxReqPendingStatus",
"KindBoxReqAcceptedStatus",
"KindBoxReqAssignedSenderAgentStatus",
"KindBoxReqRejectedStatus",
"KindBoxReqDeliveredStatus"
]
},
"entity.KindBoxStatus": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "string",
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"enum": [
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"delivered",
"ready-to-return",
"assigned-receiver-agent",
"returned",
"enumerated"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
],
"x-enum-varnames": [
"KindBoxDeliveredStatus",
"KindBoxReadyToReturnStatus",
"KindBoxAssignedReceiverAgentStatus",
"KindBoxReturnedStatus",
"KindBoxEnumeratedStatus"
]
},
"entity.KindBoxType": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"type": "string",
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"enum": [
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"on-table",
"cylindrical",
"stand-up"
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
],
"x-enum-varnames": [
"KindBoxOnTable",
"KindBoxCylindrical",
"KindBoxStandUp"
]
},
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
"entity.Province": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
},
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"entity.UserRole": {
"type": "string",
"enum": [
"benefactor"
],
"x-enum-varnames": [
"UserBenefactorRole"
]
},
feat(niki): implement validation and generate swagger docs
2024-07-21 13:10:22 +00:00
"httpmsg.ErrorResponse": {
"type": "object",
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"message": {
"type": "string"
}
}
},
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"param.PaginationResponse": {
"type": "object",
"properties": {
fix(param): add json tag to fields
2024-05-21 22:10:16 +00:00
"page_number": {
"type": "integer",
"example": 1
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
},
fix(param): add json tag to fields
2024-05-21 22:10:16 +00:00
"page_size": {
"type": "integer",
"example": 10
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
},
"total": {
fix(param): add json tag to fields
2024-05-21 22:10:16 +00:00
"type": "integer",
"example": 100
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
}
}
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
}
},
"securityDefinitions": {
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"AuthBearerAdmin": {
fix(niki): internal, validator and structure refactor
2024-08-01 10:20:18 +00:00
"description": "Type the word 'Bearer' followed by a space and Admin JWT token.",
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"type": "apiKey",
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"name": "Authorization",
fix(niki): Completion of swagger
2024-05-15 07:38:39 +00:00
"in": "header"
},
"AuthBearerBenefactor": {
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"description": "Type the word 'Bearer' followed by a space and Benefactor JWT token",
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
"type": "apiKey",
fix(niki): major refactoring and bug fixes
2024-05-17 20:16:28 +00:00
"name": "Authorization",
feat(niki): add swagger not completed
2024-05-14 13:07:09 +00:00
"in": "header"
}
}
}`
// SwaggerInfo holds exported Swagger Info so clients can modify it
var SwaggerInfo = &swag.Spec{
Version: "",
Host: "",
BasePath: "",
Schemes: []string{},
Title: "",
Description: "",
InfoInstanceName: "swagger",
SwaggerTemplate: docTemplate,
LeftDelim: "{{",
RightDelim: "}}",
}
func init() {
swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo)
}