docs.jsonld
type: ApiDocumentation
title: Braxen API
description: Braxen API - Nowoczesne rozwiązanie do automatyzacji SMS i e-mail marketing. ## Autoryzacja - WAŻNE! **KLUCZ API JEST SPECYFICZNY DLA PROJEKTU BĄDŹ SMS API!** Każdy projekt w systemie Braxen posiada swój własny, unikalny klucz API (X-API-KEY). - Klucz przypisany do Projektu A **NIE BĘDZIE** działał dla Projektu B - Jeden klucz API = Jeden projekt - Aby zarządzać wieloma projektami, potrzebujesz osobnego klucza dla każdego z nich Większość endpointów wymaga autoryzacji za pomocą klucza API przekazanego w nagłówku `X-API-KEY`. Klucz API można znaleźć w panelu zarządzania projektem bądź w panelu zarzadzania SMS API. ## Funkcjonalności - **Projects** - Zarządzanie projektami i kluczami API (ZACZNIJ OD TEGO!) - **Contacts** - Zarządzanie kontaktami i grupami kontaktów - **SMS Queue** - Wysyłanie pojedynczych i masowych SMS-ów - **SMS History** - Historia wysłanych wiadomości SMS - **SMS Status** - Sprawdzanie statusu wiadomości ## Workflow 1. Pobierz listę swoich projektów: `GET /api/projects` 2. Wybierz projekt i użyj jego klucza API (X-API-KEY) 3. Wykonuj operacje tylko na zasobach tego projektu ## Format odpowiedzi Wszystkie odpowiedzi API są zwracane w formacie JSON. ## Kody błędów - `400` - Błąd walidacji danych wejściowych - `401` - Brak lub nieprawidłowy klucz API / Klucz nie pasuje do projektu - `403` - Brak uprawnień do zasobu - `404` - Nie znaleziono zasobu - `500` - Błąd serwera
entrypoint: /api
supported class: Error
supported class: ConstraintViolation
supported class: Contact
supported class: ContactGroup
supported class: EmailCampaign
supported class: UserEmail
supported class: Project
supported class: SmsQueue
supported class: SmsQueueHistory
supported class: Entrypoint
supported class: ConstraintViolationList

Error
type: Class
title: Error
supported property: SupportedProperty
  property: Error/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/title
  title: title
  required: false
  readable: true
  writeable: false
  description: A short, human-readable summary of the problem.
supported property: SupportedProperty
  property: Error/detail
  title: detail
  required: false
  readable: true
  writeable: false
  description: A human-readable explanation specific to this occurrence of the problem.
supported property: SupportedProperty
  property: Error/instance
  title: instance
  required: false
  readable: true
  writeable: false
  description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
supported property: SupportedProperty
  property: Error/type
  title: type
  required: false
  readable: true
  writeable: false
  description: A URI reference that identifies the problem type
supported property: SupportedProperty
  property: Error/meta
  title: meta
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/source
  title: source
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/message
  title: message
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/code
  title: code
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/file
  title: file
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/line
  title: line
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Error resource.
  method: GET
  returns: Error
  title: getError
description: A representation of common errors.
subclass of: Error

Error/id
type: Property
domain: Error
the hydra core vocabulary: id
range: string

Error/title
type: Property
domain: Error
the hydra core vocabulary: title
range: string

Error/detail
type: Property
domain: Error
the hydra core vocabulary: detail
range: string

Error/instance
type: Property
domain: Error
the hydra core vocabulary: instance
range: string

Error/type
type: Property
domain: Error
the hydra core vocabulary: type
range: string

Error/meta
type: Property
domain: Error
the hydra core vocabulary: meta

Error/source
type: Property
domain: Error
the hydra core vocabulary: source

Error/description
type: Property
domain: Error
the hydra core vocabulary: description
range: string

Error/trace
type: Property
domain: Error
the hydra core vocabulary: trace

Error/message
type: Property
domain: Error
the hydra core vocabulary: message
range: string

Error/code
type: Property
domain: Error
the hydra core vocabulary: code
range: integer

Error/file
type: Property
domain: Error
the hydra core vocabulary: file
range: string

Error/line
type: Property
domain: Error
the hydra core vocabulary: line
range: integer

ConstraintViolation
type: Class
title: ConstraintViolation
supported property: SupportedProperty
  property: ConstraintViolation/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/errorTitle
  title: errorTitle
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/violations
  title: violations
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/detail
  title: detail
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/message
  title: message
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/code
  title: code
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/file
  title: file
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/line
  title: line
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/title
  title: title
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/instance
  title: instance
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/statusCode
  title: statusCode
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/headers
  title: headers
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/previous
  title: previous
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
description: Unprocessable entity
subclass of: Error

ConstraintViolation/status
type: Property
domain: ConstraintViolation
the hydra core vocabulary: status
range: integer

ConstraintViolation/errorTitle
type: Property
domain: ConstraintViolation
the hydra core vocabulary: errorTitle
range: string

ConstraintViolation/violations
type: Property
domain: ConstraintViolation
the hydra core vocabulary: violations
range: ConstraintViolationList

ConstraintViolation/detail
type: Property
domain: ConstraintViolation
the hydra core vocabulary: detail
range: string

ConstraintViolation/message
type: Property
domain: ConstraintViolation
the hydra core vocabulary: message
range: string

ConstraintViolation/code
type: Property
domain: ConstraintViolation
the hydra core vocabulary: code
range: string
range: integer

ConstraintViolation/file
type: Property
domain: ConstraintViolation
the hydra core vocabulary: file
range: string

ConstraintViolation/line
type: Property
domain: ConstraintViolation
the hydra core vocabulary: line
range: integer

ConstraintViolation/description
type: Property
domain: ConstraintViolation
the hydra core vocabulary: description
range: string

ConstraintViolation/type
type: Property
domain: ConstraintViolation
the hydra core vocabulary: type
range: string

ConstraintViolation/title
type: Property
domain: ConstraintViolation
the hydra core vocabulary: title
range: string

ConstraintViolation/instance
type: Property
domain: ConstraintViolation
the hydra core vocabulary: instance
range: string

ConstraintViolation/statusCode
type: Property
domain: ConstraintViolation
the hydra core vocabulary: statusCode
range: integer

ConstraintViolation/headers
type: Property
domain: ConstraintViolation
the hydra core vocabulary: headers

ConstraintViolation/trace
type: Property
domain: ConstraintViolation
the hydra core vocabulary: trace

ConstraintViolation/previous
type: Property
domain: ConstraintViolation
the hydra core vocabulary: previous
range: integer

