QR-Platform API Schemas

{
  // Indicates if passwordless registration was used
  passwordless?: boolean
  // Indicates if a verification email was sent
  emailSent?: boolean
  // Informational message
  message?: string
  // ID of the created organization
  orgId?: string
  // Name of the organization
  organizationName?: string
  // Redirect URL of the organization
  organizationRedirectUrl?: string
  // Description of the organization
  organizationDescription?: string
}

// Error response for validation failures
{
  message: string
  errors?: []
}

// Details of a specific error issue
{
  path?:   anyOf: [
    {"type":"string"},
    {"type":"number"}
  ][]
  // Specific message for this issue
  message: string
  // Optional specific code for this issue (e.g., Zod issue code)
  code?: string
}

// Error response when an email address is already registered
{
  message: string
}

// Error response when an email fails to send
{
  message: string
}

// Error response when organization creation fails during registration
{
  message: string
}

{
  // User email address
  email: string
  // User password (optional for passwordless)
  password?: string
  // Name of the initial organization
  organizationName?: string
  // Description of the organization
  organizationDescription?: string
  // Redirect URL of the organization
  organizationRedirectUrl?: string
}

{
  // JWT access token upon successful registration verification
  access_token?: string
}

// Error response when an email has already been verified
{
  message: string
}

// Unauthorized response message
{
  message: string
}

// Indicates that the specified user was not found
{
  // The specified user could not be found
  message: string
}

// Indicates that the organization context was not found or is invalid
{
  // The specified organization could not be found or is not accessible
  message: string
}

{
  // User email address (optional)
  email?: string
  // 6-digit verification code (for email/MFA)
  code?: string
  // Verification token (for email links)
  token?: string
  // User password (if setting during verification)
  password?: string
}

{
  // Indicates if the verification email was resent
  emailSent?: boolean
}

// Error response for invalid credentials for an operation (not login)
{
  message: string
}

{
  // JWT access token (if password provided)
  access_token?: string
  // Indicates if passwordless sign-in is required
  passwordless?: boolean
  // Indicates if a sign-in verification email was sent
  emailSent?: boolean
  // Details of the organization the user signed into
  organization?: {
    // Unique identifier for the organization
    id: string
    // Name of the organization
    name?: string
  }
}

{
  // User email address
  email: string
  // User password (optional for passwordless)
  password?: string
}

{
  // JWT access token upon successful sign-in verification
  access_token?: string
}

{
  // User email address (optional)
  email?: string
  // 6-digit verification code (for email/MFA)
  code?: string
  // Verification token (for email links)
  token?: string
  // User password (if setting during verification)
  password?: string
}

{
  // Indicates if the verification email was sent
  emailSent?: boolean
}

{
  // Indicates if the email was successfully verified
  verified?: boolean
  // JWT access token upon successful verification
  access_token?: string
}

{
  // User email address (optional)
  email?: string
  // 6-digit verification code (for email/MFA)
  code?: string
  // Verification token (for email links)
  token?: string
  // User password (if setting during verification)
  password?: string
}

// Basic user response information
{
  // Unique identifier for the user
  id: string
  // User's full name
  name: string
  // User's email address
  email: string
  // Whether the user's email address has been verified
  isEmailVerified: boolean
  // Whether the user account is disabled
  isDisabled: boolean
}

// User information with audit details
allOf: [
  {"$ref":"BaseUserResponse"}
]

// User information in audit trail
{
  // Unique identifier of the user
  id: string
  // Name of the user
  name: string
  // Email address of the user
  email: string
}

// API key information in audit trail
{
  // Unique identifier of the API key
  id: string
  // Name of the API key
  name: string
  // Role associated with the API key
  roleName: string
}

allOf: [
  {"$ref":"UserResponseWithAudit"}
]

// Organization information with related details
{
  // Unique identifier for the organization
  id: string
  // Name of the organization
  name: string
  // Current plan of the organization
  planName?: string | null
  // Description of the organization
  description?: string | null
  // Redirect URL of the organization
  redirectUrl?: string | null
  // Whether the organization is disabled
  isDisabled?: boolean
  // ID of the user or API key that disabled the organization
  disabledBy?: string | null
  // Timestamp when the organization was disabled
  disabledAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
  // Whether the organization is deleted
  isDeleted?: boolean
  // ID of the user or API key that deleted the organization
  deletedBy?: string | null
  // Timestamp when the organization was deleted
  deletedAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
  // Whether this is the current active organization for the user
  isCurrent?: boolean
  roles?:   {
    // Name of the role
    name: string
    scopes?:     // Scope associated with the role
    string[]
  }[]
  workspaces?:   {
    // Unique identifier for the workspace
    id: string
    // Name of the workspace
    name: string
    // Whether access to this workspace is isRestricted
    isRestricted: boolean
    roles?:     {
      // Name of the role
      name: string
      scopes?:       // Scope associated with the role
      string[]
    }[]
  }[]
  // User who created the resource
  createdByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // User who last updated the resource
  updatedByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // API key used to create the resource
  createdByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // API key used to last update the resource
  updatedByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // When the resource was created
  createdAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
  // When the resource was last updated
  updatedAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
}

{
  // Confirmation message
  message: string
}

// Error response when the user is not signed in or session has expired
{
  message: string
}

{
  // Success message
  message?: string
}

{
  // User email address
  email: string
  // User password (required for authentication)
  password?: string
}

{
  // Success message
  message?: string
}

// Error response when changing the password fails for an unspecified reason
{
  message: string
}

