Merge pull request #223 from codatio/speakeasy-sdk-regen-1689207702

chore: speakeasy sdk regeneration - Generate Common SDK
codatio · Jul 14, 2023 · bf6d1b9 · bf6d1b9
2 parents c0a748b + 9f0796c
commit bf6d1b9
Show file tree

Hide file tree

Showing 37 changed files with 215 additions and 134 deletions.
diff --git a/common/README.md b/common/README.md
@@ -10,6 +10,8 @@ pip install codat-common
 
 ## SDK Example Usage
 <!-- Start SDK Example Usage -->
+
+
 ```python
 import codatcommon
 from codatcommon.models import shared

diff --git a/common/RELEASES.md b/common/RELEASES.md
@@ -566,4 +566,28 @@ Based on:
 - OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Common.yaml
 - Speakeasy CLI 1.53.0 (2.58.0) https://github.com/speakeasy-api/speakeasy
 ### Releases
-- [PyPI v0.31.1] https://pypi.org/project/codat-common/0.31.1 - common
+- [PyPI v0.31.1] https://pypi.org/project/codat-common/0.31.1 - common
+
+## 2023-07-13 00:21:39
+### Changes
+Based on:
+- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Common.yaml
+- Speakeasy CLI 1.57.0 (2.62.1) https://github.com/speakeasy-api/speakeasy
+### Releases
+- [PyPI v0.32.0] https://pypi.org/project/codat-common/0.32.0 - common
+
+## 2023-07-14 00:21:05
+### Changes
+Based on:
+- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Common.yaml
+- Speakeasy CLI 1.59.0 (2.65.0) https://github.com/speakeasy-api/speakeasy
+### Releases
+- [PyPI v0.33.0] https://pypi.org/project/codat-common/0.33.0 - common
+
+## 2023-07-14 17:36:10
+### Changes
+Based on:
+- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Common.yaml
+- Speakeasy CLI 1.59.0 (2.65.0) https://github.com/speakeasy-api/speakeasy
+### Releases
+- [PyPI v0.33.1] https://pypi.org/project/codat-common/0.33.1 - common
diff --git a/common/USAGE.md b/common/USAGE.md
@@ -1,4 +1,6 @@
 <!-- Start SDK Example Usage -->
+
+
 ```python
 import codatcommon
 from codatcommon.models import shared

diff --git a/common/docs/models/shared/createrule.md b/common/docs/models/shared/createrule.md
@@ -0,0 +1,12 @@
+# CreateRule
+
+Create an event notification to a URL or list of email addresses based on the given type or condition.
+
+
+## Fields
+
+| Field                                                             | Type                                                              | Required                                                          | Description                                                       | Example                                                           |
+| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
+| `company_id`                                                      | *Optional[str]*                                                   | :heavy_minus_sign:                                                | N/A                                                               | 39b73b17-cc2e-429e-915d-71654e9dcd1e                              |
+| `notifiers`                                                       | [CreateRuleNotifiers](../../models/shared/createrulenotifiers.md) | :heavy_check_mark:                                                | N/A                                                               |                                                                   |
+| `type`                                                            | *str*                                                             | :heavy_check_mark:                                                | N/A                                                               |                                                                   |
diff --git a/common/docs/models/shared/createrulenotifiers.md b/common/docs/models/shared/createrulenotifiers.md
@@ -0,0 +1,9 @@
+# CreateRuleNotifiers
+
+
+## Fields
+
+| Field                      | Type                       | Required                   | Description                | Example                    |
+| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -------------------------- |
+| `emails`                   | list[*str*]                | :heavy_minus_sign:         | N/A                        |                            |
+| `webhook`                  | *Optional[str]*            | :heavy_minus_sign:         | N/A                        | https://webhook.client.com |
diff --git a/common/docs/models/shared/rule.md b/common/docs/models/shared/rule.md
@@ -1,13 +1,13 @@
 # Rule
 
