Bundle Recipients

A BundleRecipient is a person who has had a bundle shared with them via email invite. A Bundle can be re-shared with a Bundle Recipient by sending a create request with the inbox_id, recipient email address, and share_after_create => true.

List Share Link Recipients

SDK Method

Files::BundleRecipient.list

Return Object

List<BundleRecipient>

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
user_id
int64		User ID. Provide a value of 0 to operate the current session's user.
bundle_id
int64
Required		List recipients for the bundle with this ID.

Additional Arguments

Example Request

begin
  bundle_recipients = Files::BundleRecipient.list(
    bundle_id: 1
  )
  bundle_recipients.auto_paging_each do |bundle_recipient|
    # Operate on bundle_recipient
  end
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Create Share Link Recipient

SDK Method

Files::BundleRecipient.create

Return Object

BundleRecipient

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
user_id
int64		User ID. Provide a value of 0 to operate the current session's user.
bundle_id
int64
Required		Bundle to share.
recipient
string
Required		Email addresses to share this bundle with.
name
string		Name of recipient.
company
string		Company of recipient.
note
string		Note to include in email.
share_after_create
boolean		Set to true to share the link with the recipient upon creation.

Example Request

begin
  bundle_recipient = Files::BundleRecipient.create(
    bundle_id: 1,
    recipient: "johndoe@gmail.com"
  )
  # Operate on bundle_recipient
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

The BundleRecipient Object

Some of the methods above return a BundleRecipient object. The attributes of this object are listed below.

AttributeDescription
company
string		The recipient's company.
name
string		The recipient's name.
note
string		A note sent to the recipient with the bundle.
recipient
string		The recipient's email address.
sent_at
date-time		When the Bundle was shared with this recipient.
workspace_id
int64		Workspace ID. 0 means the default workspace.