@algolia/ingestion 1.55.2 → 1.56.0

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/dist/browser.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import * as _algolia_client_common from '@algolia/client-common';
2
- import { ChunkedHelperOptions, CreateClientOptions, RequestOptions, ClientOptions } from '@algolia/client-common';
2
+ import { ChunkedHelperOptions, CreateClientOptions, RequestOptions, AlgoliaHttpResponse, ClientOptions } from '@algolia/client-common';
3
3
 
4
4
  /**
5
5
  * Credentials for authenticating with an API key.
@@ -2540,7 +2540,7 @@ type ChunkedPushOptions = ChunkedHelperOptions & {
2540
2540
  objects: Array<Record<string, unknown>>;
2541
2541
  };
2542
2542
 
2543
- declare const apiClientVersion = "1.55.2";
2543
+ declare const apiClientVersion = "1.56.0";
2544
2544
  declare const REGIONS: readonly ["eu", "us"];
2545
2545
  type Region = (typeof REGIONS)[number];
2546
2546
  type RegionOptions = {
@@ -2568,7 +2568,7 @@ declare function isScheduleTrigger(trigger: TaskCreateTrigger | Trigger): trigge
2568
2568
  */
2569
2569
  declare function isSubscriptionTrigger(trigger: TaskCreateTrigger | Trigger): trigger is SubscriptionTrigger;
