Bundle Recipients

A BundleRecipient is a person who has had a bundle shared with them via email invite. A Bundle can be re-shared with a Bundle Recipient by sending a create request with the inbox_id, recipient email address, and share_after_create => true.

List Share Link Recipients

SDK Method

bundle_recipient.List()

Return Values

Returns a *bundle_recipient.Iter and an error. Range over All() to receive files_sdk.BundleRecipient values and errors. Check each loop error before using its resource. Next() and Err() remain supported.

Authorization Requirement

Available to all authenticated keys or sessions.

BundleRecipientListParams Fields

FieldDescription
UserId
int64		User ID. Provide a value of 0 to operate the current session's user.
BundleId
int64
Required		List recipients for the bundle with this ID.

Additional Arguments

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    bundle_recipient "github.com/Files-com/files-sdk-go/v3/bundlerecipient"
)

bundleRecipientIterator, err := bundle_recipient.List(files_sdk.BundleRecipientListParams{BundleId: 1})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
    } else {
        fmt.Printf("Request failed: %v\n", err)
    }
    return
}

for bundleRecipient, err := range bundleRecipientIterator.All() {
    if err != nil {
        var respErr files_sdk.ResponseError
        if errors.As(err, &respErr) {
            fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
        } else {
            fmt.Printf("Request failed: %v\n", err)
        }
        return
    }
    fmt.Println(bundleRecipient)
}

Create Share Link Recipient

SDK Method

bundle_recipient.Create()

Return Values

Returns a files_sdk.BundleRecipient value and an error.

Authorization Requirement

Available to all authenticated keys or sessions.

BundleRecipientCreateParams Fields

FieldDescription
UserId
int64		User ID. Provide a value of 0 to operate the current session's user.
BundleId
int64
Required		Bundle to share.
Recipient
string
Required		Email addresses to share this bundle with.
Name
string		Name of recipient.
Company
string		Company of recipient.
Note
string		Note to include in email.
ShareAfterCreate
boolean		Set to true to share the link with the recipient upon creation.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    bundle_recipient "github.com/Files-com/files-sdk-go/v3/bundlerecipient"
)

bundleRecipient, err := bundle_recipient.Create(files_sdk.BundleRecipientCreateParams{
  BundleId: 1,
  Recipient: "johndoe@gmail.com",
})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
    } else {
        fmt.Printf("Request failed: %v\n", err)
    }
    return
}
fmt.Println(bundleRecipient)

The BundleRecipient Object

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

AttributeDescription
Company
string		The recipient's company.
Name
string		The recipient's name.
Note
string		A note sent to the recipient with the bundle.
Recipient
string		The recipient's email address.
SentAt
date-time		When the Bundle was shared with this recipient.
WorkspaceId
int64		Workspace ID. 0 means the default workspace.