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 Customer Portal SDK #47

Open
wants to merge 98 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
98 commits
Select commit Hold shift + click to select a range
1548a47
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.19.2
speakeasybot Mar 31, 2023
0e8da6e
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.19.3
speakeasybot Apr 1, 2023
28fc7ba
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.19.6
speakeasybot Apr 6, 2023
dbb8cee
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.19.6
speakeasybot Apr 8, 2023
13d6b31
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.19.7
speakeasybot Apr 12, 2023
a8aecad
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.20.0
speakeasybot Apr 14, 2023
1943d14
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.20.1
speakeasybot Apr 18, 2023
7833648
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.20.2
speakeasybot Apr 19, 2023
94c887c
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.21.4
speakeasybot Apr 21, 2023
95619d1
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.22.1
speakeasybot Apr 22, 2023
7f1a8c2
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.23.1
speakeasybot Apr 26, 2023
df4cf26
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.25.1
speakeasybot Apr 27, 2023
eace6bb
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.26.2
speakeasybot Apr 28, 2023
71d2f8f
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.26.4
speakeasybot Apr 29, 2023
1e5a090
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.26.5
speakeasybot May 2, 2023
4ec9067
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.27.0
speakeasybot May 3, 2023
6490176
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.29.0
speakeasybot May 5, 2023
6c1c462
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.29.1
speakeasybot May 6, 2023
2a9df8a
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.29.2
speakeasybot May 10, 2023
eb15a37
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.30.0
speakeasybot May 11, 2023
d404546
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.30.1
speakeasybot May 12, 2023
969129a
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.31.1
speakeasybot May 13, 2023
c352c28
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.32.0
speakeasybot May 16, 2023
47ca753
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.33.2
speakeasybot May 17, 2023
85195da
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.34.0
speakeasybot May 18, 2023
ab8992b
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.35.0
speakeasybot May 19, 2023
08f254b
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.37.5
speakeasybot May 23, 2023
0b3509f
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.39.0
speakeasybot May 27, 2023
4b8e969
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.40.2
speakeasybot Jun 1, 2023
a9a9375
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.40.3
speakeasybot Jun 2, 2023
716dffc
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.43.0
speakeasybot Jun 3, 2023
fe484c6
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.44.0
speakeasybot Jun 6, 2023
a6dd3e8
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.44.2
speakeasybot Jun 7, 2023
b1ae80c
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.45.0
speakeasybot Jun 8, 2023
6bdf433
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.45.2
speakeasybot Jun 9, 2023
5bc66c9
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.47.0
speakeasybot Jun 10, 2023
fb28d76
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.47.1
speakeasybot Jun 11, 2023
a2c569e
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.47.1
speakeasybot Jun 13, 2023
86dc5e5
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.47.3
speakeasybot Jun 14, 2023
0987d70
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.48.0
speakeasybot Jun 16, 2023
e7ac94e
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.49.0
speakeasybot Jun 20, 2023
f805579
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.49.1
speakeasybot Jun 21, 2023
0695c48
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.50.1
speakeasybot Jun 23, 2023
c012124
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.51.1
speakeasybot Jun 27, 2023
73977c7
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.51.3
speakeasybot Jun 29, 2023
00e107e
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.52.0
speakeasybot Jul 1, 2023
2ebe804
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.52.2
speakeasybot Jul 6, 2023
6e3c543
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.53.0
speakeasybot Jul 7, 2023
d5ae8d5
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.53.1
speakeasybot Jul 8, 2023
e3c4a41
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.56.0
speakeasybot Jul 11, 2023
ef394dc
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.56.3
speakeasybot Jul 12, 2023
5c8212b
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.57.0
speakeasybot Jul 13, 2023
3a43161
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.59.0
speakeasybot Jul 14, 2023
737fac6
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.61.0
speakeasybot Jul 18, 2023
e005054
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.62.1
speakeasybot Jul 19, 2023
99858d5
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.64.0
speakeasybot Jul 22, 2023
045e688
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.65.0
speakeasybot Jul 26, 2023
550d38f
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.65.1
speakeasybot Jul 27, 2023
ad4c685
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.65.2
speakeasybot Jul 28, 2023
0a74478
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.66.1
speakeasybot Aug 1, 2023
4e250ef
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.68.1
speakeasybot Aug 3, 2023
e7befeb
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.68.3
speakeasybot Aug 4, 2023
cb3fa38
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.69.1
speakeasybot Aug 8, 2023
4f93046
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.71.0
speakeasybot Aug 11, 2023
19c75de
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.72.0
speakeasybot Aug 15, 2023
2fc24f7
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.73.1
speakeasybot Aug 17, 2023
c837e4d
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.73.1
speakeasybot Aug 18, 2023
c354119
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.74.3
speakeasybot Aug 19, 2023
b2b2b08
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.74.15
speakeasybot Aug 26, 2023
af2b8c0
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.74.17
speakeasybot Aug 29, 2023
6452200
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.76.0
speakeasybot Aug 31, 2023
e484d81
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.77.0
speakeasybot Sep 1, 2023
1e36721
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.77.2
speakeasybot Sep 2, 2023
1673385
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.78.3
speakeasybot Sep 5, 2023
2d51292
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.78.8
speakeasybot Sep 6, 2023
d76cb0f
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.82.5
speakeasybot Sep 12, 2023
f58d5ac
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.86.0
speakeasybot Sep 16, 2023
2257413
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.88.0
speakeasybot Sep 20, 2023
71af09e
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.88.1
speakeasybot Sep 21, 2023
e7c5733
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.89.0
speakeasybot Sep 22, 2023
94d3429
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.90.0
speakeasybot Sep 23, 2023
01d716b
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.91.0
speakeasybot Sep 26, 2023
a4591d0
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.91.2
speakeasybot Sep 27, 2023
527643d
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.91.3
speakeasybot Sep 29, 2023
30756de
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.91.4
speakeasybot Sep 30, 2023
5df4aec
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.92.2
speakeasybot Oct 1, 2023
49f2494
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.92.3
speakeasybot Oct 2, 2023
bc6262c
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.94.0
speakeasybot Oct 5, 2023
66ef5ee
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.96.1
speakeasybot Oct 7, 2023
fac8bad
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.99.0
speakeasybot Oct 13, 2023
80bdc31
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.99.2
speakeasybot Oct 14, 2023
2d07f00
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.101.0
speakeasybot Oct 18, 2023
883ac1d
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.104.0
speakeasybot Oct 21, 2023
4528bfc
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.105.0
speakeasybot Oct 24, 2023
7c2e86b
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.107.0
speakeasybot Oct 26, 2023
68a5cce
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.109.0
speakeasybot Oct 28, 2023
4cd39a3
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.109.0
speakeasybot Oct 31, 2023
abb0210
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.109.2
speakeasybot Nov 1, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 2 additions & 0 deletions customer_portal/.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 customer_portal/.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`
276 changes: 212 additions & 64 deletions customer_portal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,80 +12,228 @@ pip install git+https://github.com/epilot-dev/sdk-python.git#subdirectory=custom
<!-- Start SDK Example Usage -->
```python
import epilot
import dateutil.parser
from epilot.models import operations, shared

