{
  "openapi": "3.0.4",
  "info": {
    "title": "DTO Flow Automation API",
    "version": "v1"
  },
  "paths": {
    "/api/automation/v1/file-feeds/{fileFeedSlug}/manifest": {
      "get": {
        "tags": [
          "AutomationFileFeeds"
        ],
        "operationId": "GetManifest",
        "parameters": [
          {
            "name": "fileFeedSlug",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/AutomationFeedManifest"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AutomationFeedManifest"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/AutomationFeedManifest"
                }
              }
            }
          }
        }
      }
    },
    "/api/automation/v1/file-feeds/{fileFeedSlug}/periods/by-deadline": {
      "get": {
        "tags": [
          "AutomationFileFeeds"
        ],
        "operationId": "GetPeriodStatusByDeadline",
        "parameters": [
          {
            "name": "fileFeedSlug",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "deadlineAt",
            "in": "query",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/AutomationPeriodStatus"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AutomationPeriodStatus"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/AutomationPeriodStatus"
                }
              }
            }
          }
        }
      }
    },
    "/api/automation/v1/file-feeds/{fileFeedSlug}/submissions/upload-sessions": {
      "post": {
        "tags": [
          "AutomationFileFeeds"
        ],
        "operationId": "CreateUploadSession",
        "parameters": [
          {
            "name": "fileFeedSlug",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateAutomationUploadSessionRequest"
              }
            },
            "text/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateAutomationUploadSessionRequest"
              }
            },
            "application/*+json": {
              "schema": {
                "$ref": "#/components/schemas/CreateAutomationUploadSessionRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/SubmissionUploadSessionResponse"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubmissionUploadSessionResponse"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubmissionUploadSessionResponse"
                }
              }
            }
          }
        }
      }
    },
    "/api/automation/v1/file-feeds/{fileFeedSlug}/submissions/{submissionId}/complete": {
      "post": {
        "tags": [
          "AutomationFileFeeds"
        ],
        "operationId": "CompleteUpload",
        "parameters": [
          {
            "name": "fileFeedSlug",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "submissionId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/FileFeedSubmissionSummaryResponse"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FileFeedSubmissionSummaryResponse"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/FileFeedSubmissionSummaryResponse"
                }
              }
            }
          }
        }
      }
    },
    "/api/automation/v1/file-feeds/{fileFeedSlug}/periods/by-deadline/accepted-files": {
      "get": {
        "tags": [
          "AutomationFileFeeds"
        ],
        "operationId": "GetAcceptedFilesByDeadline",
        "parameters": [
          {
            "name": "fileFeedSlug",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "deadlineAt",
            "in": "query",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/AutomationAcceptedFiles"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AutomationAcceptedFiles"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/AutomationAcceptedFiles"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "AutomationAcceptedFile": {
        "type": "object",
        "properties": {
          "submittedFileId": {
            "type": "string",
            "format": "uuid"
          },
          "feedFileId": {
            "type": "string",
            "format": "uuid",
            "nullable": true
          },
          "fileName": {
            "type": "string",
            "nullable": true
          },
          "contentType": {
            "type": "string",
            "nullable": true
          },
          "sizeBytes": {
            "type": "integer",
            "format": "int64"
          },
          "downloadUrl": {
            "type": "string",
            "nullable": true
          },
          "expiresAt": {
            "type": "string",
            "format": "date-time"
          }
        },
        "additionalProperties": false
      },
      "AutomationAcceptedFiles": {
        "type": "object",
        "properties": {
          "fileFeedId": {
            "type": "string",
            "format": "uuid"
          },
          "submissionId": {
            "type": "string",
            "format": "uuid"
          },
          "periodKey": {
            "type": "string",
            "nullable": true
          },
          "deadlineAt": {
            "type": "string",
            "format": "date-time"
          },
          "status": {
            "type": "string",
            "nullable": true
          },
          "files": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AutomationAcceptedFile"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "AutomationFeedFileManifest": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "slug": {
            "type": "string",
            "nullable": true
          },
          "sortOrder": {
            "type": "integer",
            "format": "int32"
          },
          "status": {
            "type": "string",
            "nullable": true
          },
          "format": {
            "type": "string",
            "nullable": true
          },
          "expectedExtension": {
            "type": "string",
            "nullable": true
          },
          "fileNameMatchMode": {
            "type": "string",
            "nullable": true
          },
          "fileNameMatchValue": {
            "type": "string",
            "nullable": true
          },
          "requiredInSubmission": {
            "type": "boolean"
          },
          "isValidationEnabled": {
            "type": "boolean"
          }
        },
        "additionalProperties": false
      },
      "AutomationFeedManifest": {
        "type": "object",
        "properties": {
          "fileFeedId": {
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "slug": {
            "type": "string",
            "nullable": true
          },
          "direction": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "string",
            "nullable": true
          },
          "allowAdditionalFiles": {
            "type": "boolean"
          },
          "uploadSchedule": {
            "$ref": "#/components/schemas/AutomationUploadSchedule"
          },
          "uploadLimits": {
            "$ref": "#/components/schemas/AutomationFileUploadLimits"
          },
          "files": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AutomationFeedFileManifest"
            },
            "nullable": true
          },
          "tokenScopes": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "AutomationFileUploadLimits": {
        "type": "object",
        "properties": {
          "maxFileSizeMegaBytes": {
            "type": "integer",
            "format": "int64"
          },
          "blockedFileTypes": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "AutomationPeriodStatus": {
        "type": "object",
        "properties": {
          "fileFeedId": {
            "type": "string",
            "format": "uuid"
          },
          "deadlineAt": {
            "type": "string",
            "format": "date-time"
          },
          "hasSubmission": {
            "type": "boolean"
          },
          "submissionId": {
            "type": "string",
            "format": "uuid",
            "nullable": true
          },
          "periodKey": {
            "type": "string",
            "nullable": true
          },
          "periodStart": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "periodEnd": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "status": {
            "type": "string",
            "nullable": true
          },
          "fileCount": {
            "type": "integer",
            "format": "int32"
          },
          "uploadCompleted": {
            "type": "boolean"
          },
          "validationStatus": {
            "type": "string",
            "nullable": true
          },
          "accepted": {
            "type": "boolean"
          },
          "acceptedFilesAvailable": {
            "type": "boolean"
          },
          "submittedAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "AutomationUploadSchedule": {
        "type": "object",
        "properties": {
          "frequency": {
            "type": "string",
            "nullable": true
          },
          "timeZoneId": {
            "type": "string",
            "nullable": true
          },
          "dueTime": {
            "type": "string",
            "format": "time"
          },
          "dueDayOfWeek": {
            "$ref": "#/components/schemas/DayOfWeek"
          },
          "dueDayOfMonth": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "gracePeriodMinutes": {
            "type": "integer",
            "format": "int32"
          }
        },
        "additionalProperties": false
      },
      "CreateAutomationUploadFileRequest": {
        "type": "object",
        "properties": {
          "feedFileSlug": {
            "type": "string",
            "nullable": true
          },
          "originalFileName": {
            "type": "string",
            "nullable": true
          },
          "contentType": {
            "type": "string",
            "nullable": true
          },
          "sizeBytes": {
            "type": "integer",
            "format": "int64"
          }
        },
        "additionalProperties": false
      },
      "CreateAutomationUploadSessionRequest": {
        "type": "object",
        "properties": {
          "partnerSlug": {
            "type": "string",
            "nullable": true
          },
          "deadlineAt": {
            "type": "string",
            "format": "date-time"
          },
          "files": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CreateAutomationUploadFileRequest"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "DayOfWeek": {
        "enum": [
          0,
          1,
          2,
          3,
          4,
          5,
          6
        ],
        "type": "integer",
        "format": "int32"
      },
      "FileFeedSubmissionSummaryResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "partnerId": {
            "type": "string",
            "format": "uuid",
            "nullable": true
          },
          "partnerName": {
            "type": "string",
            "nullable": true
          },
          "periodKey": {
            "type": "string",
            "nullable": true
          },
          "periodStart": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "periodEnd": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "dueAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "status": {
            "type": "string",
            "nullable": true
          },
          "fileCount": {
            "type": "integer",
            "format": "int32"
          },
          "createdByUserId": {
            "type": "string",
            "format": "uuid",
            "nullable": true
          },
          "createdByUserDisplayName": {
            "type": "string",
            "nullable": true
          },
          "createdByUserEmail": {
            "type": "string",
            "nullable": true
          },
          "createdByUserProfilePictureUrl": {
            "type": "string",
            "nullable": true
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "submittedByUserId": {
            "type": "string",
            "format": "uuid",
            "nullable": true
          },
          "submittedByUserDisplayName": {
            "type": "string",
            "nullable": true
          },
          "submittedByUserEmail": {
            "type": "string",
            "nullable": true
          },
          "submittedByUserProfilePictureUrl": {
            "type": "string",
            "nullable": true
          },
          "submittedAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "SubmissionUploadFileTargetResponse": {
        "type": "object",
        "properties": {
          "submittedFileId": {
            "type": "string",
            "format": "uuid"
          },
          "feedFileId": {
            "type": "string",
            "format": "uuid",
            "nullable": true
          },
          "originalFileName": {
            "type": "string",
            "nullable": true
          },
          "blobPath": {
            "type": "string",
            "nullable": true
          },
          "sizeBytes": {
            "type": "integer",
            "format": "int64"
          },
          "contentType": {
            "type": "string",
            "nullable": true
          },
          "uploadUrl": {
            "type": "string",
            "nullable": true
          },
          "method": {
            "type": "string",
            "nullable": true
          },
          "headers": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "nullable": true
          },
          "expiresAt": {
            "type": "string",
            "format": "date-time"
          }
        },
        "additionalProperties": false
      },
      "SubmissionUploadSessionResponse": {
        "type": "object",
        "properties": {
          "submissionId": {
            "type": "string",
            "format": "uuid"
          },
          "partnerId": {
            "type": "string",
            "format": "uuid",
            "nullable": true
          },
          "partnerName": {
            "type": "string",
            "nullable": true
          },
          "periodKey": {
            "type": "string",
            "nullable": true
          },
          "periodLabel": {
            "type": "string",
            "nullable": true
          },
          "periodStart": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "periodEnd": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "dueAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "status": {
            "type": "string",
            "nullable": true
          },
          "files": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SubmissionUploadFileTargetResponse"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      }
    },
    "securitySchemes": {
      "AutomationBearer": {
        "type": "http",
        "description": "Use a DTO Flow private access token with a feed grant for the requested automation action.",
        "scheme": "bearer",
        "bearerFormat": "DTO Flow private access token"
      }
    }
  },
  "security": [
    {
      "AutomationBearer": [ ]
    }
  ],
  "tags": [
    {
      "name": "AutomationFileFeeds"
    }
  ]
}