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::PartnerSiteRequest.list

Return Object

List<PartnerSiteRequest>

Authorization Requirement

Available to all authenticated keys or sessions.

Additional Arguments

Example Request

begin
  partner_site_requests = Files::PartnerSiteRequest.list
  partner_site_requests.auto_paging_each do |partner_site_request|
    # Operate on partner_site_request
  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

Find partner site request by pairing key

SDK Method

Files::PartnerSiteRequest.find_by_pairing_key

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.

Method Arguments

ArgumentDescription
pairing_key
string
Required		Pairing key for the partner site request

Example Request

begin
  Files::PartnerSiteRequest.find_by_pairing_key(
    pairing_key: "pairing_key"
  )
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 Site Request

SDK Method

Files::PartnerSiteRequest.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

begin
  partner_site_request = Files::PartnerSiteRequest.create(
    host_partner_id: 1,
    guest_site_url: "guest_site_url"
  )
  # Operate on partner_site_request
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

Reject partner site request

SDK Method

Files::PartnerSiteRequest.reject

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.

Method Arguments

ArgumentDescription
pairing_key
string
Required		Pairing key for the partner site request

Example Request

begin
  Files::PartnerSiteRequest.reject(
    pairing_key: "pairing_key"
  )
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

Approve partner site request

SDK Method

Files::PartnerSiteRequest.approve

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.

Method Arguments

ArgumentDescription
pairing_key
string
Required		Pairing key for the partner site request

Example Request

begin
  Files::PartnerSiteRequest.approve(
    pairing_key: "pairing_key"
  )
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 Site Request

SDK Method

partner_site_request.delete

Return Object

nil

Authorization Requirement

Available to all authenticated keys or sessions.

Example Request

begin
  partner_site_request = Files::PartnerSiteRequest.list.first
  partner_site_request.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 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