{
  // User email address
  email: string
  // Password reset token received via email
  token: string
  // New password to set
  newPassword: string
}

{
  // Success message
  message?: string
}

{
  // Current user password
  currentPassword: string
  // New password to set
  newPassword: string
}

// API key information with organization details
{
  // Unique identifier for the API key
  id: string
  // ID of the organization this API key belongs to
  orgId: string
  // Name of the role assigned to this API key
  roleName: string
  // Descriptive name for the API key
  name: string
  // Current status of the API key
  status: enum[active, deleted, disabled] //default: active
  // Timestamp when the API key expires
  expiresAt?: string | null
  // Organization information
  organization: {
    // Name of the organization this API key belongs to
    name?: string
  }
  // User who created the resource
  createdByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // User who last updated the resource
  updatedByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // API key used to create the resource
  createdByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // API key used to last update the resource
  updatedByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // When the resource was created
  createdAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
  // When the resource was last updated
  updatedAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
}

// Response after creating an API key, including the key value
allOf: [
  {"$ref":"ApiKeyResponse"}
]

// Error response when an API key name is already taken within the organization
{
  message: string
}

// Error response when the role specified for an API key is invalid or not permitted
{
  message: string
}

// Error response when the API key lifetime format is invalid (e.g., use "30d", "1y")
{
  message: string
}

// Error response when an operation cannot be completed due to a usage limit
{
  message: string
}

// Forbidden response message
{
  message: string
}

// Data required to create a new API key
{
  // Name of the role assigned to this API key
  roleName: string
  // Duration for which the key is valid (e.g., "30d", "1y")
  lifetime?: string
  // Descriptive name for the API key
  name: string
}

[]

{
  "type": "null",
  "example": [],
  "description": "Empty array response"
}

// Indicates that the specified API Key was not found
{
  // The specified API Key could not be found
  message: string
}

// Data for updating an API key
{
  // New name for the API key
  name: string
  // New expiration date for the API key
  expiresAt?: string | null
}

// Data for changing the status of an API key
{
  // New status for the API key
  status: enum[active, disabled]
}

// Generic success response
{
  // Success message
  message: string
}

// Error response when at least one field is required for an update operation
{
  message: string
}

// Data for updating an organization
{
  // Name of the organization
  name?: string
  // Description of the organization
  description?: string | null
  // Redirect URL of the organization
  redirectUrl?: string | null
}

// Response after creating an organization
{
  // Unique identifier for the organization
  id: string
  // Name of the organization
  name: string
  // Description of the organization
  description?: string | null
  // Redirect URL of the organization
  redirectUrl?: string | null
}

// Data required to create a new organization
{
  // Name of the organization
  name: string
  // Description of the organization
  description?: string
  // Redirect URL of the organization
  redirectUrl?: string | null
}

// Indicates that the organization was not found or is disabled
{
  // The specified organization could not be found, or it is currently disabled
  message: string
}

// Invitation details with audit information
{
  // Unique identifier for the invitation
  id: string
  // Email address of the invited user
  email: string
  // ID of the organization sending the invitation
  orgId: string
  // ID of the specific workspace (if applicable)
  workspaceId?: string | null
  // Role to be assigned upon acceptance
  roleName: string
  // Current status of the invitation
  status: enum[pending, accepted, expired, declined]
  // Personalized message included in the invitation
  message?: string | null
  // When the invitation expires
  expiresAt: anyOf: [
    {"type":"string"},
    {"type":"string"}
  ]
  // Organization information
  organization: {
    // Name of the organization sending the invitation
    name: string
  }
  // Workspace information (if invitation is for a specific workspace)
  workspace?: object | null
  // User who created the resource
  createdByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // User who last updated the resource
  updatedByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // API key used to create the resource
  createdByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // API key used to last update the resource
  updatedByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // When the resource was created
  createdAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
  // When the resource was last updated
  updatedAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
}

// Invitation details with audit information
{
  // Unique identifier for the invitation
  id: string
  // Email address of the invited user
  email: string
  // ID of the organization sending the invitation
  orgId: string
  // ID of the specific workspace (if applicable)
  workspaceId?: string | null
  // Role to be assigned upon acceptance
  roleName: string
  // Current status of the invitation
  status: enum[pending, accepted, expired, declined]
  // Personalized message included in the invitation
  message?: string | null
  // When the invitation expires
  expiresAt: anyOf: [
    {"type":"string"},
    {"type":"string"}
  ]
  // Organization information
  organization: {
    // Name of the organization sending the invitation
    name: string
  }
  // Workspace information (if invitation is for a specific workspace)
  workspace?: object | null
  // User who created the resource
  createdByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // User who last updated the resource
  updatedByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // API key used to create the resource
  createdByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // API key used to last update the resource
  updatedByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // When the resource was created
  createdAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
  // When the resource was last updated
  updatedAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
}

// Error response when a user already has the specified role in the organization
{
  message: string
}

// Data required to create a new invitation
{
  // Email address of the person to invite
  email: string
  // Role to assign to the invited user
  roleName: string
  // Optional workspace ID to invite user to a specific workspace
  workspaceId?: string
  // Optional personalized message to include in the invitation
  message?: string | null
}

[]

