Class PropertyEndpoint

Access the Property API endpoints

Index

Constructors

Methods

get lookup timestamp withId

Constructors

constructor

new PropertyEndpoint(requester: Requester): PropertyEndpoint
Parameters
- requester: Requester
Returns PropertyEndpoint
- Defined in src/generated/endpoints/property.ts:18

Methods

get

get(
    params?: {
        id?: number;
        selections?: string[];
        timestamp?: string | number;
    },
): Promise<PropertyResponse>
Get any property selection
Parameters
- Optionalparams: { id?: number; selections?: string[]; timestamp?: string | number }
  Optional query parameters
Returns Promise<PropertyResponse>
- Defined in src/generated/endpoints/property.ts:59

lookup

lookup(
params?: { timestamp?: string | number },
): Promise<PropertyLookupResponse>
Get all available property selections
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<PropertyLookupResponse>
- Defined in src/generated/endpoints/property.ts:31

timestamp

timestamp(params?: { timestamp?: string | number }): Promise<TimestampResponse>
Get current server time
Parameters
- Optionalparams: { timestamp?: string | number }
  Optional query parameters
Returns Promise<TimestampResponse>
- Defined in src/generated/endpoints/property.ts:45

withId

withId(id: string | number): PropertyIdContext
Parameters
- id: string | number
  The ID for this context
Returns PropertyIdContext
- Defined in src/generated/endpoints/property.ts:23