Skip to content

Latest commit

 

History

History
263 lines (164 loc) · 12.1 KB

README.md

File metadata and controls

263 lines (164 loc) · 12.1 KB

File

(file)

Overview

Available Operations

create_storage_file

Create a file

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.file.create_storage_file(connection_id="<id>", storage_file=::UnifiedRubySDK::Shared::StorageFile.new(), fields_=[
  "<value>",
])

if ! res.storage_file.nil?
  # handle response
end

Parameters

Parameter Type Required Description
connection_id ::String ✔️ ID of the connection
storage_file T.nilable(::UnifiedRubySDK::Shared::StorageFile) ➖ N/A
fields_ T::Array<::String> ➖ Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::CreateStorageFileResponse)

get_storage_file

Retrieve a file

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.file.get_storage_file(connection_id="<id>", id="<id>", fields_=[
  "<value>",
])

if ! res.storage_file.nil?
  # handle response
end

Parameters

Parameter Type Required Description
connection_id ::String ✔️ ID of the connection
id ::String ✔️ ID of the File
fields_ T::Array<::String> ➖ Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::GetStorageFileResponse)

list_storage_files

List all files

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)


req = ::UnifiedRubySDK::Operations::ListStorageFilesRequest.new(
  connection_id: "<id>",
)
    
res = s.file.list_storage_files(req)

if ! res.storage_files.nil?
  # handle response
end

Parameters

Parameter Type Required Description
request ::UnifiedRubySDK::Operations::ListStorageFilesRequest ✔️ The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::ListStorageFilesResponse)

patch_storage_file

Update a file

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.file.patch_storage_file(connection_id="<id>", id="<id>", storage_file=::UnifiedRubySDK::Shared::StorageFile.new(), fields_=[
  "<value>",
])

if ! res.storage_file.nil?
  # handle response
end

Parameters

Parameter Type Required Description
connection_id ::String ✔️ ID of the connection
id ::String ✔️ ID of the File
storage_file T.nilable(::UnifiedRubySDK::Shared::StorageFile) ➖ N/A
fields_ T::Array<::String> ➖ Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::PatchStorageFileResponse)

remove_storage_file

Remove a file

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.file.remove_storage_file(connection_id="<id>", id="<id>")

if res.status_code == 200
  # handle response
end

Parameters

Parameter Type Required Description
connection_id ::String ✔️ ID of the connection
id ::String ✔️ ID of the File

Response

T.nilable(::UnifiedRubySDK::Operations::RemoveStorageFileResponse)

update_storage_file

Update a file

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.file.update_storage_file(connection_id="<id>", id="<id>", storage_file=::UnifiedRubySDK::Shared::StorageFile.new(), fields_=[
  "<value>",
])

if ! res.storage_file.nil?
  # handle response
end

Parameters

Parameter Type Required Description
connection_id ::String ✔️ ID of the connection
id ::String ✔️ ID of the File
storage_file T.nilable(::UnifiedRubySDK::Shared::StorageFile) ➖ N/A
fields_ T::Array<::String> ➖ Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::UpdateStorageFileResponse)