File: _feature_service.py

package info (click to toggle)
python-stripe 14.4.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 15,576 kB
  • sloc: python: 201,956; makefile: 13; sh: 9
file content (181 lines) | stat: -rw-r--r-- 5,049 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
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
# -*- 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._list_object import ListObject
    from stripe._request_options import RequestOptions
    from stripe.entitlements._feature import Feature
    from stripe.params.entitlements._feature_create_params import (
        FeatureCreateParams,
    )
    from stripe.params.entitlements._feature_list_params import (
        FeatureListParams,
    )
    from stripe.params.entitlements._feature_retrieve_params import (
        FeatureRetrieveParams,
    )
    from stripe.params.entitlements._feature_update_params import (
        FeatureUpdateParams,
    )


class FeatureService(StripeService):
    def list(
        self,
        params: Optional["FeatureListParams"] = None,
        options: Optional["RequestOptions"] = None,
    ) -> "ListObject[Feature]":
        """
        Retrieve a list of features
        """
        return cast(
            "ListObject[Feature]",
            self._request(
                "get",
                "/v1/entitlements/features",
                base_address="api",
                params=params,
                options=options,
            ),
        )

    async def list_async(
        self,
        params: Optional["FeatureListParams"] = None,
        options: Optional["RequestOptions"] = None,
    ) -> "ListObject[Feature]":
        """
        Retrieve a list of features
        """
        return cast(
            "ListObject[Feature]",
            await self._request_async(
                "get",
                "/v1/entitlements/features",
                base_address="api",
                params=params,
                options=options,
            ),
        )

    def create(
        self,
        params: "FeatureCreateParams",
        options: Optional["RequestOptions"] = None,
    ) -> "Feature":
        """
        Creates a feature
        """
        return cast(
            "Feature",
            self._request(
                "post",
                "/v1/entitlements/features",
                base_address="api",
                params=params,
                options=options,
            ),
        )

    async def create_async(
        self,
        params: "FeatureCreateParams",
        options: Optional["RequestOptions"] = None,
    ) -> "Feature":
        """
        Creates a feature
        """
        return cast(
            "Feature",
            await self._request_async(
                "post",
                "/v1/entitlements/features",
                base_address="api",
                params=params,
                options=options,
            ),
        )

    def retrieve(
        self,
        id: str,
        params: Optional["FeatureRetrieveParams"] = None,
        options: Optional["RequestOptions"] = None,
    ) -> "Feature":
        """
        Retrieves a feature
        """
        return cast(
            "Feature",
            self._request(
                "get",
                "/v1/entitlements/features/{id}".format(id=sanitize_id(id)),
                base_address="api",
                params=params,
                options=options,
            ),
        )

    async def retrieve_async(
        self,
        id: str,
        params: Optional["FeatureRetrieveParams"] = None,
        options: Optional["RequestOptions"] = None,
    ) -> "Feature":
        """
        Retrieves a feature
        """
        return cast(
            "Feature",
            await self._request_async(
                "get",
                "/v1/entitlements/features/{id}".format(id=sanitize_id(id)),
                base_address="api",
                params=params,
                options=options,
            ),
        )

    def update(
        self,
        id: str,
        params: Optional["FeatureUpdateParams"] = None,
        options: Optional["RequestOptions"] = None,
    ) -> "Feature":
        """
        Update a feature's metadata or permanently deactivate it.
        """
        return cast(
            "Feature",
            self._request(
                "post",
                "/v1/entitlements/features/{id}".format(id=sanitize_id(id)),
                base_address="api",
                params=params,
                options=options,
            ),
        )

    async def update_async(
        self,
        id: str,
        params: Optional["FeatureUpdateParams"] = None,
        options: Optional["RequestOptions"] = None,
    ) -> "Feature":
        """
        Update a feature's metadata or permanently deactivate it.
        """
        return cast(
            "Feature",
            await self._request_async(
                "post",
                "/v1/entitlements/features/{id}".format(id=sanitize_id(id)),
                base_address="api",
                params=params,
                options=options,
            ),
        )