Class: MergeATSClient::LinkedAccountsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LinkedAccountsApi

Returns a new instance of LinkedAccountsApi.



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

def api_client
  @api_client
end

Instance Method Details

#linked_accounts_list(opts = {}) ⇒ PaginatedAccountDetailsAndActionsList

List linked accounts for your organization.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :category (String)
  • :cursor (String) —

    The pagination cursor value.

  • :end_user_email_address (String) —

    If provided, will only return linked accounts associated with the given email address.

  • :end_user_organization_name (String) —

    If provided, will only return linked accounts associated with the given organization name.

  • :end_user_origin_id (String) —

    If provided, will only return linked accounts associated with the given origin ID.

  • :end_user_origin_ids (String) —

    Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.

  • :id (String)
  • :ids (String) —

    Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.

  • :integration_name (String) —

    If provided, will only return linked accounts associated with the given integration name.

  • :is_test_account (String) —

    If included, will only include test linked accounts. If not included, will only include non-test linked accounts.

  • :page_size (Integer) —

    Number of results to return per page.

  • :status (String) —

    Filter by status. Options: `COMPLETE`, `INCOMPLETE`, `RELINK_NEEDED`

Returns:



37
38
39
40
 
# File 'lib/merge_ats_client/api/linked_accounts_api.rb', line 37

def linked_accounts_list(opts = {})
  data, _status_code, _headers = linked_accounts_list_with_http_info(opts)
  data
end

#linked_accounts_list_with_http_info(opts = {}) ⇒ Array<(PaginatedAccountDetailsAndActionsList, Integer, Hash)>

List linked accounts for your organization.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :category (String)
  • :cursor (String) —

    The pagination cursor value.

  • :end_user_email_address (String) —

    If provided, will only return linked accounts associated with the given email address.

  • :end_user_organization_name (String) —

    If provided, will only return linked accounts associated with the given organization name.

  • :end_user_origin_id (String) —

    If provided, will only return linked accounts associated with the given origin ID.

  • :end_user_origin_ids (String) —

    Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.

  • :id (String)
  • :ids (String) —

    Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.

  • :integration_name (String) —

    If provided, will only return linked accounts associated with the given integration name.

  • :is_test_account (String) —

    If included, will only include test linked accounts. If not included, will only include non-test linked accounts.

  • :page_size (Integer) —

    Number of results to return per page.

  • :status (String) —

    Filter by status. Options: &#x60;COMPLETE&#x60;, &#x60;INCOMPLETE&#x60;, &#x60;RELINK_NEEDED&#x60;

Returns:



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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/merge_ats_client/api/linked_accounts_api.rb', line 57

def linked_accounts_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinkedAccountsApi.linked_accounts_list ...'
  end
  allowable_values = ["accounting", "ats", "crm", "hris", "ticketing"]
  if @api_client.config.client_side_validation && opts[:'category'] && !allowable_values.include?(opts[:'category'])
    fail ArgumentError, "invalid value for \"category\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/linked-accounts'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'category'] = opts[:'category'] if !opts[:'category'].nil?
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
  query_params[:'end_user_email_address'] = opts[:'end_user_email_address'] if !opts[:'end_user_email_address'].nil?
  query_params[:'end_user_organization_name'] = opts[:'end_user_organization_name'] if !opts[:'end_user_organization_name'].nil?
  query_params[:'end_user_origin_id'] = opts[:'end_user_origin_id'] if !opts[:'end_user_origin_id'].nil?
  query_params[:'end_user_origin_ids'] = opts[:'end_user_origin_ids'] if !opts[:'end_user_origin_ids'].nil?
  query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
  query_params[:'ids'] = opts[:'ids'] if !opts[:'ids'].nil?
  query_params[:'integration_name'] = opts[:'integration_name'] if !opts[:'integration_name'].nil?
  query_params[:'is_test_account'] = opts[:'is_test_account'] if !opts[:'is_test_account'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].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] || 'PaginatedAccountDetailsAndActionsList'

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

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