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_sdk.partner_site_request.list()

Return Object

ListObj[PartnerSiteRequest]

Authorization Requirement

Available to all authenticated keys or sessions.

Additional Arguments

Example Request

import files_sdk

try:
  partner_site_requests = files_sdk.partner_site_request.list()
  for partner_site_request in partner_site_requests.auto_paging_iter():
    # Operate on partner_site_request
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Find partner site request by pairing key

SDK Method

files_sdk.partner_site_request.find_by_pairing_key()

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.

Method Arguments

ArgumentDescription
pairing_key
string
Required		Pairing key for the partner site request

Example Request

import files_sdk

try:
  files_sdk.partner_site_request.find_by_pairing_key({
    "pairing_key": "pairing_key"
  })
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Create Partner Site Request

SDK Method

files_sdk.partner_site_request.create()

Return Object

PartnerSiteRequest

Authorization Requirement

Available to all authenticated keys or sessions.

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

import files_sdk

try:
  partner_site_request = files_sdk.partner_site_request.create({
    "host_partner_id": 1,
    "guest_site_url": "guest_site_url"
  })
  # Operate on partner_site_request
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Reject partner site request

SDK Method

files_sdk.partner_site_request.reject()

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.

Method Arguments

ArgumentDescription
pairing_key
string
Required		Pairing key for the partner site request

Example Request

import files_sdk

try:
  files_sdk.partner_site_request.reject({
    "pairing_key": "pairing_key"
  })
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Approve partner site request

SDK Method

files_sdk.partner_site_request.approve()

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.

Method Arguments

ArgumentDescription
pairing_key
string
Required		Pairing key for the partner site request

Example Request

import files_sdk

try:
  files_sdk.partner_site_request.approve({
    "pairing_key": "pairing_key"
  })
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Delete Partner Site Request

SDK Method

partner_site_request.delete()

Return Object

No return value.

Authorization Requirement

Available to all authenticated keys or sessions.

Example Request

import files_sdk

try:
  partner_site_request = files_sdk.partner_site_request.list.first
  partner_site_request.delete()
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

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