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: 🐝 Update SDK - Generate Client SDKs for Wingspan cms #16

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Empty file modified cms/.gitattributes
100755 → 100644
Empty file.
74 changes: 74 additions & 0 deletions cms/.speakeasy/gen.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
lockVersion: 2.0.0
id: a13af8b2-f7cf-4bfa-a5aa-03617427433b
management:
docChecksum: a394825e1c1bc4930882a784d6d637e8
docVersion: 1.0.0
speakeasyVersion: internal
generationVersion: 2.237.3
releaseVersion: 3.0.1
configChecksum: 25e4747b353811dfc74a9998d36c9005
repoURL: https://github.com/wingspanHQ/client-sdk-python.git
repoSubDirectory: cms
installationURL: https://github.com/wingspanHQ/client-sdk-python.git#subdirectory=cms
published: true
features:
python:
core: 4.4.2
flattening: 2.81.1
globalSecurity: 2.83.2
globalServerURLs: 2.82.1
generatedFiles:
- src/sdk/sdkconfiguration.py
- src/sdk/benefits_enrollment.py
- src/sdk/benefits_service.py
- src/sdk/sdk.py
- pylintrc
- setup.py
- src/sdk/__init__.py
- src/sdk/utils/__init__.py
- src/sdk/utils/retries.py
- src/sdk/utils/utils.py
- src/sdk/models/errors/sdkerror.py
- tests/helpers.py
- src/sdk/models/operations/get_benefits_enrollment_id_.py
- src/sdk/models/operations/get_benefits_plan_enrollment.py
- src/sdk/models/operations/get_benefits_plan_enrollment_id_.py
- src/sdk/models/operations/get_benefits_service.py
- src/sdk/models/operations/patch_benefits_service_id_.py
- src/sdk/models/shared/enrollment.py
- src/sdk/models/shared/e974d9e9e5676123cf56d2fd858ece1c24be8be15b96a100963b7cb1afada329.py
- src/sdk/models/shared/planenrollment.py
- src/sdk/models/shared/userroles.py
- src/sdk/models/shared/planenrollmentcoveragemonth.py
- src/sdk/models/shared/a71f30be878693b235f8c5f1650be03c9920ca9821526545760476436104c9dc.py
- src/sdk/models/shared/serviceenablementresponse.py
- src/sdk/models/shared/serviceenablementupdate.py
- src/sdk/models/shared/security.py
- src/sdk/models/__init__.py
- src/sdk/models/errors/__init__.py
- src/sdk/models/operations/__init__.py
- src/sdk/models/shared/__init__.py
- docs/models/operations/getbenefitsenrollmentidrequest.md
- docs/models/operations/getbenefitsenrollmentidresponse.md
- docs/models/operations/getbenefitsplanenrollmentresponse.md
- docs/models/operations/getbenefitsplanenrollmentidrequest.md
- docs/models/operations/getbenefitsplanenrollmentidresponse.md
- docs/models/operations/getbenefitsserviceresponse.md
- docs/models/operations/patchbenefitsserviceidrequest.md
- docs/models/operations/patchbenefitsserviceidresponse.md
- docs/models/shared/enrollment.md
- docs/models/shared/e974d9e9e5676123cf56d2fd858ece1c24be8be15b96a100963b7cb1afada329status.md
- docs/models/shared/e974d9e9e5676123cf56d2fd858ece1c24be8be15b96a100963b7cb1afada329.md
- docs/models/shared/plantype.md
- docs/models/shared/status.md
- docs/models/shared/planenrollment.md
- docs/models/shared/userroles.md
- docs/models/shared/fundingstatus.md
- docs/models/shared/planenrollmentcoveragemonth.md
- docs/models/shared/a71f30be878693b235f8c5f1650be03c9920ca9821526545760476436104c9dc.md
- docs/models/shared/servicestate.md
- docs/models/shared/serviceenablementresponse.md
- docs/models/shared/serviceenablementupdate.md
- docs/models/shared/security.md
- USAGE.md
- .gitattributes
101 changes: 73 additions & 28 deletions cms/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,88 +5,104 @@
<!-- No SDK Available Operations -->


