fix: format

apideck-libraries · Dec 10, 2024 · a907df9 · a907df9
1 parent 31028be
commit a907df9
Show file tree

Hide file tree

Showing 91 changed files with 799 additions and 732 deletions.
diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
diff --git a/.speakeasy/overlay-spec.yaml b/.speakeasy/overlay-spec.yaml
@@ -0,0 +1,8 @@
+overlay: 1.0.0
+info:
+  title: Format Parameter Name Update
+  version: 0.0.1
+actions:
+  - target: $["components"]["parameters"]["format"]
+    update:
+      name: file_format
diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -1,33 +1,38 @@
-speakeasyVersion: 1.453.0
+speakeasyVersion: 1.453.8
 sources:
     Apideck:
         sourceNamespace: apideck
-        sourceRevisionDigest: sha256:bd31296f2b3ce64ae294b0e2921db4689f713fe0896e51a38dcaded2676414e6
-        sourceBlobDigest: sha256:c78223a6f6e3fb5b1d9f0d663d8bd72bf35ecc3ed8435dd81561c45569a9f642
+        sourceRevisionDigest: sha256:4370f91648df925a9cd5ee51f82e76448642303ca9fde1ea6aadf656bfe5694e
+        sourceBlobDigest: sha256:19939b73f05d1c30fba2779c43866e9c4d163b4e97a074b3a8961a34e04e5e8f
         tags:
             - latest
             - 10.8.3
 targets:
     apideck:
         source: Apideck
         sourceNamespace: apideck
-        sourceRevisionDigest: sha256:bd31296f2b3ce64ae294b0e2921db4689f713fe0896e51a38dcaded2676414e6
-        sourceBlobDigest: sha256:c78223a6f6e3fb5b1d9f0d663d8bd72bf35ecc3ed8435dd81561c45569a9f642
+        sourceRevisionDigest: sha256:4370f91648df925a9cd5ee51f82e76448642303ca9fde1ea6aadf656bfe5694e
+        sourceBlobDigest: sha256:19939b73f05d1c30fba2779c43866e9c4d163b4e97a074b3a8961a34e04e5e8f
         codeSamplesNamespace: apideck-python-code-samples
-        codeSamplesRevisionDigest: sha256:9f12e8cc9d69d0ea4cbbd760a992e82f7a19a4744f9376bbfab9ea2b6843587c
+        codeSamplesRevisionDigest: sha256:3e9b2e781657df8ba931972b4537cab054eedda9568491c6d850f139a1b9c52b
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest
     sources:
         Apideck:
             inputs:
                 - location: https://ci-spec-unify.s3.eu-central-1.amazonaws.com/speakeasy-spec.yml
+            overlays:
+                - location: ./.speakeasy/overlay-spec.yaml
             registry:
                 location: registry.speakeasyapi.dev/apideck-k2o/apideck/apideck
     targets:
         apideck:
             target: python
             source: Apideck
+            publish:
+                pypi:
+                    token: $pypi_token
             codeSamples:
                 registry:
                     location: registry.speakeasyapi.dev/apideck-k2o/apideck/apideck-python-code-samples

diff --git a/.speakeasy/workflow.yaml b/.speakeasy/workflow.yaml
@@ -4,6 +4,8 @@ sources:
     Apideck:
         inputs:
             - location: https://ci-spec-unify.s3.eu-central-1.amazonaws.com/speakeasy-spec.yml
+        overlays:
+            - location: ./.speakeasy/overlay-spec.yaml
         registry:
             location: registry.speakeasyapi.dev/apideck-k2o/apideck/apideck
 targets:

diff --git a/README.md b/README.md
@@ -52,15 +52,15 @@ The SDK can be installed with either *pip* or *poetry* package managers.
 *PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
 
 ```bash
-pip install git+<UNSET>.git
+pip install apideck-unify
 ```
 
 ### Poetry
 
 *Poetry* is a modern tool that simplifies dependency management and package publishing by using a single `pyproject.toml` file to handle project metadata and dependencies.
 
 ```bash
-poetry add git+<UNSET>.git
+poetry add apideck-unify
 ```
 <!-- End SDK Installation [installation] -->
 
