griddy-sdk / BaseSDK

Class: BaseSDK¶

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

Base SDK class providing common functionality for all endpoint classes.

Extended by¶

Constructors¶

Constructor¶

new BaseSDK(sdkConfig, parentRef?): BaseSDK

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

Parameters¶

sdkConfig¶

SDKConfiguration

parentRef?¶

object

Returns¶

BaseSDK

Properties¶

parentRef¶

protected parentRef: object = null

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

sdkConfiguration¶

protected sdkConfiguration: SDKConfiguration

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

Methods¶

buildRequest()¶

protected buildRequest(config): Request

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

Build an HTTP request.

Parameters¶

config¶

EndpointConfig

Returns¶

Request

createHookContext()¶

protected createHookContext(operationId, baseUrl): HookContext

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

Create a hook context for request execution.

Parameters¶

operationId¶

string

baseUrl¶

string

Returns¶

HookContext

doRequest()¶

protected doRequest(hookCtx, request, errorStatusCodes, retryConfig?): Promise\<Response>

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

Execute an HTTP request with hooks and retries.

Parameters¶

hookCtx¶

HookContext

request¶

Request

errorStatusCodes¶

string[]

retryConfig?¶

config¶

RetryConfig

statusCodes¶

string[]

Returns¶

Promise\<Response>

executeEndpoint()¶

protected executeEndpoint\<T>(config): Promise\<T>

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

Execute an endpoint and return the response.

Type Parameters¶

T¶

T

Parameters¶

config¶

EndpointConfig\<T>

Returns¶

Promise\<T>

generateUrl()¶

protected generateUrl(baseUrl, path, request, requestMeta?): string

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

Generate URL with path parameters substituted.

Parameters¶

baseUrl¶

string

path¶

string

request¶

Record\<string, unknown>

requestMeta?¶

Record\<string, ParamMetadata>

Returns¶

string

getHeaders()¶

protected getHeaders(request, requestMeta?): Record\<string, string>

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

Get headers from request.

Parameters¶

request¶

Record\<string, unknown>

requestMeta?¶

Record\<string, ParamMetadata>

Returns¶

Record\<string, string>

getQueryParams()¶

protected getQueryParams(request, requestMeta?): Record\<string, string>

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

Get query parameters from request.

Parameters¶

request¶

Record\<string, unknown>

requestMeta?¶

Record\<string, ParamMetadata>

Returns¶

Record\<string, string>

getSecurityParams()¶

protected getSecurityParams(security): object

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

Get security headers and query params.

Parameters¶

security¶

Security | () => Security

Returns¶

object

headers¶

headers: Record\<string, string>

queryParams¶

queryParams: Record\<string, string>

getUrl()¶

protected getUrl(baseUrl, urlVariables): string

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

Get the URL with template variables.

Parameters¶

baseUrl¶

string

urlVariables¶

Record\<string, string>

Returns¶

string

handleJsonResponse()¶

protected handleJsonResponse\<T>(response, errorStatusCodes): Promise\<T>

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

Handle JSON response with error handling.

Type Parameters¶

T¶

T

Parameters¶

response¶

Response

errorStatusCodes¶

string[]

Returns¶

Promise\<T>

resolveBaseUrl()¶

protected resolveBaseUrl(serverUrl?, urlVariables?): string

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

Resolve the base URL for a request.

Parameters¶

serverUrl?¶

string

urlVariables?¶

Record\<string, string>

Returns¶

string

resolveRetryConfig()¶

protected resolveRetryConfig(retries, retryStatusCodes?): object

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

Resolve retry configuration.

Parameters¶

retries¶

typeof UNSET | RetryConfig

retryStatusCodes?¶

string[]

Returns¶

object

config¶

config: RetryConfig

statusCodes¶

statusCodes: string[]

resolveTimeout()¶

protected resolveTimeout(timeoutMs?): number

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

Resolve timeout, falling back to SDK configuration.

Parameters¶

timeoutMs?¶

number

Returns¶

number