Class: DealMakerAPI::ShareholderApi

Inherits:
Object
  • Object
show all
Defined in:
lib/DealMakerAPI/api/shareholder_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ShareholderApi 



19
20
21
 
# File 'lib/DealMakerAPI/api/shareholder_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/DealMakerAPI/api/shareholder_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_shareholders(id, opts = {}) ⇒ V1EntitiesShareholders

Get a company shareholders list Gets a list of company shareholders.



27
28
29
30
 
# File 'lib/DealMakerAPI/api/shareholder_api.rb', line 27

def get_shareholders(id, opts = {})
  data, _status_code, _headers = get_shareholders_with_http_info(id, opts)
  data
end

#get_shareholders_tags(id, opts = {}) ⇒ V1EntitiesShareholdersTags

Get a company shareholders list grouped by tags Gets a list of company shareholders grouped by tags.



90
91
92
93
 
# File 'lib/DealMakerAPI/api/shareholder_api.rb', line 90

def get_shareholders_tags(id, opts = {})
  data, _status_code, _headers = get_shareholders_tags_with_http_info(id, opts)
  data
end

#get_shareholders_tags_with_http_info(id, opts = {}) ⇒ Array<(V1EntitiesShareholdersTags, Integer, Hash)>

Get a company shareholders list grouped by tags Gets a list of company shareholders grouped by tags.



100
101
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
 
# File 'lib/DealMakerAPI/api/shareholder_api.rb', line 100

def get_shareholders_tags_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ShareholderApi.get_shareholders_tags ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ShareholderApi.get_shareholders_tags"
  end
  # resource path
  local_var_path = '/companies/{id}/shareholders/tags'.sub('{' + 'id' + '}', CGI.escape(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']) unless header_params['Accept']

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

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

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

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

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

#get_shareholders_with_http_info(id, opts = {}) ⇒ Array<(V1EntitiesShareholders, Integer, Hash)>

Get a company shareholders list Gets a list of company shareholders.



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
 
# File 'lib/DealMakerAPI/api/shareholder_api.rb', line 37

def get_shareholders_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ShareholderApi.get_shareholders ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ShareholderApi.get_shareholders"
  end
  # resource path
  local_var_path = '/companies/{id}/shareholders'.sub('{' + 'id' + '}', CGI.escape(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']) unless header_params['Accept']

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

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

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

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

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