Module: BookingSync::API::Client::RentalsContentsOverrides

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

Instance Method Summary collapse

Instance Method Details

#create_rentals_contents_override(application, rental, options = {}) ⇒ BookingSync::API::Resource

Create a rentals_contents_override

Overrides rental’s (with id 12) description in English only for application with id 1.

Examples:

Create a rentals contents override.

@api.create_rentals_contents_override(1,, 12 { description_en: "Overriden English description" })

Parameters:

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

    Application object or ID for which the rentals contents override will be created.

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

    Rental object or ID for which the rentals contents override will be created.

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

    Rentals Contents Override attributes.

Returns:

See Also:



41
42
43
44
45
 
# File 'lib/bookingsync/api/client/rentals_contents_overrides.rb', line 41

def create_rentals_contents_override(application, rental, options = {})
  post("rentals_contents_overrides", rentals_contents_overrides: [
    options.merge(application_id: application.to_s.to_i, rental_id: rental.to_s.to_i)
  ]).pop
end

#delete_rentals_contents_override(rentals_contents_override) ⇒ NilClass

Delete a rentals_contents_override

Parameters:

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

    RentalsContentsOverride or ID of the rentals_contents_override to be deleted.

Returns:

  • (NilClass) —

    Returns nil on success.



67
68
69
 
# File 'lib/bookingsync/api/client/rentals_contents_overrides.rb', line 67

def delete_rentals_contents_override(rentals_contents_override)
  delete "rentals_contents_overrides/#{rentals_contents_override}"
end

#edit_rentals_contents_override(rentals_contents_override, options = {}) ⇒ BookingSync::API::Resource

Edit a rentals_contents_override

Examples:

rentals_contents_override = @api.rentals_contents_overrides.first
@api.edit_rentals_contents_override(rentals_contents_override, { summary_en: "Override English summary" })

Parameters:

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

    RentalsContentsOverride or ID of the rentals_contents_override to be updated.

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

    rentals_contents_override attributes to be updated.

Returns:

See Also:



58
59
60
 
# File 'lib/bookingsync/api/client/rentals_contents_overrides.rb', line 58

def edit_rentals_contents_override(rentals_contents_override, options = {})
  put("rentals_contents_overrides/#{rentals_contents_override}", rentals_contents_overrides: [options]).pop
end

#rentals_contents_override(rentals_content_override) ⇒ BookingSync::API::Resource

Get a single rentals_contents_override

rentals_contents_override or ID of the rentals_contents_override.

Parameters:

Returns:

See Also:



25
26
27
 
# File 'lib/bookingsync/api/client/rentals_contents_overrides.rb', line 25

def rentals_contents_override(rentals_content_override)
  get("rentals_contents_overrides/#{rentals_content_override}").pop
end

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

List rentals_contents_overrides

Returns all rentals contents overrides for the current account.

Examples:

Get the list of rentals contents overrides for the current account

rentals_contents_overrides = @api.rentals_contents_overrides
rentals_contents_overrides.first.description.en # => "Overriden English description"

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/rentals_contents_overrides.rb', line 15

def rentals_contents_overrides(options = {}, &block)
  paginate :rentals_contents_overrides, options, &block
end