files.com/src/models/InboxRecipient.js

Files.com SDK for JavaScript

/* eslint-disable no-unused-vars */
import Api from '../Api'
import * as errors from '../Errors'
import {
  getType, isArray, isInt, isObject, isString,
} from '../utils'
/* eslint-enable no-unused-vars */

/**
 * Class InboxRecipient
 */
class InboxRecipient {
  attributes = {}

  options = {}

  constructor(attributes = {}, options = {}) {
    Object.entries(attributes).forEach(([key, value]) => {
      const normalizedKey = key.replace('?', '')

      this.attributes[normalizedKey] = value

      Object.defineProperty(this, normalizedKey, { value, writable: false })
    })

    this.options = { ...options }
  }

  isLoaded = () => !!this.attributes.id

  // string # The recipient's company.
  getCompany = () => this.attributes.company

  setCompany = value => {
    this.attributes.company = value
  }

  // string # The recipient's name.
  getName = () => this.attributes.name

  setName = value => {
    this.attributes.name = value
  }

  // string # A note sent to the recipient with the inbox.
  getNote = () => this.attributes.note

  setNote = value => {
    this.attributes.note = value
  }

  // string # The recipient's email address.
  getRecipient = () => this.attributes.recipient

  setRecipient = value => {
    this.attributes.recipient = value
  }

  // date-time # When the Inbox was shared with this recipient.
  getSentAt = () => this.attributes.sent_at

  setSentAt = value => {
    this.attributes.sent_at = value
  }

  // int64 # Inbox to share.
  getInboxId = () => this.attributes.inbox_id

  setInboxId = value => {
    this.attributes.inbox_id = value
  }

  // boolean # Set to true to share the link with the recipient upon creation.
  getShareAfterCreate = () => this.attributes.share_after_create

  setShareAfterCreate = value => {
    this.attributes.share_after_create = value
  }

  save = async () => {
    if (this.attributes.id) {
      throw new errors.NotImplementedError('The InboxRecipient object doesn\'t support updates.')
    } else {
      const newObject = await InboxRecipient.create(this.attributes, this.options)
      this.attributes = { ...newObject.attributes }
      return true
    }
  }

  // Parameters:
  //   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
  //   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
  //   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
  //   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
  //   inbox_id (required) - int64 - List recipients for the inbox with this ID.
  static list = async (params = {}, options = {}) => {
    if (!params.inbox_id) {
      throw new errors.MissingParameterError('Parameter missing: inbox_id')
    }

    if (params.cursor && !isString(params.cursor)) {
      throw new errors.InvalidParameterError(`Bad parameter: cursor must be of type String, received ${getType(params.cursor)}`)
    }

    if (params.per_page && !isInt(params.per_page)) {
      throw new errors.InvalidParameterError(`Bad parameter: per_page must be of type Int, received ${getType(params.per_page)}`)
    }

    if (params.inbox_id && !isInt(params.inbox_id)) {
      throw new errors.InvalidParameterError(`Bad parameter: inbox_id must be of type Int, received ${getType(params.inbox_id)}`)
    }

    const response = await Api.sendRequest('/inbox_recipients', 'GET', params, options)

    return response?.data?.map(obj => new InboxRecipient(obj, options)) || []
  }

  static all = (params = {}, options = {}) =>
    InboxRecipient.list(params, options)

  // Parameters:
  //   inbox_id (required) - int64 - Inbox to share.
  //   recipient (required) - string - Email address to share this inbox with.
  //   name - string - Name of recipient.
  //   company - string - Company of recipient.
  //   note - string - Note to include in email.
  //   share_after_create - boolean - Set to true to share the link with the recipient upon creation.
  static create = async (params = {}, options = {}) => {
    if (!params.inbox_id) {
      throw new errors.MissingParameterError('Parameter missing: inbox_id')
    }

    if (!params.recipient) {
      throw new errors.MissingParameterError('Parameter missing: recipient')
    }

    if (params.inbox_id && !isInt(params.inbox_id)) {
      throw new errors.InvalidParameterError(`Bad parameter: inbox_id must be of type Int, received ${getType(params.inbox_id)}`)
    }

    if (params.recipient && !isString(params.recipient)) {
      throw new errors.InvalidParameterError(`Bad parameter: recipient must be of type String, received ${getType(params.recipient)}`)
    }

    if (params.name && !isString(params.name)) {
      throw new errors.InvalidParameterError(`Bad parameter: name must be of type String, received ${getType(params.name)}`)
    }

    if (params.company && !isString(params.company)) {
      throw new errors.InvalidParameterError(`Bad parameter: company must be of type String, received ${getType(params.company)}`)
    }

    if (params.note && !isString(params.note)) {
      throw new errors.InvalidParameterError(`Bad parameter: note must be of type String, received ${getType(params.note)}`)
    }

    const response = await Api.sendRequest('/inbox_recipients', 'POST', params, options)

    return new InboxRecipient(response?.data, options)
  }
}

export default InboxRecipient

module.exports = InboxRecipient
module.exports.default = InboxRecipient