fix(lever-ashby) yaml cleanup (#131)

## Describe your changes Improve endpoints and clean up groups ## Issue ticket number and link ## Checklist before requesting a review (skip if just adding/editing APIs & templates) - [ ] I added tests, otherwise the reason is: - [ ] External API requests have `retries` - [ ] Pagination is used where appropriate - [ ] The built in `nango.paginate` call is used instead of a `while (true)` loop - [ ] Third party requests are NOT parallelized (this can cause issues with rate limits) - [ ] If a sync requires metadata the `nango.yaml` has `auto_start: false` - [ ] If the sync is a `full` sync then `track_deletes: true` is set - [ ] I followed the best practices and guidelines from the [Writing Integration Scripts](/NangoHQ/integration-templates/blob/main/WRITING_INTEGRATION_SCRIPTS.md) doc
NangoHQ · Dec 3, 2024 · cd7fcfb · cd7fcfb
1 parent a20d56a
commit cd7fcfb
Show file tree

Hide file tree

Showing 18 changed files with 321 additions and 166 deletions.
diff --git a/flows.yaml b/flows.yaml
diff --git a/integrations/ashby/nango.yaml b/integrations/ashby/nango.yaml
@@ -11,6 +11,7 @@ integrations:
                 endpoint:
                     method: GET
                     path: /candidates
+                    group: Candidates
             jobs:
                 runs: every hour
                 output: AshbyJob
@@ -21,6 +22,7 @@ integrations:
                 endpoint:
                     method: GET
                     path: /jobs
+                    group: Jobs
         actions:
             create-application:
                 output: AshbyCreateApplicationResponse
@@ -30,6 +32,7 @@ integrations:
                 endpoint:
                     method: POST
                     path: /applications
+                    group: Applications
             create-note:
                 output: AshbyCreateNoteResponse
                 input: AshbyCreateNoteInput
@@ -38,6 +41,7 @@ integrations:
                 endpoint:
                     method: POST
                     path: /notes
+                    group: Notes
             application-change-source:
                 output: AshbyResponse
                 input: ChangeSource
@@ -64,13 +68,14 @@ integrations:
                 output: AshbyResponse
                 input: ChangeSource | ChangeStage | UpdateHistory
                 description: |
-                    Action to update an application stage.
+                    Action to update an application.
                 endpoint:
                     method: PATCH
-                    path: /applications/update
+                    path: /applications
                     group: Applications
                 scopes:
                     - candidatesWrite
+                version: 1.0.0
             application-update-history:
                 output: AshbyResponse
                 input: UpdateHistory
@@ -86,7 +91,7 @@ integrations:
                 output: AshbyResponse
                 input: CreateCandidate
                 description: |
-                    Action to update history an application stage.
+                    Action to create a candidate.
                 endpoint:
                     method: POST
                     path: /candidates

diff --git a/integrations/lever/actions/posting.ts → integrations/lever/actions/get-posting.ts b/integrations/lever/actions/posting.ts → integrations/lever/actions/get-posting.ts
diff --git a/integrations/lever/nango.yaml b/integrations/lever/nango.yaml
@@ -11,9 +11,11 @@ integrations:
                 input: LeverCreateNoteInput
                 endpoint:
                     method: POST
-                    path: /lever/create-note
+                    path: /notes
+                    group: Notes
                 scopes:
                     - notes:write:admin
+                version: 1.0.0
             create-opportunity:
                 description: |
                     Action to create candidates and opportunities in Lever
@@ -28,90 +30,102 @@ integrations:
                 version: 1.0.0
             get-stages:
                 description: |
-                    Action to get lists all pipeline stages in your Lever account.
+                    Action to get lists all pipeline stages. Note that this does 
+                    not paginate the response so it is possible that not all stages 
+                    are returned.
                 output: GetStages
                 endpoint:
                     method: GET
-                    path: /stages
-                    group: Opportunities
+                    path: /stages/limited
+                    group: Stages
+                version: 1.0.0
             users:
                 description: |
-                    Lists all the users in your Lever account. Only active users are included by default..
+                    Lists all the users in your Lever account. Only active users are included by default.
                 output: SuccessResponse
                 endpoint:
                     method: GET
                     path: /users
                     group: Users
             get-postings:
                 description: |
-                    Get all Posts for your account in Lever
+                    Get all posts for your account. Note that this does
+                    not paginate the response so it is possible that not all postings 
+                    are returned.
                 output: SuccessResponse
                 endpoint:
                     method: GET
-                    path: /posts/single
+                    path: /posts/limited
                     group: Posts
+                version: 1.0.0
             get-archive-reasons:
                 description: |
-                    Get all Posts for your account in Lever
+                    Get all archived reasons
                 output: SuccessResponse
                 endpoint:
                     method: GET
                     path: /archived/reasons
-                    group: Opportunities
-            posting:
+                    group: Archived
+            get-posting:
                 description: |
-                    Get single posts for your account in Lever
+                    Get single post for your account in Lever
                 output: SuccessResponse
                 input: SinglePost
                 endpoint:
                     method: GET
-                    path: /posts
+                    path: /posts/single
                     group: Posts
+                version: 1.0.0
             update-opportunity-links:
                 description: |
                     Update the links in an opportunity
                 output: SuccessResponse
                 input: UpdateLinks
                 endpoint:
                     method: POST
-                    path: /links
+                    path: /opportunities/links
                     group: Opportunities
+                version: 1.0.0
             update-opportunity-sources:
                 description: |
                     Update the sources in an opportunity
                 output: SuccessResponse
                 input: UpdateSources
                 endpoint:
                     method: POST
-                    path: /sources
+                    path: /opportunities/sources
                     group: Opportunities
+                version: 1.0.0
             update-opportunity-stage:
                 description: |
                     Update the stage in an opportunity
                 output: SuccessResponse
                 input: UpdateOpportunityStage
                 endpoint:
                     method: POST
-                    path: /stages
+                    path: /opportunities/stages
                     group: Opportunities
+                version: 1.0.0
             update-opportunity-tags:
                 description: |
                     Update the tags in an opportunity
                 output: SuccessResponse
                 input: UpdateTags
                 endpoint:
                     method: POST
-                    path: /tags
+                    path: /opportunities/tags
                     group: Opportunities
+                version: 1.0.0
             update-opportunity-archived:
                 description: |
                     Update the tags in an opportunity
                 output: SuccessResponse
                 input: ArchiveOpportunity
                 endpoint:
                     method: PUT
-                    path: /archived
+                    path: /opportunities/archived
                     group: Opportunities
+                version: 1.0.0
             apply-posting:
                 description: |
                     Submit an application on behalf of a candidate. This endpoint can only be used to submit applications to published or unlisted postings.
@@ -152,53 +166,62 @@ integrations:
                 sync_type: full
                 endpoint:
                     method: GET
-                    path: /lever/opportunities-applications
+                    path: /applications
+                    group: Applications
                 scopes:
                     - applications:read:admin
+                version: 1.0.0
             opportunities-feedbacks:
                 runs: every 6 hours
                 description: |
-                    Fetches a list of all feedback forms for a candidate for a specific Opportunity in lever
+                    Fetches a list of all feedback forms for a candidate for every single opportunity
                 output: LeverOpportunityFeedback
                 sync_type: full
                 endpoint:
                     method: GET
-                    path: /lever/opportunities-feedbacks
+                    path: /opportunities/feedback
+                    group: Opportunities
                 scopes:
                     - feedback:read:admin
             opportunities-interviews:
                 runs: every 6 hours
                 description: |
-                    Fetches a list of all interviewers for a specific Opportunity in lever
+                    Fetches a list of all interviews for every single opportunity
                 output: LeverOpportunityInterview
                 sync_type: full
                 endpoint:
                     method: GET
-                    path: /lever/opportunities-interviews
+                    path: /opportunities/interviewers
+                    group: Opportunities
                 scopes:
                     - interviews:read:admin
+                version: 1.0.0
             opportunities-notes:
                 runs: every 6 hours
                 description: |
-                    Fetches a list of all notes for a specific candidate in lever
+                    Fetches a list of all notes for every single opportunity
                 output: LeverOpportunityNote
                 sync_type: full
                 endpoint:
                     method: GET
-                    path: /lever/opportunities-notes
+                    path: /opportunities-notes
+                    group: Notes
                 scopes:
                     - notes:read:admin
+                version: 1.0.0
             opportunities-offers:
                 runs: every 6 hours
                 description: |
-                    Fetches a list of all offers for a specific candidate in lever.
+                    Fetches a list of all offers for every single opportunity
                 output: LeverOpportunityOffer
                 sync_type: full
                 endpoint:
                     method: GET
-                    path: /lever/opportunities-offers
+                    path: /opportunities/offers
+                    group: Offers
                 scopes:
                     - offers:write:admin
+                version: 1.0.0
             postings:
                 runs: every 6 hours
                 description: |
@@ -207,31 +230,37 @@ integrations:
                 sync_type: full
                 endpoint:
                     method: GET
-                    path: /lever/postings
+                    path: /postings
+                    group: Postings
                 scopes:
                     - postings:read:admin
-            postings-apply:
+                version: 1.0.0
+            postings-questions:
                 runs: every 6 hours
                 description: |
                     Fetches a list of all questions included in a posting’s application form in Lever
                 output: LeverPostingApply
                 sync_type: full
                 endpoint:
                     method: GET
-                    path: /lever/postings-apply
+                    path: /postings/questions
+                    group: Postings
                 scopes:
                     - postings:read:admin
-            stage:
+                version: 1.0.0
+            stages:
                 runs: every 6 hours
                 description: |
                     Fetches a list of all pipeline stages in Lever
                 output: LeverStage
                 sync_type: full
                 endpoint:
                     method: GET
-                    path: /lever/stage
+                    path: /stages
+                    group: Stages
                 scopes:
                     - stages:read:admin
+                version: 1.0.0
 models:
     LeverOpportunity:
         id: string

diff --git a/integrations/lever/syncs/postings-apply.ts → ...rations/lever/syncs/postings-questions.ts b/integrations/lever/syncs/postings-apply.ts → ...rations/lever/syncs/postings-questions.ts
diff --git a/integrations/lever/syncs/stage.ts → integrations/lever/syncs/stages.ts b/integrations/lever/syncs/stage.ts → integrations/lever/syncs/stages.ts
diff --git a/...r/tests/lever-basic-apply-posting.test.ts → ...s/lever/tests/lever-apply-posting.test.ts b/...r/tests/lever-basic-apply-posting.test.ts → ...s/lever/tests/lever-apply-posting.test.ts
diff --git a/...ts/lever-basic-create-opportunity.test.ts → ...er/tests/lever-create-opportunity.test.ts b/...ts/lever-basic-create-opportunity.test.ts → ...er/tests/lever-create-opportunity.test.ts
diff --git a/...s/lever-basic-get-archive-reasons.test.ts → ...r/tests/lever-get-archive-reasons.test.ts b/...s/lever-basic-get-archive-reasons.test.ts → ...r/tests/lever-get-archive-reasons.test.ts
diff --git a/...er/tests/lever-basic-get-postings.test.ts → ...ns/lever/tests/lever-get-postings.test.ts b/...er/tests/lever-basic-get-postings.test.ts → ...ns/lever/tests/lever-get-postings.test.ts
diff --git a/...ever/tests/lever-basic-get-stages.test.ts → ...ions/lever/tests/lever-get-stages.test.ts b/...ever/tests/lever-basic-get-stages.test.ts → ...ions/lever/tests/lever-get-stages.test.ts
diff --git a/...s/lever/tests/lever-basic-posting.test.ts → ...rations/lever/tests/lever-posting.test.ts b/...s/lever/tests/lever-basic-posting.test.ts → ...rations/lever/tests/lever-posting.test.ts
@@ -1,6 +1,6 @@
 import { vi, expect, it, describe } from 'vitest';
 
-import runAction from '../actions/posting.js';
+import runAction from '../actions/get-posting.js';
 
 describe('lever-basic posting tests', () => {
     const nangoMock = new global.vitest.NangoActionMock({

diff --git a/...basic-update-opportunity-archived.test.ts → ...lever-update-opportunity-archived.test.ts b/...basic-update-opportunity-archived.test.ts → ...lever-update-opportunity-archived.test.ts
diff --git a/...er-basic-update-opportunity-links.test.ts → ...ts/lever-update-opportunity-links.test.ts b/...er-basic-update-opportunity-links.test.ts → ...ts/lever-update-opportunity-links.test.ts
diff --git a/...-basic-update-opportunity-sources.test.ts → .../lever-update-opportunity-sources.test.ts b/...-basic-update-opportunity-sources.test.ts → .../lever-update-opportunity-sources.test.ts
diff --git a/...er-basic-update-opportunity-stage.test.ts → ...ts/lever-update-opportunity-stage.test.ts b/...er-basic-update-opportunity-stage.test.ts → ...ts/lever-update-opportunity-stage.test.ts
diff --git a/...ver-basic-update-opportunity-tags.test.ts → ...sts/lever-update-opportunity-tags.test.ts b/...ver-basic-update-opportunity-tags.test.ts → ...sts/lever-update-opportunity-tags.test.ts
diff --git a/...ons/lever/tests/lever-basic-users.test.ts → integrations/lever/tests/lever-users.test.ts b/...ons/lever/tests/lever-basic-users.test.ts → integrations/lever/tests/lever-users.test.ts