// Invitation details with audit information
{
  // Unique identifier for the invitation
  id: string
  // ID of the organization sending the invitation
  orgId: string
  // ID of the specific workspace (if applicable)
  workspaceId?: string | null
  // Role to be assigned upon acceptance
  roleName: string
  // Current status of the invitation
  status: enum[pending, accepted, expired, declined]
  // Personalized message included in the invitation
  message?: string | null
  // When the invitation expires
  expiresAt: anyOf: [
    {"type":"string"},
    {"type":"string"}
  ]
  // Organization information
  organization: {
    // Name of the organization sending the invitation
    name: string
  }
  // Workspace information (if invitation is for a specific workspace)
  workspace?: object | null
  // User who created the resource
  createdByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // User who last updated the resource
  updatedByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // API key used to create the resource
  createdByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // API key used to last update the resource
  updatedByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // When the resource was created
  createdAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
  // When the resource was last updated
  updatedAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
}[]

// Error response when attempting to delete an accepted invitation
{
  message: string
}

// Indicates that the invitation was not found or is invalid
{
  // The specified invitation could not be found or is invalid or the organization is disabled or deleted
  message: string
}

// Response after accepting an invitation
{
  // User ID of the newly registered or existing user
  id: string
  // Email address of the user
  email: string
  // Whether the email has been verified
  isEmailVerified: boolean
  // JWT access token for authentication
  access_token: string
}

// Error response when an invitation has expired
{
  message: string
}

// Error response when an invitation has already been accepted
{
  message: string
}

// Error response when an invitation has already been declined
{
  message: string
}

// Role information with organization details
{
  // Name of the role
  name: string
  scopes?:   string[]
  // Organization the role is associated with
  organization: {
    // Unique identifier for the organization
    id: string
    // Name of the organization
    name?: string
    // Description of the organization
    description?: string | null
  }
}

// Indicates that the specified member was not found
{
  // The specified member could not be found
  message: string
}

// Indicates that the member or role was not found
{
  // The specified member (user) or role could not be found
  message: string
}

// Data required to add a member to an organization
{
  // Email address of the user to add
  email: string
  // Name of the role to assign to the member
  roleName: string
  // Whether to send an invitation email
  sendInvitation?: boolean
}

[]

// Member information with roles
allOf: [
  {"$ref":"UserResponseWithAudit"}
]

// Role information
{
  // Name of the role
  name: string
  scopes?:   string[]
}

// Grouped roles for a member
{
  organizationRoles:   // Role in the organization
  {
    // Name of the role
    name: string
    scopes?:     string[]
    // ID of the organization this role is associated with
    orgId: string
  }[]
  workspaceRoles:   // Role in a workspace
  {
    // Name of the role
    name: string
    scopes?:     string[]
    // ID of the workspace this role is associated with
    workspaceId: string
  }[]
}

// Response body when a member is found but has no roles in the given context, resulting in a 404 for the roles list
{
  organizationRoles?: []
  workspaceRoles?: []
}

// Data required to add a role to a member
{
  // Name of the role to assign
  roleName: string
}

// Error response when a user attempts to remove their own owner role
{
  message: string
}

// Workspace information with audit details
{
  // Unique identifier for the workspace
  id: string
  // Name of the workspace
  name: string
  // Description of the workspace
  description?: string | null
  // Whether access to this workspace is isRestricted
  isRestricted: boolean
  // ID of the organization this workspace belongs to
  orgId: string
  // User who created the resource
  createdByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // User who last updated the resource
  updatedByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // API key used to create the resource
  createdByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // API key used to last update the resource
  updatedByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // When the resource was created
  createdAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
  // When the resource was last updated
  updatedAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
}

// Error response when a workspace name is already taken within the organization
{
  message: string
}

// Data required to create a new workspace
{
  // Name of the workspace
  name: string
  // Description of the workspace
  description?: string
  // Whether access to this workspace is isRestricted
  isRestricted?: boolean //default: true
}

// Indicates that the specified workspace was not found
{
  // The specified workspace could not be found
  message: string
}

// Data for updating a workspace
{
  // New name for the workspace
  name?: string
  // New description for the workspace
  description?: string
  // Whether access to this workspace is isRestricted
  isRestricted?: boolean
}

// Response after deleting a workspace
{
  // Success message
  message: string
}

// Error response when a workspace is not empty
{
  message: string
}

// Role assigned to a workspace member
{
  // Name of the role
  name: string
}[]

// Result of assigning a role to a workspace member
{
  // Name of the assigned role
  name: string
}

// Error response when a user already has the specified role in the workspace
{
  message: string
}

// Indicates that the specified role was not found
{
  // The specified role could not be found
  message: string
}

// Role to assign to a workspace member
{
  // Name of the role to assign
  roleName: string
}

[]

// Workspace member information
{
  // Unique identifier of the member
  id: string
  // Name of the member
  name: string
  // Email address of the member
  email: string
  roles:   {
    // Name of the role
    name: string
    // Whether the role is inherited from organization level
    isInherited: boolean
  }[]
  // User who created the resource
  createdByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // User who last updated the resource
  updatedByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // API key used to create the resource
  createdByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // API key used to last update the resource
  updatedByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // When the resource was created
  createdAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
  // When the resource was last updated
  updatedAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
}

[]

// Role with detailed scope information
{
  // Name of the role
  name: string
  scopes:   // Permission scope
  string[]
}

[]

// Plan information
{
  // Unique identifier of the plan
  name: enum[plan-free, plan-startup, plan-business, plan-enterprise]
  // Human-readable name of the plan
  displayName: string
  // Brief description of the plan
  description: string
  // Plan limits by limit type
  limits: {
  }
  // Whether this is the current plan for the authenticated organization
  isCurrent?: boolean
  // When the next limit reset will occur for this plan
  nextResetAt?: anyOf: [
    {"type":"string"},
    {"type":"string"}
  ]
}

