fastly 5.0.0 → 5.1.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 (33) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +6 -0
  3. data/Gemfile.lock +1 -1
  4. data/README.md +15 -8
  5. data/docs/BulkUpdateConfigStoreItem.md +12 -0
  6. data/docs/{BulkUpdateDictionaryItemAllOf.md → BulkUpdateConfigStoreItemAllOf.md} +1 -1
  7. data/docs/BulkUpdateConfigStoreListRequest.md +10 -0
  8. data/docs/ConfigStore.md +10 -0
  9. data/docs/ConfigStoreApi.md +277 -0
  10. data/docs/ConfigStoreInfoResponse.md +10 -0
  11. data/docs/ConfigStoreItem.md +11 -0
  12. data/docs/ConfigStoreItemApi.md +302 -0
  13. data/docs/ConfigStoreItemResponse.md +15 -0
  14. data/docs/ConfigStoreItemResponseAllOf.md +10 -0
  15. data/docs/ConfigStoreResponse.md +14 -0
  16. data/docs/ConfigStoreResponseAllOf.md +10 -0
  17. data/lib/fastly/api/config_store_api.rb +463 -0
  18. data/lib/fastly/api/config_store_item_api.rb +529 -0
  19. data/lib/fastly/models/bulk_update_config_store_item.rb +278 -0
  20. data/lib/fastly/models/{bulk_update_dictionary_item_all_of.rb → bulk_update_config_store_item_all_of.rb} +3 -3
  21. data/lib/fastly/models/bulk_update_config_store_list_request.rb +218 -0
  22. data/lib/fastly/models/bulk_update_dictionary_item.rb +1 -1
  23. data/lib/fastly/models/config_store.rb +217 -0
  24. data/lib/fastly/models/config_store_info_response.rb +217 -0
  25. data/lib/fastly/models/config_store_item.rb +227 -0
  26. data/lib/fastly/models/config_store_item_response.rb +278 -0
  27. data/lib/fastly/models/config_store_item_response_all_of.rb +216 -0
  28. data/lib/fastly/models/config_store_response.rb +269 -0
  29. data/lib/fastly/models/config_store_response_all_of.rb +217 -0
  30. data/lib/fastly/version.rb +1 -1
  31. data/lib/fastly.rb +12 -1
  32. data/sig.json +1 -1
  33. metadata +26 -4
