@seamapi/nextlove-sdk-generator 1.5.3 → 1.5.5

package/src/lib/generate-python-sdk/templates/.gitignore.template.ts

@@ -0,0 +1,11 @@
+export default () => `dist
+seamapi/utils/get_sentry_dsn.py
+.env
+__pycache__
+*/__pycache__
+node_modules
+
+.deeper
+.yalc
+yalc.lock
+`

package/src/lib/generate-python-sdk/templates/__init__.py.template.ts

@@ -0,0 +1,6 @@
+export default () => `# flake8: noqa
+# type: ignore
+
+from seamapi.seam import Seam
+from seamapi.seam import SeamApiException
+`

package/src/lib/generate-python-sdk/templates/conftest.py.template.ts

@@ -1,11 +1,80 @@
-export default () => `import pytest
-import random
+export default () => `import random
 import string
+import pytest
 from seamapi import Seam
+from dotenv import load_dotenv
+from typing import Any
+from dataclasses import dataclass
 
 
+@pytest.fixture(autouse=True)
+def dotenv_fixture():
+    load_dotenv()
+
+
+@dataclass
+class SeamBackend:
+    url: str
+    sandbox_api_key: str
+
+
+# TODO this should use scope="session", but there's some issue, this would
+# dramatically reduce test time to switch
 @pytest.fixture(scope="function")
-def seam():
-    r = ''.join(random.choices(string.ascii_uppercase + string.digits, k=10))
-    seam = Seam(api_url=f"https://{r}.fakeseamconnect.seam.vc", api_key="seam_apikey1_token")
-    yield seam`
+def seam_backend():
+    random_string = ''.join(random.choices(string.ascii_uppercase + string.digits, k=10))
+    yield SeamBackend(
+        url=f"https://{random_string}.fakeseamconnect.seam.vc",
+        sandbox_api_key="seam_apikey1_token",
+    )
+
+
+@pytest.fixture
+def seam(seam_backend: Any):
+    seam = Seam(api_url=seam_backend.url, api_key=seam_backend.sandbox_api_key)
+    # seam.make_request("POST", "/workspaces/reset_sandbox")
+    yield seam
+
+
+@pytest.fixture
+def fake_sentry(monkeypatch):
+    sentry_dsn = "https://key@sentry.io/123"
+
+    monkeypatch.setenv("SENTRY_DSN", sentry_dsn)
+
+    sentry_init_args = {}
+    sentry_capture_exception_calls = []
+    sentry_add_breadcrumb_calls = []
+
+    class TestSentryClient(object):
+        def __init__(self, *args, **kwargs):
+            sentry_init_args.update(kwargs)
+
+        def set_context(self, *args, **kwargs):
+            pass
+
+    monkeypatch.setattr("sentry_sdk.Client", TestSentryClient)
+
+    class TestSentryScope(object):
+        def set_context(self, *args, **kwargs):
+            pass
+
+    class TestSentryHub(object):
+        def __init__(self, *args, **kwargs):
+            self.scope = TestSentryScope()
+
+        def capture_exception(self, *args, **kwargs):
+            sentry_capture_exception_calls.append((args, kwargs))
+
+        def add_breadcrumb(self, *args, **kwargs):
+            sentry_add_breadcrumb_calls.append((args, kwargs))
+
+    monkeypatch.setattr("sentry_sdk.Hub", TestSentryHub)
+
+    yield {
+        "sentry_init_args": sentry_init_args,
+        "sentry_capture_exception_calls": sentry_capture_exception_calls,
+        "sentry_add_breadcrumb_calls": sentry_add_breadcrumb_calls,
+        "sentry_dsn": sentry_dsn,
+    }
+`

package/src/lib/generate-python-sdk/templates/prebuild.py.template.ts

@@ -0,0 +1,12 @@
+export default () => `import os
+
+value = os.environ.get("SENTRY_DSN", "None")
+if value != "None":
+  value = f'"{value}"'
+
+f = open("seamapi/utils/get_sentry_dsn.py", "w")
+f.write(f"""
+def get_sentry_dsn():
+  return {value}
+""")
+`

