Class: KoronaCloudClient::DataExchangeConfigurationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/korona-cloud-client/api/data_exchange_configurations_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DataExchangeConfigurationsApi

Returns a new instance of DataExchangeConfigurationsApi.



19
20
21
 
# File 'lib/korona-cloud-client/api/data_exchange_configurations_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/korona-cloud-client/api/data_exchange_configurations_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_data_exchange_configuration(korona_account_id, data_exchange_configuration_type, opts = {}) ⇒ DataExchangeConfiguration

returns the single data exchange configuration

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

  • data_exchange_configuration_type (String) —

    data exchange configuration type

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/korona-cloud-client/api/data_exchange_configurations_api.rb', line 27

def get_data_exchange_configuration(, data_exchange_configuration_type, opts = {})
  data, _status_code, _headers = get_data_exchange_configuration_with_http_info(, data_exchange_configuration_type, opts)
  data
end

#get_data_exchange_configuration_with_http_info(korona_account_id, data_exchange_configuration_type, opts = {}) ⇒ Array<(DataExchangeConfiguration, Integer, Hash)>

returns the single data exchange configuration

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

  • data_exchange_configuration_type (String) —

    data exchange configuration type

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

    the optional parameters

Returns:

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

    DataExchangeConfiguration 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
89
90
91
92
 
# File 'lib/korona-cloud-client/api/data_exchange_configurations_api.rb', line 37

def get_data_exchange_configuration_with_http_info(, data_exchange_configuration_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataExchangeConfigurationsApi.get_data_exchange_configuration ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling DataExchangeConfigurationsApi.get_data_exchange_configuration"
  end
  # verify the required parameter 'data_exchange_configuration_type' is set
  if @api_client.config.client_side_validation && data_exchange_configuration_type.nil?
    fail ArgumentError, "Missing the required parameter 'data_exchange_configuration_type' when calling DataExchangeConfigurationsApi.get_data_exchange_configuration"
  end
  # verify enum value
  allowable_values = ["KORONA_ENTRY"]
  if @api_client.config.client_side_validation && !allowable_values.include?(data_exchange_configuration_type)
    fail ArgumentError, "invalid value for \"data_exchange_configuration_type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/dataExchangeConfigurations/{dataExchangeConfigurationType}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'dataExchangeConfigurationType' + '}', CGI.escape(data_exchange_configuration_type.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] || 'DataExchangeConfiguration'

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

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

#get_data_exchange_configurations(korona_account_id, opts = {}) ⇒ ResultListDataExchangeConfiguration

lists all data exchange configurations

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    number of the page to fetch

  • :size (Integer) —

    amount of objects to return per page

  • :sort (String) —

    attribute to sort by (multiple separated by comma; max. 5)

  • :revision (Integer) —

    last revision number, objects with a greater revision than this will be returned

  • :include_deleted (Boolean) —

    indicates deleted objects should be loaded or not (default: false)

Returns:



103
104
105
106
 
# File 'lib/korona-cloud-client/api/data_exchange_configurations_api.rb', line 103

def get_data_exchange_configurations(, opts = {})
  data, _status_code, _headers = get_data_exchange_configurations_with_http_info(, opts)
  data
end

#get_data_exchange_configurations_with_http_info(korona_account_id, opts = {}) ⇒ Array<(ResultListDataExchangeConfiguration, Integer, Hash)>

lists all data exchange configurations

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    number of the page to fetch

  • :size (Integer) —

    amount of objects to return per page

  • :sort (String) —

    attribute to sort by (multiple separated by comma; max. 5)

  • :revision (Integer) —

    last revision number, objects with a greater revision than this will be returned

  • :include_deleted (Boolean) —

    indicates deleted objects should be loaded or not (default: false)

Returns:



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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/korona-cloud-client/api/data_exchange_configurations_api.rb', line 117

def get_data_exchange_configurations_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataExchangeConfigurationsApi.get_data_exchange_configurations ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling DataExchangeConfigurationsApi.get_data_exchange_configurations"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/dataExchangeConfigurations'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'revision'] = opts[:'revision'] if !opts[:'revision'].nil?
  query_params[:'includeDeleted'] = opts[:'include_deleted'] if !opts[:'include_deleted'].nil?

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

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

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