fastly 4.0.1.pre.alpha.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d18154c172c2a3f85cfd19d89cebbe7184148ffbe892e87fb7de6feb020a3e09
-  data.tar.gz: 0c37e40af9f70504c8af44778f966251b90bc7752d41b1f3b8c3f957f293600e
+  metadata.gz: 5b993587a1bc1831cf06074525d6ebeb5678ca49144349d01e4ea59380628cdf
+  data.tar.gz: 16fd9f49b6d5efa5bcb4b377e666a46124d867717809ebd55d7b57fcd1054676
 SHA512:
-  metadata.gz: dfd8a7cfbd96c17dfb728010e5f22f5055aed739660867a134dc41be84ed2183e631dc8f2c1273268574b6dbe2c7030e09afe0e39febc6ccc886e0e2db5a5258
-  data.tar.gz: 9ac4619b5b5a4ca1ade8f32696aa1fdeb24c376616df0d05445bf55294e73b3df48bc69f09e4a98632bc20fa805719b02599141f9fd77086a2e55b0b13e9c4a4
+  metadata.gz: fb63451ed405de43a59efd16345d694fce683e5ad28dfc3e16d453c82ebb661e3a6d4fe6bb49b674c353241ea19443e1dc4c9af592671706523bdfc136977e8d
+  data.tar.gz: b989a523060f1f4f9c3b4f6574090059b7c61ec02743d69cbac9a1b54ebde5fd3c1642cef15733c85f10f1c44ba2c4afdd0a908348b6ab53efb89fe63529f388

data/CHANGELOG.md