package/src/lib/generate-python-sdk/templates/pyproject.toml.template.ts

@@ -1,6 +1,6 @@
 export default () => `[tool.poetry]
 name = "seamapi"
-version = "2.14.0"
+version = "2.18.0"
 description = "A Python Library for Seam's API https://getseam.com"
 authors = ["Severin Ibarluzea <seveibar@gmail.com>"]
 license = "MIT"
@@ -8,13 +8,17 @@ license = "MIT"
 [tool.poetry.dependencies]
 python = "^3.7"
 requests = "^2.26.0"
+dataclasses-json = "^0.5.6"
+sentry-sdk = "^1.9.10"
 
 [tool.poetry.dev-dependencies]
 pytest = "^6.2.5"
 python-dotenv = "^0.19.2"
 black = "^21.12b0"
+testcontainers = {extras = ["postgresql"], version = "^3.4.2"}
 responses = "^0.22.0"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]
-build-backend = "poetry.core.masonry.api"`
+build-backend = "poetry.core.masonry.api"
+`

package/src/lib/generate-python-sdk/templates/seam.py.template.ts

@@ -1,19 +1,51 @@
 export default () => `import os
 
+from seamapi.utils.get_sentry_dsn import get_sentry_dsn
 from .routes import Routes
 import requests
-from importlib.metadata import version
+import sentry_sdk
+import pkg_resources
 from typing import Optional, cast
-from .types import AbstractSeam, SeamAPIException
+from .types import AbstractSeam, SeamApiException
 
 
 class Seam(AbstractSeam):
+    """
+    Initial Seam class used to interact with Seam API
+
+    ...
+
+    Attributes
+    ----------
+    api_key : str
+        API key (default None)
+    api_url : str
+        API url (default None)
+    workspaces : Workspaces
+        Workspaces class
+    connected_accounts : ConnectedAccounts
+        Connected accounts class
+    connect_webviews : ConnectWebviews
+        Connect webviews class
+    devices : Devices
+        Devices class
+    events : Events
+        Events class
+    locks : Locks
+        Locks class
+    access_codes : AccessCodes
+        Access codes class
+    action_attempts : ActionAttempts
+        Action attempts class
+    """
+
     api_key: str
     api_url: str = "https://connect.getseam.com"
 
     def __init__(
         self,
         api_key: Optional[str] = None,
+        workspace_id: Optional[str] = None,
         api_url: Optional[str] = None,
         should_report_exceptions: Optional[bool] = False,
     ):
@@ -22,8 +54,12 @@ class Seam(AbstractSeam):
         ----------
         api_key : str, optional
           API key
+        workspace_id : str, optional
+          Workspace id
         api_url : str, optional
           API url
+        should_report_exceptions : bool, optional
+          Defaults to False. If true, thrown exceptions will be reported to Seam.
         """
         Routes.__init__(self)
 
@@ -33,10 +69,34 @@ class Seam(AbstractSeam):
             raise Exception(
                 "SEAM_API_KEY not found in environment, and api_key not provided"
             )
-        if api_url is None:
-            api_url = os.environ.get("SEAM_API_URL", self.api_url)
+        if workspace_id is None:
+            workspace_id = os.environ.get("SEAM_WORKSPACE_ID", None)
         self.api_key = api_key
-        self.api_url = cast(str, api_url)
+        self.workspace_id = workspace_id
+        
+        if os.environ.get("SEAM_API_URL", None) is not None:
+          print(
+            '\\n'
+            '\\033[93m'
+            'Using the SEAM_API_URL environment variable is deprecated. '
+            'Support will be removed in a later major version. Use SEAM_ENDPOINT instead.'
+            '\\033[0m'
+          )
+        api_url = os.environ.get("SEAM_API_URL", None) or os.environ.get("SEAM_ENDPOINT", None) or api_url
+        if api_url is not None:
+            self.api_url = cast(str, api_url)
+
+        self.should_report_exceptions = should_report_exceptions
+
+        if self.should_report_exceptions:
+            self.sentry_client = sentry_sdk.Hub(sentry_sdk.Client(
+                dsn=get_sentry_dsn(),
+            ))
+            self.sentry_client.scope.set_context("sdk_info", {
+                "repository": "https://github.com/seamapi/python",
+                "version": pkg_resources.get_distribution("seamapi").version,
+                "endpoint": self.api_url,
+            })
 
     def make_request(self, method: str, path: str, **kwargs):
         """
