Skip to content

Commit

Permalink
Admen: docs & manifest
Browse files Browse the repository at this point in the history
  • Loading branch information
itsnedhir committed Nov 26, 2024
1 parent cf9761e commit 2cfd061
Show file tree
Hide file tree
Showing 18 changed files with 10,525 additions and 12,168 deletions.
21,932 changes: 9,785 additions & 12,147 deletions manifest.json

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ Send **archived** 'profile(s)' _from_ AD-MEN _to_ HrFlow

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
| `share_server` :red_circle: | `string` | None | The hostname of the network share server |
| `share_name` :red_circle: | `string` | None | The name of the network share |
| `share_username` :red_circle: | `string` | None | The username to connect to the network share |
| `share_password` :red_circle: | `string` | None | The password to connect to the network share |
| `share_server` | `string\|null` | None | The hostname of the network share server |
| `share_name` | `string\|null` | None | The name of the network share |
| `share_username` | `string\|null` | None | The username to connect to the network share |
| `share_password` | `string\|null` | None | The password to connect to the network share |
| `limit` | `integer\|null` | None | The maximum number of items to fetch |

## Push Parameters (HrFlow)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ Send **created** 'profile(s)' _from_ AD-MEN _to_ HrFlow

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
| `share_server` :red_circle: | `string` | None | The hostname of the network share server |
| `share_name` :red_circle: | `string` | None | The name of the network share |
| `share_username` :red_circle: | `string` | None | The username to connect to the network share |
| `share_password` :red_circle: | `string` | None | The password to connect to the network share |
| `share_server` | `string\|null` | None | The hostname of the network share server |
| `share_name` | `string\|null` | None | The name of the network share |
| `share_username` | `string\|null` | None | The username to connect to the network share |
| `share_password` | `string\|null` | None | The password to connect to the network share |
| `limit` | `integer\|null` | None | The maximum number of items to fetch |

## Push Parameters (HrFlow)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ Send **updated** 'profile(s)' _from_ AD-MEN _to_ HrFlow

| Field | Type | Default | Description |
| ----- | ---- | ------- | ----------- |
| `share_server` :red_circle: | `string` | None | The hostname of the network share server |
| `share_name` :red_circle: | `string` | None | The name of the network share |
| `share_username` :red_circle: | `string` | None | The username to connect to the network share |
| `share_password` :red_circle: | `string` | None | The password to connect to the network share |
| `share_server` | `string\|null` | None | The hostname of the network share server |
| `share_name` | `string\|null` | None | The name of the network share |
| `share_username` | `string\|null` | None | The username to connect to the network share |
| `share_password` | `string\|null` | None | The password to connect to the network share |
| `limit` | `integer\|null` | None | The maximum number of items to fetch |

## Push Parameters (HrFlow)
Expand Down
13 changes: 4 additions & 9 deletions src/hrflow_connectors/v2/connectors/admen/schemas.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
from msgspec import Struct


# Table : MISSION
class AdmenMission(Struct):
ID_MISSION: int
ID_SOCIETE: int
Expand Down Expand Up @@ -69,7 +68,7 @@ class AdmenMission(Struct):
SECTEURWEB: str
FONCTIONWEB: str
HTML: str
SOFT_DELETED: int # use for delete_jobs_in_hrflow
SOFT_DELETED: int
DATE_DELETED: datetime.date
ID_PERDEL: int
DATE_SAISIE: datetime.date
Expand Down Expand Up @@ -115,7 +114,7 @@ class AdmenMission(Struct):
SHOWEMAILASSI: int
URL: str
POSTIT: str
DATE_MAJ: str # use for update_jobs_in_hrflow alongside DATE_SAISIE
DATE_MAJ: str
INDEXED: int
CAC_FILTER: str
CAC_PERS1_ACCESS: int
Expand All @@ -132,7 +131,6 @@ class AdmenMission(Struct):
ENTITE: str


# Table : TANNONCES
class AdmenJob(Struct):
ID_ANNONCE: int
ID_SUPPORT: int
Expand Down Expand Up @@ -173,7 +171,6 @@ class AdmenJob(Struct):
DESCRASSIGNMENT_TXT: str


# Table : CANDIDATURE
class AdmenCandidature(Struct):
ID_MISSION: int
ID_PERSONNE: int
Expand Down Expand Up @@ -277,7 +274,6 @@ class AdmenCandidature(Struct):
Libre1: str


