@crowdin/app-project-module 0.107.0 → 1.0.0

package/out/modules/api/components.d.ts

@@ -4,50 +4,100 @@
  *  schemas:
  *    CrowdinFiles:
  *      type: array
- *      example: [{id: 1, name: Landing pages}, {id: 2, parentId: 1, name: Home Page, type: json}]
+ *      description: 'List of Crowdin files and folders'
+ *      example: [{id: '1', name: 'Landing pages'}, {id: '2', parentId: '1', name: 'Home Page', type: 'json'}]
  *      items:
  *        anyOf:
- *          - properties:
+ *          - type: object
+ *            description: 'Folder'
+ *            properties:
  *              id:
  *                type: string
+ *                description: 'Unique identifier'
  *              name:
  *                type: string
- *          - properties:
+ *                description: 'Folder name'
+ *              parentId:
+ *                type: string
+ *                description: 'Parent folder identifier'
+ *          - type: object
+ *            description: 'File'
+ *            properties:
  *              id:
  *                type: string
+ *                description: 'Unique identifier'
  *              parentId:
  *                type: string
+ *                description: 'Parent folder identifier'
  *              name:
  *                type: string
+ *                description: 'File name'
  *              type:
  *                type: string
+ *                description: 'File type (e.g., json, xml, html)'
+ *              excludedTargetLanguages:
+ *                type: array
+ *                description: 'Languages excluded from translation'
+ *                items:
+ *                  type: string
+ *    NodeType:
+ *      type: string
+ *      description: 'Type of tree element'
+ *      enum:
+ *        - '0'
+ *        - '1'
+ *        - '2'
+ *      x-enum-descriptions:
+ *        - 'Folder'
+ *        - 'File'
+ *        - 'Branch'
  *    IntegrationFiles:
  *      type: array
- *      example: [{id: 1, name: Landing pages, parent_id: 0, node_type: 0}, {name: Intro, id: 73291251883, parentId: Landing pages, type: json, node_type: 1}]
+ *      description: 'List of integration files and folders'
+ *      example: [{id: '1', name: 'Landing pages'}, {id: '73291251883', name: 'Intro', parentId: '1', type: 'json'}]
  *      items:
  *        anyOf:
- *          - properties:
+ *          - type: object
+ *            description: 'Folder'
+ *            properties:
  *              id:
  *                type: string
+ *                description: 'Unique identifier'
  *              name:
  *                type: string
- *              parent_id:
+ *                description: 'Folder name'
+ *              parentId:
  *                type: string
- *              node_type:
+ *                description: 'Parent folder identifier'
+ *          - type: object
+ *            description: 'File'
+ *            properties:
+ *              id:
  *                type: string
- *          - properties:
+ *                description: 'Unique identifier'
  *              name:
  *                type: string
- *              id:
- *                type: string
+ *                description: 'File name'
  *              parentId:
  *                type: string
+ *                description: 'Parent folder identifier'
  *              type:
  *                type: string
- *              node_type:
- *                type: string
+ *                description: 'File type (e.g., json, xml, html)'
+ *              isNew:
+ *                type: boolean
+ *                description: 'Whether file is new (not synced before)'
+ *              isUpdated:
+ *                type: boolean
+ *                description: 'Whether file was updated since last sync'
+ *              notSynced:
+ *                type: boolean
+ *                description: 'Whether file was never synced'
+ *              synced:
+ *                type: boolean
+ *                description: 'Whether file is synced'
  *    UpdateCrowdinFiles:
- *      title: 'Update files'
+ *      title: 'Sync Files to Crowdin'
  *      required:
  *        - projectId
  *        - files
@@ -64,7 +114,7 @@
  *          default: false
  *          example: true
  *    FileLanguagePair:
- *      title: 'Update files'
+ *      title: 'Sync Translations to Integration'
  *      required:
  *        - projectId
  *        - files
@@ -134,7 +184,7 @@
  *          type:
  *            type: string
  *          node_type:
- *            type: string
+ *            $ref: '#/components/schemas/NodeType'
  *          schedule:
  *            type: boolean
  *    UpdateSyncSettingsData:
@@ -199,17 +249,45 @@
  *          type: integer
  *          example: 86
  *    LoginFieldsResponse:
- *      type: array
- *      items:
- *        type: object
- *        properties:
- *          key:
- *            type: string
- *            example: 'apiKey'
- *          name:
- *            type: string
- *            example: 'Service API key'
- *      example: [{ key: 'email', name: 'User email' }, { key: 'password', name: 'User password' }]
+ *      type: object
+ *      properties:
+ *        fields:
+ *          type: array
+ *          items:
+ *            type: object
+ *            properties:
+ *              key:
+ *                type: string
+ *                description: 'Unique field identifier'
+ *                example: 'apiKey'
+ *              name:
+ *                type: string
+ *                description: 'Human-readable field label'
+ *                example: 'Service API key'
+ *              type:
+ *                type: string
+ *                description: 'Field input type'
+ *                enum:
+ *                  - text
+ *                  - password
+ *                  - checkbox
+ *                  - select
+ *                  - textarea
+ *                  - file
+ *                  - notice
+ *                example: 'password'
+ *              options:
+ *                type: array
+ *                description: 'Available options (only for select type)'
+ *                items:
+ *                  type: object
+ *                  properties:
+ *                    label:
+ *                      type: string
+ *                    value:
+ *                      type: string
+ *      example:
+ *        fields: [{ key: 'email', name: 'User email', type: 'text' }, { key: 'password', name: 'User password', type: 'password' }]
  *    Login:
  *      title: 'Login'
  *      required:
