Class: Fastly::SnippetApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SnippetApi

Returns a new instance of SnippetApi.



17
18
19
 
# File 'lib/fastly/api/snippet_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/snippet_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#create_snippet(opts = {}) ⇒ SnippetResponsePost

Create a snippet Create a snippet for a particular service and version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :name (String) —

    The name for the snippet.

  • :type (String) —

    The location in generated VCL where the snippet should be placed.

  • :content (String) —

    The VCL code that specifies exactly what the snippet does.

  • :priority (String) —

    Priority determines execution order. Lower numbers execute first. (default to ‘100’)

  • :dynamic (String) —

    Sets the snippet version.

Returns:



30
31
32
33
 
# File 'lib/fastly/api/snippet_api.rb', line 30

def create_snippet(opts = {})
  data, _status_code, _headers = create_snippet_with_http_info(opts)
  data
end

#create_snippet_with_http_info(opts = {}) ⇒ Array<(SnippetResponsePost, Integer, Hash)>

Create a snippet Create a snippet for a particular service and version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :name (String) —

    The name for the snippet.

  • :type (String) —

    The location in generated VCL where the snippet should be placed.

  • :content (String) —

    The VCL code that specifies exactly what the snippet does.

  • :priority (String) —

    Priority determines execution order. Lower numbers execute first. (default to ‘100’)

  • :dynamic (String) —

    Sets the snippet version.

Returns:

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

    SnippetResponsePost data, response status code and response headers



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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/fastly/api/snippet_api.rb', line 45