@@ -1,4 +1,15 @@
-# Change Log
+# Changelog
+
+## [v4.0.0](https://github.com/fastly/fastly-ruby/releases/tag/v4.0.0) (2022-12-15)
+
+[Full Changelog](https://github.com/fastly/fastly-ruby/compare/v3.0.2...v4.0.0)
+
+**Breaking:**
+
+* New interface from code-generated API client [#183](https://github.com/fastly/fastly-ruby/pull/183) 
+  * [Blog post: Better Fastly API clients with OpenAPI Generator](https://dev.to/fastly/better-fastly-api-clients-with-openapi-generator-3lno)
+  * [Documentation](https://github.com/fastly/fastly-ruby#documentation-for-api-endpoints)
+  * [Unsupported API endpoints](https://github.com/fastly/fastly-ruby#issues)
 
 ## [v3.0.2](https://github.com/fastly/fastly-ruby/tree/v3.0.2) (2021-06-30)
 
@@ -429,28 +440,28 @@
 * major refactor and reorganization of code (merged branch https://github.com/fastly/fastly-ruby/pull/31)
 * bump curb dep to 0.8.6 for ruby 2.1 support (see https://github.com/fastly/fastly-ruby/issues/43)
 
-2014-09-29 v1.1.4
+## 2014-09-29 v1.1.4
 * Require API Key for purge by key requests
 
-2014-07-25 v1.1.3
+## 2014-07-25 v1.1.3
 * Add test:unit rake task
 * Add Rubocop and some rubocop cleanup
 * Clarify gem name in documentation
 * Fix a bug in the `Fastly.get_options` method
 * Add `bin/fastly_create_domain` script to easily create domain
 
-2014-06-12 v1.1.2
+## 2014-06-12 v1.1.2
 * Replace `String#underscore` with `Fastly::Util.class_to_path` method.
 * Add first true unit test
 * Add `test_helper.rb`
 * Add `pry` as dependency
 * Add console Rake task
 
-2013-11-26 v1.02
+## 2013-11-26 v1.02
 
 Fix rdoc dependency and quorum spelling (Kristoffer Renholm)
 
-2013-10-03 v1.01
+## 2013-10-03 v1.01
 
 Add historical stats functionality
 Fix settings
@@ -460,47 +471,44 @@ Fix some doc stuff (Sam Sharpe)
 Reorganize library (Eric Saxby & Paul Henry)
 Fix purge_all, purge_by_key and details (Kazuki Ohta)
 
-2013-07-16 v1.00
+## 2013-07-16 v1.00
 
 Fix delete VCL (thanks Andrian Jardan)
 
-2012-05-01 v0.99
+## 2012-05-01 v0.99
 
 Fix some SSL issues
 Allow some admin functionality
 
-2012-02-02 v0.98
+## 2012-02-02 v0.98
 
 Make deactivate! work
 Add active?
 Add Service.purge_by_key
 
-2012-01-27 v0.97
+## 2012-01-27 v0.97
 
 Fix invoice tests with new billing API
 
-2012-01-16 v0.96
+## 2012-01-16 v0.96
 
 Fix version.locked?
 Make fastly_upload_vcl work
 
-2011-12-19 v0.95
+## 2011-12-19 v0.95
 
 Fix the way invoices and stats are fetched
 
-2011-12-15 v0.9
+## 2011-12-15 v0.9
 
 Add mapping from backends to directors and directors to origins
 
-2011-11-03 v0.8
+## 2011-11-03 v0.8
 
 Add list_* to all objects
 
 Add Healthchecks and Syslog endpoint streaming
 
-2011-11-02 v0.5
+## 2011-11-02 v0.5
 
 Initial releasee
-
-
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fastly (4.0.1.pre.alpha.0)
+    fastly (4.1.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

data/README.md

@@ -2,13 +2,23 @@
 
 A Ruby client library for interacting with most facets of the [Fastly API](https://developer.fastly.com/reference/api).
 
+> NOTE: This 4.x release is a new [generated API client](https://dev.to/fastly/better-fastly-api-clients-with-openapi-generator-3lno) for the Fastly API.
+> The previous 3.x version is no longer supported, but can be found at https://github.com/fastly/fastly-ruby/tree/v3.x.
+
+
+> ⚠️ This client library (`v4.1.0`)  is an early-access release. Features may change without notice. Use at your own risk.
+
+**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).
+
+Read about the [Fastly Product Lifecycle](https://docs.fastly.com/products/fastly-product-lifecycle).
+
 
 ## Installation
 
 To install via RubyGems, add the following to your project's `Gemfile`:
 
 ```ruby
-gem 'fastly', '~> 4.0.0'
+gem 'fastly', '~> v4.1.0'
 ```
 
 Then run `bundle install`.
@@ -55,7 +65,7 @@ end
 
 Alternatively, set the `FASTLY_API_TOKEN` environment variable instead of setting `api_token`.
 
-## Endpoints
+## Documentation for API Endpoints
 
 The main documentation for the Fastly API can be found on our [Developer Hub](https://developer.fastly.com/reference/api).
 
@@ -316,6 +326,14 @@ Class | Method | Description
 [*Fastly::MutualAuthenticationApi*](docs/MutualAuthenticationApi.md) | [**get_mutual_authentication**](docs/MutualAuthenticationApi.md#get_mutual_authentication) | Get a Mutual Authentication
 [*Fastly::MutualAuthenticationApi*](docs/MutualAuthenticationApi.md) | [**list_mutual_authentications**](docs/MutualAuthenticationApi.md#list_mutual_authentications) | List Mutual Authentications
 [*Fastly::MutualAuthenticationApi*](docs/MutualAuthenticationApi.md) | [**patch_mutual_authentication**](docs/MutualAuthenticationApi.md#patch_mutual_authentication) | Update a Mutual Authentication
+[*Fastly::ObjectStoreApi*](docs/ObjectStoreApi.md) | [**create_store**](docs/ObjectStoreApi.md#create_store) | Create an object store.
+[*Fastly::ObjectStoreApi*](docs/ObjectStoreApi.md) | [**delete_key_from_store**](docs/ObjectStoreApi.md#delete_key_from_store) | Delete object store key.
+[*Fastly::ObjectStoreApi*](docs/ObjectStoreApi.md) | [**delete_store**](docs/ObjectStoreApi.md#delete_store) | Delete an object store.
+[*Fastly::ObjectStoreApi*](docs/ObjectStoreApi.md) | [**get_keys**](docs/ObjectStoreApi.md#get_keys) | List object store keys.
+[*Fastly::ObjectStoreApi*](docs/ObjectStoreApi.md) | [**get_store**](docs/ObjectStoreApi.md#get_store) | Describe an object store.
+[*Fastly::ObjectStoreApi*](docs/ObjectStoreApi.md) | [**get_stores**](docs/ObjectStoreApi.md#get_stores) | List object stores.
+[*Fastly::ObjectStoreApi*](docs/ObjectStoreApi.md) | [**get_value_for_key**](docs/ObjectStoreApi.md#get_value_for_key) | Get object store key value.
+[*Fastly::ObjectStoreApi*](docs/ObjectStoreApi.md) | [**set_value_for_key**](docs/ObjectStoreApi.md#set_value_for_key) | Insert object store key-value.
 [*Fastly::PackageApi*](docs/PackageApi.md) | [**get_package**](docs/PackageApi.md#get_package) | Get details of the service's Compute@Edge package.
 [*Fastly::PackageApi*](docs/PackageApi.md) | [**put_package**](docs/PackageApi.md#put_package) | Upload a Compute@Edge package.
 [*Fastly::PoolApi*](docs/PoolApi.md) | [**create_server_pool**](docs/PoolApi.md#create_server_pool) | Create a server pool
@@ -367,6 +385,7 @@ Class | Method | Description
 [*Fastly::ServiceAuthorizationsApi*](docs/ServiceAuthorizationsApi.md) | [**show_service_authorization**](docs/ServiceAuthorizationsApi.md#show_service_authorization) | Show service authorization
 [*Fastly::ServiceAuthorizationsApi*](docs/ServiceAuthorizationsApi.md) | [**update_service_authorization**](docs/ServiceAuthorizationsApi.md#update_service_authorization) | Update service authorization
 [*Fastly::SettingsApi*](docs/SettingsApi.md) | [**get_service_settings**](docs/SettingsApi.md#get_service_settings) | Get service settings
+[*Fastly::SettingsApi*](docs/SettingsApi.md) | [**update_service_settings**](docs/SettingsApi.md#update_service_settings) | Update service settings
 [*Fastly::SnippetApi*](docs/SnippetApi.md) | [**create_snippet**](docs/SnippetApi.md#create_snippet) | Create a snippet
 [*Fastly::SnippetApi*](docs/SnippetApi.md) | [**delete_snippet**](docs/SnippetApi.md#delete_snippet) | Delete a snippet
 [*Fastly::SnippetApi*](docs/SnippetApi.md) | [**get_snippet**](docs/SnippetApi.md#get_snippet) | Get a versioned snippet
@@ -476,83 +495,6 @@ Class | Method | Description
 
 ## Issues
 
-The fastly-ruby API client currently does not support the following endpoints:
-
-- [`/content/edge_check`](https://developer.fastly.com/reference/api/utils/content) (GET)
-- [`/customer/{customer_id}/contacts`](https://developer.fastly.com/reference/api/account/contact) (POST)
-- [`/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/object/{store_id}/keys/{key_name}`](https://developer.fastly.com/reference/api/) (DELETE, GET, PUT)
-- [`/resources/stores/object/{store_id}/keys`](https://developer.fastly.com/reference/api/) (GET)
-- [`/resources/stores/object/{store_id}`](https://developer.fastly.com/reference/api/) (DELETE, GET)
-- [`/resources/stores/object`](https://developer.fastly.com/reference/api/) (GET, POST)
-- [`/resources/stores/secret/{store_id}/secrets/{secret_name}`](https://developer.fastly.com/reference/api/) (DELETE, GET)
-- [`/resources/stores/secret/{store_id}/secrets`](https://developer.fastly.com/reference/api/) (GET, POST)
-- [`/resources/stores/secret/{store_id}`](https://developer.fastly.com/reference/api/) (DELETE, GET)
-- [`/resources/stores/secret`](https://developer.fastly.com/reference/api/) (GET, POST)
-- [`/roles/{role_id}/permissions`](https://developer.fastly.com/reference/api/account/roles) (DELETE, POST)
-- [`/roles/{role_id}`](https://developer.fastly.com/reference/api/account/roles) (PATCH)
-- [`/roles`](https://developer.fastly.com/reference/api/account/roles) (POST)
-- [`/service-authorizations`](https://developer.fastly.com/reference/api/account/service-authorization) (DELETE, PATCH)
-- [`/service-groups/{service_group_id}/services`](https://developer.fastly.com/reference/api/account/service-groups) (DELETE, POST)
-- [`/service-groups/{service_group_id}`](https://developer.fastly.com/reference/api/account/service-groups) (PATCH)
-- [`/service-groups`](https://developer.fastly.com/reference/api/account/service-groups) (POST)
-- [`/service/{service_id}/acl/{acl_id}/entries`](https://developer.fastly.com/reference/api/acls/acl-entry) (GET)
-- [`/service/{service_id}/acl/{acl_id}/entry/{acl_entry_id}`](https://developer.fastly.com/reference/api/acls/acl-entry) (GET, PATCH)
-- [`/service/{service_id}/acl/{acl_id}/entry`](https://developer.fastly.com/reference/api/acls/acl-entry) (POST)
-- [`/service/{service_id}/dictionary/{dictionary_id}/items`](https://developer.fastly.com/reference/api/dictionaries/dictionary-item) (PATCH)
-- [`/service/{service_id}/version/{version_id}/apex-redirects`](https://developer.fastly.com/reference/api/vcl-services/apex-redirect) (POST)
-- [`/service/{service_id}/version/{version_id}/director/{director_name}`](https://developer.fastly.com/reference/api/load-balancing/directors/director) (PUT)
-- [`/service/{service_id}/version/{version_id}/logging/kafka/{logging_kafka_name}`](https://developer.fastly.com/reference/api/logging/kafka) (PUT)
-- [`/service/{service_id}/version/{version_id}/logging/kinesis/{logging_kinesis_name}`](https://developer.fastly.com/reference/api/logging/kinesis) (PUT)
-- [`/service/{service_id}/version/{version_id}/rate-limiters`](https://developer.fastly.com/reference/api/vcl-services/rate-limiter) (POST)
-- [`/service/{service_id}/version/{version_id}/request_settings`](https://developer.fastly.com/reference/api/vcl-services/request-settings) (POST)
-- [`/service/{service_id}/version/{version_id}/response_object/{response_object_name}`](https://developer.fastly.com/reference/api/vcl-services/response-object) (PUT)
-- [`/service/{service_id}/version/{version_id}/response_object`](https://developer.fastly.com/reference/api/vcl-services/response-object) (POST)
-- [`/service/{service_id}/version/{version_id}/settings`](https://developer.fastly.com/reference/api/vcl-services/settings) (PUT)
-- [`/service/{service_id}/version/{version_id}/snippet/{snippet_name}`](https://developer.fastly.com/reference/api/vcl-services/snippet) (PUT)
-- [`/service/{service_id}/version/{version_id}/wafs/{firewall_id}`](https://developer.fastly.com/reference/api/legacy-waf/firewall) (GET, PATCH)
-- [`/service/{service_id}/version/{version_id}/wafs`](https://developer.fastly.com/reference/api/legacy-waf/firewall) (GET, POST)
-- [`/service/{service_id}/wafs/{firewall_id}/owasp`](https://developer.fastly.com/reference/api/legacy-waf/owasp) (GET, PATCH, POST)
-- [`/service/{service_id}/wafs/{firewall_id}/rule_statuses`](https://developer.fastly.com/reference/api/legacy-waf/rule-status) (GET, POST)
-- [`/service/{service_id}/wafs/{firewall_id}/rules/{waf_rule_id}/rule_status`](https://developer.fastly.com/reference/api/legacy-waf/rule-status) (GET, PATCH)
-- [`/service/{service_id}/wafs/{firewall_id}/ruleset/preview`](https://developer.fastly.com/reference/api/legacy-waf/ruleset) (GET)
-- [`/service/{service_id}/wafs/{firewall_id}/ruleset`](https://developer.fastly.com/reference/api/legacy-waf/ruleset) (GET, PATCH)
-- [`/service/{service_id}/wafs/{firewall_id}/update_statuses/{update_status_id}`](https://developer.fastly.com/reference/api/legacy-waf/update-status) (GET)
-- [`/service/{service_id}/wafs/{firewall_id}/update_statuses`](https://developer.fastly.com/reference/api/legacy-waf/update-status) (GET)
-- [`/sudo`](https://developer.fastly.com/reference/api/utils/sudo) (POST)
-- [`/tls/activations/{tls_activation_id}`](https://developer.fastly.com/reference/api/tls/mutual-tls/activations) (GET, PATCH)
-- [`/tls/activations`](https://developer.fastly.com/reference/api/tls/mutual-tls/activations) (GET)
-- [`/tokens`](https://developer.fastly.com/reference/api/auth-tokens/user) (DELETE, POST)
-- [`/user-groups/{user_group_id}/members`](https://developer.fastly.com/reference/api/account/user-groups) (DELETE, POST)
-- [`/user-groups/{user_group_id}/roles`](https://developer.fastly.com/reference/api/account/user-groups) (DELETE, POST)
-- [`/user-groups/{user_group_id}/service-groups`](https://developer.fastly.com/reference/api/account/user-groups) (DELETE, POST)
-- [`/user-groups/{user_group_id}`](https://developer.fastly.com/reference/api/account/user-groups) (PATCH)
-- [`/user-groups`](https://developer.fastly.com/reference/api/account/user-groups) (POST)
-- [`/v1/channel/{service_id}/ts/h/limit/{max_entries}`](https://developer.fastly.com/reference/api/metrics-stats/origin-insights) (GET)
-- [`/v1/channel/{service_id}/ts/h`](https://developer.fastly.com/reference/api/metrics-stats/origin-insights) (GET)
-- [`/v1/channel/{service_id}/ts/{start_timestamp}`](https://developer.fastly.com/reference/api/metrics-stats/origin-insights) (GET)
-- [`/v1/domains/{service_id}/ts/h/limit/{max_entries}`](https://developer.fastly.com/reference/api/metrics-stats/domain-inspector/real-time) (GET)
-- [`/v1/domains/{service_id}/ts/h`](https://developer.fastly.com/reference/api/metrics-stats/domain-inspector/real-time) (GET)
-- [`/v1/domains/{service_id}/ts/{start_timestamp}`](https://developer.fastly.com/reference/api/metrics-stats/domain-inspector/real-time) (GET)
-- [`/v1/origins/{service_id}/ts/h/limit/{max_entries}`](https://developer.fastly.com/reference/api/metrics-stats/origin-inspector/real-time) (GET)
-- [`/v1/origins/{service_id}/ts/h`](https://developer.fastly.com/reference/api/metrics-stats/origin-inspector/real-time) (GET)
-- [`/v1/origins/{service_id}/ts/{start_timestamp}`](https://developer.fastly.com/reference/api/metrics-stats/origin-inspector/real-time) (GET)
-- [`/waf/firewalls/{firewall_id}/versions/{version_id}/active-rules`](https://developer.fastly.com/reference/api/waf/rules/active) (DELETE)
-- [`/wafs/configuration_sets/{configuration_set_id}/relationships/wafs`](https://developer.fastly.com/reference/api/legacy-waf/configuration-set) (GET, PATCH)
-- [`/wafs/configuration_sets`](https://developer.fastly.com/reference/api/legacy-waf/configuration-set) (GET)
-- [`/wafs/rules/{waf_rule_id}/vcl`](https://developer.fastly.com/reference/api/legacy-waf/rule) (GET)
-- [`/wafs/rules/{waf_rule_id}`](https://developer.fastly.com/reference/api/legacy-waf/rule) (GET)
-- [`/wafs/rules`](https://developer.fastly.com/reference/api/legacy-waf/rule) (GET)
-- [`/wafs/tags`](https://developer.fastly.com/reference/api/legacy-waf/tag) (GET)
-- [`/wafs/{firewall_id}/disable`](https://developer.fastly.com/reference/api/legacy-waf/firewall) (PATCH)
-- [`/wafs/{firewall_id}/enable`](https://developer.fastly.com/reference/api/legacy-waf/firewall) (PATCH)
-- [`/wafs/{firewall_id}/rules/{waf_rule_id}/vcl`](https://developer.fastly.com/reference/api/legacy-waf/rule) (GET)
-- [`/wafs/{firewall_id}`](https://developer.fastly.com/reference/api/legacy-waf/firewall) (GET)
-- [`/wafs`](https://developer.fastly.com/reference/api/legacy-waf/firewall) (GET)
-
-
 If you encounter any non-security-related bug or unexpected behavior, please [file an issue][bug]
 using the bug report template.
 

data/docs/GetStoresResponse.md

@@ -0,0 +1,11 @@
+# Fastly::GetStoresResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<StoreResponse>**](StoreResponse.md) |  | [optional] |
+| **meta** | [**GetStoresResponseMeta**](GetStoresResponseMeta.md) |  | [optional] |
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
+

data/docs/GetStoresResponseMeta.md

@@ -0,0 +1,11 @@
+# Fastly::GetStoresResponseMeta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **next_cursor** | **String** | Cursor for the next page. | [optional] |
+| **limit** | **Integer** | Entries returned. | [optional] |
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
+

data/docs/KeyResponse.md

@@ -0,0 +1,11 @@
+# Fastly::KeyResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | **Array<String>** |  | [optional] |
+| **meta** | [**GetStoresResponseMeta**](GetStoresResponseMeta.md) |  | [optional] |
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
+

data/docs/MutualAuthenticationApi.md

@@ -104,6 +104,7 @@ Show a Mutual Authentication.
 api_instance = Fastly::MutualAuthenticationApi.new
 opts = {
     mutual_authentication_id: 'mutual_authentication_id_example', # String | Alphanumeric string identifying a mutual authentication.
+    include: 'include_example', # 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. 
 }
 
 begin
@@ -119,6 +120,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **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] |
 | **mutual_authentication_id** | **String** | Alphanumeric string identifying a mutual authentication. |  |
 
 ### Return type
@@ -140,6 +142,7 @@ List all mutual authentications.
 ```ruby
 api_instance = Fastly::MutualAuthenticationApi.new
 opts = {
+    include: 'include_example', # 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. 
     page_number: 1, # Integer | Current page.
     page_size: 20, # Integer | Number of records per page.
 }
@@ -157,6 +160,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **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] |
 | **page_number** | **Integer** | Current page. | [optional] |
 | **page_size** | **Integer** | Number of records per page. | [optional][default to 20] |
 

data/docs/ObjectStoreApi.md

@@ -0,0 +1,330 @@
+# Fastly::ObjectStoreApi
+
+
+```ruby
+require 'fastly'
+api_instance = Fastly::ObjectStoreApi.new
+```
+
+## Methods
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_store**](ObjectStoreApi.md#create_store) | **POST** /resources/stores/object | Create an object store. |
+| [**delete_key_from_store**](ObjectStoreApi.md#delete_key_from_store) | **DELETE** /resources/stores/object/{store_id}/keys/{key_name} | Delete object store key. |
+| [**delete_store**](ObjectStoreApi.md#delete_store) | **DELETE** /resources/stores/object/{store_id} | Delete an object store. |
+| [**get_keys**](ObjectStoreApi.md#get_keys) | **GET** /resources/stores/object/{store_id}/keys | List object store keys. |
+| [**get_store**](ObjectStoreApi.md#get_store) | **GET** /resources/stores/object/{store_id} | Describe an object store. |
+| [**get_stores**](ObjectStoreApi.md#get_stores) | **GET** /resources/stores/object | List object stores. |
+| [**get_value_for_key**](ObjectStoreApi.md#get_value_for_key) | **GET** /resources/stores/object/{store_id}/keys/{key_name} | Get object store key value. |
+| [**set_value_for_key**](ObjectStoreApi.md#set_value_for_key) | **PUT** /resources/stores/object/{store_id}/keys/{key_name} | Insert object store key-value. |
+
+
+## `create_store()`
+
+```ruby
+create_store(opts): <StoreResponse> # Create an object store.
+```
+
+Create a new object store.
+
+### Examples
+
+```ruby
+api_instance = Fastly::ObjectStoreApi.new
+opts = {
+    store: Fastly::Store.new, # Store | 
+}
+
+begin
+  # Create an object store.
+  result = api_instance.create_store(opts)
+  p result
+rescue Fastly::ApiError => e
+  puts "Error when calling ObjectStoreApi->create_store: #{e}"
+end
+```
+
+### Options
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **store** | [**Store**](Store.md) |  | [optional] |
+
+### Return type
+
+[**StoreResponse**](StoreResponse.md)
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to README]](../../README.md)
+## `delete_key_from_store()`
+
+```ruby
+delete_key_from_store(opts) # Delete object store key.
+```
+
+Delete a key from a customer store.
+
+### Examples
+
+```ruby
+api_instance = Fastly::ObjectStoreApi.new
+opts = {
+    store_id: 'store_id_example', # String | 
+    key_name: 'key_name_example', # String | 
+}
+
+begin
+  # Delete object store key.
+  api_instance.delete_key_from_store(opts)
+rescue Fastly::ApiError => e
+  puts "Error when calling ObjectStoreApi->delete_key_from_store: #{e}"
+end
+```
+
+### Options
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **store_id** | **String** |  |  |
+| **key_name** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to README]](../../README.md)
+## `delete_store()`
+
+```ruby
+delete_store(opts) # Delete an object store.
+```
+
+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.
+
+### Examples
+
+```ruby
+api_instance = Fastly::ObjectStoreApi.new
+opts = {
+    store_id: 'store_id_example', # String | 
+}
+
+begin
+  # Delete an object store.
+  api_instance.delete_store(opts)
+rescue Fastly::ApiError => e
+  puts "Error when calling ObjectStoreApi->delete_store: #{e}"
+end
+```
+
+### Options
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **store_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to README]](../../README.md)
+## `get_keys()`
+
+```ruby
+get_keys(opts): <KeyResponse> # List object store keys.
+```
+
+List all keys within an object store.
+
+### Examples
+
+```ruby
+api_instance = Fastly::ObjectStoreApi.new
+opts = {
+    store_id: 'store_id_example', # String | 
+    cursor: 'cursor_example', # String | 
+    limit: 56, # Integer | 
+}
+
+begin
+  # List object store keys.
+  result = api_instance.get_keys(opts)
+  p result
+rescue Fastly::ApiError => e
+  puts "Error when calling ObjectStoreApi->get_keys: #{e}"
+end
+```
+
+### Options
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **store_id** | **String** |  |  |
+| **cursor** | **String** |  | [optional] |
+| **limit** | **Integer** |  | [optional][default to 100] |
+
+### Return type
+
+[**KeyResponse**](KeyResponse.md)
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to README]](../../README.md)
+## `get_store()`
+
+```ruby
+get_store(opts): <StoreResponse> # Describe an object store.
+```
+
+Get an object store by ID.
+
+### Examples
+
+```ruby
+api_instance = Fastly::ObjectStoreApi.new
+opts = {
+    store_id: 'store_id_example', # String | 
+}
+
+begin
+  # Describe an object store.
+  result = api_instance.get_store(opts)
+  p result
+rescue Fastly::ApiError => e
+  puts "Error when calling ObjectStoreApi->get_store: #{e}"
+end
+```
+
+### Options
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **store_id** | **String** |  |  |
+
+### Return type
+
+[**StoreResponse**](StoreResponse.md)
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to README]](../../README.md)
+## `get_stores()`
+
+```ruby
+get_stores(opts): <GetStoresResponse> # List object stores.
+```
+
+Get all stores for a given customer.
+
+### Examples
+
+```ruby
+api_instance = Fastly::ObjectStoreApi.new
+opts = {
+    cursor: 'cursor_example', # String | 
+    limit: 56, # Integer | 
+}
+
+begin
+  # List object stores.
+  result = api_instance.get_stores(opts)
+  p result
+rescue Fastly::ApiError => e
+  puts "Error when calling ObjectStoreApi->get_stores: #{e}"
+end
+```
+
+### Options
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cursor** | **String** |  | [optional] |
+| **limit** | **Integer** |  | [optional][default to 100] |
+
+### Return type
+
+[**GetStoresResponse**](GetStoresResponse.md)
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to README]](../../README.md)
+## `get_value_for_key()`
+
+```ruby
+get_value_for_key(opts): File # Get object store key value.
+```
+
+Get the value associated with a key.
+
+### Examples
+
+```ruby
+api_instance = Fastly::ObjectStoreApi.new
+opts = {
+    store_id: 'store_id_example', # String | 
+    key_name: 'key_name_example', # String | 
+}
+
+begin
+  # Get object store key value.
+  result = api_instance.get_value_for_key(opts)
+  p result
+rescue Fastly::ApiError => e
+  puts "Error when calling ObjectStoreApi->get_value_for_key: #{e}"
+end
+```
+
+### Options
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **store_id** | **String** |  |  |
+| **key_name** | **String** |  |  |
+
+### Return type
+
+**File**
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to README]](../../README.md)
+## `set_value_for_key()`
+
+```ruby
+set_value_for_key(opts): File # Insert object store key-value.
+```
+
+Insert a new key-value pair into an object store.
+
+### Examples
+
+```ruby
+api_instance = Fastly::ObjectStoreApi.new
+opts = {
+    store_id: 'store_id_example', # String | 
+    key_name: 'key_name_example', # String | 
+    body: File.new('/path/to/some/file'), # File | 
+}
+
+begin
+  # Insert object store key-value.
+  result = api_instance.set_value_for_key(opts)
+  p result
+rescue Fastly::ApiError => e
+  puts "Error when calling ObjectStoreApi->set_value_for_key: #{e}"
+end
+```
+
+### Options
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **store_id** | **String** |  |  |
+| **key_name** | **String** |  |  |
+| **body** | **File** |  | [optional] |
+
+### Return type
+
+**File**
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to README]](../../README.md)