meow-api.yml

openapi: 3.0.2
info:
  title: Meow
  version: '0.1'
  license:
    name: GNU General Public License v3.0 or later
    url: https://github.com/nash-md/meow/LICENSE
  contact:
    name: Meow
    url: https://github.com/nash-md/meow
servers:
  - url: https://sales-funnel.app
paths:
  /public/login:
    post:
      security: []
      operationId: loginUser
      summary: login
      description: login a user
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                password:
                  type: string
      responses:
        '200':
          description: OK
          $ref: '#/components/responses/LoginResponse'
        '400':
          description: the server did not understand the request
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/NotAuthorized'
        5XX:
          description: Unexpected error.
          $ref: '#/components/responses/ServerError'
  /public/validate-token:
    post:
      security: []
      operationId: validateToken
      summary: validate a token
      description: validate a token
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                token:
                  type: string
      responses:
        '200':
          description: OK
          $ref: '#/components/responses/ValidateTokenResponse'
        '400':
          description: the server did not understand the request
          $ref: '#/components/responses/BadRequest'
        5XX:
          description: Unexpected error.
          $ref: '#/components/responses/ServerError'
  /api/cards:
    get:
      operationId: fetchCards
      summary: fetch cards
      security:
        - AuthenticationToken: []
      description: fetch all cards
      responses:
        '200':
          description: OK
          $ref: '#/components/responses/CardListResponse'
        '400':
          description: the server did not understand the request
          $ref: '#/components/responses/BadRequest'
        5XX:
          description: Unexpected error.
          $ref: '#/components/responses/ServerError'
    post:
      operationId: createCard
      summary: create a new card
      security:
        - AuthenticationToken: []
      description: create a new card
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CardCreateRequest'
      responses:
        '200':
          description: OK
          $ref: '#/components/responses/CardResponse'
        '400':
          description: the server did not understand the request
          $ref: '#/components/responses/BadRequest'
        5XX:
          description: Unexpected error.
          $ref: '#/components/responses/ServerError'
  /api/cards/{cardId}:
    get:
      operationId: fetchCard
      summary: fetch card
      security:
        - AuthenticationToken: []
      description: fetch a card
      parameters:
        - $ref: '#/components/parameters/cardId'
      responses:
        '200':
          description: OK
          $ref: '#/components/responses/CardResponse'
        '400':
          description: the server did not understand the request
          $ref: '#/components/responses/BadRequest'
        '404':
          description: the server did not find the card
          $ref: '#/components/responses/NotFound'
        5XX:
          description: Unexpected error.
          $ref: '#/components/responses/ServerError'
    post:
      operationId: updateCard
      summary: update card
      security:
        - AuthenticationToken: []
      description: fetch a card
      parameters:
        - $ref: '#/components/parameters/cardId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CardUpdateRequest'
      responses:
        '200':
          description: OK
          $ref: '#/components/responses/CardResponse'
        '400':
          description: the server did not understand the request
          $ref: '#/components/responses/BadRequest'
        '404':
          description: the server did not find the card
          $ref: '#/components/responses/NotFound'
        5XX:
          description: Unexpected error.
          $ref: '#/components/responses/ServerError'
  /api/schemas:
    get:
      operationId: fetchSchemas
      summary: fetch schemas
      security:
        - AuthenticationToken: []
      description: fetch all schemas
      parameters: 
        - in:  query
          name: type
          schema:
            type: string
      responses:
        '200':
          description: OK
          $ref: '#/components/responses/SchemaListResponse'
        '400':
          description: the server did not understand the request
          $ref: '#/components/responses/BadRequest'
        5XX:
          description: Unexpected error.
          $ref: '#/components/responses/ServerError'
  /api/accounts:
      get:
        operationId: fetchAccounts
        summary: fetch accounts
        security:
          - AuthenticationToken: []
        description: fetch all accounts
        responses:
          '200':
            description: OK
            $ref: '#/components/responses/AccountListResponse'
          '400':
            description: the server did not understand the request
            $ref: '#/components/responses/BadRequest'
          5XX:
            description: Unexpected error.
            $ref: '#/components/responses/ServerError'
      post:
        operationId: createAccount
        summary: create a new account
        security:
          - AuthenticationToken: []
        description: create a new account
        requestBody:
          required: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountCreateOrUpdateRequest'
        responses:
          '200':
            description: OK
            $ref: '#/components/responses/AccountResponse'
          '400':
            description: the server did not understand the request
            $ref: '#/components/responses/BadRequest'
          5XX:
            description: Unexpected error.
            $ref: '#/components/responses/ServerError'
  /api/accounts/{accountId}:
      get:
        operationId: fetchAccount
        summary: fetch account
        security:
          - AuthenticationToken: []
        description: fetch a card
        parameters:
          - $ref: '#/components/parameters/accountId'
        responses:
          '200':
            description: OK
            $ref: '#/components/responses/AccountResponse'
          '400':
            description: the server did not understand the request
            $ref: '#/components/responses/BadRequest'
          '404':
            description: the server did not find the card
            $ref: '#/components/responses/NotFound'
          5XX:
            description: Unexpected error.
            $ref: '#/components/responses/ServerError'
      post:
        operationId: updateAccount
        summary: update account
        security:
          - AuthenticationToken: []
        description: fetch a card
        parameters:
          - $ref: '#/components/parameters/accountId'
        requestBody:
          required: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountCreateOrUpdateRequest'
        responses:
          '200':
            description: OK
            $ref: '#/components/responses/AccountResponse'
          '400':
            description: the server did not understand the request
            $ref: '#/components/responses/BadRequest'
          '404':
            description: the server did not find the card
            $ref: '#/components/responses/NotFound'
          5XX:
            description: Unexpected error.
            $ref: '#/components/responses/ServerError'
  /api/forecast/achieved:
    get:
      operationId: fetchAchievedForecast
      summary: fetch achieved forecast
      security:
        - AuthenticationToken: []
      description: fetch achieved forecast
      parameters:
        - name: userId
          in: query
          description: User identifier
          required: false
          schema:
            type: string
        - name: start
          in: query
          description: Start date for the forecast
          required: true
          schema:
            type: string
        - name: end
          in: query
          description: End date for the forecast
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json: {}
        '400':
          description: the server did not understand the request
          $ref: '#/components/responses/BadRequest'
        5XX:
          description: Unexpected error.
          $ref: '#/components/responses/ServerError'
  /api/forecast/predicted:
    get:
      operationId: fetchPredictedForecast
      summary: fetch predicted forecast
      security:
        - AuthenticationToken: []
      description: fetch predicted forecast
      parameters:
        - name: userId
          in: query
          description: User identifier
          required: false
          schema:
            type: string
        - name: start
          in: query
          description: Start date for the forecast
          required: true
          schema:
            type: string
        - name: end
          in: query
          description: End date for the forecast
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json: {}
        '400':
          description: the server did not understand the request
          $ref: '#/components/responses/BadRequest'
        5XX:
          description: Unexpected error.
          $ref: '#/components/responses/ServerError'
  /api/forecast/list:
    get:
      operationId: fetchForecastList
      summary: fetch predicted list
      security:
        - AuthenticationToken: []
      description: fetch predicted list
      parameters:
        - name: userId
          in: query
          description: User identifier
          required: false
          schema:
            type: string
        - name: mode
          in: query
          description: Query mode
          required: false
          schema:
            type: string
        - name: start
          in: query
          description: Start date for the forecast
          required: true
          schema:
            type: string
        - name: end
          in: query
          description: End date for the forecast
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json: {}
        '400':
          description: the server did not understand the request
          $ref: '#/components/responses/BadRequest'
        5XX:
          description: Unexpected error.
          $ref: '#/components/responses/ServerError'
