SwisseldexAumImmo

SwisseldexAumImmo - the Ruby gem for the AUM Immo

No descripton provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0
• Package version: 1.0.0
• Build date: 2020-07-10T16:07:00.421+01:00
• Build package: class io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build SwisseldexAumImmo.gemspec

Then either install the gem locally:

gem install ./SwisseldexAumImmo-1.0.0.gem

(for development, run gem install --dev ./SwisseldexAumImmo-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'SwisseldexAumImmo', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'SwisseldexAumImmo', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'SwisseldexAumImmo'

# Setup authorization
SwisseldexAumImmo.configure do |config|
  # Configure API key authorization: apiKeyQuery
  config.api_key['subscription-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['subscription-key'] = 'Bearer'

  # Configure API key authorization: apiKeyHeader
  config.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
end

api_instance = SwisseldexAumImmo::DefaultApi.new

opts = { 
  test_delivery: true, # BOOLEAN | Processes message but does not forward it to recognized VNB (for testing)
  carbon_copy_email: "carbon_copy_email_example", # String | If VNB is consuming the message via Email, this address is taken as CC (mainly intended for testing). Adress is only considered if the mail-server supports TLS (you can check this with e.g. https://www.checktls.com/TestReceiver). Value of this parameter is not validated and it won't cause a negative impact on the processing of the message.
  upload_message: SwisseldexAumImmo::UploadMessage.new # UploadMessage | Structure and property-names are adapted from eCH-0112 (https://www.ech.ch/de/standards/52687).
}

begin
  #Upload
  result = api_instance.upload(opts)
  p result
rescue SwisseldexAumImmo::ApiError => e
  puts "Exception when calling DefaultApi->upload: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://sdx-aum-apim-t.azure-api.net/immo

Class	Method	HTTP request	Description
SwisseldexAumImmo::DefaultApi	upload	POST /messages	Upload

Documentation for Models

• SwisseldexAumImmo::UploadMessage
• SwisseldexAumImmo::UploadMessageBuilding
• SwisseldexAumImmo::UploadMessageContract
• SwisseldexAumImmo::UploadMessageContractor
• SwisseldexAumImmo::UploadMessageContractorPostalAddress
• SwisseldexAumImmo::UploadMessageDwelling
• SwisseldexAumImmo::UploadMessageExtension
• SwisseldexAumImmo::UploadMessageExtensionPreviousPerson
• SwisseldexAumImmo::UploadMessageGoesTo
• SwisseldexAumImmo::UploadMessagePerson
• SwisseldexAumImmo::UploadResponse
• SwisseldexAumImmo::UploadResponseDataCorrections
• SwisseldexAumImmo::UploadResponseDataCorrectionsBuildingAddress
• SwisseldexAumImmo::UploadResponseProviderDetails

Documentation for Authorization

apiKeyQuery

• Type: API key
• API key parameter name: subscription-key
• Location: URL query string

apiKeyHeader

• Type: API key
• API key parameter name: Ocp-Apim-Subscription-Key
• Location: HTTP header