zou 0.20.83__py3-none-any.whl → 0.20.84__py3-none-any.whl

zou/app/blueprints/crud/working_file.py

@@ -24,6 +24,150 @@ class WorkingFilesResource(BaseModelsResource):
         user_service.block_access_to_vendor()
         return True
 
+    @jwt_required()
+    def get(self):
+        """
+        Get working files
+        ---
+        tags:
+          - Crud
+        description: Retrieve all working files. Supports filtering via
+          query parameters and pagination. Vendor access is blocked.
+          Includes project permission filtering for non-admin users.
+        parameters:
+          - in: query
+            name: page
+            required: false
+            schema:
+              type: integer
+            example: 1
+            description: Page number for pagination
+          - in: query
+            name: limit
+            required: false
+            schema:
+              type: integer
+            example: 50
+            description: Number of results per page
+          - in: query
+            name: relations
+            required: false
+            schema:
+              type: boolean
+            default: false
+            example: false
+            description: Whether to include relations
+        responses:
+            200:
+              description: Working files retrieved successfully
+              content:
+                application/json:
+                  schema:
+                    oneOf:
+                      - type: array
+                        items:
+                          type: object
+                      - type: object
+                        properties:
+                          data:
+                            type: array
+                            items:
+                              type: object
+                            example: []
+                          total:
+                            type: integer
+                            example: 100
+                          nb_pages:
+                            type: integer
+                            example: 2
+                          limit:
+                            type: integer
+                            example: 50
+                          offset:
+                            type: integer
+                            example: 0
+                          page:
+                            type: integer
+                            example: 1
+            400:
+              description: Invalid filter format or query error
+        """
+        return super().get()
+
+    @jwt_required()
+    def post(self):
+        """
+        Create working file
+        ---
+        tags:
+          - Crud
+        description: Create a new working file with data provided in the
+          request body. JSON format is expected.
+        requestBody:
+          required: true
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - name
+                  - task_id
+                  - entity_id
+                properties:
+                  name:
+                    type: string
+                    example: work_file_v001
+                  task_id:
+                    type: string
+                    format: uuid
+                    example: a24a6ea4-ce75-4665-a070-57453082c25
+                  entity_id:
+                    type: string
+                    format: uuid
+                    example: b24a6ea4-ce75-4665-a070-57453082c25
+                  revision:
+                    type: integer
+                    default: 1
+                    example: 1
+        responses:
+            201:
+              description: Working file created successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      name:
+                        type: string
+                        example: work_file_v001
+                      task_id:
+                        type: string
+                        format: uuid
+                        example: b24a6ea4-ce75-4665-a070-57453082c25
+                      entity_id:
+                        type: string
+                        format: uuid
+                        example: c24a6ea4-ce75-4665-a070-57453082c25
+                      revision:
+                        type: integer
+                        example: 1
+                      created_at:
+                        type: string
+                        format: date-time
+                        example: "2024-01-15T10:30:00Z"
+                      updated_at:
+                        type: string
+                        format: date-time
+                        example: "2024-01-15T10:30:00Z"
+            400:
+              description: Invalid data format or validation error
+        """
+        return super().post()
+
     def add_project_permission_filter(self, query):
         """
         Filtering to keep only the files from projects available to the user's
@@ -54,28 +198,147 @@ class WorkingFileResource(BaseModelResource):
         user_service.check_task_action_access(working_file["task_id"])
         return True
 
+    @jwt_required()
+    def put(self, instance_id):
+        """
+        Update working file
+        ---
+        tags:
+          - Crud
+        description: Update a working file with data provided in the
+          request body. JSON format is expected. Requires task action
+          access.
+        parameters:
+          - in: path
+            name: instance_id
+            required: true
+            schema:
+              type: string
+              format: uuid
+            example: a24a6ea4-ce75-4665-a070-57453082c25
+        requestBody:
+          required: true
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  name:
+                    type: string
+                    example: updated_work_file_v001
+                  revision:
+                    type: integer
+                    example: 2
+        responses:
+            200:
+              description: Working file updated successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      name:
+                        type: string
+                        example: updated_work_file_v001
+                      task_id:
+                        type: string
+                        format: uuid
+                        example: b24a6ea4-ce75-4665-a070-57453082c25
+                      entity_id:
+                        type: string
+                        format: uuid
+                        example: c24a6ea4-ce75-4665-a070-57453082c25
+                      revision:
+                        type: integer
+                        example: 2
+                      created_at:
+                        type: string
+                        format: date-time
+                        example: "2024-01-15T10:30:00Z"
+                      updated_at:
+                        type: string
+                        format: date-time
+                        example: "2024-01-15T11:00:00Z"
+            400:
+              description: Invalid data format or validation error
+        """
+        return super().put(instance_id)
+
+    @jwt_required()
+    def delete(self, instance_id):
+        """
+        Delete working file
+        ---
+        tags:
+          - Crud
+        description: Delete a working file by its ID. Returns empty
+          response on success.
+        parameters:
+          - in: path
+            name: instance_id
+            required: true
+            schema:
+              type: string
+              format: uuid
+            example: a24a6ea4-ce75-4665-a070-57453082c25
+        responses:
+            204:
+              description: Working file deleted successfully
+            400:
+              description: Integrity error or cannot delete
+        """
+        return super().delete(instance_id)
+
     @jwt_required()
     def get(self, instance_id):
         """
