Class: FinchAPI::Resources::Sandbox::Directory

Inherits:

Object

• Object
• FinchAPI::Resources::Sandbox::Directory

Defined in:

lib/finch_api/resources/sandbox/directory.rb

Instance Method Summary

• #create(body: nil, request_options: {}) ⇒ Array<Object>

  Some parameter documentations has been truncated, see Models::Sandbox::DirectoryCreateParams for more details.

• #initialize(client:) ⇒ Directory constructor private

  A new instance of Directory.

Constructor Details

#initialize(client:) ⇒ Directory

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Directory.

Parameters:

• client (FinchAPI::Client)

# File 'lib/finch_api/resources/sandbox/directory.rb', line 35

def initialize(client:)
  @client = client
end

Instance Method Details

#create(body: nil, request_options: {}) ⇒ Array<Object>

Some parameter documentations has been truncated, see Models::Sandbox::DirectoryCreateParams for more details.

Add new individuals to a sandbox company

Parameters:

• body (Array<FinchAPI::Models::Sandbox::DirectoryCreateParams::Body>) —

  Array of individuals to create. Takes all combined fields from ‘/individual` and

• request_options (FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Array<Object>)

See Also:

• Models::Sandbox::DirectoryCreateParams

# File 'lib/finch_api/resources/sandbox/directory.rb', line 21

def create(params = {})
  parsed, options = FinchAPI::Sandbox::DirectoryCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "sandbox/directory",
    body: parsed[:body],
    model: FinchAPI::Internal::Type::ArrayOf[FinchAPI::Internal::Type::Unknown],
    options: options
  )
end