Partner Channel Templates

A PartnerChannelTemplate defines reusable Partner Channel configuration that can be applied to Partners.

Route path patterns can be fixed paths shared by all assigned Partners, or include {{partner_name}} to expand to a single folder name. Slashes in Partner names become pipes (|). Leading and trailing whitespace, percent signs, and null bytes are percent-encoded. Names consisting of . or .. become %2E or %2E%2E. For example, a Partner named "Acme " uses the folder "Acme%20", while "Acme%20" uses "Acme%2520". These percent sequences are literal folder-name characters, not URL encoding to decode. The expanded route must point to an existing folder in the same Workspace.

List Partner Channel Templates

SDK Method

PartnerChannelTemplate.list()

Return Object

PartnerChannelTemplate[]

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

Additional Arguments

Example Request

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

try {
  const partnerChannelTemplates = await PartnerChannelTemplate.list();
  for (const partnerChannelTemplate of partnerChannelTemplates) {
    // Operate on partnerChannelTemplate
  }
} 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 Template

SDK Method

PartnerChannelTemplate.find()

Return Object

PartnerChannelTemplate

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

Method Arguments

ArgumentDescription
id
int64
Required		Partner Channel Template ID.

Example Request

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

try {
  const partnerChannelTemplate = await PartnerChannelTemplate.find(id);
  // Operate on partnerChannelTemplate
} 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 Template

SDK Method

PartnerChannelTemplate.create()

Return Object

PartnerChannelTemplate

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

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
use_channel_root
boolean		falseUse the Channel folder directly for a one-way exchange. Defaults to false. Cannot be changed after creation. Folder name overrides must be blank when enabled, and the Template must remain one-way.
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_pattern
string		Optional route path pattern for files uploaded by the Partner. Supports {{partner_name}}.
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_pattern
string		Optional route path pattern for files delivered to the Partner. Supports {{partner_name}}.
name
string
Required		The name of the Partner Channel Template.
path
string
Required		Channel path relative to the Partner root folder.
workspace_id
int64		0ID of the Workspace associated with this Partner Channel Template.

Example Request

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

try {
  const partnerChannelTemplate = await PartnerChannelTemplate.create({
    name: "Claims Template",
    path: "claims/medical",
  });
  // Operate on partnerChannelTemplate
} 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 Template

SDK Method

partnerChannelTemplate.update()

Return Object

PartnerChannelTemplate

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

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
use_channel_root
boolean		Use the Channel folder directly for a one-way exchange. Defaults to false. Cannot be changed after creation. Folder name overrides must be blank when enabled, and the Template must remain one-way.
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_pattern
string		Optional route path pattern for files uploaded by the Partner. Supports {{partner_name}}.
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_pattern
string		Optional route path pattern for files delivered to the Partner. Supports {{partner_name}}.
name
string		The name of the Partner Channel Template.
path
string		Channel path relative to the Partner root folder.

Example Request

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

try {
  // Find the partnerChannelTemplate object by its id.
  const partnerChannelTemplate = await PartnerChannelTemplate.find(id);
  await partnerChannelTemplate.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 Template

SDK Method

partnerChannelTemplate.delete()

Return Object

No return value.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

Example Request

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

try {
  // Find the partnerChannelTemplate object by its id.
  const partnerChannelTemplate = await PartnerChannelTemplate.find(id);
  await partnerChannelTemplate.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 PartnerChannelTemplate Object

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

AttributeDescription
id
int64		The unique ID of the Partner Channel Template.
workspace_id
int64		ID of the Workspace associated with this Partner Channel Template.
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
use_channel_root
boolean		Use the Channel folder directly for a one-way exchange. Defaults to false. Cannot be changed after creation. Folder name overrides must be blank when enabled, and the Template must remain one-way.
name
string		The name of the Partner Channel Template.
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_pattern
string		Optional route path pattern for files uploaded by the Partner. Supports {{partner_name}}.
to_partner_route_path_pattern
string		Optional route path pattern for files delivered to the Partner. Supports {{partner_name}}.
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 subfolder name. Null when the direction is disabled or uses the Channel folder directly.
effective_from_partner_folder_name
string		Resolved from-Partner subfolder name. Null when the direction is disabled or uses the Channel folder directly.