From aaa336ac1e84e44b88af7c2ee3ffb98f46ef37e2 Mon Sep 17 00:00:00 2001 From: Nedhir Ebnou Date: Tue, 10 Dec 2024 16:30:26 +0100 Subject: [PATCH] removing extra docs --- .flake8 | 1 + .../hubspot/docs/pull_profile_list.md | 75 ---------------- .../connectors/hubspot/docs/push_profile.md | 67 -------------- .../recruitee/docs/pull_job_list.md | 75 ---------------- .../recruitee/docs/pull_profile_list.md | 89 ------------------- .../connectors/recruitee/docs/push_profile.md | 67 -------------- 6 files changed, 1 insertion(+), 373 deletions(-) delete mode 100644 src/hrflow_connectors/v2/connectors/hubspot/docs/pull_profile_list.md delete mode 100644 src/hrflow_connectors/v2/connectors/hubspot/docs/push_profile.md delete mode 100644 src/hrflow_connectors/v2/connectors/recruitee/docs/pull_job_list.md delete mode 100644 src/hrflow_connectors/v2/connectors/recruitee/docs/pull_profile_list.md delete mode 100644 src/hrflow_connectors/v2/connectors/recruitee/docs/push_profile.md diff --git a/.flake8 b/.flake8 index 745b529de..279bf6389 100644 --- a/.flake8 +++ b/.flake8 @@ -5,5 +5,6 @@ ignore = E731, W503, E203 black-config = pyproject.toml per-file-ignores = src/hrflow_connectors/v2/connectors/zohorecruit/aisles.py: E501 + src/hrflow_connectors/v2/connectors/flatchr/aisles.py: E501 src/hrflow_connectors/v1/core/documentation.py: E501 tests/v1/core/test_documentation.py: E501 \ No newline at end of file diff --git a/src/hrflow_connectors/v2/connectors/hubspot/docs/pull_profile_list.md b/src/hrflow_connectors/v2/connectors/hubspot/docs/pull_profile_list.md deleted file mode 100644 index 7efb5a43e..000000000 --- a/src/hrflow_connectors/v2/connectors/hubspot/docs/pull_profile_list.md +++ /dev/null @@ -1,75 +0,0 @@ -# Pull profile list -`Hubspot Contacts` :arrow_right: `HrFlow.ai Profiles` - -Retrieves contacts from Hubspot via API and send them to a ***Hrflow.ai Source***. - - - -## Action Parameters - -| Field | Type | Default | Description | -| ----- | ---- | ------- | ----------- | -| `logics` | `typing.List[typing.Callable[[typing.Dict], typing.Optional[typing.Dict]]]` | [] | List of logic functions | -| `format` | `typing.Callable[[typing.Dict], typing.Dict]` | [`format_hubspot_contact`](../connector.py#L39) | Formatting function | -| `read_mode` | `str` | ReadMode.sync | If 'incremental' then `read_from` of the last run is given to Origin Warehouse during read. **The actual behavior depends on implementation of read**. In 'sync' mode `read_from` is neither fetched nor given to Origin Warehouse during read. | - -## Source Parameters - -| Field | Type | Default | Description | -| ----- | ---- | ------- | ----------- | -| `access_token` :red_circle: | `str` | None | The token used to authenticate any API calls made for to your HubSpot account. | -| `limit` | `int` | None | The maximum number of results to display per page. | -| `after` | `str` | None | The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. | -| `properties` | `str` | firstname,lastname,date_of_birth,email,phone,company,address,zip,city,state,country | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. | -| `propertiesWithHistory` | `str` | None | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request. | -| `associations` | `typing.List[str]` | None | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. | -| `archived` | `bool` | False | Whether to return only results that have been archived. | - -## Destination Parameters - -| Field | Type | Default | Description | -| ----- | ---- | ------- | ----------- | -| `api_secret` :red_circle: | `str` | None | X-API-KEY used to access HrFlow.ai API | -| `api_user` :red_circle: | `str` | None | X-USER-EMAIL used to access HrFlow.ai API | -| `source_key` :red_circle: | `str` | None | HrFlow.ai source key | -| `edit` | `bool` | False | When enabled the profile must exist in the source | -| `only_edit_fields` :red_circle: | `typing.List[str]` | None | List of attributes to use for the edit operation e.g. ['tags', 'metadatas'] | - -:red_circle: : *required* - -## Example - -```python -import logging -from hrflow_connectors import Hubspot -from hrflow_connectors.core import ReadMode - - -logging.basicConfig(level=logging.INFO) - - -Hubspot.pull_profile_list( - workflow_id="some_string_identifier", - action_parameters=dict( - logics=[], - format=lambda *args, **kwargs: None # Put your code logic here, - read_mode=ReadMode.sync, - ), - origin_parameters=dict( - access_token="your_access_token", - limit=0, - after="your_after", - properties="firstname,lastname,date_of_birth,email,phone,company,address,zip,city,state,country", - propertiesWithHistory="your_propertiesWithHistory", - associations=***, - archived=False, - ), - target_parameters=dict( - api_secret="your_api_secret", - api_user="your_api_user", - source_key="your_source_key", - edit=False, - only_edit_fields=***, - ) -) -``` \ No newline at end of file diff --git a/src/hrflow_connectors/v2/connectors/hubspot/docs/push_profile.md b/src/hrflow_connectors/v2/connectors/hubspot/docs/push_profile.md deleted file mode 100644 index da16826aa..000000000 --- a/src/hrflow_connectors/v2/connectors/hubspot/docs/push_profile.md +++ /dev/null @@ -1,67 +0,0 @@ -# Push profile -`HrFlow.ai Profiles` :arrow_right: `Hubspot Contacts` - -Writes a profile from Hrflow.ai Source as a contact on Hubspot via the API - - - -## Action Parameters - -| Field | Type | Default | Description | -| ----- | ---- | ------- | ----------- | -| `logics` | `typing.List[typing.Callable[[typing.Dict], typing.Optional[typing.Dict]]]` | [] | List of logic functions | -| `format` | `typing.Callable[[typing.Dict], typing.Dict]` | [`format_hrflow_profile`](../connector.py#L18) | Formatting function | -| `read_mode` | `str` | ReadMode.sync | If 'incremental' then `read_from` of the last run is given to Origin Warehouse during read. **The actual behavior depends on implementation of read**. In 'sync' mode `read_from` is neither fetched nor given to Origin Warehouse during read. | - -## Source Parameters - -| Field | Type | Default | Description | -| ----- | ---- | ------- | ----------- | -| `api_secret` :red_circle: | `str` | None | X-API-KEY used to access HrFlow.ai API | -| `api_user` :red_circle: | `str` | None | X-USER-EMAIL used to access HrFlow.ai API | -| `source_key` :red_circle: | `str` | None | HrFlow.ai source key | -| `profile_key` :red_circle: | `str` | None | HrFlow.ai profile key | - -## Destination Parameters - -| Field | Type | Default | Description | -| ----- | ---- | ------- | ----------- | -| `access_token` :red_circle: | `str` | None | The token used to authenticate any API calls made for to your HubSpot account. | -| `dealID` | `int` | None | | -| `ticketID` | `int` | None | | -| `pipeline` | `` | None | | - -:red_circle: : *required* - -## Example - -```python -import logging -from hrflow_connectors import Hubspot -from hrflow_connectors.core import ReadMode - - -logging.basicConfig(level=logging.INFO) - - -Hubspot.push_profile( - workflow_id="some_string_identifier", - action_parameters=dict( - logics=[], - format=lambda *args, **kwargs: None # Put your code logic here, - read_mode=ReadMode.sync, - ), - origin_parameters=dict( - api_secret="your_api_secret", - api_user="your_api_user", - source_key="your_source_key", - profile_key="your_profile_key", - ), - target_parameters=dict( - access_token="your_access_token", - dealID=0, - ticketID=0, - pipeline=***, - ) -) -``` \ No newline at end of file diff --git a/src/hrflow_connectors/v2/connectors/recruitee/docs/pull_job_list.md b/src/hrflow_connectors/v2/connectors/recruitee/docs/pull_job_list.md deleted file mode 100644 index e2da8e400..000000000 --- a/src/hrflow_connectors/v2/connectors/recruitee/docs/pull_job_list.md +++ /dev/null @@ -1,75 +0,0 @@ -# Pull job list -`Recruitee Jobs` :arrow_right: `HrFlow.ai Jobs` - -Retrieves all jobs via the ***Recruitee*** API and send them to a ***Hrflow.ai Board***. - - - -## Action Parameters - -| Field | Type | Default | Description | -| ----- | ---- | ------- | ----------- | -| `logics` | `typing.List[typing.Callable[[typing.Dict], typing.Optional[typing.Dict]]]` | [] | List of logic functions | -| `format` | `typing.Callable[[typing.Dict], typing.Dict]` | [`format_job`](../connector.py#L177) | Formatting function | -| `read_mode` | `str` | ReadMode.sync | If 'incremental' then `read_from` of the last run is given to Origin Warehouse during read. **The actual behavior depends on implementation of read**. In 'sync' mode `read_from` is neither fetched nor given to Origin Warehouse during read. | - -## Source Parameters - -| Field | Type | Default | Description | -| ----- | ---- | ------- | ----------- | -| `company_id` :red_circle: | `str` | None | Company ID. A company subdomain can also be used. | -| `api_token` :red_circle: | `str` | None | Personal API Token allowing access to the Recruitee API from external services. | -| `recruitee_endpoint` :red_circle: | `str` | None | Specifies which endpoint to be used, satging or production. | -| `kind` | `str` | None | If no kind is given, returns all job offers, if kind is job then lists only jobs, if scope is talent_pool, lists only talent pools | -| `scope` | `str` | None | If no scope is given list all job offers. archived returns only archived job offers, active returns published, internal and closed job offers, not_archived returns all but archived jobs | -| `view_mode` | `str` | brief | default (default mode, includes most of offer details); brief (only offer’s id, title, status and kind) | - -## Destination Parameters - -| Field | Type | Default | Description | -| ----- | ---- | ------- | ----------- | -| `api_secret` :red_circle: | `str` | None | X-API-KEY used to access HrFlow.ai API | -| `api_user` :red_circle: | `str` | None | X-USER-EMAIL used to access HrFlow.ai API | -| `board_key` :red_circle: | `str` | None | HrFlow.ai board key | -| `sync` | `bool` | True | When enabled only pushed jobs will remain in the board | -| `update_content` | `bool` | False | When enabled jobs already present in the board are updated | -| `enrich_with_parsing` | `bool` | False | When enabled jobs are enriched with HrFlow.ai parsing | - -:red_circle: : *required* - -## Example - -```python -import logging -from hrflow_connectors import Recruitee -from hrflow_connectors.core import ReadMode - - -logging.basicConfig(level=logging.INFO) - - -Recruitee.pull_job_list( - workflow_id="some_string_identifier", - action_parameters=dict( - logics=[], - format=lambda *args, **kwargs: None # Put your code logic here, - read_mode=ReadMode.sync, - ), - origin_parameters=dict( - company_id="your_company_id", - api_token="your_api_token", - recruitee_endpoint="STAGING ENDPOINT", - kind="your_kind", - scope="your_scope", - view_mode="brief", - ), - target_parameters=dict( - api_secret="your_api_secret", - api_user="your_api_user", - board_key="your_board_key", - sync=True, - update_content=False, - enrich_with_parsing=False, - ) -) -``` \ No newline at end of file diff --git a/src/hrflow_connectors/v2/connectors/recruitee/docs/pull_profile_list.md b/src/hrflow_connectors/v2/connectors/recruitee/docs/pull_profile_list.md deleted file mode 100644 index a1a5ecd60..000000000 --- a/src/hrflow_connectors/v2/connectors/recruitee/docs/pull_profile_list.md +++ /dev/null @@ -1,89 +0,0 @@ -# Pull profile list -`Recruitee Profiles` :arrow_right: `HrFlow.ai Profiles` - -Retrieves all profiles via the ***Recruitee*** API and send them to a ***Hrflow.ai Source***. - - - -## Action Parameters - -| Field | Type | Default | Description | -| ----- | ---- | ------- | ----------- | -| `logics` | `typing.List[typing.Callable[[typing.Dict], typing.Optional[typing.Dict]]]` | [] | List of logic functions | -| `format` | `typing.Callable[[typing.Dict], typing.Dict]` | [`format_to_hrflow_profile`](../connector.py#L55) | Formatting function | -| `read_mode` | `str` | ReadMode.sync | If 'incremental' then `read_from` of the last run is given to Origin Warehouse during read. **The actual behavior depends on implementation of read**. In 'sync' mode `read_from` is neither fetched nor given to Origin Warehouse during read. | - -## Source Parameters - -| Field | Type | Default | Description | -| ----- | ---- | ------- | ----------- | -| `company_id` :red_circle: | `str` | None | Company ID. A company subdomain can also be used. | -| `api_token` :red_circle: | `str` | None | Personal API Token allowing access to the Recruitee API from external services. | -| `recruitee_endpoint` :red_circle: | `str` | None | Specifies which endpoint to be used, satging or production. | -| `limit` | `int` | None | Specifies the number of candidates to retrieve | -| `offset` | `int` | None | Skip number of candidates from the begining, used for ‘load more’, offset for next page should be current offset + limit | -| `created_after` | `str` | None | Show only candidates created after given date | -| `disqualified` | `bool` | None | Show only disqualified candidates who are disqualified in at least one job (should be string ‘true’ or ‘1’). | -| `qualified` | `bool` | None | Show only disqualified candidates who are qualified in at least one job (should be string ‘true’ or ‘1’). | -| `ids` | `str` | None | List of IDs separated by comma, example: 234221,4211412,535432 | -| `offer_id` | `str` | None | Filter by offer | -| `query` | `str` | None | Search query for candidate’s name or offer | -| `sort` | `str` | None | Sorting options: by_date, by_last_message | -| `with_messages` | `bool` | None | Show only candidates with messages (should be string ‘true’ or ‘1’) | -| `with_my_messages` | `bool` | None | Show only candidates with messages that current admin sent (should be string ‘true’ or ‘1’ | - -## Destination Parameters - -| Field | Type | Default | Description | -| ----- | ---- | ------- | ----------- | -| `api_secret` :red_circle: | `str` | None | X-API-KEY used to access HrFlow.ai API | -| `api_user` :red_circle: | `str` | None | X-USER-EMAIL used to access HrFlow.ai API | -| `source_key` :red_circle: | `str` | None | HrFlow.ai source key | -| `edit` | `bool` | False | When enabled the profile must exist in the source | -| `only_edit_fields` :red_circle: | `typing.List[str]` | None | List of attributes to use for the edit operation e.g. ['tags', 'metadatas'] | - -:red_circle: : *required* - -## Example - -```python -import logging -from hrflow_connectors import Recruitee -from hrflow_connectors.core import ReadMode - - -logging.basicConfig(level=logging.INFO) - - -Recruitee.pull_profile_list( - workflow_id="some_string_identifier", - action_parameters=dict( - logics=[], - format=lambda *args, **kwargs: None # Put your code logic here, - read_mode=ReadMode.sync, - ), - origin_parameters=dict( - company_id="your_company_id", - api_token="your_api_token", - recruitee_endpoint="STAGING ENDPOINT", - limit=0, - offset=0, - created_after="your_created_after", - disqualified=False, - qualified=False, - ids="your_ids", - offer_id="your_offer_id", - query="your_query", - sort="by_date", - with_messages=False, - with_my_messages=False, - ), - target_parameters=dict( - api_secret="your_api_secret", - api_user="your_api_user", - source_key="your_source_key", - edit=False, - only_edit_fields=***, - ) -) -``` \ No newline at end of file diff --git a/src/hrflow_connectors/v2/connectors/recruitee/docs/push_profile.md b/src/hrflow_connectors/v2/connectors/recruitee/docs/push_profile.md deleted file mode 100644 index f1aad440f..000000000 --- a/src/hrflow_connectors/v2/connectors/recruitee/docs/push_profile.md +++ /dev/null @@ -1,67 +0,0 @@ -# Push profile -`HrFlow.ai Profiles` :arrow_right: `Recruitee Profiles` - -Writes a profile from Hrflow.ai Source as a candidate on Recruitee via the API - - - -## Action Parameters - -| Field | Type | Default | Description | -| ----- | ---- | ------- | ----------- | -| `logics` | `typing.List[typing.Callable[[typing.Dict], typing.Optional[typing.Dict]]]` | [] | List of logic functions | -| `format` | `typing.Callable[[typing.Dict], typing.Dict]` | [`format_profile`](../connector.py#L39) | Formatting function | -| `read_mode` | `str` | ReadMode.sync | If 'incremental' then `read_from` of the last run is given to Origin Warehouse during read. **The actual behavior depends on implementation of read**. In 'sync' mode `read_from` is neither fetched nor given to Origin Warehouse during read. | - -## Source Parameters - -| Field | Type | Default | Description | -| ----- | ---- | ------- | ----------- | -| `api_secret` :red_circle: | `str` | None | X-API-KEY used to access HrFlow.ai API | -| `api_user` :red_circle: | `str` | None | X-USER-EMAIL used to access HrFlow.ai API | -| `source_key` :red_circle: | `str` | None | HrFlow.ai source key | -| `profile_key` :red_circle: | `str` | None | HrFlow.ai profile key | - -## Destination Parameters - -| Field | Type | Default | Description | -| ----- | ---- | ------- | ----------- | -| `company_id` :red_circle: | `str` | None | Company ID. A company subdomain can also be used. | -| `api_token` :red_circle: | `str` | None | Personal API Token allowing access to the Recruitee API from external services. | -| `recruitee_endpoint` :red_circle: | `str` | None | Specifies which endpoint to be used, satging or production. | -| `offer_ids` | `typing.List[int]` | None | Offers to which the candidate will be assigned with default stage. You can also pass one ID as offer_id | - -:red_circle: : *required* - -## Example - -```python -import logging -from hrflow_connectors import Recruitee -from hrflow_connectors.core import ReadMode - - -logging.basicConfig(level=logging.INFO) - - -Recruitee.push_profile( - workflow_id="some_string_identifier", - action_parameters=dict( - logics=[], - format=lambda *args, **kwargs: None # Put your code logic here, - read_mode=ReadMode.sync, - ), - origin_parameters=dict( - api_secret="your_api_secret", - api_user="your_api_user", - source_key="your_source_key", - profile_key="your_profile_key", - ), - target_parameters=dict( - company_id="your_company_id", - api_token="your_api_token", - recruitee_endpoint="STAGING ENDPOINT", - offer_ids=***, - ) -) -``` \ No newline at end of file