Partner Channels

A PartnerChannel defines a structured communication path within a Partner root folder, including directional folder names and partner-scoped routing configuration.

List Partner Channels

SDK Method

Files::PartnerChannel.list

Return Object

List<PartnerChannel>

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

begin
  partner_channels = Files::PartnerChannel.list
  partner_channels.auto_paging_each do |partner_channel|
    # Operate on partner_channel
  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

Show Partner Channel

SDK Method

Files::PartnerChannel.find

Return Object

PartnerChannel

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
id
int64
Required		Partner Channel ID.

Example Request

begin
  partner_channel = Files::PartnerChannel.find(id)
  # Operate on partner_channel
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 Partner Channel

SDK Method

Files::PartnerChannel.create

Return Object

PartnerChannel

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDefaultDescription
direction
string		"two_way"Channel directions. two_way enables both directions, to_partner enables outgoing downloads, and from_partner enables incoming uploads.
Possible values: two_way, to_partner, from_partner
from_partner_folder_name
string		Optional Channel-level from-Partner folder name override.
from_partner_managed_folder_paths
array(string)		Managed folder paths inside the from-Partner folder.
from_partner_route_path
string		Optional route path for files uploaded by the Partner.
to_partner_folder_name
string		Optional Channel-level to-Partner folder name override.
to_partner_managed_folder_paths
array(string)		Managed folder paths inside the to-Partner folder.
to_partner_route_path
string		Optional route path for files delivered to the Partner.
partner_id
int64
Required		ID of the Partner this Channel belongs to.
path
string
Required		Channel path relative to the Partner root folder.
workspace_id
int64		0ID of the Workspace associated with this Partner Channel.

Example Request

begin
  partner_channel = Files::PartnerChannel.create(
    partner_id: 1,
    path: "claims/medical"
  )
  # Operate on partner_channel
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

Update Partner Channel

SDK Method

partner_channel.update

Return Object

PartnerChannel

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
direction
string		Channel directions. two_way enables both directions, to_partner enables outgoing downloads, and from_partner enables incoming uploads.
Possible values: two_way, to_partner, from_partner
from_partner_folder_name
string		Optional Channel-level from-Partner folder name override.
from_partner_managed_folder_paths
array(string)		Managed folder paths inside the from-Partner folder.
from_partner_route_path
string		Optional route path for files uploaded by the Partner.
to_partner_folder_name
string		Optional Channel-level to-Partner folder name override.
to_partner_managed_folder_paths
array(string)		Managed folder paths inside the to-Partner folder.
to_partner_route_path
string		Optional route path for files delivered to the Partner.
path
string		Channel path relative to the Partner root folder.

Example Request

begin
  # Find the partner_channel object by its id.
  partner_channel = Files::PartnerChannel.find(id)
  partner_channel.update(
    direction: "two_way"
  )
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

Delete Partner Channel

SDK Method

partner_channel.delete

Return Object

nil

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Example Request

begin
  # Find the partner_channel object by its id.
  partner_channel = Files::PartnerChannel.find(id)
  partner_channel.delete
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 PartnerChannel Object

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

AttributeDescription
id
int64		The unique ID of the Partner Channel.
workspace_id
int64		ID of the Workspace associated with this Partner Channel.
direction
string		Channel directions. two_way enables both directions, to_partner enables outgoing downloads, and from_partner enables incoming uploads.
Possible values: two_way, to_partner, from_partner
partner_id
int64		ID of the Partner this Channel belongs to.
partner_channel_template_id
int64		ID of the Partner Channel Template that manages this Channel, if any.
path
string		Channel path relative to the Partner root folder. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
to_partner_folder_name
string		Optional Channel-level to-Partner folder name override.
from_partner_folder_name
string		Optional Channel-level from-Partner folder name override.
from_partner_route_path
string		Optional route path for files uploaded by the Partner.
to_partner_route_path
string		Optional route path for files delivered to the Partner.
to_partner_managed_folder_paths
array(string)		Managed folder paths inside the to-Partner folder.
from_partner_managed_folder_paths
array(string)		Managed folder paths inside the from-Partner folder.
effective_to_partner_folder_name
string		Resolved to-Partner folder name after Channel override and default.
effective_from_partner_folder_name
string		Resolved from-Partner folder name after Channel override and default.
channel_path
string		Resolved Channel folder path.
to_partner_folder_path
string		Resolved to-Partner folder path.
from_partner_folder_path
string		Resolved from-Partner folder path.