@mergeapi/merge-node-client 1.1.9 → 2.0.1

package/.mock/definition/hris/locations.yml

@@ -0,0 +1,218 @@
+types:
+  LocationsListRequestLocationType:
+    enum:
+      - HOME
+      - WORK
+    source:
+      openapi: openapi/openapi.yml
+  LocationsListRequestRemoteFields:
+    enum:
+      - country
+      - value: country,location_type
+        name: CountryLocationType
+      - location_type
+    source:
+      openapi: openapi/openapi.yml
+  LocationsListRequestShowEnumOrigins:
+    enum:
+      - country
+      - value: country,location_type
+        name: CountryLocationType
+      - location_type
+    source:
+      openapi: openapi/openapi.yml
+  LocationsRetrieveRequestRemoteFields:
+    enum:
+      - country
+      - value: country,location_type
+        name: CountryLocationType
+      - location_type
+    source:
+      openapi: openapi/openapi.yml
+  LocationsRetrieveRequestShowEnumOrigins:
+    enum:
+      - country
+      - value: country,location_type
+        name: CountryLocationType
+      - location_type
+    source:
+      openapi: openapi/openapi.yml
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    list:
+      path: /hris/v1/locations
+      method: GET
+      auth: true
+      docs: Returns a list of `Location` objects.
+      source:
+        openapi: openapi/openapi.yml
+      request:
+        name: LocationsListRequest
+        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).
+          location_type:
+            type: optional<LocationsListRequestLocationType>
+            docs: |-
+              If provided, will only return locations with this location_type
+
+              * `HOME` - HOME
+              * `WORK` - WORK
+          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<LocationsListRequestRemoteFields>
+            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<LocationsListRequestShowEnumOrigins>
+            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.PaginatedLocationList
+        status-code: 200
+      examples:
+        - headers: {}
+          response:
+            body:
+              next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw
+              previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ
+              results:
+                - id: f5e6a151-f44e-449a-afb1-8fd781905958
+                  remote_id: '93018402'
+                  created_at: '2021-09-15T00:00:00Z'
+                  modified_at: '2021-10-16T00:00:00Z'
+                  name: NYC Office
+                  phone_number: '+1111111111'
+                  street_1: 2920 Broadway
+                  street_2: 2nd Floor
+                  city: 'New York '
+                  state: NY
+                  zip_code: '10027'
+                  country: AF
+                  location_type: HOME
+                  remote_was_deleted: true
+                  field_mappings:
+                    organization_defined_targets:
+                      custom_key: custom_value
+                    linked_account_defined_targets:
+                      custom_key: custom_value
+                  remote_data:
+                    - path: /locations
+                      data:
+                        - Varies by platform
+    retrieve:
+      path: /hris/v1/locations/{id}
+      method: GET
+      auth: true
+      docs: Returns a `Location` object with the given `id`.
+      source:
+        openapi: openapi/openapi.yml
+      path-parameters:
+        id: string
+      request:
+        name: LocationsRetrieveRequest
+        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<LocationsRetrieveRequestRemoteFields>
+            docs: Deprecated. Use show_enum_origins.
+          show_enum_origins:
+            type: optional<LocationsRetrieveRequestShowEnumOrigins>
+            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.Location
+        status-code: 200
+      examples:
+        - path-parameters:
+            id: id
+          headers: {}
+          response:
+            body:
+              id: f5e6a151-f44e-449a-afb1-8fd781905958
+              remote_id: '93018402'
+              created_at: '2021-09-15T00:00:00Z'
+              modified_at: '2021-10-16T00:00:00Z'
+              name: NYC Office
+              phone_number: '+1111111111'
+              street_1: 2920 Broadway
+              street_2: 2nd Floor
+              city: 'New York '
+              state: NY
+              zip_code: '10027'
+              country: AF
+              location_type: HOME
+              remote_was_deleted: true
+              field_mappings:
+                organization_defined_targets:
+                  custom_key: custom_value
+                linked_account_defined_targets:
+                  custom_key: custom_value
+              remote_data:
+                - path: /locations
+                  data:
+                    - Varies by platform
+  source:
+    openapi: openapi/openapi.yml

package/.mock/definition/hris/passthrough.yml

