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

partnersiterequest.List()

Return Object

[]*PartnerSiteRequest

Authorization Requirement

Available to all authenticated keys or sessions.

Additional Arguments

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    partner_site_request "github.com/Files-com/files-sdk-go/v3/partnersiterequest"
)

partnerSiteRequestIterator, err := partner_site_request.List(files_sdk.PartnerSiteRequestListParams{})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

for partnerSiteRequestIterator.Next() {
    partnerSiteRequest := partnerSiteRequestIterator.partnerSiteRequest()
}
err = partnerSiteRequestIterator.Err()
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

Find partner site request by pairing key

SDK Method

partnersiterequest.FindByPairingKey()

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.

PartnerSiteRequestFindByPairingKeyParams Fields

FieldDescription
PairingKey
string
Required		Pairing key for the partner site request

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    partner_site_request "github.com/Files-com/files-sdk-go/v3/partnersiterequest"
)

err := partner_site_request.FindByPairingKey(files_sdk.PartnerSiteRequestFindByPairingKeyParams{PairingKey: "pairing_key"})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

Create Partner Site Request

SDK Method

partnersiterequest.Create()

Return Object

PartnerSiteRequest

Authorization Requirement

Available to all authenticated keys or sessions.

PartnerSiteRequestCreateParams Fields

FieldDescription
HostPartnerId
int64
Required		Host Partner ID to link with
GuestSiteUrl
string
Required		Guest Site URL to link to

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    partner_site_request "github.com/Files-com/files-sdk-go/v3/partnersiterequest"
)

partnerSiteRequest, err := partner_site_request.Create(files_sdk.PartnerSiteRequestCreateParams{
  HostPartnerId: 1,
  GuestSiteUrl: "guest_site_url"
})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

Reject partner site request

SDK Method

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

PartnerSiteRequestRejectParams Fields

FieldDescription
PairingKey
string
Required		Pairing key for the partner site request

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    partner_site_request "github.com/Files-com/files-sdk-go/v3/partnersiterequest"
)

err := partner_site_request.Reject(files_sdk.PartnerSiteRequestRejectParams{PairingKey: "pairing_key"})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

Approve partner site request

SDK Method

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

PartnerSiteRequestApproveParams Fields

FieldDescription
PairingKey
string
Required		Pairing key for the partner site request

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    partner_site_request "github.com/Files-com/files-sdk-go/v3/partnersiterequest"
)

err := partner_site_request.Approve(files_sdk.PartnerSiteRequestApproveParams{PairingKey: "pairing_key"})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

Delete Partner Site Request

SDK Method

partnersiterequest.Delete()

Return Object

No return value.

Authorization Requirement

Available to all authenticated keys or sessions.

PartnerSiteRequestDeleteParams Fields

FieldDescription
Id
int64
Required		Partner Site Request ID.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    partner_site_request "github.com/Files-com/files-sdk-go/v3/partnersiterequest"
)

err := partner_site_request.Delete(files_sdk.PartnerSiteRequestDeleteParams{Id: 1})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

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
HostPartnerId
int64		Host Partner ID
GuestSiteUrl
string		Guest Site URL
Status
string		Request status (pending, approved, rejected)
Possible values: pending, approved, rejected
HostSiteName
string		Host Site Name
PairingKey
string		Pairing key used to approve this request on the Guest Site
CreatedAt
date-time		Request creation date/time
UpdatedAt
date-time		Request last updated date/time