Skip to content

Commit 74f0c70

Browse files
speakeasybotspeakeasybot
committed
ci: regenerated with OpenAPI Doc 1.0.0, Speakeasy CLI 1.253.1
1 parent 7935d40 commit 74f0c70

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+2115
-638
lines changed

‎organization/.gitattributes

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# This allows generated code to be indexed correctly
2+
*.py linguist-generated=false

‎organization/.gitignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
venv/
2+
src/*.egg-info/
3+
__pycache__/
4+
.pytest_cache/
5+
.python-version
6+
.DS_Store

‎organization/.speakeasy/gen.lock

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
lockVersion: 2.0.0
2+
id: 47ceec13-596f-4a55-9162-e8ab258f5b7c
3+
management:
4+
docChecksum: 243f6d77a2d2aa13b8116985f9a6ec70
5+
docVersion: 1.0.0
6+
speakeasyVersion: 1.253.1
7+
generationVersion: 2.306.0
8+
releaseVersion: 1.3.0
9+
configChecksum: 540bfa614ea7fa291e246ddbca962073
10+
repoURL: https://github.com/epilot-dev/sdk-python.git
11+
repoSubDirectory: organization
12+
installationURL: https://github.com/epilot-dev/sdk-python.git#subdirectory=organization
13+
features:
14+
python:
15+
core: 4.6.4
16+
flattening: 2.81.1
17+
globalSecurity: 2.83.5
18+
globalServerURLs: 2.82.2
19+
responseFormat: 0.1.0
20+
unions: 2.82.6
21+
generatedFiles:
22+
- src/epilot/sdkconfiguration.py
23+
- src/epilot/organization.py
24+
- src/epilot/organization_settings.py
25+
- src/epilot/sdk.py
26+
- py.typed
27+
- pylintrc
28+
- setup.py
29+
- src/epilot/__init__.py
30+
- src/epilot/utils/__init__.py
31+
- src/epilot/utils/retries.py
32+
- src/epilot/utils/utils.py
33+
- src/epilot/models/errors/sdkerror.py
34+
- tests/helpers.py
35+
- src/epilot/models/operations/getorganization.py
36+
- src/epilot/models/operations/updateorganization.py
37+
- src/epilot/models/operations/deletesettingsvalue.py
38+
- src/epilot/models/operations/getsettings.py
39+
- src/epilot/models/operations/putsettingsvalue.py
40+
- src/epilot/models/components/organization.py
41+
- src/epilot/models/components/httpmetadata.py
42+
- src/epilot/models/components/security.py
43+
- src/epilot/models/__init__.py
44+
- src/epilot/models/errors/__init__.py
45+
- src/epilot/models/operations/__init__.py
46+
- src/epilot/models/components/__init__.py
47+
- docs/models/operations/getorganizationrequest.md
48+
- docs/models/operations/getorganizationresponse.md
49+
- docs/models/operations/updateorganizationrequest.md
50+
- docs/models/operations/updateorganizationresponse.md
51+
- docs/models/operations/deletesettingsvaluerequest.md
52+
- docs/models/operations/deletesettingsvalueresponse.md
53+
- docs/models/operations/getsettingsrequest.md
54+
- docs/models/operations/getsettingsresponse.md
55+
- docs/models/operations/putsettingsvaluerequest.md
56+
- docs/models/operations/putsettingsvalueresponse.md
57+
- docs/models/components/address.md
58+
- docs/models/components/type.md
59+
- docs/models/components/organization.md
60+
- docs/models/components/httpmetadata.md
61+
- docs/models/components/settingsvalue.md
62+
- docs/models/components/security.md
63+
- docs/sdks/epilot/README.md
64+
- docs/sdks/organization/README.md
65+
- docs/sdks/organizationsettings/README.md
66+
- USAGE.md
67+
- .gitattributes
68+
- src/epilot/_hooks/sdkhooks.py
69+
- src/epilot/_hooks/types.py
70+
- src/epilot/_hooks/__init__.py

‎organization/README.md

Lines changed: 154 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,183 @@
11
# epilot-organization
22

3-
<!-- Start SDK Installation -->
3+
<!-- Start SDK Installation [installation] -->
44
## SDK Installation
55

66
```bash
77
pip install git+https://github.com/epilot-dev/sdk-python.git#subdirectory=organization
88
```
9-
<!-- End SDK Installation -->
9+
<!-- End SDK Installation [installation] -->
1010

11+
<!-- Start SDK Example Usage [usage] -->
1112
## SDK Example Usage
12-
<!-- Start SDK Example Usage -->
13+
14+
### Example
15+
16+
```python
17+
import epilot
18+
19+
s = epilot.Epilot(
20+
epilot_auth="<YOUR_BEARER_TOKEN_HERE>",
21+
)
22+
23+
24+
res = s.organization.get_organization(org_id='739224')
25+
26+
if res.organization is not None:
27+
# handle response
28+
pass
29+
30+
```
31+
<!-- End SDK Example Usage [usage] -->
32+
33+
<!-- Start Available Resources and Operations [operations] -->
34+
## Available Resources and Operations
35+
36+
### [organization](docs/sdks/organization/README.md)
37+
38+
* [get_organization](docs/sdks/organization/README.md#get_organization) - getOrganization
39+
* [update_organization](docs/sdks/organization/README.md#update_organization) - updateOrganization
40+
41+
### [organization_settings](docs/sdks/organizationsettings/README.md)
42+
43+
* [delete_settings_value](docs/sdks/organizationsettings/README.md#delete_settings_value) - deleteSettingsValue
44+
* [get_settings](docs/sdks/organizationsettings/README.md#get_settings) - getSettings
45+
* [put_settings_value](docs/sdks/organizationsettings/README.md#put_settings_value) - putSettingsValue
46+
<!-- End Available Resources and Operations [operations] -->
47+
48+
<!-- Start Error Handling [errors] -->
49+
## Error Handling
50+
51+
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.
52+
53+
| Error Object | Status Code | Content Type |
54+
| --------------- | --------------- | --------------- |
55+
| errors.SDKError | 4xx-5xx | */* |
56+
57+
### Example
58+
59+
```python
60+
import epilot
61+
from epilot.models import errors
62+
63+
s = epilot.Epilot(
64+
epilot_auth="<YOUR_BEARER_TOKEN_HERE>",
65+
)
66+
67+
68+
res = None
69+
try:
70+
res = s.organization.get_organization(org_id='739224')
71+
except errors.SDKError as e:
72+
# handle exception
73+
raise(e)
74+
75+
if res.organization is not None:
76+
# handle response
77+
pass
78+
79+
```
80+
<!-- End Error Handling [errors] -->
81+
82+
<!-- Start Server Selection [server] -->
83+
## Server Selection
84+
85+
### Select Server by Index
86+
87+
You can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
88+
89+
| # | Server | Variables |
90+
| - | ------ | --------- |
91+
| 0 | `https://organization-v2.sls.epilot.io` | None |
92+
93+
#### Example
94+
1395
```python
1496
import epilot
15-
from epilot.models import operations, shared
1697

1798
s = epilot.Epilot(
18-
security=shared.Security(
19-
epilot_auth="Bearer YOUR_BEARER_TOKEN_HERE",
20-
),
99+
server_idx=0,
100+
epilot_auth="<YOUR_BEARER_TOKEN_HERE>",
21101
)
22102

23103

24-
req = operations.GetOrganizationRequest(
25-
org_id="739224",
104+
res = s.organization.get_organization(org_id='739224')
105+
106+
if res.organization is not None:
107+
# handle response
108+
pass
109+
110+
```
111+
112+
113+
### Override Server URL Per-Client
114+
115+
The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
116+
```python
117+
import epilot
118+
119+
s = epilot.Epilot(
120+
server_url="https://organization-v2.sls.epilot.io",
121+
epilot_auth="<YOUR_BEARER_TOKEN_HERE>",
26122
)
27-
28-
res = s.organization.get_organization(req)
123+
124+
125+
res = s.organization.get_organization(org_id='739224')
29126

30127
if res.organization is not None:
31128
# handle response
129+
pass
130+
32131
```
33-
<!-- End SDK Example Usage -->
132+
<!-- End Server Selection [server] -->
34133

