Skip to content

Commit 8d3686f

Browse files
author
github-actions
committed
Generated v3.1.0
1 parent 0da6432 commit 8d3686f

File tree

668 files changed

+2042
-662
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

668 files changed

+2042
-662
lines changed

README.md

+16-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,11 @@
22

33
An asynchronous JavaScript client library for interacting with most facets of the [Fastly API](https://developer.fastly.com/reference/api).
44

5-
> ⚠️ This client library (`3.0.1-alpha.1`) is an early-access release. Features may change without notice. Use at your own risk.
5+
> NOTE: This 3.x release is a new [generated API client](https://dev.to/fastly/better-fastly-api-clients-with-openapi-generator-3lno) for the Fastly API.
6+
> The previous 2.x version is no longer supported, but can be found at https://github.com/thisandagain/fastly.
7+
8+
9+
> ⚠️ This client library (`v3.1.0`) is an early-access release. Features may change without notice. Use at your own risk.
610
711
**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).
812

@@ -18,10 +22,10 @@ import Fastly from "fastly";
1822

1923
const apiInstance = new Fastly.AclApi();
2024

21-
// If the FASTLY_API_TOKEN environment variable is set,
25+
// If the FASTLY_API_TOKEN environment variable is set,
2226
// the client will use it to authenticate all API requests.
2327
// Alternatively, you may authorize the client instance
24-
// with a Fastly API token, which will override
28+
// with a Fastly API token, which will override
2529
// the environment variable.
2630
// Fastly.ApiClient.instance.authenticate("YOUR_API_TOKEN");
2731

@@ -314,6 +318,14 @@ Class | Method | Description
314318
*Fastly.MutualAuthenticationApi* | [**getMutualAuthentication**](docs/MutualAuthenticationApi.md#getMutualAuthentication) | Get a Mutual Authentication
315319
*Fastly.MutualAuthenticationApi* | [**listMutualAuthentications**](docs/MutualAuthenticationApi.md#listMutualAuthentications) | List Mutual Authentications
316320
*Fastly.MutualAuthenticationApi* | [**patchMutualAuthentication**](docs/MutualAuthenticationApi.md#patchMutualAuthentication) | Update a Mutual Authentication
321+
*Fastly.ObjectStoreApi* | [**createStore**](docs/ObjectStoreApi.md#createStore) | Create an object store.
322+
*Fastly.ObjectStoreApi* | [**deleteKeyFromStore**](docs/ObjectStoreApi.md#deleteKeyFromStore) | Delete object store key.
323+
*Fastly.ObjectStoreApi* | [**deleteStore**](docs/ObjectStoreApi.md#deleteStore) | Delete an object store.
324+
*Fastly.ObjectStoreApi* | [**getKeys**](docs/ObjectStoreApi.md#getKeys) | List object store keys.
325+
*Fastly.ObjectStoreApi* | [**getStore**](docs/ObjectStoreApi.md#getStore) | Describe an object store.
326+
*Fastly.ObjectStoreApi* | [**getStores**](docs/ObjectStoreApi.md#getStores) | List object stores.
327+
*Fastly.ObjectStoreApi* | [**getValueForKey**](docs/ObjectStoreApi.md#getValueForKey) | Get object store key value.
328+
*Fastly.ObjectStoreApi* | [**setValueForKey**](docs/ObjectStoreApi.md#setValueForKey) | Insert object store key-value.
317329
*Fastly.PackageApi* | [**getPackage**](docs/PackageApi.md#getPackage) | Get details of the service's Compute@Edge package.
318330
*Fastly.PackageApi* | [**putPackage**](docs/PackageApi.md#putPackage) | Upload a Compute@Edge package.
319331
*Fastly.PoolApi* | [**createServerPool**](docs/PoolApi.md#createServerPool) | Create a server pool
@@ -365,6 +377,7 @@ Class | Method | Description
365377
*Fastly.ServiceAuthorizationsApi* | [**showServiceAuthorization**](docs/ServiceAuthorizationsApi.md#showServiceAuthorization) | Show service authorization
366378
*Fastly.ServiceAuthorizationsApi* | [**updateServiceAuthorization**](docs/ServiceAuthorizationsApi.md#updateServiceAuthorization) | Update service authorization
367379
*Fastly.SettingsApi* | [**getServiceSettings**](docs/SettingsApi.md#getServiceSettings) | Get service settings
380+
*Fastly.SettingsApi* | [**updateServiceSettings**](docs/SettingsApi.md#updateServiceSettings) | Update service settings
368381
*Fastly.SnippetApi* | [**createSnippet**](docs/SnippetApi.md#createSnippet) | Create a snippet
369382
*Fastly.SnippetApi* | [**deleteSnippet**](docs/SnippetApi.md#deleteSnippet) | Delete a snippet
370383
*Fastly.SnippetApi* | [**getSnippet**](docs/SnippetApi.md#getSnippet) | Get a versioned snippet

docs/GetStoresResponse.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Fastly.GetStoresResponse
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**data** | [**[StoreResponse]**](StoreResponse.md) | | [optional]
8+
**meta** | [**GetStoresResponseMeta**](GetStoresResponseMeta.md) | | [optional]
9+
10+
11+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

docs/GetStoresResponseMeta.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Fastly.GetStoresResponseMeta
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**next_cursor** | **String** | Cursor for the next page. | [optional]
8+
**limit** | **Number** | Entries returned. | [optional]
9+
10+
11+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

docs/KeyResponse.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Fastly.KeyResponse
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**data** | **[String]** | | [optional]
8+
**meta** | [**GetStoresResponseMeta**](GetStoresResponseMeta.md) | | [optional]
9+
10+
11+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

docs/MutualAuthenticationApi.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ null (empty response body)
8787
## `getMutualAuthentication`
8888

8989
```javascript
90-
getMutualAuthentication({ mutual_authentication_id })
90+
getMutualAuthentication({ mutual_authentication_id, [include] })
9191
```
9292

9393
Show a Mutual Authentication.
@@ -97,6 +97,7 @@ Show a Mutual Authentication.
9797
```javascript
9898
const options = {
9999
mutual_authentication_id: "mutual_authentication_id_example", // required
100+
include: "include_example",
100101
};
101102

102103
apiInstance.getMutualAuthentication(options)
@@ -113,6 +114,7 @@ apiInstance.getMutualAuthentication(options)
113114
Name | Type | Description | Notes
114115
------------- | ------------- | ------------- | -------------
115116
**mutual_authentication_id** | **String** | Alphanumeric string identifying a mutual authentication. |
117+
**include** | **String** | Comma-separated list of related objects to include (optional). Permitted values: `tls_activations`. Including TLS activations will provide you with the TLS domain names that are related to your Mutual TLS authentication. | [optional]
116118

117119
### Return type
118120

@@ -122,7 +124,7 @@ Name | Type | Description | Notes
122124
## `listMutualAuthentications`
123125

124126
```javascript
125-
listMutualAuthentications({ , [page_number, ][page_size] })
127+
listMutualAuthentications({ , [include, ][page_number, ][page_size] })
126128
```
127129

128130
List all mutual authentications.
@@ -131,6 +133,7 @@ List all mutual authentications.
131133

132134
```javascript
133135
const options = {
136+
include: "include_example",
134137
page_number: 1,
135138
page_size: 20,
136139
};
@@ -148,6 +151,7 @@ apiInstance.listMutualAuthentications(options)
148151

149152
Name | Type | Description | Notes
150153
------------- | ------------- | ------------- | -------------
154+
**include** | **String** | Comma-separated list of related objects to include (optional). Permitted values: `tls_activations`. Including TLS activations will provide you with the TLS domain names that are related to your Mutual TLS authentication. | [optional]
151155
**page_number** | **Number** | Current page. | [optional]
152156
**page_size** | **Number** | Number of records per page. | [optional] [defaults to 20]
153157

0 commit comments

Comments
 (0)