Skip to content

Latest commit

 

History

History
executable file
·
171 lines (119 loc) · 8.09 KB

README.md

File metadata and controls

executable file
·
171 lines (119 loc) · 8.09 KB
Raw

companies

Overview

Companies

Available Operations

enrich

Enrich a company profile

Example Usage

import { Structure } from "structure-ac";
import { EnrichCompanyResponse } from "structure-ac/dist/sdk/models/operations";

const sdk = new Structure({
  security: {
    bearerAuth: "",
  },
});

sdk.companies.enrich({
  id: "a05dfc2d-df7c-4c78-8a1b-a928fc816742",
}).then((res: EnrichCompanyResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Parameters

Parameter Type Required Description
request operations.EnrichCompanyRequest ✔️ The request object to use for the request.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.EnrichCompanyResponse>

listEmployees

List company employees

Example Usage

import { Structure } from "structure-ac";
import { ListEmployeesResponse } from "structure-ac/dist/sdk/models/operations";

const sdk = new Structure({
  security: {
    bearerAuth: "",
  },
});

sdk.companies.listEmployees({
  id: "cb739205-9293-496f-aa75-96eb10faaa23",
  offset: "corporis",
  perPage: "explicabo",
}).then((res: ListEmployeesResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Parameters

Parameter Type Required Description
request operations.ListEmployeesRequest ✔️ The request object to use for the request.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.ListEmployeesResponse>

listJobs

List company jobs

Example Usage

import { Structure } from "structure-ac";
import { ListJobsResponse } from "structure-ac/dist/sdk/models/operations";

const sdk = new Structure({
  security: {
    bearerAuth: "",
  },
});

sdk.companies.listJobs({
  id: "c5955907-aff1-4a3a-afa9-467739251aa5",
  offset: "odit",
  perPage: "quo",
}).then((res: ListJobsResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Parameters

Parameter Type Required Description
request operations.ListJobsRequest ✔️ The request object to use for the request.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.ListJobsResponse>

search

Search Companies

Example Usage

import { Structure } from "structure-ac";
import { SearchCompaniesResponse } from "structure-ac/dist/sdk/models/operations";

const sdk = new Structure({
  security: {
    bearerAuth: "",
  },
});

sdk.companies.search({
  filter: "sequi",
  limit: "tenetur",
  page: "ipsam",
  query: "id",
}).then((res: SearchCompaniesResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Parameters

Parameter Type Required Description
request operations.SearchCompaniesApplicationJSON ✔️ The request object to use for the request.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.SearchCompaniesResponse>