Paketler API

Hizmet ve dersleri bir araya getiren, seansları sayılan aylık paketler.

Modül kodu packages · 7 işlem · 3 veri modeli · 6 olay. Bir anahtar ya da token, arkasındaki kişinin bu modülde yapabildiğinden fazlasını asla yapamaz; satır düzeyindeki güvenlik uygulamadakiyle birebir aynıdır. Yetki kapsamları: packages (hepsi), packages:read (yalnız okuma) ya da packages:<yetenek>.

Kaynaklar

Listeler limit (en çok 200), cursor, order (ör. -created_at), fields ve q alır; diğer her sorgu parametresi bir sütun süzgecidir: ?status=paid, ?total[gte]=100, ?id[in]=a,b, ?x=null.

İşlemler

packages.create_package

Paket oluştur — Bir dönem, bir fiyat ve neleri kapsadığı.

Gereken izin packages:manage · veriyi değiştirir

• REST kısayolu: POST /api/v1/packages
• Asıl adres: POST /api/v1/actions/packages.create_package

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: packages.package_created

Neye yazar: package (insert) — Creates the package; package_item (insert) — Writes what it covers

curl -X POST https://app.getera.io/api/v1/packages/actions/create_package \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"name":"Name","periodMonths":1,"priceAmount":1,"items":{}}'