# Table : EXPERIENCES_PROFESSIONNELLES
class AdmenProfessionalExperience(Struct):
ID_PERSONNE: int
DATE_EXP: datetime.date
Expand All @@ -303,7 +299,6 @@ class AdmenProfessionalExperience(Struct):
ID_COMPADDR: int


# Table : Personnes
class AdmenProfile(Struct):
ID_PERSONNE: int
PER_ID_PERSONNE: int
Expand Down Expand Up @@ -359,7 +354,7 @@ class AdmenProfile(Struct):
TEL4_CONFIDENTIEL: int
GRAPHOLOGIE: int
DATE_CREATION: datetime.date
DATE_MAJ: datetime.datetime # use for update_profiles_in_hrflow alongside DATE_CREATION
DATE_MAJ: datetime.datetime
DATE_DEPUIS: datetime.date
NATIONALITE: str
SALAIRE: int
Expand Down Expand Up @@ -392,7 +387,7 @@ class AdmenProfile(Struct):
TEL_PERSO3: str
MOBILE_PRO: str
EN_COURS: int
SOFT_DELETED: int # use for delete_profiles_in_hrflow
SOFT_DELETED: int
DATE_DELETED: datetime.date
ID_PERDEL: int
COLOR: int
Expand Down
69 changes: 69 additions & 0 deletions src/hrflow_connectors/v2/connectors/hubspot/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# 📖 Summary
- [📖 Summary](#-summary)
- [📝 About Hubspot](#-about-hubspot)
- [📊 Data Flow](#-data-flow)
- [🔌 Connector Actions](#-connector-actions)
- [🐍 Quick Start Example](#-quick-start-example)
- [🔗 Useful Links](#-useful-links)
- [👏 Special Thanks](#-special-thanks)


# 📝 About Hubspot

HubSpot is a CRM platform with all the software, integrations, and resources you need to connect marketing, sales, content management, and customer service.


<p align="center">
<image src=https://user-images.githubusercontent.com/107410704/213674431-f11f9805-6c43-456b-bb3d-b60ebf698415.jpg width=90% height=100% >
</p>


# 📊 Data Flow
In this section, we outline the data flow between different components of the connector. The following schema provides a graphical representation of the data exchange process

<p align="center">

<image src=https://user-images.githubusercontent.com/107410704/213676477-70dd9009-f41b-4659-a58c-41f53a92f7d4.jpg width=90% height=100% >
</p>



# 🔌 Connector Actions
<p align="center">

| Action | Description |
| ------- | ----------- |
| [**Push profile**](docs/push_profile.md) | Writes a profile from Hrflow.ai Source as a contact on Hubspot via the API |
| [**Pull profile list**](docs/pull_profile_list.md) | Retrieves contacts from Hubspot via API and send them to a ***Hrflow.ai Source***. |


</p>


# 🐍 Quick Start Example


To make sure you can successfully run the latest versions of the example scripts, you have to **install the package from PyPi**.
To browse the examples of actions corresponding to released versions of 🤗 this connector, you just need to import the module like this :


<p align="center">
<image src=https://user-images.githubusercontent.com/107410704/219017227-8e7f86a6-fd8d-4e31-ab07-5ef13184eab0.png width=90% height=100% >
</p>

Once the connector module is imported, you can leverage all the different actions that it offers.

For more code details checkout connector code


# 🔗 Useful Links

- 📄Visit [Hubspot](https://www.hubspot.com) to learn more.
- ⚙️ API documentation : (https://developers.hubspot.com/docs/api/overview)
- 💻 [Connector code](https://github.com/Riminder/hrflow-connectors/tree/master/src/hrflow_connectors/connectors/hubspot) on our Github.


# 👏 Special Thanks
- 💻 HrFlow.ai : [Nedhir Ebnou](https://github.com/nedhirouebnou) - Software Engineer
- 🤝 Hubspot :[Hubspot for the accessible documentation](https://www.hubspot.com)

1 change: 1 addition & 0 deletions src/hrflow_connectors/v2/connectors/hubspot/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from hrflow_connectors.v1.connectors.hubspot.connector import Hubspot # noqa
Loading

0 comments on commit 2cfd061

Please sign in to comment.