Generated v7.3.0

fastly · May 24, 2024 · ba52a92 · ba52a92
1 parent f969fe5
commit ba52a92
Show file tree

Hide file tree

Showing 940 changed files with 3,125 additions and 1,848 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,25 @@
 # Changelog
 
+## [v7.3.0](https://github.com/fastly/fastly-js/releases/tag/release/v7.3.0) (2024-05-24)
+
+**Bug fixes:**
+
+- fix(backend): Correct tcp_keepalive_enable to be nullable
+- bugfix(resource): Correct `type_resource` accepted values
+- bugfix(sudo): Mark API to require authentication token
+
+**Enhancements:**
+
+- feat(image-optimizer-default-settings): Add Image Optimizer Default Settings APIs
+- feat(tls-subscriptions): Add `certificate_authority` filter parameter
+
+**Documentation:**
+
+- docs(generator): Update links in docs and comments with unified docs site URL structure
+- docs(generator): Clean up README by using GitHub alert icons and collapsible sections
+- doc(logging-kinesis): Update description of `format` field.
+- doc(tls-subscriptions): Update descriptions of `certificate_authority` and `tls_subscription_include` fields.
+
 ## [v7.2.0](https://github.com/fastly/fastly-js/releases/tag/release/v7.2.0) (2024-04-25)
 
 **Bug fixes:**

diff --git a/README.md b/README.md
@@ -1,8 +1,9 @@
 # Fastly
 
