react-query-lightbase-codegen 0.0.1

package/src/mobile-api.yaml

@@ -0,0 +1,1550 @@
+openapi: 3.0.0
+info:
+  title: Amstel Mobile API
+  version: 1.0
+  description: API for the app
+
+servers:
+  - url: http://localhost:8000/
+    description: Local environment
+
+paths:
+  /v1/auth/register/:
+    post:
+      operationId: register
+      summary: Create a new account
+      description: Create a new account
+      tags:
+        - authentication
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                first_name:
+                  type: string
+                  required: true
+                last_name_prefix:
+                  type: string
+                  required: true
+                last_name:
+                  type: string
+                  required: true
+                email:
+                  type: string
+                  format: email
+                  required: true
+                  description: "note: should be unique"
+                gender:
+                  type: string
+                  enum: [male, female, other]
+                  required: true
+                date_of_birth:
+                  type: string
+                  format: date
+                  required: true
+                phone_number:
+                  type: string
+                  example: 0612345678
+                  required: true
+                  description: "note: should be unique"
+                phone_number_verify_id:
+                  type: string
+                  required: true
+                phone_number_verify_token:
+                  type: string
+                  required: true
+                address:
+                  $ref: "#/components/schemas/AddressShort"
+
+      responses:
+        "200":
+          description: JWT token for the newly created user
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/AuthenticationResponse"
+        "400":
+          description: When a validation error occured
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  user_error:
+                    type: string
+                    enum: [postcode_not_allowed]
+
+  /v1/auth/request-authentication/:
+    post:
+      operationId: requestAuthentication
+      summary: Request a email with verification link for the alternative authentication flow.
+      description: Authenticate using the e-mail and sms token
+      tags:
+        - authentication
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                phone_number:
+                  type: string
+                  example: "0612345678"
+                device_os:
+                  type: string
+                  enum: [ios, android]
+
+      responses:
+        "204":
+          description: No content, also not if phone doesn't exists
+
+  /v1/auth/authenticate/:
+    post:
+      operationId: authenticate
+      summary: Complete the authentication with sms token
+      description: Authenticate using the sms token
+      tags:
+        - authentication
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                phone_number:
+                  type: string
+                phone_number_verify_token:
+                  type: integer
+                  example: 654321
+                  description: SMS token
+      responses:
+        "200":
+          description: Authentication response
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/AuthenticationResponse"
+        "400":
+          description: When a validation error occured
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  phone_number_verify_token:
+                    type: string
+
+  /v1/auth/refresh-token/:
+    post:
+      operationId: refreshToken
+      summary: Create a new access token
+      description:
+        Create a new access token using a refresh token. You'll receive a new access and refresh token.
+        The old refresh token is getting blacklisted and cannot be used anymore.
+      tags:
+        - authentication
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                refresh:
+                  type: string
+
+      responses:
+        "200":
+          description: Authentication response
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/AuthenticationResponse"
+
+  /v1/account/register-device/:
+    post:
+      operationId: registerDevice
+      summary: Registers device id
+      description: Connects the device to the user account so the backend can send push notifications
+      tags:
+        - user management
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                device_uid:
+                  type: string
+                device_os:
+                  type: string
+                  enum: [ios, android]
+                device_user_agent:
+                  type: string
+                provider:
+                  type: string
+                  enum: [appcenter, azure]
+      responses:
+        "201":
+          description: Register response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  device_uid:
+                    type: string
+                  device_os:
+                    type: string
+                    enum: [ios, android]
+                  device_user_agent:
+                    type: string
+
+  /v1/account/update-personal-data/:
+    put:
+      operationId: updatePersonalData
+      summary: Updates personal data
+      description:
+        Updates personal data of the current user (bsn, email, phone number or general_practitioner_id)
+        All the fields are optional, it is possible to call this endpoint with one field only.
+        Except for phone_number, then also phone_number_verify_id and phone_number_verify_token are required.
+      tags:
+        - user management
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                email:
+                  type: string
+                  description: Email (can only be set when no email is set yet)
+                  required: false
+                phone_number:
+                  type: string
+                  description: Phone number
+                  required: false
+                phone_number_verify_id:
+                  type: string
+                  required: false
+                phone_number_verify_token:
+                  type: string
+                  required: false
+                bsn:
+                  type: string
+                  example: "123456782"
+                  required: false
+                general_practitioner_id:
+                  type: string
+                  format: uuid
+                  required: false
+                lsp_arranged:
+                  type: boolean
+                  description: When the user arranged the LSP to be available
+                  required: false
+                identification_sent:
+                  type: boolean
+                  description: When the user sent their identification
+                  required: false
+                residence_address:
+                  $ref: "#/components/schemas/Address"
+                  required: false
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Account"
+          description: "Returns current account data"
+
+  /v1/account/change-email/:
+    post:
+      operationId: changeEmail
+      summary: Requests email change
+      description: Sends an confirmation email with which the user can confirm and change the email address
+      tags:
+        - user management
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                email:
+                  type: string
+                  description: The new email address
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  status:
+                    type: string
+
+  /v1/account/request-verification-email/:
+    post:
+      operationId: requestVerificationEmail
+      summary: Requests verification email
+      description: Sends an new confirmation email with which the user can verify the email address
+      tags:
+        - user management
+      requestBody:
+      responses:
+        "200":
+          content:
+
+  /v1/account/update-medical/:
+    put:
+      operationId: updateMedicalInfo
+      summary: Updates medical info
+      description: Updates medical info of the current user
+      tags:
+        - user management
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                medication_use:
+                  type: string
+                  description: Medication use
+                chronic_disorders:
+                  type: string
+                  description: Chronic disorders
+                allergies:
+                  type: string
+                  description: Allergies
+                selfcare_drugs:
+                  type: string
+                  description: Selfcare drugs
+                other_details:
+                  type: string
+                  description: Other details
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Account"
+          description: "Returns current account data"
+
+  /v1/account/update-consent/:
+    put:
+      operationId: updateConsent
+      summary: Updates constent
+      description: Stores the users consent (and the date on which the user gave his/her consent)
+      tags:
+        - user management
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                contact_gp:
+                  type: boolean
+                  required: false
+                  description: Can the GP be contacted
+                lsp:
+                  type: boolean
+                  required: false
+                  description: Can information be shared through the Landelijk Servicepunt
+                kidney_function:
+                  type: boolean
+                  required: false
+                  description: Thuisapotheek permission to ask my doctor about my laboratory value or kidney function.
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Account"
+          description: "Returns current account data"
+
+  /v1/account/create-appointment/:
+    post:
+      operationId: createAppointment
+      summary: Create a new appointment
+      tags:
+        - user management
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/AppointmentInput"
+      responses:
+        "200":
+          description: Created appointment
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Appointment"
+
+  /v1/account/me/:
+    get:
+      operationId: me
+      summary: Receive data of current user
+      tags:
+        - user management
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Account"
+          description: "Returns current account data"
+
+  /v1/account/update/:
+    put:
+      operationId: updateMe
+      summary: Update current user
+      description: ""
+      tags:
+        - user management
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                participate_tests:
+                  type: boolean
+                  required: false
+                  description: Designates whether the user wants to participate in additional tests.
+                dismissed_participate_tests:
+                  type: boolean
+                  required: false
+                  description: The user dismissed this timeline card.
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Account"
+          description: "Returns current account data"
+
+  /v1/account/delete/:
+    delete:
+      operationId: deleteAccount
+      tags:
+        - user management
+      requestBody:
+        required: false
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                delete_reason:
+                  type: string
+                  required: false
+      responses:
+        "204":
+          description: "Returns no content"
+        "500":
+          description: "Error response"
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  detail:
+                    type: string
+
+  /v1/subusers/:
+    get:
+      operationId: getSubusers
+      summary: Get all subusers
+      tags:
+        - subusers
+      responses:
+        "200":
+          description: List with all subusers
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  id:
+                    type: string
+                    format: uuid
+                  full_name:
+                    type: string
+                  date_of_birth:
+                    type: string
+                    format: date
+                    example: "2019-12-03"
+                  gender:
+                    type: string
+                    enum: [male, female, other]
+
+    post:
+      operationId: createSubuser
+      summary: Create a new sub user
+      tags:
+        - subusers
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                dossier_type:
+                  type: string
+                  enum:
+                    - child_below_12
+                    - child_between_12_and_16
+                    - carer
+                    - legally_incapable
+                bsn:
+                  type: string
+                  example: "123456782"
+                first_name:
+                  type: string
+                last_name_prefix:
+                  type: string
+                  required: false
+                last_name:
+                  type: string
+                date_of_birth:
+                  type: string
+                  format: date
+                  example: "2019-12-03"
+                gender:
+                  type: string
+                  enum: [male, female, other]
+                address:
+                  $ref: "#/components/schemas/AddressShort"
+                  required: false
+                  description: Optional, if not provided, the address of api user is used.
+                appointment:
+                  $ref: "#/components/schemas/AppointmentInput"
+
+      responses:
+        "200":
+          description: JWT token for the newly created subuser
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/AuthenticationResponse"
+
+  /v1/subusers/{subuser_id}/login/:
+    post:
+      operationId: loginSubuser
+      summary: Login as subuser
+      parameters:
+        - in: path
+          name: subuser_id
+          schema:
+            type: integer
+          required: true
+          description: Numeric ID of the user to get
+      tags:
+        - subusers
+      responses:
+        "200":
+          description: JWT token to login as the subuser
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/AuthenticationResponse"
+        "404":
+          description: When a invalid subuser id is given
+
+  /v1/caregiver-requests/:
+    post:
+      operationId: createCaregiverRequest
+      summary: Create a new caregiver request
+      tags:
+        - caregiver
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                phone_number:
+                  type: string
+                  required: false
+                date_of_birth:
+                  type: string
+                  format: date
+                  example: "2019-12-03"
+      responses:
+        "201":
+          description: Created
+
+  /v1/caregiver-requests/{id}/:
+    put:
+      operationId: updateCaregiverRequest
+      summary: Update caregiver request status
+      parameters:
+        - in: path
+          name: id
+          schema:
+           type: integer
+          required: true
+          description: Numeric ID of the caregiver request to get
+      tags:
+        - caregiver
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                status:
+                  type: string
+                  enum: [declined, approved]
+
+      responses:
+        "200":
+          description: JWT token to login as the subuser
+          content:
+            application/json:
+              schema:
+                properties:
+                  status:
+                    type: string
+                    enum: [declined, approved]
+        "404":
+          description: When a invalid id is given or request is already processed
+
+  /v1/dossier/prescriptions/:
+    get:
+      operationId: listPrescriptions
+      summary: Get all new prescriptions for the logged in user
+      tags:
+        - dossier
+      parameters: []
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/Prescription"
+          description: ""
+
+  /v1/dossier/prescriptions/{prescription_id}/:
+    get:
+      operationId: getPrescription
+      summary: Gets single prescription using the given prescription ID
+      tags:
+        - dossier
+      parameters:
+        - name: prescription_id
+          in: path
+          required: true
+          description: ""
+          schema:
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Prescription"
+          description: ""
+
+  /v1/dossier/medicines/:
+    get:
+      operationId: listMedicines
+      summary: Get all new medicines for the logged in user
+      tags:
+        - dossier
+      parameters: []
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/Medicine"
+          description: ""
+
+  /v1/dossier/medicines/{medicine_id}/:
+    get:
+      operationId: getMedicine
+      summary: Gets single medicine using the given medicine ID
+      tags:
+        - dossier
+      parameters:
+        - name: medicine_id
+          in: path
+          required: true
+          description: ""
+          schema:
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/DetailedMedicine"
+          description: ""
+
+  /v1/dossier/prescription-requests/:
+    get:
+      operationId: getPrescriptionRequests
+      summary: Retrieves all current prescription requests
+      tags:
+        - dossier
+      responses:
+        "201":
+          description: All prescription requests
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/PrescriptionRequest"
+    post:
+      operationId: createPrescriptionRequest
+      summary: Creates a new prescription request
+      tags:
+        - dossier
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                prescription:
+                  type: string
+                  format: uuid
+      responses:
+        "201":
+          description: The new prescription request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/PrescriptionRequest"
+
+  /v1/dossier/orders/:
+    post:
+      operationId: createOrder
+      tags:
+        - dossier
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                prescriptions:
+                  type: array
+                  items:
+                    type: string
+                    format: uuid
+                store:
+                  type: string
+                  format: uuid
+                  required: false
+                prevent_neighbour_delivery:
+                  type: boolean
+                delivery_method:
+                  type: string
+                  enum: [home-delivery, counter, locker, locker247, special]
+                delivery_address:
+                  $ref: "#/components/schemas/Address"
+                appointment:
+                  $ref: "#/components/schemas/AppointmentInput"
+                  required: false
+      responses:
+        "201":
+          description: ""
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Order"
+
+  /v1/dossier/orders/{order_id}/:
+    get:
+      operationId: getOrder
+      summary: Gets single order using the given order ID
+      tags:
+        - dossier
+      parameters:
+        - name: order_id
+          in: path
+          required: true
+          description: ""
+          schema:
+            type: string
+            format: uuid
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Order"
+          description: ""
+
+  /v1/dossier/timeline/:
+    get:
+      operationId: listTimeline
+      tags:
+        - dossier
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/TimelineItem"
+          description: ""
+
+  /v1/dossier/timeline/close/:
+    post:
+      operationId: closeTimeline
+      tags:
+        - dossier
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                model:
+                  type: string
+                  enum:
+                    - order
+                    - prescription_request
+                id:
+                  type: string
+      responses:
+        "200":
+          description: "Returns new timeline data."
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/TimelineItem"
+
+  /v1/phone-number-verification/:
+    post:
+      operationId: phoneNumberVerification
+      summary: Verify a telephone number
+      description: Send a SMS to the recipient to validate their telephone number. If an user is authenticated, no phone_number should be given.
+      tags:
+        - utils
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                phone_number:
+                  type: string
+                  required: false
+                device_os:
+                  type: string
+                  enum: [ios, android]
+      responses:
+        "200":
+          description: A verification id
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  verification_id:
+                    type: string
+
+  /v1/verify-token/:
+    post:
+      operationId: verifyToken
+      summary: Verify a validation token
+      description: Verifies the given verification (SMS) token
+      tags:
+        - utils
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                phone_number:
+                  type: string
+                  description: Phone number
+                  required: false
+                phone_number_verify_id:
+                  type: string
+                phone_number_verify_token:
+                  type: string
+      responses:
+        "200":
+          description: Status
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  status:
+                    type: string
+
+  /v1/available-timeslots/:
+    get:
+      operationId: getAvailableTimeslots
+      summary: Get available timeslots
+      description: Before making an appointment get an overview of all the available timeslots.
+      tags:
+        - utils
+      parameters:
+        - in: query
+          name: days
+          schema:
+            type: string
+          description: How many days need to be checked
+      responses:
+        "200":
+          description: A list of available timeslots grouped per day
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  warning:
+                    type: string
+                    required: false
+                  result:
+                    type: array
+                    items:
+                      properties:
+                        day:
+                          type: string
+                        timeslots:
+                          type: object
+                          properties:
+                            start:
+                              type: string
+                            end:
+                              type: string
+                            available:
+                              type: boolean
+
+  /v1/general-practitioners-search/:
+    get:
+      operationId: generalPractitionersSearch
+      summary: Find a General practitioner or Health centre.
+      description: Search for general practitioners in BIG-register or healthcenters.
+      tags:
+        - utils
+      parameters:
+        - in: query
+          name: q
+          schema:
+            type: string
+          description: Search term
+      responses:
+        "200":
+          description: A list with general practitioners and health centers.
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/GeneralPractitioner"
+
+  /v1/suggest-order-eta/:
+    get:
+      operationId: suggestOrderEta
+      summary: Get order ETA
+      tags:
+        - utils
+      responses:
+        "200":
+          description: ""
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  eta:
+                    type: string
+                    format: "date-time"
+
+  /v1/address-lookup/:
+    post:
+      operationId: addressLookup
+      summary: Lookup an address
+      description: Lookup an address using a postcode and house number
+      tags:
+        - utils
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                postcode:
+                  type: string
+                house_number:
+                  type: string
+      responses:
+        "200":
+          description: The resolved address
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  postcode:
+                    type: string
+                    required: true
+                  house_number:
+                    type: integer
+                    example: 1
+                    required: true
+                  street_name:
+                    type: string
+                    required: true
+                  city:
+                    type: string
+                    required: true
+                  house_number_suffixes:
+                    type: array
+                    description: List with all possible house number suffixes
+                    items:
+                      type: string
+                  country:
+                    type: string
+                    example: NL
+
+components:
+  securitySchemes:
+    bearerAuth:
+      type: http
+      scheme: bearer
+      bearerFormat: JWT
+
+  schemas:
+    Account:
+      type: object
+      properties:
+        id:
+          type: string
+          format: uuid
+        email:
+          type: string
+          format: email
+          example: johndoe@example.com
+        first_name:
+          type: string
+        last_name:
+          type: string
+        phone_number:
+          type: string
+          example: 0612345678
+        date_of_birth:
+          type: string
+          format: date
+          example: "2019-12-03"
+        gender:
+          type: string
+          enum: [male, female, other]
+        residence_address:
+          $ref: "#/components/schemas/Address"
+        shipping_address:
+          $ref: "#/components/schemas/Address"
+        parent_users:
+          type: array
+          items:
+            type: object
+            properties:
+              full_name:
+                type: string
+        is_logged_in_as_subuser:
+          type: boolean
+        dossier_type:
+          type: string
+          enum:
+            - standard
+            - child_below_12
+            - child_between_12_and_16
+            - carer
+            - legally_incapable
+        has_subaccounts:
+          type: boolean
+        dossier_state:
+          type: object
+          properties:
+            approved:
+              type: boolean
+            consent:
+              type: boolean
+            general_practitioner:
+              type: boolean
+            insurance:
+              type: boolean
+            intake:
+              type: boolean
+            medical_data:
+              type: boolean
+            verified_phone:
+              type: boolean
+            identified:
+              type: boolean
+        status:
+          type: object
+          properties:
+            profile_complete:
+              type: boolean
+            missing_fields:
+              type: array
+              items:
+                type: string
+                enum: [email, phone_number, verified_phone, intake, consent]
+        insurer:
+          type: string
+          description: Name of insurer
+        insurance_policy_number:
+          type: string
+        general_practitioner:
+          $ref: "#/components/schemas/GeneralPractitioner"
+          required: false
+        consent_lsp:
+          type: boolean
+        consent_contact_gp:
+          type: boolean
+        consent_kidney_function:
+          type: boolean
+
+    AuthenticationResponse:
+      type: object
+      properties:
+        access:
+          type: string
+          description: access token
+        refresh:
+          type: string
+          description: refresh token
+
+    AddressShort:
+      type: object
+      properties:
+        postcode:
+          type: string
+          required: true
+        house_number:
+          type: integer
+          example: 1
+          required: true
+        house_number_suffix:
+          type: string
+          example: "B"
+
+    Address:
+      allOf:
+        - $ref: "#/components/schemas/AddressShort"
+        - type: object
+          properties:
+            street_name:
+              type: string
+              required: true
+            city:
+              type: string
+              required: true
+
+    GeneralPractitioner:
+      type: object
+      properties:
+        id:
+          type: string
+          format: uuid
+        practice_name:
+          type: string
+        full_name:
+          type: string
+          required: false
+        is_health_centre:
+          type: boolean
+        postcode:
+          type: string
+        house_number:
+          type: string
+        street_name:
+          type: string
+        city:
+          type: string
+        website:
+          type: string
+          example: http://www.example.com
+        phone_number:
+          type: string
+          example: 06 12345678
+          required: false
+        agb_code:
+          type: string
+          required: false
+
+    Prescription:
+      type: object
+      properties:
+        gp_agb:
+          type: string
+        pharmacy_agb:
+          type: string
+        prescriber:
+          type: object
+          properties:
+            name:
+              type: string
+            company_name:
+              type: string
+            postcode:
+              type: string
+            house_number:
+              type: integer
+              example: 1
+            house_number_suffix:
+              type: string
+              example: "B"
+            street_name:
+              type: string
+            city:
+              type: string
+            country:
+              type: string
+        id:
+          type: integer
+        reference_number:
+          type: integer
+        medicines:
+          type: array
+          items:
+            $ref: "#/components/schemas/Medicine"
+
+    OrderedPrescription:
+      allOf:
+        - $ref: "#/components/schemas/Medicine"
+        - type: object
+          properties:
+            medicines:
+              type: array
+              items:
+                $ref: "#/components/schemas/OrderedMedicine"
+
+    Medicine:
+      type: object
+      properties:
+        id:
+          type: string
+          format: uuid
+          required: true
+        name:
+          type: string
+          required: true
+        created:
+          type: string
+          format: date-time
+          required: true
+        gpknaam:
+          type: string
+          required: true
+        receptnr:
+          type: string
+          required: true
+        gebrtekst:
+          type: string
+          required: true
+        startdat:
+          type: string
+          format: date
+        enddat:
+          type: string
+          format: date
+        is_recurring:
+          type: boolean
+        hoeveelheid:
+          type: number
+        first_issue:
+          type: boolean
+        first_issue_type:
+          type: string
+          enum:
+            - first_usage
+            - pharmacy_switch
+            - expired
+        is_blacklisted:
+          type: boolean
+        is_coldchain:
+          type: boolean
+        can_request:
+          type: boolean
+          required: false
+        warning_text:
+          type: string
+          required: false
+        success_text:
+          type: string
+          required: false
+
+    DetailedMedicine:
+      allOf:
+        - $ref: "#/components/schemas/Medicine"
+        - type: object
+          properties:
+            order_history:
+              type: array
+              required: false
+              items:
+                type: string
+                format: date-time
+
+    OrderedMedicine:
+      allOf:
+        - $ref: "#/components/schemas/Medicine"
+        - type: object
+          properties:
+            alternative:
+              type: string
+
+    TimelineItem:
+      type: object
+      properties:
+        id:
+          type: string
+          format: uuid
+        category:
+          type: string
+          enum:
+            - order
+            - prescription
+            - profile
+            - warning
+        notification_type:
+          type: string
+          deprecated: true
+          enum:
+            - appointment-onboarding
+            - appointment-first_medication
+            - appointment-alternative_medicine
+            - appointment-order_generic
+            - dossier-incomplete
+            - dossier-pending
+            - dossier-lsp
+            - confirm-email
+            - caregiver-request
+            - caregiver-request-approved
+            - order-pending
+            - order-approved
+            - order-declined
+            - order-shipment_pending
+            - order-sent
+            - order-delivered
+            - order-special-delivery
+            - order-finished
+            - order-warning
+            - order-returned
+            - participate-tests
+            - prescription-available
+            - prescriptionrequest-pending
+            - prescriptionrequest-declined
+            - prescriptionrequest-approved
+            - prescription-stock-notification
+        created:
+          type: string
+          format: date-time
+          readOnly: true
+        title:
+          type: string
+          maxLength: 100
+        body:
+          type: string
+        extra:
+          type: object
+          required: false
+          properties:
+            close_api_body:
+              type: object
+              required: false
+              properties:
+                model:
+                  type: string
+                  enum:
+                    - order
+                    - prescription_request
+                id:
+                  type: string
+            link_text:
+              type: string
+              required: false
+              description: Used in order-warning to display button
+            phone_number:
+              type: string
+              required: false
+              description: Used in order-warning to display phone number
+            warning_text:
+              type: string
+              required: false
+            medicine_ids:
+              type: array
+              items:
+                type: string
+                format: uuid
+
+    PrescriptionRequest:
+      type: object
+      properties:
+        id:
+          type: string
+          format: uuid
+        dossier:
+          type: string
+          format: uuid
+        prescription:
+          type: string
+          format: uuid
+        created:
+          type: string
+          format: date-time
+        status:
+          type: string
+          enum: [pending, approved, declined]
+        new_prescription:
+          type: string
+          format: uuid
+          required: false
+
+    AppointmentInput:
+      type: object
+      properties:
+        day:
+          type: string
+          format: date
+          description: The day of the appointment
+        timeslot:
+          type: string
+          pattern: '^\d{2}:\d{2}$'
+          example: "14:30"
+          description: The timeslot to reserve
+        type:
+          type: string
+          enum:
+            [onboarding, first_medication, alternative_medicine, order_generic]
+        order:
+          type: string
+          format: uuid
+          required: false
+
+    Appointment:
+      type: object
+      properties:
+        day:
+          type: string
+          format: date
+          description: The day of the appointment
+        timeslot:
+          type: string
+          pattern: '^\d{2}:\d{2}$'
+          example: "14:30"
+        start:
+          type: string
+          pattern: '^\d{2}:\d{2}$'
+          example: "14:30"
+        end:
+          type: string
+          pattern: '^\d{2}:\d{2}$'
+          example: "15:00"
+        dossier:
+          type: string
+          format: uuid
+        order:
+          type: string
+          format: uuid
+        type:
+          type: string
+          enum:
+            [onboarding, first_medication, alternative_medicine, order_generic]
+        completed:
+          type: boolean
+
+    Order:
+      type: object
+      properties:
+        id:
+          type: string
+          format: uuid
+        created:
+          type: string
+          format: date-time
+        delivery_address:
+          $ref: "#/components/schemas/Address"
+        delivery_method:
+          type: string
+          enum: [home-delivery, counter, locker, locker247, special]
+        create_appointment:
+          type: boolean
+          description: Indicates if an appointment can be made
+        dossier:
+          type: string
+          format: uuid
+        prevent_neighbour_delivery:
+          type: boolean
+        eta_from:
+          type: string
+          format: date-time
+        eta_to:
+          type: string
+          format: date-time
+        prescriptions:
+          type: array
+          items:
+            $ref: "#/components/schemas/OrderedPrescription"
+        status:
+          type: string
+          enum:
+            - pending
+            - shipment_pending
+            - sent
+            - finished
+            - returned
+            - return_finished
+            - declined
+        store_id:
+          type: string
+          format: uuid
+        appointment:
+          $ref: "#/components/schemas/Appointment"
+        authorized_name:
+          type: string
+          required: false
+        authorized_date_of_birth:
+          type: string
+          format: date
+          required: false
+        share_text:
+          type: string
+          example:
+            - "Wil je alsjeblieft een pakketje voor mij ophalen? Met behulp van deze barcode: https://example.com/barcode/bstn234t32i3"
+          required: false