diff --git a/.mock/definition/accounting/__package__.yml b/.mock/definition/accounting/__package__.yml index 93434370..cd7f2ced 100644 --- a/.mock/definition/accounting/__package__.yml +++ b/.mock/definition/accounting/__package__.yml @@ -3663,6 +3663,7 @@ types: docs: The address's city. state: type: optional + docs: The address's state or region. access: read-only country_subdivision: type: optional @@ -51606,6 +51607,9 @@ types: docs: The third-party API path that is being called. data: type: optional + docs: >- + The data returned from the third-party for this object in its + original, unnormalized format. access: read-only source: openapi: openapi/openapi.yml diff --git a/.mock/definition/accounting/addresses.yml b/.mock/definition/accounting/addresses.yml index 5317c7fe..5f5ce481 100644 --- a/.mock/definition/accounting/addresses.yml +++ b/.mock/definition/accounting/addresses.yml @@ -59,8 +59,7 @@ service: street_1: 2920 Broadway street_2: 2nd Floor city: New York - state: - key: value + state: NY country_subdivision: NY country: AF zip_code: '10027' diff --git a/.mock/definition/accounting/asyncPassthrough.yml b/.mock/definition/accounting/asyncPassthrough.yml index 5898b8f9..35276342 100644 --- a/.mock/definition/accounting/asyncPassthrough.yml +++ b/.mock/definition/accounting/asyncPassthrough.yml @@ -55,7 +55,11 @@ service: path: /scooters status: 200 response: - key: value + scooters: + - company: Lime + model: Gen 2.5 + - company: Bird + model: Bird Zero response_headers: X-Page-Token: value response_type: JSON diff --git a/.mock/definition/accounting/balanceSheets.yml b/.mock/definition/accounting/balanceSheets.yml index 03e23bd0..9e451c2f 100644 --- a/.mock/definition/accounting/balanceSheets.yml +++ b/.mock/definition/accounting/balanceSheets.yml @@ -115,6 +115,7 @@ service: - remote_id: '10301' name: Revenue - New York value: 500 + company: 595c8f97-2ac4-45b7-b000-41bdf43240b5 liabilities: - remote_id: '10011' created_at: '2021-09-15T00:00:00Z' @@ -128,6 +129,7 @@ service: - remote_id: '10301' name: Revenue - New York value: 500 + company: 595c8f97-2ac4-45b7-b000-41bdf43240b5 equity: - remote_id: '10012' created_at: '2021-09-15T00:00:00Z' @@ -141,6 +143,7 @@ service: - remote_id: '10301' name: Revenue - New York value: 500 + company: 595c8f97-2ac4-45b7-b000-41bdf43240b5 remote_generated_at: '2021-10-01T00:00:00Z' remote_was_deleted: true field_mappings: @@ -150,6 +153,8 @@ service: custom_key: custom_value remote_data: - path: /platform-endpoint + data: + - Varies by platform retrieve: path: /accounting/v1/balance-sheets/{id} method: GET @@ -257,6 +262,6 @@ service: remote_data: - path: /platform-endpoint data: - key: value + - Varies by platform source: openapi: openapi/openapi.yml diff --git a/.mock/definition/accounting/cashFlowStatements.yml b/.mock/definition/accounting/cashFlowStatements.yml index ddd3ef42..361a21b9 100644 --- a/.mock/definition/accounting/cashFlowStatements.yml +++ b/.mock/definition/accounting/cashFlowStatements.yml @@ -118,6 +118,7 @@ service: modified_at: '2021-09-18T00:00:00Z' name: Net Income value: 1097.13 + company: 595c8f97-2ac4-45b7-b000-41bdf43240b5 investing_activities: - remote_id: '192406939' created_at: '2021-11-15T00:00:00Z' @@ -129,10 +130,13 @@ service: modified_at: '2021-09-18T00:00:00Z' name: Equipment value: 1000 + company: 595c8f97-2ac4-45b7-b000-41bdf43240b5 financing_activities: - remote_id: '192406939' created_at: '2021-11-15T00:00:00Z' modified_at: '2021-11-15T00:00:00Z' + name: Revenue + value: 1000 sub_items: - remote_id: '10300' name: Revenue - San Francisco @@ -140,6 +144,7 @@ service: - remote_id: '10301' name: Revenue - New York value: 500 + company: 595c8f97-2ac4-45b7-b000-41bdf43240b5 remote_generated_at: '2020-04-01T00:00:00Z' remote_was_deleted: true field_mappings: diff --git a/.mock/definition/accounting/companyInfo.yml b/.mock/definition/accounting/companyInfo.yml index 5d2f4331..a61972c8 100644 --- a/.mock/definition/accounting/companyInfo.yml +++ b/.mock/definition/accounting/companyInfo.yml @@ -126,11 +126,14 @@ service: street_2: 2nd Floor city: New York state: NY + country_subdivision: NY country: US zip_code: '10027' phone_numbers: - created_at: '2021-09-15T00:00:00Z' modified_at: '2021-10-16T00:00:00Z' + number: '+3198675309' + type: Mobile remote_was_deleted: true field_mappings: organization_defined_targets: diff --git a/.mock/definition/accounting/contacts.yml b/.mock/definition/accounting/contacts.yml index da1b9fa1..81a256ee 100644 --- a/.mock/definition/accounting/contacts.yml +++ b/.mock/definition/accounting/contacts.yml @@ -207,6 +207,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string create: path: /accounting/v1/contacts method: POST @@ -278,6 +279,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string warnings: - source: pointer: pointer @@ -392,8 +394,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class - value: - key: value + value: string partialUpdate: path: /accounting/v1/contacts/{id} method: PATCH @@ -469,6 +470,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string warnings: - source: pointer: pointer diff --git a/.mock/definition/accounting/creditNotes.yml b/.mock/definition/accounting/creditNotes.yml index e4c5b38c..361be1b5 100644 --- a/.mock/definition/accounting/creditNotes.yml +++ b/.mock/definition/accounting/creditNotes.yml @@ -732,7 +732,8 @@ service: - a9a94a75-19c1-41fe-90d8-d9ba959c38e5 accounting_period: accounting_period applied_to_lines: - - created_at: '2021-09-15T00:00:00Z' + - remote_id: '088899' + created_at: '2021-09-15T00:00:00Z' modified_at: '2021-10-16T00:00:00Z' invoice: 5b3c1341-a20f-4e51-b72c-f3830a16c97b applied_date: '2020-03-31T00:00:00Z' @@ -833,7 +834,8 @@ service: - a9a94a75-19c1-41fe-90d8-d9ba959c38e5 accounting_period: accounting_period applied_to_lines: - - created_at: '2021-09-15T00:00:00Z' + - remote_id: '088899' + created_at: '2021-09-15T00:00:00Z' modified_at: '2021-10-16T00:00:00Z' invoice: 5b3c1341-a20f-4e51-b72c-f3830a16c97b applied_date: '2020-03-31T00:00:00Z' diff --git a/.mock/definition/accounting/expenseReports.yml b/.mock/definition/accounting/expenseReports.yml index b21b57f0..2f613f2d 100644 --- a/.mock/definition/accounting/expenseReports.yml +++ b/.mock/definition/accounting/expenseReports.yml @@ -338,6 +338,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string create: path: /accounting/v1/expense-reports method: POST @@ -433,6 +434,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string warnings: - source: pointer: pointer @@ -551,6 +553,7 @@ service: remote_was_deleted: true remote_fields: - remote_field_class: remote_field_class + value: string retrieve: path: /accounting/v1/expense-reports/{id} method: GET @@ -637,6 +640,7 @@ service: remote_was_deleted: false remote_fields: - remote_field_class: remote_field_class + value: string currency: XUA description: January 2024 Travel Expenses accounting_period: 7d793c67-9f72-4a6b-9256-3936f237b0d9 @@ -656,8 +660,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class - value: - key: value + value: string linesRemoteFieldClassesList: path: /accounting/v1/expense-reports/lines/remote-field-classes method: GET diff --git a/.mock/definition/accounting/expenses.yml b/.mock/definition/accounting/expenses.yml index 4b3cf6f3..e3ba188f 100644 --- a/.mock/definition/accounting/expenses.yml +++ b/.mock/definition/accounting/expenses.yml @@ -405,8 +405,11 @@ service: - b38c59b0-a9d7-4740-b1ee-5436c6751e3d - 9b840d2-686a-465a-8a8e-7b028498f8e4 - a47e11b6-c73b-4a0c-be31-130fc48177fa + company: 595c8f97-2ac4-45b7-b000-41bdf43240b5 account: 2a56344a-a491-11ec-b909-0242ac120002 description: Desk Lamp + exchange_rate: '2.9' + tax_rate: a12e7c20-1922-9df7-s75n-edfeewnn7384 tracking_categories: - b38c59b0-a9d7-4740-b1ee-5436c6751e3d - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -424,6 +427,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string create: path: /accounting/v1/expenses method: POST @@ -509,8 +513,11 @@ service: - b38c59b0-a9d7-4740-b1ee-5436c6751e3d - 9b840d2-686a-465a-8a8e-7b028498f8e4 - a47e11b6-c73b-4a0c-be31-130fc48177fa + company: 595c8f97-2ac4-45b7-b000-41bdf43240b5 account: 2a56344a-a491-11ec-b909-0242ac120002 description: Desk Lamp + exchange_rate: '2.9' + tax_rate: a12e7c20-1922-9df7-s75n-edfeewnn7384 tracking_categories: - b38c59b0-a9d7-4740-b1ee-5436c6751e3d - 9b840d2-686a-465a-8a8e-7b028498f8e4 @@ -528,6 +535,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string warnings: - source: pointer: pointer @@ -672,8 +680,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class - value: - key: value + value: string linesRemoteFieldClassesList: path: /accounting/v1/expenses/lines/remote-field-classes method: GET diff --git a/.mock/definition/accounting/generalLedgerTransactions.yml b/.mock/definition/accounting/generalLedgerTransactions.yml index e771a4b9..b8d96bc8 100644 --- a/.mock/definition/accounting/generalLedgerTransactions.yml +++ b/.mock/definition/accounting/generalLedgerTransactions.yml @@ -203,6 +203,11 @@ service: foreign_debit_amount: foreign_debit_amount foreign_credit_amount: foreign_credit_amount remote_was_deleted: false + field_mappings: + organization_defined_targets: + custom_key: custom_value + linked_account_defined_targets: + custom_key: custom_value remote_was_deleted: true field_mappings: organization_defined_targets: @@ -211,6 +216,8 @@ service: custom_key: custom_value remote_data: - path: /platform-endpoint + data: + - Varies by platform retrieve: path: /accounting/v1/general-ledger-transactions/{id} method: GET @@ -307,6 +314,6 @@ service: remote_data: - path: /platform-endpoint data: - key: value + - Varies by platform source: openapi: openapi/openapi.yml diff --git a/.mock/definition/accounting/incomeStatements.yml b/.mock/definition/accounting/incomeStatements.yml index cb1a1ace..11ad49af 100644 --- a/.mock/definition/accounting/incomeStatements.yml +++ b/.mock/definition/accounting/incomeStatements.yml @@ -115,6 +115,7 @@ service: - remote_id: '10201' name: Pest Control Services value: -100 + company: 595c8f97-2ac4-45b7-b000-41bdf43240b5 cost_of_sales: - remote_id: '10299' created_at: '2021-09-15T00:00:00Z' @@ -125,6 +126,7 @@ service: - remote_id: '10200' name: Supplies value: 10 + company: 595c8f97-2ac4-45b7-b000-41bdf43240b5 gross_profit: 300 operating_expenses: - remote_id: '10299' @@ -139,6 +141,7 @@ service: - remote_id: '10301' name: Revenue - New York value: 500 + company: 595c8f97-2ac4-45b7-b000-41bdf43240b5 net_operating_income: 200 non_operating_expenses: - remote_id: '10299' @@ -153,6 +156,7 @@ service: - remote_id: '10301' name: Revenue - New York value: 500 + company: 595c8f97-2ac4-45b7-b000-41bdf43240b5 net_income: 100 remote_was_deleted: true field_mappings: diff --git a/.mock/definition/accounting/invoices.yml b/.mock/definition/accounting/invoices.yml index b5fd903c..84b00b58 100644 --- a/.mock/definition/accounting/invoices.yml +++ b/.mock/definition/accounting/invoices.yml @@ -27164,14 +27164,21 @@ service: - 9b840d2-686a-465a-8a8e-7b028498f8e4 - a47e11b6-c73b-4a0c-be31-130fc48177fa company: 595c8f97-2ac4-45b7-b000-41bdf43240b5 + field_mappings: + organization_defined_targets: + custom_key: custom_value + linked_account_defined_targets: + custom_key: custom_value applied_credit_notes: - - created_at: '2021-09-15T00:00:00Z' + - remote_id: '088899' + created_at: '2021-09-15T00:00:00Z' modified_at: '2021-10-16T00:00:00Z' credit_note: 5b3c1341-a20f-4e51-b72c-f3830a16c97b applied_date: '2020-03-31T00:00:00Z' applied_amount: '2.9' applied_vendor_credits: - - created_at: '2021-09-15T00:00:00Z' + - remote_id: '088899' + created_at: '2021-09-15T00:00:00Z' modified_at: '2021-10-16T00:00:00Z' vendor_credit: 5b3c1341-a20f-4e51-b72c-f3830a16c97b applied_date: '2020-03-31T00:00:00Z' @@ -27189,6 +27196,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string create: path: /accounting/v1/invoices method: POST @@ -27288,14 +27296,21 @@ service: - 9b840d2-686a-465a-8a8e-7b028498f8e4 - a47e11b6-c73b-4a0c-be31-130fc48177fa company: 595c8f97-2ac4-45b7-b000-41bdf43240b5 + field_mappings: + organization_defined_targets: + custom_key: custom_value + linked_account_defined_targets: + custom_key: custom_value applied_credit_notes: - - created_at: '2021-09-15T00:00:00Z' + - remote_id: '088899' + created_at: '2021-09-15T00:00:00Z' modified_at: '2021-10-16T00:00:00Z' credit_note: 5b3c1341-a20f-4e51-b72c-f3830a16c97b applied_date: '2020-03-31T00:00:00Z' applied_amount: '2.9' applied_vendor_credits: - - created_at: '2021-09-15T00:00:00Z' + - remote_id: '088899' + created_at: '2021-09-15T00:00:00Z' modified_at: '2021-10-16T00:00:00Z' vendor_credit: 5b3c1341-a20f-4e51-b72c-f3830a16c97b applied_date: '2020-03-31T00:00:00Z' @@ -27313,6 +27328,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string warnings: - source: pointer: pointer @@ -27460,6 +27476,7 @@ service: custom_key: custom_value remote_fields: - remote_field_class: remote_field_class + value: string applied_credit_notes: - remote_id: '088899' created_at: '2021-09-15T00:00:00Z' @@ -27489,8 +27506,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class - value: - key: value + value: string partialUpdate: path: /accounting/v1/invoices/{id} method: PATCH @@ -27591,14 +27607,21 @@ service: - 9b840d2-686a-465a-8a8e-7b028498f8e4 - a47e11b6-c73b-4a0c-be31-130fc48177fa company: 595c8f97-2ac4-45b7-b000-41bdf43240b5 + field_mappings: + organization_defined_targets: + custom_key: custom_value + linked_account_defined_targets: + custom_key: custom_value applied_credit_notes: - - created_at: '2021-09-15T00:00:00Z' + - remote_id: '088899' + created_at: '2021-09-15T00:00:00Z' modified_at: '2021-10-16T00:00:00Z' credit_note: 5b3c1341-a20f-4e51-b72c-f3830a16c97b applied_date: '2020-03-31T00:00:00Z' applied_amount: '2.9' applied_vendor_credits: - - created_at: '2021-09-15T00:00:00Z' + - remote_id: '088899' + created_at: '2021-09-15T00:00:00Z' modified_at: '2021-10-16T00:00:00Z' vendor_credit: 5b3c1341-a20f-4e51-b72c-f3830a16c97b applied_date: '2020-03-31T00:00:00Z' @@ -27616,6 +27639,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string warnings: - source: pointer: pointer diff --git a/.mock/definition/accounting/journalEntries.yml b/.mock/definition/accounting/journalEntries.yml index 163555c7..6c823fe1 100644 --- a/.mock/definition/accounting/journalEntries.yml +++ b/.mock/definition/accounting/journalEntries.yml @@ -401,6 +401,16 @@ service: modified_at: '2021-10-16T00:00:00Z' account: f963f34d-3d2f-4f77-b557-cf36bc7e6498 net_amount: 10 + tracking_categories: + - d25d609b-945f-4762-b55a-1c8fb220c43c + - 9b840d2-686a-465a-8a8e-7b028498f8e4 + - a47e11b6-c73b-4a0c-be31-130fc48177fa + company: 595c8f97-2ac4-45b7-b000-41bdf43240b5 + employee: 123c8r35-5kf5-12x5-r833-99bwf35210b5 + contact: d2d5ea3c-b032-11ec-b909-0242ac120002 + tax_rate: a12e7c20-1922-9df7-s75n-edfeewnn7384 + description: Cash payment for lunch + exchange_rate: '2.9' journal_number: '42' tracking_categories: - b38c59b0-a9d7-4740-b1ee-5436c6751e3d @@ -422,6 +432,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string create: path: /accounting/v1/journal-entries method: POST @@ -499,6 +510,16 @@ service: modified_at: '2021-10-16T00:00:00Z' account: f963f34d-3d2f-4f77-b557-cf36bc7e6498 net_amount: 10 + tracking_categories: + - d25d609b-945f-4762-b55a-1c8fb220c43c + - 9b840d2-686a-465a-8a8e-7b028498f8e4 + - a47e11b6-c73b-4a0c-be31-130fc48177fa + company: 595c8f97-2ac4-45b7-b000-41bdf43240b5 + employee: 123c8r35-5kf5-12x5-r833-99bwf35210b5 + contact: d2d5ea3c-b032-11ec-b909-0242ac120002 + tax_rate: a12e7c20-1922-9df7-s75n-edfeewnn7384 + description: Cash payment for lunch + exchange_rate: '2.9' journal_number: '42' tracking_categories: - b38c59b0-a9d7-4740-b1ee-5436c6751e3d @@ -520,6 +541,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string warnings: - source: pointer: pointer @@ -625,6 +647,7 @@ service: remote_was_deleted: false remote_fields: - remote_field_class: remote_field_class + value: string - id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 remote_id: '121223' created_at: '2021-09-15T00:00:00Z' @@ -646,6 +669,7 @@ service: remote_was_deleted: true remote_fields: - remote_field_class: remote_field_class + value: string journal_number: '42' tracking_categories: - b38c59b0-a9d7-4740-b1ee-5436c6751e3d @@ -667,8 +691,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class - value: - key: value + value: string linesRemoteFieldClassesList: path: /accounting/v1/journal-entries/lines/remote-field-classes method: GET diff --git a/.mock/definition/accounting/passthrough.yml b/.mock/definition/accounting/passthrough.yml index c50e8282..bd4b2a6a 100644 --- a/.mock/definition/accounting/passthrough.yml +++ b/.mock/definition/accounting/passthrough.yml @@ -31,7 +31,11 @@ service: path: /scooters status: 200 response: - key: value + scooters: + - company: Lime + model: Gen 2.5 + - company: Bird + model: Bird Zero response_headers: X-Page-Token: value response_type: JSON diff --git a/.mock/definition/accounting/payments.yml b/.mock/definition/accounting/payments.yml index 9992cedd..df550c47 100644 --- a/.mock/definition/accounting/payments.yml +++ b/.mock/definition/accounting/payments.yml @@ -698,6 +698,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string create: path: /accounting/v1/payments method: POST @@ -784,6 +785,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string warnings: - source: pointer: pointer @@ -901,8 +903,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class - value: - key: value + value: string partialUpdate: path: /accounting/v1/payments/{id} method: PATCH @@ -993,6 +994,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string warnings: - source: pointer: pointer diff --git a/.mock/definition/accounting/purchaseOrders.yml b/.mock/definition/accounting/purchaseOrders.yml index 4de1b4fa..aa3a21be 100644 --- a/.mock/definition/accounting/purchaseOrders.yml +++ b/.mock/definition/accounting/purchaseOrders.yml @@ -698,6 +698,7 @@ service: company: 595c8f97-2ac4-45b7-b000-41bdf43240b5 remote_was_deleted: false - id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 + remote_id: '121222' created_at: '2021-09-15T00:00:00Z' modified_at: '2021-10-16T00:00:00Z' description: Pickleball Balls @@ -710,6 +711,9 @@ service: - a47e11b6-c73b-4a0c-be31-130fc48177fa tax_amount: tax_amount total_line_amount: total_line_amount + tax_rate: a12e7c20-1922-9df7-s75n-edfeewnn7384 + exchange_rate: '2.9' + company: 595c8f97-2ac4-45b7-b000-41bdf43240b5 inclusive_of_tax: true tracking_categories: - b38c59b0-a9d7-4740-b1ee-5436c6751e3d @@ -730,6 +734,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string create: path: /accounting/v1/purchase-orders method: POST @@ -806,6 +811,7 @@ service: company: 595c8f97-2ac4-45b7-b000-41bdf43240b5 remote_was_deleted: false - id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 + remote_id: '121222' created_at: '2021-09-15T00:00:00Z' modified_at: '2021-10-16T00:00:00Z' description: Pickleball Balls @@ -818,6 +824,9 @@ service: - a47e11b6-c73b-4a0c-be31-130fc48177fa tax_amount: tax_amount total_line_amount: total_line_amount + tax_rate: a12e7c20-1922-9df7-s75n-edfeewnn7384 + exchange_rate: '2.9' + company: 595c8f97-2ac4-45b7-b000-41bdf43240b5 inclusive_of_tax: true tracking_categories: - b38c59b0-a9d7-4740-b1ee-5436c6751e3d @@ -838,6 +847,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string warnings: - source: pointer: pointer @@ -959,6 +969,7 @@ service: remote_was_deleted: false remote_fields: - remote_field_class: remote_field_class + value: string - id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 remote_id: '121222' created_at: '2021-09-15T00:00:00Z' @@ -981,6 +992,7 @@ service: remote_was_deleted: true remote_fields: - remote_field_class: remote_field_class + value: string inclusive_of_tax: true tracking_categories: - b38c59b0-a9d7-4740-b1ee-5436c6751e3d @@ -1001,8 +1013,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class - value: - key: value + value: string lineItemsRemoteFieldClassesList: path: /accounting/v1/purchase-orders/line-items/remote-field-classes method: GET diff --git a/.mock/definition/accounting/transactions.yml b/.mock/definition/accounting/transactions.yml index d58c6842..7b572615 100644 --- a/.mock/definition/accounting/transactions.yml +++ b/.mock/definition/accounting/transactions.yml @@ -395,6 +395,7 @@ service: company: 595c8f97-2ac4-45b7-b000-41bdf43240b5 remote_was_deleted: false - id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4 + remote_id: '121222' created_at: '2021-09-15T00:00:00Z' modified_at: '2021-10-16T00:00:00Z' memo: Pickleball balls @@ -408,6 +409,8 @@ service: - a47e11b6-c73b-4a0c-be31-130fc48177fa total_line_amount: total_line_amount tax_rate: a12e7c20-1922-9df7-s75n-edfeewnn7384 + exchange_rate: '2.9' + company: 595c8f97-2ac4-45b7-b000-41bdf43240b5 remote_was_deleted: true accounting_period: accounting_period field_mappings: diff --git a/.mock/definition/accounting/vendorCredits.yml b/.mock/definition/accounting/vendorCredits.yml index 2b9b8bdb..a6969c9c 100644 --- a/.mock/definition/accounting/vendorCredits.yml +++ b/.mock/definition/accounting/vendorCredits.yml @@ -267,12 +267,16 @@ service: - a47e11b6-c73b-4a0c-be31-130fc48177fa description: Refund for overpayment account: 9d892439-5fab-4dbb-8bd8-34f7f96c7912 + company: 595c8f97-2ac4-45b7-b000-41bdf43240b5 + tax_rate: a12e7c20-1922-9df7-s75n-edfeewnn7384 + exchange_rate: '2.9' tracking_categories: - b38c59b0-a9d7-4740-b1ee-5436c6751e3d - 9b840d2-686a-465a-8a8e-7b028498f8e4 - a47e11b6-c73b-4a0c-be31-130fc48177fa applied_to_lines: - - created_at: '2021-09-15T00:00:00Z' + - remote_id: '088899' + created_at: '2021-09-15T00:00:00Z' modified_at: '2021-10-16T00:00:00Z' invoice: 5b3c1341-a20f-4e51-b72c-f3830a16c97b applied_date: '2020-03-31T00:00:00Z' @@ -367,12 +371,16 @@ service: - a47e11b6-c73b-4a0c-be31-130fc48177fa description: Refund for overpayment account: 9d892439-5fab-4dbb-8bd8-34f7f96c7912 + company: 595c8f97-2ac4-45b7-b000-41bdf43240b5 + tax_rate: a12e7c20-1922-9df7-s75n-edfeewnn7384 + exchange_rate: '2.9' tracking_categories: - b38c59b0-a9d7-4740-b1ee-5436c6751e3d - 9b840d2-686a-465a-8a8e-7b028498f8e4 - a47e11b6-c73b-4a0c-be31-130fc48177fa applied_to_lines: - - created_at: '2021-09-15T00:00:00Z' + - remote_id: '088899' + created_at: '2021-09-15T00:00:00Z' modified_at: '2021-10-16T00:00:00Z' invoice: 5b3c1341-a20f-4e51-b72c-f3830a16c97b applied_date: '2020-03-31T00:00:00Z' diff --git a/.mock/definition/ats/__package__.yml b/.mock/definition/ats/__package__.yml index e280d693..7b2174d2 100644 --- a/.mock/definition/ats/__package__.yml +++ b/.mock/definition/ats/__package__.yml @@ -3527,6 +3527,9 @@ types: docs: The third-party API path that is being called. data: type: optional + docs: >- + The data returned from the third-party for this object in its + original, unnormalized format. access: read-only source: openapi: openapi/openapi.yml diff --git a/.mock/definition/ats/asyncPassthrough.yml b/.mock/definition/ats/asyncPassthrough.yml index 44039152..07d63611 100644 --- a/.mock/definition/ats/asyncPassthrough.yml +++ b/.mock/definition/ats/asyncPassthrough.yml @@ -55,7 +55,11 @@ service: path: /scooters status: 200 response: - key: value + scooters: + - company: Lime + model: Gen 2.5 + - company: Bird + model: Bird Zero response_headers: X-Page-Token: value response_type: JSON diff --git a/.mock/definition/ats/passthrough.yml b/.mock/definition/ats/passthrough.yml index 1379f58a..4a196e46 100644 --- a/.mock/definition/ats/passthrough.yml +++ b/.mock/definition/ats/passthrough.yml @@ -31,7 +31,11 @@ service: path: /scooters status: 200 response: - key: value + scooters: + - company: Lime + model: Gen 2.5 + - company: Bird + model: Bird Zero response_headers: X-Page-Token: value response_type: JSON diff --git a/.mock/definition/chat/__package__.yml b/.mock/definition/chat/__package__.yml index 8b785b13..e0d72bf5 100644 --- a/.mock/definition/chat/__package__.yml +++ b/.mock/definition/chat/__package__.yml @@ -1066,6 +1066,7 @@ types: docs: The name of the Group validation: maxLength: 254 + users: optional>> remote_created_at: type: optional docs: When the third party's group was created. @@ -1514,6 +1515,9 @@ types: docs: The third-party API path that is being called. data: type: optional + docs: >- + The data returned from the third-party for this object in its + original, unnormalized format. access: read-only source: openapi: openapi/openapi.yml diff --git a/.mock/definition/chat/asyncPassthrough.yml b/.mock/definition/chat/asyncPassthrough.yml index 5a5db1aa..22ada60f 100644 --- a/.mock/definition/chat/asyncPassthrough.yml +++ b/.mock/definition/chat/asyncPassthrough.yml @@ -55,7 +55,11 @@ service: path: /scooters status: 200 response: - key: value + scooters: + - company: Lime + model: Gen 2.5 + - company: Bird + model: Bird Zero response_headers: X-Page-Token: value response_type: JSON diff --git a/.mock/definition/chat/groups.yml b/.mock/definition/chat/groups.yml index dbc7d4da..da1425a1 100644 --- a/.mock/definition/chat/groups.yml +++ b/.mock/definition/chat/groups.yml @@ -26,6 +26,11 @@ service: cursor: type: optional docs: The pagination cursor value. + expand: + type: optional> + docs: >- + Which relations should be returned in expanded form. Multiple + relation names should be comma separated without spaces. include_deleted_data: type: optional docs: >- @@ -69,6 +74,7 @@ service: created_after: '2024-01-15T09:30:00Z' created_before: '2024-01-15T09:30:00Z' cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw + expand: users include_deleted_data: true include_remote_data: true include_shell_data: true @@ -88,6 +94,8 @@ service: created_at: '2021-09-15T00:00:00Z' modified_at: '2021-10-16T00:00:00Z' name: Engineering + users: + - users remote_created_at: '2021-09-15T00:00:00Z' remote_updated_at: '2021-09-16T00:00:00Z' remote_was_deleted: true @@ -113,6 +121,11 @@ service: request: name: GroupsRetrieveRequest query-parameters: + expand: + type: optional> + docs: >- + Which relations should be returned in expanded form. Multiple + relation names should be comma separated without spaces. include_remote_data: type: optional docs: >- @@ -131,6 +144,7 @@ service: - path-parameters: id: id query-parameters: + expand: users include_remote_data: true include_shell_data: true headers: @@ -142,6 +156,8 @@ service: created_at: '2021-09-15T00:00:00Z' modified_at: '2021-10-16T00:00:00Z' name: Engineering + users: + - users remote_created_at: '2021-09-15T00:00:00Z' remote_updated_at: '2021-09-16T00:00:00Z' remote_was_deleted: true diff --git a/.mock/definition/chat/linkToken.yml b/.mock/definition/chat/linkToken.yml index cddf6967..f4084f63 100644 --- a/.mock/definition/chat/linkToken.yml +++ b/.mock/definition/chat/linkToken.yml @@ -40,7 +40,9 @@ service: method: POST auth: - tokenAuth: [] - docs: Creates a link token to be used when linking a new end user. + docs: >- + Creates a link token to be used when linking a new end user. The link + token expires after single use. source: openapi: openapi/openapi.yml request: diff --git a/.mock/definition/chat/messages.yml b/.mock/definition/chat/messages.yml index 75208260..acf1a202 100644 --- a/.mock/definition/chat/messages.yml +++ b/.mock/definition/chat/messages.yml @@ -32,6 +32,11 @@ service: request: name: MessagesListRequest query-parameters: + conversation_id: + type: optional + docs: Filter messages by conversation ID. + validation: + format: uuid created_after: type: optional docs: If provided, will only return objects created after this datetime. @@ -93,6 +98,7 @@ service: status-code: 200 examples: - query-parameters: + conversation_id: conversation_id created_after: '2024-01-15T09:30:00Z' created_before: '2024-01-15T09:30:00Z' cursor: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw diff --git a/.mock/definition/chat/passthrough.yml b/.mock/definition/chat/passthrough.yml index a8dfd8f9..ae7ea1ed 100644 --- a/.mock/definition/chat/passthrough.yml +++ b/.mock/definition/chat/passthrough.yml @@ -31,7 +31,11 @@ service: path: /scooters status: 200 response: - key: value + scooters: + - company: Lime + model: Gen 2.5 + - company: Bird + model: Bird Zero response_headers: X-Page-Token: value response_type: JSON diff --git a/.mock/definition/crm/__package__.yml b/.mock/definition/crm/__package__.yml index adb6df8b..c2f1308b 100644 --- a/.mock/definition/crm/__package__.yml +++ b/.mock/definition/crm/__package__.yml @@ -5071,6 +5071,9 @@ types: docs: The third-party API path that is being called. data: type: optional + docs: >- + The data returned from the third-party for this object in its + original, unnormalized format. access: read-only source: openapi: openapi/openapi.yml diff --git a/.mock/definition/crm/accounts.yml b/.mock/definition/crm/accounts.yml index 4c1d6b27..08a87f07 100644 --- a/.mock/definition/crm/accounts.yml +++ b/.mock/definition/crm/accounts.yml @@ -143,6 +143,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string create: path: /crm/v1/accounts method: POST @@ -221,6 +222,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string warnings: - source: pointer: pointer @@ -330,8 +332,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class - value: - key: value + value: string partialUpdate: path: /crm/v1/accounts/{id} method: PATCH @@ -414,6 +415,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string warnings: - source: pointer: pointer diff --git a/.mock/definition/crm/asyncPassthrough.yml b/.mock/definition/crm/asyncPassthrough.yml index 1f1698d8..1fc93cd5 100644 --- a/.mock/definition/crm/asyncPassthrough.yml +++ b/.mock/definition/crm/asyncPassthrough.yml @@ -55,7 +55,11 @@ service: path: /scooters status: 200 response: - key: value + scooters: + - company: Lime + model: Gen 2.5 + - company: Bird + model: Bird Zero response_headers: X-Page-Token: value response_type: JSON diff --git a/.mock/definition/crm/contacts.yml b/.mock/definition/crm/contacts.yml index dbeb1b5f..f2af6958 100644 --- a/.mock/definition/crm/contacts.yml +++ b/.mock/definition/crm/contacts.yml @@ -170,6 +170,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string create: path: /crm/v1/contacts method: POST @@ -250,6 +251,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string warnings: - source: pointer: pointer @@ -361,8 +363,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class - value: - key: value + value: string partialUpdate: path: /crm/v1/contacts/{id} method: PATCH @@ -447,6 +448,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string warnings: - source: pointer: pointer diff --git a/.mock/definition/crm/customObjectClasses.yml b/.mock/definition/crm/customObjectClasses.yml index 145bc579..72d6df87 100644 --- a/.mock/definition/crm/customObjectClasses.yml +++ b/.mock/definition/crm/customObjectClasses.yml @@ -226,6 +226,10 @@ service: field_choices: - {} - {} + item_schema: + item_type: null + item_format: null + item_choices: null association_types: - key: value source: diff --git a/.mock/definition/crm/customObjects.yml b/.mock/definition/crm/customObjects.yml index 4a3dac8c..b5e0d29c 100644 --- a/.mock/definition/crm/customObjects.yml +++ b/.mock/definition/crm/customObjects.yml @@ -104,6 +104,7 @@ service: customer_type: Returning remote_fields: - remote_field_class: remote_field_class + value: string custom_object_classes_custom_objects_create: path: /crm/v1/custom-object-classes/{custom_object_class_id}/custom-objects method: POST @@ -159,6 +160,7 @@ service: customer_type: Returning remote_fields: - remote_field_class: remote_field_class + value: string warnings: - source: pointer: pointer @@ -236,8 +238,7 @@ service: customer_type: Returning remote_fields: - remote_field_class: remote_field_class - value: - key: value + value: string custom_object_classes_custom_objects_meta_post_retrieve: path: >- /crm/v1/custom-object-classes/{custom_object_class_id}/custom-objects/meta/post diff --git a/.mock/definition/crm/engagementTypes.yml b/.mock/definition/crm/engagementTypes.yml index 23a484a9..25273d46 100644 --- a/.mock/definition/crm/engagementTypes.yml +++ b/.mock/definition/crm/engagementTypes.yml @@ -97,6 +97,7 @@ service: name: First Call remote_fields: - remote_field_class: remote_field_class + value: string retrieve: path: /crm/v1/engagement-types/{id} method: GET @@ -148,8 +149,7 @@ service: name: First Call remote_fields: - remote_field_class: remote_field_class - value: - key: value + value: string remoteFieldClassesList: path: /crm/v1/engagement-types/remote-field-classes method: GET diff --git a/.mock/definition/crm/engagements.yml b/.mock/definition/crm/engagements.yml index 384459c5..14eb0b84 100644 --- a/.mock/definition/crm/engagements.yml +++ b/.mock/definition/crm/engagements.yml @@ -194,6 +194,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string create: path: /crm/v1/engagements method: POST @@ -258,6 +259,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string warnings: - source: pointer: pointer @@ -353,8 +355,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class - value: - key: value + value: string partialUpdate: path: /crm/v1/engagements/{id} method: PATCH @@ -423,6 +424,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string warnings: - source: pointer: pointer diff --git a/.mock/definition/crm/leads.yml b/.mock/definition/crm/leads.yml index 871da7f7..6b81c6e5 100644 --- a/.mock/definition/crm/leads.yml +++ b/.mock/definition/crm/leads.yml @@ -197,6 +197,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string create: path: /crm/v1/leads method: POST @@ -282,6 +283,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string warnings: - source: pointer: pointer @@ -398,8 +400,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class - value: - key: value + value: string metaPostRetrieve: path: /crm/v1/leads/meta/post method: GET diff --git a/.mock/definition/crm/notes.yml b/.mock/definition/crm/notes.yml index f655ff38..3d915d48 100644 --- a/.mock/definition/crm/notes.yml +++ b/.mock/definition/crm/notes.yml @@ -195,6 +195,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string create: path: /crm/v1/notes method: POST @@ -256,6 +257,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string warnings: - source: pointer: pointer @@ -348,8 +350,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class - value: - key: value + value: string metaPostRetrieve: path: /crm/v1/notes/meta/post method: GET diff --git a/.mock/definition/crm/opportunities.yml b/.mock/definition/crm/opportunities.yml index 7485a78e..35678301 100644 --- a/.mock/definition/crm/opportunities.yml +++ b/.mock/definition/crm/opportunities.yml @@ -202,6 +202,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string create: path: /crm/v1/opportunities method: POST @@ -266,6 +267,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string warnings: - source: pointer: pointer @@ -373,8 +375,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class - value: - key: value + value: string partialUpdate: path: /crm/v1/opportunities/{id} method: PATCH @@ -443,6 +444,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string warnings: - source: pointer: pointer diff --git a/.mock/definition/crm/passthrough.yml b/.mock/definition/crm/passthrough.yml index 147b406c..ed00b557 100644 --- a/.mock/definition/crm/passthrough.yml +++ b/.mock/definition/crm/passthrough.yml @@ -31,7 +31,11 @@ service: path: /scooters status: 200 response: - key: value + scooters: + - company: Lime + model: Gen 2.5 + - company: Bird + model: Bird Zero response_headers: X-Page-Token: value response_type: JSON diff --git a/.mock/definition/crm/stages.yml b/.mock/definition/crm/stages.yml index 4d871422..9485966f 100644 --- a/.mock/definition/crm/stages.yml +++ b/.mock/definition/crm/stages.yml @@ -106,6 +106,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string retrieve: path: /crm/v1/stages/{id} method: GET @@ -166,8 +167,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class - value: - key: value + value: string remoteFieldClassesList: path: /crm/v1/stages/remote-field-classes method: GET diff --git a/.mock/definition/crm/tasks.yml b/.mock/definition/crm/tasks.yml index f7df5e71..0f9f55fb 100644 --- a/.mock/definition/crm/tasks.yml +++ b/.mock/definition/crm/tasks.yml @@ -150,6 +150,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string create: path: /crm/v1/tasks method: POST @@ -212,6 +213,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string warnings: - source: pointer: pointer @@ -305,8 +307,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class - value: - key: value + value: string partialUpdate: path: /crm/v1/tasks/{id} method: PATCH @@ -373,6 +374,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string warnings: - source: pointer: pointer diff --git a/.mock/definition/crm/users.yml b/.mock/definition/crm/users.yml index 97b21b6e..81fc4641 100644 --- a/.mock/definition/crm/users.yml +++ b/.mock/definition/crm/users.yml @@ -112,6 +112,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string retrieve: path: /crm/v1/users/{id} method: GET @@ -174,8 +175,7 @@ service: - Varies by platform remote_fields: - remote_field_class: remote_field_class - value: - key: value + value: string ignoreCreate: path: /crm/v1/users/ignore/{model_id} method: POST diff --git a/.mock/definition/filestorage/__package__.yml b/.mock/definition/filestorage/__package__.yml index 16d7bfbc..762ddb92 100644 --- a/.mock/definition/filestorage/__package__.yml +++ b/.mock/definition/filestorage/__package__.yml @@ -2081,6 +2081,9 @@ types: docs: The third-party API path that is being called. data: type: optional + docs: >- + The data returned from the third-party for this object in its + original, unnormalized format. access: read-only source: openapi: openapi/openapi.yml diff --git a/.mock/definition/filestorage/asyncPassthrough.yml b/.mock/definition/filestorage/asyncPassthrough.yml index 7a336038..e718c89d 100644 --- a/.mock/definition/filestorage/asyncPassthrough.yml +++ b/.mock/definition/filestorage/asyncPassthrough.yml @@ -55,7 +55,11 @@ service: path: /scooters status: 200 response: - key: value + scooters: + - company: Lime + model: Gen 2.5 + - company: Bird + model: Bird Zero response_headers: X-Page-Token: value response_type: JSON diff --git a/.mock/definition/filestorage/passthrough.yml b/.mock/definition/filestorage/passthrough.yml index dc993de1..664c7c6b 100644 --- a/.mock/definition/filestorage/passthrough.yml +++ b/.mock/definition/filestorage/passthrough.yml @@ -31,7 +31,11 @@ service: path: /scooters status: 200 response: - key: value + scooters: + - company: Lime + model: Gen 2.5 + - company: Bird + model: Bird Zero response_headers: X-Page-Token: value response_type: JSON diff --git a/.mock/definition/hris/__package__.yml b/.mock/definition/hris/__package__.yml index 2b2ae989..20f040eb 100644 --- a/.mock/definition/hris/__package__.yml +++ b/.mock/definition/hris/__package__.yml @@ -6739,6 +6739,9 @@ types: docs: The third-party API path that is being called. data: type: optional + docs: >- + The data returned from the third-party for this object in its + original, unnormalized format. access: read-only source: openapi: openapi/openapi.yml diff --git a/.mock/definition/hris/asyncPassthrough.yml b/.mock/definition/hris/asyncPassthrough.yml index faed6335..a7579b75 100644 --- a/.mock/definition/hris/asyncPassthrough.yml +++ b/.mock/definition/hris/asyncPassthrough.yml @@ -55,7 +55,11 @@ service: path: /scooters status: 200 response: - key: value + scooters: + - company: Lime + model: Gen 2.5 + - company: Bird + model: Bird Zero response_headers: X-Page-Token: value response_type: JSON diff --git a/.mock/definition/hris/employeePayrollRuns.yml b/.mock/definition/hris/employeePayrollRuns.yml index 08989deb..60958af7 100644 --- a/.mock/definition/hris/employeePayrollRuns.yml +++ b/.mock/definition/hris/employeePayrollRuns.yml @@ -155,33 +155,61 @@ service: check_date: '2020-11-10T00:00:00Z' earnings: - id: babbced6-3a81-4775-8da2-490dc6385259 + remote_id: '52802' created_at: '2021-09-15T00:00:00Z' modified_at: '2021-10-16T00:00:00Z' employee_payroll_run: 35347df1-95e7-46e2-93cc-66f1191edca5 amount: 1002.34 type: SALARY + field_mappings: + organization_defined_targets: + custom_key: custom_value + linked_account_defined_targets: + custom_key: custom_value - id: babbced6-3a81-4775-8da2-490dc6385259 + remote_id: '52802' created_at: '2021-09-15T00:00:00Z' modified_at: '2021-10-16T00:00:00Z' employee_payroll_run: 35347df1-95e7-46e2-93cc-66f1191edca5 amount: 8342.34 type: OVERTIME + field_mappings: + organization_defined_targets: + custom_key: custom_value + linked_account_defined_targets: + custom_key: custom_value deductions: - id: 5fd439fc-1b64-4755-b275-64918936c365 + remote_id: '93478612' created_at: '2021-09-15T00:00:00Z' modified_at: '2021-10-16T00:00:00Z' employee_payroll_run: 35347df1-95e7-46e2-93cc-66f1191edca5 name: Social Security employee_deduction: 34.54 company_deduction: 78.78 + field_mappings: + organization_defined_targets: + custom_key: custom_value + linked_account_defined_targets: + custom_key: custom_value + remote_data: + - path: /payroll-deduction + data: + - Varies by platform taxes: - id: e3a825fd-c38d-4095-a717-df98c4cb9ebc + remote_id: '26806834' created_at: '2021-09-15T00:00:00Z' modified_at: '2021-10-16T00:00:00Z' employee_payroll_run: 35347df1-95e7-46e2-93cc-66f1191edca5 name: California State Income Tax amount: 100.25 employer_tax: true + field_mappings: + organization_defined_targets: + custom_key: custom_value + linked_account_defined_targets: + custom_key: custom_value remote_was_deleted: true field_mappings: organization_defined_targets: @@ -262,6 +290,8 @@ service: custom_key: custom_value remote_data: - path: /platform-endpoint + data: + - Varies by platform - id: babbced6-3a81-4775-8da2-490dc6385259 remote_id: '52802' created_at: '2021-09-15T00:00:00Z' @@ -277,6 +307,8 @@ service: custom_key: custom_value remote_data: - path: /platform-endpoint + data: + - Varies by platform deductions: - id: 5fd439fc-1b64-4755-b275-64918936c365 remote_id: '93478612' @@ -313,6 +345,8 @@ service: custom_key: custom_value remote_data: - path: /platform-endpoint + data: + - Varies by platform remote_was_deleted: true field_mappings: organization_defined_targets: diff --git a/.mock/definition/hris/employerBenefits.yml b/.mock/definition/hris/employerBenefits.yml index 5d9d4137..fd922280 100644 --- a/.mock/definition/hris/employerBenefits.yml +++ b/.mock/definition/hris/employerBenefits.yml @@ -99,6 +99,8 @@ service: custom_key: custom_value remote_data: - path: /platform-endpoint + data: + - Varies by platform retrieve: path: /hris/v1/employer-benefits/{id} method: GET @@ -153,6 +155,6 @@ service: remote_data: - path: /platform-endpoint data: - key: value + - Varies by platform source: openapi: openapi/openapi.yml diff --git a/.mock/definition/hris/passthrough.yml b/.mock/definition/hris/passthrough.yml index 28029d92..2a6c9cf2 100644 --- a/.mock/definition/hris/passthrough.yml +++ b/.mock/definition/hris/passthrough.yml @@ -31,7 +31,11 @@ service: path: /scooters status: 200 response: - key: value + scooters: + - company: Lime + model: Gen 2.5 + - company: Bird + model: Bird Zero response_headers: X-Page-Token: value response_type: JSON diff --git a/.mock/definition/knowledgebase/__package__.yml b/.mock/definition/knowledgebase/__package__.yml index ed758215..507587e3 100644 --- a/.mock/definition/knowledgebase/__package__.yml +++ b/.mock/definition/knowledgebase/__package__.yml @@ -1913,6 +1913,9 @@ types: docs: The third-party API path that is being called. data: type: optional + docs: >- + The data returned from the third-party for this object in its + original, unnormalized format. access: read-only source: openapi: openapi/openapi.yml diff --git a/.mock/definition/knowledgebase/articles.yml b/.mock/definition/knowledgebase/articles.yml index 0c2c8ac0..ccfeb650 100644 --- a/.mock/definition/knowledgebase/articles.yml +++ b/.mock/definition/knowledgebase/articles.yml @@ -689,6 +689,11 @@ service: type: USER roles: - OWNER + field_mappings: + organization_defined_targets: + custom_key: custom_value + linked_account_defined_targets: + custom_key: custom_value attachments: - 640b80b-fac9-409f-aa19-1f9221aec445 remote_was_deleted: true @@ -772,6 +777,7 @@ service: created_at: '2020-03-31T00:00:00Z' modified_at: '2020-06-20T00:00:00Z' user: 21ce474c-asdf-34a2-754r-629f799f7d12 + group: group type: USER roles: - OWNER diff --git a/.mock/definition/knowledgebase/asyncPassthrough.yml b/.mock/definition/knowledgebase/asyncPassthrough.yml index de432290..02bd5fa3 100644 --- a/.mock/definition/knowledgebase/asyncPassthrough.yml +++ b/.mock/definition/knowledgebase/asyncPassthrough.yml @@ -55,7 +55,11 @@ service: path: /scooters status: 200 response: - key: value + scooters: + - company: Lime + model: Gen 2.5 + - company: Bird + model: Bird Zero response_headers: X-Page-Token: value response_type: JSON diff --git a/.mock/definition/knowledgebase/containers.yml b/.mock/definition/knowledgebase/containers.yml index 603d38d7..827ae3c8 100644 --- a/.mock/definition/knowledgebase/containers.yml +++ b/.mock/definition/knowledgebase/containers.yml @@ -177,6 +177,11 @@ service: type: USER roles: - OWNER + field_mappings: + organization_defined_targets: + custom_key: custom_value + linked_account_defined_targets: + custom_key: custom_value remote_was_deleted: true field_mappings: organization_defined_targets: @@ -252,6 +257,7 @@ service: created_at: '2020-03-31T00:00:00Z' modified_at: '2020-06-20T00:00:00Z' user: 21ce474c-asdf-34a2-754r-629f799f7d12 + group: group type: USER roles: - OWNER diff --git a/.mock/definition/knowledgebase/passthrough.yml b/.mock/definition/knowledgebase/passthrough.yml index 4a4ba7bc..425d3461 100644 --- a/.mock/definition/knowledgebase/passthrough.yml +++ b/.mock/definition/knowledgebase/passthrough.yml @@ -31,7 +31,11 @@ service: path: /scooters status: 200 response: - key: value + scooters: + - company: Lime + model: Gen 2.5 + - company: Bird + model: Bird Zero response_headers: X-Page-Token: value response_type: JSON diff --git a/.mock/definition/ticketing/__package__.yml b/.mock/definition/ticketing/__package__.yml index d1aa2e53..e988754d 100644 --- a/.mock/definition/ticketing/__package__.yml +++ b/.mock/definition/ticketing/__package__.yml @@ -2252,6 +2252,9 @@ types: docs: The third-party API path that is being called. data: type: optional + docs: >- + The data returned from the third-party for this object in its + original, unnormalized format. access: read-only source: openapi: openapi/openapi.yml diff --git a/.mock/definition/ticketing/asyncPassthrough.yml b/.mock/definition/ticketing/asyncPassthrough.yml index f988cb0a..32c50223 100644 --- a/.mock/definition/ticketing/asyncPassthrough.yml +++ b/.mock/definition/ticketing/asyncPassthrough.yml @@ -55,7 +55,11 @@ service: path: /scooters status: 200 response: - key: value + scooters: + - company: Lime + model: Gen 2.5 + - company: Bird + model: Bird Zero response_headers: X-Page-Token: value response_type: JSON diff --git a/.mock/definition/ticketing/attachments.yml b/.mock/definition/ticketing/attachments.yml index d47438be..ab4b3748 100644 --- a/.mock/definition/ticketing/attachments.yml +++ b/.mock/definition/ticketing/attachments.yml @@ -117,6 +117,8 @@ service: custom_key: custom_value remote_data: - path: /platform-endpoint + data: + - Varies by platform create: path: /ticketing/v1/attachments method: POST @@ -173,6 +175,8 @@ service: custom_key: custom_value remote_data: - path: /platform-endpoint + data: + - Varies by platform warnings: - source: pointer: pointer @@ -255,7 +259,7 @@ service: remote_data: - path: /platform-endpoint data: - key: value + - Varies by platform downloadRetrieve: path: /ticketing/v1/attachments/{id}/download method: GET diff --git a/.mock/definition/ticketing/collections.yml b/.mock/definition/ticketing/collections.yml index a7cace56..7ba0ce3d 100644 --- a/.mock/definition/ticketing/collections.yml +++ b/.mock/definition/ticketing/collections.yml @@ -152,6 +152,8 @@ service: custom_key: custom_value remote_data: - path: /platform-endpoint + data: + - Varies by platform viewersList: path: /ticketing/v1/collections/{collection_id}/viewers method: GET @@ -301,6 +303,6 @@ service: remote_data: - path: /platform-endpoint data: - key: value + - Varies by platform source: openapi: openapi/openapi.yml diff --git a/.mock/definition/ticketing/comments.yml b/.mock/definition/ticketing/comments.yml index 8b75794a..6b0aa6a3 100644 --- a/.mock/definition/ticketing/comments.yml +++ b/.mock/definition/ticketing/comments.yml @@ -153,6 +153,8 @@ service: custom_key: custom_value remote_data: - path: /platform-endpoint + data: + - Varies by platform create: path: /ticketing/v1/comments method: POST @@ -214,6 +216,8 @@ service: custom_key: custom_value remote_data: - path: /platform-endpoint + data: + - Varies by platform warnings: - source: pointer: pointer @@ -299,7 +303,7 @@ service: remote_data: - path: /platform-endpoint data: - key: value + - Varies by platform metaPostRetrieve: path: /ticketing/v1/comments/meta/post method: GET diff --git a/.mock/definition/ticketing/contacts.yml b/.mock/definition/ticketing/contacts.yml index 9126e2c4..4bfc2a18 100644 --- a/.mock/definition/ticketing/contacts.yml +++ b/.mock/definition/ticketing/contacts.yml @@ -110,6 +110,8 @@ service: custom_key: custom_value remote_data: - path: /platform-endpoint + data: + - Varies by platform create: path: /ticketing/v1/contacts method: POST @@ -165,6 +167,8 @@ service: custom_key: custom_value remote_data: - path: /platform-endpoint + data: + - Varies by platform warnings: - source: pointer: pointer @@ -246,7 +250,7 @@ service: remote_data: - path: /platform-endpoint data: - key: value + - Varies by platform metaPostRetrieve: path: /ticketing/v1/contacts/meta/post method: GET diff --git a/.mock/definition/ticketing/passthrough.yml b/.mock/definition/ticketing/passthrough.yml index 6d5310be..8c5d351f 100644 --- a/.mock/definition/ticketing/passthrough.yml +++ b/.mock/definition/ticketing/passthrough.yml @@ -31,7 +31,11 @@ service: path: /scooters status: 200 response: - key: value + scooters: + - company: Lime + model: Gen 2.5 + - company: Bird + model: Bird Zero response_headers: X-Page-Token: value response_type: JSON diff --git a/.mock/definition/ticketing/projects.yml b/.mock/definition/ticketing/projects.yml index 2901dc63..51f7855f 100644 --- a/.mock/definition/ticketing/projects.yml +++ b/.mock/definition/ticketing/projects.yml @@ -97,6 +97,8 @@ service: custom_key: custom_value remote_data: - path: /platform-endpoint + data: + - Varies by platform retrieve: path: /ticketing/v1/projects/{id} method: GET @@ -149,7 +151,7 @@ service: remote_data: - path: /platform-endpoint data: - key: value + - Varies by platform usersList: path: /ticketing/v1/projects/{parent_id}/users method: GET @@ -234,6 +236,8 @@ service: custom_key: custom_value remote_data: - path: /platform-endpoint + data: + - Varies by platform source: openapi: openapi/openapi.yml types: diff --git a/.mock/definition/ticketing/roles.yml b/.mock/definition/ticketing/roles.yml index d61264ba..618d3ecf 100644 --- a/.mock/definition/ticketing/roles.yml +++ b/.mock/definition/ticketing/roles.yml @@ -101,6 +101,8 @@ service: custom_key: custom_value remote_data: - path: /platform-endpoint + data: + - Varies by platform retrieve: path: /ticketing/v1/roles/{id} method: GET @@ -157,6 +159,6 @@ service: remote_data: - path: /platform-endpoint data: - key: value + - Varies by platform source: openapi: openapi/openapi.yml diff --git a/.mock/definition/ticketing/tags.yml b/.mock/definition/ticketing/tags.yml index 3c9c92f8..9d7c96b7 100644 --- a/.mock/definition/ticketing/tags.yml +++ b/.mock/definition/ticketing/tags.yml @@ -96,6 +96,8 @@ service: custom_key: custom_value remote_data: - path: /platform-endpoint + data: + - Varies by platform retrieve: path: /ticketing/v1/tags/{id} method: GET @@ -147,6 +149,6 @@ service: remote_data: - path: /platform-endpoint data: - key: value + - Varies by platform source: openapi: openapi/openapi.yml diff --git a/.mock/definition/ticketing/teams.yml b/.mock/definition/ticketing/teams.yml index 8e9406f8..3c5962cd 100644 --- a/.mock/definition/ticketing/teams.yml +++ b/.mock/definition/ticketing/teams.yml @@ -97,6 +97,8 @@ service: custom_key: custom_value remote_data: - path: /platform-endpoint + data: + - Varies by platform retrieve: path: /ticketing/v1/teams/{id} method: GET @@ -149,6 +151,6 @@ service: remote_data: - path: /platform-endpoint data: - key: value + - Varies by platform source: openapi: openapi/openapi.yml diff --git a/.mock/definition/ticketing/tickets.yml b/.mock/definition/ticketing/tickets.yml index 5a192233..36676bf2 100644 --- a/.mock/definition/ticketing/tickets.yml +++ b/.mock/definition/ticketing/tickets.yml @@ -1385,8 +1385,11 @@ service: custom_key: custom_value remote_data: - path: /platform-endpoint + data: + - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string create: path: /ticketing/v1/tickets method: POST @@ -1469,8 +1472,11 @@ service: custom_key: custom_value remote_data: - path: /platform-endpoint + data: + - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string warnings: - source: pointer: pointer @@ -1597,11 +1603,10 @@ service: remote_data: - path: /platform-endpoint data: - key: value + - Varies by platform remote_fields: - remote_field_class: remote_field_class - value: - key: value + value: string partialUpdate: path: /ticketing/v1/tickets/{id} method: PATCH @@ -1688,8 +1693,11 @@ service: custom_key: custom_value remote_data: - path: /platform-endpoint + data: + - Varies by platform remote_fields: - remote_field_class: remote_field_class + value: string warnings: - source: pointer: pointer diff --git a/.mock/definition/ticketing/users.yml b/.mock/definition/ticketing/users.yml index 20577eb4..41965674 100644 --- a/.mock/definition/ticketing/users.yml +++ b/.mock/definition/ticketing/users.yml @@ -137,6 +137,8 @@ service: custom_key: custom_value remote_data: - path: /platform-endpoint + data: + - Varies by platform retrieve: path: /ticketing/v1/users/{id} method: GET @@ -202,6 +204,6 @@ service: remote_data: - path: /platform-endpoint data: - key: value + - Varies by platform source: openapi: openapi/openapi.yml diff --git a/.mock/fern.config.json b/.mock/fern.config.json index 9aef8fce..452f7613 100644 --- a/.mock/fern.config.json +++ b/.mock/fern.config.json @@ -1,4 +1,4 @@ { "organization" : "merge", - "version" : "0.83.0" + "version" : "0.112.1" } \ No newline at end of file diff --git a/README.md b/README.md index 74e4002c..3fee8310 100644 --- a/README.md +++ b/README.md @@ -260,3 +260,4 @@ while response.next is not None: + diff --git a/poetry.lock b/poetry.lock index 794340bd..a19d7e2f 100644 --- a/poetry.lock +++ b/poetry.lock @@ -60,13 +60,13 @@ files = [ [[package]] name = "exceptiongroup" -version = "1.3.0" +version = "1.3.1" description = "Backport of PEP 654 (exception groups)" optional = false python-versions = ">=3.7" files = [ - {file = "exceptiongroup-1.3.0-py3-none-any.whl", hash = "sha256:4d111e6e0c13d0644cad6ddaa7ed0261a0b36971f6d23e7ec9b4b9097da78a10"}, - {file = "exceptiongroup-1.3.0.tar.gz", hash = "sha256:b241f5885f560bc56a59ee63ca4c6a8bfa46ae4ad651af316d4e81817bb9fd88"}, + {file = "exceptiongroup-1.3.1-py3-none-any.whl", hash = "sha256:a7a39a3bd276781e98394987d3a5701d0c4edffb633bb7a5144577f82c773598"}, + {file = "exceptiongroup-1.3.1.tar.gz", hash = "sha256:8b412432c6055b0b7d14c310000ae93352ed6754f70fa8f7c34141f91c4e3219"}, ] [package.dependencies] diff --git a/pyproject.toml b/pyproject.toml index 147dd02e..6e9177d0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ name = "MergePythonClient" [tool.poetry] name = "MergePythonClient" -version = "2.6.0" +version = "2.6.1" description = "" readme = "README.md" authors = [] diff --git a/reference.md b/reference.md index 548074e8..72c3f6b5 100644 --- a/reference.md +++ b/reference.md @@ -10263,6 +10263,14 @@ client.chat.groups.list(
+**expand:** `typing.Optional[typing.Literal["users"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ **include_deleted_data:** `typing.Optional[bool]` — 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/).
@@ -10392,6 +10400,14 @@ client.chat.groups.retrieve(
+**expand:** `typing.Optional[typing.Literal["users"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ **include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -10709,7 +10725,7 @@ client.chat.issues.retrieve(
-Creates a link token to be used when linking a new end user. +Creates a link token to be used when linking a new end user. The link token expires after single use.
@@ -11125,6 +11141,7 @@ client = Merge( api_key="YOUR_API_KEY", ) client.chat.messages.list( + conversation_id="conversation_id", created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -11161,6 +11178,14 @@ client.chat.messages.list(
+**conversation_id:** `typing.Optional[str]` — Filter messages by conversation ID. + +
+
+ +
+
+ **created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -27155,8 +27180,8 @@ client.filestorage.webhook_receivers.create(
-## Knowledgebase AccountDetails -
client.knowledgebase.account_details.retrieve() +## Hris AccountDetails +
client.hris.account_details.retrieve()
@@ -27189,7 +27214,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.account_details.retrieve() +client.hris.account_details.retrieve() ```
@@ -27217,8 +27242,8 @@ client.knowledgebase.account_details.retrieve()
-## Knowledgebase AccountToken -
client.knowledgebase.account_token.retrieve(...) +## Hris AccountToken +
client.hris.account_token.retrieve(...)
@@ -27251,7 +27276,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.account_token.retrieve( +client.hris.account_token.retrieve( public_token="public_token", ) @@ -27289,8 +27314,8 @@ client.knowledgebase.account_token.retrieve(
-## Knowledgebase Articles -
client.knowledgebase.articles.list(...) +## Hris AsyncPassthrough +
client.hris.async_passthrough.create(...)
@@ -27302,7 +27327,7 @@ client.knowledgebase.account_token.retrieve(
-Returns a list of `Article` objects. +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -27317,43 +27342,18 @@ Returns a list of `Article` objects.
```python -import datetime - from merge import Merge -from merge.resources.knowledgebase.resources.articles import ( - ArticlesListRequestExpand, - ArticlesListRequestType, -) +from merge.resources.hris import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.articles.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - expand=ArticlesListRequestExpand.ATTACHMENTS, - include_deleted_data=True, - include_remote_data=True, - include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", +client.hris.async_passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", ), - page_size=1, - parent_article_id="parent_article_id", - parent_container_id="parent_container_id", - remote_id="remote_id", - root_container_id="root_container_id", - status="status", - type=ArticlesListRequestType.EMPTY, ) ``` @@ -27370,7 +27370,7 @@ client.knowledgebase.articles.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**request:** `DataPassthroughRequest`
@@ -27378,119 +27378,70 @@ client.knowledgebase.articles.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**cursor:** `typing.Optional[str]` — The pagination cursor value. -
-
-
-**expand:** `typing.Optional[ArticlesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. -
+
+
client.hris.async_passthrough.retrieve(...)
-**include_deleted_data:** `typing.Optional[bool]` — 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/). - -
-
+#### 📝 Description
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - +Retrieves data from earlier async-passthrough POST request
- -
-
- -**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. -
-
-
- -**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - -
-
+#### 🔌 Usage
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. - -
-
-
-**parent_article_id:** `typing.Optional[str]` — If provided, will only return sub articles of the parent_article_id. - -
-
+```python +from merge import Merge -
-
+client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.async_passthrough.retrieve( + async_passthrough_receipt_id="async_passthrough_receipt_id", +) -**parent_container_id:** `typing.Optional[str]` — If provided, will only return sub articles of the parent_container_id. - +```
- -
-
- -**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. -
-
-
- -**root_container_id:** `typing.Optional[str]` — If provided, will only return sub articles of the root_container_id. - -
-
+#### ⚙️ Parameters
-**status:** `typing.Optional[str]` — If provided, will only return articles of the given status; multiple statuses can be separated by commas. - -
-
-
-**type:** `typing.Optional[ArticlesListRequestType]` — If provided, will only return articles of the given type. +**async_passthrough_receipt_id:** `str`
@@ -27510,7 +27461,8 @@ client.knowledgebase.articles.list(
-
client.knowledgebase.articles.retrieve(...) +## Hris AuditTrail +
client.hris.audit_trail.list(...)
@@ -27522,7 +27474,7 @@ client.knowledgebase.articles.list(
-Returns an `Article` object with the given `id`. +Gets a list of audit trail events.
@@ -27538,19 +27490,18 @@ Returns an `Article` object with the given `id`. ```python from merge import Merge -from merge.resources.knowledgebase.resources.articles import ( - ArticlesRetrieveRequestExpand, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.articles.retrieve( - id="id", - expand=ArticlesRetrieveRequestExpand.ATTACHMENTS, - include_remote_data=True, - include_shell_data=True, +client.hris.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + end_date="end_date", + event_type="event_type", + page_size=1, + start_date="start_date", + user_email="user_email", ) ``` @@ -27567,7 +27518,7 @@ client.knowledgebase.articles.retrieve(
-**id:** `str` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -27575,7 +27526,7 @@ client.knowledgebase.articles.retrieve(
-**expand:** `typing.Optional[ArticlesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
@@ -27583,7 +27534,7 @@ client.knowledgebase.articles.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**event_type:** `typing.Optional[str]` — If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`
@@ -27591,7 +27542,23 @@ client.knowledgebase.articles.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+ +
+
+ +**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time + +
+
+ +
+
+ +**user_email:** `typing.Optional[str]` — If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email.
@@ -27611,8 +27578,8 @@ client.knowledgebase.articles.retrieve(
-## Knowledgebase AsyncPassthrough -
client.knowledgebase.async_passthrough.create(...) +## Hris AvailableActions +
client.hris.available_actions.retrieve()
@@ -27624,7 +27591,7 @@ client.knowledgebase.articles.retrieve(
-Asynchronously pull data from an endpoint not currently supported by Merge. +Returns a list of models and actions available for an account.
@@ -27640,18 +27607,12 @@ Asynchronously pull data from an endpoint not currently supported by Merge. ```python from merge import Merge -from merge.resources.knowledgebase import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.async_passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), -) +client.hris.available_actions.retrieve() ``` @@ -27667,14 +27628,6 @@ client.knowledgebase.async_passthrough.create(
-**request:** `DataPassthroughRequest` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -27687,7 +27640,8 @@ client.knowledgebase.async_passthrough.create(
-
client.knowledgebase.async_passthrough.retrieve(...) +## Hris BankInfo +
client.hris.bank_info.list(...)
@@ -27699,7 +27653,7 @@ client.knowledgebase.async_passthrough.create(
-Retrieves data from earlier async-passthrough POST request +Returns a list of `BankInfo` objects.
@@ -27714,87 +27668,21 @@ Retrieves data from earlier async-passthrough POST request
```python +import datetime + from merge import Merge +from merge.resources.hris.resources.bank_info import ( + BankInfoListRequestAccountType, + BankInfoListRequestOrderBy, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.async_passthrough.retrieve( - async_passthrough_receipt_id="async_passthrough_receipt_id", -) - -``` -
-
- -
- -#### ⚙️ Parameters - -
-
- -
-
- -**async_passthrough_receipt_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - - - - - -## Knowledgebase Attachments -
client.knowledgebase.attachments.list(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Returns a list of `Attachment` objects. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -import datetime - -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.knowledgebase.attachments.list( +client.hris.bank_info.list( + account_type=BankInfoListRequestAccountType.CHECKING, + bank_name="bank_name", created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -27802,6 +27690,7 @@ client.knowledgebase.attachments.list( "2024-01-15 09:30:00+00:00", ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + employee_id="employee_id", include_deleted_data=True, include_remote_data=True, include_shell_data=True, @@ -27811,6 +27700,7 @@ client.knowledgebase.attachments.list( modified_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), + order_by=BankInfoListRequestOrderBy.REMOTE_CREATED_AT_DESCENDING, page_size=1, remote_id="remote_id", ) @@ -27829,6 +27719,27 @@ client.knowledgebase.attachments.list(
+**account_type:** `typing.Optional[BankInfoListRequestAccountType]` + +If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING') + +* `SAVINGS` - SAVINGS +* `CHECKING` - CHECKING + +
+
+ +
+
+ +**bank_name:** `typing.Optional[str]` — If provided, will only return BankInfo's with this bank name. + +
+
+ +
+
+ **created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -27853,6 +27764,22 @@ client.knowledgebase.attachments.list(
+**employee_id:** `typing.Optional[str]` — If provided, will only return bank accounts for this employee. + +
+
+ +
+
+ +**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ **include_deleted_data:** `typing.Optional[bool]` — 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/).
@@ -27893,6 +27820,14 @@ client.knowledgebase.attachments.list(
+**order_by:** `typing.Optional[BankInfoListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: remote_created_at, -remote_created_at. + +
+
+ +
+
+ **page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
@@ -27901,6 +27836,14 @@ client.knowledgebase.attachments.list(
+**remote_fields:** `typing.Optional[typing.Literal["account_type"]]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ **remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -27909,6 +27852,14 @@ client.knowledgebase.attachments.list(
+**show_enum_origins:** `typing.Optional[typing.Literal["account_type"]]` — 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) + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -27921,7 +27872,7 @@ client.knowledgebase.attachments.list(
-
client.knowledgebase.attachments.retrieve(...) +
client.hris.bank_info.retrieve(...)
@@ -27933,7 +27884,7 @@ client.knowledgebase.attachments.list(
-Returns an `Attachment` object with the given `id`. +Returns a `BankInfo` object with the given `id`.
@@ -27954,7 +27905,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.attachments.retrieve( +client.hris.bank_info.retrieve( id="id", include_remote_data=True, include_shell_data=True, @@ -27982,6 +27933,14 @@ client.knowledgebase.attachments.retrieve(
+**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ **include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -27998,6 +27957,22 @@ client.knowledgebase.attachments.retrieve(
+**remote_fields:** `typing.Optional[typing.Literal["account_type"]]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[typing.Literal["account_type"]]` — 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) + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -28010,8 +27985,8 @@ client.knowledgebase.attachments.retrieve(
-## Knowledgebase AuditTrail -
client.knowledgebase.audit_trail.list(...) +## Hris Benefits +
client.hris.benefits.list(...)
@@ -28023,7 +27998,7 @@ client.knowledgebase.attachments.retrieve(
-Gets a list of audit trail events. +Returns a list of `Benefit` objects.
@@ -28038,19 +28013,34 @@ Gets a list of audit trail events.
```python +import datetime + from merge import Merge client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.audit_trail.list( +client.hris.benefits.list( + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - end_date="end_date", - event_type="event_type", + employee_id="employee_id", + include_deleted_data=True, + include_remote_data=True, + include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), page_size=1, - start_date="start_date", - user_email="user_email", + remote_id="remote_id", ) ``` @@ -28067,7 +28057,7 @@ client.knowledgebase.audit_trail.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -28075,7 +28065,7 @@ client.knowledgebase.audit_trail.list(
-**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -28083,7 +28073,7 @@ client.knowledgebase.audit_trail.list(
-**event_type:** `typing.Optional[str]` — If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -28091,7 +28081,7 @@ client.knowledgebase.audit_trail.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**employee_id:** `typing.Optional[str]` — If provided, will return the benefits associated with the employee.
@@ -28099,7 +28089,7 @@ client.knowledgebase.audit_trail.list(
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time +**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -28107,7 +28097,7 @@ client.knowledgebase.audit_trail.list(
-**user_email:** `typing.Optional[str]` — If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email. +**include_deleted_data:** `typing.Optional[bool]` — 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/).
@@ -28115,65 +28105,51 @@ client.knowledgebase.audit_trail.list(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
+
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +
-
-## Knowledgebase AvailableActions -
client.knowledgebase.available_actions.retrieve()
-#### 📝 Description - -
-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
-Returns a list of models and actions available for an account. -
-
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.knowledgebase.available_actions.retrieve() - -``` -
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +
-#### ⚙️ Parameters -
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+
@@ -28189,8 +28165,7 @@ client.knowledgebase.available_actions.retrieve()
-## Knowledgebase Containers -
client.knowledgebase.containers.list(...) +
client.hris.benefits.retrieve(...)
@@ -28202,7 +28177,7 @@ client.knowledgebase.available_actions.retrieve()
-Returns a list of `Container` objects. +Returns a `Benefit` object with the given `id`.
@@ -28217,41 +28192,16 @@ Returns a list of `Container` objects.
```python -import datetime - from merge import Merge -from merge.resources.knowledgebase.resources.containers import ( - ContainersListRequestExpand, - ContainersListRequestType, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.containers.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - expand=ContainersListRequestExpand.PARENT_ARTICLE, - include_deleted_data=True, +client.hris.benefits.retrieve( + id="id", include_remote_data=True, include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - page_size=1, - parent_article_id="parent_article_id", - parent_container_id="parent_container_id", - remote_id="remote_id", - type=ContainersListRequestType.EMPTY, ) ``` @@ -28268,7 +28218,7 @@ client.knowledgebase.containers.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**id:** `str`
@@ -28276,7 +28226,7 @@ client.knowledgebase.containers.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -28284,7 +28234,7 @@ client.knowledgebase.containers.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -28292,7 +28242,7 @@ client.knowledgebase.containers.list(
-**expand:** `typing.Optional[ContainersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -28300,15 +28250,90 @@ client.knowledgebase.containers.list(
-**include_deleted_data:** `typing.Optional[bool]` — 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/). +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+ + + + +
+## Hris Companies +
client.hris.companies.list(...)
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +#### 📝 Description + +
+
+ +
+
+ +Returns a list of `Company` objects. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +import datetime + +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.companies.list( + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + include_deleted_data=True, + include_remote_data=True, + include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + page_size=1, + remote_id="remote_id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -28316,7 +28341,7 @@ client.knowledgebase.containers.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -28324,7 +28349,7 @@ client.knowledgebase.containers.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -28332,7 +28357,7 @@ client.knowledgebase.containers.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**include_deleted_data:** `typing.Optional[bool]` — 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/).
@@ -28340,7 +28365,7 @@ client.knowledgebase.containers.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -28348,7 +28373,7 @@ client.knowledgebase.containers.list(
-**parent_article_id:** `typing.Optional[str]` — If provided, will only return sub containers of the parent_article_id. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -28356,7 +28381,7 @@ client.knowledgebase.containers.list(
-**parent_container_id:** `typing.Optional[str]` — If provided, will only return sub containers of the parent_container_id. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -28364,7 +28389,7 @@ client.knowledgebase.containers.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -28372,7 +28397,15 @@ client.knowledgebase.containers.list(
-**type:** `typing.Optional[ContainersListRequestType]` — If provided, will only return containers of the given type. +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. + +
+
+ +
+
+ +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -28392,7 +28425,7 @@ client.knowledgebase.containers.list(
-
client.knowledgebase.containers.retrieve(...) +
client.hris.companies.retrieve(...)
@@ -28404,7 +28437,7 @@ client.knowledgebase.containers.list(
-Returns a `Container` object with the given `id`. +Returns a `Company` object with the given `id`.
@@ -28420,17 +28453,13 @@ Returns a `Container` object with the given `id`. ```python from merge import Merge -from merge.resources.knowledgebase.resources.containers import ( - ContainersRetrieveRequestExpand, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.containers.retrieve( +client.hris.companies.retrieve( id="id", - expand=ContainersRetrieveRequestExpand.PARENT_ARTICLE, include_remote_data=True, include_shell_data=True, ) @@ -28457,14 +28486,6 @@ client.knowledgebase.containers.retrieve(
-**expand:** `typing.Optional[ContainersRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- **include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -28493,8 +28514,8 @@ client.knowledgebase.containers.retrieve(
-## Knowledgebase Scopes -
client.knowledgebase.scopes.default_scopes_retrieve() +## Hris Scopes +
client.hris.scopes.default_scopes_retrieve()
@@ -28527,7 +28548,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.scopes.default_scopes_retrieve() +client.hris.scopes.default_scopes_retrieve() ```
@@ -28555,7 +28576,7 @@ client.knowledgebase.scopes.default_scopes_retrieve()
-
client.knowledgebase.scopes.linked_account_scopes_retrieve() +
client.hris.scopes.linked_account_scopes_retrieve()
@@ -28588,7 +28609,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.scopes.linked_account_scopes_retrieve() +client.hris.scopes.linked_account_scopes_retrieve() ```
@@ -28616,7 +28637,7 @@ client.knowledgebase.scopes.linked_account_scopes_retrieve()
-
client.knowledgebase.scopes.linked_account_scopes_create(...) +
client.hris.scopes.linked_account_scopes_create(...)
@@ -28644,7 +28665,7 @@ Update permissions for any Common Model or field for a single Linked Account. An ```python from merge import Merge -from merge.resources.knowledgebase import ( +from merge.resources.hris import ( FieldPermissionDeserializerRequest, IndividualCommonModelScopeDeserializerRequest, ModelPermissionDeserializerRequest, @@ -28654,7 +28675,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.scopes.linked_account_scopes_create( +client.hris.scopes.linked_account_scopes_create( common_models=[ IndividualCommonModelScopeDeserializerRequest( model_name="Employee", @@ -28716,8 +28737,8 @@ client.knowledgebase.scopes.linked_account_scopes_create(
-## Knowledgebase DeleteAccount -
client.knowledgebase.delete_account.delete() +## Hris DeleteAccount +
client.hris.delete_account.delete()
@@ -28750,7 +28771,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.delete_account.delete() +client.hris.delete_account.delete() ```
@@ -28778,8 +28799,8 @@ client.knowledgebase.delete_account.delete()
-## Knowledgebase FieldMapping -
client.knowledgebase.field_mapping.field_mappings_retrieve(...) +## Hris Dependents +
client.hris.dependents.list(...)
@@ -28791,7 +28812,7 @@ client.knowledgebase.delete_account.delete()
-Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/). +Returns a list of `Dependent` objects.
@@ -28806,14 +28827,35 @@ Get all Field Mappings for this Linked Account. Field Mappings are mappings betw
```python +import datetime + from merge import Merge client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.field_mapping.field_mappings_retrieve( - exclude_remote_field_metadata=True, +client.hris.dependents.list( + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + employee_id="employee_id", + include_deleted_data=True, + include_remote_data=True, + include_sensitive_fields=True, + include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + page_size=1, + remote_id="remote_id", ) ``` @@ -28830,7 +28872,7 @@ client.knowledgebase.field_mapping.field_mappings_retrieve(
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -28838,76 +28880,87 @@ client.knowledgebase.field_mapping.field_mappings_retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+ +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor value. +
+
+
+**employee_id:** `typing.Optional[str]` — If provided, will only return dependents for this employee. +
-
-
client.knowledgebase.field_mapping.field_mappings_create(...)
-#### 📝 Description +**include_deleted_data:** `typing.Optional[bool]` — 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:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+
-Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start. +**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response. +
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +
-#### 🔌 Usage -
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
+
-```python -from merge import Merge +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.knowledgebase.field_mapping.field_mappings_create( - exclude_remote_field_metadata=True, - target_field_name="example_target_field_name", - target_field_description="this is a example description of the target field", - remote_field_traversal_path=["example_remote_field"], - remote_method="GET", - remote_url_path="/example-url-path", - common_model_name="ExampleCommonModel", -) +
+
-``` -
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. + -#### ⚙️ Parameters - -
-
-
-**target_field_name:** `str` — The name of the target field you want this remote field to map to. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -28915,31 +28968,73 @@ client.knowledgebase.field_mapping.field_mappings_create(
-**target_field_description:** `str` — The description of the target field you want this remote field to map to. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+ + + + +
+
client.hris.dependents.retrieve(...)
-**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. - +#### 📝 Description + +
+
+ +
+
+ +Returns a `Dependent` object with the given `id`.
+
+
+ +#### 🔌 Usage
-**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.dependents.retrieve( + id="id", + include_remote_data=True, + include_sensitive_fields=True, + include_shell_data=True, +) + +```
+
+
+ +#### ⚙️ Parameters
-**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from. +
+
+ +**id:** `str`
@@ -28947,7 +29042,7 @@ client.knowledgebase.field_mapping.field_mappings_create(
-**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -28955,7 +29050,7 @@ client.knowledgebase.field_mapping.field_mappings_create(
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. +**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response.
@@ -28963,7 +29058,7 @@ client.knowledgebase.field_mapping.field_mappings_create(
-**jmes_path:** `typing.Optional[str]` — JMES path to specify json query expression to be used on field mapping. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -28983,7 +29078,8 @@ client.knowledgebase.field_mapping.field_mappings_create(
-
client.knowledgebase.field_mapping.field_mappings_destroy(...) +## Hris EmployeePayrollRuns +
client.hris.employee_payroll_runs.list(...)
@@ -28995,7 +29091,7 @@ client.knowledgebase.field_mapping.field_mappings_create(
-Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start. +Returns a list of `EmployeePayrollRun` objects.
@@ -29010,14 +29106,51 @@ Deletes Field Mappings for a Linked Account. All data related to this Field Mapp
```python +import datetime + from merge import Merge +from merge.resources.hris.resources.employee_payroll_runs import ( + EmployeePayrollRunsListRequestExpand, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.field_mapping.field_mappings_destroy( - field_mapping_id="field_mapping_id", +client.hris.employee_payroll_runs.list( + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + employee_id="employee_id", + ended_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + ended_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + expand=EmployeePayrollRunsListRequestExpand.EMPLOYEE, + include_deleted_data=True, + include_remote_data=True, + include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + page_size=1, + payroll_run_id="payroll_run_id", + remote_id="remote_id", + started_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + started_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), ) ``` @@ -29034,7 +29167,7 @@ client.knowledgebase.field_mapping.field_mappings_destroy(
-**field_mapping_id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -29042,70 +29175,95 @@ client.knowledgebase.field_mapping.field_mappings_destroy(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
-
+
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value. +
-
-
client.knowledgebase.field_mapping.field_mappings_partial_update(...)
-#### 📝 Description +**employee_id:** `typing.Optional[str]` — If provided, will only return employee payroll runs for this employee. + +
+
+**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs ended after this datetime. + +
+
+
-Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start. +**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs ended before this datetime. +
+ +
+
+ +**expand:** `typing.Optional[EmployeePayrollRunsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-#### 🔌 Usage -
+**include_deleted_data:** `typing.Optional[bool]` — 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/). + +
+
+
-```python -from merge import Merge +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.knowledgebase.field_mapping.field_mappings_partial_update( - field_mapping_id="field_mapping_id", -) +
+
-``` +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +
+ +
+
+ +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +
-#### ⚙️ Parameters -
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + +
+
+
-**field_mapping_id:** `str` +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
@@ -29113,7 +29271,7 @@ client.knowledgebase.field_mapping.field_mappings_partial_update(
-**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. +**payroll_run_id:** `typing.Optional[str]` — If provided, will only return employee payroll runs for this employee.
@@ -29121,7 +29279,7 @@ client.knowledgebase.field_mapping.field_mappings_partial_update(
-**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -29129,7 +29287,7 @@ client.knowledgebase.field_mapping.field_mappings_partial_update(
-**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from. +**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs started after this datetime.
@@ -29137,7 +29295,7 @@ client.knowledgebase.field_mapping.field_mappings_partial_update(
-**jmes_path:** `typing.Optional[str]` — JMES path to specify json query expression to be used on field mapping. +**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs started before this datetime.
@@ -29157,7 +29315,7 @@ client.knowledgebase.field_mapping.field_mappings_partial_update(
-
client.knowledgebase.field_mapping.remote_fields_retrieve(...) +
client.hris.employee_payroll_runs.retrieve(...)
@@ -29169,7 +29327,7 @@ client.knowledgebase.field_mapping.field_mappings_partial_update(
-Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/). +Returns an `EmployeePayrollRun` object with the given `id`.
@@ -29185,14 +29343,19 @@ Get all remote fields for a Linked Account. Remote fields are third-party fields ```python from merge import Merge +from merge.resources.hris.resources.employee_payroll_runs import ( + EmployeePayrollRunsRetrieveRequestExpand, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.field_mapping.remote_fields_retrieve( - common_models="common_models", - include_example_values="include_example_values", +client.hris.employee_payroll_runs.retrieve( + id="id", + expand=EmployeePayrollRunsRetrieveRequestExpand.EMPLOYEE, + include_remote_data=True, + include_shell_data=True, ) ``` @@ -29209,7 +29372,7 @@ client.knowledgebase.field_mapping.remote_fields_retrieve(
-**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models. +**id:** `str`
@@ -29217,7 +29380,23 @@ client.knowledgebase.field_mapping.remote_fields_retrieve(
-**include_example_values:** `typing.Optional[str]` — If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers. +**expand:** `typing.Optional[EmployeePayrollRunsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -29237,7 +29416,8 @@ client.knowledgebase.field_mapping.remote_fields_retrieve(
-
client.knowledgebase.field_mapping.target_fields_retrieve() +## Hris Employees +
client.hris.employees.list(...)
@@ -29249,7 +29429,7 @@ client.knowledgebase.field_mapping.remote_fields_retrieve(
-Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/). +Returns a list of `Employee` objects.
@@ -29264,152 +29444,22 @@ Get all organization-wide Target Fields, this will not include any Linked Accoun
```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.knowledgebase.field_mapping.target_fields_retrieve() - -``` -
-
- - - -#### ⚙️ Parameters - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - - - -
- -## Knowledgebase GenerateKey -
client.knowledgebase.generate_key.create(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Create a remote key. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.knowledgebase.generate_key.create( - name="Remote Deployment Key 1", -) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**name:** `str` — The name of the remote key - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Knowledgebase Groups -
client.knowledgebase.groups.list(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Returns a list of `Group` objects. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -import datetime +import datetime from merge import Merge -from merge.resources.knowledgebase.resources.groups import ( - GroupsListRequestExpand, +from merge.resources.hris.resources.employees import ( + EmployeesListRequestEmploymentStatus, + EmployeesListRequestExpand, + EmployeesListRequestRemoteFields, + EmployeesListRequestShowEnumOrigins, ) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.groups.list( +client.hris.employees.list( + company_id="company_id", created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -29417,10 +29467,21 @@ client.knowledgebase.groups.list( "2024-01-15 09:30:00+00:00", ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - expand=GroupsListRequestExpand.PARENT_GROUP, + display_full_name="display_full_name", + employee_number="employee_number", + employment_status=EmployeesListRequestEmploymentStatus.ACTIVE, + employment_type="employment_type", + expand=EmployeesListRequestExpand.COMPANY, + first_name="first_name", + groups="groups", + home_location_id="home_location_id", include_deleted_data=True, include_remote_data=True, + include_sensitive_fields=True, include_shell_data=True, + job_title="job_title", + last_name="last_name", + manager_id="manager_id", modified_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -29428,7 +29489,26 @@ client.knowledgebase.groups.list( "2024-01-15 09:30:00+00:00", ), page_size=1, + pay_group_id="pay_group_id", + personal_email="personal_email", + remote_fields=EmployeesListRequestRemoteFields.EMPLOYMENT_STATUS, remote_id="remote_id", + show_enum_origins=EmployeesListRequestShowEnumOrigins.EMPLOYMENT_STATUS, + started_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + started_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + team_id="team_id", + terminated_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + terminated_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + work_email="work_email", + work_location_id="work_location_id", ) ``` @@ -29445,7 +29525,7 @@ client.knowledgebase.groups.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**company_id:** `typing.Optional[str]` — If provided, will only return employees for this company.
@@ -29453,7 +29533,7 @@ client.knowledgebase.groups.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -29461,7 +29541,7 @@ client.knowledgebase.groups.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -29469,7 +29549,7 @@ client.knowledgebase.groups.list(
-**expand:** `typing.Optional[GroupsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -29477,7 +29557,7 @@ client.knowledgebase.groups.list(
-**include_deleted_data:** `typing.Optional[bool]` — 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/). +**display_full_name:** `typing.Optional[str]` — If provided, will only return employees with this display name.
@@ -29485,7 +29565,7 @@ client.knowledgebase.groups.list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**employee_number:** `typing.Optional[str]` — If provided, will only return employees with this employee number.
@@ -29493,15 +29573,13 @@ client.knowledgebase.groups.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
+**employment_status:** `typing.Optional[EmployeesListRequestEmploymentStatus]` -
-
+If provided, will only return employees with this employment status. -**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +* `ACTIVE` - ACTIVE +* `PENDING` - PENDING +* `INACTIVE` - INACTIVE
@@ -29509,7 +29587,7 @@ client.knowledgebase.groups.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**employment_type:** `typing.Optional[str]` — If provided, will only return employees that have an employment of the specified employment type.
@@ -29517,7 +29595,7 @@ client.knowledgebase.groups.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +**expand:** `typing.Optional[EmployeesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -29525,7 +29603,7 @@ client.knowledgebase.groups.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**first_name:** `typing.Optional[str]` — If provided, will only return employees with this first name.
@@ -29533,76 +29611,31 @@ client.knowledgebase.groups.list(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**groups:** `typing.Optional[str]` — If provided, will only return employees matching the group ids; multiple groups can be separated by commas.
-
-
- - -
-
-
- -
client.knowledgebase.groups.retrieve(...) -
-
- -#### 📝 Description
-
-
- -Returns a `Group` object with the given `id`. -
-
+**home_location_id:** `typing.Optional[str]` — If provided, will only return employees for this home location. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge -from merge.resources.knowledgebase.resources.groups import ( - GroupsRetrieveRequestExpand, -) - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.knowledgebase.groups.retrieve( - id="id", - expand=GroupsRetrieveRequestExpand.PARENT_GROUP, - include_remote_data=True, - include_shell_data=True, -) - -``` -
-
+**include_deleted_data:** `typing.Optional[bool]` — 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/). +
-#### ⚙️ Parameters -
-
-
- -**id:** `str` +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -29610,7 +29643,7 @@ client.knowledgebase.groups.retrieve(
-**expand:** `typing.Optional[GroupsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response.
@@ -29618,7 +29651,7 @@ client.knowledgebase.groups.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -29626,7 +29659,7 @@ client.knowledgebase.groups.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**job_title:** `typing.Optional[str]` — If provided, will only return employees that have an employment of the specified job title.
@@ -29634,97 +29667,31 @@ client.knowledgebase.groups.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**last_name:** `typing.Optional[str]` — If provided, will only return employees with this last name.
-
-
- -
-
-
- -## Knowledgebase Issues -
client.knowledgebase.issues.list(...)
-#### 📝 Description - -
-
- -
-
- -Gets all issues for Organization. -
-
+**manager_id:** `typing.Optional[str]` — If provided, will only return employees for this manager. +
-#### 🔌 Usage - -
-
-
-```python -import datetime - -from merge import Merge -from merge.resources.knowledgebase.resources.issues import ( - IssuesListRequestStatus, -) - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.knowledgebase.issues.list( - account_token="account_token", - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - end_date="end_date", - end_user_organization_name="end_user_organization_name", - first_incident_time_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - first_incident_time_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - include_muted="include_muted", - integration_name="integration_name", - last_incident_time_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - last_incident_time_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - linked_account_id="linked_account_id", - page_size=1, - start_date="start_date", - status=IssuesListRequestStatus.ONGOING, -) - -``` -
-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +
-#### ⚙️ Parameters - -
-
-
-**account_token:** `typing.Optional[str]` +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -29732,7 +29699,7 @@ client.knowledgebase.issues.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -29740,7 +29707,7 @@ client.knowledgebase.issues.list(
-**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time +**pay_group_id:** `typing.Optional[str]` — If provided, will only return employees for this pay group
@@ -29748,7 +29715,7 @@ client.knowledgebase.issues.list(
-**end_user_organization_name:** `typing.Optional[str]` +**personal_email:** `typing.Optional[str]` — If provided, will only return Employees with this personal email
@@ -29756,7 +29723,7 @@ client.knowledgebase.issues.list(
-**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime. +**remote_fields:** `typing.Optional[EmployeesListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -29764,7 +29731,7 @@ client.knowledgebase.issues.list(
-**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -29772,7 +29739,7 @@ client.knowledgebase.issues.list(
-**include_muted:** `typing.Optional[str]` — If true, will include muted issues +**show_enum_origins:** `typing.Optional[EmployeesListRequestShowEnumOrigins]` — 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)
@@ -29780,7 +29747,7 @@ client.knowledgebase.issues.list(
-**integration_name:** `typing.Optional[str]` +**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that started after this datetime.
@@ -29788,7 +29755,7 @@ client.knowledgebase.issues.list(
-**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime. +**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return employees that started before this datetime.
@@ -29796,7 +29763,7 @@ client.knowledgebase.issues.list(
-**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime. +**team_id:** `typing.Optional[str]` — If provided, will only return employees for this team.
@@ -29804,7 +29771,7 @@ client.knowledgebase.issues.list(
-**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in. +**terminated_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that were terminated after this datetime.
@@ -29812,7 +29779,7 @@ client.knowledgebase.issues.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +**terminated_before:** `typing.Optional[dt.datetime]` — If provided, will only return employees that were terminated before this datetime.
@@ -29820,7 +29787,7 @@ client.knowledgebase.issues.list(
-**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time +**work_email:** `typing.Optional[str]` — If provided, will only return Employees with this work email
@@ -29828,12 +29795,7 @@ client.knowledgebase.issues.list(
-**status:** `typing.Optional[IssuesListRequestStatus]` - -Status of the issue. Options: ('ONGOING', 'RESOLVED') - -* `ONGOING` - ONGOING -* `RESOLVED` - RESOLVED +**work_location_id:** `typing.Optional[str]` — If provided, will only return employees for this location.
@@ -29853,7 +29815,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
client.knowledgebase.issues.retrieve(...) +
client.hris.employees.create(...)
@@ -29865,7 +29827,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-Get a specific issue. +Creates an `Employee` object with the given values.
@@ -29881,13 +29843,16 @@ Get a specific issue. ```python from merge import Merge +from merge.resources.hris import EmployeeRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.issues.retrieve( - id="id", +client.hris.employees.create( + is_debug_mode=True, + run_async=True, + model=EmployeeRequest(), ) ``` @@ -29904,7 +29869,23 @@ client.knowledgebase.issues.retrieve(
-**id:** `str` +**model:** `EmployeeRequest` + +
+
+ +
+
+ +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. + +
+
+ +
+
+ +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -29924,8 +29905,7 @@ client.knowledgebase.issues.retrieve(
-## Knowledgebase LinkToken -
client.knowledgebase.link_token.create(...) +
client.hris.employees.retrieve(...)
@@ -29937,7 +29917,7 @@ client.knowledgebase.issues.retrieve(
-Creates a link token to be used when linking a new end user. +Returns an `Employee` object with the given `id`.
@@ -29953,17 +29933,24 @@ Creates a link token to be used when linking a new end user. ```python from merge import Merge -from merge.resources.knowledgebase import CategoriesEnum +from merge.resources.hris.resources.employees import ( + EmployeesRetrieveRequestExpand, + EmployeesRetrieveRequestRemoteFields, + EmployeesRetrieveRequestShowEnumOrigins, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.link_token.create( - end_user_email_address="example@gmail.com", - end_user_organization_name="Test Organization", - end_user_origin_id="12345", - categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS], +client.hris.employees.retrieve( + id="id", + expand=EmployeesRetrieveRequestExpand.COMPANY, + include_remote_data=True, + include_sensitive_fields=True, + include_shell_data=True, + remote_fields=EmployeesRetrieveRequestRemoteFields.EMPLOYMENT_STATUS, + show_enum_origins=EmployeesRetrieveRequestShowEnumOrigins.EMPLOYMENT_STATUS, ) ``` @@ -29980,7 +29967,7 @@ client.knowledgebase.link_token.create(
-**end_user_email_address:** `str` — Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent. +**id:** `str`
@@ -29988,7 +29975,7 @@ client.knowledgebase.link_token.create(
-**end_user_organization_name:** `str` — Your end user's organization. +**expand:** `typing.Optional[EmployeesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -29996,7 +29983,7 @@ client.knowledgebase.link_token.create(
-**end_user_origin_id:** `str` — This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -30004,7 +29991,7 @@ client.knowledgebase.link_token.create(
-**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link. +**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response.
@@ -30012,7 +29999,7 @@ client.knowledgebase.link_token.create(
-**integration:** `typing.Optional[str]` — The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -30020,7 +30007,7 @@ client.knowledgebase.link_token.create(
-**link_expiry_mins:** `typing.Optional[int]` — An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30. +**remote_fields:** `typing.Optional[EmployeesRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -30028,7 +30015,7 @@ client.knowledgebase.link_token.create(
-**should_create_magic_link_url:** `typing.Optional[bool]` — Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link. +**show_enum_origins:** `typing.Optional[EmployeesRetrieveRequestShowEnumOrigins]` — 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)
@@ -30036,43 +30023,80 @@ client.knowledgebase.link_token.create(
-**hide_admin_magic_link:** `typing.Optional[bool]` — Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + +
+ +
client.hris.employees.ignore_create(...)
-**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account. - +#### 📝 Description + +
+
+ +
+
+ +Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes. +
+
+#### 🔌 Usage +
-**category_common_model_scopes:** `typing.Optional[ - typing.Dict[ - str, - typing.Optional[ - typing.Sequence[IndividualCommonModelScopeDeserializerRequest] - ], - ] -]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings. - +
+
+ +```python +from merge import Merge +from merge.resources.hris import ReasonEnum + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.employees.ignore_create( + model_id="model_id", + reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, +) + +``` +
+
+#### ⚙️ Parameters +
-**language:** `typing.Optional[EndUserDetailsRequestLanguage]` +
+
-The following subset of IETF language tags can be used to configure localization. +**model_id:** `str` + +
+
-* `en` - en -* `de` - de +
+
+ +**reason:** `IgnoreCommonModelRequestReason`
@@ -30080,7 +30104,7 @@ The following subset of IETF language tags can be used to configure localization
-**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled. +**message:** `typing.Optional[str]`
@@ -30088,22 +30112,63 @@ The following subset of IETF language tags can be used to configure localization
-**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+ + +
+
+
+
client.hris.employees.meta_post_retrieve()
-**completed_account_initial_screen:** `typing.Optional[EndUserDetailsRequestCompletedAccountInitialScreen]` +#### 📝 Description -When creating a Link token, you can specifiy the initial screen of Linking Flow for a completed Linked Account. +
+
-* `SELECTIVE_SYNC` - SELECTIVE_SYNC - +
+
+ +Returns metadata for `Employee` POSTs.
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.employees.meta_post_retrieve() + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
@@ -30120,8 +30185,8 @@ When creating a Link token, you can specifiy the initial screen of Linking Flow
-## Knowledgebase LinkedAccounts -
client.knowledgebase.linked_accounts.list(...) +## Hris EmployerBenefits +
client.hris.employer_benefits.list(...)
@@ -30133,7 +30198,7 @@ When creating a Link token, you can specifiy the initial screen of Linking Flow
-List linked accounts for your organization. +Returns a list of `EmployerBenefit` objects.
@@ -30148,29 +30213,33 @@ List linked accounts for your organization.
```python +import datetime + from merge import Merge -from merge.resources.knowledgebase.resources.linked_accounts import ( - LinkedAccountsListRequestCategory, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.linked_accounts.list( - category=LinkedAccountsListRequestCategory.ACCOUNTING, +client.hris.employer_benefits.list( + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - end_user_email_address="end_user_email_address", - end_user_organization_name="end_user_organization_name", - end_user_origin_id="end_user_origin_id", - end_user_origin_ids="end_user_origin_ids", - id="id", - ids="ids", - include_duplicates=True, - integration_name="integration_name", - is_test_account="is_test_account", + include_deleted_data=True, + include_remote_data=True, + include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), page_size=1, - status="status", + remote_id="remote_id", ) ``` @@ -30187,18 +30256,15 @@ client.knowledgebase.linked_accounts.list(
-**category:** `typing.Optional[LinkedAccountsListRequestCategory]` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. + +
+
-Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mktg`, `ticketing` +
+
-* `hris` - hris -* `ats` - ats -* `accounting` - accounting -* `ticketing` - ticketing -* `crm` - crm -* `mktg` - mktg -* `filestorage` - filestorage -* `knowledgebase` - knowledgebase +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -30214,7 +30280,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address. +**include_deleted_data:** `typing.Optional[bool]` — 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/).
@@ -30222,7 +30288,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -30230,7 +30296,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -30238,7 +30304,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -30246,7 +30312,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-**id:** `typing.Optional[str]` +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -30254,7 +30320,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
@@ -30262,7 +30328,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-**include_duplicates:** `typing.Optional[bool]` — If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -30270,15 +30336,72 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+ + + + +
+
client.hris.employer_benefits.retrieve(...)
-**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts. +#### 📝 Description + +
+
+ +
+
+ +Returns an `EmployerBenefit` object with the given `id`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.employer_benefits.retrieve( + id="id", + include_remote_data=True, + include_shell_data=True, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `str`
@@ -30286,7 +30409,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -30294,7 +30417,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED` +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -30314,8 +30437,8 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-## Knowledgebase Passthrough -
client.knowledgebase.passthrough.create(...) +## Hris Employments +
client.hris.employments.list(...)
@@ -30327,7 +30450,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-Pull data from an endpoint not currently supported by Merge. +Returns a list of `Employment` objects.
@@ -30342,18 +30465,44 @@ Pull data from an endpoint not currently supported by Merge.
```python +import datetime + from merge import Merge -from merge.resources.knowledgebase import DataPassthroughRequest, MethodEnum +from merge.resources.hris.resources.employments import ( + EmploymentsListRequestExpand, + EmploymentsListRequestOrderBy, + EmploymentsListRequestRemoteFields, + EmploymentsListRequestShowEnumOrigins, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", +client.hris.employments.list( + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + employee_id="employee_id", + expand=EmploymentsListRequestExpand.EMPLOYEE, + include_deleted_data=True, + include_remote_data=True, + include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + order_by=EmploymentsListRequestOrderBy.EFFECTIVE_DATE_DESCENDING, + page_size=1, + remote_fields=EmploymentsListRequestRemoteFields.EMPLOYMENT_TYPE, + remote_id="remote_id", + show_enum_origins=EmploymentsListRequestShowEnumOrigins.EMPLOYMENT_TYPE, ) ``` @@ -30370,7 +30519,7 @@ client.knowledgebase.passthrough.create(
-**request:** `DataPassthroughRequest` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -30378,71 +30527,111 @@ client.knowledgebase.passthrough.create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+ +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor value. +
+
+
+**employee_id:** `typing.Optional[str]` — If provided, will only return employments for this employee. +
-
-## Knowledgebase RegenerateKey -
client.knowledgebase.regenerate_key.create(...)
-#### 📝 Description +**expand:** `typing.Optional[EmploymentsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+**include_deleted_data:** `typing.Optional[bool]` — 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/). + +
+
+
-Exchange remote keys. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +
-#### 🔌 Usage -
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
+
-```python -from merge import Merge +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.knowledgebase.regenerate_key.create( - name="Remote Deployment Key 1", -) +
+
-``` +**order_by:** `typing.Optional[EmploymentsListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: effective_date, -effective_date. +
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +
-#### ⚙️ Parameters +
+
+ +**remote_fields:** `typing.Optional[EmploymentsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. + +
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+
-**name:** `str` — The name of the remote key +**show_enum_origins:** `typing.Optional[EmploymentsListRequestShowEnumOrigins]` — 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)
@@ -30462,8 +30651,7 @@ client.knowledgebase.regenerate_key.create(
-## Knowledgebase SyncStatus -
client.knowledgebase.sync_status.list(...) +
client.hris.employments.retrieve(...)
@@ -30475,7 +30663,7 @@ client.knowledgebase.regenerate_key.create(
-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). +Returns an `Employment` object with the given `id`.
@@ -30491,31 +30679,72 @@ Get sync status for the current sync and the most recently finished sync. `last_ ```python from merge import Merge +from merge.resources.hris.resources.employments import ( + EmploymentsRetrieveRequestExpand, + EmploymentsRetrieveRequestRemoteFields, + EmploymentsRetrieveRequestShowEnumOrigins, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.sync_status.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - page_size=1, +client.hris.employments.retrieve( + id="id", + expand=EmploymentsRetrieveRequestExpand.EMPLOYEE, + include_remote_data=True, + include_shell_data=True, + remote_fields=EmploymentsRetrieveRequestRemoteFields.EMPLOYMENT_TYPE, + show_enum_origins=EmploymentsRetrieveRequestShowEnumOrigins.EMPLOYMENT_TYPE, ) -``` +``` + +
+ + + +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `str` +
+ +
+
+ +**expand:** `typing.Optional[EmploymentsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-#### ⚙️ Parameters +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**remote_fields:** `typing.Optional[EmploymentsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -30523,7 +30752,7 @@ client.knowledgebase.sync_status.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +**show_enum_origins:** `typing.Optional[EmploymentsRetrieveRequestShowEnumOrigins]` — 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)
@@ -30543,8 +30772,8 @@ client.knowledgebase.sync_status.list(
-## Knowledgebase ForceResync -
client.knowledgebase.force_resync.sync_status_resync_create() +## Hris FieldMapping +
client.hris.field_mapping.field_mappings_retrieve(...)
@@ -30556,7 +30785,7 @@ client.knowledgebase.sync_status.list(
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers. +Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
@@ -30577,7 +30806,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.force_resync.sync_status_resync_create() +client.hris.field_mapping.field_mappings_retrieve( + exclude_remote_field_metadata=True, +) ``` @@ -30593,6 +30824,14 @@ client.knowledgebase.force_resync.sync_status_resync_create()
+**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -30605,8 +30844,7 @@ client.knowledgebase.force_resync.sync_status_resync_create()
-## Knowledgebase Users -
client.knowledgebase.users.list(...) +
client.hris.field_mapping.field_mappings_create(...)
@@ -30618,7 +30856,7 @@ client.knowledgebase.force_resync.sync_status_resync_create()
-Returns a list of `User` objects. +Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -30633,33 +30871,20 @@ Returns a list of `User` objects.
```python -import datetime - from merge import Merge client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.users.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - include_deleted_data=True, - include_remote_data=True, - include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - page_size=1, - remote_id="remote_id", +client.hris.field_mapping.field_mappings_create( + exclude_remote_field_metadata=True, + target_field_name="example_target_field_name", + target_field_description="this is a example description of the target field", + remote_field_traversal_path=["example_remote_field"], + remote_method="GET", + remote_url_path="/example-url-path", + common_model_name="ExampleCommonModel", ) ``` @@ -30676,23 +30901,7 @@ client.knowledgebase.users.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. - -
-
- -
-
- -**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. - -
-
- -
-
- -**cursor:** `typing.Optional[str]` — The pagination cursor value. +**target_field_name:** `str` — The name of the target field you want this remote field to map to.
@@ -30700,7 +30909,7 @@ client.knowledgebase.users.list(
-**include_deleted_data:** `typing.Optional[bool]` — 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/). +**target_field_description:** `str` — The description of the target field you want this remote field to map to.
@@ -30708,7 +30917,7 @@ client.knowledgebase.users.list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
@@ -30716,7 +30925,7 @@ client.knowledgebase.users.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
@@ -30724,7 +30933,7 @@ client.knowledgebase.users.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
@@ -30732,7 +30941,7 @@ client.knowledgebase.users.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category.
@@ -30740,7 +30949,7 @@ client.knowledgebase.users.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
@@ -30748,7 +30957,7 @@ client.knowledgebase.users.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**jmes_path:** `typing.Optional[str]` — JMES path to specify json query expression to be used on field mapping.
@@ -30768,7 +30977,7 @@ client.knowledgebase.users.list(
-
client.knowledgebase.users.retrieve(...) +
client.hris.field_mapping.field_mappings_destroy(...)
@@ -30780,7 +30989,7 @@ client.knowledgebase.users.list(
-Returns a `User` object with the given `id`. +Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -30801,10 +31010,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.users.retrieve( - id="id", - include_remote_data=True, - include_shell_data=True, +client.hris.field_mapping.field_mappings_destroy( + field_mapping_id="field_mapping_id", ) ``` @@ -30821,23 +31028,7 @@ client.knowledgebase.users.retrieve(
-**id:** `str` - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**field_mapping_id:** `str`
@@ -30857,8 +31048,7 @@ client.knowledgebase.users.retrieve(
-## Knowledgebase WebhookReceivers -
client.knowledgebase.webhook_receivers.list() +
client.hris.field_mapping.field_mappings_partial_update(...)
@@ -30870,7 +31060,7 @@ client.knowledgebase.users.retrieve(
-Returns a list of `WebhookReceiver` objects. +Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -30891,7 +31081,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.webhook_receivers.list() +client.hris.field_mapping.field_mappings_partial_update( + field_mapping_id="field_mapping_id", +) ``` @@ -30907,71 +31099,23 @@ client.knowledgebase.webhook_receivers.list()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**field_mapping_id:** `str`
- -
- - - - -
- -
client.knowledgebase.webhook_receivers.create(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Creates a `WebhookReceiver` object with the given values. -
-
-
-
- -#### 🔌 Usage
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.knowledgebase.webhook_receivers.create( - event="event", - is_active=True, -) - -``` -
-
+**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. +
-#### ⚙️ Parameters - -
-
-
-**event:** `str` +**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
@@ -30979,7 +31123,7 @@ client.knowledgebase.webhook_receivers.create(
-**is_active:** `bool` +**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
@@ -30987,7 +31131,7 @@ client.knowledgebase.webhook_receivers.create(
-**key:** `typing.Optional[str]` +**jmes_path:** `typing.Optional[str]` — JMES path to specify json query expression to be used on field mapping.
@@ -31007,8 +31151,7 @@ client.knowledgebase.webhook_receivers.create(
-## Hris AccountDetails -
client.hris.account_details.retrieve() +
client.hris.field_mapping.remote_fields_retrieve(...)
@@ -31020,7 +31163,7 @@ client.knowledgebase.webhook_receivers.create(
-Get details for a linked account. +Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
@@ -31041,7 +31184,10 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.account_details.retrieve() +client.hris.field_mapping.remote_fields_retrieve( + common_models="common_models", + include_example_values="include_example_values", +) ``` @@ -31057,6 +31203,22 @@ client.hris.account_details.retrieve()
+**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models. + +
+
+ +
+
+ +**include_example_values:** `typing.Optional[str]` — If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -31069,8 +31231,7 @@ client.hris.account_details.retrieve()
-## Hris AccountToken -
client.hris.account_token.retrieve(...) +
client.hris.field_mapping.target_fields_retrieve()
@@ -31082,7 +31243,7 @@ client.hris.account_details.retrieve()
-Returns the account token for the end user with the provided public token. +Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
@@ -31103,9 +31264,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.account_token.retrieve( - public_token="public_token", -) +client.hris.field_mapping.target_fields_retrieve() ``` @@ -31115,16 +31274,8 @@ client.hris.account_token.retrieve( #### ⚙️ Parameters -
-
- -
-
- -**public_token:** `str` - -
-
+
+
@@ -31141,8 +31292,8 @@ client.hris.account_token.retrieve(
-## Hris AsyncPassthrough -
client.hris.async_passthrough.create(...) +## Hris GenerateKey +
client.hris.generate_key.create(...)
@@ -31154,7 +31305,7 @@ client.hris.account_token.retrieve(
-Asynchronously pull data from an endpoint not currently supported by Merge. +Create a remote key.
@@ -31170,17 +31321,13 @@ Asynchronously pull data from an endpoint not currently supported by Merge. ```python from merge import Merge -from merge.resources.hris import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.async_passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), +client.hris.generate_key.create( + name="Remote Deployment Key 1", ) ``` @@ -31197,7 +31344,7 @@ client.hris.async_passthrough.create(
-**request:** `DataPassthroughRequest` +**name:** `str` — The name of the remote key
@@ -31217,7 +31364,8 @@ client.hris.async_passthrough.create(
-
client.hris.async_passthrough.retrieve(...) +## Hris Groups +
client.hris.groups.list(...)
@@ -31229,7 +31377,7 @@ client.hris.async_passthrough.create(
-Retrieves data from earlier async-passthrough POST request +Returns a list of `Group` objects.
@@ -31244,14 +31392,36 @@ Retrieves data from earlier async-passthrough POST request
```python +import datetime + from merge import Merge client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.async_passthrough.retrieve( - async_passthrough_receipt_id="async_passthrough_receipt_id", +client.hris.groups.list( + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + include_deleted_data=True, + include_remote_data=True, + include_shell_data=True, + is_commonly_used_as_team="is_commonly_used_as_team", + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + names="names", + page_size=1, + remote_id="remote_id", + types="types", ) ``` @@ -31268,7 +31438,7 @@ client.hris.async_passthrough.retrieve(
-**async_passthrough_receipt_id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -31276,76 +31446,71 @@ client.hris.async_passthrough.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
-
+
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value. +
-
-## Hris AuditTrail -
client.hris.audit_trail.list(...)
-#### 📝 Description +**include_deleted_data:** `typing.Optional[bool]` — 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:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+
-Gets a list of audit trail events. -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + -#### 🔌 Usage -
+**is_commonly_used_as_team:** `typing.Optional[str]` — If provided, specifies whether to return only Group objects which refer to a team in the third party platform. Note that this is an opinionated view based on how a team may be represented in the third party platform. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.audit_trail.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - end_date="end_date", - event_type="event_type", - page_size=1, - start_date="start_date", - user_email="user_email", -) - -``` -
-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + -#### ⚙️ Parameters -
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + +
+
+
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**names:** `typing.Optional[str]` — If provided, will only return groups with these names. Multiple values can be separated by commas.
@@ -31353,7 +31518,7 @@ client.hris.audit_trail.list(
-**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
@@ -31361,7 +31526,7 @@ client.hris.audit_trail.list(
-**event_type:** `typing.Optional[str]` — If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED` +**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins.
@@ -31369,7 +31534,7 @@ client.hris.audit_trail.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -31377,7 +31542,7 @@ client.hris.audit_trail.list(
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time +**show_enum_origins:** `typing.Optional[typing.Literal["type"]]` — 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)
@@ -31385,7 +31550,7 @@ client.hris.audit_trail.list(
-**user_email:** `typing.Optional[str]` — If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email. +**types:** `typing.Optional[str]` — If provided, will only return groups of these types. Multiple values can be separated by commas.
@@ -31405,8 +31570,7 @@ client.hris.audit_trail.list(
-## Hris AvailableActions -
client.hris.available_actions.retrieve() +
client.hris.groups.retrieve(...)
@@ -31418,7 +31582,7 @@ client.hris.audit_trail.list(
-Returns a list of models and actions available for an account. +Returns a `Group` object with the given `id`.
@@ -31439,7 +31603,11 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.available_actions.retrieve() +client.hris.groups.retrieve( + id="id", + include_remote_data=True, + include_shell_data=True, +) ``` @@ -31455,6 +31623,46 @@ client.hris.available_actions.retrieve()
+**id:** `str` + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+ +
+
+ +**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[typing.Literal["type"]]` — 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) + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -31467,8 +31675,8 @@ client.hris.available_actions.retrieve()
-## Hris BankInfo -
client.hris.bank_info.list(...) +## Hris Issues +
client.hris.issues.list(...)
@@ -31480,7 +31688,7 @@ client.hris.available_actions.retrieve()
-Returns a list of `BankInfo` objects. +Gets all issues for Organization.
@@ -31498,38 +31706,35 @@ Returns a list of `BankInfo` objects. import datetime from merge import Merge -from merge.resources.hris.resources.bank_info import ( - BankInfoListRequestAccountType, - BankInfoListRequestOrderBy, -) +from merge.resources.hris.resources.issues import IssuesListRequestStatus client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.bank_info.list( - account_type=BankInfoListRequestAccountType.CHECKING, - bank_name="bank_name", - created_after=datetime.datetime.fromisoformat( +client.hris.issues.list( + account_token="account_token", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + end_date="end_date", + end_user_organization_name="end_user_organization_name", + first_incident_time_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - created_before=datetime.datetime.fromisoformat( + first_incident_time_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - employee_id="employee_id", - include_deleted_data=True, - include_remote_data=True, - include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( + include_muted="include_muted", + integration_name="integration_name", + last_incident_time_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - modified_before=datetime.datetime.fromisoformat( + last_incident_time_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - order_by=BankInfoListRequestOrderBy.REMOTE_CREATED_AT_DESCENDING, + linked_account_id="linked_account_id", page_size=1, - remote_id="remote_id", + start_date="start_date", + status=IssuesListRequestStatus.ONGOING, ) ``` @@ -31546,36 +31751,7 @@ client.hris.bank_info.list(
-**account_type:** `typing.Optional[BankInfoListRequestAccountType]` - -If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING') - -* `SAVINGS` - SAVINGS -* `CHECKING` - CHECKING - -
-
- -
-
- -**bank_name:** `typing.Optional[str]` — If provided, will only return BankInfo's with this bank name. - -
-
- -
-
- -**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. - -
-
- -
-
- -**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**account_token:** `typing.Optional[str]`
@@ -31591,7 +31767,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**employee_id:** `typing.Optional[str]` — If provided, will only return bank accounts for this employee. +**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time
@@ -31599,7 +31775,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**end_user_organization_name:** `typing.Optional[str]`
@@ -31607,7 +31783,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**include_deleted_data:** `typing.Optional[bool]` — 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/). +**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
@@ -31615,7 +31791,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
@@ -31623,7 +31799,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**include_muted:** `typing.Optional[str]` — If true, will include muted issues
@@ -31631,7 +31807,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**integration_name:** `typing.Optional[str]`
@@ -31639,7 +31815,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime.
@@ -31647,7 +31823,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**order_by:** `typing.Optional[BankInfoListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: remote_created_at, -remote_created_at. +**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
@@ -31655,7 +31831,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in.
@@ -31663,7 +31839,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**remote_fields:** `typing.Optional[typing.Literal["account_type"]]` — Deprecated. Use show_enum_origins. +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
@@ -31671,7 +31847,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time
@@ -31679,7 +31855,12 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**show_enum_origins:** `typing.Optional[typing.Literal["account_type"]]` — 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) +**status:** `typing.Optional[IssuesListRequestStatus]` + +Status of the issue. Options: ('ONGOING', 'RESOLVED') + +* `ONGOING` - ONGOING +* `RESOLVED` - RESOLVED
@@ -31699,7 +31880,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-
client.hris.bank_info.retrieve(...) +
client.hris.issues.retrieve(...)
@@ -31711,7 +31892,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-Returns a `BankInfo` object with the given `id`. +Get a specific issue.
@@ -31732,10 +31913,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.bank_info.retrieve( +client.hris.issues.retrieve( id="id", - include_remote_data=True, - include_shell_data=True, ) ``` @@ -31760,46 +31939,6 @@ client.hris.bank_info.retrieve(
-**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
- -
-
- -**remote_fields:** `typing.Optional[typing.Literal["account_type"]]` — Deprecated. Use show_enum_origins. - -
-
- -
-
- -**show_enum_origins:** `typing.Optional[typing.Literal["account_type"]]` — 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) - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -31812,8 +31951,8 @@ client.hris.bank_info.retrieve(
-## Hris Benefits -
client.hris.benefits.list(...) +## Hris LinkToken +
client.hris.link_token.create(...)
@@ -31825,7 +31964,7 @@ client.hris.bank_info.retrieve(
-Returns a list of `Benefit` objects. +Creates a link token to be used when linking a new end user.
@@ -31840,34 +31979,18 @@ Returns a list of `Benefit` objects.
```python -import datetime - from merge import Merge +from merge.resources.hris import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.benefits.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - employee_id="employee_id", - include_deleted_data=True, - include_remote_data=True, - include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - page_size=1, - remote_id="remote_id", +client.hris.link_token.create( + end_user_email_address="example@gmail.com", + end_user_organization_name="Test Organization", + end_user_origin_id="12345", + categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS], ) ``` @@ -31884,7 +32007,7 @@ client.hris.benefits.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**end_user_email_address:** `str` — Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.
@@ -31892,7 +32015,7 @@ client.hris.benefits.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**end_user_organization_name:** `str` — Your end user's organization.
@@ -31900,7 +32023,7 @@ client.hris.benefits.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**end_user_origin_id:** `str` — This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers.
@@ -31908,7 +32031,7 @@ client.hris.benefits.list(
-**employee_id:** `typing.Optional[str]` — If provided, will return the benefits associated with the employee. +**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
@@ -31916,7 +32039,7 @@ client.hris.benefits.list(
-**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**integration:** `typing.Optional[str]` — The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/.
@@ -31924,7 +32047,7 @@ client.hris.benefits.list(
-**include_deleted_data:** `typing.Optional[bool]` — 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/). +**link_expiry_mins:** `typing.Optional[int]` — An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30.
@@ -31932,7 +32055,7 @@ client.hris.benefits.list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**should_create_magic_link_url:** `typing.Optional[bool]` — Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
@@ -31940,7 +32063,7 @@ client.hris.benefits.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**hide_admin_magic_link:** `typing.Optional[bool]` — Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
@@ -31948,7 +32071,7 @@ client.hris.benefits.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.
@@ -31956,7 +32079,14 @@ client.hris.benefits.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**category_common_model_scopes:** `typing.Optional[ + typing.Dict[ + str, + typing.Optional[ + typing.Sequence[IndividualCommonModelScopeDeserializerRequest] + ], + ] +]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings.
@@ -31964,7 +32094,12 @@ client.hris.benefits.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +**language:** `typing.Optional[EndUserDetailsRequestLanguage]` + +The following subset of IETF language tags can be used to configure localization. + +* `en` - en +* `de` - de
@@ -31972,7 +32107,27 @@ client.hris.benefits.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled. + +
+
+ +
+
+ +**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options. + +
+
+ +
+
+ +**completed_account_initial_screen:** `typing.Optional[EndUserDetailsRequestCompletedAccountInitialScreen]` + +When creating a Link token, you can specifiy the initial screen of Linking Flow for a completed Linked Account. + +* `SELECTIVE_SYNC` - SELECTIVE_SYNC
@@ -31992,7 +32147,8 @@ client.hris.benefits.list(
-
client.hris.benefits.retrieve(...) +## Hris LinkedAccounts +
client.hris.linked_accounts.list(...)
@@ -32004,48 +32160,143 @@ client.hris.benefits.list(
-Returns a `Benefit` object with the given `id`. +List linked accounts for your organization. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge +from merge.resources.hris.resources.linked_accounts import ( + LinkedAccountsListRequestCategory, +) + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.linked_accounts.list( + category=LinkedAccountsListRequestCategory.ACCOUNTING, + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + end_user_email_address="end_user_email_address", + end_user_organization_name="end_user_organization_name", + end_user_origin_id="end_user_origin_id", + end_user_origin_ids="end_user_origin_ids", + id="id", + ids="ids", + include_duplicates=True, + integration_name="integration_name", + is_test_account="is_test_account", + page_size=1, + status="status", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**category:** `typing.Optional[LinkedAccountsListRequestCategory]` + +Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing` + +* `hris` - hris +* `ats` - ats +* `accounting` - accounting +* `ticketing` - ticketing +* `crm` - crm +* `mktg` - mktg +* `filestorage` - filestorage + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+ +
+
+ +**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address. + +
+
+ +
+
+ +**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name. +
+ +
+
+ +**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID. +
-#### 🔌 Usage -
+**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.benefits.retrieve( - id="id", - include_remote_data=True, - include_shell_data=True, -) - -``` +**id:** `typing.Optional[str]` +
+ +
+
+ +**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. +
-#### ⚙️ Parameters -
+**include_duplicates:** `typing.Optional[bool]` — If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account. + +
+
+
-**id:** `str` +**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name.
@@ -32053,7 +32304,7 @@ client.hris.benefits.retrieve(
-**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
@@ -32061,7 +32312,7 @@ client.hris.benefits.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
@@ -32069,7 +32320,7 @@ client.hris.benefits.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
@@ -32089,8 +32340,8 @@ client.hris.benefits.retrieve(
-## Hris Companies -
client.hris.companies.list(...) +## Hris Locations +
client.hris.locations.list(...)
@@ -32102,7 +32353,7 @@ client.hris.benefits.retrieve(
-Returns a list of `Company` objects. +Returns a list of `Location` objects.
@@ -32120,12 +32371,17 @@ Returns a list of `Company` objects. import datetime from merge import Merge +from merge.resources.hris.resources.locations import ( + LocationsListRequestLocationType, + LocationsListRequestRemoteFields, + LocationsListRequestShowEnumOrigins, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.companies.list( +client.hris.locations.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -32136,6 +32392,7 @@ client.hris.companies.list( include_deleted_data=True, include_remote_data=True, include_shell_data=True, + location_type=LocationsListRequestLocationType.HOME, modified_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -32143,7 +32400,9 @@ client.hris.companies.list( "2024-01-15 09:30:00+00:00", ), page_size=1, + remote_fields=LocationsListRequestRemoteFields.COUNTRY, remote_id="remote_id", + show_enum_origins=LocationsListRequestShowEnumOrigins.COUNTRY, ) ``` @@ -32208,6 +32467,19 @@ client.hris.companies.list(
+**location_type:** `typing.Optional[LocationsListRequestLocationType]` + +If provided, will only return locations with this location type + +* `HOME` - HOME +* `WORK` - WORK + +
+
+ +
+
+ **modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -32232,6 +32504,14 @@ client.hris.companies.list(
+**remote_fields:** `typing.Optional[LocationsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ **remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -32240,6 +32520,14 @@ client.hris.companies.list(
+**show_enum_origins:** `typing.Optional[LocationsListRequestShowEnumOrigins]` — 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) + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -32252,7 +32540,7 @@ client.hris.companies.list(
-
client.hris.companies.retrieve(...) +
client.hris.locations.retrieve(...)
@@ -32264,7 +32552,7 @@ client.hris.companies.list(
-Returns a `Company` object with the given `id`. +Returns a `Location` object with the given `id`.
@@ -32280,15 +32568,21 @@ Returns a `Company` object with the given `id`. ```python from merge import Merge +from merge.resources.hris.resources.locations import ( + LocationsRetrieveRequestRemoteFields, + LocationsRetrieveRequestShowEnumOrigins, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.companies.retrieve( +client.hris.locations.retrieve( id="id", include_remote_data=True, include_shell_data=True, + remote_fields=LocationsRetrieveRequestRemoteFields.COUNTRY, + show_enum_origins=LocationsRetrieveRequestShowEnumOrigins.COUNTRY, ) ``` @@ -32329,6 +32623,22 @@ client.hris.companies.retrieve(
+**remote_fields:** `typing.Optional[LocationsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[LocationsRetrieveRequestShowEnumOrigins]` — 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) + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -32341,8 +32651,8 @@ client.hris.companies.retrieve(
-## Hris Scopes -
client.hris.scopes.default_scopes_retrieve() +## Hris Passthrough +
client.hris.passthrough.create(...)
@@ -32354,7 +32664,7 @@ client.hris.companies.retrieve(
-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). +Pull data from an endpoint not currently supported by Merge.
@@ -32370,12 +32680,18 @@ Get the default permissions for Merge Common Models and fields across all Linked ```python from merge import Merge +from merge.resources.hris import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.scopes.default_scopes_retrieve() +client.hris.passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), +) ``` @@ -32391,6 +32707,14 @@ client.hris.scopes.default_scopes_retrieve()
+**request:** `DataPassthroughRequest` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -32403,7 +32727,8 @@ client.hris.scopes.default_scopes_retrieve()
-
client.hris.scopes.linked_account_scopes_retrieve() +## Hris PayGroups +
client.hris.pay_groups.list(...)
@@ -32415,7 +32740,7 @@ client.hris.scopes.default_scopes_retrieve()
-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). +Returns a list of `PayGroup` objects.
@@ -32430,13 +32755,34 @@ Get all available permissions for Merge Common Models and fields for a single Li
```python +import datetime + from merge import Merge client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.scopes.linked_account_scopes_retrieve() +client.hris.pay_groups.list( + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + include_deleted_data=True, + include_remote_data=True, + include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + page_size=1, + remote_id="remote_id", +) ```
@@ -32452,99 +32798,79 @@ client.hris.scopes.linked_account_scopes_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
- -
+
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +
-
-
client.hris.scopes.linked_account_scopes_create(...)
-#### 📝 Description +**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+**include_deleted_data:** `typing.Optional[bool]` — 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/). + +
+
+
-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) -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + -#### 🔌 Usage -
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+
-```python -from merge import Merge -from merge.resources.hris import ( - FieldPermissionDeserializerRequest, - IndividualCommonModelScopeDeserializerRequest, - ModelPermissionDeserializerRequest, -) - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.scopes.linked_account_scopes_create( - common_models=[ - IndividualCommonModelScopeDeserializerRequest( - model_name="Employee", - model_permissions={ - "READ": ModelPermissionDeserializerRequest( - is_enabled=True, - ), - "WRITE": ModelPermissionDeserializerRequest( - is_enabled=False, - ), - }, - field_permissions=FieldPermissionDeserializerRequest( - enabled_fields=["avatar", "home_location"], - disabled_fields=["work_location"], - ), - ), - IndividualCommonModelScopeDeserializerRequest( - model_name="Benefit", - model_permissions={ - "WRITE": ModelPermissionDeserializerRequest( - is_enabled=False, - ) - }, - ), - ], -) - -``` +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +
+ +
+
+ +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +
-#### ⚙️ Parameters -
+**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. + +
+
+
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -32564,8 +32890,7 @@ client.hris.scopes.linked_account_scopes_create(
-## Hris DeleteAccount -
client.hris.delete_account.delete() +
client.hris.pay_groups.retrieve(...)
@@ -32577,7 +32902,7 @@ client.hris.scopes.linked_account_scopes_create(
-Delete a linked account. +Returns a `PayGroup` object with the given `id`.
@@ -32598,7 +32923,11 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.delete_account.delete() +client.hris.pay_groups.retrieve( + id="id", + include_remote_data=True, + include_shell_data=True, +) ``` @@ -32614,6 +32943,30 @@ client.hris.delete_account.delete()
+**id:** `str` + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -32626,8 +32979,8 @@ client.hris.delete_account.delete()
-## Hris Dependents -
client.hris.dependents.list(...) +## Hris PayrollRuns +
client.hris.payroll_runs.list(...)
@@ -32639,7 +32992,7 @@ client.hris.delete_account.delete()
-Returns a list of `Dependent` objects. +Returns a list of `PayrollRun` objects.
@@ -32657,12 +33010,17 @@ Returns a list of `Dependent` objects. import datetime from merge import Merge +from merge.resources.hris.resources.payroll_runs import ( + PayrollRunsListRequestRemoteFields, + PayrollRunsListRequestRunType, + PayrollRunsListRequestShowEnumOrigins, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.dependents.list( +client.hris.payroll_runs.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -32670,10 +33028,14 @@ client.hris.dependents.list( "2024-01-15 09:30:00+00:00", ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - employee_id="employee_id", + ended_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + ended_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), include_deleted_data=True, include_remote_data=True, - include_sensitive_fields=True, include_shell_data=True, modified_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", @@ -32682,7 +33044,16 @@ client.hris.dependents.list( "2024-01-15 09:30:00+00:00", ), page_size=1, + remote_fields=PayrollRunsListRequestRemoteFields.RUN_STATE, remote_id="remote_id", + run_type=PayrollRunsListRequestRunType.CORRECTION, + show_enum_origins=PayrollRunsListRequestShowEnumOrigins.RUN_STATE, + started_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + started_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), ) ``` @@ -32723,7 +33094,7 @@ client.hris.dependents.list(
-**employee_id:** `typing.Optional[str]` — If provided, will only return dependents for this employee. +**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs ended after this datetime.
@@ -32731,7 +33102,7 @@ client.hris.dependents.list(
-**include_deleted_data:** `typing.Optional[bool]` — 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/). +**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs ended before this datetime.
@@ -32739,7 +33110,7 @@ client.hris.dependents.list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**include_deleted_data:** `typing.Optional[bool]` — 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/).
@@ -32747,7 +33118,7 @@ client.hris.dependents.list(
-**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -32787,7 +33158,7 @@ client.hris.dependents.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**remote_fields:** `typing.Optional[PayrollRunsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -32795,73 +33166,23 @@ client.hris.dependents.list(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
- -
- - - - -
- -
client.hris.dependents.retrieve(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Returns a `Dependent` object with the given `id`. -
-
-
-
- -#### 🔌 Usage - -
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.dependents.retrieve( - id="id", - include_remote_data=True, - include_sensitive_fields=True, - include_shell_data=True, -) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
+**run_type:** `typing.Optional[PayrollRunsListRequestRunType]` -
-
+If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS') -**id:** `str` +* `REGULAR` - REGULAR +* `OFF_CYCLE` - OFF_CYCLE +* `CORRECTION` - CORRECTION +* `TERMINATION` - TERMINATION +* `SIGN_ON_BONUS` - SIGN_ON_BONUS
@@ -32869,7 +33190,7 @@ client.hris.dependents.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**show_enum_origins:** `typing.Optional[PayrollRunsListRequestShowEnumOrigins]` — 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)
@@ -32877,7 +33198,7 @@ client.hris.dependents.retrieve(
-**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response. +**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs started after this datetime.
@@ -32885,7 +33206,7 @@ client.hris.dependents.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs started before this datetime.
@@ -32905,8 +33226,7 @@ client.hris.dependents.retrieve(
-## Hris EmployeePayrollRuns -
client.hris.employee_payroll_runs.list(...) +
client.hris.payroll_runs.retrieve(...)
@@ -32918,7 +33238,7 @@ client.hris.dependents.retrieve(
-Returns a list of `EmployeePayrollRun` objects. +Returns a `PayrollRun` object with the given `id`.
@@ -32933,51 +33253,22 @@ Returns a list of `EmployeePayrollRun` objects.
```python -import datetime - from merge import Merge -from merge.resources.hris.resources.employee_payroll_runs import ( - EmployeePayrollRunsListRequestExpand, +from merge.resources.hris.resources.payroll_runs import ( + PayrollRunsRetrieveRequestRemoteFields, + PayrollRunsRetrieveRequestShowEnumOrigins, ) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employee_payroll_runs.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - employee_id="employee_id", - ended_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - ended_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - expand=EmployeePayrollRunsListRequestExpand.EMPLOYEE, - include_deleted_data=True, +client.hris.payroll_runs.retrieve( + id="id", include_remote_data=True, include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - page_size=1, - payroll_run_id="payroll_run_id", - remote_id="remote_id", - started_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - started_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), + remote_fields=PayrollRunsRetrieveRequestRemoteFields.RUN_STATE, + show_enum_origins=PayrollRunsRetrieveRequestShowEnumOrigins.RUN_STATE, ) ``` @@ -32994,7 +33285,7 @@ client.hris.employee_payroll_runs.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**id:** `str`
@@ -33002,7 +33293,7 @@ client.hris.employee_payroll_runs.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -33010,7 +33301,7 @@ client.hris.employee_payroll_runs.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -33018,7 +33309,7 @@ client.hris.employee_payroll_runs.list(
-**employee_id:** `typing.Optional[str]` — If provided, will only return employee payroll runs for this employee. +**remote_fields:** `typing.Optional[PayrollRunsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -33026,7 +33317,7 @@ client.hris.employee_payroll_runs.list(
-**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs ended after this datetime. +**show_enum_origins:** `typing.Optional[PayrollRunsRetrieveRequestShowEnumOrigins]` — 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)
@@ -33034,31 +33325,71 @@ client.hris.employee_payroll_runs.list(
-**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs ended before this datetime. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+ + + + +
+ +## Hris RegenerateKey +
client.hris.regenerate_key.create(...) +
+
+ +#### 📝 Description
-**expand:** `typing.Optional[EmployeePayrollRunsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - +
+
+ +Exchange remote keys.
+
+
+ +#### 🔌 Usage
-**include_deleted_data:** `typing.Optional[bool]` — 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/). - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.regenerate_key.create( + name="Remote Deployment Key 1", +) + +``` +
+
+#### ⚙️ Parameters + +
+
+
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**name:** `str` — The name of the remote key
@@ -33066,55 +33397,72 @@ client.hris.employee_payroll_runs.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. -
+
+## Hris SyncStatus +
client.hris.sync_status.list(...)
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - -
-
+#### 📝 Description
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. - -
-
-
-**payroll_run_id:** `typing.Optional[str]` — If provided, will only return employee payroll runs for this employee. - +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). +
+
+#### 🔌 Usage +
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + page_size=1, +) + +```
+
+
+ +#### ⚙️ Parameters
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs started after this datetime. +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -33122,7 +33470,7 @@ client.hris.employee_payroll_runs.list(
-**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs started before this datetime. +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
@@ -33142,7 +33490,8 @@ client.hris.employee_payroll_runs.list(
-
client.hris.employee_payroll_runs.retrieve(...) +## Hris ForceResync +
client.hris.force_resync.sync_status_resync_create()
@@ -33154,7 +33503,7 @@ client.hris.employee_payroll_runs.list(
-Returns an `EmployeePayrollRun` object with the given `id`. +Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
@@ -33170,20 +33519,12 @@ Returns an `EmployeePayrollRun` object with the given `id`. ```python from merge import Merge -from merge.resources.hris.resources.employee_payroll_runs import ( - EmployeePayrollRunsRetrieveRequestExpand, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employee_payroll_runs.retrieve( - id="id", - expand=EmployeePayrollRunsRetrieveRequestExpand.EMPLOYEE, - include_remote_data=True, - include_shell_data=True, -) +client.hris.force_resync.sync_status_resync_create() ``` @@ -33199,38 +33540,6 @@ client.hris.employee_payroll_runs.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[EmployeePayrollRunsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -33243,8 +33552,8 @@ client.hris.employee_payroll_runs.retrieve(
-## Hris Employees -
client.hris.employees.list(...) +## Hris Teams +
client.hris.teams.list(...)
@@ -33256,7 +33565,7 @@ client.hris.employee_payroll_runs.retrieve(
-Returns a list of `Employee` objects. +Returns a list of `Team` objects.
@@ -33274,19 +33583,12 @@ Returns a list of `Employee` objects. import datetime from merge import Merge -from merge.resources.hris.resources.employees import ( - EmployeesListRequestEmploymentStatus, - EmployeesListRequestExpand, - EmployeesListRequestRemoteFields, - EmployeesListRequestShowEnumOrigins, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employees.list( - company_id="company_id", +client.hris.teams.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -33294,21 +33596,9 @@ client.hris.employees.list( "2024-01-15 09:30:00+00:00", ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - display_full_name="display_full_name", - employee_number="employee_number", - employment_status=EmployeesListRequestEmploymentStatus.ACTIVE, - employment_type="employment_type", - expand=EmployeesListRequestExpand.COMPANY, - first_name="first_name", - groups="groups", - home_location_id="home_location_id", include_deleted_data=True, include_remote_data=True, - include_sensitive_fields=True, include_shell_data=True, - job_title="job_title", - last_name="last_name", - manager_id="manager_id", modified_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -33316,26 +33606,8 @@ client.hris.employees.list( "2024-01-15 09:30:00+00:00", ), page_size=1, - pay_group_id="pay_group_id", - personal_email="personal_email", - remote_fields=EmployeesListRequestRemoteFields.EMPLOYMENT_STATUS, + parent_team_id="parent_team_id", remote_id="remote_id", - show_enum_origins=EmployeesListRequestShowEnumOrigins.EMPLOYMENT_STATUS, - started_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - started_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - team_id="team_id", - terminated_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - terminated_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - work_email="work_email", - work_location_id="work_location_id", ) ``` @@ -33352,7 +33624,7 @@ client.hris.employees.list(
-**company_id:** `typing.Optional[str]` — If provided, will only return employees for this company. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -33360,7 +33632,7 @@ client.hris.employees.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -33368,7 +33640,7 @@ client.hris.employees.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -33376,7 +33648,7 @@ client.hris.employees.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**expand:** `typing.Optional[typing.Literal["parent_team"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -33384,7 +33656,7 @@ client.hris.employees.list(
-**display_full_name:** `typing.Optional[str]` — If provided, will only return employees with this display name. +**include_deleted_data:** `typing.Optional[bool]` — 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/).
@@ -33392,7 +33664,7 @@ client.hris.employees.list(
-**employee_number:** `typing.Optional[str]` — If provided, will only return employees with this employee number. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -33400,13 +33672,15 @@ client.hris.employees.list(
-**employment_status:** `typing.Optional[EmployeesListRequestEmploymentStatus]` +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
-If provided, will only return employees with this employment status. +
+
-* `ACTIVE` - ACTIVE -* `PENDING` - PENDING -* `INACTIVE` - INACTIVE +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -33414,7 +33688,7 @@ If provided, will only return employees with this employment status.
-**employment_type:** `typing.Optional[str]` — If provided, will only return employees that have an employment of the specified employment type. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -33422,7 +33696,7 @@ If provided, will only return employees with this employment status.
-**expand:** `typing.Optional[EmployeesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
@@ -33430,15 +33704,88 @@ If provided, will only return employees with this employment status.
-**first_name:** `typing.Optional[str]` — If provided, will only return employees with this first name. +**parent_team_id:** `typing.Optional[str]` — If provided, will only return teams with this parent team. + +
+
+ +
+
+ +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + + +
+ +
client.hris.teams.retrieve(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a `Team` object with the given `id`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.teams.retrieve( + id="id", + include_remote_data=True, + include_shell_data=True, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
-**groups:** `typing.Optional[str]` — If provided, will only return employees matching the group ids; multiple groups can be separated by commas. +**id:** `str`
@@ -33446,7 +33793,7 @@ If provided, will only return employees with this employment status.
-**home_location_id:** `typing.Optional[str]` — If provided, will only return employees for this home location. +**expand:** `typing.Optional[typing.Literal["parent_team"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -33454,7 +33801,7 @@ If provided, will only return employees with this employment status.
-**include_deleted_data:** `typing.Optional[bool]` — 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:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -33462,7 +33809,7 @@ If provided, will only return employees with this employment status.
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -33470,55 +33817,116 @@ If provided, will only return employees with this employment status.
-**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). -
+
+## Hris TimeOff +
client.hris.time_off.list(...)
-**job_title:** `typing.Optional[str]` — If provided, will only return employees that have an employment of the specified job title. - -
-
+#### 📝 Description
-**last_name:** `typing.Optional[str]` — If provided, will only return employees with this last name. - -
-
-
-**manager_id:** `typing.Optional[str]` — If provided, will only return employees for this manager. - +Returns a list of `TimeOff` objects.
+ + + +#### 🔌 Usage
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - +
+
+ +```python +import datetime + +from merge import Merge +from merge.resources.hris.resources.time_off import ( + TimeOffListRequestExpand, + TimeOffListRequestRemoteFields, + TimeOffListRequestRequestType, + TimeOffListRequestShowEnumOrigins, + TimeOffListRequestStatus, +) + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.time_off.list( + approver_id="approver_id", + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + employee_id="employee_id", + ended_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + ended_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + expand=TimeOffListRequestExpand.APPROVER, + include_deleted_data=True, + include_remote_data=True, + include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + page_size=1, + remote_fields=TimeOffListRequestRemoteFields.REQUEST_TYPE, + remote_id="remote_id", + request_type=TimeOffListRequestRequestType.BEREAVEMENT, + show_enum_origins=TimeOffListRequestShowEnumOrigins.REQUEST_TYPE, + started_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + started_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + status=TimeOffListRequestStatus.APPROVED, +) + +``` +
+
+#### ⚙️ Parameters +
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +
+
+ +**approver_id:** `typing.Optional[str]` — If provided, will only return time off for this approver.
@@ -33526,7 +33934,7 @@ If provided, will only return employees with this employment status.
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -33534,7 +33942,7 @@ If provided, will only return employees with this employment status.
-**pay_group_id:** `typing.Optional[str]` — If provided, will only return employees for this pay group +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -33542,7 +33950,7 @@ If provided, will only return employees with this employment status.
-**personal_email:** `typing.Optional[str]` — If provided, will only return Employees with this personal email +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -33550,7 +33958,7 @@ If provided, will only return employees with this employment status.
-**remote_fields:** `typing.Optional[EmployeesListRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**employee_id:** `typing.Optional[str]` — If provided, will only return time off for this employee.
@@ -33558,7 +33966,7 @@ If provided, will only return employees with this employment status.
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that ended after this datetime.
@@ -33566,7 +33974,7 @@ If provided, will only return employees with this employment status.
-**show_enum_origins:** `typing.Optional[EmployeesListRequestShowEnumOrigins]` — 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) +**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return time-offs that ended before this datetime.
@@ -33574,7 +33982,7 @@ If provided, will only return employees with this employment status.
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that started after this datetime. +**expand:** `typing.Optional[TimeOffListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -33582,7 +33990,7 @@ If provided, will only return employees with this employment status.
-**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return employees that started before this datetime. +**include_deleted_data:** `typing.Optional[bool]` — 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/).
@@ -33590,7 +33998,7 @@ If provided, will only return employees with this employment status.
-**team_id:** `typing.Optional[str]` — If provided, will only return employees for this team. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -33598,7 +34006,7 @@ If provided, will only return employees with this employment status.
-**terminated_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that were terminated after this datetime. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -33606,7 +34014,7 @@ If provided, will only return employees with this employment status.
-**terminated_before:** `typing.Optional[dt.datetime]` — If provided, will only return employees that were terminated before this datetime. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -33614,7 +34022,7 @@ If provided, will only return employees with this employment status.
-**work_email:** `typing.Optional[str]` — If provided, will only return Employees with this work email +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -33622,7 +34030,7 @@ If provided, will only return employees with this employment status.
-**work_location_id:** `typing.Optional[str]` — If provided, will only return employees for this location. +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
@@ -33630,73 +34038,48 @@ If provided, will only return employees with this employment status.
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**remote_fields:** `typing.Optional[TimeOffListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
-
-
+
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +
-
-
client.hris.employees.create(...)
-#### 📝 Description - -
-
+**request_type:** `typing.Optional[TimeOffListRequestRequestType]` -
-
+If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') -Creates an `Employee` object with the given values. -
-
+* `VACATION` - VACATION +* `SICK` - SICK +* `PERSONAL` - PERSONAL +* `JURY_DUTY` - JURY_DUTY +* `VOLUNTEER` - VOLUNTEER +* `BEREAVEMENT` - BEREAVEMENT +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge -from merge.resources.hris import EmployeeRequest - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.employees.create( - is_debug_mode=True, - run_async=True, - model=EmployeeRequest(), -) - -``` -
-
+**show_enum_origins:** `typing.Optional[TimeOffListRequestShowEnumOrigins]` — 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) +
-#### ⚙️ Parameters - -
-
-
-**model:** `EmployeeRequest` +**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return time-offs that started after this datetime.
@@ -33704,7 +34087,7 @@ client.hris.employees.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return time-offs that started before this datetime.
@@ -33712,7 +34095,15 @@ client.hris.employees.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**status:** `typing.Optional[TimeOffListRequestStatus]` + +If provided, will only return TimeOff with this status. Options: ('REQUESTED', 'APPROVED', 'DECLINED', 'CANCELLED', 'DELETED') + +* `REQUESTED` - REQUESTED +* `APPROVED` - APPROVED +* `DECLINED` - DECLINED +* `CANCELLED` - CANCELLED +* `DELETED` - DELETED
@@ -33732,7 +34123,7 @@ client.hris.employees.create(
-
client.hris.employees.retrieve(...) +
client.hris.time_off.create(...)
@@ -33744,7 +34135,7 @@ client.hris.employees.create(
-Returns an `Employee` object with the given `id`. +Creates a `TimeOff` object with the given values.
@@ -33760,73 +34151,33 @@ Returns an `Employee` object with the given `id`. ```python from merge import Merge -from merge.resources.hris.resources.employees import ( - EmployeesRetrieveRequestExpand, - EmployeesRetrieveRequestRemoteFields, - EmployeesRetrieveRequestShowEnumOrigins, -) +from merge.resources.hris import TimeOffRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employees.retrieve( - id="id", - expand=EmployeesRetrieveRequestExpand.COMPANY, - include_remote_data=True, - include_sensitive_fields=True, - include_shell_data=True, - remote_fields=EmployeesRetrieveRequestRemoteFields.EMPLOYMENT_STATUS, - show_enum_origins=EmployeesRetrieveRequestShowEnumOrigins.EMPLOYMENT_STATUS, +client.hris.time_off.create( + is_debug_mode=True, + run_async=True, + model=TimeOffRequest(), ) -``` - -
- - - -#### ⚙️ Parameters - -
-
- -
-
- -**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[EmployeesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - +``` +
+
+#### ⚙️ Parameters +
-**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response. - -
-
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**model:** `TimeOffRequest`
@@ -33834,7 +34185,7 @@ client.hris.employees.retrieve(
-**remote_fields:** `typing.Optional[EmployeesRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -33842,7 +34193,7 @@ client.hris.employees.retrieve(
-**show_enum_origins:** `typing.Optional[EmployeesRetrieveRequestShowEnumOrigins]` — 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) +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -33862,7 +34213,7 @@ client.hris.employees.retrieve(
-
client.hris.employees.ignore_create(...) +
client.hris.time_off.retrieve(...)
@@ -33874,7 +34225,7 @@ client.hris.employees.retrieve(
-Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes. +Returns a `TimeOff` object with the given `id`.
@@ -33890,15 +34241,23 @@ Ignores a specific row based on the `model_id` in the url. These records will ha ```python from merge import Merge -from merge.resources.hris import ReasonEnum +from merge.resources.hris.resources.time_off import ( + TimeOffRetrieveRequestExpand, + TimeOffRetrieveRequestRemoteFields, + TimeOffRetrieveRequestShowEnumOrigins, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employees.ignore_create( - model_id="model_id", - reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, +client.hris.time_off.retrieve( + id="id", + expand=TimeOffRetrieveRequestExpand.APPROVER, + include_remote_data=True, + include_shell_data=True, + remote_fields=TimeOffRetrieveRequestRemoteFields.REQUEST_TYPE, + show_enum_origins=TimeOffRetrieveRequestShowEnumOrigins.REQUEST_TYPE, ) ``` @@ -33915,7 +34274,7 @@ client.hris.employees.ignore_create(
-**model_id:** `str` +**id:** `str`
@@ -33923,7 +34282,7 @@ client.hris.employees.ignore_create(
-**reason:** `IgnoreCommonModelRequestReason` +**expand:** `typing.Optional[TimeOffRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -33931,7 +34290,31 @@ client.hris.employees.ignore_create(
-**message:** `typing.Optional[str]` +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+ +
+
+ +**remote_fields:** `typing.Optional[TimeOffRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[TimeOffRetrieveRequestShowEnumOrigins]` — 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)
@@ -33951,7 +34334,7 @@ client.hris.employees.ignore_create(
-
client.hris.employees.meta_post_retrieve() +
client.hris.time_off.meta_post_retrieve()
@@ -33963,7 +34346,7 @@ client.hris.employees.ignore_create(
-Returns metadata for `Employee` POSTs. +Returns metadata for `TimeOff` POSTs.
@@ -33984,7 +34367,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employees.meta_post_retrieve() +client.hris.time_off.meta_post_retrieve() ``` @@ -34012,8 +34395,8 @@ client.hris.employees.meta_post_retrieve()
-## Hris EmployerBenefits -
client.hris.employer_benefits.list(...) +## Hris TimeOffBalances +
client.hris.time_off_balances.list(...)
@@ -34025,7 +34408,7 @@ client.hris.employees.meta_post_retrieve()
-Returns a list of `EmployerBenefit` objects. +Returns a list of `TimeOffBalance` objects.
@@ -34043,12 +34426,15 @@ Returns a list of `EmployerBenefit` objects. import datetime from merge import Merge +from merge.resources.hris.resources.time_off_balances import ( + TimeOffBalancesListRequestPolicyType, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employer_benefits.list( +client.hris.time_off_balances.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -34056,6 +34442,7 @@ client.hris.employer_benefits.list( "2024-01-15 09:30:00+00:00", ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + employee_id="employee_id", include_deleted_data=True, include_remote_data=True, include_shell_data=True, @@ -34066,6 +34453,7 @@ client.hris.employer_benefits.list( "2024-01-15 09:30:00+00:00", ), page_size=1, + policy_type=TimeOffBalancesListRequestPolicyType.BEREAVEMENT, remote_id="remote_id", ) @@ -34107,6 +34495,22 @@ client.hris.employer_benefits.list(
+**employee_id:** `typing.Optional[str]` — If provided, will only return time off balances for this employee. + +
+
+ +
+
+ +**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ **include_deleted_data:** `typing.Optional[bool]` — 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/).
@@ -34155,6 +34559,31 @@ client.hris.employer_benefits.list(
+**policy_type:** `typing.Optional[TimeOffBalancesListRequestPolicyType]` + +If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') + +* `VACATION` - VACATION +* `SICK` - SICK +* `PERSONAL` - PERSONAL +* `JURY_DUTY` - JURY_DUTY +* `VOLUNTEER` - VOLUNTEER +* `BEREAVEMENT` - BEREAVEMENT + +
+
+ +
+
+ +**remote_fields:** `typing.Optional[typing.Literal["policy_type"]]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ **remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -34163,6 +34592,14 @@ client.hris.employer_benefits.list(
+**show_enum_origins:** `typing.Optional[typing.Literal["policy_type"]]` — 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) + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -34175,7 +34612,7 @@ client.hris.employer_benefits.list(
-
client.hris.employer_benefits.retrieve(...) +
client.hris.time_off_balances.retrieve(...)
@@ -34187,7 +34624,7 @@ client.hris.employer_benefits.list(
-Returns an `EmployerBenefit` object with the given `id`. +Returns a `TimeOffBalance` object with the given `id`.
@@ -34208,7 +34645,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employer_benefits.retrieve( +client.hris.time_off_balances.retrieve( id="id", include_remote_data=True, include_shell_data=True, @@ -34236,6 +34673,14 @@ client.hris.employer_benefits.retrieve(
+**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ **include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -34252,6 +34697,22 @@ client.hris.employer_benefits.retrieve(
+**remote_fields:** `typing.Optional[typing.Literal["policy_type"]]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[typing.Literal["policy_type"]]` — 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) + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -34264,8 +34725,8 @@ client.hris.employer_benefits.retrieve(
-## Hris Employments -
client.hris.employments.list(...) +## Hris TimesheetEntries +
client.hris.timesheet_entries.list(...)
@@ -34277,7 +34738,7 @@ client.hris.employer_benefits.retrieve(
-Returns a list of `Employment` objects. +Returns a list of `TimesheetEntry` objects.
@@ -34295,18 +34756,15 @@ Returns a list of `Employment` objects. import datetime from merge import Merge -from merge.resources.hris.resources.employments import ( - EmploymentsListRequestExpand, - EmploymentsListRequestOrderBy, - EmploymentsListRequestRemoteFields, - EmploymentsListRequestShowEnumOrigins, +from merge.resources.hris.resources.timesheet_entries import ( + TimesheetEntriesListRequestOrderBy, ) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employments.list( +client.hris.timesheet_entries.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -34315,7 +34773,12 @@ client.hris.employments.list( ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", employee_id="employee_id", - expand=EmploymentsListRequestExpand.EMPLOYEE, + ended_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + ended_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), include_deleted_data=True, include_remote_data=True, include_shell_data=True, @@ -34325,11 +34788,15 @@ client.hris.employments.list( modified_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - order_by=EmploymentsListRequestOrderBy.EFFECTIVE_DATE_DESCENDING, + order_by=TimesheetEntriesListRequestOrderBy.START_TIME_DESCENDING, page_size=1, - remote_fields=EmploymentsListRequestRemoteFields.EMPLOYMENT_TYPE, remote_id="remote_id", - show_enum_origins=EmploymentsListRequestShowEnumOrigins.EMPLOYMENT_TYPE, + started_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + started_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), ) ``` @@ -34340,69 +34807,13 @@ client.hris.employments.list( #### ⚙️ Parameters -
-
- -
-
- -**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. - -
-
- -
-
- -**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. - -
-
- -
-
- -**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**employee_id:** `typing.Optional[str]` — If provided, will only return employments for this employee. - -
-
- -
-
- -**expand:** `typing.Optional[EmploymentsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- -**include_deleted_data:** `typing.Optional[bool]` — 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:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
+
+
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -34410,7 +34821,7 @@ client.hris.employments.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -34418,7 +34829,7 @@ client.hris.employments.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -34426,7 +34837,7 @@ client.hris.employments.list(
-**order_by:** `typing.Optional[EmploymentsListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: effective_date, -effective_date. +**employee_id:** `typing.Optional[str]` — If provided, will only return timesheet entries for this employee.
@@ -34434,7 +34845,7 @@ client.hris.employments.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries ended after this datetime.
@@ -34442,7 +34853,7 @@ client.hris.employments.list(
-**remote_fields:** `typing.Optional[EmploymentsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries ended before this datetime.
@@ -34450,7 +34861,7 @@ client.hris.employments.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -34458,7 +34869,7 @@ client.hris.employments.list(
-**show_enum_origins:** `typing.Optional[EmploymentsListRequestShowEnumOrigins]` — 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) +**include_deleted_data:** `typing.Optional[bool]` — 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/).
@@ -34466,80 +34877,31 @@ client.hris.employments.list(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
- - -
-
-
- -
client.hris.employments.retrieve(...) -
-
- -#### 📝 Description - -
-
-Returns an `Employment` object with the given `id`. -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge -from merge.resources.hris.resources.employments import ( - EmploymentsRetrieveRequestExpand, - EmploymentsRetrieveRequestRemoteFields, - EmploymentsRetrieveRequestShowEnumOrigins, -) - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.employments.retrieve( - id="id", - expand=EmploymentsRetrieveRequestExpand.EMPLOYEE, - include_remote_data=True, - include_shell_data=True, - remote_fields=EmploymentsRetrieveRequestRemoteFields.EMPLOYMENT_TYPE, - show_enum_origins=EmploymentsRetrieveRequestShowEnumOrigins.EMPLOYMENT_TYPE, -) - -``` -
-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +
-#### ⚙️ Parameters - -
-
-
-**id:** `str` +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -34547,7 +34909,7 @@ client.hris.employments.retrieve(
-**expand:** `typing.Optional[EmploymentsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**order_by:** `typing.Optional[TimesheetEntriesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: start_time, -start_time.
@@ -34555,7 +34917,7 @@ client.hris.employments.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
@@ -34563,7 +34925,7 @@ client.hris.employments.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -34571,7 +34933,7 @@ client.hris.employments.retrieve(
-**remote_fields:** `typing.Optional[EmploymentsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries started after this datetime.
@@ -34579,7 +34941,7 @@ client.hris.employments.retrieve(
-**show_enum_origins:** `typing.Optional[EmploymentsRetrieveRequestShowEnumOrigins]` — 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_before:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries started before this datetime.
@@ -34599,8 +34961,7 @@ client.hris.employments.retrieve(
-## Hris FieldMapping -
client.hris.field_mapping.field_mappings_retrieve(...) +
client.hris.timesheet_entries.create(...)
@@ -34612,7 +34973,7 @@ client.hris.employments.retrieve(
-Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/). +Creates a `TimesheetEntry` object with the given values.
@@ -34628,13 +34989,16 @@ Get all Field Mappings for this Linked Account. Field Mappings are mappings betw ```python from merge import Merge +from merge.resources.hris import TimesheetEntryRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.field_mapping.field_mappings_retrieve( - exclude_remote_field_metadata=True, +client.hris.timesheet_entries.create( + is_debug_mode=True, + run_async=True, + model=TimesheetEntryRequest(), ) ``` @@ -34651,7 +35015,23 @@ client.hris.field_mapping.field_mappings_retrieve(
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. +**model:** `TimesheetEntryRequest` + +
+
+ +
+
+ +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. + +
+
+ +
+
+ +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -34671,7 +35051,7 @@ client.hris.field_mapping.field_mappings_retrieve(
-
client.hris.field_mapping.field_mappings_create(...) +
client.hris.timesheet_entries.retrieve(...)
@@ -34683,7 +35063,7 @@ client.hris.field_mapping.field_mappings_retrieve(
-Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start. +Returns a `TimesheetEntry` object with the given `id`.
@@ -34704,14 +35084,10 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.field_mapping.field_mappings_create( - exclude_remote_field_metadata=True, - target_field_name="example_target_field_name", - target_field_description="this is a example description of the target field", - remote_field_traversal_path=["example_remote_field"], - remote_method="GET", - remote_url_path="/example-url-path", - common_model_name="ExampleCommonModel", +client.hris.timesheet_entries.retrieve( + id="id", + include_remote_data=True, + include_shell_data=True, ) ``` @@ -34728,39 +35104,7 @@ client.hris.field_mapping.field_mappings_create(
-**target_field_name:** `str` — The name of the target field you want this remote field to map to. - -
-
- -
-
- -**target_field_description:** `str` — The description of the target field you want this remote field to map to. - -
-
- -
-
- -**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. - -
-
- -
-
- -**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from. - -
-
- -
-
- -**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from. +**id:** `str`
@@ -34768,7 +35112,7 @@ client.hris.field_mapping.field_mappings_create(
-**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category. +**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -34776,7 +35120,7 @@ client.hris.field_mapping.field_mappings_create(
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -34784,7 +35128,7 @@ client.hris.field_mapping.field_mappings_create(
-**jmes_path:** `typing.Optional[str]` — JMES path to specify json query expression to be used on field mapping. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -34804,7 +35148,7 @@ client.hris.field_mapping.field_mappings_create(
-
client.hris.field_mapping.field_mappings_destroy(...) +
client.hris.timesheet_entries.meta_post_retrieve()
@@ -34816,7 +35160,7 @@ client.hris.field_mapping.field_mappings_create(
-Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start. +Returns metadata for `TimesheetEntry` POSTs.
@@ -34837,9 +35181,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.field_mapping.field_mappings_destroy( - field_mapping_id="field_mapping_id", -) +client.hris.timesheet_entries.meta_post_retrieve() ``` @@ -34855,14 +35197,6 @@ client.hris.field_mapping.field_mappings_destroy(
-**field_mapping_id:** `str` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -34875,7 +35209,8 @@ client.hris.field_mapping.field_mappings_destroy(
-
client.hris.field_mapping.field_mappings_partial_update(...) +## Hris WebhookReceivers +
client.hris.webhook_receivers.list()
@@ -34887,7 +35222,7 @@ client.hris.field_mapping.field_mappings_destroy(
-Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start. +Returns a list of `WebhookReceiver` objects.
@@ -34908,9 +35243,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.field_mapping.field_mappings_partial_update( - field_mapping_id="field_mapping_id", -) +client.hris.webhook_receivers.list() ``` @@ -34926,46 +35259,6 @@ client.hris.field_mapping.field_mappings_partial_update(
-**field_mapping_id:** `str` - -
-
- -
-
- -**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. - -
-
- -
-
- -**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from. - -
-
- -
-
- -**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from. - -
-
- -
-
- -**jmes_path:** `typing.Optional[str]` — JMES path to specify json query expression to be used on field mapping. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -34978,7 +35271,7 @@ client.hris.field_mapping.field_mappings_partial_update(
-
client.hris.field_mapping.remote_fields_retrieve(...) +
client.hris.webhook_receivers.create(...)
@@ -34990,7 +35283,7 @@ client.hris.field_mapping.field_mappings_partial_update(
-Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/). +Creates a `WebhookReceiver` object with the given values.
@@ -35011,9 +35304,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.field_mapping.remote_fields_retrieve( - common_models="common_models", - include_example_values="include_example_values", +client.hris.webhook_receivers.create( + event="event", + is_active=True, ) ``` @@ -35030,7 +35323,15 @@ client.hris.field_mapping.remote_fields_retrieve(
-**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models. +**event:** `str` + +
+
+ +
+
+ +**is_active:** `bool`
@@ -35038,7 +35339,7 @@ client.hris.field_mapping.remote_fields_retrieve(
-**include_example_values:** `typing.Optional[str]` — If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers. +**key:** `typing.Optional[str]`
@@ -35058,7 +35359,8 @@ client.hris.field_mapping.remote_fields_retrieve(
-
client.hris.field_mapping.target_fields_retrieve() +## Knowledgebase AccountDetails +
client.knowledgebase.account_details.retrieve()
@@ -35070,7 +35372,7 @@ client.hris.field_mapping.remote_fields_retrieve(
-Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/). +Get details for a linked account.
@@ -35091,7 +35393,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.field_mapping.target_fields_retrieve() +client.knowledgebase.account_details.retrieve() ``` @@ -35119,8 +35421,8 @@ client.hris.field_mapping.target_fields_retrieve()
-## Hris GenerateKey -
client.hris.generate_key.create(...) +## Knowledgebase AccountToken +
client.knowledgebase.account_token.retrieve(...)
@@ -35132,7 +35434,7 @@ client.hris.field_mapping.target_fields_retrieve()
-Create a remote key. +Returns the account token for the end user with the provided public token.
@@ -35153,8 +35455,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.generate_key.create( - name="Remote Deployment Key 1", +client.knowledgebase.account_token.retrieve( + public_token="public_token", ) ``` @@ -35171,7 +35473,7 @@ client.hris.generate_key.create(
-**name:** `str` — The name of the remote key +**public_token:** `str`
@@ -35191,8 +35493,8 @@ client.hris.generate_key.create(
-## Hris Groups -
client.hris.groups.list(...) +## Knowledgebase Articles +
client.knowledgebase.articles.list(...)
@@ -35204,7 +35506,7 @@ client.hris.generate_key.create(
-Returns a list of `Group` objects. +Returns a list of `Article` objects.
@@ -35222,12 +35524,16 @@ Returns a list of `Group` objects. import datetime from merge import Merge +from merge.resources.knowledgebase.resources.articles import ( + ArticlesListRequestExpand, + ArticlesListRequestType, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.groups.list( +client.knowledgebase.articles.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -35235,20 +35541,23 @@ client.hris.groups.list( "2024-01-15 09:30:00+00:00", ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + expand=ArticlesListRequestExpand.ATTACHMENTS, include_deleted_data=True, include_remote_data=True, include_shell_data=True, - is_commonly_used_as_team="is_commonly_used_as_team", modified_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), modified_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - names="names", page_size=1, + parent_article_id="parent_article_id", + parent_container_id="parent_container_id", remote_id="remote_id", - types="types", + root_container_id="root_container_id", + status="status", + type=ArticlesListRequestType.EMPTY, ) ``` @@ -35289,7 +35598,7 @@ client.hris.groups.list(
-**include_deleted_data:** `typing.Optional[bool]` — 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/). +**expand:** `typing.Optional[ArticlesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -35297,7 +35606,7 @@ client.hris.groups.list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**include_deleted_data:** `typing.Optional[bool]` — 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/).
@@ -35305,7 +35614,7 @@ client.hris.groups.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -35313,7 +35622,7 @@ client.hris.groups.list(
-**is_commonly_used_as_team:** `typing.Optional[str]` — If provided, specifies whether to return only Group objects which refer to a team in the third party platform. Note that this is an opinionated view based on how a team may be represented in the third party platform. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -35337,7 +35646,7 @@ client.hris.groups.list(
-**names:** `typing.Optional[str]` — If provided, will only return groups with these names. Multiple values can be separated by commas. +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
@@ -35345,7 +35654,7 @@ client.hris.groups.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +**parent_article_id:** `typing.Optional[str]` — If provided, will only return sub articles of the parent_article_id.
@@ -35353,7 +35662,7 @@ client.hris.groups.list(
-**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins. +**parent_container_id:** `typing.Optional[str]` — If provided, will only return sub articles of the parent_container_id.
@@ -35369,7 +35678,7 @@ client.hris.groups.list(
-**show_enum_origins:** `typing.Optional[typing.Literal["type"]]` — 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) +**root_container_id:** `typing.Optional[str]` — If provided, will only return sub articles of the root_container_id.
@@ -35377,7 +35686,15 @@ client.hris.groups.list(
-**types:** `typing.Optional[str]` — If provided, will only return groups of these types. Multiple values can be separated by commas. +**status:** `typing.Optional[str]` — If provided, will only return articles of the given status; multiple statuses can be separated by commas. + +
+
+ +
+
+ +**type:** `typing.Optional[ArticlesListRequestType]` — If provided, will only return articles of the given type.
@@ -35397,7 +35714,7 @@ client.hris.groups.list(
-
client.hris.groups.retrieve(...) +
client.knowledgebase.articles.retrieve(...)
@@ -35409,7 +35726,7 @@ client.hris.groups.list(
-Returns a `Group` object with the given `id`. +Returns an `Article` object with the given `id`.
@@ -35425,13 +35742,17 @@ Returns a `Group` object with the given `id`. ```python from merge import Merge +from merge.resources.knowledgebase.resources.articles import ( + ArticlesRetrieveRequestExpand, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.groups.retrieve( +client.knowledgebase.articles.retrieve( id="id", + expand=ArticlesRetrieveRequestExpand.ATTACHMENTS, include_remote_data=True, include_shell_data=True, ) @@ -35458,15 +35779,7 @@ client.hris.groups.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**expand:** `typing.Optional[ArticlesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -35474,7 +35787,7 @@ client.hris.groups.retrieve(
-**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -35482,7 +35795,7 @@ client.hris.groups.retrieve(
-**show_enum_origins:** `typing.Optional[typing.Literal["type"]]` — 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) +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -35502,8 +35815,8 @@ client.hris.groups.retrieve(
-## Hris Issues -
client.hris.issues.list(...) +## Knowledgebase AsyncPassthrough +
client.knowledgebase.async_passthrough.create(...)
@@ -35515,7 +35828,7 @@ client.hris.groups.retrieve(
-Gets all issues for Organization. +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -35530,38 +35843,18 @@ Gets all issues for Organization.
```python -import datetime - from merge import Merge -from merge.resources.hris.resources.issues import IssuesListRequestStatus +from merge.resources.knowledgebase import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.issues.list( - account_token="account_token", - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - end_date="end_date", - end_user_organization_name="end_user_organization_name", - first_incident_time_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - first_incident_time_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - include_muted="include_muted", - integration_name="integration_name", - last_incident_time_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - last_incident_time_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", +client.knowledgebase.async_passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", ), - linked_account_id="linked_account_id", - page_size=1, - start_date="start_date", - status=IssuesListRequestStatus.ONGOING, ) ``` @@ -35578,116 +35871,7 @@ client.hris.issues.list(
-**account_token:** `typing.Optional[str]` - -
-
- -
-
- -**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time - -
-
- -
-
- -**end_user_organization_name:** `typing.Optional[str]` - -
-
- -
-
- -**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime. - -
-
- -
-
- -**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime. - -
-
- -
-
- -**include_muted:** `typing.Optional[str]` — If true, will include muted issues - -
-
- -
-
- -**integration_name:** `typing.Optional[str]` - -
-
- -
-
- -**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime. - -
-
- -
-
- -**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime. - -
-
- -
-
- -**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in. - -
-
- -
-
- -**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. - -
-
- -
-
- -**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time - -
-
- -
-
- -**status:** `typing.Optional[IssuesListRequestStatus]` - -Status of the issue. Options: ('ONGOING', 'RESOLVED') - -* `ONGOING` - ONGOING -* `RESOLVED` - RESOLVED +**request:** `DataPassthroughRequest`
@@ -35707,7 +35891,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
client.hris.issues.retrieve(...) +
client.knowledgebase.async_passthrough.retrieve(...)
@@ -35719,7 +35903,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-Get a specific issue. +Retrieves data from earlier async-passthrough POST request
@@ -35740,8 +35924,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.issues.retrieve( - id="id", +client.knowledgebase.async_passthrough.retrieve( + async_passthrough_receipt_id="async_passthrough_receipt_id", ) ``` @@ -35758,7 +35942,7 @@ client.hris.issues.retrieve(
-**id:** `str` +**async_passthrough_receipt_id:** `str`
@@ -35778,8 +35962,8 @@ client.hris.issues.retrieve(
-## Hris LinkToken -
client.hris.link_token.create(...) +## Knowledgebase Attachments +
client.knowledgebase.attachments.list(...)
@@ -35791,7 +35975,7 @@ client.hris.issues.retrieve(
-Creates a link token to be used when linking a new end user. +Returns a list of `Attachment` objects.
@@ -35806,18 +35990,33 @@ Creates a link token to be used when linking a new end user.
```python +import datetime + from merge import Merge -from merge.resources.hris import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.link_token.create( - end_user_email_address="example@gmail.com", - end_user_organization_name="Test Organization", - end_user_origin_id="12345", - categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS], +client.knowledgebase.attachments.list( + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + include_deleted_data=True, + include_remote_data=True, + include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + page_size=1, + remote_id="remote_id", ) ``` @@ -35834,7 +36033,7 @@ client.hris.link_token.create(
-**end_user_email_address:** `str` — Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -35842,7 +36041,7 @@ client.hris.link_token.create(
-**end_user_organization_name:** `str` — Your end user's organization. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -35850,7 +36049,7 @@ client.hris.link_token.create(
-**end_user_origin_id:** `str` — This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -35858,7 +36057,7 @@ client.hris.link_token.create(
-**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link. +**include_deleted_data:** `typing.Optional[bool]` — 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/).
@@ -35866,7 +36065,7 @@ client.hris.link_token.create(
-**integration:** `typing.Optional[str]` — The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -35874,7 +36073,7 @@ client.hris.link_token.create(
-**link_expiry_mins:** `typing.Optional[int]` — An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -35882,7 +36081,7 @@ client.hris.link_token.create(
-**should_create_magic_link_url:** `typing.Optional[bool]` — Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -35890,7 +36089,7 @@ client.hris.link_token.create(
-**hide_admin_magic_link:** `typing.Optional[bool]` — Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -35898,7 +36097,7 @@ client.hris.link_token.create(
-**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account. +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
@@ -35906,14 +36105,7 @@ client.hris.link_token.create(
-**category_common_model_scopes:** `typing.Optional[ - typing.Dict[ - str, - typing.Optional[ - typing.Sequence[IndividualCommonModelScopeDeserializerRequest] - ], - ] -]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -35921,28 +36113,72 @@ client.hris.link_token.create(
-**language:** `typing.Optional[EndUserDetailsRequestLanguage]` +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
-The following subset of IETF language tags can be used to configure localization. -* `en` - en -* `de` - de - +
+
client.knowledgebase.attachments.retrieve(...)
-**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled. - +#### 📝 Description + +
+
+ +
+
+ +Returns an `Attachment` object with the given `id`. +
+
+#### 🔌 Usage +
-**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options. +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.knowledgebase.attachments.retrieve( + id="id", + include_remote_data=True, + include_shell_data=True, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `str`
@@ -35950,11 +36186,15 @@ The following subset of IETF language tags can be used to configure localization
-**completed_account_initial_screen:** `typing.Optional[EndUserDetailsRequestCompletedAccountInitialScreen]` +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
-When creating a Link token, you can specifiy the initial screen of Linking Flow for a completed Linked Account. +
+
-* `SELECTIVE_SYNC` - SELECTIVE_SYNC +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -35974,8 +36214,8 @@ When creating a Link token, you can specifiy the initial screen of Linking Flow
-## Hris LinkedAccounts -
client.hris.linked_accounts.list(...) +## Knowledgebase AuditTrail +
client.knowledgebase.audit_trail.list(...)
@@ -35987,7 +36227,7 @@ When creating a Link token, you can specifiy the initial screen of Linking Flow
-List linked accounts for your organization. +Gets a list of audit trail events.
@@ -36003,28 +36243,18 @@ List linked accounts for your organization. ```python from merge import Merge -from merge.resources.hris.resources.linked_accounts import ( - LinkedAccountsListRequestCategory, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.linked_accounts.list( - category=LinkedAccountsListRequestCategory.ACCOUNTING, +client.knowledgebase.audit_trail.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - end_user_email_address="end_user_email_address", - end_user_organization_name="end_user_organization_name", - end_user_origin_id="end_user_origin_id", - end_user_origin_ids="end_user_origin_ids", - id="id", - ids="ids", - include_duplicates=True, - integration_name="integration_name", - is_test_account="is_test_account", + end_date="end_date", + event_type="event_type", page_size=1, - status="status", + start_date="start_date", + user_email="user_email", ) ``` @@ -36041,17 +36271,7 @@ client.hris.linked_accounts.list(
-**category:** `typing.Optional[LinkedAccountsListRequestCategory]` - -Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing` - -* `hris` - hris -* `ats` - ats -* `accounting` - accounting -* `ticketing` - ticketing -* `crm` - crm -* `mktg` - mktg -* `filestorage` - filestorage +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -36059,7 +36279,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
@@ -36067,7 +36287,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address. +**event_type:** `typing.Optional[str]` — If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`
@@ -36075,7 +36295,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -36083,7 +36303,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID. +**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
@@ -36091,7 +36311,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. +**user_email:** `typing.Optional[str]` — If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email.
@@ -36099,58 +36319,64 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**id:** `typing.Optional[str]` +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. -
+
+## Knowledgebase AvailableActions +
client.knowledgebase.available_actions.retrieve()
-**include_duplicates:** `typing.Optional[bool]` — If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account. - -
-
+#### 📝 Description
-**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name. - -
-
-
-**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts. - +Returns a list of models and actions available for an account. +
+
+#### 🔌 Usage +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. - -
-
-
-**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED` - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.knowledgebase.available_actions.retrieve() + +```
+ + + +#### ⚙️ Parameters + +
+
@@ -36167,8 +36393,8 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Hris Locations -
client.hris.locations.list(...) +## Knowledgebase Containers +
client.knowledgebase.containers.list(...)
@@ -36180,7 +36406,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-Returns a list of `Location` objects. +Returns a list of `Container` objects.
@@ -36198,17 +36424,16 @@ Returns a list of `Location` objects. import datetime from merge import Merge -from merge.resources.hris.resources.locations import ( - LocationsListRequestLocationType, - LocationsListRequestRemoteFields, - LocationsListRequestShowEnumOrigins, +from merge.resources.knowledgebase.resources.containers import ( + ContainersListRequestExpand, + ContainersListRequestType, ) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.locations.list( +client.knowledgebase.containers.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -36216,10 +36441,10 @@ client.hris.locations.list( "2024-01-15 09:30:00+00:00", ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + expand=ContainersListRequestExpand.PARENT_ARTICLE, include_deleted_data=True, include_remote_data=True, include_shell_data=True, - location_type=LocationsListRequestLocationType.HOME, modified_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -36227,9 +36452,10 @@ client.hris.locations.list( "2024-01-15 09:30:00+00:00", ), page_size=1, - remote_fields=LocationsListRequestRemoteFields.COUNTRY, + parent_article_id="parent_article_id", + parent_container_id="parent_container_id", remote_id="remote_id", - show_enum_origins=LocationsListRequestShowEnumOrigins.COUNTRY, + type=ContainersListRequestType.EMPTY, ) ``` @@ -36270,6 +36496,14 @@ client.hris.locations.list(
+**expand:** `typing.Optional[ContainersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ **include_deleted_data:** `typing.Optional[bool]` — 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/).
@@ -36294,12 +36528,7 @@ client.hris.locations.list(
-**location_type:** `typing.Optional[LocationsListRequestLocationType]` - -If provided, will only return locations with this location type - -* `HOME` - HOME -* `WORK` - WORK +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -36307,7 +36536,7 @@ If provided, will only return locations with this location type
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -36315,7 +36544,7 @@ If provided, will only return locations with this location type
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
@@ -36323,7 +36552,7 @@ If provided, will only return locations with this location type
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +**parent_article_id:** `typing.Optional[str]` — If provided, will only return sub containers of the parent_article_id.
@@ -36331,7 +36560,7 @@ If provided, will only return locations with this location type
-**remote_fields:** `typing.Optional[LocationsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**parent_container_id:** `typing.Optional[str]` — If provided, will only return sub containers of the parent_container_id.
@@ -36347,7 +36576,7 @@ If provided, will only return locations with this location type
-**show_enum_origins:** `typing.Optional[LocationsListRequestShowEnumOrigins]` — 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) +**type:** `typing.Optional[ContainersListRequestType]` — If provided, will only return containers of the given type.
@@ -36367,7 +36596,7 @@ If provided, will only return locations with this location type
-
client.hris.locations.retrieve(...) +
client.knowledgebase.containers.retrieve(...)
@@ -36379,7 +36608,7 @@ If provided, will only return locations with this location type
-Returns a `Location` object with the given `id`. +Returns a `Container` object with the given `id`.
@@ -36395,21 +36624,19 @@ Returns a `Location` object with the given `id`. ```python from merge import Merge -from merge.resources.hris.resources.locations import ( - LocationsRetrieveRequestRemoteFields, - LocationsRetrieveRequestShowEnumOrigins, +from merge.resources.knowledgebase.resources.containers import ( + ContainersRetrieveRequestExpand, ) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.locations.retrieve( +client.knowledgebase.containers.retrieve( id="id", + expand=ContainersRetrieveRequestExpand.PARENT_ARTICLE, include_remote_data=True, include_shell_data=True, - remote_fields=LocationsRetrieveRequestRemoteFields.COUNTRY, - show_enum_origins=LocationsRetrieveRequestShowEnumOrigins.COUNTRY, ) ``` @@ -36434,15 +36661,7 @@ client.hris.locations.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**expand:** `typing.Optional[ContainersRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -36450,7 +36669,7 @@ client.hris.locations.retrieve(
-**remote_fields:** `typing.Optional[LocationsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -36458,7 +36677,7 @@ client.hris.locations.retrieve(
-**show_enum_origins:** `typing.Optional[LocationsRetrieveRequestShowEnumOrigins]` — 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) +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -36478,8 +36697,8 @@ client.hris.locations.retrieve(
-## Hris Passthrough -
client.hris.passthrough.create(...) +## Knowledgebase Scopes +
client.knowledgebase.scopes.default_scopes_retrieve()
@@ -36491,7 +36710,7 @@ client.hris.locations.retrieve(
-Pull data from an endpoint not currently supported by Merge. +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).
@@ -36507,18 +36726,12 @@ Pull data from an endpoint not currently supported by Merge. ```python from merge import Merge -from merge.resources.hris import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), -) +client.knowledgebase.scopes.default_scopes_retrieve() ``` @@ -36534,14 +36747,6 @@ client.hris.passthrough.create(
-**request:** `DataPassthroughRequest` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -36554,8 +36759,7 @@ client.hris.passthrough.create(
-## Hris PayGroups -
client.hris.pay_groups.list(...) +
client.knowledgebase.scopes.linked_account_scopes_retrieve()
@@ -36567,7 +36771,7 @@ client.hris.passthrough.create(
-Returns a list of `PayGroup` objects. +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).
@@ -36582,34 +36786,13 @@ Returns a list of `PayGroup` objects.
```python -import datetime - from merge import Merge client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.pay_groups.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - include_deleted_data=True, - include_remote_data=True, - include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - page_size=1, - remote_id="remote_id", -) +client.knowledgebase.scopes.linked_account_scopes_retrieve() ```
@@ -36625,79 +36808,99 @@ client.hris.pay_groups.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. -
-
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value. -
+
+
client.knowledgebase.scopes.linked_account_scopes_create(...)
-**include_deleted_data:** `typing.Optional[bool]` — 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/). - -
-
+#### 📝 Description
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - +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) +
+
+#### 🔌 Usage +
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - -
-
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - +```python +from merge import Merge +from merge.resources.knowledgebase import ( + FieldPermissionDeserializerRequest, + IndividualCommonModelScopeDeserializerRequest, + ModelPermissionDeserializerRequest, +) + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.knowledgebase.scopes.linked_account_scopes_create( + common_models=[ + IndividualCommonModelScopeDeserializerRequest( + model_name="Employee", + model_permissions={ + "READ": ModelPermissionDeserializerRequest( + is_enabled=True, + ), + "WRITE": ModelPermissionDeserializerRequest( + is_enabled=False, + ), + }, + field_permissions=FieldPermissionDeserializerRequest( + enabled_fields=["avatar", "home_location"], + disabled_fields=["work_location"], + ), + ), + IndividualCommonModelScopeDeserializerRequest( + model_name="Benefit", + model_permissions={ + "WRITE": ModelPermissionDeserializerRequest( + is_enabled=False, + ) + }, + ), + ], +) + +``` +
+
+#### ⚙️ Parameters +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. - -
-
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
@@ -36717,7 +36920,8 @@ client.hris.pay_groups.list(
-
client.hris.pay_groups.retrieve(...) +## Knowledgebase DeleteAccount +
client.knowledgebase.delete_account.delete()
@@ -36729,7 +36933,7 @@ client.hris.pay_groups.list(
-Returns a `PayGroup` object with the given `id`. +Delete a linked account.
@@ -36750,11 +36954,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.pay_groups.retrieve( - id="id", - include_remote_data=True, - include_shell_data=True, -) +client.knowledgebase.delete_account.delete() ``` @@ -36770,23 +36970,71 @@ client.hris.pay_groups.retrieve(
-**id:** `str` +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + + +
+ +## Knowledgebase FieldMapping +
client.knowledgebase.field_mapping.field_mappings_retrieve(...) +
+
+ +#### 📝 Description
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - +
+
+ +Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/). +
+
+#### 🔌 Usage +
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.knowledgebase.field_mapping.field_mappings_retrieve( + exclude_remote_field_metadata=True, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
@@ -36805,9 +37053,8 @@ client.hris.pay_groups.retrieve(
- -## Hris PayrollRuns -
client.hris.payroll_runs.list(...) + +
client.knowledgebase.field_mapping.field_mappings_create(...)
@@ -36819,7 +37066,7 @@ client.hris.pay_groups.retrieve(
-Returns a list of `PayrollRun` objects. +Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -36834,53 +37081,20 @@ Returns a list of `PayrollRun` objects.
```python -import datetime - from merge import Merge -from merge.resources.hris.resources.payroll_runs import ( - PayrollRunsListRequestRemoteFields, - PayrollRunsListRequestRunType, - PayrollRunsListRequestShowEnumOrigins, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.payroll_runs.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - ended_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - ended_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - include_deleted_data=True, - include_remote_data=True, - include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - page_size=1, - remote_fields=PayrollRunsListRequestRemoteFields.RUN_STATE, - remote_id="remote_id", - run_type=PayrollRunsListRequestRunType.CORRECTION, - show_enum_origins=PayrollRunsListRequestShowEnumOrigins.RUN_STATE, - started_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - started_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), +client.knowledgebase.field_mapping.field_mappings_create( + exclude_remote_field_metadata=True, + target_field_name="example_target_field_name", + target_field_description="this is a example description of the target field", + remote_field_traversal_path=["example_remote_field"], + remote_method="GET", + remote_url_path="/example-url-path", + common_model_name="ExampleCommonModel", ) ``` @@ -36897,7 +37111,7 @@ client.hris.payroll_runs.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**target_field_name:** `str` — The name of the target field you want this remote field to map to.
@@ -36905,7 +37119,7 @@ client.hris.payroll_runs.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**target_field_description:** `str` — The description of the target field you want this remote field to map to.
@@ -36913,7 +37127,7 @@ client.hris.payroll_runs.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
@@ -36921,7 +37135,7 @@ client.hris.payroll_runs.list(
-**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs ended after this datetime. +**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
@@ -36929,7 +37143,7 @@ client.hris.payroll_runs.list(
-**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs ended before this datetime. +**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
@@ -36937,7 +37151,7 @@ client.hris.payroll_runs.list(
-**include_deleted_data:** `typing.Optional[bool]` — 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/). +**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category.
@@ -36945,7 +37159,7 @@ client.hris.payroll_runs.list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
@@ -36953,7 +37167,7 @@ client.hris.payroll_runs.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**jmes_path:** `typing.Optional[str]` — JMES path to specify json query expression to be used on field mapping.
@@ -36961,79 +37175,70 @@ client.hris.payroll_runs.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. -
+
+
client.knowledgebase.field_mapping.field_mappings_destroy(...)
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. - -
-
+#### 📝 Description
-**remote_fields:** `typing.Optional[PayrollRunsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. - -
-
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - +Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+ + + +#### 🔌 Usage
-**run_type:** `typing.Optional[PayrollRunsListRequestRunType]` +
+
-If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS') +```python +from merge import Merge -* `REGULAR` - REGULAR -* `OFF_CYCLE` - OFF_CYCLE -* `CORRECTION` - CORRECTION -* `TERMINATION` - TERMINATION -* `SIGN_ON_BONUS` - SIGN_ON_BONUS - +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.knowledgebase.field_mapping.field_mappings_destroy( + field_mapping_id="field_mapping_id", +) + +```
- -
-
- -**show_enum_origins:** `typing.Optional[PayrollRunsListRequestShowEnumOrigins]` — 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) -
+#### ⚙️ Parameters +
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs started after this datetime. - -
-
-
-**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs started before this datetime. +**field_mapping_id:** `str`
@@ -37053,7 +37258,7 @@ If provided, will only return PayrollRun's with this status. Options: ('REGULAR'
-
client.hris.payroll_runs.retrieve(...) +
client.knowledgebase.field_mapping.field_mappings_partial_update(...)
@@ -37065,7 +37270,7 @@ If provided, will only return PayrollRun's with this status. Options: ('REGULAR'
-Returns a `PayrollRun` object with the given `id`. +Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -37081,21 +37286,13 @@ Returns a `PayrollRun` object with the given `id`. ```python from merge import Merge -from merge.resources.hris.resources.payroll_runs import ( - PayrollRunsRetrieveRequestRemoteFields, - PayrollRunsRetrieveRequestShowEnumOrigins, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.payroll_runs.retrieve( - id="id", - include_remote_data=True, - include_shell_data=True, - remote_fields=PayrollRunsRetrieveRequestRemoteFields.RUN_STATE, - show_enum_origins=PayrollRunsRetrieveRequestShowEnumOrigins.RUN_STATE, +client.knowledgebase.field_mapping.field_mappings_partial_update( + field_mapping_id="field_mapping_id", ) ``` @@ -37112,7 +37309,7 @@ client.hris.payroll_runs.retrieve(
-**id:** `str` +**field_mapping_id:** `str`
@@ -37120,7 +37317,7 @@ client.hris.payroll_runs.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
@@ -37128,7 +37325,7 @@ client.hris.payroll_runs.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
@@ -37136,7 +37333,7 @@ client.hris.payroll_runs.retrieve(
-**remote_fields:** `typing.Optional[PayrollRunsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
@@ -37144,7 +37341,7 @@ client.hris.payroll_runs.retrieve(
-**show_enum_origins:** `typing.Optional[PayrollRunsRetrieveRequestShowEnumOrigins]` — 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) +**jmes_path:** `typing.Optional[str]` — JMES path to specify json query expression to be used on field mapping.
@@ -37164,8 +37361,7 @@ client.hris.payroll_runs.retrieve(
-## Hris RegenerateKey -
client.hris.regenerate_key.create(...) +
client.knowledgebase.field_mapping.remote_fields_retrieve(...)
@@ -37177,7 +37373,7 @@ client.hris.payroll_runs.retrieve(
-Exchange remote keys. +Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
@@ -37198,8 +37394,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.regenerate_key.create( - name="Remote Deployment Key 1", +client.knowledgebase.field_mapping.remote_fields_retrieve( + common_models="common_models", + include_example_values="include_example_values", ) ``` @@ -37216,7 +37413,15 @@ client.hris.regenerate_key.create(
-**name:** `str` — The name of the remote key +**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models. + +
+
+ +
+
+ +**include_example_values:** `typing.Optional[str]` — If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers.
@@ -37236,8 +37441,7 @@ client.hris.regenerate_key.create(
-## Hris SyncStatus -
client.hris.sync_status.list(...) +
client.knowledgebase.field_mapping.target_fields_retrieve()
@@ -37249,7 +37453,7 @@ client.hris.regenerate_key.create(
-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). +Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
@@ -37270,10 +37474,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.sync_status.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - page_size=1, -) +client.knowledgebase.field_mapping.target_fields_retrieve() ``` @@ -37289,22 +37490,6 @@ client.hris.sync_status.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -37317,8 +37502,8 @@ client.hris.sync_status.list(
-## Hris ForceResync -
client.hris.force_resync.sync_status_resync_create() +## Knowledgebase GenerateKey +
client.knowledgebase.generate_key.create(...)
@@ -37330,7 +37515,7 @@ client.hris.sync_status.list(
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers. +Create a remote key.
@@ -37351,7 +37536,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.force_resync.sync_status_resync_create() +client.knowledgebase.generate_key.create( + name="Remote Deployment Key 1", +) ``` @@ -37367,6 +37554,14 @@ client.hris.force_resync.sync_status_resync_create()
+**name:** `str` — The name of the remote key + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -37379,8 +37574,8 @@ client.hris.force_resync.sync_status_resync_create()
-## Hris Teams -
client.hris.teams.list(...) +## Knowledgebase Groups +
client.knowledgebase.groups.list(...)
@@ -37392,7 +37587,7 @@ client.hris.force_resync.sync_status_resync_create()
-Returns a list of `Team` objects. +Returns a list of `Group` objects.
@@ -37410,12 +37605,15 @@ Returns a list of `Team` objects. import datetime from merge import Merge +from merge.resources.knowledgebase.resources.groups import ( + GroupsListRequestExpand, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.teams.list( +client.knowledgebase.groups.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -37423,6 +37621,7 @@ client.hris.teams.list( "2024-01-15 09:30:00+00:00", ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + expand=GroupsListRequestExpand.PARENT_GROUP, include_deleted_data=True, include_remote_data=True, include_shell_data=True, @@ -37433,7 +37632,6 @@ client.hris.teams.list( "2024-01-15 09:30:00+00:00", ), page_size=1, - parent_team_id="parent_team_id", remote_id="remote_id", ) @@ -37475,7 +37673,7 @@ client.hris.teams.list(
-**expand:** `typing.Optional[typing.Literal["parent_team"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[GroupsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -37531,14 +37729,6 @@ client.hris.teams.list(
-**parent_team_id:** `typing.Optional[str]` — If provided, will only return teams with this parent team. - -
-
- -
-
- **remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -37559,7 +37749,7 @@ client.hris.teams.list(
-
client.hris.teams.retrieve(...) +
client.knowledgebase.groups.retrieve(...)
@@ -37571,7 +37761,7 @@ client.hris.teams.list(
-Returns a `Team` object with the given `id`. +Returns a `Group` object with the given `id`.
@@ -37587,13 +37777,17 @@ Returns a `Team` object with the given `id`. ```python from merge import Merge +from merge.resources.knowledgebase.resources.groups import ( + GroupsRetrieveRequestExpand, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.teams.retrieve( +client.knowledgebase.groups.retrieve( id="id", + expand=GroupsRetrieveRequestExpand.PARENT_GROUP, include_remote_data=True, include_shell_data=True, ) @@ -37620,7 +37814,7 @@ client.hris.teams.retrieve(
-**expand:** `typing.Optional[typing.Literal["parent_team"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[GroupsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -37656,8 +37850,8 @@ client.hris.teams.retrieve(
-## Hris TimeOff -
client.hris.time_off.list(...) +## Knowledgebase Issues +
client.knowledgebase.issues.list(...)
@@ -37669,7 +37863,7 @@ client.hris.teams.retrieve(
-Returns a list of `TimeOff` objects. +Gets all issues for Organization.
@@ -37687,56 +37881,37 @@ Returns a list of `TimeOff` objects. import datetime from merge import Merge -from merge.resources.hris.resources.time_off import ( - TimeOffListRequestExpand, - TimeOffListRequestRemoteFields, - TimeOffListRequestRequestType, - TimeOffListRequestShowEnumOrigins, - TimeOffListRequestStatus, +from merge.resources.knowledgebase.resources.issues import ( + IssuesListRequestStatus, ) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off.list( - approver_id="approver_id", - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), +client.knowledgebase.issues.list( + account_token="account_token", cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - employee_id="employee_id", - ended_after=datetime.datetime.fromisoformat( + end_date="end_date", + end_user_organization_name="end_user_organization_name", + first_incident_time_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - ended_before=datetime.datetime.fromisoformat( + first_incident_time_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - expand=TimeOffListRequestExpand.APPROVER, - include_deleted_data=True, - include_remote_data=True, - include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( + include_muted="include_muted", + integration_name="integration_name", + last_incident_time_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - modified_before=datetime.datetime.fromisoformat( + last_incident_time_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), + linked_account_id="linked_account_id", page_size=1, - remote_fields=TimeOffListRequestRemoteFields.REQUEST_TYPE, - remote_id="remote_id", - request_type=TimeOffListRequestRequestType.BEREAVEMENT, - show_enum_origins=TimeOffListRequestShowEnumOrigins.REQUEST_TYPE, - started_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - started_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - status=TimeOffListRequestStatus.APPROVED, + start_date="start_date", + status=IssuesListRequestStatus.ONGOING, ) ``` @@ -37753,23 +37928,7 @@ client.hris.time_off.list(
-**approver_id:** `typing.Optional[str]` — If provided, will only return time off for this approver. - -
-
- -
-
- -**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. - -
-
- -
-
- -**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**account_token:** `typing.Optional[str]`
@@ -37785,7 +37944,7 @@ client.hris.time_off.list(
-**employee_id:** `typing.Optional[str]` — If provided, will only return time off for this employee. +**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time
@@ -37793,7 +37952,7 @@ client.hris.time_off.list(
-**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that ended after this datetime. +**end_user_organization_name:** `typing.Optional[str]`
@@ -37801,7 +37960,7 @@ client.hris.time_off.list(
-**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return time-offs that ended before this datetime. +**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
@@ -37809,7 +37968,7 @@ client.hris.time_off.list(
-**expand:** `typing.Optional[TimeOffListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
@@ -37817,7 +37976,7 @@ client.hris.time_off.list(
-**include_deleted_data:** `typing.Optional[bool]` — 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_muted:** `typing.Optional[str]` — If true, will include muted issues
@@ -37825,7 +37984,7 @@ client.hris.time_off.list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**integration_name:** `typing.Optional[str]`
@@ -37833,7 +37992,7 @@ client.hris.time_off.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime.
@@ -37841,7 +38000,7 @@ client.hris.time_off.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
@@ -37849,7 +38008,7 @@ client.hris.time_off.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in.
@@ -37865,56 +38024,7 @@ client.hris.time_off.list(
-**remote_fields:** `typing.Optional[TimeOffListRequestRemoteFields]` — Deprecated. Use show_enum_origins. - -
-
- -
-
- -**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
- -
-
- -**request_type:** `typing.Optional[TimeOffListRequestRequestType]` - -If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') - -* `VACATION` - VACATION -* `SICK` - SICK -* `PERSONAL` - PERSONAL -* `JURY_DUTY` - JURY_DUTY -* `VOLUNTEER` - VOLUNTEER -* `BEREAVEMENT` - BEREAVEMENT - -
-
- -
-
- -**show_enum_origins:** `typing.Optional[TimeOffListRequestShowEnumOrigins]` — 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:** `typing.Optional[dt.datetime]` — If provided, will only return time-offs that started after this datetime. - -
-
- -
-
- -**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return time-offs that started before this datetime. +**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time
@@ -37922,15 +38032,12 @@ If provided, will only return TimeOff with this request type. Options: ('VACATIO
-**status:** `typing.Optional[TimeOffListRequestStatus]` +**status:** `typing.Optional[IssuesListRequestStatus]` -If provided, will only return TimeOff with this status. Options: ('REQUESTED', 'APPROVED', 'DECLINED', 'CANCELLED', 'DELETED') +Status of the issue. Options: ('ONGOING', 'RESOLVED') -* `REQUESTED` - REQUESTED -* `APPROVED` - APPROVED -* `DECLINED` - DECLINED -* `CANCELLED` - CANCELLED -* `DELETED` - DELETED +* `ONGOING` - ONGOING +* `RESOLVED` - RESOLVED
@@ -37950,7 +38057,7 @@ If provided, will only return TimeOff with this status. Options: ('REQUESTED', '
-
client.hris.time_off.create(...) +
client.knowledgebase.issues.retrieve(...)
@@ -37962,7 +38069,7 @@ If provided, will only return TimeOff with this status. Options: ('REQUESTED', '
-Creates a `TimeOff` object with the given values. +Get a specific issue.
@@ -37978,16 +38085,13 @@ Creates a `TimeOff` object with the given values. ```python from merge import Merge -from merge.resources.hris import TimeOffRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off.create( - is_debug_mode=True, - run_async=True, - model=TimeOffRequest(), +client.knowledgebase.issues.retrieve( + id="id", ) ``` @@ -38004,23 +38108,7 @@ client.hris.time_off.create(
-**model:** `TimeOffRequest` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. - -
-
- -
-
- -**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**id:** `str`
@@ -38040,7 +38128,8 @@ client.hris.time_off.create(
-
client.hris.time_off.retrieve(...) +## Knowledgebase LinkToken +
client.knowledgebase.link_token.create(...)
@@ -38052,7 +38141,7 @@ client.hris.time_off.create(
-Returns a `TimeOff` object with the given `id`. +Creates a link token to be used when linking a new end user.
@@ -38068,23 +38157,17 @@ Returns a `TimeOff` object with the given `id`. ```python from merge import Merge -from merge.resources.hris.resources.time_off import ( - TimeOffRetrieveRequestExpand, - TimeOffRetrieveRequestRemoteFields, - TimeOffRetrieveRequestShowEnumOrigins, -) +from merge.resources.knowledgebase import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off.retrieve( - id="id", - expand=TimeOffRetrieveRequestExpand.APPROVER, - include_remote_data=True, - include_shell_data=True, - remote_fields=TimeOffRetrieveRequestRemoteFields.REQUEST_TYPE, - show_enum_origins=TimeOffRetrieveRequestShowEnumOrigins.REQUEST_TYPE, +client.knowledgebase.link_token.create( + end_user_email_address="example@gmail.com", + end_user_organization_name="Test Organization", + end_user_origin_id="12345", + categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS], ) ``` @@ -38101,7 +38184,7 @@ client.hris.time_off.retrieve(
-**id:** `str` +**end_user_email_address:** `str` — Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.
@@ -38109,7 +38192,7 @@ client.hris.time_off.retrieve(
-**expand:** `typing.Optional[TimeOffRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**end_user_organization_name:** `str` — Your end user's organization.
@@ -38117,7 +38200,7 @@ client.hris.time_off.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**end_user_origin_id:** `str` — This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers.
@@ -38125,7 +38208,7 @@ client.hris.time_off.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
@@ -38133,7 +38216,7 @@ client.hris.time_off.retrieve(
-**remote_fields:** `typing.Optional[TimeOffRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**integration:** `typing.Optional[str]` — The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/.
@@ -38141,7 +38224,46 @@ client.hris.time_off.retrieve(
-**show_enum_origins:** `typing.Optional[TimeOffRetrieveRequestShowEnumOrigins]` — 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) +**link_expiry_mins:** `typing.Optional[int]` — An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30. + +
+
+ +
+
+ +**should_create_magic_link_url:** `typing.Optional[bool]` — Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link. + +
+
+ +
+
+ +**hide_admin_magic_link:** `typing.Optional[bool]` — Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link. + +
+
+ +
+
+ +**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account. + +
+
+ +
+
+ +**category_common_model_scopes:** `typing.Optional[ + typing.Dict[ + str, + typing.Optional[ + typing.Sequence[IndividualCommonModelScopeDeserializerRequest] + ], + ] +]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings.
@@ -38149,64 +38271,44 @@ client.hris.time_off.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
- -
+**language:** `typing.Optional[EndUserDetailsRequestLanguage]` +The following subset of IETF language tags can be used to configure localization. +* `en` - en +* `de` - de + -
-
client.hris.time_off.meta_post_retrieve()
-#### 📝 Description - -
-
+**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled. + +
+
-Returns metadata for `TimeOff` POSTs. -
-
+**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge +**completed_account_initial_screen:** `typing.Optional[EndUserDetailsRequestCompletedAccountInitialScreen]` -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.time_off.meta_post_retrieve() +When creating a Link token, you can specifiy the initial screen of Linking Flow for a completed Linked Account. -``` -
-
+* `SELECTIVE_SYNC` - SELECTIVE_SYNC +
-#### ⚙️ Parameters - -
-
-
@@ -38222,8 +38324,8 @@ client.hris.time_off.meta_post_retrieve()
-## Hris TimeOffBalances -
client.hris.time_off_balances.list(...) +## Knowledgebase LinkedAccounts +
client.knowledgebase.linked_accounts.list(...)
@@ -38235,7 +38337,7 @@ client.hris.time_off.meta_post_retrieve()
-Returns a list of `TimeOffBalance` objects. +List linked accounts for your organization.
@@ -38250,38 +38352,29 @@ Returns a list of `TimeOffBalance` objects.
```python -import datetime - from merge import Merge -from merge.resources.hris.resources.time_off_balances import ( - TimeOffBalancesListRequestPolicyType, +from merge.resources.knowledgebase.resources.linked_accounts import ( + LinkedAccountsListRequestCategory, ) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off_balances.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), +client.knowledgebase.linked_accounts.list( + category=LinkedAccountsListRequestCategory.ACCOUNTING, cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - employee_id="employee_id", - include_deleted_data=True, - include_remote_data=True, - include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), + end_user_email_address="end_user_email_address", + end_user_organization_name="end_user_organization_name", + end_user_origin_id="end_user_origin_id", + end_user_origin_ids="end_user_origin_ids", + id="id", + ids="ids", + include_duplicates=True, + integration_name="integration_name", + is_test_account="is_test_account", page_size=1, - policy_type=TimeOffBalancesListRequestPolicyType.BEREAVEMENT, - remote_id="remote_id", + status="status", ) ``` @@ -38298,15 +38391,18 @@ client.hris.time_off_balances.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. - -
-
+**category:** `typing.Optional[LinkedAccountsListRequestCategory]` -
-
+Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mktg`, `ticketing` -**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +* `hris` - hris +* `ats` - ats +* `accounting` - accounting +* `ticketing` - ticketing +* `crm` - crm +* `mktg` - mktg +* `filestorage` - filestorage +* `knowledgebase` - knowledgebase
@@ -38322,15 +38418,7 @@ client.hris.time_off_balances.list(
-**employee_id:** `typing.Optional[str]` — If provided, will only return time off balances for this employee. - -
-
- -
-
- -**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address.
@@ -38338,7 +38426,7 @@ client.hris.time_off_balances.list(
-**include_deleted_data:** `typing.Optional[bool]` — 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/). +**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name.
@@ -38346,7 +38434,7 @@ client.hris.time_off_balances.list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID.
@@ -38354,7 +38442,7 @@ client.hris.time_off_balances.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
@@ -38362,7 +38450,7 @@ client.hris.time_off_balances.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**id:** `typing.Optional[str]`
@@ -38370,7 +38458,7 @@ client.hris.time_off_balances.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
@@ -38378,7 +38466,7 @@ client.hris.time_off_balances.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +**include_duplicates:** `typing.Optional[bool]` — If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.
@@ -38386,16 +38474,7 @@ client.hris.time_off_balances.list(
-**policy_type:** `typing.Optional[TimeOffBalancesListRequestPolicyType]` - -If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') - -* `VACATION` - VACATION -* `SICK` - SICK -* `PERSONAL` - PERSONAL -* `JURY_DUTY` - JURY_DUTY -* `VOLUNTEER` - VOLUNTEER -* `BEREAVEMENT` - BEREAVEMENT +**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name.
@@ -38403,7 +38482,7 @@ If provided, will only return TimeOffBalance with this policy type. Options: ('V
-**remote_fields:** `typing.Optional[typing.Literal["policy_type"]]` — Deprecated. Use show_enum_origins. +**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
@@ -38411,7 +38490,7 @@ If provided, will only return TimeOffBalance with this policy type. Options: ('V
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
@@ -38419,7 +38498,7 @@ If provided, will only return TimeOffBalance with this policy type. Options: ('V
-**show_enum_origins:** `typing.Optional[typing.Literal["policy_type"]]` — 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) +**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
@@ -38439,7 +38518,8 @@ If provided, will only return TimeOffBalance with this policy type. Options: ('V
-
client.hris.time_off_balances.retrieve(...) +## Knowledgebase Passthrough +
client.knowledgebase.passthrough.create(...)
@@ -38451,7 +38531,7 @@ If provided, will only return TimeOffBalance with this policy type. Options: ('V
-Returns a `TimeOffBalance` object with the given `id`. +Pull data from an endpoint not currently supported by Merge.
@@ -38467,15 +38547,17 @@ Returns a `TimeOffBalance` object with the given `id`. ```python from merge import Merge +from merge.resources.knowledgebase import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off_balances.retrieve( - id="id", - include_remote_data=True, - include_shell_data=True, +client.knowledgebase.passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), ) ``` @@ -38492,47 +38574,7 @@ client.hris.time_off_balances.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
- -
-
- -**remote_fields:** `typing.Optional[typing.Literal["policy_type"]]` — Deprecated. Use show_enum_origins. - -
-
- -
-
- -**show_enum_origins:** `typing.Optional[typing.Literal["policy_type"]]` — 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) +**request:** `DataPassthroughRequest`
@@ -38552,8 +38594,8 @@ client.hris.time_off_balances.retrieve(
-## Hris TimesheetEntries -
client.hris.timesheet_entries.list(...) +## Knowledgebase RegenerateKey +
client.knowledgebase.regenerate_key.create(...)
@@ -38565,7 +38607,7 @@ client.hris.time_off_balances.retrieve(
-Returns a list of `TimesheetEntry` objects. +Exchange remote keys.
@@ -38580,50 +38622,14 @@ Returns a list of `TimesheetEntry` objects.
```python -import datetime - from merge import Merge -from merge.resources.hris.resources.timesheet_entries import ( - TimesheetEntriesListRequestOrderBy, -) - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.timesheet_entries.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - employee_id="employee_id", - ended_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - ended_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - include_deleted_data=True, - include_remote_data=True, - include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - order_by=TimesheetEntriesListRequestOrderBy.START_TIME_DESCENDING, - page_size=1, - remote_id="remote_id", - started_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - started_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.knowledgebase.regenerate_key.create( + name="Remote Deployment Key 1", ) ``` @@ -38640,7 +38646,7 @@ client.hris.timesheet_entries.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**name:** `str` — The name of the remote key
@@ -38648,119 +38654,72 @@ client.hris.timesheet_entries.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**cursor:** `typing.Optional[str]` — The pagination cursor value. -
-
-
-**employee_id:** `typing.Optional[str]` — If provided, will only return timesheet entries for this employee. -
+
+## Knowledgebase SyncStatus +
client.knowledgebase.sync_status.list(...)
-**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries ended after this datetime. - -
-
+#### 📝 Description
-**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries ended before this datetime. - -
-
-
-**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - +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).
- -
-
- -**include_deleted_data:** `typing.Optional[bool]` — 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:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
+#### 🔌 Usage
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - -
-
+```python +from merge import Merge -
-
+client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.knowledgebase.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + page_size=1, +) -**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - +```
- -
-
- -**order_by:** `typing.Optional[TimesheetEntriesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: start_time, -start_time. -
-
-
- -**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. - -
-
+#### ⚙️ Parameters
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
-
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries started after this datetime. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -38768,7 +38727,7 @@ client.hris.timesheet_entries.list(
-**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries started before this datetime. +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
@@ -38788,7 +38747,8 @@ client.hris.timesheet_entries.list(
-
client.hris.timesheet_entries.create(...) +## Knowledgebase ForceResync +
client.knowledgebase.force_resync.sync_status_resync_create()
@@ -38800,7 +38760,7 @@ client.hris.timesheet_entries.list(
-Creates a `TimesheetEntry` object with the given values. +Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
@@ -38816,17 +38776,12 @@ Creates a `TimesheetEntry` object with the given values. ```python from merge import Merge -from merge.resources.hris import TimesheetEntryRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.timesheet_entries.create( - is_debug_mode=True, - run_async=True, - model=TimesheetEntryRequest(), -) +client.knowledgebase.force_resync.sync_status_resync_create() ``` @@ -38842,30 +38797,6 @@ client.hris.timesheet_entries.create(
-**model:** `TimesheetEntryRequest` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. - -
-
- -
-
- -**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -38878,7 +38809,8 @@ client.hris.timesheet_entries.create(
-
client.hris.timesheet_entries.retrieve(...) +## Knowledgebase Users +
client.knowledgebase.users.list(...)
@@ -38890,7 +38822,7 @@ client.hris.timesheet_entries.create(
-Returns a `TimesheetEntry` object with the given `id`. +Returns a list of `User` objects.
@@ -38905,16 +38837,33 @@ Returns a `TimesheetEntry` object with the given `id`.
```python +import datetime + from merge import Merge client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.timesheet_entries.retrieve( - id="id", +client.knowledgebase.users.list( + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + include_deleted_data=True, include_remote_data=True, include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + page_size=1, + remote_id="remote_id", ) ``` @@ -38931,7 +38880,7 @@ client.hris.timesheet_entries.retrieve(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -38939,7 +38888,23 @@ client.hris.timesheet_entries.retrieve(
-**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+ +
+
+ +**include_deleted_data:** `typing.Optional[bool]` — 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/).
@@ -38963,6 +38928,38 @@ client.hris.timesheet_entries.retrieve(
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
+ +
+
+ +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. + +
+
+ +
+
+ +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -38975,7 +38972,7 @@ client.hris.timesheet_entries.retrieve(
-
client.hris.timesheet_entries.meta_post_retrieve() +
client.knowledgebase.users.retrieve(...)
@@ -38987,7 +38984,7 @@ client.hris.timesheet_entries.retrieve(
-Returns metadata for `TimesheetEntry` POSTs. +Returns a `User` object with the given `id`.
@@ -39008,7 +39005,11 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.timesheet_entries.meta_post_retrieve() +client.knowledgebase.users.retrieve( + id="id", + include_remote_data=True, + include_shell_data=True, +) ``` @@ -39024,6 +39025,30 @@ client.hris.timesheet_entries.meta_post_retrieve()
+**id:** `str` + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -39036,8 +39061,8 @@ client.hris.timesheet_entries.meta_post_retrieve()
-## Hris WebhookReceivers -
client.hris.webhook_receivers.list() +## Knowledgebase WebhookReceivers +
client.knowledgebase.webhook_receivers.list()
@@ -39070,7 +39095,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.webhook_receivers.list() +client.knowledgebase.webhook_receivers.list() ```
@@ -39098,7 +39123,7 @@ client.hris.webhook_receivers.list()
-
client.hris.webhook_receivers.create(...) +
client.knowledgebase.webhook_receivers.create(...)
@@ -39131,7 +39156,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.webhook_receivers.create( +client.knowledgebase.webhook_receivers.create( event="event", is_active=True, ) diff --git a/src/merge/client.py b/src/merge/client.py index 202dd6e3..4350fe25 100644 --- a/src/merge/client.py +++ b/src/merge/client.py @@ -92,8 +92,8 @@ def __init__( self._chat: typing.Optional[ChatClient] = None self._crm: typing.Optional[CrmClient] = None self._filestorage: typing.Optional[FilestorageClient] = None - self._knowledgebase: typing.Optional[KnowledgebaseClient] = None self._hris: typing.Optional[HrisClient] = None + self._knowledgebase: typing.Optional[KnowledgebaseClient] = None self._ticketing: typing.Optional[TicketingClient] = None self._accounting: typing.Optional[AccountingClient] = None @@ -129,14 +129,6 @@ def filestorage(self): self._filestorage = FilestorageClient(client_wrapper=self._client_wrapper) return self._filestorage - @property - def knowledgebase(self): - if self._knowledgebase is None: - from .resources.knowledgebase.client import KnowledgebaseClient # noqa: E402 - - self._knowledgebase = KnowledgebaseClient(client_wrapper=self._client_wrapper) - return self._knowledgebase - @property def hris(self): if self._hris is None: @@ -145,6 +137,14 @@ def hris(self): self._hris = HrisClient(client_wrapper=self._client_wrapper) return self._hris + @property + def knowledgebase(self): + if self._knowledgebase is None: + from .resources.knowledgebase.client import KnowledgebaseClient # noqa: E402 + + self._knowledgebase = KnowledgebaseClient(client_wrapper=self._client_wrapper) + return self._knowledgebase + @property def ticketing(self): if self._ticketing is None: @@ -235,8 +235,8 @@ def __init__( self._chat: typing.Optional[AsyncChatClient] = None self._crm: typing.Optional[AsyncCrmClient] = None self._filestorage: typing.Optional[AsyncFilestorageClient] = None - self._knowledgebase: typing.Optional[AsyncKnowledgebaseClient] = None self._hris: typing.Optional[AsyncHrisClient] = None + self._knowledgebase: typing.Optional[AsyncKnowledgebaseClient] = None self._ticketing: typing.Optional[AsyncTicketingClient] = None self._accounting: typing.Optional[AsyncAccountingClient] = None @@ -272,14 +272,6 @@ def filestorage(self): self._filestorage = AsyncFilestorageClient(client_wrapper=self._client_wrapper) return self._filestorage - @property - def knowledgebase(self): - if self._knowledgebase is None: - from .resources.knowledgebase.client import AsyncKnowledgebaseClient # noqa: E402 - - self._knowledgebase = AsyncKnowledgebaseClient(client_wrapper=self._client_wrapper) - return self._knowledgebase - @property def hris(self): if self._hris is None: @@ -288,6 +280,14 @@ def hris(self): self._hris = AsyncHrisClient(client_wrapper=self._client_wrapper) return self._hris + @property + def knowledgebase(self): + if self._knowledgebase is None: + from .resources.knowledgebase.client import AsyncKnowledgebaseClient # noqa: E402 + + self._knowledgebase = AsyncKnowledgebaseClient(client_wrapper=self._client_wrapper) + return self._knowledgebase + @property def ticketing(self): if self._ticketing is None: diff --git a/src/merge/core/client_wrapper.py b/src/merge/core/client_wrapper.py index b2dbf289..45e75a53 100644 --- a/src/merge/core/client_wrapper.py +++ b/src/merge/core/client_wrapper.py @@ -24,10 +24,10 @@ def __init__( def get_headers(self) -> typing.Dict[str, str]: headers: typing.Dict[str, str] = { - "User-Agent": "MergePythonClient/2.6.0", + "User-Agent": "MergePythonClient/2.6.1", "X-Fern-Language": "Python", "X-Fern-SDK-Name": "MergePythonClient", - "X-Fern-SDK-Version": "2.6.0", + "X-Fern-SDK-Version": "2.6.1", **(self.get_custom_headers() or {}), } if self._account_token is not None: diff --git a/src/merge/resources/accounting/types/address.py b/src/merge/resources/accounting/types/address.py index 5de9d995..196a516f 100644 --- a/src/merge/resources/accounting/types/address.py +++ b/src/merge/resources/accounting/types/address.py @@ -53,7 +53,11 @@ class Address(UncheckedBaseModel): The address's city. """ - state: typing.Optional[typing.Optional[typing.Any]] = None + state: typing.Optional[typing.Optional[typing.Any]] = pydantic.Field(default=None) + """ + The address's state or region. + """ + country_subdivision: typing.Optional[str] = pydantic.Field(default=None) """ The address's state or region. diff --git a/src/merge/resources/accounting/types/remote_data.py b/src/merge/resources/accounting/types/remote_data.py index b60f53bf..f34bec80 100644 --- a/src/merge/resources/accounting/types/remote_data.py +++ b/src/merge/resources/accounting/types/remote_data.py @@ -22,7 +22,10 @@ class RemoteData(UncheckedBaseModel): The third-party API path that is being called. """ - data: typing.Optional[typing.Optional[typing.Any]] = None + data: typing.Optional[typing.Optional[typing.Any]] = pydantic.Field(default=None) + """ + The data returned from the third-party for this object in its original, unnormalized format. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ats/types/remote_data.py b/src/merge/resources/ats/types/remote_data.py index b60f53bf..f34bec80 100644 --- a/src/merge/resources/ats/types/remote_data.py +++ b/src/merge/resources/ats/types/remote_data.py @@ -22,7 +22,10 @@ class RemoteData(UncheckedBaseModel): The third-party API path that is being called. """ - data: typing.Optional[typing.Optional[typing.Any]] = None + data: typing.Optional[typing.Optional[typing.Any]] = pydantic.Field(default=None) + """ + The data returned from the third-party for this object in its original, unnormalized format. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/chat/resources/groups/client.py b/src/merge/resources/chat/resources/groups/client.py index 6d11e52a..17627ccb 100644 --- a/src/merge/resources/chat/resources/groups/client.py +++ b/src/merge/resources/chat/resources/groups/client.py @@ -31,6 +31,7 @@ def list( created_after: typing.Optional[dt.datetime] = None, created_before: typing.Optional[dt.datetime] = None, cursor: typing.Optional[str] = None, + expand: typing.Optional[typing.Literal["users"]] = None, include_deleted_data: typing.Optional[bool] = None, include_remote_data: typing.Optional[bool] = None, include_shell_data: typing.Optional[bool] = None, @@ -54,6 +55,9 @@ def list( cursor : typing.Optional[str] The pagination cursor value. + expand : typing.Optional[typing.Literal["users"]] + Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + include_deleted_data : typing.Optional[bool] 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/). @@ -118,6 +122,7 @@ def list( created_after=created_after, created_before=created_before, cursor=cursor, + expand=expand, include_deleted_data=include_deleted_data, include_remote_data=include_remote_data, include_shell_data=include_shell_data, @@ -133,6 +138,7 @@ def retrieve( self, id: str, *, + expand: typing.Optional[typing.Literal["users"]] = None, include_remote_data: typing.Optional[bool] = None, include_shell_data: typing.Optional[bool] = None, request_options: typing.Optional[RequestOptions] = None, @@ -144,6 +150,9 @@ def retrieve( ---------- id : str + expand : typing.Optional[typing.Literal["users"]] + Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + include_remote_data : typing.Optional[bool] Whether to include the original data Merge fetched from the third-party to produce these models. @@ -174,6 +183,7 @@ def retrieve( """ _response = self._raw_client.retrieve( id, + expand=expand, include_remote_data=include_remote_data, include_shell_data=include_shell_data, request_options=request_options, @@ -202,6 +212,7 @@ async def list( created_after: typing.Optional[dt.datetime] = None, created_before: typing.Optional[dt.datetime] = None, cursor: typing.Optional[str] = None, + expand: typing.Optional[typing.Literal["users"]] = None, include_deleted_data: typing.Optional[bool] = None, include_remote_data: typing.Optional[bool] = None, include_shell_data: typing.Optional[bool] = None, @@ -225,6 +236,9 @@ async def list( cursor : typing.Optional[str] The pagination cursor value. + expand : typing.Optional[typing.Literal["users"]] + Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + include_deleted_data : typing.Optional[bool] 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/). @@ -296,6 +310,7 @@ async def main() -> None: created_after=created_after, created_before=created_before, cursor=cursor, + expand=expand, include_deleted_data=include_deleted_data, include_remote_data=include_remote_data, include_shell_data=include_shell_data, @@ -311,6 +326,7 @@ async def retrieve( self, id: str, *, + expand: typing.Optional[typing.Literal["users"]] = None, include_remote_data: typing.Optional[bool] = None, include_shell_data: typing.Optional[bool] = None, request_options: typing.Optional[RequestOptions] = None, @@ -322,6 +338,9 @@ async def retrieve( ---------- id : str + expand : typing.Optional[typing.Literal["users"]] + Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + include_remote_data : typing.Optional[bool] Whether to include the original data Merge fetched from the third-party to produce these models. @@ -360,6 +379,7 @@ async def main() -> None: """ _response = await self._raw_client.retrieve( id, + expand=expand, include_remote_data=include_remote_data, include_shell_data=include_shell_data, request_options=request_options, diff --git a/src/merge/resources/chat/resources/groups/raw_client.py b/src/merge/resources/chat/resources/groups/raw_client.py index dc8f99ba..77c76e71 100644 --- a/src/merge/resources/chat/resources/groups/raw_client.py +++ b/src/merge/resources/chat/resources/groups/raw_client.py @@ -25,6 +25,7 @@ def list( created_after: typing.Optional[dt.datetime] = None, created_before: typing.Optional[dt.datetime] = None, cursor: typing.Optional[str] = None, + expand: typing.Optional[typing.Literal["users"]] = None, include_deleted_data: typing.Optional[bool] = None, include_remote_data: typing.Optional[bool] = None, include_shell_data: typing.Optional[bool] = None, @@ -48,6 +49,9 @@ def list( cursor : typing.Optional[str] The pagination cursor value. + expand : typing.Optional[typing.Literal["users"]] + Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + include_deleted_data : typing.Optional[bool] 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/). @@ -84,6 +88,7 @@ def list( "created_after": serialize_datetime(created_after) if created_after is not None else None, "created_before": serialize_datetime(created_before) if created_before is not None else None, "cursor": cursor, + "expand": expand, "include_deleted_data": include_deleted_data, "include_remote_data": include_remote_data, "include_shell_data": include_shell_data, @@ -113,6 +118,7 @@ def retrieve( self, id: str, *, + expand: typing.Optional[typing.Literal["users"]] = None, include_remote_data: typing.Optional[bool] = None, include_shell_data: typing.Optional[bool] = None, request_options: typing.Optional[RequestOptions] = None, @@ -124,6 +130,9 @@ def retrieve( ---------- id : str + expand : typing.Optional[typing.Literal["users"]] + Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + include_remote_data : typing.Optional[bool] Whether to include the original data Merge fetched from the third-party to produce these models. @@ -142,6 +151,7 @@ def retrieve( f"chat/v1/groups/{jsonable_encoder(id)}", method="GET", params={ + "expand": expand, "include_remote_data": include_remote_data, "include_shell_data": include_shell_data, }, @@ -173,6 +183,7 @@ async def list( created_after: typing.Optional[dt.datetime] = None, created_before: typing.Optional[dt.datetime] = None, cursor: typing.Optional[str] = None, + expand: typing.Optional[typing.Literal["users"]] = None, include_deleted_data: typing.Optional[bool] = None, include_remote_data: typing.Optional[bool] = None, include_shell_data: typing.Optional[bool] = None, @@ -196,6 +207,9 @@ async def list( cursor : typing.Optional[str] The pagination cursor value. + expand : typing.Optional[typing.Literal["users"]] + Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + include_deleted_data : typing.Optional[bool] 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/). @@ -232,6 +246,7 @@ async def list( "created_after": serialize_datetime(created_after) if created_after is not None else None, "created_before": serialize_datetime(created_before) if created_before is not None else None, "cursor": cursor, + "expand": expand, "include_deleted_data": include_deleted_data, "include_remote_data": include_remote_data, "include_shell_data": include_shell_data, @@ -261,6 +276,7 @@ async def retrieve( self, id: str, *, + expand: typing.Optional[typing.Literal["users"]] = None, include_remote_data: typing.Optional[bool] = None, include_shell_data: typing.Optional[bool] = None, request_options: typing.Optional[RequestOptions] = None, @@ -272,6 +288,9 @@ async def retrieve( ---------- id : str + expand : typing.Optional[typing.Literal["users"]] + Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + include_remote_data : typing.Optional[bool] Whether to include the original data Merge fetched from the third-party to produce these models. @@ -290,6 +309,7 @@ async def retrieve( f"chat/v1/groups/{jsonable_encoder(id)}", method="GET", params={ + "expand": expand, "include_remote_data": include_remote_data, "include_shell_data": include_shell_data, }, diff --git a/src/merge/resources/chat/resources/link_token/client.py b/src/merge/resources/chat/resources/link_token/client.py index 3d5feac9..e5851e8a 100644 --- a/src/merge/resources/chat/resources/link_token/client.py +++ b/src/merge/resources/chat/resources/link_token/client.py @@ -55,7 +55,7 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> LinkToken: """ - Creates a link token to be used when linking a new end user. + Creates a link token to be used when linking a new end user. The link token expires after single use. Parameters ---------- @@ -187,7 +187,7 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> LinkToken: """ - Creates a link token to be used when linking a new end user. + Creates a link token to be used when linking a new end user. The link token expires after single use. Parameters ---------- diff --git a/src/merge/resources/chat/resources/link_token/raw_client.py b/src/merge/resources/chat/resources/link_token/raw_client.py index 1ee72cfc..2bd4c7c8 100644 --- a/src/merge/resources/chat/resources/link_token/raw_client.py +++ b/src/merge/resources/chat/resources/link_token/raw_client.py @@ -47,7 +47,7 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[LinkToken]: """ - Creates a link token to be used when linking a new end user. + Creates a link token to be used when linking a new end user. The link token expires after single use. Parameters ---------- @@ -173,7 +173,7 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[LinkToken]: """ - Creates a link token to be used when linking a new end user. + Creates a link token to be used when linking a new end user. The link token expires after single use. Parameters ---------- diff --git a/src/merge/resources/chat/resources/messages/client.py b/src/merge/resources/chat/resources/messages/client.py index dbe484c3..04c51f18 100644 --- a/src/merge/resources/chat/resources/messages/client.py +++ b/src/merge/resources/chat/resources/messages/client.py @@ -30,6 +30,7 @@ def with_raw_response(self) -> RawMessagesClient: def list( self, *, + conversation_id: typing.Optional[str] = None, created_after: typing.Optional[dt.datetime] = None, created_before: typing.Optional[dt.datetime] = None, cursor: typing.Optional[str] = None, @@ -49,6 +50,9 @@ def list( Parameters ---------- + conversation_id : typing.Optional[str] + Filter messages by conversation ID. + created_after : typing.Optional[dt.datetime] If provided, will only return objects created after this datetime. @@ -105,6 +109,7 @@ def list( api_key="YOUR_API_KEY", ) client.chat.messages.list( + conversation_id="conversation_id", created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -128,6 +133,7 @@ def list( ) """ _response = self._raw_client.list( + conversation_id=conversation_id, created_after=created_after, created_before=created_before, cursor=cursor, @@ -292,6 +298,7 @@ def with_raw_response(self) -> AsyncRawMessagesClient: async def list( self, *, + conversation_id: typing.Optional[str] = None, created_after: typing.Optional[dt.datetime] = None, created_before: typing.Optional[dt.datetime] = None, cursor: typing.Optional[str] = None, @@ -311,6 +318,9 @@ async def list( Parameters ---------- + conversation_id : typing.Optional[str] + Filter messages by conversation ID. + created_after : typing.Optional[dt.datetime] If provided, will only return objects created after this datetime. @@ -371,6 +381,7 @@ async def list( async def main() -> None: await client.chat.messages.list( + conversation_id="conversation_id", created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -397,6 +408,7 @@ async def main() -> None: asyncio.run(main()) """ _response = await self._raw_client.list( + conversation_id=conversation_id, created_after=created_after, created_before=created_before, cursor=cursor, diff --git a/src/merge/resources/chat/resources/messages/raw_client.py b/src/merge/resources/chat/resources/messages/raw_client.py index 975293e2..ef732e06 100644 --- a/src/merge/resources/chat/resources/messages/raw_client.py +++ b/src/merge/resources/chat/resources/messages/raw_client.py @@ -24,6 +24,7 @@ def __init__(self, *, client_wrapper: SyncClientWrapper): def list( self, *, + conversation_id: typing.Optional[str] = None, created_after: typing.Optional[dt.datetime] = None, created_before: typing.Optional[dt.datetime] = None, cursor: typing.Optional[str] = None, @@ -43,6 +44,9 @@ def list( Parameters ---------- + conversation_id : typing.Optional[str] + Filter messages by conversation ID. + created_after : typing.Optional[dt.datetime] If provided, will only return objects created after this datetime. @@ -91,6 +95,7 @@ def list( "chat/v1/messages", method="GET", params={ + "conversation_id": conversation_id, "created_after": serialize_datetime(created_after) if created_after is not None else None, "created_before": serialize_datetime(created_before) if created_before is not None else None, "cursor": cursor, @@ -255,6 +260,7 @@ def __init__(self, *, client_wrapper: AsyncClientWrapper): async def list( self, *, + conversation_id: typing.Optional[str] = None, created_after: typing.Optional[dt.datetime] = None, created_before: typing.Optional[dt.datetime] = None, cursor: typing.Optional[str] = None, @@ -274,6 +280,9 @@ async def list( Parameters ---------- + conversation_id : typing.Optional[str] + Filter messages by conversation ID. + created_after : typing.Optional[dt.datetime] If provided, will only return objects created after this datetime. @@ -322,6 +331,7 @@ async def list( "chat/v1/messages", method="GET", params={ + "conversation_id": conversation_id, "created_after": serialize_datetime(created_after) if created_after is not None else None, "created_before": serialize_datetime(created_before) if created_before is not None else None, "cursor": cursor, diff --git a/src/merge/resources/chat/types/group.py b/src/merge/resources/chat/types/group.py index ee2ecc66..732616f4 100644 --- a/src/merge/resources/chat/types/group.py +++ b/src/merge/resources/chat/types/group.py @@ -39,6 +39,7 @@ class Group(UncheckedBaseModel): The name of the Group """ + users: typing.Optional[typing.List[typing.Optional[str]]] = None remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's group was created. diff --git a/src/merge/resources/chat/types/remote_data.py b/src/merge/resources/chat/types/remote_data.py index b60f53bf..f34bec80 100644 --- a/src/merge/resources/chat/types/remote_data.py +++ b/src/merge/resources/chat/types/remote_data.py @@ -22,7 +22,10 @@ class RemoteData(UncheckedBaseModel): The third-party API path that is being called. """ - data: typing.Optional[typing.Optional[typing.Any]] = None + data: typing.Optional[typing.Optional[typing.Any]] = pydantic.Field(default=None) + """ + The data returned from the third-party for this object in its original, unnormalized format. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/remote_data.py b/src/merge/resources/crm/types/remote_data.py index b60f53bf..f34bec80 100644 --- a/src/merge/resources/crm/types/remote_data.py +++ b/src/merge/resources/crm/types/remote_data.py @@ -22,7 +22,10 @@ class RemoteData(UncheckedBaseModel): The third-party API path that is being called. """ - data: typing.Optional[typing.Optional[typing.Any]] = None + data: typing.Optional[typing.Optional[typing.Any]] = pydantic.Field(default=None) + """ + The data returned from the third-party for this object in its original, unnormalized format. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/filestorage/types/remote_data.py b/src/merge/resources/filestorage/types/remote_data.py index b60f53bf..f34bec80 100644 --- a/src/merge/resources/filestorage/types/remote_data.py +++ b/src/merge/resources/filestorage/types/remote_data.py @@ -22,7 +22,10 @@ class RemoteData(UncheckedBaseModel): The third-party API path that is being called. """ - data: typing.Optional[typing.Optional[typing.Any]] = None + data: typing.Optional[typing.Optional[typing.Any]] = pydantic.Field(default=None) + """ + The data returned from the third-party for this object in its original, unnormalized format. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/hris/types/remote_data.py b/src/merge/resources/hris/types/remote_data.py index b60f53bf..f34bec80 100644 --- a/src/merge/resources/hris/types/remote_data.py +++ b/src/merge/resources/hris/types/remote_data.py @@ -22,7 +22,10 @@ class RemoteData(UncheckedBaseModel): The third-party API path that is being called. """ - data: typing.Optional[typing.Optional[typing.Any]] = None + data: typing.Optional[typing.Optional[typing.Any]] = pydantic.Field(default=None) + """ + The data returned from the third-party for this object in its original, unnormalized format. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/knowledgebase/types/remote_data.py b/src/merge/resources/knowledgebase/types/remote_data.py index b60f53bf..f34bec80 100644 --- a/src/merge/resources/knowledgebase/types/remote_data.py +++ b/src/merge/resources/knowledgebase/types/remote_data.py @@ -22,7 +22,10 @@ class RemoteData(UncheckedBaseModel): The third-party API path that is being called. """ - data: typing.Optional[typing.Optional[typing.Any]] = None + data: typing.Optional[typing.Optional[typing.Any]] = pydantic.Field(default=None) + """ + The data returned from the third-party for this object in its original, unnormalized format. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ticketing/types/remote_data.py b/src/merge/resources/ticketing/types/remote_data.py index b60f53bf..f34bec80 100644 --- a/src/merge/resources/ticketing/types/remote_data.py +++ b/src/merge/resources/ticketing/types/remote_data.py @@ -22,7 +22,10 @@ class RemoteData(UncheckedBaseModel): The third-party API path that is being called. """ - data: typing.Optional[typing.Optional[typing.Any]] = None + data: typing.Optional[typing.Optional[typing.Any]] = pydantic.Field(default=None) + """ + The data returned from the third-party for this object in its original, unnormalized format. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2