@@ -53,21 +113,37 @@ class Seam(AbstractSeam):
         """
 
         url = self.api_url + path
+        sdk_version = pkg_resources.get_distribution("seamapi").version
         headers = {
             "Authorization": "Bearer " + self.api_key,
             "Content-Type": "application/json",
-            "User-Agent": "Python SDK v" + version("seamapi") + " (https://github.com/seamapi/python)",
+            "User-Agent": "Python SDK v" + sdk_version + " (https://github.com/seamapi/python)",
+            "seam-sdk-name": "seamapi/python",
+            "seam-sdk-version": sdk_version,
         }
+        if self.workspace_id is not None:
+            headers["seam-workspace"] = self.workspace_id
         response = requests.request(method, url, headers=headers, **kwargs)
 
-        parsed_response = response.json()
+        if self.should_report_exceptions and response.status_code:
+            # Add breadcrumb
+            self.sentry_client.add_breadcrumb(
+                category="http",
+                level="info",
+                data={
+                    "method": method,
+                    "url": url,
+                    "status_code": response.status_code,
+                    "request_id": response.headers.get("seam-request-id", "unknown"),
+                },
+            )
+
 
         if response.status_code != 200:
-            raise SeamAPIException(
-                response.status_code,
-                response.headers.get("seam-request-id", None),
-                parsed_response["error"],
-            )
-        ## TODO automatically paginate if kwargs["auto_paginate"] is True
+            raise SeamApiException(response)
+
+        if "application/json" in response.headers["content-type"]:
+            return response.json()
 
-        return parsed_response`
+        return response.text
+`

package/src/lib/generate-python-sdk/templates/snippets/abstract-seam.template.ts

@@ -1,8 +1,15 @@
 export default () => `@dataclass
 class AbstractSeam(AbstractRoutes):
-  api_key: str
-  api_url: str
+    api_key: str
+    workspace_id: str
+    api_url: str
 
-  @abc.abstractmethod
-  def __init__(self, api_key: Optional[str] = None):
-    raise NotImplementedError`
+    @abc.abstractmethod
+    def __init__(
+        self,
+        api_key: Optional[str] = None,
+        workspace_id: Optional[str] = None,
+        api_url: Optional[str] = None,
+        should_report_exceptions: Optional[bool] = False,
+    ):
+        raise NotImplementedError`

package/src/lib/generate-python-sdk/templates/snippets/resource-dataclass.template.ts

@@ -11,5 +11,13 @@ ${parameters.map((p) => `  ${p.name}: ${p.type}`).join("\n")}
   @staticmethod
   def from_dict(d: Dict[str, Any]):
     return ${name}(
-${parameters.map((p) => `      ${p.name}=d.get("${p.name}", None),`).join("\n")}
+${parameters
+  .map((p) => {
+    const is_dict_param = p.type.startsWith("Dict") || p.name === "properties"
+
+    return `      ${p.name}=${is_dict_param ? "DeepAttrDict(" : ""}d.get("${
+      p.name
+    }", None)${is_dict_param ? ")" : ""},`
+  })
+  .join("\n")}
       )`

package/src/lib/generate-python-sdk/templates/snippets/seam-api-exception-class.template.ts

@@ -0,0 +1,16 @@
+export default () => `class SeamApiException(Exception):
+  def __init__(
+      self,
+      response,
+  ):
+      self.status_code = response.status_code
+      self.request_id = response.headers.get("seam-request-id", None)
+
+      self.metadata = None
+      if "application/json" in response.headers["content-type"]:
+          parsed_response = response.json()
+          self.metadata = parsed_response.get("error", None)
+
+      super().__init__(
+          f"SeamApiException: status={self.status_code}, request_id={self.request_id}, metadata={self.metadata}"
+      )`

package/src/lib/generate-python-sdk/templates/utils/get_sentry_dsn.py.template.ts

@@ -0,0 +1,5 @@
+export default () => `import os
+
+def get_sentry_dsn():
+  # This is replaced with a hard-coded value during the build process (see scripts/prebuild.py)
+  return os.environ.get("SENTRY_DSN", None)`

package/src/lib/generate-python-sdk/templates/utils/report_error.py.template.ts

@@ -0,0 +1,16 @@
+export default () => `from seamapi.types import SeamApiException
+
+"""
+A decorator for model methods that will report errors to Sentry (if enabled).
+Expects that the model has a \`seam\` attribute that is a \`Seam\` instance.
+"""
+def report_error(f):
+  def wrapper(self, *args, **kwargs):
+    try:
+      return f(self, *args, **kwargs)
+    except Exception as error:
+      if self.seam.should_report_exceptions and type(error) is not SeamApiException:
+        self.seam.sentry_client.capture_exception(error)
+
+      raise error
+  return wrapper`

