@mergeapi/merge-node-client 1.1.8 → 2.0.0

package/.mock/definition/ats/scopes.yml

@@ -0,0 +1,160 @@
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    default_scopes_retrieve:
+      path: /ats/v1/default-scopes
+      method: GET
+      auth: true
+      docs: >-
+        Get the default permissions for Merge Common Models and fields across
+        all Linked Accounts of a given category. [Learn
+        more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
+      source:
+        openapi: openapi/openapi.yml
+      response:
+        docs: ''
+        type: root.CommonModelScopeApi
+        status-code: 200
+      examples:
+        - response:
+            body:
+              common_models:
+                - model_name: Employee
+                  model_permissions:
+                    READ:
+                      is_enabled: true
+                    WRITE:
+                      is_enabled: false
+                  field_permissions:
+                    enabled_fields:
+                      - avatar
+                      - created_at
+                      - custom_fields
+                      - date_of_birth
+                      - first_name
+                      - gender
+                      - remote_created_at
+                      - remote_data
+                    disabled_fields:
+                      - company
+                      - employments
+                      - groups
+                      - home_location
+                      - manager
+                      - work_location
+    linked_account_scopes_retrieve:
+      path: /ats/v1/linked-account-scopes
+      method: GET
+      auth: true
+      docs: >-
+        Get all available permissions for Merge Common Models and fields for a
+        single Linked Account. [Learn
+        more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
+      source:
+        openapi: openapi/openapi.yml
+      response:
+        docs: ''
+        type: root.CommonModelScopeApi
+        status-code: 200
+      examples:
+        - headers: {}
+          response:
+            body:
+              common_models:
+                - model_name: Employee
+                  model_permissions:
+                    READ:
+                      is_enabled: true
+                    WRITE:
+                      is_enabled: false
+                  field_permissions:
+                    enabled_fields:
+                      - avatar
+                      - created_at
+                      - custom_fields
+                      - date_of_birth
+                      - first_name
+                      - gender
+                      - remote_created_at
+                      - remote_data
+                    disabled_fields:
+                      - company
+                      - employments
+                      - groups
+                      - home_location
+                      - manager
+                      - work_location
+    linked_account_scopes_create:
+      path: /ats/v1/linked-account-scopes
+      method: POST
+      auth: true
+      docs: >-
+        Update permissions for any Common Model or field for a single Linked
+        Account. Any Scopes not set in this POST request will inherit the
+        default Scopes. [Learn
+        more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
+      source:
+        openapi: openapi/openapi.yml
+      request:
+        name: LinkedAccountCommonModelScopeDeserializerRequest
+        body:
+          properties:
+            common_models:
+              docs: The common models you want to update the scopes for
+              type: list<root.IndividualCommonModelScopeDeserializerRequest>
+        content-type: application/json
+      response:
+        docs: ''
+        type: root.CommonModelScopeApi
+        status-code: 200
+      examples:
+        - headers: {}
+          request:
+            common_models:
+              - model_name: Employee
+                model_permissions:
+                  READ:
+                    is_enabled: true
+                  WRITE:
+                    is_enabled: false
+                field_permissions:
+                  enabled_fields:
+                    - avatar
+                    - home_location
+                  disabled_fields:
+                    - work_location
+              - model_name: Benefit
+                model_permissions:
+                  WRITE:
+                    is_enabled: false
+          response:
+            body:
+              common_models:
+                - model_name: Employee
+                  model_permissions:
+                    READ:
+                      is_enabled: true
+                    WRITE:
+                      is_enabled: false
+                  field_permissions:
+                    enabled_fields:
+                      - avatar
+                      - created_at
+                      - custom_fields
+                      - date_of_birth
+                      - first_name
+                      - gender
+                      - remote_created_at
+                      - remote_data
+                    disabled_fields:
+                      - company
+                      - employments
+                      - groups
+                      - home_location
+                      - manager
+                      - work_location
+  source:
+    openapi: openapi/openapi.yml

package/.mock/definition/ats/scorecards.yml

@@ -0,0 +1,216 @@
+types:
+  ScorecardsListRequestExpand:
+    enum:
+      - application
+      - value: application,interview
+        name: ApplicationInterview
+      - value: application,interview,interviewer
+        name: ApplicationInterviewInterviewer
+      - value: application,interviewer
+        name: ApplicationInterviewer
+      - interview
+      - value: interview,interviewer
+        name: InterviewInterviewer
+      - interviewer
+    source:
+      openapi: openapi/openapi.yml
+  ScorecardsRetrieveRequestExpand:
+    enum:
+      - application
+      - value: application,interview
+        name: ApplicationInterview
+      - value: application,interview,interviewer
+        name: ApplicationInterviewInterviewer
+      - value: application,interviewer
+        name: ApplicationInterviewer
+      - interview
+      - value: interview,interviewer
+        name: InterviewInterviewer
+      - interviewer
+    source:
+      openapi: openapi/openapi.yml
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    list:
+      path: /ats/v1/scorecards
+      method: GET
+      auth: true
+      docs: Returns a list of `Scorecard` objects.
+      source:
+        openapi: openapi/openapi.yml
+      request:
+        name: ScorecardsListRequest
+        query-parameters:
+          application_id:
+            type: optional<string>
+            docs: If provided, will only return scorecards for this application.
+          created_after:
+            type: optional<datetime>
+            docs: If provided, will only return objects created after this datetime.
+          created_before:
+            type: optional<datetime>
+            docs: >-
+              If provided, will only return objects created before this
+              datetime.
+          cursor:
+            type: optional<string>
+            docs: The pagination cursor value.
+          expand:
+            type: optional<ScorecardsListRequestExpand>
+            docs: >-
+              Which relations should be returned in expanded form. Multiple
+              relation names should be comma separated without spaces.
+          include_deleted_data:
+            type: optional<boolean>
+            docs: >-
+              Indicates whether or not this object has been deleted in the third
+              party platform. Full coverage deletion detection is a premium
+              add-on. Native deletion detection is offered for free with limited
+              coverage. [Learn
+              more](https://docs.merge.dev/integrations/hris/supported-features/).
+          include_remote_data:
+            type: optional<boolean>
+            docs: >-
+              Whether to include the original data Merge fetched from the
+              third-party to produce these models.
+          include_shell_data:
+            type: optional<boolean>
+            docs: >-
+              Whether to include shell records. Shell records are empty records
+              (they may contain some metadata but all other fields are null).
+          interview_id:
+            type: optional<string>
+            docs: If provided, will only return scorecards for this interview.
+          interviewer_id:
+            type: optional<string>
+            docs: If provided, will only return scorecards for this interviewer.
+          modified_after:
+            type: optional<datetime>
+            docs: >-
+              If provided, only objects synced by Merge after this date time
+              will be returned.
+          modified_before:
+            type: optional<datetime>
+            docs: >-
+              If provided, only objects synced by Merge before this date time
+              will be returned.
+          page_size:
+            type: optional<integer>
+            docs: Number of results to return per page.
+          remote_fields:
+            type: optional<literal<"overall_recommendation">>
+            docs: Deprecated. Use show_enum_origins.
+          remote_id:
+            type: optional<string>
+            docs: The API provider's ID for the given object.
+          show_enum_origins:
+            type: optional<literal<"overall_recommendation">>
+            docs: >-
+              A comma separated list of enum field names for which you'd like
+              the original values to be returned, instead of Merge's normalized
+              enum values. [Learn
+              more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+      response:
+        docs: ''
+        type: root.PaginatedScorecardList
+        status-code: 200
+      examples:
+        - headers: {}
+          response:
+            body:
+              next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw
+              previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ
+              results:
+                - id: 3eab2f17-eeb1-450d-97f0-029d8be1e06f
+                  remote_id: '22234'
+                  created_at: '2021-09-15T00:00:00Z'
+                  modified_at: '2021-10-16T00:00:00Z'
+                  application: application
+                  interview: interview
+                  interviewer: interviewer
+                  remote_created_at: '2021-10-15T00:00:00Z'
+                  submitted_at: '2021-10-15T00:00:00Z'
+                  overall_recommendation: DEFINITELY_NO
+                  remote_was_deleted: true
+                  field_mappings:
+                    organization_defined_targets:
+                      custom_key: custom_value
+                    linked_account_defined_targets:
+                      custom_key: custom_value
+                  remote_data:
+                    - path: /ratings
+                      data:
+                        - Varies by platform
+    retrieve:
+      path: /ats/v1/scorecards/{id}
+      method: GET
+      auth: true
+      docs: Returns a `Scorecard` object with the given `id`.
+      source:
+        openapi: openapi/openapi.yml
+      path-parameters:
+        id: string
+      request:
+        name: ScorecardsRetrieveRequest
+        query-parameters:
+          expand:
+            type: optional<ScorecardsRetrieveRequestExpand>
+            docs: >-
+              Which relations should be returned in expanded form. Multiple
+              relation names should be comma separated without spaces.
+          include_remote_data:
+            type: optional<boolean>
+            docs: >-
+              Whether to include the original data Merge fetched from the
+              third-party to produce these models.
+          include_shell_data:
+            type: optional<boolean>
+            docs: >-
+              Whether to include shell records. Shell records are empty records
+              (they may contain some metadata but all other fields are null).
+          remote_fields:
+            type: optional<literal<"overall_recommendation">>
+            docs: Deprecated. Use show_enum_origins.
+          show_enum_origins:
+            type: optional<literal<"overall_recommendation">>
+            docs: >-
+              A comma separated list of enum field names for which you'd like
+              the original values to be returned, instead of Merge's normalized
+              enum values. [Learn
+              more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+      response:
+        docs: ''
+        type: root.Scorecard
+        status-code: 200
+      examples:
+        - path-parameters:
+            id: id
+          headers: {}
+          response:
+            body:
+              id: 3eab2f17-eeb1-450d-97f0-029d8be1e06f
+              remote_id: '22234'
+              created_at: '2021-09-15T00:00:00Z'
+              modified_at: '2021-10-16T00:00:00Z'
+              application: application
+              interview: interview
+              interviewer: interviewer
+              remote_created_at: '2021-10-15T00:00:00Z'
+              submitted_at: '2021-10-15T00:00:00Z'
+              overall_recommendation: DEFINITELY_NO
+              remote_was_deleted: true
+              field_mappings:
+                organization_defined_targets:
+                  custom_key: custom_value
+                linked_account_defined_targets:
+                  custom_key: custom_value
+              remote_data:
+                - path: /ratings
+                  data:
+                    - Varies by platform
+  source:
+    openapi: openapi/openapi.yml

package/.mock/definition/ats/syncStatus.yml

@@ -0,0 +1,55 @@
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    list:
+      path: /ats/v1/sync-status
+      method: GET
+      auth: true
+      docs: >-
+        Get sync status for the current sync and the most recently finished
+        sync. `last_sync_start` represents the most recent time any sync began.
+        `last_sync_finished` represents the most recent time any sync completed.
+        These timestamps may correspond to different sync instances which may
+        result in a sync start time being later than a separate sync completed
+        time. To ensure you are retrieving the latest available data reference
+        the `last_sync_finished` timestamp where `last_sync_result` is `DONE`.
+        Possible values for `status` and `last_sync_result` are `DISABLED`,
+        `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more
+        about sync status in our [Help
+        Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
+      source:
+        openapi: openapi/openapi.yml
+      request:
+        name: SyncStatusListRequest
+        query-parameters:
+          cursor:
+            type: optional<string>
+            docs: The pagination cursor value.
+          page_size:
+            type: optional<integer>
+            docs: Number of results to return per page.
+      response:
+        docs: ''
+        type: root.PaginatedSyncStatusList
+        status-code: 200
+      examples:
+        - headers: {}
+          response:
+            body:
+              next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw
+              previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ
+              results:
+                - model_name: Candidate
+                  model_id: ats.Candidate
+                  last_sync_start: '2021-03-30T19:44:18Z'
+                  next_sync_start: '2021-03-30T20:44:18Z'
+                  last_sync_result: SYNCING
+                  last_sync_finished: '2021-03-30T19:55:18Z'
+                  status: SYNCING
+                  is_initial_sync: true
+                  selective_sync_configurations_usage: IN_NEXT_SYNC
+  source:
+    openapi: openapi/openapi.yml

package/.mock/definition/ats/tags.yml

@@ -0,0 +1,88 @@
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    list:
+      path: /ats/v1/tags
+      method: GET
+      auth: true
+      docs: Returns a list of `Tag` objects.
+      source:
+        openapi: openapi/openapi.yml
+      request:
+        name: TagsListRequest
+        query-parameters:
+          created_after:
+            type: optional<datetime>
+            docs: If provided, will only return objects created after this datetime.
+          created_before:
+            type: optional<datetime>
+            docs: >-
+              If provided, will only return objects created before this
+              datetime.
+          cursor:
+            type: optional<string>
+            docs: The pagination cursor value.
+          include_deleted_data:
+            type: optional<boolean>
+            docs: >-
+              Indicates whether or not this object has been deleted in the third
+              party platform. Full coverage deletion detection is a premium
+              add-on. Native deletion detection is offered for free with limited
+              coverage. [Learn
+              more](https://docs.merge.dev/integrations/hris/supported-features/).
+          include_remote_data:
+            type: optional<boolean>
+            docs: >-
+              Whether to include the original data Merge fetched from the
+              third-party to produce these models.
+          include_shell_data:
+            type: optional<boolean>
+            docs: >-
+              Whether to include shell records. Shell records are empty records
+              (they may contain some metadata but all other fields are null).
+          modified_after:
+            type: optional<datetime>
+            docs: >-
+              If provided, only objects synced by Merge after this date time
+              will be returned.
+          modified_before:
+            type: optional<datetime>
+            docs: >-
+              If provided, only objects synced by Merge before this date time
+              will be returned.
+          page_size:
+            type: optional<integer>
+            docs: Number of results to return per page.
+          remote_id:
+            type: optional<string>
+            docs: The API provider's ID for the given object.
+      response:
+        docs: ''
+        type: root.PaginatedTagList
+        status-code: 200
+      examples:
+        - headers: {}
+          response:
+            body:
+              next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw
+              previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ
+              results:
+                - remote_id: '4567'
+                  created_at: '2021-09-15T00:00:00Z'
+                  modified_at: '2021-10-16T00:00:00Z'
+                  name: High-Priority
+                  remote_was_deleted: true
+                  field_mappings:
+                    organization_defined_targets:
+                      custom_key: custom_value
+                    linked_account_defined_targets:
+                      custom_key: custom_value
+                  remote_data:
+                    - path: /tags
+                      data:
+                        - Varies by platform
+  source:
+    openapi: openapi/openapi.yml

package/.mock/definition/ats/users.yml

@@ -0,0 +1,173 @@
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    list:
+      path: /ats/v1/users
+      method: GET
+      auth: true
+      docs: Returns a list of `RemoteUser` objects.
+      source:
+        openapi: openapi/openapi.yml
+      request:
+        name: UsersListRequest
+        query-parameters:
+          created_after:
+            type: optional<datetime>
+            docs: If provided, will only return objects created after this datetime.
+          created_before:
+            type: optional<datetime>
+            docs: >-
+              If provided, will only return objects created before this
+              datetime.
+          cursor:
+            type: optional<string>
+            docs: The pagination cursor value.
+          email:
+            type: optional<string>
+            docs: >-
+              If provided, will only return remote users with the given email
+              address
+            validation:
+              format: email
+          include_deleted_data:
+            type: optional<boolean>
+            docs: >-
+              Indicates whether or not this object has been deleted in the third
+              party platform. Full coverage deletion detection is a premium
+              add-on. Native deletion detection is offered for free with limited
+              coverage. [Learn
+              more](https://docs.merge.dev/integrations/hris/supported-features/).
+          include_remote_data:
+            type: optional<boolean>
+            docs: >-
+              Whether to include the original data Merge fetched from the
+              third-party to produce these models.
+          include_shell_data:
+            type: optional<boolean>
+            docs: >-
+              Whether to include shell records. Shell records are empty records
+              (they may contain some metadata but all other fields are null).
+          modified_after:
+            type: optional<datetime>
+            docs: >-
+              If provided, only objects synced by Merge after this date time
+              will be returned.
+          modified_before:
+            type: optional<datetime>
+            docs: >-
+              If provided, only objects synced by Merge before this date time
+              will be returned.
+          page_size:
+            type: optional<integer>
+            docs: Number of results to return per page.
+          remote_fields:
+            type: optional<literal<"access_role">>
+            docs: Deprecated. Use show_enum_origins.
+          remote_id:
+            type: optional<string>
+            docs: The API provider's ID for the given object.
+          show_enum_origins:
+            type: optional<literal<"access_role">>
+            docs: >-
+              A comma separated list of enum field names for which you'd like
+              the original values to be returned, instead of Merge's normalized
+              enum values. [Learn
+              more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+      response:
+        docs: ''
+        type: root.PaginatedRemoteUserList
+        status-code: 200
+      examples:
+        - headers: {}
+          response:
+            body:
+              next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw
+              previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ
+              results:
+                - id: b82302de-852e-4e60-b050-edf9da3b7c02
+                  remote_id: '344321'
+                  created_at: '2021-09-15T00:00:00Z'
+                  modified_at: '2021-10-16T00:00:00Z'
+                  first_name: Shensi
+                  last_name: Ding
+                  email: hello@merge.dev
+                  disabled: true
+                  remote_created_at: '2020-11-10T00:00:00Z'
+                  access_role: SUPER_ADMIN
+                  remote_was_deleted: true
+                  field_mappings:
+                    organization_defined_targets:
+                      custom_key: custom_value
+                    linked_account_defined_targets:
+                      custom_key: custom_value
+                  remote_data:
+                    - path: /users
+                      data:
+                        - Varies by platform
+    retrieve:
+      path: /ats/v1/users/{id}
+      method: GET
+      auth: true
+      docs: Returns a `RemoteUser` object with the given `id`.
+      source:
+        openapi: openapi/openapi.yml
+      path-parameters:
+        id: string
+      request:
+        name: UsersRetrieveRequest
+        query-parameters:
+          include_remote_data:
+            type: optional<boolean>
+            docs: >-
+              Whether to include the original data Merge fetched from the
+              third-party to produce these models.
+          include_shell_data:
+            type: optional<boolean>
+            docs: >-
+              Whether to include shell records. Shell records are empty records
+              (they may contain some metadata but all other fields are null).
+          remote_fields:
+            type: optional<literal<"access_role">>
+            docs: Deprecated. Use show_enum_origins.
+          show_enum_origins:
+            type: optional<literal<"access_role">>
+            docs: >-
+              A comma separated list of enum field names for which you'd like
+              the original values to be returned, instead of Merge's normalized
+              enum values. [Learn
+              more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+      response:
+        docs: ''
+        type: root.RemoteUser
+        status-code: 200
+      examples:
+        - path-parameters:
+            id: id
+          headers: {}
+          response:
+            body:
+              id: b82302de-852e-4e60-b050-edf9da3b7c02
+              remote_id: '344321'
+              created_at: '2021-09-15T00:00:00Z'
+              modified_at: '2021-10-16T00:00:00Z'
+              first_name: Shensi
+              last_name: Ding
+              email: hello@merge.dev
+              disabled: true
+              remote_created_at: '2020-11-10T00:00:00Z'
+              access_role: SUPER_ADMIN
+              remote_was_deleted: true
+              field_mappings:
+                organization_defined_targets:
+                  custom_key: custom_value
+                linked_account_defined_targets:
+                  custom_key: custom_value
+              remote_data:
+                - path: /users
+                  data:
+                    - Varies by platform
+  source:
+    openapi: openapi/openapi.yml