@algolia/ingestion 1.0.0-alpha.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (190) hide show
  1. package/dist/builds/browser.d.ts +6 -0
  2. package/dist/builds/browser.d.ts.map +1 -0
  3. package/dist/builds/node.d.ts +6 -0
  4. package/dist/builds/node.d.ts.map +1 -0
  5. package/dist/ingestion.cjs.js +815 -0
  6. package/dist/ingestion.esm.browser.js +1450 -0
  7. package/dist/ingestion.esm.node.js +810 -0
  8. package/dist/ingestion.umd.js +2 -0
  9. package/dist/model/actionType.d.ts +2 -0
  10. package/dist/model/actionType.d.ts.map +1 -0
  11. package/dist/model/authAPIKey.d.ts +4 -0
  12. package/dist/model/authAPIKey.d.ts.map +1 -0
  13. package/dist/model/authAlgolia.d.ts +5 -0
  14. package/dist/model/authAlgolia.d.ts.map +1 -0
  15. package/dist/model/authBasic.d.ts +5 -0
  16. package/dist/model/authBasic.d.ts.map +1 -0
  17. package/dist/model/authGoogleServiceAccount.d.ts +5 -0
  18. package/dist/model/authGoogleServiceAccount.d.ts.map +1 -0
  19. package/dist/model/authInput.d.ts +7 -0
  20. package/dist/model/authInput.d.ts.map +1 -0
  21. package/dist/model/authOAuth.d.ts +7 -0
  22. package/dist/model/authOAuth.d.ts.map +1 -0
  23. package/dist/model/authentication.d.ts +19 -0
  24. package/dist/model/authentication.d.ts.map +1 -0
  25. package/dist/model/authenticationCreate.d.ts +10 -0
  26. package/dist/model/authenticationCreate.d.ts.map +1 -0
  27. package/dist/model/authenticationCreateResponse.d.ts +9 -0
  28. package/dist/model/authenticationCreateResponse.d.ts.map +1 -0
  29. package/dist/model/authenticationType.d.ts +2 -0
  30. package/dist/model/authenticationType.d.ts.map +1 -0
  31. package/dist/model/authenticationUpdate.d.ts +10 -0
  32. package/dist/model/authenticationUpdate.d.ts.map +1 -0
  33. package/dist/model/authenticationUpdateResponse.d.ts +9 -0
  34. package/dist/model/authenticationUpdateResponse.d.ts.map +1 -0
  35. package/dist/model/clientMethodProps.d.ts +265 -0
  36. package/dist/model/clientMethodProps.d.ts.map +1 -0
  37. package/dist/model/deleteResponse.d.ts +7 -0
  38. package/dist/model/deleteResponse.d.ts.map +1 -0
  39. package/dist/model/destination.d.ts +18 -0
  40. package/dist/model/destination.d.ts.map +1 -0
  41. package/dist/model/destinationCreate.d.ts +9 -0
  42. package/dist/model/destinationCreate.d.ts.map +1 -0
  43. package/dist/model/destinationCreateResponse.d.ts +9 -0
  44. package/dist/model/destinationCreateResponse.d.ts.map +1 -0
  45. package/dist/model/destinationIndexName.d.ts +4 -0
  46. package/dist/model/destinationIndexName.d.ts.map +1 -0
  47. package/dist/model/destinationIndexPrefix.d.ts +4 -0
  48. package/dist/model/destinationIndexPrefix.d.ts.map +1 -0
  49. package/dist/model/destinationInput.d.ts +4 -0
  50. package/dist/model/destinationInput.d.ts.map +1 -0
  51. package/dist/model/destinationType.d.ts +2 -0
  52. package/dist/model/destinationType.d.ts.map +1 -0
  53. package/dist/model/destinationUpdate.d.ts +9 -0
  54. package/dist/model/destinationUpdate.d.ts.map +1 -0
  55. package/dist/model/destinationUpdateResponse.d.ts +9 -0
  56. package/dist/model/destinationUpdateResponse.d.ts.map +1 -0
  57. package/dist/model/errorBase.d.ts +7 -0
  58. package/dist/model/errorBase.d.ts.map +1 -0
  59. package/dist/model/event.d.ts +15 -0
  60. package/dist/model/event.d.ts.map +1 -0
  61. package/dist/model/eventStatus.d.ts +2 -0
  62. package/dist/model/eventStatus.d.ts.map +1 -0
  63. package/dist/model/eventType.d.ts +2 -0
  64. package/dist/model/eventType.d.ts.map +1 -0
  65. package/dist/model/index.d.ts +59 -0
  66. package/dist/model/index.d.ts.map +1 -0
  67. package/dist/model/listAuthenticationsResponse.d.ts +7 -0
  68. package/dist/model/listAuthenticationsResponse.d.ts.map +1 -0
  69. package/dist/model/listDestinationsResponse.d.ts +7 -0
  70. package/dist/model/listDestinationsResponse.d.ts.map +1 -0
  71. package/dist/model/listEventsResponse.d.ts +7 -0
  72. package/dist/model/listEventsResponse.d.ts.map +1 -0
  73. package/dist/model/listSourcesResponse.d.ts +7 -0
  74. package/dist/model/listSourcesResponse.d.ts.map +1 -0
  75. package/dist/model/listTasksResponse.d.ts +7 -0
  76. package/dist/model/listTasksResponse.d.ts.map +1 -0
  77. package/dist/model/pagination.d.ts +7 -0
  78. package/dist/model/pagination.d.ts.map +1 -0
  79. package/dist/model/platformType.d.ts +2 -0
  80. package/dist/model/platformType.d.ts.map +1 -0
  81. package/dist/model/run.d.ts +30 -0
  82. package/dist/model/run.d.ts.map +1 -0
  83. package/dist/model/runListResponse.d.ts +7 -0
  84. package/dist/model/runListResponse.d.ts.map +1 -0
  85. package/dist/model/runOutcome.d.ts +2 -0
  86. package/dist/model/runOutcome.d.ts.map +1 -0
  87. package/dist/model/runProgress.d.ts +5 -0
  88. package/dist/model/runProgress.d.ts.map +1 -0
  89. package/dist/model/runResponse.d.ts +8 -0
  90. package/dist/model/runResponse.d.ts.map +1 -0
  91. package/dist/model/runStatus.d.ts +2 -0
  92. package/dist/model/runStatus.d.ts.map +1 -0
  93. package/dist/model/runType.d.ts +2 -0
  94. package/dist/model/runType.d.ts.map +1 -0
  95. package/dist/model/source.d.ts +18 -0
  96. package/dist/model/source.d.ts.map +1 -0
  97. package/dist/model/sourceBigCommerce.d.ts +4 -0
  98. package/dist/model/sourceBigCommerce.d.ts.map +1 -0
  99. package/dist/model/sourceCommercetools.d.ts +6 -0
  100. package/dist/model/sourceCommercetools.d.ts.map +1 -0
  101. package/dist/model/sourceCreate.d.ts +9 -0
  102. package/dist/model/sourceCreate.d.ts.map +1 -0
  103. package/dist/model/sourceCreateResponse.d.ts +9 -0
  104. package/dist/model/sourceCreateResponse.d.ts.map +1 -0
  105. package/dist/model/sourceInput.d.ts +4 -0
  106. package/dist/model/sourceInput.d.ts.map +1 -0
  107. package/dist/model/sourceType.d.ts +2 -0
  108. package/dist/model/sourceType.d.ts.map +1 -0
  109. package/dist/model/sourceUpdate.d.ts +9 -0
  110. package/dist/model/sourceUpdate.d.ts.map +1 -0
  111. package/dist/model/sourceUpdateResponse.d.ts +9 -0
  112. package/dist/model/sourceUpdateResponse.d.ts.map +1 -0
  113. package/dist/model/task.d.ts +21 -0
  114. package/dist/model/task.d.ts.map +1 -0
  115. package/dist/model/taskCreate.d.ts +10 -0
  116. package/dist/model/taskCreate.d.ts.map +1 -0
  117. package/dist/model/taskCreateResponse.d.ts +8 -0
  118. package/dist/model/taskCreateResponse.d.ts.map +1 -0
  119. package/dist/model/taskUpdate.d.ts +7 -0
  120. package/dist/model/taskUpdate.d.ts.map +1 -0
  121. package/dist/model/taskUpdateResponse.d.ts +8 -0
  122. package/dist/model/taskUpdateResponse.d.ts.map +1 -0
  123. package/dist/model/trigger.d.ts +6 -0
  124. package/dist/model/trigger.d.ts.map +1 -0
  125. package/dist/model/triggerType.d.ts +2 -0
  126. package/dist/model/triggerType.d.ts.map +1 -0
  127. package/dist/src/ingestionClient.d.ts +322 -0
  128. package/dist/src/ingestionClient.d.ts.map +1 -0
  129. package/index.d.ts +2 -0
  130. package/index.js +2 -0
  131. package/model/actionType.ts +3 -0
  132. package/model/authAPIKey.ts +5 -0
  133. package/model/authAlgolia.ts +7 -0
  134. package/model/authBasic.ts +7 -0
  135. package/model/authGoogleServiceAccount.ts +7 -0
  136. package/model/authInput.ts +14 -0
  137. package/model/authOAuth.ts +11 -0
  138. package/model/authentication.ts +27 -0
  139. package/model/authenticationCreate.ts +15 -0
  140. package/model/authenticationCreateResponse.ts +12 -0
  141. package/model/authenticationType.ts +8 -0
  142. package/model/authenticationUpdate.ts +15 -0
  143. package/model/authenticationUpdateResponse.ts +12 -0
  144. package/model/clientMethodProps.ts +290 -0
  145. package/model/deleteResponse.ts +8 -0
  146. package/model/destination.ts +26 -0
  147. package/model/destinationCreate.ts +14 -0
  148. package/model/destinationCreateResponse.ts +12 -0
  149. package/model/destinationIndexName.ts +5 -0
  150. package/model/destinationIndexPrefix.ts +5 -0
  151. package/model/destinationInput.ts +6 -0
  152. package/model/destinationType.ts +3 -0
  153. package/model/destinationUpdate.ts +14 -0
  154. package/model/destinationUpdateResponse.ts +12 -0
  155. package/model/errorBase.ts +8 -0
  156. package/model/event.ts +23 -0
  157. package/model/eventStatus.ts +8 -0
  158. package/model/eventType.ts +3 -0
  159. package/model/index.ts +60 -0
  160. package/model/listAuthenticationsResponse.ts +10 -0
  161. package/model/listDestinationsResponse.ts +10 -0
  162. package/model/listEventsResponse.ts +10 -0
  163. package/model/listSourcesResponse.ts +10 -0
  164. package/model/listTasksResponse.ts +10 -0
  165. package/model/pagination.ts +11 -0
  166. package/model/platformType.ts +3 -0
  167. package/model/run.ts +42 -0
  168. package/model/runListResponse.ts +10 -0
  169. package/model/runOutcome.ts +3 -0
  170. package/model/runProgress.ts +7 -0
  171. package/model/runResponse.ts +10 -0
  172. package/model/runStatus.ts +3 -0
  173. package/model/runType.ts +3 -0
  174. package/model/source.ts +26 -0
  175. package/model/sourceBigCommerce.ts +5 -0
  176. package/model/sourceCommercetools.ts +9 -0
  177. package/model/sourceCreate.ts +14 -0
  178. package/model/sourceCreateResponse.ts +12 -0
  179. package/model/sourceInput.ts +6 -0
  180. package/model/sourceType.ts +3 -0
  181. package/model/sourceUpdate.ts +14 -0
  182. package/model/sourceUpdateResponse.ts +12 -0
  183. package/model/task.ts +32 -0
  184. package/model/taskCreate.ts +16 -0
  185. package/model/taskCreateResponse.ts +10 -0
  186. package/model/taskUpdate.ts +11 -0
  187. package/model/taskUpdateResponse.ts +10 -0
  188. package/model/trigger.ts +9 -0
  189. package/model/triggerType.ts +3 -0
  190. package/package.json +53 -0
