README

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "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:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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



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

// Configure Bearer authorization: bearerAuth
$config = Infracorp\Extranet\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Infracorp\Extranet\Client\Api\DefaultApi(
    // 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 = 56; // int | service pack identifier
$add_service_contract_comment = new \Infracorp\Extranet\Client\Model\AddServiceContractComment(); // \Infracorp\Extranet\Client\Model\AddServiceContractComment

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

API Endpoints

All URIs are relative to https://my.tests.prizz-telecom.fr

Class	Method	HTTP request	Description
DefaultApi	addServiceContractComment	POST /external-api/v2/service_contracts/{id}/comments	Service Contract add comment
DefaultApi	createCommercialOffer	POST /external-api/v2/commercial_offers	Commercial Offers
DefaultApi	createCommercialOfferSection	POST /external-api/v2/commercial_offers/{id}/sections	Commercial Offer Sections
DefaultApi	createEligibility	POST /external-api/v2/eligibility	Create Eligibility
DefaultApi	createTicketOperator	POST /external-api/v2/exploitation/operator/{id}	Exploitation Operator Tickets
DefaultApi	createWorkflow	POST /external-api/v2/workflow	Workflows
DefaultApi	eligibilityHistory	GET /external-api/v2/eligibility/history	Eligibility History
DefaultApi	getApiTokens	GET /external-api/v2/users/api_tokens	User Api Tokens
DefaultApi	getAttachment	GET /external-api/v2/attachments/{id}	Attachement
DefaultApi	getClientLegalEntities	GET /external-api/v2/client_legal_entities	Client legal entities
DefaultApi	getClientLegalEntity	GET /external-api/v2/client_legal_entities/{id}	Client legal entity
DefaultApi	getCommentThread	GET /external-api/v2/comments/threads/{id}	Comment thread
DefaultApi	getCommentThreads	GET /external-api/v2/comments/threads	Comment threads
DefaultApi	getCommercialOffer	GET /external-api/v2/commercial_offers/{id}	Commercial Offer
DefaultApi	getCommercialOfferByName	GET /external-api/v2/commercial_offers_by_name/{offer_name}	Commercial Offer
DefaultApi	getCommercialOfferItem	GET /external-api/v2/commercial_offer_items/{id}	Commercial Offer Item
DefaultApi	getCommercialOfferPdf	GET /external-api/v2/commercial_offers/{id}/pdf	Commercial Offer Pdf
DefaultApi	getCommercialOfferSection	GET /external-api/v2/commercial_offer_sections/{id}	Commercial Offer Section
DefaultApi	getCommercialOffers	GET /external-api/v2/commercial_offers	Commercial Offers
DefaultApi	getCurrentUser	GET /external-api/v2/user	User
DefaultApi	getEligibility	GET /external-api/v2/eligibility/{id}	Get Eligibility
DefaultApi	getEntityAttachments	GET /external-api/v2/attachments	Attachements entity
DefaultApi	getInvoice	GET /external-api/v2/invoices/{id}	Invoice
DefaultApi	getInvoiceDetail	GET /external-api/v2/invoice_details/{id}	Invoice Detail
DefaultApi	getInvoicePdf	GET /external-api/v2/invoices/{id}/pdf	Invoice Pdf
DefaultApi	getInvoices	GET /external-api/v2/invoices	Invoices
DefaultApi	getLegalEntities	GET /external-api/v2/legal_entities	Legal entities
DefaultApi	getLegalEntity	GET /external-api/v2/legal_entities/{id}	Legal entity
DefaultApi	getOffers	GET /external-api/v2/offers	Offers
DefaultApi	getOperatorTickets	GET /external-api/v2/exploitation/operator/{id}/tickets	Exploitation Operator Tickets
DefaultApi	getPriceList	GET /external-api/v2/price_lists/{id}	Price List
DefaultApi	getPriceListItems	GET /external-api/v2/price_lists_items	Price List Items
DefaultApi	getPriceListOffers	GET /external-api/v2/price_lists/{id}/offers	Price List Offers
DefaultApi	getPriceLists	GET /external-api/v2/price_lists	Price Lists
DefaultApi	getProcess	GET /external-api/v2/exploitation/operator/{id}/process/{processId}	Exploitation Process
DefaultApi	getPublicAttachments	GET /external-api/v2/attachments/public	Attachements Public
DefaultApi	getRunningWorkflows	GET /external-api/v2/workflows/running	Workflows running
DefaultApi	getService	GET /external-api/v2/services/{id}	Service
DefaultApi	getServiceContract	GET /external-api/v2/service_contracts/{id}	Service Contract
DefaultApi	getServiceContractByName	GET /external-api/v2/service_contracts_by_name/{service_name}	Service Contract by name
DefaultApi	getServiceContracts	GET /external-api/v2/service_contracts	Service Contracts
DefaultApi	getServices	GET /external-api/v2/services	Services
DefaultApi	getTicket	GET /external-api/v2/exploitation/operator/{id}/tickets/{ref}	Exploitation Ticket
DefaultApi	getTickets	GET /external-api/v2/exploitation/tickets	Exploitation Tickets
DefaultApi	getWorkflow	GET /external-api/v2/workflow/{id}	Workflow
DefaultApi	openTicket	POST /external-api/v2/exploitation/operator/{id}/tickets	Exploitation Tickets
DefaultApi	removeCommercialOfferSection	DELETE /external-api/v2/commercial_offers/{id}/sections/{sectionId}	Remove Commercial Offer Section
DefaultApi	renameCommercialOfferSection	POST /external-api/v2/commercial_offers/{id}/sections/{sectionId}/rename	Rename Commercial Offer Section
DefaultApi	runProcess	POST /external-api/v2/exploitation/operator/{id}/process/{processId}	Exploitation Process
DefaultApi	runWorkflow	POST /external-api/v2/workflow/{id}	Workflow
DefaultApi	search	GET /external-api/v2/search	Search
DefaultApi	setCommercialOfferSectionOffer	POST /external-api/v2/commercial_offers/{id}/sections/{sectionId}/offer	Set Commercial Offer Section Offer
DefaultApi	setServiceContractVlan	POST /external-api/v2/service_contracts/{id}/vlan	Service Contract set vlan
DefaultApi	signCommercialOffer	POST /external-api/v2/commercial_offers/{id}/sign	Sign Commercial Offer
DefaultApi	submitCommercialOffer	POST /external-api/v2/commercial_offers/{id}/submit	Submit Commercial Offer
DefaultApi	updateCommercialOfferSectionItems	POST /external-api/v2/commercial_offers/{id}/sections/{sectionId}/update_items	Update Commercial Offer Section Items

Models

Authorization

Authentication schemes defined for the API:

tokenAuth

Type: API key
API key parameter name: Authorization
Location: HTTP header

bearerAuth

Type: Bearer authentication

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 2.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

infracorp / api-client-extranet

Maintainers

Details