action velopayments_list_users {
  label: "List Users"
  description: "Get a paginated response listing the Users"
  provider: velopayments
  method: GET
  path: "/v2/users"
  encoding: json
  input: {
    type: "object"
    properties: {
      entityId: {
        type: "string"
        format: "uuid"
      }
      page: {
        type: "integer"
        format: "int32"
      }
      pageSize: {
        type: "integer"
        format: "int32"
      }
      payeeType: {
        type: "string"
        enum: ["COMPANY", "INDIVIDUAL"]
      }
      sort: {
        type: "string"
      }
      status: {
        type: "string"
        description: "The status of the user\nwhen the user has been invited but not yet enrolled they will have a PENDING status\n"
        enum: ["ENABLED", "DISABLED", "PENDING"]
      }
      type: {
        type: "string"
        enum: ["BACKOFFICE", "PAYOR", "PAYEE"]
      }
    }
    additionalProperties: false
  }
  output: {
    type: "object"
    description: "List Users Response Object"
    properties: {
      content: {
        type: "array"
        items: {
          type: "object"
          properties: {
            companyName: {
              type: "string"
              description: "The payor or payee company name or null if the user is not a payor or payee user\n"
            }
            email: {
              type: "string"
              format: "email"
              description: "the email address of the user"
            }
            entityId: {
              type: "string"
              format: "uuid"
              description: "The payorId or payeeId or null if the user is not a payor or payee user\n"
            }
            firstName: {
              type: "string"
            }
            id: {
              type: "string"
              format: "uuid"
              description: "The id of the user"
            }
            lastName: {
              type: "string"
            }
            lockedOut: {
              type: "boolean"
              description: "If true the user is currently locked out and unable to log in"
            }
            lockedOutTimestamp: {
              type: "string"
              format: "date-time"
              description: "A timestamp showing when the user was locked out\nIf null then the user is not currently locked out\n"
            }
            mfaStatus: {
              type: "string"
              description: "The status of the MFA device"
              enum: ["REGISTERED", "UNREGISTERED"]
            }
            mfaType: {
              type: "string"
              description: "The type of the MFA device"
              enum: ["SMS", "YUBIKEY", "TOTP"]
            }
            primaryContactNumber: {
              type: "string"
              description: "The main contact number for the user\n"
            }
            roles: {
              type: "array"
              description: "The role(s) for the user\n"
              items: {
                type: "object"
                required: ["name"]
                properties: {
                  name: {
                    type: "string"
                    description: "the name of the role"
                  }
                }
              }
            }
            secondaryContactNumber: {
              type: "string"
              description: "The secondary contact number for the user\n"
            }
            smsNumber: {
              type: "string"
              description: "The phone number of a device that the user can receive sms messages on\n"
            }
            status: {
              type: "string"
              description: "The status of the user\nwhen the user has been invited but not yet enrolled they will have a PENDING status\n"
              enum: ["ENABLED", "DISABLED", "PENDING"]
            }
            userType: {
              type: "string"
              description: "Indicates the type of user. Could be BACKOFFICE, PAYOR or PAYEE."
              enum: ["BACKOFFICE", "PAYOR", "PAYEE"]
            }
          }
        }
      }
      links: {
        type: "array"
        items: {
          properties: {
            href: {
              type: "string"
            }
            rel: {
              type: "string"
            }
          }
        }
      }
      page: {
        properties: {
          numberOfElements: {
            type: "integer"
          }
          page: {
            type: "integer"
          }
          pageSize: {
            type: "integer"
          }
          totalElements: {
            type: "integer"
          }
          totalPages: {
            type: "integer"
          }
        }
      }
    }
  }
}