Class: KabustationClient::RegisterApi

Inherits:
Object
  • Object
show all
Defined in:
lib/kabustation_client/api/register_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RegisterApi

Returns a new instance of RegisterApi.



19
20
21
 
# File 'lib/kabustation_client/api/register_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/kabustation_client/api/register_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#register_put(request_register, opts = {}) ⇒ RegistSuccess

銘柄登録 PUSH配信する銘柄を登録します。
API登録銘柄リストを開くには、kabuステーションAPIインジケーターを右クリックし「API登録銘柄リスト」を選択してください。

Parameters:

  • request_register (RequestRegister) —

    登録する銘柄のリスト

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/kabustation_client/api/register_api.rb', line 27

def register_put(request_register, opts = {})
  data, _status_code, _headers = register_put_with_http_info(request_register, opts)
  data
end

#register_put_with_http_info(request_register, opts = {}) ⇒ Array<(RegistSuccess, Integer, Hash)>

銘柄登録 PUSH配信する銘柄を登録します。&lt;br&gt; API登録銘柄リストを開くには、kabuステーションAPIインジケーターを右クリックし「API登録銘柄リスト」を選択してください。

Parameters:

  • request_register (RequestRegister) —

    登録する銘柄のリスト

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

    the optional parameters

Returns:

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

    RegistSuccess data, response status code and response headers



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
86
87
88
 
# File 'lib/kabustation_client/api/register_api.rb', line 37

def register_put_with_http_info(request_register, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RegisterApi.register_put ...'
  end
  # verify the required parameter 'request_register' is set
  if @api_client.config.client_side_validation && request_register.nil?
    fail ArgumentError, "Missing the required parameter 'request_register' when calling RegisterApi.register_put"
  end
  # resource path
  local_var_path = '/register'

  # 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(request_register)

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

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

  new_options = opts.merge(
    :operation => :"RegisterApi.register_put",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RegisterApi#register_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#unregister_all_put(opts = {}) ⇒ UnregisterAllSuccess

銘柄登録全解除 API登録銘柄リストに登録されている銘柄をすべて解除します

Parameters:

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

    the optional parameters

Returns:



94
95
96
97
 
# File 'lib/kabustation_client/api/register_api.rb', line 94

def unregister_all_put(opts = {})
  data, _status_code, _headers = unregister_all_put_with_http_info(opts)
  data
end

#unregister_all_put_with_http_info(opts = {}) ⇒ Array<(UnregisterAllSuccess, Integer, Hash)>

銘柄登録全解除 API登録銘柄リストに登録されている銘柄をすべて解除します

Parameters:

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

    the optional parameters

Returns:

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

    UnregisterAllSuccess data, response status code and response headers



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/kabustation_client/api/register_api.rb', line 103

def unregister_all_put_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RegisterApi.unregister_all_put ...'
  end
  # resource path
  local_var_path = '/unregister/all'

  # 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] || 'UnregisterAllSuccess'

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

  new_options = opts.merge(
    :operation => :"RegisterApi.unregister_all_put",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RegisterApi#unregister_all_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#unregister_put(request_unregister, opts = {}) ⇒ RegistSuccess

銘柄登録解除 API登録銘柄リストに登録されている銘柄を解除します

Parameters:

  • request_unregister (RequestUnregister) —

    登録解除する銘柄のリスト

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

    the optional parameters

Returns:



152
153
154
155
 
# File 'lib/kabustation_client/api/register_api.rb', line 152

def unregister_put(request_unregister, opts = {})
  data, _status_code, _headers = unregister_put_with_http_info(request_unregister, opts)
  data
end

#unregister_put_with_http_info(request_unregister, opts = {}) ⇒ Array<(RegistSuccess, Integer, Hash)>

銘柄登録解除 API登録銘柄リストに登録されている銘柄を解除します

Parameters:

  • request_unregister (RequestUnregister) —

    登録解除する銘柄のリスト

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

    the optional parameters

Returns:

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

    RegistSuccess data, response status code and response headers



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
211
212
213
 
# File 'lib/kabustation_client/api/register_api.rb', line 162

def unregister_put_with_http_info(request_unregister, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RegisterApi.unregister_put ...'
  end
  # verify the required parameter 'request_unregister' is set
  if @api_client.config.client_side_validation && request_unregister.nil?
    fail ArgumentError, "Missing the required parameter 'request_unregister' when calling RegisterApi.unregister_put"
  end
  # resource path
  local_var_path = '/unregister'

  # 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(request_unregister)

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

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

  new_options = opts.merge(
    :operation => :"RegisterApi.unregister_put",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RegisterApi#unregister_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end