fastly 5.0.0 → 5.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be03f22d46f7b8adf3bf9cd63806b5ff90264542cdcd060eaa0915d4e2a9a6b4
-  data.tar.gz: 452994d5b059c890b99b778739e5996256e14d662cc4e439bbe7e629017e1743
+  metadata.gz: db8e5417ece0e6ea7ae0ae66c558513d458cde749e745707de6faddad5ed7403
+  data.tar.gz: ffb1143b08f03aa7af86554883277bcaaddef3d3c343e1a5878f2810f7db91ab
 SHA512:
-  metadata.gz: 9e3b07f06f6d0a8b260b570b80e31737c11fbb056bcf1f0a68d88df8c54597d75d46782ceea958b9c6700cfecd1b649338533f70b12d5b1f41a60bd5750cb54a
-  data.tar.gz: dab6128c528d940b60c188179592ca3a29471f95192bbce13e46a4847404fdf57526398574472ad85d2cca423981e042508a33ff53f1c3b02cd284bf502e59bd
+  metadata.gz: 24c752858e709856a39d8b15443e61331afb1212826fad1243817e6b8a99365015ffedc22a16de74ee4c843cea7a43009aaf3c0488332f200a73b0e74356371d
+  data.tar.gz: 5b23e6683d575420c74f810081180447319442e50026e9b51889e6d594503d1c17985e840f7378088cd2ddba6b81cc1c6995e65a2431ccfa193953eb8bd47b35

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## [v5.1.1](https://github.com/fastly/fastly-ruby/releases/tag/release/v5.1.1) (2023-05-22)
+
+**Bug fixes:**
+
+- fix(acl): change `version` from int to string.
+- fix(acl): add missing methods for `service_id` and `service_version` properties.
+- fix(backend): make `ssl_check_cert` nullable.
+- fix(purge): skip URL escape for `surrogate_key` param.
+- fix(snippets): change `priority` and `version` from int to string.
+- fix(snippets): add missing methods for `service_id` and `service_version` properties.
+
+## [v5.1.0](https://github.com/fastly/fastly-ruby/releases/tag/release/v5.1.0) (2023-05-17)
+
+**Enhancements:**
+
+- feat(config_store): add Config Store endpoints.
+
 ## [v5.0.0](https://github.com/fastly/fastly-ruby/releases/tag/release/v5.0.0) (2023-05-16)
 
 **Breaking changes:**

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fastly (5.0.0)
+    fastly (5.1.1)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

data/README.md