-        Retrieve a working file corresponding at given ID and return it as a
-        JSON object.
+        Get working file
         ---
         tags:
           - Crud
+        description: Retrieve a working file instance by its ID and return
+          it as a JSON object.
         parameters:
           - in: path
-            name: working_file_id
-            required: True
-            type: string
-            format: uuid
+            name: instance_id
+            required: true
+            schema:
+              type: string
+              format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
         responses:
             200:
-                description: Model as a JSON object
+              description: Working file retrieved successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      name:
+                        type: string
+                        example: work_file_v001
+                      task_id:
+                        type: string
+                        format: uuid
+                        example: b24a6ea4-ce75-4665-a070-57453082c25
+                      created_at:
+                        type: string
+                        format: date-time
+                        example: "2024-01-15T10:30:00Z"
+                      updated_at:
+                        type: string
+                        format: date-time
+                        example: "2024-01-15T10:30:00Z"
             400:
-                description: Statement error
-            404:
-                description: Value error
+              description: Invalid ID format or query error
         """
         try:
             working_file = files_service.get_working_file(instance_id)

zou/app/blueprints/export/csv/assets.py

@@ -17,20 +17,30 @@ class AssetsCsvExport(Resource):
     @jwt_required()
     def get(self, project_id):
         """
-        Export assets linked to a given project as csv.
+        Export assets csv
         ---
         tags:
           - Export
+        description: Export project assets as CSV file. Includes asset
+          information, task statuses, assignments, and metadata.
+        produces:
+          - text/csv
         parameters:
           - in: path
             name: project_id
-            required: True
-            type: string
-            format: uuid
+            required: true
+            schema:
+              type: string
+              format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
         responses:
             200:
-                description: Assets exported as csv
+              description: Assets exported as CSV successfully
+              content:
+                text/csv:
+                  schema:
+                    type: string
+                  example: "Project,Type,Name,Description,Time Spent\nProject A,Character,Asset1,Description,10.50"
         """
         project = projects_service.get_project(project_id)
         self.check_permissions(project["id"])

zou/app/blueprints/export/csv/base.py

@@ -20,13 +20,22 @@ class BaseCsvExport(Resource):
     @jwt_required()
     def get(self):
         """
-        Export as csv.
+        Export csv
         ---
         tags:
-            - Export
+          - Export
+        description: Export data as CSV file. Returns a CSV file with
+          formatted data based on the resource type.
+        produces:
+          - text/csv
         responses:
             200:
-                description: Exported as csv
+              description: CSV file exported successfully
+              content:
+                text/csv:
+                  schema:
+                    type: string
+                  example: "Header1,Header2\nValue1,Value2"
         """
         self.prepare_import()
         try:

zou/app/blueprints/export/csv/casting.py

@@ -16,20 +16,47 @@ class CastingCsvExport(Resource, ArgsMixin):
     @jwt_required()
     def get(self, project_id):
         """
-        Export casting linked to a given project as csv.
+        Export casting csv
         ---
         tags:
           - Export
+        description: Export project casting links as CSV file. Includes
+          links between assets and shots, sequences, or episodes with
+          occurrence counts and labels.
+        produces:
+          - text/csv
         parameters:
           - in: path
             name: project_id
