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

zou/app/blueprints/source/shotgun/episode.py

@@ -1,4 +1,5 @@
 from flask import current_app
+from flask_jwt_extended import jwt_required
 
 from zou.app.models.project import Project
 from zou.app.models.entity import Entity
@@ -13,6 +14,83 @@ from zou.app.blueprints.source.shotgun.exception import (
 
 
 class ImportShotgunEpisodesResource(BaseImportShotgunResource):
+    @jwt_required()
+    def post(self):
+        """
+        Import shotgun episodes
+        ---
+        description: Import Shotgun episodes. Send a list of Shotgun episode
+          entries in the JSON body. Returns created or updated episodes.
+        tags:
+          - Import
+        requestBody:
+          required: true
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    id:
+                      type: integer
+                      description: Shotgun ID of the episode
+                      example: 12345
+                    code:
+                      type: string
+                      description: Episode code
+                      example: "EP01"
+                    description:
+                      type: string
+                      description: Episode description
+                      example: "First episode"
+                    project:
+                      type: object
+                      description: Project information
+                      properties:
+                        name:
+                          type: string
+                          example: "My Project"
+              example:
+                - id: 12345
+                  code: "EP01"
+                  description: "First episode"
+                  project:
+                    name: "My Project"
+        responses:
+          200:
+            description: Episodes imported successfully
+            content:
+              application/json:
+                schema:
+                  type: array
+                  items:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        description: Episode unique identifier
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      name:
+                        type: string
+                        description: Episode name
+                        example: "EP01"
+                      created_at:
+                        type: string
+                        format: date-time
+                        description: Creation timestamp
+                        example: "2024-01-15T10:30:00Z"
+                      updated_at:
+                        type: string
+                        format: date-time
+                        description: Update timestamp
+                        example: "2024-01-15T11:00:00Z"
+          400:
+            description: Invalid request body or data format error
+        """
+        return super().post()
+
     def prepare_import(self):
         self.episode_type = shots_service.get_episode_type()
         self.project_map = Project.get_id_map(field="name")
@@ -61,3 +139,49 @@ class ImportRemoveShotgunEpisodeResource(ImportRemoveShotgunBaseResource):
         ImportRemoveShotgunBaseResource.__init__(
             self, Entity, entity_type_id=shots_service.get_episode_type()["id"]
         )
+
+    @jwt_required()
+    def post(self):
+        """
+        Remove shotgun episode
+        ---
+        description: Remove a Shotgun episode from the database. Provide the
+          Shotgun entry ID in the JSON body.
+        tags:
+          - Import
+        requestBody:
+          required: true
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - id
+                properties:
+                  id:
+                    type: integer
+                    description: Shotgun ID of the episode to remove
+                    example: 12345
+              example:
+                id: 12345
+        responses:
+          200:
+            description: Removal result returned
+            content:
+              application/json:
+                schema:
+                  type: object
+                  properties:
+                    success:
+                      type: boolean
+                      description: Whether the removal was successful
+                      example: true
+                    removed_instance_id:
+                      type: string
+                      format: uuid
+                      description: ID of the removed episode, if found
+                      example: a24a6ea4-ce75-4665-a070-57453082c25
+          400:
+            description: Invalid request body or instance not found
+        """
+        return super().post()

zou/app/blueprints/source/shotgun/import_errors.py

@@ -8,19 +8,49 @@ from zou.app.models.data_import_error import DataImportError
 
 
 class ShotgunImportErrorsResource(Resource):
+
     def __init__(self):
         Resource.__init__(self)
 
     @jwt_required()
     def get(self):
         """
-        Import shotgun error resource.
+        Get shotgun import errors
         ---
+        description: Get all Shotgun import errors from the database.
+          Returns a list of data import errors with source "shotgun".
         tags:
           - Import
         responses:
-            200:
-                description: Resource imported
+          200:
+            description: List of import errors retrieved successfully
+            content:
+              application/json:
+                schema:
+                  type: array
+                  items:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        description: Import error unique identifier
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      source:
+                        type: string
+                        description: Source of the import error
+                        example: "shotgun"
+                      event_data:
+                        type: object
+                        description: Error event data
+                        example: {"error": "Import failed"}
+                      created_at:
+                        type: string
+                        format: date-time
+                        description: Creation timestamp
+                        example: "2024-01-15T10:30:00Z"
+          400:
+            description: Invalid request
         """
         criterions = {"source": "shotgun"}
         import_errors = DataImportError.query.filter_by(**criterions).all()
@@ -29,13 +59,61 @@ class ShotgunImportErrorsResource(Resource):
     @jwt_required()
     def post(self):
         """
-        Serialize shotgun error resource.
+        Create shotgun import error
         ---
+        description: Create a new Shotgun import error record. The error
+          event data should be provided in the JSON body.
         tags:
           - Import
+        requestBody:
+          required: true
+          content:
+            application/json:
+              schema:
+                type: object
+                description: Error event data
+                properties:
+                  error:
+                    type: string
+                    description: Error message
+                    example: "Failed to import asset"
+                  details:
+                    type: object
+                    description: Additional error details
+                    example: {"shotgun_id": 12345, "reason": "Missing field"}
+                example:
+                  error: "Failed to import asset"
+                  details:
+                    shotgun_id: 12345
+                    reason: "Missing required field"
         responses:
-            200:
-                description: Resource serialized
+          201:
+            description: Import error created successfully
+            content:
+              application/json:
+                schema:
+                  type: object
+                  properties:
+                    id:
+                      type: string
+                      format: uuid
+                      description: Import error unique identifier
+                      example: a24a6ea4-ce75-4665-a070-57453082c25
+                    source:
+                      type: string
+                      description: Source of the import error
+                      example: "shotgun"
+                    event_data:
+                      type: object
+                      description: Error event data
+                      example: {"error": "Failed to import asset"}
+                    created_at:
+                      type: string
+                      format: date-time
+                      description: Creation timestamp
+                      example: "2024-01-15T10:30:00Z"
+          400:
+            description: Invalid request body
         """
         error = DataImportError(event_data=request.json, source="shotgun")
         error.save()
@@ -49,22 +127,35 @@ class ShotgunImportErrorResource(Resource):
     @jwt_required()
     def delete(self, error_id):
         """
-        Delete error.
+        Delete shotgun import error
         ---
+        description: Delete a Shotgun import error by its unique identifier.
+          Returns success confirmation when the error is deleted.
         tags:
           - Import
         parameters:
           - in: path
             name: error_id
-            required: True
-            type: string
-            format: uuid
+            required: true
+            schema:
+              type: string
+              format: uuid
+            description: Import error unique identifier
             example: a24a6ea4-ce75-4665-a070-57453082c25
         responses:
-            204:
-                description: Error deleted
-            404:
-                description: Error non-existant or Statement error
+          204:
+            description: Import error deleted successfully
+            content:
+              application/json:
+                schema:
+                  type: object
+                  properties:
+                    deletion_success:
+                      type: boolean
+                      description: Whether deletion was successful
+                      example: true
+          400:
+            description: Invalid error ID format
         """
         try:
             error = DataImportError.get(error_id)

zou/app/blueprints/source/shotgun/notes.py

@@ -1,6 +1,7 @@
 import datetime
 
 from flask import current_app
+from flask_jwt_extended import jwt_required
 
 from zou.app.models.task import Task
 from zou.app.models.comment import Comment
@@ -13,6 +14,91 @@ from zou.app.blueprints.source.shotgun.base import (
 
 
 class ImportShotgunNotesResource(BaseImportShotgunResource):
+    @jwt_required()
+    def post(self):
+        """
+        Import shotgun notes
+        ---
+        description: Import Shotgun notes (comments) linked to tasks. Send a
+          list of Shotgun note entries in the JSON body. Only notes linked to
+          tasks are imported. Returns created or updated comments.
+        tags:
+          - Import
+        requestBody:
+          required: true
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    id:
+                      type: integer
+                      description: Shotgun ID of the note
+                      example: 12345
+                    content:
+                      type: string
+                      description: Note content
+                      example: "This is a comment"
+                    tasks:
+                      type: array
+                      description: Linked tasks
+                      items:
+                        type: object
+                        properties:
+                          id:
+                            type: integer
+                            example: 67890
+                    user:
+                      type: object
+                      description: User who created the note
+                      properties:
+                        id:
+                          type: integer
+                          example: 11111
+                    created_at:
+                      type: string
+                      format: date-time
+                      description: Creation timestamp
+                      example: "2024-01-15T10:30:00Z"
+              example:
+                - id: 12345
+                  content: "This is a comment"
+                  tasks:
+                    - id: 67890
+                  user:
+                    id: 11111
+                  created_at: "2024-01-15T10:30:00Z"
+        responses:
+          200:
+            description: Notes imported successfully
+            content:
+              application/json:
+                schema:
+                  type: array
+                  items:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        description: Comment unique identifier
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      text:
+                        type: string
+                        description: Comment text
+                        example: "This is a comment"
+                      created_at:
+                        type: string
+                        format: date-time
+                        description: Creation timestamp
+                        example: "2024-01-15T10:30:00Z"
+          400:
+            description: Invalid request body or data format error
+        """
+        return super().post()
+
     def prepare_import(self):
         self.person_ids = Person.get_id_map()
 
@@ -58,3 +144,49 @@ class ImportShotgunNotesResource(BaseImportShotgunResource):
 class ImportRemoveShotgunNoteResource(ImportRemoveShotgunBaseResource):
     def __init__(self):
         ImportRemoveShotgunBaseResource.__init__(self, Comment)
+
+    @jwt_required()
+    def post(self):
+        """
+        Remove shotgun note
+        ---
+        description: Remove a Shotgun note (comment) from the database.
+          Provide the Shotgun entry ID in the JSON body.
+        tags:
+          - Import
+        requestBody:
+          required: true
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - id
+                properties:
+                  id:
+                    type: integer
+                    description: Shotgun ID of the note to remove
+                    example: 12345
+              example:
+                id: 12345
+        responses:
+          200:
+            description: Removal result returned
+            content:
+              application/json:
+                schema:
+                  type: object
+                  properties:
+                    success:
+                      type: boolean
+                      description: Whether the removal was successful
+                      example: true
+                    removed_instance_id:
+                      type: string
+                      format: uuid
+                      description: ID of the removed note, if found
+                      example: a24a6ea4-ce75-4665-a070-57453082c25
+          400:
+            description: Invalid request body or instance not found
+        """
+        return super().post()

zou/app/blueprints/source/shotgun/person.py

@@ -1,4 +1,5 @@
 from flask import current_app
+from flask_jwt_extended import jwt_required
 
 from zou.app import db
 from zou.app.models.department import Department
@@ -17,6 +18,122 @@ class ImportShotgunPersonsResource(BaseImportShotgunResource):
     def __init__(self):
         BaseImportShotgunResource.__init__(self)
 
+    @jwt_required()
+    def post(self):
+        """
+        Import shotgun persons
+        ---
+        description: Import Shotgun persons (users). Send a list of Shotgun
+          person entries in the JSON body. Returns created or updated persons
+          with department associations.
+        tags:
+          - Import
+        requestBody:
+          required: true
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    id:
+                      type: integer
+                      description: Shotgun ID of the person
+                      example: 12345
+                    firstname:
+                      type: string
+                      description: First name
+                      example: "John"
+                    lastname:
+                      type: string
+                      description: Last name
+                      example: "Doe"
+                    email:
+                      type: string
+                      format: email
+                      description: Email address
+                      example: "john.doe@example.com"
+                    login:
+                      type: string
+                      description: Desktop login
+                      example: "jdoe"
+                    sg_status_list:
+                      type: string
+                      description: Status list
+                      example: "act"
+                    permission_rule_set:
+                      type: object
+                      description: Permission rule set
+                      properties:
+                        name:
+                          type: string
+                          example: "Manager"
+                    department:
+                      type: object
+                      description: Department information
+                      properties:
+                        name:
+                          type: string
+                          example: "Animation"
+              example:
+                - id: 12345
+                  firstname: "John"
+                  lastname: "Doe"
+                  email: "john.doe@example.com"
+                  login: "jdoe"
+                  sg_status_list: "act"
+                  permission_rule_set:
+                    name: "Manager"
+                  department:
+                    name: "Animation"
+        responses:
+          200:
+            description: Persons imported successfully
+            content:
+              application/json:
+                schema:
+                  type: array
+                  items:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        description: Person unique identifier
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      first_name:
+                        type: string
+                        description: First name
+                        example: "John"
+                      last_name:
+                        type: string
+                        description: Last name
+                        example: "Doe"
+                      email:
+                        type: string
+                        format: email
+                        description: Email address
+                        example: "john.doe@example.com"
+                      role:
+                        type: string
+                        description: User role
+                        example: "manager"
+                      created_at:
+                        type: string
+                        format: date-time
+                        description: Creation timestamp
+                        example: "2024-01-15T10:30:00Z"
+                      updated_at:
+                        type: string
+                        format: date-time
+                        description: Update timestamp
+                        example: "2024-01-15T11:00:00Z"
+          400:
+            description: Invalid request body or data format error
+        """
+        return super().post()
+
     def extract_data(self, sg_person):
         is_active = sg_person.get("sg_status_list", "act") == "act"
         role = "user"
@@ -97,3 +214,49 @@ class ImportShotgunPersonsResource(BaseImportShotgunResource):
 class ImportRemoveShotgunPersonResource(ImportRemoveShotgunBaseResource):
     def __init__(self):
         ImportRemoveShotgunBaseResource.__init__(self, Person)
+
+    @jwt_required()
+    def post(self):
+        """
+        Remove shotgun person
+        ---
+        description: Remove a Shotgun person (user) from the database. Provide
+          the Shotgun entry ID in the JSON body.
+        tags:
+          - Import
+        requestBody:
+          required: true
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - id
+                properties:
+                  id:
+                    type: integer
+                    description: Shotgun ID of the person to remove
+                    example: 12345
+              example:
+                id: 12345
+        responses:
+          200:
+            description: Removal result returned
+            content:
+              application/json:
+                schema:
+                  type: object
+                  properties:
+                    success:
+                      type: boolean
+                      description: Whether the removal was successful
+                      example: true
+                    removed_instance_id:
+                      type: string
+                      format: uuid
+                      description: ID of the removed person, if found
+                      example: a24a6ea4-ce75-4665-a070-57453082c25
+          400:
+            description: Invalid request body or instance not found
+        """
+        return super().post()