diff --git a/openapi/api-docs.yaml b/openapi/api-docs.yaml index 70020b625e5c..8cc1473948d5 100644 --- a/openapi/api-docs.yaml +++ b/openapi/api-docs.yaml @@ -27,25 +27,19 @@ paths: get: tags: - actvities - summary: 'Returns a list of actvities' - description: 'Lists all activities related to this company' + summary: "Returns a list of actvities" + description: "Lists all activities related to this company" operationId: getActivities parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/activity_include' - - - $ref: '#/components/parameters/index' - - - $ref: '#/components/parameters/per_page_meta' - - - $ref: '#/components/parameters/page_meta' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/activity_include" + - $ref: "#/components/parameters/index" + - $ref: "#/components/parameters/per_page_meta" + - $ref: "#/components/parameters/page_meta" responses: 200: - description: 'A list of actvities' + description: 'Returns the client object' headers: X-MINIMUM-CLIENT-VERSION: $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' @@ -56,31 +50,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Activity' - default: - description: 'Unexpected Error' + $ref: '#/components/schemas/Client' + 401: + description: 'Authentication error' content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/actvities/download_entity/{activity_id}': + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' + 422: + $ref: '#/components/responses/422' + default: + $ref: '#/components/responses/default' + "/api/v1/actvities/download_entity/{activity_id}": get: tags: - actvities - summary: 'Returns a PDF for the given activity' - description: 'Returns a PDF for the given activity' + summary: "Returns a PDF for the given activity" + description: "Returns a PDF for the given activity" operationId: getActivityHistoricalEntityPdf parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/activity_include' - - - name: activity_id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/activity_include" + - name: activity_id in: path - description: 'The Activity Hashed ID' + description: "The Activity Hashed ID" required: true schema: type: string @@ -88,63 +84,64 @@ paths: example: D2J234DFA responses: 200: - description: 'PDF File' + description: "PDF File" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 404: - description: 'No file exists for the given record' - default: - description: 'Unexpected Error' + description: "No file exists for the given record" + 401: + description: 'Authentication error' content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' + 422: + $ref: '#/components/responses/422' + default: + $ref: '#/components/responses/default' + /api/v1/login: post: tags: - login - summary: 'Attempts authentication' - description: 'Returns a CompanyUser object on success' + summary: "Attempts authentication" + description: "Returns a CompanyUser object on success" operationId: postLogin security: - [] parameters: - - - $ref: '#/components/parameters/X-API-SECRET' - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/login_include' - - - $ref: '#/components/parameters/include_static' - - - $ref: '#/components/parameters/clear_cache' + - $ref: "#/components/parameters/X-API-SECRET" + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/login_include" + - $ref: "#/components/parameters/include_static" + - $ref: "#/components/parameters/clear_cache" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: properties: email: - description: 'The users email address.' + description: "The users email address." type: string - example: 'demo@invoiceninja.com' + example: "demo@invoiceninja.com" password: - description: 'The user password. Must meet minimum criteria ~ > 6 characters' + description: "The user password. Must meet minimum criteria ~ > 6 characters" type: string - example: 'Password0' + example: "Password0" type: object responses: 200: - description: 'The Company User response' + description: 'Returns the company user object' headers: X-MINIMUM-CLIENT-VERSION: $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' @@ -155,209 +152,217 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CompanyUser' + $ref: '#/components/schemas/Client' 401: - description: 'Authentication failure' + description: 'Authentication error' content: application/json: schema: - $ref: '#/components/schemas/AuthenticationError' + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' + 422: + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' /api/v1/refresh: post: tags: - refresh - summary: 'Refresh data by timestamp' + summary: "Refresh data by timestamp" description: | - Refreshes the dataset. + Refreshes the dataset. - This endpoint can be used if you only need to access the most recent data from a certain point in time. - operationId: refresh + This endpoint can be used if you only need to access the most recent data from a certain point in time. + operationId: refresh parameters: - - - name: updated_at + - name: updated_at in: query - description: 'The unix timestamp from which the refreshed data should be sent from, if no value is passed the system will assume you require all data.' + description: "The unix timestamp from which the refreshed data should be sent from, if no value is passed the system will assume you require all data." required: true schema: type: number format: integer example: 1676173763 - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/include_static' - - - $ref: '#/components/parameters/clear_cache' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/include_static" + - $ref: "#/components/parameters/clear_cache" responses: 200: - description: 'The Company User response' + description: "The Company User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyUser' + $ref: "#/components/schemas/CompanyUser" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' + 422: + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/yodlee/refresh: post: tags: - yodlee - summary: 'Yodlee Webhook' - description: 'Webhook endpoint for Yodlee. Used to notify the system that a data point can be updated.' + summary: "Yodlee Webhook" + description: "Webhook endpoint for Yodlee. Used to notify the system that a data point can be updated." operationId: yodleeRefreshWebhook parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: '' + description: "" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' + 422: + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_integrations: get: tags: - bank_integrations - summary: 'Returns a list of Bank Integrations' - description: 'Lists all bank integrations' + summary: "Returns a list of Bank Integrations" + description: "Lists all bank integrations" operationId: getBankIntegrations parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/bank_integration_include' - - - $ref: '#/components/parameters/index' - - - name: rows + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/bank_integration_include" + - $ref: "#/components/parameters/index" + - name: rows in: query - description: 'The number of bank integrations to return' + description: "The number of bank integrations to return" required: false schema: type: number format: integer - example: '50' + example: "50" responses: 200: - description: 'A list of bank integrations' + description: "A list of bank integrations" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - bank_integrations - summary: 'Adds a bank_integration' - description: 'Adds an bank_integration to a company' + summary: "Adds a bank_integration" + description: "Adds an bank_integration to a company" operationId: storeBankIntegration parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved bank_integration object' + description: "Returns the saved bank_integration object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/bank_integrations/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/bank_integrations/{id}": get: tags: - bank_integrations - summary: 'Shows a bank_integration' - description: 'Displays a bank_integration by id' + summary: "Shows a bank_integration" + description: "Displays a bank_integration by id" operationId: showBankIntegration parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The BankIntegration Hashed ID' + description: "The BankIntegration Hashed ID" required: true schema: type: string @@ -365,47 +370,47 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_integration object' + description: "Returns the bank_integration object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - bank_integrations - summary: 'Updates a bank_integration' - description: 'Handles the updating of a bank_integration by id' + summary: "Updates a bank_integration" + description: "Handles the updating of a bank_integration by id" operationId: updateBankIntegration parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The BankIntegration Hashed ID' + description: "The BankIntegration Hashed ID" required: true schema: type: string @@ -413,47 +418,47 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_integration object' + description: "Returns the bank_integration object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - bank_integrations - summary: 'Deletes a bank_integration' - description: 'Handles the deletion of a bank_integration by id' + summary: "Deletes a bank_integration" + description: "Handles the deletion of a bank_integration by id" operationId: deleteBankIntegration parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The BankIntegration Hashed ID' + description: "The BankIntegration Hashed ID" required: true schema: type: string @@ -461,44 +466,44 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/bank_integrations/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/bank_integrations/{id}/edit": get: tags: - bank_integrations - summary: 'Shows a bank_integration for editing' - description: 'Displays a bank_integration by id' + summary: "Shows a bank_integration for editing" + description: "Displays a bank_integration by id" operationId: editBankIntegration parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The BankIntegration Hashed ID' + description: "The BankIntegration Hashed ID" required: true schema: type: string @@ -506,345 +511,326 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_integration object' + description: "Returns the bank_integration object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_integrations/create: get: tags: - bank_integrations - summary: 'Gets a new blank bank_integration object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank bank_integration object" + description: "Returns a blank object with default values" operationId: getBankIntegrationsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank bank_integration object' + description: "A blank bank_integration object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_integrations/bulk: post: tags: - bank_integrations - summary: 'Performs bulk actions on an array of bank_integrations' - description: '' + summary: "Performs bulk actions on an array of bank_integrations" + description: "" operationId: bulkBankIntegrations parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Action paramters' + description: "Action paramters" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Bulk Action response' + description: "The Bulk Action response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_integrations/refresh_accounts: post: tags: - bank_integrations - summary: 'Gets the list of accounts from the remote server' - description: 'Adds an bank_integration to a company' + summary: "Gets the list of accounts from the remote server" + description: "Adds an bank_integration to a company" operationId: getRefreshAccounts parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved bank_integration object' + description: "Returns the saved bank_integration object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_integrations/remove_account/account_id: post: tags: - bank_integrations - summary: 'Removes an account from the integration' - description: 'Removes an account from the integration' + summary: "Removes an account from the integration" + description: "Removes an account from the integration" operationId: getRemoveAccount parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the bank_integration object' + description: "Returns the bank_integration object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_integrations/get_transactions/account_id: post: tags: - bank_integrations - summary: 'Retrieve transactions for a account' - description: 'Retrieve transactions for a account' + summary: "Retrieve transactions for a account" + description: "Retrieve transactions for a account" operationId: getAccountTransactions parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Retrieve transactions for a account' + description: "Retrieve transactions for a account" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_transactions: get: tags: - bank_transactions - summary: 'Gets a list of bank_transactions' - description: 'Lists all bank integrations' + summary: "Gets a list of bank_transactions" + description: "Lists all bank integrations" operationId: getBankTransactions parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' - - - name: rows + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" + - name: rows in: query - description: 'The number of bank integrations to return' + description: "The number of bank integrations to return" required: false schema: type: number format: integer - example: '50' + example: "50" responses: 200: - description: 'A list of bank integrations' + description: "A list of bank integrations" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransaction' + $ref: "#/components/schemas/BankTransaction" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - bank_transactions - summary: 'Adds a bank_transaction' - description: 'Adds an bank_transaction to a company' + summary: "Adds a bank_transaction" + description: "Adds an bank_transaction to a company" operationId: storeBankTransaction parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved bank_transaction object' + description: "Returns the saved bank_transaction object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransaction' + $ref: "#/components/schemas/BankTransaction" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/bank_transactions/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/bank_transactions/{id}": get: tags: - bank_transactions - summary: 'Shows a bank_transaction' - description: 'Displays a bank_transaction by id' + summary: "Shows a bank_transaction" + description: "Displays a bank_transaction by id" operationId: showBankTransaction parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The BankTransaction Hashed ID' + description: "The BankTransaction Hashed ID" required: true schema: type: string @@ -852,47 +838,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_transaction object' + description: "Returns the bank_transaction object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransaction' + $ref: "#/components/schemas/BankTransaction" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - bank_transactions - summary: 'Updates a bank_transaction' - description: 'Handles the updating of a bank_transaction by id' + summary: "Updates a bank_transaction" + description: "Handles the updating of a bank_transaction by id" operationId: updateBankTransaction parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The BankTransaction Hashed ID' + description: "The BankTransaction Hashed ID" required: true schema: type: string @@ -900,47 +882,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_transaction object' + description: "Returns the bank_transaction object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransaction' + $ref: "#/components/schemas/BankTransaction" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - bank_transactions - summary: 'Deletes a bank_transaction' - description: 'Handles the deletion of a bank_transaction by id' + summary: "Deletes a bank_transaction" + description: "Handles the deletion of a bank_transaction by id" operationId: deleteBankTransaction parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The BankTransaction Hashed ID' + description: "The BankTransaction Hashed ID" required: true schema: type: string @@ -948,44 +926,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/bank_transactions/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/bank_transactions/{id}/edit": get: tags: - bank_transactions - summary: 'Shows a bank_transaction for editing' - description: 'Displays a bank_transaction by id' + summary: "Shows a bank_transaction for editing" + description: "Displays a bank_transaction by id" operationId: editBankTransaction parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The BankTransaction Hashed ID' + description: "The BankTransaction Hashed ID" required: true schema: type: string @@ -993,272 +967,251 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_transaction object' + description: "Returns the bank_transaction object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransaction' + $ref: "#/components/schemas/BankTransaction" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_transactions/create: get: tags: - bank_transactions - summary: 'Gets a new blank bank_transaction object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank bank_transaction object" + description: "Returns a blank object with default values" operationId: getBankTransactionsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank bank_transaction object' + description: "A blank bank_transaction object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransaction' + $ref: "#/components/schemas/BankTransaction" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_transations/bulk: post: tags: - bank_transactions - summary: 'Performs bulk actions on an array of bank_transations' - description: '' + summary: "Performs bulk actions on an array of bank_transations" + description: "" operationId: bulkBankTransactions parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Action paramters' + description: "Action paramters" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Bulk Action response' + description: "The Bulk Action response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_transations/match: post: tags: - bank_transactions - summary: 'Performs match actions on an array of bank_transactions' - description: '' + summary: "Performs match actions on an array of bank_transactions" + description: "" operationId: matchBankTransactions parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Action paramters' + description: "Action paramters" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Bulk Action response' + description: "The Bulk Action response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_transaction_rules: get: tags: - bank_transaction_rules - summary: 'Gets a list of bank_transaction_rules' - description: 'Lists all bank transaction rules' + summary: "Gets a list of bank_transaction_rules" + description: "Lists all bank transaction rules" operationId: getBankTransactionRules parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' - - - name: rows + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" + - name: rows in: query - description: 'The number of bank integrations to return' + description: "The number of bank integrations to return" required: false schema: type: number format: integer - example: '50' + example: "50" responses: 200: - description: 'A list of bank integrations' + description: "A list of bank integrations" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransactionRule' + $ref: "#/components/schemas/BankTransactionRule" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - bank_transaction_rules - summary: 'Adds a bank_transaction rule' - description: 'Adds an bank_transaction to a company' + summary: "Adds a bank_transaction rule" + description: "Adds an bank_transaction to a company" operationId: storeBankTransactionRule parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved bank_transaction rule object' + description: "Returns the saved bank_transaction rule object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransactionRule' + $ref: "#/components/schemas/BankTransactionRule" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/bank_transaction_rules/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/bank_transaction_rules/{id}": get: tags: - bank_transaction_rules - summary: 'Shows a bank_transaction' - description: 'Displays a bank_transaction by id' + summary: "Shows a bank_transaction" + description: "Displays a bank_transaction by id" operationId: showBankTransactionRule parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Bank Transaction RuleHashed ID' + description: "The Bank Transaction RuleHashed ID" required: true schema: type: string @@ -1266,47 +1219,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_transaction rule object' + description: "Returns the bank_transaction rule object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransactionRule' + $ref: "#/components/schemas/BankTransactionRule" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - bank_transaction_rules - summary: 'Updates a bank_transaction Rule' - description: 'Handles the updating of a bank_transaction rule by id' + summary: "Updates a bank_transaction Rule" + description: "Handles the updating of a bank_transaction rule by id" operationId: updateBankTransactionRule parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Bank Transaction Rule Hashed ID' + description: "The Bank Transaction Rule Hashed ID" required: true schema: type: string @@ -1314,47 +1263,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_transaction rule object' + description: "Returns the bank_transaction rule object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransactionRule' + $ref: "#/components/schemas/BankTransactionRule" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - bank_transaction_rules - summary: 'Deletes a bank_transaction rule' - description: 'Handles the deletion of a bank_transaction rule by id' + summary: "Deletes a bank_transaction rule" + description: "Handles the deletion of a bank_transaction rule by id" operationId: deleteBankTransactionRule parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Bank Transaction Rule Hashed ID' + description: "The Bank Transaction Rule Hashed ID" required: true schema: type: string @@ -1362,44 +1307,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/bank_transaction_rules/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/bank_transaction_rules/{id}/edit": get: tags: - bank_transaction_rules - summary: 'Shows a bank_transaction for editing' - description: 'Displays a bank_transaction by id' + summary: "Shows a bank_transaction for editing" + description: "Displays a bank_transaction by id" operationId: editBankTransactionRule parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Bank Transaction Rule Hashed ID' + description: "The Bank Transaction Rule Hashed ID" required: true schema: type: string @@ -1407,264 +1348,242 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_transaction rule object' + description: "Returns the bank_transaction rule object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransactionRule' + $ref: "#/components/schemas/BankTransactionRule" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_transaction_rules/create: get: tags: - bank_transaction_rules - summary: 'Gets a new blank bank_transaction rule object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank bank_transaction rule object" + description: "Returns a blank object with default values" operationId: getBankTransactionRulesCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank bank_transaction rule object' + description: "A blank bank_transaction rule object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransactionRule' + $ref: "#/components/schemas/BankTransactionRule" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_transation_rules/bulk: post: tags: - bank_transaction_rules - summary: 'Performs bulk actions on an array of bank_transation rules' - description: '' + summary: "Performs bulk actions on an array of bank_transation rules" + description: "" operationId: bulkBankTransactionRules parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Action paramters' + description: "Action paramters" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Bulk Action response' + description: "The Bulk Action response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/charts/totals: post: tags: - charts - summary: 'Get chart data' - description: 'Get chart data' + summary: "Get chart data" + description: "Get chart data" operationId: getChartTotals parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' - - - name: rows + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" + - name: rows in: query - description: 'The chart' + description: "The chart" required: false schema: type: number format: integer - example: '50' + example: "50" responses: 200: - description: 'json dataset of chart data' + description: "json dataset of chart data" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/client_gateway_tokens: get: tags: - client_gateway_tokens - summary: 'List of client tokens' + summary: "List of client tokens" description: "Lists client_gateway_tokens, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the client_gateway_tokens, these are handled by the ClientGatewayTokenFilters class which defines the methods available" operationId: getClientGatewayTokens parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of client_gateway_tokens' + description: "A list of client_gateway_tokens" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ClientGatewayToken' + $ref: "#/components/schemas/ClientGatewayToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - client_gateway_tokens - summary: 'Adds a client' - description: 'Adds an client to a company' + summary: "Adds a client" + description: "Adds an client to a company" operationId: storeClientGatewayToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved client object' + description: "Returns the saved client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ClientGatewayToken' + $ref: "#/components/schemas/ClientGatewayToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/client_gateway_tokens/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/client_gateway_tokens/{id}": get: tags: - client_gateway_tokens - summary: 'Shows a client' - description: 'Displays a client by id' + summary: "Shows a client" + description: "Displays a client by id" operationId: showClientGatewayToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The ClientGatewayToken Hashed ID' + description: "The ClientGatewayToken Hashed ID" required: true schema: type: string @@ -1672,47 +1591,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the cl.ient object' + description: "Returns the cl.ient object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ClientGatewayToken' + $ref: "#/components/schemas/ClientGatewayToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - client_gateway_tokens - summary: 'Updates a client' - description: 'Handles the updating of a client by id' + summary: "Updates a client" + description: "Handles the updating of a client by id" operationId: updateClientGatewayToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The ClientGatewayToken Hashed ID' + description: "The ClientGatewayToken Hashed ID" required: true schema: type: string @@ -1720,47 +1635,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ClientGatewayToken' + $ref: "#/components/schemas/ClientGatewayToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - client_gateway_tokens - summary: 'Deletes a client' - description: 'Handles the deletion of a client by id' + summary: "Deletes a client" + description: "Handles the deletion of a client by id" operationId: deleteClientGatewayToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The ClientGatewayToken Hashed ID' + description: "The ClientGatewayToken Hashed ID" required: true schema: type: string @@ -1768,44 +1679,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/client_gateway_tokens/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/client_gateway_tokens/{id}/edit": get: tags: - client_gateway_tokens - summary: 'Shows a client for editting' - description: 'Displays a client by id' + summary: "Shows a client for editting" + description: "Displays a client by id" operationId: editClientGatewayToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The ClientGatewayToken Hashed ID' + description: "The ClientGatewayToken Hashed ID" required: true schema: type: string @@ -1813,208 +1720,192 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ClientGatewayToken' + $ref: "#/components/schemas/ClientGatewayToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/client_gateway_tokens/create: get: tags: - client_gateway_tokens - summary: 'Gets a new blank client object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank client object" + description: "Returns a blank object with default values" operationId: getClientGatewayTokensCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank client object' + description: "A blank client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ClientGatewayToken' + $ref: "#/components/schemas/ClientGatewayToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - + $ref: "#/components/schemas/Error" + /api/v1/companies: get: tags: - companies - summary: 'Gets a list of companies' + summary: "Gets a list of companies" description: "Lists companies, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the companies, these are handled by the CompanyFilters class which defines the methods available" operationId: getCompanies parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of companies' + description: "A list of companies" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Company' + $ref: "#/components/schemas/Company" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - companies - summary: 'Adds a company' - description: 'Adds an company to the system' + summary: "Adds a company" + description: "Adds an company to the system" operationId: storeCompany parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved company object' + description: "Returns the saved company object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Company' + $ref: "#/components/schemas/Company" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/companies/create: get: tags: - companies - summary: 'Gets a new blank company object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank company object" + description: "Returns a blank object with default values" operationId: getCompaniesCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank company object' + description: "A blank company object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Company' + $ref: "#/components/schemas/Company" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/companies/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/companies/{id}": get: tags: - companies - summary: 'Shows an company' - description: 'Displays an company by id' + summary: "Shows an company" + description: "Displays an company by id" operationId: showCompany parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Company Hashed ID' + description: "The Company Hashed ID" required: true schema: type: string @@ -2022,47 +1913,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the company object' + description: "Returns the company object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Company' + $ref: "#/components/schemas/Company" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - companies - summary: 'Updates an company' - description: 'Handles the updating of an company by id' + summary: "Updates an company" + description: "Handles the updating of an company by id" operationId: updateCompany parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Company Hashed ID' + description: "The Company Hashed ID" required: true schema: type: string @@ -2070,47 +1957,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the company object' + description: "Returns the company object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Company' + $ref: "#/components/schemas/Company" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - companies - summary: 'Deletes a company' - description: 'Handles the deletion of an company by id' + summary: "Deletes a company" + description: "Handles the deletion of an company by id" operationId: deleteCompany parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Company Hashed ID' + description: "The Company Hashed ID" required: true schema: type: string @@ -2118,44 +2001,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/companies/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/companies/{id}/edit": get: tags: - companies - summary: 'Shows an company for editting' - description: 'Displays an company by id' + summary: "Shows an company for editting" + description: "Displays an company by id" operationId: editCompany parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Company Hashed ID' + description: "The Company Hashed ID" required: true schema: type: string @@ -2163,48 +2042,44 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the company object' + description: "Returns the company object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Company' + $ref: "#/components/schemas/Company" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/companies/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/companies/{id}/upload": put: tags: - companies - summary: 'Uploads a document to a company' - description: 'Handles the uploading of a document to a company' + summary: "Uploads a document to a company" + description: "Handles the uploading of a document to a company" operationId: uploadCompanies parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Company Hashed ID' + description: "The Company Hashed ID" required: true schema: type: string @@ -2212,48 +2087,44 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Company' + $ref: "#/components/schemas/Company" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/companies/{company}/default': + $ref: "#/components/schemas/Error" + "/api/v1/companies/{company}/default": post: tags: - companies - summary: 'Sets the company as the default company.' - description: 'Sets the company as the default company.' + summary: "Sets the company as the default company." + description: "Sets the company as the default company." operationId: setDefaultCompany parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: company + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: company in: path - description: 'The Company Hashed ID' + description: "The Company Hashed ID" required: true schema: type: string @@ -2261,167 +2132,154 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the company object' + description: "Returns the company object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Company' + $ref: "#/components/schemas/Company" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/company_gateways: get: tags: - company_gateways - summary: 'Gets a list of company_gateways' + summary: "Gets a list of company_gateways" description: "Lists company_gateways, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the company_gateways, these are handled by the CompanyGatewayFilters class which defines the methods available" operationId: getCompanyGateways parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of company_gateways' + description: "A list of company_gateways" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyGateway' + $ref: "#/components/schemas/CompanyGateway" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - company_gateways - summary: 'Adds a CompanyGateway' - description: 'Adds an CompanyGateway to the system' + summary: "Adds a CompanyGateway" + description: "Adds an CompanyGateway to the system" operationId: storeCompanyGateway parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved CompanyGateway object' + description: "Returns the saved CompanyGateway object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyGateway' + $ref: "#/components/schemas/CompanyGateway" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/company_gateways/create: get: tags: - company_gateways - summary: 'Gets a new blank CompanyGateway object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank CompanyGateway object" + description: "Returns a blank object with default values" operationId: getCompanyGatewaysCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank CompanyGateway object' + description: "A blank CompanyGateway object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyGateway' + $ref: "#/components/schemas/CompanyGateway" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/company_gateways/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/company_gateways/{id}": get: tags: - company_gateways - summary: 'Shows an CompanyGateway' - description: 'Displays an CompanyGateway by id' + summary: "Shows an CompanyGateway" + description: "Displays an CompanyGateway by id" operationId: showCompanyGateway parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The CompanyGateway Hashed ID' + description: "The CompanyGateway Hashed ID" required: true schema: type: string @@ -2429,47 +2287,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the CompanyGateway object' + description: "Returns the CompanyGateway object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyGateway' + $ref: "#/components/schemas/CompanyGateway" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - company_gateways - summary: 'Updates an CompanyGateway' - description: 'Handles the updating of an CompanyGateway by id' + summary: "Updates an CompanyGateway" + description: "Handles the updating of an CompanyGateway by id" operationId: updateCompanyGateway parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The CompanyGateway Hashed ID' + description: "The CompanyGateway Hashed ID" required: true schema: type: string @@ -2477,47 +2331,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the CompanyGateway object' + description: "Returns the CompanyGateway object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyGateway' + $ref: "#/components/schemas/CompanyGateway" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - company_gateways - summary: 'Deletes a CompanyGateway' - description: 'Handles the deletion of an CompanyGateway by id' + summary: "Deletes a CompanyGateway" + description: "Handles the deletion of an CompanyGateway by id" operationId: deleteCompanyGateway parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The CompanyGateway Hashed ID' + description: "The CompanyGateway Hashed ID" required: true schema: type: string @@ -2525,44 +2375,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/company_gateways/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/company_gateways/{id}/edit": get: tags: - company_gateways - summary: 'Shows an CompanyGateway for editting' - description: 'Displays an CompanyGateway by id' + summary: "Shows an CompanyGateway for editting" + description: "Displays an CompanyGateway by id" operationId: editCompanyGateway parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The CompanyGateway Hashed ID' + description: "The CompanyGateway Hashed ID" required: true schema: type: string @@ -2570,338 +2416,313 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the CompanyGateway object' + description: "Returns the CompanyGateway object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyGateway' + $ref: "#/components/schemas/CompanyGateway" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/company_gateways/bulk: post: tags: - company_gateways - summary: 'Performs bulk actions on an array of company_gateways' - description: '' + summary: "Performs bulk actions on an array of company_gateways" + description: "" operationId: bulkCompanyGateways parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Array of company gateway IDs' + description: "Array of company gateway IDs" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Company Gateways response' + description: "The Company Gateways response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyGateway' + $ref: "#/components/schemas/CompanyGateway" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/company_ledger: get: tags: - company_ledger - summary: 'Gets a list of company_ledger' - description: 'Lists the company_ledger.' + summary: "Gets a list of company_ledger" + description: "Lists the company_ledger." operationId: getCompanyLedger parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of company_ledger' + description: "A list of company_ledger" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyLedger' + $ref: "#/components/schemas/CompanyLedger" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/company_users: post: tags: - company_user - summary: 'Update a company user record' - description: 'Attempts to update a company user record. A company user can modify only their settings fields. Full access for Admin users' + summary: "Update a company user record" + description: "Attempts to update a company user record. A company user can modify only their settings fields. Full access for Admin users" operationId: updateCompanyUser parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'The Company User response' + description: "The Company User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyUser' + $ref: "#/components/schemas/CompanyUser" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/connected_account: post: tags: - connected_account - summary: 'Connect an oauth user to an existing user' - description: 'Refreshes the dataset' + summary: "Connect an oauth user to an existing user" + description: "Refreshes the dataset" operationId: connected_account parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/include_static' - - - $ref: '#/components/parameters/clear_cache' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/include_static" + - $ref: "#/components/parameters/clear_cache" responses: 200: - description: 'The Company User response' + description: "The Company User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/credits: get: tags: - credits - summary: 'Gets a list of credits' + summary: "Gets a list of credits" description: "Lists credits, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the credits, these are handled by the CreditFilters class which defines the methods available" operationId: getCredits parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of credits' + description: "A list of credits" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - credits - summary: 'Adds a credit' - description: 'Adds an credit to the system' + summary: "Adds a credit" + description: "Adds an credit to the system" operationId: storeCredit parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved credit object' + description: "Returns the saved credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/credits/create: get: tags: - credits - summary: 'Gets a new blank credit object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank credit object" + description: "Returns a blank object with default values" operationId: getCreditsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank credit object' + description: "A blank credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/credits/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/credits/{id}": get: tags: - credits - summary: 'Shows an credit' - description: 'Displays an credit by id' + summary: "Shows an credit" + description: "Displays an credit by id" operationId: showCredit parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Credit Hashed ID' + description: "The Credit Hashed ID" required: true schema: type: string @@ -2909,47 +2730,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the credit object' + description: "Returns the credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - Credits - summary: 'Updates an Credit' - description: 'Handles the updating of an Credit by id' + summary: "Updates an Credit" + description: "Handles the updating of an Credit by id" operationId: updateCredit parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Credit Hashed ID' + description: "The Credit Hashed ID" required: true schema: type: string @@ -2957,47 +2774,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Credit object' + description: "Returns the Credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - credits - summary: 'Deletes a credit' - description: 'Handles the deletion of an credit by id' + summary: "Deletes a credit" + description: "Handles the deletion of an credit by id" operationId: deleteCredit parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Credit Hashed ID' + description: "The Credit Hashed ID" required: true schema: type: string @@ -3005,44 +2818,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/credits/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/credits/{id}/edit": get: tags: - credits - summary: 'Shows an credit for editting' - description: 'Displays an credit by id' + summary: "Shows an credit for editting" + description: "Displays an credit by id" operationId: editCredit parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Invoice Hashed ID' + description: "The Invoice Hashed ID" required: true schema: type: string @@ -3050,95 +2859,88 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the credit object' + description: "Returns the credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/credits/bulk: post: tags: - credits - summary: 'Performs bulk actions on an array of credits' - description: '' + summary: "Performs bulk actions on an array of credits" + description: "" operationId: bulkCredits parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Bulk Action response' + description: "The Bulk Action response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/credit/{invitation_key}/download': + $ref: "#/components/schemas/Error" + "/api/v1/credit/{invitation_key}/download": get: tags: - quotes - summary: 'Download a specific credit by invitation key' - description: 'Downloads a specific quote' + summary: "Download a specific credit by invitation key" + description: "Downloads a specific quote" operationId: downloadCredit parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: invitation_key + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: invitation_key in: path - description: 'The Credit Invitation Key' + description: "The Credit Invitation Key" required: true schema: type: string @@ -3146,44 +2948,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the credit pdf' + description: "Returns the credit pdf" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/credits/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/credits/{id}/upload": put: tags: - credits - summary: 'Uploads a document to a credit' - description: 'Handles the uploading of a document to a credit' + summary: "Uploads a document to a credit" + description: "Handles the uploading of a document to a credit" operationId: uploadCredits parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Credit Hashed ID' + description: "The Credit Hashed ID" required: true schema: type: string @@ -3191,129 +2989,118 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Credit object' + description: "Returns the Credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/designs: get: tags: - designs - summary: 'Gets a list of designs' - description: 'Lists designs' + summary: "Gets a list of designs" + description: "Lists designs" operationId: getDesigns parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of designs' + description: "A list of designs" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Design' + $ref: "#/components/schemas/Design" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - designs - summary: 'Adds a design' - description: 'Adds an design to a company' + summary: "Adds a design" + description: "Adds an design to a company" operationId: storeDesign parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved design object' + description: "Returns the saved design object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Design' + $ref: "#/components/schemas/Design" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/designs/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/designs/{id}": get: tags: - designs - summary: 'Shows a design' - description: 'Displays a design by id' + summary: "Shows a design" + description: "Displays a design by id" operationId: showDesign parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Design Hashed ID' + description: "The Design Hashed ID" required: true schema: type: string @@ -3321,47 +3108,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the expense object' + description: "Returns the expense object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Design' + $ref: "#/components/schemas/Design" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - designs - summary: 'Updates a design' - description: 'Handles the updating of a design by id' + summary: "Updates a design" + description: "Handles the updating of a design by id" operationId: updateDesign parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Design Hashed ID' + description: "The Design Hashed ID" required: true schema: type: string @@ -3369,47 +3152,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the design object' + description: "Returns the design object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Design' + $ref: "#/components/schemas/Design" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - designs - summary: 'Deletes a design' - description: 'Handles the deletion of a design by id' + summary: "Deletes a design" + description: "Handles the deletion of a design by id" operationId: deleteDesign parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Design Hashed ID' + description: "The Design Hashed ID" required: true schema: type: string @@ -3417,44 +3196,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/designs/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/designs/{id}/edit": get: tags: - designs - summary: 'Shows a design for editting' - description: 'Displays a design by id' + summary: "Shows a design for editting" + description: "Displays a design by id" operationId: editDesign parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Design Hashed ID' + description: "The Design Hashed ID" required: true schema: type: string @@ -3462,194 +3237,183 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the design object' + description: "Returns the design object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Design' + $ref: "#/components/schemas/Design" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/designs/create: get: tags: - designs - summary: 'Gets a new blank design object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank design object" + description: "Returns a blank object with default values" operationId: getDesignsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank design object' + description: "A blank design object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Design' + $ref: "#/components/schemas/Design" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/designs/bulk: post: tags: - designs - summary: 'Performs bulk actions on an array of designs' - description: '' + summary: "Performs bulk actions on an array of designs" + description: "" operationId: bulkDesigns parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Design User response' + description: "The Design User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Design' + $ref: "#/components/schemas/Design" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/documents: get: tags: - documents - summary: 'Gets a list of documents' + summary: "Gets a list of documents" description: "Lists documents, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the documents, these are handled by the DocumentsFilters class which defines the methods available" operationId: getDocuments parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of documents' + description: "A list of documents" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Document' + $ref: "#/components/schemas/Document" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/emails: post: tags: - emails - summary: 'Sends an email for an entity' - description: 'Sends an email for an entity' + summary: "Sends an email for an entity" + description: "Sends an email for an entity" operationId: sendEmailTemplate parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: - description: 'The template subject and body' + description: "The template subject and body" required: true content: application/json: schema: properties: subject: - description: 'The email subject' + description: "The email subject" type: string body: - description: 'The email body' + description: "The email body" type: string entity: - description: 'The entity name' + description: "The entity name" type: string entity_id: - description: 'The entity_id' + description: "The entity_id" type: string template: - description: 'The template required' + description: "The template required" type: string type: object responses: @@ -3657,156 +3421,147 @@ paths: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Template' + $ref: "#/components/schemas/Template" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/expense_categories: get: tags: - expense_categories - summary: 'Gets a list of expense_categories' - description: 'Lists tax rates' + summary: "Gets a list of expense_categories" + description: "Lists tax rates" operationId: getExpenseCategorys parameters: - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of expense_categories' + description: "A list of expense_categories" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ExpenseCategory' + $ref: "#/components/schemas/ExpenseCategory" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - expense_categories - summary: 'Adds a expense category' - description: 'Adds an expense category to the system' + summary: "Adds a expense category" + description: "Adds an expense category to the system" operationId: storeExpenseCategory parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved invoice object' + description: "Returns the saved invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ExpenseCategory' + $ref: "#/components/schemas/ExpenseCategory" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/expense_categories/create: get: tags: - expense_categories - summary: 'Gets a new blank Expens Category object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank Expens Category object" + description: "Returns a blank object with default values" operationId: getExpenseCategoryCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'A blank Expens Category object' + description: "A blank Expens Category object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ExpenseCategory' + $ref: "#/components/schemas/ExpenseCategory" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/expense_categories/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/expense_categories/{id}": get: tags: - expense_categories - summary: 'Shows a Expens Category' - description: 'Displays an ExpenseCategory by id' + summary: "Shows a Expens Category" + description: "Displays an ExpenseCategory by id" operationId: showExpenseCategory parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The ExpenseCategory Hashed ID' + description: "The ExpenseCategory Hashed ID" required: true schema: type: string @@ -3814,45 +3569,42 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Expens Category object' + description: "Returns the Expens Category object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ExpenseCategory' + $ref: "#/components/schemas/ExpenseCategory" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - expense_categories - summary: 'Updates a tax rate' - description: 'Handles the updating of a tax rate by id' + summary: "Updates a tax rate" + description: "Handles the updating of a tax rate by id" operationId: updateExpenseCategory parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The ExpenseCategory Hashed ID' + description: "The ExpenseCategory Hashed ID" required: true schema: type: string @@ -3860,45 +3612,42 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the ExpenseCategory object' + description: "Returns the ExpenseCategory object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ExpenseCategory' + $ref: "#/components/schemas/ExpenseCategory" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - expense_categories - summary: 'Deletes a ExpenseCategory' - description: 'Handles the deletion of an ExpenseCategory by id' + summary: "Deletes a ExpenseCategory" + description: "Handles the deletion of an ExpenseCategory by id" operationId: deleteExpenseCategory parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The ExpenseCategory Hashed ID' + description: "The ExpenseCategory Hashed ID" required: true schema: type: string @@ -3906,42 +3655,39 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/expense_categories/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/expense_categories/{id}/edit": get: tags: - expense_categories - summary: 'Shows a Expens Category for editting' - description: 'Displays a Expens Category by id' + summary: "Shows a Expens Category for editting" + description: "Displays a Expens Category by id" operationId: editExpenseCategory parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The ExpenseCategory Hashed ID' + description: "The ExpenseCategory Hashed ID" required: true schema: type: string @@ -3949,180 +3695,166 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Expens Category object' + description: "Returns the Expens Category object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ExpenseCategory' + $ref: "#/components/schemas/ExpenseCategory" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/expense_categories/bulk: post: tags: - expense_categories - summary: 'Performs bulk actions on an array of ExpenseCategorys' - description: '' + summary: "Performs bulk actions on an array of ExpenseCategorys" + description: "" operationId: bulkExpenseCategorys parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Expens Categorys' + description: "Expens Categorys" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The ExpenseCategory List response' + description: "The ExpenseCategory List response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/expenses: get: tags: - expenses - summary: 'Gets a list of expenses' + summary: "Gets a list of expenses" description: "Lists expenses, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the expenses, these are handled by the ExpenseFilters class which defines the methods available" operationId: getExpenses parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of expenses' + description: "A list of expenses" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Expense' + $ref: "#/components/schemas/Expense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - expenses - summary: 'Adds a client' - description: 'Adds an client to a company' + summary: "Adds a client" + description: "Adds an client to a company" operationId: storeExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved client object' + description: "Returns the saved client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Expense' + $ref: "#/components/schemas/Expense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/expenses/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/expenses/{id}": get: tags: - expenses - summary: 'Shows a client' - description: 'Displays a client by id' + summary: "Shows a client" + description: "Displays a client by id" operationId: showExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Expense Hashed ID' + description: "The Expense Hashed ID" required: true schema: type: string @@ -4130,47 +3862,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the expense object' + description: "Returns the expense object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Expense' + $ref: "#/components/schemas/Expense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - expenses - summary: 'Updates a client' - description: 'Handles the updating of a client by id' + summary: "Updates a client" + description: "Handles the updating of a client by id" operationId: updateExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Expense Hashed ID' + description: "The Expense Hashed ID" required: true schema: type: string @@ -4178,47 +3906,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Expense' + $ref: "#/components/schemas/Expense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - expenses - summary: 'Deletes a client' - description: 'Handles the deletion of a client by id' + summary: "Deletes a client" + description: "Handles the deletion of a client by id" operationId: deleteExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Expense Hashed ID' + description: "The Expense Hashed ID" required: true schema: type: string @@ -4226,44 +3950,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/expenses/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/expenses/{id}/edit": get: tags: - expenses - summary: 'Shows a client for editting' - description: 'Displays a client by id' + summary: "Shows a client for editting" + description: "Displays a client by id" operationId: editExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Expense Hashed ID' + description: "The Expense Hashed ID" required: true schema: type: string @@ -4271,139 +3991,129 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Expense' + $ref: "#/components/schemas/Expense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/expenses/create: get: tags: - expenses - summary: 'Gets a new blank client object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank client object" + description: "Returns a blank object with default values" operationId: getExpensesCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank client object' + description: "A blank client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Expense' + $ref: "#/components/schemas/Expense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/expenses/bulk: post: tags: - expenses - summary: 'Performs bulk actions on an array of expenses' - description: '' + summary: "Performs bulk actions on an array of expenses" + description: "" operationId: bulkExpenses parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Expense User response' + description: "The Expense User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Expense' + $ref: "#/components/schemas/Expense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/expenses/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/expenses/{id}/upload": put: tags: - expense - summary: 'Uploads a document to a expense' - description: 'Handles the uploading of a document to a expense' + summary: "Uploads a document to a expense" + description: "Handles the uploading of a document to a expense" operationId: uploadExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Expense Hashed ID' + description: "The Expense Hashed ID" required: true schema: type: string @@ -4411,199 +4121,185 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Expense object' + description: "Returns the Expense object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Expense' + $ref: "#/components/schemas/Expense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/export: post: tags: - export - summary: 'Export data from the system' - description: 'Export data from the system' + summary: "Export data from the system" + description: "Export data from the system" operationId: getExport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/group_settings: get: tags: - group_settings - summary: 'Gets a list of group_settings' + summary: "Gets a list of group_settings" description: "Lists group_settings, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the group_settings, these are handled by the GroupSettingFilters class which defines the methods available" operationId: getGroupSettings parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of group_settings' + description: "A list of group_settings" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/GroupSetting' + $ref: "#/components/schemas/GroupSetting" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - group_settings - summary: 'Adds a GroupSetting' - description: 'Adds an GroupSetting to the system' + summary: "Adds a GroupSetting" + description: "Adds an GroupSetting to the system" operationId: storeGroupSetting parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved GroupSetting object' + description: "Returns the saved GroupSetting object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/GroupSetting' + $ref: "#/components/schemas/GroupSetting" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/group_settings/create: get: tags: - group_settings - summary: 'Gets a new blank GroupSetting object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank GroupSetting object" + description: "Returns a blank object with default values" operationId: getGroupSettingsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank GroupSetting object' + description: "A blank GroupSetting object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/GroupSetting' + $ref: "#/components/schemas/GroupSetting" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/group_settings/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/group_settings/{id}": get: tags: - group_settings - summary: 'Shows an GroupSetting' - description: 'Displays an GroupSetting by id' + summary: "Shows an GroupSetting" + description: "Displays an GroupSetting by id" operationId: showGroupSetting parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The GroupSetting Hashed ID' + description: "The GroupSetting Hashed ID" required: true schema: type: string @@ -4611,47 +4307,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the GroupSetting object' + description: "Returns the GroupSetting object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/GroupSetting' + $ref: "#/components/schemas/GroupSetting" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - group_settings - summary: 'Updates an GroupSetting' - description: 'Handles the updating of an GroupSetting by id' + summary: "Updates an GroupSetting" + description: "Handles the updating of an GroupSetting by id" operationId: updateGroupSetting parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The GroupSetting Hashed ID' + description: "The GroupSetting Hashed ID" required: true schema: type: string @@ -4659,47 +4351,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the GroupSetting object' + description: "Returns the GroupSetting object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/GroupSetting' + $ref: "#/components/schemas/GroupSetting" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - group_settings - summary: 'Deletes a GroupSetting' - description: 'Handles the deletion of an GroupSetting by id' + summary: "Deletes a GroupSetting" + description: "Handles the deletion of an GroupSetting by id" operationId: deleteGroupSetting parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The GroupSetting Hashed ID' + description: "The GroupSetting Hashed ID" required: true schema: type: string @@ -4707,44 +4395,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/group_settings/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/group_settings/{id}/edit": get: tags: - group_settings - summary: 'Shows an GroupSetting for editting' - description: 'Displays an GroupSetting by id' + summary: "Shows an GroupSetting for editting" + description: "Displays an GroupSetting by id" operationId: editGroupSetting parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The GroupSetting Hashed ID' + description: "The GroupSetting Hashed ID" required: true schema: type: string @@ -4752,95 +4436,88 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the GroupSetting object' + description: "Returns the GroupSetting object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/GroupSetting' + $ref: "#/components/schemas/GroupSetting" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/group_settings/bulk: post: tags: - group_settings - summary: 'Performs bulk actions on an array of group_settings' - description: '' + summary: "Performs bulk actions on an array of group_settings" + description: "" operationId: bulkGroupSettings parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'An array of group_settings ids' + description: "An array of group_settings ids" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Bulk Action response' + description: "The Bulk Action response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/group_settings/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/group_settings/{id}/upload": put: tags: - group_settings - summary: 'Uploads a document to a group setting' - description: 'Handles the uploading of a document to a group setting' + summary: "Uploads a document to a group setting" + description: "Handles the uploading of a document to a group setting" operationId: uploadGroupSetting parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Group Setting Hashed ID' + description: "The Group Setting Hashed ID" required: true schema: type: string @@ -4848,46 +4525,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Group Setting object' + description: "Returns the Group Setting object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/preimport: post: tags: - imports - summary: 'Pre Import checks - returns a reference to the job and the headers of the CSV' - description: 'Pre Import checks - returns a reference to the job and the headers of the CSV' + summary: "Pre Import checks - returns a reference to the job and the headers of the CSV" + description: "Pre Import checks - returns a reference to the job and the headers of the CSV" operationId: preimport parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" requestBody: - description: 'The CSV file' + description: "The CSV file" required: true content: multipart/form-data: @@ -4896,273 +4570,253 @@ paths: format: binary responses: 200: - description: 'Returns a reference to the file' + description: "Returns a reference to the file" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/import_json: post: tags: - import - summary: 'Import data from the system' - description: 'Import data from the system' + summary: "Import data from the system" + description: "Import data from the system" operationId: getImportJson parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/apple/confirm_purchase: post: tags: - postmark - summary: 'Processing webhooks from Apple for in app purchases' - description: 'Adds an credit to the system' + summary: "Processing webhooks from Apple for in app purchases" + description: "Adds an credit to the system" operationId: confirmApplePurchase parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved credit object' + description: "Returns the saved credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/apple/process_webhook: post: tags: - postmark - summary: 'Processing event webhooks from Apple for in purchase / subscription status update' - description: 'Adds an credit to the system' + summary: "Processing event webhooks from Apple for in purchase / subscription status update" + description: "Adds an credit to the system" operationId: processAppleWebhook parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved credit object' + description: "Returns the saved credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/invoices: get: tags: - invoices - summary: 'Gets a list of invoices' + summary: "Gets a list of invoices" description: "Lists invoices, search and filters allow fine grained lists to be generated.\n *\n *\t\tQuery parameters can be added to performed more fine grained filtering of the invoices, these are handled by the InvoiceFilters class which defines the methods available" operationId: getInvoices parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of invoices' + description: "A list of invoices" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - invoices - summary: 'Adds a invoice' - description: 'Adds an invoice to the system' + summary: "Adds a invoice" + description: "Adds an invoice to the system" operationId: storeInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/FillableInvoice' + $ref: "#/components/schemas/FillableInvoice" responses: 200: - description: 'Returns the saved invoice object' + description: "Returns the saved invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/invoices/create: get: tags: - invoices - summary: 'Gets a new blank invoice object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank invoice object" + description: "Returns a blank object with default values" operationId: getInvoicesCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank invoice object' + description: "A blank invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/invoices/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/invoices/{id}": get: tags: - invoices - summary: 'Shows an invoice' - description: 'Displays an invoice by id' + summary: "Shows an invoice" + description: "Displays an invoice by id" operationId: showInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Invoice Hashed ID' + description: "The Invoice Hashed ID" required: true schema: type: string @@ -5170,47 +4824,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the invoice object' + description: "Returns the invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - invoices - summary: 'Updates an invoice' - description: 'Handles the updating of an invoice by id' + summary: "Updates an invoice" + description: "Handles the updating of an invoice by id" operationId: updateInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Invoice Hashed ID' + description: "The Invoice Hashed ID" required: true schema: type: string @@ -5218,47 +4868,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the invoice object' + description: "Returns the invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - invoices - summary: 'Deletes a invoice' - description: 'Handles the deletion of an invoice by id' + summary: "Deletes a invoice" + description: "Handles the deletion of an invoice by id" operationId: deleteInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Invoice Hashed ID' + description: "The Invoice Hashed ID" required: true schema: type: string @@ -5266,44 +4912,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/invoices/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/invoices/{id}/edit": get: tags: - invoices - summary: 'Shows an invoice for editting' - description: 'Displays an invoice by id' + summary: "Shows an invoice for editting" + description: "Displays an invoice by id" operationId: editInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Invoice Hashed ID' + description: "The Invoice Hashed ID" required: true schema: type: string @@ -5311,104 +4953,96 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the invoice object' + description: "Returns the invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/invoices/bulk: post: tags: - invoices - summary: 'Performs bulk actions on an array of invoices' - description: '' + summary: "Performs bulk actions on an array of invoices" + description: "" operationId: bulkInvoices parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Bulk Action response' + description: "The Bulk Action response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/invoices/{id}/{action}': + $ref: "#/components/schemas/Error" + "/api/v1/invoices/{id}/{action}": get: tags: - invoices - summary: 'Performs a custom action on an invoice' + summary: "Performs a custom action on an invoice" description: "Performs a custom action on an invoice.\n *\n * The current range of actions are as follows\n * - clone_to_invoice\n * - clone_to_quote\n * - history\n * - delivery_note\n * - mark_paid\n * - download\n * - archive\n * - delete\n * - email" operationId: actionInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Invoice Hashed ID' + description: "The Invoice Hashed ID" required: true schema: type: string format: string example: D2J234DFA - - - name: action + - name: action in: path - description: 'The action string to be performed' + description: "The action string to be performed" required: true schema: type: string @@ -5416,48 +5050,44 @@ paths: example: clone_to_quote responses: 200: - description: 'Returns the invoice object' + description: "Returns the invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/invoice/{invitation_key}/download': + $ref: "#/components/schemas/Error" + "/api/v1/invoice/{invitation_key}/download": get: tags: - invoices - summary: 'Download a specific invoice by invitation key' - description: 'Downloads a specific invoice' + summary: "Download a specific invoice by invitation key" + description: "Downloads a specific invoice" operationId: downloadInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: invitation_key + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: invitation_key in: path - description: 'The Invoice Invitation Key' + description: "The Invoice Invitation Key" required: true schema: type: string @@ -5465,44 +5095,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the invoice pdf' + description: "Returns the invoice pdf" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/invoices/{id}/delivery_note': + $ref: "#/components/schemas/Error" + "/api/v1/invoices/{id}/delivery_note": get: tags: - invoices - summary: 'Download a specific invoice delivery notes' - description: 'Downloads a specific invoice delivery notes' + summary: "Download a specific invoice delivery notes" + description: "Downloads a specific invoice delivery notes" operationId: deliveryNote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Invoice Hahsed Id' + description: "The Invoice Hahsed Id" required: true schema: type: string @@ -5510,44 +5136,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the invoice delivery note pdf' + description: "Returns the invoice delivery note pdf" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/invoices/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/invoices/{id}/upload": put: tags: - invoices - summary: 'Uploads a document to a invoice' - description: 'Handles the uploading of a document to a invoice' + summary: "Uploads a document to a invoice" + description: "Handles the uploading of a document to a invoice" operationId: uploadInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Invoice Hashed ID' + description: "The Invoice Hashed ID" required: true schema: type: string @@ -5555,134 +5177,124 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Invoice object' + description: "Returns the Invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/claim_license: get: tags: - claim_license - summary: 'Attempts to claim a white label license' - description: 'Attempts to claim a white label license' + summary: "Attempts to claim a white label license" + description: "Attempts to claim a white label license" operationId: getClaimLicense parameters: - - - $ref: '#/components/parameters/X-Requested-With' - - - name: license_key + - $ref: "#/components/parameters/X-Requested-With" + - name: license_key in: query - description: 'The license hash' + description: "The license hash" required: true schema: type: string format: string example: d87sh-s755s-s7d76-sdsd8 - - - name: product_id + - name: product_id in: query - description: 'The ID of the product purchased.' + description: "The ID of the product purchased." required: true schema: type: string format: string - example: '1' + example: "1" responses: 200: description: Success! headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/logout: post: tags: - logout - summary: 'Gets a list of logout' - description: 'Lists all logout' + summary: "Gets a list of logout" + description: "Lists all logout" operationId: getLogout parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'Success message' + description: "Success message" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/migration/purge/{company}': + $ref: "#/components/schemas/Error" + "/api/v1/migration/purge/{company}": post: tags: - migration - summary: 'Attempts to purge a company record and all its child records' - description: 'Attempts to purge a company record and all its child records' + summary: "Attempts to purge a company record and all its child records" + description: "Attempts to purge a company record and all its child records" operationId: postPurgeCompany parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: company + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: company in: path - description: 'The Company Hashed ID' + description: "The Company Hashed ID" required: true schema: type: string @@ -5693,39 +5305,36 @@ paths: description: Success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/migration/purge_save_settings/{company}': + $ref: "#/components/schemas/Error" + "/api/v1/migration/purge_save_settings/{company}": post: tags: - migration - summary: 'Attempts to purge a companies child records but save the company record and its settings' - description: 'Attempts to purge a companies child records but save the company record and its settings' + summary: "Attempts to purge a companies child records but save the company record and its settings" + description: "Attempts to purge a companies child records but save the company record and its settings" operationId: postPurgeCompanySaveSettings parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: company + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: company in: path - description: 'The Company Hashed ID' + description: "The Company Hashed ID" required: true schema: type: string @@ -5736,41 +5345,37 @@ paths: description: Success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/migration/start: post: tags: - migration - summary: 'Starts the migration from previous version of Invoice Ninja' - description: 'Starts the migration from previous version of Invoice Ninja' + summary: "Starts the migration from previous version of Invoice Ninja" + description: "Starts the migration from previous version of Invoice Ninja" operationId: postStartMigration parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/X-API-PASSWORD' - - - name: migration + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/X-API-PASSWORD" + - name: migration in: query - description: 'The migraton file' + description: "The migraton file" required: true schema: type: object @@ -5781,199 +5386,185 @@ paths: description: Success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/one_time_token: post: tags: - one_time_token - summary: 'Attempts to create a one time token' - description: 'Attempts to create a one time token' + summary: "Attempts to create a one time token" + description: "Attempts to create a one time token" operationId: oneTimeToken parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'The Company User response' + description: "The Company User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/payments: get: tags: - payments - summary: 'Gets a list of payments' + summary: "Gets a list of payments" description: "Lists payments, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the payments, these are handled by the PaymentFilters class which defines the methods available" operationId: getPayments parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of payments' + description: "A list of payments" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - payments - summary: 'Adds a Payment' - description: 'Adds an Payment to the system' + summary: "Adds a Payment" + description: "Adds an Payment to the system" operationId: storePayment parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" requestBody: - description: 'The payment request' + description: "The payment request" required: true content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" responses: 200: - description: 'Returns the saved Payment object' + description: "Returns the saved Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/payments/create: get: tags: - payments - summary: 'Gets a new blank Payment object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank Payment object" + description: "Returns a blank object with default values" operationId: getPaymentsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank Payment object' + description: "A blank Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/payments/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/payments/{id}": get: tags: - payments - summary: 'Shows an Payment' - description: 'Displays an Payment by id' + summary: "Shows an Payment" + description: "Displays an Payment by id" operationId: showPayment parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Hashed ID' + description: "The Payment Hashed ID" required: true schema: type: string @@ -5981,47 +5572,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Payment object' + description: "Returns the Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - payments - summary: 'Updates an Payment' - description: 'Handles the updating of an Payment by id' + summary: "Updates an Payment" + description: "Handles the updating of an Payment by id" operationId: updatePayment parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Hashed ID' + description: "The Payment Hashed ID" required: true schema: type: string @@ -6029,47 +5616,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Payment object' + description: "Returns the Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - payments - summary: 'Deletes a Payment' - description: 'Handles the deletion of an Payment by id' + summary: "Deletes a Payment" + description: "Handles the deletion of an Payment by id" operationId: deletePayment parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Hashed ID' + description: "The Payment Hashed ID" required: true schema: type: string @@ -6077,44 +5660,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/payments/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/payments/{id}/edit": get: tags: - payments - summary: 'Shows an Payment for editting' - description: 'Displays an Payment by id' + summary: "Shows an Payment for editting" + description: "Displays an Payment by id" operationId: editPayment parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Hashed ID' + description: "The Payment Hashed ID" required: true schema: type: string @@ -6122,108 +5701,100 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Payment object' + description: "Returns the Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/payments/bulk: post: tags: - payments - summary: 'Performs bulk actions on an array of payments' - description: '' + summary: "Performs bulk actions on an array of payments" + description: "" operationId: bulkPayments parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Payment response' + description: "The Payment response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/payments/{id}/{action}': + $ref: "#/components/schemas/Error" + "/api/v1/payments/{id}/{action}": get: tags: - payments - summary: 'Performs a custom action on an Payment' + summary: "Performs a custom action on an Payment" description: "Performs a custom action on an Payment.\n\n The current range of actions are as follows\n - clone_to_Payment\n - clone_to_quote\n - history\n - delivery_note\n - mark_paid\n - download\n - archive\n - delete\n - email" operationId: actionPayment parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Hashed ID' + description: "The Payment Hashed ID" required: true schema: type: string format: string example: D2J234DFA - - - name: action + - name: action in: path - description: 'The action string to be performed' + description: "The action string to be performed" required: true schema: type: string @@ -6231,95 +5802,88 @@ paths: example: clone_to_quote responses: 200: - description: 'Returns the Payment object' + description: "Returns the Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/payments/refund: post: tags: - payments - summary: 'Adds a Refund' - description: 'Adds an Refund to the system' + summary: "Adds a Refund" + description: "Adds an Refund to the system" operationId: storeRefund parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" requestBody: - description: 'The refund request' + description: "The refund request" required: true content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" responses: 200: - description: 'Returns the saved Payment object' + description: "Returns the saved Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/payments/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/payments/{id}/upload": put: tags: - payments - summary: 'Uploads a document to a payment' - description: 'Handles the uploading of a document to a payment' + summary: "Uploads a document to a payment" + description: "Handles the uploading of a document to a payment" operationId: uploadPayment parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Hashed ID' + description: "The Payment Hashed ID" required: true schema: type: string @@ -6327,176 +5891,162 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Payment object' + description: "Returns the Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/payment_terms: get: tags: - payment_terms - summary: 'Gets a list of payment terms' - description: 'Lists payment terms' + summary: "Gets a list of payment terms" + description: "Lists payment terms" operationId: getPaymentTerms parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of payment terms' + description: "A list of payment terms" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/PaymentTerm' + $ref: "#/components/schemas/PaymentTerm" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - payment_terms - summary: 'Adds a Payment' - description: 'Adds a Payment Term to the system' + summary: "Adds a Payment" + description: "Adds a Payment Term to the system" operationId: storePaymentTerm parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" requestBody: - description: 'The payment_terms request' + description: "The payment_terms request" required: true content: application/json: schema: - $ref: '#/components/schemas/PaymentTerm' + $ref: "#/components/schemas/PaymentTerm" responses: 200: - description: 'Returns the saved Payment object' + description: "Returns the saved Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/PaymentTerm' + $ref: "#/components/schemas/PaymentTerm" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/payment_terms/create: get: tags: - payment_terms - summary: 'Gets a new blank PaymentTerm object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank PaymentTerm object" + description: "Returns a blank object with default values" operationId: getPaymentTermsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank PaymentTerm object' + description: "A blank PaymentTerm object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/payment_terms/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/payment_terms/{id}": get: tags: - payment_terms - summary: 'Shows a Payment Term' - description: 'Displays an Payment Term by id' + summary: "Shows a Payment Term" + description: "Displays an Payment Term by id" operationId: showPaymentTerm parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Term Hashed ID' + description: "The Payment Term Hashed ID" required: true schema: type: string @@ -6504,47 +6054,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Payment Term object' + description: "Returns the Payment Term object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/PaymentTerm' + $ref: "#/components/schemas/PaymentTerm" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - payment_terms - summary: 'Updates a Payment Term' - description: 'Handles the updating of an Payment Termby id' + summary: "Updates a Payment Term" + description: "Handles the updating of an Payment Termby id" operationId: updatePaymentTerm parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Term Hashed ID' + description: "The Payment Term Hashed ID" required: true schema: type: string @@ -6552,47 +6098,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Payment Term object' + description: "Returns the Payment Term object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/PaymentTerm' + $ref: "#/components/schemas/PaymentTerm" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - payment_termss - summary: 'Deletes a Payment Term' - description: 'Handles the deletion of an PaymentTerm by id' + summary: "Deletes a Payment Term" + description: "Handles the deletion of an PaymentTerm by id" operationId: deletePaymentTerm parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Term Hashed ID' + description: "The Payment Term Hashed ID" required: true schema: type: string @@ -6600,44 +6142,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/payment_terms/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/payment_terms/{id}/edit": get: tags: - payment_terms - summary: 'Shows an Payment Term for editting' - description: 'Displays an Payment Term by id' + summary: "Shows an Payment Term for editting" + description: "Displays an Payment Term by id" operationId: editPaymentTerms parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Term Hashed ID' + description: "The Payment Term Hashed ID" required: true schema: type: string @@ -6645,325 +6183,304 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Payment object' + description: "Returns the Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/PaymentTerm' + $ref: "#/components/schemas/PaymentTerm" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/payment_terms/bulk: post: tags: - payment_terms - summary: 'Performs bulk actions on an array of payment terms' - description: '' + summary: "Performs bulk actions on an array of payment terms" + description: "" operationId: bulkPaymentTerms parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Payment Ter,s' + description: "Payment Ter,s" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Payment Terms response' + description: "The Payment Terms response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/PaymentTerm' + $ref: "#/components/schemas/PaymentTerm" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/ping: get: tags: - ping - summary: 'Attempts to ping the API' - description: 'Attempts to ping the API' + summary: "Attempts to ping the API" + description: "Attempts to ping the API" operationId: getPing parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'The company and user name' + description: "The company and user name" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" /api/v1/health_check: get: tags: - health_check - summary: 'Attempts to get a health check from the API' - description: 'Attempts to get a health check from the API' + summary: "Attempts to get a health check from the API" + description: "Attempts to get a health check from the API" operationId: getHealthCheck parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'A key/value map of the system health' + description: "A key/value map of the system health" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" /api/v1/postmark_webhook: post: tags: - postmark - summary: 'Processing webhooks from PostMark' - description: 'Adds an credit to the system' + summary: "Processing webhooks from PostMark" + description: "Adds an credit to the system" operationId: postmarkWebhook parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved credit object' + description: "Returns the saved credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/preview: post: tags: - preview - summary: 'Returns a pdf preview' - description: 'Returns a pdf preview.' + summary: "Returns a pdf preview" + description: "Returns a pdf preview." operationId: getPreview parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'The pdf response' + description: "The pdf response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/preview/purchase_order: post: tags: - preview - summary: 'Returns a pdf preview for purchase order' - description: 'Returns a pdf preview for purchase order.' + summary: "Returns a pdf preview for purchase order" + description: "Returns a pdf preview for purchase order." operationId: getPreviewPurchaseOrder parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'The pdf response' + description: "The pdf response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - + $ref: "#/components/schemas/Error" + /api/v1/projects: get: tags: - projects - summary: 'Gets a list of projects' - description: 'Lists projects' + summary: "Gets a list of projects" + description: "Lists projects" operationId: getProjects parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of projects' + description: "A list of projects" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - projects - summary: 'Adds a project' - description: 'Adds an project to a company' + summary: "Adds a project" + description: "Adds an project to a company" operationId: storeProject parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved project object' + description: "Returns the saved project object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/projects/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/projects/{id}": get: tags: - projects - summary: 'Shows a project' - description: 'Displays a project by id' + summary: "Shows a project" + description: "Displays a project by id" operationId: showProject parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Project Hashed ID' + description: "The Project Hashed ID" required: true schema: type: string @@ -6971,47 +6488,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the expense object' + description: "Returns the expense object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - projects - summary: 'Updates a project' - description: 'Handles the updating of a project by id' + summary: "Updates a project" + description: "Handles the updating of a project by id" operationId: updateProject parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Project Hashed ID' + description: "The Project Hashed ID" required: true schema: type: string @@ -7019,47 +6532,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the project object' + description: "Returns the project object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - projects - summary: 'Deletes a project' - description: 'Handles the deletion of a project by id' + summary: "Deletes a project" + description: "Handles the deletion of a project by id" operationId: deleteProject parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Project Hashed ID' + description: "The Project Hashed ID" required: true schema: type: string @@ -7067,44 +6576,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/projects/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/projects/{id}/edit": get: tags: - projects - summary: 'Shows a project for editting' - description: 'Displays a project by id' + summary: "Shows a project for editting" + description: "Displays a project by id" operationId: editProject parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Project Hashed ID' + description: "The Project Hashed ID" required: true schema: type: string @@ -7112,139 +6617,129 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the project object' + description: "Returns the project object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/projects/create: get: tags: - projects - summary: 'Gets a new blank project object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank project object" + description: "Returns a blank object with default values" operationId: getProjectsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank project object' + description: "A blank project object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/projects/bulk: post: tags: - projects - summary: 'Performs bulk actions on an array of projects' - description: '' + summary: "Performs bulk actions on an array of projects" + description: "" operationId: bulkProjects parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Project User response' + description: "The Project User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/projects/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/projects/{id}/upload": put: tags: - projects - summary: 'Uploads a document to a project' - description: 'Handles the uploading of a document to a project' + summary: "Uploads a document to a project" + description: "Handles the uploading of a document to a project" operationId: uploadProject parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Project Hashed ID' + description: "The Project Hashed ID" required: true schema: type: string @@ -7252,167 +6747,154 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Project object' + description: "Returns the Project object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/purchase_orders: get: tags: - purchase_orders - summary: 'Gets a list of purchase orders' + summary: "Gets a list of purchase orders" description: "Lists purchase orders, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the purchase orders, these are handled by the PurchaseOrderFilters class which defines the methods available" operationId: getPurchaseOrders parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of purchase orders' + description: "A list of purchase orders" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - purhcase_orders - summary: 'Adds a purchase order' - description: 'Adds an purchase order to the system' + summary: "Adds a purchase order" + description: "Adds an purchase order to the system" operationId: storePurchaseOrder parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved purchase order object' + description: "Returns the saved purchase order object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/purchase_orders/create: get: tags: - purchase_orders - summary: 'Gets a new blank purchase order object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank purchase order object" + description: "Returns a blank object with default values" operationId: getPurchaseOrderCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank purchase order object' + description: "A blank purchase order object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/purchase_orders/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/purchase_orders/{id}": get: tags: - purchase_orders - summary: 'Shows an purcase orders' - description: 'Displays an purchase order by id' + summary: "Shows an purcase orders" + description: "Displays an purchase order by id" operationId: showPurchaseOrder parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Purchase order Hashed ID' + description: "The Purchase order Hashed ID" required: true schema: type: string @@ -7420,47 +6902,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the purchase order object' + description: "Returns the purchase order object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - purchase_orders - summary: 'Deletes a purchase order' - description: 'Handles the deletion of an purchase orders by id' + summary: "Deletes a purchase order" + description: "Handles the deletion of an purchase orders by id" operationId: deletePurchaseOrder parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The purhcase order Hashed ID' + description: "The purhcase order Hashed ID" required: true schema: type: string @@ -7468,44 +6946,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/purchase_orders/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/purchase_orders/{id}/edit": get: tags: - purchase_orders - summary: 'Shows an purchase order for editting' - description: 'Displays an purchase order by id' + summary: "Shows an purchase order for editting" + description: "Displays an purchase order by id" operationId: editPurchaseOrder parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The purchase order Hashed ID' + description: "The purchase order Hashed ID" required: true schema: type: string @@ -7513,48 +6987,44 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the purchase order object' + description: "Returns the purchase order object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/purchase_order/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/purchase_order/{id}": put: tags: - purchase_orders - summary: 'Updates an purchase order' - description: 'Handles the updating of an purchase order by id' + summary: "Updates an purchase order" + description: "Handles the updating of an purchase order by id" operationId: updatePurchaseOrder parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The purchase order Hashed ID' + description: "The purchase order Hashed ID" required: true schema: type: string @@ -7562,104 +7032,96 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the purchase order object' + description: "Returns the purchase order object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/purchase_orders/bulk: post: tags: - purchase_orders - summary: 'Performs bulk actions on an array of purchase_orders' - description: '' + summary: "Performs bulk actions on an array of purchase_orders" + description: "" operationId: bulkPurchaseOrderss parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Purchase Order IDS' + description: "Purchase Order IDS" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Bulk Action response' + description: "The Bulk Action response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/purchase_orders/{id}/{action}': + $ref: "#/components/schemas/Error" + "/api/v1/purchase_orders/{id}/{action}": get: tags: - purchase_orders - summary: 'Performs a custom action on an purchase order' + summary: "Performs a custom action on an purchase order" description: "Performs a custom action on an purchase order.\n *\n * The current range of actions are as follows\n * - mark_paid\n * - download\n * - archive\n * - delete\n * - email" operationId: actionPurchaseOrder parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Purchase Order Hashed ID' + description: "The Purchase Order Hashed ID" required: true schema: type: string format: string example: D2J234DFA - - - name: action + - name: action in: path - description: 'The action string to be performed' + description: "The action string to be performed" required: true schema: type: string @@ -7667,48 +7129,44 @@ paths: example: clone_to_quote responses: 200: - description: 'Returns the invoice object' + description: "Returns the invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/purchase_orders/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/purchase_orders/{id}/upload": put: tags: - purchase_orders - summary: 'Uploads a document to a purchase_orders' - description: 'Handles the uploading of a document to a purchase_order' + summary: "Uploads a document to a purchase_orders" + description: "Handles the uploading of a document to a purchase_order" operationId: uploadPurchaseOrder parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Purchase Order Hashed ID' + description: "The Purchase Order Hashed ID" required: true schema: type: string @@ -7716,48 +7174,44 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Purchase Order object' + description: "Returns the Purchase Order object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/purchase_order/{invitation_key}/download': + $ref: "#/components/schemas/Error" + "/api/v1/purchase_order/{invitation_key}/download": get: tags: - purchase_orders - summary: 'Download a specific purchase order by invitation key' - description: 'Downloads a specific purchase order' + summary: "Download a specific purchase order by invitation key" + description: "Downloads a specific purchase order" operationId: downloadPurchaseOrder parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: invitation_key + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: invitation_key in: path - description: 'The Purchase Order Invitation Key' + description: "The Purchase Order Invitation Key" required: true schema: type: string @@ -7765,163 +7219,150 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Purchase Order pdf' + description: "Returns the Purchase Order pdf" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/quotes: get: tags: - quotes - summary: 'Gets a list of quotes' + summary: "Gets a list of quotes" description: "Lists quotes, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the quotes, these are handled by the QuoteFilters class which defines the methods available" operationId: getQuotes parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of quotes' + description: "A list of quotes" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - quotes - summary: 'Adds a Quote' - description: 'Adds an Quote to the system' + summary: "Adds a Quote" + description: "Adds an Quote to the system" operationId: storeQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved Quote object' + description: "Returns the saved Quote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/quotes/create: get: tags: - quotes - summary: 'Gets a new blank Quote object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank Quote object" + description: "Returns a blank object with default values" operationId: getQuotesCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank Quote object' + description: "A blank Quote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/quotes/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/quotes/{id}": get: tags: - quotes - summary: 'Shows an Quote' - description: 'Displays an Quote by id' + summary: "Shows an Quote" + description: "Displays an Quote by id" operationId: showQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Quote Hashed ID' + description: "The Quote Hashed ID" required: true schema: type: string @@ -7929,47 +7370,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Quote object' + description: "Returns the Quote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - quotes - summary: 'Updates an Quote' - description: 'Handles the updating of an Quote by id' + summary: "Updates an Quote" + description: "Handles the updating of an Quote by id" operationId: updateQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Quote Hashed ID' + description: "The Quote Hashed ID" required: true schema: type: string @@ -7977,47 +7414,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Quote object' + description: "Returns the Quote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - quotes - summary: 'Deletes a Quote' - description: 'Handles the deletion of an Quote by id' + summary: "Deletes a Quote" + description: "Handles the deletion of an Quote by id" operationId: deleteQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Quote Hashed ID' + description: "The Quote Hashed ID" required: true schema: type: string @@ -8025,44 +7458,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/quotes/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/quotes/{id}/edit": get: tags: - quotes - summary: 'Shows an Quote for editting' - description: 'Displays an Quote by id' + summary: "Shows an Quote for editting" + description: "Displays an Quote by id" operationId: editQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Quote Hashed ID' + description: "The Quote Hashed ID" required: true schema: type: string @@ -8070,108 +7499,100 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Quote object' + description: "Returns the Quote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/quotes/bulk: post: tags: - quotes - summary: 'Performs bulk actions on an array of quotes' - description: '' + summary: "Performs bulk actions on an array of quotes" + description: "" operationId: bulkQuotes parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Hashed ids' + description: "Hashed ids" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Quote response' + description: "The Quote response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/quotes/{id}/{action}': + $ref: "#/components/schemas/Error" + "/api/v1/quotes/{id}/{action}": get: tags: - quotes - summary: 'Performs a custom action on an Quote' + summary: "Performs a custom action on an Quote" description: "Performs a custom action on an Quote.\n\n The current range of actions are as follows\n - clone_to_quote\n - history\n - delivery_note\n - mark_paid\n - download\n - archive\n - delete\n - convert\n - convert_to_invoice\n - email" operationId: actionQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Quote Hashed ID' + description: "The Quote Hashed ID" required: true schema: type: string format: string example: D2J234DFA - - - name: action + - name: action in: path - description: 'The action string to be performed' + description: "The action string to be performed" required: true schema: type: string @@ -8179,48 +7600,44 @@ paths: example: clone_to_quote responses: 200: - description: 'Returns the Quote object' + description: "Returns the Quote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/quote/{invitation_key}/download': + $ref: "#/components/schemas/Error" + "/api/v1/quote/{invitation_key}/download": get: tags: - quotes - summary: 'Download a specific quote by invitation key' - description: 'Downloads a specific quote' + summary: "Download a specific quote by invitation key" + description: "Downloads a specific quote" operationId: downloadQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: invitation_key + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: invitation_key in: path - description: 'The Quote Invitation Key' + description: "The Quote Invitation Key" required: true schema: type: string @@ -8228,44 +7645,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the quote pdf' + description: "Returns the quote pdf" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/quotes/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/quotes/{id}/upload": put: tags: - quotes - summary: 'Uploads a document to a quote' - description: 'Handles the uploading of a document to a quote' + summary: "Uploads a document to a quote" + description: "Handles the uploading of a document to a quote" operationId: uploadQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Quote Hashed ID' + description: "The Quote Hashed ID" required: true schema: type: string @@ -8273,129 +7686,118 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Quote object' + description: "Returns the Quote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_expenses: get: tags: - recurring_expenses - summary: 'Gets a list of recurring_expenses' + summary: "Gets a list of recurring_expenses" description: "Lists recurring_expenses, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the recurring_expenses, these are handled by the RecurringExpenseFilters class which defines the methods available" operationId: getRecurringExpenses parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of recurring_expenses' + description: "A list of recurring_expenses" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringExpense' + $ref: "#/components/schemas/RecurringExpense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - recurring_expenses - summary: 'Adds a client' - description: 'Adds an client to a company' + summary: "Adds a client" + description: "Adds an client to a company" operationId: storeRecurringExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved client object' + description: "Returns the saved client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringExpense' + $ref: "#/components/schemas/RecurringExpense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_expenses/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_expenses/{id}": get: tags: - recurring_expenses - summary: 'Shows a client' - description: 'Displays a client by id' + summary: "Shows a client" + description: "Displays a client by id" operationId: showRecurringExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringExpense Hashed ID' + description: "The RecurringExpense Hashed ID" required: true schema: type: string @@ -8403,47 +7805,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the recurring_expense object' + description: "Returns the recurring_expense object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringExpense' + $ref: "#/components/schemas/RecurringExpense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - recurring_expenses - summary: 'Updates a client' - description: 'Handles the updating of a client by id' + summary: "Updates a client" + description: "Handles the updating of a client by id" operationId: updateRecurringExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringExpense Hashed ID' + description: "The RecurringExpense Hashed ID" required: true schema: type: string @@ -8451,47 +7849,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringExpense' + $ref: "#/components/schemas/RecurringExpense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - recurring_expenses - summary: 'Deletes a client' - description: 'Handles the deletion of a client by id' + summary: "Deletes a client" + description: "Handles the deletion of a client by id" operationId: deleteRecurringExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringExpense Hashed ID' + description: "The RecurringExpense Hashed ID" required: true schema: type: string @@ -8499,44 +7893,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_expenses/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_expenses/{id}/edit": get: tags: - recurring_expenses - summary: 'Shows a client for editting' - description: 'Displays a client by id' + summary: "Shows a client for editting" + description: "Displays a client by id" operationId: editRecurringExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringExpense Hashed ID' + description: "The RecurringExpense Hashed ID" required: true schema: type: string @@ -8544,139 +7934,129 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringExpense' + $ref: "#/components/schemas/RecurringExpense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_expenses/create: get: tags: - recurring_expenses - summary: 'Gets a new blank client object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank client object" + description: "Returns a blank object with default values" operationId: getRecurringExpensesCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank client object' + description: "A blank client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringExpense' + $ref: "#/components/schemas/RecurringExpense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_expenses/bulk: post: tags: - recurring_expenses - summary: 'Performs bulk actions on an array of recurring_expenses' - description: '' + summary: "Performs bulk actions on an array of recurring_expenses" + description: "" operationId: bulkRecurringExpenses parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The RecurringExpense User response' + description: "The RecurringExpense User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringExpense' + $ref: "#/components/schemas/RecurringExpense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_expenses/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_expenses/{id}/upload": put: tags: - recurring_expense - summary: 'Uploads a document to a recurring_expense' - description: 'Handles the uploading of a document to a recurring_expense' + summary: "Uploads a document to a recurring_expense" + description: "Handles the uploading of a document to a recurring_expense" operationId: uploadRecurringExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringExpense Hashed ID' + description: "The RecurringExpense Hashed ID" required: true schema: type: string @@ -8684,167 +8064,154 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the RecurringExpense object' + description: "Returns the RecurringExpense object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringExpense' + $ref: "#/components/schemas/RecurringExpense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_invoices: get: tags: - recurring_invoices - summary: 'Gets a list of recurring_invoices' + summary: "Gets a list of recurring_invoices" description: "Lists recurring_invoices, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the recurring_invoices, these are handled by the RecurringInvoiceFilters class which defines the methods available" operationId: getRecurringInvoices parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of recurring_invoices' + description: "A list of recurring_invoices" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - recurring_invoices - summary: 'Adds a RecurringInvoice' - description: 'Adds an RecurringInvoice to the system' + summary: "Adds a RecurringInvoice" + description: "Adds an RecurringInvoice to the system" operationId: storeRecurringInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved RecurringInvoice object' + description: "Returns the saved RecurringInvoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_invoices/create: get: tags: - recurring_invoices - summary: 'Gets a new blank RecurringInvoice object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank RecurringInvoice object" + description: "Returns a blank object with default values" operationId: getRecurringInvoicesCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank RecurringInvoice object' + description: "A blank RecurringInvoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_invoices/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_invoices/{id}": get: tags: - recurring_invoices - summary: 'Shows an RecurringInvoice' - description: 'Displays an RecurringInvoice by id' + summary: "Shows an RecurringInvoice" + description: "Displays an RecurringInvoice by id" operationId: showRecurringInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringInvoice Hashed ID' + description: "The RecurringInvoice Hashed ID" required: true schema: type: string @@ -8852,47 +8219,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the RecurringInvoice object' + description: "Returns the RecurringInvoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - recurring_invoices - summary: 'Updates an RecurringInvoice' - description: 'Handles the updating of an RecurringInvoice by id' + summary: "Updates an RecurringInvoice" + description: "Handles the updating of an RecurringInvoice by id" operationId: updateRecurringInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringInvoice Hashed ID' + description: "The RecurringInvoice Hashed ID" required: true schema: type: string @@ -8900,47 +8263,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the RecurringInvoice object' + description: "Returns the RecurringInvoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - recurring_invoices - summary: 'Deletes a RecurringInvoice' - description: 'Handles the deletion of an RecurringInvoice by id' + summary: "Deletes a RecurringInvoice" + description: "Handles the deletion of an RecurringInvoice by id" operationId: deleteRecurringInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringInvoice Hashed ID' + description: "The RecurringInvoice Hashed ID" required: true schema: type: string @@ -8948,44 +8307,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_invoices/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_invoices/{id}/edit": get: tags: - recurring_invoices - summary: 'Shows an RecurringInvoice for editting' - description: 'Displays an RecurringInvoice by id' + summary: "Shows an RecurringInvoice for editting" + description: "Displays an RecurringInvoice by id" operationId: editRecurringInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringInvoice Hashed ID' + description: "The RecurringInvoice Hashed ID" required: true schema: type: string @@ -8993,48 +8348,44 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the RecurringInvoice object' + description: "Returns the RecurringInvoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_invoice/{invitation_key}/download': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_invoice/{invitation_key}/download": get: tags: - invoices - summary: 'Download a specific invoice by invitation key' - description: 'Downloads a specific invoice' + summary: "Download a specific invoice by invitation key" + description: "Downloads a specific invoice" operationId: downloadRecurringInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: invitation_key + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: invitation_key in: path - description: 'The Recurring Invoice Invitation Key' + description: "The Recurring Invoice Invitation Key" required: true schema: type: string @@ -9042,104 +8393,96 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the recurring invoice pdf' + description: "Returns the recurring invoice pdf" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_invoices/bulk: post: tags: - recurring_invoices - summary: 'Performs bulk actions on an array of recurring_invoices' - description: '' + summary: "Performs bulk actions on an array of recurring_invoices" + description: "" operationId: bulkRecurringInvoices parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Hashed IDs' + description: "Hashed IDs" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The RecurringInvoice response' + description: "The RecurringInvoice response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_invoices/{id}/{action}': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_invoices/{id}/{action}": get: tags: - recurring_invoices - summary: 'Performs a custom action on an RecurringInvoice' + summary: "Performs a custom action on an RecurringInvoice" description: "Performs a custom action on an RecurringInvoice.\n\n The current range of actions are as follows\n - clone_to_RecurringInvoice\n - clone_to_quote\n - history\n - delivery_note\n - mark_paid\n - download\n - archive\n - delete\n - email" operationId: actionRecurringInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringInvoice Hashed ID' + description: "The RecurringInvoice Hashed ID" required: true schema: type: string format: string example: D2J234DFA - - - name: action + - name: action in: path - description: 'The action string to be performed' + description: "The action string to be performed" required: true schema: type: string @@ -9147,48 +8490,44 @@ paths: example: clone_to_quote responses: 200: - description: 'Returns the RecurringInvoice object' + description: "Returns the RecurringInvoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_invoices/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_invoices/{id}/upload": put: tags: - recurring_invoices - summary: 'Uploads a document to a recurring_invoice' - description: 'Handles the uploading of a document to a recurring_invoice' + summary: "Uploads a document to a recurring_invoice" + description: "Handles the uploading of a document to a recurring_invoice" operationId: uploadRecurringInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringInvoice Hashed ID' + description: "The RecurringInvoice Hashed ID" required: true schema: type: string @@ -9196,167 +8535,154 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the RecurringInvoice object' + description: "Returns the RecurringInvoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_quotes: get: tags: - recurring_quotes - summary: 'Gets a list of recurring_quotes' + summary: "Gets a list of recurring_quotes" description: "Lists recurring_quotes, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the recurring_quotes, these are handled by the RecurringQuoteFilters class which defines the methods available" operationId: getRecurringQuotes parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of recurring_quotes' + description: "A list of recurring_quotes" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringQuote' + $ref: "#/components/schemas/RecurringQuote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - recurring_quotes - summary: 'Adds a RecurringQuote' - description: 'Adds an RecurringQuote to the system' + summary: "Adds a RecurringQuote" + description: "Adds an RecurringQuote to the system" operationId: storeRecurringQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved RecurringQuote object' + description: "Returns the saved RecurringQuote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringQuote' + $ref: "#/components/schemas/RecurringQuote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_quotes/create: get: tags: - recurring_quotes - summary: 'Gets a new blank RecurringQuote object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank RecurringQuote object" + description: "Returns a blank object with default values" operationId: getRecurringQuotesCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank RecurringQuote object' + description: "A blank RecurringQuote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringQuote' + $ref: "#/components/schemas/RecurringQuote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_quotes/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_quotes/{id}": get: tags: - recurring_quotes - summary: 'Shows an RecurringQuote' - description: 'Displays an RecurringQuote by id' + summary: "Shows an RecurringQuote" + description: "Displays an RecurringQuote by id" operationId: showRecurringQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringQuote Hashed ID' + description: "The RecurringQuote Hashed ID" required: true schema: type: string @@ -9364,47 +8690,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the RecurringQuote object' + description: "Returns the RecurringQuote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringQuote' + $ref: "#/components/schemas/RecurringQuote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - recurring_quotes - summary: 'Updates an RecurringQuote' - description: 'Handles the updating of an RecurringQuote by id' + summary: "Updates an RecurringQuote" + description: "Handles the updating of an RecurringQuote by id" operationId: updateRecurringQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringQuote Hashed ID' + description: "The RecurringQuote Hashed ID" required: true schema: type: string @@ -9412,47 +8734,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the RecurringQuote object' + description: "Returns the RecurringQuote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringQuote' + $ref: "#/components/schemas/RecurringQuote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - recurring_quotes - summary: 'Deletes a RecurringQuote' - description: 'Handles the deletion of an RecurringQuote by id' + summary: "Deletes a RecurringQuote" + description: "Handles the deletion of an RecurringQuote by id" operationId: deleteRecurringQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringQuote Hashed ID' + description: "The RecurringQuote Hashed ID" required: true schema: type: string @@ -9460,44 +8778,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_quotes/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_quotes/{id}/edit": get: tags: - recurring_quotes - summary: 'Shows an RecurringQuote for editting' - description: 'Displays an RecurringQuote by id' + summary: "Shows an RecurringQuote for editting" + description: "Displays an RecurringQuote by id" operationId: editRecurringQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringQuote Hashed ID' + description: "The RecurringQuote Hashed ID" required: true schema: type: string @@ -9505,108 +8819,100 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the RecurringQuote object' + description: "Returns the RecurringQuote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringQuote' + $ref: "#/components/schemas/RecurringQuote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_quotes/bulk: post: tags: - recurring_quotes - summary: 'Performs bulk actions on an array of recurring_quotes' - description: '' + summary: "Performs bulk actions on an array of recurring_quotes" + description: "" operationId: bulkRecurringQuotes parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Hashed ids' + description: "Hashed ids" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The RecurringQuote response' + description: "The RecurringQuote response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringQuote' + $ref: "#/components/schemas/RecurringQuote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_quotes/{id}/{action}': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_quotes/{id}/{action}": get: tags: - recurring_quotes - summary: 'Performs a custom action on an RecurringQuote' + summary: "Performs a custom action on an RecurringQuote" description: "Performs a custom action on an RecurringQuote.\n\n The current range of actions are as follows\n - clone_to_RecurringQuote\n - clone_to_quote\n - history\n - delivery_note\n - mark_paid\n - download\n - archive\n - delete\n - email" operationId: actionRecurringQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringQuote Hashed ID' + description: "The RecurringQuote Hashed ID" required: true schema: type: string format: string example: D2J234DFA - - - name: action + - name: action in: path - description: 'The action string to be performed' + description: "The action string to be performed" required: true schema: type: string @@ -9614,804 +8920,769 @@ paths: example: clone_to_quote responses: 200: - description: 'Returns the RecurringQuote object' + description: "Returns the RecurringQuote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringQuote' + $ref: "#/components/schemas/RecurringQuote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/contacts: post: tags: - reports - summary: 'Contact reports' - description: 'Export contact reports' + summary: "Contact reports" + description: "Export contact reports" operationId: getContactReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/clients: post: tags: - reports - summary: 'Client reports' - description: 'Export client reports' + summary: "Client reports" + description: "Export client reports" operationId: getClientReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/credit: post: tags: - reports - summary: 'Credit reports' - description: 'Export credit reports' + summary: "Credit reports" + description: "Export credit reports" operationId: getCreditReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/documents: post: tags: - reports - summary: 'Document reports' - description: 'Export document reports' + summary: "Document reports" + description: "Export document reports" operationId: getDocumentReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/expense: post: tags: - reports - summary: 'Expense reports' - description: 'Export expense reports' + summary: "Expense reports" + description: "Export expense reports" operationId: getExpenseReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/invoice_items: post: tags: - reports - summary: 'Invoice item reports' - description: 'Export invoice item reports' + summary: "Invoice item reports" + description: "Export invoice item reports" operationId: getInvoiceItemReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/invoices: post: tags: - reports - summary: 'Invoice reports' - description: 'Export invoice reports' + summary: "Invoice reports" + description: "Export invoice reports" operationId: getInvoiceReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/payments: post: tags: - reports - summary: 'Payment reports' - description: 'Export payment reports' + summary: "Payment reports" + description: "Export payment reports" operationId: getPaymentReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/products: post: tags: - reports - summary: 'Product reports' - description: 'Export product reports' + summary: "Product reports" + description: "Export product reports" operationId: getProductReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/product_sales: post: tags: - reports - summary: 'Product Salesreports' - description: 'Export product sales reports' + summary: "Product Salesreports" + description: "Export product sales reports" operationId: getProductSalesReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/profitloss: post: tags: - reports - summary: 'Profit loss reports' - description: 'Profit loss report' + summary: "Profit loss reports" + description: "Profit loss report" operationId: getProfitLossReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/quote_items: post: tags: - reports - summary: 'Quote item reports' - description: 'Export Quote item reports' + summary: "Quote item reports" + description: "Export Quote item reports" operationId: getQuoteItemReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/quotes: post: tags: - reports - summary: 'Quote reports' - description: 'Export quote reports' + summary: "Quote reports" + description: "Export quote reports" operationId: getQuoteReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/recurring_invoices: post: tags: - reports - summary: 'Recurring Invoice reports' - description: 'Export recurring invoice reports' + summary: "Recurring Invoice reports" + description: "Export recurring invoice reports" operationId: getRecurringInvoiceReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/tasks: post: tags: - reports - summary: 'Task reports' - description: 'Export task reports' + summary: "Task reports" + description: "Export task reports" operationId: getTaskReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/self-update: post: tags: - update - summary: 'Performs a system update' - description: 'Performs a system update' + summary: "Performs a system update" + description: "Performs a system update" operationId: selfUpdate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-API-PASSWORD' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-API-PASSWORD" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Success/failure response' + description: "Success/failure response" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/statics: get: tags: - statics - summary: 'Gets a list of statics' - description: 'Lists all statics' + summary: "Gets a list of statics" + description: "Lists all statics" operationId: getStatics parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of static data' + description: "A list of static data" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/subscriptions: get: tags: - subscriptions - summary: 'Gets a list of subscriptions' - description: 'Lists subscriptions.' + summary: "Gets a list of subscriptions" + description: "Lists subscriptions." operationId: getSubscriptions parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of subscriptions' + description: "A list of subscriptions" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/Subscription" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - subscriptions - summary: 'Adds a subscriptions' - description: 'Adds an subscriptions to the system' + summary: "Adds a subscriptions" + description: "Adds an subscriptions to the system" operationId: storeSubscription parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved subscriptions object' + description: "Returns the saved subscriptions object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/Subscription" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/subscriptions/create: get: tags: - subscriptions - summary: 'Gets a new blank subscriptions object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank subscriptions object" + description: "Returns a blank object with default values" operationId: getSubscriptionsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank subscriptions object' + description: "A blank subscriptions object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/Subscription" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/subscriptions/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/subscriptions/{id}": get: tags: - subscriptions - summary: 'Shows an subscriptions' - description: 'Displays an subscriptions by id' + summary: "Shows an subscriptions" + description: "Displays an subscriptions by id" operationId: showSubscription parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Subscription Hashed ID' + description: "The Subscription Hashed ID" required: true schema: type: string @@ -10419,47 +9690,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Subscription object' + description: "Returns the Subscription object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/Subscription" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - subscriptions - summary: 'Updates an subscriptions' - description: 'Handles the updating of an subscriptions by id' + summary: "Updates an subscriptions" + description: "Handles the updating of an subscriptions by id" operationId: updateSubscription parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Subscription Hashed ID' + description: "The Subscription Hashed ID" required: true schema: type: string @@ -10467,47 +9734,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the subscriptions object' + description: "Returns the subscriptions object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/Subscription" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - subscriptions - summary: 'Deletes a subscriptions' - description: 'Handles the deletion of an subscriptions by id' + summary: "Deletes a subscriptions" + description: "Handles the deletion of an subscriptions by id" operationId: deleteSubscription parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Subscription Hashed ID' + description: "The Subscription Hashed ID" required: true schema: type: string @@ -10515,44 +9778,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/subscriptions/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/subscriptions/{id}/edit": get: tags: - subscriptions - summary: 'Shows an subscriptions for editting' - description: 'Displays an subscriptions by id' + summary: "Shows an subscriptions for editting" + description: "Displays an subscriptions by id" operationId: editSubscription parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Subscription Hashed ID' + description: "The Subscription Hashed ID" required: true schema: type: string @@ -10560,102 +9819,97 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the invoice object' + description: "Returns the invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/Subscription" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/subscriptions/bulk: post: tags: - subscriptions - summary: 'Performs bulk actions on an array of subscriptions' - description: '' + summary: "Performs bulk actions on an array of subscriptions" + description: "" operationId: bulkSubscriptions parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Subscription response' + description: "The Subscription response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/Subscription" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/support/messages/send: post: tags: - support - summary: 'Sends a support message to Invoice Ninja team' - description: 'Allows a user to send a support message to the Invoice Ninja Team' + summary: "Sends a support message to Invoice Ninja team" + description: "Allows a user to send a support message to the Invoice Ninja Team" operationId: supportMessage parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" requestBody: - description: 'The message' + description: "The message" required: true content: application/json: schema: properties: message: - description: 'The support message' + description: "The support message" type: string type: string responses: @@ -10663,83 +9917,76 @@ paths: description: Success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: type: array items: - description: 'Server response' + description: "Server response" type: string example: true default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/system_logs: get: tags: - system_logs - summary: 'Gets a list of system logs' + summary: "Gets a list of system logs" description: "Lists system logs, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the system logs, these are handled by the SystemLogFilters class which defines the methods available" operationId: getSystemLogs parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of system logs' + description: "A list of system logs" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/SystemLog' + $ref: "#/components/schemas/SystemLog" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/system_logs/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/system_logs/{id}": get: tags: - system_logs - summary: 'Shows a system_logs' - description: 'Displays a system_logs by id' + summary: "Shows a system_logs" + description: "Displays a system_logs by id" operationId: showSystemLogs parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The system_logs Hashed ID' + description: "The system_logs Hashed ID" required: true schema: type: string @@ -10747,129 +9994,118 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the system_logs object' + description: "Returns the system_logs object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/SystemLog' + $ref: "#/components/schemas/SystemLog" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tasks: get: tags: - tasks - summary: 'Gets a list of tasks' + summary: "Gets a list of tasks" description: "Lists tasks, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the tasks, these are handled by the TaskFilters class which defines the methods available" operationId: getTasks parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of tasks' + description: "A list of tasks" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - tasks - summary: 'Adds a client' - description: 'Adds an client to a company' + summary: "Adds a client" + description: "Adds an client to a company" operationId: storeTask parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved client object' + description: "Returns the saved client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/tasks/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/tasks/{id}": get: tags: - tasks - summary: 'Shows a client' - description: 'Displays a client by id' + summary: "Shows a client" + description: "Displays a client by id" operationId: showTask parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Task Hashed ID' + description: "The Task Hashed ID" required: true schema: type: string @@ -10877,47 +10113,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the task object' + description: "Returns the task object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - tasks - summary: 'Updates a client' - description: 'Handles the updating of a client by id' + summary: "Updates a client" + description: "Handles the updating of a client by id" operationId: updateTask parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Task Hashed ID' + description: "The Task Hashed ID" required: true schema: type: string @@ -10925,47 +10157,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - tasks - summary: 'Deletes a client' - description: 'Handles the deletion of a client by id' + summary: "Deletes a client" + description: "Handles the deletion of a client by id" operationId: deleteTask parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Task Hashed ID' + description: "The Task Hashed ID" required: true schema: type: string @@ -10973,44 +10201,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/tasks/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/tasks/{id}/edit": get: tags: - tasks - summary: 'Shows a client for editting' - description: 'Displays a client by id' + summary: "Shows a client for editting" + description: "Displays a client by id" operationId: editTask parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Task Hashed ID' + description: "The Task Hashed ID" required: true schema: type: string @@ -11018,139 +10242,129 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tasks/create: get: tags: - tasks - summary: 'Gets a new blank client object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank client object" + description: "Returns a blank object with default values" operationId: getTasksCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank client object' + description: "A blank client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tasks/bulk: post: tags: - tasks - summary: 'Performs bulk actions on an array of tasks' - description: '' + summary: "Performs bulk actions on an array of tasks" + description: "" operationId: bulkTasks parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Task User response' + description: "The Task User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/tasks/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/tasks/{id}/upload": put: tags: - tasks - summary: 'Uploads a document to a task' - description: 'Handles the uploading of a document to a task' + summary: "Uploads a document to a task" + description: "Handles the uploading of a document to a task" operationId: uploadTask parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Task Hashed ID' + description: "The Task Hashed ID" required: true schema: type: string @@ -11158,185 +10372,174 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Task object' + description: "Returns the Task object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tasks/stort: post: tags: - tasks - summary: 'Sort tasks on KanBan' - description: 'Sorts tasks after drag and drop on the KanBan.' + summary: "Sort tasks on KanBan" + description: "Sorts tasks after drag and drop on the KanBan." operationId: sortTasks parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns an Ok, 200 HTTP status' + description: "Returns an Ok, 200 HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/task_schedulers/: get: tags: - task_schedulers - summary: 'Task Scheduler Index' - description: 'Get all schedulers with associated jobs' + summary: "Task Scheduler Index" + description: "Get all schedulers with associated jobs" operationId: getTaskSchedulers parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - task_schedulers - summary: 'Create task scheduler with job ' + summary: "Create task scheduler with job " description: "Create task scheduler with a job (action(job) request should be sent via request also. Example: We want client report to be job which will be run\n * multiple times, we should send the same parameters in the request as we would send if we wanted to get report, see example" operationId: createTaskScheduler parameters: - - - $ref: '#/components/parameters/X-API-SECRET' - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-API-SECRET" + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/TaskSchedulerSchema' + $ref: "#/components/schemas/TaskSchedulerSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/invoices/task_schedulers: get: tags: - task_schedulers - summary: 'Gets a new blank scheduler object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank scheduler object" + description: "Returns a blank object with default values" operationId: getTaskScheduler parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank scheduler object' + description: "A blank scheduler object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskSchedulerSchema' + $ref: "#/components/schemas/TaskSchedulerSchema" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/task_schedulers/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/task_schedulers/{id}": get: tags: - task_schedulers - summary: 'Show given scheduler' - description: 'Get scheduler with associated job' + summary: "Show given scheduler" + description: "Get scheduler with associated job" operationId: showTaskScheduler parameters: - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The Scheduler Hashed ID' + description: "The Scheduler Hashed ID" required: true schema: type: string @@ -11347,32 +10550,29 @@ paths: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - task_schedulers - summary: 'Update task scheduler ' - description: 'Update task scheduler' + summary: "Update task scheduler " + description: "Update task scheduler" operationId: updateTaskScheduler parameters: - - - $ref: '#/components/parameters/X-API-SECRET' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-SECRET" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The Scheduler Hashed ID' + description: "The Scheduler Hashed ID" required: true schema: type: string @@ -11383,42 +10583,40 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TaskSchedulerSchema' + $ref: "#/components/schemas/TaskSchedulerSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - task_schedulers - summary: 'Destroy Task Scheduler' - description: 'Destroy task scheduler and its associated job' + summary: "Destroy Task Scheduler" + description: "Destroy task scheduler and its associated job" operationId: destroyTaskScheduler parameters: - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The Scheduler Hashed ID' + description: "The Scheduler Hashed ID" required: true schema: type: string @@ -11429,214 +10627,197 @@ paths: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/task_schedulers/bulk: post: tags: - task_schedulers - summary: 'Performs bulk actions on an array of task_schedulers' - description: '' + summary: "Performs bulk actions on an array of task_schedulers" + description: "" operationId: bulkTaskSchedulerActions parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'array of ids' + description: "array of ids" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The TaskSchedule response' + description: "The TaskSchedule response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskSchedulerSchema' + $ref: "#/components/schemas/TaskSchedulerSchema" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/task_statuses: get: tags: - task_status - summary: 'Gets a list of task statuses' - description: 'Lists task statuses' + summary: "Gets a list of task statuses" + description: "Lists task statuses" operationId: getTaskStatuses parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of task statuses' + description: "A list of task statuses" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskStatus' + $ref: "#/components/schemas/TaskStatus" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - task_status - summary: 'Adds a TaskStatus' - description: 'Adds a TaskStatusto the system' + summary: "Adds a TaskStatus" + description: "Adds a TaskStatusto the system" operationId: storeTaskStatus parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" requestBody: - description: 'The task_status request' + description: "The task_status request" required: true content: application/json: schema: - $ref: '#/components/schemas/TaskStatus' + $ref: "#/components/schemas/TaskStatus" responses: 200: - description: 'Returns the saved TaskStatus object' + description: "Returns the saved TaskStatus object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskStatus' + $ref: "#/components/schemas/TaskStatus" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/task_statuses/create: get: tags: - task_status - summary: 'Gets a new blank TaskStatus object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank TaskStatus object" + description: "Returns a blank object with default values" operationId: getTaskStatussCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank TaskStatus object' + description: "A blank TaskStatus object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskStatus' + $ref: "#/components/schemas/TaskStatus" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/task_statuses/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/task_statuses/{id}": get: tags: - task_status - summary: 'Shows a TaskStatus Term' - description: 'Displays an TaskStatusby id' + summary: "Shows a TaskStatus Term" + description: "Displays an TaskStatusby id" operationId: showTaskStatus parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The TaskStatusHashed ID' + description: "The TaskStatusHashed ID" required: true schema: type: string @@ -11644,47 +10825,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the TaskStatusobject' + description: "Returns the TaskStatusobject" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskStatus' + $ref: "#/components/schemas/TaskStatus" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - task_status - summary: 'Updates a TaskStatus Term' - description: 'Handles the updating of an TaskStatus Termby id' + summary: "Updates a TaskStatus Term" + description: "Handles the updating of an TaskStatus Termby id" operationId: updateTaskStatus parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The TaskStatusHashed ID' + description: "The TaskStatusHashed ID" required: true schema: type: string @@ -11692,47 +10869,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the TaskStatusobject' + description: "Returns the TaskStatusobject" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskStatus' + $ref: "#/components/schemas/TaskStatus" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - task_statuss - summary: 'Deletes a TaskStatus Term' - description: 'Handles the deletion of an TaskStatus by id' + summary: "Deletes a TaskStatus Term" + description: "Handles the deletion of an TaskStatus by id" operationId: deleteTaskStatus parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The TaskStatusHashed ID' + description: "The TaskStatusHashed ID" required: true schema: type: string @@ -11740,44 +10913,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/task_statuses/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/task_statuses/{id}/edit": get: tags: - task_status - summary: 'Shows an TaskStatusfor editting' - description: 'Displays an TaskStatusby id' + summary: "Shows an TaskStatusfor editting" + description: "Displays an TaskStatusby id" operationId: editTaskStatuss parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The TaskStatusHashed ID' + description: "The TaskStatusHashed ID" required: true schema: type: string @@ -11785,171 +10954,162 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the TaskStatus object' + description: "Returns the TaskStatus object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskStatus' + $ref: "#/components/schemas/TaskStatus" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/task_statuses/bulk: post: tags: - task_status - summary: 'Performs bulk actions on an array of task statuses' - description: '' + summary: "Performs bulk actions on an array of task statuses" + description: "" operationId: bulkTaskStatuss parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'TaskStatus Ter,s' + description: "TaskStatus Ter,s" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The TaskStatus Terms response' + description: "The TaskStatus Terms response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskStatus' + $ref: "#/components/schemas/TaskStatus" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tax_rates: get: tags: - tax_rates - summary: 'Gets a list of tax_rates' - description: 'Lists tax rates' + summary: "Gets a list of tax_rates" + description: "Lists tax rates" operationId: getTaxRates parameters: - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of tax_rates' + description: "A list of tax_rates" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaxRate' + $ref: "#/components/schemas/TaxRate" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tax_rates/create: get: tags: - tax_rates - summary: 'Gets a new blank Tax Rate object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank Tax Rate object" + description: "Returns a blank object with default values" operationId: getTaxRateCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'A blank Tax Rate object' + description: "A blank Tax Rate object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaxRate' + $ref: "#/components/schemas/TaxRate" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/tax_rates/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/tax_rates/{id}": get: tags: - tax_rates - summary: 'Shows a Tax Rate' - description: 'Displays an TaxRate by id' + summary: "Shows a Tax Rate" + description: "Displays an TaxRate by id" operationId: showTaxRate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The TaxRate Hashed ID' + description: "The TaxRate Hashed ID" required: true schema: type: string @@ -11957,45 +11117,42 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Tax Rate object' + description: "Returns the Tax Rate object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaxRate' + $ref: "#/components/schemas/TaxRate" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - tax_rates - summary: 'Updates a tax rate' - description: 'Handles the updating of a tax rate by id' + summary: "Updates a tax rate" + description: "Handles the updating of a tax rate by id" operationId: updateTaxRate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The TaxRate Hashed ID' + description: "The TaxRate Hashed ID" required: true schema: type: string @@ -12003,45 +11160,42 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the TaxRate object' + description: "Returns the TaxRate object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaxRate' + $ref: "#/components/schemas/TaxRate" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - tax_rates - summary: 'Deletes a TaxRate' - description: 'Handles the deletion of an TaxRate by id' + summary: "Deletes a TaxRate" + description: "Handles the deletion of an TaxRate by id" operationId: deleteTaxRate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The TaxRate Hashed ID' + description: "The TaxRate Hashed ID" required: true schema: type: string @@ -12049,42 +11203,39 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/tax_rates/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/tax_rates/{id}/edit": get: tags: - tax_rates - summary: 'Shows a Tax Rate for editting' - description: 'Displays a Tax Rate by id' + summary: "Shows a Tax Rate for editting" + description: "Displays a Tax Rate by id" operationId: editTaxRate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The TaxRate Hashed ID' + description: "The TaxRate Hashed ID" required: true schema: type: string @@ -12092,230 +11243,215 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Tax Rate object' + description: "Returns the Tax Rate object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaxRate' + $ref: "#/components/schemas/TaxRate" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tax_rates/bulk: post: tags: - tax_rates - summary: 'Performs bulk actions on an array of TaxRates' - description: '' + summary: "Performs bulk actions on an array of TaxRates" + description: "" operationId: bulkTaxRates parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Tax Rates' + description: "Tax Rates" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The TaxRate List response' + description: "The TaxRate List response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/templates: post: tags: - templates - summary: 'Returns a entity template with the template variables replaced with the Entities' - description: 'Returns a entity template with the template variables replaced with the Entities' + summary: "Returns a entity template with the template variables replaced with the Entities" + description: "Returns a entity template with the template variables replaced with the Entities" operationId: getShowTemplate parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: - description: 'The template subject and body' + description: "The template subject and body" required: true content: application/json: schema: properties: subject: - description: 'The email template subject' + description: "The email template subject" type: string body: - description: 'The email template body' + description: "The email template body" type: string type: object responses: 200: - description: 'The template response' + description: "The template response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Template' + $ref: "#/components/schemas/Template" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tokens: get: tags: - tokens - summary: 'Gets a list of company tokens' + summary: "Gets a list of company tokens" description: "Lists company tokens.\n *\n * Query parameters can be added to performed more fine grained filtering of the tokens, these are handled by the TokenFilters class which defines the methods available" operationId: getTokens parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of tokens' + description: "A list of tokens" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyToken' + $ref: "#/components/schemas/CompanyToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - tokens - summary: 'Adds a token' - description: 'Adds an token to a company' + summary: "Adds a token" + description: "Adds an token to a company" operationId: storeToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved token object' + description: "Returns the saved token object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyToken' + $ref: "#/components/schemas/CompanyToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/tokens/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/tokens/{id}": get: tags: - tokens - summary: 'Shows a token' - description: 'Displays a token by id' + summary: "Shows a token" + description: "Displays a token by id" operationId: showToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Token Hashed ID' + description: "The Token Hashed ID" required: true schema: type: string @@ -12323,47 +11459,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the token object' + description: "Returns the token object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyToken' + $ref: "#/components/schemas/CompanyToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - tokens - summary: 'Updates a token' - description: 'Handles the updating of a token by id' + summary: "Updates a token" + description: "Handles the updating of a token by id" operationId: updateToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Token Hashed ID' + description: "The Token Hashed ID" required: true schema: type: string @@ -12371,47 +11503,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the token object' + description: "Returns the token object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyToken' + $ref: "#/components/schemas/CompanyToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - tokens - summary: 'Deletes a token' - description: 'Handles the deletion of a token by id' + summary: "Deletes a token" + description: "Handles the deletion of a token by id" operationId: deleteToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Token Hashed ID' + description: "The Token Hashed ID" required: true schema: type: string @@ -12419,44 +11547,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/tokens/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/tokens/{id}/edit": get: tags: - tokens - summary: 'Shows a token for editting' - description: 'Displays a token by id' + summary: "Shows a token for editting" + description: "Displays a token by id" operationId: editToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Token Hashed ID' + description: "The Token Hashed ID" required: true schema: type: string @@ -12464,258 +11588,239 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the token object' + description: "Returns the token object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyToken' + $ref: "#/components/schemas/CompanyToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tokens/create: get: tags: - tokens - summary: 'Gets a new blank token object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank token object" + description: "Returns a blank object with default values" operationId: getTokensCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank token object' + description: "A blank token object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyToken' + $ref: "#/components/schemas/CompanyToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tokens/bulk: post: tags: - tokens - summary: 'Performs bulk actions on an array of tokens' - description: '' + summary: "Performs bulk actions on an array of tokens" + description: "" operationId: bulkTokens parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Token ids' + description: "Token ids" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Token response' + description: "The Token response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyToken' + $ref: "#/components/schemas/CompanyToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/users: get: tags: - users - summary: 'Gets a list of users' + summary: "Gets a list of users" description: "Lists users, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the users, these are handled by the UserFilters class which defines the methods available" operationId: getUsers parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of users' + description: "A list of users" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - users - summary: 'Adds a User' - description: 'Adds an User to the system' + summary: "Adds a User" + description: "Adds an User to the system" operationId: storeUser parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved User object' + description: "Returns the saved User object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/users/create: get: tags: - users - summary: 'Gets a new blank User object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank User object" + description: "Returns a blank object with default values" operationId: getUsersCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank User object' + description: "A blank User object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/users/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/users/{id}": get: tags: - users - summary: 'Shows an User' - description: 'Displays an User by id' + summary: "Shows an User" + description: "Displays an User by id" operationId: showUser parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The User Hashed ID' + description: "The User Hashed ID" required: true schema: type: string @@ -12723,47 +11828,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the User object' + description: "Returns the User object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - users - summary: 'Updates an User' - description: 'Handles the updating of an User by id' + summary: "Updates an User" + description: "Handles the updating of an User by id" operationId: updateUser parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The User Hashed ID' + description: "The User Hashed ID" required: true schema: type: string @@ -12771,56 +11872,51 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the User object' + description: "Returns the User object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - users - summary: 'Deletes a User' - description: 'Handles the deletion of an User by id' + summary: "Deletes a User" + description: "Handles the deletion of an User by id" operationId: deleteUser parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: token_name + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: token_name in: query - description: 'Customized name for the Users API Token' + description: "Customized name for the Users API Token" required: false schema: type: string format: string - example: 'iOS Device 11 iPad' - - - name: id + example: "iOS Device 11 iPad" + - name: id in: path - description: 'The User Hashed ID' + description: "The User Hashed ID" required: true schema: type: string @@ -12828,44 +11924,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/users/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/users/{id}/edit": get: tags: - users - summary: 'Shows an User for editting' - description: 'Displays an User by id' + summary: "Shows an User for editting" + description: "Displays an User by id" operationId: editUser parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The User Hashed ID' + description: "The User Hashed ID" required: true schema: type: string @@ -12873,99 +11965,92 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the User object' + description: "Returns the User object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/users/bulk: post: tags: - users - summary: 'Performs bulk actions on an array of users' - description: '' + summary: "Performs bulk actions on an array of users" + description: "" operationId: bulkUsers parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Hashed ids' + description: "Hashed ids" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The User response' + description: "The User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/users/{user}/detach_from_company': + $ref: "#/components/schemas/Error" + "/api/v1/users/{user}/detach_from_company": delete: tags: - users - summary: 'Detach an existing user to a company' - description: 'Detach an existing user from a company' + summary: "Detach an existing user to a company" + description: "Detach an existing user from a company" operationId: detachUser parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: user + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: user in: path - description: 'The user hashed_id' + description: "The user hashed_id" required: true schema: type: string @@ -12973,44 +12058,40 @@ paths: example: FD767dfd7 responses: 200: - description: 'Success response' + description: "Success response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/users/{user}/invite': + $ref: "#/components/schemas/Error" + "/api/v1/users/{user}/invite": post: tags: - users - summary: 'Reconfirm an existing user to a company' - description: 'Reconfirm an existing user from a company' + summary: "Reconfirm an existing user to a company" + description: "Reconfirm an existing user from a company" operationId: inviteUser parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: user + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: user in: path - description: 'The user hashed_id' + description: "The user hashed_id" required: true schema: type: string @@ -13018,44 +12099,40 @@ paths: example: FD767dfd7 responses: 200: - description: 'Success response' + description: "Success response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/users/{user}/reconfirm': + $ref: "#/components/schemas/Error" + "/api/v1/users/{user}/reconfirm": post: tags: - users - summary: 'Reconfirm an existing user to a company' - description: 'Reconfirm an existing user from a company' + summary: "Reconfirm an existing user to a company" + description: "Reconfirm an existing user from a company" operationId: inviteUserReconfirm parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: user + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: user in: path - description: 'The user hashed_id' + description: "The user hashed_id" required: true schema: type: string @@ -13063,125 +12140,114 @@ paths: example: FD767dfd7 responses: 200: - description: 'Success response' + description: "Success response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/vendors: get: tags: - vendors - summary: 'Gets a list of vendors' + summary: "Gets a list of vendors" description: "Lists vendors, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the vendors, these are handled by the VendorFilters class which defines the methods available" operationId: getVendors parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of vendors' + description: "A list of vendors" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - vendors - summary: 'Adds a client' - description: 'Adds an client to a company' + summary: "Adds a client" + description: "Adds an client to a company" operationId: storeVendor parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved client object' + description: "Returns the saved client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/vendors/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/vendors/{id}": get: tags: - vendors - summary: 'Shows a client' - description: 'Displays a client by id' + summary: "Shows a client" + description: "Displays a client by id" operationId: showVendor parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Vendor Hashed ID' + description: "The Vendor Hashed ID" required: true schema: type: string @@ -13189,47 +12255,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the vendor object' + description: "Returns the vendor object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - vendors - summary: 'Updates a client' - description: 'Handles the updating of a client by id' + summary: "Updates a client" + description: "Handles the updating of a client by id" operationId: updateVendor parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Vendor Hashed ID' + description: "The Vendor Hashed ID" required: true schema: type: string @@ -13237,47 +12299,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - vendors - summary: 'Deletes a client' - description: 'Handles the deletion of a client by id' + summary: "Deletes a client" + description: "Handles the deletion of a client by id" operationId: deleteVendor parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Vendor Hashed ID' + description: "The Vendor Hashed ID" required: true schema: type: string @@ -13285,44 +12343,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/vendors/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/vendors/{id}/edit": get: tags: - vendors - summary: 'Shows a client for editting' - description: 'Displays a client by id' + summary: "Shows a client for editting" + description: "Displays a client by id" operationId: editVendor parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Vendor Hashed ID' + description: "The Vendor Hashed ID" required: true schema: type: string @@ -13330,139 +12384,129 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/vendors/create: get: tags: - vendors - summary: 'Gets a new blank client object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank client object" + description: "Returns a blank object with default values" operationId: getVendorsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank client object' + description: "A blank client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/vendors/bulk: post: tags: - vendors - summary: 'Performs bulk actions on an array of vendors' - description: '' + summary: "Performs bulk actions on an array of vendors" + description: "" operationId: bulkVendors parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Vendor User response' + description: "The Vendor User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/vendors/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/vendors/{id}/upload": put: tags: - vendors - summary: 'Uploads a document to a vendor' - description: 'Handles the uploading of a document to a vendor' + summary: "Uploads a document to a vendor" + description: "Handles the uploading of a document to a vendor" operationId: uploadVendor parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Vendor Hashed ID' + description: "The Vendor Hashed ID" required: true schema: type: string @@ -13470,161 +12514,149 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Vendor object' + description: "Returns the Vendor object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/webcron: get: tags: - webcron - summary: 'Executes the task scheduler via a webcron service' - description: 'Executes the task scheduler via a webcron service' + summary: "Executes the task scheduler via a webcron service" + description: "Executes the task scheduler via a webcron service" operationId: webcron parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'Success response' + description: "Success response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/webhooks: get: tags: - webhooks - summary: 'Gets a list of Webhooks' + summary: "Gets a list of Webhooks" description: "Lists Webhooks, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the Webhooks, these are handled by the WebhookFilters class which defines the methods available" operationId: getWebhooks parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of Webhooks' + description: "A list of Webhooks" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - webhooks - summary: 'Adds a Webhook' - description: 'Adds an Webhook to a company' + summary: "Adds a Webhook" + description: "Adds an Webhook to a company" operationId: storeWebhook parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved Webhook object' + description: "Returns the saved Webhook object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/webhooks/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/webhooks/{id}": get: tags: - webhooks - summary: 'Shows a Webhook' - description: 'Displays a Webhook by id' + summary: "Shows a Webhook" + description: "Displays a Webhook by id" operationId: showWebhook parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Webhook Hashed ID' + description: "The Webhook Hashed ID" required: true schema: type: string @@ -13632,47 +12664,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Webhook object' + description: "Returns the Webhook object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - webhooks - summary: 'Updates a Webhook' - description: 'Handles the updating of a Webhook by id' + summary: "Updates a Webhook" + description: "Handles the updating of a Webhook by id" operationId: updateWebhook parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Webhook Hashed ID' + description: "The Webhook Hashed ID" required: true schema: type: string @@ -13680,47 +12708,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Webhook object' + description: "Returns the Webhook object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - Webhooks - summary: 'Deletes a Webhook' - description: 'Handles the deletion of a Webhook by id' + summary: "Deletes a Webhook" + description: "Handles the deletion of a Webhook by id" operationId: deleteWebhook parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Webhook Hashed ID' + description: "The Webhook Hashed ID" required: true schema: type: string @@ -13728,44 +12752,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/webhooks/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/webhooks/{id}/edit": get: tags: - webhooks - summary: 'Shows a Webhook for editting' - description: 'Displays a Webhook by id' + summary: "Shows a Webhook for editting" + description: "Displays a Webhook by id" operationId: editWebhook parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Webhook Hashed ID' + description: "The Webhook Hashed ID" required: true schema: type: string @@ -13773,258 +12793,218 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Webhook object' + description: "Returns the Webhook object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/webhooks/create: get: tags: - webhooks - summary: 'Gets a new blank Webhook object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank Webhook object" + description: "Returns a blank object with default values" operationId: getWebhooksCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank Webhook object' + description: "A blank Webhook object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/webhooks/bulk: post: tags: - webhooks - summary: 'Performs bulk actions on an array of Webhooks' - description: '' + summary: "Performs bulk actions on an array of Webhooks" + description: "" operationId: bulkWebhooks parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Webhook User response' + description: "The Webhook User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" + /api/v1/products: get: tags: - products - summary: 'List products' - description: "Lists products, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the products, these are handled by the ProductFilters class which defines the methods available" + summary: "List products" + description: | + Lists products, search and filters allow fine grained lists to be generated. + Query parameters can be added to perform fine grained filtering of the products list, these are handled by the ProductFilters class + which defines the methods available operationId: getProducts parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of products' + description: "A list of products" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Product' + $ref: "#/components/schemas/Product" + 401: + description: "Authentication error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthenticationError" + 403: + description: "Authorization error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthorizationError" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - products - summary: 'Create Product' - description: 'Adds an Product to the system' + summary: "Create Product" + description: "Adds a product to a company" operationId: storeProduct parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved Product object' + description: "Returns the saved product object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Product' + $ref: "#/components/schemas/Product" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - /api/v1/products/create: + $ref: "#/components/schemas/Error" + "/api/v1/products/{id}": get: tags: - products - summary: 'Create product' - description: 'Returns a blank object with default values' - operationId: getProductsCreate - parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - responses: - 200: - description: 'A blank Product object' - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' - X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' - X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' - content: - application/json: - schema: - $ref: '#/components/schemas/Product' - 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' - default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - '/api/v1/products/{id}': - get: - tags: - - products - summary: 'Show product' - description: 'Displays an Product by id' + summary: "Show product" + description: "Displays a product by id" operationId: showProduct parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Product Hashed ID' + description: "The Product Hashed ID" required: true schema: type: string @@ -14032,47 +13012,55 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Product object' + description: "Returns the product object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Product' + $ref: "#/components/schemas/Product" + 401: + description: "Authentication error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthenticationError" + 403: + description: "Authorization error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthorizationError" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - products - summary: 'Update product' - description: 'Handles the updating of an Product by id' + summary: "Update product" + description: "Handles the updating of a product by id" operationId: updateProduct parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Product Hashed ID' + description: "The Product Hashed ID" required: true schema: type: string @@ -14080,47 +13068,55 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Product object' + description: "Returns the Product object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Product' + $ref: "#/components/schemas/Product" + 401: + description: "Authentication error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthenticationError" + 403: + description: "Authorization error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthorizationError" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - products - summary: 'Delete product' - description: 'Handles the deletion of an Product by id' + summary: "Delete product" + description: "Handles the deletion of a product by id" operationId: deleteProduct parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Product Hashed ID' + description: "The Product Hashed ID" required: true schema: type: string @@ -14128,44 +13124,52 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + description: "Authentication error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthenticationError" + 403: + description: "Authorization error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthorizationError" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/products/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/products/{id}/edit": get: tags: - products - summary: 'Show product' - description: 'Displays an Product by id' + summary: "Edit product" + description: "Displays an Product by id" operationId: editProduct parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Product Hashed ID' + description: "The Product Hashed ID" required: true schema: type: string @@ -14173,130 +13177,225 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Product object' + description: "Returns the Product object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Product' + $ref: "#/components/schemas/Product" + 401: + description: "Authentication error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthenticationError" + 403: + description: "Authorization error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthorizationError" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" + "/api/v1/products/create": + get: + tags: + - products + summary: "Blank product" + description: "Returns a blank product object with default values" + operationId: getProductsCreate + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "A blank Product object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Product" + 401: + description: "Authentication error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthenticationError" + 403: + description: "Authorization error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthorizationError" + 422: + description: "Validation error" + content: + application/json: + schema: + $ref: "#/components/schemas/ValidationError" + default: + description: "Unexpected Error" + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + /api/v1/products/bulk: post: tags: - products - summary: 'Bulk product actions' - description: '' + summary: "Bulk product actions" + description: "Archive / Restore / Delete in bulk" operationId: bulkProducts parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Hashed IDs' + description: "Hashed IDs" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Product response' + description: "The Product response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Product' + $ref: "#/components/schemas/Product" + 401: + description: "Authentication error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthenticationError" + 403: + description: "Authorization error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthorizationError" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/products/{id}/upload': + $ref: "#/components/schemas/Error" + + "/api/v1/products/{id}/upload": put: tags: - products - summary: 'Add product document' - description: 'Handles the uploading of a document to a product' + summary: "Add product document" + description: "Handles the uploading of a document to a product" operationId: uploadProduct parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/client_include" + - name: id in: path - description: 'The Product Hashed ID' + description: "The Product Hashed ID" required: true schema: type: string format: string example: D2J234DFA - responses: + produces: + - application/json + requestBody: + required: true + content: + multipart/form-data: + schema: + type: object + properties: + _method: + type: string + example: POST + documents: + type: array + format: binary 200: - description: 'Returns the Product object' + description: "Returns the Product object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Product' + $ref: "#/components/schemas/Product" + 401: + description: "Authentication error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthenticationError" + 403: + description: "Authorization error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthorizationError" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" + /api/v1/clients: get: tags: @@ -14306,72 +13405,60 @@ paths: Lists clients. Fine grained filtering is also available using query parameters. operationId: getClients parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' - - - $ref: '#/components/parameters/index' - - - name: name + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' + - $ref: '#/components/parameters/index' + - name: name in: query description: Filter by client name required: false schema: type: string example: bob - - - name: balance + - name: balance in: query description: Filter by client balance, format uses an operator and value separated by a colon. lt,lte, gt, gte, eq required: false schema: type: string example: lt:10 - - - name: between_balance + - name: between_balance in: query description: Filter between client balances, format uses two values separated by a colon required: false schema: type: string example: 10:100 - - - name: email + - name: email in: query description: Filter by client email required: false schema: type: string example: bob@gmail.com - - - name: id_number + - name: id_number in: query description: Filter by client id_number required: false schema: type: string example: a1039883 - - - name: number + - name: number in: query description: Filter by client number required: false schema: type: string example: a1039883 - - - name: filter + - name: filter in: query description: Filters clients on columns - name, id_number, contact.first_name contact.last_name, contact.email, custom_value1-4 required: false schema: type: string example: a1039883 - - - name: sort + - name: sort in: query description: Returns the list sorted by column in ascending or descending order. required: false @@ -14400,36 +13487,21 @@ paths: schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' post: tags: - clients summary: 'Create client' - description: 'Adds an client to a company' + description: 'Adds a client to a company' operationId: storeClient parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' responses: 200: description: 'Returns the saved client object' @@ -14451,23 +13523,11 @@ paths: schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' '/api/v1/clients/{id}': get: tags: @@ -14476,74 +13536,10 @@ paths: description: 'Displays a client by id' operationId: showClient parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' - - - name: id - in: path - description: 'The Client Hashed ID' - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: 'Returns the cl.ient object' - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' - X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' - X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' - content: - application/json: - schema: - $ref: '#/components/schemas/Client' - 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' - 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' - 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' - default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - put: - tags: - - clients - summary: 'Update client' - description: 'Handles the updating of a client by id' - operationId: updateClient - parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' - - - name: id + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' + - name: id in: path description: 'The Client Hashed ID' required: true @@ -14572,23 +13568,55 @@ paths: schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + $ref: '#/components/responses/default' + put: + tags: + - clients + summary: 'Update client' + description: 'Handles the updating of a client by id' + operationId: updateClient + parameters: + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' + - name: id + in: path + description: 'The Client Hashed ID' + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: 'Returns the client object' + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/schemas/Client' + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' + 422: + $ref: '#/components/responses/422' + default: + $ref: '#/components/responses/default' delete: tags: - clients @@ -14596,14 +13624,10 @@ paths: description: 'Handles the deletion of a client by id' operationId: deleteClient parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' - - - name: id + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' + - name: id in: path description: 'The Client Hashed ID' required: true @@ -14628,23 +13652,11 @@ paths: schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' '/api/v1/clients/{id}/edit': get: tags: @@ -14653,14 +13665,10 @@ paths: description: 'Displays a client by id' operationId: editClient parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/include' + - name: id in: path description: 'The Client Hashed ID' required: true @@ -14689,23 +13697,11 @@ paths: schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' /api/v1/clients/create: get: tags: @@ -14714,12 +13710,9 @@ paths: description: 'Returns a blank object with default values' operationId: getClientsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' responses: 200: description: 'A blank client object' @@ -14741,37 +13734,22 @@ paths: schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' /api/v1/clients/bulk: post: tags: - clients - summary: 'Bulk actions' - description: '' + summary: 'Bulk client actions' + description: 'Archive / Restore / Delete in bulk' operationId: bulkClients parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/index' requestBody: description: 'User credentials' required: true @@ -14804,23 +13782,11 @@ paths: schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' '/api/v1/clients/{id}/upload': put: tags: @@ -14829,14 +13795,10 @@ paths: description: 'Handles the uploading of a document to a client, please note due to a quirk in REST you will need to use a _method parameter with value of POST' operationId: uploadClient parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' - - - name: id + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' + - name: id in: path description: 'The Client Hashed ID' required: true @@ -14880,23 +13842,11 @@ paths: schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' '/api/v1/clients/{id}/purge': post: tags: @@ -14905,14 +13855,10 @@ paths: description: 'Handles purging a client' operationId: purgeClient parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' - - - name: id + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' + - name: id in: path description: 'The Client Hashed ID' required: true @@ -14937,23 +13883,11 @@ paths: schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' '/api/v1/clients/{id}/{mergeable_client_hashed_id}/merge': post: tags: @@ -14962,14 +13896,10 @@ paths: description: 'Handles merging 2 clients' operationId: mergeClient parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' - - - name: id + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' + - name: id in: path description: 'The Client Hashed ID' required: true @@ -14977,8 +13907,7 @@ paths: type: string format: string example: D2J234DFA - - - name: mergeable_client_hashed_id + - name: mergeable_client_hashed_id in: path description: 'The Mergeable Client Hashed ID' required: true @@ -15003,23 +13932,11 @@ paths: schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' /api/v1/client_statement: post: tags: @@ -15028,12 +13945,9 @@ paths: description: 'Return a PDF of the client statement' operationId: clientStatement parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/include' requestBody: description: 'Statment Options' required: true @@ -15072,29 +13986,13 @@ paths: schema: $ref: '#/components/schemas/Client' 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' components: parameters: X-API-SECRET: @@ -19377,27 +18275,23 @@ components: example: true type: object tags: - - - name: login + - name: login 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 + description: "Find out more" + url: "https://invoiceninja.github.io" + - name: clients description: | - Endpoint definitions for interacting with clients. - - - name: products + Endpoint definitions for interacting with clients. + - name: products description: | - Endpoint definitions for interacting with products. - - - name: invoices + Endpoint definitions for interacting with products. + - name: invoices description: | - Endpoint definitions for interacting with invoices. + Endpoint definitions for interacting with invoices. externalDocs: - description: 'https://invoiceninja.github.io' - url: 'https://invoiceninja.github.io' + description: "https://invoiceninja.github.io" + url: "https://invoiceninja.github.io" security: - - ApiKeyAuth: [] \ No newline at end of file + - ApiKeyAuth: [] diff --git a/openapi/components/responses/401.yaml b/openapi/components/responses/401.yaml new file mode 100644 index 000000000000..69425b37899f --- /dev/null +++ b/openapi/components/responses/401.yaml @@ -0,0 +1,5 @@ +description: 'Authentication error' +content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' \ No newline at end of file diff --git a/openapi/components/responses/403.yaml b/openapi/components/responses/403.yaml new file mode 100644 index 000000000000..19061bac43d1 --- /dev/null +++ b/openapi/components/responses/403.yaml @@ -0,0 +1,5 @@ +description: 'Authorization error' +content: + application/json: + schema: + $ref: '#components/schemas/AuthorizationError' \ No newline at end of file diff --git a/openapi/components/responses/404.yaml b/openapi/components/responses/404.yaml new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/openapi/components/responses/422.yaml b/openapi/components/responses/422.yaml new file mode 100644 index 000000000000..ef144eae1cd2 --- /dev/null +++ b/openapi/components/responses/422.yaml @@ -0,0 +1,5 @@ +description: 'Validation error' +content: + application/json: + schema: + $ref: '#/components/schemas/ValidationError' \ No newline at end of file diff --git a/openapi/components/responses/default.yaml b/openapi/components/responses/default.yaml new file mode 100644 index 000000000000..a3bf73e8979e --- /dev/null +++ b/openapi/components/responses/default.yaml @@ -0,0 +1,5 @@ +description: 'Unexpected Error' +content: + application/json: + schema: + $ref: '#/components/schemas/Error' \ No newline at end of file diff --git a/openapi/misc/misc.yaml b/openapi/misc/misc.yaml index 81e1ea4727be..4fef1ce7a532 100644 --- a/openapi/misc/misc.yaml +++ b/openapi/misc/misc.yaml @@ -1,25 +1,21 @@ tags: - - - name: login + - name: login 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 + description: "Find out more" + url: "https://invoiceninja.github.io" + - name: clients description: | - Endpoint definitions for interacting with clients. - - - name: products + Endpoint definitions for interacting with clients. + - name: products description: | - Endpoint definitions for interacting with products. - - - name: invoices + Endpoint definitions for interacting with products. + - name: invoices description: | - Endpoint definitions for interacting with invoices. + Endpoint definitions for interacting with invoices. externalDocs: - description: 'https://invoiceninja.github.io' - url: 'https://invoiceninja.github.io' + description: "https://invoiceninja.github.io" + url: "https://invoiceninja.github.io" security: - - ApiKeyAuth: [] \ No newline at end of file + - ApiKeyAuth: [] diff --git a/openapi/paths.yaml b/openapi/paths.yaml index 382a4cf1cdee..245d6784c4e2 100644 --- a/openapi/paths.yaml +++ b/openapi/paths.yaml @@ -3,25 +3,19 @@ paths: get: tags: - actvities - summary: 'Returns a list of actvities' - description: 'Lists all activities related to this company' + summary: "Returns a list of actvities" + description: "Lists all activities related to this company" operationId: getActivities parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/activity_include' - - - $ref: '#/components/parameters/index' - - - $ref: '#/components/parameters/per_page_meta' - - - $ref: '#/components/parameters/page_meta' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/activity_include" + - $ref: "#/components/parameters/index" + - $ref: "#/components/parameters/per_page_meta" + - $ref: "#/components/parameters/page_meta" responses: 200: - description: 'A list of actvities' + description: 'Returns the client object' headers: X-MINIMUM-CLIENT-VERSION: $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' @@ -32,31 +26,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Activity' - default: - description: 'Unexpected Error' + $ref: '#/components/schemas/Client' + 401: + description: 'Authentication error' content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/actvities/download_entity/{activity_id}': + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' + 422: + $ref: '#/components/responses/422' + default: + $ref: '#/components/responses/default' + "/api/v1/actvities/download_entity/{activity_id}": get: tags: - actvities - summary: 'Returns a PDF for the given activity' - description: 'Returns a PDF for the given activity' + summary: "Returns a PDF for the given activity" + description: "Returns a PDF for the given activity" operationId: getActivityHistoricalEntityPdf parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/activity_include' - - - name: activity_id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/activity_include" + - name: activity_id in: path - description: 'The Activity Hashed ID' + description: "The Activity Hashed ID" required: true schema: type: string @@ -64,63 +60,64 @@ paths: example: D2J234DFA responses: 200: - description: 'PDF File' + description: "PDF File" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 404: - description: 'No file exists for the given record' - default: - description: 'Unexpected Error' + description: "No file exists for the given record" + 401: + description: 'Authentication error' content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' + 422: + $ref: '#/components/responses/422' + default: + $ref: '#/components/responses/default' + /api/v1/login: post: tags: - login - summary: 'Attempts authentication' - description: 'Returns a CompanyUser object on success' + summary: "Attempts authentication" + description: "Returns a CompanyUser object on success" operationId: postLogin security: - [] parameters: - - - $ref: '#/components/parameters/X-API-SECRET' - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/login_include' - - - $ref: '#/components/parameters/include_static' - - - $ref: '#/components/parameters/clear_cache' + - $ref: "#/components/parameters/X-API-SECRET" + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/login_include" + - $ref: "#/components/parameters/include_static" + - $ref: "#/components/parameters/clear_cache" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: properties: email: - description: 'The users email address.' + description: "The users email address." type: string - example: 'demo@invoiceninja.com' + example: "demo@invoiceninja.com" password: - description: 'The user password. Must meet minimum criteria ~ > 6 characters' + description: "The user password. Must meet minimum criteria ~ > 6 characters" type: string - example: 'Password0' + example: "Password0" type: object responses: 200: - description: 'The Company User response' + description: 'Returns the company user object' headers: X-MINIMUM-CLIENT-VERSION: $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' @@ -131,209 +128,217 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CompanyUser' + $ref: '#/components/schemas/Client' 401: - description: 'Authentication failure' + description: 'Authentication error' content: application/json: schema: - $ref: '#/components/schemas/AuthenticationError' + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' + 422: + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' /api/v1/refresh: post: tags: - refresh - summary: 'Refresh data by timestamp' + summary: "Refresh data by timestamp" description: | - Refreshes the dataset. + Refreshes the dataset. - This endpoint can be used if you only need to access the most recent data from a certain point in time. - operationId: refresh + This endpoint can be used if you only need to access the most recent data from a certain point in time. + operationId: refresh parameters: - - - name: updated_at + - name: updated_at in: query - description: 'The unix timestamp from which the refreshed data should be sent from, if no value is passed the system will assume you require all data.' + description: "The unix timestamp from which the refreshed data should be sent from, if no value is passed the system will assume you require all data." required: true schema: type: number format: integer example: 1676173763 - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/include_static' - - - $ref: '#/components/parameters/clear_cache' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/include_static" + - $ref: "#/components/parameters/clear_cache" responses: 200: - description: 'The Company User response' + description: "The Company User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyUser' + $ref: "#/components/schemas/CompanyUser" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' + 422: + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/yodlee/refresh: post: tags: - yodlee - summary: 'Yodlee Webhook' - description: 'Webhook endpoint for Yodlee. Used to notify the system that a data point can be updated.' + summary: "Yodlee Webhook" + description: "Webhook endpoint for Yodlee. Used to notify the system that a data point can be updated." operationId: yodleeRefreshWebhook parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: '' + description: "" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' + 422: + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_integrations: get: tags: - bank_integrations - summary: 'Returns a list of Bank Integrations' - description: 'Lists all bank integrations' + summary: "Returns a list of Bank Integrations" + description: "Lists all bank integrations" operationId: getBankIntegrations parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/bank_integration_include' - - - $ref: '#/components/parameters/index' - - - name: rows + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/bank_integration_include" + - $ref: "#/components/parameters/index" + - name: rows in: query - description: 'The number of bank integrations to return' + description: "The number of bank integrations to return" required: false schema: type: number format: integer - example: '50' + example: "50" responses: 200: - description: 'A list of bank integrations' + description: "A list of bank integrations" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - bank_integrations - summary: 'Adds a bank_integration' - description: 'Adds an bank_integration to a company' + summary: "Adds a bank_integration" + description: "Adds an bank_integration to a company" operationId: storeBankIntegration parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved bank_integration object' + description: "Returns the saved bank_integration object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/bank_integrations/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/bank_integrations/{id}": get: tags: - bank_integrations - summary: 'Shows a bank_integration' - description: 'Displays a bank_integration by id' + summary: "Shows a bank_integration" + description: "Displays a bank_integration by id" operationId: showBankIntegration parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The BankIntegration Hashed ID' + description: "The BankIntegration Hashed ID" required: true schema: type: string @@ -341,47 +346,47 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_integration object' + description: "Returns the bank_integration object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - bank_integrations - summary: 'Updates a bank_integration' - description: 'Handles the updating of a bank_integration by id' + summary: "Updates a bank_integration" + description: "Handles the updating of a bank_integration by id" operationId: updateBankIntegration parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The BankIntegration Hashed ID' + description: "The BankIntegration Hashed ID" required: true schema: type: string @@ -389,47 +394,47 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_integration object' + description: "Returns the bank_integration object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - bank_integrations - summary: 'Deletes a bank_integration' - description: 'Handles the deletion of a bank_integration by id' + summary: "Deletes a bank_integration" + description: "Handles the deletion of a bank_integration by id" operationId: deleteBankIntegration parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The BankIntegration Hashed ID' + description: "The BankIntegration Hashed ID" required: true schema: type: string @@ -437,44 +442,44 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/bank_integrations/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/bank_integrations/{id}/edit": get: tags: - bank_integrations - summary: 'Shows a bank_integration for editing' - description: 'Displays a bank_integration by id' + summary: "Shows a bank_integration for editing" + description: "Displays a bank_integration by id" operationId: editBankIntegration parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The BankIntegration Hashed ID' + description: "The BankIntegration Hashed ID" required: true schema: type: string @@ -482,345 +487,326 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_integration object' + description: "Returns the bank_integration object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_integrations/create: get: tags: - bank_integrations - summary: 'Gets a new blank bank_integration object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank bank_integration object" + description: "Returns a blank object with default values" operationId: getBankIntegrationsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank bank_integration object' + description: "A blank bank_integration object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_integrations/bulk: post: tags: - bank_integrations - summary: 'Performs bulk actions on an array of bank_integrations' - description: '' + summary: "Performs bulk actions on an array of bank_integrations" + description: "" operationId: bulkBankIntegrations parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Action paramters' + description: "Action paramters" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Bulk Action response' + description: "The Bulk Action response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_integrations/refresh_accounts: post: tags: - bank_integrations - summary: 'Gets the list of accounts from the remote server' - description: 'Adds an bank_integration to a company' + summary: "Gets the list of accounts from the remote server" + description: "Adds an bank_integration to a company" operationId: getRefreshAccounts parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved bank_integration object' + description: "Returns the saved bank_integration object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_integrations/remove_account/account_id: post: tags: - bank_integrations - summary: 'Removes an account from the integration' - description: 'Removes an account from the integration' + summary: "Removes an account from the integration" + description: "Removes an account from the integration" operationId: getRemoveAccount parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the bank_integration object' + description: "Returns the bank_integration object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_integrations/get_transactions/account_id: post: tags: - bank_integrations - summary: 'Retrieve transactions for a account' - description: 'Retrieve transactions for a account' + summary: "Retrieve transactions for a account" + description: "Retrieve transactions for a account" operationId: getAccountTransactions parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Retrieve transactions for a account' + description: "Retrieve transactions for a account" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_transactions: get: tags: - bank_transactions - summary: 'Gets a list of bank_transactions' - description: 'Lists all bank integrations' + summary: "Gets a list of bank_transactions" + description: "Lists all bank integrations" operationId: getBankTransactions parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' - - - name: rows + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" + - name: rows in: query - description: 'The number of bank integrations to return' + description: "The number of bank integrations to return" required: false schema: type: number format: integer - example: '50' + example: "50" responses: 200: - description: 'A list of bank integrations' + description: "A list of bank integrations" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransaction' + $ref: "#/components/schemas/BankTransaction" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - bank_transactions - summary: 'Adds a bank_transaction' - description: 'Adds an bank_transaction to a company' + summary: "Adds a bank_transaction" + description: "Adds an bank_transaction to a company" operationId: storeBankTransaction parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved bank_transaction object' + description: "Returns the saved bank_transaction object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransaction' + $ref: "#/components/schemas/BankTransaction" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/bank_transactions/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/bank_transactions/{id}": get: tags: - bank_transactions - summary: 'Shows a bank_transaction' - description: 'Displays a bank_transaction by id' + summary: "Shows a bank_transaction" + description: "Displays a bank_transaction by id" operationId: showBankTransaction parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The BankTransaction Hashed ID' + description: "The BankTransaction Hashed ID" required: true schema: type: string @@ -828,47 +814,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_transaction object' + description: "Returns the bank_transaction object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransaction' + $ref: "#/components/schemas/BankTransaction" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - bank_transactions - summary: 'Updates a bank_transaction' - description: 'Handles the updating of a bank_transaction by id' + summary: "Updates a bank_transaction" + description: "Handles the updating of a bank_transaction by id" operationId: updateBankTransaction parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The BankTransaction Hashed ID' + description: "The BankTransaction Hashed ID" required: true schema: type: string @@ -876,47 +858,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_transaction object' + description: "Returns the bank_transaction object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransaction' + $ref: "#/components/schemas/BankTransaction" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - bank_transactions - summary: 'Deletes a bank_transaction' - description: 'Handles the deletion of a bank_transaction by id' + summary: "Deletes a bank_transaction" + description: "Handles the deletion of a bank_transaction by id" operationId: deleteBankTransaction parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The BankTransaction Hashed ID' + description: "The BankTransaction Hashed ID" required: true schema: type: string @@ -924,44 +902,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/bank_transactions/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/bank_transactions/{id}/edit": get: tags: - bank_transactions - summary: 'Shows a bank_transaction for editing' - description: 'Displays a bank_transaction by id' + summary: "Shows a bank_transaction for editing" + description: "Displays a bank_transaction by id" operationId: editBankTransaction parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The BankTransaction Hashed ID' + description: "The BankTransaction Hashed ID" required: true schema: type: string @@ -969,272 +943,251 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_transaction object' + description: "Returns the bank_transaction object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransaction' + $ref: "#/components/schemas/BankTransaction" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_transactions/create: get: tags: - bank_transactions - summary: 'Gets a new blank bank_transaction object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank bank_transaction object" + description: "Returns a blank object with default values" operationId: getBankTransactionsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank bank_transaction object' + description: "A blank bank_transaction object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransaction' + $ref: "#/components/schemas/BankTransaction" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_transations/bulk: post: tags: - bank_transactions - summary: 'Performs bulk actions on an array of bank_transations' - description: '' + summary: "Performs bulk actions on an array of bank_transations" + description: "" operationId: bulkBankTransactions parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Action paramters' + description: "Action paramters" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Bulk Action response' + description: "The Bulk Action response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_transations/match: post: tags: - bank_transactions - summary: 'Performs match actions on an array of bank_transactions' - description: '' + summary: "Performs match actions on an array of bank_transactions" + description: "" operationId: matchBankTransactions parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Action paramters' + description: "Action paramters" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Bulk Action response' + description: "The Bulk Action response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_transaction_rules: get: tags: - bank_transaction_rules - summary: 'Gets a list of bank_transaction_rules' - description: 'Lists all bank transaction rules' + summary: "Gets a list of bank_transaction_rules" + description: "Lists all bank transaction rules" operationId: getBankTransactionRules parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' - - - name: rows + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" + - name: rows in: query - description: 'The number of bank integrations to return' + description: "The number of bank integrations to return" required: false schema: type: number format: integer - example: '50' + example: "50" responses: 200: - description: 'A list of bank integrations' + description: "A list of bank integrations" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransactionRule' + $ref: "#/components/schemas/BankTransactionRule" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - bank_transaction_rules - summary: 'Adds a bank_transaction rule' - description: 'Adds an bank_transaction to a company' + summary: "Adds a bank_transaction rule" + description: "Adds an bank_transaction to a company" operationId: storeBankTransactionRule parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved bank_transaction rule object' + description: "Returns the saved bank_transaction rule object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransactionRule' + $ref: "#/components/schemas/BankTransactionRule" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/bank_transaction_rules/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/bank_transaction_rules/{id}": get: tags: - bank_transaction_rules - summary: 'Shows a bank_transaction' - description: 'Displays a bank_transaction by id' + summary: "Shows a bank_transaction" + description: "Displays a bank_transaction by id" operationId: showBankTransactionRule parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Bank Transaction RuleHashed ID' + description: "The Bank Transaction RuleHashed ID" required: true schema: type: string @@ -1242,47 +1195,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_transaction rule object' + description: "Returns the bank_transaction rule object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransactionRule' + $ref: "#/components/schemas/BankTransactionRule" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - bank_transaction_rules - summary: 'Updates a bank_transaction Rule' - description: 'Handles the updating of a bank_transaction rule by id' + summary: "Updates a bank_transaction Rule" + description: "Handles the updating of a bank_transaction rule by id" operationId: updateBankTransactionRule parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Bank Transaction Rule Hashed ID' + description: "The Bank Transaction Rule Hashed ID" required: true schema: type: string @@ -1290,47 +1239,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_transaction rule object' + description: "Returns the bank_transaction rule object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransactionRule' + $ref: "#/components/schemas/BankTransactionRule" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - bank_transaction_rules - summary: 'Deletes a bank_transaction rule' - description: 'Handles the deletion of a bank_transaction rule by id' + summary: "Deletes a bank_transaction rule" + description: "Handles the deletion of a bank_transaction rule by id" operationId: deleteBankTransactionRule parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Bank Transaction Rule Hashed ID' + description: "The Bank Transaction Rule Hashed ID" required: true schema: type: string @@ -1338,44 +1283,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/bank_transaction_rules/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/bank_transaction_rules/{id}/edit": get: tags: - bank_transaction_rules - summary: 'Shows a bank_transaction for editing' - description: 'Displays a bank_transaction by id' + summary: "Shows a bank_transaction for editing" + description: "Displays a bank_transaction by id" operationId: editBankTransactionRule parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Bank Transaction Rule Hashed ID' + description: "The Bank Transaction Rule Hashed ID" required: true schema: type: string @@ -1383,264 +1324,242 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_transaction rule object' + description: "Returns the bank_transaction rule object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransactionRule' + $ref: "#/components/schemas/BankTransactionRule" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_transaction_rules/create: get: tags: - bank_transaction_rules - summary: 'Gets a new blank bank_transaction rule object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank bank_transaction rule object" + description: "Returns a blank object with default values" operationId: getBankTransactionRulesCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank bank_transaction rule object' + description: "A blank bank_transaction rule object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransactionRule' + $ref: "#/components/schemas/BankTransactionRule" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_transation_rules/bulk: post: tags: - bank_transaction_rules - summary: 'Performs bulk actions on an array of bank_transation rules' - description: '' + summary: "Performs bulk actions on an array of bank_transation rules" + description: "" operationId: bulkBankTransactionRules parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Action paramters' + description: "Action paramters" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Bulk Action response' + description: "The Bulk Action response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/charts/totals: post: tags: - charts - summary: 'Get chart data' - description: 'Get chart data' + summary: "Get chart data" + description: "Get chart data" operationId: getChartTotals parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' - - - name: rows + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" + - name: rows in: query - description: 'The chart' + description: "The chart" required: false schema: type: number format: integer - example: '50' + example: "50" responses: 200: - description: 'json dataset of chart data' + description: "json dataset of chart data" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/client_gateway_tokens: get: tags: - client_gateway_tokens - summary: 'List of client tokens' + summary: "List of client tokens" description: "Lists client_gateway_tokens, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the client_gateway_tokens, these are handled by the ClientGatewayTokenFilters class which defines the methods available" operationId: getClientGatewayTokens parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of client_gateway_tokens' + description: "A list of client_gateway_tokens" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ClientGatewayToken' + $ref: "#/components/schemas/ClientGatewayToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - client_gateway_tokens - summary: 'Adds a client' - description: 'Adds an client to a company' + summary: "Adds a client" + description: "Adds an client to a company" operationId: storeClientGatewayToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved client object' + description: "Returns the saved client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ClientGatewayToken' + $ref: "#/components/schemas/ClientGatewayToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/client_gateway_tokens/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/client_gateway_tokens/{id}": get: tags: - client_gateway_tokens - summary: 'Shows a client' - description: 'Displays a client by id' + summary: "Shows a client" + description: "Displays a client by id" operationId: showClientGatewayToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The ClientGatewayToken Hashed ID' + description: "The ClientGatewayToken Hashed ID" required: true schema: type: string @@ -1648,47 +1567,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the cl.ient object' + description: "Returns the cl.ient object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ClientGatewayToken' + $ref: "#/components/schemas/ClientGatewayToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - client_gateway_tokens - summary: 'Updates a client' - description: 'Handles the updating of a client by id' + summary: "Updates a client" + description: "Handles the updating of a client by id" operationId: updateClientGatewayToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The ClientGatewayToken Hashed ID' + description: "The ClientGatewayToken Hashed ID" required: true schema: type: string @@ -1696,47 +1611,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ClientGatewayToken' + $ref: "#/components/schemas/ClientGatewayToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - client_gateway_tokens - summary: 'Deletes a client' - description: 'Handles the deletion of a client by id' + summary: "Deletes a client" + description: "Handles the deletion of a client by id" operationId: deleteClientGatewayToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The ClientGatewayToken Hashed ID' + description: "The ClientGatewayToken Hashed ID" required: true schema: type: string @@ -1744,44 +1655,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/client_gateway_tokens/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/client_gateway_tokens/{id}/edit": get: tags: - client_gateway_tokens - summary: 'Shows a client for editting' - description: 'Displays a client by id' + summary: "Shows a client for editting" + description: "Displays a client by id" operationId: editClientGatewayToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The ClientGatewayToken Hashed ID' + description: "The ClientGatewayToken Hashed ID" required: true schema: type: string @@ -1789,208 +1696,192 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ClientGatewayToken' + $ref: "#/components/schemas/ClientGatewayToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/client_gateway_tokens/create: get: tags: - client_gateway_tokens - summary: 'Gets a new blank client object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank client object" + description: "Returns a blank object with default values" operationId: getClientGatewayTokensCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank client object' + description: "A blank client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ClientGatewayToken' + $ref: "#/components/schemas/ClientGatewayToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - + $ref: "#/components/schemas/Error" + /api/v1/companies: get: tags: - companies - summary: 'Gets a list of companies' + summary: "Gets a list of companies" description: "Lists companies, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the companies, these are handled by the CompanyFilters class which defines the methods available" operationId: getCompanies parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of companies' + description: "A list of companies" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Company' + $ref: "#/components/schemas/Company" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - companies - summary: 'Adds a company' - description: 'Adds an company to the system' + summary: "Adds a company" + description: "Adds an company to the system" operationId: storeCompany parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved company object' + description: "Returns the saved company object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Company' + $ref: "#/components/schemas/Company" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/companies/create: get: tags: - companies - summary: 'Gets a new blank company object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank company object" + description: "Returns a blank object with default values" operationId: getCompaniesCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank company object' + description: "A blank company object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Company' + $ref: "#/components/schemas/Company" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/companies/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/companies/{id}": get: tags: - companies - summary: 'Shows an company' - description: 'Displays an company by id' + summary: "Shows an company" + description: "Displays an company by id" operationId: showCompany parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Company Hashed ID' + description: "The Company Hashed ID" required: true schema: type: string @@ -1998,47 +1889,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the company object' + description: "Returns the company object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Company' + $ref: "#/components/schemas/Company" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - companies - summary: 'Updates an company' - description: 'Handles the updating of an company by id' + summary: "Updates an company" + description: "Handles the updating of an company by id" operationId: updateCompany parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Company Hashed ID' + description: "The Company Hashed ID" required: true schema: type: string @@ -2046,47 +1933,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the company object' + description: "Returns the company object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Company' + $ref: "#/components/schemas/Company" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - companies - summary: 'Deletes a company' - description: 'Handles the deletion of an company by id' + summary: "Deletes a company" + description: "Handles the deletion of an company by id" operationId: deleteCompany parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Company Hashed ID' + description: "The Company Hashed ID" required: true schema: type: string @@ -2094,44 +1977,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/companies/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/companies/{id}/edit": get: tags: - companies - summary: 'Shows an company for editting' - description: 'Displays an company by id' + summary: "Shows an company for editting" + description: "Displays an company by id" operationId: editCompany parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Company Hashed ID' + description: "The Company Hashed ID" required: true schema: type: string @@ -2139,48 +2018,44 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the company object' + description: "Returns the company object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Company' + $ref: "#/components/schemas/Company" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/companies/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/companies/{id}/upload": put: tags: - companies - summary: 'Uploads a document to a company' - description: 'Handles the uploading of a document to a company' + summary: "Uploads a document to a company" + description: "Handles the uploading of a document to a company" operationId: uploadCompanies parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Company Hashed ID' + description: "The Company Hashed ID" required: true schema: type: string @@ -2188,48 +2063,44 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Company' + $ref: "#/components/schemas/Company" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/companies/{company}/default': + $ref: "#/components/schemas/Error" + "/api/v1/companies/{company}/default": post: tags: - companies - summary: 'Sets the company as the default company.' - description: 'Sets the company as the default company.' + summary: "Sets the company as the default company." + description: "Sets the company as the default company." operationId: setDefaultCompany parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: company + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: company in: path - description: 'The Company Hashed ID' + description: "The Company Hashed ID" required: true schema: type: string @@ -2237,167 +2108,154 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the company object' + description: "Returns the company object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Company' + $ref: "#/components/schemas/Company" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/company_gateways: get: tags: - company_gateways - summary: 'Gets a list of company_gateways' + summary: "Gets a list of company_gateways" description: "Lists company_gateways, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the company_gateways, these are handled by the CompanyGatewayFilters class which defines the methods available" operationId: getCompanyGateways parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of company_gateways' + description: "A list of company_gateways" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyGateway' + $ref: "#/components/schemas/CompanyGateway" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - company_gateways - summary: 'Adds a CompanyGateway' - description: 'Adds an CompanyGateway to the system' + summary: "Adds a CompanyGateway" + description: "Adds an CompanyGateway to the system" operationId: storeCompanyGateway parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved CompanyGateway object' + description: "Returns the saved CompanyGateway object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyGateway' + $ref: "#/components/schemas/CompanyGateway" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/company_gateways/create: get: tags: - company_gateways - summary: 'Gets a new blank CompanyGateway object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank CompanyGateway object" + description: "Returns a blank object with default values" operationId: getCompanyGatewaysCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank CompanyGateway object' + description: "A blank CompanyGateway object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyGateway' + $ref: "#/components/schemas/CompanyGateway" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/company_gateways/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/company_gateways/{id}": get: tags: - company_gateways - summary: 'Shows an CompanyGateway' - description: 'Displays an CompanyGateway by id' + summary: "Shows an CompanyGateway" + description: "Displays an CompanyGateway by id" operationId: showCompanyGateway parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The CompanyGateway Hashed ID' + description: "The CompanyGateway Hashed ID" required: true schema: type: string @@ -2405,47 +2263,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the CompanyGateway object' + description: "Returns the CompanyGateway object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyGateway' + $ref: "#/components/schemas/CompanyGateway" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - company_gateways - summary: 'Updates an CompanyGateway' - description: 'Handles the updating of an CompanyGateway by id' + summary: "Updates an CompanyGateway" + description: "Handles the updating of an CompanyGateway by id" operationId: updateCompanyGateway parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The CompanyGateway Hashed ID' + description: "The CompanyGateway Hashed ID" required: true schema: type: string @@ -2453,47 +2307,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the CompanyGateway object' + description: "Returns the CompanyGateway object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyGateway' + $ref: "#/components/schemas/CompanyGateway" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - company_gateways - summary: 'Deletes a CompanyGateway' - description: 'Handles the deletion of an CompanyGateway by id' + summary: "Deletes a CompanyGateway" + description: "Handles the deletion of an CompanyGateway by id" operationId: deleteCompanyGateway parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The CompanyGateway Hashed ID' + description: "The CompanyGateway Hashed ID" required: true schema: type: string @@ -2501,44 +2351,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/company_gateways/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/company_gateways/{id}/edit": get: tags: - company_gateways - summary: 'Shows an CompanyGateway for editting' - description: 'Displays an CompanyGateway by id' + summary: "Shows an CompanyGateway for editting" + description: "Displays an CompanyGateway by id" operationId: editCompanyGateway parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The CompanyGateway Hashed ID' + description: "The CompanyGateway Hashed ID" required: true schema: type: string @@ -2546,338 +2392,313 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the CompanyGateway object' + description: "Returns the CompanyGateway object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyGateway' + $ref: "#/components/schemas/CompanyGateway" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/company_gateways/bulk: post: tags: - company_gateways - summary: 'Performs bulk actions on an array of company_gateways' - description: '' + summary: "Performs bulk actions on an array of company_gateways" + description: "" operationId: bulkCompanyGateways parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Array of company gateway IDs' + description: "Array of company gateway IDs" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Company Gateways response' + description: "The Company Gateways response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyGateway' + $ref: "#/components/schemas/CompanyGateway" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/company_ledger: get: tags: - company_ledger - summary: 'Gets a list of company_ledger' - description: 'Lists the company_ledger.' + summary: "Gets a list of company_ledger" + description: "Lists the company_ledger." operationId: getCompanyLedger parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of company_ledger' + description: "A list of company_ledger" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyLedger' + $ref: "#/components/schemas/CompanyLedger" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/company_users: post: tags: - company_user - summary: 'Update a company user record' - description: 'Attempts to update a company user record. A company user can modify only their settings fields. Full access for Admin users' + summary: "Update a company user record" + description: "Attempts to update a company user record. A company user can modify only their settings fields. Full access for Admin users" operationId: updateCompanyUser parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'The Company User response' + description: "The Company User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyUser' + $ref: "#/components/schemas/CompanyUser" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/connected_account: post: tags: - connected_account - summary: 'Connect an oauth user to an existing user' - description: 'Refreshes the dataset' + summary: "Connect an oauth user to an existing user" + description: "Refreshes the dataset" operationId: connected_account parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/include_static' - - - $ref: '#/components/parameters/clear_cache' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/include_static" + - $ref: "#/components/parameters/clear_cache" responses: 200: - description: 'The Company User response' + description: "The Company User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/credits: get: tags: - credits - summary: 'Gets a list of credits' + summary: "Gets a list of credits" description: "Lists credits, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the credits, these are handled by the CreditFilters class which defines the methods available" operationId: getCredits parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of credits' + description: "A list of credits" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - credits - summary: 'Adds a credit' - description: 'Adds an credit to the system' + summary: "Adds a credit" + description: "Adds an credit to the system" operationId: storeCredit parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved credit object' + description: "Returns the saved credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/credits/create: get: tags: - credits - summary: 'Gets a new blank credit object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank credit object" + description: "Returns a blank object with default values" operationId: getCreditsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank credit object' + description: "A blank credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/credits/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/credits/{id}": get: tags: - credits - summary: 'Shows an credit' - description: 'Displays an credit by id' + summary: "Shows an credit" + description: "Displays an credit by id" operationId: showCredit parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Credit Hashed ID' + description: "The Credit Hashed ID" required: true schema: type: string @@ -2885,47 +2706,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the credit object' + description: "Returns the credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - Credits - summary: 'Updates an Credit' - description: 'Handles the updating of an Credit by id' + summary: "Updates an Credit" + description: "Handles the updating of an Credit by id" operationId: updateCredit parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Credit Hashed ID' + description: "The Credit Hashed ID" required: true schema: type: string @@ -2933,47 +2750,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Credit object' + description: "Returns the Credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - credits - summary: 'Deletes a credit' - description: 'Handles the deletion of an credit by id' + summary: "Deletes a credit" + description: "Handles the deletion of an credit by id" operationId: deleteCredit parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Credit Hashed ID' + description: "The Credit Hashed ID" required: true schema: type: string @@ -2981,44 +2794,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/credits/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/credits/{id}/edit": get: tags: - credits - summary: 'Shows an credit for editting' - description: 'Displays an credit by id' + summary: "Shows an credit for editting" + description: "Displays an credit by id" operationId: editCredit parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Invoice Hashed ID' + description: "The Invoice Hashed ID" required: true schema: type: string @@ -3026,95 +2835,88 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the credit object' + description: "Returns the credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/credits/bulk: post: tags: - credits - summary: 'Performs bulk actions on an array of credits' - description: '' + summary: "Performs bulk actions on an array of credits" + description: "" operationId: bulkCredits parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Bulk Action response' + description: "The Bulk Action response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/credit/{invitation_key}/download': + $ref: "#/components/schemas/Error" + "/api/v1/credit/{invitation_key}/download": get: tags: - quotes - summary: 'Download a specific credit by invitation key' - description: 'Downloads a specific quote' + summary: "Download a specific credit by invitation key" + description: "Downloads a specific quote" operationId: downloadCredit parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: invitation_key + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: invitation_key in: path - description: 'The Credit Invitation Key' + description: "The Credit Invitation Key" required: true schema: type: string @@ -3122,44 +2924,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the credit pdf' + description: "Returns the credit pdf" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/credits/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/credits/{id}/upload": put: tags: - credits - summary: 'Uploads a document to a credit' - description: 'Handles the uploading of a document to a credit' + summary: "Uploads a document to a credit" + description: "Handles the uploading of a document to a credit" operationId: uploadCredits parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Credit Hashed ID' + description: "The Credit Hashed ID" required: true schema: type: string @@ -3167,129 +2965,118 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Credit object' + description: "Returns the Credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/designs: get: tags: - designs - summary: 'Gets a list of designs' - description: 'Lists designs' + summary: "Gets a list of designs" + description: "Lists designs" operationId: getDesigns parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of designs' + description: "A list of designs" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Design' + $ref: "#/components/schemas/Design" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - designs - summary: 'Adds a design' - description: 'Adds an design to a company' + summary: "Adds a design" + description: "Adds an design to a company" operationId: storeDesign parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved design object' + description: "Returns the saved design object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Design' + $ref: "#/components/schemas/Design" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/designs/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/designs/{id}": get: tags: - designs - summary: 'Shows a design' - description: 'Displays a design by id' + summary: "Shows a design" + description: "Displays a design by id" operationId: showDesign parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Design Hashed ID' + description: "The Design Hashed ID" required: true schema: type: string @@ -3297,47 +3084,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the expense object' + description: "Returns the expense object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Design' + $ref: "#/components/schemas/Design" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - designs - summary: 'Updates a design' - description: 'Handles the updating of a design by id' + summary: "Updates a design" + description: "Handles the updating of a design by id" operationId: updateDesign parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Design Hashed ID' + description: "The Design Hashed ID" required: true schema: type: string @@ -3345,47 +3128,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the design object' + description: "Returns the design object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Design' + $ref: "#/components/schemas/Design" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - designs - summary: 'Deletes a design' - description: 'Handles the deletion of a design by id' + summary: "Deletes a design" + description: "Handles the deletion of a design by id" operationId: deleteDesign parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Design Hashed ID' + description: "The Design Hashed ID" required: true schema: type: string @@ -3393,44 +3172,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/designs/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/designs/{id}/edit": get: tags: - designs - summary: 'Shows a design for editting' - description: 'Displays a design by id' + summary: "Shows a design for editting" + description: "Displays a design by id" operationId: editDesign parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Design Hashed ID' + description: "The Design Hashed ID" required: true schema: type: string @@ -3438,194 +3213,183 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the design object' + description: "Returns the design object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Design' + $ref: "#/components/schemas/Design" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/designs/create: get: tags: - designs - summary: 'Gets a new blank design object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank design object" + description: "Returns a blank object with default values" operationId: getDesignsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank design object' + description: "A blank design object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Design' + $ref: "#/components/schemas/Design" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/designs/bulk: post: tags: - designs - summary: 'Performs bulk actions on an array of designs' - description: '' + summary: "Performs bulk actions on an array of designs" + description: "" operationId: bulkDesigns parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Design User response' + description: "The Design User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Design' + $ref: "#/components/schemas/Design" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/documents: get: tags: - documents - summary: 'Gets a list of documents' + summary: "Gets a list of documents" description: "Lists documents, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the documents, these are handled by the DocumentsFilters class which defines the methods available" operationId: getDocuments parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of documents' + description: "A list of documents" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Document' + $ref: "#/components/schemas/Document" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/emails: post: tags: - emails - summary: 'Sends an email for an entity' - description: 'Sends an email for an entity' + summary: "Sends an email for an entity" + description: "Sends an email for an entity" operationId: sendEmailTemplate parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: - description: 'The template subject and body' + description: "The template subject and body" required: true content: application/json: schema: properties: subject: - description: 'The email subject' + description: "The email subject" type: string body: - description: 'The email body' + description: "The email body" type: string entity: - description: 'The entity name' + description: "The entity name" type: string entity_id: - description: 'The entity_id' + description: "The entity_id" type: string template: - description: 'The template required' + description: "The template required" type: string type: object responses: @@ -3633,156 +3397,147 @@ paths: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Template' + $ref: "#/components/schemas/Template" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/expense_categories: get: tags: - expense_categories - summary: 'Gets a list of expense_categories' - description: 'Lists tax rates' + summary: "Gets a list of expense_categories" + description: "Lists tax rates" operationId: getExpenseCategorys parameters: - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of expense_categories' + description: "A list of expense_categories" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ExpenseCategory' + $ref: "#/components/schemas/ExpenseCategory" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - expense_categories - summary: 'Adds a expense category' - description: 'Adds an expense category to the system' + summary: "Adds a expense category" + description: "Adds an expense category to the system" operationId: storeExpenseCategory parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved invoice object' + description: "Returns the saved invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ExpenseCategory' + $ref: "#/components/schemas/ExpenseCategory" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/expense_categories/create: get: tags: - expense_categories - summary: 'Gets a new blank Expens Category object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank Expens Category object" + description: "Returns a blank object with default values" operationId: getExpenseCategoryCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'A blank Expens Category object' + description: "A blank Expens Category object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ExpenseCategory' + $ref: "#/components/schemas/ExpenseCategory" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/expense_categories/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/expense_categories/{id}": get: tags: - expense_categories - summary: 'Shows a Expens Category' - description: 'Displays an ExpenseCategory by id' + summary: "Shows a Expens Category" + description: "Displays an ExpenseCategory by id" operationId: showExpenseCategory parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The ExpenseCategory Hashed ID' + description: "The ExpenseCategory Hashed ID" required: true schema: type: string @@ -3790,45 +3545,42 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Expens Category object' + description: "Returns the Expens Category object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ExpenseCategory' + $ref: "#/components/schemas/ExpenseCategory" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - expense_categories - summary: 'Updates a tax rate' - description: 'Handles the updating of a tax rate by id' + summary: "Updates a tax rate" + description: "Handles the updating of a tax rate by id" operationId: updateExpenseCategory parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The ExpenseCategory Hashed ID' + description: "The ExpenseCategory Hashed ID" required: true schema: type: string @@ -3836,45 +3588,42 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the ExpenseCategory object' + description: "Returns the ExpenseCategory object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ExpenseCategory' + $ref: "#/components/schemas/ExpenseCategory" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - expense_categories - summary: 'Deletes a ExpenseCategory' - description: 'Handles the deletion of an ExpenseCategory by id' + summary: "Deletes a ExpenseCategory" + description: "Handles the deletion of an ExpenseCategory by id" operationId: deleteExpenseCategory parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The ExpenseCategory Hashed ID' + description: "The ExpenseCategory Hashed ID" required: true schema: type: string @@ -3882,42 +3631,39 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/expense_categories/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/expense_categories/{id}/edit": get: tags: - expense_categories - summary: 'Shows a Expens Category for editting' - description: 'Displays a Expens Category by id' + summary: "Shows a Expens Category for editting" + description: "Displays a Expens Category by id" operationId: editExpenseCategory parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The ExpenseCategory Hashed ID' + description: "The ExpenseCategory Hashed ID" required: true schema: type: string @@ -3925,180 +3671,166 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Expens Category object' + description: "Returns the Expens Category object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ExpenseCategory' + $ref: "#/components/schemas/ExpenseCategory" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/expense_categories/bulk: post: tags: - expense_categories - summary: 'Performs bulk actions on an array of ExpenseCategorys' - description: '' + summary: "Performs bulk actions on an array of ExpenseCategorys" + description: "" operationId: bulkExpenseCategorys parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Expens Categorys' + description: "Expens Categorys" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The ExpenseCategory List response' + description: "The ExpenseCategory List response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/expenses: get: tags: - expenses - summary: 'Gets a list of expenses' + summary: "Gets a list of expenses" description: "Lists expenses, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the expenses, these are handled by the ExpenseFilters class which defines the methods available" operationId: getExpenses parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of expenses' + description: "A list of expenses" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Expense' + $ref: "#/components/schemas/Expense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - expenses - summary: 'Adds a client' - description: 'Adds an client to a company' + summary: "Adds a client" + description: "Adds an client to a company" operationId: storeExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved client object' + description: "Returns the saved client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Expense' + $ref: "#/components/schemas/Expense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/expenses/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/expenses/{id}": get: tags: - expenses - summary: 'Shows a client' - description: 'Displays a client by id' + summary: "Shows a client" + description: "Displays a client by id" operationId: showExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Expense Hashed ID' + description: "The Expense Hashed ID" required: true schema: type: string @@ -4106,47 +3838,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the expense object' + description: "Returns the expense object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Expense' + $ref: "#/components/schemas/Expense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - expenses - summary: 'Updates a client' - description: 'Handles the updating of a client by id' + summary: "Updates a client" + description: "Handles the updating of a client by id" operationId: updateExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Expense Hashed ID' + description: "The Expense Hashed ID" required: true schema: type: string @@ -4154,47 +3882,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Expense' + $ref: "#/components/schemas/Expense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - expenses - summary: 'Deletes a client' - description: 'Handles the deletion of a client by id' + summary: "Deletes a client" + description: "Handles the deletion of a client by id" operationId: deleteExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Expense Hashed ID' + description: "The Expense Hashed ID" required: true schema: type: string @@ -4202,44 +3926,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/expenses/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/expenses/{id}/edit": get: tags: - expenses - summary: 'Shows a client for editting' - description: 'Displays a client by id' + summary: "Shows a client for editting" + description: "Displays a client by id" operationId: editExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Expense Hashed ID' + description: "The Expense Hashed ID" required: true schema: type: string @@ -4247,139 +3967,129 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Expense' + $ref: "#/components/schemas/Expense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/expenses/create: get: tags: - expenses - summary: 'Gets a new blank client object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank client object" + description: "Returns a blank object with default values" operationId: getExpensesCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank client object' + description: "A blank client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Expense' + $ref: "#/components/schemas/Expense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/expenses/bulk: post: tags: - expenses - summary: 'Performs bulk actions on an array of expenses' - description: '' + summary: "Performs bulk actions on an array of expenses" + description: "" operationId: bulkExpenses parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Expense User response' + description: "The Expense User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Expense' + $ref: "#/components/schemas/Expense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/expenses/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/expenses/{id}/upload": put: tags: - expense - summary: 'Uploads a document to a expense' - description: 'Handles the uploading of a document to a expense' + summary: "Uploads a document to a expense" + description: "Handles the uploading of a document to a expense" operationId: uploadExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Expense Hashed ID' + description: "The Expense Hashed ID" required: true schema: type: string @@ -4387,199 +4097,185 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Expense object' + description: "Returns the Expense object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Expense' + $ref: "#/components/schemas/Expense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/export: post: tags: - export - summary: 'Export data from the system' - description: 'Export data from the system' + summary: "Export data from the system" + description: "Export data from the system" operationId: getExport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/group_settings: get: tags: - group_settings - summary: 'Gets a list of group_settings' + summary: "Gets a list of group_settings" description: "Lists group_settings, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the group_settings, these are handled by the GroupSettingFilters class which defines the methods available" operationId: getGroupSettings parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of group_settings' + description: "A list of group_settings" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/GroupSetting' + $ref: "#/components/schemas/GroupSetting" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - group_settings - summary: 'Adds a GroupSetting' - description: 'Adds an GroupSetting to the system' + summary: "Adds a GroupSetting" + description: "Adds an GroupSetting to the system" operationId: storeGroupSetting parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved GroupSetting object' + description: "Returns the saved GroupSetting object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/GroupSetting' + $ref: "#/components/schemas/GroupSetting" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/group_settings/create: get: tags: - group_settings - summary: 'Gets a new blank GroupSetting object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank GroupSetting object" + description: "Returns a blank object with default values" operationId: getGroupSettingsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank GroupSetting object' + description: "A blank GroupSetting object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/GroupSetting' + $ref: "#/components/schemas/GroupSetting" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/group_settings/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/group_settings/{id}": get: tags: - group_settings - summary: 'Shows an GroupSetting' - description: 'Displays an GroupSetting by id' + summary: "Shows an GroupSetting" + description: "Displays an GroupSetting by id" operationId: showGroupSetting parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The GroupSetting Hashed ID' + description: "The GroupSetting Hashed ID" required: true schema: type: string @@ -4587,47 +4283,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the GroupSetting object' + description: "Returns the GroupSetting object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/GroupSetting' + $ref: "#/components/schemas/GroupSetting" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - group_settings - summary: 'Updates an GroupSetting' - description: 'Handles the updating of an GroupSetting by id' + summary: "Updates an GroupSetting" + description: "Handles the updating of an GroupSetting by id" operationId: updateGroupSetting parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The GroupSetting Hashed ID' + description: "The GroupSetting Hashed ID" required: true schema: type: string @@ -4635,47 +4327,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the GroupSetting object' + description: "Returns the GroupSetting object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/GroupSetting' + $ref: "#/components/schemas/GroupSetting" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - group_settings - summary: 'Deletes a GroupSetting' - description: 'Handles the deletion of an GroupSetting by id' + summary: "Deletes a GroupSetting" + description: "Handles the deletion of an GroupSetting by id" operationId: deleteGroupSetting parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The GroupSetting Hashed ID' + description: "The GroupSetting Hashed ID" required: true schema: type: string @@ -4683,44 +4371,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/group_settings/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/group_settings/{id}/edit": get: tags: - group_settings - summary: 'Shows an GroupSetting for editting' - description: 'Displays an GroupSetting by id' + summary: "Shows an GroupSetting for editting" + description: "Displays an GroupSetting by id" operationId: editGroupSetting parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The GroupSetting Hashed ID' + description: "The GroupSetting Hashed ID" required: true schema: type: string @@ -4728,95 +4412,88 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the GroupSetting object' + description: "Returns the GroupSetting object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/GroupSetting' + $ref: "#/components/schemas/GroupSetting" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/group_settings/bulk: post: tags: - group_settings - summary: 'Performs bulk actions on an array of group_settings' - description: '' + summary: "Performs bulk actions on an array of group_settings" + description: "" operationId: bulkGroupSettings parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'An array of group_settings ids' + description: "An array of group_settings ids" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Bulk Action response' + description: "The Bulk Action response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/group_settings/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/group_settings/{id}/upload": put: tags: - group_settings - summary: 'Uploads a document to a group setting' - description: 'Handles the uploading of a document to a group setting' + summary: "Uploads a document to a group setting" + description: "Handles the uploading of a document to a group setting" operationId: uploadGroupSetting parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Group Setting Hashed ID' + description: "The Group Setting Hashed ID" required: true schema: type: string @@ -4824,46 +4501,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Group Setting object' + description: "Returns the Group Setting object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/preimport: post: tags: - imports - summary: 'Pre Import checks - returns a reference to the job and the headers of the CSV' - description: 'Pre Import checks - returns a reference to the job and the headers of the CSV' + summary: "Pre Import checks - returns a reference to the job and the headers of the CSV" + description: "Pre Import checks - returns a reference to the job and the headers of the CSV" operationId: preimport parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" requestBody: - description: 'The CSV file' + description: "The CSV file" required: true content: multipart/form-data: @@ -4872,273 +4546,253 @@ paths: format: binary responses: 200: - description: 'Returns a reference to the file' + description: "Returns a reference to the file" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/import_json: post: tags: - import - summary: 'Import data from the system' - description: 'Import data from the system' + summary: "Import data from the system" + description: "Import data from the system" operationId: getImportJson parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/apple/confirm_purchase: post: tags: - postmark - summary: 'Processing webhooks from Apple for in app purchases' - description: 'Adds an credit to the system' + summary: "Processing webhooks from Apple for in app purchases" + description: "Adds an credit to the system" operationId: confirmApplePurchase parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved credit object' + description: "Returns the saved credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/apple/process_webhook: post: tags: - postmark - summary: 'Processing event webhooks from Apple for in purchase / subscription status update' - description: 'Adds an credit to the system' + summary: "Processing event webhooks from Apple for in purchase / subscription status update" + description: "Adds an credit to the system" operationId: processAppleWebhook parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved credit object' + description: "Returns the saved credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/invoices: get: tags: - invoices - summary: 'Gets a list of invoices' + summary: "Gets a list of invoices" description: "Lists invoices, search and filters allow fine grained lists to be generated.\n *\n *\t\tQuery parameters can be added to performed more fine grained filtering of the invoices, these are handled by the InvoiceFilters class which defines the methods available" operationId: getInvoices parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of invoices' + description: "A list of invoices" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - invoices - summary: 'Adds a invoice' - description: 'Adds an invoice to the system' + summary: "Adds a invoice" + description: "Adds an invoice to the system" operationId: storeInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/FillableInvoice' + $ref: "#/components/schemas/FillableInvoice" responses: 200: - description: 'Returns the saved invoice object' + description: "Returns the saved invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/invoices/create: get: tags: - invoices - summary: 'Gets a new blank invoice object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank invoice object" + description: "Returns a blank object with default values" operationId: getInvoicesCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank invoice object' + description: "A blank invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/invoices/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/invoices/{id}": get: tags: - invoices - summary: 'Shows an invoice' - description: 'Displays an invoice by id' + summary: "Shows an invoice" + description: "Displays an invoice by id" operationId: showInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Invoice Hashed ID' + description: "The Invoice Hashed ID" required: true schema: type: string @@ -5146,47 +4800,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the invoice object' + description: "Returns the invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - invoices - summary: 'Updates an invoice' - description: 'Handles the updating of an invoice by id' + summary: "Updates an invoice" + description: "Handles the updating of an invoice by id" operationId: updateInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Invoice Hashed ID' + description: "The Invoice Hashed ID" required: true schema: type: string @@ -5194,47 +4844,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the invoice object' + description: "Returns the invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - invoices - summary: 'Deletes a invoice' - description: 'Handles the deletion of an invoice by id' + summary: "Deletes a invoice" + description: "Handles the deletion of an invoice by id" operationId: deleteInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Invoice Hashed ID' + description: "The Invoice Hashed ID" required: true schema: type: string @@ -5242,44 +4888,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/invoices/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/invoices/{id}/edit": get: tags: - invoices - summary: 'Shows an invoice for editting' - description: 'Displays an invoice by id' + summary: "Shows an invoice for editting" + description: "Displays an invoice by id" operationId: editInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Invoice Hashed ID' + description: "The Invoice Hashed ID" required: true schema: type: string @@ -5287,104 +4929,96 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the invoice object' + description: "Returns the invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/invoices/bulk: post: tags: - invoices - summary: 'Performs bulk actions on an array of invoices' - description: '' + summary: "Performs bulk actions on an array of invoices" + description: "" operationId: bulkInvoices parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Bulk Action response' + description: "The Bulk Action response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/invoices/{id}/{action}': + $ref: "#/components/schemas/Error" + "/api/v1/invoices/{id}/{action}": get: tags: - invoices - summary: 'Performs a custom action on an invoice' + summary: "Performs a custom action on an invoice" description: "Performs a custom action on an invoice.\n *\n * The current range of actions are as follows\n * - clone_to_invoice\n * - clone_to_quote\n * - history\n * - delivery_note\n * - mark_paid\n * - download\n * - archive\n * - delete\n * - email" operationId: actionInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Invoice Hashed ID' + description: "The Invoice Hashed ID" required: true schema: type: string format: string example: D2J234DFA - - - name: action + - name: action in: path - description: 'The action string to be performed' + description: "The action string to be performed" required: true schema: type: string @@ -5392,48 +5026,44 @@ paths: example: clone_to_quote responses: 200: - description: 'Returns the invoice object' + description: "Returns the invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/invoice/{invitation_key}/download': + $ref: "#/components/schemas/Error" + "/api/v1/invoice/{invitation_key}/download": get: tags: - invoices - summary: 'Download a specific invoice by invitation key' - description: 'Downloads a specific invoice' + summary: "Download a specific invoice by invitation key" + description: "Downloads a specific invoice" operationId: downloadInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: invitation_key + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: invitation_key in: path - description: 'The Invoice Invitation Key' + description: "The Invoice Invitation Key" required: true schema: type: string @@ -5441,44 +5071,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the invoice pdf' + description: "Returns the invoice pdf" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/invoices/{id}/delivery_note': + $ref: "#/components/schemas/Error" + "/api/v1/invoices/{id}/delivery_note": get: tags: - invoices - summary: 'Download a specific invoice delivery notes' - description: 'Downloads a specific invoice delivery notes' + summary: "Download a specific invoice delivery notes" + description: "Downloads a specific invoice delivery notes" operationId: deliveryNote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Invoice Hahsed Id' + description: "The Invoice Hahsed Id" required: true schema: type: string @@ -5486,44 +5112,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the invoice delivery note pdf' + description: "Returns the invoice delivery note pdf" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/invoices/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/invoices/{id}/upload": put: tags: - invoices - summary: 'Uploads a document to a invoice' - description: 'Handles the uploading of a document to a invoice' + summary: "Uploads a document to a invoice" + description: "Handles the uploading of a document to a invoice" operationId: uploadInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Invoice Hashed ID' + description: "The Invoice Hashed ID" required: true schema: type: string @@ -5531,134 +5153,124 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Invoice object' + description: "Returns the Invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/claim_license: get: tags: - claim_license - summary: 'Attempts to claim a white label license' - description: 'Attempts to claim a white label license' + summary: "Attempts to claim a white label license" + description: "Attempts to claim a white label license" operationId: getClaimLicense parameters: - - - $ref: '#/components/parameters/X-Requested-With' - - - name: license_key + - $ref: "#/components/parameters/X-Requested-With" + - name: license_key in: query - description: 'The license hash' + description: "The license hash" required: true schema: type: string format: string example: d87sh-s755s-s7d76-sdsd8 - - - name: product_id + - name: product_id in: query - description: 'The ID of the product purchased.' + description: "The ID of the product purchased." required: true schema: type: string format: string - example: '1' + example: "1" responses: 200: description: Success! headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/logout: post: tags: - logout - summary: 'Gets a list of logout' - description: 'Lists all logout' + summary: "Gets a list of logout" + description: "Lists all logout" operationId: getLogout parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'Success message' + description: "Success message" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/migration/purge/{company}': + $ref: "#/components/schemas/Error" + "/api/v1/migration/purge/{company}": post: tags: - migration - summary: 'Attempts to purge a company record and all its child records' - description: 'Attempts to purge a company record and all its child records' + summary: "Attempts to purge a company record and all its child records" + description: "Attempts to purge a company record and all its child records" operationId: postPurgeCompany parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: company + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: company in: path - description: 'The Company Hashed ID' + description: "The Company Hashed ID" required: true schema: type: string @@ -5669,39 +5281,36 @@ paths: description: Success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/migration/purge_save_settings/{company}': + $ref: "#/components/schemas/Error" + "/api/v1/migration/purge_save_settings/{company}": post: tags: - migration - summary: 'Attempts to purge a companies child records but save the company record and its settings' - description: 'Attempts to purge a companies child records but save the company record and its settings' + summary: "Attempts to purge a companies child records but save the company record and its settings" + description: "Attempts to purge a companies child records but save the company record and its settings" operationId: postPurgeCompanySaveSettings parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: company + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: company in: path - description: 'The Company Hashed ID' + description: "The Company Hashed ID" required: true schema: type: string @@ -5712,41 +5321,37 @@ paths: description: Success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/migration/start: post: tags: - migration - summary: 'Starts the migration from previous version of Invoice Ninja' - description: 'Starts the migration from previous version of Invoice Ninja' + summary: "Starts the migration from previous version of Invoice Ninja" + description: "Starts the migration from previous version of Invoice Ninja" operationId: postStartMigration parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/X-API-PASSWORD' - - - name: migration + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/X-API-PASSWORD" + - name: migration in: query - description: 'The migraton file' + description: "The migraton file" required: true schema: type: object @@ -5757,199 +5362,185 @@ paths: description: Success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/one_time_token: post: tags: - one_time_token - summary: 'Attempts to create a one time token' - description: 'Attempts to create a one time token' + summary: "Attempts to create a one time token" + description: "Attempts to create a one time token" operationId: oneTimeToken parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'The Company User response' + description: "The Company User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/payments: get: tags: - payments - summary: 'Gets a list of payments' + summary: "Gets a list of payments" description: "Lists payments, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the payments, these are handled by the PaymentFilters class which defines the methods available" operationId: getPayments parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of payments' + description: "A list of payments" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - payments - summary: 'Adds a Payment' - description: 'Adds an Payment to the system' + summary: "Adds a Payment" + description: "Adds an Payment to the system" operationId: storePayment parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" requestBody: - description: 'The payment request' + description: "The payment request" required: true content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" responses: 200: - description: 'Returns the saved Payment object' + description: "Returns the saved Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/payments/create: get: tags: - payments - summary: 'Gets a new blank Payment object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank Payment object" + description: "Returns a blank object with default values" operationId: getPaymentsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank Payment object' + description: "A blank Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/payments/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/payments/{id}": get: tags: - payments - summary: 'Shows an Payment' - description: 'Displays an Payment by id' + summary: "Shows an Payment" + description: "Displays an Payment by id" operationId: showPayment parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Hashed ID' + description: "The Payment Hashed ID" required: true schema: type: string @@ -5957,47 +5548,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Payment object' + description: "Returns the Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - payments - summary: 'Updates an Payment' - description: 'Handles the updating of an Payment by id' + summary: "Updates an Payment" + description: "Handles the updating of an Payment by id" operationId: updatePayment parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Hashed ID' + description: "The Payment Hashed ID" required: true schema: type: string @@ -6005,47 +5592,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Payment object' + description: "Returns the Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - payments - summary: 'Deletes a Payment' - description: 'Handles the deletion of an Payment by id' + summary: "Deletes a Payment" + description: "Handles the deletion of an Payment by id" operationId: deletePayment parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Hashed ID' + description: "The Payment Hashed ID" required: true schema: type: string @@ -6053,44 +5636,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/payments/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/payments/{id}/edit": get: tags: - payments - summary: 'Shows an Payment for editting' - description: 'Displays an Payment by id' + summary: "Shows an Payment for editting" + description: "Displays an Payment by id" operationId: editPayment parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Hashed ID' + description: "The Payment Hashed ID" required: true schema: type: string @@ -6098,108 +5677,100 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Payment object' + description: "Returns the Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/payments/bulk: post: tags: - payments - summary: 'Performs bulk actions on an array of payments' - description: '' + summary: "Performs bulk actions on an array of payments" + description: "" operationId: bulkPayments parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Payment response' + description: "The Payment response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/payments/{id}/{action}': + $ref: "#/components/schemas/Error" + "/api/v1/payments/{id}/{action}": get: tags: - payments - summary: 'Performs a custom action on an Payment' + summary: "Performs a custom action on an Payment" description: "Performs a custom action on an Payment.\n\n The current range of actions are as follows\n - clone_to_Payment\n - clone_to_quote\n - history\n - delivery_note\n - mark_paid\n - download\n - archive\n - delete\n - email" operationId: actionPayment parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Hashed ID' + description: "The Payment Hashed ID" required: true schema: type: string format: string example: D2J234DFA - - - name: action + - name: action in: path - description: 'The action string to be performed' + description: "The action string to be performed" required: true schema: type: string @@ -6207,95 +5778,88 @@ paths: example: clone_to_quote responses: 200: - description: 'Returns the Payment object' + description: "Returns the Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/payments/refund: post: tags: - payments - summary: 'Adds a Refund' - description: 'Adds an Refund to the system' + summary: "Adds a Refund" + description: "Adds an Refund to the system" operationId: storeRefund parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" requestBody: - description: 'The refund request' + description: "The refund request" required: true content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" responses: 200: - description: 'Returns the saved Payment object' + description: "Returns the saved Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/payments/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/payments/{id}/upload": put: tags: - payments - summary: 'Uploads a document to a payment' - description: 'Handles the uploading of a document to a payment' + summary: "Uploads a document to a payment" + description: "Handles the uploading of a document to a payment" operationId: uploadPayment parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Hashed ID' + description: "The Payment Hashed ID" required: true schema: type: string @@ -6303,176 +5867,162 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Payment object' + description: "Returns the Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/payment_terms: get: tags: - payment_terms - summary: 'Gets a list of payment terms' - description: 'Lists payment terms' + summary: "Gets a list of payment terms" + description: "Lists payment terms" operationId: getPaymentTerms parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of payment terms' + description: "A list of payment terms" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/PaymentTerm' + $ref: "#/components/schemas/PaymentTerm" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - payment_terms - summary: 'Adds a Payment' - description: 'Adds a Payment Term to the system' + summary: "Adds a Payment" + description: "Adds a Payment Term to the system" operationId: storePaymentTerm parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" requestBody: - description: 'The payment_terms request' + description: "The payment_terms request" required: true content: application/json: schema: - $ref: '#/components/schemas/PaymentTerm' + $ref: "#/components/schemas/PaymentTerm" responses: 200: - description: 'Returns the saved Payment object' + description: "Returns the saved Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/PaymentTerm' + $ref: "#/components/schemas/PaymentTerm" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/payment_terms/create: get: tags: - payment_terms - summary: 'Gets a new blank PaymentTerm object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank PaymentTerm object" + description: "Returns a blank object with default values" operationId: getPaymentTermsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank PaymentTerm object' + description: "A blank PaymentTerm object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/payment_terms/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/payment_terms/{id}": get: tags: - payment_terms - summary: 'Shows a Payment Term' - description: 'Displays an Payment Term by id' + summary: "Shows a Payment Term" + description: "Displays an Payment Term by id" operationId: showPaymentTerm parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Term Hashed ID' + description: "The Payment Term Hashed ID" required: true schema: type: string @@ -6480,47 +6030,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Payment Term object' + description: "Returns the Payment Term object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/PaymentTerm' + $ref: "#/components/schemas/PaymentTerm" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - payment_terms - summary: 'Updates a Payment Term' - description: 'Handles the updating of an Payment Termby id' + summary: "Updates a Payment Term" + description: "Handles the updating of an Payment Termby id" operationId: updatePaymentTerm parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Term Hashed ID' + description: "The Payment Term Hashed ID" required: true schema: type: string @@ -6528,47 +6074,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Payment Term object' + description: "Returns the Payment Term object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/PaymentTerm' + $ref: "#/components/schemas/PaymentTerm" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - payment_termss - summary: 'Deletes a Payment Term' - description: 'Handles the deletion of an PaymentTerm by id' + summary: "Deletes a Payment Term" + description: "Handles the deletion of an PaymentTerm by id" operationId: deletePaymentTerm parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Term Hashed ID' + description: "The Payment Term Hashed ID" required: true schema: type: string @@ -6576,44 +6118,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/payment_terms/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/payment_terms/{id}/edit": get: tags: - payment_terms - summary: 'Shows an Payment Term for editting' - description: 'Displays an Payment Term by id' + summary: "Shows an Payment Term for editting" + description: "Displays an Payment Term by id" operationId: editPaymentTerms parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Term Hashed ID' + description: "The Payment Term Hashed ID" required: true schema: type: string @@ -6621,325 +6159,304 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Payment object' + description: "Returns the Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/PaymentTerm' + $ref: "#/components/schemas/PaymentTerm" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/payment_terms/bulk: post: tags: - payment_terms - summary: 'Performs bulk actions on an array of payment terms' - description: '' + summary: "Performs bulk actions on an array of payment terms" + description: "" operationId: bulkPaymentTerms parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Payment Ter,s' + description: "Payment Ter,s" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Payment Terms response' + description: "The Payment Terms response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/PaymentTerm' + $ref: "#/components/schemas/PaymentTerm" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/ping: get: tags: - ping - summary: 'Attempts to ping the API' - description: 'Attempts to ping the API' + summary: "Attempts to ping the API" + description: "Attempts to ping the API" operationId: getPing parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'The company and user name' + description: "The company and user name" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" /api/v1/health_check: get: tags: - health_check - summary: 'Attempts to get a health check from the API' - description: 'Attempts to get a health check from the API' + summary: "Attempts to get a health check from the API" + description: "Attempts to get a health check from the API" operationId: getHealthCheck parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'A key/value map of the system health' + description: "A key/value map of the system health" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" /api/v1/postmark_webhook: post: tags: - postmark - summary: 'Processing webhooks from PostMark' - description: 'Adds an credit to the system' + summary: "Processing webhooks from PostMark" + description: "Adds an credit to the system" operationId: postmarkWebhook parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved credit object' + description: "Returns the saved credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/preview: post: tags: - preview - summary: 'Returns a pdf preview' - description: 'Returns a pdf preview.' + summary: "Returns a pdf preview" + description: "Returns a pdf preview." operationId: getPreview parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'The pdf response' + description: "The pdf response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/preview/purchase_order: post: tags: - preview - summary: 'Returns a pdf preview for purchase order' - description: 'Returns a pdf preview for purchase order.' + summary: "Returns a pdf preview for purchase order" + description: "Returns a pdf preview for purchase order." operationId: getPreviewPurchaseOrder parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'The pdf response' + description: "The pdf response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - + $ref: "#/components/schemas/Error" + /api/v1/projects: get: tags: - projects - summary: 'Gets a list of projects' - description: 'Lists projects' + summary: "Gets a list of projects" + description: "Lists projects" operationId: getProjects parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of projects' + description: "A list of projects" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - projects - summary: 'Adds a project' - description: 'Adds an project to a company' + summary: "Adds a project" + description: "Adds an project to a company" operationId: storeProject parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved project object' + description: "Returns the saved project object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/projects/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/projects/{id}": get: tags: - projects - summary: 'Shows a project' - description: 'Displays a project by id' + summary: "Shows a project" + description: "Displays a project by id" operationId: showProject parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Project Hashed ID' + description: "The Project Hashed ID" required: true schema: type: string @@ -6947,47 +6464,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the expense object' + description: "Returns the expense object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - projects - summary: 'Updates a project' - description: 'Handles the updating of a project by id' + summary: "Updates a project" + description: "Handles the updating of a project by id" operationId: updateProject parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Project Hashed ID' + description: "The Project Hashed ID" required: true schema: type: string @@ -6995,47 +6508,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the project object' + description: "Returns the project object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - projects - summary: 'Deletes a project' - description: 'Handles the deletion of a project by id' + summary: "Deletes a project" + description: "Handles the deletion of a project by id" operationId: deleteProject parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Project Hashed ID' + description: "The Project Hashed ID" required: true schema: type: string @@ -7043,44 +6552,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/projects/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/projects/{id}/edit": get: tags: - projects - summary: 'Shows a project for editting' - description: 'Displays a project by id' + summary: "Shows a project for editting" + description: "Displays a project by id" operationId: editProject parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Project Hashed ID' + description: "The Project Hashed ID" required: true schema: type: string @@ -7088,139 +6593,129 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the project object' + description: "Returns the project object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/projects/create: get: tags: - projects - summary: 'Gets a new blank project object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank project object" + description: "Returns a blank object with default values" operationId: getProjectsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank project object' + description: "A blank project object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/projects/bulk: post: tags: - projects - summary: 'Performs bulk actions on an array of projects' - description: '' + summary: "Performs bulk actions on an array of projects" + description: "" operationId: bulkProjects parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Project User response' + description: "The Project User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/projects/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/projects/{id}/upload": put: tags: - projects - summary: 'Uploads a document to a project' - description: 'Handles the uploading of a document to a project' + summary: "Uploads a document to a project" + description: "Handles the uploading of a document to a project" operationId: uploadProject parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Project Hashed ID' + description: "The Project Hashed ID" required: true schema: type: string @@ -7228,167 +6723,154 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Project object' + description: "Returns the Project object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/purchase_orders: get: tags: - purchase_orders - summary: 'Gets a list of purchase orders' + summary: "Gets a list of purchase orders" description: "Lists purchase orders, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the purchase orders, these are handled by the PurchaseOrderFilters class which defines the methods available" operationId: getPurchaseOrders parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of purchase orders' + description: "A list of purchase orders" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - purhcase_orders - summary: 'Adds a purchase order' - description: 'Adds an purchase order to the system' + summary: "Adds a purchase order" + description: "Adds an purchase order to the system" operationId: storePurchaseOrder parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved purchase order object' + description: "Returns the saved purchase order object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/purchase_orders/create: get: tags: - purchase_orders - summary: 'Gets a new blank purchase order object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank purchase order object" + description: "Returns a blank object with default values" operationId: getPurchaseOrderCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank purchase order object' + description: "A blank purchase order object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/purchase_orders/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/purchase_orders/{id}": get: tags: - purchase_orders - summary: 'Shows an purcase orders' - description: 'Displays an purchase order by id' + summary: "Shows an purcase orders" + description: "Displays an purchase order by id" operationId: showPurchaseOrder parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Purchase order Hashed ID' + description: "The Purchase order Hashed ID" required: true schema: type: string @@ -7396,47 +6878,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the purchase order object' + description: "Returns the purchase order object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - purchase_orders - summary: 'Deletes a purchase order' - description: 'Handles the deletion of an purchase orders by id' + summary: "Deletes a purchase order" + description: "Handles the deletion of an purchase orders by id" operationId: deletePurchaseOrder parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The purhcase order Hashed ID' + description: "The purhcase order Hashed ID" required: true schema: type: string @@ -7444,44 +6922,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/purchase_orders/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/purchase_orders/{id}/edit": get: tags: - purchase_orders - summary: 'Shows an purchase order for editting' - description: 'Displays an purchase order by id' + summary: "Shows an purchase order for editting" + description: "Displays an purchase order by id" operationId: editPurchaseOrder parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The purchase order Hashed ID' + description: "The purchase order Hashed ID" required: true schema: type: string @@ -7489,48 +6963,44 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the purchase order object' + description: "Returns the purchase order object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/purchase_order/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/purchase_order/{id}": put: tags: - purchase_orders - summary: 'Updates an purchase order' - description: 'Handles the updating of an purchase order by id' + summary: "Updates an purchase order" + description: "Handles the updating of an purchase order by id" operationId: updatePurchaseOrder parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The purchase order Hashed ID' + description: "The purchase order Hashed ID" required: true schema: type: string @@ -7538,104 +7008,96 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the purchase order object' + description: "Returns the purchase order object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/purchase_orders/bulk: post: tags: - purchase_orders - summary: 'Performs bulk actions on an array of purchase_orders' - description: '' + summary: "Performs bulk actions on an array of purchase_orders" + description: "" operationId: bulkPurchaseOrderss parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Purchase Order IDS' + description: "Purchase Order IDS" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Bulk Action response' + description: "The Bulk Action response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/purchase_orders/{id}/{action}': + $ref: "#/components/schemas/Error" + "/api/v1/purchase_orders/{id}/{action}": get: tags: - purchase_orders - summary: 'Performs a custom action on an purchase order' + summary: "Performs a custom action on an purchase order" description: "Performs a custom action on an purchase order.\n *\n * The current range of actions are as follows\n * - mark_paid\n * - download\n * - archive\n * - delete\n * - email" operationId: actionPurchaseOrder parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Purchase Order Hashed ID' + description: "The Purchase Order Hashed ID" required: true schema: type: string format: string example: D2J234DFA - - - name: action + - name: action in: path - description: 'The action string to be performed' + description: "The action string to be performed" required: true schema: type: string @@ -7643,48 +7105,44 @@ paths: example: clone_to_quote responses: 200: - description: 'Returns the invoice object' + description: "Returns the invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/purchase_orders/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/purchase_orders/{id}/upload": put: tags: - purchase_orders - summary: 'Uploads a document to a purchase_orders' - description: 'Handles the uploading of a document to a purchase_order' + summary: "Uploads a document to a purchase_orders" + description: "Handles the uploading of a document to a purchase_order" operationId: uploadPurchaseOrder parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Purchase Order Hashed ID' + description: "The Purchase Order Hashed ID" required: true schema: type: string @@ -7692,48 +7150,44 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Purchase Order object' + description: "Returns the Purchase Order object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/purchase_order/{invitation_key}/download': + $ref: "#/components/schemas/Error" + "/api/v1/purchase_order/{invitation_key}/download": get: tags: - purchase_orders - summary: 'Download a specific purchase order by invitation key' - description: 'Downloads a specific purchase order' + summary: "Download a specific purchase order by invitation key" + description: "Downloads a specific purchase order" operationId: downloadPurchaseOrder parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: invitation_key + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: invitation_key in: path - description: 'The Purchase Order Invitation Key' + description: "The Purchase Order Invitation Key" required: true schema: type: string @@ -7741,163 +7195,150 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Purchase Order pdf' + description: "Returns the Purchase Order pdf" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/quotes: get: tags: - quotes - summary: 'Gets a list of quotes' + summary: "Gets a list of quotes" description: "Lists quotes, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the quotes, these are handled by the QuoteFilters class which defines the methods available" operationId: getQuotes parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of quotes' + description: "A list of quotes" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - quotes - summary: 'Adds a Quote' - description: 'Adds an Quote to the system' + summary: "Adds a Quote" + description: "Adds an Quote to the system" operationId: storeQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved Quote object' + description: "Returns the saved Quote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/quotes/create: get: tags: - quotes - summary: 'Gets a new blank Quote object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank Quote object" + description: "Returns a blank object with default values" operationId: getQuotesCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank Quote object' + description: "A blank Quote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/quotes/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/quotes/{id}": get: tags: - quotes - summary: 'Shows an Quote' - description: 'Displays an Quote by id' + summary: "Shows an Quote" + description: "Displays an Quote by id" operationId: showQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Quote Hashed ID' + description: "The Quote Hashed ID" required: true schema: type: string @@ -7905,47 +7346,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Quote object' + description: "Returns the Quote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - quotes - summary: 'Updates an Quote' - description: 'Handles the updating of an Quote by id' + summary: "Updates an Quote" + description: "Handles the updating of an Quote by id" operationId: updateQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Quote Hashed ID' + description: "The Quote Hashed ID" required: true schema: type: string @@ -7953,47 +7390,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Quote object' + description: "Returns the Quote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - quotes - summary: 'Deletes a Quote' - description: 'Handles the deletion of an Quote by id' + summary: "Deletes a Quote" + description: "Handles the deletion of an Quote by id" operationId: deleteQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Quote Hashed ID' + description: "The Quote Hashed ID" required: true schema: type: string @@ -8001,44 +7434,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/quotes/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/quotes/{id}/edit": get: tags: - quotes - summary: 'Shows an Quote for editting' - description: 'Displays an Quote by id' + summary: "Shows an Quote for editting" + description: "Displays an Quote by id" operationId: editQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Quote Hashed ID' + description: "The Quote Hashed ID" required: true schema: type: string @@ -8046,108 +7475,100 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Quote object' + description: "Returns the Quote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/quotes/bulk: post: tags: - quotes - summary: 'Performs bulk actions on an array of quotes' - description: '' + summary: "Performs bulk actions on an array of quotes" + description: "" operationId: bulkQuotes parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Hashed ids' + description: "Hashed ids" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Quote response' + description: "The Quote response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/quotes/{id}/{action}': + $ref: "#/components/schemas/Error" + "/api/v1/quotes/{id}/{action}": get: tags: - quotes - summary: 'Performs a custom action on an Quote' + summary: "Performs a custom action on an Quote" description: "Performs a custom action on an Quote.\n\n The current range of actions are as follows\n - clone_to_quote\n - history\n - delivery_note\n - mark_paid\n - download\n - archive\n - delete\n - convert\n - convert_to_invoice\n - email" operationId: actionQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Quote Hashed ID' + description: "The Quote Hashed ID" required: true schema: type: string format: string example: D2J234DFA - - - name: action + - name: action in: path - description: 'The action string to be performed' + description: "The action string to be performed" required: true schema: type: string @@ -8155,48 +7576,44 @@ paths: example: clone_to_quote responses: 200: - description: 'Returns the Quote object' + description: "Returns the Quote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/quote/{invitation_key}/download': + $ref: "#/components/schemas/Error" + "/api/v1/quote/{invitation_key}/download": get: tags: - quotes - summary: 'Download a specific quote by invitation key' - description: 'Downloads a specific quote' + summary: "Download a specific quote by invitation key" + description: "Downloads a specific quote" operationId: downloadQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: invitation_key + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: invitation_key in: path - description: 'The Quote Invitation Key' + description: "The Quote Invitation Key" required: true schema: type: string @@ -8204,44 +7621,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the quote pdf' + description: "Returns the quote pdf" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/quotes/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/quotes/{id}/upload": put: tags: - quotes - summary: 'Uploads a document to a quote' - description: 'Handles the uploading of a document to a quote' + summary: "Uploads a document to a quote" + description: "Handles the uploading of a document to a quote" operationId: uploadQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Quote Hashed ID' + description: "The Quote Hashed ID" required: true schema: type: string @@ -8249,129 +7662,118 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Quote object' + description: "Returns the Quote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_expenses: get: tags: - recurring_expenses - summary: 'Gets a list of recurring_expenses' + summary: "Gets a list of recurring_expenses" description: "Lists recurring_expenses, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the recurring_expenses, these are handled by the RecurringExpenseFilters class which defines the methods available" operationId: getRecurringExpenses parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of recurring_expenses' + description: "A list of recurring_expenses" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringExpense' + $ref: "#/components/schemas/RecurringExpense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - recurring_expenses - summary: 'Adds a client' - description: 'Adds an client to a company' + summary: "Adds a client" + description: "Adds an client to a company" operationId: storeRecurringExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved client object' + description: "Returns the saved client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringExpense' + $ref: "#/components/schemas/RecurringExpense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_expenses/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_expenses/{id}": get: tags: - recurring_expenses - summary: 'Shows a client' - description: 'Displays a client by id' + summary: "Shows a client" + description: "Displays a client by id" operationId: showRecurringExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringExpense Hashed ID' + description: "The RecurringExpense Hashed ID" required: true schema: type: string @@ -8379,47 +7781,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the recurring_expense object' + description: "Returns the recurring_expense object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringExpense' + $ref: "#/components/schemas/RecurringExpense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - recurring_expenses - summary: 'Updates a client' - description: 'Handles the updating of a client by id' + summary: "Updates a client" + description: "Handles the updating of a client by id" operationId: updateRecurringExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringExpense Hashed ID' + description: "The RecurringExpense Hashed ID" required: true schema: type: string @@ -8427,47 +7825,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringExpense' + $ref: "#/components/schemas/RecurringExpense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - recurring_expenses - summary: 'Deletes a client' - description: 'Handles the deletion of a client by id' + summary: "Deletes a client" + description: "Handles the deletion of a client by id" operationId: deleteRecurringExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringExpense Hashed ID' + description: "The RecurringExpense Hashed ID" required: true schema: type: string @@ -8475,44 +7869,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_expenses/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_expenses/{id}/edit": get: tags: - recurring_expenses - summary: 'Shows a client for editting' - description: 'Displays a client by id' + summary: "Shows a client for editting" + description: "Displays a client by id" operationId: editRecurringExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringExpense Hashed ID' + description: "The RecurringExpense Hashed ID" required: true schema: type: string @@ -8520,139 +7910,129 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringExpense' + $ref: "#/components/schemas/RecurringExpense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_expenses/create: get: tags: - recurring_expenses - summary: 'Gets a new blank client object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank client object" + description: "Returns a blank object with default values" operationId: getRecurringExpensesCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank client object' + description: "A blank client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringExpense' + $ref: "#/components/schemas/RecurringExpense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_expenses/bulk: post: tags: - recurring_expenses - summary: 'Performs bulk actions on an array of recurring_expenses' - description: '' + summary: "Performs bulk actions on an array of recurring_expenses" + description: "" operationId: bulkRecurringExpenses parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The RecurringExpense User response' + description: "The RecurringExpense User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringExpense' + $ref: "#/components/schemas/RecurringExpense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_expenses/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_expenses/{id}/upload": put: tags: - recurring_expense - summary: 'Uploads a document to a recurring_expense' - description: 'Handles the uploading of a document to a recurring_expense' + summary: "Uploads a document to a recurring_expense" + description: "Handles the uploading of a document to a recurring_expense" operationId: uploadRecurringExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringExpense Hashed ID' + description: "The RecurringExpense Hashed ID" required: true schema: type: string @@ -8660,167 +8040,154 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the RecurringExpense object' + description: "Returns the RecurringExpense object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringExpense' + $ref: "#/components/schemas/RecurringExpense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_invoices: get: tags: - recurring_invoices - summary: 'Gets a list of recurring_invoices' + summary: "Gets a list of recurring_invoices" description: "Lists recurring_invoices, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the recurring_invoices, these are handled by the RecurringInvoiceFilters class which defines the methods available" operationId: getRecurringInvoices parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of recurring_invoices' + description: "A list of recurring_invoices" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - recurring_invoices - summary: 'Adds a RecurringInvoice' - description: 'Adds an RecurringInvoice to the system' + summary: "Adds a RecurringInvoice" + description: "Adds an RecurringInvoice to the system" operationId: storeRecurringInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved RecurringInvoice object' + description: "Returns the saved RecurringInvoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_invoices/create: get: tags: - recurring_invoices - summary: 'Gets a new blank RecurringInvoice object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank RecurringInvoice object" + description: "Returns a blank object with default values" operationId: getRecurringInvoicesCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank RecurringInvoice object' + description: "A blank RecurringInvoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_invoices/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_invoices/{id}": get: tags: - recurring_invoices - summary: 'Shows an RecurringInvoice' - description: 'Displays an RecurringInvoice by id' + summary: "Shows an RecurringInvoice" + description: "Displays an RecurringInvoice by id" operationId: showRecurringInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringInvoice Hashed ID' + description: "The RecurringInvoice Hashed ID" required: true schema: type: string @@ -8828,47 +8195,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the RecurringInvoice object' + description: "Returns the RecurringInvoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - recurring_invoices - summary: 'Updates an RecurringInvoice' - description: 'Handles the updating of an RecurringInvoice by id' + summary: "Updates an RecurringInvoice" + description: "Handles the updating of an RecurringInvoice by id" operationId: updateRecurringInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringInvoice Hashed ID' + description: "The RecurringInvoice Hashed ID" required: true schema: type: string @@ -8876,47 +8239,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the RecurringInvoice object' + description: "Returns the RecurringInvoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - recurring_invoices - summary: 'Deletes a RecurringInvoice' - description: 'Handles the deletion of an RecurringInvoice by id' + summary: "Deletes a RecurringInvoice" + description: "Handles the deletion of an RecurringInvoice by id" operationId: deleteRecurringInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringInvoice Hashed ID' + description: "The RecurringInvoice Hashed ID" required: true schema: type: string @@ -8924,44 +8283,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_invoices/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_invoices/{id}/edit": get: tags: - recurring_invoices - summary: 'Shows an RecurringInvoice for editting' - description: 'Displays an RecurringInvoice by id' + summary: "Shows an RecurringInvoice for editting" + description: "Displays an RecurringInvoice by id" operationId: editRecurringInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringInvoice Hashed ID' + description: "The RecurringInvoice Hashed ID" required: true schema: type: string @@ -8969,48 +8324,44 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the RecurringInvoice object' + description: "Returns the RecurringInvoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_invoice/{invitation_key}/download': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_invoice/{invitation_key}/download": get: tags: - invoices - summary: 'Download a specific invoice by invitation key' - description: 'Downloads a specific invoice' + summary: "Download a specific invoice by invitation key" + description: "Downloads a specific invoice" operationId: downloadRecurringInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: invitation_key + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: invitation_key in: path - description: 'The Recurring Invoice Invitation Key' + description: "The Recurring Invoice Invitation Key" required: true schema: type: string @@ -9018,104 +8369,96 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the recurring invoice pdf' + description: "Returns the recurring invoice pdf" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_invoices/bulk: post: tags: - recurring_invoices - summary: 'Performs bulk actions on an array of recurring_invoices' - description: '' + summary: "Performs bulk actions on an array of recurring_invoices" + description: "" operationId: bulkRecurringInvoices parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Hashed IDs' + description: "Hashed IDs" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The RecurringInvoice response' + description: "The RecurringInvoice response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_invoices/{id}/{action}': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_invoices/{id}/{action}": get: tags: - recurring_invoices - summary: 'Performs a custom action on an RecurringInvoice' + summary: "Performs a custom action on an RecurringInvoice" description: "Performs a custom action on an RecurringInvoice.\n\n The current range of actions are as follows\n - clone_to_RecurringInvoice\n - clone_to_quote\n - history\n - delivery_note\n - mark_paid\n - download\n - archive\n - delete\n - email" operationId: actionRecurringInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringInvoice Hashed ID' + description: "The RecurringInvoice Hashed ID" required: true schema: type: string format: string example: D2J234DFA - - - name: action + - name: action in: path - description: 'The action string to be performed' + description: "The action string to be performed" required: true schema: type: string @@ -9123,48 +8466,44 @@ paths: example: clone_to_quote responses: 200: - description: 'Returns the RecurringInvoice object' + description: "Returns the RecurringInvoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_invoices/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_invoices/{id}/upload": put: tags: - recurring_invoices - summary: 'Uploads a document to a recurring_invoice' - description: 'Handles the uploading of a document to a recurring_invoice' + summary: "Uploads a document to a recurring_invoice" + description: "Handles the uploading of a document to a recurring_invoice" operationId: uploadRecurringInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringInvoice Hashed ID' + description: "The RecurringInvoice Hashed ID" required: true schema: type: string @@ -9172,167 +8511,154 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the RecurringInvoice object' + description: "Returns the RecurringInvoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_quotes: get: tags: - recurring_quotes - summary: 'Gets a list of recurring_quotes' + summary: "Gets a list of recurring_quotes" description: "Lists recurring_quotes, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the recurring_quotes, these are handled by the RecurringQuoteFilters class which defines the methods available" operationId: getRecurringQuotes parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of recurring_quotes' + description: "A list of recurring_quotes" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringQuote' + $ref: "#/components/schemas/RecurringQuote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - recurring_quotes - summary: 'Adds a RecurringQuote' - description: 'Adds an RecurringQuote to the system' + summary: "Adds a RecurringQuote" + description: "Adds an RecurringQuote to the system" operationId: storeRecurringQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved RecurringQuote object' + description: "Returns the saved RecurringQuote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringQuote' + $ref: "#/components/schemas/RecurringQuote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_quotes/create: get: tags: - recurring_quotes - summary: 'Gets a new blank RecurringQuote object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank RecurringQuote object" + description: "Returns a blank object with default values" operationId: getRecurringQuotesCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank RecurringQuote object' + description: "A blank RecurringQuote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringQuote' + $ref: "#/components/schemas/RecurringQuote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_quotes/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_quotes/{id}": get: tags: - recurring_quotes - summary: 'Shows an RecurringQuote' - description: 'Displays an RecurringQuote by id' + summary: "Shows an RecurringQuote" + description: "Displays an RecurringQuote by id" operationId: showRecurringQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringQuote Hashed ID' + description: "The RecurringQuote Hashed ID" required: true schema: type: string @@ -9340,47 +8666,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the RecurringQuote object' + description: "Returns the RecurringQuote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringQuote' + $ref: "#/components/schemas/RecurringQuote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - recurring_quotes - summary: 'Updates an RecurringQuote' - description: 'Handles the updating of an RecurringQuote by id' + summary: "Updates an RecurringQuote" + description: "Handles the updating of an RecurringQuote by id" operationId: updateRecurringQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringQuote Hashed ID' + description: "The RecurringQuote Hashed ID" required: true schema: type: string @@ -9388,47 +8710,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the RecurringQuote object' + description: "Returns the RecurringQuote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringQuote' + $ref: "#/components/schemas/RecurringQuote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - recurring_quotes - summary: 'Deletes a RecurringQuote' - description: 'Handles the deletion of an RecurringQuote by id' + summary: "Deletes a RecurringQuote" + description: "Handles the deletion of an RecurringQuote by id" operationId: deleteRecurringQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringQuote Hashed ID' + description: "The RecurringQuote Hashed ID" required: true schema: type: string @@ -9436,44 +8754,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_quotes/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_quotes/{id}/edit": get: tags: - recurring_quotes - summary: 'Shows an RecurringQuote for editting' - description: 'Displays an RecurringQuote by id' + summary: "Shows an RecurringQuote for editting" + description: "Displays an RecurringQuote by id" operationId: editRecurringQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringQuote Hashed ID' + description: "The RecurringQuote Hashed ID" required: true schema: type: string @@ -9481,108 +8795,100 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the RecurringQuote object' + description: "Returns the RecurringQuote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringQuote' + $ref: "#/components/schemas/RecurringQuote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_quotes/bulk: post: tags: - recurring_quotes - summary: 'Performs bulk actions on an array of recurring_quotes' - description: '' + summary: "Performs bulk actions on an array of recurring_quotes" + description: "" operationId: bulkRecurringQuotes parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Hashed ids' + description: "Hashed ids" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The RecurringQuote response' + description: "The RecurringQuote response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringQuote' + $ref: "#/components/schemas/RecurringQuote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_quotes/{id}/{action}': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_quotes/{id}/{action}": get: tags: - recurring_quotes - summary: 'Performs a custom action on an RecurringQuote' + summary: "Performs a custom action on an RecurringQuote" description: "Performs a custom action on an RecurringQuote.\n\n The current range of actions are as follows\n - clone_to_RecurringQuote\n - clone_to_quote\n - history\n - delivery_note\n - mark_paid\n - download\n - archive\n - delete\n - email" operationId: actionRecurringQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringQuote Hashed ID' + description: "The RecurringQuote Hashed ID" required: true schema: type: string format: string example: D2J234DFA - - - name: action + - name: action in: path - description: 'The action string to be performed' + description: "The action string to be performed" required: true schema: type: string @@ -9590,804 +8896,769 @@ paths: example: clone_to_quote responses: 200: - description: 'Returns the RecurringQuote object' + description: "Returns the RecurringQuote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringQuote' + $ref: "#/components/schemas/RecurringQuote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/contacts: post: tags: - reports - summary: 'Contact reports' - description: 'Export contact reports' + summary: "Contact reports" + description: "Export contact reports" operationId: getContactReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/clients: post: tags: - reports - summary: 'Client reports' - description: 'Export client reports' + summary: "Client reports" + description: "Export client reports" operationId: getClientReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/credit: post: tags: - reports - summary: 'Credit reports' - description: 'Export credit reports' + summary: "Credit reports" + description: "Export credit reports" operationId: getCreditReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/documents: post: tags: - reports - summary: 'Document reports' - description: 'Export document reports' + summary: "Document reports" + description: "Export document reports" operationId: getDocumentReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/expense: post: tags: - reports - summary: 'Expense reports' - description: 'Export expense reports' + summary: "Expense reports" + description: "Export expense reports" operationId: getExpenseReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/invoice_items: post: tags: - reports - summary: 'Invoice item reports' - description: 'Export invoice item reports' + summary: "Invoice item reports" + description: "Export invoice item reports" operationId: getInvoiceItemReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/invoices: post: tags: - reports - summary: 'Invoice reports' - description: 'Export invoice reports' + summary: "Invoice reports" + description: "Export invoice reports" operationId: getInvoiceReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/payments: post: tags: - reports - summary: 'Payment reports' - description: 'Export payment reports' + summary: "Payment reports" + description: "Export payment reports" operationId: getPaymentReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/products: post: tags: - reports - summary: 'Product reports' - description: 'Export product reports' + summary: "Product reports" + description: "Export product reports" operationId: getProductReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/product_sales: post: tags: - reports - summary: 'Product Salesreports' - description: 'Export product sales reports' + summary: "Product Salesreports" + description: "Export product sales reports" operationId: getProductSalesReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/profitloss: post: tags: - reports - summary: 'Profit loss reports' - description: 'Profit loss report' + summary: "Profit loss reports" + description: "Profit loss report" operationId: getProfitLossReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/quote_items: post: tags: - reports - summary: 'Quote item reports' - description: 'Export Quote item reports' + summary: "Quote item reports" + description: "Export Quote item reports" operationId: getQuoteItemReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/quotes: post: tags: - reports - summary: 'Quote reports' - description: 'Export quote reports' + summary: "Quote reports" + description: "Export quote reports" operationId: getQuoteReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/recurring_invoices: post: tags: - reports - summary: 'Recurring Invoice reports' - description: 'Export recurring invoice reports' + summary: "Recurring Invoice reports" + description: "Export recurring invoice reports" operationId: getRecurringInvoiceReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/tasks: post: tags: - reports - summary: 'Task reports' - description: 'Export task reports' + summary: "Task reports" + description: "Export task reports" operationId: getTaskReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/self-update: post: tags: - update - summary: 'Performs a system update' - description: 'Performs a system update' + summary: "Performs a system update" + description: "Performs a system update" operationId: selfUpdate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-API-PASSWORD' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-API-PASSWORD" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Success/failure response' + description: "Success/failure response" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/statics: get: tags: - statics - summary: 'Gets a list of statics' - description: 'Lists all statics' + summary: "Gets a list of statics" + description: "Lists all statics" operationId: getStatics parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of static data' + description: "A list of static data" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/subscriptions: get: tags: - subscriptions - summary: 'Gets a list of subscriptions' - description: 'Lists subscriptions.' + summary: "Gets a list of subscriptions" + description: "Lists subscriptions." operationId: getSubscriptions parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of subscriptions' + description: "A list of subscriptions" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/Subscription" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - subscriptions - summary: 'Adds a subscriptions' - description: 'Adds an subscriptions to the system' + summary: "Adds a subscriptions" + description: "Adds an subscriptions to the system" operationId: storeSubscription parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved subscriptions object' + description: "Returns the saved subscriptions object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/Subscription" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/subscriptions/create: get: tags: - subscriptions - summary: 'Gets a new blank subscriptions object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank subscriptions object" + description: "Returns a blank object with default values" operationId: getSubscriptionsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank subscriptions object' + description: "A blank subscriptions object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/Subscription" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/subscriptions/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/subscriptions/{id}": get: tags: - subscriptions - summary: 'Shows an subscriptions' - description: 'Displays an subscriptions by id' + summary: "Shows an subscriptions" + description: "Displays an subscriptions by id" operationId: showSubscription parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Subscription Hashed ID' + description: "The Subscription Hashed ID" required: true schema: type: string @@ -10395,47 +9666,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Subscription object' + description: "Returns the Subscription object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/Subscription" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - subscriptions - summary: 'Updates an subscriptions' - description: 'Handles the updating of an subscriptions by id' + summary: "Updates an subscriptions" + description: "Handles the updating of an subscriptions by id" operationId: updateSubscription parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Subscription Hashed ID' + description: "The Subscription Hashed ID" required: true schema: type: string @@ -10443,47 +9710,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the subscriptions object' + description: "Returns the subscriptions object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/Subscription" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - subscriptions - summary: 'Deletes a subscriptions' - description: 'Handles the deletion of an subscriptions by id' + summary: "Deletes a subscriptions" + description: "Handles the deletion of an subscriptions by id" operationId: deleteSubscription parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Subscription Hashed ID' + description: "The Subscription Hashed ID" required: true schema: type: string @@ -10491,44 +9754,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/subscriptions/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/subscriptions/{id}/edit": get: tags: - subscriptions - summary: 'Shows an subscriptions for editting' - description: 'Displays an subscriptions by id' + summary: "Shows an subscriptions for editting" + description: "Displays an subscriptions by id" operationId: editSubscription parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Subscription Hashed ID' + description: "The Subscription Hashed ID" required: true schema: type: string @@ -10536,102 +9795,97 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the invoice object' + description: "Returns the invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/Subscription" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/subscriptions/bulk: post: tags: - subscriptions - summary: 'Performs bulk actions on an array of subscriptions' - description: '' + summary: "Performs bulk actions on an array of subscriptions" + description: "" operationId: bulkSubscriptions parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Subscription response' + description: "The Subscription response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/Subscription" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/support/messages/send: post: tags: - support - summary: 'Sends a support message to Invoice Ninja team' - description: 'Allows a user to send a support message to the Invoice Ninja Team' + summary: "Sends a support message to Invoice Ninja team" + description: "Allows a user to send a support message to the Invoice Ninja Team" operationId: supportMessage parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" requestBody: - description: 'The message' + description: "The message" required: true content: application/json: schema: properties: message: - description: 'The support message' + description: "The support message" type: string type: string responses: @@ -10639,83 +9893,76 @@ paths: description: Success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: type: array items: - description: 'Server response' + description: "Server response" type: string example: true default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/system_logs: get: tags: - system_logs - summary: 'Gets a list of system logs' + summary: "Gets a list of system logs" description: "Lists system logs, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the system logs, these are handled by the SystemLogFilters class which defines the methods available" operationId: getSystemLogs parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of system logs' + description: "A list of system logs" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/SystemLog' + $ref: "#/components/schemas/SystemLog" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/system_logs/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/system_logs/{id}": get: tags: - system_logs - summary: 'Shows a system_logs' - description: 'Displays a system_logs by id' + summary: "Shows a system_logs" + description: "Displays a system_logs by id" operationId: showSystemLogs parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The system_logs Hashed ID' + description: "The system_logs Hashed ID" required: true schema: type: string @@ -10723,129 +9970,118 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the system_logs object' + description: "Returns the system_logs object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/SystemLog' + $ref: "#/components/schemas/SystemLog" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tasks: get: tags: - tasks - summary: 'Gets a list of tasks' + summary: "Gets a list of tasks" description: "Lists tasks, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the tasks, these are handled by the TaskFilters class which defines the methods available" operationId: getTasks parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of tasks' + description: "A list of tasks" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - tasks - summary: 'Adds a client' - description: 'Adds an client to a company' + summary: "Adds a client" + description: "Adds an client to a company" operationId: storeTask parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved client object' + description: "Returns the saved client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/tasks/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/tasks/{id}": get: tags: - tasks - summary: 'Shows a client' - description: 'Displays a client by id' + summary: "Shows a client" + description: "Displays a client by id" operationId: showTask parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Task Hashed ID' + description: "The Task Hashed ID" required: true schema: type: string @@ -10853,47 +10089,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the task object' + description: "Returns the task object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - tasks - summary: 'Updates a client' - description: 'Handles the updating of a client by id' + summary: "Updates a client" + description: "Handles the updating of a client by id" operationId: updateTask parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Task Hashed ID' + description: "The Task Hashed ID" required: true schema: type: string @@ -10901,47 +10133,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - tasks - summary: 'Deletes a client' - description: 'Handles the deletion of a client by id' + summary: "Deletes a client" + description: "Handles the deletion of a client by id" operationId: deleteTask parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Task Hashed ID' + description: "The Task Hashed ID" required: true schema: type: string @@ -10949,44 +10177,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/tasks/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/tasks/{id}/edit": get: tags: - tasks - summary: 'Shows a client for editting' - description: 'Displays a client by id' + summary: "Shows a client for editting" + description: "Displays a client by id" operationId: editTask parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Task Hashed ID' + description: "The Task Hashed ID" required: true schema: type: string @@ -10994,139 +10218,129 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tasks/create: get: tags: - tasks - summary: 'Gets a new blank client object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank client object" + description: "Returns a blank object with default values" operationId: getTasksCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank client object' + description: "A blank client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tasks/bulk: post: tags: - tasks - summary: 'Performs bulk actions on an array of tasks' - description: '' + summary: "Performs bulk actions on an array of tasks" + description: "" operationId: bulkTasks parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Task User response' + description: "The Task User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/tasks/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/tasks/{id}/upload": put: tags: - tasks - summary: 'Uploads a document to a task' - description: 'Handles the uploading of a document to a task' + summary: "Uploads a document to a task" + description: "Handles the uploading of a document to a task" operationId: uploadTask parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Task Hashed ID' + description: "The Task Hashed ID" required: true schema: type: string @@ -11134,185 +10348,174 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Task object' + description: "Returns the Task object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tasks/stort: post: tags: - tasks - summary: 'Sort tasks on KanBan' - description: 'Sorts tasks after drag and drop on the KanBan.' + summary: "Sort tasks on KanBan" + description: "Sorts tasks after drag and drop on the KanBan." operationId: sortTasks parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns an Ok, 200 HTTP status' + description: "Returns an Ok, 200 HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/task_schedulers/: get: tags: - task_schedulers - summary: 'Task Scheduler Index' - description: 'Get all schedulers with associated jobs' + summary: "Task Scheduler Index" + description: "Get all schedulers with associated jobs" operationId: getTaskSchedulers parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - task_schedulers - summary: 'Create task scheduler with job ' + summary: "Create task scheduler with job " description: "Create task scheduler with a job (action(job) request should be sent via request also. Example: We want client report to be job which will be run\n * multiple times, we should send the same parameters in the request as we would send if we wanted to get report, see example" operationId: createTaskScheduler parameters: - - - $ref: '#/components/parameters/X-API-SECRET' - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-API-SECRET" + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/TaskSchedulerSchema' + $ref: "#/components/schemas/TaskSchedulerSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/invoices/task_schedulers: get: tags: - task_schedulers - summary: 'Gets a new blank scheduler object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank scheduler object" + description: "Returns a blank object with default values" operationId: getTaskScheduler parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank scheduler object' + description: "A blank scheduler object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskSchedulerSchema' + $ref: "#/components/schemas/TaskSchedulerSchema" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/task_schedulers/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/task_schedulers/{id}": get: tags: - task_schedulers - summary: 'Show given scheduler' - description: 'Get scheduler with associated job' + summary: "Show given scheduler" + description: "Get scheduler with associated job" operationId: showTaskScheduler parameters: - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The Scheduler Hashed ID' + description: "The Scheduler Hashed ID" required: true schema: type: string @@ -11323,32 +10526,29 @@ paths: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - task_schedulers - summary: 'Update task scheduler ' - description: 'Update task scheduler' + summary: "Update task scheduler " + description: "Update task scheduler" operationId: updateTaskScheduler parameters: - - - $ref: '#/components/parameters/X-API-SECRET' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-SECRET" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The Scheduler Hashed ID' + description: "The Scheduler Hashed ID" required: true schema: type: string @@ -11359,42 +10559,40 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TaskSchedulerSchema' + $ref: "#/components/schemas/TaskSchedulerSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - task_schedulers - summary: 'Destroy Task Scheduler' - description: 'Destroy task scheduler and its associated job' + summary: "Destroy Task Scheduler" + description: "Destroy task scheduler and its associated job" operationId: destroyTaskScheduler parameters: - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The Scheduler Hashed ID' + description: "The Scheduler Hashed ID" required: true schema: type: string @@ -11405,214 +10603,197 @@ paths: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/task_schedulers/bulk: post: tags: - task_schedulers - summary: 'Performs bulk actions on an array of task_schedulers' - description: '' + summary: "Performs bulk actions on an array of task_schedulers" + description: "" operationId: bulkTaskSchedulerActions parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'array of ids' + description: "array of ids" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The TaskSchedule response' + description: "The TaskSchedule response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskSchedulerSchema' + $ref: "#/components/schemas/TaskSchedulerSchema" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/task_statuses: get: tags: - task_status - summary: 'Gets a list of task statuses' - description: 'Lists task statuses' + summary: "Gets a list of task statuses" + description: "Lists task statuses" operationId: getTaskStatuses parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of task statuses' + description: "A list of task statuses" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskStatus' + $ref: "#/components/schemas/TaskStatus" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - task_status - summary: 'Adds a TaskStatus' - description: 'Adds a TaskStatusto the system' + summary: "Adds a TaskStatus" + description: "Adds a TaskStatusto the system" operationId: storeTaskStatus parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" requestBody: - description: 'The task_status request' + description: "The task_status request" required: true content: application/json: schema: - $ref: '#/components/schemas/TaskStatus' + $ref: "#/components/schemas/TaskStatus" responses: 200: - description: 'Returns the saved TaskStatus object' + description: "Returns the saved TaskStatus object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskStatus' + $ref: "#/components/schemas/TaskStatus" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/task_statuses/create: get: tags: - task_status - summary: 'Gets a new blank TaskStatus object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank TaskStatus object" + description: "Returns a blank object with default values" operationId: getTaskStatussCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank TaskStatus object' + description: "A blank TaskStatus object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskStatus' + $ref: "#/components/schemas/TaskStatus" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/task_statuses/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/task_statuses/{id}": get: tags: - task_status - summary: 'Shows a TaskStatus Term' - description: 'Displays an TaskStatusby id' + summary: "Shows a TaskStatus Term" + description: "Displays an TaskStatusby id" operationId: showTaskStatus parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The TaskStatusHashed ID' + description: "The TaskStatusHashed ID" required: true schema: type: string @@ -11620,47 +10801,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the TaskStatusobject' + description: "Returns the TaskStatusobject" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskStatus' + $ref: "#/components/schemas/TaskStatus" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - task_status - summary: 'Updates a TaskStatus Term' - description: 'Handles the updating of an TaskStatus Termby id' + summary: "Updates a TaskStatus Term" + description: "Handles the updating of an TaskStatus Termby id" operationId: updateTaskStatus parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The TaskStatusHashed ID' + description: "The TaskStatusHashed ID" required: true schema: type: string @@ -11668,47 +10845,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the TaskStatusobject' + description: "Returns the TaskStatusobject" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskStatus' + $ref: "#/components/schemas/TaskStatus" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - task_statuss - summary: 'Deletes a TaskStatus Term' - description: 'Handles the deletion of an TaskStatus by id' + summary: "Deletes a TaskStatus Term" + description: "Handles the deletion of an TaskStatus by id" operationId: deleteTaskStatus parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The TaskStatusHashed ID' + description: "The TaskStatusHashed ID" required: true schema: type: string @@ -11716,44 +10889,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/task_statuses/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/task_statuses/{id}/edit": get: tags: - task_status - summary: 'Shows an TaskStatusfor editting' - description: 'Displays an TaskStatusby id' + summary: "Shows an TaskStatusfor editting" + description: "Displays an TaskStatusby id" operationId: editTaskStatuss parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The TaskStatusHashed ID' + description: "The TaskStatusHashed ID" required: true schema: type: string @@ -11761,171 +10930,162 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the TaskStatus object' + description: "Returns the TaskStatus object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskStatus' + $ref: "#/components/schemas/TaskStatus" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/task_statuses/bulk: post: tags: - task_status - summary: 'Performs bulk actions on an array of task statuses' - description: '' + summary: "Performs bulk actions on an array of task statuses" + description: "" operationId: bulkTaskStatuss parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'TaskStatus Ter,s' + description: "TaskStatus Ter,s" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The TaskStatus Terms response' + description: "The TaskStatus Terms response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskStatus' + $ref: "#/components/schemas/TaskStatus" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tax_rates: get: tags: - tax_rates - summary: 'Gets a list of tax_rates' - description: 'Lists tax rates' + summary: "Gets a list of tax_rates" + description: "Lists tax rates" operationId: getTaxRates parameters: - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of tax_rates' + description: "A list of tax_rates" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaxRate' + $ref: "#/components/schemas/TaxRate" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tax_rates/create: get: tags: - tax_rates - summary: 'Gets a new blank Tax Rate object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank Tax Rate object" + description: "Returns a blank object with default values" operationId: getTaxRateCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'A blank Tax Rate object' + description: "A blank Tax Rate object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaxRate' + $ref: "#/components/schemas/TaxRate" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/tax_rates/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/tax_rates/{id}": get: tags: - tax_rates - summary: 'Shows a Tax Rate' - description: 'Displays an TaxRate by id' + summary: "Shows a Tax Rate" + description: "Displays an TaxRate by id" operationId: showTaxRate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The TaxRate Hashed ID' + description: "The TaxRate Hashed ID" required: true schema: type: string @@ -11933,45 +11093,42 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Tax Rate object' + description: "Returns the Tax Rate object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaxRate' + $ref: "#/components/schemas/TaxRate" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - tax_rates - summary: 'Updates a tax rate' - description: 'Handles the updating of a tax rate by id' + summary: "Updates a tax rate" + description: "Handles the updating of a tax rate by id" operationId: updateTaxRate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The TaxRate Hashed ID' + description: "The TaxRate Hashed ID" required: true schema: type: string @@ -11979,45 +11136,42 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the TaxRate object' + description: "Returns the TaxRate object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaxRate' + $ref: "#/components/schemas/TaxRate" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - tax_rates - summary: 'Deletes a TaxRate' - description: 'Handles the deletion of an TaxRate by id' + summary: "Deletes a TaxRate" + description: "Handles the deletion of an TaxRate by id" operationId: deleteTaxRate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The TaxRate Hashed ID' + description: "The TaxRate Hashed ID" required: true schema: type: string @@ -12025,42 +11179,39 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/tax_rates/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/tax_rates/{id}/edit": get: tags: - tax_rates - summary: 'Shows a Tax Rate for editting' - description: 'Displays a Tax Rate by id' + summary: "Shows a Tax Rate for editting" + description: "Displays a Tax Rate by id" operationId: editTaxRate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The TaxRate Hashed ID' + description: "The TaxRate Hashed ID" required: true schema: type: string @@ -12068,230 +11219,215 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Tax Rate object' + description: "Returns the Tax Rate object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaxRate' + $ref: "#/components/schemas/TaxRate" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tax_rates/bulk: post: tags: - tax_rates - summary: 'Performs bulk actions on an array of TaxRates' - description: '' + summary: "Performs bulk actions on an array of TaxRates" + description: "" operationId: bulkTaxRates parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Tax Rates' + description: "Tax Rates" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The TaxRate List response' + description: "The TaxRate List response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/templates: post: tags: - templates - summary: 'Returns a entity template with the template variables replaced with the Entities' - description: 'Returns a entity template with the template variables replaced with the Entities' + summary: "Returns a entity template with the template variables replaced with the Entities" + description: "Returns a entity template with the template variables replaced with the Entities" operationId: getShowTemplate parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: - description: 'The template subject and body' + description: "The template subject and body" required: true content: application/json: schema: properties: subject: - description: 'The email template subject' + description: "The email template subject" type: string body: - description: 'The email template body' + description: "The email template body" type: string type: object responses: 200: - description: 'The template response' + description: "The template response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Template' + $ref: "#/components/schemas/Template" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tokens: get: tags: - tokens - summary: 'Gets a list of company tokens' + summary: "Gets a list of company tokens" description: "Lists company tokens.\n *\n * Query parameters can be added to performed more fine grained filtering of the tokens, these are handled by the TokenFilters class which defines the methods available" operationId: getTokens parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of tokens' + description: "A list of tokens" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyToken' + $ref: "#/components/schemas/CompanyToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - tokens - summary: 'Adds a token' - description: 'Adds an token to a company' + summary: "Adds a token" + description: "Adds an token to a company" operationId: storeToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved token object' + description: "Returns the saved token object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyToken' + $ref: "#/components/schemas/CompanyToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/tokens/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/tokens/{id}": get: tags: - tokens - summary: 'Shows a token' - description: 'Displays a token by id' + summary: "Shows a token" + description: "Displays a token by id" operationId: showToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Token Hashed ID' + description: "The Token Hashed ID" required: true schema: type: string @@ -12299,47 +11435,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the token object' + description: "Returns the token object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyToken' + $ref: "#/components/schemas/CompanyToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - tokens - summary: 'Updates a token' - description: 'Handles the updating of a token by id' + summary: "Updates a token" + description: "Handles the updating of a token by id" operationId: updateToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Token Hashed ID' + description: "The Token Hashed ID" required: true schema: type: string @@ -12347,47 +11479,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the token object' + description: "Returns the token object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyToken' + $ref: "#/components/schemas/CompanyToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - tokens - summary: 'Deletes a token' - description: 'Handles the deletion of a token by id' + summary: "Deletes a token" + description: "Handles the deletion of a token by id" operationId: deleteToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Token Hashed ID' + description: "The Token Hashed ID" required: true schema: type: string @@ -12395,44 +11523,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/tokens/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/tokens/{id}/edit": get: tags: - tokens - summary: 'Shows a token for editting' - description: 'Displays a token by id' + summary: "Shows a token for editting" + description: "Displays a token by id" operationId: editToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Token Hashed ID' + description: "The Token Hashed ID" required: true schema: type: string @@ -12440,258 +11564,239 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the token object' + description: "Returns the token object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyToken' + $ref: "#/components/schemas/CompanyToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tokens/create: get: tags: - tokens - summary: 'Gets a new blank token object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank token object" + description: "Returns a blank object with default values" operationId: getTokensCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank token object' + description: "A blank token object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyToken' + $ref: "#/components/schemas/CompanyToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tokens/bulk: post: tags: - tokens - summary: 'Performs bulk actions on an array of tokens' - description: '' + summary: "Performs bulk actions on an array of tokens" + description: "" operationId: bulkTokens parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Token ids' + description: "Token ids" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Token response' + description: "The Token response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyToken' + $ref: "#/components/schemas/CompanyToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/users: get: tags: - users - summary: 'Gets a list of users' + summary: "Gets a list of users" description: "Lists users, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the users, these are handled by the UserFilters class which defines the methods available" operationId: getUsers parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of users' + description: "A list of users" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - users - summary: 'Adds a User' - description: 'Adds an User to the system' + summary: "Adds a User" + description: "Adds an User to the system" operationId: storeUser parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved User object' + description: "Returns the saved User object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/users/create: get: tags: - users - summary: 'Gets a new blank User object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank User object" + description: "Returns a blank object with default values" operationId: getUsersCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank User object' + description: "A blank User object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/users/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/users/{id}": get: tags: - users - summary: 'Shows an User' - description: 'Displays an User by id' + summary: "Shows an User" + description: "Displays an User by id" operationId: showUser parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The User Hashed ID' + description: "The User Hashed ID" required: true schema: type: string @@ -12699,47 +11804,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the User object' + description: "Returns the User object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - users - summary: 'Updates an User' - description: 'Handles the updating of an User by id' + summary: "Updates an User" + description: "Handles the updating of an User by id" operationId: updateUser parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The User Hashed ID' + description: "The User Hashed ID" required: true schema: type: string @@ -12747,56 +11848,51 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the User object' + description: "Returns the User object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - users - summary: 'Deletes a User' - description: 'Handles the deletion of an User by id' + summary: "Deletes a User" + description: "Handles the deletion of an User by id" operationId: deleteUser parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: token_name + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: token_name in: query - description: 'Customized name for the Users API Token' + description: "Customized name for the Users API Token" required: false schema: type: string format: string - example: 'iOS Device 11 iPad' - - - name: id + example: "iOS Device 11 iPad" + - name: id in: path - description: 'The User Hashed ID' + description: "The User Hashed ID" required: true schema: type: string @@ -12804,44 +11900,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/users/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/users/{id}/edit": get: tags: - users - summary: 'Shows an User for editting' - description: 'Displays an User by id' + summary: "Shows an User for editting" + description: "Displays an User by id" operationId: editUser parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The User Hashed ID' + description: "The User Hashed ID" required: true schema: type: string @@ -12849,99 +11941,92 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the User object' + description: "Returns the User object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/users/bulk: post: tags: - users - summary: 'Performs bulk actions on an array of users' - description: '' + summary: "Performs bulk actions on an array of users" + description: "" operationId: bulkUsers parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Hashed ids' + description: "Hashed ids" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The User response' + description: "The User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/users/{user}/detach_from_company': + $ref: "#/components/schemas/Error" + "/api/v1/users/{user}/detach_from_company": delete: tags: - users - summary: 'Detach an existing user to a company' - description: 'Detach an existing user from a company' + summary: "Detach an existing user to a company" + description: "Detach an existing user from a company" operationId: detachUser parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: user + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: user in: path - description: 'The user hashed_id' + description: "The user hashed_id" required: true schema: type: string @@ -12949,44 +12034,40 @@ paths: example: FD767dfd7 responses: 200: - description: 'Success response' + description: "Success response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/users/{user}/invite': + $ref: "#/components/schemas/Error" + "/api/v1/users/{user}/invite": post: tags: - users - summary: 'Reconfirm an existing user to a company' - description: 'Reconfirm an existing user from a company' + summary: "Reconfirm an existing user to a company" + description: "Reconfirm an existing user from a company" operationId: inviteUser parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: user + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: user in: path - description: 'The user hashed_id' + description: "The user hashed_id" required: true schema: type: string @@ -12994,44 +12075,40 @@ paths: example: FD767dfd7 responses: 200: - description: 'Success response' + description: "Success response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/users/{user}/reconfirm': + $ref: "#/components/schemas/Error" + "/api/v1/users/{user}/reconfirm": post: tags: - users - summary: 'Reconfirm an existing user to a company' - description: 'Reconfirm an existing user from a company' + summary: "Reconfirm an existing user to a company" + description: "Reconfirm an existing user from a company" operationId: inviteUserReconfirm parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: user + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: user in: path - description: 'The user hashed_id' + description: "The user hashed_id" required: true schema: type: string @@ -13039,125 +12116,114 @@ paths: example: FD767dfd7 responses: 200: - description: 'Success response' + description: "Success response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/vendors: get: tags: - vendors - summary: 'Gets a list of vendors' + summary: "Gets a list of vendors" description: "Lists vendors, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the vendors, these are handled by the VendorFilters class which defines the methods available" operationId: getVendors parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of vendors' + description: "A list of vendors" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - vendors - summary: 'Adds a client' - description: 'Adds an client to a company' + summary: "Adds a client" + description: "Adds an client to a company" operationId: storeVendor parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved client object' + description: "Returns the saved client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/vendors/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/vendors/{id}": get: tags: - vendors - summary: 'Shows a client' - description: 'Displays a client by id' + summary: "Shows a client" + description: "Displays a client by id" operationId: showVendor parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Vendor Hashed ID' + description: "The Vendor Hashed ID" required: true schema: type: string @@ -13165,47 +12231,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the vendor object' + description: "Returns the vendor object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - vendors - summary: 'Updates a client' - description: 'Handles the updating of a client by id' + summary: "Updates a client" + description: "Handles the updating of a client by id" operationId: updateVendor parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Vendor Hashed ID' + description: "The Vendor Hashed ID" required: true schema: type: string @@ -13213,47 +12275,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - vendors - summary: 'Deletes a client' - description: 'Handles the deletion of a client by id' + summary: "Deletes a client" + description: "Handles the deletion of a client by id" operationId: deleteVendor parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Vendor Hashed ID' + description: "The Vendor Hashed ID" required: true schema: type: string @@ -13261,44 +12319,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/vendors/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/vendors/{id}/edit": get: tags: - vendors - summary: 'Shows a client for editting' - description: 'Displays a client by id' + summary: "Shows a client for editting" + description: "Displays a client by id" operationId: editVendor parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Vendor Hashed ID' + description: "The Vendor Hashed ID" required: true schema: type: string @@ -13306,139 +12360,129 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/vendors/create: get: tags: - vendors - summary: 'Gets a new blank client object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank client object" + description: "Returns a blank object with default values" operationId: getVendorsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank client object' + description: "A blank client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/vendors/bulk: post: tags: - vendors - summary: 'Performs bulk actions on an array of vendors' - description: '' + summary: "Performs bulk actions on an array of vendors" + description: "" operationId: bulkVendors parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Vendor User response' + description: "The Vendor User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/vendors/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/vendors/{id}/upload": put: tags: - vendors - summary: 'Uploads a document to a vendor' - description: 'Handles the uploading of a document to a vendor' + summary: "Uploads a document to a vendor" + description: "Handles the uploading of a document to a vendor" operationId: uploadVendor parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Vendor Hashed ID' + description: "The Vendor Hashed ID" required: true schema: type: string @@ -13446,161 +12490,149 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Vendor object' + description: "Returns the Vendor object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/webcron: get: tags: - webcron - summary: 'Executes the task scheduler via a webcron service' - description: 'Executes the task scheduler via a webcron service' + summary: "Executes the task scheduler via a webcron service" + description: "Executes the task scheduler via a webcron service" operationId: webcron parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'Success response' + description: "Success response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/webhooks: get: tags: - webhooks - summary: 'Gets a list of Webhooks' + summary: "Gets a list of Webhooks" description: "Lists Webhooks, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the Webhooks, these are handled by the WebhookFilters class which defines the methods available" operationId: getWebhooks parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of Webhooks' + description: "A list of Webhooks" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - webhooks - summary: 'Adds a Webhook' - description: 'Adds an Webhook to a company' + summary: "Adds a Webhook" + description: "Adds an Webhook to a company" operationId: storeWebhook parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved Webhook object' + description: "Returns the saved Webhook object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/webhooks/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/webhooks/{id}": get: tags: - webhooks - summary: 'Shows a Webhook' - description: 'Displays a Webhook by id' + summary: "Shows a Webhook" + description: "Displays a Webhook by id" operationId: showWebhook parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Webhook Hashed ID' + description: "The Webhook Hashed ID" required: true schema: type: string @@ -13608,47 +12640,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Webhook object' + description: "Returns the Webhook object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - webhooks - summary: 'Updates a Webhook' - description: 'Handles the updating of a Webhook by id' + summary: "Updates a Webhook" + description: "Handles the updating of a Webhook by id" operationId: updateWebhook parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Webhook Hashed ID' + description: "The Webhook Hashed ID" required: true schema: type: string @@ -13656,47 +12684,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Webhook object' + description: "Returns the Webhook object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - Webhooks - summary: 'Deletes a Webhook' - description: 'Handles the deletion of a Webhook by id' + summary: "Deletes a Webhook" + description: "Handles the deletion of a Webhook by id" operationId: deleteWebhook parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Webhook Hashed ID' + description: "The Webhook Hashed ID" required: true schema: type: string @@ -13704,44 +12728,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/webhooks/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/webhooks/{id}/edit": get: tags: - webhooks - summary: 'Shows a Webhook for editting' - description: 'Displays a Webhook by id' + summary: "Shows a Webhook for editting" + description: "Displays a Webhook by id" operationId: editWebhook parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Webhook Hashed ID' + description: "The Webhook Hashed ID" required: true schema: type: string @@ -13749,118 +12769,112 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Webhook object' + description: "Returns the Webhook object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/webhooks/create: get: tags: - webhooks - summary: 'Gets a new blank Webhook object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank Webhook object" + description: "Returns a blank object with default values" operationId: getWebhooksCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank Webhook object' + description: "A blank Webhook object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/webhooks/bulk: post: tags: - webhooks - summary: 'Performs bulk actions on an array of Webhooks' - description: '' + summary: "Performs bulk actions on an array of Webhooks" + description: "" operationId: bulkWebhooks parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Webhook User response' + description: "The Webhook User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' \ No newline at end of file + $ref: "#/components/schemas/Error" diff --git a/openapi/paths/clients.yaml b/openapi/paths/clients.yaml index 41f50989853f..261abd6dc9b7 100644 --- a/openapi/paths/clients.yaml +++ b/openapi/paths/clients.yaml @@ -7,72 +7,60 @@ Lists clients. Fine grained filtering is also available using query parameters. operationId: getClients parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' - - - $ref: '#/components/parameters/index' - - - name: name + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' + - $ref: '#/components/parameters/index' + - name: name in: query description: Filter by client name required: false schema: type: string example: bob - - - name: balance + - name: balance in: query description: Filter by client balance, format uses an operator and value separated by a colon. lt,lte, gt, gte, eq required: false schema: type: string example: lt:10 - - - name: between_balance + - name: between_balance in: query description: Filter between client balances, format uses two values separated by a colon required: false schema: type: string example: 10:100 - - - name: email + - name: email in: query description: Filter by client email required: false schema: type: string example: bob@gmail.com - - - name: id_number + - name: id_number in: query description: Filter by client id_number required: false schema: type: string example: a1039883 - - - name: number + - name: number in: query description: Filter by client number required: false schema: type: string example: a1039883 - - - name: filter + - name: filter in: query description: Filters clients on columns - name, id_number, contact.first_name contact.last_name, contact.email, custom_value1-4 required: false schema: type: string example: a1039883 - - - name: sort + - name: sort in: query description: Returns the list sorted by column in ascending or descending order. required: false @@ -101,36 +89,21 @@ schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' post: tags: - clients summary: 'Create client' - description: 'Adds an client to a company' + description: 'Adds a client to a company' operationId: storeClient parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' responses: 200: description: 'Returns the saved client object' @@ -152,23 +125,11 @@ schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' '/api/v1/clients/{id}': get: tags: @@ -177,74 +138,10 @@ description: 'Displays a client by id' operationId: showClient parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' - - - name: id - in: path - description: 'The Client Hashed ID' - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: 'Returns the cl.ient object' - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' - X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' - X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' - content: - application/json: - schema: - $ref: '#/components/schemas/Client' - 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' - 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' - 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' - default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - put: - tags: - - clients - summary: 'Update client' - description: 'Handles the updating of a client by id' - operationId: updateClient - parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' - - - name: id + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' + - name: id in: path description: 'The Client Hashed ID' required: true @@ -273,23 +170,55 @@ schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + $ref: '#/components/responses/default' + put: + tags: + - clients + summary: 'Update client' + description: 'Handles the updating of a client by id' + operationId: updateClient + parameters: + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' + - name: id + in: path + description: 'The Client Hashed ID' + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: 'Returns the client object' + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/schemas/Client' + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' + 422: + $ref: '#/components/responses/422' + default: + $ref: '#/components/responses/default' delete: tags: - clients @@ -297,14 +226,10 @@ description: 'Handles the deletion of a client by id' operationId: deleteClient parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' - - - name: id + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' + - name: id in: path description: 'The Client Hashed ID' required: true @@ -329,23 +254,11 @@ schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' '/api/v1/clients/{id}/edit': get: tags: @@ -354,14 +267,10 @@ description: 'Displays a client by id' operationId: editClient parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/include' + - name: id in: path description: 'The Client Hashed ID' required: true @@ -390,23 +299,11 @@ schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' /api/v1/clients/create: get: tags: @@ -415,12 +312,9 @@ description: 'Returns a blank object with default values' operationId: getClientsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' responses: 200: description: 'A blank client object' @@ -442,37 +336,22 @@ schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' /api/v1/clients/bulk: post: tags: - clients - summary: 'Bulk actions' - description: '' + summary: 'Bulk client actions' + description: 'Archive / Restore / Delete in bulk' operationId: bulkClients parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/index' requestBody: description: 'User credentials' required: true @@ -505,23 +384,11 @@ schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' '/api/v1/clients/{id}/upload': put: tags: @@ -530,14 +397,10 @@ description: 'Handles the uploading of a document to a client, please note due to a quirk in REST you will need to use a _method parameter with value of POST' operationId: uploadClient parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' - - - name: id + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' + - name: id in: path description: 'The Client Hashed ID' required: true @@ -581,23 +444,11 @@ schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' '/api/v1/clients/{id}/purge': post: tags: @@ -606,14 +457,10 @@ description: 'Handles purging a client' operationId: purgeClient parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' - - - name: id + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' + - name: id in: path description: 'The Client Hashed ID' required: true @@ -638,23 +485,11 @@ schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' '/api/v1/clients/{id}/{mergeable_client_hashed_id}/merge': post: tags: @@ -663,14 +498,10 @@ description: 'Handles merging 2 clients' operationId: mergeClient parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' - - - name: id + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' + - name: id in: path description: 'The Client Hashed ID' required: true @@ -678,8 +509,7 @@ type: string format: string example: D2J234DFA - - - name: mergeable_client_hashed_id + - name: mergeable_client_hashed_id in: path description: 'The Mergeable Client Hashed ID' required: true @@ -704,23 +534,11 @@ schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' /api/v1/client_statement: post: tags: @@ -729,12 +547,9 @@ description: 'Return a PDF of the client statement' operationId: clientStatement parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/include' requestBody: description: 'Statment Options' required: true @@ -773,26 +588,10 @@ schema: $ref: '#/components/schemas/Client' 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' \ No newline at end of file + $ref: '#/components/responses/default' \ No newline at end of file diff --git a/openapi/paths/products.yaml b/openapi/paths/products.yaml index a93b65a9a593..2cecf78a3a1d 100644 --- a/openapi/paths/products.yaml +++ b/openapi/paths/products.yaml @@ -2,139 +2,104 @@ get: tags: - products - summary: 'List products' - description: "Lists products, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the products, these are handled by the ProductFilters class which defines the methods available" + summary: "List products" + description: | + Lists products, search and filters allow fine grained lists to be generated. + Query parameters can be added to perform fine grained filtering of the products list, these are handled by the ProductFilters class + which defines the methods available operationId: getProducts parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of products' + description: "A list of products" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Product' + $ref: "#/components/schemas/Product" + 401: + description: "Authentication error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthenticationError" + 403: + description: "Authorization error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthorizationError" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - products - summary: 'Create Product' - description: 'Adds an Product to the system' + summary: "Create Product" + description: "Adds a product to a company" operationId: storeProduct parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved Product object' + description: "Returns the saved product object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Product' + $ref: "#/components/schemas/Product" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - /api/v1/products/create: + $ref: "#/components/schemas/Error" + "/api/v1/products/{id}": get: tags: - products - summary: 'Create product' - description: 'Returns a blank object with default values' - operationId: getProductsCreate - parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - responses: - 200: - description: 'A blank Product object' - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' - X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' - X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' - content: - application/json: - schema: - $ref: '#/components/schemas/Product' - 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' - default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - '/api/v1/products/{id}': - get: - tags: - - products - summary: 'Show product' - description: 'Displays an Product by id' + summary: "Show product" + description: "Displays a product by id" operationId: showProduct parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Product Hashed ID' + description: "The Product Hashed ID" required: true schema: type: string @@ -142,47 +107,55 @@ example: D2J234DFA responses: 200: - description: 'Returns the Product object' + description: "Returns the product object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Product' + $ref: "#/components/schemas/Product" + 401: + description: "Authentication error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthenticationError" + 403: + description: "Authorization error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthorizationError" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - products - summary: 'Update product' - description: 'Handles the updating of an Product by id' + summary: "Update product" + description: "Handles the updating of a product by id" operationId: updateProduct parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Product Hashed ID' + description: "The Product Hashed ID" required: true schema: type: string @@ -190,47 +163,55 @@ example: D2J234DFA responses: 200: - description: 'Returns the Product object' + description: "Returns the Product object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Product' + $ref: "#/components/schemas/Product" + 401: + description: "Authentication error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthenticationError" + 403: + description: "Authorization error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthorizationError" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - products - summary: 'Delete product' - description: 'Handles the deletion of an Product by id' + summary: "Delete product" + description: "Handles the deletion of a product by id" operationId: deleteProduct parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Product Hashed ID' + description: "The Product Hashed ID" required: true schema: type: string @@ -238,44 +219,52 @@ example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + description: "Authentication error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthenticationError" + 403: + description: "Authorization error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthorizationError" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/products/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/products/{id}/edit": get: tags: - products - summary: 'Edit product' - description: 'Displays an Product by id' + summary: "Edit product" + description: "Displays an Product by id" operationId: editProduct parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Product Hashed ID' + description: "The Product Hashed ID" required: true schema: type: string @@ -283,127 +272,221 @@ example: D2J234DFA responses: 200: - description: 'Returns the Product object' + description: "Returns the Product object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Product' + $ref: "#/components/schemas/Product" + 401: + description: "Authentication error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthenticationError" + 403: + description: "Authorization error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthorizationError" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" + "/api/v1/products/create": + get: + tags: + - products + summary: "Blank product" + description: "Returns a blank product object with default values" + operationId: getProductsCreate + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "A blank Product object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Product" + 401: + description: "Authentication error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthenticationError" + 403: + description: "Authorization error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthorizationError" + 422: + description: "Validation error" + content: + application/json: + schema: + $ref: "#/components/schemas/ValidationError" + default: + description: "Unexpected Error" + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + /api/v1/products/bulk: post: tags: - products - summary: 'Bulk product actions' - description: '' + summary: "Bulk product actions" + description: "Archive / Restore / Delete in bulk" operationId: bulkProducts parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Hashed IDs' + description: "Hashed IDs" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Product response' + description: "The Product response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Product' + $ref: "#/components/schemas/Product" + 401: + description: "Authentication error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthenticationError" + 403: + description: "Authorization error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthorizationError" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/products/{id}/upload': + $ref: "#/components/schemas/Error" + + "/api/v1/products/{id}/upload": put: tags: - products - summary: 'Add product document' - description: 'Handles the uploading of a document to a product' + summary: "Add product document" + description: "Handles the uploading of a document to a product" operationId: uploadProduct parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/client_include" + - name: id in: path - description: 'The Product Hashed ID' + description: "The Product Hashed ID" required: true schema: type: string format: string example: D2J234DFA - responses: + produces: + - application/json + requestBody: + required: true + content: + multipart/form-data: + schema: + type: object + properties: + _method: + type: string + example: POST + documents: + type: array + format: binary 200: - description: 'Returns the Product object' + description: "Returns the Product object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Product' + $ref: "#/components/schemas/Product" + 401: + description: "Authentication error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthenticationError" + 403: + description: "Authorization error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthorizationError" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' \ No newline at end of file + $ref: "#/components/schemas/Error"