BYOD lines

# No credential needed.
curl -sS "https://api.isnap.ai/v1/apps"

curl -sS -X POST "https://api.isnap.ai/v1/byod/pair" \
  -H "Authorization: Bearer $ISNAP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"metadata":{"crm_account_id":"acct_1042"}}'

import { APIError, ISnapClient } from '@isnap/sdk'

const client = new ISnapClient({ apiKey: process.env.ISNAP_API_KEY ?? '', maxRetries: 2 })

const apps = await client.apps.manifest()
if (!apps.macos.available) {
  throw new Error('No installer of the bridge app is offered for macOS.')
}

// Issue the code when the user has installed and opened the bridge app: it is valid for 5 minutes.
try {
  // The operation does not honor Idempotency-Key: a retry issues another code.
  // Give the user the code of the response you received.
  const pairing = await client.byod.pair({ metadata: { crm_account_id: 'acct_1042' } })
  // Show pairing.activation_code to the user who pairs the device. Do not log it.
  console.log(pairing.download_urls.macos, pairing.expires_at)
} catch (err) {
  if (err instanceof APIError && err.code === 'payment_required') {
    console.error('This account has no BYOD slot.')
  } else if (err instanceof APIError && err.code === 'no_slot_available') {
    console.error('Every BYOD slot is used: terminate a BYOD line to free one.')
  } else {
    throw err
  }
}

import os

import requests

API = "https://api.isnap.ai"

apps = requests.get(f"{API}/v1/apps", timeout=30)
apps.raise_for_status()
if not apps.json()["data"]["macos"]["available"]:
    raise SystemExit("No installer of the bridge app is offered for macOS.")

# Issue the code when the user has installed and opened the bridge app: it is valid for 5 minutes.
# The operation does not honor Idempotency-Key: a retry issues another code.
# Give the user the code of the response you received.
response = requests.post(
    f"{API}/v1/byod/pair",
    headers={"Authorization": f"Bearer {os.environ['ISNAP_API_KEY']}"},
    json={"metadata": {"crm_account_id": "acct_1042"}},
    timeout=30,
)
payload = response.json()

if response.status_code == 201:
    pairing = payload["data"]
    # Show pairing["activation_code"] to the user who pairs the device. Do not log it.
    print(pairing["download_urls"]["macos"], pairing["expires_at"])
elif payload["error"]["code"] == "payment_required":
    print("This account has no BYOD slot.")
elif payload["error"]["code"] == "no_slot_available":
    print("Every BYOD slot is used: terminate a BYOD line to free one.")
else:
    response.raise_for_status()

# Lists your lines that are active or reserved. Match the metadata you sent with the code.
curl -sS "https://api.isnap.ai/v1/lines/my" \
  -H "Authorization: Bearer $ISNAP_API_KEY"

import { ISnapClient } from '@isnap/sdk'

const client = new ISnapClient({ apiKey: process.env.ISNAP_API_KEY ?? '', maxRetries: 2 })

const { lines } = await client.lines.listMine()
const paired = lines.filter(
  (line) =>
    (line.billing_tier === 'byod_imessage' || line.billing_tier === 'byod_android') &&
    line.metadata?.crm_account_id === 'acct_1042'
)

for (const line of paired) {
  // phone_number is "" until the device reports its number: read the line again later.
  console.log(line.id, line.status, line.phone_number === '' ? 'number not reported' : 'number known')
}

import os

import requests

response = requests.get(
    "https://api.isnap.ai/v1/lines/my",
    headers={"Authorization": f"Bearer {os.environ['ISNAP_API_KEY']}"},
    timeout=30,
)
response.raise_for_status()

for line in response.json()["data"]["lines"]:
    if line["billing_tier"] not in ("byod_imessage", "byod_android"):
        continue
    if (line["metadata"] or {}).get("crm_account_id") != "acct_1042":
        continue
    # phone_number is "" until the device reports its number: read the line again later.
    print(line["id"], line["status"], "number known" if line["phone_number"] else "number not reported")