Class: MergeATSClient::SelectiveSyncApi

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ats_client/api/selective_sync_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SelectiveSyncApi

Returns a new instance of SelectiveSyncApi.



19
20
21
 
# File 'lib/merge_ats_client/api/selective_sync_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/merge_ats_client/api/selective_sync_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#selective_sync_configurations_list(x_account_token, opts = {}) ⇒ Array<LinkedAccountSelectiveSyncConfiguration>

Get a linked account’s selective syncs.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/merge_ats_client/api/selective_sync_api.rb', line 26

def selective_sync_configurations_list(, opts = {})
  data, _status_code, _headers = selective_sync_configurations_list_with_http_info(, opts)
  data
end

#selective_sync_configurations_list_with_http_info(x_account_token, opts = {}) ⇒ Array<(Array<LinkedAccountSelectiveSyncConfiguration>, Integer, Hash)>

Get a linked account&#39;s selective syncs.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

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

    the optional parameters

Returns:



35
36
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
 
# File 'lib/merge_ats_client/api/selective_sync_api.rb', line 35

def selective_sync_configurations_list_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SelectiveSyncApi.selective_sync_configurations_list ...'
  end
  # verify the required parameter 'x_account_token' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_token' when calling SelectiveSyncApi.selective_sync_configurations_list"
  end
  # resource path
  local_var_path = '/selective-sync/configurations'

  # 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'])
  header_params[:'X-Account-Token'] = 

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<LinkedAccountSelectiveSyncConfiguration>'

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

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

#selective_sync_configurations_update(x_account_token, linked_account_selective_sync_configuration_list_request, opts = {}) ⇒ Array<LinkedAccountSelectiveSyncConfiguration>

Replace a linked account’s selective syncs.

Parameters:

Returns:



89
90
91
92
 
# File 'lib/merge_ats_client/api/selective_sync_api.rb', line 89

def selective_sync_configurations_update(, , opts = {})
  data, _status_code, _headers = selective_sync_configurations_update_with_http_info(, , opts)
  data
end

#selective_sync_configurations_update_with_http_info(x_account_token, linked_account_selective_sync_configuration_list_request, opts = {}) ⇒ Array<(Array<LinkedAccountSelectiveSyncConfiguration>, Integer, Hash)>

Replace a linked account&#39;s selective syncs.

Parameters:

Returns:



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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/merge_ats_client/api/selective_sync_api.rb', line 99

def selective_sync_configurations_update_with_http_info(, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SelectiveSyncApi.selective_sync_configurations_update ...'
  end
  # verify the required parameter 'x_account_token' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_token' when calling SelectiveSyncApi.selective_sync_configurations_update"
  end
  # verify the required parameter 'linked_account_selective_sync_configuration_list_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'linked_account_selective_sync_configuration_list_request' when calling SelectiveSyncApi.selective_sync_configurations_update"
  end
  # resource path
  local_var_path = '/selective-sync/configurations'

  # 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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-Account-Token'] = 

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body()

  # return_type
  return_type = opts[:debug_return_type] || 'Array<LinkedAccountSelectiveSyncConfiguration>'

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

  new_options = opts.merge(
    :operation => :"SelectiveSyncApi.selective_sync_configurations_update",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SelectiveSyncApi#selective_sync_configurations_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#selective_sync_meta_list(x_account_token, opts = {}) ⇒ PaginatedConditionSchemaList

Get metadata for the conditions available to a linked account.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

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

    the optional parameters

Options Hash (opts):

  • :common_model (String)
  • :cursor (Integer) —

    The pagination cursor value.

  • :page_size (Integer) —

    Number of results to return per page.

Returns:



161
162
163
164
 
# File 'lib/merge_ats_client/api/selective_sync_api.rb', line 161

def selective_sync_meta_list(, opts = {})
  data, _status_code, _headers = selective_sync_meta_list_with_http_info(, opts)
  data
end

#selective_sync_meta_list_with_http_info(x_account_token, opts = {}) ⇒ Array<(PaginatedConditionSchemaList, Integer, Hash)>

Get metadata for the conditions available to a linked account.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

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

    the optional parameters

Options Hash (opts):

  • :common_model (String)
  • :cursor (Integer) —

    The pagination cursor value.

  • :page_size (Integer) —

    Number of results to return per page.

Returns:



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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/merge_ats_client/api/selective_sync_api.rb', line 173

def selective_sync_meta_list_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SelectiveSyncApi.selective_sync_meta_list ...'
  end
  # verify the required parameter 'x_account_token' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_token' when calling SelectiveSyncApi.selective_sync_meta_list"
  end
  # resource path
  local_var_path = '/selective-sync/meta'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'common_model'] = opts[:'common_model'] if !opts[:'common_model'].nil?
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Account-Token'] = 

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

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

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

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

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