Class: MergeHRISClient::ScopesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_hris_client/api/scopes_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ScopesApi

Returns a new instance of ScopesApi.



19
20
21
 
# File 'lib/merge_hris_client/api/scopes_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_hris_client/api/scopes_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#default_scopes_retrieve(opts = {}) ⇒ CommonModelScopeAPI

Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](help.merge.dev/en/articles/8828211-common-model-and-field-scopes).

Parameters:

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

    the optional parameters

Returns:



25
26
27
28
 
# File 'lib/merge_hris_client/api/scopes_api.rb', line 25

def default_scopes_retrieve(opts = {})
  data, _status_code, _headers = default_scopes_retrieve_with_http_info(opts)
  data
end

#default_scopes_retrieve_with_http_info(opts = {}) ⇒ Array<(CommonModelScopeAPI, Integer, Hash)>

Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](help.merge.dev/en/articles/8828211-common-model-and-field-scopes).

Parameters:

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

    the optional parameters

Returns:

  • (Array<(CommonModelScopeAPI, Integer, Hash)>) —

    CommonModelScopeAPI data, response status code and response headers



33
34
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
 
# File 'lib/merge_hris_client/api/scopes_api.rb', line 33

def default_scopes_retrieve_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScopesApi.default_scopes_retrieve ...'
  end
  # resource path
  local_var_path = '/default-scopes'

  # 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'])

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

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

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

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

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

#linked_account_scopes_create(x_account_token, linked_account_common_model_scope_deserializer_request, opts = {}) ⇒ CommonModelScopeAPI

Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](help.merge.dev/en/articles/8828211-common-model-and-field-scopes)

Parameters:

Returns:



82
83
84
85
 
# File 'lib/merge_hris_client/api/scopes_api.rb', line 82

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

#linked_account_scopes_create_with_http_info(x_account_token, linked_account_common_model_scope_deserializer_request, opts = {}) ⇒ Array<(CommonModelScopeAPI, Integer, Hash)>

Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](help.merge.dev/en/articles/8828211-common-model-and-field-scopes)

Parameters:

Returns:

  • (Array<(CommonModelScopeAPI, Integer, Hash)>) —

    CommonModelScopeAPI data, 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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/merge_hris_client/api/scopes_api.rb', line 92

def (, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScopesApi.linked_account_scopes_create ...'
  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 ScopesApi.linked_account_scopes_create"
  end
  # verify the required parameter 'linked_account_common_model_scope_deserializer_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'linked_account_common_model_scope_deserializer_request' when calling ScopesApi.linked_account_scopes_create"
  end
  # resource path
  local_var_path = '/linked-account-scopes'

  # 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', 'application/x-www-form-urlencoded', 'multipart/form-data'])
  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] || 'CommonModelScopeAPI'

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

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

#linked_account_scopes_retrieve(x_account_token, opts = {}) ⇒ CommonModelScopeAPI

Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](help.merge.dev/en/articles/8828211-common-model-and-field-scopes).

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

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

    the optional parameters

Returns:



151
152
153
154
 
# File 'lib/merge_hris_client/api/scopes_api.rb', line 151

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

#linked_account_scopes_retrieve_with_http_info(x_account_token, opts = {}) ⇒ Array<(CommonModelScopeAPI, Integer, Hash)>

Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](help.merge.dev/en/articles/8828211-common-model-and-field-scopes).

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

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

    the optional parameters

Returns:

  • (Array<(CommonModelScopeAPI, Integer, Hash)>) —

    CommonModelScopeAPI data, response status code and response headers



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
200
201
202
203
204
205
206
207
 
# File 'lib/merge_hris_client/api/scopes_api.rb', line 160

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScopesApi.linked_account_scopes_retrieve ...'
  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 ScopesApi.linked_account_scopes_retrieve"
  end
  # resource path
  local_var_path = '/linked-account-scopes'

  # 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] || 'CommonModelScopeAPI'

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

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