---
displayed_sidebar: entitiesSidebar
---

import ParameterTypes from "@site/src/components/ParameterTypes"

# BatchJob

## Properties

<ParameterTypes parameters={[
  {
    "name": "canceled_at",
    "type": "`Date`",
    "description": "",
    "optional": true,
    "defaultValue": "",
    "children": []
  },
  {
    "name": "completed_at",
    "type": "`Date`",
    "description": "",
    "optional": true,
    "defaultValue": "",
    "children": []
  },
  {
    "name": "confirmed_at",
    "type": "`Date`",
    "description": "",
    "optional": true,
    "defaultValue": "",
    "children": []
  },
  {
    "name": "context",
    "type": "Record<`string`, `unknown`\\>",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "children": []
  },
  {
    "name": "created_at",
    "type": "`Date`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "children": []
  },
  {
    "name": "created_by",
    "type": "``null`` \\| `string`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "children": []
  },
  {
    "name": "created_by_user",
    "type": "[`User`](User.mdx)",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "children": [
      {
        "name": "constructor",
        "type": "() => [`User`](User.mdx)",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "children": []
      },
      {
        "name": "api_token",
        "type": "`string`",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "children": []
      },
      {
        "name": "created_at",
        "type": "`Date`",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "children": []
      },
      {
        "name": "deleted_at",
        "type": "``null`` \\| `Date`",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "children": []
      },
      {
        "name": "email",
        "type": "`string`",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "children": []
      },
      {
        "name": "first_name",
        "type": "`string`",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "children": []
      },
      {
        "name": "id",
        "type": "`string`",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "children": []
      },
      {
        "name": "last_name",
        "type": "`string`",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "children": []
      },
      {
        "name": "metadata",
        "type": "Record<`string`, `unknown`\\>",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "children": []
      },
      {
        "name": "password_hash",
        "type": "`string`",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "children": []
      },
      {
        "name": "role",
        "type": "[`UserRoles`](../enums/UserRoles.mdx)",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "children": [
          {
            "name": "ADMIN",
            "type": "``\"admin\"``",
            "description": "",
            "optional": true,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "DEVELOPER",
            "type": "``\"developer\"``",
            "description": "",
            "optional": true,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "MEMBER",
            "type": "``\"member\"``",
            "description": "",
            "optional": true,
            "defaultValue": "",
            "children": []
          }
        ]
      },
      {
        "name": "updated_at",
        "type": "`Date`",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "children": []
      },
      {
        "name": "beforeInsert",
        "type": "() => `void`",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "children": []
      }
    ]
  },
  {
    "name": "deleted_at",
    "type": "``null`` \\| `Date`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "children": []
  },
  {
    "name": "dry_run",
    "type": "`boolean`",
    "description": "",
    "optional": false,
    "defaultValue": "`false`",
    "children": []
  },
  {
    "name": "failed_at",
    "type": "`Date`",
    "description": "",
    "optional": true,
    "defaultValue": "",
    "children": []
  },
  {
    "name": "id",
    "type": "`string`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "children": []
  },
  {
    "name": "pre_processed_at",
    "type": "`Date`",
    "description": "",
    "optional": true,
    "defaultValue": "",
    "children": []
  },
  {
    "name": "processing_at",
    "type": "`Date`",
    "description": "",
    "optional": true,
    "defaultValue": "",
    "children": []
  },
  {
    "name": "result",
    "type": "{ `advancement_count?`: `number` ; `count?`: `number` ; `errors?`: (`string` \\| `BatchJobResultError`)[] ; `file_key?`: `string` ; `file_size?`: `number` ; `progress?`: `number` ; `stat_descriptors?`: `BatchJobResultStatDescriptor`[]  } & Record<`string`, `unknown`\\>",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "children": []
  },
  {
    "name": "status",
    "type": "`BatchJobStatus`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "children": []
  },
  {
    "name": "type",
    "type": "`string`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "children": []
  },
  {
    "name": "updated_at",
    "type": "`Date`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "children": []
  }
]} />