improvement: added webhooks registration docs

models/enums/EventType.yaml

@@ -0,0 +1,63 @@
+type: string
+title: EventType
+description: Event type.
+enum:
+  - it.fattureincloud.issued_documents.invoices.create
+  - it.fattureincloud.issued_documents.invoices.update
+  - it.fattureincloud.issued_documents.invoices.delete
+  - it.fattureincloud.issued_documents.quotes.create
+  - it.fattureincloud.issued_documents.quotes.update
+  - it.fattureincloud.issued_documents.quotes.delete
+  - it.fattureincloud.issued_documents.proformas.create
+  - it.fattureincloud.issued_documents.proformas.update
+  - it.fattureincloud.issued_documents.proformas.create
+  - it.fattureincloud.issued_documents.receipts.create
+  - it.fattureincloud.issued_documents.receipts.update
+  - it.fattureincloud.issued_documents.receipts.delete
+  - it.fattureincloud.issued_documents.delivery_notes.create
+  - it.fattureincloud.issued_documents.delivery_notes.update
+  - it.fattureincloud.issued_documents.delivery_notes.delete
+  - it.fattureincloud.issued_documents.credit_notes.create
+  - it.fattureincloud.issued_documents.credit_notes.update
+  - it.fattureincloud.issued_documents.credit_notes.delete
+  - it.fattureincloud.issued_documents.orders.create
+  - it.fattureincloud.issued_documents.orders.update
+  - it.fattureincloud.issued_documents.orders.delete
+  - it.fattureincloud.issued_documents.work_reports.create
+  - it.fattureincloud.issued_documents.work_reports.update
+  - it.fattureincloud.issued_documents.work_reports.delete
+  - it.fattureincloud.issued_documents.supplier_orders.create
+  - it.fattureincloud.issued_documents.supplier_orders.update
+  - it.fattureincloud.issued_documents.supplier_orders.delete
+  - it.fattureincloud.issued_documents.self_invoices.create
+  - it.fattureincloud.issued_documents.self_invoices.update
+  - it.fattureincloud.issued_documents.self_invoices.delete
+  - it.fattureincloud.issued_documents.all.create
+  - it.fattureincloud.issued_documents.all.update
+  - it.fattureincloud.issued_documents.all.delete
+  - it.fattureincloud.received_documents.create
+  - it.fattureincloud.received_documents.update
+  - it.fattureincloud.received_documents.delete
+  - it.fattureincloud.receipts.create
+  - it.fattureincloud.receipts.update
+  - it.fattureincloud.receipts.delete
+  - it.fattureincloud.taxes.create
+  - it.fattureincloud.taxes.update
+  - it.fattureincloud.taxes.delete
+  - it.fattureincloud.cashbook.create
+  - it.fattureincloud.cashbook.update
+  - it.fattureincloud.cashbook.delete
+  - it.fattureincloud.products.create
+  - it.fattureincloud.products.update
+  - it.fattureincloud.products.delete
+  - it.fattureincloud.entities.clients.create
+  - it.fattureincloud.entities.clients.update
+  - it.fattureincloud.entities.clients.delete
+  - it.fattureincloud.entities.suppliers.create
+  - it.fattureincloud.entities.suppliers.update
+  - it.fattureincloud.entities.suppliers.delete
+  - it.fattureincloud.entities.all.create
+  - it.fattureincloud.entities.all.update
+  - it.fattureincloud.entities.all.delete
+  - it.fattureincloud.issued_documents.e_invoices
+  - it.fattureincloud.received_documents.e_invoices

models/requests/CreateWebhooksSubscriptionRequest.yaml

@@ -0,0 +1,5 @@
+title: CreateWebhooksSubscriptionRequest
+type: object
+properties:
+  data:
+    $ref: ../schemas/WebhooksSubscription.yaml

models/requests/ModifyWebhooksSubscriptionRequest.yaml

@@ -0,0 +1,5 @@
+title: ModifyWebhooksSubscriptionRequest
+type: object
+properties:
+  data:
+    $ref: ../schemas/WebhooksSubscription.yaml

models/responses/CreateWebhooksSubscriptionResponse.yaml

@@ -0,0 +1,11 @@
+title: CreateWebhooksSubscriptionResponse
+type: object
+properties:
+  data:
+    $ref: ../schemas/WebhooksSubscription.yaml
+  warnings:
+    type: array
+    nullable: true
+    description: Webhooks registration warnings
+    items:
+      type: string