def create_snippet_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SnippetApi.create_snippet ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_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 SnippetApi.create_snippet"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling SnippetApi.create_snippet"
  end
  allowable_values = ["init", "recv", "hash", "hit", "miss", "pass", "fetch", "error", "deliver", "log", "none"]
  if @api_client.config.client_side_validation && opts[:'type'] && !allowable_values.include?(opts[:'type'])
    fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
  end
  allowable_values = ["0", "1"]
  if @api_client.config.client_side_validation && opts[:'dynamic'] && !allowable_values.include?(opts[:'dynamic'])
    fail ArgumentError, "invalid value for \"dynamic\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/snippet'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_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['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['type'] = opts[:'type'] if !opts[:'type'].nil?
  form_params['content'] = opts[:'content'] if !opts[:'content'].nil?
  form_params['priority'] = opts[:'priority'] if !opts[:'priority'].nil?
  form_params['dynamic'] = opts[:'dynamic'] if !opts[:'dynamic'].nil?

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

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

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

  new_options = opts.merge(
    :operation => :"SnippetApi.create_snippet",
    :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: SnippetApi#create_snippet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_snippet(opts = {}) ⇒ InlineResponse200

Delete a snippet Delete a specific snippet for a particular service and version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :snippet_name (String) —

    The name for the snippet. (required)

Returns:



124
125
126
127
 
# File 'lib/fastly/api/snippet_api.rb', line 124

def delete_snippet(opts = {})
  data, _status_code, _headers = delete_snippet_with_http_info(opts)
  data
end

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

Delete a snippet Delete a specific snippet for a particular service and version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :snippet_name (String) —

    The name for the snippet. (required)

Returns:

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

    InlineResponse200 data, response status code and response headers



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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/fastly/api/snippet_api.rb', line 135

def delete_snippet_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SnippetApi.delete_snippet ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  snippet_name = opts[:'snippet_name']
  # 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 SnippetApi.delete_snippet"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling SnippetApi.delete_snippet"
  end
  # verify the required parameter 'snippet_name' is set
  if @api_client.config.client_side_validation && snippet_name.nil?
    fail ArgumentError, "Missing the required parameter 'snippet_name' when calling SnippetApi.delete_snippet"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/snippet/{snippet_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'snippet_name' + '}', CGI.escape(snippet_name.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 => :"SnippetApi.delete_snippet",
    :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: SnippetApi#delete_snippet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_snippet(opts = {}) ⇒ SnippetResponse

Get a versioned snippet Get a single snippet for a particular service and version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :snippet_name (String) —

    The name for the snippet. (required)

Returns:



201
202
203
204
 
# File 'lib/fastly/api/snippet_api.rb', line 201

def get_snippet(opts = {})
  data, _status_code, _headers = get_snippet_with_http_info(opts)
  data
end

#get_snippet_dynamic(opts = {}) ⇒ SnippetResponse

Get a dynamic snippet Get a single dynamic snippet for a particular service.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :snippet_id (String) —

    Alphanumeric string identifying a VCL Snippet. (required)

Returns:



277
278
279
280
 
# File 'lib/fastly/api/snippet_api.rb', line 277

def get_snippet_dynamic(opts = {})
  data, _status_code, _headers = get_snippet_dynamic_with_http_info(opts)
  data
end

#get_snippet_dynamic_with_http_info(opts = {}) ⇒ Array<(SnippetResponse, Integer, Hash)>

Get a dynamic snippet Get a single dynamic snippet for a particular service.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :snippet_id (String) —

    Alphanumeric string identifying a VCL Snippet. (required)

Returns:

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

    SnippetResponse data, response status code and response headers



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
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/fastly/api/snippet_api.rb', line 287

def get_snippet_dynamic_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SnippetApi.get_snippet_dynamic ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  snippet_id = opts[:'snippet_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 SnippetApi.get_snippet_dynamic"
  end
  # verify the required parameter 'snippet_id' is set
  if @api_client.config.client_side_validation && snippet_id.nil?
    fail ArgumentError, "Missing the required parameter 'snippet_id' when calling SnippetApi.get_snippet_dynamic"
  end
  # resource path
  local_var_path = '/service/{service_id}/snippet/{snippet_id}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'snippet_id' + '}', CGI.escape(snippet_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'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"SnippetApi.get_snippet_dynamic",
    :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: SnippetApi#get_snippet_dynamic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_snippet_with_http_info(opts = {}) ⇒ Array<(SnippetResponse, Integer, Hash)>

Get a versioned snippet Get a single snippet for a particular service and version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :snippet_name (String) —

    The name for the snippet. (required)

Returns:

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

    SnippetResponse data, response status code and response headers



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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/fastly/api/snippet_api.rb', line 212

def get_snippet_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SnippetApi.get_snippet ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  snippet_name = opts[:'snippet_name']
  # 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 SnippetApi.get_snippet"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling SnippetApi.get_snippet"
  end
  # verify the required parameter 'snippet_name' is set
  if @api_client.config.client_side_validation && snippet_name.nil?
    fail ArgumentError, "Missing the required parameter 'snippet_name' when calling SnippetApi.get_snippet"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/snippet/{snippet_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'snippet_name' + '}', CGI.escape(snippet_name.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] || 'SnippetResponse'

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

  new_options = opts.merge(
    :operation => :"SnippetApi.get_snippet",
    :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: SnippetApi#get_snippet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_snippets(opts = {}) ⇒ Array<SnippetResponse>

List snippets List all snippets for a particular service and version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

Returns:



347
348
349
350
 
# File 'lib/fastly/api/snippet_api.rb', line 347

def list_snippets(opts = {})
  data, _status_code, _headers = list_snippets_with_http_info(opts)
  data
end

#list_snippets_with_http_info(opts = {}) ⇒ Array<(Array<SnippetResponse>, Integer, Hash)>

List snippets List all snippets for a particular service and version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

Returns:

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

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



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
 
# File 'lib/fastly/api/snippet_api.rb', line 357

def list_snippets_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SnippetApi.list_snippets ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_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 SnippetApi.list_snippets"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling SnippetApi.list_snippets"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/snippet'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_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'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"SnippetApi.list_snippets",
    :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: SnippetApi#list_snippets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_snippet(opts = {}) ⇒ SnippetResponse

Update a versioned snippet Update a specific snippet for a particular service and version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :snippet_name (String) —

    The name for the snippet. (required)

Returns:



418
419
420
421
 
# File 'lib/fastly/api/snippet_api.rb', line 418

def update_snippet(opts = {})
  data, _status_code, _headers = update_snippet_with_http_info(opts)
  data
end

#update_snippet_dynamic(opts = {}) ⇒ SnippetResponse

Update a dynamic snippet Update a dynamic snippet for a particular service.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :snippet_id (String) —

    Alphanumeric string identifying a VCL Snippet. (required)

  • :name (String) —

    The name for the snippet.

  • :type (String) —

    The location in generated VCL where the snippet should be placed.

  • :content (String) —

    The VCL code that specifies exactly what the snippet does.

  • :priority (String) —

    Priority determines execution order. Lower numbers execute first. (default to ‘100’)

  • :dynamic (String) —

    Sets the snippet version.

Returns:



504
505
506
507
 
# File 'lib/fastly/api/snippet_api.rb', line 504

def update_snippet_dynamic(opts = {})
  data, _status_code, _headers = update_snippet_dynamic_with_http_info(opts)
  data
end

#update_snippet_dynamic_with_http_info(opts = {}) ⇒ Array<(SnippetResponse, Integer, Hash)>

Update a dynamic snippet Update a dynamic snippet for a particular service.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :snippet_id (String) —

    Alphanumeric string identifying a VCL Snippet. (required)

  • :name (String) —

    The name for the snippet.

  • :type (String) —

    The location in generated VCL where the snippet should be placed.

  • :content (String) —

    The VCL code that specifies exactly what the snippet does.

  • :priority (String) —

    Priority determines execution order. Lower numbers execute first. (default to ‘100’)

  • :dynamic (String) —

    Sets the snippet version.

Returns:

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

    SnippetResponse data, response status code and response headers



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
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
 
# File 'lib/fastly/api/snippet_api.rb', line 519

def update_snippet_dynamic_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SnippetApi.update_snippet_dynamic ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  snippet_id = opts[:'snippet_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 SnippetApi.update_snippet_dynamic"
  end
  # verify the required parameter 'snippet_id' is set
  if @api_client.config.client_side_validation && snippet_id.nil?
    fail ArgumentError, "Missing the required parameter 'snippet_id' when calling SnippetApi.update_snippet_dynamic"
  end
  allowable_values = ["init", "recv", "hash", "hit", "miss", "pass", "fetch", "error", "deliver", "log", "none"]
  if @api_client.config.client_side_validation && opts[:'type'] && !allowable_values.include?(opts[:'type'])
    fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
  end
  allowable_values = ["0", "1"]
  if @api_client.config.client_side_validation && opts[:'dynamic'] && !allowable_values.include?(opts[:'dynamic'])
    fail ArgumentError, "invalid value for \"dynamic\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/service/{service_id}/snippet/{snippet_id}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'snippet_id' + '}', CGI.escape(snippet_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['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['type'] = opts[:'type'] if !opts[:'type'].nil?
  form_params['content'] = opts[:'content'] if !opts[:'content'].nil?
  form_params['priority'] = opts[:'priority'] if !opts[:'priority'].nil?
  form_params['dynamic'] = opts[:'dynamic'] if !opts[:'dynamic'].nil?

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

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

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

  new_options = opts.merge(
    :operation => :"SnippetApi.update_snippet_dynamic",
    :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: SnippetApi#update_snippet_dynamic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_snippet_with_http_info(opts = {}) ⇒ Array<(SnippetResponse, Integer, Hash)>

Update a versioned snippet Update a specific snippet for a particular service and version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :snippet_name (String) —

    The name for the snippet. (required)

Returns:

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

    SnippetResponse data, response status code and response headers



429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
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
 
# File 'lib/fastly/api/snippet_api.rb', line 429

def update_snippet_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SnippetApi.update_snippet ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  snippet_name = opts[:'snippet_name']
  # 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 SnippetApi.update_snippet"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling SnippetApi.update_snippet"
  end
  # verify the required parameter 'snippet_name' is set
  if @api_client.config.client_side_validation && snippet_name.nil?
    fail ArgumentError, "Missing the required parameter 'snippet_name' when calling SnippetApi.update_snippet"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/snippet/{snippet_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'snippet_name' + '}', CGI.escape(snippet_name.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] || {}

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

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

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

  new_options = opts.merge(
    :operation => :"SnippetApi.update_snippet",
    :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: SnippetApi#update_snippet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end