Contact
type: Class
title: Contact
supported property: SupportedProperty
  property: Contact/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Contact/phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Contact/email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Contact/description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Contact/groupMemberships
  title: groupMemberships
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Contact/unsubscriptions
  title: unsubscriptions
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Contact/emailCampaignQueue
  title: emailCampaignQueue
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Contact/user
  title: user
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Contact/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Contact/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Contact/unsubscribedAt
  title: unsubscribedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Contact/isSoftBounced
  title: isSoftBounced
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: Contact/lastSoftBounceAt
  title: lastSoftBounceAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Contact/isHardBounced
  title: isHardBounced
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: Contact/lastHardBounceAt
  title: lastHardBounceAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Contact/hasSmsConsent
  title: hasSmsConsent
  required: false
  readable: false
  writeable: true
  description: Zgoda na wysyłkę SMS marketingowych (RODO) UWAGA: SMS wysyłane są TYLKO na polskie numery telefonu (+48)
supported property: SupportedProperty
  property: Contact/smsConsentDate
  title: smsConsentDate
  required: false
  readable: true
  writeable: true
  description: Data udzielenia zgody na SMS
supported property: SupportedProperty
  property: Contact/smsConsentSource
  title: smsConsentSource
  required: false
  readable: true
  writeable: true
  description: Źródło zgody SMS: 'manual', 'import', 'api', 'form', 'double_opt_in', 'legacy_import' WYMAGANE dla RODO Art. 7.1 - administrator musi wiedzieć SKĄD pochodzi zgoda
supported property: SupportedProperty
  property: Contact/smsConsentText
  title: smsConsentText
  required: false
  readable: true
  writeable: true
  description: Pełna treść zgody SMS (RODO Art. 7.1 - dowód zgody) Przechowujemy dokładną treść klauzuli, którą użytkownik zaakceptował Wymóg: administrator musi być w stanie wykazać, na CO DOKŁADNIE użytkownik wyraził zgodę WYMAGANE dla RODO Art. 7.1
supported property: SupportedProperty
  property: Contact/smsConsentIpAddress
  title: smsConsentIpAddress
  required: false
  readable: true
  writeable: true
  description: Adres IP z którego udzielono zgody SMS (wymóg RODO - Art. 7.1) Przechowywane do celów dowodowych w przypadku kontroli UODO WYMAGANE dla RODO Art. 7.1 - dowód SKĄD została udzielona zgoda
supported property: SupportedProperty
  property: Contact/smsConsentUserAgent
  title: smsConsentUserAgent
  required: false
  readable: true
  writeable: true
  description: User Agent przeglądarki z której udzielono zgody SMS Dodatkowe zabezpieczenie zgodności z RODO - pełna ścieżka audytu WYMAGANE dla pełnego audytu RODO
supported property: SupportedProperty
  property: Contact/smsUnsubscribedAt
  title: smsUnsubscribedAt
  required: false
  readable: true
  writeable: true
  description: Data rezygnacji z SMS (unsubscribe)
supported property: SupportedProperty
  property: Contact/smsUnsubscribeReason
  title: smsUnsubscribeReason
  required: false
  readable: true
  writeable: true
  description: Powód rezygnacji z SMS: 'user_request', 'admin_removal', 'gdpr_request', 'spam_complaint'
supported property: SupportedProperty
  property: Contact/createdFromIp
  title: createdFromIp
  required: false
  readable: true
  writeable: true
  description: Adres IP z którego dodano kontakt (wymóg RODO - Art. 30) Rejestr czynności przetwarzania - obowiązek administratora danych
supported property: SupportedProperty
  property: Contact/lastUpdatedFromIp
  title: lastUpdatedFromIp
  required: false
  readable: true
  writeable: true
  description: Adres IP ostatniej aktualizacji kontaktu Pełna historia zmian dla zgodności z RODO
supported property: SupportedProperty
  property: Contact/fullName
  title: fullName
  required: false
  readable: true
  writeable: false
  description: Zwraca pełną nazwę kontaktu
supported property: SupportedProperty
  property: Contact/contactGroups
  title: contactGroups
  required: false
  readable: true
  writeable: false
  description: Zwraca wszystkie grupy kontaktów do których należy kontakt
supported property: SupportedProperty
  property: Contact/activeContactGroups
  title: activeContactGroups
  required: false
  readable: true
  writeable: false
  description: Zwraca tylko aktywne grupy kontaktów
supported property: SupportedProperty
  property: Contact/inGroup
  title: inGroup
  required: false
  readable: false
  writeable: false
  description: Sprawdza czy kontakt należy do grupy
supported property: SupportedProperty
  property: Contact/activeGroupsCount
  title: activeGroupsCount
  required: false
  readable: true
  writeable: false
  description: Zwraca liczbę aktywnych grup
supported property: SupportedProperty
  property: Contact/createdAtValue
  title: createdAtValue
  required: false
  readable: false
  writeable: false
supported operation: Operation
description: Kontakty - zarządzanie odbiorcami w grupach kontaktów. UWAGA: Klucz API (X-API-KEY) jest przypisany do konkretnego projektu. Jeden klucz API działa tylko dla jednego projektu!

Contact/name
type: Property
domain: Contact
the hydra core vocabulary: name
range: string

Contact/phoneNumber
type: Property
domain: Contact
the hydra core vocabulary: phoneNumber
range: string

Contact/email
type: Property
domain: Contact
the hydra core vocabulary: email
range: string

Contact/description
type: Property
domain: Contact
the hydra core vocabulary: description
range: string

Contact/groupMemberships
type: Property
domain: Contact
the hydra core vocabulary: groupMemberships

Contact/unsubscriptions
type: Property
domain: Contact
the hydra core vocabulary: unsubscriptions

Contact/emailCampaignQueue
type: Property
domain: Contact
the hydra core vocabulary: emailCampaignQueue

Contact/user
type: Property
domain: Contact
the hydra core vocabulary: user

Contact/createdAt
type: Property
domain: Contact
the hydra core vocabulary: createdAt
range: dateTime

Contact/updatedAt
type: Property
domain: Contact
the hydra core vocabulary: updatedAt
range: dateTime

Contact/unsubscribedAt
type: Property
domain: Contact
the hydra core vocabulary: unsubscribedAt
range: dateTime

Contact/isSoftBounced
type: Property
domain: Contact
the hydra core vocabulary: isSoftBounced
range: boolean

Contact/lastSoftBounceAt
type: Property
domain: Contact
the hydra core vocabulary: lastSoftBounceAt
range: dateTime

Contact/isHardBounced
type: Property
domain: Contact
the hydra core vocabulary: isHardBounced
range: boolean

Contact/lastHardBounceAt
type: Property
domain: Contact
the hydra core vocabulary: lastHardBounceAt
range: dateTime

Contact/hasSmsConsent
type: Property
domain: Contact
the hydra core vocabulary: hasSmsConsent
range: boolean

Contact/smsConsentDate
type: Property
domain: Contact
the hydra core vocabulary: smsConsentDate
range: dateTime

Contact/smsConsentSource
type: Property
domain: Contact
the hydra core vocabulary: smsConsentSource
range: string