35-
<!-- Start SDK Available Operations -->
36-
## SDK Available Operations
134+
<!-- Start Custom HTTP Client [http-client] -->
135+
## Custom HTTP Client
37136

137+
The Python SDK makes API calls using the [requests](https://pypi.org/project/requests/) HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `requests.Session` object.
38138

39-
### organization
139+
For example, you could specify a header for every request that this sdk makes as follows:
140+
```python
141+
import epilot
142+
import requests
143+
144+
http_client = requests.Session()
145+
http_client.headers.update({'x-custom-header': 'someValue'})
146+
s = epilot.Epilot(client=http_client)
147+
```
148+
<!-- End Custom HTTP Client [http-client] -->
149+
150+
<!-- Start Authentication [security] -->
151+
## Authentication
152+
153+
### Per-Client Security Schemes
154+
155+
This SDK supports the following security scheme globally:
156+
157+
| Name | Type | Scheme |
158+
| ------------- | ------------- | ------------- |
159+
| `epilot_auth` | http | HTTP Bearer |
160+
161+
To authenticate with the API the `epilot_auth` parameter must be set when initializing the SDK client instance. For example:
162+
```python
163+
import epilot
164+
165+
s = epilot.Epilot(
166+
epilot_auth="<YOUR_BEARER_TOKEN_HERE>",
167+
)
168+
169+
170+
res = s.organization.get_organization(org_id='739224')
171+
172+
if res.organization is not None:
173+
# handle response
174+
pass
175+
176+
```
177+
<!-- End Authentication [security] -->
40178

41-
* `get_organization` - getOrganization
42-
* `update_organization` - updateOrganization
179+
<!-- Placeholder for Future Speakeasy SDK Sections -->
43180

44-
### organization_settings
45181

46-
* `delete_settings_value` - deleteSettingsValue
47-
* `get_settings` - getSettings
48-
* `put_settings_value` - putSettingsValue
49-
<!-- End SDK Available Operations -->
50182

51183
### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)

‎organization/RELEASES.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,12 @@ Based on:
3434
### Changes
3535
Based on:
3636
- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/organization-v2.yaml
37-
- Speakeasy CLI 1.19.2 (2.16.5) https://github.com/speakeasy-api/speakeasy
37+
- Speakeasy CLI 1.19.2 (2.16.5) https://github.com/speakeasy-api/speakeasy
38+
39+
## 2024-04-16 00:02:00
40+
### Changes
41+
Based on:
42+
- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/organization-v2.yaml
43+
- Speakeasy CLI 1.253.1 (2.306.0) https://github.com/speakeasy-api/speakeasy
44+
### Generated
45+
- [python v1.3.0] organization

‎organization/USAGE.md

100755100644
Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,17 @@
1-
<!-- Start SDK Example Usage -->
1+
<!-- Start SDK Example Usage [usage] -->
22
```python
33
import epilot
4-
from epilot.models import operations, shared
54

65
s = epilot.Epilot(
7-
security=shared.Security(
8-
epilot_auth="Bearer YOUR_BEARER_TOKEN_HERE",
9-
),
6+
epilot_auth="<YOUR_BEARER_TOKEN_HERE>",
107
)
118

129

13-
req = operations.GetOrganizationRequest(
14-
org_id="739224",
15-
)
16-
17-
res = s.organization.get_organization(req)
10+
res = s.organization.get_organization(org_id='739224')
1811

1912
if res.organization is not None:
2013
# handle response
14+
pass
15+
2116
```
22-
<!-- End SDK Example Usage -->
17+
<!-- End SDK Example Usage [usage] -->

‎organization/docs/models/components/address.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Address
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ------------------ | ------------------ | ------------------ | ------------------ |
8+
| `city` | *Optional[str]* | :heavy_minus_sign: | N/A |
9+
| `country` | *Optional[str]* | :heavy_minus_sign: | N/A |
10+
| `postal_code` | *Optional[str]* | :heavy_minus_sign: | N/A |
11+
| `street` | *Optional[str]* | :heavy_minus_sign: | N/A |
12+
| `street_number` | *Optional[str]* | :heavy_minus_sign: | N/A |

‎organization/docs/models/components/httpmetadata.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# HTTPMetadata
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
8+
| `response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
9+
| `request` | [requests.Request](https://requests.readthedocs.io/en/latest/api/#requests.Request) | :heavy_check_mark: | Raw HTTP request; suitable for debugging |

‎organization/docs/models/components/organization.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Organization
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description | Example |
7+
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
8+
| `address` | [Optional[components.Address]](../../models/components/address.md) | :heavy_minus_sign: | N/A | |
9+
| `email` | *Optional[str]* | :heavy_minus_sign: | N/A | someone@epilot.cloud |
10+
| `free_user_limit` | *Optional[float]* | :heavy_minus_sign: | N/A | 50 |
11+
| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | 739224 |
12+
| `is_unlicensed_org` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
13+
| `logo_thumbnail_url` | *Optional[str]* | :heavy_minus_sign: | N/A | https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png |
14+
| `logo_url` | *Optional[str]* | :heavy_minus_sign: | N/A | https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png |
15+
| `name` | *Optional[str]* | :heavy_minus_sign: | N/A | Epilot |
16+
| `phone` | *Optional[str]* | :heavy_minus_sign: | N/A | 49123123123 |
17+
| `pricing_tier` | *Optional[str]* | :heavy_minus_sign: | N/A | professional |
18+
| `signature` | *Optional[str]* | :heavy_minus_sign: | N/A | <p>Thanks</p> |
19+
| `style` | Dict[str, *Any*] | :heavy_minus_sign: | Organization style setting (e.g. font setting) | |
20+
| `symbol` | *Optional[str]* | :heavy_minus_sign: | N/A | EPI |
21+
| `type` | [Optional[components.Type]](../../models/components/type.md) | :heavy_minus_sign: | N/A | |
22+
| `website` | *Optional[str]* | :heavy_minus_sign: | N/A | https://epilot.cloud |

0 commit comments

Comments
 (0)