fastly 7.2.2 → 8.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +20 -0
  3. data/Gemfile.lock +2 -2
  4. data/README.md +1 -1
  5. data/docs/HistoricalApi.md +12 -12
  6. data/docs/{HistoricalAggregateResponse.md → HistoricalStatsAggregatedResponse.md} +1 -1
  7. data/docs/{HistoricalAggregateResponseAllOf.md → HistoricalStatsAggregatedResponseAllOf.md} +1 -1
  8. data/docs/{HistoricalResponse.md → HistoricalStatsByServiceResponse.md} +1 -1
  9. data/docs/{HistoricalResponseDataField.md → HistoricalStatsByServiceResponseAllOf.md} +1 -1
  10. data/docs/{HistoricalFieldResponse.md → HistoricalUsageAggregatedResponse.md} +2 -2
  11. data/docs/{HistoricalFieldResponseDataField.md → HistoricalUsageAggregatedResponseAllOf.md} +2 -2
  12. data/docs/{HistoricalUsageResults.md → HistoricalUsageData.md} +1 -1
  13. data/docs/HistoricalUsageMonthResponseData.md +2 -2
  14. data/docs/{HistoricalService.md → HistoricalUsageService.md} +1 -1
  15. data/docs/HistoricalUsageServiceResponse.md +1 -1
  16. data/docs/HistoricalUsageServiceResponseAllOf.md +1 -1
  17. data/docs/Results.md +2 -0
  18. data/lib/fastly/api/historical_api.rb +18 -18
  19. data/lib/fastly/models/{historical_aggregate_response.rb → historical_stats_aggregated_response.rb} +4 -4
  20. data/lib/fastly/models/{historical_aggregate_response_all_of.rb → historical_stats_aggregated_response_all_of.rb} +3 -3
  21. data/lib/fastly/models/{historical_response.rb → historical_stats_by_service_response.rb} +4 -4
  22. data/lib/fastly/models/{historical_response_data_field.rb → historical_stats_by_service_response_all_of.rb} +3 -3
  23. data/lib/fastly/models/{historical_field_response.rb → historical_usage_aggregated_response.rb} +6 -5
  24. data/lib/fastly/models/{historical_field_response_data_field.rb → historical_usage_aggregated_response_all_of.rb} +5 -4
  25. data/lib/fastly/models/{historical_usage_results.rb → historical_usage_data.rb} +4 -3
  26. data/lib/fastly/models/historical_usage_month_response_data.rb +7 -3
  27. data/lib/fastly/models/{historical_service.rb → historical_usage_service.rb} +3 -3
  28. data/lib/fastly/models/historical_usage_service_response.rb +5 -2
  29. data/lib/fastly/models/historical_usage_service_response_all_of.rb +5 -2
  30. data/lib/fastly/models/relationship_mutual_authentication.rb +1 -1
  31. data/lib/fastly/models/relationship_tls_domain.rb +1 -1
  32. data/lib/fastly/models/results.rb +24 -5
  33. data/lib/fastly/version.rb +1 -1
  34. data/lib/fastly.rb +8 -14
  35. data/sig.json +1 -1
  36. metadata +18 -30
  37. data/docs/HistoricalFieldAggregateResponse.md +0 -13
  38. data/docs/HistoricalFieldAggregateResponseAllOf.md +0 -10
  39. data/docs/HistoricalFieldResultsAttributes.md +0 -236
  40. data/docs/HistoricalFieldResultsAttributesAdditional.md +0 -11
  41. data/docs/HistoricalUsageAggregateResponse.md +0 -13
  42. data/docs/ReadOnlyIdService.md +0 -9
  43. data/lib/fastly/models/historical_field_aggregate_response.rb +0 -256
  44. data/lib/fastly/models/historical_field_aggregate_response_all_of.rb +0 -218
  45. data/lib/fastly/models/historical_field_results_attributes.rb +0 -2484
  46. data/lib/fastly/models/historical_field_results_attributes_additional.rb +0 -225
  47. data/lib/fastly/models/historical_usage_aggregate_response.rb +0 -254
  48. data/lib/fastly/models/read_only_id_service.rb +0 -207
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e09b9b4f5b431772590037d0d9a5d869ecda1fee88404dbd7d33ba2c9e6f35e8
4
- data.tar.gz: e0244e1534d8285374e46dab7f6f47989e182966ad3484421316a2054cf491e4
3
+ metadata.gz: 5fe91b6ebbe202b86c7088c6cbc48fbeeda5c2b4ca990e7a5375141b370c4335
4
+ data.tar.gz: f5a4c07dadb9fbddee85b0aa74b16fc48c6ff8875afab138c02f55bf6ed1176c
5
5
  SHA512:
6
- metadata.gz: c6a4bf423f7c2c09174ccb29336f0b61e8c535758233d779ba0a219cc8f6e3f460cdd7dc363125dc0a5e4f82b827ef0fc2e751ea571a9a32c9101e7ed5282d39
7
- data.tar.gz: 434e367457c93601888a8c4c2b9a065efbefc60bfd01776c959b89a328e56eb0df0632d18e1e6f8e327844211821efaec1c360115a322a021f409d45dffe4014
6
+ metadata.gz: 75551f6c3f5eef665d3cf482b312867bd567e127929d5fff69cbf7b31f798c3a2783e19ceddaeef64f4f882ac1003bec903296759523ff1efa01eea4ca4ef3f5
7
+ data.tar.gz: a87159f48a67025850c5d598b02c2e408f47024221fb0e4781f5f3f13ca5b01ff921e9431313efba46763c57b91dbf5bd58b262a87fba4943dc9d69a226c4c41
data/CHANGELOG.md CHANGED
@@ -1,5 +1,25 @@
1
1
  # Changelog