// Plan with detailed usage information
{
  // Unique identifier of the plan
  name: enum[plan-free, plan-startup, plan-business, plan-enterprise]
  // Detailed limits with current usage
  limits: {
  }
  // Whether this is the current plan
  isCurrent?: boolean
  // When the next limit reset will occur
  nextResetAt?: anyOf: [
    {"type":"string"},
    {"type":"string"}
  ]
}

// Limit details with current usage
{
  // Maximum allowed value for this limit
  limit: number
  // Current usage count against this limit
  usage: number
}

// Plan with detailed usage information
{
  // Unique identifier of the plan
  name: enum[plan-free, plan-startup, plan-business, plan-enterprise]
  // Detailed limits with current usage
  limits: {
  }
  // Whether this is the current plan
  isCurrent?: boolean
  // When the next limit reset will occur
  nextResetAt?: anyOf: [
    {"type":"string"},
    {"type":"string"}
  ]
}

// Indicates that the plan was not found
{
  // The specified plan or the plan for the organization could not be found
  message: string
}

[]

// Setting response data
{
  // Name of the setting
  name: string
  // URL-friendly identifier for the setting
  slug: string
  // Description of what the setting does
  description?: string | null
}

// Setting with group information
allOf: [
  {"$ref":"SettingResponse"}
]

[]

// Indicates that the specified setting was not found
{
  // The specified setting could not be found
  message: string
}

// Error response when a setting value is required but not provided
{
  message: string
}

// Error response when attempting to create a setting with a reserved name
{
  message: string
}

// Error response when attempting to operate on a service setting as if it were workspace-overridable, but it is not
{
  message: string
}

// Data required to create a new setting
{
  // Name of the setting
  name: string
  // Description of what the setting does
  description?: string | null
}

// Data required to update an existing setting
{
  // Description of what the setting does
  description?: string | null
}

// Generic success response
{
  // Success message
  message: string
}

// Error response when attempting to delete a non-deletable service setting
{
  message: string
}

// Error response when an invalid service setting slug is provided
{
  message: string
}

// Error response when a service setting value has an incorrect data type
{
  message: string
}

// Error response when a service setting value is invalid (e.g., not in allowed list)
{
  message: string
}

// Error response when attempting to override a non-overridable setting at the workspace level
{
  message: string
}

// Error response when a workspace ID is required for an operation but not provided
{
  message: string
}

{
  data?: []
  // Pagination metadata
  pagination: {
    // Total number of items matching the filter criteria
    total: number
    // Current page number
    page: number
    // Number of items per page
    limit: number
    // Total number of pages
    totalPages: number
  }
}

// Indicates that the specified QR code was not found
{
  // The specified QR code could not be found
  message: string
}

// Code router rule assignment response object
{
  // Unique rule assignment identifier
  id: string
  // Parent QR code ID
  codeId: string
  // Template ID or null for inline
  templateId: string | null
  // Denormalized rule type for filtering
  ruleType: string
  // Resolved rule object
  rule: {
    // Template ID (only for template rules)
    id?: string
    // Rule name
    name: string | null
    // Rule description
    description: string | null
    // Rule type
    type: string
    // Rule conditions (null for scanLimit)
    conditions: object | null
    // Is global template
    isGlobal?: boolean
    // Organization ID
    orgId?: string | null
    // Workspace ID
    workspaceId?: string | null
    // Total template scans
    totalScans?: integer
    // Template creation date
    createdAt?: string
    // Template update date
    updatedAt?: string
  }
  priority: integer
  // The type of data the QR code contains. Only applies to dynamic codes. Determines how the QR code data is processed and what content type is returned when scanned. Available options: url (default, standard web redirect), wifi (WiFi configuration), vcard (contact card), text (plain text), email (mailto format), event (calendar event), json (custom JSON), file (file download).
  dataType: enum[url, wifi, vcard, text, email, event, json, file]
  dynamicData: {
  }
  maxScans: integer | null
  loop: boolean
  expiresAt: string | null
  disabled: boolean
  currentScans: integer
  totalScans: integer
  // User who created the resource
  createdByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // User who last updated the resource
  updatedByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // API key used to create the resource
  createdByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // API key used to last update the resource
  updatedByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // When the resource was created
  createdAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
  // When the resource was last updated
  updatedAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
}

// Error response when a router rule with the specified priority already exists
{
  message: string
}

// Error response when router rule conditions are invalid for the specified rule type
{
  message: string
}

// Error response when scanLimit rule is missing required maxScans field
{
  message: string
}

// Error response when an invalid country code is provided for router rule
{
  message: string
}

// Indicates that the specified router rule assignment was not found
{
  // The specified router rule assignment could not be found
  message: string
}

