commet-sdk 0.1.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.
- commet/__init__.py +21 -0
- commet/_customer.py +119 -0
- commet/_exceptions.py +39 -0
- commet/_http.py +261 -0
- commet/client.py +109 -0
- commet/py.typed +0 -0
- commet/resources/__init__.py +0 -0
- commet/resources/credit_packs.py +11 -0
- commet/resources/customers.py +128 -0
- commet/resources/features.py +50 -0
- commet/resources/plans.py +22 -0
- commet/resources/portal.py +22 -0
- commet/resources/seats.py +99 -0
- commet/resources/subscriptions.py +57 -0
- commet/resources/usage.py +93 -0
- commet/resources/webhooks.py +44 -0
- commet_sdk-0.1.0.dist-info/METADATA +118 -0
- commet_sdk-0.1.0.dist-info/RECORD +21 -0
- commet_sdk-0.1.0.dist-info/WHEEL +5 -0
- commet_sdk-0.1.0.dist-info/licenses/LICENSE +21 -0
- commet_sdk-0.1.0.dist-info/top_level.txt +1 -0
commet/__init__.py
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
from ._exceptions import CommetAPIError, CommetError, CommetValidationError
|
|
2
|
+
from ._http import ApiResponse
|
|
3
|
+
from .client import Commet
|
|
4
|
+
from .resources.webhooks import Webhooks
|
|
5
|
+
|
|
6
|
+
try:
|
|
7
|
+
from importlib.metadata import version
|
|
8
|
+
|
|
9
|
+
__version__ = version("commet")
|
|
10
|
+
except Exception:
|
|
11
|
+
__version__ = "0.1.0"
|
|
12
|
+
|
|
13
|
+
__all__ = [
|
|
14
|
+
"__version__",
|
|
15
|
+
"ApiResponse",
|
|
16
|
+
"Commet",
|
|
17
|
+
"CommetAPIError",
|
|
18
|
+
"CommetError",
|
|
19
|
+
"CommetValidationError",
|
|
20
|
+
"Webhooks",
|
|
21
|
+
]
|
commet/_customer.py
ADDED
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
from typing import TYPE_CHECKING
|
|
4
|
+
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ._http import ApiResponse
|
|
7
|
+
from .resources.features import FeaturesResource
|
|
8
|
+
from .resources.portal import PortalResource
|
|
9
|
+
from .resources.seats import SeatsResource
|
|
10
|
+
from .resources.subscriptions import SubscriptionsResource
|
|
11
|
+
from .resources.usage import UsageResource
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
class CustomerContext:
|
|
15
|
+
"""Customer-scoped API context.
|
|
16
|
+
|
|
17
|
+
All operations are automatically scoped to the customer's external_id.
|
|
18
|
+
|
|
19
|
+
Usage::
|
|
20
|
+
|
|
21
|
+
customer = commet.customer("user_123")
|
|
22
|
+
|
|
23
|
+
customer.features.get("team_members")
|
|
24
|
+
customer.seats.add("editor")
|
|
25
|
+
customer.usage.track("api_calls")
|
|
26
|
+
"""
|
|
27
|
+
|
|
28
|
+
def __init__(
|
|
29
|
+
self,
|
|
30
|
+
external_id: str,
|
|
31
|
+
*,
|
|
32
|
+
features: FeaturesResource,
|
|
33
|
+
seats: SeatsResource,
|
|
34
|
+
usage: UsageResource,
|
|
35
|
+
subscriptions: SubscriptionsResource,
|
|
36
|
+
portal: PortalResource,
|
|
37
|
+
) -> None:
|
|
38
|
+
self._external_id = external_id
|
|
39
|
+
self.features = _CustomerFeatures(external_id, features)
|
|
40
|
+
self.seats = _CustomerSeats(external_id, seats)
|
|
41
|
+
self.usage = _CustomerUsage(external_id, usage)
|
|
42
|
+
self.subscription = _CustomerSubscription(external_id, subscriptions)
|
|
43
|
+
self.portal = _CustomerPortal(external_id, portal)
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
class _CustomerFeatures:
|
|
47
|
+
def __init__(self, external_id: str, resource: FeaturesResource) -> None:
|
|
48
|
+
self._external_id = external_id
|
|
49
|
+
self._resource = resource
|
|
50
|
+
|
|
51
|
+
def get(self, code: str) -> ApiResponse:
|
|
52
|
+
return self._resource.get(code=code, external_id=self._external_id)
|
|
53
|
+
|
|
54
|
+
def check(self, code: str) -> ApiResponse:
|
|
55
|
+
return self._resource.check(code=code, external_id=self._external_id)
|
|
56
|
+
|
|
57
|
+
def can_use(self, code: str) -> ApiResponse:
|
|
58
|
+
return self._resource.can_use(code=code, external_id=self._external_id)
|
|
59
|
+
|
|
60
|
+
def list(self) -> ApiResponse:
|
|
61
|
+
return self._resource.list(self._external_id)
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
class _CustomerSeats:
|
|
65
|
+
def __init__(self, external_id: str, resource: SeatsResource) -> None:
|
|
66
|
+
self._external_id = external_id
|
|
67
|
+
self._resource = resource
|
|
68
|
+
|
|
69
|
+
def add(self, seat_type: str, count: int = 1) -> ApiResponse:
|
|
70
|
+
return self._resource.add(
|
|
71
|
+
seat_type=seat_type, count=count, external_id=self._external_id
|
|
72
|
+
)
|
|
73
|
+
|
|
74
|
+
def remove(self, seat_type: str, count: int = 1) -> ApiResponse:
|
|
75
|
+
return self._resource.remove(
|
|
76
|
+
seat_type=seat_type, count=count, external_id=self._external_id
|
|
77
|
+
)
|
|
78
|
+
|
|
79
|
+
def set(self, seat_type: str, count: int) -> ApiResponse:
|
|
80
|
+
return self._resource.set(
|
|
81
|
+
seat_type=seat_type, count=count, external_id=self._external_id
|
|
82
|
+
)
|
|
83
|
+
|
|
84
|
+
def get_balance(self, seat_type: str) -> ApiResponse:
|
|
85
|
+
return self._resource.get_balance(seat_type=seat_type, external_id=self._external_id)
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
class _CustomerUsage:
|
|
89
|
+
def __init__(self, external_id: str, resource: UsageResource) -> None:
|
|
90
|
+
self._external_id = external_id
|
|
91
|
+
self._resource = resource
|
|
92
|
+
|
|
93
|
+
def track(
|
|
94
|
+
self,
|
|
95
|
+
feature: str,
|
|
96
|
+
value: int | None = None,
|
|
97
|
+
properties: dict[str, str] | None = None,
|
|
98
|
+
) -> ApiResponse:
|
|
99
|
+
return self._resource.track(
|
|
100
|
+
feature=feature, external_id=self._external_id, value=value, properties=properties
|
|
101
|
+
)
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
class _CustomerSubscription:
|
|
105
|
+
def __init__(self, external_id: str, resource: SubscriptionsResource) -> None:
|
|
106
|
+
self._external_id = external_id
|
|
107
|
+
self._resource = resource
|
|
108
|
+
|
|
109
|
+
def get(self) -> ApiResponse:
|
|
110
|
+
return self._resource.get(self._external_id)
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
class _CustomerPortal:
|
|
114
|
+
def __init__(self, external_id: str, resource: PortalResource) -> None:
|
|
115
|
+
self._external_id = external_id
|
|
116
|
+
self._resource = resource
|
|
117
|
+
|
|
118
|
+
def get_url(self) -> ApiResponse:
|
|
119
|
+
return self._resource.get_url(external_id=self._external_id)
|
commet/_exceptions.py
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
class CommetError(Exception):
|
|
5
|
+
def __init__(
|
|
6
|
+
self,
|
|
7
|
+
message: str,
|
|
8
|
+
*,
|
|
9
|
+
code: str | None = None,
|
|
10
|
+
status_code: int | None = None,
|
|
11
|
+
details: object = None,
|
|
12
|
+
) -> None:
|
|
13
|
+
super().__init__(message)
|
|
14
|
+
self.code = code
|
|
15
|
+
self.status_code = status_code
|
|
16
|
+
self.details = details
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
class CommetAPIError(CommetError):
|
|
20
|
+
def __init__(
|
|
21
|
+
self,
|
|
22
|
+
message: str,
|
|
23
|
+
*,
|
|
24
|
+
status_code: int,
|
|
25
|
+
code: str | None = None,
|
|
26
|
+
details: object = None,
|
|
27
|
+
) -> None:
|
|
28
|
+
super().__init__(message, code=code, status_code=status_code, details=details)
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
class CommetValidationError(CommetError):
|
|
32
|
+
def __init__(
|
|
33
|
+
self,
|
|
34
|
+
message: str,
|
|
35
|
+
*,
|
|
36
|
+
validation_errors: dict[str, list[str]],
|
|
37
|
+
) -> None:
|
|
38
|
+
super().__init__(message)
|
|
39
|
+
self.validation_errors = validation_errors
|
commet/_http.py
ADDED
|
@@ -0,0 +1,261 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
import logging
|
|
4
|
+
import re
|
|
5
|
+
import time
|
|
6
|
+
from dataclasses import dataclass
|
|
7
|
+
from typing import Any
|
|
8
|
+
from uuid import uuid4
|
|
9
|
+
|
|
10
|
+
import httpx
|
|
11
|
+
|
|
12
|
+
from ._exceptions import CommetAPIError, CommetValidationError
|
|
13
|
+
|
|
14
|
+
logger = logging.getLogger("commet")
|
|
15
|
+
|
|
16
|
+
# -- Case conversion --
|
|
17
|
+
|
|
18
|
+
_UPPER_AFTER_LOWER = re.compile(r"(.)([A-Z][a-z]+)")
|
|
19
|
+
_LOWER_BEFORE_UPPER = re.compile(r"([a-z0-9])([A-Z])")
|
|
20
|
+
|
|
21
|
+
_RETRYABLE_STATUS_CODES = frozenset({408, 429, 500, 502, 503, 504})
|
|
22
|
+
|
|
23
|
+
_BASE_URLS = {
|
|
24
|
+
"production": "https://commet.co",
|
|
25
|
+
"sandbox": "https://sandbox.commet.co",
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
def _to_snake(name: str) -> str:
|
|
30
|
+
return _LOWER_BEFORE_UPPER.sub(r"\1_\2", _UPPER_AFTER_LOWER.sub(r"\1_\2", name)).lower()
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
def _to_camel(name: str) -> str:
|
|
34
|
+
parts = name.split("_")
|
|
35
|
+
return parts[0] + "".join(p.capitalize() for p in parts[1:])
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
def _convert_keys(obj: Any, fn: Any) -> Any:
|
|
39
|
+
if isinstance(obj, dict):
|
|
40
|
+
return {fn(k): _convert_keys(v, fn) for k, v in obj.items()}
|
|
41
|
+
if isinstance(obj, list):
|
|
42
|
+
return [_convert_keys(i, fn) for i in obj]
|
|
43
|
+
return obj
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
def build_body(**kwargs: Any) -> dict[str, Any]:
|
|
47
|
+
"""Build request body, stripping None values."""
|
|
48
|
+
return {k: v for k, v in kwargs.items() if v is not None}
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
# -- Response --
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
@dataclass
|
|
55
|
+
class ApiResponse:
|
|
56
|
+
success: bool
|
|
57
|
+
data: Any = None
|
|
58
|
+
code: str | None = None
|
|
59
|
+
message: str | None = None
|
|
60
|
+
has_more: bool | None = None
|
|
61
|
+
next_cursor: str | None = None
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
# -- HTTP Client --
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
class CommetHTTPClient:
|
|
68
|
+
def __init__(
|
|
69
|
+
self,
|
|
70
|
+
api_key: str,
|
|
71
|
+
environment: str,
|
|
72
|
+
*,
|
|
73
|
+
timeout: float = 30.0,
|
|
74
|
+
retries: int = 3,
|
|
75
|
+
) -> None:
|
|
76
|
+
base_url = _BASE_URLS[environment]
|
|
77
|
+
self._client = httpx.Client(
|
|
78
|
+
base_url=f"{base_url}/api",
|
|
79
|
+
headers={
|
|
80
|
+
"x-api-key": api_key,
|
|
81
|
+
"Content-Type": "application/json",
|
|
82
|
+
"User-Agent": f"commet-python/{_get_version()}",
|
|
83
|
+
},
|
|
84
|
+
timeout=timeout,
|
|
85
|
+
)
|
|
86
|
+
self._max_retries = retries
|
|
87
|
+
|
|
88
|
+
def close(self) -> None:
|
|
89
|
+
self._client.close()
|
|
90
|
+
|
|
91
|
+
def get(
|
|
92
|
+
self,
|
|
93
|
+
endpoint: str,
|
|
94
|
+
params: dict[str, Any] | None = None,
|
|
95
|
+
*,
|
|
96
|
+
idempotency_key: str | None = None,
|
|
97
|
+
timeout: float | None = None,
|
|
98
|
+
) -> ApiResponse:
|
|
99
|
+
clean = (
|
|
100
|
+
{_to_camel(k): v for k, v in params.items() if v is not None}
|
|
101
|
+
if params
|
|
102
|
+
else None
|
|
103
|
+
)
|
|
104
|
+
return self._request(
|
|
105
|
+
"GET", endpoint, params=clean, idempotency_key=idempotency_key, timeout=timeout
|
|
106
|
+
)
|
|
107
|
+
|
|
108
|
+
def post(
|
|
109
|
+
self,
|
|
110
|
+
endpoint: str,
|
|
111
|
+
body: dict[str, Any] | None = None,
|
|
112
|
+
*,
|
|
113
|
+
idempotency_key: str | None = None,
|
|
114
|
+
timeout: float | None = None,
|
|
115
|
+
) -> ApiResponse:
|
|
116
|
+
return self._request(
|
|
117
|
+
"POST", endpoint, body=body, idempotency_key=idempotency_key, timeout=timeout
|
|
118
|
+
)
|
|
119
|
+
|
|
120
|
+
def put(
|
|
121
|
+
self,
|
|
122
|
+
endpoint: str,
|
|
123
|
+
body: dict[str, Any] | None = None,
|
|
124
|
+
*,
|
|
125
|
+
idempotency_key: str | None = None,
|
|
126
|
+
timeout: float | None = None,
|
|
127
|
+
) -> ApiResponse:
|
|
128
|
+
return self._request(
|
|
129
|
+
"PUT", endpoint, body=body, idempotency_key=idempotency_key, timeout=timeout
|
|
130
|
+
)
|
|
131
|
+
|
|
132
|
+
def delete(
|
|
133
|
+
self,
|
|
134
|
+
endpoint: str,
|
|
135
|
+
body: dict[str, Any] | None = None,
|
|
136
|
+
*,
|
|
137
|
+
idempotency_key: str | None = None,
|
|
138
|
+
timeout: float | None = None,
|
|
139
|
+
) -> ApiResponse:
|
|
140
|
+
return self._request(
|
|
141
|
+
"DELETE", endpoint, body=body, idempotency_key=idempotency_key, timeout=timeout
|
|
142
|
+
)
|
|
143
|
+
|
|
144
|
+
# -- Internals --
|
|
145
|
+
|
|
146
|
+
def _request(
|
|
147
|
+
self,
|
|
148
|
+
method: str,
|
|
149
|
+
endpoint: str,
|
|
150
|
+
*,
|
|
151
|
+
body: dict[str, Any] | None = None,
|
|
152
|
+
params: dict[str, Any] | None = None,
|
|
153
|
+
idempotency_key: str | None = None,
|
|
154
|
+
timeout: float | None = None,
|
|
155
|
+
) -> ApiResponse:
|
|
156
|
+
headers: dict[str, str] = {}
|
|
157
|
+
if method == "POST":
|
|
158
|
+
headers["Idempotency-Key"] = idempotency_key or f"sdk_{uuid4().hex}"
|
|
159
|
+
|
|
160
|
+
json_body = _convert_keys(body, _to_camel) if body else None
|
|
161
|
+
|
|
162
|
+
logger.debug("%s %s", method, endpoint)
|
|
163
|
+
if json_body:
|
|
164
|
+
logger.debug("Body: %s", json_body)
|
|
165
|
+
|
|
166
|
+
return self._execute(
|
|
167
|
+
method, endpoint, json_body=json_body, params=params, headers=headers, timeout=timeout
|
|
168
|
+
)
|
|
169
|
+
|
|
170
|
+
def _execute(
|
|
171
|
+
self,
|
|
172
|
+
method: str,
|
|
173
|
+
endpoint: str,
|
|
174
|
+
*,
|
|
175
|
+
json_body: Any = None,
|
|
176
|
+
params: dict[str, Any] | None = None,
|
|
177
|
+
headers: dict[str, str] | None = None,
|
|
178
|
+
timeout: float | None = None,
|
|
179
|
+
attempt: int = 1,
|
|
180
|
+
) -> ApiResponse:
|
|
181
|
+
try:
|
|
182
|
+
resp = self._client.request(
|
|
183
|
+
method, endpoint, json=json_body, params=params, headers=headers, timeout=timeout
|
|
184
|
+
)
|
|
185
|
+
except httpx.TimeoutException:
|
|
186
|
+
if attempt <= self._max_retries:
|
|
187
|
+
self._wait(attempt)
|
|
188
|
+
return self._execute(
|
|
189
|
+
method, endpoint, json_body=json_body, params=params,
|
|
190
|
+
headers=headers, timeout=timeout, attempt=attempt + 1,
|
|
191
|
+
)
|
|
192
|
+
raise
|
|
193
|
+
|
|
194
|
+
logger.debug("Response: %d", resp.status_code)
|
|
195
|
+
|
|
196
|
+
if resp.status_code in _RETRYABLE_STATUS_CODES and attempt <= self._max_retries:
|
|
197
|
+
self._wait(attempt)
|
|
198
|
+
return self._execute(
|
|
199
|
+
method, endpoint, json_body=json_body, params=params,
|
|
200
|
+
headers=headers, timeout=timeout, attempt=attempt + 1,
|
|
201
|
+
)
|
|
202
|
+
|
|
203
|
+
try:
|
|
204
|
+
data = resp.json()
|
|
205
|
+
except Exception:
|
|
206
|
+
if resp.status_code == 404:
|
|
207
|
+
return ApiResponse(success=False, code="not_found", message="Resource not found")
|
|
208
|
+
raise CommetAPIError(
|
|
209
|
+
f"Invalid JSON response: {resp.status_code}",
|
|
210
|
+
status_code=resp.status_code,
|
|
211
|
+
code="INVALID_JSON",
|
|
212
|
+
)
|
|
213
|
+
|
|
214
|
+
if resp.is_error:
|
|
215
|
+
self._handle_error(resp.status_code, data)
|
|
216
|
+
|
|
217
|
+
converted = _convert_keys(data, _to_snake)
|
|
218
|
+
return ApiResponse(
|
|
219
|
+
success=converted.get("success", True),
|
|
220
|
+
data=converted.get("data"),
|
|
221
|
+
code=converted.get("code"),
|
|
222
|
+
message=converted.get("message"),
|
|
223
|
+
has_more=converted.get("has_more"),
|
|
224
|
+
next_cursor=converted.get("next_cursor"),
|
|
225
|
+
)
|
|
226
|
+
|
|
227
|
+
def _handle_error(self, status_code: int, data: Any) -> None:
|
|
228
|
+
if not isinstance(data, dict):
|
|
229
|
+
raise CommetAPIError(
|
|
230
|
+
f"Request failed with status {status_code}", status_code=status_code
|
|
231
|
+
)
|
|
232
|
+
|
|
233
|
+
if data.get("code") == "validation_error" and isinstance(data.get("details"), list):
|
|
234
|
+
errors: dict[str, list[str]] = {}
|
|
235
|
+
for detail in data["details"]:
|
|
236
|
+
field = detail.get("field", "unknown")
|
|
237
|
+
errors.setdefault(field, []).append(detail.get("message", ""))
|
|
238
|
+
raise CommetValidationError(
|
|
239
|
+
data.get("message", "Validation failed"), validation_errors=errors
|
|
240
|
+
)
|
|
241
|
+
|
|
242
|
+
raise CommetAPIError(
|
|
243
|
+
data.get("message", f"Request failed with status {status_code}"),
|
|
244
|
+
status_code=status_code,
|
|
245
|
+
code=data.get("code"),
|
|
246
|
+
details=data.get("details"),
|
|
247
|
+
)
|
|
248
|
+
|
|
249
|
+
def _wait(self, attempt: int) -> None:
|
|
250
|
+
delay = min(1.0 * (2 ** (attempt - 1)), 8.0)
|
|
251
|
+
logger.debug("Retrying in %ss (attempt %d/%d)", delay, attempt, self._max_retries)
|
|
252
|
+
time.sleep(delay)
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
def _get_version() -> str:
|
|
256
|
+
try:
|
|
257
|
+
from importlib.metadata import version
|
|
258
|
+
|
|
259
|
+
return version("commet")
|
|
260
|
+
except Exception:
|
|
261
|
+
return "0.1.0"
|
commet/client.py
ADDED
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
import logging
|
|
4
|
+
from typing import Literal
|
|
5
|
+
|
|
6
|
+
from ._customer import CustomerContext
|
|
7
|
+
from ._http import CommetHTTPClient, _BASE_URLS
|
|
8
|
+
from .resources.credit_packs import CreditPacksResource
|
|
9
|
+
from .resources.customers import CustomersResource
|
|
10
|
+
from .resources.features import FeaturesResource
|
|
11
|
+
from .resources.plans import PlansResource
|
|
12
|
+
from .resources.portal import PortalResource
|
|
13
|
+
from .resources.seats import SeatsResource
|
|
14
|
+
from .resources.subscriptions import SubscriptionsResource
|
|
15
|
+
from .resources.usage import UsageResource
|
|
16
|
+
from .resources.webhooks import Webhooks
|
|
17
|
+
|
|
18
|
+
logger = logging.getLogger("commet")
|
|
19
|
+
|
|
20
|
+
Environment = Literal["sandbox", "production"]
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
class Commet:
|
|
24
|
+
"""Commet SDK client.
|
|
25
|
+
|
|
26
|
+
Usage::
|
|
27
|
+
|
|
28
|
+
from commet import Commet
|
|
29
|
+
|
|
30
|
+
commet = Commet(api_key="ck_xxx")
|
|
31
|
+
|
|
32
|
+
# Direct resource access
|
|
33
|
+
commet.customers.create(email="user@example.com")
|
|
34
|
+
commet.usage.track(feature="api_calls", external_id="user_123")
|
|
35
|
+
|
|
36
|
+
# Customer-scoped context
|
|
37
|
+
customer = commet.customer("user_123")
|
|
38
|
+
customer.usage.track("api_calls")
|
|
39
|
+
|
|
40
|
+
# Context manager
|
|
41
|
+
with Commet(api_key="ck_xxx") as commet:
|
|
42
|
+
commet.usage.track(feature="api_calls", external_id="user_123")
|
|
43
|
+
"""
|
|
44
|
+
|
|
45
|
+
def __init__(
|
|
46
|
+
self,
|
|
47
|
+
api_key: str,
|
|
48
|
+
*,
|
|
49
|
+
environment: Environment = "sandbox",
|
|
50
|
+
timeout: float = 30.0,
|
|
51
|
+
retries: int = 3,
|
|
52
|
+
) -> None:
|
|
53
|
+
if not api_key:
|
|
54
|
+
raise ValueError("Commet SDK: API key is required")
|
|
55
|
+
|
|
56
|
+
if not api_key.startswith("ck_"):
|
|
57
|
+
raise ValueError("Commet SDK: Invalid API key format. Expected format: ck_xxx...")
|
|
58
|
+
|
|
59
|
+
if environment not in _BASE_URLS:
|
|
60
|
+
raise ValueError(
|
|
61
|
+
f"Commet SDK: Invalid environment '{environment}'. Must be 'sandbox' or 'production'"
|
|
62
|
+
)
|
|
63
|
+
|
|
64
|
+
self._environment = environment
|
|
65
|
+
self._http = CommetHTTPClient(
|
|
66
|
+
api_key, environment, timeout=timeout, retries=retries
|
|
67
|
+
)
|
|
68
|
+
|
|
69
|
+
self.customers = CustomersResource(self._http)
|
|
70
|
+
self.credit_packs = CreditPacksResource(self._http)
|
|
71
|
+
self.plans = PlansResource(self._http)
|
|
72
|
+
self.usage = UsageResource(self._http)
|
|
73
|
+
self.seats = SeatsResource(self._http)
|
|
74
|
+
self.subscriptions = SubscriptionsResource(self._http)
|
|
75
|
+
self.portal = PortalResource(self._http)
|
|
76
|
+
self.features = FeaturesResource(self._http)
|
|
77
|
+
self.webhooks = Webhooks()
|
|
78
|
+
|
|
79
|
+
logger.debug("Initialized in %s mode", environment)
|
|
80
|
+
|
|
81
|
+
def close(self) -> None:
|
|
82
|
+
self._http.close()
|
|
83
|
+
|
|
84
|
+
def __enter__(self) -> Commet:
|
|
85
|
+
return self
|
|
86
|
+
|
|
87
|
+
def __exit__(self, *args: object) -> None:
|
|
88
|
+
self.close()
|
|
89
|
+
|
|
90
|
+
def customer(self, external_id: str) -> CustomerContext:
|
|
91
|
+
"""Create a customer-scoped context for cleaner API usage."""
|
|
92
|
+
return CustomerContext(
|
|
93
|
+
external_id,
|
|
94
|
+
features=self.features,
|
|
95
|
+
seats=self.seats,
|
|
96
|
+
usage=self.usage,
|
|
97
|
+
subscriptions=self.subscriptions,
|
|
98
|
+
portal=self.portal,
|
|
99
|
+
)
|
|
100
|
+
|
|
101
|
+
@property
|
|
102
|
+
def environment(self) -> str:
|
|
103
|
+
return self._environment
|
|
104
|
+
|
|
105
|
+
def is_sandbox(self) -> bool:
|
|
106
|
+
return self._environment == "sandbox"
|
|
107
|
+
|
|
108
|
+
def is_production(self) -> bool:
|
|
109
|
+
return self._environment == "production"
|
commet/py.typed
ADDED
|
File without changes
|
|
File without changes
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
from .._http import ApiResponse, CommetHTTPClient
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
class CreditPacksResource:
|
|
7
|
+
def __init__(self, http: CommetHTTPClient) -> None:
|
|
8
|
+
self._http = http
|
|
9
|
+
|
|
10
|
+
def list(self) -> ApiResponse:
|
|
11
|
+
return self._http.get("/credit-packs")
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
from typing import Any
|
|
4
|
+
|
|
5
|
+
from .._http import ApiResponse, CommetHTTPClient, build_body
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
class CustomersResource:
|
|
9
|
+
def __init__(self, http: CommetHTTPClient) -> None:
|
|
10
|
+
self._http = http
|
|
11
|
+
|
|
12
|
+
def create(
|
|
13
|
+
self,
|
|
14
|
+
*,
|
|
15
|
+
email: str,
|
|
16
|
+
external_id: str | None = None,
|
|
17
|
+
full_name: str | None = None,
|
|
18
|
+
domain: str | None = None,
|
|
19
|
+
website: str | None = None,
|
|
20
|
+
timezone: str | None = None,
|
|
21
|
+
language: str | None = None,
|
|
22
|
+
industry: str | None = None,
|
|
23
|
+
metadata: dict[str, Any] | None = None,
|
|
24
|
+
address: dict[str, str] | None = None,
|
|
25
|
+
idempotency_key: str | None = None,
|
|
26
|
+
) -> ApiResponse:
|
|
27
|
+
return self._http.post(
|
|
28
|
+
"/customers",
|
|
29
|
+
build_body(
|
|
30
|
+
billing_email=email,
|
|
31
|
+
external_id=external_id,
|
|
32
|
+
full_name=full_name,
|
|
33
|
+
domain=domain,
|
|
34
|
+
website=website,
|
|
35
|
+
timezone=timezone,
|
|
36
|
+
language=language,
|
|
37
|
+
industry=industry,
|
|
38
|
+
metadata=metadata,
|
|
39
|
+
address=address,
|
|
40
|
+
),
|
|
41
|
+
idempotency_key=idempotency_key,
|
|
42
|
+
)
|
|
43
|
+
|
|
44
|
+
def create_batch(
|
|
45
|
+
self,
|
|
46
|
+
customers: list[dict[str, Any]],
|
|
47
|
+
*,
|
|
48
|
+
idempotency_key: str | None = None,
|
|
49
|
+
) -> ApiResponse:
|
|
50
|
+
mapped = [
|
|
51
|
+
build_body(
|
|
52
|
+
billing_email=c.get("email"),
|
|
53
|
+
external_id=c.get("external_id"),
|
|
54
|
+
full_name=c.get("full_name"),
|
|
55
|
+
domain=c.get("domain"),
|
|
56
|
+
website=c.get("website"),
|
|
57
|
+
timezone=c.get("timezone"),
|
|
58
|
+
language=c.get("language"),
|
|
59
|
+
industry=c.get("industry"),
|
|
60
|
+
metadata=c.get("metadata"),
|
|
61
|
+
address=c.get("address"),
|
|
62
|
+
)
|
|
63
|
+
for c in customers
|
|
64
|
+
]
|
|
65
|
+
return self._http.post(
|
|
66
|
+
"/customers/batch", {"customers": mapped}, idempotency_key=idempotency_key
|
|
67
|
+
)
|
|
68
|
+
|
|
69
|
+
def get(self, customer_id: str) -> ApiResponse:
|
|
70
|
+
return self._http.get(f"/customers/{customer_id}")
|
|
71
|
+
|
|
72
|
+
def update(
|
|
73
|
+
self,
|
|
74
|
+
customer_id: str,
|
|
75
|
+
*,
|
|
76
|
+
email: str | None = None,
|
|
77
|
+
external_id: str | None = None,
|
|
78
|
+
full_name: str | None = None,
|
|
79
|
+
domain: str | None = None,
|
|
80
|
+
website: str | None = None,
|
|
81
|
+
timezone: str | None = None,
|
|
82
|
+
language: str | None = None,
|
|
83
|
+
industry: str | None = None,
|
|
84
|
+
metadata: dict[str, Any] | None = None,
|
|
85
|
+
idempotency_key: str | None = None,
|
|
86
|
+
) -> ApiResponse:
|
|
87
|
+
return self._http.put(
|
|
88
|
+
f"/customers/{customer_id}",
|
|
89
|
+
build_body(
|
|
90
|
+
billing_email=email,
|
|
91
|
+
external_id=external_id,
|
|
92
|
+
full_name=full_name,
|
|
93
|
+
domain=domain,
|
|
94
|
+
website=website,
|
|
95
|
+
timezone=timezone,
|
|
96
|
+
language=language,
|
|
97
|
+
industry=industry,
|
|
98
|
+
metadata=metadata,
|
|
99
|
+
),
|
|
100
|
+
idempotency_key=idempotency_key,
|
|
101
|
+
)
|
|
102
|
+
|
|
103
|
+
def list(
|
|
104
|
+
self,
|
|
105
|
+
*,
|
|
106
|
+
external_id: str | None = None,
|
|
107
|
+
is_active: bool | None = None,
|
|
108
|
+
search: str | None = None,
|
|
109
|
+
limit: int | None = None,
|
|
110
|
+
cursor: str | None = None,
|
|
111
|
+
) -> ApiResponse:
|
|
112
|
+
return self._http.get(
|
|
113
|
+
"/customers",
|
|
114
|
+
build_body(
|
|
115
|
+
external_id=external_id,
|
|
116
|
+
is_active=is_active,
|
|
117
|
+
search=search,
|
|
118
|
+
limit=limit,
|
|
119
|
+
cursor=cursor,
|
|
120
|
+
),
|
|
121
|
+
)
|
|
122
|
+
|
|
123
|
+
def archive(self, customer_id: str, *, idempotency_key: str | None = None) -> ApiResponse:
|
|
124
|
+
return self._http.put(
|
|
125
|
+
f"/customers/{customer_id}",
|
|
126
|
+
{"is_active": False},
|
|
127
|
+
idempotency_key=idempotency_key,
|
|
128
|
+
)
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
from .._http import ApiResponse, CommetHTTPClient
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
class FeaturesResource:
|
|
7
|
+
def __init__(self, http: CommetHTTPClient) -> None:
|
|
8
|
+
self._http = http
|
|
9
|
+
|
|
10
|
+
def get(
|
|
11
|
+
self,
|
|
12
|
+
*,
|
|
13
|
+
code: str,
|
|
14
|
+
external_id: str,
|
|
15
|
+
) -> ApiResponse:
|
|
16
|
+
return self._http.get(f"/features/{code}", {"external_id": external_id})
|
|
17
|
+
|
|
18
|
+
def check(
|
|
19
|
+
self,
|
|
20
|
+
*,
|
|
21
|
+
code: str,
|
|
22
|
+
external_id: str,
|
|
23
|
+
) -> ApiResponse:
|
|
24
|
+
result = self._http.get(f"/features/{code}", {"external_id": external_id})
|
|
25
|
+
|
|
26
|
+
if not result.success or not result.data:
|
|
27
|
+
return ApiResponse(
|
|
28
|
+
success=False,
|
|
29
|
+
data={"allowed": False},
|
|
30
|
+
message=result.message,
|
|
31
|
+
)
|
|
32
|
+
|
|
33
|
+
return ApiResponse(
|
|
34
|
+
success=True,
|
|
35
|
+
data={"allowed": result.data.get("allowed", False)},
|
|
36
|
+
message=result.message,
|
|
37
|
+
)
|
|
38
|
+
|
|
39
|
+
def can_use(
|
|
40
|
+
self,
|
|
41
|
+
*,
|
|
42
|
+
code: str,
|
|
43
|
+
external_id: str,
|
|
44
|
+
) -> ApiResponse:
|
|
45
|
+
return self._http.get(
|
|
46
|
+
f"/features/{code}", {"external_id": external_id, "action": "canUse"}
|
|
47
|
+
)
|
|
48
|
+
|
|
49
|
+
def list(self, external_id: str) -> ApiResponse:
|
|
50
|
+
return self._http.get("/features", {"external_id": external_id})
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
from .._http import ApiResponse, CommetHTTPClient, build_body
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
class PlansResource:
|
|
7
|
+
def __init__(self, http: CommetHTTPClient) -> None:
|
|
8
|
+
self._http = http
|
|
9
|
+
|
|
10
|
+
def list(
|
|
11
|
+
self,
|
|
12
|
+
*,
|
|
13
|
+
include_private: bool | None = None,
|
|
14
|
+
limit: int | None = None,
|
|
15
|
+
cursor: str | None = None,
|
|
16
|
+
) -> ApiResponse:
|
|
17
|
+
return self._http.get("/plans", build_body(
|
|
18
|
+
include_private=include_private, limit=limit, cursor=cursor
|
|
19
|
+
))
|
|
20
|
+
|
|
21
|
+
def get(self, plan_code: str) -> ApiResponse:
|
|
22
|
+
return self._http.get(f"/plans/{plan_code}")
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
from .._http import ApiResponse, CommetHTTPClient, build_body
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
class PortalResource:
|
|
7
|
+
def __init__(self, http: CommetHTTPClient) -> None:
|
|
8
|
+
self._http = http
|
|
9
|
+
|
|
10
|
+
def get_url(
|
|
11
|
+
self,
|
|
12
|
+
*,
|
|
13
|
+
customer_id: str | None = None,
|
|
14
|
+
external_id: str | None = None,
|
|
15
|
+
email: str | None = None,
|
|
16
|
+
idempotency_key: str | None = None,
|
|
17
|
+
) -> ApiResponse:
|
|
18
|
+
return self._http.post(
|
|
19
|
+
"/portal/request-access",
|
|
20
|
+
build_body(customer_id=customer_id, external_id=external_id, email=email),
|
|
21
|
+
idempotency_key=idempotency_key,
|
|
22
|
+
)
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
from .._http import ApiResponse, CommetHTTPClient, build_body
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
class SeatsResource:
|
|
7
|
+
def __init__(self, http: CommetHTTPClient) -> None:
|
|
8
|
+
self._http = http
|
|
9
|
+
|
|
10
|
+
def add(
|
|
11
|
+
self,
|
|
12
|
+
*,
|
|
13
|
+
seat_type: str,
|
|
14
|
+
count: int,
|
|
15
|
+
customer_id: str | None = None,
|
|
16
|
+
external_id: str | None = None,
|
|
17
|
+
idempotency_key: str | None = None,
|
|
18
|
+
) -> ApiResponse:
|
|
19
|
+
return self._http.post(
|
|
20
|
+
"/seats",
|
|
21
|
+
build_body(
|
|
22
|
+
seat_type=seat_type, count=count,
|
|
23
|
+
customer_id=customer_id, external_id=external_id,
|
|
24
|
+
),
|
|
25
|
+
idempotency_key=idempotency_key,
|
|
26
|
+
)
|
|
27
|
+
|
|
28
|
+
def remove(
|
|
29
|
+
self,
|
|
30
|
+
*,
|
|
31
|
+
seat_type: str,
|
|
32
|
+
count: int,
|
|
33
|
+
customer_id: str | None = None,
|
|
34
|
+
external_id: str | None = None,
|
|
35
|
+
idempotency_key: str | None = None,
|
|
36
|
+
) -> ApiResponse:
|
|
37
|
+
return self._http.delete(
|
|
38
|
+
"/seats",
|
|
39
|
+
build_body(
|
|
40
|
+
seat_type=seat_type, count=count,
|
|
41
|
+
customer_id=customer_id, external_id=external_id,
|
|
42
|
+
),
|
|
43
|
+
idempotency_key=idempotency_key,
|
|
44
|
+
)
|
|
45
|
+
|
|
46
|
+
def set(
|
|
47
|
+
self,
|
|
48
|
+
*,
|
|
49
|
+
seat_type: str,
|
|
50
|
+
count: int,
|
|
51
|
+
customer_id: str | None = None,
|
|
52
|
+
external_id: str | None = None,
|
|
53
|
+
idempotency_key: str | None = None,
|
|
54
|
+
) -> ApiResponse:
|
|
55
|
+
return self._http.put(
|
|
56
|
+
"/seats",
|
|
57
|
+
build_body(
|
|
58
|
+
seat_type=seat_type, count=count,
|
|
59
|
+
customer_id=customer_id, external_id=external_id,
|
|
60
|
+
),
|
|
61
|
+
idempotency_key=idempotency_key,
|
|
62
|
+
)
|
|
63
|
+
|
|
64
|
+
def set_all(
|
|
65
|
+
self,
|
|
66
|
+
*,
|
|
67
|
+
seats: dict[str, int],
|
|
68
|
+
customer_id: str | None = None,
|
|
69
|
+
external_id: str | None = None,
|
|
70
|
+
idempotency_key: str | None = None,
|
|
71
|
+
) -> ApiResponse:
|
|
72
|
+
return self._http.put(
|
|
73
|
+
"/seats/bulk",
|
|
74
|
+
build_body(seats=seats, customer_id=customer_id, external_id=external_id),
|
|
75
|
+
idempotency_key=idempotency_key,
|
|
76
|
+
)
|
|
77
|
+
|
|
78
|
+
def get_balance(
|
|
79
|
+
self,
|
|
80
|
+
*,
|
|
81
|
+
seat_type: str,
|
|
82
|
+
customer_id: str | None = None,
|
|
83
|
+
external_id: str | None = None,
|
|
84
|
+
) -> ApiResponse:
|
|
85
|
+
return self._http.get(
|
|
86
|
+
"/seats/balance",
|
|
87
|
+
build_body(seat_type=seat_type, customer_id=customer_id, external_id=external_id),
|
|
88
|
+
)
|
|
89
|
+
|
|
90
|
+
def get_all_balances(
|
|
91
|
+
self,
|
|
92
|
+
*,
|
|
93
|
+
customer_id: str | None = None,
|
|
94
|
+
external_id: str | None = None,
|
|
95
|
+
) -> ApiResponse:
|
|
96
|
+
return self._http.get(
|
|
97
|
+
"/seats/balances",
|
|
98
|
+
build_body(customer_id=customer_id, external_id=external_id),
|
|
99
|
+
)
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
from .._http import ApiResponse, CommetHTTPClient, build_body
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
class SubscriptionsResource:
|
|
7
|
+
def __init__(self, http: CommetHTTPClient) -> None:
|
|
8
|
+
self._http = http
|
|
9
|
+
|
|
10
|
+
def create(
|
|
11
|
+
self,
|
|
12
|
+
*,
|
|
13
|
+
customer_id: str | None = None,
|
|
14
|
+
external_id: str | None = None,
|
|
15
|
+
plan_code: str | None = None,
|
|
16
|
+
plan_id: str | None = None,
|
|
17
|
+
billing_interval: str | None = None,
|
|
18
|
+
initial_seats: dict[str, int] | None = None,
|
|
19
|
+
skip_trial: bool | None = None,
|
|
20
|
+
name: str | None = None,
|
|
21
|
+
start_date: str | None = None,
|
|
22
|
+
success_url: str | None = None,
|
|
23
|
+
idempotency_key: str | None = None,
|
|
24
|
+
) -> ApiResponse:
|
|
25
|
+
return self._http.post(
|
|
26
|
+
"/subscriptions",
|
|
27
|
+
build_body(
|
|
28
|
+
customer_id=customer_id,
|
|
29
|
+
external_id=external_id,
|
|
30
|
+
plan_code=plan_code,
|
|
31
|
+
plan_id=plan_id,
|
|
32
|
+
billing_interval=billing_interval,
|
|
33
|
+
initial_seats=initial_seats,
|
|
34
|
+
skip_trial=skip_trial,
|
|
35
|
+
name=name,
|
|
36
|
+
start_date=start_date,
|
|
37
|
+
success_url=success_url,
|
|
38
|
+
),
|
|
39
|
+
idempotency_key=idempotency_key,
|
|
40
|
+
)
|
|
41
|
+
|
|
42
|
+
def get(self, external_id: str) -> ApiResponse:
|
|
43
|
+
return self._http.get("/subscriptions/active", {"external_id": external_id})
|
|
44
|
+
|
|
45
|
+
def cancel(
|
|
46
|
+
self,
|
|
47
|
+
subscription_id: str,
|
|
48
|
+
*,
|
|
49
|
+
reason: str | None = None,
|
|
50
|
+
immediate: bool | None = None,
|
|
51
|
+
idempotency_key: str | None = None,
|
|
52
|
+
) -> ApiResponse:
|
|
53
|
+
return self._http.post(
|
|
54
|
+
f"/subscriptions/{subscription_id}/cancel",
|
|
55
|
+
build_body(reason=reason, immediate=immediate),
|
|
56
|
+
idempotency_key=idempotency_key,
|
|
57
|
+
)
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
from datetime import datetime, timezone
|
|
4
|
+
from typing import Any
|
|
5
|
+
|
|
6
|
+
from .._http import ApiResponse, CommetHTTPClient, build_body
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
class UsageResource:
|
|
10
|
+
def __init__(self, http: CommetHTTPClient) -> None:
|
|
11
|
+
self._http = http
|
|
12
|
+
|
|
13
|
+
def track(
|
|
14
|
+
self,
|
|
15
|
+
*,
|
|
16
|
+
feature: str,
|
|
17
|
+
customer_id: str | None = None,
|
|
18
|
+
external_id: str | None = None,
|
|
19
|
+
value: int | None = None,
|
|
20
|
+
model: str | None = None,
|
|
21
|
+
input_tokens: int | None = None,
|
|
22
|
+
output_tokens: int | None = None,
|
|
23
|
+
cache_read_tokens: int | None = None,
|
|
24
|
+
cache_write_tokens: int | None = None,
|
|
25
|
+
idempotency_key: str | None = None,
|
|
26
|
+
timestamp: str | None = None,
|
|
27
|
+
properties: dict[str, str] | None = None,
|
|
28
|
+
) -> ApiResponse:
|
|
29
|
+
props = (
|
|
30
|
+
[{"property": k, "value": v} for k, v in properties.items()] if properties else None
|
|
31
|
+
)
|
|
32
|
+
|
|
33
|
+
body = build_body(
|
|
34
|
+
feature=feature,
|
|
35
|
+
customer_id=customer_id,
|
|
36
|
+
external_id=external_id,
|
|
37
|
+
idempotency_key=idempotency_key,
|
|
38
|
+
timestamp=timestamp or datetime.now(timezone.utc).isoformat(),
|
|
39
|
+
properties=props,
|
|
40
|
+
)
|
|
41
|
+
|
|
42
|
+
if model:
|
|
43
|
+
body.update(build_body(
|
|
44
|
+
model=model,
|
|
45
|
+
input_tokens=input_tokens,
|
|
46
|
+
output_tokens=output_tokens,
|
|
47
|
+
cache_read_tokens=cache_read_tokens,
|
|
48
|
+
cache_write_tokens=cache_write_tokens,
|
|
49
|
+
))
|
|
50
|
+
else:
|
|
51
|
+
if value is not None:
|
|
52
|
+
body["value"] = value
|
|
53
|
+
|
|
54
|
+
return self._http.post("/usage/events", body, idempotency_key=idempotency_key)
|
|
55
|
+
|
|
56
|
+
def track_batch(
|
|
57
|
+
self,
|
|
58
|
+
events: list[dict[str, Any]],
|
|
59
|
+
*,
|
|
60
|
+
idempotency_key: str | None = None,
|
|
61
|
+
) -> ApiResponse:
|
|
62
|
+
mapped = []
|
|
63
|
+
for evt in events:
|
|
64
|
+
props = evt.get("properties")
|
|
65
|
+
formatted_props = (
|
|
66
|
+
[{"property": k, "value": v} for k, v in props.items()] if props else None
|
|
67
|
+
)
|
|
68
|
+
|
|
69
|
+
entry = build_body(
|
|
70
|
+
feature=evt.get("feature"),
|
|
71
|
+
customer_id=evt.get("customer_id"),
|
|
72
|
+
external_id=evt.get("external_id"),
|
|
73
|
+
idempotency_key=evt.get("idempotency_key"),
|
|
74
|
+
timestamp=evt.get("timestamp") or datetime.now(timezone.utc).isoformat(),
|
|
75
|
+
properties=formatted_props,
|
|
76
|
+
)
|
|
77
|
+
|
|
78
|
+
if evt.get("model"):
|
|
79
|
+
entry.update(build_body(
|
|
80
|
+
model=evt["model"],
|
|
81
|
+
input_tokens=evt.get("input_tokens"),
|
|
82
|
+
output_tokens=evt.get("output_tokens"),
|
|
83
|
+
cache_read_tokens=evt.get("cache_read_tokens"),
|
|
84
|
+
cache_write_tokens=evt.get("cache_write_tokens"),
|
|
85
|
+
))
|
|
86
|
+
elif evt.get("value") is not None:
|
|
87
|
+
entry["value"] = evt["value"]
|
|
88
|
+
|
|
89
|
+
mapped.append(entry)
|
|
90
|
+
|
|
91
|
+
return self._http.post(
|
|
92
|
+
"/usage/events/batch", {"events": mapped}, idempotency_key=idempotency_key
|
|
93
|
+
)
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
import hashlib
|
|
4
|
+
import hmac
|
|
5
|
+
import json
|
|
6
|
+
from typing import Any
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
class Webhooks:
|
|
10
|
+
"""Webhook signature verification.
|
|
11
|
+
|
|
12
|
+
Usage::
|
|
13
|
+
|
|
14
|
+
from commet import Webhooks
|
|
15
|
+
|
|
16
|
+
webhooks = Webhooks()
|
|
17
|
+
|
|
18
|
+
is_valid = webhooks.verify(
|
|
19
|
+
payload=raw_body,
|
|
20
|
+
signature=request.headers["x-commet-signature"],
|
|
21
|
+
secret=WEBHOOK_SECRET,
|
|
22
|
+
)
|
|
23
|
+
"""
|
|
24
|
+
|
|
25
|
+
def verify(self, *, payload: str, signature: str | None, secret: str) -> bool:
|
|
26
|
+
if not signature or not secret or not payload:
|
|
27
|
+
return False
|
|
28
|
+
|
|
29
|
+
expected = self._sign(payload, secret)
|
|
30
|
+
return hmac.compare_digest(signature, expected)
|
|
31
|
+
|
|
32
|
+
def verify_and_parse(
|
|
33
|
+
self, *, raw_body: str, signature: str | None, secret: str
|
|
34
|
+
) -> dict[str, Any] | None:
|
|
35
|
+
if not self.verify(payload=raw_body, signature=signature, secret=secret):
|
|
36
|
+
return None
|
|
37
|
+
|
|
38
|
+
try:
|
|
39
|
+
return json.loads(raw_body)
|
|
40
|
+
except (json.JSONDecodeError, TypeError):
|
|
41
|
+
return None
|
|
42
|
+
|
|
43
|
+
def _sign(self, payload: str, secret: str) -> str:
|
|
44
|
+
return hmac.new(secret.encode(), payload.encode(), hashlib.sha256).hexdigest()
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: commet-sdk
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Commet SDK for Python - Billing and usage tracking for SaaS
|
|
5
|
+
Author: Commet Team
|
|
6
|
+
License-Expression: MIT
|
|
7
|
+
Project-URL: Homepage, https://commet.co
|
|
8
|
+
Project-URL: Repository, https://github.com/commet-labs/commet-python
|
|
9
|
+
Keywords: billing,sdk,payments,invoicing,usage-based-billing,seat-licensing
|
|
10
|
+
Classifier: Development Status :: 4 - Beta
|
|
11
|
+
Classifier: Intended Audience :: Developers
|
|
12
|
+
Classifier: Programming Language :: Python :: 3
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
18
|
+
Classifier: Typing :: Typed
|
|
19
|
+
Requires-Python: >=3.9
|
|
20
|
+
Description-Content-Type: text/markdown
|
|
21
|
+
License-File: LICENSE
|
|
22
|
+
Requires-Dist: httpx>=0.27
|
|
23
|
+
Provides-Extra: dev
|
|
24
|
+
Requires-Dist: pytest; extra == "dev"
|
|
25
|
+
Requires-Dist: ruff; extra == "dev"
|
|
26
|
+
Requires-Dist: mypy; extra == "dev"
|
|
27
|
+
Requires-Dist: respx; extra == "dev"
|
|
28
|
+
Dynamic: license-file
|
|
29
|
+
|
|
30
|
+
# Commet Python SDK
|
|
31
|
+
|
|
32
|
+
Billing and usage tracking for SaaS applications.
|
|
33
|
+
|
|
34
|
+
## Installation
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
pip install commet
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Quick start
|
|
41
|
+
|
|
42
|
+
```python
|
|
43
|
+
from commet import Commet
|
|
44
|
+
|
|
45
|
+
commet = Commet(api_key="ck_xxx", environment="production")
|
|
46
|
+
|
|
47
|
+
# Create a customer
|
|
48
|
+
commet.customers.create(email="user@example.com", external_id="user_123")
|
|
49
|
+
|
|
50
|
+
# Create a subscription
|
|
51
|
+
commet.subscriptions.create(external_id="user_123", plan_code="pro")
|
|
52
|
+
|
|
53
|
+
# Track usage
|
|
54
|
+
commet.usage.track(feature="api_calls", external_id="user_123")
|
|
55
|
+
|
|
56
|
+
# Track AI token usage
|
|
57
|
+
commet.usage.track(
|
|
58
|
+
feature="ai_generation",
|
|
59
|
+
external_id="user_123",
|
|
60
|
+
model="claude-sonnet-4-20250514",
|
|
61
|
+
input_tokens=1000,
|
|
62
|
+
output_tokens=500,
|
|
63
|
+
)
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
## Customer context
|
|
67
|
+
|
|
68
|
+
Scope all operations to a customer to avoid repeating `external_id`:
|
|
69
|
+
|
|
70
|
+
```python
|
|
71
|
+
customer = commet.customer("user_123")
|
|
72
|
+
|
|
73
|
+
customer.usage.track("api_calls")
|
|
74
|
+
customer.features.check("custom_branding")
|
|
75
|
+
customer.seats.add("editor", count=3)
|
|
76
|
+
customer.portal.get_url()
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
## Webhook verification
|
|
80
|
+
|
|
81
|
+
```python
|
|
82
|
+
from commet import Webhooks
|
|
83
|
+
|
|
84
|
+
webhooks = Webhooks()
|
|
85
|
+
|
|
86
|
+
payload = webhooks.verify_and_parse(
|
|
87
|
+
raw_body=request_body,
|
|
88
|
+
signature=request.headers["x-commet-signature"],
|
|
89
|
+
secret="whsec_xxx",
|
|
90
|
+
)
|
|
91
|
+
|
|
92
|
+
if payload is None:
|
|
93
|
+
raise ValueError("Invalid webhook signature")
|
|
94
|
+
|
|
95
|
+
if payload["event"] == "subscription.activated":
|
|
96
|
+
# handle activation
|
|
97
|
+
pass
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
## Context manager
|
|
101
|
+
|
|
102
|
+
```python
|
|
103
|
+
with Commet(api_key="ck_xxx") as commet:
|
|
104
|
+
commet.usage.track(feature="api_calls", external_id="user_123")
|
|
105
|
+
# connection pool is automatically closed
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
## Environments
|
|
109
|
+
|
|
110
|
+
The SDK defaults to `sandbox`. Set `environment="production"` for live operations:
|
|
111
|
+
|
|
112
|
+
```python
|
|
113
|
+
commet = Commet(api_key="ck_xxx", environment="production")
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
## License
|
|
117
|
+
|
|
118
|
+
MIT
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
commet/__init__.py,sha256=pPfSFM2LkbZYfahEPMovWeYNNSmwVryQOxYA-ar0NVI,458
|
|
2
|
+
commet/_customer.py,sha256=p_uUS0vZ2IBEuCqGf0SmG1RXWppDERuSX73100XKia4,3898
|
|
3
|
+
commet/_exceptions.py,sha256=Ap9e6k2Cuj8gfvhGCLownjAZK3SQQuoRBV5EAh75Z6A,934
|
|
4
|
+
commet/_http.py,sha256=OtD1wAZqjTakh8Btxk81duUrie73Qbr6-uKAP9DOf2o,7739
|
|
5
|
+
commet/client.py,sha256=Q8bliLLM0TQZZEKGr1INSOm-6iREmNOUZ9w8Lj-yoVY,3342
|
|
6
|
+
commet/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
7
|
+
commet/resources/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
8
|
+
commet/resources/credit_packs.py,sha256=bSyh4tMWOyJn2I5HD3Mk9fOm4dIBATfHa2HAq9P1JRs,280
|
|
9
|
+
commet/resources/customers.py,sha256=_n1cjub9KeoJke9lfjxpivZU79EMyjfkZJDQEgMo-lY,3892
|
|
10
|
+
commet/resources/features.py,sha256=bng3RXM90mIAzyUUNLiUDemv_Ihn2yg6kxR657XCeVs,1307
|
|
11
|
+
commet/resources/plans.py,sha256=Rp7F4rEPqb9eR6ZknpEzjQzX4uOIs32vJdoiu7fLPUY,618
|
|
12
|
+
commet/resources/portal.py,sha256=WwquAWQ4-49dNoeSwdGHFoGvhCDyd_Xxo9tc24Yi1nY,639
|
|
13
|
+
commet/resources/seats.py,sha256=ODy-lFnXvLkhzna0kdw4IeygQ5Y1r4jo8NJR702tJGg,2745
|
|
14
|
+
commet/resources/subscriptions.py,sha256=vYwUGMf1C5ZuV_c4X5K4JnKOR4XkO1ccfP-w4JjKgww,1826
|
|
15
|
+
commet/resources/usage.py,sha256=cey0L2hzAAvSiTtfDnezTfp8I2p7NghswEbj5IKu5Jo,3106
|
|
16
|
+
commet/resources/webhooks.py,sha256=5D-JW0Mb6g12zjsGDuhzwtREr26o9bsmA2EGI9majGQ,1188
|
|
17
|
+
commet_sdk-0.1.0.dist-info/licenses/LICENSE,sha256=An1hkhoPcAbt8WBg0BaPNUBbaNyOXnxC5aiz6vTA4dw,1063
|
|
18
|
+
commet_sdk-0.1.0.dist-info/METADATA,sha256=vNLl_87TCoq61fr9FYozYiGz0egtrKvM0erVLg_DmWI,2821
|
|
19
|
+
commet_sdk-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
|
|
20
|
+
commet_sdk-0.1.0.dist-info/top_level.txt,sha256=3V7AhucjAtcgz0ZwVpx1Cx-wBeViNGSvr3A-4K_rewQ,7
|
|
21
|
+
commet_sdk-0.1.0.dist-info/RECORD,,
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Commet
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
commet
|