@pipe0/client 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -104,6 +104,19 @@ interface paths {
104
104
  detail: string;
105
105
  };
106
106
  };
107
+ }; /** @description Queued-record hard limit reached (or the request-rate bucket was exceeded) */
108
+ 429: {
109
+ headers: {
110
+ [name: string]: unknown;
111
+ };
112
+ content: {
113
+ "application/json": {
114
+ type: string;
115
+ title: string;
116
+ status: number;
117
+ detail: string;
118
+ };
119
+ };
107
120
  };
108
121
  };
109
122
  };
@@ -200,6 +213,19 @@ interface paths {
200
213
  detail: string;
201
214
  };
202
215
  };
216
+ }; /** @description Queued-record hard limit reached (or the request-rate bucket was exceeded) */
217
+ 429: {
218
+ headers: {
219
+ [name: string]: unknown;
220
+ };
221
+ content: {
222
+ "application/json": {
223
+ type: string;
224
+ title: string;
225
+ status: number;
226
+ detail: string;
227
+ };
228
+ };
203
229
  };
204
230
  };
205
231
  };
@@ -297,6 +323,107 @@ interface paths {
297
323
  patch?: never;
298
324
  trace?: never;
299
325
  };
326
+ "/v1/pipes/cancel/{run_id}": {
327
+ parameters: {
328
+ query?: never;
329
+ header?: never;
330
+ path?: never;
331
+ cookie?: never;
332
+ };
333
+ get?: never;
334
+ put?: never; /** @description Cancel an enrichment run that is still queued (status 'pending'). Canceling returns the run's records to your capacity immediately (see the X-P1/P2/P3-Capacity headers), which can restore a better task priority for subsequent submissions. Runs that are already processing, finished, or created by sheets cannot be canceled. */
335
+ post: {
336
+ parameters: {
337
+ query?: never;
338
+ header?: never;
339
+ path: {
340
+ run_id: string | null;
341
+ };
342
+ cookie?: never;
343
+ };
344
+ requestBody?: never;
345
+ responses: {
346
+ /** @description The canceled run */200: {
347
+ headers: {
348
+ [name: string]: unknown;
349
+ };
350
+ content: {
351
+ "application/json": components["schemas"]["PipesResponseSchema"];
352
+ };
353
+ }; /** @description Bad request */
354
+ 400: {
355
+ headers: {
356
+ [name: string]: unknown;
357
+ };
358
+ content: {
359
+ "application/json": {
360
+ type: string;
361
+ title: string;
362
+ status: number;
363
+ detail: string;
364
+ };
365
+ };
366
+ }; /** @description Unauthorized */
367
+ 401: {
368
+ headers: {
369
+ [name: string]: unknown;
370
+ };
371
+ content: {
372
+ "application/json": {
373
+ type: string;
374
+ title: string;
375
+ status: number;
376
+ detail: string;
377
+ };
378
+ };
379
+ }; /** @description Forbidden */
380
+ 403: {
381
+ headers: {
382
+ [name: string]: unknown;
383
+ };
384
+ content: {
385
+ "application/json": {
386
+ type: string;
387
+ title: string;
388
+ status: number;
389
+ detail: string;
390
+ };
391
+ };
392
+ }; /** @description Not found */
393
+ 404: {
394
+ headers: {
395
+ [name: string]: unknown;
396
+ };
397
+ content: {
398
+ "application/json": {
399
+ type: string;
400
+ title: string;
401
+ status: number;
402
+ detail: string;
403
+ };
404
+ };
405
+ }; /** @description Run is no longer pending */
406
+ 409: {
407
+ headers: {
408
+ [name: string]: unknown;
409
+ };
410
+ content: {
411
+ "application/json": {
412
+ type: string;
413
+ title: string;
414
+ status: number;
415
+ detail: string;
416
+ };
417
+ };
418
+ };
419
+ };
420
+ };
421
+ delete?: never;
422
+ options?: never;
423
+ head?: never;
424
+ patch?: never;
425
+ trace?: never;
426
+ };
300
427
  "/v1/pipes/validate": {
301
428
  parameters: {
302
429
  query?: never;
@@ -992,6 +1119,107 @@ interface paths {
992
1119
  patch?: never;
993
1120
  trace?: never;
994
1121
  };
1122
+ "/v1/search/cancel/{run_id}": {
1123
+ parameters: {
1124
+ query?: never;
1125
+ header?: never;
1126
+ path?: never;
1127
+ cookie?: never;
1128
+ };
1129
+ get?: never;
1130
+ put?: never; /** @description Cancel a search run that is still queued (status 'pending'). Canceling returns the run to your capacity immediately (see the X-P1/P2/P3-Capacity headers). Runs that are already processing or finished cannot be canceled. */
1131
+ post: {
1132
+ parameters: {
1133
+ query?: never;
1134
+ header?: never;
1135
+ path: {
1136
+ run_id: string | null;
1137
+ };
1138
+ cookie?: never;
1139
+ };
1140
+ requestBody?: never;
1141
+ responses: {
1142
+ /** @description The canceled run */200: {
1143
+ headers: {
1144
+ [name: string]: unknown;
1145
+ };
1146
+ content: {
1147
+ "application/json": components["schemas"]["SearchResponseSchema"];
1148
+ };
1149
+ }; /** @description Bad request */
1150
+ 400: {
1151
+ headers: {
1152
+ [name: string]: unknown;
1153
+ };
1154
+ content: {
1155
+ "application/json": {
1156
+ type: string;
1157
+ title: string;
1158
+ status: number;
1159
+ detail: string;
1160
+ };
1161
+ };
1162
+ }; /** @description Unauthorized */
1163
+ 401: {
1164
+ headers: {
1165
+ [name: string]: unknown;
1166
+ };
1167
+ content: {
1168
+ "application/json": {
1169
+ type: string;
1170
+ title: string;
1171
+ status: number;
1172
+ detail: string;
1173
+ };
1174
+ };
1175
+ }; /** @description Forbidden */
1176
+ 403: {
1177
+ headers: {
1178
+ [name: string]: unknown;
1179
+ };
1180
+ content: {
1181
+ "application/json": {
1182
+ type: string;
1183
+ title: string;
1184
+ status: number;
1185
+ detail: string;
1186
+ };
1187
+ };
1188
+ }; /** @description Not found */
1189
+ 404: {
1190
+ headers: {
1191
+ [name: string]: unknown;
1192
+ };
1193
+ content: {
1194
+ "application/json": {
1195
+ type: string;
1196
+ title: string;
1197
+ status: number;
1198
+ detail: string;
1199
+ };
1200
+ };
1201
+ }; /** @description Run is no longer pending */
1202
+ 409: {
1203
+ headers: {
1204
+ [name: string]: unknown;
1205
+ };
1206
+ content: {
1207
+ "application/json": {
1208
+ type: string;
1209
+ title: string;
1210
+ status: number;
1211
+ detail: string;
1212
+ };
1213
+ };
1214
+ };
1215
+ };
1216
+ };
1217
+ delete?: never;
1218
+ options?: never;
1219
+ head?: never;
1220
+ patch?: never;
1221
+ trace?: never;
1222
+ };
995
1223
  "/v1/search/run/sync": {
996
1224
  parameters: {
997
1225
  query?: never;
@@ -1086,6 +1314,19 @@ interface paths {
1086
1314
  detail: string;
1087
1315
  };
1088
1316
  };
1317
+ }; /** @description Queued-record hard limit reached (or the request-rate bucket was exceeded) */
1318
+ 429: {
1319
+ headers: {
1320
+ [name: string]: unknown;
1321
+ };
1322
+ content: {
1323
+ "application/json": {
1324
+ type: string;
1325
+ title: string;
1326
+ status: number;
1327
+ detail: string;
1328
+ };
1329
+ };
1089
1330
  };
1090
1331
  };
1091
1332
  };
