components:
 schemas:
    BaseFolderFilter:
      type: object
      description: The backend supports compound filters, therefore you can include either `folder_group_id`, or `folder_name` or both fields.
      properties:
        folder_group_id:
          type: integer
          description: Group ID associated with the folder to filter.
          example: 1234
          minimum: 1
        folder_name:
          type: string
          description: Name of the folder where to add the file.
          example: sample_folder

    FileCreateData:
      description: Payload for `NEW` or `CONTENT_CHANGE` actions.
      allOf:
        - $ref: "#/components/schemas/BaseFolderFilter"
        - type: object
          required: [file_name, file_download_url]
          properties:
            file_name:
              type: string
              description: Name of the file to add or modify.
              example: sample_pdf.pdf
            file_download_url:
              type: string
              format: uri
              description: Accessible URL to download the document.
              example: https://pdfobject.com/pdf/sample.pdf

    FileDeleteData:
      description: Payload for `DELETE` action.
      allOf:
        - $ref: "#/components/schemas/BaseFolderFilter"
        - type: object
          required: [file_name]
          properties:
            file_name:
              type: string
              description: Name of the file to delete.
              example: sample_pdf.pdf
    FileRenameData:
      description: Payload for `RENAME` action.
      required: [old_file_name, new_file_name]
      allOf:
        - $ref: "#/components/schemas/BaseFolderFilter"
        - type: object
          required: [old_file_name, new_file_name]
          properties:
            old_file_name:
              type: string
              description: Name of the existing file to be renamed.
              example: old_sample_pdf.pdf
            new_file_name:
              type: string
              description: New name of the file.
              example: new_sample_pdf.pdf

    DocumentSyncRequestBody:
      type: object
      required: [action, data]
      properties:
        action:
          type: string
          enum: [NEW, CONTENT_CHANGE, RENAME, DELETE]
          description: Action name to execute.
        data:
          oneOf:
            - $ref: "#/components/schemas/FileCreateData"
            - $ref: "#/components/schemas/FileRenameData"
            - $ref: "#/components/schemas/FileDeleteData"