Class: RelationClient::MessageBoxApi

Inherits:
Object
  • Object
show all
Defined in:
lib/relation_client/api/message_box_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MessageBoxApi 



19
20
21
 
# File 'lib/relation_client/api/message_box_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/relation_client/api/message_box_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#message_box_id_customers_post(message_box_id, opts = {}) ⇒ Customer

登録



26
27
28
29
 
# File 'lib/relation_client/api/message_box_api.rb', line 26

def message_box_id_customers_post(message_box_id, opts = {})
  data, _status_code, _headers = message_box_id_customers_post_with_http_info(message_box_id, opts)
  data
end

#message_box_id_customers_post_with_http_info(message_box_id, opts = {}) ⇒ Array<(Customer, Integer, Hash)>

登録



35
36
37
38
39
40
41
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/relation_client/api/message_box_api.rb', line 35

def message_box_id_customers_post_with_http_info(message_box_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MessageBoxApi.message_box_id_customers_post ...'
  end
  # verify the required parameter 'message_box_id' is set
  if @api_client.config.client_side_validation && message_box_id.nil?
    fail ArgumentError, "Missing the required parameter 'message_box_id' when calling MessageBoxApi.message_box_id_customers_post"
  end
  if @api_client.config.client_side_validation && message_box_id < 1
    fail ArgumentError, 'invalid value for "message_box_id" when calling MessageBoxApi.message_box_id_customers_post, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/{message_box_id}/customers'.sub('{' + 'message_box_id' + '}', CGI.escape(message_box_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] || 'Customer'

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

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

#message_box_id_records_post(message_box_id, subject, operated_at, operator, duration, body, opts = {}) ⇒ Record

応答メモ作成

Options Hash (opts):

  • :ticket_id (Integer) —

    チケットID

  • :status_cd (String) —

    ステータス

  • :customer_email (String) —

    顧客メールアドレス

  • :customer_tel (String) —

    顧客電話番号

  • :icon_cd (String) —

    対応種別

  • :is_html (Boolean)
  • :assignee (String) 


103
104
105
106
 
# File 'lib/relation_client/api/message_box_api.rb', line 103

def message_box_id_records_post(message_box_id, subject, operated_at, operator, duration, body, opts = {})
  data, _status_code, _headers = message_box_id_records_post_with_http_info(message_box_id, subject, operated_at, operator, duration, body, opts)
  data
end

#message_box_id_records_post_with_http_info(message_box_id, subject, operated_at, operator, duration, body, opts = {}) ⇒ Array<(Record, Integer, Hash)>

応答メモ作成

Options Hash (opts):

  • :ticket_id (Integer) —

    チケットID

  • :status_cd (String) —

    ステータス

  • :customer_email (String) —

    顧客メールアドレス

  • :customer_tel (String) —

    顧客電話番号

  • :icon_cd (String) —

    対応種別

  • :is_html (Boolean)
  • :assignee (String) 


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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
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
 
# File 'lib/relation_client/api/message_box_api.rb', line 124

def message_box_id_records_post_with_http_info(message_box_id, subject, operated_at, operator, duration, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MessageBoxApi.message_box_id_records_post ...'
  end
  # verify the required parameter 'message_box_id' is set
  if @api_client.config.client_side_validation && message_box_id.nil?
    fail ArgumentError, "Missing the required parameter 'message_box_id' when calling MessageBoxApi.message_box_id_records_post"
  end
  # verify the required parameter 'subject' is set
  if @api_client.config.client_side_validation && subject.nil?
    fail ArgumentError, "Missing the required parameter 'subject' when calling MessageBoxApi.message_box_id_records_post"
  end
  # verify the required parameter 'operated_at' is set
  if @api_client.config.client_side_validation && operated_at.nil?
    fail ArgumentError, "Missing the required parameter 'operated_at' when calling MessageBoxApi.message_box_id_records_post"
  end
  # verify the required parameter 'operator' is set
  if @api_client.config.client_side_validation && operator.nil?
    fail ArgumentError, "Missing the required parameter 'operator' when calling MessageBoxApi.message_box_id_records_post"
  end
  # verify the required parameter 'duration' is set
  if @api_client.config.client_side_validation && duration.nil?
    fail ArgumentError, "Missing the required parameter 'duration' when calling MessageBoxApi.message_box_id_records_post"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling MessageBoxApi.message_box_id_records_post"
  end
  allowable_values = ["open", "ongoing", "closed", "unwanted", "trash", "spam", "deleted"]
  if @api_client.config.client_side_validation && opts[:'status_cd'] && !allowable_values.include?(opts[:'status_cd'])
    fail ArgumentError, "invalid value for \"status_cd\", must be one of #{allowable_values}"
  end
  allowable_values = ["received_phone", "called_phone", "meeting", "sales", "postal", "note"]
  if @api_client.config.client_side_validation && opts[:'icon_cd'] && !allowable_values.include?(opts[:'icon_cd'])
    fail ArgumentError, "invalid value for \"icon_cd\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/{message_box_id}/records'.sub('{' + 'message_box_id' + '}', CGI.escape(message_box_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'])
  header_params[:'subject'] = subject
  header_params[:'operated_at'] = operated_at
  header_params[:'operator'] = operator
  header_params[:'duration'] = duration
  header_params[:'body'] = body
  header_params[:'ticket_id'] = opts[:'ticket_id'] if !opts[:'ticket_id'].nil?
  header_params[:'status_cd'] = opts[:'status_cd'] if !opts[:'status_cd'].nil?
  header_params[:'customer_email'] = opts[:'customer_email'] if !opts[:'customer_email'].nil?
  header_params[:'customer_tel'] = opts[:'customer_tel'] if !opts[:'customer_tel'].nil?
  header_params[:'icon_cd'] = opts[:'icon_cd'] if !opts[:'icon_cd'].nil?
  header_params[:'is_html'] = opts[:'is_html'] if !opts[:'is_html'].nil?
  header_params[:'assignee'] = opts[:'assignee'] if !opts[:'assignee'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

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

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

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

#message_boxes_get(opts = {}) ⇒ Array<MessageBox>

一覧取得



215
216
217
218
 
# File 'lib/relation_client/api/message_box_api.rb', line 215

def message_boxes_get(opts = {})
  data, _status_code, _headers = message_boxes_get_with_http_info(opts)
  data
end

#message_boxes_get_with_http_info(opts = {}) ⇒ Array<(Array<MessageBox>, Integer, Hash)>

一覧取得



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/relation_client/api/message_box_api.rb', line 223

def message_boxes_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MessageBoxApi.message_boxes_get ...'
  end
  # resource path
  local_var_path = '/message_boxes'

  # 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] || 'Array<MessageBox>'

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

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