@@ -1176,6 +1417,19 @@ interface paths {
1176
1417
  detail: string;
1177
1418
  };
1178
1419
  };
1420
+ }; /** @description Queued-record hard limit reached (or the request-rate bucket was exceeded) */
1421
+ 429: {
1422
+ headers: {
1423
+ [name: string]: unknown;
1424
+ };
1425
+ content: {
1426
+ "application/json": {
1427
+ type: string;
1428
+ title: string;
1429
+ status: number;
1430
+ detail: string;
1431
+ };
1432
+ };
1179
1433
  };
1180
1434
  };
1181
1435
  };
@@ -2613,7 +2867,8 @@ interface paths {
2613
2867
  team_id: string | null;
2614
2868
  user_id: string | null;
2615
2869
  scopes: string[];
2616
- value: string;
2870
+ value: string; /** @enum {string} */
2871
+ format: "value" | "text";
2617
2872
  created_by: string; /** Format: date */
2618
2873
  last_used_at: string | null; /** Format: date */
2619
2874
  created_at: string; /** Format: date */
@@ -2650,7 +2905,7 @@ interface paths {
2650
2905
  };
2651
2906
  };
2652
2907
  };
2653
- put?: never; /** @description Create a new constant. Constants are plaintext config values referenced from pipe templates as `{{ CONSTANTS.<label> }}`. */
2908
+ put?: never; /** @description Create a new constant. Constants are plaintext config values referenced from pipe templates as `{{ CONSTANTS.<label> }}`. Use `format: "text"` for multi-line values such as a company description or writing instructions; `format` is inferred from the value when omitted. */
2654
2909
  post: {
2655
2910
  parameters: {
2656
2911
  query?: never;
@@ -2665,6 +2920,11 @@ interface paths {
2665
2920
  "application/json": {
2666
2921
  label: string;
2667
2922
  value: string;
2923
+ /**
2924
+ * @description How the value is authored. `value` (default) is a single line — newlines are rejected. `text` is multi-line prose (company descriptions, writing instructions) and renders as a textarea in the dashboard. Omit on create to infer from the value.
2925
+ * @enum {string}
2926
+ */
2927
+ format?: "value" | "text";
2668
2928
  description?: string | null;
2669
2929
  provider_hint?: string | null; /** @enum {string} */
2670
2930
  ownership_level: "organization" | "team" | "user";
@@ -2691,7 +2951,8 @@ interface paths {
2691
2951
  team_id: string | null;
2692
2952
  user_id: string | null;
2693
2953
  scopes: string[];
2694
- value: string;
2954
+ value: string; /** @enum {string} */
2955
+ format: "value" | "text";
2695
2956
  created_by: string; /** Format: date */
2696
2957
  last_used_at: string | null; /** Format: date */
2697
2958
  created_at: string; /** Format: date */
@@ -2794,7 +3055,8 @@ interface paths {
2794
3055
  team_id: string | null;
2795
3056
  user_id: string | null;
2796
3057
  scopes: string[];
2797
- value: string;
3058
+ value: string; /** @enum {string} */
3059
+ format: "value" | "text";
2798
3060
  created_by: string; /** Format: date */
2799
3061
  last_used_at: string | null; /** Format: date */
2800
3062
  created_at: string; /** Format: date */
@@ -2905,7 +3167,7 @@ interface paths {
2905
3167
  };
2906
3168
  };
2907
3169
  options?: never;
2908
- head?: never; /** @description Update a constant's metadata and/or value. Constants aren't credentials so value edits flow through the same PATCH path as label/description/scope edits. */
3170
+ head?: never; /** @description Update a constant's metadata, value, and/or format. Constants aren't credentials so value edits flow through the same PATCH path as label/description/scope edits. Narrowing `format` to `value` on a multi-line constant is rejected unless a single-line value is supplied in the same request. */
2909
3171
  patch: {
2910
3172
  parameters: {
2911
3173
  query?: never;
@@ -2921,6 +3183,11 @@ interface paths {
2921
3183
  "application/json": {
2922
3184
  label?: string;
2923
3185
  value?: string;
3186
+ /**
3187
+ * @description How the value is authored. `value` (default) is a single line — newlines are rejected. `text` is multi-line prose (company descriptions, writing instructions) and renders as a textarea in the dashboard. Omit on create to infer from the value.
3188
+ * @enum {string}
3189
+ */
3190
+ format?: "value" | "text";
2924
3191
  description?: string | null;
2925
3192
  provider_hint?: string | null;
2926
3193
  scopes?: string[];
@@ -2944,7 +3211,8 @@ interface paths {
2944
3211
  team_id: string | null;
2945
3212
  user_id: string | null;
2946
3213
  scopes: string[];
2947
- value: string;
3214
+ value: string; /** @enum {string} */
3215
+ format: "value" | "text";
2948
3216
  created_by: string; /** Format: date */
2949
3217
  last_used_at: string | null; /** Format: date */
2950
3218
  created_at: string; /** Format: date */
@@ -3305,7 +3573,7 @@ interface components {
3305
3573
  };
3306
3574
  };
3307
3575
  }; /** @enum {string} */
3308
- status: "completed" | "failed" | "pending" | "processing";
3576
+ status: "completed" | "failed" | "pending" | "processing" | "canceled";
3309
3577
  };
3310
3578
  /**
3311
3579
  * @default {
@@ -4698,9 +4966,6 @@ interface components {
4698
4966
  * },
4699
4967
  * {
4700
4968
  * "provider": "hunter"
4701
- * },
4702
- * {
4703
- * "provider": "findymail"
4704
4969
  * }
4705
4970
  * ]
4706
4971
  */
@@ -4857,9 +5122,6 @@ interface components {
4857
5122
  * },
4858
5123
  * {
4859
5124
  * "provider": "hunter"
4860
- * },
4861
- * {
4862
- * "provider": "findymail"
4863
5125
  * }
4864
5126
  * ]
4865
5127
  */
@@ -8712,9 +8974,6 @@ interface components {
8712
8974
  /**
8713
8975
  * @default [
8714
8976
  * {
8715
- * "provider": "findymail"
8716
- * },
8717
- * {
8718
8977
  * "provider": "hunter"
8719
8978
  * },
8720
8979
  * {
@@ -8915,9 +9174,6 @@ interface components {
8915
9174
  /**
8916
9175
  * @default [
8917
9176
  * {
8918
- * "provider": "findymail"
8919
- * },
8920
- * {
8921
9177
  * "provider": "hunter"
8922
9178
  * },
8923
9179
  * {
@@ -14971,9 +15227,6 @@ interface components {
14971
15227
  * },
14972
15228
  * {
14973
15229
  * "provider": "amplemarket"
14974
- * },
14975
- * {
14976
- * "provider": "findymail"
14977
15230
  * }
14978
15231
  * ]
14979
15232
  */
@@ -15085,9 +15338,6 @@ interface components {
15085
15338
  * },
15086
15339
  * {
15087
15340
  * "provider": "crustdata"
15088
- * },
15089
- * {
15090
- * "provider": "findymail"
15091
15341
  * }
15092
15342
  * ]
15093
15343
  */
@@ -16692,9 +16942,6 @@ interface components {
16692
16942
  * "provider": "leadmagic"
16693
16943
  * },
16694
16944
  * {
16695
- * "provider": "findymail"
16696
- * },
16697
- * {
16698
16945
  * "provider": "crustdata"
16699
16946
  * }
16700
16947
  * ]
@@ -16827,9 +17074,6 @@ interface components {
16827
17074
  * "provider": "leadmagic"
16828
17075
  * },
16829
17076
  * {
16830
- * "provider": "findymail"
16831
- * },
16832
- * {
16833
17077
  * "provider": "crustdata"
16834
17078
  * }
16835
17079
  * ]
@@ -17630,7 +17874,7 @@ interface components {
17630
17874
  };
17631
17875
  SearchesResponseSchema: {
17632
17876
  id: string; /** @enum {string} */
17633
- status: "completed" | "failed" | "pending" | "processing";
17877
+ status: "completed" | "failed" | "pending" | "processing" | "canceled";
17634
17878
  results: {
17635
17879
  [key: string]: {
17636
17880
  value: string | number | boolean | null | {
@@ -24486,7 +24730,7 @@ interface components {
24486
24730
  } | null;
24487
24731
  SearchResponseSchema: {
24488
24732
  id: string; /** @enum {string} */
24489
- status: "completed" | "failed" | "pending" | "processing"; /** @enum {string} */
24733
+ status: "completed" | "failed" | "pending" | "processing" | "canceled"; /** @enum {string} */
24490
24734
  search_id: "companies:profiles:crustdata@1" | "companies:profiles:crustdata@2" | "companies:profiles:crustdata@3" | "companies:profiles:amplemarket@1" | "companies:profiles:amplemarket@2" | "people:profiles:crustdata@1" | "people:profiles:crustdata@2" | "people:profiles:crustdata@3" | "people:profiles:amplemarket@1" | "people:profiles:amplemarket@2" | "companies:entitysearch:parallel@1" | "people:entitysearch:parallel@1" | "people:eventguests:luma@1" | "people:channelmembers:slack@1" | "events:googlecalendar@1" | "sheet:rows@1" | "bucket:entries@1" | "query:postgres@1" | "query:databricks@1" | "posts:content:crustdata@1" | "contacts:hubspot@1" | "companies:hubspot@1" | "deals:hubspot@1" | "owners:hubspot@1" | "contacts:salesforce@1" | "leads:salesforce@1" | "accounts:salesforce@1" | "opportunities:salesforce@1" | "users:salesforce@1" | "query:salesforce@1" | "people:attio@1" | "companies:attio@1" | "deals:attio@1" | "records:attio@1" | "entries:attio@1" | "query:attio@1" | "users:attio@1";
24491
24735
  errors: {
24492
24736
  code: string;