getlurk 0.2.1__py3-none-any.whl

getlurk/__init__.py

@@ -0,0 +1,32 @@
+"""The Lurk API for Python.
+
+>>> from getlurk import Lurk
+>>> lurk = Lurk()  # reads the key from LURK_KEY
+>>> receipt = lurk.events.send({"event": "checkin.scanned", "user": "maya@example.com"})
+"""
+
+from ._generated import schema, types
+from .aio import AsyncLurk
+from .client import DEFAULT_BASE_URL, SDK_VERSION, Lurk, Response, Transport
+from .errors import LurkConnectionError, LurkError, WebhookVerificationError
+from .options import RequestOptions
+from .webhooks import ActivityCreatedEvent, RuleLiveEvent, WebhookEvent, construct_event
+
+__all__ = [
+    "ActivityCreatedEvent",
+    "AsyncLurk",
+    "DEFAULT_BASE_URL",
+    "Lurk",
+    "LurkConnectionError",
+    "LurkError",
+    "RequestOptions",
+    "Response",
+    "RuleLiveEvent",
+    "SDK_VERSION",
+    "Transport",
+    "WebhookEvent",
+    "WebhookVerificationError",
+    "construct_event",
+    "schema",
+    "types",
+]

getlurk/_generated/__init__.py

@@ -0,0 +1 @@
+"""Generated from openapi/openapi.json by scripts/generate.ts. Do not edit."""

getlurk/_generated/operations.py