{
  "ok": true,
  "result": "…",
  "events": [
    "packages.package_created"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.packages.create({
  name: "Name",
  periodMonths: 1,
  priceAmount: 1,
  items: {}
})

era packages create --data '{"name":"Name","periodMonths":1,"priceAmount":1,"items":{}}'

{
  "name": "era__packages__create_package",
  "arguments": {
    "name": "Name",
    "periodMonths": 1,
    "priceAmount": 1,
    "items": {}
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde packages:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 invalid_items, service_not_found, class_not_found · 429 çok sık istek

packages.redeem

Paket seansı kullan — Seansı kaldıkça bir randevuyu abonelikten karşılar.

Gereken izin packages:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/packages.redeem

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: packages.session_used, packages.almost_used_up

Neye yazar: package_usage (insert) — Records the session drawn

curl -X POST https://app.getera.io/api/v1/package_usages/actions/redeem \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"subscriptionId":"SUBSCRIPTION_ID","recordType":"appointment_line","recordId":"RECORD_ID"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "packages.session_used",
    "packages.almost_used_up"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.packageUsages.redeem({
  subscriptionId: "SUBSCRIPTION_ID",
  recordType: "appointment_line",
  recordId: "RECORD_ID"
})

era package_usages redeem \
  --subscription-id "SUBSCRIPTION_ID" \
  --record-type "appointment_line" \
  --record-id "RECORD_ID"

{
  "name": "era__packages__redeem",
  "arguments": {
    "subscriptionId": "SUBSCRIPTION_ID",
    "recordType": "appointment_line",
    "recordId": "RECORD_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde packages:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 subscription_not_found, subscription_not_active, record_not_found, customer_mismatch, subscription_expired, not_covered, already_redeemed, no_sessions_left · 429 çok sık istek

packages.release

Seansı geri ver — Yanlışlıkla düşülen bir seansı geri alır. Randevunun kendisine dokunulmaz.

Gereken izin packages:write · siler ya da geri alınamaz · Era çalıştırırken bir kişiye onaylatır

• Asıl adres: POST /api/v1/actions/packages.release

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: packages.session_released

Neye yazar: package_usage (delete) — Removes the usage

curl -X POST https://app.getera.io/api/v1/package_usages/PACKAGE_USAGE_ID/actions/release \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "packages.session_released"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.packageUsages.release("PACKAGE_USAGE_ID")

era package_usages release PACKAGE_USAGE_ID

{
  "name": "era__packages__release",
  "arguments": {
    "usageId": "PACKAGE_USAGE_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde packages:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 usage_not_found · 429 çok sık istek

packages.retire_package

Satıştan kaldır — Satışı durdurur. Devam eden abonelikler bitiş tarihlerine kadar sürer.

Gereken izin packages:manage · dışarıya ulaşır (gönderir, yayımlar ya da ücret alır) · Era çalıştırırken bir kişiye onaylatır

• Asıl adres: POST /api/v1/actions/packages.retire_package

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: packages.package_retired

Neye yazar: package (update) — Stamps archived_at

curl -X POST https://app.getera.io/api/v1/packages/PACKAGE_ID/actions/retire_package \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "packages.package_retired"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.packages.retirePackage("PACKAGE_ID")

era packages retire_package PACKAGE_ID

{
  "name": "era__packages__retire_package",
  "arguments": {
    "id": "PACKAGE_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde packages:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_found, package_retired · 429 çok sık istek

packages.set_items

Kapsamı değiştir — Paketteki hizmet ve dersler, her birinden kaç seansla.

Gereken izin packages:manage · siler ya da geri alınamaz

• Asıl adres: POST /api/v1/actions/packages.set_items

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: packages.package_updated

Neye yazar: package_item (delete) — Clears the old contents; package_item (insert) — Writes the new contents

curl -X POST https://app.getera.io/api/v1/package_items/actions/set_items \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"id":"PACKAGE_ID","items":{}}'

{
  "ok": true,
  "result": "…",
  "events": [
    "packages.package_updated"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.packageItems.setItems({
  id: "PACKAGE_ID",
  items: {}
})

era package_items set_items --data '{"id":"PACKAGE_ID","items":{}}'

{
  "name": "era__packages__set_items",
  "arguments": {
    "id": "PACKAGE_ID",
    "items": {}
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde packages:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_found, package_retired, invalid_items, service_not_found, class_not_found, items_in_use · 429 çok sık istek

packages.update_package

Paketi düzenle — Ad, dönem, fiyat ve varsayılan yenileme — yalnızca yeni satışlar için.

Gereken izin packages:manage · veriyi değiştirir

• REST kısayolu: PATCH /api/v1/packages/{id}
• Asıl adres: POST /api/v1/actions/packages.update_package

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: packages.package_updated

Neye yazar: package (update) — Updates the package

curl -X POST https://app.getera.io/api/v1/packages/PACKAGE_ID/actions/update_package \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"name":"Name"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "packages.package_updated"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.packages.updatePackage("PACKAGE_ID", {
  name: "Name"
})

era packages update_package PACKAGE_ID \
  --name "Name"

{
  "name": "era__packages__update_package",
  "arguments": {
    "id": "PACKAGE_ID",
    "name": "Name"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde packages:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_found, package_retired · 429 çok sık istek

packages.use_on_my_booking

Paketimi kullan — Giriş yapmış müşteri, yeni aldığı randevuyu seansı kalmışsa paketinden karşılar.

Gereken izin packages:write · veriyi değiştirir · Yayındaki bir siteden de çağrılabilir (customer)

• Asıl adres: POST /api/v1/actions/packages.use_on_my_booking

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: packages.session_used, packages.almost_used_up

Neye yazar: package_usage (insert) — Records the session drawn

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde packages:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_your_booking, no_sessions_left · 429 çok sık istek

Veri modelleri

PackageItem

Tablo package_item · Kaynak package_items

• GET /api/v1/package_items
• GET /api/v1/package_items/{id}

Birincil anahtar: id

Denetimler:

• CHECK ((num_nonnulls(item_variant_id, group_class_id) = 1))
• CHECK (((sessions_per_period IS NULL) OR (sessions_per_period > 0)))

PackageUsage

Tablo package_usage · Kaynak package_usages

• GET /api/v1/package_usages
• GET /api/v1/package_usages/{id}

Birincil anahtar: id

Tekil: record_type, record_id

Package

Tablo package · Kaynak packages

• GET /api/v1/packages
• GET /api/v1/packages/{id}
• POST /api/v1/packages → packages.create_package
• PATCH /api/v1/packages/{id} → packages.update_package

Birincil anahtar: id

Denetimler:

• CHECK (((length(btrim(name)) >= 1) AND (length(btrim(name)) <= 255)))
• CHECK ((period_months > 0))
• CHECK ((price_amount >= 0))

Olaylar

İş akışları ve webhook'lar bu olaylara tepki verir.