class Fastly::IamServiceGroupsApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/fastly/api/iam_service_groups_api.rb, line 17
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

add_service_group_services(opts = {}) click to toggle source

Add services in a service group Add services in a service group. @option opts [String] :service_group_id Alphanumeric string identifying the service group. (required) @option opts [Hash<String, Object>] :request_body @return [Object]

# File lib/fastly/api/iam_service_groups_api.rb, line 25
def add_service_group_services(opts = {})
  data, _status_code, _headers = add_service_group_services_with_http_info(opts)
  data
end
add_service_group_services_with_http_info(opts = {}) click to toggle source

Add services in a service group Add services in a service group. @option opts [String] :service_group_id Alphanumeric string identifying the service group. (required) @option opts [Hash<String, Object>] :request_body @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers

# File lib/fastly/api/iam_service_groups_api.rb, line 35
def add_service_group_services_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IamServiceGroupsApi.add_service_group_services ...'
  end
  # unbox the parameters from the hash
  service_group_id = opts[:'service_group_id']
  # verify the required parameter 'service_group_id' is set
  if @api_client.config.client_side_validation && service_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_group_id' when calling IamServiceGroupsApi.add_service_group_services"
  end
  # resource path
  local_var_path = '/service-groups/{service_group_id}/services'.sub('{' + 'service_group_id' + '}', CGI.escape(service_group_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[:'request_body'])

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

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

  new_options = opts.merge(
    :operation => :"IamServiceGroupsApi.add_service_group_services",
    :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: IamServiceGroupsApi#add_service_group_services\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
create_a_service_group(opts = {}) click to toggle source

Create a service group Create a service group. @option opts [Hash<String, Object>] :request_body @return [Object]

# File lib/fastly/api/iam_service_groups_api.rb, line 94
def create_a_service_group(opts = {})
  data, _status_code, _headers = create_a_service_group_with_http_info(opts)
  data
end
create_a_service_group_with_http_info(opts = {}) click to toggle source

Create a service group Create a service group. @option opts [Hash<String, Object>] :request_body @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers

# File lib/fastly/api/iam_service_groups_api.rb, line 103
def create_a_service_group_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IamServiceGroupsApi.create_a_service_group ...'
  end
  # unbox the parameters from the hash
  # resource path
  local_var_path = '/service-groups'

  # 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[:'request_body'])

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

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

  new_options = opts.merge(
    :operation => :"IamServiceGroupsApi.create_a_service_group",
    :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: IamServiceGroupsApi#create_a_service_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_a_service_group(opts = {}) click to toggle source

Delete a service group Delete a service group. @option opts [String] :service_group_id Alphanumeric string identifying the service group. (required) @return [nil]

# File lib/fastly/api/iam_service_groups_api.rb, line 157
def delete_a_service_group(opts = {})
  delete_a_service_group_with_http_info(opts)
  nil
end
delete_a_service_group_with_http_info(opts = {}) click to toggle source

Delete a service group Delete a service group. @option opts [String] :service_group_id Alphanumeric string identifying the service group. (required) @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/fastly/api/iam_service_groups_api.rb, line 166
def delete_a_service_group_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IamServiceGroupsApi.delete_a_service_group ...'
  end
  # unbox the parameters from the hash
  service_group_id = opts[:'service_group_id']
  # verify the required parameter 'service_group_id' is set
  if @api_client.config.client_side_validation && service_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_group_id' when calling IamServiceGroupsApi.delete_a_service_group"
  end
  # resource path
  local_var_path = '/service-groups/{service_group_id}'.sub('{' + 'service_group_id' + '}', CGI.escape(service_group_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 => :"IamServiceGroupsApi.delete_a_service_group",
    :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: IamServiceGroupsApi#delete_a_service_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_a_service_group(opts = {}) click to toggle source

Get a service group Get a service group. @option opts [String] :service_group_id Alphanumeric string identifying the service group. (required) @return [Object]

# File lib/fastly/api/iam_service_groups_api.rb, line 218
def get_a_service_group(opts = {})
  data, _status_code, _headers = get_a_service_group_with_http_info(opts)
  data
end
get_a_service_group_with_http_info(opts = {}) click to toggle source

Get a service group Get a service group. @option opts [String] :service_group_id Alphanumeric string identifying the service group. (required) @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers

# File lib/fastly/api/iam_service_groups_api.rb, line 227
def get_a_service_group_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IamServiceGroupsApi.get_a_service_group ...'
  end
  # unbox the parameters from the hash
  service_group_id = opts[:'service_group_id']
  # verify the required parameter 'service_group_id' is set
  if @api_client.config.client_side_validation && service_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_group_id' when calling IamServiceGroupsApi.get_a_service_group"
  end
  # resource path
  local_var_path = '/service-groups/{service_group_id}'.sub('{' + 'service_group_id' + '}', CGI.escape(service_group_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] || 'Object'

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

  new_options = opts.merge(
    :operation => :"IamServiceGroupsApi.get_a_service_group",
    :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: IamServiceGroupsApi#get_a_service_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list_service_group_services(opts = {}) click to toggle source

List services to a service group List services to a service group. @option opts [String] :service_group_id Alphanumeric string identifying the service group. (required) @option opts [Integer] :per_page Number of records per page. (default to 20) @option opts [Integer] :page Current page. @return [Object]

# File lib/fastly/api/iam_service_groups_api.rb, line 283
def list_service_group_services(opts = {})
  data, _status_code, _headers = list_service_group_services_with_http_info(opts)
  data
end
list_service_group_services_with_http_info(opts = {}) click to toggle source

List services to a service group List services to a service group. @option opts [String] :service_group_id Alphanumeric string identifying the service group. (required) @option opts [Integer] :per_page Number of records per page. (default to 20) @option opts [Integer] :page Current page. @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers

# File lib/fastly/api/iam_service_groups_api.rb, line 294
def list_service_group_services_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IamServiceGroupsApi.list_service_group_services ...'
  end
  # unbox the parameters from the hash
  service_group_id = opts[:'service_group_id']
  # verify the required parameter 'service_group_id' is set
  if @api_client.config.client_side_validation && service_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_group_id' when calling IamServiceGroupsApi.list_service_group_services"
  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 IamServiceGroupsApi.list_service_group_services, 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 IamServiceGroupsApi.list_service_group_services, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/service-groups/{service_group_id}/services'.sub('{' + 'service_group_id' + '}', CGI.escape(service_group_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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] || 'Object'

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

  new_options = opts.merge(
    :operation => :"IamServiceGroupsApi.list_service_group_services",
    :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: IamServiceGroupsApi#list_service_group_services\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list_service_groups(opts = {}) click to toggle source

List service groups List all service groups. @option opts [Integer] :per_page Number of records per page. (default to 20) @option opts [Integer] :page Current page. @return [Object]

# File lib/fastly/api/iam_service_groups_api.rb, line 359
def list_service_groups(opts = {})
  data, _status_code, _headers = list_service_groups_with_http_info(opts)
  data
end
list_service_groups_with_http_info(opts = {}) click to toggle source

List service groups List all service groups. @option opts [Integer] :per_page Number of records per page. (default to 20) @option opts [Integer] :page Current page. @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers

# File lib/fastly/api/iam_service_groups_api.rb, line 369
def list_service_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IamServiceGroupsApi.list_service_groups ...'
  end
  # unbox the parameters from the hash
  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 IamServiceGroupsApi.list_service_groups, 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 IamServiceGroupsApi.list_service_groups, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/service-groups'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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] || 'Object'

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

  new_options = opts.merge(
    :operation => :"IamServiceGroupsApi.list_service_groups",
    :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: IamServiceGroupsApi#list_service_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
remove_service_group_services(opts = {}) click to toggle source

Remove services from a service group Remove services from a service group. @option opts [String] :service_group_id Alphanumeric string identifying the service group. (required) @option opts [Hash<String, Object>] :request_body @return [nil]

# File lib/fastly/api/iam_service_groups_api.rb, line 429
def remove_service_group_services(opts = {})
  remove_service_group_services_with_http_info(opts)
  nil
end
remove_service_group_services_with_http_info(opts = {}) click to toggle source

Remove services from a service group Remove services from a service group. @option opts [String] :service_group_id Alphanumeric string identifying the service group. (required) @option opts [Hash<String, Object>] :request_body @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/fastly/api/iam_service_groups_api.rb, line 439
def remove_service_group_services_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IamServiceGroupsApi.remove_service_group_services ...'
  end
  # unbox the parameters from the hash
  service_group_id = opts[:'service_group_id']
  # verify the required parameter 'service_group_id' is set
  if @api_client.config.client_side_validation && service_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_group_id' when calling IamServiceGroupsApi.remove_service_group_services"
  end
  # resource path
  local_var_path = '/service-groups/{service_group_id}/services'.sub('{' + 'service_group_id' + '}', CGI.escape(service_group_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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[:'request_body'])

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"IamServiceGroupsApi.remove_service_group_services",
    :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: IamServiceGroupsApi#remove_service_group_services\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update_a_service_group(opts = {}) click to toggle source

Update a service group Update a service group. @option opts [String] :service_group_id Alphanumeric string identifying the service group. (required) @option opts [Hash<String, Object>] :request_body @return [Object]

# File lib/fastly/api/iam_service_groups_api.rb, line 497
def update_a_service_group(opts = {})
  data, _status_code, _headers = update_a_service_group_with_http_info(opts)
  data
end
update_a_service_group_with_http_info(opts = {}) click to toggle source

Update a service group Update a service group. @option opts [String] :service_group_id Alphanumeric string identifying the service group. (required) @option opts [Hash<String, Object>] :request_body @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers

# File lib/fastly/api/iam_service_groups_api.rb, line 507
def update_a_service_group_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IamServiceGroupsApi.update_a_service_group ...'
  end
  # unbox the parameters from the hash
  service_group_id = opts[:'service_group_id']
  # verify the required parameter 'service_group_id' is set
  if @api_client.config.client_side_validation && service_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_group_id' when calling IamServiceGroupsApi.update_a_service_group"
  end
  # resource path
  local_var_path = '/service-groups/{service_group_id}'.sub('{' + 'service_group_id' + '}', CGI.escape(service_group_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[:'request_body'])

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

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

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