SwaggerClient-php

The Madaster Private API endpoint.

This PHP package is automatically generated by the Swagger Codegen project:

  • API version: 1.1
  • Build package: io.swagger.codegen.languages.PhpClientCodegen For more information, please visit https://www.madaster.com

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

$apiInstance = new Swagger\Client\Api\BuildingApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = "id_example"; // string | The identifier of the building.

try {
    $result = $apiInstance->apiV11BuildingsByIdCircularGet($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BuildingApi->apiV11BuildingsByIdCircularGet: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://localhost

Class Method HTTP request Description
BuildingApi apiV11BuildingsByIdCircularGet GET /api/v1.1/buildings/{id}/circular Gets the circular information of a buildnig.
BuildingApi apiV11BuildingsByIdDelete DELETE /api/v1.1/buildings/{id} Deletes the building and all related data.
BuildingApi apiV11BuildingsByIdExportexcelpassportPost POST /api/v1.1/buildings/{id}/exportexcelpassport Schedules the generation of a PDF building passport.
BuildingApi apiV11BuildingsByIdExportpassportPost POST /api/v1.1/buildings/{id}/exportpassport Schedules the generation of a PDF building passport.
BuildingApi apiV11BuildingsByIdFinancialGet GET /api/v1.1/buildings/{id}/financial Gets the financial information of a buildnig.
BuildingApi apiV11BuildingsByIdGet GET /api/v1.1/buildings/{id} Gets a building by its identifier.
BuildingApi apiV11BuildingsByIdImagesPost POST /api/v1.1/buildings/{id}/images Adds an image to a building.
BuildingApi apiV11BuildingsByIdProcessPost POST /api/v1.1/buildings/{id}/process Schedules the building for proccesing, recalculates all data.
BuildingApi apiV11BuildingsByIdPut PUT /api/v1.1/buildings/{id} Replaces a building.
BuildingApi apiV11BuildingsByIdUsersGet GET /api/v1.1/buildings/{id}/users Gets all users for a building.
BuildingApi apiV11BuildingsByIdUsersPut PUT /api/v1.1/buildings/{id}/users Replaces the security of a users for a building.
BuildingApi apiV11BuildingsByIdValidateGet GET /api/v1.1/buildings/{id}/validate Gets building validation parameters.
BuildingApi apiV11BuildingsGet GET /api/v1.1/buildings Gets all buildings.
BuildingApi apiV11BuildingsPost POST /api/v1.1/buildings Adds a building.
BuildingFileApi apiV11BuildingsByBuildingIdFilesByIdActivePost POST /api/v1.1/buildings/{buildingId}/files/{id}/active Activates or deactivates a building file.
BuildingFileApi apiV11BuildingsByBuildingIdFilesByIdDelete DELETE /api/v1.1/buildings/{buildingId}/files/{id} Deletes a building file.
BuildingFileApi apiV11BuildingsByBuildingIdFilesByIdDownloadGet GET /api/v1.1/buildings/{buildingId}/files/{id}/download Gets a download url for the building file.
BuildingFileApi apiV11BuildingsByBuildingIdFilesByIdGet GET /api/v1.1/buildings/{buildingId}/files/{id} Gets a building file by its identifier.
BuildingFileApi apiV11BuildingsByBuildingIdFilesByIdSetimportingPost POST /api/v1.1/buildings/{buildingId}/files/{id}/setimporting Sets the status of a file to 'importing', so element can be added or updated can be made.
BuildingFileApi apiV11BuildingsByBuildingIdFilesByIdStartrefinementPost POST /api/v1.1/buildings/{buildingId}/files/{id}/startrefinement Starts the refinement of a building file.
BuildingFileApi apiV11BuildingsByBuildingIdFilesByIdStatusGet GET /api/v1.1/buildings/{buildingId}/files/{id}/status Gets a building file status by its identifier.
BuildingFileApi apiV11BuildingsByBuildingIdFilesByIdUploadPost POST /api/v1.1/buildings/{buildingId}/files/{id}/upload Uploads a building file.
BuildingFileApi apiV11BuildingsByBuildingIdFilesGet GET /api/v1.1/buildings/{buildingId}/files Gets all building files.
BuildingFileApi apiV11BuildingsByBuildingIdFilesPost POST /api/v1.1/buildings/{buildingId}/files Adds a building file.
BuildingFileElementApi apiV11BuildingsByBuildingIdFilesByFileIdElementsByIdDelete DELETE /api/v1.1/buildings/{buildingId}/files/{fileId}/elements/{id} Deletes an existing building file element.
BuildingFileElementApi apiV11BuildingsByBuildingIdFilesByFileIdElementsByIdGet GET /api/v1.1/buildings/{buildingId}/files/{fileId}/elements/{id} Gets a building file element by its identifier and building file identifier.
BuildingFileElementApi apiV11BuildingsByBuildingIdFilesByFileIdElementsByIdPut PUT /api/v1.1/buildings/{buildingId}/files/{fileId}/elements/{id} Updates an existing building file element.
BuildingFileElementApi apiV11BuildingsByBuildingIdFilesByFileIdElementsGet GET /api/v1.1/buildings/{buildingId}/files/{fileId}/elements Gets a building file elements by its building file identifier.
BuildingFileElementApi apiV11BuildingsByBuildingIdFilesByFileIdElementsPost POST /api/v1.1/buildings/{buildingId}/files/{fileId}/elements Create a new building file element.
MaterialApi apiV11MaterialsByIdFinancialvaluesGet GET /api/v1.1/materials/{id}/financialvalues Gets the financial values of a material, for manual import mode.
MaterialApi apiV11MaterialsByIdFinancialvaluesPost POST /api/v1.1/materials/{id}/financialvalues Adds a financial value for a material, for manual import mode.
MaterialApi apiV11MaterialsByIdFinancialvaluesPut PUT /api/v1.1/materials/{id}/financialvalues Replaces the financial values for a material, for manual import mode.
MaterialApi apiV11MaterialsByIdGet GET /api/v1.1/materials/{id} Gets a material by its identifier.
MaterialApi apiV11MaterialsByIdMatchesGet GET /api/v1.1/materials/{id}/matches Gets the matches of a material.
MaterialApi apiV11MaterialsByIdMatchesPost POST /api/v1.1/materials/{id}/matches Adds a match for a material.
MaterialApi apiV11MaterialsByIdMatchesPut PUT /api/v1.1/materials/{id}/matches Replaces the matches for a material.
MaterialApi apiV11MaterialsByIdPut PUT /api/v1.1/materials/{id} Replaces a material.
MaterialApi apiV11MaterialsGet GET /api/v1.1/materials Gets all materials.
MaterialApi apiV11MaterialsPost POST /api/v1.1/materials Adds a material.
PortfolioApi apiV11PortfoliosByIdBuildingsGet GET /api/v1.1/portfolios/{id}/buildings Gets all buildings for a portfolio.
PortfolioApi apiV11PortfoliosByIdDelete DELETE /api/v1.1/portfolios/{id} Deletes a portfolio.
PortfolioApi apiV11PortfoliosByIdGet GET /api/v1.1/portfolios/{id} Gets a portfolio by its identifier.
PortfolioApi apiV11PortfoliosByIdLogoPost POST /api/v1.1/portfolios/{id}/logo Sets the logo of a portfolio.
PortfolioApi apiV11PortfoliosByIdPassportPost POST /api/v1.1/portfolios/{id}/passport Schedules the generation of a PDF portfolio passport.
PortfolioApi apiV11PortfoliosByIdPut PUT /api/v1.1/portfolios/{id} Replaces a portfolio.
PortfolioApi apiV11PortfoliosByIdUsersGet GET /api/v1.1/portfolios/{id}/users Gets all users for a portfolio.
PortfolioApi apiV11PortfoliosByIdUsersPut PUT /api/v1.1/portfolios/{id}/users Replaces the security of a users for a portfolio.
PortfolioApi apiV11PortfoliosGet GET /api/v1.1/portfolios Gets all portfolios.
PortfolioApi apiV11PortfoliosPost POST /api/v1.1/portfolios Adds a portfolio.
PortfolioFileApi apiV11PortfoliosByPortfolioIdFilesByIdDelete DELETE /api/v1.1/portfolios/{portfolioId}/files/{id} Deletes a portfolio file.
PortfolioFileApi apiV11PortfoliosByPortfolioIdFilesByIdDownloadGet GET /api/v1.1/portfolios/{portfolioId}/files/{id}/download Gets a download url for the portfolio file.
PortfolioFileApi apiV11PortfoliosByPortfolioIdFilesByIdGet GET /api/v1.1/portfolios/{portfolioId}/files/{id} Gets a portfolio file by its identifier.
PortfolioFileApi apiV11PortfoliosByPortfolioIdFilesByIdStatusGet GET /api/v1.1/portfolios/{portfolioId}/files/{id}/status Gets a portfolio file status by its identifier.
PortfolioFileApi apiV11PortfoliosByPortfolioIdFilesByIdUploadPost POST /api/v1.1/portfolios/{portfolioId}/files/{id}/upload Uploads a portfolio file.
PortfolioFileApi apiV11PortfoliosByPortfolioIdFilesGet GET /api/v1.1/portfolios/{portfolioId}/files Gets all portfolio files for a portfolio.
PortfolioFileApi apiV11PortfoliosByPortfolioIdFilesPost POST /api/v1.1/portfolios/{portfolioId}/files Adds a portfolio file.
ProductApi apiV11ProductsByIdChildrenGet GET /api/v1.1/products/{id}/children Gets the children of a product.
ProductApi apiV11ProductsByIdChildrenPost POST /api/v1.1/products/{id}/children Adds a child for a product.
ProductApi apiV11ProductsByIdChildrenPut PUT /api/v1.1/products/{id}/children Replaces the children for a product.
ProductApi apiV11ProductsByIdFinancialvaluesGet GET /api/v1.1/products/{id}/financialvalues Gets the financial values of a product.
ProductApi apiV11ProductsByIdFinancialvaluesPost POST /api/v1.1/products/{id}/financialvalues Adds a financial value for a product.
ProductApi apiV11ProductsByIdFinancialvaluesPut PUT /api/v1.1/products/{id}/financialvalues Replaces the financial values for a product.
ProductApi apiV11ProductsByIdGet GET /api/v1.1/products/{id} Gets a product by its identifier.
ProductApi apiV11ProductsByIdMatchesGet GET /api/v1.1/products/{id}/matches Gets the matches of a product.
ProductApi apiV11ProductsByIdMatchesPost POST /api/v1.1/products/{id}/matches Adds a match for a product.
ProductApi apiV11ProductsByIdMatchesPut PUT /api/v1.1/products/{id}/matches Replaces the matches for a product.
ProductApi apiV11ProductsByIdPut PUT /api/v1.1/products/{id} Replaces a product.
ProductApi apiV11ProductsGet GET /api/v1.1/products Gets all products.
ProductApi apiV11ProductsPost POST /api/v1.1/products Adds a product.

Documentation For Models

Documentation For Authorization

Token

  • Type: API key
  • API key parameter name: X-API-Key
  • Location: HTTP header

Author

service@madaster.com