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
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._invoice_rendering_template import InvoiceRenderingTemplate
from stripe._list_object import ListObject
from stripe._request_options import RequestOptions
from stripe._stripe_service import StripeService
from stripe._util import sanitize_id
from typing import List, cast
from typing_extensions import Literal, NotRequired, TypedDict
class InvoiceRenderingTemplateService(StripeService):
class ArchiveParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
class ListParams(TypedDict):
ending_before: NotRequired[str]
"""
A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
limit: NotRequired[int]
"""
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
"""
starting_after: NotRequired[str]
"""
A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
"""
status: NotRequired[Literal["active", "archived"]]
class RetrieveParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
version: NotRequired[int]
class UnarchiveParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
def list(
self,
params: "InvoiceRenderingTemplateService.ListParams" = {},
options: RequestOptions = {},
) -> ListObject[InvoiceRenderingTemplate]:
"""
List all templates, ordered by creation date, with the most recently created template appearing first.
"""
return cast(
ListObject[InvoiceRenderingTemplate],
self._request(
"get",
"/v1/invoice_rendering_templates",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: "InvoiceRenderingTemplateService.ListParams" = {},
options: RequestOptions = {},
) -> ListObject[InvoiceRenderingTemplate]:
"""
List all templates, ordered by creation date, with the most recently created template appearing first.
"""
return cast(
ListObject[InvoiceRenderingTemplate],
await self._request_async(
"get",
"/v1/invoice_rendering_templates",
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
template: str,
params: "InvoiceRenderingTemplateService.RetrieveParams" = {},
options: RequestOptions = {},
) -> InvoiceRenderingTemplate:
"""
Retrieves an invoice rendering template with the given ID. It by default returns the latest version of the template. Optionally, specify a version to see previous versions.
"""
return cast(
InvoiceRenderingTemplate,
self._request(
"get",
"/v1/invoice_rendering_templates/{template}".format(
template=sanitize_id(template),
),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
template: str,
params: "InvoiceRenderingTemplateService.RetrieveParams" = {},
options: RequestOptions = {},
) -> InvoiceRenderingTemplate:
"""
Retrieves an invoice rendering template with the given ID. It by default returns the latest version of the template. Optionally, specify a version to see previous versions.
"""
return cast(
InvoiceRenderingTemplate,
await self._request_async(
"get",
"/v1/invoice_rendering_templates/{template}".format(
template=sanitize_id(template),
),
base_address="api",
params=params,
options=options,
),
)
def archive(
self,
template: str,
params: "InvoiceRenderingTemplateService.ArchiveParams" = {},
options: RequestOptions = {},
) -> InvoiceRenderingTemplate:
"""
Updates the status of an invoice rendering template to ‘archived' so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.
"""
return cast(
InvoiceRenderingTemplate,
self._request(
"post",
"/v1/invoice_rendering_templates/{template}/archive".format(
template=sanitize_id(template),
),
base_address="api",
params=params,
options=options,
),
)
async def archive_async(
self,
template: str,
params: "InvoiceRenderingTemplateService.ArchiveParams" = {},
options: RequestOptions = {},
) -> InvoiceRenderingTemplate:
"""
Updates the status of an invoice rendering template to ‘archived' so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.
"""
return cast(
InvoiceRenderingTemplate,
await self._request_async(
"post",
"/v1/invoice_rendering_templates/{template}/archive".format(
template=sanitize_id(template),
),
base_address="api",
params=params,
options=options,
),
)
def unarchive(
self,
template: str,
params: "InvoiceRenderingTemplateService.UnarchiveParams" = {},
options: RequestOptions = {},
) -> InvoiceRenderingTemplate:
"""
Unarchive an invoice rendering template so it can be used on new Stripe objects again.
"""
return cast(
InvoiceRenderingTemplate,
self._request(
"post",
"/v1/invoice_rendering_templates/{template}/unarchive".format(
template=sanitize_id(template),
),
base_address="api",
params=params,
options=options,
),
)
async def unarchive_async(
self,
template: str,
params: "InvoiceRenderingTemplateService.UnarchiveParams" = {},
options: RequestOptions = {},
) -> InvoiceRenderingTemplate:
"""
Unarchive an invoice rendering template so it can be used on new Stripe objects again.
"""
return cast(
InvoiceRenderingTemplate,
await self._request_async(
"post",
"/v1/invoice_rendering_templates/{template}/unarchive".format(
template=sanitize_id(template),
),
base_address="api",
params=params,
options=options,
),
)
|