-An asynchronous JavaScript client library for interacting with most facets of the [Fastly API](https://developer.fastly.com/reference/api).
+An asynchronous JavaScript client library for interacting with most facets of the [Fastly API](https://www.fastly.com/documentation/reference/api/).
 
-> **NOTE:** This API client is auto-generated from Fastly's OpenAPI specification and may not function correctly when used on the Compute platform. Support for Compute is on the roadmap but has not yet been prioritised.
+> [!WARNING]
+> This API client is auto-generated from Fastly's OpenAPI specification and may not function correctly when used on the Compute platform. Support for Compute is on the roadmap but has not yet been prioritized.
 
 
 ## Usage
@@ -36,18 +37,25 @@ apiInstance.createAcl(options)
 
 ## Authorization
 
-The Fastly API requires an [API token](https://developer.fastly.com/reference/api/#authentication) for most operations. If the `FASTLY_API_TOKEN` environment variable is set, the client will automatically use it to authenticate all API requests. Alternatively, you may authenticate the client _instance_ with a Fastly API token, which will override the environment variable.
+> [!NOTE]
+> The Fastly API requires an [API token](https://www.fastly.com/documentation/reference/api/#authentication) for most operations.
+
+If the `FASTLY_API_TOKEN` environment variable is set, the client will automatically use it to authenticate all API requests. Alternatively, you may authenticate the client _instance_ with a Fastly API token, which will override the environment variable.
 
 ```javascript
 Fastly.ApiClient.instance.authenticate("YOUR_API_TOKEN");
 ```
 
-## Documentation for API Endpoints
+## API Endpoints
+
+The main documentation for the Fastly API can be found on our [Developer Hub](https://www.fastly.com/documentation/reference/api/).
 
-The main documentation for the Fastly API can be found on our [Developer Hub](https://developer.fastly.com/reference/api).
+<details>
+
+<summary>Table of API endpoints</summary>
 
 Class | Method | Description
---- | --- | ---
+----- | ------ | -----------
 *Fastly.AclApi* | [**createAcl**](docs/AclApi.md#createAcl) | Create a new ACL
 *Fastly.AclApi* | [**deleteAcl**](docs/AclApi.md#deleteAcl) | Delete an ACL
 *Fastly.AclApi* | [**getAcl**](docs/AclApi.md#getAcl) | Describe an ACL
@@ -213,6 +221,8 @@ Class | Method | Description
 *Fastly.IamUserGroupsApi* | [**removeUserGroupRoles**](docs/IamUserGroupsApi.md#removeUserGroupRoles) | Remove roles from a user group
 *Fastly.IamUserGroupsApi* | [**removeUserGroupServiceGroups**](docs/IamUserGroupsApi.md#removeUserGroupServiceGroups) | Remove service groups from a user group
 *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.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
@@ -581,6 +591,8 @@ Class | Method | Description
 *Fastly.WholePlatformDdosHistoricalApi* | [**getPlatformDdosHistorical**](docs/WholePlatformDdosHistoricalApi.md#getPlatformDdosHistorical) | Get historical DDoS metrics for the entire Fastly platform
 
 
+</details>
+
 ## Issues
 
 The fastly-js API client currently does not support the following endpoints:

diff --git a/docs/AclApi.md b/docs/AclApi.md
@@ -5,8 +5,11 @@ const apiInstance = new Fastly.AclApi();
 ```
 ## Methods
 
-Method | Fastly API endpoint | Description
-------------- | ------------- | -------------
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
+
+Method | HTTP request | Description
+------ | ------------ | -----------
 [**createAcl**](AclApi.md#createAcl) | **POST** /service/{service_id}/version/{version_id}/acl | Create a new ACL
 [**deleteAcl**](AclApi.md#deleteAcl) | **DELETE** /service/{service_id}/version/{version_id}/acl/{acl_name} | Delete an ACL
 [**getAcl**](AclApi.md#getAcl) | **GET** /service/{service_id}/version/{version_id}/acl/{acl_name} | Describe an ACL

diff --git a/docs/AclEntryApi.md b/docs/AclEntryApi.md
@@ -5,8 +5,11 @@ const apiInstance = new Fastly.AclEntryApi();
 ```
 ## Methods
 
-Method | Fastly API endpoint | Description
-------------- | ------------- | -------------
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
+
+Method | HTTP request | Description
+------ | ------------ | -----------
 [**bulkUpdateAclEntries**](AclEntryApi.md#bulkUpdateAclEntries) | **PATCH** /service/{service_id}/acl/{acl_id}/entries | Update multiple ACL entries
 [**createAclEntry**](AclEntryApi.md#createAclEntry) | **POST** /service/{service_id}/acl/{acl_id}/entry | Create an ACL entry
 [**deleteAclEntry**](AclEntryApi.md#deleteAclEntry) | **DELETE** /service/{service_id}/acl/{acl_id}/entry/{acl_entry_id} | Delete an ACL entry

diff --git a/docs/ApexRedirectApi.md b/docs/ApexRedirectApi.md
@@ -5,8 +5,11 @@ const apiInstance = new Fastly.ApexRedirectApi();
 ```
 ## Methods
 
-Method | Fastly API endpoint | Description
-------------- | ------------- | -------------
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
+
+Method | HTTP request | Description
+------ | ------------ | -----------
 [**createApexRedirect**](ApexRedirectApi.md#createApexRedirect) | **POST** /service/{service_id}/version/{version_id}/apex-redirects | Create an apex redirect
 [**deleteApexRedirect**](ApexRedirectApi.md#deleteApexRedirect) | **DELETE** /apex-redirects/{apex_redirect_id} | Delete an apex redirect
 [**getApexRedirect**](ApexRedirectApi.md#getApexRedirect) | **GET** /apex-redirects/{apex_redirect_id} | Get an apex redirect

diff --git a/docs/AutomationTokensApi.md b/docs/AutomationTokensApi.md
@@ -5,8 +5,11 @@ const apiInstance = new Fastly.AutomationTokensApi();
 ```
 ## Methods
 
-Method | Fastly API endpoint | Description
-------------- | ------------- | -------------
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
+
+Method | HTTP request | Description
+------ | ------------ | -----------
 [**createAutomationToken**](AutomationTokensApi.md#createAutomationToken) | **POST** /automation-tokens | Create Automation Token
 [**getAutomationTokenId**](AutomationTokensApi.md#getAutomationTokenId) | **GET** /automation-tokens/{id} | Retrieve an Automation Token by ID
 [**getAutomationTokensIdServices**](AutomationTokensApi.md#getAutomationTokensIdServices) | **GET** /automation-tokens/{id}/services | List Automation Token Services

diff --git a/docs/BackendApi.md b/docs/BackendApi.md
@@ -5,8 +5,11 @@ const apiInstance = new Fastly.BackendApi();
 ```
 ## Methods
 
-Method | Fastly API endpoint | Description
-------------- | ------------- | -------------
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
+
+Method | HTTP request | Description
+------ | ------------ | -----------
 [**createBackend**](BackendApi.md#createBackend) | **POST** /service/{service_id}/version/{version_id}/backend | Create a backend
 [**deleteBackend**](BackendApi.md#deleteBackend) | **DELETE** /service/{service_id}/version/{version_id}/backend/{backend_name} | Delete a backend
 [**getBackend**](BackendApi.md#getBackend) | **GET** /service/{service_id}/version/{version_id}/backend/{backend_name} | Describe a backend

diff --git a/docs/BillingAddressApi.md b/docs/BillingAddressApi.md
@@ -5,8 +5,11 @@ const apiInstance = new Fastly.BillingAddressApi();
 ```
 ## Methods
 
-Method | Fastly API endpoint | Description
-------------- | ------------- | -------------
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
+
+Method | HTTP request | Description
+------ | ------------ | -----------
 [**addBillingAddr**](BillingAddressApi.md#addBillingAddr) | **POST** /customer/{customer_id}/billing_address | Add a billing address to a customer
 [**deleteBillingAddr**](BillingAddressApi.md#deleteBillingAddr) | **DELETE** /customer/{customer_id}/billing_address | Delete a billing address
 [**getBillingAddr**](BillingAddressApi.md#getBillingAddr) | **GET** /customer/{customer_id}/billing_address | Get a billing address

diff --git a/docs/BillingApi.md b/docs/BillingApi.md
@@ -5,8 +5,11 @@ const apiInstance = new Fastly.BillingApi();
 ```
 ## Methods
 
-Method | Fastly API endpoint | Description
-------------- | ------------- | -------------
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
+
+Method | HTTP request | Description
+------ | ------------ | -----------
 [**getInvoice**](BillingApi.md#getInvoice) | **GET** /billing/v2/year/{year}/month/{month} | Get an invoice
 [**getInvoiceById**](BillingApi.md#getInvoiceById) | **GET** /billing/v2/account_customers/{customer_id}/invoices/{invoice_id} | Get an invoice
 [**getInvoiceMtd**](BillingApi.md#getInvoiceMtd) | **GET** /billing/v2/account_customers/{customer_id}/mtd_invoice | Get month-to-date billing estimate

diff --git a/docs/BillingInvoicesApi.md b/docs/BillingInvoicesApi.md
@@ -5,8 +5,11 @@ const apiInstance = new Fastly.BillingInvoicesApi();
 ```
 ## Methods
 
-Method | Fastly API endpoint | Description
-------------- | ------------- | -------------
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
+
+Method | HTTP request | 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.
 

diff --git a/docs/CacheSettingsApi.md b/docs/CacheSettingsApi.md
@@ -5,8 +5,11 @@ const apiInstance = new Fastly.CacheSettingsApi();
 ```
 ## Methods
 
-Method | Fastly API endpoint | Description
-------------- | ------------- | -------------
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
+
+Method | HTTP request | Description
+------ | ------------ | -----------
 [**createCacheSettings**](CacheSettingsApi.md#createCacheSettings) | **POST** /service/{service_id}/version/{version_id}/cache_settings | Create a cache settings object
 [**deleteCacheSettings**](CacheSettingsApi.md#deleteCacheSettings) | **DELETE** /service/{service_id}/version/{version_id}/cache_settings/{cache_settings_name} | Delete a cache settings object
 [**getCacheSettings**](CacheSettingsApi.md#getCacheSettings) | **GET** /service/{service_id}/version/{version_id}/cache_settings/{cache_settings_name} | Get a cache settings object

diff --git a/docs/ConditionApi.md b/docs/ConditionApi.md
@@ -5,8 +5,11 @@ const apiInstance = new Fastly.ConditionApi();
 ```
 ## Methods
 
-Method | Fastly API endpoint | Description
-------------- | ------------- | -------------
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
+
+Method | HTTP request | Description
+------ | ------------ | -----------
 [**createCondition**](ConditionApi.md#createCondition) | **POST** /service/{service_id}/version/{version_id}/condition | Create a condition
 [**deleteCondition**](ConditionApi.md#deleteCondition) | **DELETE** /service/{service_id}/version/{version_id}/condition/{condition_name} | Delete a condition
 [**getCondition**](ConditionApi.md#getCondition) | **GET** /service/{service_id}/version/{version_id}/condition/{condition_name} | Describe a condition

diff --git a/docs/ConfigStoreApi.md b/docs/ConfigStoreApi.md
@@ -5,8 +5,11 @@ const apiInstance = new Fastly.ConfigStoreApi();
 ```
 ## Methods
 
-Method | Fastly API endpoint | Description
-------------- | ------------- | -------------
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
+
+Method | HTTP request | Description
+------ | ------------ | -----------
 [**createConfigStore**](ConfigStoreApi.md#createConfigStore) | **POST** /resources/stores/config | Create a config store
 [**deleteConfigStore**](ConfigStoreApi.md#deleteConfigStore) | **DELETE** /resources/stores/config/{config_store_id} | Delete a config store
 [**getConfigStore**](ConfigStoreApi.md#getConfigStore) | **GET** /resources/stores/config/{config_store_id} | Describe a config store

diff --git a/docs/ConfigStoreItemApi.md b/docs/ConfigStoreItemApi.md
@@ -5,8 +5,11 @@ const apiInstance = new Fastly.ConfigStoreItemApi();
 ```
 ## Methods
 
-Method | Fastly API endpoint | Description
-------------- | ------------- | -------------
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
+
+Method | HTTP request | Description
+------ | ------------ | -----------
 [**bulkUpdateConfigStoreItem**](ConfigStoreItemApi.md#bulkUpdateConfigStoreItem) | **PATCH** /resources/stores/config/{config_store_id}/items | Update multiple entries in a config store
 [**createConfigStoreItem**](ConfigStoreItemApi.md#createConfigStoreItem) | **POST** /resources/stores/config/{config_store_id}/item | Create an entry in a config store
 [**deleteConfigStoreItem**](ConfigStoreItemApi.md#deleteConfigStoreItem) | **DELETE** /resources/stores/config/{config_store_id}/item/{config_store_item_key} | Delete an item from a config store

diff --git a/docs/ContactApi.md b/docs/ContactApi.md
@@ -5,8 +5,11 @@ const apiInstance = new Fastly.ContactApi();
 ```
 ## Methods
 
-Method | Fastly API endpoint | Description
-------------- | ------------- | -------------
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
+
+Method | HTTP request | Description
+------ | ------------ | -----------
 [**createContacts**](ContactApi.md#createContacts) | **POST** /customer/{customer_id}/contacts | Add a new customer contact
 [**deleteContact**](ContactApi.md#deleteContact) | **DELETE** /customer/{customer_id}/contact/{contact_id} | Delete a contact
 [**listContacts**](ContactApi.md#listContacts) | **GET** /customer/{customer_id}/contacts | List contacts

diff --git a/docs/ContentApi.md b/docs/ContentApi.md
@@ -5,8 +5,11 @@ const apiInstance = new Fastly.ContentApi();
 ```
 ## Methods
 
-Method | Fastly API endpoint | Description
-------------- | ------------- | -------------
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
+
+Method | HTTP request | Description
+------ | ------------ | -----------
 [**contentCheck**](ContentApi.md#contentCheck) | **GET** /content/edge_check | Check status of content in each POP&#39;s cache
 
 

diff --git a/docs/CustomerApi.md b/docs/CustomerApi.md
@@ -5,8 +5,11 @@ const apiInstance = new Fastly.CustomerApi();
 ```
 ## Methods
 
-Method | Fastly API endpoint | Description
-------------- | ------------- | -------------
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
+
+Method | HTTP request | Description
+------ | ------------ | -----------
 [**deleteCustomer**](CustomerApi.md#deleteCustomer) | **DELETE** /customer/{customer_id} | Delete a customer
 [**getCustomer**](CustomerApi.md#getCustomer) | **GET** /customer/{customer_id} | Get a customer
 [**getLoggedInCustomer**](CustomerApi.md#getLoggedInCustomer) | **GET** /current_customer | Get the logged in customer

diff --git a/docs/DefaultSettings.md b/docs/DefaultSettings.md
@@ -0,0 +1,16 @@
+# Fastly.DefaultSettings
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**resize_filter** | **String** | The type of filter to use while resizing an image. | [optional]  [one of: "lanczos3", "lanczos2", "bicubic", "bilinear", "nearest"]
+**webp** | **Boolean** | Controls whether or not to default to WebP output when the client supports it. This is equivalent to adding \&quot;auto&#x3D;webp\&quot; to all image optimizer requests.  | [optional]  [defaults to false]
+**webp_quality** | **Number** | The default quality to use with WebP output. This can be overridden with the second option in the \&quot;quality\&quot; URL parameter on specific image optimizer requests.  | [optional]  [defaults to 85]
+**jpeg_type** | **String** | The default type of JPEG output to use. This can be overridden with \&quot;format&#x3D;bjpeg\&quot; and \&quot;format&#x3D;pjpeg\&quot; on specific image optimizer requests.  | [optional]  [one of: "auto", "baseline", "progressive"]
+**jpeg_quality** | **Number** | The default quality to use with JPEG output. This can be overridden with the \&quot;quality\&quot; parameter on specific image optimizer requests.  | [optional]  [defaults to 85]
+**upscale** | **Boolean** | Whether or not we should allow output images to render at sizes larger than input.  | [optional]  [defaults to false]
+**allow_video** | **Boolean** | Enables GIF to MP4 transformations on this service. | [optional]  [defaults to false]
+
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/DefaultSettingsError.md b/docs/DefaultSettingsError.md
@@ -0,0 +1,12 @@
+# Fastly.DefaultSettingsError
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **String** |  | [optional] 
+**type** | **String** |  | [optional] 
+**detail** | **String** |  | [optional] 
+
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/DefaultSettingsResponse.md b/docs/DefaultSettingsResponse.md
@@ -0,0 +1,16 @@
+# Fastly.DefaultSettingsResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**resize_filter** | **String** | The type of filter to use while resizing an image. |  [one of: "lanczos3", "lanczos2", "bicubic", "bilinear", "nearest"]
+**webp** | **Boolean** | Controls whether or not to default to WebP output when the client supports it. This is equivalent to adding \&quot;auto&#x3D;webp\&quot; to all image optimizer requests.  |  [defaults to false]
+**webp_quality** | **Number** | The default quality to use with WebP output. This can be overridden with the second option in the \&quot;quality\&quot; URL parameter on specific image optimizer requests.  |  [defaults to 85]
+**jpeg_type** | **String** | The default type of JPEG output to use. This can be overridden with \&quot;format&#x3D;bjpeg\&quot; and \&quot;format&#x3D;pjpeg\&quot; on specific image optimizer requests.  |  [one of: "auto", "baseline", "progressive"]
+**jpeg_quality** | **Number** | The default quality to use with JPEG output. This can be overridden with the \&quot;quality\&quot; parameter on specific image optimizer requests.  |  [defaults to 85]
+**upscale** | **Boolean** | Whether or not we should allow output images to render at sizes larger than input.  |  [defaults to false]
+**allow_video** | **Boolean** | Enables GIF to MP4 transformations on this service. |  [defaults to false]
+
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/DictionaryApi.md b/docs/DictionaryApi.md
@@ -5,8 +5,11 @@ const apiInstance = new Fastly.DictionaryApi();
 ```
 ## Methods
 
-Method | Fastly API endpoint | Description
-------------- | ------------- | -------------
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
+
+Method | HTTP request | Description
+------ | ------------ | -----------
 [**createDictionary**](DictionaryApi.md#createDictionary) | **POST** /service/{service_id}/version/{version_id}/dictionary | Create an edge dictionary
 [**deleteDictionary**](DictionaryApi.md#deleteDictionary) | **DELETE** /service/{service_id}/version/{version_id}/dictionary/{dictionary_name} | Delete an edge dictionary
 [**getDictionary**](DictionaryApi.md#getDictionary) | **GET** /service/{service_id}/version/{version_id}/dictionary/{dictionary_name} | Get an edge dictionary

diff --git a/docs/DictionaryInfoApi.md b/docs/DictionaryInfoApi.md
@@ -5,8 +5,11 @@ const apiInstance = new Fastly.DictionaryInfoApi();
 ```
 ## Methods
 
-Method | Fastly API endpoint | Description
-------------- | ------------- | -------------
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
+
+Method | HTTP request | Description
+------ | ------------ | -----------
 [**getDictionaryInfo**](DictionaryInfoApi.md#getDictionaryInfo) | **GET** /service/{service_id}/version/{version_id}/dictionary/{dictionary_id}/info | Get edge dictionary metadata