// Base QR code response schema
{
  // Unique identifier for the QR code
  id: string
  // Name of the QR code
  name: string
  // Type of the QR code
  type?: enum[static, dynamic]
  // The type of data the QR code contains. Only applies to dynamic codes.
  dataType?: enum[url, wifi, vcard, text, email, event, json, file, ]
  // Short alias for the QR code
  shortAlias?: string | null
  // Functional content for dynamic QR codes. Structure depends on dataType.
  dynamicData?: object | null
  // Data encoded in the QR code
  data: string
  // Description of the QR code
  description: string | null
  // Number of times the QR code has been scanned
  totalScans: number | null
  // Custom user metadata for the QR code as JSON object. This is separate from the dynamicData field and stores additional information that is not part of the functional content.
  metadata: object | null
  // ID of the style applied to the QR code
  styleId: string | null
  // ID of the template applied to the QR code
  templateId: string | null
  // ID of the border applied to the QR code
  borderId: string | null
  // ID of the text applied to the QR code
  textId: string | null
  // Style object with its configuration
  style?: {
    id?: string | null
    name?: string | null
  }
  // Template object with its configuration
  template?: {
    id?: string | null
    name?: string | null
  }
  // Border object with its configuration
  border?: {
    id?: string | null
    name?: string | null
  }
  // Text object with its configuration
  text?: {
    id?: string | null
    name?: string | null
  }
  // ID of the workspace the QR code belongs to
  workspaceId: string | null
  // Whether the QR code is valid
  isValid: boolean | null
  // When the QR code was last validated
  validatedAt: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
  // Version number of the QR code
  version: number
  // Whether the QR code is deleted
  isDeleted?: boolean
}

// Complete configuration for QR code generation
{
  // Data to encode in the QR code (required)
  data: string
  // Overall shape of the QR code
  shape?: enum[square, circle, ]
  // Margin around the QR code in pixels
  margin?: number | null
  // Whether QR code is responsive
  isResponsive?: boolean | null
  // Scale factor for QR code (0-1.5)
  scale?: number | null
  // General offset in pixels
  offset?: number | null
  // Vertical offset in pixels
  verticalOffset?: number | null
  // Horizontal offset in pixels
  horizontalOffset?: number | null
  // QR code specific options
  qrOptions?: object | null
  // Options for QR code dots
  dotsOptions?: object | null
  // Options for QR code corner squares
  cornersSquareOptions?: object | null
  // Options for QR code corner dots
  cornersDotOptions?: object | null
  // Options for QR code background or false to disable
  backgroundOptions?: anyOf: [
    {"type":"object","properties":{"color":{"type":["string","null"],"description":"Background color in CSS format","example":"#ffffff"},"round":{"anyOf":[{"type":"number","minimum":0,"maximum":1},{"type":"string"},{"type":"null"}],"description":"Background corner rounding (0-1 or CSS value)","example":0.1},"gradient":{"oneOf":[{"$ref":"Gradient"},{"type":"null"}],"description":"Gradient for background"}},"required":["color"]},
    {"type":"boolean","const":false}
  ]
  // Image to embed in the QR code (URL, Buffer, or Blob)
  image?: anyOf: [
    {"type":"string"},
    {},
    {},
    {"type":"null"}
  ]
  // Options for embedded image
  imageOptions?: object | null
  // Border configuration options
  borderOptions?: object | null
}

// Gradient definition
{
  // Type of gradient
  type?: enum[linear, radial]
  // Rotation angle of gradient in degrees
  rotation?: number
  colorStops?:   // Color stop in a gradient
  {
    // Position of the color stop (0-1)
    offset?: number
    // Color in CSS format
    color?: string
  }[]
}

// Inner or outer border configuration
{
  // Border color in CSS format
  color?: string
  // Border thickness in pixels
  thickness?: number
}

// Options for QR code decoration
{
  // Whether decoration is disabled
  disabled?: boolean
  // Whether text is enabled
  enableText?: boolean
  // Offset position in pixels
  offset?: number
  // Curve adjustment value
  curveAdjustment?: number
  // Whether curve is disabled
  curveDisabled?: boolean
  // Curve radius value (CSS format)
  curveRadius?: string
  // Type of decoration
  type?: enum[text, image]
  // Content value for decoration
  value?: string
}

// Text decoration style
{
  // Font face for the text
  fontFace?: string
  // Font size in pixels
  fontSize?: number
  // Font color in CSS format
  fontColor?: string
  // Letter spacing in pixels
  letterSpacing?: number
  // Font weight
  fontWeight?: enum[normal, bold]
}

