API Reference — Sequence Sets

naftiko: 1.0.0-alpha2
info:
  label: API Reference — Sequence Sets
  description: 'API Reference — Sequence Sets. 5 operations. Lead operation: Create sequence sets. Self-contained Naftiko
    capability covering one Zuora business surface.'
  tags:
  - Zuora
  - Sequence Sets
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ZUORA_API_KEY: ZUORA_API_KEY
capability:
  consumes:
  - type: http
    namespace: v1-sequence-sets
    baseUri: https://rest.zuora.com
    description: API Reference — Sequence Sets business capability. Self-contained, no shared references.
    resources:
    - name: v1-sequence-sets
      path: /v1/sequence-sets
      operations:
      - name: postsequencesets
        method: POST
        description: Create sequence sets
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Request
          in: body
          type: string
          required: true
      - name: getsequencesets
        method: GET
        description: List sequence sets
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: query
          type: string
          description: The name of a specific sequence set.
    - name: v1-sequence-sets-id
      path: /v1/sequence-sets/{id}
      operations:
      - name: putsequenceset
        method: PUT
        description: Update a sequence set
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the sequence set to update.
          required: true
        - name: Request
          in: body
          type: string
      - name: getsequenceset
        method: GET
        description: Retrieve a sequence set
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the sequence set to retrieve information about.
          required: true
      - name: deletesequenceset
        method: DELETE
        description: Delete a sequence set
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the sequence set to delete.
          required: true
  exposes:
  - type: rest
    namespace: v1-sequence-sets-rest
    port: 8080
    description: REST adapter for API Reference — Sequence Sets. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v1/sequence-sets
      name: v1-sequence-sets
      description: REST surface for v1-sequence-sets.
      operations:
      - method: POST
        name: postsequencesets
        description: Create sequence sets
        call: v1-sequence-sets.postsequencesets
        with:
          Request: rest.Request
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getsequencesets
        description: List sequence sets
        call: v1-sequence-sets.getsequencesets
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/sequence-sets/{id}
      name: v1-sequence-sets-id
      description: REST surface for v1-sequence-sets-id.
      operations:
      - method: PUT
        name: putsequenceset
        description: Update a sequence set
        call: v1-sequence-sets.putsequenceset
        with:
          id: rest.id
          Request: rest.Request
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getsequenceset
        description: Retrieve a sequence set
        call: v1-sequence-sets.getsequenceset
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletesequenceset
        description: Delete a sequence set
        call: v1-sequence-sets.deletesequenceset
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: v1-sequence-sets-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — Sequence Sets. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: create-sequence-sets
      description: Create sequence sets
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-sequence-sets.postsequencesets
      with:
        Request: tools.Request
      outputParameters:
      - type: object
        mapping: $.
    - name: list-sequence-sets
      description: List sequence sets
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-sequence-sets.getsequencesets
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: update-sequence-set
      description: Update a sequence set
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v1-sequence-sets.putsequenceset
      with:
        id: tools.id
        Request: tools.Request
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-sequence-set
      description: Retrieve a sequence set
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-sequence-sets.getsequenceset
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-sequence-set
      description: Delete a sequence set
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: v1-sequence-sets.deletesequenceset
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.