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

PartnerChannel.list()

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.

Additional Arguments

Example Request

import PartnerChannel from 'files.com/lib/models/PartnerChannel';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const partnerChannels = await PartnerChannel.list();
  for (const partnerChannel of partnerChannels) {
    // Operate on partnerChannel
  }
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

Show Partner Channel

SDK Method

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

import PartnerChannel from 'files.com/lib/models/PartnerChannel';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const partnerChannel = await PartnerChannel.find(id);
  // Operate on partnerChannel
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

Create Partner Channel

SDK Method

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

import PartnerChannel from 'files.com/lib/models/PartnerChannel';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const partnerChannel = await PartnerChannel.create({
    partner_id: 1,
    path: "claims/medical",
  });
  // Operate on partnerChannel
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

Update Partner Channel

SDK Method

partnerChannel.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

import PartnerChannel from 'files.com/lib/models/PartnerChannel';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  // Find the partnerChannel object by its id.
  const partnerChannel = await PartnerChannel.find(id);
  await partnerChannel.update({
    direction: "two_way",
  });
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

Delete Partner Channel

SDK Method

partnerChannel.delete()

Return Object

No return value.

Authorization Requirement

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

Example Request

import PartnerChannel from 'files.com/lib/models/PartnerChannel';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  // Find the partnerChannel object by its id.
  const partnerChannel = await PartnerChannel.find(id);
  await partnerChannel.delete();
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

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.