Generated v3.3.0

fastly · Apr 5, 2023 · 897c6e6 · 897c6e6
1 parent e77d849
commit 897c6e6
Show file tree

Hide file tree

Showing 674 changed files with 3,080 additions and 1,117 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,24 @@
 # Changelog
 
-## [v3.2.0](https://github.com/fastly/fastly-js/releases/tag/v3.2.0) (2023-03-21)
+## [v3.3.0](https://github.com/fastly/fastly-js/releases/tag/release/v3.3.0) (2023-04-05)
+
+**Bug fixes:**
+
+- fix(purge): avoid encodeURIComponent with x-allow-reserved
+
+**Enhancements:**
+
+- feat(domain-ownership): list API endpoint
+- feat(object-store): items API endpoints
+- feat(object-store): add 'location' property to 'create_store'
+- feat(object-store): add 'force' property to 'delete_store'
+- feat(realtime): additional DDoS properties
+
+**Documentation:**
+
+- docs(acl-entries): document batch updating
+
+## [v3.2.0](https://github.com/fastly/fastly-js/releases/tag/release/v3.2.0) (2023-03-21)
 
 ## Bug fixes
 

diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ An asynchronous JavaScript client library for interacting with most facets of th
 > The previous 2.x version is no longer supported, but can be found at https://github.com/thisandagain/fastly.
 
 
