Class: PureCloud::StationsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ StationsApi

Returns a new instance of StationsApi.



23
24
25
 
# File 'lib/purecloud/api/stations_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/stations_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#delete_station_id_associateduser(station_id, opts = {}) ⇒ String

Unassigns the user assigned to this station

Parameters:

  • station_id —

    Station ID

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

    the optional parameters

Returns:

  • (String) 


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

def delete_station_id_associateduser(station_id, opts = {})
  data, status_code, headers = delete_station_id_associateduser_with_http_info(station_id, opts)
  return data
end

#delete_station_id_associateduser_with_http_info(station_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Unassigns the user assigned to this station

Parameters:

  • station_id —

    Station ID

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

    the optional parameters

Returns:

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

    String 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/stations_api.rb', line 42

def delete_station_id_associateduser_with_http_info(station_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: StationsApi#delete_station_id_associateduser ..."
  end
  
  # verify the required parameter 'station_id' is set
  fail "Missing the required parameter 'station_id' when calling delete_station_id_associateduser" if station_id.nil?
  
  # resource path
  local_var_path = "/api/v2/stations/{stationId}/associateduser".sub('{format}','json').sub('{' + 'stationId' + '}', station_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(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StationsApi#delete_station_id_associateduser\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_station_id(station_id, opts = {}) ⇒ Station

Get station.

Parameters:

  • station_id —

    Station ID

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

    the optional parameters

Returns:



92
93
94
95
 
# File 'lib/purecloud/api/stations_api.rb', line 92

def get_station_id(station_id, opts = {})
  data, status_code, headers = get_station_id_with_http_info(station_id, opts)
  return data
end

#get_station_id_with_http_info(station_id, opts = {}) ⇒ Array<(Station, Fixnum, Hash)>

Get station.

Parameters:

  • station_id —

    Station ID

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

    the optional parameters

Returns:

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

    Station data, response status code and response headers



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
143
144
145
 
# File 'lib/purecloud/api/stations_api.rb', line 102

def get_station_id_with_http_info(station_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: StationsApi#get_station_id ..."
  end
  
  # verify the required parameter 'station_id' is set
  fail "Missing the required parameter 'station_id' when calling get_station_id" if station_id.nil?
  
  # resource path
  local_var_path = "/api/v2/stations/{stationId}".sub('{format}','json').sub('{' + 'stationId' + '}', station_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 => 'Station')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StationsApi#get_station_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_stations(opts = {}) ⇒ StationEntityListing

Get the list of available stations.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :sort_by (String) —

    Sort by (default to name)

  • :name (String) —

    Name

  • :id (String) —

    Comma separated list of stationIds

  • :line_appearance_id (String) —

    lineAppearanceId

Returns:



157
158
159
160
 
# File 'lib/purecloud/api/stations_api.rb', line 157

def get_stations(opts = {})
  data, status_code, headers = get_stations_with_http_info(opts)
  return data
end

#get_stations_with_http_info(opts = {}) ⇒ Array<(StationEntityListing, Fixnum, Hash)>

Get the list of available stations.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :sort_by (String) —

    Sort by

  • :name (String) —

    Name

  • :id (String) —

    Comma separated list of stationIds

  • :line_appearance_id (String) —

    lineAppearanceId

Returns:

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

    StationEntityListing data, response status code and response headers



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
213
214
215
216
217
218
 
# File 'lib/purecloud/api/stations_api.rb', line 172

def get_stations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: StationsApi#get_stations ..."
  end
  
  # resource path
  local_var_path = "/api/v2/stations".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'id'] = opts[:'id'] if opts[:'id']
  query_params[:'lineAppearanceId'] = opts[:'line_appearance_id'] if opts[:'line_appearance_id']

  # 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 => 'StationEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StationsApi#get_stations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end