[Intum Pomoc](https://intum.pl/pomoc.md) / [API](https://intum.pl/pomoc/konto/api.md)

# [Moduły i ich części](https://intum.pl/pomoc/konto/api/moduly-i-czesci.md)

Część modułu (submoduł) to fragment modułu, który admin konta włącza i wyłącza osobno, np.
Zawiadomienia w Organizacji albo Helplinki w Bazie wiedzy. Wyłączona część znika z menu, pulpitu
i ustawień modułu, a jej pola (np. projekt w formatce zadania) się chowają. Dane zostają, a strony
pod bezpośrednim adresem działają dalej. Po ponownym włączeniu wszystko wraca.

Wymaga uprawnienia administratora konta (`:account`).

**Autoryzacja:** `Authorization: Bearer TOKEN`
**Content-Type:** `application/json; charset=utf-8`

## API Endpoints

| Metoda | Ścieżka | Opis |
|--------|---------|------|
| GET | `/account/modules.json` | Moduły konta: `available` (dostępne), `default` (domyślne produktu), `active` (włączone) |
| GET | `/account/modules/:mod.json` | Moduł i lista jego części ze stanem |
| PATCH | `/account/modules/:mod/submodules/:code.json` | Włączenie/wyłączenie części: `{"enabled": true}` / `{"enabled": false}` |
| PATCH | `/account/modules/:mod/submodules/:code/name.json` | Własna nazwa części: `{"names": {"other": "Budowy", "one": "Budowa"}}` |

`:mod` to kod modułu (`organize`, `kb`), `:code` - pełny kod części z kropką (`organize.notices`).

## Odpowiedź GET `/account/modules/:mod.json`

```json
{
  "module": "kb",
  "active": true,
  "submodules": [
    { "code": "kb.knowledge_bases", "active": true, "default": true, "required": true },
    { "code": "kb.forums", "active": true, "default": true, "required": false },
    { "code": "kb.helplinks", "active": false, "default": false, "required": false },
    { "code": "kb.changelogs", "active": true, "default": true, "required": false }
  ]
}
```

| Pole | Opis |
|------|------|
| `code` | Kod części |
| `active` | Czy część jest teraz włączona na koncie |
| `default` | Stan domyślny w produkcie - część bez ręcznej zmiany ma ten stan |
| `required` | Stała część modułu (np. Bazy wiedzy) - zawsze włączona, PATCH zwraca błąd |

Części, którym można nadać własną nazwę (`organize.projects`, `organize.workinfo`, `crm.deals`), mają dodatkowo
pole `names` - własne nazwy konta, `{}` gdy obowiązują domyślne:
`{ "code": "organize.projects", ..., "names": { "other": "Budowy", "one": "Budowa" } }`.

PATCH zwraca obiekt jednej części w tym samym formacie. Błąd `422` (`status: "error"`) przy części
z innego modułu, stałej (`required`), nieznanej albo bez parametru `enabled`.

## Własna nazwa części

`PATCH /account/modules/:mod/submodules/:code/name.json` z `{"names": {...}}` - konto nazywa część po
swojemu, np. Projekty → „Budowy”. Nazwa podmienia napis w menu, na pulpicie, w nagłówkach list
i przy polach projektu w filtrach i formularzach. Napisy z nazwą w środku zdania („Nowy projekt”)
zostają bez zmian. Nazwa nie zależy od języka interfejsu.

| Część | Formy w `names` |
|-------|-----------------|
| `organize.projects` | `other` - l. mnoga (menu, nagłówek listy, np. „Budowy”), `one` - l. pojedyncza (pole „Projekt”, np. „Budowa”) |
| `organize.workinfo` | `other` - jedna nazwa (np. „Czas pracy”) |
| `crm.deals` | `other` - l. mnoga (menu, nagłówek listy, np. „Zlecenia”), `one` - l. pojedyncza (pole „Interes”, np. „Zlecenie”) |

- pusta forma albo jej brak = nazwa domyślna, `{"names": {}}` przywraca obie,
- formy spoza tabeli są pomijane, nazwa ma najwyżej 40 znaków (dłuższa jest przycinana),
- inne części → `422`,
- zmiana zostawia wpis w aktywnościach konta (`submodule_rename`).

## Części modułów

| Moduł | Kod | Co to jest | Domyślnie |
|-------|-----|-----------|-----------|
| organize | `organize.tasks` | Zadania | włączone |
| organize | `organize.projects` | Projekty (z polami projektu w innych modułach) | włączone |
| organize | `organize.tasklists` | Listy zadań | wyłączone |
| organize | `organize.teams` | Zespoły | włączone |
| organize | `organize.workinfo` | WorkInfo - czas pracy (wpisy, przycisk Play, raporty) | wyłączone |
| organize | `organize.employee_leaves` | Urlopy | wyłączone |
| organize | `organize.posts` | Posty | wyłączone |
| organize | `organize.notices` | Zawiadomienia | wyłączone |
| kb | `kb.knowledge_bases` | Bazy wiedzy - stała część | zawsze |
| kb | `kb.forums` | Fora sugestii (bez nich formatka bazy nie ma pola Rodzaj) | włączone |
| kb | `kb.helplinks` | Helplinki | wyłączone |
| kb | `kb.changelogs` | Changelogi | włączone |
| crm | `crm.clients` | Klienci - stała część | zawsze |
| crm | `crm.contacts` | Kontakty (wyłączone znikają tylko z menu i paska bocznego CRM; strony, API i dane działają) | włączone |
| crm | `crm.deals` | Interesy (wyłączone znikają tylko z menu, paska bocznego CRM i z „Dodaj → Interes” na karcie klienta; strony, API i dane działają) | włączone |
| crm | `crm.notes` | Notatki (wyłączone znikają tylko z menu i paska bocznego CRM; strony, API i dane działają) | włączone |
| crm | `crm.client_portal` | Portal klienta `/portal` - wyłączony daje 404 i chowa pola portalu na kliencie | wyłączone |

Produkt może mieć inne stany domyślne - rozstrzyga pole `default` z odpowiedzi GET.
Każde przełączenie zostawia wpis w aktywnościach konta (`submodule_enable` / `submodule_disable`).
Projektom, WorkInfo i Interesom (CRM) można nadać własną nazwę - sekcja „Własna nazwa części”.

## Przykłady

```bash
# stan części Organizacji
curl -s -H "Authorization: Bearer TOKEN" "https://HOST/account/modules/organize.json"

# włącz Zawiadomienia
curl -s -X PATCH -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json; charset=utf-8" \
  -d '{"enabled": true}' "https://HOST/account/modules/organize/submodules/organize.notices.json"

# wyłącz Fora sugestii w Bazie wiedzy
curl -s -X PATCH -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json; charset=utf-8" \
  -d '{"enabled": false}' "https://HOST/account/modules/kb/submodules/kb.forums.json"

# nazwij Projekty „Budowy” / „Budowa”
curl -s -X PATCH -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json; charset=utf-8" \
  -d '{"names": {"other": "Budowy", "one": "Budowa"}}' "https://HOST/account/modules/organize/submodules/organize.projects/name.json"

# przywróć domyślną nazwę WorkInfo
curl -s -X PATCH -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json; charset=utf-8" \
  -d '{"names": {}}' "https://HOST/account/modules/organize/submodules/organize.workinfo/name.json"
```