Class: Bfwd::SynchConfigsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/bf_ruby2/api/synch_configs_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SynchConfigsApi

Returns a new instance of SynchConfigsApi.



19
20
21
 
# File 'lib/bf_ruby2/api/synch_configs_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/bf_ruby2/api/synch_configs_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_sync_config(synch_config, opts = {}) ⇒ DataSynchronisationConfigurationPagedMetadata

Create a synch configuration. a new synch configuration","request":"createSynchConfigRequest.html","response":"createSynchConfigResponse.html"

Parameters:

  • synch_config —

    The data synch config object to be created.

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/bf_ruby2/api/synch_configs_api.rb', line 28

def create_sync_config(synch_config, opts = {})
  data, _status_code, _headers = create_sync_config_with_http_info(synch_config, opts)
  return data
end

#create_sync_config_with_http_info(synch_config, opts = {}) ⇒ Array<(DataSynchronisationConfigurationPagedMetadata, Fixnum, Hash)>

Create a synch configuration. a new synch configuration&quot;,&quot;request&quot;:&quot;createSynchConfigRequest.html&quot;,&quot;response&quot;:&quot;createSynchConfigResponse.html&quot;

Parameters:

  • synch_config —

    The data synch config object to be created.

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

    the optional parameters

Returns:



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
 
# File 'lib/bf_ruby2/api/synch_configs_api.rb', line 38

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(synch_config)
  auth_names = []
  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 => 'DataSynchronisationConfigurationPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SynchConfigsApi#create_sync_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_sync_configs(opts = {}) ⇒ DataSynchronisationConfigurationPagedMetadata

Returns a collection of Users. By default 10 values are returned. Records are returned in natural order. { "nickname" : "Get all synch configs","response" : "getSynchConfigsAll.html"}

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first synch configuration to return. (default to 0)

  • :records (Integer) —

    The maximum number of configs to return. (default to 10)

  • :order_by (String) —

    Specify a field used to order the result set. (default to created)

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC. (default to DESC)

Returns:



87
88
89
90
 
# File 'lib/bf_ruby2/api/synch_configs_api.rb', line 87

def get_all_sync_configs(opts = {})
  data, _status_code, _headers = get_all_sync_configs_with_http_info(opts)
  return data
end

#get_all_sync_configs_with_http_info(opts = {}) ⇒ Array<(DataSynchronisationConfigurationPagedMetadata, Fixnum, Hash)>

Returns a collection of Users. By default 10 values are returned. Records are returned in natural order. { &quot;nickname&quot; : &quot;Get all synch configs&quot;,&quot;response&quot; : &quot;getSynchConfigsAll.html&quot;}

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first synch configuration to return.

  • :records (Integer) —

    The maximum number of configs to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC.

Returns:



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
 
# File 'lib/bf_ruby2/api/synch_configs_api.rb', line 101

def get_all_sync_configs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SynchConfigsApi.get_all_sync_configs ..."
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/synchConfigs"

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'DataSynchronisationConfigurationPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SynchConfigsApi#get_all_sync_configs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sync_config(synch_configs_id, opts = {}) ⇒ DataSynchronisationConfigurationPagedMetadata

Returns a single config, specified by the ID parameter. { "nickname" : "Retrieve an existing synch config","response" : "getSynchConfigByID.html"}

Parameters:

  • synch_configs_id —

    ID of the Synch Configuration.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization -IDs used to restrict the scope of API calls.

Returns:



149
150
151
152
 
# File 'lib/bf_ruby2/api/synch_configs_api.rb', line 149

def get_sync_config(synch_configs_id, opts = {})
  data, _status_code, _headers = get_sync_config_with_http_info(synch_configs_id, opts)
  return data
end

#get_sync_config_by_platform(platform, opts = {}) ⇒ DataSynchronisationConfigurationPagedMetadata

Returns a collection configurations, specified by the platform parameter. { "nickname" : "Retrieve by platform","response" : "getSynchConfigsByPlatform.html"}

Parameters:

  • platform —

    The type of the synch configuration.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:



207
208
209
210
 
# File 'lib/bf_ruby2/api/synch_configs_api.rb', line 207

def get_sync_config_by_platform(platform, opts = {})
  data, _status_code, _headers = get_sync_config_by_platform_with_http_info(platform, opts)
  return data
end

#get_sync_config_by_platform_with_http_info(platform, opts = {}) ⇒ Array<(DataSynchronisationConfigurationPagedMetadata, Fixnum, Hash)>

Returns a collection configurations, specified by the platform parameter. { &quot;nickname&quot; : &quot;Retrieve by platform&quot;,&quot;response&quot; : &quot;getSynchConfigsByPlatform.html&quot;}

Parameters:

  • platform —

    The type of the synch configuration.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/bf_ruby2/api/synch_configs_api.rb', line 218