2
2
 
3
+ ## [v8.0.0](https://github.com/fastly/fastly-ruby/releases/tag/release/v8.0.0) (2023-11-29)
4
+
5
+ **Breaking:**
6
+
7
+ - breaking(historical): restructure OpenAPI schema to avoid duplicated data rendering.
8
+
9
+ **Bug fixes:**
10
+
11
+ - fix: no longer display Markdown syntax in code comments.
12
+
13
+ **Enhancements:**
14
+
15
+ - feat(stats): expose new `service_id` and `start_time` fields.
16
+
17
+ ## [v7.2.2](https://github.com/fastly/fastly-ruby/releases/tag/release/v7.2.2) (2023-11-07)
18
+
19
+ **Enhancements:**
20
+
21
+ - feat(config_store): add `name` query param to list endpoint.
22
+
3
23
  ## [v7.2.1](https://github.com/fastly/fastly-ruby/releases/tag/release/v7.2.1) (2023-10-27)
4
24
 
5
25
  **Documentation:**
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- fastly (7.2.2)
4
+ fastly (8.0.0)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
@@ -38,7 +38,7 @@ GEM
38
38
  unicode-display_width (>= 1.4.0, < 1.6)
39
39
  ruby-progressbar (1.11.0)
40
40
  stringio (3.0.1)
41
- typhoeus (1.4.0)
41
+ typhoeus (1.4.1)
42
42
  ethon (>= 0.9.0)
43
43
  unicode-display_width (1.5.0)
44
44
 
