CalOohPay API Documentation - v2.1.0
    Preparing search index...

    Interface CommandLineOptions

    Configuration options for the CalOohPay command-line interface.

    Defines all the parameters that can be provided when running the CLI tool to calculate on-call payments. These options control which schedules to query, the time period to analyze, authentication, and output preferences.

    const options: CommandLineOptions = {
      rotaIds: 'SCHEDULE1,SCHEDULE2',
      since: '2024-08-01',
      until: '2024-08-31',
      timeZoneId: 'Europe/London',
      key: 'api-key-here',
      outputFile: 'output/payments.csv',
      help: false
    };
    interface CommandLineOptions {
        help?: boolean;
        key?: string;
        outputFile?: string;
        rotaIds: string;
        since: string;
        timeZoneId?: string;
        until: string;
    }
    Index

    Properties

    help? key? outputFile? rotaIds since timeZoneId? until

    Properties

    help?: boolean

    Whether to display help information. When true, shows usage instructions and exits without processing.

    key?: string

    PagerDuty API authentication token. Can also be provided via API_TOKEN environment variable. Command-line value takes precedence over environment variable.

    outputFile?: string

    Path to the output CSV file for payroll data. File will be created with Google Sheets compatible format. Directory will be created if it doesn't exist.

    'output/august-2024-payments.csv'
    rotaIds: string

    Comma-separated list of PagerDuty schedule IDs to analyze. Each schedule will be processed independently and results combined.

    'PXXXXXX,PYYYYYY'
    since: string

    Start date for the analysis period in ISO format (YYYY-MM-DD). Will be coerced to midnight (00:00:00) in the schedule's timezone.

    '2024-08-01'
    timeZoneId?: string

    Optional IANA timezone identifier to override the schedule's default timezone. If not provided, uses the timezone configured in PagerDuty schedule.

    'America/New_York' or 'Asia/Tokyo'
    until: string

    End date for the analysis period in ISO format (YYYY-MM-DD). Will be coerced to end of day (23:59:59.999) in the schedule's timezone.

    '2024-08-31'

    Settings

    Member Visibility

    On This Page

    Properties