griddy-sdk / EndpointConfig

Interface: EndpointConfig\<T>¶

Defined in: src/griddy/nfl/baseSdk.ts:32

Configuration for an API endpoint.

Type Parameters¶

T¶

T = unknown

Properties¶

acceptHeaderValue?¶

optional acceptHeaderValue: string

Defined in: src/griddy/nfl/baseSdk.ts:68

Accept header value

errorStatusCodes¶

errorStatusCodes: string[]

Defined in: src/griddy/nfl/baseSdk.ts:46

Expected error status codes

getSerializedBody()?¶

optional getSerializedBody: () => SerializedRequestBody

Defined in: src/griddy/nfl/baseSdk.ts:64

Body serializer function

Returns¶

SerializedRequestBody

httpHeaders?¶

optional httpHeaders: Record\<string, string>

Defined in: src/griddy/nfl/baseSdk.ts:58

Additional HTTP headers

method¶

method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH"

Defined in: src/griddy/nfl/baseSdk.ts:34

HTTP method

operationId¶

operationId: string

Defined in: src/griddy/nfl/baseSdk.ts:38

Operation identifier

path¶

path: string

Defined in: src/griddy/nfl/baseSdk.ts:36

URL path with {param} placeholders

request¶

request: Record\<string, unknown>

Defined in: src/griddy/nfl/baseSdk.ts:40

Request parameters

requestBodyRequired?¶

optional requestBodyRequired: boolean

Defined in: src/griddy/nfl/baseSdk.ts:48

Whether request body is required

requestHasPathParams?¶

optional requestHasPathParams: boolean

Defined in: src/griddy/nfl/baseSdk.ts:50

Whether request has path parameters

requestHasQueryParams?¶

optional requestHasQueryParams: boolean

Defined in: src/griddy/nfl/baseSdk.ts:52

Whether request has query parameters

requestMeta?¶

optional requestMeta: Record\<string, ParamMetadata>

Defined in: src/griddy/nfl/baseSdk.ts:42

Request parameter metadata

responseType?¶

optional responseType: string

Defined in: src/griddy/nfl/baseSdk.ts:44

Response type constructor (for documentation)

retries?¶

optional retries: typeof UNSET | RetryConfig

Defined in: src/griddy/nfl/baseSdk.ts:60

Retry configuration

returnRawJson?¶

optional returnRawJson: boolean

Defined in: src/griddy/nfl/baseSdk.ts:62

Return raw JSON instead of typed response

serverUrl?¶

optional serverUrl: string

Defined in: src/griddy/nfl/baseSdk.ts:54

Server URL override

timeoutMs?¶

optional timeoutMs: number

Defined in: src/griddy/nfl/baseSdk.ts:56

Timeout in milliseconds

userAgentHeader?¶

optional userAgentHeader: string

Defined in: src/griddy/nfl/baseSdk.ts:66

User agent header name