@@ -12,7 +12,7 @@ A Ruby client library for interacting with most facets of the [Fastly API](https
 To install via RubyGems, add the following to your project's `Gemfile`:
 
 ```ruby
-gem 'fastly', '~> 5.0.0'
+gem 'fastly', '~> 5.1.1'
 ```
 
 Then run `bundle install`.
@@ -103,6 +103,20 @@ Class | Method | Description
 [*Fastly::ConditionApi*](docs/ConditionApi.md) | [**get_condition**](docs/ConditionApi.md#get_condition) | Describe a condition
 [*Fastly::ConditionApi*](docs/ConditionApi.md) | [**list_conditions**](docs/ConditionApi.md#list_conditions) | List conditions
 [*Fastly::ConditionApi*](docs/ConditionApi.md) | [**update_condition**](docs/ConditionApi.md#update_condition) | Update a condition
+[*Fastly::ConfigStoreApi*](docs/ConfigStoreApi.md) | [**create_config_store**](docs/ConfigStoreApi.md#create_config_store) | Create a config store
+[*Fastly::ConfigStoreApi*](docs/ConfigStoreApi.md) | [**delete_config_store**](docs/ConfigStoreApi.md#delete_config_store) | Delete a config store
+[*Fastly::ConfigStoreApi*](docs/ConfigStoreApi.md) | [**get_config_store**](docs/ConfigStoreApi.md#get_config_store) | Describe a config store
+[*Fastly::ConfigStoreApi*](docs/ConfigStoreApi.md) | [**get_config_store_info**](docs/ConfigStoreApi.md#get_config_store_info) | Get config store metadata
+[*Fastly::ConfigStoreApi*](docs/ConfigStoreApi.md) | [**list_config_store_services**](docs/ConfigStoreApi.md#list_config_store_services) | List linked services
+[*Fastly::ConfigStoreApi*](docs/ConfigStoreApi.md) | [**list_config_stores**](docs/ConfigStoreApi.md#list_config_stores) | List config stores
+[*Fastly::ConfigStoreApi*](docs/ConfigStoreApi.md) | [**update_config_store**](docs/ConfigStoreApi.md#update_config_store) | Update a config store
+[*Fastly::ConfigStoreItemApi*](docs/ConfigStoreItemApi.md) | [**bulk_update_config_store_item**](docs/ConfigStoreItemApi.md#bulk_update_config_store_item) | Update multiple entries in a config store
+[*Fastly::ConfigStoreItemApi*](docs/ConfigStoreItemApi.md) | [**create_config_store_item**](docs/ConfigStoreItemApi.md#create_config_store_item) | Create an entry in a config store
+[*Fastly::ConfigStoreItemApi*](docs/ConfigStoreItemApi.md) | [**delete_config_store_item**](docs/ConfigStoreItemApi.md#delete_config_store_item) | Delete an item from a config store
+[*Fastly::ConfigStoreItemApi*](docs/ConfigStoreItemApi.md) | [**get_config_store_item**](docs/ConfigStoreItemApi.md#get_config_store_item) | Get an item from a config store
+[*Fastly::ConfigStoreItemApi*](docs/ConfigStoreItemApi.md) | [**list_config_store_items**](docs/ConfigStoreItemApi.md#list_config_store_items) | List items in a config store
+[*Fastly::ConfigStoreItemApi*](docs/ConfigStoreItemApi.md) | [**update_config_store_item**](docs/ConfigStoreItemApi.md#update_config_store_item) | Update an entry in a config store
+[*Fastly::ConfigStoreItemApi*](docs/ConfigStoreItemApi.md) | [**upsert_config_store_item**](docs/ConfigStoreItemApi.md#upsert_config_store_item) | Insert or update an entry in a config store
 [*Fastly::ContactApi*](docs/ContactApi.md) | [**delete_contact**](docs/ContactApi.md#delete_contact) | Delete a contact
 [*Fastly::ContactApi*](docs/ContactApi.md) | [**list_contacts**](docs/ContactApi.md#list_contacts) | List contacts
 [*Fastly::CustomerApi*](docs/CustomerApi.md) | [**delete_customer**](docs/CustomerApi.md#delete_customer) | Delete a customer
@@ -497,13 +511,6 @@ The fastly-ruby API client currently does not support the following endpoints:
 - [`/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)

data/docs/AclResponse.md

@@ -9,7 +9,7 @@
 | **deleted_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
 | **updated_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
 | **service_id** | **String** |  | [optional][readonly] |
-| **version** | **Integer** |  | [optional][readonly] |
+| **version** | **String** | String representing the number identifying a version of the service. | [optional][readonly] |
 | **id** | **String** |  | [optional][readonly] |
 
 [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

data/docs/AclResponseAllOf.md

@@ -4,6 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **service_id** | **String** |  | [optional][readonly] |
+| **version** | **String** | String representing the number identifying a version of the service. | [optional][readonly] |
 | **id** | **String** |  | [optional][readonly] |
 
 [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

data/docs/BulkUpdateConfigStoreItem.md

@@ -0,0 +1,12 @@
+# Fastly::BulkUpdateConfigStoreItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **item_key** | **String** | Item key, maximum 256 characters. | [optional] |
+| **item_value** | **String** | Item value, maximum 8000 characters. | [optional] |
+| **op** | **String** |  | [optional] |
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
+

data/docs/{BulkUpdateDictionaryItemAllOf.md → BulkUpdateConfigStoreItemAllOf.md}

@@ -1,4 +1,4 @@
-# Fastly::BulkUpdateDictionaryItemAllOf
+# Fastly::BulkUpdateConfigStoreItemAllOf
 
 ## Properties
 

data/docs/BulkUpdateConfigStoreListRequest.md

@@ -0,0 +1,10 @@
+# Fastly::BulkUpdateConfigStoreListRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | [**Array<BulkUpdateConfigStoreItem>**](BulkUpdateConfigStoreItem.md) |  | [optional] |
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
+

data/docs/ConfigStore.md

@@ -0,0 +1,10 @@
+# Fastly::ConfigStore
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the config store. | [optional] |
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
+

data/docs/ConfigStoreApi.md

@@ -0,0 +1,277 @@
+# Fastly::ConfigStoreApi
+
+
+```ruby
+require 'fastly'
+api_instance = Fastly::ConfigStoreApi.new
+```
+
+## Methods
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_config_store**](ConfigStoreApi.md#create_config_store) | **POST** /resources/stores/config | Create a config store |
+| [**delete_config_store**](ConfigStoreApi.md#delete_config_store) | **DELETE** /resources/stores/config/{config_store_id} | Delete a config store |
+| [**get_config_store**](ConfigStoreApi.md#get_config_store) | **GET** /resources/stores/config/{config_store_id} | Describe a config store |
+| [**get_config_store_info**](ConfigStoreApi.md#get_config_store_info) | **GET** /resources/stores/config/{config_store_id}/info | Get config store metadata |
+| [**list_config_store_services**](ConfigStoreApi.md#list_config_store_services) | **GET** /resources/stores/config/{config_store_id}/services | List linked services |
+| [**list_config_stores**](ConfigStoreApi.md#list_config_stores) | **GET** /resources/stores/config | List config stores |
+| [**update_config_store**](ConfigStoreApi.md#update_config_store) | **PUT** /resources/stores/config/{config_store_id} | Update a config store |
+
+
+## `create_config_store()`
+
+```ruby
+create_config_store(opts): <ConfigStoreResponse> # Create a config store
+```
+
+Create a config store.
+
+### Examples
+
+```ruby
+api_instance = Fastly::ConfigStoreApi.new
+opts = {
+    name: 'name_example', # String | The name of the config store.
+}
+
+begin
+  # Create a config store
+  result = api_instance.create_config_store(opts)
+  p result
+rescue Fastly::ApiError => e
+  puts "Error when calling ConfigStoreApi->create_config_store: #{e}"
+end
+```
+
+### Options
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the config store. | [optional] |
+
+### Return type
+
+[**ConfigStoreResponse**](ConfigStoreResponse.md)
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to README]](../../README.md)
+## `delete_config_store()`
+
+```ruby
+delete_config_store(opts): <InlineResponse200> # Delete a config store
+```
+
+Delete a config store.
+
+### Examples
+
+```ruby
+api_instance = Fastly::ConfigStoreApi.new
+opts = {
+    config_store_id: 'config_store_id_example', # String | An alphanumeric string identifying the config store.
+}
+
+begin
+  # Delete a config store
+  result = api_instance.delete_config_store(opts)
+  p result
+rescue Fastly::ApiError => e
+  puts "Error when calling ConfigStoreApi->delete_config_store: #{e}"
+end
+```
+
+### Options
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **config_store_id** | **String** | An alphanumeric string identifying the config store. |  |
+
+### Return type
+
+[**InlineResponse200**](InlineResponse200.md)
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to README]](../../README.md)
+## `get_config_store()`
+
+```ruby
+get_config_store(opts): <ConfigStoreResponse> # Describe a config store
+```
+
+Describe a config store by its identifier.
+
+### Examples
+
+```ruby
+api_instance = Fastly::ConfigStoreApi.new
+opts = {
+    config_store_id: 'config_store_id_example', # String | An alphanumeric string identifying the config store.
+}
+
+begin
+  # Describe a config store
+  result = api_instance.get_config_store(opts)
+  p result
+rescue Fastly::ApiError => e
+  puts "Error when calling ConfigStoreApi->get_config_store: #{e}"
+end
+```
+
+### Options
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **config_store_id** | **String** | An alphanumeric string identifying the config store. |  |
+
+### Return type
+
+[**ConfigStoreResponse**](ConfigStoreResponse.md)
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to README]](../../README.md)
+## `get_config_store_info()`
+
+```ruby
+get_config_store_info(opts): <ConfigStoreInfoResponse> # Get config store metadata
+```
+
+Retrieve metadata for a single config store.
+
+### Examples
+
+```ruby
+api_instance = Fastly::ConfigStoreApi.new
+opts = {
+    config_store_id: 'config_store_id_example', # String | An alphanumeric string identifying the config store.
+}
+
+begin
+  # Get config store metadata
+  result = api_instance.get_config_store_info(opts)
+  p result
+rescue Fastly::ApiError => e
+  puts "Error when calling ConfigStoreApi->get_config_store_info: #{e}"
+end
+```
+
+### Options
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **config_store_id** | **String** | An alphanumeric string identifying the config store. |  |
+
+### Return type
+
+[**ConfigStoreInfoResponse**](ConfigStoreInfoResponse.md)
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to README]](../../README.md)
+## `list_config_store_services()`
+
+```ruby
+list_config_store_services(opts): Object # List linked services
+```
+
+List services linked to a config store
+
+### Examples
+
+```ruby
+api_instance = Fastly::ConfigStoreApi.new
+opts = {
+    config_store_id: 'config_store_id_example', # String | An alphanumeric string identifying the config store.
+}
+
+begin
+  # List linked services
+  result = api_instance.list_config_store_services(opts)
+  p result
+rescue Fastly::ApiError => e
+  puts "Error when calling ConfigStoreApi->list_config_store_services: #{e}"
+end
+```
+
+### Options
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **config_store_id** | **String** | An alphanumeric string identifying the config store. |  |
+
+### Return type
+
+**Object**
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to README]](../../README.md)
+## `list_config_stores()`
+
+```ruby
+list_config_stores: <Array<ConfigStoreResponse>> # List config stores
+```
+
+List config stores.
+
+### Examples
+
+```ruby
+api_instance = Fastly::ConfigStoreApi.new
+
+begin
+  # List config stores
+  result = api_instance.list_config_stores
+  p result
+rescue Fastly::ApiError => e
+  puts "Error when calling ConfigStoreApi->list_config_stores: #{e}"
+end
+```
+
+### Options
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;ConfigStoreResponse&gt;**](ConfigStoreResponse.md)
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to README]](../../README.md)
+## `update_config_store()`
+
+```ruby
+update_config_store(opts): <ConfigStoreResponse> # Update a config store
+```
+
+Update a config store.
+
+### Examples
+
+```ruby
+api_instance = Fastly::ConfigStoreApi.new
+opts = {
+    config_store_id: 'config_store_id_example', # String | An alphanumeric string identifying the config store.
+    name: 'name_example', # String | The name of the config store.
+}
+
+begin
+  # Update a config store
+  result = api_instance.update_config_store(opts)
+  p result
+rescue Fastly::ApiError => e
+  puts "Error when calling ConfigStoreApi->update_config_store: #{e}"
+end
+```
+
+### Options
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **config_store_id** | **String** | An alphanumeric string identifying the config store. |  |
+| **name** | **String** | The name of the config store. | [optional] |
+
+### Return type
+
+[**ConfigStoreResponse**](ConfigStoreResponse.md)
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to README]](../../README.md)

data/docs/ConfigStoreInfoResponse.md

@@ -0,0 +1,10 @@
+# Fastly::ConfigStoreInfoResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **item_count** | **Integer** | The number of items currently in the config store. | [optional] |
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
+

data/docs/ConfigStoreItem.md

@@ -0,0 +1,11 @@
+# Fastly::ConfigStoreItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **item_key** | **String** | Item key, maximum 256 characters. | [optional] |
+| **item_value** | **String** | Item value, maximum 8000 characters. | [optional] |
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
+