s = epilot.Epilot()

s = epilot.Epilot(
security=shared.Security(
epilot_auth="",
),
)

req = operations.AddEndCustomerRelationToEntityRequest(
id="unde",
slug="contact",
req = operations.GetEntityActivityFeedRequest(
id='5da0a718-c822-403d-9f5d-20d4584e0528',
slug=shared.EntitySlug.CONTACT,
type='SyncActivity',
)

res = s.ecp.add_end_customer_relation_to_entity(req, operations.AddEndCustomerRelationToEntitySecurity(
portal_auth="Bearer YOUR_BEARER_TOKEN_HERE",
))

if res.add_end_customer_relation_to_entity_200_application_json_object is not None:
res = s.activity.get_entity_activity_feed(req)

if res.get_entity_activity_feed_200_application_json_object is not None:
# handle response
pass
```
<!-- End SDK Example Usage -->

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


### ecp

* `add_end_customer_relation_to_entity` - addEndCustomerRelationToEntity
* `delete_entity_file` - Delete files from an entity
* `delete_portal_user` - deletePortalUser
* `get_all_contracts` - getAllContracts
* `get_all_opportunities` - getAllOpportunities
* `get_all_orders` - getAllOrders
* `get_contact` - getContact
* `get_contract` - get contract based on id
* `get_entities_by_identifiers` - getEntitiesByIdentifiers
* `get_opportunity` - getOpportunity
* `get_order` - getOrder
* `get_organization_settings` - getOrganizationSettings
* `get_portal_config` - getPortalConfig
* `get_portal_config_by_domain` - getPortalConfigByDomain
* `get_portal_user` - getPortalUser
* `get_schemas` - getSchemas
* `save_entity_file` - Add files to an entity
* `test_auth` - testAuth
* `update_contact` - updateContact
* `update_contract` - Update contract based on id
* `update_opportunity` - Update an opportunity based on id
* `update_order` - updateOrder
* `update_portal_user` - updatePortalUser

### ecp_admin

* `configure_distribution` - configureDistribution
* `delete_portal` - deletePortal
* `extra_permission_attributes` - extraPermissionAttributes
* `get_all_portal_configs` - getAllPortalConfigs
* `get_ecp_contact` - getECPContact
* `get_email_templates` - getEmailTemplates
* `get_entity_identifiers` - getEntityIdentifiers
* `get_org_portal_config` - getOrgPortalConfig
* `get_portal_config` - getPortalConfig
* `get_public_portal_config` - getPublicPortalConfig
* `get_valid_secondary_attributes` - getValidSecondaryAttributes
* `replace_ecp_template_variables` - replaceECPTemplateVariables
* `save_portal_files` - Add files to portal
* `upsert_email_templates` - upsertEmailTemplates
* `upsert_portal` - upserts a portal

### public

* `activate_user` - activateUser
* `confirm_user` - confirmUser
* `create_user` - creates a user
* `get_count_by_email` - getCountByEmail
* `user_exists` - userExists
## Available Resources and Operations


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

* [get_entity_activity_feed](docs/sdks/activity/README.md#get_entity_activity_feed) - getEntityActivityFeed

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

* [get_customer_balance](docs/sdks/balance/README.md#get_customer_balance) - getCustomerBalance

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

* [add_end_customer_relation_to_entity](docs/sdks/ecp/README.md#add_end_customer_relation_to_entity) - addEndCustomerRelationToEntity
* [create_custom_entity_activity](docs/sdks/ecp/README.md#create_custom_entity_activity) - createCustomEntityActivity
* [delete_entity_file](docs/sdks/ecp/README.md#delete_entity_file) - deleteEntityFile
* [delete_portal_user](docs/sdks/ecp/README.md#delete_portal_user) - deletePortalUser
* [get_all_contracts](docs/sdks/ecp/README.md#get_all_contracts) - getAllContracts
* [get_all_files](docs/sdks/ecp/README.md#get_all_files) - getAllFiles
* [get_all_opportunities](docs/sdks/ecp/README.md#get_all_opportunities) - getAllOpportunities
* [get_all_orders](docs/sdks/ecp/README.md#get_all_orders) - getAllOrders
* [get_billing_events](docs/sdks/ecp/README.md#get_billing_events) - getBillingEvents
* [get_contact](docs/sdks/ecp/README.md#get_contact) - getContact
* [get_contract](docs/sdks/ecp/README.md#get_contract) - getContract
* [get_entities_by_identifiers](docs/sdks/ecp/README.md#get_entities_by_identifiers) - getEntitiesByIdentifiers
* [get_file_by_id](docs/sdks/ecp/README.md#get_file_by_id) - getFileById
* [get_files_count_by_entity](docs/sdks/ecp/README.md#get_files_count_by_entity) - getFileCountByEntity
* [get_opportunity](docs/sdks/ecp/README.md#get_opportunity) - getOpportunity
* [get_order](docs/sdks/ecp/README.md#get_order) - getOrder
* [get_organization_settings](docs/sdks/ecp/README.md#get_organization_settings) - getOrganizationSettings
* [get_portal_config](docs/sdks/ecp/README.md#get_portal_config) - getPortalConfig
* [get_portal_user](docs/sdks/ecp/README.md#get_portal_user) - getPortalUser
* [get_portal_widgets](docs/sdks/ecp/README.md#get_portal_widgets) - getPortalWidgets
* [get_schemas](docs/sdks/ecp/README.md#get_schemas) - getSchemas
* [save_entity_file](docs/sdks/ecp/README.md#save_entity_file) - saveEntityFile
* [track_file_downloaded](docs/sdks/ecp/README.md#track_file_downloaded) - trackFileDownloaded
* [trigger_entity_access](docs/sdks/ecp/README.md#trigger_entity_access) - triggerEntityAccess
* [update_contact](docs/sdks/ecp/README.md#update_contact) - updateContact
* [update_contract](docs/sdks/ecp/README.md#update_contract) - updateContract
* [update_opportunity](docs/sdks/ecp/README.md#update_opportunity) - updateOpportunity
* [update_order](docs/sdks/ecp/README.md#update_order) - updateOrder
* [update_portal_user](docs/sdks/ecp/README.md#update_portal_user) - updatePortalUser

### [ecp_admin](docs/sdks/ecpadmin/README.md)

* [configure_distribution](docs/sdks/ecpadmin/README.md#configure_distribution) - configureDistribution
* [create_sso_user](docs/sdks/ecpadmin/README.md#create_sso_user) - createSSOUser
* [delete_portal](docs/sdks/ecpadmin/README.md#delete_portal) - deletePortal
* [extra_permission_attributes](docs/sdks/ecpadmin/README.md#extra_permission_attributes) - extraPermissionAttributes
* [fetch_portal_users_by_related_entity](docs/sdks/ecpadmin/README.md#fetch_portal_users_by_related_entity) - fetchPortalUsersByRelatedEntity
* [get_all_portal_configs](docs/sdks/ecpadmin/README.md#get_all_portal_configs) - getAllPortalConfigs
* [get_ecp_contact](docs/sdks/ecpadmin/README.md#get_ecp_contact) - getECPContact
* [get_email_templates](docs/sdks/ecpadmin/README.md#get_email_templates) - getEmailTemplates
* [get_entity_identifiers](docs/sdks/ecpadmin/README.md#get_entity_identifiers) - getEntityIdentifiers
* [get_org_portal_config](docs/sdks/ecpadmin/README.md#get_org_portal_config) - getOrgPortalConfig
* [get_portal_config](docs/sdks/ecpadmin/README.md#get_portal_config) - getPortalConfig
* [get_portal_widgets](docs/sdks/ecpadmin/README.md#get_portal_widgets) - getPortalWidgets
* [get_valid_secondary_attributes](docs/sdks/ecpadmin/README.md#get_valid_secondary_attributes) - getValidSecondaryAttributes
* [login_to_portal_as_user](docs/sdks/ecpadmin/README.md#login_to_portal_as_user) - loginToPortalAsUser
* [replace_ecp_template_variables](docs/sdks/ecpadmin/README.md#replace_ecp_template_variables) - replaceECPTemplateVariables
* [save_portal_files](docs/sdks/ecpadmin/README.md#save_portal_files) - savePortalFiles
* [upsert_email_templates](docs/sdks/ecpadmin/README.md#upsert_email_templates) - upsertEmailTemplates
* [upsert_portal](docs/sdks/ecpadmin/README.md#upsert_portal) - upsertPortal
* [upsert_portal_widget](docs/sdks/ecpadmin/README.md#upsert_portal_widget) - upsertPortalWidget

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

* [confirm_user](docs/sdks/public/README.md#confirm_user) - confirmUser
* [create_user](docs/sdks/public/README.md#create_user) - createUser
* [get_contact_count](docs/sdks/public/README.md#get_contact_count) - getContactCount
* [get_count_by_email](docs/sdks/public/README.md#get_count_by_email) - getCountByEmail
* [get_portal_config_by_domain](docs/sdks/public/README.md#get_portal_config_by_domain) - getPortalConfigByDomain
* [get_public_portal_config](docs/sdks/public/README.md#get_public_portal_config) - getPublicPortalConfig
* [get_public_portal_widgets](docs/sdks/public/README.md#get_public_portal_widgets) - getPublicPortalWidgets
* [user_exists](docs/sdks/public/README.md#user_exists) - userExists
<!-- 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://customer-portal-api.sls.epilot.io` | None |

For example:


```python
import epilot
import dateutil.parser
from epilot.models import operations, shared

s = epilot.Epilot(
security=shared.Security(
epilot_auth="",
),
server_idx=0
)

req = operations.GetEntityActivityFeedRequest(
id='5da0a718-c822-403d-9f5d-20d4584e0528',
slug=shared.EntitySlug.CONTACT,
type='SyncActivity',
)

res = s.activity.get_entity_activity_feed(req)

if res.get_entity_activity_feed_200_application_json_object is not None:
# 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
import dateutil.parser
from epilot.models import operations, shared

s = epilot.Epilot(
security=shared.Security(
epilot_auth="",
),
server_url="https://customer-portal-api.sls.epilot.io"
)

req = operations.GetEntityActivityFeedRequest(
id='5da0a718-c822-403d-9f5d-20d4584e0528',
slug=shared.EntitySlug.CONTACT,
type='SyncActivity',
)

res = s.activity.get_entity_activity_feed(req)

if res.get_entity_activity_feed_200_application_json_object is not None:
# 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