-            required: True
-            type: string
-            format: uuid
+            required: true
+            schema:
+              type: string
+              format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: query
+            name: episode_id
+            required: false
+            schema:
+              type: string
+              format: uuid
+            example: b24a6ea4-ce75-4665-a070-57453082c25
+            description: Episode ID to filter casting links
+          - in: query
+            name: is_shot_casting
+            required: false
+            schema:
+              type: boolean
+            default: false
+            example: false
+            description: Whether to export shot casting only
         responses:
             200:
-                description: Casting exported as csv
+              description: Casting exported as CSV successfully
+              content:
+                text/csv:
+                  schema:
+                    type: string
+                  example: "Parent,Name,Asset Type,Asset,Occurences,Label\nSequence1,SH010,Character,Asset1,1,fixed"
         """
         project = projects_service.get_project(project_id)  # Check existence
         self.check_permissions(project_id)

zou/app/blueprints/export/csv/edits.py

@@ -16,20 +16,30 @@ class EditsCsvExport(Resource):
     @jwt_required()
     def get(self, project_id):
         """
-        Export edits linked to a given project as csv.
+        Export edits csv
         ---
         tags:
           - Export
+        description: Export project edits as CSV file. Includes edit
+          information, task statuses, assignments, and metadata.
+        produces:
+          - text/csv
         parameters:
           - in: path
             name: project_id
-            required: True
-            type: string
-            format: uuid
+            required: true
+            schema:
+              type: string
+              format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
         responses:
             200:
-                description: Edits exported as csv
+              description: Edits exported as CSV successfully
+              content:
+                text/csv:
+                  schema:
+                    type: string
+                  example: "Project,Episode,Name,Description,Time Spent\nProject A,EP01,Edit_001,Description,8.75"
         """
         self.task_type_map = tasks_service.get_task_type_map()
         self.task_status_map = tasks_service.get_task_status_map()

zou/app/blueprints/export/csv/persons.py

@@ -1,4 +1,5 @@
 from zou.app.blueprints.export.csv.base import BaseCsvExport
+from flask_jwt_extended import jwt_required
 
 from zou.app.models.person import Person
 
@@ -8,6 +9,29 @@ class PersonsCsvExport(BaseCsvExport):
         BaseCsvExport.__init__(self)
         self.file_name = "people_export"
 
+    @jwt_required()
+    def get(self):
+        """
+        Export persons csv
+        ---
+        tags:
+          - Export
+        description: Export persons as CSV file. Includes person information
+          with last name, first name, email, phone, role, contract type,
+          and active status. Excludes bot accounts.
+        produces:
+          - text/csv
+        responses:
+            200:
+              description: Persons exported as CSV successfully
+              content:
+                text/csv:
+                  schema:
+                    type: string
+                  example: "Last Name,First Name,Email,Phone,Role,Contract Type,Active\nDoe,John,john.doe@example.com,+1234567890,user,freelance,yes"
+        """
+        return super().get()
+
     def build_headers(self):
         return [
             "Last Name",

zou/app/blueprints/export/csv/playlists.py

@@ -22,20 +22,31 @@ class PlaylistCsvExport(Resource):
     @jwt_required()
     def get(self, playlist_id):
         """
-        Export a given playlist as csv.
+        Export playlist csv
         ---
         tags:
           - Export
+        description: Export playlist as CSV file. Includes playlist shots
+          with preview information, task statuses, comments, and revision
+          details.
+        produces:
+          - text/csv
         parameters:
           - in: path
             name: playlist_id
-            required: True
-            type: string
-            format: uuid
+            required: true
+            schema:
+              type: string
+              format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
         responses:
             200:
