Class CompanyTypeIdContext

Context class for Company API endpoints that require a "typeId"

Index

Constructors

Methods

Constructors

constructor

new CompanyTypeIdContext(
requester: Requester,
contextId: string | number,
): CompanyTypeIdContext
Parameters
- requester: Requester
- contextId: string | number
Returns CompanyTypeIdContext
- Defined in src/generated/endpoints/company.ts:238

Methods

companies

companies(
    params?: {
        limit?: number;
        offset?: number;
        striptags?: "true" | "false";
        timestamp?: string;
    },
): Promise<PaginatedResponse<CompaniesResponse> & CompaniesResponse>
Get a list of companies for a specific company type
Parameters
- Optionalparams: {
      limit?: number;
      offset?: number;
      striptags?: "true" | "false";
      timestamp?: string;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<CompaniesResponse> & CompaniesResponse>
- Defined in src/generated/endpoints/company.ts:247