-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathcheck_transfers.py
More file actions
848 lines (707 loc) · 34.8 KB
/
check_transfers.py
File metadata and controls
848 lines (707 loc) · 34.8 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
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
from __future__ import annotations
from typing import Union
from datetime import date
from typing_extensions import Literal
import httpx
from ..types import check_transfer_list_params, check_transfer_create_params, check_transfer_stop_payment_params
from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
from .._utils import 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 ..pagination import SyncPage, AsyncPage
from .._base_client import AsyncPaginator, make_request_options
from ..types.check_transfer import CheckTransfer
__all__ = ["CheckTransfersResource", "AsyncCheckTransfersResource"]
class CheckTransfersResource(SyncAPIResource):
@cached_property
def with_raw_response(self) -> CheckTransfersResourceWithRawResponse:
"""
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/Increase/increase-python#accessing-raw-response-data-eg-headers
"""
return CheckTransfersResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> CheckTransfersResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
For more information, see https://www.github.com/Increase/increase-python#with_streaming_response
"""
return CheckTransfersResourceWithStreamingResponse(self)
def create(
self,
*,
account_id: str,
amount: int,
fulfillment_method: Literal["physical_check", "third_party"],
source_account_number_id: str,
balance_check: Literal["full", "none"] | Omit = omit,
check_number: str | Omit = omit,
physical_check: check_transfer_create_params.PhysicalCheck | Omit = omit,
require_approval: bool | Omit = omit,
third_party: check_transfer_create_params.ThirdParty | Omit = omit,
valid_until_date: Union[str, date] | 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,
idempotency_key: str | None = None,
) -> CheckTransfer:
"""
Create a Check Transfer
Args:
account_id: The identifier for the account that will send the transfer.
amount: The transfer amount in USD cents.
fulfillment_method: Whether Increase will print and mail the check or if you will do it yourself.
- `physical_check` - Increase will print and mail a physical check.
- `third_party` - Increase will not print a check; you are responsible for
printing and mailing a check with the provided account number, routing number,
check number, and amount.
source_account_number_id: The identifier of the Account Number from which to send the transfer and print
on the check.
balance_check: How the account's available balance should be checked. If omitted, the default
behavior is `balance_check: full`.
- `full` - The available balance of the account must be at least the amount of
the check, and a Pending Transaction will be created for the full amount. This
is the default behavior if `balance_check` is omitted.
- `none` - No balance check will performed when the check transfer is initiated.
A zero-dollar Pending Transaction will be created. The balance will still be
checked when the Inbound Check Deposit is created.
check_number: The check number Increase should use for the check. This should not contain
leading zeroes and must be unique across the `source_account_number`. If this is
omitted, Increase will generate a check number for you.
physical_check: Details relating to the physical check that Increase will print and mail. This
is required if `fulfillment_method` is equal to `physical_check`. It must not be
included if any other `fulfillment_method` is provided.
require_approval: Whether the transfer requires explicit approval via the dashboard or API.
third_party: Details relating to the custom fulfillment you will perform. This is required if
`fulfillment_method` is equal to `third_party`. It must not be included if any
other `fulfillment_method` is provided.
valid_until_date: If provided, the check will be valid on or before this date. After this date,
the check transfer will be automatically stopped and deposits will not be
accepted. For checks printed by Increase, this date is included on the check as
its expiry.
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
idempotency_key: Specify a custom idempotency key for this request
"""
return self._post(
"/check_transfers",
body=maybe_transform(
{
"account_id": account_id,
"amount": amount,
"fulfillment_method": fulfillment_method,
"source_account_number_id": source_account_number_id,
"balance_check": balance_check,
"check_number": check_number,
"physical_check": physical_check,
"require_approval": require_approval,
"third_party": third_party,
"valid_until_date": valid_until_date,
},
check_transfer_create_params.CheckTransferCreateParams,
),
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
idempotency_key=idempotency_key,
),
cast_to=CheckTransfer,
)
def retrieve(
self,
check_transfer_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,
) -> CheckTransfer:
"""
Retrieve a Check Transfer
Args:
check_transfer_id: The identifier of the Check Transfer.
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 check_transfer_id:
raise ValueError(f"Expected a non-empty value for `check_transfer_id` but received {check_transfer_id!r}")
return self._get(
f"/check_transfers/{check_transfer_id}",
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=CheckTransfer,
)
def list(
self,
*,
account_id: str | Omit = omit,
created_at: check_transfer_list_params.CreatedAt | Omit = omit,
cursor: str | Omit = omit,
idempotency_key: str | Omit = omit,
limit: int | Omit = omit,
status: check_transfer_list_params.Status | 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,
) -> SyncPage[CheckTransfer]:
"""
List Check Transfers
Args:
account_id: Filter Check Transfers to those that originated from the specified Account.
cursor: Return the page of entries after this one.
idempotency_key: Filter records to the one with the specified `idempotency_key` you chose for
that object. This value is unique across Increase and is used to ensure that a
request is only processed once. Learn more about
[idempotency](https://increase.com/documentation/idempotency-keys).
limit: Limit the size of the list that is returned. The default (and maximum) is 100
objects.
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_list(
"/check_transfers",
page=SyncPage[CheckTransfer],
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=maybe_transform(
{
"account_id": account_id,
"created_at": created_at,
"cursor": cursor,
"idempotency_key": idempotency_key,
"limit": limit,
"status": status,
},
check_transfer_list_params.CheckTransferListParams,
),
),
model=CheckTransfer,
)
def approve(
self,
check_transfer_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,
idempotency_key: str | None = None,
) -> CheckTransfer:
"""
Approve a Check Transfer
Args:
check_transfer_id: The identifier of the Check Transfer to approve.
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
idempotency_key: Specify a custom idempotency key for this request
"""
if not check_transfer_id:
raise ValueError(f"Expected a non-empty value for `check_transfer_id` but received {check_transfer_id!r}")
return self._post(
f"/check_transfers/{check_transfer_id}/approve",
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
idempotency_key=idempotency_key,
),
cast_to=CheckTransfer,
)
def cancel(
self,
check_transfer_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,
idempotency_key: str | None = None,
) -> CheckTransfer:
"""Cancel a Check Transfer with the `pending_approval` status.
See
[Transfer Approvals](/documentation/transfer-approvals) for more information.
Args:
check_transfer_id: The identifier of the pending Check Transfer to cancel.
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
idempotency_key: Specify a custom idempotency key for this request
"""
if not check_transfer_id:
raise ValueError(f"Expected a non-empty value for `check_transfer_id` but received {check_transfer_id!r}")
return self._post(
f"/check_transfers/{check_transfer_id}/cancel",
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
idempotency_key=idempotency_key,
),
cast_to=CheckTransfer,
)
def stop_payment(
self,
check_transfer_id: str,
*,
reason: Literal["mail_delivery_failed", "not_authorized", "valid_until_date_passed", "unknown"] | 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,
idempotency_key: str | None = None,
) -> CheckTransfer:
"""
Stop payment on a Check Transfer
Args:
check_transfer_id: The identifier of the Check Transfer.
reason: The reason why this transfer should be stopped.
- `mail_delivery_failed` - The check could not be delivered.
- `not_authorized` - The check was not authorized.
- `valid_until_date_passed` - The check was stopped for `valid_until_date` being
in the past.
- `unknown` - The check was stopped for another reason.
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
idempotency_key: Specify a custom idempotency key for this request
"""
if not check_transfer_id:
raise ValueError(f"Expected a non-empty value for `check_transfer_id` but received {check_transfer_id!r}")
return self._post(
f"/check_transfers/{check_transfer_id}/stop_payment",
body=maybe_transform({"reason": reason}, check_transfer_stop_payment_params.CheckTransferStopPaymentParams),
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
idempotency_key=idempotency_key,
),
cast_to=CheckTransfer,
)
class AsyncCheckTransfersResource(AsyncAPIResource):
@cached_property
def with_raw_response(self) -> AsyncCheckTransfersResourceWithRawResponse:
"""
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/Increase/increase-python#accessing-raw-response-data-eg-headers
"""
return AsyncCheckTransfersResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> AsyncCheckTransfersResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
For more information, see https://www.github.com/Increase/increase-python#with_streaming_response
"""
return AsyncCheckTransfersResourceWithStreamingResponse(self)
async def create(
self,
*,
account_id: str,
amount: int,
fulfillment_method: Literal["physical_check", "third_party"],
source_account_number_id: str,
balance_check: Literal["full", "none"] | Omit = omit,
check_number: str | Omit = omit,
physical_check: check_transfer_create_params.PhysicalCheck | Omit = omit,
require_approval: bool | Omit = omit,
third_party: check_transfer_create_params.ThirdParty | Omit = omit,
valid_until_date: Union[str, date] | 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,
idempotency_key: str | None = None,
) -> CheckTransfer:
"""
Create a Check Transfer
Args:
account_id: The identifier for the account that will send the transfer.
amount: The transfer amount in USD cents.
fulfillment_method: Whether Increase will print and mail the check or if you will do it yourself.
- `physical_check` - Increase will print and mail a physical check.
- `third_party` - Increase will not print a check; you are responsible for
printing and mailing a check with the provided account number, routing number,
check number, and amount.
source_account_number_id: The identifier of the Account Number from which to send the transfer and print
on the check.
balance_check: How the account's available balance should be checked. If omitted, the default
behavior is `balance_check: full`.
- `full` - The available balance of the account must be at least the amount of
the check, and a Pending Transaction will be created for the full amount. This
is the default behavior if `balance_check` is omitted.
- `none` - No balance check will performed when the check transfer is initiated.
A zero-dollar Pending Transaction will be created. The balance will still be
checked when the Inbound Check Deposit is created.
check_number: The check number Increase should use for the check. This should not contain
leading zeroes and must be unique across the `source_account_number`. If this is
omitted, Increase will generate a check number for you.
physical_check: Details relating to the physical check that Increase will print and mail. This
is required if `fulfillment_method` is equal to `physical_check`. It must not be
included if any other `fulfillment_method` is provided.
require_approval: Whether the transfer requires explicit approval via the dashboard or API.
third_party: Details relating to the custom fulfillment you will perform. This is required if
`fulfillment_method` is equal to `third_party`. It must not be included if any
other `fulfillment_method` is provided.
valid_until_date: If provided, the check will be valid on or before this date. After this date,
the check transfer will be automatically stopped and deposits will not be
accepted. For checks printed by Increase, this date is included on the check as
its expiry.
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
idempotency_key: Specify a custom idempotency key for this request
"""
return await self._post(
"/check_transfers",
body=await async_maybe_transform(
{
"account_id": account_id,
"amount": amount,
"fulfillment_method": fulfillment_method,
"source_account_number_id": source_account_number_id,
"balance_check": balance_check,
"check_number": check_number,
"physical_check": physical_check,
"require_approval": require_approval,
"third_party": third_party,
"valid_until_date": valid_until_date,
},
check_transfer_create_params.CheckTransferCreateParams,
),
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
idempotency_key=idempotency_key,
),
cast_to=CheckTransfer,
)
async def retrieve(
self,
check_transfer_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,
) -> CheckTransfer:
"""
Retrieve a Check Transfer
Args:
check_transfer_id: The identifier of the Check Transfer.
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 check_transfer_id:
raise ValueError(f"Expected a non-empty value for `check_transfer_id` but received {check_transfer_id!r}")
return await self._get(
f"/check_transfers/{check_transfer_id}",
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=CheckTransfer,
)
def list(
self,
*,
account_id: str | Omit = omit,
created_at: check_transfer_list_params.CreatedAt | Omit = omit,
cursor: str | Omit = omit,
idempotency_key: str | Omit = omit,
limit: int | Omit = omit,
status: check_transfer_list_params.Status | 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,
) -> AsyncPaginator[CheckTransfer, AsyncPage[CheckTransfer]]:
"""
List Check Transfers
Args:
account_id: Filter Check Transfers to those that originated from the specified Account.
cursor: Return the page of entries after this one.
idempotency_key: Filter records to the one with the specified `idempotency_key` you chose for
that object. This value is unique across Increase and is used to ensure that a
request is only processed once. Learn more about
[idempotency](https://increase.com/documentation/idempotency-keys).
limit: Limit the size of the list that is returned. The default (and maximum) is 100
objects.
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_list(
"/check_transfers",
page=AsyncPage[CheckTransfer],
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=maybe_transform(
{
"account_id": account_id,
"created_at": created_at,
"cursor": cursor,
"idempotency_key": idempotency_key,
"limit": limit,
"status": status,
},
check_transfer_list_params.CheckTransferListParams,
),
),
model=CheckTransfer,
)
async def approve(
self,
check_transfer_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,
idempotency_key: str | None = None,
) -> CheckTransfer:
"""
Approve a Check Transfer
Args:
check_transfer_id: The identifier of the Check Transfer to approve.
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
idempotency_key: Specify a custom idempotency key for this request
"""
if not check_transfer_id:
raise ValueError(f"Expected a non-empty value for `check_transfer_id` but received {check_transfer_id!r}")
return await self._post(
f"/check_transfers/{check_transfer_id}/approve",
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
idempotency_key=idempotency_key,
),
cast_to=CheckTransfer,
)
async def cancel(
self,
check_transfer_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,
idempotency_key: str | None = None,
) -> CheckTransfer:
"""Cancel a Check Transfer with the `pending_approval` status.
See
[Transfer Approvals](/documentation/transfer-approvals) for more information.
Args:
check_transfer_id: The identifier of the pending Check Transfer to cancel.
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
idempotency_key: Specify a custom idempotency key for this request
"""
if not check_transfer_id:
raise ValueError(f"Expected a non-empty value for `check_transfer_id` but received {check_transfer_id!r}")
return await self._post(
f"/check_transfers/{check_transfer_id}/cancel",
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
idempotency_key=idempotency_key,
),
cast_to=CheckTransfer,
)
async def stop_payment(
self,
check_transfer_id: str,
*,
reason: Literal["mail_delivery_failed", "not_authorized", "valid_until_date_passed", "unknown"] | 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,
idempotency_key: str | None = None,
) -> CheckTransfer:
"""
Stop payment on a Check Transfer
Args:
check_transfer_id: The identifier of the Check Transfer.
reason: The reason why this transfer should be stopped.
- `mail_delivery_failed` - The check could not be delivered.
- `not_authorized` - The check was not authorized.
- `valid_until_date_passed` - The check was stopped for `valid_until_date` being
in the past.
- `unknown` - The check was stopped for another reason.
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
idempotency_key: Specify a custom idempotency key for this request
"""
if not check_transfer_id:
raise ValueError(f"Expected a non-empty value for `check_transfer_id` but received {check_transfer_id!r}")
return await self._post(
f"/check_transfers/{check_transfer_id}/stop_payment",
body=await async_maybe_transform(
{"reason": reason}, check_transfer_stop_payment_params.CheckTransferStopPaymentParams
),
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
idempotency_key=idempotency_key,
),
cast_to=CheckTransfer,
)
class CheckTransfersResourceWithRawResponse:
def __init__(self, check_transfers: CheckTransfersResource) -> None:
self._check_transfers = check_transfers
self.create = to_raw_response_wrapper(
check_transfers.create,
)
self.retrieve = to_raw_response_wrapper(
check_transfers.retrieve,
)
self.list = to_raw_response_wrapper(
check_transfers.list,
)
self.approve = to_raw_response_wrapper(
check_transfers.approve,
)
self.cancel = to_raw_response_wrapper(
check_transfers.cancel,
)
self.stop_payment = to_raw_response_wrapper(
check_transfers.stop_payment,
)
class AsyncCheckTransfersResourceWithRawResponse:
def __init__(self, check_transfers: AsyncCheckTransfersResource) -> None:
self._check_transfers = check_transfers
self.create = async_to_raw_response_wrapper(
check_transfers.create,
)
self.retrieve = async_to_raw_response_wrapper(
check_transfers.retrieve,
)
self.list = async_to_raw_response_wrapper(
check_transfers.list,
)
self.approve = async_to_raw_response_wrapper(
check_transfers.approve,
)
self.cancel = async_to_raw_response_wrapper(
check_transfers.cancel,
)
self.stop_payment = async_to_raw_response_wrapper(
check_transfers.stop_payment,
)
class CheckTransfersResourceWithStreamingResponse:
def __init__(self, check_transfers: CheckTransfersResource) -> None:
self._check_transfers = check_transfers
self.create = to_streamed_response_wrapper(
check_transfers.create,
)
self.retrieve = to_streamed_response_wrapper(
check_transfers.retrieve,
)
self.list = to_streamed_response_wrapper(
check_transfers.list,
)
self.approve = to_streamed_response_wrapper(
check_transfers.approve,
)
self.cancel = to_streamed_response_wrapper(
check_transfers.cancel,
)
self.stop_payment = to_streamed_response_wrapper(
check_transfers.stop_payment,
)
class AsyncCheckTransfersResourceWithStreamingResponse:
def __init__(self, check_transfers: AsyncCheckTransfersResource) -> None:
self._check_transfers = check_transfers
self.create = async_to_streamed_response_wrapper(
check_transfers.create,
)
self.retrieve = async_to_streamed_response_wrapper(
check_transfers.retrieve,
)
self.list = async_to_streamed_response_wrapper(
check_transfers.list,
)
self.approve = async_to_streamed_response_wrapper(
check_transfers.approve,
)
self.cancel = async_to_streamed_response_wrapper(
check_transfers.cancel,
)
self.stop_payment = async_to_streamed_response_wrapper(
check_transfers.stop_payment,
)