// Configuration options for QR code styling
{
  // Primary color for QR code elements in CSS format
  primaryColor?: string | null
  // Secondary color for QR code elements in CSS format
  secondaryColor?: string | null
  // Tertiary color for QR code elements in CSS format
  thirdColor?: string | null
  // Background color of the QR code in CSS format
  backgroundColor?: string | null
  // Gradient configuration for QR code dots
  dotsGradient?: oneOf: [
    {"$ref":"Gradient"},
    {"type":"null"}
  ]
  // Gradient configuration for corner dots
  cornersDotGradient?: oneOf: [
    {"$ref":"Gradient"},
    {"type":"null"}
  ]
  // Gradient configuration for corners
  cornersGradient?: oneOf: [
    {"$ref":"Gradient"},
    {"type":"null"}
  ]
  // Gradient configuration for QR code background
  backgroundGradient?: oneOf: [
    {"$ref":"Gradient"},
    {"type":"null"}
  ]
  // Shape style for the QR code dots
  dotShape?: enum[dot, square, rounded, extra-rounded, classy, classy-rounded, vertical-line, horizontal-line, random-dot, small-square, tiny-square, star, plus, diamond, ]
  // Shape style for the QR code corner squares
  cornerSquareShape?: enum[dot, square, rounded, classy, outpoint, inpoint, ]
  // Shape style for the QR code corner dots
  cornerDotShape?: enum[dot, square, heart, rounded, classy, outpoint, inpoint, ]
  // Logo to be placed on the QR code (URL, Base64, Buffer, or Blob)
  logo?: anyOf: [
    {"type":"string"},
    {},
    {},
    {"type":"null"}
  ]
  // Size of the logo relative to QR code (0-1)
  logoSize?: number | null
  // Placement mode for the logo
  logoMode?: enum[center, overlay, background, ]
  // Margin around the logo in pixels
  logoMargin?: number | null
  // Background color for logo in CSS format
  logoBackgroundColor?: string | null
  // Padding around the logo in pixels
  logoPadding?: number | null
  // Border radius for logo in pixels or CSS format
  logoRadius?: anyOf: [
    {"type":"string"},
    {"type":"number"},
    {"type":"null"}
  ]
  // Color of the QR code border in CSS format
  borderColor?: string | null
  // Thickness of the border in pixels
  borderThickness?: number | null
  // Border radius in pixels or CSS format
  borderRadius?: anyOf: [
    {"type":"string"},
    {"type":"number"},
    {"type":"null"}
  ]
  // Color of the inner border in CSS format
  borderInnerColor?: string | null
  // Thickness of the inner border in pixels
  borderInnerThickness?: number | null
  // Inner border radius in pixels or CSS format
  borderInnerRadius?: anyOf: [
    {"type":"string"},
    {"type":"number"},
    {"type":"null"}
  ]
  // Color of the outer border in CSS format
  borderOuterColor?: string | null
  // Thickness of the outer border in pixels
  borderOuterThickness?: number | null
  // Text to display on top border
  borderTextTop?: string | null
  // Text to display on right border
  borderTextRight?: string | null
  // Text to display on bottom border
  borderTextBottom?: string | null
  // Text to display on left border
  borderTextLeft?: string | null
  // Font family for border text
  borderFontFace?: string | null
  // Font size for border text in pixels
  borderFontSize?: number | null
  // Font color for border text in CSS format
  borderFontColor?: string | null
  // Letter spacing for border text in pixels
  borderLetterSpacing?: number | null
  // Text transformation for border text
  borderTextTransform?: enum[uppercase, lowercase, capitalize, ]
  // Font weight for border text
  borderFontWeight?: string
}

// QR code configuration with optional data field
{
  // Overall shape of the QR code
  shape?: enum[square, circle, ]
  // Margin around the QR code in pixels
  margin?: number | null
  // Whether QR code is responsive
  isResponsive?: boolean | null
  // Scale factor for QR code (0-1.5)
  scale?: number | null
  // General offset in pixels
  offset?: number | null
  // Vertical offset in pixels
  verticalOffset?: number | null
  // Horizontal offset in pixels
  horizontalOffset?: number | null
  // QR code specific options
  qrOptions?: object | null
  // Options for QR code dots
  dotsOptions?: object | null
  // Options for QR code corner squares
  cornersSquareOptions?: object | null
  // Options for QR code corner dots
  cornersDotOptions?: object | null
  // Options for QR code background or false to disable
  backgroundOptions?: anyOf: [
    {"type":"object","properties":{"color":{"type":["string","null"],"description":"Background color in CSS format","example":"#ffffff"},"round":{"anyOf":[{"type":"number","minimum":0,"maximum":1},{"type":"string"},{"type":"null"}],"description":"Background corner rounding (0-1 or CSS value)","example":0.1},"gradient":{"oneOf":[{"$ref":"Gradient"},{"type":"null"}],"description":"Gradient for background"}},"required":["color"]},
    {"type":"boolean","const":false}
  ]
  // Image to embed in the QR code (URL, Buffer, or Blob)
  image?: anyOf: [
    {"type":"string"},
    {},
    {},
    {"type":"null"}
  ]
  // Options for embedded image
  imageOptions?: object | null
  // Border configuration options
  borderOptions?: object | null
  // Data to encode in the QR code (optional in this context)
  data?: string
}

// Border options configuration
{
  // Overall shape of the QR code
  shape?: enum[square, circle, ]
  // Margin around the QR code in pixels
  margin?: number | null
  // Whether QR code is responsive
  isResponsive?: boolean | null
  // Scale factor for QR code (0-1.5)
  scale?: number | null
  // General offset in pixels
  offset?: number | null
  // Vertical offset in pixels
  verticalOffset?: number | null
  // Horizontal offset in pixels
  horizontalOffset?: number | null
  // QR code specific options
  qrOptions?: object | null
  // Options for QR code dots
  dotsOptions?: object | null
  // Options for QR code corner squares
  cornersSquareOptions?: object | null
  // Options for QR code corner dots
  cornersDotOptions?: object | null
  // Options for QR code background or false to disable
  backgroundOptions?: anyOf: [
    {"type":"object","properties":{"color":{"type":["string","null"],"description":"Background color in CSS format","example":"#ffffff"},"round":{"anyOf":[{"type":"number","minimum":0,"maximum":1},{"type":"string"},{"type":"null"}],"description":"Background corner rounding (0-1 or CSS value)","example":0.1},"gradient":{"oneOf":[{"$ref":"Gradient"},{"type":"null"}],"description":"Gradient for background"}},"required":["color"]},
    {"type":"boolean","const":false}
  ]
  // Image to embed in the QR code (URL, Buffer, or Blob)
  image?: anyOf: [
    {"type":"string"},
    {},
    {},
    {"type":"null"}
  ]
  // Options for embedded image
  imageOptions?: object | null
  borderOptions: {
    // Whether to show border
    hasBorder?: boolean | null
    // Border thickness in pixels
    thickness?: number | null
    // Border color in CSS format
    color?: string | null
    // Border radius in CSS format
    radius?: string | null
    // Thickness when no border is shown
    noBorderThickness?: number | null
    // Border background color in CSS format
    background?: string | null
    // Inner border configuration
    inner?: object | null
    // Outer border configuration
    borderOuter?: oneOf: [
      {"$ref":"BorderInnerOuter"},
      {"type":"null"}
    ]
    // Inner border configuration
    borderInner?: oneOf: [
      {"$ref":"BorderInnerOuter"},
      {"type":"null"}
    ]
    // Border decorations configuration
    decorations?: object | null
  }
}