Contact/smsConsentText
type: Property
domain: Contact
the hydra core vocabulary: smsConsentText
range: string

Contact/smsConsentIpAddress
type: Property
domain: Contact
the hydra core vocabulary: smsConsentIpAddress
range: string

Contact/smsConsentUserAgent
type: Property
domain: Contact
the hydra core vocabulary: smsConsentUserAgent
range: string

Contact/smsUnsubscribedAt
type: Property
domain: Contact
the hydra core vocabulary: smsUnsubscribedAt
range: dateTime

Contact/smsUnsubscribeReason
type: Property
domain: Contact
the hydra core vocabulary: smsUnsubscribeReason
range: string

Contact/createdFromIp
type: Property
domain: Contact
the hydra core vocabulary: createdFromIp
range: string

Contact/lastUpdatedFromIp
type: Property
domain: Contact
the hydra core vocabulary: lastUpdatedFromIp
range: string

Contact/fullName
type: Property
domain: Contact
the hydra core vocabulary: fullName
range: string

Contact/contactGroups
type: Link
domain: Contact
the hydra core vocabulary: contactGroups
range: ContactGroup

Contact/activeContactGroups
type: Link
domain: Contact
the hydra core vocabulary: activeContactGroups
range: ContactGroup

Contact/inGroup
type: Property
domain: Contact
the hydra core vocabulary: inGroup

Contact/activeGroupsCount
type: Property
domain: Contact
the hydra core vocabulary: activeGroupsCount
range: integer

Contact/createdAtValue
type: Property
domain: Contact
the hydra core vocabulary: createdAtValue

Contact/updatedAtValue
type: Property
domain: Contact
the hydra core vocabulary: updatedAtValue

Contact/unsubscribedFromProject
type: Property
domain: Contact
the hydra core vocabulary: unsubscribedFromProject

Contact/unsubscribedProjects
type: Property
domain: Contact
the hydra core vocabulary: unsubscribedProjects

Contact/softBounced
type: Property
domain: Contact
the hydra core vocabulary: softBounced
range: boolean

Contact/hardBounced
type: Property
domain: Contact
the hydra core vocabulary: hardBounced
range: boolean

Contact/smsConsent
type: Property
domain: Contact
the hydra core vocabulary: smsConsent
range: boolean

Contact/polishPhoneNumber
type: Property
domain: Contact
the hydra core vocabulary: polishPhoneNumber
range: boolean

ContactGroup
type: Class
title: ContactGroup
supported property: SupportedProperty
  property: ContactGroup/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ContactGroup/description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ContactGroup/user
  title: user
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ContactGroup/project
  title: project
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ContactGroup/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ContactGroup/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ContactGroup/contactMemberships
  title: contactMemberships
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ContactGroup/emailCampaigns
  title: emailCampaigns
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ContactGroup/defaultSmsConsent
  title: defaultSmsConsent
  required: false
  readable: true
  writeable: true
  description: Domyślna zgoda na SMS dla nowych kontaktów w grupie (RODO) Gdy TRUE - nowe kontakty dodawane do grupy automatycznie otrzymują zgodę SMS Dotyczy TYLKO polskich numerów (+48)
supported property: SupportedProperty
  property: ContactGroup/smsConsentUpdatedAt
  title: smsConsentUpdatedAt
  required: false
  readable: true
  writeable: true
  description: Data ostatniej zmiany ustawień zgody SMS dla grupy
supported property: SupportedProperty
  property: ContactGroup/contacts
  title: contacts
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ContactGroup/activeContacts
  title: activeContacts
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ContactGroup/createdAtValue
  title: createdAtValue
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: ContactGroup/updatedAtValue
  title: updatedAtValue
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: ContactGroup/contactsCount
  title: contactsCount
  required: false
  readable: true
  writeable: false
  description: Zwraca liczbę kontaktów w grupie
supported property: SupportedProperty
  property: ContactGroup/allMembershipsCount
  title: allMembershipsCount
  required: false
  readable: true
  writeable: false
  description: Zwraca liczbę wszystkich członkostw (włącznie z nieaktywnymi)
supported property: SupportedProperty
  property: ContactGroup/contact
  title: contact
  required: false
  readable: false
  writeable: true
  description: Sprawdza czy kontakt jest w grupie
supported property: SupportedProperty
  property: ContactGroup/phoneNumbers
  title: phoneNumbers
  required: false
  readable: true
  writeable: false
  description: Zwraca wszystkie numery telefonów z grupy
supported property: SupportedProperty
  property: ContactGroup/contactsWithSmsConsent
  title: contactsWithSmsConsent
  required: false
  readable: true
  writeable: false
  description: Zwraca kontakty z tej grupy które mają zgodę na SMS UWAGA: Sprawdza TYLKO kontakty z polskimi numerami (+48)
supported property: SupportedProperty
  property: ContactGroup/smsConsentContactsCount
  title: smsConsentContactsCount
  required: false
  readable: true
  writeable: false
  description: Liczba kontaktów z polskimi numerami i zgodą SMS
supported operation: Operation
  type: FindAction
  description: Retrieves a ContactGroup resource.
  method: GET
  returns: ContactGroup
  title: getContactGroup
description: Grupy kontaktów do organizacji i zarządzania odbiorcami kampanii

ContactGroup/name
type: Property
domain: ContactGroup
the hydra core vocabulary: name
range: string

ContactGroup/description
type: Property
domain: ContactGroup
the hydra core vocabulary: description
range: string

ContactGroup/user
type: Property
domain: ContactGroup
the hydra core vocabulary: user

ContactGroup/project
type: Link
domain: ContactGroup
the hydra core vocabulary: project
max cardinality: 1
range: Project

ContactGroup/createdAt
type: Property
domain: ContactGroup
the hydra core vocabulary: createdAt
range: dateTime

ContactGroup/updatedAt
type: Property
domain: ContactGroup
the hydra core vocabulary: updatedAt
range: dateTime

ContactGroup/contactMemberships
type: Property
domain: ContactGroup
the hydra core vocabulary: contactMemberships

ContactGroup/emailCampaigns
type: Link
domain: ContactGroup
the hydra core vocabulary: emailCampaigns
range: EmailCampaign

ContactGroup/defaultSmsConsent
type: Property
domain: ContactGroup
the hydra core vocabulary: defaultSmsConsent
range: boolean

ContactGroup/smsConsentUpdatedAt
type: Property
domain: ContactGroup
the hydra core vocabulary: smsConsentUpdatedAt
range: dateTime

ContactGroup/contacts
type: Link
domain: ContactGroup
the hydra core vocabulary: contacts
range: Contact

ContactGroup/activeContacts
type: Link
domain: ContactGroup
the hydra core vocabulary: activeContacts
range: Contact

ContactGroup/createdAtValue
type: Property
domain: ContactGroup
the hydra core vocabulary: createdAtValue

