Generated v5.3.0

CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## [v5.3.0](https://github.com/fastly/fastly-php/releases/tag/release/v5.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.
+
 ## [v5.2.0](https://github.com/fastly/fastly-php/releases/tag/release/v5.2.0) (2024-04-25)
 
 **Bug fixes:**

README.md

@@ -1,6 +1,6 @@
 # Fastly PHP
 
-A PHP client library for interacting with most facets of the [Fastly API](https://developer.fastly.com/reference/api).
+A PHP client library for interacting with most facets of the [Fastly API](https://www.fastly.com/documentation/reference/api/).
 
 
 ## Installation
@@ -59,7 +59,10 @@ try {
 
 ## Authorization
 
-The Fastly API requires an [API token](https://developer.fastly.com/reference/api/#authentication) for most operations.  Set it in the PHP client by using the `setApiToken` method of a configuration as shown:
+> [!NOTE]
+> The Fastly API requires an [API token](https://www.fastly.com/documentation/reference/api/#authentication) for most operations.
+
+Set up the API token in the PHP client by using the `setApiToken` method of a configuration as shown:
 
 ```php
 Fastly\Configuration::getDefaultConfiguration()->setApiToken('YOUR_API_TOKEN');
@@ -71,12 +74,16 @@ Alternatively, set the `FASTLY_API_TOKEN` environment variable instead of using
 Fastly\Configuration::getDefaultConfiguration();
 ```
 
-## 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
------------- | ------------- | -------------
+----- | ------ | -----------
 [*AclApi*](docs/Api/AclApi.md) | [**createAcl**](docs/Api/AclApi.md#createacl) | Create a new ACL
 [*AclApi*](docs/Api/AclApi.md) | [**deleteAcl**](docs/Api/AclApi.md#deleteacl) | Delete an ACL
 [*AclApi*](docs/Api/AclApi.md) | [**getAcl**](docs/Api/AclApi.md#getacl) | Describe an ACL
@@ -242,6 +249,8 @@ Class | Method | Description
 [*IamUserGroupsApi*](docs/Api/IamUserGroupsApi.md) | [**removeUserGroupRoles**](docs/Api/IamUserGroupsApi.md#removeusergrouproles) | Remove roles from a user group
 [*IamUserGroupsApi*](docs/Api/IamUserGroupsApi.md) | [**removeUserGroupServiceGroups**](docs/Api/IamUserGroupsApi.md#removeusergroupservicegroups) | Remove service groups from a user group
 [*IamUserGroupsApi*](docs/Api/IamUserGroupsApi.md) | [**updateAUserGroup**](docs/Api/IamUserGroupsApi.md#updateausergroup) | Update a user group
+[*ImageOptimizerDefaultSettingsApi*](docs/Api/ImageOptimizerDefaultSettingsApi.md) | [**getDefaultSettings**](docs/Api/ImageOptimizerDefaultSettingsApi.md#getdefaultsettings) | Get current Image Optimizer Default Settings
+[*ImageOptimizerDefaultSettingsApi*](docs/Api/ImageOptimizerDefaultSettingsApi.md) | [**updateDefaultSettings**](docs/Api/ImageOptimizerDefaultSettingsApi.md#updatedefaultsettings) | Update Image Optimizer Default Settings
 [*InvitationsApi*](docs/Api/InvitationsApi.md) | [**createInvitation**](docs/Api/InvitationsApi.md#createinvitation) | Create an invitation
 [*InvitationsApi*](docs/Api/InvitationsApi.md) | [**deleteInvitation**](docs/Api/InvitationsApi.md#deleteinvitation) | Delete an invitation
 [*InvitationsApi*](docs/Api/InvitationsApi.md) | [**listInvitations**](docs/Api/InvitationsApi.md#listinvitations) | List invitations
@@ -610,6 +619,8 @@ Class | Method | Description
 [*WholePlatformDdosHistoricalApi*](docs/Api/WholePlatformDdosHistoricalApi.md) | [**getPlatformDdosHistorical**](docs/Api/WholePlatformDdosHistoricalApi.md#getplatformddoshistorical) | Get historical DDoS metrics for the entire Fastly platform
 
 
+</details>
+
 ## Issues
 
 The fastly-php API client currently does not support the following endpoints:

docs/Api/AclApi.md

@@ -12,8 +12,11 @@ $apiInstance = new Fastly\Api\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

docs/Api/AclEntryApi.md

@@ -12,8 +12,11 @@ $apiInstance = new Fastly\Api\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

docs/Api/ApexRedirectApi.md

@@ -12,8 +12,11 @@ $apiInstance = new Fastly\Api\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

docs/Api/AutomationTokensApi.md

@@ -12,8 +12,11 @@ $apiInstance = new Fastly\Api\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

docs/Api/BackendApi.md

@@ -12,8 +12,11 @@ $apiInstance = new Fastly\Api\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

docs/Api/BillingAddressApi.md

@@ -12,8 +12,11 @@ $apiInstance = new Fastly\Api\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

docs/Api/BillingApi.md

@@ -12,8 +12,11 @@ $apiInstance = new Fastly\Api\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

docs/Api/BillingInvoicesApi.md

@@ -12,8 +12,11 @@ $apiInstance = new Fastly\Api\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.
 

docs/Api/CacheSettingsApi.md

@@ -12,8 +12,11 @@ $apiInstance = new Fastly\Api\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

docs/Api/ConditionApi.md

@@ -12,8 +12,11 @@ $apiInstance = new Fastly\Api\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

docs/Api/ConfigStoreApi.md

@@ -12,8 +12,11 @@ $apiInstance = new Fastly\Api\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

docs/Api/ConfigStoreItemApi.md

@@ -12,8 +12,11 @@ $apiInstance = new Fastly\Api\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

docs/Api/ContactApi.md

@@ -12,8 +12,11 @@ $apiInstance = new Fastly\Api\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

docs/Api/ContentApi.md

@@ -12,8 +12,11 @@ $apiInstance = new Fastly\Api\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's cache
 
 

docs/Api/CustomerApi.md

@@ -12,8 +12,11 @@ $apiInstance = new Fastly\Api\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

docs/Api/DictionaryApi.md

@@ -12,8 +12,11 @@ $apiInstance = new Fastly\Api\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

docs/Api/DictionaryInfoApi.md

@@ -12,8 +12,11 @@ $apiInstance = new Fastly\Api\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
 
 

docs/Api/DictionaryItemApi.md

@@ -12,8 +12,11 @@ $apiInstance = new Fastly\Api\DictionaryItemApi(
 
 ## Methods
 
-Method | Fastly API endpoint | Description
-------------- | ------------- | -------------
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
+
+Method | HTTP request | Description
+------ | ------------ | -----------
 [**bulkUpdateDictionaryItem()**](DictionaryItemApi.md#bulkUpdateDictionaryItem) | **PATCH** /service/{service_id}/dictionary/{dictionary_id}/items | Update multiple entries in an edge dictionary
 [**createDictionaryItem()**](DictionaryItemApi.md#createDictionaryItem) | **POST** /service/{service_id}/dictionary/{dictionary_id}/item | Create an entry in an edge dictionary
 [**deleteDictionaryItem()**](DictionaryItemApi.md#deleteDictionaryItem) | **DELETE** /service/{service_id}/dictionary/{dictionary_id}/item/{dictionary_item_key} | Delete an item from an edge dictionary

docs/Api/DiffApi.md

@@ -12,8 +12,11 @@ $apiInstance = new Fastly\Api\DiffApi(
 
 ## Methods
 
-Method | Fastly API endpoint | Description
-------------- | ------------- | -------------
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
+
+Method | HTTP request | Description
+------ | ------------ | -----------
 [**diffServiceVersions()**](DiffApi.md#diffServiceVersions) | **GET** /service/{service_id}/diff/from/{from_version_id}/to/{to_version_id} | Diff two service versions
 
 

docs/Api/DirectorApi.md

@@ -12,8 +12,11 @@ $apiInstance = new Fastly\Api\DirectorApi(
 
 ## Methods
 
-Method | Fastly API endpoint | Description
-------------- | ------------- | -------------
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
+
+Method | HTTP request | Description
+------ | ------------ | -----------
 [**createDirector()**](DirectorApi.md#createDirector) | **POST** /service/{service_id}/version/{version_id}/director | Create a director
 [**deleteDirector()**](DirectorApi.md#deleteDirector) | **DELETE** /service/{service_id}/version/{version_id}/director/{director_name} | Delete a director
 [**getDirector()**](DirectorApi.md#getDirector) | **GET** /service/{service_id}/version/{version_id}/director/{director_name} | Get a director

docs/Api/DirectorBackendApi.md

@@ -12,8 +12,11 @@ $apiInstance = new Fastly\Api\DirectorBackendApi(
 
 ## Methods
 
-Method | Fastly API endpoint | Description
-------------- | ------------- | -------------
+> [!NOTE]
+> All URIs are relative to `https://api.fastly.com`
+
+Method | HTTP request | Description
+------ | ------------ | -----------
 [**createDirectorBackend()**](DirectorBackendApi.md#createDirectorBackend) | **POST** /service/{service_id}/version/{version_id}/director/{director_name}/backend/{backend_name} | Create a director-backend relationship
 [**deleteDirectorBackend()**](DirectorBackendApi.md#deleteDirectorBackend) | **DELETE** /service/{service_id}/version/{version_id}/director/{director_name}/backend/{backend_name} | Delete a director-backend relationship
 [**getDirectorBackend()**](DirectorBackendApi.md#getDirectorBackend) | **GET** /service/{service_id}/version/{version_id}/director/{director_name}/backend/{backend_name} | Get a director-backend relationship