@ikatec/digisac-api-sdk 4.4.1 → 4.5.1

package/dist/apis/pipeline/types.d.ts

@@ -1,4 +1,5 @@
 import type { Department } from '../departments/types';
+import type { WhereClause } from '../../core/types';
 export type PipelineStageStatus = {
     id: string;
     /** The default "Finalizados" stage carries `STATUS_WON` and `STATUS_LOOSE`. */
@@ -86,4 +87,167 @@ export type UpdatePipelinePayload = {
     goBack?: boolean;
     permissionToViewCard?: boolean | null;
 };
+/** Codes the stage routes answer (as a JSON string, with 200) instead of the stage. */
+export type PipelineStageRefusal = 'STAGES_LIMIT' | 'STAGE_ALREADY_EXIST';
+export type PipelineStageStatusInput = {
+    /** Send the `id` of an existing status to keep it on update; omit it to create one. */
+    id?: string;
+    name: string;
+    position: number;
+};
+export type PipelineStageReasonInput = {
+    /** Send the `id` of an existing reason to keep it on update; omit it to create one. */
+    id?: string;
+    name: string;
+    position: number;
+    isWon?: boolean;
+};
+export type CreatePipelineStagePayload = {
+    /** Up to 255 characters; must not repeat the name of another stage of the pipeline. */
+    name: string;
+    pipelineId: string;
+    /** Must be truthy — the backend `required` rule refuses `0`. */
+    position: number;
+    /** Up to 10. */
+    statuses?: PipelineStageStatusInput[];
+    /** Up to 20. */
+    reasons?: PipelineStageReasonInput[];
+};
+export type UpdatePipelineStagePayload = CreatePipelineStagePayload & {
+    /**
+     * The stage id. Send it: the duplicate-name check compares against the `id` of the body,
+     * so without it keeping the current name answers `'STAGE_ALREADY_EXIST'`.
+     */
+    id?: string;
+};
+/**
+ * Where the cards of a deleted stage go:
+ * - `typeAction: 'move'` moves them to `idNewStage` (a stage of the same pipeline), clearing
+ *   status, reason and result;
+ * - without `typeAction`, they are archived and moved to the first stage of the pipeline.
+ */
+export type DeletePipelineStagePayload = {
+    typeAction?: 'move';
+    idNewStage?: string;
+    /**
+     * Author of the card movements written by `'move'` — the backend reads it from the body, not
+     * from the token (the UI sends the logged user). Without it, moving a stage that has cards
+     * fails with 500 (`CardMovement.userId cannot be null`) after the cards were already moved,
+     * and the stage is kept.
+     */
+    user?: {
+        id: string;
+    };
+};
+/** Answer of the stage deletion; `'PIPELINES_MIN_STAGES'` = refused, the pipeline keeps 2 stages. */
+export type DeletePipelineStageResult = 'MESSAGE_STAGE_DELETED' | 'PIPELINES_MIN_STAGES';
+export type PipelineStatusRef = {
+    id: string;
+    name: string;
+};
+/** `GET /pipelines/status/{id}`: the status plus how many cards use it. */
+export type PipelineStageStatusWithCount = PipelineStageStatus & {
+    cardsCount: number;
+};
+/**
+ * What happens to the cards of a deleted status: `'keep-without-status'` clears their status,
+ * `'move-to-another'` sets `newStatusId` (not validated by the backend).
+ */
+export type DeletePipelineStatusPayload = {
+    action: 'keep-without-status';
+} | {
+    action: 'move-to-another';
+    newStatusId: string;
+};
+export type PipelineAutomationType = 'notification';
+export type PipelineAutomationConfig = {
+    notify?: 'high' | 'medium' | 'medium-high';
+    frequency?: 'daily' | 'weekly' | 'biweekly' | 'monthly';
+    day?: string;
+    from?: {
+        high?: string;
+        medium?: string;
+    };
+    recipient?: 'admin' | 'owner' | 'both';
+};
+export type PipelineAutomation = {
+    id: string;
+    pipelineId: string;
+    type: PipelineAutomationType;
+    isArchived: boolean | null;
+    archivedAt: string | null;
+    config: PipelineAutomationConfig;
+    createdAt: string;
+    updatedAt: string;
+};
+export type CreatePipelineAutomationPayload = {
+    pipelineId: string;
+    /** The backend does not validate it (any string is stored); `'notification'` is the only one used. */
+    type: PipelineAutomationType;
+    config?: PipelineAutomationConfig;
+    isArchived?: boolean;
+};
+/** The backend validator requires `pipelineId` and `type` on update too. */
+export type UpdatePipelineAutomationPayload = CreatePipelineAutomationPayload;
+/** Card date filters of the CSV export; the UI sends `'YYYY-MM-DD HH:mm:ss'`. */
+export type ExportPipelinePayload = {
+    /** Without both `createdAt*`, the range defaults to now (empty export). */
+    createdAtInit?: string;
+    createdAtFinal?: string;
+    /** With both `wonAt*`, only won cards are exported. */
+    wonAtInit?: string;
+    wonAtFinal?: string;
+};
+export type PipelinesWithTotalsQuery = {
+    /** `accountId` is always injected by the backend. `$and[].createdAt` filters the cards. */
+    where?: WhereClause<PipelineRecord>;
+    order?: [string, 'ASC' | 'DESC'][];
+    limit?: number;
+    /** `true` lists only the pipelines that are not archived. */
+    archive?: boolean;
+};
+export type PipelineTotals = {
+    id: string;
+    name: string;
+    total: number | null;
+    totalSuccess: number | null;
+    totalFailed: number | null;
+    /** A bigint, sent as a string. */
+    totalCards: string;
+};
+/**
+ * Pipelines without stages are left out; there is no pagination. With a `createdAt` filter, only
+ * the stages that have matching cards are listed, but `totals` still has every stage.
+ */
+export type PipelinesWithTotals = {
+    data: (PipelineRecord & {
+        stages: PipelineStage[];
+        totals: PipelineTotals[];
+    })[];
+};
+/** Card filters of the stage totals (same as the board filters of the UI). */
+export type PipelineStageTotalsFilters = {
+    status?: {
+        value: string;
+    };
+    service?: {
+        id: string;
+    };
+    nameTitle?: string;
+    /** `DD/MM/YYYY`. */
+    createdFrom?: string;
+    createdUntil?: string;
+    owner?: {
+        id: string;
+        value?: string;
+    };
+    wonFrom?: string;
+    wonUntil?: string;
+};
+export type PipelineStageTotals = PipelineStage & {
+    totalCards: number;
+    totalCardsValue: number;
+    totalWonCardsValue: number;
+    totalLostCardsValue: number;
+};
 //# sourceMappingURL=types.d.ts.map

package/dist/apis/pipeline/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/pipeline/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAEtD,MAAM,MAAM,mBAAmB,GAAG;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,+EAA+E;IAC/E,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,OAAO,CAAA;IACd,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,QAAQ,CAAC,EAAE,mBAAmB,EAAE,CAAA;IAChC,OAAO,CAAC,EAAE,mBAAmB,EAAE,CAAA;IAC/B,uFAAuF;IACvF,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAC7B,CAAA;AAED,kGAAkG;AAClG,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,OAAO,CAAA;IACf,SAAS,EAAE,MAAM,CAAA;IACjB,oBAAoB,EAAE,OAAO,GAAG,IAAI,CAAA;IACpC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;CACzB,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,OAAO,CAAA;IACf,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,oBAAoB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IACrC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB,MAAM,CAAC,EAAE,aAAa,EAAE,CAAA;IACxB,WAAW,CAAC,EAAE,UAAU,EAAE,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG,aAAa,GAAG,QAAQ,CAAA;AAE5D,MAAM,MAAM,qBAAqB,GAAG;IAClC,2DAA2D;IAC3D,IAAI,EAAE,MAAM,CAAA;IACZ,uEAAuE;IACvE,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,gEAAgE;IAChE,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,0EAA0E;IAC1E,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,oBAAoB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;CACtC,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/pipeline/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD,MAAM,MAAM,mBAAmB,GAAG;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,+EAA+E;IAC/E,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,OAAO,CAAA;IACd,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,QAAQ,CAAC,EAAE,mBAAmB,EAAE,CAAA;IAChC,OAAO,CAAC,EAAE,mBAAmB,EAAE,CAAA;IAC/B,uFAAuF;IACvF,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAC7B,CAAA;AAED,kGAAkG;AAClG,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,OAAO,CAAA;IACf,SAAS,EAAE,MAAM,CAAA;IACjB,oBAAoB,EAAE,OAAO,GAAG,IAAI,CAAA;IACpC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;CACzB,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,OAAO,CAAA;IACf,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,oBAAoB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IACrC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB,MAAM,CAAC,EAAE,aAAa,EAAE,CAAA;IACxB,WAAW,CAAC,EAAE,UAAU,EAAE,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG,aAAa,GAAG,QAAQ,CAAA;AAE5D,MAAM,MAAM,qBAAqB,GAAG;IAClC,2DAA2D;IAC3D,IAAI,EAAE,MAAM,CAAA;IACZ,uEAAuE;IACvE,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,gEAAgE;IAChE,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,0EAA0E;IAC1E,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,oBAAoB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;CACtC,CAAA;AAED,uFAAuF;AACvF,MAAM,MAAM,oBAAoB,GAAG,cAAc,GAAG,qBAAqB,CAAA;AAEzE,MAAM,MAAM,wBAAwB,GAAG;IACrC,uFAAuF;IACvF,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,uFAAuF;IACvF,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG;IACvC,uFAAuF;IACvF,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,gEAAgE;IAChE,QAAQ,EAAE,MAAM,CAAA;IAChB,gBAAgB;IAChB,QAAQ,CAAC,EAAE,wBAAwB,EAAE,CAAA;IACrC,gBAAgB;IAChB,OAAO,CAAC,EAAE,wBAAwB,EAAE,CAAA;CACrC,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG,0BAA0B,GAAG;IACpE;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;CACZ,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;;;;OAKG;IACH,IAAI,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CAAA;CACtB,CAAA;AAED,qGAAqG;AACrG,MAAM,MAAM,yBAAyB,GAAG,uBAAuB,GAAG,sBAAsB,CAAA;AAExF,MAAM,MAAM,iBAAiB,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAA;AAE5D,2EAA2E;AAC3E,MAAM,MAAM,4BAA4B,GAAG,mBAAmB,GAAG;IAAE,UAAU,EAAE,MAAM,CAAA;CAAE,CAAA;AAEvF;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GACnC;IAAE,MAAM,EAAE,qBAAqB,CAAA;CAAE,GACjC;IAAE,MAAM,EAAE,iBAAiB,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,CAAA;AAEtD,MAAM,MAAM,sBAAsB,GAAG,cAAc,CAAA;AAEnD,MAAM,MAAM,wBAAwB,GAAG;IACrC,MAAM,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,aAAa,CAAA;IAC1C,SAAS,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAA;IACvD,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IACzC,SAAS,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,CAAA;CACvC,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,sBAAsB,CAAA;IAC5B,UAAU,EAAE,OAAO,GAAG,IAAI,CAAA;IAC1B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,MAAM,EAAE,wBAAwB,CAAA;IAChC,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,+BAA+B,GAAG;IAC5C,UAAU,EAAE,MAAM,CAAA;IAClB,sGAAsG;IACtG,IAAI,EAAE,sBAAsB,CAAA;IAC5B,MAAM,CAAC,EAAE,wBAAwB,CAAA;IACjC,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAED,4EAA4E;AAC5E,MAAM,MAAM,+BAA+B,GAAG,+BAA+B,CAAA;AAE7E,iFAAiF;AACjF,MAAM,MAAM,qBAAqB,GAAG;IAClC,2EAA2E;IAC3E,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,uDAAuD;IACvD,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,2FAA2F;IAC3F,KAAK,CAAC,EAAE,WAAW,CAAC,cAAc,CAAC,CAAA;IACnC,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,KAAK,GAAG,MAAM,CAAC,EAAE,CAAA;IAClC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,6DAA6D;IAC7D,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,kCAAkC;IAClC,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,CAAC,cAAc,GAAG;QAAE,MAAM,EAAE,aAAa,EAAE,CAAC;QAAC,MAAM,EAAE,cAAc,EAAE,CAAA;KAAE,CAAC,EAAE,CAAA;CACjF,CAAA;AAED,8EAA8E;AAC9E,MAAM,MAAM,0BAA0B,GAAG;IACvC,MAAM,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;IAC1B,OAAO,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CAAA;IACxB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,oBAAoB;IACpB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,KAAK,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IACtC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,aAAa,GAAG;IAChD,UAAU,EAAE,MAAM,CAAA;IAClB,eAAe,EAAE,MAAM,CAAA;IACvB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,mBAAmB,EAAE,MAAM,CAAA;CAC5B,CAAA"}

package/dist/apis/tickets/types.d.ts

@@ -1,5 +1,6 @@
 import type { Contact } from '../contacts/types';
 import type { Department } from '../departments/types';
+import type { Message } from '../messages/types';
 import type { Service } from '../services/types';
 import type { User } from '../users/types';
 export type TicketOrigin = 'automatic' | 'manual' | 'widget';
@@ -20,6 +21,40 @@ export type TicketMetrics = {
     waitingTimeTransfersAvg?: number;
     isActiveTicket?: boolean;
 };
+export type TicketTransferAction = 'opened' | 'transferred' | 'closed';
+/**
+ * A step of the history of a ticket (opening, transfer, closing), as the `ticketTransfers` include of
+ * `GET /tickets/{id}` answers it. `byUserId` is who performed the step (null when there is no user, e.g. a bot).
+ *
+ * Inside `ticketTransfers`, the route whitelist only accepts `byUser`, `fromUser`, `toUser`, `fromDepartment` and
+ * `toDepartment`: `transferredMessage`, `firstMessage` and `lastMessage` are dropped in silence and come as `null`.
+ */
+export type TicketTransfer = {
+    id: string;
+    action: TicketTransferAction | null;
+    comments: string | null;
+    fromDistribution: boolean;
+    accountId: string;
+    ticketId: string;
+    byUserId: string | null;
+    fromUserId: string | null;
+    toUserId: string | null;
+    fromDepartmentId: string | null;
+    toDepartmentId: string | null;
+    transferredMessageId: string | null;
+    firstMessageId: string | null;
+    lastMessageId: string | null;
+    createdAt: string;
+    updatedAt: string;
+    byUser?: User | null;
+    fromUser?: User | null;
+    toUser?: User | null;
+    fromDepartment?: Department | null;
+    toDepartment?: Department | null;
+    transferredMessage?: Message | null;
+    firstMessage?: Message | null;
+    lastMessage?: Message | null;
+};
 export type Ticket = {
     id: string;
     isOpen: boolean;
@@ -45,8 +80,9 @@ export type Ticket = {
     department?: Department;
     user?: User | null;
     service?: Service | null;
+    ticketTransfers?: TicketTransfer[];
 };
-export type TicketRelationships = 'contact' | 'department' | 'user' | 'service';
+export type TicketRelationships = 'contact' | 'department' | 'user' | 'service' | 'ticketTransfers';
 export type CreateTicketPayload = {
     contactId: string;
     departmentId: string;

package/dist/apis/tickets/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/tickets/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAE1C,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,CAAA;AAE5D,MAAM,MAAM,aAAa,GAAG;IAC1B,6EAA6E;IAC7E,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,8EAA8E;IAC9E,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,2EAA2E;IAC3E,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,4DAA4D;IAC5D,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,iDAAiD;IACjD,uBAAuB,CAAC,EAAE,MAAM,CAAA;IAChC,kDAAkD;IAClD,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,yCAAyC;IACzC,uBAAuB,CAAC,EAAE,MAAM,CAAA;IAChC,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,OAAO,CAAA;IACf,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,MAAM,EAAE,YAAY,GAAG,IAAI,CAAA;IAC3B,OAAO,EAAE,aAAa,CAAA;IACtB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,cAAc,EAAE,OAAO,CAAA;IACvB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAA;IACtC,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IAEjB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAClB,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,SAAS,GAAG,YAAY,GAAG,MAAM,GAAG,SAAS,CAAA;AAE/E,MAAM,MAAM,mBAAmB,GAAG;IAChC,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,YAAY,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,uBAAuB,GAC/B;IAAE,GAAG,EAAE,MAAM,EAAE,CAAC;IAAC,cAAc,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,GACxE;IAAE,mBAAmB,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/tickets/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAE1C,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,CAAA;AAE5D,MAAM,MAAM,aAAa,GAAG;IAC1B,6EAA6E;IAC7E,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,8EAA8E;IAC9E,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,2EAA2E;IAC3E,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,4DAA4D;IAC5D,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,iDAAiD;IACjD,uBAAuB,CAAC,EAAE,MAAM,CAAA;IAChC,kDAAkD;IAClD,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,yCAAyC;IACzC,uBAAuB,CAAC,EAAE,MAAM,CAAA;IAChC,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,QAAQ,GAAG,aAAa,GAAG,QAAQ,CAAA;AAEtE;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,oBAAoB,GAAG,IAAI,CAAA;IACnC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,gBAAgB,EAAE,OAAO,CAAA;IACzB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAA;IAC/B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAA;IACnC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IAEjB,MAAM,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACpB,QAAQ,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACtB,MAAM,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACpB,cAAc,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IAClC,YAAY,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IAChC,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IACnC,YAAY,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IAC7B,WAAW,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,OAAO,CAAA;IACf,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,MAAM,EAAE,YAAY,GAAG,IAAI,CAAA;IAC3B,OAAO,EAAE,aAAa,CAAA;IACtB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,cAAc,EAAE,OAAO,CAAA;IACvB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAA;IACtC,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IAEjB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAClB,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IACxB,eAAe,CAAC,EAAE,cAAc,EAAE,CAAA;CACnC,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,SAAS,GAAG,YAAY,GAAG,MAAM,GAAG,SAAS,GAAG,iBAAiB,CAAA;AAEnG,MAAM,MAAM,mBAAmB,GAAG;IAChC,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,YAAY,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,uBAAuB,GAC/B;IAAE,GAAG,EAAE,MAAM,EAAE,CAAC;IAAC,cAAc,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,GACxE;IAAE,mBAAmB,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ikatec/digisac-api-sdk",
-  "version": "4.4.1",
+  "version": "4.5.1",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",

package/src/apis/cards/CardsApi.test.ts

@@ -0,0 +1,128 @@
+import { beforeEach, describe, expect, it, vi } from 'vitest'
+import type { ApiClient } from '../../core/ApiClient'
+import { CardsApi } from './CardsApi'
+
+// ── Mock client factory ──────────────────────────────────────────────
+
+function createMockClient(): ApiClient {
+  return {
+    setAccessToken: vi.fn().mockReturnThis(),
+    request: vi.fn(),
+    get: vi.fn(),
+    post: vi.fn(),
+    put: vi.fn(),
+    patch: vi.fn(),
+    delete: vi.fn(),
+  }
+}
+
+const headers = { 'X-Custom': 'value' }
+
+// ── Tests ────────────────────────────────────────────────────────────
+
+describe('CardsApi', () => {
+  let client: ReturnType<typeof createMockClient>
+  let api: CardsApi
+
+  beforeEach(() => {
+    client = createMockClient()
+    api = new CardsApi(client)
+  })
+
+  describe('bulkMove', () => {
+    it('calls client.put with /cards/bulk-move and body', async () => {
+      vi.mocked(client.put).mockResolvedValue({ movedCount: 2, ignoredCount: 0 })
+      const body = {
+        ids: ['c1', 'c2'],
+        originPipelineStageId: 's1',
+        pipelineId: 'p1',
+        pipelineStageId: 's2',
+      }
+      const result = await api.bulkMove(body, headers)
+      expect(client.put).toHaveBeenCalledWith('/cards/bulk-move', body, headers)
+      expect(result).toEqual({ movedCount: 2, ignoredCount: 0 })
+    })
+  })
+
+  describe('updateOrder', () => {
+    it('calls client.put with /cards/order/:id and the order', async () => {
+      await api.updateOrder('c1', 3)
+      expect(client.put).toHaveBeenCalledWith('/cards/order/c1', { order: 3 }, undefined)
+    })
+  })
+
+  describe('products', () => {
+    it('saveProduct calls client.post with /cards/product and body', async () => {
+      vi.mocked(client.post).mockResolvedValue({ message: 'Operação realizada com sucesso.' })
+      const body = { cardId: 'c1', name: 'Plano', ammount: 2, value: 99.9 }
+      const result = await api.saveProduct(body)
+      expect(client.post).toHaveBeenCalledWith('/cards/product', body, undefined)
+      expect(result).toEqual({ message: 'Operação realizada com sucesso.' })
+    })
+
+    it('deleteProduct calls client.delete with /cards/product/:id', async () => {
+      await api.deleteProduct('pr1', headers)
+      expect(client.delete).toHaveBeenCalledWith('/cards/product/pr1', headers)
+    })
+  })
+
+  describe('comments', () => {
+    it('saveComment calls client.post with /cards/comment and body', async () => {
+      const body = { cardId: 'c1', comment: 'Ligar amanhã' }
+      await api.saveComment(body)
+      expect(client.post).toHaveBeenCalledWith('/cards/comment', body, undefined)
+    })
+
+    it('saveComment edits by id', async () => {
+      const body = { id: 'cm1', comment: 'Ligar hoje', removedFileIds: ['f1'] }
+      await api.saveComment(body, headers)
+      expect(client.post).toHaveBeenCalledWith('/cards/comment', body, headers)
+    })
+
+    it('deleteComment calls client.delete with /cards/comment/:id', async () => {
+      await api.deleteComment('cm1')
+      expect(client.delete).toHaveBeenCalledWith('/cards/comment/cm1', undefined)
+    })
+  })
+
+  describe('reads', () => {
+    it('getOwners calls client.post with /cards/owners and no body', async () => {
+      vi.mocked(client.post).mockResolvedValue([{ id: 'u1', name: 'Ana', disabled: false }])
+      const result = await api.getOwners()
+      expect(client.post).toHaveBeenCalledWith('/cards/owners', undefined, undefined)
+      expect(result).toEqual([{ id: 'u1', name: 'Ana', disabled: false }])
+    })
+
+    it('getCards calls client.post with /cards/getCards and the query', async () => {
+      const body = {
+        where: { accountId: 'a1', pipelineStageId: 's1' },
+        attributes: ['id', 'title'] as ('id' | 'title')[],
+        order: [['contact.name', 'ASC']] as ['contact.name', 'ASC'][],
+        limit: 20,
+      }
+      await api.getCards(body)
+      expect(client.post).toHaveBeenCalledWith('/cards/getCards', body, undefined)
+    })
+
+    it('getContactTotals calls client.post with /cards/contact-totals/:contactId', async () => {
+      vi.mocked(client.post).mockResolvedValue({ totalOpen: 1 })
+      const result = await api.getContactTotals('ct1', headers)
+      expect(client.post).toHaveBeenCalledWith('/cards/contact-totals/ct1', undefined, headers)
+      expect(result).toEqual({ totalOpen: 1 })
+    })
+  })
+
+  describe('error propagation', () => {
+    it('propagates errors from bulkMove', async () => {
+      vi.mocked(client.put).mockRejectedValue(new Error('At least one card id is required.'))
+      await expect(
+        api.bulkMove({
+          ids: [],
+          originPipelineStageId: 's1',
+          pipelineId: 'p1',
+          pipelineStageId: 's2',
+        }),
+      ).rejects.toThrow('At least one card id is required.')
+    })
+  })
+})

package/src/apis/cards/CardsApi.ts

@@ -1,9 +1,132 @@
 import type { ApiClient } from '../../core/ApiClient'
 import { BaseCrudApi } from '../../core/BaseCrudApi'
-import type { Card, CreateCardPayload, UpdateCardPayload } from './types'
+import type {
+  BulkMoveCardsPayload,
+  BulkMoveCardsResult,
+  Card,
+  CardContactTotals,
+  CardOperationResult,
+  CardOwner,
+  CreateCardPayload,
+  GetCardsPayload,
+  SaveCardCommentPayload,
+  SaveCardProductPayload,
+  UpdateCardPayload,
+} from './types'
 
 export class CardsApi extends BaseCrudApi<Card, CreateCardPayload, UpdateCardPayload> {
   constructor(client: ApiClient) {
     super(client, '/cards')
   }
+
+  /**
+   * Moves several cards of one stage to another stage (of the same or another pipeline),
+   * clearing their status/reason unless given. Cards outside the account or not in
+   * `originPipelineStageId` are skipped and counted in `ignoredCount`.
+   * @permissions pipelines.opportunity.update
+   */
+  bulkMove(
+    body: BulkMoveCardsPayload,
+    headers?: Record<string, string>,
+  ): Promise<BulkMoveCardsResult> {
+    return this.client.put<BulkMoveCardsResult, BulkMoveCardsPayload>(
+      `${this.basePath}/bulk-move`,
+      body,
+      headers,
+    )
+  }
+
+  /**
+   * Moves a card to the `order` position of its stage, shifting the cards in between. Resolves
+   * to the card as stored. The backend refuses `0` (400 `required`), although the first card of
+   * a stage has order 0.
+   * @permissions pipelines.opportunity.update
+   */
+  updateOrder(id: string, order: number, headers?: Record<string, string>): Promise<Card> {
+    return this.client.put<Card, { order: number }>(
+      `${this.basePath}/order/${id}`,
+      { order },
+      headers,
+    )
+  }
+
+  /**
+   * Adds a product to a card, or updates the product of `body.id`.
+   * @permissions pipelines.opportunity.update
+   */
+  saveProduct(
+    body: SaveCardProductPayload,
+    headers?: Record<string, string>,
+  ): Promise<CardOperationResult> {
+    return this.client.post<CardOperationResult, SaveCardProductPayload>(
+      `${this.basePath}/product`,
+      body,
+      headers,
+    )
+  }
+
+  /**
+   * Deletes a product of a card. An unknown id also resolves with 200, with the message
+   * `'Produto não encontrado'`.
+   * @permissions pipelines.opportunity.update
+   */
+  deleteProduct(id: string, headers?: Record<string, string>): Promise<CardOperationResult> {
+    return this.client.delete<CardOperationResult>(`${this.basePath}/product/${id}`, headers)
+  }
+
+  /**
+   * Adds a comment to a card, or edits the comment of `body.id`. Resolves to a message, not to
+   * the comment — read it back through `getById(cardId, { include: ['comments'] })`. A card or
+   * comment of another account fails with 404.
+   * @permissions pipelines.opportunity.update
+   */
+  saveComment(
+    body: SaveCardCommentPayload,
+    headers?: Record<string, string>,
+  ): Promise<CardOperationResult> {
+    return this.client.post<CardOperationResult, SaveCardCommentPayload>(
+      `${this.basePath}/comment`,
+      body,
+      headers,
+    )
+  }
+
+  /**
+   * Deletes a comment of a card. Resolves with no content; unknown → 404.
+   * @permissions pipelines.opportunity.update
+   */
+  deleteComment(id: string, headers?: Record<string, string>): Promise<void> {
+    return this.client.delete<void>(`${this.basePath}/comment/${id}`, headers)
+  }
+
+  /**
+   * Lists the users of the account that can own a card, sorted by name.
+   * @permissions pipelines.opportunity.view
+   */
+  getOwners(headers?: Record<string, string>): Promise<CardOwner[]> {
+    return this.client.post<CardOwner[]>(`${this.basePath}/owners`, undefined, headers)
+  }
+
+  /**
+   * Lists cards with the board query of the UI. Resolves to a plain array (no pagination).
+   * @permissions pipelines.opportunity.view
+   */
+  getCards(body: GetCardsPayload, headers?: Record<string, string>): Promise<Card[]> {
+    return this.client.post<Card[], GetCardsPayload>(`${this.basePath}/getCards`, body, headers)
+  }
+
+  /**
+   * Counts the open cards of a contact visible to the caller.
+   * @permissions pipelines.opportunity.view
+   */
+  getContactTotals(
+    contactId: string,
+    headers?: Record<string, string>,
+  ): Promise<CardContactTotals> {
+    return this.client.post<CardContactTotals>(
+      `${this.basePath}/contact-totals/${contactId}`,
+      undefined,
+      headers,
+    )
+  }
 }

package/src/apis/cards/types.ts

@@ -1,3 +1,4 @@
+import type { ListQuery, WhereClause } from '../../core/types'
 import type { Contact } from '../contacts/types'
 import type {
   Pipeline,
@@ -98,6 +99,8 @@ export type Card = {
   lastMessage?: unknown
   /** Only on getMany/getById answers: sum of the products (`ammount * value`). */
   totalValue?: number
+  /** Only on `getCards` answers. */
+  contactName?: string
   // relationships
   contact?: Contact | null
   owner?: User | null
@@ -158,3 +161,81 @@ export type UpdateCardPayload = {
   success?: boolean | null
   finishedAt?: string | null
 }
+
+/** Answer of the product and comment writes — the entity itself is not returned. */
+export type CardOperationResult = { message: string }
+
+export type BulkMoveCardsPayload = {
+  /** At least one; ids outside the account or not in `originPipelineStageId` are ignored. */
+  ids: string[]
+  originPipelineStageId: string
+  /** Destination pipeline; `pipelineStageId` must be one of its stages. */
+  pipelineId: string
+  pipelineStageId: string
+  /** Must be a status of the destination stage, unless it is the last stage. */
+  statusId?: string
+  /** Kept only when the destination is the last stage (then `finishedAt` is set). */
+  success?: boolean
+  reasonId?: string
+}
+
+export type BulkMoveCardsResult = { movedCount: number; ignoredCount: number }
+
+/**
+ * Creates a product of a card, or updates the product of `id`. No validation on the backend:
+ * a missing `name`/`ammount`/`value` fails with 500.
+ */
+export type SaveCardProductPayload = {
+  id?: string
+  cardId: string
+  name: string
+  /** Quantity — integer (the backend column is spelled `ammount`). */
+  ammount: number
+  value: number
+}
+
+/**
+ * Creates a comment on `cardId`, or edits the comment of `id`. It needs text or at least one
+ * file. `files` are references to files already uploaded (see `FilesApi`) — `.pdf`, `.txt`,
+ * `.html` or `.md`, up to 10 files of 10 MB.
+ */
+export type SaveCardCommentPayload =
+  | { id?: undefined; cardId: string; comment?: string; files?: { id: string }[] }
+  | {
+      id: string
+      cardId?: string
+      comment?: string
+      files?: { id: string }[]
+      removedFileIds?: string[]
+    }
+
+export type CardOwner = {
+  id: string
+  /** Suffixed with " - Sem permissão" (in the caller's language) when `disabled`. */
+  name: string
+  /** `true` for users without `pipelines.opportunity.update`. */
+  disabled: boolean
+}
+
+/**
+ * Body of `POST /cards/getCards`: Sequelize options sent as-is. The route does **not** scope the
+ * query by account — without `where.accountId` it answers cards of other accounts. `order`
+ * accepts card fields and `contact.name`.
+ */
+export type GetCardsPayload = Omit<
+  ListQuery<Card>,
+  'page' | 'perPage' | 'paginate' | 'where' | 'order' | 'attributes'
+> & {
+  where: WhereClause<Card> & { accountId: string }
+  /**
+   * The card columns to answer. Required in practice: the backend selects only these (plus the
+   * computed `contactName` and `totalValue`), so without them each card has no other field.
+   */
+  attributes: (keyof Card & string)[]
+  order?: [(keyof Card & string) | 'contact.name', 'ASC' | 'DESC'][]
+}
+
+export type CardContactTotals = {
+  /** Open cards of the contact (not archived, not finished, in a pipeline that exists). */
+  totalOpen: number
+}