// Text options configuration
{
  // Text value for all positions
  value?: string | null
  // Text value for the top position
  topValue?: string | null
  // Text value for the bottom position
  bottomValue?: string | null
  // Text value for the right position
  rightValue?: string | null
  // Text value for the left position
  leftValue?: string | null
}

// QR code response with audit information
allOf: [
  {"$ref":"BaseCodeResponse"}
]

// QR code response with audit information and file links
allOf: [
  {"$ref":"BaseCodeResponseWithAudit"}
]

// QR code file link
{
  // Format of the QR code file
  format: string
  // URL to access the QR code file
  url: string
}

// QR code response with audit information and file links
allOf: [
  {"$ref":"BaseCodeResponseWithAudit"}
]

{
  // Unique identifier for the code link
  id: string
  // Type of the link file
  type: string
  // Name of the link
  name: string
  // URL to access the file
  url: string
  // When the resource was created
  createdAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
  // When the resource was last updated
  updatedAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
  // ID of the user who created the link
  createdByUserId: string | null
  // ID of the API key used to create the link
  createdByApiKeyId: string | null
  // Associated QR code information
  code: {
    // ID of the related code
    id: string
    // Name of the related code
    name: string | null
    // Data encoded in the QR code
    data: string
    // Description of the related code
    description: string | null
  }
  // Version number of the code
  version?: number
  // Whether this link is for the current version
  isCurrentVersion?: boolean
  // User who created the resource
  createdByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // User who last updated the resource
  updatedByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // API key used to create the resource
  createdByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // API key used to last update the resource
  updatedByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
}

// Error response when the data for QR Code is missing
{
  message: string
}

// Error response when the QR Code configuration is invalid
{
  message: string
}

// Error response when an invalid code type is provided
{
  message: string
}

// Error response when a dynamic data is provided for a new static QR code
{
  message: string
}

// Error response when a dynamic data is required for a dynamic QR code
{
  message: string
}

// Error response when a QR Code with the specified short alias already exists
{
  message: string
}

// Error response when a short alias is provided for a static QR code
{
  message: string
}

// Error response when a dynamic data points to the redirect domain
{
  message: string
}

// Error response when a dataType is provided for a static QR code
{
  message: string
}

// Error response when a dataType is provided for a dynamic to static QR code
{
  message: string
}

// Error response when a data is provided for a dynamic QR code
{
  message: string
}

// Indicates that the specified style was not found
{
  // The specified style could not be found
  message: string
}

// Indicates that the specified template was not found
{
  // The specified template could not be found
  message: string
}

// Indicates that the specified border entity was not found
{
  // The specified border entity could not be found
  message: string
}

// Indicates that the specified text entity was not found
{
  // The specified text entity could not be found
  message: string
}

{
  // Type of QR code
  type?: enum[static, dynamic]
  // The type of data the QR code contains. Only applies to dynamic codes. Defaults to "url" for dynamic codes. Each dataType has specific content structure requirements. url: {url}, wifi: {ssid, password?, security?, hidden?}, vcard: {fullName?, email?, phone?, organization?}, text: {text}, email: {to, subject?, body?}, event: {eventTitle, startDate, endDate?, location?}, file: {fileName, fileUrl, mimeType?}, json: any valid JSON.
  dataType?: enum[url, wifi, vcard, text, email, event, json, file]
  // Functional content for dynamic QR codes. Structure depends on dataType. url: {url}, wifi: {ssid, password?, security?, hidden?}, vcard: {fullName?, email?, phone?, organization?}, text: {text}, email: {to, subject?, body?}, event: {eventTitle, startDate, endDate?, location?}, file: {fileName, fileUrl, mimeType?}, json: any valid JSON.
  dynamicData?: {
  }
  // Short alias for the QR code link (URL-safe characters only)
  shortAlias?: string
  // QR code data content
  data?: string
  // Name of the QR code
  name: string
  // Optional description for the QR code
  description?: string
  // Custom user metadata for the QR code as JSON object. This is separate from the dynamicData field and can store any additional information about the QR code that is not part of the functional content (e.g., campaign info, tags, internal references).
  metadata?: object | null
  // Format for the generated QR code link
  linkFormat?: enum[svg, png, pdf]
  // Whether to validate the QR code during creation
  validate?: boolean
  // QR code generation options
  options?: oneOf: [
    {"$ref":"QRCodeOptionsWithOptionalData"},
    {"type":"null"}
  ]
  // Style ID to apply to the QR code
  styleId?: string | null
  // Style object with options or style name string
  style?: anyOf: [
    {"type":["object","null"],"properties":{"id":{"type":["string","null"]},"options":{"oneOf":[{"$ref":"StyleOptions"},{"type":"null"}]}}},
    {"type":"string"},
    {"type":"null"}
  ]
  // Template ID to apply to the QR code
  templateId?: string | null
  // Template object with options or template name string
  template?: anyOf: [
    {"type":["object","null"],"properties":{"id":{"type":["string","null"]},"options":{"oneOf":[{"$ref":"QRCodeOptionsWithOptionalData"},{"type":"null"}]}}},
    {"type":"string"},
    {"type":"null"}
  ]
  // Border ID to apply to the QR code
  borderId?: string | null
  // Border object with options or border name string
  border?: anyOf: [
    {"type":["object","null"],"properties":{"id":{"type":["string","null"]},"options":{"oneOf":[{"$ref":"BorderOptions"},{"type":"null"}]}}},
    {"type":"string"},
    {"type":"null"}
  ]
  // Text ID to apply to the QR code
  textId?: string | null
  // Text object with options or text name string
  text?: anyOf: [
    {"type":["object","null"],"properties":{"id":{"type":["string","null"]},"options":{"oneOf":[{"$ref":"TextOptions"},{"type":"null"}]}}},
    {"type":"string"},
    {"type":"null"}
  ]
}

