diff --git a/.circleci/config.yml b/.circleci/config.yml index 2354bac9ff0..b923d9ec4d7 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -123,7 +123,7 @@ jobs: environment: discovery.type: single-node resource_class: xlarge - parallelism: 4 + parallelism: 5 steps: - attach_workspace: at: ~/ @@ -135,7 +135,7 @@ jobs: command: | SKIP_CACHE_INVALIDATION=true AWS_ACCESS_KEY_ID=noop AWS_SECRET_ACCESS_KEY=noop npm run start:api:ci > /tmp/web-client/server-output.txt & ./wait-until.sh http://localhost:3000/api/swagger - TESTFILES=$(circleci tests glob "web-client/integration-tests/*.test.js" | circleci tests split --split-by=timings) + TESTFILES=$(circleci tests glob "web-client/integration-tests/*.test.js" "web-client/integration-tests-public/*.test.js" | circleci tests split --split-by=timings) CI=true NO_SCANNER=true SKIP_VIRUS_SCAN=true AWS_ACCESS_KEY_ID=noop AWS_SECRET_ACCESS_KEY=noop npx jest --coverageDirectory=./coverage-integration-${CIRCLE_NODE_INDEX} --runInBand --config web-client/jest-integration.config.js ${TESTFILES} - store_artifacts: path: /tmp/web-client @@ -161,6 +161,7 @@ jobs: ./web-client/coverage-integration-1/coverage-final.json \ ./web-client/coverage-integration-2/coverage-final.json \ ./web-client/coverage-integration-3/coverage-final.json \ + ./web-client/coverage-integration-4/coverage-final.json \ ./web-client/coverage-unit/coverage-final.json - run: name: Check Coverage @@ -254,6 +255,45 @@ jobs: - store_artifacts: path: /tmp/cypress + e2e-cypress-public: + docker: + - image: $AWS_ACCOUNT_ID.dkr.ecr.us-east-1.amazonaws.com/ef-cms-us-east-1:latest + aws_auth: + aws_access_key_id: $AWS_ACCESS_KEY_ID + aws_secret_access_key: $AWS_SECRET_ACCESS_KEY + - image: amazon/dynamodb-local + command: ['-jar', 'DynamoDBLocal.jar', '-sharedDb'] + - image: elastic/elasticsearch:7.5.2 + environment: + discovery.type: single-node + environment: + _JAVA_OPTIONS: '-Xms1024m -Xmx2048m' + resource_class: xlarge + steps: + - attach_workspace: + at: ~/ + - run: + name: Create Cypress Artifacts Directory + command: mkdir /tmp/cypress + - run: + name: Cypress + command: | + npm run build:all && + CYPRESS_VERSION=`./node_modules/.bin/cypress --version | awk -F' ' '{print $4; exit}'` + if [ ! -e "/root/.cache/Cypress/${CYPRESS_VERSION}/Cypress/Cypress" ]; then + ./node_modules/.bin/cypress install + fi + + SKIP_CACHE_INVALIDATION=true TEMP_DOCUMENTS_BUCKET_NAME=noop-temp-documents-local-us-east-1 DOCUMENTS_BUCKET_NAME=noop-documents-local-us-east-1 S3_ENDPOINT=http://localhost:9000 MASTER_DYNAMODB_ENDPOINT=http://localhost:8000 AWS_ACCESS_KEY_ID=S3RVER AWS_SECRET_ACCESS_KEY=S3RVER SLS_DEPLOYMENT_BUCKET=noop npx run-p start:api:ci start:public:ci > /tmp/cypress/cypress-output.txt & + ./wait-until-services.sh + ./wait-until.sh http://localhost:3000/api/swagger + sleep 5 + npm run cypress:public + - store_artifacts: + path: /root/project/cypress/videos/ + - store_artifacts: + path: /tmp/cypress + pre-deploy: machine: docker_layer_caching: true @@ -358,6 +398,9 @@ jobs: - run: name: 'Deploy - Web API - Serverless - Practitioners - us-east-1' command: docker run -e "AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID}" -e "AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY}" -e "EFCMS_DOMAIN=${EFCMS_DOMAIN}" -e "CIRCLE_HONEYBADGER_API_KEY=${CIRCLE_HONEYBADGER_API_KEY}" -e "IRS_SUPERUSER_EMAIL=${IRS_SUPERUSER_EMAIL}" -v $(pwd)/.cache:/home/app/.cache --rm efcms /bin/sh -c "./web-api/run-serverless-practitioners.sh ${ENV} us-east-1" + - run: + name: 'Deploy - Web API - Serverless - Messages - us-east-1' + command: docker run -e "AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID}" -e "AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY}" -e "EFCMS_DOMAIN=${EFCMS_DOMAIN}" -e "CIRCLE_HONEYBADGER_API_KEY=${CIRCLE_HONEYBADGER_API_KEY}" -e "IRS_SUPERUSER_EMAIL=${IRS_SUPERUSER_EMAIL}" -v $(pwd)/.cache:/home/app/.cache --rm efcms /bin/sh -c "./web-api/run-serverless-messages.sh ${ENV} us-east-1" - run: name: 'Deploy - Web API - Serverless - Notifications - us-east-1' command: docker run -e "AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID}" -e "AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY}" -e "EFCMS_DOMAIN=${EFCMS_DOMAIN}" -e "CIRCLE_HONEYBADGER_API_KEY=${CIRCLE_HONEYBADGER_API_KEY}" -e "IRS_SUPERUSER_EMAIL=${IRS_SUPERUSER_EMAIL}" -v $(pwd)/.cache:/home/app/.cache --rm efcms /bin/sh -c "./web-api/run-serverless-notifications.sh ${ENV} us-east-1" @@ -436,6 +479,9 @@ jobs: - run: name: 'Deploy - Web API - Serverless - Practitioners - us-west-1' command: docker run -e "AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID}" -e "AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY}" -e "EFCMS_DOMAIN=${EFCMS_DOMAIN}" -e "CIRCLE_HONEYBADGER_API_KEY=${CIRCLE_HONEYBADGER_API_KEY}" -e "IRS_SUPERUSER_EMAIL=${IRS_SUPERUSER_EMAIL}" -v $(pwd)/.cache:/home/app/.cache --rm efcms /bin/sh -c "./web-api/run-serverless-practitioners.sh ${ENV} us-west-1" + - run: + name: 'Deploy - Web API - Serverless - Messages - us-west-1' + command: docker run -e "AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID}" -e "AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY}" -e "EFCMS_DOMAIN=${EFCMS_DOMAIN}" -e "CIRCLE_HONEYBADGER_API_KEY=${CIRCLE_HONEYBADGER_API_KEY}" -e "IRS_SUPERUSER_EMAIL=${IRS_SUPERUSER_EMAIL}" -v $(pwd)/.cache:/home/app/.cache --rm efcms /bin/sh -c "./web-api/run-serverless-messages.sh ${ENV} us-west-1" - run: name: 'Deploy - Web API - Serverless - Notifications - us-west-1' command: docker run -e "AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID}" -e "AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY}" -e "EFCMS_DOMAIN=${EFCMS_DOMAIN}" -e "CIRCLE_HONEYBADGER_API_KEY=${CIRCLE_HONEYBADGER_API_KEY}" -e "IRS_SUPERUSER_EMAIL=${IRS_SUPERUSER_EMAIL}" -v $(pwd)/.cache:/home/app/.cache --rm efcms /bin/sh -c "./web-api/run-serverless-notifications.sh ${ENV} us-west-1" @@ -462,10 +508,10 @@ jobs: # command: docker run -e "AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID}" -e "AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY}" -e "EFCMS_DOMAIN=${EFCMS_DOMAIN}" --rm efcms /bin/sh -c "cd web-api && ./switch-environment-color.sh ${ENV}" - run: name: 'Deploy - Web Client - S3' - command: docker run -e "DYNAMSOFT_URL_OVERRIDE=${DYNAMSOFT_URL_OVERRIDE}" -e "ENV=${ENV}" -e "AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID}" -e "AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY}" -e "EFCMS_DOMAIN=${EFCMS_DOMAIN}" -e "COGNITO_SUFFIX=${COGNITO_SUFFIX}" -e "CIRCLE_SHA1=${CIRCLE_SHA1}" -e "CIRCLE_HONEYBADGER_API_KEY=${CIRCLE_HONEYBADGER_API_KEY}" --rm efcms /bin/sh -c "./web-client/build-dist.sh $ENV && aws s3 sync dist s3://ui-${ENV}.${EFCMS_DOMAIN} --delete --cache-control no-cache && aws s3 sync dist s3://failover-ui-${ENV}.${EFCMS_DOMAIN} --delete --cache-control no-cache" + command: docker run -e "DYNAMSOFT_URL_OVERRIDE=${DYNAMSOFT_URL_OVERRIDE}" -e "ENV=${ENV}" -e "AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID}" -e "AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY}" -e "EFCMS_DOMAIN=${EFCMS_DOMAIN}" -e "COGNITO_SUFFIX=${COGNITO_SUFFIX}" -e "CIRCLE_SHA1=${CIRCLE_SHA1}" -e "CIRCLE_HONEYBADGER_API_KEY=${CIRCLE_HONEYBADGER_API_KEY}" --rm efcms /bin/sh -c "./web-client/build-dist.sh $ENV && aws s3 sync dist s3://ui-${ENV}.${EFCMS_DOMAIN} --delete && aws s3 cp s3://ui-${ENV}.${EFCMS_DOMAIN}/index.html s3://ui-${ENV}.${EFCMS_DOMAIN}/index.html --metadata-directive REPLACE --cache-control max-age=0 && aws s3 sync dist s3://failover-ui-${ENV}.${EFCMS_DOMAIN} --delete --cache-control no-cache && aws s3 cp s3://failover-ui-${ENV}.${EFCMS_DOMAIN}/index.html s3://failover-ui-${ENV}.${EFCMS_DOMAIN}/index.html --metadata-directive REPLACE --cache-control max-age=0" - run: name: 'Deploy - Public Web Client - S3' - command: docker run -e "ENV=${ENV}" -e "AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID}" -e "AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY}" -e "EFCMS_DOMAIN=${EFCMS_DOMAIN}" -e "COGNITO_SUFFIX=${COGNITO_SUFFIX}" -e "CIRCLE_SHA1=${CIRCLE_SHA1}" --rm efcms /bin/sh -c "./web-client/build-dist-public.sh $ENV && aws s3 sync dist-public s3://ui-public-${ENV}.${EFCMS_DOMAIN} --delete --cache-control no-cache && aws s3 sync dist-public s3://failover-ui-public-${ENV}.${EFCMS_DOMAIN} --delete --cache-control no-cache" + command: docker run -e "ENV=${ENV}" -e "AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID}" -e "AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY}" -e "EFCMS_DOMAIN=${EFCMS_DOMAIN}" -e "COGNITO_SUFFIX=${COGNITO_SUFFIX}" -e "CIRCLE_SHA1=${CIRCLE_SHA1}" --rm efcms /bin/sh -c "./web-client/build-dist-public.sh $ENV && aws s3 sync dist-public s3://ui-public-${ENV}.${EFCMS_DOMAIN} --delete && aws s3 cp s3://ui-public-${ENV}.${EFCMS_DOMAIN}/index.html s3://ui-public-${ENV}.${EFCMS_DOMAIN}/index.html --metadata-directive REPLACE --cache-control max-age=0 && aws s3 sync dist-public s3://failover-ui-public-${ENV}.${EFCMS_DOMAIN} --delete --cache-control no-cache && aws s3 cp s3://failover-ui-public-${ENV}.${EFCMS_DOMAIN}/index.html s3://failover-ui-public-${ENV}.${EFCMS_DOMAIN}/index.html --metadata-directive REPLACE --cache-control max-age=0" post-deploy: machine: @@ -493,22 +539,22 @@ jobs: - run: name: 'Deploy - Web API - Cognito Create Users' command: | - if [ "${CIRCLE_BRANCH}" == "staging" ] || [ "${CIRCLE_BRANCH}" == "irs" ]; then + if [ "${CIRCLE_BRANCH}" == "develop" ] || [ "${CIRCLE_BRANCH}" == "staging" ] || [ "${CIRCLE_BRANCH}" == "irs" ] || [ "${CIRCLE_BRANCH}" == "experimental1" ] || [ "${CIRCLE_BRANCH}" == "experimental2" ] ; then docker run -e "AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID}" -e "AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY}" -e "USTC_ADMIN_PASS=${USTC_ADMIN_PASS}" --rm efcms /bin/sh -c "cd web-api && ./setup-cognito-users.sh ${ENV}" else echo "skipping…" fi - run: name: 'Deploy - Web API - Cognito Create Court Users' - command: | - if [ "${CIRCLE_BRANCH}" == "staging" ] || [ "${CIRCLE_BRANCH}" == "test" ]; then + command: | + if [ "${CIRCLE_BRANCH}" == "develop" ] || [ "${CIRCLE_BRANCH}" == "staging" ] || [ "${CIRCLE_BRANCH}" == "test" ] || [ "${CIRCLE_BRANCH}" == "experimental1" ] || [ "${CIRCLE_BRANCH}" == "experimental2" ]; then docker run -e "AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID}" -e "AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY}" -e "USTC_ADMIN_PASS=${USTC_ADMIN_PASS}" --rm efcms /bin/sh -c "cd web-api && ./setup-court-users.sh ${ENV}" else echo "skipping…" fi - run: name: 'Deploy - Web API - Cognito Create IRS User' - command: | + command: | if [ "${CIRCLE_BRANCH}" == "irs" ]; then docker run -e "AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID}" -e "AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY}" -e "USTC_ADMIN_PASS=${USTC_ADMIN_PASS}" --rm efcms /bin/sh -c "cd web-api && ./setup-irs-user.sh ${ENV}" else @@ -578,6 +624,9 @@ workflows: - e2e-cypress: requires: - bundle + - e2e-cypress-public: + requires: + - bundle - build-client-coverage: requires: - build-shared @@ -586,6 +635,7 @@ workflows: - build-client-integration - e2e-pa11y - e2e-cypress + - e2e-cypress-public - pre-deploy: requires: - build-client-coverage @@ -658,6 +708,13 @@ workflows: branches: ignore: - develop + - e2e-cypress-public: + requires: + - bundle + filters: + branches: + ignore: + - develop - build-client-coverage: requires: - build-shared @@ -666,6 +723,7 @@ workflows: - build-client-integration - e2e-pa11y - e2e-cypress + - e2e-cypress-public filters: branches: ignore: @@ -681,7 +739,7 @@ workflows: - test - migration - master - - experimental + - experimental1 - experimental2 - deploy-api-east: requires: @@ -694,7 +752,7 @@ workflows: - test - migration - master - - experimental + - experimental1 - experimental2 - deploy-api-west: requires: @@ -707,7 +765,7 @@ workflows: - test - migration - master - - experimental + - experimental1 - experimental2 - switch-and-deploy-ui: requires: @@ -721,7 +779,7 @@ workflows: - test - migration - master - - experimental + - experimental1 - experimental2 - post-deploy: requires: @@ -734,5 +792,5 @@ workflows: - test - migration - master - - experimental + - experimental1 - experimental2 diff --git a/.eslintrc.js b/.eslintrc.js index df4ae40c5d3..feed186b1b6 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -33,6 +33,15 @@ module.exports = { 'promise/catch-or-return': 'off', }, }, + { + files: [ + 'web-client/integration-tests/**/*.js', + 'web-client/integration-tests-public/**/*.js', + ], + rules: { + 'jest/expect-expect': 'off', + }, + }, ], parser: 'babel-eslint', parserOptions: { @@ -218,6 +227,7 @@ module.exports = { 'dynamsoft', 'efcms', 'elasticsearch', + 'enum', 'eslint', 'falsy', 'fieldset', @@ -324,6 +334,7 @@ module.exports = { 'textarea', 'thorton', 'thortons', + 'todays', 'touchmove', 'transferee', 'truthy', diff --git a/.github/workflows/nodejs.yml b/.github/workflows/nodejs.yml index 3ceca225a64..0c97b8743bf 100644 --- a/.github/workflows/nodejs.yml +++ b/.github/workflows/nodejs.yml @@ -2,9 +2,9 @@ name: Node.js CI on: push: - branches: [ develop, experimental, master ] + branches: [ develop, experimental1, master ] pull_request: - branches: [ develop, experimental, master ] + branches: [ develop, experimental1, master ] jobs: linting: @@ -26,4 +26,3 @@ jobs: run: npm run lint - name: Shellcheck run: ./run-shellcheck.sh - diff --git a/.gitignore b/.gitignore index 8b4d2ce9a2b..194848c8dce 100644 --- a/.gitignore +++ b/.gitignore @@ -23,15 +23,17 @@ graph-generators/node_modules/ lambda-policy.json node_modules/ parcel-debug-* +proxy-request-times.json puppeteer_lambda_layer.tar.gz +reports/test-reporter.xml shared/coverage shared/pdf-tests/*.html web-api/runtimes/clamav/bin web-api/runtimes/clamav/clamav_lambda_layer.tar.gz web-api/runtimes/clamav/lib web-api/storage/s3/* -web-api/terraform/template/cognito-triggers/index.js.zip web-api/terraform/template/cognito-authorizer/index.js.zip +web-api/terraform/template/cognito-triggers/index.js.zip web-api/terraform/template/log-forwarder/index.js.zip web-client/.cache/ web-client/coverage-e2e @@ -39,7 +41,5 @@ web-client/coverage-integration/* web-client/coverage-unit/* web-client/pa11y/pa11y-screenshots web-client/reports -web-client/tests_output/ web-client/terraform/common/cloudfront-edge/index.js.zip -proxy-request-times.json -reports/test-reporter.xml +web-client/tests_output/ diff --git a/.prettierignore b/.prettierignore index 9507e4cdb53..dd9f420d19b 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1,3 +1,3 @@ package.json *.md -*_.js \ No newline at end of file +*_.js diff --git a/Dockerfile b/Dockerfile index 323d71bcc87..45a75989b3c 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,6 +1,4 @@ -FROM cypress/base:12.16.0 - -RUN echo "recache again" +FROM cypress/base:12.16.2 WORKDIR /home/app @@ -46,6 +44,7 @@ ENV JAVA_HOME=/usr/lib/jvm/java-11-openjdk-amd64 COPY package.json /home/app/package.json COPY package-lock.json /home/app/package-lock.json RUN npm set progress=false && \ + npm config set puppeteer_skip_chromium_download true && \ npm i COPY . /home/app diff --git a/README.md b/README.md index 77417646dcc..f04101fd461 100644 --- a/README.md +++ b/README.md @@ -50,11 +50,6 @@ For documentation about the CI/CD setup, API, style guide, UX, code review, etc. -## Dependency diagrams - -- Client -- Server - ## Backlog The backlog is stored [in GitHub Issues in Flexion’s repository](https://github.com/flexion/ef-cms/issues), _not_ on this repository. Although they can be viewed like any other GitHub issues, they are managed on a scrum board that requires the [ZenHub browser plugin](https://www.zenhub.com/) to see. diff --git a/config/dev.yml b/config/dev.yml index 5a410629412..ef4833446e0 100644 --- a/config/dev.yml +++ b/config/dev.yml @@ -1 +1 @@ -nodeEnv: production \ No newline at end of file +nodeEnv: production diff --git a/config/exp.yml b/config/exp1.yml similarity index 100% rename from config/exp.yml rename to config/exp1.yml diff --git a/config/prod.yml b/config/prod.yml index 5a410629412..ef4833446e0 100644 --- a/config/prod.yml +++ b/config/prod.yml @@ -1 +1 @@ -nodeEnv: production \ No newline at end of file +nodeEnv: production diff --git a/config/stg.yml b/config/stg.yml index 5a410629412..ef4833446e0 100644 --- a/config/stg.yml +++ b/config/stg.yml @@ -1 +1 @@ -nodeEnv: production \ No newline at end of file +nodeEnv: production diff --git a/cypress-public.json b/cypress-public.json new file mode 100644 index 00000000000..2135ee0f410 --- /dev/null +++ b/cypress-public.json @@ -0,0 +1,11 @@ +{ + "baseUrl": "http://localhost:5678", + "reporter": "spec", + "reporterOptions": { + "toConsole": true + }, + "defaultCommandTimeout": 20000, + "requestTimeout": 12000, + "viewportWidth": 1200, + "viewportHeight": 900 +} diff --git a/cypress/integration/assign-a-work-item-to-self.spec.js b/cypress/integration/assign-a-work-item-to-self.spec.js index c62ade3d0c5..669a10e75cd 100644 --- a/cypress/integration/assign-a-work-item-to-self.spec.js +++ b/cypress/integration/assign-a-work-item-to-self.spec.js @@ -1,19 +1,12 @@ const { getWorkItemCheckboxLabel, - getWorkItemMessage, - getWorkItemMessages, getWorkItemRow, navigateTo: navigateToDashboard, selectAssignee, - viewDocumentQCMyInbox, viewDocumentQCSectionInbox, } = require('../support/pages/dashboard'); describe('Assign a work item ', () => { - before(() => { - cy.task('seed'); - }); - it('views the section inbox', () => { navigateToDashboard('petitionsclerk'); viewDocumentQCSectionInbox(); @@ -29,18 +22,5 @@ describe('Assign a work item ', () => { getWorkItemRow('101-19W') .contains('td.to', 'Test Petitionsclerk') .should('exist'); - - getWorkItemRow('101-19W').contains('a', 'Petition').click(); - getWorkItemMessages(); - - getWorkItemMessage('2611344f-f7bf-4f47-8ba0-60c70cb25446').contains( - 'Petition filed by Brett Osborne is ready for review.', - ); - }); - - it('places the work item in the petitionsclerk my inbox', () => { - navigateToDashboard('petitionsclerk'); - viewDocumentQCMyInbox(); - getWorkItemRow('101-19W').should('exist'); }); }); diff --git a/cypress/integration/create-a-work-item.spec.js b/cypress/integration/create-a-work-item.spec.js index 08d9006a80a..26908e4e702 100644 --- a/cypress/integration/create-a-work-item.spec.js +++ b/cypress/integration/create-a-work-item.spec.js @@ -22,7 +22,6 @@ const { describe('Create a work item ', () => { before(() => { - cy.task('seed'); navigateToDocumentDetail( 'petitionsclerk', '104-19', diff --git a/cypress/integration/edit-case-caption-via-case-detail-header.spec.js b/cypress/integration/edit-case-caption-via-case-detail-header.spec.js index 61a5973159a..fd364b3962e 100644 --- a/cypress/integration/edit-case-caption-via-case-detail-header.spec.js +++ b/cypress/integration/edit-case-caption-via-case-detail-header.spec.js @@ -9,7 +9,6 @@ const { describe('Edit a case caption from case detail header', function () { before(() => { - cy.task('seed'); navigateToCaseDetail('docketclerk', '101-19'); getActionMenuButton().click(); getEditCaseCaptionButton().click(); diff --git a/cypress/integration/edit-case-caption-via-petition-qc.spec.js b/cypress/integration/edit-case-caption-via-petition-qc.spec.js index 404c4fca60e..32b7a511c70 100644 --- a/cypress/integration/edit-case-caption-via-petition-qc.spec.js +++ b/cypress/integration/edit-case-caption-via-petition-qc.spec.js @@ -10,7 +10,6 @@ const { describe('change the case caption via the petition qc page', () => { before(() => { - cy.task('seed'); navigateToPetitionQc( 'petitionsclerk', '101-19', diff --git a/cypress/integration/file-a-petition.spec.js b/cypress/integration/file-a-petition.spec.js index 1bae8f66c16..9fdb34a961f 100644 --- a/cypress/integration/file-a-petition.spec.js +++ b/cypress/integration/file-a-petition.spec.js @@ -3,7 +3,6 @@ let createdDocketNumber; describe('File a petition', function () { before(() => { - cy.task('seed'); cy.login('petitioner'); }); @@ -165,12 +164,22 @@ describe('creation form', () => { cy.get('button#submit-case').click(); }); + it('click the regular radio button', () => { + cy.get('#procedure-type-radios').scrollIntoView(); + cy.get('#procedure-type-radios label').eq(1).click(); + }); + + it('select a city', () => { + cy.get('#preferred-trial-city').scrollIntoView().select('Mobile, Alabama'); + }); + it('click the small radio button', () => { cy.get('#procedure-type-radios').scrollIntoView(); - cy.get('#procedure-type-radios label').first().click(); + cy.get('#procedure-type-radios label').eq(0).click(); }); it('select a city', () => { + cy.get('#preferred-trial-city').should('have.value', ''); cy.get('#preferred-trial-city').scrollIntoView().select('Mobile, Alabama'); }); @@ -179,15 +188,20 @@ describe('creation form', () => { }); it('submits forms and redirects to the file petition success page', () => { + cy.get('button#submit-case').scrollIntoView().click(); + cy.server(); cy.route('POST', '**/cases').as('postCase'); - cy.get('button#submit-case').scrollIntoView().click(); cy.wait('@postCase'); cy.get('@postCase').should(xhr => { // eslint-disable-next-line jest/valid-expect expect(xhr.responseBody).to.have.property('docketNumber'); createdDocketNumber = xhr.responseBody.docketNumber; }); + + // wait for elasticsearch to refresh + cy.wait(1000); + cy.url().should('include', 'file-a-petition/success'); cy.get('a#button-back-to-dashboard').click(); }); @@ -209,4 +223,8 @@ describe('can view case detail', () => { it('shows docket record table and data', () => { cy.get('table.case-detail.docket-record tbody tr').should('exist'); }); + + it('displays page count of the petition document', () => { + cy.get('td.number-of-pages').should('contain.text', '2'); + }); }); diff --git a/cypress/integration/file-an-answer.spec.js b/cypress/integration/file-an-answer.spec.js index 6e5680eebc0..d1e88b75a6a 100644 --- a/cypress/integration/file-an-answer.spec.js +++ b/cypress/integration/file-an-answer.spec.js @@ -4,7 +4,6 @@ const { describe('Filing an Answer', function () { before(() => { - cy.task('seed'); cy.login('irsPractitioner', '/case-detail/102-19'); }); @@ -43,6 +42,9 @@ describe('Filing an Answer', function () { }); it('reflects changes to 102-19 by showing it in irsPractitioner case list', () => { + // wait for elasticsearch to refresh + cy.wait(1000); + navigateToDashboard('irsPractitioner'); cy.get('table#case-list').find('a').should('contain', '102-19'); }); diff --git a/cypress/integration/petitions-clerk-creates-a-case.spec.js b/cypress/integration/petitions-clerk-creates-a-case.spec.js index 7e2e8f43b39..f4fb8bb1bb1 100644 --- a/cypress/integration/petitions-clerk-creates-a-case.spec.js +++ b/cypress/integration/petitions-clerk-creates-a-case.spec.js @@ -9,8 +9,6 @@ const { describe('Create case and submit to IRS', function () { before(() => { - cy.task('seed'); - navigateToDocumentQC('petitionsclerk'); getCreateACaseButton().click(); @@ -29,4 +27,9 @@ describe('Create case and submit to IRS', function () { expect(xhr.responseBody).to.have.property('docketNumber'); }); }); + + it('should display a confirmation modal when the user clicks cancel on the review page', () => { + cy.get('button#cancel-create-case').scrollIntoView().click(); + cy.get('div.modal-header').should('exist'); + }); }); diff --git a/cypress/integration/public/advanced-search.spec.js b/cypress/integration/public/advanced-search.spec.js new file mode 100644 index 00000000000..13729024487 --- /dev/null +++ b/cypress/integration/public/advanced-search.spec.js @@ -0,0 +1,49 @@ +const { + clickOnSearchTab, + docketRecordTable, + enterDocumentDocketNumber, + enterDocumentKeywordForOpinionSearch, + enterPetitionerName, + navigateTo: navigateToDashboard, + noSearchResultsContainer, + searchForCaseByDocketNumber, + searchForCaseByPetitionerInformation, + searchForDocuments, + searchResultsTable, +} = require('../../support/pages/public/advanced-search'); + +describe('Advanced search', () => { + describe('case - by name', () => { + it('should route to case detail when a match is found and the user clicks on the docket record link in the table', () => { + navigateToDashboard(); + enterPetitionerName('Osborne'); + searchForCaseByPetitionerInformation(); + expect(searchResultsTable()).to.exist; + }); + }); + + describe('case - by docket number', () => { + it('should display "No Matches Found" when case search yields no results', () => { + navigateToDashboard(); + searchForCaseByDocketNumber('999-99'); + expect(noSearchResultsContainer()).to.exist; + }); + + it('should route to case detail when a case search match is found', () => { + navigateToDashboard(); + searchForCaseByDocketNumber('103-20'); + expect(docketRecordTable()).to.exist; + }); + }); + + describe('opinion', () => { + it('should display results when a keyword and docketNumberWithSuffix is provided', () => { + navigateToDashboard(); + clickOnSearchTab('opinion'); + enterDocumentKeywordForOpinionSearch('opinion'); + enterDocumentDocketNumber('105-20L'); + searchForDocuments(); + expect(searchResultsTable()).to.exist; + }); + }); +}); diff --git a/cypress/integration/start-a-case-practitioner.spec.js b/cypress/integration/start-a-case-practitioner.spec.js index 05118b94d93..418ee965b87 100644 --- a/cypress/integration/start-a-case-practitioner.spec.js +++ b/cypress/integration/start-a-case-practitioner.spec.js @@ -7,10 +7,6 @@ const { const { fillInAndSubmitForm } = require('../support/pages/start-a-case'); describe('Start a case as a practitioner ', () => { - before(() => { - cy.task('seed'); - }); - it('go to the practitioner dashboard and expect that a case list table is displayed with 3 cases', () => { navigateToDashboard('privatePractitioner'); getCaseList().should('have.length', 3); diff --git a/cypress/support/pages/dashboard.js b/cypress/support/pages/dashboard.js index 137a4aa5b18..ff330147760 100644 --- a/cypress/support/pages/dashboard.js +++ b/cypress/support/pages/dashboard.js @@ -19,12 +19,6 @@ exports.viewSectionOutbox = () => { cy.get('button#section-sent-tab').click(); }; -exports.viewDocumentQCMyInbox = () => { - cy.visit('/document-qc/my/inbox'); - // eslint-disable-next-line cypress/no-unnecessary-waiting - cy.wait(1000); -}; - exports.viewDocumentQCSectionInbox = () => { cy.visit('/document-qc/section/inbox'); }; @@ -60,11 +54,3 @@ exports.getWorkItemRow = docketNumber => { exports.getSendButton = () => { return cy.contains('button', 'Send'); }; - -exports.getWorkItemMessages = () => { - return cy.get('#tab-pending-messages').click(); -}; - -exports.getWorkItemMessage = workItemId => { - return cy.get(`div.workitem-${workItemId}`); -}; diff --git a/cypress/support/pages/public/advanced-search.js b/cypress/support/pages/public/advanced-search.js new file mode 100644 index 00000000000..2044ee71e2f --- /dev/null +++ b/cypress/support/pages/public/advanced-search.js @@ -0,0 +1,44 @@ +exports.navigateTo = () => { + cy.visit('/'); +}; + +exports.clickOnSearchTab = tabName => { + cy.get(`button#tab-${tabName}`).click(); +}; + +exports.searchForCaseByDocketNumber = docketNumber => { + cy.get('input#docket-number').type(docketNumber); + cy.get('button#docket-search-button').click(); +}; + +exports.enterPetitionerName = name => { + cy.get('input#petitioner-name').type(name); +}; + +exports.enterDocumentKeywordForOpinionSearch = keyword => { + cy.get('input#opinion-search').type(keyword); +}; + +exports.enterDocumentDocketNumber = docketNumber => { + cy.get('input#docket-number').type(docketNumber); +}; + +exports.searchForCaseByPetitionerInformation = () => { + cy.get('button#advanced-search-button').click(); +}; + +exports.searchForDocuments = () => { + cy.get('button#advanced-search-button').click(); +}; + +exports.noSearchResultsContainer = () => { + return cy.get('div#no-search-results'); +}; + +exports.searchResultsTable = () => { + return cy.get('table.search-results'); +}; + +exports.docketRecordTable = () => { + return cy.get('table.docket-record'); +}; diff --git a/cypress/support/pages/start-a-case.js b/cypress/support/pages/start-a-case.js index f5ac8068bc0..1e75e5aa023 100644 --- a/cypress/support/pages/start-a-case.js +++ b/cypress/support/pages/start-a-case.js @@ -37,6 +37,9 @@ exports.fillInAndSubmitForm = () => { // step 5 cy.get('button#submit-case').scrollIntoView().click(); + // wait for elasticsearch to refresh + cy.wait(3000); + // success page cy.url().should('include', 'file-a-petition/success'); cy.get('a#button-back-to-dashboard').click(); diff --git a/docs/CHECKLISTS.md b/docs/CHECKLISTS.md index afa552d5d4f..d915db3d2a2 100644 --- a/docs/CHECKLISTS.md +++ b/docs/CHECKLISTS.md @@ -18,9 +18,8 @@ All of our endpoints are split into multiple AWS CloudFormation stacks and hoste - [ ] create a new `*Handlers.js` file, your functions for your new `serverless-*.yml` must point to this handlers - [ ] create a new `serverless-*.yml` file in the `./web-api` directory (copy an existing one and modify as needed) - [ ] change the service name to something unique - - [ ] change the `customDomain.basePath` to be something unique - - [ ] change `serverless-offline.port` to be a new unique port - [ ] update the `package.include` to use the new handlers file you cretaed + - [ ] add a section to `web-api/config/custom.yml` for the new stack with a unique port and basePath - [ ] update `./web-api/proxy.js` to include your new path and map it to your new port - [ ] create a new `./web-api/run-serverless*.sh` script (chmod 755 or copy an existing script) and modify it to use the new `*Handlers.js` file - [ ] update `./web-api/run-local.sh` to include your new serverless service diff --git a/docs/ENVIRONMENT_DESTRUCTION.md b/docs/ENVIRONMENT_DESTRUCTION.md deleted file mode 100644 index 94b5dcfb9c8..00000000000 --- a/docs/ENVIRONMENT_DESTRUCTION.md +++ /dev/null @@ -1,49 +0,0 @@ -# Environment Destruction - -Follow these instructions to destroy an environment that was previously created and deployed: - -1. In AWS’s [API Gateway console](https://console.aws.amazon.com/apigateway/home?region=us-east-1#/), delete the custom domain for `efcms-[ENV].ustc-case-mgmt.example.gov` and `efcms-[ENV]-ws.ustc-case-mgmt.example.gov` in both us-east-1 and us-west-1 (replacing `example.gov` with your actual domain name). - -2. In AWS’s [CloudFormation console](https://console.aws.amazon.com/cloudformation/), delete all the CloudFormation stacks in both us-east-1 and us-west-1 (both blue and green). The stacks will match the following pattern: `ef-cms-*-[ENV]` (e.g. `env-cms-*-prod`). Simply enter the environment name in the search bar to find all of them. - -3. In AWS’s [DynamoDB console](https://console.aws.amazon.com/dynamodb/), delete the tables for the environment in both us-east-1 and us-west-1. There should be two tables in us-east-1 and one table in us-west-1. - -4. In AWS’s [Cognito console](https://console.aws.amazon.com/cognito/), delete the domain for `efcms-[ENV]`, followed by the Cognito user pool for the environment in us-east-1. - -5. In AWS’s [S3 console](https://console.aws.amazon.com/s3/), empty all of the buckets for the environment. Enter `[ENV]` in the search bar to find all buckets associated with your environment. There should be a total of 10 buckets to empty. - -6. In AWS’s [CloudFront console](https://console.aws.amazon.com/cloudfront/), search for the distributions for the environment by entering `[ENV]` in the search bar. There should be one for ui and one for ui-public. For each one of those, click on it, go to the "Behaviors" tab, and edit the behavior. At the bottom of the Edit page, there is a Lambda Function Associations section. Click the `X` to delete that association. - -7. If not already installed and configured, install the AWS CLI on your local system and configure it to use your IAM credentials. Then destroy web-client: `cd web-client/terraform/main && ../bin/environment-destroy.sh [ENV]`. An expected error will occur: - -``` -* module.environment.aws_lambda_function.header_security_lambda (destroy): 1 error(s) occurred: - -* aws_lambda_function.header_security_lambda: Error deleting Lambda Function: InvalidParameterValueException: Lambda was unable to delete arn:aws:lambda:us-east-1:515554424717:function:header_security_lambda_exp:53 because it is a replicated function. Please see our documentation for Deleting Lambda@Edge Functions and Replicas. -{ - Message_: "Lambda was unable to delete arn:aws:lambda:us-east-1:515554424717:function:header_security_lambda_exp:53 because it is a replicated function. Please see our documentation for Deleting Lambda@Edge Functions and Replicas." -} -``` - -This Lambda function's replicas may take several hours to remove. It can be deleted from the AWS console after waiting a few hours for replication deletion. - -8. Destroy web-api: `cd web-api/terraform/main && ../bin/environment-destroy.sh [ENV]`. - -If you get an error like this, you may have to contact AWS and have them remove the associations with the certificate: - -``` -* aws_acm_certificate.ws-us-west-1: Error deleting certificate: ResourceInUseException: Certificate arn:aws:acm:us-west-1:515554424717:certificate/9d6bbec6-c7fc-4277-87a5-fb63f2589f21 in account 515554424717 is in use. -``` - -If you run into this issue then you'll need to run `terraform state rm aws_cognito_user_pool_domain.main`: - -``` -Error: Error applying plan: - -1 error(s) occurred: - -* module.ef-cms_apis.aws_cognito_user_pool_domain.main (destroy): 1 error(s) occurred: - -* aws_cognito_user_pool_domain.main: InvalidParameter: 1 validation error(s) found. -- minimum field size of 1, DeleteUserPoolDomainInput.UserPoolId. -``` diff --git a/docs/TROUBLESHOOTING.md b/docs/TROUBLESHOOTING.md index 3e787a5fed1..ed47c6915e2 100644 --- a/docs/TROUBLESHOOTING.md +++ b/docs/TROUBLESHOOTING.md @@ -116,3 +116,12 @@ To revert your `serverless-prune-plugin`, just change `before` back to `after` o This error often occurs when we are indexing too many dynamic keys or nested objects with Elasticsearch and reach our total field limit. The script will output data related to the mapping for the environment and can help pinpoint areas to look into further. To filter data from indexing, add fields or keys to the filtering functions in `processStreamRecordsInteractor.js`. + + +### NotFoundException when calling the GetDomainName + +This error occurs when code changes do not cause the checksums of the files to change. In order to redeploy, the file must have a different checksum than what is recorded in the database. + +#### Solution + +Delete checksums from the environment dynamo table that is failing. For example, if the dev deploy is failing, navigate to the efcms-deploy-dev table in AWS and delete all the check-sum-** items. \ No newline at end of file diff --git a/docs/entities/Batch.md b/docs/entities/Batch.md new file mode 100644 index 00000000000..6b2b5775e78 --- /dev/null +++ b/docs/entities/Batch.md @@ -0,0 +1,45 @@ +# Batch + ``` +--- + type: "object" + keys: + batchId: + type: "string" + flags: + presence: "required" + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + batchIndex: + type: "number" + flags: + presence: "required" + rules: + - + name: "integer" + - + name: "min" + args: + limit: 0 + createdAt: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "required" + pages: + type: "array" + flags: + presence: "required" + rules: + - + name: "min" + args: + limit: 1 + + ``` diff --git a/docs/entities/Case.md b/docs/entities/Case.md index bcf6720ed68..9d83f7e37ef 100644 --- a/docs/entities/Case.md +++ b/docs/entities/Case.md @@ -1,835 +1,1090 @@ # Case - -### associatedJudge - - -Judge assigned to this case. Defaults to Chief Judge. - - -Restricted - -> `string` | optional - -##### Maximum limit - - -`50` - -### automaticBlocked - - -Temporarily blocked from trial due to a pending item or due date. - -> `boolean` | optional - -### automaticBlockedDate - -> `any` - - -If `automaticBlocked` = `true`, then this field is `date` and is `required.` - - -Otherwise, this field is `any` and is `optional`. `null` is allowed. - -### automaticBlockedReason - -> `any` - - -If `automaticBlocked` = `true`, then this field is `string` and is `required.` - - -Otherwise, this field is `any` and is `optional`. `null` is allowed. - -### blocked - - -Temporarily blocked from trial. - - -Restricted - -> `boolean` | optional - -### blockedDate - - -Restricted - -> `any` - - -If `blocked` = `true`, then this field is `date` and is `required.` - - -Otherwise, this field is `any` and is `optional`. `null` is allowed. - -### blockedReason - - -Restricted - -> `any` - - -If `blocked` = `true`, then this field is `string` and is `required.` - - -Otherwise, this field is `any` and is `optional`. `null` is allowed. - -### caseCaption - - -The name of the party bringing the case, e.g. "Carol Williams, Petitioner," "Mark Taylor, Incompetent, Debra Thomas, Next Friend, Petitioner," or "Estate of Test Taxpayer, Deceased, Petitioner." This is the first half of the case title. - -> `string` | required - -##### Maximum limit - - -`500` - -### caseId - - -Unique case ID only used by the system. - -> `string` | required - -### caseNote - - -Restricted - -> `string` | optional - -##### Maximum limit - - -`500` - -### caseType - -> `string` | required - -##### Allowed Values - - - - `CDP (Lien/Levy)` - - `Deficiency` - - `Declaratory Judgment (Exempt Organization)` - - `Declaratory Judgment (Retirement Plan)` - - `Innocent Spouse` - - `Interest Abatement` - - `Other` - - `Partnership (BBA Section 1101)` - - `Partnership (Section 6226)` - - `Partnership (Section 6228)` - - `Passport` - - `Whistleblower` - - `Worker Classification` - -### contactPrimary - -> `object` | required - -### contactSecondary - -> `object` | optional - -##### Can be null. - -### createdAt - - -When the paper or electronic case was added to the system. This value cannot be edited. - -> `date` | required - -### docketNumber - - -Unique case ID in XXXXX-YY format. - -> `string` | required - -##### Regex Pattern - - -`/^(\d{3,5}-\d{2})$/` - -### docketNumberSuffix - -> `string` | optional - -##### Allowed Values - - - - `null` - - `W` - - `P` - - `X` - - `R` - - `SL` - - `L` - - `S` - -### docketRecord - - -List of DocketRecord Entities for the case. - -> `array` | required - - -An array of [`DocketRecord`](./DocketRecord.md)s - -#### Rules - -### documents - - -List of Document Entities for the case. - -> `array` | required - - -An array of [`Document`](./Document.md)s - -### entityName - -> `string` | required - -##### Can be Case. - -### filingType - -> `string` | optional - -##### Allowed Values - - - - `Myself` - - `Myself and my spouse` - - `A business` - - `Other` - - `Individual petitioner` - - `Petitioner and spouse` - -### hasVerifiedIrsNotice - - -Whether the petitioner received an IRS notice, verified by the petitions clerk. - -> `boolean` | optional - -##### Can be null. - -### highPriority - - -Restricted - -> `boolean` | optional - -### highPriorityReason - - -Restricted - -> `any` - - -If `highPriority` = `true`, then this field is `string` and is `required.` - - -Otherwise, this field is `any` and is `optional`. `null` is allowed. - -### initialCaption - - -Case caption before modification. - -> `string` | optional - -##### Maximum limit - - -`500` - -##### Can be null. - -### initialDocketNumberSuffix - - -Case docket number suffix before modification. - -> `string` | optional - -##### Maximum limit - - -`2` - -##### Can be null. - -### irsNoticeDate - - -Last date that the petitioner is allowed to file before. - -> `date` | optional - -##### Maximum date - - -`now` - -##### Can be null. - -### irsPractitioners - - -List of IRS practitioners (also known as respondents) associated with the case. - -> `array` | optional - -### isPaper - -> `boolean` | optional - -### leadCaseId - - -If this case is consolidated, this is the ID of the lead case. It is the lowest docket number in the consolidated group. - -> `string` | optional - -### mailingDate - - -Date that petition was mailed to the court. - -> `any` - - -If `isPaper` = `true`, then this field is `string` and is `required.` - - -Otherwise, this field is `string` and is `optional`. `null` is allowed. - -### noticeOfAttachments - - -Reminder for clerks to review the notice of attachments. - -> `boolean` | optional - -### noticeOfTrialDate - - -Reminder for clerks to review the notice of trial date. - -> `date` | optional - -### orderDesignatingPlaceOfTrial - - -Reminder for clerks to review the Order Designating Place of Trial. - -> `boolean` | optional - -### orderForAmendedPetition - - -Reminder for clerks to review the order for amended Petition. - -> `boolean` | optional - -### orderForAmendedPetitionAndFilingFee - - -Reminder for clerks to review the order for amended Petition And filing fee. - -> `boolean` | optional - -### orderForFilingFee - - -Reminder for clerks to review the order for filing fee. - -> `boolean` | optional - -### orderForOds - - -Reminder for clerks to review the order for ODS. - -> `boolean` | optional - -### orderForRatification - - -Reminder for clerks to review the Order for Ratification. - -> `boolean` | optional - -### orderToChangeDesignatedPlaceOfTrial - - -Reminder for clerks to review the Order to Change Designated Place Of Trial. - -> `boolean` | optional - -### orderToShowCause - - -Reminder for clerks to review the Order to Show Cause. - -> `boolean` | optional - -### partyType - - -Party type of the case petitioner. - -> `string` | required - -##### Allowed Values - - - - `Conservator` - - `Corporation` - - `Custodian` - - `Donor` - - `Estate with an executor/personal representative/fiduciary/etc.` - - `Estate without an executor/personal representative/fiduciary/etc.` - - `Guardian` - - `Next friend for a legally incompetent person (without a guardian, conservator, or other like fiduciary)` - - `Next friend for a minor (without a guardian, conservator, or other like fiduciary)` - - `Partnership (as the Tax Matters Partner)` - - `Partnership (as a partnership representative under the BBA regime)` - - `Partnership (as a partner other than Tax Matters Partner)` - - `Petitioner` - - `Petitioner & deceased spouse` - - `Petitioner & spouse` - - `Surviving spouse` - - `Transferee` - - `Trust` - -### petitionPaymentStatus - - -Status of the case fee payment. - -> `string` | required - -##### Allowed Values - - - - `Paid` - - `Not Paid` - - `Waived` - -### petitionPaymentDate - - -When the petitioner paid the case fee. - -> `any` - - -If `petitionPaymentStatus` = `Paid`, then this field is `date` and is `required.` - - -Otherwise, this field is `date` and is `optional`. `null` is allowed. - -### petitionPaymentMethod - - -How the petitioner paid the case fee. - -> `any` - - -If `petitionPaymentStatus` = `Paid`, then this field is `string` and is `required.` - - -Otherwise, this field is `string` and is `optional`. `null` is allowed. - -### petitionPaymentWaivedDate - - -When the case fee was waived. - -> `any` - - -If `petitionPaymentStatus` = `Waived`, then this field is `date` and is `required.` - - -Otherwise, this field is `date` and is `optional`. `null` is allowed. - -### preferredTrialCity - - -Where the petitioner would prefer to hold the case trial. - -> `conditional` | optional - - -*Must match 1 of the following conditions:* - -#### Condition #1 for `preferredTrialCity`: - -> `string` - -##### Allowed Values - - - - `Fresno, California` - - `Tallahassee, Florida` - - `Pocatello, Idaho` - - `Peoria, Illinois` - - `Wichita, Kansas` - - `Shreveport, Louisiana` - - `Portland, Maine` - - `Billings, Montana` - - `Albany, New York` - - `Syracuse, New York` - - `Bismarck, North Dakota` - - `Aberdeen, South Dakota` - - `Burlington, Vermont` - - `Roanoke, Virginia` - - `Cheyenne, Wyoming` - - `Birmingham, Alabama` - - `Mobile, Alabama` - - `Anchorage, Alaska` - - `Phoenix, Arizona` - - `Little Rock, Arkansas` - - `Los Angeles, California` - - `San Diego, California` - - `San Francisco, California` - - `Denver, Colorado` - - `Hartford, Connecticut` - - `Washington, District of Columbia` - - `Jacksonville, Florida` - - `Miami, Florida` - - `Tampa, Florida` - - `Atlanta, Georgia` - - `Honolulu, Hawaii` - - `Boise, Idaho` - - `Chicago, Illinois` - - `Indianapolis, Indiana` - - `Des Moines, Iowa` - - `Louisville, Kentucky` - - `New Orleans, Louisiana` - - `Baltimore, Maryland` - - `Boston, Massachusetts` - - `Detroit, Michigan` - - `St. Paul, Minnesota` - - `Jackson, Mississippi` - - `Kansas City, Missouri` - - `St. Louis, Missouri` - - `Helena, Montana` - - `Omaha, Nebraska` - - `Las Vegas, Nevada` - - `Reno, Nevada` - - `Albuquerque, New Mexico` - - `Buffalo, New York` - - `New York City, New York` - - `Winston-Salem, North Carolina` - - `Cincinnati, Ohio` - - `Cleveland, Ohio` - - `Columbus, Ohio` - - `Oklahoma City, Oklahoma` - - `Portland, Oregon` - - `Philadelphia, Pennsylvania` - - `Pittsburgh, Pennsylvania` - - `Columbia, South Carolina` - - `Knoxville, Tennessee` - - `Memphis, Tennessee` - - `Nashville, Tennessee` - - `Dallas, Texas` - - `El Paso, Texas` - - `Houston, Texas` - - `Lubbock, Texas` - - `San Antonio, Texas` - - `Salt Lake City, Utah` - - `Richmond, Virginia` - - `Seattle, Washington` - - `Spokane, Washington` - - `Charleston, West Virginia` - - `Milwaukee, Wisconsin` - - `null` - -#### Condition #2 for `preferredTrialCity`: - -> `string` - -##### Regex Pattern - - -`/^[a-zA-Z ]+, [a-zA-Z ]+, [0-9]+$/` - -### privatePractitioners - - -List of private practitioners associated with the case. - -> `array` | optional - -### procedureType - - -Procedure type of the case. - -> `string` | required - -##### Allowed Values - - - - `Regular` - - `Small` - -### qcCompleteForTrial - - -QC Checklist object that must be completed before the case can go to trial. - - -Restricted - -> `object` | optional - -### receivedAt - - -When the case was received by the court. If electronic, this value will be the same as createdAt. If paper, this value can be edited. - -> `date` | required - -### sealedDate - - -When the case was sealed from the public. - -> `date` | optional - -##### Can be null. - -### sortableDocketNumber - - -A sortable representation of the docket number (auto-generated by constructor). - -> `number` | required - -### statistics - - -List of Statistic Entities for the case. - -> `array` | optional - - -An array of [`Statistic`](./Statistic.md)s - -### status - - -Status of the case. - - -Restricted - -> `string` | optional - -##### Allowed Values - - - - `Assigned - Case` - - `Assigned - Motion` - - `Calendared` - - `CAV` - - `Closed` - - `General Docket - Not at Issue` - - `General Docket - At Issue (Ready for Trial)` - - `Jurisdiction Retained` - - `New` - - `On Appeal` - - `Rule 155` - - `Submitted` - -### closedDate - -> `any` - - -If `status` = `Closed`, then this field is `date` and is `required.` - - -Otherwise, this field is `any` and is `optional`. `null` is allowed. - -### trialDate - - -When this case goes to trial. - -> `date` | optional - -##### Can be null. - -### trialLocation - - -Where this case goes to trial. This may be different that the preferred trial location. - -> `conditional` | optional - - -*Must match 1 of the following conditions:* - -#### Condition #1 for `trialLocation`: - -> `string` - -##### Allowed Values - - - - `Fresno, California` - - `Tallahassee, Florida` - - `Pocatello, Idaho` - - `Peoria, Illinois` - - `Wichita, Kansas` - - `Shreveport, Louisiana` - - `Portland, Maine` - - `Billings, Montana` - - `Albany, New York` - - `Syracuse, New York` - - `Bismarck, North Dakota` - - `Aberdeen, South Dakota` - - `Burlington, Vermont` - - `Roanoke, Virginia` - - `Cheyenne, Wyoming` - - `Birmingham, Alabama` - - `Mobile, Alabama` - - `Anchorage, Alaska` - - `Phoenix, Arizona` - - `Little Rock, Arkansas` - - `Los Angeles, California` - - `San Diego, California` - - `San Francisco, California` - - `Denver, Colorado` - - `Hartford, Connecticut` - - `Washington, District of Columbia` - - `Jacksonville, Florida` - - `Miami, Florida` - - `Tampa, Florida` - - `Atlanta, Georgia` - - `Honolulu, Hawaii` - - `Boise, Idaho` - - `Chicago, Illinois` - - `Indianapolis, Indiana` - - `Des Moines, Iowa` - - `Louisville, Kentucky` - - `New Orleans, Louisiana` - - `Baltimore, Maryland` - - `Boston, Massachusetts` - - `Detroit, Michigan` - - `St. Paul, Minnesota` - - `Jackson, Mississippi` - - `Kansas City, Missouri` - - `St. Louis, Missouri` - - `Helena, Montana` - - `Omaha, Nebraska` - - `Las Vegas, Nevada` - - `Reno, Nevada` - - `Albuquerque, New Mexico` - - `Buffalo, New York` - - `New York City, New York` - - `Winston-Salem, North Carolina` - - `Cincinnati, Ohio` - - `Cleveland, Ohio` - - `Columbus, Ohio` - - `Oklahoma City, Oklahoma` - - `Portland, Oregon` - - `Philadelphia, Pennsylvania` - - `Pittsburgh, Pennsylvania` - - `Columbia, South Carolina` - - `Knoxville, Tennessee` - - `Memphis, Tennessee` - - `Nashville, Tennessee` - - `Dallas, Texas` - - `El Paso, Texas` - - `Houston, Texas` - - `Lubbock, Texas` - - `San Antonio, Texas` - - `Salt Lake City, Utah` - - `Richmond, Virginia` - - `Seattle, Washington` - - `Spokane, Washington` - - `Charleston, West Virginia` - - `Milwaukee, Wisconsin` - - `null` - -#### Condition #2 for `trialLocation`: - -> `string` - -##### Regex Pattern - - -`/^[a-zA-Z ]+, [a-zA-Z ]+, [0-9]+$/` - -### trialSessionId - - -The unique ID of the trial session associated with this case. - -> `string` | optional - -### trialTime - - -Time of day when this case goes to trial. - -> `string` | optional - -##### Regex Pattern - - -`/^[0-9]{1,2}:([0-5][0-9])$/` - -### useSameAsPrimary - - -Whether to use the same address for the primary and secondary petitioner contact information (used only in data entry and QC process). - -> `boolean` | optional - -### userId - - -The unique ID of the User who added the case to the system. - - -Restricted - -> `string` | optional - -##### Maximum limit - - -`50` - -### workItems - - -List of system messages associated with this case. - - -Restricted - -> `array` | optional + ``` +--- + type: "object" + keys: + associatedJudge: + type: "string" + flags: + presence: "optional" + description: "Judge assigned to this case. Defaults to Chief Judge." + rules: + - + name: "max" + args: + limit: 50 + metas: + - + tags: + - "Restricted" + automaticBlocked: + type: "boolean" + flags: + presence: "optional" + description: "Temporarily blocked from trial due to a pending item or due date." + automaticBlockedDate: + type: "any" + whens: + - + ref: + path: + - "automaticBlocked" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - true + then: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "required" + otherwise: + type: "any" + flags: + presence: "optional" + allow: + - null + automaticBlockedReason: + type: "any" + whens: + - + ref: + path: + - "automaticBlocked" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - true + then: + type: "string" + flags: + only: true + presence: "required" + description: "The reason the case was automatically blocked from trial." + allow: + - "Due Date" + - "Pending Item" + - "Pending Item and Due Date" + otherwise: + type: "any" + flags: + presence: "optional" + allow: + - null + blocked: + type: "boolean" + flags: + presence: "optional" + description: "Temporarily blocked from trial." + metas: + - + tags: + - "Restricted" + blockedDate: + type: "any" + metas: + - + tags: + - "Restricted" + whens: + - + ref: + path: + - "blocked" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - true + then: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "required" + otherwise: + type: "any" + flags: + presence: "optional" + allow: + - null + blockedReason: + type: "any" + metas: + - + tags: + - "Restricted" + whens: + - + ref: + path: + - "blocked" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - true + then: + type: "string" + flags: + presence: "required" + description: "Open text field for describing reason for blocking this case from trial." + rules: + - + name: "max" + args: + limit: 250 + otherwise: + type: "any" + flags: + presence: "optional" + allow: + - null + caseCaption: + type: "string" + flags: + presence: "required" + description: "The name of the party bringing the case, e.g. \"Carol Williams, Petitioner,\" \"Mark Taylor, Incompetent, Debra Thomas, Next Friend, Petitioner,\" or \"Estate of Test Taxpayer, Deceased, Petitioner.\" This is the first half of the case title." + rules: + - + name: "max" + args: + limit: 500 + caseId: + type: "string" + flags: + presence: "required" + description: "Unique case ID only used by the system." + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + caseNote: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 500 + metas: + - + tags: + - "Restricted" + caseType: + type: "string" + flags: + only: true + presence: "required" + allow: + - "CDP (Lien/Levy)" + - "Deficiency" + - "Declaratory Judgment (Exempt Organization)" + - "Declaratory Judgment (Retirement Plan)" + - "Innocent Spouse" + - "Interest Abatement" + - "Other" + - "Partnership (BBA Section 1101)" + - "Partnership (Section 6226)" + - "Partnership (Section 6228)" + - "Passport" + - "Whistleblower" + - "Worker Classification" + contactPrimary: + type: "object" + flags: + presence: "required" + contactSecondary: + type: "object" + flags: + presence: "optional" + allow: + - null + correspondence: + type: "array" + flags: + description: "List of Correspondence documents for the case." + items: + - + type: "object" + metas: + - + entityName: "Correspondence" + createdAt: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "required" + description: "When the paper or electronic case was added to the system. This value cannot be edited." + damages: + type: "number" + flags: + presence: "optional" + description: "Damages for the case." + allow: + - null + docketNumber: + type: "string" + flags: + presence: "required" + description: "Unique case ID in XXXXX-YY format." + rules: + - + name: "pattern" + args: + regex: "/^([1-9]\\d{2,4}-\\d{2})$/" + docketNumberSuffix: + type: "string" + flags: + only: true + presence: "optional" + allow: + - null + - "W" + - "P" + - "X" + - "R" + - "SL" + - "L" + - "S" + docketNumberWithSuffix: + type: "string" + flags: + presence: "optional" + description: "Auto-generated from docket number and the suffix." + docketRecord: + type: "array" + flags: + presence: "required" + description: "List of DocketRecord Entities for the case." + rules: + - + name: "unique" + args: + comparator: [object Function] + items: + - + type: "object" + metas: + - + entityName: "DocketRecord" + documents: + type: "array" + flags: + presence: "required" + description: "List of Document Entities for the case." + items: + - + type: "object" + metas: + - + entityName: "Document" + entityName: + type: "string" + flags: + only: true + presence: "required" + allow: + - "Case" + filingType: + type: "string" + flags: + only: true + presence: "optional" + allow: + - "Myself" + - "Myself and my spouse" + - "A business" + - "Other" + - "Individual petitioner" + - "Petitioner and spouse" + hasVerifiedIrsNotice: + type: "boolean" + flags: + presence: "optional" + description: "Whether the petitioner received an IRS notice, verified by the petitions clerk." + allow: + - null + highPriority: + type: "boolean" + flags: + presence: "optional" + metas: + - + tags: + - "Restricted" + highPriorityReason: + type: "any" + metas: + - + tags: + - "Restricted" + whens: + - + ref: + path: + - "highPriority" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - true + then: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 250 + otherwise: + type: "any" + flags: + presence: "optional" + allow: + - null + initialCaption: + type: "string" + flags: + presence: "optional" + description: "Case caption before modification." + rules: + - + name: "max" + args: + limit: 500 + allow: + - null + initialDocketNumberSuffix: + type: "string" + flags: + presence: "optional" + description: "Case docket number suffix before modification." + rules: + - + name: "max" + args: + limit: 2 + allow: + - null + irsNoticeDate: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "optional" + description: "Last date that the petitioner is allowed to file before." + rules: + - + name: "max" + args: + date: "now" + allow: + - null + irsPractitioners: + type: "array" + flags: + presence: "optional" + description: "List of IRS practitioners (also known as respondents) associated with the case." + isPaper: + type: "boolean" + flags: + presence: "optional" + leadCaseId: + type: "string" + flags: + presence: "optional" + description: "If this case is consolidated, this is the ID of the lead case. It is the lowest docket number in the consolidated group." + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + litigationCosts: + type: "number" + flags: + presence: "optional" + description: "Litigation costs for the case." + allow: + - null + mailingDate: + type: "any" + flags: + description: "Date that petition was mailed to the court." + whens: + - + ref: + path: + - "isPaper" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - true + then: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 25 + otherwise: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 25 + allow: + - null + noticeOfAttachments: + type: "boolean" + flags: + presence: "optional" + description: "Reminder for clerks to review the notice of attachments." + noticeOfTrialDate: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "optional" + description: "Reminder for clerks to review the notice of trial date." + orderDesignatingPlaceOfTrial: + type: "boolean" + flags: + presence: "optional" + description: "Reminder for clerks to review the Order Designating Place of Trial." + orderForAmendedPetition: + type: "boolean" + flags: + presence: "optional" + description: "Reminder for clerks to review the order for amended Petition." + orderForAmendedPetitionAndFilingFee: + type: "boolean" + flags: + presence: "optional" + description: "Reminder for clerks to review the order for amended Petition And filing fee." + orderForFilingFee: + type: "boolean" + flags: + presence: "optional" + description: "Reminder for clerks to review the order for filing fee." + orderForOds: + type: "boolean" + flags: + presence: "optional" + description: "Reminder for clerks to review the order for ODS." + orderForRatification: + type: "boolean" + flags: + presence: "optional" + description: "Reminder for clerks to review the Order for Ratification." + orderToChangeDesignatedPlaceOfTrial: + type: "boolean" + flags: + presence: "optional" + description: "Reminder for clerks to review the Order to Change Designated Place Of Trial." + orderToShowCause: + type: "boolean" + flags: + presence: "optional" + description: "Reminder for clerks to review the Order to Show Cause." + partyType: + type: "string" + flags: + only: true + presence: "required" + description: "Party type of the case petitioner." + allow: + - "Conservator" + - "Corporation" + - "Custodian" + - "Donor" + - "Estate with an executor/personal representative/fiduciary/etc." + - "Estate without an executor/personal representative/fiduciary/etc." + - "Guardian" + - "Next friend for a legally incompetent person (without a guardian, conservator, or other like fiduciary)" + - "Next friend for a minor (without a guardian, conservator, or other like fiduciary)" + - "Partnership (as the Tax Matters Partner)" + - "Partnership (as a partnership representative under the BBA regime)" + - "Partnership (as a partner other than Tax Matters Partner)" + - "Petitioner" + - "Petitioner & deceased spouse" + - "Petitioner & spouse" + - "Surviving spouse" + - "Transferee" + - "Trust" + petitionPaymentStatus: + type: "string" + flags: + only: true + presence: "required" + description: "Status of the case fee payment." + allow: + - "Paid" + - "Not Paid" + - "Waived" + petitionPaymentDate: + type: "any" + flags: + description: "When the petitioner paid the case fee." + whens: + - + ref: + path: + - "petitionPaymentStatus" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "Paid" + then: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "required" + otherwise: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "optional" + allow: + - null + petitionPaymentMethod: + type: "any" + flags: + description: "How the petitioner paid the case fee." + whens: + - + ref: + path: + - "petitionPaymentStatus" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "Paid" + then: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 50 + otherwise: + type: "string" + flags: + presence: "optional" + allow: + - null + petitionPaymentWaivedDate: + type: "any" + flags: + description: "When the case fee was waived." + whens: + - + ref: + path: + - "petitionPaymentStatus" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "Waived" + then: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "required" + otherwise: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "optional" + allow: + - null + preferredTrialCity: + type: "alternatives" + flags: + presence: "optional" + description: "Where the petitioner would prefer to hold the case trial." + matches: + - + schema: + type: "string" + flags: + only: true + allow: + - "Fresno, California" + - "Tallahassee, Florida" + - "Pocatello, Idaho" + - "Peoria, Illinois" + - "Wichita, Kansas" + - "Shreveport, Louisiana" + - "Portland, Maine" + - "Billings, Montana" + - "Albany, New York" + - "Syracuse, New York" + - "Bismarck, North Dakota" + - "Aberdeen, South Dakota" + - "Burlington, Vermont" + - "Roanoke, Virginia" + - "Cheyenne, Wyoming" + - "Birmingham, Alabama" + - "Mobile, Alabama" + - "Anchorage, Alaska" + - "Phoenix, Arizona" + - "Little Rock, Arkansas" + - "Los Angeles, California" + - "San Diego, California" + - "San Francisco, California" + - "Denver, Colorado" + - "Hartford, Connecticut" + - "Washington, District of Columbia" + - "Jacksonville, Florida" + - "Miami, Florida" + - "Tampa, Florida" + - "Atlanta, Georgia" + - "Honolulu, Hawaii" + - "Boise, Idaho" + - "Chicago, Illinois" + - "Indianapolis, Indiana" + - "Des Moines, Iowa" + - "Louisville, Kentucky" + - "New Orleans, Louisiana" + - "Baltimore, Maryland" + - "Boston, Massachusetts" + - "Detroit, Michigan" + - "St. Paul, Minnesota" + - "Jackson, Mississippi" + - "Kansas City, Missouri" + - "St. Louis, Missouri" + - "Helena, Montana" + - "Omaha, Nebraska" + - "Las Vegas, Nevada" + - "Reno, Nevada" + - "Albuquerque, New Mexico" + - "Buffalo, New York" + - "New York City, New York" + - "Winston-Salem, North Carolina" + - "Cincinnati, Ohio" + - "Cleveland, Ohio" + - "Columbus, Ohio" + - "Oklahoma City, Oklahoma" + - "Portland, Oregon" + - "Philadelphia, Pennsylvania" + - "Pittsburgh, Pennsylvania" + - "Columbia, South Carolina" + - "Knoxville, Tennessee" + - "Memphis, Tennessee" + - "Nashville, Tennessee" + - "Dallas, Texas" + - "El Paso, Texas" + - "Houston, Texas" + - "Lubbock, Texas" + - "San Antonio, Texas" + - "Salt Lake City, Utah" + - "Richmond, Virginia" + - "Seattle, Washington" + - "Spokane, Washington" + - "Charleston, West Virginia" + - "Milwaukee, Wisconsin" + - null + - + schema: + type: "string" + rules: + - + name: "pattern" + args: + regex: "/^[a-zA-Z ]+, [a-zA-Z ]+, [0-9]+$/" + privatePractitioners: + type: "array" + flags: + presence: "optional" + description: "List of private practitioners associated with the case." + procedureType: + type: "string" + flags: + only: true + presence: "required" + description: "Procedure type of the case." + allow: + - "Regular" + - "Small" + qcCompleteForTrial: + type: "object" + flags: + presence: "optional" + description: "QC Checklist object that must be completed before the case can go to trial." + metas: + - + tags: + - "Restricted" + receivedAt: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "required" + description: "When the case was received by the court. If electronic, this value will be the same as createdAt. If paper, this value can be edited." + sealedDate: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "optional" + description: "When the case was sealed from the public." + allow: + - null + sortableDocketNumber: + type: "number" + flags: + presence: "required" + description: "A sortable representation of the docket number (auto-generated by constructor)." + statistics: + type: "any" + flags: + description: "List of Statistic Entities for the case." + whens: + - + ref: + path: + - "hasVerifiedIrsNotice" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - true + then: + type: "any" + whens: + - + ref: + path: + - "caseType" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "Deficiency" + then: + type: "array" + flags: + presence: "required" + rules: + - + name: "min" + args: + limit: 1 + items: + - + type: "object" + metas: + - + entityName: "Statistic" + otherwise: + type: "array" + flags: + presence: "optional" + items: + - + type: "object" + metas: + - + entityName: "Statistic" + otherwise: + type: "array" + flags: + presence: "optional" + items: + - + type: "object" + metas: + - + entityName: "Statistic" + status: + type: "string" + flags: + only: true + presence: "optional" + description: "Status of the case." + allow: + - "Assigned - Case" + - "Assigned - Motion" + - "Calendared" + - "CAV" + - "Closed" + - "General Docket - Not at Issue" + - "General Docket - At Issue (Ready for Trial)" + - "Jurisdiction Retained" + - "New" + - "On Appeal" + - "Rule 155" + - "Submitted" + metas: + - + tags: + - "Restricted" + closedDate: + type: "any" + whens: + - + ref: + path: + - "status" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "Closed" + then: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "required" + otherwise: + type: "any" + flags: + presence: "optional" + allow: + - null + trialDate: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "optional" + description: "When this case goes to trial." + allow: + - null + trialLocation: + type: "alternatives" + flags: + presence: "optional" + description: "Where this case goes to trial. This may be different that the preferred trial location." + matches: + - + schema: + type: "string" + flags: + only: true + allow: + - "Fresno, California" + - "Tallahassee, Florida" + - "Pocatello, Idaho" + - "Peoria, Illinois" + - "Wichita, Kansas" + - "Shreveport, Louisiana" + - "Portland, Maine" + - "Billings, Montana" + - "Albany, New York" + - "Syracuse, New York" + - "Bismarck, North Dakota" + - "Aberdeen, South Dakota" + - "Burlington, Vermont" + - "Roanoke, Virginia" + - "Cheyenne, Wyoming" + - "Birmingham, Alabama" + - "Mobile, Alabama" + - "Anchorage, Alaska" + - "Phoenix, Arizona" + - "Little Rock, Arkansas" + - "Los Angeles, California" + - "San Diego, California" + - "San Francisco, California" + - "Denver, Colorado" + - "Hartford, Connecticut" + - "Washington, District of Columbia" + - "Jacksonville, Florida" + - "Miami, Florida" + - "Tampa, Florida" + - "Atlanta, Georgia" + - "Honolulu, Hawaii" + - "Boise, Idaho" + - "Chicago, Illinois" + - "Indianapolis, Indiana" + - "Des Moines, Iowa" + - "Louisville, Kentucky" + - "New Orleans, Louisiana" + - "Baltimore, Maryland" + - "Boston, Massachusetts" + - "Detroit, Michigan" + - "St. Paul, Minnesota" + - "Jackson, Mississippi" + - "Kansas City, Missouri" + - "St. Louis, Missouri" + - "Helena, Montana" + - "Omaha, Nebraska" + - "Las Vegas, Nevada" + - "Reno, Nevada" + - "Albuquerque, New Mexico" + - "Buffalo, New York" + - "New York City, New York" + - "Winston-Salem, North Carolina" + - "Cincinnati, Ohio" + - "Cleveland, Ohio" + - "Columbus, Ohio" + - "Oklahoma City, Oklahoma" + - "Portland, Oregon" + - "Philadelphia, Pennsylvania" + - "Pittsburgh, Pennsylvania" + - "Columbia, South Carolina" + - "Knoxville, Tennessee" + - "Memphis, Tennessee" + - "Nashville, Tennessee" + - "Dallas, Texas" + - "El Paso, Texas" + - "Houston, Texas" + - "Lubbock, Texas" + - "San Antonio, Texas" + - "Salt Lake City, Utah" + - "Richmond, Virginia" + - "Seattle, Washington" + - "Spokane, Washington" + - "Charleston, West Virginia" + - "Milwaukee, Wisconsin" + - null + - + schema: + type: "string" + rules: + - + name: "pattern" + args: + regex: "/^[a-zA-Z ]+, [a-zA-Z ]+, [0-9]+$/" + trialSessionId: + type: "string" + flags: + presence: "optional" + description: "The unique ID of the trial session associated with this case." + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + trialTime: + type: "string" + flags: + presence: "optional" + description: "Time of day when this case goes to trial." + rules: + - + name: "pattern" + args: + regex: "/^([01]?[0-9]|2[0-3]):[0-5][0-9]$/" + useSameAsPrimary: + type: "boolean" + flags: + presence: "optional" + description: "Whether to use the same address for the primary and secondary petitioner contact information (used only in data entry and QC process)." + userId: + type: "string" + flags: + presence: "optional" + description: "The unique ID of the User who added the case to the system." + rules: + - + name: "max" + args: + limit: 50 + metas: + - + tags: + - "Restricted" + workItems: + type: "array" + flags: + presence: "optional" + description: "List of system messages associated with this case." + metas: + - + tags: + - "Restricted" + + ``` diff --git a/docs/entities/CaseDeadline.md b/docs/entities/CaseDeadline.md index 110b63e438a..fa7e6036b2d 100644 --- a/docs/entities/CaseDeadline.md +++ b/docs/entities/CaseDeadline.md @@ -1,52 +1,68 @@ # CaseDeadline - -### caseDeadlineId - - -Unique Case Deadline ID only used by the system. - -> `string` | required - -### caseId - - -Unique Case ID only used by the system. - -> `string` | required - -### createdAt - - -When the Case Deadline was added to the system. - -> `date` | required - -### deadlineDate - - -When the Case Deadline expires. - -> `date` | required - -### description - - -User provided description of the Case Deadline. - -> `string` | required - -##### Maximum limit - - -`120` - -##### Minimum limit - - -`1` - -### entityName - -> `string` | required - -##### Can be CaseDeadline. + ``` +--- + type: "object" + keys: + caseDeadlineId: + type: "string" + flags: + presence: "required" + description: "Unique Case Deadline ID only used by the system." + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + caseId: + type: "string" + flags: + presence: "required" + description: "Unique Case ID only used by the system." + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + createdAt: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "required" + description: "When the Case Deadline was added to the system." + deadlineDate: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "required" + description: "When the Case Deadline expires." + description: + type: "string" + flags: + presence: "required" + description: "User provided description of the Case Deadline." + rules: + - + name: "max" + args: + limit: 120 + - + name: "min" + args: + limit: 1 + entityName: + type: "string" + flags: + only: true + presence: "required" + allow: + - "CaseDeadline" + + ``` diff --git a/docs/entities/CaseMessage.md b/docs/entities/CaseMessage.md new file mode 100644 index 00000000000..defe0a48486 --- /dev/null +++ b/docs/entities/CaseMessage.md @@ -0,0 +1,225 @@ +# CaseMessage + ``` +--- + type: "object" + keys: + caseId: + type: "string" + flags: + presence: "required" + description: "ID of the case the message is attached to." + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + caseStatus: + type: "string" + flags: + presence: "optional" + description: "The status of the associated case." + createdAt: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "required" + description: "When the message was created." + docketNumber: + type: "string" + flags: + presence: "required" + rules: + - + name: "pattern" + args: + regex: "/^([1-9]\\d{2,4}-\\d{2})$/" + docketNumberWithSuffix: + type: "string" + flags: + presence: "optional" + description: "The docket number and suffix for the associated case." + allow: + - null + entityName: + type: "string" + flags: + only: true + presence: "required" + allow: + - "CaseMessage" + from: + type: "string" + flags: + presence: "required" + description: "The name of the user who sent the message." + rules: + - + name: "max" + args: + limit: 100 + fromSection: + type: "string" + flags: + only: true + presence: "required" + description: "The section of the user who sent the message." + allow: + - "adc" + - "admissions" + - "chambers" + - "clerkofcourt" + - "docket" + - "petitions" + - "trialClerks" + - "armensChambers" + - "ashfordsChambers" + - "buchsChambers" + - "carluzzosChambers" + - "cohensChambers" + - "colvinsChambers" + - "copelandsChambers" + - "foleysChambers" + - "galesChambers" + - "gerbersChambers" + - "goekesChambers" + - "gustafsonsChambers" + - "guysChambers" + - "halpernsChambers" + - "holmesChambers" + - "jacobsChambers" + - "jonesChambers" + - "kerrigansChambers" + - "laubersChambers" + - "leydensChambers" + - "marvelsChambers" + - "morrisonsChambers" + - "negasChambers" + - "panuthosChambers" + - "parisChambers" + - "pughsChambers" + - "ruwesChambers" + - "thorntonsChambers" + - "urdasChambers" + - "vasquezsChambers" + - "wellsChambers" + fromUserId: + type: "string" + flags: + presence: "required" + description: "The ID of the user who sent the message." + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + message: + type: "string" + flags: + presence: "required" + description: "The message text." + rules: + - + name: "max" + args: + limit: 500 + messageId: + type: "string" + flags: + presence: "required" + description: "A unique ID generated by the system to represent the message." + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + subject: + type: "string" + flags: + presence: "required" + description: "The subject line of the message." + rules: + - + name: "max" + args: + limit: 250 + to: + type: "string" + flags: + presence: "required" + description: "The name of the user who is the recipient of the message." + rules: + - + name: "max" + args: + limit: 100 + allow: + - null + toSection: + type: "string" + flags: + only: true + presence: "required" + description: "The section of the user who is the recipient of the message." + allow: + - "adc" + - "admissions" + - "chambers" + - "clerkofcourt" + - "docket" + - "petitions" + - "trialClerks" + - "armensChambers" + - "ashfordsChambers" + - "buchsChambers" + - "carluzzosChambers" + - "cohensChambers" + - "colvinsChambers" + - "copelandsChambers" + - "foleysChambers" + - "galesChambers" + - "gerbersChambers" + - "goekesChambers" + - "gustafsonsChambers" + - "guysChambers" + - "halpernsChambers" + - "holmesChambers" + - "jacobsChambers" + - "jonesChambers" + - "kerrigansChambers" + - "laubersChambers" + - "leydensChambers" + - "marvelsChambers" + - "morrisonsChambers" + - "negasChambers" + - "panuthosChambers" + - "parisChambers" + - "pughsChambers" + - "ruwesChambers" + - "thorntonsChambers" + - "urdasChambers" + - "vasquezsChambers" + - "wellsChambers" + toUserId: + type: "string" + flags: + presence: "required" + description: "The ID of the user who is the recipient of the message." + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + allow: + - null + + ``` diff --git a/docs/entities/Correspondence.md b/docs/entities/Correspondence.md new file mode 100644 index 00000000000..56309ec437a --- /dev/null +++ b/docs/entities/Correspondence.md @@ -0,0 +1,62 @@ +# Correspondence + ``` +--- + type: "object" + keys: + documentId: + type: "string" + flags: + presence: "required" + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + documentTitle: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 500 + filedBy: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 500 + allow: + - "" + filingDate: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "required" + description: "Date that this Document was filed." + rules: + - + name: "max" + args: + date: "now" + userId: + type: "string" + flags: + presence: "required" + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + + ``` diff --git a/docs/entities/DocketRecord.md b/docs/entities/DocketRecord.md index 3384831688e..d4c5ebbbf94 100644 --- a/docs/entities/DocketRecord.md +++ b/docs/entities/DocketRecord.md @@ -1,436 +1,468 @@ # DocketRecord - -### action - - -Action taken in response to this Docket Record item. - -> `string` | optional - -##### Can be null. - -### description - - -Text that describes this Docket Record item, which may be part of the Filings and Proceedings value. - -> `string` | required - -### documentId - - -ID of the associated PDF document in the S3 bucket. - -> `string` | optional - -##### Can be null. - -### editState - - -JSON representation of the in-progress edit of this item. - - -Restricted - -> `string` | optional - -##### Can be null. - -### entityName - -> `string` | required - -##### Can be DocketRecord. - -### eventCode - - -Code associated with the event that resulted in this item being added to the Docket Record. - -> `string` | required - -##### Allowed Values - - - - `A` - - `AAAP` - - `AAPN` - - `AATP` - - `AATS` - - `AATT` - - `ACED` - - `ADMR` - - `ADMT` - - `AFE` - - `AFF` - - `AMAT` - - `AMDC` - - `APA` - - `APLD` - - `APPL` - - `APPW` - - `APW` - - `ASAP` - - `ASUP` - - `ATAP` - - `ATSP` - - `BND` - - `BRF` - - `CERT` - - `CIVP` - - `COED` - - `CS` - - `CTRA` - - `DCL` - - `DEC` - - `DISC` - - `DSC` - - `EA` - - `ES` - - `EVID` - - `EXH` - - `FEE` - - `FEEW` - - `FTRL` - - `HE` - - `HEAR` - - `LTR` - - `M000` - - `M001` - - `M002` - - `M003` - - `M004` - - `M005` - - `M006` - - `M007` - - `M008` - - `M009` - - `M010` - - `M011` - - `M012` - - `M013` - - `M014` - - `M015` - - `M016` - - `M017` - - `M018` - - `M019` - - `M020` - - `M021` - - `M022` - - `M023` - - `M024` - - `M026` - - `M027` - - `M028` - - `M029` - - `M030` - - `M031` - - `M032` - - `M033` - - `M034` - - `M035` - - `M036` - - `M037` - - `M038` - - `M039` - - `M040` - - `M041` - - `M042` - - `M043` - - `M044` - - `M045` - - `M046` - - `M047` - - `M048` - - `M049` - - `M050` - - `M051` - - `M052` - - `M053` - - `M054` - - `M055` - - `M056` - - `M057` - - `M058` - - `M059` - - `M060` - - `M061` - - `M062` - - `M063` - - `M064` - - `M065` - - `M066` - - `M067` - - `M068` - - `M069` - - `M070` - - `M071` - - `M072` - - `M073` - - `M074` - - `M075` - - `M076` - - `M077` - - `M078` - - `M079` - - `M080` - - `M081` - - `M082` - - `M083` - - `M084` - - `M085` - - `M086` - - `M087` - - `M088` - - `M089` - - `M090` - - `M091` - - `M092` - - `M093` - - `M094` - - `M095` - - `M096` - - `M097` - - `M098` - - `M099` - - `M100` - - `M101` - - `M102` - - `M103` - - `M104` - - `M105` - - `M106` - - `M107` - - `M108` - - `M109` - - `M110` - - `M111` - - `M112` - - `M113` - - `M114` - - `M115` - - `M116` - - `M117` - - `M118` - - `M119` - - `M120` - - `M121` - - `M122` - - `M123` - - `M124` - - `M125` - - `M126` - - `M129` - - `M130` - - `M131` - - `M132` - - `M133` - - `M134` - - `M135` - - `M136` - - `M218` - - `MEMO` - - `MGRTED` - - `MINC` - - `MIND` - - `MISC` - - `MISCL` - - `MISL` - - `MISP` - - `MOP` - - `NAJA` - - `NCA` - - `NCAG` - - `NCAP` - - `NCNP` - - `NCON` - - `NCP` - - `NCTP` - - `NDC` - - `NDT` - - `NFAR` - - `NIFL` - - `NINF` - - `NIS` - - `NITM` - - `NJAR` - - `NNOB` - - `NOA` - - `NOB` - - `NODC` - - `NOEI` - - `NOEP` - - `NOI` - - `NOST` - - `NOT` - - `NOU` - - `NPB` - - `NPJR` - - `NRJD` - - `NRJR` - - `NSA` - - `NSTE` - - `NTA` - - `NTD` - - `NTN` - - `O` - - `OAD` - - `OAJ` - - `OAL` - - `OAP` - - `OAPF` - - `OAR` - - `OAS` - - `OASL` - - `OAW` - - `OAX` - - `OBJ` - - `OBJE` - - `OBJN` - - `OCA` - - `OD` - - `ODD` - - `ODJ` - - `ODL` - - `ODP` - - `ODR` - - `ODS` - - `ODSL` - - `ODW` - - `ODX` - - `OF` - - `OFAB` - - `OFFX` - - `OFWD` - - `OFX` - - `OIP` - - `OJR` - - `OODS` - - `OP` - - `OPFX` - - `OPPO` - - `OPX` - - `ORAP` - - `OROP` - - `OSC` - - `OSCP` - - `OST` - - `OSUB` - - `P` - - `PARD` - - `PHM` - - `PMT` - - `PSDE` - - `PTFR` - - `PTRL` - - `RAT` - - `RATF` - - `RCOM` - - `REDC` - - `REPL` - - `REQ` - - `REQA` - - `RESP` - - `RFPC` - - `RJN` - - `RLRI` - - `RM` - - `ROA` - - `RPT` - - `RQT` - - `RSP` - - `RTP` - - `RTRA` - - `S212` - - `SADM` - - `SAMB` - - `SATL` - - `SDEC` - - `SEAB` - - `SEOB` - - `SERB` - - `SESB` - - `SIAB` - - `SIAM` - - `SIMB` - - `SIML` - - `SIOB` - - `SIOM` - - `SIRB` - - `SISB` - - `SOC` - - `SOMB` - - `SOP` - - `SORI` - - `SPAR` - - `SPD` - - `SPML` - - `SPMT` - - `SPTN` - - `SPTO` - - `SRMB` - - `SSB` - - `SSRB` - - `SSRM` - - `SSTP` - - `STAR` - - `STAT` - - `STBB` - - `STIN` - - `STIP` - - `STP` - - `STPD` - - `STS` - - `STST` - - `SUPM` - - `SURP` - - `Standard` - - `TCOP` - - `TE` - - `TRAN` - - `TRL` - - `USCA` - - `USDL` - - `WRIT` - -### filedBy - - -ID of the user that filed this Docket Record item. - - -Restricted - -> `string` | optional - -##### Can be null. - -### filingDate - - -Date that this Docket Record item was filed. - -> `date` | required - -##### Maximum date - - -`now` - -### index - - -Index of this item in the Docket Record list. - -> `number` | required - -### servedPartiesCode - - -Served parties code to override system-computed code. - -> `string` | optional - -##### Can be null. + ``` +--- + type: "object" + keys: + action: + type: "string" + flags: + presence: "optional" + description: "Action taken in response to this Docket Record item." + rules: + - + name: "max" + args: + limit: 100 + allow: + - null + description: + type: "string" + flags: + presence: "required" + description: "Text that describes this Docket Record item, which may be part of the Filings and Proceedings value." + rules: + - + name: "max" + args: + limit: 500 + documentId: + type: "string" + flags: + presence: "optional" + description: "ID of the associated PDF document in the S3 bucket." + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + allow: + - null + editState: + type: "string" + flags: + presence: "optional" + description: "JSON representation of the in-progress edit of this item." + rules: + - + name: "max" + args: + limit: 1000 + allow: + - null + metas: + - + tags: + - "Restricted" + entityName: + type: "string" + flags: + only: true + presence: "required" + allow: + - "DocketRecord" + eventCode: + type: "string" + flags: + only: true + presence: "required" + description: "Code associated with the event that resulted in this item being added to the Docket Record." + allow: + - "A" + - "AAAP" + - "AAPN" + - "AATP" + - "AATS" + - "AATT" + - "ACED" + - "ADMR" + - "ADMT" + - "AFE" + - "AFF" + - "AFP" + - "AMAT" + - "AMDC" + - "APA" + - "APLD" + - "APPL" + - "APPW" + - "APW" + - "ASAP" + - "ASUP" + - "ATAP" + - "ATSP" + - "BND" + - "BRF" + - "CERT" + - "CIVP" + - "COED" + - "CS" + - "CTRA" + - "DCL" + - "DEC" + - "DISC" + - "DSC" + - "EA" + - "ES" + - "EVID" + - "EXH" + - "FEE" + - "FEEW" + - "FTRL" + - "HE" + - "HEAR" + - "LTR" + - "M000" + - "M001" + - "M002" + - "M003" + - "M004" + - "M005" + - "M006" + - "M007" + - "M008" + - "M009" + - "M010" + - "M011" + - "M012" + - "M013" + - "M014" + - "M015" + - "M016" + - "M017" + - "M018" + - "M019" + - "M020" + - "M021" + - "M022" + - "M023" + - "M024" + - "M026" + - "M027" + - "M028" + - "M029" + - "M030" + - "M031" + - "M032" + - "M033" + - "M034" + - "M035" + - "M036" + - "M037" + - "M038" + - "M039" + - "M040" + - "M041" + - "M042" + - "M043" + - "M044" + - "M045" + - "M046" + - "M047" + - "M048" + - "M049" + - "M050" + - "M051" + - "M052" + - "M053" + - "M054" + - "M055" + - "M056" + - "M057" + - "M058" + - "M059" + - "M060" + - "M061" + - "M062" + - "M063" + - "M064" + - "M065" + - "M066" + - "M067" + - "M068" + - "M069" + - "M070" + - "M071" + - "M072" + - "M073" + - "M074" + - "M075" + - "M076" + - "M077" + - "M078" + - "M079" + - "M080" + - "M081" + - "M082" + - "M083" + - "M084" + - "M085" + - "M086" + - "M087" + - "M088" + - "M089" + - "M090" + - "M091" + - "M092" + - "M093" + - "M094" + - "M095" + - "M096" + - "M097" + - "M098" + - "M099" + - "M100" + - "M101" + - "M102" + - "M103" + - "M104" + - "M105" + - "M106" + - "M107" + - "M108" + - "M109" + - "M110" + - "M111" + - "M112" + - "M113" + - "M114" + - "M115" + - "M116" + - "M117" + - "M118" + - "M119" + - "M120" + - "M121" + - "M122" + - "M123" + - "M124" + - "M125" + - "M126" + - "M129" + - "M130" + - "M131" + - "M132" + - "M133" + - "M134" + - "M135" + - "M136" + - "M218" + - "MEMO" + - "MGRTED" + - "MINC" + - "MIND" + - "MISC" + - "MISCL" + - "MISL" + - "MISP" + - "MOP" + - "NAJA" + - "NCA" + - "NCAG" + - "NCAP" + - "NCNP" + - "NCON" + - "NCP" + - "NCTP" + - "NDC" + - "NDT" + - "NFAR" + - "NIFL" + - "NINF" + - "NIS" + - "NITM" + - "NJAR" + - "NNOB" + - "NOA" + - "NOB" + - "NODC" + - "NOEI" + - "NOEP" + - "NOI" + - "NOST" + - "NOT" + - "NOU" + - "NPB" + - "NPJR" + - "NRJD" + - "NRJR" + - "NSA" + - "NSTE" + - "NTA" + - "NTD" + - "NTN" + - "O" + - "OAD" + - "OAJ" + - "OAL" + - "OAP" + - "OAPF" + - "OAR" + - "OAS" + - "OASL" + - "OAW" + - "OAX" + - "OBJ" + - "OBJE" + - "OBJN" + - "OCA" + - "OD" + - "ODD" + - "ODJ" + - "ODL" + - "ODP" + - "ODR" + - "ODS" + - "ODSL" + - "ODW" + - "ODX" + - "OF" + - "OFAB" + - "OFFX" + - "OFWD" + - "OFX" + - "OIP" + - "OJR" + - "OODS" + - "OP" + - "OPFX" + - "OPPO" + - "OPX" + - "ORAP" + - "OROP" + - "OSC" + - "OSCP" + - "OST" + - "OSUB" + - "P" + - "PARD" + - "PHM" + - "PMT" + - "PSDE" + - "PTFR" + - "PTRL" + - "RAT" + - "RATF" + - "RCOM" + - "REDC" + - "REPL" + - "REQ" + - "REQA" + - "RESP" + - "RFPC" + - "RJN" + - "RLRI" + - "RM" + - "ROA" + - "RPT" + - "RQT" + - "RSP" + - "RTP" + - "RTRA" + - "S212" + - "SADM" + - "SAMB" + - "SATL" + - "SDEC" + - "SEAB" + - "SEOB" + - "SERB" + - "SESB" + - "SIAB" + - "SIAM" + - "SIMB" + - "SIML" + - "SIOB" + - "SIOM" + - "SIRB" + - "SISB" + - "SOC" + - "SOMB" + - "SOP" + - "SORI" + - "SPAR" + - "SPD" + - "SPML" + - "SPMT" + - "SPTN" + - "SPTO" + - "SRMB" + - "SSB" + - "SSRB" + - "SSRM" + - "SSTP" + - "STAR" + - "STAT" + - "STBB" + - "STIN" + - "STIP" + - "STP" + - "STPD" + - "STS" + - "STST" + - "SUPM" + - "SURP" + - "TCOP" + - "TE" + - "TRAN" + - "TRL" + - "USCA" + - "USDL" + - "WRIT" + filedBy: + type: "string" + flags: + presence: "optional" + description: "User that filed this Docket Record item." + rules: + - + name: "max" + args: + limit: 500 + allow: + - null + metas: + - + tags: + - "Restricted" + filingDate: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "required" + description: "Date that this Docket Record item was filed." + rules: + - + name: "max" + args: + date: "now" + index: + type: "number" + flags: + presence: "required" + description: "Index of this item in the Docket Record list." + rules: + - + name: "integer" + numberOfPages: + type: "number" + flags: + presence: "optional" + allow: + - null + servedPartiesCode: + type: "string" + flags: + only: true + presence: "optional" + description: "Served parties code to override system-computed code." + allow: + - "R" + - "B" + - "" + - null + + ``` diff --git a/docs/entities/Document.md b/docs/entities/Document.md index db3ba9bee43..56c3a12a286 100644 --- a/docs/entities/Document.md +++ b/docs/entities/Document.md @@ -1,711 +1,804 @@ # Document - -### addToCoversheet - -> `boolean` | optional - -### additionalInfo - -> `string` | optional - -### additionalInfo2 - -> `string` | optional - -### archived - - -A document that was archived instead of added to the Docket Record. - -> `boolean` | optional - -### caseId - - -Unique ID of the associated Case. - -> `string` | optional - -### certificateOfService - -> `boolean` | optional - -### certificateOfServiceDate - -> `any` - - -If `certificateOfService` = `true`, then this field is `date` and is `required.` - - -Otherwise, this field is `any` and is `optional`. - -### createdAt - - -When the Document was added to the system. - -> `date` | required - -### date - - -An optional date used when generating a fully concatenated document title. - -> `date` | optional - -##### Can be null. - -### docketNumber - - -Docket Number of the associated Case in XXXXX-YY format. - -> `string` | optional - -##### Regex Pattern - - -`/^(\d{3,5}-\d{2})$/` - -### docketNumbers - - -Optional Docket Number text used when generating a fully concatenated document title. - -> `string` | optional - -### documentContentsId - - -The S3 ID containing the text contents of the document. - -> `string` | optional - -### documentId - - -ID of the associated PDF document in the S3 bucket. - -> `string` | required - -### documentTitle - - -The title of this document. - -> `string` | optional - -### documentType - - -The type of this document. - -> `string` | required - -##### Allowed Values - - - - `Application for Waiver of Filing Fee` - - `Ownership Disclosure Statement` - - `Petition` - - `Request for Place of Trial` - - `Statement of Taxpayer Identification` - - `Entry of Appearance` - - `Substitution of Counsel` - - `Answer` - - `Answer to Amended Petition` - - `Answer to Amended Petition, as Amended` - - `Answer to Amendment to Amended Petition` - - `Answer to Amendment to Petition` - - `Answer to Petition, as Amended` - - `Answer to Second Amended Petition` - - `Answer to Second Amendment to Petition` - - `Answer to Supplement to Petition` - - `Answer to Third Amended Petition` - - `Answer to Third Amendment to Petition` - - `Designation of Counsel to Receive Service` - - `Motion to Withdraw as Counsel` - - `Motion to Withdraw Counsel (filed by petitioner)` - - `Application for Waiver of Filing Fee and Affidavit` - - `Application to Take Deposition` - - `Agreed Computation for Entry of Decision` - - `Computation for Entry of Decision` - - `Proposed Stipulated Decision` - - `Revised Computation` - - `Administrative Record` - - `Amended` - - `Amended Certificate of Service` - - `Amendment [anything]` - - `Certificate as to the Genuineness of the Administrative Record` - - `Certificate of Service` - - `Civil Penalty Approval Form` - - `Exhibit(s)` - - `Memorandum` - - `Partial Administrative Record` - - `Ratification` - - `Redacted` - - `Report` - - `Status Report` - - `Motion for Continuance` - - `Motion for Extension of Time` - - `Motion to Dismiss for Lack of Jurisdiction` - - `Motion to Dismiss for Lack of Prosecution` - - `Motion for Summary Judgment` - - `Motion to Change or Correct Caption` - - `Motion for a New Trial` - - `Motion for an Order under Federal Rule of Evidence 502(d)` - - `Motion for an Order under Model Rule of Professional Conduct 4.2` - - `Motion for Appointment of Mediator` - - `Motion for Assignment of Judge` - - `Motion for Audio of Trial Proceeding(s)` - - `Motion for Certification of an Interlocutory Order to Permit Immediate Appeal` - - `Motion for Default and Dismissal` - - `Motion for Entry of Decision` - - `Motion for Entry of Order that Undenied Allegations be Deemed Admitted Pursuant to Rule 37(c)` - - `Motion for Estate Tax Deduction Developing at or after Trial Pursuant to Rule 156` - - `Motion for in Camera Review` - - `Motion for International Judicial Assistance` - - `Motion for Judgment on the Pleadings` - - `Motion for Leave to Conduct Discovery Pursuant to Rule 70(a)(2)` - - `Motion for Leave to File` - - `Motion for Leave to File Out of Time` - - `Motion for Leave to Serve Additional Interrogatories` - - `Motion for Leave to Use Electronic Equipment` - - `Motion for More Definite Statement Pursuant to Rule 51` - - `Motion for Non-Binding Mediation` - - `Motion for Oral Argument` - - `Motion for Order Fixing Amount of an Appeal Bond` - - `Motion for Order to Release the Amount of an Appeal Bond` - - `Motion for Order to Show Cause Why Case Should Not Be Sumitted on the Basis of the Administrative Record` - - `Motion for Order to Show Cause Why Judgment Should Not be Entered on the Basis of a Previously Decided Case` - - `Motion for Order to Show Cause Why Proposed Facts and Evidence Should Not be Accepted as Established Pursuant to Rule 91(f)` - - `Motion for Partial Summary Judgment` - - `Motion for Pretrial Conference` - - `Motion for Protective Order Pursuant to Rule 103` - - `Motion for Reasonable Litigation or Administrative Costs` - - `Motion for Reconsideration of Findings or Opinion Pursuant to Rule 161` - - `Motion for Reconsideration of Order` - - `Motion for Recusal of Judge` - - `Motion for Review of Jeopardy Assessment or Jeopardy Levy Pursuant to Rule 56` - - `Motion for the Court to Pay the Expenses of a Transcript` - - `Motion for the Court to Pay the Expenses of an Interpreter` - - `Motion for Voluntary Binding Arbitration` - - `Motion for Writ of Habeas Corpus Ad Testificandum` - - `Motion in Limine` - - `Motion to Add Lien or Levy Designation` - - `Motion to Add Small Tax case Designation` - - `Motion to Amend Order` - - `Motion to Appoint an Interpreter Pursuant to Rule 143(f)` - - `Motion to Appoint New Tax Matters Partner` - - `Motion to Appoint Tax Matters Partner` - - `Motion to Authorize Proposed Sale of Seized Property` - - `Motion to Be Excused from Appearing at the Trial Session` - - `Motion to Be Recognized as Next Friend` - - `Motion to Bifurcate` - - `Motion to Calendar` - - `Motion to Calendar and Consolidate` - - `Motion to Calendar in the Electronic (North) Courtroom` - - `Motion to Certify for Interlocutory Appeal` - - `Motion to Change or Correct Docket Entry` - - `Motion to Change Place of Submission of Declaratory Judgment Case` - - `Motion to Change Place of Trial` - - `Motion to Change Service Method` - - `Motion to Clarify Order` - - `Motion to Close on Ground of Duplication` - - `Motion to Compel Discovery` - - `Motion to Compel Production of Documents` - - `Motion to Compel Responses to Interrogatories` - - `Motion to Compel the Taking of Deposition` - - `Motion to Conform the Pleadings to the Proof` - - `Motion to Consolidate` - - `Motion to Correct and Certify Record on Appeal` - - `Motion to Correct Clerical Order` - - `Motion to Correct Transcript` - - `Motion to Depose Pursuant to Rule 74` - - `Motion to Determine the Tax Matters Partner` - - `Motion to Dismiss` - - `Motion to Dismiss for Failure to Properly Prosecute` - - `Motion to Dismiss for Failure to State a Claim upon Which Relief Can Be Granted` - - `Motion to Dismiss for Lack of Jurisdiction as to [person, notice, or year]` - - `Motion to Dismiss on Grounds of Mootness` - - `Motion to Disqualify Counsel` - - `Motion to Enforce a Refund of Overpayment Pursuant to Rule 260` - - `Motion to Enforce Subpoena` - - `Motion to Extend Time to Move or File Answer` - - `Motion to Impose a Penalty` - - `Motion to Impose Sanctions` - - `Motion to Modify Decision in Estate Tax Case Pursuant to Rule 262` - - `Motion to Modify Order` - - `Motion to Permit Expert Witness to Testify without a Written Report Regarding Industry Practice Pursuant to Rule 143(g)(3)` - - `Motion to Permit Levy` - - `Motion to Preclude` - - `Motion to Quash or Modify Subpoena` - - `Motion to Redetermine Interest Pursuant to Rule 261` - - `Motion to Remand` - - `Motion to Remove Lien/Levy Designation` - - `Motion to Remove Small Tax Case Designation` - - `Motion to Remove Tax Matters Partner` - - `Motion to Reopen the Record` - - `Motion to Require Petitioner to File a Reply in a Small Tax Case Pursuant to Rule 173(c)` - - `Motion to Restore Case to the General Docket` - - `Motion to Restrain Assessment or Collection or to Order Refund of Amount Collected` - - `Motion to Retain File in Estate Tax Case Involving § 6166 Election Pursuant to Rule 157` - - `Motion to Review the Sufficiency of Answers or Objections to Request for Admissions` - - `Motion to Seal` - - `Motion to Set for a Time & Date Certain` - - `Motion to Set Pretrial Scheduling Order` - - `Motion to Sever` - - `Motion to Shift the Burden of Proof` - - `Motion to Shorten the Time` - - `Motion to Stay Proceedings` - - `Motion to Stay Proposed Sale of Seized Property` - - `Motion to Strike` - - `Motion to Submit Case Pursuant to Rule 122` - - `Motion to Substitute Parties and Change Caption` - - `Motion to Substitute Trial Exhibit(s)` - - `Motion to Supplement the Record` - - `Motion to Suppress Evidence` - - `Motion to Take Deposition Pursuant to Rule 74(c)(3)` - - `Motion to Take Judicial Notice` - - `Motion to Vacate` - - `Motion to Vacate or Revise Pursuant to Rule 162` - - `Motion to Withdraw` - - `Motion to Withdraw or Modify the Deemed Admitted Admissions Pursuant to Rule 90(f)` - - `Notice of Abatement of Jeopardy Assessment` - - `Notice of Appeal` - - `Notice of Change of Address` - - `Notice of Change of Address and Telephone Number` - - `Notice of Change of Telephone Number` - - `Notice of Clarification of Tax Matters Partner` - - `Notice of Concession` - - `Notice of Consistent Agreement Pursuant to Rule 248(c)(1)` - - `Notice of Death of Counsel` - - `Notice of Filing of Petition and Right to Intervene` - - `Notice of Filing of the Administrative Record` - - `Notice of Identification of Tax Matters Partner` - - `Notice of Intent Not to File` - - `Notice of Issue Concerning Foreign Law` - - `Notice of Jeopardy Assessment` - - `Notice of Judicial Ruling` - - `Notice of No Objection` - - `Notice of Objection` - - `Notice of Partial Abatement of Jeopardy Assessment` - - `Notice of Proceeding in Bankruptcy` - - `Notice of Relevant Judicial Decisions` - - `Notice of Settlement Agreement Pursuant to Rule 248(c)(1)` - - `Notice of Small Tax Case Election` - - `Notice of Supplemental Authority` - - `Notice of Telephone Number` - - `Notice of Termination Assessment` - - `Notice of Unavailability` - - `Redacted Petition Filed` - - `Prehearing Memorandum` - - `Pretrial Memorandum` - - `Reply` - - `Sur-Reply` - - `Request for Admissions` - - `Request for Judicial Notice` - - `Request for Pretrial Conference` - - `No Objection` - - `Objection` - - `Opposition` - - `Response` - - `Seriatim Answering Brief` - - `Seriatim Answering Memorandum Brief` - - `Seriatim Opening Brief` - - `Seriatim Opening Memorandum Brief` - - `Seriatim Reply Brief` - - `Seriatim Reply Memorandum Brief` - - `Seriatim Sur-Reply Brief` - - `Seriatim Sur-Reply Memorandum Brief` - - `Simultaneous Answering Brief` - - `Simultaneous Answering Memoranda of Law` - - `Simultaneous Answering Memorandum Brief` - - `Simultaneous Memoranda of Law` - - `Simultaneous Opening Brief` - - `Simultaneous Opening Memorandum Brief` - - `Simultaneous Reply Brief` - - `Simultaneous Supplemental Brief` - - `Simultaneous Sur-Reply Brief` - - `Simultaneous Sur-Reply Memorandum Brief` - - `Statement` - - `Statement of Redacted Information` - - `Statement under Rule 212` - - `Statement under Rule 50(c)` - - `Settlement Stipulation` - - `Stipulation` - - `Stipulation as to the Administrative Record` - - `Stipulation as to the Partial Administrative Record` - - `Stipulation of Facts` - - `Stipulation of Pretrial Deadlines` - - `Stipulation of Settled Issues` - - `Stipulation of Settlement` - - `Stipulation to Be Bound` - - `Stipulation to Take Deposition` - - `Supplement` - - `Supplemental` - - `Affidavit in Support` - - `Brief in Support` - - `Declaration in Support` - - `Memorandum in Support` - - `Unsworn Declaration under Penalty of Perjury in Support` - - `Application` - - `Application for Examination Pursuant to Rule 73` - - `Amended [Document Name]` - - `Appellate Filing Fee Received` - - `Bond` - - `Bounced Electronic Service` - - `Evidence` - - `Hearing Exhibits` - - `Letter` - - `Miscellaneous` - - `Miscellaneous (Lodged)` - - `Reference List of Redacted Information` - - `Returned Mail` - - `Trial Exhibits` - - `U.S.C.A. [Anything]` - - `Motion` - - `Motion for Review By the Full Court` - - `Motion for Review En Banc` - - `Motion to Be Exempt from E-Filing` - - `Motion to Change Place of Hearing of Disclosure Case` - - `Motion to File Document Under Seal` - - `Motion to Intervene` - - `Motion to Proceed Anonymously` - - `Notice` - - `Notice of Change of Counsel for Non-Party` - - `Notice of Election to Intervene` - - `Notice of Election to Participate` - - `Notice of Intervention` - - `Ratification of Petition` - - `Request` - - `Objection [anything]` - - `Opposition [anything]` - - `Response [anything]` - - `Supplement To [anything]` - - `Supplemental [anything]` - - `Order` - - `Order of Dismissal for Lack of Jurisdiction` - - `Order of Dismissal` - - `Order of Dismissal and Decision` - - `Order to Show Cause` - - `Order and Decision` - - `Decision` - - `O - Order` - - `OAJ - Order that case is assigned` - - `OAL - Order that the letter "L" is added to Docket number` - - `OAP - Order for Amended Petition` - - `OAPF - Order for Amended Petition and Filing Fee` - - `OAR - Order that the letter "R" is added to the Docket number` - - `OAS - Order that the letter "S" is added to the Docket number` - - `OASL - Order that the letters "SL" are added to the Docket number` - - `OAW - Order that the letter "W" is added to the Docket number` - - `OAX - Order that the letter "X" is added to the Docket number` - - `OCA - Order that caption of case is amended` - - `OD - Order of Dismissal Entered,` - - `ODD - Order of Dismissal and Decision Entered,` - - `ODL - Order that the letter "L" is deleted from the Docket number` - - `ODP - Order that the letter "P" is deleted from the Docket number` - - `ODR - Order that the letter "R" is deleted from the Docket number` - - `ODS - Order that the letter "S" is deleted from the Docket number` - - `ODSL - Order that the letters "SL" are deleted from the Docket number` - - `ODW - Order that the letter "W" is deleted from the Docket number` - - `ODX - Order that the letter "X" is deleted from the Docket number` - - `OF - Order for Filing Fee` - - `OFAB - Order fixing amount of bond` - - `OFFX - Order time is extended for petr(s) to pay the filing fee` - - `OFWD - Order for Filing Fee. Application waiver of Filing Fee is denied.` - - `OFX - Order time is extended for petr(s) to pay filing fee or submit an Application for Waiver of Filing fee` - - `OIP - Order that the letter "P" is added to the Docket number` - - `OJR - Order that jurisdiction is retained` - - `OODS - Order for Ownership Disclosure Statement` - - `OPFX - Order time is extended for petr(s) to file Amended Petition and pay the Filing Fee or submit an Application for Waiver of Filing Fee` - - `OPX - Order time is extended for petr(s) to file Amended Petition` - - `ORAP - Order for Amendment to Petition` - - `OROP - Order for Ratification of Petition` - - `OSC - Order` - - `OSCP - Order petr(s) to show cause why "S" should not be removed` - - `OST - Order of Service of Transcript (Bench Opinion)` - - `OSUB - Order that case is submitted` - - `DEC - Decision Entered,` - - `OAD - Order and Decision Entered,` - - `ODJ - Order of Dismissal for Lack of Jurisdiction Entered,` - - `SDEC - Stipulated Decision Entered,` - - `MOP - Memorandum Opinion` - - `NOT - Notice` - - `Summary Opinion` - - `Writ of Habeas Corpus Ad Testificandum` - - `CTRA - Corrected Transcript` - - `FTRL - Further Trial before ...` - - `HEAR - Hearing before ...` - - `NTD - Notice of Trial` - - `PTRL - Partial Trial before ...` - - `TRL - Trial before ...` - - `ROA - Record on Appeal` - - `TCOP - T.C. Opinion` - - `RTRA - Revised Transcript` - - `TRAN - Transcript` - - `SPTO - Standing Pre-Trial Order` - - `MISC - Miscellaneous` - - `Stipulated Decision` - - `Notice of Docket Change` - - `Notice of Trial` - - `Standing Pretrial Notice` - - `Standing Pretrial Order` - -### draftState - -> `object` | optional - -##### Can be null. - -### entityName - -> `string` | required - -##### Can be Document. - -### eventCode - -> `string` | optional - -### filedBy - -> `string` | optional - -##### Can be . - -### filingDate - - -Date that this Document was filed. - -> `date` | required - -##### Maximum date - - -`now` - -### freeText - -> `string` | optional - -### freeText2 - -> `string` | optional - -### hasSupportingDocuments - -> `boolean` | optional - -### isFileAttached - -> `boolean` | optional - -### isPaper - -> `boolean` | optional - -### judge - - -The judge associated with the document. - -> `string` | optional - -##### Can be null. - -### lodged - - -A lodged document is awaiting action by the judge to enact or refuse. - -> `boolean` | optional - -### numberOfPages - -> `number` | optional - -##### Can be null. - -### objections - -> `string` | optional - -### ordinalValue - -> `string` | optional - -### partyIrsPractitioner - -> `boolean` | optional - -### partyPrimary - - -Use the primary contact to compose the filedBy text. - -> `boolean` | optional - -### partySecondary - - -Use the secondary contact to compose the filedBy text. - -> `boolean` | optional - -### pending - -> `boolean` | optional - -### previousDocument - -> `object` | optional - -### privatePractitioners - - -Practitioner names to be used to compose the filedBy text. - -> `array` | optional - - -An array of objects. - -### processingStatus - -> `string` | optional - -### qcAt - -> `date` | optional - -### qcByUserId - -> `string` | optional - -##### Can be null. - -### receivedAt - -> `date` | optional - -### relationship - -> `string` | optional - -##### Allowed Values - - - - `primaryDocument` - - `primarySupportingDocument` - - `secondaryDocument` - - `secondarySupportingDocument` - - `supportingDocument` - -### scenario - -> `string` | optional - -##### Allowed Values - - - - `Standard` - - `Nonstandard A` - - `Nonstandard B` - - `Nonstandard C` - - `Nonstandard D` - - `Nonstandard E` - - `Nonstandard F` - - `Nonstandard G` - - `Nonstandard H` - - `Type A` - - `Type B` - - `Type C` - - `Type D` - - `Type E` - - `Type F` - - `Type G` - - `Type H` - -### secondaryDate - - -A secondary date associated with the document, typically related to time-restricted availability. - -> `date` | optional - -### servedAt - - -When the document is served on the parties. - -> `date` | optional - -### servedParties - -> `array` | optional - - -An array of objects. - -### serviceDate - - -Certificate of service date. - -> `date` | optional - -##### Maximum date - - -`now` - -##### Can be null. - -### serviceStamp - -> `string` | optional - -### signedAt - -> `date` | optional - -##### Can be null. - -### signedByUserId - -> `string` | optional - -##### Can be null. - -### signedJudgeName - -> `string` | optional - -##### Can be null. - -### supportingDocument - -> `string` | optional - -##### Can be null. - -### trialLocation - - -An optional trial location used when generating a fully concatenated document title. - -> `string` | optional - -##### Can be null. - -### userId - -> `string` | required - -### workItems - -> `array` | optional + ``` +--- + type: "object" + keys: + addToCoversheet: + type: "boolean" + flags: + presence: "optional" + additionalInfo: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 500 + additionalInfo2: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 500 + archived: + type: "boolean" + flags: + presence: "optional" + description: "A document that was archived instead of added to the Docket Record." + certificateOfService: + type: "boolean" + flags: + presence: "optional" + certificateOfServiceDate: + type: "any" + whens: + - + ref: + path: + - "certificateOfService" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - true + then: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "required" + otherwise: + type: "any" + flags: + presence: "optional" + createdAt: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "required" + description: "When the Document was added to the system." + date: + type: "date" + flags: + format: "iso" + presence: "optional" + description: "An optional date used when generating a fully concatenated document title." + allow: + - null + docketNumber: + type: "string" + flags: + presence: "optional" + description: "Docket Number of the associated Case in XXXXX-YY format." + rules: + - + name: "pattern" + args: + regex: "/^([1-9]\\d{2,4}-\\d{2})$/" + docketNumbers: + type: "string" + flags: + presence: "optional" + description: "Optional Docket Number text used when generating a fully concatenated document title." + rules: + - + name: "max" + args: + limit: 500 + documentContentsId: + type: "string" + flags: + presence: "optional" + description: "The S3 ID containing the text contents of the document." + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + documentId: + type: "string" + flags: + presence: "required" + description: "ID of the associated PDF document in the S3 bucket." + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + documentTitle: + type: "string" + flags: + presence: "optional" + description: "The title of this document." + rules: + - + name: "max" + args: + limit: 500 + documentType: + type: "string" + flags: + only: true + presence: "required" + description: "The type of this document." + allow: + - "Application for Waiver of Filing Fee" + - "Ownership Disclosure Statement" + - "Petition" + - "Request for Place of Trial" + - "Statement of Taxpayer Identification" + - "Entry of Appearance" + - "Substitution of Counsel" + - "Answer" + - "Answer to Amended Petition" + - "Answer to Amended Petition, as Amended" + - "Answer to Amendment to Amended Petition" + - "Answer to Amendment to Petition" + - "Answer to Petition, as Amended" + - "Answer to Second Amended Petition" + - "Answer to Second Amendment to Petition" + - "Answer to Supplement to Petition" + - "Answer to Third Amended Petition" + - "Answer to Third Amendment to Petition" + - "Designation of Counsel to Receive Service" + - "Motion to Withdraw as Counsel" + - "Motion to Withdraw Counsel (filed by petitioner)" + - "Application for Waiver of Filing Fee and Affidavit" + - "Application to Take Deposition" + - "Agreed Computation for Entry of Decision" + - "Computation for Entry of Decision" + - "Proposed Stipulated Decision" + - "Revised Computation" + - "Administrative Record" + - "Amended" + - "Amended Certificate of Service" + - "Amendment [anything]" + - "Certificate as to the Genuineness of the Administrative Record" + - "Certificate of Service" + - "Civil Penalty Approval Form" + - "Exhibit(s)" + - "Memorandum" + - "Partial Administrative Record" + - "Ratification" + - "Redacted" + - "Report" + - "Status Report" + - "Motion for Continuance" + - "Motion for Extension of Time" + - "Motion to Dismiss for Lack of Jurisdiction" + - "Motion to Dismiss for Lack of Prosecution" + - "Motion for Summary Judgment" + - "Motion to Change or Correct Caption" + - "Motion for a New Trial" + - "Motion for an Order under Federal Rule of Evidence 502(d)" + - "Motion for an Order under Model Rule of Professional Conduct 4.2" + - "Motion for Appointment of Mediator" + - "Motion for Assignment of Judge" + - "Motion for Audio of Trial Proceeding(s)" + - "Motion for Certification of an Interlocutory Order to Permit Immediate Appeal" + - "Motion for Default and Dismissal" + - "Motion for Entry of Decision" + - "Motion for Entry of Order that Undenied Allegations be Deemed Admitted Pursuant to Rule 37(c)" + - "Motion for Estate Tax Deduction Developing at or after Trial Pursuant to Rule 156" + - "Motion for in Camera Review" + - "Motion for International Judicial Assistance" + - "Motion for Judgment on the Pleadings" + - "Motion for Leave to Conduct Discovery Pursuant to Rule 70(a)(2)" + - "Motion for Leave to File" + - "Motion for Leave to File Out of Time" + - "Motion for Leave to Serve Additional Interrogatories" + - "Motion for Leave to Use Electronic Equipment" + - "Motion for More Definite Statement Pursuant to Rule 51" + - "Motion for Non-Binding Mediation" + - "Motion for Oral Argument" + - "Motion for Order Fixing Amount of an Appeal Bond" + - "Motion for Order to Release the Amount of an Appeal Bond" + - "Motion for Order to Show Cause Why Case Should Not Be Sumitted on the Basis of the Administrative Record" + - "Motion for Order to Show Cause Why Judgment Should Not be Entered on the Basis of a Previously Decided Case" + - "Motion for Order to Show Cause Why Proposed Facts and Evidence Should Not be Accepted as Established Pursuant to Rule 91(f)" + - "Motion for Partial Summary Judgment" + - "Motion for Pretrial Conference" + - "Motion for Protective Order Pursuant to Rule 103" + - "Motion for Reasonable Litigation or Administrative Costs" + - "Motion for Reconsideration of Findings or Opinion Pursuant to Rule 161" + - "Motion for Reconsideration of Order" + - "Motion for Recusal of Judge" + - "Motion for Review of Jeopardy Assessment or Jeopardy Levy Pursuant to Rule 56" + - "Motion for the Court to Pay the Expenses of a Transcript" + - "Motion for the Court to Pay the Expenses of an Interpreter" + - "Motion for Voluntary Binding Arbitration" + - "Motion for Writ of Habeas Corpus Ad Testificandum" + - "Motion in Limine" + - "Motion to Add Lien or Levy Designation" + - "Motion to Add Small Tax case Designation" + - "Motion to Amend Order" + - "Motion to Appoint an Interpreter Pursuant to Rule 143(f)" + - "Motion to Appoint New Tax Matters Partner" + - "Motion to Appoint Tax Matters Partner" + - "Motion to Authorize Proposed Sale of Seized Property" + - "Motion to Be Excused from Appearing at the Trial Session" + - "Motion to Be Recognized as Next Friend" + - "Motion to Bifurcate" + - "Motion to Calendar" + - "Motion to Calendar and Consolidate" + - "Motion to Calendar in the Electronic (North) Courtroom" + - "Motion to Certify for Interlocutory Appeal" + - "Motion to Change or Correct Docket Entry" + - "Motion to Change Place of Submission of Declaratory Judgment Case" + - "Motion to Change Place of Trial" + - "Motion to Change Service Method" + - "Motion to Clarify Order" + - "Motion to Close on Ground of Duplication" + - "Motion to Compel Discovery" + - "Motion to Compel Production of Documents" + - "Motion to Compel Responses to Interrogatories" + - "Motion to Compel the Taking of Deposition" + - "Motion to Conform the Pleadings to the Proof" + - "Motion to Consolidate" + - "Motion to Correct and Certify Record on Appeal" + - "Motion to Correct Clerical Order" + - "Motion to Correct Transcript" + - "Motion to Depose Pursuant to Rule 74" + - "Motion to Determine the Tax Matters Partner" + - "Motion to Dismiss" + - "Motion to Dismiss for Failure to Properly Prosecute" + - "Motion to Dismiss for Failure to State a Claim upon Which Relief Can Be Granted" + - "Motion to Dismiss for Lack of Jurisdiction as to [person, notice, or year]" + - "Motion to Dismiss on Grounds of Mootness" + - "Motion to Disqualify Counsel" + - "Motion to Enforce a Refund of Overpayment Pursuant to Rule 260" + - "Motion to Enforce Subpoena" + - "Motion to Extend Time to Move or File Answer" + - "Motion to Impose a Penalty" + - "Motion to Impose Sanctions" + - "Motion to Modify Decision in Estate Tax Case Pursuant to Rule 262" + - "Motion to Modify Order" + - "Motion to Permit Expert Witness to Testify without a Written Report Regarding Industry Practice Pursuant to Rule 143(g)(3)" + - "Motion to Permit Levy" + - "Motion to Preclude" + - "Motion to Quash or Modify Subpoena" + - "Motion to Redetermine Interest Pursuant to Rule 261" + - "Motion to Remand" + - "Motion to Remove Lien/Levy Designation" + - "Motion to Remove Small Tax Case Designation" + - "Motion to Remove Tax Matters Partner" + - "Motion to Reopen the Record" + - "Motion to Require Petitioner to File a Reply in a Small Tax Case Pursuant to Rule 173(c)" + - "Motion to Restore Case to the General Docket" + - "Motion to Restrain Assessment or Collection or to Order Refund of Amount Collected" + - "Motion to Retain File in Estate Tax Case Involving § 6166 Election Pursuant to Rule 157" + - "Motion to Review the Sufficiency of Answers or Objections to Request for Admissions" + - "Motion to Seal" + - "Motion to Set for a Time & Date Certain" + - "Motion to Set Pretrial Scheduling Order" + - "Motion to Sever" + - "Motion to Shift the Burden of Proof" + - "Motion to Shorten the Time" + - "Motion to Stay Proceedings" + - "Motion to Stay Proposed Sale of Seized Property" + - "Motion to Strike" + - "Motion to Submit Case Pursuant to Rule 122" + - "Motion to Substitute Parties and Change Caption" + - "Motion to Substitute Trial Exhibit(s)" + - "Motion to Supplement the Record" + - "Motion to Suppress Evidence" + - "Motion to Take Deposition Pursuant to Rule 74(c)(3)" + - "Motion to Take Judicial Notice" + - "Motion to Vacate" + - "Motion to Vacate or Revise Pursuant to Rule 162" + - "Motion to Withdraw" + - "Motion to Withdraw or Modify the Deemed Admitted Admissions Pursuant to Rule 90(f)" + - "Notice of Abatement of Jeopardy Assessment" + - "Notice of Appeal" + - "Notice of Change of Address" + - "Notice of Change of Address and Telephone Number" + - "Notice of Change of Telephone Number" + - "Notice of Clarification of Tax Matters Partner" + - "Notice of Concession" + - "Notice of Consistent Agreement Pursuant to Rule 248(c)(1)" + - "Notice of Death of Counsel" + - "Notice of Filing of Petition and Right to Intervene" + - "Notice of Filing of the Administrative Record" + - "Notice of Identification of Tax Matters Partner" + - "Notice of Intent Not to File" + - "Notice of Issue Concerning Foreign Law" + - "Notice of Jeopardy Assessment" + - "Notice of Judicial Ruling" + - "Notice of No Objection" + - "Notice of Objection" + - "Notice of Partial Abatement of Jeopardy Assessment" + - "Notice of Proceeding in Bankruptcy" + - "Notice of Relevant Judicial Decisions" + - "Notice of Settlement Agreement Pursuant to Rule 248(c)(1)" + - "Notice of Small Tax Case Election" + - "Notice of Supplemental Authority" + - "Notice of Telephone Number" + - "Notice of Termination Assessment" + - "Notice of Unavailability" + - "Redacted Petition Filed" + - "Prehearing Memorandum" + - "Pretrial Memorandum" + - "Reply" + - "Sur-Reply" + - "Request for Admissions" + - "Request for Judicial Notice" + - "Request for Pretrial Conference" + - "No Objection" + - "Objection" + - "Opposition" + - "Response" + - "Seriatim Answering Brief" + - "Seriatim Answering Memorandum Brief" + - "Seriatim Opening Brief" + - "Seriatim Opening Memorandum Brief" + - "Seriatim Reply Brief" + - "Seriatim Reply Memorandum Brief" + - "Seriatim Sur-Reply Brief" + - "Seriatim Sur-Reply Memorandum Brief" + - "Simultaneous Answering Brief" + - "Simultaneous Answering Memoranda of Law" + - "Simultaneous Answering Memorandum Brief" + - "Simultaneous Memoranda of Law" + - "Simultaneous Opening Brief" + - "Simultaneous Opening Memorandum Brief" + - "Simultaneous Reply Brief" + - "Simultaneous Supplemental Brief" + - "Simultaneous Sur-Reply Brief" + - "Simultaneous Sur-Reply Memorandum Brief" + - "Statement" + - "Statement of Redacted Information" + - "Statement under Rule 212" + - "Statement under Rule 50(c)" + - "Settlement Stipulation" + - "Stipulation" + - "Stipulation as to the Administrative Record" + - "Stipulation as to the Partial Administrative Record" + - "Stipulation of Facts" + - "Stipulation of Pretrial Deadlines" + - "Stipulation of Settled Issues" + - "Stipulation of Settlement" + - "Stipulation to Be Bound" + - "Stipulation to Take Deposition" + - "Supplement" + - "Supplemental" + - "Affidavit in Support" + - "Brief in Support" + - "Declaration in Support" + - "Memorandum in Support" + - "Unsworn Declaration under Penalty of Perjury in Support" + - "Application" + - "Application for Examination Pursuant to Rule 73" + - "Amended [Document Name]" + - "Appellate Filing Fee Received" + - "Bond" + - "Bounced Electronic Service" + - "Evidence" + - "Hearing Exhibits" + - "Letter" + - "Miscellaneous" + - "Miscellaneous (Lodged)" + - "Reference List of Redacted Information" + - "Returned Mail" + - "Trial Exhibits" + - "U.S.C.A. [Anything]" + - "Motion" + - "Motion for Review By the Full Court" + - "Motion for Review En Banc" + - "Motion to Be Exempt from E-Filing" + - "Motion to Change Place of Hearing of Disclosure Case" + - "Motion to File Document Under Seal" + - "Motion to Intervene" + - "Motion to Proceed Anonymously" + - "Notice" + - "Notice of Change of Counsel for Non-Party" + - "Notice of Election to Intervene" + - "Notice of Election to Participate" + - "Notice of Intervention" + - "Ratification of Petition" + - "Request" + - "Objection [anything]" + - "Opposition [anything]" + - "Response [anything]" + - "Supplement To [anything]" + - "Supplemental [anything]" + - "Order" + - "Order of Dismissal for Lack of Jurisdiction" + - "Order of Dismissal" + - "Order of Dismissal and Decision" + - "Order to Show Cause" + - "Order and Decision" + - "Decision" + - "O - Order" + - "OAJ - Order that case is assigned" + - "OAL - Order that the letter \"L\" is added to Docket number" + - "OAP - Order for Amended Petition" + - "OAPF - Order for Amended Petition and Filing Fee" + - "OAR - Order that the letter \"R\" is added to the Docket number" + - "OAS - Order that the letter \"S\" is added to the Docket number" + - "OASL - Order that the letters \"SL\" are added to the Docket number" + - "OAW - Order that the letter \"W\" is added to the Docket number" + - "OAX - Order that the letter \"X\" is added to the Docket number" + - "OCA - Order that caption of case is amended" + - "OD - Order of Dismissal Entered" + - "ODD - Order of Dismissal and Decision Entered" + - "ODL - Order that the letter \"L\" is deleted from the Docket number" + - "ODP - Order that the letter \"P\" is deleted from the Docket number" + - "ODR - Order that the letter \"R\" is deleted from the Docket number" + - "ODS - Order that the letter \"S\" is deleted from the Docket number" + - "ODSL - Order that the letters \"SL\" are deleted from the Docket number" + - "ODW - Order that the letter \"W\" is deleted from the Docket number" + - "ODX - Order that the letter \"X\" is deleted from the Docket number" + - "OF - Order for Filing Fee" + - "OFAB - Order fixing amount of bond" + - "OFFX - Order time is extended for petr(s) to pay the filing fee" + - "OFWD - Order for Filing Fee. Application waiver of Filing Fee is denied." + - "OFX - Order time is extended for petr(s) to pay filing fee or submit an Application for Waiver of Filing fee" + - "OIP - Order that the letter \"P\" is added to the Docket number" + - "OJR - Order that jurisdiction is retained" + - "OODS - Order for Ownership Disclosure Statement" + - "OPFX - Order time is extended for petr(s) to file Amended Petition and pay the Filing Fee or submit an Application for Waiver of Filing Fee" + - "OPX - Order time is extended for petr(s) to file Amended Petition" + - "ORAP - Order for Amendment to Petition" + - "OROP - Order for Ratification of Petition" + - "OSC - Order" + - "OSCP - Order petr(s) to show cause why \"S\" should not be removed" + - "OST - Order of Service of Transcript (Bench Opinion)" + - "OSUB - Order that case is submitted" + - "DEC - Decision Entered," + - "OAD - Order and Decision Entered," + - "ODJ - Order of Dismissal for Lack of Jurisdiction Entered," + - "SDEC - Stipulated Decision Entered," + - "MOP - Memorandum Opinion" + - "NOT - Notice" + - "Summary Opinion" + - "Writ of Habeas Corpus Ad Testificandum" + - "CTRA - Corrected Transcript" + - "FTRL - Further Trial before ..." + - "HEAR - Hearing before ..." + - "NTD - Notice of Trial" + - "PTRL - Partial Trial before ..." + - "TRL - Trial before ..." + - "ROA - Record on Appeal" + - "TCOP - T.C. Opinion" + - "RTRA - Revised Transcript" + - "TRAN - Transcript" + - "SPTO - Standing Pre-Trial Order" + - "MISC - Miscellaneous" + - "Stipulated Decision" + - "Notice of Docket Change" + - "Notice of Trial" + - "Standing Pretrial Notice" + - "Standing Pretrial Order" + draftState: + type: "object" + flags: + presence: "optional" + allow: + - null + entityName: + type: "string" + flags: + only: true + presence: "required" + allow: + - "Document" + eventCode: + type: "string" + flags: + presence: "optional" + filedBy: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 500 + allow: + - "" + filingDate: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "required" + description: "Date that this Document was filed." + rules: + - + name: "max" + args: + date: "now" + freeText: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 500 + freeText2: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 500 + hasSupportingDocuments: + type: "boolean" + flags: + presence: "optional" + isFileAttached: + type: "boolean" + flags: + presence: "optional" + isPaper: + type: "boolean" + flags: + presence: "optional" + judge: + type: "string" + flags: + presence: "optional" + description: "The judge associated with the document." + allow: + - null + lodged: + type: "boolean" + flags: + presence: "optional" + description: "A lodged document is awaiting action by the judge to enact or refuse." + numberOfPages: + type: "number" + flags: + presence: "optional" + allow: + - null + objections: + type: "string" + flags: + only: true + presence: "optional" + allow: + - "No" + - "Yes" + - "Unknown" + ordinalValue: + type: "string" + flags: + presence: "optional" + partyIrsPractitioner: + type: "boolean" + flags: + presence: "optional" + partyPrimary: + type: "boolean" + flags: + presence: "optional" + description: "Use the primary contact to compose the filedBy text." + partySecondary: + type: "boolean" + flags: + presence: "optional" + description: "Use the secondary contact to compose the filedBy text." + pending: + type: "boolean" + flags: + presence: "optional" + previousDocument: + type: "object" + flags: + presence: "optional" + privatePractitioners: + type: "array" + flags: + presence: "optional" + description: "Practitioner names to be used to compose the filedBy text." + items: + - + type: "object" + keys: + name: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 500 + processingStatus: + type: "string" + flags: + presence: "optional" + qcAt: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "optional" + qcByUserId: + type: "string" + flags: + presence: "optional" + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + allow: + - null + receivedAt: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "optional" + relationship: + type: "string" + flags: + only: true + presence: "optional" + allow: + - "primaryDocument" + - "primarySupportingDocument" + - "secondaryDocument" + - "secondarySupportingDocument" + - "supportingDocument" + scenario: + type: "string" + flags: + only: true + presence: "optional" + allow: + - "Standard" + - "Nonstandard A" + - "Nonstandard B" + - "Nonstandard C" + - "Nonstandard D" + - "Nonstandard E" + - "Nonstandard F" + - "Nonstandard G" + - "Nonstandard H" + - "Type A" + - "Type B" + - "Type C" + - "Type D" + - "Type E" + - "Type F" + - "Type G" + - "Type H" + secondaryDate: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "optional" + description: "A secondary date associated with the document, typically related to time-restricted availability." + servedAt: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "optional" + description: "When the document is served on the parties." + servedParties: + type: "array" + flags: + presence: "optional" + items: + - + type: "object" + keys: + name: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 500 + serviceDate: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "optional" + description: "Certificate of service date." + rules: + - + name: "max" + args: + date: "now" + allow: + - null + serviceStamp: + type: "string" + flags: + presence: "optional" + signedAt: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "optional" + allow: + - null + signedByUserId: + type: "string" + flags: + presence: "optional" + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + allow: + - null + signedJudgeName: + type: "string" + flags: + presence: "optional" + allow: + - null + supportingDocument: + type: "string" + flags: + presence: "optional" + allow: + - null + trialLocation: + type: "string" + flags: + presence: "optional" + description: "An optional trial location used when generating a fully concatenated document title." + allow: + - null + userId: + type: "string" + flags: + presence: "required" + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + workItems: + type: "array" + flags: + presence: "optional" + + ``` diff --git a/docs/entities/ForwardMessage.md b/docs/entities/ForwardMessage.md new file mode 100644 index 00000000000..e92aa17e980 --- /dev/null +++ b/docs/entities/ForwardMessage.md @@ -0,0 +1,71 @@ +# ForwardMessage + ``` +--- + type: "object" + keys: + assigneeId: + type: "string" + flags: + presence: "required" + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + forwardMessage: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 500 + section: + type: "string" + flags: + only: true + presence: "required" + allow: + - "adc" + - "admissions" + - "chambers" + - "clerkofcourt" + - "docket" + - "petitions" + - "trialClerks" + - "armensChambers" + - "ashfordsChambers" + - "buchsChambers" + - "carluzzosChambers" + - "cohensChambers" + - "colvinsChambers" + - "copelandsChambers" + - "foleysChambers" + - "galesChambers" + - "gerbersChambers" + - "goekesChambers" + - "gustafsonsChambers" + - "guysChambers" + - "halpernsChambers" + - "holmesChambers" + - "jacobsChambers" + - "jonesChambers" + - "kerrigansChambers" + - "laubersChambers" + - "leydensChambers" + - "marvelsChambers" + - "morrisonsChambers" + - "negasChambers" + - "panuthosChambers" + - "parisChambers" + - "pughsChambers" + - "ruwesChambers" + - "thorntonsChambers" + - "urdasChambers" + - "vasquezsChambers" + - "wellsChambers" + + ``` diff --git a/docs/entities/InitialWorkItemMessage.md b/docs/entities/InitialWorkItemMessage.md new file mode 100644 index 00000000000..31deb7a24cb --- /dev/null +++ b/docs/entities/InitialWorkItemMessage.md @@ -0,0 +1,71 @@ +# InitialWorkItemMessage + ``` +--- + type: "object" + keys: + assigneeId: + type: "string" + flags: + presence: "required" + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + message: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 500 + section: + type: "string" + flags: + only: true + presence: "required" + allow: + - "adc" + - "admissions" + - "chambers" + - "clerkofcourt" + - "docket" + - "petitions" + - "trialClerks" + - "armensChambers" + - "ashfordsChambers" + - "buchsChambers" + - "carluzzosChambers" + - "cohensChambers" + - "colvinsChambers" + - "copelandsChambers" + - "foleysChambers" + - "galesChambers" + - "gerbersChambers" + - "goekesChambers" + - "gustafsonsChambers" + - "guysChambers" + - "halpernsChambers" + - "holmesChambers" + - "jacobsChambers" + - "jonesChambers" + - "kerrigansChambers" + - "laubersChambers" + - "leydensChambers" + - "marvelsChambers" + - "morrisonsChambers" + - "negasChambers" + - "panuthosChambers" + - "parisChambers" + - "pughsChambers" + - "ruwesChambers" + - "thorntonsChambers" + - "urdasChambers" + - "vasquezsChambers" + - "wellsChambers" + + ``` diff --git a/docs/entities/IrsPractitioner.md b/docs/entities/IrsPractitioner.md new file mode 100644 index 00000000000..ec6cf19287c --- /dev/null +++ b/docs/entities/IrsPractitioner.md @@ -0,0 +1,288 @@ +# IrsPractitioner + ``` +--- + type: "object" + keys: + barNumber: + type: "string" + flags: + presence: "optional" + allow: + - null + contact: + type: "object" + flags: + presence: "optional" + keys: + address1: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 100 + address2: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + allow: + - null + address3: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + allow: + - null + city: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 100 + countryType: + type: "string" + flags: + only: true + presence: "required" + allow: + - "domestic" + - "international" + country: + type: "any" + whens: + - + ref: + path: + - "countryType" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "international" + then: + type: "string" + flags: + presence: "required" + otherwise: + type: "string" + flags: + presence: "optional" + allow: + - null + phone: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 100 + postalCode: + type: "any" + whens: + - + ref: + path: + - "countryType" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "international" + then: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 100 + otherwise: + type: "string" + flags: + presence: "required" + rules: + - + name: "pattern" + args: + regex: "/^(\\d{5}|\\d{5}-\\d{4})$/" + state: + type: "any" + whens: + - + ref: + path: + - "countryType" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "international" + then: + type: "string" + flags: + presence: "optional" + allow: + - null + otherwise: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 100 + email: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + entityName: + type: "string" + flags: + only: true + presence: "required" + allow: + - "IrsPractitioner" + section: + type: "string" + flags: + presence: "optional" + token: + type: "string" + flags: + presence: "optional" + userId: + type: "string" + flags: + presence: "required" + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + name: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + role: + type: "string" + flags: + only: true + presence: "required" + allow: + - "irsPractitioner" + judgeFullName: + type: "any" + whens: + - + ref: + path: + - "role" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "judge" + then: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + otherwise: + type: "any" + flags: + presence: "optional" + allow: + - null + judgeTitle: + type: "any" + whens: + - + ref: + path: + - "role" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "judge" + then: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + otherwise: + type: "any" + flags: + presence: "optional" + allow: + - null + serviceIndicator: + type: "string" + flags: + only: true + presence: "required" + allow: + - "Electronic" + - "None" + - "Paper" + + ``` diff --git a/docs/entities/Message.md b/docs/entities/Message.md new file mode 100644 index 00000000000..e5e169b6d02 --- /dev/null +++ b/docs/entities/Message.md @@ -0,0 +1,85 @@ +# Message + ``` +--- + type: "object" + keys: + createdAt: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "optional" + entityName: + type: "string" + flags: + only: true + presence: "required" + allow: + - "Message" + from: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 100 + fromUserId: + type: "string" + flags: + presence: "required" + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + message: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 500 + messageId: + type: "string" + flags: + presence: "required" + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + to: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + allow: + - null + toUserId: + type: "string" + flags: + presence: "optional" + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + allow: + - null + + ``` diff --git a/docs/entities/NewCaseMessage.md b/docs/entities/NewCaseMessage.md new file mode 100644 index 00000000000..c50fef4ea11 --- /dev/null +++ b/docs/entities/NewCaseMessage.md @@ -0,0 +1,93 @@ +# NewCaseMessage + ``` +--- + type: "object" + keys: + entityName: + type: "string" + flags: + only: true + presence: "required" + allow: + - "NewCaseMessage" + message: + type: "string" + flags: + presence: "required" + description: "The message text." + rules: + - + name: "max" + args: + limit: 500 + subject: + type: "string" + flags: + presence: "required" + description: "The subject line of the message." + rules: + - + name: "max" + args: + limit: 250 + toSection: + type: "string" + flags: + only: true + presence: "required" + description: "The section of the user who is the recipient of the message." + allow: + - "adc" + - "admissions" + - "chambers" + - "clerkofcourt" + - "docket" + - "petitions" + - "trialClerks" + - "armensChambers" + - "ashfordsChambers" + - "buchsChambers" + - "carluzzosChambers" + - "cohensChambers" + - "colvinsChambers" + - "copelandsChambers" + - "foleysChambers" + - "galesChambers" + - "gerbersChambers" + - "goekesChambers" + - "gustafsonsChambers" + - "guysChambers" + - "halpernsChambers" + - "holmesChambers" + - "jacobsChambers" + - "jonesChambers" + - "kerrigansChambers" + - "laubersChambers" + - "leydensChambers" + - "marvelsChambers" + - "morrisonsChambers" + - "negasChambers" + - "panuthosChambers" + - "parisChambers" + - "pughsChambers" + - "ruwesChambers" + - "thorntonsChambers" + - "urdasChambers" + - "vasquezsChambers" + - "wellsChambers" + toUserId: + type: "string" + flags: + presence: "required" + description: "The ID of the user who is the recipient of the message." + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + allow: + - null + + ``` diff --git a/docs/entities/NewPractitioner.md b/docs/entities/NewPractitioner.md new file mode 100644 index 00000000000..c11a5684f2f --- /dev/null +++ b/docs/entities/NewPractitioner.md @@ -0,0 +1,398 @@ +# NewPractitioner + ``` +--- + type: "object" + keys: + barNumber: + type: "string" + flags: + presence: "optional" + allow: + - null + contact: + type: "object" + flags: + presence: "optional" + keys: + address1: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 100 + address2: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + allow: + - null + address3: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + allow: + - null + city: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 100 + countryType: + type: "string" + flags: + only: true + presence: "required" + allow: + - "domestic" + - "international" + country: + type: "any" + whens: + - + ref: + path: + - "countryType" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "international" + then: + type: "string" + flags: + presence: "required" + otherwise: + type: "string" + flags: + presence: "optional" + allow: + - null + phone: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 100 + postalCode: + type: "any" + whens: + - + ref: + path: + - "countryType" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "international" + then: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 100 + otherwise: + type: "string" + flags: + presence: "required" + rules: + - + name: "pattern" + args: + regex: "/^(\\d{5}|\\d{5}-\\d{4})$/" + state: + type: "any" + whens: + - + ref: + path: + - "countryType" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "international" + then: + type: "string" + flags: + presence: "optional" + allow: + - null + otherwise: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 100 + email: + type: "string" + flags: + presence: "required" + entityName: + type: "string" + flags: + only: true + presence: "required" + allow: + - "Practitioner" + section: + type: "string" + flags: + presence: "optional" + token: + type: "string" + flags: + presence: "optional" + userId: + type: "string" + flags: + presence: "optional" + allow: + - null + name: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + role: + type: "string" + flags: + presence: "optional" + allow: + - null + judgeFullName: + type: "any" + whens: + - + ref: + path: + - "role" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "judge" + then: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + otherwise: + type: "any" + flags: + presence: "optional" + allow: + - null + judgeTitle: + type: "any" + whens: + - + ref: + path: + - "role" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "judge" + then: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + otherwise: + type: "any" + flags: + presence: "optional" + allow: + - null + additionalPhone: + type: "string" + flags: + presence: "optional" + description: "An alternate phone number for the practitioner." + rules: + - + name: "max" + args: + limit: 100 + allow: + - null + admissionsDate: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "required" + description: "The date the practitioner was admitted to the Tax Court bar." + rules: + - + name: "max" + args: + date: "now" + admissionsStatus: + type: "string" + flags: + presence: "required" + alternateEmail: + type: "string" + flags: + presence: "optional" + description: "An alternate email address for the practitioner." + rules: + - + name: "max" + args: + limit: 100 + allow: + - null + birthYear: + type: "number" + flags: + presence: "required" + description: "The year the practitioner was born." + rules: + - + name: "integer" + - + name: "min" + args: + limit: 1900 + - + name: "max" + args: + limit: 2020 + employer: + type: "string" + flags: + only: true + presence: "required" + description: "The employer designation for the practitioner." + allow: + - "IRS" + - "DOJ" + - "Private" + firmName: + type: "string" + flags: + presence: "optional" + description: "The firm name for the practitioner." + rules: + - + name: "max" + args: + limit: 100 + allow: + - null + firstName: + type: "string" + flags: + presence: "required" + lastName: + type: "string" + flags: + presence: "required" + middleName: + type: "string" + flags: + presence: "optional" + description: "The optional middle name of the practitioner." + rules: + - + name: "max" + args: + limit: 100 + allow: + - null + originalBarState: + type: "string" + flags: + presence: "required" + description: "The state in which the practitioner passed their bar examination." + rules: + - + name: "max" + args: + limit: 100 + practitionerType: + type: "string" + flags: + only: true + presence: "required" + description: "The type of practitioner - either Attorney or Non-Attorney." + allow: + - "Attorney" + - "Non-Attorney" + suffix: + type: "string" + flags: + presence: "optional" + description: "The name suffix of the practitioner." + rules: + - + name: "max" + args: + limit: 100 + allow: + - "" + + ``` diff --git a/docs/entities/Note.md b/docs/entities/Note.md new file mode 100644 index 00000000000..0aa5fa058b2 --- /dev/null +++ b/docs/entities/Note.md @@ -0,0 +1,11 @@ +# Note + ``` +--- + type: "object" + keys: + notes: + type: "string" + flags: + presence: "required" + + ``` diff --git a/docs/entities/Order.md b/docs/entities/Order.md new file mode 100644 index 00000000000..a4e5f62d935 --- /dev/null +++ b/docs/entities/Order.md @@ -0,0 +1,33 @@ +# Order + ``` +--- + type: "object" + keys: + documentTitle: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 100 + documentType: + type: "string" + flags: + presence: "required" + eventCode: + type: "string" + flags: + presence: "optional" + orderBody: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 500 + + ``` diff --git a/docs/entities/OrderWithoutBody.md b/docs/entities/OrderWithoutBody.md new file mode 100644 index 00000000000..603ebcb8622 --- /dev/null +++ b/docs/entities/OrderWithoutBody.md @@ -0,0 +1,19 @@ +# OrderWithoutBody + ``` +--- + type: "object" + keys: + documentTitle: + type: "string" + flags: + presence: "required" + documentType: + type: "string" + flags: + presence: "required" + eventCode: + type: "string" + flags: + presence: "required" + + ``` diff --git a/docs/entities/Practitioner.md b/docs/entities/Practitioner.md new file mode 100644 index 00000000000..f777ee6bf1b --- /dev/null +++ b/docs/entities/Practitioner.md @@ -0,0 +1,455 @@ +# Practitioner + ``` +--- + type: "object" + keys: + barNumber: + type: "string" + flags: + presence: "required" + description: "A unique identifier comprising of the practitioner initials, date, and series number." + rules: + - + name: "max" + args: + limit: 100 + contact: + type: "object" + flags: + presence: "optional" + keys: + address1: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 100 + address2: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + allow: + - null + address3: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + allow: + - null + city: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 100 + countryType: + type: "string" + flags: + only: true + presence: "required" + allow: + - "domestic" + - "international" + country: + type: "any" + whens: + - + ref: + path: + - "countryType" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "international" + then: + type: "string" + flags: + presence: "required" + otherwise: + type: "string" + flags: + presence: "optional" + allow: + - null + phone: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 100 + postalCode: + type: "any" + whens: + - + ref: + path: + - "countryType" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "international" + then: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 100 + otherwise: + type: "string" + flags: + presence: "required" + rules: + - + name: "pattern" + args: + regex: "/^(\\d{5}|\\d{5}-\\d{4})$/" + state: + type: "any" + whens: + - + ref: + path: + - "countryType" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "international" + then: + type: "string" + flags: + presence: "optional" + allow: + - null + otherwise: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 100 + email: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + entityName: + type: "string" + flags: + only: true + presence: "required" + allow: + - "Practitioner" + section: + type: "string" + flags: + presence: "optional" + token: + type: "string" + flags: + presence: "optional" + userId: + type: "string" + flags: + presence: "required" + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + name: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + role: + type: "alternatives" + matches: + - + ref: + path: + - "admissionsStatus" + is: + type: "any" + flags: + only: true + allow: + - "Active" + then: + type: "string" + flags: + only: true + presence: "required" + allow: + - "irsPractitioner" + - "privatePractitioner" + otherwise: + type: "string" + flags: + only: true + presence: "required" + allow: + - "inactivePractitioner" + judgeFullName: + type: "any" + whens: + - + ref: + path: + - "role" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "judge" + then: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + otherwise: + type: "any" + flags: + presence: "optional" + allow: + - null + judgeTitle: + type: "any" + whens: + - + ref: + path: + - "role" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "judge" + then: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + otherwise: + type: "any" + flags: + presence: "optional" + allow: + - null + additionalPhone: + type: "string" + flags: + presence: "optional" + description: "An alternate phone number for the practitioner." + rules: + - + name: "max" + args: + limit: 100 + allow: + - null + admissionsDate: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "required" + description: "The date the practitioner was admitted to the Tax Court bar." + rules: + - + name: "max" + args: + date: "now" + admissionsStatus: + type: "string" + flags: + only: true + presence: "required" + description: "The Tax Court bar admission status for the practitioner." + allow: + - "Active" + - "Suspended" + - "Disbarred" + - "Resigned" + - "Deceased" + - "Inactive" + alternateEmail: + type: "string" + flags: + presence: "optional" + description: "An alternate email address for the practitioner." + rules: + - + name: "max" + args: + limit: 100 + allow: + - null + birthYear: + type: "number" + flags: + presence: "required" + description: "The year the practitioner was born." + rules: + - + name: "integer" + - + name: "min" + args: + limit: 1900 + - + name: "max" + args: + limit: 2020 + employer: + type: "string" + flags: + only: true + presence: "required" + description: "The employer designation for the practitioner." + allow: + - "IRS" + - "DOJ" + - "Private" + firmName: + type: "string" + flags: + presence: "optional" + description: "The firm name for the practitioner." + rules: + - + name: "max" + args: + limit: 100 + allow: + - null + firstName: + type: "string" + flags: + presence: "required" + description: "The first name of the practitioner." + rules: + - + name: "max" + args: + limit: 100 + lastName: + type: "string" + flags: + presence: "required" + description: "The last name of the practitioner." + rules: + - + name: "max" + args: + limit: 100 + middleName: + type: "string" + flags: + presence: "optional" + description: "The optional middle name of the practitioner." + rules: + - + name: "max" + args: + limit: 100 + allow: + - null + originalBarState: + type: "string" + flags: + presence: "required" + description: "The state in which the practitioner passed their bar examination." + rules: + - + name: "max" + args: + limit: 100 + practitionerType: + type: "string" + flags: + only: true + presence: "required" + description: "The type of practitioner - either Attorney or Non-Attorney." + allow: + - "Attorney" + - "Non-Attorney" + suffix: + type: "string" + flags: + presence: "optional" + description: "The name suffix of the practitioner." + rules: + - + name: "max" + args: + limit: 100 + allow: + - "" + + ``` diff --git a/docs/entities/PrivatePractitioner.md b/docs/entities/PrivatePractitioner.md new file mode 100644 index 00000000000..4a7fa446fbc --- /dev/null +++ b/docs/entities/PrivatePractitioner.md @@ -0,0 +1,296 @@ +# PrivatePractitioner + ``` +--- + type: "object" + keys: + barNumber: + type: "string" + flags: + presence: "optional" + allow: + - null + contact: + type: "object" + flags: + presence: "optional" + keys: + address1: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 100 + address2: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + allow: + - null + address3: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + allow: + - null + city: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 100 + countryType: + type: "string" + flags: + only: true + presence: "required" + allow: + - "domestic" + - "international" + country: + type: "any" + whens: + - + ref: + path: + - "countryType" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "international" + then: + type: "string" + flags: + presence: "required" + otherwise: + type: "string" + flags: + presence: "optional" + allow: + - null + phone: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 100 + postalCode: + type: "any" + whens: + - + ref: + path: + - "countryType" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "international" + then: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 100 + otherwise: + type: "string" + flags: + presence: "required" + rules: + - + name: "pattern" + args: + regex: "/^(\\d{5}|\\d{5}-\\d{4})$/" + state: + type: "any" + whens: + - + ref: + path: + - "countryType" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "international" + then: + type: "string" + flags: + presence: "optional" + allow: + - null + otherwise: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 100 + email: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + entityName: + type: "string" + flags: + only: true + presence: "required" + allow: + - "PrivatePractitioner" + section: + type: "string" + flags: + presence: "optional" + token: + type: "string" + flags: + presence: "optional" + userId: + type: "string" + flags: + presence: "required" + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + name: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + role: + type: "string" + flags: + presence: "required" + only: true + allow: + - "privatePractitioner" + judgeFullName: + type: "any" + whens: + - + ref: + path: + - "role" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "judge" + then: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + otherwise: + type: "any" + flags: + presence: "optional" + allow: + - null + judgeTitle: + type: "any" + whens: + - + ref: + path: + - "role" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "judge" + then: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + otherwise: + type: "any" + flags: + presence: "optional" + allow: + - null + representingPrimary: + type: "boolean" + flags: + presence: "optional" + representingSecondary: + type: "boolean" + flags: + presence: "optional" + serviceIndicator: + type: "string" + flags: + only: true + presence: "required" + allow: + - "Electronic" + - "None" + - "Paper" + + ``` diff --git a/docs/entities/PublicUser.md b/docs/entities/PublicUser.md new file mode 100644 index 00000000000..75616048dcf --- /dev/null +++ b/docs/entities/PublicUser.md @@ -0,0 +1,99 @@ +# PublicUser + ``` +--- + type: "object" + keys: + name: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + role: + type: "string" + flags: + only: true + presence: "required" + allow: + - "adc" + - "admin" + - "admissionsclerk" + - "chambers" + - "clerkofcourt" + - "docketclerk" + - "floater" + - "inactivePractitioner" + - "irsPractitioner" + - "irsSuperuser" + - "judge" + - "petitioner" + - "petitionsclerk" + - "privatePractitioner" + - "trialclerk" + judgeFullName: + type: "any" + whens: + - + ref: + path: + - "role" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "judge" + then: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + otherwise: + type: "any" + flags: + presence: "optional" + allow: + - null + judgeTitle: + type: "any" + whens: + - + ref: + path: + - "role" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "judge" + then: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + otherwise: + type: "any" + flags: + presence: "optional" + allow: + - null + + ``` diff --git a/docs/entities/Scan.md b/docs/entities/Scan.md new file mode 100644 index 00000000000..93c44d0c231 --- /dev/null +++ b/docs/entities/Scan.md @@ -0,0 +1,34 @@ +# Scan + ``` +--- + type: "object" + keys: + batches: + type: "array" + flags: + presence: "required" + rules: + - + name: "min" + args: + limit: 1 + createdAt: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "required" + scanId: + type: "string" + flags: + presence: "required" + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + + ``` diff --git a/docs/entities/Statistic.md b/docs/entities/Statistic.md index cd69127b663..220a0037686 100644 --- a/docs/entities/Statistic.md +++ b/docs/entities/Statistic.md @@ -1,71 +1,170 @@ # Statistic - -### deficiencyAmount - - -The amount of the deficiency. - -> `number` | optional - -##### Can be null. - -### entityName - -> `string` | required - -##### Can be Statistic. - -### lastDateOfPeriod - - -Last date of the statistics period. - -> `date` | optional - -##### Maximum date - - -`now` - -##### Can be null. - -### totalPenalties - - -The total amount of penalties for the period or year. - -> `number` | optional - -##### Can be null. - -### year - - -The year of the statistics period. - -> `number` | optional - -##### Minimum limit - - -`1900` - -##### Maximum limit - - -`2020` - -##### Can be null. - -### yearOrPeriod - - -Whether the statistics are for a year or period. - -> `string` | required - -##### Allowed Values - - - - `Year` - - `Period` + ``` +--- + type: "object" + keys: + determinationDeficiencyAmount: + type: "alternatives" + flags: + description: "The amount of the deficiency determined by the Court." + matches: + - + ref: + path: + - "determinationTotalPenalties" + is: + type: "any" + flags: + presence: "required" + invalid: + - null + then: + type: "number" + flags: + presence: "required" + otherwise: + type: "number" + flags: + presence: "optional" + allow: + - null + determinationTotalPenalties: + type: "alternatives" + flags: + description: "The total amount of penalties for the period or year determined by the Court." + matches: + - + ref: + path: + - "determinationDeficiencyAmount" + is: + type: "any" + flags: + presence: "required" + invalid: + - null + then: + type: "number" + flags: + presence: "required" + otherwise: + type: "number" + flags: + presence: "optional" + allow: + - null + entityName: + type: "string" + flags: + only: true + presence: "required" + allow: + - "Statistic" + irsDeficiencyAmount: + type: "number" + flags: + presence: "required" + description: "The amount of the deficiency on the IRS notice." + irsTotalPenalties: + type: "number" + flags: + presence: "required" + description: "The total amount of penalties for the period or year on the IRS notice." + statisticId: + type: "string" + flags: + presence: "required" + description: "Unique statistic ID only used by the system." + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + yearOrPeriod: + type: "string" + flags: + presence: "required" + only: true + description: "Whether the statistics are for a year or period." + allow: + - "Year" + - "Period" + lastDateOfPeriod: + type: "any" + flags: + description: "Last date of the statistics period." + whens: + - + ref: + path: + - "yearOrPeriod" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "Period" + then: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "required" + rules: + - + name: "max" + args: + date: "now" + otherwise: + type: "any" + flags: + presence: "optional" + allow: + - null + year: + type: "any" + flags: + description: "The year of the statistics period." + whens: + - + ref: + path: + - "yearOrPeriod" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "Year" + then: + type: "number" + flags: + presence: "required" + rules: + - + name: "integer" + - + name: "min" + args: + limit: 1900 + - + name: "max" + args: + limit: 2020 + otherwise: + type: "any" + flags: + presence: "optional" + allow: + - null + + ``` diff --git a/docs/entities/User.md b/docs/entities/User.md new file mode 100644 index 00000000000..ae9319383af --- /dev/null +++ b/docs/entities/User.md @@ -0,0 +1,293 @@ +# User + ``` +--- + type: "object" + keys: + barNumber: + type: "string" + flags: + presence: "optional" + allow: + - null + contact: + type: "object" + flags: + presence: "optional" + keys: + address1: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 100 + address2: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + allow: + - null + address3: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + allow: + - null + city: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 100 + countryType: + type: "string" + flags: + only: true + presence: "required" + allow: + - "domestic" + - "international" + country: + type: "any" + whens: + - + ref: + path: + - "countryType" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "international" + then: + type: "string" + flags: + presence: "required" + otherwise: + type: "string" + flags: + presence: "optional" + allow: + - null + phone: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 100 + postalCode: + type: "any" + whens: + - + ref: + path: + - "countryType" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "international" + then: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 100 + otherwise: + type: "string" + flags: + presence: "required" + rules: + - + name: "pattern" + args: + regex: "/^(\\d{5}|\\d{5}-\\d{4})$/" + state: + type: "any" + whens: + - + ref: + path: + - "countryType" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "international" + then: + type: "string" + flags: + presence: "optional" + allow: + - null + otherwise: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 100 + email: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + entityName: + type: "string" + flags: + only: true + presence: "required" + allow: + - "User" + section: + type: "string" + flags: + presence: "optional" + token: + type: "string" + flags: + presence: "optional" + userId: + type: "string" + flags: + presence: "required" + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + name: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + role: + type: "string" + flags: + only: true + presence: "required" + allow: + - "adc" + - "admin" + - "admissionsclerk" + - "chambers" + - "clerkofcourt" + - "docketclerk" + - "floater" + - "inactivePractitioner" + - "irsPractitioner" + - "irsSuperuser" + - "judge" + - "petitioner" + - "petitionsclerk" + - "privatePractitioner" + - "trialclerk" + judgeFullName: + type: "any" + whens: + - + ref: + path: + - "role" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "judge" + then: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + otherwise: + type: "any" + flags: + presence: "optional" + allow: + - null + judgeTitle: + type: "any" + whens: + - + ref: + path: + - "role" + is: + type: "any" + flags: + only: true + presence: "required" + allow: + - + override: true + - "judge" + then: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + otherwise: + type: "any" + flags: + presence: "optional" + allow: + - null + + ``` diff --git a/docs/entities/UserCase.md b/docs/entities/UserCase.md new file mode 100644 index 00000000000..e1e0dbe9990 --- /dev/null +++ b/docs/entities/UserCase.md @@ -0,0 +1,79 @@ +# UserCase + ``` +--- + type: "object" + keys: + caseCaption: + type: "string" + flags: + presence: "required" + description: "The name of the party bringing the case, e.g. \"Carol Williams, Petitioner,\" \"Mark Taylor, Incompetent, Debra Thomas, Next Friend, Petitioner,\" or \"Estate of Test Taxpayer, Deceased, Petitioner.\" This is the first half of the case title." + rules: + - + name: "max" + args: + limit: 500 + caseId: + type: "string" + flags: + presence: "required" + description: "Unique case ID only used by the system." + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + docketNumber: + type: "string" + flags: + presence: "required" + description: "Unique case ID in XXXXX-YY format." + rules: + - + name: "pattern" + args: + regex: "/^([1-9]\\d{2,4}-\\d{2})$/" + docketNumberWithSuffix: + type: "string" + flags: + presence: "optional" + description: "Auto-generated from docket number and the suffix." + leadCaseId: + type: "string" + flags: + presence: "optional" + description: "If this case is consolidated, this is the ID of the lead case. It is the lowest docket number in the consolidated group." + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + status: + type: "string" + flags: + only: true + presence: "optional" + description: "Status of the case." + allow: + - "Assigned - Case" + - "Assigned - Motion" + - "Calendared" + - "CAV" + - "Closed" + - "General Docket - Not at Issue" + - "General Docket - At Issue (Ready for Trial)" + - "Jurisdiction Retained" + - "New" + - "On Appeal" + - "Rule 155" + - "Submitted" + metas: + - + tags: + - "Restricted" + + ``` diff --git a/docs/entities/UserCaseNote.md b/docs/entities/UserCaseNote.md new file mode 100644 index 00000000000..e23c719cdb7 --- /dev/null +++ b/docs/entities/UserCaseNote.md @@ -0,0 +1,40 @@ +# UserCaseNote + ``` +--- + type: "object" + keys: + caseId: + type: "string" + flags: + presence: "required" + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + entityName: + type: "string" + flags: + only: true + presence: "required" + allow: + - "UserCaseNote" + notes: + type: "string" + flags: + presence: "required" + userId: + type: "string" + flags: + presence: "required" + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + + ``` diff --git a/docs/entities/WorkItem.md b/docs/entities/WorkItem.md new file mode 100644 index 00000000000..c607e5e0342 --- /dev/null +++ b/docs/entities/WorkItem.md @@ -0,0 +1,356 @@ +# WorkItem + ``` +--- + type: "object" + keys: + assigneeId: + type: "string" + flags: + presence: "optional" + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + allow: + - null + assigneeName: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + allow: + - null + associatedJudge: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 100 + caseId: + type: "string" + flags: + presence: "required" + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + caseIsInProgress: + type: "boolean" + flags: + presence: "optional" + caseStatus: + type: "string" + flags: + only: true + presence: "optional" + allow: + - "Assigned - Case" + - "Assigned - Motion" + - "Calendared" + - "CAV" + - "Closed" + - "General Docket - Not at Issue" + - "General Docket - At Issue (Ready for Trial)" + - "Jurisdiction Retained" + - "New" + - "On Appeal" + - "Rule 155" + - "Submitted" + caseTitle: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 500 + completedAt: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "optional" + completedBy: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + allow: + - null + completedByUserId: + type: "string" + flags: + presence: "optional" + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + allow: + - null + completedMessage: + type: "string" + flags: + presence: "optional" + rules: + - + name: "max" + args: + limit: 100 + allow: + - null + createdAt: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "optional" + docketNumber: + type: "string" + flags: + presence: "required" + rules: + - + name: "pattern" + args: + regex: "/^([1-9]\\d{2,4}-\\d{2})$/" + docketNumberSuffix: + type: "string" + flags: + only: true + presence: "optional" + allow: + - "W" + - "P" + - "X" + - "R" + - "SL" + - "L" + - "S" + - null + document: + type: "object" + flags: + presence: "required" + entityName: + type: "string" + flags: + only: true + presence: "required" + allow: + - "WorkItem" + hideFromPendingMessages: + type: "boolean" + flags: + presence: "optional" + highPriority: + type: "boolean" + flags: + presence: "optional" + inProgress: + type: "boolean" + flags: + presence: "optional" + isInitializeCase: + type: "boolean" + flags: + presence: "optional" + isQC: + type: "boolean" + flags: + presence: "required" + isRead: + type: "boolean" + flags: + presence: "optional" + messages: + type: "array" + flags: + presence: "required" + items: + - + type: "object" + section: + type: "string" + flags: + only: true + presence: "required" + allow: + - "adc" + - "admissions" + - "chambers" + - "clerkofcourt" + - "docket" + - "petitions" + - "trialClerks" + - "armensChambers" + - "ashfordsChambers" + - "buchsChambers" + - "carluzzosChambers" + - "cohensChambers" + - "colvinsChambers" + - "copelandsChambers" + - "foleysChambers" + - "galesChambers" + - "gerbersChambers" + - "goekesChambers" + - "gustafsonsChambers" + - "guysChambers" + - "halpernsChambers" + - "holmesChambers" + - "jacobsChambers" + - "jonesChambers" + - "kerrigansChambers" + - "laubersChambers" + - "leydensChambers" + - "marvelsChambers" + - "morrisonsChambers" + - "negasChambers" + - "panuthosChambers" + - "parisChambers" + - "pughsChambers" + - "ruwesChambers" + - "thorntonsChambers" + - "urdasChambers" + - "vasquezsChambers" + - "wellsChambers" + - "admin" + - "admissionsclerk" + - "docketclerk" + - "floater" + - "inactivePractitioner" + - "irsPractitioner" + - "irsSuperuser" + - "judge" + - "petitioner" + - "petitionsclerk" + - "privatePractitioner" + - "trialclerk" + - "irsSystem" + sentBy: + type: "string" + flags: + presence: "required" + rules: + - + name: "max" + args: + limit: 100 + sentBySection: + type: "string" + flags: + only: true + presence: "optional" + allow: + - "adc" + - "admissions" + - "chambers" + - "clerkofcourt" + - "docket" + - "petitions" + - "trialClerks" + - "armensChambers" + - "ashfordsChambers" + - "buchsChambers" + - "carluzzosChambers" + - "cohensChambers" + - "colvinsChambers" + - "copelandsChambers" + - "foleysChambers" + - "galesChambers" + - "gerbersChambers" + - "goekesChambers" + - "gustafsonsChambers" + - "guysChambers" + - "halpernsChambers" + - "holmesChambers" + - "jacobsChambers" + - "jonesChambers" + - "kerrigansChambers" + - "laubersChambers" + - "leydensChambers" + - "marvelsChambers" + - "morrisonsChambers" + - "negasChambers" + - "panuthosChambers" + - "parisChambers" + - "pughsChambers" + - "ruwesChambers" + - "thorntonsChambers" + - "urdasChambers" + - "vasquezsChambers" + - "wellsChambers" + - "admin" + - "admissionsclerk" + - "docketclerk" + - "floater" + - "inactivePractitioner" + - "irsPractitioner" + - "irsSuperuser" + - "judge" + - "petitioner" + - "petitionsclerk" + - "privatePractitioner" + - "trialclerk" + sentByUserId: + type: "string" + flags: + presence: "optional" + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + trialDate: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "optional" + allow: + - null + updatedAt: + type: "date" + flags: + format: + - "YYYY-MM-DDTHH:mm:ss.SSSZ" + - "YYYY-MM-DD" + presence: "required" + workItemId: + type: "string" + flags: + presence: "required" + rules: + - + name: "guid" + args: + options: + version: + - "uuidv4" + + ``` diff --git a/docs/entities/contacts/NextFriendForIncompetentPersonContact.md b/docs/entities/contacts/NextFriendForIncompetentPersonContact.md index f6f0361cf24..cb363da9ebe 100644 --- a/docs/entities/contacts/NextFriendForIncompetentPersonContact.md +++ b/docs/entities/contacts/NextFriendForIncompetentPersonContact.md @@ -1,71 +1,76 @@ # contacts/NextFriendForIncompetentPersonContact - -### countryType - -> `string` | required - -##### Can be domestic. - -### address1 - -> `string` | required - -### address2 - -> `string` | optional - -### address3 - -> `string` | optional - -### city - -> `string` | required - -### email - -> `string` | optional - -### inCareOf - -> `string` | optional - -### name - -> `string` | required - -### phone - -> `string` | optional - -### secondaryName - -> `string` | required - -### title - -> `string` | optional - -### serviceIndicator - -> `string` | optional - -##### Allowed Values - - - - `Electronic` - - `None` - - `Paper` - -### state - -> `string` | required - -### postalCode - -> `string` | required - -##### Regex Pattern - - -`/^(\d{5}|\d{5}-\d{4})$/` + ``` +--- + type: "object" + keys: + countryType: + type: "string" + flags: + only: true + presence: "required" + allow: + - "domestic" + address1: + type: "string" + flags: + presence: "required" + address2: + type: "string" + flags: + presence: "optional" + address3: + type: "string" + flags: + presence: "optional" + city: + type: "string" + flags: + presence: "required" + email: + type: "string" + flags: + presence: "optional" + inCareOf: + type: "string" + flags: + presence: "optional" + name: + type: "string" + flags: + presence: "required" + phone: + type: "string" + flags: + presence: "optional" + secondaryName: + type: "string" + flags: + presence: "required" + title: + type: "string" + flags: + presence: "optional" + serviceIndicator: + type: "string" + flags: + only: true + presence: "optional" + allow: + - "Electronic" + - "None" + - "Paper" + state: + type: "string" + flags: + presence: "required" + postalCode: + type: "string" + flags: + presence: "required" + rules: + - + name: "pattern" + args: + regex: "/^(\\d{5}|\\d{5}-\\d{4})$/" + + ``` diff --git a/docs/entities/contacts/NextFriendForMinorContact.md b/docs/entities/contacts/NextFriendForMinorContact.md index 3c8415ae598..933ba67469c 100644 --- a/docs/entities/contacts/NextFriendForMinorContact.md +++ b/docs/entities/contacts/NextFriendForMinorContact.md @@ -1,71 +1,76 @@ # contacts/NextFriendForMinorContact - -### countryType - -> `string` | required - -##### Can be domestic. - -### address1 - -> `string` | required - -### address2 - -> `string` | optional - -### address3 - -> `string` | optional - -### city - -> `string` | required - -### email - -> `string` | optional - -### inCareOf - -> `string` | optional - -### name - -> `string` | required - -### phone - -> `string` | optional - -### secondaryName - -> `string` | required - -### title - -> `string` | optional - -### serviceIndicator - -> `string` | optional - -##### Allowed Values - - - - `Electronic` - - `None` - - `Paper` - -### state - -> `string` | required - -### postalCode - -> `string` | required - -##### Regex Pattern - - -`/^(\d{5}|\d{5}-\d{4})$/` + ``` +--- + type: "object" + keys: + countryType: + type: "string" + flags: + only: true + presence: "required" + allow: + - "domestic" + address1: + type: "string" + flags: + presence: "required" + address2: + type: "string" + flags: + presence: "optional" + address3: + type: "string" + flags: + presence: "optional" + city: + type: "string" + flags: + presence: "required" + email: + type: "string" + flags: + presence: "optional" + inCareOf: + type: "string" + flags: + presence: "optional" + name: + type: "string" + flags: + presence: "required" + phone: + type: "string" + flags: + presence: "optional" + secondaryName: + type: "string" + flags: + presence: "required" + title: + type: "string" + flags: + presence: "optional" + serviceIndicator: + type: "string" + flags: + only: true + presence: "optional" + allow: + - "Electronic" + - "None" + - "Paper" + state: + type: "string" + flags: + presence: "required" + postalCode: + type: "string" + flags: + presence: "required" + rules: + - + name: "pattern" + args: + regex: "/^(\\d{5}|\\d{5}-\\d{4})$/" + + ``` diff --git a/docs/entities/contacts/PartnershipAsTaxMattersPartnerContact.md b/docs/entities/contacts/PartnershipAsTaxMattersPartnerContact.md index ac4948ce194..727a7e74e63 100644 --- a/docs/entities/contacts/PartnershipAsTaxMattersPartnerContact.md +++ b/docs/entities/contacts/PartnershipAsTaxMattersPartnerContact.md @@ -1,71 +1,76 @@ # contacts/PartnershipAsTaxMattersPartnerContact - -### countryType - -> `string` | required - -##### Can be domestic. - -### address1 - -> `string` | required - -### address2 - -> `string` | optional - -### address3 - -> `string` | optional - -### city - -> `string` | required - -### email - -> `string` | optional - -### inCareOf - -> `string` | optional - -### name - -> `string` | required - -### phone - -> `string` | optional - -### secondaryName - -> `string` | required - -### title - -> `string` | optional - -### serviceIndicator - -> `string` | optional - -##### Allowed Values - - - - `Electronic` - - `None` - - `Paper` - -### state - -> `string` | required - -### postalCode - -> `string` | required - -##### Regex Pattern - - -`/^(\d{5}|\d{5}-\d{4})$/` + ``` +--- + type: "object" + keys: + countryType: + type: "string" + flags: + only: true + presence: "required" + allow: + - "domestic" + address1: + type: "string" + flags: + presence: "required" + address2: + type: "string" + flags: + presence: "optional" + address3: + type: "string" + flags: + presence: "optional" + city: + type: "string" + flags: + presence: "required" + email: + type: "string" + flags: + presence: "optional" + inCareOf: + type: "string" + flags: + presence: "optional" + name: + type: "string" + flags: + presence: "required" + phone: + type: "string" + flags: + presence: "optional" + secondaryName: + type: "string" + flags: + presence: "required" + title: + type: "string" + flags: + presence: "optional" + serviceIndicator: + type: "string" + flags: + only: true + presence: "optional" + allow: + - "Electronic" + - "None" + - "Paper" + state: + type: "string" + flags: + presence: "required" + postalCode: + type: "string" + flags: + presence: "required" + rules: + - + name: "pattern" + args: + regex: "/^(\\d{5}|\\d{5}-\\d{4})$/" + + ``` diff --git a/docs/entities/contacts/PartnershipBBAPrimaryContact.md b/docs/entities/contacts/PartnershipBBAPrimaryContact.md index 122ada0a1a2..e567e3cc2cd 100644 --- a/docs/entities/contacts/PartnershipBBAPrimaryContact.md +++ b/docs/entities/contacts/PartnershipBBAPrimaryContact.md @@ -1,71 +1,76 @@ # contacts/PartnershipBBAPrimaryContact - -### countryType - -> `string` | required - -##### Can be domestic. - -### address1 - -> `string` | required - -### address2 - -> `string` | optional - -### address3 - -> `string` | optional - -### city - -> `string` | required - -### email - -> `string` | optional - -### inCareOf - -> `string` | optional - -### name - -> `string` | required - -### phone - -> `string` | optional - -### secondaryName - -> `string` | required - -### title - -> `string` | optional - -### serviceIndicator - -> `string` | optional - -##### Allowed Values - - - - `Electronic` - - `None` - - `Paper` - -### state - -> `string` | required - -### postalCode - -> `string` | required - -##### Regex Pattern - - -`/^(\d{5}|\d{5}-\d{4})$/` + ``` +--- + type: "object" + keys: + countryType: + type: "string" + flags: + only: true + presence: "required" + allow: + - "domestic" + address1: + type: "string" + flags: + presence: "required" + address2: + type: "string" + flags: + presence: "optional" + address3: + type: "string" + flags: + presence: "optional" + city: + type: "string" + flags: + presence: "required" + email: + type: "string" + flags: + presence: "optional" + inCareOf: + type: "string" + flags: + presence: "optional" + name: + type: "string" + flags: + presence: "required" + phone: + type: "string" + flags: + presence: "optional" + secondaryName: + type: "string" + flags: + presence: "required" + title: + type: "string" + flags: + presence: "optional" + serviceIndicator: + type: "string" + flags: + only: true + presence: "optional" + allow: + - "Electronic" + - "None" + - "Paper" + state: + type: "string" + flags: + presence: "required" + postalCode: + type: "string" + flags: + presence: "required" + rules: + - + name: "pattern" + args: + regex: "/^(\\d{5}|\\d{5}-\\d{4})$/" + + ``` diff --git a/docs/entities/contacts/PartnershipOtherThanTaxMattersPrimaryContact.md b/docs/entities/contacts/PartnershipOtherThanTaxMattersPrimaryContact.md index 977917fc9b5..3c96d08f998 100644 --- a/docs/entities/contacts/PartnershipOtherThanTaxMattersPrimaryContact.md +++ b/docs/entities/contacts/PartnershipOtherThanTaxMattersPrimaryContact.md @@ -1,71 +1,76 @@ # contacts/PartnershipOtherThanTaxMattersPrimaryContact - -### countryType - -> `string` | required - -##### Can be domestic. - -### address1 - -> `string` | required - -### address2 - -> `string` | optional - -### address3 - -> `string` | optional - -### city - -> `string` | required - -### email - -> `string` | optional - -### inCareOf - -> `string` | optional - -### name - -> `string` | required - -### phone - -> `string` | optional - -### secondaryName - -> `string` | required - -### title - -> `string` | optional - -### serviceIndicator - -> `string` | optional - -##### Allowed Values - - - - `Electronic` - - `None` - - `Paper` - -### state - -> `string` | required - -### postalCode - -> `string` | required - -##### Regex Pattern - - -`/^(\d{5}|\d{5}-\d{4})$/` + ``` +--- + type: "object" + keys: + countryType: + type: "string" + flags: + only: true + presence: "required" + allow: + - "domestic" + address1: + type: "string" + flags: + presence: "required" + address2: + type: "string" + flags: + presence: "optional" + address3: + type: "string" + flags: + presence: "optional" + city: + type: "string" + flags: + presence: "required" + email: + type: "string" + flags: + presence: "optional" + inCareOf: + type: "string" + flags: + presence: "optional" + name: + type: "string" + flags: + presence: "required" + phone: + type: "string" + flags: + presence: "optional" + secondaryName: + type: "string" + flags: + presence: "required" + title: + type: "string" + flags: + presence: "optional" + serviceIndicator: + type: "string" + flags: + only: true + presence: "optional" + allow: + - "Electronic" + - "None" + - "Paper" + state: + type: "string" + flags: + presence: "required" + postalCode: + type: "string" + flags: + presence: "required" + rules: + - + name: "pattern" + args: + regex: "/^(\\d{5}|\\d{5}-\\d{4})$/" + + ``` diff --git a/docs/entities/contacts/PetitionerConservatorContact.md b/docs/entities/contacts/PetitionerConservatorContact.md index 280e5dcc46f..b8133a1c88d 100644 --- a/docs/entities/contacts/PetitionerConservatorContact.md +++ b/docs/entities/contacts/PetitionerConservatorContact.md @@ -1,71 +1,76 @@ # contacts/PetitionerConservatorContact - -### countryType - -> `string` | required - -##### Can be domestic. - -### address1 - -> `string` | required - -### address2 - -> `string` | optional - -### address3 - -> `string` | optional - -### city - -> `string` | required - -### email - -> `string` | optional - -### inCareOf - -> `string` | optional - -### name - -> `string` | required - -### phone - -> `string` | optional - -### secondaryName - -> `string` | required - -### title - -> `string` | optional - -### serviceIndicator - -> `string` | optional - -##### Allowed Values - - - - `Electronic` - - `None` - - `Paper` - -### state - -> `string` | required - -### postalCode - -> `string` | required - -##### Regex Pattern - - -`/^(\d{5}|\d{5}-\d{4})$/` + ``` +--- + type: "object" + keys: + countryType: + type: "string" + flags: + only: true + presence: "required" + allow: + - "domestic" + address1: + type: "string" + flags: + presence: "required" + address2: + type: "string" + flags: + presence: "optional" + address3: + type: "string" + flags: + presence: "optional" + city: + type: "string" + flags: + presence: "required" + email: + type: "string" + flags: + presence: "optional" + inCareOf: + type: "string" + flags: + presence: "optional" + name: + type: "string" + flags: + presence: "required" + phone: + type: "string" + flags: + presence: "optional" + secondaryName: + type: "string" + flags: + presence: "required" + title: + type: "string" + flags: + presence: "optional" + serviceIndicator: + type: "string" + flags: + only: true + presence: "optional" + allow: + - "Electronic" + - "None" + - "Paper" + state: + type: "string" + flags: + presence: "required" + postalCode: + type: "string" + flags: + presence: "required" + rules: + - + name: "pattern" + args: + regex: "/^(\\d{5}|\\d{5}-\\d{4})$/" + + ``` diff --git a/docs/entities/contacts/PetitionerCorporationContact.md b/docs/entities/contacts/PetitionerCorporationContact.md index c6db6a5bc85..2dce690692f 100644 --- a/docs/entities/contacts/PetitionerCorporationContact.md +++ b/docs/entities/contacts/PetitionerCorporationContact.md @@ -1,71 +1,76 @@ # contacts/PetitionerCorporationContact - -### countryType - -> `string` | required - -##### Can be domestic. - -### address1 - -> `string` | required - -### address2 - -> `string` | optional - -### address3 - -> `string` | optional - -### city - -> `string` | required - -### email - -> `string` | optional - -### inCareOf - -> `string` | required - -### name - -> `string` | required - -### phone - -> `string` | optional - -### secondaryName - -> `string` | optional - -### title - -> `string` | optional - -### serviceIndicator - -> `string` | optional - -##### Allowed Values - - - - `Electronic` - - `None` - - `Paper` - -### state - -> `string` | required - -### postalCode - -> `string` | required - -##### Regex Pattern - - -`/^(\d{5}|\d{5}-\d{4})$/` + ``` +--- + type: "object" + keys: + countryType: + type: "string" + flags: + only: true + presence: "required" + allow: + - "domestic" + address1: + type: "string" + flags: + presence: "required" + address2: + type: "string" + flags: + presence: "optional" + address3: + type: "string" + flags: + presence: "optional" + city: + type: "string" + flags: + presence: "required" + email: + type: "string" + flags: + presence: "optional" + inCareOf: + type: "string" + flags: + presence: "required" + name: + type: "string" + flags: + presence: "required" + phone: + type: "string" + flags: + presence: "optional" + secondaryName: + type: "string" + flags: + presence: "optional" + title: + type: "string" + flags: + presence: "optional" + serviceIndicator: + type: "string" + flags: + only: true + presence: "optional" + allow: + - "Electronic" + - "None" + - "Paper" + state: + type: "string" + flags: + presence: "required" + postalCode: + type: "string" + flags: + presence: "required" + rules: + - + name: "pattern" + args: + regex: "/^(\\d{5}|\\d{5}-\\d{4})$/" + + ``` diff --git a/docs/entities/contacts/PetitionerCustodianContact.md b/docs/entities/contacts/PetitionerCustodianContact.md index 6cc189f6e56..0bfb545b462 100644 --- a/docs/entities/contacts/PetitionerCustodianContact.md +++ b/docs/entities/contacts/PetitionerCustodianContact.md @@ -1,71 +1,76 @@ # contacts/PetitionerCustodianContact - -### countryType - -> `string` | required - -##### Can be domestic. - -### address1 - -> `string` | required - -### address2 - -> `string` | optional - -### address3 - -> `string` | optional - -### city - -> `string` | required - -### email - -> `string` | optional - -### inCareOf - -> `string` | optional - -### name - -> `string` | required - -### phone - -> `string` | optional - -### secondaryName - -> `string` | required - -### title - -> `string` | optional - -### serviceIndicator - -> `string` | optional - -##### Allowed Values - - - - `Electronic` - - `None` - - `Paper` - -### state - -> `string` | required - -### postalCode - -> `string` | required - -##### Regex Pattern - - -`/^(\d{5}|\d{5}-\d{4})$/` + ``` +--- + type: "object" + keys: + countryType: + type: "string" + flags: + only: true + presence: "required" + allow: + - "domestic" + address1: + type: "string" + flags: + presence: "required" + address2: + type: "string" + flags: + presence: "optional" + address3: + type: "string" + flags: + presence: "optional" + city: + type: "string" + flags: + presence: "required" + email: + type: "string" + flags: + presence: "optional" + inCareOf: + type: "string" + flags: + presence: "optional" + name: + type: "string" + flags: + presence: "required" + phone: + type: "string" + flags: + presence: "optional" + secondaryName: + type: "string" + flags: + presence: "required" + title: + type: "string" + flags: + presence: "optional" + serviceIndicator: + type: "string" + flags: + only: true + presence: "optional" + allow: + - "Electronic" + - "None" + - "Paper" + state: + type: "string" + flags: + presence: "required" + postalCode: + type: "string" + flags: + presence: "required" + rules: + - + name: "pattern" + args: + regex: "/^(\\d{5}|\\d{5}-\\d{4})$/" + + ``` diff --git a/docs/entities/contacts/PetitionerDeceasedSpouseContact.md b/docs/entities/contacts/PetitionerDeceasedSpouseContact.md index faacc314b45..fe8e24f895a 100644 --- a/docs/entities/contacts/PetitionerDeceasedSpouseContact.md +++ b/docs/entities/contacts/PetitionerDeceasedSpouseContact.md @@ -1,73 +1,78 @@ # contacts/PetitionerDeceasedSpouseContact - -### countryType - -> `string` | required - -##### Can be domestic. - -### address1 - -> `string` | required - -### address2 - -> `string` | optional - -### address3 - -> `string` | optional - -### city - -> `string` | required - -### email - -> `string` | optional - -### inCareOf - -> `string` | required - -### name - -> `string` | required - -### phone - -> `string` | optional - -##### Can be null. - -### secondaryName - -> `string` | optional - -### title - -> `string` | optional - -### serviceIndicator - -> `string` | optional - -##### Allowed Values - - - - `Electronic` - - `None` - - `Paper` - -### state - -> `string` | required - -### postalCode - -> `string` | required - -##### Regex Pattern - - -`/^(\d{5}|\d{5}-\d{4})$/` + ``` +--- + type: "object" + keys: + countryType: + type: "string" + flags: + only: true + presence: "required" + allow: + - "domestic" + address1: + type: "string" + flags: + presence: "required" + address2: + type: "string" + flags: + presence: "optional" + address3: + type: "string" + flags: + presence: "optional" + city: + type: "string" + flags: + presence: "required" + email: + type: "string" + flags: + presence: "optional" + inCareOf: + type: "string" + flags: + presence: "required" + name: + type: "string" + flags: + presence: "required" + phone: + type: "string" + flags: + presence: "optional" + allow: + - null + secondaryName: + type: "string" + flags: + presence: "optional" + title: + type: "string" + flags: + presence: "optional" + serviceIndicator: + type: "string" + flags: + only: true + presence: "optional" + allow: + - "Electronic" + - "None" + - "Paper" + state: + type: "string" + flags: + presence: "required" + postalCode: + type: "string" + flags: + presence: "required" + rules: + - + name: "pattern" + args: + regex: "/^(\\d{5}|\\d{5}-\\d{4})$/" + + ``` diff --git a/docs/entities/contacts/PetitionerEstateWithExecutorPrimaryContact.md b/docs/entities/contacts/PetitionerEstateWithExecutorPrimaryContact.md index 7fd17e07892..07680942da5 100644 --- a/docs/entities/contacts/PetitionerEstateWithExecutorPrimaryContact.md +++ b/docs/entities/contacts/PetitionerEstateWithExecutorPrimaryContact.md @@ -1,71 +1,76 @@ # contacts/PetitionerEstateWithExecutorPrimaryContact - -### countryType - -> `string` | required - -##### Can be domestic. - -### address1 - -> `string` | required - -### address2 - -> `string` | optional - -### address3 - -> `string` | optional - -### city - -> `string` | required - -### email - -> `string` | optional - -### inCareOf - -> `string` | optional - -### name - -> `string` | required - -### phone - -> `string` | optional - -### secondaryName - -> `string` | required - -### title - -> `string` | optional - -### serviceIndicator - -> `string` | optional - -##### Allowed Values - - - - `Electronic` - - `None` - - `Paper` - -### state - -> `string` | required - -### postalCode - -> `string` | required - -##### Regex Pattern - - -`/^(\d{5}|\d{5}-\d{4})$/` + ``` +--- + type: "object" + keys: + countryType: + type: "string" + flags: + only: true + presence: "required" + allow: + - "domestic" + address1: + type: "string" + flags: + presence: "required" + address2: + type: "string" + flags: + presence: "optional" + address3: + type: "string" + flags: + presence: "optional" + city: + type: "string" + flags: + presence: "required" + email: + type: "string" + flags: + presence: "optional" + inCareOf: + type: "string" + flags: + presence: "optional" + name: + type: "string" + flags: + presence: "required" + phone: + type: "string" + flags: + presence: "optional" + secondaryName: + type: "string" + flags: + presence: "required" + title: + type: "string" + flags: + presence: "optional" + serviceIndicator: + type: "string" + flags: + only: true + presence: "optional" + allow: + - "Electronic" + - "None" + - "Paper" + state: + type: "string" + flags: + presence: "required" + postalCode: + type: "string" + flags: + presence: "required" + rules: + - + name: "pattern" + args: + regex: "/^(\\d{5}|\\d{5}-\\d{4})$/" + + ``` diff --git a/docs/entities/contacts/PetitionerGuardianContact.md b/docs/entities/contacts/PetitionerGuardianContact.md index 31db1baf901..6d7832667d2 100644 --- a/docs/entities/contacts/PetitionerGuardianContact.md +++ b/docs/entities/contacts/PetitionerGuardianContact.md @@ -1,71 +1,76 @@ # contacts/PetitionerGuardianContact - -### countryType - -> `string` | required - -##### Can be domestic. - -### address1 - -> `string` | required - -### address2 - -> `string` | optional - -### address3 - -> `string` | optional - -### city - -> `string` | required - -### email - -> `string` | optional - -### inCareOf - -> `string` | optional - -### name - -> `string` | required - -### phone - -> `string` | optional - -### secondaryName - -> `string` | required - -### title - -> `string` | optional - -### serviceIndicator - -> `string` | optional - -##### Allowed Values - - - - `Electronic` - - `None` - - `Paper` - -### state - -> `string` | required - -### postalCode - -> `string` | required - -##### Regex Pattern - - -`/^(\d{5}|\d{5}-\d{4})$/` + ``` +--- + type: "object" + keys: + countryType: + type: "string" + flags: + only: true + presence: "required" + allow: + - "domestic" + address1: + type: "string" + flags: + presence: "required" + address2: + type: "string" + flags: + presence: "optional" + address3: + type: "string" + flags: + presence: "optional" + city: + type: "string" + flags: + presence: "required" + email: + type: "string" + flags: + presence: "optional" + inCareOf: + type: "string" + flags: + presence: "optional" + name: + type: "string" + flags: + presence: "required" + phone: + type: "string" + flags: + presence: "optional" + secondaryName: + type: "string" + flags: + presence: "required" + title: + type: "string" + flags: + presence: "optional" + serviceIndicator: + type: "string" + flags: + only: true + presence: "optional" + allow: + - "Electronic" + - "None" + - "Paper" + state: + type: "string" + flags: + presence: "required" + postalCode: + type: "string" + flags: + presence: "required" + rules: + - + name: "pattern" + args: + regex: "/^(\\d{5}|\\d{5}-\\d{4})$/" + + ``` diff --git a/docs/entities/contacts/PetitionerIntermediaryContact.md b/docs/entities/contacts/PetitionerIntermediaryContact.md index 1de1caad340..055d2ab3867 100644 --- a/docs/entities/contacts/PetitionerIntermediaryContact.md +++ b/docs/entities/contacts/PetitionerIntermediaryContact.md @@ -1,71 +1,76 @@ # contacts/PetitionerIntermediaryContact - -### countryType - -> `string` | required - -##### Can be domestic. - -### address1 - -> `string` | required - -### address2 - -> `string` | optional - -### address3 - -> `string` | optional - -### city - -> `string` | required - -### email - -> `string` | optional - -### inCareOf - -> `string` | optional - -### name - -> `string` | required - -### phone - -> `string` | optional - -### secondaryName - -> `string` | optional - -### title - -> `string` | optional - -### serviceIndicator - -> `string` | optional - -##### Allowed Values - - - - `Electronic` - - `None` - - `Paper` - -### state - -> `string` | required - -### postalCode - -> `string` | required - -##### Regex Pattern - - -`/^(\d{5}|\d{5}-\d{4})$/` + ``` +--- + type: "object" + keys: + countryType: + type: "string" + flags: + only: true + presence: "required" + allow: + - "domestic" + address1: + type: "string" + flags: + presence: "required" + address2: + type: "string" + flags: + presence: "optional" + address3: + type: "string" + flags: + presence: "optional" + city: + type: "string" + flags: + presence: "required" + email: + type: "string" + flags: + presence: "optional" + inCareOf: + type: "string" + flags: + presence: "optional" + name: + type: "string" + flags: + presence: "required" + phone: + type: "string" + flags: + presence: "optional" + secondaryName: + type: "string" + flags: + presence: "optional" + title: + type: "string" + flags: + presence: "optional" + serviceIndicator: + type: "string" + flags: + only: true + presence: "optional" + allow: + - "Electronic" + - "None" + - "Paper" + state: + type: "string" + flags: + presence: "required" + postalCode: + type: "string" + flags: + presence: "required" + rules: + - + name: "pattern" + args: + regex: "/^(\\d{5}|\\d{5}-\\d{4})$/" + + ``` diff --git a/docs/entities/contacts/PetitionerPrimaryContact.md b/docs/entities/contacts/PetitionerPrimaryContact.md index 3fe1fca3a43..8be9c35cadd 100644 --- a/docs/entities/contacts/PetitionerPrimaryContact.md +++ b/docs/entities/contacts/PetitionerPrimaryContact.md @@ -1,71 +1,76 @@ # contacts/PetitionerPrimaryContact - -### countryType - -> `string` | required - -##### Can be domestic. - -### address1 - -> `string` | required - -### address2 - -> `string` | optional - -### address3 - -> `string` | optional - -### city - -> `string` | required - -### email - -> `string` | optional - -### inCareOf - -> `string` | optional - -### name - -> `string` | required - -### phone - -> `string` | optional - -### secondaryName - -> `string` | optional - -### title - -> `string` | optional - -### serviceIndicator - -> `string` | optional - -##### Allowed Values - - - - `Electronic` - - `None` - - `Paper` - -### state - -> `string` | required - -### postalCode - -> `string` | required - -##### Regex Pattern - - -`/^(\d{5}|\d{5}-\d{4})$/` + ``` +--- + type: "object" + keys: + countryType: + type: "string" + flags: + only: true + presence: "required" + allow: + - "domestic" + address1: + type: "string" + flags: + presence: "required" + address2: + type: "string" + flags: + presence: "optional" + address3: + type: "string" + flags: + presence: "optional" + city: + type: "string" + flags: + presence: "required" + email: + type: "string" + flags: + presence: "optional" + inCareOf: + type: "string" + flags: + presence: "optional" + name: + type: "string" + flags: + presence: "required" + phone: + type: "string" + flags: + presence: "optional" + secondaryName: + type: "string" + flags: + presence: "optional" + title: + type: "string" + flags: + presence: "optional" + serviceIndicator: + type: "string" + flags: + only: true + presence: "optional" + allow: + - "Electronic" + - "None" + - "Paper" + state: + type: "string" + flags: + presence: "required" + postalCode: + type: "string" + flags: + presence: "required" + rules: + - + name: "pattern" + args: + regex: "/^(\\d{5}|\\d{5}-\\d{4})$/" + + ``` diff --git a/docs/entities/contacts/PetitionerSpouseContact.md b/docs/entities/contacts/PetitionerSpouseContact.md index 75c50bab6bb..11ecd496cd9 100644 --- a/docs/entities/contacts/PetitionerSpouseContact.md +++ b/docs/entities/contacts/PetitionerSpouseContact.md @@ -1,71 +1,76 @@ # contacts/PetitionerSpouseContact - -### countryType - -> `string` | required - -##### Can be domestic. - -### address1 - -> `string` | required - -### address2 - -> `string` | optional - -### address3 - -> `string` | optional - -### city - -> `string` | required - -### email - -> `string` | optional - -### inCareOf - -> `string` | optional - -### name - -> `string` | required - -### phone - -> `string` | optional - -### secondaryName - -> `string` | optional - -### title - -> `string` | optional - -### serviceIndicator - -> `string` | optional - -##### Allowed Values - - - - `Electronic` - - `None` - - `Paper` - -### state - -> `string` | required - -### postalCode - -> `string` | required - -##### Regex Pattern - - -`/^(\d{5}|\d{5}-\d{4})$/` + ``` +--- + type: "object" + keys: + countryType: + type: "string" + flags: + only: true + presence: "required" + allow: + - "domestic" + address1: + type: "string" + flags: + presence: "required" + address2: + type: "string" + flags: + presence: "optional" + address3: + type: "string" + flags: + presence: "optional" + city: + type: "string" + flags: + presence: "required" + email: + type: "string" + flags: + presence: "optional" + inCareOf: + type: "string" + flags: + presence: "optional" + name: + type: "string" + flags: + presence: "required" + phone: + type: "string" + flags: + presence: "optional" + secondaryName: + type: "string" + flags: + presence: "optional" + title: + type: "string" + flags: + presence: "optional" + serviceIndicator: + type: "string" + flags: + only: true + presence: "optional" + allow: + - "Electronic" + - "None" + - "Paper" + state: + type: "string" + flags: + presence: "required" + postalCode: + type: "string" + flags: + presence: "required" + rules: + - + name: "pattern" + args: + regex: "/^(\\d{5}|\\d{5}-\\d{4})$/" + + ``` diff --git a/docs/entities/contacts/PetitionerTrustContact.md b/docs/entities/contacts/PetitionerTrustContact.md index e519b2f3cf8..fcb401050a9 100644 --- a/docs/entities/contacts/PetitionerTrustContact.md +++ b/docs/entities/contacts/PetitionerTrustContact.md @@ -1,71 +1,76 @@ # contacts/PetitionerTrustContact - -### countryType - -> `string` | required - -##### Can be domestic. - -### address1 - -> `string` | required - -### address2 - -> `string` | optional - -### address3 - -> `string` | optional - -### city - -> `string` | required - -### email - -> `string` | optional - -### inCareOf - -> `string` | optional - -### name - -> `string` | required - -### phone - -> `string` | optional - -### secondaryName - -> `string` | required - -### title - -> `string` | optional - -### serviceIndicator - -> `string` | optional - -##### Allowed Values - - - - `Electronic` - - `None` - - `Paper` - -### state - -> `string` | required - -### postalCode - -> `string` | required - -##### Regex Pattern - - -`/^(\d{5}|\d{5}-\d{4})$/` + ``` +--- + type: "object" + keys: + countryType: + type: "string" + flags: + only: true + presence: "required" + allow: + - "domestic" + address1: + type: "string" + flags: + presence: "required" + address2: + type: "string" + flags: + presence: "optional" + address3: + type: "string" + flags: + presence: "optional" + city: + type: "string" + flags: + presence: "required" + email: + type: "string" + flags: + presence: "optional" + inCareOf: + type: "string" + flags: + presence: "optional" + name: + type: "string" + flags: + presence: "required" + phone: + type: "string" + flags: + presence: "optional" + secondaryName: + type: "string" + flags: + presence: "required" + title: + type: "string" + flags: + presence: "optional" + serviceIndicator: + type: "string" + flags: + only: true + presence: "optional" + allow: + - "Electronic" + - "None" + - "Paper" + state: + type: "string" + flags: + presence: "required" + postalCode: + type: "string" + flags: + presence: "required" + rules: + - + name: "pattern" + args: + regex: "/^(\\d{5}|\\d{5}-\\d{4})$/" + + ``` diff --git a/docs/entities/contacts/SurvivingSpouseContact.md b/docs/entities/contacts/SurvivingSpouseContact.md index f2a262c09d4..44b07d0b676 100644 --- a/docs/entities/contacts/SurvivingSpouseContact.md +++ b/docs/entities/contacts/SurvivingSpouseContact.md @@ -1,71 +1,76 @@ # contacts/SurvivingSpouseContact - -### countryType - -> `string` | required - -##### Can be domestic. - -### address1 - -> `string` | required - -### address2 - -> `string` | optional - -### address3 - -> `string` | optional - -### city - -> `string` | required - -### email - -> `string` | optional - -### inCareOf - -> `string` | optional - -### name - -> `string` | required - -### phone - -> `string` | optional - -### secondaryName - -> `string` | required - -### title - -> `string` | optional - -### serviceIndicator - -> `string` | optional - -##### Allowed Values - - - - `Electronic` - - `None` - - `Paper` - -### state - -> `string` | required - -### postalCode - -> `string` | required - -##### Regex Pattern - - -`/^(\d{5}|\d{5}-\d{4})$/` + ``` +--- + type: "object" + keys: + countryType: + type: "string" + flags: + only: true + presence: "required" + allow: + - "domestic" + address1: + type: "string" + flags: + presence: "required" + address2: + type: "string" + flags: + presence: "optional" + address3: + type: "string" + flags: + presence: "optional" + city: + type: "string" + flags: + presence: "required" + email: + type: "string" + flags: + presence: "optional" + inCareOf: + type: "string" + flags: + presence: "optional" + name: + type: "string" + flags: + presence: "required" + phone: + type: "string" + flags: + presence: "optional" + secondaryName: + type: "string" + flags: + presence: "required" + title: + type: "string" + flags: + presence: "optional" + serviceIndicator: + type: "string" + flags: + only: true + presence: "optional" + allow: + - "Electronic" + - "None" + - "Paper" + state: + type: "string" + flags: + presence: "required" + postalCode: + type: "string" + flags: + presence: "required" + rules: + - + name: "pattern" + args: + regex: "/^(\\d{5}|\\d{5}-\\d{4})$/" + + ``` diff --git a/docs/zap-report.html b/docs/zap-report.html index ec1516a396b..89d25d55b24 100644 --- a/docs/zap-report.html +++ b/docs/zap-report.html @@ -91,7 +91,7 @@
A response code of 401 was returned by the server.
This may indicate that the application is failing to handle unexpected input correctly.
Raised by the 'Alert on HTTP Response Code Error' script
A response code of 403 was returned by the server.
This may indicate that the application is failing to handle unexpected input correctly.
Raised by the 'Alert on HTTP Response Code Error' script