class Bfwd::ProfilesApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

get_all_profiles(opts = {}) click to toggle source

Returns a collection of all profiles. By default 10 values are returned. Records are returned in natural order {"nickname":"Get all profiles","response":"getProfileAll.html"} @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organizations used to restrict the scope of API calls. @option opts [Integer] :offset The offset from the first profile to return. (default to 0) @option opts [Integer] :records The maximum number of profiles to return. (default to 10) @option opts [String] :order_by Specify a field used to order the result set. (default to created) @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. (default to DESC) @return [ProfilePagedMetadata]

# File lib/bf_ruby2/api/profiles_api.rb, line 32
def get_all_profiles(opts = {})
  data, _status_code, _headers = get_all_profiles_with_http_info(opts)
  return data
end
get_all_profiles_with_http_info(opts = {}) click to toggle source

Returns a collection of all profiles. By default 10 values are returned. Records are returned in natural order {&quot;nickname&quot;:&quot;Get all profiles&quot;,&quot;response&quot;:&quot;getProfileAll.html&quot;} @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organizations used to restrict the scope of API calls. @option opts [Integer] :offset The offset from the first profile to return. @option opts [Integer] :records The maximum number of profiles to return. @option opts [String] :order_by Specify a field used to order the result set. @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. @return [Array<(ProfilePagedMetadata, Fixnum, Hash)>] ProfilePagedMetadata data, response status code and response headers

# File lib/bf_ruby2/api/profiles_api.rb, line 46
def get_all_profiles_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ProfilesApi.get_all_profiles ..."
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/profiles"

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ProfilePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProfilesApi#get_all_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_profile(profile_id, opts = {}) click to toggle source

Returns a single profile, specified by the ID parameter. {"nickname":"Retrieve an existing profile","response":"getProfileByID.html"} @param profile_id ID of the Profile. @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls. @return [ProfilePagedMetadata]

# File lib/bf_ruby2/api/profiles_api.rb, line 94
def get_profile(profile_id, opts = {})
  data, _status_code, _headers = get_profile_with_http_info(profile_id, opts)
  return data
end
get_profile_by_account_id(account_id, opts = {}) click to toggle source

Returns a collection of profiles, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order {"nickname":"Retrieve by account","response":"getProfileByAccountID.html"} @param account_id The account-ID of the profile. @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organizations used to restrict the scope of API calls. @option opts [Integer] :offset The offset from the first profile to return. (default to 0) @option opts [Integer] :records The maximum number of profiles to return. (default to 10) @option opts [String] :order_by Specify a field used to order the result set. (default to created) @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. (default to DESC) @return [ProfilePagedMetadata]

# File lib/bf_ruby2/api/profiles_api.rb, line 156
def get_profile_by_account_id(account_id, opts = {})
  data, _status_code, _headers = get_profile_by_account_id_with_http_info(account_id, opts)
  return data
end
get_profile_by_account_id_with_http_info(account_id, opts = {}) click to toggle source

Returns a collection of profiles, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order {&quot;nickname&quot;:&quot;Retrieve by account&quot;,&quot;response&quot;:&quot;getProfileByAccountID.html&quot;} @param account_id The account-ID of the profile. @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organizations used to restrict the scope of API calls. @option opts [Integer] :offset The offset from the first profile to return. @option opts [Integer] :records The maximum number of profiles to return. @option opts [String] :order_by Specify a field used to order the result set. @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. @return [Array<(ProfilePagedMetadata, Fixnum, Hash)>] ProfilePagedMetadata data, response status code and response headers

