Pipedream Connect Usage and Users Report

arazzo: 1.0.1
info:
  title: Pipedream Connect Usage and Users Report
  summary: List external users for a project, then pull Connect usage records for a window.
  description: >-
    A reporting flow that pairs a project's external user roster with its
    Connect credit usage. The workflow lists the external users registered in
    the project environment, then retrieves the Connect usage records for the
    supplied time window so consumption can be reconciled against the user base.
    Every step spells out its request inline so the flow can be read and
    executed without opening the underlying OpenAPI description.
  version: 1.0.0
sourceDescriptions:
- name: usageApi
  url: ../openapi/pipedream-usage-api-openapi.yml
  type: openapi
- name: usersApi
  url: ../openapi/pipedream-users-api-openapi.yml
  type: openapi
workflows:
- workflowId: usage-and-users-report
  summary: Roster the project's external users and pull Connect usage for a window.
  description: >-
    Lists external users for the project environment, then fetches Connect usage
    records between the supplied start and end timestamps.
  inputs:
    type: object
    required:
    - projectId
    - environment
    - startTs
    - endTs
    properties:
      projectId:
        type: string
        description: The project ID, which starts with proj_.
      environment:
        type: string
        description: The Connect environment (development or production).
      startTs:
        type: integer
        description: Usage window start timestamp in seconds.
      endTs:
        type: integer
        description: Usage window end timestamp in seconds.
  steps:
  - stepId: listUsers
    description: >-
      List the external users registered in the project environment to establish
      the user roster for the report.
    operationId: listUsers
    parameters:
    - name: project_id
      in: path
      value: $inputs.projectId
    - name: x-pd-environment
      in: header
      value: $inputs.environment
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      users: $response.body#/data
  - stepId: listUsage
    description: >-
      Retrieve the Connect usage records for the supplied time window so credit
      consumption can be reported.
    operationId: listUsages
    parameters:
    - name: start_ts
      in: query
      value: $inputs.startTs
    - name: end_ts
      in: query
      value: $inputs.endTs
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      usage: $response.body#/data
  outputs:
    users: $steps.listUsers.outputs.users
    usage: $steps.listUsage.outputs.usage