Skip to content

Latest commit

 

History

History
executable file
·
47 lines (37 loc) · 1.75 KB

README.md

File metadata and controls

executable file
·
47 lines (37 loc) · 1.75 KB

BeMyGuestSuppliersApiv1

This API SDK was automatically generated by APIMATIC v2.0

How to configure:

The generated code might need to be configured with your API credentials. To do that, open the file "configuration.rb" and edit it's contents.

Alternatively, you can modify the Configuration parameters at run-time through the following:

BeMyGuestSuppliersApiv1::Configuration.your_paramater = YOUR_VALUE

How to build and install:

The generated code depends on a few Ruby gems. The references to these gems are added in the gemspec file. The easiest way to resolve the dependencies, build the gem and install it is through Rake:

  1. Install Rake if not already installed: gem install rake
  2. Install Bundler if not already installed: gem install bundler
  3. From terminal/cmd navigate to the root directory of the SDK.
  4. Invoke: rake install

Alternatively, you can build and install the gem manually:

  1. From terminal/cmd navigate to the root directory of the SDK.
  2. Run the build command: gem build be_my_guest_suppliers_apiv_1.gemspec
  3. Run the install command: gem install ./be_my_guest_suppliers_apiv_1-1.0.gem

Note: You will need to have internet access for this step.

How to use:

After having installed the gem, you can easily use the SDK following these steps.

  1. Create a "be_my_guest_suppliers_apiv_1_test.rb" file in the root directory.
  2. Use any controller as follows:
require 'be_my_guest_suppliers_apiv_1'

api_client = BeMyGuestSuppliersApiv1::BeMyGuestSuppliersAPIV1Client.new
controller = api_client.api_controller
response = controller.retrieve_config(<required parameters if any>)
p response