-                description: Playlist exported as csv
+              description: Playlist exported as CSV successfully
+              content:
+                text/csv:
+                  schema:
+                    type: string
+                  example: "Entity name,Nb Frames,Task Type,Retake count,Revision,Task Status,Last comment author,Last comment date,Last comment\nSH010,120,Animation,2,10,WIP,John Doe,2024-01-15,Good work"
         """
         user_service.block_access_to_vendor()
         playlist = playlists_service.get_playlist(playlist_id)

zou/app/blueprints/export/csv/projects.py

@@ -1,4 +1,5 @@
 from zou.app.blueprints.export.csv.base import BaseCsvExport
+from flask_jwt_extended import jwt_required
 
 from zou.app.models.project_status import ProjectStatus
 from zou.app.models.project import Project
@@ -8,6 +9,28 @@ class ProjectsCsvExport(BaseCsvExport):
     def __init__(self):
         BaseCsvExport.__init__(self)
 
+    @jwt_required()
+    def get(self):
+        """
+        Export projects csv
+        ---
+        tags:
+          - Export
+        description: Export projects as CSV file. Includes project name
+          and status information.
+        produces:
+          - text/csv
+        responses:
+            200:
+              description: Projects exported as CSV successfully
+              content:
+                text/csv:
+                  schema:
+                    type: string
+                  example: "Name,Status\nProject A,Active\nProject B,Open"
+        """
+        return super().get()
+
     def build_headers(self):
         return ["Name", "Status"]
 

zou/app/blueprints/export/csv/shots.py

@@ -17,20 +17,30 @@ class ShotsCsvExport(Resource):
     @jwt_required()
     def get(self, project_id):
         """
-        Export shots linked to a given project as csv.
+        Export shots csv
         ---
         tags:
           - Export
+        description: Export project shots as CSV file. Includes shot
+          information, frames, task statuses, assignments, and metadata.
+        produces:
+          - text/csv
         parameters:
           - in: path
             name: project_id
-            required: True
-            type: string
-            format: uuid
+            required: true
+            schema:
+              type: string
+              format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
         responses:
             200:
-                description: Shots exported as csv
+              description: Shots exported as CSV successfully
+              content:
+                text/csv:
+                  schema:
+                    type: string
+                  example: "Project,Episode,Sequence,Name,Description,Time Spent,Frames,Frame In,Frame Out,FPS\nProject A,EP01,SQ01,SH010,Description,5.25,120,1001,1120,24"
         """
         project = projects_service.get_project(project_id)
         self.check_permissions(project["id"])

zou/app/blueprints/export/csv/task_types.py

@@ -1,4 +1,5 @@
 from zou.app.blueprints.export.csv.base import BaseCsvExport
+from flask_jwt_extended import jwt_required
 
 from zou.app.models.department import Department
 from zou.app.models.task_type import TaskType
@@ -10,6 +11,28 @@ class TaskTypesCsvExport(BaseCsvExport):
 
         self.name = "task_types_export"
 
+    @jwt_required()
+    def get(self):
+        """
+        Export task types csv
+        ---
+        tags:
+          - Export
+        description: Export task types as CSV file. Includes department
+          and task type name information.
+        produces:
+          - text/csv
+        responses:
+            200:
+              description: Task types exported as CSV successfully
+              content:
+                text/csv:
+                  schema:
+                    type: string
+                  example: "Department,Name\nAnimation,Animation\nModeling,Modeling"
+        """
+        return super().get()
+
     def build_headers(self):
         return ["Department", "Name"]
 

zou/app/blueprints/export/csv/tasks.py

@@ -1,4 +1,5 @@
 from zou.app.blueprints.export.csv.base import BaseCsvExport
+from flask_jwt_extended import jwt_required
 from sqlalchemy.orm import aliased
 
 from zou.app.models.task_status import TaskStatus
@@ -18,6 +19,29 @@ class TasksCsvExport(BaseCsvExport):
 
         self.file_name = "tasks_export"
 
+    @jwt_required()
+    def get(self):
+        """
+        Export tasks csv
+        ---
+        tags:
+          - Export
+        description: Export tasks as CSV file. Includes tasks from open
+          projects with project, task type, episode, sequence, entity,
+          assigner, assignees, dates, duration, estimation, and status.
+        produces:
+          - text/csv
+        responses:
+            200:
+              description: Tasks exported as CSV successfully
+              content:
+                text/csv:
+                  schema:
+                    type: string
+                  example: "Project,Task Type,Episode,Sequence,Entity Type,Entity,Assigner,Assignees,Duration,Estimation,Start date,Due date,WIP date,Validation date,Task Status\nProject A,Animation,EP01,SQ01,Shot,SH010,John Doe,Jane Doe,480,600,2024-01-01,2024-01-15,2024-01-05,2024-01-20,WIP"
+        """
+        return super().get()
+
     def build_headers(self):
         return [
             "Project",