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
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._stripe_service import StripeService
from stripe._util import sanitize_id
from typing import Optional, cast
from typing_extensions import TYPE_CHECKING
if TYPE_CHECKING:
from stripe._request_options import RequestOptions
from stripe.params.test_helpers.treasury._outbound_transfer_fail_params import (
OutboundTransferFailParams,
)
from stripe.params.test_helpers.treasury._outbound_transfer_post_params import (
OutboundTransferPostParams,
)
from stripe.params.test_helpers.treasury._outbound_transfer_return_outbound_transfer_params import (
OutboundTransferReturnOutboundTransferParams,
)
from stripe.params.test_helpers.treasury._outbound_transfer_update_params import (
OutboundTransferUpdateParams,
)
from stripe.treasury._outbound_transfer import OutboundTransfer
class OutboundTransferService(StripeService):
def update(
self,
outbound_transfer: str,
params: "OutboundTransferUpdateParams",
options: Optional["RequestOptions"] = None,
) -> "OutboundTransfer":
"""
Updates a test mode created OutboundTransfer with tracking details. The OutboundTransfer must not be cancelable, and cannot be in the canceled or failed states.
"""
return cast(
"OutboundTransfer",
self._request(
"post",
"/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}".format(
outbound_transfer=sanitize_id(outbound_transfer),
),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
outbound_transfer: str,
params: "OutboundTransferUpdateParams",
options: Optional["RequestOptions"] = None,
) -> "OutboundTransfer":
"""
Updates a test mode created OutboundTransfer with tracking details. The OutboundTransfer must not be cancelable, and cannot be in the canceled or failed states.
"""
return cast(
"OutboundTransfer",
await self._request_async(
"post",
"/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}".format(
outbound_transfer=sanitize_id(outbound_transfer),
),
base_address="api",
params=params,
options=options,
),
)
def fail(
self,
outbound_transfer: str,
params: Optional["OutboundTransferFailParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "OutboundTransfer":
"""
Transitions a test mode created OutboundTransfer to the failed status. The OutboundTransfer must already be in the processing state.
"""
return cast(
"OutboundTransfer",
self._request(
"post",
"/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/fail".format(
outbound_transfer=sanitize_id(outbound_transfer),
),
base_address="api",
params=params,
options=options,
),
)
async def fail_async(
self,
outbound_transfer: str,
params: Optional["OutboundTransferFailParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "OutboundTransfer":
"""
Transitions a test mode created OutboundTransfer to the failed status. The OutboundTransfer must already be in the processing state.
"""
return cast(
"OutboundTransfer",
await self._request_async(
"post",
"/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/fail".format(
outbound_transfer=sanitize_id(outbound_transfer),
),
base_address="api",
params=params,
options=options,
),
)
def post(
self,
outbound_transfer: str,
params: Optional["OutboundTransferPostParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "OutboundTransfer":
"""
Transitions a test mode created OutboundTransfer to the posted status. The OutboundTransfer must already be in the processing state.
"""
return cast(
"OutboundTransfer",
self._request(
"post",
"/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/post".format(
outbound_transfer=sanitize_id(outbound_transfer),
),
base_address="api",
params=params,
options=options,
),
)
async def post_async(
self,
outbound_transfer: str,
params: Optional["OutboundTransferPostParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "OutboundTransfer":
"""
Transitions a test mode created OutboundTransfer to the posted status. The OutboundTransfer must already be in the processing state.
"""
return cast(
"OutboundTransfer",
await self._request_async(
"post",
"/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/post".format(
outbound_transfer=sanitize_id(outbound_transfer),
),
base_address="api",
params=params,
options=options,
),
)
def return_outbound_transfer(
self,
outbound_transfer: str,
params: Optional[
"OutboundTransferReturnOutboundTransferParams"
] = None,
options: Optional["RequestOptions"] = None,
) -> "OutboundTransfer":
"""
Transitions a test mode created OutboundTransfer to the returned status. The OutboundTransfer must already be in the processing state.
"""
return cast(
"OutboundTransfer",
self._request(
"post",
"/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/return".format(
outbound_transfer=sanitize_id(outbound_transfer),
),
base_address="api",
params=params,
options=options,
),
)
async def return_outbound_transfer_async(
self,
outbound_transfer: str,
params: Optional[
"OutboundTransferReturnOutboundTransferParams"
] = None,
options: Optional["RequestOptions"] = None,
) -> "OutboundTransfer":
"""
Transitions a test mode created OutboundTransfer to the returned status. The OutboundTransfer must already be in the processing state.
"""
return cast(
"OutboundTransfer",
await self._request_async(
"post",
"/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/return".format(
outbound_transfer=sanitize_id(outbound_transfer),
),
base_address="api",
params=params,
options=options,
),
)
|