@@ -0,0 +1,40 @@
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    create:
+      path: /hris/v1/passthrough
+      method: POST
+      auth: true
+      docs: Pull data from an endpoint not currently supported by Merge.
+      source:
+        openapi: openapi/openapi.yml
+      request:
+        body: root.DataPassthroughRequest
+        content-type: application/json
+      response:
+        docs: ''
+        type: root.RemoteResponse
+        status-code: 200
+      examples:
+        - headers: {}
+          request:
+            method: GET
+            path: /scooters
+          response:
+            body:
+              method: GET
+              path: /scooters
+              status: 200
+              response:
+                key: value
+              response_headers:
+                X-Page-Token: value
+              response_type: JSON
+              headers:
+                EXTRA-HEADER: value
+                Authorization: <redacted>
+  source:
+    openapi: openapi/openapi.yml

package/.mock/definition/hris/payGroups.yml

@@ -0,0 +1,136 @@
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    list:
+      path: /hris/v1/pay-groups
+      method: GET
+      auth: true
+      docs: Returns a list of `PayGroup` objects.
+      source:
+        openapi: openapi/openapi.yml
+      request:
+        name: PayGroupsListRequest
+        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.PaginatedPayGroupList
+        status-code: 200
+      examples:
+        - headers: {}
+          response:
+            body:
+              next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw
+              previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ
+              results:
+                - id: fd1e0fb5-8f92-4ec9-9f32-179cf732867d
+                  remote_id: '800293'
+                  created_at: '2021-09-15T00:00:00Z'
+                  modified_at: '2021-10-16T00:00:00Z'
+                  pay_group_name: contractor
+                  remote_was_deleted: true
+                  field_mappings:
+                    organization_defined_targets:
+                      custom_key: custom_value
+                    linked_account_defined_targets:
+                      custom_key: custom_value
+                  remote_data:
+                    - path: /pay-group
+                      data:
+                        - Varies by platform
+    retrieve:
+      path: /hris/v1/pay-groups/{id}
+      method: GET
+      auth: true
+      docs: Returns a `PayGroup` object with the given `id`.
+      source:
+        openapi: openapi/openapi.yml
+      path-parameters:
+        id: string
+      request:
+        name: PayGroupsRetrieveRequest
+        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).
+      response:
+        docs: ''
+        type: root.PayGroup
+        status-code: 200
+      examples:
+        - path-parameters:
+            id: id
+          headers: {}
+          response:
+            body:
+              id: fd1e0fb5-8f92-4ec9-9f32-179cf732867d
+              remote_id: '800293'
+              created_at: '2021-09-15T00:00:00Z'
+              modified_at: '2021-10-16T00:00:00Z'
+              pay_group_name: contractor
+              remote_was_deleted: true
+              field_mappings:
+                organization_defined_targets:
+                  custom_key: custom_value
+                linked_account_defined_targets:
+                  custom_key: custom_value
+              remote_data:
+                - path: /pay-group
+                  data:
+                    - Varies by platform
+  source:
+    openapi: openapi/openapi.yml

package/.mock/definition/hris/payrollRuns.yml