-Configuration to provide an event notification to a URL or list of email addresses based on the given type or condition.
+Create an event notification to a URL or list of email addresses based on the given type or condition.
 
 
 ## Fields
 
 | Field                                                 | Type                                                  | Required                                              | Description                                           | Example                                               |
 | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
 | `company_id`                                          | *Optional[str]*                                       | :heavy_minus_sign:                                    | N/A                                                   | 39b73b17-cc2e-429e-915d-71654e9dcd1e                  |
-| `id`                                                  | *str*                                                 | :heavy_check_mark:                                    | N/A                                                   | ff89c50e-a719-4ef5-a182-9917e53927b6                  |
+| `id`                                                  | *Optional[str]*                                       | :heavy_minus_sign:                                    | N/A                                                   | ff89c50e-a719-4ef5-a182-9917e53927b6                  |
 | `notifiers`                                           | [RuleNotifiers](../../models/shared/rulenotifiers.md) | :heavy_check_mark:                                    | N/A                                                   |                                                       |
 | `type`                                                | *str*                                                 | :heavy_check_mark:                                    | N/A                                                   |                                                       |
diff --git a/common/docs/sdks/companies/README.md b/common/docs/sdks/companies/README.md
@@ -65,7 +65,7 @@ Permanently deletes a company, its connections and any cached data. This operati
 
 ```python
 import codatcommon
-from codatcommon.models import operations
+from codatcommon.models import operations, shared
 
 s = codatcommon.CodatCommon(
     security=shared.Security(
@@ -104,7 +104,7 @@ if res.status_code == 200:
 
 ```python
 import codatcommon
