@algolia/ingestion 1.0.0-beta.1 → 1.0.0-beta.11
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.
- package/LICENSE +21 -0
- package/dist/builds/browser.d.ts +41 -33
- package/dist/builds/browser.d.ts.map +1 -1
- package/dist/builds/node.d.ts +41 -33
- package/dist/builds/node.d.ts.map +1 -1
- package/dist/ingestion.cjs +265 -32
- package/dist/ingestion.esm.browser.js +275 -49
- package/dist/ingestion.esm.node.js +265 -32
- package/dist/ingestion.umd.js +2 -2
- package/dist/model/authentication.d.ts +2 -2
- package/dist/model/authenticationCreateResponse.d.ts +1 -1
- package/dist/model/authenticationUpdateResponse.d.ts +1 -1
- package/dist/model/clientMethodProps.d.ts +57 -13
- package/dist/model/clientMethodProps.d.ts.map +1 -1
- package/dist/model/deleteResponse.d.ts +1 -1
- package/dist/model/destination.d.ts +2 -2
- package/dist/model/destinationCreateResponse.d.ts +1 -1
- package/dist/model/destinationUpdateResponse.d.ts +1 -1
- package/dist/model/dockerStreamsInput.d.ts +4 -0
- package/dist/model/dockerStreamsInput.d.ts.map +1 -0
- package/dist/model/event.d.ts +1 -1
- package/dist/model/index.d.ts +13 -5
- package/dist/model/index.d.ts.map +1 -1
- package/dist/model/listTransformationsResponse.d.ts +10 -0
- package/dist/model/listTransformationsResponse.d.ts.map +1 -0
- package/dist/model/onDemandTrigger.d.ts +1 -1
- package/dist/model/run.d.ts +3 -3
- package/dist/model/runResponse.d.ts +1 -1
- package/dist/model/scheduleTrigger.d.ts +2 -2
- package/dist/model/sortKeys.d.ts +5 -0
- package/dist/model/sortKeys.d.ts.map +1 -0
- package/dist/model/source.d.ts +2 -2
- package/dist/model/sourceCreateResponse.d.ts +1 -1
- package/dist/model/sourceUpdateResponse.d.ts +1 -1
- package/dist/model/sourceUpdateShopify.d.ts +2 -26
- package/dist/model/sourceUpdateShopify.d.ts.map +1 -1
- package/dist/model/sourceWatchResponse.d.ts +20 -0
- package/dist/model/sourceWatchResponse.d.ts.map +1 -0
- package/dist/model/{streamingUtilsInput.d.ts → streamingInput.d.ts} +2 -2
- package/dist/model/streamingInput.d.ts.map +1 -0
- package/dist/model/task.d.ts +6 -2
- package/dist/model/task.d.ts.map +1 -1
- package/dist/model/taskCreate.d.ts +4 -0
- package/dist/model/taskCreate.d.ts.map +1 -1
- package/dist/model/taskCreateResponse.d.ts +1 -1
- package/dist/model/taskInput.d.ts +3 -4
- package/dist/model/taskInput.d.ts.map +1 -1
- package/dist/model/taskUpdateResponse.d.ts +1 -1
- package/dist/model/transformation.d.ts +27 -0
- package/dist/model/transformation.d.ts.map +1 -0
- package/dist/model/transformationCreate.d.ts +18 -0
- package/dist/model/transformationCreate.d.ts.map +1 -0
- package/dist/model/transformationCreateResponse.d.ts +14 -0
- package/dist/model/transformationCreateResponse.d.ts.map +1 -0
- package/dist/model/transformationSearch.d.ts +4 -0
- package/dist/model/transformationSearch.d.ts.map +1 -0
- package/dist/model/transformationTry.d.ts +11 -0
- package/dist/model/transformationTry.d.ts.map +1 -0
- package/dist/model/transformationTryResponse.d.ts +9 -0
- package/dist/model/transformationTryResponse.d.ts.map +1 -0
- package/dist/model/transformationTryResponseError.d.ts +14 -0
- package/dist/model/transformationTryResponseError.d.ts.map +1 -0
- package/dist/model/transformationUpdateResponse.d.ts +14 -0
- package/dist/model/transformationUpdateResponse.d.ts.map +1 -0
- package/dist/model/window.d.ts +2 -2
- package/dist/src/ingestionClient.d.ts +117 -22
- package/dist/src/ingestionClient.d.ts.map +1 -1
- package/model/authentication.ts +2 -2
- package/model/authenticationCreateResponse.ts +1 -1
- package/model/authenticationUpdateResponse.ts +1 -1
- package/model/clientMethodProps.ts +62 -14
- package/model/deleteResponse.ts +1 -1
- package/model/destination.ts +2 -2
- package/model/destinationCreateResponse.ts +1 -1
- package/model/destinationUpdateResponse.ts +1 -1
- package/model/{dockerSourceStreams.ts → dockerStreamsInput.ts} +2 -2
- package/model/event.ts +1 -1
- package/model/index.ts +13 -5
- package/model/listTransformationsResponse.ts +13 -0
- package/model/onDemandTrigger.ts +1 -1
- package/model/run.ts +3 -3
- package/model/runResponse.ts +1 -1
- package/model/scheduleTrigger.ts +2 -2
- package/model/sortKeys.ts +6 -0
- package/model/source.ts +2 -2
- package/model/sourceCreateResponse.ts +1 -1
- package/model/sourceUpdateResponse.ts +1 -1
- package/model/sourceUpdateShopify.ts +2 -32
- package/model/sourceWatchResponse.ts +25 -0
- package/model/{streamingUtilsInput.ts → streamingInput.ts} +1 -1
- package/model/task.ts +7 -2
- package/model/taskCreate.ts +5 -0
- package/model/taskCreateResponse.ts +1 -1
- package/model/taskInput.ts +3 -8
- package/model/taskUpdateResponse.ts +1 -1
- package/model/transformation.ts +33 -0
- package/model/transformationCreate.ts +21 -0
- package/model/transformationCreateResponse.ts +16 -0
- package/model/transformationSearch.ts +5 -0
- package/model/{dockerSourceDiscover.ts → transformationTry.ts} +5 -5
- package/model/transformationTryResponse.ts +12 -0
- package/model/transformationTryResponseError.ts +16 -0
- package/model/transformationUpdateResponse.ts +16 -0
- package/model/window.ts +2 -2
- package/package.json +11 -8
- package/dist/model/dockerSourceDiscover.d.ts +0 -11
- package/dist/model/dockerSourceDiscover.d.ts.map +0 -1
- package/dist/model/dockerSourceStreams.d.ts +0 -4
- package/dist/model/dockerSourceStreams.d.ts.map +0 -1
- package/dist/model/onDemandDateUtilsInput.d.ts +0 -16
- package/dist/model/onDemandDateUtilsInput.d.ts.map +0 -1
- package/dist/model/scheduleDateUtilsInput.d.ts +0 -12
- package/dist/model/scheduleDateUtilsInput.d.ts.map +0 -1
- package/dist/model/streamingUtilsInput.d.ts.map +0 -1
- package/model/onDemandDateUtilsInput.ts +0 -20
- package/model/scheduleDateUtilsInput.ts +0 -15
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2013-Present Algolia
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/dist/builds/browser.d.ts
CHANGED
|
@@ -11,43 +11,51 @@ export declare function ingestionClient(appId: string, apiKey: string, region: R
|
|
|
11
11
|
appId: string;
|
|
12
12
|
clearCache(): Promise<void>;
|
|
13
13
|
readonly _ua: string;
|
|
14
|
-
addAlgoliaAgent(segment: string, version?: string
|
|
15
|
-
createAuthentication(authenticationCreate: import("../model").AuthenticationCreate, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
16
|
-
createDestination(destinationCreate: import("../model").DestinationCreate, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
17
|
-
createSource(sourceCreate: import("../model").SourceCreate, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
18
|
-
createTask(taskCreate: import("../model").TaskCreate, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
14
|
+
addAlgoliaAgent(segment: string, version?: string): void;
|
|
15
|
+
createAuthentication(authenticationCreate: import("../model").AuthenticationCreate, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").AuthenticationCreateResponse>;
|
|
16
|
+
createDestination(destinationCreate: import("../model").DestinationCreate, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DestinationCreateResponse>;
|
|
17
|
+
createSource(sourceCreate: import("../model").SourceCreate, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SourceCreateResponse>;
|
|
18
|
+
createTask(taskCreate: import("../model").TaskCreate, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").TaskCreateResponse>;
|
|
19
|
+
createTransformation(transformationCreate: import("../model").TransformationCreate, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").TransformationCreateResponse>;
|
|
20
|
+
customDelete({ path, parameters }: import("../model").CustomDeleteProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
|
|
21
|
+
customGet({ path, parameters }: import("../model").CustomGetProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
|
|
22
|
+
customPost({ path, parameters, body }: import("../model").CustomPostProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
|
|
23
|
+
customPut({ path, parameters, body }: import("../model").CustomPutProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
|
|
24
|
+
deleteAuthentication({ authenticationID }: import("../model").DeleteAuthenticationProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeleteResponse>;
|
|
25
|
+
deleteDestination({ destinationID }: import("../model").DeleteDestinationProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeleteResponse>;
|
|
26
|
+
deleteSource({ sourceID }: import("../model").DeleteSourceProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeleteResponse>;
|
|
27
|
+
deleteTask({ taskID }: import("../model").DeleteTaskProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeleteResponse>;
|
|
28
|
+
deleteTransformation({ transformationID }: import("../model").DeleteTransformationProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeleteResponse>;
|
|
29
|
+
disableTask({ taskID }: import("../model").DisableTaskProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").TaskUpdateResponse>;
|
|
30
|
+
enableTask({ taskID }: import("../model").EnableTaskProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").TaskUpdateResponse>;
|
|
31
|
+
getAuthentication({ authenticationID }: import("../model").GetAuthenticationProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").Authentication>;
|
|
30
32
|
getAuthentications({ itemsPerPage, page, type, platform, sort, order, }?: import("../model").GetAuthenticationsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListAuthenticationsResponse>;
|
|
31
|
-
getDestination({ destinationID }: import("../model").GetDestinationProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
33
|
+
getDestination({ destinationID }: import("../model").GetDestinationProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").Destination>;
|
|
32
34
|
getDestinations({ itemsPerPage, page, type, authenticationID, sort, order, }?: import("../model").GetDestinationsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListDestinationsResponse>;
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
getRun({ runID }: import("../model").GetRunProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").Run>;
|
|
35
|
+
getEvent({ runID, eventID }: import("../model").GetEventProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").Event>;
|
|
36
|
+
getEvents({ runID, itemsPerPage, page, status, type, sort, order, startDate, endDate, }: import("../model").GetEventsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").ListEventsResponse>;
|
|
37
|
+
getRun({ runID }: import("../model").GetRunProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").Run>;
|
|
37
38
|
getRuns({ itemsPerPage, page, status, taskID, sort, order, startDate, endDate, }?: import("../model").GetRunsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").RunListResponse>;
|
|
38
|
-
getSource({ sourceID }: import("../model").GetSourceProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
39
|
+
getSource({ sourceID }: import("../model").GetSourceProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").Source>;
|
|
39
40
|
getSources({ itemsPerPage, page, type, authenticationID, sort, order, }?: import("../model").GetSourcesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListSourcesResponse>;
|
|
40
|
-
getTask({ taskID }: import("../model").GetTaskProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
41
|
+
getTask({ taskID }: import("../model").GetTaskProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").Task>;
|
|
41
42
|
getTasks({ itemsPerPage, page, action, enabled, sourceID, destinationID, triggerType, sort, order, }?: import("../model").GetTasksProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListTasksResponse>;
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
43
|
+
getTransformation({ transformationID }: import("../model").GetTransformationProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").Transformation>;
|
|
44
|
+
getTransformations({ sort, order }?: import("../model").GetTransformationsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListTransformationsResponse>;
|
|
45
|
+
runTask({ taskID }: import("../model").RunTaskProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").RunResponse>;
|
|
46
|
+
searchAuthentications(authenticationSearch: import("../model").AuthenticationSearch, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").Authentication[]>;
|
|
47
|
+
searchDestinations(destinationSearch: import("../model").DestinationSearch, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").Destination[]>;
|
|
48
|
+
searchSources(sourceSearch: import("../model").SourceSearch, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").Source[]>;
|
|
49
|
+
searchTasks(taskSearch: import("../model").TaskSearch, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").Task[]>;
|
|
50
|
+
searchTransformations(transformationSearch: import("../model").TransformationSearch, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").Transformation[]>;
|
|
51
|
+
triggerDockerSourceDiscover({ sourceID }: import("../model").TriggerDockerSourceDiscoverProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SourceWatchResponse>;
|
|
52
|
+
tryTransformations(transformationTry: import("../model").TransformationTry, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").TransformationTryResponse>;
|
|
53
|
+
updateAuthentication({ authenticationID, authenticationUpdate }: import("../model").UpdateAuthenticationProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").AuthenticationUpdateResponse>;
|
|
54
|
+
updateDestination({ destinationID, destinationUpdate }: import("../model").UpdateDestinationProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DestinationUpdateResponse>;
|
|
55
|
+
updateSource({ sourceID, sourceUpdate }: import("../model").UpdateSourceProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SourceUpdateResponse>;
|
|
56
|
+
updateTask({ taskID, taskUpdate }: import("../model").UpdateTaskProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").TaskUpdateResponse>;
|
|
57
|
+
updateTransformation({ transformationID, transformationCreate }: import("../model").UpdateTransformationProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").TransformationUpdateResponse>;
|
|
58
|
+
validateSource(sourceCreate: import("../model").SourceCreate, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SourceWatchResponse>;
|
|
59
|
+
validateSourceBeforeUpdate({ sourceID, sourceUpdate }: import("../model").ValidateSourceBeforeUpdateProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SourceWatchResponse>;
|
|
52
60
|
};
|
|
53
61
|
//# sourceMappingURL=browser.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAW5D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAOrD,OAAO,EACL,gBAAgB,EAChB,MAAM,EACN,iBAAiB,EACjB,iBAAiB,EACjB,qBAAqB,GACtB,MAAM,wBAAwB,CAAC;AAChC,cAAc,UAAU,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,OAAO,eAAe,CAAC,CAAC;AAGjE,wBAAgB,eAAe,CAC7B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa
|
|
1
|
+
{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAW5D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAOrD,OAAO,EACL,gBAAgB,EAChB,MAAM,EACN,iBAAiB,EACjB,iBAAiB,EACjB,qBAAqB,GACtB,MAAM,wBAAwB,CAAC;AAChC,cAAc,UAAU,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,OAAO,eAAe,CAAC,CAAC;AAGjE,wBAAgB,eAAe,CAC7B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAyCxB"}
|
package/dist/builds/node.d.ts
CHANGED
|
@@ -11,43 +11,51 @@ export declare function ingestionClient(appId: string, apiKey: string, region: R
|
|
|
11
11
|
appId: string;
|
|
12
12
|
clearCache(): Promise<void>;
|
|
13
13
|
_ua: string;
|
|
14
|
-
addAlgoliaAgent(segment: string, version?: string
|
|
15
|
-
createAuthentication(authenticationCreate: import("../model").AuthenticationCreate, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
16
|
-
createDestination(destinationCreate: import("../model").DestinationCreate, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
17
|
-
createSource(sourceCreate: import("../model").SourceCreate, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
18
|
-
createTask(taskCreate: import("../model").TaskCreate, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
14
|
+
addAlgoliaAgent(segment: string, version?: string): void;
|
|
15
|
+
createAuthentication(authenticationCreate: import("../model").AuthenticationCreate, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").AuthenticationCreateResponse>;
|
|
16
|
+
createDestination(destinationCreate: import("../model").DestinationCreate, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DestinationCreateResponse>;
|
|
17
|
+
createSource(sourceCreate: import("../model").SourceCreate, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SourceCreateResponse>;
|
|
18
|
+
createTask(taskCreate: import("../model").TaskCreate, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").TaskCreateResponse>;
|
|
19
|
+
createTransformation(transformationCreate: import("../model").TransformationCreate, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").TransformationCreateResponse>;
|
|
20
|
+
customDelete({ path, parameters }: import("../model").CustomDeleteProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
|
|
21
|
+
customGet({ path, parameters }: import("../model").CustomGetProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
|
|
22
|
+
customPost({ path, parameters, body }: import("../model").CustomPostProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
|
|
23
|
+
customPut({ path, parameters, body }: import("../model").CustomPutProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
|
|
24
|
+
deleteAuthentication({ authenticationID }: import("../model").DeleteAuthenticationProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeleteResponse>;
|
|
25
|
+
deleteDestination({ destinationID }: import("../model").DeleteDestinationProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeleteResponse>;
|
|
26
|
+
deleteSource({ sourceID }: import("../model").DeleteSourceProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeleteResponse>;
|
|
27
|
+
deleteTask({ taskID }: import("../model").DeleteTaskProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeleteResponse>;
|
|
28
|
+
deleteTransformation({ transformationID }: import("../model").DeleteTransformationProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DeleteResponse>;
|
|
29
|
+
disableTask({ taskID }: import("../model").DisableTaskProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").TaskUpdateResponse>;
|
|
30
|
+
enableTask({ taskID }: import("../model").EnableTaskProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").TaskUpdateResponse>;
|
|
31
|
+
getAuthentication({ authenticationID }: import("../model").GetAuthenticationProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").Authentication>;
|
|
30
32
|
getAuthentications({ itemsPerPage, page, type, platform, sort, order, }?: import("../model").GetAuthenticationsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListAuthenticationsResponse>;
|
|
31
|
-
getDestination({ destinationID }: import("../model").GetDestinationProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
33
|
+
getDestination({ destinationID }: import("../model").GetDestinationProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").Destination>;
|
|
32
34
|
getDestinations({ itemsPerPage, page, type, authenticationID, sort, order, }?: import("../model").GetDestinationsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListDestinationsResponse>;
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
getRun({ runID }: import("../model").GetRunProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").Run>;
|
|
35
|
+
getEvent({ runID, eventID }: import("../model").GetEventProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").Event>;
|
|
36
|
+
getEvents({ runID, itemsPerPage, page, status, type, sort, order, startDate, endDate, }: import("../model").GetEventsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").ListEventsResponse>;
|
|
37
|
+
getRun({ runID }: import("../model").GetRunProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").Run>;
|
|
37
38
|
getRuns({ itemsPerPage, page, status, taskID, sort, order, startDate, endDate, }?: import("../model").GetRunsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").RunListResponse>;
|
|
38
|
-
getSource({ sourceID }: import("../model").GetSourceProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
39
|
+
getSource({ sourceID }: import("../model").GetSourceProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").Source>;
|
|
39
40
|
getSources({ itemsPerPage, page, type, authenticationID, sort, order, }?: import("../model").GetSourcesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListSourcesResponse>;
|
|
40
|
-
getTask({ taskID }: import("../model").GetTaskProps, requestOptions?: import("@algolia/client-common").RequestOptions
|
|
41
|
+
getTask({ taskID }: import("../model").GetTaskProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").Task>;
|
|
41
42
|
getTasks({ itemsPerPage, page, action, enabled, sourceID, destinationID, triggerType, sort, order, }?: import("../model").GetTasksProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListTasksResponse>;
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
43
|
+
getTransformation({ transformationID }: import("../model").GetTransformationProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").Transformation>;
|
|
44
|
+
getTransformations({ sort, order }?: import("../model").GetTransformationsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListTransformationsResponse>;
|
|
45
|
+
runTask({ taskID }: import("../model").RunTaskProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").RunResponse>;
|
|
46
|
+
searchAuthentications(authenticationSearch: import("../model").AuthenticationSearch, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").Authentication[]>;
|
|
47
|
+
searchDestinations(destinationSearch: import("../model").DestinationSearch, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").Destination[]>;
|
|
48
|
+
searchSources(sourceSearch: import("../model").SourceSearch, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").Source[]>;
|
|
49
|
+
searchTasks(taskSearch: import("../model").TaskSearch, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").Task[]>;
|
|
50
|
+
searchTransformations(transformationSearch: import("../model").TransformationSearch, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").Transformation[]>;
|
|
51
|
+
triggerDockerSourceDiscover({ sourceID }: import("../model").TriggerDockerSourceDiscoverProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SourceWatchResponse>;
|
|
52
|
+
tryTransformations(transformationTry: import("../model").TransformationTry, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").TransformationTryResponse>;
|
|
53
|
+
updateAuthentication({ authenticationID, authenticationUpdate }: import("../model").UpdateAuthenticationProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").AuthenticationUpdateResponse>;
|
|
54
|
+
updateDestination({ destinationID, destinationUpdate }: import("../model").UpdateDestinationProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").DestinationUpdateResponse>;
|
|
55
|
+
updateSource({ sourceID, sourceUpdate }: import("../model").UpdateSourceProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SourceUpdateResponse>;
|
|
56
|
+
updateTask({ taskID, taskUpdate }: import("../model").UpdateTaskProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").TaskUpdateResponse>;
|
|
57
|
+
updateTransformation({ transformationID, transformationCreate }: import("../model").UpdateTransformationProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").TransformationUpdateResponse>;
|
|
58
|
+
validateSource(sourceCreate: import("../model").SourceCreate, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SourceWatchResponse>;
|
|
59
|
+
validateSourceBeforeUpdate({ sourceID, sourceUpdate }: import("../model").ValidateSourceBeforeUpdateProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").SourceWatchResponse>;
|
|
52
60
|
};
|
|
53
61
|
//# sourceMappingURL=node.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../builds/node.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAU5D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAGrD,OAAO,EACL,gBAAgB,EAChB,MAAM,EACN,iBAAiB,EACjB,iBAAiB,EACjB,qBAAqB,GACtB,MAAM,wBAAwB,CAAC;AAChC,cAAc,UAAU,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,OAAO,eAAe,CAAC,CAAC;AAGjE,wBAAgB,eAAe,CAC7B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa
|
|
1
|
+
{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../builds/node.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAU5D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAGrD,OAAO,EACL,gBAAgB,EAChB,MAAM,EACN,iBAAiB,EACjB,iBAAiB,EACjB,qBAAqB,GACtB,MAAM,wBAAwB,CAAC;AAChC,cAAc,UAAU,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,OAAO,eAAe,CAAC,CAAC;AAGjE,wBAAgB,eAAe,CAC7B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAqCxB"}
|
package/dist/ingestion.cjs
CHANGED
|
@@ -4,7 +4,7 @@ var clientCommon = require('@algolia/client-common');
|
|
|
4
4
|
var requesterNodeHttp = require('@algolia/requester-node-http');
|
|
5
5
|
|
|
6
6
|
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
7
|
-
const apiClientVersion = '1.0.0-beta.
|
|
7
|
+
const apiClientVersion = '1.0.0-beta.11';
|
|
8
8
|
const REGIONS = ['eu', 'us'];
|
|
9
9
|
function getDefaultHosts(region) {
|
|
10
10
|
const url = 'data.{region}.algolia.com'.replace('{region}', region);
|
|
@@ -230,6 +230,34 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
230
230
|
};
|
|
231
231
|
return transporter.request(request, requestOptions);
|
|
232
232
|
},
|
|
233
|
+
/**
|
|
234
|
+
* Creates a new transformation.
|
|
235
|
+
*
|
|
236
|
+
* @param transformationCreate - Request body for creating a transformation.
|
|
237
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
238
|
+
*/
|
|
239
|
+
createTransformation(transformationCreate, requestOptions) {
|
|
240
|
+
if (!transformationCreate) {
|
|
241
|
+
throw new Error('Parameter `transformationCreate` is required when calling `createTransformation`.');
|
|
242
|
+
}
|
|
243
|
+
if (!transformationCreate.code) {
|
|
244
|
+
throw new Error('Parameter `transformationCreate.code` is required when calling `createTransformation`.');
|
|
245
|
+
}
|
|
246
|
+
if (!transformationCreate.name) {
|
|
247
|
+
throw new Error('Parameter `transformationCreate.name` is required when calling `createTransformation`.');
|
|
248
|
+
}
|
|
249
|
+
const requestPath = '/1/transformations';
|
|
250
|
+
const headers = {};
|
|
251
|
+
const queryParameters = {};
|
|
252
|
+
const request = {
|
|
253
|
+
method: 'POST',
|
|
254
|
+
path: requestPath,
|
|
255
|
+
queryParameters,
|
|
256
|
+
headers,
|
|
257
|
+
data: transformationCreate,
|
|
258
|
+
};
|
|
259
|
+
return transporter.request(request, requestOptions);
|
|
260
|
+
},
|
|
233
261
|
/**
|
|
234
262
|
* This method allow you to send requests to the Algolia REST API.
|
|
235
263
|
*
|
|
@@ -429,6 +457,28 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
429
457
|
};
|
|
430
458
|
return transporter.request(request, requestOptions);
|
|
431
459
|
},
|
|
460
|
+
/**
|
|
461
|
+
* Deletes a transformation by its ID.
|
|
462
|
+
*
|
|
463
|
+
* @param deleteTransformation - The deleteTransformation object.
|
|
464
|
+
* @param deleteTransformation.transformationID - Unique identifier of a transformation.
|
|
465
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
466
|
+
*/
|
|
467
|
+
deleteTransformation({ transformationID }, requestOptions) {
|
|
468
|
+
if (!transformationID) {
|
|
469
|
+
throw new Error('Parameter `transformationID` is required when calling `deleteTransformation`.');
|
|
470
|
+
}
|
|
471
|
+
const requestPath = '/1/transformations/{transformationID}'.replace('{transformationID}', encodeURIComponent(transformationID));
|
|
472
|
+
const headers = {};
|
|
473
|
+
const queryParameters = {};
|
|
474
|
+
const request = {
|
|
475
|
+
method: 'DELETE',
|
|
476
|
+
path: requestPath,
|
|
477
|
+
queryParameters,
|
|
478
|
+
headers,
|
|
479
|
+
};
|
|
480
|
+
return transporter.request(request, requestOptions);
|
|
481
|
+
},
|
|
432
482
|
/**
|
|
433
483
|
* Disables a task.
|
|
434
484
|
*
|
|
@@ -631,33 +681,6 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
631
681
|
};
|
|
632
682
|
return transporter.request(request, requestOptions);
|
|
633
683
|
},
|
|
634
|
-
/**
|
|
635
|
-
* Retrieves a stream listing for a source. Listing streams only works with sources with `type: docker` and `imageType: singer`.
|
|
636
|
-
*
|
|
637
|
-
* Required API Key ACLs:
|
|
638
|
-
* - addObject
|
|
639
|
-
* - deleteIndex
|
|
640
|
-
* - editSettings.
|
|
641
|
-
*
|
|
642
|
-
* @param getDockerSourceStreams - The getDockerSourceStreams object.
|
|
643
|
-
* @param getDockerSourceStreams.sourceID - Unique identifier of a source.
|
|
644
|
-
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
645
|
-
*/
|
|
646
|
-
getDockerSourceStreams({ sourceID }, requestOptions) {
|
|
647
|
-
if (!sourceID) {
|
|
648
|
-
throw new Error('Parameter `sourceID` is required when calling `getDockerSourceStreams`.');
|
|
649
|
-
}
|
|
650
|
-
const requestPath = '/1/sources/{sourceID}/discover'.replace('{sourceID}', encodeURIComponent(sourceID));
|
|
651
|
-
const headers = {};
|
|
652
|
-
const queryParameters = {};
|
|
653
|
-
const request = {
|
|
654
|
-
method: 'GET',
|
|
655
|
-
path: requestPath,
|
|
656
|
-
queryParameters,
|
|
657
|
-
headers,
|
|
658
|
-
};
|
|
659
|
-
return transporter.request(request, requestOptions);
|
|
660
|
-
},
|
|
661
684
|
/**
|
|
662
685
|
* Retrieves a single task run event by its ID.
|
|
663
686
|
*
|
|
@@ -707,8 +730,8 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
707
730
|
* @param getEvents.type - Event type for filtering the list of task runs.
|
|
708
731
|
* @param getEvents.sort - Property by which to sort the list of task run events.
|
|
709
732
|
* @param getEvents.order - Sort order of the response, ascending or descending.
|
|
710
|
-
* @param getEvents.startDate - Date and time in
|
|
711
|
-
* @param getEvents.endDate - Date and time in
|
|
733
|
+
* @param getEvents.startDate - Date and time in RFC 3339 format for the earliest events to retrieve. By default, the current time minus three hours is used.
|
|
734
|
+
* @param getEvents.endDate - Date and time in RFC 3339 format for the latest events to retrieve. By default, the current time is used.
|
|
712
735
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
713
736
|
*/
|
|
714
737
|
getEvents({ runID, itemsPerPage, page, status, type, sort, order, startDate, endDate, }, requestOptions) {
|
|
@@ -792,8 +815,8 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
792
815
|
* @param getRuns.taskID - Task ID for filtering the list of task runs.
|
|
793
816
|
* @param getRuns.sort - Property by which to sort the list of task runs.
|
|
794
817
|
* @param getRuns.order - Sort order of the response, ascending or descending.
|
|
795
|
-
* @param getRuns.startDate - Date in
|
|
796
|
-
* @param getRuns.endDate - Date in
|
|
818
|
+
* @param getRuns.startDate - Date in RFC 3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.
|
|
819
|
+
* @param getRuns.endDate - Date in RFC 3339 format for the latest run to retrieve. By default, the current day is used.
|
|
797
820
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
798
821
|
*/
|
|
799
822
|
getRuns({ itemsPerPage, page, status, taskID, sort, order, startDate, endDate, } = {}, requestOptions = undefined) {
|
|
@@ -992,6 +1015,64 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
992
1015
|
};
|
|
993
1016
|
return transporter.request(request, requestOptions);
|
|
994
1017
|
},
|
|
1018
|
+
/**
|
|
1019
|
+
* Retrieves a transformation by its ID.
|
|
1020
|
+
*
|
|
1021
|
+
* Required API Key ACLs:
|
|
1022
|
+
* - addObject
|
|
1023
|
+
* - deleteIndex
|
|
1024
|
+
* - editSettings.
|
|
1025
|
+
*
|
|
1026
|
+
* @param getTransformation - The getTransformation object.
|
|
1027
|
+
* @param getTransformation.transformationID - Unique identifier of a transformation.
|
|
1028
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1029
|
+
*/
|
|
1030
|
+
getTransformation({ transformationID }, requestOptions) {
|
|
1031
|
+
if (!transformationID) {
|
|
1032
|
+
throw new Error('Parameter `transformationID` is required when calling `getTransformation`.');
|
|
1033
|
+
}
|
|
1034
|
+
const requestPath = '/1/transformations/{transformationID}'.replace('{transformationID}', encodeURIComponent(transformationID));
|
|
1035
|
+
const headers = {};
|
|
1036
|
+
const queryParameters = {};
|
|
1037
|
+
const request = {
|
|
1038
|
+
method: 'GET',
|
|
1039
|
+
path: requestPath,
|
|
1040
|
+
queryParameters,
|
|
1041
|
+
headers,
|
|
1042
|
+
};
|
|
1043
|
+
return transporter.request(request, requestOptions);
|
|
1044
|
+
},
|
|
1045
|
+
/**
|
|
1046
|
+
* Retrieves a list of transformations.
|
|
1047
|
+
*
|
|
1048
|
+
* Required API Key ACLs:
|
|
1049
|
+
* - addObject
|
|
1050
|
+
* - deleteIndex
|
|
1051
|
+
* - editSettings.
|
|
1052
|
+
*
|
|
1053
|
+
* @param getTransformations - The getTransformations object.
|
|
1054
|
+
* @param getTransformations.sort - Property by which to sort the list.
|
|
1055
|
+
* @param getTransformations.order - Sort order of the response, ascending or descending.
|
|
1056
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1057
|
+
*/
|
|
1058
|
+
getTransformations({ sort, order } = {}, requestOptions = undefined) {
|
|
1059
|
+
const requestPath = '/1/transformations';
|
|
1060
|
+
const headers = {};
|
|
1061
|
+
const queryParameters = {};
|
|
1062
|
+
if (sort !== undefined) {
|
|
1063
|
+
queryParameters.sort = sort.toString();
|
|
1064
|
+
}
|
|
1065
|
+
if (order !== undefined) {
|
|
1066
|
+
queryParameters.order = order.toString();
|
|
1067
|
+
}
|
|
1068
|
+
const request = {
|
|
1069
|
+
method: 'GET',
|
|
1070
|
+
path: requestPath,
|
|
1071
|
+
queryParameters,
|
|
1072
|
+
headers,
|
|
1073
|
+
};
|
|
1074
|
+
return transporter.request(request, requestOptions);
|
|
1075
|
+
},
|
|
995
1076
|
/**
|
|
996
1077
|
* Runs a task. You can check the status of task runs with the observability endpoints.
|
|
997
1078
|
*
|
|
@@ -1139,6 +1220,36 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1139
1220
|
};
|
|
1140
1221
|
return transporter.request(request, requestOptions);
|
|
1141
1222
|
},
|
|
1223
|
+
/**
|
|
1224
|
+
* Searches for transformations.
|
|
1225
|
+
*
|
|
1226
|
+
* Required API Key ACLs:
|
|
1227
|
+
* - addObject
|
|
1228
|
+
* - deleteIndex
|
|
1229
|
+
* - editSettings.
|
|
1230
|
+
*
|
|
1231
|
+
* @param transformationSearch - The transformationSearch object.
|
|
1232
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1233
|
+
*/
|
|
1234
|
+
searchTransformations(transformationSearch, requestOptions) {
|
|
1235
|
+
if (!transformationSearch) {
|
|
1236
|
+
throw new Error('Parameter `transformationSearch` is required when calling `searchTransformations`.');
|
|
1237
|
+
}
|
|
1238
|
+
if (!transformationSearch.transformationsIDs) {
|
|
1239
|
+
throw new Error('Parameter `transformationSearch.transformationsIDs` is required when calling `searchTransformations`.');
|
|
1240
|
+
}
|
|
1241
|
+
const requestPath = '/1/transformations/search';
|
|
1242
|
+
const headers = {};
|
|
1243
|
+
const queryParameters = {};
|
|
1244
|
+
const request = {
|
|
1245
|
+
method: 'POST',
|
|
1246
|
+
path: requestPath,
|
|
1247
|
+
queryParameters,
|
|
1248
|
+
headers,
|
|
1249
|
+
data: transformationSearch,
|
|
1250
|
+
};
|
|
1251
|
+
return transporter.request(request, requestOptions);
|
|
1252
|
+
},
|
|
1142
1253
|
/**
|
|
1143
1254
|
* Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: singer`.
|
|
1144
1255
|
*
|
|
@@ -1166,6 +1277,39 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1166
1277
|
};
|
|
1167
1278
|
return transporter.request(request, requestOptions);
|
|
1168
1279
|
},
|
|
1280
|
+
/**
|
|
1281
|
+
* Try a transformation.
|
|
1282
|
+
*
|
|
1283
|
+
* Required API Key ACLs:
|
|
1284
|
+
* - addObject
|
|
1285
|
+
* - deleteIndex
|
|
1286
|
+
* - editSettings.
|
|
1287
|
+
*
|
|
1288
|
+
* @param transformationTry - The transformationTry object.
|
|
1289
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1290
|
+
*/
|
|
1291
|
+
tryTransformations(transformationTry, requestOptions) {
|
|
1292
|
+
if (!transformationTry) {
|
|
1293
|
+
throw new Error('Parameter `transformationTry` is required when calling `tryTransformations`.');
|
|
1294
|
+
}
|
|
1295
|
+
if (!transformationTry.code) {
|
|
1296
|
+
throw new Error('Parameter `transformationTry.code` is required when calling `tryTransformations`.');
|
|
1297
|
+
}
|
|
1298
|
+
if (!transformationTry.sampleRecord) {
|
|
1299
|
+
throw new Error('Parameter `transformationTry.sampleRecord` is required when calling `tryTransformations`.');
|
|
1300
|
+
}
|
|
1301
|
+
const requestPath = '/1/transformations/try';
|
|
1302
|
+
const headers = {};
|
|
1303
|
+
const queryParameters = {};
|
|
1304
|
+
const request = {
|
|
1305
|
+
method: 'POST',
|
|
1306
|
+
path: requestPath,
|
|
1307
|
+
queryParameters,
|
|
1308
|
+
headers,
|
|
1309
|
+
data: transformationTry,
|
|
1310
|
+
};
|
|
1311
|
+
return transporter.request(request, requestOptions);
|
|
1312
|
+
},
|
|
1169
1313
|
/**
|
|
1170
1314
|
* Updates an authentication resource.
|
|
1171
1315
|
*
|
|
@@ -1289,6 +1433,95 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1289
1433
|
};
|
|
1290
1434
|
return transporter.request(request, requestOptions);
|
|
1291
1435
|
},
|
|
1436
|
+
/**
|
|
1437
|
+
* Updates a transformation by its ID.
|
|
1438
|
+
*
|
|
1439
|
+
* @param updateTransformation - The updateTransformation object.
|
|
1440
|
+
* @param updateTransformation.transformationID - Unique identifier of a transformation.
|
|
1441
|
+
* @param updateTransformation.transformationCreate - The transformationCreate object.
|
|
1442
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1443
|
+
*/
|
|
1444
|
+
updateTransformation({ transformationID, transformationCreate }, requestOptions) {
|
|
1445
|
+
if (!transformationID) {
|
|
1446
|
+
throw new Error('Parameter `transformationID` is required when calling `updateTransformation`.');
|
|
1447
|
+
}
|
|
1448
|
+
if (!transformationCreate) {
|
|
1449
|
+
throw new Error('Parameter `transformationCreate` is required when calling `updateTransformation`.');
|
|
1450
|
+
}
|
|
1451
|
+
if (!transformationCreate.code) {
|
|
1452
|
+
throw new Error('Parameter `transformationCreate.code` is required when calling `updateTransformation`.');
|
|
1453
|
+
}
|
|
1454
|
+
if (!transformationCreate.name) {
|
|
1455
|
+
throw new Error('Parameter `transformationCreate.name` is required when calling `updateTransformation`.');
|
|
1456
|
+
}
|
|
1457
|
+
const requestPath = '/1/transformations/{transformationID}'.replace('{transformationID}', encodeURIComponent(transformationID));
|
|
1458
|
+
const headers = {};
|
|
1459
|
+
const queryParameters = {};
|
|
1460
|
+
const request = {
|
|
1461
|
+
method: 'PUT',
|
|
1462
|
+
path: requestPath,
|
|
1463
|
+
queryParameters,
|
|
1464
|
+
headers,
|
|
1465
|
+
data: transformationCreate,
|
|
1466
|
+
};
|
|
1467
|
+
return transporter.request(request, requestOptions);
|
|
1468
|
+
},
|
|
1469
|
+
/**
|
|
1470
|
+
* Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
|
|
1471
|
+
*
|
|
1472
|
+
* Required API Key ACLs:
|
|
1473
|
+
* - addObject
|
|
1474
|
+
* - deleteIndex
|
|
1475
|
+
* - editSettings.
|
|
1476
|
+
*
|
|
1477
|
+
* @param sourceCreate -.
|
|
1478
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1479
|
+
*/
|
|
1480
|
+
validateSource(sourceCreate, requestOptions = undefined) {
|
|
1481
|
+
const requestPath = '/1/sources/validate';
|
|
1482
|
+
const headers = {};
|
|
1483
|
+
const queryParameters = {};
|
|
1484
|
+
const request = {
|
|
1485
|
+
method: 'POST',
|
|
1486
|
+
path: requestPath,
|
|
1487
|
+
queryParameters,
|
|
1488
|
+
headers,
|
|
1489
|
+
data: sourceCreate ? sourceCreate : {},
|
|
1490
|
+
};
|
|
1491
|
+
return transporter.request(request, requestOptions);
|
|
1492
|
+
},
|
|
1493
|
+
/**
|
|
1494
|
+
* Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.
|
|
1495
|
+
*
|
|
1496
|
+
* Required API Key ACLs:
|
|
1497
|
+
* - addObject
|
|
1498
|
+
* - deleteIndex
|
|
1499
|
+
* - editSettings.
|
|
1500
|
+
*
|
|
1501
|
+
* @param validateSourceBeforeUpdate - The validateSourceBeforeUpdate object.
|
|
1502
|
+
* @param validateSourceBeforeUpdate.sourceID - Unique identifier of a source.
|
|
1503
|
+
* @param validateSourceBeforeUpdate.sourceUpdate - The sourceUpdate object.
|
|
1504
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1505
|
+
*/
|
|
1506
|
+
validateSourceBeforeUpdate({ sourceID, sourceUpdate }, requestOptions) {
|
|
1507
|
+
if (!sourceID) {
|
|
1508
|
+
throw new Error('Parameter `sourceID` is required when calling `validateSourceBeforeUpdate`.');
|
|
1509
|
+
}
|
|
1510
|
+
if (!sourceUpdate) {
|
|
1511
|
+
throw new Error('Parameter `sourceUpdate` is required when calling `validateSourceBeforeUpdate`.');
|
|
1512
|
+
}
|
|
1513
|
+
const requestPath = '/1/sources/{sourceID}/validate'.replace('{sourceID}', encodeURIComponent(sourceID));
|
|
1514
|
+
const headers = {};
|
|
1515
|
+
const queryParameters = {};
|
|
1516
|
+
const request = {
|
|
1517
|
+
method: 'POST',
|
|
1518
|
+
path: requestPath,
|
|
1519
|
+
queryParameters,
|
|
1520
|
+
headers,
|
|
1521
|
+
data: sourceUpdate,
|
|
1522
|
+
};
|
|
1523
|
+
return transporter.request(request, requestOptions);
|
|
1524
|
+
},
|
|
1292
1525
|
};
|
|
1293
1526
|
}
|
|
1294
1527
|
|