Generated v7.10.0

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [v7.10.0](https://github.com/fastly/fastly-js/releases/tag/release/v7.10.0) (2024-10-23)
+
+**Documentation:**
+
+- doc(javascript): Add example and note to README to help with initialization.
+- doc(backend): Correct spelling in `connect_timeout` and `first_byte_timeout` field descriptions.
+
 ## [v7.9.0](https://github.com/fastly/fastly-js/releases/tag/release/v7.9.0) (2024-09-13)
 
 **Bug fixes:**

README.md

@@ -13,12 +13,21 @@ import Fastly from "fastly";
 
 const apiInstance = new Fastly.AclApi();
 
-// If the FASTLY_API_TOKEN environment variable is set,
-// the client will use it to authenticate all API requests.
-// Alternatively, you may authorize the client instance
-// with a Fastly API token, which will override
-// the environment variable.
-// Fastly.ApiClient.instance.authenticate("YOUR_API_TOKEN");
+/**
+* @note
+* If the FASTLY_API_TOKEN environment variable is set,
+* the client will use it to authenticate all API requests.
+* Alternatively, you may authorize the client instance
+* with a Fastly API token, which will override
+* the environment variable.
+* @example
+* Fastly.ApiClient.instance.authenticate("YOUR_API_TOKEN");
+* const fastlyService = new FastlyInstance.ServiceApi();
+* @note
+* For ESM based Typescript projects, import the client like this:
+* import * as Fastly from "fastly";
+*
+*/
 
 const options = {
   service_id: "SU1Z0isxPaozGVKXdv0eY", // required

docs/Backend.md

@@ -9,8 +9,8 @@ Name | Type | Description | Notes
 **between_bytes_timeout** | **Number** | Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using `bereq.between_bytes_timeout`. | [optional] 
 **client_cert** | **String** | Unused. | [optional] 
 **comment** | **String** | A freeform descriptive note. | [optional] 
-**connect_timeout** | **Number** | Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`. | [optional] 
-**first_byte_timeout** | **Number** | Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`. | [optional] 
+**connect_timeout** | **Number** | Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`. | [optional] 
+**first_byte_timeout** | **Number** | Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`. | [optional] 
 **healthcheck** | **String** | The name of the healthcheck to use with this backend. | [optional] 
 **hostname** | **String** | The hostname of the backend. May be used as an alternative to `address` to set the backend location. | [optional] 
 **ipv4** | **String** | IPv4 address of the backend. May be used as an alternative to `address` to set the backend location. | [optional] 

docs/BackendApi.md

@@ -88,8 +88,8 @@ Name | Type | Description  | Notes
 **between_bytes_timeout** | **Number** | Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using `bereq.between_bytes_timeout`. | [optional]
 **client_cert** | **String** | Unused. | [optional]
 **comment** | **String** | A freeform descriptive note. | [optional]
-**connect_timeout** | **Number** | Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`. | [optional]
-**first_byte_timeout** | **Number** | Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`. | [optional]
+**connect_timeout** | **Number** | Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`. | [optional]
+**first_byte_timeout** | **Number** | Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`. | [optional]
 **healthcheck** | **String** | The name of the healthcheck to use with this backend. | [optional]
 **hostname** | **String** | The hostname of the backend. May be used as an alternative to `address` to set the backend location. | [optional]
 **ipv4** | **String** | IPv4 address of the backend. May be used as an alternative to `address` to set the backend location. | [optional]
@@ -312,8 +312,8 @@ Name | Type | Description  | Notes
 **between_bytes_timeout** | **Number** | Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using `bereq.between_bytes_timeout`. | [optional]
 **client_cert** | **String** | Unused. | [optional]
 **comment** | **String** | A freeform descriptive note. | [optional]
-**connect_timeout** | **Number** | Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`. | [optional]
-**first_byte_timeout** | **Number** | Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`. | [optional]
+**connect_timeout** | **Number** | Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`. | [optional]
+**first_byte_timeout** | **Number** | Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`. | [optional]
 **healthcheck** | **String** | The name of the healthcheck to use with this backend. | [optional]
 **hostname** | **String** | The hostname of the backend. May be used as an alternative to `address` to set the backend location. | [optional]
 **ipv4** | **String** | IPv4 address of the backend. May be used as an alternative to `address` to set the backend location. | [optional]

docs/BackendResponse.md

@@ -9,8 +9,8 @@ Name | Type | Description | Notes
 **between_bytes_timeout** | **Number** | Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using `bereq.between_bytes_timeout`. | [optional] 
 **client_cert** | **String** | Unused. | [optional] 
 **comment** | **String** | A freeform descriptive note. | [optional] 
-**connect_timeout** | **Number** | Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`. | [optional] 
-**first_byte_timeout** | **Number** | Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`. | [optional] 
+**connect_timeout** | **Number** | Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`. | [optional] 
+**first_byte_timeout** | **Number** | Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`. | [optional] 
 **healthcheck** | **String** | The name of the healthcheck to use with this backend. | [optional] 
 **hostname** | **String** | The hostname of the backend. May be used as an alternative to `address` to set the backend location. | [optional] 
 **ipv4** | **String** | IPv4 address of the backend. May be used as an alternative to `address` to set the backend location. | [optional] 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "fastly",
-  "version": "7.9.0",
+  "version": "7.10.0",
   "description": "A JavaScript client library for interacting with most facets of the Fastly API.",
   "license": "MIT",
   "main": "dist/index.js",

sig.json

@@ -1 +1 @@
-{"G": "1827dbb1", "D": "1f27800e"}
+{"G": "dbe8e713", "D": "4061d4ec"}

src/ApiClient.js

@@ -19,7 +19,7 @@ const DEFAULT_RATELIMIT = 1000;
 
 /**
 * @module ApiClient
-* @version 7.9.0
+* @version 7.10.0
 */
 
 /**
@@ -66,7 +66,7 @@ class ApiClient {
          * @default {}
          */
         this.defaultHeaders = {
-            'User-Agent': 'fastly-js/7.9.0'
+            'User-Agent': 'fastly-js/7.10.0'
         };
 
         /**

src/api/AclApi.js

@@ -18,7 +18,7 @@ import InlineResponse200 from '../model/InlineResponse200';
 /**
 * Acl service.
 * @module api/AclApi
-* @version 7.9.0
+* @version 7.10.0
 */
 export default class AclApi {
 

src/api/AclEntryApi.js

@@ -20,7 +20,7 @@ import InlineResponse200 from '../model/InlineResponse200';
 /**
 * AclEntry service.
 * @module api/AclEntryApi
-* @version 7.9.0
+* @version 7.10.0
 */
 export default class AclEntryApi {
 

src/api/AclsInComputeApi.js

@@ -21,7 +21,7 @@ import ComputeAclUpdateEntry from '../model/ComputeAclUpdateEntry';
 /**
 * AclsInCompute service.
 * @module api/AclsInComputeApi
-* @version 7.9.0
+* @version 7.10.0
 */
 export default class AclsInComputeApi {
 

src/api/ApexRedirectApi.js

@@ -18,7 +18,7 @@ import InlineResponse200 from '../model/InlineResponse200';
 /**
 * ApexRedirect service.
 * @module api/ApexRedirectApi
-* @version 7.9.0
+* @version 7.10.0
 */
 export default class ApexRedirectApi {
 

src/api/AutomationTokensApi.js

@@ -21,7 +21,7 @@ import InlineResponse2001 from '../model/InlineResponse2001';
 /**
 * AutomationTokens service.
 * @module api/AutomationTokensApi
-* @version 7.9.0
+* @version 7.10.0
 */
 export default class AutomationTokensApi {