-from codatcommon.models import operations
+from codatcommon.models import operations, shared
 
 s = codatcommon.CodatCommon(
     security=shared.Security(
@@ -143,7 +143,7 @@ if res.company is not None:
 
 ```python
 import codatcommon
-from codatcommon.models import operations
+from codatcommon.models import operations, shared
 
 s = codatcommon.CodatCommon(
     security=shared.Security(

diff --git a/common/docs/sdks/connections/README.md b/common/docs/sdks/connections/README.md
@@ -23,7 +23,7 @@ Use the [List Integrations](https://docs.codat.io/codat-api#/operations/list-int
 
 ```python
 import codatcommon
-from codatcommon.models import operations
+from codatcommon.models import operations, shared
 
 s = codatcommon.CodatCommon(
     security=shared.Security(
@@ -66,7 +66,7 @@ This operation is not reversible. The end user would need to reauthorize a new d
 
 ```python
 import codatcommon
-from codatcommon.models import operations
+from codatcommon.models import operations, shared
 
 s = codatcommon.CodatCommon(
     security=shared.Security(
@@ -106,7 +106,7 @@ if res.status_code == 200:
 
 ```python
 import codatcommon
-from codatcommon.models import operations
+from codatcommon.models import operations, shared
 
 s = codatcommon.CodatCommon(
     security=shared.Security(
@@ -146,7 +146,7 @@ if res.connection is not None:
 
 ```python
 import codatcommon
-from codatcommon.models import operations
+from codatcommon.models import operations, shared
 
 s = codatcommon.CodatCommon(
     security=shared.Security(
@@ -189,7 +189,7 @@ if res.connections is not None:
 
 ```python
 import codatcommon
-from codatcommon.models import operations
+from codatcommon.models import operations, shared
 
 s = codatcommon.CodatCommon(
     security=shared.Security(
@@ -232,7 +232,7 @@ Update data connection's authorization.
 
 ```python
 import codatcommon
-from codatcommon.models import operations
+from codatcommon.models import operations, shared
 
 s = codatcommon.CodatCommon(
     security=shared.Security(

diff --git a/common/docs/sdks/integrations/README.md b/common/docs/sdks/integrations/README.md
@@ -18,7 +18,7 @@ Get single integration, by platformKey
 
 ```python
 import codatcommon
-from codatcommon.models import operations
+from codatcommon.models import operations, shared
 
 s = codatcommon.CodatCommon(
     security=shared.Security(
@@ -57,7 +57,7 @@ Get branding for platform.
 
 ```python
 import codatcommon
-from codatcommon.models import operations
+from codatcommon.models import operations, shared
 
 s = codatcommon.CodatCommon(
     security=shared.Security(
@@ -96,7 +96,7 @@ List your available integrations
 
 ```python
 import codatcommon
-from codatcommon.models import operations
+from codatcommon.models import operations, shared
 
 s = codatcommon.CodatCommon(
     security=shared.Security(

diff --git a/common/docs/sdks/pushdata/README.md b/common/docs/sdks/pushdata/README.md
@@ -68,7 +68,7 @@ Retrieve push operation.
 
 ```python
 import codatcommon
-from codatcommon.models import operations
+from codatcommon.models import operations, shared
 
 s = codatcommon.CodatCommon(
     security=shared.Security(
@@ -108,7 +108,7 @@ List push operation records.
 
 ```python
 import codatcommon
-from codatcommon.models import operations
+from codatcommon.models import operations, shared
 
 s = codatcommon.CodatCommon(
     security=shared.Security(

diff --git a/common/docs/sdks/refreshdata/README.md b/common/docs/sdks/refreshdata/README.md
@@ -24,7 +24,7 @@ This is an asynchronous operation, and will bring updated data into Codat from t
 
 ```python
 import codatcommon
-from codatcommon.models import operations
+from codatcommon.models import operations, shared
 
 s = codatcommon.CodatCommon(
     security=shared.Security(
@@ -106,7 +106,7 @@ Get the state of each data type for a company
 
 ```python
 import codatcommon
-from codatcommon.models import operations
+from codatcommon.models import operations, shared
 
 s = codatcommon.CodatCommon(
     security=shared.Security(
@@ -145,7 +145,7 @@ Retrieve information about a single dataset or pull operation.
 
 ```python
 import codatcommon
-from codatcommon.models import operations
+from codatcommon.models import operations, shared
 
 s = codatcommon.CodatCommon(
     security=shared.Security(
@@ -185,7 +185,7 @@ Gets the pull operation history (datasets) for a given company.
 
 ```python
 import codatcommon
-from codatcommon.models import operations
+from codatcommon.models import operations, shared
 
 s = codatcommon.CodatCommon(
     security=shared.Security(

diff --git a/common/docs/sdks/settings/README.md b/common/docs/sdks/settings/README.md
@@ -21,7 +21,7 @@ Fetch your Codat profile.
 
 ```python
 import codatcommon
-
+from codatcommon.models import shared
 
 s = codatcommon.CodatCommon(
     security=shared.Security(
@@ -56,7 +56,7 @@ Retrieve the sync settings for your client. This includes how often data types s
 
 ```python
 import codatcommon
-
+from codatcommon.models import shared
 
 s = codatcommon.CodatCommon(
     security=shared.Security(

diff --git a/common/docs/sdks/supplementaldata/README.md b/common/docs/sdks/supplementaldata/README.md
@@ -80,7 +80,7 @@ The *Get configuration* endpoint returns supplemental data configuration previou
 
 ```python
 import codatcommon
-from codatcommon.models import operations
+from codatcommon.models import operations, shared
 
 s = codatcommon.CodatCommon(
     security=shared.Security(

diff --git a/common/docs/sdks/webhooks/README.md b/common/docs/sdks/webhooks/README.md
@@ -26,10 +26,9 @@ s = codatcommon.CodatCommon(
     ),
 )
 
-req = shared.Rule(
+req = shared.CreateRule(
     company_id='39b73b17-cc2e-429e-915d-71654e9dcd1e',
-    id='ff89c50e-a719-4ef5-a182-9917e53927b6',
-    notifiers=shared.RuleNotifiers(
+    notifiers=shared.CreateRuleNotifiers(
         emails=[
             '[email protected]',
             '[email protected]',
@@ -50,7 +49,7 @@ if res.rule is not None:
 
 | Parameter                                                           | Type                                                                | Required                                                            | Description                                                         |
 | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
-| `request`                                                           | [shared.Rule](../../models/shared/rule.md)                          | :heavy_check_mark:                                                  | The request object to use for the request.                          |
+| `request`                                                           | [shared.CreateRule](../../models/shared/createrule.md)              | :heavy_check_mark:                                                  | The request object to use for the request.                          |
 | `retries`                                                           | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md)    | :heavy_minus_sign:                                                  | Configuration to override the default retry behavior of the client. |
 
 
@@ -67,7 +66,7 @@ Get a single webhook
 
 ```python
 import codatcommon
-from codatcommon.models import operations
+from codatcommon.models import operations, shared
 
 s = codatcommon.CodatCommon(
     security=shared.Security(
@@ -106,7 +105,7 @@ List webhooks that you are subscribed to.
 
 ```python
 import codatcommon
-from codatcommon.models import operations
+from codatcommon.models import operations, shared
 
 s = codatcommon.CodatCommon(
     security=shared.Security(

diff --git a/common/files.gen b/common/files.gen
@@ -93,6 +93,7 @@ src/codatcommon/models/shared/syncsettings.py
 src/codatcommon/models/shared/syncsetting.py
 src/codatcommon/models/shared/supplementaldataconfiguration.py
 src/codatcommon/models/shared/rule.py
+src/codatcommon/models/shared/createrule.py
 src/codatcommon/models/shared/rules.py
 src/codatcommon/models/shared/security.py
 src/codatcommon/models/shared/companydataconnectionstatuschangedwebhook.py
@@ -234,6 +235,8 @@ docs/models/shared/supplementaldataconfigurationsupplementaldatasourceconfigurat
 docs/models/shared/supplementaldataconfiguration.md
 docs/models/shared/rulenotifiers.md
 docs/models/shared/rule.md
+docs/models/shared/createrulenotifiers.md
+docs/models/shared/createrule.md
 docs/models/shared/rules.md
 docs/models/shared/security.md
 docs/models/shared/companydataconnectionstatuschangedwebhookdata.md

diff --git a/common/gen.yaml b/common/gen.yaml
@@ -1,15 +1,15 @@
 configVersion: 1.0.0
 management:
-  docChecksum: 5a5f31fc5122be8cbb5952c4477cf930
+  docChecksum: 9d7c6aa08e1e5ceaa9cd30a987411bb2
   docVersion: 2.1.0
-  speakeasyVersion: 1.53.0
-  generationVersion: 2.58.0
+  speakeasyVersion: 1.59.0
+  generationVersion: 2.65.0
 generation:
   sdkClassName: CodatCommon
   singleTagPerOp: false
   telemetryEnabled: true
 python:
-  version: 0.31.1
+  version: 0.33.1
   author: Speakeasy
   description: Python Client SDK Generated by Speakeasy
   maxMethodParams: 0

diff --git a/common/setup.py b/common/setup.py
@@ -10,7 +10,7 @@
 
 setuptools.setup(
     name="codat-common",
-    version="0.31.1",
+    version="0.33.1",
     author="Speakeasy",
     description="Python Client SDK Generated by Speakeasy",
     long_description=long_description,

diff --git a/common/src/codatcommon/companies.py b/common/src/codatcommon/companies.py
@@ -16,7 +16,7 @@ def __init__(self, sdk_config: SDKConfiguration) -> None:
     def create(self, request: shared.CompanyRequestBody, retries: Optional[utils.RetryConfig] = None) -> operations.CreateCompanyResponse:
         r"""Create company
         Creates a new company that can be used to assign connections to. 
-        
+
         If forbidden characters (see `name` pattern) are present in the request, a company will be created with the forbidden characters removed. For example, `Company (Codat[1])` with be created as `Company Codat1`.
         """
         base_url = utils.template_url(*self.sdk_configuration.get_server_details())

diff --git a/common/src/codatcommon/connections.py b/common/src/codatcommon/connections.py
@@ -16,7 +16,7 @@ def __init__(self, sdk_config: SDKConfiguration) -> None:
     def create(self, request: operations.CreateDataConnectionRequest, retries: Optional[utils.RetryConfig] = None) -> operations.CreateDataConnectionResponse:
         r"""Create connection
         Creates a connection for the company by providing a valid `platformKey`. 
-        
+
         Use the [List Integrations](https://docs.codat.io/codat-api#/operations/list-integrations) endpoint to access valid platform keys.
         """
         base_url = utils.template_url(*self.sdk_configuration.get_server_details())

diff --git a/common/src/codatcommon/models/shared/__init__.py b/common/src/codatcommon/models/shared/__init__.py
@@ -11,6 +11,7 @@
 from .connection import *
 from .connections import *
 from .connectionstatus import *
+from .createrule import *
 from .dataconnectionerror import *
 from .dataconnectionhistory import *
 from .dataconnectionstatus import *
@@ -57,4 +58,4 @@
 from .validation import *
 from .validationitem import *
 
-__all__ = ["Branding","BrandingButton","BrandingImage","BrandingLogo","Companies","Company","CompanyDataConnectionStatusChangedWebhook","CompanyDataConnectionStatusChangedWebhookData","CompanyRequestBody","Connection","ConnectionStatus","Connections","DataConnectionError","DataConnectionHistory","DataConnectionStatus","DataStatus","DataSyncCompletedWebhook","DataSyncCompletedWebhookData","DataType","DataTypeFeature","DatasetDataChangedWebhook","DatasetDataChangedWebhookData","DatasetStatusChangedErrorWebhook","DatasetStatusChangedErrorWebhookData","ErrorMessage","FeatureState","FeatureType","HRef","ImageReference","Integration","Integrations","Links","NewCompanySynchronizedWebhook","Profile","PullOperation","PullOperationStatus","PushChangeType","PushFieldValidation","PushHistoryResponse","PushOperation","PushOperationChange","PushOperationRef","PushOperationStatus","PushOperationStatusChangedWebhook","PushOperationStatusChangedWebhookData","PushOperationSummary","PushOperationTimedOutWebhook","PushOperationTimedOutWebhookData","PushOption","PushOptionChoice","PushOptionProperty","PushOptionType","PushValidationInfo","Rule","RuleNotifiers","Rules","Security","SourceType","SupplementalDataConfiguration","SupplementalDataConfigurationSupplementalDataSourceConfiguration","SupportedFeature","SyncSetting","SyncSettingDataType","SyncSettings","Validation","ValidationItem"]
+__all__ = ["Branding","BrandingButton","BrandingImage","BrandingLogo","Companies","Company","CompanyDataConnectionStatusChangedWebhook","CompanyDataConnectionStatusChangedWebhookData","CompanyRequestBody","Connection","ConnectionStatus","Connections","CreateRule","CreateRuleNotifiers","DataConnectionError","DataConnectionHistory","DataConnectionStatus","DataStatus","DataSyncCompletedWebhook","DataSyncCompletedWebhookData","DataType","DataTypeFeature","DatasetDataChangedWebhook","DatasetDataChangedWebhookData","DatasetStatusChangedErrorWebhook","DatasetStatusChangedErrorWebhookData","ErrorMessage","FeatureState","FeatureType","HRef","ImageReference","Integration","Integrations","Links","NewCompanySynchronizedWebhook","Profile","PullOperation","PullOperationStatus","PushChangeType","PushFieldValidation","PushHistoryResponse","PushOperation","PushOperationChange","PushOperationRef","PushOperationStatus","PushOperationStatusChangedWebhook","PushOperationStatusChangedWebhookData","PushOperationSummary","PushOperationTimedOutWebhook","PushOperationTimedOutWebhookData","PushOption","PushOptionChoice","PushOptionProperty","PushOptionType","PushValidationInfo","Rule","RuleNotifiers","Rules","Security","SourceType","SupplementalDataConfiguration","SupplementalDataConfigurationSupplementalDataSourceConfiguration","SupportedFeature","SyncSetting","SyncSettingDataType","SyncSettings","Validation","ValidationItem"]