File: _exchange_rate_service.py

package info (click to toggle)
python-stripe 13.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 14,476 kB
  • sloc: python: 187,843; makefile: 13; sh: 9
file content (107 lines) | stat: -rw-r--r-- 3,975 bytes parent folder | download
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
# -*- 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._exchange_rate import ExchangeRate
    from stripe._list_object import ListObject
    from stripe._request_options import RequestOptions
    from stripe.params._exchange_rate_list_params import ExchangeRateListParams
    from stripe.params._exchange_rate_retrieve_params import (
        ExchangeRateRetrieveParams,
    )


class ExchangeRateService(StripeService):
    def list(
        self,
        params: Optional["ExchangeRateListParams"] = None,
        options: Optional["RequestOptions"] = None,
    ) -> "ListObject[ExchangeRate]":
        """
        [Deprecated] The ExchangeRate APIs are deprecated. Please use the [FX Quotes API](https://docs.stripe.com/payments/currencies/localize-prices/fx-quotes-api) instead.

        Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.
        """
        return cast(
            "ListObject[ExchangeRate]",
            self._request(
                "get",
                "/v1/exchange_rates",
                base_address="api",
                params=params,
                options=options,
            ),
        )

    async def list_async(
        self,
        params: Optional["ExchangeRateListParams"] = None,
        options: Optional["RequestOptions"] = None,
    ) -> "ListObject[ExchangeRate]":
        """
        [Deprecated] The ExchangeRate APIs are deprecated. Please use the [FX Quotes API](https://docs.stripe.com/payments/currencies/localize-prices/fx-quotes-api) instead.

        Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.
        """
        return cast(
            "ListObject[ExchangeRate]",
            await self._request_async(
                "get",
                "/v1/exchange_rates",
                base_address="api",
                params=params,
                options=options,
            ),
        )

    def retrieve(
        self,
        rate_id: str,
        params: Optional["ExchangeRateRetrieveParams"] = None,
        options: Optional["RequestOptions"] = None,
    ) -> "ExchangeRate":
        """
        [Deprecated] The ExchangeRate APIs are deprecated. Please use the [FX Quotes API](https://docs.stripe.com/payments/currencies/localize-prices/fx-quotes-api) instead.

        Retrieves the exchange rates from the given currency to every supported currency.
        """
        return cast(
            "ExchangeRate",
            self._request(
                "get",
                "/v1/exchange_rates/{rate_id}".format(
                    rate_id=sanitize_id(rate_id),
                ),
                base_address="api",
                params=params,
                options=options,
            ),
        )

    async def retrieve_async(
        self,
        rate_id: str,
        params: Optional["ExchangeRateRetrieveParams"] = None,
        options: Optional["RequestOptions"] = None,
    ) -> "ExchangeRate":
        """
        [Deprecated] The ExchangeRate APIs are deprecated. Please use the [FX Quotes API](https://docs.stripe.com/payments/currencies/localize-prices/fx-quotes-api) instead.

        Retrieves the exchange rates from the given currency to every supported currency.
        """
        return cast(
            "ExchangeRate",
            await self._request_async(
                "get",
                "/v1/exchange_rates/{rate_id}".format(
                    rate_id=sanitize_id(rate_id),
                ),
                base_address="api",
                params=params,
                options=options,
            ),
        )