diff --git a/src/hrflow_connectors/v2/connectors/admen/docs/archive_jobs_in_hrflow.md b/src/hrflow_connectors/v2/connectors/admen/docs/archive_jobs_in_hrflow.md index a68144fd..6c241e1e 100644 --- a/src/hrflow_connectors/v2/connectors/admen/docs/archive_jobs_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/admen/docs/archive_jobs_in_hrflow.md @@ -15,7 +15,7 @@ Send **archived** 'job(s)' _from_ AD-MEN _to_ HrFlow | `db_user` :red_circle: | `string` | None | The username to connect to the database | | `db_password` :red_circle: | `string` | None | The password to connect to the database | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/admen/docs/archive_profiles_in_admen.md b/src/hrflow_connectors/v2/connectors/admen/docs/archive_profiles_in_admen.md index 58a497d8..215cad7f 100644 --- a/src/hrflow_connectors/v2/connectors/admen/docs/archive_profiles_in_admen.md +++ b/src/hrflow_connectors/v2/connectors/admen/docs/archive_profiles_in_admen.md @@ -15,7 +15,7 @@ Send **archived** 'profile(s)' _from_ HrFlow _to_ AD-MEN | `db_user` :red_circle: | `string` | None | The username to connect to the database | | `db_password` :red_circle: | `string` | None | The password to connect to the database | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/admen/docs/archive_profiles_in_hrflow.md b/src/hrflow_connectors/v2/connectors/admen/docs/archive_profiles_in_hrflow.md index 1993381e..6cc5cd7c 100644 --- a/src/hrflow_connectors/v2/connectors/admen/docs/archive_profiles_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/admen/docs/archive_profiles_in_hrflow.md @@ -15,7 +15,7 @@ Send **archived** 'profile(s)' _from_ AD-MEN _to_ HrFlow | `db_user` :red_circle: | `string` | None | The username to connect to the database | | `db_password` :red_circle: | `string` | None | The password to connect to the database | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/admen/docs/create_jobs_in_hrflow.md b/src/hrflow_connectors/v2/connectors/admen/docs/create_jobs_in_hrflow.md index 3c7b1936..c09fd8db 100644 --- a/src/hrflow_connectors/v2/connectors/admen/docs/create_jobs_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/admen/docs/create_jobs_in_hrflow.md @@ -15,7 +15,7 @@ Send **created** 'job(s)' _from_ AD-MEN _to_ HrFlow | `db_user` :red_circle: | `string` | None | The username to connect to the database | | `db_password` :red_circle: | `string` | None | The password to connect to the database | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/admen/docs/create_profiles_in_admen.md b/src/hrflow_connectors/v2/connectors/admen/docs/create_profiles_in_admen.md index 14639611..b5127cd0 100644 --- a/src/hrflow_connectors/v2/connectors/admen/docs/create_profiles_in_admen.md +++ b/src/hrflow_connectors/v2/connectors/admen/docs/create_profiles_in_admen.md @@ -15,7 +15,7 @@ Send **created** 'profile(s)' _from_ HrFlow _to_ AD-MEN | `db_user` :red_circle: | `string` | None | The username to connect to the database | | `db_password` :red_circle: | `string` | None | The password to connect to the database | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/admen/docs/create_profiles_in_hrflow.md b/src/hrflow_connectors/v2/connectors/admen/docs/create_profiles_in_hrflow.md index d46e5555..9eea269c 100644 --- a/src/hrflow_connectors/v2/connectors/admen/docs/create_profiles_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/admen/docs/create_profiles_in_hrflow.md @@ -15,7 +15,7 @@ Send **created** 'profile(s)' _from_ AD-MEN _to_ HrFlow | `db_user` :red_circle: | `string` | None | The username to connect to the database | | `db_password` :red_circle: | `string` | None | The password to connect to the database | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/admen/docs/update_jobs_in_hrflow.md b/src/hrflow_connectors/v2/connectors/admen/docs/update_jobs_in_hrflow.md index 3c356e7e..31b5d45d 100644 --- a/src/hrflow_connectors/v2/connectors/admen/docs/update_jobs_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/admen/docs/update_jobs_in_hrflow.md @@ -15,7 +15,7 @@ Send **updated** 'job(s)' _from_ AD-MEN _to_ HrFlow | `db_user` :red_circle: | `string` | None | The username to connect to the database | | `db_password` :red_circle: | `string` | None | The password to connect to the database | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/admen/docs/update_profiles_in_admen.md b/src/hrflow_connectors/v2/connectors/admen/docs/update_profiles_in_admen.md index 787fc4fb..f5753de5 100644 --- a/src/hrflow_connectors/v2/connectors/admen/docs/update_profiles_in_admen.md +++ b/src/hrflow_connectors/v2/connectors/admen/docs/update_profiles_in_admen.md @@ -15,7 +15,7 @@ Send **updated** 'profile(s)' _from_ HrFlow _to_ AD-MEN | `db_user` :red_circle: | `string` | None | The username to connect to the database | | `db_password` :red_circle: | `string` | None | The password to connect to the database | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/admen/docs/update_profiles_in_hrflow.md b/src/hrflow_connectors/v2/connectors/admen/docs/update_profiles_in_hrflow.md index 24d8e9f7..1f57eef1 100644 --- a/src/hrflow_connectors/v2/connectors/admen/docs/update_profiles_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/admen/docs/update_profiles_in_hrflow.md @@ -15,7 +15,7 @@ Send **updated** 'profile(s)' _from_ AD-MEN _to_ HrFlow | `db_user` :red_circle: | `string` | None | The username to connect to the database | | `db_password` :red_circle: | `string` | None | The password to connect to the database | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/bullhorn/docs/archive_jobs_in_hrflow.md b/src/hrflow_connectors/v2/connectors/bullhorn/docs/archive_jobs_in_hrflow.md index 64b47daf..b949b58c 100644 --- a/src/hrflow_connectors/v2/connectors/bullhorn/docs/archive_jobs_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/bullhorn/docs/archive_jobs_in_hrflow.md @@ -14,7 +14,7 @@ Send **archived** 'job(s)' _from_ Bullhorn _to_ HrFlow | `password` :red_circle: | `string` | None | Password for Bullhorn login | | `username` :red_circle: | `string` | None | Username for Bullhorn login | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/bullhorn/docs/archive_profiles_in_hrflow.md b/src/hrflow_connectors/v2/connectors/bullhorn/docs/archive_profiles_in_hrflow.md index f2da1236..165f189c 100644 --- a/src/hrflow_connectors/v2/connectors/bullhorn/docs/archive_profiles_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/bullhorn/docs/archive_profiles_in_hrflow.md @@ -14,7 +14,7 @@ Send **archived** 'profile(s)' _from_ Bullhorn _to_ HrFlow | `password` :red_circle: | `string` | None | Password for Bullhorn login | | `username` :red_circle: | `string` | None | Username for Bullhorn login | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/bullhorn/docs/create_jobs_in_hrflow.md b/src/hrflow_connectors/v2/connectors/bullhorn/docs/create_jobs_in_hrflow.md index db7b7301..e6b7e24a 100644 --- a/src/hrflow_connectors/v2/connectors/bullhorn/docs/create_jobs_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/bullhorn/docs/create_jobs_in_hrflow.md @@ -14,7 +14,7 @@ Send **created** 'job(s)' _from_ Bullhorn _to_ HrFlow | `password` :red_circle: | `string` | None | Password for Bullhorn login | | `username` :red_circle: | `string` | None | Username for Bullhorn login | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/bullhorn/docs/create_profiles_in_hrflow.md b/src/hrflow_connectors/v2/connectors/bullhorn/docs/create_profiles_in_hrflow.md index 57d0bc58..90937686 100644 --- a/src/hrflow_connectors/v2/connectors/bullhorn/docs/create_profiles_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/bullhorn/docs/create_profiles_in_hrflow.md @@ -14,7 +14,7 @@ Send **created** 'profile(s)' _from_ Bullhorn _to_ HrFlow | `password` :red_circle: | `string` | None | Password for Bullhorn login | | `username` :red_circle: | `string` | None | Username for Bullhorn login | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/bullhorn/docs/update_jobs_in_hrflow.md b/src/hrflow_connectors/v2/connectors/bullhorn/docs/update_jobs_in_hrflow.md index b61245a4..5c7fe069 100644 --- a/src/hrflow_connectors/v2/connectors/bullhorn/docs/update_jobs_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/bullhorn/docs/update_jobs_in_hrflow.md @@ -14,7 +14,7 @@ Send **updated** 'job(s)' _from_ Bullhorn _to_ HrFlow | `password` :red_circle: | `string` | None | Password for Bullhorn login | | `username` :red_circle: | `string` | None | Username for Bullhorn login | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/bullhorn/docs/update_profiles_in_hrflow.md b/src/hrflow_connectors/v2/connectors/bullhorn/docs/update_profiles_in_hrflow.md index 28ef1e29..93694919 100644 --- a/src/hrflow_connectors/v2/connectors/bullhorn/docs/update_profiles_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/bullhorn/docs/update_profiles_in_hrflow.md @@ -14,7 +14,7 @@ Send **updated** 'profile(s)' _from_ Bullhorn _to_ HrFlow | `password` :red_circle: | `string` | None | Password for Bullhorn login | | `username` :red_circle: | `string` | None | Username for Bullhorn login | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/hubspot/docs/archive_profiles_in_hrflow.md b/src/hrflow_connectors/v2/connectors/hubspot/docs/archive_profiles_in_hrflow.md index b4cf508a..b3358b18 100644 --- a/src/hrflow_connectors/v2/connectors/hubspot/docs/archive_profiles_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/hubspot/docs/archive_profiles_in_hrflow.md @@ -11,7 +11,7 @@ Send **archived** 'profile(s)' _from_ Hubspot _to_ HrFlow | ----- | ---- | ------- | ----------- | | `access_token` :red_circle: | `string` | None | The token used to authenticate any API calls made for to your HubSpot account. | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/hubspot/docs/archive_profiles_in_hubspot.md b/src/hrflow_connectors/v2/connectors/hubspot/docs/archive_profiles_in_hubspot.md index 3759bf2c..a393992d 100644 --- a/src/hrflow_connectors/v2/connectors/hubspot/docs/archive_profiles_in_hubspot.md +++ b/src/hrflow_connectors/v2/connectors/hubspot/docs/archive_profiles_in_hubspot.md @@ -11,7 +11,7 @@ Send **archived** 'profile(s)' _from_ HrFlow _to_ Hubspot | ----- | ---- | ------- | ----------- | | `access_token` :red_circle: | `string` | None | The token used to authenticate any API calls made for to your HubSpot account. | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/hubspot/docs/create_profiles_in_hrflow.md b/src/hrflow_connectors/v2/connectors/hubspot/docs/create_profiles_in_hrflow.md index 3e65df46..69dac0ab 100644 --- a/src/hrflow_connectors/v2/connectors/hubspot/docs/create_profiles_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/hubspot/docs/create_profiles_in_hrflow.md @@ -11,7 +11,7 @@ Send **created** 'profile(s)' _from_ Hubspot _to_ HrFlow | ----- | ---- | ------- | ----------- | | `access_token` :red_circle: | `string` | None | The token used to authenticate any API calls made for to your HubSpot account. | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/hubspot/docs/create_profiles_in_hubspot.md b/src/hrflow_connectors/v2/connectors/hubspot/docs/create_profiles_in_hubspot.md index 3521330e..fc57368d 100644 --- a/src/hrflow_connectors/v2/connectors/hubspot/docs/create_profiles_in_hubspot.md +++ b/src/hrflow_connectors/v2/connectors/hubspot/docs/create_profiles_in_hubspot.md @@ -11,7 +11,7 @@ Send **created** 'profile(s)' _from_ HrFlow _to_ Hubspot | ----- | ---- | ------- | ----------- | | `access_token` :red_circle: | `string` | None | The token used to authenticate any API calls made for to your HubSpot account. | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/hubspot/docs/update_profiles_in_hrflow.md b/src/hrflow_connectors/v2/connectors/hubspot/docs/update_profiles_in_hrflow.md index c4746449..07d60b3c 100644 --- a/src/hrflow_connectors/v2/connectors/hubspot/docs/update_profiles_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/hubspot/docs/update_profiles_in_hrflow.md @@ -11,7 +11,7 @@ Send **updated** 'profile(s)' _from_ Hubspot _to_ HrFlow | ----- | ---- | ------- | ----------- | | `access_token` :red_circle: | `string` | None | The token used to authenticate any API calls made for to your HubSpot account. | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/hubspot/docs/update_profiles_in_hubspot.md b/src/hrflow_connectors/v2/connectors/hubspot/docs/update_profiles_in_hubspot.md index 31d93d89..4d6a6966 100644 --- a/src/hrflow_connectors/v2/connectors/hubspot/docs/update_profiles_in_hubspot.md +++ b/src/hrflow_connectors/v2/connectors/hubspot/docs/update_profiles_in_hubspot.md @@ -11,7 +11,7 @@ Send **updated** 'profile(s)' _from_ HrFlow _to_ Hubspot | ----- | ---- | ------- | ----------- | | `access_token` :red_circle: | `string` | None | The token used to authenticate any API calls made for to your HubSpot account. | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/recruitee/docs/archive_jobs_in_hrflow.md b/src/hrflow_connectors/v2/connectors/recruitee/docs/archive_jobs_in_hrflow.md index 6d6c5353..e8b8d290 100644 --- a/src/hrflow_connectors/v2/connectors/recruitee/docs/archive_jobs_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/recruitee/docs/archive_jobs_in_hrflow.md @@ -13,7 +13,7 @@ Send **archived** 'job(s)' _from_ Recruitee _to_ HrFlow | `api_token` :red_circle: | `string` | None | Personal API Token allowing access to the Recruitee API from external services. | | `recruitee_endpoint` | `Literal['https://api.rc.recruitee.dev/c','https://api.recruitee.com/c','https://api.s.recruitee.com/c']` | https://api.recruitee.com/c | Specifies which endpoint to be used, satging or production. | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/recruitee/docs/archive_profiles_in_hrflow.md b/src/hrflow_connectors/v2/connectors/recruitee/docs/archive_profiles_in_hrflow.md index a972d423..0f58b8f3 100644 --- a/src/hrflow_connectors/v2/connectors/recruitee/docs/archive_profiles_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/recruitee/docs/archive_profiles_in_hrflow.md @@ -13,7 +13,7 @@ Send **archived** 'profile(s)' _from_ Recruitee _to_ HrFlow | `api_token` :red_circle: | `string` | None | Personal API Token allowing access to the Recruitee API from external services. | | `recruitee_endpoint` | `Literal['https://api.rc.recruitee.dev/c','https://api.recruitee.com/c','https://api.s.recruitee.com/c']` | https://api.recruitee.com/c | Specifies which endpoint to be used, satging or production. | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/recruitee/docs/archive_profiles_in_recruitee.md b/src/hrflow_connectors/v2/connectors/recruitee/docs/archive_profiles_in_recruitee.md index 6a795db5..db71fd41 100644 --- a/src/hrflow_connectors/v2/connectors/recruitee/docs/archive_profiles_in_recruitee.md +++ b/src/hrflow_connectors/v2/connectors/recruitee/docs/archive_profiles_in_recruitee.md @@ -13,7 +13,7 @@ Send **archived** 'profile(s)' _from_ HrFlow _to_ Recruitee | `api_token` :red_circle: | `string` | None | Personal API Token allowing access to the Recruitee API from external services. | | `recruitee_endpoint` | `Literal['https://api.rc.recruitee.dev/c','https://api.recruitee.com/c','https://api.s.recruitee.com/c']` | https://api.recruitee.com/c | Specifies which endpoint to be used, satging or production. | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/recruitee/docs/create_jobs_in_hrflow.md b/src/hrflow_connectors/v2/connectors/recruitee/docs/create_jobs_in_hrflow.md index 19a56950..b6ae1891 100644 --- a/src/hrflow_connectors/v2/connectors/recruitee/docs/create_jobs_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/recruitee/docs/create_jobs_in_hrflow.md @@ -13,7 +13,7 @@ Send **created** 'job(s)' _from_ Recruitee _to_ HrFlow | `api_token` :red_circle: | `string` | None | Personal API Token allowing access to the Recruitee API from external services. | | `recruitee_endpoint` | `Literal['https://api.rc.recruitee.dev/c','https://api.recruitee.com/c','https://api.s.recruitee.com/c']` | https://api.recruitee.com/c | Specifies which endpoint to be used, satging or production. | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/recruitee/docs/create_profiles_in_hrflow.md b/src/hrflow_connectors/v2/connectors/recruitee/docs/create_profiles_in_hrflow.md index 1a2d2648..2a1288e2 100644 --- a/src/hrflow_connectors/v2/connectors/recruitee/docs/create_profiles_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/recruitee/docs/create_profiles_in_hrflow.md @@ -13,7 +13,7 @@ Send **created** 'profile(s)' _from_ Recruitee _to_ HrFlow | `api_token` :red_circle: | `string` | None | Personal API Token allowing access to the Recruitee API from external services. | | `recruitee_endpoint` | `Literal['https://api.rc.recruitee.dev/c','https://api.recruitee.com/c','https://api.s.recruitee.com/c']` | https://api.recruitee.com/c | Specifies which endpoint to be used, satging or production. | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/recruitee/docs/create_profiles_in_recruitee.md b/src/hrflow_connectors/v2/connectors/recruitee/docs/create_profiles_in_recruitee.md index 824eee7f..04b4af03 100644 --- a/src/hrflow_connectors/v2/connectors/recruitee/docs/create_profiles_in_recruitee.md +++ b/src/hrflow_connectors/v2/connectors/recruitee/docs/create_profiles_in_recruitee.md @@ -13,7 +13,7 @@ Send **created** 'profile(s)' _from_ HrFlow _to_ Recruitee | `api_token` :red_circle: | `string` | None | Personal API Token allowing access to the Recruitee API from external services. | | `recruitee_endpoint` | `Literal['https://api.rc.recruitee.dev/c','https://api.recruitee.com/c','https://api.s.recruitee.com/c']` | https://api.recruitee.com/c | Specifies which endpoint to be used, satging or production. | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/recruitee/docs/update_jobs_in_hrflow.md b/src/hrflow_connectors/v2/connectors/recruitee/docs/update_jobs_in_hrflow.md index 0d0bac5d..a92b0946 100644 --- a/src/hrflow_connectors/v2/connectors/recruitee/docs/update_jobs_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/recruitee/docs/update_jobs_in_hrflow.md @@ -13,7 +13,7 @@ Send **updated** 'job(s)' _from_ Recruitee _to_ HrFlow | `api_token` :red_circle: | `string` | None | Personal API Token allowing access to the Recruitee API from external services. | | `recruitee_endpoint` | `Literal['https://api.rc.recruitee.dev/c','https://api.recruitee.com/c','https://api.s.recruitee.com/c']` | https://api.recruitee.com/c | Specifies which endpoint to be used, satging or production. | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/recruitee/docs/update_profiles_in_hrflow.md b/src/hrflow_connectors/v2/connectors/recruitee/docs/update_profiles_in_hrflow.md index b336f97c..cbb4a25f 100644 --- a/src/hrflow_connectors/v2/connectors/recruitee/docs/update_profiles_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/recruitee/docs/update_profiles_in_hrflow.md @@ -13,7 +13,7 @@ Send **updated** 'profile(s)' _from_ Recruitee _to_ HrFlow | `api_token` :red_circle: | `string` | None | Personal API Token allowing access to the Recruitee API from external services. | | `recruitee_endpoint` | `Literal['https://api.rc.recruitee.dev/c','https://api.recruitee.com/c','https://api.s.recruitee.com/c']` | https://api.recruitee.com/c | Specifies which endpoint to be used, satging or production. | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/recruitee/docs/update_profiles_in_recruitee.md b/src/hrflow_connectors/v2/connectors/recruitee/docs/update_profiles_in_recruitee.md index 7de03bde..dc58c970 100644 --- a/src/hrflow_connectors/v2/connectors/recruitee/docs/update_profiles_in_recruitee.md +++ b/src/hrflow_connectors/v2/connectors/recruitee/docs/update_profiles_in_recruitee.md @@ -13,7 +13,7 @@ Send **updated** 'profile(s)' _from_ HrFlow _to_ Recruitee | `api_token` :red_circle: | `string` | None | Personal API Token allowing access to the Recruitee API from external services. | | `recruitee_endpoint` | `Literal['https://api.rc.recruitee.dev/c','https://api.recruitee.com/c','https://api.s.recruitee.com/c']` | https://api.recruitee.com/c | Specifies which endpoint to be used, satging or production. | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/smartrecruiters/aisles.py b/src/hrflow_connectors/v2/connectors/smartrecruiters/aisles.py index 2c951b41..63a8de6c 100644 --- a/src/hrflow_connectors/v2/connectors/smartrecruiters/aisles.py +++ b/src/hrflow_connectors/v2/connectors/smartrecruiters/aisles.py @@ -11,10 +11,11 @@ SmartRecruitersProfile, ) from hrflow_connectors.v2.core.common import Entity -from hrflow_connectors.v2.core.warehouse import ( # Endpoints, +from hrflow_connectors.v2.core.warehouse import ( Aisle, Criterias, Endpoint, + Endpoints, ReadOperation, WriteOperation, merge, @@ -460,11 +461,11 @@ def delete_profiles( update=read_profiles, archive=read_profiles, ), - # endpoints=Endpoints( - # create=GET_CANDIDATE_ENDPOINT, - # update=GET_CANDIDATE_ENDPOINT, - # archive=GET_CANDIDATE_ENDPOINT, - # ), + endpoints=Endpoints( + create=GET_CANDIDATE_ENDPOINT, + update=GET_CANDIDATE_ENDPOINT, + archive=GET_CANDIDATE_ENDPOINT, + ), ), write=WriteOperation( criterias=Criterias( @@ -477,10 +478,10 @@ def delete_profiles( update=update_profiles, archive=delete_profiles, ), - # endpoints=Endpoints( - # create=POST_CANDIDATE_ENDPOINT, - # update=UPDATE_CANDIDATE_ENDPOINT, - # archive=DELETE_CANDIDATE_ENDPOINT, - # ), + endpoints=Endpoints( + create=POST_CANDIDATE_ENDPOINT, + update=UPDATE_CANDIDATE_ENDPOINT, + archive=DELETE_CANDIDATE_ENDPOINT, + ), ), ) diff --git a/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/archive_jobs_in_hrflow.md b/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/archive_jobs_in_hrflow.md index 49e4e7db..3415ccde 100644 --- a/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/archive_jobs_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/archive_jobs_in_hrflow.md @@ -11,7 +11,7 @@ Send **archived** 'job(s)' _from_ SmartRecruiters _to_ HrFlow | ----- | ---- | ------- | ----------- | | `x_smart_token` :red_circle: | `string` | None | X-SmartToken used to access SmartRecruiters API | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/archive_profiles_in_hrflow.md b/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/archive_profiles_in_hrflow.md index e101e1b3..0d9ca3e6 100644 --- a/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/archive_profiles_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/archive_profiles_in_hrflow.md @@ -4,6 +4,12 @@ Send **archived** 'profile(s)' _from_ SmartRecruiters _to_ HrFlow +**SmartRecruiters endpoint used :** +| Endpoint | Description | +| --------- | ----------- | +| [**Get candidate**](https://developers.smartrecruiters.com/reference/candidatesget-1) | Endpoint to get the content of a candidate with a given id, a candidateId parameter is required, the request method is `GET` | + + ## SmartRecruiters Auth Parameters @@ -11,7 +17,7 @@ Send **archived** 'profile(s)' _from_ SmartRecruiters _to_ HrFlow | ----- | ---- | ------- | ----------- | | `x_smart_token` :red_circle: | `string` | None | X-SmartToken used to access SmartRecruiters API | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/archive_profiles_in_smartrecruiters.md b/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/archive_profiles_in_smartrecruiters.md index 4430da61..76a345ea 100644 --- a/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/archive_profiles_in_smartrecruiters.md +++ b/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/archive_profiles_in_smartrecruiters.md @@ -5,13 +5,19 @@ Send **archived** 'profile(s)' _from_ HrFlow _to_ SmartRecruiters +**SmartRecruiters endpoint used :** +| Endpoint | Description | +| --------- | ----------- | +| [**Delete Candidate**](https://developers.smartrecruiters.com/reference/candidatesdelete-1) | Endpoint to delete a candidate with a given id, a candidateId parameter is required, the request method is `DELETE` | + + ## SmartRecruiters Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | | `x_smart_token` :red_circle: | `string` | None | X-SmartToken used to access SmartRecruiters API | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/create_jobs_in_hrflow.md b/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/create_jobs_in_hrflow.md index 45e6fd41..ce28d5c5 100644 --- a/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/create_jobs_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/create_jobs_in_hrflow.md @@ -11,7 +11,7 @@ Send **created** 'job(s)' _from_ SmartRecruiters _to_ HrFlow | ----- | ---- | ------- | ----------- | | `x_smart_token` :red_circle: | `string` | None | X-SmartToken used to access SmartRecruiters API | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/create_profiles_in_hrflow.md b/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/create_profiles_in_hrflow.md index 5956bc2e..3204173c 100644 --- a/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/create_profiles_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/create_profiles_in_hrflow.md @@ -4,6 +4,12 @@ Send **created** 'profile(s)' _from_ SmartRecruiters _to_ HrFlow +**SmartRecruiters endpoint used :** +| Endpoint | Description | +| --------- | ----------- | +| [**Get candidate**](https://developers.smartrecruiters.com/reference/candidatesget-1) | Endpoint to get the content of a candidate with a given id, a candidateId parameter is required, the request method is `GET` | + + ## SmartRecruiters Auth Parameters @@ -11,7 +17,7 @@ Send **created** 'profile(s)' _from_ SmartRecruiters _to_ HrFlow | ----- | ---- | ------- | ----------- | | `x_smart_token` :red_circle: | `string` | None | X-SmartToken used to access SmartRecruiters API | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/create_profiles_in_smartrecruiters.md b/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/create_profiles_in_smartrecruiters.md index 5b173abd..7559843a 100644 --- a/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/create_profiles_in_smartrecruiters.md +++ b/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/create_profiles_in_smartrecruiters.md @@ -5,13 +5,19 @@ Send **created** 'profile(s)' _from_ HrFlow _to_ SmartRecruiters +**SmartRecruiters endpoint used :** +| Endpoint | Description | +| --------- | ----------- | +| [**Post Candidate**](https://developers.smartrecruiters.com/reference/candidatesadd-1) | Endpoint to create a new candidate and assign to a talent pool, the request method is `POST` | + + ## SmartRecruiters Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | | `x_smart_token` :red_circle: | `string` | None | X-SmartToken used to access SmartRecruiters API | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/update_jobs_in_hrflow.md b/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/update_jobs_in_hrflow.md index df76f3a9..65442966 100644 --- a/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/update_jobs_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/update_jobs_in_hrflow.md @@ -11,7 +11,7 @@ Send **updated** 'job(s)' _from_ SmartRecruiters _to_ HrFlow | ----- | ---- | ------- | ----------- | | `x_smart_token` :red_circle: | `string` | None | X-SmartToken used to access SmartRecruiters API | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/update_profiles_in_hrflow.md b/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/update_profiles_in_hrflow.md index 85c46881..4f16131f 100644 --- a/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/update_profiles_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/update_profiles_in_hrflow.md @@ -4,6 +4,12 @@ Send **updated** 'profile(s)' _from_ SmartRecruiters _to_ HrFlow +**SmartRecruiters endpoint used :** +| Endpoint | Description | +| --------- | ----------- | +| [**Get candidate**](https://developers.smartrecruiters.com/reference/candidatesget-1) | Endpoint to get the content of a candidate with a given id, a candidateId parameter is required, the request method is `GET` | + + ## SmartRecruiters Auth Parameters @@ -11,7 +17,7 @@ Send **updated** 'profile(s)' _from_ SmartRecruiters _to_ HrFlow | ----- | ---- | ------- | ----------- | | `x_smart_token` :red_circle: | `string` | None | X-SmartToken used to access SmartRecruiters API | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/update_profiles_in_smartrecruiters.md b/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/update_profiles_in_smartrecruiters.md index 0191ed5a..ce01f583 100644 --- a/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/update_profiles_in_smartrecruiters.md +++ b/src/hrflow_connectors/v2/connectors/smartrecruiters/docs/update_profiles_in_smartrecruiters.md @@ -5,13 +5,19 @@ Send **updated** 'profile(s)' _from_ HrFlow _to_ SmartRecruiters +**SmartRecruiters endpoint used :** +| Endpoint | Description | +| --------- | ----------- | +| [**Update Candidate**](https://developers.smartrecruiters.com/reference/candidatespatch-1) | Endpoint to update a candidate with a given id, a candidateId parameter is required, the request method is `PUT` | + + ## SmartRecruiters Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | | `x_smart_token` :red_circle: | `string` | None | X-SmartToken used to access SmartRecruiters API | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/zohorecruit/docs/archive_jobs_in_hrflow.md b/src/hrflow_connectors/v2/connectors/zohorecruit/docs/archive_jobs_in_hrflow.md index fcbec5ed..6cee3d78 100644 --- a/src/hrflow_connectors/v2/connectors/zohorecruit/docs/archive_jobs_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/zohorecruit/docs/archive_jobs_in_hrflow.md @@ -23,7 +23,7 @@ You must use your domain-specific Zoho Accounts URL to generate access and refre JP: https://accounts.zoho.jp CA: https://accounts.zohocloud.ca | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/zohorecruit/docs/archive_profiles_in_hrflow.md b/src/hrflow_connectors/v2/connectors/zohorecruit/docs/archive_profiles_in_hrflow.md index be3cf251..69d3ed09 100644 --- a/src/hrflow_connectors/v2/connectors/zohorecruit/docs/archive_profiles_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/zohorecruit/docs/archive_profiles_in_hrflow.md @@ -23,7 +23,7 @@ You must use your domain-specific Zoho Accounts URL to generate access and refre JP: https://accounts.zoho.jp CA: https://accounts.zohocloud.ca | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/zohorecruit/docs/archive_profiles_in_zohorecruit.md b/src/hrflow_connectors/v2/connectors/zohorecruit/docs/archive_profiles_in_zohorecruit.md index 8a0f14a6..c6f8558d 100644 --- a/src/hrflow_connectors/v2/connectors/zohorecruit/docs/archive_profiles_in_zohorecruit.md +++ b/src/hrflow_connectors/v2/connectors/zohorecruit/docs/archive_profiles_in_zohorecruit.md @@ -23,7 +23,7 @@ You must use your domain-specific Zoho Accounts URL to generate access and refre JP: https://accounts.zoho.jp CA: https://accounts.zohocloud.ca | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/zohorecruit/docs/create_jobs_in_hrflow.md b/src/hrflow_connectors/v2/connectors/zohorecruit/docs/create_jobs_in_hrflow.md index 45bb4bff..e2c241c1 100644 --- a/src/hrflow_connectors/v2/connectors/zohorecruit/docs/create_jobs_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/zohorecruit/docs/create_jobs_in_hrflow.md @@ -23,7 +23,7 @@ You must use your domain-specific Zoho Accounts URL to generate access and refre JP: https://accounts.zoho.jp CA: https://accounts.zohocloud.ca | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/zohorecruit/docs/create_profiles_in_hrflow.md b/src/hrflow_connectors/v2/connectors/zohorecruit/docs/create_profiles_in_hrflow.md index d6d92d6e..44076f23 100644 --- a/src/hrflow_connectors/v2/connectors/zohorecruit/docs/create_profiles_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/zohorecruit/docs/create_profiles_in_hrflow.md @@ -23,7 +23,7 @@ You must use your domain-specific Zoho Accounts URL to generate access and refre JP: https://accounts.zoho.jp CA: https://accounts.zohocloud.ca | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/zohorecruit/docs/create_profiles_in_zohorecruit.md b/src/hrflow_connectors/v2/connectors/zohorecruit/docs/create_profiles_in_zohorecruit.md index f77c9cef..98ac6b07 100644 --- a/src/hrflow_connectors/v2/connectors/zohorecruit/docs/create_profiles_in_zohorecruit.md +++ b/src/hrflow_connectors/v2/connectors/zohorecruit/docs/create_profiles_in_zohorecruit.md @@ -23,7 +23,7 @@ You must use your domain-specific Zoho Accounts URL to generate access and refre JP: https://accounts.zoho.jp CA: https://accounts.zohocloud.ca | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/zohorecruit/docs/update_jobs_in_hrflow.md b/src/hrflow_connectors/v2/connectors/zohorecruit/docs/update_jobs_in_hrflow.md index 922fd265..866021dc 100644 --- a/src/hrflow_connectors/v2/connectors/zohorecruit/docs/update_jobs_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/zohorecruit/docs/update_jobs_in_hrflow.md @@ -23,7 +23,7 @@ You must use your domain-specific Zoho Accounts URL to generate access and refre JP: https://accounts.zoho.jp CA: https://accounts.zohocloud.ca | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/zohorecruit/docs/update_profiles_in_hrflow.md b/src/hrflow_connectors/v2/connectors/zohorecruit/docs/update_profiles_in_hrflow.md index 4524bd84..23c4d995 100644 --- a/src/hrflow_connectors/v2/connectors/zohorecruit/docs/update_profiles_in_hrflow.md +++ b/src/hrflow_connectors/v2/connectors/zohorecruit/docs/update_profiles_in_hrflow.md @@ -23,7 +23,7 @@ You must use your domain-specific Zoho Accounts URL to generate access and refre JP: https://accounts.zoho.jp CA: https://accounts.zohocloud.ca | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/connectors/zohorecruit/docs/update_profiles_in_zohorecruit.md b/src/hrflow_connectors/v2/connectors/zohorecruit/docs/update_profiles_in_zohorecruit.md index be9e83bf..7a353f3e 100644 --- a/src/hrflow_connectors/v2/connectors/zohorecruit/docs/update_profiles_in_zohorecruit.md +++ b/src/hrflow_connectors/v2/connectors/zohorecruit/docs/update_profiles_in_zohorecruit.md @@ -23,7 +23,7 @@ You must use your domain-specific Zoho Accounts URL to generate access and refre JP: https://accounts.zoho.jp CA: https://accounts.zohocloud.ca | -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/core/templates/action_readme.md.j2 b/src/hrflow_connectors/v2/core/templates/action_readme.md.j2 index f029c675..2669dbbb 100644 --- a/src/hrflow_connectors/v2/core/templates/action_readme.md.j2 +++ b/src/hrflow_connectors/v2/core/templates/action_readme.md.j2 @@ -3,22 +3,18 @@ {{ description }} -{% if origin_endpoints %} -**{{ origin_name }} endpoints used :** -| Endpoints | Description | +{% if origin_endpoint %} +**{{ origin_name }} endpoint used :** +| Endpoint | Description | | --------- | ----------- | -{%- for endpoint in origin_endpoints %} -| [**{{ endpoint.name}}**]({{ endpoint.url }}) | {{ endpoint.description }} | -{%- endfor %} +| [**{{ origin_endpoint.name}}**]({{ origin_endpoint.url }}) | {{ origin_endpoint.description }} | {% endif %} -{% if target_endpoints %} -**{{ target_name }} endpoints used :** -| Endpoints | Description | +{% if target_endpoint %} +**{{ target_name }} endpoint used :** +| Endpoint | Description | | --------- | ----------- | -{%- for endpoint in target_endpoints %} -| [**{{ endpoint.name}}**]({{ endpoint.url }}) | {{ endpoint.description }} | -{%- endfor %} +| [**{{ target_endpoint.name}}**]({{ target_endpoint.url }}) | {{ target_endpoint.description }} | {% endif %} ## {{ connector_name }} Auth Parameters @@ -29,7 +25,7 @@ | `{{ field.name }}` {% if field.required %}:red_circle:{% endif %} | `{{ field.type | replace("|", "\|")}}` | {{ field.default }} | {{ field.description }} | {%- endfor %} -## HrFlow Auth Parameters +## HrFlow.ai Auth Parameters | Field | Type | Default | Description | | ----- | ---- | ------- | ----------- | diff --git a/src/hrflow_connectors/v2/core/templating.py b/src/hrflow_connectors/v2/core/templating.py index a761e5e4..0612baaa 100644 --- a/src/hrflow_connectors/v2/core/templating.py +++ b/src/hrflow_connectors/v2/core/templating.py @@ -251,8 +251,8 @@ def connector_action(connector: Connector, flow: Flow) -> str: origin_name=origin_name, target_name=target_name, description=flow.description(connector.name), - origin_endpoints=origin_aisle.read.endpoints.for_mode(flow.mode), - target_endpoints=target_aisle.write.endpoints.for_mode(flow.mode), + origin_endpoint=origin_aisle.read.endpoints.for_mode(flow.mode), + target_endpoint=target_aisle.write.endpoints.for_mode(flow.mode), connector_name=connector.name, connector_auth_fields=template_fields(connector.warehouse.auth), hrflow_auth_fields=template_fields(HrFlowWarehouse.auth), diff --git a/src/hrflow_connectors/v2/core/warehouse.py b/src/hrflow_connectors/v2/core/warehouse.py index 8a1576b9..dbb5b2bb 100644 --- a/src/hrflow_connectors/v2/core/warehouse.py +++ b/src/hrflow_connectors/v2/core/warehouse.py @@ -125,7 +125,7 @@ def parameters(self, mode: Mode): @dataclass -class Endpoinsts: +class Endpoints: create: t.Optional[Endpoint] = None update: t.Optional[Endpoint] = None archive: t.Optional[Endpoint] = None @@ -146,7 +146,7 @@ def for_mode(self, mode: Mode): class Operation(t.Generic[OperationT]): function: OperationT criterias: Criterias - endpoints: Endpoinsts = field(default_factory=Endpoinsts) + endpoints: Endpoints = field(default_factory=Endpoints) @dataclass diff --git a/tests/v2/core/test_documentation.py b/tests/v2/core/test_documentation.py index ddd44e07..72e5f5c2 100644 --- a/tests/v2/core/test_documentation.py +++ b/tests/v2/core/test_documentation.py @@ -1,5 +1,6 @@ import logging from pathlib import Path +from unittest import mock import pytest @@ -14,7 +15,11 @@ AmbiguousConnectorImportName, ConnectorImportNameNotFound, ) +from hrflow_connectors.v2.core.warehouse import Endpoint, Endpoints from tests.v2.core.conftest import SmartLeadsProto, TypedSmartLeads +from tests.v2.core.src.hrflow_connectors.connectors.smartleads.aisles.leads import ( + LeadsAisle, +) from tests.v2.core.utils import added_connectors, main_import_name_as NOTEBOOKS_FILE = "anyfile.txt" @@ -67,6 +72,64 @@ def clean(connectors_directory: Path, SmartLeads: TypedSmartLeads): directory.rmdir() +def test_documentation_works_if_endpoints_are_set_up( + connectors_directory: Path, SmartLeads: TypedSmartLeads +): + endpoints = Endpoints( + create=Endpoint( + name="Create", + description="Create a lead", + url="https://api.smartleads.com/create", + ), + update=Endpoint( + name="Update", + description="Update a lead", + url="https://api.smartleads.com/update", + ), + archive=Endpoint( + name="Archive", + description="Archive a lead", + url="https://api.smartleads.com/archive", + ), + ) + + with mock.patch.object(LeadsAisle.read, "endpoints", endpoints): + with mock.patch.object(LeadsAisle.write, "endpoints", endpoints): + with added_connectors([("SmartLeads", SmartLeads)]): + hrflow_connectors_docs( + connectors=[SmartLeads], + connectors_directory=connectors_directory, + ) + + for flow in SmartLeads.flows: + action_documentations = ( + connectors_directory + / SmartLeads.subtype + / "docs" + / f"{flow.name(SmartLeads.subtype)}.md" + ) + + assert action_documentations.exists() + + doc_content = action_documentations.read_text() + + if flow.mode == Mode.create: + endpoint = endpoints.create + elif flow.mode == Mode.update: + endpoint = endpoints.update + elif flow.mode == Mode.archive: + endpoint = endpoints.archive + + assert endpoint is not None + + assert "endpoint used" in doc_content + + assert ( + f"| [**{endpoint.name}**]({endpoint.url}) | {endpoint.description} |" + in doc_content + ) + + def test_documentation(connectors_directory: Path, SmartLeads: TypedSmartLeads): readme = connectors_directory / SmartLeads.subtype / "README.md" stub = connectors_directory / SmartLeads.subtype / "connector.pyi"