yirlo 1.0.0__tar.gz

yirlo-1.0.0/PKG-INFO

@@ -0,0 +1,27 @@
+Metadata-Version: 2.4
+Name: yirlo
+Version: 1.0.0
+Summary: Yirlo SDK: run your AI cold email outreach (projects, campaigns, inbox, hot leads, budgets) from Python.
+License: MIT
+Project-URL: Homepage, https://yirlo.com
+Project-URL: Documentation, https://yirlo.com/api-docs
+Keywords: yirlo,cold email,outbound,lead generation,sdk
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# Yirlo
+
+Run Yirlo, the AI outbound agent for B2B companies, from Python: projects, campaigns, budgets, the inbox and replies, hot leads, webhooks and your team. No dependencies.
+
+Get an API key at https://yirlo.com/app/api-keys. Full API docs: https://yirlo.com/api-docs
+
+```python
+import os
+from yirlo import Yirlo
+y = Yirlo(os.environ["YIRLO_API_KEY"])
+me = y.get_account()
+campaigns = y.list_campaigns(project_id=me["projects"][0]["id"])["campaigns"]
+hot = y.list_hot_leads()
+```
+
+Errors raise `YirloError` with `.status` and `.body`. MCP server: `https://yirlo.com/mcp` (header `Authorization: Bearer <key>`).

yirlo-1.0.0/README.md

@@ -0,0 +1,16 @@
+# Yirlo
+
+Run Yirlo, the AI outbound agent for B2B companies, from Python: projects, campaigns, budgets, the inbox and replies, hot leads, webhooks and your team. No dependencies.
+
+Get an API key at https://yirlo.com/app/api-keys. Full API docs: https://yirlo.com/api-docs
+
+```python
+import os
+from yirlo import Yirlo
+y = Yirlo(os.environ["YIRLO_API_KEY"])
+me = y.get_account()
+campaigns = y.list_campaigns(project_id=me["projects"][0]["id"])["campaigns"]
+hot = y.list_hot_leads()
+```
+
+Errors raise `YirloError` with `.status` and `.body`. MCP server: `https://yirlo.com/mcp` (header `Authorization: Bearer <key>`).

yirlo-1.0.0/pyproject.toml

