restoredfiles

Documentation

Overview

Package restoredfiles contains methods related to RestoredFiles

Index

• type RestoredFilesV1
  • func (r *RestoredFilesV1) DownloadSharedFile(body *models.DownloadSharedFileV1Request) (*models.DownloadSharedFileResponse, *apiutils.APIError)
  • func (r *RestoredFilesV1) GenerateRestoredFilePasscode(restoredFileId string) (*models.GenerateRestoredFilePasscodeResponse, *apiutils.APIError)
  • func (r *RestoredFilesV1) ListRestoredFiles(limit *int64, start *string, filter string) (*models.RestoredFilesResponse, *apiutils.APIError)
  • func (r *RestoredFilesV1) RestoreFiles(embed *string, body models.RestoreFilesV1Request) (*models.RestoreFileResponse, *apiutils.APIError)
  • func (r *RestoredFilesV1) ShareRestoredFile(restoredFileId string, body *models.ShareRestoredFileV1Request) (*models.ShareFileRestoreEmailResponse, *apiutils.APIError)
• type RestoredFilesV1Client
  • func NewRestoredFilesV1(config config.Config) RestoredFilesV1Client

Types

type RestoredFilesV1

type RestoredFilesV1 struct {
	// contains filtered or unexported fields
}

RestoredFilesV1 represents a custom type struct

func (*RestoredFilesV1) DownloadSharedFile

func (r *RestoredFilesV1) DownloadSharedFile(
	body *models.DownloadSharedFileV1Request) (
	*models.DownloadSharedFileResponse, *apiutils.APIError)

DownloadSharedFile Downloads one or more restored files, bundled into a ZIP file, that another user shared with you by email.

func (*RestoredFilesV1) GenerateRestoredFilePasscode

func (r *RestoredFilesV1) GenerateRestoredFilePasscode(
	restoredFileId string) (
	*models.GenerateRestoredFilePasscodeResponse, *apiutils.APIError)

GenerateRestoredFilePasscode Generates a new passcode to access restored files shared by email. A passcode is

automatically generated when you share restored files by email. Only regenerate a
passcode if you (or the recipient) have lost the original passcode. When you
regenerate a new passcode, the old one becomes invalid.

func (*RestoredFilesV1) ListRestoredFiles

func (r *RestoredFilesV1) ListRestoredFiles(
	limit *int64,
	start *string,
	filter string) (
	*models.RestoredFilesResponse, *apiutils.APIError)

ListRestoredFiles Gets the list of active restored files for an asset.

func (*RestoredFilesV1) RestoreFiles

func (r *RestoredFilesV1) RestoreFiles(
	embed *string,
	body models.RestoreFilesV1Request) (
	*models.RestoreFileResponse, *apiutils.APIError)

RestoreFiles Restores one or more files from the specified backup.

func (*RestoredFilesV1) ShareRestoredFile

func (r *RestoredFilesV1) ShareRestoredFile(
	restoredFileId string,
	body *models.ShareRestoredFileV1Request) (
	*models.ShareFileRestoreEmailResponse, *apiutils.APIError)

ShareRestoredFile Sends a downloadable link to the specified email recipient to access restored files

shared by email. Restored files are initially sent by email using
[POST /restores/files](#operation/restore-files). After you send the initial email to one user, you can run
this endpoint to share the email with additional users or to resend the email to
the initial user. Also send the passcode generated from
[POST /restores/files](#operation/restore-files) to these users so they can access
the restored files.

type RestoredFilesV1Client

type RestoredFilesV1Client interface {
	// ListRestoredFiles Gets the list of active restored files for an asset.
	ListRestoredFiles(
		limit *int64,
		start *string,
		filter string) (
		*models.RestoredFilesResponse, *apiutils.APIError)

	// RestoreFiles Restores one or more files from the specified backup.
	RestoreFiles(
		embed *string,
		body models.RestoreFilesV1Request) (
		*models.RestoreFileResponse, *apiutils.APIError)

	// DownloadSharedFile Downloads one or more restored files, bundled into a ZIP file, that another user shared with you by email.
	DownloadSharedFile(
		body *models.DownloadSharedFileV1Request) (
		*models.DownloadSharedFileResponse, *apiutils.APIError)

	// GenerateRestoredFilePasscode Generates a new passcode to access restored files shared by email. A passcode is
	//  automatically generated when you share restored files by email. Only regenerate a
	//  passcode if you (or the recipient) have lost the original passcode. When you
	//  regenerate a new passcode, the old one becomes invalid.
	GenerateRestoredFilePasscode(
		restoredFileId string) (
		*models.GenerateRestoredFilePasscodeResponse, *apiutils.APIError)

	// ShareRestoredFile Sends a downloadable link to the specified email recipient to access restored files
	//  shared by email. Restored files are initially sent by email using
	//  [POST /restores/files](#operation/restore-files). After you send the initial email to one user, you can run
	//  this endpoint to share the email with additional users or to resend the email to
	//  the initial user. Also send the passcode generated from
	//  [POST /restores/files](#operation/restore-files) to these users so they can access
	//  the restored files.
	ShareRestoredFile(
		restoredFileId string,
		body *models.ShareRestoredFileV1Request) (
		*models.ShareFileRestoreEmailResponse, *apiutils.APIError)
}

RestoredFilesV1Client represents a custom type interface

func NewRestoredFilesV1

func NewRestoredFilesV1(config config.Config) RestoredFilesV1Client

NewRestoredFilesV1 returns RestoredFilesV1Client