Class: Merge::Filestorage::AsyncUsersClient

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/filestorage/users/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Merge::Filestorage::AsyncUsersClient

Parameters:



128
129
130
 
# File 'lib/merge_ruby_client/filestorage/users/client.rb', line 128

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Merge::AsyncRequestClient (readonly)

Returns:



124
125
126
 
# File 'lib/merge_ruby_client/filestorage/users/client.rb', line 124

def request_client
  @request_client
end

Instance Method Details

#list(created_after: nil, created_before: nil, cursor: nil, include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil, is_me: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_id: nil, request_options: nil) ⇒ Merge::Filestorage::PaginatedUserList

Returns a list of ‘User` objects.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.filestorage.users.list(cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw")

Parameters:

  • created_after (DateTime) (defaults to: nil) —

    If provided, will only return objects created after this datetime.

  • created_before (DateTime) (defaults to: nil) —

    If provided, will only return objects created before this datetime.

  • cursor (String) (defaults to: nil) —

    The pagination cursor value.

  • include_deleted_data (Boolean) (defaults to: nil) —

    Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).

  • include_remote_data (Boolean) (defaults to: nil) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

  • include_shell_data (Boolean) (defaults to: nil) —

    Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

  • is_me (String) (defaults to: nil) —

    If provided, will only return the user object for requestor.

  • modified_after (DateTime) (defaults to: nil) —

    If provided, only objects synced by Merge after this date time will be returned.

  • modified_before (DateTime) (defaults to: nil) —

    If provided, only objects synced by Merge before this date time will be returned.

  • page_size (Integer) (defaults to: nil) —

    Number of results to return per page.

  • remote_id (String) (defaults to: nil) —

    The API provider’s ID for the given object.

  • request_options (Merge::RequestOptions) (defaults to: nil)

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
 
# File 'lib/merge_ruby_client/filestorage/users/client.rb', line 160

def list(created_after: nil, created_before: nil, cursor: nil, include_deleted_data: nil,
         include_remote_data: nil, include_shell_data: nil, is_me: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_id: nil, request_options: nil)
  Async do
    response = @request_client.conn.get do |req|
      req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
      req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
      req.headers["X-Account-Token"] = request_options. unless request_options&..nil?
      req.headers = {
    **(req.headers || {}),
    **@request_client.get_headers,
    **(request_options&.additional_headers || {})
      }.compact
      req.params = {
        **(request_options&.additional_query_parameters || {}),
        "created_after": created_after,
        "created_before": created_before,
        "cursor": cursor,
        "include_deleted_data": include_deleted_data,
        "include_remote_data": include_remote_data,
        "include_shell_data": include_shell_data,
        "is_me": is_me,
        "modified_after": modified_after,
        "modified_before": modified_before,
        "page_size": page_size,
        "remote_id": remote_id
      }.compact
      unless request_options.nil? || request_options&.additional_body_parameters.nil?
        req.body = { **(request_options&.additional_body_parameters || {}) }.compact
      end
      req.url "#{@request_client.get_url(request_options: request_options)}/filestorage/v1/users"
    end
    Merge::Filestorage::PaginatedUserList.from_json(json_object: response.body)
  end
end

#retrieve(id:, include_remote_data: nil, include_shell_data: nil, request_options: nil) ⇒ Merge::Filestorage::User

Returns a ‘User` object with the given `id`.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.filestorage.users.retrieve(id: "id")

Parameters:

  • id (String)
  • include_remote_data (Boolean) (defaults to: nil) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

  • include_shell_data (Boolean) (defaults to: nil) —

    Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

  • request_options (Merge::RequestOptions) (defaults to: nil)

Returns:



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/merge_ruby_client/filestorage/users/client.rb', line 211

def retrieve(id:, include_remote_data: nil, include_shell_data: nil, request_options: nil)
  Async do
    response = @request_client.conn.get do |req|
      req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
      req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
      req.headers["X-Account-Token"] = request_options. unless request_options&..nil?
      req.headers = {
    **(req.headers || {}),
    **@request_client.get_headers,
    **(request_options&.additional_headers || {})
      }.compact
      req.params = {
        **(request_options&.additional_query_parameters || {}),
        "include_remote_data": include_remote_data,
        "include_shell_data": include_shell_data
      }.compact
      unless request_options.nil? || request_options&.additional_body_parameters.nil?
        req.body = { **(request_options&.additional_body_parameters || {}) }.compact
      end
      req.url "#{@request_client.get_url(request_options: request_options)}/filestorage/v1/users/#{id}"
    end
    Merge::Filestorage::User.from_json(json_object: response.body)
  end
end