@@ -0,0 +1,16 @@
+[build-system]
+requires = ["setuptools>=61"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "yirlo"
+version = "1.0.0"
+description = "Yirlo SDK: run your AI cold email outreach (projects, campaigns, inbox, hot leads, budgets) from Python."
+readme = "README.md"
+requires-python = ">=3.8"
+license = { text = "MIT" }
+keywords = ["yirlo", "cold email", "outbound", "lead generation", "sdk"]
+
+[project.urls]
+Homepage = "https://yirlo.com"
+Documentation = "https://yirlo.com/api-docs"

yirlo-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

yirlo-1.0.0/src/yirlo/__init__.py

@@ -0,0 +1,206 @@
+"""Yirlo SDK for Python 3.8+ (standard library only). https://yirlo.com/sdk/yirlo.py
+Every method is one call to https://yirlo.com/public/api/v1 (docs: https://yirlo.com/api-docs).
+Usage:  from yirlo import Yirlo;  y = Yirlo(os.environ["YIRLO_API_KEY"]);  print(y.get_account())"""
+import json, urllib.request, urllib.error, urllib.parse
+
+class YirloError(Exception):
+    def __init__(self, status, body):
+        super().__init__((body or {}).get("detail") or f"HTTP {status}"); self.status, self.body = status, body
+
+class Yirlo:
+    def __init__(self, api_key, base_url="https://yirlo.com"):
+        if not api_key:
+            raise ValueError("Pass your Yirlo API key (https://yirlo.com/app/api-keys)")
+        self.api_key, self.base_url = api_key, base_url.rstrip("/")
+
+    def request(self, method, path, query=None, body=None):
+        q = {k: v for k, v in (query or {}).items() if v is not None}
+        url = self.base_url + "/public/api/v1" + path + ("?" + urllib.parse.urlencode(q) if q else "")
+        data = json.dumps(body).encode() if body is not None else (None if method == "GET" else b"{}")
+        req = urllib.request.Request(url, data=data, method=method, headers={"X-API-Key": self.api_key, "Content-Type": "application/json", "User-Agent": "yirlo-python/1.0"})
+        try:
+            with urllib.request.urlopen(req, timeout=120) as r:
+                t = r.read()
+                return json.loads(t) if t else {}
+        except urllib.error.HTTPError as e:
+            t = e.read()
+            try:
+                body = json.loads(t) if t else {}
+            except ValueError:
+                body = {"detail": t.decode("utf-8", "replace")}
+            raise YirloError(e.code, body)
+
+    def get_account(self):
+        """Who this API key is: email, credit balance and projects. A good first call."""
+        a = {}
+        path = "/me"
+        return self.request("GET", path)
+
+    def get_balance(self):
+        """Credit balance (1 credit = $0.01)."""
+        a = {}
+        path = "/billing/balance"
+        return self.request("GET", path)
+
+    def list_projects(self):
+        """Every outreach project on the account."""
+        a = {}
+        path = "/agentapp/projects"
+        return self.request("GET", path)
+
+    def create_project(self, domain=None, no_website=None, sender_name=None):
+        """Create a project from a company website (or, with no website, from what it sells, to whom and where). Answers at once with the project id and status creating; Yirlo analyses the company in about 1-2 minutes, then get_project shows status ready and its campaigns are paused until you start one."""
+        a = {"domain": domain, "no_website": no_website, "sender_name": sender_name}
+        path = "/agentapp/projects"
+        return self.request("POST", path, body={k: v for k, v in a.items() if v is not None})
+
+    def get_project(self, project_id):
+        """One project: company, settings, campaigns. For a project from create_project: status creating, ready or failed (with failure_reason and next_step)."""
+        a = {}
+        path = "/agentapp/projects/{project_id}".replace("{project_id}", urllib.parse.quote(str(project_id), safe=""))
+        return self.request("GET", path)
+
+    def project_analytics(self, project_id):
+        """Emails sent, replies and hot leads for a project."""
+        a = {}
+        path = "/agentapp/projects/{project_id}/analytics".replace("{project_id}", urllib.parse.quote(str(project_id), safe=""))
+        return self.request("GET", path)
+
+    def get_project_budget(self, project_id):
+        """Daily budget and monthly cap."""
+        a = {}
+        path = "/agentapp/projects/{project_id}/budget".replace("{project_id}", urllib.parse.quote(str(project_id), safe=""))
+        return self.request("GET", path)
+
+    def set_project_budget(self, project_id, daily_budget_usd):
+        """Set the project daily budget in USD."""
+        a = {"daily_budget_usd": daily_budget_usd}
+        path = "/agentapp/projects/{project_id}/budget".replace("{project_id}", urllib.parse.quote(str(project_id), safe=""))
+        return self.request("PATCH", path, body={k: v for k, v in a.items() if v is not None})
+
+    def list_campaigns(self, project_id=None):
+        """Campaigns (audiences), optionally for one project."""
+        a = {"project_id": project_id}
+        path = "/agentapp/campaigns"
+        return self.request("GET", path, query=a)
+
+    def get_campaign(self, campaign_id):
+        """One campaign: audience, targeting and email instructions."""
+        a = {}
+        path = "/agentapp/campaigns/{campaign_id}".replace("{campaign_id}", urllib.parse.quote(str(campaign_id), safe=""))
+        return self.request("GET", path)
+
+    def create_campaign(self, project_id, name, target_geo=None):
+        """Create a campaign from a name that describes the people to reach, e.g. "Heads of support at Shopify fashion brands". Takes about 30 seconds."""
+        a = {"project_id": project_id, "name": name, "target_geo": target_geo}
+        path = "/agentapp/campaigns"
+        return self.request("POST", path, body={k: v for k, v in a.items() if v is not None})
+
+    def start_campaign(self, campaign_id):
+        """Start (resume) a campaign."""
+        a = {}
+        path = "/agentapp/campaigns/{campaign_id}/start".replace("{campaign_id}", urllib.parse.quote(str(campaign_id), safe=""))
+        return self.request("POST", path)
+
+    def stop_campaign(self, campaign_id):
+        """Pause a campaign."""
+        a = {}
+        path = "/agentapp/campaigns/{campaign_id}/stop".replace("{campaign_id}", urllib.parse.quote(str(campaign_id), safe=""))
+        return self.request("POST", path)
+
+    def archive_campaign(self, campaign_id):
+        """Archive a campaign."""
+        a = {}
+        path = "/agentapp/campaigns/{campaign_id}/archive".replace("{campaign_id}", urllib.parse.quote(str(campaign_id), safe=""))
+        return self.request("POST", path)
+
+    def set_campaign_budget(self, campaign_id, daily_limit_usd):
+        """Set a campaign daily limit in USD."""
+        a = {"daily_limit_usd": daily_limit_usd}
+        path = "/agentapp/campaigns/{campaign_id}/budget".replace("{campaign_id}", urllib.parse.quote(str(campaign_id), safe=""))
+        return self.request("PATCH", path, body={k: v for k, v in a.items() if v is not None})
+
+    def campaign_analytics(self, campaign_id):
+        """Leads found, contacted, replied, hot, bounced for a campaign."""
+        a = {}
+        path = "/agentapp/campaigns/{campaign_id}/analytics".replace("{campaign_id}", urllib.parse.quote(str(campaign_id), safe=""))
+        return self.request("GET", path)
+
+    def list_hot_leads(self, project_id=None):
+        """Interested replies (hot leads), optionally for one project."""
+        a = {"project_id": project_id}
+        path = "/agentapp/hot-leads"
+        return self.request("GET", path, query=a)
+
+    def list_inbox(self, project_id, tab=None):
+        """Conversations in a project inbox. tab: need_reply, hot, all or replied."""
+        a = {"tab": tab}
+        path = "/agentapp/projects/{project_id}/inbox".replace("{project_id}", urllib.parse.quote(str(project_id), safe=""))
+        return self.request("GET", path, query=a)
+
+    def read_conversation(self, campaign_id, person_id):
+        """The full thread with one lead."""
+        a = {}
+        path = "/agentapp/campaigns/{campaign_id}/inbox/{person_id}".replace("{campaign_id}", urllib.parse.quote(str(campaign_id), safe="")).replace("{person_id}", urllib.parse.quote(str(person_id), safe=""))
+        return self.request("GET", path)
+
+    def reply(self, campaign_id, person_id, body_text):
+        """Send a reply to a lead in a thread. This sends a real email."""
+        a = {"body_text": body_text}
+        path = "/agentapp/campaigns/{campaign_id}/inbox/{person_id}/reply".replace("{campaign_id}", urllib.parse.quote(str(campaign_id), safe="")).replace("{person_id}", urllib.parse.quote(str(person_id), safe=""))
+        return self.request("POST", path, body={k: v for k, v in a.items() if v is not None})
+
+    def set_lead_note(self, campaign_id, person_id, note):
+        """Set the note on a lead."""
+        a = {"note": note}
+        path = "/agentapp/campaigns/{campaign_id}/inbox/{person_id}/note".replace("{campaign_id}", urllib.parse.quote(str(campaign_id), safe="")).replace("{person_id}", urllib.parse.quote(str(person_id), safe=""))
+        return self.request("POST", path, body={k: v for k, v in a.items() if v is not None})
+
+    def set_lead_status(self, campaign_id, person_id, status):
+        """Set a lead's deal status."""
+        a = {"status": status}
+        path = "/agentapp/campaigns/{campaign_id}/inbox/{person_id}/status".replace("{campaign_id}", urllib.parse.quote(str(campaign_id), safe="")).replace("{person_id}", urllib.parse.quote(str(person_id), safe=""))
+        return self.request("POST", path, body={k: v for k, v in a.items() if v is not None})
+
+    def suppress_emails(self, emails, list_name=None):
+        """Never email these addresses (every project)."""
+        a = {"emails": emails, "list_name": list_name}
+        path = "/agentapp/suppress-list/people"
+        return self.request("POST", path, body={k: v for k, v in a.items() if v is not None})
+
+    def suppress_domains(self, domains, list_name=None):
+        """Never email anyone at these company domains (every project)."""
+        a = {"domains": domains, "list_name": list_name}
+        path = "/agentapp/suppress-list/companies"
+        return self.request("POST", path, body={k: v for k, v in a.items() if v is not None})
+
+    def list_webhooks(self, project_id=None):
+        """Webhooks for a project (events: reply.received, hot_lead.received)."""
+        a = {"project_id": project_id}
+        path = "/agentapp/webhooks"
+        return self.request("GET", path, query=a)
+
+    def add_webhook(self, project_id, url, events=None):
+        """Add an https webhook to a project."""
+        a = {"project_id": project_id, "url": url, "events": events}
+        path = "/agentapp/webhooks"
+        q = {"project_id": a.pop("project_id", None)}
+        return self.request("POST", path, query=q, body={k: v for k, v in a.items() if v is not None})
+
+    def test_webhook(self, project_id, webhook_id):
+        """Send one signed sample event to a webhook."""
+        a = {"project_id": project_id}
+        path = "/agentapp/webhooks/{webhook_id}/test".replace("{webhook_id}", urllib.parse.quote(str(webhook_id), safe=""))
+        return self.request("POST", path, query=a)
+
+    def list_team(self, project_id):
+        """People on a project."""
+        a = {}
+        path = "/agentapp/projects/{project_id}/team".replace("{project_id}", urllib.parse.quote(str(project_id), safe=""))
+        return self.request("GET", path)
+
+    def invite_teammate(self, project_id, email):
+        """Invite someone to a project by email (owner only)."""
+        a = {"email": email}
+        path = "/agentapp/projects/{project_id}/team".replace("{project_id}", urllib.parse.quote(str(project_id), safe=""))
+        return self.request("POST", path, body={k: v for k, v in a.items() if v is not None})

yirlo-1.0.0/src/yirlo.egg-info/PKG-INFO

@@ -0,0 +1,27 @@
+Metadata-Version: 2.4
+Name: yirlo
+Version: 1.0.0
+Summary: Yirlo SDK: run your AI cold email outreach (projects, campaigns, inbox, hot leads, budgets) from Python.
+License: MIT
+Project-URL: Homepage, https://yirlo.com
+Project-URL: Documentation, https://yirlo.com/api-docs
+Keywords: yirlo,cold email,outbound,lead generation,sdk
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# Yirlo
+
+Run Yirlo, the AI outbound agent for B2B companies, from Python: projects, campaigns, budgets, the inbox and replies, hot leads, webhooks and your team. No dependencies.
+
+Get an API key at https://yirlo.com/app/api-keys. Full API docs: https://yirlo.com/api-docs
+
+```python
+import os
+from yirlo import Yirlo
+y = Yirlo(os.environ["YIRLO_API_KEY"])
+me = y.get_account()
+campaigns = y.list_campaigns(project_id=me["projects"][0]["id"])["campaigns"]
+hot = y.list_hot_leads()
+```
+
+Errors raise `YirloError` with `.status` and `.body`. MCP server: `https://yirlo.com/mcp` (header `Authorization: Bearer <key>`).

yirlo-1.0.0/src/yirlo.egg-info/SOURCES.txt

@@ -0,0 +1,7 @@
+README.md
+pyproject.toml
+src/yirlo/__init__.py
+src/yirlo.egg-info/PKG-INFO
+src/yirlo.egg-info/SOURCES.txt
+src/yirlo.egg-info/dependency_links.txt
+src/yirlo.egg-info/top_level.txt

yirlo-1.0.0/src/yirlo.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

yirlo-1.0.0/src/yirlo.egg-info/top_level.txt

@@ -0,0 +1 @@
+yirlo