Class CompanyEndpoint

Access the Company API endpoints

Index

Constructors

constructor

Methods

applications employees get lookup news profile stock timestamp withId withTypeId

Constructors

constructor

new CompanyEndpoint(requester: Requester): CompanyEndpoint
Parameters
- requester: Requester
Returns CompanyEndpoint
- Defined in src/generated/endpoints/company.ts:27

Methods

applications

applications(
params?: { timestamp?: string },
): Promise<CompanyApplicationsResponse>
Get your company's applications
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<CompanyApplicationsResponse>
- Defined in src/generated/endpoints/company.ts:35

employees

employees(
params?: { striptags?: "true" | "false"; timestamp?: string },
): Promise<CompanyEmployeesResponse>
Get my company's employees
Parameters
- Optionalparams: { striptags?: "true" | "false"; timestamp?: string }
  Optional query parameters
Returns Promise<CompanyEmployeesResponse>
- Defined in src/generated/endpoints/company.ts:49

get

get(
    params?: {
        cat?: CompanyNewsCategory;
        id?: number;
        legacy?: string[];
        limit?: number;
        offset?: number;
        selections?: string[];
        striptags?: "true" | "false";
        timestamp?: string;
    },
): Promise<CompanyResponse>
Get any Company selection
Parameters
- Optionalparams: {
      cat?: CompanyNewsCategory;
      id?: number;
      legacy?: string[];
      limit?: number;
      offset?: number;
      selections?: string[];
      striptags?: "true" | "false";
      timestamp?: string;
  }
  Optional query parameters
Returns Promise<CompanyResponse>
- Defined in src/generated/endpoints/company.ts:149

lookup

lookup(params?: { timestamp?: string }): Promise<CompanyLookupResponse>
No summary available
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<CompanyLookupResponse>
- Defined in src/generated/endpoints/company.ts:121

news

news(
    params?: {
        cat?: CompanyNewsCategory;
        from?: number;
        limit?: number;
        sort?: "ASC" | "DESC";
        striptags?: "true" | "false";
        timestamp?: string;
        to?: number;
    },
): Promise<PaginatedResponse<NewsResponse> & NewsResponse>
Get your company's news details
Parameters
- Optionalparams: {
      cat?: CompanyNewsCategory;
      from?: number;
      limit?: number;
      sort?: "ASC" | "DESC";
      striptags?: "true" | "false";
      timestamp?: string;
      to?: number;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<NewsResponse> & NewsResponse>
- Defined in src/generated/endpoints/company.ts:65

profile

profile(
params?: { striptags?: "true" | "false"; timestamp?: string },
): Promise<CompanyProfileResponseMixed>
Get my company's profile
Parameters
- Optionalparams: { striptags?: "true" | "false"; timestamp?: string }
  Optional query parameters
Returns Promise<CompanyProfileResponseMixed>
- Defined in src/generated/endpoints/company.ts:91

stock

stock(params?: { timestamp?: string }): Promise<CompanyStockResponse>
Get your company's stock
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<CompanyStockResponse>
- Defined in src/generated/endpoints/company.ts:107

timestamp

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

withId

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

withTypeId

withTypeId(typeId: string | number): CompanyTypeIdContext
Parameters
- typeId: string | number
  The ID for this context
Returns CompanyTypeIdContext
- Defined in src/generated/endpoints/company.ts:179

Class CompanyEndpoint

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CompanyEndpoint

Methods

applications

Parameters

Returns Promise<CompanyApplicationsResponse>

employees

Parameters

Returns Promise<CompanyEmployeesResponse>

get

Parameters

Returns Promise<CompanyResponse>

lookup

Parameters

Returns Promise<CompanyLookupResponse>

news

Parameters

Returns Promise<PaginatedResponse<NewsResponse> & NewsResponse>

profile

Parameters

Returns Promise<CompanyProfileResponseMixed>

stock

Parameters

Returns Promise<CompanyStockResponse>

timestamp

Parameters

Returns Promise<TimestampResponse>

withId

Parameters

Returns CompanyIdContext

withTypeId

Parameters

Returns CompanyTypeIdContext

Settings

On This Page