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 Submission SDK #63

Open
wants to merge 84 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
84 commits
Select commit Hold shift + click to select a range
b6ce6bc
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.19.3
speakeasybot Apr 1, 2023
f5ea896
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.19.6
speakeasybot Apr 6, 2023
e4552ee
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.19.7
speakeasybot Apr 12, 2023
29f2b8f
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.20.0
speakeasybot Apr 14, 2023
6168545
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.20.1
speakeasybot Apr 18, 2023
7359aee
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.20.2
speakeasybot Apr 19, 2023
fa8c382
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.21.4
speakeasybot Apr 21, 2023
6ad8fa9
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.22.1
speakeasybot Apr 22, 2023
1de8615
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.23.1
speakeasybot Apr 26, 2023
2919a07
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.25.1
speakeasybot Apr 27, 2023
3e9e4cd
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.26.2
speakeasybot Apr 28, 2023
bca9847
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.26.4
speakeasybot Apr 29, 2023
0b9d60b
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.26.5
speakeasybot May 2, 2023
f035397
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.27.0
speakeasybot May 3, 2023
3711158
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.29.0
speakeasybot May 5, 2023
852e738
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.29.1
speakeasybot May 6, 2023
74d2af0
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.29.2
speakeasybot May 10, 2023
f77c1ab
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.30.0
speakeasybot May 11, 2023
b2de9d4
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.30.1
speakeasybot May 12, 2023
008cad7
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.31.1
speakeasybot May 13, 2023
36c9828
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.32.0
speakeasybot May 16, 2023
217a3e4
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.33.2
speakeasybot May 17, 2023
e4e2927
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.34.0
speakeasybot May 18, 2023
4860327
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.35.0
speakeasybot May 19, 2023
c99feab
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.37.5
speakeasybot May 23, 2023
f5e7d02
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.39.0
speakeasybot May 27, 2023
91a1486
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.40.2
speakeasybot Jun 1, 2023
6a5e36d
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.40.3
speakeasybot Jun 2, 2023
07f9cc1
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.43.0
speakeasybot Jun 3, 2023
6931afa
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.44.2
speakeasybot Jun 7, 2023
dee13ca
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.45.0
speakeasybot Jun 8, 2023
73a8695
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.45.2
speakeasybot Jun 9, 2023
7bf5377
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.47.0
speakeasybot Jun 10, 2023
b54f008
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.47.1
speakeasybot Jun 11, 2023
03bd21b
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.47.3
speakeasybot Jun 14, 2023
0c21a2b
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.48.0
speakeasybot Jun 16, 2023
9e6fef8
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.49.0
speakeasybot Jun 20, 2023
977b68a
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.49.1
speakeasybot Jun 21, 2023
ba2023f
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.50.1
speakeasybot Jun 23, 2023
a2e96bc
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.51.1
speakeasybot Jun 27, 2023
4d80a7d
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.51.3
speakeasybot Jun 29, 2023
1bc4f5f
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.51.3
speakeasybot Jun 30, 2023
733e0f5
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.52.0
speakeasybot Jul 1, 2023
f74eea4
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.52.2
speakeasybot Jul 6, 2023
10a9efb
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.53.0
speakeasybot Jul 7, 2023
f2248bb
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.53.1
speakeasybot Jul 8, 2023
0c71860
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.56.0
speakeasybot Jul 11, 2023
d70d1c1
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.56.4
speakeasybot Jul 12, 2023
99f08e8
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.57.0
speakeasybot Jul 13, 2023
0620c9f
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.59.0
speakeasybot Jul 14, 2023
a41e8bb
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.60.0
speakeasybot Jul 17, 2023
2433ee2
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.61.0
speakeasybot Jul 18, 2023
d9411e5
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.62.1
speakeasybot Jul 19, 2023
56892d9
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.64.0
speakeasybot Jul 22, 2023
6a53ae3
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.65.0
speakeasybot Jul 26, 2023
8c81d34
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.65.1
speakeasybot Jul 27, 2023
42dcc93
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.65.2
speakeasybot Jul 28, 2023
defd57f
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.66.1
speakeasybot Aug 1, 2023
93d65e3
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.68.1
speakeasybot Aug 3, 2023
a546687
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.68.3
speakeasybot Aug 4, 2023
31b5c0c
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.69.1
speakeasybot Aug 8, 2023
b200548
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.72.0
speakeasybot Aug 15, 2023
b2eed43
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.74.3
speakeasybot Aug 19, 2023
6a7769e
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.74.11
speakeasybot Aug 25, 2023
5700bfd
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.74.16
speakeasybot Aug 26, 2023
9472d30
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.74.17
speakeasybot Aug 29, 2023
823543f
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.76.1
speakeasybot Aug 31, 2023
d063d43
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.77.0
speakeasybot Sep 1, 2023
60af492
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.77.2
speakeasybot Sep 2, 2023
11a4159
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.78.3
speakeasybot Sep 5, 2023
a90023d
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.82.5
speakeasybot Sep 12, 2023
104cff2
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.86.0
speakeasybot Sep 16, 2023
8c0f6df
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.88.0
speakeasybot Sep 20, 2023
61bf866
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.91.0
speakeasybot Sep 26, 2023
5b303fd
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.91.2
speakeasybot Sep 27, 2023
b4cb8a0
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.91.3
speakeasybot Sep 29, 2023
6235865
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.92.2
speakeasybot Oct 1, 2023
e794775
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.92.3
speakeasybot Oct 2, 2023
ead3544
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.94.0
speakeasybot Oct 5, 2023
c8b69e5
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.96.1
speakeasybot Oct 7, 2023
307f42c
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.99.1
speakeasybot Oct 13, 2023
172de37
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.101.0
speakeasybot Oct 18, 2023
43aec95
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.104.0
speakeasybot Oct 21, 2023
e5e1593
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 submission/.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 submission/.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`
283 changes: 250 additions & 33 deletions submission/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,65 +12,282 @@ pip install git+https://github.com/epilot-dev/sdk-python.git#subdirectory=submis
<!-- Start SDK Example Usage -->
```python
import epilot
from epilot.models import operations, shared
from epilot.models import shared

