Skip to content

Commit b6a18f3

Browse files
authored
docs(billing): specify for all tools (#315)
1 parent 0d5c846 commit b6a18f3

File tree

2 files changed

+58
-0
lines changed
  • scaleway-async/scaleway_async/billing/v2alpha1
  • scaleway/scaleway/billing/v2alpha1

2 files changed

+58
-0
lines changed

scaleway-async/scaleway_async/billing/v2alpha1/api.py

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,11 @@ async def get_consumption(
4141
organization_id: Optional[str] = None,
4242
) -> GetConsumptionResponse:
4343
"""
44+
Get current month's consumption.
45+
The consumption reflects the amount of money you have spent for the products you have used.
46+
The consumption value is monetary and is not computed in real time.
47+
:param organization_id: Filter by organization ID.
48+
:return: :class:`GetConsumptionResponse <GetConsumptionResponse>`
4449
4550
Usage:
4651
::
@@ -72,6 +77,16 @@ async def list_invoices(
7277
order_by: ListInvoicesRequestOrderBy = ListInvoicesRequestOrderBy.INVOICE_NUMBER_DESC,
7378
) -> ListInvoicesResponse:
7479
"""
80+
List invoices.
81+
List all your invoices, filtering by `start_date` and `invoice_type`. Each invoice has its own ID.
82+
:param organization_id: Organization ID to filter for, only invoices from this Organization will be returned.
83+
:param started_after: Invoice's `start_date` is greater or equal to `started_after`.
84+
:param started_before: Invoice's `start_date` precedes `started_before`.
85+
:param invoice_type: Invoice type. It can either be `periodic` or `purchase`.
86+
:param page: Positive integer to choose the page to return.
87+
:param page_size: Positive integer lower or equal to 100 to select the number of items to return.
88+
:param order_by: How invoices are ordered in the response.
89+
:return: :class:`ListInvoicesResponse <ListInvoicesResponse>`
7590
7691
Usage:
7792
::
@@ -109,6 +124,15 @@ async def list_invoices_all(
109124
order_by: Optional[ListInvoicesRequestOrderBy] = None,
110125
) -> List[Invoice]:
111126
"""
127+
List invoices.
128+
List all your invoices, filtering by `start_date` and `invoice_type`. Each invoice has its own ID.
129+
:param organization_id: Organization ID to filter for, only invoices from this Organization will be returned.
130+
:param started_after: Invoice's `start_date` is greater or equal to `started_after`.
131+
:param started_before: Invoice's `start_date` precedes `started_before`.
132+
:param invoice_type: Invoice type. It can either be `periodic` or `purchase`.
133+
:param page: Positive integer to choose the page to return.
134+
:param page_size: Positive integer lower or equal to 100 to select the number of items to return.
135+
:param order_by: How invoices are ordered in the response.
112136
:return: :class:`List[ListInvoicesResponse] <List[ListInvoicesResponse]>`
113137
114138
Usage:
@@ -139,6 +163,11 @@ async def download_invoice(
139163
file_type: DownloadInvoiceRequestFileType,
140164
) -> Optional[ScwFile]:
141165
"""
166+
Download an invoice.
167+
Download a specific invoice, specified by its ID.
168+
:param invoice_id: Invoice ID.
169+
:param file_type: Wanted file type.
170+
:return: :class:`Optional[ScwFile] <Optional[ScwFile]>`
142171
143172
Usage:
144173
::

scaleway/scaleway/billing/v2alpha1/api.py

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,11 @@ def get_consumption(
4141
organization_id: Optional[str] = None,
4242
) -> GetConsumptionResponse:
4343
"""
44+
Get current month's consumption.
45+
The consumption reflects the amount of money you have spent for the products you have used.
46+
The consumption value is monetary and is not computed in real time.
47+
:param organization_id: Filter by organization ID.
48+
:return: :class:`GetConsumptionResponse <GetConsumptionResponse>`
4449
4550
Usage:
4651
::
@@ -72,6 +77,16 @@ def list_invoices(
7277
order_by: ListInvoicesRequestOrderBy = ListInvoicesRequestOrderBy.INVOICE_NUMBER_DESC,
7378
) -> ListInvoicesResponse:
7479
"""
80+
List invoices.
81+
List all your invoices, filtering by `start_date` and `invoice_type`. Each invoice has its own ID.
82+
:param organization_id: Organization ID to filter for, only invoices from this Organization will be returned.
83+
:param started_after: Invoice's `start_date` is greater or equal to `started_after`.
84+
:param started_before: Invoice's `start_date` precedes `started_before`.
85+
:param invoice_type: Invoice type. It can either be `periodic` or `purchase`.
86+
:param page: Positive integer to choose the page to return.
87+
:param page_size: Positive integer lower or equal to 100 to select the number of items to return.
88+
:param order_by: How invoices are ordered in the response.
89+
:return: :class:`ListInvoicesResponse <ListInvoicesResponse>`
7590
7691
Usage:
7792
::
@@ -109,6 +124,15 @@ def list_invoices_all(
109124
order_by: Optional[ListInvoicesRequestOrderBy] = None,
110125
) -> List[Invoice]:
111126
"""
127+
List invoices.
128+
List all your invoices, filtering by `start_date` and `invoice_type`. Each invoice has its own ID.
129+
:param organization_id: Organization ID to filter for, only invoices from this Organization will be returned.
130+
:param started_after: Invoice's `start_date` is greater or equal to `started_after`.
131+
:param started_before: Invoice's `start_date` precedes `started_before`.
132+
:param invoice_type: Invoice type. It can either be `periodic` or `purchase`.
133+
:param page: Positive integer to choose the page to return.
134+
:param page_size: Positive integer lower or equal to 100 to select the number of items to return.
135+
:param order_by: How invoices are ordered in the response.
112136
:return: :class:`List[ListInvoicesResponse] <List[ListInvoicesResponse]>`
113137
114138
Usage:
@@ -139,6 +163,11 @@ def download_invoice(
139163
file_type: DownloadInvoiceRequestFileType,
140164
) -> Optional[ScwFile]:
141165
"""
166+
Download an invoice.
167+
Download a specific invoice, specified by its ID.
168+
:param invoice_id: Invoice ID.
169+
:param file_type: Wanted file type.
170+
:return: :class:`Optional[ScwFile] <Optional[ScwFile]>`
142171
143172
Usage:
144173
::

0 commit comments

Comments
 (0)