Module: BookingSync::API::Client::Participants

Included in:
BookingSync::API::Client
Defined in:
lib/bookingsync/api/client/participants.rb

Instance Method Summary collapse

Instance Method Details

#create_participant(options) ⇒ BookingSync::API::Resource

Create a new participant

Parameters:

  • options (Hash) —

    Participant’s attributes.

Returns:



32
33
34
 
# File 'lib/bookingsync/api/client/participants.rb', line 32

def create_participant(options)
  post("inbox/participants", participants: [options]).pop
end

#edit_participant(participant, options = {}) ⇒ BookingSync::API::Resource

Edit a participant

Examples:

participant = @api.participants.first
@api.edit_participant(participant, { read: true })

Parameters:

  • participant (BookingSync::API::Resource|Integer) —

    Participant or ID of the participant to be updated.

  • options (Hash) (defaults to: {}) —

    Participant attributes to be updated.

Returns:



46
47
48
 
# File 'lib/bookingsync/api/client/participants.rb', line 46

def edit_participant(participant, options = {})
  put("inbox/participants/#{participant}", participants: [options]).pop
end

#participant(participant) ⇒ BookingSync::API::Resource

Get a single participant

Parameters:

Returns:



24
25
26
 
# File 'lib/bookingsync/api/client/participants.rb', line 24

def participant(participant)
  get("inbox/participants/#{participant}").pop
end

#participants(options = {}, &block) ⇒ Array<BookingSync::API::Resource>

List participants

Returns all participants supported in BookingSync.

Examples:

Get the list of participants for the current account

participants = @api.participants
participants.first.read_at # => "Fri, 02 Mar 2018 17:06:41 UTC +00:00"

Parameters:

  • options (Hash) (defaults to: {}) —

    A customizable set of options.

Options Hash (options):

  • fields: (Array) —

    List of fields to be fetched.

Returns:

See Also:



15
16
17
 
# File 'lib/bookingsync/api/client/participants.rb', line 15

def participants(options = {}, &block)
  paginate "inbox/participants", options, &block
end