ContactGroup/updatedAtValue
type: Property
domain: ContactGroup
the hydra core vocabulary: updatedAtValue

ContactGroup/contactsCount
type: Property
domain: ContactGroup
the hydra core vocabulary: contactsCount
range: integer

ContactGroup/allMembershipsCount
type: Property
domain: ContactGroup
the hydra core vocabulary: allMembershipsCount
range: integer

ContactGroup/contact
type: Link
domain: ContactGroup
the hydra core vocabulary: contact
range: Contact

ContactGroup/phoneNumbers
type: Property
domain: ContactGroup
the hydra core vocabulary: phoneNumbers

ContactGroup/contactsWithSmsConsent
type: Property
domain: ContactGroup
the hydra core vocabulary: contactsWithSmsConsent

ContactGroup/smsConsentContactsCount
type: Property
domain: ContactGroup
the hydra core vocabulary: smsConsentContactsCount
range: integer

EmailCampaign
type: Class
title: EmailCampaign
supported property: SupportedProperty
  property: EmailCampaign/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EmailCampaign/subject
  title: subject
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EmailCampaign/bodyHtml
  title: bodyHtml
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EmailCampaign/bodyDragDrop
  title: bodyDragDrop
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EmailCampaign/editorType
  title: editorType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EmailCampaign/contactGroup
  title: contactGroup
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EmailCampaign/status
  title: status
  required: false
  readable: true
  writeable: true
  description: Status: draft, scheduled, sending, completed, failed, cancelled
supported property: SupportedProperty
  property: EmailCampaign/totalRecipients
  title: totalRecipients
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EmailCampaign/sentCount
  title: sentCount
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EmailCampaign/failedCount
  title: failedCount
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EmailCampaign/pendingCount
  title: pendingCount
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EmailCampaign/readCount
  title: readCount
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EmailCampaign/clickedCount
  title: clickedCount
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EmailCampaign/cancelledCount
  title: cancelledCount
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EmailCampaign/oldEmailCampaignStats
  title: oldEmailCampaignStats
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EmailCampaign/followUps
  title: followUps
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EmailCampaign/currentStep
  title: currentStep
  required: false
  readable: true
  writeable: true
  description: Aktualny etap wysyłki: 0 = główna kampania, 1 = follow-up #1, 2 = follow-up #2, .
supported property: SupportedProperty
  property: EmailCampaign/selectedSenderIds
  title: selectedSenderIds
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EmailCampaign/replyCount
  title: replyCount
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EmailCampaign/scheduledAt
  title: scheduledAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EmailCampaign/startedAt
  title: startedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EmailCampaign/completedAt
  title: completedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EmailCampaign/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: EmailCampaign/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: EmailCampaign/emailTemplate
  title: emailTemplate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EmailCampaign/queueItems
  title: queueItems
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EmailCampaign/historyItems
  title: historyItems
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EmailCampaign/updatedAtValue
  title: updatedAtValue
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: EmailCampaign/progress
  title: progress
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: EmailCampaign/completed
  title: completed
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: EmailCampaign/sending
  title: sending
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: EmailCampaign/successRate
  title: successRate
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: EmailCampaign/resendCount
  title: resendCount
  required: false
  readable: true
  writeable: false
  description: Zlicza ile razy kampania była wysyłana ponownie
supported operation: Operation
description: Kampanie e-mail - przeglądaj kampanie i ich statystyki

EmailCampaign/name
type: Property
domain: EmailCampaign
the hydra core vocabulary: name
range: string

EmailCampaign/subject
type: Property
domain: EmailCampaign
the hydra core vocabulary: subject
range: string

EmailCampaign/bodyHtml
type: Property
domain: EmailCampaign
the hydra core vocabulary: bodyHtml
range: string

EmailCampaign/bodyDragDrop
type: Property
domain: EmailCampaign
the hydra core vocabulary: bodyDragDrop
range: string

EmailCampaign/editorType
type: Property
domain: EmailCampaign
the hydra core vocabulary: editorType
range: string

EmailCampaign/contactGroup
type: Link
domain: EmailCampaign
the hydra core vocabulary: contactGroup
max cardinality: 1
range: ContactGroup

EmailCampaign/status
type: Property
domain: EmailCampaign
the hydra core vocabulary: status
range: string

EmailCampaign/totalRecipients
type: Property
domain: EmailCampaign
the hydra core vocabulary: totalRecipients
range: integer

EmailCampaign/sentCount
type: Property
domain: EmailCampaign
the hydra core vocabulary: sentCount
range: integer

EmailCampaign/failedCount
type: Property
domain: EmailCampaign
the hydra core vocabulary: failedCount
range: integer

EmailCampaign/pendingCount
type: Property
domain: EmailCampaign
the hydra core vocabulary: pendingCount
range: integer

EmailCampaign/readCount
type: Property
domain: EmailCampaign
the hydra core vocabulary: readCount
range: integer

EmailCampaign/clickedCount
type: Property
domain: EmailCampaign
the hydra core vocabulary: clickedCount
range: integer

EmailCampaign/cancelledCount
type: Property
domain: EmailCampaign
the hydra core vocabulary: cancelledCount
range: integer

EmailCampaign/oldEmailCampaignStats
type: Property
domain: EmailCampaign
the hydra core vocabulary: oldEmailCampaignStats
range: string

EmailCampaign/followUps
type: Property
domain: EmailCampaign
the hydra core vocabulary: followUps
range: string

EmailCampaign/currentStep
type: Property
domain: EmailCampaign
the hydra core vocabulary: currentStep
range: integer

EmailCampaign/selectedSenderIds
type: Property
domain: EmailCampaign
the hydra core vocabulary: selectedSenderIds
range: string

EmailCampaign/replyCount
type: Property
domain: EmailCampaign
the hydra core vocabulary: replyCount
range: integer

EmailCampaign/scheduledAt
type: Property
domain: EmailCampaign
the hydra core vocabulary: scheduledAt
range: dateTime

EmailCampaign/startedAt
type: Property
domain: EmailCampaign
the hydra core vocabulary: startedAt
range: dateTime

EmailCampaign/completedAt
type: Property
domain: EmailCampaign
the hydra core vocabulary: completedAt
range: dateTime

EmailCampaign/createdAt
type: Property
domain: EmailCampaign
the hydra core vocabulary: createdAt
range: dateTime

EmailCampaign/updatedAt
type: Property
domain: EmailCampaign
the hydra core vocabulary: updatedAt
range: dateTime

EmailCampaign/emailTemplate
type: Property
domain: EmailCampaign
the hydra core vocabulary: emailTemplate

EmailCampaign/queueItems
type: Property
domain: EmailCampaign
the hydra core vocabulary: queueItems

EmailCampaign/historyItems
type: Property
domain: EmailCampaign
the hydra core vocabulary: historyItems

