Skip to content

Commit 2b428c1

Browse files
dguyendguyen
committed
feat: initial
0 parents  commit 2b428c1

File tree

1,410 files changed

+66504
-0
lines changed

Some content is hidden

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

1,410 files changed

+66504
-0
lines changed

‎.devcontainer/README.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
2+
> **Remember to shutdown a GitHub Codespace when it is not in use!**
3+
4+
# Dev Containers Quick Start
5+
6+
The default location for usage snippets is the `samples` directory.
7+
8+
## Running a Usage Sample
9+
10+
A sample usage example has been provided in a `root.py` file. As you work with the SDK, it's expected that you will modify these samples to fit your needs. To execute this particular snippet, use the command below.
11+
12+
```
13+
python root.py
14+
```
15+
16+
## Generating Additional Usage Samples
17+
18+
The speakeasy CLI allows you to generate more usage snippets. Here's how:
19+
20+
- To generate a sample for a specific operation by providing an operation ID, use:
21+
22+
```
23+
speakeasy generate usage -s registry.speakeasyapi.dev/documenso-inc/api/documenso-v-2-beta-api:main -l python -i {INPUT_OPERATION_ID} -o ./samples
24+
```
25+
26+
- To generate samples for an entire namespace (like a tag or group name), use:
27+
28+
```
29+
speakeasy generate usage -s registry.speakeasyapi.dev/documenso-inc/api/documenso-v-2-beta-api:main -l python -n {INPUT_TAG_NAME} -o ./samples
30+
```

‎.devcontainer/devcontainer.json

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
2+
// README at: https://github.com/devcontainers/images/tree/main/src/python
3+
{
4+
"name": "Python",
5+
"image": "mcr.microsoft.com/devcontainers/python:1-3.11-bullseye",
6+
// Features to add to the dev container. More info: https://containers.dev/features.
7+
// "features": {},
8+
// Use 'forwardPorts' to make a list of ports inside the container available locally.
9+
// "forwardPorts": [],
10+
// Use 'postCreateCommand' to run commands after the container is created.
11+
"postCreateCommand": "sudo chmod +x ./.devcontainer/setup.sh && ./.devcontainer/setup.sh",
12+
"customizations": {
13+
"vscode": {
14+
"extensions": [
15+
"ms-python.python",
16+
"ms-python.vscode-pylance",
17+
"github.vscode-pull-request-github"
18+
],
19+
"settings": {
20+
"files.eol": "\n",
21+
"editor.formatOnSave": true,
22+
"python.formatting.provider": "black",
23+
"python.linting.enabled": true,
24+
"python.linting.pylintEnabled": true,
25+
"python.linting.flake8Enabled": true,
26+
"python.linting.banditEnabled": true,
27+
"python.testing.pytestEnabled": true
28+
}
29+
},
30+
"codespaces": {
31+
"openFiles": [
32+
".devcontainer/README.md"
33+
]
34+
}
35+
}
36+
// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
37+
// "remoteUser": "root"
38+
}

‎.devcontainer/setup.sh

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
#!/bin/bash
2+
3+
# Install the speakeasy CLI
4+
curl -fsSL https://raw.githubusercontent.com/speakeasy-api/speakeasy/main/install.sh | sh
5+
6+
# Setup samples directory
7+
rmdir samples || true
8+
mkdir samples
9+
10+
python -m pip install --upgrade pip
11+
pip install -e .
12+
13+
# Generate starter usage sample with speakeasy
14+
speakeasy generate usage -s registry.speakeasyapi.dev/documenso-inc/api/documenso-v-2-beta-api:main -l python -o samples/root.py

‎.gitattributes

+2
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

‎.github/workflows/sdk_generation.yaml

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Generate
2+
permissions:
3+
checks: write
4+
contents: write
5+
pull-requests: write
6+
statuses: write
7+
id-token: write
8+
"on":
9+
workflow_dispatch:
10+
inputs:
11+
force:
12+
description: Force generation of SDKs
13+
type: boolean
14+
default: false
15+
set_version:
16+
description: optionally set a specific SDK version
17+
type: string
18+
schedule:
19+
- cron: 0 0 * * *
20+
jobs:
21+
generate:
22+
uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15
23+
with:
24+
force: ${{ github.event.inputs.force }}
25+
mode: pr
26+
set_version: ${{ github.event.inputs.set_version }}
27+
secrets:
28+
github_access_token: ${{ secrets.GITHUB_TOKEN }}
29+
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}

