permitstack 1.0.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (68) hide show
  1. permitstack/__init__.py +17 -0
  2. permitstack/_hooks/__init__.py +4 -0
  3. permitstack/_hooks/sdkhooks.py +74 -0
  4. permitstack/_hooks/types.py +112 -0
  5. permitstack/_version.py +15 -0
  6. permitstack/basesdk.py +396 -0
  7. permitstack/bulk_export.py +241 -0
  8. permitstack/contractors.py +625 -0
  9. permitstack/errors/__init__.py +39 -0
  10. permitstack/errors/httpvalidationerror.py +28 -0
  11. permitstack/errors/no_response_error.py +17 -0
  12. permitstack/errors/permitstackdefaulterror.py +40 -0
  13. permitstack/errors/permitstackerror.py +30 -0
  14. permitstack/errors/responsevalidationerror.py +27 -0
  15. permitstack/health.py +171 -0
  16. permitstack/httpclient.py +125 -0
  17. permitstack/models/__init__.py +158 -0
  18. permitstack/models/contractorprofile.py +108 -0
  19. permitstack/models/contractorsearchresponse.py +24 -0
  20. permitstack/models/contractorsummary.py +57 -0
  21. permitstack/models/delete_webhookop.py +16 -0
  22. permitstack/models/export_permits_csvop.py +98 -0
  23. permitstack/models/get_contractor_permitsop.py +46 -0
  24. permitstack/models/get_contractorop.py +16 -0
  25. permitstack/models/get_permitop.py +16 -0
  26. permitstack/models/get_permits_by_addressop.py +46 -0
  27. permitstack/models/get_property_historyop.py +18 -0
  28. permitstack/models/permitcategory.py +27 -0
  29. permitstack/models/permitdetail.py +164 -0
  30. permitstack/models/permitsearchresponse.py +24 -0
  31. permitstack/models/permitstatus.py +16 -0
  32. permitstack/models/permitsummary.py +121 -0
  33. permitstack/models/propertytype.py +14 -0
  34. permitstack/models/search_contractorsop.py +98 -0
  35. permitstack/models/search_permitsop.py +247 -0
  36. permitstack/models/security.py +42 -0
  37. permitstack/models/validationerror.py +57 -0
  38. permitstack/models/webhookcreate.py +60 -0
  39. permitstack/permits.py +866 -0
  40. permitstack/property_history.py +207 -0
  41. permitstack/py.typed +1 -0
  42. permitstack/sdk.py +218 -0
  43. permitstack/sdkconfiguration.py +49 -0
  44. permitstack/types/__init__.py +21 -0
  45. permitstack/types/basemodel.py +77 -0
  46. permitstack/utils/__init__.py +178 -0
  47. permitstack/utils/annotations.py +79 -0
  48. permitstack/utils/datetimes.py +23 -0
  49. permitstack/utils/dynamic_imports.py +54 -0
  50. permitstack/utils/enums.py +134 -0
  51. permitstack/utils/eventstreaming.py +309 -0
  52. permitstack/utils/forms.py +234 -0
  53. permitstack/utils/headers.py +136 -0
  54. permitstack/utils/logger.py +27 -0
  55. permitstack/utils/metadata.py +119 -0
  56. permitstack/utils/queryparams.py +217 -0
  57. permitstack/utils/requestbodies.py +66 -0
  58. permitstack/utils/retries.py +271 -0
  59. permitstack/utils/security.py +215 -0
  60. permitstack/utils/serializers.py +225 -0
  61. permitstack/utils/unmarshal_json_response.py +38 -0
  62. permitstack/utils/url.py +155 -0
  63. permitstack/utils/values.py +137 -0
  64. permitstack/webhooks.py +593 -0
  65. permitstack-1.0.0.dist-info/METADATA +541 -0
  66. permitstack-1.0.0.dist-info/RECORD +68 -0
  67. permitstack-1.0.0.dist-info/WHEEL +5 -0
  68. permitstack-1.0.0.dist-info/top_level.txt +1 -0