EmailCampaign/updatedAtValue
type: Property
domain: EmailCampaign
the hydra core vocabulary: updatedAtValue

EmailCampaign/progress
type: Property
domain: EmailCampaign
the hydra core vocabulary: progress
range: string

EmailCampaign/completed
type: Property
domain: EmailCampaign
the hydra core vocabulary: completed
range: boolean

EmailCampaign/sending
type: Property
domain: EmailCampaign
the hydra core vocabulary: sending
range: boolean

EmailCampaign/successRate
type: Property
domain: EmailCampaign
the hydra core vocabulary: successRate
range: decimal

EmailCampaign/resendCount
type: Property
domain: EmailCampaign
the hydra core vocabulary: resendCount
range: integer

EmailCampaign/selectedSenderIdsArray
type: Property
domain: EmailCampaign
the hydra core vocabulary: selectedSenderIdsArray
range: integer

EmailCampaign/oldStatsArray
type: Property
domain: EmailCampaign
the hydra core vocabulary: oldStatsArray

EmailCampaign/activeContent
type: Property
domain: EmailCampaign
the hydra core vocabulary: activeContent
range: string

EmailCampaign/success
type: Property
domain: EmailCampaign
the hydra core vocabulary: success
range: boolean

EmailCampaign/campaigns
type: Property
domain: EmailCampaign
the hydra core vocabulary: campaigns

EmailCampaign/total
type: Property
domain: EmailCampaign
the hydra core vocabulary: total
range: integer

EmailCampaign/message
type: Property
domain: EmailCampaign
the hydra core vocabulary: message
range: string

UserEmail
type: Class
title: UserEmail
supported property: SupportedProperty
  property: UserEmail/user
  title: user
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: UserEmail/senderEmail
  title: senderEmail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: UserEmail/senderLabel
  title: senderLabel
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: UserEmail/senderName
  title: senderName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: UserEmail/senderPass
  title: senderPass
  required: false
  readable: true
  writeable: true
  description: Zaszyfrowane hasło email (używane do wysyłania SMTP)
supported property: SupportedProperty
  property: UserEmail/senderHost
  title: senderHost
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: UserEmail/senderPort
  title: senderPort
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: UserEmail/receiverHost
  title: receiverHost
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: UserEmail/receiverPort
  title: receiverPort
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: UserEmail/isActive
  title: isActive
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: UserEmail/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: UserEmail/lastBounceCheckAt
  title: lastBounceCheckAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: UserEmail/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: UserEmail/lastUsedAt
  title: lastUsedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: UserEmail/lastSyncAt
  title: lastSyncAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: UserEmail/projects
  title: projects
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: UserEmail/emailCampaignQueue
  title: emailCampaignQueue
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: UserEmail/emailCampaignHistory
  title: emailCampaignHistory
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: UserEmail/active
  title: active
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: UserEmail/fullSenderName
  title: fullSenderName
  required: false
  readable: true
  writeable: false
  description: Zwraca pełną nazwę nadawcy z adresem email
supported property: SupportedProperty
  property: UserEmail/maskedPassword
  title: maskedPassword
  required: false
  readable: true
  writeable: false
  description: Zwraca zamaskowaną wersję hasła (do wyświetlania)
supported property: SupportedProperty
  property: UserEmail/validSmtpConfig
  title: validSmtpConfig
  required: false
  readable: true
  writeable: false
  description: Sprawdza czy konfiguracja SMTP jest kompletna
supported property: SupportedProperty
  property: UserEmail/validImapConfig
  title: validImapConfig
  required: false
  readable: true
  writeable: false
  description: Sprawdza czy konfiguracja IMAP jest kompletna
supported property: SupportedProperty
  property: UserEmail/success
  title: success
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: UserEmail/userEmails
  title: userEmails
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: UserEmail/total
  title: total
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: UserEmail/message
  title: message
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a UserEmail resource.
  method: GET
  returns: UserEmail
  title: getUserEmail
description: Skrzynki pocztowe - przeglądaj konfiguracje bez dostępu do wrażliwych danych

UserEmail/user
type: Property
domain: UserEmail
the hydra core vocabulary: user

UserEmail/senderEmail
type: Property
domain: UserEmail
the hydra core vocabulary: senderEmail
range: string

UserEmail/senderLabel
type: Property
domain: UserEmail
the hydra core vocabulary: senderLabel
range: string

UserEmail/senderName
type: Property
domain: UserEmail
the hydra core vocabulary: senderName
range: string

UserEmail/senderPass
type: Property
domain: UserEmail
the hydra core vocabulary: senderPass
range: string

UserEmail/senderHost
type: Property
domain: UserEmail
the hydra core vocabulary: senderHost
range: string

UserEmail/senderPort
type: Property
domain: UserEmail
the hydra core vocabulary: senderPort
range: string

UserEmail/receiverHost
type: Property
domain: UserEmail
the hydra core vocabulary: receiverHost
range: string

UserEmail/receiverPort
type: Property
domain: UserEmail
the hydra core vocabulary: receiverPort
range: string

UserEmail/isActive
type: Property
domain: UserEmail
the hydra core vocabulary: isActive
range: boolean

UserEmail/createdAt
type: Property
domain: UserEmail
the hydra core vocabulary: createdAt
range: dateTime

UserEmail/lastBounceCheckAt
type: Property
domain: UserEmail
the hydra core vocabulary: lastBounceCheckAt
range: dateTime

UserEmail/updatedAt
type: Property
domain: UserEmail
the hydra core vocabulary: updatedAt
range: dateTime

UserEmail/lastUsedAt
type: Property
domain: UserEmail
the hydra core vocabulary: lastUsedAt
range: dateTime

UserEmail/lastSyncAt
type: Property
domain: UserEmail
the hydra core vocabulary: lastSyncAt
range: dateTime

UserEmail/projects
type: Link
domain: UserEmail
the hydra core vocabulary: projects
range: Project

UserEmail/emailCampaignQueue
type: Property
domain: UserEmail
the hydra core vocabulary: emailCampaignQueue

UserEmail/emailCampaignHistory
type: Property
domain: UserEmail
the hydra core vocabulary: emailCampaignHistory

UserEmail/active
type: Property
domain: UserEmail
the hydra core vocabulary: active
range: boolean

UserEmail/fullSenderName
type: Property
domain: UserEmail
the hydra core vocabulary: fullSenderName
range: string

UserEmail/maskedPassword
type: Property
domain: UserEmail
the hydra core vocabulary: maskedPassword
range: string

UserEmail/validSmtpConfig
type: Property
domain: UserEmail
the hydra core vocabulary: validSmtpConfig
range: boolean

UserEmail/validImapConfig
type: Property
domain: UserEmail
the hydra core vocabulary: validImapConfig
range: boolean

UserEmail/success
type: Property
domain: UserEmail
the hydra core vocabulary: success
range: boolean

