Class: Bfwd::SynchAppConfigsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SynchAppConfigsApi

Returns a new instance of SynchAppConfigsApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_sync_app_config(synch_app_config, opts = {}) ⇒ DataSynchronisationAppConfigurationPagedMetadata

Create a synch app configuration. a new synch app configuration","request":"createSynchAppConfigurationRequest.html","response":"createSynchAppConfigurationResponse.html"

Parameters:

  • synch_app_config —

    The data synch app config object to be created.

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

    the optional parameters

Returns:



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

def create_sync_app_config(synch_app_config, opts = {})
  data, _status_code, _headers = create_sync_app_config_with_http_info(synch_app_config, opts)
  return data
end

#create_sync_app_config_with_http_info(synch_app_config, opts = {}) ⇒ Array<(DataSynchronisationAppConfigurationPagedMetadata, Fixnum, Hash)>

Create a synch app configuration. a new synch app configuration&quot;,&quot;request&quot;:&quot;createSynchAppConfigurationRequest.html&quot;,&quot;response&quot;:&quot;createSynchAppConfigurationResponse.html&quot;

Parameters:

  • synch_app_config —

    The data synch app 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_app_configs_api.rb', line 38

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

  # 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_app_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 => 'DataSynchronisationAppConfigurationPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SynchAppConfigsApi#create_sync_app_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sync_app_config(synch_app_configs_id, opts = {}) ⇒ DataSynchronisationAppConfigurationPagedMetadata

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

Parameters:

  • synch_app_configs_id —

    ID of the Synch App 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:



84
85
86
87
 
# File 'lib/bf_ruby2/api/synch_app_configs_api.rb', line 84

def get_sync_app_config(synch_app_configs_id, opts = {})
  data, _status_code, _headers = get_sync_app_config_with_http_info(synch_app_configs_id, opts)
  return data
end

#get_sync_app_config_by_platform(platform, opts = {}) ⇒ DataSynchronisationAppConfigurationPagedMetadata

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

Parameters:

  • platform —

    The type of the synch app 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:



142
143
144
145
 
# File 'lib/bf_ruby2/api/synch_app_configs_api.rb', line 142

def get_sync_app_config_by_platform(platform, opts = {})
  data, _status_code, _headers = get_sync_app_config_by_platform_with_http_info(platform, opts)
  return data
end

#get_sync_app_config_by_platform_with_http_info(platform, opts = {}) ⇒ Array<(DataSynchronisationAppConfigurationPagedMetadata, Fixnum, Hash)>

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

Parameters:

  • platform —

    The type of the synch app 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:



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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/bf_ruby2/api/synch_app_configs_api.rb', line 153

def get_sync_app_config_by_platform_with_http_info(platform, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SynchAppConfigsApi.get_sync_app_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 SynchAppConfigsApi.get_sync_app_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 = "/synchAppConfigs/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 => 'DataSynchronisationAppConfigurationPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SynchAppConfigsApi#get_sync_app_config_by_platform\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sync_app_config_with_http_info(synch_app_configs_id, opts = {}) ⇒ Array<(DataSynchronisationAppConfigurationPagedMetadata, 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;getSynchAppConfigByID.html&quot;}

Parameters:

  • synch_app_configs_id —

    ID of the Synch App 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:



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
130
131
132
133
134
 
# File 'lib/bf_ruby2/api/synch_app_configs_api.rb', line 95

def get_sync_app_config_with_http_info(synch_app_configs_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SynchAppConfigsApi.get_sync_app_config ..."
  end
  # verify the required parameter 'synch_app_configs_id' is set
  if @api_client.config.client_side_validation && synch_app_configs_id.nil?
    fail ArgumentError, "Missing the required parameter 'synch_app_configs_id' when calling SynchAppConfigsApi.get_sync_app_config"
  end
  # resource path
  local_var_path = "/synchAppConfigs/{synchAppConfigs-ID}".sub('{' + 'synchAppConfigs-ID' + '}', synch_app_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 => 'DataSynchronisationAppConfigurationPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SynchAppConfigsApi#get_sync_app_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_sync_app_config(synch_app_config, opts = {}) ⇒ DataSynchronisationAppConfigurationPagedMetadata

Update a synch app configuration. { "nickname" : "Update a sync app configuration", "request" : "updateSyncAppConfigRequest.html" ,"response" : "updateSyncAppConfigResponse.html" }

Parameters:

  • synch_app_config —

    The synch app configuration object to be updated.

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

    the optional parameters

Returns:



203
204
205
206
 
# File 'lib/bf_ruby2/api/synch_app_configs_api.rb', line 203

def update_sync_app_config(synch_app_config, opts = {})
  data, _status_code, _headers = update_sync_app_config_with_http_info(synch_app_config, opts)
  return data
end

#update_sync_app_config_with_http_info(synch_app_config, opts = {}) ⇒ Array<(DataSynchronisationAppConfigurationPagedMetadata, Fixnum, Hash)>

Update a synch app configuration. { &quot;nickname&quot; : &quot;Update a sync app configuration&quot;, &quot;request&quot; : &quot;updateSyncAppConfigRequest.html&quot; ,&quot;response&quot; : &quot;updateSyncAppConfigResponse.html&quot; }

Parameters:

  • synch_app_config —

    The synch app configuration object to be updated.

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

    the optional parameters

Returns:



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
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/bf_ruby2/api/synch_app_configs_api.rb', line 213

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

  # 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_app_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 => 'DataSynchronisationAppConfigurationPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SynchAppConfigsApi#update_sync_app_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end