Skip to content

Commit 99adcfe

Browse files
author
github-actions
committed
Generated v3.0.0
1 parent 1170430 commit 99adcfe

File tree

239 files changed

+44111
-303
lines changed

Some content is hidden

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

239 files changed

+44111
-303
lines changed

‎CHANGELOG.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,54 @@
11
# Changelog
22

3+
## [v3.0.0](https://github.com/fastly/fastly-py/releases/tag/release/v3.0.0) (2023-07-06)
4+
5+
Substantial changes were made to the underlying OpenAPI specification that produces this API client. These changes have resulted in multiple new endpoints being supported as well as multiple breaking type changes and so we're publishing these changes as a new major release.
6+
7+
**Enhancements:**
8+
9+
- feat(apex_redirect): support all endpoints.
10+
- feat(contact): support 'create' endpoint.
11+
- feat(director): support 'update' endpoint.
12+
- feat(domain_inspector): support all endpoints.
13+
- feat(iam_roles): support 'add permissions' endpoint.
14+
- feat(iam_roles): support 'create role' endpoint.
15+
- feat(iam_roles): support 'delete permissions' endpoint.
16+
- feat(iam_roles): support 'update role' endpoint.
17+
- feat(iam_services): support 'add services' endpoint.
18+
- feat(iam_services): support 'create service group' endpoint.
19+
- feat(iam_services): support 'remove services' endpoint.
20+
- feat(iam_services): support 'update service group' endpoint.
21+
- feat(iam_users): support 'add members' endpoint.
22+
- feat(iam_users): support 'add roles' endpoint.
23+
- feat(iam_users): support 'add service groups' endpoint.
24+
- feat(iam_users): support 'create user group' endpoint.
25+
- feat(iam_users): support 'remove members' endpoint.
26+
- feat(iam_users): support 'remove roles' endpoint.
27+
- feat(iam_users): support 'remove service groups' endpoint.
28+
- feat(iam_users): support 'update user group' endpoint.
29+
- feat(legacy_waf): support all endpoints.
30+
- feat(logging_kafka): support 'update' endpoint.
31+
- feat(logging_kinesis): support 'update' endpoint.
32+
- feat(origin_inspector): support all endpoints.
33+
- feat(request_settings): support 'create' endpoint.
34+
- feat(response_object): support 'create' endpoint.
35+
- feat(response_object): support 'update' endpoint.
36+
- feat(secret_store): support all endpoints.
37+
- feat(service_authorizations): support 'delete' endpoint.
38+
- feat(service_authorizations): support 'update' endpoint.
39+
- feat(snippet): support 'update versioned snippet' endpoint.
40+
- feat(sudo): support 'request sudo access' endpoint.
41+
- feat(tokens): support 'revoke multiple tokens' endpoint.
42+
- feat(tokens): support 'create token' endpoint.
43+
- feat(waf_active_rules): support 'delete' endpoint.
44+
45+
**Bug fixes:**
46+
47+
- fix(content): update request/response types.
48+
- fix(events): update metadata type.
49+
- fix(realtime_entry): update recorded/aggregated type.
50+
- fix(realtime_measurements): update miss_histogram type.
51+
352
## [v2.4.0](https://github.com/fastly/fastly-py/releases/tag/release/v2.4.0) (2023-07-05)
453

554
**Enhancements:**

‎README.md‎

Lines changed: 84 additions & 61 deletions
Large diffs are not rendered by default.