UserEmail/userEmails
type: Property
domain: UserEmail
the hydra core vocabulary: userEmails

UserEmail/total
type: Property
domain: UserEmail
the hydra core vocabulary: total
range: integer

UserEmail/message
type: Property
domain: UserEmail
the hydra core vocabulary: message
range: string

Project
type: Class
title: Project
supported property: SupportedProperty
  property: Project/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Project/description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Project/apiKey
  title: apiKey
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Project/usageLastDate
  title: usageLastDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Project/isApiActive
  title: isApiActive
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: Project/user
  title: user
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Project/userEmails
  title: userEmails
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Project/contactGroups
  title: contactGroups
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Project/unsubscriptions
  title: unsubscriptions
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Project/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Project/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Project/requireSmsConsent
  title: requireSmsConsent
  required: false
  readable: true
  writeable: true
  description: Wymagaj zgody SMS dla wszystkich wysyłek w projekcie (RODO) Gdy TRUE - projekt wymaga zgody SMS dla wszystkich kontaktów System wysyła SMS TYLKO na polskie numery (+48)
supported property: SupportedProperty
  property: Project/smsConsentPolicyUpdatedAt
  title: smsConsentPolicyUpdatedAt
  required: false
  readable: true
  writeable: true
  description: Data ostatniej zmiany ustawień zgody SMS dla projektu
supported property: SupportedProperty
  property: Project/activeUserEmails
  title: activeUserEmails
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Project/createdAtValue
  title: createdAtValue
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: Project/updatedAtValue
  title: updatedAtValue
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: Project/contactGroupsCount
  title: contactGroupsCount
  required: false
  readable: true
  writeable: false
  description: Zlicza liczbę grup kontaktów w projekcie
supported property: SupportedProperty
  property: Project/userEmailsCount
  title: userEmailsCount
  required: false
  readable: true
  writeable: false
  description: Zlicza liczbę kont email przypisanych do projektu
supported property: SupportedProperty
  property: Project/unsubscriptionsCount
  title: unsubscriptionsCount
  required: false
  readable: true
  writeable: false
  description: Zlicza liczbę odsubskrypcji w projekcie
supported property: SupportedProperty
  property: Project/unsubscribedContact
  title: unsubscribedContact
  required: false
  readable: false
  writeable: false
  description: Sprawdza czy dany kontakt jest odsubskrybowany z tego projektu
supported property: SupportedProperty
  property: Project/unsubscribedContacts
  title: unsubscribedContacts
  required: false
  readable: true
  writeable: false
  description: Zwraca wszystkie odsubskrybowane kontakty z tego projektu
supported property: SupportedProperty
  property: Project/maskedApiKey
  title: maskedApiKey
  required: false
  readable: true
  writeable: false
  description: Zwraca zamaskowaną wersję klucza API do wyświetlania
supported property: SupportedProperty
  property: Project/apiActive
  title: apiActive
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Project/success
  title: success
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Project/projects
  title: projects
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Project/total
  title: total
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Project/message
  title: message
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Project resource.
  method: GET
  returns: Project
  title: getProject
description: Projekty - zarządzanie projektami i ich kluczami API. UWAGA: Każdy projekt posiada własny, unikalny klucz API. Klucz przypisany do projektu A nie będzie działał dla projektu B!

Project/name
type: Property
domain: Project
the hydra core vocabulary: name
range: string

Project/description
type: Property
domain: Project
the hydra core vocabulary: description
range: string

Project/apiKey
type: Property
domain: Project
the hydra core vocabulary: apiKey
range: string

Project/usageLastDate
type: Property
domain: Project
the hydra core vocabulary: usageLastDate
range: dateTime

Project/isApiActive
type: Property
domain: Project
the hydra core vocabulary: isApiActive
range: boolean

Project/user
type: Property
domain: Project
the hydra core vocabulary: user

Project/userEmails
type: Link
domain: Project
the hydra core vocabulary: userEmails
range: UserEmail

Project/contactGroups
type: Link
domain: Project
the hydra core vocabulary: contactGroups
range: ContactGroup

Project/unsubscriptions
type: Property
domain: Project
the hydra core vocabulary: unsubscriptions

Project/createdAt
type: Property
domain: Project
the hydra core vocabulary: createdAt
range: dateTime

Project/updatedAt
type: Property
domain: Project
the hydra core vocabulary: updatedAt
range: dateTime

Project/requireSmsConsent
type: Property
domain: Project
the hydra core vocabulary: requireSmsConsent
range: boolean

Project/smsConsentPolicyUpdatedAt
type: Property
domain: Project
the hydra core vocabulary: smsConsentPolicyUpdatedAt
range: dateTime

Project/activeUserEmails
type: Property
domain: Project
the hydra core vocabulary: activeUserEmails

Project/createdAtValue
type: Property
domain: Project
the hydra core vocabulary: createdAtValue

Project/updatedAtValue
type: Property
domain: Project
the hydra core vocabulary: updatedAtValue

Project/contactGroupsCount
type: Property
domain: Project
the hydra core vocabulary: contactGroupsCount
range: integer

Project/userEmailsCount
type: Property
domain: Project
the hydra core vocabulary: userEmailsCount
range: integer

Project/unsubscriptionsCount
type: Property
domain: Project
the hydra core vocabulary: unsubscriptionsCount
range: integer

Project/unsubscribedContact
type: Property
domain: Project
the hydra core vocabulary: unsubscribedContact

Project/unsubscribedContacts
type: Property
domain: Project
the hydra core vocabulary: unsubscribedContacts

Project/maskedApiKey
type: Property
domain: Project
the hydra core vocabulary: maskedApiKey
range: string

Project/apiActive
type: Property
domain: Project
the hydra core vocabulary: apiActive
range: boolean

Project/success
type: Property
domain: Project
the hydra core vocabulary: success
range: boolean

Project/projects
type: Property
domain: Project
the hydra core vocabulary: projects

Project/total
type: Property
domain: Project
the hydra core vocabulary: total
range: integer

Project/message
type: Property
domain: Project
the hydra core vocabulary: message
range: string

SmsQueue
type: Class
title: SmsQueue
supported property: SupportedProperty
  property: SmsQueue/senderName
  title: senderName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueue/phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueue/message
  title: message
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueue/scheduledAt
  title: scheduledAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueue/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueue/priority
  title: priority
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueue/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueue/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueue/processedAt
  title: processedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueue/appointmentId
  title: appointmentId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueue/attempts
  title: attempts
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueue/maxAttempts
  title: maxAttempts
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueue/parts
  title: parts
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueue/smsCost
  title: smsCost
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueue/errorMessage
  title: errorMessage
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueue/user
  title: user
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueue/phoneDevice
  title: phoneDevice
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueue/sourceType
  title: sourceType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueue/createdAtValue
  title: createdAtValue
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: SmsQueue/exceededMaxAttempts
  title: exceededMaxAttempts
  required: false
  readable: true
  writeable: false
  description: Sprawdza czy przekroczono maksymalną liczbę prób
