buy_borghi_services

BuyBorghiServices - JavaScript client for buy_borghi_services BuyBorghi API This SDK is automatically generated by the Swagger Codegen project:

• API version: ${project.version}
• Package version: ${project.version}
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install buy_borghi_services --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your buy_borghi_services from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('buy_borghi_services') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/buy_borghi_services then install it via:

    npm install YOUR_USERNAME/buy_borghi_services --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var BuyBorghiServices = require('buy_borghi_services');

var api = new BuyBorghiServices.CompaniesApi()

var townId = "townId_example"; // {String} A unique identifier used to identify the town.

var companyId = "companyId_example"; // {String} A unique identifier used to identify the company.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.townsTownIdCompaniesCompanyIdCouponsGet(townId, companyId, callback);

Documentation for API Endpoints

All URIs are relative to https://buyborghi.imolinfo.it/buyborghi-api/v1

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- BuyBorghiServices.CompaniesApi | townsTownIdCompaniesCompanyIdCouponsGet | GET /towns/{townId}/companies/{companyId}/coupons | Get coupons made by the company BuyBorghiServices.CompaniesApi | townsTownIdCompaniesCompanyIdEventsGet | GET /towns/{townId}/companies/{companyId}/events | Get events organized by the company BuyBorghiServices.CompaniesApi | townsTownIdCompaniesCompanyIdGet | GET /towns/{townId}/companies/{companyId} | Get company's details BuyBorghiServices.CompaniesApi | townsTownIdCompaniesGet | GET /towns/{townId}/companies | Get companies related to the town BuyBorghiServices.CouponsApi | townsTownIdCompaniesCompanyIdCouponsGet | GET /towns/{townId}/companies/{companyId}/coupons | Get coupons made by the company BuyBorghiServices.CouponsApi | townsTownIdCouponsCouponIdGet | GET /towns/{townId}/coupons/{couponId} | Get coupons's details BuyBorghiServices.CouponsApi | townsTownIdCouponsGet | GET /towns/{townId}/coupons | Get coupons related to the town BuyBorghiServices.EventsApi | townsTownIdCompaniesCompanyIdEventsGet | GET /towns/{townId}/companies/{companyId}/events | Get events organized by the company BuyBorghiServices.EventsApi | townsTownIdEventsEventIdGet | GET /towns/{townId}/events/{eventId} | Get event's details BuyBorghiServices.EventsApi | townsTownIdEventsGet | GET /towns/{townId}/events | Get events related to the town BuyBorghiServices.InfoApi | helpGet | GET /help | Send general informations, contacts and FAQ BuyBorghiServices.PlacesApi | townsTownIdPlacesGet | GET /towns/{townId}/places | Get places related to the town BuyBorghiServices.PlacesApi | townsTownIdPlacesPlaceIdGet | GET /towns/{townId}/places/{placeId} | Get event's details BuyBorghiServices.PostApi | reportingsPost | POST /reportings | Send abuses and/or reports BuyBorghiServices.PostApi | townsPost | POST /towns/ | Add town Geo-coordinates BuyBorghiServices.TownsApi | townsGet | GET /towns/ | Town list BuyBorghiServices.TownsApi | townsPost | POST /towns/ | Add town Geo-coordinates BuyBorghiServices.TownsApi | townsTownIdCompaniesCompanyIdCouponsGet | GET /towns/{townId}/companies/{companyId}/coupons | Get coupons made by the company BuyBorghiServices.TownsApi | townsTownIdCompaniesCompanyIdEventsGet | GET /towns/{townId}/companies/{companyId}/events | Get events organized by the company BuyBorghiServices.TownsApi | townsTownIdCompaniesCompanyIdGet | GET /towns/{townId}/companies/{companyId} | Get company's details BuyBorghiServices.TownsApi | townsTownIdCompaniesGet | GET /towns/{townId}/companies | Get companies related to the town BuyBorghiServices.TownsApi | townsTownIdCouponsCouponIdGet | GET /towns/{townId}/coupons/{couponId} | Get coupons's details BuyBorghiServices.TownsApi | townsTownIdCouponsGet | GET /towns/{townId}/coupons | Get coupons related to the town BuyBorghiServices.TownsApi | townsTownIdElementsGet | GET /towns/{townId}/elements | Find elements of any type BuyBorghiServices.TownsApi | townsTownIdEventsEventIdGet | GET /towns/{townId}/events/{eventId} | Get event's details BuyBorghiServices.TownsApi | townsTownIdEventsGet | GET /towns/{townId}/events | Get events related to the town BuyBorghiServices.TownsApi | townsTownIdGet | GET /towns/{townId} | Get town's details BuyBorghiServices.TownsApi | townsTownIdPlacesGet | GET /towns/{townId}/places | Get places related to the town BuyBorghiServices.TownsApi | townsTownIdPlacesPlaceIdGet | GET /towns/{townId}/places/{placeId} | Get event's details BuyBorghiServices.WelcomeApi | welcomeGet | GET /welcome/ | Check if user is phisically in town

Documentation for Models

• BuyBorghiServices.Anagraphic
• BuyBorghiServices.BusinessInfo
• BuyBorghiServices.Company
• BuyBorghiServices.CompanyList
• BuyBorghiServices.Contacts
• BuyBorghiServices.Coordinates
• BuyBorghiServices.Coupon
• BuyBorghiServices.CouponList
• BuyBorghiServices.Element
• BuyBorghiServices.ElementList
• BuyBorghiServices.ElementType
• BuyBorghiServices.Event
• BuyBorghiServices.EventList
• BuyBorghiServices.GeoInfo
• BuyBorghiServices.GetTownsCompaniesIdCouponsResponse
• BuyBorghiServices.GetTownsCompaniesIdEventsResponse
• BuyBorghiServices.GetTownsCompaniesIdResponse
• BuyBorghiServices.GetTownsIdCompaniesResponse
• BuyBorghiServices.GetTownsIdCouponsIdResponse
• BuyBorghiServices.GetTownsIdCouponsResponse
• BuyBorghiServices.GetTownsIdElementsResponse
• BuyBorghiServices.GetTownsIdEventsIdResponse
• BuyBorghiServices.GetTownsIdEventsResponse
• BuyBorghiServices.GetTownsIdPlacesIdResponse
• BuyBorghiServices.GetTownsIdPlacesResponse
• BuyBorghiServices.GetTownsIdResponse
• BuyBorghiServices.GetTownsResponse
• BuyBorghiServices.GetWelcomeResponse
• BuyBorghiServices.HowToGetInTown
• BuyBorghiServices.Media
• BuyBorghiServices.Municipality
• BuyBorghiServices.Offer
• BuyBorghiServices.Place
• BuyBorghiServices.PlaceList
• BuyBorghiServices.Polygon
• BuyBorghiServices.PostReportRequest
• BuyBorghiServices.PostTownsRequest
• BuyBorghiServices.SocialMedia
• BuyBorghiServices.SocialMediaList
• BuyBorghiServices.Tag
• BuyBorghiServices.TagList
• BuyBorghiServices.TimeInfo
• BuyBorghiServices.Town
• BuyBorghiServices.TownId
• BuyBorghiServices.TownList
• BuyBorghiServices.User

Documentation for Authorization

OAuth2

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://www.buyborghi.it/oauth/authorize
• Scopes:
  • admin: Grants access to admin operations
  • read: Grants read access
  • write: Grants write access