API Reference — Custom Scheduled Events

naftiko: 1.0.0-alpha2
info:
  label: API Reference — Custom Scheduled Events
  description: 'API Reference — Custom Scheduled Events. 5 operations. Lead operation: Create a scheduled event. Self-contained
    Naftiko capability covering one Zuora business surface.'
  tags:
  - Zuora
  - Custom Scheduled Events
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ZUORA_API_KEY: ZUORA_API_KEY
capability:
  consumes:
  - type: http
    namespace: v1-custom-scheduled-events
    baseUri: https://rest.zuora.com
    description: API Reference — Custom Scheduled Events business capability. Self-contained, no shared references.
    resources:
    - name: events-scheduled-events
      path: /events/scheduled-events
      operations:
      - name: postscheduledevent
        method: POST
        description: Create a scheduled event
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: postScheduledEventRequest
          in: body
          type: string
          required: true
      - name: getscheduledevents
        method: GET
        description: List all scheduled events
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: eventTypeName
          in: query
          type: string
          description: 'The name of the scheduled event. Should be specified in the pattern: ^[A-Za-z]{1,}[\\w\\-]*$'
        - name: apiObject
          in: query
          type: string
          description: 'The base object that the scheduled event is defined upon. Should be specified in the pattern: ^[A-Z][\\w\\-]*$'
        - name: apiField
          in: query
          type: string
          description: 'The base field of the base object in the `apiObject` field. Should be specified in the pattern: ^[A-Z][\\w\\-]*$'
        - name: active
          in: query
          type: boolean
          description: Indicate whether the scheduled event is active or inactive.
        - name: start
          in: query
          type: integer
          description: The first index of the query result. Default to 0 if absent, and the minimum is 0.
        - name: limit
          in: query
          type: integer
          description: The maximum number of data records to be returned. Default to 10 if absent.
    - name: events-scheduled-events-id
      path: /events/scheduled-events/{id}
      operations:
      - name: getscheduledeventbyid
        method: GET
        description: Retrieve a scheduled event by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the scheduled event.
          required: true
      - name: updatescheduledeventbyid
        method: PUT
        description: Update a scheduled event by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the scheduled event.
          required: true
        - name: putScheduledEventRequest
          in: body
          type: string
          required: true
      - name: deletescheduledeventbyid
        method: DELETE
        description: Delete a scheduled event by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the scheduled event.
          required: true
  exposes:
  - type: rest
    namespace: v1-custom-scheduled-events-rest
    port: 8080
    description: REST adapter for API Reference — Custom Scheduled Events. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/events/scheduled-events
      name: events-scheduled-events
      description: REST surface for events-scheduled-events.
      operations:
      - method: POST
        name: postscheduledevent
        description: Create a scheduled event
        call: v1-custom-scheduled-events.postscheduledevent
        with:
          postScheduledEventRequest: rest.postScheduledEventRequest
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getscheduledevents
        description: List all scheduled events
        call: v1-custom-scheduled-events.getscheduledevents
        with:
          eventTypeName: rest.eventTypeName
          apiObject: rest.apiObject
          apiField: rest.apiField
          active: rest.active
          start: rest.start
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/events/scheduled-events/{id}
      name: events-scheduled-events-id
      description: REST surface for events-scheduled-events-id.
      operations:
      - method: GET
        name: getscheduledeventbyid
        description: Retrieve a scheduled event by ID
        call: v1-custom-scheduled-events.getscheduledeventbyid
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatescheduledeventbyid
        description: Update a scheduled event by ID
        call: v1-custom-scheduled-events.updatescheduledeventbyid
        with:
          id: rest.id
          putScheduledEventRequest: rest.putScheduledEventRequest
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletescheduledeventbyid
        description: Delete a scheduled event by ID
        call: v1-custom-scheduled-events.deletescheduledeventbyid
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: v1-custom-scheduled-events-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — Custom Scheduled Events. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: create-scheduled-event
      description: Create a scheduled event
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-custom-scheduled-events.postscheduledevent
      with:
        postScheduledEventRequest: tools.postScheduledEventRequest
      outputParameters:
      - type: object
        mapping: $.
    - name: list-all-scheduled-events
      description: List all scheduled events
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-custom-scheduled-events.getscheduledevents
      with:
        eventTypeName: tools.eventTypeName
        apiObject: tools.apiObject
        apiField: tools.apiField
        active: tools.active
        start: tools.start
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-scheduled-event-id
      description: Retrieve a scheduled event by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-custom-scheduled-events.getscheduledeventbyid
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-scheduled-event-id
      description: Update a scheduled event by ID
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v1-custom-scheduled-events.updatescheduledeventbyid
      with:
        id: tools.id
        putScheduledEventRequest: tools.putScheduledEventRequest
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-scheduled-event-id
      description: Delete a scheduled event by ID
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: v1-custom-scheduled-events.deletescheduledeventbyid
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.