supported property: SupportedProperty
  property: SmsQueue/readyToSend
  title: readyToSend
  required: false
  readable: true
  writeable: false
  description: Sprawdza czy SMS jest gotowy do wysłania
supported property: SupportedProperty
  property: SmsQueue/statusName
  title: statusName
  required: false
  readable: true
  writeable: false
  description: Zwraca nazwę statusu w języku polskim
supported property: SupportedProperty
  property: SmsQueue/priorityName
  title: priorityName
  required: false
  readable: true
  writeable: false
  description: Zwraca nazwę priorytetu
supported property: SupportedProperty
  property: SmsQueue/priorityValue
  title: priorityValue
  required: false
  readable: true
  writeable: false
  description: Zwraca wartość priorytetu jako int (dla sortowania)
supported property: SupportedProperty
  property: SmsQueue/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueue/phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueue/message
  title: message
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueue/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueue/statusName
  title: statusName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueue/priority
  title: priority
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueue/priorityName
  title: priorityName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueue/scheduledAt
  title: scheduledAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueue/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported operation: Operation
description: Zarządzanie wiadomościami SMS - wysyłanie, anulowanie, sprawdzanie statusu

SmsQueue/senderName
type: Property
domain: SmsQueue
the hydra core vocabulary: senderName
range: string

SmsQueue/phoneNumber
type: Property
domain: SmsQueue
the hydra core vocabulary: phoneNumber
range: string

SmsQueue/message
type: Property
domain: SmsQueue
the hydra core vocabulary: message
range: string

SmsQueue/scheduledAt
type: Property
domain: SmsQueue
the hydra core vocabulary: scheduledAt
range: dateTime
range: string

SmsQueue/updatedAt
type: Property
domain: SmsQueue
the hydra core vocabulary: updatedAt
range: dateTime

SmsQueue/priority
type: Property
domain: SmsQueue
the hydra core vocabulary: priority
range: integer

SmsQueue/status
type: Property
domain: SmsQueue
the hydra core vocabulary: status
range: string

SmsQueue/createdAt
type: Property
domain: SmsQueue
the hydra core vocabulary: createdAt
range: dateTime
range: string

SmsQueue/processedAt
type: Property
domain: SmsQueue
the hydra core vocabulary: processedAt
range: dateTime
range: string

SmsQueue/appointmentId
type: Property
domain: SmsQueue
the hydra core vocabulary: appointmentId
range: integer

SmsQueue/attempts
type: Property
domain: SmsQueue
the hydra core vocabulary: attempts
range: integer

SmsQueue/maxAttempts
type: Property
domain: SmsQueue
the hydra core vocabulary: maxAttempts
range: integer

SmsQueue/parts
type: Property
domain: SmsQueue
the hydra core vocabulary: parts
range: integer

SmsQueue/smsCost
type: Property
domain: SmsQueue
the hydra core vocabulary: smsCost
range: integer

SmsQueue/errorMessage
type: Property
domain: SmsQueue
the hydra core vocabulary: errorMessage
range: string

SmsQueue/user
type: Property
domain: SmsQueue
the hydra core vocabulary: user

SmsQueue/phoneDevice
type: Property
domain: SmsQueue
the hydra core vocabulary: phoneDevice

SmsQueue/sourceType
type: Property
domain: SmsQueue
the hydra core vocabulary: sourceType

SmsQueue/createdAtValue
type: Property
domain: SmsQueue
the hydra core vocabulary: createdAtValue

SmsQueue/exceededMaxAttempts
type: Property
domain: SmsQueue
the hydra core vocabulary: exceededMaxAttempts
range: boolean

SmsQueue/readyToSend
type: Property
domain: SmsQueue
the hydra core vocabulary: readyToSend
range: boolean

SmsQueue/statusName
type: Property
domain: SmsQueue
the hydra core vocabulary: statusName
range: string

SmsQueue/priorityName
type: Property
domain: SmsQueue
the hydra core vocabulary: priorityName
range: string

SmsQueue/priorityValue
type: Property
domain: SmsQueue
the hydra core vocabulary: priorityValue
range: integer

SmsQueue/id
type: Property
domain: SmsQueue
the hydra core vocabulary: id
range: integer

SmsQueueHistory
type: Class
title: SmsQueueHistory
supported property: SupportedProperty
  property: SmsQueueHistory/senderName
  title: senderName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueueHistory/phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueueHistory/message
  title: message
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueueHistory/appointmentId
  title: appointmentId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueueHistory/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueueHistory/errorMessage
  title: errorMessage
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueueHistory/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueueHistory/deliveredAt
  title: deliveredAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueueHistory/smsCost
  title: smsCost
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueueHistory/user
  title: user
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueueHistory/phoneDevice
  title: phoneDevice
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueueHistory/createdAtValue
  title: createdAtValue
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: SmsQueueHistory/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueueHistory/phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueueHistory/message
  title: message
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueueHistory/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueueHistory/statusName
  title: statusName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueueHistory/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueueHistory/deliveredAt
  title: deliveredAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SmsQueueHistory/errorMessage
  title: errorMessage
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a SmsQueueHistory resource.
  method: GET
  returns: SmsQueueHistory
  title: getSmsQueueHistory
description: Historia wysłanych wiadomości SMS

SmsQueueHistory/senderName
type: Property
domain: SmsQueueHistory
the hydra core vocabulary: senderName
range: string

SmsQueueHistory/phoneNumber
type: Property
domain: SmsQueueHistory
the hydra core vocabulary: phoneNumber
range: string

SmsQueueHistory/message
type: Property
domain: SmsQueueHistory
the hydra core vocabulary: message
range: string

SmsQueueHistory/appointmentId
type: Property
domain: SmsQueueHistory
the hydra core vocabulary: appointmentId
range: integer

SmsQueueHistory/status
type: Property
domain: SmsQueueHistory
the hydra core vocabulary: status
range: string

SmsQueueHistory/errorMessage
type: Property
domain: SmsQueueHistory
the hydra core vocabulary: errorMessage
range: string

SmsQueueHistory/createdAt
type: Property
domain: SmsQueueHistory
the hydra core vocabulary: createdAt
range: dateTime
range: string

SmsQueueHistory/deliveredAt
type: Property
domain: SmsQueueHistory
the hydra core vocabulary: deliveredAt
range: dateTime
range: string

SmsQueueHistory/smsCost
type: Property
domain: SmsQueueHistory
the hydra core vocabulary: smsCost
range: integer