data/README.md CHANGED
@@ -8,7 +8,7 @@ A Ruby client library for interacting with most facets of the [Fastly API](https
8
8
  To install via RubyGems, add the following to your project's `Gemfile`:
9
9
 
10
10
  ```ruby
11
- gem 'fastly', '~> 7.2.2'
11
+ gem 'fastly', '~> 8.0.0'
12
12
  ```
13
13
 
14
14
  Then run `bundle install`.
@@ -24,7 +24,7 @@ api_instance = Fastly::HistoricalApi.new
24
24
  ## `get_hist_stats()`
25
25
 
26
26
  ```ruby
27
- get_hist_stats(opts): <HistoricalResponse> # Get historical stats
27
+ get_hist_stats(opts): <HistoricalStatsByServiceResponse> # Get historical stats
28
28
  ```
29
29
 
30
30
  Fetches historical stats for each of your Fastly services and groups the results by service ID.
@@ -60,14 +60,14 @@ end
60
60
 
61
61
  ### Return type
62
62
 
63
- [**HistoricalResponse**](HistoricalResponse.md)
63
+ [**HistoricalStatsByServiceResponse**](HistoricalStatsByServiceResponse.md)
64
64
 
65
65
  [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
66
66
  [[Back to README]](../../README.md)
67
67
  ## `get_hist_stats_aggregated()`
68
68
 
69
69
  ```ruby
70
- get_hist_stats_aggregated(opts): <HistoricalAggregateResponse> # Get aggregated historical stats
70
+ get_hist_stats_aggregated(opts): <HistoricalStatsAggregatedResponse> # Get aggregated historical stats
71
71
  ```
72
72
 
73
73
  Fetches historical stats information aggregated across all of your Fastly services.
@@ -103,14 +103,14 @@ end
103
103
 
104
104
  ### Return type
105
105
 
106
- [**HistoricalAggregateResponse**](HistoricalAggregateResponse.md)
106
+ [**HistoricalStatsAggregatedResponse**](HistoricalStatsAggregatedResponse.md)
107
107
 
108
108
  [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
109
109
  [[Back to README]](../../README.md)
110
110
  ## `get_hist_stats_field()`
111
111
 
112
112
  ```ruby
113
- get_hist_stats_field(opts): <HistoricalFieldResponse> # Get historical stats for a single field
113
+ get_hist_stats_field(opts): <HistoricalStatsByServiceResponse> # Get historical stats for a single field
114
114
  ```
115
115
 
116
116
  Fetches the specified field from the historical stats for each of your services and groups the results by service ID.
@@ -148,14 +148,14 @@ end
148
148
 
149
149
  ### Return type
150
150
 
151
- [**HistoricalFieldResponse**](HistoricalFieldResponse.md)
151
+ [**HistoricalStatsByServiceResponse**](HistoricalStatsByServiceResponse.md)
152
152
 
153
153
  [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
154
154
  [[Back to README]](../../README.md)
155
155
  ## `get_hist_stats_service()`
156
156
 
157
157
  ```ruby
158
- get_hist_stats_service(opts): <HistoricalAggregateResponse> # Get historical stats for a single service
158
+ get_hist_stats_service(opts): <HistoricalStatsAggregatedResponse> # Get historical stats for a single service
159
159
  ```
160
160
 
161
161
  Fetches historical stats for a given service.
@@ -193,14 +193,14 @@ end
193
193
 
194
194
  ### Return type
195
195
 
196
- [**HistoricalAggregateResponse**](HistoricalAggregateResponse.md)
196
+ [**HistoricalStatsAggregatedResponse**](HistoricalStatsAggregatedResponse.md)
197
197
 
198
198
  [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
199
199
  [[Back to README]](../../README.md)
200
200
  ## `get_hist_stats_service_field()`
201
201
 
202
202
  ```ruby
203
- get_hist_stats_service_field(opts): <HistoricalFieldAggregateResponse> # Get historical stats for a single service/field combination
203
+ get_hist_stats_service_field(opts): <HistoricalStatsAggregatedResponse> # Get historical stats for a single service/field combination
204
204
  ```
205
205
 
206
206
  Fetches the specified field from the historical stats for a given service.
@@ -240,7 +240,7 @@ end
240
240
 
241
241
  ### Return type
242
242
 
243
- [**HistoricalFieldAggregateResponse**](HistoricalFieldAggregateResponse.md)
243
+ [**HistoricalStatsAggregatedResponse**](HistoricalStatsAggregatedResponse.md)
244
244
 
245
245
  [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
246
246
  [[Back to README]](../../README.md)
@@ -279,7 +279,7 @@ This endpoint does not need any parameter.
279
279
  ## `get_usage()`
280
280
 
281
281
  ```ruby
282
- get_usage(opts): <HistoricalUsageAggregateResponse> # Get usage statistics
282
+ get_usage(opts): <HistoricalUsageAggregatedResponse> # Get usage statistics
283
283
  ```
284
284
 
285
285
  Returns usage information aggregated across all Fastly services and grouped by region. To aggregate across all Fastly services by time period, see [`/stats/aggregate`](#get-hist-stats-aggregated).
@@ -311,7 +311,7 @@ end
311
311
 
312
312
  ### Return type
313
313
 
314
- [**HistoricalUsageAggregateResponse**](HistoricalUsageAggregateResponse.md)
314
+ [**HistoricalUsageAggregatedResponse**](HistoricalUsageAggregatedResponse.md)
315
315
 
316
316
  [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
317
317
  [[Back to README]](../../README.md)
@@ -1,4 +1,4 @@
1
- # Fastly::HistoricalAggregateResponse
1
+ # Fastly::HistoricalStatsAggregatedResponse
2
2
 
3
3
  ## Properties
4
4
 
@@ -1,4 +1,4 @@
1
- # Fastly::HistoricalAggregateResponseAllOf
1
+ # Fastly::HistoricalStatsAggregatedResponseAllOf
2
2
 
3
3
  ## Properties
4
4
 
@@ -1,4 +1,4 @@
1
- # Fastly::HistoricalResponse
1
+ # Fastly::HistoricalStatsByServiceResponse
2
2
 
3
3
  ## Properties
4
4
 
@@ -1,4 +1,4 @@
1
- # Fastly::HistoricalResponseDataField
1
+ # Fastly::HistoricalStatsByServiceResponseAllOf
2
2
 
3
3
  ## Properties
4
4
 
@@ -1,4 +1,4 @@
1
- # Fastly::HistoricalFieldResponse
1
+ # Fastly::HistoricalUsageAggregatedResponse
2
2
 
3
3
  ## Properties
4
4
 
@@ -7,7 +7,7 @@
7
7
  | **status** | **String** | Whether or not we were able to successfully execute the query. | [optional] |
8
8
  | **meta** | [**HistoricalMeta**](HistoricalMeta.md) | | [optional] |
9
9
  | **msg** | **String** | If the query was not successful, this will provide a string that explains why. | [optional] |
10
- | **data** | **Hash&lt;String, Array&gt;** | | [optional] |
10
+ | **data** | [**Hash&lt;String, HistoricalUsageData&gt;**](HistoricalUsageData.md) | Organized by *region*. | [optional] |
11
11
 
12
12
  [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
13
13
 
@@ -1,10 +1,10 @@
1
- # Fastly::HistoricalFieldResponseDataField
1
+ # Fastly::HistoricalUsageAggregatedResponseAllOf
2
2
 
3
3
  ## Properties
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **data** | **Hash&lt;String, Array&gt;** | | [optional] |
7
+ | **data** | [**Hash&lt;String, HistoricalUsageData&gt;**](HistoricalUsageData.md) | Organized by *region*. | [optional] |
8
8
 
9
9
  [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
10
10
 
@@ -1,4 +1,4 @@
1
- # Fastly::HistoricalUsageResults
1
+ # Fastly::HistoricalUsageData
2
2
 
3
3
  ## Properties
4
4
 
@@ -5,8 +5,8 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **customer_id** | **String** | | [optional][readonly] |
8
- | **services** | [**Hash&lt;String, HistoricalService&gt;**](HistoricalService.md) | | [optional] |
9
- | **total** | [**HistoricalUsageResults**](HistoricalUsageResults.md) | | [optional] |
8
+ | **services** | [**Hash&lt;String, HistoricalUsageService&gt;**](HistoricalUsageService.md) | Organized by *service id*. | [optional] |
9
+ | **total** | [**Hash&lt;String, HistoricalUsageData&gt;**](HistoricalUsageData.md) | Organized by *region*. | [optional] |
10
10
 
11
11
  [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
12
12
 
@@ -1,4 +1,4 @@
1
- # Fastly::HistoricalService
1
+ # Fastly::HistoricalUsageService
2
2
 
3
3
  ## Properties
4
4
 
@@ -7,7 +7,7 @@
7
7
  | **status** | **String** | Whether or not we were able to successfully execute the query. | [optional] |
8
8
  | **meta** | [**HistoricalMeta**](HistoricalMeta.md) | | [optional] |
9
9
  | **msg** | **String** | If the query was not successful, this will provide a string that explains why. | [optional] |
10
- | **data** | [**HistoricalUsageResults**](HistoricalUsageResults.md) | | [optional] |
10
+ | **data** | **Hash&lt;String, Hash&lt;String, HistoricalUsageData&gt;&gt;** | Organized by *region*. | [optional] |
11
11
 
12
12
  [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
13
13
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **data** | [**HistoricalUsageResults**](HistoricalUsageResults.md) | | [optional] |
7
+ | **data** | **Hash&lt;String, Hash&lt;String, HistoricalUsageData&gt;&gt;** | Organized by *region*. | [optional] |
8
8
 
9
9
  [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
10
10
 
data/docs/Results.md CHANGED
@@ -229,6 +229,8 @@
229
229
  | **bot_challenges_issued** | **Integer** | The number of challenges issued. For example, the issuance of a CAPTCHA challenge. | [optional] |
230
230
  | **bot_challenges_succeeded** | **Integer** | The number of successful challenge solutions processed. For example, a correct CAPTCHA solution. | [optional] |
231
231
  | **bot_challenges_failed** | **Integer** | The number of failed challenge solutions processed. For example, an incorrect CAPTCHA solution. | [optional] |
232
+ | **service_id** | **String** | | [optional][readonly] |
233
+ | **start_time** | **Integer** | Timestamp for the start of the time period being reported | [optional] |
232
234
 
233
235
  [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
234
236
 
@@ -23,7 +23,7 @@ module Fastly
23
23
  # @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as &#x60;from&#x60;. (default to 'now')
24
24
  # @option opts [String] :by Duration of sample windows. One of: * &#x60;hour&#x60; - Group data by hour. * &#x60;minute&#x60; - Group data by minute. * &#x60;day&#x60; - Group data by day. (default to 'day')
25
25
  # @option opts [String] :region Limit query to a specific geographic region. One of: * &#x60;usa&#x60; - North America. * &#x60;europe&#x60; - Europe. * &#x60;anzac&#x60; - Australia and New Zealand. * &#x60;asia&#x60; - Asia. * &#x60;asia_india&#x60; - India. * &#x60;asia_southkorea&#x60; - South Korea. * &#x60;africa_std&#x60; - Africa. * &#x60;southamerica_std&#x60; - South America.
26
- # @return [HistoricalResponse]
26
+ # @return [HistoricalStatsByServiceResponse]
27
27
  def get_hist_stats(opts = {})
28
28
  data, _status_code, _headers = get_hist_stats_with_http_info(opts)
29
29
  data
@@ -35,7 +35,7 @@ module Fastly
35
35
  # @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as &#x60;from&#x60;. (default to 'now')
36
36
  # @option opts [String] :by Duration of sample windows. One of: * &#x60;hour&#x60; - Group data by hour. * &#x60;minute&#x60; - Group data by minute. * &#x60;day&#x60; - Group data by day. (default to 'day')
37
37
  # @option opts [String] :region Limit query to a specific geographic region. One of: * &#x60;usa&#x60; - North America. * &#x60;europe&#x60; - Europe. * &#x60;anzac&#x60; - Australia and New Zealand. * &#x60;asia&#x60; - Asia. * &#x60;asia_india&#x60; - India. * &#x60;asia_southkorea&#x60; - South Korea. * &#x60;africa_std&#x60; - Africa. * &#x60;southamerica_std&#x60; - South America.
38
- # @return [Array<(HistoricalResponse, Integer, Hash)>] HistoricalResponse data, response status code and response headers
38
+ # @return [Array<(HistoricalStatsByServiceResponse, Integer, Hash)>] HistoricalStatsByServiceResponse data, response status code and response headers
39
39
  def get_hist_stats_with_http_info(opts = {})
40
40
  if @api_client.config.debugging
41
41
  @api_client.config.logger.debug 'Calling API: HistoricalApi.get_hist_stats ...'
@@ -71,7 +71,7 @@ module Fastly
71
71
  post_body = opts[:debug_body]
72
72
 
73
73
  # return_type
74
- return_type = opts[:debug_return_type] || 'HistoricalResponse'
74
+ return_type = opts[:debug_return_type] || 'HistoricalStatsByServiceResponse'
75
75
 
76
76
  # auth_names
77
77
  auth_names = opts[:debug_auth_names] || ['token']
@@ -99,7 +99,7 @@ module Fastly
99
99
  # @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as &#x60;from&#x60;. (default to 'now')
100
100
  # @option opts [String] :by Duration of sample windows. One of: * &#x60;hour&#x60; - Group data by hour. * &#x60;minute&#x60; - Group data by minute. * &#x60;day&#x60; - Group data by day. (default to 'day')
101
101
  # @option opts [String] :region Limit query to a specific geographic region. One of: * &#x60;usa&#x60; - North America. * &#x60;europe&#x60; - Europe. * &#x60;anzac&#x60; - Australia and New Zealand. * &#x60;asia&#x60; - Asia. * &#x60;asia_india&#x60; - India. * &#x60;asia_southkorea&#x60; - South Korea. * &#x60;africa_std&#x60; - Africa. * &#x60;southamerica_std&#x60; - South America.
102
- # @return [HistoricalAggregateResponse]
102
+ # @return [HistoricalStatsAggregatedResponse]
103
103
  def get_hist_stats_aggregated(opts = {})
104
104
  data, _status_code, _headers = get_hist_stats_aggregated_with_http_info(opts)
105
105
  data
@@ -111,7 +111,7 @@ module Fastly
111
111
  # @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as &#x60;from&#x60;. (default to 'now')
112
112
  # @option opts [String] :by Duration of sample windows. One of: * &#x60;hour&#x60; - Group data by hour. * &#x60;minute&#x60; - Group data by minute. * &#x60;day&#x60; - Group data by day. (default to 'day')
113
113
  # @option opts [String] :region Limit query to a specific geographic region. One of: * &#x60;usa&#x60; - North America. * &#x60;europe&#x60; - Europe. * &#x60;anzac&#x60; - Australia and New Zealand. * &#x60;asia&#x60; - Asia. * &#x60;asia_india&#x60; - India. * &#x60;asia_southkorea&#x60; - South Korea. * &#x60;africa_std&#x60; - Africa. * &#x60;southamerica_std&#x60; - South America.
114
- # @return [Array<(HistoricalAggregateResponse, Integer, Hash)>] HistoricalAggregateResponse data, response status code and response headers
114
+ # @return [Array<(HistoricalStatsAggregatedResponse, Integer, Hash)>] HistoricalStatsAggregatedResponse data, response status code and response headers
115
115
  def get_hist_stats_aggregated_with_http_info(opts = {})
116
116
  if @api_client.config.debugging
117
117
  @api_client.config.logger.debug 'Calling API: HistoricalApi.get_hist_stats_aggregated ...'
@@ -147,7 +147,7 @@ module Fastly
147
147
  post_body = opts[:debug_body]
148
148
 
149
149
  # return_type
150
- return_type = opts[:debug_return_type] || 'HistoricalAggregateResponse'
150
+ return_type = opts[:debug_return_type] || 'HistoricalStatsAggregatedResponse'
151
151
 
152
152
  # auth_names
153
153
  auth_names = opts[:debug_auth_names] || ['token']
@@ -176,7 +176,7 @@ module Fastly
176
176
  # @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as &#x60;from&#x60;. (default to 'now')
177
177
  # @option opts [String] :by Duration of sample windows. One of: * &#x60;hour&#x60; - Group data by hour. * &#x60;minute&#x60; - Group data by minute. * &#x60;day&#x60; - Group data by day. (default to 'day')
178
178
  # @option opts [String] :region Limit query to a specific geographic region. One of: * &#x60;usa&#x60; - North America. * &#x60;europe&#x60; - Europe. * &#x60;anzac&#x60; - Australia and New Zealand. * &#x60;asia&#x60; - Asia. * &#x60;asia_india&#x60; - India. * &#x60;asia_southkorea&#x60; - South Korea. * &#x60;africa_std&#x60; - Africa. * &#x60;southamerica_std&#x60; - South America.
179
- # @return [HistoricalFieldResponse]
179
+ # @return [HistoricalStatsByServiceResponse]
180
180
  def get_hist_stats_field(opts = {})
181
181
  data, _status_code, _headers = get_hist_stats_field_with_http_info(opts)
182
182
  data
@@ -189,7 +189,7 @@ module Fastly
189
189
  # @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as &#x60;from&#x60;. (default to 'now')
190
190
  # @option opts [String] :by Duration of sample windows. One of: * &#x60;hour&#x60; - Group data by hour. * &#x60;minute&#x60; - Group data by minute. * &#x60;day&#x60; - Group data by day. (default to 'day')
191
191
  # @option opts [String] :region Limit query to a specific geographic region. One of: * &#x60;usa&#x60; - North America. * &#x60;europe&#x60; - Europe. * &#x60;anzac&#x60; - Australia and New Zealand. * &#x60;asia&#x60; - Asia. * &#x60;asia_india&#x60; - India. * &#x60;asia_southkorea&#x60; - South Korea. * &#x60;africa_std&#x60; - Africa. * &#x60;southamerica_std&#x60; - South America.
192
- # @return [Array<(HistoricalFieldResponse, Integer, Hash)>] HistoricalFieldResponse data, response status code and response headers
192
+ # @return [Array<(HistoricalStatsByServiceResponse, Integer, Hash)>] HistoricalStatsByServiceResponse data, response status code and response headers
193
193
  def get_hist_stats_field_with_http_info(opts = {})
194
194
  if @api_client.config.debugging
195
195
  @api_client.config.logger.debug 'Calling API: HistoricalApi.get_hist_stats_field ...'
@@ -230,7 +230,7 @@ module Fastly
230
230
  post_body = opts[:debug_body]
231
231
 
232
232
  # return_type
233
- return_type = opts[:debug_return_type] || 'HistoricalFieldResponse'
233
+ return_type = opts[:debug_return_type] || 'HistoricalStatsByServiceResponse'
234
234
 
235
235
  # auth_names
236
236
  auth_names = opts[:debug_auth_names] || ['token']
@@ -259,7 +259,7 @@ module Fastly
259
259
  # @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as &#x60;from&#x60;. (default to 'now')
260
260
  # @option opts [String] :by Duration of sample windows. One of: * &#x60;hour&#x60; - Group data by hour. * &#x60;minute&#x60; - Group data by minute. * &#x60;day&#x60; - Group data by day. (default to 'day')
261
261
  # @option opts [String] :region Limit query to a specific geographic region. One of: * &#x60;usa&#x60; - North America. * &#x60;europe&#x60; - Europe. * &#x60;anzac&#x60; - Australia and New Zealand. * &#x60;asia&#x60; - Asia. * &#x60;asia_india&#x60; - India. * &#x60;asia_southkorea&#x60; - South Korea. * &#x60;africa_std&#x60; - Africa. * &#x60;southamerica_std&#x60; - South America.
262
- # @return [HistoricalAggregateResponse]
262
+ # @return [HistoricalStatsAggregatedResponse]
263
263
  def get_hist_stats_service(opts = {})
264
264
  data, _status_code, _headers = get_hist_stats_service_with_http_info(opts)
265
265
  data
@@ -272,7 +272,7 @@ module Fastly
272
272
  # @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as &#x60;from&#x60;. (default to 'now')
273
273
  # @option opts [String] :by Duration of sample windows. One of: * &#x60;hour&#x60; - Group data by hour. * &#x60;minute&#x60; - Group data by minute. * &#x60;day&#x60; - Group data by day. (default to 'day')
274
274
  # @option opts [String] :region Limit query to a specific geographic region. One of: * &#x60;usa&#x60; - North America. * &#x60;europe&#x60; - Europe. * &#x60;anzac&#x60; - Australia and New Zealand. * &#x60;asia&#x60; - Asia. * &#x60;asia_india&#x60; - India. * &#x60;asia_southkorea&#x60; - South Korea. * &#x60;africa_std&#x60; - Africa. * &#x60;southamerica_std&#x60; - South America.
275
- # @return [Array<(HistoricalAggregateResponse, Integer, Hash)>] HistoricalAggregateResponse data, response status code and response headers
275
+ # @return [Array<(HistoricalStatsAggregatedResponse, Integer, Hash)>] HistoricalStatsAggregatedResponse data, response status code and response headers
276
276
  def get_hist_stats_service_with_http_info(opts = {})
277
277
  if @api_client.config.debugging
278
278
  @api_client.config.logger.debug 'Calling API: HistoricalApi.get_hist_stats_service ...'
@@ -313,7 +313,7 @@ module Fastly
313
313
  post_body = opts[:debug_body]
314
314
 
315
315
  # return_type
316
- return_type = opts[:debug_return_type] || 'HistoricalAggregateResponse'
316
+ return_type = opts[:debug_return_type] || 'HistoricalStatsAggregatedResponse'
317
317
 
318
318
  # auth_names
319
319
  auth_names = opts[:debug_auth_names] || ['token']
@@ -343,7 +343,7 @@ module Fastly
343
343
  # @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as &#x60;from&#x60;. (default to 'now')
344
344
  # @option opts [String] :by Duration of sample windows. One of: * &#x60;hour&#x60; - Group data by hour. * &#x60;minute&#x60; - Group data by minute. * &#x60;day&#x60; - Group data by day. (default to 'day')
345
345
  # @option opts [String] :region Limit query to a specific geographic region. One of: * &#x60;usa&#x60; - North America. * &#x60;europe&#x60; - Europe. * &#x60;anzac&#x60; - Australia and New Zealand. * &#x60;asia&#x60; - Asia. * &#x60;asia_india&#x60; - India. * &#x60;asia_southkorea&#x60; - South Korea. * &#x60;africa_std&#x60; - Africa. * &#x60;southamerica_std&#x60; - South America.
346
- # @return [HistoricalFieldAggregateResponse]
346
+ # @return [HistoricalStatsAggregatedResponse]
347
347
  def get_hist_stats_service_field(opts = {})
348
348
  data, _status_code, _headers = get_hist_stats_service_field_with_http_info(opts)
349
349
  data
@@ -357,7 +357,7 @@ module Fastly
357
357
  # @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as &#x60;from&#x60;. (default to 'now')
358
358
  # @option opts [String] :by Duration of sample windows. One of: * &#x60;hour&#x60; - Group data by hour. * &#x60;minute&#x60; - Group data by minute. * &#x60;day&#x60; - Group data by day. (default to 'day')
359
359
  # @option opts [String] :region Limit query to a specific geographic region. One of: * &#x60;usa&#x60; - North America. * &#x60;europe&#x60; - Europe. * &#x60;anzac&#x60; - Australia and New Zealand. * &#x60;asia&#x60; - Asia. * &#x60;asia_india&#x60; - India. * &#x60;asia_southkorea&#x60; - South Korea. * &#x60;africa_std&#x60; - Africa. * &#x60;southamerica_std&#x60; - South America.
360
- # @return [Array<(HistoricalFieldAggregateResponse, Integer, Hash)>] HistoricalFieldAggregateResponse data, response status code and response headers
360
+ # @return [Array<(HistoricalStatsAggregatedResponse, Integer, Hash)>] HistoricalStatsAggregatedResponse data, response status code and response headers
361
361
  def get_hist_stats_service_field_with_http_info(opts = {})
362
362
  if @api_client.config.debugging
363
363
  @api_client.config.logger.debug 'Calling API: HistoricalApi.get_hist_stats_service_field ...'
@@ -403,7 +403,7 @@ module Fastly
403
403
  post_body = opts[:debug_body]
404
404
 
405
405
  # return_type
406
- return_type = opts[:debug_return_type] || 'HistoricalFieldAggregateResponse'
406
+ return_type = opts[:debug_return_type] || 'HistoricalStatsAggregatedResponse'
407
407
 
408
408
  # auth_names
409
409
  auth_names = opts[:debug_auth_names] || ['token']
@@ -485,7 +485,7 @@ module Fastly
485
485
  # Returns usage information aggregated across all Fastly services and grouped by region. To aggregate across all Fastly services by time period, see [`/stats/aggregate`](#get-hist-stats-aggregated).
486
486
  # @option opts [String] :from 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 &#x60;by&#x60;.
487
487
  # @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as &#x60;from&#x60;. (default to 'now')
488
- # @return [HistoricalUsageAggregateResponse]
488
+ # @return [HistoricalUsageAggregatedResponse]
489
489
  def get_usage(opts = {})
490
490
  data, _status_code, _headers = get_usage_with_http_info(opts)
491
491
  data
@@ -495,7 +495,7 @@ module Fastly
495
495
  # Returns usage information aggregated across all Fastly services and grouped by region. To aggregate across all Fastly services by time period, see [&#x60;/stats/aggregate&#x60;](#get-hist-stats-aggregated).
496
496
  # @option opts [String] :from 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 &#x60;by&#x60;.
497
497
  # @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as &#x60;from&#x60;. (default to 'now')
498
- # @return [Array<(HistoricalUsageAggregateResponse, Integer, Hash)>] HistoricalUsageAggregateResponse data, response status code and response headers
498
+ # @return [Array<(HistoricalUsageAggregatedResponse, Integer, Hash)>] HistoricalUsageAggregatedResponse data, response status code and response headers
499
499
  def get_usage_with_http_info(opts = {})
500
500
  if @api_client.config.debugging
501
501
  @api_client.config.logger.debug 'Calling API: HistoricalApi.get_usage ...'
@@ -521,7 +521,7 @@ module Fastly
521
521
  post_body = opts[:debug_body]
522
522
 
523
523
  # return_type
524
- return_type = opts[:debug_return_type] || 'HistoricalUsageAggregateResponse'
524
+ return_type = opts[:debug_return_type] || 'HistoricalUsageAggregatedResponse'
525
525
 
526
526
  # auth_names
527
527
  auth_names = opts[:debug_auth_names] || ['token']
@@ -12,7 +12,7 @@ require 'date'
12
12
  require 'time'
13
13
 
14
14
  module Fastly
15
- class HistoricalAggregateResponse
15
+ class HistoricalStatsAggregatedResponse
16
16
  # Whether or not we were able to successfully execute the query.
17
17
  attr_accessor :status
18
18
 
@@ -59,7 +59,7 @@ module Fastly
59
59
  def self.fastly_all_of
60
60
  [
61
61
  :'Historical',
62
- :'HistoricalAggregateResponseAllOf'
62
+ :'HistoricalStatsAggregatedResponseAllOf'
63
63
  ]
64
64
  end
65
65
 
@@ -67,13 +67,13 @@ module Fastly
67
67
  # @param [Hash] attributes Model attributes in the form of hash
68
68
  def initialize(attributes = {})
69
69
  if (!attributes.is_a?(Hash))
70
- fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::HistoricalAggregateResponse` initialize method"
70
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::HistoricalStatsAggregatedResponse` initialize method"
71
71
  end
72
72
 
73
73
  # check to see if the attribute exists and convert string to symbol for hash key
74
74
  attributes = attributes.each_with_object({}) { |(k, v), h|
75
75
  if (!self.class.attribute_map.key?(k.to_sym))
76
- fail ArgumentError, "`#{k}` is not a valid attribute in `Fastly::HistoricalAggregateResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
76
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Fastly::HistoricalStatsAggregatedResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
77
77
  end
78
78
  h[k.to_sym] = v
79
79
  }
@@ -12,7 +12,7 @@ require 'date'
12
12
  require 'time'
13
13
 
14
14
  module Fastly
15
- class HistoricalAggregateResponseAllOf
15
+ class HistoricalStatsAggregatedResponseAllOf
16
16
  attr_accessor :data
17
17
 
18
18
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -44,13 +44,13 @@ module Fastly
44
44
  # @param [Hash] attributes Model attributes in the form of hash
45
45
  def initialize(attributes = {})
46
46
  if (!attributes.is_a?(Hash))
47
- fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::HistoricalAggregateResponseAllOf` initialize method"
47
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::HistoricalStatsAggregatedResponseAllOf` initialize method"
48
48
  end
49
49
 
50
50
  # check to see if the attribute exists and convert string to symbol for hash key
51
51
  attributes = attributes.each_with_object({}) { |(k, v), h|
52
52
  if (!self.class.attribute_map.key?(k.to_sym))
53
- fail ArgumentError, "`#{k}` is not a valid attribute in `Fastly::HistoricalAggregateResponseAllOf`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
53
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Fastly::HistoricalStatsAggregatedResponseAllOf`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
54
54
  end
55
55
  h[k.to_sym] = v
56
56
  }
@@ -12,7 +12,7 @@ require 'date'
12
12
  require 'time'
13
13
 
14
14
  module Fastly
15
- class HistoricalResponse
15
+ class HistoricalStatsByServiceResponse
16
16
  # Whether or not we were able to successfully execute the query.
17
17
  attr_accessor :status
18
18
 
@@ -60,7 +60,7 @@ module Fastly
60
60
  def self.fastly_all_of
61
61
  [
62
62
  :'Historical',
63
- :'HistoricalResponseDataField'
63
+ :'HistoricalStatsByServiceResponseAllOf'
64
64
  ]
65
65
  end
66
66
 
@@ -68,13 +68,13 @@ module Fastly
68
68
  # @param [Hash] attributes Model attributes in the form of hash
69
69
  def initialize(attributes = {})
70
70
  if (!attributes.is_a?(Hash))
71
- fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::HistoricalResponse` initialize method"
71
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::HistoricalStatsByServiceResponse` initialize method"
72
72
  end
73
73
 
74
74
  # check to see if the attribute exists and convert string to symbol for hash key
75
75
  attributes = attributes.each_with_object({}) { |(k, v), h|
76
76
  if (!self.class.attribute_map.key?(k.to_sym))
77
- fail ArgumentError, "`#{k}` is not a valid attribute in `Fastly::HistoricalResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
77
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Fastly::HistoricalStatsByServiceResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
78
78
  end
79
79
  h[k.to_sym] = v
80
80
  }
@@ -12,7 +12,7 @@ require 'date'
12
12
  require 'time'
13
13
 
14
14
  module Fastly
15
- class HistoricalResponseDataField
15
+ class HistoricalStatsByServiceResponseAllOf
16
16
  # Contains the results of the query, organized by *service ID*, into arrays where each element describes one service over a *time span*.
17
17
  attr_accessor :data
18
18
 
@@ -45,13 +45,13 @@ module Fastly
45
45
  # @param [Hash] attributes Model attributes in the form of hash
46
46
  def initialize(attributes = {})
47
47
  if (!attributes.is_a?(Hash))
48
- fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::HistoricalResponseDataField` initialize method"
48
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::HistoricalStatsByServiceResponseAllOf` initialize method"
49
49
  end
50
50
 
51
51
  # check to see if the attribute exists and convert string to symbol for hash key
52
52
  attributes = attributes.each_with_object({}) { |(k, v), h|
53
53
  if (!self.class.attribute_map.key?(k.to_sym))
54
- fail ArgumentError, "`#{k}` is not a valid attribute in `Fastly::HistoricalResponseDataField`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
54
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Fastly::HistoricalStatsByServiceResponseAllOf`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
55
55
  end
56
56
  h[k.to_sym] = v
57
57
  }
@@ -12,7 +12,7 @@ require 'date'
12
12
  require 'time'
13
13
 
14
14
  module Fastly
15
- class HistoricalFieldResponse
15
+ class HistoricalUsageAggregatedResponse
16
16
  # Whether or not we were able to successfully execute the query.
17
17
  attr_accessor :status
18
18
 
@@ -21,6 +21,7 @@ module Fastly
21
21
  # If the query was not successful, this will provide a string that explains why.
22
22
  attr_accessor :msg
23
23
 
24
+ # Organized by *region*.
24
25
  attr_accessor :data
25
26
 
26
27
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -44,7 +45,7 @@ module Fastly
44
45
  :'status' => :'String',
45
46
  :'meta' => :'HistoricalMeta',
46
47
  :'msg' => :'String',
47
- :'data' => :'Hash<String, Array>'
48
+ :'data' => :'Hash<String, HistoricalUsageData>'
48
49
  }
49
50
  end
50
51
 
@@ -59,7 +60,7 @@ module Fastly
59
60
  def self.fastly_all_of
60
61
  [
61
62
  :'Historical',
62
- :'HistoricalFieldResponseDataField'
63
+ :'HistoricalUsageAggregatedResponseAllOf'
63
64
  ]
64
65
  end
65
66
 
@@ -67,13 +68,13 @@ module Fastly
67
68
  # @param [Hash] attributes Model attributes in the form of hash
68
69
  def initialize(attributes = {})
69
70
  if (!attributes.is_a?(Hash))
70
- fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::HistoricalFieldResponse` initialize method"
71
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::HistoricalUsageAggregatedResponse` initialize method"
71
72
  end
72
73
 
73
74
  # check to see if the attribute exists and convert string to symbol for hash key
74
75
  attributes = attributes.each_with_object({}) { |(k, v), h|
75
76
  if (!self.class.attribute_map.key?(k.to_sym))
76
- fail ArgumentError, "`#{k}` is not a valid attribute in `Fastly::HistoricalFieldResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
77
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Fastly::HistoricalUsageAggregatedResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
77
78
  end
78
79
  h[k.to_sym] = v
79
80
  }