def get_sync_config_by_platform_with_http_info(platform, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SynchConfigsApi.get_sync_config_by_platform ..."
  end
  # verify the required parameter 'platform' is set
  if @api_client.config.client_side_validation && platform.nil?
    fail ArgumentError, "Missing the required parameter 'platform' when calling SynchConfigsApi.get_sync_config_by_platform"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['Salesforce'].include?(platform)
    fail ArgumentError, "invalid value for 'platform', must be one of Salesforce"
  end
  # resource path
  local_var_path = "/synchConfigs/platform/{platform}".sub('{' + 'platform' + '}', platform.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'DataSynchronisationConfigurationPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SynchConfigsApi#get_sync_config_by_platform\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sync_config_by_username(username, opts = {}) ⇒ DataSynchronisationConfigurationPagedMetadata

Returns a collection configurations, specified by the username parameter. { "nickname" : "Retrieve by username","response" : "getSynchConfigByUsername.html"}

Parameters:

  • username —

    The username in the synch configuration.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:



269
270
271
272
 
# File 'lib/bf_ruby2/api/synch_configs_api.rb', line 269

def get_sync_config_by_username(username, opts = {})
  data, _status_code, _headers = get_sync_config_by_username_with_http_info(username, opts)
  return data
end

#get_sync_config_by_username_with_http_info(username, opts = {}) ⇒ Array<(DataSynchronisationConfigurationPagedMetadata, Fixnum, Hash)>

Returns a collection configurations, specified by the username parameter. { &quot;nickname&quot; : &quot;Retrieve by username&quot;,&quot;response&quot; : &quot;getSynchConfigByUsername.html&quot;}

Parameters:

  • username —

    The username in the synch configuration.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/bf_ruby2/api/synch_configs_api.rb', line 280

def get_sync_config_by_username_with_http_info(username, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SynchConfigsApi.get_sync_config_by_username ..."
  end
  # verify the required parameter 'username' is set
  if @api_client.config.client_side_validation && username.nil?
    fail ArgumentError, "Missing the required parameter 'username' when calling SynchConfigsApi.get_sync_config_by_username"
  end
  # resource path
  local_var_path = "/synchConfigs/username/{username}".sub('{' + 'username' + '}', username.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'DataSynchronisationConfigurationPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SynchConfigsApi#get_sync_config_by_username\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sync_config_with_http_info(synch_configs_id, opts = {}) ⇒ Array<(DataSynchronisationConfigurationPagedMetadata, Fixnum, Hash)>

Returns a single config, specified by the ID parameter. { &quot;nickname&quot; : &quot;Retrieve an existing synch config&quot;,&quot;response&quot; : &quot;getSynchConfigByID.html&quot;}

Parameters:

  • synch_configs_id —

    ID of the Synch Configuration.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization -IDs used to restrict the scope of API calls.

Returns:



160
161
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
 
# File 'lib/bf_ruby2/api/synch_configs_api.rb', line 160

def get_sync_config_with_http_info(synch_configs_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SynchConfigsApi.get_sync_config ..."
  end
  # verify the required parameter 'synch_configs_id' is set
  if @api_client.config.client_side_validation && synch_configs_id.nil?
    fail ArgumentError, "Missing the required parameter 'synch_configs_id' when calling SynchConfigsApi.get_sync_config"
  end
  # resource path
  local_var_path = "/synchConfigs/{synchConfigs-ID}".sub('{' + 'synchConfigs-ID' + '}', synch_configs_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'DataSynchronisationConfigurationPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SynchConfigsApi#get_sync_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_sync_config(synch_config, opts = {}) ⇒ DataSynchronisationConfigurationPagedMetadata

Update a synch configuration. { "nickname" : "Update a synch config", "request" : "updateSyncConfigRequest.html" ,"response" : "updateSyncConfigResponse.html" }

Parameters:

  • synch_config —

    The synch configuration object to be updated.

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

    the optional parameters

Returns:



326
327
328
329
 
# File 'lib/bf_ruby2/api/synch_configs_api.rb', line 326

def update_sync_config(synch_config, opts = {})
  data, _status_code, _headers = update_sync_config_with_http_info(synch_config, opts)
  return data
end

#update_sync_config_with_http_info(synch_config, opts = {}) ⇒ Array<(DataSynchronisationConfigurationPagedMetadata, Fixnum, Hash)>

Update a synch configuration. { &quot;nickname&quot; : &quot;Update a synch config&quot;, &quot;request&quot; : &quot;updateSyncConfigRequest.html&quot; ,&quot;response&quot; : &quot;updateSyncConfigResponse.html&quot; }

Parameters:

  • synch_config —

    The synch configuration object to be updated.

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

    the optional parameters

Returns:



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/bf_ruby2/api/synch_configs_api.rb', line 336

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(synch_config)
  auth_names = []
  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,
    :return_type => 'DataSynchronisationConfigurationPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SynchConfigsApi#update_sync_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end