data/docs/ConfigStoreItemApi.md ADDED
@@ -0,0 +1,302 @@
1
+ # Fastly::ConfigStoreItemApi
2
+
3
+
4
+ ```ruby
5
+ require 'fastly'
6
+ api_instance = Fastly::ConfigStoreItemApi.new
7
+ ```
8
+
9
+ ## Methods
10
+
11
+ | Method | HTTP request | Description |
12
+ | ------ | ------------ | ----------- |
13
+ | [**bulk_update_config_store_item**](ConfigStoreItemApi.md#bulk_update_config_store_item) | **PATCH** /resources/stores/config/{config_store_id}/items | Update multiple entries in a config store |
14
+ | [**create_config_store_item**](ConfigStoreItemApi.md#create_config_store_item) | **POST** /resources/stores/config/{config_store_id}/item | Create an entry in a config store |
15
+ | [**delete_config_store_item**](ConfigStoreItemApi.md#delete_config_store_item) | **DELETE** /resources/stores/config/{config_store_id}/item/{config_store_item_key} | Delete an item from a config store |
16
+ | [**get_config_store_item**](ConfigStoreItemApi.md#get_config_store_item) | **GET** /resources/stores/config/{config_store_id}/item/{config_store_item_key} | Get an item from a config store |
17
+ | [**list_config_store_items**](ConfigStoreItemApi.md#list_config_store_items) | **GET** /resources/stores/config/{config_store_id}/items | List items in a config store |
18
+ | [**update_config_store_item**](ConfigStoreItemApi.md#update_config_store_item) | **PATCH** /resources/stores/config/{config_store_id}/item/{config_store_item_key} | Update an entry in a config store |
19
+ | [**upsert_config_store_item**](ConfigStoreItemApi.md#upsert_config_store_item) | **PUT** /resources/stores/config/{config_store_id}/item/{config_store_item_key} | Insert or update an entry in a config store |
20
+
21
+
22
+ ## `bulk_update_config_store_item()`
23
+
24
+ ```ruby
25
+ bulk_update_config_store_item(opts): <InlineResponse200> # Update multiple entries in a config store
26
+ ```
27
+
28
+ Add multiple key-value pairs to an individual config store, specified by ID.
29
+
30
+ ### Examples
31
+
32
+ ```ruby
33
+ api_instance = Fastly::ConfigStoreItemApi.new
34
+ opts = {
35
+ config_store_id: 'config_store_id_example', # String | An alphanumeric string identifying the config store.
36
+ bulk_update_config_store_list_request: Fastly::BulkUpdateConfigStoreListRequest.new, # BulkUpdateConfigStoreListRequest |
37
+ }
38
+
39
+ begin
40
+ # Update multiple entries in a config store
41
+ result = api_instance.bulk_update_config_store_item(opts)
42
+ p result
43
+ rescue Fastly::ApiError => e
44
+ puts "Error when calling ConfigStoreItemApi->bulk_update_config_store_item: #{e}"
45
+ end
46
+ ```
47
+
48
+ ### Options
49
+
50
+ | Name | Type | Description | Notes |
51
+ | ---- | ---- | ----------- | ----- |
52
+ | **config_store_id** | **String** | An alphanumeric string identifying the config store. | |
53
+ | **bulk_update_config_store_list_request** | [**BulkUpdateConfigStoreListRequest**](BulkUpdateConfigStoreListRequest.md) | | [optional] |
54
+
55
+ ### Return type
56
+
57
+ [**InlineResponse200**](InlineResponse200.md)
58
+
59
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
60
+ [[Back to README]](../../README.md)
61
+ ## `create_config_store_item()`
62
+
63
+ ```ruby
64
+ create_config_store_item(opts): <ConfigStoreItemResponse> # Create an entry in a config store
65
+ ```
66
+
67
+ Add a single key-value pair to an individual config store, specified by ID.
68
+
69
+ ### Examples
70
+
71
+ ```ruby
72
+ api_instance = Fastly::ConfigStoreItemApi.new
73
+ opts = {
74
+ config_store_id: 'config_store_id_example', # String | An alphanumeric string identifying the config store.
75
+ item_key: 'item_key_example', # String | Item key, maximum 256 characters.
76
+ item_value: 'item_value_example', # String | Item value, maximum 8000 characters.
77
+ }
78
+
79
+ begin
80
+ # Create an entry in a config store
81
+ result = api_instance.create_config_store_item(opts)
82
+ p result
83
+ rescue Fastly::ApiError => e
84
+ puts "Error when calling ConfigStoreItemApi->create_config_store_item: #{e}"
85
+ end
86
+ ```
87
+
88
+ ### Options
89
+
90
+ | Name | Type | Description | Notes |
91
+ | ---- | ---- | ----------- | ----- |
92
+ | **config_store_id** | **String** | An alphanumeric string identifying the config store. | |
93
+ | **item_key** | **String** | Item key, maximum 256 characters. | [optional] |
94
+ | **item_value** | **String** | Item value, maximum 8000 characters. | [optional] |
95
+
96
+ ### Return type
97
+
98
+ [**ConfigStoreItemResponse**](ConfigStoreItemResponse.md)
99
+
100
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
101
+ [[Back to README]](../../README.md)
102
+ ## `delete_config_store_item()`
103
+
104
+ ```ruby
105
+ delete_config_store_item(opts): <InlineResponse200> # Delete an item from a config store
106
+ ```
107
+
108
+ Delete an entry in a config store given a config store ID, and item key.
109
+
110
+ ### Examples
111
+
112
+ ```ruby
113
+ api_instance = Fastly::ConfigStoreItemApi.new
114
+ opts = {
115
+ config_store_id: 'config_store_id_example', # String | An alphanumeric string identifying the config store.
116
+ config_store_item_key: 'config_store_item_key_example', # String | Item key, maximum 256 characters.
117
+ }
118
+
119
+ begin
120
+ # Delete an item from a config store
121
+ result = api_instance.delete_config_store_item(opts)
122
+ p result
123
+ rescue Fastly::ApiError => e
124
+ puts "Error when calling ConfigStoreItemApi->delete_config_store_item: #{e}"
125
+ end
126
+ ```
127
+
128
+ ### Options
129
+
130
+ | Name | Type | Description | Notes |
131
+ | ---- | ---- | ----------- | ----- |
132
+ | **config_store_id** | **String** | An alphanumeric string identifying the config store. | |
133
+ | **config_store_item_key** | **String** | Item key, maximum 256 characters. | |
134
+
135
+ ### Return type
136
+
137
+ [**InlineResponse200**](InlineResponse200.md)
138
+
139
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
140
+ [[Back to README]](../../README.md)
141
+ ## `get_config_store_item()`
142
+
143
+ ```ruby
144
+ get_config_store_item(opts): <ConfigStoreItemResponse> # Get an item from a config store
145
+ ```
146
+
147
+ Retrieve a config store entry given a config store ID and item key.
148
+
149
+ ### Examples
150
+
151
+ ```ruby
152
+ api_instance = Fastly::ConfigStoreItemApi.new
153
+ opts = {
154
+ config_store_id: 'config_store_id_example', # String | An alphanumeric string identifying the config store.
155
+ config_store_item_key: 'config_store_item_key_example', # String | Item key, maximum 256 characters.
156
+ }
157
+
158
+ begin
159
+ # Get an item from a config store
160
+ result = api_instance.get_config_store_item(opts)
161
+ p result
162
+ rescue Fastly::ApiError => e
163
+ puts "Error when calling ConfigStoreItemApi->get_config_store_item: #{e}"
164
+ end
165
+ ```
166
+
167
+ ### Options
168
+
169
+ | Name | Type | Description | Notes |
170
+ | ---- | ---- | ----------- | ----- |
171
+ | **config_store_id** | **String** | An alphanumeric string identifying the config store. | |
172
+ | **config_store_item_key** | **String** | Item key, maximum 256 characters. | |
173
+
174
+ ### Return type
175
+
176
+ [**ConfigStoreItemResponse**](ConfigStoreItemResponse.md)
177
+
178
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
179
+ [[Back to README]](../../README.md)
180
+ ## `list_config_store_items()`
181
+
182
+ ```ruby
183
+ list_config_store_items(opts): <Array<ConfigStoreItemResponse>> # List items in a config store
184
+ ```
185
+
186
+ List the key-value pairs associated with a given config store ID.
187
+
188
+ ### Examples
189
+
190
+ ```ruby
191
+ api_instance = Fastly::ConfigStoreItemApi.new
192
+ opts = {
193
+ config_store_id: 'config_store_id_example', # String | An alphanumeric string identifying the config store.
194
+ }
195
+
196
+ begin
197
+ # List items in a config store
198
+ result = api_instance.list_config_store_items(opts)
199
+ p result
200
+ rescue Fastly::ApiError => e
201
+ puts "Error when calling ConfigStoreItemApi->list_config_store_items: #{e}"
202
+ end
203
+ ```
204
+
205
+ ### Options
206
+
207
+ | Name | Type | Description | Notes |
208
+ | ---- | ---- | ----------- | ----- |
209
+ | **config_store_id** | **String** | An alphanumeric string identifying the config store. | |
210
+
211
+ ### Return type
212
+
213
+ [**Array&lt;ConfigStoreItemResponse&gt;**](ConfigStoreItemResponse.md)
214
+
215
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
216
+ [[Back to README]](../../README.md)
217
+ ## `update_config_store_item()`
218
+
219
+ ```ruby
220
+ update_config_store_item(opts): <ConfigStoreItemResponse> # Update an entry in a config store
221
+ ```
222
+
223
+ Update an entry in a config store given a config store ID, item key, and item value.
224
+
225
+ ### Examples
226
+
227
+ ```ruby
228
+ api_instance = Fastly::ConfigStoreItemApi.new
229
+ opts = {
230
+ config_store_id: 'config_store_id_example', # String | An alphanumeric string identifying the config store.
231
+ config_store_item_key: 'config_store_item_key_example', # String | Item key, maximum 256 characters.
232
+ item_key: 'item_key_example', # String | Item key, maximum 256 characters.
233
+ item_value: 'item_value_example', # String | Item value, maximum 8000 characters.
234
+ }
235
+
236
+ begin
237
+ # Update an entry in a config store
238
+ result = api_instance.update_config_store_item(opts)
239
+ p result
240
+ rescue Fastly::ApiError => e
241
+ puts "Error when calling ConfigStoreItemApi->update_config_store_item: #{e}"
242
+ end
243
+ ```
244
+
245
+ ### Options
246
+
247
+ | Name | Type | Description | Notes |
248
+ | ---- | ---- | ----------- | ----- |
249
+ | **config_store_id** | **String** | An alphanumeric string identifying the config store. | |
250
+ | **config_store_item_key** | **String** | Item key, maximum 256 characters. | |
251
+ | **item_key** | **String** | Item key, maximum 256 characters. | [optional] |
252
+ | **item_value** | **String** | Item value, maximum 8000 characters. | [optional] |
253
+
254
+ ### Return type
255
+
256
+ [**ConfigStoreItemResponse**](ConfigStoreItemResponse.md)
257
+
258
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
259
+ [[Back to README]](../../README.md)
260
+ ## `upsert_config_store_item()`
261
+
262
+ ```ruby
263
+ upsert_config_store_item(opts): <ConfigStoreItemResponse> # Insert or update an entry in a config store
264
+ ```
265
+
266
+ Insert or update an entry in a config store given a config store ID, item key, and item value.
267
+
268
+ ### Examples
269
+
270
+ ```ruby
271
+ api_instance = Fastly::ConfigStoreItemApi.new
272
+ opts = {
273
+ config_store_id: 'config_store_id_example', # String | An alphanumeric string identifying the config store.
274
+ config_store_item_key: 'config_store_item_key_example', # String | Item key, maximum 256 characters.
275
+ item_key: 'item_key_example', # String | Item key, maximum 256 characters.
276
+ item_value: 'item_value_example', # String | Item value, maximum 8000 characters.
277
+ }
278
+
279
+ begin
280
+ # Insert or update an entry in a config store
281
+ result = api_instance.upsert_config_store_item(opts)
282
+ p result
283
+ rescue Fastly::ApiError => e
284
+ puts "Error when calling ConfigStoreItemApi->upsert_config_store_item: #{e}"
285
+ end
286
+ ```
287
+
288
+ ### Options
289
+
290
+ | Name | Type | Description | Notes |
291
+ | ---- | ---- | ----------- | ----- |
292
+ | **config_store_id** | **String** | An alphanumeric string identifying the config store. | |
293
+ | **config_store_item_key** | **String** | Item key, maximum 256 characters. | |
294
+ | **item_key** | **String** | Item key, maximum 256 characters. | [optional] |
295
+ | **item_value** | **String** | Item value, maximum 8000 characters. | [optional] |
296
+
297
+ ### Return type
298
+
299
+ [**ConfigStoreItemResponse**](ConfigStoreItemResponse.md)
300
+
301
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
302
+ [[Back to README]](../../README.md)
data/docs/ConfigStoreItemResponse.md ADDED
@@ -0,0 +1,15 @@
1
+ # Fastly::ConfigStoreItemResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **item_key** | **String** | Item key, maximum 256 characters. | [optional] |
8
+ | **item_value** | **String** | Item value, maximum 8000 characters. | [optional] |
9
+ | **created_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
10
+ | **deleted_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
11
+ | **updated_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
12
+ | **store_id** | **String** | | [optional][readonly] |
13
+
14
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
15
+
data/docs/ConfigStoreItemResponseAllOf.md ADDED
@@ -0,0 +1,10 @@
1
+ # Fastly::ConfigStoreItemResponseAllOf
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **store_id** | **String** | | [optional][readonly] |
8
+
9
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
10
+
data/docs/ConfigStoreResponse.md ADDED
@@ -0,0 +1,14 @@
1
+ # Fastly::ConfigStoreResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **created_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
8
+ | **deleted_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
9
+ | **updated_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
10
+ | **name** | **String** | The name of the config store. | [optional] |
11
+ | **id** | **String** | An alphanumeric string identifying the config store. | [optional] |
12
+
13
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
14
+
data/docs/ConfigStoreResponseAllOf.md ADDED
@@ -0,0 +1,10 @@
1
+ # Fastly::ConfigStoreResponseAllOf
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | An alphanumeric string identifying the config store. | [optional] |
8
+
9
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
10
+