Class: Fastly::DictionaryItemApi

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/api/dictionary_item_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DictionaryItemApi

Returns a new instance of DictionaryItemApi.



17
18
19
 
# File 'lib/fastly/api/dictionary_item_api.rb', line 17

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/fastly/api/dictionary_item_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#bulk_update_dictionary_item(opts = {}) ⇒ InlineResponse200

Update multiple entries in an edge dictionary Update multiple items in the same dictionary. For faster updates to your service, group your changes into large batches. The maximum batch size is 1000 items. [Contact support](support.fastly.com/) to discuss raising this limit.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :dictionary_id (String) —

    Alphanumeric string identifying a Dictionary. (required)

  • :bulk_update_dictionary_list_request (BulkUpdateDictionaryListRequest)

Returns:



26
27
28
29
 
# File 'lib/fastly/api/dictionary_item_api.rb', line 26

def bulk_update_dictionary_item(opts = {})
  data, _status_code, _headers = bulk_update_dictionary_item_with_http_info(opts)
  data
end

#bulk_update_dictionary_item_with_http_info(opts = {}) ⇒ Array<(InlineResponse200, Integer, Hash)>

Update multiple entries in an edge dictionary Update multiple items in the same dictionary. For faster updates to your service, group your changes into large batches. The maximum batch size is 1000 items. [Contact support](support.fastly.com/) to discuss raising this limit.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :dictionary_id (String) —

    Alphanumeric string identifying a Dictionary. (required)

  • :bulk_update_dictionary_list_request (BulkUpdateDictionaryListRequest)

Returns:

  • (Array<(InlineResponse200, Integer, Hash)>) —

    InlineResponse200 data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/fastly/api/dictionary_item_api.rb', line 37

