Module: Immobilienscout24::Api::Publish

Included in:
Immobilienscout24::Api
Defined in:
lib/immobilienscout24/api/publish.rb

Overview

Methods for the Publish API

See Also:

Instance Method Summary collapse

Instance Method Details

#create_publication(publication) ⇒ Hashie::Mash

Create a single publication

Examples:

client.create_publication(publication)

Parameters:

  • publication (Hash) —

    Publication data

Returns:

  • (Hashie::Mash) —

    Immobilienscout24 response

See Also:



52
53
54
 
# File 'lib/immobilienscout24/api/publish.rb', line 52

def create_publication(publication)
  post publish_endpoint("/publish"), publication
end

#create_publications(publications) ⇒ Hashie::Mash

Create multiple publications

Examples:

client.create_publications(publications)

Parameters:

  • publications (Hash) —

    Publication data

Returns:

  • (Hashie::Mash) —

    Immobilienscout24 response

See Also:



41
42
43
 
# File 'lib/immobilienscout24/api/publish.rb', line 41

def create_publications(publications)
  post publish_endpoint("/publish/list"), publications
end

#delete_publication(id) ⇒ Hashie::Mash

Delete a publication

Examples:

client.delete_publication(publication_id)

Parameters:

  • id (String) —

    Publication id

Returns:

  • (Hashie::Mash) —

    Immobilienscout24 response

See Also:



63
64
65
 
# File 'lib/immobilienscout24/api/publish.rb', line 63

def delete_publication(id)
  delete publish_endpoint("/publish/#{id}")
end

#publication(id) ⇒ Hashie::Mash

Get a single publication

Examples:

client.publication(publication_id)

Parameters:

  • id (String) —

    Publication id

Returns:

  • (Hashie::Mash) —

    Immobilienscout24 response

See Also:



30
31
32
 
# File 'lib/immobilienscout24/api/publish.rb', line 30

def publication(id)
  get publish_endpoint("/publish/#{id}")
end

#publications(estate, params = {}) ⇒ Hashie::Mash

Get a list of all publications

Examples:

client.publications(estate_id)

Parameters:

  • estate (Hash) —

    Estate id

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

    Additional request parameters

Returns:

  • (Hashie::Mash) —

    Immobilienscout24 response

See Also:



18
19
20
21
 
# File 'lib/immobilienscout24/api/publish.rb', line 18

def publications(estate, params = {})
  params = {realestate: estate}.merge(params)
  get publish_endpoint("/publish"), params
end

#publish_endpoint(resource) ⇒ String

Generates the publish endpoint

Parameters:

  • resource (String, Integer) —

    In most cases the id of the publication

Returns:

  • (String) —

    The url to the publish resource



73
74
75
 
# File 'lib/immobilienscout24/api/publish.rb', line 73

def publish_endpoint(resource)
  ["api/offer/#{api_version}", resource].join
end