client.org
client.org
client.org împachetează /api/v1/org/* — profilul organizației apelante, locațiile sale și setările sale de notificări prin email. Vezi documentația REST corespondentă la API Organizații.
Eșecurile la nivel HTTP apar ca EBonApiError — vezi Erori și /ro/api/errors.
client.org.get()
Obține organizația curentă.
async get(): Promise<Organization>
Fără parametri. Returnează Organization-ul curent.
const org = await client.org.get();
client.org.update(body)
Actualizează proprietățile organizației.
async update(body: UpdateOrgBody): Promise<Organization>
| Nume | Tip | Obligatoriu | Note |
|---|---|---|---|
name | string | nu | Redenumește organizația. |
billingAddress | BillingAddress | nu | Înlocuiește adresa de facturare completă. |
Returnează Organization-ul actualizat.
await client.org.update({ name: 'ACME SRL' });
client.org.listLocations()
Listează toate locațiile.
async listLocations(): Promise<Location[]>
Fără parametri. Returnează un tablou de Location.
const locations = await client.org.listLocations();
client.org.createLocation(body)
Creează o locație nouă.
async createLocation(body: CreateLocationBody): Promise<Location>
| Nume | Tip | Obligatoriu | Note |
|---|---|---|---|
name | string | da | Etichetă lizibilă. |
address | string | da | Adresa poștală (un singur șir). |
Returnează Location-ul creat.
await client.org.createLocation({ name: 'Cluj HQ', address: 'Strada Memorandumului 1' });
client.org.updateLocation(id, body)
Actualizează o locație.
async updateLocation(id: string, body: UpdateLocationBody): Promise<Location>
| Nume | Tip | Obligatoriu | Note |
|---|---|---|---|
name | string | nu | Redenumește locația. |
address | string | nu | Înlocuiește adresa poștală. |
Returnează Location-ul actualizat.
await client.org.updateLocation('loc_01HZ...', { name: 'Cluj HQ' });
client.org.deleteLocation(id)
Șterge o locație.
async deleteLocation(id: string): Promise<undefined>
| Nume | Tip | Obligatoriu | Note |
|---|---|---|---|
id | string | da | Identificatorul locației. |
Returnează undefined la succes.
await client.org.deleteLocation('loc_01HZ...');
client.org.getNotificationSettings()
Obține setările de notificări.
async getNotificationSettings(): Promise<NotificationSettings>
Fără parametri. Returnează { subscribers: NotificationSubscriber[] } — fiecare email și categoriile pe care le primește.
const { subscribers } = await client.org.getNotificationSettings();
client.org.updateNotificationSettings(body)
Actualizează setările de notificări.
async updateNotificationSettings(body: UpdateNotificationSettingsBody): Promise<NotificationSettings>
| Nume | Tip | Obligatoriu | Note |
|---|---|---|---|
subscribers | NotificationSubscriber[] | da | Listă de înlocuire completă — fiecare intrare este { email, categories: NotificationCategory[] }. |
Returnează NotificationSettings-ul actualizat. NotificationCategory este una dintre 'reports' | 'alerts' | 'billing' | 'device_events' | 'analytics'.
await client.org.updateNotificationSettings({
subscribers: [
{ email: 'ops@example.com', categories: ['alerts', 'device_events'] },
{ email: 'finance@example.com', categories: ['reports', 'billing'] },
],
});