‎.gitignore

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.venv/
2+
venv/
3+
src/*.egg-info/
4+
__pycache__/
5+
.pytest_cache/
6+
.python-version
7+
.DS_Store
8+
pyrightconfig.json
9+
.speakeasy/reports

‎.speakeasy/gen.lock

+1,932
Large diffs are not rendered by default.

‎.speakeasy/gen.yaml

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
configVersion: 2.0.0
2+
generation:
3+
devContainers:
4+
enabled: true
5+
schemaPath: registry.speakeasyapi.dev/documenso-inc/api/documenso-v-2-beta-api:main
6+
sdkClassName: Documenso
7+
maintainOpenAPIOrder: true
8+
usageSnippets:
9+
optionalPropertyRendering: withExample
10+
useClassNamesForArrayFields: true
11+
fixes:
12+
nameResolutionDec2023: true
13+
parameterOrderingFeb2024: true
14+
requestResponseComponentNamesFeb2024: true
15+
auth:
16+
oAuth2ClientCredentialsEnabled: true
17+
oAuth2PasswordEnabled: true
18+
python:
19+
version: 0.0.1
20+
additionalDependencies:
21+
dev: {}
22+
main: {}
23+
authors:
24+
- Speakeasy
25+
clientServerStatusCodesAsErrors: true
26+
defaultErrorName: APIError
27+
description: Python Client SDK Generated by Speakeasy.
28+
enableCustomCodeRegions: false
29+
enumFormat: enum
30+
envVarPrefix: DOCUMENSO
31+
fixFlags:
32+
responseRequiredSep2024: true
33+
flattenGlobalSecurity: true
34+
flattenRequests: true
35+
flatteningOrder: parameters-first
36+
imports:
37+
option: openapi
38+
paths:
39+
callbacks: ""
40+
errors: ""
41+
operations: ""
42+
shared: ""
43+
webhooks: ""
44+
inputModelSuffix: input
45+
maxMethodParams: 999
46+
methodArguments: infer-optional-args
47+
outputModelSuffix: output
48+
packageName: documenso_sdk
49+
responseFormat: flat
50+
templateVersion: v2

‎.speakeasy/workflow.lock

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
speakeasyVersion: 1.469.10
2+
sources:
3+
documenso-OAS:
4+
sourceNamespace: documenso-oas
5+
sourceRevisionDigest: sha256:93ee78e094f9f5de4c126c6a06c363e22412c11a874255e545a8cb610b3bf047
6+
sourceBlobDigest: sha256:b54d7f793fedc532b07ad3a417aa86f4af3d1b4f9e7496550ce6cf5a455187fb
7+
tags:
8+
- latest
9+
targets:
10+
documenso:
11+
source: documenso-OAS
12+
sourceNamespace: documenso-oas
13+
sourceRevisionDigest: sha256:93ee78e094f9f5de4c126c6a06c363e22412c11a874255e545a8cb610b3bf047
14+
sourceBlobDigest: sha256:b54d7f793fedc532b07ad3a417aa86f4af3d1b4f9e7496550ce6cf5a455187fb
15+
codeSamplesNamespace: documenso-oas-python-code-samples
16+
codeSamplesRevisionDigest: sha256:9b99bf0034c33db16e98adde685b31bc76f65a98fa2815c09cbc3af97014619c
17+
workflow:
18+
workflowVersion: 1.0.0
19+
speakeasyVersion: latest
20+
sources:
21+
documenso-OAS:
22+
inputs:
23+
- location: registry.speakeasyapi.dev/documenso-inc/api/documenso-v-2-beta-api:main
24+
registry:
25+
location: registry.speakeasyapi.dev/documenso-inc/api/documenso-oas
26+
targets:
27+
documenso:
28+
target: python
29+
source: documenso-OAS
30+
codeSamples:
31+
registry:
32+
location: registry.speakeasyapi.dev/documenso-inc/api/documenso-oas-python-code-samples
33+
labelOverride:
34+
fixedValue: Python (SDK)
35+
blocking: false

‎.speakeasy/workflow.yaml

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
workflowVersion: 1.0.0
2+
speakeasyVersion: latest
3+
sources:
4+
documenso-OAS:
5+
inputs:
6+
- location: registry.speakeasyapi.dev/documenso-inc/api/documenso-v-2-beta-api:main
7+
registry:
8+
location: registry.speakeasyapi.dev/documenso-inc/api/documenso-oas
9+
targets:
10+
documenso:
11+
target: python
12+
source: documenso-OAS
13+
codeSamples:
14+
registry:
15+
location: registry.speakeasyapi.dev/documenso-inc/api/documenso-oas-python-code-samples
16+
labelOverride:
17+
fixedValue: Python (SDK)
18+
blocking: false

‎.vscode/settings.json

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"python.testing.pytestArgs": ["tests", "-vv"],
3+
"python.testing.unittestEnabled": false,
4+
"python.testing.pytestEnabled": true,
5+
"pylint.args": ["--rcfile=pylintrc"]
6+
}

‎CONTRIBUTING.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Contributing to This Repository
2+
3+
Thank you for your interest in contributing to this repository. Please note that this repository contains generated code. As such, we do not accept direct changes or pull requests. Instead, we encourage you to follow the guidelines below to report issues and suggest improvements.
4+
5+
## How to Report Issues
6+
7+
If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please provide as much detail as possible to help us reproduce the problem. This includes:
8+
9+
- A clear and descriptive title
10+
- Steps to reproduce the issue
11+
- Expected and actual behavior
12+
- Any relevant logs, screenshots, or error messages
13+
- Information about your environment (e.g., operating system, software versions)
14+
- For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed
15+
16+
## Issue Triage and Upstream Fixes
17+
18+
We will review and triage issues as quickly as possible. Our goal is to address bugs and incorporate improvements in the upstream source code. Fixes will be included in the next generation of the generated code.
19+
20+
## Contact
21+
22+
If you have any questions or need further assistance, please feel free to reach out by opening an issue.
23+
24+
Thank you for your understanding and cooperation!
25+
26+
The Maintainers

0 commit comments

Comments
 (0)