{"openapi":"3.1.0","info":{"title":"Smart Parser API","description":"API Service for parsing resumes","version":"1.2.0"},"paths":{"/api/v1/cv/filters/":{"get":{"tags":["cv"],"summary":"Get Filters","description":"Return all client's filters","operationId":"get_filters_api_v1_cv_filters__get","security":[{"HTTPClientInternalCredentials":[]},{"External Token":[]}],"parameters":[{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {client-token}"},"description":"Bearer {client-token}"},{"name":"x-forwarded-host","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Forwarded-Host"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FilterQueryResponseDTO"},"title":"Response Get Filters Api V1 Cv Filters Get"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"Time in seconds left before next allowed request","schema":{"type":"float"}},"X-Rate-Limit":{"description":"The number of allowed requests in the current period","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["cv"],"summary":"Create Filter","description":"# Create filter instance.\n\nTo create filter you need to specify: `operation`, `values`, `field`, `subqueries`\n\n# Operations:\nThis is enum field, but these enum-values are distributed into groups:\n\n1. Operations for complex queries: `and`, `or`\n2. Operations for string queries:\n `exact`, `iexact`, `not_exact`, `not_iexact`,\n `like` `ilike`, `not_like` `not_ilike`,\n `startswith` `endswith` `istartswith`, `iendswith`. \n\n `i`-prefix means case-insensitive\n3. Operations for compare queries:\n `eq`(equal), `ne`(not equal),\n `gt`(greater than), `lt`(less than),\n `ge`(greater or equal), `le`(less or equal)\n4. Set operations:\n `in`, `not_in`, `between`, `not_between`,\n `contains`, `not_contains`\n\n> Complex query-instance requires `subqueries`, other operations require `values` and `field`\n\n# Subqueries:\nThat is just a list of references to other filter-queries, with the same structure, but without `title` field.\n\n# Values and Field:\n- values: object with key `data` and value any of supported by given operation and given field type\n- field: field name, which can refer to nested fields as well.\n for nested fields use __*double*__ underscore as separator, `__`\n\nexample:\n\n```\n# tables, where User's fields are the root one:\nUser:\n profile: Profile\n username: string\n created_at: datetime\n\nProfile:\n age: number\n phone: string\n languages: array[string]\n\n# `field` and `values` for request body:\n- {\"field\": \"username\", \"values\": {\"data\": \"john\"}}\n- {\"field\": \"created_at\", \"values\": {\"data\": \"2022-01-01\"}}\n- {\"field\": \"profile__age\", \"values\": {\"data\": 25}}\n```\n\n# Supported field/values types for different operations\n\n1. For String operations:\n - field: any field of string type\n - values: `{\"data\": }`\n\n2. For Compare operations:\n - field: any field of types: number, date, datetime\n - values: `{\"data\": | | }`\n - boolean fields and values supported as well but only for `eq` and `ne`\n\n3. For Operations `in`, `not_in`:\n - field: any field of any type, excluding arrays\n - values: `{\"data\": [any type suitable for given field]}`\n\n4. For Operations `between`, `not_between`:\n - field: any field of types: number, date, datetime\n - values: `{\"data\": [ | | ]}`. Exactly 2 values are expected in array\n\n5. For Operations `contains`, `not_contains`:\n - field: any field of type array[string]\n - values: `{\"data\": }`\n\n# Fields for filter queries, where CV's fields are the root one:\n```\nCV:\n status: enum(CVProcessingStatus)\n filename: string\n created_at: datetime\n updated_at: datetime\n person: Person\n\n\nPerson:\n names: string\n orig_names: string\n birthday_date: date\n real_age: number\n age: number\n birthday_year: number\n about_me: string\n orig_about_me: string\n skills: array[string]\n orig_skills: array[string]\n languages: array[string]\n orig_languages: array[string]\n proficiency: array[string]\n orig_proficiency: array[string]\n experience_overall_time_month: number\n does_end_date_anywhere_stated: bool\n contacts_info: Contacts\n institutions: array[Institution]\n experience: array[Job]\n courses: array[Course]\n created_at: datetime\n\n\nContacts:\n emails: string\n phones: string\n telegram: string\n github: string\n\n\nInstitution:\n university_name: string\n orig_university_name: string\n education_field: string\n orig_education_field: string\n start_date: date\n end_date: date\n until_now: bool\n transcript_university_name: string\n\nJob:\n company_name: string\n orig_company_name: string\n job_title: string\n orig_job_title: string\n legal_suffix: string\n clear_company_name: string\n start_date: date\n end_date: date\n overall_time_month: number\n until_now: bool\n job_grade: string\n start_of_description: string\n end_of_description: string\n orig_description: string\n project_description: string\n orig_project_description: string\n achievements: array[string]\n orig_achievements: array[string]\n responsibilities: array[string]\n orig_responsibilities: array[string]\n root_cluster: array[string]\n competencies_cluster: array[string]\n knowledge: array[string]\n tools: array[string]\n abilities: array[string]\n is_description_orig_short: bool\n is_tools_non_specific: bool\n\nCourse:\n course_provider: string\n orig_course_provider: string\n education_field: string\n orig_education_field: string\n start_date: date\n end_date: date\n until_now: bool\n```","operationId":"create_filter_api_v1_cv_filters__post","security":[{"HTTPClientInternalCredentials":[]},{"External Token":[]}],"parameters":[{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {client-token}"},"description":"Bearer {client-token}"},{"name":"x-forwarded-host","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Forwarded-Host"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilterQueryDTO"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilterQueryDetailedResponseDTO"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"Time in seconds left before next allowed request","schema":{"type":"float"}},"X-Rate-Limit":{"description":"The number of allowed requests in the current period","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/cv/filters/{filter_id}/":{"get":{"tags":["cv"],"summary":"Get Filter Detailed","description":"Return details of filter","operationId":"get_filter_detailed_api_v1_cv_filters__filter_id___get","security":[{"HTTPClientInternalCredentials":[]},{"External Token":[]}],"parameters":[{"name":"filter_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Filter Id"}},{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {client-token}"},"description":"Bearer {client-token}"},{"name":"x-forwarded-host","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Forwarded-Host"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilterQueryDetailedResponseDTO"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"Time in seconds left before next allowed request","schema":{"type":"float"}},"X-Rate-Limit":{"description":"The number of allowed requests in the current period","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilterQueryNotFoundDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["cv"],"summary":"Delete Filter Detailed","description":"Return all client's filters","operationId":"delete_filter_detailed_api_v1_cv_filters__filter_id___delete","security":[{"HTTPClientInternalCredentials":[]},{"External Token":[]}],"parameters":[{"name":"filter_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Filter Id"}},{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {client-token}"},"description":"Bearer {client-token}"},{"name":"x-forwarded-host","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Forwarded-Host"}}],"responses":{"204":{"description":"Successful Response"},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"Time in seconds left before next allowed request","schema":{"type":"float"}},"X-Rate-Limit":{"description":"The number of allowed requests in the current period","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilterQueryNotFoundDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/cv/{cv_id}/":{"get":{"tags":["cv"],"summary":"Get Cv Detailed","operationId":"get_cv_detailed_api_v1_cv__cv_id___get","security":[{"HTTPClientInternalCredentials":[]},{"External Token":[]}],"parameters":[{"name":"cv_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Cv Id"}},{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {client-token}"},"description":"Bearer {client-token}"},{"name":"x-forwarded-host","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Forwarded-Host"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CVDetailedDTO"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"Time in seconds left before next allowed request","schema":{"type":"float"}},"X-Rate-Limit":{"description":"The number of allowed requests in the current period","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CVNotFoundDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["cv"],"summary":"Delete Cv","operationId":"delete_cv_api_v1_cv__cv_id___delete","security":[{"HTTPClientInternalCredentials":[]},{"External Token":[]}],"parameters":[{"name":"cv_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Cv Id"}},{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {client-token}"},"description":"Bearer {client-token}"},{"name":"x-forwarded-host","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Forwarded-Host"}}],"responses":{"204":{"description":"Successful Response"},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"Time in seconds left before next allowed request","schema":{"type":"float"}},"X-Rate-Limit":{"description":"The number of allowed requests in the current period","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/cv/{cv_id}/with-full-text/":{"get":{"tags":["cv"],"summary":"Get Cv With Full Text","operationId":"get_cv_with_full_text_api_v1_cv__cv_id__with_full_text__get","security":[{"HTTPClientInternalCredentials":[]},{"External Token":[]}],"parameters":[{"name":"cv_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Cv Id"}},{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {client-token}"},"description":"Bearer {client-token}"},{"name":"x-forwarded-host","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Forwarded-Host"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CVWithFullTextDTO"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"Time in seconds left before next allowed request","schema":{"type":"float"}},"X-Rate-Limit":{"description":"The number of allowed requests in the current period","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CVNotFoundDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/cv/":{"get":{"tags":["cv"],"summary":"Get Cv List","description":"# CVs List.\n\nif you have specified a `filter_id`, you'll get the filtered list by created filter before.\nTo create filter, check the [`POST /api/v1/cv/filters/`](#/cv/create_filter_api_v1_cv_filters__post) endpoint.","operationId":"get_cv_list_api_v1_cv__get","security":[{"HTTPClientInternalCredentials":[]},{"External Token":[]}],"parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/CVProcessingStatus"},{"type":"null"}],"title":"Status"}},{"name":"filter_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Filter Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Page size","default":50,"title":"Size"},"description":"Page size"},{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {client-token}"},"description":"Bearer {client-token}"},{"name":"x-forwarded-host","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Forwarded-Host"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_CVDTO_"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"Time in seconds left before next allowed request","schema":{"type":"float"}},"X-Rate-Limit":{"description":"The number of allowed requests in the current period","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilterQueryNotFoundDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["cv"],"summary":"Upload Cv","operationId":"upload_cv_api_v1_cv__post","security":[{"HTTPClientInternalCredentials":[]},{"External Token":[]}],"parameters":[{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {client-token}"},"description":"Bearer {client-token}"},{"name":"x-forwarded-host","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Forwarded-Host"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_cv_api_v1_cv__post"}}}},"callbacks":{"notify_cv_parsing_success":{"${webhook_url}":{"post":{"summary":"CV Parsing Success Notification","description":"This callback is sent by the CV parsing service when the CV analysis is **successful**. The parsed CV data will be sent to the ***{webhook_url}***.","operationId":"notify_cv_parsing_success__webhook_url__post","parameters":[{"name":"X-Hub-Signature","in":"header","required":true,"schema":{"type":"string","title":"X-Hub-Signature","description":"\nHeader for verifying the origin of the webhook.\n\n### X-Hub-Signature Calculation\n\nTo ensure the integrity and authenticity of the webhook, calculate the signature using the HMAC-SHA256 algorithm. This involves the following steps:\n\n1. **Fetch the Secret Key:** Retrieve the `webhook_secret_key` from your provider or client (you should to do this once and save `webhook_secret_key` to environment variable).\n2. **Prepare the Message:** Concatenate the HTTP method, webhook URL, and the JSON-encoded request body.\n3. **Compute the HMAC:** Use the `webhook_secret_key` to create an HMAC-SHA256 hash of the prepared message.\n\nThe computed hash should be compared with the `X-Hub-Signature` header of the webhook request.\n\n### Example Python Code\n\n```python\nimport hmac\nimport hashlib\nimport json\n\ndef calculate_signature(\n webhook_secret_key: str,\n http_method: str,\n webhook_url: str,\n payload: dict,\n) -> str:\n payload_json = json.dumps(payload)\n msg = f\"{http_method}{webhook_url}{payload_json}\"\n return hmac.new(\n webhook_secret_key.encode(),\n msg=msg.encode(),\n digestmod=hashlib.sha256,\n ).hexdigest()\n```\n\n### Example Usage\n\n```python\nwebhook_secret_key = \"your_webhook_secret_key\"\nhttp_method = \"POST\"\nwebhook_url = \"https://example.com/webhook\"\npayload = {\"key\": \"value\"}\n\nsignature = calculate_signature(webhook_secret_key, http_method, webhook_url, payload)\nprint(\"X-Hub-Signature:\", signature) # X-Hub-Signature: 59aac07ecc725304506f5c86aa8dfb75f788ed11d3531662be39daf379f013dc\n```\n"},"description":"\nHeader for verifying the origin of the webhook.\n\n### X-Hub-Signature Calculation\n\nTo ensure the integrity and authenticity of the webhook, calculate the signature using the HMAC-SHA256 algorithm. This involves the following steps:\n\n1. **Fetch the Secret Key:** Retrieve the `webhook_secret_key` from your provider or client (you should to do this once and save `webhook_secret_key` to environment variable).\n2. **Prepare the Message:** Concatenate the HTTP method, webhook URL, and the JSON-encoded request body.\n3. **Compute the HMAC:** Use the `webhook_secret_key` to create an HMAC-SHA256 hash of the prepared message.\n\nThe computed hash should be compared with the `X-Hub-Signature` header of the webhook request.\n\n### Example Python Code\n\n```python\nimport hmac\nimport hashlib\nimport json\n\ndef calculate_signature(\n webhook_secret_key: str,\n http_method: str,\n webhook_url: str,\n payload: dict,\n) -> str:\n payload_json = json.dumps(payload)\n msg = f\"{http_method}{webhook_url}{payload_json}\"\n return hmac.new(\n webhook_secret_key.encode(),\n msg=msg.encode(),\n digestmod=hashlib.sha256,\n ).hexdigest()\n```\n\n### Example Usage\n\n```python\nwebhook_secret_key = \"your_webhook_secret_key\"\nhttp_method = \"POST\"\nwebhook_url = \"https://example.com/webhook\"\npayload = {\"key\": \"value\"}\n\nsignature = calculate_signature(webhook_secret_key, http_method, webhook_url, payload)\nprint(\"X-Hub-Signature:\", signature) # X-Hub-Signature: 59aac07ecc725304506f5c86aa8dfb75f788ed11d3531662be39daf379f013dc\n```\n"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SucceededCVParsingWebhookDTO"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"notify_cv_parsing_failure":{"${webhook_url}":{"post":{"summary":"CV Parsing Failure Notification","description":"This callback is sent by the CV parsing service when the CV analysis **fails**. The initial CV object data will be sent to the ***{webhook_url}***.","operationId":"notify_cv_parsing_failure__webhook_url__post","parameters":[{"name":"X-Hub-Signature","in":"header","required":true,"schema":{"type":"string","title":"X-Hub-Signature","description":"\nHeader for verifying the origin of the webhook.\n\n### X-Hub-Signature Calculation\n\nTo ensure the integrity and authenticity of the webhook, calculate the signature using the HMAC-SHA256 algorithm. This involves the following steps:\n\n1. **Fetch the Secret Key:** Retrieve the `webhook_secret_key` from your provider or client (you should to do this once and save `webhook_secret_key` to environment variable).\n2. **Prepare the Message:** Concatenate the HTTP method, webhook URL, and the JSON-encoded request body.\n3. **Compute the HMAC:** Use the `webhook_secret_key` to create an HMAC-SHA256 hash of the prepared message.\n\nThe computed hash should be compared with the `X-Hub-Signature` header of the webhook request.\n\n### Example Python Code\n\n```python\nimport hmac\nimport hashlib\nimport json\n\ndef calculate_signature(\n webhook_secret_key: str,\n http_method: str,\n webhook_url: str,\n payload: dict,\n) -> str:\n payload_json = json.dumps(payload)\n msg = f\"{http_method}{webhook_url}{payload_json}\"\n return hmac.new(\n webhook_secret_key.encode(),\n msg=msg.encode(),\n digestmod=hashlib.sha256,\n ).hexdigest()\n```\n\n### Example Usage\n\n```python\nwebhook_secret_key = \"your_webhook_secret_key\"\nhttp_method = \"POST\"\nwebhook_url = \"https://example.com/webhook\"\npayload = {\"key\": \"value\"}\n\nsignature = calculate_signature(webhook_secret_key, http_method, webhook_url, payload)\nprint(\"X-Hub-Signature:\", signature) # X-Hub-Signature: 59aac07ecc725304506f5c86aa8dfb75f788ed11d3531662be39daf379f013dc\n```\n"},"description":"\nHeader for verifying the origin of the webhook.\n\n### X-Hub-Signature Calculation\n\nTo ensure the integrity and authenticity of the webhook, calculate the signature using the HMAC-SHA256 algorithm. This involves the following steps:\n\n1. **Fetch the Secret Key:** Retrieve the `webhook_secret_key` from your provider or client (you should to do this once and save `webhook_secret_key` to environment variable).\n2. **Prepare the Message:** Concatenate the HTTP method, webhook URL, and the JSON-encoded request body.\n3. **Compute the HMAC:** Use the `webhook_secret_key` to create an HMAC-SHA256 hash of the prepared message.\n\nThe computed hash should be compared with the `X-Hub-Signature` header of the webhook request.\n\n### Example Python Code\n\n```python\nimport hmac\nimport hashlib\nimport json\n\ndef calculate_signature(\n webhook_secret_key: str,\n http_method: str,\n webhook_url: str,\n payload: dict,\n) -> str:\n payload_json = json.dumps(payload)\n msg = f\"{http_method}{webhook_url}{payload_json}\"\n return hmac.new(\n webhook_secret_key.encode(),\n msg=msg.encode(),\n digestmod=hashlib.sha256,\n ).hexdigest()\n```\n\n### Example Usage\n\n```python\nwebhook_secret_key = \"your_webhook_secret_key\"\nhttp_method = \"POST\"\nwebhook_url = \"https://example.com/webhook\"\npayload = {\"key\": \"value\"}\n\nsignature = calculate_signature(webhook_secret_key, http_method, webhook_url, payload)\nprint(\"X-Hub-Signature:\", signature) # X-Hub-Signature: 59aac07ecc725304506f5c86aa8dfb75f788ed11d3531662be39daf379f013dc\n```\n"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailedCVParsingWebhookDTO"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CVDTO"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"Time in seconds left before next allowed request","schema":{"type":"float"}},"X-Rate-Limit":{"description":"The number of allowed requests in the current period","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"415":{"description":"Unsupported media type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeDTO"}}}},"402":{"description":"No credits left on provider","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoCreditsLeftOnProviderDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["cv"],"summary":"Delete All Cv","operationId":"delete_all_cv_api_v1_cv__delete","security":[{"HTTPClientInternalCredentials":[]},{"External Token":[]}],"parameters":[{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {client-token}"},"description":"Bearer {client-token}"},{"name":"x-forwarded-host","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Forwarded-Host"}}],"responses":{"204":{"description":"Successful Response"},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"Time in seconds left before next allowed request","schema":{"type":"float"}},"X-Rate-Limit":{"description":"The number of allowed requests in the current period","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/cv/bulk/":{"post":{"tags":["cv"],"summary":"Upload Cv Bulk","operationId":"upload_cv_bulk_api_v1_cv_bulk__post","security":[{"HTTPClientInternalCredentials":[]},{"External Token":[]}],"parameters":[{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {client-token}"},"description":"Bearer {client-token}"},{"name":"x-forwarded-host","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Forwarded-Host"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_cv_bulk_api_v1_cv_bulk__post"}}}},"callbacks":{"notify_cv_parsing_success":{"${webhook_url}":{"post":{"summary":"CV Parsing Success Notification","description":"This callback is sent by the CV parsing service when the CV analysis is **successful**. The parsed CV data will be sent to the ***{webhook_url}***.","operationId":"notify_cv_parsing_success__webhook_url__post","parameters":[{"name":"X-Hub-Signature","in":"header","required":true,"schema":{"type":"string","title":"X-Hub-Signature","description":"\nHeader for verifying the origin of the webhook.\n\n### X-Hub-Signature Calculation\n\nTo ensure the integrity and authenticity of the webhook, calculate the signature using the HMAC-SHA256 algorithm. This involves the following steps:\n\n1. **Fetch the Secret Key:** Retrieve the `webhook_secret_key` from your provider or client (you should to do this once and save `webhook_secret_key` to environment variable).\n2. **Prepare the Message:** Concatenate the HTTP method, webhook URL, and the JSON-encoded request body.\n3. **Compute the HMAC:** Use the `webhook_secret_key` to create an HMAC-SHA256 hash of the prepared message.\n\nThe computed hash should be compared with the `X-Hub-Signature` header of the webhook request.\n\n### Example Python Code\n\n```python\nimport hmac\nimport hashlib\nimport json\n\ndef calculate_signature(\n webhook_secret_key: str,\n http_method: str,\n webhook_url: str,\n payload: dict,\n) -> str:\n payload_json = json.dumps(payload)\n msg = f\"{http_method}{webhook_url}{payload_json}\"\n return hmac.new(\n webhook_secret_key.encode(),\n msg=msg.encode(),\n digestmod=hashlib.sha256,\n ).hexdigest()\n```\n\n### Example Usage\n\n```python\nwebhook_secret_key = \"your_webhook_secret_key\"\nhttp_method = \"POST\"\nwebhook_url = \"https://example.com/webhook\"\npayload = {\"key\": \"value\"}\n\nsignature = calculate_signature(webhook_secret_key, http_method, webhook_url, payload)\nprint(\"X-Hub-Signature:\", signature) # X-Hub-Signature: 59aac07ecc725304506f5c86aa8dfb75f788ed11d3531662be39daf379f013dc\n```\n"},"description":"\nHeader for verifying the origin of the webhook.\n\n### X-Hub-Signature Calculation\n\nTo ensure the integrity and authenticity of the webhook, calculate the signature using the HMAC-SHA256 algorithm. This involves the following steps:\n\n1. **Fetch the Secret Key:** Retrieve the `webhook_secret_key` from your provider or client (you should to do this once and save `webhook_secret_key` to environment variable).\n2. **Prepare the Message:** Concatenate the HTTP method, webhook URL, and the JSON-encoded request body.\n3. **Compute the HMAC:** Use the `webhook_secret_key` to create an HMAC-SHA256 hash of the prepared message.\n\nThe computed hash should be compared with the `X-Hub-Signature` header of the webhook request.\n\n### Example Python Code\n\n```python\nimport hmac\nimport hashlib\nimport json\n\ndef calculate_signature(\n webhook_secret_key: str,\n http_method: str,\n webhook_url: str,\n payload: dict,\n) -> str:\n payload_json = json.dumps(payload)\n msg = f\"{http_method}{webhook_url}{payload_json}\"\n return hmac.new(\n webhook_secret_key.encode(),\n msg=msg.encode(),\n digestmod=hashlib.sha256,\n ).hexdigest()\n```\n\n### Example Usage\n\n```python\nwebhook_secret_key = \"your_webhook_secret_key\"\nhttp_method = \"POST\"\nwebhook_url = \"https://example.com/webhook\"\npayload = {\"key\": \"value\"}\n\nsignature = calculate_signature(webhook_secret_key, http_method, webhook_url, payload)\nprint(\"X-Hub-Signature:\", signature) # X-Hub-Signature: 59aac07ecc725304506f5c86aa8dfb75f788ed11d3531662be39daf379f013dc\n```\n"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SucceededCVParsingWebhookDTO"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"notify_cv_parsing_failure":{"${webhook_url}":{"post":{"summary":"CV Parsing Failure Notification","description":"This callback is sent by the CV parsing service when the CV analysis **fails**. The initial CV object data will be sent to the ***{webhook_url}***.","operationId":"notify_cv_parsing_failure__webhook_url__post","parameters":[{"name":"X-Hub-Signature","in":"header","required":true,"schema":{"type":"string","title":"X-Hub-Signature","description":"\nHeader for verifying the origin of the webhook.\n\n### X-Hub-Signature Calculation\n\nTo ensure the integrity and authenticity of the webhook, calculate the signature using the HMAC-SHA256 algorithm. This involves the following steps:\n\n1. **Fetch the Secret Key:** Retrieve the `webhook_secret_key` from your provider or client (you should to do this once and save `webhook_secret_key` to environment variable).\n2. **Prepare the Message:** Concatenate the HTTP method, webhook URL, and the JSON-encoded request body.\n3. **Compute the HMAC:** Use the `webhook_secret_key` to create an HMAC-SHA256 hash of the prepared message.\n\nThe computed hash should be compared with the `X-Hub-Signature` header of the webhook request.\n\n### Example Python Code\n\n```python\nimport hmac\nimport hashlib\nimport json\n\ndef calculate_signature(\n webhook_secret_key: str,\n http_method: str,\n webhook_url: str,\n payload: dict,\n) -> str:\n payload_json = json.dumps(payload)\n msg = f\"{http_method}{webhook_url}{payload_json}\"\n return hmac.new(\n webhook_secret_key.encode(),\n msg=msg.encode(),\n digestmod=hashlib.sha256,\n ).hexdigest()\n```\n\n### Example Usage\n\n```python\nwebhook_secret_key = \"your_webhook_secret_key\"\nhttp_method = \"POST\"\nwebhook_url = \"https://example.com/webhook\"\npayload = {\"key\": \"value\"}\n\nsignature = calculate_signature(webhook_secret_key, http_method, webhook_url, payload)\nprint(\"X-Hub-Signature:\", signature) # X-Hub-Signature: 59aac07ecc725304506f5c86aa8dfb75f788ed11d3531662be39daf379f013dc\n```\n"},"description":"\nHeader for verifying the origin of the webhook.\n\n### X-Hub-Signature Calculation\n\nTo ensure the integrity and authenticity of the webhook, calculate the signature using the HMAC-SHA256 algorithm. This involves the following steps:\n\n1. **Fetch the Secret Key:** Retrieve the `webhook_secret_key` from your provider or client (you should to do this once and save `webhook_secret_key` to environment variable).\n2. **Prepare the Message:** Concatenate the HTTP method, webhook URL, and the JSON-encoded request body.\n3. **Compute the HMAC:** Use the `webhook_secret_key` to create an HMAC-SHA256 hash of the prepared message.\n\nThe computed hash should be compared with the `X-Hub-Signature` header of the webhook request.\n\n### Example Python Code\n\n```python\nimport hmac\nimport hashlib\nimport json\n\ndef calculate_signature(\n webhook_secret_key: str,\n http_method: str,\n webhook_url: str,\n payload: dict,\n) -> str:\n payload_json = json.dumps(payload)\n msg = f\"{http_method}{webhook_url}{payload_json}\"\n return hmac.new(\n webhook_secret_key.encode(),\n msg=msg.encode(),\n digestmod=hashlib.sha256,\n ).hexdigest()\n```\n\n### Example Usage\n\n```python\nwebhook_secret_key = \"your_webhook_secret_key\"\nhttp_method = \"POST\"\nwebhook_url = \"https://example.com/webhook\"\npayload = {\"key\": \"value\"}\n\nsignature = calculate_signature(webhook_secret_key, http_method, webhook_url, payload)\nprint(\"X-Hub-Signature:\", signature) # X-Hub-Signature: 59aac07ecc725304506f5c86aa8dfb75f788ed11d3531662be39daf379f013dc\n```\n"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailedCVParsingWebhookDTO"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CVDTO"},"title":"Response Upload Cv Bulk Api V1 Cv Bulk Post"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"Time in seconds left before next allowed request","schema":{"type":"float"}},"X-Rate-Limit":{"description":"The number of allowed requests in the current period","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"415":{"description":"Unsupported media type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeDTO"}}}},"402":{"description":"No credits left on provider","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoCreditsLeftOnProviderDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/providers/current/":{"get":{"tags":["provider-current"],"summary":"Get Current Provider","operationId":"get_current_provider_api_v1_providers_current__get","security":[{"HTTPProviderCredentials":[]}],"parameters":[{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {provider-token}"},"description":"Bearer {provider-token}"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderDTO"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"Time in seconds left before next allowed request","schema":{"type":"float"}},"X-Rate-Limit":{"description":"The number of allowed requests in the current period","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["provider-current"],"summary":"Update Current Provider","description":"Update current provider endpoint","operationId":"update_current_provider_api_v1_providers_current__patch","security":[{"HTTPProviderCredentials":[]}],"parameters":[{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {provider-token}"},"description":"Bearer {provider-token}"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderUpdateDTO"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderDetailedResponseDTO"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"Time in seconds left before next allowed request","schema":{"type":"float"}},"X-Rate-Limit":{"description":"The number of allowed requests in the current period","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/providers/current/token/":{"patch":{"tags":["provider-tokens"],"summary":"Update Provider Token","description":"Update token data","operationId":"update_provider_token_api_v1_providers_current_token__patch","security":[{"HTTPProviderCredentials":[]}],"parameters":[{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {provider-token}"},"description":"Bearer {provider-token}"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderTokenUpdateDTO"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderTokenDTO"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"Time in seconds left before next allowed request","schema":{"type":"float"}},"X-Rate-Limit":{"description":"The number of allowed requests in the current period","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["provider-tokens"],"summary":"Revoke Provider Token","description":"Revokes provider's token.","operationId":"revoke_provider_token_api_v1_providers_current_token__delete","security":[{"HTTPProviderCredentials":[]}],"parameters":[{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {provider-token}"},"description":"Bearer {provider-token}"}],"responses":{"204":{"description":"Successful Response"},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"Time in seconds left before next allowed request","schema":{"type":"float"}},"X-Rate-Limit":{"description":"The number of allowed requests in the current period","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/providers/current/token/refresh/":{"post":{"tags":["provider-tokens"],"summary":"Refresh Provider Token","description":"Refresh token if there is no more tokens left.\nUpdate public and private parts.","operationId":"refresh_provider_token_api_v1_providers_current_token_refresh__post","security":[{"HTTPProviderCredentials":[]}],"parameters":[{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {provider-token}"},"description":"Bearer {provider-token}"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneratedProviderToken"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"Time in seconds left before next allowed request","schema":{"type":"float"}},"X-Rate-Limit":{"description":"The number of allowed requests in the current period","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"403":{"description":"Permission denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoPermissionsToRefreshTokenDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/providers/":{"get":{"tags":["provider-for-admin"],"summary":"Get All Providers","operationId":"get_all_providers_api_v1_providers__get","security":[{"HTTPAdminCredentials":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Page size","default":50,"title":"Size"},"description":"Page size"},{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {admin-token}"},"description":"Bearer {admin-token}"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_ProviderDTO_"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["provider-for-admin"],"summary":"Create Provider","operationId":"create_provider_api_v1_providers__post","security":[{"HTTPAdminCredentials":[]}],"parameters":[{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {admin-token}"},"description":"Bearer {admin-token}"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderCreateDTO"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderWithCreditsResponseDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/providers/{provider_id}/":{"get":{"tags":["provider-for-admin"],"summary":"Get Provider","operationId":"get_provider_api_v1_providers__provider_id___get","security":[{"HTTPAdminCredentials":[]}],"parameters":[{"name":"provider_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Provider Id"}},{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {admin-token}"},"description":"Bearer {admin-token}"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderDetailedResponseDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderNotFoundDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["provider-for-admin"],"summary":"Update Provider","operationId":"update_provider_api_v1_providers__provider_id___patch","security":[{"HTTPAdminCredentials":[]}],"parameters":[{"name":"provider_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Provider Id"}},{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {admin-token}"},"description":"Bearer {admin-token}"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderUpdateForAdminDTO"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderDetailedResponseDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderNotFoundDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/providers/{provider_id}/dispense/":{"patch":{"tags":["provider-for-admin"],"summary":"Dispense Provider Credits","operationId":"dispense_provider_credits_api_v1_providers__provider_id__dispense__patch","security":[{"HTTPAdminCredentials":[]}],"parameters":[{"name":"provider_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Provider Id"}},{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {admin-token}"},"description":"Bearer {admin-token}"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dispense"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderDetailedResponseDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderNotFoundDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/providers/{provider_id}/tokens/":{"post":{"tags":["provider-for-admin"],"summary":"Generate Provider Token","operationId":"generate_provider_token_api_v1_providers__provider_id__tokens__post","security":[{"HTTPAdminCredentials":[]}],"parameters":[{"name":"provider_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Provider Id"}},{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {admin-token}"},"description":"Bearer {admin-token}"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderTokenCreateDTO"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneratedProviderToken"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderNotFoundDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["provider-for-admin"],"summary":"Revoke Provider Tokens","description":"Revokes all provider's tokens by admin.","operationId":"revoke_provider_tokens_api_v1_providers__provider_id__tokens__delete","security":[{"HTTPAdminCredentials":[]}],"parameters":[{"name":"provider_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Provider Id"}},{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {admin-token}"},"description":"Bearer {admin-token}"}],"responses":{"204":{"description":"Successful Response"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderNotFoundDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/providers/{provider_id}/tokens/external/":{"post":{"tags":["provider-for-admin"],"summary":"Generate Provider External Token","operationId":"generate_provider_external_token_api_v1_providers__provider_id__tokens_external__post","security":[{"HTTPAdminCredentials":[]}],"parameters":[{"name":"provider_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Provider Id"}},{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {admin-token}"},"description":"Bearer {admin-token}"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderExternalTokenCreateDTO"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneratedProviderToken"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderNotFoundDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/providers/{provider_id}/restrictions/":{"get":{"tags":["provider-for-admin"],"summary":"Get Provider Restrictions","operationId":"get_provider_restrictions_api_v1_providers__provider_id__restrictions__get","security":[{"HTTPAdminCredentials":[]}],"parameters":[{"name":"provider_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Provider Id"}},{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {admin-token}"},"description":"Bearer {admin-token}"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestrictionsResponseDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestrictionsNotFoundDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["provider-for-admin"],"summary":"Create Provider Restrictions","operationId":"create_provider_restrictions_api_v1_providers__provider_id__restrictions__post","security":[{"HTTPAdminCredentials":[]}],"parameters":[{"name":"provider_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Provider Id"}},{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {admin-token}"},"description":"Bearer {admin-token}"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestrictionsCreateRequestDTO"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestrictionsResponseDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderNotFoundDTO"}}}},"403":{"description":"Provider already has restrictions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderHasRestrictionsDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["provider-for-admin"],"summary":"Update Provider Restrictions","operationId":"update_provider_restrictions_api_v1_providers__provider_id__restrictions__patch","security":[{"HTTPAdminCredentials":[]}],"parameters":[{"name":"provider_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Provider Id"}},{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {admin-token}"},"description":"Bearer {admin-token}"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestrictionsUpdateRequestDTO"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestrictionsResponseDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestrictionsNotFoundDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/clients/":{"get":{"tags":["client-for-provider"],"summary":"Get Clients List","description":"Returns clients belonging to provider.","operationId":"get_clients_list_api_v1_clients__get","security":[{"HTTPProviderCredentials":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Page size","default":50,"title":"Size"},"description":"Page size"},{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {provider-token}"},"description":"Bearer {provider-token}"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_ClientForProviderDTO_"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"Time in seconds left before next allowed request","schema":{"type":"float"}},"X-Rate-Limit":{"description":"The number of allowed requests in the current period","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["client-for-provider"],"summary":"Create Client","description":"Creates new client for provider.","operationId":"create_client_api_v1_clients__post","security":[{"HTTPProviderCredentials":[]}],"parameters":[{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {provider-token}"},"description":"Bearer {provider-token}"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCreateDTO"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientWithCreditsResponseDTO"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"Time in seconds left before next allowed request","schema":{"type":"float"}},"X-Rate-Limit":{"description":"The number of allowed requests in the current period","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/clients/current/":{"get":{"tags":["client-current"],"summary":"Get Current Client","operationId":"get_current_client_api_v1_clients_current__get","security":[{"HTTPClientInternalCredentials":[]},{"External Token":[]}],"parameters":[{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {client-token}"},"description":"Bearer {client-token}"},{"name":"x-forwarded-host","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Forwarded-Host"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientDetailedResponseDTO"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"Time in seconds left before next allowed request","schema":{"type":"float"}},"X-Rate-Limit":{"description":"The number of allowed requests in the current period","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["client-current"],"summary":"Update Client","description":"Update current client endpoint","operationId":"update_client_api_v1_clients_current__patch","security":[{"HTTPClientInternalCredentials":[]},{"External Token":[]}],"parameters":[{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {client-token}"},"description":"Bearer {client-token}"},{"name":"x-forwarded-host","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Forwarded-Host"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientUpdateDTO"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientDetailedResponseDTO"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"Time in seconds left before next allowed request","schema":{"type":"float"}},"X-Rate-Limit":{"description":"The number of allowed requests in the current period","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/clients/{client_id}/":{"get":{"tags":["client-for-provider"],"summary":"Get Client By Id","operationId":"get_client_by_id_api_v1_clients__client_id___get","security":[{"HTTPProviderCredentials":[]}],"parameters":[{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}},{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {provider-token}"},"description":"Bearer {provider-token}"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientDetailedResponseDTO"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"Time in seconds left before next allowed request","schema":{"type":"float"}},"X-Rate-Limit":{"description":"The number of allowed requests in the current period","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["client-for-provider"],"summary":"Update Client","description":"Update client endpoint for provider.","operationId":"update_client_api_v1_clients__client_id___patch","security":[{"HTTPProviderCredentials":[]}],"parameters":[{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}},{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {provider-token}"},"description":"Bearer {provider-token}"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientUpdateForProviderDTO"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientWithCreditsResponseDTO"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"Time in seconds left before next allowed request","schema":{"type":"float"}},"X-Rate-Limit":{"description":"The number of allowed requests in the current period","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsDTO"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientNotFoundDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/clients/{client_id}/dispense/":{"patch":{"tags":["client-for-provider"],"summary":"Dispense Client Credits","description":"Dispense client credits.","operationId":"dispense_client_credits_api_v1_clients__client_id__dispense__patch","security":[{"HTTPProviderCredentials":[]}],"parameters":[{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}},{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {provider-token}"},"description":"Bearer {provider-token}"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dispense"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientDetailedResponseDTO"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"Time in seconds left before next allowed request","schema":{"type":"float"}},"X-Rate-Limit":{"description":"The number of allowed requests in the current period","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsDTO"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientNotFoundDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/clients/{client_id}/tokens/":{"post":{"tags":["client-for-provider"],"summary":"Generate Client Token","description":"Generates token for client by provider.","operationId":"generate_client_token_api_v1_clients__client_id__tokens__post","security":[{"HTTPProviderCredentials":[]}],"parameters":[{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}},{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {provider-token}"},"description":"Bearer {provider-token}"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientTokenCreateDTO"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneratedClientToken"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"Time in seconds left before next allowed request","schema":{"type":"float"}},"X-Rate-Limit":{"description":"The number of allowed requests in the current period","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsDTO"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientNotFoundDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["client-for-provider"],"summary":"Revoke Client Tokens","description":"Revokes all client's tokens by provider.","operationId":"revoke_client_tokens_api_v1_clients__client_id__tokens__delete","security":[{"HTTPProviderCredentials":[]}],"parameters":[{"name":"client_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Id"}},{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {provider-token}"},"description":"Bearer {provider-token}"}],"responses":{"204":{"description":"Successful Response"},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"Time in seconds left before next allowed request","schema":{"type":"float"}},"X-Rate-Limit":{"description":"The number of allowed requests in the current period","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsDTO"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientNotFoundDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/clients/current/token/":{"patch":{"tags":["client-tokens"],"summary":"Update Client Token","description":"Update token data","operationId":"update_client_token_api_v1_clients_current_token__patch","security":[{"HTTPClientInternalCredentials":[]},{"External Token":[]}],"parameters":[{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {client-token}"},"description":"Bearer {client-token}"},{"name":"x-forwarded-host","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Forwarded-Host"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientTokenUpdateDTO"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientTokenDTO"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"Time in seconds left before next allowed request","schema":{"type":"float"}},"X-Rate-Limit":{"description":"The number of allowed requests in the current period","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["client-tokens"],"summary":"Revoke Client Token","description":"Revokes client's token.","operationId":"revoke_client_token_api_v1_clients_current_token__delete","security":[{"HTTPClientInternalCredentials":[]},{"External Token":[]}],"parameters":[{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {client-token}"},"description":"Bearer {client-token}"},{"name":"x-forwarded-host","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Forwarded-Host"}}],"responses":{"204":{"description":"Successful Response"},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"Time in seconds left before next allowed request","schema":{"type":"float"}},"X-Rate-Limit":{"description":"The number of allowed requests in the current period","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/clients/current/token/refresh/":{"post":{"tags":["client-tokens"],"summary":"Refresh Client Token","description":"Refresh token if there is no more tokens left.\nUpdate public and private parts.","operationId":"refresh_client_token_api_v1_clients_current_token_refresh__post","security":[{"HTTPClientInternalCredentials":[]},{"External Token":[]}],"parameters":[{"name":"Authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","description":"Bearer {client-token}"},"description":"Bearer {client-token}"},{"name":"x-forwarded-host","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Forwarded-Host"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneratedClientToken"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"Time in seconds left before next allowed request","schema":{"type":"float"}},"X-Rate-Limit":{"description":"The number of allowed requests in the current period","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExceptionDTO"}}}},"403":{"description":"Permission denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoPermissionsToRefreshTokenDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/trigger-error/":{"get":{"summary":"Trigger Error","operationId":"trigger_error_trigger_error__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"number","title":"Response Trigger Error Trigger Error Get"}}}}}}},"/health/":{"get":{"tags":["healthcheck"],"summary":"Perform a Health Check","operationId":"health_check_health__get","responses":{"200":{"description":"Return HTTP Status Code 200 (OK)","content":{"application/json":{"schema":{}}}}}}}},"components":{"schemas":{"AuthenticationExceptionDTO":{"anyOf":[{"$ref":"#/components/schemas/TokenExpiredExceptionDTO"},{"$ref":"#/components/schemas/TokenInvalidExceptionDTO"},{"$ref":"#/components/schemas/TokenNotProvidedExceptionDTO"}],"title":"AuthenticationExceptionDTO"},"Body_upload_cv_api_v1_cv__post":{"properties":{"file":{"type":"string","format":"binary","title":"File"}},"type":"object","required":["file"],"title":"Body_upload_cv_api_v1_cv__post"},"Body_upload_cv_bulk_api_v1_cv_bulk__post":{"properties":{"files":{"items":{"type":"string","format":"binary"},"type":"array","title":"Files"}},"type":"object","required":["files"],"title":"Body_upload_cv_bulk_api_v1_cv_bulk__post"},"CVDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"status":{"$ref":"#/components/schemas/CVProcessingStatus"},"filename":{"type":"string","title":"Filename"},"token_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Token Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","status","filename","token_id","created_at","updated_at"],"title":"CVDTO"},"CVDetailedDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"status":{"$ref":"#/components/schemas/CVProcessingStatus"},"filename":{"type":"string","title":"Filename"},"token_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Token Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"file_url":{"type":"string","minLength":1,"format":"uri","title":"File Url"},"person":{"anyOf":[{"$ref":"#/components/schemas/PersonDTO"},{"type":"null"}]}},"type":"object","required":["id","status","filename","token_id","created_at","updated_at","file_url","person"],"title":"CVDetailedDTO"},"CVDetailedWithRequiredPersonDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"status":{"$ref":"#/components/schemas/CVProcessingStatus"},"filename":{"type":"string","title":"Filename"},"token_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Token Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"file_url":{"type":"string","minLength":1,"format":"uri","title":"File Url"},"person":{"$ref":"#/components/schemas/PersonDTO"}},"type":"object","required":["id","status","filename","token_id","created_at","updated_at","file_url","person"],"title":"CVDetailedWithRequiredPersonDTO"},"CVNotFoundDTO":{"properties":{"detail":{"type":"string","title":"Detail","default":"CV with given id not found: {id}"}},"type":"object","title":"CVNotFoundDTO"},"CVProcessingStatus":{"type":"string","enum":["initialized","processing","succeeded","failed"],"title":"CVProcessingStatus"},"CVWithFullTextDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"status":{"$ref":"#/components/schemas/CVProcessingStatus"},"filename":{"type":"string","title":"Filename"},"token_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Token Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"cv_full_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cv Full Text"}},"type":"object","required":["id","status","filename","token_id","created_at","updated_at","cv_full_text"],"title":"CVWithFullTextDTO"},"ClientCreateDTO":{"properties":{"name":{"type":"string","title":"Name"},"email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email"},"webhook_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Url"},"credits":{"type":"integer","minimum":0.0,"title":"Credits","default":1000},"unlimited_credits":{"type":"boolean","title":"Unlimited Credits","default":false}},"type":"object","required":["name"],"title":"ClientCreateDTO"},"ClientDetailedResponseDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email"},"webhook_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Url"},"webhook_secret_key":{"type":"string","title":"Webhook Secret Key"},"provider_id":{"type":"string","format":"uuid","title":"Provider Id"},"unlimited_credits":{"type":"boolean","title":"Unlimited Credits"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"credits":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits"},"tokens":{"items":{"$ref":"#/components/schemas/ClientTokenDTO"},"type":"array","title":"Tokens"}},"type":"object","required":["id","name","email","webhook_secret_key","provider_id","unlimited_credits","created_at","updated_at","tokens"],"title":"ClientDetailedResponseDTO"},"ClientForProviderDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email"},"webhook_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Url"},"webhook_secret_key":{"type":"string","title":"Webhook Secret Key"},"unlimited_credits":{"type":"boolean","title":"Unlimited Credits"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","name","webhook_secret_key","unlimited_credits","created_at","updated_at"],"title":"ClientForProviderDTO"},"ClientNotFoundDTO":{"properties":{"detail":{"type":"string","title":"Detail","default":"Client with given id not found: {id}"}},"type":"object","title":"ClientNotFoundDTO"},"ClientTokenCreateDTO":{"properties":{"name":{"type":"string","title":"Name"},"expired_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expired At","description":"Token expiration datetime. If set to None, it's never expired."}},"type":"object","required":["name"],"title":"ClientTokenCreateDTO"},"ClientTokenDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"revoked":{"type":"boolean","title":"Revoked","default":false},"expired_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expired At"}},"type":"object","required":["id","name"],"title":"ClientTokenDTO"},"ClientTokenUpdateDTO":{"properties":{"name":{"type":"string","title":"Name"},"expired_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expired At"}},"type":"object","title":"ClientTokenUpdateDTO"},"ClientUpdateDTO":{"properties":{"name":{"type":"string","title":"Name"},"email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email"},"webhook_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Url"}},"type":"object","title":"ClientUpdateDTO"},"ClientUpdateForProviderDTO":{"properties":{"name":{"type":"string","title":"Name"},"email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email"},"webhook_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Url"},"unlimited_credits":{"type":"boolean","title":"Unlimited Credits"}},"type":"object","title":"ClientUpdateForProviderDTO"},"ClientWithCreditsResponseDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email"},"webhook_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Url"},"webhook_secret_key":{"type":"string","title":"Webhook Secret Key"},"provider_id":{"type":"string","format":"uuid","title":"Provider Id"},"unlimited_credits":{"type":"boolean","title":"Unlimited Credits"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"credits":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits"}},"type":"object","required":["id","name","email","webhook_secret_key","provider_id","unlimited_credits","created_at","updated_at"],"title":"ClientWithCreditsResponseDTO"},"ContactsInfoDTO":{"properties":{"emails":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Emails"},"phones":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phones"},"telegram":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Telegram"},"github":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Github"}},"type":"object","required":["emails","phones","telegram","github"],"title":"ContactsInfoDTO"},"CourseDTO":{"properties":{"course_provider":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Course Provider"},"orig_course_provider":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Orig Course Provider"},"education_field":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Education Field"},"orig_education_field":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Orig Education Field"},"start_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Start Date"},"end_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"End Date"},"until_now":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Until Now"}},"type":"object","required":["course_provider","orig_course_provider","education_field","orig_education_field","start_date","end_date","until_now"],"title":"CourseDTO"},"Dispense":{"properties":{"amount":{"type":"integer","title":"Amount"}},"type":"object","required":["amount"],"title":"Dispense"},"FailedCVParsingWebhookDTO":{"properties":{"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"cv_parsing_failed"},"cv":{"$ref":"#/components/schemas/CVDTO"}},"type":"object","required":["cv"],"title":"FailedCVParsingWebhookDTO"},"FilterQueryDTO":{"properties":{"values":{"anyOf":[{"$ref":"#/components/schemas/ValuesData"},{"type":"null"}]},"operation":{"$ref":"#/components/schemas/Operation"},"field":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Field"},"subqueries":{"anyOf":[{"items":{"$ref":"#/components/schemas/SubFilterQueryDTO"},"type":"array"},{"type":"null"}],"title":"Subqueries"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"}},"type":"object","required":["operation"],"title":"FilterQueryDTO","examples":[{"operation":"and","subqueries":[{"field":"person__names","operation":"starts_with","values":{"data":"John"}},{"field":"person__names","operation":"iends_with","values":{"data":"dOE"}},{"field":"person__age","operation":"between","values":{"data":[18,45]}},{"field":"created_at","operation":"lt","values":{"data":"2024-11-13"}},{"field":"person__experience_overall_time_month","operation":"ge","values":{"data":48}},{"operation":"or","subqueries":[{"field":"person__skills","operation":"contains","values":{"data":"Python"}},{"field":"person__skills","operation":"contains","values":{"data":"python"}}]},{"operation":"or","subqueries":[{"field":"person__languages","operation":"contains","values":{"data":"Japanese"}},{"field":"person__languages","operation":"contains","values":{"data":"japanese"}}]},{"operation":"and","subqueries":[{"field":"person__institutions__until_now","operation":"ne","values":{"data":true}},{"field":"person__courses__until_now","operation":"ne","values":{"data":true}}]}],"title":"complex filter to show full power of filters: name startswith john and iendswith doe, age between 18_and_45, cv created_before_yesterday, over 4 years of experience, knows python and japanese, not student"}]},"FilterQueryDetailedResponseDTO":{"properties":{"operation":{"$ref":"#/components/schemas/Operation"},"field":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Field"},"values":{"anyOf":[{"$ref":"#/components/schemas/ValuesData"},{"type":"null"}]},"subqueries":{"anyOf":[{"items":{"$ref":"#/components/schemas/FilterSubQueryDetailedResponseDTO"},"type":"array"},{"type":"null"}],"title":"Subqueries"},"id":{"type":"string","format":"uuid","title":"Id"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"}},"type":"object","required":["operation","id"],"title":"FilterQueryDetailedResponseDTO"},"FilterQueryNotFoundDTO":{"properties":{"detail":{"type":"string","title":"Detail","default":"Filter query with given id not found: {id}"}},"type":"object","title":"FilterQueryNotFoundDTO"},"FilterQueryResponseDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"title":{"type":"string","title":"Title"},"operation":{"$ref":"#/components/schemas/Operation"}},"type":"object","required":["id","title","operation"],"title":"FilterQueryResponseDTO"},"FilterSubQueryDetailedResponseDTO":{"properties":{"operation":{"$ref":"#/components/schemas/Operation"},"field":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Field"},"values":{"anyOf":[{"$ref":"#/components/schemas/ValuesData"},{"type":"null"}]},"subqueries":{"anyOf":[{"items":{"$ref":"#/components/schemas/FilterSubQueryDetailedResponseDTO"},"type":"array"},{"type":"null"}],"title":"Subqueries"}},"type":"object","required":["operation"],"title":"FilterSubQueryDetailedResponseDTO"},"GeneratedClientToken":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"revoked":{"type":"boolean","title":"Revoked","default":false},"expired_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expired At"},"private_part":{"type":"string","maxLength":64,"minLength":64,"title":"Private Part"},"owner_id":{"type":"string","format":"uuid","title":"Owner Id"}},"type":"object","required":["id","name","private_part","owner_id"],"title":"GeneratedClientToken"},"GeneratedProviderToken":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"revoked":{"type":"boolean","title":"Revoked","default":false},"expired_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expired At"},"private_part":{"type":"string","title":"Private Part"},"owner_id":{"type":"string","format":"uuid","title":"Owner Id"}},"type":"object","required":["id","name","private_part","owner_id"],"title":"GeneratedProviderToken"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"InstitutionDTO":{"properties":{"university_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"University Name"},"orig_university_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Orig University Name"},"education_field":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Education Field"},"orig_education_field":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Orig Education Field"},"start_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Start Date"},"end_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"End Date"},"until_now":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Until Now"},"transcript_university_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transcript University Name"}},"type":"object","required":["university_name","orig_university_name","education_field","orig_education_field","start_date","end_date","until_now","transcript_university_name"],"title":"InstitutionDTO"},"JobDTO":{"properties":{"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"orig_company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Orig Company Name"},"clear_company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Clear Company Name"},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location"},"orig_location":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Orig Location"},"job_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job Title"},"orig_job_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Orig Job Title"},"legal_suffix":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Legal Suffix"},"start_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Start Date"},"end_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"End Date"},"overall_time_month":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Overall Time Month"},"until_now":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Until Now"},"job_grade":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job Grade"},"start_of_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Of Description"},"end_of_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End Of Description"},"orig_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Orig Description"},"project_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project Description"},"orig_project_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Orig Project Description"},"achievements":{"items":{"type":"string"},"type":"array","title":"Achievements"},"orig_achievements":{"anyOf":[{"items":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":"array"},{"type":"null"}],"title":"Orig Achievements"},"responsibilities":{"items":{"type":"string"},"type":"array","title":"Responsibilities"},"orig_responsibilities":{"anyOf":[{"items":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":"array"},{"type":"null"}],"title":"Orig Responsibilities"},"root_cluster":{"items":{"type":"string"},"type":"array","title":"Root Cluster"},"competencies_cluster":{"items":{"type":"string"},"type":"array","title":"Competencies Cluster"},"knowledge":{"items":{"type":"string"},"type":"array","title":"Knowledge"},"tools":{"items":{"type":"string"},"type":"array","title":"Tools"},"abilities":{"items":{"type":"string"},"type":"array","title":"Abilities"},"is_description_orig_short":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Description Orig Short"},"is_tools_non_specific":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Tools Non Specific"}},"type":"object","required":["company_name","orig_company_name","clear_company_name","location","orig_location","job_title","orig_job_title","legal_suffix","start_date","end_date","overall_time_month","until_now","job_grade","start_of_description","end_of_description","orig_description","project_description","orig_project_description","achievements","orig_achievements","responsibilities","orig_responsibilities","root_cluster","competencies_cluster","knowledge","tools","abilities","is_description_orig_short","is_tools_non_specific"],"title":"JobDTO"},"NoCreditsLeftOnProviderDTO":{"properties":{"detail":{"type":"string","title":"Detail","default":"No credits left on provider"}},"type":"object","title":"NoCreditsLeftOnProviderDTO"},"NoPermissionsToRefreshTokenDTO":{"properties":{"detail":{"type":"string","title":"Detail","default":"Cannot refresh current token, you still have other tokens."}},"type":"object","title":"NoPermissionsToRefreshTokenDTO"},"Operation":{"type":"string","enum":["and","or","exact","iexact","not_exact","not_iexact","like","ilike","not_like","not_ilike","starts_with","istarts_with","ends_with","iends_with","eq","ne","gt","ge","lt","le","in","not_in","between","not_between","contains","not_contains"],"title":"Operation"},"Page_CVDTO_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/CVDTO"},"type":"array","title":"Items"},"total":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Total"},"page":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Page"},"size":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Size"},"pages":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Pages"}},"type":"object","required":["items","total","page","size"],"title":"Page[CVDTO]"},"Page_ClientForProviderDTO_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ClientForProviderDTO"},"type":"array","title":"Items"},"total":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Total"},"page":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Page"},"size":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Size"},"pages":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Pages"}},"type":"object","required":["items","total","page","size"],"title":"Page[ClientForProviderDTO]"},"Page_ProviderDTO_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ProviderDTO"},"type":"array","title":"Items"},"total":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Total"},"page":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Page"},"size":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Size"},"pages":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Pages"}},"type":"object","required":["items","total","page","size"],"title":"Page[ProviderDTO]"},"PersonDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"names":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Names"},"orig_names":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Orig Names"},"age":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Age"},"real_age":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Real Age"},"birthday_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Birthday Date"},"birthday_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Birthday Year"},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location"},"about_me":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"About Me"},"orig_about_me":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Orig About Me"},"skills":{"items":{"type":"string"},"type":"array","title":"Skills"},"orig_skills":{"items":{"type":"string"},"type":"array","title":"Orig Skills"},"languages":{"items":{"type":"string"},"type":"array","title":"Languages"},"orig_languages":{"anyOf":[{"items":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":"array"},{"type":"null"}],"title":"Orig Languages"},"proficiency":{"anyOf":[{"items":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":"array"},{"type":"null"}],"title":"Proficiency"},"orig_proficiency":{"anyOf":[{"items":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":"array"},{"type":"null"}],"title":"Orig Proficiency"},"experience_overall_time_month":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Experience Overall Time Month"},"does_end_date_anywhere_stated":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Does End Date Anywhere Stated"},"contacts_info":{"anyOf":[{"$ref":"#/components/schemas/ContactsInfoDTO"},{"type":"null"}]},"institutions":{"items":{"$ref":"#/components/schemas/InstitutionDTO"},"type":"array","title":"Institutions"},"experience":{"items":{"$ref":"#/components/schemas/JobDTO"},"type":"array","title":"Experience"},"courses":{"items":{"$ref":"#/components/schemas/CourseDTO"},"type":"array","title":"Courses"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["id","names","orig_names","age","real_age","birthday_date","birthday_year","location","about_me","orig_about_me","skills","orig_skills","languages","orig_languages","proficiency","orig_proficiency","experience_overall_time_month","does_end_date_anywhere_stated","contacts_info","institutions","experience","courses","created_at"],"title":"PersonDTO"},"ProviderCreateDTO":{"properties":{"name":{"type":"string","title":"Name"},"email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email"},"credits":{"type":"integer","minimum":0.0,"title":"Credits","default":1000},"unlimited_credits":{"type":"boolean","title":"Unlimited Credits","default":false},"host":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Host"},"authentication_header_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authentication Header Key"},"client_name_header_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Name Header Key"},"webhook_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Url"}},"type":"object","required":["name"],"title":"ProviderCreateDTO"},"ProviderDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email"},"unlimited_credits":{"type":"boolean","title":"Unlimited Credits"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"webhook_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Url"},"webhook_secret_key":{"type":"string","title":"Webhook Secret Key"}},"type":"object","required":["id","name","email","unlimited_credits","created_at","updated_at","webhook_url","webhook_secret_key"],"title":"ProviderDTO"},"ProviderDetailedResponseDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email"},"unlimited_credits":{"type":"boolean","title":"Unlimited Credits"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"webhook_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Url"},"webhook_secret_key":{"type":"string","title":"Webhook Secret Key"},"credits":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits"},"tokens":{"items":{"$ref":"#/components/schemas/ProviderTokenDTO"},"type":"array","title":"Tokens"}},"type":"object","required":["id","name","email","unlimited_credits","created_at","updated_at","webhook_url","webhook_secret_key","tokens"],"title":"ProviderDetailedResponseDTO"},"ProviderExternalTokenCreateDTO":{"properties":{"name":{"type":"string","title":"Name","default":"external token"},"expired_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expired At","description":"Token expiration datetime. If set to None, it's never expired."},"token":{"type":"string","title":"Token","description":"Token created by external provider"}},"type":"object","required":["token"],"title":"ProviderExternalTokenCreateDTO"},"ProviderHasRestrictionsDTO":{"properties":{"detail":{"type":"string","title":"Detail","default":"Provider already has restrictions"}},"type":"object","title":"ProviderHasRestrictionsDTO"},"ProviderNotFoundDTO":{"properties":{"detail":{"type":"string","title":"Detail","default":"Provider with given id not found: {id}"}},"type":"object","title":"ProviderNotFoundDTO"},"ProviderTokenCreateDTO":{"properties":{"name":{"type":"string","title":"Name"},"expired_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expired At","description":"Token expiration datetime. If set to None, it's never expired."}},"type":"object","required":["name"],"title":"ProviderTokenCreateDTO"},"ProviderTokenDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"revoked":{"type":"boolean","title":"Revoked","default":false},"expired_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expired At"}},"type":"object","required":["id","name"],"title":"ProviderTokenDTO"},"ProviderTokenUpdateDTO":{"properties":{"name":{"type":"string","title":"Name"},"expired_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expired At"}},"type":"object","title":"ProviderTokenUpdateDTO"},"ProviderUpdateDTO":{"properties":{"name":{"type":"string","title":"Name"},"email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email"},"webhook_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Url"}},"type":"object","title":"ProviderUpdateDTO"},"ProviderUpdateForAdminDTO":{"properties":{"name":{"type":"string","title":"Name"},"email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email"},"webhook_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Url"},"unlimited_credits":{"type":"boolean","title":"Unlimited Credits"}},"type":"object","title":"ProviderUpdateForAdminDTO"},"ProviderWithCreditsResponseDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email"},"unlimited_credits":{"type":"boolean","title":"Unlimited Credits"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"webhook_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Url"},"webhook_secret_key":{"type":"string","title":"Webhook Secret Key"},"credits":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits"}},"type":"object","required":["id","name","email","unlimited_credits","created_at","updated_at","webhook_url","webhook_secret_key"],"title":"ProviderWithCreditsResponseDTO"},"RestrictionsCreateRequestDTO":{"properties":{"max_amount_of_files":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Amount Of Files"},"max_file_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max File Size"},"max_amount_of_pages_in_file":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Amount Of Pages In File"},"rate_limit_request_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Rate Limit Request Amount","description":"Amount of requests allowed in period"},"rate_limit_period":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rate Limit Period","description":"Interval for rate limiting requests"}},"type":"object","title":"RestrictionsCreateRequestDTO"},"RestrictionsNotFoundDTO":{"properties":{"detail":{"type":"string","title":"Detail","default":"Restrictions for provider with given id not found: {id}"}},"type":"object","title":"RestrictionsNotFoundDTO"},"RestrictionsResponseDTO":{"properties":{"max_amount_of_files":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Amount Of Files"},"max_file_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max File Size"},"max_amount_of_pages_in_file":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Amount Of Pages In File"},"rate_limit_request_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Rate Limit Request Amount","description":"Amount of requests allowed in period"},"rate_limit_period":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rate Limit Period","description":"Interval for rate limiting requests"}},"type":"object","required":["max_amount_of_files","max_file_size","max_amount_of_pages_in_file","rate_limit_request_amount","rate_limit_period"],"title":"RestrictionsResponseDTO"},"RestrictionsUpdateRequestDTO":{"properties":{"max_amount_of_files":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Amount Of Files"},"max_file_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max File Size"},"max_amount_of_pages_in_file":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Amount Of Pages In File"},"rate_limit_request_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Rate Limit Request Amount","description":"Amount of requests allowed in period"},"rate_limit_period":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rate Limit Period","description":"Interval for rate limiting requests"}},"type":"object","title":"RestrictionsUpdateRequestDTO"},"SubFilterQueryDTO":{"properties":{"values":{"anyOf":[{"$ref":"#/components/schemas/ValuesData"},{"type":"null"}]},"operation":{"$ref":"#/components/schemas/Operation"},"field":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Field"},"subqueries":{"anyOf":[{"items":{"$ref":"#/components/schemas/SubFilterQueryDTO"},"type":"array"},{"type":"null"}],"title":"Subqueries"}},"type":"object","required":["operation"],"title":"SubFilterQueryDTO"},"SucceededCVParsingWebhookDTO":{"properties":{"event_type":{"$ref":"#/components/schemas/WebhookEventType","default":"cv_parsing_succeeded"},"cv":{"$ref":"#/components/schemas/CVDetailedWithRequiredPersonDTO"}},"type":"object","required":["cv"],"title":"SucceededCVParsingWebhookDTO"},"TokenExpiredExceptionDTO":{"properties":{"detail":{"type":"string","title":"Detail","default":"Token has expired"}},"type":"object","title":"TokenExpiredExceptionDTO"},"TokenInvalidExceptionDTO":{"properties":{"detail":{"type":"string","title":"Detail","default":"Invalid token provided"}},"type":"object","title":"TokenInvalidExceptionDTO"},"TokenNotProvidedExceptionDTO":{"properties":{"detail":{"type":"string","title":"Detail","default":"Token is not provided"}},"type":"object","title":"TokenNotProvidedExceptionDTO"},"TooManyRequestsDTO":{"properties":{"detail":{"type":"string","title":"Detail","default":"Too Many Requests"}},"type":"object","title":"TooManyRequestsDTO"},"UnsupportedMediaTypeDTO":{"properties":{"detail":{"type":"string","title":"Detail","default":"Allowed MIME Types: application/pdf"}},"type":"object","title":"UnsupportedMediaTypeDTO"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"ValuesData":{"properties":{"data":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"string","format":"date"},{"type":"string","format":"date-time"}]},"type":"array"},{"type":"string","format":"date"},{"type":"string","format":"date-time"},{"type":"null"}],"title":"Data"}},"type":"object","required":["data"],"title":"ValuesData"},"WebhookEventType":{"type":"string","enum":["cv_parsing_succeeded","cv_parsing_failed"],"title":"WebhookEventType"}},"securitySchemes":{"HTTPClientInternalCredentials":{"type":"http","description":"HTTPClientInternalCredentials","scheme":"bearer"},"External Token":{"type":"apiKey","description":"External authentication","in":"header","name":"External"},"HTTPProviderCredentials":{"type":"http","description":"HTTPProviderCredentials","scheme":"bearer"},"HTTPAdminCredentials":{"type":"http","description":"HTTPAdminCredentials","scheme":"bearer"}}}}