@@ -0,0 +1,322 @@
1
+ import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
2
+ import type { Authentication } from '../model/authentication';
3
+ import type { AuthenticationCreate } from '../model/authenticationCreate';
4
+ import type { AuthenticationCreateResponse } from '../model/authenticationCreateResponse';
5
+ import type { AuthenticationUpdateResponse } from '../model/authenticationUpdateResponse';
6
+ import type { DeleteAuthenticationProps, DeleteDestinationProps, DeleteSourceProps, DeleteTaskProps, DisableTaskProps, EnableTaskProps, GetAuthenticationProps, GetAuthenticationsProps, GetDestinationProps, GetDestinationsProps, GetEventProps, GetEventsProps, GetRunProps, GetRunsProps, GetRunsByTaskIDProps, GetSourceProps, GetSourcesProps, GetTaskProps, GetTasksProps, RunTaskProps, UpdateAuthenticationProps, UpdateDestinationProps, UpdateSourceProps, UpdateTaskProps } from '../model/clientMethodProps';
7
+ import type { DeleteResponse } from '../model/deleteResponse';
8
+ import type { Destination } from '../model/destination';
9
+ import type { DestinationCreate } from '../model/destinationCreate';
10
+ import type { DestinationCreateResponse } from '../model/destinationCreateResponse';
11
+ import type { DestinationUpdateResponse } from '../model/destinationUpdateResponse';
12
+ import type { Event } from '../model/event';
13
+ import type { ListAuthenticationsResponse } from '../model/listAuthenticationsResponse';
14
+ import type { ListDestinationsResponse } from '../model/listDestinationsResponse';
15
+ import type { ListEventsResponse } from '../model/listEventsResponse';
16
+ import type { ListSourcesResponse } from '../model/listSourcesResponse';
17
+ import type { ListTasksResponse } from '../model/listTasksResponse';
18
+ import type { Run } from '../model/run';
19
+ import type { RunListResponse } from '../model/runListResponse';
20
+ import type { RunResponse } from '../model/runResponse';
21
+ import type { Source } from '../model/source';
22
+ import type { SourceCreate } from '../model/sourceCreate';
23
+ import type { SourceCreateResponse } from '../model/sourceCreateResponse';
24
+ import type { SourceUpdateResponse } from '../model/sourceUpdateResponse';
25
+ import type { Task } from '../model/task';
26
+ import type { TaskCreate } from '../model/taskCreate';
27
+ import type { TaskCreateResponse } from '../model/taskCreateResponse';
28
+ import type { TaskUpdateResponse } from '../model/taskUpdateResponse';
29
+ export declare const apiClientVersion = "1.0.0-alpha.2";
30
+ export declare const REGIONS: readonly ["us"];
31
+ export declare type Region = typeof REGIONS[number];
32
+ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
33
+ region: Region;
34
+ }): {
35
+ transporter: import("@algolia/client-common").Transporter;
36
+ /**
37
+ * The `appId` currently in use.
38
+ */
39
+ appId: string;
40
+ /**
41
+ * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
42
+ */
43
+ clearCache(): Promise<void>;
44
+ /**
45
+ * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
46
+ */
47
+ readonly _ua: string;
48
+ /**
49
+ * Adds a `segment` to the `x-algolia-agent` sent with every requests.
50
+ *
51
+ * @param segment - The algolia agent (user-agent) segment to add.
52
+ * @param version - The version of the agent.
53
+ */
54
+ addAlgoliaAgent(segment: string, version?: string): void;
55
+ /**
56
+ * Create a authentication.
57
+ *
58
+ * @summary Create a authentication.
59
+ * @param authenticationCreate -.
60
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
61
+ */
62
+ createAuthentication(authenticationCreate: AuthenticationCreate, requestOptions?: RequestOptions): Promise<AuthenticationCreateResponse>;
63
+ /**
64
+ * Create a destination.
65
+ *
66
+ * @summary Create a destination.
67
+ * @param destinationCreate -.
68
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
69
+ */
70
+ createDestination(destinationCreate: DestinationCreate, requestOptions?: RequestOptions): Promise<DestinationCreateResponse>;
71
+ /**
72
+ * Create a source.
73
+ *
74
+ * @summary Create a source.
75
+ * @param sourceCreate -.
76
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
77
+ */
78
+ createSource(sourceCreate: SourceCreate, requestOptions?: RequestOptions): Promise<SourceCreateResponse>;
79
+ /**
80
+ * Create a task.
81
+ *
82
+ * @summary Create a task.
83
+ * @param taskCreate -.
84
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
85
+ */
86
+ createTask(taskCreate: TaskCreate, requestOptions?: RequestOptions): Promise<TaskCreateResponse>;
87
+ /**
88
+ * Soft delete a authentication.
89
+ *
90
+ * @summary Delete a authentication.
91
+ * @param deleteAuthentication - The deleteAuthentication object.
92
+ * @param deleteAuthentication.authenticationID - The authentication uuid.
93
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
94
+ */
95
+ deleteAuthentication({ authenticationID }: DeleteAuthenticationProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
96
+ /**
97
+ * Soft delete a destination.
98
+ *
99
+ * @summary Delete a destination.
100
+ * @param deleteDestination - The deleteDestination object.
101
+ * @param deleteDestination.destinationID - The destination uuid.
102
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
103
+ */
104
+ deleteDestination({ destinationID }: DeleteDestinationProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
105
+ /**
106
+ * Soft delete a source.
107
+ *
108
+ * @summary Delete a source.
109
+ * @param deleteSource - The deleteSource object.
110
+ * @param deleteSource.sourceID - The source uuid.
111
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
112
+ */
113
+ deleteSource({ sourceID }: DeleteSourceProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
114
+ /**
115
+ * Soft delete a task.
116
+ *
117
+ * @summary Delete a task.
118
+ * @param deleteTask - The deleteTask object.
119
+ * @param deleteTask.taskID - The task uuid.
120
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
121
+ */
122
+ deleteTask({ taskID }: DeleteTaskProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
123
+ /**
124
+ * Disable a task.
125
+ *
126
+ * @summary Disable a task.
127
+ * @param disableTask - The disableTask object.
128
+ * @param disableTask.taskID - The task uuid.
129
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
130
+ */
131
+ disableTask({ taskID }: DisableTaskProps, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
132
+ /**
133
+ * Enable a task.
134
+ *
135
+ * @summary Enable a task.
136
+ * @param enableTask - The enableTask object.
137
+ * @param enableTask.taskID - The task uuid.
138
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
139
+ */
140
+ enableTask({ taskID }: EnableTaskProps, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
141
+ /**
142
+ * Get a authentication.
143
+ *
144
+ * @summary Get a authentication.
145
+ * @param getAuthentication - The getAuthentication object.
146
+ * @param getAuthentication.authenticationID - The authentication uuid.
147
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
148
+ */
149
+ getAuthentication({ authenticationID }: GetAuthenticationProps, requestOptions?: RequestOptions): Promise<Authentication>;
150
+ /**
151
+ * Get a list of authentications.
152
+ *
153
+ * @summary Get a list of authentications.
154
+ * @param getAuthentications - The getAuthentications object.
155
+ * @param getAuthentications.itemsPerPage - The number of items per page to return.
156
+ * @param getAuthentications.page - The page number to fetch, starting at 1.
157
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
158
+ */
159
+ getAuthentications({ itemsPerPage, page }?: GetAuthenticationsProps, requestOptions?: RequestOptions | undefined): Promise<ListAuthenticationsResponse>;
160
+ /**
161
+ * Get a destination.
162
+ *
163
+ * @summary Get a destination.
164
+ * @param getDestination - The getDestination object.
165
+ * @param getDestination.destinationID - The destination uuid.
166
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
167
+ */
168
+ getDestination({ destinationID }: GetDestinationProps, requestOptions?: RequestOptions): Promise<Destination>;
169
+ /**
170
+ * Get a list of destinations.
171
+ *
172
+ * @summary Get a list of destinations.
173
+ * @param getDestinations - The getDestinations object.
174
+ * @param getDestinations.itemsPerPage - The number of items per page to return.
175
+ * @param getDestinations.page - The page number to fetch, starting at 1.
176
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
177
+ */
178
+ getDestinations({ itemsPerPage, page }?: GetDestinationsProps, requestOptions?: RequestOptions | undefined): Promise<ListDestinationsResponse>;
179
+ /**
180
+ * Get an event in a specific run.
181
+ *
182
+ * @summary Get an event in a specific run.
183
+ * @param getEvent - The getEvent object.
184
+ * @param getEvent.runID - The run uuid.
185
+ * @param getEvent.eventID - The event uuid.
186
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
187
+ */
188
+ getEvent({ runID, eventID }: GetEventProps, requestOptions?: RequestOptions): Promise<Event>;
189
+ /**
190
+ * Get a list of events for a specific run.
191
+ *
192
+ * @summary Get a list of events for a specific run.
193
+ * @param getEvents - The getEvents object.
194
+ * @param getEvents.runID - The run uuid.
195
+ * @param getEvents.itemsPerPage - The number of items per page to return.
196
+ * @param getEvents.page - The page number to fetch, starting at 1.
197
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
198
+ */
199
+ getEvents({ runID, itemsPerPage, page }: GetEventsProps, requestOptions?: RequestOptions): Promise<ListEventsResponse>;
200
+ /**
201
+ * Get a run.
202
+ *
203
+ * @summary Get a run.
204
+ * @param getRun - The getRun object.
205
+ * @param getRun.runID - The run uuid.
206
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
207
+ */
208
+ getRun({ runID }: GetRunProps, requestOptions?: RequestOptions): Promise<Run>;
209
+ /**
210
+ * Get a list of runs.
211
+ *
212
+ * @summary Get a list of runs.
213
+ * @param getRuns - The getRuns object.
214
+ * @param getRuns.itemsPerPage - The number of items per page to return.
215
+ * @param getRuns.page - The page number to fetch, starting at 1.
216
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
217
+ */
218
+ getRuns({ itemsPerPage, page }?: GetRunsProps, requestOptions?: RequestOptions | undefined): Promise<RunListResponse>;
219
+ /**
220
+ * Get a list of runs associated with a taskID.
221
+ *
222
+ * @summary Get a list of runs associated with a taskID.
223
+ * @param getRunsByTaskID - The getRunsByTaskID object.
224
+ * @param getRunsByTaskID.taskID - The task uuid.
225
+ * @param getRunsByTaskID.itemsPerPage - The number of items per page to return.
226
+ * @param getRunsByTaskID.page - The page number to fetch, starting at 1.
227
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
228
+ */
229
+ getRunsByTaskID({ taskID, itemsPerPage, page }: GetRunsByTaskIDProps, requestOptions?: RequestOptions): Promise<RunListResponse>;
230
+ /**
231
+ * Get a source.
232
+ *
233
+ * @summary Get a source.
234
+ * @param getSource - The getSource object.
235
+ * @param getSource.sourceID - The source uuid.
236
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
237
+ */
238
+ getSource({ sourceID }: GetSourceProps, requestOptions?: RequestOptions): Promise<Source>;
239
+ /**
240
+ * Get a list of sources.
241
+ *
242
+ * @summary Get a list of sources.
243
+ * @param getSources - The getSources object.
244
+ * @param getSources.itemsPerPage - The number of items per page to return.
245
+ * @param getSources.page - The page number to fetch, starting at 1.
246
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
247
+ */
248
+ getSources({ itemsPerPage, page }?: GetSourcesProps, requestOptions?: RequestOptions | undefined): Promise<ListSourcesResponse>;
249
+ /**
250
+ * Get a task.
251
+ *
252
+ * @summary Get a task.
253
+ * @param getTask - The getTask object.
254
+ * @param getTask.taskID - The task uuid.
255
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
256
+ */
257
+ getTask({ taskID }: GetTaskProps, requestOptions?: RequestOptions): Promise<Task>;
258
+ /**
259
+ * Get a list of tasks.
260
+ *
261
+ * @summary Get a list of tasks.
262
+ * @param getTasks - The getTasks object.
263
+ * @param getTasks.itemsPerPage - The number of items per page to return.
264
+ * @param getTasks.page - The page number to fetch, starting at 1.
265
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
266
+ */
267
+ getTasks({ itemsPerPage, page }?: GetTasksProps, requestOptions?: RequestOptions | undefined): Promise<ListTasksResponse>;
268
+ /**
269
+ * Run a task.
270
+ *
271
+ * @summary Run a task.
272
+ * @param runTask - The runTask object.
273
+ * @param runTask.taskID - The task uuid.
274
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
275
+ */
276
+ runTask({ taskID }: RunTaskProps, requestOptions?: RequestOptions): Promise<RunResponse>;
277
+ /**
278
+ * Update a authentication.
279
+ *
280
+ * @summary Update a authentication.
281
+ * @param updateAuthentication - The updateAuthentication object.
282
+ * @param updateAuthentication.authenticationID - The authentication uuid.
283
+ * @param updateAuthentication.authenticationUpdate - The authenticationUpdate object.
284
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
285
+ */
286
+ updateAuthentication({ authenticationID, authenticationUpdate }: UpdateAuthenticationProps, requestOptions?: RequestOptions): Promise<AuthenticationUpdateResponse>;
287
+ /**
288
+ * Update a destination.
289
+ *
290
+ * @summary Update a destination.
291
+ * @param updateDestination - The updateDestination object.
292
+ * @param updateDestination.destinationID - The destination uuid.
293
+ * @param updateDestination.destinationUpdate - The destinationUpdate object.
294
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
295
+ */
296
+ updateDestination({ destinationID, destinationUpdate }: UpdateDestinationProps, requestOptions?: RequestOptions): Promise<DestinationUpdateResponse>;
297
+ /**
298
+ * Update a source.
299
+ *
300
+ * @summary Update a source.
301
+ * @param updateSource - The updateSource object.
302
+ * @param updateSource.sourceID - The source uuid.
303
+ * @param updateSource.sourceUpdate - The sourceUpdate object.
304
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
305
+ */
306
+ updateSource({ sourceID, sourceUpdate }: UpdateSourceProps, requestOptions?: RequestOptions): Promise<SourceUpdateResponse>;
307
+ /**
308
+ * Update a task.
309
+ *
310
+ * @summary Update a task.
311
+ * @param updateTask - The updateTask object.
312
+ * @param updateTask.taskID - The task uuid.
313
+ * @param updateTask.taskUpdate - The taskUpdate object.
314
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
315
+ */
316
+ updateTask({ taskID, taskUpdate }: UpdateTaskProps, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
317
+ };
318
+ /**
319
+ * The client type.
320
+ */
321
+ export declare type IngestionClient = ReturnType<typeof createIngestionClient>;
322
+ //# sourceMappingURL=ingestionClient.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ingestionClient.d.ts","sourceRoot":"","sources":["../../src/ingestionClient.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AAC1F,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AAC1F,OAAO,KAAK,EACV,yBAAyB,EACzB,sBAAsB,EACtB,iBAAiB,EACjB,eAAe,EACf,gBAAgB,EAChB,eAAe,EACf,sBAAsB,EACtB,uBAAuB,EACvB,mBAAmB,EACnB,oBAAoB,EACpB,aAAa,EACb,cAAc,EACd,WAAW,EACX,YAAY,EACZ,oBAAoB,EACpB,cAAc,EACd,eAAe,EACf,YAAY,EACZ,aAAa,EACb,YAAY,EACZ,yBAAyB,EACzB,sBAAsB,EACtB,iBAAiB,EACjB,eAAe,EAChB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AACpF,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AACpF,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,sCAAsC,CAAC;AACxF,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAClF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAEtE,eAAO,MAAM,gBAAgB,kBAAkB,CAAC;AAEhD,eAAO,MAAM,OAAO,iBAAkB,CAAC;AACvC,oBAAY,MAAM,GAAG,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC;AAS5C,wBAAgB,qBAAqB,CAAC,EACpC,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,MAAM,EAAE,YAAY,EACpB,GAAG,OAAO,EACX,EAAE,mBAAmB,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE;;IA2BvC;;OAEG;;IAGH;;OAEG;kBACW,QAAQ,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;OAMG;+CAEqB,oBAAoB,mBACzB,cAAc,GAC9B,QAAQ,4BAA4B,CAAC;IAsBxC;;;;;;OAMG;yCAEkB,iBAAiB,mBACnB,cAAc,GAC9B,QAAQ,yBAAyB,CAAC;IAsBrC;;;;;;OAMG;+BAEa,YAAY,mBACT,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAsBhC;;;;;;OAMG;2BAEW,UAAU,mBACL,cAAc,GAC9B,QAAQ,kBAAkB,CAAC;IAiC9B;;;;;;;OAOG;+CAEqB,yBAAyB,mBAC9B,cAAc,GAC9B,QAAQ,cAAc,CAAC;IAwB1B;;;;;;;OAOG;yCAEkB,sBAAsB,mBACxB,cAAc,GAC9B,QAAQ,cAAc,CAAC;IAwB1B;;;;;;;OAOG;+BAEa,iBAAiB,mBACd,cAAc,GAC9B,QAAQ,cAAc,CAAC;IAwB1B;;;;;;;OAOG;2BAEW,eAAe,mBACV,cAAc,GAC9B,QAAQ,cAAc,CAAC;IAwB1B;;;;;;;OAOG;4BAEW,gBAAgB,mBACX,cAAc,GAC9B,QAAQ,kBAAkB,CAAC;IAwB9B;;;;;;;OAOG;2BAEW,eAAe,mBACV,cAAc,GAC9B,QAAQ,kBAAkB,CAAC;IAwB9B;;;;;;;OAOG;4CAEqB,sBAAsB,mBAC3B,cAAc,GAC9B,QAAQ,cAAc,CAAC;IAwB1B;;;;;;;;OAQG;gDAEuB,uBAAuB,mBAC/B,cAAc,GAAG,SAAS,GACzC,QAAQ,2BAA2B,CAAC;IAuBvC;;;;;;;OAOG;sCAEkB,mBAAmB,mBACrB,cAAc,GAC9B,QAAQ,WAAW,CAAC;IAwBvB;;;;;;;;OAQG;6CAEuB,oBAAoB,mBAC5B,cAAc,GAAG,SAAS,GACzC,QAAQ,wBAAwB,CAAC;IAuBpC;;;;;;;;OAQG;iCAEmB,aAAa,mBAChB,cAAc,GAC9B,QAAQ,KAAK,CAAC;IA6BjB;;;;;;;;;OASG;6CAE8B,cAAc,mBAC5B,cAAc,GAC9B,QAAQ,kBAAkB,CAAC;IAgC9B;;;;;;;OAOG;sBAEU,WAAW,mBACL,cAAc,GAC9B,QAAQ,GAAG,CAAC;IAsBf;;;;;;;;OAQG;qCAEuB,YAAY,mBACpB,cAAc,GAAG,SAAS,GACzC,QAAQ,eAAe,CAAC;IAuB3B;;;;;;;;;OASG;oDAE+B,oBAAoB,mBACnC,cAAc,GAC9B,QAAQ,eAAe,CAAC;IAgC3B;;;;;;;OAOG;4BAEa,cAAc,mBACX,cAAc,GAC9B,QAAQ,MAAM,CAAC;IAwBlB;;;;;;;;OAQG;wCAEuB,eAAe,mBACvB,cAAc,GAAG,SAAS,GACzC,QAAQ,mBAAmB,CAAC;IAuB/B;;;;;;;OAOG;wBAEW,YAAY,mBACP,cAAc,GAC9B,QAAQ,IAAI,CAAC;IAwBhB;;;;;;;;OAQG;sCAEuB,aAAa,mBACrB,cAAc,GAAG,SAAS,GACzC,QAAQ,iBAAiB,CAAC;IAuB7B;;;;;;;OAOG;wBAEW,YAAY,mBACP,cAAc,GAC9B,QAAQ,WAAW,CAAC;IAwBvB;;;;;;;;OAQG;qEAE2C,yBAAyB,mBACpD,cAAc,GAC9B,QAAQ,4BAA4B,CAAC;IA+BxC;;;;;;;;OAQG;4DAEqC,sBAAsB,mBAC3C,cAAc,GAC9B,QAAQ,yBAAyB,CAAC;IA+BrC;;;;;;;;OAQG;6CAE2B,iBAAiB,mBAC5B,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IA+BhC;;;;;;;;OAQG;uCAEuB,eAAe,mBACtB,cAAc,GAC9B,QAAQ,kBAAkB,CAAC;EA+BjC;AAED;;GAEG;AACH,oBAAY,eAAe,GAAG,UAAU,CAAC,OAAO,qBAAqB,CAAC,CAAC"}
package/index.d.ts ADDED
@@ -0,0 +1,2 @@
1
+ // eslint-disable-next-line import/no-unresolved
2
+ export * from './dist/builds/node';
package/index.js ADDED
@@ -0,0 +1,2 @@
1
+ // eslint-disable-next-line import/no-commonjs,import/extensions
2
+ module.exports = require('./dist/ingestion.cjs.js');
@@ -0,0 +1,3 @@
1
+ // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
2
+
3
+ export type ActionType = 'delete' | 'replace' | 'save';
@@ -0,0 +1,5 @@
1
+ // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
2
+
3
+ export type AuthAPIKey = {
4
+ key: string;
5
+ };
@@ -0,0 +1,7 @@
1
+ // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
2
+
3
+ export type AuthAlgolia = {
4
+ appID: string;
5
+
6
+ apiKey: string;
7
+ };
@@ -0,0 +1,7 @@
1
+ // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
2
+
3
+ export type AuthBasic = {
4
+ username: string;
5
+
6
+ password: string;
7
+ };
@@ -0,0 +1,7 @@
1
+ // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
2
+
3
+ export type AuthGoogleServiceAccount = {
4
+ clientEmail: string;
5
+
6
+ privateKey: string;
7
+ };
@@ -0,0 +1,14 @@
1
+ // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
2
+
3
+ import type { AuthAPIKey } from './authAPIKey';
4
+ import type { AuthAlgolia } from './authAlgolia';
5
+ import type { AuthBasic } from './authBasic';
6
+ import type { AuthGoogleServiceAccount } from './authGoogleServiceAccount';
7
+ import type { AuthOAuth } from './authOAuth';
8
+
9
+ export type AuthInput =
10
+ | AuthAlgolia
11
+ | AuthAPIKey
12
+ | AuthBasic
13
+ | AuthGoogleServiceAccount
14
+ | AuthOAuth;
@@ -0,0 +1,11 @@
1
+ // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
2
+
3
+ export type AuthOAuth = {
4
+ url: string;
5
+
6
+ client_id: string;
7
+
8
+ client_secret: string;
9
+
10
+ scope: string;
11
+ };
@@ -0,0 +1,27 @@
1
+ // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
2
+
3
+ import type { AuthInput } from './authInput';
4
+ import type { AuthenticationType } from './authenticationType';
5
+ import type { PlatformType } from './platformType';
6
+
7
+ export type Authentication = {
8
+ authenticationID: string;
9
+
10
+ type: AuthenticationType;
11
+
12
+ name: string;
13
+
14
+ platform?: PlatformType;
15
+
16
+ input: AuthInput;
17
+
18
+ /**
19
+ * Date of creation (RFC3339 format).
20
+ */
21
+ createdAt: string;
22
+
23
+ /**
24
+ * Date of last update (RFC3339 format).
25
+ */
26
+ updatedAt?: string;
27
+ };
@@ -0,0 +1,15 @@
1
+ // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
2
+
3
+ import type { AuthInput } from './authInput';
4
+ import type { AuthenticationType } from './authenticationType';
5
+ import type { PlatformType } from './platformType';
6
+
7
+ export type AuthenticationCreate = {
8
+ type: AuthenticationType;
9
+
10
+ name: string;
11
+
12
+ platform?: PlatformType;
13
+
14
+ input: AuthInput;
15
+ };
@@ -0,0 +1,12 @@
1
+ // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
2
+
3
+ export type AuthenticationCreateResponse = {
4
+ authenticationID: string;
5
+
6
+ name: string;
7
+
8
+ /**
9
+ * Date of creation (RFC3339 format).
10
+ */
11
+ createdAt: string;
12
+ };
@@ -0,0 +1,8 @@
1
+ // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
2
+
3
+ export type AuthenticationType =
4
+ | 'algolia'
5
+ | 'apiKey'
6
+ | 'basic'
7
+ | 'googleServiceAccount'
8
+ | 'oauth';
@@ -0,0 +1,15 @@
1
+ // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
2
+
3
+ import type { AuthInput } from './authInput';
4
+ import type { AuthenticationType } from './authenticationType';
5
+ import type { PlatformType } from './platformType';
6
+
7
+ export type AuthenticationUpdate = {
8
+ type?: AuthenticationType;
9
+
10
+ name?: string;
11
+
12
+ platform?: PlatformType;
13
+
14
+ input?: AuthInput;
15
+ };
@@ -0,0 +1,12 @@
1
+ // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
2
+
3
+ export type AuthenticationUpdateResponse = {
4
+ authenticationID: string;
5
+
6
+ name: string;
7
+
8
+ /**
9
+ * Date of last update (RFC3339 format).
10
+ */
11
+ updatedAt: string;
12
+ };