Skip to content

Commit a7cc89e

Browse files
speakeasybotspeakeasybot
committed
ci: regenerated with OpenAPI Doc 1.0, Speakeay CLI 1.23.1
1 parent 7735da6 commit a7cc89e

File tree

12 files changed

+333
-25
lines changed

12 files changed

+333
-25
lines changed

‎README.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Authentication with the Structure API is using OAuth2. When establishing a conne
2929
<!-- Start SDK Example Usage -->
3030
```python
3131
import sdk
32-
from sdk.models import operations, shared
32+
from sdk.models import operations
3333

3434
s = sdk.SDK(
3535
security=shared.Security(
@@ -41,7 +41,7 @@ s = sdk.SDK(
4141
req = operations.EnrichCompanyRequest(
4242
id="89bd9d8d-69a6-474e-8f46-7cc8796ed151",
4343
)
44-
44+
4545
res = s.companies.enrich(req)
4646

4747
if res.body is not None:
@@ -53,26 +53,26 @@ if res.body is not None:
5353
## Available Resources and Operations
5454

5555

56-
### accounts
56+
### [accounts](docs/accounts/README.md)
5757

58-
* `list_users` - Show current user accounts
58+
* [list_users](docs/accounts/README.md#list_users) - Show current user accounts
5959

60-
### companies
60+
### [companies](docs/companies/README.md)
6161

62-
* `enrich` - Enrich a company profile
63-
* `list_employees` - List company employees
64-
* `list_jobs` - List company jobs
65-
* `search` - Search Companies
62+
* [enrich](docs/companies/README.md#enrich) - Enrich a company profile
63+
* [list_employees](docs/companies/README.md#list_employees) - List company employees
64+
* [list_jobs](docs/companies/README.md#list_jobs) - List company jobs
65+
* [search](docs/companies/README.md#search) - Search Companies
6666

67-
### people
67+
### [people](docs/people/README.md)
6868

69-
* `enrich` - Enrich a person profile
70-
* `search` - Search People
69+
* [enrich](docs/people/README.md#enrich) - Enrich a person profile
70+
* [search](docs/people/README.md#search) - Search People
7171

72-
### user
72+
### [user](docs/user/README.md)
7373

74-
* `login` - Login user
75-
* `me` - Show current user
74+
* [login](docs/user/README.md#login) - Login user
75+
* [me](docs/user/README.md#me) - Show current user
7676
<!-- End SDK Available Operations -->
7777

7878
### Maturity

‎RELEASES.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,4 +70,12 @@ Based on:
7070
- OpenAPI Doc 1.0 https://prod.speakeasyapi.dev/v1/apis/Structure/version/1.0.0/schema/download
7171
- Speakeasy CLI 1.22.1 (2.20.1) https://github.com/speakeasy-api/speakeasy
7272
### Releases
73-
- [PyPI v0.3.0] https://pypi.org/project/structure_py/0.3.0 - .
73+
- [PyPI v0.3.0] https://pypi.org/project/structure_py/0.3.0 - .
74+
75+
## 2023-04-26 00:57:49
76+
### Changes
77+
Based on:
78+
- OpenAPI Doc 1.0 https://prod.speakeasyapi.dev/v1/apis/Structure/version/1.0.0/schema/download
79+
- Speakeasy CLI 1.23.1 (2.21.1) https://github.com/speakeasy-api/speakeasy
80+
### Releases
81+
- [PyPI v0.4.0] https://pypi.org/project/structure_py/0.4.0 - .

‎USAGE.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- Start SDK Example Usage -->
22
```python
33
import sdk
4-
from sdk.models import operations, shared
4+
from sdk.models import operations
55