@@ -0,0 +1,243 @@
+types:
+  PayrollRunsListRequestRemoteFields:
+    enum:
+      - run_state
+      - value: run_state,run_type
+        name: RunStateRunType
+      - run_type
+    source:
+      openapi: openapi/openapi.yml
+  PayrollRunsListRequestRunType:
+    enum:
+      - CORRECTION
+      - OFF_CYCLE
+      - REGULAR
+      - SIGN_ON_BONUS
+      - TERMINATION
+    source:
+      openapi: openapi/openapi.yml
+  PayrollRunsListRequestShowEnumOrigins:
+    enum:
+      - run_state
+      - value: run_state,run_type
+        name: RunStateRunType
+      - run_type
+    source:
+      openapi: openapi/openapi.yml
+  PayrollRunsRetrieveRequestRemoteFields:
+    enum:
+      - run_state
+      - value: run_state,run_type
+        name: RunStateRunType
+      - run_type
+    source:
+      openapi: openapi/openapi.yml
+  PayrollRunsRetrieveRequestShowEnumOrigins:
+    enum:
+      - run_state
+      - value: run_state,run_type
+        name: RunStateRunType
+      - run_type
+    source:
+      openapi: openapi/openapi.yml
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    list:
+      path: /hris/v1/payroll-runs
+      method: GET
+      auth: true
+      docs: Returns a list of `PayrollRun` objects.
+      source:
+        openapi: openapi/openapi.yml
+      request:
+        name: PayrollRunsListRequest
+        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.
+          ended_after:
+            type: optional<datetime>
+            docs: >-
+              If provided, will only return payroll runs ended after this
+              datetime.
+          ended_before:
+            type: optional<datetime>
+            docs: >-
+              If provided, will only return payroll runs ended before this
+              datetime.
+          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<PayrollRunsListRequestRemoteFields>
+            docs: Deprecated. Use show_enum_origins.
+          remote_id:
+            type: optional<string>
+            docs: The API provider's ID for the given object.
+          run_type:
+            type: optional<PayrollRunsListRequestRunType>
+            docs: >-
+              If provided, will only return PayrollRun's with this status.
+              Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION',
+              'SIGN_ON_BONUS')
+
+
+              * `REGULAR` - REGULAR
+
+              * `OFF_CYCLE` - OFF_CYCLE
+
+              * `CORRECTION` - CORRECTION
+
+              * `TERMINATION` - TERMINATION
+
+              * `SIGN_ON_BONUS` - SIGN_ON_BONUS
+          show_enum_origins:
+            type: optional<PayrollRunsListRequestShowEnumOrigins>
+            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)
+          started_after:
+            type: optional<datetime>
+            docs: >-
+              If provided, will only return payroll runs started after this
+              datetime.
+          started_before:
+            type: optional<datetime>
+            docs: >-
+              If provided, will only return payroll runs started before this
+              datetime.
+      response:
+        docs: ''
+        type: root.PaginatedPayrollRunList
+        status-code: 200
+      examples:
+        - headers: {}
+          response:
+            body:
+              next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw
+              previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ
+              results:
+                - id: 37336947-b3d4-4a4c-a310-ab6ab510e079
+                  remote_id: '19202938'
+                  created_at: '2021-09-15T00:00:00Z'
+                  modified_at: '2021-10-16T00:00:00Z'
+                  run_state: PAID
+                  run_type: REGULAR
+                  start_date: '2020-11-08T00:00:00Z'
+                  end_date: '2020-11-15T00:00:00Z'
+                  check_date: '2020-11-15T00:00:00Z'
+                  remote_was_deleted: true
+                  field_mappings:
+                    organization_defined_targets:
+                      custom_key: custom_value
+                    linked_account_defined_targets:
+                      custom_key: custom_value
+                  remote_data:
+                    - path: /payroll
+                      data:
+                        - Varies by platform
+    retrieve:
+      path: /hris/v1/payroll-runs/{id}
+      method: GET
+      auth: true
+      docs: Returns a `PayrollRun` object with the given `id`.
+      source:
+        openapi: openapi/openapi.yml
+      path-parameters:
+        id: string
+      request:
+        name: PayrollRunsRetrieveRequest
+        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<PayrollRunsRetrieveRequestRemoteFields>
+            docs: Deprecated. Use show_enum_origins.
+          show_enum_origins:
+            type: optional<PayrollRunsRetrieveRequestShowEnumOrigins>
+            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.PayrollRun
+        status-code: 200
+      examples:
+        - path-parameters:
+            id: id
+          headers: {}
+          response:
+            body:
+              id: 37336947-b3d4-4a4c-a310-ab6ab510e079
+              remote_id: '19202938'
+              created_at: '2021-09-15T00:00:00Z'
+              modified_at: '2021-10-16T00:00:00Z'
+              run_state: PAID
+              run_type: REGULAR
+              start_date: '2020-11-08T00:00:00Z'
+              end_date: '2020-11-15T00:00:00Z'
+              check_date: '2020-11-15T00:00:00Z'
+              remote_was_deleted: true
+              field_mappings:
+                organization_defined_targets:
+                  custom_key: custom_value
+                linked_account_defined_targets:
+                  custom_key: custom_value
+              remote_data:
+                - path: /payroll
+                  data:
+                    - Varies by platform
+  source:
+    openapi: openapi/openapi.yml

package/.mock/definition/hris/regenerateKey.yml

@@ -0,0 +1,36 @@
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    create:
+      path: /hris/v1/regenerate-key
+      method: POST
+      auth: true
+      docs: Exchange remote keys.
+      source:
+        openapi: openapi/openapi.yml
+      request:
+        name: RemoteKeyForRegenerationRequest
+        body:
+          properties:
+            name:
+              type: string
+              docs: The name of the remote key
+              validation:
+                minLength: 1
+        content-type: application/json
+      response:
+        docs: ''
+        type: root.RemoteKey
+        status-code: 200
+      examples:
+        - request:
+            name: Remote Deployment Key 1
+          response:
+            body:
+              name: Remote Deployment Key 1
+              key: hXY57W0g0WkdRHjCaPvwijK63fwfN-o_Wh7f30SLTq_uPCOLo-WFcA
+  source:
+    openapi: openapi/openapi.yml