Skip to content

Commit

Permalink
Generated v8.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Dec 6, 2024
1 parent 08b56c4 commit d8bc210
Show file tree
Hide file tree
Showing 931 changed files with 7,732 additions and 1,163 deletions.
31 changes: 31 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,36 @@
# Changelog

## [v8.0.0](https://github.com/fastly/fastly-js/releases/tag/release/v8.0.0) (2024-12-05)

**Breaking Changes:**

- fix(udm-domains): Use v1 versioned HTTP endpoints for UDM domains
- fix(historical): Remove references to VCL on Compute metrics
- fix(realtime): Remove references to VCL on Compute metrics
- feat(billing-usage-metrics): Updated to v3 of the API

**Bug fixes:**

- fix(acls-in-compute): Corrected shape of `compute-acl-update` model.

**Enhancements:**

- feat(object-storage-access-keys): Added Object Storage Access Keys API
- feat(logging-grafanacloudlogs): Added Grafana Cloud Logs Loggin API
- feat(log-explorer): Added Log Explorer API
- feat(insights): Added Insights API
- feat(kv-store-item): Added `consistency` parameter to `get-keys` operation.
- feat(enabled-products): Added `mode` property to `set-configuration`.

**Documentation:**

- doc(observability-custom-dashboards): Fix bad link in custom dashboard documentation
- doc(observability-custom-dashboards): Reformat some enums to fix docs rendering
- doc(acls-in-compute): Corrections to descriptions of `compute-acl-lookup`, `compute-acl-list-entries`,
`compute-acl-update-entry`, and `compute-acl-update` structures
- doc(enabled-products): Added support for product ID `log_explorer_insights`.
- doc(enabled-products): Added support for product ID `ddos_protection`.

## [v7.10.0](https://github.com/fastly/fastly-js/releases/tag/release/v7.10.0) (2024-10-23)

