fastly 4.1.0 → 4.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (63) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +25 -0
  3. data/Gemfile.lock +1 -1
  4. data/README.md +7 -11
  5. data/docs/Backend.md +1 -1
  6. data/docs/BackendApi.md +4 -4
  7. data/docs/BackendResponse.md +1 -1
  8. data/docs/EnabledProductResponse.md +12 -0
  9. data/docs/{EnabledProductProduct.md → EnabledProductResponseLinks.md} +3 -3
  10. data/docs/{ResourceCreateAllOf.md → EnabledProductResponseProduct.md} +3 -2
  11. data/docs/{EnabledProductLinks.md → EnabledProductResponseService.md} +3 -3
  12. data/docs/EnabledProductsApi.md +7 -7
  13. data/docs/EventsApi.md +2 -0
  14. data/docs/HistoricalApi.md +10 -10
  15. data/docs/{GetStoresResponse.md → InlineResponse2002.md} +2 -2
  16. data/docs/{GetStoresResponseMeta.md → InlineResponse2002Meta.md} +1 -1
  17. data/docs/ObjectStoreApi.md +3 -166
  18. data/docs/Pop.md +7 -4
  19. data/docs/PopCoordinates.md +2 -4
  20. data/docs/RealtimeMeasurements.md +4 -2
  21. data/docs/Resource.md +2 -1
  22. data/docs/ResourceApi.md +34 -32
  23. data/docs/ResourceResponse.md +3 -3
  24. data/docs/ResourceResponseAllOf.md +1 -1
  25. data/docs/Results.md +5 -3
  26. data/docs/TlsSubscriptionResponseAttributes.md +1 -1
  27. data/docs/TlsSubscriptionResponseAttributesAllOf.md +1 -1
  28. data/docs/TlsSubscriptionsApi.md +3 -3
  29. data/lib/fastly/api/backend_api.rb +4 -4
  30. data/lib/fastly/api/enabled_products_api.rb +12 -12
  31. data/lib/fastly/api/events_api.rb +3 -0
  32. data/lib/fastly/api/historical_api.rb +10 -10
  33. data/lib/fastly/api/object_store_api.rb +5 -289
  34. data/lib/fastly/api/purge_api.rb +1 -1
  35. data/lib/fastly/api/resource_api.rb +51 -48
  36. data/lib/fastly/api/tls_subscriptions_api.rb +4 -4
  37. data/lib/fastly/models/backend.rb +1 -1
  38. data/lib/fastly/models/backend_response.rb +1 -1
  39. data/lib/fastly/models/{enabled_product.rb → enabled_product_response.rb} +6 -6
  40. data/lib/fastly/models/{enabled_product_links.rb → enabled_product_response_links.rb} +5 -3
  41. data/lib/fastly/models/{enabled_product_product.rb → enabled_product_response_product.rb} +5 -3
  42. data/lib/fastly/models/{key_response.rb → enabled_product_response_service.rb} +18 -18
  43. data/lib/fastly/models/{get_stores_response.rb → inline_response2002.rb} +4 -4
  44. data/lib/fastly/models/{get_stores_response_meta.rb → inline_response2002_meta.rb} +3 -3
  45. data/lib/fastly/models/pop.rb +121 -1
  46. data/lib/fastly/models/pop_coordinates.rb +12 -19
  47. data/lib/fastly/models/realtime_measurements.rb +23 -3
  48. data/lib/fastly/models/resource.rb +12 -2
  49. data/lib/fastly/models/resource_response.rb +23 -23
  50. data/lib/fastly/models/resource_response_all_of.rb +1 -1
  51. data/lib/fastly/models/results.rb +24 -4
  52. data/lib/fastly/models/tls_subscription_response_attributes.rb +2 -2
  53. data/lib/fastly/models/tls_subscription_response_attributes_all_of.rb +2 -2
  54. data/lib/fastly/models/type_resource.rb +2 -0
  55. data/lib/fastly/version.rb +1 -1
  56. data/lib/fastly.rb +6 -8
  57. data/sig.json +1 -1
  58. metadata +14 -18
  59. data/docs/EnabledProduct.md +0 -12
  60. data/docs/KeyResponse.md +0 -11
  61. data/docs/ResourceCreate.md +0 -11
  62. data/lib/fastly/models/resource_create.rb +0 -235
  63. data/lib/fastly/models/resource_create_all_of.rb +0 -217
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5b993587a1bc1831cf06074525d6ebeb5678ca49144349d01e4ea59380628cdf
4
- data.tar.gz: 16fd9f49b6d5efa5bcb4b377e666a46124d867717809ebd55d7b57fcd1054676
3
+ metadata.gz: 0d249f1c7560f35585549de862d293c437671c06d8f4d8a16135ee55991befa3
4
+ data.tar.gz: e5b44d00bc3949a6cfde7e59fef056a96090bfed2ddb1592846575dc5e168df9
5
5
  SHA512:
