@ikatec/digisac-api-sdk 4.12.0 → 4.14.0

package/src/apis/services/ServicesApi.test.ts

@@ -91,4 +91,15 @@ describe('ServicesApi', () => {
       })
     },
   )
+
+  describe('accessManagement', () => {
+    it('posts the users and the deny flag to /services/:id/access-management', async () => {
+      vi.mocked(client.post).mockResolvedValue({ message: '1 users denied access.' })
+      const body = { userIds: ['u-1'], deny: true }
+      await expect(api.accessManagement('svc-1', body)).resolves.toEqual({
+        message: '1 users denied access.',
+      })
+      expect(client.post).toHaveBeenCalledWith('/services/svc-1/access-management', body, undefined)
+    })
+  })
 })

package/src/apis/services/ServicesApi.ts

@@ -6,6 +6,8 @@ import type {
   ServiceLimits,
   UpdateServicePayload,
   ArchiveServicePayload,
+  ServiceAccessManagementPayload,
+  ServiceAccessManagementResponse,
 } from './types'
 
 export class ServicesApi extends ArchivableCrudApi<
@@ -109,4 +111,23 @@ export class ServicesApi extends ArchivableCrudApi<
   restart(id: string, headers?: Record<string, string>): Promise<'OK'> {
     return this.client.post<'OK'>(`${this.basePath}/${id}/restart`, undefined, headers)
   }
+
+  /**
+   * Denies the connection to users (`deny: true`) or gives it back (`deny: false`); the admins are skipped. Denying
+   * transfers the open tickets of those users in the connection. The rows are read with
+   * `ServiceAccessManagementApi.getMany`. An unknown connection answers 404 `Service not found.`; a missing
+   * `userIds` or a `deny` that is not a boolean answers 400.
+   * @permissions users.update AND services.operate
+   */
+  accessManagement(
+    id: string,
+    body: ServiceAccessManagementPayload,
+    headers?: Record<string, string>,
+  ): Promise<ServiceAccessManagementResponse> {
+    return this.client.post<ServiceAccessManagementResponse, ServiceAccessManagementPayload>(
+      `${this.basePath}/${id}/access-management`,
+      body,
+      headers,
+    )
+  }
 }

package/src/apis/services/types.ts

