@nimble-way/nimble-js 0.7.0 → 0.8.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.
@@ -449,6 +449,99 @@ export namespace ExtractAsyncResponse {
449
449
  }
450
450
  }
451
451
 
452
+ /**
453
+ * Response when a batch of extract tasks is created successfully.
454
+ */
455
+ export interface ExtractBatchResponse {
456
+ /**
457
+ * Unique identifier for the batch.
458
+ */
459
+ batch_id: string;
460
+
461
+ /**
462
+ * Number of tasks in the batch.
463
+ */
464
+ batch_size: number;
465
+
466
+ /**
467
+ * List of created tasks.
468
+ */
469
+ tasks: Array<ExtractBatchResponse.Task>;
470
+ }
471
+
472
+ export namespace ExtractBatchResponse {
473
+ export interface Task {
474
+ /**
475
+ * Unique task identifier.
476
+ */
477
+ id: string;
478
+
479
+ _query: unknown;
480
+
481
+ /**
482
+ * Timestamp when the task was created.
483
+ */
484
+ created_at: string;
485
+
486
+ /**
487
+ * Original input data for the task.
488
+ */
489
+ input: unknown;
490
+
491
+ /**
492
+ * Current state of the task.
493
+ */
494
+ state: 'pending' | 'success' | 'error';
495
+
496
+ /**
497
+ * URL for checking the task status.
498
+ */
499
+ status_url: string;
500
+
501
+ /**
502
+ * Account name that owns the task.
503
+ */
504
+ account_name?: string;
505
+
506
+ api_type?: 'web' | 'serp' | 'ecommerce' | 'social' | 'media' | 'agent' | 'extract';
507
+
508
+ /**
509
+ * Batch ID if this task is part of a batch.
510
+ */
511
+ batch_id?: string;
512
+
513
+ /**
514
+ * URL for downloading the task results.
515
+ */
516
+ download_url?: string;
517
+
518
+ /**
519
+ * Error message if the task failed.
520
+ */
521
+ error?: string;
522
+
523
+ /**
524
+ * Classification of the error type.
525
+ */
526
+ error_type?: string;
527
+
528
+ /**
529
+ * Timestamp when the task was last modified.
530
+ */
531
+ modified_at?: string;
532
+
533
+ /**
534
+ * Storage location of the output data.
535
+ */
536
+ output_url?: string;
537
+
538
+ /**
539
+ * HTTP status code from the task execution.
540
+ */
541
+ status_code?: number;
542
+ }
543
+ }
544
+
452
545
  /**
453
546
  * Response schema for map requests.
454
547
  */
@@ -2751,6 +2844,1129 @@ export namespace ExtractAsyncParams {
2751
2844
  }
2752
2845
  }
2753
2846
 
