openapi: 3.0.3 info: title: Feniks description: '' version: 1.0.0 servers: - url: api-apostle.com paths: /api/register: post: summary: Register description: 'Creates an User under a newly registered Team, Brand and then gets placed under the Apostle organization.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, OK' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"email\": \"rickmartens@home.nl\",\n \"first_name\": \"Rick\",\n \"last_name\": \"Martens\",\n \"created_at\": \"2021-01-29T09:56:13.000000Z\",\n \"id\": 201\n },\n {\n \"name\": \"testbrand\",\n \"updated_at\": \"2021-01-29T09:56:13.000000Z\",\n \"created_at\": \"2021-01-29T09:56:13.000000Z\",\n \"id\": 101\n },\n {\n \"name\": \"testTeam\",\n \"domain\": \"tts\",\n \"updated_at\": \"2021-01-29T09:56:13.000000Z\",\n \"created_at\": \"2021-01-29T09:56:13.000000Z\",\n \"id\": 123\n },\n {\n \"updated_at\": \"2021-01-29T09:56:13.000000Z\",\n \"created_at\": \"2021-01-29T09:56:13.000000Z\",\n \"id\": 9048\n }\n ]\n}\n\n}" 400: description: '400, Incorrect input' content: text/plain: schema: type: string example: 'The data that has been put in could not be validated.' tags: - Authentication requestBody: required: true content: application/json: schema: type: object properties: brand_name: type: string description: 'The new Brand the User and Team will get registered under.' example: velit team_name: type: string description: 'The new Team the User will get registered under.' example: error team_domain: type: string description: 'The team_domain that the newly made Team will have.' example: ut email: type: string description: 'The email the new User will use to log in with.' example: repudiandae first_name: type: string description: 'The first name of the newly created User.' example: soluta last_name: type: string description: 'The last name of the newly created User.' example: vitae password: type: string description: 'The password belonging to the newly created User. *' example: est required: - brand_name - team_name - email - first_name - last_name - password /api/login: post: summary: Login description: 'Logs the user in based on their email, password and team_domain. A membership_token and user_token are returned.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, OK' content: text/plain: schema: type: string example: "\"data\": {\n \"user_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxIiwianRpIjoiMzk5OTMyMmMzNTVmNjI0MzhkNzFkMGMzYjM1M2EwZmQ0NjE5M2RjYTJjNTgyNzkxNDllMmQ3NTUxZmU2NjlmNDEzYWQwNzVkZDUxOGI3YTEiLCJpYXQiOiIxNjExOTEzODk0Ljk2ODQwNCIsIm5iZiI6IjE2MTE5MTM4OTQuOTY4NDExIiwiZXhwIjoiMTY0MzQ0OTg5NC45MzU5OTQiLCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.MMzVlOrYgw7ITdRlgxwx7BwzCvjf5KDClc7IYH6DG7BlZ0rSYJtZ8yrt0wggnsvd8nsGjcFF4gvmglvDdoPzSneVGjQtEX2T8wXgl9A4R-PHTkggDHmETyuQdEQL1k3es7CHK_uL2cqO-k5NSDxFkAmqwEZ4NGNDK3ZR4P3LLqPR_QuCJe97QyDiQzy7Du5DdoiSUWExovnf45xbHgzPdSUE2U6wKMb0nfw83tm_g5lyU0NeEfbhhzkAKuF9kSJh-A9U68e9hep0GAm4jN1y_SmU41zc128iVxN-jrRzH8ElCFwWuTsuEZ-KvfIFHuKTNmN-AbAbTL8TxlhtNvOl8jwvlYu97PRiBOcSr1_c4AXwyETNDjxGbdzLlYrjL-KyXaAEpDXtXi6_OMiib1nlLzd0J2f6BvMJNbaGxfRITj8k21Bh24iCegjMmYDN0tZjZhUTnNfOxdlfbRLPfAbzBAz1L7iXyVyg43CnecWdU5a6iWjqXxzfT0tDa0OuB6MKmrw30nInvt216p5pv1aGsVWHYAPf3IDjVu7opQHm3vzAND1ED01NSQnsVVtkUVMZRfWxbKUHPWbPTeQzqxxdO1FYI6jmC9TI3R442nGn30fY4SCjakbrHa1TsEcISS34uiqxhQ3YIQDOMYUbdy-kXYFNYXvZiuyTE-1JYJIuQ7w\",\n \"membership_token\": \"eyJpdiI6IkhWSkhnTXc3cEtSdjVNeTUwUkFFcEE9PSIsInZhbHVlIjoiTXVmME1VNW1NczJDQldYYU9IN3VKUT09IiwibWFjIjoiZDhiNTdjZmZiNWJhNTVhN2Y2Y2FhYzM4MGE3NzAwNjViZDljMWQ1YWFjZDcwMzdiMWMyMjdmOThlZDcwYzBkMyJ9\"\n}" 404: description: '404, Not found' content: text/plain: schema: type: string example: 'Either the login credentials are incorrect, or there was no user with that email found within the database.' tags: - Authentication requestBody: required: true content: application/json: schema: type: object properties: email: type: string description: 'The email used to register at Apostle.' example: accusantium password: type: string description: 'The password paired with the email when the user registered at Apostle.' example: et team_domain: type: string description: 'The team_domain belonging to the Team the user wants to log in to. If left empty, the user will be logged in to the first Team available.' example: eos required: - email - password /api/login/magic/send: post: summary: 'Send magic link' description: 'Request a magic link to be sent to user e-mail address. A membership_token and user_token are returned.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 404: description: '404, Not found' content: text/plain: schema: type: string example: 'User not found.' tags: - Authentication requestBody: required: true content: application/json: schema: type: object properties: e-mail: type: string description: 'The e-mail for making the request.' example: quibusdam required: - e-mail /api/login/magic: get: summary: 'Magic login' description: 'Use token to login once, after this te token will be deleted. A membership_token and user_token are returned.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 404: description: '404, Not found' content: text/plain: schema: type: string example: 'Invalid token or User not found.' 403: description: '403, Forbidden' content: text/plain: schema: type: string example: 'Token has timed-out.' tags: - Authentication requestBody: required: true content: application/json: schema: type: object properties: token: type: string description: 'The received token.' example: excepturi team_domain: type: string description: 'The team_domain belonging to the Team the user wants to log in to. If left empty, the user will be logged in to the first Team available.' example: dolor required: - token /api/logout: get: summary: Logout description: 'Logout for the User' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '401, Not logged in' content: text/plain: schema: type: string example: 'There is no User logged in to log out.' tags: - Authentication /api/password/reset/send: get: summary: 'Send password reset link' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 422: description: '' content: application/json: schema: type: object example: success: false code: 115 locale: nl_NL message: 'The given data was invalid.' data: { messages: { email: ['The email field is required.'] } } debug: { trace: { class: Illuminate\Validation\ValidationException, file: /home/vagrant/feniks/vendor/laravel/framework/src/Illuminate/Validation/Validator.php, line: 466 } } properties: success: { type: boolean, example: false } code: { type: integer, example: 115 } locale: { type: string, example: nl_NL } message: { type: string, example: 'The given data was invalid.' } data: { type: object, example: { messages: { email: ['The email field is required.'] } } } debug: { type: object, example: { trace: { class: Illuminate\Validation\ValidationException, file: /home/vagrant/feniks/vendor/laravel/framework/src/Illuminate/Validation/Validator.php, line: 466 } } } tags: - Authentication /api/password/reset: post: summary: 'Reset password with token' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - Authentication '/api/impersonate/{user}': get: summary: '' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 500: description: '' content: application/json: schema: type: object example: success: false code: 113 locale: nl_NL message: Unauthenticated. data: null debug: { trace: { class: Illuminate\Auth\AuthenticationException, file: /home/vagrant/feniks/vendor/laravel/framework/src/Illuminate/Auth/Middleware/Authenticate.php, line: 82 } } properties: success: { type: boolean, example: false } code: { type: integer, example: 113 } locale: { type: string, example: nl_NL } message: { type: string, example: Unauthenticated. } data: { type: string, example: null } debug: { type: object, example: { trace: { class: Illuminate\Auth\AuthenticationException, file: /home/vagrant/feniks/vendor/laravel/framework/src/Illuminate/Auth/Middleware/Authenticate.php, line: 82 } } } tags: - Authentication parameters: - in: path name: user description: '' example: non required: true schema: type: string /api/brand/all: get: summary: Index description: 'Retrieve all Brands under the same organization as the given Membership' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n {\n \"id\": 4,\n \"name\": \"corrupti\",\n \"created_at\": \"2021-01-12T12:21:56.000000Z\",\n \"updated_at\": \"2021-01-12T12:21:56.000000Z\",\n \"organization_id\": 5,\n \"organization\": {\n \"id\": 5,\n \"name\": \"Bartell-Carter\",\n \"created_at\": null,\n \"updated_at\": null\n }\n },\n {\n \"id\": 10,\n \"name\": \"marcetti\",\n \"created_at\": \"2021-01-12T12:21:56.000000Z\",\n \"updated_at\": \"2021-01-12T12:21:56.000000Z\",\n \"organization_id\": 5,\n \"organization\": {\n \"id\": 5,\n \"name\": \"Bartell-Carter\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n }\n ]\n}" 404: description: '404, No Brands found' content: text/plain: schema: type: string example: 'There were no Brands found within our database.' tags: - Brands requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in' example: perferendis pagination: type: string description: 'The amount of items you want per page and the page you want to access separated by a comma.' example: '"2,3" The first number will be the amount of items per page, the second is the current page you want to access' required: - membership_token - pagination /api/brand/me: get: summary: Me description: 'Get the details of Brand of the logged in Member' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 404: description: '404, No Team found' content: text/plain: schema: type: string example: 'There was no Team found associated to the given Membership.' 500: description: '' content: application/json: schema: type: object example: success: false code: 113 locale: nl_NL message: Unauthenticated. data: null debug: { trace: { class: Illuminate\Auth\AuthenticationException, file: /home/vagrant/feniks/vendor/laravel/framework/src/Illuminate/Auth/Middleware/Authenticate.php, line: 82 } } properties: success: { type: boolean, example: false } code: { type: integer, example: 113 } locale: { type: string, example: nl_NL } message: { type: string, example: Unauthenticated. } data: { type: string, example: null } debug: { type: object, example: { trace: { class: Illuminate\Auth\AuthenticationException, file: /home/vagrant/feniks/vendor/laravel/framework/src/Illuminate/Auth/Middleware/Authenticate.php, line: 82 } } } tags: - Brands requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in' example: illum required: - membership_token /api/brand/resolve: get: summary: Resolve description: 'Search a Brand that possesses the given attributes.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"values\": [\n [\n {\n \"id\": 1,\n \"name\": \"sit\",\n \"created_at\": \"2021-01-13T08:14:25.000000Z\",\n \"updated_at\": \"2021-01-13T08:14:25.000000Z\",\n \"organization\": {\n \"id\": 5,\n \"name\": \"Bartell-Carter\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n ]\n ]\n}" 404: description: '404, No Brands found' content: text/plain: schema: type: string example: 'There were no Brands found based on the query given.' tags: - Brands requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in' example: et search_query: type: string description: 'Any kind of attribute you want to query on, separating the attribute from the value with a semicolon. ("id;4 name;brandname")' example: in required: - membership_token - search_query '/api/brand/detail/{id}': get: summary: Show description: 'Show the details of a Brand that is available under the same Organization as the given Membership' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 6,\n \"name\": \"corrupti\",\n \"created_at\": \"2021-01-13T08:14:25.000000Z\",\n \"updated_at\": \"2021-01-13T08:14:25.000000Z\",\n \"organization\": {\n \"id\": 5,\n \"name\": \"Bartell-Carter\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n ]\n}" 404: description: '404, No Brand found' content: text/plain: schema: type: string example: 'There was no Brand found with that ID.' 409: description: '409, Conflict' content: text/plain: schema: type: string example: 'The Brand you''re trying to see does not fall under your Organization, thus you are unauthorized.' tags: - Brands requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: neque required: - membership_token parameters: - in: path name: id description: 'The ID of the Brand that you want to show.' example: 2 required: true schema: type: integer /api/brand/create: post: summary: Store description: 'Stores a single Brand with the given parameters as attributes of said Brand.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 201: description: '201, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"name\": \"Scortini\",\n \"updated_at\": \"2021-01-13T08:46:55.000000Z\",\n \"created_at\": \"2021-01-13T08:46:55.000000Z\",\n \"id\": 134,\n \"organization\": {\n \"id\": 5,\n \"name\": \"Bartell-Carter\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n ]\n}" 400: description: '400, Wrong values' content: text/plain: schema: type: string example: 'The given values to create the Brand either already exist within the database or are of the wrong type.' 409: description: '409, Could not be created' content: text/plain: schema: type: string example: 'The Brand could not be created.' tags: - Brands requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: quibusdam name: type: string description: 'The name of the Brand that you are trying to create.' example: doloribus organization_id: type: integer description: 'The ID of the organization that the Brand you are creating belongs to.' example: 14 required: - membership_token - name - organization_id '/api/brand/edit/{id}': patch: summary: Update description: 'Updates a single Brand with the given parameters as the new attributes of the given Brand.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 6,\n \"name\": \"Scorccini\",\n \"created_at\": \"2021-01-13T08:14:25.000000Z\",\n \"updated_at\": \"2021-01-13T08:56:33.000000Z\",\n \"organization\": {\n \"id\": 5,\n \"name\": \"Bartell-Carter\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n ]\n}" 404: description: '404, Brand not found' content: text/plain: schema: type: string example: 'Could not find the Brand associated with the ID that was given.' 409: description: '409, Conflict' content: text/plain: schema: type: string example: 'The Brand attempted to edit did not fall under the same Organization as the given Membership and is thus unauthorized to be edited.' tags: - Brands requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: tempora name: type: string description: 'The new name of the Brand that you want to edit.' example: doloribus required: - membership_token parameters: - in: path name: id description: 'The ID of the Brand that you want to edit.' example: 20 required: true schema: type: integer /api/brand/me/edit: patch: summary: Update description: 'Updates the authenticated User with the given parameters.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 201: description: '201, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"email\": \"test@gmail.com\",\n \"first_name\": \"Rick\",\n \"last_name\": \"Martens\",\n \"created_at\": \"2021-01-19T11:40:17.000000Z\",\n \"id\": 101\n }\n ]\n}" 404: description: '404, User not found' content: text/plain: schema: type: string example: 'Could not find the User associated with the ID that was given.' 409: description: '409, Conflict' content: text/plain: schema: type: string example: 'The User could not be updated.' tags: - Brands requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: ratione email: type: string description: 'The email of the User that you are trying to edit.' example: a password: type: string description: 'The password of the User that you are trying to edit.' example: et first_name: type: string description: 'The first name of the User that you are trying to edit.' example: cupiditate last_name: type: string description: 'The last name of the User that you are trying to edit.' example: voluptatem dob: type: date description: 'The date of birth of the User that you are trying to edit.' example: ab phone: type: string description: 'The phone number of the User that you are trying to edit.' example: et language: type: string description: 'A combination of letters standing for the language of the User that you are trying to edit.' example: quia consent: type: boolean description: 'A boolean signifying if the User consented to the terms and conditions.' example: true avatar: type: url description: 'A URL leading to the image the User wants to use as their avatar.' example: qui required: - membership_token - email - password /api/brand/delete: delete: summary: Destroy description: 'Destroys a single or list of Brands based on the IDs given in the parameters.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 212: description: '212, Deleted' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 6,\n \"id\": 8,\n }\n ]\n}" 409: description: '409, Could not be deleted' content: text/plain: schema: type: string example: 'Some or all Brands given could not be deleted.' tags: - Brands requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: soluta array: type: of description: 'id''s to delete' example: doloremque required: - membership_token /api/brand/me/delete: delete: summary: 'Destroy Me' description: 'Destroys the current Brand.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - Brands requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: qui required: - membership_token /api/permission/all: get: summary: '' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 500: description: '' content: application/json: schema: type: object example: success: false code: 113 locale: nl_NL message: Unauthenticated. data: null debug: { trace: { class: Illuminate\Auth\AuthenticationException, file: /home/vagrant/feniks/vendor/laravel/framework/src/Illuminate/Auth/Middleware/Authenticate.php, line: 82 } } properties: success: { type: boolean, example: false } code: { type: integer, example: 113 } locale: { type: string, example: nl_NL } message: { type: string, example: Unauthenticated. } data: { type: string, example: null } debug: { type: object, example: { trace: { class: Illuminate\Auth\AuthenticationException, file: /home/vagrant/feniks/vendor/laravel/framework/src/Illuminate/Auth/Middleware/Authenticate.php, line: 82 } } } tags: - Endpoints /api/permission/resolve: get: summary: 'Check one or more columns against a value delimited per item on semicolon '';''' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 500: description: '' content: application/json: schema: type: object example: success: false code: 113 locale: nl_NL message: Unauthenticated. data: null debug: { trace: { class: Illuminate\Auth\AuthenticationException, file: /home/vagrant/feniks/vendor/laravel/framework/src/Illuminate/Auth/Middleware/Authenticate.php, line: 82 } } properties: success: { type: boolean, example: false } code: { type: integer, example: 113 } locale: { type: string, example: nl_NL } message: { type: string, example: Unauthenticated. } data: { type: string, example: null } debug: { type: object, example: { trace: { class: Illuminate\Auth\AuthenticationException, file: /home/vagrant/feniks/vendor/laravel/framework/src/Illuminate/Auth/Middleware/Authenticate.php, line: 82 } } } tags: - Endpoints '/api/permission/detail/{id}': get: summary: '' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 500: description: '' content: application/json: schema: type: object example: success: false code: 113 locale: nl_NL message: Unauthenticated. data: null debug: { trace: { class: Illuminate\Auth\AuthenticationException, file: /home/vagrant/feniks/vendor/laravel/framework/src/Illuminate/Auth/Middleware/Authenticate.php, line: 82 } } properties: success: { type: boolean, example: false } code: { type: integer, example: 113 } locale: { type: string, example: nl_NL } message: { type: string, example: Unauthenticated. } data: { type: string, example: null } debug: { type: object, example: { trace: { class: Illuminate\Auth\AuthenticationException, file: /home/vagrant/feniks/vendor/laravel/framework/src/Illuminate/Auth/Middleware/Authenticate.php, line: 82 } } } tags: - Endpoints parameters: - in: path name: id description: '' example: at required: true schema: type: string /api/permission/create: post: summary: '' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - Endpoints '/api/permission/edit/{id}': patch: summary: '' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - Endpoints parameters: - in: path name: id description: '' example: labore required: true schema: type: string /api/permission/delete: delete: summary: '' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - Endpoints /api/translation/all: get: summary: '' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 500: description: '' content: application/json: schema: type: object example: success: false code: 113 locale: nl_NL message: Unauthenticated. data: null debug: { trace: { class: Illuminate\Auth\AuthenticationException, file: /home/vagrant/feniks/vendor/laravel/framework/src/Illuminate/Auth/Middleware/Authenticate.php, line: 82 } } properties: success: { type: boolean, example: false } code: { type: integer, example: 113 } locale: { type: string, example: nl_NL } message: { type: string, example: Unauthenticated. } data: { type: string, example: null } debug: { type: object, example: { trace: { class: Illuminate\Auth\AuthenticationException, file: /home/vagrant/feniks/vendor/laravel/framework/src/Illuminate/Auth/Middleware/Authenticate.php, line: 82 } } } tags: - Endpoints /api/translation/resolve: get: summary: '' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 500: description: '' content: application/json: schema: type: object example: success: false code: 113 locale: nl_NL message: Unauthenticated. data: null debug: { trace: { class: Illuminate\Auth\AuthenticationException, file: /home/vagrant/feniks/vendor/laravel/framework/src/Illuminate/Auth/Middleware/Authenticate.php, line: 82 } } properties: success: { type: boolean, example: false } code: { type: integer, example: 113 } locale: { type: string, example: nl_NL } message: { type: string, example: Unauthenticated. } data: { type: string, example: null } debug: { type: object, example: { trace: { class: Illuminate\Auth\AuthenticationException, file: /home/vagrant/feniks/vendor/laravel/framework/src/Illuminate/Auth/Middleware/Authenticate.php, line: 82 } } } tags: - Endpoints '/api/translation/detail/{id}': get: summary: '' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 500: description: '' content: application/json: schema: type: object example: success: false code: 113 locale: nl_NL message: Unauthenticated. data: null debug: { trace: { class: Illuminate\Auth\AuthenticationException, file: /home/vagrant/feniks/vendor/laravel/framework/src/Illuminate/Auth/Middleware/Authenticate.php, line: 82 } } properties: success: { type: boolean, example: false } code: { type: integer, example: 113 } locale: { type: string, example: nl_NL } message: { type: string, example: Unauthenticated. } data: { type: string, example: null } debug: { type: object, example: { trace: { class: Illuminate\Auth\AuthenticationException, file: /home/vagrant/feniks/vendor/laravel/framework/src/Illuminate/Auth/Middleware/Authenticate.php, line: 82 } } } tags: - Endpoints parameters: - in: path name: id description: '' example: at required: true schema: type: string /api/translation/create: post: summary: '' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - Endpoints '/api/translation/edit/{id}': patch: summary: '' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - Endpoints parameters: - in: path name: id description: '' example: itaque required: true schema: type: string /api/translation/delete: delete: summary: '' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - Endpoints '/api/group/memberships/{id}': get: summary: Memberships description: 'Retrieve all Memberships under the same requested Group' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 400: description: '400, No pagination' content: text/plain: schema: type: string example: 'No pagination parameter given.' 401: description: '401, Not authorized' content: text/plain: schema: type: string example: 'No access.' 404: description: '404, No Group found' content: text/plain: schema: type: string example: 'There was no Group with the given id found within our database.' 409: description: '409, Not authorized' content: text/plain: schema: type: string example: 'Group and Membership do not belong to the same Team.' tags: - Groups requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in' example: quae pagination: type: string description: 'The amount of items you want per page and the page you want to access separated by a comma.' example: '"2,3" The first number will be the amount of items per page, the second is the current page you want to access' required: - membership_token - pagination parameters: - in: path name: id description: '' example: expedita required: true schema: type: string /api/group/add/membership: post: summary: 'Membership Add' description: 'Adds membership to given Group.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '401, Not authorized' content: text/plain: schema: type: string example: 'No access.' 400: description: '400, Wrong values' content: text/plain: schema: type: string example: 'You entered wrong values.' 403: description: '403, No access' content: text/plain: schema: type: string example: 'Group doesn''t belong to your team.' 409: description: '409, Conflict' content: text/plain: schema: type: string example: 'This relation already exists.' tags: - Groups requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: alias group_id: type: integer description: 'The ID of the Group.' example: 20 membership_id: type: integer description: 'The ID of the membership you want to add to the Group.' example: 15 required: - membership_token - group_id - membership_id /api/group/delete/membership: delete: summary: 'Membership Delete' description: 'Deletes membership from given Group.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '401, Not authorized' content: text/plain: schema: type: string example: 'No access.' 400: description: '400, Wrong values' content: text/plain: schema: type: string example: 'You entered wrong values.' 403: description: '403, No access' content: text/plain: schema: type: string example: 'The given Membership does not belong to your Team.' 409: description: '409, Conflict' content: text/plain: schema: type: string example: 'This relation already exists.' 503: description: '503, Service Unavailable' content: text/plain: schema: type: string example: 'Could not remove relation, something went wrong. Please contact developers.' tags: - Groups requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: sint group_id: type: integer description: 'The ID of the Group.' example: 7 membership_id: type: integer description: 'The ID of the membership you want to add to the Group.' example: 12 required: - membership_token - group_id - membership_id /api/group/all: get: summary: Index description: 'Retrieve all Groups under the same Team as the given Membership' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 4,\n \"name\": \"corrupti\",\n \"created_at\": \"2021-01-12T12:21:56.000000Z\",\n \"updated_at\": \"2021-01-12T12:21:56.000000Z\",\n \"team\": {\n \"id\": 8,\n \"name\": \"Pfannerstill, Halvorson and Marquardt\",\n \"domain\": \"herman\",\n \"logo\": \"https://lorempixel.com/640/480/?51237\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"brand\": {\n \"id\": 6,\n \"name\": \"ut\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"organization\": {\n \"id\": 10,\n \"name\": \"Wintheiser, Barton and Beahan\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n }\n },\n {\n \"id\": 10,\n \"name\": \"marcetti\",\n \"created_at\": \"2021-01-12T12:21:56.000000Z\",\n \"updated_at\": \"2021-01-12T12:21:56.000000Z\",\n \"team\": {\n \"id\": 8,\n \"name\": \"Pfannerstill, Halvorson and Marquardt\",\n \"domain\": \"herman\",\n \"logo\": \"https://lorempixel.com/640/480/?51237\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"brand\": {\n \"id\": 6,\n \"name\": \"ut\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"organization\": {\n \"id\": 10,\n \"name\": \"Wintheiser, Barton and Beahan\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n }\n }\n ]\n}" 404: description: '404, No Groups found' content: text/plain: schema: type: string example: 'There were no Groups found within our database.' tags: - Groups requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in' example: ut pagination: type: string description: 'The amount of items you want per page and the page you want to access separated by a comma.' example: '"2,3" The first number will be the amount of items per page, the second is the current page you want to access' required: - membership_token - pagination /api/group/resolve: get: summary: Resolve description: 'Search a Group with the given attributes.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 1,\n \"name\": \"sit\",\n \"created_at\": \"2021-01-13T08:14:25.000000Z\",\n \"updated_at\": \"2021-01-13T08:14:25.000000Z\",\n \"team_id\": 8,\n \"team\": {\n \"id\": 8,\n \"name\": \"Pfannerstill, Halvorson and Marquardt\",\n \"domain\": \"herman\",\n \"logo\": \"https://lorempixel.com/640/480/?51237\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"brand\": {\n \"id\": 6,\n \"name\": \"ut\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"organization\": {\n \"id\": 10,\n \"name\": \"Wintheiser, Barton and Beahan\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n }\n }\n ]\n}" 404: description: '404, No Groups found' content: text/plain: schema: type: string example: 'There were no Groups found based on the query given.' tags: - Groups requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in' example: voluptatum search_query: type: string description: 'Any kind of attribute you want to query on, separating the attribute from the value with a semicolon. ("id;4 name;groupname")' example: itaque required: - membership_token - search_query '/api/group/detail/{id}': get: summary: Show description: 'Show the details of a Group that is available under the same Team as the given Membership' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 6,\n \"name\": \"corrupti\",\n \"created_at\": \"2021-01-13T08:14:25.000000Z\",\n \"updated_at\": \"2021-01-13T08:14:25.000000Z\",\n \"team\": {\n \"id\": 8,\n \"name\": \"Pfannerstill, Halvorson and Marquardt\",\n \"domain\": \"herman\",\n \"logo\": \"https://lorempixel.com/640/480/?51237\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"brand\": {\n \"id\": 6,\n \"name\": \"ut\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"organization\": {\n \"id\": 10,\n \"name\": \"Wintheiser, Barton and Beahan\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n }\n }\n ]\n}" 404: description: '404, No Group found' content: text/plain: schema: type: string example: 'There was no Group found with that ID.' 409: description: '409, Conflict' content: text/plain: schema: type: string example: 'The Group you''re trying to see does not fall under your Team, thus you are unauthorized.' tags: - Groups requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: dolore required: - membership_token parameters: - in: path name: id description: 'The ID of the Group that you want to show.' example: 9 required: true schema: type: integer /api/group/create: post: summary: Store description: 'Stores a single Group with the given parameters as attributes of said Group.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 201: description: '201, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"name\": \"Scortini\",\n \"updated_at\": \"2021-01-13T08:46:55.000000Z\",\n \"created_at\": \"2021-01-13T08:46:55.000000Z\",\n \"id\": 134,\n \"team\": {\n \"id\": 8,\n \"name\": \"Pfannerstill, Halvorson and Marquardt\",\n \"domain\": \"herman\",\n \"logo\": \"https://lorempixel.com/640/480/?51237\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"brand\": {\n \"id\": 6,\n \"name\": \"ut\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"organization\": {\n \"id\": 10,\n \"name\": \"Wintheiser, Barton and Beahan\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n }\n }\n ]\n}" 400: description: '400, Wrong values' content: text/plain: schema: type: string example: 'The given values to create the Group either already exist within the database or are of the wrong type.' 409: description: '409, Could not be created' content: text/plain: schema: type: string example: 'The Group you are trying to create does not belong to your Team.' tags: - Groups requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: sunt name: type: string description: 'The name of the Group that you are trying to create.' example: accusantium team_id: type: integer description: 'The ID of the Team that the Group you are creating belongs to.' example: 11 required: - membership_token - name - team_id '/api/group/edit/{id}': patch: summary: Update description: 'Updates a single Group with the given parameters as the new attributes of the given Group.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 6,\n \"name\": \"Scorccini\",\n \"created_at\": \"2021-01-13T08:14:25.000000Z\",\n \"updated_at\": \"2021-01-13T08:56:33.000000Z\",\n \"team\": {\n \"id\": 8,\n \"name\": \"Pfannerstill, Halvorson and Marquardt\",\n \"domain\": \"herman\",\n \"logo\": \"https://lorempixel.com/640/480/?51237\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"brand\": {\n \"id\": 6,\n \"name\": \"ut\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"organization\": {\n \"id\": 10,\n \"name\": \"Wintheiser, Barton and Beahan\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n }\n }\n ]\n}" 404: description: '404, Group not found' content: text/plain: schema: type: string example: 'Could not find the Group associated with the ID that was given.' 409: description: '409, Conflict' content: text/plain: schema: type: string example: 'The Group attempted to edit did not fall under the same Team as the given Membership and is thus unauthorized to be edited.' tags: - Groups requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: sapiente name: type: string description: 'The new name of the Group that you want to edit.' example: a required: - membership_token parameters: - in: path name: id description: 'The ID of the Group that you want to edit.' example: 13 required: true schema: type: integer /api/group/delete: delete: summary: Destroy description: 'Destroys a single or list of Groups based on the IDs given in the parameters.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 212: description: '212, Deleted' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 6,\n \"id\": 8,\n }\n ]\n\n}" 409: description: '409, Could not be deleted' content: text/plain: schema: type: string example: 'Some or all Groups given could not be deleted.' tags: - Groups requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: dolores array: type: of description: 'id''s to delete' example: cumque required: - membership_token /api/images/all: get: summary: '' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 500: description: '' content: application/json: schema: type: object example: success: false code: 113 locale: nl_NL message: Unauthenticated. data: null debug: { trace: { class: Illuminate\Auth\AuthenticationException, file: /home/vagrant/feniks/vendor/laravel/framework/src/Illuminate/Auth/Middleware/Authenticate.php, line: 82 } } properties: success: { type: boolean, example: false } code: { type: integer, example: 113 } locale: { type: string, example: nl_NL } message: { type: string, example: Unauthenticated. } data: { type: string, example: null } debug: { type: object, example: { trace: { class: Illuminate\Auth\AuthenticationException, file: /home/vagrant/feniks/vendor/laravel/framework/src/Illuminate/Auth/Middleware/Authenticate.php, line: 82 } } } tags: - Images /api/images/resolve: get: summary: 'Check one or more columns against a value delimited per item on semicolon '';''' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 500: description: '' content: application/json: schema: type: object example: success: false code: 113 locale: nl_NL message: Unauthenticated. data: null debug: { trace: { class: Illuminate\Auth\AuthenticationException, file: /home/vagrant/feniks/vendor/laravel/framework/src/Illuminate/Auth/Middleware/Authenticate.php, line: 82 } } properties: success: { type: boolean, example: false } code: { type: integer, example: 113 } locale: { type: string, example: nl_NL } message: { type: string, example: Unauthenticated. } data: { type: string, example: null } debug: { type: object, example: { trace: { class: Illuminate\Auth\AuthenticationException, file: /home/vagrant/feniks/vendor/laravel/framework/src/Illuminate/Auth/Middleware/Authenticate.php, line: 82 } } } tags: - Images '/api/images/detail/{id}': get: summary: '' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 500: description: '' content: application/json: schema: type: object example: success: false code: 113 locale: nl_NL message: Unauthenticated. data: null debug: { trace: { class: Illuminate\Auth\AuthenticationException, file: /home/vagrant/feniks/vendor/laravel/framework/src/Illuminate/Auth/Middleware/Authenticate.php, line: 82 } } properties: success: { type: boolean, example: false } code: { type: integer, example: 113 } locale: { type: string, example: nl_NL } message: { type: string, example: Unauthenticated. } data: { type: string, example: null } debug: { type: object, example: { trace: { class: Illuminate\Auth\AuthenticationException, file: /home/vagrant/feniks/vendor/laravel/framework/src/Illuminate/Auth/Middleware/Authenticate.php, line: 82 } } } tags: - Images parameters: - in: path name: id description: '' example: quo required: true schema: type: string /api/images/create: post: summary: Store description: 'Stores a single Image and generates a 40x40 thumbnail' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: multipart/form-data schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 201: description: '201, Created' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 132,\n \"title\": \"title\",\n \"description\": \"description\",\n \"src\": \"images/LdQgUpRo0scMynLtEQGxK7x9VyI2jH0ly8aDHNEd.jpg\",\n \"filename\": \"php0i6liU\",\n \"extension\": \"jpeg\",\n \"filesize\": 116082000,\n \"width\": 1600,\n \"height\": 1600,\n \"alt\": null,\n \"thumbnail_id\": 132,\n \"created_at\": null,\n \"updated_at\": null,\n \"thumbnail\": {\n \"id\": 132,\n \"src\": \"thumbnails/php0i6liU.jpg\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n ]\n }" tags: - Images requestBody: required: true content: multipart/form-data: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: consectetur image: type: string format: binary description: "The Image file that you want to upload\nmimes:jpg,png,jpeg,gif,svg|max:4096\ndimensions:min_width=100,min_height=100,max_width=1960,max_height=1080'." title: type: string description: 'The Image title' example: dolore description: type: string description: 'The Image description' example: voluptas alt: type: string description: 'The alt title' example: non required: - membership_token - image /api/images/create/multiple: post: summary: 'Store Multiple' description: 'Stores multiple Images and generates 40x40 thumbnails' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: multipart/form-data schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 201: description: '201, Created' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 132,\n \"title\": \"title\",\n \"description\": \"description\",\n \"src\": \"images/LdQgUpRo0scMynLtEQGxK7x9VyI2jH0ly8aDHNEd.jpg\",\n \"filename\": \"php0i6liU\",\n \"extension\": \"jpeg\",\n \"filesize\": 116082000,\n \"width\": 1600,\n \"height\": 1600,\n \"alt\": null,\n \"thumbnail_id\": 132,\n \"created_at\": null,\n \"updated_at\": null,\n \"thumbnail\": {\n \"id\": 132,\n \"src\": \"thumbnails/php0i6liU.jpg\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n ]\n }" tags: - Images requestBody: required: true content: multipart/form-data: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: hic image: type: string format: binary description: "The Image file that you want to upload\nmimes:jpg,png,jpeg,gif,svg|max:4096\ndimensions:min_width=100,min_height=100,max_width=1960,max_height=1080'.\n\nMultiple files can be added to request.\nindexed or assoc keys possible, doesnt matter" required: - membership_token - image '/api/images/edit/{id}': patch: summary: '' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - Images parameters: - in: path name: id description: '' example: veritatis required: true schema: type: string /api/images/delete: delete: summary: '' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - Images '/api/invite/accept/{inviteToken}': post: summary: Accept description: 'Accepts an Invite based on the token given in the email.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"user_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxIiwianRpIjoiY2NlOTYzNTI3ZGNhZTE3ZDA5N2Q4ZDRkZTFkZTg2YmM0ODU4OGU3MzI4YWZlN2UwODhjOGY3ZDg5ODVlOWJjNWQ3MDY4OTc4MWQxZDRlNTAiLCJpYXQiOiIxNjEwOTcxNTg0LjUyNTQwNiIsIm5iZiI6IjE2MTA5NzE1ODQuNTI1NDM5IiwiZXhwIjoiMTY0MjUwNzU4NC40ODczNDIiLCJzdWIiOiIxMDEiLCJzY29wZXMiOltdfQ.rShoJwanYO6zgXmkR3aEoZYYGOUgyRh4qcKWat_B5l42-jFMLbWrw2CoTvLSijJTGQ-rApCH0qyZTjm8eTKQ3aRVwdXYUc24jjjVRrpzosWDGXl8OnkSueM6V23QUU8rUYjwoPoQlBiPihS3xFDRDyR0szuD0YIhVDN_CsO14naW2SbqSuPqtVolW2GAXICN8Ily7N0kk-4vZ4ZeeIhGJocHlBlmwEtjjcM5yN6he7oL1QhN8UeCdJDDREIa3aflf6xrN9mGtYUDDRhZ6ScA5GrQrfyMHfteT6iZZpMyXFKZbufYlzyub2m4lyeYTqZdTHM38d1X9ByBmHgsiS0ZWHyWDe5u9mh2bDXzFPNp91ssOmgUaLjG683FgxgjqWqznzBi0exD-wXRCMRoTaYN1-A2xQWYDZy_AxR9mEZPKgy5YByMPACnEhBwKhhfEdz7eO8itZZOohy2766KIJ_aOl0Fw_tm4dZLdQPJRungDGXG2dWWA35OaW3H9Yi6Z8LyEnxIclrACTcdiXvirYP6pb86bkAhzxBUHRKbHYEyNKalEMVIBoThGKkoiZ_yZ2s1vh0ZQl7lHQvlBbIfMGRDBT62Kxu3vvajUo_Fkgy5dqFM8aLpqbjlzMVqB9sQkVg1niK8B7QtA-3Z8gwNUB0nCpH_MKZTxn02pYBr-DjVwVQ\",\n \"membership_token\": \"eyJpdiI6ImJVUGNNZldDcDFXOWZjSEhxWko2TUE9PSIsInZhbHVlIjoiKzNOYnArdjNMeWE0eXNYWUVpTGNUUT09IiwibWFjIjoiNjI4NGM3OTdkNDI3ZDM2ZjA3ZTI2MzQ2OGQ4MGQxYjY0OGZjNDgxZTQ0OTYyMWMzOTMzNTY1NzE2MDZhOTYyYiJ9\"\n}" 401: description: '401, Unauthorized' content: text/plain: schema: type: string example: 'The Invite you''re trying to send does not belong to your Team.' 404: description: '404, Invite not found' content: text/plain: schema: type: string example: 'The invite you''re trying to accept can not be found.' 409: description: '409, Conflict' content: text/plain: schema: type: string example: 'The new user could not be logged in.' 400: description: '400, Bad Request' content: text/plain: schema: type: string example: 'Either the token could not be found, or the User already has a Membership with that Team.' tags: - Invites requestBody: required: true content: application/json: schema: type: object properties: password: type: string description: 'The password of the account you''re either trying to log in with, or the password you want to use for the newly made account.' example: illo email: type: string description: 'The email associated with the account that you already have an account with.' example: velit first_name: type: string description: 'The first name you want your user account to display.' example: est last_name: type: string description: 'The last name you want your use account to display.' example: fuga required: - password parameters: - in: path name: inviteToken description: '' example: dolor required: true schema: type: string - in: path name: token description: 'The token that came in the email, used to log in for the first time.' example: explicabo required: true schema: type: string '/api/invite/send/{invite}': get: summary: Send description: 'Send a created Invite to the email address in the object.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 101,\n \"state\": \"pending\",\n \"token\": \"ZiBzVqTGkConoJQ0GVVhI65KE7cA38HG8P8CovPOC12nfdXlaSwN7sISnY2gmv5v\",\n \"email\": \"test@gmail.com\",\n \"name\": \"mister master man\",\n \"role\": {\n \"id\": 1,\n \"name\": \"Ambassador\",\n \"level\": \"user\",\n \"created_at\": \"2021-01-13T08:14:25.000000Z\",\n \"updated_at\": \"2021-01-13T08:14:25.000000Z\",\n },\n \"sent_at\": \"2021-01-18T12:02:45.677520Z\",\n \"accepted_at\": null,\n \"message\": \"Ik ben een testbericht!\",\n \"created_at\": \"2021-01-18T12:01:29.000000Z\",\n \"updated_at\": \"2021-01-18T12:02:45.000000Z\",\n \"team\": {\n \"id\": 8,\n \"name\": \"Pfannerstill, Halvorson and Marquardt\",\n \"domain\": \"herman\",\n \"logo\": \"https://lorempixel.com/640/480/?51237\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"brand\": {\n \"id\": 6,\n \"name\": \"ut\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"organization\": {\n \"id\": 10,\n \"name\": \"Wintheiser, Barton and Beahan\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n }\n }\n ]\n}" 401: description: '401, Unauthorized' content: text/plain: schema: type: string example: 'The Invite you''re trying to send does not belong to your Team.' 404: description: '404, No Invite found' content: text/plain: schema: type: string example: 'There was no Invite found with that ID.' tags: - Invites requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Invite access-token that came back when logged in' example: modi required: - membership_token parameters: - in: path name: invite description: '' example: suscipit required: true schema: type: string - in: path name: id description: 'The ID of the Invite that you want to send out.' example: 12 required: true schema: type: integer /api/invite/resolve: get: summary: Resolve description: 'Search an Invite with the given attributes.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 1,\n \"state\": \"pending\",\n \"token\": \"PakN8cRgw2vydzxYj4m7pplJMTYX35O0aCkl3mXBYTWrxqtrOvumOZKoy7xQbl6o\",\n \"email\": \"iharris@hotmail.com\",\n \"name\": \"Blaze Veum\",\n \"role\": {\n \"id\": 1,\n \"name\": \"Ambassador\",\n \"level\": \"user\",\n \"created_at\": \"2021-01-13T08:14:25.000000Z\",\n \"updated_at\": \"2021-01-13T08:14:25.000000Z\"\n },\n \"sent_at\": null,\n \"accepted_at\": null,\n \"message\": \"Lorem Ipsum is slechts een proeftekst uit het drukkerij- en zetterijwezen.\",\n \"created_at\": \"1994-09-13T13:44:09.000000Z\",\n \"updated_at\": \"1991-03-14T03:15:05.000000Z\",\n \"team\": {\n \"id\": 8,\n \"name\": \"Pfannerstill, Halvorson and Marquardt\",\n \"domain\": \"herman\",\n \"logo\": \"https://lorempixel.com/640/480/?51237\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"brand\": {\n \"id\": 6,\n \"name\": \"ut\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"organization\": {\n \"id\": 10,\n \"name\": \"Wintheiser, Barton and Beahan\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n }\n }\n ]\n}" 404: description: '404, No Invites found' content: text/plain: schema: type: string example: 'There were no Invites found based on the query given.' tags: - Invites requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Invite access-token that came back when logged in' example: nostrum search_query: type: string description: 'Any kind of attribute you want to query on, separating the attribute from the value with a semicolon. ("id;4 team_id;8")' example: dolore required: - membership_token - search_query /api/invite/all: get: summary: Index description: 'Retrieve all Invites under the same Team of the given Membership' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 1,\n \"state\": \"pending\",\n \"token\": \"PakN8cRgw2vydzxYj4m7pplJMTYX35O0aCkl3mXBYTWrxqtrOvumOZKoy7xQbl6o\",\n \"email\": \"iharris@hotmail.com\",\n \"name\": \"Blaze Veum\",\n \"role_id\": 1,\n \"role\": {\n \"id\": 1,\n \"name\": \"Ambassador\",\n \"level\": \"user\",\n \"created_at\": \"2021-01-13T08:14:25.000000Z\",\n \"updated_at\": \"2021-01-13T08:14:25.000000Z\",\n },\n \"sent_at\": null,\n \"accepted_at\": null,\n \"message\": \"Lorem Ipsum is slechts een proeftekst uit het drukkerij- en zetterijwezen.\",\n \"created_at\": \"1994-09-13T13:44:09.000000Z\",\n \"updated_at\": \"1991-03-14T03:15:05.000000Z\",\n \"team_id\": 8,\n \"team\": {\n \"id\": 8,\n \"name\": \"Pfannerstill, Halvorson and Marquardt\",\n \"domain\": \"herman\",\n \"logo\": \"https://lorempixel.com/640/480/?51237\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"brand_id\": 6,\n \"brand\": {\n \"id\": 6,\n \"name\": \"ut\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"organization_id\": 10,\n \"organization\": {\n \"id\": 10,\n \"name\": \"Wintheiser, Barton and Beahan\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n }\n }\n ]\n}" 404: description: '404, No Invites found' content: text/plain: schema: type: string example: 'There were no Invites found within our database.' tags: - Invites requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in' example: dicta pagination: type: string description: 'The amount of items you want per page and the page you want to access separated by a comma.' example: '"2,3" The first number will be the amount of items per page, the second is the current page you want to access' required: - membership_token - pagination '/api/invite/detail/{id}': get: summary: Show description: 'Show the details of an Invite that is available under the same Team,.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 1,\n \"state\": \"pending\",\n \"token\": \"PakN8cRgw2vydzxYj4m7pplJMTYX35O0aCkl3mXBYTWrxqtrOvumOZKoy7xQbl6o\",\n \"email\": \"iharris@hotmail.com\",\n \"name\": \"Blaze Veum\",\n \"role\": {\n \"id\": 1,\n \"name\": \"Ambassador\",\n \"level\": \"user\",\n \"created_at\": \"2021-01-13T08:14:25.000000Z\",\n \"updated_at\": \"2021-01-13T08:14:25.000000Z\",\n },\n \"sent_at\": null,\n \"accepted_at\": null,\n \"message\": \"Lorem Ipsum is slechts een proeftekst uit het drukkerij- en zetterijwezen.\",\n \"created_at\": \"1994-09-13T13:44:09.000000Z\",\n \"updated_at\": \"1991-03-14T03:15:05.000000Z\",\n \"team\": {\n \"id\": 8,\n \"name\": \"Pfannerstill, Halvorson and Marquardt\",\n \"domain\": \"herman\",\n \"logo\": \"https://lorempixel.com/640/480/?51237\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"brand\": {\n \"id\": 6,\n \"name\": \"ut\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"organization\": {\n \"id\": 10,\n \"name\": \"Wintheiser, Barton and Beahan\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n }\n }\n ]\n}" 404: description: '404, No Invite found' content: text/plain: schema: type: string example: 'There was no Invite found with that ID.' 409: description: '409, Conflict' content: text/plain: schema: type: string example: 'The Invite you''re trying to see does not fall under your Team, thus you are unauthorized.' tags: - Invites requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: eius required: - membership_token parameters: - in: path name: id description: 'The ID of the Membership that you want to show.' example: 13 required: true schema: type: integer /api/invite/create: post: summary: Store description: 'Stores a single Invite with the given parameters as attributes of said Invite.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 201: description: '201, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"state\": \"pending\",\n \"name\": \"mister master man\",\n \"token\": \"ZiBzVqTGkConoJQ0GVVhI65KE7cA38HG8P8CovPOC12nfdXlaSwN7sISnY2gmv5v\",\n \"email\": \"test@gmail.com\",\n \"role\": {\n \"id\": 1,\n \"name\": \"Ambassador\",\n \"level\": \"user\",\n \"created_at\": \"2021-01-13T08:14:25.000000Z\",\n \"updated_at\": \"2021-01-13T08:14:25.000000Z\",\n },\n \"message\": \"Ik ben een testbericht!\",\n \"updated_at\": \"2021-01-18T12:01:29.000000Z\",\n \"created_at\": \"2021-01-18T12:01:29.000000Z\",\n \"id\": 101,\n \"team\": {\n \"id\": 8,\n \"name\": \"Pfannerstill, Halvorson and Marquardt\",\n \"domain\": \"herman\",\n \"logo\": \"https://lorempixel.com/640/480/?51237\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"brand\": {\n \"id\": 6,\n \"name\": \"ut\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"organization\": {\n \"id\": 10,\n \"name\": \"Wintheiser, Barton and Beahan\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n }\n }\n ]\n}" 400: description: '400, Wrong values' content: text/plain: schema: type: string example: 'The given values to create the Invite either already exist within the database or are of the wrong type.' 409: description: '409, Could not be created' content: text/plain: schema: type: string example: 'The Invite could not be created.' tags: - Invites requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: perspiciatis team_id: type: integer description: 'The ID of the Team that the Invite belongs to.' example: 12 state: type: string description: 'The state of the Invite.' example: cupiditate name: type: string description: 'The Name of the recipient of the Invite.' example: ea token: type: string description: 'The token required to log in for the first time through the Invite.' example: voluptatibus email: type: string description: 'The email address that the Invite will be sent to.' example: fugit role_id: type: integer description: 'The Role-level that the invitee will have upon logging in for the first time.' example: 1 message: type: string description: 'A message to be sent together with the email to the invitee.' example: maiores required: - membership_token - team_id - email - role_id '/api/invite/edit/{id}': patch: summary: Update description: 'Updates a single Invite with the given parameters as the new attributes of the given Invite.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 1,\n \"state\": \"pending\",\n \"token\": \"PakN8cRgw2vydzxYj4m7pplJMTYX35O0aCkl3mXBYTWrxqtrOvumOZKoy7xQbl6o\",\n \"email\": \"iharris@hotmail.com\",\n \"name\": \"Blaze Veum\",\n \"role\": {\n \"id\": 1,\n \"name\": \"Ambassador\",\n \"level\": \"user\",\n \"created_at\": \"2021-01-13T08:14:25.000000Z\",\n \"updated_at\": \"2021-01-13T08:14:25.000000Z\",\n },\n \"sent_at\": null,\n \"accepted_at\": null,\n \"message\": \"Lorem Ipsum is slechts een proeftekst uit het drukkerij- en zetterijwezen.\",\n \"created_at\": \"1994-09-13T13:44:09.000000Z\",\n \"updated_at\": \"2021-01-19T09:03:15.000000Z\",\n \"team\": {\n \"id\": 8,\n \"name\": \"Pfannerstill, Halvorson and Marquardt\",\n \"domain\": \"herman\",\n \"logo\": \"https://lorempixel.com/640/480/?51237\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"brand\": {\n \"id\": 6,\n \"name\": \"ut\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"organization\": {\n \"id\": 10,\n \"name\": \"Wintheiser, Barton and Beahan\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n }\n }\n ]\n}" 404: description: '404, Invite not found' content: text/plain: schema: type: string example: 'Could not find the Invite associated with the ID that was given.' 409: description: '409, Conflict' content: text/plain: schema: type: string example: 'The Invite you''re trying to access does not belong to your Team.' tags: - Invites requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: illo state: type: string description: 'The new state that the Invite will have.' example: aut role_id: type: integer description: 'The new ID of the role-level the user will have upon logging in for the first time.' example: 8 message: type: string description: 'The new message to be sent together with the email to the invitee.' example: provident sent_at: type: date description: 'The date the message was sent on.' example: voluptate accepted_at: type: date description: 'The date the Invite was accepted on.' example: beatae required: - membership_token parameters: - in: path name: id description: '' example: illum required: true schema: type: string /api/invite/delete: delete: summary: Destroy description: 'Destroys a single or list of Invites based on the IDs given in the parameters.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 212: description: '212, Deleted' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 1,\n \"id\": 3,\n }\n ]\n}" 409: description: '409, Could not be deleted' content: text/plain: schema: type: string example: 'Some or all Invites given could not be deleted.' tags: - Invites requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: recusandae array: type: of description: 'id''s to delete' example: ratione required: - membership_token '/api/membership/assign/role/{membership}/{role}': post: summary: 'Assign Role' description: 'Assign a Role to a Membership' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 404: description: '404, No Roles found' content: text/plain: schema: type: string example: 'There were no Roles found based on the query given.' tags: - Memberships requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in' example: voluptate membership_id: type: string description: 'The Membership id tho assign a Role to' example: maxime required: - membership_token - membership_id parameters: - in: path name: membership description: '' example: reiciendis required: true schema: type: string - in: path name: role description: '' example: ut required: true schema: type: string /api/membership/resolve: get: summary: Resolve description: "Search and filter trough Memberships within your team/brand/org and retrieve the User objects related to those Memberships\nEvery search parameter can bu used with multiple search-terms by concatenating the term with a semicolon like this (term1;term2;term3)" parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 404: description: '404, No Memberships found' content: text/plain: schema: type: string example: 'There were no Memberships found based on the query given.' tags: - Memberships requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in' example: facilis type: type: string description: 'The level of indexing you want to have of all Memberships. (team, brand, organization)' example: nihil pagination: type: string description: 'The amount of items you want per page and the page you want to access separated by a comma.' example: '"2,3" The first number will be the amount of items per page, the second is the current page you want to access' membership_role: type: integer description: 'Filter on Role' example: 11 membership_ghost: type: boolean description: 'Filter on Ghost' example: true user_first_name: type: string description: 'Filter on First name' example: sequi user_last_name: type: string description: 'Filter on Last name' example: eaque user_dob: type: string description: 'Filter on Date of birth format(d-m-Y)' example: qui user_email: type: string description: 'Filter on E-mail' example: quidem user_phone: type: string description: 'Filter on Phone number' example: dolorem user_language: type: string description: 'Filter on Language' example: expedita required: - membership_token - pagination /api/membership/me: get: summary: Me description: 'Get the details of the authenticated Membership' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - Memberships requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in' example: eaque required: - membership_token /api/membership/all: get: summary: Index description: 'Retrieve all Memberships under the same Team, Brand or Organization' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 404: description: '404, No Memberships found' content: text/plain: schema: type: string example: 'There were no Memberships found within our database.' tags: - Memberships requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in' example: saepe type: type: string description: 'The level of indexing you want to have of all Memberships. (team, brand, organization)' example: et pagination: type: string description: 'The amount of items you want per page and the page you want to access separated by a comma.' example: '"2,3" The first number will be the amount of items per page, the second is the current page you want to access' required: - membership_token - pagination /api/membership/create: post: summary: Store description: 'Stores a single Membership with the given parameters as attributes of said Membership.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 201: description: '201, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"updated_at\": \"2021-01-13T08:46:55.000000Z\",\n \"created_at\": \"2021-01-13T08:46:55.000000Z\",\n \"id\": 134,\n \"team\": {\n \"id\": 8,\n \"name\": \"Pfannerstill, Halvorson and Marquardt\",\n \"domain\": \"herman\",\n \"logo\": \"https://lorempixel.com/640/480/?51237\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"brand\": {\n \"id\": 6,\n \"name\": \"ut\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"organization\": {\n \"id\": 10,\n \"name\": \"Wintheiser, Barton and Beahan\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n },\n \"role\": {\n \"id\": 6,\n \"name\": \"Apostle Software-engineer\",\n \"level\": \"developer\",\n \"created_at\": \"2021-02-02T12:15:42.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:42.000000Z\"\n },\n \"user\": {\n \"id\": 1,\n \"first_name\": \"Wava\",\n \"last_name\": \"Purdy\",\n \"dob\": \"1999-08-20\",\n \"email\": \"test@apostle.nl\",\n \"phone\": \"441-775-9608\",\n \"email_verified_at\": \"1977-12-28T23:00:00.000000Z\",\n \"consent\": 0,\n \"avatar\": \"https://lorempixel.com/640/480/?37555\",\n \"language\": \"nl\",\n \"created_at\": \"2021-02-02T12:15:43.000000Z\",\n \"deleted_at\": null,\n \"provider\": null,\n \"provider_id\": null\n }\n }\n ]\n}" 400: description: '400, Wrong values' content: text/plain: schema: type: string example: 'The given values to create the Membership either already exist within the database or are of the wrong type.' 409: description: '409, Could not be created' content: text/plain: schema: type: string example: 'The Membership could not be created.' tags: - Memberships requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: culpa user_id: type: integer description: 'The ID of the User that the Membership you are creating belongs to.' example: 19 team_id: type: integer description: 'The ID of the Team that the Membership you are creating belongs to.' example: 10 role_id: type: integer description: 'The ID of the Role that the Membership you are creating has.' example: 11 ghost: type: boolean description: 'A boolean representing if the User is a ghost within the Team. (0, 1)' example: true required: - membership_token - user_id - team_id - role_id '/api/membership/detail/{id}': get: summary: Show description: 'Show the details of a Membership that is available under the same Team, Brand or Organization.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 6,\n \"last_login\": \"1995-09-18 00:00:00\",\n \"ghost\": 0,\n \"created_at\": \"2021-01-13T08:14:25.000000Z\",\n \"updated_at\": \"2021-01-13T08:14:25.000000Z\",\n \"team\": {\n \"id\": 8,\n \"name\": \"Pfannerstill, Halvorson and Marquardt\",\n \"domain\": \"herman\",\n \"logo\": \"https://lorempixel.com/640/480/?51237\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"brand\": {\n \"id\": 6,\n \"name\": \"ut\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"organization\": {\n \"id\": 10,\n \"name\": \"Wintheiser, Barton and Beahan\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n },\n \"role\": {\n \"id\": 6,\n \"name\": \"Apostle Software-engineer\",\n \"level\": \"developer\",\n \"created_at\": \"2021-02-02T12:15:42.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:42.000000Z\"\n },\n \"user\": {\n \"id\": 1,\n \"first_name\": \"Wava\",\n \"last_name\": \"Purdy\",\n \"dob\": \"1999-08-20\",\n \"email\": \"test@apostle.nl\",\n \"phone\": \"441-775-9608\",\n \"email_verified_at\": \"1977-12-28T23:00:00.000000Z\",\n \"consent\": 0,\n \"avatar\": \"https://lorempixel.com/640/480/?37555\",\n \"language\": \"nl\",\n \"created_at\": \"2021-02-02T12:15:43.000000Z\",\n \"deleted_at\": null,\n \"provider\": null,\n \"provider_id\": null\n }\n }\n ]\n}" 404: description: '404, No Membership found' content: text/plain: schema: type: string example: 'There was no Membership found with that ID.' 409: description: '409, Conflict' content: text/plain: schema: type: string example: 'The Membership you''re trying to see does not fall under your Team, Brand or Organization thus you are unauthorized.' tags: - Memberships requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: et type: type: string description: 'The level of indexing you want to have of all Memberships. (team, brand, organization)' example: inventore required: - membership_token parameters: - in: path name: id description: 'The ID of the Membership that you want to show.' example: 12 required: true schema: type: integer '/api/membership/edit/{id}': patch: summary: Update description: 'Updates a single Membership with the given parameters as the new attributes of the given Membership.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 21,\n \"last_login\": \"2014-09-15 00:00:00\",\n \"ghost\": 0,\n \"created_at\": \"2021-01-13T08:14:25.000000Z\",\n \"updated_at\": \"2021-01-13T08:56:33.000000Z\",\n \"team\": {\n \"id\": 8,\n \"name\": \"Pfannerstill, Halvorson and Marquardt\",\n \"domain\": \"herman\",\n \"logo\": \"https://lorempixel.com/640/480/?51237\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"brand\": {\n \"id\": 6,\n \"name\": \"ut\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"organization\": {\n \"id\": 10,\n \"name\": \"Wintheiser, Barton and Beahan\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n },\n \"role\": {\n \"id\": 6,\n \"name\": \"Apostle Software-engineer\",\n \"level\": \"developer\",\n \"created_at\": \"2021-02-02T12:15:42.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:42.000000Z\"\n },\n \"user\": {\n \"id\": 1,\n \"first_name\": \"Wava\",\n \"last_name\": \"Purdy\",\n \"dob\": \"1999-08-20\",\n \"email\": \"test@apostle.nl\",\n \"phone\": \"441-775-9608\",\n \"email_verified_at\": \"1977-12-28T23:00:00.000000Z\",\n \"consent\": 0,\n \"avatar\": \"https://lorempixel.com/640/480/?37555\",\n \"language\": \"nl\",\n \"created_at\": \"2021-02-02T12:15:43.000000Z\",\n \"deleted_at\": null,\n \"provider\": null,\n \"provider_id\": null\n }\n }\n ]\n}" 404: description: '404, Membership not found' content: text/plain: schema: type: string example: 'Could not find the Membership associated with the ID that was given.' 409: description: '409, Conflict' content: text/plain: schema: type: string example: 'The Membership attempted to edit did not fall under the same Team as the given Membership and is thus unauthorized to be edited.' tags: - Memberships requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: nam role_id: type: integer description: 'The new ID of the Role that you want to give to the Membership.' example: 2 ghost: type: boolean description: 'The new value of the boolean signifying whether the Membership is a ghost within it''s Team.' example: false required: - membership_token parameters: - in: path name: id description: 'The ID of the Membership that you want to edit.' example: 9 required: true schema: type: integer /api/membership/me/edit: patch: summary: 'Update Me' description: 'Updates the authenticated Membership with the given parameters as the new attributes of the given Membership.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 21,\n \"last_login\": \"2014-09-15 00:00:00\",\n \"ghost\": 0,\n \"created_at\": \"2021-01-13T08:14:25.000000Z\",\n \"updated_at\": \"2021-01-13T08:56:33.000000Z\",\n \"deleted_at\": null,\n \"team\": {\n \"id\": 8,\n \"name\": \"Pfannerstill, Halvorson and Marquardt\",\n \"domain\": \"herman\",\n \"logo\": \"https://lorempixel.com/640/480/?51237\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"brand\": {\n \"id\": 6,\n \"name\": \"ut\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"organization\": {\n \"id\": 10,\n \"name\": \"Wintheiser, Barton and Beahan\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n },\n \"role\": {\n \"id\": 6,\n \"name\": \"Apostle Software-engineer\",\n \"level\": \"developer\",\n \"created_at\": \"2021-02-02T12:15:42.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:42.000000Z\"\n },\n \"user\": {\n \"id\": 1,\n \"first_name\": \"Wava\",\n \"last_name\": \"Purdy\",\n \"dob\": \"1999-08-20\",\n \"email\": \"test@apostle.nl\",\n \"phone\": \"441-775-9608\",\n \"email_verified_at\": \"1977-12-28T23:00:00.000000Z\",\n \"consent\": 0,\n \"avatar\": \"https://lorempixel.com/640/480/?37555\",\n \"language\": \"nl\",\n \"created_at\": \"2021-02-02T12:15:43.000000Z\",\n \"deleted_at\": null,\n \"provider\": null,\n \"provider_id\": null\n }\n }\n ]\n}" tags: - Memberships requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: ea role_id: type: integer description: 'The new ID of the Role that you want to give to the Membership.' example: 7 ghost: type: boolean description: 'The new value of the boolean signifying whether the Membership is a ghost within it''s Team.' example: false required: - membership_token parameters: - in: path name: id description: 'The ID of the Membership that you want to edit.' example: 7 required: true schema: type: integer /api/membership/delete: delete: summary: Destroy description: 'Destroys a single or list of Memberships based on the IDs given in the parameters.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 212: description: '212, Deleted' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 21,\n \"id\": 44,\n }\n ]\n}" 409: description: '409, Could not be deleted' content: text/plain: schema: type: string example: 'Some or all Memberships given could not be deleted.' tags: - Memberships requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: voluptas array: type: of description: 'id''s to delete' example: voluptate required: - membership_token /api/membership/me/delete: delete: summary: 'Destroy Me' description: 'Destroys a the authenticated Membership.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - Memberships requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: quia required: - membership_token /api/organization/resolve: get: summary: Resolve description: 'Search an Organization with the given attributes.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 1,\n \"name\": \"sit\",\n \"created_at\": \"2021-01-13T08:14:25.000000Z\",\n \"updated_at\": \"2021-01-13T08:14:25.000000Z\"\n }\n ]\n}" 404: description: '404, No Organizations found' content: text/plain: schema: type: string example: 'There were no Organizations found based on the query given.' tags: - Organizations requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in' example: aut search_query: type: string description: 'Any kind of attribute you want to query on, separating the attribute from the value with a semicolon. ("id;4 name;organizationname")' example: autem required: - membership_token - search_query /api/organization/me: get: summary: Me description: 'Get the details of the Organization belonging to the logged in Member' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 59,\n \"name\": \"Mitchell\",\n \"created_at\": \"2021-01-13T08:14:25.000000Z\",\n \"updated_at\": \"2021-01-13T08:14:25.000000Z\"\n }\n ]\n}" 404: description: '404, No Organization found' content: text/plain: schema: type: string example: 'There could not be an Organization found belonging to the given Membership.' tags: - Organizations requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in' example: eum required: - membership_token /api/organization/all: get: summary: Index description: 'Retrieve all Organizations' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 1,\n \"name\": \"Greenfelder\",\n \"created_at\": \"2021-01-12T12:21:56.000000Z\",\n \"updated_at\": \"2021-01-12T12:21:56.000000Z\",\n },\n {\n \"id\": 2,\n \"name\": \"Franecki\",\n \"created_at\": \"2021-01-12T12:21:56.000000Z\",\n \"updated_at\": \"2021-01-12T12:21:56.000000Z\"\n }\n ]\n}" 404: description: '404, No Organizations found' content: text/plain: schema: type: string example: 'There were no Organizations found within our database.' tags: - Organizations requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in' example: aut pagination: type: string description: 'The amount of items you want per page and the page you want to access separated by a comma.' example: '"2,3" The first number will be the amount of items per page, the second is the current page you want to access' required: - membership_token - pagination '/api/organization/detail/{id}': get: summary: Show description: 'Show the details of an Organization.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 6,\n \"name\": \"corrupti\",\n \"created_at\": \"2021-01-13T08:14:25.000000Z\",\n \"updated_at\": \"2021-01-13T08:14:25.000000Z\",\n }\n ]\n}" 404: description: '404, No Organization found' content: text/plain: schema: type: string example: 'There was no Organization found with that ID.' tags: - Organizations requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: velit required: - membership_token parameters: - in: path name: id description: 'The ID of the Organization that you want to show.' example: 8 required: true schema: type: integer /api/organization/create: post: summary: Store description: 'Stores a single Organization with the given parameters as attributes of said Organization.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 201: description: '201, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"name\": \"Scortini\",\n \"id\": 134\n }\n ]\n}" 400: description: '400, Wrong values' content: text/plain: schema: type: string example: 'The given values to create the Organization either already exist within the database or are of the wrong type.' 409: description: '409, Could not be created' content: text/plain: schema: type: string example: 'The Organization could not be created.' tags: - Organizations requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: commodi name: type: string description: 'The name of the Brand that you are trying to create.' example: nobis required: - membership_token - name '/api/organization/edit/{id}': patch: summary: Update description: 'Updates a single Organization with the given parameters as the new attributes of the given Organization.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 6,\n \"name\": \"Scorccini\",\n \"created_at\": \"2021-01-13T08:14:25.000000Z\",\n \"updated_at\": \"2021-01-13T08:56:33.000000Z\"\n }\n ]\n}" 404: description: '404, Organization not found' content: text/plain: schema: type: string example: 'Could not find the Organization associated with the ID that was given.' 409: description: '409, Conflict' content: text/plain: schema: type: string example: 'The Organization could not be edited.' tags: - Organizations requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: quaerat name: type: string description: 'The new name of the Organization that you want to edit.' example: ut required: - membership_token parameters: - in: path name: id description: 'The ID of the Organization that you want to edit.' example: 15 required: true schema: type: integer /api/organization/me/edit: patch: summary: 'Update Me' description: 'Updates the Organization belonging to the authenticated Membership with the given parameters as the new attributes of the given Organization.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 21,\n \"name\": \"jenny\",\n \"created_at\": \"2021-01-13T08:14:25.000000Z\",\n \"updated_at\": \"2021-01-13T08:56:33.000000Z\",\n \"deleted_at\": null,\n }\n }\n}" 404: description: '404, No Organizations found' content: text/plain: schema: type: string example: 'No Organization linked to the given Membership could be found.' tags: - Organizations requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: fuga name: type: string description: 'The name that you want to update the Organization with.' example: sit required: - membership_token /api/organization/delete: delete: summary: Destroy description: 'Destroys a single or list of Organizations based on the IDs given in the parameters.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 212: description: '212, Deleted' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 6,\n \"id\": 61,\n }\n ]\n\n}" 409: description: '409, Could not be deleted' content: text/plain: schema: type: string example: 'Some or all Organizations given could not be deleted.' tags: - Organizations requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: nihil array: type: of description: 'id''s to delete' example: aliquam required: - membership_token /api/organization/me/delete: delete: summary: 'Destroy Me' description: 'Destroys the Organization linked with the authenticated Membership.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - Organizations requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: quo required: - membership_token /api/role/all: get: summary: Index description: 'Retrieve all Roles' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 1,\n \"name\": \"Ambassador\",\n \"level\": \"user\",\n \"created_at\": \"2021-01-12T12:21:56.000000Z\",\n \"updated_at\": \"2021-01-12T12:21:56.000000Z\",\n },\n {\n \"id\": 2,\n \"name\": \"Social Master\",\n \"level\": \"team_admin\",\n \"created_at\": \"2021-01-12T12:21:56.000000Z\",\n \"updated_at\": \"2021-01-12T12:21:56.000000Z\"\n }\n ]\n}" 404: description: '404, No Roles found' content: text/plain: schema: type: string example: 'There were no Roles found within our database.' tags: - Roles requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in' example: ut pagination: type: string description: 'The amount of items you want per page and the page you want to access separated by a comma.' example: '"2,3" The first number will be the amount of items per page, the second is the current page you want to access' required: - membership_token - pagination /api/role/resolve: get: summary: Resolve description: 'Search a Role with the given attributes.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 1,\n \"name\": \"Ambassador\",\n \"level\": \"user\",\n \"created_at\": \"2021-01-13T08:14:25.000000Z\",\n \"updated_at\": \"2021-01-13T08:14:25.000000Z\"\n }\n ]\n}" 404: description: '404, No Roles found' content: text/plain: schema: type: string example: 'There were no Roles found based on the query given.' tags: - Roles requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in' example: voluptatem search_query: type: string description: 'Any kind of attribute you want to query on, separating the attribute from the value with a semicolon. ("id;4 name;rolename")' example: quia required: - membership_token - search_query /api/role/me: get: summary: Me description: 'Get the details of Role of the logged in Member' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 404: description: '404, No Team found' content: text/plain: schema: type: string example: 'There was no Team found associated to the given Membership.' 500: description: '' content: application/json: schema: type: object example: success: false code: 113 locale: nl_NL message: Unauthenticated. data: null debug: { trace: { class: Illuminate\Auth\AuthenticationException, file: /home/vagrant/feniks/vendor/laravel/framework/src/Illuminate/Auth/Middleware/Authenticate.php, line: 82 } } properties: success: { type: boolean, example: false } code: { type: integer, example: 113 } locale: { type: string, example: nl_NL } message: { type: string, example: Unauthenticated. } data: { type: string, example: null } debug: { type: object, example: { trace: { class: Illuminate\Auth\AuthenticationException, file: /home/vagrant/feniks/vendor/laravel/framework/src/Illuminate/Auth/Middleware/Authenticate.php, line: 82 } } } tags: - Roles requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in' example: dolor required: - membership_token '/api/role/detail/{id}': get: summary: Show description: 'Show the details of a Role' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 3,\n \"name\": \"Brand Master\",\n \"level\": \"brand_admin\",\n \"created_at\": \"2021-01-12T12:21:56.000000Z\",\n \"updated_at\": \"2021-01-12T12:21:56.000000Z\"\n }\n ]\n}" 404: description: '404, No Role found' content: text/plain: schema: type: string example: 'There was no Role found with that ID.' tags: - Roles requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: voluptatem required: - membership_token parameters: - in: path name: id description: 'The ID of the Role that you want to show.' example: 8 required: true schema: type: integer /api/role/create: post: summary: Store description: 'Stores a single Role with the given parameters as attributes of said Role.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 201: description: '201, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"name\": \"Big Boss\",\n \"updated_at\": \"2021-01-13T08:46:55.000000Z\",\n \"created_at\": \"2021-01-13T08:46:55.000000Z\",\n \"id\": 134\n }\n ]\n}" 400: description: '400, Wrong values' content: text/plain: schema: type: string example: 'The given values to create the Role either already exist within the database or are of the wrong type.' 409: description: '409, Could not be created' content: text/plain: schema: type: string example: 'The Role could not be created.' tags: - Roles requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: consequatur name: type: string description: 'The name of the Role that you are trying to create.' example: optio required: - membership_token - name '/api/role/edit/{id}': patch: summary: Update description: 'Updates a single Role with the given parameters as the new attributes of the given Role.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"name\": \"Big Boss\",\n \"created_at\": \"2021-01-13T08:14:25.000000Z\",\n \"updated_at\": \"2021-01-13T08:56:33.000000Z\",\n \"id\": 134\n }\n ]\n}" 404: description: '404, Role not found' content: text/plain: schema: type: string example: 'Could not find the Role associated with the ID that was given.' tags: - Roles requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: eum name: type: string description: 'The new name of the Role that you want to edit.' example: incidunt required: - membership_token parameters: - in: path name: id description: '' example: tenetur required: true schema: type: string /api/role/delete: delete: summary: Destroy description: 'Destroys a single or list of Role based on the IDs given in the parameters.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 212: description: '212, Deleted' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 6,\n \"id\": 16,\n }\n ]\n\n}" 409: description: '409, Could not be deleted' content: text/plain: schema: type: string example: 'Some or all Roles given could not be deleted.' tags: - Roles requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: accusantium array: type: of description: 'id''s to delete' example: ut required: - membership_token /api/team/resolve: get: summary: Resolve description: 'Search a Team with the given attributes.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 1,\n \"name\": \"sit\",\n \"domain\": \"marquadth\",\n \"logo\": \"https://lorempixel.com/640/480/?95714\",\n \"created_at\": \"2021-01-13T08:14:25.000000Z\",\n \"updated_at\": \"2021-01-13T08:14:25.000000Z\",\n \"brand\": {\n \"id\": 1,\n \"name\": \"aspernatur\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"organization\": {\n \"id\": 5,\n \"name\": \"Bartell-Carter\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n }\n ]\n}" 404: description: '404, No Teams found' content: text/plain: schema: type: string example: 'There were no Teams found based on the query given.' tags: - Teams requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in' example: optio search_query: type: string description: 'Any kind of attribute you want to query on, separating the attribute from the value with a semicolon. ("id;4 name;teamname")' example: error required: - membership_token - search_query /api/team/me: get: summary: Me description: 'Get the details of Team of the logged in Member' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 59,\n \"name\": \"Kessler Ltd\",\n \"domain\": \"walsh\",\n \"logo\": \"https://lorempixel.com/640/480/?32874\",\n \"created_at\": \"2021-01-18T10:38:02.000000Z\",\n \"updated_at\": \"2021-01-18T10:38:02.000000Z\",\n \"brand\": {\n \"id\": 1,\n \"name\": \"aspernatur\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"organization\": {\n \"id\": 5,\n \"name\": \"Bartell-Carter\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n }\n ]\n}" 404: description: '404, No Team found' content: text/plain: schema: type: string example: 'There was no Team found associated to the given Membership.' tags: - Teams requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in' example: cum required: - membership_token /api/team/all: get: summary: Index description: 'Retrieve all Teams under the same Brand or Organization' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 59,\n \"name\": \"Kessler Ltd\",\n \"domain\": \"walsh\",\n \"logo\": \"https://lorempixel.com/640/480/?32874\",\n \"created_at\": \"2021-01-18T10:38:02.000000Z\",\n \"updated_at\": \"2021-01-18T10:38:02.000000Z\",\n \"brand_id\": 1,\n \"brand\": {\n \"id\": 1,\n \"name\": \"aspernatur\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"organization_id\": 5,\n \"organization\": {\n \"id\": 5,\n \"name\": \"Bartell-Carter\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n }\n ]\n}" 404: description: '404, No Team found' content: text/plain: schema: type: string example: 'There were no Teams found associated to the given Membership under the same Brand or Organization.' tags: - Teams requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in' example: modi type: type: string description: 'The level of indexing you want to have of all Teams. (brand, organization)' example: voluptatibus pagination: type: string description: 'The amount of items you want per page and the page you want to access separated by a comma.' example: '"2,3" The first number will be the amount of items per page, the second is the current page you want to access' required: - membership_token - pagination '/api/team/detail/{id}': get: summary: Show description: 'Show the details of a Team that is available under the same Brand or Organization.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 6,\n \"name\": \"Spinka, Roob and Bogan\",\n \"domain\": \"yundt\",\n \"logo\": \"https://lorempixel.com/640/480/?77923\",\n \"created_at\": \"2021-01-13T08:14:25.000000Z\",\n \"updated_at\": \"2021-01-13T08:14:25.000000Z\",\n \"brand\": {\n \"id\": 1,\n \"name\": \"aspernatur\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"organization\": {\n \"id\": 5,\n \"name\": \"Bartell-Carter\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n }\n ]\n}" 404: description: '404, No Team found' content: text/plain: schema: type: string example: 'There was no Team found with that ID.' 409: description: '409, Conflict' content: text/plain: schema: type: string example: 'The Team you''re trying to see does not fall under your Brand or Organization thus you are unauthorized.' tags: - Teams requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: incidunt type: type: string description: 'The level of indexing you want to have of all Teams. (Brand, Organization)' example: nulla required: - membership_token parameters: - in: path name: id description: 'The ID of the Team that you want to show.' example: 8 required: true schema: type: integer /api/team/create: post: summary: Store description: 'Stores a single Team with the given parameters as attributes of said Team.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, Brand not found' content: text/plain: schema: type: string example: 'status= 404 No Brand associated with the Membership could be found and thus no Team could be created.' 400: description: '400, Wrong values' content: text/plain: schema: type: string example: 'The given values to create the Team either already exist within the database or are of the wrong type.' 409: description: '409, Could not be created' content: text/plain: schema: type: string example: 'The Team could not be created.' tags: - Teams requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: corporis name: type: string description: 'The name of the Team that you are trying to create.' example: alias domain: type: string description: 'The domain name of the Team that you are trying to create.' example: qui logo: type: url description: 'A link to the logo of the Team that you are trying to create.' example: nihil brand_id: type: required description: 'The ID of the brand associated with the Team that you are trying to create.' example: ratione theme_id: type: The description: 'ID of the Theme that you want to use for the Team that you are trying to create.' example: atque required: - membership_token - name - domain '/api/team/edit/{id}': patch: summary: Update description: 'Updates a single Team with the given parameters as the new attributes of the given Team.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 59,\n \"name\": \"Kessler Ltd\",\n \"domain\": \"walsh\",\n \"logo\": \"https://lorempixel.com/640/480/?32874\",\n \"created_at\": \"2021-01-18T10:38:02.000000Z\",\n \"updated_at\": \"2021-01-18T10:38:02.000000Z\",\n \"brand\": {\n \"id\": 1,\n \"name\": \"aspernatur\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"organization\": {\n \"id\": 5,\n \"name\": \"Bartell-Carter\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n }\n ]\n}" 404: description: '404, Team not found' content: text/plain: schema: type: string example: 'Could not find the Team associated with the ID that was given.' tags: - Teams requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: atque name: type: string description: 'The new name of the Team that you''re updating.' example: laboriosam theme_id: type: integer description: 'The new ID of the Theme that you want to use for the Team that you''re updating.' example: 2 domain: type: The description: 'new name of the domain you want to use for the Team that you''re editing.' example: quis logo: type: url description: 'The new URL to the picture that you want to use for the Team.' example: sed required: - membership_token parameters: - in: path name: id description: 'The ID of the Team that you want to edit.' example: 20 required: true schema: type: integer /api/team/me/edit: patch: summary: 'Update Me' description: 'Updates the Team of the authenticated Membership with the given parameters as the new attributes of the given Team.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 59,\n \"name\": \"Kessler Ltd\",\n \"domain\": \"walsh\",\n \"logo\": \"https://lorempixel.com/640/480/?32874\",\n \"created_at\": \"2021-01-18T10:38:02.000000Z\",\n \"updated_at\": \"2021-01-18T10:38:02.000000Z\",\n \"brand\": {\n \"id\": 1,\n \"name\": \"aspernatur\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"organization\": {\n \"id\": 5,\n \"name\": \"Bartell-Carter\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n }\n ]\n}" tags: - Teams requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: est name: type: string description: 'The new name of the Team that you''re updating.' example: libero theme_id: type: integer description: 'The new ID of the Theme that you want to use for the Team that you''re updating.' example: 15 domain: type: The description: 'new name of the domain you want to use for the Team that you''re editing.' example: harum logo: type: url description: 'The new URL to the picture that you want to use for the Team.' example: ipsa required: - membership_token /api/team/delete: delete: summary: Destroy description: 'Destroys a single or list of Teams based on the IDs given in the parameters.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 212: description: '212, Deleted' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 37,\n \"id\": 17,\n }\n ]\n}" 409: description: '409, Could not be deleted' content: text/plain: schema: type: string example: 'Some or all Teams given could not be deleted.' tags: - Teams requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: dolores array: type: of description: 'id''s to delete' example: magnam required: - membership_token /api/team/me/delete: delete: summary: 'Destroy Me' description: 'Destroys the current Team.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - Teams requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: harum required: - membership_token /api/theme/all: get: summary: Index description: 'Retrieve all Themes under the same Team as the given Membership' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 1,\n \"name\": \"sunt\",\n \"active\": 0,\n \"logo\": \"https://lorempixel.com/640/480/?70291\",\n \"font\": \"Prof. Ole Upton\",\n \"text_color\": \"WhiteSmoke\",\n \"primary_color\": \"Tan\",\n \"secondary_color\": \"SeaShell\",\n \"background_color\": \"Purple\",\n \"created_at\": \"2021-01-18T10:38:02.000000Z\",\n \"updated_at\": \"2021-01-18T10:38:02.000000Z\",\n \"team_id\": 8,\n \"team\": {\n \"id\": 8,\n \"name\": \"Pfannerstill, Halvorson and Marquardt\",\n \"domain\": \"herman\",\n \"logo\": \"https://lorempixel.com/640/480/?51237\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"brand_id\": 6,\n \"brand\": {\n \"id\": 6,\n \"name\": \"ut\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"organization_id\": 10,\n \"organization\": {\n \"id\": 10,\n \"name\": \"Wintheiser, Barton and Beahan\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n }\n }\n ]\n}" 404: description: '404, No Themes found' content: text/plain: schema: type: string example: 'There were no Themes found associated to the Team of the given Membership.' tags: - Themes requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in' example: dolore pagination: type: string description: 'The amount of items you want per page and the page you want to access separated by a comma.' example: '"2,3" The first number will be the amount of items per page, the second is the current page you want to access' required: - membership_token - pagination /api/theme/resolve: get: summary: Resolve description: 'Search a Theme with the given attributes.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 1,\n \"name\": \"sunt\",\n \"active\": 0,\n \"logo\": \"https://lorempixel.com/640/480/?70291\",\n \"font\": \"Prof. Ole Upton\",\n \"text_color\": \"WhiteSmoke\",\n \"primary_color\": \"Tan\",\n \"secondary_color\": \"SeaShell\",\n \"background_color\": \"Purple\",\n \"created_at\": \"2021-01-18T10:38:02.000000Z\",\n \"updated_at\": \"2021-01-18T10:38:02.000000Z\",\n \"team\": {\n \"id\": 8,\n \"name\": \"Pfannerstill, Halvorson and Marquardt\",\n \"domain\": \"herman\",\n \"logo\": \"https://lorempixel.com/640/480/?51237\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"brand\": {\n \"id\": 6,\n \"name\": \"ut\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"organization\": {\n \"id\": 10,\n \"name\": \"Wintheiser, Barton and Beahan\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n }\n }\n ]\n}" 404: description: '404, No Themes found' content: text/plain: schema: type: string example: 'There were no Themes found based on the query given.' tags: - Themes requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in' example: non search_query: type: string description: 'Any kind of attribute you want to query on, separating the attribute from the value with a semicolon. ("id;4 name;themename")' example: sequi required: - membership_token - search_query '/api/theme/detail/{id}': get: summary: Show description: 'Show the details of a Theme' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 1,\n \"name\": \"sunt\",\n \"active\": 0,\n \"logo\": \"https://lorempixel.com/640/480/?70291\",\n \"font\": \"Prof. Ole Upton\",\n \"text_color\": \"WhiteSmoke\",\n \"primary_color\": \"Tan\",\n \"secondary_color\": \"SeaShell\",\n \"background_color\": \"Purple\",\n \"created_at\": \"2021-01-18T10:38:02.000000Z\",\n \"updated_at\": \"2021-01-18T10:38:02.000000Z\",\n \"team\": {\n \"id\": 8,\n \"name\": \"Pfannerstill, Halvorson and Marquardt\",\n \"domain\": \"herman\",\n \"logo\": \"https://lorempixel.com/640/480/?51237\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"brand\": {\n \"id\": 6,\n \"name\": \"ut\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"organization\": {\n \"id\": 10,\n \"name\": \"Wintheiser, Barton and Beahan\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n }\n }\n ]\n}" 404: description: '404, No Theme found' content: text/plain: schema: type: string example: 'There was no Theme found with that ID.' 409: description: '409, Conflict' content: text/plain: schema: type: string example: 'The Theme you''re trying to access does not belong to your Team.' tags: - Themes requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: in required: - membership_token parameters: - in: path name: id description: 'The ID of the Theme that you want to show.' example: 1 required: true schema: type: integer /api/theme/create: post: summary: Store description: 'Stores a single Theme with the given parameters as attributes of said Theme.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 201: description: '201, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 1,\n \"name\": \"sunt\",\n \"active\": 0,\n \"logo\": \"https://lorempixel.com/640/480/?70291\",\n \"font\": \"Prof. Ole Upton\",\n \"text_color\": \"WhiteSmoke\",\n \"primary_color\": \"Tan\",\n \"secondary_color\": \"SeaShell\",\n \"background_color\": \"Purple\",\n \"created_at\": \"2021-01-18T10:38:02.000000Z\",\n \"updated_at\": \"2021-01-18T10:38:02.000000Z\",\n \"team\": {\n \"id\": 8,\n \"name\": \"Pfannerstill, Halvorson and Marquardt\",\n \"domain\": \"herman\",\n \"logo\": \"https://lorempixel.com/640/480/?51237\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"brand\": {\n \"id\": 6,\n \"name\": \"ut\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"organization\": {\n \"id\": 10,\n \"name\": \"Wintheiser, Barton and Beahan\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n }\n }\n ]\n}" 400: description: '400, Wrong values' content: text/plain: schema: type: string example: 'The given values to create the Theme either already exist within the database or are of the wrong type.' 409: description: '409, Could not be created' content: text/plain: schema: type: string example: 'The Theme could not be created.' tags: - Themes requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: eius name: type: string description: 'The name of the Theme that you are trying to create.' example: similique logo: type: url description: 'The URL of the logo you want to use for the Theme.' example: facere font: type: string description: 'The name of the font you''ll be using for the new Theme.' example: aut text_color: type: string description: 'The colour of the text for the new Theme.' example: est primary_color: type: string description: 'The primary colour of the new Theme.' example: voluptatum secondary_color: type: string description: 'The secondary colour of the new Theme.' example: et background_color: type: string description: 'The colour of the background for the new Theme.' example: neque required: - membership_token - name '/api/theme/edit/{id}': patch: summary: Update description: 'Updates a single Theme with the given parameters as the new attributes of the given Theme.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 1,\n \"name\": \"sunt\",\n \"active\": 0,\n \"logo\": \"https://lorempixel.com/640/480/?70291\",\n \"font\": \"Prof. Ole Upton\",\n \"text_color\": \"WhiteSmoke\",\n \"primary_color\": \"Tan\",\n \"secondary_color\": \"SeaShell\",\n \"background_color\": \"Purple\",\n \"created_at\": \"2021-01-18T10:38:02.000000Z\",\n \"updated_at\": \"2021-01-18T10:38:02.000000Z\",\n \"team\": {\n \"id\": 8,\n \"name\": \"Pfannerstill, Halvorson and Marquardt\",\n \"domain\": \"herman\",\n \"logo\": \"https://lorempixel.com/640/480/?51237\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"brand\": {\n \"id\": 6,\n \"name\": \"ut\",\n \"created_at\": \"2021-02-02T12:15:41.000000Z\",\n \"updated_at\": \"2021-02-02T12:15:41.000000Z\",\n \"organization\": {\n \"id\": 10,\n \"name\": \"Wintheiser, Barton and Beahan\",\n \"created_at\": null,\n \"updated_at\": null\n }\n }\n }\n }\n ]\n}" 404: description: '404, Theme not found' content: text/plain: schema: type: string example: 'Could not find the Theme associated with the ID that was given.' tags: - Themes requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: voluptate name: type: string description: 'The name of the Theme that you are trying to create.' example: repellat logo: type: url description: 'The URL of the logo you want to use for the Theme.' example: quas font: type: string description: 'The name of the font you''ll be using for the new Theme.' example: quaerat text_color: type: string description: 'The colour of the text for the new Theme.' example: perferendis primary_color: type: string description: 'The primary colour of the new Theme.' example: architecto secondary_color: type: string description: 'The secondary colour of the new Theme.' example: praesentium background_color: type: string description: 'The colour of the background for the new Theme.' example: quasi required: - membership_token - name parameters: - in: path name: id description: '' example: aspernatur required: true schema: type: string /api/theme/delete: delete: summary: Destroy description: 'Destroys a single or list of Themes based on the IDs given in the parameters.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 212: description: '212, Deleted' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 4,\n \"id\": 14,\n }\n ]\n}" 409: description: '409, Could not be deleted' content: text/plain: schema: type: string example: 'Some or all Themes given could not be deleted.' tags: - Themes requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: ipsa array: type: of description: 'id''s to delete' example: sit required: - membership_token /api/user/resolve: get: summary: Resolve description: 'Search an User with the given attributes.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 1,\n \"first_name\": \"Manuela\",\n \"last_name\": \"Gulgowski\",\n \"dob\": \"1994-12-07\",\n \"email\": \"spencer.madie@russel.com\",\n \"phone\": \"640.573.2808 x666\",\n \"email_verified_at\": \"1984-10-11T23:00:00.000000Z\",\n \"consent\": 0,\n \"avatar\": \"https://lorempixel.com/640/480/?62835\",\n \"language\": \"nl\",\n \"created_at\": \"2021-01-19T10:28:33.000000Z\",\n \"deleted_at\": null,\n \"provider\": null,\n \"provider_id\": null\n }\n ]\n}" 404: description: '404, No Users found' content: text/plain: schema: type: string example: 'There were no Users found based on the query given.' tags: - Users requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in' example: ut search_query: type: string description: 'Any kind of attribute you want to query on, separating the attribute from the value with a semicolon. ("id;4 first_name;firstname")' example: dolore required: - membership_token - search_query /api/user/me: get: summary: Me description: 'Get the details of logged in Member' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 1,\n \"first_name\": \"Manuela\",\n \"last_name\": \"Gulgowski\",\n \"dob\": \"1994-12-07\",\n \"email\": \"spencer.madie@russel.com\",\n \"phone\": \"640.573.2808 x666\",\n \"email_verified_at\": \"1984-10-11T23:00:00.000000Z\",\n \"consent\": 0,\n \"avatar\": \"https://lorempixel.com/640/480/?62835\",\n \"language\": \"nl\",\n \"created_at\": \"2021-01-19T10:28:33.000000Z\",\n \"deleted_at\": null,\n \"provider\": null,\n \"provider_id\": null\n }\n ]\n}" 404: description: '404, User not found' content: text/plain: schema: type: string example: 'The User could not be found.' tags: - Users requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in' example: dolor required: - membership_token /api/user/all: get: summary: Index description: 'Retrieve all Users under the same Team, Brand or Organization' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 1,\n \"first_name\": \"Manuela\",\n \"last_name\": \"Gulgowski\",\n \"dob\": \"1994-12-07\",\n \"email\": \"spencer.madie@russel.com\",\n \"phone\": \"640.573.2808 x666\",\n \"email_verified_at\": \"1984-10-11T23:00:00.000000Z\",\n \"consent\": 0,\n \"avatar\": \"https://lorempixel.com/640/480/?62835\",\n \"language\": \"nl\",\n \"created_at\": \"2021-01-19T10:28:33.000000Z\",\n \"deleted_at\": null,\n \"provider\": null,\n \"provider_id\": null\n }\n ]\n}" 404: description: '404, No Users found' content: text/plain: schema: type: string example: 'There were no Users found within our database.' tags: - Users requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in' example: deleniti type: type: string description: 'The level of indexing you want to have of all Users. (team, brand, organization)' example: dolorem pagination: type: string description: 'The amount of items you want per page and the page you want to access separated by a comma.' example: '"2,3" The first number will be the amount of items per page, the second is the current page you want to access' required: - membership_token - pagination '/api/user/detail/{id}': get: summary: Show description: 'Show the details of a User that is available under the same Team, Brand or Organization.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 8,\n \"first_name\": \"Torrey\",\n \"last_name\": \"Eichmann\",\n \"dob\": \"2007-12-31\",\n \"email\": \"layne.hagenes@osinski.com\",\n \"phone\": \"752-632-8081\",\n \"email_verified_at\": \"2015-12-15T23:00:00.000000Z\",\n \"consent\": 0,\n \"avatar\": \"https://lorempixel.com/640/480/?91458\",\n \"language\": \"nl\",\n \"created_at\": \"2021-01-19T10:28:33.000000Z\",\n \"deleted_at\": null,\n \"provider\": null,\n \"provider_id\": null\n }\n ]\n}" 404: description: '404, No User found' content: text/plain: schema: type: string example: 'There was no User found with that ID.' 409: description: '409, Conflict' content: text/plain: schema: type: string example: 'The User you''re trying to see does not fall under your Team, Brand or Organization, thus you are unauthorized.' tags: - Users requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: voluptas type: type: string description: 'The level of indexing you want to have of all Users. (team, brand, organization)' example: aut required: - membership_token parameters: - in: path name: id description: 'The ID of the User that you want to show.' example: 12 required: true schema: type: integer /api/user/create: post: summary: Store description: 'Stores a single User with the given parameters as attributes of said User.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 201: description: '201, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"email\": \"test@gmail.com\",\n \"first_name\": \"Rick\",\n \"last_name\": \"Martens\",\n \"created_at\": \"2021-01-19T11:40:17.000000Z\",\n \"id\": 101\n }\n ]\n}" 400: description: '400, Wrong values' content: text/plain: schema: type: string example: 'The given values to create the User either already exist within the database or are of the wrong type.' 409: description: '409, Could not be created' content: text/plain: schema: type: string example: 'The User could not be created.' tags: - Users requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: nihil email: type: string description: 'The email of the User that you are trying to create.' example: nisi password: type: string description: 'The password of the User that you are trying to create.' example: nihil first_name: type: string description: 'The first name of the User that you are trying to create.' example: vel last_name: type: string description: 'The last name of the User that you are trying to create.' example: rem dob: type: date description: 'The date of birth of the User that you are trying to create.' example: commodi phone: type: string description: 'The phone number of the User that you are trying to create.' example: delectus language: type: string description: 'A combination of letters standing for the language of the User that you are trying to create.' example: sed required: - membership_token - email - password '/api/user/edit/{id}': patch: summary: Update description: 'Updates a single User with the given parameters as the new attributes of the given User.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '200, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"email\": \"test@gmail.com\",\n \"first_name\": \"Rick\",\n \"last_name\": \"Martens\",\n \"created_at\": \"2021-01-19T11:40:17.000000Z\",\n \"id\": 101\n }\n ]\n}" 404: description: '404, User not found' content: text/plain: schema: type: string example: 'Could not find the User associated with the ID that was given.' 409: description: '409, Conflict' content: text/plain: schema: type: string example: 'The User could not be updated.' tags: - Users requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: accusamus email: type: string description: 'The email of the User that you are trying to edit.' example: recusandae password: type: string description: 'The password of the User that you are trying to edit.' example: officia first_name: type: string description: 'The first name of the User that you are trying to edit.' example: inventore last_name: type: string description: 'The last name of the User that you are trying to edit.' example: quis dob: type: date description: 'The date of birth of the User that you are trying to edit.' example: reiciendis phone: type: string description: 'The phone number of the User that you are trying to edit.' example: itaque language: type: string description: 'A combination of letters standing for the language of the User that you are trying to edit.' example: hic consent: type: boolean description: 'A boolean signifying if the User consented to the terms and conditions.' example: false avatar: type: url description: 'A URL leading to the image the User wants to use as their avatar.' example: repudiandae required: - membership_token - email - password parameters: - in: path name: id description: 'The ID of the Membership that you want to edit.' example: 19 required: true schema: type: integer /api/user/me/edit: patch: summary: 'Update Me' description: 'Updates the authenticated User with the given parameters.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 201: description: '201, success' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"email\": \"test@gmail.com\",\n \"first_name\": \"Rick\",\n \"last_name\": \"Martens\",\n \"created_at\": \"2021-01-19T11:40:17.000000Z\",\n \"id\": 101\n }\n ]\n}" 404: description: '404, User not found' content: text/plain: schema: type: string example: 'Could not find the User associated with the ID that was given.' 409: description: '409, Conflict' content: text/plain: schema: type: string example: 'The User could not be updated.' tags: - Users requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: soluta email: type: string description: 'The email of the User that you are trying to edit.' example: officiis password: type: string description: 'The password of the User that you are trying to edit.' example: sit first_name: type: string description: 'The first name of the User that you are trying to edit.' example: ex last_name: type: string description: 'The last name of the User that you are trying to edit.' example: vero dob: type: date description: 'The date of birth of the User that you are trying to edit.' example: cupiditate phone: type: string description: 'The phone number of the User that you are trying to edit.' example: iste language: type: string description: 'A combination of letters standing for the language of the User that you are trying to edit.' example: veniam consent: type: boolean description: 'A boolean signifying if the User consented to the terms and conditions.' example: false avatar: type: url description: 'A URL leading to the image the User wants to use as their avatar.' example: a required: - membership_token - email - password /api/user/delete: delete: summary: Destroy description: 'Destroys a single or list of Users based on the IDs given in the parameters.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 212: description: '212, Deleted' content: text/plain: schema: type: string example: "\"data\": {\n \"items\": [\n {\n \"id\": 8,\n \"id\": 81,\n }\n ]\n}" 409: description: '409, Could not be deleted' content: text/plain: schema: type: string example: 'Some or all Users given could not be deleted.' tags: - Users requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The User access-token that came back when logged in.' example: mollitia array: type: of description: 'id''s to delete' example: facilis required: - membership_token /api/user/me/delete: delete: summary: 'Destroy Me' description: 'Destroys the authenticated User.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - Users requestBody: required: true content: application/json: schema: type: object properties: membership_token: type: string description: 'The Membership access-token that came back when logged in.' example: perferendis required: - membership_token components: securitySchemes: default: type: http scheme: bearer description: '' security: - default: []