components:
  securitySchemes:
    AuthenticationToken:
      type: apiKey
      in: header
      name: Token
  schemas:
    CardCreateRequest:
      type: object
      properties:
        name:
          type: string
        laneId:
          type: string
        laneName:
          type: string
        amount:
          type: number
        closedAt:
          type: string
          format: date-time
        nextFollowUpAt:
          type: string
          format: date-time
    CardUpdateRequest:
      type: object
      properties:
        name:
          type: string
        userId:
            type: string
        laneId:
          type: string
        laneName:
          type: string
        status:
          type: string
        amount:
          type: number
        closedAt:
          type: string
          format: date-time
        nextFollowUpAt:
          type: string
          format: date-time
    Card:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        userId:
          type: string
        laneId:
          type: string
        status:
          type: string
        amount:
          type: number
        closedAt:
          type: string
          format: date-time
        nextFollowUpAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        createdAt:
          type: string
          format: date-time
    Account:
      type: object
      properties:
        id:
          type: string
        teamId:
          type: string
        name:
          type: string
        attributes:
          $ref: '#/components/schemas/Attribute'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    AccountCreateOrUpdateRequest:
      type: object
      properties:
        name:
          type: string
        attributes:
          $ref: '#/components/schemas/Attribute'
    Attribute:
      type: object
      additionalProperties:
        oneOf:
          - type: string
          - type: integer
          - type: 'null'
    User:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        name:
          type: string
          readOnly: true
        status:
          type: string
        createdAt:
          type: string
          format: date-time
          readOnly: true
        updatedAt:
          type: string
          format: date-time
          readOnly: true
    Team:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        name:
          type: string
          readOnly: true
        createdAt:
          type: string
          format: date-time
          readOnly: true
        updatedAt:
          type: string
          format: date-time
          readOnly: true
    SchemaAttribute:
      description: response to a create account request
      type: object
      properties:
        key:
          type: string
        index:
          type: integer
        name:
          type: string
        type:
          type: string
          enum: [text, textarea, select, reference, boolean, email]
        options:
          type: array
          items:
            type: string
    SchemaType:
      type: string
      enum: [card, account]
    Schema:
      type: object
      properties:
        id:
          type: string
        teamId:
          type: string
        type:
          $ref: '#/components/schemas/SchemaType'
        schema:
          type: array
          items:
            $ref: '#/components/schemas/SchemaAttribute'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        id:
          type: string
        description:
          type: string
  parameters:
    userId:
      in: path
      description: 'The unique identifier of the user.'
      name: userId
      required: true
      schema:
        type: string
    cardId:
      in: path
      description: 'The unique identifier of the card.'
      name: cardId
      required: true
      schema:
        type: string
    accountId:
      in: path
      description: 'The unique identifier of the account.'
      name: accountId
      required: true
      schema:
        type: string
  responses:
    NotAuthorized:
      description: The request is unauthorized.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ServerError:
      description: A server error occured
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: The request was invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ValidateTokenResponse:
      description: response to a token validation request
      content:
        application/json:
          schema:
            type: object
            properties:
              isValid:
                type: boolean
              body:
                type: object
                properties:
                  token:
                    type: string
                  user:
                    type: object
                    properties: 
                      id:
                        type: string
                      name:
                        type: string
                  team:
                    type: object
                    properties: 
                      id:
                        type: string
                      currency:
                        type: string
    LoginResponse:
      description: response to a valid login request
      content:
        application/json:
          schema:
            type: object
            properties:
              token:
                type: string
              user:
                type: object
                properties: 
                  id:
                    type: string
                  name:
                    type: string
              team:
                type: object
                properties: 
                  id:
                    type: string
                  currency:
                    type: string
    CardResponse:
      description: response to a card request
      content:
        application/json:
          schema:
            type: object
            $ref: '#/components/schemas/Card'
    CardListResponse:
      description: response to a create card request
      content:
        application/json:
          schema:
            type: array
            items:
              type: object
              $ref: '#/components/schemas/Card'
    AccountResponse:
      description: response to a account request
      content:
        application/json:
          schema:
            type: object
            $ref: '#/components/schemas/Account'
    AccountListResponse:
      description: response to a create account request
      content:
        application/json:
          schema:
            type: array
            items:
              type: object
              $ref: '#/components/schemas/Account'
    SchemaListResponse:
      description: list all schemas
      content:
        application/json:
          schema:
            type: array
            items:
              type: object
              $ref: '#/components/schemas/Schema'