Class: Fastly::ServiceAuthorizationsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ServiceAuthorizationsApi

Returns a new instance of ServiceAuthorizationsApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_service_authorization(opts = {}) ⇒ ServiceAuthorizationResponse

Create service authorization Create service authorization.

Parameters:

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

    a customizable set of options

Options Hash (opts):

Returns:



24
25
26
27
 
# File 'lib/fastly/api/service_authorizations_api.rb', line 24

def create_service_authorization(opts = {})
  data, _status_code, _headers = create_service_authorization_with_http_info(opts)
  data
end

#create_service_authorization_with_http_info(opts = {}) ⇒ Array<(ServiceAuthorizationResponse, Integer, Hash)>

Create service authorization Create service authorization.

Parameters:

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

    a customizable set of options

Options Hash (opts):

Returns:



33
34
35
36
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
 
# File 'lib/fastly/api/service_authorizations_api.rb', line 33

def create_service_authorization_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceAuthorizationsApi.create_service_authorization ...'
  end
  # unbox the parameters from the hash
  # resource path
  local_var_path = '/service-authorizations'

  # 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/vnd.api+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/vnd.api+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[:'service_authorization'])

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

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

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

#delete_service_authorization(opts = {}) ⇒ nil

Delete service authorization Delete service authorization.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_authorization_id (String) —

    Alphanumeric string identifying a service authorization. (required)

Returns:

  • (nil) 


87
88
89
90
 
# File 'lib/fastly/api/service_authorizations_api.rb', line 87

def delete_service_authorization(opts = {})
  delete_service_authorization_with_http_info(opts)
  nil
end

#delete_service_authorization_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete service authorization Delete service authorization.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_authorization_id (String) —

    Alphanumeric string identifying a service authorization. (required)

Returns:

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

    nil, response status code and response headers



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

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

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

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#list_service_authorization(opts = {}) ⇒ ServiceAuthorizationsResponse

List service authorizations List service authorizations.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :page_number (Integer) —

    Current page.

  • :page_size (Integer) —

    Number of records per page. (default to 20)

Returns:



149
150
151
152
 
# File 'lib/fastly/api/service_authorizations_api.rb', line 149

def list_service_authorization(opts = {})
  data, _status_code, _headers = list_service_authorization_with_http_info(opts)
  data
end

#list_service_authorization_with_http_info(opts = {}) ⇒ Array<(ServiceAuthorizationsResponse, Integer, Hash)>

List service authorizations List service authorizations.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :page_number (Integer) —

    Current page.

  • :page_size (Integer) —

    Number of records per page. (default to 20)

Returns:



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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/fastly/api/service_authorizations_api.rb', line 159

def list_service_authorization_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceAuthorizationsApi.list_service_authorization ...'
  end
  # unbox the parameters from the hash
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ServiceAuthorizationsApi.list_service_authorization, must be smaller than or equal to 100.'
  end

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

  # resource path
  local_var_path = '/service-authorizations'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?

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

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

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

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

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

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

#show_service_authorization(opts = {}) ⇒ ServiceAuthorizationResponse

Show service authorization Show service authorization.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_authorization_id (String) —

    Alphanumeric string identifying a service authorization. (required)

Returns:



218
219
220
221
 
# File 'lib/fastly/api/service_authorizations_api.rb', line 218

def show_service_authorization(opts = {})
  data, _status_code, _headers = show_service_authorization_with_http_info(opts)
  data
end

#show_service_authorization_with_http_info(opts = {}) ⇒ Array<(ServiceAuthorizationResponse, Integer, Hash)>

Show service authorization Show service authorization.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_authorization_id (String) —

    Alphanumeric string identifying a service authorization. (required)

Returns:



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
271
272
273
274
275
 
# File 'lib/fastly/api/service_authorizations_api.rb', line 227

def show_service_authorization_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceAuthorizationsApi.show_service_authorization ...'
  end
  # unbox the parameters from the hash
  service_authorization_id = opts[:'service_authorization_id']
  # verify the required parameter 'service_authorization_id' is set
  if @api_client.config.client_side_validation && service_authorization_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_authorization_id' when calling ServiceAuthorizationsApi.show_service_authorization"
  end
  # resource path
  local_var_path = '/service-authorizations/{service_authorization_id}'.sub('{' + 'service_authorization_id' + '}', CGI.escape(service_authorization_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/vnd.api+json'])

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

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

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

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

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

#update_service_authorization(opts = {}) ⇒ ServiceAuthorizationResponse

Update service authorization Update service authorization.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_authorization_id (String) —

    Alphanumeric string identifying a service authorization. (required)

  • :service_authorization (ServiceAuthorization)

Returns:



282
283
284
285
 
# File 'lib/fastly/api/service_authorizations_api.rb', line 282

def update_service_authorization(opts = {})
  data, _status_code, _headers = update_service_authorization_with_http_info(opts)
  data
end

#update_service_authorization_with_http_info(opts = {}) ⇒ Array<(ServiceAuthorizationResponse, Integer, Hash)>

Update service authorization Update service authorization.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_authorization_id (String) —

    Alphanumeric string identifying a service authorization. (required)

  • :service_authorization (ServiceAuthorization)

Returns:



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
341
342
343
344
345
 
# File 'lib/fastly/api/service_authorizations_api.rb', line 292

def update_service_authorization_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceAuthorizationsApi.update_service_authorization ...'
  end
  # unbox the parameters from the hash
  service_authorization_id = opts[:'service_authorization_id']
  # verify the required parameter 'service_authorization_id' is set
  if @api_client.config.client_side_validation && service_authorization_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_authorization_id' when calling ServiceAuthorizationsApi.update_service_authorization"
  end
  # resource path
  local_var_path = '/service-authorizations/{service_authorization_id}'.sub('{' + 'service_authorization_id' + '}', CGI.escape(service_authorization_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/vnd.api+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[:'service_authorization'])

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

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

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