@ikatec/digisac-api-sdk 4.3.0 → 4.4.0

package/src/apis/users/types.ts

@@ -69,3 +69,124 @@ export type UpdateUserPayload = {
   language?: string
   archivedAt?: string | null
 }
+
+/** Body for `POST /users/:id/archive`. */
+export type ArchiveUserPayload = {
+  /** `true` archives the user; `false` restores it. */
+  archive: boolean
+}
+
+/** Body for `POST /users/bulk-status` and `POST /users/bulk-status/preview` (1 to 100 IDs). */
+export type BulkUsersStatusPayload = {
+  ids: string[]
+  archive: boolean
+}
+
+export type BulkUsersStatusScenario =
+  | 'emptySelection'
+  | 'noneEligible'
+  | 'allEligible'
+  | 'partiallyBlocked'
+  | 'onlySelfBlocked'
+  | 'planLimitExceeded'
+
+/** Read-only preview of a bulk status change: nothing is written. */
+export type BulkUsersStatusPreview = {
+  scenario: BulkUsersStatusScenario
+  totalSelected: number
+  /** Users already in the target status. */
+  noop: number
+  eligible: number
+  /** Users that cannot change (e.g. referenced by a bot, or the acting user). */
+  blocked: number
+  blockedSelf: boolean
+  /** Free plan slots when unarchiving; `null` when archiving. */
+  planSlotsAvailable: number | null
+}
+
+export type BulkUsersStatusResult = {
+  changed: number
+  noop: number
+  blocked: number
+  failed: number
+  changedIds: string[]
+  /** IDs of the batch that no longer exist in the account. */
+  missingIds: string[]
+}
+
+/** Body for `POST /users/export`. */
+export type ExportUsersPayload = {
+  filter: 'all' | 'active' | 'archived'
+}
+
+/** A file previously uploaded through `FilesApi`. */
+export type UserImportFile = {
+  id: string
+  name: string
+  mimetype: string
+  url?: string
+  urlToUpload?: string
+}
+
+/** Body for `POST /users/import/validate`. */
+export type ValidateUserImportPayload = {
+  file: UserImportFile
+}
+
+export type UserImportRowsSummary = {
+  total: number
+  valid: number
+  invalid: number
+  hasInvalid: boolean
+}
+
+export type ValidateUserImportResult = {
+  licenses: {
+    requestedRows: number
+    available: number
+    exceeded: boolean
+  }
+  columns: {
+    required: { name: string; found: boolean }[]
+    missingRequired: string[]
+    optionalFound: string[]
+  }
+  rows: UserImportRowsSummary
+  /** Same rows validated with the optional columns applied. */
+  rowsWithOptionalColumns: UserImportRowsSummary
+}
+
+/** Body for `POST /users/import`. */
+export type ImportUsersPayload = {
+  file: UserImportFile
+  useOptionalColumns?: boolean
+}
+
+/** The import runs in the background (the route answers `202 Accepted`). */
+export type ImportUsersResult = {
+  importId: string
+}
+
+export type EnableUserAccessResult = {
+  success: boolean
+  message: string
+}
+
+/** Body for `PATCH /users/pin`: toggles the pin of a contact for the logged user (max. 3). */
+export type TogglePinContactPayload = {
+  contactId: string
+}
+
+/** Link row returned by `PATCH /users/pin` when the contact gets pinned. */
+export type UserPinnedContactLink = {
+  userId: string
+  contactId: string
+  createdAt: string
+  updatedAt: string
+}
+
+/**
+ * Result of `PATCH /users/pin`: the created link rows when the contact gets pinned, or the
+ * number of removed links when it gets unpinned.
+ */
+export type TogglePinContactResult = UserPinnedContactLink[] | number