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

Returns a new instance of 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

登録

Parameters:

  • message_box_id (Integer) —

    Parameter description in CommonMark or HTML.

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

    the optional parameters

Returns:



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)>

登録

Parameters:

  • message_box_id (Integer) —

    Parameter description in CommonMark or HTML.

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

    the optional parameters

Returns:

  • (Array<(Customer, Integer, Hash)>) —

    Customer data, response status code and response headers



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, opts = {}) ⇒ RecordResponse

応答メモ作成

Parameters:

  • message_box_id (Integer) —

    受信箱ID(数字)

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

    the optional parameters

Options Hash (opts):

Returns:



92
93
94
95
 
# File 'lib/relation_client/api/message_box_api.rb', line 92

def message_box_id_records_post(message_box_id, opts = {})
  data, _status_code, _headers = message_box_id_records_post_with_http_info(message_box_id, opts)
  data
end

#message_box_id_records_post_with_http_info(message_box_id, opts = {}) ⇒ Array<(RecordResponse, Integer, Hash)>

応答メモ作成

Parameters:

  • message_box_id (Integer) —

    受信箱ID(数字)

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(RecordResponse, Integer, Hash)>) —

    RecordResponse 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
146
147
148
149
150
151
152
153
 
# File 'lib/relation_client/api/message_box_api.rb', line 102

def message_box_id_records_post_with_http_info(message_box_id, 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
  # 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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'record_request'])

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

  # 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>

一覧取得

Parameters:

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

    the optional parameters

Returns:



158
159
160
161
 
# File 'lib/relation_client/api/message_box_api.rb', line 158

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)>

一覧取得

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<MessageBox>, Integer, Hash)>) —

    Array<MessageBox> data, response status code and response headers



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
 
# File 'lib/relation_client/api/message_box_api.rb', line 166

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