<!-- Start Dev Containers -->


<!-- Start Error Handling [errors] -->
## Error Handling

<!-- End Dev Containers -->
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.

| Error Object | Status Code | Content Type |
| --------------- | --------------- | --------------- |
| errors.SDKError | 4x-5xx | */* |

### Example

<!-- Start Error Handling -->
# Error Handling
```python
import sdk
from sdk.models import operations

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.
s = sdk.SDK(
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)


<!-- End Error Handling -->
res = None
try:
res = s.benefits_enrollment.get_benefits_enrollment_id_(id='string')
except errors.SDKError as e:
print(e) # handle exception
raise(e)

if res.enrollment is not None:
# handle response
pass
```
<!-- End Error Handling [errors] -->


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

## Select Server by Index
<!-- Start Server Selection [server] -->
## 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://api.wingspan.app/benefits` | None |
| 1 | `https://stagingapi.wingspan.app/benefits` | None |

For example:
| 0 | `https://api.wingspan.app` | None |
| 1 | `https://stagingapi.wingspan.app` | None |

#### Example

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

s = sdk.SDK(
server_idx=1
server_idx=1,
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)


res = s.sdk.get_benefits_enrollment_id_(id='string')
res = s.benefits_enrollment.get_benefits_enrollment_id_(id='string')

if res.enrollment is not None:
# handle response
pass
```


## Override Server URL Per-Client
### 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

s = sdk.SDK(
server_url="https://api.wingspan.app/benefits"
server_url="https://api.wingspan.app",
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)


res = s.sdk.get_benefits_enrollment_id_(id='string')
res = s.benefits_enrollment.get_benefits_enrollment_id_(id='string')

if res.enrollment is not None:
# handle response
pass
```
<!-- End Server Selection -->
<!-- End Server Selection [server] -->



<!-- Start Custom HTTP Client -->
# Custom HTTP Client
<!-- Start Custom HTTP Client [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:
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 this sdk makes as follows:
```python
import sdk
import requests
Expand All @@ -95,9 +111,38 @@ http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = sdk.SDK(client: http_client)
```
<!-- End Custom HTTP Client [http-client] -->



<!-- Start Authentication [security] -->
## Authentication

<!-- End Custom HTTP Client -->
### Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme |
| ------------- | ------------- | ------------- |
| `bearer_auth` | http | HTTP Bearer |

To authenticate with the API the `bearer_auth` parameter must be set when initializing the SDK client instance. For example:
```python
import sdk
from sdk.models import operations

s = sdk.SDK(
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)


res = s.benefits_enrollment.get_benefits_enrollment_id_(id='string')

if res.enrollment is not None:
# handle response
pass
```
<!-- End Authentication [security] -->

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

Expand Down
71 changes: 71 additions & 0 deletions cms/RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,74 @@ Based on:
- [python v1.0.0] cms
### Releases
- [PyPI v1.0.0] https://pypi.org/project/wingspan_cms/1.0.0 - cms


## 2023-11-13 01:26:17
### Changes
Based on:
- OpenAPI Doc 1.0.0 https://docs.wingspan.app/openapi/6470f38d65c260000c025474
- Speakeasy CLI 1.119.0 (2.188.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v2.0.0] cms
### Releases
- [PyPI v2.0.0] https://pypi.org/project/wingspan_cms/2.0.0 - cms

## 2023-11-20 01:27:14
### Changes
Based on:
- OpenAPI Doc 1.0.0 https://docs.wingspan.app/openapi/6470f38d65c260000c025474
- Speakeasy CLI 1.121.1 (2.194.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v2.0.1] cms
### Releases
- [PyPI v2.0.1] https://pypi.org/project/wingspan_cms/2.0.1 - cms

## 2023-11-27 01:27:02
### Changes
Based on:
- OpenAPI Doc 1.0.0 https://docs.wingspan.app/openapi/6470f38d65c260000c025474
- Speakeasy CLI 1.122.0 (2.195.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v2.0.2] cms
### Releases
- [PyPI v2.0.2] https://pypi.org/project/wingspan_cms/2.0.2 - cms

## 2023-12-11 01:27:38
### Changes
Based on:
- OpenAPI Doc 1.0.0 https://docs.wingspan.app/openapi/6470f38d65c260000c025474
- Speakeasy CLI 1.125.2 (2.210.6) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v2.0.3] cms
### Releases
- [PyPI v2.0.3] https://pypi.org/project/wingspan_cms/2.0.3 - cms

## 2023-12-18 01:27:26
### Changes
Based on:
- OpenAPI Doc 1.0.0 https://docs.wingspan.app/openapi/6470f38d65c260000c025474
- Speakeasy CLI 1.126.4 (2.214.10) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v2.1.0] cms
### Releases
- [PyPI v2.1.0] https://pypi.org/project/wingspan_cms/2.1.0 - cms

## 2024-01-08 01:27:42
### Changes
Based on:
- OpenAPI Doc 1.0.0 https://docs.wingspan.app/openapi/6470f38d65c260000c025474
- Speakeasy CLI 1.133.1 (2.228.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v3.0.0] cms
### Releases
- [PyPI v3.0.0] https://pypi.org/project/wingspan_cms/3.0.0 - cms

## 2024-01-22 01:29:29
### Changes
Based on:
- OpenAPI Doc 1.0.0 https://docs.wingspan.app/openapi/6470f38d65c260000c025474
- Speakeasy CLI 1.148.0 (2.237.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v3.0.1] cms
### Releases
- [PyPI v3.0.1] https://pypi.org/project/wingspan_cms/3.0.1 - cms
12 changes: 6 additions & 6 deletions cms/USAGE.md
100755 → 100644
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
<!-- Start SDK Example Usage -->


<!-- Start SDK Example Usage [usage] -->
```python
import sdk
from sdk.models import operations

s = sdk.SDK()
s = sdk.SDK(
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)


res = s.sdk.get_benefits_enrollment_id_(id='string')
res = s.benefits_enrollment.get_benefits_enrollment_id_(id='string')

if res.enrollment is not None:
# handle response
pass
```
<!-- End SDK Example Usage -->
<!-- End SDK Example Usage [usage] -->
Empty file modified cms/docs/models/operations/getbenefitsenrollmentidrequest.md
100755 → 100644
Empty file.
2 changes: 1 addition & 1 deletion cms/docs/models/operations/getbenefitsenrollmentidresponse.md
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
| `enrollment` | [Optional[shared.Enrollment]](../../models/shared/enrollment.md) | :heavy_minus_sign: | An Enrollment records |
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
Empty file.
2 changes: 1 addition & 1 deletion cms/docs/models/operations/getbenefitsplanenrollmentidresponse.md
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
| `plan_enrollment` | [Optional[shared.PlanEnrollment]](../../models/shared/planenrollment.md) | :heavy_minus_sign: | An enrollment into a plan |
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
4 changes: 2 additions & 2 deletions cms/docs/models/operations/getbenefitsplanenrollmentresponse.md
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
| `plan_enrollments` | List[[shared.PlanEnrollment](../../models/shared/planenrollment.md)] | :heavy_minus_sign: | List of plan enrollments for a member |
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `classes` | List[[shared.PlanEnrollment](../../models/shared/planenrollment.md)] | :heavy_minus_sign: | List of plan enrollments for a member |
2 changes: 1 addition & 1 deletion cms/docs/models/operations/getbenefitsserviceresponse.md
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
| `service_enablement_response` | [Optional[shared.ServiceEnablementResponse]](../../models/shared/serviceenablementresponse.md) | :heavy_minus_sign: | Indicates status of service enablement |
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
Empty file modified cms/docs/models/operations/patchbenefitsserviceidrequest.md
100755 → 100644
Empty file.
Loading