@@ -226,8 +304,146 @@
  *      type: object
  *      description: 'Login Form Fields. Get via [Integration Login Form Fields](#operation/integration.fields)'
  *      example: { email: 'user@crowdin.com', password: 'password' }
+ *    JobStatus:
+ *      type: string
+ *      description: 'Possible job statuses'
+ *      enum:
+ *        - created
+ *        - inProgress
+ *        - finished
+ *        - failed
+ *        - canceled
+ *    JobType:
+ *      type: string
+ *      description: 'Possible job types'
+ *      enum:
+ *        - updateCrowdin
+ *        - updateIntegration
+ *        - crowdinSyncSettingsSave
+ *        - integrationSyncSettingsSave
+ *    JobListItem:
+ *      type: object
+ *      description: 'Job item returned in list response'
+ *      properties:
+ *        id:
+ *          type: string
+ *          description: 'Unique identifier of the job'
+ *          example: '067da473-fc0b-43e3-b0a2-09d26af130c1'
+ *        progress:
+ *          type: integer
+ *          description: 'Current progress percentage (0-100)'
+ *          minimum: 0
+ *          maximum: 100
+ *          example: 94
+ *        status:
+ *          $ref: '#/components/schemas/JobStatus'
+ *        title:
+ *          type: string
+ *          description: 'Human-readable title of the job'
+ *          example: 'Sync files to Crowdin'
+ *        type:
+ *          $ref: '#/components/schemas/JobType'
+ *        createdAt:
+ *          type: string
+ *          format: date-time
+ *          description: 'ISO 8601 timestamp when the job was created'
+ *          example: '2024-01-15T10:30:00.000Z'
+ *        finishedAt:
+ *          type: string
+ *          format: date-time
+ *          nullable: true
+ *          description: 'ISO 8601 timestamp when the job finished (null if not finished)'
+ *          example: '2024-01-15T10:35:00.000Z'
  *    Job:
  *      type: object
+ *      description: 'Detailed job information'
+ *      properties:
+ *        id:
+ *          type: string
+ *          description: 'Unique identifier of the job'
+ *          example: '067da473-fc0b-43e3-b0a2-09d26af130c1'
+ *        progress:
+ *          type: integer
+ *          description: 'Current progress percentage (0-100)'
+ *          minimum: 0
+ *          maximum: 100
+ *          example: 94
+ *        status:
+ *          $ref: '#/components/schemas/JobStatus'
+ *        title:
+ *          type: string
+ *          description: 'Human-readable title of the job'
+ *          example: 'Sync files to Crowdin'
+ *        type:
+ *          $ref: '#/components/schemas/JobType'
+ *        info:
+ *          type: string
+ *          nullable: true
+ *          description: 'Additional information about the job progress (e.g., ETA)'
+ *          example: 'About 2 minutes remaining'
+ *        data:
+ *          type: object
+ *          nullable: true
+ *          description: 'Additional data associated with the job'
+ *        payload:
+ *          type: object
+ *          nullable: true
+ *          description: 'Original payload used to create the job'
+ *        attempt:
+ *          type: integer
+ *          nullable: true
+ *          description: 'Current attempt number for retried jobs'
+ *          example: 1
+ *        eta:
+ *          type: number
+ *          nullable: true
+ *          description: 'Estimated time remaining in milliseconds'
+ *          example: 120000
+ *        createdAt:
+ *          type: string
+ *          format: date-time
+ *          description: 'ISO 8601 timestamp when the job was created'
+ *          example: '2024-01-15T10:30:00.000Z'
+ *        updatedAt:
+ *          type: string
+ *          format: date-time
+ *          nullable: true
+ *          description: 'ISO 8601 timestamp when the job was last updated'
+ *          example: '2024-01-15T10:32:00.000Z'
+ *        finishedAt:
+ *          type: string
+ *          format: date-time
+ *          nullable: true
+ *          description: 'ISO 8601 timestamp when the job finished'
+ *          example: '2024-01-15T10:35:00.000Z'
+ *    JobListResponse:
+ *      type: object
+ *      description: 'List of jobs response'
+ *      properties:
+ *        data:
+ *          type: array
+ *          items:
+ *            $ref: '#/components/schemas/JobListItem'
+ *    JobInfoResponse:
+ *      type: object
+ *      description: 'Single job info response'
+ *      properties:
+ *        data:
+ *          $ref: '#/components/schemas/Job'
+ *    ErrorResponse:
+ *      type: object
+ *      properties:
+ *        error:
+ *          type: object
+ *          properties:
+ *            message:
+ *              type: string
+ *              description: 'Error message describing what went wrong'
+ *              example: 'jobId is required'
+ *    JobBasic:
+ *      type: object
+ *      deprecated: true
+ *      description: 'Basic job info (deprecated format)'
  *      properties:
  *        id:
  *          type: string
@@ -247,11 +463,13 @@
  *          example: 'Sync files to Crowdin'
  *    JobResponse:
  *      type: object
+ *      deprecated: true
+ *      description: 'Deprecated. Use Job or JobListResponse instead'
  *      properties:
  *        data:
  *          type: array
  *          items:
- *            $ref: '#/components/schemas/Job'
+ *            $ref: '#/components/schemas/JobBasic'
  *
  *  parameters:
  *    ProjectId:
@@ -262,4 +480,10 @@
  *      schema:
  *        type: integer
  *        example: 12
+ *
+ *  securitySchemes:
+ *    bearerAuth:
+ *      type: http
+ *      scheme: bearer
+ *      description: 'Crowdin API Personal Access Token. Get via [Account Settings](https://crowdin.com/settings#api-key)'
  */