-> ⚠️ This client library (`3.2.0`)  is an early-access release. Features may change without notice. Use at your own risk.
+> ⚠️ This client library (`3.3.0`)  is an early-access release. Features may change without notice. Use at your own risk.
 
 **We strongly recommend that you do not install alpha and beta releases on live production services.** No official support is provided for such releases. Please try out the library in a test environment, see what breaks without worrying about consequences, and give us [feedback](#issues).
 
@@ -135,6 +135,7 @@ Class | Method | Description
 *Fastly.DomainApi* | [**getDomain**](docs/DomainApi.md#getDomain) | Describe a domain
 *Fastly.DomainApi* | [**listDomains**](docs/DomainApi.md#listDomains) | List domains
 *Fastly.DomainApi* | [**updateDomain**](docs/DomainApi.md#updateDomain) | Update a domain
+*Fastly.DomainOwnershipsApi* | [**listDomainOwnerships**](docs/DomainOwnershipsApi.md#listDomainOwnerships) | List domain-ownerships
 *Fastly.EnabledProductsApi* | [**disableProduct**](docs/EnabledProductsApi.md#disableProduct) | Disable a product
 *Fastly.EnabledProductsApi* | [**enableProduct**](docs/EnabledProductsApi.md#enableProduct) | Enable a product
 *Fastly.EnabledProductsApi* | [**getEnabledProduct**](docs/EnabledProductsApi.md#getEnabledProduct) | Get enabled product
@@ -322,6 +323,10 @@ Class | Method | Description
 *Fastly.ObjectStoreApi* | [**deleteStore**](docs/ObjectStoreApi.md#deleteStore) | Delete an object store.
 *Fastly.ObjectStoreApi* | [**getStore**](docs/ObjectStoreApi.md#getStore) | Describe an object store.
 *Fastly.ObjectStoreApi* | [**getStores**](docs/ObjectStoreApi.md#getStores) | List object stores.
+*Fastly.ObjectStoreItemApi* | [**deleteKeyFromStore**](docs/ObjectStoreItemApi.md#deleteKeyFromStore) | Delete object store item.
+*Fastly.ObjectStoreItemApi* | [**getKeys**](docs/ObjectStoreItemApi.md#getKeys) | List object store keys.
+*Fastly.ObjectStoreItemApi* | [**getValueForKey**](docs/ObjectStoreItemApi.md#getValueForKey) | Get the value of an object store item
+*Fastly.ObjectStoreItemApi* | [**setValueForKey**](docs/ObjectStoreItemApi.md#setValueForKey) | Insert an item into an object store
 *Fastly.PackageApi* | [**getPackage**](docs/PackageApi.md#getPackage) | Get details of the service&#39;s Compute@Edge package.
 *Fastly.PackageApi* | [**putPackage**](docs/PackageApi.md#putPackage) | Upload a Compute@Edge package.
 *Fastly.PoolApi* | [**createServerPool**](docs/PoolApi.md#createServerPool) | Create a server pool
@@ -470,6 +475,93 @@ Class | Method | Description
 
 ## Issues
 
+The fastly-js API client currently does not support the following endpoints:
+
+- [`/customer/{customer_id}/contacts`](https://developer.fastly.com/reference/api/account/contact) (POST)
+- [`/metrics/domains/services/{service_id}`](https://developer.fastly.com/reference/api/metrics-stats/domain-inspector/historical) (GET)
+- [`/metrics/origins/services/{service_id}`](https://developer.fastly.com/reference/api/metrics-stats/origin-inspector/historical) (GET)
+- [`/rate-limiters/{rate_limiter_id}`](https://developer.fastly.com/reference/api/vcl-services/rate-limiter) (PUT)
+- [`/resources/stores/config/{config_store_id}/info`](https://developer.fastly.com/reference/api/services/resources/config-store) (GET)
+- [`/resources/stores/config/{config_store_id}/item/{config_store_item_key}`](https://developer.fastly.com/reference/api/services/resources/config-store-item) (DELETE, GET, PATCH, PUT)
+- [`/resources/stores/config/{config_store_id}/item`](https://developer.fastly.com/reference/api/services/resources/config-store-item) (POST)
+- [`/resources/stores/config/{config_store_id}/items`](https://developer.fastly.com/reference/api/services/resources/config-store-item) (GET, PATCH)
+- [`/resources/stores/config/{config_store_id}/services`](https://developer.fastly.com/reference/api/services/resources/config-store) (GET)
+- [`/resources/stores/config/{config_store_id}`](https://developer.fastly.com/reference/api/services/resources/config-store) (DELETE, GET, PUT)
+- [`/resources/stores/config`](https://developer.fastly.com/reference/api/services/resources/config-store) (GET, POST)
+- [`/resources/stores/secret/client-key`](https://developer.fastly.com/reference/api/services/resources/secret-store) (POST)
+- [`/resources/stores/secret/signing-key`](https://developer.fastly.com/reference/api/services/resources/secret-store) (GET)
+- [`/resources/stores/secret/{store_id}/secrets/{secret_name}`](https://developer.fastly.com/reference/api/services/resources/secret) (DELETE, GET)
+- [`/resources/stores/secret/{store_id}/secrets`](https://developer.fastly.com/reference/api/services/resources/secret) (GET, POST)
+- [`/resources/stores/secret/{store_id}`](https://developer.fastly.com/reference/api/services/resources/secret-store) (DELETE, GET)
+- [`/resources/stores/secret`](https://developer.fastly.com/reference/api/services/resources/secret-store) (GET, POST)
+- [`/roles/{role_id}/permissions`](https://developer.fastly.com/reference/api/account/roles) (DELETE, POST)
+- [`/roles/{role_id}`](https://developer.fastly.com/reference/api/account/roles) (PATCH)
+- [`/roles`](https://developer.fastly.com/reference/api/account/roles) (POST)
+- [`/service-authorizations`](https://developer.fastly.com/reference/api/account/service-authorization) (DELETE, PATCH)
+- [`/service-groups/{service_group_id}/services`](https://developer.fastly.com/reference/api/account/service-groups) (DELETE, POST)
+- [`/service-groups/{service_group_id}`](https://developer.fastly.com/reference/api/account/service-groups) (PATCH)
+- [`/service-groups`](https://developer.fastly.com/reference/api/account/service-groups) (POST)
+- [`/service/{service_id}/dictionary/{dictionary_id}/items`](https://developer.fastly.com/reference/api/dictionaries/dictionary-item) (PATCH)
+- [`/service/{service_id}/lint`](https://developer.fastly.com/reference/api/vcl-services/vcl) (POST)
+- [`/service/{service_id}/version/{version_id}/apex-redirects`](https://developer.fastly.com/reference/api/vcl-services/apex-redirect) (POST)
+- [`/service/{service_id}/version/{version_id}/boilerplate`](https://developer.fastly.com/reference/api/vcl-services/vcl) (GET)
+- [`/service/{service_id}/version/{version_id}/director/{director_name}`](https://developer.fastly.com/reference/api/load-balancing/directors/director) (PUT)
+- [`/service/{service_id}/version/{version_id}/generated_vcl/content`](https://developer.fastly.com/reference/api/vcl-services/vcl) (GET)
+- [`/service/{service_id}/version/{version_id}/generated_vcl`](https://developer.fastly.com/reference/api/vcl-services/vcl) (GET)
+- [`/service/{service_id}/version/{version_id}/logging/kafka/{logging_kafka_name}`](https://developer.fastly.com/reference/api/logging/kafka) (PUT)
+- [`/service/{service_id}/version/{version_id}/logging/kinesis/{logging_kinesis_name}`](https://developer.fastly.com/reference/api/logging/kinesis) (PUT)
+- [`/service/{service_id}/version/{version_id}/rate-limiters`](https://developer.fastly.com/reference/api/vcl-services/rate-limiter) (POST)
+- [`/service/{service_id}/version/{version_id}/request_settings`](https://developer.fastly.com/reference/api/vcl-services/request-settings) (POST)
+- [`/service/{service_id}/version/{version_id}/response_object/{response_object_name}`](https://developer.fastly.com/reference/api/vcl-services/response-object) (PUT)
+- [`/service/{service_id}/version/{version_id}/response_object`](https://developer.fastly.com/reference/api/vcl-services/response-object) (POST)
+- [`/service/{service_id}/version/{version_id}/snippet/{snippet_name}`](https://developer.fastly.com/reference/api/vcl-services/snippet) (PUT)
+- [`/service/{service_id}/version/{version_id}/vcl/{vcl_name}/content`](https://developer.fastly.com/reference/api/vcl-services/vcl) (GET)
+- [`/service/{service_id}/version/{version_id}/vcl/{vcl_name}/download`](https://developer.fastly.com/reference/api/vcl-services/vcl) (GET)
+- [`/service/{service_id}/version/{version_id}/vcl/{vcl_name}/main`](https://developer.fastly.com/reference/api/vcl-services/vcl) (PUT)
+- [`/service/{service_id}/version/{version_id}/vcl/{vcl_name}`](https://developer.fastly.com/reference/api/vcl-services/vcl) (DELETE, GET, PUT)
+- [`/service/{service_id}/version/{version_id}/vcl`](https://developer.fastly.com/reference/api/vcl-services/vcl) (GET, POST)
+- [`/service/{service_id}/version/{version_id}/wafs/{firewall_id}`](https://developer.fastly.com/reference/api/legacy-waf/firewall) (GET, PATCH)
+- [`/service/{service_id}/version/{version_id}/wafs`](https://developer.fastly.com/reference/api/legacy-waf/firewall) (GET, POST)
+- [`/service/{service_id}/wafs/{firewall_id}/owasp`](https://developer.fastly.com/reference/api/legacy-waf/owasp) (GET, PATCH, POST)
+- [`/service/{service_id}/wafs/{firewall_id}/rule_statuses`](https://developer.fastly.com/reference/api/legacy-waf/rule-status) (GET, POST)
+- [`/service/{service_id}/wafs/{firewall_id}/rules/{waf_rule_id}/rule_status`](https://developer.fastly.com/reference/api/legacy-waf/rule-status) (GET, PATCH)
+- [`/service/{service_id}/wafs/{firewall_id}/ruleset/preview`](https://developer.fastly.com/reference/api/legacy-waf/ruleset) (GET)
+- [`/service/{service_id}/wafs/{firewall_id}/ruleset`](https://developer.fastly.com/reference/api/legacy-waf/ruleset) (GET, PATCH)
+- [`/service/{service_id}/wafs/{firewall_id}/update_statuses/{update_status_id}`](https://developer.fastly.com/reference/api/legacy-waf/update-status) (GET)
+- [`/service/{service_id}/wafs/{firewall_id}/update_statuses`](https://developer.fastly.com/reference/api/legacy-waf/update-status) (GET)
+- [`/sudo`](https://developer.fastly.com/reference/api/utils/sudo) (POST)
+- [`/tls/activations/{tls_activation_id}`](https://developer.fastly.com/reference/api/tls/mutual-tls/activations) (GET, PATCH)
+- [`/tls/activations`](https://developer.fastly.com/reference/api/tls/mutual-tls/activations) (GET)
+- [`/tokens`](https://developer.fastly.com/reference/api/auth-tokens/user) (DELETE, POST)
+- [`/user-groups/{user_group_id}/members`](https://developer.fastly.com/reference/api/account/user-groups) (DELETE, POST)
+- [`/user-groups/{user_group_id}/roles`](https://developer.fastly.com/reference/api/account/user-groups) (DELETE, POST)
+- [`/user-groups/{user_group_id}/service-groups`](https://developer.fastly.com/reference/api/account/user-groups) (DELETE, POST)
+- [`/user-groups/{user_group_id}`](https://developer.fastly.com/reference/api/account/user-groups) (PATCH)
+- [`/user-groups`](https://developer.fastly.com/reference/api/account/user-groups) (POST)
+- [`/v1/channel/{service_id}/ts/h/limit/{max_entries}`](https://developer.fastly.com/reference/api/metrics-stats/origin-insights) (GET)
+- [`/v1/channel/{service_id}/ts/h`](https://developer.fastly.com/reference/api/metrics-stats/origin-insights) (GET)
+- [`/v1/channel/{service_id}/ts/{start_timestamp}`](https://developer.fastly.com/reference/api/metrics-stats/origin-insights) (GET)
+- [`/v1/domains/{service_id}/ts/h/limit/{max_entries}`](https://developer.fastly.com/reference/api/metrics-stats/domain-inspector/real-time) (GET)
+- [`/v1/domains/{service_id}/ts/h`](https://developer.fastly.com/reference/api/metrics-stats/domain-inspector/real-time) (GET)
+- [`/v1/domains/{service_id}/ts/{start_timestamp}`](https://developer.fastly.com/reference/api/metrics-stats/domain-inspector/real-time) (GET)
+- [`/v1/origins/{service_id}/ts/h/limit/{max_entries}`](https://developer.fastly.com/reference/api/metrics-stats/origin-inspector/real-time) (GET)
+- [`/v1/origins/{service_id}/ts/h`](https://developer.fastly.com/reference/api/metrics-stats/origin-inspector/real-time) (GET)
+- [`/v1/origins/{service_id}/ts/{start_timestamp}`](https://developer.fastly.com/reference/api/metrics-stats/origin-inspector/real-time) (GET)
+- [`/vcl_lint`](https://developer.fastly.com/reference/api/vcl-services/vcl) (POST)
+- [`/waf/firewalls/{firewall_id}/versions/{version_id}/active-rules`](https://developer.fastly.com/reference/api/waf/rules/active) (DELETE)
+- [`/wafs/configuration_sets/{configuration_set_id}/relationships/wafs`](https://developer.fastly.com/reference/api/legacy-waf/configuration-set) (GET, PATCH)
+- [`/wafs/configuration_sets`](https://developer.fastly.com/reference/api/legacy-waf/configuration-set) (GET)
+- [`/wafs/rules/{waf_rule_id}/vcl`](https://developer.fastly.com/reference/api/legacy-waf/rule) (GET)
+- [`/wafs/rules/{waf_rule_id}`](https://developer.fastly.com/reference/api/legacy-waf/rule) (GET)
+- [`/wafs/rules`](https://developer.fastly.com/reference/api/legacy-waf/rule) (GET)
+- [`/wafs/tags`](https://developer.fastly.com/reference/api/legacy-waf/tag) (GET)
+- [`/wafs/{firewall_id}/disable`](https://developer.fastly.com/reference/api/legacy-waf/firewall) (PATCH)
+- [`/wafs/{firewall_id}/enable`](https://developer.fastly.com/reference/api/legacy-waf/firewall) (PATCH)
+- [`/wafs/{firewall_id}/rules/{waf_rule_id}/vcl`](https://developer.fastly.com/reference/api/legacy-waf/rule) (GET)
+- [`/wafs/{firewall_id}`](https://developer.fastly.com/reference/api/legacy-waf/firewall) (GET)
+- [`/wafs`](https://developer.fastly.com/reference/api/legacy-waf/firewall) (GET)
+
+
 If you encounter any non-security-related bug or unexpected behavior, please [file an issue][bug]
 using the bug report template.
 

diff --git a/docs/AclEntryApi.md b/docs/AclEntryApi.md
@@ -21,7 +21,7 @@ Method | Fastly API endpoint | Description
 bulkUpdateAclEntries({ service_id, acl_id, [bulk_update_acl_entries_request] })
 ```
 
-Update multiple ACL entries on the same ACL.
+Update multiple ACL entries on the same ACL. For faster updates to your service, group your changes into large batches. The maximum batch size is 1000 entries. [Contact support](https://support.fastly.com/) to discuss raising this limit.
 
 ### Example
 

diff --git a/docs/DomainOwnershipsApi.md b/docs/DomainOwnershipsApi.md
@@ -0,0 +1,43 @@
+# Fastly.DomainOwnershipsApi
+
+```javascript
+const apiInstance = new Fastly.DomainOwnershipsApi();
+```
+## Methods
+
+Method | Fastly API endpoint | Description
+------------- | ------------- | -------------
+[**listDomainOwnerships**](DomainOwnershipsApi.md#listDomainOwnerships) | **GET** /domain-ownerships | List domain-ownerships
+
+
+## `listDomainOwnerships`
+
+```javascript
+listDomainOwnerships()
+```
+
+List all domain-ownerships.
+
+### Example
+
+```javascript
+apiInstance.listDomainOwnerships()
+  .then((data) => {
+    console.log(data, "API called successfully.");
+  })
+  .catch((error) => {
+    console.error(error);
+  });
+```
+
+### Options
+
+This endpoint does not need any parameters.
+
+### Return type
+
+[**InlineResponse2002**](InlineResponse2002.md)
+
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to README]](../../README.md)
diff --git a/docs/InlineResponse2002.md b/docs/InlineResponse2002.md
@@ -4,8 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**data** | [**[StoreResponse]**](StoreResponse.md) |  | [optional] 
-**meta** | [**InlineResponse2002Meta**](InlineResponse2002Meta.md) |  | [optional] 
+**expires_at** | **String** | Time-stamp (GMT) when the domain_ownership validation will expire. | [optional] [readonly] 
 
 
 [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/InlineResponse2003.md b/docs/InlineResponse2003.md
@@ -0,0 +1,11 @@
+# Fastly.InlineResponse2003
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**[StoreResponse]**](StoreResponse.md) |  | [optional] 
+**meta** | [**InlineResponse2003Meta**](InlineResponse2003Meta.md) |  | [optional] 
+
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/InlineResponse2002Meta.md → docs/InlineResponse2003Meta.md b/docs/InlineResponse2002Meta.md → docs/InlineResponse2003Meta.md
@@ -1,4 +1,4 @@
-# Fastly.InlineResponse2002Meta
+# Fastly.InlineResponse2003Meta
 
 ## Properties
 

diff --git a/docs/InlineResponse2004.md b/docs/InlineResponse2004.md
@@ -0,0 +1,11 @@
+# Fastly.InlineResponse2004
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | **[String]** |  | [optional] 
+**meta** | [**InlineResponse2004Meta**](InlineResponse2004Meta.md) |  | [optional] 
+
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/InlineResponse2004Meta.md b/docs/InlineResponse2004Meta.md
@@ -0,0 +1,11 @@
+# Fastly.InlineResponse2004Meta
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**next_cursor** | **String** |  | [optional] 
+**limit** | **Number** |  | [optional] 
+
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/ObjectStoreApi.md b/docs/ObjectStoreApi.md
@@ -16,7 +16,7 @@ Method | Fastly API endpoint | Description
 ## `createStore`
 
 ```javascript
-createStore({ , [store] })
+createStore({ , [location, ][store] })
 ```
 
 Create a new object store.
@@ -25,6 +25,7 @@ Create a new object store.
 
 ```javascript
 const options = {
+  location: "location_example",
   store: {"name":"my-store"},
 };
 
@@ -41,6 +42,7 @@ apiInstance.createStore(options)
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
+**location** | **String** |  | [optional]
 **store** | [**Store**](Store.md) |  | [optional]
 
 ### Return type
@@ -51,7 +53,7 @@ Name | Type | Description  | Notes
 ## `deleteStore`
 
 ```javascript
-deleteStore({ store_id })
+deleteStore({ store_id, [force] })
 ```
 
 An object store must be empty before it can be deleted.  Deleting an object store that still contains keys will result in a `409` (Conflict).
@@ -61,6 +63,7 @@ An object store must be empty before it can be deleted.  Deleting an object stor
 ```javascript
 const options = {
   store_id: "store_id_example", // required
+  force: true,
 };
 
 apiInstance.deleteStore(options)
@@ -77,6 +80,7 @@ apiInstance.deleteStore(options)
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
 **store_id** | **String** |  |
+**force** | **Boolean** |  | [optional]
 
 ### Return type
 
@@ -152,7 +156,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**InlineResponse2002**](InlineResponse2002.md)
+[**InlineResponse2003**](InlineResponse2003.md)
 
 
 [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)