@@ -0,0 +1,178 @@
1
+ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
+
3
+ from typing import Any, TYPE_CHECKING, Callable, TypeVar
4
+ import asyncio
5
+
6
+ from .dynamic_imports import lazy_getattr, lazy_dir
7
+
8
+ _T = TypeVar("_T")
9
+
10
+
11
+ async def run_sync_in_thread(func: Callable[..., _T], *args) -> _T:
12
+ """Run a synchronous function in a thread pool to avoid blocking the event loop."""
13
+ return await asyncio.to_thread(func, *args)
14
+
15
+
16
+ if TYPE_CHECKING:
17
+ from .annotations import get_discriminator
18
+ from .datetimes import parse_datetime
19
+ from .enums import OpenEnumMeta
20
+ from .headers import get_headers, get_response_headers
21
+ from .metadata import (
22
+ FieldMetadata,
23
+ find_metadata,
24
+ FormMetadata,
25
+ HeaderMetadata,
26
+ MultipartFormMetadata,
27
+ PathParamMetadata,
28
+ QueryParamMetadata,
29
+ RequestMetadata,
30
+ SecurityMetadata,
31
+ )
32
+ from .queryparams import get_query_params
33
+ from .retries import BackoffStrategy, Retries, retry, retry_async, RetryConfig
34
+ from .requestbodies import serialize_request_body, SerializedRequestBody
35
+ from .security import get_security, get_security_from_env
36
+
37
+ from .serializers import (
38
+ get_pydantic_model,
39
+ marshal_json,
40
+ unmarshal,
41
+ unmarshal_json,
42
+ serialize_decimal,
43
+ serialize_float,
44
+ serialize_int,
45
+ stream_to_text,
46
+ stream_to_text_async,
47
+ stream_to_bytes,
48
+ stream_to_bytes_async,
49
+ validate_const,
50
+ validate_decimal,
51
+ validate_float,
52
+ validate_int,
53
+ )
54
+ from .url import generate_url, template_url, remove_suffix
55
+ from .values import (
56
+ get_global_from_env,
57
+ match_content_type,
58
+ match_status_codes,
59
+ match_response,
60
+ cast_partial,
61
+ )
62
+ from .logger import Logger, get_body_content, get_default_logger
63
+
64
+ __all__ = [
65
+ "BackoffStrategy",
66
+ "FieldMetadata",
67
+ "find_metadata",
68
+ "FormMetadata",
69
+ "generate_url",
70
+ "get_body_content",
71
+ "get_default_logger",
72
+ "get_discriminator",
73
+ "parse_datetime",
74
+ "get_global_from_env",
75
+ "get_headers",
76
+ "get_pydantic_model",
77
+ "get_query_params",
78
+ "get_response_headers",
79
+ "get_security",
80
+ "get_security_from_env",
81
+ "HeaderMetadata",
82
+ "Logger",
83
+ "marshal_json",
84
+ "match_content_type",
85
+ "match_status_codes",
86
+ "match_response",
87
+ "MultipartFormMetadata",
88
+ "OpenEnumMeta",
89
+ "PathParamMetadata",
90
+ "QueryParamMetadata",
91
+ "remove_suffix",
92
+ "Retries",
93
+ "retry",
94
+ "retry_async",
95
+ "RetryConfig",
96
+ "RequestMetadata",
97
+ "SecurityMetadata",
98
+ "serialize_decimal",
99
+ "serialize_float",
100
+ "serialize_int",
101
+ "serialize_request_body",
102
+ "SerializedRequestBody",
103
+ "stream_to_text",
104
+ "stream_to_text_async",
105
+ "stream_to_bytes",
106
+ "stream_to_bytes_async",
107
+ "template_url",
108
+ "unmarshal",
109
+ "unmarshal_json",
110
+ "validate_decimal",
111
+ "validate_const",
112
+ "validate_float",
113
+ "validate_int",
114
+ "cast_partial",
115
+ ]
116
+
117
+ _dynamic_imports: dict[str, str] = {
118
+ "BackoffStrategy": ".retries",
119
+ "FieldMetadata": ".metadata",
120
+ "find_metadata": ".metadata",
121
+ "FormMetadata": ".metadata",
122
+ "generate_url": ".url",
123
+ "get_body_content": ".logger",
124
+ "get_default_logger": ".logger",
125
+ "get_discriminator": ".annotations",
126
+ "parse_datetime": ".datetimes",
127
+ "get_global_from_env": ".values",
128
+ "get_headers": ".headers",
129
+ "get_pydantic_model": ".serializers",
130
+ "get_query_params": ".queryparams",
131
+ "get_response_headers": ".headers",
132
+ "get_security": ".security",
133
+ "get_security_from_env": ".security",
134
+ "HeaderMetadata": ".metadata",
135
+ "Logger": ".logger",
136
+ "marshal_json": ".serializers",
137
+ "match_content_type": ".values",
138
+ "match_status_codes": ".values",
139
+ "match_response": ".values",
140
+ "MultipartFormMetadata": ".metadata",
141
+ "OpenEnumMeta": ".enums",
142
+ "PathParamMetadata": ".metadata",
143
+ "QueryParamMetadata": ".metadata",
144
+ "remove_suffix": ".url",
145
+ "Retries": ".retries",
146
+ "retry": ".retries",
147
+ "retry_async": ".retries",
148
+ "RetryConfig": ".retries",
149
+ "RequestMetadata": ".metadata",
150
+ "SecurityMetadata": ".metadata",
151
+ "serialize_decimal": ".serializers",
152
+ "serialize_float": ".serializers",
153
+ "serialize_int": ".serializers",
154
+ "serialize_request_body": ".requestbodies",
155
+ "SerializedRequestBody": ".requestbodies",
156
+ "stream_to_text": ".serializers",
157
+ "stream_to_text_async": ".serializers",
158
+ "stream_to_bytes": ".serializers",
159
+ "stream_to_bytes_async": ".serializers",
160
+ "template_url": ".url",
161
+ "unmarshal": ".serializers",
162
+ "unmarshal_json": ".serializers",
163
+ "validate_decimal": ".serializers",
164
+ "validate_const": ".serializers",
165
+ "validate_float": ".serializers",
166
+ "validate_int": ".serializers",
167
+ "cast_partial": ".values",
168
+ }
169
+
170
+
171
+ def __getattr__(attr_name: str) -> Any:
172
+ return lazy_getattr(
173
+ attr_name, package=__package__, dynamic_imports=_dynamic_imports
174
+ )
175
+
176
+
177
+ def __dir__():
178
+ return lazy_dir(dynamic_imports=_dynamic_imports)
@@ -0,0 +1,79 @@
1
+ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
+
3
+ from enum import Enum
4
+ from typing import Any, Optional
5
+
6
+
7
+ def get_discriminator(model: Any, fieldname: str, key: str) -> str:
8
+ """
9
+ Recursively search for the discriminator attribute in a model.
10
+
11
+ Args:
12
+ model (Any): The model to search within.
13
+ fieldname (str): The name of the field to search for.
14
+ key (str): The key to search for in dictionaries.
15
+
16
+ Returns:
17
+ str: The name of the discriminator attribute.
18
+
19
+ Raises:
20
+ ValueError: If the discriminator attribute is not found.
21
+ """
22
+ upper_fieldname = fieldname.upper()
23
+
24
+ def get_field_discriminator(field: Any) -> Optional[str]:
25
+ """Search for the discriminator attribute in a given field."""
26
+
27
+ if isinstance(field, dict):
28
+ if key in field:
29
+ return f"{field[key]}"
30
+
31
+ if hasattr(field, fieldname):
32
+ attr = getattr(field, fieldname)
33
+ if isinstance(attr, Enum):
34
+ return f"{attr.value}"
35
+ return f"{attr}"
36
+
37
+ if hasattr(field, upper_fieldname):
38
+ attr = getattr(field, upper_fieldname)
39
+ if isinstance(attr, Enum):
40
+ return f"{attr.value}"
41
+ return f"{attr}"
42
+
43
+ return None
44
+
45
+ def search_nested_discriminator(obj: Any) -> Optional[str]:
46
+ """Recursively search for discriminator in nested structures."""
47
+ # First try direct field lookup
48
+ discriminator = get_field_discriminator(obj)
49
+ if discriminator is not None:
50
+ return discriminator
51
+
52
+ # If it's a dict, search in nested values
53
+ if isinstance(obj, dict):
54
+ for value in obj.values():
55
+ if isinstance(value, list):
56
+ # Search in list items
57
+ for item in value:
58
+ nested_discriminator = search_nested_discriminator(item)
59
+ if nested_discriminator is not None:
60
+ return nested_discriminator
61
+ elif isinstance(value, dict):
62
+ # Search in nested dict
63
+ nested_discriminator = search_nested_discriminator(value)
64
+ if nested_discriminator is not None:
65
+ return nested_discriminator
66
+
67
+ return None
68
+
69
+ if isinstance(model, list):
70
+ for field in model:
71
+ discriminator = search_nested_discriminator(field)
72
+ if discriminator is not None:
73
+ return discriminator
74
+
75
+ discriminator = search_nested_discriminator(model)
76
+ if discriminator is not None:
77
+ return discriminator
78
+
79
+ raise ValueError(f"Could not find discriminator field {fieldname} in {model}")
@@ -0,0 +1,23 @@
1
+ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
+
3
+ from datetime import datetime
4
+ import sys
5
+
6
+
7
+ def parse_datetime(datetime_string: str) -> datetime:
8
+ """
9
+ Convert a RFC 3339 / ISO 8601 formatted string into a datetime object.
10
+ Python versions 3.11 and later support parsing RFC 3339 directly with
11
+ datetime.fromisoformat(), but for earlier versions, this function
12
+ encapsulates the necessary extra logic.
13
+ """
14
+ # Python 3.11 and later can parse RFC 3339 directly
15
+ if sys.version_info >= (3, 11):
16
+ return datetime.fromisoformat(datetime_string)
17
+
18
+ # For Python 3.10 and earlier, a common ValueError is trailing 'Z' suffix,
19
+ # so fix that upfront.
20
+ if datetime_string.endswith("Z"):
21
+ datetime_string = datetime_string[:-1] + "+00:00"
22
+
23
+ return datetime.fromisoformat(datetime_string)
@@ -0,0 +1,54 @@
1
+ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
+
3
+ from importlib import import_module
4
+ import builtins
5
+ import sys
6
+
7
+
8
+ def dynamic_import(package, modname, retries=3):
9
+ """Import a module relative to package, retrying on KeyError from half-initialized modules."""
10
+ for attempt in range(retries):
11
+ try:
12
+ return import_module(modname, package)
13
+ except KeyError:
14
+ sys.modules.pop(modname, None)
15
+ if attempt == retries - 1:
16
+ break
17
+ raise KeyError(f"Failed to import module '{modname}' after {retries} attempts")
18
+
19
+
20
+ def lazy_getattr(attr_name, *, package, dynamic_imports, sub_packages=None):
21
+ """Module-level __getattr__ that lazily loads from a dynamic_imports mapping.
22
+
23
+ Args:
24
+ attr_name: The attribute being looked up.
25
+ package: The caller's __package__ (for relative imports).
26
+ dynamic_imports: Dict mapping attribute names to relative module paths.
27
+ sub_packages: Optional list of subpackage names to lazy-load.
28
+ """
29
+ module_name = dynamic_imports.get(attr_name)
30
+ if module_name is not None:
31
+ try:
32
+ module = dynamic_import(package, module_name)
33
+ return getattr(module, attr_name)
34
+ except ImportError as e:
35
+ raise ImportError(
36
+ f"Failed to import {attr_name} from {module_name}: {e}"
37
+ ) from e
38
+ except AttributeError as e:
39
+ raise AttributeError(
40
+ f"Failed to get {attr_name} from {module_name}: {e}"
41
+ ) from e
42
+
43
+ if sub_packages and attr_name in sub_packages:
44
+ return import_module(f".{attr_name}", package)
45
+
46
+ raise AttributeError(f"module '{package}' has no attribute '{attr_name}'")
47
+
48
+
49
+ def lazy_dir(*, dynamic_imports, sub_packages=None):
50
+ """Module-level __dir__ that lists lazily-loadable attributes."""
51
+ lazy_attrs = builtins.list(dynamic_imports.keys())
52
+ if sub_packages:
53
+ lazy_attrs.extend(sub_packages)
54
+ return builtins.sorted(lazy_attrs)
@@ -0,0 +1,134 @@
1
+ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
+
3
+ import enum
4
+ import sys
5
+ from typing import Any
6
+
7
+ from pydantic_core import core_schema
8
+
9
+
10
+ class OpenEnumMeta(enum.EnumMeta):
11
+ # The __call__ method `boundary` kwarg was added in 3.11 and must be present
12
+ # for pyright. Refer also: https://github.com/pylint-dev/pylint/issues/9622
13
+ # pylint: disable=unexpected-keyword-arg
14
+ # The __call__ method `values` varg must be named for pyright.
15
+ # pylint: disable=keyword-arg-before-vararg
16
+
17
+ if sys.version_info >= (3, 11):
18
+ def __call__(
19
+ cls, value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None
20
+ ):
21
+ # The `type` kwarg also happens to be a built-in that pylint flags as
22
+ # redeclared. Safe to ignore this lint rule with this scope.
23
+ # pylint: disable=redefined-builtin
24
+
25
+ if names is not None:
26
+ return super().__call__(
27
+ value,
28
+ names=names,
29
+ *values,
30
+ module=module,
31
+ qualname=qualname,
32
+ type=type,
33
+ start=start,
34
+ boundary=boundary,
35
+ )
36
+
37
+ try:
38
+ return super().__call__(
39
+ value,
40
+ names=names, # pyright: ignore[reportArgumentType]
41
+ *values,
42
+ module=module,
43
+ qualname=qualname,
44
+ type=type,
45
+ start=start,
46
+ boundary=boundary,
47
+ )
48
+ except ValueError:
49
+ return value
50
+ else:
51
+ def __call__(
52
+ cls, value, names=None, *, module=None, qualname=None, type=None, start=1
53
+ ):
54
+ # The `type` kwarg also happens to be a built-in that pylint flags as
55
+ # redeclared. Safe to ignore this lint rule with this scope.
56
+ # pylint: disable=redefined-builtin
57
+
58
+ if names is not None:
59
+ return super().__call__(
60
+ value,
61
+ names=names,
62
+ module=module,
63
+ qualname=qualname,
64
+ type=type,
65
+ start=start,
66
+ )
67
+
68
+ try:
69
+ return super().__call__(
70
+ value,
71
+ names=names, # pyright: ignore[reportArgumentType]
72
+ module=module,
73
+ qualname=qualname,
74
+ type=type,
75
+ start=start,
76
+ )
77
+ except ValueError:
78
+ return value
79
+
80
+ def __new__(mcs, name, bases, namespace, **kwargs):
81
+ cls = super().__new__(mcs, name, bases, namespace, **kwargs)
82
+
83
+ # Add __get_pydantic_core_schema__ to make open enums work correctly
84
+ # in union discrimination. In strict mode (used by Pydantic for unions),
85
+ # only known enum values match. In lax mode, unknown values are accepted.
86
+ def __get_pydantic_core_schema__(
87
+ cls_inner: Any, _source_type: Any, _handler: Any
88
+ ) -> core_schema.CoreSchema:
89
+ # Create a validator that only accepts known enum values (for strict mode)
90
+ def validate_strict(v: Any) -> Any:
91
+ if isinstance(v, cls_inner):
92
+ return v
93
+ # Use the parent EnumMeta's __call__ which raises ValueError for unknown values
94
+ return enum.EnumMeta.__call__(cls_inner, v)
95
+
96
+ # Create a lax validator that accepts unknown values
97
+ def validate_lax(v: Any) -> Any:
98
+ if isinstance(v, cls_inner):
99
+ return v
100
+ try:
101
+ return enum.EnumMeta.__call__(cls_inner, v)
102
+ except ValueError:
103
+ # Return the raw value for unknown enum values
104
+ return v
105
+
106
+ # Determine the base type schema (str or int)
107
+ is_int_enum = False
108
+ for base in cls_inner.__mro__:
109
+ if base is int:
110
+ is_int_enum = True
111
+ break
112
+ if base is str:
113
+ break
114
+
115
+ base_schema = (
116
+ core_schema.int_schema()
117
+ if is_int_enum
118
+ else core_schema.str_schema()
119
+ )
120
+
121
+ # Use lax_or_strict_schema:
122
+ # - strict mode: only known enum values match (raises ValueError for unknown)
123
+ # - lax mode: accept any value, return enum member or raw value
124
+ return core_schema.lax_or_strict_schema(
125
+ lax_schema=core_schema.chain_schema(
126
+ [base_schema, core_schema.no_info_plain_validator_function(validate_lax)]
127
+ ),
128
+ strict_schema=core_schema.chain_schema(
129
+ [base_schema, core_schema.no_info_plain_validator_function(validate_strict)]
130
+ ),
131
+ )
132
+
133
+ setattr(cls, "__get_pydantic_core_schema__", classmethod(__get_pydantic_core_schema__))
134
+ return cls