def bulk_update_dictionary_item_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DictionaryItemApi.bulk_update_dictionary_item ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  dictionary_id = opts[:'dictionary_id']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling DictionaryItemApi.bulk_update_dictionary_item"
  end
  # verify the required parameter 'dictionary_id' is set
  if @api_client.config.client_side_validation && dictionary_id.nil?
    fail ArgumentError, "Missing the required parameter 'dictionary_id' when calling DictionaryItemApi.bulk_update_dictionary_item"
  end
  # resource path
  local_var_path = '/service/{service_id}/dictionary/{dictionary_id}/items'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'dictionary_id' + '}', CGI.escape(dictionary_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'bulk_update_dictionary_list_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'InlineResponse200'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"DictionaryItemApi.bulk_update_dictionary_item",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DictionaryItemApi#bulk_update_dictionary_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_dictionary_item(opts = {}) ⇒ DictionaryItemResponse

Create an entry in an edge dictionary Create DictionaryItem given service, dictionary ID, item key, and item value.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :dictionary_id (String) —

    Alphanumeric string identifying a Dictionary. (required)

  • :item_key (String) —

    Item key, maximum 256 characters.

  • :item_value (String) —

    Item value, maximum 8000 characters.

Returns:



104
105
106
107
 
# File 'lib/fastly/api/dictionary_item_api.rb', line 104

def create_dictionary_item(opts = {})
  data, _status_code, _headers = create_dictionary_item_with_http_info(opts)
  data
end

#create_dictionary_item_with_http_info(opts = {}) ⇒ Array<(DictionaryItemResponse, Integer, Hash)>

Create an entry in an edge dictionary Create DictionaryItem given service, dictionary ID, item key, and item value.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :dictionary_id (String) —

    Alphanumeric string identifying a Dictionary. (required)

  • :item_key (String) —

    Item key, maximum 256 characters.

  • :item_value (String) —

    Item value, maximum 8000 characters.

Returns:

  • (Array<(DictionaryItemResponse, Integer, Hash)>) —

    DictionaryItemResponse data, response status code and response headers



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/fastly/api/dictionary_item_api.rb', line 116

def create_dictionary_item_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DictionaryItemApi.create_dictionary_item ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  dictionary_id = opts[:'dictionary_id']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling DictionaryItemApi.create_dictionary_item"
  end
  # verify the required parameter 'dictionary_id' is set
  if @api_client.config.client_side_validation && dictionary_id.nil?
    fail ArgumentError, "Missing the required parameter 'dictionary_id' when calling DictionaryItemApi.create_dictionary_item"
  end
  # resource path
  local_var_path = '/service/{service_id}/dictionary/{dictionary_id}/item'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'dictionary_id' + '}', CGI.escape(dictionary_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['item_key'] = opts[:'item_key'] if !opts[:'item_key'].nil?
  form_params['item_value'] = opts[:'item_value'] if !opts[:'item_value'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DictionaryItemResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"DictionaryItemApi.create_dictionary_item",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DictionaryItemApi#create_dictionary_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_dictionary_item(opts = {}) ⇒ InlineResponse200

Delete an item from an edge dictionary Delete DictionaryItem given service, dictionary ID, and item key.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :dictionary_id (String) —

    Alphanumeric string identifying a Dictionary. (required)

  • :dictionary_item_key (String) —

    Item key, maximum 256 characters. (required)

Returns:



184
185
186
187
 
# File 'lib/fastly/api/dictionary_item_api.rb', line 184

def delete_dictionary_item(opts = {})
  data, _status_code, _headers = delete_dictionary_item_with_http_info(opts)
  data
end

#delete_dictionary_item_with_http_info(opts = {}) ⇒ Array<(InlineResponse200, Integer, Hash)>

Delete an item from an edge dictionary Delete DictionaryItem given service, dictionary ID, and item key.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :dictionary_id (String) —

    Alphanumeric string identifying a Dictionary. (required)

  • :dictionary_item_key (String) —

    Item key, maximum 256 characters. (required)

Returns:

  • (Array<(InlineResponse200, Integer, Hash)>) —

    InlineResponse200 data, response status code and response headers



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/fastly/api/dictionary_item_api.rb', line 195

def delete_dictionary_item_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DictionaryItemApi.delete_dictionary_item ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  dictionary_id = opts[:'dictionary_id']
  dictionary_item_key = opts[:'dictionary_item_key']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling DictionaryItemApi.delete_dictionary_item"
  end
  # verify the required parameter 'dictionary_id' is set
  if @api_client.config.client_side_validation && dictionary_id.nil?
    fail ArgumentError, "Missing the required parameter 'dictionary_id' when calling DictionaryItemApi.delete_dictionary_item"
  end
  # verify the required parameter 'dictionary_item_key' is set
  if @api_client.config.client_side_validation && dictionary_item_key.nil?
    fail ArgumentError, "Missing the required parameter 'dictionary_item_key' when calling DictionaryItemApi.delete_dictionary_item"
  end
  # resource path
  local_var_path = '/service/{service_id}/dictionary/{dictionary_id}/item/{dictionary_item_key}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'dictionary_id' + '}', CGI.escape(dictionary_id.to_s)).sub('{' + 'dictionary_item_key' + '}', CGI.escape(dictionary_item_key.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'InlineResponse200'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"DictionaryItemApi.delete_dictionary_item",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DictionaryItemApi#delete_dictionary_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_dictionary_item(opts = {}) ⇒ DictionaryItemResponse

Get an item from an edge dictionary Retrieve a single DictionaryItem given service, dictionary ID and item key.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :dictionary_id (String) —

    Alphanumeric string identifying a Dictionary. (required)

  • :dictionary_item_key (String) —

    Item key, maximum 256 characters. (required)

Returns:



261
262
263
264
 
# File 'lib/fastly/api/dictionary_item_api.rb', line 261

def get_dictionary_item(opts = {})
  data, _status_code, _headers = get_dictionary_item_with_http_info(opts)
  data
end

#get_dictionary_item_with_http_info(opts = {}) ⇒ Array<(DictionaryItemResponse, Integer, Hash)>

Get an item from an edge dictionary Retrieve a single DictionaryItem given service, dictionary ID and item key.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :dictionary_id (String) —

    Alphanumeric string identifying a Dictionary. (required)

  • :dictionary_item_key (String) —

    Item key, maximum 256 characters. (required)

Returns:

  • (Array<(DictionaryItemResponse, Integer, Hash)>) —

    DictionaryItemResponse data, response status code and response headers



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/fastly/api/dictionary_item_api.rb', line 272

def get_dictionary_item_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DictionaryItemApi.get_dictionary_item ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  dictionary_id = opts[:'dictionary_id']
  dictionary_item_key = opts[:'dictionary_item_key']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling DictionaryItemApi.get_dictionary_item"
  end
  # verify the required parameter 'dictionary_id' is set
  if @api_client.config.client_side_validation && dictionary_id.nil?
    fail ArgumentError, "Missing the required parameter 'dictionary_id' when calling DictionaryItemApi.get_dictionary_item"
  end
  # verify the required parameter 'dictionary_item_key' is set
  if @api_client.config.client_side_validation && dictionary_item_key.nil?
    fail ArgumentError, "Missing the required parameter 'dictionary_item_key' when calling DictionaryItemApi.get_dictionary_item"
  end
  # resource path
  local_var_path = '/service/{service_id}/dictionary/{dictionary_id}/item/{dictionary_item_key}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'dictionary_id' + '}', CGI.escape(dictionary_id.to_s)).sub('{' + 'dictionary_item_key' + '}', CGI.escape(dictionary_item_key.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DictionaryItemResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"DictionaryItemApi.get_dictionary_item",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DictionaryItemApi#get_dictionary_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_dictionary_items(opts = {}) ⇒ Array<DictionaryItemResponse>

List items in an edge dictionary List of DictionaryItems given service and dictionary ID.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :dictionary_id (String) —

    Alphanumeric string identifying a Dictionary. (required)

  • :page (Integer) —

    Current page.

  • :per_page (Integer) —

    Number of records per page. (default to 20)

  • :sort (String) —

    Field on which to sort. (default to ‘created’)

  • :direction (String) —

    Direction in which to sort results. (default to ‘ascend’)

Returns:



341
342
343
344
 
# File 'lib/fastly/api/dictionary_item_api.rb', line 341

def list_dictionary_items(opts = {})
  data, _status_code, _headers = list_dictionary_items_with_http_info(opts)
  data
end

#list_dictionary_items_with_http_info(opts = {}) ⇒ Array<(Array<DictionaryItemResponse>, Integer, Hash)>

List items in an edge dictionary List of DictionaryItems given service and dictionary ID.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :dictionary_id (String) —

    Alphanumeric string identifying a Dictionary. (required)

  • :page (Integer) —

    Current page.

  • :per_page (Integer) —

    Number of records per page. (default to 20)

  • :sort (String) —

    Field on which to sort. (default to ‘created’)

  • :direction (String) —

    Direction in which to sort results. (default to ‘ascend’)

Returns:

  • (Array<(Array<DictionaryItemResponse>, Integer, Hash)>) —

    Array<DictionaryItemResponse> data, response status code and response headers



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/fastly/api/dictionary_item_api.rb', line 355

def list_dictionary_items_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DictionaryItemApi.list_dictionary_items ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  dictionary_id = opts[:'dictionary_id']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling DictionaryItemApi.list_dictionary_items"
  end
  # verify the required parameter 'dictionary_id' is set
  if @api_client.config.client_side_validation && dictionary_id.nil?
    fail ArgumentError, "Missing the required parameter 'dictionary_id' when calling DictionaryItemApi.list_dictionary_items"
  end
  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DictionaryItemApi.list_dictionary_items, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling DictionaryItemApi.list_dictionary_items, must be greater than or equal to 1.'
  end

  allowable_values = ["ascend", "descend"]
  if @api_client.config.client_side_validation && opts[:'direction'] && !allowable_values.include?(opts[:'direction'])
    fail ArgumentError, "invalid value for \"direction\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/service/{service_id}/dictionary/{dictionary_id}/items'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'dictionary_id' + '}', CGI.escape(dictionary_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'direction'] = opts[:'direction'] if !opts[:'direction'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<DictionaryItemResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"DictionaryItemApi.list_dictionary_items",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DictionaryItemApi#list_dictionary_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_dictionary_item(opts = {}) ⇒ DictionaryItemResponse

Update an entry in an edge dictionary Update DictionaryItem given service, dictionary ID, item key, and item value.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :dictionary_id (String) —

    Alphanumeric string identifying a Dictionary. (required)

  • :dictionary_item_key (String) —

    Item key, maximum 256 characters. (required)

  • :item_key (String) —

    Item key, maximum 256 characters.

  • :item_value (String) —

    Item value, maximum 8000 characters.

Returns:



434
435
436
437
 
# File 'lib/fastly/api/dictionary_item_api.rb', line 434

def update_dictionary_item(opts = {})
  data, _status_code, _headers = update_dictionary_item_with_http_info(opts)
  data
end

#update_dictionary_item_with_http_info(opts = {}) ⇒ Array<(DictionaryItemResponse, Integer, Hash)>

Update an entry in an edge dictionary Update DictionaryItem given service, dictionary ID, item key, and item value.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :dictionary_id (String) —

    Alphanumeric string identifying a Dictionary. (required)

  • :dictionary_item_key (String) —

    Item key, maximum 256 characters. (required)

  • :item_key (String) —

    Item key, maximum 256 characters.

  • :item_value (String) —

    Item value, maximum 8000 characters.

Returns:

  • (Array<(DictionaryItemResponse, Integer, Hash)>) —

    DictionaryItemResponse data, response status code and response headers



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/fastly/api/dictionary_item_api.rb', line 447

def update_dictionary_item_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DictionaryItemApi.update_dictionary_item ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  dictionary_id = opts[:'dictionary_id']
  dictionary_item_key = opts[:'dictionary_item_key']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling DictionaryItemApi.update_dictionary_item"
  end
  # verify the required parameter 'dictionary_id' is set
  if @api_client.config.client_side_validation && dictionary_id.nil?
    fail ArgumentError, "Missing the required parameter 'dictionary_id' when calling DictionaryItemApi.update_dictionary_item"
  end
  # verify the required parameter 'dictionary_item_key' is set
  if @api_client.config.client_side_validation && dictionary_item_key.nil?
    fail ArgumentError, "Missing the required parameter 'dictionary_item_key' when calling DictionaryItemApi.update_dictionary_item"
  end
  # resource path
  local_var_path = '/service/{service_id}/dictionary/{dictionary_id}/item/{dictionary_item_key}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'dictionary_id' + '}', CGI.escape(dictionary_id.to_s)).sub('{' + 'dictionary_item_key' + '}', CGI.escape(dictionary_item_key.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['item_key'] = opts[:'item_key'] if !opts[:'item_key'].nil?
  form_params['item_value'] = opts[:'item_value'] if !opts[:'item_value'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DictionaryItemResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"DictionaryItemApi.update_dictionary_item",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DictionaryItemApi#update_dictionary_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#upsert_dictionary_item(opts = {}) ⇒ DictionaryItemResponse

Insert or update an entry in an edge dictionary Upsert DictionaryItem given service, dictionary ID, item key, and item value.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :dictionary_id (String) —

    Alphanumeric string identifying a Dictionary. (required)

  • :dictionary_item_key (String) —

    Item key, maximum 256 characters. (required)

  • :item_key (String) —

    Item key, maximum 256 characters.

  • :item_value (String) —

    Item value, maximum 8000 characters.

Returns:



522
523
524
525
 
# File 'lib/fastly/api/dictionary_item_api.rb', line 522

def upsert_dictionary_item(opts = {})
  data, _status_code, _headers = upsert_dictionary_item_with_http_info(opts)
  data
end

#upsert_dictionary_item_with_http_info(opts = {}) ⇒ Array<(DictionaryItemResponse, Integer, Hash)>

Insert or update an entry in an edge dictionary Upsert DictionaryItem given service, dictionary ID, item key, and item value.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :dictionary_id (String) —

    Alphanumeric string identifying a Dictionary. (required)

  • :dictionary_item_key (String) —

    Item key, maximum 256 characters. (required)

  • :item_key (String) —

    Item key, maximum 256 characters.

  • :item_value (String) —

    Item value, maximum 8000 characters.

Returns:

  • (Array<(DictionaryItemResponse, Integer, Hash)>) —

    DictionaryItemResponse data, response status code and response headers



535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
 
# File 'lib/fastly/api/dictionary_item_api.rb', line 535

def upsert_dictionary_item_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DictionaryItemApi.upsert_dictionary_item ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  dictionary_id = opts[:'dictionary_id']
  dictionary_item_key = opts[:'dictionary_item_key']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling DictionaryItemApi.upsert_dictionary_item"
  end
  # verify the required parameter 'dictionary_id' is set
  if @api_client.config.client_side_validation && dictionary_id.nil?
    fail ArgumentError, "Missing the required parameter 'dictionary_id' when calling DictionaryItemApi.upsert_dictionary_item"
  end
  # verify the required parameter 'dictionary_item_key' is set
  if @api_client.config.client_side_validation && dictionary_item_key.nil?
    fail ArgumentError, "Missing the required parameter 'dictionary_item_key' when calling DictionaryItemApi.upsert_dictionary_item"
  end
  # resource path
  local_var_path = '/service/{service_id}/dictionary/{dictionary_id}/item/{dictionary_item_key}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'dictionary_id' + '}', CGI.escape(dictionary_id.to_s)).sub('{' + 'dictionary_item_key' + '}', CGI.escape(dictionary_item_key.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['item_key'] = opts[:'item_key'] if !opts[:'item_key'].nil?
  form_params['item_value'] = opts[:'item_value'] if !opts[:'item_value'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DictionaryItemResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"DictionaryItemApi.upsert_dictionary_item",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DictionaryItemApi#upsert_dictionary_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end