**Documentation:**
Expand Down
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Class | Method | Description
*Fastly.BillingInvoicesApi* | [**getMonthToDateInvoice**](docs/BillingInvoicesApi.md#getMonthToDateInvoice) | Get month-to-date invoice.
*Fastly.BillingInvoicesApi* | [**listInvoices**](docs/BillingInvoicesApi.md#listInvoices) | List of invoices.
*Fastly.BillingUsageMetricsApi* | [**getServiceLevelUsage**](docs/BillingUsageMetricsApi.md#getServiceLevelUsage) | Retrieve service-level usage metrics for a product.
*Fastly.BillingUsageMetricsApi* | [**getServiceLevelUsageTypes**](docs/BillingUsageMetricsApi.md#getServiceLevelUsageTypes) | Retrieve product usage types for a customer.
*Fastly.BillingUsageMetricsApi* | [**getUsageMetrics**](docs/BillingUsageMetricsApi.md#getUsageMetrics) | Get monthly usage metrics
*Fastly.CacheSettingsApi* | [**createCacheSettings**](docs/CacheSettingsApi.md#createCacheSettings) | Create a cache settings object
*Fastly.CacheSettingsApi* | [**deleteCacheSettings**](docs/CacheSettingsApi.md#deleteCacheSettings) | Delete a cache settings object
*Fastly.CacheSettingsApi* | [**getCacheSettings**](docs/CacheSettingsApi.md#getCacheSettings) | Get a cache settings object
Expand Down Expand Up @@ -247,6 +247,7 @@ Class | Method | Description
*Fastly.IamUserGroupsApi* | [**updateAUserGroup**](docs/IamUserGroupsApi.md#updateAUserGroup) | Update a user group
*Fastly.ImageOptimizerDefaultSettingsApi* | [**getDefaultSettings**](docs/ImageOptimizerDefaultSettingsApi.md#getDefaultSettings) | Get current Image Optimizer Default Settings
*Fastly.ImageOptimizerDefaultSettingsApi* | [**updateDefaultSettings**](docs/ImageOptimizerDefaultSettingsApi.md#updateDefaultSettings) | Update Image Optimizer Default Settings
*Fastly.InsightsApi* | [**getLogInsights**](docs/InsightsApi.md#getLogInsights) | Retrieve log insights
*Fastly.InvitationsApi* | [**createInvitation**](docs/InvitationsApi.md#createInvitation) | Create an invitation
*Fastly.InvitationsApi* | [**deleteInvitation**](docs/InvitationsApi.md#deleteInvitation) | Delete an invitation
*Fastly.InvitationsApi* | [**listInvitations**](docs/InvitationsApi.md#listInvitations) | List invitations
Expand Down Expand Up @@ -286,6 +287,7 @@ Class | Method | Description
*Fastly.LegacyWafTagApi* | [**listLegacyWafTags**](docs/LegacyWafTagApi.md#listLegacyWafTags) | List WAF tags
*Fastly.LegacyWafUpdateStatusApi* | [**getWafUpdateStatus**](docs/LegacyWafUpdateStatusApi.md#getWafUpdateStatus) | Get the status of a WAF update
*Fastly.LegacyWafUpdateStatusApi* | [**listWafUpdateStatuses**](docs/LegacyWafUpdateStatusApi.md#listWafUpdateStatuses) | List update statuses
*Fastly.LogExplorerApi* | [**getLogRecords**](docs/LogExplorerApi.md#getLogRecords) | Retrieve log records
*Fastly.LoggingAzureblobApi* | [**createLogAzure**](docs/LoggingAzureblobApi.md#createLogAzure) | Create an Azure Blob Storage log endpoint
*Fastly.LoggingAzureblobApi* | [**deleteLogAzure**](docs/LoggingAzureblobApi.md#deleteLogAzure) | Delete the Azure Blob Storage log endpoint
*Fastly.LoggingAzureblobApi* | [**getLogAzure**](docs/LoggingAzureblobApi.md#getLogAzure) | Get an Azure Blob Storage log endpoint
Expand Down Expand Up @@ -326,6 +328,11 @@ Class | Method | Description
*Fastly.LoggingGcsApi* | [**getLogGcs**](docs/LoggingGcsApi.md#getLogGcs) | Get a GCS log endpoint
*Fastly.LoggingGcsApi* | [**listLogGcs**](docs/LoggingGcsApi.md#listLogGcs) | List GCS log endpoints
*Fastly.LoggingGcsApi* | [**updateLogGcs**](docs/LoggingGcsApi.md#updateLogGcs) | Update a GCS log endpoint
*Fastly.LoggingGrafanacloudlogsApi* | [**createLogGrafanacloudlogs**](docs/LoggingGrafanacloudlogsApi.md#createLogGrafanacloudlogs) | Create a Grafana Cloud Logs log endpoint
*Fastly.LoggingGrafanacloudlogsApi* | [**deleteLogGrafanacloudlogs**](docs/LoggingGrafanacloudlogsApi.md#deleteLogGrafanacloudlogs) | Delete the Grafana Cloud Logs log endpoint
*Fastly.LoggingGrafanacloudlogsApi* | [**getLogGrafanacloudlogs**](docs/LoggingGrafanacloudlogsApi.md#getLogGrafanacloudlogs) | Get a Grafana Cloud Logs log endpoint
*Fastly.LoggingGrafanacloudlogsApi* | [**listLogGrafanacloudlogs**](docs/LoggingGrafanacloudlogsApi.md#listLogGrafanacloudlogs) | List Grafana Cloud Logs log endpoints
*Fastly.LoggingGrafanacloudlogsApi* | [**updateLogGrafanacloudlogs**](docs/LoggingGrafanacloudlogsApi.md#updateLogGrafanacloudlogs) | Update a Grafana Cloud Logs log endpoint
*Fastly.LoggingHerokuApi* | [**createLogHeroku**](docs/LoggingHerokuApi.md#createLogHeroku) | Create a Heroku log endpoint
*Fastly.LoggingHerokuApi* | [**deleteLogHeroku**](docs/LoggingHerokuApi.md#deleteLogHeroku) | Delete the Heroku log endpoint
*Fastly.LoggingHerokuApi* | [**getLogHeroku**](docs/LoggingHerokuApi.md#getLogHeroku) | Get a Heroku log endpoint
Expand Down Expand Up @@ -426,6 +433,10 @@ Class | Method | Description
*Fastly.MutualAuthenticationApi* | [**getMutualAuthentication**](docs/MutualAuthenticationApi.md#getMutualAuthentication) | Get a Mutual Authentication
*Fastly.MutualAuthenticationApi* | [**listMutualAuthentications**](docs/MutualAuthenticationApi.md#listMutualAuthentications) | List Mutual Authentications
*Fastly.MutualAuthenticationApi* | [**patchMutualAuthentication**](docs/MutualAuthenticationApi.md#patchMutualAuthentication) | Update a Mutual Authentication
*Fastly.ObjectStorageAccessKeysApi* | [**createAccessKey**](docs/ObjectStorageAccessKeysApi.md#createAccessKey) | Create an access key
*Fastly.ObjectStorageAccessKeysApi* | [**deleteAccessKey**](docs/ObjectStorageAccessKeysApi.md#deleteAccessKey) | Delete an access key
*Fastly.ObjectStorageAccessKeysApi* | [**getAccessKey**](docs/ObjectStorageAccessKeysApi.md#getAccessKey) | Get an access key
*Fastly.ObjectStorageAccessKeysApi* | [**listAccessKeys**](docs/ObjectStorageAccessKeysApi.md#listAccessKeys) | List access keys
*Fastly.ObservabilityCustomDashboardsApi* | [**createDashboard**](docs/ObservabilityCustomDashboardsApi.md#createDashboard) | Create a new dashboard
*Fastly.ObservabilityCustomDashboardsApi* | [**deleteDashboard**](docs/ObservabilityCustomDashboardsApi.md#deleteDashboard) | Delete an existing dashboard
*Fastly.ObservabilityCustomDashboardsApi* | [**getDashboard**](docs/ObservabilityCustomDashboardsApi.md#getDashboard) | Retrieve a dashboard by ID
Expand Down Expand Up @@ -634,8 +645,8 @@ The fastly-js API client currently does not support the following endpoints:
- [`/alerts/history`](https://www.fastly.com/documentation/reference/api/observability/alerts/history) (GET)
- [`/dns/configurations/{dns_configuration_id}`](https://www.fastly.com/documentation/reference/api/) (DELETE, GET, PATCH)
- [`/dns/configurations`](https://www.fastly.com/documentation/reference/api/) (GET, POST)
- [`/domains/{domain_id}`](https://www.fastly.com/documentation/reference/api/) (DELETE, GET, PATCH)
- [`/domains`](https://www.fastly.com/documentation/reference/api/) (GET, POST)
- [`/domains/v1/{domain_id}`](https://www.fastly.com/documentation/reference/api/) (DELETE, GET, PATCH)
- [`/domains/v1`](https://www.fastly.com/documentation/reference/api/) (GET, POST)
- [`/notifications/integration-types`](https://developer.fastly.com/reference/api/observability/notification) (GET)
- [`/notifications/integrations/{integration_id}/rotateSigningKey`](https://developer.fastly.com/reference/api/observability/notification) (POST)
- [`/notifications/integrations/{integration_id}/signingKey`](https://developer.fastly.com/reference/api/observability/notification) (GET)
Expand Down
12 changes: 12 additions & 0 deletions docs/AccessKey.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Fastly.AccessKey

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**description** | **String** | A description of the access key. |
**permission** | **String** | The permissions granted to an access key. |
**buckets** | **[String]** | | [optional]


[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
15 changes: 15 additions & 0 deletions docs/AccessKeyResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Fastly.AccessKeyResponse

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_key** | **String** | Generated access key. | [optional]
**secret_key** | **String** | Generated secret key. | [optional]
**description** | **String** | Description for the access key. | [optional]
**permission** | **String** | Permissions granted to an access key. | [optional]
**buckets** | **[String]** | | [optional]
**created_at** | **Date** | Date and time in ISO 8601 format. | [optional] [readonly]


[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
6 changes: 3 additions & 3 deletions docs/AclsInComputeApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ Name | Type | Description | Notes
## `computeAclUpdateAcls`

```javascript
computeAclUpdateAcls({ acl_id, [compute_acl_update_entry] })
computeAclUpdateAcls({ acl_id, [compute_acl_update] })
```

Update an ACL.
Expand All @@ -242,7 +242,7 @@ Update an ACL.
```javascript
const options = {
acl_id: "acl_id_example", // required
compute_acl_update_entry: [new Fastly.ComputeAclUpdateEntry()],
compute_acl_update: new Fastly.ComputeAclUpdate(),
};

apiInstance.computeAclUpdateAcls(options)
Expand All @@ -259,7 +259,7 @@ apiInstance.computeAclUpdateAcls(options)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**acl_id** | **String** | |
**compute_acl_update_entry** | [**[ComputeAclUpdateEntry]**](ComputeAclUpdateEntry.md) | | [optional]
**compute_acl_update** | [**ComputeAclUpdate**](ComputeAclUpdate.md) | | [optional]

### Return type

Expand Down
30 changes: 12 additions & 18 deletions docs/BillingUsageMetricsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ const apiInstance = new Fastly.BillingUsageMetricsApi();
Method | HTTP request | Description
------ | ------------ | -----------
[**getServiceLevelUsage**](BillingUsageMetricsApi.md#getServiceLevelUsage) | **GET** /billing/v2/account_customers/{customer_id}/service-usage-metrics | Retrieve service-level usage metrics for a product.
[**getServiceLevelUsageTypes**](BillingUsageMetricsApi.md#getServiceLevelUsageTypes) | **GET** /billing/v2/account_customers/{customer_id}/service-usage-types | Retrieve product usage types for a customer.
[**getServiceLevelUsage**](BillingUsageMetricsApi.md#getServiceLevelUsage) | **GET** /billing/v3/service-usage-metrics | Retrieve service-level usage metrics for a product.
[**getUsageMetrics**](BillingUsageMetricsApi.md#getUsageMetrics) | **GET** /billing/v3/usage-metrics | Get monthly usage metrics


## `getServiceLevelUsage`

```javascript
getServiceLevelUsage({ customer_id, product_id, usage_type_name, time_granularity, [start_date, ][end_date, ][start_month, ][end_month, ][limit, ][cursor] })
getServiceLevelUsage({ product_id, usage_type_name, [start_month, ][end_month, ][limit, ][cursor] })
```

Returns product usage, broken down by service.
Expand All @@ -26,12 +26,8 @@ Returns product usage, broken down by service.

```javascript
const options = {
customer_id: "customer_id_example", // required
product_id: "product_id_example", // required
usage_type_name: "usage_type_name_example", // required
time_granularity: "time_granularity_example", // required
start_date: 2023-01-01,
end_date: 2023-01-31,
start_month: 2023-01,
end_month: 2023-03,
limit: "'5'",
Expand All @@ -51,12 +47,8 @@ apiInstance.getServiceLevelUsage(options)

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**customer_id** | **String** | Alphanumeric string identifying the customer. |
**product_id** | **String** | The product identifier for the metrics returned (e.g., `cdn_usage`). This field is not required for CSV requests. |
**usage_type_name** | **String** | The usage type name for the metrics returned (e.g., `North America Requests`). This field is not required for CSV requests. |
**time_granularity** | **String** | |
**start_date** | **String** | | [optional]
**end_date** | **String** | | [optional]
**start_month** | **String** | | [optional]
**end_month** | **String** | | [optional]
**limit** | **String** | Number of results per page. The maximum is 100. | [optional] [defaults to '5']
Expand All @@ -67,22 +59,23 @@ Name | Type | Description | Notes
[**Serviceusagemetrics**](Serviceusagemetrics.md)


## `getServiceLevelUsageTypes`
## `getUsageMetrics`

```javascript
getServiceLevelUsageTypes({ customer_id })
getUsageMetrics({ , [start_month, ][end_month] })
```

Returns product usage types reported by the customer's services.
Returns monthly usage metrics for customer by product.

### Example

```javascript
const options = {
customer_id: "customer_id_example", // required
start_month: 2023-01,
end_month: 2023-03,
};

apiInstance.getServiceLevelUsageTypes(options)
apiInstance.getUsageMetrics(options)
.then((data) => {
console.log(data, "API called successfully.");
})
Expand All @@ -95,11 +88,12 @@ apiInstance.getServiceLevelUsageTypes(options)

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**customer_id** | **String** | Alphanumeric string identifying the customer. |
**start_month** | **String** | | [optional]
**end_month** | **String** | | [optional]

### Return type

[**Serviceusagetypes**](Serviceusagetypes.md)
[**Usagemetric**](Usagemetric.md)


[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
Expand Down
10 changes: 10 additions & 0 deletions docs/ComputeAclUpdate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Fastly.ComputeAclUpdate

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**entries** | [**[ComputeAclUpdateEntry]**](ComputeAclUpdateEntry.md) | | [optional]


[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
12 changes: 12 additions & 0 deletions docs/DimensionAttributesCountryStats.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Fastly.DimensionAttributesCountryStats

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**country_chr** | **Number** | The cache hit ratio for the country. | [optional]
**country_error_rate** | **Number** | The error rate for the country. | [optional]
**country_request_rate** | **Number** | This country's percentage of the total requests. | [optional]


[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
10 changes: 10 additions & 0 deletions docs/DimensionAttributesRate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Fastly.DimensionAttributesRate

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**rate** | **Number** | The rate at which the value in the current dimension occurs. | [optional]


[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
10 changes: 10 additions & 0 deletions docs/DimensionBrowser.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Fastly.DimensionBrowser

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**browser** | **String** | The client's browser for this dimension. | [optional]


[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
10 changes: 10 additions & 0 deletions docs/DimensionContentType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Fastly.DimensionContentType

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**content_type** | **String** | The content type of the response for this dimension. | [optional]


[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
10 changes: 10 additions & 0 deletions docs/DimensionCountry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Fastly.DimensionCountry

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**country** | **String** | The client's country for this dimension. | [optional]


[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
10 changes: 10 additions & 0 deletions docs/DimensionDevice.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Fastly.DimensionDevice

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**device** | **String** | The client's device type for this dimension. | [optional]


[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
10 changes: 10 additions & 0 deletions docs/DimensionOs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Fastly.DimensionOs

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**os** | **String** | The client's operating system for this dimension. | [optional]


[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
10 changes: 10 additions & 0 deletions docs/DimensionResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Fastly.DimensionResponse

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**response** | **String** | The HTTP reason phrase for this dimension. | [optional]


[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
10 changes: 10 additions & 0 deletions docs/DimensionStatusCode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Fastly.DimensionStatusCode

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**status_code** | **String** | The HTTP response code for this dimension. | [optional]


[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
10 changes: 10 additions & 0 deletions docs/DimensionUrl.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Fastly.DimensionUrl

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**url** | **String** | The URL path for this dimension. | [optional]


[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
Loading

0 comments on commit d8bc210

Please sign in to comment.