Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: speakeasy sdk regeneration - Generate Workflows Definition SDK #66

Open
wants to merge 83 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
83 commits
Select commit Hold shift + click to select a range
1b198fe
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.19.3
speakeasybot Apr 1, 2023
1939418
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.19.6
speakeasybot Apr 6, 2023
5f5170f
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.19.7
speakeasybot Apr 12, 2023
7a8d5d7
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.20.0
speakeasybot Apr 14, 2023
56b6e32
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.20.1
speakeasybot Apr 18, 2023
333044b
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.20.2
speakeasybot Apr 19, 2023
e1dce59
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.21.4
speakeasybot Apr 21, 2023
f95deb3
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.22.1
speakeasybot Apr 22, 2023
a1cdf81
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.23.1
speakeasybot Apr 26, 2023
c64b314
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.25.1
speakeasybot Apr 27, 2023
3fc913f
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.26.2
speakeasybot Apr 28, 2023
ed757ba
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.26.4
speakeasybot Apr 29, 2023
4c2b29a
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.26.5
speakeasybot May 2, 2023
858e4bf
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.27.0
speakeasybot May 3, 2023
a80f25f
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.29.0
speakeasybot May 5, 2023
2deca8b
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.29.1
speakeasybot May 6, 2023
3040856
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.29.2
speakeasybot May 10, 2023
4d35933
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.30.0
speakeasybot May 11, 2023
28e6872
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.30.1
speakeasybot May 12, 2023
4a63631
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.31.1
speakeasybot May 13, 2023
3b28090
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.32.0
speakeasybot May 16, 2023
5cab933
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.33.2
speakeasybot May 17, 2023
b26db02
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.34.0
speakeasybot May 18, 2023
f618c32
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.35.0
speakeasybot May 19, 2023
4ecd2b9
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.37.5
speakeasybot May 23, 2023
dc35f67
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.39.0
speakeasybot May 27, 2023
23299a7
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.40.2
speakeasybot Jun 1, 2023
3b2058c
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.41.0
speakeasybot Jun 2, 2023
a58998d
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.43.0
speakeasybot Jun 3, 2023
a4969f2
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.44.2
speakeasybot Jun 7, 2023
77a4c5b
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.45.0
speakeasybot Jun 8, 2023
95e7371
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.45.2
speakeasybot Jun 9, 2023
08b957f
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.47.0
speakeasybot Jun 10, 2023
fbf5eb4
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.47.1
speakeasybot Jun 11, 2023
d117aed
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.47.3
speakeasybot Jun 14, 2023
d4b35e4
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.48.0
speakeasybot Jun 16, 2023
c463b3a
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.49.0
speakeasybot Jun 20, 2023
8edc70b
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.49.1
speakeasybot Jun 21, 2023
d8c800c
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.50.1
speakeasybot Jun 23, 2023
b45daf9
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.51.1
speakeasybot Jun 27, 2023
4b0d1b8
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.51.3
speakeasybot Jun 29, 2023
a940948
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.52.0
speakeasybot Jul 1, 2023
4fe87bd
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.52.2
speakeasybot Jul 6, 2023
9c719eb
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.53.0
speakeasybot Jul 7, 2023
e308ae8
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.53.1
speakeasybot Jul 8, 2023
da6f681
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.56.0
speakeasybot Jul 11, 2023
eb84a4c
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.56.4
speakeasybot Jul 12, 2023
fb0013a
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.57.0
speakeasybot Jul 13, 2023
72c9830
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.59.0
speakeasybot Jul 14, 2023
63b724a
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.60.0
speakeasybot Jul 17, 2023
e45c965
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.61.0
speakeasybot Jul 18, 2023
00f16a8
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.62.1
speakeasybot Jul 19, 2023
592e6d4
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.64.0
speakeasybot Jul 22, 2023
10c56a5
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.65.0
speakeasybot Jul 26, 2023
8e22f54
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.65.1
speakeasybot Jul 27, 2023
1a5ebb8
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.65.2
speakeasybot Jul 28, 2023
95cdffe
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.66.1
speakeasybot Aug 1, 2023
9c723b7
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.68.1
speakeasybot Aug 3, 2023
1608c47
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.68.3
speakeasybot Aug 4, 2023
e06bd42
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.69.1
speakeasybot Aug 8, 2023
5b9e4a7
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.72.0
speakeasybot Aug 15, 2023
e591103
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.74.3
speakeasybot Aug 19, 2023
70b3ed6
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.74.11
speakeasybot Aug 25, 2023
d9b7a05
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.74.16
speakeasybot Aug 26, 2023
20de178
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.74.17
speakeasybot Aug 29, 2023
f7aa365
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.76.1
speakeasybot Aug 31, 2023
098ec92
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.77.0
speakeasybot Sep 1, 2023
3654d47
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.77.2
speakeasybot Sep 2, 2023
589ca60
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.78.3
speakeasybot Sep 5, 2023
76996da
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.82.5
speakeasybot Sep 12, 2023
cb0a2f9
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.86.0
speakeasybot Sep 16, 2023
4499ea1
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.88.0
speakeasybot Sep 20, 2023
ecafdb4
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.91.0
speakeasybot Sep 26, 2023
82c12c2
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.91.2
speakeasybot Sep 27, 2023
fca1e7b
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.91.3
speakeasybot Sep 29, 2023
0acdcda
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.92.2
speakeasybot Oct 1, 2023
c4a888b
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.92.3
speakeasybot Oct 2, 2023
0882c59
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.94.0
speakeasybot Oct 5, 2023
2f63a37
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.96.1
speakeasybot Oct 7, 2023
d6d2dcc
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.99.1
speakeasybot Oct 13, 2023
6cf1daa
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.101.0
speakeasybot Oct 18, 2023
8dc41f7
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.104.0
speakeasybot Oct 21, 2023
4810f29
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.109.0
speakeasybot Oct 28, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions workflows_definition/.gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# This allows generated code to be indexed correctly
*.py linguist-generated=false
7 changes: 7 additions & 0 deletions workflows_definition/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.python-version
.DS_Store
venv/
src/*.egg-info/
__pycache__/
.pytest_cache/
.python-version`
165 changes: 146 additions & 19 deletions workflows_definition/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,45 +16,172 @@ from sdk.models import operations, shared

s = sdk.SDK(
security=shared.Security(
bearer_auth="Bearer YOUR_BEARER_TOKEN_HERE",
bearer_auth="",
),
)


req = operations.ChangeReasonStatusRequest(
change_reason_status_req=shared.ChangeReasonStatusReq(
status="INACTIVE",
status=shared.ClosingReasonsStatus.ACTIVE,
),
reason_id="deserunt",
reason_id='string',
)

res = s.closing_reason.change_reason_status(req)

if res.status_code == 200:
# handle response
pass
```
<!-- End SDK Example Usage -->

<!-- Start SDK Available Operations -->
## SDK Available Operations
## Available Resources and Operations


### closing_reason
### [closing_reason](docs/sdks/closingreason/README.md)

* `change_reason_status` - changeReasonStatus
* `create_closing_reason` - createClosingReason
* `get_all_closing_reasons` - getAllClosingReasons
* [change_reason_status](docs/sdks/closingreason/README.md#change_reason_status) - changeReasonStatus
* [create_closing_reason](docs/sdks/closingreason/README.md#create_closing_reason) - createClosingReason
* [get_all_closing_reasons](docs/sdks/closingreason/README.md#get_all_closing_reasons) - getAllClosingReasons

### workflows
### [workflows](docs/sdks/workflows/README.md)

* `create_definition` - createDefinition
* `delete_definition` - deleteDefinition
* `get_definition` - getDefinition
* `get_definitions` - getDefinitions
* `get_max_allowed_limit` - getMaxAllowedLimit
* `get_workflow_closing_reasons` - getWorkflowClosingReasons
* `set_workflow_closing_reasons` - setWorkflowClosingReasons
* `update_definition` - updateDefinition
* [create_definition](docs/sdks/workflows/README.md#create_definition) - createDefinition
* [delete_definition](docs/sdks/workflows/README.md#delete_definition) - deleteDefinition
* [get_definition](docs/sdks/workflows/README.md#get_definition) - getDefinition
* [get_definitions](docs/sdks/workflows/README.md#get_definitions) - getDefinitions
* [get_max_allowed_limit](docs/sdks/workflows/README.md#get_max_allowed_limit) - getMaxAllowedLimit
* [get_workflow_closing_reasons](docs/sdks/workflows/README.md#get_workflow_closing_reasons) - getWorkflowClosingReasons
* [set_workflow_closing_reasons](docs/sdks/workflows/README.md#set_workflow_closing_reasons) - setWorkflowClosingReasons
* [update_definition](docs/sdks/workflows/README.md#update_definition) - updateDefinition
<!-- End SDK Available Operations -->



<!-- Start Dev Containers -->

<!-- End Dev Containers -->



<!-- Start Pagination -->
# Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the
returned response object will have a `Next` method that can be called to pull down the next group of results. If the
return value of `Next` is `None`, then there are no more pages to be fetched.

Here's an example of one such pagination call:
<!-- End Pagination -->



<!-- Start Error Handling -->
# Error Handling

Handling errors in your 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.


<!-- End Error Handling -->



<!-- Start Server Selection -->
# Server Selection

## Select Server by Index

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:

| # | Server | Variables |
| - | ------ | --------- |
| 0 | `https://workflows-definition.sls.epilot.io` | None |

For example:


```python
import sdk
from sdk.models import operations, shared

s = sdk.SDK(
security=shared.Security(
bearer_auth="",
),
server_idx=0
)

req = operations.ChangeReasonStatusRequest(
change_reason_status_req=shared.ChangeReasonStatusReq(
status=shared.ClosingReasonsStatus.ACTIVE,
),
reason_id='string',
)

res = s.closing_reason.change_reason_status(req)

if res.status_code == 200:
# handle response
pass
```


## Override Server URL Per-Client

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:


```python
import sdk
from sdk.models import operations, shared

s = sdk.SDK(
security=shared.Security(
bearer_auth="",
),
server_url="https://workflows-definition.sls.epilot.io"
)

req = operations.ChangeReasonStatusRequest(
change_reason_status_req=shared.ChangeReasonStatusReq(
status=shared.ClosingReasonsStatus.ACTIVE,
),
reason_id='string',
)

res = s.closing_reason.change_reason_status(req)

if res.status_code == 200:
# handle response
pass
```
<!-- End Server Selection -->



<!-- Start Custom HTTP Client -->
# Custom HTTP Client

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.


For example, you could specify a header for every request that your sdk makes as follows:

```python
import sdk
import requests

http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = sdk.SDK(client: http_client)
```


<!-- End Custom HTTP Client -->

<!-- Placeholder for Future Speakeasy SDK Sections -->



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