swagger

swagger: "2.0"
info:
  version: "1.0.0"
  title: Oval App

securityDefinitions:
  adminKey:
    type: apiKey
    description: Adminpanel token we get after authentication
    name: x-auth-token
    in: header
  userKey:
    type: apiKey
    description: Normal user token we get after authentication
    name: x-auth-token
    in: header
# during dev, should point to your local machine
host: api.ovalmoney.com
# basePath prefixes all resource paths
basePath: /
#
schemes:
  # tip: remove http to make production-grade
  - https
# format of bodies a client can send (Content-Type)
consumes:
  - application/json
# format of the responses to the client (Accepts)
produces:
  - application/json
tags:
  - name: Auth
    description: Authentication-related endpoints
  - name: Bad Wolf
    description: Bad Wolf Bad Wolf Bad Wolf
  - name: Adminpanel
    description: Adminpanel endpoints
  - name: Client
    description: Client endpoints
  - name: Profile
    description: Profile control and info
  - name: General
    description: General information for the app
  - name: Yodlee
    description: Yodlee-related endpoints
  - name: Mangopay
    description: Mangopay-related endpoints
  - name: Banking
    description: Banking information
  - name: Reporting
    description: Reporting methods
  - name: Rules
    description: Rules methods
  - name: Push Notifications
    description: Push notifications registration endpoints.
