Updates for API docs

app/Models/Company.php

@@ -120,6 +120,8 @@ use Laracasts\Presenter\PresentableTrait;
  * @property bool $inbound_mailbox_allow_unknown
  * @property string|null $inbound_mailbox_whitelist
  * @property string|null $inbound_mailbox_blacklist
+ * @property string|null $e_invoice_certificate_passphrase
+ * @property string|null $e_invoice_certificate
  * @property int $deleted_at
  * @property string|null $smtp_username
  * @property string|null $smtp_password

openapi/api-docs.yaml

@@ -62,7 +62,7 @@ info:
           | 500         | Internal Server Error: A generic error message, given when an unexpected condition was encountered and no more specific message is suitable. |
           ### Pagination
 
-          When using index routes to retrieve lists of data, by default we limit the number of records returned to 20. You can using standard pagination to paginate results, ie:
+          When using index routes to retrieve lists of data, by default we limit the number of records returned to 20. You can using standard pagination to paginate results, ie: ?per_page=50
   termsOfService: 'https://invoiceninja.github.io/docs/legal/terms_of_service/#page-content'
   contact:
     email: contact@invoiceninja.com
@@ -13078,7 +13078,43 @@ paths:
       tags:
         - clients
       summary: 'Bulk client actions'
-      description: 'Archive / Restore / Delete in bulk'
+      description: |
+        Bulk actions allow to make changes to multiple clients in a single request the following actions are supported
+        
+        - archive
+        - restore
+        - delete
+        - template _requires template,template_id properties also_
+        - assign_group _requires group_settings_id also_
+        - bulk_update _ requires column,new_value also_
+
+        All of these actions require an array of client ids to perform the requested action on ie.
+
+        "ids":['id1','id2']
+
+        actions such as template, assign_group and bulk_update also require additional properties to be passed in the request
+
+        - template
+
+        The template bulk action allows the creation of a custom template using the provided template_id to be run against the array of clients provided.
+
+        - assign_group
+        
+        Allows the setting of multiple clients to a single group
+
+        - bulk_update
+
+        Allows updating certain columns on the client model in bulk. the current list of supported columns that can be updated archived_at:
+
+        - public_notes
+        - industry_id
+        - size_id
+        - country_id
+        - custom_value1
+        - custom_value2
+        - custom_value3
+        - custom_value4
+
       operationId: bulkClients
       parameters:
         - $ref: '#/components/parameters/X-API-TOKEN'
@@ -13094,7 +13130,7 @@ paths:
               
       responses:
         200:
-          description: 'The Client listresponse'
+          description: 'The Client list Response of the updated clients that were bulk updated'
           headers:
             X-MINIMUM-CLIENT-VERSION:
               $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
@@ -13179,7 +13215,7 @@ paths:
         - clients
       summary: 'Purge client'
       description: |
-            Handles purging a clients.
+            Handles purging a client.
 
             Please note this is a destructive action.
 
@@ -20086,7 +20122,6 @@ components:
           description: 'Flag which defines if the client has a valid VAT number'
           type: boolean
           example: false
-          readOnly: true
         classification:
           description: 'The classification of the client'
           type: string
@@ -22088,15 +22123,13 @@ components:
       type: object
 tags:
   - name: login
-    description: |
+    # description: |
-      Attempts to authenticate with the API using a email/password combination.
+    #   Attempts to authenticate with the API using a email/password combination.
-    externalDocs:
+    
-      description: "Find out more"
-      url: "https://invoiceninja.github.io"
   - name: clients
-    x-tag-expanded: true
+    x-tag-expanded: false
-    description: |
+    # description: |
-      Endpoint definitions for interacting with clients.
+    #   Endpoint definitions for interacting with clients.
   - name: products
     description: |
       Endpoint definitions for interacting with products.

openapi/components/schemas/client_request.yaml

@@ -135,7 +135,6 @@
           description: 'Flag which defines if the client has a valid VAT number'
           type: boolean
           example: false
-          readOnly: true
         classification:
           description: 'The classification of the client'
           type: string

openapi/misc/misc.yaml

@@ -1,14 +1,12 @@
 tags:
   - name: login
-    description: |
+    # description: |
-      Attempts to authenticate with the API using a email/password combination.
+    #   Attempts to authenticate with the API using a email/password combination.
-    externalDocs:
+    
-      description: "Find out more"
-      url: "https://invoiceninja.github.io"
   - name: clients
-    x-tag-expanded: true
+    x-tag-expanded: false
-    description: |
+    # description: |
-      Endpoint definitions for interacting with clients.
+    #   Endpoint definitions for interacting with clients.
   - name: products
     description: |
       Endpoint definitions for interacting with products.

openapi/paths/clients.yaml

@@ -400,7 +400,43 @@
       tags:
         - clients
       summary: 'Bulk client actions'
-      description: 'Archive / Restore / Delete in bulk'
+      description: |
+        Bulk actions allow to make changes to multiple clients in a single request the following actions are supported
+        
+        - archive
+        - restore
+        - delete
+        - template _requires template,template_id properties also_
+        - assign_group _requires group_settings_id also_
+        - bulk_update _ requires column,new_value also_
+
+        All of these actions require an array of client ids to perform the requested action on ie.
+
+        "ids":['id1','id2']
+
+        actions such as template, assign_group and bulk_update also require additional properties to be passed in the request
+
+        - template
+
+        The template bulk action allows the creation of a custom template using the provided template_id to be run against the array of clients provided.
+
+        - assign_group
+        
+        Allows the setting of multiple clients to a single group
+
+        - bulk_update
+
+        Allows updating certain columns on the client model in bulk. the current list of supported columns that can be updated archived_at:
+
+        - public_notes
+        - industry_id
+        - size_id
+        - country_id
+        - custom_value1
+        - custom_value2
+        - custom_value3
+        - custom_value4
+
       operationId: bulkClients
       parameters:
         - $ref: '#/components/parameters/X-API-TOKEN'
@@ -416,7 +452,7 @@
               
       responses:
         200:
-          description: 'The Client listresponse'
+          description: 'The Client list Response of the updated clients that were bulk updated'
           headers:
             X-MINIMUM-CLIENT-VERSION:
               $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
@@ -501,7 +537,7 @@
         - clients
       summary: 'Purge client'
       description: |
-            Handles purging a clients.
+            Handles purging a client.
 
             Please note this is a destructive action.