# File lib/bf_ruby2/api/profiles_api.rb, line 171
def get_profile_by_account_id_with_http_info(account_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ProfilesApi.get_profile_by_account_id ..."
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && account_id.nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling ProfilesApi.get_profile_by_account_id"
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/profiles/account/{account-ID}".sub('{' + 'account-ID' + '}', account_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ProfilePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProfilesApi#get_profile_by_account_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_profile_by_email_address(email, opts = {}) click to toggle source

Returns a single profile, specified by the email parameter. {"nickname":"Retrieve by e-mail","response":"getProfileByEmail.html"} @param email The email address of the profile. @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organizations used to restrict the scope of API calls. @option opts [Integer] :offset The offset from the first profile to return. (default to 0) @option opts [Integer] :records The maximum number of profiles to return. (default to 10) @option opts [String] :order_by Specify a field used to order the result set. (default to created) @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. (default to DESC) @option opts [BOOLEAN] :include_retired Whether retired profiles should be returned. (default to false) @return [ProfilePagedMetadata]

# File lib/bf_ruby2/api/profiles_api.rb, line 230
def get_profile_by_email_address(email, opts = {})
  data, _status_code, _headers = get_profile_by_email_address_with_http_info(email, opts)
  return data
end
get_profile_by_email_address_with_http_info(email, opts = {}) click to toggle source

Returns a single profile, specified by the email parameter. {&quot;nickname&quot;:&quot;Retrieve by e-mail&quot;,&quot;response&quot;:&quot;getProfileByEmail.html&quot;} @param email The email address of the profile. @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organizations used to restrict the scope of API calls. @option opts [Integer] :offset The offset from the first profile to return. @option opts [Integer] :records The maximum number of profiles to return. @option opts [String] :order_by Specify a field used to order the result set. @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. @option opts [BOOLEAN] :include_retired Whether retired profiles should be returned. @return [Array<(ProfilePagedMetadata, Fixnum, Hash)>] ProfilePagedMetadata data, response status code and response headers

# File lib/bf_ruby2/api/profiles_api.rb, line 246
def get_profile_by_email_address_with_http_info(email, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ProfilesApi.get_profile_by_email_address ..."
  end
  # verify the required parameter 'email' is set
  if @api_client.config.client_side_validation && email.nil?
    fail ArgumentError, "Missing the required parameter 'email' when calling ProfilesApi.get_profile_by_email_address"
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/profiles/email/{email}".sub('{' + 'email' + '}', email.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ProfilePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProfilesApi#get_profile_by_email_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_profile_with_http_info(profile_id, opts = {}) click to toggle source

Returns a single profile, specified by the ID parameter. {&quot;nickname&quot;:&quot;Retrieve an existing profile&quot;,&quot;response&quot;:&quot;getProfileByID.html&quot;} @param profile_id ID of the Profile. @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls. @return [Array<(ProfilePagedMetadata, Fixnum, Hash)>] ProfilePagedMetadata data, response status code and response headers

# File lib/bf_ruby2/api/profiles_api.rb, line 105
def get_profile_with_http_info(profile_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ProfilesApi.get_profile ..."
  end
  # verify the required parameter 'profile_id' is set
  if @api_client.config.client_side_validation && profile_id.nil?
    fail ArgumentError, "Missing the required parameter 'profile_id' when calling ProfilesApi.get_profile"
  end
  # resource path
  local_var_path = "/profiles/{profile-ID}".sub('{' + 'profile-ID' + '}', profile_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ProfilePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProfilesApi#get_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update_profile(request, opts = {}) click to toggle source

Update a profile {"nickname":"Update a profile","request":"updateProfileRequest.html","response":"updateProfileResponse.html"} @param request The profile object to be updated. @param [Hash] opts the optional parameters @return [ProfilePagedMetadata]

# File lib/bf_ruby2/api/profiles_api.rb, line 300
def update_profile(request, opts = {})
  data, _status_code, _headers = update_profile_with_http_info(request, opts)
  return data
end
update_profile_with_http_info(request, opts = {}) click to toggle source

Update a profile {&quot;nickname&quot;:&quot;Update a profile&quot;,&quot;request&quot;:&quot;updateProfileRequest.html&quot;,&quot;response&quot;:&quot;updateProfileResponse.html&quot;} @param request The profile object to be updated. @param [Hash] opts the optional parameters @return [Array<(ProfilePagedMetadata, Fixnum, Hash)>] ProfilePagedMetadata data, response status code and response headers

# File lib/bf_ruby2/api/profiles_api.rb, line 310
def update_profile_with_http_info(request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ProfilesApi.update_profile ..."
  end
  # verify the required parameter 'request' is set
  if @api_client.config.client_side_validation && request.nil?
    fail ArgumentError, "Missing the required parameter 'request' when calling ProfilesApi.update_profile"
  end
  # resource path
  local_var_path = "/profiles"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request)
  auth_names = []
  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,
    :return_type => 'ProfilePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProfilesApi#update_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end