diff --git a/openapi/api-docs.yaml b/openapi/api-docs.yaml index 0b09d4ac70b6..a904cef64414 100644 --- a/openapi/api-docs.yaml +++ b/openapi/api-docs.yaml @@ -8657,6 +8657,13 @@ paths: type: string format: string example: D2J234DFA + requestBody: + description: Client object that needs to be updated + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ClientRequest' responses: 200: description: 'Returns the client object' @@ -8902,7 +8909,12 @@ paths: tags: - clients summary: 'Purge client' - description: 'Handles purging a client' + description: | + Handles purging a clients. + + Please note this is a destructive action. + + This action will remove all data associated with the client and cannot be undone. operationId: purgeClient parameters: - $ref: '#/components/parameters/X-API-TOKEN' @@ -8942,7 +8954,12 @@ paths: tags: - clients summary: 'Merge client' - description: 'Handles merging 2 clients' + description: | + Handles merging 2 clients + + The id parameter is the client that will be the primary client after the merge has completed. + + The mergeable_client_hashed_id is the client that will be merged into the primary client, this clients records will be updated and associated with the primary client. operationId: mergeClient parameters: - $ref: '#/components/parameters/X-API-TOKEN' @@ -8997,7 +9014,7 @@ paths: - $ref: '#/components/parameters/X-Requested-With' - $ref: '#/components/parameters/include' requestBody: - description: 'Statment Options' + description: 'Statement Options' required: true content: application/json: @@ -9015,6 +9032,9 @@ paths: show_payments_table: description: 'Flag which determines if the payments table is shown' type: boolean + show_credits_table: + description: 'Flag which determines if the credits table is shown' + type: boolean show_aging_table: description: 'Flag which determines if the aging table is shown' type: boolean @@ -9740,6 +9760,13 @@ paths: type: string format: string example: D2J234DFA + requestBody: + description: Product object that needs to be added to the company + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ProductRequest' responses: 200: description: "Returns the Product object" @@ -17030,6 +17057,9 @@ components: example: google type: object ClientRequest: + required: + - contacts + - country_id properties: id: description: 'The unique identifier of the client' @@ -17038,6 +17068,7 @@ components: readOnly: true contacts: type: array + description: 'A list of contacts associated with the client' items: $ref: '#/components/schemas/ClientContactRequest' name: diff --git a/openapi/components/schemas/client_request.yaml b/openapi/components/schemas/client_request.yaml index df8bc4d3cf0b..552282aebf4a 100644 --- a/openapi/components/schemas/client_request.yaml +++ b/openapi/components/schemas/client_request.yaml @@ -1,4 +1,7 @@ ClientRequest: + required: + - contacts + - country_id properties: id: description: 'The unique identifier of the client' @@ -7,6 +10,7 @@ readOnly: true contacts: type: array + description: 'A list of contacts associated with the client' items: $ref: '#/components/schemas/ClientContactRequest' name: diff --git a/openapi/paths/clients.yaml b/openapi/paths/clients.yaml index bc2085b8252d..7194f8981bc5 100644 --- a/openapi/paths/clients.yaml +++ b/openapi/paths/clients.yaml @@ -235,6 +235,13 @@ type: string format: string example: D2J234DFA + requestBody: + description: Client object that needs to be updated + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ClientRequest' responses: 200: description: 'Returns the client object' @@ -480,7 +487,12 @@ tags: - clients summary: 'Purge client' - description: 'Handles purging a client' + description: | + Handles purging a clients. + + Please note this is a destructive action. + + This action will remove all data associated with the client and cannot be undone. operationId: purgeClient parameters: - $ref: '#/components/parameters/X-API-TOKEN' @@ -520,7 +532,12 @@ tags: - clients summary: 'Merge client' - description: 'Handles merging 2 clients' + description: | + Handles merging 2 clients + + The id parameter is the client that will be the primary client after the merge has completed. + + The mergeable_client_hashed_id is the client that will be merged into the primary client, this clients records will be updated and associated with the primary client. operationId: mergeClient parameters: - $ref: '#/components/parameters/X-API-TOKEN' @@ -575,7 +592,7 @@ - $ref: '#/components/parameters/X-Requested-With' - $ref: '#/components/parameters/include' requestBody: - description: 'Statment Options' + description: 'Statement Options' required: true content: application/json: @@ -593,6 +610,9 @@ show_payments_table: description: 'Flag which determines if the payments table is shown' type: boolean + show_credits_table: + description: 'Flag which determines if the credits table is shown' + type: boolean show_aging_table: description: 'Flag which determines if the aging table is shown' type: boolean diff --git a/openapi/paths/products.yaml b/openapi/paths/products.yaml index ba377eb09635..1cbbfc8c5a18 100644 --- a/openapi/paths/products.yaml +++ b/openapi/paths/products.yaml @@ -172,6 +172,13 @@ type: string format: string example: D2J234DFA + requestBody: + description: Product object that needs to be added to the company + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ProductRequest' responses: 200: description: "Returns the Product object"