Class: PureCloud::LocationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/api/locations_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LocationsApi

Returns a new instance of LocationsApi.



23
24
25
 
# File 'lib/purecloud/api/locations_api.rb', line 23

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



21
22
23
 
# File 'lib/purecloud/api/locations_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#get_location_id(location_id, opts = {}) ⇒ Location

Get Location by ID.

Parameters:

  • location_id —

    Location ID

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

    the optional parameters

Returns:



32
33
34
35
 
# File 'lib/purecloud/api/locations_api.rb', line 32

def get_location_id(location_id, opts = {})
  data, status_code, headers = get_location_id_with_http_info(location_id, opts)
  return data
end

#get_location_id_with_http_info(location_id, opts = {}) ⇒ Array<(Location, Fixnum, Hash)>

Get Location by ID.

Parameters:

  • location_id —

    Location ID

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

    the optional parameters

Returns:

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

    Location data, response status code and response headers



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
82
83
84
85
 
# File 'lib/purecloud/api/locations_api.rb', line 42

def get_location_id_with_http_info(location_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LocationsApi#get_location_id ..."
  end
  
  # verify the required parameter 'location_id' is set
  fail "Missing the required parameter 'location_id' when calling get_location_id" if location_id.nil?
  
  # resource path
  local_var_path = "/api/v2/locations/{locationId}".sub('{format}','json').sub('{' + 'locationId' + '}', location_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'Location')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LocationsApi#get_location_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_locations(opts = {}) ⇒ LocationEntityListing

Get the list of locations.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :state (String) —

    Location state (default to ACTIVE)

  • :name (String) —

    Location name

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

Returns:



95
96
97
98
 
# File 'lib/purecloud/api/locations_api.rb', line 95

def get_locations(opts = {})
  data, status_code, headers = get_locations_with_http_info(opts)
  return data
end

#get_locations_with_http_info(opts = {}) ⇒ Array<(LocationEntityListing, Fixnum, Hash)>

Get the list of locations.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :state (String) —

    Location state

  • :name (String) —

    Location name

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:

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

    LocationEntityListing data, response status code and response headers



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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/purecloud/api/locations_api.rb', line 108

def get_locations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LocationsApi#get_locations ..."
  end
  
  if opts[:'state'] && !['ACTIVE', 'DELETED'].include?(opts[:'state'])
    fail 'invalid value for "state", must be one of ACTIVE, DELETED'
  end
  
  # resource path
  local_var_path = "/api/v2/locations".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'state'] = opts[:'state'] if opts[:'state']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'LocationEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LocationsApi#get_locations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end