feat: ROOT-194: Improve project representation in SDK and docs (#625)

Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com>
Co-authored-by: Jo Booth <jo@humansignal.com>

Author: 3 people

.mock/definition/__package__.yml

@@ -183,7 +183,7 @@ types:
       Serializer get numbers from project queryset annotation,
       make sure, that you use correct one(Project.objects.with_counts())
     properties:
-      allow_stream: string
+      allow_stream: boolean
       annotation_limit_count:
         type: optional<integer>
         validation:
@@ -281,7 +281,7 @@ types:
       model_version:
         type: optional<string>
         docs: Machine learning model version
-      num_tasks_with_annotations: string
+      num_tasks_with_annotations: integer
       organization: optional<integer>
       overlap_cohort_percentage:
         type: optional<integer>
@@ -296,21 +296,21 @@ types:
         type: optional<datetime>
         docs: Pinned date and time
       prompts: string
-      queue_done: string
-      queue_left: string
+      queue_done: integer
+      queue_left: integer
       queue_total: string
-      ready: string
-      rejected: string
+      ready: boolean
+      rejected: integer
       require_comment_on_skip:
         type: optional<boolean>
         default: false
       reveal_preannotations_interactively:
         type: optional<boolean>
         docs: Reveal pre-annotations interactively
       review_settings: ReviewSettings
-      review_total_tasks: string
-      reviewed_number: string
-      reviewer_queue_total: string
+      review_total_tasks: integer
+      reviewed_number: integer
+      reviewer_queue_total: integer
       sampling: optional<AllRolesProjectListSampling>
       show_annotation_history:
         type: optional<boolean>
@@ -343,7 +343,7 @@ types:
           maxLength: 50
       total_annotations_number: string
       total_predictions_number: integer
-      useful_annotation_number: string
+      useful_annotation_number: optional<integer>
       workspace: string
       workspace_title: string
     source:
@@ -3900,20 +3900,20 @@ types:
         type: integer
         docs: Honeypot annotation number in project
       id: integer
-      num_tasks_with_annotations: string
-      queue_done: string
-      queue_left: string
+      num_tasks_with_annotations: integer
+      queue_done: integer
+      queue_left: integer
       queue_total: string
-      rejected: string
-      review_total_tasks: string
-      reviewed_number: string
+      rejected: integer
+      review_total_tasks: integer
+      reviewed_number: integer
       skipped_annotations_number: string
       task_number:
         type: integer
         docs: Total task number in project
       total_annotations_number: string
       total_predictions_number: integer
-      useful_annotation_number: string
+      useful_annotation_number: optional<integer>
     source:
       openapi: openapi/openapi.yaml
   LseProjectCreateSampling:
@@ -4079,6 +4079,202 @@ types:
       workspace: optional<integer>
     source:
       openapi: openapi/openapi.yaml
+  LseProjectResponseSampling:
+    discriminated: false
+    union:
+      - SamplingDe5Enum
+      - NullEnum
+    source:
+      openapi: openapi/openapi.yaml
+    inline: true
+  LseProjectResponseSkipQueue:
+    discriminated: false
+    union:
+      - SkipQueueEnum
+      - NullEnum
+    source:
+      openapi: openapi/openapi.yaml
+    inline: true
+  LseProjectResponse:
+    docs: >-
+      Serializer for project response, combining all the serializers for
+      different roles. Don't use it except for Spectacular/Fern definitions.
+    properties:
+      allow_stream: boolean
+      annotation_limit_count:
+        type: optional<integer>
+        validation:
+          min: 1
+      annotation_limit_percent:
+        type: optional<string>
+        validation:
+          pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
+      annotator_evaluation_minimum_score:
+        type: optional<string>
+        default: '95.00'
+        validation:
+          pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
+      annotator_evaluation_minimum_tasks:
+        type: optional<integer>
+        default: 10
+        validation:
+          min: 0
+      assignment_settings: AssignmentSettings
+      color:
+        type: optional<string>
+        validation:
+          maxLength: 16
+      comment_classification_config: optional<string>
+      config_has_control_tags:
+        type: boolean
+        docs: Flag to detect is project ready for labeling
+      config_suitable_for_bulk_annotation:
+        type: boolean
+        docs: Flag to detect is project ready for bulk annotation
+      control_weights: optional<unknown>
+      created_at: datetime
+      created_by:
+        type: optional<UserSimple>
+        docs: Project owner
+      custom_script: optional<string>
+      custom_task_lock_ttl:
+        type: optional<integer>
+        docs: TTL in seconds for task reservations, on new and existing tasks
+        validation:
+          min: 1
+          max: 86400
+      data_types: unknown
+      description:
+        type: optional<string>
+        docs: Project description
+      duplication_done:
+        type: optional<boolean>
+        default: false
+      duplication_status: optional<string>
+      enable_empty_annotation:
+        type: optional<boolean>
+        docs: Allow annotators to submit empty annotations
+      evaluate_predictions_automatically:
+        type: optional<boolean>
+        docs: Retrieve and display predictions when loading a task
+      expert_instruction:
+        type: optional<string>
+        docs: Labeling instructions in HTML format
+      finished_task_number:
+        type: integer
+        docs: Finished tasks
+      ground_truth_number:
+        type: integer
+        docs: Honeypot annotation number in project
+      id: integer
+      is_draft:
+        type: optional<boolean>
+        docs: Whether or not the project is in the middle of being created
+      is_published:
+        type: optional<boolean>
+        docs: Whether or not the project is published to annotators
+      label_config:
+        type: optional<string>
+        docs: Label config in XML format. See more about it in documentation
+      maximum_annotations:
+        type: optional<integer>
+        docs: >-
+          Maximum number of annotations for one task. If the number of
+          annotations per task is equal or greater to this value, the task is
+          completed (is_labeled=True)
+        validation:
+          min: -2147483648
+          max: 2147483647
+      members: string
+      members_count: integer
+      min_annotations_to_start_training:
+        type: optional<integer>
+        docs: >-
+          Minimum number of completed tasks after which model training is
+          started
+        validation:
+          min: -2147483648
+          max: 2147483647
+      model_version:
+        type: optional<string>
+        docs: Machine learning model version
+      num_tasks_with_annotations: integer
+      organization: optional<integer>
+      overlap_cohort_percentage:
+        type: optional<integer>
+        validation:
+          min: -2147483648
+          max: 2147483647
+      parsed_label_config: unknown
+      pause_on_failed_annotator_evaluation:
+        type: optional<boolean>
+        default: false
+      pinned_at:
+        type: optional<datetime>
+        docs: Pinned date and time
+      prompts: string
+      queue_done: integer
+      queue_left: integer
+      queue_total: integer
+      ready: boolean
+      rejected: integer
+      require_comment_on_skip:
+        type: optional<boolean>
+        default: false
+      reveal_preannotations_interactively:
+        type: optional<boolean>
+        docs: Reveal pre-annotations interactively
+      review_settings: ReviewSettings
+      review_total_tasks: integer
+      reviewed_number: integer
+      reviewer_queue_total: integer
+      sampling: optional<LseProjectResponseSampling>
+      show_annotation_history:
+        type: optional<boolean>
+        docs: Show annotation history to annotator
+      show_collab_predictions:
+        type: optional<boolean>
+        docs: If set, the annotator can view model predictions
+      show_ground_truth_first: optional<boolean>
+      show_instruction:
+        type: optional<boolean>
+        docs: Show instructions to the annotator before they start
+      show_overlap_first: optional<boolean>
+      show_skip_button:
+        type: optional<boolean>
+        docs: Show a skip button in interface and allow annotators to skip the task
+      show_unused_data_columns_to_annotators: optional<boolean>
+      skip_queue: optional<LseProjectResponseSkipQueue>
+      skipped_annotations_number: integer
+      start_training_on_annotation_update:
+        type: boolean
+        docs: Start model training after any annotations are submitted or updated
+      task_data_login:
+        type: optional<string>
+        docs: 'Task data credentials: login'
+        validation:
+          maxLength: 256
+      task_data_password:
+        type: optional<string>
+        docs: 'Task data credentials: password'
+        validation:
+          maxLength: 256
+      task_number:
+        type: integer
+        docs: Total task number in project
+      title:
+        type: optional<string>
+        docs: Project name. Must be between 3 and 50 characters long.
+        validation:
+          minLength: 3
+          maxLength: 50
+      total_annotations_number: integer
+      total_predictions_number: optional<integer>
+      useful_annotation_number: optional<integer>
+      workspace: string
+      workspace_title: string
+    source:
+      openapi: openapi/openapi.yaml
   LseProjectUpdateSampling:
     discriminated: false
     union:
@@ -4722,6 +4918,13 @@ types:
       project:
         type: optional<integer>
         docs: Project ID for this task
+      review_time:
+        type: integer
+        docs: >-
+          Calculate total review time for this task from MetricInTimeBucket
+          records.
+
+          Returns time in seconds.
       reviewed: optional<boolean>
       reviewers: list<map<string, unknown>>
       reviewers_count: integer
@@ -5169,6 +5372,13 @@ types:
       project:
         type: optional<integer>
         docs: Project ID for this task
+      review_time:
+        type: integer
+        docs: >-
+          Calculate total review time for this task from MetricInTimeBucket
+          records.
+
+          Returns time in seconds.
       reviewed: optional<boolean>
       reviewers: list<map<string, unknown>>
       reviewers_count: integer