-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
github-actions
committed
Feb 28, 2024
1 parent
a5365f3
commit 074173c
Showing
118 changed files
with
8,383 additions
and
226 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| # Fastly\Api\BillingInvoicesApi | ||
|
|
||
|
|
||
| ```php | ||
| $apiInstance = new Fastly\Api\BillingInvoicesApi( | ||
| // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. | ||
| // This is optional, `GuzzleHttp\Client` will be used as default. | ||
| new GuzzleHttp\Client(), | ||
| $config | ||
| ); | ||
| ``` | ||
|
|
||
| ## Methods | ||
|
|
||
| Method | Fastly API endpoint | Description | ||
| ------------- | ------------- | ------------- | ||
| [**getInvoiceByInvoiceId()**](BillingInvoicesApi.md#getInvoiceByInvoiceId) | **GET** /billing/v3/invoices/{invoice_id} | Get invoice by ID. | ||
| [**listInvoices()**](BillingInvoicesApi.md#listInvoices) | **GET** /billing/v3/invoices | List of invoices. | ||
|
|
||
|
|
||
| ## `getInvoiceByInvoiceId()` | ||
|
|
||
| ```php | ||
| getInvoiceByInvoiceId($options): \Fastly\Model\InvoiceResponse // Get invoice by ID. | ||
| ``` | ||
|
|
||
| Returns invoice associated with the invoice id. | ||
|
|
||
| ### Example | ||
| ```php | ||
| $options['invoice_id'] = 'invoice_id_example'; // string | Alphanumeric string identifying the invoice. | ||
|
|
||
| try { | ||
| $result = $apiInstance->getInvoiceByInvoiceId($options); | ||
| } catch (Exception $e) { | ||
| echo 'Exception when calling BillingInvoicesApi->getInvoiceByInvoiceId: ', $e->getMessage(), PHP_EOL; | ||
| } | ||
| ``` | ||
|
|
||
| ### Options | ||
|
|
||
| Note: the input parameter is an associative array with the keys listed below. | ||
|
|
||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **invoice_id** | **string** | Alphanumeric string identifying the invoice. | | ||
|
|
||
| ### Return type | ||
|
|
||
| [**\Fastly\Model\InvoiceResponse**](../Model/InvoiceResponse.md) | ||
|
|
||
| [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) | ||
| [[Back to README]](../../README.md) | ||
|
|
||
| ## `listInvoices()` | ||
|
|
||
| ```php | ||
| listInvoices($options): \Fastly\Model\ListInvoicesResponse // List of invoices. | ||
| ``` | ||
|
|
||
| Returns the list of invoices, sorted by billing start date (newest to oldest). | ||
|
|
||
| ### Example | ||
| ```php | ||
| $options['billing_start_date'] = 2023-01-01T00:00:00Z; // string | ||
| $options['billing_end_date'] = 2023-01-31T00:00:00Z; // string | ||
| $options['limit'] = '100'; // string | Number of results per page. The maximum is 200. | ||
| $options['cursor'] = 'cursor_example'; // string | Cursor value from the `next_cursor` field of a previous response, used to retrieve the next page. To request the first page, this should be empty. | ||
|
|
||
| try { | ||
| $result = $apiInstance->listInvoices($options); | ||
| } catch (Exception $e) { | ||
| echo 'Exception when calling BillingInvoicesApi->listInvoices: ', $e->getMessage(), PHP_EOL; | ||
| } | ||
| ``` | ||
|
|
||
| ### Options | ||
|
|
||
| Note: the input parameter is an associative array with the keys listed below. | ||
|
|
||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **billing_start_date** | **string** | | [optional] | ||
| **billing_end_date** | **string** | | [optional] | ||
| **limit** | **string** | Number of results per page. The maximum is 200. | [optional] [defaults to '100'] | ||
| **cursor** | **string** | Cursor value from the `next_cursor` field of a previous response, used to retrieve the next page. To request the first page, this should be empty. | [optional] | ||
|
|
||
| ### Return type | ||
|
|
||
| [**\Fastly\Model\ListInvoicesResponse**](../Model/ListInvoicesResponse.md) | ||
|
|
||
| [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) | ||
| [[Back to README]](../../README.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.