SmsQueueHistory/user
type: Property
domain: SmsQueueHistory
the hydra core vocabulary: user

SmsQueueHistory/phoneDevice
type: Property
domain: SmsQueueHistory
the hydra core vocabulary: phoneDevice

SmsQueueHistory/createdAtValue
type: Property
domain: SmsQueueHistory
the hydra core vocabulary: createdAtValue

SmsQueueHistory/id
type: Property
domain: SmsQueueHistory
the hydra core vocabulary: id
range: integer

SmsQueueHistory/statusName
type: Property
domain: SmsQueueHistory
the hydra core vocabulary: statusName
range: string

Entrypoint
type: Class
title: Entrypoint
supported property: SupportedProperty
  property: Entrypoint/contact
  title: getContactCollection
  description: The collection of Contact resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/emailCampaign
  title: getEmailCampaignCollection
  description: The collection of EmailCampaign resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/userEmail
  title: getUserEmailCollection
  description: The collection of UserEmail resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/project
  title: getProjectCollection
  description: The collection of Project resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/smsQueue
  title: getSmsQueueCollection
  description: The collection of SmsQueue resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/smsQueueHistory
  title: getSmsQueueHistoryCollection
  description: The collection of SmsQueueHistory resources
  readable: true
  writeable: false
supported operation: Operation
  method: GET
  title: index
  description: The API Entrypoint.
  returns: Entrypoint

Entrypoint/contact
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Contact
supported operation: Operation
  type: CreateAction
  description: Creates a Contact resource.
  expects: Contact
  method: POST
  returns: Contact
  title: postContact

Entrypoint/emailCampaign
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: EmailCampaign
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of EmailCampaign resources.
  method: GET
  returns: Collection
  title: getEmailCampaignCollection

Entrypoint/userEmail
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: UserEmail
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of UserEmail resources.
  method: GET
  returns: Collection
  title: getUserEmailCollection

Entrypoint/project
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Project
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Project resources.
  method: GET
  returns: Collection
  title: getProjectCollection

Entrypoint/smsQueue
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: SmsQueue
supported operation: Operation
  type: CreateAction
  description: Creates a SmsQueue resource.
  expects: SmsQueue
  method: POST
  returns: SmsQueue
  title: postSmsQueue
supported operation: Operation
  type: CreateAction
  description: Creates a SmsQueue resource.
  expects: SmsQueue
  method: POST
  returns: SmsQueue
  title: postSmsQueue
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of SmsQueue resources.
  method: GET
  returns: Collection
  title: getSmsQueueCollection

Entrypoint/smsQueueHistory
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: SmsQueueHistory
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of SmsQueueHistory resources.
  method: GET
  returns: Collection
  title: getSmsQueueHistoryCollection

ConstraintViolationList
type: Class
title: ConstraintViolationList
description: A constraint violation List.
supported property: SupportedProperty
  property: propertyPath
  title: propertyPath
  description: The property path of the violation
  readable: true
  writeable: false
supported property: SupportedProperty
  property: message
  title: message
  description: The message associated with the violation
  readable: true
  writeable: false

propertyPath
type: Property
domain: ConstraintViolationList
range: string

message
type: Property
domain: ConstraintViolationList
range: string

SupportedProperty
property: Contact/updatedAtValue
title: updatedAtValue
required: false
readable: false
writeable: false

SupportedProperty
property: Contact/unsubscribedFromProject
title: unsubscribedFromProject
required: false
readable: false
writeable: false
description: Sprawdza czy kontakt jest odsubskrybowany z danego projektu

SupportedProperty
property: Contact/unsubscribedProjects
title: unsubscribedProjects
required: false
readable: true
writeable: false
description: Zwraca wszystkie projekty z których kontakt jest odsubskrybowany

SupportedProperty
property: Contact/softBounced
title: softBounced
required: false
readable: true
writeable: false

SupportedProperty
property: Contact/hardBounced
title: hardBounced
required: false
readable: true
writeable: false

SupportedProperty
property: Contact/smsConsent
title: smsConsent
required: false
readable: true
writeable: false
description: Sprawdza czy kontakt ma zgodę na SMS (RODO) UWAGA: System obsługuje TYLKO polskie numery telefonu (+48)

SupportedProperty
property: Contact/polishPhoneNumber
title: polishPhoneNumber
required: false
readable: true
writeable: false
description: Sprawdza czy numer telefonu jest polski (format +48XXXXXXXXX) System obsługuje TYLKO polskie numery telefonu

Operation
type: DeleteAction
description: Deletes the Contact resource.
method: DELETE
returns: owl:Nothing
title: deleteContact

Operation
type: FindAction
description: Retrieves a Contact resource.
method: GET
returns: Contact
title: getContact

Operation
type: FindAction
description: Retrieves a Contact resource.
method: GET
returns: Contact
title: getContact

Operation
type: FindAction
description: Retrieves a Contact resource.
method: GET
returns: Contact
title: getContact

Operation
type: FindAction
description: Retrieves a Contact resource.
method: GET
returns: Contact
title: getContact

SupportedProperty
property: EmailCampaign/selectedSenderIdsArray
title: selectedSenderIdsArray
required: false
readable: true
writeable: false

SupportedProperty
property: EmailCampaign/oldStatsArray
title: oldStatsArray
required: false
readable: true
writeable: false

SupportedProperty
property: EmailCampaign/activeContent
title: activeContent
required: false
readable: true
writeable: false
description: Zwraca aktualną treść na podstawie wybranego edytora

SupportedProperty
property: EmailCampaign/success
title: success
required: false
readable: true
writeable: true

SupportedProperty
property: EmailCampaign/campaigns
title: campaigns
required: false
readable: true
writeable: true

SupportedProperty
property: EmailCampaign/total
title: total
required: false
readable: true
writeable: true

SupportedProperty
property: EmailCampaign/message
title: message
required: false
readable: true
writeable: true

Operation
type: FindAction
description: Retrieves a EmailCampaign resource.
method: GET
returns: EmailCampaign
title: getEmailCampaign

SupportedProperty
property: SmsQueue/processedAt
title: processedAt
required: false
readable: true
writeable: true

SupportedProperty
property: SmsQueue/attempts
title: attempts
required: false
readable: true
writeable: true

SupportedProperty
property: SmsQueue/maxAttempts
title: maxAttempts
required: false
readable: true
writeable: true

SupportedProperty
property: SmsQueue/errorMessage
title: errorMessage
required: false
readable: true
writeable: true

Operation
type: FindAction
description: Retrieves a SmsQueue resource.
method: GET
returns: SmsQueue
title: getSmsQueue

Operation
type: DeleteAction
description: Deletes the SmsQueue resource.
method: DELETE
returns: owl:Nothing
title: deleteSmsQueue

Operation
type: FindAction
description: Retrieves a SmsQueue resource.
method: GET
returns: SmsQueue
title: getSmsQueue