Skip to content

Latest commit

 

History

History
306 lines (190 loc) · 13.4 KB

README.md

File metadata and controls

306 lines (190 loc) · 13.4 KB

Uc

(uc)

Overview

Available Operations

create_uc_contact

Create a contact

Example Usage

require 'unified_ruby_sdk'


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

    
res = s.uc.create_uc_contact(connection_id="<id>", uc_contact=::UnifiedRubySDK::Shared::UcContact.new(), fields_=[
  "<value>",
])

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

Parameters

Parameter Type Required Description
connection_id ::String ✔️ ID of the connection
uc_contact T.nilable(::UnifiedRubySDK::Shared::UcContact) ➖ A contact represents a person that optionally is associated with a call
fields_ T::Array<::String> ➖ Comma-delimited fields to return

Response

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

get_uc_contact

Retrieve a contact

Example Usage

require 'unified_ruby_sdk'


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

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

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

Parameters

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

Response

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

list_uc_calls

List all calls

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::ListUcCallsRequest.new(
  connection_id: "<id>",
)
    
res = s.uc.list_uc_calls(req)

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

Parameters

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

Response

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

list_uc_contacts

List all contacts

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::ListUcContactsRequest.new(
  connection_id: "<id>",
)
    
res = s.uc.list_uc_contacts(req)

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

Parameters

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

Response

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

patch_uc_contact

Update a contact

Example Usage

require 'unified_ruby_sdk'


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

    
res = s.uc.patch_uc_contact(connection_id="<id>", id="<id>", uc_contact=::UnifiedRubySDK::Shared::UcContact.new(), fields_=[
  "<value>",
])

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

Parameters

Parameter Type Required Description
connection_id ::String ✔️ ID of the connection
id ::String ✔️ ID of the Contact
uc_contact T.nilable(::UnifiedRubySDK::Shared::UcContact) ➖ A contact represents a person that optionally is associated with a call
fields_ T::Array<::String> ➖ Comma-delimited fields to return

Response

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

remove_uc_contact

Remove a contact

Example Usage

require 'unified_ruby_sdk'


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

    
res = s.uc.remove_uc_contact(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 Contact

Response

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

update_uc_contact

Update a contact

Example Usage

require 'unified_ruby_sdk'


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

    
res = s.uc.update_uc_contact(connection_id="<id>", id="<id>", uc_contact=::UnifiedRubySDK::Shared::UcContact.new(), fields_=[
  "<value>",
])

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

Parameters

Parameter Type Required Description
connection_id ::String ✔️ ID of the connection
id ::String ✔️ ID of the Contact
uc_contact T.nilable(::UnifiedRubySDK::Shared::UcContact) ➖ A contact represents a person that optionally is associated with a call
fields_ T::Array<::String> ➖ Comma-delimited fields to return

Response

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