Account Management — billFormat

naftiko: 1.0.0-alpha2
info:
  label: Account Management — billFormat
  description: 'Account Management — billFormat. 5 operations. Lead operation: List or find BillFormat objects. Self-contained
    Naftiko capability covering one Tm Forum business surface.'
  tags:
  - Tm Forum
  - billFormat
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TM_FORUM_API_KEY: TM_FORUM_API_KEY
capability:
  consumes:
  - type: http
    namespace: tmf666-account-management-billformat
    baseUri: https://serverRoot/tmf-api/accountManagement/v4
    description: Account Management — billFormat business capability. Self-contained, no shared references.
    resources:
    - name: billFormat
      path: /billFormat
      operations:
      - name: listbillformat
        method: GET
        description: List or find BillFormat objects
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: string
          description: Comma-separated properties to be provided in response
        - name: offset
          in: query
          type: integer
          description: Requested index for start of resources to be provided in response
        - name: limit
          in: query
          type: integer
          description: Requested number of resources to be provided in response
      - name: createbillformat
        method: POST
        description: Creates a BillFormat
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: billFormat
          in: body
          type: string
          description: The BillFormat to be created
          required: true
    - name: billFormat-id
      path: /billFormat/{id}
      operations:
      - name: retrievebillformat
        method: GET
        description: Retrieves a BillFormat by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Identifier of the BillFormat
          required: true
        - name: fields
          in: query
          type: string
          description: Comma-separated properties to provide in response
      - name: patchbillformat
        method: PATCH
        description: Updates partially a BillFormat
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Identifier of the BillFormat
          required: true
        - name: billFormat
          in: body
          type: string
          description: The BillFormat to be updated
          required: true
      - name: deletebillformat
        method: DELETE
        description: Deletes a BillFormat
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Identifier of the BillFormat
          required: true
  exposes:
  - type: rest
    namespace: tmf666-account-management-billformat-rest
    port: 8080
    description: REST adapter for Account Management — billFormat. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/billformat
      name: billformat
      description: REST surface for billFormat.
      operations:
      - method: GET
        name: listbillformat
        description: List or find BillFormat objects
        call: tmf666-account-management-billformat.listbillformat
        with:
          fields: rest.fields
          offset: rest.offset
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createbillformat
        description: Creates a BillFormat
        call: tmf666-account-management-billformat.createbillformat
        with:
          billFormat: rest.billFormat
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/billformat/{id}
      name: billformat-id
      description: REST surface for billFormat-id.
      operations:
      - method: GET
        name: retrievebillformat
        description: Retrieves a BillFormat by ID
        call: tmf666-account-management-billformat.retrievebillformat
        with:
          id: rest.id
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchbillformat
        description: Updates partially a BillFormat
        call: tmf666-account-management-billformat.patchbillformat
        with:
          id: rest.id
          billFormat: rest.billFormat
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletebillformat
        description: Deletes a BillFormat
        call: tmf666-account-management-billformat.deletebillformat
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: tmf666-account-management-billformat-mcp
    port: 9090
    transport: http
    description: MCP adapter for Account Management — billFormat. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-find-billformat-objects
      description: List or find BillFormat objects
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: tmf666-account-management-billformat.listbillformat
      with:
        fields: tools.fields
        offset: tools.offset
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: creates-billformat
      description: Creates a BillFormat
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: tmf666-account-management-billformat.createbillformat
      with:
        billFormat: tools.billFormat
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieves-billformat-id
      description: Retrieves a BillFormat by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: tmf666-account-management-billformat.retrievebillformat
      with:
        id: tools.id
        fields: tools.fields
      outputParameters:
      - type: object
        mapping: $.
    - name: updates-partially-billformat
      description: Updates partially a BillFormat
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: tmf666-account-management-billformat.patchbillformat
      with:
        id: tools.id
        billFormat: tools.billFormat
      outputParameters:
      - type: object
        mapping: $.
    - name: deletes-billformat
      description: Deletes a BillFormat
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: tmf666-account-management-billformat.deletebillformat
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.