Endpoints — subpackage_workerInformation

naftiko: 1.0.0-alpha2
info:
  label: Endpoints — subpackage_workerInformation
  description: 'Endpoints — subpackage_workerInformation. 10 operations. Lead operation: Add GP Workers Additional Information.
    Self-contained Naftiko capability covering one Deel business surface.'
  tags:
  - Deel
  - subpackage_workerInformation
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    DEEL_API_KEY: DEEL_API_KEY
capability:
  consumes:
  - type: http
    namespace: global-payroll-endpoints-subpackage-workerinformation
    baseUri: https://api.letsdeel.com/rest/v2
    description: Endpoints — subpackage_workerInformation business capability. Self-contained, no shared references.
    resources:
    - name: gp-workers-contracts-contract_id-additional-information
      path: /gp/workers/contracts/{contract_id}/additional-information
      operations:
      - name: creategpworkeradditionalinformation
        method: POST
        description: Add GP Workers Additional Information
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: contract_id
          in: path
          type: string
          description: The unique public identifier of the contract.
          required: true
        - name: Authorization
          in: header
          type: string
          description: '## Authentication'
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: getgpworkeradditionalinformation
        method: PATCH
        description: Update GP Workers Additional Information
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: contract_id
          in: path
          type: string
          description: The unique public identifier of the contract.
          required: true
        - name: Authorization
          in: header
          type: string
          description: '## Authentication'
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: gp-workers-worker_id-address
      path: /gp/workers/{worker_id}/address
      operations:
      - name: updategpworkeraddress
        method: PATCH
        description: Update address
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: worker_id
          in: path
          type: string
          description: Unique identifier for a worker in UUID format.
          required: true
        - name: Authorization
          in: header
          type: string
          description: '## Authentication'
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: gp-workers-worker_id-banks
      path: /gp/workers/{worker_id}/banks
      operations:
      - name: creategpworkerbank
        method: POST
        description: Add bank account
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: worker_id
          in: path
          type: string
          description: Unique identifier for a worker in UUID format.
          required: true
        - name: Authorization
          in: header
          type: string
          description: '## Authentication'
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: getgpworkerbanks
        method: GET
        description: Retrieve bank accounts
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: worker_id
          in: path
          type: string
          description: Unique identifier for a worker.
          required: true
        - name: Authorization
          in: header
          type: string
          description: '## Authentication'
          required: true
    - name: gp-workers-worker_id-banks-guide
      path: /gp/workers/{worker_id}/banks/guide
      operations:
      - name: getgpworkerbankguide
        method: GET
        description: Retrieve bank guide
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: worker_id
          in: path
          type: string
          description: Unique identifier for a worker in UUID format.
          required: true
        - name: Authorization
          in: header
          type: string
          description: '## Authentication'
          required: true
    - name: gp-workers-worker_id-banks-bank_id
      path: /gp/workers/{worker_id}/banks/{bank_id}
      operations:
      - name: updategpworkerbank
        method: PATCH
        description: Modify bank account
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: worker_id
          in: path
          type: string
          description: Unique identifier for a worker in UUID format.
          required: true
        - name: bank_id
          in: path
          type: string
          description: Unique identifier for the bank account in UUID format.
          required: true
        - name: Authorization
          in: header
          type: string
          description: '## Authentication'
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: gp-workers-worker_id-compensation
      path: /gp/workers/{worker_id}/compensation
      operations:
      - name: updategpworkercompensation
        method: PATCH
        description: Update compensation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: worker_id
          in: path
          type: string
          description: Unique identifier for a worker in UUID format.
          required: true
        - name: Authorization
          in: header
          type: string
          description: '## Authentication'
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: gp-workers-worker_id-employee-information
      path: /gp/workers/{worker_id}/employee-information
      operations:
      - name: updategpworkeremployeeinformation
        method: PATCH
        description: Update employee information
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: worker_id
          in: path
          type: string
          description: Unique identifier for a worker in UUID format.
          required: true
        - name: Authorization
          in: header
          type: string
          description: '## Authentication'
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: gp-workers-worker_id-pto-policy
      path: /gp/workers/{worker_id}/pto-policy
      operations:
      - name: updategpworkerptopolicy
        method: PATCH
        description: Update PTO policy
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: worker_id
          in: path
          type: string
          description: Unique identifier for a worker in UUID format.
          required: true
        - name: Authorization
          in: header
          type: string
          description: '## Authentication'
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: bearer
      token: '{{env.DEEL_API_KEY}}'
  exposes:
  - type: rest
    namespace: global-payroll-endpoints-subpackage-workerinformation-rest
    port: 8080
    description: REST adapter for Endpoints — subpackage_workerInformation. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/gp/workers/contracts/{contract-id}/additional-information
      name: gp-workers-contracts-contract-id-additional-information
      description: REST surface for gp-workers-contracts-contract_id-additional-information.
      operations:
      - method: POST
        name: creategpworkeradditionalinformation
        description: Add GP Workers Additional Information
        call: global-payroll-endpoints-subpackage-workerinformation.creategpworkeradditionalinformation
        with:
          contract_id: rest.contract_id
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: getgpworkeradditionalinformation
        description: Update GP Workers Additional Information
        call: global-payroll-endpoints-subpackage-workerinformation.getgpworkeradditionalinformation
        with:
          contract_id: rest.contract_id
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/gp/workers/{worker-id}/address
      name: gp-workers-worker-id-address
      description: REST surface for gp-workers-worker_id-address.
      operations:
      - method: PATCH
        name: updategpworkeraddress
        description: Update address
        call: global-payroll-endpoints-subpackage-workerinformation.updategpworkeraddress
        with:
          worker_id: rest.worker_id
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/gp/workers/{worker-id}/banks
      name: gp-workers-worker-id-banks
      description: REST surface for gp-workers-worker_id-banks.
      operations:
      - method: POST
        name: creategpworkerbank
        description: Add bank account
        call: global-payroll-endpoints-subpackage-workerinformation.creategpworkerbank
        with:
          worker_id: rest.worker_id
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getgpworkerbanks
        description: Retrieve bank accounts
        call: global-payroll-endpoints-subpackage-workerinformation.getgpworkerbanks
        with:
          worker_id: rest.worker_id
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/gp/workers/{worker-id}/banks/guide
      name: gp-workers-worker-id-banks-guide
      description: REST surface for gp-workers-worker_id-banks-guide.
      operations:
      - method: GET
        name: getgpworkerbankguide
        description: Retrieve bank guide
        call: global-payroll-endpoints-subpackage-workerinformation.getgpworkerbankguide
        with:
          worker_id: rest.worker_id
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/gp/workers/{worker-id}/banks/{bank-id}
      name: gp-workers-worker-id-banks-bank-id
      description: REST surface for gp-workers-worker_id-banks-bank_id.
      operations:
      - method: PATCH
        name: updategpworkerbank
        description: Modify bank account
        call: global-payroll-endpoints-subpackage-workerinformation.updategpworkerbank
        with:
          worker_id: rest.worker_id
          bank_id: rest.bank_id
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/gp/workers/{worker-id}/compensation
      name: gp-workers-worker-id-compensation
      description: REST surface for gp-workers-worker_id-compensation.
      operations:
      - method: PATCH
        name: updategpworkercompensation
        description: Update compensation
        call: global-payroll-endpoints-subpackage-workerinformation.updategpworkercompensation
        with:
          worker_id: rest.worker_id
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/gp/workers/{worker-id}/employee-information
      name: gp-workers-worker-id-employee-information
      description: REST surface for gp-workers-worker_id-employee-information.
      operations:
      - method: PATCH
        name: updategpworkeremployeeinformation
        description: Update employee information
        call: global-payroll-endpoints-subpackage-workerinformation.updategpworkeremployeeinformation
        with:
          worker_id: rest.worker_id
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/gp/workers/{worker-id}/pto-policy
      name: gp-workers-worker-id-pto-policy
      description: REST surface for gp-workers-worker_id-pto-policy.
      operations:
      - method: PATCH
        name: updategpworkerptopolicy
        description: Update PTO policy
        call: global-payroll-endpoints-subpackage-workerinformation.updategpworkerptopolicy
        with:
          worker_id: rest.worker_id
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: global-payroll-endpoints-subpackage-workerinformation-mcp
    port: 9090
    transport: http
    description: MCP adapter for Endpoints — subpackage_workerInformation. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: add-gp-workers-additional-information
      description: Add GP Workers Additional Information
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: global-payroll-endpoints-subpackage-workerinformation.creategpworkeradditionalinformation
      with:
        contract_id: tools.contract_id
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-gp-workers-additional-information
      description: Update GP Workers Additional Information
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: global-payroll-endpoints-subpackage-workerinformation.getgpworkeradditionalinformation
      with:
        contract_id: tools.contract_id
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-address
      description: Update address
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: global-payroll-endpoints-subpackage-workerinformation.updategpworkeraddress
      with:
        worker_id: tools.worker_id
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: add-bank-account
      description: Add bank account
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: global-payroll-endpoints-subpackage-workerinformation.creategpworkerbank
      with:
        worker_id: tools.worker_id
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-bank-accounts
      description: Retrieve bank accounts
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: global-payroll-endpoints-subpackage-workerinformation.getgpworkerbanks
      with:
        worker_id: tools.worker_id
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-bank-guide
      description: Retrieve bank guide
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: global-payroll-endpoints-subpackage-workerinformation.getgpworkerbankguide
      with:
        worker_id: tools.worker_id
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: modify-bank-account
      description: Modify bank account
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: global-payroll-endpoints-subpackage-workerinformation.updategpworkerbank
      with:
        worker_id: tools.worker_id
        bank_id: tools.bank_id
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-compensation
      description: Update compensation
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: global-payroll-endpoints-subpackage-workerinformation.updategpworkercompensation
      with:
        worker_id: tools.worker_id
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-employee-information
      description: Update employee information
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: global-payroll-endpoints-subpackage-workerinformation.updategpworkeremployeeinformation
      with:
        worker_id: tools.worker_id
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-pto-policy
      description: Update PTO policy
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: global-payroll-endpoints-subpackage-workerinformation.updategpworkerptopolicy
      with:
        worker_id: tools.worker_id
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.