@@ -292,3 +292,15 @@ export type ServiceLimit = {
 
 /** Connections used and allowed by the account plan, by connection type. */
 export type ServiceLimits = Partial<Record<ServiceType, ServiceLimit>>
+
+/** The body of `accessManagement`: the users to deny (or give back) the connection to. */
+export type ServiceAccessManagementPayload = {
+  userIds: string[]
+  /** `true` denies the connection to the users (their open tickets in it are transferred); `false` gives it back. */
+  deny: boolean
+}
+
+/** What `accessManagement` answers: how many users were denied or given back the connection (no admin is counted). */
+export type ServiceAccessManagementResponse = {
+  message: `${number} users denied access.` | `${number} users allowed access.`
+}

package/src/apis/stickerUsers/StickerUsersApi.ts

@@ -4,7 +4,9 @@ import type { StickerUser } from './types'
 
 export class StickerUsersApi extends BaseApi implements HasGetMany<StickerUser> {
   /**
-   * Returns a paginated list of sticker-user associations with their related file.
+   * The stickers the current user sent recently (`lastSendAt`), paginated; only the `file` include is
+   * served. A row is written when the user sends a message of type `sticker` (in the background, after the
+   * send).
    * @permissions stickers.send
    */
   getMany(

package/src/apis/stickerUsers/types.ts

@@ -10,9 +10,13 @@ export type StickerUser = {
   createdAt: string
   updatedAt: string
   // relationships
+  /** @deprecated Not served: the backend only serves the `file` include. */
   sticker?: Sticker
+  /** @deprecated Not served: the backend only serves the `file` include. */
   user?: User
+  /** The image of the sticker. */
   file?: File
 }
 
+/** The backend serves only `file` (`sticker` and `user` are dropped). */
 export type StickerUserRelationships = 'sticker' | 'user' | 'file'

package/src/apis/stickers/StickersApi.test.ts

@@ -0,0 +1,58 @@
+import { beforeEach, describe, expect, it, vi } from 'vitest'
+import { StickersApi } from './StickersApi'
+import type { ApiClient } from '../../core/ApiClient'
+
+// ── Mock client factory ──────────────────────────────────────────────
+
+function createMockClient(): ApiClient {
+  return {
+    setAccessToken: vi.fn().mockReturnThis(),
+    request: vi.fn(),
+    requestRaw: vi.fn(),
+    get: vi.fn(),
+    post: vi.fn(),
+    put: vi.fn(),
+    patch: vi.fn(),
+    delete: vi.fn(),
+  }
+}
+
+// ── Tests ────────────────────────────────────────────────────────────
+
+describe('StickersApi', () => {
+  let client: ReturnType<typeof createMockClient>
+  let api: StickersApi
+
+  beforeEach(() => {
+    client = createMockClient()
+    api = new StickersApi(client)
+  })
+
+  it('create posts the image to /stickers', async () => {
+    await api.create({ base64: 'iVBOR', name: 'qa' })
+    expect(client.post).toHaveBeenCalledWith(
+      '/stickers',
+      { base64: 'iVBOR', name: 'qa' },
+      undefined,
+    )
+  })
+
+  it('exist serializes the message and the checksum', async () => {
+    vi.mocked(client.get).mockResolvedValue({})
+    await expect(api.exist({ messageId: 'm-1', fileChecksum: 'abc' })).resolves.toEqual({})
+    const url = vi.mocked(client.get).mock.calls[0]?.[0] as string
+    expect(url).toMatch(/^\/stickers\/exist\?/)
+    expect(decodeURIComponent(url)).toContain('"fileChecksum":"abc"')
+  })
+
+  it('add posts the message to /stickers/add', async () => {
+    await api.add('m-1')
+    expect(client.post).toHaveBeenCalledWith('/stickers/add', { messageId: 'm-1' }, undefined)
+  })
+
+  it('remove deletes /stickers/remove/:stickerId', async () => {
+    vi.mocked(client.delete).mockResolvedValue('OK')
+    await expect(api.remove('s-1')).resolves.toBe('OK')
+    expect(client.delete).toHaveBeenCalledWith('/stickers/remove/s-1', undefined)
+  })
+})

package/src/apis/stickers/StickersApi.ts

@@ -1,12 +1,18 @@
 import type { ApiClient } from '../../core/ApiClient'
 import { BaseCrudApi } from '../../core/BaseCrudApi'
 import type { GetByIdQuery } from '../../core/types'
-import type { Sticker, CreateStickerPayload, UpdateStickerPayload } from './types'
+import type {
+  Sticker,
+  CreateStickerPayload,
+  UpdateStickerPayload,
+  StickerExistQuery,
+} from './types'
 
 /**
- * Stickers of the account. The backend serves `GET /stickers` and `POST /stickers` (plus
- * `GET /stickers/exist`, `POST /stickers/add` and `DELETE /stickers/remove/:stickerId`); there is
- * no read by id, update nor `DELETE /stickers/:id`.
+ * Stickers of the account: every user of the account sees them. The backend serves `GET /stickers`,
+ * `POST /stickers`, `GET /stickers/exist`, `POST /stickers/add` and `DELETE /stickers/remove/:stickerId`;
+ * there is no read by id, update nor `DELETE /stickers/:id`. The list accepts only the `file` include.
+ * @permissions stickers.send (list) · stickers.management (create, exist, add, remove)
  */
 export class StickersApi extends BaseCrudApi<Sticker, CreateStickerPayload, UpdateStickerPayload> {
   constructor(client: ApiClient) {
@@ -38,4 +44,40 @@ export class StickersApi extends BaseCrudApi<Sticker, CreateStickerPayload, Upda
   override deleteById(id: string, headers?: Record<string, string>): Promise<Sticker> {
     return super.deleteById(id, headers)
   }
+
+  /**
+   * Finds the sticker of the account that came from the message, or from the file of `fileChecksum` or
+   * `filehash`. Resolves `{ stickerId }`, or `{}` when there is none; without `messageId` it answers 500
+   * `Invalid message ID`.
+   */
+  exist(
+    query: StickerExistQuery,
+    headers?: Record<string, string>,
+  ): Promise<{ stickerId?: string }> {
+    return this.client.get<{ stickerId?: string }>(
+      `${this.basePath}/exist${this.toQueryString(query)}`,
+      headers,
+    )
+  }
+
+  /**
+   * Turns the file of a message of the account into a sticker (`type: 'added'`). Idempotent: a sticker that
+   * already came from the message (or its file) is answered as is, and a removed one is restored. A message
+   * without file answers 500 `Message or file not found`.
+   */
+  add(messageId: string, headers?: Record<string, string>): Promise<Sticker> {
+    return this.client.post<Sticker, { messageId: string }>(
+      `${this.basePath}/add`,
+      { messageId },
+      headers,
+    )
+  }
+
+  /**
+   * Removes a sticker of the account (soft delete; its file stays in the storage) and clears it from the
+   * recent stickers of every user. Resolves the text `'OK'`, or `false` when there is no such sticker.
+   */
+  remove(stickerId: string, headers?: Record<string, string>): Promise<'OK' | false> {
+    return this.client.delete<'OK' | false>(`${this.basePath}/remove/${stickerId}`, headers)
+  }
 }

package/src/apis/stickers/types.ts

@@ -1,8 +1,12 @@
+import type { File } from '../files/types'
+import type { Message } from '../messages/types'
 import type { User } from '../users/types'
 
+/** A sticker of the account (every user of the account sees it). */
 export type Sticker = {
   id: string
-  type: string
+  /** `'created'` (uploaded with `create`) or `'added'` (taken from a message with `add`). */
+  type: 'created' | 'added' | (string & {})
   originFileChecksum: string | null
   originFilehash: string | null
   originMessageId: string | null
@@ -10,20 +14,44 @@ export type Sticker = {
   accountId: string
   createdAt: string
   updatedAt: string
-  deletedAt: string | null
+  deletedAt?: string | null
   // relationships
+  /** @deprecated Not served: the backend only serves the `file` include. */
   user?: User
+  /** The image (webp) of the sticker. */
+  file?: File
+  /** The message the sticker came from (`add`); `null` on a sticker uploaded with `create`. */
+  originMessage?: Message | null
 }
 
-export type StickerRelationships = 'user'
+/** The backend serves only `file` (`user` is dropped). */
+export type StickerRelationships = 'user' | 'file'
 
+/**
+ * Uploads an image as a sticker: the backend converts it to a 512x512 webp (413 when it ends up too large:
+ * 100KB static, 500KB animated). `base64` without the `data:...;base64,` prefix.
+ */
 export type CreateStickerPayload = {
-  type: string
+  base64: string
+  /** The name of the file (`<name>.webp`). */
+  name: string
+  /** @deprecated Ignored by the backend: a created sticker is always `'created'`. */
+  type?: string
+  /** @deprecated Ignored by the backend: use `add` to take a sticker from a message. */
   originMessageId?: string
+  /** @deprecated Ignored by the backend. */
   originFileChecksum?: string
+  /** @deprecated Ignored by the backend. */
   originFilehash?: string
 }
 
 export type UpdateStickerPayload = {
   type?: string
 }
+
+/** Query of `exist`: finds a sticker of the account by the message or by the file it came from. */
+export type StickerExistQuery = {
+  messageId: string
+  fileChecksum?: string
+  filehash?: string
+}

package/src/apis/whatsappBusinessTemplates/WhatsappBusinessTemplatesApi.ts

@@ -81,8 +81,7 @@ export class WhatsappBusinessTemplatesApi extends BaseCrudApi<
   }
 
   /**
-   * Reads the template balance from 360Dialog. The backend looks for the 360Dialog connection on the whole platform,
-   * not only in the account, and calls 360Dialog when it finds one.
+   * Reads the template balance from 360Dialog (an external call, when there is a 360Dialog connection).
    * @permissions hsm.view
    */
   resume(headers?: Record<string, string>): Promise<Record<string, unknown>[]> {