Skip to content

Commit d8fd9ec

Browse files
docs: generate table of contents
1 parent e0343c1 commit d8fd9ec

1 file changed

Lines changed: 42 additions & 17 deletions

File tree

readme.md

Lines changed: 42 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,39 @@
11
# OpenAPI Library
22

3-
## Installation
3+
<!-- vscode-markdown-toc -->
4+
* 1. [Installation](#Installation)
5+
* 2. [Usage](#Usage)
6+
* 2.1. [Instanza della classe](#Instanzadellaclasse)
7+
* 2.2. [Esempi](#Esempi)
8+
* 2.3. [Creare raccomandata -->](#Creareraccomandata--)
9+
* 3. [Modulo comuni](#Modulocomuni)
10+
* 3.1. [Esempi](#Esempi-1)
11+
* 3.2. [Utilizzo](#Utilizzo)
12+
* 3.3. [`sendRequest($VisRequest)` -->](#sendRequestVisRequest--)
13+
* 4. [Modulo imprese](#Moduloimprese)
14+
* 4.1. [Utilizzo](#Utilizzo-1)
15+
* 4.2. [Esempi](#Esempi-1)
16+
* 5. [Modulo Marche Temporali](#ModuloMarcheTemporali)
17+
* 5.1. [Esempi](#Esempi-1)
18+
* 6. [Modulo SMS](#ModuloSMS)
19+
* 6.1. [Inviare un SMS](#InviareunSMS)
20+
* 7. [Modulo Visengine](#ModuloVisengine)
21+
22+
<!-- vscode-markdown-toc-config
23+
numbering=true
24+
autoSave=true
25+
/vscode-markdown-toc-config -->
26+
<!-- /vscode-markdown-toc -->
27+
28+
## 1. <a name='Installation'></a>Installation
429

530
```sh
631
composer require altravia/openapi
732
```
833

9-
## Usage
34+
## 2. <a name='Usage'></a>Usage
1035

11-
### Instanza della classe
36+
### 2.1. <a name='Instanzadellaclasse'></a>Instanza della classe
1237

1338
```php
1439
require_once 'vendor/autoload.php';
@@ -53,7 +78,7 @@ che possono essere usati al seguente modo:
5378
```php
5479
$this->openapi->ufficioposale->getCitiesByCap('00132');
5580
```
56-
### Esempi
81+
### 2.2. <a name='Esempi'></a>Esempi
5782

5883
```php
5984
require_once 'vendor/autoload.php';
@@ -77,9 +102,9 @@ $track = $this->openapi->ufficiopostale->track('123456789');
77102
```
78103

79104
<!-- ## Modulo ufficio postale
80-
### Creare raccomandata -->
105+
### 2.3. <a name='Creareraccomandata--'></a>Creare raccomandata -->
81106

82-
## Modulo comuni
107+
## 3. <a name='Modulocomuni'></a>Modulo comuni
83108
Consente di prendere informazioni su comuni e provincie.
84109

85110
* `getCitiesByCap`
@@ -88,7 +113,7 @@ Consente di prendere informazioni su comuni e provincie.
88113
* `getProvince`
89114
* `getComuni`
90115

91-
### Esempi
116+
### 3.1. <a name='Esempi-1'></a>Esempi
92117

93118
```php
94119
$provincia = 'RM';
@@ -114,19 +139,19 @@ var_dump($comuni['comuni']);
114139
```
115140

116141
<!-- ## Modulo visure
117-
### Utilizzo
142+
### 3.2. <a name='Utilizzo'></a>Utilizzo
118143
Il modulo espone i seguenti metodi:
119144
* `sendRequest`
120145
* `getRequestByIdVisura`
121146
* `getRequestByData`
122147
* `getDocument`
123148
* `setRicerca`
124149
125-
### `sendRequest($VisRequest)` -->
150+
### 3.3. <a name='sendRequestVisRequest--'></a>`sendRequest($VisRequest)` -->
126151

127152

128-
## Modulo imprese
129-
### Utilizzo
153+
## 4. <a name='Moduloimprese'></a>Modulo imprese
154+
### 4.1. <a name='Utilizzo-1'></a>Utilizzo
130155
Il modulo imprese espone i seguenti metodi:
131156
* `getByPartitaIva`
132157
* `getClosed`
@@ -136,7 +161,7 @@ Il modulo imprese espone i seguenti metodi:
136161

137162
Per `getBySearch` e `getByPartitaIva` è richiesto accesso allo scope `/advance`
138163

139-
### Esempi
164+
### 4.2. <a name='Esempi-1'></a>Esempi
140165
Utilizziamo `getBySearch` per cercare un'azienda il cui nome inizia con `Altrav` a Roma
141166

142167
```php
@@ -161,12 +186,12 @@ $autocomplete = $this->openapi->imprese->getBySearch('Altrav*', 'RM');
161186
*/
162187
```
163188

164-
## Modulo Marche Temporali
189+
## 5. <a name='ModuloMarcheTemporali'></a>Modulo Marche Temporali
165190
* `availability`
166191
* `checkLotto`
167192
* `purcahse`
168193

169-
### Esempi
194+
### 5.1. <a name='Esempi-1'></a>Esempi
170195

171196
```php
172197
// Controlliamo la disponibilitá di una marca di inforcert o aruba
@@ -182,13 +207,13 @@ if ($disponibilita->availability > 0) {
182207
}
183208
```
184209

185-
## Modulo SMS
210+
## 6. <a name='ModuloSMS'></a>Modulo SMS
186211
* `getRecipients`
187212
* `getMessage`
188213
* `sendMore`
189214
* `sendOne`
190215

191-
### Inviare un SMS
216+
### 6.1. <a name='InviareunSMS'></a>Inviare un SMS
192217
Per inviare un SMS, per prima cosa definiamo i destinatari:
193218

194219
```php
@@ -225,7 +250,7 @@ $options = ['timestamp_send' => '2021-04-20']
225250
$this->openapi->SMS->sendOne('Nome del mittente', '3939989741', 'lorem ipsum', '+42', 1, $options);
226251
```
227252

228-
## Modulo Visengine
253+
## 7. <a name='ModuloVisengine'></a>Modulo Visengine
229254
Come prima cosa, settiamo l'hash della visura che vogliamo richiedere
230255

231256
```php

0 commit comments

Comments
 (0)