-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdata_exports.py
More file actions
823 lines (700 loc) · 32.6 KB
/
Copy pathdata_exports.py
File metadata and controls
823 lines (700 loc) · 32.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
from __future__ import annotations
from typing import Dict
from typing_extensions import Literal
import httpx
from ..types import data_export_list_params, data_export_create_params, data_export_retrieve_params
from .._types import Body, Omit, Query, Headers, NotGiven, SequenceNotStr, omit, not_given
from .._utils import path_template, maybe_transform, async_maybe_transform
from .._compat import cached_property
from .._resource import SyncAPIResource, AsyncAPIResource
from .._response import (
to_raw_response_wrapper,
to_streamed_response_wrapper,
async_to_raw_response_wrapper,
async_to_streamed_response_wrapper,
)
from .._base_client import make_request_options
from ..types.data_export_list_response import DataExportListResponse
from ..types.data_export_retry_response import DataExportRetryResponse
from ..types.data_export_start_response import DataExportStartResponse
from ..types.data_export_cancel_response import DataExportCancelResponse
from ..types.data_export_create_response import DataExportCreateResponse
from ..types.data_export_retrieve_response import DataExportRetrieveResponse
__all__ = ["DataExportsResource", "AsyncDataExportsResource"]
class DataExportsResource(SyncAPIResource):
"""APIs for managing data exports"""
@cached_property
def with_raw_response(self) -> DataExportsResourceWithRawResponse:
"""
This property can be used as a prefix for any HTTP method call to return
the raw response object instead of the parsed content.
For more information, see https://www.github.com/onlyfansapi/onlyfansapi-python#accessing-raw-response-data-eg-headers
"""
return DataExportsResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> DataExportsResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
For more information, see https://www.github.com/onlyfansapi/onlyfansapi-python#with_streaming_response
"""
return DataExportsResourceWithStreamingResponse(self)
def create(
self,
*,
end_date: str,
file_type: Literal["csv", "xlsx", "zip"],
start_date: str,
type: Literal[
"transactions",
"chat_messages",
"media_vault",
"trial_links",
"tracking_links",
"smart_links",
"payouts",
"chargebacks",
"public_profiles",
"fans",
"followings",
],
account_ids: SequenceNotStr[str] | Omit = omit,
auto_start: bool | Omit = omit,
export_columns: SequenceNotStr[str] | Omit = omit,
options: Dict[str, object] | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> DataExportCreateResponse:
"""Create a new data export request.
This will calculate the required credits and
prepare the export for starting.
Args:
end_date: The end date for the export (ISO 8601 format).
file_type: The output file format. Supported formats vary by export type: `csv` or `xlsx`
for transactions, chat_messages, trial_links, tracking_links, smart_links,
payouts, chargebacks, public_profiles, fans, followings; `zip` for media_vault.
start_date: The start date for the export (ISO 8601 format).
type: The type of data to export
account_ids: Array of account prefixed IDs to export data from. Not required for
`public_profiles` type.
auto_start: When true, automatically starts the export after creation.
export_columns: Array of column names to include in the export (optional, defaults to all
columns for the export type)
options: Type-specific export options. For `chat_messages`: `maxMessages` (required per
account, max 10,000,000), `maxChats` (optional per-account chat scrape limit),
`skipMassMessages` (optional, bool), `chatIds` (optional array of numeric
fan/chat IDs; filters output and can drastically reduce totals). For
`media_vault`: `mediaType` (required, one of: `all`, `photo`, `gif`, `video`,
`audio`). For `fans`: `type` (required, one of: `all`, `active`, `expired`,
`latest`). For `followings`: `type` (required, one of: `all`, `active`,
`expired`). For `public_profiles`: `query` (optional, full-text search),
`gender` (optional, filter: male, female, trans, couple), `minSubscribePrice`
(optional, USD), `maxSubscribePrice` (optional, USD), `location` (optional),
`minPostsCount` (optional, minimum posts), `minPhotosCount` (optional, minimum
photos), `minVideosCount` (optional, minimum videos), `minSubscribersCount`
(optional, minimum subscribers), `minJoinDate` (optional, ISO 8601 date),
`minLastSeenAt` (optional, ISO 8601 date), `createdAtFrom` (optional, ISO 8601
date, profile added to DB after), `createdAtTo` (optional, ISO 8601 date,
profile added to DB before), `instagram` (optional), `twitter` (optional),
`tiktok` (optional), `maxResults` (optional, limit results).
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._post(
"/api/data-exports",
body=maybe_transform(
{
"end_date": end_date,
"file_type": file_type,
"start_date": start_date,
"type": type,
"account_ids": account_ids,
"auto_start": auto_start,
"export_columns": export_columns,
"options": options,
},
data_export_create_params.DataExportCreateParams,
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=DataExportCreateResponse,
)
def retrieve(
self,
data_export_id: str,
*,
download_url_expires_in: int | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> DataExportRetrieveResponse:
"""
Get the current status and progress of a data export
Args:
download_url_expires_in: Number of minutes until the download URL expires. Min `1`, max `60`, default
`5`.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not data_export_id:
raise ValueError(f"Expected a non-empty value for `data_export_id` but received {data_export_id!r}")
return self._get(
path_template("/api/data-exports/{data_export_id}", data_export_id=data_export_id),
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=maybe_transform(
{"download_url_expires_in": download_url_expires_in},
data_export_retrieve_params.DataExportRetrieveParams,
),
),
cast_to=DataExportRetrieveResponse,
)
def list(
self,
*,
download_url_expires_in: int | Omit = omit,
page: int | Omit = omit,
per_page: int | Omit = omit,
status: Literal[
"calculating_credits",
"calculating_credits_failed",
"calculating_credits_completed",
"pending",
"in_progress",
"completed",
"failed",
]
| Omit = omit,
type: Literal[
"transactions",
"chat_messages",
"media_vault",
"trial_links",
"tracking_links",
"payouts",
"chargebacks",
"public_profiles",
]
| Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> DataExportListResponse:
"""
Get a paginated list of data exports for the team
Args:
download_url_expires_in: Number of minutes until download URLs expire. Min `1`, max `60`, default `5`.
page: Page number for pagination. Default `1`
per_page: Number of results per page. Default `15`, max `100`
status: Filter by status
type: Filter by export type
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._get(
"/api/data-exports",
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=maybe_transform(
{
"download_url_expires_in": download_url_expires_in,
"page": page,
"per_page": per_page,
"status": status,
"type": type,
},
data_export_list_params.DataExportListParams,
),
),
cast_to=DataExportListResponse,
)
def cancel(
self,
data_export_id: str,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> DataExportCancelResponse:
"""Cancel a running data export.
Only exports with status `pending` or
`in_progress` can be cancelled.
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not data_export_id:
raise ValueError(f"Expected a non-empty value for `data_export_id` but received {data_export_id!r}")
return self._delete(
path_template("/api/data-exports/{data_export_id}", data_export_id=data_export_id),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=DataExportCancelResponse,
)
def retry(
self,
data_export_id: str,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> DataExportRetryResponse:
"""
Create a new data export with the same parameters as a failed export and
automatically start it.
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not data_export_id:
raise ValueError(f"Expected a non-empty value for `data_export_id` but received {data_export_id!r}")
return self._post(
path_template("/api/data-exports/{data_export_id}/retry", data_export_id=data_export_id),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=DataExportRetryResponse,
)
def start(
self,
data_export_id: str,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> DataExportStartResponse:
"""Start processing a data export that has completed credit calculation.
This will
begin the actual export process and charge credits.
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not data_export_id:
raise ValueError(f"Expected a non-empty value for `data_export_id` but received {data_export_id!r}")
return self._post(
path_template("/api/data-exports/{data_export_id}/start", data_export_id=data_export_id),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=DataExportStartResponse,
)
class AsyncDataExportsResource(AsyncAPIResource):
"""APIs for managing data exports"""
@cached_property
def with_raw_response(self) -> AsyncDataExportsResourceWithRawResponse:
"""
This property can be used as a prefix for any HTTP method call to return
the raw response object instead of the parsed content.
For more information, see https://www.github.com/onlyfansapi/onlyfansapi-python#accessing-raw-response-data-eg-headers
"""
return AsyncDataExportsResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> AsyncDataExportsResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
For more information, see https://www.github.com/onlyfansapi/onlyfansapi-python#with_streaming_response
"""
return AsyncDataExportsResourceWithStreamingResponse(self)
async def create(
self,
*,
end_date: str,
file_type: Literal["csv", "xlsx", "zip"],
start_date: str,
type: Literal[
"transactions",
"chat_messages",
"media_vault",
"trial_links",
"tracking_links",
"smart_links",
"payouts",
"chargebacks",
"public_profiles",
"fans",
"followings",
],
account_ids: SequenceNotStr[str] | Omit = omit,
auto_start: bool | Omit = omit,
export_columns: SequenceNotStr[str] | Omit = omit,
options: Dict[str, object] | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> DataExportCreateResponse:
"""Create a new data export request.
This will calculate the required credits and
prepare the export for starting.
Args:
end_date: The end date for the export (ISO 8601 format).
file_type: The output file format. Supported formats vary by export type: `csv` or `xlsx`
for transactions, chat_messages, trial_links, tracking_links, smart_links,
payouts, chargebacks, public_profiles, fans, followings; `zip` for media_vault.
start_date: The start date for the export (ISO 8601 format).
type: The type of data to export
account_ids: Array of account prefixed IDs to export data from. Not required for
`public_profiles` type.
auto_start: When true, automatically starts the export after creation.
export_columns: Array of column names to include in the export (optional, defaults to all
columns for the export type)
options: Type-specific export options. For `chat_messages`: `maxMessages` (required per
account, max 10,000,000), `maxChats` (optional per-account chat scrape limit),
`skipMassMessages` (optional, bool), `chatIds` (optional array of numeric
fan/chat IDs; filters output and can drastically reduce totals). For
`media_vault`: `mediaType` (required, one of: `all`, `photo`, `gif`, `video`,
`audio`). For `fans`: `type` (required, one of: `all`, `active`, `expired`,
`latest`). For `followings`: `type` (required, one of: `all`, `active`,
`expired`). For `public_profiles`: `query` (optional, full-text search),
`gender` (optional, filter: male, female, trans, couple), `minSubscribePrice`
(optional, USD), `maxSubscribePrice` (optional, USD), `location` (optional),
`minPostsCount` (optional, minimum posts), `minPhotosCount` (optional, minimum
photos), `minVideosCount` (optional, minimum videos), `minSubscribersCount`
(optional, minimum subscribers), `minJoinDate` (optional, ISO 8601 date),
`minLastSeenAt` (optional, ISO 8601 date), `createdAtFrom` (optional, ISO 8601
date, profile added to DB after), `createdAtTo` (optional, ISO 8601 date,
profile added to DB before), `instagram` (optional), `twitter` (optional),
`tiktok` (optional), `maxResults` (optional, limit results).
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return await self._post(
"/api/data-exports",
body=await async_maybe_transform(
{
"end_date": end_date,
"file_type": file_type,
"start_date": start_date,
"type": type,
"account_ids": account_ids,
"auto_start": auto_start,
"export_columns": export_columns,
"options": options,
},
data_export_create_params.DataExportCreateParams,
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=DataExportCreateResponse,
)
async def retrieve(
self,
data_export_id: str,
*,
download_url_expires_in: int | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> DataExportRetrieveResponse:
"""
Get the current status and progress of a data export
Args:
download_url_expires_in: Number of minutes until the download URL expires. Min `1`, max `60`, default
`5`.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not data_export_id:
raise ValueError(f"Expected a non-empty value for `data_export_id` but received {data_export_id!r}")
return await self._get(
path_template("/api/data-exports/{data_export_id}", data_export_id=data_export_id),
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=await async_maybe_transform(
{"download_url_expires_in": download_url_expires_in},
data_export_retrieve_params.DataExportRetrieveParams,
),
),
cast_to=DataExportRetrieveResponse,
)
async def list(
self,
*,
download_url_expires_in: int | Omit = omit,
page: int | Omit = omit,
per_page: int | Omit = omit,
status: Literal[
"calculating_credits",
"calculating_credits_failed",
"calculating_credits_completed",
"pending",
"in_progress",
"completed",
"failed",
]
| Omit = omit,
type: Literal[
"transactions",
"chat_messages",
"media_vault",
"trial_links",
"tracking_links",
"payouts",
"chargebacks",
"public_profiles",
]
| Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> DataExportListResponse:
"""
Get a paginated list of data exports for the team
Args:
download_url_expires_in: Number of minutes until download URLs expire. Min `1`, max `60`, default `5`.
page: Page number for pagination. Default `1`
per_page: Number of results per page. Default `15`, max `100`
status: Filter by status
type: Filter by export type
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return await self._get(
"/api/data-exports",
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=await async_maybe_transform(
{
"download_url_expires_in": download_url_expires_in,
"page": page,
"per_page": per_page,
"status": status,
"type": type,
},
data_export_list_params.DataExportListParams,
),
),
cast_to=DataExportListResponse,
)
async def cancel(
self,
data_export_id: str,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> DataExportCancelResponse:
"""Cancel a running data export.
Only exports with status `pending` or
`in_progress` can be cancelled.
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not data_export_id:
raise ValueError(f"Expected a non-empty value for `data_export_id` but received {data_export_id!r}")
return await self._delete(
path_template("/api/data-exports/{data_export_id}", data_export_id=data_export_id),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=DataExportCancelResponse,
)
async def retry(
self,
data_export_id: str,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> DataExportRetryResponse:
"""
Create a new data export with the same parameters as a failed export and
automatically start it.
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not data_export_id:
raise ValueError(f"Expected a non-empty value for `data_export_id` but received {data_export_id!r}")
return await self._post(
path_template("/api/data-exports/{data_export_id}/retry", data_export_id=data_export_id),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=DataExportRetryResponse,
)
async def start(
self,
data_export_id: str,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> DataExportStartResponse:
"""Start processing a data export that has completed credit calculation.
This will
begin the actual export process and charge credits.
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not data_export_id:
raise ValueError(f"Expected a non-empty value for `data_export_id` but received {data_export_id!r}")
return await self._post(
path_template("/api/data-exports/{data_export_id}/start", data_export_id=data_export_id),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=DataExportStartResponse,
)
class DataExportsResourceWithRawResponse:
def __init__(self, data_exports: DataExportsResource) -> None:
self._data_exports = data_exports
self.create = to_raw_response_wrapper(
data_exports.create,
)
self.retrieve = to_raw_response_wrapper(
data_exports.retrieve,
)
self.list = to_raw_response_wrapper(
data_exports.list,
)
self.cancel = to_raw_response_wrapper(
data_exports.cancel,
)
self.retry = to_raw_response_wrapper(
data_exports.retry,
)
self.start = to_raw_response_wrapper(
data_exports.start,
)
class AsyncDataExportsResourceWithRawResponse:
def __init__(self, data_exports: AsyncDataExportsResource) -> None:
self._data_exports = data_exports
self.create = async_to_raw_response_wrapper(
data_exports.create,
)
self.retrieve = async_to_raw_response_wrapper(
data_exports.retrieve,
)
self.list = async_to_raw_response_wrapper(
data_exports.list,
)
self.cancel = async_to_raw_response_wrapper(
data_exports.cancel,
)
self.retry = async_to_raw_response_wrapper(
data_exports.retry,
)
self.start = async_to_raw_response_wrapper(
data_exports.start,
)
class DataExportsResourceWithStreamingResponse:
def __init__(self, data_exports: DataExportsResource) -> None:
self._data_exports = data_exports
self.create = to_streamed_response_wrapper(
data_exports.create,
)
self.retrieve = to_streamed_response_wrapper(
data_exports.retrieve,
)
self.list = to_streamed_response_wrapper(
data_exports.list,
)
self.cancel = to_streamed_response_wrapper(
data_exports.cancel,
)
self.retry = to_streamed_response_wrapper(
data_exports.retry,
)
self.start = to_streamed_response_wrapper(
data_exports.start,
)
class AsyncDataExportsResourceWithStreamingResponse:
def __init__(self, data_exports: AsyncDataExportsResource) -> None:
self._data_exports = data_exports
self.create = async_to_streamed_response_wrapper(
data_exports.create,
)
self.retrieve = async_to_streamed_response_wrapper(
data_exports.retrieve,
)
self.list = async_to_streamed_response_wrapper(
data_exports.list,
)
self.cancel = async_to_streamed_response_wrapper(
data_exports.cancel,
)
self.retry = async_to_streamed_response_wrapper(
data_exports.retry,
)
self.start = async_to_streamed_response_wrapper(
data_exports.start,
)