@@ -0,0 +1,122 @@
+"""Generated from openapi/openapi.json by scripts/generate.ts. Do not edit."""
+
+from __future__ import annotations
+
+from typing import Dict, Literal, NamedTuple, Optional, Tuple
+
+
+class Operation(NamedTuple):
+    method: Literal["GET", "POST", "PATCH", "DELETE"]
+    path: str
+    path_params: Tuple[str, ...]
+    query_params: Tuple[str, ...]
+    body: bool
+    #: Where the idempotency key goes. An operation without one is never retried once the request may have been processed.
+    idempotency: Optional[Literal["header", "body"]]
+
+
+OPERATIONS: Dict[str, Operation] = {
+    "activity.explain": Operation("GET", "/v1/activity/{id}", ("id",), (), False, None),
+    "activity.export": Operation("GET", "/v1/activity/export", (), ("user", "rule", "unit", "since", "until",), False, None),
+    "activity.feed": Operation("GET", "/v1/activity-feed", (), ("limit", "cursor", "kind", "user", "rule", "unit", "since", "until",), False, None),
+    "activity.list": Operation("GET", "/v1/activity", (), ("limit", "cursor", "user", "rule", "unit", "cause", "transfer", "since", "until",), False, None),
+    "activity.undo": Operation("POST", "/v1/activity/{id}/undo", ("id",), (), True, None),
+    "agent_keys.create": Operation("POST", "/v1/agent-keys", (), (), True, None),
+    "agent_keys.list": Operation("GET", "/v1/agent-keys", (), ("limit", "cursor",), False, None),
+    "agent_keys.revoke": Operation("POST", "/v1/agent-keys/{id}/revoke", ("id",), (), True, None),
+    "api_keys.create": Operation("POST", "/v1/api-keys", (), (), True, None),
+    "api_keys.list": Operation("GET", "/v1/api-keys", (), ("limit", "cursor",), False, None),
+    "api_keys.revoke": Operation("POST", "/v1/api-keys/{id}/revoke", ("id",), (), True, None),
+    "audiences.add_users": Operation("POST", "/v1/audiences/{id}/users", ("id",), (), True, "header"),
+    "audiences.create": Operation("POST", "/v1/audiences", (), (), True, "header"),
+    "audiences.list": Operation("GET", "/v1/audiences", (), ("limit", "cursor", "kind",), False, None),
+    "budgets.list": Operation("GET", "/v1/budgets", (), ("limit", "cursor", "rule", "nearly_used",), False, None),
+    "clocks.advance": Operation("POST", "/v1/clock/advance", (), (), True, "header"),
+    "clocks.get": Operation("GET", "/v1/clock", (), (), False, None),
+    "clocks.reset": Operation("POST", "/v1/clock/reset", (), (), True, "header"),
+    "clocks.set": Operation("POST", "/v1/clock/set", (), (), True, "header"),
+    "dashboards.create": Operation("POST", "/v1/dashboards", (), (), True, "header"),
+    "dashboards.get": Operation("GET", "/v1/dashboards/{id}", ("id",), (), False, None),
+    "dashboards.list": Operation("GET", "/v1/dashboards", (), ("limit", "cursor", "pinned", "unit",), False, None),
+    "dashboards.pin": Operation("POST", "/v1/dashboards/{id}/pin", ("id",), (), True, None),
+    "dashboards.read": Operation("GET", "/v1/dashboards/{id}/read", ("id",), ("range", "compare", "audience",), False, None),
+    "dashboards.update": Operation("PATCH", "/v1/dashboards/{id}", ("id",), (), True, "header"),
+    "events.catalog": Operation("GET", "/v1/events/catalog", (), ("limit", "cursor", "search",), False, None),
+    "events.send": Operation("POST", "/v1/events", (), (), True, "body"),
+    "exports.cancel": Operation("POST", "/v1/exports/{id}/cancel", ("id",), (), True, "header"),
+    "exports.create": Operation("POST", "/v1/exports", (), (), True, "header"),
+    "exports.download": Operation("POST", "/v1/exports/{id}/download", ("id",), (), True, None),
+    "exports.get": Operation("GET", "/v1/exports/{id}", ("id",), (), False, None),
+    "exports.list": Operation("GET", "/v1/exports", (), ("limit", "cursor",), False, None),
+    "holds.decide": Operation("POST", "/v1/holds/{id}/decision", ("id",), (), True, None),
+    "holds.get": Operation("GET", "/v1/holds/{id}", ("id",), (), False, None),
+    "holds.list": Operation("GET", "/v1/holds", (), ("limit", "cursor", "status", "user", "rule",), False, None),
+    "integrations.health": Operation("GET", "/v1/integrations/health", (), ("key",), False, None),
+    "integrations.list": Operation("GET", "/v1/integrations", (), ("limit", "cursor", "filter",), False, None),
+    "invites.accept": Operation("POST", "/v1/invites/{id}/accept", ("id",), (), True, None),
+    "invites.decline": Operation("POST", "/v1/invites/{id}/decline", ("id",), (), True, None),
+    "invites.list": Operation("GET", "/v1/invites", (), ("limit", "cursor",), False, None),
+    "invites.revoke": Operation("DELETE", "/v1/invites/{id}", ("id",), (), True, None),
+    "lurky.brief": Operation("GET", "/v1/lurky/brief", (), (), False, None),
+    "lurky.delete_conversation": Operation("POST", "/v1/lurky/conversations/{id}/delete", ("id",), (), True, "header"),
+    "lurky.get_conversation": Operation("GET", "/v1/lurky/conversations/{id}", ("id",), (), False, None),
+    "lurky.get_settings": Operation("GET", "/v1/lurky/settings", (), (), False, None),
+    "lurky.hide_suggestion": Operation("POST", "/v1/lurky/suggestions/hide", (), (), True, "header"),
+    "lurky.list_conversations": Operation("GET", "/v1/lurky/conversations", (), ("limit", "cursor",), False, None),
+    "lurky.show_suggestion": Operation("POST", "/v1/lurky/suggestions/show", (), (), True, "header"),
+    "lurky.suggestions": Operation("GET", "/v1/lurky/suggestions", (), (), False, None),
+    "lurky.update_settings": Operation("PATCH", "/v1/lurky/settings", (), (), True, "header"),
+    "lurky.usage": Operation("GET", "/v1/lurky/usage", (), (), False, None),
+    "members.invite": Operation("POST", "/v1/invites", (), (), True, None),
+    "members.list": Operation("GET", "/v1/members", (), ("organization_id", "limit", "cursor", "status",), False, None),
+    "members.me": Operation("GET", "/v1/members/me", (), (), False, None),
+    "members.remove": Operation("DELETE", "/v1/members/{id}", ("id",), (), True, None),
+    "members.update": Operation("PATCH", "/v1/members/{id}", ("id",), (), True, None),
+    "organizations.create": Operation("POST", "/v1/organizations", (), (), True, None),
+    "organizations.list": Operation("GET", "/v1/organizations", (), ("limit", "cursor",), False, None),
+    "projects.create": Operation("POST", "/v1/projects", (), (), True, None),
+    "projects.get": Operation("GET", "/v1/projects/{id}", ("id",), (), False, None),
+    "projects.list": Operation("GET", "/v1/projects", (), ("limit", "cursor", "organization_id",), False, None),
+    "projects.setup": Operation("GET", "/v1/setup", (), (), False, None),
+    "projects.update": Operation("PATCH", "/v1/projects/{id}", ("id",), (), True, None),
+    "promotions.create": Operation("POST", "/v1/promotions", (), (), True, None),
+    "promotions.preview": Operation("POST", "/v1/promotions/preview", (), (), True, None),
+    "proposals.card": Operation("GET", "/v1/proposals/{id}/card", ("id",), (), False, None),
+    "proposals.create": Operation("POST", "/v1/proposals", (), (), True, "header"),
+    "proposals.decide": Operation("POST", "/v1/proposals/{id}/decision", ("id",), (), True, None),
+    "proposals.get": Operation("GET", "/v1/proposals/{id}", ("id",), (), False, None),
+    "proposals.list": Operation("GET", "/v1/proposals", (), ("limit", "cursor", "status",), False, None),
+    "rules.create": Operation("POST", "/v1/rules", (), (), True, "header"),
+    "rules.get": Operation("GET", "/v1/rules/{id}", ("id",), (), False, None),
+    "rules.list": Operation("GET", "/v1/rules", (), ("limit", "cursor", "status", "unit", "event", "search",), False, None),
+    "rules.pause": Operation("POST", "/v1/rules/{id}/pause", ("id",), (), True, None),
+    "rules.preview": Operation("POST", "/v1/rules/{id}/preview", ("id",), (), True, None),
+    "rules.publish": Operation("POST", "/v1/rules/{id}/live", ("id",), (), True, None),
+    "rules.resume": Operation("POST", "/v1/rules/{id}/resume", ("id",), (), True, None),
+    "rules.stats": Operation("GET", "/v1/rules/{id}/stats", ("id",), ("days",), False, None),
+    "rules.update": Operation("PATCH", "/v1/rules/{id}", ("id",), (), True, "header"),
+    "templates.get": Operation("GET", "/v1/templates/{id}", ("id",), (), False, None),
+    "templates.install": Operation("POST", "/v1/templates/{id}/install", ("id",), (), True, "header"),
+    "templates.list": Operation("GET", "/v1/templates", (), ("limit", "cursor", "filter", "category",), False, None),
+    "templates.plan": Operation("POST", "/v1/templates/{id}/plan", ("id",), (), True, None),
+    "templates.remove": Operation("POST", "/v1/templates/{id}/remove", ("id",), (), True, None),
+    "units.create": Operation("POST", "/v1/units", (), (), True, "header"),
+    "units.get": Operation("GET", "/v1/units/{id}", ("id",), (), False, None),
+    "units.give": Operation("POST", "/v1/units/give", (), (), True, "header"),
+    "units.give_preview": Operation("POST", "/v1/units/give/preview", (), (), True, None),
+    "units.list": Operation("GET", "/v1/units", (), ("limit", "cursor", "group",), False, None),
+    "units.send": Operation("POST", "/v1/units/send", (), (), True, "header"),
+    "units.spend": Operation("POST", "/v1/units/spend", (), (), True, "header"),
+    "units.update": Operation("PATCH", "/v1/units/{id}", ("id",), (), True, "header"),
+    "units.use": Operation("POST", "/v1/units/use", (), (), True, "header"),
+    "users.export": Operation("GET", "/v1/users/export", (), ("search",), False, None),
+    "users.get": Operation("GET", "/v1/users/{id}", ("id",), (), False, None),
+    "users.list": Operation("GET", "/v1/users", (), ("limit", "cursor", "search", "audience", "status", "sort", "include",), False, None),
+    "views.create": Operation("POST", "/v1/views", (), (), True, "header"),
+    "views.get": Operation("GET", "/v1/views/{id}", ("id",), ("range", "compare", "audience",), False, None),
+    "views.list": Operation("GET", "/v1/views", (), ("limit", "cursor", "search",), False, None),
+    "views.update": Operation("PATCH", "/v1/views/{id}", ("id",), (), True, "header"),
+    "webhook_endpoints.create": Operation("POST", "/v1/webhook-endpoints", (), (), True, None),
+    "webhook_endpoints.delete": Operation("POST", "/v1/webhook-endpoints/{id}/delete", ("id",), (), True, None),
+    "webhook_endpoints.list": Operation("GET", "/v1/webhook-endpoints", (), ("limit", "cursor",), False, None),
+}