Disputes

Utility Types

type DisputeSummary = {
  id: string;
  title: string;
  description: string;
  status: string;
  role: "Complainant" | "Respondant";
};

type Evidence = {
  label: string;
  url: string;
  date_submitted: string;
};

type Expert = {
  id: string;
  full_name: string;
  email: string;
  phone: string;
  role: string;
};

Utility Functions

Endpoint: GET /utils/dispute_statuses
Headers:
- None expected
Will return a list of all possible states a dispute can be in:

  type DisputeStatusesResponse = string[];

Dispute Summaries

Endpoint: GET /disputes
Headers:
- Authorization: Bearer <JWT>

Will return a list of dispute summaries the user is involved in:

type DisputeListResponse = DisputeSummary[];

Dispute Details

Endpoint: GET /disputes/{id}
Headers:
- Authorization: Bearer <JWT>

Will return detailed information about a dispute the user is involved in:

type DisputeResponse = {
  id: string;
  title: string;
  description: string;
  status: string;
  date_created: string;

  evidence: Evidence[];
  experts: Expert[];
};

Dispute Creation

Endpoint: POST /disputes/create
Headers:
- Authorization: Bearer <JWT>

type DisputeCreateRequest = {
  title : string;
  description : string;
  respondent[full_name] : string;
  respondent[email] : string;
  respondent[telephone] : string;
  files : File
};

The response will return the ID of the newly-created dispute:

type DisputeCreateResponse  = {
  id: number;
}

Dispute Evidence upload

Endpoint: POST /disputes/{id}/evidence
Headers:
- Authorization: Bearer <JWT>

NOTE: This endpoint involves files being exchanged. This requires the use of multipart/form-data instead of JSON. This is left incomplete until this exception is documenteda.

interface EvidenceUploadRequest {
  file: File[];
}

Dispute Status Change

Endpoint: PUT /dispute/status
Headers:
- Authorization: Bearer <JWT>

type UpdateRequest = {
  dispute_id : int;
  status : string;
};

# Dispute Negotiating Party Operations

## Approving
- **Endpoint:** `POST /disputes/{id}/experts/approve`
- **Headers:**
    - `Authorization: Bearer <JWT>`

```ts
interface ExpertApproveRequest {
  expert_id: string;
}

The response will return a success message

type ExpertApproveResponse = string;

Rejecting

Endpoint: POST /disputes/{id}/experts/reject
Headers:
- Authorization: Bearer <JWT>

interface ExpertRejectRequest {
  expert_id: string;
  reason: string;
}