Class: RusticiSoftwareCloudV2::ContentConnectorsApi

Inherits:
Object
  • Object
show all
Extended by:
Gem::Deprecate
Defined in:
lib/rustici_software_cloud_v2/api/content_connectors_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContentConnectorsApi

Returns a new instance of ContentConnectorsApi.



18
19
20
 
# File 'lib/rustici_software_cloud_v2/api/content_connectors_api.rb', line 18

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



16
17
18
 
# File 'lib/rustici_software_cloud_v2/api/content_connectors_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

#create_connector(connector, opts = {}) ⇒ StringResultSchema

A call to this method will create a new content connector and return a newly created Id for it.

Parameters:

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/rustici_software_cloud_v2/api/content_connectors_api.rb', line 28

def create_connector(connector, opts = {})
  data, _status_code, _headers = create_connector_with_http_info(connector, opts)
  data
end

#create_connector_with_http_info(connector, opts = {}) ⇒ Array<(StringResultSchema, Fixnum, Hash)>

A call to this method will create a new content connector and return a newly created Id for it.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(StringResultSchema, Fixnum, Hash)>) —

    StringResultSchema 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
 
# File 'lib/rustici_software_cloud_v2/api/content_connectors_api.rb', line 37

def create_connector_with_http_info(connector, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentConnectorsApi.create_connector ...'
  end
  # verify the required parameter 'connector' is set
  if connector.nil?
    fail ArgumentError, "Missing the required parameter 'connector' when calling ContentConnectorsApi.create_connector"
  end
  # resource path
  local_var_path = '/contentConnectors'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(connector)
  auth_names = ['APP_NORMAL', 'OAUTH']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'StringResultSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentConnectorsApi#create_connector\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_connector(connector_id, opts = {}) ⇒ nil

Delete a connector Delete the specified connector.

Parameters:

  • connector_id —

    the connector id

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

    the optional parameters

Returns:

  • (nil) 


82
83
84
85
 
# File 'lib/rustici_software_cloud_v2/api/content_connectors_api.rb', line 82

def delete_connector(connector_id, opts = {})
  delete_connector_with_http_info(connector_id, opts)
  nil
end

#delete_connector_with_http_info(connector_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a connector Delete the specified connector.

Parameters:

  • connector_id —

    the connector id

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



92
93
94
95
96
97
98
99
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
 
# File 'lib/rustici_software_cloud_v2/api/content_connectors_api.rb', line 92

def delete_connector_with_http_info(connector_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentConnectorsApi.delete_connector ...'
  end
  # verify the required parameter 'connector_id' is set
  if connector_id.nil?
    fail ArgumentError, "Missing the required parameter 'connector_id' when calling ContentConnectorsApi.delete_connector"
  end
  # resource path
  local_var_path = '/contentConnectors/{connectorId}'.sub('{' + 'connectorId' + '}', connector_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['APP_NORMAL', 'OAUTH']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentConnectorsApi#delete_connector\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_connectors_list(opts = {}) ⇒ ConnectorListSchema

Get a list of all Content Connectors for the application Get list of all Content Connectors in this application.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include_additional_instance_information (BOOLEAN)

Returns:



136
137
138
139
 
# File 'lib/rustici_software_cloud_v2/api/content_connectors_api.rb', line 136

def get_connectors_list(opts = {})
  data, _status_code, _headers = get_connectors_list_with_http_info(opts)
  data
end

#get_connectors_list_with_http_info(opts = {}) ⇒ Array<(ConnectorListSchema, Fixnum, Hash)>

Get a list of all Content Connectors for the application Get list of all Content Connectors in this application.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include_additional_instance_information (BOOLEAN)

Returns:

  • (Array<(ConnectorListSchema, Fixnum, Hash)>) —

    ConnectorListSchema data, response status code and response headers



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
 
# File 'lib/rustici_software_cloud_v2/api/content_connectors_api.rb', line 146

def get_connectors_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentConnectorsApi.get_connectors_list ...'
  end
  # resource path
  local_var_path = '/contentConnectors'

  # query parameters
  query_params = {}
  query_params[:'includeAdditionalInstanceInformation'] = opts[:'include_additional_instance_information'] if !opts[:'include_additional_instance_information'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['APP_NORMAL', 'OAUTH']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConnectorListSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentConnectorsApi#get_connectors_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_connector(connector_id, connector, opts = {}) ⇒ nil

Update the configuration or enabled flag associated with ‘connectorId`.

Parameters:

  • connector_id —

    the connector id

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

    the optional parameters

Returns:

  • (nil) 


188
189
190
191
 
# File 'lib/rustici_software_cloud_v2/api/content_connectors_api.rb', line 188

def update_connector(connector_id, connector, opts = {})
  update_connector_with_http_info(connector_id, connector, opts)
  nil
end

#update_connector_with_http_info(connector_id, connector, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update the configuration or enabled flag associated with &#x60;connectorId&#x60;.

Parameters:

  • connector_id —

    the connector id

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/rustici_software_cloud_v2/api/content_connectors_api.rb', line 198

def update_connector_with_http_info(connector_id, connector, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentConnectorsApi.update_connector ...'
  end
  # verify the required parameter 'connector_id' is set
  if connector_id.nil?
    fail ArgumentError, "Missing the required parameter 'connector_id' when calling ContentConnectorsApi.update_connector"
  end
  # verify the required parameter 'connector' is set
  if connector.nil?
    fail ArgumentError, "Missing the required parameter 'connector' when calling ContentConnectorsApi.update_connector"
  end
  # resource path
  local_var_path = '/contentConnectors/{connectorId}'.sub('{' + 'connectorId' + '}', connector_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(connector)
  auth_names = ['APP_NORMAL', 'OAUTH']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentConnectorsApi#update_connector\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end