Partner Channels

A PartnerChannel defines a structured communication path within a Partner root folder, including directional folder names and partner-scoped routing configuration.

List Partner Channels

SDK Method

partnerchannel.List()

Return Object

[]*PartnerChannel

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    partner_channel "github.com/Files-com/files-sdk-go/v3/partnerchannel"
)

partnerChannelIterator, err := partner_channel.List(files_sdk.PartnerChannelListParams{})
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 partnerChannelIterator.Next() {
    partnerChannel := partnerChannelIterator.partnerChannel()
}
err = partnerChannelIterator.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())
    }
}

Show Partner Channel

SDK Method

partnerchannel.Find()

Return Object

PartnerChannel

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

PartnerChannelFindParams Fields

FieldDescription
Id
int64
Required		Partner Channel ID.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    partner_channel "github.com/Files-com/files-sdk-go/v3/partnerchannel"
)

partnerChannel, err := partner_channel.Find(files_sdk.PartnerChannelFindParams{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())
    }
}

Create Partner Channel

SDK Method

partnerchannel.Create()

Return Object

PartnerChannel

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

PartnerChannelCreateParams Fields

FieldDefaultDescription
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
FromPartnerFolderName
string		Optional Channel-level from-Partner folder name override.
FromPartnerManagedFolderPaths
array(string)		Managed folder paths inside the from-Partner folder.
FromPartnerRoutePath
string		Optional route path for files uploaded by the Partner.
ToPartnerFolderName
string		Optional Channel-level to-Partner folder name override.
ToPartnerManagedFolderPaths
array(string)		Managed folder paths inside the to-Partner folder.
ToPartnerRoutePath
string		Optional route path for files delivered to the Partner.
PartnerId
int64
Required		ID of the Partner this Channel belongs to.
Path
string
Required		Channel path relative to the Partner root folder.
WorkspaceId
int64		0ID of the Workspace associated with this Partner Channel.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    partner_channel "github.com/Files-com/files-sdk-go/v3/partnerchannel"
)

partnerChannel, err := partner_channel.Create(files_sdk.PartnerChannelCreateParams{
  PartnerId: 1,
  Path: "claims/medical"
})
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())
    }
}

Update Partner Channel

SDK Method

partnerchannel.Update()

Return Object

PartnerChannel

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

PartnerChannelUpdateParams Fields

FieldDescription
Id
int64
Required		Partner Channel ID.
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
FromPartnerFolderName
string		Optional Channel-level from-Partner folder name override.
FromPartnerManagedFolderPaths
array(string)		Managed folder paths inside the from-Partner folder.
FromPartnerRoutePath
string		Optional route path for files uploaded by the Partner.
ToPartnerFolderName
string		Optional Channel-level to-Partner folder name override.
ToPartnerManagedFolderPaths
array(string)		Managed folder paths inside the to-Partner folder.
ToPartnerRoutePath
string		Optional route path for files delivered to the Partner.
Path
string		Channel path relative to the Partner root folder.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    partner_channel "github.com/Files-com/files-sdk-go/v3/partnerchannel"
)

partnerChannel, err := partner_channel.Update(files_sdk.PartnerChannelUpdateParams{
  Id: 1,
  Direction: "two_way"
})
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 Channel

SDK Method

partnerchannel.Delete()

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.

PartnerChannelDeleteParams Fields

FieldDescription
Id
int64
Required		Partner Channel ID.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    partner_channel "github.com/Files-com/files-sdk-go/v3/partnerchannel"
)

err := partner_channel.Delete(files_sdk.PartnerChannelDeleteParams{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 PartnerChannel Object

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

AttributeDescription
Id
int64		The unique ID of the Partner Channel.
WorkspaceId
int64		ID of the Workspace associated with this Partner Channel.
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
PartnerId
int64		ID of the Partner this Channel belongs to.
PartnerChannelTemplateId
int64		ID of the Partner Channel Template that manages this Channel, if any.
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.
ToPartnerFolderName
string		Optional Channel-level to-Partner folder name override.
FromPartnerFolderName
string		Optional Channel-level from-Partner folder name override.
FromPartnerRoutePath
string		Optional route path for files uploaded by the Partner.
ToPartnerRoutePath
string		Optional route path for files delivered to the Partner.
ToPartnerManagedFolderPaths
array(string)		Managed folder paths inside the to-Partner folder.
FromPartnerManagedFolderPaths
array(string)		Managed folder paths inside the from-Partner folder.
EffectiveToPartnerFolderName
string		Resolved to-Partner folder name after Channel override and default.
EffectiveFromPartnerFolderName
string		Resolved from-Partner folder name after Channel override and default.
ChannelPath
string		Resolved Channel folder path.
ToPartnerFolderPath
string		Resolved to-Partner folder path.
FromPartnerFolderPath
string		Resolved from-Partner folder path.