fastly 5.3.0 → 6.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 (224) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +62 -0
  3. data/Gemfile.lock +1 -1
  4. data/README.md +86 -63
  5. data/docs/AclEntry.md +1 -1
  6. data/docs/AclEntryApi.md +176 -0
  7. data/docs/AclEntryResponse.md +1 -1
  8. data/docs/ApexRedirectApi.md +56 -0
  9. data/docs/Batch.md +12 -0
  10. data/docs/BatchErrors.md +13 -0
  11. data/docs/BulkUpdateAclEntry.md +1 -1
  12. data/docs/ClientKey.md +12 -0
  13. data/docs/ContactApi.md +50 -0
  14. data/docs/Content.md +2 -2
  15. data/docs/ContentApi.md +52 -0
  16. data/docs/DirectorApi.md +42 -0
  17. data/docs/DomainInspector.md +12 -0
  18. data/docs/DomainInspectorEntry.md +11 -0
  19. data/docs/DomainInspectorEntryDimensions.md +12 -0
  20. data/docs/DomainInspectorHistoricalApi.md +72 -0
  21. data/docs/DomainInspectorMeasurements.md +71 -0
  22. data/docs/DomainInspectorRealtimeApi.md +132 -0
  23. data/docs/DomainInspectorRealtimeEntry.md +12 -0
  24. data/docs/EventAttributes.md +1 -1
  25. data/docs/{EventsResponseAllOf.md → EventData.md} +1 -1
  26. data/docs/HistoricalDomains.md +13 -0
  27. data/docs/HistoricalDomainsData.md +11 -0
  28. data/docs/HistoricalDomainsMeta.md +18 -0
  29. data/docs/HistoricalDomainsMetaFilters.md +12 -0
  30. data/docs/HistoricalDomainsResponse.md +13 -0
  31. data/docs/HistoricalDomainsResponseAllOf.md +10 -0
  32. data/docs/{HistoricalFieldResultsAttributesAllOf.md → HistoricalFieldResultsAttributesAdditional.md} +1 -1
  33. data/docs/HistoricalOriginsResponse.md +13 -0
  34. data/docs/HistoricalOriginsResponseAllOf.md +10 -0
  35. data/docs/IamRolesApi.md +157 -0
  36. data/docs/IamServiceGroupsApi.md +157 -0
  37. data/docs/IamUserGroupsApi.md +315 -0
  38. data/docs/InlineResponse2005.md +11 -0
  39. data/docs/InlineResponse2006.md +11 -0
  40. data/docs/InlineResponse2007.md +10 -0
  41. data/docs/InlineResponse400.md +10 -0
  42. data/docs/LegacyWafConfigurationSet.md +11 -0
  43. data/docs/LegacyWafConfigurationSetsApi.md +125 -0
  44. data/docs/LegacyWafFirewall.md +18 -0
  45. data/docs/LegacyWafFirewallApi.md +352 -0
  46. data/docs/LegacyWafOwasp.md +38 -0
  47. data/docs/LegacyWafOwaspApi.md +138 -0
  48. data/docs/LegacyWafRule.md +14 -0
  49. data/docs/LegacyWafRuleApi.md +184 -0
  50. data/docs/LegacyWafRuleStatus.md +12 -0
  51. data/docs/LegacyWafRuleStatusApi.md +202 -0
  52. data/docs/LegacyWafRuleset.md +11 -0
  53. data/docs/LegacyWafRulesetApi.md +136 -0
  54. data/docs/LegacyWafTag.md +10 -0
  55. data/docs/LegacyWafTagApi.md +58 -0
  56. data/docs/LegacyWafUpdateStatus.md +15 -0
  57. data/docs/LegacyWafUpdateStatusApi.md +102 -0
  58. data/docs/LoggingKafkaApi.md +42 -0
  59. data/docs/LoggingKinesisApi.md +42 -0
  60. data/docs/OriginInspector.md +12 -0
  61. data/docs/OriginInspectorDimensions.md +12 -0
  62. data/docs/OriginInspectorEntry.md +11 -0
  63. data/docs/OriginInspectorHistorical.md +13 -0
  64. data/docs/OriginInspectorHistoricalApi.md +72 -0
  65. data/docs/OriginInspectorHistoricalData.md +11 -0
  66. data/docs/OriginInspectorHistoricalMeta.md +18 -0
  67. data/docs/OriginInspectorHistoricalMetaFilters.md +12 -0
  68. data/docs/OriginInspectorMeasurements.md +161 -0
  69. data/docs/OriginInspectorRealtimeApi.md +132 -0
  70. data/docs/OriginInspectorRealtimeEntry.md +12 -0
  71. data/docs/OriginInspectorRealtimeEntryRecorded.md +9 -0
  72. data/docs/OriginInspectorSubsequentRequestTimestamp.md +9 -0
  73. data/docs/OriginInspectorValues.md +161 -0
  74. data/docs/PaginationCursorMeta.md +11 -0
  75. data/docs/ReadOnlyServiceId.md +9 -0
  76. data/docs/ReadOnlyVersion.md +9 -0
  77. data/docs/RealtimeEntry.md +2 -2
  78. data/docs/RealtimeEntryAggregated.md +227 -0
  79. data/docs/RealtimeEntryRecorded.md +9 -0
  80. data/docs/RealtimeMeasurements.md +1 -1
  81. data/docs/RecordedTimestamp.md +9 -0
  82. data/docs/RequestSettingsApi.md +40 -0
  83. data/docs/ResponseObjectApi.md +82 -0
  84. data/docs/SchemasSnippetResponse.md +1 -1
  85. data/docs/Secret.md +12 -0
  86. data/docs/SecretResponse.md +13 -0
  87. data/docs/SecretStore.md +10 -0
  88. data/docs/SecretStoreApi.md +233 -0
  89. data/docs/SecretStoreItemApi.md +255 -0
  90. data/docs/SecretStoreResponse.md +12 -0
  91. data/docs/ServiceAuthorizationsApi.md +76 -0
  92. data/docs/SigningKey.md +10 -0
  93. data/docs/Snippet.md +1 -1
  94. data/docs/SnippetApi.md +46 -4
  95. data/docs/SnippetResponse.md +1 -1
  96. data/docs/SubsequentRequestTimestamp.md +9 -0
  97. data/docs/SudoApi.md +52 -0
  98. data/docs/SudoGenericTokenError.md +10 -0
  99. data/docs/SudoRequest.md +12 -0
  100. data/docs/SudoResponse.md +10 -0
  101. data/docs/TokensAdditionalProps.md +9 -0
  102. data/docs/TokensApi.md +70 -0
  103. data/docs/ValidatorResult.md +1 -5
  104. data/docs/ValidatorResultData.md +12 -0
  105. data/docs/ValidatorResultDataAttributes.md +14 -0
  106. data/docs/{ValidatorResultMessages.md → ValidatorResultDataAttributesMessages.md} +2 -2
  107. data/docs/Values.md +71 -0
  108. data/docs/VclApi.md +8 -6
  109. data/docs/VclSyntaxHighlightingResponse.md +10 -0
  110. data/docs/WafActiveRulesApi.md +41 -0
  111. data/lib/fastly/api/acl_entry_api.rb +332 -0
  112. data/lib/fastly/api/apex_redirect_api.rb +111 -0
  113. data/lib/fastly/api/contact_api.rb +90 -0
  114. data/lib/fastly/api/content_api.rb +79 -0
  115. data/lib/fastly/api/director_api.rb +82 -0
  116. data/lib/fastly/api/domain_inspector_historical_api.rb +125 -0
  117. data/lib/fastly/api/domain_inspector_realtime_api.rb +223 -0
  118. data/lib/fastly/api/iam_roles_api.rb +271 -0
  119. data/lib/fastly/api/iam_service_groups_api.rb +271 -0
  120. data/lib/fastly/api/iam_user_groups_api.rb +547 -0
  121. data/lib/fastly/api/legacy_waf_configuration_sets_api.rb +209 -0
  122. data/lib/fastly/api/legacy_waf_firewall_api.rb +627 -0
  123. data/lib/fastly/api/legacy_waf_owasp_api.rb +244 -0
  124. data/lib/fastly/api/legacy_waf_rule_api.rb +307 -0
  125. data/lib/fastly/api/legacy_waf_rule_status_api.rb +366 -0
  126. data/lib/fastly/api/legacy_waf_ruleset_api.rb +237 -0
  127. data/lib/fastly/api/legacy_waf_tag_api.rb +96 -0
  128. data/lib/fastly/api/legacy_waf_update_status_api.rb +184 -0
  129. data/lib/fastly/api/logging_kafka_api.rb +82 -0
  130. data/lib/fastly/api/logging_kinesis_api.rb +82 -0
  131. data/lib/fastly/api/origin_inspector_historical_api.rb +125 -0
  132. data/lib/fastly/api/origin_inspector_realtime_api.rb +223 -0
  133. data/lib/fastly/api/request_settings_api.rb +75 -0
  134. data/lib/fastly/api/response_object_api.rb +157 -0
  135. data/lib/fastly/api/secret_store_api.rb +381 -0
  136. data/lib/fastly/api/secret_store_item_api.rb +437 -0
  137. data/lib/fastly/api/service_authorizations_api.rb +126 -0
  138. data/lib/fastly/api/snippet_api.rb +88 -6
  139. data/lib/fastly/api/sudo_api.rb +83 -0
  140. data/lib/fastly/api/tokens_api.rb +122 -0
  141. data/lib/fastly/api/vcl_api.rb +10 -10
  142. data/lib/fastly/api/waf_active_rules_api.rb +75 -0
  143. data/lib/fastly/configuration.rb +504 -0
  144. data/lib/fastly/models/acl_entry.rb +1 -1
  145. data/lib/fastly/models/acl_entry_response.rb +1 -1
  146. data/lib/fastly/models/batch.rb +239 -0
  147. data/lib/fastly/models/batch_errors.rb +247 -0
  148. data/lib/fastly/models/bulk_update_acl_entry.rb +1 -1
  149. data/lib/fastly/models/client_key.rb +239 -0
  150. data/lib/fastly/models/content.rb +8 -4
  151. data/lib/fastly/models/domain.rb +1 -0
  152. data/lib/fastly/models/domain_inspector.rb +238 -0
  153. data/lib/fastly/models/domain_inspector_entry.rb +228 -0
  154. data/lib/fastly/models/domain_inspector_entry_dimensions.rb +238 -0
  155. data/lib/fastly/models/domain_inspector_measurements.rb +828 -0
  156. data/lib/fastly/models/domain_inspector_realtime_entry.rb +241 -0
  157. data/lib/fastly/models/event_attributes.rb +4 -2
  158. data/lib/fastly/models/{events_response_all_of.rb → event_data.rb} +3 -3
  159. data/lib/fastly/models/events_response.rb +1 -1
  160. data/lib/fastly/models/historical_domains.rb +249 -0
  161. data/lib/fastly/models/historical_domains_data.rb +228 -0
  162. data/lib/fastly/models/historical_domains_meta.rb +297 -0
  163. data/lib/fastly/models/historical_domains_meta_filters.rb +235 -0
  164. data/lib/fastly/models/historical_domains_response.rb +257 -0
  165. data/lib/fastly/models/historical_domains_response_all_of.rb +219 -0
  166. data/lib/fastly/models/historical_field_results_attributes.rb +1 -1
  167. data/lib/fastly/models/{historical_field_results_attributes_all_of.rb → historical_field_results_attributes_additional.rb} +3 -3
  168. data/lib/fastly/models/historical_origins_response.rb +257 -0
  169. data/lib/fastly/models/historical_origins_response_all_of.rb +219 -0
  170. data/lib/fastly/models/inline_response2005.rb +227 -0
  171. data/lib/fastly/models/inline_response2006.rb +227 -0
  172. data/lib/fastly/models/inline_response2007.rb +218 -0
  173. data/lib/fastly/models/inline_response400.rb +250 -0
  174. data/lib/fastly/models/legacy_waf_configuration_set.rb +227 -0
  175. data/lib/fastly/models/legacy_waf_firewall.rb +297 -0
  176. data/lib/fastly/models/legacy_waf_owasp.rb +527 -0
  177. data/lib/fastly/models/legacy_waf_rule.rb +257 -0
  178. data/lib/fastly/models/legacy_waf_rule_status.rb +237 -0
  179. data/lib/fastly/models/legacy_waf_ruleset.rb +227 -0
  180. data/lib/fastly/models/legacy_waf_tag.rb +217 -0
  181. data/lib/fastly/models/legacy_waf_update_status.rb +267 -0
  182. data/lib/fastly/models/origin_inspector.rb +238 -0
  183. data/lib/fastly/models/origin_inspector_dimensions.rb +238 -0
  184. data/lib/fastly/models/origin_inspector_entry.rb +228 -0
  185. data/lib/fastly/models/origin_inspector_historical.rb +249 -0
  186. data/lib/fastly/models/origin_inspector_historical_data.rb +225 -0
  187. data/lib/fastly/models/origin_inspector_historical_meta.rb +297 -0
  188. data/lib/fastly/models/origin_inspector_historical_meta_filters.rb +235 -0
  189. data/lib/fastly/models/origin_inspector_measurements.rb +1728 -0
  190. data/lib/fastly/models/origin_inspector_realtime_entry.rb +241 -0
  191. data/lib/fastly/models/origin_inspector_realtime_entry_recorded.rb +208 -0
  192. data/lib/fastly/models/origin_inspector_subsequent_request_timestamp.rb +208 -0
  193. data/lib/fastly/models/origin_inspector_values.rb +1728 -0
  194. data/lib/fastly/models/pagination_cursor_meta.rb +227 -0
  195. data/lib/fastly/models/read_only_service_id.rb +207 -0
  196. data/lib/fastly/models/read_only_version.rb +207 -0
  197. data/lib/fastly/models/realtime_entry.rb +2 -7
  198. data/lib/fastly/models/realtime_entry_aggregated.rb +2397 -0
  199. data/lib/fastly/models/realtime_entry_recorded.rb +208 -0
  200. data/lib/fastly/models/realtime_measurements.rb +4 -2
  201. data/lib/fastly/models/recorded_timestamp.rb +208 -0
  202. data/lib/fastly/models/schemas_snippet_response.rb +3 -3
  203. data/lib/fastly/models/secret.rb +238 -0
  204. data/lib/fastly/models/secret_response.rb +249 -0
  205. data/lib/fastly/models/secret_store.rb +217 -0
  206. data/lib/fastly/models/secret_store_response.rb +238 -0
  207. data/lib/fastly/models/signing_key.rb +218 -0
  208. data/lib/fastly/models/snippet.rb +3 -3
  209. data/lib/fastly/models/snippet_response.rb +3 -3
  210. data/lib/fastly/models/subsequent_request_timestamp.rb +208 -0
  211. data/lib/fastly/models/sudo_generic_token_error.rb +216 -0
  212. data/lib/fastly/models/sudo_request.rb +244 -0
  213. data/lib/fastly/models/sudo_response.rb +217 -0
  214. data/lib/fastly/models/tokens_additional_props.rb +227 -0
  215. data/lib/fastly/models/validator_result.rb +7 -84
  216. data/lib/fastly/models/validator_result_data.rb +234 -0
  217. data/lib/fastly/models/validator_result_data_attributes.rb +293 -0
  218. data/lib/fastly/models/{validator_result_messages.rb → validator_result_data_attributes_messages.rb} +4 -4
  219. data/lib/fastly/models/values.rb +828 -0
  220. data/lib/fastly/models/vcl_syntax_highlighting_response.rb +217 -0
  221. data/lib/fastly/version.rb +1 -1
  222. data/lib/fastly.rb +79 -3
  223. data/sig.json +1 -1
  224. metadata +160 -8