package/src/lib/openapi/flatten-obj-schema.ts

@@ -14,6 +14,9 @@ export const flattenObjSchema = (
     | {
         oneOf: Array<ObjSchema>
       }
+    | {
+        allOf: Array<ObjSchema>
+      }
 ): ObjSchema => {
   if ("type" in s && s.type === "object") return s
 
@@ -39,6 +42,11 @@ export const flattenObjSchema = (
     }
     return super_obj as ObjSchema
   }
+
+  if ("allOf" in s) {
+    return deepFlattenAllOfSchema(s) as ObjSchema
+  }
+
   throw new Error(`Unknown schema type "${s.type}"`)
 }
 

package/src/lib/openapi/get-parameter-and-response-schema.ts

@@ -44,16 +44,13 @@ export const getParameterAndResponseSchema = (route: Route) => {
       parameter_schema,
       nullable,
     }
-  }
-
-  const response_obj_type = response_obj_ref?.split("/")?.pop()!
-  const response_arr_type = response_arr_ref?.split("/")?.pop()!
-
-  return {
-    response_obj_type,
-    response_arr_type,
-    parameter_schema,
-    res_return_schema: res_return_schema as ObjSchema | undefined,
-    nullable,
+  } else {
+    return {
+      response_obj_type: response_obj_ref?.split("/")?.pop(),
+      response_arr_type: response_arr_ref?.split("/")?.pop(),
+      parameter_schema,
+      res_return_schema: res_return_schema as ObjSchema | undefined,
+      nullable,
+    }
   }
 }

package/src/lib/openapi/map-parent-to-children-resource.ts

@@ -0,0 +1,28 @@
+import type { Route } from "lib/types.js"
+
+const mapParentToChildrenResources = (
+  routes: Route[]
+): Record<string, string[]> =>
+  routes.reduce((acc: Record<string, string[]>, route) => {
+    if (!route.post?.["x-fern-sdk-group-name"]) return acc
+
+    const [parent_resource_name, child_resource_name] =
+      route.post["x-fern-sdk-group-name"]
+
+    if (!parent_resource_name) return acc
+
+    if (!acc[parent_resource_name]) {
+      acc[parent_resource_name] = []
+    }
+
+    if (
+      child_resource_name &&
+      !acc[parent_resource_name]!.includes(child_resource_name)
+    ) {
+      acc[parent_resource_name]!.push(child_resource_name)
+    }
+
+    return acc
+  }, {})
+
+export default mapParentToChildrenResources