paths:
  /login/email/verify:
    x-swagger-router-controller: login_local
    get:
      tags:
        - Auth
        - Client
      description: Returns whether email was already registered
      operationId: verify_email
      parameters:
        - name: email
          in: query
          description: Email to be verified
          required: true
          type: string
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/UserExistenceCheckResponse"
        "400":
          description: Malformed input

        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /login/email/perform:
    x-swagger-router-controller: login_local
    post:
      tags:
        - Auth
        - Client
      description: Perfoms email login
      operationId: login_email
      parameters:
        - name: data
          in: body
          description: Email login body
          required: true
          schema:
            $ref: "#/definitions/EmailLoginBody"
      responses:
        "200":
          description: Login success
          schema:
            $ref: "#/definitions/UserLoginResponse"
        "400":
          description: Malformed input
        "404":
          description: User not found
        "403":
          description: Invalid credentials
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /login/facebook/verify:
    x-swagger-router-controller: login_facebook
    post:
      tags:
        - Auth
        - Client
      description: Returns whether the specified facebook access_token is already registered
      operationId: verify_facebook
      parameters:
        - name: data
          in: body
          description: Facebook verification body
          required: true
          schema:
            $ref: "#/definitions/FacebookLoginBody"

      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/UserExistenceCheckResponse"
        "400":
          description: Malformed input
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /login/facebook/bind:
    x-swagger-router-controller: login_facebook
    post:
      tags:
        - Auth
        - Client
      security:
        - userKey: []
      description: Performs a facebook login
      operationId: bind_facebook
      parameters:
        - name: data
          in: body
          description: Facebook login body
          required: true
          schema:
            $ref: "#/definitions/FacebookLoginBody"
      responses:
        "200":
          description: Attachment successful
        "400":
          description: Malformed input
        "403":
          description: Invalid token
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /login/facebook/perform:
    x-swagger-router-controller: login_facebook
    post:
      tags:
        - Auth
        - Client
      description: Performs a facebook login
      operationId: login_facebook
      parameters:
        - name: data
          in: body
          description: Facebook login body
          required: true
          schema:
            $ref: "#/definitions/FacebookLoginBody"
      responses:
        "200":
          description: Login successful
          schema:
            $ref: "#/definitions/UserLoginResponse"
        "400":
          description: Malformed input
        "403":
          description: Invalid token
        "404":
          description: User not found
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /register/facebook/perform:
    x-swagger-router-controller: login_facebook
    post:
      tags:
        - Auth
        - Client
      description: Performs a Facebook registraction
      operationId: register_facebook
      parameters:
        - name: data
          in: body
          description: Registration body
          required: true
          schema:
            $ref: "#/definitions/FacebookRegistrationBody"
      responses:
        "200":
          description: Registration successful
          schema:
            $ref: "#/definitions/UserLoginResponse"
        "400":
          description: Malformed input
        "403":
          description: Invalid token
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /register/email/perform:
    x-swagger-router-controller: login_local
    post:
      tags:
        - Auth
        - Client
      description: Performs an email registraction
      operationId: register_email
      parameters:
        - name: data
          in: body
          description: Registration body
          required: true
          schema:
            $ref: "#/definitions/EmailRegistrationBody"
      responses:
        "200":
          description: Registration successful
          schema:
            $ref: "#/definitions/UserLoginResponse"
        "400":
          description: Malformed input
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /user/profile/logout/all:
    x-swagger-router-controller: profile
    post:
      tags:
        - Auth
        - Client
      security:
        - userKey: []
      description: Logouts all other current user sessions
      operationId: logout_all_user
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/UserLoginResponse"
        "403":
          description: Access denied
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /user/is_logged_in:
    x-swagger-router-controller: profile
    post:
      tags:
        - Auth
        - Client
      security:
        - userKey: []
      description: Checks that the user is logged in (token validation)
      operationId: is_logged_in_user
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/UserLoginResponse"
        "403":
          description: Invalid token
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /user/profile:
    x-swagger-router-controller: profile
    get:
      tags:
        - Client
        - Profile
      security:
        - userKey: []
      description: Gets the profile of the specified user
      operationId: get_profile
      parameters:
        - name: id
          in: query
          description: the id of the user
          required: true
          type: integer
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/UserProfileResponse"
        "400":
          description: Malformed request
        "403":
          description: Access denied
        "404":
          description: User not found
        default:
            description: Error
            schema:
              $ref: "#/definitions/ErrorResponse"
    post:
      tags:
        - Client
        - Profile
      security:
        - userKey: []
      description: Changes the profile of the specified user
      operationId: change_profile
      parameters:
        - name: data
          in: body
          description: Change profile request body
          required: true
          schema:
            $ref: "#/definitions/UserProfileChangeRequest"
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/UserLoginResponse"
        "400":
          description: Malformed request
        "403":
          description: Access denied
        "404":
          description: User not found
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /versions.json:
    x-swagger-router-controller: versions
    get:
      tags:
        - Client
        - General
      description: Gets the avaliable app versions
      operationId: get_versions
      responses:
        "200":
          description: Success
          schema:
              $ref: "#/definitions/VersionsResponse"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /server/time:
    x-swagger-router-controller: server
    post:
      tags:
        - Client
        - General
      description: Gets the current server date-time
      operationId: get_time
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/TimeResponse"

        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /flags/flag-{countryCode2}@{scaleFactor}x.png:
    get:
      produces:
        - image/png
      tags:
        - Client
        - General
      description: Gets country's flag
      operationId: get_country_flag
      parameters:
        - name: countryCode2
          type: string
          in: path
          required: true
        - name: scaleFactor
          type: integer
          in: path
          required: true
      responses:
        "200":
          description: Success
          schema:
            type: string
            format: binary
  /countries:
    x-swagger-router-controller: country
    get:
      tags:
        - Client
        - General
      description: Gets all countries
      operationId: all_countries
      responses:
        "200":
          description: Success
          schema:
            type: array
            items:
              $ref: "#/definitions/CountryResponse"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /user/profile/image:
    x-swagger-router-controller: profile
    post:
      tags:
        - Client
        - Profile
      description: Upload profile image
      operationId: upload_profile_image
      consumes:
        - multipart/form-data
      security:
        - userKey: []
      parameters:
        - name: image
          in: formData
          description: The profile image
          required: true
          type: file
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/UserAvatar"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
    delete:
      tags:
        - Client
        - Profile
      security:
        - userKey: []
      description: Delete profile image
      operationId: delete_profile_image
      responses:
        "200":
          description: Success
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /user/profile/password/reset/request:
    x-swagger-router-controller: profile
    post:
      tags:
        - Client
        - Profile
      description: Request password reset
      operationId: request_reset
      parameters:
        - name: data
          in: body
          description: Change profile request body
          required: true
          schema:
            $ref: "#/definitions/PasswordResetBody"
      responses:
        "200":
          description: Request successful
        "400":
          description: Invalid email
        "403":
          description: User was registered through facebook
        "404":
          description: User not found

        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /user/profile/password/reset/do:
    x-swagger-router-controller: profile
    post:
      tags:
        - Client
        - Adminpanel
        - Profile
      description: Request password reset
      operationId: perform_reset
      parameters:
        - name: data
          in: body
          description: Change profile request body
          required: true
          schema:
            $ref: "#/definitions/PasswordResetDoBody"
      responses:
        "200":
          description: Request successful
        "400":
          description: Malformed request
        "403":
          description: Invalid token

        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /user/profile/yodlee/fastlink/url:
    x-swagger-router-controller: yodlee_controller
    post:
      tags:
        - Yodlee
        - Client
        - Banking
      security:
        - userKey: []
      description: Gets the fastlink url and body
      operationId: get_fast_link_url
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/UrlResponse"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /user/profile/yodlee/accounts:
    x-swagger-router-controller: yodlee_controller
    post:
      tags:
        - Profile
        - Yodlee
        - Client
        - Banking
      security:
        - userKey: []
      description: Gets all the yodlee's attached accounts
      operationId: accounts_summary_all
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/YodleeAccountsResponse"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /user/profile/yodlee/account:
    x-swagger-router-controller: yodlee_controller
    post:
      tags:
        - Profile
        - Yodlee
        - Client
        - Banking
      security:
        - userKey: []
      description: Change state of yodlee item account
      operationId: change_item_account_state
      parameters:
        - name: data
          in: body
          description: Change item account state body
          required: true
          schema:
            $ref: "#/definitions/ChangeItemAccountStateBody"
      responses:
        "200":
          description: State changed
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
    delete:
      tags:
        - Profile
        - Yodlee
        - Client
        - Banking
      security:
        - userKey: []
      description: Delete yodlee item account
      operationId: remove_item_account
      parameters:
        - name: itemAccountId
          in: query
          description: Remove item account body
          required: true
          type: string
      responses:
        "200":
          description: State changed
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /user/profile/yodlee/callback/{userId}:
    x-swagger-router-controller: yodlee_controller
    post:
      tags:
        - Profile
        - Yodlee
        - Banking
      description: Callback for yodlee's fastlink
      operationId: yodlee_callback_processor
      parameters:
        - name: status
          in: query
          description: status from Yodlee API as per https://developer.yodlee.com/Fastlink_2.0/FastLink_Integration_Guide_for_Web/Fastlink_Callback_Parameters
          required: false
          type: string
        - name: userId
          in: path
          description: id of the user
          required: true
          type: number
          format: int64
      responses:
        "200":
          description: Success
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /user/profile/yodlee/callback/listener:
    x-swagger-router-controller: yodlee_controller
    post:
      tags:
        - Profile
        - Client
        - Yodlee
        - Banking
      security:
        - userKey: []
      description: Listener for whether the callback was called, this is a long-poll request
      operationId: yodlee_callback_listener
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/YodleeCallbackListenerResponse"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /user/profile/mangopay/balance:
    x-swagger-router-controller: mangopay_controller
    post:
      tags:
        - Profile
        - Mangopay
        - Client
        - Banking
      security:
        - userKey: []
      description: Gets the wallet balance for the user
      operationId: get_wallet_balance
      responses:
        "200":
          description: Wallet balance
          schema:
            $ref: "#/definitions/TotalBalance"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /user/profile/mangopay/withdraw:
    x-swagger-router-controller: mangopay_controller
    post:
      tags:
        - Profile
        - Mangopay
        - Client
        - Banking
      security:
        - userKey: []
      description: Withdraws money from user balance
      operationId: withdraw
      parameters:
        - name: data
          in: body
          description: Money to withdraw
          required: true
          schema:
            $ref: "#/definitions/MoneyOperationBody"
      responses:
        "200":
          description: Withdraw successful
          schema:
            $ref: "#/definitions/TransactionInfo"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /user/profile/mangopay/deposit:
    x-swagger-router-controller: mangopay_controller
    post:
      tags:
        - Profile
        - Mangopay
        - Client
        - Banking
      security:
        - userKey: []
      description: Deposits money to user wallet
      operationId: deposit
      parameters:
        - name: data
          in: body
          description: Money to deposit
          required: true
          schema:
            $ref: "#/definitions/MoneyOperationBody"
      responses:
        "200":
          description: Deposit successful
          schema:
            $ref: "#/definitions/TransactionInfo"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /user/profile/mangopay/account:
    x-swagger-router-controller: mangopay_controller
    post:
      tags:
        - Profile
        - Mangopay
        - Client
        - Banking
      security:
        - userKey: []
      description: Attach a bank account to the current profile
      operationId: attach_bank_account
      parameters:
        - name: data
          in: body
          description: Money to deposit
          required: true
          schema:
            $ref: "#/definitions/AttachMangopayAccountBody"
      responses:
        "200":
          description: Attachment successful
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
    get:
      tags:
        - Profile
        - Mangopay
        - Client
        - Banking
      security:
        - userKey: []
      description: Gets bank account information
      operationId: get_bank_account_info
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/MangopayBankAccount"
        "404":
          description: No bank account attached
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
    delete:
      tags:
        - Profile
        - Mangopay
        - Client
        - Banking
      security:
        - userKey: []
      description: Deletes the bank account
      operationId: detach_bank_account
      responses:
        "200":
          description: Success
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /user/profile/mangopay/account/identity:
    x-swagger-router-controller: mangopay_controller
    post:
      tags:
        - Profile
        - Mangopay
        - Client
        - Banking
      security:
        - userKey: []
      description: Attaches identity proof documents to the account. Info is avaliable later in profile.
      operationId: identity_proof
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: "#/definitions/IdentityProofRequest"
      responses:
        "200":
          description: Successful upload
        default:
          description: Error happened. Note, here 3 additional error codes are possible - invalid_mime_type, document_validation_in_progress, document_already_validated
          schema:
            $ref: "#/definitions/ErrorResponse"

  /transaction/types:
    x-swagger-router-controller: transaction_types
    get:
      tags:
        - Client
        - Banking
      security:
        - userKey: []
      description: Gets all the possible transaction type boundaries
      operationId: all_types
      responses:
        "200":
          description: Success
          schema:
            type: array
            items:
              $ref: "#/definitions/BoundaryResponse"

        "403":
          description: Not authorized

        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /transaction/mangopay/all:
    x-swagger-router-controller: transactions
    get:
      tags:
        - Client
        - Banking
      security:
        - userKey: []
      description: Gets all mangopay transactions
      operationId: list_mangopay_transactions
      parameters:
        - name: startingId
          in: query
          type: number
          format: int64
          description: Last known transaction id (they are ordered DESC by id).
      responses:
        "200":
          description: Success
          schema:
            type: array
            items:
              $ref: "#/definitions/TransactionInfo"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /transaction/mangopay/{id}:
    x-swagger-router-controller: transactions
    get:
      tags:
        - Client
        - Banking
      security:
        - userKey: []
      description: Get one mangopay transaction
      operationId: get_mangopay_transaction
      parameters:
        - name: id
          in: path
          type: number
          format: int64
          required: true
          description: id of the transaction to get
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/TransactionInfo"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /transaction/category/normal:
    x-swagger-router-controller: transactions
    get:
      tags:
        - Client
        - Banking
      security:
        - userKey: []
      description: Lists all the transaction categories
      operationId: list_transaction_categories
      responses:
        "200":
          description: Success
          schema:
            type: array
            items:
              $ref: "#/definitions/TransactionCategory"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /transaction/category/base:
    x-swagger-router-controller: transactions
    get:
      tags:
        - Client
        - Yodlee
        - Banking
      security:
        - userKey: []
      description: Lists all the base transaction categories
      operationId: list_transaction_base_categories
      responses:
        "200":
          description: Success
          schema:
            type: array
            items:
              $ref: "#/definitions/BaseTransactionCategory"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"


  /transaction/viewed:
    x-swagger-router-controller: transactions
    post:
      tags:
        - Client
        - Yodlee
        - Banking
      security:
        - userKey: []
      description: Marks transactions as viewed or not viewed
      operationId: mark_as_viewed
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/MarkAsViewed'
      responses:
        "200":
          description: Success
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /transaction/count:
    x-swagger-router-controller: transactions
    get:
      tags:
        - Client
        - Yodlee
        - Banking
      security:
        - userKey: []
      description: Counts the transactions with filter
      operationId: count_transactions
      parameters:
        - name: isMagicRuleApplicable
          in: query
          type: integer
        - name: filterDate
          in: query
          type: string
          format: date
        - name: viewed
          in: query
          type: integer
      responses:
        "200":
          description: Success
          schema:
            $ref: '#/definitions/CountResponse'
        "403":
          description: Not authorized
        "404":
          description: Not found
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /transaction/all:
    x-swagger-router-controller: transactions
    get:
      tags:
        - Client
        - Yodlee
        - Banking
      security:
        - userKey: []
      description: Gets all the user transactions
      operationId: list_transactions
      parameters:
        - name: lastId
          in: query
          type: integer
        - name: isMagicRuleApplicable
          in: query
          type: integer
        - name: filterDate
          in: query
          type: string
          format: date
        - name: viewed
          in: query
          type: integer
      responses:
        "200":
          description: Success
          schema:
            type: array
            items:
              $ref: "#/definitions/Transaction"
        "403":
          description: Not authorized
        "404":
          description: Not found
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /transaction/{id}:
    x-swagger-router-controller: transactions
    get:
      tags:
        - Client
        - Yodlee
        - Banking
      security:
        - userKey: []
      description: Gets all the user transactions
      operationId: get_transaction
      parameters:
        - name: id
          in: path
          type: integer
          required: true
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/Transaction"
        "403":
          description: Not authorized
        "404":
          description: Not found
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /transaction/stats/daysofweek:
    x-swagger-router-controller: transactions
    get:
      tags:
        - Client
        - Yodlee
        - Banking
      security:
        - userKey: []
      description: Get the average of transactions per days of the week
      operationId: get_transaction_per_dayofweek_average
      responses:
        "200":
          description: Success
          schema:
            type: array
            items:
              $ref: "#/definitions/TransactionsStats"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /report:
    x-swagger-router-controller: reporting
    post:
      tags:
        - Client
        - Reporting
      security:
        - userKey: []
      description: Add report
      operationId: add_report
      parameters:
        - name: data
          in: body
          description: Report
          required: true
          schema:
            $ref: "#/definitions/AddReport"
      responses:
        "200":
          description: Success
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /rule:
    x-swagger-router-controller: rules
    get:
      tags:
        - Rules
        - Client
      security:
        - userKey: []
      description: Get one rule
      operationId: get_rule
      parameters:
        - name: id
          in: query
          description: Rule ID
          required: true
          type: integer
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/Rule"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
    post:
      tags:
        - Rules
        - Client
      security:
        - userKey: []
      description: Create one rule
      operationId: add_rule
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: "#/definitions/RuleCreation"
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/Rule"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
    put:
      tags:
        - Rules
        - Client
      security:
        - userKey: []
      description: Edit one rule
      operationId: edit_rule
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: "#/definitions/RuleEdit"
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/Rule"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
    delete:
      tags:
        - Rules
        - Client
      security:
        - userKey: []
      description: Delete one rule
      operationId: delete_rule
      parameters:
        - name: id
          in: query
          description: Rule ID
          required: true
          type: integer
      responses:
        "200":
          description: Success
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /rule/all:
    x-swagger-router-controller: rules
    get:
      tags:
        - Rules
        - Client
      security:
        - userKey: []
      description: Get all rules
      operationId: get_rules
      parameters:
        - name: lastId
          in: query
          required: true
          type: integer
        - name: active
          in: query
          type: number
      responses:
        "200":
          description: Success
          schema:
            type: array
            items:
              $ref: "#/definitions/Rule"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /rule/collection/all:
    x-swagger-router-controller: rules
    get:
      tags:
        - Rules
        - Client
      security:
        - userKey: []
      description: Get all rule collections
      operationId: get_rule_collections
      responses:
        "200":
          description: Success
          schema:
            type: array
            items:
              $ref: "#/definitions/RuleCollection"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /rule/collection/rules/all:
    x-swagger-router-controller: rules
    get:
      tags:
        - Rules
        - Client
      security:
        - userKey: []
      description: Get all rules from collection
      operationId: get_rules_from_collection
      parameters:
        - name: id
          in: query
          required: true
          type: integer
      responses:
        "200":
          description: Success
          schema:
            type: array
            items:
              $ref: "#/definitions/Rule"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /admin/api/collections:
    x-swagger-router-controller: collections
    get:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Get collections
      operationId: getCollections
      parameters:
        - name: limit
          in: query
          type: number
          required: true
        - name: offset
          in: query
          type: number
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/getCollections"
        "403":
          description: Not authorized
        "404":
          description: Not found
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /api/collections:
    x-swagger-router-controller: collections
    get:
      tags:
        - Client
      security:
        - userKey: []
      description: Get collections
      operationId: getCollections
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/getCollections"
        "403":
          description: Not authorized
        "404":
          description: Not found
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /admin/api/collection:
    x-swagger-router-controller: collections
    get:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Get collection by Id
      operationId: getCollection
      parameters:
        - name: id
          in: query
          type: number
          required: true
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/Collection"
        "403":
          description: Not authorized
        "404":
          description: Not found
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
    post:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Add or update collection
      operationId: postCollection
      parameters:
        - name: id
          in: query
          type: number
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/Collection"
        "403":
          description: Not authorized
        "404":
          description: Not found
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
    delete:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Delete collection
      operationId: deleteCollection
      parameters:
        - name: id
          in: query
          type: number
          required: true
      responses:
        "200":
          description: Success
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /admin/api/collection/prototype:
    x-swagger-router-controller: collections
    post:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Add prototype to collection
      operationId: addPrototype
      parameters:
        - name: collectionId
          in: query
          type: number
          required: true
        - name: prototypeId
          in: query
          type: number
          required: true
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/Prototype"
        "403":
          description: Not authorized
        "404":
          description: Not found
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
    delete:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Delete prototype from collection
      operationId: deletePrototype
      parameters:
        - name: collectionId
          in: query
          type: number
          required: true
        - name: prototypeId
          in: query
          type: number
          required: true
      responses:
        "200":
          description: Success
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /api/prototypes:
    x-swagger-router-controller: prototypes
    get:
      tags:
        - Client
      security:
        - userKey: []
      description: Get prototypes
      operationId: getPrototypes
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/getPrototypes"
        "403":
          description: Not authorized
        "404":
          description: Not found
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /admin/api/prototypes:
    x-swagger-router-controller: prototypes
    get:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Get prototypes
      operationId: getPrototypes
      parameters:
        - name: limit
          in: query
          type: number
        - name: offset
          in: query
          type: number
        - name: order
          in: query
          type: string
          enum: ['ASC', 'DESC']
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/getPrototypes"
        "403":
          description: Not authorized
        "404":
          description: Not found
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /admin/api/prototype:
    x-swagger-router-controller: prototypes
    get:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Get prototype by Id
      operationId: getPrototype
      parameters:
        - name: id
          in: query
          type: number
          required: true
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/Prototype"
        "403":
          description: Not authorized
        "404":
          description: Not found
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
    post:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Add or update prototype
      operationId: postPrototype
      parameters:
        - name: id
          in: query
          type: number
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/Prototype"
        "403":
          description: Not authorized
        "404":
          description: Not found
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
    delete:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Delete prototype
      operationId: deletePrototype
      parameters:
        - name: id
          in: query
          type: number
          required: true
      responses:
        "200":
          description: Success
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /api/prototype/follow:
    x-swagger-router-controller: prototypes
    get:
      tags:
        - Client
      security:
        - userKey: []
      description: Follow prototype
      operationId: prototypeFollow
      parameters:
        - name: id
          in: query
          type: number
          required: true
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/Rule"
        "403":
          description: Not authorized
        "404":
          description: Not found
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /notifications/device:
    x-swagger-router-controller: push_notifications
    post:
      tags:
        - Push Notifications
        - Client
      security:
        - userKey: []
      description: Registers a push notification device
      operationId: add_device
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/RegisterPushNotificationDevice'
      responses:
        "200":
          description: Success
          schema:
            $ref: '#/definitions/PushNotificationDevice'
        "403":
          description: Access denied
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /notifications/device/{id}:
    x-swagger-router-controller: push_notifications
    put:
      tags:
        - Push Notifications
        - Client
      security:
        - userKey: []
      description: Edits a push notification device
      operationId: edit_device
      parameters:
        - name: id
          in: path
          required: true
          type: integer
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/EditPushNotificationDevice'
      responses:
        "200":
          description: Success
          schema:
            $ref: '#/definitions/PushNotificationDevice'
        "403":
          description: Access denied
        "404":
          description: Push device not found
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
    get:
      tags:
        - Push Notifications
        - Client
      security:
        - userKey: []
      description: Gets a push notification device
      operationId: get_device
      parameters:
        - name: id
          in: path
          required: true
          type: integer
      responses:
        "200":
          description: Success
          schema:
            $ref: '#/definitions/PushNotificationDevice'
        "403":
          description: Access denied
        "404":
          description: Push device not found
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
    delete:
      tags:
        - Push Notifications
        - Client
      security:
        - userKey: []
      description: Deletes a push notification device
      operationId: remove_device
      parameters:
        - name: id
          in: path
          required: true
          type: integer
      responses:
        "200":
          description: Success
        "403":
          description: Access denied
        "404":
          description: Push device not found
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /notifications/device/all:
    x-swagger-router-controller: push_notifications
    get:
      tags:
        - Push Notifications
        - Client
      security:
        - userKey: []
      description: Gets all push notification devices
      operationId: list_devices
      responses:
        "200":
          description: Success
          schema:
            type: array
            items:
              $ref: '#/definitions/PushNotificationDevice'
        "403":
          description: Access denied
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /admin/api/report/all:
    x-swagger-router-controller: reporting
    get:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: List reports
      operationId: list_reports
      parameters:
        - name: lastId
          in: query
          required: true
          type: integer
        - name: isRead
          in: query
          required: true
          type: integer
      responses:
        "200":
          description: Success
          schema:
            type: array
            items:
              $ref: "#/definitions/Report"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /admin/api/report/state/change:
    x-swagger-router-controller: reporting
    post:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Change report state
      operationId: change_report_state
      parameters:
        - name: data
          in: body
          description: Report state change query
          required: true
          schema:
            $ref: "#/definitions/SetReportState"
      responses:
        "200":
          description: Success
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /admin/api/users:
    x-swagger-router-controller: admin_users
    get:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Gets all users from the database
      operationId: get_all_users
      parameters:
        - name: startingId
          in: query
          description: id of the last known user, 0 if no users known
          required: true
          type: integer
        - name: sortField
          in: query
          description: Ordering field to use (+id, -id, +lastName, etc)
          type: string
      responses:
        "200":
          description: Success
          schema:
            type: array
            items:
              $ref: "#/definitions/UserProfileResponse"
        "403":
          description: Not authorized
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /admin/api/users/one:
    x-swagger-router-controller: admin_users
    get:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Gets one user from the database
      operationId: get_one_user
      parameters:
        - name: id
          in: query
          description: the id of the user
          required: true
          type: integer
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/UserProfileResponse"
        "403":
          description: Not authorized
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
    post:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Changes one user
      operationId: edit_one_user
      parameters:
        - name: data
          in: body
          description: Change profile request body
          required: true
          schema:
            $ref: "#/definitions/UserProfileChangeRequestAdmin"
      responses:
        "200":
          description: Success
        "403":
          description: Not authorized
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /admin/api/admins:
    x-swagger-router-controller: admin_admins
    get:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Gets all users from the database
      operationId: get_all_admins
      responses:
        "200":
          description: Success
          schema:
            type: array
            items:
              $ref: "#/definitions/AdminProfileResponse"
        "403":
          description: Not authorized
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /admin/api/admins/one:
    x-swagger-router-controller: admin_admins
    delete:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Deletes one admin
      operationId: delete_one_admin
      parameters:
        - name: data
          in: body
          description: Change profile request body
          required: true
          schema:
            $ref: "#/definitions/IDOnlyRequest"
      responses:
        "200":
          description: Success
        "403":
          description: Not authorized
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /admin/api/login:
    x-swagger-router-controller: admin_auth
    post:
      tags:
        - Adminpanel
      description: Logins as admin user
      operationId: login_admin
      parameters:
        - name: data
          in: body
          description: Login request body
          required: true
          schema:
            $ref: "#/definitions/AdminLoginBody"
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/AdminLoginResponse"
        "403":
          description: Invalid user
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /admin/api/logout/all:
    x-swagger-router-controller: admin_auth
    post:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Logouts all other current admin sessions
      operationId: logout_all_admin
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/AdminLoginResponse"
        "403":
          description: Access denied
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /admin/api/register:
    x-swagger-router-controller: admin_auth
    post:
      tags:
        - Adminpanel
      description: Logins as admin user
      operationId: register_admin
      parameters:
        - name: data
          in: body
          description: Login request body
          required: true
          schema:
            $ref: "#/definitions/AdminRegisterBody"
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/AdminLoginResponse"
        "403":
          description: Invalid token or taken username
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /admin/api/is_logged_in:
    x-swagger-router-controller: admin_auth
    post:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Checks that admin is logged in
      operationId: is_logged_in_admin
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/AdminLoginResponse"
        "403":
          description: Invalid token or taken username
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /admin/api/custom/code/request:
    x-swagger-router-controller: admin_admins
    post:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Requests link for admin user
      operationId: code_admin_request
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/AdminCodeResponse"
        "403":
          description: Access denied
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /admin/api/countries:
    x-swagger-router-controller: country
    get:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Gets all countries
      operationId: all_countries_admin
      responses:
        "200":
          description: Success
          schema:
            type: array
            items:
              $ref: "#/definitions/CountryResponse"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /admin/api/transaction/boundaries:
    x-swagger-router-controller: admin_transaction_types
    get:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Gets all the type boundaries defined
      operationId: all_transaction_types_admin
      responses:
        "200":
          description: Success
          schema:
            type: array
            items:
              $ref: "#/definitions/BoundaryResponse"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
    post:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Replaces transaction types with the new ones
      operationId: replace_transaction_types
      parameters:
        - in: body
          name: data
          description: Transaction types (in cents!)
          required: true
          schema:
            type: array
            items:
              type: integer
      responses:
        "200":
          description: Success
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /admin/api/password/change:
    x-swagger-router-controller: admin_auth
    post:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Changes current AdminUser password
      operationId: change_password_admin
      parameters:
        - name: data
          in: body
          description: Login request body
          required: true
          schema:
            $ref: "#/definitions/AdminPasswordChangeRequest"
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/AdminLoginResponse"
        "400":
          description: Invalid new password
        "403":
          description: Invalid token
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /admin/api/password/reset:
    x-swagger-router-controller: admin_auth
    post:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Resets specified AdminUser password
      operationId: reset_password_admin
      parameters:
        - name: data
          in: body
          description: Login request body
          required: true
          schema:
            $ref: "#/definitions/AdminPasswordResetRequest"
      responses:
        "200":
          description: Success
        "400":
          description: Invalid new password
        "403":
          description: Invalid token or trying to reset admin
        "404":
          description: User not found
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /admin/api/transaction/mangopay/all:
    x-swagger-router-controller: transactions
    get:
      tags:
        - Client
        - Banking
      security:
        - adminKey: []
      description: Gets all mangopay transactions
      operationId: list_mangopay_transactions_admin
      parameters:
        - name: startingId
          in: query
          type: number
          format: int64
          required: true
          description: Last known transaction id, or 0 if none known
        - name: userId
          in: query
          type: number
          format: int64
          required: false
          description: The user to filter the transaction by
      responses:
        "200":
          description: Success
          schema:
            type: array
            items:
              $ref: "#/definitions/TransactionInfo"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /admin/api/transaction/mangopay/{id}:
    x-swagger-router-controller: transactions
    get:
      tags:
        - Client
        - Banking
      security:
        - adminKey: []
      description: Get one mangopay transaction
      operationId: get_mangopay_transaction_admin
      parameters:
        - name: id
          in: path
          type: number
          format: int64
          required: true
          description: id of the transaction to get
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/TransactionInfo"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /admin/api/currencies:
    x-swagger-router-controller: currencies
    get:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Gets all currencies
      operationId: all_currencies
      responses:
        "200":
          description: Success
          schema:
            type: array
            items:
              $ref: "#/definitions/CurrencyInfo"

  /admin/api/transaction/category/normal:
    x-swagger-router-controller: transactions
    get:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Lists all the transaction categories
      operationId: list_transaction_categories_admin
      responses:
        "200":
          description: Success
          schema:
            type: array
            items:
              $ref: "#/definitions/TransactionCategory"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /admin/api/transaction/category/base:
    x-swagger-router-controller: transactions
    get:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Lists all the base transaction categories
      operationId: list_transaction_base_categories_admin
      responses:
        "200":
          description: Success
          schema:
            type: array
            items:
              $ref: "#/definitions/BaseTransactionCategory"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /admin/api/transaction/all:
    x-swagger-router-controller: transactions
    get:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Gets all the yodlee transactions
      operationId: list_transactions_admin
      parameters:
        - name: lastId
          in: query
          type: integer
        - name: userId
          in: query
          type: integer
        - name: isMagicRuleApplicable
          in: query
          type: integer
        - name: filterDate
          in: query
          type: string
          format: date
        - name: viewed
          in: query
          type: integer
      responses:
        "200":
          description: Success
          schema:
            type: array
            items:
              $ref: "#/definitions/Transaction"
        "403":
          description: Not authorized
        "404":
          description: Not found
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /admin/api/transaction/all/grouped:
    x-swagger-router-controller: transactions
    get:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Gets all the yodlee transactions
      operationId: list_grouped_by_day_transactions_admin
      parameters:
        - name: lastId
          in: query
          type: integer
        - name: userId
          in: query
          type: integer
        - name: isMagicRuleApplicable
          in: query
          type: integer
      responses:
        "200":
          description: Success
          schema:
            type: array
            items:
              $ref: "#/definitions/TransactionGroup"
        "403":
          description: Not authorized
        "404":
          description: Not found
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /admin/api/notifications/send:
    x-swagger-router-controller: push_notifications
    post:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Sends a push to a specific user
      operationId: send_push_to_user
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/PushToUserBody'
      responses:
        "200":
          description: Sucess
          schema:
            $ref: '#/definitions/PushResult'
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /admin/api/transaction/{id}:
    x-swagger-router-controller: transactions
    get:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Gets all the user transactions
      operationId: get_transaction_admin
      parameters:
        - name: id
          in: path
          type: integer
          required: true
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/Transaction"
        "403":
          description: Not authorized
        "404":
          description: Not found
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /admin/api/article:
    x-swagger-router-controller: news
    get:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Get news with offset and limit
      operationId: getArticle
      parameters:
        - name: id
          in: query
          type: number
          required: true
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/News"
        "403":
          description: Not authorized
        "404":
          description: Not found
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
    post:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Add or update an article
      operationId: postArticle
      parameters:
        - name: id
          in: query
          type: number
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/News"
        "403":
          description: Not authorized
        "404":
          description: Not found
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
    delete:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Delete an article
      operationId: deleteAticle
      parameters:
        - name: id
          in: query
          type: number
          required: true
      responses:
        "200":
          description: Success
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /admin/api/news/get:
    x-swagger-router-controller: news
    get:
      tags:
        - Adminpanel
      security:
        - adminKey: []
      description: Get news with offset and limit
      operationId: getNews
      parameters:
        - name: offset
          in: query
          type: number
          required: true
        - name: limit
          in: query
          type: number
          required: true
        - name: order
          in: query
          type: string
          enum: ['ASC', 'DESC']
          required: false
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/getNews"
        "403":
          description: Not authorized
        "404":
          description: Not found
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /api/news/get:
    x-swagger-router-controller: news
    get:
      tags:
        - Adminpanel
      security:
        - userKey: []
      description: Get news with offset and limit
      operationId: getNews
      parameters:
        - name: offset
          in: query
          type: number
          required: true
        - name: limit
          in: query
          type: number
          required: true
        - name: order
          in: query
          type: string
          enum: ['ASC', 'DESC']
          required: false
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/getNews"
        "403":
          description: Not authorized
        "404":
          description: Not found
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /api/getSuggestions/{type}:
    x-swagger-router-controller: suggestions
    get:
      tags:
        - Client
      security:
        - userKey: []
      description: Getting rules suggestions
      operationId: getUserRulesPrototypes
      parameters:
        - name: type
          in: path
          type: string
          required: true
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/ruleSuggestions"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /api/statistics/day:
    x-swagger-router-controller: statistics
    get:
      tags:
        - Client
      security:
        - userKey: []
      description: Get statistics on a day
      operationId: getDailyStatistics
      parameters:
        - name: date
          in: query
          type: string
          required: false
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/dailyStatistics"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /api/statistics/week:
    x-swagger-router-controller: statistics
    get:
      tags:
        - Client
      security:
        - userKey: []
      description: Get statistics on a week
      operationId: getWeeklyStatistics
      parameters:
        - name: date
          in: query
          type: string
          required: false
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/weeklyStatistics"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /api/statistics/chart:
    x-swagger-router-controller: statistics
    get:
      tags:
        - Client
      security:
        - userKey: []
      description: Get statistics on a week for chart
      operationId: getWeeklyChart
      parameters:
        - name: date
          in: query
          type: string
          required: false
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/weeklyChart"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /api/statistics/transactions:
    x-swagger-router-controller: statistics
    get:
      tags:
        - Client
      security:
        - userKey: []
      description: Get statistics of transactions for a month
      operationId: getAvgTransactions
      parameters:
        - name: date
          in: query
          type: string
          required: true
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/transactionsAvarage"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /api/statistics/rulesDynamics:
    x-swagger-router-controller: statistics
    get:
      tags:
        - Client
      security:
        - userKey: []
      description: Get Rules with statistics for current and last month
      operationId: rulesWithStats
      parameters:
        - name: date
          in: query
          type: string
          required: false
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/RuleStats"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /api/payments/balance:
    x-swagger-router-controller: payments
    get:
      tags:
        - Client
      security:
        - userKey: []
      description: Check user balance in Oval
      operationId: checkBalance
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/userBalance"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /api/payments/history:
    x-swagger-router-controller: payments
    get:
      tags:
        - Client
      security:
        - userKey: []
      description: Check user payments history in Oval
      operationId: getPaymentsHistory
      parameters:
        - name: limit
          in: query
          type: string
          required: false
        - name: offset
          in: query
          type: string
          required: false
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/history"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /queue/{uuid}:
    x-swagger-router-controller: queue
    get:
      tags:
        - uuid
      description: Refcounter
      operationId: redirect
      parameters:
        - name: uuid
          in: path
          type: string
          required: true
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/BadWolf"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /hooks/payin:
    x-swagger-router-controller: mangopay_hooks
    get:
      tags:
        - Client
        - Mangopay
        - Banking
      description: This is a hook that will provide PAYIN-related events (see https://docs.mangopay.com/api-references/notifications/). This method supports additional EventType of "CLIENT_REFRESH" to force the refreshment of the transaction.
      operationId: payin_hook
      parameters:
        - name: EventType
          in: query
          type: string
          required: true
          description: Can be one of described here https://docs.mangopay.com/api-references/notifications/ with additional "CLIENT_REFRESH" status - this is for the mobile client to use, it will update transaction info in the database
        - name: ResourceId
          in: query
          type: string
          required: true
          description: mangopayId of the transaction
        - name: Date
          in: query
          type: string
          required: false
          description: This parameter is never used
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/HookResponse"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /badwolf:
    x-swagger-router-controller: badwolf
    get:
      tags:
        - Bad Wolf
        - Client
      description: Bad wolf bad wolf bad wolf bad wolf bad wolf bad wolf bad wolf bad wolf bad wolf bad wolf bad wolf
      operationId: bad_wolf
      parameters:
        - name: badwolf
          in: query
          type: string
          description: bad wolf bad wolf bad wolf bad wolf bad wolf bad wolf bad wolf
      responses:
        "200":
          description: Bad Wolf
          schema:
            $ref: "#/definitions/BadWolf"
        default:
          description: Bad Wolf
          schema:
            $ref: "#/definitions/ErrorResponse"

  /hooks/payout:
    x-swagger-router-controller: mangopay_hooks
    get:
      tags:
        - Client
        - Mangopay
        - Banking
      description: This is a hook that will provide PAYOUT-related events (see https://docs.mangopay.com/api-references/notifications/). This method supports additional EventType of "CLIENT_REFRESH" to force the refreshment of the transaction.
      operationId: payout_hook
      parameters:
        - name: EventType
          in: query
          type: string
          required: true
          description: Can be one of described here https://docs.mangopay.com/api-references/notifications/ with additional "CLIENT_REFRESH" status - this is for the mobile client to use, it will update transaction info in the database
        - name: ResourceId
          in: query
          type: string
          required: true
          description: mangopayId of the transaction
        - name: Date
          in: query
          type: string
          required: false
          description: This parameter is never used
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/HookResponse"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /swagger:
    x-swagger-pipe: swagger_raw
# complex objects have schema definitions
definitions:
  ErrorResponse:
    required:
      - message
    properties:
      message:
        type: string
      messageCode:
        type: string

  YodleeAccountsResponse:
    required:
      - accounts
    properties:
      accounts:
        type: array
        items:
          $ref: "#/definitions/AccountInfo"

  TotalBalance:
    required:
      - amount
      - currencyCode
    properties:
      amount:
        type: number
        format: double
      currencyCode:
        type: string
        description: ISO Currency code

  ChangeItemAccountStateBody:
    required:
      - itemAccountId
      - activate
    properties:
      itemAccountId:
        type: string
      activate:
        type: boolean

  AccountInfo:
    required:
      - name
      - itemId
      - itemAccountId
      - favicon
      - maskedAccountNumber
      - type
      - balance
    properties:
      name:
        type: string
      itemId:
        type: string
      itemAccountId:
        type: string
      favicon:
        type: string
      maskedAccountNumber:
        type: string
      type:
        type: string
      balance:
        $ref: "#/definitions/TotalBalance"

  UrlResponse:
    required:
      - url
    properties:
      url:
        type: string
      body:
        type: string
        description: Will be present, if request must be made with POST

  FacebookLoginBody:
    type: object
    required:
      - access_token
    properties:
      access_token:
        type: string
        description: access_token provided by Facebook
      refresh_token:
        type: string
        description: access_token provided by Facebook

  PasswordResetBody:
    type: object
    required:
      - email
    properties:
      email:
        type: string
        description: email to login as

  PasswordResetDoBody:
    type: object
    required:
      - token
      - newPassword
    properties:
      token:
        type: string
      newPassword:
        type: string
        format: password

  AdminLoginBody:
    type: object
    required:
      - username
      - password
    properties:
      username:
        type: string
        description: username to login as
      password:
        type: string
        description: password to confirm login

  AdminRegisterBody:
    type: object
    required:
      - username
      - password
      - token
    properties:
      username:
        type: string
        description: username to login as
      password:
        type: string
        description: password to confirm login
      token:
        type: string
        description: The token we get as register code
  AdminLoginResponse:
    type: object
    required:
      - token
      - username
    properties:
      token:
        type: string
        description: JWT to use as x-auth-token
      username:
        type: string

  UserLoginResponse:
    type: object
    required:
      - token
      - id
    properties:
      token:
        type: string
        description: JWT to use as x-auth-token
      id:
        type: integer

  UserExistenceCheckResponse:
    type: object
    required:
      - userFound
    properties:
      userFound:
        type: boolean

  AdminCodeResponse:
    type: object
    required:
      - link
    properties:
      link:
        type: string
        description: Part of a link to use as login response
  EmailLoginBody:
    type: object
    required:
      - email
      - password
    properties:
      email:
        type: string
        description: email to login as
      password:
        type: string
        description: password to confirm login
        format: password

  UserAvatar:
    required:
      - profileImage
    properties:
      profileImage:
        type: string
        description: URL for the image

  UserProfileResponse:
    required:
      - id
      - createdAt
      - updatedAt
      - firstName
      - lastName
      - gender
      - email
      - birthday
      - countryCode2
      - citizenshipCode2
      - identityProofStatus
      - kycLevel
      - detectedCurrency
    properties:
      id:
        type: integer
      createdAt:
        type: string
        format: date-time
      updatedAt:
        type: string
        format: date-time
      firstName:
        type: string
      lastName:
        type: string
      profileImage:
        type: string
        description: URL for the image
      gender:
        type: string
      email:
        type: string
      birthday:
        type: string
        format: date
      countryCode2:
        type: string
      citizenshipCode2:
        type: string
      addressCountryCode2:
        type: string
      facebookId:
        type: string
      address:
        type: string
      zipCode:
        type: string
      region:
        type: string
      city:
        type: string
      occupation:
        type: string
      incomeRange:
        type: string
        description: Can be one of "1", "2", "3", "4", "5", "6". See description at https://docs.mangopay.com/api-references/users/natural-users/
      identityProofStatus:
        type: string
        description: Can be one of "NOT_UPLOADED", "CREATED", "VALIDATION_ASKED", "VALIDATED", "REFUSED", see reference here https://docs.mangopay.com/api-references/kyc/documents/
      kycLevel:
        type: string
        description: Can be one of "LIGHT", "REGULAR". See reference here https://docs.mangopay.com/api-references/users/natural-users/
      detectedCurrency:
        type: string
        description: Will be a ISO currency code that was detected during registration.
      position:
        type: integer
      uuid:
        type: string
  AdminProfileResponse:
    required:
      - id
      - createdAt
      - updatedAt
      - username
    properties:
      id:
        type: integer
      createdAt:
        type: string
        format: date-time
      updatedAt:
        type: string
        format: date-time
      username:
        type: string
  EmailRegistrationBody:
    required:
      - firstName
      - lastName
      - gender
      - email
      - birthday
      - countryCode2
      - citizenshipCode2
      - password
    properties:
      firstName:
        type: string
      lastName:
        type: string
      gender:
        type: string
      email:
        type: string
      birthday:
        type: string
        format: date
      countryCode2:
        type: string
      citizenshipCode2:
        type: string
      password:
        type: string
        format: password
        description: Password should be at least 8 characteds long, should contain 1 letter and 1 number
  FacebookRegistrationBody:
    required:
      - firstName
      - lastName
      - gender
      - email
      - birthday
      - countryCode2
      - citizenshipCode2
      - access_token
    properties:
      firstName:
        type: string
      lastName:
        type: string
      gender:
        type: string
      email:
        type: string
      birthday:
        type: string
        format: date
      countryCode2:
        type: string
      citizenshipCode2:
        type: string
      access_token:
        type: string
        description: access_token provided by Facebook
      refresh_token:
        type: string
        description: access_token provided by Facebook
  UserProfileChangeRequest:
    properties:
      firstName:
        type: string
      lastName:
        type: string
      gender:
        type: string
      email:
        type: string
      birthday:
        type: string
        format: date
      newPassword:
        type: string
        format: password
      oldPassword:
        type: string
        format: password
        description: This must be supplied only if the new password is entered
      countryCode2:
        type: string
      citizenshipCode2:
        type: string
      addressCountryCode2:
        type: string
      address:
        type: string
      zipCode:
        type: string
      region:
        type: string
      city:
        type: string
      occupation:
        type: string
      tokens:
        type: string
      incomeRange:
        type: string
        description: Can be one of "1", "2", "3", "4", "5", "6". See description at https://docs.mangopay.com/api-references/users/natural-users/

  UserProfileChangeRequestAdmin:
    required:
      - id
    properties:
      id:
        type: integer
      firstName:
        type: string
      lastName:
        type: string
      gender:
        type: string
      email:
        type: string
      birthday:
        type: string
        format: date
      newPassword:
        type: string
        format: password
      oldPassword:
        type: string
        format: password
        description: This must be supplied only if the new password is entered
      countryCode2:
        type: string
      citizenshipCode2:
        type: string
      addressCountryCode2:
        type: string
      address:
        type: string
      zipCode:
        type: string
      region:
        type: string
      city:
        type: string
      occupation:
        type: string
      incomeRange:
        type: string
        description: Can be one of "1", "2", "3", "4", "5", "6". See description at https://docs.mangopay.com/api-references/users/natural-users/

  AdminPasswordChangeRequest:
    required:
      - oldPassword
      - newPassword
    properties:
      newPassword:
        type: string
        format: password
      oldPassword:
        type: string
        format: password

  AdminPasswordResetRequest:
    required:
      - id
      - newPassword
    properties:
      id:
        type: integer
      newPassword:
        type: string
        format: password

  IDOnlyRequest:
    required:
      - id
    properties:
      id:
        type: integer

  VersionsResponse:
    required:
      - latest
      - allowed
    properties:
      latest:
        type: string
        description: Latest app version, follows semver
      allowed:
        type: string
        description: Minimum allowed app version, follows semver
  TimeResponse:
    required:
      - time
    properties:
      time:
        type: string
        format: date-time
        description: Current date-time
  CountryResponse:
    required:
      - name
      - code2
      - code3
      - nationality
      - currency
    properties:
      name:
        type: string
      code2:
        type: string
      code3:
        type: string
      nationality:
        type: string
      currency:
        type: string

  BoundaryResponse:
    required:
      - id
      - boundaryValue
    properties:
      id:
        type: integer
      boundaryValue:
        type: integer
        format: int64
      createdAt:
        type: string
        format: date-time
      updatedAt:
        type: string
        format: date-time

  MoneyOperationBody:
    required:
      - amount
    properties:
      amount:
        type: integer
        description: Amount in the currency of the account

  HookResponse:
    required:
      - status
    properties:
      status:
        type: string
        description: Will always be equal to "notification_received", this is a filler property to reply to mangopay
      transactionId:
        type: integer
        description: Will only be present if EventType is "CLIENT_REFRESH"

  TransactionInfo:
    required:
      - id
      - mangopayId
      - createdAt
      - updatedAt
      - userId
      - status
      - nature
      - type
      - creditedFundsOriginal
      - creditedFundsEuro
      - creditedFundsAccountCurrency
      - debitedFundsOriginal
      - debitedFundsEuro
      - debitedFundsAccountCurrency
    properties:
      id:
        type: number
        format: int64
      tag:
        type: string
        description: Represents whether transaction was "manual" or "automatic"
      createdAt:
        type: string
        format: date-time
      updatedAt:
        type: string
        format: date-time
      userId:
        type: number
        format: int64
      mangopayId:
        type: string
      type:
        type: string
        description: Will be "PAYIN" or "PAYOUT"
      isPayIn:
        type: boolean
      nature:
        type: string
      status:
        type: string
      creditedFundsOriginal:
        $ref: "#/definitions/TotalBalance"
      creditedFundsEuro:
        $ref: "#/definitions/TotalBalance"
      creditedFundsAccountCurrency:
        $ref: "#/definitions/TotalBalance"
      debitedFundsOriginal:
        $ref: "#/definitions/TotalBalance"
      debitedFundsEuro:
        $ref: "#/definitions/TotalBalance"
      debitedFundsAccountCurrency:
        $ref: "#/definitions/TotalBalance"

  CurrencyInfo:
    required:
      - code
      - rate
    properties:
      code:
        type: string
        description: ISO currency code
      rate:
        type: number
        format: double

  BaseTransactionCategory:
    required:
      - id
      - name
      - magicRules
    properties:
      id:
        type: integer
      name:
        type: string
      magicRules:
        type: boolean
        description: Indicates whether magic rules are applied to this category or not

  TransactionCategory:
    required:
      - id
      - name
      - yodleeId
      - baseCategoryId
    properties:
      id:
        type: integer
      name:
        type: string
      yodleeId:
        type: integer
      baseCategoryId:
        type: integer

  AttachMangopayAccountBody:
    required:
      - type
      - culture
      - name
      - address
      - countryCode2
      - city
    properties:
      type:
        type: string
        description: Account type (either GB or IBAN)
      culture:
        type: string
        description: Culture from Mandate. EN or FR for type = IBAN, or EN for type = GB
      name:
        type: string
        description: OwnerName from Mangopay API
      address:
        type: string
        description: AddressLine1 from Mangopay API
      countryCode2:
        type: string
        description: Country ISO Code
      city:
        type: string
        description: City from Mangopay API
      zipCode:
        type: string
        description: PostalCode from Mangopay API
      region:
        type: string
        description: Region from Mangopay API
      IBAN:
        type: string
        description: Required and available only for IBAN type
      BIC:
        type: string
        description: Available only for IBAN type, can be derived by Mangopay automatically
      accountNumber:
        type: string
        description: Required and available only for GB type. Should match regex /^\d+$/
      sortCode:
        type: string
        description: Required and available only for GB type. Should match regex /^\d{6}$/
  MangopayBankAccount:
    required:
      - type
      - name
      - address
      - countryCode2
      - city
      - status
    properties:
      type:
        type: string
        description: Account type (either GB or IBAN)
      name:
        type: string
        description: OwnerName from Mangopay API
      address:
        type: string
        description: AddressLine1 from Mangopay API
      countryCode2:
        type: string
        description: Country ISO Code
      city:
        type: string
        description: City from Mangopay API
      zipCode:
        type: string
        description: PostalCode from Mangopay API
      region:
        type: string
        description: Region from Mangopay API
      status:
        type: string
        description: Mandate status
      IBAN:
        type: string
        description: Required and available only for IBAN type
      BIC:
        type: string
        description: Available only for IBAN type, can be derived by Mangopay automatically
      accountNumber:
        type: string
        description: Required and available only for GB type. Should match regex /^\d+$/
      sortCode:
        type: string
        description: Required and available only for GB type. Should match regex /^\d{6}$/

  YodleeCallbackListenerResponse:
    required:
      - callbackCalled
    properties:
      callbackCalled:
        type: boolean
        description: If the callback was called this will be true


  TransactionsStats:
    required:
      - count
      - amountEuro
      - amountAccountCurrency
    properties:
      count:
        type: integer
      amountEuro:
        $ref: "#/definitions/TotalBalance"
      amountAccountCurrency:
        $ref: "#/definitions/TotalBalance"

  TransactionDescription:
    properties:
      description:
        type: string
      merchantName:
        type: string

  Transaction:
    required:
      - id
      - createdAt
      - updatedAt
      - yodleeId
      - description
      - transactionDate
      - transactionCategoryId
      - userId
      - amountOriginal
      - amountEuro
      - amountAccountCurrency
      - viewed
    properties:
      id:
        type: integer
      createdAt:
        type: string
        format: date-time
      updatedAt:
        type: string
        format: date-time
      transactionDate:
        type: string
        format: date-time
      userId:
        type: integer
      link:
        type: string
      description:
        $ref: "#/definitions/TransactionDescription"
      transactionCategoryId:
        type: integer
      yodleeId:
        type: integer
      amountOriginal:
        $ref: "#/definitions/TotalBalance"
      amountEuro:
        $ref: "#/definitions/TotalBalance"
      amountAccountCurrency:
        $ref: "#/definitions/TotalBalance"
      viewed:
        type: boolean
      preMangopayTransaction:
        $ref: '#/definitions/PreMangopayTransaction'

  TransactionGroup:
    required:
      - id
      - dayOfTransaction
      - amountEuro
    properties:
      id:
        type: integer
      dayOfTransaction:
        type: string
        format: date
      amountEuro:
        $ref: "#/definitions/TotalBalance"
      amountAccountCurrency:
        $ref: "#/definitions/TotalBalance"
  AddReport:
    required:
      - ruleId
    properties:
      ruleId:
        type: integer
      comment:
        type: string
  SetReportState:
    required:
      - id
      - isRead
    properties:
      id:
        type: integer
      isRead:
        type: integer
  Report:
    required:
      - id
      - createdAt
      - updatedAt
      - isRead
      - ruleId
      - userId
    properties:
      id:
        type: integer
      createdAt:
        type: string
        format: date-time
      updatedAt:
        type: string
        format: date-time
      isRead:
        type: boolean
      ruleId:
        type: integer
      userId:
        type: integer

  IdentityProofRequest:
    required:
      - idFront
      - idBack
    properties:
      idFront:
        type: string
        description: Base64-encoded file
      idBack:
        type: string
        description: Base64-encoded file
      force:
        type: string
        description: To force the reupload of the documents - pass "1" here.
  RuleEdit:
    required:
      - id
    properties:
      id:
        type: integer
      active:
        type: boolean
      name:
        type: string
        description: Rule name
      processingIdentifier:
        type: string
        description: Can be one of "bySum", "byTimePeriod", "byTimePeriodEvenly", "byCategory", or a combination (e.g."bySum+byCategory"). "byTimePeriodEvenly" works only with "byTarget", and conflicts with "byTimePeriod"
      savingIdentifier:
        type: string
        description: Can be one of "percentageAmount", "fixedAmount", "targetAmount"
      categoryId:
        type: integer
        description: Goes with "byCategory" processingIdentifier
      percentage:
        type: integer
        description: Goes with "percentageAmount" savingIdentifier
      frequency:
        type: string
        description: Possible values are "daily", "weekly", "monthly". Goes with "byTimePeriod" and "byTimePeriodEvenly" processingIdentifier
      fixedAmount:
        type: integer
        description: Goes with "fixedAmount" savingIdentifier
      targetSum:
        type: integer
        description: Goes with "targetAmount" savingIdentifier
      upperSum:
        type: integer
        description: Goes with "bySum" processingIdentifier
      lowerSum:
        type: integer
        description: Goes with "bySum" processingIdentifier

  RuleCreation:
    required:
      - processingIdentifier
      - savingIdentifier
      - name
    properties:
      name:
        type: string
        description: Rule name
      processingIdentifier:
        type: string
        description: Can be one of "bySum", "byTimePeriod", "byCategory", or a combination (e.g."bySum+byCategory")
      savingIdentifier:
        type: string
        description: Can be one of "percentageAmount", "fixedAmount", "targetAmount"
      categoryId:
        type: integer
        description: Goes with "byCategory" processingIdentifier
      percentage:
        type: integer
        description: Goes with "percentageAmount" savingIdentifier
      frequency:
        type: string
        description: Possible values are "daily", "weekly", "monthly". Goes with "byTimePeriod" processingIdentifier
      fixedAmount:
        type: integer
        description: Goes with "fixedAmount" savingIdentifier
      targetSum:
        type: integer
        description: Goes with "targetAmount" savingIdentifier
      upperSum:
        type: integer
        description: Goes with "bySum" processingIdentifier
      lowerSum:
        type: integer
        description: Goes with "bySum" processingIdentifier
      parentId:
        type: integer
        description: Will be present if the rule was created from a parent rule

  RuleCollection:
    required:
      - id
      - createdAt
      - updatedAt
      - name
    properties:
      id:
        type: integer
      createdAt:
        type: string
        format: date-time
      updatedAt:
        type: string
        format: date-time
      name:
        type: string
        description: Rule name
  Rule:
    required:
      - id
      - createdAt
      - updatedAt
      - active
      - processingIdentifier
      - savingIdentifier
    properties:
      id:
        type: integer
      createdAt:
        type: string
        format: date-time
      updatedAt:
        type: string
        format: date-time
      active:
        type: boolean
      name:
        type: string
        description: Rule name
      processingIdentifier:
        type: string
        description: Can be one of "bySum", "byTimePeriod", "byCategory", or a combination (e.g."bySum+byCategory")
      savingIdentifier:
        type: string
        description: Can be one of "percentageAmount", "fixedAmount", "targetAmount"
      userId:
        type: integer
      categoryId:
        type: integer
        description: Goes with "byCategory" processingIdentifier
      percentage:
        type: integer
        description: Goes with "percentageAmount" savingIdentifier
      frequency:
        type: string
        description: Possible values are "daily", "weekly", "monthly". Goes with "byTimePeriod" processingIdentifier
      fixedAmount:
        type: integer
        description: Goes with "fixedAmount" savingIdentifier
      targetSum:
        type: integer
        description: Goes with "targetAmount" savingIdentifier
      upperSum:
        type: integer
        description: Goes with "bySum" processingIdentifier
      lowerSum:
        type: integer
        description: Goes with "bySum" processingIdentifier
      parentId:
        type: integer
        description: Will be present if the rule was created from a parent rule
  BadWolf:
    required:
      - badWolf
    properties:
      badWolf:
        type: string
        description: Bad wolf bad wolf bad wolf bad wolf bad wolf bad wolf bad wolf
  CountResponse:
    required:
      - count
    properties:
      count:
        type: integer
  MarkAsViewed:
    required:
      - ids
      - markAs
    properties:
      ids:
        type: array
        items:
          type: integer
      markAs:
        type: boolean
  PreMangopayTransaction:
    required:
      - id
      - createdAt
      - updatedAt
      - paymentPassed
      - ruleId
      - userId
      - amountEuro
      - amountAccountCurrency
    properties:
      id:
        type: integer
      createdAt:
        type: string
        format: date-time
      updatedAt:
        type: string
        format: date-time
      paymentPassed:
        type: boolean
      ruleId:
        type: integer
      userId:
        type: integer
      transactionId:
        type: integer
      amountEuro:
        $ref: "#/definitions/TotalBalance"
      amountAccountCurrency:
        $ref: "#/definitions/TotalBalance"

  PushNotificationDevice:
    required:
      - id
      - createdAt
      - updatedAt
      - type
      - token
      - userId
    properties:
      id:
        type: integer
      createdAt:
        type: string
        format: date-time
      updatedAt:
        type: string
        format: date-time
      type:
        type: string
      token:
        type: string
      userId:
        type: integer
  RegisterPushNotificationDevice:
    required:
      - type
      - token
    properties:
      type:
        type: string
      token:
        type: string

  EditPushNotificationDevice:
    required:
      - token
    properties:
      token:
        type: string
  PushToUserBody:
    required:
      - userId
      - text
    properties:
      userId:
        type: integer
      text:
        type: string
  PushResult:
    required:
      - success
      - failed
    properties:
      success:
        type: integer
      failed:
        type: integer
  AddNewsItem:
    properties:
      title:
        type: string
      author:
        type: string
      shortDescription:
        type: string
      img:
        type: string
      linkToSource:
        type: string
      createdAt:
        type: string
        format: date-time

  getNews:
    properties:
      news:
        type: array
        items:
          $ref: "#/definitions/News"

  News:
    properties:
      title:
        type: string
      author:
        type: string
      shortDescription:
        type: string
      img:
        type: string
      linkToSource:
        type: string
      createdAt:
        type: string
        format: date-time
      updateAt:
        type: string
        format: date-time

  getCollections:
    properties:
      collections:
        type: array
        items:
          $ref: "#/definitions/Collection"

  Collection:
    properties:
      id:
        type: integer
      title:
        type: string
      subtitle:
        type: string
      description:
        type: string
      photo:
        type: string
      prototypes:
        type: string
      counter:
        type: integer
      prototypesObj:
        type: array
        items:
          $ref: "#/definitions/Prototype"
      createdAt:
        type: string
        format: date-time
      updateAt:
        type: string
        format: date-time

  getPrototypes:
    properties:
      prototypes:
        type: array
        items:
          $ref: "#/definitions/Prototype"

  Prototype:
    required:
      - name
    properties:
      name:
        type: string
      targetSum:
        type: number
      processingIdentifier:
        type: string

  ruleSuggestions:
    properties:
      suggestions:
        type: array
        items:
          $ref: "#/definitions/Suggestion"

  Suggestion:
    properties:
      name:
        type: string
      targetSum:
        type: number
      fixedAmount:
        type: number
      lowerSum:
        type: number
      upperSum:
        type: number
      frequency:
        type: string
      weight:
        type: number

  dailyStatistics:
    properties:
      rules:
        type: number
      transactions:
        type: number
      savings:
        type: number

  weeklyStatistics:
    properties:
      rules:
        type: number
      transactions:
        type: number
      savings:
        type: number

  weeklyChart:
    properties:
      days:
        type: array
        items:
          $ref: "#/definitions/chartDay"
      top:
        type: number
      globalAvg:
        type: number

  chartDay:
    properties:
      day:
        type: string
      value:
        type: number
      avg:
        type: number

  average:
    properties:
      day:
        type: number
      avg:
        type: number

  transactionsAvarage:
    properties:
      average:
        type: number
      category:
        type: string
      lastDate:
        type: string
        format: date-time

  userBalance:
    properties:
      balance:
        type: number

  history:
    properties:
      paymentStatus:
        type: string
      paymentId:
        type: number
      paymentDate:
        type: string
        format: date-time
      paymentDir:
        type: number
      sum:
        type: number
      error:
        type: string

  RulesStats:
    properties:
      rules:
        type: array
        items:
          $ref: "#/definitions/RuleStats"

  RuleStats:
    required:
      - id
      - createdAt
      - updatedAt
      - active
      - processingIdentifier
      - savingIdentifier
      - curMonth
      - lastMonth
    properties:
      id:
        type: integer
      createdAt:
        type: string
        format: date-time
      updatedAt:
        type: string
        format: date-time
      active:
        type: boolean
      name:
        type: string
      processingIdentifier:
        type: string
      savingIdentifier:
        type: string
      userId:
        type: integer
      categoryId:
        type: integer
      percentage:
        type: integer
      frequency:
        type: string
      fixedAmount:
        type: integer
      targetSum:
        type: integer
      upperSum:
        type: integer
      lowerSum:
        type: integer
      parentId:
        type: integer
      curMonth:
        type: integer
      lastMonth:
        type: integer