@@ -10,12 +10,68 @@ api_instance = Fastly::ApexRedirectApi.new
10
10
 
11
11
  | Method | HTTP request | Description |
12
12
  | ------ | ------------ | ----------- |
13
+ | [**create_apex_redirect**](ApexRedirectApi.md#create_apex_redirect) | **POST** /service/{service_id}/version/{version_id}/apex-redirects | Create an apex redirect |
13
14
  | [**delete_apex_redirect**](ApexRedirectApi.md#delete_apex_redirect) | **DELETE** /apex-redirects/{apex_redirect_id} | Delete an apex redirect |
14
15
  | [**get_apex_redirect**](ApexRedirectApi.md#get_apex_redirect) | **GET** /apex-redirects/{apex_redirect_id} | Get an apex redirect |
15
16
  | [**list_apex_redirects**](ApexRedirectApi.md#list_apex_redirects) | **GET** /service/{service_id}/version/{version_id}/apex-redirects | List apex redirects |
16
17
  | [**update_apex_redirect**](ApexRedirectApi.md#update_apex_redirect) | **PUT** /apex-redirects/{apex_redirect_id} | Update an apex redirect |
17
18
 
18
19
 
20
+ ## `create_apex_redirect()`
21
+
22
+ ```ruby
23
+ create_apex_redirect(opts): <ApexRedirect> # Create an apex redirect
24
+ ```
25
+
26
+ Create an apex redirect for a particular service and version.
27
+
28
+ ### Examples
29
+
30
+ ```ruby
31
+ api_instance = Fastly::ApexRedirectApi.new
32
+ opts = {
33
+ service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
34
+ version_id: 56, # Integer | Integer identifying a service version.
35
+ service_id: 'service_id_example', # String |
36
+ version: 56, # Integer |
37
+ created_at: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Date and time in ISO 8601 format.
38
+ deleted_at: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Date and time in ISO 8601 format.
39
+ updated_at: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Date and time in ISO 8601 format.
40
+ status_code: 301, # Integer | HTTP status code used to redirect the client.
41
+ domains: ['inner_example'], # Array<String> | Array of apex domains that should redirect to their WWW subdomain.
42
+ feature_revision: 56, # Integer | Revision number of the apex redirect feature implementation. Defaults to the most recent revision.
43
+ }
44
+
45
+ begin
46
+ # Create an apex redirect
47
+ result = api_instance.create_apex_redirect(opts)
48
+ p result
49
+ rescue Fastly::ApiError => e
50
+ puts "Error when calling ApexRedirectApi->create_apex_redirect: #{e}"
51
+ end
52
+ ```
53
+
54
+ ### Options
55
+
56
+ | Name | Type | Description | Notes |
57
+ | ---- | ---- | ----------- | ----- |
58
+ | **service_id** | **String** | Alphanumeric string identifying the service. | |
59
+ | **version_id** | **Integer** | Integer identifying a service version. | |
60
+ | **service_id** | **String** | | [optional] |
61
+ | **version** | **Integer** | | [optional] |
62
+ | **created_at** | **Time** | Date and time in ISO 8601 format. | [optional] |
63
+ | **deleted_at** | **Time** | Date and time in ISO 8601 format. | [optional] |
64
+ | **updated_at** | **Time** | Date and time in ISO 8601 format. | [optional] |
65
+ | **status_code** | **Integer** | HTTP status code used to redirect the client. | [optional] |
66
+ | **domains** | [**Array&lt;String&gt;**](String.md) | Array of apex domains that should redirect to their WWW subdomain. | [optional] |
67
+ | **feature_revision** | **Integer** | Revision number of the apex redirect feature implementation. Defaults to the most recent revision. | [optional] |
68
+
69
+ ### Return type
70
+
71
+ [**ApexRedirect**](ApexRedirect.md)
72
+
73
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
74
+ [[Back to README]](../../README.md)
19
75
  ## `delete_apex_redirect()`
20
76
 
21
77
  ```ruby
data/docs/Batch.md ADDED
@@ -0,0 +1,12 @@
1
+ # Fastly::Batch
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **title** | **String** | A descriptor for the response of the entire batch | [optional] |
8
+ | **type** | **String** | If an error is present in any of the requests, this field will describe that error | [optional] |
9
+ | **errors** | [**Array&lt;BatchErrors&gt;**](BatchErrors.md) | Per-key errors which failed to parse, validate, or otherwise transmit | [optional] |
10
+
11
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
12
+
@@ -0,0 +1,13 @@
1
+ # Fastly::BatchErrors
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **key** | **String** | The key that the error corresponds to. This field will be empty if the object or one of its fields was unable to be parsed. | [optional] |
8
+ | **index** | **Integer** | The line number of the payload on which the error occurred (starting from 0 for the first line). | [optional] |
9
+ | **code** | **String** | The HTTP response code for the request, or a 400 if the request was not able to be completed. | [optional] |
10
+ | **reason** | **String** | A descriptor of this particular item&#39;s error. | [optional] |
11
+
12
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
13
+
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **negated** | **Integer** | Whether to negate the match. Useful primarily when creating individual exceptions to larger subnets. | [optional][default to NEGATED::N0] |
7
+ | **negated** | **Integer** | Whether to negate the match. Useful primarily when creating individual exceptions to larger subnets. | [optional][default to NEGATED::disable] |
8
8
  | **comment** | **String** | A freeform descriptive note. | [optional] |
9
9
  | **ip** | **String** | An IP address. | [optional] |
10
10
  | **subnet** | **Integer** | Number of bits for the subnet mask applied to the IP address. For IPv4 addresses, a value of 32 represents the smallest subnet mask (1 address), 24 represents a class C subnet mask (256 addresses), 16 represents a class B subnet mask (65k addresses), and 8 is class A subnet mask (16m addresses). If not provided, no mask is applied. | [optional] |
data/docs/ClientKey.md ADDED
@@ -0,0 +1,12 @@
1
+ # Fastly::ClientKey
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **client_key** | **String** | A Base64-encoded X25519 public key that can be used with a [libsodium-compatible sealed box](https://libsodium.gitbook.io/doc/public-key_cryptography/sealed_boxes) to encrypt secrets before upload. | [optional] |
8
+ | **signature** | **String** | A Base64-encoded signature of the client key. The signature is generated using the signing key and must be verified before using the client key. | [optional] |
9
+ | **expires_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
10
+
11
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
12
+
data/docs/ContactApi.md CHANGED
@@ -10,10 +10,60 @@ api_instance = Fastly::ContactApi.new
10
10
 
11
11
  | Method | HTTP request | Description |
12
12
  | ------ | ------------ | ----------- |
13
+ | [**create_contacts**](ContactApi.md#create_contacts) | **POST** /customer/{customer_id}/contacts | Add a new customer contact |
13
14
  | [**delete_contact**](ContactApi.md#delete_contact) | **DELETE** /customer/{customer_id}/contact/{contact_id} | Delete a contact |
14
15
  | [**list_contacts**](ContactApi.md#list_contacts) | **GET** /customer/{customer_id}/contacts | List contacts |
15
16
 
16
17
 
18
+ ## `create_contacts()`
19
+
20
+ ```ruby
21
+ create_contacts(opts): <ContactResponse> # Add a new customer contact
22
+ ```
23
+
24
+ Create a contact.
25
+
26
+ ### Examples
27
+
28
+ ```ruby
29
+ api_instance = Fastly::ContactApi.new
30
+ opts = {
31
+ customer_id: 'customer_id_example', # String | Alphanumeric string identifying the customer.
32
+ user_id: 'user_id_example', # String | The alphanumeric string representing the user for this customer contact.
33
+ contact_type: 'primary', # String | The type of contact.
34
+ name: 'name_example', # String | The name of this contact, when user_id is not provided.
35
+ email: 'email_example', # String | The email of this contact, when a user_id is not provided.
36
+ phone: 'phone_example', # String | The phone number for this contact. Required for primary, technical, and security contact types.
37
+ customer_id: 'customer_id_example', # String | The alphanumeric string representing the customer for this customer contact.
38
+ }
39
+
40
+ begin
41
+ # Add a new customer contact
42
+ result = api_instance.create_contacts(opts)
43
+ p result
44
+ rescue Fastly::ApiError => e
45
+ puts "Error when calling ContactApi->create_contacts: #{e}"
46
+ end
47
+ ```
48
+
49
+ ### Options
50
+
51
+ | Name | Type | Description | Notes |
52
+ | ---- | ---- | ----------- | ----- |
53
+ | **customer_id** | **String** | Alphanumeric string identifying the customer. | |
54
+ | **user_id** | **String** | The alphanumeric string representing the user for this customer contact. | [optional] |
55
+ | **contact_type** | **String** | The type of contact. | [optional] |
56
+ | **name** | **String** | The name of this contact, when user_id is not provided. | [optional] |
57
+ | **email** | **String** | The email of this contact, when a user_id is not provided. | [optional] |
58
+ | **phone** | **String** | The phone number for this contact. Required for primary, technical, and security contact types. | [optional] |
59
+ | **customer_id** | **String** | The alphanumeric string representing the customer for this customer contact. | [optional] |
60
+
61
+ ### Return type
62
+
63
+ [**ContactResponse**](ContactResponse.md)
64
+
65
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
66
+ [[Back to README]](../../README.md)
17
67
  ## `delete_contact()`
18
68
 
19
69
  ```ruby
data/docs/Content.md CHANGED
@@ -5,8 +5,8 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **hash** | **String** | | [optional] |
8
- | **request** | **Object** | | [optional] |
9
- | **response** | **Object** | | [optional] |
8
+ | **request** | **Hash&lt;String, Object&gt;** | | [optional] |
9
+ | **response** | **Hash&lt;String, Object&gt;** | | [optional] |
10
10
  | **response_time** | **Float** | | [optional] |
11
11
  | **server** | **String** | | [optional] |
12
12
  | **pop** | **String** | | [optional] |
@@ -0,0 +1,52 @@
1
+ # Fastly::ContentApi
2
+
3
+
4
+ ```ruby
5
+ require 'fastly'
6
+ api_instance = Fastly::ContentApi.new
7
+ ```
8
+
9
+ ## Methods
10
+
11
+ | Method | HTTP request | Description |
12
+ | ------ | ------------ | ----------- |
13
+ | [**content_check**](ContentApi.md#content_check) | **GET** /content/edge_check | Check status of content in each POP&#39;s cache |
14
+
15
+
16
+ ## `content_check()`
17
+
18
+ ```ruby
19
+ content_check(opts): <Array<Content>> # Check status of content in each POP's cache
20
+ ```
21
+
22
+ Retrieve headers and MD5 hash of the content for a particular URL from each Fastly edge server. This API is limited to 200 requests per hour.
23
+
24
+ ### Examples
25
+
26
+ ```ruby
27
+ api_instance = Fastly::ContentApi.new
28
+ opts = {
29
+ url: 'https://www.example.com/foo/bar', # String | Full URL (host and path) to check on all nodes. if protocol is omitted, http will be assumed.
30
+ }
31
+
32
+ begin
33
+ # Check status of content in each POP's cache
34
+ result = api_instance.content_check(opts)
35
+ p result
36
+ rescue Fastly::ApiError => e
37
+ puts "Error when calling ContentApi->content_check: #{e}"
38
+ end
39
+ ```
40
+
41
+ ### Options
42
+
43
+ | Name | Type | Description | Notes |
44
+ | ---- | ---- | ----------- | ----- |
45
+ | **url** | **String** | Full URL (host and path) to check on all nodes. if protocol is omitted, http will be assumed. | [optional] |
46
+
47
+ ### Return type
48
+
49
+ [**Array&lt;Content&gt;**](Content.md)
50
+
51
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
52
+ [[Back to README]](../../README.md)
data/docs/DirectorApi.md CHANGED
@@ -14,6 +14,7 @@ api_instance = Fastly::DirectorApi.new
14
14
  | [**delete_director**](DirectorApi.md#delete_director) | **DELETE** /service/{service_id}/version/{version_id}/director/{director_name} | Delete a director |
15
15
  | [**get_director**](DirectorApi.md#get_director) | **GET** /service/{service_id}/version/{version_id}/director/{director_name} | Get a director |
16
16
  | [**list_directors**](DirectorApi.md#list_directors) | **GET** /service/{service_id}/version/{version_id}/director | List directors |
17
+ | [**update_director**](DirectorApi.md#update_director) | **PUT** /service/{service_id}/version/{version_id}/director/{director_name} | Update a director |
17
18
 
18
19
 
19
20
  ## `create_director()`
@@ -192,3 +193,44 @@ end
192
193
 
193
194
  [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
194
195
  [[Back to README]](../../README.md)
196
+ ## `update_director()`
197
+
198
+ ```ruby
199
+ update_director(opts): <DirectorResponse> # Update a director
200
+ ```
201
+
202
+ Update the director for a particular service and version.
203
+
204
+ ### Examples
205
+
206
+ ```ruby
207
+ api_instance = Fastly::DirectorApi.new
208
+ opts = {
209
+ service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
210
+ version_id: 56, # Integer | Integer identifying a service version.
211
+ director_name: 'director_name_example', # String | Name for the Director.
212
+ }
213
+
214
+ begin
215
+ # Update a director
216
+ result = api_instance.update_director(opts)
217
+ p result
218
+ rescue Fastly::ApiError => e
219
+ puts "Error when calling DirectorApi->update_director: #{e}"
220
+ end
221
+ ```
222
+
223
+ ### Options
224
+
225
+ | Name | Type | Description | Notes |
226
+ | ---- | ---- | ----------- | ----- |
227
+ | **service_id** | **String** | Alphanumeric string identifying the service. | |
228
+ | **version_id** | **Integer** | Integer identifying a service version. | |
229
+ | **director_name** | **String** | Name for the Director. | |
230
+
231
+ ### Return type
232
+
233
+ [**DirectorResponse**](DirectorResponse.md)
234
+
235
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
236
+ [[Back to README]](../../README.md)
@@ -0,0 +1,12 @@
1
+ # Fastly::DomainInspector
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **timestamp** | [**SubsequentRequestTimestamp**](SubsequentRequestTimestamp.md) | | [optional] |
8
+ | **aggregate_delay** | **Integer** | Offset of entry timestamps from the current time due to processing time. | [optional] |
9
+ | **data** | [**Array&lt;DomainInspectorRealtimeEntry&gt;**](DomainInspectorRealtimeEntry.md) | A list of report [entries](#entry-data-model), each representing one second of time. | [optional] |
10
+
11
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
12
+
@@ -0,0 +1,11 @@
1
+ # Fastly::DomainInspectorEntry
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **dimensions** | [**DomainInspectorEntryDimensions**](DomainInspectorEntryDimensions.md) | | [optional] |
8
+ | **values** | [**Array&lt;Values&gt;**](Values.md) | An array of values representing the metric values at each point in time. Note that this dataset is sparse: only the keys with non-zero values will be included in the record. | [optional] |
9
+
10
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
11
+
@@ -0,0 +1,12 @@
1
+ # Fastly::DomainInspectorEntryDimensions
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **region** | **String** | The geographic region from which the edge responses in this data entry were delivered. If unspecified, results are aggregated across regions. | [optional] |
8
+ | **datacenter** | **String** | The POP from which the edge responses in this data entry were delivered. If unspecified, results are aggregated across POPs. | [optional] |
9
+ | **domain** | **String** | The domain from which the edge responses in this data entry were delivered. If unspecified, results are aggregated across domains. | [optional] |
10
+
11
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
12
+
@@ -0,0 +1,72 @@
1
+ # Fastly::DomainInspectorHistoricalApi
2
+
3
+
4
+ ```ruby
5
+ require 'fastly'
6
+ api_instance = Fastly::DomainInspectorHistoricalApi.new
7
+ ```
8
+
9
+ ## Methods
10
+
11
+ | Method | HTTP request | Description |
12
+ | ------ | ------------ | ----------- |
13
+ | [**get_domain_inspector_historical**](DomainInspectorHistoricalApi.md#get_domain_inspector_historical) | **GET** /metrics/domains/services/{service_id} | Get historical domain data for a service |
14
+
15
+
16
+ ## `get_domain_inspector_historical()`
17
+
18
+ ```ruby
19
+ get_domain_inspector_historical(opts): <HistoricalDomainsResponse> # Get historical domain data for a service
20
+ ```
21
+
22
+ Fetches historical domain metrics for a given Fastly service, optionally filtering and grouping the results by domain, region, or POP.
23
+
24
+ ### Examples
25
+
26
+ ```ruby
27
+ api_instance = Fastly::DomainInspectorHistoricalApi.new
28
+ opts = {
29
+ service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
30
+ start: '2021-08-01T00:00:00.000Z', # String | A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the inclusive start of the query time range. If not provided, a default is chosen based on the provided `downsample` value.
31
+ _end: '2020-08-02T00:00:00.000Z', # String | A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the exclusive end of the query time range. If not provided, a default is chosen based on the provided `downsample` value.
32
+ downsample: 'hour', # String | Duration of sample windows.
33
+ metric: 'resp_body_bytes,status_2xx', # String | The metric to retrieve. Up to ten comma-separated metrics are accepted.
34
+ group_by: 'domain', # String | Dimensions to return in the query. Multiple dimensions may be separated by commas. For example, `group_by=domain` will return one timeseries for every domain, as a total across all datacenters (POPs).
35
+ limit: 'limit_example', # String | Number of results per page. The maximum is 200.
36
+ cursor: 'cursor_example', # String | Cursor value from a previous response to retrieve the next page. To request the first page, this should be empty.
37
+ region: 'usa', # String | Limit query to one or more specific geographic regions. Values should be comma-separated.
38
+ datacenter: 'SJC,STP', # String | Limit query to one or more specific POPs. Values should be comma-separated.
39
+ domain: 'domain_1.com,domain_2.com', # String | Limit query to one or more specific domains. Values should be comma-separated.
40
+ }
41
+
42
+ begin
43
+ # Get historical domain data for a service
44
+ result = api_instance.get_domain_inspector_historical(opts)
45
+ p result
46
+ rescue Fastly::ApiError => e
47
+ puts "Error when calling DomainInspectorHistoricalApi->get_domain_inspector_historical: #{e}"
48
+ end
49
+ ```
50
+
51
+ ### Options
52
+
53
+ | Name | Type | Description | Notes |
54
+ | ---- | ---- | ----------- | ----- |
55
+ | **service_id** | **String** | Alphanumeric string identifying the service. | |
56
+ | **start** | **String** | A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the inclusive start of the query time range. If not provided, a default is chosen based on the provided `downsample` value. | [optional] |
57
+ | **_end** | **String** | A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the exclusive end of the query time range. If not provided, a default is chosen based on the provided `downsample` value. | [optional] |
58
+ | **downsample** | **String** | Duration of sample windows. | [optional][default to &#39;hour&#39;] |
59
+ | **metric** | **String** | The metric to retrieve. Up to ten comma-separated metrics are accepted. | [optional][default to &#39;edge_requests&#39;] |
60
+ | **group_by** | **String** | Dimensions to return in the query. Multiple dimensions may be separated by commas. For example, `group_by&#x3D;domain` will return one timeseries for every domain, as a total across all datacenters (POPs). | [optional] |
61
+ | **limit** | **String** | Number of results per page. The maximum is 200. | [optional][default to &#39;100&#39;] |
62
+ | **cursor** | **String** | Cursor value from a previous response to retrieve the next page. To request the first page, this should be empty. | [optional] |
63
+ | **region** | **String** | Limit query to one or more specific geographic regions. Values should be comma-separated. | [optional] |
64
+ | **datacenter** | **String** | Limit query to one or more specific POPs. Values should be comma-separated. | [optional] |
65
+ | **domain** | **String** | Limit query to one or more specific domains. Values should be comma-separated. | [optional] |
66
+
67
+ ### Return type
68
+
69
+ [**HistoricalDomainsResponse**](HistoricalDomainsResponse.md)
70
+
71
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
72
+ [[Back to README]](../../README.md)
@@ -0,0 +1,71 @@
1
+ # Fastly::DomainInspectorMeasurements
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **edge_requests** | **Integer** | Number of requests sent by end users to Fastly. | [optional] |
8
+ | **edge_resp_header_bytes** | **Integer** | Total header bytes delivered from Fastly to the end user. | [optional] |
9
+ | **edge_resp_body_bytes** | **Integer** | Total body bytes delivered from Fastly to the end user. | [optional] |
10
+ | **status_1xx** | **Integer** | Number of 1xx \&quot;Informational\&quot; category status codes delivered. | [optional] |
11
+ | **status_2xx** | **Integer** | Number of 2xx \&quot;Success\&quot; status codes delivered. | [optional] |
12
+ | **status_3xx** | **Integer** | Number of 3xx \&quot;Redirection\&quot; codes delivered. | [optional] |
13
+ | **status_4xx** | **Integer** | Number of 4xx \&quot;Client Error\&quot; codes delivered. | [optional] |
14
+ | **status_5xx** | **Integer** | Number of 5xx \&quot;Server Error\&quot; codes delivered. | [optional] |
15
+ | **status_200** | **Integer** | Number of responses delivered with status code 200 (Success). | [optional] |
16
+ | **status_204** | **Integer** | Number of responses delivered with status code 204 (No Content). | [optional] |
17
+ | **status_206** | **Integer** | Number of responses delivered with status code 206 (Partial Content). | [optional] |
18
+ | **status_301** | **Integer** | Number of responses delivered with status code 301 (Moved Permanently). | [optional] |
19
+ | **status_302** | **Integer** | Number of responses delivered with status code 302 (Found). | [optional] |
20
+ | **status_304** | **Integer** | Number of responses delivered with status code 304 (Not Modified). | [optional] |
21
+ | **status_400** | **Integer** | Number of responses delivered with status code 400 (Bad Request). | [optional] |
22
+ | **status_401** | **Integer** | Number of responses delivered with status code 401 (Unauthorized). | [optional] |
23
+ | **status_403** | **Integer** | Number of responses delivered with status code 403 (Forbidden). | [optional] |
24
+ | **status_404** | **Integer** | Number of responses delivered with status code 404 (Not Found). | [optional] |
25
+ | **status_416** | **Integer** | Number of responses delivered with status code 416 (Range Not Satisfiable). | [optional] |
26
+ | **status_429** | **Integer** | Number of responses delivered with status code 429 (Too Many Requests). | [optional] |
27
+ | **status_500** | **Integer** | Number of responses delivered with status code 500 (Internal Server Error). | [optional] |
28
+ | **status_501** | **Integer** | Number of responses delivered with status code 501 (Not Implemented). | [optional] |
29
+ | **status_502** | **Integer** | Number of responses delivered with status code 502 (Bad Gateway). | [optional] |
30
+ | **status_503** | **Integer** | Number of responses delivered with status code 503 (Service Unavailable). | [optional] |
31
+ | **status_504** | **Integer** | Number of responses delivered with status code 504 (Gateway Timeout). | [optional] |
32
+ | **status_505** | **Integer** | Number of responses delivered with status code 505 (HTTP Version Not Supported). | [optional] |
33
+ | **requests** | **Integer** | Number of requests processed. | [optional] |
34
+ | **resp_header_bytes** | **Integer** | Total header bytes delivered. | [optional] |
35
+ | **resp_body_bytes** | **Integer** | Total body bytes delivered. | [optional] |
36
+ | **bereq_header_bytes** | **Integer** | Total header bytes sent to origin. | [optional] |
37
+ | **bereq_body_bytes** | **Integer** | Total body bytes sent to origin. | [optional] |
38
+ | **edge_hit_requests** | **Integer** | Number of requests sent by end users to Fastly that resulted in a hit at the edge. | [optional] |
39
+ | **edge_miss_requests** | **Integer** | Number of requests sent by end users to Fastly that resulted in a miss at the edge. | [optional] |
40
+ | **origin_fetches** | **Integer** | Number of requests sent to origin. | [optional] |
41
+ | **origin_fetch_resp_header_bytes** | **Integer** | Total header bytes received from origin. | [optional] |
42
+ | **origin_fetch_resp_body_bytes** | **Integer** | Total body bytes received from origin. | [optional] |
43
+ | **bandwidth** | **Integer** | Total bytes delivered (`resp_header_bytes` + `resp_body_bytes` + `bereq_header_bytes` + `bereq_body_bytes`). | [optional] |
44
+ | **edge_hit_ratio** | **Float** | Ratio of cache hits to cache misses at the edge, between 0 and 1 (`edge_hit_requests` / (`edge_hit_requests` + `edge_miss_requests`)). | [optional] |
45
+ | **origin_offload** | **Float** | Ratio of response bytes delivered from the edge compared to what is delivered from origin, between 0 and 1. (`edge_resp_body_bytes` + `edge_resp_header_bytes`) / (`origin_fetch_resp_body_bytes` + `origin_fetch_resp_header_bytes` + `edge_resp_body_bytes` + `edge_resp_header_bytes`). | [optional] |
46
+ | **origin_status_200** | **Integer** | Number of responses received from origin with status code 200 (Success). | [optional] |
47
+ | **origin_status_204** | **Integer** | Number of responses received from origin with status code 204 (No Content). | [optional] |
48
+ | **origin_status_206** | **Integer** | Number of responses received from origin with status code 206 (Partial Content). | [optional] |
49
+ | **origin_status_301** | **Integer** | Number of responses received from origin with status code 301 (Moved Permanently). | [optional] |
50
+ | **origin_status_302** | **Integer** | Number of responses received from origin with status code 302 (Found). | [optional] |
51
+ | **origin_status_304** | **Integer** | Number of responses received from origin with status code 304 (Not Modified). | [optional] |
52
+ | **origin_status_400** | **Integer** | Number of responses received from origin with status code 400 (Bad Request). | [optional] |
53
+ | **origin_status_401** | **Integer** | Number of responses received from origin with status code 401 (Unauthorized). | [optional] |
54
+ | **origin_status_403** | **Integer** | Number of responses received from origin with status code 403 (Forbidden). | [optional] |
55
+ | **origin_status_404** | **Integer** | Number of responses received from origin with status code 404 (Not Found). | [optional] |
56
+ | **origin_status_416** | **Integer** | Number of responses received from origin with status code 416 (Range Not Satisfiable). | [optional] |
57
+ | **origin_status_429** | **Integer** | Number of responses received from origin with status code 429 (Too Many Requests). | [optional] |
58
+ | **origin_status_500** | **Integer** | Number of responses received from origin with status code 500 (Internal Server Error). | [optional] |
59
+ | **origin_status_501** | **Integer** | Number of responses received from origin with status code 501 (Not Implemented). | [optional] |
60
+ | **origin_status_502** | **Integer** | Number of responses received from origin with status code 502 (Bad Gateway). | [optional] |
61
+ | **origin_status_503** | **Integer** | Number of responses received from origin with status code 503 (Service Unavailable). | [optional] |
62
+ | **origin_status_504** | **Integer** | Number of responses received from origin with status code 504 (Gateway Timeout). | [optional] |
63
+ | **origin_status_505** | **Integer** | Number of responses received from origin with status code 505 (HTTP Version Not Supported). | [optional] |
64
+ | **origin_status_1xx** | **Integer** | Number of \&quot;Informational\&quot; category status codes received from origin. | [optional] |
65
+ | **origin_status_2xx** | **Integer** | Number of \&quot;Success\&quot; status codes received from origin. | [optional] |
66
+ | **origin_status_3xx** | **Integer** | Number of \&quot;Redirection\&quot; codes received from origin. | [optional] |
67
+ | **origin_status_4xx** | **Integer** | Number of \&quot;Client Error\&quot; codes received from origin. | [optional] |
68
+ | **origin_status_5xx** | **Integer** | Number of \&quot;Server Error\&quot; codes received from origin. | [optional] |
69
+
70
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
71
+
@@ -0,0 +1,132 @@
1
+ # Fastly::DomainInspectorRealtimeApi
2
+
3
+
4
+ ```ruby
5
+ require 'fastly'
6
+ api_instance = Fastly::DomainInspectorRealtimeApi.new
7
+ ```
8
+
9
+ ## Methods
10
+
11
+ | Method | HTTP request | Description |
12
+ | ------ | ------------ | ----------- |
13
+ | [**get_domain_inspector_last120_seconds**](DomainInspectorRealtimeApi.md#get_domain_inspector_last120_seconds) | **GET** /v1/domains/{service_id}/ts/h | Get real-time domain data for the last 120 seconds |
14
+ | [**get_domain_inspector_last_max_entries**](DomainInspectorRealtimeApi.md#get_domain_inspector_last_max_entries) | **GET** /v1/domains/{service_id}/ts/h/limit/{max_entries} | Get a limited number of real-time domain data entries |
15
+ | [**get_domain_inspector_last_second**](DomainInspectorRealtimeApi.md#get_domain_inspector_last_second) | **GET** /v1/domains/{service_id}/ts/{start_timestamp} | Get real-time domain data from a specified time |
16
+
17
+
18
+ ## `get_domain_inspector_last120_seconds()`
19
+
20
+ ```ruby
21
+ get_domain_inspector_last120_seconds(opts): <DomainInspector> # Get real-time domain data for the last 120 seconds
22
+ ```
23
+
24
+ Get data for the 120 seconds preceding the latest timestamp available for a service.
25
+
26
+ ### Examples
27
+
28
+ ```ruby
29
+ api_instance = Fastly::DomainInspectorRealtimeApi.new
30
+ opts = {
31
+ service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
32
+ }
33
+
34
+ begin
35
+ # Get real-time domain data for the last 120 seconds
36
+ result = api_instance.get_domain_inspector_last120_seconds(opts)
37
+ p result
38
+ rescue Fastly::ApiError => e
39
+ puts "Error when calling DomainInspectorRealtimeApi->get_domain_inspector_last120_seconds: #{e}"
40
+ end
41
+ ```
42
+
43
+ ### Options
44
+
45
+ | Name | Type | Description | Notes |
46
+ | ---- | ---- | ----------- | ----- |
47
+ | **service_id** | **String** | Alphanumeric string identifying the service. | |
48
+
49
+ ### Return type
50
+
51
+ [**DomainInspector**](DomainInspector.md)
52
+
53
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
54
+ [[Back to README]](../../README.md)
55
+ ## `get_domain_inspector_last_max_entries()`
56
+
57
+ ```ruby
58
+ get_domain_inspector_last_max_entries(opts): <DomainInspector> # Get a limited number of real-time domain data entries
59
+ ```
60
+
61
+ Get data for the `max_entries` seconds preceding the latest timestamp available for a service, up to a maximum of 120 entries.
62
+
63
+ ### Examples
64
+
65
+ ```ruby
66
+ api_instance = Fastly::DomainInspectorRealtimeApi.new
67
+ opts = {
68
+ service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
69
+ max_entries: 1, # Integer | Maximum number of results to show.
70
+ }
71
+
72
+ begin
73
+ # Get a limited number of real-time domain data entries
74
+ result = api_instance.get_domain_inspector_last_max_entries(opts)
75
+ p result
76
+ rescue Fastly::ApiError => e
77
+ puts "Error when calling DomainInspectorRealtimeApi->get_domain_inspector_last_max_entries: #{e}"
78
+ end
79
+ ```
80
+
81
+ ### Options
82
+
83
+ | Name | Type | Description | Notes |
84
+ | ---- | ---- | ----------- | ----- |
85
+ | **service_id** | **String** | Alphanumeric string identifying the service. | |
86
+ | **max_entries** | **Integer** | Maximum number of results to show. | |
87
+
88
+ ### Return type
89
+
90
+ [**DomainInspector**](DomainInspector.md)
91
+
92
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
93
+ [[Back to README]](../../README.md)
94
+ ## `get_domain_inspector_last_second()`
95
+
96
+ ```ruby
97
+ get_domain_inspector_last_second(opts): <DomainInspector> # Get real-time domain data from a specified time
98
+ ```
99
+
100
+ Get real-time domain data for the specified reporting period. Specify `0` to get a single entry for the last complete second. The `Timestamp` field included in the response provides the time index of the latest entry in the dataset and can be provided as the `start_timestamp` of the next request for a seamless continuation of the dataset from one request to the next. Due to processing latency, the earliest entry in the response dataset may be earlier than `start_timestamp` by the value of `AggregateDelay`.
101
+
102
+ ### Examples
103
+
104
+ ```ruby
105
+ api_instance = Fastly::DomainInspectorRealtimeApi.new
106
+ opts = {
107
+ service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
108
+ start_timestamp: 56, # Integer | Timestamp in seconds (Unix epoch time).
109
+ }
110
+
111
+ begin
112
+ # Get real-time domain data from a specified time
113
+ result = api_instance.get_domain_inspector_last_second(opts)
114
+ p result
115
+ rescue Fastly::ApiError => e
116
+ puts "Error when calling DomainInspectorRealtimeApi->get_domain_inspector_last_second: #{e}"
117
+ end
118
+ ```
119
+
120
+ ### Options
121
+
122
+ | Name | Type | Description | Notes |
123
+ | ---- | ---- | ----------- | ----- |
124
+ | **service_id** | **String** | Alphanumeric string identifying the service. | |
125
+ | **start_timestamp** | **Integer** | Timestamp in seconds (Unix epoch time). | |
126
+
127
+ ### Return type
128
+
129
+ [**DomainInspector**](DomainInspector.md)
130
+
131
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
132
+ [[Back to README]](../../README.md)
@@ -0,0 +1,12 @@
1
+ # Fastly::DomainInspectorRealtimeEntry
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **recorded** | [**RecordedTimestamp**](RecordedTimestamp.md) | | [optional] |
8
+ | **aggregated** | [**Hash&lt;String, DomainInspectorMeasurements&gt;**](DomainInspectorMeasurements.md) | Groups [measurements](#measurements-data-model) by backend name and then by IP address. | [optional] |
9
+ | **datacenter** | **Hash&lt;String, Hash&lt;String, DomainInspectorMeasurements&gt;&gt;** | Groups [measurements](#measurements-data-model) by POP, then backend name, and then IP address. See the [POPs API](/reference/api/utils/pops/) for details about POP identifiers. | [optional] |
10
+
11
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
12
+
@@ -10,7 +10,7 @@
10
10
  | **description** | **String** | Description of the event. | [optional] |
11
11
  | **event_type** | **String** | Type of event. Can be used with `filter[event_type]` | [optional] |
12
12
  | **ip** | **String** | IP addresses that the event was requested from. | [optional] |
13
- | **metadata** | **Object** | Hash of key value pairs of additional information. | [optional] |
13
+ | **metadata** | **Hash&lt;String, Object&gt;** | Hash of key value pairs of additional information. | [optional] |
14
14
  | **service_id** | **String** | | [optional][readonly] |
15
15
  | **user_id** | **String** | | [optional][readonly] |
16
16
  | **token_id** | **String** | | [optional][readonly] |
@@ -1,4 +1,4 @@
1
- # Fastly::EventsResponseAllOf
1
+ # Fastly::EventData
2
2
 
3
3
  ## Properties
4
4