models/responses/GetWebhooksSubscriptionResponse.yaml

@@ -0,0 +1,5 @@
+title: GetWebhooksSubscriptionResponse
+type: object
+properties:
+  data:
+    $ref: ../schemas/WebhooksSubscription.yaml

models/responses/ListWebhooksSubscriptionsResponse.yaml

@@ -0,0 +1,7 @@
+title: ListWebhooksSubscriptionsResponse
+type: object
+properties:
+  data:
+    type: array
+    items:
+      $ref: ../schemas/WebhooksSubscription.yaml

models/responses/ModifyWebhooksSubscriptionResponse.yaml

@@ -0,0 +1,11 @@
+title: CreateWebhooksSubscriptionRequest
+type: object
+properties:
+  data:
+    $ref: ../schemas/WebhooksSubscription.yaml
+  warnings:
+    type: array
+    nullable: true
+    description: Webhooks registration warnings
+    items:
+      type: string

models/schemas/ArchiveDocument.yaml

@@ -17,8 +17,7 @@ properties:
   attachment_url:
     type: string
     description: >-
-      [Temporary]
-      [Read Only]
+      [Temporary] [Read Only]
 
       Absolute url of the attached file. Authomatically set if a valid
       attachment token is passed via POST /archive or PUT /archive/{documentId}.

models/schemas/F24.yaml

@@ -25,8 +25,7 @@ properties:
   attachment_url:
     type: string
     description: >-
-      [Temporary]
-      [Read Only]
+      [Temporary] [Read Only]
 
       Absolute url of the attached file. Authomatically set if a valid
       attachment token is passed via POST /taxes or PUT /taxes/{documentId}.

models/schemas/IssuedDocument.yaml

@@ -447,33 +447,29 @@ properties:
     format: date
   url:
     type: string
-    description: >-
-      [Temporary]
-      [Read Only]
+    description: |-
+      [Temporary] [Read Only]
 
       Public url of the document PDF file.
     nullable: true
   dn_url:
     type: string
-    description: >-
-      [Temporary]
-      [Read Only]
+    description: |-
+      [Temporary] [Read Only]
 
       Public url of the attached delivery note PDF file.
     nullable: true
   ai_url:
     type: string
-    description: >-
-      [Temporary]
-      [Read Only]
+    description: |-
+      [Temporary] [Read Only]
 
       Public url of the accompanying invoice PDF file.
     nullable: true
   attachment_url:
     type: string
     description: >-
-      [Temporary]
-      [Read Only]
+      [Temporary] [Read Only]
 
       Public url of the attached file. Authomatically set if a valid attachment
       token is passed via POST /issued_documents or PUT
@@ -532,4 +528,4 @@ properties:
     nullable: true
   updated_at:
     type: string
-    nullable: true
+    nullable: true

models/schemas/IssuedDocumentPreCreateInfo.yaml

@@ -130,4 +130,3 @@ properties:
     items:
       $ref: ./Language.yaml
     nullable: true
-

models/schemas/ReceivedDocument.yaml

@@ -114,7 +114,7 @@ properties:
     description: |-
       [Temporary]
       [Read Only]
-      
+
       Public url of the attached file. Authomatically set if a valid attachment
       token is passed via POST /received_documents or PUT
       /received_documents/{documentId}.
@@ -125,13 +125,15 @@ properties:
     description: |-
       [Temporary]
       [Read Only]
-      
+
       Attachment preview url.
     readOnly: true
     nullable: true
   auto_calculate:
     type: boolean
-    description: If set to false total items amount and total payments amount can be different.
+    description: >-
+      If set to false total items amount and total payments amount can be
+      different.
     nullable: true
   attachment_token:
     type: string

models/schemas/WebhooksSubscription.yaml

@@ -0,0 +1,21 @@
+title: WebhooksSubscription
+type: object
+properties:
+  id:
+    type: string
+    nullable: true
+    description: Unique identifier
+  sink:
+    type: string
+    nullable: true
+    description: Webhooks callback uri.
+  verified:
+    type: boolean
+    nullable: true
+    description: '[Read Only] True if the webhooks subscription has been verified.'
+  types:
+    type: array
+    nullable: true
+    description: Webhooks events types.
+    items:
+      $ref: ../enums/EventType.yaml