2570
2570
  declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & RegionOptions): {
2571
- transporter: _algolia_client_common.Transporter;
2571
+ transporter: _algolia_client_common.TransporterWithHttpInfo;
2572
2572
  /**
2573
2573
  * The `appId` currently in use.
2574
2574
  */
@@ -2627,6 +2627,20 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2627
2627
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2628
2628
  */
2629
2629
  createAuthentication(authenticationCreate: AuthenticationCreate, requestOptions?: RequestOptions): Promise<AuthenticationCreateResponse>;
2630
+ /**
2631
+ * Creates a new authentication resource.
2632
+ *
2633
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
2634
+ *
2635
+ * Required API Key ACLs:
2636
+ * - addObject
2637
+ * - deleteIndex
2638
+ * - editSettings
2639
+ * @param authenticationCreate -
2640
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2641
+ * @see createAuthentication for the plain version.
2642
+ */
2643
+ createAuthenticationWithHTTPInfo(authenticationCreate: AuthenticationCreate, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<AuthenticationCreateResponse>>;
2630
2644
  /**
2631
2645
  * Creates a new destination.
2632
2646
  *
@@ -2638,6 +2652,20 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2638
2652
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2639
2653
  */
2640
2654
  createDestination(destinationCreate: DestinationCreate, requestOptions?: RequestOptions): Promise<DestinationCreateResponse>;
2655
+ /**
2656
+ * Creates a new destination.
2657
+ *
2658
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
2659
+ *
2660
+ * Required API Key ACLs:
2661
+ * - addObject
2662
+ * - deleteIndex
2663
+ * - editSettings
2664
+ * @param destinationCreate -
2665
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2666
+ * @see createDestination for the plain version.
2667
+ */
2668
+ createDestinationWithHTTPInfo(destinationCreate: DestinationCreate, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<DestinationCreateResponse>>;
2641
2669
  /**
2642
2670
  * Creates a new source.
2643
2671
  *
@@ -2649,6 +2677,20 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2649
2677
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2650
2678
  */
2651
2679
  createSource(sourceCreate: SourceCreate, requestOptions?: RequestOptions): Promise<SourceCreateResponse>;
2680
+ /**
2681
+ * Creates a new source.
2682
+ *
2683
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
2684
+ *
2685
+ * Required API Key ACLs:
2686
+ * - addObject
2687
+ * - deleteIndex
2688
+ * - editSettings
2689
+ * @param sourceCreate -
2690
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2691
+ * @see createSource for the plain version.
2692
+ */
2693
+ createSourceWithHTTPInfo(sourceCreate: SourceCreate, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<SourceCreateResponse>>;
2652
2694
  /**
2653
2695
  * Creates a new task.
2654
2696
  *
@@ -2660,6 +2702,20 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2660
2702
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2661
2703
  */
2662
2704
  createTask(taskCreate: TaskCreate, requestOptions?: RequestOptions): Promise<TaskCreateResponse>;
2705
+ /**
2706
+ * Creates a new task.
2707
+ *
2708
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
2709
+ *
2710
+ * Required API Key ACLs:
2711
+ * - addObject
2712
+ * - deleteIndex
2713
+ * - editSettings
2714
+ * @param taskCreate - Request body for creating a task.
2715
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2716
+ * @see createTask for the plain version.
2717
+ */
2718
+ createTaskWithHTTPInfo(taskCreate: TaskCreate, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<TaskCreateResponse>>;
2663
2719
  /**
2664
2720
  * Creates a new task using the v1 endpoint. Use `createTask` instead.
2665
2721
  *
@@ -2673,6 +2729,22 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2673
2729
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2674
2730
  */
2675
2731
  createTaskV1(taskCreate: TaskCreateV1, requestOptions?: RequestOptions): Promise<TaskCreateResponse>;
2732
+ /**
2733
+ * Creates a new task using the v1 endpoint. Use `createTask` instead.
2734
+ *
2735
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
2736
+ *
2737
+ * Required API Key ACLs:
2738
+ * - addObject
2739
+ * - deleteIndex
2740
+ * - editSettings
2741
+ *
2742
+ * @deprecated
2743
+ * @param taskCreate - Request body for creating a task.
2744
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2745
+ * @see createTaskV1 for the plain version.
2746
+ */
2747
+ createTaskV1WithHTTPInfo(taskCreate: TaskCreateV1, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<TaskCreateResponse>>;
2676
2748
  /**
2677
2749
  * Creates a new transformation.
2678
2750
  *
@@ -2684,6 +2756,20 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2684
2756
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2685
2757
  */
2686
2758
  createTransformation(transformationCreate: TransformationCreate, requestOptions?: RequestOptions): Promise<TransformationCreateResponse>;
2759
+ /**
2760
+ * Creates a new transformation.
2761
+ *
2762
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
2763
+ *
2764
+ * Required API Key ACLs:
2765
+ * - addObject
2766
+ * - deleteIndex
2767
+ * - editSettings
2768
+ * @param transformationCreate - Request body for creating a transformation.
2769
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2770
+ * @see createTransformation for the plain version.
2771
+ */
2772
+ createTransformationWithHTTPInfo(transformationCreate: TransformationCreate, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<TransformationCreateResponse>>;
2687
2773
  /**
2688
2774
  * This method lets you send requests to the Algolia REST API.
2689
2775
  * @param customDelete - The customDelete object.
@@ -2692,6 +2778,17 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2692
2778
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2693
2779
  */
2694
2780
  customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
2781
+ /**
2782
+ * This method lets you send requests to the Algolia REST API.
2783
+ *
2784
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
2785
+ * @param customDelete - The customDelete object.
2786
+ * @param customDelete.path - Path of the endpoint, for example `1/newFeature`.
2787
+ * @param customDelete.parameters - Query parameters to apply to the current query.
2788
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2789
+ * @see customDelete for the plain version.
2790
+ */
2791
+ customDeleteWithHTTPInfo({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
2695
2792
  /**
2696
2793
  * This method lets you send requests to the Algolia REST API.
2697
2794
  * @param customGet - The customGet object.
@@ -2700,6 +2797,17 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2700
2797
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2701
2798
  */
2702
2799
  customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
2800
+ /**
2801
+ * This method lets you send requests to the Algolia REST API.
2802
+ *
2803
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
2804
+ * @param customGet - The customGet object.
2805
+ * @param customGet.path - Path of the endpoint, for example `1/newFeature`.
2806
+ * @param customGet.parameters - Query parameters to apply to the current query.
2807
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2808
+ * @see customGet for the plain version.
2809
+ */
2810
+ customGetWithHTTPInfo({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
2703
2811
  /**
2704
2812
  * This method lets you send requests to the Algolia REST API.
2705
2813
  * @param customPost - The customPost object.
@@ -2709,6 +2817,18 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2709
2817
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2710
2818
  */
2711
2819
  customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
2820
+ /**
2821
+ * This method lets you send requests to the Algolia REST API.
2822
+ *
2823
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
2824
+ * @param customPost - The customPost object.
2825
+ * @param customPost.path - Path of the endpoint, for example `1/newFeature`.
2826
+ * @param customPost.parameters - Query parameters to apply to the current query.
2827
+ * @param customPost.body - Parameters to send with the custom request.
2828
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2829
+ * @see customPost for the plain version.
2830
+ */
2831
+ customPostWithHTTPInfo({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
2712
2832
  /**
2713
2833
  * This method lets you send requests to the Algolia REST API.
2714
2834
  * @param customPut - The customPut object.
@@ -2718,6 +2838,18 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2718
2838
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2719
2839
  */
2720
2840
  customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
2841
+ /**
2842
+ * This method lets you send requests to the Algolia REST API.
2843
+ *
2844
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
2845
+ * @param customPut - The customPut object.
2846
+ * @param customPut.path - Path of the endpoint, for example `1/newFeature`.
2847
+ * @param customPut.parameters - Query parameters to apply to the current query.
2848
+ * @param customPut.body - Parameters to send with the custom request.
2849
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2850
+ * @see customPut for the plain version.
2851
+ */
2852
+ customPutWithHTTPInfo({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
2721
2853
  /**
2722
2854
  * Deletes an authentication resource. You can\'t delete authentication resources that are used by a source or a destination.
2723
2855
  *
@@ -2730,6 +2862,21 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2730
2862
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2731
2863
  */
2732
2864
  deleteAuthentication({ authenticationID }: DeleteAuthenticationProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
2865
+ /**
2866
+ * Deletes an authentication resource. You can\'t delete authentication resources that are used by a source or a destination.
2867
+ *
2868
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
2869
+ *
2870
+ * Required API Key ACLs:
2871
+ * - addObject
2872
+ * - deleteIndex
2873
+ * - editSettings
2874
+ * @param deleteAuthentication - The deleteAuthentication object.
2875
+ * @param deleteAuthentication.authenticationID - Unique identifier of an authentication resource.
2876
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2877
+ * @see deleteAuthentication for the plain version.
2878
+ */
2879
+ deleteAuthenticationWithHTTPInfo({ authenticationID }: DeleteAuthenticationProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<DeleteResponse>>;
2733
2880
  /**
2734
2881
  * Deletes a destination by its ID. You can\'t delete destinations that are referenced in tasks.
2735
2882
  *
@@ -2742,6 +2889,21 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2742
2889
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2743
2890
  */
2744
2891
  deleteDestination({ destinationID }: DeleteDestinationProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
2892
+ /**
2893
+ * Deletes a destination by its ID. You can\'t delete destinations that are referenced in tasks.
2894
+ *
2895
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
2896
+ *
2897
+ * Required API Key ACLs:
2898
+ * - addObject
2899
+ * - deleteIndex
2900
+ * - editSettings
2901
+ * @param deleteDestination - The deleteDestination object.
2902
+ * @param deleteDestination.destinationID - Unique identifier of a destination.
2903
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2904
+ * @see deleteDestination for the plain version.
2905
+ */
2906
+ deleteDestinationWithHTTPInfo({ destinationID }: DeleteDestinationProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<DeleteResponse>>;
2745
2907
  /**
2746
2908
  * Deletes a source by its ID. You can\'t delete sources that are referenced in tasks.
2747
2909
  *
@@ -2754,6 +2916,21 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2754
2916
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2755
2917
  */
2756
2918
  deleteSource({ sourceID }: DeleteSourceProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
2919
+ /**
2920
+ * Deletes a source by its ID. You can\'t delete sources that are referenced in tasks.
2921
+ *
2922
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
2923
+ *
2924
+ * Required API Key ACLs:
2925
+ * - addObject
2926
+ * - deleteIndex
2927
+ * - editSettings
2928
+ * @param deleteSource - The deleteSource object.
2929
+ * @param deleteSource.sourceID - Unique identifier of a source.
2930
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2931
+ * @see deleteSource for the plain version.
2932
+ */
2933
+ deleteSourceWithHTTPInfo({ sourceID }: DeleteSourceProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<DeleteResponse>>;
2757
2934
  /**
2758
2935
  * Deletes a task by its ID.
2759
2936
  *
@@ -2766,6 +2943,21 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2766
2943
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2767
2944
  */
2768
2945
  deleteTask({ taskID }: DeleteTaskProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
2946
+ /**
2947
+ * Deletes a task by its ID.
2948
+ *
2949
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
2950
+ *
2951
+ * Required API Key ACLs:
2952
+ * - addObject
2953
+ * - deleteIndex
2954
+ * - editSettings
2955
+ * @param deleteTask - The deleteTask object.
2956
+ * @param deleteTask.taskID - Unique identifier of a task.
2957
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2958
+ * @see deleteTask for the plain version.
2959
+ */
2960
+ deleteTaskWithHTTPInfo({ taskID }: DeleteTaskProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<DeleteResponse>>;
2769
2961
  /**
2770
2962
  * Deletes a task by its ID using the v1 endpoint. Use `deleteTask` instead.
2771
2963
  *
@@ -2780,6 +2972,23 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2780
2972
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2781
2973
  */
2782
2974
  deleteTaskV1({ taskID }: DeleteTaskV1Props, requestOptions?: RequestOptions): Promise<DeleteResponse>;
2975
+ /**
2976
+ * Deletes a task by its ID using the v1 endpoint. Use `deleteTask` instead.
2977
+ *
2978
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
2979
+ *
2980
+ * Required API Key ACLs:
2981
+ * - addObject
2982
+ * - deleteIndex
2983
+ * - editSettings
2984
+ *
2985
+ * @deprecated
2986
+ * @param deleteTaskV1 - The deleteTaskV1 object.
2987
+ * @param deleteTaskV1.taskID - Unique identifier of a task.
2988
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2989
+ * @see deleteTaskV1 for the plain version.
2990
+ */
2991
+ deleteTaskV1WithHTTPInfo({ taskID }: DeleteTaskV1Props, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<DeleteResponse>>;
2783
2992
  /**
2784
2993
  * Deletes a transformation by its ID.
2785
2994
  *
@@ -2792,6 +3001,21 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2792
3001
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2793
3002
  */
2794
3003
  deleteTransformation({ transformationID }: DeleteTransformationProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
3004
+ /**
3005
+ * Deletes a transformation by its ID.
3006
+ *
3007
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3008
+ *
3009
+ * Required API Key ACLs:
3010
+ * - addObject
3011
+ * - deleteIndex
3012
+ * - editSettings
3013
+ * @param deleteTransformation - The deleteTransformation object.
3014
+ * @param deleteTransformation.transformationID - Unique identifier of a transformation.
3015
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3016
+ * @see deleteTransformation for the plain version.
3017
+ */
3018
+ deleteTransformationWithHTTPInfo({ transformationID }: DeleteTransformationProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<DeleteResponse>>;
2795
3019
  /**
2796
3020
  * Disables a task.
2797
3021
  *
@@ -2804,6 +3028,21 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2804
3028
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2805
3029
  */
2806
3030
  disableTask({ taskID }: DisableTaskProps, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
3031
+ /**
3032
+ * Disables a task.
3033
+ *
3034
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3035
+ *
3036
+ * Required API Key ACLs:
3037
+ * - addObject
3038
+ * - deleteIndex
3039
+ * - editSettings
3040
+ * @param disableTask - The disableTask object.
3041
+ * @param disableTask.taskID - Unique identifier of a task.
3042
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3043
+ * @see disableTask for the plain version.
3044
+ */
3045
+ disableTaskWithHTTPInfo({ taskID }: DisableTaskProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<TaskUpdateResponse>>;
2807
3046
  /**
2808
3047
  * Disables a task using the v1 endpoint. Use `disableTask` instead.
2809
3048
  *
@@ -2818,6 +3057,23 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2818
3057
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2819
3058
  */
2820
3059
  disableTaskV1({ taskID }: DisableTaskV1Props, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
3060
+ /**
3061
+ * Disables a task using the v1 endpoint. Use `disableTask` instead.
3062
+ *
3063
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3064
+ *
3065
+ * Required API Key ACLs:
3066
+ * - addObject
3067
+ * - deleteIndex
3068
+ * - editSettings
3069
+ *
3070
+ * @deprecated
3071
+ * @param disableTaskV1 - The disableTaskV1 object.
3072
+ * @param disableTaskV1.taskID - Unique identifier of a task.
3073
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3074
+ * @see disableTaskV1 for the plain version.
3075
+ */
3076
+ disableTaskV1WithHTTPInfo({ taskID }: DisableTaskV1Props, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<TaskUpdateResponse>>;
2821
3077
  /**
2822
3078
  * Enables a task.
2823
3079
  *
@@ -2830,6 +3086,21 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2830
3086
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2831
3087
  */
2832
3088
  enableTask({ taskID }: EnableTaskProps, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
3089
+ /**
3090
+ * Enables a task.
3091
+ *
3092
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3093
+ *
3094
+ * Required API Key ACLs:
3095
+ * - addObject
3096
+ * - deleteIndex
3097
+ * - editSettings
3098
+ * @param enableTask - The enableTask object.
3099
+ * @param enableTask.taskID - Unique identifier of a task.
3100
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3101
+ * @see enableTask for the plain version.
3102
+ */
3103
+ enableTaskWithHTTPInfo({ taskID }: EnableTaskProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<TaskUpdateResponse>>;
2833
3104
  /**
2834
3105
  * Enables a task using the v1 endpoint. Use `enableTask` instead.
2835
3106
  *
@@ -2844,6 +3115,23 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2844
3115
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2845
3116
  */
2846
3117
  enableTaskV1({ taskID }: EnableTaskV1Props, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
3118
+ /**
3119
+ * Enables a task using the v1 endpoint. Use `enableTask` instead.
3120
+ *
3121
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3122
+ *
3123
+ * Required API Key ACLs:
3124
+ * - addObject
3125
+ * - deleteIndex
3126
+ * - editSettings
3127
+ *
3128
+ * @deprecated
3129
+ * @param enableTaskV1 - The enableTaskV1 object.
3130
+ * @param enableTaskV1.taskID - Unique identifier of a task.
3131
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3132
+ * @see enableTaskV1 for the plain version.
3133
+ */
3134
+ enableTaskV1WithHTTPInfo({ taskID }: EnableTaskV1Props, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<TaskUpdateResponse>>;
2847
3135
  /**
2848
3136
  * Retrieves an authentication resource by its ID.
2849
3137
  *
@@ -2856,6 +3144,21 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2856
3144
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2857
3145
  */
2858
3146
  getAuthentication({ authenticationID }: GetAuthenticationProps, requestOptions?: RequestOptions): Promise<Authentication>;
3147
+ /**
3148
+ * Retrieves an authentication resource by its ID.
3149
+ *
3150
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3151
+ *
3152
+ * Required API Key ACLs:
3153
+ * - addObject
3154
+ * - deleteIndex
3155
+ * - editSettings
3156
+ * @param getAuthentication - The getAuthentication object.
3157
+ * @param getAuthentication.authenticationID - Unique identifier of an authentication resource.
3158
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3159
+ * @see getAuthentication for the plain version.
3160
+ */
3161
+ getAuthenticationWithHTTPInfo({ authenticationID }: GetAuthenticationProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Authentication>>;
2859
3162
  /**
2860
3163
  * Retrieves a destination by its ID.
2861
3164
  *
@@ -2868,6 +3171,21 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2868
3171
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2869
3172
  */
2870
3173
  getDestination({ destinationID }: GetDestinationProps, requestOptions?: RequestOptions): Promise<Destination>;
3174
+ /**
3175
+ * Retrieves a destination by its ID.
3176
+ *
3177
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3178
+ *
3179
+ * Required API Key ACLs:
3180
+ * - addObject
3181
+ * - deleteIndex
3182
+ * - editSettings
3183
+ * @param getDestination - The getDestination object.
3184
+ * @param getDestination.destinationID - Unique identifier of a destination.
3185
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3186
+ * @see getDestination for the plain version.
3187
+ */
3188
+ getDestinationWithHTTPInfo({ destinationID }: GetDestinationProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Destination>>;
2871
3189
  /**
2872
3190
  * Retrieves a single task run event by its ID.
2873
3191
  *
@@ -2882,17 +3200,48 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2882
3200
  */
2883
3201
  getEvent({ runID, eventID }: GetEventProps, requestOptions?: RequestOptions): Promise<Event>;
2884
3202
  /**
2885
- * Retrieve a single task run by its ID.
3203
+ * Retrieves a single task run event by its ID.
3204
+ *
3205
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
2886
3206
  *
2887
3207
  * Required API Key ACLs:
2888
3208
  * - addObject
2889
3209
  * - deleteIndex
2890
3210
  * - editSettings
2891
- * @param getRun - The getRun object.
3211
+ * @param getEvent - The getEvent object.
3212
+ * @param getEvent.runID - Unique identifier of a task run.
3213
+ * @param getEvent.eventID - Unique identifier of an event.
3214
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3215
+ * @see getEvent for the plain version.
3216
+ */
3217
+ getEventWithHTTPInfo({ runID, eventID }: GetEventProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Event>>;
3218
+ /**
3219
+ * Retrieve a single task run by its ID.
3220
+ *
3221
+ * Required API Key ACLs:
3222
+ * - addObject
3223
+ * - deleteIndex
3224
+ * - editSettings
3225
+ * @param getRun - The getRun object.
2892
3226
  * @param getRun.runID - Unique identifier of a task run.
2893
3227
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2894
3228
  */
2895
3229
  getRun({ runID }: GetRunProps, requestOptions?: RequestOptions): Promise<Run>;
3230
+ /**
3231
+ * Retrieve a single task run by its ID.
3232
+ *
3233
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3234
+ *
3235
+ * Required API Key ACLs:
3236
+ * - addObject
3237
+ * - deleteIndex
3238
+ * - editSettings
3239
+ * @param getRun - The getRun object.
3240
+ * @param getRun.runID - Unique identifier of a task run.
3241
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3242
+ * @see getRun for the plain version.
3243
+ */
3244
+ getRunWithHTTPInfo({ runID }: GetRunProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Run>>;
2896
3245
  /**
2897
3246
  * Retrieve a source by its ID.
2898
3247
  *
@@ -2905,6 +3254,21 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2905
3254
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2906
3255
  */
2907
3256
  getSource({ sourceID }: GetSourceProps, requestOptions?: RequestOptions): Promise<Source>;
3257
+ /**
3258
+ * Retrieve a source by its ID.
3259
+ *
3260
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3261
+ *
3262
+ * Required API Key ACLs:
3263
+ * - addObject
3264
+ * - deleteIndex
3265
+ * - editSettings
3266
+ * @param getSource - The getSource object.
3267
+ * @param getSource.sourceID - Unique identifier of a source.
3268
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3269
+ * @see getSource for the plain version.
3270
+ */
3271
+ getSourceWithHTTPInfo({ sourceID }: GetSourceProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Source>>;
2908
3272
  /**
2909
3273
  * Retrieves a task by its ID.
2910
3274
  *
@@ -2917,6 +3281,21 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2917
3281
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2918
3282
  */
2919
3283
  getTask({ taskID }: GetTaskProps, requestOptions?: RequestOptions): Promise<Task>;
3284
+ /**
3285
+ * Retrieves a task by its ID.
3286
+ *
3287
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3288
+ *
3289
+ * Required API Key ACLs:
3290
+ * - addObject
3291
+ * - deleteIndex
3292
+ * - editSettings
3293
+ * @param getTask - The getTask object.
3294
+ * @param getTask.taskID - Unique identifier of a task.
3295
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3296
+ * @see getTask for the plain version.
3297
+ */
3298
+ getTaskWithHTTPInfo({ taskID }: GetTaskProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Task>>;
2920
3299
  /**
2921
3300
  * Retrieves a task by its ID using the v1 endpoint. Use `getTask` instead.
2922
3301
  *
@@ -2931,6 +3310,23 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2931
3310
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2932
3311
  */
2933
3312
  getTaskV1({ taskID }: GetTaskV1Props, requestOptions?: RequestOptions): Promise<TaskV1>;
3313
+ /**
3314
+ * Retrieves a task by its ID using the v1 endpoint. Use `getTask` instead.
3315
+ *
3316
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3317
+ *
3318
+ * Required API Key ACLs:
3319
+ * - addObject
3320
+ * - deleteIndex
3321
+ * - editSettings
3322
+ *
3323
+ * @deprecated
3324
+ * @param getTaskV1 - The getTaskV1 object.
3325
+ * @param getTaskV1.taskID - Unique identifier of a task.
3326
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3327
+ * @see getTaskV1 for the plain version.
3328
+ */
3329
+ getTaskV1WithHTTPInfo({ taskID }: GetTaskV1Props, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<TaskV1>>;
2934
3330
  /**
2935
3331
  * Retrieves a transformation by its ID.
2936
3332
  *
@@ -2943,6 +3339,21 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2943
3339
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2944
3340
  */
2945
3341
  getTransformation({ transformationID }: GetTransformationProps, requestOptions?: RequestOptions): Promise<Transformation>;
3342
+ /**
3343
+ * Retrieves a transformation by its ID.
3344
+ *
3345
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3346
+ *
3347
+ * Required API Key ACLs:
3348
+ * - addObject
3349
+ * - deleteIndex
3350
+ * - editSettings
3351
+ * @param getTransformation - The getTransformation object.
3352
+ * @param getTransformation.transformationID - Unique identifier of a transformation.
3353
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3354
+ * @see getTransformation for the plain version.
3355
+ */
3356
+ getTransformationWithHTTPInfo({ transformationID }: GetTransformationProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Transformation>>;
2946
3357
  /**
2947
3358
  * Retrieves a list of all authentication resources.
2948
3359
  *
@@ -2960,6 +3371,26 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2960
3371
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2961
3372
  */
2962
3373
  listAuthentications({ itemsPerPage, page, type, platform, sort, order }?: ListAuthenticationsProps, requestOptions?: RequestOptions | undefined): Promise<ListAuthenticationsResponse>;
3374
+ /**
3375
+ * Retrieves a list of all authentication resources.
3376
+ *
3377
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3378
+ *
3379
+ * Required API Key ACLs:
3380
+ * - addObject
3381
+ * - deleteIndex
3382
+ * - editSettings
3383
+ * @param listAuthentications - The listAuthentications object.
3384
+ * @param listAuthentications.itemsPerPage - Number of items per page.
3385
+ * @param listAuthentications.page - Page number of the paginated API response.
3386
+ * @param listAuthentications.type - Type of authentication resource to retrieve.
3387
+ * @param listAuthentications.platform - Ecommerce platform for which to retrieve authentications.
3388
+ * @param listAuthentications.sort - Property by which to sort the list of authentications.
3389
+ * @param listAuthentications.order - Sort order of the response, ascending or descending.
3390
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3391
+ * @see listAuthentications for the plain version.
3392
+ */
3393
+ listAuthenticationsWithHTTPInfo({ itemsPerPage, page, type, platform, sort, order }?: ListAuthenticationsProps, requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<ListAuthenticationsResponse>>;
2963
3394
  /**
2964
3395
  * Retrieves a list of destinations.
2965
3396
  *
@@ -2978,6 +3409,27 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2978
3409
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2979
3410
  */
2980
3411
  listDestinations({ itemsPerPage, page, type, authenticationID, transformationID, sort, order }?: ListDestinationsProps, requestOptions?: RequestOptions | undefined): Promise<ListDestinationsResponse>;
3412
+ /**
3413
+ * Retrieves a list of destinations.
3414
+ *
3415
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3416
+ *
3417
+ * Required API Key ACLs:
3418
+ * - addObject
3419
+ * - deleteIndex
3420
+ * - editSettings
3421
+ * @param listDestinations - The listDestinations object.
3422
+ * @param listDestinations.itemsPerPage - Number of items per page.
3423
+ * @param listDestinations.page - Page number of the paginated API response.
3424
+ * @param listDestinations.type - Destination type.
3425
+ * @param listDestinations.authenticationID - Authentication ID used by destinations.
3426
+ * @param listDestinations.transformationID - Get the list of destinations used by a transformation.
3427
+ * @param listDestinations.sort - Property by which to sort the destinations.
3428
+ * @param listDestinations.order - Sort order of the response, ascending or descending.
3429
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3430
+ * @see listDestinations for the plain version.
3431
+ */
3432
+ listDestinationsWithHTTPInfo({ itemsPerPage, page, type, authenticationID, transformationID, sort, order }?: ListDestinationsProps, requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<ListDestinationsResponse>>;
2981
3433
  /**
2982
3434
  * Retrieves a list of events for a task run, identified by its ID.
2983
3435
  *
@@ -2998,6 +3450,29 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2998
3450
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2999
3451
  */
3000
3452
  listEvents({ runID, itemsPerPage, page, status, type, sort, order, startDate, endDate }: ListEventsProps, requestOptions?: RequestOptions): Promise<ListEventsResponse>;
3453
+ /**
3454
+ * Retrieves a list of events for a task run, identified by its ID.
3455
+ *
3456
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3457
+ *
3458
+ * Required API Key ACLs:
3459
+ * - addObject
3460
+ * - deleteIndex
3461
+ * - editSettings
3462
+ * @param listEvents - The listEvents object.
3463
+ * @param listEvents.runID - Unique identifier of a task run.
3464
+ * @param listEvents.itemsPerPage - Number of items per page.
3465
+ * @param listEvents.page - Page number of the paginated API response.
3466
+ * @param listEvents.status - Event status for filtering the list of task runs.
3467
+ * @param listEvents.type - Event type for filtering the list of task runs.
3468
+ * @param listEvents.sort - Property by which to sort the list of task run events.
3469
+ * @param listEvents.order - Sort order of the response, ascending or descending.
3470
+ * @param listEvents.startDate - Date and time in RFC 3339 format for the earliest events to retrieve. By default, the current time minus three hours is used.
3471
+ * @param listEvents.endDate - Date and time in RFC 3339 format for the latest events to retrieve. By default, the current time is used.
3472
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3473
+ * @see listEvents for the plain version.
3474
+ */
3475
+ listEventsWithHTTPInfo({ runID, itemsPerPage, page, status, type, sort, order, startDate, endDate }: ListEventsProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<ListEventsResponse>>;
3001
3476
  /**
3002
3477
  * Retrieve a list of task runs.
3003
3478
  *
@@ -3018,6 +3493,29 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3018
3493
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3019
3494
  */
3020
3495
  listRuns({ itemsPerPage, page, status, type, taskID, sort, order, startDate, endDate }?: ListRunsProps, requestOptions?: RequestOptions | undefined): Promise<RunListResponse>;
3496
+ /**
3497
+ * Retrieve a list of task runs.
3498
+ *
3499
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3500
+ *
3501
+ * Required API Key ACLs:
3502
+ * - addObject
3503
+ * - deleteIndex
3504
+ * - editSettings
3505
+ * @param listRuns - The listRuns object.
3506
+ * @param listRuns.itemsPerPage - Number of items per page.
3507
+ * @param listRuns.page - Page number of the paginated API response.
3508
+ * @param listRuns.status - Run status for filtering the list of task runs.
3509
+ * @param listRuns.type - Run type for filtering the list of task runs.
3510
+ * @param listRuns.taskID - Task ID for filtering the list of task runs.
3511
+ * @param listRuns.sort - Property by which to sort the list of task runs.
3512
+ * @param listRuns.order - Sort order of the response, ascending or descending.
3513
+ * @param listRuns.startDate - Date and time for the earliest run to retrieve, in RFC 3339 format. By default, the current day minus seven days is used.
3514
+ * @param listRuns.endDate - Date and time for the latest run to retrieve, in RFC 3339 format. By default, the current day is used.
3515
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3516
+ * @see listRuns for the plain version.
3517
+ */
3518
+ listRunsWithHTTPInfo({ itemsPerPage, page, status, type, taskID, sort, order, startDate, endDate }?: ListRunsProps, requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<RunListResponse>>;
3021
3519
  /**
3022
3520
  * Retrieves a list of sources.
3023
3521
  *
@@ -3035,6 +3533,26 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3035
3533
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3036
3534
  */
3037
3535
  listSources({ itemsPerPage, page, type, authenticationID, sort, order }?: ListSourcesProps, requestOptions?: RequestOptions | undefined): Promise<ListSourcesResponse>;
3536
+ /**
3537
+ * Retrieves a list of sources.
3538
+ *
3539
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3540
+ *
3541
+ * Required API Key ACLs:
3542
+ * - addObject
3543
+ * - deleteIndex
3544
+ * - editSettings
3545
+ * @param listSources - The listSources object.
3546
+ * @param listSources.itemsPerPage - Number of items per page.
3547
+ * @param listSources.page - Page number of the paginated API response.
3548
+ * @param listSources.type - Source type. Some sources require authentication.
3549
+ * @param listSources.authenticationID - Authentication IDs of the sources to retrieve. \'none\' returns sources that doesn\'t have an authentication.
3550
+ * @param listSources.sort - Property by which to sort the list of sources.
3551
+ * @param listSources.order - Sort order of the response, ascending or descending.
3552
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3553
+ * @see listSources for the plain version.
3554
+ */
3555
+ listSourcesWithHTTPInfo({ itemsPerPage, page, type, authenticationID, sort, order }?: ListSourcesProps, requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<ListSourcesResponse>>;
3038
3556
  /**
3039
3557
  * Retrieves a list of tasks.
3040
3558
  *
@@ -3057,6 +3575,31 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3057
3575
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3058
3576
  */
3059
3577
  listTasks({ itemsPerPage, page, action, enabled, sourceID, sourceType, destinationID, triggerType, withEmailNotifications, sort, order, }?: ListTasksProps, requestOptions?: RequestOptions | undefined): Promise<ListTasksResponse>;
3578
+ /**
3579
+ * Retrieves a list of tasks.
3580
+ *
3581
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3582
+ *
3583
+ * Required API Key ACLs:
3584
+ * - addObject
3585
+ * - deleteIndex
3586
+ * - editSettings
3587
+ * @param listTasks - The listTasks object.
3588
+ * @param listTasks.itemsPerPage - Number of items per page.
3589
+ * @param listTasks.page - Page number of the paginated API response.
3590
+ * @param listTasks.action - Actions for filtering the list of tasks.
3591
+ * @param listTasks.enabled - Whether to filter the list of tasks by the `enabled` status.
3592
+ * @param listTasks.sourceID - Source IDs for filtering the list of tasks.
3593
+ * @param listTasks.sourceType - Filters the tasks with the specified source type.
3594
+ * @param listTasks.destinationID - Destination IDs for filtering the list of tasks.
3595
+ * @param listTasks.triggerType - Type of task trigger for filtering the list of tasks.
3596
+ * @param listTasks.withEmailNotifications - If specified, the response only includes tasks with notifications.email.enabled set to this value.
3597
+ * @param listTasks.sort - Property by which to sort the list of tasks.
3598
+ * @param listTasks.order - Sort order of the response, ascending or descending.
3599
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3600
+ * @see listTasks for the plain version.
3601
+ */
3602
+ listTasksWithHTTPInfo({ itemsPerPage, page, action, enabled, sourceID, sourceType, destinationID, triggerType, withEmailNotifications, sort, order, }?: ListTasksProps, requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<ListTasksResponse>>;
3060
3603
  /**
3061
3604
  * Retrieves a list of tasks using the v1 endpoint. Use `getTasks` instead.
3062
3605
  *
@@ -3079,6 +3622,31 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3079
3622
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3080
3623
  */
3081
3624
  listTasksV1({ itemsPerPage, page, action, enabled, sourceID, destinationID, triggerType, sort, order }?: ListTasksV1Props, requestOptions?: RequestOptions | undefined): Promise<ListTasksResponseV1>;
3625
+ /**
3626
+ * Retrieves a list of tasks using the v1 endpoint. Use `getTasks` instead.
3627
+ *
3628
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3629
+ *
3630
+ * Required API Key ACLs:
3631
+ * - addObject
3632
+ * - deleteIndex
3633
+ * - editSettings
3634
+ *
3635
+ * @deprecated
3636
+ * @param listTasksV1 - The listTasksV1 object.
3637
+ * @param listTasksV1.itemsPerPage - Number of items per page.
3638
+ * @param listTasksV1.page - Page number of the paginated API response.
3639
+ * @param listTasksV1.action - Actions for filtering the list of tasks.
3640
+ * @param listTasksV1.enabled - Whether to filter the list of tasks by the `enabled` status.
3641
+ * @param listTasksV1.sourceID - Source IDs for filtering the list of tasks.
3642
+ * @param listTasksV1.destinationID - Destination IDs for filtering the list of tasks.
3643
+ * @param listTasksV1.triggerType - Type of task trigger for filtering the list of tasks.
3644
+ * @param listTasksV1.sort - Property by which to sort the list of tasks.
3645
+ * @param listTasksV1.order - Sort order of the response, ascending or descending.
3646
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3647
+ * @see listTasksV1 for the plain version.
3648
+ */
3649
+ listTasksV1WithHTTPInfo({ itemsPerPage, page, action, enabled, sourceID, destinationID, triggerType, sort, order }?: ListTasksV1Props, requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<ListTasksResponseV1>>;
3082
3650
  /**
3083
3651
  * Retrieves a list of transformations.
3084
3652
  *
@@ -3095,6 +3663,25 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3095
3663
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3096
3664
  */
3097
3665
  listTransformations({ itemsPerPage, page, sort, order, type }?: ListTransformationsProps, requestOptions?: RequestOptions | undefined): Promise<ListTransformationsResponse>;
3666
+ /**
3667
+ * Retrieves a list of transformations.
3668
+ *
3669
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3670
+ *
3671
+ * Required API Key ACLs:
3672
+ * - addObject
3673
+ * - deleteIndex
3674
+ * - editSettings
3675
+ * @param listTransformations - The listTransformations object.
3676
+ * @param listTransformations.itemsPerPage - Number of items per page.
3677
+ * @param listTransformations.page - Page number of the paginated API response.
3678
+ * @param listTransformations.sort - Property by which to sort the list of transformations.
3679
+ * @param listTransformations.order - Sort order of the response, ascending or descending.
3680
+ * @param listTransformations.type - Whether to filter the list of transformations by the type of transformation.
3681
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3682
+ * @see listTransformations for the plain version.
3683
+ */
3684
+ listTransformationsWithHTTPInfo({ itemsPerPage, page, sort, order, type }?: ListTransformationsProps, requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<ListTransformationsResponse>>;
3098
3685
  /**
3099
3686
  * Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data), this is the recommended way of ingesting your records. This method is similar to `pushTask`, but requires an `indexName` instead of a `taskID`. If zero or many tasks are found, an error will be returned.
3100
3687
  *
@@ -3110,6 +3697,24 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3110
3697
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3111
3698
  */
3112
3699
  push({ indexName, pushTaskPayload, watch, referenceIndexName }: PushProps, requestOptions?: RequestOptions): Promise<WatchResponse>;
3700
+ /**
3701
+ * Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data), this is the recommended way of ingesting your records. This method is similar to `pushTask`, but requires an `indexName` instead of a `taskID`. If zero or many tasks are found, an error will be returned.
3702
+ *
3703
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3704
+ *
3705
+ * Required API Key ACLs:
3706
+ * - addObject
3707
+ * - deleteIndex
3708
+ * - editSettings
3709
+ * @param push - The push object.
3710
+ * @param push.indexName - Name of the index on which to perform the operation.
3711
+ * @param push.pushTaskPayload - The pushTaskPayload object.
3712
+ * @param push.watch - When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
3713
+ * @param push.referenceIndexName - This is required when targeting an index that does not have a push connector setup (e.g. a tmp index), but you wish to attach another index\'s transformation to it (e.g. the source index name).
3714
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3715
+ * @see push for the plain version.
3716
+ */
3717
+ pushWithHTTPInfo({ indexName, pushTaskPayload, watch, referenceIndexName }: PushProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<WatchResponse>>;
3113
3718
  /**
3114
3719
  * Pushes records through the pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints or the debugger dashboard to see the status of your task. If you want to transform your data before indexing, this is the recommended way of ingesting your records. This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
3115
3720
  *
@@ -3123,10 +3728,42 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3123
3728
  * @param pushTask.watch - When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
3124
3729
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3125
3730
  */
3126
- pushTask({ taskID, pushTaskPayload, watch }: PushTaskProps, requestOptions?: RequestOptions): Promise<WatchResponse>;
3731
+ pushTask({ taskID, pushTaskPayload, watch }: PushTaskProps, requestOptions?: RequestOptions): Promise<WatchResponse>;
3732
+ /**
3733
+ * Pushes records through the pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints or the debugger dashboard to see the status of your task. If you want to transform your data before indexing, this is the recommended way of ingesting your records. This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
3734
+ *
3735
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3736
+ *
3737
+ * Required API Key ACLs:
3738
+ * - addObject
3739
+ * - deleteIndex
3740
+ * - editSettings
3741
+ * @param pushTask - The pushTask object.
3742
+ * @param pushTask.taskID - Unique identifier of a task.
3743
+ * @param pushTask.pushTaskPayload - The pushTaskPayload object.
3744
+ * @param pushTask.watch - When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
3745
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3746
+ * @see pushTask for the plain version.
3747
+ */
3748
+ pushTaskWithHTTPInfo({ taskID, pushTaskPayload, watch }: PushTaskProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<WatchResponse>>;
3749
+ /**
3750
+ * Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
3751
+ *
3752
+ * Required API Key ACLs:
3753
+ * - addObject
3754
+ * - deleteIndex
3755
+ * - editSettings
3756
+ * @param replaceTask - The replaceTask object.
3757
+ * @param replaceTask.taskID - Unique identifier of a task.
3758
+ * @param replaceTask.taskReplace - The taskReplace object.
3759
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3760
+ */
3761
+ replaceTask({ taskID, taskReplace }: ReplaceTaskProps, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
3127
3762
  /**
3128
3763
  * Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
3129
3764
  *
3765
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3766
+ *
3130
3767
  * Required API Key ACLs:
3131
3768
  * - addObject
3132
3769
  * - deleteIndex
@@ -3135,8 +3772,9 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3135
3772
  * @param replaceTask.taskID - Unique identifier of a task.
3136
3773
  * @param replaceTask.taskReplace - The taskReplace object.
3137
3774
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3775
+ * @see replaceTask for the plain version.
3138
3776
  */
3139
- replaceTask({ taskID, taskReplace }: ReplaceTaskProps, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
3777
+ replaceTaskWithHTTPInfo({ taskID, taskReplace }: ReplaceTaskProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<TaskUpdateResponse>>;
3140
3778
  /**
3141
3779
  * Runs all tasks linked to a source, only available for Shopify, BigCommerce and commercetools sources. Creates one run per task.
3142
3780
  *
@@ -3150,6 +3788,22 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3150
3788
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3151
3789
  */
3152
3790
  runSource({ sourceID, runSourcePayload }: RunSourceProps, requestOptions?: RequestOptions): Promise<RunSourceResponse>;
3791
+ /**
3792
+ * Runs all tasks linked to a source, only available for Shopify, BigCommerce and commercetools sources. Creates one run per task.
3793
+ *
3794
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3795
+ *
3796
+ * Required API Key ACLs:
3797
+ * - addObject
3798
+ * - deleteIndex
3799
+ * - editSettings
3800
+ * @param runSource - The runSource object.
3801
+ * @param runSource.sourceID - Unique identifier of a source.
3802
+ * @param runSource.runSourcePayload -
3803
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3804
+ * @see runSource for the plain version.
3805
+ */
3806
+ runSourceWithHTTPInfo({ sourceID, runSourcePayload }: RunSourceProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<RunSourceResponse>>;
3153
3807
  /**
3154
3808
  * Runs a task. You can check the status of task runs with the observability endpoints.
3155
3809
  *
@@ -3163,6 +3817,22 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3163
3817
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3164
3818
  */
3165
3819
  runTask({ taskID, runTaskPayload }: RunTaskProps, requestOptions?: RequestOptions): Promise<RunResponse>;
3820
+ /**
3821
+ * Runs a task. You can check the status of task runs with the observability endpoints.
3822
+ *
3823
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3824
+ *
3825
+ * Required API Key ACLs:
3826
+ * - addObject
3827
+ * - deleteIndex
3828
+ * - editSettings
3829
+ * @param runTask - The runTask object.
3830
+ * @param runTask.taskID - Unique identifier of a task.
3831
+ * @param runTask.runTaskPayload -
3832
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3833
+ * @see runTask for the plain version.
3834
+ */
3835
+ runTaskWithHTTPInfo({ taskID, runTaskPayload }: RunTaskProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<RunResponse>>;
3166
3836
  /**
3167
3837
  * Runs a task using the v1 endpoint. Use `runTask` instead. You can check the status of task runs with the observability endpoints.
3168
3838
  *
@@ -3178,6 +3848,24 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3178
3848
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3179
3849
  */
3180
3850
  runTaskV1({ taskID, runTaskPayload }: RunTaskV1Props, requestOptions?: RequestOptions): Promise<RunResponse>;
3851
+ /**
3852
+ * Runs a task using the v1 endpoint. Use `runTask` instead. You can check the status of task runs with the observability endpoints.
3853
+ *
3854
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3855
+ *
3856
+ * Required API Key ACLs:
3857
+ * - addObject
3858
+ * - deleteIndex
3859
+ * - editSettings
3860
+ *
3861
+ * @deprecated
3862
+ * @param runTaskV1 - The runTaskV1 object.
3863
+ * @param runTaskV1.taskID - Unique identifier of a task.
3864
+ * @param runTaskV1.runTaskPayload -
3865
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3866
+ * @see runTaskV1 for the plain version.
3867
+ */
3868
+ runTaskV1WithHTTPInfo({ taskID, runTaskPayload }: RunTaskV1Props, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<RunResponse>>;
3181
3869
  /**
3182
3870
  * Searches for authentication resources.
3183
3871
  *
@@ -3189,6 +3877,20 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3189
3877
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3190
3878
  */
3191
3879
  searchAuthentications(authenticationSearch: AuthenticationSearch, requestOptions?: RequestOptions): Promise<Array<Authentication>>;
3880
+ /**
3881
+ * Searches for authentication resources.
3882
+ *
3883
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3884
+ *
3885
+ * Required API Key ACLs:
3886
+ * - addObject
3887
+ * - deleteIndex
3888
+ * - editSettings
3889
+ * @param authenticationSearch - The authenticationSearch object.
3890
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3891
+ * @see searchAuthentications for the plain version.
3892
+ */
3893
+ searchAuthenticationsWithHTTPInfo(authenticationSearch: AuthenticationSearch, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Array<Authentication>>>;
3192
3894
  /**
3193
3895
  * Searches for destinations.
3194
3896
  *
@@ -3200,6 +3902,20 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3200
3902
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3201
3903
  */
3202
3904
  searchDestinations(destinationSearch: DestinationSearch, requestOptions?: RequestOptions): Promise<Array<Destination>>;
3905
+ /**
3906
+ * Searches for destinations.
3907
+ *
3908
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3909
+ *
3910
+ * Required API Key ACLs:
3911
+ * - addObject
3912
+ * - deleteIndex
3913
+ * - editSettings
3914
+ * @param destinationSearch - The destinationSearch object.
3915
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3916
+ * @see searchDestinations for the plain version.
3917
+ */
3918
+ searchDestinationsWithHTTPInfo(destinationSearch: DestinationSearch, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Array<Destination>>>;
3203
3919
  /**
3204
3920
  * Searches for sources.
3205
3921
  *
@@ -3211,6 +3927,20 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3211
3927
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3212
3928
  */
3213
3929
  searchSources(sourceSearch: SourceSearch, requestOptions?: RequestOptions): Promise<Array<Source>>;
3930
+ /**
3931
+ * Searches for sources.
3932
+ *
3933
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3934
+ *
3935
+ * Required API Key ACLs:
3936
+ * - addObject
3937
+ * - deleteIndex
3938
+ * - editSettings
3939
+ * @param sourceSearch - The sourceSearch object.
3940
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3941
+ * @see searchSources for the plain version.
3942
+ */
3943
+ searchSourcesWithHTTPInfo(sourceSearch: SourceSearch, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Array<Source>>>;
3214
3944
  /**
3215
3945
  * Searches for tasks.
3216
3946
  *
@@ -3222,6 +3952,20 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3222
3952
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3223
3953
  */
3224
3954
  searchTasks(taskSearch: TaskSearch, requestOptions?: RequestOptions): Promise<Array<Task>>;
3955
+ /**
3956
+ * Searches for tasks.
3957
+ *
3958
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3959
+ *
3960
+ * Required API Key ACLs:
3961
+ * - addObject
3962
+ * - deleteIndex
3963
+ * - editSettings
3964
+ * @param taskSearch - The taskSearch object.
3965
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3966
+ * @see searchTasks for the plain version.
3967
+ */
3968
+ searchTasksWithHTTPInfo(taskSearch: TaskSearch, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Array<Task>>>;
3225
3969
  /**
3226
3970
  * Searches for tasks using the v1 endpoint. Use `searchTasks` instead.
3227
3971
  *
@@ -3235,6 +3979,22 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3235
3979
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3236
3980
  */
3237
3981
  searchTasksV1(taskSearch: TaskSearch, requestOptions?: RequestOptions): Promise<Array<TaskV1>>;
3982
+ /**
3983
+ * Searches for tasks using the v1 endpoint. Use `searchTasks` instead.
3984
+ *
3985
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
3986
+ *
3987
+ * Required API Key ACLs:
3988
+ * - addObject
3989
+ * - deleteIndex
3990
+ * - editSettings
3991
+ *
3992
+ * @deprecated
3993
+ * @param taskSearch - The taskSearch object.
3994
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3995
+ * @see searchTasksV1 for the plain version.
3996
+ */
3997
+ searchTasksV1WithHTTPInfo(taskSearch: TaskSearch, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Array<TaskV1>>>;
3238
3998
  /**
3239
3999
  * Searches for transformations.
3240
4000
  *
@@ -3246,6 +4006,20 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3246
4006
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3247
4007
  */
3248
4008
  searchTransformations(transformationSearch: TransformationSearch, requestOptions?: RequestOptions): Promise<Array<Transformation>>;
4009
+ /**
4010
+ * Searches for transformations.
4011
+ *
4012
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4013
+ *
4014
+ * Required API Key ACLs:
4015
+ * - addObject
4016
+ * - deleteIndex
4017
+ * - editSettings
4018
+ * @param transformationSearch - The transformationSearch object.
4019
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4020
+ * @see searchTransformations for the plain version.
4021
+ */
4022
+ searchTransformationsWithHTTPInfo(transformationSearch: TransformationSearch, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Array<Transformation>>>;
3249
4023
  /**
3250
4024
  * Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: airbyte`.
3251
4025
  *
@@ -3258,6 +4032,21 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3258
4032
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3259
4033
  */
3260
4034
  triggerDockerSourceDiscover({ sourceID }: TriggerDockerSourceDiscoverProps, requestOptions?: RequestOptions): Promise<WatchResponse>;
4035
+ /**
4036
+ * Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: airbyte`.
4037
+ *
4038
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4039
+ *
4040
+ * Required API Key ACLs:
4041
+ * - addObject
4042
+ * - deleteIndex
4043
+ * - editSettings
4044
+ * @param triggerDockerSourceDiscover - The triggerDockerSourceDiscover object.
4045
+ * @param triggerDockerSourceDiscover.sourceID - Unique identifier of a source.
4046
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4047
+ * @see triggerDockerSourceDiscover for the plain version.
4048
+ */
4049
+ triggerDockerSourceDiscoverWithHTTPInfo({ sourceID }: TriggerDockerSourceDiscoverProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<WatchResponse>>;
3261
4050
  /**
3262
4051
  * Try a transformation before creating it.
3263
4052
  *
@@ -3269,6 +4058,20 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3269
4058
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3270
4059
  */
3271
4060
  tryTransformation(transformationTry: TransformationTry, requestOptions?: RequestOptions): Promise<TransformationTryResponse>;
4061
+ /**
4062
+ * Try a transformation before creating it.
4063
+ *
4064
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4065
+ *
4066
+ * Required API Key ACLs:
4067
+ * - addObject
4068
+ * - deleteIndex
4069
+ * - editSettings
4070
+ * @param transformationTry - The transformationTry object.
4071
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4072
+ * @see tryTransformation for the plain version.
4073
+ */
4074
+ tryTransformationWithHTTPInfo(transformationTry: TransformationTry, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<TransformationTryResponse>>;
3272
4075
  /**
3273
4076
  * Try a transformation before updating it.
3274
4077
  *
@@ -3282,6 +4085,22 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3282
4085
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3283
4086
  */
3284
4087
  tryTransformationBeforeUpdate({ transformationID, transformationTry }: TryTransformationBeforeUpdateProps, requestOptions?: RequestOptions): Promise<TransformationTryResponse>;
4088
+ /**
4089
+ * Try a transformation before updating it.
4090
+ *
4091
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4092
+ *
4093
+ * Required API Key ACLs:
4094
+ * - addObject
4095
+ * - deleteIndex
4096
+ * - editSettings
4097
+ * @param tryTransformationBeforeUpdate - The tryTransformationBeforeUpdate object.
4098
+ * @param tryTransformationBeforeUpdate.transformationID - Unique identifier of a transformation.
4099
+ * @param tryTransformationBeforeUpdate.transformationTry - The transformationTry object.
4100
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4101
+ * @see tryTransformationBeforeUpdate for the plain version.
4102
+ */
4103
+ tryTransformationBeforeUpdateWithHTTPInfo({ transformationID, transformationTry }: TryTransformationBeforeUpdateProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<TransformationTryResponse>>;
3285
4104
  /**
3286
4105
  * Updates an authentication resource.
3287
4106
  *
@@ -3295,6 +4114,22 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3295
4114
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3296
4115
  */
3297
4116
  updateAuthentication({ authenticationID, authenticationUpdate }: UpdateAuthenticationProps, requestOptions?: RequestOptions): Promise<AuthenticationUpdateResponse>;
4117
+ /**
4118
+ * Updates an authentication resource.
4119
+ *
4120
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4121
+ *
4122
+ * Required API Key ACLs:
4123
+ * - addObject
4124
+ * - deleteIndex
4125
+ * - editSettings
4126
+ * @param updateAuthentication - The updateAuthentication object.
4127
+ * @param updateAuthentication.authenticationID - Unique identifier of an authentication resource.
4128
+ * @param updateAuthentication.authenticationUpdate - The authenticationUpdate object.
4129
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4130
+ * @see updateAuthentication for the plain version.
4131
+ */
4132
+ updateAuthenticationWithHTTPInfo({ authenticationID, authenticationUpdate }: UpdateAuthenticationProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<AuthenticationUpdateResponse>>;
3298
4133
  /**
3299
4134
  * Updates the destination by its ID.
3300
4135
  *
@@ -3308,6 +4143,22 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3308
4143
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3309
4144
  */
3310
4145
  updateDestination({ destinationID, destinationUpdate }: UpdateDestinationProps, requestOptions?: RequestOptions): Promise<DestinationUpdateResponse>;
4146
+ /**
4147
+ * Updates the destination by its ID.
4148
+ *
4149
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4150
+ *
4151
+ * Required API Key ACLs:
4152
+ * - addObject
4153
+ * - deleteIndex
4154
+ * - editSettings
4155
+ * @param updateDestination - The updateDestination object.
4156
+ * @param updateDestination.destinationID - Unique identifier of a destination.
4157
+ * @param updateDestination.destinationUpdate - The destinationUpdate object.
4158
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4159
+ * @see updateDestination for the plain version.
4160
+ */
4161
+ updateDestinationWithHTTPInfo({ destinationID, destinationUpdate }: UpdateDestinationProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<DestinationUpdateResponse>>;
3311
4162
  /**
3312
4163
  * Updates a source by its ID.
3313
4164
  *
@@ -3321,6 +4172,22 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3321
4172
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3322
4173
  */
3323
4174
  updateSource({ sourceID, sourceUpdate }: UpdateSourceProps, requestOptions?: RequestOptions): Promise<SourceUpdateResponse>;
4175
+ /**
4176
+ * Updates a source by its ID.
4177
+ *
4178
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4179
+ *
4180
+ * Required API Key ACLs:
4181
+ * - addObject
4182
+ * - deleteIndex
4183
+ * - editSettings
4184
+ * @param updateSource - The updateSource object.
4185
+ * @param updateSource.sourceID - Unique identifier of a source.
4186
+ * @param updateSource.sourceUpdate - The sourceUpdate object.
4187
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4188
+ * @see updateSource for the plain version.
4189
+ */
4190
+ updateSourceWithHTTPInfo({ sourceID, sourceUpdate }: UpdateSourceProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<SourceUpdateResponse>>;
3324
4191
  /**
3325
4192
  * Partially updates a task by its ID.
3326
4193
  *
@@ -3334,6 +4201,22 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3334
4201
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3335
4202
  */
3336
4203
  updateTask({ taskID, taskUpdate }: UpdateTaskProps, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
4204
+ /**
4205
+ * Partially updates a task by its ID.
4206
+ *
4207
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4208
+ *
4209
+ * Required API Key ACLs:
4210
+ * - addObject
4211
+ * - deleteIndex
4212
+ * - editSettings
4213
+ * @param updateTask - The updateTask object.
4214
+ * @param updateTask.taskID - Unique identifier of a task.
4215
+ * @param updateTask.taskUpdate - The taskUpdate object.
4216
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4217
+ * @see updateTask for the plain version.
4218
+ */
4219
+ updateTaskWithHTTPInfo({ taskID, taskUpdate }: UpdateTaskProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<TaskUpdateResponse>>;
3337
4220
  /**
3338
4221
  * Updates a task by its ID using the v1 endpoint. Use `updateTask` instead.
3339
4222
  *
@@ -3349,6 +4232,24 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3349
4232
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3350
4233
  */
3351
4234
  updateTaskV1({ taskID, taskUpdate }: UpdateTaskV1Props, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
4235
+ /**
4236
+ * Updates a task by its ID using the v1 endpoint. Use `updateTask` instead.
4237
+ *
4238
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4239
+ *
4240
+ * Required API Key ACLs:
4241
+ * - addObject
4242
+ * - deleteIndex
4243
+ * - editSettings
4244
+ *
4245
+ * @deprecated
4246
+ * @param updateTaskV1 - The updateTaskV1 object.
4247
+ * @param updateTaskV1.taskID - Unique identifier of a task.
4248
+ * @param updateTaskV1.taskUpdate - The taskUpdate object.
4249
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4250
+ * @see updateTaskV1 for the plain version.
4251
+ */
4252
+ updateTaskV1WithHTTPInfo({ taskID, taskUpdate }: UpdateTaskV1Props, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<TaskUpdateResponse>>;
3352
4253
  /**
3353
4254
  * Updates a transformation by its ID.
3354
4255
  *
@@ -3362,6 +4263,22 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3362
4263
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3363
4264
  */
3364
4265
  updateTransformation({ transformationID, transformationCreate }: UpdateTransformationProps, requestOptions?: RequestOptions): Promise<TransformationUpdateResponse>;
4266
+ /**
4267
+ * Updates a transformation by its ID.
4268
+ *
4269
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4270
+ *
4271
+ * Required API Key ACLs:
4272
+ * - addObject
4273
+ * - deleteIndex
4274
+ * - editSettings
4275
+ * @param updateTransformation - The updateTransformation object.
4276
+ * @param updateTransformation.transformationID - Unique identifier of a transformation.
4277
+ * @param updateTransformation.transformationCreate - The transformationCreate object.
4278
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4279
+ * @see updateTransformation for the plain version.
4280
+ */
4281
+ updateTransformationWithHTTPInfo({ transformationID, transformationCreate }: UpdateTransformationProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<TransformationUpdateResponse>>;
3365
4282
  /**
3366
4283
  * Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
3367
4284
  *
@@ -3373,6 +4290,20 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3373
4290
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3374
4291
  */
3375
4292
  validateSource(sourceCreate: SourceCreate, requestOptions?: RequestOptions | undefined): Promise<WatchResponse>;
4293
+ /**
4294
+ * Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
4295
+ *
4296
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4297
+ *
4298
+ * Required API Key ACLs:
4299
+ * - addObject
4300
+ * - deleteIndex
4301
+ * - editSettings
4302
+ * @param sourceCreate -
4303
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4304
+ * @see validateSource for the plain version.
4305
+ */
4306
+ validateSourceWithHTTPInfo(sourceCreate: SourceCreate, requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<WatchResponse>>;
3376
4307
  /**
3377
4308
  * Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.
3378
4309
  *
@@ -3386,6 +4317,22 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3386
4317
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3387
4318
  */
3388
4319
  validateSourceBeforeUpdate({ sourceID, sourceUpdate }: ValidateSourceBeforeUpdateProps, requestOptions?: RequestOptions): Promise<WatchResponse>;
4320
+ /**
4321
+ * Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.
4322
+ *
4323
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
4324
+ *
4325
+ * Required API Key ACLs:
4326
+ * - addObject
4327
+ * - deleteIndex
4328
+ * - editSettings
4329
+ * @param validateSourceBeforeUpdate - The validateSourceBeforeUpdate object.
4330
+ * @param validateSourceBeforeUpdate.sourceID - Unique identifier of a source.
4331
+ * @param validateSourceBeforeUpdate.sourceUpdate - The sourceUpdate object.
4332
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
4333
+ * @see validateSourceBeforeUpdate for the plain version.
4334
+ */
4335
+ validateSourceBeforeUpdateWithHTTPInfo({ sourceID, sourceUpdate }: ValidateSourceBeforeUpdateProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<WatchResponse>>;
3389
4336
  };
3390
4337
 
3391
4338
  /**