Partner Site Requests

A PartnerSiteRequest represents a request for a Guest Partner to add their Files.com Site to their Partnership with the Host Partner. The Guest Partner's Files.com Site is referred to as the Guest Site in this relationship.

The Partner Admin user representing the Guest on the Host Partner can initiate a request, which generates a pairing key. The Guest Site admin must then approve the request. This ensures that the Partner Admin user representing the Guest on the Host Partner and the Site Admins of the Site are in agreement that the linking should occur.

List Partner Site Requests

SDK Method

\Files\Model\PartnerSiteRequest::list;

Return Object

PartnerSiteRequest[]

Authorization Requirement

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

Additional Arguments

Example Request

try {
  $partner_site_requests = \Files\Model\PartnerSiteRequest::list();
  foreach ($partner_site_requests as $partner_site_request) {
    // Operate on $partner_site_request
  }
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Find partner site request by pairing key

SDK Method

\Files\Model\PartnerSiteRequest::findByPairingKey;

Return Object

No return value.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator.

Method Arguments

ArgumentDescription
pairing_key
string
Required		Pairing key for the partner site request

Example Request

try {
  \Files\Model\PartnerSiteRequest::findByPairingKey([
    'pairing_key' => "pairing_key"
  ]);
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Create Partner Site Request

SDK Method

\Files\Model\PartnerSiteRequest::create;

Return Object

PartnerSiteRequest

Authorization Requirement

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

Method Arguments

ArgumentDescription
host_partner_id
int64
Required		Host Partner ID to link with
guest_site_url
string
Required		Guest Site URL to link to

Example Request

try {
  $partner_site_request = \Files\Model\PartnerSiteRequest::create([
    'host_partner_id' => 1,
    'guest_site_url' => "guest_site_url"
  ]);
  // Operate on $partner_site_request
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Reject partner site request

SDK Method

\Files\Model\PartnerSiteRequest::reject;

Return Object

No return value.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator.

Method Arguments

ArgumentDescription
pairing_key
string
Required		Pairing key for the partner site request

Example Request

try {
  \Files\Model\PartnerSiteRequest::reject([
    'pairing_key' => "pairing_key"
  ]);
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Approve partner site request

SDK Method

\Files\Model\PartnerSiteRequest::approve;

Return Object

No return value.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator.

Method Arguments

ArgumentDescription
pairing_key
string
Required		Pairing key for the partner site request
partner_id
int64		ID of an existing Partner on this site, with the host role, that represents the requesting organization. The connection binds to that Partner and makes it host_and_guest. When omitted, a guest Partner named after the host site is created.

Example Request

try {
  \Files\Model\PartnerSiteRequest::approve([
    'pairing_key' => "pairing_key"
  ]);
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Delete Partner Site Request

SDK Method

$partner_site_request->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, a Workspace Administrator for the relevant workspace, or a Partner Administrator for the relevant partner.

Example Request

try {
  $partner_site_request = \Files\Model\PartnerSiteRequest::list()[0];
  $partner_site_request->delete();
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

The PartnerSiteRequest Object

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

AttributeDescription
id
int64		Partner Site Request ID
host_partner_id
int64		Host Partner ID
guest_site_url
string		Guest Site URL
status
string		Request status (pending, approved, rejected)
Possible values: pending, approved, rejected
host_site_name
string		Host Site Name
pairing_key
string		Pairing key used to approve this request on the Guest Site
created_at
date-time		Request creation date/time
updated_at
date-time		Request last updated date/time