6
- metadata.gz: fb63451ed405de43a59efd16345d694fce683e5ad28dfc3e16d453c82ebb661e3a6d4fe6bb49b674c353241ea19443e1dc4c9af592671706523bdfc136977e8d
7
- data.tar.gz: b989a523060f1f4f9c3b4f6574090059b7c61ec02743d69cbac9a1b54ebde5fd3c1642cef15733c85f10f1c44ba2c4afdd0a908348b6ab53efb89fe63529f388
6
+ metadata.gz: 23d0daf589c1e835be63725b99a390e4ab615a46524fb28c5bc24453bf59ed5bdcfcfd975f3683a5799c90c1942f47fe7e7ccfd28efb735867e565ce4439806f
7
+ data.tar.gz: d1cab60a1f6573e1876c51830762cb2222c6d514fdb6de189489eba86ff41a0d57a29313b3e09f84a1f04874bf0803531b453addc65ab6fdcc69a3cc8c9a518e
data/CHANGELOG.md CHANGED
@@ -1,5 +1,30 @@
1
1
  # Changelog
2
2
 
3
+ ## [v4.1.0](https://github.com/fastly/fastly-ruby/releases/tag/v4.1.0) (2023-03-21)
4
+
5
+ [Full Changelog](https://github.com/fastly/fastly-ruby/compare/v4.0.0...v4.1.0)
6
+
7
+ ## Bug fixes
8
+
9
+ - fix(purge): switch authentication type to 'token'
10
+
11
+ ## Enhancements
12
+
13
+ - feat(events): implement 'filter_created_at' property
14
+ - feat(mutual-authentication): implement 'include' property
15
+ - feat(object-store): implement new Object Store API endpoints
16
+ - feat(settings): implement Service Settings 'update' endpoint
17
+
18
+ ## Documentation
19
+
20
+ - docs(backend): keepalive_time
21
+ - docs(pop): region, shield, latitude, longitude
22
+ - docs(product-enablement): brotli_compression
23
+ - docs(resource): terminology
24
+ - docs(results): fanout properties
25
+ - docs(tls/subscriptions): new 'failed' state
26
+ - docs(user): 'login' modification note removed
27
+
3
28
  ## [v4.0.0](https://github.com/fastly/fastly-ruby/releases/tag/v4.0.0) (2022-12-15)
4
29
 
5
30
  [Full Changelog](https://github.com/fastly/fastly-ruby/compare/v3.0.2...v4.0.0)
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- fastly (4.1.0)
4
+ fastly (4.2.0)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
data/README.md CHANGED
@@ -6,7 +6,7 @@ A Ruby client library for interacting with most facets of the [Fastly API](https
6
6
  > The previous 3.x version is no longer supported, but can be found at https://github.com/fastly/fastly-ruby/tree/v3.x.
7
7
 
8
8
 
9
- > ⚠️ This client library (`v4.1.0`) is an early-access release. Features may change without notice. Use at your own risk.
9
+ > ⚠️ This client library (`4.2.0`) is an early-access release. Features may change without notice. Use at your own risk.
10
10
 
11
11
  **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).
12
12
 
@@ -18,7 +18,7 @@ Read about the [Fastly Product Lifecycle](https://docs.fastly.com/products/fastl
18
18
  To install via RubyGems, add the following to your project's `Gemfile`:
19
19
 
20
20
  ```ruby
21
- gem 'fastly', '~> v4.1.0'
21
+ gem 'fastly', '~> 4.2.0'
22
22
  ```
23
23
 
24
24
  Then run `bundle install`.
@@ -327,13 +327,9 @@ Class | Method | Description
327
327
  [*Fastly::MutualAuthenticationApi*](docs/MutualAuthenticationApi.md) | [**list_mutual_authentications**](docs/MutualAuthenticationApi.md#list_mutual_authentications) | List Mutual Authentications
328
328
  [*Fastly::MutualAuthenticationApi*](docs/MutualAuthenticationApi.md) | [**patch_mutual_authentication**](docs/MutualAuthenticationApi.md#patch_mutual_authentication) | Update a Mutual Authentication
329
329
  [*Fastly::ObjectStoreApi*](docs/ObjectStoreApi.md) | [**create_store**](docs/ObjectStoreApi.md#create_store) | Create an object store.
330
- [*Fastly::ObjectStoreApi*](docs/ObjectStoreApi.md) | [**delete_key_from_store**](docs/ObjectStoreApi.md#delete_key_from_store) | Delete object store key.
331
330
  [*Fastly::ObjectStoreApi*](docs/ObjectStoreApi.md) | [**delete_store**](docs/ObjectStoreApi.md#delete_store) | Delete an object store.
332
- [*Fastly::ObjectStoreApi*](docs/ObjectStoreApi.md) | [**get_keys**](docs/ObjectStoreApi.md#get_keys) | List object store keys.
333
331
  [*Fastly::ObjectStoreApi*](docs/ObjectStoreApi.md) | [**get_store**](docs/ObjectStoreApi.md#get_store) | Describe an object store.
334
332
  [*Fastly::ObjectStoreApi*](docs/ObjectStoreApi.md) | [**get_stores**](docs/ObjectStoreApi.md#get_stores) | List object stores.
335
- [*Fastly::ObjectStoreApi*](docs/ObjectStoreApi.md) | [**get_value_for_key**](docs/ObjectStoreApi.md#get_value_for_key) | Get object store key value.
336
- [*Fastly::ObjectStoreApi*](docs/ObjectStoreApi.md) | [**set_value_for_key**](docs/ObjectStoreApi.md#set_value_for_key) | Insert object store key-value.
337
333
  [*Fastly::PackageApi*](docs/PackageApi.md) | [**get_package**](docs/PackageApi.md#get_package) | Get details of the service's Compute@Edge package.
338
334
  [*Fastly::PackageApi*](docs/PackageApi.md) | [**put_package**](docs/PackageApi.md#put_package) | Upload a Compute@Edge package.
339
335
  [*Fastly::PoolApi*](docs/PoolApi.md) | [**create_server_pool**](docs/PoolApi.md#create_server_pool) | Create a server pool
@@ -358,11 +354,11 @@ Class | Method | Description
358
354
  [*Fastly::RequestSettingsApi*](docs/RequestSettingsApi.md) | [**get_request_settings**](docs/RequestSettingsApi.md#get_request_settings) | Get a Request Settings object
359
355
  [*Fastly::RequestSettingsApi*](docs/RequestSettingsApi.md) | [**list_request_settings**](docs/RequestSettingsApi.md#list_request_settings) | List Request Settings objects
360
356
  [*Fastly::RequestSettingsApi*](docs/RequestSettingsApi.md) | [**update_request_settings**](docs/RequestSettingsApi.md#update_request_settings) | Update a Request Settings object
361
- [*Fastly::ResourceApi*](docs/ResourceApi.md) | [**create_resource**](docs/ResourceApi.md#create_resource) | Create a resource
362
- [*Fastly::ResourceApi*](docs/ResourceApi.md) | [**delete_resource**](docs/ResourceApi.md#delete_resource) | Delete a resource
363
- [*Fastly::ResourceApi*](docs/ResourceApi.md) | [**get_resource**](docs/ResourceApi.md#get_resource) | Display a resource
364
- [*Fastly::ResourceApi*](docs/ResourceApi.md) | [**list_resources**](docs/ResourceApi.md#list_resources) | List resources
365
- [*Fastly::ResourceApi*](docs/ResourceApi.md) | [**update_resource**](docs/ResourceApi.md#update_resource) | Update a resource
357
+ [*Fastly::ResourceApi*](docs/ResourceApi.md) | [**create_resource**](docs/ResourceApi.md#create_resource) | Create a resource link
358
+ [*Fastly::ResourceApi*](docs/ResourceApi.md) | [**delete_resource**](docs/ResourceApi.md#delete_resource) | Delete a resource link
359
+ [*Fastly::ResourceApi*](docs/ResourceApi.md) | [**get_resource**](docs/ResourceApi.md#get_resource) | Display a resource link
360
+ [*Fastly::ResourceApi*](docs/ResourceApi.md) | [**list_resources**](docs/ResourceApi.md#list_resources) | List resource links
361
+ [*Fastly::ResourceApi*](docs/ResourceApi.md) | [**update_resource**](docs/ResourceApi.md#update_resource) | Update a resource link
366
362
  [*Fastly::ResponseObjectApi*](docs/ResponseObjectApi.md) | [**delete_response_object**](docs/ResponseObjectApi.md#delete_response_object) | Delete a Response Object
367
363
  [*Fastly::ResponseObjectApi*](docs/ResponseObjectApi.md) | [**get_response_object**](docs/ResponseObjectApi.md#get_response_object) | Get a Response object
368
364
  [*Fastly::ResponseObjectApi*](docs/ResponseObjectApi.md) | [**list_response_objects**](docs/ResponseObjectApi.md#list_response_objects) | List Response objects
data/docs/Backend.md CHANGED
@@ -15,7 +15,7 @@
15
15
  | **hostname** | **String** | The hostname of the backend. May be used as an alternative to `address` to set the backend location. | [optional] |
16
16
  | **ipv4** | **String** | IPv4 address of the backend. May be used as an alternative to `address` to set the backend location. | [optional] |
17
17
  | **ipv6** | **String** | IPv6 address of the backend. May be used as an alternative to `address` to set the backend location. | [optional] |
18
- | **keepalive_time** | **Integer** | How long to keep a persistent connection to the backend between requests. | [optional] |
18
+ | **keepalive_time** | **Integer** | How long in seconds to keep a persistent connection to the backend between requests. | [optional] |
19
19
  | **max_conn** | **Integer** | Maximum number of concurrent connections this backend will accept. | [optional] |
20
20
  | **max_tls_version** | **String** | Maximum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated. | [optional] |
21
21
  | **min_tls_version** | **String** | Minimum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated. | [optional] |
data/docs/BackendApi.md CHANGED
@@ -43,7 +43,7 @@ opts = {
43
43
  hostname: 'hostname_example', # String | The hostname of the backend. May be used as an alternative to `address` to set the backend location.
44
44
  ipv4: 'ipv4_example', # String | IPv4 address of the backend. May be used as an alternative to `address` to set the backend location.
45
45
  ipv6: 'ipv6_example', # String | IPv6 address of the backend. May be used as an alternative to `address` to set the backend location.
46
- keepalive_time: 56, # Integer | How long to keep a persistent connection to the backend between requests.
46
+ keepalive_time: 56, # Integer | How long in seconds to keep a persistent connection to the backend between requests.
47
47
  max_conn: 56, # Integer | Maximum number of concurrent connections this backend will accept.
48
48
  max_tls_version: 'max_tls_version_example', # String | Maximum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated.
49
49
  min_tls_version: 'min_tls_version_example', # String | Minimum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated.
@@ -90,7 +90,7 @@ end
90
90
  | **hostname** | **String** | The hostname of the backend. May be used as an alternative to `address` to set the backend location. | [optional] |
91
91
  | **ipv4** | **String** | IPv4 address of the backend. May be used as an alternative to `address` to set the backend location. | [optional] |
92
92
  | **ipv6** | **String** | IPv6 address of the backend. May be used as an alternative to `address` to set the backend location. | [optional] |
93
- | **keepalive_time** | **Integer** | How long to keep a persistent connection to the backend between requests. | [optional] |
93
+ | **keepalive_time** | **Integer** | How long in seconds to keep a persistent connection to the backend between requests. | [optional] |
94
94
  | **max_conn** | **Integer** | Maximum number of concurrent connections this backend will accept. | [optional] |
95
95
  | **max_tls_version** | **String** | Maximum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated. | [optional] |
96
96
  | **min_tls_version** | **String** | Minimum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated. | [optional] |
@@ -264,7 +264,7 @@ opts = {
264
264
  hostname: 'hostname_example', # String | The hostname of the backend. May be used as an alternative to `address` to set the backend location.
265
265
  ipv4: 'ipv4_example', # String | IPv4 address of the backend. May be used as an alternative to `address` to set the backend location.
266
266
  ipv6: 'ipv6_example', # String | IPv6 address of the backend. May be used as an alternative to `address` to set the backend location.
267
- keepalive_time: 56, # Integer | How long to keep a persistent connection to the backend between requests.
267
+ keepalive_time: 56, # Integer | How long in seconds to keep a persistent connection to the backend between requests.
268
268
  max_conn: 56, # Integer | Maximum number of concurrent connections this backend will accept.
269
269
  max_tls_version: 'max_tls_version_example', # String | Maximum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated.
270
270
  min_tls_version: 'min_tls_version_example', # String | Minimum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated.
@@ -312,7 +312,7 @@ end
312
312
  | **hostname** | **String** | The hostname of the backend. May be used as an alternative to `address` to set the backend location. | [optional] |
313
313
  | **ipv4** | **String** | IPv4 address of the backend. May be used as an alternative to `address` to set the backend location. | [optional] |
314
314
  | **ipv6** | **String** | IPv6 address of the backend. May be used as an alternative to `address` to set the backend location. | [optional] |
315
- | **keepalive_time** | **Integer** | How long to keep a persistent connection to the backend between requests. | [optional] |
315
+ | **keepalive_time** | **Integer** | How long in seconds to keep a persistent connection to the backend between requests. | [optional] |
316
316
  | **max_conn** | **Integer** | Maximum number of concurrent connections this backend will accept. | [optional] |
317
317
  | **max_tls_version** | **String** | Maximum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated. | [optional] |
318
318
  | **min_tls_version** | **String** | Minimum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated. | [optional] |
@@ -15,7 +15,7 @@
15
15
  | **hostname** | **String** | The hostname of the backend. May be used as an alternative to `address` to set the backend location. | [optional] |
16
16
  | **ipv4** | **String** | IPv4 address of the backend. May be used as an alternative to `address` to set the backend location. | [optional] |
17
17
  | **ipv6** | **String** | IPv6 address of the backend. May be used as an alternative to `address` to set the backend location. | [optional] |
18
- | **keepalive_time** | **Integer** | How long to keep a persistent connection to the backend between requests. | [optional] |
18
+ | **keepalive_time** | **Integer** | How long in seconds to keep a persistent connection to the backend between requests. | [optional] |
19
19
  | **max_conn** | **Integer** | Maximum number of concurrent connections this backend will accept. | [optional] |
20
20
  | **max_tls_version** | **String** | Maximum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated. | [optional] |
21
21
  | **min_tls_version** | **String** | Minimum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated. | [optional] |
@@ -0,0 +1,12 @@
1
+ # Fastly::EnabledProductResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **product** | [**EnabledProductResponseProduct**](EnabledProductResponseProduct.md) | | [optional] |
8
+ | **service** | [**EnabledProductResponseService**](EnabledProductResponseService.md) | | [optional] |
9
+ | **_links** | [**EnabledProductResponseLinks**](EnabledProductResponseLinks.md) | | [optional] |
10
+
11
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
12
+
@@ -1,11 +1,11 @@
1
- # Fastly::EnabledProductProduct
1
+ # Fastly::EnabledProductResponseLinks
2
2
 
3
3
  ## Properties
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **id** | **String** | | [optional] |
8
- | **object** | **String** | | [optional] |
7
+ | **_self** | **String** | Location of resource | [optional] |
8
+ | **service** | **String** | Location of the service resource | [optional] |
9
9
 
10
10
  [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
11
11
 
@@ -1,10 +1,11 @@
1
- # Fastly::ResourceCreateAllOf
1
+ # Fastly::EnabledProductResponseProduct
2
2
 
3
3
  ## Properties
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **resource_id** | **String** | The ID of the linked resource. | [optional] |
7
+ | **id** | **String** | Product identifier | [optional] |
8
+ | **object** | **String** | Name of the object | [optional] |
8
9
 
9
10
  [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
10
11
 
@@ -1,11 +1,11 @@
1
- # Fastly::EnabledProductLinks
1
+ # Fastly::EnabledProductResponseService
2
2
 
3
3
  ## Properties
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **_self** | **String** | | [optional] |
8
- | **service** | **String** | | [optional] |
7
+ | **id** | **String** | Service identifier | [optional] |
8
+ | **object** | **String** | Name of the object | [optional] |
9
9
 
10
10
  [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
11
11
 
@@ -21,7 +21,7 @@ api_instance = Fastly::EnabledProductsApi.new
21
21
  disable_product(opts) # Disable a product
22
22
  ```
23
23
 
24
- Disable a product on a service. Supported product IDs: `origin_inspector`,`domain_inspector`,`image_optimizer`, and `websockets`.
24
+ Disable a product on a service. Supported product IDs: `brotli_compression`,`domain_inspector`,`fanout`,`image_optimizer`,`origin_inspector`, and `websockets`.
25
25
 
26
26
  ### Examples
27
27
 
@@ -56,10 +56,10 @@ nil (empty response body)
56
56
  ## `enable_product()`
57
57
 
58
58
  ```ruby
59
- enable_product(opts): <EnabledProduct> # Enable a product
59
+ enable_product(opts): <EnabledProductResponse> # Enable a product
60
60
  ```
61
61
 
62
- Enable a product on a service. Supported product IDs: `origin_inspector`,`domain_inspector`,`image_optimizer`, and `websockets`.
62
+ Enable a product on a service. Supported product IDs: `brotli_compression`,`domain_inspector`,`fanout`,`image_optimizer`,`origin_inspector`, and `websockets`.
63
63
 
64
64
  ### Examples
65
65
 
@@ -88,17 +88,17 @@ end
88
88
 
89
89
  ### Return type
90
90
 
91
- [**EnabledProduct**](EnabledProduct.md)
91
+ [**EnabledProductResponse**](EnabledProductResponse.md)
92
92
 
93
93
  [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
94
94
  [[Back to README]](../../README.md)
95
95
  ## `get_enabled_product()`
96
96
 
97
97
  ```ruby
98
- get_enabled_product(opts): <EnabledProduct> # Get enabled product
98
+ get_enabled_product(opts): <EnabledProductResponse> # Get enabled product
99
99
  ```
100
100
 
101
- Get enabled product on a service. Supported product IDs: `origin_inspector`,`domain_inspector`,`image_optimizer`, and `websockets`.
101
+ Get enabled product on a service. Supported product IDs: `brotli_compression`,`domain_inspector`,`fanout`,`image_optimizer`,`origin_inspector`, and `websockets`.
102
102
 
103
103
  ### Examples
104
104
 
@@ -127,7 +127,7 @@ end
127
127
 
128
128
  ### Return type
129
129
 
130
- [**EnabledProduct**](EnabledProduct.md)
130
+ [**EnabledProductResponse**](EnabledProductResponse.md)
131
131
 
132
132
  [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
133
133
  [[Back to README]](../../README.md)
data/docs/EventsApi.md CHANGED
@@ -69,6 +69,7 @@ opts = {
69
69
  filter_service_id: 'filter_service_id_example', # String | Limit the results returned to a specific service.
70
70
  filter_user_id: 'filter_user_id_example', # String | Limit the results returned to a specific user.
71
71
  filter_token_id: 'filter_token_id_example', # String | Limit the returned events to a specific token.
72
+ filter_created_at: 'filter_created_at_example', # String | Limit the returned events to a specific time frame. Accepts sub-parameters: lt, lte, gt, gte (e.g., filter[created_at][gt]=2022-01-12).
72
73
  page_number: 1, # Integer | Current page.
73
74
  page_size: 20, # Integer | Number of records per page.
74
75
  sort: 'created_at', # String | The order in which to list the results by creation date.
@@ -92,6 +93,7 @@ end
92
93
  | **filter_service_id** | **String** | Limit the results returned to a specific service. | [optional] |
93
94
  | **filter_user_id** | **String** | Limit the results returned to a specific user. | [optional] |
94
95
  | **filter_token_id** | **String** | Limit the returned events to a specific token. | [optional] |
96
+ | **filter_created_at** | **String** | Limit the returned events to a specific time frame. Accepts sub-parameters: lt, lte, gt, gte (e.g., filter[created_at][gt]&#x3D;2022-01-12). | [optional] |
95
97
  | **page_number** | **Integer** | Current page. | [optional] |
96
98
  | **page_size** | **Integer** | Number of records per page. | [optional][default to 20] |
97
99
  | **sort** | **String** | The order in which to list the results by creation date. | [optional][default to &#39;created_at&#39;] |
@@ -37,7 +37,7 @@ opts = {
37
37
  from: '2020-04-09T18:14:30Z', # String | Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
38
38
  to: '2020-04-09T18:14:30Z', # String | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`.
39
39
  by: 'hour', # String | Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day.
40
- region: 'usa', # String | Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea ([from Aug 2, 2021](https://status.fastly.com/incidents/f83m70cqm258)) * `africa_std` - Africa. * `southamerica_std` - South America.
40
+ region: 'usa', # String | Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea. * `africa_std` - Africa. * `southamerica_std` - South America.
41
41
  }
42
42
 
43
43
  begin
@@ -56,7 +56,7 @@ end
56
56
  | **from** | **String** | Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as &#39;yesterday&#39;, or &#39;two weeks ago&#39;. Default varies based on the value of `by`. | [optional] |
57
57
  | **to** | **String** | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. | [optional][default to &#39;now&#39;] |
58
58
  | **by** | **String** | Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day. | [optional][default to &#39;day&#39;] |
59
- | **region** | **String** | Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea ([from Aug 2, 2021](https://status.fastly.com/incidents/f83m70cqm258)) * `africa_std` - Africa. * `southamerica_std` - South America. | [optional] |
59
+ | **region** | **String** | Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea. * `africa_std` - Africa. * `southamerica_std` - South America. | [optional] |
60
60
 
61
61
  ### Return type
62
62
 
@@ -80,7 +80,7 @@ opts = {
80
80
  from: '2020-04-09T18:14:30Z', # String | Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
81
81
  to: '2020-04-09T18:14:30Z', # String | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`.
82
82
  by: 'hour', # String | Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day.
83
- region: 'usa', # String | Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea ([from Aug 2, 2021](https://status.fastly.com/incidents/f83m70cqm258)) * `africa_std` - Africa. * `southamerica_std` - South America.
83
+ region: 'usa', # String | Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea. * `africa_std` - Africa. * `southamerica_std` - South America.
84
84
  }
85
85
 
86
86
  begin
@@ -99,7 +99,7 @@ end
99
99
  | **from** | **String** | Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as &#39;yesterday&#39;, or &#39;two weeks ago&#39;. Default varies based on the value of `by`. | [optional] |
100
100
  | **to** | **String** | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. | [optional][default to &#39;now&#39;] |
101
101
  | **by** | **String** | Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day. | [optional][default to &#39;day&#39;] |
102
- | **region** | **String** | Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea ([from Aug 2, 2021](https://status.fastly.com/incidents/f83m70cqm258)) * `africa_std` - Africa. * `southamerica_std` - South America. | [optional] |
102
+ | **region** | **String** | Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea. * `africa_std` - Africa. * `southamerica_std` - South America. | [optional] |
103
103
 
104
104
  ### Return type
105
105
 
@@ -124,7 +124,7 @@ opts = {
124
124
  from: '2020-04-09T18:14:30Z', # String | Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
125
125
  to: '2020-04-09T18:14:30Z', # String | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`.
126
126
  by: 'hour', # String | Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day.
127
- region: 'usa', # String | Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea ([from Aug 2, 2021](https://status.fastly.com/incidents/f83m70cqm258)) * `africa_std` - Africa. * `southamerica_std` - South America.
127
+ region: 'usa', # String | Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea. * `africa_std` - Africa. * `southamerica_std` - South America.
128
128
  }
129
129
 
130
130
  begin
@@ -144,7 +144,7 @@ end
144
144
  | **from** | **String** | Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as &#39;yesterday&#39;, or &#39;two weeks ago&#39;. Default varies based on the value of `by`. | [optional] |
145
145
  | **to** | **String** | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. | [optional][default to &#39;now&#39;] |
146
146
  | **by** | **String** | Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day. | [optional][default to &#39;day&#39;] |
147
- | **region** | **String** | Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea ([from Aug 2, 2021](https://status.fastly.com/incidents/f83m70cqm258)) * `africa_std` - Africa. * `southamerica_std` - South America. | [optional] |
147
+ | **region** | **String** | Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea. * `africa_std` - Africa. * `southamerica_std` - South America. | [optional] |
148
148
 
149
149
  ### Return type
150
150
 
@@ -169,7 +169,7 @@ opts = {
169
169
  from: '2020-04-09T18:14:30Z', # String | Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
170
170
  to: '2020-04-09T18:14:30Z', # String | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`.
171
171
  by: 'hour', # String | Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day.
172
- region: 'usa', # String | Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea ([from Aug 2, 2021](https://status.fastly.com/incidents/f83m70cqm258)) * `africa_std` - Africa. * `southamerica_std` - South America.
172
+ region: 'usa', # String | Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea. * `africa_std` - Africa. * `southamerica_std` - South America.
173
173
  }
174
174
 
175
175
  begin
@@ -189,7 +189,7 @@ end
189
189
  | **from** | **String** | Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as &#39;yesterday&#39;, or &#39;two weeks ago&#39;. Default varies based on the value of `by`. | [optional] |
190
190
  | **to** | **String** | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. | [optional][default to &#39;now&#39;] |
191
191
  | **by** | **String** | Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day. | [optional][default to &#39;day&#39;] |
192
- | **region** | **String** | Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea ([from Aug 2, 2021](https://status.fastly.com/incidents/f83m70cqm258)) * `africa_std` - Africa. * `southamerica_std` - South America. | [optional] |
192
+ | **region** | **String** | Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea. * `africa_std` - Africa. * `southamerica_std` - South America. | [optional] |
193
193
 
194
194
  ### Return type
195
195
 
@@ -215,7 +215,7 @@ opts = {
215
215
  from: '2020-04-09T18:14:30Z', # String | Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
216
216
  to: '2020-04-09T18:14:30Z', # String | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`.
217
217
  by: 'hour', # String | Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day.
218
- region: 'usa', # String | Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea ([from Aug 2, 2021](https://status.fastly.com/incidents/f83m70cqm258)) * `africa_std` - Africa. * `southamerica_std` - South America.
218
+ region: 'usa', # String | Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea. * `africa_std` - Africa. * `southamerica_std` - South America.
219
219
  }
220
220
 
221
221
  begin
@@ -236,7 +236,7 @@ end
236
236
  | **from** | **String** | Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as &#39;yesterday&#39;, or &#39;two weeks ago&#39;. Default varies based on the value of `by`. | [optional] |
237
237
  | **to** | **String** | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. | [optional][default to &#39;now&#39;] |
238
238
  | **by** | **String** | Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day. | [optional][default to &#39;day&#39;] |
239
- | **region** | **String** | Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea ([from Aug 2, 2021](https://status.fastly.com/incidents/f83m70cqm258)) * `africa_std` - Africa. * `southamerica_std` - South America. | [optional] |
239
+ | **region** | **String** | Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea. * `africa_std` - Africa. * `southamerica_std` - South America. | [optional] |
240
240
 
241
241
  ### Return type
242
242
 
@@ -1,11 +1,11 @@
1
- # Fastly::GetStoresResponse
1
+ # Fastly::InlineResponse2002
2
2
 
3
3
  ## Properties
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **data** | [**Array&lt;StoreResponse&gt;**](StoreResponse.md) | | [optional] |
8
- | **meta** | [**GetStoresResponseMeta**](GetStoresResponseMeta.md) | | [optional] |
8
+ | **meta** | [**InlineResponse2002Meta**](InlineResponse2002Meta.md) | | [optional] |
9
9
 
10
10
  [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
11
11
 
@@ -1,4 +1,4 @@
1
- # Fastly::GetStoresResponseMeta
1
+ # Fastly::InlineResponse2002Meta
2
2
 
3
3
  ## Properties
4
4
 
@@ -11,13 +11,9 @@ api_instance = Fastly::ObjectStoreApi.new
11
11
  | Method | HTTP request | Description |
12
12
  | ------ | ------------ | ----------- |
13
13
  | [**create_store**](ObjectStoreApi.md#create_store) | **POST** /resources/stores/object | Create an object store. |
14
- | [**delete_key_from_store**](ObjectStoreApi.md#delete_key_from_store) | **DELETE** /resources/stores/object/{store_id}/keys/{key_name} | Delete object store key. |
15
14
  | [**delete_store**](ObjectStoreApi.md#delete_store) | **DELETE** /resources/stores/object/{store_id} | Delete an object store. |
16
- | [**get_keys**](ObjectStoreApi.md#get_keys) | **GET** /resources/stores/object/{store_id}/keys | List object store keys. |
17
15
  | [**get_store**](ObjectStoreApi.md#get_store) | **GET** /resources/stores/object/{store_id} | Describe an object store. |
18
16
  | [**get_stores**](ObjectStoreApi.md#get_stores) | **GET** /resources/stores/object | List object stores. |
19
- | [**get_value_for_key**](ObjectStoreApi.md#get_value_for_key) | **GET** /resources/stores/object/{store_id}/keys/{key_name} | Get object store key value. |
20
- | [**set_value_for_key**](ObjectStoreApi.md#set_value_for_key) | **PUT** /resources/stores/object/{store_id}/keys/{key_name} | Insert object store key-value. |
21
17
 
22
18
 
23
19
  ## `create_store()`
@@ -55,44 +51,6 @@ end
55
51
 
56
52
  [**StoreResponse**](StoreResponse.md)
57
53
 
58
- [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
59
- [[Back to README]](../../README.md)
60
- ## `delete_key_from_store()`
61
-
62
- ```ruby
63
- delete_key_from_store(opts) # Delete object store key.
64
- ```
65
-
66
- Delete a key from a customer store.
67
-
68
- ### Examples
69
-
70
- ```ruby
71
- api_instance = Fastly::ObjectStoreApi.new
72
- opts = {
73
- store_id: 'store_id_example', # String |
74
- key_name: 'key_name_example', # String |
75
- }
76
-
77
- begin
78
- # Delete object store key.
79
- api_instance.delete_key_from_store(opts)
80
- rescue Fastly::ApiError => e
81
- puts "Error when calling ObjectStoreApi->delete_key_from_store: #{e}"
82
- end
83
- ```
84
-
85
- ### Options
86
-
87
- | Name | Type | Description | Notes |
88
- | ---- | ---- | ----------- | ----- |
89
- | **store_id** | **String** | | |
90
- | **key_name** | **String** | | |
91
-
92
- ### Return type
93
-
94
- nil (empty response body)
95
-
96
54
  [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
97
55
  [[Back to README]](../../README.md)
98
56
  ## `delete_store()`
@@ -101,7 +59,7 @@ nil (empty response body)
101
59
  delete_store(opts) # Delete an object store.
102
60
  ```
103
61
 
104
- 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.
62
+ 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).
105
63
 
106
64
  ### Examples
107
65
 
@@ -129,47 +87,6 @@ end
129
87
 
130
88
  nil (empty response body)
131
89
 
132
- [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
133
- [[Back to README]](../../README.md)
134
- ## `get_keys()`
135
-
136
- ```ruby
137
- get_keys(opts): <KeyResponse> # List object store keys.
138
- ```
139
-
140
- List all keys within an object store.
141
-
142
- ### Examples
143
-
144
- ```ruby
145
- api_instance = Fastly::ObjectStoreApi.new
146
- opts = {
147
- store_id: 'store_id_example', # String |
148
- cursor: 'cursor_example', # String |
149
- limit: 56, # Integer |
150
- }
151
-
152
- begin
153
- # List object store keys.
154
- result = api_instance.get_keys(opts)
155
- p result
156
- rescue Fastly::ApiError => e
157
- puts "Error when calling ObjectStoreApi->get_keys: #{e}"
158
- end
159
- ```
160
-
161
- ### Options
162
-
163
- | Name | Type | Description | Notes |
164
- | ---- | ---- | ----------- | ----- |
165
- | **store_id** | **String** | | |
166
- | **cursor** | **String** | | [optional] |
167
- | **limit** | **Integer** | | [optional][default to 100] |
168
-
169
- ### Return type
170
-
171
- [**KeyResponse**](KeyResponse.md)
172
-
173
90
  [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
174
91
  [[Back to README]](../../README.md)
175
92
  ## `get_store()`
@@ -212,7 +129,7 @@ end
212
129
  ## `get_stores()`
213
130
 
214
131
  ```ruby
215
- get_stores(opts): <GetStoresResponse> # List object stores.
132
+ get_stores(opts): <InlineResponse2002> # List object stores.
216
133
  ```
217
134
 
218
135
  Get all stores for a given customer.
@@ -244,87 +161,7 @@ end
244
161
 
245
162
  ### Return type
246
163
 
247
- [**GetStoresResponse**](GetStoresResponse.md)
248
-
249
- [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
250
- [[Back to README]](../../README.md)
251
- ## `get_value_for_key()`
252
-
253
- ```ruby
254
- get_value_for_key(opts): File # Get object store key value.
255
- ```
256
-
257
- Get the value associated with a key.
258
-
259
- ### Examples
260
-
261
- ```ruby
262
- api_instance = Fastly::ObjectStoreApi.new
263
- opts = {
264
- store_id: 'store_id_example', # String |
265
- key_name: 'key_name_example', # String |
266
- }
267
-
268
- begin
269
- # Get object store key value.
270
- result = api_instance.get_value_for_key(opts)
271
- p result
272
- rescue Fastly::ApiError => e
273
- puts "Error when calling ObjectStoreApi->get_value_for_key: #{e}"
274
- end
275
- ```
276
-
277
- ### Options
278
-
279
- | Name | Type | Description | Notes |
280
- | ---- | ---- | ----------- | ----- |
281
- | **store_id** | **String** | | |
282
- | **key_name** | **String** | | |
283
-
284
- ### Return type
285
-
286
- **File**
287
-
288
- [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
289
- [[Back to README]](../../README.md)
290
- ## `set_value_for_key()`
291
-
292
- ```ruby
293
- set_value_for_key(opts): File # Insert object store key-value.
294
- ```
295
-
296
- Insert a new key-value pair into an object store.
297
-
298
- ### Examples
299
-
300
- ```ruby
301
- api_instance = Fastly::ObjectStoreApi.new
302
- opts = {
303
- store_id: 'store_id_example', # String |
304
- key_name: 'key_name_example', # String |
305
- body: File.new('/path/to/some/file'), # File |
306
- }
307
-
308
- begin
309
- # Insert object store key-value.
310
- result = api_instance.set_value_for_key(opts)
311
- p result
312
- rescue Fastly::ApiError => e
313
- puts "Error when calling ObjectStoreApi->set_value_for_key: #{e}"
314
- end
315
- ```
316
-
317
- ### Options
318
-
319
- | Name | Type | Description | Notes |
320
- | ---- | ---- | ----------- | ----- |
321
- | **store_id** | **String** | | |
322
- | **key_name** | **String** | | |
323
- | **body** | **File** | | [optional] |
324
-
325
- ### Return type
326
-
327
- **File**
164
+ [**InlineResponse2002**](InlineResponse2002.md)
328
165
 
329
166
  [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
330
167
  [[Back to README]](../../README.md)