Class UsageSummaryAvailableFieldsAttributes

The lists of field names returned by GET /api/v1/usage/summary at each of its three response levels. Each list contains every key the data endpoint emits—both typed fields declared in the OpenAPI spec and untyped keys exposed through additionalProperties.

Hierarchy

  • UsageSummaryAvailableFieldsAttributes

Constructors

constructor

Properties

additionalProperties? dateFields? dateOrgFields? responseFields?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional dateFields

dateFields?: string[]

Sorted list of every key returned inside each UsageSummaryDate entry of usage[] (typed fields and additionalProperties keys combined).

Optional dateOrgFields

dateOrgFields?: string[]

Sorted list of every key returned inside each UsageSummaryDateOrg entry of usage[].orgs[] (typed fields and additionalProperties keys combined).

Optional responseFields

responseFields?: string[]

Sorted list of every key returned as a direct property of UsageSummaryResponse (typed fields and additionalProperties keys combined).

Settings

Member Visibility

Theme

Generated using TypeDoc