s = epilot.Epilot()


req = shared.SubmissionPayload(
ivy_opportunity_ids=[
"deserunt",
"porro",
"nulla",
'string',
],
entities=[
{
"perspiciatis": "nulla",
"nihil": "fuga",
"facilis": "eum",
"iusto": "ullam",
},
{
"inventore": "sapiente",
"enim": "eum",
"voluptatum": "autem",
"vel": "non",
},
{
"similique": "reprehenderit",
"molestiae": "quo",
},
shared.SubmissionEntity(
additional_properties={
"contact_last_name": 'string',
"contact_email": 'string',
"request": 'string',
"files": 'string',
"_schema": 'string',
"description": 'string',
"contact_first_name": 'string',
},
schema=shared.SubmissionEntitySchema.SUBMISSION,
files=[
shared.SubmissionEntityFiles(
additional_properties={
"key": 'string',
},
tags=[
'string',
],
relation_tags=[
'string',
],
s3ref=shared.S3Reference(
bucket='epilot-user-content',
key='temp/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf',
),
),
],
),
],
journey_submit_id="123",
journey_submit_id='123',
opt_ins=[
shared.OptIn(
identifier="[email protected]",
identifier='[email protected]',
meta={
"dicta": "est",
"voluptatem": "consequatur",
"key": 'string',
},
topic="EMAIL_MARKETING",
topic='EMAIL_MARKETING',
),
],
organization_id="123",
source_id="ce99875f-fba9-4fe2-a8f9-afaf52059051",
source_type="journey",
organization_id='123',
source_id='ce99875f-fba9-4fe2-a8f9-afaf52059051',
source_type='journey',
)

res = s.submissions.create_submission(req)

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

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


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

* `create_submission` - createSubmission
* [create_submission](docs/sdks/submissions/README.md#create_submission) - createSubmission
<!-- 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://submission.sls.epilot.io` | None |

For example:


```python
import epilot
from epilot.models import shared

s = epilot.Epilot(
server_idx=0
)

req = shared.SubmissionPayload(
ivy_opportunity_ids=[
'string',
],
entities=[
shared.SubmissionEntity(
additional_properties={
"contact_first_name": 'string',
"contact_last_name": 'string',
"contact_email": 'string',
"request": 'string',
"files": 'string',
"_schema": 'string',
"description": 'string',
},
schema=shared.SubmissionEntitySchema.SUBMISSION,
files=[
shared.SubmissionEntityFiles(
additional_properties={
"key": 'string',
},
tags=[
'string',
],
relation_tags=[
'string',
],
s3ref=shared.S3Reference(
bucket='epilot-user-content',
key='temp/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf',
),
),
],
),
],
journey_submit_id='123',
opt_ins=[
shared.OptIn(
identifier='[email protected]',
meta={
"key": 'string',
},
topic='EMAIL_MARKETING',
),
],
organization_id='123',
source_id='ce99875f-fba9-4fe2-a8f9-afaf52059051',
source_type='journey',
)

res = s.submissions.create_submission(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 epilot
from epilot.models import shared

s = epilot.Epilot(
server_url="https://submission.sls.epilot.io"
)

req = shared.SubmissionPayload(
ivy_opportunity_ids=[
'string',
],
entities=[
shared.SubmissionEntity(
additional_properties={
"contact_first_name": 'string',
"contact_last_name": 'string',
"contact_email": 'string',
"request": 'string',
"files": 'string',
"_schema": 'string',
"description": 'string',
},
schema=shared.SubmissionEntitySchema.SUBMISSION,
files=[
shared.SubmissionEntityFiles(
additional_properties={
"key": 'string',
},
tags=[
'string',
],
relation_tags=[
'string',
],
s3ref=shared.S3Reference(
bucket='epilot-user-content',
key='temp/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf',
),
),
],
),
],
journey_submit_id='123',
opt_ins=[
shared.OptIn(
identifier='[email protected]',
meta={
"key": 'string',
},
topic='EMAIL_MARKETING',
),
],
organization_id='123',
source_id='ce99875f-fba9-4fe2-a8f9-afaf52059051',
source_type='journey',
)

res = s.submissions.create_submission(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 epilot
import requests

http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = epilot.Epilot(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