‎docs/ApexRedirectApi.md‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,120 @@ All URIs are relative to *https://api.fastly.com*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7+
[**create_apex_redirect**](ApexRedirectApi.md#create_apex_redirect) | **POST** /service/{service_id}/version/{version_id}/apex-redirects | Create an apex redirect
78
[**delete_apex_redirect**](ApexRedirectApi.md#delete_apex_redirect) | **DELETE** /apex-redirects/{apex_redirect_id} | Delete an apex redirect
89
[**get_apex_redirect**](ApexRedirectApi.md#get_apex_redirect) | **GET** /apex-redirects/{apex_redirect_id} | Get an apex redirect
910
[**list_apex_redirects**](ApexRedirectApi.md#list_apex_redirects) | **GET** /service/{service_id}/version/{version_id}/apex-redirects | List apex redirects
1011
[**update_apex_redirect**](ApexRedirectApi.md#update_apex_redirect) | **PUT** /apex-redirects/{apex_redirect_id} | Update an apex redirect
1112

1213

14+
# **create_apex_redirect**
15+
> ApexRedirect create_apex_redirect(service_id, version_id)
16+
17+
Create an apex redirect
18+
19+
Create an apex redirect for a particular service and version.
20+
21+
### Example
22+
23+
* Api Key Authentication (token):
24+
25+
```python
26+
import time
27+
import fastly
28+
from fastly.api import apex_redirect_api
29+
from fastly.model.apex_redirect import ApexRedirect
30+
from pprint import pprint
31+
# Defining the host is optional and defaults to https://api.fastly.com
32+
# See configuration.py for a list of all supported configuration parameters.
33+
configuration = fastly.Configuration(
34+
host = "https://api.fastly.com"
35+
)
36+
37+
# The client must configure the authentication and authorization parameters
38+
# in accordance with the API server security policy.
39+
# Examples for each auth method are provided below, use the example that
40+
# satisfies your auth use case.
41+
42+
# Configure API key authorization: token
43+
configuration.api_key['token'] = 'YOUR_API_KEY'
44+
45+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
46+
# configuration.api_key_prefix['token'] = 'Bearer'
47+
48+
# Enter a context with an instance of the API client
49+
with fastly.ApiClient(configuration) as api_client:
50+
# Create an instance of the API class
51+
api_instance = apex_redirect_api.ApexRedirectApi(api_client)
52+
service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
53+
version_id = 1 # int | Integer identifying a service version.
54+
service_id2 = "service_id_example" # str | (optional)
55+
version = 1 # int | (optional)
56+
created_at = dateutil_parser('2020-04-09T18:14:30Z') # datetime, none_type | Date and time in ISO 8601 format. (optional)
57+
deleted_at = dateutil_parser('2020-04-09T18:14:30Z') # datetime, none_type | Date and time in ISO 8601 format. (optional)
58+
updated_at = dateutil_parser('2020-04-09T18:14:30Z') # datetime, none_type | Date and time in ISO 8601 format. (optional)
59+
status_code = 301 # int | HTTP status code used to redirect the client. (optional)
60+
domains = [
61+
"domains_example",
62+
] # [str] | Array of apex domains that should redirect to their WWW subdomain. (optional)
63+
feature_revision = 1 # int | Revision number of the apex redirect feature implementation. Defaults to the most recent revision. (optional)
64+
65+
# example passing only required values which don't have defaults set
66+
try:
67+
# Create an apex redirect
68+
api_response = api_instance.create_apex_redirect(service_id, version_id)
69+
pprint(api_response)
70+
except fastly.ApiException as e:
71+
print("Exception when calling ApexRedirectApi->create_apex_redirect: %s\n" % e)
72+
73+
# example passing only required values which don't have defaults set
74+
# and optional values
75+
try:
76+
# Create an apex redirect
77+
api_response = api_instance.create_apex_redirect(service_id, version_id, service_id2=service_id2, version=version, created_at=created_at, deleted_at=deleted_at, updated_at=updated_at, status_code=status_code, domains=domains, feature_revision=feature_revision)
78+
pprint(api_response)
79+
except fastly.ApiException as e:
80+
print("Exception when calling ApexRedirectApi->create_apex_redirect: %s\n" % e)
81+
```
82+
83+
84+
### Parameters
85+
86+
Name | Type | Description | Notes
87+
------------- | ------------- | ------------- | -------------
88+
**service_id** | **str**| Alphanumeric string identifying the service. |
89+
**version_id** | **int**| Integer identifying a service version. |
90+
**service_id2** | **str**| | [optional]
91+
**version** | **int**| | [optional]
92+
**created_at** | **datetime, none_type**| Date and time in ISO 8601 format. | [optional]
93+
**deleted_at** | **datetime, none_type**| Date and time in ISO 8601 format. | [optional]
94+
**updated_at** | **datetime, none_type**| Date and time in ISO 8601 format. | [optional]
95+
**status_code** | **int**| HTTP status code used to redirect the client. | [optional]
96+
**domains** | **[str]**| Array of apex domains that should redirect to their WWW subdomain. | [optional]
97+
**feature_revision** | **int**| Revision number of the apex redirect feature implementation. Defaults to the most recent revision. | [optional]
98+
99+
### Return type
100+
101+
[**ApexRedirect**](ApexRedirect.md)
102+
103+
### Authorization
104+
105+
[token](../README.md#token)
106+
107+
### HTTP request headers
108+
109+
- **Content-Type**: application/x-www-form-urlencoded
110+
- **Accept**: application/json
111+
112+
113+
### HTTP response details
114+
115+
| Status code | Description | Response headers |
116+
|-------------|-------------|------------------|
117+
**200** | OK | - |
118+
119+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
120+
13121
# **delete_apex_redirect**
14122
> InlineResponse200 delete_apex_redirect(apex_redirect_id)
15123

‎docs/AutomationToken.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# AutomationToken
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**name** | **str** | The name of the token. | [optional]
8+
**role** | **str** | The role on the token. | [optional]
9+
**services** | **[str]** | (Optional) The service IDs of the services the token will have access to. Separate service IDs with a space. If no services are specified, the token will have access to all services on the account. | [optional]
10+
**scope** | **str** | A space-delimited list of authorization scope. | [optional] if omitted the server will use the default value of "global"
11+
**expires_at** | **str** | A UTC time-stamp of when the token expires. | [optional]
12+
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
13+
14+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15+
16+

‎docs/AutomationTokenCreateRequest.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# AutomationTokenCreateRequest
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**attributes** | [**AutomationTokenCreateRequestAttributes**](AutomationTokenCreateRequestAttributes.md) | | [optional]
8+
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+
12+

‎docs/AutomationTokenCreateRequestAttributes.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# AutomationTokenCreateRequestAttributes
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**name** | **str** | name of the token | [optional]
8+
**role** | **str** | | [optional]
9+
**services** | **[str]** | List of service ids to limit the token | [optional]
10+
**scope** | **str** | | [optional] if omitted the server will use the default value of "global"
11+
**expires_at** | **datetime, none_type** | A UTC time-stamp of when the token will expire. | [optional]
12+
**tls_access** | **bool** | Indicates whether TLS access is enabled for the token. | [optional]
13+
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
14+
15+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
16+
17+

‎docs/AutomationTokenCreateResponse.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# AutomationTokenCreateResponse
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**name** | **str** | The name of the token. | [optional]
8+
**role** | **str** | The role on the token. | [optional]
9+
**services** | **[str]** | (Optional) The service IDs of the services the token will have access to. Separate service IDs with a space. If no services are specified, the token will have access to all services on the account. | [optional]
10+
**scope** | **str** | A space-delimited list of authorization scope. | [optional] if omitted the server will use the default value of "global"
11+
**expires_at** | **str** | A UTC time-stamp of when the token expires. | [optional]
12+
**created_at** | **datetime** | A UTC time-stamp of when the token was created. | [optional] [readonly]
13+
**deleted_at** | **datetime, none_type** | Date and time in ISO 8601 format. | [optional] [readonly]
14+
**updated_at** | **datetime, none_type** | Date and time in ISO 8601 format. | [optional] [readonly]
15+
**id** | [**ReadOnlyId**](ReadOnlyId.md) | | [optional]
16+
**user_id** | [**ReadOnlyUserId**](ReadOnlyUserId.md) | | [optional]
17+
**customer_id** | [**ReadOnlyCustomerId**](ReadOnlyCustomerId.md) | | [optional]
18+
**sudo_expires_at** | **datetime** | | [optional] [readonly]
19+
**access_token** | **str** | | [optional] [readonly]
20+
**last_used_at** | **datetime** | A UTC time-stamp of when the token was last used. | [optional] [readonly]
21+
**user_agent** | **str** | The User-Agent header of the client that last used the token. | [optional]
22+
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
23+
24+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
25+
26+

‎docs/AutomationTokenCreateResponseAllOf.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# AutomationTokenCreateResponseAllOf
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**id** | [**ReadOnlyId**](ReadOnlyId.md) | | [optional]
8+
**user_id** | [**ReadOnlyUserId**](ReadOnlyUserId.md) | | [optional]
9+
**customer_id** | [**ReadOnlyCustomerId**](ReadOnlyCustomerId.md) | | [optional]
10+
**sudo_expires_at** | **datetime** | | [optional] [readonly]
11+
**created_at** | **datetime** | A UTC time-stamp of when the token was created. | [optional] [readonly]
12+
**access_token** | **str** | | [optional] [readonly]
13+
**last_used_at** | **datetime** | A UTC time-stamp of when the token was last used. | [optional] [readonly]
14+
**user_agent** | **str** | The User-Agent header of the client that last used the token. | [optional]
15+
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
16+
17+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
18+
19+

‎docs/AutomationTokenResponse.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# AutomationTokenResponse
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**name** | **str** | The name of the token. | [optional]
8+
**role** | **str** | | [optional]
9+
**services** | **[str]** | (Optional) The service IDs of the services the token will have access to. Separate service IDs with a space. If no services are specified, the token will have access to all services on the account. | [optional]
10+
**scope** | **str** | A space-delimited list of authorization scope. | [optional] if omitted the server will use the default value of "global"
11+
**expires_at** | **str** | (optional) A UTC time-stamp of when the token will expire. | [optional]
12+
**created_at** | **str** | A UTC time-stamp of when the token was created. | [optional]
13+
**deleted_at** | **datetime, none_type** | Date and time in ISO 8601 format. | [optional] [readonly]
14+
**updated_at** | **datetime, none_type** | Date and time in ISO 8601 format. | [optional] [readonly]
15+
**id** | [**ReadOnlyId**](ReadOnlyId.md) | | [optional]
16+
**customer_id** | [**ReadOnlyCustomerId**](ReadOnlyCustomerId.md) | | [optional]
17+
**ip** | **str** | The IP address of the client that last used the token. | [optional]
18+
**user_agent** | **str** | The User-Agent header of the client that last used the token. | [optional]
19+
**sudo_expires_at** | **str** | | [optional] [readonly]
20+
**last_used_at** | **datetime** | A UTC time-stamp of when the token was last used. | [optional] [readonly]
21+
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
22+
23+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
24+
25+

‎docs/AutomationTokenResponseAllOf.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# AutomationTokenResponseAllOf
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**id** | [**ReadOnlyId**](ReadOnlyId.md) | | [optional]
8+
**customer_id** | [**ReadOnlyCustomerId**](ReadOnlyCustomerId.md) | | [optional]
9+
**role** | **str** | | [optional]
10+
**ip** | **str** | The IP address of the client that last used the token. | [optional]
11+
**user_agent** | **str** | The User-Agent header of the client that last used the token. | [optional]
12+
**sudo_expires_at** | **str** | | [optional] [readonly]
13+
**last_used_at** | **datetime** | A UTC time-stamp of when the token was last used. | [optional] [readonly]
14+
**created_at** | **str** | A UTC time-stamp of when the token was created. | [optional]
15+
**expires_at** | **str** | (optional) A UTC time-stamp of when the token will expire. | [optional]
16+
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
17+
18+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
19+
20+

0 commit comments

Comments
 (0)