Skip to content

Latest commit

 

History

History
executable file
·
89 lines (61 loc) · 4.13 KB

README.md

File metadata and controls

executable file
·
89 lines (61 loc) · 4.13 KB
Raw

people

Overview

People

Available Operations

enrich

Enrich a person profile

Example Usage

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

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

sdk.people.enrich({
  id: "d019da1f-fe78-4f09-bb00-74f15471b5e6",
}).then((res: EnrichPersonResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Parameters

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

Response

Promise<operations.EnrichPersonResponse>

search

Search People

Example Usage

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

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

sdk.people.search({
  filter: "repudiandae",
  limit: "quae",
  page: "ipsum",
  query: "quidem",
}).then((res: SearchPeopleResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Parameters

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

Response

Promise<operations.SearchPeopleResponse>