Skip to content
Makaio Framework

Variable: ClientUsageIngestSchema

Makaio Framework

Makaio Framework / contracts/client / ClientUsageIngestSchema

Variable: ClientUsageIngestSchema

Section titled “Variable: ClientUsageIngestSchema”

const ClientUsageIngestSchema: object

Defined in: ../../../packages/contracts/src/client/account-identity.ts:176

Request and response schemas for client.usage.ingest.

Type Declaration

Section titled “Type Declaration”

request

Section titled “request”

request: ZodObject<{ account: ZodObject<{ displayLabel: ZodOptional<ZodString>; identifiers: ZodArray<ZodObject<{ scheme: ZodString; strength: ZodEnum<{ alias: "alias"; strong: "strong"; }>; value: ZodString; }, $strip>>; }, $strip>; clientId: ZodString; metadata: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; observedAt: ZodNumber; source: ZodString; usage: ZodObject<{ windows: ZodArray<ZodObject<{ key: ZodString; label: ZodString; resetsAt: ZodOptional<ZodNumber>; usedPercentage: ZodNumber; }, $strip>>; }, $strip>; }, $strip>

response

Section titled “response”

response: ZodObject<{ clientAccountId: ZodString; snapshot: ZodObject<{ clientAccountId: ZodString; clientId: ZodString; displayLabel: ZodOptional<ZodString>; metadata: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; observedAt: ZodNumber; source: ZodString; usage: ZodObject<{ windows: ZodArray<ZodObject<{ key: ZodString; label: ZodString; resetsAt: ZodOptional<…>; usedPercentage: ZodNumber; }, $strip>>; }, $strip>; }, $strip>; }, $strip>