API Reference — subpackage_simulations

naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_simulations
  description: 'API Reference — subpackage_simulations. 2 operations. Lead operation: Simulates Shipment. Self-contained Naftiko
    capability covering one Shipbob business surface.'
  tags:
  - Shipbob
  - subpackage_simulations
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SHIPBOB_API_KEY: SHIPBOB_API_KEY
capability:
  consumes:
  - type: http
    namespace: shipbob-subpackage-simulations
    baseUri: https://api.shipbob.com
    description: API Reference — subpackage_simulations business capability. Self-contained, no shared references.
    resources:
    - name: 2026-01-simulate-shipment
      path: /2026-01/simulate/shipment
      operations:
      - name: simulatesshipment
        method: POST
        description: Simulates Shipment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: Authentication using Personal Access Token (PAT) token or OAuth2
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: 2026-01-simulate-status-simulationId
      path: /2026-01/simulate/status/{simulationId}
      operations:
      - name: getsimulationstatus
        method: GET
        description: Get Simulation Status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: simulationId
          in: path
          type: string
          description: The simulation id
          required: true
        - name: Authorization
          in: header
          type: string
          description: Authentication using Personal Access Token (PAT) token or OAuth2
          required: true
    authentication:
      type: bearer
      token: '{{env.SHIPBOB_API_KEY}}'
  exposes:
  - type: rest
    namespace: shipbob-subpackage-simulations-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_simulations. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/2026-01/simulate/shipment
      name: 2026-01-simulate-shipment
      description: REST surface for 2026-01-simulate-shipment.
      operations:
      - method: POST
        name: simulatesshipment
        description: Simulates Shipment
        call: shipbob-subpackage-simulations.simulatesshipment
        with:
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/2026-01/simulate/status/{simulationid}
      name: 2026-01-simulate-status-simulationid
      description: REST surface for 2026-01-simulate-status-simulationId.
      operations:
      - method: GET
        name: getsimulationstatus
        description: Get Simulation Status
        call: shipbob-subpackage-simulations.getsimulationstatus
        with:
          simulationId: rest.simulationId
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: shipbob-subpackage-simulations-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_simulations. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: simulates-shipment
      description: Simulates Shipment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shipbob-subpackage-simulations.simulatesshipment
      with:
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-simulation-status
      description: Get Simulation Status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shipbob-subpackage-simulations.getsimulationstatus
      with:
        simulationId: tools.simulationId
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.