// Error response when attempting to update a soft-deleted code
{
  message: string
}

// Error response when a dynamic data is provided for a static QR code
{
  message: string
}

// Error response when a short alias is provided for a dynamic to static QR code
{
  message: string
}

{
  // Type of QR code
  type?: enum[static, dynamic]
  // The type of data the QR code contains. Only applies to dynamic codes. Determines how the QR code data is processed and what content type is returned when scanned. Each dataType has specific content structure requirements.
  dataType?: enum[url, wifi, vcard, text, email, event, json, file, ]
  // Functional content for dynamic QR codes. Structure depends on dataType. url: {url}, wifi: {ssid, password?, security?, hidden?}, vcard: {fullName?, email?, phone?, organization?}, text: {text}, email: {to, subject?, body?}, event: {eventTitle, startDate, endDate?, location?}, file: {fileName, fileUrl, mimeType?}, json: any valid JSON.
  dynamicData?: object | null
  // Short alias for the QR code link (URL-safe characters only)
  shortAlias?: string | null
  // QR code data content
  data?: string | null
  // QR code generation options
  options?: oneOf: [
    {"$ref":"QRCodeOptionsWithOptionalData"},
    {"type":"null"}
  ]
  // Name of the QR code
  name?: string
  // Description for the QR code
  description?: string
  // Custom user metadata for the QR code as JSON object. This is separate from the dynamicData field and can store any additional information about the QR code that is not part of the functional content (e.g., campaign info, tags, internal references).
  metadata?: object | null
  // Style ID to apply to the QR code
  styleId?: string | null
  // Style object with options or style name string
  style?: anyOf: [
    {"type":"object","properties":{"id":{"type":["string","null"]},"name":{"type":["string","null"]},"options":{"oneOf":[{"$ref":"StyleOptions"},{"type":"null"}]}}},
    {"type":"string"},
    {"type":"null"}
  ]
  // Template ID to apply to the QR code
  templateId?: string | null
  // Template object with options or template name string
  template?: anyOf: [
    {"type":"object","properties":{"id":{"type":["string","null"]},"name":{"type":["string","null"]},"options":{"oneOf":[{"$ref":"QRCodeOptionsWithOptionalData"},{"type":"null"}]}}},
    {"type":"string"},
    {"type":"null"}
  ]
  // Border ID to apply to the QR code
  borderId?: string | null
  // Border object with options or border name string
  border?: anyOf: [
    {"type":"object","properties":{"id":{"type":["string","null"]},"name":{"type":["string","null"]},"options":{"oneOf":[{"$ref":"BorderOptions"},{"type":"null"}]}}},
    {"type":"string"},
    {"type":"null"}
  ]
  // Text ID to apply to the QR code
  textId?: string | null
  // Text object with options or text name string
  text?: anyOf: [
    {"type":"object","properties":{"id":{"type":["string","null"]},"name":{"type":["string","null"]},"options":{"oneOf":[{"$ref":"TextOptions"},{"type":"null"}]}}},
    {"type":"string"},
    {"type":"null"}
  ]
  // Format for the generated QR code link. Return existing link if generated before or create new link with provided format.
  linkFormat?: enum[svg, png, pdf]
  // Whether to validate the QR code during update
  validate?: boolean
}

// Error response when at least one field within options is required for an update operation
{
  message: string
}

{
  // The type of data the QR code contains. Only applies to dynamic codes. Determines how the QR code data is processed and what content type is returned when scanned.
  dataType?: enum[url, wifi, vcard, text, email, event, json, file]
  // Partial QR code generation options to update. All fields are optional. At least one option field must be provided.
  options: {
    // Data to encode in the QR code (required)
    data?: string
    // Shape of the QR code
    shape?: enum[square, circle, ]
    margin?: number | null
    isResponsive?: boolean | null
    scale?: number | null
    offset?: number | null
    verticalOffset?: number | null
    horizontalOffset?: number | null
    qrOptions?: object | null
    dotsOptions?: object | null
    cornersSquareOptions?: object | null
    cornersDotOptions?: object | null
    backgroundOptions?: anyOf: [
      {"type":"object","properties":{"color":{"type":["string","null"],"description":"Background color in CSS format","example":"#ffffff"},"round":{"anyOf":[{"type":"number","minimum":0,"maximum":1},{"type":"string"},{"type":"null"}],"description":"Background corner rounding (0-1 or CSS value)","example":0.1},"gradient":{"oneOf":[{"$ref":"Gradient"},{"type":"null"}],"description":"Gradient for background"}},"required":["color"]},
      {"type":"boolean","const":false}
    ]
    image?: anyOf: [
      {"type":"string"},
      {},
      {},
      {"type":"null"}
    ]
    imageOptions?: object | null
    borderOptions?: object | null
  }
  // Format for the generated QR code link. Return existing link if generated before or create new link with provided format.
  linkFormat?: enum[svg, png, pdf]
  // Whether to validate the QR code after updating options.
  validate?: boolean
}