Class: VericredClient::CarrierGroupsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/vericred_client/api/carrier_groups_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CarrierGroupsApi

Returns a new instance of CarrierGroupsApi.



990
991
992
 
# File 'lib/vericred_client/api/carrier_groups_api.rb', line 990

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



988
989
990
 
# File 'lib/vericred_client/api/carrier_groups_api.rb', line 988

def api_client
  @api_client
end

Instance Method Details

#delete_carrier_group(vericred_id, opts = {}) ⇒ nil

Delete a CarrierGroup. Delete a CarrierGroup from the database.

Parameters:

  • vericred_id —

    The unique Vericred id

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

    the optional parameters

Returns:

  • (nil) 


999
1000
1001
1002
 
# File 'lib/vericred_client/api/carrier_groups_api.rb', line 999

def delete_carrier_group(vericred_id, opts = {})
  delete_carrier_group_with_http_info(vericred_id, opts)
  return nil
end

#delete_carrier_group_with_http_info(vericred_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a CarrierGroup. Delete a CarrierGroup from the database.

Parameters:

  • vericred_id —

    The unique Vericred id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
 
# File 'lib/vericred_client/api/carrier_groups_api.rb', line 1009

def delete_carrier_group_with_http_info(vericred_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CarrierGroupsApi.delete_carrier_group ..."
  end
  # verify the required parameter 'vericred_id' is set
  fail ArgumentError, "Missing the required parameter 'vericred_id' when calling CarrierGroupsApi.delete_carrier_group" if vericred_id.nil?
  # resource path
  local_var_path = "/carrier_groups/{vericred_id}".sub('{format}','json').sub('{' + 'vericred_id' + '}', vericred_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['Vericred-Api-Key']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CarrierGroupsApi#delete_carrier_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_carrier_group(vericred_id, body, opts = {}) ⇒ nil

Create/update a CarrierGroup Add or update a CarrierGroup to the database.

Parameters:

  • vericred_id —

    The unique Vericred id

  • body —

    CarrierGroup Record

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

    the optional parameters

Returns:

  • (nil) 


1056
1057
1058
1059
 
# File 'lib/vericred_client/api/carrier_groups_api.rb', line 1056

def put_carrier_group(vericred_id, body, opts = {})
  put_carrier_group_with_http_info(vericred_id, body, opts)
  return nil
end

#put_carrier_group_with_http_info(vericred_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Create/update a CarrierGroup Add or update a CarrierGroup to the database.

Parameters:

  • vericred_id —

    The unique Vericred id

  • body —

    CarrierGroup Record

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
 
# File 'lib/vericred_client/api/carrier_groups_api.rb', line 1067

def put_carrier_group_with_http_info(vericred_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CarrierGroupsApi.put_carrier_group ..."
  end
  # verify the required parameter 'vericred_id' is set
  fail ArgumentError, "Missing the required parameter 'vericred_id' when calling CarrierGroupsApi.put_carrier_group" if vericred_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling CarrierGroupsApi.put_carrier_group" if body.nil?
  # resource path
  local_var_path = "/carrier_groups/{vericred_id}".sub('{format}','json').sub('{' + 'vericred_id' + '}', vericred_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['Vericred-Api-Key']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CarrierGroupsApi#put_carrier_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end