@@ -88,8 +88,8 @@ with Apideck(
     api_key=os.getenv("APIDECK_API_KEY", ""),
     consumer_id="test-consumer",
     app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
-) as s:
-    res = s.accounting.tax_rates.list(request={
+) as apideck:
+    res = apideck.accounting.tax_rates.list(request={
         "service_id": "salesforce",
         "filter_": {
             "assets": True,
@@ -123,8 +123,8 @@ async def main():
         api_key=os.getenv("APIDECK_API_KEY", ""),
         consumer_id="test-consumer",
         app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
-    ) as s:
-        res = await s.accounting.tax_rates.list_async(request={
+    ) as apideck:
+        res = await apideck.accounting.tax_rates.list_async(request={
             "service_id": "salesforce",
             "filter_": {
                 "assets": True,
@@ -167,8 +167,8 @@ with Apideck(
     api_key=os.getenv("APIDECK_API_KEY", ""),
     consumer_id="test-consumer",
     app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
-) as s:
-    res = s.accounting.tax_rates.list(request={
+) as apideck:
+    res = apideck.accounting.tax_rates.list(request={
         "service_id": "salesforce",
         "filter_": {
             "assets": True,
@@ -724,16 +724,16 @@ Some of the endpoints in this SDK support retries. If you use the SDK without an
 
 To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
 ```python
-from apideck.utils import BackoffStrategy, RetryConfig
 from apideck_unify import Apideck
+from apideck_unify.utils import BackoffStrategy, RetryConfig
 import os
 
 with Apideck(
     api_key=os.getenv("APIDECK_API_KEY", ""),
     consumer_id="test-consumer",
     app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
-) as s:
-    res = s.accounting.tax_rates.list(request={
+) as apideck:
+    res = apideck.accounting.tax_rates.list(request={
         "service_id": "salesforce",
         "filter_": {
             "assets": True,
@@ -757,17 +757,17 @@ with Apideck(
 
 If you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK:
 ```python
-from apideck.utils import BackoffStrategy, RetryConfig
 from apideck_unify import Apideck
+from apideck_unify.utils import BackoffStrategy, RetryConfig
 import os
 
 with Apideck(
     retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
     api_key=os.getenv("APIDECK_API_KEY", ""),
     consumer_id="test-consumer",
     app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
-) as s:
-    res = s.accounting.tax_rates.list(request={
+) as apideck:
+    res = apideck.accounting.tax_rates.list(request={
         "service_id": "salesforce",
         "filter_": {
             "assets": True,
@@ -824,10 +824,10 @@ with Apideck(
     api_key=os.getenv("APIDECK_API_KEY", ""),
     consumer_id="test-consumer",
     app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
-) as s:
+) as apideck:
     res = None
     try:
-        res = s.accounting.tax_rates.list(request={
+        res = apideck.accounting.tax_rates.list(request={
             "service_id": "salesforce",
             "filter_": {
                 "assets": True,
@@ -882,8 +882,8 @@ with Apideck(
     api_key=os.getenv("APIDECK_API_KEY", ""),
     consumer_id="test-consumer",
     app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
-) as s:
-    res = s.accounting.tax_rates.list(request={
+) as apideck:
+    res = apideck.accounting.tax_rates.list(request={
         "service_id": "salesforce",
         "filter_": {
             "assets": True,
@@ -915,8 +915,8 @@ with Apideck(
     api_key=os.getenv("APIDECK_API_KEY", ""),
     consumer_id="test-consumer",
     app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
-) as s:
-    res = s.file_storage.upload_sessions.create(create_upload_session_request={
+) as apideck:
+    res = apideck.file_storage.upload_sessions.create(create_upload_session_request={
         "name": "Documents",
         "parent_folder_id": "1234",
         "size": 1810673,

diff --git a/USAGE.md b/USAGE.md
@@ -8,8 +8,8 @@ with Apideck(
     api_key=os.getenv("APIDECK_API_KEY", ""),
     consumer_id="test-consumer",
     app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
-) as s:
-    res = s.accounting.tax_rates.list(request={
+) as apideck:
+    res = apideck.accounting.tax_rates.list(request={
         "service_id": "salesforce",
         "filter_": {
             "assets": True,
@@ -43,8 +43,8 @@ async def main():
         api_key=os.getenv("APIDECK_API_KEY", ""),
         consumer_id="test-consumer",
         app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
-    ) as s:
-        res = await s.accounting.tax_rates.list_async(request={
+    ) as apideck:
+        res = await apideck.accounting.tax_rates.list_async(request={
             "service_id": "salesforce",
             "filter_": {
                 "assets": True,

diff --git a/docs/models/connectordoc.md b/docs/models/connectordoc.md
@@ -8,5 +8,5 @@
 | `id`                                                                            | *Optional[str]*                                                                 | :heavy_minus_sign:                                                              | A unique identifier for an object.                                              | 12345                                                                           |
 | `name`                                                                          | *Optional[str]*                                                                 | :heavy_minus_sign:                                                              | Name of the doc.                                                                | connection                                                                      |
 | `audience`                                                                      | [Optional[models.Audience]](../models/audience.md)                              | :heavy_minus_sign:                                                              | Audience for the doc.                                                           |                                                                                 |
-| `format`                                                                        | [Optional[models.Format]](../models/format.md)                                  | :heavy_minus_sign:                                                              | Format of the doc.                                                              |                                                                                 |
+| `format_`                                                                       | [Optional[models.Format]](../models/format_.md)                                 | :heavy_minus_sign:                                                              | Format of the doc.                                                              |                                                                                 |
 | `url`                                                                           | *Optional[str]*                                                                 | :heavy_minus_sign:                                                              | Link to fetch the content of the doc.                                           | https://unify.apideck.com/connector/connectors/workday/docs/consumer+connection |