sdk-javascript/src/types/mResponses.ts at cb7f0b4de96cab2e3f0fdb4593d1d57577de4dcd · kuzzleio/sdk-javascript · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
import { JSONObject } from "./JSONObject";

type mResponseErrors = Array<{
  /**
   * Original document that caused the error
   */
  document: {
    _id: string;
    body: JSONObject;
  };

  /**
   * HTTP error status code
   */
  status: number;

  /**
   * Human readable reason
   */
  reason: string;
}>;

export type mCreateResponse = {
  /**
   * Array of succeeded operations
   */
  successes: Array<{
    /**
     * Document unique identifier
     */
    _id: string;

    /**
     * Document content
     */
    _source: JSONObject;

    /**
     * Document version number
     */
    _version: number;

    /**
     * `true` if document is created
     */
    created: boolean;
  }>;

  /**
   * Arrays of errored operations
   */
  errors: mResponseErrors;
};

export type mCreateOrReplaceResponse = mCreateResponse;
export type mUpsertResponse = mCreateResponse;

export type mReplaceResponse = {
  /**
   * Array of succeeded operations
   */
  successes: Array<{
    /**
     * Document unique identifier
     */
    _id: string;

    /**
     * Document content
     */
    _source: JSONObject;

    /**
     * Document version number
     */
    _version: number;
  }>;

  /**
   * Arrays of errored operations
   */
  errors: mResponseErrors;
};

export type mUpdateResponse = mReplaceResponse;

export type mDeleteResponse = {
  /**
   * IDs of deleted documents
   */
  successes: string[];

  errors: Array<{
    /**
     * Document unique identifier
     */
    _id: string;

    /**
     * Human readable reason
     */
    reason: string;
  }>;
};