2847
+ export interface ExtractBatchParams {
2848
+ /**
2849
+ * Array of extraction requests. Each object represents one extraction with its own
2850
+ * parameters.
2851
+ */
2852
+ params: Array<ExtractBatchParams.Param>;
2853
+
2854
+ /**
2855
+ * Shared parameters applied to the entire batch, such as storage and callback
2856
+ * configuration.
2857
+ */
2858
+ shared_params?: ExtractBatchParams.SharedParams;
2859
+ }
2860
+
2861
+ export namespace ExtractBatchParams {
2862
+ export interface Param {
2863
+ /**
2864
+ * Target URL to scrape
2865
+ */
2866
+ url: string;
2867
+
2868
+ /**
2869
+ * Browser type to emulate
2870
+ */
2871
+ browser?: 'chrome' | 'firefox' | Param.UnionMember1;
2872
+
2873
+ /**
2874
+ * Array of browser automation actions to execute sequentially
2875
+ */
2876
+ browser_actions?: Array<
2877
+ | Shared.AutoScrollAction
2878
+ | Shared.ClickAction
2879
+ | Shared.EvalAction
2880
+ | Shared.FetchAction
2881
+ | Shared.FillAction
2882
+ | Shared.GetCookiesAction
2883
+ | Shared.GotoAction
2884
+ | Shared.PressAction
2885
+ | Shared.ScreenshotAction
2886
+ | Shared.ScrollAction
2887
+ | Shared.WaitAction
2888
+ | Shared.WaitForElementAction
2889
+ | Shared.WaitForNavigationAction
2890
+ >;
2891
+
2892
+ /**
2893
+ * City for geolocation
2894
+ */
2895
+ city?: string;
2896
+
2897
+ /**
2898
+ * Whether to automatically handle cookie consent headers
2899
+ */
2900
+ consent_header?: boolean;
2901
+
2902
+ /**
2903
+ * Browser cookies as array of cookie objects
2904
+ */
2905
+ cookies?: Array<Param.UnionMember0> | string;
2906
+
2907
+ /**
2908
+ * Country code for geolocation and proxy selection
2909
+ */
2910
+ country?:
2911
+ | 'AD'
2912
+ | 'AE'
2913
+ | 'AF'
2914
+ | 'AG'
2915
+ | 'AI'
2916
+ | 'AL'
2917
+ | 'AM'
2918
+ | 'AO'
2919
+ | 'AQ'
2920
+ | 'AR'
2921
+ | 'AS'
2922
+ | 'AT'
2923
+ | 'AU'
2924
+ | 'AW'
2925
+ | 'AX'
2926
+ | 'AZ'
2927
+ | 'BA'
2928
+ | 'BB'
2929
+ | 'BD'
2930
+ | 'BE'
2931
+ | 'BF'
2932
+ | 'BG'
2933
+ | 'BH'
2934
+ | 'BI'
2935
+ | 'BJ'
2936
+ | 'BL'
2937
+ | 'BM'
2938
+ | 'BN'
2939
+ | 'BO'
2940
+ | 'BQ'
2941
+ | 'BR'
2942
+ | 'BS'
2943
+ | 'BT'
2944
+ | 'BV'
2945
+ | 'BW'
2946
+ | 'BY'
2947
+ | 'BZ'
2948
+ | 'CA'
2949
+ | 'CC'
2950
+ | 'CD'
2951
+ | 'CF'
2952
+ | 'CG'
2953
+ | 'CH'
2954
+ | 'CI'
2955
+ | 'CK'
2956
+ | 'CL'
2957
+ | 'CM'
2958
+ | 'CN'
2959
+ | 'CO'
2960
+ | 'CR'
2961
+ | 'CU'
2962
+ | 'CV'
2963
+ | 'CW'
2964
+ | 'CX'
2965
+ | 'CY'
2966
+ | 'CZ'
2967
+ | 'DE'
2968
+ | 'DJ'
2969
+ | 'DK'
2970
+ | 'DM'
2971
+ | 'DO'
2972
+ | 'DZ'
2973
+ | 'EC'
2974
+ | 'EE'
2975
+ | 'EG'
2976
+ | 'EH'
2977
+ | 'ER'
2978
+ | 'ES'
2979
+ | 'ET'
2980
+ | 'FI'
2981
+ | 'FJ'
2982
+ | 'FK'
2983
+ | 'FM'
2984
+ | 'FO'
2985
+ | 'FR'
2986
+ | 'GA'
2987
+ | 'GB'
2988
+ | 'GD'
2989
+ | 'GE'
2990
+ | 'GF'
2991
+ | 'GG'
2992
+ | 'GH'
2993
+ | 'GI'
2994
+ | 'GL'
2995
+ | 'GM'
2996
+ | 'GN'
2997
+ | 'GP'
2998
+ | 'GQ'
2999
+ | 'GR'
3000
+ | 'GS'
3001
+ | 'GT'
3002
+ | 'GU'
3003
+ | 'GW'
3004
+ | 'GY'
3005
+ | 'HK'
3006
+ | 'HM'
3007
+ | 'HN'
3008
+ | 'HR'
3009
+ | 'HT'
3010
+ | 'HU'
3011
+ | 'ID'
3012
+ | 'IE'
3013
+ | 'IL'
3014
+ | 'IM'
3015
+ | 'IN'
3016
+ | 'IO'
3017
+ | 'IQ'
3018
+ | 'IR'
3019
+ | 'IS'
3020
+ | 'IT'
3021
+ | 'JE'
3022
+ | 'JM'
3023
+ | 'JO'
3024
+ | 'JP'
3025
+ | 'KE'
3026
+ | 'KG'
3027
+ | 'KH'
3028
+ | 'KI'
3029
+ | 'KM'
3030
+ | 'KN'
3031
+ | 'KP'
3032
+ | 'KR'
3033
+ | 'KW'
3034
+ | 'KY'
3035
+ | 'KZ'
3036
+ | 'LA'
3037
+ | 'LB'
3038
+ | 'LC'
3039
+ | 'LI'
3040
+ | 'LK'
3041
+ | 'LR'
3042
+ | 'LS'
3043
+ | 'LT'
3044
+ | 'LU'
3045
+ | 'LV'
3046
+ | 'LY'
3047
+ | 'MA'
3048
+ | 'MC'
3049
+ | 'MD'
3050
+ | 'ME'
3051
+ | 'MF'
3052
+ | 'MG'
3053
+ | 'MH'
3054
+ | 'MK'
3055
+ | 'ML'
3056
+ | 'MM'
3057
+ | 'MN'
3058
+ | 'MO'
3059
+ | 'MP'
3060
+ | 'MQ'
3061
+ | 'MR'
3062
+ | 'MS'
3063
+ | 'MT'
3064
+ | 'MU'
3065
+ | 'MV'
3066
+ | 'MW'
3067
+ | 'MX'
3068
+ | 'MY'
3069
+ | 'MZ'
3070
+ | 'NA'
3071
+ | 'NC'
3072
+ | 'NE'
3073
+ | 'NF'
3074
+ | 'NG'
3075
+ | 'NI'
3076
+ | 'NL'
3077
+ | 'NO'
3078
+ | 'NP'
3079
+ | 'NR'
3080
+ | 'NU'
3081
+ | 'NZ'
3082
+ | 'OM'
3083
+ | 'PA'
3084
+ | 'PE'
3085
+ | 'PF'
3086
+ | 'PG'
3087
+ | 'PH'
3088
+ | 'PK'
3089
+ | 'PL'
3090
+ | 'PM'
3091
+ | 'PN'
3092
+ | 'PR'
3093
+ | 'PS'
3094
+ | 'PT'
3095
+ | 'PW'
3096
+ | 'PY'
3097
+ | 'QA'
3098
+ | 'RE'
3099
+ | 'RO'
3100
+ | 'RS'
3101
+ | 'RU'
3102
+ | 'RW'
3103
+ | 'SA'
3104
+ | 'SB'
3105
+ | 'SC'
3106
+ | 'SD'
3107
+ | 'SE'
3108
+ | 'SG'
3109
+ | 'SH'
3110
+ | 'SI'
3111
+ | 'SJ'
3112
+ | 'SK'
3113
+ | 'SL'
3114
+ | 'SM'
3115
+ | 'SN'
3116
+ | 'SO'
3117
+ | 'SR'
3118
+ | 'SS'
3119
+ | 'ST'
3120
+ | 'SV'
3121
+ | 'SX'
3122
+ | 'SY'
3123
+ | 'SZ'
3124
+ | 'TC'
3125
+ | 'TD'
3126
+ | 'TF'
3127
+ | 'TG'
3128
+ | 'TH'
3129
+ | 'TJ'
3130
+ | 'TK'
3131
+ | 'TL'
3132
+ | 'TM'
3133
+ | 'TN'
3134
+ | 'TO'
3135
+ | 'TR'
3136
+ | 'TT'
3137
+ | 'TV'
3138
+ | 'TW'
3139
+ | 'TZ'
3140
+ | 'UA'
3141
+ | 'UG'
3142
+ | 'UM'
3143
+ | 'US'
3144
+ | 'UY'
3145
+ | 'UZ'
3146
+ | 'VA'
3147
+ | 'VC'
3148
+ | 'VE'
3149
+ | 'VG'
3150
+ | 'VI'
3151
+ | 'VN'
3152
+ | 'VU'
3153
+ | 'WF'
3154
+ | 'WS'
3155
+ | 'XK'
3156
+ | 'YE'
3157
+ | 'YT'
3158
+ | 'ZA'
3159
+ | 'ZM'
3160
+ | 'ZW'
3161
+ | 'ALL';
3162
+
3163
+ /**
3164
+ * Device type for browser emulation
3165
+ */
3166
+ device?: 'desktop' | 'mobile' | 'tablet';
3167
+
3168
+ /**
3169
+ * Browser driver to use
3170
+ */
3171
+ driver?: 'vx6' | 'vx8' | 'vx8-pro' | 'vx10' | 'vx10-pro' | 'vx12' | 'vx12-pro';
3172
+
3173
+ /**
3174
+ * Expected HTTP status codes for successful requests
3175
+ */
3176
+ expected_status_codes?: Array<number>;
3177
+
3178
+ /**
3179
+ * List of acceptable response formats in order of preference
3180
+ */
3181
+ formats?: Array<'html' | 'markdown' | 'screenshot'>;
3182
+
3183
+ /**
3184
+ * Custom HTTP headers to include in the request
3185
+ */
3186
+ headers?: { [key: string]: string | Array<string> | null };
3187
+
3188
+ /**
3189
+ * Whether to use HTTP/2 protocol
3190
+ */
3191
+ http2?: boolean;
3192
+
3193
+ /**
3194
+ * Whether to emulate XMLHttpRequest behavior
3195
+ */
3196
+ is_xhr?: boolean;
3197
+
3198
+ /**
3199
+ * Locale for browser language and region settings
3200
+ */
3201
+ locale?:
3202
+ | 'aa-DJ'
3203
+ | 'aa-ER'
3204
+ | 'aa-ET'
3205
+ | 'af'
3206
+ | 'af-NA'
3207
+ | 'af-ZA'
3208
+ | 'ak'
3209
+ | 'ak-GH'
3210
+ | 'am'
3211
+ | 'am-ET'
3212
+ | 'an-ES'
3213
+ | 'ar'
3214
+ | 'ar-AE'
3215
+ | 'ar-BH'
3216
+ | 'ar-DZ'
3217
+ | 'ar-EG'
3218
+ | 'ar-IN'
3219
+ | 'ar-IQ'
3220
+ | 'ar-JO'
3221
+ | 'ar-KW'
3222
+ | 'ar-LB'
3223
+ | 'ar-LY'
3224
+ | 'ar-MA'
3225
+ | 'ar-OM'
3226
+ | 'ar-QA'
3227
+ | 'ar-SA'
3228
+ | 'ar-SD'
3229
+ | 'ar-SY'
3230
+ | 'ar-TN'
3231
+ | 'ar-YE'
3232
+ | 'as'
3233
+ | 'as-IN'
3234
+ | 'asa'
3235
+ | 'asa-TZ'
3236
+ | 'ast-ES'
3237
+ | 'az'
3238
+ | 'az-AZ'
3239
+ | 'az-Cyrl'
3240
+ | 'az-Cyrl-AZ'
3241
+ | 'az-Latn'
3242
+ | 'az-Latn-AZ'
3243
+ | 'be'
3244
+ | 'be-BY'
3245
+ | 'bem'
3246
+ | 'bem-ZM'
3247
+ | 'ber-DZ'
3248
+ | 'ber-MA'
3249
+ | 'bez'
3250
+ | 'bez-TZ'
3251
+ | 'bg'
3252
+ | 'bg-BG'
3253
+ | 'bho-IN'
3254
+ | 'bm'
3255
+ | 'bm-ML'
3256
+ | 'bn'
3257
+ | 'bn-BD'
3258
+ | 'bn-IN'
3259
+ | 'bo'
3260
+ | 'bo-CN'
3261
+ | 'bo-IN'
3262
+ | 'br-FR'
3263
+ | 'brx-IN'
3264
+ | 'bs'
3265
+ | 'bs-BA'
3266
+ | 'byn-ER'
3267
+ | 'ca'
3268
+ | 'ca-AD'
3269
+ | 'ca-ES'
3270
+ | 'ca-FR'
3271
+ | 'ca-IT'
3272
+ | 'cgg'
3273
+ | 'cgg-UG'
3274
+ | 'chr'
3275
+ | 'chr-US'
3276
+ | 'crh-UA'
3277
+ | 'cs'
3278
+ | 'cs-CZ'
3279
+ | 'csb-PL'
3280
+ | 'cv-RU'
3281
+ | 'cy'
3282
+ | 'cy-GB'
3283
+ | 'da'
3284
+ | 'da-DK'
3285
+ | 'dav'
3286
+ | 'dav-KE'
3287
+ | 'de'
3288
+ | 'de-AT'
3289
+ | 'de-BE'
3290
+ | 'de-CH'
3291
+ | 'de-DE'
3292
+ | 'de-LI'
3293
+ | 'de-LU'
3294
+ | 'dv-MV'
3295
+ | 'dz-BT'
3296
+ | 'ebu'
3297
+ | 'ebu-KE'
3298
+ | 'ee'
3299
+ | 'ee-GH'
3300
+ | 'ee-TG'
3301
+ | 'el'
3302
+ | 'el-CY'
3303
+ | 'el-GR'
3304
+ | 'en'
3305
+ | 'en-AG'
3306
+ | 'en-AS'
3307
+ | 'en-AU'
3308
+ | 'en-BE'
3309
+ | 'en-BW'
3310
+ | 'en-BZ'
3311
+ | 'en-CA'
3312
+ | 'en-DK'
3313
+ | 'en-GB'
3314
+ | 'en-GU'
3315
+ | 'en-HK'
3316
+ | 'en-IE'
3317
+ | 'en-IN'
3318
+ | 'en-JM'
3319
+ | 'en-MH'
3320
+ | 'en-MP'
3321
+ | 'en-MT'
3322
+ | 'en-MU'
3323
+ | 'en-NA'
3324
+ | 'en-NG'
3325
+ | 'en-NZ'
3326
+ | 'en-PH'
3327
+ | 'en-PK'
3328
+ | 'en-SG'
3329
+ | 'en-TT'
3330
+ | 'en-UM'
3331
+ | 'en-US'
3332
+ | 'en-VI'
3333
+ | 'en-ZA'
3334
+ | 'en-ZM'
3335
+ | 'en-ZW'
3336
+ | 'eo'
3337
+ | 'es'
3338
+ | 'es-419'
3339
+ | 'es-AR'
3340
+ | 'es-BO'
3341
+ | 'es-CL'
3342
+ | 'es-CO'
3343
+ | 'es-CR'
3344
+ | 'es-CU'
3345
+ | 'es-DO'
3346
+ | 'es-EC'
3347
+ | 'es-ES'
3348
+ | 'es-GQ'
3349
+ | 'es-GT'
3350
+ | 'es-HN'
3351
+ | 'es-MX'
3352
+ | 'es-NI'
3353
+ | 'es-PA'
3354
+ | 'es-PE'
3355
+ | 'es-PR'
3356
+ | 'es-PY'
3357
+ | 'es-SV'
3358
+ | 'es-US'
3359
+ | 'es-UY'
3360
+ | 'es-VE'
3361
+ | 'et'
3362
+ | 'et-EE'
3363
+ | 'eu'
3364
+ | 'eu-ES'
3365
+ | 'fa'
3366
+ | 'fa-AF'
3367
+ | 'fa-IR'
3368
+ | 'ff'
3369
+ | 'ff-SN'
3370
+ | 'fi'
3371
+ | 'fi-FI'
3372
+ | 'fil'
3373
+ | 'fil-PH'
3374
+ | 'fo'
3375
+ | 'fo-FO'
3376
+ | 'fr'
3377
+ | 'fr-BE'
3378
+ | 'fr-BF'
3379
+ | 'fr-BI'
3380
+ | 'fr-BJ'
3381
+ | 'fr-BL'
3382
+ | 'fr-CA'
3383
+ | 'fr-CD'
3384
+ | 'fr-CF'
3385
+ | 'fr-CG'
3386
+ | 'fr-CH'
3387
+ | 'fr-CI'
3388
+ | 'fr-CM'
3389
+ | 'fr-DJ'
3390
+ | 'fr-FR'
3391
+ | 'fr-GA'
3392
+ | 'fr-GN'
3393
+ | 'fr-GP'
3394
+ | 'fr-GQ'
3395
+ | 'fr-KM'
3396
+ | 'fr-LU'
3397
+ | 'fr-MC'
3398
+ | 'fr-MF'
3399
+ | 'fr-MG'
3400
+ | 'fr-ML'
3401
+ | 'fr-MQ'
3402
+ | 'fr-NE'
3403
+ | 'fr-RE'
3404
+ | 'fr-RW'
3405
+ | 'fr-SN'
3406
+ | 'fr-TD'
3407
+ | 'fr-TG'
3408
+ | 'fur-IT'
3409
+ | 'fy-DE'
3410
+ | 'fy-NL'
3411
+ | 'ga'
3412
+ | 'ga-IE'
3413
+ | 'gd-GB'
3414
+ | 'gez-ER'
3415
+ | 'gez-ET'
3416
+ | 'gl'
3417
+ | 'gl-ES'
3418
+ | 'gsw'
3419
+ | 'gsw-CH'
3420
+ | 'gu'
3421
+ | 'gu-IN'
3422
+ | 'guz'
3423
+ | 'guz-KE'
3424
+ | 'gv'
3425
+ | 'gv-GB'
3426
+ | 'ha'
3427
+ | 'ha-Latn'
3428
+ | 'ha-Latn-GH'
3429
+ | 'ha-Latn-NE'
3430
+ | 'ha-Latn-NG'
3431
+ | 'ha-NG'
3432
+ | 'haw'
3433
+ | 'haw-US'
3434
+ | 'he'
3435
+ | 'he-IL'
3436
+ | 'hi'
3437
+ | 'hi-IN'
3438
+ | 'hne-IN'
3439
+ | 'hr'
3440
+ | 'hr-HR'
3441
+ | 'hsb-DE'
3442
+ | 'ht-HT'
3443
+ | 'hu'
3444
+ | 'hu-HU'
3445
+ | 'hy'
3446
+ | 'hy-AM'
3447
+ | 'id'
3448
+ | 'id-ID'
3449
+ | 'ig'
3450
+ | 'ig-NG'
3451
+ | 'ii'
3452
+ | 'ii-CN'
3453
+ | 'ik-CA'
3454
+ | 'is'
3455
+ | 'is-IS'
3456
+ | 'it'
3457
+ | 'it-CH'
3458
+ | 'it-IT'
3459
+ | 'iu-CA'
3460
+ | 'iw-IL'
3461
+ | 'ja'
3462
+ | 'ja-JP'
3463
+ | 'jmc'
3464
+ | 'jmc-TZ'
3465
+ | 'ka'
3466
+ | 'ka-GE'
3467
+ | 'kab'
3468
+ | 'kab-DZ'
3469
+ | 'kam'
3470
+ | 'kam-KE'
3471
+ | 'kde'
3472
+ | 'kde-TZ'
3473
+ | 'kea'
3474
+ | 'kea-CV'
3475
+ | 'khq'
3476
+ | 'khq-ML'
3477
+ | 'ki'
3478
+ | 'ki-KE'
3479
+ | 'kk'
3480
+ | 'kk-Cyrl'
3481
+ | 'kk-Cyrl-KZ'
3482
+ | 'kk-KZ'
3483
+ | 'kl'
3484
+ | 'kl-GL'
3485
+ | 'kln'
3486
+ | 'kln-KE'
3487
+ | 'km'
3488
+ | 'km-KH'
3489
+ | 'kn'
3490
+ | 'kn-IN'
3491
+ | 'ko'
3492
+ | 'ko-KR'
3493
+ | 'kok'
3494
+ | 'kok-IN'
3495
+ | 'ks-IN'
3496
+ | 'ku-TR'
3497
+ | 'kw'
3498
+ | 'kw-GB'
3499
+ | 'ky-KG'
3500
+ | 'lag'
3501
+ | 'lag-TZ'
3502
+ | 'lb-LU'
3503
+ | 'lg'
3504
+ | 'lg-UG'
3505
+ | 'li-BE'
3506
+ | 'li-NL'
3507
+ | 'lij-IT'
3508
+ | 'lo-LA'
3509
+ | 'lt'
3510
+ | 'lt-LT'
3511
+ | 'luo'
3512
+ | 'luo-KE'
3513
+ | 'luy'
3514
+ | 'luy-KE'
3515
+ | 'lv'
3516
+ | 'lv-LV'
3517
+ | 'mag-IN'
3518
+ | 'mai-IN'
3519
+ | 'mas'
3520
+ | 'mas-KE'
3521
+ | 'mas-TZ'
3522
+ | 'mer'
3523
+ | 'mer-KE'
3524
+ | 'mfe'
3525
+ | 'mfe-MU'
3526
+ | 'mg'
3527
+ | 'mg-MG'
3528
+ | 'mhr-RU'
3529
+ | 'mi-NZ'
3530
+ | 'mk'
3531
+ | 'mk-MK'
3532
+ | 'ml'
3533
+ | 'ml-IN'
3534
+ | 'mn-MN'
3535
+ | 'mr'
3536
+ | 'mr-IN'
3537
+ | 'ms'
3538
+ | 'ms-BN'
3539
+ | 'ms-MY'
3540
+ | 'mt'
3541
+ | 'mt-MT'
3542
+ | 'my'
3543
+ | 'my-MM'
3544
+ | 'nan-TW'
3545
+ | 'naq'
3546
+ | 'naq-NA'
3547
+ | 'nb'
3548
+ | 'nb-NO'
3549
+ | 'nd'
3550
+ | 'nd-ZW'
3551
+ | 'nds-DE'
3552
+ | 'nds-NL'
3553
+ | 'ne'
3554
+ | 'ne-IN'
3555
+ | 'ne-NP'
3556
+ | 'nl'
3557
+ | 'nl-AW'
3558
+ | 'nl-BE'
3559
+ | 'nl-NL'
3560
+ | 'nn'
3561
+ | 'nn-NO'
3562
+ | 'nr-ZA'
3563
+ | 'nso-ZA'
3564
+ | 'nyn'
3565
+ | 'nyn-UG'
3566
+ | 'oc-FR'
3567
+ | 'om'
3568
+ | 'om-ET'
3569
+ | 'om-KE'
3570
+ | 'or'
3571
+ | 'or-IN'
3572
+ | 'os-RU'
3573
+ | 'pa'
3574
+ | 'pa-Arab'
3575
+ | 'pa-Arab-PK'
3576
+ | 'pa-Guru'
3577
+ | 'pa-Guru-IN'
3578
+ | 'pa-IN'
3579
+ | 'pa-PK'
3580
+ | 'pap-AN'
3581
+ | 'pl'
3582
+ | 'pl-PL'
3583
+ | 'ps'
3584
+ | 'ps-AF'
3585
+ | 'pt'
3586
+ | 'pt-BR'
3587
+ | 'pt-GW'
3588
+ | 'pt-MZ'
3589
+ | 'pt-PT'
3590
+ | 'rm'
3591
+ | 'rm-CH'
3592
+ | 'ro'
3593
+ | 'ro-MD'
3594
+ | 'ro-RO'
3595
+ | 'rof'
3596
+ | 'rof-TZ'
3597
+ | 'ru'
3598
+ | 'ru-MD'
3599
+ | 'ru-RU'
3600
+ | 'ru-UA'
3601
+ | 'rw'
3602
+ | 'rw-RW'
3603
+ | 'rwk'
3604
+ | 'rwk-TZ'
3605
+ | 'sa-IN'
3606
+ | 'saq'
3607
+ | 'saq-KE'
3608
+ | 'sc-IT'
3609
+ | 'sd-IN'
3610
+ | 'se-NO'
3611
+ | 'seh'
3612
+ | 'seh-MZ'
3613
+ | 'ses'
3614
+ | 'ses-ML'
3615
+ | 'sg'
3616
+ | 'sg-CF'
3617
+ | 'shi'
3618
+ | 'shi-Latn'
3619
+ | 'shi-Latn-MA'
3620
+ | 'shi-Tfng'
3621
+ | 'shi-Tfng-MA'
3622
+ | 'shs-CA'
3623
+ | 'si'
3624
+ | 'si-LK'
3625
+ | 'sid-ET'
3626
+ | 'sk'
3627
+ | 'sk-SK'
3628
+ | 'sl'
3629
+ | 'sl-SI'
3630
+ | 'sn'
3631
+ | 'sn-ZW'
3632
+ | 'so'
3633
+ | 'so-DJ'
3634
+ | 'so-ET'
3635
+ | 'so-KE'
3636
+ | 'so-SO'
3637
+ | 'sq'
3638
+ | 'sq-AL'
3639
+ | 'sq-MK'
3640
+ | 'sr'
3641
+ | 'sr-Cyrl'
3642
+ | 'sr-Cyrl-BA'
3643
+ | 'sr-Cyrl-ME'
3644
+ | 'sr-Cyrl-RS'
3645
+ | 'sr-Latn'
3646
+ | 'sr-Latn-BA'
3647
+ | 'sr-Latn-ME'
3648
+ | 'sr-Latn-RS'
3649
+ | 'sr-ME'
3650
+ | 'sr-RS'
3651
+ | 'ss-ZA'
3652
+ | 'st-ZA'
3653
+ | 'sv'
3654
+ | 'sv-FI'
3655
+ | 'sv-SE'
3656
+ | 'sw'
3657
+ | 'sw-KE'
3658
+ | 'sw-TZ'
3659
+ | 'ta'
3660
+ | 'ta-IN'
3661
+ | 'ta-LK'
3662
+ | 'te'
3663
+ | 'te-IN'
3664
+ | 'teo'
3665
+ | 'teo-KE'
3666
+ | 'teo-UG'
3667
+ | 'tg-TJ'
3668
+ | 'th'
3669
+ | 'th-TH'
3670
+ | 'ti'
3671
+ | 'ti-ER'
3672
+ | 'ti-ET'
3673
+ | 'tig-ER'
3674
+ | 'tk-TM'
3675
+ | 'tl-PH'
3676
+ | 'tn-ZA'
3677
+ | 'to'
3678
+ | 'to-TO'
3679
+ | 'tr'
3680
+ | 'tr-CY'
3681
+ | 'tr-TR'
3682
+ | 'ts-ZA'
3683
+ | 'tt-RU'
3684
+ | 'tzm'
3685
+ | 'tzm-Latn'
3686
+ | 'tzm-Latn-MA'
3687
+ | 'ug-CN'
3688
+ | 'uk'
3689
+ | 'uk-UA'
3690
+ | 'unm-US'
3691
+ | 'ur'
3692
+ | 'ur-IN'
3693
+ | 'ur-PK'
3694
+ | 'uz'
3695
+ | 'uz-Arab'
3696
+ | 'uz-Arab-AF'
3697
+ | 'uz-Cyrl'
3698
+ | 'uz-Cyrl-UZ'
3699
+ | 'uz-Latn'
3700
+ | 'uz-Latn-UZ'
3701
+ | 'uz-UZ'
3702
+ | 've-ZA'
3703
+ | 'vi'
3704
+ | 'vi-VN'
3705
+ | 'vun'
3706
+ | 'vun-TZ'
3707
+ | 'wa-BE'
3708
+ | 'wae-CH'
3709
+ | 'wal-ET'
3710
+ | 'wo-SN'
3711
+ | 'xh-ZA'
3712
+ | 'xog'
3713
+ | 'xog-UG'
3714
+ | 'yi-US'
3715
+ | 'yo'
3716
+ | 'yo-NG'
3717
+ | 'yue-HK'
3718
+ | 'zh'
3719
+ | 'zh-CN'
3720
+ | 'zh-HK'
3721
+ | 'zh-Hans'
3722
+ | 'zh-Hans-CN'
3723
+ | 'zh-Hans-HK'
3724
+ | 'zh-Hans-MO'
3725
+ | 'zh-Hans-SG'
3726
+ | 'zh-Hant'
3727
+ | 'zh-Hant-HK'
3728
+ | 'zh-Hant-MO'
3729
+ | 'zh-Hant-TW'
3730
+ | 'zh-SG'
3731
+ | 'zh-TW'
3732
+ | 'zu'
3733
+ | 'zu-ZA'
3734
+ | 'auto';
3735
+
3736
+ /**
3737
+ * HTTP method for the request
3738
+ */
3739
+ method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
3740
+
3741
+ /**
3742
+ * Filters for capturing network traffic
3743
+ */
3744
+ network_capture?: Array<Param.NetworkCapture>;
3745
+
3746
+ /**
3747
+ * Operating system to emulate
3748
+ */
3749
+ os?: 'windows' | 'mac os' | 'linux' | 'android' | 'ios';
3750
+
3751
+ /**
3752
+ * Whether to parse the response content
3753
+ */
3754
+ parse?: boolean;
3755
+
3756
+ /**
3757
+ * Custom parser configuration as a key-value map
3758
+ */
3759
+ parser?: { [key: string]: unknown } | string;
3760
+
3761
+ /**
3762
+ * Referrer policy for the request
3763
+ */
3764
+ referrer_type?:
3765
+ | 'random'
3766
+ | 'no-referer'
3767
+ | 'same-origin'
3768
+ | 'google'
3769
+ | 'bing'
3770
+ | 'facebook'
3771
+ | 'twitter'
3772
+ | 'instagram';
3773
+
3774
+ /**
3775
+ * Whether to render JavaScript content using a browser
3776
+ */
3777
+ render?: boolean;
3778
+
3779
+ /**
3780
+ * Request timeout in milliseconds
3781
+ */
3782
+ request_timeout?: number;
3783
+
3784
+ session?: Param.Session;
3785
+
3786
+ /**
3787
+ * Skills or capabilities required for the request
3788
+ */
3789
+ skill?: string | Array<string>;
3790
+
3791
+ /**
3792
+ * US state for geolocation (only valid when country is US)
3793
+ */
3794
+ state?:
3795
+ | 'AL'
3796
+ | 'AK'
3797
+ | 'AS'
3798
+ | 'AZ'
3799
+ | 'AR'
3800
+ | 'CA'
3801
+ | 'CO'
3802
+ | 'CT'
3803
+ | 'DE'
3804
+ | 'DC'
3805
+ | 'FL'
3806
+ | 'GA'
3807
+ | 'GU'
3808
+ | 'HI'
3809
+ | 'ID'
3810
+ | 'IL'
3811
+ | 'IN'
3812
+ | 'IA'
3813
+ | 'KS'
3814
+ | 'KY'
3815
+ | 'LA'
3816
+ | 'ME'
3817
+ | 'MD'
3818
+ | 'MA'
3819
+ | 'MI'
3820
+ | 'MN'
3821
+ | 'MS'
3822
+ | 'MO'
3823
+ | 'MT'
3824
+ | 'NE'
3825
+ | 'NV'
3826
+ | 'NH'
3827
+ | 'NJ'
3828
+ | 'NM'
3829
+ | 'NY'
3830
+ | 'NC'
3831
+ | 'ND'
3832
+ | 'MP'
3833
+ | 'OH'
3834
+ | 'OK'
3835
+ | 'OR'
3836
+ | 'PA'
3837
+ | 'PR'
3838
+ | 'RI'
3839
+ | 'SC'
3840
+ | 'SD'
3841
+ | 'TN'
3842
+ | 'TX'
3843
+ | 'UT'
3844
+ | 'VT'
3845
+ | 'VA'
3846
+ | 'VI'
3847
+ | 'WA'
3848
+ | 'WV'
3849
+ | 'WI'
3850
+ | 'WY';
3851
+
3852
+ /**
3853
+ * User-defined tag for request identification
3854
+ */
3855
+ tag?: string;
3856
+ }
3857
+
3858
+ export namespace Param {
3859
+ export interface UnionMember1 {
3860
+ name: 'chrome' | 'firefox';
3861
+
3862
+ /**
3863
+ * Specific browser version to emulate
3864
+ */
3865
+ version?: string;
3866
+ }
3867
+
3868
+ export interface UnionMember0 {
3869
+ creation?: string | null;
3870
+
3871
+ domain?: string | null;
3872
+
3873
+ expires?: string;
3874
+
3875
+ extensions?: Array<string> | null;
3876
+
3877
+ hostOnly?: boolean | null;
3878
+
3879
+ httpOnly?: boolean | null;
3880
+
3881
+ lastAccessed?: string | null;
3882
+
3883
+ maxAge?: 'Infinity' | '-Infinity' | number | null;
3884
+
3885
+ name?: string;
3886
+
3887
+ path?: string | null;
3888
+
3889
+ pathIsDefault?: boolean | null;
3890
+
3891
+ sameSite?: 'strict' | 'lax' | 'none';
3892
+
3893
+ secure?: boolean;
3894
+
3895
+ value?: string;
3896
+
3897
+ [k: string]: unknown;
3898
+ }
3899
+
3900
+ export interface NetworkCapture {
3901
+ method?: 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE' | 'PATCH';
3902
+
3903
+ /**
3904
+ * Resource type for network capture filtering
3905
+ */
3906
+ resource_type?: string | Array<string>;
3907
+
3908
+ status_code?: number | Array<number>;
3909
+
3910
+ url?: NetworkCapture.URL;
3911
+
3912
+ validation?: boolean;
3913
+
3914
+ wait_for_requests_count?: number;
3915
+
3916
+ wait_for_requests_count_timeout?: number;
3917
+ }
3918
+
3919
+ export namespace NetworkCapture {
3920
+ export interface URL {
3921
+ value: string;
3922
+
3923
+ type?: 'exact' | 'contains';
3924
+ }
3925
+ }
3926
+
3927
+ export interface Session {
3928
+ id?: string;
3929
+
3930
+ prefetch_userbrowser?: boolean;
3931
+
3932
+ retry?: boolean;
3933
+
3934
+ timeout?: number;
3935
+ }
3936
+ }
3937
+
3938
+ /**
3939
+ * Shared parameters applied to the entire batch, such as storage and callback
3940
+ * configuration.
3941
+ */
3942
+ export interface SharedParams {
3943
+ /**
3944
+ * URL to call back when async operation completes
3945
+ */
3946
+ callback_url?: string;
3947
+
3948
+ /**
3949
+ * Whether to compress stored data
3950
+ */
3951
+ storage_compress?: boolean;
3952
+
3953
+ /**
3954
+ * Custom name for the stored object
3955
+ */
3956
+ storage_object_name?: string;
3957
+
3958
+ /**
3959
+ * Type of storage to use for results
3960
+ */
3961
+ storage_type?: string;
3962
+
3963
+ /**
3964
+ * URL for storage location
3965
+ */
3966
+ storage_url?: string;
3967
+ }
3968
+ }
3969
+
2754
3970
  export interface MapParams {
2755
3971
  /**
2756
3972
  * Url to map.
@@ -3662,10 +4878,12 @@ export declare namespace TopLevel {
3662
4878
  export {
3663
4879
  type ExtractResponse as ExtractResponse,
3664
4880
  type ExtractAsyncResponse as ExtractAsyncResponse,
4881
+ type ExtractBatchResponse as ExtractBatchResponse,
3665
4882
  type MapResponse as MapResponse,
3666
4883
  type SearchResponse as SearchResponse,
3667
4884
  type ExtractParams as ExtractParams,
3668
4885
  type ExtractAsyncParams as ExtractAsyncParams,
4886
+ type ExtractBatchParams as ExtractBatchParams,
3669
4887
  type MapParams as MapParams,
3670
4888
  type SearchParams as SearchParams,
3671
4889
  };