66
s = sdk.SDK(
77
security=shared.Security(
@@ -13,7 +13,7 @@ s = sdk.SDK(
1313
req = operations.EnrichCompanyRequest(
1414
id="89bd9d8d-69a6-474e-8f46-7cc8796ed151",
1515
)
16-
16+
1717
res = s.companies.enrich(req)
1818

1919
if res.body is not None:

‎docs/accounts/README.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# accounts
2+
3+
## Overview
4+
5+
Accounts
6+
7+
### Available Operations
8+
9+
* [list_users](#list_users) - Show current user accounts
10+
11+
## list_users
12+
13+
Show current user accounts
14+
15+
### Example Usage
16+
17+
```python
18+
import sdk
19+
20+
21+
s = sdk.SDK(
22+
security=shared.Security(
23+
bearer_auth="Bearer YOUR_BEARER_TOKEN_HERE",
24+
),
25+
)
26+
27+
28+
res = s.accounts.list_users()
29+
30+
if res.body is not None:
31+
# handle response
32+
```

‎docs/companies/README.md‎

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
# companies
2+
3+
## Overview
4+
5+
Companies
6+
7+
### Available Operations
8+
9+
* [enrich](#enrich) - Enrich a company profile
10+
* [list_employees](#list_employees) - List company employees
11+
* [list_jobs](#list_jobs) - List company jobs
12+
* [search](#search) - Search Companies
13+
14+
## enrich
15+
16+
Enrich a company profile
17+
18+
### Example Usage
19+
20+
```python
21+
import sdk
22+
from sdk.models import operations
23+
24+
s = sdk.SDK(
25+
security=shared.Security(
26+
bearer_auth="Bearer YOUR_BEARER_TOKEN_HERE",
27+
),
28+
)
29+
30+
31+
req = operations.EnrichCompanyRequest(
32+
id="a05dfc2d-df7c-4c78-8a1b-a928fc816742",
33+
)
34+
35+
res = s.companies.enrich(req)
36+
37+
if res.body is not None:
38+
# handle response
39+
```
40+
41+
## list_employees
42+
43+
List company employees
44+
45+
### Example Usage
46+
47+
```python
48+
import sdk
49+
from sdk.models import operations
50+
51+
s = sdk.SDK(
52+
security=shared.Security(
53+
bearer_auth="Bearer YOUR_BEARER_TOKEN_HERE",
54+
),
55+
)
56+
57+
58+
req = operations.ListEmployeesRequest(
59+
id="cb739205-9293-496f-aa75-96eb10faaa23",
60+
offset="corporis",
61+
per_page="explicabo",
62+
)
63+
64+
res = s.companies.list_employees(req)
65+
66+
if res.body is not None:
67+
# handle response
68+
```
69+
70+
## list_jobs
71+
72+
List company jobs
73+
74+
### Example Usage
75+
76+
```python
77+
import sdk
78+
from sdk.models import operations
79+
80+
s = sdk.SDK(
81+
security=shared.Security(
82+
bearer_auth="Bearer YOUR_BEARER_TOKEN_HERE",
83+
),
84+
)
85+
86+
87+
req = operations.ListJobsRequest(
88+
id="c5955907-aff1-4a3a-afa9-467739251aa5",
89+
offset="odit",
90+
per_page="quo",
91+
)
92+
93+
res = s.companies.list_jobs(req)
94+
95+
if res.body is not None:
96+
# handle response
97+
```
98+
99+
## search
100+
101+
Search Companies
102+
103+
### Example Usage
104+
105+
```python
106+
import sdk
107+
from sdk.models import operations
108+
109+
s = sdk.SDK(
110+
security=shared.Security(
111+
bearer_auth="Bearer YOUR_BEARER_TOKEN_HERE",
112+
),
113+
)
114+
115+
116+
req = operations.SearchCompaniesApplicationJSON(
117+
filter="sequi",
118+
limit="tenetur",
119+
page="ipsam",
120+
query="id",
121+
)
122+
123+
res = s.companies.search(req)
124+
125+
if res.body is not None:
126+
# handle response
127+
```

‎docs/people/README.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# people
2+
3+
## Overview
4+
5+
People
6+
7+
### Available Operations
8+
9+
* [enrich](#enrich) - Enrich a person profile
10+
* [search](#search) - Search People
11+
12+
## enrich
13+
14+
Enrich a person profile
15+
16+
### Example Usage
17+
18+
```python
19+
import sdk
20+
from sdk.models import operations
21+
22+
s = sdk.SDK(
23+
security=shared.Security(
24+
bearer_auth="Bearer YOUR_BEARER_TOKEN_HERE",
25+
),
26+
)
27+
28+
29+
req = operations.EnrichPersonRequest(
30+
id="d019da1f-fe78-4f09-bb00-74f15471b5e6",
31+
)
32+
33+
res = s.people.enrich(req)
34+
35+
if res.body is not None:
36+
# handle response
37+
```
38+
39+
## search
40+
41+
Search People
42+
43+
### Example Usage
44+
45+
```python
46+
import sdk
47+
from sdk.models import operations
48+
49+
s = sdk.SDK(
50+
security=shared.Security(
51+
bearer_auth="Bearer YOUR_BEARER_TOKEN_HERE",
52+
),
53+
)
54+
55+
56+
req = operations.SearchPeopleApplicationJSON(
57+
filter="repudiandae",
58+
limit="quae",
59+
page="ipsum",
60+
query="quidem",
61+
)
62+
63+
res = s.people.search(req)
64+
65+
if res.body is not None:
66+
# handle response
67+
```

‎docs/sdk/README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# SDK
2+
3+
## Overview
4+
5+
Structure provides company and people data. Use our dataset of 700 million people and 24 million companies to build products, enrich person profiles, power predictive modeling/ai, analysis, and more.
6+
7+
### Available Operations
8+

‎docs/user/README.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# user
2+
3+
## Overview
4+
5+
User
6+
7+
### Available Operations
8+
9+
* [login](#login) - Login user
10+
* [me](#me) - Show current user
11+
12+
## login
13+
14+
Login user
15+
16+
### Example Usage
17+
18+
```python
19+
import sdk
20+
from sdk.models import operations
21+
22+
s = sdk.SDK(
23+
security=shared.Security(
24+
bearer_auth="Bearer YOUR_BEARER_TOKEN_HERE",
25+
),
26+
)
27+
28+
29+
req = operations.LoginApplicationJSON(
30+
email="[email protected]",
31+
password="rem",
32+
)
33+
34+
res = s.user.login(req)
35+
36+
if res.body is not None:
37+
# handle response
38+
```
39+
40+
## me
41+
42+
Show current user
43+
44+
### Example Usage
45+
46+
```python
47+
import sdk
48+
49+
50+
s = sdk.SDK(
51+
security=shared.Security(
52+
bearer_auth="Bearer YOUR_BEARER_TOKEN_HERE",
53+
),
54+
)
55+
56+
57+
res = s.user.me()
58+
59+
if res.body is not None:
60+
# handle response
61+
```

0 commit comments

Comments
 (0)